#include "lwip/opt.h"
#include "lwip/def.h"

Include dependency graph for ip_addr.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	ip_addr

struct	ip_addr_packed

struct	ip_addr2

struct	ip_info

Macros
#define	IP_ADDR_ANY ((ip_addr_t *)&ip_addr_any)

#define	IP_ADDR_BROADCAST ((ip_addr_t *)&ip_addr_broadcast)

#define	IPADDR_NONE ((u32_t)0xffffffffUL)

#define	IPADDR_LOOPBACK ((u32_t)0x7f000001UL)

#define	IPADDR_ANY ((u32_t)0x00000000UL)

#define	IPADDR_BROADCAST ((u32_t)0xffffffffUL)

#define	IP_CLASSA(a) ((((u32_t)(a)) & 0x80000000UL) == 0)

#define	IP_CLASSA_NET 0xff000000

#define	IP_CLASSA_NSHIFT 24

#define	IP_CLASSA_HOST (0xffffffff & ~IP_CLASSA_NET)

#define	IP_CLASSA_MAX 128

#define	IP_CLASSB(a) ((((u32_t)(a)) & 0xc0000000UL) == 0x80000000UL)

#define	IP_CLASSB_NET 0xffff0000

#define	IP_CLASSB_NSHIFT 16

#define	IP_CLASSB_HOST (0xffffffff & ~IP_CLASSB_NET)

#define	IP_CLASSB_MAX 65536

#define	IP_CLASSC(a) ((((u32_t)(a)) & 0xe0000000UL) == 0xc0000000UL)

#define	IP_CLASSC_NET 0xffffff00

#define	IP_CLASSC_NSHIFT 8

#define	IP_CLASSC_HOST (0xffffffff & ~IP_CLASSC_NET)

#define	IP_CLASSD(a) (((u32_t)(a) & 0xf0000000UL) == 0xe0000000UL)

#define	IP_CLASSD_NET 0xf0000000 /* These ones aren't really */

#define	IP_CLASSD_NSHIFT 28 /* net and host fields, but */

#define	IP_CLASSD_HOST 0x0fffffff /* routing needn't know. */

#define	IP_MULTICAST(a) IP_CLASSD(a)

#define	IP_EXPERIMENTAL(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)

#define	IP_BADCLASS(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)

#define	IP_LOOPBACKNET 127 /* official! */

#define	IP4_ADDR(ipaddr, a, b, c, d)

#define	IPADDR2_COPY(dest, src) SMEMCPY(dest, src, sizeof(ip_addr_t))

#define	ip_addr_copy(dest, src) ((dest).addr = (src).addr)

#define	ip_addr_set(dest, src)

#define	ip_addr_set_zero(ipaddr) ((ipaddr)->addr = 0)

#define	ip_addr_set_any(ipaddr) ((ipaddr)->addr = IPADDR_ANY)

#define	ip_addr_set_loopback(ipaddr) ((ipaddr)->addr = PP_HTONL(IPADDR_LOOPBACK))

#define	ip_addr_set_hton(dest, src)

#define	ip4_addr_set_u32(dest_ipaddr, src_u32) ((dest_ipaddr)->addr = (src_u32))

#define	ip4_addr_get_u32(src_ipaddr) ((src_ipaddr)->addr)

#define	ip_addr_get_network(target, host, netmask) ((target)->addr = ((host)->addr) & ((netmask)->addr))

#define	ip_addr_netcmp(addr1, addr2, mask)

#define	ip_addr_cmp(addr1, addr2) ((addr1)->addr == (addr2)->addr)

#define	ip_addr_isany(addr1) ((addr1) == NULL \|\| (addr1)->addr == IPADDR_ANY)

#define	ip_addr_isbroadcast(ipaddr, netif) ip4_addr_isbroadcast((ipaddr)->addr, (netif))

#define	ip_addr_netmask_valid(netmask) ip4_addr_netmask_valid((netmask)->addr)

#define	ip_addr_ismulticast(addr1) (((addr1)->addr & PP_HTONL(0xf0000000UL)) == PP_HTONL(0xe0000000UL))

#define	ip_addr_islinklocal(addr1) (((addr1)->addr & PP_HTONL(0xffff0000UL)) == PP_HTONL(0xa9fe0000UL))

