bsd/netinet6/nd6.h

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