socket.h File Reference

Socket addresses. More...

#include <stdint.h>
#include <ipxe/tables.h>

Go to the source code of this file.

Data Structures
struct	sockaddr
	Generalized socket address structure. More...
struct	sockaddr_converter
	Socket address converter. More...

Macros
#define	TCP_SOCK_STREAM   0x1
#define	SOCK_STREAM   tcp_sock_stream
#define	UDP_SOCK_DGRAM   0x2
#define	SOCK_DGRAM   udp_sock_dgram
#define	PING_SOCK_ECHO   0x3
#define	SOCK_ECHO   ping_sock_echo
#define	AF_INET   1
	IPv4 Internet addresses. More...
#define	AF_INET6   2
	IPv6 Internet addresses. More...
#define	AF_FC   3
	Fibre Channel addresses. More...
#define	SA_LEN   32
	Length of a struct sockaddr. More...
#define	SOCKADDR_CONVERTERS   __table ( struct sockaddr_converter, "sockaddr_converters" )
	Socket address converter table. More...
#define	__sockaddr_converter   __table_entry ( SOCKADDR_CONVERTERS, 01 )
	Declare a socket address converter. More...

Typedefs
typedef uint16_t	sa_family_t
	A socket address family. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static const char *	socket_semantics_name (int semantics)
	Name communication semantics. More...
static const char *	socket_family_name (int family)
	Name address family. More...
const char *	sock_ntoa (struct sockaddr *sa)
	Transcribe socket address. More...
int	sock_aton (const char *string, struct sockaddr *sa)
	Parse socket address. More...

Variables
int	tcp_sock_stream
	Connection-based, reliable streams. More...
int	udp_sock_dgram
	Connectionless, unreliable streams. More...
int	ping_sock_echo
	Echo testing streams. More...

Detailed Description

Socket addresses.

Definition in file socket.h.

Macro Definition Documentation

SA_LEN

#define SA_LEN   32

Length of a struct sockaddr.

Definition at line 89 of file socket.h.

SOCKADDR_CONVERTERS

#define SOCKADDR_CONVERTERS   __table ( struct sockaddr_converter, "sockaddr_converters" )

Socket address converter table.

Definition at line 138 of file socket.h.

__sockaddr_converter

#define __sockaddr_converter   __table_entry ( SOCKADDR_CONVERTERS, 01 )

Declare a socket address converter.

Definition at line 142 of file socket.h.

Typedef Documentation

sa_family_t

typedef uint16_t sa_family_t

A socket address family.

Definition at line 86 of file socket.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

socket_semantics_name()

static const char* socket_semantics_name ( int  semantics )

inlinestatic

Name communication semantics.

Parameters

semantics

Communication semantics (e.g. SOCK_STREAM)

Return values

name	Name of communication semantics

Definition at line 46 of file socket.h.

                                        {
        /* Cannot use a switch() because of the {TCP_UDP}_SOCK_XXX hack */
        if ( semantics == SOCK_STREAM ) {
                return "SOCK_STREAM";
        } else if ( semantics == SOCK_DGRAM ) {
                return "SOCK_DGRAM";
        } else if ( semantics == SOCK_ECHO ) {
                return "SOCK_ECHO";
        } else {
                return "SOCK_UNKNOWN";
        }
}

References SOCK_DGRAM, SOCK_ECHO, and SOCK_STREAM.

Referenced by xfer_open_socket().

socket_family_name()

static const char* socket_family_name ( int  family )

inlinestatic

Name address family.

Parameters

family

Address family (e.g. AF_INET)

Return values

name	Name of address family

Definition at line 76 of file socket.h.

                                  {
        switch ( family ) {
        case AF_INET:           return "AF_INET";
        case AF_INET6:          return "AF_INET6";
        case AF_FC:             return "AF_FC";
        default:                return "AF_UNKNOWN";
        }
}

References AF_FC, AF_INET, and AF_INET6.

Referenced by efi_pxe_start(), and xfer_open_socket().

sock_ntoa()

const char* sock_ntoa

(

struct sockaddr *

sa

)

Transcribe socket address.

Parameters

sa	Socket address

Return values

string

Socket address string

Definition at line 43 of file socket.c.

                                               {
        struct sockaddr_converter *converter;

        for_each_table_entry ( converter, SOCKADDR_CONVERTERS ) {
                if ( converter->family == sa->sa_family )
                        return converter->ntoa ( sa );
        }
        return NULL;
}

References sockaddr_converter::family, for_each_table_entry, sockaddr_converter::ntoa, NULL, sa, sockaddr::sa_family, and SOCKADDR_CONVERTERS.

Referenced by apply_dns_settings(), apply_syslog_settings(), dns_resolved(), dns_send_packet(), ping_callback(), pxe_tftp_open(), tcp_open(), tftp_uri(), and x509_check_ipaddress().

sock_aton()

int sock_aton	(	const char *	string,
		struct sockaddr *	sa
	)

Parse socket address.

Parameters

string	Socket address string
sa	Socket address to fill in

Return values

rc	Return status code

Definition at line 60 of file socket.c.

                                                          {
        struct sockaddr_converter *converter;

        for_each_table_entry ( converter, SOCKADDR_CONVERTERS ) {
                if ( converter->aton ( string, sa ) == 0 ) {
                        sa->sa_family = converter->family;
                        return 0;
                }
        }
        return -EINVAL;
}

References sockaddr_converter::aton, EINVAL, sockaddr_converter::family, for_each_table_entry, sa, sockaddr::sa_family, and SOCKADDR_CONVERTERS.

Referenced by numeric_resolv(), slam_parse_multicast_address(), and x509_check_ipaddress().