#define	ip_addr_debug_print(debug, ipaddr)

#define	ip4_addr1(ipaddr) (((u8_t*)(ipaddr))[0])

#define	ip4_addr2(ipaddr) (((u8_t*)(ipaddr))[1])

#define	ip4_addr3(ipaddr) (((u8_t*)(ipaddr))[2])

#define	ip4_addr4(ipaddr) (((u8_t*)(ipaddr))[3])

#define	ip4_addr1_16(ipaddr) ((u16_t)ip4_addr1(ipaddr))

#define	ip4_addr2_16(ipaddr) ((u16_t)ip4_addr2(ipaddr))

#define	ip4_addr3_16(ipaddr) ((u16_t)ip4_addr3(ipaddr))

#define	ip4_addr4_16(ipaddr) ((u16_t)ip4_addr4(ipaddr))

#define	ip_ntoa(ipaddr) ipaddr_ntoa(ipaddr)

#define	IP2STR(ipaddr)

#define	IPSTR "%d.%d.%d.%d"

Typedefs
typedef typedefPACK_STRUCT_END struct ip_addr	ip_addr_t

typedef struct ip_addr_packed	ip_addr_p_t

Functions
u8_t	ip4_addr_isbroadcast (u32_t addr, const struct netif *netif) ICACHE_FLASH_ATTR

u8_t	ip4_addr_netmask_valid (u32_t netmask) ICACHE_FLASH_ATTR

u32_t	ipaddr_addr (const char *cp) ICACHE_FLASH_ATTR

int	ipaddr_aton (const char cp, ip_addr_t addr) ICACHE_FLASH_ATTR

char *	ipaddr_ntoa (const ip_addr_t *addr) ICACHE_FLASH_ATTR

char *	ipaddr_ntoa_r (const ip_addr_t addr, char buf, int buflen) ICACHE_FLASH_ATTR

Variables
PACK_STRUCT_BEGIN struct ip_addr_packed	PACK_STRUCT_STRUCT

const ip_addr_t	ip_addr_any

const ip_addr_t	ip_addr_broadcast

Macro Definition Documentation

◆ IP2STR

#define IP2STR ( ipaddr )

Value:

ip4_addr1_16(ipaddr), \
    ip4_addr2_16(ipaddr), \
    ip4_addr3_16(ipaddr), \
    ip4_addr4_16(ipaddr)

Definition at line 240 of file ip_addr.h.

Referenced by acl_check_packet(), and wifi_softap_ip_config().

◆ IP4_ADDR

#define IP4_ADDR	(	ipaddr,
		a,
		b,
		c,
		d
	)

Value:

(ipaddr)->addr = ((u32_t)((a) & 0xff) << 24) | \
                         ((u32_t)((b) & 0xff) << 16) | \
                         ((u32_t)((c) & 0xff) << 8)  | \
                          (u32_t)((d) & 0xff)

Set an IP address given by the four byte-parts

Definition at line 139 of file ip_addr.h.

Referenced by dhcps_start(), espconn_connect(), espconn_find_connection(), espconn_tcp_client(), espconn_udp_sendto(), espconn_udp_sent(), netif_init(), and wifi_softap_ip_config().

◆ ip4_addr1

#define ip4_addr1 ( ipaddr ) (((u8_t*)(ipaddr))[0])

Definition at line 220 of file ip_addr.h.

Referenced by add_offer_options(), and captdnsRecv().

◆ ip4_addr1_16

#define ip4_addr1_16 ( ipaddr ) ((u16_t)ip4_addr1(ipaddr))

Definition at line 226 of file ip_addr.h.

Referenced by espconn_client_connect(), espconn_tcp_accept(), espconn_udp_recv(), ip_output(), ip_route(), ip_router(), netif_set_gw(), netif_set_ipaddr(), and netif_set_netmask().

◆ ip4_addr2

#define ip4_addr2 ( ipaddr ) (((u8_t*)(ipaddr))[1])

Definition at line 221 of file ip_addr.h.

Referenced by add_offer_options(), and captdnsRecv().

◆ ip4_addr2_16

#define ip4_addr2_16 ( ipaddr ) ((u16_t)ip4_addr2(ipaddr))

Definition at line 227 of file ip_addr.h.

