Data transfer interface opening. More...

#include <stdarg.h>
#include <ipxe/tables.h>
#include <ipxe/socket.h>

Data Structures
struct	uri_opener
	A URI opener. More...

struct	socket_opener
	A socket opener. More...

Macros
#define	URI_OPENERS __table ( struct uri_opener, "uri_openers" )
	URI opener table. More...

#define	__uri_opener __table_entry ( URI_OPENERS, 01 )
	Register a URI opener. More...

#define	SOCKET_OPENERS __table ( struct socket_opener, "socket_openers" )
	Socket opener table. More...

#define	__socket_opener __table_entry ( SOCKET_OPENERS, 01 )
	Register a socket opener. More...

Enumerations
enum	{ LOCATION_URI = 1, LOCATION_URI_STRING, LOCATION_SOCKET }
	Location types. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)

	FILE_SECBOOT (PERMITTED)

struct uri_opener *	xfer_uri_opener (const char *scheme)
	Find opener for URI scheme. More...

int	xfer_open_uri (struct interface intf, struct uri uri)
	Open URI. More...

int	xfer_open_uri_string (struct interface intf, const char uri_string)
	Open URI string. More...

int	xfer_open_named_socket (struct interface intf, int semantics, struct sockaddr peer, const char name, struct sockaddr local)
	Open named socket. More...

int	xfer_open_socket (struct interface intf, int semantics, struct sockaddr peer, struct sockaddr *local)
	Open socket. More...

int	xfer_vopen (struct interface *intf, int type, va_list args)
	Open location. More...

int	xfer_open (struct interface *intf, int type,...)
	Open location. More...

int	xfer_vreopen (struct interface *intf, int type, va_list args)
	Reopen location. More...

Detailed Description

Data transfer interface opening.

Definition in file open.h.

Macro Definition Documentation

◆ URI_OPENERS

#define URI_OPENERS __table ( struct uri_opener, "uri_openers" )

URI opener table.

Definition at line 65 of file open.h.

◆ __uri_opener

struct uri_opener mtftp_uri_opener __uri_opener __table_entry ( URI_OPENERS, 01 )

Register a URI opener.

MTFTP URI opener.

TFTM URI opener.

Definition at line 68 of file open.h.

◆ SOCKET_OPENERS

#define SOCKET_OPENERS __table ( struct socket_opener, "socket_openers" )

Socket opener table.

Definition at line 86 of file open.h.

◆ __socket_opener

#define __socket_opener __table_entry ( SOCKET_OPENERS, 01 )

Register a socket opener.

Definition at line 89 of file open.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Location types.

Enumerator

LOCATION_URI

Location is a URI.

   Parameter list for open() is:

   struct uri *uri;

LOCATION_URI_STRING

Location is a URI string.

   Parameter list for open() is:

   const char *uri_string;

LOCATION_SOCKET

Location is a socket.

   Parameter list for open() is:

   int semantics;
   struct sockaddr *peer;
   struct sockaddr *local;

Definition at line 21 of file open.h.

      {
         /** Location is a URI
          *
          * Parameter list for open() is:
          *
          * struct uri *uri;
          */
         LOCATION_URI = 1,
         /** Location is a URI string
          *
          * Parameter list for open() is:
          *
          * const char *uri_string;
          */
         LOCATION_URI_STRING,
         /** Location is a socket
          *
          * Parameter list for open() is:
          *
          * int semantics;
          * struct sockaddr *peer;
          * struct sockaddr *local;
          */
         LOCATION_SOCKET,
 };

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )

◆ xfer_uri_opener()

struct uri_opener* xfer_uri_opener ( const char * scheme )

Find opener for URI scheme.

Parameters

scheme URI scheme

Return values

opener Opener, or NULL

Definition at line 48 of file open.c.

                                                            {
         struct uri_opener *opener;
 
         for_each_table_entry ( opener, URI_OPENERS ) {
                 if ( strcasecmp ( scheme, opener->scheme ) == 0 )
                         return opener;
         }
         return NULL;
 }

References for_each_table_entry, NULL, uri_opener::scheme, strcasecmp(), and URI_OPENERS.

Referenced by netboot(), and xfer_open_uri().

◆ xfer_open_uri()

int xfer_open_uri	(	struct interface *	intf,
		struct uri *	uri
	)

Open URI.

Parameters

