bsd/netinet6/nd6.h

   1 /*
   2  * Copyright (c) 2000-2015 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  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
  30  * All rights reserved.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice, this list of conditions and the following disclaimer.
  37  * 2. Redistributions in binary form must reproduce the above copyright
  38  *    notice, this list of conditions and the following disclaimer in the
  39  *    documentation and/or other materials provided with the distribution.
  40  * 3. Neither the name of the project nor the names of its contributors
  41  *    may be used to endorse or promote products derived from this software
  42  *    without specific prior written permission.
  43  *
  44  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  45  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  46  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  47  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  48  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  49  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  50  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  51  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  52  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  53  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  54  * SUCH DAMAGE.
  55  */
  56
  57 #ifndef _NETINET6_ND6_H_
  58 #define _NETINET6_ND6_H_
  59 #include <sys/appleapiopts.h>
  60
  61 /* see net/route.h, or net/if_inarp.h */
  62 #ifndef RTF_ANNOUNCE
  63 #define RTF_ANNOUNCE    RTF_PROTO2
  64 #endif
  65
  66 #include <sys/queue.h>
  67
  68 #ifdef BSD_KERNEL_PRIVATE
  69 #include <net/flowadv.h>
  70 #include <kern/locks.h>
  71 #include <sys/tree.h>
  72 #include <netinet6/nd6_var.h>
  73
  74 struct  llinfo_nd6 {
  75         /*
  76          * The following are protected by rnh_lock
  77          */
  78         struct  llinfo_nd6 *ln_next;
  79         struct  llinfo_nd6 *ln_prev;
  80         struct  rtentry *ln_rt;
  81         /*
  82          * The following are protected by rt_lock
  83          */
  84         struct ifnet *ln_exclifp; /* excluded interface (prefix proxy) */
  85         struct  mbuf *ln_hold;  /* last packet until resolved/timeout */
  86         uint32_t ln_asked;      /* # of queries already sent for this addr */
  87         short   ln_state;       /* reachability state */
  88         short   ln_router;      /* 2^0: ND6 router bit */
  89         u_int32_t ln_flags;     /* flags; see below */
  90         u_int64_t ln_expire;    /* lifetime for NDP state transition */
  91         u_int64_t ln_lastused;  /* last used timestamp */
  92         struct  if_llreach *ln_llreach; /* link-layer reachability record */
  93 };
  94
  95 /* Values for ln_flags */
  96 #define ND6_LNF_TIMER_SKIP      0x1     /* modified by nd6_timer() */
  97 #define ND6_LNF_IN_USE          0x2     /* currently in llinfo_nd6 list */
  98 #endif /* BSD_KERNEL_PRIVATE */
  99
 100 #define ND6_LLINFO_PURGE        -3
 101 #define ND6_LLINFO_NOSTATE      -2
 102 /*
 103  * We don't need the WAITDELETE state any more, but we keep the definition
 104  * in a comment line instead of removing it. This is necessary to avoid
 105  * unintentionally reusing the value for another purpose, which might
 106  * affect backward compatibility with old applications.
 107  * (20000711 jinmei@kame.net)
 108  */
 109 /* #define      ND6_LLINFO_WAITDELETE   -1 */
 110 #define ND6_LLINFO_INCOMPLETE   0
 111 #define ND6_LLINFO_REACHABLE    1
 112 #define ND6_LLINFO_STALE        2
 113 #define ND6_LLINFO_DELAY        3
 114 #define ND6_LLINFO_PROBE        4
 115
 116 #ifdef BSD_KERNEL_PRIVATE
 117 #define ND6_IS_LLINFO_PROBREACH(n) ((n)->ln_state > ND6_LLINFO_INCOMPLETE)
 118 #define ND6_LLINFO_PERMANENT(n) \
 119         (((n)->ln_expire == 0) && ((n)->ln_state > ND6_LLINFO_INCOMPLETE))
 120
 121 #define ND6_EUI64_GBIT  0x01
 122 #define ND6_EUI64_UBIT  0x02
 123
 124 #define ND6_EUI64_TO_IFID(in6) \
 125         do {(in6)->s6_addr[8] ^= ND6_EUI64_UBIT; } while (0)
 126
 127 #define ND6_EUI64_GROUP(in6)            ((in6)->s6_addr[8] & ND6_EUI64_GBIT)
 128 #define ND6_EUI64_INDIVIDUAL(in6)       (!ND6_EUI64_GROUP(in6))
 129 #define ND6_EUI64_LOCAL(in6)            ((in6)->s6_addr[8] & ND6_EUI64_UBIT)
 130 #define ND6_EUI64_UNIVERSAL(in6)        (!ND6_EUI64_LOCAL(in6))
 131 #define ND6_IFID_LOCAL(in6)             (!ND6_EUI64_LOCAL(in6))
 132 #define ND6_IFID_UNIVERSAL(in6)         (!ND6_EUI64_UNIVERSAL(in6))
 133 #endif /* BSD_KERNEL_PRIVATE */
 134
 135 #if !defined(BSD_KERNEL_PRIVATE)
 136 struct nd_ifinfo {
 137 #else
 138 /* For binary compatibility, this structure must not change */
 139 /* NOTE: nd_ifinfo is defined in nd6_var.h */
 140 struct nd_ifinfo_compat {
 141 #endif /* !BSD_KERNEL_PRIVATE */
 142         u_int32_t linkmtu;              /* LinkMTU */
 143         u_int32_t maxmtu;               /* Upper bound of LinkMTU */
 144         u_int32_t basereachable;        /* BaseReachableTime */
 145         u_int32_t reachable;            /* Reachable Time */
 146         u_int32_t retrans;              /* Retrans Timer */
 147         u_int32_t flags;                /* Flags */
 148         int recalctm;                   /* BaseReacable re-calculation timer */
 149         u_int8_t chlim;                 /* CurHopLimit */
 150         u_int8_t receivedra;
 151         /* the following 3 members are for privacy extension for addrconf */
 152         u_int8_t randomseed0[8]; /* upper 64 bits of SHA1 digest */
 153         u_int8_t randomseed1[8]; /* lower 64 bits (usually the EUI64 IFID) */
 154         u_int8_t randomid[8];   /* current random ID */
 155 };
 156
 157 #define ND6_IFF_PERFORMNUD              0x1
 158 #if defined(PRIVATE)
 159
 160 /*
 161  * APPLE: not used. Interface specific router advertisements are handled with a
 162  * specific ifnet flag: IFEF_ACCEPT_RTADVD
 163  */
 164 #define ND6_IFF_ACCEPT_RTADV            0x2
 165
 166 /* APPLE: NOT USED not related to ND. */
 167 #define ND6_IFF_PREFER_SOURCE           0x4
 168
 169 /* IPv6 operation is disabled due to * DAD failure.  (XXX: not ND-specific) */
 170 #define ND6_IFF_IFDISABLED              0x8
 171
 172 #define ND6_IFF_DONT_SET_IFROUTE        0x10 /* NOT USED */
 173 #endif /* PRIVATE */
 174 #define ND6_IFF_PROXY_PREFIXES          0x20
 175 #define ND6_IFF_IGNORE_NA               0x40
 176 #if defined(PRIVATE)
 177 #define ND6_IFF_INSECURE                0x80
 178 #endif
 179 #define ND6_IFF_REPLICATED              0x100   /* sleep proxy registered */
 180
 181 struct in6_nbrinfo {
 182         char ifname[IFNAMSIZ];  /* if name, e.g. "en0" */
 183         struct in6_addr addr;   /* IPv6 address of the neighbor */
 184         long    asked;          /* # of queries already sent for this addr */
 185         int     isrouter;       /* if it acts as a router */
 186         int     state;          /* reachability state */
 187         int     expire;         /* lifetime for NDP state transition */
 188 };
 189
 190 #if defined(BSD_KERNEL_PRIVATE)
 191 struct in6_nbrinfo_32 {
 192         char ifname[IFNAMSIZ];
 193         struct in6_addr addr;
 194         u_int32_t asked;
 195         int     isrouter;
 196         int     state;
 197         int     expire;
 198 };
 199
 200 struct in6_nbrinfo_64 {
 201         char ifname[IFNAMSIZ];
 202         struct in6_addr addr;
 203         long    asked;
 204         int     isrouter        __attribute__((aligned(8)));
 205         int     state;
 206         int     expire;
 207 } __attribute__((aligned(8)));
 208 #endif /* BSD_KERNEL_PRIVATE */
 209
 210 #define DRLSTSIZ 10
 211 #define PRLSTSIZ 10
 212
 213 struct  in6_drlist {
 214         char ifname[IFNAMSIZ];
 215         struct {
 216                 struct  in6_addr rtaddr;
 217                 u_char  flags;
 218                 u_short rtlifetime;
 219                 u_long  expire;
 220                 u_short if_index;
 221         } defrouter[DRLSTSIZ];
 222 };
 223
 224 #if defined(BSD_KERNEL_PRIVATE)
 225 struct  in6_drlist_32 {
 226         char ifname[IFNAMSIZ];
 227         struct {
 228                 struct  in6_addr rtaddr;
 229                 u_char  flags;
 230                 u_short rtlifetime;
 231                 u_int32_t expire;
 232                 u_short if_index;
 233         } defrouter[DRLSTSIZ];
 234 };
 235
 236 struct  in6_drlist_64 {
 237         char ifname[IFNAMSIZ];
 238         struct {
 239                 struct  in6_addr rtaddr;
 240                 u_char  flags;
 241                 u_short rtlifetime;
 242                 u_long  expire          __attribute__((aligned(8)));
 243                 u_short if_index        __attribute__((aligned(8)));
 244         } defrouter[DRLSTSIZ] __attribute__((aligned(8)));
 245 };
 246 #endif /* BSD_KERNEL_PRIVATE */
 247
 248 /* valid values for stateflags */
 249 #define NDDRF_INSTALLED 0x1     /* installed in the routing table */
 250 #define NDDRF_IFSCOPE   0x2     /* installed as a scoped route */
 251 #define NDDRF_STATIC    0x4     /* for internal use only */
 252 #ifdef BSD_KERNEL_PRIVATE
 253 #define NDDRF_PROCESSED 0x10
 254 #endif
 255
 256 struct  in6_defrouter {
 257         struct  sockaddr_in6 rtaddr;
 258         u_char  flags;
 259         u_char  stateflags;
 260         u_short rtlifetime;
 261         u_long  expire;
 262         u_short if_index;
 263 };
 264
 265 #if defined(BSD_KERNEL_PRIVATE)
 266 struct  in6_defrouter_32 {
 267         struct  sockaddr_in6 rtaddr;
 268         u_char  flags;
 269         u_char  stateflags;
 270         u_short rtlifetime;
 271         u_int32_t expire;
 272         u_short if_index;
 273 };
 274
 275 struct  in6_defrouter_64 {
 276         struct  sockaddr_in6 rtaddr;
 277         u_char  flags;
 278         u_char  stateflags;
 279         u_short rtlifetime;
 280         u_long  expire          __attribute__((aligned(8)));
 281         u_short if_index        __attribute__((aligned(8)));
 282 } __attribute__((aligned(8)));
 283 #endif /* BSD_KERNEL_PRIVATE */
 284
 285 struct  in6_prlist {
 286         char ifname[IFNAMSIZ];
 287         struct {
 288                 struct  in6_addr prefix;
 289                 struct prf_ra raflags;
 290                 u_char  prefixlen;
 291                 u_char  origin;
 292                 u_long  vltime;
 293                 u_long  pltime;
 294                 u_long  expire;
 295                 u_short if_index;
 296                 u_short advrtrs; /* number of advertisement routers */
 297                 struct  in6_addr advrtr[DRLSTSIZ]; /* XXX: explicit limit */
 298         } prefix[PRLSTSIZ];
 299 };
 300
 301 #if defined(BSD_KERNEL_PRIVATE)
 302 struct  in6_prlist_32 {
 303         char ifname[IFNAMSIZ];
 304         struct {
 305                 struct  in6_addr prefix;
 306                 struct prf_ra raflags;
 307                 u_char  prefixlen;
 308                 u_char  origin;
 309                 u_int32_t vltime;
 310                 u_int32_t pltime;
 311                 u_int32_t expire;
 312                 u_short if_index;
 313                 u_short advrtrs;
 314                 struct  in6_addr advrtr[DRLSTSIZ];
 315         } prefix[PRLSTSIZ];
 316 };
 317
 318 struct  in6_prlist_64 {
 319         char ifname[IFNAMSIZ];
 320         struct {
 321                 struct  in6_addr prefix;
 322                 struct prf_ra raflags;
 323                 u_char  prefixlen;
 324                 u_char  origin;
 325                 u_long  vltime  __attribute__((aligned(8)));
 326                 u_long  pltime  __attribute__((aligned(8)));
 327                 u_long  expire  __attribute__((aligned(8)));
 328                 u_short if_index;
 329                 u_short advrtrs;
 330                 u_int32_t pad;
 331                 struct  in6_addr advrtr[DRLSTSIZ];
 332         } prefix[PRLSTSIZ];
 333 };
 334 #endif /* BSD_KERNEL_PRIVATE */
 335
 336 struct in6_prefix {
 337         struct  sockaddr_in6 prefix;
 338         struct prf_ra raflags;
 339         u_char  prefixlen;
 340         u_char  origin;
 341         u_long  vltime;
 342         u_long  pltime;
 343         u_long  expire;
 344         u_int32_t flags;
 345         int refcnt;
 346         u_short if_index;
 347         u_short advrtrs; /* number of advertisement routers */
 348         /* struct sockaddr_in6 advrtr[] */
 349 };
 350
 351 #if defined(BSD_KERNEL_PRIVATE)
 352 struct in6_prefix_32 {
 353         struct  sockaddr_in6 prefix;
 354         struct prf_ra raflags;
 355         u_char  prefixlen;
 356         u_char  origin;
 357         u_int32_t vltime;
 358         u_int32_t pltime;
 359         u_int32_t expire;
 360         u_int32_t flags;
 361         int refcnt;
 362         u_short if_index;
 363         u_short advrtrs; /* number of advertisement routers */
 364         /* struct sockaddr_in6 advrtr[] */
 365 };
 366
 367 struct in6_prefix_64 {
 368         struct  sockaddr_in6 prefix;
 369         struct prf_ra raflags;
 370         u_char  prefixlen;
 371         u_char  origin;
 372         u_long  vltime  __attribute__((aligned(8)));
 373         u_long  pltime  __attribute__((aligned(8)));
 374         u_long  expire  __attribute__((aligned(8)));
 375         u_int32_t flags __attribute__((aligned(8)));
 376         int refcnt;
 377         u_short if_index;
 378         u_short advrtrs;
 379         /* struct sockaddr_in6 advrtr[] */
 380 };
 381 #endif /* BSD_KERNEL_PRIVATE */
 382
 383 struct  in6_ondireq {
 384         char ifname[IFNAMSIZ];
 385         struct {
 386                 u_int32_t linkmtu;      /* LinkMTU */
 387                 u_int32_t maxmtu;       /* Upper bound of LinkMTU */
 388                 u_int32_t basereachable; /* BaseReachableTime */
 389                 u_int32_t reachable;    /* Reachable Time */
 390                 u_int32_t retrans;      /* Retrans Timer */
 391                 u_int32_t flags;        /* Flags */
 392                 int recalctm;           /* BaseReacable re-calculation timer */
 393                 u_int8_t chlim;         /* CurHopLimit */
 394                 u_int8_t receivedra;
 395         } ndi;
 396 };
 397
 398 #if !defined(BSD_KERNEL_PRIVATE)
 399 struct  in6_ndireq {
 400         char ifname[IFNAMSIZ];
 401         struct nd_ifinfo ndi;
 402 };
 403 #else
 404 struct  in6_ndireq {
 405         char ifname[IFNAMSIZ];
 406         struct nd_ifinfo_compat ndi;
 407 };
 408 #endif /* !BSD_KERNEL_PRIVATE */
 409
 410 struct  in6_ndifreq {
 411         char ifname[IFNAMSIZ];
 412         u_long ifindex;
 413 };
 414
 415 #define MAX_RTR_SOLICITATION_DELAY      1       /* 1sec */
 416 #define RTR_SOLICITATION_INTERVAL       4       /* 4sec */
 417
 418 #if defined(BSD_KERNEL_PRIVATE)
 419 struct  in6_ndifreq_32 {
 420         char ifname[IFNAMSIZ];
 421         u_int32_t ifindex;
 422 };
 423
 424 struct  in6_ndifreq_64 {
 425         char ifname[IFNAMSIZ];
 426         u_long ifindex  __attribute__((aligned(8)));
 427 };
 428 #endif /* BSD_KERNEL_PRIVATE */
 429
 430 /* Prefix status */
 431 #define NDPRF_ONLINK            0x1
 432 #define NDPRF_DETACHED          0x2
 433 #define NDPRF_STATIC            0x100
 434 #define NDPRF_IFSCOPE           0x1000
 435 #define NDPRF_PRPROXY           0x2000
 436 #ifdef BSD_KERNEL_PRIVATE
 437 #define NDPRF_PROCESSED_ONLINK  0x08000
 438 #define NDPRF_PROCESSED_SERVICE 0x10000
 439 #define NDPRF_DEFUNCT           0x20000
 440 #endif
 441
 442 /* protocol constants */
 443 #define MAX_RTR_SOLICITATION_DELAY      1       /* 1sec */
 444 #define RTR_SOLICITATION_INTERVAL       4       /* 4sec */
 445 #define MAX_RTR_SOLICITATIONS           3
 446
 447 #define ND6_INFINITE_LIFETIME           0xffffffff
 448 #define ND6_MAX_LIFETIME                0x7fffffff
 449
 450 #ifdef BSD_KERNEL_PRIVATE
 451 #define ND_IFINFO(ifp)                          \
 452     ((ifp == NULL) ? NULL :                     \
 453      ((IN6_IFEXTRA(ifp) == NULL) ? NULL :       \
 454       (&IN6_IFEXTRA(ifp)->nd_ifinfo)))
 455
 456 /*
 457  * In a more readable form, we derive linkmtu based on:
 458  *
 459  * if (ifp == NULL)
 460  *         linkmtu = IPV6_MMTU
 461  * else if (ND_IFINFO(ifp) == NULL || !ND_IFINFO(ifp)->initialized)
 462  *         linkmtu = ifp->if_mtu;
 463  * else if (ND_IFINFO(ifp)->linkmtu && ND_IFINFO(ifp)->linkmtu < ifp->if_mtu)
 464  *         linkmtu = ND_IFINFO(ifp)->linkmtu;
 465  * else if ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < ifp->if_mtu))
 466  *         linkmtu = ND_IFINFO(ifp)->maxmtu;
 467  * else
 468  *         linkmtu = ifp->if_mtu;
 469  */
 470 #define IN6_LINKMTU(ifp)                                                      \
 471         (ifp == NULL ? IPV6_MMTU :                                            \
 472         (ND_IFINFO(ifp) == NULL || !ND_IFINFO(ifp)->initialized) ?            \
 473         (ifp)->if_mtu : ((ND_IFINFO(ifp)->linkmtu &&                          \
 474         ND_IFINFO(ifp)->linkmtu < (ifp)->if_mtu) ? ND_IFINFO(ifp)->linkmtu :  \
 475         ((ND_IFINFO(ifp)->maxmtu && ND_IFINFO(ifp)->maxmtu < (ifp)->if_mtu) ? \
 476         ND_IFINFO(ifp)->maxmtu : (ifp)->if_mtu)))
 477
 478 /* node constants */
 479 #define MAX_REACHABLE_TIME              3600000 /* msec */
 480 #define REACHABLE_TIME                  30000   /* msec */
 481 #define RETRANS_TIMER                   1000    /* msec */
 482 #define MIN_RANDOM_FACTOR               512     /* 1024 * 0.5 */
 483 #define MAX_RANDOM_FACTOR               1536    /* 1024 * 1.5 */
 484 #define DEF_TEMP_VALID_LIFETIME         604800  /* 1 week */
 485 #define DEF_TEMP_PREFERRED_LIFETIME     86400   /* 1 day */
 486 #define TEMPADDR_REGEN_ADVANCE          5       /* sec */
 487 #define MAX_TEMP_DESYNC_FACTOR          600     /* 10 min */
 488 #define ND_COMPUTE_RTIME(x) \
 489                 (((MIN_RANDOM_FACTOR * (x >> 10)) + (RandomULong() & \
 490                 ((MAX_RANDOM_FACTOR - MIN_RANDOM_FACTOR) * (x >> 10)))) /1000)
 491
 492 /* prefix expiry times */
 493 #define ND6_PREFIX_EXPIRY_UNSPEC        -1
 494 #define ND6_PREFIX_EXPIRY_NEVER         0
 495
 496 TAILQ_HEAD(nd_drhead, nd_defrouter);
 497 struct  nd_defrouter {
 498         decl_lck_mtx_data(, nddr_lock);
 499         TAILQ_ENTRY(nd_defrouter) dr_entry;
 500         struct in6_addr rtaddr;
 501         u_int32_t       nddr_refcount;
 502         u_int32_t       nddr_debug;
 503         u_int64_t       expire;
 504         u_int64_t       base_calendartime;      /* calendar time at creation */
 505         u_int64_t       base_uptime;            /* uptime at creation */
 506         u_char          flags;                  /* flags on RA message */
 507         u_char          stateflags;
 508         u_short         rtlifetime;
 509         unsigned int    genid;
 510         int             err;
 511         struct ifnet    *ifp;
 512         void (*nddr_trace)(struct nd_defrouter *, int); /* trace callback fn */
 513 };
 514
 515 #define NDDR_LOCK_ASSERT_HELD(_nddr)                                    \
 516         lck_mtx_assert(&(_nddr)->nddr_lock, LCK_MTX_ASSERT_OWNED)
 517
 518 #define NDDR_LOCK_ASSERT_NOTHELD(_nddr)                                 \
 519         lck_mtx_assert(&(_nddr)->nddr_lock, LCK_MTX_ASSERT_NOTOWNED)
 520
 521 #define NDDR_LOCK(_nddr)                                                \
 522         lck_mtx_lock(&(_nddr)->nddr_lock)
 523
 524 #define NDDR_LOCK_SPIN(_nddr)                                           \
 525         lck_mtx_lock_spin(&(_nddr)->nddr_lock)
 526
 527 #define NDDR_CONVERT_LOCK(_nddr) do {                                   \
 528         NDPR_LOCK_ASSERT_HELD(_nddr);                                   \
 529         lck_mtx_convert_spin(&(_nddr)->nddr_lock);                      \
 530 } while (0)
 531
 532 #define NDDR_UNLOCK(_nddr)                                              \
 533         lck_mtx_unlock(&(_nddr)->nddr_lock)
 534
 535 #define NDDR_ADDREF(_nddr)                                              \
 536         nddr_addref(_nddr, 0)
 537
 538 #define NDDR_ADDREF_LOCKED(_nddr)                                       \
 539         nddr_addref(_nddr, 1)
 540
 541 #define NDDR_REMREF(_nddr) do {                                         \
 542         (void) nddr_remref(_nddr, 0);                                   \
 543 } while (0)
 544
 545 #define NDDR_REMREF_LOCKED(_nddr)                                       \
 546         nddr_remref(_nddr, 1)
 547
 548 /* define struct prproxy_sols_tree */
 549 RB_HEAD(prproxy_sols_tree, nd6_prproxy_soltgt);
 550
 551 struct nd_prefix {
 552         decl_lck_mtx_data(, ndpr_lock);
 553         u_int32_t       ndpr_refcount;  /* reference count */
 554         u_int32_t       ndpr_debug;     /* see ifa_debug flags */
 555         struct ifnet     *ndpr_ifp;
 556         struct rtentry   *ndpr_rt;
 557         LIST_ENTRY(nd_prefix) ndpr_entry;
 558         struct sockaddr_in6 ndpr_prefix; /* prefix */
 559         struct in6_addr ndpr_mask; /* netmask derived from the prefix */
 560         struct in6_addr ndpr_addr; /* address that is derived from the prefix */
 561         u_int32_t       ndpr_vltime;    /* advertised valid lifetime */
 562         u_int32_t       ndpr_pltime;    /* advertised preferred lifetime */
 563         u_int64_t       ndpr_preferred; /* preferred time of the prefix */
 564         u_int64_t       ndpr_expire;    /* expiration time of the prefix */
 565         u_int64_t       ndpr_lastupdate; /* rx time of last advertisement */
 566         u_int64_t       ndpr_base_calendartime; /* calendar time at creation */
 567         u_int64_t       ndpr_base_uptime;       /* uptime at creation */
 568         struct prf_ra   ndpr_flags;
 569         unsigned int    ndpr_genid;     /* protects ndpr_advrtrs */
 570         u_int32_t       ndpr_stateflags; /* actual state flags */
 571         /* list of routers that advertise the prefix: */
 572         LIST_HEAD(pr_rtrhead, nd_pfxrouter) ndpr_advrtrs;
 573         u_char          ndpr_plen;
 574         int             ndpr_addrcnt;   /* reference counter from addresses */
 575         u_int32_t       ndpr_allmulti_cnt;      /* total all-multi reqs */
 576         u_int32_t       ndpr_prproxy_sols_cnt;  /* total # of proxied NS */
 577         struct prproxy_sols_tree ndpr_prproxy_sols; /* tree of proxied NS */
 578         void (*ndpr_trace)(struct nd_prefix *, int); /* trace callback fn */
 579 };
 580
 581 #define ndpr_next               ndpr_entry.le_next
 582
 583 #define ndpr_raf                ndpr_flags
 584 #define ndpr_raf_onlink         ndpr_flags.onlink
 585 #define ndpr_raf_auto           ndpr_flags.autonomous
 586 #define ndpr_raf_router         ndpr_flags.router
 587 /*
 588  * We keep expired prefix for certain amount of time, for validation purposes.
 589  * 1800s = MaxRtrAdvInterval
 590  */
 591 #define NDPR_KEEP_EXPIRED       (1800 * 2)
 592
 593 #define NDPR_LOCK_ASSERT_HELD(_ndpr)                                    \
 594         lck_mtx_assert(&(_ndpr)->ndpr_lock, LCK_MTX_ASSERT_OWNED)
 595
 596 #define NDPR_LOCK_ASSERT_NOTHELD(_ndpr)                                 \
 597         lck_mtx_assert(&(_ndpr)->ndpr_lock, LCK_MTX_ASSERT_NOTOWNED)
 598
 599 #define NDPR_LOCK(_ndpr)                                                \
 600         lck_mtx_lock(&(_ndpr)->ndpr_lock)
 601
 602 #define NDPR_LOCK_SPIN(_ndpr)                                           \
 603         lck_mtx_lock_spin(&(_ndpr)->ndpr_lock)
 604
 605 #define NDPR_CONVERT_LOCK(_ndpr) do {                                   \
 606         NDPR_LOCK_ASSERT_HELD(_ndpr);                                   \
 607         lck_mtx_convert_spin(&(_ndpr)->ndpr_lock);                      \
 608 } while (0)
 609
 610 #define NDPR_UNLOCK(_ndpr)                                              \
 611         lck_mtx_unlock(&(_ndpr)->ndpr_lock)
 612
 613 #define NDPR_ADDREF(_ndpr)                                              \
 614         ndpr_addref(_ndpr, 0)
 615
 616 #define NDPR_ADDREF_LOCKED(_ndpr)                                       \
 617         ndpr_addref(_ndpr, 1)
 618
 619 #define NDPR_REMREF(_ndpr) do {                                         \
 620         (void) ndpr_remref(_ndpr, 0);                                   \
 621 } while (0)
 622
 623 #define NDPR_REMREF_LOCKED(_ndpr)                                       \
 624         ndpr_remref(_ndpr, 1)
 625
 626 /*
 627  * Message format for use in obtaining information about prefixes
 628  * from inet6 sysctl function
 629  */
 630 struct inet6_ndpr_msghdr {
 631         u_short inpm_msglen;    /* to skip over non-understood messages */
 632         u_char  inpm_version;   /* future binary compatibility */
 633         u_char  inpm_type;      /* message type */
 634         struct in6_addr inpm_prefix;
 635         u_int32_t       prm_vltim;
 636         u_int32_t       prm_pltime;
 637         u_int32_t       prm_expire;
 638         u_int32_t       prm_preferred;
 639         struct in6_prflags prm_flags;
 640         u_short prm_index;      /* index for associated ifp */
 641         u_char  prm_plen;       /* length of prefix in bits */
 642 };
 643
 644 #define prm_raf_onlink          prm_flags.prf_ra.onlink
 645 #define prm_raf_auto            prm_flags.prf_ra.autonomous
 646
 647 #define prm_statef_onlink       prm_flags.prf_state.onlink
 648
 649 #define prm_rrf_decrvalid       prm_flags.prf_rr.decrvalid
 650 #define prm_rrf_decrprefd       prm_flags.prf_rr.decrprefd
 651
 652 #define ifpr2ndpr(ifpr) ((struct nd_prefix *)(ifpr))
 653 #define ndpr2ifpr(ndpr) ((struct ifprefix *)(ndpr))
 654
 655 struct nd_pfxrouter {
 656         LIST_ENTRY(nd_pfxrouter) pfr_entry;
 657 #define pfr_next pfr_entry.le_next
 658         struct nd_defrouter *router;
 659 };
 660
 661 LIST_HEAD(nd_prhead, nd_prefix);
 662
 663 struct nd_prefix_list {
 664         struct nd_prefix_list *next;
 665         struct nd_prefix pr;
 666 };
 667 #endif /* BSD_KERNEL_PRIVATE */
 668
 669 #if defined(PRIVATE)
 670 struct kev_nd6_ndfailure {
 671         struct net_event_data link_data;
 672 };
 673
 674 struct kev_nd6_ndalive {
 675         struct net_event_data link_data;
 676 };
 677
 678 /* ND6 kernel event subclass value */
 679 #define KEV_ND6_SUBCLASS                7
 680
 681 /* ND6 kernel event action type */
 682 #define KEV_ND6_RA                      1
 683 #define KEV_ND6_NDFAILURE               2 /* IPv6 neighbor cache entry expiry */
 684 #define KEV_ND6_NDALIVE                 3 /* IPv6 neighbor reachable */
 685
 686 /* ND6 RA L2 source address length */
 687 #define ND6_ROUTER_LL_SIZE              64
 688
 689 struct nd6_ra_prefix {
 690         struct sockaddr_in6 prefix;
 691         struct prf_ra raflags;
 692         u_int32_t prefixlen;
 693         u_int32_t origin;
 694         u_int64_t vltime;
 695         u_int64_t pltime;
 696         u_int64_t expire;
 697         u_int32_t flags;
 698         u_int32_t refcnt;
 699         u_int32_t if_index;
 700         u_int32_t pad;
 701 };
 702
 703 /* ND6 router advertisement valid bits */
 704 #define KEV_ND6_DATA_VALID_MTU          (0x1 << 0)
 705 #define KEV_ND6_DATA_VALID_PREFIX       (0x1 << 1)
 706
 707 struct kev_nd6_ra_data {
 708         u_int8_t lladdr[ND6_ROUTER_LL_SIZE];
 709         u_int32_t lladdrlen;
 710         u_int32_t mtu;
 711         u_int32_t list_index;
 712         u_int32_t list_length;
 713         u_int32_t flags;
 714         struct nd6_ra_prefix prefix;
 715         u_int32_t pad;
 716 };
 717 #endif /* PRIVATE */
 718
 719 #if defined(BSD_KERNEL_PRIVATE)
 720 /* nd6.c */
 721 extern int nd6_prune;
 722 extern int nd6_prune_lazy;
 723 extern int nd6_delay;
 724 extern int nd6_umaxtries;
 725 extern int nd6_mmaxtries;
 726 extern int nd6_useloopback;
 727 extern int nd6_accept_6to4;
 728 extern int nd6_maxnudhint;
 729 extern int nd6_gctimer;
 730 extern struct llinfo_nd6 llinfo_nd6;
 731 extern struct nd_drhead nd_defrouter;
 732 extern struct nd_prhead nd_prefix;
 733 extern int nd6_debug;
 734 extern int nd6_onlink_ns_rfc4861;
 735 extern int nd6_optimistic_dad;
 736
 737 #define nd6log(x)       do { if (nd6_debug >= 1) log x; } while (0)
 738 #define nd6log2(x)      do { if (nd6_debug >= 2) log x; } while (0)
 739
 740 #define ND6_OPTIMISTIC_DAD_LINKLOCAL    (1 << 0)
 741 #define ND6_OPTIMISTIC_DAD_AUTOCONF     (1 << 1)
 742 #define ND6_OPTIMISTIC_DAD_TEMPORARY    (1 << 2)
 743 #define ND6_OPTIMISTIC_DAD_DYNAMIC      (1 << 3)
 744 #define ND6_OPTIMISTIC_DAD_SECURED      (1 << 4)
 745 #define ND6_OPTIMISTIC_DAD_MANUAL       (1 << 5)
 746
 747 /* nd6_rtr.c */
 748 extern int nd6_defifindex;
 749 extern int ip6_desync_factor;   /* seconds */
 750 /* ND6_INFINITE_LIFETIME does not apply to temporary addresses */
 751 extern u_int32_t ip6_temp_preferred_lifetime; /* seconds */
 752 extern u_int32_t ip6_temp_valid_lifetime; /* seconds */
 753 extern int ip6_temp_regen_advance; /* seconds */
 754
 755 union nd_opts {
 756         struct nd_opt_hdr *nd_opt_array[8];     /* max = target address list */
 757         struct {
 758                 struct nd_opt_hdr *zero;
 759                 struct nd_opt_hdr *src_lladdr;
 760                 struct nd_opt_hdr *tgt_lladdr;
 761                 struct nd_opt_prefix_info *pi_beg; /* multiple opts, start */
 762                 struct nd_opt_rd_hdr *rh;
 763                 struct nd_opt_mtu *mtu;
 764                 struct nd_opt_hdr *search;      /* multiple opts */
 765                 struct nd_opt_hdr *last;        /* multiple opts */
 766                 int done;
 767                 struct nd_opt_prefix_info *pi_end; /* multiple opts, end */
 768         } nd_opt_each;
 769 };
 770 #define nd_opts_src_lladdr      nd_opt_each.src_lladdr
 771 #define nd_opts_tgt_lladdr      nd_opt_each.tgt_lladdr
 772 #define nd_opts_pi              nd_opt_each.pi_beg
 773 #define nd_opts_pi_end          nd_opt_each.pi_end
 774 #define nd_opts_rh              nd_opt_each.rh
 775 #define nd_opts_mtu             nd_opt_each.mtu
 776 #define nd_opts_search          nd_opt_each.search
 777 #define nd_opts_last            nd_opt_each.last
 778 #define nd_opts_done            nd_opt_each.done
 779
 780 /* XXX: need nd6_var.h?? */
 781 /* nd6.c */
 782 extern int nd6_sched_timeout_want;
 783 extern void nd6_sched_timeout(struct timeval *, struct timeval *);
 784 extern void nd6_init(void);
 785 extern void nd6_ifreset(struct ifnet *ifp);
 786 extern void nd6_ifattach(struct ifnet *);
 787 extern int nd6_is_addr_neighbor(struct sockaddr_in6 *, struct ifnet *, int);
 788 extern void nd6_option_init(void *, int, union nd_opts *);
 789 extern struct nd_opt_hdr *nd6_option(union nd_opts *);
 790 extern int nd6_options(union nd_opts *);
 791 extern struct rtentry *nd6_lookup(struct in6_addr *, int, struct ifnet *, int);
 792 extern void nd6_setmtu(struct ifnet *);
 793 extern void nd6_purge(struct ifnet *);
 794 extern void nd6_free(struct rtentry *);
 795 extern void nd6_nud_hint(struct rtentry *, struct in6_addr *, int);
 796 extern int nd6_resolve(struct ifnet *, struct rtentry *,
 797     struct mbuf *, struct sockaddr *, u_char *);
 798 extern void nd6_rtrequest(int, struct rtentry *, struct sockaddr *);
 799 extern int nd6_ioctl(u_long, caddr_t, struct ifnet *);
 800 extern void nd6_cache_lladdr(struct ifnet *, struct in6_addr *,
 801     char *, int, int, int);
 802 extern int nd6_output_list(struct ifnet *, struct ifnet *, struct mbuf *,
 803     struct sockaddr_in6 *, struct rtentry *, struct flowadv *);
 804 extern int nd6_output(struct ifnet *, struct ifnet *, struct mbuf *,
 805     struct sockaddr_in6 *, struct rtentry *, struct flowadv *);
 806 extern int nd6_storelladdr(struct ifnet *, struct rtentry *, struct mbuf *,
 807     struct sockaddr *, u_char *);
 808 extern int nd6_need_cache(struct ifnet *);
 809 extern void nd6_drain(void *);
 810 extern void nd6_post_msg(u_int32_t, struct nd_prefix_list *, u_int32_t,
 811     u_int32_t, char *, u_int32_t);
 812 extern int nd6_setifinfo(struct ifnet *, u_int32_t, u_int32_t);
 813 extern void ln_setexpire(struct llinfo_nd6 *, uint64_t);
 814
 815 /* nd6_nbr.c */
 816 extern void nd6_nbr_init(void);
 817 extern void nd6_na_input(struct mbuf *, int, int);
 818 extern void nd6_na_output(struct ifnet *, const struct in6_addr *,
 819     const struct in6_addr *, u_int32_t, int, struct sockaddr *);
 820 extern void nd6_ns_input(struct mbuf *, int, int);
 821 extern void nd6_ns_output(struct ifnet *, const struct in6_addr *,
 822     const struct in6_addr *, struct llinfo_nd6 *, int);
 823 extern caddr_t nd6_ifptomac(struct ifnet *);
 824 extern void nd6_dad_start(struct ifaddr *, int *);
 825 extern void nd6_dad_stop(struct ifaddr *);
 826 extern void nd6_dad_duplicated(struct ifaddr *);
 827 extern void nd6_llreach_alloc(struct rtentry *, struct ifnet *, void *,
 828     unsigned int, boolean_t);
 829 extern void nd6_llreach_set_reachable(struct ifnet *, void *, unsigned int);
 830 extern void nd6_llreach_use(struct llinfo_nd6 *);
 831 extern void nd6_alt_node_addr_decompose(struct ifnet *, struct sockaddr *,
 832     struct sockaddr_dl *, struct sockaddr_in6 *);
 833 extern void nd6_alt_node_present(struct ifnet *, struct sockaddr_in6 *,
 834     struct sockaddr_dl *, int32_t, int, int);
 835 extern void nd6_alt_node_absent(struct ifnet *, struct sockaddr_in6 *);
 836
 837 /* nd6_rtr.c */
 838 extern void nd6_rtr_init(void);
 839 extern void nd6_rs_input(struct mbuf *, int, int);
 840 extern void nd6_ra_input(struct mbuf *, int, int);
 841 extern void prelist_del(struct nd_prefix *);
 842 extern void defrouter_select(struct ifnet *);
 843 extern void defrouter_reset(void);
 844 extern int defrtrlist_ioctl(u_long, caddr_t);
 845 extern void defrtrlist_del(struct nd_defrouter *);
 846 extern int defrtrlist_add_static(struct nd_defrouter *);
 847 extern int defrtrlist_del_static(struct nd_defrouter *);
 848 extern void prelist_remove(struct nd_prefix *);
 849 extern int prelist_update(struct nd_prefix *, struct nd_defrouter *,
 850     struct mbuf *, int);
 851 extern int nd6_prelist_add(struct nd_prefix *, struct nd_defrouter *,
 852     struct nd_prefix **, boolean_t);
 853 extern int nd6_prefix_onlink(struct nd_prefix *);
 854 extern int nd6_prefix_onlink_scoped(struct nd_prefix *, unsigned int);
 855 extern int nd6_prefix_offlink(struct nd_prefix *);
 856 extern void pfxlist_onlink_check(void);
 857 extern struct nd_defrouter *defrouter_lookup(struct in6_addr *, struct ifnet *);
 858 extern struct nd_prefix *nd6_prefix_lookup(struct nd_prefix *, int);
 859 extern int in6_init_prefix_ltimes(struct nd_prefix *ndpr);
 860 extern void rt6_flush(struct in6_addr *, struct ifnet *);
 861 extern int nd6_setdefaultiface(int);
 862 extern int in6_tmpifadd(const struct in6_ifaddr *, int);
 863 extern void nddr_addref(struct nd_defrouter *, int);
 864 extern struct nd_defrouter *nddr_remref(struct nd_defrouter *, int);
 865 extern uint64_t nddr_getexpire(struct nd_defrouter *);
 866 extern void ndpr_addref(struct nd_prefix *, int);
 867 extern struct nd_prefix *ndpr_remref(struct nd_prefix *, int);
 868 extern uint64_t ndpr_getexpire(struct nd_prefix *);
 869
 870 /* nd6_prproxy.c */
 871 struct ip6_hdr;
 872 extern u_int32_t nd6_prproxy;
 873 extern void nd6_prproxy_init(void);
 874 extern int nd6_if_prproxy(struct ifnet *, boolean_t);
 875 extern void nd6_prproxy_prelist_update(struct nd_prefix *, struct nd_prefix *);
 876 extern boolean_t nd6_prproxy_ifaddr(struct in6_ifaddr *);
 877 extern void nd6_proxy_find_fwdroute(struct ifnet *, struct route_in6 *);
 878 extern boolean_t nd6_prproxy_isours(struct mbuf *, struct ip6_hdr *,
 879     struct route_in6 *, unsigned int);
 880 extern void nd6_prproxy_ns_output(struct ifnet *, struct ifnet *,
 881     struct in6_addr *, struct in6_addr *, struct llinfo_nd6 *);
 882 extern void nd6_prproxy_ns_input(struct ifnet *, struct in6_addr *,
 883     char *, int, struct in6_addr *, struct in6_addr *);
 884 extern void nd6_prproxy_na_input(struct ifnet *, struct in6_addr *,
 885     struct in6_addr *, struct in6_addr *, int);
 886 extern void nd6_prproxy_sols_reap(struct nd_prefix *);
 887 extern void nd6_prproxy_sols_prune(struct nd_prefix *, u_int32_t);
 888 extern int nd6_if_disable(struct ifnet *, boolean_t);
 889 #endif /* BSD_KERNEL_PRIVATE */
 890
 891 #ifdef KERNEL
 892
 893 /*
 894  *      @function nd6_lookup_ipv6
 895  *      @discussion This function will check the routing table for a cached
 896  *              neighbor discovery entry or trigger an neighbor discovery query
 897  *              to resolve the IPv6 address to a link-layer address.
 898  *              nd entries are stored in the routing table. This function will
 899  *              lookup the IPv6 destination in the routing table. If the
 900  *              destination requires forwarding to a gateway, the route of the
 901  *              gateway will be looked up. The route entry is inspected to
 902  *              determine if the link layer destination address is known. If
 903  *              unknown, neighbor discovery will be used to resolve the entry.
 904  *      @param interface The interface the packet is being sent on.
 905  *      @param ip6_dest The IPv6 destination of the packet.
 906  *      @param ll_dest On output, the link-layer destination.
 907  *      @param ll_dest_len The length of the buffer for ll_dest.
 908  *      @param hint Any routing hint passed down from the protocol.
 909  *      @param packet The packet being transmitted.
 910  *      @result May return an error such as EHOSTDOWN or ENETUNREACH. If
 911  *              this function returns EJUSTRETURN, the packet has been queued
 912  *              and will be sent when the address is resolved. If any other
 913  *              value is returned, the caller is responsible for disposing of
 914  *              the packet.
 915  */
 916 extern errno_t nd6_lookup_ipv6(ifnet_t interface,
 917     const struct sockaddr_in6 *ip6_dest, struct sockaddr_dl *ll_dest,
 918     size_t ll_dest_len, route_t hint, mbuf_t packet);
 919
 920 #endif /* KERNEL */
 921
 922 /* nd6_send.c */
 923 #ifdef BSD_KERNEL_PRIVATE
 924 /*
 925  * nd6_send_opmode
 926  *
 927  *      value   using CGA       tx SEND         rx SEND
 928  *   --------   ---------       -------         -------
 929  *   DISABLED          NO            NO              NO
 930  *      QUIET         YES            NO              NO
 931  */
 932 extern int nd6_send_opstate;
 933
 934 #define ND6_SEND_OPMODE_DISABLED        0
 935 #define ND6_SEND_OPMODE_CGA_QUIET       1
 936
 937 #endif /* BSD_KERNEL_PRIVATE */
 938 #endif /* _NETINET6_ND6_H_ */