Referenced by espconn_client_connect(), espconn_tcp_accept(), espconn_udp_recv(), ip_output(), ip_route(), ip_router(), netif_set_gw(), netif_set_ipaddr(), and netif_set_netmask().

◆ ip4_addr3

#define ip4_addr3 ( ipaddr ) (((u8_t*)(ipaddr))[2])

Definition at line 222 of file ip_addr.h.

Referenced by add_offer_options(), captdnsRecv(), and wifi_softap_ip_config().

◆ ip4_addr3_16

#define ip4_addr3_16 ( ipaddr ) ((u16_t)ip4_addr3(ipaddr))

Definition at line 228 of file ip_addr.h.

Referenced by espconn_client_connect(), espconn_tcp_accept(), espconn_udp_recv(), ip_output(), ip_route(), ip_router(), netif_set_gw(), netif_set_ipaddr(), and netif_set_netmask().

◆ ip4_addr4

#define ip4_addr4 ( ipaddr ) (((u8_t*)(ipaddr))[3])

Definition at line 223 of file ip_addr.h.

Referenced by add_offer_options(), captdnsRecv(), patch_netif_ap(), and wifi_softap_ip_config().

◆ ip4_addr4_16

#define ip4_addr4_16 ( ipaddr ) ((u16_t)ip4_addr4(ipaddr))

Definition at line 229 of file ip_addr.h.

Referenced by espconn_client_connect(), espconn_tcp_accept(), espconn_udp_recv(), ip_output(), ip_route(), ip_router(), netif_set_gw(), netif_set_ipaddr(), and netif_set_netmask().

◆ ip4_addr_get_u32

#define ip4_addr_get_u32 ( src_ipaddr ) ((src_ipaddr)->addr)

IPv4 only: get the IP address as an u32_t

Definition at line 181 of file ip_addr.h.

Referenced by inet_chksum_pseudo(), inet_chksum_pseudo_partial(), ip4_addr_isbroadcast(), ip_input(), ip_output_if(), ipaddr_addr(), and ipaddr_ntoa_r().

◆ ip4_addr_set_u32

#define ip4_addr_set_u32	(	dest_ipaddr,
		src_u32
	)	((dest_ipaddr)->addr = (src_u32))

IPv4 only: set the IP address given as an u32_t

Definition at line 179 of file ip_addr.h.

Referenced by ip4_addr_isbroadcast(), and ipaddr_aton().

◆ IP_ADDR_ANY

#define IP_ADDR_ANY ((ip_addr_t *)&ip_addr_any)

IP_ADDR_ can be used as a fixed IP address for the wildcard and the broadcast address

Definition at line 92 of file ip_addr.h.

Referenced by espconn_tcp_client(), espconn_tcp_server(), and espconn_udp_server().

◆ IP_ADDR_BROADCAST

#define IP_ADDR_BROADCAST ((ip_addr_t *)&ip_addr_broadcast)

Definition at line 93 of file ip_addr.h.

◆ ip_addr_cmp

#define ip_addr_cmp	(	addr1,
		addr2
	)	((addr1)->addr == (addr2)->addr)

Definition at line 198 of file ip_addr.h.

Referenced by ip_input(), ip_output_if(), netif_set_ipaddr(), and wifi_softap_ip_config().

◆ ip_addr_copy

#define ip_addr_copy	(	dest,
		src
	)	((dest).addr = (src).addr)

Copy IP address - faster than ip_addr_set: no NULL check

Definition at line 162 of file ip_addr.h.

Referenced by ip_input(), and ip_output_if().

◆ ip_addr_debug_print

#define ip_addr_debug_print	(	debug,
		ipaddr
	)

Value:

LWIP_DEBUGF(debug, ("%"U16_F".%"U16_F".%"U16_F".%"U16_F,             \
                      ipaddr != NULL ? ip4_addr1_16(ipaddr) : 0,       \
                      ipaddr != NULL ? ip4_addr2_16(ipaddr) : 0,       \
                      ipaddr != NULL ? ip4_addr3_16(ipaddr) : 0,       \
                      ipaddr != NULL ? ip4_addr4_16(ipaddr) : 0))

Definition at line 212 of file ip_addr.h.

Referenced by netif_add().

◆ ip_addr_get_network

#define ip_addr_get_network	(	target,
		host,
		netmask
	)	((target)->addr = ((host)->addr) & ((netmask)->addr))