intf	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 68 of file open.c.

                                                               {
         struct uri_opener *opener;
         struct uri *resolved_uri;
         int rc;
 
         /* Resolve URI */
         resolved_uri = resolve_uri ( cwuri, uri );
         if ( ! resolved_uri ) {
                 rc = -ENOMEM;
                 goto err_resolve_uri;
         }
 
         /* Find opener which supports this URI scheme */
         opener = xfer_uri_opener ( resolved_uri->scheme );
         if ( ! opener ) {
                 DBGC ( INTF_COL ( intf ), "INTF " INTF_FMT " attempted to open "
                        "unsupported URI scheme \"%s\"\n",
                        INTF_DBG ( intf ), resolved_uri->scheme );
                 rc = -ENOTSUP;
                 goto err_opener;
         }
 
         /* Call opener */
         DBGC ( INTF_COL ( intf ), "INTF " INTF_FMT " opening %s URI\n",
                INTF_DBG ( intf ), resolved_uri->scheme );
         if ( ( rc = opener->open ( intf, resolved_uri ) ) != 0 ) {
                 DBGC ( INTF_COL ( intf ), "INTF " INTF_FMT " could not open: "
                        "%s\n", INTF_DBG ( intf ), strerror ( rc ) );
                 goto err_open;
         }
 
  err_open:
  err_opener:
         uri_put ( resolved_uri );
  err_resolve_uri:
         return rc;
 }

References cwuri, DBGC, ENOMEM, ENOTSUP, INTF_COL, INTF_DBG, INTF_FMT, uri_opener::open, rc, resolve_uri(), uri::scheme, strerror(), uri_put(), and xfer_uri_opener().

Referenced by create_downloader(), efi_pxe_tftp_open(), pxe_tftp_open(), sanpath_open(), xfer_open_uri_string(), and xfer_vopen().

◆ xfer_open_uri_string()

int xfer_open_uri_string	(	struct interface *	intf,
		const char *	uri_string
	)

Open URI string.

Parameters

