| 1 | /**
|
|---|
| 2 | * @file
|
|---|
| 3 | * IPv4 address API
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
|
|---|
| 8 | * All rights reserved.
|
|---|
| 9 | *
|
|---|
| 10 | * Redistribution and use in source and binary forms, with or without modification,
|
|---|
| 11 | * are permitted provided that the following conditions are met:
|
|---|
| 12 | *
|
|---|
| 13 | * 1. Redistributions of source code must retain the above copyright notice,
|
|---|
| 14 | * this list of conditions and the following disclaimer.
|
|---|
| 15 | * 2. Redistributions in binary form must reproduce the above copyright notice,
|
|---|
| 16 | * this list of conditions and the following disclaimer in the documentation
|
|---|
| 17 | * and/or other materials provided with the distribution.
|
|---|
| 18 | * 3. The name of the author may not be used to endorse or promote products
|
|---|
| 19 | * derived from this software without specific prior written permission.
|
|---|
| 20 | *
|
|---|
| 21 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
|
|---|
| 22 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|---|
| 23 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
|
|---|
| 24 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|---|
| 25 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
|
|---|
| 26 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|---|
| 27 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|---|
| 28 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
|
|---|
| 29 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
|
|---|
| 30 | * OF SUCH DAMAGE.
|
|---|
| 31 | *
|
|---|
| 32 | * This file is part of the lwIP TCP/IP stack.
|
|---|
| 33 | *
|
|---|
| 34 | * Author: Adam Dunkels <adam@sics.se>
|
|---|
| 35 | *
|
|---|
| 36 | */
|
|---|
| 37 | #ifndef LWIP_HDR_IP4_ADDR_H
|
|---|
| 38 | #define LWIP_HDR_IP4_ADDR_H
|
|---|
| 39 |
|
|---|
| 40 | #include "lwip/opt.h"
|
|---|
| 41 | #include "lwip/def.h"
|
|---|
| 42 |
|
|---|
| 43 | #if LWIP_IPV4
|
|---|
| 44 |
|
|---|
| 45 | #ifdef __cplusplus
|
|---|
| 46 | extern "C" {
|
|---|
| 47 | #endif
|
|---|
| 48 |
|
|---|
| 49 | /** This is the aligned version of ip4_addr_t,
|
|---|
| 50 | used as local variable, on the stack, etc. */
|
|---|
| 51 | struct ip4_addr {
|
|---|
| 52 | u32_t addr;
|
|---|
| 53 | };
|
|---|
| 54 |
|
|---|
| 55 | /** ip4_addr_t uses a struct for convenience only, so that the same defines can
|
|---|
| 56 | * operate both on ip4_addr_t as well as on ip4_addr_p_t. */
|
|---|
| 57 | typedef struct ip4_addr ip4_addr_t;
|
|---|
| 58 |
|
|---|
| 59 | /* Forward declaration to not include netif.h */
|
|---|
| 60 | struct netif;
|
|---|
| 61 |
|
|---|
| 62 | /** 255.255.255.255 */
|
|---|
| 63 | #define IPADDR_NONE ((u32_t)0xffffffffUL)
|
|---|
| 64 | /** 127.0.0.1 */
|
|---|
| 65 | #define IPADDR_LOOPBACK ((u32_t)0x7f000001UL)
|
|---|
| 66 | /** 0.0.0.0 */
|
|---|
| 67 | #define IPADDR_ANY ((u32_t)0x00000000UL)
|
|---|
| 68 | /** 255.255.255.255 */
|
|---|
| 69 | #define IPADDR_BROADCAST ((u32_t)0xffffffffUL)
|
|---|
| 70 |
|
|---|
| 71 | /* Definitions of the bits in an Internet address integer.
|
|---|
| 72 |
|
|---|
| 73 | On subnets, host and network parts are found according to
|
|---|
| 74 | the subnet mask, not these masks. */
|
|---|
| 75 | #define IP_CLASSA(a) ((((u32_t)(a)) & 0x80000000UL) == 0)
|
|---|
| 76 | #define IP_CLASSA_NET 0xff000000
|
|---|
| 77 | #define IP_CLASSA_NSHIFT 24
|
|---|
| 78 | #define IP_CLASSA_HOST (0xffffffff & ~IP_CLASSA_NET)
|
|---|
| 79 | #define IP_CLASSA_MAX 128
|
|---|
| 80 |
|
|---|
| 81 | #define IP_CLASSB(a) ((((u32_t)(a)) & 0xc0000000UL) == 0x80000000UL)
|
|---|
| 82 | #define IP_CLASSB_NET 0xffff0000
|
|---|
| 83 | #define IP_CLASSB_NSHIFT 16
|
|---|
| 84 | #define IP_CLASSB_HOST (0xffffffff & ~IP_CLASSB_NET)
|
|---|
| 85 | #define IP_CLASSB_MAX 65536
|
|---|
| 86 |
|
|---|
| 87 | #define IP_CLASSC(a) ((((u32_t)(a)) & 0xe0000000UL) == 0xc0000000UL)
|
|---|
| 88 | #define IP_CLASSC_NET 0xffffff00
|
|---|
| 89 | #define IP_CLASSC_NSHIFT 8
|
|---|
| 90 | #define IP_CLASSC_HOST (0xffffffff & ~IP_CLASSC_NET)
|
|---|
| 91 |
|
|---|
| 92 | #define IP_CLASSD(a) (((u32_t)(a) & 0xf0000000UL) == 0xe0000000UL)
|
|---|
| 93 | #define IP_CLASSD_NET 0xf0000000 /* These ones aren't really */
|
|---|
| 94 | #define IP_CLASSD_NSHIFT 28 /* net and host fields, but */
|
|---|
| 95 | #define IP_CLASSD_HOST 0x0fffffff /* routing needn't know. */
|
|---|
| 96 | #define IP_MULTICAST(a) IP_CLASSD(a)
|
|---|
| 97 |
|
|---|
| 98 | #define IP_EXPERIMENTAL(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)
|
|---|
| 99 | #define IP_BADCLASS(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)
|
|---|
| 100 |
|
|---|
| 101 | #define IP_LOOPBACKNET 127 /* official! */
|
|---|
| 102 |
|
|---|
| 103 | /** Set an IP address given by the four byte-parts */
|
|---|
| 104 | #define IP4_ADDR(ipaddr, a,b,c,d) (ipaddr)->addr = PP_HTONL(LWIP_MAKEU32(a,b,c,d))
|
|---|
| 105 |
|
|---|
| 106 | /** Copy IP address - faster than ip4_addr_set: no NULL check */
|
|---|
| 107 | #define ip4_addr_copy(dest, src) MEMCPY(&((dest).addr), &((src).addr), 4)
|
|---|
| 108 | /** Safely copy one IP address to another (src may be NULL) */
|
|---|
| 109 | #define ip4_addr_set(dest, src) ((dest)->addr = \
|
|---|
| 110 | ((src) == NULL ? 0 : \
|
|---|
| 111 | (src)->addr))
|
|---|
| 112 | /** Set complete address to zero */
|
|---|
| 113 | #define ip4_addr_set_zero(ipaddr) ((ipaddr)->addr = 0)
|
|---|
| 114 | /** Set address to IPADDR_ANY (no need for lwip_htonl()) */
|
|---|
| 115 | #define ip4_addr_set_any(ipaddr) ((ipaddr)->addr = IPADDR_ANY)
|
|---|
| 116 | /** Set address to loopback address */
|
|---|
| 117 | #define ip4_addr_set_loopback(ipaddr) ((ipaddr)->addr = PP_HTONL(IPADDR_LOOPBACK))
|
|---|
| 118 | /** Check if an address is in the loopback region */
|
|---|
| 119 | #define ip4_addr_isloopback(ipaddr) (((ipaddr)->addr & PP_HTONL(IP_CLASSA_NET)) == PP_HTONL(((u32_t)IP_LOOPBACKNET) << 24))
|
|---|
| 120 | /** Safely copy one IP address to another and change byte order
|
|---|
| 121 | * from host- to network-order. */
|
|---|
| 122 | #define ip4_addr_set_hton(dest, src) ((dest)->addr = \
|
|---|
| 123 | ((src) == NULL ? 0:\
|
|---|
| 124 | lwip_htonl((src)->addr)))
|
|---|
| 125 | /** IPv4 only: set the IP address given as an u32_t */
|
|---|
| 126 | #define ip4_addr_set_u32(dest_ipaddr, src_u32) ((dest_ipaddr)->addr = (src_u32))
|
|---|
| 127 | /** IPv4 only: get the IP address as an u32_t */
|
|---|
| 128 | #define ip4_addr_get_u32(src_ipaddr) ((src_ipaddr)->addr)
|
|---|
| 129 |
|
|---|
| 130 | /** Get the network address by combining host address with netmask */
|
|---|
| 131 | #define ip4_addr_get_network(target, host, netmask) do { ((target)->addr = ((host)->addr) & ((netmask)->addr)); } while(0)
|
|---|
| 132 |
|
|---|
| 133 | /**
|
|---|
| 134 | * Determine if two address are on the same network.
|
|---|
| 135 | *
|
|---|
| 136 | * @arg addr1 IP address 1
|
|---|
| 137 | * @arg addr2 IP address 2
|
|---|
| 138 | * @arg mask network identifier mask
|
|---|
| 139 | * @return !0 if the network identifiers of both address match
|
|---|
| 140 | */
|
|---|
| 141 | #define ip4_addr_netcmp(addr1, addr2, mask) (((addr1)->addr & \
|
|---|
| 142 | (mask)->addr) == \
|
|---|
| 143 | ((addr2)->addr & \
|
|---|
| 144 | (mask)->addr))
|
|---|
| 145 | #define ip4_addr_cmp(addr1, addr2) ((addr1)->addr == (addr2)->addr)
|
|---|
| 146 |
|
|---|
| 147 | #define ip4_addr_isany_val(addr1) ((addr1).addr == IPADDR_ANY)
|
|---|
| 148 | #define ip4_addr_isany(addr1) ((addr1) == NULL || ip4_addr_isany_val(*(addr1)))
|
|---|
| 149 |
|
|---|
| 150 | #define ip4_addr_isbroadcast(addr1, netif) ip4_addr_isbroadcast_u32((addr1)->addr, netif)
|
|---|
| 151 | u8_t ip4_addr_isbroadcast_u32(u32_t addr, const struct netif *netif);
|
|---|
| 152 |
|
|---|
| 153 | #define ip_addr_netmask_valid(netmask) ip4_addr_netmask_valid((netmask)->addr)
|
|---|
| 154 | u8_t ip4_addr_netmask_valid(u32_t netmask);
|
|---|
| 155 |
|
|---|
| 156 | #define ip4_addr_ismulticast(addr1) (((addr1)->addr & PP_HTONL(0xf0000000UL)) == PP_HTONL(0xe0000000UL))
|
|---|
| 157 |
|
|---|
| 158 | #define ip4_addr_islinklocal(addr1) (((addr1)->addr & PP_HTONL(0xffff0000UL)) == PP_HTONL(0xa9fe0000UL))
|
|---|
| 159 |
|
|---|
| 160 | #define ip4_addr_debug_print_parts(debug, a, b, c, d) \
|
|---|
| 161 | LWIP_DEBUGF(debug, ("%" U16_F ".%" U16_F ".%" U16_F ".%" U16_F, a, b, c, d))
|
|---|
| 162 | #define ip4_addr_debug_print(debug, ipaddr) \
|
|---|
| 163 | ip4_addr_debug_print_parts(debug, \
|
|---|
| 164 | (u16_t)((ipaddr) != NULL ? ip4_addr1_16(ipaddr) : 0), \
|
|---|
| 165 | (u16_t)((ipaddr) != NULL ? ip4_addr2_16(ipaddr) : 0), \
|
|---|
| 166 | (u16_t)((ipaddr) != NULL ? ip4_addr3_16(ipaddr) : 0), \
|
|---|
| 167 | (u16_t)((ipaddr) != NULL ? ip4_addr4_16(ipaddr) : 0))
|
|---|
| 168 | #define ip4_addr_debug_print_val(debug, ipaddr) \
|
|---|
| 169 | ip4_addr_debug_print_parts(debug, \
|
|---|
| 170 | ip4_addr1_16_val(ipaddr), \
|
|---|
| 171 | ip4_addr2_16_val(ipaddr), \
|
|---|
| 172 | ip4_addr3_16_val(ipaddr), \
|
|---|
| 173 | ip4_addr4_16_val(ipaddr))
|
|---|
| 174 |
|
|---|
| 175 | /* Get one byte from the 4-byte address */
|
|---|
| 176 | #define ip4_addr_get_byte(ipaddr, idx) (((const u8_t*)(&(ipaddr)->addr))[idx])
|
|---|
| 177 | #define ip4_addr1(ipaddr) ip4_addr_get_byte(ipaddr, 0)
|
|---|
| 178 | #define ip4_addr2(ipaddr) ip4_addr_get_byte(ipaddr, 1)
|
|---|
| 179 | #define ip4_addr3(ipaddr) ip4_addr_get_byte(ipaddr, 2)
|
|---|
| 180 | #define ip4_addr4(ipaddr) ip4_addr_get_byte(ipaddr, 3)
|
|---|
| 181 | /* Get one byte from the 4-byte address, but argument is 'ip4_addr_t',
|
|---|
| 182 | * not a pointer */
|
|---|
| 183 | #define ip4_addr_get_byte_val(ipaddr, idx) ((u8_t)(((ipaddr).addr >> (idx * 8)) & 0xff))
|
|---|
| 184 | #define ip4_addr1_val(ipaddr) ip4_addr_get_byte_val(ipaddr, 0)
|
|---|
| 185 | #define ip4_addr2_val(ipaddr) ip4_addr_get_byte_val(ipaddr, 1)
|
|---|
| 186 | #define ip4_addr3_val(ipaddr) ip4_addr_get_byte_val(ipaddr, 2)
|
|---|
| 187 | #define ip4_addr4_val(ipaddr) ip4_addr_get_byte_val(ipaddr, 3)
|
|---|
| 188 | /* These are cast to u16_t, with the intent that they are often arguments
|
|---|
| 189 | * to printf using the U16_F format from cc.h. */
|
|---|
| 190 | #define ip4_addr1_16(ipaddr) ((u16_t)ip4_addr1(ipaddr))
|
|---|
| 191 | #define ip4_addr2_16(ipaddr) ((u16_t)ip4_addr2(ipaddr))
|
|---|
| 192 | #define ip4_addr3_16(ipaddr) ((u16_t)ip4_addr3(ipaddr))
|
|---|
| 193 | #define ip4_addr4_16(ipaddr) ((u16_t)ip4_addr4(ipaddr))
|
|---|
| 194 | #define ip4_addr1_16_val(ipaddr) ((u16_t)ip4_addr1_val(ipaddr))
|
|---|
| 195 | #define ip4_addr2_16_val(ipaddr) ((u16_t)ip4_addr2_val(ipaddr))
|
|---|
| 196 | #define ip4_addr3_16_val(ipaddr) ((u16_t)ip4_addr3_val(ipaddr))
|
|---|
| 197 | #define ip4_addr4_16_val(ipaddr) ((u16_t)ip4_addr4_val(ipaddr))
|
|---|
| 198 |
|
|---|
| 199 | #define IP4ADDR_STRLEN_MAX 16
|
|---|
| 200 |
|
|---|
| 201 | /** For backwards compatibility */
|
|---|
| 202 | #define ip_ntoa(ipaddr) ipaddr_ntoa(ipaddr)
|
|---|
| 203 |
|
|---|
| 204 | u32_t ipaddr_addr(const char *cp);
|
|---|
| 205 | int ip4addr_aton(const char *cp, ip4_addr_t *addr);
|
|---|
| 206 | /** returns ptr to static buffer; not reentrant! */
|
|---|
| 207 | char *ip4addr_ntoa(const ip4_addr_t *addr);
|
|---|
| 208 | char *ip4addr_ntoa_r(const ip4_addr_t *addr, char *buf, int buflen);
|
|---|
| 209 |
|
|---|
| 210 | #ifdef __cplusplus
|
|---|
| 211 | }
|
|---|
| 212 | #endif
|
|---|
| 213 |
|
|---|
| 214 | #endif /* LWIP_IPV4 */
|
|---|
| 215 |
|
|---|
| 216 | #endif /* LWIP_HDR_IP_ADDR_H */
|
|---|
![(please configure the [header_logo] section in trac.ini)](/trac_user/contrib/chrome/site/your_project_logo.png){kind=logo}
