#include <stdint.h>
#include <byteswap.h>
#include <ipxe/socket.h>

Data Structures
struct	in_addr
	IP address structure. More...

struct	in6_addr
	IP6 address structure. More...

struct	sockaddr_in
	IPv4 socket address. More...

struct	sockaddr_in6
	IPv6 socket address. More...

Macros
#define	IP_ICMP 1

#define	IP_TCP 6

#define	IP_UDP 17

#define	IP_ICMP6 58

#define	INADDR_NONE htonl ( 0xffffffff )

#define	INADDR_BROADCAST htonl ( 0xffffffff )

#define	INADDR_NET_CLASSA htonl ( 0xff000000 )

#define	INADDR_NET_CLASSB htonl ( 0xffff0000 )

#define	INADDR_NET_CLASSC htonl ( 0xffffff00 )

#define	IN_IS_CLASSA(addr) ( ( (addr) & htonl ( 0x80000000 ) ) == htonl ( 0x00000000 ) )

#define	IN_IS_CLASSB(addr) ( ( (addr) & htonl ( 0xc0000000 ) ) == htonl ( 0x80000000 ) )

#define	IN_IS_CLASSC(addr) ( ( (addr) & htonl ( 0xe0000000 ) ) == htonl ( 0xc0000000 ) )

#define	IN_IS_MULTICAST(addr) ( ( (addr) & htonl ( 0xf0000000 ) ) == htonl ( 0xe0000000 ) )

#define	IN_IS_SMALL(mask) ( (mask) & htonl ( 0x00000003 ) )

#define	s6_addr in6_u.u6_addr8

#define	s6_addr16 in6_u.u6_addr16

#define	s6_addr32 in6_u.u6_addr32

#define	IN6_IS_ADDR_UNSPECIFIED(addr)

#define	IN6_IS_ADDR_MULTICAST(addr) ( ( ( const uint8_t ) (addr) ) == 0xff )

#define	IN6_IS_ADDR_LINKLOCAL(addr)

#define	IN6_IS_ADDR_SITELOCAL(addr)

#define	IN6_IS_ADDR_ULA(addr) ( ( ( ( const uint8_t ) (addr) ) & 0xfe ) == 0xfc )

Typedefs
typedef struct in_addr	in_addr

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)

	FILE_SECBOOT (PERMITTED)

int	inet_aton (const char cp, struct in_addr inp)
	Parse IPv4 address. More...

char *	inet_ntoa (struct in_addr in)
	Convert IPv4 address to dotted-quad notation. More...

int	inet6_aton (const char string, struct in6_addr in)
	Parse IPv6 address. More...

char *	inet6_ntoa (const struct in6_addr *in)
	Convert IPv6 address to standard notation. More...

Macro Definition Documentation

◆ IP_ICMP

#define IP_ICMP 1

Definition at line 13 of file in.h.

◆ IP_TCP

#define IP_TCP 6

Definition at line 14 of file in.h.

◆ IP_UDP

#define IP_UDP 17

Definition at line 15 of file in.h.

◆ IP_ICMP6

#define IP_ICMP6 58

Definition at line 16 of file in.h.

◆ INADDR_NONE

#define INADDR_NONE htonl ( 0xffffffff )

Definition at line 20 of file in.h.

◆ INADDR_BROADCAST

#define INADDR_BROADCAST htonl ( 0xffffffff )

Definition at line 22 of file in.h.

◆ INADDR_NET_CLASSA

#define INADDR_NET_CLASSA htonl ( 0xff000000 )

Definition at line 24 of file in.h.

◆ INADDR_NET_CLASSB

#define INADDR_NET_CLASSB htonl ( 0xffff0000 )

Definition at line 25 of file in.h.

◆ INADDR_NET_CLASSC

#define INADDR_NET_CLASSC htonl ( 0xffffff00 )

Definition at line 26 of file in.h.

◆ IN_IS_CLASSA

#define IN_IS_CLASSA ( addr ) ( ( (addr) & htonl ( 0x80000000 ) ) == htonl ( 0x00000000 ) )

Definition at line 28 of file in.h.

