bsd/netinet6/nd6.h

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