Get the network address by combining host address with netmask

Definition at line 184 of file ip_addr.h.

◆ ip_addr_isany

#define ip_addr_isany ( addr1 ) ((addr1) == NULL || (addr1)->addr == IPADDR_ANY)

Definition at line 200 of file ip_addr.h.

Referenced by ip_input(), ip_output_if(), ip_router(), netif_set_ipaddr(), and parse_msg().

◆ ip_addr_isbroadcast

#define ip_addr_isbroadcast	(	ipaddr,
		netif
	)	ip4_addr_isbroadcast((ipaddr)->addr, (netif))

Definition at line 202 of file ip_addr.h.

Referenced by ip_input(), and ip_route().

◆ ip_addr_islinklocal

#define ip_addr_islinklocal ( addr1 ) (((addr1)->addr & PP_HTONL(0xffff0000UL)) == PP_HTONL(0xa9fe0000UL))

Definition at line 210 of file ip_addr.h.

Referenced by ip_router(), and netif_set_ipaddr().

◆ ip_addr_ismulticast

#define ip_addr_ismulticast ( addr1 ) (((addr1)->addr & PP_HTONL(0xf0000000UL)) == PP_HTONL(0xe0000000UL))

Definition at line 208 of file ip_addr.h.

Referenced by ip_input().

◆ ip_addr_netcmp

#define ip_addr_netcmp	(	addr1,
		addr2,
		mask
	)

Value:

(((addr1)->addr & \
                                              (mask)->addr) == \
                                             ((addr2)->addr & \
                                              (mask)->addr))

Determine if two address are on the same network.

addr1 IP address 1
addr2 IP address 2
mask network identifier mask
Returns
!0 if the network identifiers of both address match

Definition at line 194 of file ip_addr.h.

Referenced by espconn_udp_recv(), ip4_addr_isbroadcast(), ip_route(), and ip_router().

◆ ip_addr_netmask_valid

#define ip_addr_netmask_valid ( netmask ) ip4_addr_netmask_valid((netmask)->addr)

Definition at line 205 of file ip_addr.h.

◆ ip_addr_set

#define ip_addr_set	(	dest,
		src
	)

Value:

((dest)->addr = \
                                    ((src) == NULL ? 0 : \
                                    (src)->addr))

Safely copy one IP address to another (src may be NULL)

Definition at line 164 of file ip_addr.h.

Referenced by netif_set_gw(), netif_set_ipaddr(), and netif_set_netmask().

◆ ip_addr_set_any

#define ip_addr_set_any ( ipaddr ) ((ipaddr)->addr = IPADDR_ANY)

Set address to IPADDR_ANY (no need for htonl())

Definition at line 170 of file ip_addr.h.

Referenced by ip_input().

◆ ip_addr_set_hton

#define ip_addr_set_hton	(	dest,
		src
	)

Value:

((dest)->addr = \
                               ((src) == NULL ? 0:\
                               htonl((src)->addr)))

Safely copy one IP address to another and change byte order from host- to network-order.

Definition at line 175 of file ip_addr.h.

◆ ip_addr_set_loopback

#define ip_addr_set_loopback ( ipaddr ) ((ipaddr)->addr = PP_HTONL(IPADDR_LOOPBACK))

Set address to loopback address

Definition at line 172 of file ip_addr.h.

◆ ip_addr_set_zero

#define ip_addr_set_zero ( ipaddr ) ((ipaddr)->addr = 0)

Set complete address to zero

Definition at line 168 of file ip_addr.h.

Referenced by netif_add().

◆ IP_BADCLASS

#define IP_BADCLASS ( a ) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)

Definition at line 132 of file ip_addr.h.

◆ IP_CLASSA

#define IP_CLASSA ( a ) ((((u32_t)(a)) & 0x80000000UL) == 0)

Definition at line 108 of file ip_addr.h.

◆ IP_CLASSA_HOST

#define IP_CLASSA_HOST (0xffffffff & ~IP_CLASSA_NET)

Definition at line 111 of file ip_addr.h.

◆ IP_CLASSA_MAX

#define IP_CLASSA_MAX 128

Definition at line 112 of file ip_addr.h.

◆ IP_CLASSA_NET