◆ IN_IS_CLASSB

#define IN_IS_CLASSB ( addr ) ( ( (addr) & htonl ( 0xc0000000 ) ) == htonl ( 0x80000000 ) )

Definition at line 30 of file in.h.

◆ IN_IS_CLASSC

#define IN_IS_CLASSC ( addr ) ( ( (addr) & htonl ( 0xe0000000 ) ) == htonl ( 0xc0000000 ) )

Definition at line 32 of file in.h.

◆ IN_IS_MULTICAST

#define IN_IS_MULTICAST ( addr ) ( ( (addr) & htonl ( 0xf0000000 ) ) == htonl ( 0xe0000000 ) )

Definition at line 34 of file in.h.

◆ IN_IS_SMALL

#define IN_IS_SMALL ( mask ) ( (mask) & htonl ( 0x00000003 ) )

Definition at line 37 of file in.h.

◆ s6_addr

#define s6_addr in6_u.u6_addr8

Definition at line 57 of file in.h.

◆ s6_addr16

#define s6_addr16 in6_u.u6_addr16

Definition at line 58 of file in.h.

◆ s6_addr32

#define s6_addr32 in6_u.u6_addr32

Definition at line 59 of file in.h.

◆ IN6_IS_ADDR_UNSPECIFIED

#define IN6_IS_ADDR_UNSPECIFIED ( addr )

Value:

( ( ( ( ( const uint32_t * ) (addr) )[0] ) |                    \
            ( ( ( const uint32_t * ) (addr) )[1] ) |                    \
            ( ( ( const uint32_t * ) (addr) )[2] ) |                    \
            ( ( ( const uint32_t * ) (addr) )[3] ) ) == 0 )

Definition at line 62 of file in.h.

◆ IN6_IS_ADDR_MULTICAST

#define IN6_IS_ADDR_MULTICAST ( addr ) ( *( ( const uint8_t * ) (addr) ) == 0xff )

Definition at line 68 of file in.h.

◆ IN6_IS_ADDR_LINKLOCAL

#define IN6_IS_ADDR_LINKLOCAL ( addr )

Value:

( ( *( ( const uint16_t * ) (addr) ) & htons ( 0xffc0 ) ) == \

htons ( 0xfe80 ) )

uint16_t

unsigned short uint16_t

Definition: stdint.h:11

addr

uint32_t addr

Buffer address.

Definition: dwmac.h:20

htons

#define htons(value)

Definition: byteswap.h:136

Definition at line 71 of file in.h.

◆ IN6_IS_ADDR_SITELOCAL

#define IN6_IS_ADDR_SITELOCAL ( addr )

Value:

( ( *( ( const uint16_t * ) (addr) ) & htons ( 0xffc0 ) ) == \

htons ( 0xfec0 ) )

uint16_t

unsigned short uint16_t

Definition: stdint.h:11

addr

uint32_t addr

Buffer address.

Definition: dwmac.h:20

htons

#define htons(value)

Definition: byteswap.h:136

Definition at line 75 of file in.h.

◆ IN6_IS_ADDR_ULA

#define IN6_IS_ADDR_ULA ( addr ) ( ( *( ( const uint8_t * ) (addr) ) & 0xfe ) == 0xfc )

Definition at line 79 of file in.h.

Typedef Documentation

◆ in_addr

typedef struct in_addr in_addr

Definition at line 46 of file in.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )

◆ inet_aton()

int inet_aton	(	const char *	string,
		struct in_addr *	in
	)

Parse IPv4 address.

Parameters

string IPv4 address string

Return values

in	IPv4 address to fill in
ok	IPv4 address is valid

Note that this function returns nonzero iff the address is valid, to match the standard BSD API function of the same name. Unlike most other iPXE functions, a zero therefore indicates failure.

Definition at line 787 of file ipv4.c.

                                                          {
         const char *separator = "...";
         uint8_t *byte = ( ( uint8_t * ) in );
         char *endp;
         unsigned long value;
 
         while ( 1 ) {
                 value = strtoul ( string, &endp, 0 );
                 if ( string == endp )
                         return 0;
                 if ( value > 0xff )
                         return 0;
                 *(byte++) = value;
                 if ( *endp != *separator )
                         return 0;
                 if ( ! *(separator++) )
                         return 1;
                 string = ( endp + 1 );
         }
 }

