ReactOS 0.4.16-dev-533-gc7d1aa3
ip6_addr.h
Go to the documentation of this file.
1
7/*
8 * Copyright (c) 2010 Inico Technologies Ltd.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without modification,
12 * are permitted provided that the following conditions are met:
13 *
14 * 1. Redistributions of source code must retain the above copyright notice,
15 * this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright notice,
17 * this list of conditions and the following disclaimer in the documentation
18 * and/or other materials provided with the distribution.
19 * 3. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
25 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
27 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
31 * OF SUCH DAMAGE.
32 *
33 * This file is part of the lwIP TCP/IP stack.
34 *
35 * Author: Ivan Delamer <delamer@inicotech.com>
36 *
37 * Structs and macros for handling IPv6 addresses.
38 *
39 * Please coordinate changes and requests with Ivan Delamer
40 * <delamer@inicotech.com>
41 */
42#ifndef LWIP_HDR_IP6_ADDR_H
43#define LWIP_HDR_IP6_ADDR_H
44
45#include "lwip/opt.h"
46#include "def.h"
47
48#if LWIP_IPV6 /* don't build if not configured for use in lwipopts.h */
49
50#include "lwip/ip6_zone.h"
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
56
59struct ip6_addr {
60 u32_t addr[4];
61#if LWIP_IPV6_SCOPES
62 u8_t zone;
63#endif /* LWIP_IPV6_SCOPES */
64};
65
67typedef struct ip6_addr ip6_addr_t;
68
70#define IP6_ADDR_PART(ip6addr, index, a,b,c,d) \
71 (ip6addr)->addr[index] = PP_HTONL(LWIP_MAKEU32(a,b,c,d))
72
75#define IP6_ADDR(ip6addr, idx0, idx1, idx2, idx3) do { \
76 (ip6addr)->addr[0] = idx0; \
77 (ip6addr)->addr[1] = idx1; \
78 (ip6addr)->addr[2] = idx2; \
79 (ip6addr)->addr[3] = idx3; \
80 ip6_addr_clear_zone(ip6addr); } while(0)
81
83#define IP6_ADDR_BLOCK1(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[0]) >> 16) & 0xffff))
85#define IP6_ADDR_BLOCK2(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[0])) & 0xffff))
87#define IP6_ADDR_BLOCK3(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[1]) >> 16) & 0xffff))
89#define IP6_ADDR_BLOCK4(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[1])) & 0xffff))
91#define IP6_ADDR_BLOCK5(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[2]) >> 16) & 0xffff))
93#define IP6_ADDR_BLOCK6(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[2])) & 0xffff))
95#define IP6_ADDR_BLOCK7(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[3]) >> 16) & 0xffff))
97#define IP6_ADDR_BLOCK8(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[3])) & 0xffff))
98
100#define ip6_addr_copy(dest, src) do{(dest).addr[0] = (src).addr[0]; \
101 (dest).addr[1] = (src).addr[1]; \
102 (dest).addr[2] = (src).addr[2]; \
103 (dest).addr[3] = (src).addr[3]; \
104 ip6_addr_copy_zone((dest), (src)); }while(0)
106#define ip6_addr_set(dest, src) do{(dest)->addr[0] = (src) == NULL ? 0 : (src)->addr[0]; \
107 (dest)->addr[1] = (src) == NULL ? 0 : (src)->addr[1]; \
108 (dest)->addr[2] = (src) == NULL ? 0 : (src)->addr[2]; \
109 (dest)->addr[3] = (src) == NULL ? 0 : (src)->addr[3]; \
110 ip6_addr_set_zone((dest), (src) == NULL ? IP6_NO_ZONE : ip6_addr_zone(src)); }while(0)
111
113#define ip6_addr_copy_from_packed(dest, src) do{(dest).addr[0] = (src).addr[0]; \
114 (dest).addr[1] = (src).addr[1]; \
115 (dest).addr[2] = (src).addr[2]; \
116 (dest).addr[3] = (src).addr[3]; \
117 ip6_addr_clear_zone(&dest); }while(0)
118
120#define ip6_addr_copy_to_packed(dest, src) do{(dest).addr[0] = (src).addr[0]; \
121 (dest).addr[1] = (src).addr[1]; \
122 (dest).addr[2] = (src).addr[2]; \
123 (dest).addr[3] = (src).addr[3]; }while(0)
124
126#define ip6_addr_set_zero(ip6addr) do{(ip6addr)->addr[0] = 0; \
127 (ip6addr)->addr[1] = 0; \
128 (ip6addr)->addr[2] = 0; \
129 (ip6addr)->addr[3] = 0; \
130 ip6_addr_clear_zone(ip6addr);}while(0)
131
133#define ip6_addr_set_any(ip6addr) ip6_addr_set_zero(ip6addr)
135#define ip6_addr_set_loopback(ip6addr) do{(ip6addr)->addr[0] = 0; \
136 (ip6addr)->addr[1] = 0; \
137 (ip6addr)->addr[2] = 0; \
138 (ip6addr)->addr[3] = PP_HTONL(0x00000001UL); \
139 ip6_addr_clear_zone(ip6addr);}while(0)
142#define ip6_addr_set_hton(dest, src) do{(dest)->addr[0] = (src) == NULL ? 0 : lwip_htonl((src)->addr[0]); \
143 (dest)->addr[1] = (src) == NULL ? 0 : lwip_htonl((src)->addr[1]); \
144 (dest)->addr[2] = (src) == NULL ? 0 : lwip_htonl((src)->addr[2]); \
145 (dest)->addr[3] = (src) == NULL ? 0 : lwip_htonl((src)->addr[3]); \
146 ip6_addr_set_zone((dest), (src) == NULL ? IP6_NO_ZONE : ip6_addr_zone(src));}while(0)
147
148
150#define ip6_addr_netcmp_zoneless(addr1, addr2) ip6_addr_net_zoneless_eq(addr1, addr2)
152#define ip6_addr_net_zoneless_eq(addr1, addr2) (((addr1)->addr[0] == (addr2)->addr[0]) && \
153 ((addr1)->addr[1] == (addr2)->addr[1]))
154
159#define ip6_addr_netcmp(addr1, addr2) ip6_addr_net_eq(addr1, addr2)
167#define ip6_addr_net_eq(addr1, addr2) (ip6_addr_net_zoneless_eq((addr1), (addr2)) && \
168 ip6_addr_zone_eq((addr1), (addr2)))
169
170#define ip6_addr_nethostcmp(addr1, addr2) ip6_addr_nethost_eq(addr1, addr2)
171/* Exact-host comparison *after* ip6_addr_net_eq() succeeded, for efficiency. */
172#define ip6_addr_nethost_eq(addr1, addr2) (((addr1)->addr[2] == (addr2)->addr[2]) && \
173 ((addr1)->addr[3] == (addr2)->addr[3]))
174
176#define ip6_addr_cmp_zoneless(addr1, addr2) ip6_addr_zoneless_eq(addr1, addr2)
178#define ip6_addr_zoneless_eq(addr1, addr2) (((addr1)->addr[0] == (addr2)->addr[0]) && \
179 ((addr1)->addr[1] == (addr2)->addr[1]) && \
180 ((addr1)->addr[2] == (addr2)->addr[2]) && \
181 ((addr1)->addr[3] == (addr2)->addr[3]))
183#define ip6_addr_cmp(addr1, addr2) ip6_addr_eq(addr1, addr2)
192#define ip6_addr_eq(addr1, addr2) (ip6_addr_zoneless_eq((addr1), (addr2)) && \
193 ip6_addr_zone_eq((addr1), (addr2)))
194
196#define ip6_addr_cmp_packed(ip6addr, paddr, zone_idx) ip6_addr_packed_eq(ip6addr, paddr, zone_idx)
198#define ip6_addr_packed_eq(ip6addr, paddr, zone_idx) (((ip6addr)->addr[0] == (paddr)->addr[0]) && \
199 ((ip6addr)->addr[1] == (paddr)->addr[1]) && \
200 ((ip6addr)->addr[2] == (paddr)->addr[2]) && \
201 ((ip6addr)->addr[3] == (paddr)->addr[3]) && \
202 ip6_addr_equals_zone((ip6addr), (zone_idx)))
203
204#define ip6_get_subnet_id(ip6addr) (lwip_htonl((ip6addr)->addr[2]) & 0x0000ffffUL)
205
206#define ip6_addr_isany_val(ip6addr) (((ip6addr).addr[0] == 0) && \
207 ((ip6addr).addr[1] == 0) && \
208 ((ip6addr).addr[2] == 0) && \
209 ((ip6addr).addr[3] == 0))
210#define ip6_addr_isany(ip6addr) (((ip6addr) == NULL) || ip6_addr_isany_val(*(ip6addr)))
211
212#define ip6_addr_isloopback(ip6addr) (((ip6addr)->addr[0] == 0UL) && \
213 ((ip6addr)->addr[1] == 0UL) && \
214 ((ip6addr)->addr[2] == 0UL) && \
215 ((ip6addr)->addr[3] == PP_HTONL(0x00000001UL)))
216
217#define ip6_addr_isglobal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xe0000000UL)) == PP_HTONL(0x20000000UL))
218
219#define ip6_addr_islinklocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xffc00000UL)) == PP_HTONL(0xfe800000UL))
220
221#define ip6_addr_issitelocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xffc00000UL)) == PP_HTONL(0xfec00000UL))
222
223#define ip6_addr_isuniquelocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xfe000000UL)) == PP_HTONL(0xfc000000UL))
224
225#define ip6_addr_isipv4mappedipv6(ip6addr) (((ip6addr)->addr[0] == 0) && ((ip6addr)->addr[1] == 0) && (((ip6addr)->addr[2]) == PP_HTONL(0x0000FFFFUL)))
226
227#define ip6_addr_isipv4compat(ip6addr) (((ip6addr)->addr[0] == 0UL) && \
228 ((ip6addr)->addr[1] == 0UL) && \
229 ((ip6addr)->addr[2] == 0UL) && \
230 (htonl((ip6addr)->addr[3]) > 1))
231
232#define ip6_addr_ismulticast(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff000000UL)) == PP_HTONL(0xff000000UL))
233#define ip6_addr_multicast_transient_flag(ip6addr) ((ip6addr)->addr[0] & PP_HTONL(0x00100000UL))
234#define ip6_addr_multicast_prefix_flag(ip6addr) ((ip6addr)->addr[0] & PP_HTONL(0x00200000UL))
235#define ip6_addr_multicast_rendezvous_flag(ip6addr) ((ip6addr)->addr[0] & PP_HTONL(0x00400000UL))
236#define ip6_addr_multicast_scope(ip6addr) ((lwip_htonl((ip6addr)->addr[0]) >> 16) & 0xf)
237#define IP6_MULTICAST_SCOPE_RESERVED 0x0
238#define IP6_MULTICAST_SCOPE_RESERVED0 0x0
239#define IP6_MULTICAST_SCOPE_INTERFACE_LOCAL 0x1
240#define IP6_MULTICAST_SCOPE_LINK_LOCAL 0x2
241#define IP6_MULTICAST_SCOPE_RESERVED3 0x3
242#define IP6_MULTICAST_SCOPE_ADMIN_LOCAL 0x4
243#define IP6_MULTICAST_SCOPE_SITE_LOCAL 0x5
244#define IP6_MULTICAST_SCOPE_ORGANIZATION_LOCAL 0x8
245#define IP6_MULTICAST_SCOPE_GLOBAL 0xe
246#define IP6_MULTICAST_SCOPE_RESERVEDF 0xf
247#define ip6_addr_ismulticast_iflocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff010000UL))
248#define ip6_addr_ismulticast_linklocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff020000UL))
249#define ip6_addr_ismulticast_adminlocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff040000UL))
250#define ip6_addr_ismulticast_sitelocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff050000UL))
251#define ip6_addr_ismulticast_orglocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff080000UL))
252#define ip6_addr_ismulticast_global(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff0e0000UL))
253
254/* Scoping note: while interface-local and link-local multicast addresses do
255 * have a scope (i.e., they are meaningful only in the context of a particular
256 * interface), the following functions are not assigning or comparing zone
257 * indices. The reason for this is backward compatibility. Any call site that
258 * produces a non-global multicast address must assign a multicast address as
259 * appropriate itself. */
260
261#define ip6_addr_isallnodes_iflocal(ip6addr) (((ip6addr)->addr[0] == PP_HTONL(0xff010000UL)) && \
262 ((ip6addr)->addr[1] == 0UL) && \
263 ((ip6addr)->addr[2] == 0UL) && \
264 ((ip6addr)->addr[3] == PP_HTONL(0x00000001UL)))
265
266#define ip6_addr_isallnodes_linklocal(ip6addr) (((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
267 ((ip6addr)->addr[1] == 0UL) && \
268 ((ip6addr)->addr[2] == 0UL) && \
269 ((ip6addr)->addr[3] == PP_HTONL(0x00000001UL)))
270#define ip6_addr_set_allnodes_linklocal(ip6addr) do{(ip6addr)->addr[0] = PP_HTONL(0xff020000UL); \
271 (ip6addr)->addr[1] = 0; \
272 (ip6addr)->addr[2] = 0; \
273 (ip6addr)->addr[3] = PP_HTONL(0x00000001UL); \
274 ip6_addr_clear_zone(ip6addr); }while(0)
275
276#define ip6_addr_isallrouters_linklocal(ip6addr) (((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
277 ((ip6addr)->addr[1] == 0UL) && \
278 ((ip6addr)->addr[2] == 0UL) && \
279 ((ip6addr)->addr[3] == PP_HTONL(0x00000002UL)))
280#define ip6_addr_set_allrouters_linklocal(ip6addr) do{(ip6addr)->addr[0] = PP_HTONL(0xff020000UL); \
281 (ip6addr)->addr[1] = 0; \
282 (ip6addr)->addr[2] = 0; \
283 (ip6addr)->addr[3] = PP_HTONL(0x00000002UL); \
284 ip6_addr_clear_zone(ip6addr); }while(0)
285
286#define ip6_addr_issolicitednode(ip6addr) ( ((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
287 ((ip6addr)->addr[2] == PP_HTONL(0x00000001UL)) && \
288 (((ip6addr)->addr[3] & PP_HTONL(0xff000000UL)) == PP_HTONL(0xff000000UL)) )
289
290#define ip6_addr_set_solicitednode(ip6addr, if_id) do{(ip6addr)->addr[0] = PP_HTONL(0xff020000UL); \
291 (ip6addr)->addr[1] = 0; \
292 (ip6addr)->addr[2] = PP_HTONL(0x00000001UL); \
293 (ip6addr)->addr[3] = (PP_HTONL(0xff000000UL) | (if_id)); \
294 ip6_addr_clear_zone(ip6addr); }while(0)
295
296#define ip6_addr_cmp_solicitednode(ip6addr, sn_addr) ip6_addr_solicitednode_eq(ip6addr, sn_addr)
297#define ip6_addr_solicitednode_eq(ip6addr, sn_addr) (((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
298 ((ip6addr)->addr[1] == 0) && \
299 ((ip6addr)->addr[2] == PP_HTONL(0x00000001UL)) && \
300 ((ip6addr)->addr[3] == (PP_HTONL(0xff000000UL) | (sn_addr)->addr[3])))
301
302/* IPv6 address states. */
303#define IP6_ADDR_INVALID 0x00
304#define IP6_ADDR_TENTATIVE 0x08
305#define IP6_ADDR_TENTATIVE_1 0x09 /* 1 probe sent */
306#define IP6_ADDR_TENTATIVE_2 0x0a /* 2 probes sent */
307#define IP6_ADDR_TENTATIVE_3 0x0b /* 3 probes sent */
308#define IP6_ADDR_TENTATIVE_4 0x0c /* 4 probes sent */
309#define IP6_ADDR_TENTATIVE_5 0x0d /* 5 probes sent */
310#define IP6_ADDR_TENTATIVE_6 0x0e /* 6 probes sent */
311#define IP6_ADDR_TENTATIVE_7 0x0f /* 7 probes sent */
312#define IP6_ADDR_VALID 0x10 /* This bit marks an address as valid (preferred or deprecated) */
313#define IP6_ADDR_PREFERRED 0x30
314#define IP6_ADDR_DEPRECATED 0x10 /* Same as VALID (valid but not preferred) */
315#define IP6_ADDR_DUPLICATED 0x40 /* Failed DAD test, not valid */
316
317#define IP6_ADDR_TENTATIVE_COUNT_MASK 0x07 /* 1-7 probes sent */
318
319#define ip6_addr_isinvalid(addr_state) (addr_state == IP6_ADDR_INVALID)
320#define ip6_addr_istentative(addr_state) (addr_state & IP6_ADDR_TENTATIVE)
321#define ip6_addr_isvalid(addr_state) (addr_state & IP6_ADDR_VALID) /* Include valid, preferred, and deprecated. */
322#define ip6_addr_ispreferred(addr_state) (addr_state == IP6_ADDR_PREFERRED)
323#define ip6_addr_isdeprecated(addr_state) (addr_state == IP6_ADDR_DEPRECATED)
324#define ip6_addr_isduplicated(addr_state) (addr_state == IP6_ADDR_DUPLICATED)
325
326#if LWIP_IPV6_ADDRESS_LIFETIMES
327#define IP6_ADDR_LIFE_STATIC (0)
328#define IP6_ADDR_LIFE_INFINITE (0xffffffffUL)
329#define ip6_addr_life_isstatic(addr_life) ((addr_life) == IP6_ADDR_LIFE_STATIC)
330#define ip6_addr_life_isinfinite(addr_life) ((addr_life) == IP6_ADDR_LIFE_INFINITE)
331#endif /* LWIP_IPV6_ADDRESS_LIFETIMES */
332
333#define ip6_addr_debug_print_parts(debug, a, b, c, d, e, f, g, h) \
334 LWIP_DEBUGF(debug, ("%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F, \
335 a, b, c, d, e, f, g, h))
336#define ip6_addr_debug_print(debug, ipaddr) \
337 ip6_addr_debug_print_parts(debug, \
338 (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK1(ipaddr) : 0), \
339 (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK2(ipaddr) : 0), \
340 (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK3(ipaddr) : 0), \
341 (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK4(ipaddr) : 0), \
342 (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK5(ipaddr) : 0), \
343 (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK6(ipaddr) : 0), \
344 (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK7(ipaddr) : 0), \
345 (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK8(ipaddr) : 0))
346#define ip6_addr_debug_print_val(debug, ipaddr) \
347 ip6_addr_debug_print_parts(debug, \
348 IP6_ADDR_BLOCK1(&(ipaddr)), \
349 IP6_ADDR_BLOCK2(&(ipaddr)), \
350 IP6_ADDR_BLOCK3(&(ipaddr)), \
351 IP6_ADDR_BLOCK4(&(ipaddr)), \
352 IP6_ADDR_BLOCK5(&(ipaddr)), \
353 IP6_ADDR_BLOCK6(&(ipaddr)), \
354 IP6_ADDR_BLOCK7(&(ipaddr)), \
355 IP6_ADDR_BLOCK8(&(ipaddr)))
356
357#define IP6ADDR_STRLEN_MAX 46
358
359int ip6addr_aton(const char *cp, ip6_addr_t *addr);
361char *ip6addr_ntoa(const ip6_addr_t *addr);
362char *ip6addr_ntoa_r(const ip6_addr_t *addr, char *buf, int buflen);
363
364
365
366#ifdef __cplusplus
367}
368#endif
369
370#endif /* LWIP_IPV6 */
371
372#endif /* LWIP_HDR_IP6_ADDR_H */
buf
GLenum GLuint GLenum GLsizei const GLchar * buf
Definition: glext.h:7751
addr
GLenum const GLvoid * addr
Definition: glext.h:9621
u32_t
uint32_t u32_t
Definition: arch.h:129
u8_t
uint8_t u8_t
Definition: arch.h:125
ip6_zone.h
cp
POINT cp
Definition: magnifier.c:59
zone
DWORD zone
Definition: sec_mgr.c:1754