#define IP_CLASSA_NET 0xff000000

Definition at line 109 of file ip_addr.h.

◆ IP_CLASSA_NSHIFT

#define IP_CLASSA_NSHIFT 24

Definition at line 110 of file ip_addr.h.

◆ IP_CLASSB

#define IP_CLASSB ( a ) ((((u32_t)(a)) & 0xc0000000UL) == 0x80000000UL)

Definition at line 114 of file ip_addr.h.

◆ IP_CLASSB_HOST

#define IP_CLASSB_HOST (0xffffffff & ~IP_CLASSB_NET)

Definition at line 117 of file ip_addr.h.

◆ IP_CLASSB_MAX

#define IP_CLASSB_MAX 65536

Definition at line 118 of file ip_addr.h.

◆ IP_CLASSB_NET

#define IP_CLASSB_NET 0xffff0000

Definition at line 115 of file ip_addr.h.

◆ IP_CLASSB_NSHIFT

#define IP_CLASSB_NSHIFT 16

Definition at line 116 of file ip_addr.h.

◆ IP_CLASSC

#define IP_CLASSC ( a ) ((((u32_t)(a)) & 0xe0000000UL) == 0xc0000000UL)

Definition at line 120 of file ip_addr.h.

◆ IP_CLASSC_HOST

#define IP_CLASSC_HOST (0xffffffff & ~IP_CLASSC_NET)

Definition at line 123 of file ip_addr.h.

◆ IP_CLASSC_NET

#define IP_CLASSC_NET 0xffffff00

Definition at line 121 of file ip_addr.h.

◆ IP_CLASSC_NSHIFT

#define IP_CLASSC_NSHIFT 8

Definition at line 122 of file ip_addr.h.

◆ IP_CLASSD

#define IP_CLASSD ( a ) (((u32_t)(a) & 0xf0000000UL) == 0xe0000000UL)

Definition at line 125 of file ip_addr.h.

◆ IP_CLASSD_HOST

#define IP_CLASSD_HOST 0x0fffffff /* routing needn't know. */

Definition at line 128 of file ip_addr.h.

◆ IP_CLASSD_NET

#define IP_CLASSD_NET 0xf0000000 /* These ones aren't really */

Definition at line 126 of file ip_addr.h.

◆ IP_CLASSD_NSHIFT

#define IP_CLASSD_NSHIFT 28 /* net and host fields, but */

Definition at line 127 of file ip_addr.h.

◆ IP_EXPERIMENTAL

#define IP_EXPERIMENTAL ( a ) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)

Definition at line 131 of file ip_addr.h.

◆ IP_LOOPBACKNET

#define IP_LOOPBACKNET 127 /* official! */

Definition at line 134 of file ip_addr.h.

◆ IP_MULTICAST

#define IP_MULTICAST ( a ) IP_CLASSD(a)

Definition at line 129 of file ip_addr.h.

◆ ip_ntoa

#define ip_ntoa ( ipaddr ) ipaddr_ntoa(ipaddr)

For backwards compatibility

Definition at line 232 of file ip_addr.h.

◆ IPADDR2_COPY

#define IPADDR2_COPY	(	dest,
		src
	)	SMEMCPY(dest, src, sizeof(ip_addr_t))