References in, strtoul(), and value.

Referenced by inet_aton_fail_okx(), inet_aton_okx(), ipv4_route_okx(), ipv4_sock_aton(), parse_ipv4_setting(), and tftp_process_multicast().

◆ inet_ntoa()

char* inet_ntoa ( struct in_addr in )

Convert IPv4 address to dotted-quad notation.

Parameters

in	IPv4 address

Return values

string IPv4 address in dotted-quad notation

Definition at line 814 of file ipv4.c.

                                        {
         static char buf[16]; /* "xxx.xxx.xxx.xxx" */
         uint8_t *bytes = ( uint8_t * ) &in;
         
         sprintf ( buf, "%d.%d.%d.%d", bytes[0], bytes[1], bytes[2], bytes[3] );
         return buf;
 }

References bytes, in, and sprintf.

Referenced by dhcp_deliver(), dhcp_discovery_rx(), dhcp_proxy_rx(), dhcp_proxy_tx(), dhcp_pxebs_accept(), dhcp_pxebs_rx(), dhcp_pxebs_tx(), dhcp_request_rx(), dhcp_request_tx(), efi_snp_mcast_ip_to_mac(), fetch_next_server_and_filename(), format_ipv4_setting(), gve_describe(), ibft_ipaddr(), inet_aton_okx(), inet_ntoa_okx(), ipoib_transmit(), ipv4_add_miniroute(), ipv4_del_miniroute(), ipv4_gratuitous_arp(), ipv4_ntoa(), ipv4_route_okx(), ipv4_rx(), ipv4_sock_ntoa(), ipv4_tx(), pxenv_udp_open(), pxenv_udp_read(), pxenv_udp_write(), pxenv_undi_get_mcast_address(), route_ipv4_print(), start_pxebs(), tftp_apply_settings(), and tftp_process_multicast().

◆ inet6_aton()

int inet6_aton	(	const char *	string,
		struct in6_addr *	in
	)

Parse IPv6 address.

Parameters

string IPv6 address string

Return values

in	IPv6 address to fill in
rc	Return status code

Definition at line 825 of file ipv6.c.

                                                            {
         uint16_t *word = in->s6_addr16;
         uint16_t *end = ( word + ( sizeof ( in->s6_addr16 ) /
                                    sizeof ( in->s6_addr16[0] ) ) );
         uint16_t *pad = NULL;
         const char *nptr = string;
         char *endptr;
         unsigned long value;
         size_t pad_len;
         size_t move_len;
 
         /* Parse string */
         while ( 1 ) {
 
                 /* Parse current word */
                 value = strtoul ( nptr, &endptr, 16 );
                 if ( value > 0xffff ) {
                         DBG ( "IPv6 invalid word value %#lx in \"%s\"\n",
                               value, string );
                         return -EINVAL;
                 }
                 *(word++) = htons ( value );
 
                 /* Parse separator */
                 if ( ! *endptr )
                         break;
                 if ( *endptr != ':' ) {
                         DBG ( "IPv6 invalid separator '%c' in \"%s\"\n",
                               *endptr, string );
                         return -EINVAL;
                 }
                 if ( ( endptr == nptr ) && ( nptr != string ) ) {
                         if ( pad ) {
                                 DBG ( "IPv6 invalid multiple \"::\" in "
                                       "\"%s\"\n", string );
                                 return -EINVAL;
                         }
                         pad = word;
                 }
                 nptr = ( endptr + 1 );
 
                 /* Check for overrun */
                 if ( word == end ) {
                         DBG ( "IPv6 too many words in \"%s\"\n", string );
                         return -EINVAL;
                 }
         }
 
         /* Insert padding if specified */
         if ( pad ) {
                 move_len = ( ( ( void * ) word ) - ( ( void * ) pad ) );
                 pad_len = ( ( ( void * ) end ) - ( ( void * ) word ) );
                 memmove ( ( ( ( void * ) pad ) + pad_len ), pad, move_len );
                 memset ( pad, 0, pad_len );
         } else if ( word != end ) {
                 DBG ( "IPv6 underlength address \"%s\"\n", string );
                 return -EINVAL;
         }
 
         return 0;
 }

