bsd/netinet6/in6.h

   1 /*
   2  * Copyright (c) 2008-2020 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 /*
  30  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
  31  * All rights reserved.
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions
  35  * are met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. Neither the name of the project nor the names of its contributors
  42  *    may be used to endorse or promote products derived from this software
  43  *    without specific prior written permission.
  44  *
  45  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  48  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  49  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  55  * SUCH DAMAGE.
  56  */
  57
  58 /*
  59  * Copyright (c) 1982, 1986, 1990, 1993
  60  *      The Regents of the University of California.  All rights reserved.
  61  *
  62  * Redistribution and use in source and binary forms, with or without
  63  * modification, are permitted provided that the following conditions
  64  * are met:
  65  * 1. Redistributions of source code must retain the above copyright
  66  *    notice, this list of conditions and the following disclaimer.
  67  * 2. Redistributions in binary form must reproduce the above copyright
  68  *    notice, this list of conditions and the following disclaimer in the
  69  *    documentation and/or other materials provided with the distribution.
  70  * 3. All advertising materials mentioning features or use of this software
  71  *    must display the following acknowledgement:
  72  *      This product includes software developed by the University of
  73  *      California, Berkeley and its contributors.
  74  * 4. Neither the name of the University nor the names of its contributors
  75  *    may be used to endorse or promote products derived from this software
  76  *    without specific prior written permission.
  77  *
  78  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  79  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  80  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  81  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  82  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  83  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  84  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  85  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  86  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  87  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  88  * SUCH DAMAGE.
  89  *
  90  *      @(#)in.h        8.3 (Berkeley) 1/3/94
  91  */
  92
  93 #ifndef DRIVERKIT
  94 #ifndef __KAME_NETINET_IN_H_INCLUDED_
  95 #error "do not include netinet6/in6.h directly, include netinet/in.h. " \
  96         " see RFC2553"
  97 #endif
  98 #endif /* DRIVERKIT */
  99
 100 #ifndef _NETINET6_IN6_H_
 101 #define _NETINET6_IN6_H_
 102 #ifndef DRIVERKIT
 103 #include <sys/appleapiopts.h>
 104 #else
 105 #include <sys/_types/_in_port_t.h>
 106 #endif /* DRIVERKIT */
 107
 108 #include <sys/_types.h>
 109 #include <sys/_types/_sa_family_t.h>
 110
 111 /*
 112  * Identification of the network protocol stack
 113  * for *BSD-current/release: http://www.kame.net/dev/cvsweb.cgi/kame/COVERAGE
 114  * has the table of implementation/integration differences.
 115  */
 116 #define __KAME__
 117 #define __KAME_VERSION          "2009/apple-darwin"
 118
 119 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 120 /*
 121  * Local port number conventions:
 122  *
 123  * Ports < IPPORT_RESERVED are reserved for privileged processes (e.g. root),
 124  * unless a kernel is compiled with IPNOPRIVPORTS defined.
 125  *
 126  * When a user does a bind(2) or connect(2) with a port number of zero,
 127  * a non-conflicting local port address is chosen.
 128  *
 129  * The default range is IPPORT_ANONMIN to IPPORT_ANONMAX, although
 130  * that is settable by sysctl(3); net.inet.ip.anonportmin and
 131  * net.inet.ip.anonportmax respectively.
 132  *
 133  * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
 134  * default assignment range.
 135  *
 136  * The value IP_PORTRANGE_DEFAULT causes the default behavior.
 137  *
 138  * The value IP_PORTRANGE_HIGH is the same as IP_PORTRANGE_DEFAULT,
 139  * and exists only for FreeBSD compatibility purposes.
 140  *
 141  * The value IP_PORTRANGE_LOW changes the range to the "low" are
 142  * that is (by convention) restricted to privileged processes.
 143  * This convention is based on "vouchsafe" principles only.
 144  * It is only secure if you trust the remote host to restrict these ports.
 145  * The range is IPPORT_RESERVEDMIN to IPPORT_RESERVEDMAX.
 146  */
 147
 148 #define IPV6PORT_RESERVED       1024
 149 #define IPV6PORT_ANONMIN        49152
 150 #define IPV6PORT_ANONMAX        65535
 151 #define IPV6PORT_RESERVEDMIN    600
 152 #define IPV6PORT_RESERVEDMAX    (IPV6PORT_RESERVED-1)
 153 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 154
 155 /*
 156  * IPv6 address
 157  */
 158 typedef struct in6_addr {
 159         union {
 160                 __uint8_t   __u6_addr8[16];
 161                 __uint16_t  __u6_addr16[8];
 162                 __uint32_t  __u6_addr32[4];
 163         } __u6_addr;                    /* 128-bit IP6 address */
 164 } in6_addr_t;
 165
 166 #define s6_addr   __u6_addr.__u6_addr8
 167 #ifdef KERNEL   /* XXX nonstandard */
 168 #define s6_addr8  __u6_addr.__u6_addr8
 169 #define s6_addr16 __u6_addr.__u6_addr16
 170 #define s6_addr32 __u6_addr.__u6_addr32
 171 #endif
 172
 173 #define INET6_ADDRSTRLEN        46
 174
 175 /*
 176  * Socket address for IPv6
 177  */
 178 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 179 #define SIN6_LEN
 180 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 181 struct sockaddr_in6 {
 182         __uint8_t       sin6_len;       /* length of this struct(sa_family_t) */
 183         sa_family_t     sin6_family;    /* AF_INET6 (sa_family_t) */
 184         in_port_t       sin6_port;      /* Transport layer port # (in_port_t) */
 185         __uint32_t      sin6_flowinfo;  /* IP6 flow information */
 186         struct in6_addr sin6_addr;      /* IP6 address */
 187         __uint32_t      sin6_scope_id;  /* scope zone index */
 188 };
 189
 190 #ifdef KERNEL   /* XXX nonstandard */
 191 /*
 192  * Local definition for masks
 193  */
 194 #define IN6MASK0        {{{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }}}
 195 #define IN6MASK7        {{{ 0xfe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 196                             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
 197 #define IN6MASK8        {{{ 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 198                             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
 199 #define IN6MASK16       {{{ 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 200                             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
 201 #define IN6MASK32       {{{ 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, \
 202                             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
 203 #define IN6MASK64       {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
 204                             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
 205 #define IN6MASK96       {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
 206                             0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00 }}}
 207 #define IN6MASK128      {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
 208                             0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }}}
 209 #endif
 210
 211 #ifndef PLATFORM_DriverKit
 212
 213 #ifdef KERNEL_PRIVATE
 214 extern const struct sockaddr_in6 sa6_any;
 215
 216 extern const struct in6_addr in6mask0;
 217 extern const struct in6_addr in6mask7;
 218 extern const struct in6_addr in6mask16;
 219 extern const struct in6_addr in6mask32;
 220 extern const struct in6_addr in6mask64;
 221 extern const struct in6_addr in6mask96;
 222 extern const struct in6_addr in6mask128;
 223
 224 #define SIN6(s)         ((struct sockaddr_in6 *)(void *)s)
 225 #define satosin6(sa)    SIN6(sa)
 226 #define sin6tosa(sin6)  ((struct sockaddr *)(void *)(sin6))
 227 #define SIN6IFSCOPE(s)  SIN6(s)
 228 #endif /* KERNEL_PRIVATE */
 229
 230 #ifdef KERNEL   /* XXX nonstandard */
 231 /*
 232  * Macros started with IPV6_ADDR is KAME local
 233  */
 234 #if BYTE_ORDER == BIG_ENDIAN
 235 #define IPV6_ADDR_INT32_ONE     1
 236 #define IPV6_ADDR_INT32_TWO     2
 237 #define IPV6_ADDR_INT32_MNL     0xff010000
 238 #define IPV6_ADDR_INT32_MLL     0xff020000
 239 #define IPV6_ADDR_INT32_SMP     0x0000ffff
 240 #define IPV6_ADDR_INT16_ULL     0xfe80
 241 #define IPV6_ADDR_INT16_USL     0xfec0
 242 #define IPV6_ADDR_INT16_MLL     0xff02
 243 #elif BYTE_ORDER == LITTLE_ENDIAN
 244 #define IPV6_ADDR_INT32_ONE     0x01000000
 245 #define IPV6_ADDR_INT32_TWO     0x02000000
 246 #define IPV6_ADDR_INT32_MNL     0x000001ff
 247 #define IPV6_ADDR_INT32_MLL     0x000002ff
 248 #define IPV6_ADDR_INT32_SMP     0xffff0000
 249 #define IPV6_ADDR_INT16_ULL     0x80fe
 250 #define IPV6_ADDR_INT16_USL     0xc0fe
 251 #define IPV6_ADDR_INT16_MLL     0x02ff
 252 #endif
 253 #endif
 254
 255 /*
 256  * Definition of some useful macros to handle IP6 addresses
 257  */
 258 #define IN6ADDR_ANY_INIT \
 259         {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 260             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
 261 #define IN6ADDR_LOOPBACK_INIT \
 262         {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 263             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
 264 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 265 #define IN6ADDR_NODELOCAL_ALLNODES_INIT \
 266         {{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 267             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
 268 #define IN6ADDR_INTFACELOCAL_ALLNODES_INIT \
 269         {{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 270             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
 271 #define IN6ADDR_LINKLOCAL_ALLNODES_INIT \
 272         {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 273             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
 274 #define IN6ADDR_LINKLOCAL_ALLROUTERS_INIT \
 275         {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 276             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 }}}
 277 #define IN6ADDR_LINKLOCAL_ALLV2ROUTERS_INIT \
 278         {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 279             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x16 }}}
 280 #define IN6ADDR_V4MAPPED_INIT \
 281         {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
 282             0x00, 0x00, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00 }}}
 283 #define IN6ADDR_MULTICAST_PREFIX        IN6MASK8
 284 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 285
 286 extern const struct in6_addr in6addr_any;
 287 extern const struct in6_addr in6addr_loopback;
 288 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 289 extern const struct in6_addr in6addr_nodelocal_allnodes;
 290 extern const struct in6_addr in6addr_linklocal_allnodes;
 291 extern const struct in6_addr in6addr_linklocal_allrouters;
 292 extern const struct in6_addr in6addr_linklocal_allv2routers;
 293 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 294
 295 /*
 296  * Equality
 297  * NOTE: Some of kernel programming environment (for example, openbsd/sparc)
 298  * does not supply memcmp().  For userland memcmp() is preferred as it is
 299  * in ANSI standard.
 300  */
 301 #ifdef KERNEL
 302 #define IN6_ARE_ADDR_EQUAL(a, b) \
 303         (bcmp(&(a)->s6_addr[0], &(b)->s6_addr[0], \
 304         sizeof (struct in6_addr)) == 0)
 305 #else
 306 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 307 #define IN6_ARE_ADDR_EQUAL(a, b) \
 308         (memcmp(&(a)->s6_addr[0], &(b)->s6_addr[0], sizeof (struct in6_addr)) \
 309         == 0)
 310 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 311 #endif
 312
 313 #ifdef KERNEL                   /* non standard */
 314 /* see if two addresses are equal in a scope-conscious manner. */
 315 #define SA6_ARE_ADDR_EQUAL(a, b) \
 316         (((a)->sin6_scope_id == 0 || (b)->sin6_scope_id == 0 || \
 317         ((a)->sin6_scope_id == (b)->sin6_scope_id)) && \
 318         (bcmp(&(a)->sin6_addr, &(b)->sin6_addr, sizeof (struct in6_addr)) == 0))
 319 #endif
 320
 321 /*
 322  * Unspecified
 323  */
 324 #define IN6_IS_ADDR_UNSPECIFIED(a)      \
 325         ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
 326         (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
 327         (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == 0) && \
 328         (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) == 0))
 329
 330 /*
 331  * Loopback
 332  */
 333 #define IN6_IS_ADDR_LOOPBACK(a)         \
 334         ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
 335         (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
 336         (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == 0) && \
 337         (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) == ntohl(1)))
 338
 339 /*
 340  * IPv4 compatible
 341  */
 342 #define IN6_IS_ADDR_V4COMPAT(a)         \
 343         ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
 344         (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
 345         (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == 0) && \
 346         (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) != 0) && \
 347         (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) != ntohl(1)))
 348
 349 /*
 350  * Mapped
 351  */
 352 #define IN6_IS_ADDR_V4MAPPED(a)               \
 353         ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
 354         (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
 355         (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == \
 356         ntohl(0x0000ffff)))
 357
 358 /*
 359  * 6to4
 360  */
 361 #define IN6_IS_ADDR_6TO4(x)     (ntohs((x)->s6_addr16[0]) == 0x2002)
 362
 363 /*
 364  * KAME Scope Values
 365  */
 366
 367 #ifdef KERNEL   /* XXX nonstandard */
 368 #define IPV6_ADDR_SCOPE_NODELOCAL       0x01
 369 #define IPV6_ADDR_SCOPE_INTFACELOCAL    0x01
 370 #define IPV6_ADDR_SCOPE_LINKLOCAL       0x02
 371 #define IPV6_ADDR_SCOPE_SITELOCAL       0x05
 372 #define IPV6_ADDR_SCOPE_ORGLOCAL        0x08    /* just used in this file */
 373 #define IPV6_ADDR_SCOPE_GLOBAL          0x0e
 374 #else
 375 #define __IPV6_ADDR_SCOPE_NODELOCAL     0x01
 376 #define __IPV6_ADDR_SCOPE_INTFACELOCAL  0x01
 377 #define __IPV6_ADDR_SCOPE_LINKLOCAL     0x02
 378 #define __IPV6_ADDR_SCOPE_SITELOCAL     0x05
 379 #define __IPV6_ADDR_SCOPE_ORGLOCAL      0x08    /* just used in this file */
 380 #define __IPV6_ADDR_SCOPE_GLOBAL        0x0e
 381 #endif
 382
 383 /*
 384  * Unicast Scope
 385  * Note that we must check topmost 10 bits only, not 16 bits (see RFC2373).
 386  */
 387 #define IN6_IS_ADDR_LINKLOCAL(a)        \
 388         (((a)->s6_addr[0] == 0xfe) && (((a)->s6_addr[1] & 0xc0) == 0x80))
 389 #define IN6_IS_ADDR_SITELOCAL(a)        \
 390         (((a)->s6_addr[0] == 0xfe) && (((a)->s6_addr[1] & 0xc0) == 0xc0))
 391
 392 /*
 393  * Multicast
 394  */
 395 #define IN6_IS_ADDR_MULTICAST(a)        ((a)->s6_addr[0] == 0xff)
 396
 397 #define IPV6_ADDR_MC_FLAGS(a)           ((a)->s6_addr[1] & 0xf0)
 398
 399 #define IPV6_ADDR_MC_FLAGS_TRANSIENT            0x10
 400 #define IPV6_ADDR_MC_FLAGS_PREFIX               0x20
 401 #define IPV6_ADDR_MC_FLAGS_UNICAST_BASED        (IPV6_ADDR_MC_FLAGS_TRANSIENT | IPV6_ADDR_MC_FLAGS_PREFIX)
 402
 403 #define IN6_IS_ADDR_UNICAST_BASED_MULTICAST(a)  \
 404         (IN6_IS_ADDR_MULTICAST(a) &&            \
 405         (IPV6_ADDR_MC_FLAGS(a) == IPV6_ADDR_MC_FLAGS_UNICAST_BASED))
 406
 407 /*
 408  * Unique Local IPv6 Unicast Addresses (per RFC 4193)
 409  */
 410 #define IN6_IS_ADDR_UNIQUE_LOCAL(a) \
 411         (((a)->s6_addr[0] == 0xfc) || ((a)->s6_addr[0] == 0xfd))
 412
 413 #ifdef KERNEL   /* XXX nonstandard */
 414 #define IPV6_ADDR_MC_SCOPE(a)           ((a)->s6_addr[1] & 0x0f)
 415 #else
 416 #define __IPV6_ADDR_MC_SCOPE(a)         ((a)->s6_addr[1] & 0x0f)
 417 #endif
 418
 419 /*
 420  * Multicast Scope
 421  */
 422 #ifdef KERNEL   /* refers nonstandard items */
 423 #define IN6_IS_ADDR_MC_UNICAST_BASED_LINKLOCAL(a)                               \
 424         (IN6_IS_ADDR_MULTICAST(a) &&                                            \
 425         (IPV6_ADDR_MC_FLAGS(a) == IPV6_ADDR_MC_FLAGS_UNICAST_BASED) &&          \
 426         (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_LINKLOCAL))
 427 #define IN6_IS_ADDR_MC_NODELOCAL(a)     \
 428         (IN6_IS_ADDR_MULTICAST(a) &&    \
 429         (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_NODELOCAL))
 430 #define IN6_IS_ADDR_MC_INTFACELOCAL(a)  \
 431         (IN6_IS_ADDR_MULTICAST(a) &&    \
 432         (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_INTFACELOCAL))
 433 #define IN6_IS_ADDR_MC_LINKLOCAL(a)                                             \
 434         (IN6_IS_ADDR_MULTICAST(a) &&                                            \
 435         (IPV6_ADDR_MC_FLAGS(a) != IPV6_ADDR_MC_FLAGS_UNICAST_BASED) &&          \
 436         (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_LINKLOCAL))
 437 #define IN6_IS_ADDR_MC_SITELOCAL(a)     \
 438         (IN6_IS_ADDR_MULTICAST(a) &&    \
 439         (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_SITELOCAL))
 440 #define IN6_IS_ADDR_MC_ORGLOCAL(a)      \
 441         (IN6_IS_ADDR_MULTICAST(a) &&    \
 442         (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_ORGLOCAL))
 443 #define IN6_IS_ADDR_MC_GLOBAL(a)        \
 444         (IN6_IS_ADDR_MULTICAST(a) &&    \
 445         (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_GLOBAL))
 446 #else
 447 #define IN6_IS_ADDR_MC_NODELOCAL(a)     \
 448         (IN6_IS_ADDR_MULTICAST(a) &&    \
 449         (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_NODELOCAL))
 450 #define IN6_IS_ADDR_MC_LINKLOCAL(a)                                             \
 451         (IN6_IS_ADDR_MULTICAST(a) &&                                            \
 452         (IPV6_ADDR_MC_FLAGS(a) != IPV6_ADDR_MC_FLAGS_UNICAST_BASED) &&          \
 453         (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_LINKLOCAL))
 454 #define IN6_IS_ADDR_MC_SITELOCAL(a)     \
 455         (IN6_IS_ADDR_MULTICAST(a) &&    \
 456         (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_SITELOCAL))
 457 #define IN6_IS_ADDR_MC_ORGLOCAL(a)      \
 458         (IN6_IS_ADDR_MULTICAST(a) &&    \
 459         (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_ORGLOCAL))
 460 #define IN6_IS_ADDR_MC_GLOBAL(a)        \
 461         (IN6_IS_ADDR_MULTICAST(a) &&    \
 462         (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_GLOBAL))
 463 #endif
 464
 465 #ifdef KERNEL   /* nonstandard */
 466 /*
 467  * KAME Scope
 468  */
 469 #define IN6_IS_SCOPE_LINKLOCAL(a)       \
 470         ((IN6_IS_ADDR_LINKLOCAL(a)) ||  \
 471         (IN6_IS_ADDR_MC_LINKLOCAL(a)))
 472
 473 #define IN6_IS_SCOPE_EMBED(a)                   \
 474         ((IN6_IS_ADDR_LINKLOCAL(a)) ||          \
 475         (IN6_IS_ADDR_MC_LINKLOCAL(a)) ||        \
 476         (IN6_IS_ADDR_MC_INTFACELOCAL(a)))
 477
 478 #define IFA6_IS_DEPRECATED(a, t) \
 479         ((a)->ia6_lifetime.ia6ti_preferred != 0 && \
 480         (a)->ia6_lifetime.ia6ti_preferred < (t))
 481 #define IFA6_IS_INVALID(a, t) \
 482         ((a)->ia6_lifetime.ia6ti_expire != 0 && \
 483         (a)->ia6_lifetime.ia6ti_expire < (t))
 484 #endif /* KERNEL */
 485
 486 #ifdef PRIVATE
 487 struct route_in6_old {
 488         void            *ro_rt;
 489         uint32_t        ro_flags;
 490         struct sockaddr_in6 ro_dst;
 491 };
 492 #endif /* PRIVATE */
 493
 494 #ifdef BSD_KERNEL_PRIVATE
 495 #include <net/if_llatbl.h>
 496 #include <sys/eventhandler.h>
 497
 498 /*
 499  * IP6 route structure
 500  *
 501  * A route consists of a destination address and a reference
 502  * to a routing entry.  These are often held by protocols
 503  * in their control blocks, e.g. inpcb.
 504  */
 505 struct route_in6 {
 506         /*
 507          * N.B: struct route_in6 must begin with ro_{rt,srcia,flags}
 508          * because the code does some casts of a 'struct route_in6 *'
 509          * to a 'struct route *'.
 510          */
 511         struct rtentry  *ro_rt;
 512         struct  llentry *ro_lle;
 513
 514         struct ifaddr   *ro_srcia;
 515         uint32_t        ro_flags;       /* route flags */
 516         struct sockaddr_in6 ro_dst;
 517 };
 518 #endif /* BSD_KERNEL_PRIVATE */
 519
 520 /*
 521  * Options for use with [gs]etsockopt at the IPV6 level.
 522  * First word of comment is data type; bool is stored in int.
 523  */
 524 /* no hdrincl */
 525 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 526 /*
 527  * RFC 3542 define the following socket options in a manner incompatible
 528  * with RFC 2292:
 529  *   IPV6_PKTINFO
 530  *   IPV6_HOPLIMIT
 531  *   IPV6_NEXTHOP
 532  *   IPV6_HOPOPTS
 533  *   IPV6_DSTOPTS
 534  *   IPV6_RTHDR
 535  *
 536  * To use the new IPv6 Sockets options introduced by RFC 3542
 537  * the constant __APPLE_USE_RFC_3542 must be defined before
 538  * including <netinet/in.h>
 539  *
 540  * To use the old IPv6 Sockets options from RFC 2292
 541  * the constant __APPLE_USE_RFC_2292 must be defined before
 542  * including <netinet/in.h>
 543  *
 544  * Note that eventually RFC 3542 is going to be the
 545  * default and RFC 2292 will be obsolete.
 546  */
 547 #ifdef BSD_KERNEL_PRIVATE
 548 #define __APPLE_USE_RFC_3542 1
 549 #endif /* BSD_KERNEL_PRIVATE */
 550
 551 #if defined(__APPLE_USE_RFC_3542) && defined(__APPLE_USE_RFC_2292)
 552 #error "__APPLE_USE_RFC_3542 and __APPLE_USE_RFC_2292 cannot be both defined"
 553 #endif
 554
 555 #if 0 /* the followings are relic in IPv4 and hence are disabled */
 556 #define IPV6_OPTIONS            1  /* buf/ip6_opts; set/get IP6 options */
 557 #define IPV6_RECVOPTS           5  /* bool; receive all IP6 opts w/dgram */
 558 #define IPV6_RECVRETOPTS        6  /* bool; receive IP6 opts for response */
 559 #define IPV6_RECVDSTADDR        7  /* bool; receive IP6 dst addr w/dgram */
 560 #define IPV6_RETOPTS            8  /* ip6_opts; set/get IP6 options */
 561 #endif /* 0 */
 562 #define IPV6_SOCKOPT_RESERVED1  3  /* reserved for future use */
 563 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 564 #define IPV6_UNICAST_HOPS       4  /* int; IP6 hops */
 565 #define IPV6_MULTICAST_IF       9  /* u_int; set/get IP6 multicast i/f  */
 566 #define IPV6_MULTICAST_HOPS     10 /* int; set/get IP6 multicast hops */
 567 #define IPV6_MULTICAST_LOOP     11 /* u_int; set/get IP6 mcast loopback */
 568 #define IPV6_JOIN_GROUP         12 /* ip6_mreq; join a group membership */
 569 #define IPV6_LEAVE_GROUP        13 /* ip6_mreq; leave a group membership */
 570
 571 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 572 #define IPV6_PORTRANGE          14 /* int; range to choose for unspec port */
 573 #define ICMP6_FILTER            18 /* icmp6_filter; icmp6 filter */
 574 #define IPV6_2292PKTINFO        19 /* bool; send/recv if, src/dst addr */
 575 #define IPV6_2292HOPLIMIT       20 /* bool; hop limit */
 576 #define IPV6_2292NEXTHOP        21 /* bool; next hop addr */
 577 #define IPV6_2292HOPOPTS        22 /* bool; hop-by-hop option */
 578 #define IPV6_2292DSTOPTS        23 /* bool; destinaion option */
 579 #define IPV6_2292RTHDR          24 /* ip6_rthdr: routing header */
 580
 581 /* buf/cmsghdr; set/get IPv6 options [obsoleted by RFC3542] */
 582 #define IPV6_2292PKTOPTIONS     25
 583
 584 #ifdef __APPLE_USE_RFC_2292
 585 #define IPV6_PKTINFO    IPV6_2292PKTINFO
 586 #define IPV6_HOPLIMIT   IPV6_2292HOPLIMIT
 587 #define IPV6_NEXTHOP    IPV6_2292NEXTHOP
 588 #define IPV6_HOPOPTS    IPV6_2292HOPOPTS
 589 #define IPV6_DSTOPTS    IPV6_2292DSTOPTS
 590 #define IPV6_RTHDR      IPV6_2292RTHDR
 591 #define IPV6_PKTOPTIONS IPV6_2292PKTOPTIONS
 592 #endif /* __APPLE_USE_RFC_2292 */
 593
 594 #define IPV6_CHECKSUM           26 /* int; checksum offset for raw socket */
 595 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 596 #define IPV6_V6ONLY             27 /* bool; only bind INET6 at wildcard bind */
 597 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 598 #ifndef KERNEL
 599 #define IPV6_BINDV6ONLY         IPV6_V6ONLY
 600 #endif /* KERNEL */
 601
 602
 603 #if 1 /* IPSEC */
 604 #define IPV6_IPSEC_POLICY       28 /* struct; get/set security policy */
 605 #endif /* 1 */
 606 #define IPV6_FAITH              29 /* deprecated */
 607
 608 #if 1 /* IPV6FIREWALL */
 609 #define IPV6_FW_ADD             30 /* add a firewall rule to chain */
 610 #define IPV6_FW_DEL             31 /* delete a firewall rule from chain */
 611 #define IPV6_FW_FLUSH           32 /* flush firewall rule chain */
 612 #define IPV6_FW_ZERO            33 /* clear single/all firewall counter(s) */
 613 #define IPV6_FW_GET             34 /* get entire firewall rule chain */
 614 #endif /* 1 */
 615
 616 /*
 617  * APPLE: NOTE the value of those 2 options is kept unchanged from
 618  *   previous version of darwin/OS X for binary compatibility reasons
 619  *   and differ from FreeBSD (values 57 and 61). See below.
 620  */
 621 #define IPV6_RECVTCLASS         35 /* bool; recv traffic class values */
 622 #define IPV6_TCLASS             36 /* int; send traffic class value */
 623
 624 #ifdef __APPLE_USE_RFC_3542
 625 /* new socket options introduced in RFC3542 */
 626 /*
 627  * ip6_dest; send dst option before rthdr
 628  * APPLE: Value purposely different than FreeBSD (35) to avoid
 629  * collision with definition of IPV6_RECVTCLASS in previous
 630  * darwin implementations
 631  */
 632 #define IPV6_RTHDRDSTOPTS       57
 633
 634 /*
 635  * bool; recv if, dst addr
 636  * APPLE: Value purposely different than FreeBSD(36) to avoid
 637  * collision with definition of IPV6_TCLASS in previous
 638  * darwin implementations
 639  */
 640 #define IPV6_RECVPKTINFO        61
 641
 642 #define IPV6_RECVHOPLIMIT       37 /* bool; recv hop limit */
 643 #define IPV6_RECVRTHDR          38 /* bool; recv routing header */
 644 #define IPV6_RECVHOPOPTS        39 /* bool; recv hop-by-hop option */
 645 #define IPV6_RECVDSTOPTS        40 /* bool; recv dst option after rthdr */
 646 #ifdef KERNEL
 647 #define IPV6_RECVRTHDRDSTOPTS   41 /* bool; recv dst option before rthdr */
 648 #endif
 649
 650 #define IPV6_USE_MIN_MTU        42 /* bool; send packets at the minimum MTU */
 651 #define IPV6_RECVPATHMTU        43 /* bool; notify an according MTU */
 652
 653 /*
 654  * mtuinfo; get the current path MTU (sopt), 4 bytes int;
 655  * MTU notification (cmsg)
 656  */
 657 #define IPV6_PATHMTU            44
 658
 659 #if 0 /* obsoleted during 2292bis -> 3542 */
 660 /* no data; ND reachability confirm (cmsg only/not in of RFC3542) */
 661 #define IPV6_REACHCONF          45
 662 #endif
 663 /* more new socket options introduced in RFC3542 */
 664 #define IPV6_3542PKTINFO        46 /* in6_pktinfo; send if, src addr */
 665 #define IPV6_3542HOPLIMIT       47 /* int; send hop limit */
 666 #define IPV6_3542NEXTHOP        48 /* sockaddr; next hop addr */
 667 #define IPV6_3542HOPOPTS        49 /* ip6_hbh; send hop-by-hop option */
 668 #define IPV6_3542DSTOPTS        50 /* ip6_dest; send dst option befor rthdr */
 669 #define IPV6_3542RTHDR          51 /* ip6_rthdr; send routing header */
 670
 671 #define IPV6_PKTINFO    IPV6_3542PKTINFO
 672 #define IPV6_HOPLIMIT   IPV6_3542HOPLIMIT
 673 #define IPV6_NEXTHOP    IPV6_3542NEXTHOP
 674 #define IPV6_HOPOPTS    IPV6_3542HOPOPTS
 675 #define IPV6_DSTOPTS    IPV6_3542DSTOPTS
 676 #define IPV6_RTHDR      IPV6_3542RTHDR
 677
 678 #define IPV6_AUTOFLOWLABEL      59 /* bool; attach flowlabel automagically */
 679
 680 #define IPV6_DONTFRAG           62 /* bool; disable IPv6 fragmentation */
 681
 682 /* int; prefer temporary addresses as the source address. */
 683 #define IPV6_PREFER_TEMPADDR    63
 684
 685 /*
 686  * The following option is private; do not use it from user applications.
 687  * It is deliberately defined to the same value as IP_MSFILTER.
 688  */
 689 #define IPV6_MSFILTER           74 /* struct __msfilterreq; */
 690 #endif /* __APPLE_USE_RFC_3542 */
 691
 692 #define IPV6_BOUND_IF           125 /* int; set/get bound interface */
 693
 694 #ifdef PRIVATE
 695 #define IPV6_NO_IFT_CELLULAR    6969 /* for internal use only */
 696 #define IPV6_OUT_IF             9696 /* for internal use only */
 697 #endif /* PRIVATE */
 698
 699 /* to define items, should talk with KAME guys first, for *BSD compatibility */
 700
 701 #define IPV6_RTHDR_LOOSE        0 /* this hop need not be a neighbor. */
 702 #define IPV6_RTHDR_STRICT       1 /* this hop must be a neighbor. */
 703 #define IPV6_RTHDR_TYPE_0       0 /* IPv6 routing header type 0 */
 704
 705 /*
 706  * Defaults and limits for options
 707  */
 708 #define IPV6_DEFAULT_MULTICAST_HOPS 1   /* normally limit m'casts to 1 hop  */
 709 #define IPV6_DEFAULT_MULTICAST_LOOP 1   /* normally hear sends if a member  */
 710
 711 /*
 712  * The im6o_membership vector for each socket is now dynamically allocated at
 713  * run-time, bounded by USHRT_MAX, and is reallocated when needed, sized
 714  * according to a power-of-two increment.
 715  */
 716 #define IPV6_MIN_MEMBERSHIPS    31
 717 #define IPV6_MAX_MEMBERSHIPS    4095
 718
 719 /*
 720  * Default resource limits for IPv6 multicast source filtering.
 721  * These may be modified by sysctl.
 722  */
 723 #define IPV6_MAX_GROUP_SRC_FILTER       512     /* sources per group */
 724 #define IPV6_MAX_SOCK_SRC_FILTER        128     /* sources per socket/group */
 725
 726 /*
 727  * Argument structure for IPV6_JOIN_GROUP and IPV6_LEAVE_GROUP.
 728  */
 729 struct ipv6_mreq {
 730         struct in6_addr ipv6mr_multiaddr;
 731         unsigned int    ipv6mr_interface;
 732 };
 733
 734 /*
 735  * IPV6_2292PKTINFO: Packet information(RFC2292 sec 5)
 736  */
 737 struct in6_pktinfo {
 738         struct in6_addr ipi6_addr;      /* src/dst IPv6 address */
 739         unsigned int    ipi6_ifindex;   /* send/recv interface index */
 740 };
 741
 742 /*
 743  * Control structure for IPV6_RECVPATHMTU socket option.
 744  */
 745 struct ip6_mtuinfo {
 746         struct sockaddr_in6 ip6m_addr;  /* or sockaddr_storage? */
 747         uint32_t ip6m_mtu;
 748 };
 749
 750 /*
 751  * Argument for IPV6_PORTRANGE:
 752  * - which range to search when port is unspecified at bind() or connect()
 753  */
 754 #define IPV6_PORTRANGE_DEFAULT  0       /* default range */
 755 #define IPV6_PORTRANGE_HIGH     1       /* "high" - request firewall bypass */
 756 #define IPV6_PORTRANGE_LOW      2       /* "low" - vouchsafe security */
 757
 758 /*
 759  * Definitions for inet6 sysctl operations.
 760  *
 761  * Third level is protocol number.
 762  * Fourth level is desired variable within that protocol.
 763  */
 764 #define IPV6PROTO_MAXID (IPPROTO_PIM + 1)  /* don't list to IPV6PROTO_MAX */
 765
 766 /*
 767  * Names for IP sysctl objects
 768  */
 769 #define IPV6CTL_FORWARDING      1       /* act as router */
 770 #define IPV6CTL_SENDREDIRECTS   2       /* may send redirects when forwarding */
 771 #define IPV6CTL_DEFHLIM         3       /* default Hop-Limit */
 772 #ifdef notyet
 773 #define IPV6CTL_DEFMTU          4       /* default MTU */
 774 #endif
 775 #define IPV6CTL_FORWSRCRT       5       /* forward source-routed dgrams */
 776 #define IPV6CTL_STATS           6       /* stats */
 777 #define IPV6CTL_MRTSTATS        7       /* multicast forwarding stats */
 778 #define IPV6CTL_MRTPROTO        8       /* multicast routing protocol */
 779 #define IPV6CTL_MAXFRAGPACKETS  9       /* max packets reassembly queue */
 780 #define IPV6CTL_SOURCECHECK     10      /* verify source route and intf */
 781 #define IPV6CTL_SOURCECHECK_LOGINT 11   /* minimume logging interval */
 782 #define IPV6CTL_ACCEPT_RTADV    12
 783 #define IPV6CTL_KEEPFAITH       13      /* deprecated */
 784 #define IPV6CTL_LOG_INTERVAL    14
 785 #define IPV6CTL_HDRNESTLIMIT    15
 786 #define IPV6CTL_DAD_COUNT       16
 787 #define IPV6CTL_AUTO_FLOWLABEL  17
 788 #define IPV6CTL_DEFMCASTHLIM    18
 789 #define IPV6CTL_GIF_HLIM        19      /* default HLIM for gif encap packet */
 790 #define IPV6CTL_KAME_VERSION    20
 791 #define IPV6CTL_USE_DEPRECATED  21      /* use deprec addr (RFC2462 5.5.4) */
 792 #define IPV6CTL_RR_PRUNE        22      /* walk timer for router renumbering */
 793 #if 0   /* obsolete */
 794 #define IPV6CTL_MAPPED_ADDR     23
 795 #endif
 796 #define IPV6CTL_V6ONLY          24
 797 #define IPV6CTL_RTEXPIRE        25      /* cloned route expiration time */
 798 #define IPV6CTL_RTMINEXPIRE     26      /* min value for expiration time */
 799 #define IPV6CTL_RTMAXCACHE      27      /* trigger level for dynamic expire */
 800
 801 #define IPV6CTL_USETEMPADDR     32      /* use temporary addresses [RFC 4941] */
 802 #define IPV6CTL_TEMPPLTIME      33      /* preferred lifetime for tmpaddrs */
 803 #define IPV6CTL_TEMPVLTIME      34      /* valid lifetime for tmpaddrs */
 804 #define IPV6CTL_AUTO_LINKLOCAL  35      /* automatic link-local addr assign */
 805 #define IPV6CTL_RIP6STATS       36      /* raw_ip6 stats */
 806 #define IPV6CTL_PREFER_TEMPADDR 37      /* prefer temporary addr as src */
 807 #define IPV6CTL_ADDRCTLPOLICY   38      /* get/set address selection policy */
 808 #define IPV6CTL_USE_DEFAULTZONE 39      /* use default scope zone */
 809
 810 #define IPV6CTL_MAXFRAGS        41      /* max fragments */
 811 #define IPV6CTL_MCAST_PMTU      44      /* enable pMTU discovery for mcast? */
 812
 813 #define IPV6CTL_NEIGHBORGCTHRESH 46
 814 #define IPV6CTL_MAXIFPREFIXES   47
 815 #define IPV6CTL_MAXIFDEFROUTERS 48
 816 #define IPV6CTL_MAXDYNROUTES    49
 817 #define ICMPV6CTL_ND6_ONLINKNSRFC4861   50
 818
 819 /* New entries should be added here from current IPV6CTL_MAXID value. */
 820 /* to define items, should talk with KAME guys first, for *BSD compatibility */
 821 #define IPV6CTL_MAXID           51
 822
 823 #ifdef BSD_KERNEL_PRIVATE
 824 #define CTL_IPV6PROTO_NAMES { \
 825         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 826         { 0, 0 }, \
 827         { "tcp6", CTLTYPE_NODE }, \
 828         { 0, 0 }, \
 829         { 0, 0 }, \
 830         { 0, 0 }, \
 831         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 832         { 0, 0 }, \
 833         { 0, 0 }, \
 834         { "udp6", CTLTYPE_NODE }, \
 835         { 0, 0 }, \
 836         { 0, 0 }, \
 837         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 838         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 839         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 840         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 841         { 0, 0 }, \
 842         { "ip6", CTLTYPE_NODE }, \
 843         { 0, 0 }, \
 844         { 0, 0 }, \
 845         { 0, 0 }, \
 846         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 847         { 0, 0 }, \
 848         { "ipsec6", CTLTYPE_NODE }, \
 849         { 0, 0 }, \
 850         { 0, 0 }, \
 851         { 0, 0 }, \
 852         { 0, 0 }, \
 853         { 0, 0 }, \
 854         { 0, 0 }, \
 855         { "icmp6", CTLTYPE_NODE }, \
 856         { 0, 0 }, \
 857         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 858         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 859         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 860         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 861         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 862         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 863         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 864         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
 865         { 0, 0 }, \
 866         { 0, 0 }, \
 867         { 0, 0 }, \
 868         { 0, 0 }, \
 869 }
 870 /*
 871  * Redefinition of mbuf flags
 872  */
 873 #define M_AUTHIPHDR     M_PROTO2
 874 #define M_DECRYPTED     M_PROTO3
 875 #define M_AUTHIPDGM     M_PROTO5
 876
 877 struct cmsghdr;
 878 struct mbuf;
 879 struct ifnet;
 880 struct in6_aliasreq;
 881 struct lltable;
 882
 883 extern struct lltable * in6_lltattach(struct ifnet *ifp);
 884 extern uint16_t in6_pseudo(const struct in6_addr *, const struct in6_addr *,
 885     uint32_t);
 886 extern u_int16_t inet6_cksum(struct mbuf *, uint32_t, uint32_t, uint32_t);
 887 extern u_int16_t inet6_cksum_buffer(const uint8_t *, uint32_t, uint32_t,
 888     uint32_t);
 889
 890 #define in6_cksum(_m, _n, _o, _l)                       \
 891         inet6_cksum(_m, _n, _o, _l)
 892 #define in6_cksum_buffer(_b, _n, _o, _l)                \
 893         inet6_cksum_buffer(_b, _n, _o, _l)
 894
 895 extern int in6_addrscope(struct in6_addr *);
 896 extern struct in6_ifaddr *in6_ifawithscope(struct ifnet *, struct in6_addr *);
 897 extern struct in6_ifaddr *in6_ifawithifp(struct ifnet *, struct in6_addr *);
 898
 899 struct sockaddr;
 900
 901 extern void in6_sin6_2_sin(struct sockaddr_in *sin, struct sockaddr_in6 *sin6);
 902 extern void in6_sin_2_v4mapsin6(struct sockaddr_in *sin,
 903     struct sockaddr_in6 *sin6);
 904 extern void in6_sin6_2_sin_in_sock(struct sockaddr *nam);
 905 extern int in6_sin_2_v4mapsin6_in_sock(struct sockaddr **nam);
 906
 907 extern uint32_t in6_finalize_cksum(struct mbuf *, uint32_t, int32_t,
 908     int32_t, uint32_t);
 909
 910 #define in6_delayed_cksum(_m)                   \
 911         ((void) in6_finalize_cksum(_m, 0, 0, -1, CSUM_DELAY_IPV6_DATA))
 912 #define in6_delayed_cksum_offset(_m, _o, _s, _p)        \
 913         ((void) in6_finalize_cksum(_m, _o, _s, _p, CSUM_DELAY_IPV6_DATA))
 914
 915 /* IPv6 protocol events */
 916 extern struct eventhandler_lists_ctxt in6_evhdlr_ctxt;
 917 /*
 918  * XXX Avoid reordering the enum values below.
 919  * If the order is changed, please make sure
 920  * in6_event2kev_array is also changed to reflect the
 921  * change in order of the enums
 922  */
 923 typedef enum {
 924         /* Address events */
 925         /*
 926          * XXX To avoid duplicacy and also for correctness
 927          * only report these for link local and stable addresses
 928          * NOTE: Link local address can never be marked detached
 929          * or duplicated.
 930          */
 931         IN6_ADDR_MARKED_DUPLICATED,
 932         IN6_ADDR_MARKED_DETACHED,
 933         IN6_ADDR_MARKED_DEPRECATED,
 934
 935         /* Expiry events */
 936         IN6_NDP_RTR_EXPIRY,
 937         IN6_NDP_PFX_EXPIRY,
 938         IN6_NDP_ADDR_EXPIRY,
 939
 940         /* XXX DNS expiry needs to be handled by user-space */
 941         /* MAX */
 942         IN6_EVENT_MAX,
 943 } in6_evhdlr_code_t;
 944
 945 struct in6_event2kev {
 946         in6_evhdlr_code_t       in6_event_code;
 947         uint32_t                in6_event_kev_subclass;
 948         uint32_t                in6_event_kev_code;
 949         const char              *in6_event_str;
 950 };
 951 extern struct in6_event2kev in6_event2kev_array[];
 952 extern void in6_eventhdlr_callback(struct eventhandler_entry_arg, in6_evhdlr_code_t,
 953     struct ifnet *, struct in6_addr *, uint32_t);
 954 extern void in6_event_enqueue_nwk_wq_entry(in6_evhdlr_code_t,
 955     struct ifnet *, struct in6_addr *, uint32_t);
 956
 957 typedef void (*in6_event_fn) (struct eventhandler_entry_arg, in6_evhdlr_code_t,
 958     struct ifnet *, struct in6_addr *, uint32_t);
 959 EVENTHANDLER_DECLARE(in6_event, in6_event_fn);
 960 #endif /* BSD_KERNEL_PRIVATE */
 961
 962 #ifdef PRIVATE
 963 /* CLAT46 events */
 964 typedef enum in6_clat46_evhdlr_code_t {
 965         IN6_CLAT46_EVENT_V4_FLOW,
 966         IN6_CLAT46_EVENT_V6_ADDR_CONFFAIL,
 967 } in6_clat46_evhdlr_code_t;
 968
 969 struct kev_netevent_clat46_data {
 970         in6_clat46_evhdlr_code_t clat46_event_code;
 971         pid_t epid;
 972         uuid_t euuid;
 973 };
 974 #endif /* PRIVATE */
 975
 976 #ifdef BSD_KERNEL_PRIVATE
 977 /* CLAT46 events */
 978 extern struct eventhandler_lists_ctxt in6_clat46_evhdlr_ctxt;
 979 extern void in6_clat46_eventhdlr_callback(struct eventhandler_entry_arg,
 980     in6_clat46_evhdlr_code_t, pid_t, uuid_t);
 981 extern void in6_clat46_event_enqueue_nwk_wq_entry(in6_clat46_evhdlr_code_t,
 982     pid_t, uuid_t);
 983
 984 typedef void (*in6_clat46_event_fn) (struct eventhandler_entry_arg, in6_clat46_evhdlr_code_t,
 985     pid_t, uuid_t);
 986 EVENTHANDLER_DECLARE(in6_clat46_event, in6_clat46_event_fn);
 987 #endif /* BSD_KERNEL_PRIVATE */
 988
 989 #ifdef KERNEL_PRIVATE
 990 /* exporte for ApplicationFirewall */
 991 extern int in6_localaddr(struct in6_addr *);
 992 extern int in6addr_local(struct in6_addr *);
 993 #endif /* KERNEL_PRIVATE */
 994
 995 #ifndef KERNEL
 996 __BEGIN_DECLS
 997 struct cmsghdr;
 998
 999 extern int inet6_option_space(int);