MEMCPY-like copying of IP addresses where addresses are known to be 16-bit-aligned if the port is correctly configured (so a port could define this to copying 2 u16_t's) - no NULL-pointer-checking needed.

Definition at line 158 of file ip_addr.h.

◆ IPADDR_ANY

#define IPADDR_ANY ((u32_t)0x00000000UL)

0.0.0.0

Definition at line 100 of file ip_addr.h.

Referenced by espconn_find_connection(), and ip4_addr_isbroadcast().

◆ IPADDR_BROADCAST

#define IPADDR_BROADCAST ((u32_t)0xffffffffUL)

255.255.255.255

Definition at line 102 of file ip_addr.h.

Referenced by acl_check_packet(), and ip4_addr_isbroadcast().

◆ IPADDR_LOOPBACK

#define IPADDR_LOOPBACK ((u32_t)0x7f000001UL)

127.0.0.1

Definition at line 98 of file ip_addr.h.

◆ IPADDR_NONE

#define IPADDR_NONE ((u32_t)0xffffffffUL)

255.255.255.255

Definition at line 96 of file ip_addr.h.

Referenced by ipaddr_addr().

◆ IPSTR

#define IPSTR "%d.%d.%d.%d"

Definition at line 245 of file ip_addr.h.

Referenced by wifi_softap_ip_config().

Typedef Documentation

◆ ip_addr_p_t

typedef struct ip_addr_packed ip_addr_p_t

Definition at line 65 of file ip_addr.h.

◆ ip_addr_t

typedef typedefPACK_STRUCT_END struct ip_addr ip_addr_t

ip_addr_t uses a struct for convenience only, so that the same defines can operate both on ip_addr_t as well as on ip_addr_p_t.

Definition at line 64 of file ip_addr.h.

Function Documentation

◆ ip4_addr_isbroadcast()

u8_t ip4_addr_isbroadcast	(	u32_t	addr,
		const struct netif *	netif
	)

Determine if an address is a broadcast address on a network interface

Parameters

addr	address to be checked
netif	the network interface against which the address is checked

Returns: returns non-zero if the address is a broadcast address

Definition at line 55 of file ip_addr.c.

References netif::flags, ip4_addr_get_u32, ip4_addr_set_u32, netif::ip_addr, ip_addr_netcmp, IPADDR_ANY, IPADDR_BROADCAST, NETIF_FLAG_BROADCAST, and netif::netmask.

 {
   ip_addr_t ipaddr;
   ip4_addr_set_u32(&ipaddr, addr);
 
   /* all ones (broadcast) or all zeroes (old skool broadcast) */
   if ((~addr == IPADDR_ANY) ||
       (addr == IPADDR_ANY)) {
     return 1;
   /* no broadcast support on this network interface? */
   } else if ((netif->flags & NETIF_FLAG_BROADCAST) == 0) {
     /* the given address cannot be a broadcast address
      * nor can we check against any broadcast addresses */
     return 0;
   /* address matches network interface address exactly? => no broadcast */
   } else if (addr == ip4_addr_get_u32(&netif->ip_addr)) {
     return 0;
   /*  on the same (sub) network... */
   } else if (ip_addr_netcmp(&ipaddr, &(netif->ip_addr), &(netif->netmask))
          /* ...and host identifier bits are all ones? =>... */
           && ((addr & ~ip4_addr_get_u32(&netif->netmask)) ==
            (IPADDR_BROADCAST & ~ip4_addr_get_u32(&netif->netmask)))) {
     /* => network broadcast address */
     return 1;
   } else {
     return 0;
   }
 }

◆ ip4_addr_netmask_valid()

u8_t ip4_addr_netmask_valid ( u32_t netmask )

Checks if a netmask is valid (starting with ones, then only zeros)

Parameters

netmask the IPv4 netmask to check (in network byte order!)

Returns: 1 if the netmask is valid, 0 if it is not

Definition at line 90 of file ip_addr.c.

References lwip_htonl().

 {
   u32_t mask;
   u32_t nm_hostorder = lwip_htonl(netmask);
 
   /* first, check for the first zero */
   for (mask = 1U << 31 ; mask != 0; mask >>= 1) {
     if ((nm_hostorder & mask) == 0) {
       break;
     }
   }
   /* then check that there is no one */
   for (; mask != 0; mask >>= 1) {
     if ((nm_hostorder & mask) != 0) {
       /* there is a one after the first zero -> invalid */
       return 0;
     }
   }
   /* no one after the first zero -> valid */
   return 1;
 }

Here is the call graph for this function:

◆ ipaddr_addr()

u32_t ipaddr_addr ( const char * cp )

Ascii internet address interpretation routine. The value returned is in network order.

Parameters

cp	IP address in ascii represenation (e.g. "127.0.0.1")

Returns: ip address in network order

Definition at line 130 of file ip_addr.c.

 {
   ip_addr_t val;
 
   if (ipaddr_aton(cp, &val)) {
     return ip4_addr_get_u32(&val);
   }
   return (IPADDR_NONE);
 }

◆ ipaddr_aton()

int ipaddr_aton	(	const char *	cp,
		ip_addr_t *	addr
	)

Check whether "cp" is a valid ascii representation of an Internet address and convert to a binary address. Returns 1 if the address is valid, 0 if not. This replaces inet_addr, the return value from which cannot distinguish between failure and a local broadcast address.

Parameters

cp	IP address in ascii represenation (e.g. "127.0.0.1")
addr	pointer to which to save the ip address in network order

Returns: 1 if cp could be converted to addr, 0 on failure

Definition at line 152 of file ip_addr.c.

References htonl, ip4_addr_set_u32, islower, isspace, isxdigit, and LWIP_ASSERT.

Referenced by ipaddr_addr().

 {
   u32_t val;
   u8_t base;
   char c;
   char ch;
   unsigned long cutoff;
   int cutlim;
   u32_t parts[4];
   u32_t *pp = parts;
 
   c = *cp;
   for (;;) {
     /*
      * Collect number up to ``.''.
      * Values are specified as for C:
      * 0x=hex, 0=octal, 1-9=decimal.
      */
     if (!isdigit(c))
       return (0);
     val = 0;
     base = 10;
     if (c == '0') {
       c = *++cp;
       if (c == 'x' || c == 'X') {
         base = 16;
         c = *++cp;
       } else
         base = 8;
     }
 
     cutoff =(unsigned long)0xffffffff / (unsigned long)base;
     cutlim =(unsigned long)0xffffffff % (unsigned long)base;
 
     for (;;) {
       if (isdigit(c)) {
         ch = (int)(c - '0');
 
         if (val > cutoff || (val == cutoff && ch > cutlim))
             return (0);
 
         val = (val * base) + (int)(c - '0');
         c = *++cp;
       } else if (base == 16 && isxdigit(c)) {
         ch = (int)(c + 10 - (islower(c) ? 'a' : 'A'));
 
         if (val > cutoff || (val == cutoff && ch > cutlim))
             return (0);
 
         val = (val << 4) | (int)(c + 10 - (islower(c) ? 'a' : 'A'));
         c = *++cp;
       } else
         break;
     }
     if (c == '.') {
       /*
        * Internet format:
        *  a.b.c.d
        *  a.b.c   (with c treated as 16 bits)
        *  a.b (with b treated as 24 bits)
        */
       if (pp >= parts + 3) {
         return (0);
       }
       *pp++ = val;
       c = *++cp;
     } else
       break;
   }
   /*
    * Check for trailing characters.
    */
   if (c != '\0' && !isspace(c)) {
     return (0);
   }
   /*
    * Concoct the address according to
    * the number of parts specified.
    */
   switch (pp - parts + 1) {
 
   case 0:
     return (0);       /* initial nondigit */
 
   case 1:             /* a -- 32 bits */
     break;
 
   case 2:             /* a.b -- 8.24 bits */
     if ((val > 0xffffffUL) || (parts[0] > 0xff)) {
       return (0);
     }
     val |= parts[0] << 24;
     break;
 
   case 3:             /* a.b.c -- 8.8.16 bits */
     if ((val > 0xffff) || (parts[0] > 0xff) || (parts[1] > 0xff)) {
       return (0);
     }
     val |= (parts[0] << 24) | (parts[1] << 16);
     break;
 
   case 4:             /* a.b.c.d -- 8.8.8.8 bits */
     if ((val > 0xff) || (parts[0] > 0xff) || (parts[1] > 0xff) || (parts[2] > 0xff)) {
       return (0);
     }
     val |= (parts[0] << 24) | (parts[1] << 16) | (parts[2] << 8);
     break;
   default:
     LWIP_ASSERT("unhandled", 0);
     break;
   }
   if (addr) {
     ip4_addr_set_u32(addr, htonl(val));
   }
   return (1);
 }

Here is the caller graph for this function:

◆ ipaddr_ntoa()

char* ipaddr_ntoa ( const ip_addr_t * addr )

returns ptr to static buffer; not reentrant!

Convert numeric IP address into decimal dotted ASCII representation. returns ptr to static buffer; not reentrant!

Parameters

addr	ip address in network order to convert

Returns: pointer to a global static (!) buffer that holds the ASCII represenation of addr

Definition at line 278 of file ip_addr.c.

References ipaddr_ntoa_r().

 {
   static char str[16];
   return ipaddr_ntoa_r(addr, str, 16);
 }

Here is the call graph for this function:

◆ ipaddr_ntoa_r()

char* ipaddr_ntoa_r	(	const ip_addr_t *	addr,
		char *	buf,
		int	buflen
	)

Same as ipaddr_ntoa, but reentrant since a user-supplied buffer is used.

Parameters

addr	ip address in network order to convert
buf	target buffer where the string is stored
buflen	length of buf

Returns: either pointer to buf which now holds the ASCII representation of addr or NULL if buf was too small

Definition at line 293 of file ip_addr.c.

References ip4_addr_get_u32, and NULL.

Referenced by ipaddr_ntoa().

 {
   u32_t s_addr;
   char inv[3];
   char *rp;
   u8_t *ap;
   u8_t rem;
   u8_t n;
   u8_t i;
   int len = 0;
 
   s_addr = ip4_addr_get_u32(addr);
 
   rp = buf;
   ap = (u8_t *)&s_addr;
   for(n = 0; n < 4; n++) {
     i = 0;
     do {
       rem = *ap % (u8_t)10;
       *ap /= (u8_t)10;
       inv[i++] = '0' + rem;
     } while(*ap);
     while(i--) {
       if (len++ >= buflen) {
         return NULL;
       }
       *rp++ = inv[i];
     }
     if (len++ >= buflen) {
       return NULL;
     }
     *rp++ = '.';
     ap++;
   }
   *--rp = 0;
   return buf;
 }

Here is the caller graph for this function:

Variable Documentation

◆ ip_addr_any

const ip_addr_t ip_addr_any

◆ ip_addr_broadcast

const ip_addr_t ip_addr_broadcast

◆ PACK_STRUCT_STRUCT

PACK_STRUCT_BEGIN struct ip_addr2 PACK_STRUCT_STRUCT

Data Structures

Macros

Typedefs

Functions

Variables

Macro Definition Documentation

◆ IP2STR

◆ IP4_ADDR

◆ ip4_addr1

◆ ip4_addr1_16

◆ ip4_addr2

◆ ip4_addr2_16

◆ ip4_addr3

◆ ip4_addr3_16

◆ ip4_addr4

◆ ip4_addr4_16

◆ ip4_addr_get_u32

◆ ip4_addr_set_u32

◆ IP_ADDR_ANY

◆ IP_ADDR_BROADCAST

◆ ip_addr_cmp

◆ ip_addr_copy

◆ ip_addr_debug_print

◆ ip_addr_get_network

◆ ip_addr_isany

◆ ip_addr_isbroadcast

◆ ip_addr_islinklocal

◆ ip_addr_ismulticast

◆ ip_addr_netcmp

◆ ip_addr_netmask_valid

◆ ip_addr_set

◆ ip_addr_set_any

◆ ip_addr_set_hton

◆ ip_addr_set_loopback

◆ ip_addr_set_zero

◆ IP_BADCLASS

◆ IP_CLASSA

◆ IP_CLASSA_HOST

◆ IP_CLASSA_MAX

◆ IP_CLASSA_NET

◆ IP_CLASSA_NSHIFT

◆ IP_CLASSB

◆ IP_CLASSB_HOST

◆ IP_CLASSB_MAX

◆ IP_CLASSB_NET

◆ IP_CLASSB_NSHIFT

◆ IP_CLASSC

◆ IP_CLASSC_HOST

◆ IP_CLASSC_NET

◆ IP_CLASSC_NSHIFT

◆ IP_CLASSD

◆ IP_CLASSD_HOST

◆ IP_CLASSD_NET

◆ IP_CLASSD_NSHIFT

◆ IP_EXPERIMENTAL

◆ IP_LOOPBACKNET

◆ IP_MULTICAST

◆ ip_ntoa

◆ IPADDR2_COPY

◆ IPADDR_ANY

◆ IPADDR_BROADCAST

◆ IPADDR_LOOPBACK

◆ IPADDR_NONE

◆ IPSTR

Typedef Documentation

◆ ip_addr_p_t

◆ ip_addr_t

Function Documentation

◆ ip4_addr_isbroadcast()

◆ ip4_addr_netmask_valid()

◆ ipaddr_addr()

◆ ipaddr_aton()

◆ ipaddr_ntoa()

◆ ipaddr_ntoa_r()

Variable Documentation

◆ ip_addr_any

◆ ip_addr_broadcast

◆ PACK_STRUCT_STRUCT