123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256 |
- /*
- * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- * 3. The name of the author may not be used to endorse or promote products
- * derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
- * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
- * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
- * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
- * OF SUCH DAMAGE.
- *
- * This file is part of the lwIP TCP/IP stack.
- *
- * Author: Adam Dunkels <adam@sics.se>
- *
- */
- #ifndef __LWIP_IP_ADDR_H__
- #define __LWIP_IP_ADDR_H__
- #include "lwip/opt.h"
- #include "lwip/def.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- /* This is the aligned version of ip_addr_t,
- used as local variable, on the stack, etc. */
- struct ip_addr {
- u32_t addr;
- };
- /* This is the packed version of ip_addr_t,
- used in network headers that are itself packed */
- #ifdef PACK_STRUCT_USE_INCLUDES
- # include "arch/bpstruct.h"
- #endif
- PACK_STRUCT_BEGIN
- struct ip_addr_packed {
- PACK_STRUCT_FIELD(u32_t addr);
- } PACK_STRUCT_STRUCT;
- PACK_STRUCT_END
- #ifdef PACK_STRUCT_USE_INCLUDES
- # include "arch/epstruct.h"
- #endif
- /** 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. */
- typedef struct ip_addr ip_addr_t;
- typedef struct ip_addr_packed ip_addr_p_t;
- /*
- * struct ipaddr2 is used in the definition of the ARP packet format in
- * order to support compilers that don't have structure packing.
- */
- #ifdef PACK_STRUCT_USE_INCLUDES
- # include "arch/bpstruct.h"
- #endif
- PACK_STRUCT_BEGIN
- struct ip_addr2 {
- PACK_STRUCT_FIELD(u16_t addrw[2]);
- } PACK_STRUCT_STRUCT;
- PACK_STRUCT_END
- #ifdef PACK_STRUCT_USE_INCLUDES
- # include "arch/epstruct.h"
- #endif
- /* Forward declaration to not include netif.h */
- struct netif;
- extern const ip_addr_t ip_addr_any;
- extern const ip_addr_t ip_addr_broadcast;
- /** IP_ADDR_ can be used as a fixed IP address
- * for the wildcard and the broadcast address
- */
- #define IP_ADDR_ANY ((ip_addr_t *)&ip_addr_any)
- #define IP_ADDR_BROADCAST ((ip_addr_t *)&ip_addr_broadcast)
- /** 255.255.255.255 */
- #define IPADDR_NONE ((u32_t)0xffffffffUL)
- /** 127.0.0.1 */
- #define IPADDR_LOOPBACK ((u32_t)0x7f000001UL)
- /** 0.0.0.0 */
- #define IPADDR_ANY ((u32_t)0x00000000UL)
- /** 255.255.255.255 */
- #define IPADDR_BROADCAST ((u32_t)0xffffffffUL)
- /* Definitions of the bits in an Internet address integer.
- On subnets, host and network parts are found according to
- the subnet mask, not these masks. */
- #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! */
- #if BYTE_ORDER == BIG_ENDIAN
- /** Set an IP address given by the four byte-parts */
- #define IP4_ADDR(ipaddr, a,b,c,d) \
- (ipaddr)->addr = ((u32_t)((a) & 0xff) << 24) | \
- ((u32_t)((b) & 0xff) << 16) | \
- ((u32_t)((c) & 0xff) << 8) | \
- (u32_t)((d) & 0xff)
- #else
- /** Set an IP address given by the four byte-parts.
- Little-endian version that prevents the use of htonl. */
- #define IP4_ADDR(ipaddr, a,b,c,d) \
- (ipaddr)->addr = ((u32_t)((d) & 0xff) << 24) | \
- ((u32_t)((c) & 0xff) << 16) | \
- ((u32_t)((b) & 0xff) << 8) | \
- (u32_t)((a) & 0xff)
- #endif
- /** 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. */
- #ifndef IPADDR2_COPY
- #define IPADDR2_COPY(dest, src) SMEMCPY(dest, src, sizeof(ip_addr_t))
- #endif
- /** Copy IP address - faster than ip_addr_set: no NULL check */
- #define ip_addr_copy(dest, src) ((dest).addr = (src).addr)
- /** Safely copy one IP address to another (src may be NULL) */
- #define ip_addr_set(dest, src) ((dest)->addr = \
- ((src) == NULL ? 0 : \
- (src)->addr))
- /** Set complete address to zero */
- #define ip_addr_set_zero(ipaddr) ((ipaddr)->addr = 0)
- /** Set address to IPADDR_ANY (no need for htonl()) */
- #define ip_addr_set_any(ipaddr) ((ipaddr)->addr = IPADDR_ANY)
- /** Set address to loopback address */
- #define ip_addr_set_loopback(ipaddr) ((ipaddr)->addr = PP_HTONL(IPADDR_LOOPBACK))
- /** Safely copy one IP address to another and change byte order
- * from host- to network-order. */
- #define ip_addr_set_hton(dest, src) ((dest)->addr = \
- ((src) == NULL ? 0:\
- htonl((src)->addr)))
- /** IPv4 only: set the IP address given as an u32_t */
- #define ip4_addr_set_u32(dest_ipaddr, src_u32) ((dest_ipaddr)->addr = (src_u32))
- /** IPv4 only: get the IP address as an u32_t */
- #define ip4_addr_get_u32(src_ipaddr) ((src_ipaddr)->addr)
- /** Get the network address by combining host address with netmask */
- #define ip_addr_get_network(target, host, netmask) ((target)->addr = ((host)->addr) & ((netmask)->addr))
- /**
- * Determine if two address are on the same network.
- *
- * @arg addr1 IP address 1
- * @arg addr2 IP address 2
- * @arg mask network identifier mask
- * @return !0 if the network identifiers of both address match
- */
- #define ip_addr_netcmp(addr1, addr2, mask) (((addr1)->addr & \
- (mask)->addr) == \
- ((addr2)->addr & \
- (mask)->addr))
- #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))
- u8_t ip4_addr_isbroadcast(u32_t addr, const struct netif *netif)ICACHE_FLASH_ATTR;
- #define ip_addr_netmask_valid(netmask) ip4_addr_netmask_valid((netmask)->addr)
- u8_t ip4_addr_netmask_valid(u32_t netmask)ICACHE_FLASH_ATTR;
- #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) \
- 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))
- /* Get one byte from the 4-byte address */
- #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])
- /* These are cast to u16_t, with the intent that they are often arguments
- * to printf using the U16_F format from cc.h. */
- #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))
- /** For backwards compatibility */
- #define ip_ntoa(ipaddr) ipaddr_ntoa(ipaddr)
- u32_t ipaddr_addr(const char *cp)ICACHE_FLASH_ATTR;
- int ipaddr_aton(const char *cp, ip_addr_t *addr)ICACHE_FLASH_ATTR;
- /** returns ptr to static buffer; not reentrant! */
- 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;
- #define IP2STR(ipaddr) ip4_addr1_16(ipaddr), \
- ip4_addr2_16(ipaddr), \
- ip4_addr3_16(ipaddr), \
- ip4_addr4_16(ipaddr)
- #define IPSTR "%d.%d.%d.%d"
- struct ip_info {
- struct ip_addr ip;
- struct ip_addr netmask;
- struct ip_addr gw;
- };
- #ifdef __cplusplus
- }
- #endif
- #endif /* __LWIP_IP_ADDR_H__ */
|