References DBG, EINVAL, end, htons, in, memmove(), memset(), NULL, pad, pad_len, string, strtoul(), and value.

Referenced by inet6_aton_fail_okx(), inet6_aton_okx(), ipv6_route_okx(), ipv6_sock_aton(), ipv6_table_okx(), and parse_ipv6_setting().

◆ inet6_ntoa()

char* inet6_ntoa ( const struct in6_addr * in )

Convert IPv6 address to standard notation.

Parameters

in	IPv6 address

Return values

string IPv6 address string in canonical format

RFC5952 defines the canonical format for IPv6 textual representation.

Definition at line 895 of file ipv6.c.

                                                 {
         static char buf[41]; /* ":xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx" */
         char *out = buf;
         char *longest_start = NULL;
         char *start = NULL;
         int longest_len = 1;
         int len = 0;
         char *dest;
         unsigned int i;
         uint16_t value;
 
         /* Format address, keeping track of longest run of zeros */
         for ( i = 0 ; i < ( sizeof ( in->s6_addr16 ) /
                             sizeof ( in->s6_addr16[0] ) ) ; i++ ) {
                 value = ntohs ( in->s6_addr16[i] );
                 if ( value == 0 ) {
                         if ( len++ == 0 )
                                 start = out;
                         if ( len > longest_len ) {
                                 longest_start = start;
                                 longest_len = len;
                         }
                 } else {
                         len = 0;
                 }
                 out += sprintf ( out, ":%x", value );
         }
 
         /* Abbreviate longest run of zeros, if applicable */
         if ( longest_start ) {
                 dest = strcpy ( ( longest_start + 1 ),
                                 ( longest_start + ( 2 * longest_len ) ) );
                 if ( dest[0] == '\0' )
                         dest[1] = '\0';
                 dest[0] = ':';
         }
         return ( ( longest_start == buf ) ? buf : ( buf + 1 ) );
 }

References dest, in, len, ntohs, NULL, out, sprintf, start, strcpy(), and value.

Referenced by dhcpv6_rx(), format_ipv6_setting(), inet6_aton_okx(), inet6_ntoa_okx(), ipv6_dump_miniroute(), ipv6_ntoa(), ipv6_route_okx(), ipv6_rx(), ipv6_sock_ntoa(), ipv6_tx(), ndp_prefix_fetch_ip6(), ndp_rx_neighbour_advertisement_ll_target(), ndp_rx_neighbour_solicitation_ll_source(), ndp_rx_router_advertisement_ll_source(), ndp_rx_router_advertisement_prefix(), and route_ipv6_print().

Data Structures

Macros

Typedefs

Functions

Macro Definition Documentation

◆ IP_ICMP

◆ IP_TCP

◆ IP_UDP

◆ IP_ICMP6

◆ INADDR_NONE

◆ INADDR_BROADCAST

◆ INADDR_NET_CLASSA

◆ INADDR_NET_CLASSB

◆ INADDR_NET_CLASSC

◆ IN_IS_CLASSA

◆ IN_IS_CLASSB

◆ IN_IS_CLASSC

◆ IN_IS_MULTICAST

◆ IN_IS_SMALL

◆ s6_addr

◆ s6_addr16

◆ s6_addr32

◆ IN6_IS_ADDR_UNSPECIFIED

◆ IN6_IS_ADDR_MULTICAST

◆ IN6_IS_ADDR_LINKLOCAL

◆ IN6_IS_ADDR_SITELOCAL

◆ IN6_IS_ADDR_ULA

Typedef Documentation

◆ in_addr

Function Documentation

◆ FILE_LICENCE()

◆ FILE_SECBOOT()

◆ inet_aton()

◆ inet_ntoa()

◆ inet6_aton()

◆ inet6_ntoa()