Darran Shepherd
/
AutoIpNetStack
Net stack with AutoIP enabled
Embed:
(wiki syntax)
Show/hide line numbers
ip_addr.h
00001 /* 00002 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 00003 * All rights reserved. 00004 * 00005 * Redistribution and use in source and binary forms, with or without modification, 00006 * are permitted provided that the following conditions are met: 00007 * 00008 * 1. Redistributions of source code must retain the above copyright notice, 00009 * this list of conditions and the following disclaimer. 00010 * 2. Redistributions in binary form must reproduce the above copyright notice, 00011 * this list of conditions and the following disclaimer in the documentation 00012 * and/or other materials provided with the distribution. 00013 * 3. The name of the author may not be used to endorse or promote products 00014 * derived from this software without specific prior written permission. 00015 * 00016 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 00017 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 00018 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 00019 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 00020 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 00021 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 00022 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 00023 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 00024 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 00025 * OF SUCH DAMAGE. 00026 * 00027 * This file is part of the lwIP TCP/IP stack. 00028 * 00029 * Author: Adam Dunkels <adam@sics.se> 00030 * 00031 */ 00032 #ifndef __LWIP_IP_ADDR_H__ 00033 #define __LWIP_IP_ADDR_H__ 00034 00035 #include "lwip/opt.h" 00036 #include "lwip/def.h" 00037 00038 #ifdef __cplusplus 00039 extern "C" { 00040 #endif 00041 00042 #ifdef PACK_STRUCT_USE_INCLUDES 00043 # include "arch/bpstruct.h" 00044 #endif 00045 PACK_STRUCT_BEGIN 00046 struct _ip_addr { 00047 PACK_STRUCT_FIELD(u32_t addr); 00048 } PACK_STRUCT_STRUCT; 00049 PACK_STRUCT_END 00050 #ifdef PACK_STRUCT_USE_INCLUDES 00051 # include "arch/epstruct.h" 00052 #endif 00053 00054 typedef struct _ip_addr ip_addr_t; 00055 00056 /* 00057 * struct ipaddr2 is used in the definition of the ARP packet format in 00058 * order to support compilers that don't have structure packing. 00059 */ 00060 #ifdef PACK_STRUCT_USE_INCLUDES 00061 # include "arch/bpstruct.h" 00062 #endif 00063 PACK_STRUCT_BEGIN 00064 struct ip_addr2 { 00065 PACK_STRUCT_FIELD(u16_t addrw[2]); 00066 } PACK_STRUCT_STRUCT; 00067 PACK_STRUCT_END 00068 #ifdef PACK_STRUCT_USE_INCLUDES 00069 # include "arch/epstruct.h" 00070 #endif 00071 00072 /* Forward declaration to not include netif.h */ 00073 struct netif; 00074 00075 extern const ip_addr_t ip_addr_any; 00076 extern const ip_addr_t ip_addr_broadcast; 00077 00078 /** IP_ADDR_ can be used as a fixed IP address 00079 * for the wildcard and the broadcast address 00080 */ 00081 #define IP_ADDR_ANY ((ip_addr_t *)&ip_addr_any) 00082 #define IP_ADDR_BROADCAST ((ip_addr_t *)&ip_addr_broadcast) 00083 00084 /** 255.255.255.255 */ 00085 #define IPADDR_NONE ((u32_t)0xffffffffUL) 00086 /** 127.0.0.1 */ 00087 #define IPADDR_LOOPBACK ((u32_t)0x7f000001UL) 00088 /** 0.0.0.0 */ 00089 #define IPADDR_ANY ((u32_t)0x00000000UL) 00090 /** 255.255.255.255 */ 00091 #define IPADDR_BROADCAST ((u32_t)0xffffffffUL) 00092 00093 /* Definitions of the bits in an Internet address integer. 00094 00095 On subnets, host and network parts are found according to 00096 the subnet mask, not these masks. */ 00097 #define IP_CLASSA(a) ((((u32_t)(a)) & 0x80000000UL) == 0) 00098 #define IP_CLASSA_NET 0xff000000 00099 #define IP_CLASSA_NSHIFT 24 00100 #define IP_CLASSA_HOST (0xffffffff & ~IP_CLASSA_NET) 00101 #define IP_CLASSA_MAX 128 00102 00103 #define IP_CLASSB(a) ((((u32_t)(a)) & 0xc0000000UL) == 0x80000000UL) 00104 #define IP_CLASSB_NET 0xffff0000 00105 #define IP_CLASSB_NSHIFT 16 00106 #define IP_CLASSB_HOST (0xffffffff & ~IP_CLASSB_NET) 00107 #define IP_CLASSB_MAX 65536 00108 00109 #define IP_CLASSC(a) ((((u32_t)(a)) & 0xe0000000UL) == 0xc0000000UL) 00110 #define IP_CLASSC_NET 0xffffff00 00111 #define IP_CLASSC_NSHIFT 8 00112 #define IP_CLASSC_HOST (0xffffffff & ~IP_CLASSC_NET) 00113 00114 #define IP_CLASSD(a) (((u32_t)(a) & 0xf0000000UL) == 0xe0000000UL) 00115 #define IP_CLASSD_NET 0xf0000000 /* These ones aren't really */ 00116 #define IP_CLASSD_NSHIFT 28 /* net and host fields, but */ 00117 #define IP_CLASSD_HOST 0x0fffffff /* routing needn't know. */ 00118 #define IP_MULTICAST(a) IP_CLASSD(a) 00119 00120 #define IP_EXPERIMENTAL(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL) 00121 #define IP_BADCLASS(a) (((u32_t)(a) & 0xf0000000UL) == 0xf0000000UL) 00122 00123 #define IP_LOOPBACKNET 127 /* official! */ 00124 00125 00126 #if BYTE_ORDER == BIG_ENDIAN 00127 /** Set an IP address given by the four byte-parts */ 00128 #define IP4_ADDR(ipaddr, a,b,c,d) \ 00129 (ipaddr)->addr = ((u32_t)((a) & 0xff) << 24) | \ 00130 ((u32_t)((b) & 0xff) << 16) | \ 00131 ((u32_t)((c) & 0xff) << 8) | \ 00132 (u32_t)((d) & 0xff) 00133 #else 00134 /** Set an IP address given by the four byte-parts. 00135 Little-endian version that prevents the use of htonl. */ 00136 #define IP4_ADDR(ipaddr, a,b,c,d) \ 00137 (ipaddr)->addr = ((u32_t)((d) & 0xff) << 24) | \ 00138 ((u32_t)((c) & 0xff) << 16) | \ 00139 ((u32_t)((b) & 0xff) << 8) | \ 00140 (u32_t)((a) & 0xff) 00141 #endif 00142 00143 /** Copy IP address - faster than ip_addr_set: no NULL check */ 00144 #define ip_addr_copy(dest, src) ((dest).addr = (src).addr) 00145 /** Safely copy one IP address to another (src may be NULL) */ 00146 #define ip_addr_set(dest, src) ((dest)->addr = \ 00147 ((src) == NULL ? 0 : \ 00148 (src)->addr)) 00149 /** Set complete address to zero */ 00150 #define ip_addr_set_zero(ipaddr) ((ipaddr)->addr = 0) 00151 /** Set address to IPADDR_ANY (no need for htonl()) */ 00152 #define ip_addr_set_any(ipaddr) ((ipaddr)->addr = IPADDR_ANY) 00153 /** Set address to loopback address */ 00154 #define ip_addr_set_loopback(ipaddr) ((ipaddr)->addr = htonl(IPADDR_LOOPBACK)) 00155 /** Safely copy one IP address to another and change byte order 00156 * from host- to network-order. */ 00157 #define ip_addr_set_hton(dest, src) ((dest)->addr = \ 00158 ((src) == NULL ? 0:\ 00159 htonl((src)->addr))) 00160 /** IPv4 only: set the IP address given as an u32_t */ 00161 #define ip4_addr_set_u32(dest_ipaddr, src_u32) ((dest_ipaddr)->addr = (src_u32)) 00162 /** IPv4 only: get the IP address as an u32_t */ 00163 #define ip4_addr_get_u32(src_ipaddr) ((src_ipaddr)->addr) 00164 00165 /** Get the network address by combining host address with netmask */ 00166 #define ip_addr_get_network(target, host, netmask) ((target)->addr = ((host)->addr) & ((netmask)->addr)) 00167 00168 /** 00169 * Determine if two address are on the same network. 00170 * 00171 * @arg addr1 IP address 1 00172 * @arg addr2 IP address 2 00173 * @arg mask network identifier mask 00174 * @return !0 if the network identifiers of both address match 00175 */ 00176 #define ip_addr_netcmp(addr1, addr2, mask) (((addr1)->addr & \ 00177 (mask)->addr) == \ 00178 ((addr2)->addr & \ 00179 (mask)->addr)) 00180 #define ip_addr_cmp(addr1, addr2) ((addr1)->addr == (addr2)->addr) 00181 00182 #define ip_addr_isany(addr1) ((addr1) == NULL || (addr1)->addr == IPADDR_ANY) 00183 00184 u8_t ip_addr_isbroadcast(ip_addr_t *, struct netif *); 00185 00186 #define ip_addr_ismulticast(addr1) (((addr1)->addr & ntohl(0xf0000000UL)) == ntohl(0xe0000000UL)) 00187 00188 #define ip_addr_islinklocal(addr1) (((addr1)->addr & ntohl(0xffff0000UL)) == ntohl(0xa9fe0000UL)) 00189 00190 #define ip_addr_debug_print(debug, ipaddr) \ 00191 LWIP_DEBUGF(debug, ("%"U16_F".%"U16_F".%"U16_F".%"U16_F, \ 00192 ipaddr != NULL ? ip4_addr1_16(ipaddr) : 0, \ 00193 ipaddr != NULL ? ip4_addr2_16(ipaddr) : 0, \ 00194 ipaddr != NULL ? ip4_addr3_16(ipaddr) : 0, \ 00195 ipaddr != NULL ? ip4_addr4_16(ipaddr) : 0)) 00196 00197 /* Get one byte from the 4-byte address */ 00198 #define ip4_addr1(ipaddr) (((u8_t*)(ipaddr))[0]) 00199 #define ip4_addr2(ipaddr) (((u8_t*)(ipaddr))[1]) 00200 #define ip4_addr3(ipaddr) (((u8_t*)(ipaddr))[2]) 00201 #define ip4_addr4(ipaddr) (((u8_t*)(ipaddr))[3]) 00202 /* These are cast to u16_t, with the intent that they are often arguments 00203 * to printf using the U16_F format from cc.h. */ 00204 #define ip4_addr1_16(ipaddr) ((u16_t)ip4_addr1(ipaddr)) 00205 #define ip4_addr2_16(ipaddr) ((u16_t)ip4_addr2(ipaddr)) 00206 #define ip4_addr3_16(ipaddr) ((u16_t)ip4_addr3(ipaddr)) 00207 #define ip4_addr4_16(ipaddr) ((u16_t)ip4_addr4(ipaddr)) 00208 00209 /** For backwards compatibility */ 00210 #define ip_ntoa(ipaddr) ipaddr_ntoa(ipaddr) 00211 00212 u32_t ipaddr_addr(const char *cp); 00213 int ipaddr_aton(const char *cp, ip_addr_t *addr); 00214 /** returns ptr to static buffer; not reentrant! */ 00215 char *ipaddr_ntoa(ip_addr_t *addr); 00216 char *ipaddr_ntoa_r(ip_addr_t *addr, char *buf, int buflen); 00217 00218 #ifdef __cplusplus 00219 } 00220 #endif 00221 00222 #endif /* __LWIP_IP_ADDR_H__ */
Generated on Tue Jul 12 2022 15:37:04 by 1.7.2