open.c File Reference

Data transfer interface opening. More...

#include <stdarg.h>
#include <string.h>
#include <errno.h>
#include <gpxe/xfer.h>
#include <gpxe/uri.h>
#include <gpxe/socket.h>
#include <gpxe/open.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER)
int	xfer_open_uri (struct xfer_interface *xfer, struct uri *uri)
	Open URI.
int	xfer_open_uri_string (struct xfer_interface *xfer, const char *uri_string)
	Open URI string.
int	xfer_open_socket (struct xfer_interface *xfer, int semantics, struct sockaddr *peer, struct sockaddr *local)
	Open socket.
int	xfer_vopen (struct xfer_interface *xfer, int type, va_list args)
	Open location.
int	xfer_open (struct xfer_interface *xfer, int type,...)
	Open location.
int	xfer_vreopen (struct xfer_interface *xfer, int type, va_list args)
	Reopen location.

---

Detailed Description

Data transfer interface opening.

Definition in file open.c.

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

int xfer_open_uri	(	struct xfer_interface *	xfer,
		struct uri *	uri
	)

Open URI.

Parameters:

	xfer	Data transfer interface
	uri	URI

Return values:

rc

Return status code

The URI will be regarded as being relative to the current working URI (see churi()).

Definition at line 45 of file open.c.

References cwuri, DBGC, ENOMEM, ENOTSUP, for_each_table_entry, uri_opener::open, resolve_uri(), uri_opener::scheme, uri::scheme, strcmp(), and URI_OPENERS.

Referenced by xfer_open_uri_string(), and xfer_vopen().

                                                                   {
        struct uri_opener *opener;
        struct uri *resolved_uri;
        int rc = -ENOTSUP;

        /* Resolve URI */
        resolved_uri = resolve_uri ( cwuri, uri );
        if ( ! resolved_uri )
                return -ENOMEM;

        /* Find opener which supports this URI scheme */
        for_each_table_entry ( opener, URI_OPENERS ) {
                if ( strcmp ( resolved_uri->scheme, opener->scheme ) == 0 ) {
                        DBGC ( xfer, "XFER %p opening %s URI\n",
                               xfer, opener->scheme );
                        rc = opener->open ( xfer, resolved_uri );
                        goto done;
                }
        }
        DBGC ( xfer, "XFER %p attempted to open unsupported URI scheme "
               "\"%s\"\n", xfer, resolved_uri->scheme );

 done:
        uri_put ( resolved_uri );
        return rc;
}

int xfer_open_uri_string	(	struct xfer_interface *	xfer,
		const char *	uri_string
	)

Open URI string.

Parameters:

	xfer	Data transfer interface
	uri_string	URI string (e.g. "http://etherboot.org/kernel")

Return values:

rc

Return status code

The URI will be regarded as being relative to the current working URI (see churi()).

Definition at line 82 of file open.c.

References DBGC, ENOMEM, parse_uri(), and xfer_open_uri().

Referenced by open(), pxe_tftp_open(), and xfer_vopen().

                                                    {
        struct uri *uri;
        int rc;

        DBGC ( xfer, "XFER %p opening URI %s\n", xfer, uri_string );

        uri = parse_uri ( uri_string );
        if ( ! uri )
                return -ENOMEM;

        rc = xfer_open_uri ( xfer, uri );

        uri_put ( uri );
        return rc;
}

int xfer_open_socket	(	struct xfer_interface *	xfer,
		int	semantics,
		struct sockaddr *	peer,
		struct sockaddr *	local
	)

Open socket.

Parameters:

	xfer	Data transfer interface
	semantics	Communication semantics (e.g. SOCK_STREAM)
	peer	Peer socket address
	local	Local socket address, or NULL

Return values:

rc

Return status code

Definition at line 108 of file open.c.

References DBGC, ENOTSUP, socket_opener::family, for_each_table_entry, socket_opener::open, sockaddr::sa_family, socket_opener::semantics, and SOCKET_OPENERS.

Referenced by dns_resolv(), ftp_reply(), slam_open(), start_dhcp(), start_pxebs(), tftp_reopen_mc(), and xfer_vopen().

                                                                       {
        struct socket_opener *opener;

        DBGC ( xfer, "XFER %p opening (%s,%s) socket\n", xfer,
               socket_semantics_name ( semantics ),
               socket_family_name ( peer->sa_family ) );

        for_each_table_entry ( opener, SOCKET_OPENERS ) {
                if ( ( opener->semantics == semantics ) &&
                     ( opener->family == peer->sa_family ) ) {
                        return opener->open ( xfer, peer, local );
                }
        }

        DBGC ( xfer, "XFER %p attempted to open unsupported socket type "
               "(%s,%s)\n", xfer, socket_semantics_name ( semantics ),
               socket_family_name ( peer->sa_family ) );
        return -ENOTSUP;
}

int xfer_vopen	(	struct xfer_interface *	xfer,
		int	type,
		va_list	args
	)

Open location.

Parameters:

	xfer	Data transfer interface
	type	Location type
	args	Remaining arguments depend upon location type

Return values:

rc

Return status code

Definition at line 137 of file open.c.

References DBGC, ENOTSUP, LOCATION_SOCKET, LOCATION_URI, LOCATION_URI_STRING, va_arg, xfer_open_socket(), xfer_open_uri(), and xfer_open_uri_string().

Referenced by create_downloader(), xfer_open(), and xfer_vreopen().

                                                                       {
        switch ( type ) {
        case LOCATION_URI_STRING: {
                const char *uri_string = va_arg ( args, const char * );

                return xfer_open_uri_string ( xfer, uri_string ); }
        case LOCATION_URI: {
                struct uri *uri = va_arg ( args, struct uri * );

                return xfer_open_uri ( xfer, uri ); }
        case LOCATION_SOCKET: {
                int semantics = va_arg ( args, int );
                struct sockaddr *peer = va_arg ( args, struct sockaddr * );
                struct sockaddr *local = va_arg ( args, struct sockaddr * );

                return xfer_open_socket ( xfer, semantics, peer, local ); }
        default:
                DBGC ( xfer, "XFER %p attempted to open unsupported location "
                       "type %d\n", xfer, type );
                return -ENOTSUP;
        }
}

int xfer_open	(	struct xfer_interface *	xfer,
		int	type,
			...
	)

Open location.

Parameters:

	xfer	Data transfer interface
	type	Location type
	...	Remaining arguments depend upon location type

Return values:

rc

Return status code

Definition at line 168 of file open.c.

References va_end, va_start, and xfer_vopen().

                                                             {
        va_list args;
        int rc;

        va_start ( args, type );
        rc = xfer_vopen ( xfer, type, args );
        va_end ( args );
        return rc;
}

int xfer_vreopen	(	struct xfer_interface *	xfer,
		int	type,
		va_list	args
	)

Reopen location.

Parameters:

	xfer	Data transfer interface
	type	Location type
	args	Remaining arguments depend upon location type

Return values:

rc

Return status code

This will close the existing connection and open a new connection using xfer_vopen(). It is intended to be used as a .vredirect method handler.

Definition at line 190 of file open.c.

References xfer_close(), and xfer_vopen().

Referenced by iscsi_vredirect().

                                                                         {

        /* Close existing connection */
        xfer_close ( xfer, 0 );

        /* Open new location */
        return xfer_vopen ( xfer, type, args );
}