ip6_addr.h

00001 /**
00002  * @file
00003  *
00004  * IPv6 addresses.
00005  */
00006 
00007 /*
00008  * Copyright (c) 2010 Inico Technologies Ltd.
00009  * All rights reserved.
00010  *
00011  * Redistribution and use in source and binary forms, with or without modification,
00012  * are permitted provided that the following conditions are met:
00013  *
00014  * 1. Redistributions of source code must retain the above copyright notice,
00015  *    this list of conditions and the following disclaimer.
00016  * 2. Redistributions in binary form must reproduce the above copyright notice,
00017  *    this list of conditions and the following disclaimer in the documentation
00018  *    and/or other materials provided with the distribution.
00019  * 3. The name of the author may not be used to endorse or promote products
00020  *    derived from this software without specific prior written permission.
00021  *
00022  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
00023  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00024  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
00025  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00026  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
00027  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00028  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00029  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
00030  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
00031  * OF SUCH DAMAGE.
00032  *
00033  * This file is part of the lwIP TCP/IP stack.
00034  *
00035  * Author: Ivan Delamer <delamer@inicotech.com>
00036  *
00037  * Structs and macros for handling IPv6 addresses.
00038  *
00039  * Please coordinate changes and requests with Ivan Delamer
00040  * <delamer@inicotech.com>
00041  */
00042 #ifndef LWIP_HDR_IP6_ADDR_H
00043 #define LWIP_HDR_IP6_ADDR_H
00044 
00045 #include "lwip/opt.h"
00046 
00047 #if LWIP_IPV6  /* don't build if not configured for use in lwipopts.h */
00048 
00049 
00050 #ifdef __cplusplus
00051 extern "C" {
00052 #endif
00053 
00054 
00055 /** This is the aligned version of ip6_addr_t,
00056     used as local variable, on the stack, etc. */
00057 struct ip6_addr {
00058   u32_t addr[4];
00059 };
00060 
00061 /** This is the packed version of ip6_addr_t,
00062     used in network headers that are itself packed */
00063 #ifdef PACK_STRUCT_USE_INCLUDES
00064 #  include "arch/bpstruct.h"
00065 #endif
00066 PACK_STRUCT_BEGIN
00067 struct ip6_addr_packed {
00068   PACK_STRUCT_FIELD(u32_t addr[4]);
00069 } PACK_STRUCT_STRUCT;
00070 PACK_STRUCT_END
00071 #ifdef PACK_STRUCT_USE_INCLUDES
00072 #  include "arch/epstruct.h"
00073 #endif
00074 
00075 /** IPv6 address */
00076 typedef struct ip6_addr ip6_addr_t;
00077 typedef struct ip6_addr_packed ip6_addr_p_t;
00078 
00079 
00080 #if BYTE_ORDER == BIG_ENDIAN
00081 /** Set an IPv6 partial address given by byte-parts. */
00082 #define IP6_ADDR_PART(ip6addr, index, a,b,c,d) \
00083   (ip6addr)->addr[index] = ((u32_t)((a) & 0xff) << 24) | \
00084                            ((u32_t)((b) & 0xff) << 16) | \
00085                            ((u32_t)((c) & 0xff) << 8)  | \
00086                             (u32_t)((d) & 0xff)
00087 #else
00088 /** Set an IPv6 partial address given by byte-parts.
00089 Little-endian version, stored in network order (no htonl). */
00090 #define IP6_ADDR_PART(ip6addr, index, a,b,c,d) \
00091   (ip6addr)->addr[index] = ((u32_t)((d) & 0xff) << 24) | \
00092                            ((u32_t)((c) & 0xff) << 16) | \
00093                            ((u32_t)((b) & 0xff) << 8)  | \
00094                             (u32_t)((a) & 0xff)
00095 #endif
00096 
00097 /** Set a full IPv6 address by passing the 4 u32_t indices in network byte order
00098     (use PP_HTONL() for constants) */
00099 #define IP6_ADDR(ip6addr, idx0, idx1, idx2, idx3) do { \
00100   (ip6addr)->addr[0] = idx0; \
00101   (ip6addr)->addr[1] = idx1; \
00102   (ip6addr)->addr[2] = idx2; \
00103   (ip6addr)->addr[3] = idx3; } while(0)
00104 
00105 /** Access address in 16-bit block */
00106 #define IP6_ADDR_BLOCK1(ip6addr) ((u16_t)((htonl((ip6addr)->addr[0]) >> 16) & 0xffff))
00107 /** Access address in 16-bit block */
00108 #define IP6_ADDR_BLOCK2(ip6addr) ((u16_t)((htonl((ip6addr)->addr[0])) & 0xffff))
00109 /** Access address in 16-bit block */
00110 #define IP6_ADDR_BLOCK3(ip6addr) ((u16_t)((htonl((ip6addr)->addr[1]) >> 16) & 0xffff))
00111 /** Access address in 16-bit block */
00112 #define IP6_ADDR_BLOCK4(ip6addr) ((u16_t)((htonl((ip6addr)->addr[1])) & 0xffff))
00113 /** Access address in 16-bit block */
00114 #define IP6_ADDR_BLOCK5(ip6addr) ((u16_t)((htonl((ip6addr)->addr[2]) >> 16) & 0xffff))
00115 /** Access address in 16-bit block */
00116 #define IP6_ADDR_BLOCK6(ip6addr) ((u16_t)((htonl((ip6addr)->addr[2])) & 0xffff))
00117 /** Access address in 16-bit block */
00118 #define IP6_ADDR_BLOCK7(ip6addr) ((u16_t)((htonl((ip6addr)->addr[3]) >> 16) & 0xffff))
00119 /** Access address in 16-bit block */
00120 #define IP6_ADDR_BLOCK8(ip6addr) ((u16_t)((htonl((ip6addr)->addr[3])) & 0xffff))
00121 
00122 /** Copy IPv6 address - faster than ip6_addr_set: no NULL check */
00123 #define ip6_addr_copy(dest, src) do{(dest).addr[0] = (src).addr[0]; \
00124                                     (dest).addr[1] = (src).addr[1]; \
00125                                     (dest).addr[2] = (src).addr[2]; \
00126                                     (dest).addr[3] = (src).addr[3];}while(0)
00127 /** Safely copy one IPv6 address to another (src may be NULL) */
00128 #define ip6_addr_set(dest, src) do{(dest)->addr[0] = (src) == NULL ? 0 : (src)->addr[0]; \
00129                                    (dest)->addr[1] = (src) == NULL ? 0 : (src)->addr[1]; \
00130                                    (dest)->addr[2] = (src) == NULL ? 0 : (src)->addr[2]; \
00131                                    (dest)->addr[3] = (src) == NULL ? 0 : (src)->addr[3];}while(0)
00132 
00133 /** Set complete address to zero */
00134 #define ip6_addr_set_zero(ip6addr)    do{(ip6addr)->addr[0] = 0; \
00135                                          (ip6addr)->addr[1] = 0; \
00136                                          (ip6addr)->addr[2] = 0; \
00137                                          (ip6addr)->addr[3] = 0;}while(0)
00138 
00139 /** Set address to ipv6 'any' (no need for htonl()) */
00140 #define ip6_addr_set_any(ip6addr)       ip6_addr_set_zero(ip6addr)
00141 /** Set address to ipv6 loopback address */
00142 #define ip6_addr_set_loopback(ip6addr) do{(ip6addr)->addr[0] = 0; \
00143                                           (ip6addr)->addr[1] = 0; \
00144                                           (ip6addr)->addr[2] = 0; \
00145                                           (ip6addr)->addr[3] = PP_HTONL(0x00000001UL);}while(0)
00146 /** Safely copy one IPv6 address to another and change byte order
00147  * from host- to network-order. */
00148 #define ip6_addr_set_hton(dest, src) do{(dest)->addr[0] = (src) == NULL ? 0 : htonl((src)->addr[0]); \
00149                                         (dest)->addr[1] = (src) == NULL ? 0 : htonl((src)->addr[1]); \
00150                                         (dest)->addr[2] = (src) == NULL ? 0 : htonl((src)->addr[2]); \
00151                                         (dest)->addr[3] = (src) == NULL ? 0 : htonl((src)->addr[3]);}while(0)
00152 
00153 
00154 /**
00155  * Determine if two IPv6 address are on the same network.
00156  *
00157  * @arg addr1 IPv6 address 1
00158  * @arg addr2 IPv6 address 2
00159  * @return !0 if the network identifiers of both address match
00160  */
00161 #define ip6_addr_netcmp(addr1, addr2) (((addr1)->addr[0] == (addr2)->addr[0]) && \
00162                                        ((addr1)->addr[1] == (addr2)->addr[1]))
00163 
00164 #define ip6_addr_cmp(addr1, addr2) (((addr1)->addr[0] == (addr2)->addr[0]) && \
00165                                     ((addr1)->addr[1] == (addr2)->addr[1]) && \
00166                                     ((addr1)->addr[2] == (addr2)->addr[2]) && \
00167                                     ((addr1)->addr[3] == (addr2)->addr[3]))
00168 
00169 #define ip6_get_subnet_id(ip6addr)   (htonl((ip6addr)->addr[2]) & 0x0000ffffUL)
00170 
00171 #define ip6_addr_isany_val(ip6addr) (((ip6addr).addr[0] == 0) && \
00172                                      ((ip6addr).addr[1] == 0) && \
00173                                      ((ip6addr).addr[2] == 0) && \
00174                                      ((ip6addr).addr[3] == 0))
00175 #define ip6_addr_isany(ip6addr) (((ip6addr) == NULL) || ip6_addr_isany_val(*(ip6addr)))
00176 
00177 #define ip6_addr_isloopback(ip6addr) (((ip6addr)->addr[0] == 0UL) && \
00178                                       ((ip6addr)->addr[1] == 0UL) && \
00179                                       ((ip6addr)->addr[2] == 0UL) && \
00180                                       ((ip6addr)->addr[3] == PP_HTONL(0x00000001UL)))
00181 
00182 #define ip6_addr_isglobal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xe0000000UL)) == PP_HTONL(0x20000000UL))
00183 
00184 #define ip6_addr_islinklocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xffc00000UL)) == PP_HTONL(0xfe800000UL))
00185 
00186 #define ip6_addr_issitelocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xffc00000UL)) == PP_HTONL(0xfec00000UL))
00187 
00188 #define ip6_addr_isuniquelocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xfe000000UL)) == PP_HTONL(0xfc000000UL))
00189 
00190 #define ip6_addr_isipv6mappedipv4(ip6addr) (((ip6addr)->addr[0] == 0) && ((ip6addr)->addr[1] == 0) && (((ip6addr)->addr[2]) == PP_HTONL(0x0000FFFFUL)))
00191 
00192 #define ip6_addr_ismulticast(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff000000UL)) == PP_HTONL(0xff000000UL))
00193 #define ip6_addr_multicast_transient_flag(ip6addr)  ((ip6addr)->addr[0] & PP_HTONL(0x00100000UL))
00194 #define ip6_addr_multicast_prefix_flag(ip6addr)     ((ip6addr)->addr[0] & PP_HTONL(0x00200000UL))
00195 #define ip6_addr_multicast_rendezvous_flag(ip6addr) ((ip6addr)->addr[0] & PP_HTONL(0x00400000UL))
00196 #define ip6_addr_multicast_scope(ip6addr) ((htonl((ip6addr)->addr[0]) >> 16) & 0xf)
00197 #define IP6_MULTICAST_SCOPE_RESERVED            0x0
00198 #define IP6_MULTICAST_SCOPE_RESERVED0           0x0
00199 #define IP6_MULTICAST_SCOPE_INTERFACE_LOCAL     0x1
00200 #define IP6_MULTICAST_SCOPE_LINK_LOCAL          0x2
00201 #define IP6_MULTICAST_SCOPE_RESERVED3           0x3
00202 #define IP6_MULTICAST_SCOPE_ADMIN_LOCAL         0x4
00203 #define IP6_MULTICAST_SCOPE_SITE_LOCAL          0x5
00204 #define IP6_MULTICAST_SCOPE_ORGANIZATION_LOCAL  0x8
00205 #define IP6_MULTICAST_SCOPE_GLOBAL              0xe
00206 #define IP6_MULTICAST_SCOPE_RESERVEDF           0xf
00207 #define ip6_addr_ismulticast_iflocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff010000UL))
00208 #define ip6_addr_ismulticast_linklocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff020000UL))
00209 #define ip6_addr_ismulticast_adminlocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff040000UL))
00210 #define ip6_addr_ismulticast_sitelocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff050000UL))
00211 #define ip6_addr_ismulticast_orglocal(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff080000UL))
00212 #define ip6_addr_ismulticast_global(ip6addr) (((ip6addr)->addr[0] & PP_HTONL(0xff8f0000UL)) == PP_HTONL(0xff0e0000UL))
00213 
00214 /* @todo define get/set for well-know multicast addresses, e.g. ff02::1 */
00215 #define ip6_addr_isallnodes_iflocal(ip6addr) (((ip6addr)->addr[0] == PP_HTONL(0xff010000UL)) && \
00216     ((ip6addr)->addr[1] == 0UL) && \
00217     ((ip6addr)->addr[2] == 0UL) && \
00218     ((ip6addr)->addr[3] == PP_HTONL(0x00000001UL)))
00219 
00220 #define ip6_addr_isallnodes_linklocal(ip6addr) (((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
00221     ((ip6addr)->addr[1] == 0UL) && \
00222     ((ip6addr)->addr[2] == 0UL) && \
00223     ((ip6addr)->addr[3] == PP_HTONL(0x00000001UL)))
00224 #define ip6_addr_set_allnodes_linklocal(ip6addr) do{(ip6addr)->addr[0] = PP_HTONL(0xff020000UL); \
00225                 (ip6addr)->addr[1] = 0; \
00226                 (ip6addr)->addr[2] = 0; \
00227                 (ip6addr)->addr[3] = PP_HTONL(0x00000001UL);}while(0)
00228 
00229 #define ip6_addr_isallrouters_linklocal(ip6addr) (((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
00230     ((ip6addr)->addr[1] == 0UL) && \
00231     ((ip6addr)->addr[2] == 0UL) && \
00232     ((ip6addr)->addr[3] == PP_HTONL(0x00000002UL)))
00233 #define ip6_addr_set_allrouters_linklocal(ip6addr) do{(ip6addr)->addr[0] = PP_HTONL(0xff020000UL); \
00234                 (ip6addr)->addr[1] = 0; \
00235                 (ip6addr)->addr[2] = 0; \
00236                 (ip6addr)->addr[3] = PP_HTONL(0x00000002UL);}while(0)
00237 
00238 #define ip6_addr_issolicitednode(ip6addr) ( ((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
00239         ((ip6addr)->addr[2] == PP_HTONL(0x00000001UL)) && \
00240         (((ip6addr)->addr[3] & PP_HTONL(0xff000000UL)) == PP_HTONL(0xff000000UL)) )
00241 
00242 #define ip6_addr_set_solicitednode(ip6addr, if_id) do{(ip6addr)->addr[0] = PP_HTONL(0xff020000UL); \
00243                 (ip6addr)->addr[1] = 0; \
00244                 (ip6addr)->addr[2] = PP_HTONL(0x00000001UL); \
00245                 (ip6addr)->addr[3] = (PP_HTONL(0xff000000UL) | (if_id));}while(0)
00246 
00247 #define ip6_addr_cmp_solicitednode(ip6addr, sn_addr) (((ip6addr)->addr[0] == PP_HTONL(0xff020000UL)) && \
00248                                     ((ip6addr)->addr[1] == 0) && \
00249                                     ((ip6addr)->addr[2] == PP_HTONL(0x00000001UL)) && \
00250                                     ((ip6addr)->addr[3] == (PP_HTONL(0xff000000UL) | (sn_addr)->addr[3])))
00251 
00252 /* IPv6 address states. */
00253 #define IP6_ADDR_INVALID      0x00
00254 #define IP6_ADDR_TENTATIVE    0x08
00255 #define IP6_ADDR_TENTATIVE_1  0x09 /* 1 probe sent */
00256 #define IP6_ADDR_TENTATIVE_2  0x0a /* 2 probes sent */
00257 #define IP6_ADDR_TENTATIVE_3  0x0b /* 3 probes sent */
00258 #define IP6_ADDR_TENTATIVE_4  0x0c /* 4 probes sent */
00259 #define IP6_ADDR_TENTATIVE_5  0x0d /* 5 probes sent */
00260 #define IP6_ADDR_TENTATIVE_6  0x0e /* 6 probes sent */
00261 #define IP6_ADDR_TENTATIVE_7  0x0f /* 7 probes sent */
00262 #define IP6_ADDR_VALID        0x10
00263 #define IP6_ADDR_PREFERRED    0x30
00264 #define IP6_ADDR_DEPRECATED   0x50
00265 
00266 #define ip6_addr_isinvalid(addr_state) (addr_state == IP6_ADDR_INVALID)
00267 #define ip6_addr_istentative(addr_state) (addr_state & IP6_ADDR_TENTATIVE)
00268 #define ip6_addr_isvalid(addr_state) (addr_state & IP6_ADDR_VALID) /* Include valid, preferred, and deprecated. */
00269 #define ip6_addr_ispreferred(addr_state) (addr_state == IP6_ADDR_PREFERRED)
00270 #define ip6_addr_isdeprecated(addr_state) (addr_state == IP6_ADDR_DEPRECATED)
00271 
00272 #define ip6_addr_debug_print_parts(debug, a, b, c, d, e, f, g, h) \
00273   LWIP_DEBUGF(debug, ("%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F ":%" X16_F, \
00274                       a, b, c, d, e, f, g, h))
00275 #define ip6_addr_debug_print(debug, ipaddr) \
00276   ip6_addr_debug_print_parts(debug, \
00277                       (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK1(ipaddr) : 0),    \
00278                       (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK2(ipaddr) : 0),    \
00279                       (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK3(ipaddr) : 0),    \
00280                       (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK4(ipaddr) : 0),    \
00281                       (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK5(ipaddr) : 0),    \
00282                       (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK6(ipaddr) : 0),    \
00283                       (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK7(ipaddr) : 0),    \
00284                       (u16_t)((ipaddr) != NULL ? IP6_ADDR_BLOCK8(ipaddr) : 0))
00285 #define ip6_addr_debug_print_val(debug, ipaddr) \
00286   ip6_addr_debug_print_parts(debug, \
00287                       IP6_ADDR_BLOCK1(&(ipaddr)),    \
00288                       IP6_ADDR_BLOCK2(&(ipaddr)),    \
00289                       IP6_ADDR_BLOCK3(&(ipaddr)),    \
00290                       IP6_ADDR_BLOCK4(&(ipaddr)),    \
00291                       IP6_ADDR_BLOCK5(&(ipaddr)),    \
00292                       IP6_ADDR_BLOCK6(&(ipaddr)),    \
00293                       IP6_ADDR_BLOCK7(&(ipaddr)),    \
00294                       IP6_ADDR_BLOCK8(&(ipaddr)))
00295 
00296 #define IP6ADDR_STRLEN_MAX    46
00297 
00298 int ip6addr_aton(const char *cp, ip6_addr_t *addr);
00299 /** returns ptr to static buffer; not reentrant! */
00300 char *ip6addr_ntoa(const ip6_addr_t *addr);
00301 char *ip6addr_ntoa_r(const ip6_addr_t *addr, char *buf, int buflen);
00302 
00303 
00304 
00305 #ifdef __cplusplus
00306 }
00307 #endif
00308 
00309 #endif /* LWIP_IPV6 */
00310 
00311 #endif /* LWIP_HDR_IP6_ADDR_H */