1000 extern int inet6_option_init(void *, struct cmsghdr **, int);
1001 extern int inet6_option_append(struct cmsghdr *, const __uint8_t *, int, int);
1002 extern __uint8_t *inet6_option_alloc(struct cmsghdr *, int, int, int);
1003 extern int inet6_option_next(const struct cmsghdr *, __uint8_t **);
1004 extern int inet6_option_find(const struct cmsghdr *, __uint8_t **, int);
1005
1006 extern size_t inet6_rthdr_space(int, int);
1007 extern struct cmsghdr *inet6_rthdr_init(void *, int);
1008 extern int inet6_rthdr_add(struct cmsghdr *, const struct in6_addr *,
1009     unsigned int);
1010 extern int inet6_rthdr_lasthop(struct cmsghdr *, unsigned int);
1011 #if 0 /* not implemented yet */
1012 extern int inet6_rthdr_reverse(const struct cmsghdr *, struct cmsghdr *);
1013 #endif
1014 extern int inet6_rthdr_segments(const struct cmsghdr *);
1015 extern struct in6_addr *inet6_rthdr_getaddr(struct cmsghdr *, int);
1016 extern int inet6_rthdr_getflags(const struct cmsghdr *, int);
1017
1018 extern int inet6_opt_init(void *, socklen_t);
1019 extern int inet6_opt_append(void *, socklen_t, int, __uint8_t, socklen_t,
1020     __uint8_t, void **);
1021 extern int inet6_opt_finish(void *, socklen_t, int);
1022 extern int inet6_opt_set_val(void *, int, void *, socklen_t);
1023
1024 extern int inet6_opt_next(void *, socklen_t, int, __uint8_t *, socklen_t *,
1025     void **);
1026 extern int inet6_opt_find(void *, socklen_t, int, __uint8_t, socklen_t *,
1027     void **);
1028 extern int inet6_opt_get_val(void *, int, void *, socklen_t);
1029 extern socklen_t inet6_rth_space(int, int);
1030 extern void *inet6_rth_init(void *, socklen_t, int, int);
1031 extern int inet6_rth_add(void *, const struct in6_addr *);
1032 extern int inet6_rth_reverse(const void *, void *);
1033 extern int inet6_rth_segments(const void *);
1034 extern struct in6_addr *inet6_rth_getaddr(const void *, int);
1035
1036 __END_DECLS
1037 #endif /* !KERNEL */
1038 #endif /* PLATFORM_DriverKit */
1039 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1040 #endif /* !_NETINET6_IN6_H_ */