Dependencies:   mbed

Dependents:   TCP

Committer:
slowness
Date:
Tue Sep 06 18:05:46 2011 +0000
Revision:
0:58c3d014a4e7

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
slowness 0:58c3d014a4e7 1 /*
slowness 0:58c3d014a4e7 2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
slowness 0:58c3d014a4e7 3 * All rights reserved.
slowness 0:58c3d014a4e7 4 *
slowness 0:58c3d014a4e7 5 * Redistribution and use in source and binary forms, with or without modification,
slowness 0:58c3d014a4e7 6 * are permitted provided that the following conditions are met:
slowness 0:58c3d014a4e7 7 *
slowness 0:58c3d014a4e7 8 * 1. Redistributions of source code must retain the above copyright notice,
slowness 0:58c3d014a4e7 9 * this list of conditions and the following disclaimer.
slowness 0:58c3d014a4e7 10 * 2. Redistributions in binary form must reproduce the above copyright notice,
slowness 0:58c3d014a4e7 11 * this list of conditions and the following disclaimer in the documentation
slowness 0:58c3d014a4e7 12 * and/or other materials provided with the distribution.
slowness 0:58c3d014a4e7 13 * 3. The name of the author may not be used to endorse or promote products
slowness 0:58c3d014a4e7 14 * derived from this software without specific prior written permission.
slowness 0:58c3d014a4e7 15 *
slowness 0:58c3d014a4e7 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
slowness 0:58c3d014a4e7 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
slowness 0:58c3d014a4e7 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
slowness 0:58c3d014a4e7 19 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
slowness 0:58c3d014a4e7 20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
slowness 0:58c3d014a4e7 21 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
slowness 0:58c3d014a4e7 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
slowness 0:58c3d014a4e7 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
slowness 0:58c3d014a4e7 24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
slowness 0:58c3d014a4e7 25 * OF SUCH DAMAGE.
slowness 0:58c3d014a4e7 26 *
slowness 0:58c3d014a4e7 27 * This file is part of the lwIP TCP/IP stack.
slowness 0:58c3d014a4e7 28 *
slowness 0:58c3d014a4e7 29 * Author: Adam Dunkels <adam@sics.se>
slowness 0:58c3d014a4e7 30 *
slowness 0:58c3d014a4e7 31 */
slowness 0:58c3d014a4e7 32 #ifndef __LWIP_IP_ADDR_H__
slowness 0:58c3d014a4e7 33 #define __LWIP_IP_ADDR_H__
slowness 0:58c3d014a4e7 34
slowness 0:58c3d014a4e7 35 #include "lwip/opt.h"
slowness 0:58c3d014a4e7 36 #include "lwip/def.h"
slowness 0:58c3d014a4e7 37
slowness 0:58c3d014a4e7 38 #ifdef __cplusplus
slowness 0:58c3d014a4e7 39 extern "C" {
slowness 0:58c3d014a4e7 40 #endif
slowness 0:58c3d014a4e7 41
slowness 0:58c3d014a4e7 42 /* This is the aligned version of ip_addr_t,
slowness 0:58c3d014a4e7 43 used as local variable, on the stack, etc. */
slowness 0:58c3d014a4e7 44 struct ip_addr {
slowness 0:58c3d014a4e7 45 u32_t addr;
slowness 0:58c3d014a4e7 46 };
slowness 0:58c3d014a4e7 47
slowness 0:58c3d014a4e7 48 /* This is the packed version of ip_addr_t,
slowness 0:58c3d014a4e7 49 used in network headers that are itself packed */
slowness 0:58c3d014a4e7 50 #ifdef PACK_STRUCT_USE_INCLUDES
slowness 0:58c3d014a4e7 51 # include "arch/bpstruct.h"
slowness 0:58c3d014a4e7 52 #endif
slowness 0:58c3d014a4e7 53 PACK_STRUCT_BEGIN
slowness 0:58c3d014a4e7 54 struct ip_addr_packed {
slowness 0:58c3d014a4e7 55 PACK_STRUCT_FIELD(u32_t addr);
slowness 0:58c3d014a4e7 56 } PACK_STRUCT_STRUCT;
slowness 0:58c3d014a4e7 57 PACK_STRUCT_END
slowness 0:58c3d014a4e7 58 #ifdef PACK_STRUCT_USE_INCLUDES
slowness 0:58c3d014a4e7 59 # include "arch/epstruct.h"
slowness 0:58c3d014a4e7 60 #endif
slowness 0:58c3d014a4e7 61
slowness 0:58c3d014a4e7 62 /** ip_addr_t uses a struct for convenience only, so that the same defines can
slowness 0:58c3d014a4e7 63 * operate both on ip_addr_t as well as on ip_addr_p_t. */
slowness 0:58c3d014a4e7 64 typedef struct ip_addr ip_addr_t;
slowness 0:58c3d014a4e7 65 typedef struct ip_addr_packed ip_addr_p_t;
slowness 0:58c3d014a4e7 66
slowness 0:58c3d014a4e7 67 /*
slowness 0:58c3d014a4e7 68 * struct ipaddr2 is used in the definition of the ARP packet format in
slowness 0:58c3d014a4e7 69 * order to support compilers that don't have structure packing.
slowness 0:58c3d014a4e7 70 */
slowness 0:58c3d014a4e7 71 #ifdef PACK_STRUCT_USE_INCLUDES
slowness 0:58c3d014a4e7 72 # include "arch/bpstruct.h"
slowness 0:58c3d014a4e7 73 #endif
slowness 0:58c3d014a4e7 74 PACK_STRUCT_BEGIN
slowness 0:58c3d014a4e7 75 struct ip_addr2 {
slowness 0:58c3d014a4e7 76 PACK_STRUCT_FIELD(u16_t addrw[2]);
slowness 0:58c3d014a4e7 77 } PACK_STRUCT_STRUCT;
slowness 0:58c3d014a4e7 78 PACK_STRUCT_END
slowness 0:58c3d014a4e7 79 #ifdef PACK_STRUCT_USE_INCLUDES
slowness 0:58c3d014a4e7 80 # include "arch/epstruct.h"
slowness 0:58c3d014a4e7 81 #endif
slowness 0:58c3d014a4e7 82
slowness 0:58c3d014a4e7 83 /* Forward declaration to not include netif.h */
slowness 0:58c3d014a4e7 84 struct netif;
slowness 0:58c3d014a4e7 85
slowness 0:58c3d014a4e7 86 extern const ip_addr_t ip_addr_any;
slowness 0:58c3d014a4e7 87 extern const ip_addr_t ip_addr_broadcast;
slowness 0:58c3d014a4e7 88
slowness 0:58c3d014a4e7 89 /** IP_ADDR_ can be used as a fixed IP address
slowness 0:58c3d014a4e7 90 * for the wildcard and the broadcast address
slowness 0:58c3d014a4e7 91 */
slowness 0:58c3d014a4e7 92 #define IP_ADDR_ANY ((ip_addr_t *)&ip_addr_any)
slowness 0:58c3d014a4e7 93 #define IP_ADDR_BROADCAST ((ip_addr_t *)&ip_addr_broadcast)
slowness 0:58c3d014a4e7 94
slowness 0:58c3d014a4e7 95 /** 255.255.255.255 */
slowness 0:58c3d014a4e7 96 #define IPADDR_NONE ((u32_t)0xffffffffUL)
slowness 0:58c3d014a4e7 97 /** 127.0.0.1 */
slowness 0:58c3d014a4e7 98 #define IPADDR_LOOPBACK ((u32_t)0x7f000001UL)
slowness 0:58c3d014a4e7 99 /** 0.0.0.0 */
slowness 0:58c3d014a4e7 100 #define IPADDR_ANY ((u32_t)0x00000000UL)
slowness 0:58c3d014a4e7 101 /** 255.255.255.255 */
slowness 0:58c3d014a4e7 102 #define IPADDR_BROADCAST ((u32_t)0xffffffffUL)
slowness 0:58c3d014a4e7 103
slowness 0:58c3d014a4e7 104 /* Definitions of the bits in an Internet address integer.
slowness 0:58c3d014a4e7 105
slowness 0:58c3d014a4e7 106 On subnets, host and network parts are found according to
slowness 0:58c3d014a4e7 107 the subnet mask, not these masks. */
slowness 0:58c3d014a4e7 108 #define IP_CLASSA(a) ((((u32_t)(a)) & 0x80000000UL) == 0)
slowness 0:58c3d014a4e7 109 #define IP_CLASSA_NET 0xff000000
slowness 0:58c3d014a4e7 110 #define IP_CLASSA_NSHIFT 24
slowness 0:58c3d014a4e7 111 #define IP_CLASSA_HOST (0xffffffff & ~IP_CLASSA_NET)
slowness 0:58c3d014a4e7 112 #define IP_CLASSA_MAX 128
slowness 0:58c3d014a4e7 113
slowness 0:58c3d014a4e7 114 #define IP_CLASSB(a) ((((u32_t)(a)) & 0xc0000000UL) == 0x80000000UL)
slowness 0:58c3d014a4e7 115 #define IP_CLASSB_NET 0xffff0000
slowness 0:58c3d014a4e7 116 #define IP_CLASSB_NSHIFT 16
slowness 0:58c3d014a4e7 117 #define IP_CLASSB_HOST (0xffffffff & ~IP_CLASSB_NET)
slowness 0:58c3d014a4e7 118 #define IP_CLASSB_MAX 65536
slowness 0:58c3d014a4e7 119
slowness 0:58c3d014a4e7 120 #define IP_CLASSC(a) ((((u32_t)(a)) & 0xe0000000UL) == 0xc0000000UL)
slowness 0:58c3d014a4e7 121 #define IP_CLASSC_NET 0xffffff00
slowness 0:58c3d014a4e7 122 #define IP_CLASSC_NSHIFT 8
slowness 0:58c3d014a4e7 123 #define IP_CLASSC_HOST (0xffffffff & ~IP_CLASSC_NET)
slowness 0:58c3d014a4e7 124
slowness 0:58c3d014a4e7 125 #define IP_CLASSD(a) (((u32_t)(a) & 0xf0000000UL) == 0xe0000000UL)
slowness 0:58c3d014a4e7 126 #define IP_CLASSD_NET 0xf0000000 /* These ones aren't really */
slowness 0:58c3d014a4e7 127 #define IP_CLASSD_NSHIFT 28 /* net and host fields, but */
slowness 0:58c3d014a4e7 128 #define IP_CLASSD_HOST 0x0fffffff /* routing needn't know. */
slowness 0:58c3d014a4e7 129 #define IP_MULTICAST(a) IP_CLASSD(a)
slowness 0:58c3d014a4e7 130
slowness 0:58c3d014a4e7 131 #define IP_EXPERIMENTAL(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)
slowness 0:58c3d014a4e7 132 #define IP_BADCLASS(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL)
slowness 0:58c3d014a4e7 133
slowness 0:58c3d014a4e7 134 #define IP_LOOPBACKNET 127 /* official! */
slowness 0:58c3d014a4e7 135
slowness 0:58c3d014a4e7 136
slowness 0:58c3d014a4e7 137 #if BYTE_ORDER == BIG_ENDIAN
slowness 0:58c3d014a4e7 138 /** Set an IP address given by the four byte-parts */
slowness 0:58c3d014a4e7 139 #define IP4_ADDR(ipaddr, a,b,c,d) \
slowness 0:58c3d014a4e7 140 (ipaddr)->addr = ((u32_t)((a) & 0xff) << 24) | \
slowness 0:58c3d014a4e7 141 ((u32_t)((b) & 0xff) << 16) | \
slowness 0:58c3d014a4e7 142 ((u32_t)((c) & 0xff) << 8) | \
slowness 0:58c3d014a4e7 143 (u32_t)((d) & 0xff)
slowness 0:58c3d014a4e7 144 #else
slowness 0:58c3d014a4e7 145 /** Set an IP address given by the four byte-parts.
slowness 0:58c3d014a4e7 146 Little-endian version that prevents the use of htonl. */
slowness 0:58c3d014a4e7 147 #define IP4_ADDR(ipaddr, a,b,c,d) \
slowness 0:58c3d014a4e7 148 (ipaddr)->addr = ((u32_t)((d) & 0xff) << 24) | \
slowness 0:58c3d014a4e7 149 ((u32_t)((c) & 0xff) << 16) | \
slowness 0:58c3d014a4e7 150 ((u32_t)((b) & 0xff) << 8) | \
slowness 0:58c3d014a4e7 151 (u32_t)((a) & 0xff)
slowness 0:58c3d014a4e7 152 #endif
slowness 0:58c3d014a4e7 153
slowness 0:58c3d014a4e7 154 /** MEMCPY-like copying of IP addresses where addresses are known to be
slowness 0:58c3d014a4e7 155 * 16-bit-aligned if the port is correctly configured (so a port could define
slowness 0:58c3d014a4e7 156 * this to copying 2 u16_t's) - no NULL-pointer-checking needed. */
slowness 0:58c3d014a4e7 157 #ifndef IPADDR2_COPY
slowness 0:58c3d014a4e7 158 #define IPADDR2_COPY(dest, src) SMEMCPY(dest, src, sizeof(ip_addr_t))
slowness 0:58c3d014a4e7 159 #endif
slowness 0:58c3d014a4e7 160
slowness 0:58c3d014a4e7 161 /** Copy IP address - faster than ip_addr_set: no NULL check */
slowness 0:58c3d014a4e7 162 #define ip_addr_copy(dest, src) ((dest).addr = (src).addr)
slowness 0:58c3d014a4e7 163 /** Safely copy one IP address to another (src may be NULL) */
slowness 0:58c3d014a4e7 164 #define ip_addr_set(dest, src) ((dest)->addr = \
slowness 0:58c3d014a4e7 165 ((src) == NULL ? 0 : \
slowness 0:58c3d014a4e7 166 (src)->addr))
slowness 0:58c3d014a4e7 167 /** Set complete address to zero */
slowness 0:58c3d014a4e7 168 #define ip_addr_set_zero(ipaddr) ((ipaddr)->addr = 0)
slowness 0:58c3d014a4e7 169 /** Set address to IPADDR_ANY (no need for htonl()) */
slowness 0:58c3d014a4e7 170 #define ip_addr_set_any(ipaddr) ((ipaddr)->addr = IPADDR_ANY)
slowness 0:58c3d014a4e7 171 /** Set address to loopback address */
slowness 0:58c3d014a4e7 172 #define ip_addr_set_loopback(ipaddr) ((ipaddr)->addr = PP_HTONL(IPADDR_LOOPBACK))
slowness 0:58c3d014a4e7 173 /** Safely copy one IP address to another and change byte order
slowness 0:58c3d014a4e7 174 * from host- to network-order. */
slowness 0:58c3d014a4e7 175 #define ip_addr_set_hton(dest, src) ((dest)->addr = \
slowness 0:58c3d014a4e7 176 ((src) == NULL ? 0:\
slowness 0:58c3d014a4e7 177 htonl((src)->addr)))
slowness 0:58c3d014a4e7 178 /** IPv4 only: set the IP address given as an u32_t */
slowness 0:58c3d014a4e7 179 #define ip4_addr_set_u32(dest_ipaddr, src_u32) ((dest_ipaddr)->addr = (src_u32))
slowness 0:58c3d014a4e7 180 /** IPv4 only: get the IP address as an u32_t */
slowness 0:58c3d014a4e7 181 #define ip4_addr_get_u32(src_ipaddr) ((src_ipaddr)->addr)
slowness 0:58c3d014a4e7 182
slowness 0:58c3d014a4e7 183 /** Get the network address by combining host address with netmask */
slowness 0:58c3d014a4e7 184 #define ip_addr_get_network(target, host, netmask) ((target)->addr = ((host)->addr) & ((netmask)->addr))
slowness 0:58c3d014a4e7 185
slowness 0:58c3d014a4e7 186 /**
slowness 0:58c3d014a4e7 187 * Determine if two address are on the same network.
slowness 0:58c3d014a4e7 188 *
slowness 0:58c3d014a4e7 189 * @arg addr1 IP address 1
slowness 0:58c3d014a4e7 190 * @arg addr2 IP address 2
slowness 0:58c3d014a4e7 191 * @arg mask network identifier mask
slowness 0:58c3d014a4e7 192 * @return !0 if the network identifiers of both address match
slowness 0:58c3d014a4e7 193 */
slowness 0:58c3d014a4e7 194 #define ip_addr_netcmp(addr1, addr2, mask) (((addr1)->addr & \
slowness 0:58c3d014a4e7 195 (mask)->addr) == \
slowness 0:58c3d014a4e7 196 ((addr2)->addr & \
slowness 0:58c3d014a4e7 197 (mask)->addr))
slowness 0:58c3d014a4e7 198 #define ip_addr_cmp(addr1, addr2) ((addr1)->addr == (addr2)->addr)
slowness 0:58c3d014a4e7 199
slowness 0:58c3d014a4e7 200 #define ip_addr_isany(addr1) ((addr1) == NULL || (addr1)->addr == IPADDR_ANY)
slowness 0:58c3d014a4e7 201
slowness 0:58c3d014a4e7 202 #define ip_addr_isbroadcast(ipaddr, netif) ip4_addr_isbroadcast((ipaddr)->addr, (netif))
slowness 0:58c3d014a4e7 203 u8_t ip4_addr_isbroadcast(u32_t addr, const struct netif *netif);
slowness 0:58c3d014a4e7 204
slowness 0:58c3d014a4e7 205 #define ip_addr_netmask_valid(netmask) ip4_addr_netmask_valid((netmask)->addr)
slowness 0:58c3d014a4e7 206 u8_t ip4_addr_netmask_valid(u32_t netmask);
slowness 0:58c3d014a4e7 207
slowness 0:58c3d014a4e7 208 #define ip_addr_ismulticast(addr1) (((addr1)->addr & PP_HTONL(0xf0000000UL)) == PP_HTONL(0xe0000000UL))
slowness 0:58c3d014a4e7 209
slowness 0:58c3d014a4e7 210 #define ip_addr_islinklocal(addr1) (((addr1)->addr & PP_HTONL(0xffff0000UL)) == PP_HTONL(0xa9fe0000UL))
slowness 0:58c3d014a4e7 211
slowness 0:58c3d014a4e7 212 #define ip_addr_debug_print(debug, ipaddr) \
slowness 0:58c3d014a4e7 213 LWIP_DEBUGF(debug, ("%"U16_F".%"U16_F".%"U16_F".%"U16_F, \
slowness 0:58c3d014a4e7 214 ipaddr != NULL ? ip4_addr1_16(ipaddr) : 0, \
slowness 0:58c3d014a4e7 215 ipaddr != NULL ? ip4_addr2_16(ipaddr) : 0, \
slowness 0:58c3d014a4e7 216 ipaddr != NULL ? ip4_addr3_16(ipaddr) : 0, \
slowness 0:58c3d014a4e7 217 ipaddr != NULL ? ip4_addr4_16(ipaddr) : 0))
slowness 0:58c3d014a4e7 218
slowness 0:58c3d014a4e7 219 /* Get one byte from the 4-byte address */
slowness 0:58c3d014a4e7 220 #define ip4_addr1(ipaddr) (((u8_t*)(ipaddr))[0])
slowness 0:58c3d014a4e7 221 #define ip4_addr2(ipaddr) (((u8_t*)(ipaddr))[1])
slowness 0:58c3d014a4e7 222 #define ip4_addr3(ipaddr) (((u8_t*)(ipaddr))[2])
slowness 0:58c3d014a4e7 223 #define ip4_addr4(ipaddr) (((u8_t*)(ipaddr))[3])
slowness 0:58c3d014a4e7 224 /* These are cast to u16_t, with the intent that they are often arguments
slowness 0:58c3d014a4e7 225 * to printf using the U16_F format from cc.h. */
slowness 0:58c3d014a4e7 226 #define ip4_addr1_16(ipaddr) ((u16_t)ip4_addr1(ipaddr))
slowness 0:58c3d014a4e7 227 #define ip4_addr2_16(ipaddr) ((u16_t)ip4_addr2(ipaddr))
slowness 0:58c3d014a4e7 228 #define ip4_addr3_16(ipaddr) ((u16_t)ip4_addr3(ipaddr))
slowness 0:58c3d014a4e7 229 #define ip4_addr4_16(ipaddr) ((u16_t)ip4_addr4(ipaddr))
slowness 0:58c3d014a4e7 230
slowness 0:58c3d014a4e7 231 /** For backwards compatibility */
slowness 0:58c3d014a4e7 232 #define ip_ntoa(ipaddr) ipaddr_ntoa(ipaddr)
slowness 0:58c3d014a4e7 233
slowness 0:58c3d014a4e7 234 u32_t ipaddr_addr(const char *cp);
slowness 0:58c3d014a4e7 235 int ipaddr_aton(const char *cp, ip_addr_t *addr);
slowness 0:58c3d014a4e7 236 /** returns ptr to static buffer; not reentrant! */
slowness 0:58c3d014a4e7 237 char *ipaddr_ntoa(const ip_addr_t *addr);
slowness 0:58c3d014a4e7 238 char *ipaddr_ntoa_r(const ip_addr_t *addr, char *buf, int buflen);
slowness 0:58c3d014a4e7 239
slowness 0:58c3d014a4e7 240 #ifdef __cplusplus
slowness 0:58c3d014a4e7 241 }
slowness 0:58c3d014a4e7 242 #endif
slowness 0:58c3d014a4e7 243
slowness 0:58c3d014a4e7 244 #endif /* __LWIP_IP_ADDR_H__ */