sys/netinet6/in6.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the project nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      $KAME: in6.h,v 1.89 2001/05/27 13:28:35 itojun Exp $
  32  */
  33
  34 /*-
  35  * Copyright (c) 1982, 1986, 1990, 1993
  36  *      The Regents of the University of California.  All rights reserved.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  * 1. Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  * 2. Redistributions in binary form must reproduce the above copyright
  44  *    notice, this list of conditions and the following disclaimer in the
  45  *    documentation and/or other materials provided with the distribution.
  46  * 3. Neither the name of the University nor the names of its contributors
  47  *    may be used to endorse or promote products derived from this software
  48  *    without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  53  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  54  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  55  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  56  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  58  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  59  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  60  * SUCH DAMAGE.
  61  */
  62
  63 #ifndef __KAME_NETINET_IN_H_INCLUDED_
  64 #error "do not include netinet6/in6.h directly, include netinet/in.h.  see RFC2553"
  65 #endif
  66
  67 #ifndef _NETINET6_IN6_H_
  68 #define _NETINET6_IN6_H_
  69
  70 /*
  71  * Identification of the network protocol stack
  72  * for *BSD-current/release: http://www.kame.net/dev/cvsweb.cgi/kame/COVERAGE
  73  * has the table of implementation/integration differences.
  74  */
  75 #define __KAME__
  76 #define __KAME_VERSION          "FreeBSD"
  77
  78 /*
  79  * IPv6 port allocation rules should mirror the IPv4 rules and are controlled
  80  * by the net.inet.ip.portrange sysctl tree. The following defines exist
  81  * for compatibility with userland applications that need them.
  82  */
  83 #if __BSD_VISIBLE
  84 #define IPV6PORT_RESERVED       1024
  85 #define IPV6PORT_ANONMIN        49152
  86 #define IPV6PORT_ANONMAX        65535
  87 #define IPV6PORT_RESERVEDMIN    600
  88 #define IPV6PORT_RESERVEDMAX    (IPV6PORT_RESERVED-1)
  89 #endif
  90
  91 /*
  92  * IPv6 address
  93  */
  94 struct in6_addr {
  95         union {
  96                 uint8_t         __u6_addr8[16];
  97                 uint16_t        __u6_addr16[8];
  98                 uint32_t        __u6_addr32[4];
  99         } __u6_addr;                    /* 128-bit IP6 address */
 100 };
 101
 102 #define s6_addr   __u6_addr.__u6_addr8
 103 #if defined(_KERNEL) || defined(_STANDALONE) /* XXX nonstandard */
 104 #define s6_addr8  __u6_addr.__u6_addr8
 105 #define s6_addr16 __u6_addr.__u6_addr16
 106 #define s6_addr32 __u6_addr.__u6_addr32
 107 #endif
 108
 109 #define INET6_ADDRSTRLEN        46
 110
 111 /*
 112  * XXX missing POSIX.1-2001 macro IPPROTO_IPV6.
 113  */
 114
 115 /*
 116  * Socket address for IPv6
 117  */
 118 #if __BSD_VISIBLE
 119 #define SIN6_LEN
 120 #endif
 121
 122 struct sockaddr_in6 {
 123         uint8_t         sin6_len;       /* length of this struct */
 124         sa_family_t     sin6_family;    /* AF_INET6 */
 125         in_port_t       sin6_port;      /* Transport layer port # */
 126         uint32_t        sin6_flowinfo;  /* IP6 flow information */
 127         struct in6_addr sin6_addr;      /* IP6 address */
 128         uint32_t        sin6_scope_id;  /* scope zone index */
 129 };
 130
 131 /*
 132  * Local definition for masks
 133  */
 134 #ifdef _KERNEL  /* XXX nonstandard */
 135 #define IN6MASK0        {{{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }}}
 136 #define IN6MASK32       {{{ 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, \
 137                             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
 138 #define IN6MASK64       {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
 139                             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
 140 #define IN6MASK96       {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
 141                             0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00 }}}
 142 #define IN6MASK128      {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
 143                             0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }}}
 144 #endif
 145
 146 #ifdef _KERNEL
 147 extern const struct sockaddr_in6 sa6_any;
 148
 149 extern const struct in6_addr in6mask0;
 150 extern const struct in6_addr in6mask32;
 151 extern const struct in6_addr in6mask64;
 152 extern const struct in6_addr in6mask96;
 153 extern const struct in6_addr in6mask128;
 154 #endif /* _KERNEL */
 155
 156 /*
 157  * Macros started with IPV6_ADDR is KAME local
 158  */
 159 #ifdef _KERNEL  /* XXX nonstandard */
 160 #if _BYTE_ORDER == _BIG_ENDIAN
 161 #define IPV6_ADDR_INT32_ONE     1
 162 #define IPV6_ADDR_INT32_TWO     2
 163 #define IPV6_ADDR_INT32_MNL     0xff010000
 164 #define IPV6_ADDR_INT32_MLL     0xff020000
 165 #define IPV6_ADDR_INT32_SMP     0x0000ffff
 166 #define IPV6_ADDR_INT16_ULL     0xfe80
 167 #define IPV6_ADDR_INT16_USL     0xfec0
 168 #define IPV6_ADDR_INT16_MLL     0xff02
 169 #elif _BYTE_ORDER == _LITTLE_ENDIAN
 170 #define IPV6_ADDR_INT32_ONE     0x01000000
 171 #define IPV6_ADDR_INT32_TWO     0x02000000
 172 #define IPV6_ADDR_INT32_MNL     0x000001ff
 173 #define IPV6_ADDR_INT32_MLL     0x000002ff
 174 #define IPV6_ADDR_INT32_SMP     0xffff0000
 175 #define IPV6_ADDR_INT16_ULL     0x80fe
 176 #define IPV6_ADDR_INT16_USL     0xc0fe
 177 #define IPV6_ADDR_INT16_MLL     0x02ff
 178 #endif
 179 #endif
 180
 181 /*
 182  * Definition of some useful macros to handle IP6 addresses
 183  */
 184 #if __BSD_VISIBLE
 185 #define IN6ADDR_ANY_INIT \
 186         {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 187             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
 188 #define IN6ADDR_LOOPBACK_INIT \
 189         {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 190             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
 191 #define IN6ADDR_NODELOCAL_ALLNODES_INIT \
 192         {{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 193             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
 194 #define IN6ADDR_INTFACELOCAL_ALLNODES_INIT \
 195         {{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 196             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
 197 #define IN6ADDR_LINKLOCAL_ALLNODES_INIT \
 198         {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 199             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
 200 #define IN6ADDR_LINKLOCAL_ALLROUTERS_INIT \
 201         {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 202             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 }}}
 203 #define IN6ADDR_LINKLOCAL_ALLV2ROUTERS_INIT \
 204         {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 205             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x16 }}}
 206 #endif
 207
 208 extern const struct in6_addr in6addr_any;
 209 extern const struct in6_addr in6addr_loopback;
 210 #if __BSD_VISIBLE
 211 extern const struct in6_addr in6addr_nodelocal_allnodes;
 212 extern const struct in6_addr in6addr_linklocal_allnodes;
 213 extern const struct in6_addr in6addr_linklocal_allrouters;
 214 extern const struct in6_addr in6addr_linklocal_allv2routers;
 215 #endif
 216
 217 /*
 218  * Equality
 219  */
 220 #if __BSD_VISIBLE
 221 #define IN6_ARE_ADDR_EQUAL(a, b)                        \
 222     (memcmp(&(a)->s6_addr[0], &(b)->s6_addr[0], sizeof(struct in6_addr)) == 0)
 223 #endif
 224
 225 /*
 226  * Unspecified
 227  */
 228 #define IN6_IS_ADDR_UNSPECIFIED(a)      \
 229         ((a)->__u6_addr.__u6_addr32[0] == 0 &&  \
 230          (a)->__u6_addr.__u6_addr32[1] == 0 &&  \
 231          (a)->__u6_addr.__u6_addr32[2] == 0 &&  \
 232          (a)->__u6_addr.__u6_addr32[3] == 0)
 233
 234 /*
 235  * Loopback
 236  */
 237 #define IN6_IS_ADDR_LOOPBACK(a)         \
 238         ((a)->__u6_addr.__u6_addr32[0] == 0 &&  \
 239          (a)->__u6_addr.__u6_addr32[1] == 0 &&  \
 240          (a)->__u6_addr.__u6_addr32[2] == 0 &&  \
 241          (a)->__u6_addr.__u6_addr32[3] == ntohl(1))
 242
 243 /*
 244  * IPv4 compatible
 245  */
 246 #define IN6_IS_ADDR_V4COMPAT(a)         \
 247         ((a)->__u6_addr.__u6_addr32[0] == 0 &&  \
 248          (a)->__u6_addr.__u6_addr32[1] == 0 &&  \
 249          (a)->__u6_addr.__u6_addr32[2] == 0 &&  \
 250          (a)->__u6_addr.__u6_addr32[3] != 0 &&  \
 251          (a)->__u6_addr.__u6_addr32[3] != ntohl(1))
 252
 253 /*
 254  * Mapped
 255  */
 256 #define IN6_IS_ADDR_V4MAPPED(a)               \
 257         ((a)->__u6_addr.__u6_addr32[0] == 0 &&  \
 258          (a)->__u6_addr.__u6_addr32[1] == 0 &&  \
 259          (a)->__u6_addr.__u6_addr32[2] == ntohl(0x0000ffff))
 260
 261 /*
 262  * KAME Scope Values
 263  */
 264
 265 #ifdef _KERNEL  /* XXX nonstandard */
 266 #define IPV6_ADDR_SCOPE_NODELOCAL       0x01
 267 #define IPV6_ADDR_SCOPE_INTFACELOCAL    0x01
 268 #define IPV6_ADDR_SCOPE_LINKLOCAL       0x02
 269 #define IPV6_ADDR_SCOPE_SITELOCAL       0x05
 270 #define IPV6_ADDR_SCOPE_ORGLOCAL        0x08    /* just used in this file */
 271 #define IPV6_ADDR_SCOPE_GLOBAL          0x0e
 272 #else
 273 #define __IPV6_ADDR_SCOPE_NODELOCAL     0x01
 274 #define __IPV6_ADDR_SCOPE_INTFACELOCAL  0x01
 275 #define __IPV6_ADDR_SCOPE_LINKLOCAL     0x02
 276 #define __IPV6_ADDR_SCOPE_SITELOCAL     0x05
 277 #define __IPV6_ADDR_SCOPE_ORGLOCAL      0x08    /* just used in this file */
 278 #define __IPV6_ADDR_SCOPE_GLOBAL        0x0e
 279 #endif
 280
 281 /*
 282  * Unicast Scope
 283  * Note that we must check topmost 10 bits only, not 16 bits (see RFC2373).
 284  */
 285 #define IN6_IS_ADDR_LINKLOCAL(a)        \
 286         (((a)->s6_addr[0] == 0xfe) && (((a)->s6_addr[1] & 0xc0) == 0x80))
 287 #define IN6_IS_ADDR_SITELOCAL(a)        \
 288         (((a)->s6_addr[0] == 0xfe) && (((a)->s6_addr[1] & 0xc0) == 0xc0))
 289
 290 /*
 291  * Multicast
 292  */
 293 #define IN6_IS_ADDR_MULTICAST(a)        ((a)->s6_addr[0] == 0xff)
 294
 295 #ifdef _KERNEL  /* XXX nonstandard */
 296 #define IPV6_ADDR_MC_SCOPE(a)           ((a)->s6_addr[1] & 0x0f)
 297 #else
 298 #define __IPV6_ADDR_MC_SCOPE(a)         ((a)->s6_addr[1] & 0x0f)
 299 #endif
 300
 301 /*
 302  * Multicast Scope
 303  */
 304 #ifdef _KERNEL  /* refers nonstandard items */
 305 #define IN6_IS_ADDR_MC_NODELOCAL(a)     \
 306         (IN6_IS_ADDR_MULTICAST(a) &&    \
 307          (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_NODELOCAL))
 308 #define IN6_IS_ADDR_MC_INTFACELOCAL(a)  \
 309         (IN6_IS_ADDR_MULTICAST(a) &&    \
 310          (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_INTFACELOCAL))
 311 #define IN6_IS_ADDR_MC_LINKLOCAL(a)     \
 312         (IN6_IS_ADDR_MULTICAST(a) &&    \
 313          (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_LINKLOCAL))
 314 #define IN6_IS_ADDR_MC_SITELOCAL(a)     \
 315         (IN6_IS_ADDR_MULTICAST(a) &&    \
 316          (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_SITELOCAL))
 317 #define IN6_IS_ADDR_MC_ORGLOCAL(a)      \
 318         (IN6_IS_ADDR_MULTICAST(a) &&    \
 319          (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_ORGLOCAL))
 320 #define IN6_IS_ADDR_MC_GLOBAL(a)        \
 321         (IN6_IS_ADDR_MULTICAST(a) &&    \
 322          (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_GLOBAL))
 323 #else
 324 #define IN6_IS_ADDR_MC_NODELOCAL(a)     \
 325         (IN6_IS_ADDR_MULTICAST(a) &&    \
 326          (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_NODELOCAL))
 327 #define IN6_IS_ADDR_MC_LINKLOCAL(a)     \
 328         (IN6_IS_ADDR_MULTICAST(a) &&    \
 329          (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_LINKLOCAL))
 330 #define IN6_IS_ADDR_MC_SITELOCAL(a)     \
 331         (IN6_IS_ADDR_MULTICAST(a) &&    \
 332          (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_SITELOCAL))
 333 #define IN6_IS_ADDR_MC_ORGLOCAL(a)      \
 334         (IN6_IS_ADDR_MULTICAST(a) &&    \
 335          (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_ORGLOCAL))
 336 #define IN6_IS_ADDR_MC_GLOBAL(a)        \
 337         (IN6_IS_ADDR_MULTICAST(a) &&    \
 338          (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_GLOBAL))
 339 #endif
 340
 341 #ifdef _KERNEL  /* nonstandard */
 342 /*
 343  * KAME Scope
 344  */
 345 #define IN6_IS_SCOPE_LINKLOCAL(a)       \
 346         ((IN6_IS_ADDR_LINKLOCAL(a)) ||  \
 347          (IN6_IS_ADDR_MC_LINKLOCAL(a)))
 348 #define IN6_IS_SCOPE_EMBED(a)                   \
 349         ((IN6_IS_ADDR_LINKLOCAL(a)) ||          \
 350          (IN6_IS_ADDR_MC_LINKLOCAL(a)) ||       \
 351          (IN6_IS_ADDR_MC_INTFACELOCAL(a)))
 352
 353 #define IFA6_IS_DEPRECATED(a) \
 354         ((a)->ia6_lifetime.ia6t_pltime != ND6_INFINITE_LIFETIME && \
 355          (u_int32_t)((time_uptime - (a)->ia6_updatetime)) > \
 356          (a)->ia6_lifetime.ia6t_pltime)
 357 #define IFA6_IS_INVALID(a) \
 358         ((a)->ia6_lifetime.ia6t_vltime != ND6_INFINITE_LIFETIME && \
 359          (u_int32_t)((time_uptime - (a)->ia6_updatetime)) > \
 360          (a)->ia6_lifetime.ia6t_vltime)
 361 #endif /* _KERNEL */
 362
 363 /*
 364  * IP6 route structure
 365  */
 366 #if __BSD_VISIBLE
 367 struct nhop_object;
 368 struct route_in6 {
 369         struct nhop_object *ro_nh;
 370         struct  llentry *ro_lle;
 371         /*
 372          * ro_prepend and ro_plen are only used for bpf to pass in a
 373          * preformed header.  They are not cacheable.
 374          */
 375         char            *ro_prepend;
 376         uint16_t        ro_plen;
 377         uint16_t        ro_flags;
 378         uint16_t        ro_mtu; /* saved ro_rt mtu */
 379         uint16_t        spare;
 380         struct  sockaddr_in6 ro_dst;
 381 };
 382 #endif
 383
 384 #ifdef _KERNEL
 385 #define MTAG_ABI_IPV6           1444287380      /* IPv6 ABI */
 386 #define IPV6_TAG_DIRECT         0               /* direct-dispatch IPv6 */
 387 #endif /* _KERNEL */
 388
 389 /*
 390  * Options for use with [gs]etsockopt at the IPV6 level.
 391  * First word of comment is data type; bool is stored in int.
 392  */
 393 /* no hdrincl */
 394 #if 0 /* the followings are relic in IPv4 and hence are disabled */
 395 #define IPV6_OPTIONS            1  /* buf/ip6_opts; set/get IP6 options */
 396 #define IPV6_RECVOPTS           5  /* bool; receive all IP6 opts w/dgram */
 397 #define IPV6_RECVRETOPTS        6  /* bool; receive IP6 opts for response */
 398 #define IPV6_RECVDSTADDR        7  /* bool; receive IP6 dst addr w/dgram */
 399 #define IPV6_RETOPTS            8  /* ip6_opts; set/get IP6 options */
 400 #endif
 401 #define IPV6_SOCKOPT_RESERVED1  3  /* reserved for future use */
 402 #define IPV6_UNICAST_HOPS       4  /* int; IP6 hops */
 403 #define IPV6_MULTICAST_IF       9  /* u_int; set/get IP6 multicast i/f  */
 404 #define IPV6_MULTICAST_HOPS     10 /* int; set/get IP6 multicast hops */
 405 #define IPV6_MULTICAST_LOOP     11 /* u_int; set/get IP6 multicast loopback */
 406 #define IPV6_JOIN_GROUP         12 /* ipv6_mreq; join a group membership */
 407 #define IPV6_LEAVE_GROUP        13 /* ipv6_mreq; leave a group membership */
 408 #define IPV6_PORTRANGE          14 /* int; range to choose for unspec port */
 409 #define ICMP6_FILTER            18 /* icmp6_filter; icmp6 filter */
 410 /* RFC2292 options */
 411 #ifdef _KERNEL
 412 #define IPV6_2292PKTINFO        19 /* bool; send/recv if, src/dst addr */
 413 #define IPV6_2292HOPLIMIT       20 /* bool; hop limit */
 414 #define IPV6_2292NEXTHOP        21 /* bool; next hop addr */
 415 #define IPV6_2292HOPOPTS        22 /* bool; hop-by-hop option */
 416 #define IPV6_2292DSTOPTS        23 /* bool; destinaion option */
 417 #define IPV6_2292RTHDR          24 /* bool; routing header */
 418 #define IPV6_2292PKTOPTIONS     25 /* buf/cmsghdr; set/get IPv6 options */
 419 #endif
 420
 421 #define IPV6_CHECKSUM           26 /* int; checksum offset for raw socket */
 422 #define IPV6_V6ONLY             27 /* bool; make AF_INET6 sockets v6 only */
 423 #ifndef _KERNEL
 424 #define IPV6_BINDV6ONLY         IPV6_V6ONLY
 425 #endif
 426
 427 #define IPV6_IPSEC_POLICY       28 /* struct; get/set security policy */
 428                                    /* 29; unused; was IPV6_FAITH */
 429 #if 1 /* IPV6FIREWALL */
 430 #define IPV6_FW_ADD             30 /* add a firewall rule to chain */
 431 #define IPV6_FW_DEL             31 /* delete a firewall rule from chain */
 432 #define IPV6_FW_FLUSH           32 /* flush firewall rule chain */
 433 #define IPV6_FW_ZERO            33 /* clear single/all firewall counter(s) */
 434 #define IPV6_FW_GET             34 /* get entire firewall rule chain */
 435 #endif
 436
 437 /* new socket options introduced in RFC3542 */
 438 #define IPV6_RTHDRDSTOPTS       35 /* ip6_dest; send dst option before rthdr */
 439
 440 #define IPV6_RECVPKTINFO        36 /* bool; recv if, dst addr */
 441 #define IPV6_RECVHOPLIMIT       37 /* bool; recv hop limit */
 442 #define IPV6_RECVRTHDR          38 /* bool; recv routing header */
 443 #define IPV6_RECVHOPOPTS        39 /* bool; recv hop-by-hop option */
 444 #define IPV6_RECVDSTOPTS        40 /* bool; recv dst option after rthdr */
 445 #ifdef _KERNEL
 446 #define IPV6_RECVRTHDRDSTOPTS   41 /* bool; recv dst option before rthdr */
 447 #endif
 448
 449 #define IPV6_USE_MIN_MTU        42 /* bool; send packets at the minimum MTU */
 450 #define IPV6_RECVPATHMTU        43 /* bool; notify an according MTU */
 451
 452 #define IPV6_PATHMTU            44 /* mtuinfo; get the current path MTU (sopt),
 453                                       4 bytes int; MTU notification (cmsg) */
 454 #if 0 /*obsoleted during 2292bis -> 3542*/
 455 #define IPV6_REACHCONF          45 /* no data; ND reachability confirm
 456                                       (cmsg only/not in of RFC3542) */
 457 #endif
 458
 459 /* more new socket options introduced in RFC3542 */
 460 #define IPV6_PKTINFO            46 /* in6_pktinfo; send if, src addr */
 461 #define IPV6_HOPLIMIT           47 /* int; send hop limit */
 462 #define IPV6_NEXTHOP            48 /* sockaddr; next hop addr */
 463 #define IPV6_HOPOPTS            49 /* ip6_hbh; send hop-by-hop option */
 464 #define IPV6_DSTOPTS            50 /* ip6_dest; send dst option befor rthdr */
 465 #define IPV6_RTHDR              51 /* ip6_rthdr; send routing header */
 466 #if 0
 467 #define IPV6_PKTOPTIONS         52 /* buf/cmsghdr; set/get IPv6 options */
 468                                    /* obsoleted by RFC3542 */
 469 #endif
 470
 471 #define IPV6_RECVTCLASS         57 /* bool; recv traffic class values */
 472
 473 #define IPV6_AUTOFLOWLABEL      59 /* bool; attach flowlabel automagically */
 474
 475 #define IPV6_TCLASS             61 /* int; send traffic class value */
 476 #define IPV6_DONTFRAG           62 /* bool; disable IPv6 fragmentation */
 477
 478 #define IPV6_PREFER_TEMPADDR    63 /* int; prefer temporary addresses as
 479                                     * the source address.
 480                                     */
 481
 482 #define IPV6_BINDANY            64 /* bool: allow bind to any address */
 483                                    /* unused; was IPV6_BIND_MULTI */
 484                                    /* unused; was IPV6_RSS_LISTEN_BUCKET */
 485 #define IPV6_FLOWID             67 /* int; flowid of given socket */
 486 #define IPV6_FLOWTYPE           68 /* int; flowtype of given socket */
 487 #define IPV6_RSSBUCKETID        69 /* int; RSS bucket ID of given socket */
 488 #define IPV6_RECVFLOWID         70 /* bool; receive IP6 flowid/flowtype w/ datagram */
 489 #define IPV6_RECVRSSBUCKETID    71 /* bool; receive IP6 RSS bucket id w/ datagram */
 490
 491 #define IPV6_ORIGDSTADDR        72 /* bool: allow getting dstaddr /port info */
 492 #define IPV6_RECVORIGDSTADDR    IPV6_ORIGDSTADDR
 493
 494 /*
 495  * The following option is private; do not use it from user applications.
 496  * It is deliberately defined to the same value as IP_MSFILTER.
 497  */
 498 #define IPV6_MSFILTER           74 /* struct __msfilterreq;
 499                                     * set/get multicast source filter list.
 500                                     */
 501
 502 /* The following option deals with the 802.1Q Ethernet Priority Code Point */
 503 #define IPV6_VLAN_PCP           75  /* int; set/get PCP used for packet, */
 504                                     /*      -1 use interface default */
 505
 506 /* to define items, should talk with KAME guys first, for *BSD compatibility */
 507
 508 #define IPV6_RTHDR_LOOSE     0 /* this hop need not be a neighbor. XXX old spec */
 509 #define IPV6_RTHDR_STRICT    1 /* this hop must be a neighbor. XXX old spec */
 510 #define IPV6_RTHDR_TYPE_0    0 /* IPv6 routing header type 0 */
 511
 512 /*
 513  * Defaults and limits for options
 514  */
 515 #define IPV6_DEFAULT_MULTICAST_HOPS 1   /* normally limit m'casts to 1 hop */
 516 #define IPV6_DEFAULT_MULTICAST_LOOP 1   /* normally hear sends if a member */
 517
 518 /*
 519  * Limit for IPv6 multicast memberships
 520  */
 521 #define IPV6_MAX_MEMBERSHIPS    4095
 522
 523 /*
 524  * Default resource limits for IPv6 multicast source filtering.
 525  * These may be modified by sysctl.
 526  */
 527 #define IPV6_MAX_GROUP_SRC_FILTER       512     /* sources per group */
 528 #define IPV6_MAX_SOCK_SRC_FILTER        128     /* sources per socket/group */
 529
 530 /*
 531  * Argument structure for IPV6_JOIN_GROUP and IPV6_LEAVE_GROUP.
 532  */
 533 struct ipv6_mreq {
 534         struct in6_addr ipv6mr_multiaddr;
 535         unsigned int    ipv6mr_interface;
 536 };
 537
 538 /*
 539  * IPV6_PKTINFO: Packet information(RFC2292 sec 5)
 540  */
 541 struct in6_pktinfo {
 542         struct in6_addr ipi6_addr;      /* src/dst IPv6 address */
 543         unsigned int    ipi6_ifindex;   /* send/recv interface index */
 544 };
 545
 546 /*
 547  * Control structure for IPV6_RECVPATHMTU socket option.
 548  */
 549 struct ip6_mtuinfo {
 550         struct sockaddr_in6 ip6m_addr;  /* or sockaddr_storage? */
 551         uint32_t ip6m_mtu;
 552 };
 553
 554 /*
 555  * Argument for IPV6_PORTRANGE:
 556  * - which range to search when port is unspecified at bind() or connect()
 557  */
 558 #define IPV6_PORTRANGE_DEFAULT  0       /* default range */
 559 #define IPV6_PORTRANGE_HIGH     1       /* "high" - request firewall bypass */
 560 #define IPV6_PORTRANGE_LOW      2       /* "low" - vouchsafe security */
 561
 562 #if __BSD_VISIBLE
 563 /*
 564  * Definitions for inet6 sysctl operations.
 565  *
 566  * Third level is protocol number.
 567  * Fourth level is desired variable within that protocol.
 568  */
 569 #define IPV6PROTO_MAXID (IPPROTO_PIM + 1)       /* don't list to IPV6PROTO_MAX */
 570
 571 /*
 572  * Names for IP sysctl objects
 573  */
 574 #define IPV6CTL_FORWARDING      1       /* act as router */
 575 #define IPV6CTL_SENDREDIRECTS   2       /* may send redirects when forwarding*/
 576 #define IPV6CTL_DEFHLIM         3       /* default Hop-Limit */
 577 #ifdef notyet
 578 #define IPV6CTL_DEFMTU          4       /* default MTU */
 579 #endif
 580 #define IPV6CTL_FORWSRCRT       5       /* forward source-routed dgrams */
 581 #define IPV6CTL_STATS           6       /* stats */
 582 #define IPV6CTL_MRTSTATS        7       /* multicast forwarding stats */
 583 #define IPV6CTL_MRTPROTO        8       /* multicast routing protocol */
 584 #define IPV6CTL_MAXFRAGPACKETS  9       /* max packets reassembly queue */
 585 #define IPV6CTL_SOURCECHECK     10      /* verify source route and intf */
 586 #define IPV6CTL_SOURCECHECK_LOGINT 11   /* minimume logging interval */
 587 #define IPV6CTL_ACCEPT_RTADV    12
 588                                         /* 13; unused; was: IPV6CTL_KEEPFAITH */
 589 #define IPV6CTL_LOG_INTERVAL    14
 590 #define IPV6CTL_HDRNESTLIMIT    15
 591 #define IPV6CTL_DAD_COUNT       16
 592 #define IPV6CTL_AUTO_FLOWLABEL  17
 593 #define IPV6CTL_DEFMCASTHLIM    18
 594 #define IPV6CTL_GIF_HLIM        19      /* default HLIM for gif encap packet */
 595 #define IPV6CTL_KAME_VERSION    20
 596 #define IPV6CTL_USE_DEPRECATED  21      /* use deprecated addr (RFC2462 5.5.4) */
 597 #define IPV6CTL_RR_PRUNE        22      /* walk timer for router renumbering */
 598 #if 0   /* obsolete */
 599 #define IPV6CTL_MAPPED_ADDR     23
 600 #endif
 601 #define IPV6CTL_V6ONLY          24
 602 /*      IPV6CTL_RTEXPIRE        25      deprecated */
 603 /*      IPV6CTL_RTMINEXPIRE     26      deprecated */
 604 /*      IPV6CTL_RTMAXCACHE      27      deprecated */
 605
 606 #define IPV6CTL_USETEMPADDR     32      /* use temporary addresses (RFC3041) */
 607 #define IPV6CTL_TEMPPLTIME      33      /* preferred lifetime for tmpaddrs */
 608 #define IPV6CTL_TEMPVLTIME      34      /* valid lifetime for tmpaddrs */
 609 #define IPV6CTL_AUTO_LINKLOCAL  35      /* automatic link-local addr assign */
 610 #define IPV6CTL_RIP6STATS       36      /* raw_ip6 stats */
 611 #define IPV6CTL_PREFER_TEMPADDR 37      /* prefer temporary addr as src */
 612 #define IPV6CTL_ADDRCTLPOLICY   38      /* get/set address selection policy */
 613 #define IPV6CTL_USE_DEFAULTZONE 39      /* use default scope zone */
 614
 615 #define IPV6CTL_MAXFRAGS        41      /* max fragments */
 616 #if 0
 617 #define IPV6CTL_IFQ             42      /* ip6intrq node */
 618 #define IPV6CTL_ISATAPRTR       43      /* isatap router */
 619 #endif
 620 #define IPV6CTL_MCAST_PMTU      44      /* enable pMTU discovery for multicast? */
 621
 622 /* New entries should be added here from current IPV6CTL_MAXID value. */
 623 /* to define items, should talk with KAME guys first, for *BSD compatibility */
 624 #define IPV6CTL_STEALTH         45
 625
 626 #define ICMPV6CTL_ND6_ONLINKNSRFC4861   47
 627 #define IPV6CTL_NO_RADR         48      /* No defroute from RA */
 628 #define IPV6CTL_NORBIT_RAIF     49      /* Disable R-bit in NA on RA
 629                                          * receiving IF. */
 630 #define IPV6CTL_RFC6204W3       50      /* Accept defroute even when forwarding
 631                                            enabled */
 632 #define IPV6CTL_INTRQMAXLEN     51      /* max length of IPv6 netisr queue */
 633 #define IPV6CTL_INTRDQMAXLEN    52      /* max length of direct IPv6 netisr
 634                                          * queue */
 635 #define IPV6CTL_MAXFRAGSPERPACKET       53 /* Max fragments per packet */
 636 #define IPV6CTL_MAXFRAGBUCKETSIZE       54 /* Max reassembly queues per bucket */
 637 #define IPV6CTL_MAXID           55
 638 #endif /* __BSD_VISIBLE */
 639
 640 /*
 641  * Since both netinet/ and netinet6/ call into netipsec/ and netpfil/,
 642  * the protocol specific mbuf flags are shared between them.
 643  */
 644 #define M_FASTFWD_OURS          M_PROTO1        /* changed dst to local */
 645 #define M_IP6_NEXTHOP           M_PROTO2        /* explicit ip nexthop */
 646 #define M_IP_NEXTHOP            M_PROTO2        /* explicit ip nexthop */
 647 #define M_SKIP_FIREWALL         M_PROTO3        /* skip firewall processing */
 648 #define M_AUTHIPHDR             M_PROTO4
 649 #define M_DECRYPTED             M_PROTO5
 650 #define M_LOOP                  M_PROTO6
 651 #define M_AUTHIPDGM             M_PROTO7
 652 #define M_RTALERT_MLD           M_PROTO8
 653 #define M_FRAGMENTED            M_PROTO9        /* contained fragment header */
 654
 655 #ifdef _KERNEL
 656 struct cmsghdr;
 657 struct ip6_hdr;
 658
 659 int     in6_cksum(struct mbuf *, uint8_t, uint32_t, uint32_t);
 660 int     in6_cksum_partial(struct mbuf *, uint8_t, uint32_t, uint32_t, uint32_t);
 661 int     in6_cksum_pseudo(struct ip6_hdr *, uint32_t, uint8_t, uint16_t);
 662
 663 int     in6_localaddr(struct in6_addr *);
 664 int     in6_localip(struct in6_addr *);
 665 bool    in6_localip_fib(struct in6_addr *, uint16_t);
 666 int     in6_ifhasaddr(struct ifnet *, struct in6_addr *);
 667 int     in6_addrscope(const struct in6_addr *);
 668 char    *ip6_sprintf(char *, const struct in6_addr *);
 669 struct  in6_ifaddr *in6_ifawithifp(struct ifnet *, struct in6_addr *);
 670 extern void in6_if_up(struct ifnet *);
 671 struct sockaddr;
 672
 673 void    in6_sin6_2_sin(struct sockaddr_in *sin,
 674                             struct sockaddr_in6 *sin6);
 675 void    in6_sin_2_v4mapsin6(struct sockaddr_in *sin,
 676                                  struct sockaddr_in6 *sin6);
 677 void    in6_sin6_2_sin_in_sock(struct sockaddr *nam);
 678 extern void addrsel_policy_init(void);
 679
 680 #define satosin6(sa)    ((struct sockaddr_in6 *)(sa))
 681 #define sin6tosa(sin6)  ((struct sockaddr *)(sin6))
 682 #define ifatoia6(ifa)   ((struct in6_ifaddr *)(ifa))
 683
 684 #endif /* _KERNEL */
 685
 686 #ifndef _SIZE_T_DECLARED
 687 typedef __size_t        size_t;
 688 #define _SIZE_T_DECLARED
 689 #endif
 690
 691 #ifndef _SOCKLEN_T_DECLARED
 692 typedef __socklen_t     socklen_t;
 693 #define _SOCKLEN_T_DECLARED
 694 #endif
 695
 696 #if __BSD_VISIBLE
 697
 698 __BEGIN_DECLS
 699 struct cmsghdr;
 700
 701 extern int inet6_option_space(int);
 702 extern int inet6_option_init(void *, struct cmsghdr **, int);
 703 extern int inet6_option_append(struct cmsghdr *, const uint8_t *,
 704         int, int);
 705 extern uint8_t *inet6_option_alloc(struct cmsghdr *, int, int, int);
 706 extern int inet6_option_next(const struct cmsghdr *, uint8_t **);
 707 extern int inet6_option_find(const struct cmsghdr *, uint8_t **, int);
 708
 709 extern size_t inet6_rthdr_space(int, int);
 710 extern struct cmsghdr *inet6_rthdr_init(void *, int);
 711 extern int inet6_rthdr_add(struct cmsghdr *, const struct in6_addr *,
 712         unsigned int);
 713 extern int inet6_rthdr_lasthop(struct cmsghdr *, unsigned int);
 714 #if 0 /* not implemented yet */
 715 extern int inet6_rthdr_reverse(const struct cmsghdr *, struct cmsghdr *);
 716 #endif
 717 extern int inet6_rthdr_segments(const struct cmsghdr *);
 718 extern struct in6_addr *inet6_rthdr_getaddr(struct cmsghdr *, int);
 719 extern int inet6_rthdr_getflags(const struct cmsghdr *, int);
 720
 721 extern int inet6_opt_init(void *, socklen_t);
 722 extern int inet6_opt_append(void *, socklen_t, int, uint8_t, socklen_t,
 723         uint8_t, void **);
 724 extern int inet6_opt_finish(void *, socklen_t, int);
 725 extern int inet6_opt_set_val(void *, int, void *, socklen_t);
 726
 727 extern int inet6_opt_next(void *, socklen_t, int, uint8_t *, socklen_t *,
 728         void **);
 729 extern int inet6_opt_find(void *, socklen_t, int, uint8_t, socklen_t *,
 730         void **);
 731 extern int inet6_opt_get_val(void *, int, void *, socklen_t);
 732 extern socklen_t inet6_rth_space(int, int);
 733 extern void *inet6_rth_init(void *, socklen_t, int, int);
 734 extern int inet6_rth_add(void *, const struct in6_addr *);
 735 extern int inet6_rth_reverse(const void *, void *);
 736 extern int inet6_rth_segments(const void *);
 737 extern struct in6_addr *inet6_rth_getaddr(const void *, int);
 738 __END_DECLS
 739
 740 #endif /* __BSD_VISIBLE */
 741
 742 #endif /* !_NETINET6_IN6_H_ */