intf	Data transfer interface
uri_string	URI string (e.g. "http://ipxe.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 116 of file open.c.

                                                     {
         struct uri *uri;
         int rc;
 
         DBGC ( INTF_COL ( intf ), "INTF " INTF_FMT " opening URI %s\n",
                INTF_DBG ( intf ), uri_string );
 
         uri = parse_uri ( uri_string );
         if ( ! uri )
                 return -ENOMEM;
 
         rc = xfer_open_uri ( intf, uri );
 
         uri_put ( uri );
         return rc;
 }

References DBGC, ENOMEM, INTF_COL, INTF_DBG, INTF_FMT, parse_uri(), rc, uri_put(), and xfer_open_uri().

Referenced by open(), validator_start_download(), validator_start_ocsp(), and xfer_vopen().

◆ xfer_open_named_socket()

int xfer_open_named_socket	(	struct interface *	xfer,
		int	semantics,
		struct sockaddr *	peer,
		const char *	name,
		struct sockaddr *	local
	)

Open named socket.

Parameters

semantics	Communication semantics (e.g. SOCK_STREAM)
peer	Peer socket address to complete
name	Name to resolve
local	Local socket address, or NULL

Return values

rc	Return status code

Definition at line 403 of file resolv.c.

                                                       {
         struct named_socket *named;
         int rc;
 
         /* Allocate and initialise structure */
         named = zalloc ( sizeof ( *named ) );
         if ( ! named )
                 return -ENOMEM;
         ref_init ( &named->refcnt, NULL );
         intf_init ( &named->xfer, &named_xfer_desc, &named->refcnt );
         intf_init ( &named->resolv, &named_resolv_desc, &named->refcnt );
         named->semantics = semantics;
         if ( local ) {
                 memcpy ( &named->local, local, sizeof ( named->local ) );
                 named->have_local = 1;
         }
 
         DBGC ( named, "NAMED %p opening \"%s\"\n",
                named, name );
 
         /* Start name resolution */
         if ( ( rc = resolv ( &named->resolv, name, peer ) ) != 0 )
                 goto err;
 
         /* Attach parent interface, mortalise self, and return */
         intf_plug_plug ( &named->xfer, xfer );
         ref_put ( &named->refcnt );
         return 0;
 
  err:
         ref_put ( &named->refcnt );
         return rc;
 }

References DBGC, ENOMEM, named_socket::have_local, intf_init(), intf_plug_plug(), named_socket::local, memcpy(), name, named_resolv_desc, named_xfer_desc, NULL, peer, rc, ref_init, ref_put, named_socket::refcnt, named_socket::resolv, resolv(), named_socket::semantics, named_socket::xfer, and zalloc().

Referenced by apply_syslogs_settings(), create_pinger(), ftp_open(), http_connect(), iscsi_open_connection(), nfs_connect(), slam_open(), start_ntp(), tcp_open_uri(), tftp_reopen(), and udp_open_uri().

◆ xfer_open_socket()

int xfer_open_socket	(	struct interface *	intf,
		int	semantics,
		struct sockaddr *	peer,
		struct sockaddr *	local
	)

Open socket.

Parameters

intf	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 143 of file open.c.

                                                                        {
         struct socket_opener *opener;
 
         DBGC ( INTF_COL ( intf ), "INTF " INTF_FMT " opening (%s,%s) socket\n",
                INTF_DBG ( intf ), socket_semantics_name ( semantics ),
                socket_family_name ( peer->sa_family ) );
 
         for_each_table_entry ( opener, SOCKET_OPENERS ) {
                 if ( opener->semantics == semantics )
                         return opener->open ( intf, peer, local );
         }
 
         DBGC ( INTF_COL ( intf ), "INTF " INTF_FMT " attempted to open "
                "unsupported socket type (%s,%s)\n",
                INTF_DBG ( intf ), socket_semantics_name ( semantics ),
                socket_family_name ( peer->sa_family ) );
         return -ENOTSUP;
 }

References DBGC, ENOTSUP, for_each_table_entry, INTF_COL, INTF_DBG, INTF_FMT, socket_opener::open, peer, socket_opener::semantics, socket_family_name(), SOCKET_OPENERS, and socket_semantics_name().

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

◆ xfer_vopen()

int xfer_vopen	(	struct interface *	intf,
		int	type,
		va_list	args
	)

Open location.

Parameters

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

Return values

rc	Return status code

Definition at line 171 of file open.c.

                                                                   {
         switch ( type ) {
         case LOCATION_URI_STRING: {
                 const char *uri_string = va_arg ( args, const char * );
 
                 return xfer_open_uri_string ( intf, uri_string ); }
         case LOCATION_URI: {
                 struct uri *uri = va_arg ( args, struct uri * );
 
                 return xfer_open_uri ( intf, 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 ( intf, semantics, peer, local ); }
         default:
                 DBGC ( INTF_COL ( intf ), "INTF " INTF_FMT " attempted to "
                        "open unsupported location type %d\n",
                        INTF_DBG ( intf ), type );
                 return -ENOTSUP;
         }
 }

References DBGC, ENOTSUP, INTF_COL, INTF_DBG, INTF_FMT, LOCATION_SOCKET, LOCATION_URI, LOCATION_URI_STRING, peer, type, va_arg, xfer_open_socket(), xfer_open_uri(), and xfer_open_uri_string().

Referenced by xfer_open(), and xfer_vreopen().

◆ xfer_open()

int xfer_open	(	struct interface *	intf,
		int	type,
			...
	)

Open location.

Parameters

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

Return values

rc	Return status code

Definition at line 203 of file open.c.

                                                         {
         va_list args;
         int rc;
 
         va_start ( args, type );
         rc = xfer_vopen ( intf, type, args );
         va_end ( args );
         return rc;
 }

References rc, type, va_end, va_start, and xfer_vopen().

Referenced by efi_download_start().

◆ xfer_vreopen()

int xfer_vreopen	(	struct interface *	intf,
		int	type,
		va_list	args
	)

Reopen location.

Parameters

intf	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 225 of file open.c.

                                                                     {
 
         /* Close existing connection */
         intf_restart ( intf, 0 );
 
         /* Open new location */
         return xfer_vopen ( intf, type, args );
 }

References intf_restart(), type, and xfer_vopen().

Referenced by downloader_vredirect(), iscsi_vredirect(), and xfer_vredirect().

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ URI_OPENERS

◆ __uri_opener

◆ SOCKET_OPENERS

◆ __socket_opener

Enumeration Type Documentation

◆ anonymous enum

Function Documentation

◆ FILE_LICENCE()

◆ FILE_SECBOOT()

◆ xfer_uri_opener()

◆ xfer_open_uri()

◆ xfer_open_uri_string()

◆ xfer_open_named_socket()

◆ xfer_open_socket()

◆ xfer_vopen()

◆ xfer_open()

◆ xfer_vreopen()