UbixOS  2.0
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 <net/opt.h>
46 #include <net/def.h>
47 
48 #if LWIP_IPV6 /* don't build if not configured for use in lwipopts.h */
49 
50 
51 #ifdef __cplusplus
52 extern "C" {
53 #endif
54 
55 
58 struct ip6_addr {
59  u32_t addr[4];
60 };
61 
63 typedef struct ip6_addr ip6_addr_t;
64 
66 #define IP6_ADDR_PART(ip6addr, index, a,b,c,d) \
67  (ip6addr)->addr[index] = PP_HTONL(LWIP_MAKEU32(a,b,c,d))
68 
71 #define IP6_ADDR(ip6addr, idx0, idx1, idx2, idx3) do { \
72  (ip6addr)->addr[0] = idx0; \
73  (ip6addr)->addr[1] = idx1; \
74  (ip6addr)->addr[2] = idx2; \
75  (ip6addr)->addr[3] = idx3; } while(0)
76 
78 #define IP6_ADDR_BLOCK1(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[0]) >> 16) & 0xffff))
79 
80 #define IP6_ADDR_BLOCK2(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[0])) & 0xffff))
81 
82 #define IP6_ADDR_BLOCK3(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[1]) >> 16) & 0xffff))
83 
84 #define IP6_ADDR_BLOCK4(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[1])) & 0xffff))
85 
86 #define IP6_ADDR_BLOCK5(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[2]) >> 16) & 0xffff))
87 
88 #define IP6_ADDR_BLOCK6(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[2])) & 0xffff))
89 
90 #define IP6_ADDR_BLOCK7(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[3]) >> 16) & 0xffff))
91 
92 #define IP6_ADDR_BLOCK8(ip6addr) ((u16_t)((lwip_htonl((ip6addr)->addr[3])) & 0xffff))
93 
95 #define ip6_addr_copy(dest, src) do{(dest).addr[0] = (src).addr[0]; \
96  (dest).addr[1] = (src).addr[1]; \
97  (dest).addr[2] = (src).addr[2]; \
98  (dest).addr[3] = (src).addr[3];}while(0)
99 
100 #define ip6_addr_set(dest, src) do{(dest)->addr[0] = (src) == NULL ? 0 : (src)->addr[0]; \
101  (dest)->addr[1] = (src) == NULL ? 0 : (src)->addr[1]; \
102  (dest)->addr[2] = (src) == NULL ? 0 : (src)->addr[2]; \
103  (dest)->addr[3] = (src) == NULL ? 0 : (src)->addr[3];}while(0)
104 
106 #define ip6_addr_set_zero(ip6addr) do{(ip6addr)->addr[0] = 0; \
107  (ip6addr)->addr[1] = 0; \
108  (ip6addr)->addr[2] = 0; \
109  (ip6addr)->addr[3] = 0;}while(0)
110 
112 #define ip6_addr_set_any(ip6addr) ip6_addr_set_zero(ip6addr)
113 
114 #define ip6_addr_set_loopback(ip6addr) do{(ip6addr)->addr[0] = 0; \
115  (ip6addr)->addr[1] = 0; \
116  (ip6addr)->addr[2] = 0; \
117  (ip6addr)->addr[3] = PP_HTONL(0x00000001UL);}while(0)
118 
120 #define ip6_addr_set_hton(dest, src) do{(dest)->addr[0] = (src) == NULL ? 0 : lwip_htonl((src)->addr[0]); \
121  (dest)->addr[1] = (src) == NULL ? 0 : lwip_htonl((src)->addr[1]); \
122  (dest)->addr[2] = (src) == NULL ? 0 : lwip_htonl((src)->addr[2]); \
123  (dest)->addr[3] = (src) == NULL ? 0 : lwip_htonl((src)->addr[3]);}while(0)
124 
125 
133 #define ip6_addr_netcmp(addr1, addr2) (((addr1)->addr[0] == (addr2)->addr[0]) && \
134  ((addr1)->addr[1] == (addr2)->addr[1]))
135 
136 #define ip6_addr_cmp(addr1, addr2) (((addr1)->addr[0] == (addr2)->addr[0]) && \
137  ((addr1)->addr[1] == (addr2)->addr[1]) && \
138  ((addr1)->addr[2] == (addr2)->addr[2]) && \
139  ((addr1)->addr[3] == (addr2)->addr[3]))
140 
141 #define ip6_get_subnet_id(ip6addr) (lwip_htonl((ip6addr)->addr[2]) & 0x0000ffffUL)
142 
143 #define ip6_addr_isany_val(ip6addr) (((ip6addr).addr[0] == 0) && \
144  ((ip6addr).addr[1] == 0) && \
145  ((ip6addr).addr[2] == 0) && \
146  ((ip6addr).addr[3] == 0))
147 #define ip6_addr_isany(ip6addr) (((ip6addr) == NULL) || ip6_addr_isany_val(*(ip6addr)))
148 
149 #define ip6_addr_isloopback(ip6addr) (((ip6addr)->addr[0] == 0UL) && \
150  ((ip6addr)->addr[1] == 0UL) && \
151  ((ip6addr)->addr[2] == 0UL) && \
152  ((ip6addr)->addr[3] == PP_HTONL(0x00000001UL)))
153 
154 #define ip6_addr_isglobal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xe0000000UL)) == PP_HTONL(0x20000000UL))
155 
156 #define ip6_addr_islinklocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xffc00000UL)) == PP_HTONL(0xfe800000UL))
157 
158 #define ip6_addr_issitelocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xffc00000UL)) == PP_HTONL(0xfec00000UL))
159 
160 #define ip6_addr_isuniquelocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xfe000000UL)) == PP_HTONL(0xfc000000UL))
161 
162 #define ip6_addr_isipv4mappedipv6(ip6addr) (((ip6addr)->addr[0] == 0) && ((ip6addr)->addr[1] == 0) && (((ip6addr)->addr[2]) == PP_HTONL(0x0000FFFFUL)))
163 
164 #define ip6_addr_ismulticast(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff000000UL)) == PP_HTONL(0xff000000UL))
165 #define ip6_addr_multicast_transient_flag(ip6addr) ((ip6addr)->addr[0] & PP_HTONL(0x00100000UL))
166 #define ip6_addr_multicast_prefix_flag(ip6addr) ((ip6addr)->addr[0] & PP_HTONL(0x00200000UL))
167 #define ip6_addr_multicast_rendezvous_flag(ip6addr) ((ip6addr)->addr[0] & PP_HTONL(0x00400000UL))
168 #define ip6_addr_multicast_scope(ip6addr) ((lwip_htonl((ip6addr)->addr[0]) >> 16) & 0xf)
169 #define IP6_MULTICAST_SCOPE_RESERVED 0x0
170 #define IP6_MULTICAST_SCOPE_RESERVED0 0x0
171 #define IP6_MULTICAST_SCOPE_INTERFACE_LOCAL 0x1
172 #define IP6_MULTICAST_SCOPE_LINK_LOCAL 0x2
173 #define IP6_MULTICAST_SCOPE_RESERVED3 0x3
174 #define IP6_MULTICAST_SCOPE_ADMIN_LOCAL 0x4
175 #define IP6_MULTICAST_SCOPE_SITE_LOCAL 0x5
176 #define IP6_MULTICAST_SCOPE_ORGANIZATION_LOCAL 0x8
177 #define IP6_MULTICAST_SCOPE_GLOBAL 0xe
178 #define IP6_MULTICAST_SCOPE_RESERVEDF 0xf
179 #define ip6_addr_ismulticast_iflocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff010000UL))
180 #define ip6_addr_ismulticast_linklocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff020000UL))
181 #define ip6_addr_ismulticast_adminlocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff040000UL))
182 #define ip6_addr_ismulticast_sitelocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff050000UL))
183 #define ip6_addr_ismulticast_orglocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff080000UL))
184 #define ip6_addr_ismulticast_global(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff0e0000UL))
185 
186 /* @todo define get/set for well-know multicast addresses, e.g. ff02::1 */
187 #define ip6_addr_isallnodes_iflocal(ip6addr) (((ip6addr)->addr[0] == PP_HTONL(0xff010000UL)) && \
188  ((ip6addr)->addr[1] == 0UL) && \
189  ((ip6addr)->addr[2] == 0UL) && \
190  ((ip6addr)->addr[3] == PP_HTONL(0x00000001UL)))
191 
192 #define ip6_addr_isallnodes_linklocal(ip6addr) (((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
193  ((ip6addr)->addr[1] == 0UL) && \
194  ((ip6addr)->addr[2] == 0UL) && \
195  ((ip6addr)->addr[3] == PP_HTONL(0x00000001UL)))
196 #define ip6_addr_set_allnodes_linklocal(ip6addr) do{(ip6addr)->addr[0] = PP_HTONL(0xff020000UL); \
197  (ip6addr)->addr[1] = 0; \
198  (ip6addr)->addr[2] = 0; \
199  (ip6addr)->addr[3] = PP_HTONL(0x00000001UL);}while(0)
200 
201 #define ip6_addr_isallrouters_linklocal(ip6addr) (((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
202  ((ip6addr)->addr[1] == 0UL) && \
203  ((ip6addr)->addr[2] == 0UL) && \
204  ((ip6addr)->addr[3] == PP_HTONL(0x00000002UL)))
205 #define ip6_addr_set_allrouters_linklocal(ip6addr) do{(ip6addr)->addr[0] = PP_HTONL(0xff020000UL); \
206  (ip6addr)->addr[1] = 0; \
207  (ip6addr)->addr[2] = 0; \
208  (ip6addr)->addr[3] = PP_HTONL(0x00000002UL);}while(0)
209 
210 #define ip6_addr_issolicitednode(ip6addr) ( ((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
211  ((ip6addr)->addr[2] == PP_HTONL(0x00000001UL)) && \
212  (((ip6addr)->addr[3] & PP_HTONL(0xff000000UL)) == PP_HTONL(0xff000000UL)) )
213 
214 #define ip6_addr_set_solicitednode(ip6addr, if_id) do{(ip6addr)->addr[0] = PP_HTONL(0xff020000UL); \
215  (ip6addr)->addr[1] = 0; \
216  (ip6addr)->addr[2] = PP_HTONL(0x00000001UL); \
217  (ip6addr)->addr[3] = (PP_HTONL(0xff000000UL) | (if_id));}while(0)
218 
219 #define ip6_addr_cmp_solicitednode(ip6addr, sn_addr) (((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
220  ((ip6addr)->addr[1] == 0) && \
221  ((ip6addr)->addr[2] == PP_HTONL(0x00000001UL)) && \
222  ((ip6addr)->addr[3] == (PP_HTONL(0xff000000UL) | (sn_addr)->addr[3])))
223 
224 /* IPv6 address states. */
225 #define IP6_ADDR_INVALID 0x00
226 #define IP6_ADDR_TENTATIVE 0x08
227 #define IP6_ADDR_TENTATIVE_1 0x09 /* 1 probe sent */
228 #define IP6_ADDR_TENTATIVE_2 0x0a /* 2 probes sent */
229 #define IP6_ADDR_TENTATIVE_3 0x0b /* 3 probes sent */
230 #define IP6_ADDR_TENTATIVE_4 0x0c /* 4 probes sent */
231 #define IP6_ADDR_TENTATIVE_5 0x0d /* 5 probes sent */
232 #define IP6_ADDR_TENTATIVE_6 0x0e /* 6 probes sent */
233 #define IP6_ADDR_TENTATIVE_7 0x0f /* 7 probes sent */
234 #define IP6_ADDR_VALID 0x10 /* This bit marks an address as valid (preferred or deprecated) */
235 #define IP6_ADDR_PREFERRED 0x30
236 #define IP6_ADDR_DEPRECATED 0x10 /* Same as VALID (valid but not preferred) */
237 
238 #define IP6_ADDR_TENTATIVE_COUNT_MASK 0x07 /* 1-7 probes sent */
239 
240 #define ip6_addr_isinvalid(addr_state) (addr_state == IP6_ADDR_INVALID)
241 #define ip6_addr_istentative(addr_state) (addr_state & IP6_ADDR_TENTATIVE)
242 #define ip6_addr_isvalid(addr_state) (addr_state & IP6_ADDR_VALID) /* Include valid, preferred, and deprecated. */
243 #define ip6_addr_ispreferred(addr_state) (addr_state == IP6_ADDR_PREFERRED)
244 #define ip6_addr_isdeprecated(addr_state) (addr_state == IP6_ADDR_DEPRECATED)
245 
246 #define ip6_addr_debug_print_parts(debug, a, b, c, d, e, f, g, h) \
247  LWIP_DEBUGF(debug, ("%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F, \
248  a, b, c, d, e, f, g, h))
249 #define ip6_addr_debug_print(debug, ipaddr) \
250  ip6_addr_debug_print_parts(debug, \
251  (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK1(ipaddr) : 0), \
252  (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK2(ipaddr) : 0), \
253  (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK3(ipaddr) : 0), \
254  (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK4(ipaddr) : 0), \
255  (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK5(ipaddr) : 0), \
256  (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK6(ipaddr) : 0), \
257  (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK7(ipaddr) : 0), \
258  (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK8(ipaddr) : 0))
259 #define ip6_addr_debug_print_val(debug, ipaddr) \
260  ip6_addr_debug_print_parts(debug, \
261  IP6_ADDR_BLOCK1(&(ipaddr)), \
262  IP6_ADDR_BLOCK2(&(ipaddr)), \
263  IP6_ADDR_BLOCK3(&(ipaddr)), \
264  IP6_ADDR_BLOCK4(&(ipaddr)), \
265  IP6_ADDR_BLOCK5(&(ipaddr)), \
266  IP6_ADDR_BLOCK6(&(ipaddr)), \
267  IP6_ADDR_BLOCK7(&(ipaddr)), \
268  IP6_ADDR_BLOCK8(&(ipaddr)))
269 
270 #define IP6ADDR_STRLEN_MAX 46
271 
272 int ip6addr_aton(const char *cp, ip6_addr_t *addr);
274 char *ip6addr_ntoa(const ip6_addr_t *addr);
275 char *ip6addr_ntoa_r(const ip6_addr_t *addr, char *buf, int buflen);
276 
277 
278 
279 #ifdef __cplusplus
280 }
281 #endif
282 
283 #endif /* LWIP_IPV6 */
284 
285 #endif /* LWIP_HDR_IP6_ADDR_H */
opt.h
def.h
u32_t
uint32_t u32_t
Definition: arch.h:126
buf
Definition: buf.h:35