| /** |
| * @file |
| * IPv4 address API |
| */ |
| |
| /* |
| * 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_HDR_IP4_ADDR_H |
| #define LWIP_HDR_IP4_ADDR_H |
| |
| #include "lwip/opt.h" |
| #include "lwip/def.h" |
| |
| #if LWIP_IPV4 |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /** This is the aligned version of ip4_addr_t, |
| used as local variable, on the stack, etc. */ |
| struct ip4_addr { |
| u32_t addr; |
| }; |
| |
| /** ip4_addr_t uses a struct for convenience only, so that the same defines can |
| * operate both on ip4_addr_t as well as on ip4_addr_p_t. */ |
| typedef struct ip4_addr ip4_addr_t; |
| |
| /* Forward declaration to not include netif.h */ |
| struct netif; |
| |
| /** 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! */ |
| |
| /** Set an IP address given by the four byte-parts */ |
| #define IP4_ADDR(ipaddr, a,b,c,d) (ipaddr)->addr = PP_HTONL(LWIP_MAKEU32(a,b,c,d)) |
| |
| /** Copy IP address - faster than ip4_addr_set: no NULL check */ |
| #define ip4_addr_copy(dest, src) ((dest).addr = (src).addr) |
| /** Safely copy one IP address to another (src may be NULL) */ |
| #define ip4_addr_set(dest, src) ((dest)->addr = \ |
| ((src) == NULL ? 0 : \ |
| (src)->addr)) |
| /** Set complete address to zero */ |
| #define ip4_addr_set_zero(ipaddr) ((ipaddr)->addr = 0) |
| /** Set address to IPADDR_ANY (no need for lwip_htonl()) */ |
| #define ip4_addr_set_any(ipaddr) ((ipaddr)->addr = IPADDR_ANY) |
| /** Set address to loopback address */ |
| #define ip4_addr_set_loopback(ipaddr) ((ipaddr)->addr = PP_HTONL(IPADDR_LOOPBACK)) |
| /** Check if an address is in the loopback region */ |
| #define ip4_addr_isloopback(ipaddr) (((ipaddr)->addr & PP_HTONL(IP_CLASSA_NET)) == PP_HTONL(((u32_t)IP_LOOPBACKNET) << 24)) |
| /** Safely copy one IP address to another and change byte order |
| * from host- to network-order. */ |
| #define ip4_addr_set_hton(dest, src) ((dest)->addr = \ |
| ((src) == NULL ? 0:\ |
| lwip_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 ip4_addr_get_network(target, host, netmask) do { ((target)->addr = ((host)->addr) & ((netmask)->addr)); } while(0) |
| |
| /** |
| * 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 ip4_addr_netcmp(addr1, addr2, mask) (((addr1)->addr & \ |
| (mask)->addr) == \ |
| ((addr2)->addr & \ |
| (mask)->addr)) |
| #define ip4_addr_cmp(addr1, addr2) ((addr1)->addr == (addr2)->addr) |
| |
| #define ip4_addr_isany_val(addr1) ((addr1).addr == IPADDR_ANY) |
| #define ip4_addr_isany(addr1) ((addr1) == NULL || ip4_addr_isany_val(*(addr1))) |
| |
| #define ip4_addr_isbroadcast(addr1, netif) ip4_addr_isbroadcast_u32((addr1)->addr, netif) |
| u8_t ip4_addr_isbroadcast_u32(u32_t addr, const struct netif *netif); |
| |
| #define ip_addr_netmask_valid(netmask) ip4_addr_netmask_valid((netmask)->addr) |
| u8_t ip4_addr_netmask_valid(u32_t netmask); |
| |
| #define ip4_addr_ismulticast(addr1) (((addr1)->addr & PP_HTONL(0xf0000000UL)) == PP_HTONL(0xe0000000UL)) |
| |
| #define ip4_addr_islinklocal(addr1) (((addr1)->addr & PP_HTONL(0xffff0000UL)) == PP_HTONL(0xa9fe0000UL)) |
| |
| #define ip4_addr_debug_print_parts(debug, a, b, c, d) \ |
| LWIP_DEBUGF(debug, ("%" U16_F ".%" U16_F ".%" U16_F ".%" U16_F, a, b, c, d)) |
| #define ip4_addr_debug_print(debug, ipaddr) \ |
| ip4_addr_debug_print_parts(debug, \ |
| (u16_t)((ipaddr) != NULL ? ip4_addr1_16(ipaddr) : 0), \ |
| (u16_t)((ipaddr) != NULL ? ip4_addr2_16(ipaddr) : 0), \ |
| (u16_t)((ipaddr) != NULL ? ip4_addr3_16(ipaddr) : 0), \ |
| (u16_t)((ipaddr) != NULL ? ip4_addr4_16(ipaddr) : 0)) |
| #define ip4_addr_debug_print_val(debug, ipaddr) \ |
| ip4_addr_debug_print_parts(debug, \ |
| ip4_addr1_16_val(ipaddr), \ |
| ip4_addr2_16_val(ipaddr), \ |
| ip4_addr3_16_val(ipaddr), \ |
| ip4_addr4_16_val(ipaddr)) |
| |
| /* Get one byte from the 4-byte address */ |
| #define ip4_addr_get_byte(ipaddr, idx) (((const u8_t*)(&(ipaddr)->addr))[idx]) |
| #define ip4_addr1(ipaddr) ip4_addr_get_byte(ipaddr, 0) |
| #define ip4_addr2(ipaddr) ip4_addr_get_byte(ipaddr, 1) |
| #define ip4_addr3(ipaddr) ip4_addr_get_byte(ipaddr, 2) |
| #define ip4_addr4(ipaddr) ip4_addr_get_byte(ipaddr, 3) |
| /* Get one byte from the 4-byte address, but argument is 'ip4_addr_t', |
| * not a pointer */ |
| #define ip4_addr_get_byte_val(ipaddr, idx) ((u8_t)(((ipaddr).addr >> (idx * 8)) & 0xff)) |
| #define ip4_addr1_val(ipaddr) ip4_addr_get_byte_val(ipaddr, 0) |
| #define ip4_addr2_val(ipaddr) ip4_addr_get_byte_val(ipaddr, 1) |
| #define ip4_addr3_val(ipaddr) ip4_addr_get_byte_val(ipaddr, 2) |
| #define ip4_addr4_val(ipaddr) ip4_addr_get_byte_val(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)) |
| #define ip4_addr1_16_val(ipaddr) ((u16_t)ip4_addr1_val(ipaddr)) |
| #define ip4_addr2_16_val(ipaddr) ((u16_t)ip4_addr2_val(ipaddr)) |
| #define ip4_addr3_16_val(ipaddr) ((u16_t)ip4_addr3_val(ipaddr)) |
| #define ip4_addr4_16_val(ipaddr) ((u16_t)ip4_addr4_val(ipaddr)) |
| |
| #define IP4ADDR_STRLEN_MAX 16 |
| |
| /** For backwards compatibility */ |
| #define ip_ntoa(ipaddr) ipaddr_ntoa(ipaddr) |
| |
| u32_t ipaddr_addr(const char *cp); |
| int ip4addr_aton(const char *cp, ip4_addr_t *addr); |
| /** returns ptr to static buffer; not reentrant! */ |
| char *ip4addr_ntoa(const ip4_addr_t *addr); |
| char *ip4addr_ntoa_r(const ip4_addr_t *addr, char *buf, int buflen); |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* LWIP_IPV4 */ |
| |
| #endif /* LWIP_HDR_IP_ADDR_H */ |