open.h

Go to the documentation of this file.

#ifndef _IPXE_OPEN_H
#define _IPXE_OPEN_H

/** @file
 *
 * Data transfer interface opening
 *
 */

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
FILE_SECBOOT ( PERMITTED );

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

struct uri;
struct interface;

/** Location types */
enum {
        /** 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,
};

/** A URI opener */
struct uri_opener {
        /** URI protocol name
         *
         * This is the "scheme" portion of the URI, e.g. "http" or
         * "file".
         */
        const char *scheme;
        /** Open URI
         *
         * @v intf              Object interface
         * @v uri               URI
         * @ret rc              Return status code
         */
        int ( * open ) ( struct interface *intf, struct uri *uri );
};

/** URI opener table */
#define URI_OPENERS __table ( struct uri_opener, "uri_openers" )

/** Register a URI opener */
#define __uri_opener __table_entry ( URI_OPENERS, 01 )

/** A socket opener */
struct socket_opener {
        /** Communication semantics (e.g. SOCK_STREAM) */
        int semantics;
        /** Open socket
         *
         * @v intf              Object interface
         * @v peer              Peer socket address
         * @v local             Local socket address, or NULL
         * @ret rc              Return status code
         */
        int ( * open ) ( struct interface *intf, struct sockaddr *peer,
                         struct sockaddr *local );
};

/** Socket opener table */
#define SOCKET_OPENERS __table ( struct socket_opener, "socket_openers" )

/** Register a socket opener */
#define __socket_opener __table_entry ( SOCKET_OPENERS, 01 )

extern struct uri_opener * xfer_uri_opener ( const char *scheme );
extern int xfer_open_uri ( struct interface *intf, struct uri *uri );
extern int xfer_open_uri_string ( struct interface *intf,
                                  const char *uri_string );
extern int xfer_open_named_socket ( struct interface *intf, int semantics,
                                    struct sockaddr *peer, const char *name,
                                    struct sockaddr *local );
extern int xfer_open_socket ( struct interface *intf, int semantics,
                              struct sockaddr *peer, struct sockaddr *local );
extern int xfer_vopen ( struct interface *intf, int type, va_list args );
extern int xfer_open ( struct interface *intf, int type, ... );
extern int xfer_vreopen ( struct interface *intf, int type,
                          va_list args );

#endif /* _IPXE_OPEN_H */