bsd/netinet6/in6_var.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 /*
  30  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
  31  * All rights reserved.
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions
  35  * are met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. Neither the name of the project nor the names of its contributors
  42  *    may be used to endorse or promote products derived from this software
  43  *    without specific prior written permission.
  44  *
  45  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  48  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  49  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  55  * SUCH DAMAGE.
  56  */
  57
  58 /*
  59  * Copyright (c) 1985, 1986, 1993
  60  *      The Regents of the University of California.  All rights reserved.
  61  *
  62  * Redistribution and use in source and binary forms, with or without
  63  * modification, are permitted provided that the following conditions
  64  * are met:
  65  * 1. Redistributions of source code must retain the above copyright
  66  *    notice, this list of conditions and the following disclaimer.
  67  * 2. Redistributions in binary form must reproduce the above copyright
  68  *    notice, this list of conditions and the following disclaimer in the
  69  *    documentation and/or other materials provided with the distribution.
  70  * 3. All advertising materials mentioning features or use of this software
  71  *    must display the following acknowledgement:
  72  *      This product includes software developed by the University of
  73  *      California, Berkeley and its contributors.
  74  * 4. Neither the name of the University nor the names of its contributors
  75  *    may be used to endorse or promote products derived from this software
  76  *    without specific prior written permission.
  77  *
  78  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  79  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  80  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  81  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  82  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  83  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  84  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  85  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  86  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  87  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  88  * SUCH DAMAGE.
  89  *
  90  *      @(#)in_var.h    8.1 (Berkeley) 6/10/93
  91  */
  92
  93 #ifndef _NETINET6_IN6_VAR_H_
  94 #define _NETINET6_IN6_VAR_H_
  95 #include <sys/appleapiopts.h>
  96
  97 #ifdef BSD_KERNEL_PRIVATE
  98 #include <sys/tree.h>
  99 #include <sys/mcache.h>
 100 #endif /* BSD_KERNEL_PRIVATE */
 101 #include <netinet6/scope6_var.h>
 102 #include <sys/kern_event.h>
 103 #include <net/ethernet.h>
 104
 105 /*
 106  * pltime/vltime are just for future reference (required to implements 2
 107  * hour rule for hosts).  they should never be modified by nd6_timeout or
 108  * anywhere else.
 109  *      userland -> kernel: accept pltime/vltime
 110  *      kernel -> userland: throw up everything
 111  *      in kernel: modify preferred/expire only
 112  */
 113 struct in6_addrlifetime {
 114         time_t ia6t_expire;     /* valid lifetime expiration time */
 115         time_t ia6t_preferred;  /* preferred lifetime expiration time */
 116         u_int32_t ia6t_vltime;  /* valid lifetime */
 117         u_int32_t ia6t_pltime;  /* prefix lifetime */
 118 };
 119
 120 #ifdef BSD_KERNEL_PRIVATE
 121 struct in6_addrlifetime_32 {
 122         u_int32_t ia6t_expire;
 123         u_int32_t ia6t_preferred;
 124         u_int32_t ia6t_vltime;
 125         u_int32_t ia6t_pltime;
 126 };
 127
 128 struct in6_addrlifetime_64 {
 129         u_int64_t ia6t_expire;
 130         u_int64_t ia6t_preferred;
 131         u_int32_t ia6t_vltime;
 132         u_int32_t ia6t_pltime;
 133 };
 134
 135 /*
 136  * Internal representation of ia6_lifetime (expiration in uptime unit)
 137  */
 138 struct in6_addrlifetime_i {
 139         u_int64_t ia6ti_expire;         /* valid lifetime expiration time */
 140         u_int64_t ia6ti_preferred;      /* preferred lifetime expiration time */
 141         u_int32_t ia6ti_vltime;         /* valid lifetime */
 142         u_int32_t ia6ti_pltime;         /* prefix lifetime */
 143         u_int64_t ia6ti_base_calendartime; /* calendar time at creation */
 144         u_int64_t ia6ti_base_uptime;    /* uptime at creation */
 145 };
 146
 147 /*
 148  * Interface address, IPv6 version.  One of these structures
 149  * is allocated for each interface with an IPv6 address.
 150  * The ifaddr structure contains the protocol-independent part
 151  * of the structure and is assumed to be first.
 152  */
 153
 154 struct in6_ifaddr {
 155         struct ifaddr ia_ifa;           /* protocol-independent info */
 156 #define ia_ifp          ia_ifa.ifa_ifp
 157 #define ia_flags        ia_ifa.ifa_flags
 158         struct sockaddr_in6 ia_addr;    /* interface address */
 159         struct sockaddr_in6 ia_net;     /* network number of interface */
 160         struct sockaddr_in6 ia_dstaddr; /* space for destination addr */
 161         struct sockaddr_in6 ia_prefixmask; /* prefix mask */
 162         u_int32_t ia_plen;              /* prefix length */
 163         struct in6_ifaddr *ia_next;     /* next in6 list of IP6 addresses */
 164         int ia6_flags;
 165
 166         struct in6_addrlifetime_i ia6_lifetime;
 167         /*
 168          * the creation time of this address, which is
 169          * currently used for temporary addresses only.
 170          */
 171         u_int64_t ia6_createtime;
 172         u_int64_t ia6_updatetime;
 173
 174         struct ifprefix *ia6_ifpr;      /* back pointer to ifprefix */
 175
 176         /* back pointer to the ND prefix (for autoconfigured addresses only) */
 177         struct nd_prefix *ia6_ndpr;
 178
 179         /* multicast addresses joined from the kernel */
 180         LIST_HEAD(, in6_multi_mship) ia6_memberships;
 181 };
 182
 183 #define ifatoia6(ifa)   ((struct in6_ifaddr *)(void *)(ifa))
 184 #endif /* BSD_KERNEL_PRIVATE */
 185
 186 /* control structure to manage address selection policy */
 187 struct in6_addrpolicy {
 188         struct sockaddr_in6 addr; /* prefix address */
 189         struct sockaddr_in6 addrmask; /* prefix mask */
 190         int preced;             /* precedence */
 191         int label;              /* matching label */
 192         u_quad_t use;           /* statistics */
 193 };
 194
 195 /*
 196  * IPv6 interface statistics, as defined in RFC2465 Ipv6IfStatsEntry (p12).
 197  */
 198 struct in6_ifstat {
 199         u_quad_t ifs6_in_receive;       /* # of total input datagram */
 200         u_quad_t ifs6_in_hdrerr;        /* # of datagrams with invalid hdr */
 201         u_quad_t ifs6_in_toobig;        /* # of datagrams exceeded MTU */
 202         u_quad_t ifs6_in_noroute;       /* # of datagrams with no route */
 203         u_quad_t ifs6_in_addrerr;       /* # of datagrams with invalid dst */
 204         u_quad_t ifs6_in_protounknown;  /* # of datagrams with unknown proto */
 205                                         /* NOTE: increment on final dst if */
 206         u_quad_t ifs6_in_truncated;     /* # of truncated datagrams */
 207         u_quad_t ifs6_in_discard;       /* # of discarded datagrams */
 208                                         /* NOTE: fragment timeout is not here */
 209         u_quad_t ifs6_in_deliver;       /* # of datagrams delivered to ULP */
 210                                         /* NOTE: increment on final dst if */
 211         u_quad_t ifs6_out_forward;      /* # of datagrams forwarded */
 212                                         /* NOTE: increment on outgoing if */
 213         u_quad_t ifs6_out_request;      /* # of outgoing datagrams from ULP */
 214                                         /* NOTE: does not include forwrads */
 215         u_quad_t ifs6_out_discard;      /* # of discarded datagrams */
 216         u_quad_t ifs6_out_fragok;       /* # of datagrams fragmented */
 217         u_quad_t ifs6_out_fragfail;     /* # of datagrams failed on fragment */
 218         u_quad_t ifs6_out_fragcreat;    /* # of fragment datagrams */
 219                                         /* NOTE: this is # after fragment */
 220         u_quad_t ifs6_reass_reqd;       /* # of incoming fragmented packets */
 221                                         /* NOTE: increment on final dst if */
 222         u_quad_t ifs6_reass_ok;         /* # of reassembled packets */
 223                                         /* NOTE: this is # after reass */
 224                                         /* NOTE: increment on final dst if */
 225         u_quad_t ifs6_reass_fail;       /* # of reass failures */
 226                                         /* NOTE: may not be packet count */
 227                                         /* NOTE: increment on final dst if */
 228         u_quad_t ifs6_in_mcast;         /* # of inbound multicast datagrams */
 229         u_quad_t ifs6_out_mcast;        /* # of outbound multicast datagrams */
 230 };
 231
 232 /*
 233  * ICMPv6 interface statistics, as defined in RFC2466 Ipv6IfIcmpEntry.
 234  * XXX: I'm not sure if this file is the right place for this structure...
 235  */
 236 struct icmp6_ifstat {
 237         /*
 238          * Input statistics
 239          */
 240         /* ipv6IfIcmpInMsgs, total # of input messages */
 241         u_quad_t ifs6_in_msg;
 242         /* ipv6IfIcmpInErrors, # of input error messages */
 243         u_quad_t ifs6_in_error;
 244         /* ipv6IfIcmpInDestUnreachs, # of input dest unreach errors */
 245         u_quad_t ifs6_in_dstunreach;
 246         /* ipv6IfIcmpInAdminProhibs, # of input admin. prohibited errs */
 247         u_quad_t ifs6_in_adminprohib;
 248         /* ipv6IfIcmpInTimeExcds, # of input time exceeded errors */
 249         u_quad_t ifs6_in_timeexceed;
 250         /* ipv6IfIcmpInParmProblems, # of input parameter problem errors */
 251         u_quad_t ifs6_in_paramprob;
 252         /* ipv6IfIcmpInPktTooBigs, # of input packet too big errors */
 253         u_quad_t ifs6_in_pkttoobig;
 254         /* ipv6IfIcmpInEchos, # of input echo requests */
 255         u_quad_t ifs6_in_echo;
 256         /* ipv6IfIcmpInEchoReplies, # of input echo replies */
 257         u_quad_t ifs6_in_echoreply;
 258         /* ipv6IfIcmpInRouterSolicits, # of input router solicitations */
 259         u_quad_t ifs6_in_routersolicit;
 260         /* ipv6IfIcmpInRouterAdvertisements, # of input router advertisements */
 261         u_quad_t ifs6_in_routeradvert;
 262         /* ipv6IfIcmpInNeighborSolicits, # of input neighbor solicitations */
 263         u_quad_t ifs6_in_neighborsolicit;
 264         /* ipv6IfIcmpInNeighborAdvertisements, # of input neighbor advs. */
 265         u_quad_t ifs6_in_neighboradvert;
 266         /* ipv6IfIcmpInRedirects, # of input redirects */
 267         u_quad_t ifs6_in_redirect;
 268         /* ipv6IfIcmpInGroupMembQueries, # of input MLD queries */
 269         u_quad_t ifs6_in_mldquery;
 270         /* ipv6IfIcmpInGroupMembResponses, # of input MLD reports */
 271         u_quad_t ifs6_in_mldreport;
 272         /* ipv6IfIcmpInGroupMembReductions, # of input MLD done */
 273         u_quad_t ifs6_in_mlddone;
 274
 275         /*
 276          * Output statistics. We should solve unresolved routing problem...
 277          */
 278         /* ipv6IfIcmpOutMsgs, total # of output messages */
 279         u_quad_t ifs6_out_msg;
 280         /* ipv6IfIcmpOutErrors, # of output error messages */
 281         u_quad_t ifs6_out_error;
 282         /* ipv6IfIcmpOutDestUnreachs, # of output dest unreach errors */
 283         u_quad_t ifs6_out_dstunreach;
 284         /* ipv6IfIcmpOutAdminProhibs, # of output admin. prohibited errs */
 285         u_quad_t ifs6_out_adminprohib;
 286         /* ipv6IfIcmpOutTimeExcds, # of output time exceeded errors */
 287         u_quad_t ifs6_out_timeexceed;
 288         /* ipv6IfIcmpOutParmProblems, # of output parameter problem errors */
 289         u_quad_t ifs6_out_paramprob;
 290         /* ipv6IfIcmpOutPktTooBigs, # of output packet too big errors */
 291         u_quad_t ifs6_out_pkttoobig;
 292         /* ipv6IfIcmpOutEchos, # of output echo requests */
 293         u_quad_t ifs6_out_echo;
 294         /* ipv6IfIcmpOutEchoReplies, # of output echo replies */
 295         u_quad_t ifs6_out_echoreply;
 296         /* ipv6IfIcmpOutRouterSolicits, # of output router solicitations */
 297         u_quad_t ifs6_out_routersolicit;
 298         /* ipv6IfIcmpOutRouterAdvertisements, # of output router advs. */
 299         u_quad_t ifs6_out_routeradvert;
 300         /* ipv6IfIcmpOutNeighborSolicits, # of output neighbor solicitations */
 301         u_quad_t ifs6_out_neighborsolicit;
 302         /* ipv6IfIcmpOutNeighborAdvertisements, # of output neighbor advs. */
 303         u_quad_t ifs6_out_neighboradvert;
 304         /* ipv6IfIcmpOutRedirects, # of output redirects */
 305         u_quad_t ifs6_out_redirect;
 306         /* ipv6IfIcmpOutGroupMembQueries, # of output MLD queries */
 307         u_quad_t ifs6_out_mldquery;
 308         /* ipv6IfIcmpOutGroupMembResponses, # of output MLD reports */
 309         u_quad_t ifs6_out_mldreport;
 310         /* ipv6IfIcmpOutGroupMembReductions, # of output MLD done */
 311         u_quad_t ifs6_out_mlddone;
 312 };
 313
 314 struct in6_ifreq {
 315         char    ifr_name[IFNAMSIZ];
 316         union {
 317                 struct  sockaddr_in6 ifru_addr;
 318                 struct  sockaddr_in6 ifru_dstaddr;
 319                 int     ifru_flags;
 320                 int     ifru_flags6;
 321                 int     ifru_metric;
 322                 int     ifru_intval;
 323                 caddr_t ifru_data;
 324                 struct in6_addrlifetime ifru_lifetime;
 325                 struct in6_ifstat ifru_stat;
 326                 struct icmp6_ifstat ifru_icmp6stat;
 327                 u_int32_t ifru_scope_id[SCOPE6_ID_MAX];
 328         } ifr_ifru;
 329 };
 330
 331 struct in6_aliasreq {
 332         char    ifra_name[IFNAMSIZ];
 333         struct  sockaddr_in6 ifra_addr;
 334         struct  sockaddr_in6 ifra_dstaddr;
 335         struct  sockaddr_in6 ifra_prefixmask;
 336         int     ifra_flags;
 337         struct in6_addrlifetime ifra_lifetime;
 338 };
 339
 340 #ifdef PRIVATE
 341 #define IN6_CGA_MODIFIER_LENGTH 16
 342
 343 struct in6_cga_modifier {
 344         u_int8_t octets[IN6_CGA_MODIFIER_LENGTH];
 345 };
 346
 347 struct in6_cga_prepare {
 348         struct in6_cga_modifier cga_modifier;
 349         u_int8_t cga_security_level;
 350         u_int8_t reserved_A[15];
 351 };
 352
 353 #define IN6_CGA_KEY_MAXSIZE     2048    /* octets */
 354
 355 struct in6_cga_nodecfg {
 356         struct iovec cga_privkey;
 357         struct iovec cga_pubkey;
 358         struct in6_cga_prepare cga_prepare;
 359 };
 360
 361 struct in6_llstartreq {
 362         char llsr_name[IFNAMSIZ];
 363         int llsr_flags;
 364         struct in6_cga_prepare llsr_cgaprep;
 365         struct in6_addrlifetime llsr_lifetime;
 366 };
 367
 368 #ifdef BSD_KERNEL_PRIVATE
 369 struct in6_llstartreq_32 {
 370         char llsr_name[IFNAMSIZ];
 371         int llsr_flags;
 372         struct in6_cga_prepare llsr_cgaprep;
 373         struct in6_addrlifetime_32 llsr_lifetime;
 374 };
 375
 376 struct in6_llstartreq_64 {
 377         char llsr_name[IFNAMSIZ];
 378         int llsr_flags;
 379         struct in6_cga_prepare llsr_cgaprep;
 380         struct in6_addrlifetime_64 llsr_lifetime;
 381 };
 382 #endif /* !BSD_KERNEL_PRIVATE */
 383 #endif /* PRIVATE */
 384
 385 #ifdef BSD_KERNEL_PRIVATE
 386 struct in6_aliasreq_32 {
 387         char    ifra_name[IFNAMSIZ];
 388         struct  sockaddr_in6 ifra_addr;
 389         struct  sockaddr_in6 ifra_dstaddr;
 390         struct  sockaddr_in6 ifra_prefixmask;
 391         int     ifra_flags;
 392         struct in6_addrlifetime_32 ifra_lifetime;
 393 };
 394
 395 struct in6_aliasreq_64 {
 396         char    ifra_name[IFNAMSIZ];
 397         struct  sockaddr_in6 ifra_addr;
 398         struct  sockaddr_in6 ifra_dstaddr;
 399         struct  sockaddr_in6 ifra_prefixmask;
 400         int     ifra_flags;
 401         struct in6_addrlifetime_64 ifra_lifetime;
 402 };
 403 #endif /* BSD_KERNEL_PRIVATE */
 404
 405 /* prefix type macro */
 406 #define IN6_PREFIX_ND   1
 407 #define IN6_PREFIX_RR   2
 408
 409 /*
 410  * prefix related flags passed between kernel(NDP related part) and
 411  * user land command(ifconfig) and daemon(rtadvd).
 412  */
 413 struct in6_prflags {
 414         struct prf_ra {
 415                 u_char onlink : 1;
 416                 u_char autonomous : 1;
 417                 u_char reserved : 6;
 418         } prf_ra;
 419         u_char prf_reserved1;
 420         u_short prf_reserved2;
 421         /* want to put this on 4byte offset */
 422         struct prf_rr {
 423                 u_char decrvalid : 1;
 424                 u_char decrprefd : 1;
 425                 u_char reserved : 6;
 426         } prf_rr;
 427         u_char prf_reserved3;
 428         u_short prf_reserved4;
 429 };
 430
 431 struct  in6_prefixreq {
 432         char    ipr_name[IFNAMSIZ];
 433         u_char  ipr_origin;
 434         u_char  ipr_plen;
 435         u_int32_t ipr_vltime;
 436         u_int32_t ipr_pltime;
 437         struct in6_prflags ipr_flags;
 438         struct  sockaddr_in6 ipr_prefix;
 439 };
 440
 441 #define PR_ORIG_RA      0
 442 #define PR_ORIG_RR      1
 443 #define PR_ORIG_STATIC  2
 444 #define PR_ORIG_KERNEL  3
 445
 446 #define ipr_raf_onlink          ipr_flags.prf_ra.onlink
 447 #define ipr_raf_auto            ipr_flags.prf_ra.autonomous
 448
 449 #define ipr_statef_onlink       ipr_flags.prf_state.onlink
 450
 451 #define ipr_rrf_decrvalid       ipr_flags.prf_rr.decrvalid
 452 #define ipr_rrf_decrprefd       ipr_flags.prf_rr.decrprefd
 453
 454 struct in6_rrenumreq {
 455         char    irr_name[IFNAMSIZ];
 456         u_char  irr_origin;
 457         u_char  irr_m_len;      /* match len for matchprefix */
 458         u_char  irr_m_minlen;   /* minlen for matching prefix */
 459         u_char  irr_m_maxlen;   /* maxlen for matching prefix */
 460         u_char  irr_u_uselen;   /* uselen for adding prefix */
 461         u_char  irr_u_keeplen;  /* keeplen from matching prefix */
 462         struct irr_raflagmask {
 463                 u_char onlink : 1;
 464                 u_char autonomous : 1;
 465                 u_char reserved : 6;
 466         } irr_raflagmask;
 467         u_int32_t irr_vltime;
 468         u_int32_t irr_pltime;
 469         struct in6_prflags irr_flags;
 470         struct  sockaddr_in6 irr_matchprefix;
 471         struct  sockaddr_in6 irr_useprefix;
 472 };
 473
 474 #define irr_raf_mask_onlink     irr_raflagmask.onlink
 475 #define irr_raf_mask_auto       irr_raflagmask.autonomous
 476 #define irr_raf_mask_reserved   irr_raflagmask.reserved
 477
 478 #define irr_raf_onlink          irr_flags.prf_ra.onlink
 479 #define irr_raf_auto            irr_flags.prf_ra.autonomous
 480
 481 #define irr_statef_onlink       irr_flags.prf_state.onlink
 482
 483 #define irr_rrf                 irr_flags.prf_rr
 484 #define irr_rrf_decrvalid       irr_flags.prf_rr.decrvalid
 485 #define irr_rrf_decrprefd       irr_flags.prf_rr.decrprefd
 486
 487 /*
 488  * Event data, inet6 style.
 489  */
 490 struct kev_in6_addrlifetime {
 491         u_int32_t ia6t_expire;
 492         u_int32_t ia6t_preferred;
 493         u_int32_t ia6t_vltime;
 494         u_int32_t ia6t_pltime;
 495 };
 496
 497 struct kev_in6_data {
 498         struct net_event_data link_data;
 499         struct sockaddr_in6 ia_addr;    /* interface address */
 500         struct sockaddr_in6 ia_net;     /* network number of interface */
 501         struct sockaddr_in6 ia_dstaddr; /* space for destination addr */
 502         struct sockaddr_in6 ia_prefixmask; /* prefix mask */
 503         u_int32_t ia_plen;              /* prefix length */
 504         u_int32_t ia6_flags;            /* address flags from in6_ifaddr */
 505         struct kev_in6_addrlifetime ia_lifetime; /* address life info */
 506         uint8_t ia_mac[ETHER_ADDR_LEN];
 507 };
 508
 509 /*
 510  * Define inet6 event subclass and specific inet6 events.
 511  */
 512 #define KEV_INET6_SUBCLASS              6 /* inet6 subclass identifier */
 513
 514 #define KEV_INET6_NEW_USER_ADDR         1 /* Userland configured IPv6 address */
 515 #define KEV_INET6_CHANGED_ADDR          2 /* Address changed event (future) */
 516 #define KEV_INET6_ADDR_DELETED          3 /* IPv6 address was deleted */
 517 #define KEV_INET6_NEW_LL_ADDR           4 /* Autoconf LL address appeared */
 518 #define KEV_INET6_NEW_RTADV_ADDR        5 /* Autoconf address has appeared */
 519 #define KEV_INET6_DEFROUTER             6 /* Default router detected */
 520
 521 #ifdef BSD_KERNEL_PRIVATE
 522 /* Utility function used inside netinet6 kernel code for generating events */
 523 void in6_post_msg(struct ifnet *, u_int32_t, struct in6_ifaddr *, uint8_t *mac);
 524
 525 #define IN6_ARE_MASKED_ADDR_EQUAL(d, a, m)      (       \
 526         (((d)->s6_addr32[0] ^ (a)->s6_addr32[0]) & (m)->s6_addr32[0]) == 0 && \
 527         (((d)->s6_addr32[1] ^ (a)->s6_addr32[1]) & (m)->s6_addr32[1]) == 0 && \
 528         (((d)->s6_addr32[2] ^ (a)->s6_addr32[2]) & (m)->s6_addr32[2]) == 0 && \
 529         (((d)->s6_addr32[3] ^ (a)->s6_addr32[3]) & (m)->s6_addr32[3]) == 0)
 530
 531 /*
 532  * Given a pointer to an in6_ifaddr (ifaddr),
 533  * return a pointer to the addr as a sockaddr_in6
 534  */
 535 #define IA6_IN6(ia)     (&((ia)->ia_addr.sin6_addr))
 536 #define IA6_DSTIN6(ia)  (&((ia)->ia_dstaddr.sin6_addr))
 537 #define IA6_MASKIN6(ia) (&((ia)->ia_prefixmask.sin6_addr))
 538 #define IA6_SIN6(ia)    (&((ia)->ia_addr))
 539 #define IA6_DSTSIN6(ia) (&((ia)->ia_dstaddr))
 540 #define IFA_IN6(x)      \
 541         (&((struct sockaddr_in6 *)(void *)((x)->ifa_addr))->sin6_addr)
 542 #define IFA_DSTIN6(x)   \
 543         (&((struct sockaddr_in6 *)(void *)((x)->ifa_dstaddr))->sin6_addr)
 544 #define IFPR_IN6(x)     \
 545         (&((struct sockaddr_in6 *)(void *)((x)->ifpr_prefix))->sin6_addr)
 546 #endif /* BSD_KERNEL_PRIVATE */
 547
 548 #define SIOCSIFADDR_IN6          _IOW('i', 12, struct in6_ifreq)
 549 #define SIOCGIFADDR_IN6         _IOWR('i', 33, struct in6_ifreq)
 550
 551 /*
 552  * SIOCSxxx ioctls should be unused (see comments in in6.c), but
 553  * we do not shift numbers for binary compatibility.
 554  */
 555 #define SIOCSIFDSTADDR_IN6      _IOW('i', 14, struct in6_ifreq)
 556 #define SIOCSIFNETMASK_IN6      _IOW('i', 22, struct in6_ifreq)
 557
 558 #define SIOCGIFDSTADDR_IN6      _IOWR('i', 34, struct in6_ifreq)
 559 #define SIOCGIFNETMASK_IN6      _IOWR('i', 37, struct in6_ifreq)
 560
 561 #define SIOCDIFADDR_IN6         _IOW('i', 25, struct in6_ifreq)
 562 #define SIOCAIFADDR_IN6         _IOW('i', 26, struct in6_aliasreq)
 563 #ifdef BSD_KERNEL_PRIVATE
 564 #define SIOCAIFADDR_IN6_32      _IOW('i', 26, struct in6_aliasreq_32)
 565 #define SIOCAIFADDR_IN6_64      _IOW('i', 26, struct in6_aliasreq_64)
 566 #endif /* BSD_KERNEL_PRIVATE */
 567
 568 #define SIOCSIFPHYADDR_IN6      _IOW('i', 62, struct in6_aliasreq)
 569 #ifdef BSD_KERNEL_PRIVATE
 570 #define SIOCSIFPHYADDR_IN6_32   _IOW('i', 62, struct in6_aliasreq_32)
 571 #define SIOCSIFPHYADDR_IN6_64   _IOW('i', 62, struct in6_aliasreq_64)
 572 #endif /* BSD_KERNEL_PRIVATE */
 573 #define SIOCGIFPSRCADDR_IN6     _IOWR('i', 63, struct in6_ifreq)
 574 #define SIOCGIFPDSTADDR_IN6     _IOWR('i', 64, struct in6_ifreq)
 575 #define SIOCGIFAFLAG_IN6        _IOWR('i', 73, struct in6_ifreq)
 576
 577 #define SIOCGDRLST_IN6          _IOWR('i', 74, struct in6_drlist)
 578 #ifdef BSD_KERNEL_PRIVATE
 579 #define SIOCGDRLST_IN6_32       _IOWR('i', 74, struct in6_drlist_32)
 580 #define SIOCGDRLST_IN6_64       _IOWR('i', 74, struct in6_drlist_64)
 581 #endif /* BSD_KERNEL_PRIVATE */
 582
 583 #define SIOCGPRLST_IN6          _IOWR('i', 75, struct in6_prlist)
 584 #ifdef BSD_KERNEL_PRIVATE
 585 #define SIOCGPRLST_IN6_32       _IOWR('i', 75, struct in6_prlist_32)
 586 #define SIOCGPRLST_IN6_64       _IOWR('i', 75, struct in6_prlist_64)
 587 #endif /* BSD_KERNEL_PRIVATE */
 588
 589 #define OSIOCGIFINFO_IN6        _IOWR('i', 108, struct in6_ondireq)
 590 #define SIOCGIFINFO_IN6         _IOWR('i', 76, struct in6_ondireq)
 591 #define SIOCSNDFLUSH_IN6        _IOWR('i', 77, struct in6_ifreq)
 592
 593 #define SIOCGNBRINFO_IN6        _IOWR('i', 78, struct in6_nbrinfo)
 594 #ifdef BSD_KERNEL_PRIVATE
 595 #define SIOCGNBRINFO_IN6_32     _IOWR('i', 78, struct in6_nbrinfo_32)
 596 #define SIOCGNBRINFO_IN6_64     _IOWR('i', 78, struct in6_nbrinfo_64)
 597 #endif /* BSD_KERNEL_PRIVATE */
 598
 599 #define SIOCSPFXFLUSH_IN6       _IOWR('i', 79, struct in6_ifreq)
 600 #define SIOCSRTRFLUSH_IN6       _IOWR('i', 80, struct in6_ifreq)
 601
 602 #define SIOCGIFALIFETIME_IN6    _IOWR('i', 81, struct in6_ifreq)
 603 #define SIOCSIFALIFETIME_IN6    _IOWR('i', 82, struct in6_ifreq)
 604 #define SIOCGIFSTAT_IN6         _IOWR('i', 83, struct in6_ifreq)
 605 #define SIOCGIFSTAT_ICMP6       _IOWR('i', 84, struct in6_ifreq)
 606
 607 #define SIOCSDEFIFACE_IN6       _IOWR('i', 85, struct in6_ndifreq)
 608 #define SIOCGDEFIFACE_IN6       _IOWR('i', 86, struct in6_ndifreq)
 609 #ifdef BSD_KERNEL_PRIVATE
 610 #define SIOCSDEFIFACE_IN6_32    _IOWR('i', 85, struct in6_ndifreq_32)
 611 #define SIOCSDEFIFACE_IN6_64    _IOWR('i', 85, struct in6_ndifreq_64)
 612 #define SIOCGDEFIFACE_IN6_32    _IOWR('i', 86, struct in6_ndifreq_32)
 613 #define SIOCGDEFIFACE_IN6_64    _IOWR('i', 86, struct in6_ndifreq_64)
 614 #endif /* BSD_KERNEL_PRIVATE */
 615
 616 #define SIOCSIFINFO_FLAGS       _IOWR('i', 87, struct in6_ndireq) /* XXX */
 617
 618 /* N.B.: These 3 ioctls are deprecated and won't work */
 619 #define SIOCSSCOPE6             _IOW('i', 88, struct in6_ifreq)
 620 #define SIOCGSCOPE6             _IOWR('i', 89, struct in6_ifreq)
 621 #define SIOCGSCOPE6DEF          _IOWR('i', 90, struct in6_ifreq)
 622
 623 #define SIOCSIFPREFIX_IN6       _IOW('i', 100, struct in6_prefixreq) /* set */
 624 #define SIOCGIFPREFIX_IN6       _IOWR('i', 101, struct in6_prefixreq) /* get */
 625 #define SIOCDIFPREFIX_IN6       _IOW('i', 102, struct in6_prefixreq) /* del */
 626 #define SIOCAIFPREFIX_IN6       _IOW('i', 103, struct in6_rrenumreq) /* add */
 627
 628 /* change */
 629 #define SIOCCIFPREFIX_IN6       _IOW('i', 104, struct in6_rrenumreq)
 630
 631 /* set global */
 632 #define SIOCSGIFPREFIX_IN6      _IOW('i', 105, struct in6_rrenumreq)
 633
 634 /*
 635  * multicast routing, get s/g pkt cnt, pkt cnt per interface.
 636  */
 637 #define SIOCGETSGCNT_IN6        _IOWR('u', 28, struct sioc_sg_req6)
 638 #define SIOCGETMIFCNT_IN6       _IOWR('u', 107, struct sioc_mif_req6)
 639 #ifdef BSD_KERNEL_PRIVATE
 640 #define SIOCGETMIFCNT_IN6_32    _IOWR('u', 107, struct sioc_mif_req6_32)
 641 #define SIOCGETMIFCNT_IN6_64    _IOWR('u', 107, struct sioc_mif_req6_64)
 642 #endif /* BSD_KERNEL_PRIVATE */
 643
 644 #define SIOCAADDRCTL_POLICY     _IOW('u', 108, struct in6_addrpolicy)
 645 #define SIOCDADDRCTL_POLICY     _IOW('u', 109, struct in6_addrpolicy)
 646
 647 #ifdef PRIVATE
 648 /*
 649  * temporary control calls to attach/detach IPv6 to/from an interface.
 650  */
 651 #define SIOCPROTOATTACH_IN6     _IOWR('i', 110, struct in6_aliasreq)
 652 #ifdef BSD_KERNEL_PRIVATE
 653 #define SIOCPROTOATTACH_IN6_32  _IOWR('i', 110, struct in6_aliasreq_32)
 654 #define SIOCPROTOATTACH_IN6_64  _IOWR('i', 110, struct in6_aliasreq_64)
 655 #endif /* BSD_KERNEL_PRIVATE */
 656 #define SIOCPROTODETACH_IN6     _IOWR('i', 111, struct in6_ifreq)
 657
 658 /*
 659  * start/stop aquiring linklocal on interface
 660  */
 661 #define SIOCLL_START            _IOWR('i', 130, struct in6_aliasreq)
 662 #ifdef BSD_KERNEL_PRIVATE
 663 #define SIOCLL_START_32         _IOWR('i', 130, struct in6_aliasreq_32)
 664 #define SIOCLL_START_64         _IOWR('i', 130, struct in6_aliasreq_64)
 665 #endif /* BSD_KERNEL_PRIVATE */
 666 #define SIOCLL_STOP             _IOWR('i', 131, struct in6_ifreq)
 667
 668 /*
 669  * accept rtadvd (and stop accepting) on this interface.
 670  */
 671 #define SIOCAUTOCONF_START      _IOWR('i', 132, struct in6_ifreq)
 672 #define SIOCAUTOCONF_STOP       _IOWR('i', 133, struct in6_ifreq)
 673
 674 /*
 675  * add/remove default IPv6 router.
 676  */
 677 #define SIOCDRADD_IN6           _IOWR('u', 134, struct in6_defrouter)
 678 #ifdef BSD_KERNEL_PRIVATE
 679 #define SIOCDRADD_IN6_32        _IOWR('u', 134, struct in6_defrouter_32)
 680 #define SIOCDRADD_IN6_64        _IOWR('u', 134, struct in6_defrouter_64)
 681 #endif /* BSD_KERNEL_PRIVATE */
 682 #define SIOCDRDEL_IN6           _IOWR('u', 135, struct in6_defrouter)
 683 #ifdef BSD_KERNEL_PRIVATE
 684 #define SIOCDRDEL_IN6_32        _IOWR('u', 135, struct in6_defrouter_32)
 685 #define SIOCDRDEL_IN6_64        _IOWR('u', 135, struct in6_defrouter_64)
 686 #endif /* BSD_KERNEL_PRIVATE */
 687
 688 /*
 689  * enable/disable IPv6 router mode on interface.
 690  */
 691 #define SIOCSETROUTERMODE_IN6   _IOWR('i', 136, struct in6_ifreq)
 692
 693 /*
 694  * start secure link-local interface addresses
 695  */
 696 #define SIOCLL_CGASTART         _IOW('i', 160, struct in6_llstartreq)
 697 #ifdef BSD_KERNEL_PRIVATE
 698 #define SIOCLL_CGASTART_32      _IOW('i', 160, struct in6_llstartreq_32)
 699 #define SIOCLL_CGASTART_64      _IOW('i', 160, struct in6_llstartreq_64)
 700 #endif
 701 #endif /* PRIVATE */
 702
 703 #ifdef BSD_KERNEL_PRIVATE
 704 /*
 705  * XXX: Do not extend IN6_IFF values beyond 16-bit.  We currently copy the
 706  *      values from ia6_flags as is into m_pkthdr.{src,dst}_iff which are
 707  *      defined as 16-bit variables.  We can relax this once we define a
 708  *      unified set of interface flags for {ia,ia6}_flags and perform
 709  *      translation between those and the publicly-defined ones below.
 710  */
 711 #endif /* BSD_KERNEL_PRIVATE */
 712 #define IN6_IFF_ANYCAST         0x0001  /* anycast address */
 713 #define IN6_IFF_TENTATIVE       0x0002  /* tentative address */
 714 #define IN6_IFF_DUPLICATED      0x0004  /* DAD detected duplicate */
 715 #define IN6_IFF_DETACHED        0x0008  /* may be detached from the link */
 716 #define IN6_IFF_DEPRECATED      0x0010  /* deprecated address */
 717
 718 /* don't perform DAD on this address (used only at first SIOC* call) */
 719 #define IN6_IFF_NODAD           0x0020
 720
 721 #define IN6_IFF_AUTOCONF        0x0040  /* autoconfigurable address. */
 722 #define IN6_IFF_TEMPORARY       0x0080  /* temporary (anonymous) address. */
 723 #define IN6_IFF_DYNAMIC         0x0100  /* assigned by DHCPv6 service */
 724 #define IN6_IFF_OPTIMISTIC      0x0200  /* optimistic DAD, i.e. RFC 4429 */
 725 #define IN6_IFF_SECURED         0x0400  /* cryptographically generated */
 726 #ifdef PRIVATE
 727 #define IN6_IFF_SWIFTDAD        0x0800  /* DAD with no delay */
 728 #endif
 729 #define IN6_IFF_NOPFX           0x8000  /* Depreciated. Don't use. */
 730
 731 /* Duplicate Address Detection [DAD] in progress. */
 732 #define IN6_IFF_DADPROGRESS     (IN6_IFF_TENTATIVE|IN6_IFF_OPTIMISTIC)
 733
 734 /* do not input/output */
 735 #define IN6_IFF_NOTREADY        (IN6_IFF_TENTATIVE|IN6_IFF_DUPLICATED)
 736
 737 #ifdef KERNEL
 738 #define IN6_ARE_SCOPE_CMP(a, b)         ((a) - (b))
 739 #define IN6_ARE_SCOPE_EQUAL(a, b)       ((a) == (b))
 740 #endif /* KERNEL */
 741
 742 #ifdef BSD_KERNEL_PRIVATE
 743 extern struct in6_ifaddr *in6_ifaddrs;
 744
 745 extern struct icmp6stat icmp6stat;
 746 extern lck_rw_t in6_ifaddr_rwlock;
 747 extern lck_mtx_t proxy6_lock;
 748 extern u_char inet6ctlerrmap[];
 749 extern u_int32_t in6_maxmtu;
 750
 751 /* N.B.: if_inet6data is never freed once set, so we don't need to lock */
 752 #define in6_ifstat_inc_common(_ifp, _tag, _atomic) do {                 \
 753         if (_ifp != NULL && IN6_IFEXTRA(_ifp) != NULL) {                \
 754                 if (_atomic)                                            \
 755                         atomic_add_64(                                  \
 756                             &IN6_IFEXTRA(_ifp)->in6_ifstat._tag, 1);    \
 757                 else                                                    \
 758                         IN6_IFEXTRA(_ifp)->in6_ifstat._tag++;           \
 759         }                                                               \
 760 } while (0)
 761
 762 /* atomic version */
 763 #define in6_ifstat_inc(_ifp, _tag) \
 764         in6_ifstat_inc_common(_ifp, _tag, TRUE)
 765
 766 /* non-atomic version (for fast paths) */
 767 #define in6_ifstat_inc_na(_ifp, _tag) \
 768         in6_ifstat_inc_common(_ifp, _tag, FALSE)
 769
 770 /*
 771  * Macro for finding the internet address structure (in6_ifaddr) corresponding
 772  * to a given interface (ifnet structure).
 773  */
 774
 775 #define IFP_TO_IA6(ifp, ia)                                             \
 776         /* struct ifnet *ifp; */                                        \
 777         /* struct in6_ifaddr *ia; */                                    \
 778 do {                                                                    \
 779         struct ifaddr *_ifa;                                            \
 780         ifnet_lock_assert(ifp, LCK_RW_ASSERT_HELD);                     \
 781         for (_ifa = (ifp)->if_addrlist.tqh_first; _ifa != NULL;         \
 782             _ifa = _ifa->ifa_list.tqe_next) {                           \
 783                 IFA_LOCK(_ifa);                                         \
 784                 if (_ifa->ifa_addr->sa_family == AF_INET6) {            \
 785                         IFA_ADDREF_LOCKED(_ifa);                        \
 786                         IFA_UNLOCK(_ifa);                               \
 787                         break;                                          \
 788                 }                                                       \
 789                 IFA_UNLOCK(_ifa);                                       \
 790         }                                                               \
 791         (ia) = (struct in6_ifaddr *)_ifa;                               \
 792 } while (0)
 793
 794 /*
 795  * IPv6 multicast MLD-layer source entry.
 796  */
 797 struct ip6_msource {
 798         RB_ENTRY(ip6_msource)   im6s_link;      /* RB tree links */
 799         struct in6_addr         im6s_addr;
 800         struct im6s_st {
 801                 uint16_t        ex;             /* # of exclusive members */
 802                 uint16_t        in;             /* # of inclusive members */
 803         }                       im6s_st[2];     /* state at t0, t1 */
 804         uint8_t                 im6s_stp;       /* pending query */
 805 };
 806
 807 RB_HEAD(ip6_msource_tree, ip6_msource);
 808
 809 RB_PROTOTYPE_SC_PREV(__private_extern__, ip6_msource_tree, ip6_msource,
 810     im6s_link, ip6_msource_cmp);
 811
 812 /*
 813  * IPv6 multicast PCB-layer source entry.
 814  *
 815  * NOTE: overlapping use of struct ip6_msource fields at start.
 816  */
 817 struct in6_msource {
 818         RB_ENTRY(ip6_msource)   im6s_link;      /* Common field */
 819         struct in6_addr         im6s_addr;      /* Common field */
 820         uint8_t                 im6sl_st[2];    /* state before/at commit */
 821 };
 822
 823 /*
 824  * IPv6 multicast PCB-layer group filter descriptor.
 825  */
 826 struct in6_mfilter {
 827         struct ip6_msource_tree im6f_sources; /* source list for (S,G) */
 828         u_long                  im6f_nsrc;    /* # of source entries */
 829         uint8_t                 im6f_st[2];   /* state before/at commit */
 830 };
 831
 832 /*
 833  * Legacy KAME IPv6 multicast membership descriptor.
 834  */
 835 struct in6_multi_mship {
 836         struct  in6_multi *i6mm_maddr;  /* Multicast address pointer */
 837         LIST_ENTRY(in6_multi_mship) i6mm_chain;  /* multicast options chain */
 838 };
 839
 840 #ifdef BSD_KERNEL_PRIVATE
 841 #include <netinet6/nd6_var.h>
 842 /*
 843  *  * Per-interface IPv6 structures.
 844  *   */
 845 struct in6_ifextra {
 846         struct scope6_id        scope6_id;
 847         struct in6_ifstat       in6_ifstat;
 848         struct icmp6_ifstat     icmp6_ifstat;
 849         struct nd_ifinfo        nd_ifinfo;
 850         uint32_t                netsig_len;
 851         u_int8_t                netsig[IFNET_SIGNATURELEN];
 852 };
 853 #define IN6_IFEXTRA(_ifp)       ((struct in6_ifextra *)(_ifp->if_inet6data))
 854 #endif /* BSD_KERNEL_PRIVATE */
 855
 856 struct mld_ifinfo;
 857
 858 /*
 859  * IPv6 group descriptor.
 860  *
 861  * For every entry on an ifnet's if_multiaddrs list which represents
 862  * an IP multicast group, there is one of these structures.
 863  *
 864  * If any source filters are present, then a node will exist in the RB-tree
 865  * to permit fast lookup by source whenever an operation takes place.
 866  * This permits pre-order traversal when we issue reports.
 867  * Source filter trees are kept separately from the socket layer to
 868  * greatly simplify locking.
 869  *
 870  * When MLDv2 is active, in6m_timer is the response to group query timer.
 871  * The state-change timer in6m_sctimer is separate; whenever state changes
 872  * for the group the state change record is generated and transmitted,
 873  * and kept if retransmissions are necessary.
 874  *
 875  * The request count here is a count of requests for this address, not a
 876  * count of pointers to this structure.
 877  *
 878  * FUTURE: in6m_entry is now only used when groups are being purged
 879  * on a detaching ifnet.  It could be demoted to a SLIST_ENTRY.
 880  */
 881 struct in6_multi {
 882         decl_lck_mtx_data(, in6m_lock);
 883         u_int32_t in6m_refcount;        /* reference count */
 884         u_int32_t in6m_reqcnt;          /* request count for this address */
 885         u_int32_t in6m_debug;           /* see ifa_debug flags */
 886         LIST_ENTRY(in6_multi) in6m_entry; /* list glue */
 887         struct  in6_addr in6m_addr;     /* IP6 multicast address */
 888         struct  ifnet *in6m_ifp;        /* back pointer to ifnet */
 889         struct  ifmultiaddr *in6m_ifma; /* back pointer to ifmultiaddr */
 890         u_int   in6m_state;             /* state of the membership */
 891         u_int   in6m_timer;             /* MLD6 listener report timer */
 892
 893         /* New fields for MLDv2 follow. */
 894         struct mld_ifinfo       *in6m_mli;      /* MLD info */
 895         SLIST_ENTRY(in6_multi)   in6m_dtle;     /* detached waiting for rele  */
 896         SLIST_ENTRY(in6_multi)   in6m_nrele;    /* to-be-released by MLD */
 897         u_int32_t                in6m_nrelecnt; /* deferred release count */
 898         struct ip6_msource_tree  in6m_srcs;     /* tree of sources */
 899         u_long                   in6m_nsrc;     /* # of tree entries */
 900
 901         struct ifqueue           in6m_scq;  /* pending state-change packets */
 902         struct timeval           in6m_lastgsrtv;        /* last G-S-R query */
 903         uint16_t                 in6m_sctimer;  /* state-change timer */
 904         uint16_t                 in6m_scrv;     /* state-change rexmit count */
 905
 906         /*
 907          * SSM state counters which track state at T0 (the time the last
 908          * state-change report's RV timer went to zero) and T1
 909          * (time of pending report, i.e. now).
 910          * Used for computing MLDv2 state-change reports. Several refcounts
 911          * are maintained here to optimize for common use-cases.
 912          */
 913         struct in6m_st {
 914                 uint16_t        iss_fmode;      /* MLD filter mode */
 915                 uint16_t        iss_asm;        /* # of ASM listeners */
 916                 uint16_t        iss_ex;         /* # of exclusive members */
 917                 uint16_t        iss_in;         /* # of inclusive members */
 918                 uint16_t        iss_rec;        /* # of recorded sources */
 919         }                       in6m_st[2];     /* state at t0, t1 */
 920
 921         void (*in6m_trace)              /* callback fn for tracing refs */
 922             (struct in6_multi *, int);
 923 };
 924
 925 #define IN6M_LOCK_ASSERT_HELD(_in6m)                                    \
 926         lck_mtx_assert(&(_in6m)->in6m_lock, LCK_MTX_ASSERT_OWNED)
 927
 928 #define IN6M_LOCK_ASSERT_NOTHELD(_in6m)                                 \
 929         lck_mtx_assert(&(_in6m)->in6m_lock, LCK_MTX_ASSERT_NOTOWNED)
 930
 931 #define IN6M_LOCK(_in6m)                                                \
 932         lck_mtx_lock(&(_in6m)->in6m_lock)
 933
 934 #define IN6M_LOCK_SPIN(_in6m)                                           \
 935         lck_mtx_lock_spin(&(_in6m)->in6m_lock)
 936
 937 #define IN6M_CONVERT_LOCK(_in6m) do {                                   \
 938         IN6M_LOCK_ASSERT_HELD(_in6m);                                   \
 939         lck_mtx_convert_spin(&(_in6m)->in6m_lock);                      \
 940 } while (0)
 941
 942 #define IN6M_UNLOCK(_in6m)                                              \
 943         lck_mtx_unlock(&(_in6m)->in6m_lock)
 944
 945 #define IN6M_ADDREF(_in6m)                                              \
 946         in6m_addref(_in6m, 0)
 947
 948 #define IN6M_ADDREF_LOCKED(_in6m)                                       \
 949         in6m_addref(_in6m, 1)
 950
 951 #define IN6M_REMREF(_in6m)                                              \
 952         in6m_remref(_in6m, 0)
 953
 954 #define IN6M_REMREF_LOCKED(_in6m)                                       \
 955         in6m_remref(_in6m, 1)
 956
 957 /* flags to in6_update_ifa */
 958 #define IN6_IFAUPDATE_NOWAIT    0x1 /* don't block allocating memory */
 959 #define IN6_IFAUPDATE_1STADDR   0x2 /* first address on interface */
 960 #define IN6_IFAUPDATE_NEWADDR   0x4 /* new address on interface */
 961 #define IN6_IFAUPDATE_DADDELAY  0x8 /* must delay initial DAD probe */
 962
 963 struct ip6_moptions;
 964 struct sockopt;
 965 struct inpcb;
 966
 967 extern LIST_HEAD(in6_multihead, in6_multi) in6_multihead;
 968
 969 /*
 970  * Structure used by macros below to remember position when stepping through
 971  * all of the in6_multi records.
 972  */
 973 struct in6_multistep {
 974         struct in6_ifaddr *i_ia;
 975         struct in6_multi *i_in6m;
 976 };
 977
 978 /*
 979  * Macros for looking up the in6_multi record for a given IP6 multicast
 980  * address on a given interface. If no matching record is found, "in6m"
 981  * returns NULL.
 982  *
 983  * We do this differently compared other BSD implementations; instead of
 984  * walking the if_multiaddrs list at the interface and returning the
 985  * ifma_protospec value of a matching entry, we search the global list
 986  * of in6_multi records and find it that way.  Otherwise either the two
 987  * structures (in6_multi, ifmultiaddr) need to be ref counted both ways,
 988  * which will make things too complicated, or they need to reside in the
 989  * same protected domain, which they aren't.
 990  *
 991  * Must be called with in6_multihead_lock held.
 992  */
 993 #define IN6_LOOKUP_MULTI(addr, ifp, in6m)                               \
 994         /* struct in6_addr *addr; */                                    \
 995         /* struct ifnet *ifp; */                                        \
 996         /* struct in6_multi *in6m; */                                   \
 997 do {                                                                    \
 998         struct in6_multistep _step;                                     \
 999         IN6_FIRST_MULTI(_step, in6m);                                   \
1000         while ((in6m) != NULL) {                                        \
1001                 IN6M_LOCK_SPIN(in6m);                                   \
1002                 if ((in6m)->in6m_ifp == (ifp) &&                        \
1003                     IN6_ARE_ADDR_EQUAL(&(in6m)->in6m_addr, (addr))) {   \
1004                         IN6M_ADDREF_LOCKED(in6m);                       \
1005                         IN6M_UNLOCK(in6m);                              \
1006                         break;                                          \
1007                 }                                                       \
1008                 IN6M_UNLOCK(in6m);                                      \
1009                 IN6_NEXT_MULTI(_step, in6m);                            \
1010         }                                                               \
1011 } while (0)
1012
1013 /*
1014  * Macro to step through all of the in6_multi records, one at a time.
1015  * The current position is remembered in "step", which the caller must
1016  * provide.  IN6_FIRST_MULTI(), below, must be called to initialize "step"
1017  * and get the first record.  Both macros return a NULL "in6m" when there
1018  * are no remaining records.
1019  *
1020  * Must be called with in6_multihead_lock held.
1021  */
1022 #define IN6_NEXT_MULTI(step, in6m)                                      \
1023         /* struct in6_multistep step; */                                \
1024         /* struct in6_multi *in6m; */                                   \
1025 do {                                                                    \
1026         in6_multihead_lock_assert(LCK_RW_ASSERT_HELD);                  \
1027         if (((in6m) = (step).i_in6m) != NULL)                           \
1028                 (step).i_in6m = (step).i_in6m->in6m_entry.le_next;      \
1029 } while (0)
1030
1031 #define IN6_FIRST_MULTI(step, in6m)                                     \
1032         /* struct in6_multistep step; */                                \
1033         /* struct in6_multi *in6m */                                    \
1034 do {                                                                    \
1035         in6_multihead_lock_assert(LCK_RW_ASSERT_HELD);                  \
1036         (step).i_in6m = in6_multihead.lh_first;                         \
1037                 IN6_NEXT_MULTI((step), (in6m));                         \
1038 } while (0)
1039
1040 extern lck_mtx_t *inet6_domain_mutex;
1041 extern struct domain *inet6domain;
1042
1043 struct ip6_pktopts;
1044
1045 /* Multicast private KPIs. */
1046 extern int im6o_mc_filter(const struct ip6_moptions *, const struct ifnet *,
1047     const struct sockaddr *, const struct sockaddr *);
1048 extern int in6_mc_join(struct ifnet *, const struct in6_addr *,
1049     struct in6_mfilter *, struct in6_multi **, int);
1050 extern int in6_mc_leave(struct in6_multi *, struct in6_mfilter *);
1051 extern void in6m_clear_recorded(struct in6_multi *);
1052 extern void in6m_commit(struct in6_multi *);
1053 extern void in6m_purge(struct in6_multi *);
1054 extern void in6m_print(const struct in6_multi *);
1055 extern int in6m_record_source(struct in6_multi *, const struct in6_addr *);
1056 extern int ip6_getmoptions(struct inpcb *, struct sockopt *);
1057 extern int ip6_setmoptions(struct inpcb *, struct sockopt *);
1058 /* Legacy KAME multicast private KPIs. */
1059 extern struct in6_multi_mship *in6_joingroup(struct ifnet *,
1060     struct in6_addr *, int *, int);
1061 extern int in6_leavegroup(struct in6_multi_mship *);
1062 extern void in6_multi_init(void);
1063 extern void in6m_addref(struct in6_multi *, int);
1064 extern void in6m_remref(struct in6_multi *, int);
1065 extern int in6_multi_detach(struct in6_multi *);
1066 extern int in6_ifindex2scopeid(int);
1067 extern int in6_mask2len(struct in6_addr *, u_char *);
1068 extern void in6_len2mask(struct in6_addr *, int);
1069 extern int in6_control(struct socket *, u_long, caddr_t, struct ifnet *,
1070     struct proc *);
1071 extern int in6_update_ifa(struct ifnet *, struct in6_aliasreq *, int,
1072     struct in6_ifaddr **);
1073 extern void in6_purgeaddr(struct ifaddr *);
1074 extern int in6if_do_dad(struct ifnet *);
1075 extern void in6_purgeif(struct ifnet *);
1076 extern void in6_savemkludge(struct in6_ifaddr *);
1077 extern void in6_setmaxmtu(void);
1078 extern void in6_restoremkludge(struct in6_ifaddr *, struct ifnet *);
1079 extern void in6_purgemkludge(struct ifnet *);
1080 extern struct in6_ifaddr *in6ifa_ifpforlinklocal(struct ifnet *, int);
1081 extern struct in6_ifaddr *in6ifa_ifpwithaddr(struct ifnet *, struct in6_addr *);
1082 extern struct in6_ifaddr *in6ifa_prproxyaddr(struct in6_addr *);
1083 extern void in6ifa_getlifetime(struct in6_ifaddr *,
1084     struct in6_addrlifetime *, int);
1085 extern void in6ifa_setlifetime(struct in6_ifaddr *, struct in6_addrlifetime *);
1086 extern char *ip6_sprintf(const struct in6_addr *);
1087 extern int in6_addr2scopeid(struct ifnet *, struct in6_addr *);
1088 extern int in6_matchlen(struct in6_addr *, struct in6_addr *);
1089 extern int in6_are_prefix_equal(struct in6_addr *p1, struct in6_addr *p2,
1090     int len);
1091 extern void in6_prefixlen2mask(struct in6_addr *maskp, int len);
1092 extern int in6_prefix_add_ifid(int iilen, struct in6_ifaddr *ia);
1093 extern void in6_prefix_remove_ifid(int iilen, struct in6_ifaddr *ia);
1094 extern void in6_purgeprefix(struct ifnet *);
1095 extern void in6_purgeaddrs(struct ifnet *);
1096 extern int in6_is_addr_deprecated(struct sockaddr_in6 *);
1097 extern uint8_t im6s_get_mode(const struct in6_multi *,
1098     const struct ip6_msource *, uint8_t);
1099 extern void im6f_leave(struct in6_mfilter *);
1100 extern void im6f_purge(struct in6_mfilter *);
1101 extern int in6_embedscope(struct in6_addr *, const struct sockaddr_in6 *,
1102     struct inpcb *, struct ifnet **, struct ip6_pktopts *);
1103 extern int in6_recoverscope(struct sockaddr_in6 *, const struct in6_addr *,
1104     struct ifnet *);
1105 extern void in6_aliasreq_64_to_32(struct in6_aliasreq_64 *,
1106     struct in6_aliasreq_32 *);
1107 extern void in6_aliasreq_32_to_64(struct in6_aliasreq_32 *,
1108     struct in6_aliasreq_64 *);
1109 extern void in6_ifaddr_init(void);
1110 extern int in6_inithead(void **, int);
1111 extern void in6_rtqdrain(void);
1112 extern struct radix_node *in6_validate(struct radix_node *);
1113 extern int  in6_if2idlen(struct ifnet *);
1114 extern int in6_src_ioctl(u_long, caddr_t);
1115 extern void in6_multihead_lock_exclusive(void);
1116 extern void in6_multihead_lock_shared(void);
1117 extern void in6_multihead_lock_assert(int);
1118 extern void in6_multihead_lock_done(void);
1119
1120 extern void in6_cga_init(void);
1121 extern void in6_cga_node_lock(void);
1122 extern void in6_cga_node_unlock(void);
1123 extern void in6_cga_query(struct in6_cga_nodecfg *);
1124 extern int in6_cga_start(const struct in6_cga_nodecfg *);
1125 extern int in6_cga_stop(void);
1126 extern ssize_t in6_cga_parameters_prepare(void *, size_t,
1127     const struct in6_addr *, u_int8_t, const struct in6_cga_modifier *);
1128 extern int in6_cga_generate(const struct in6_cga_prepare *, u_int8_t,
1129     struct in6_addr *);
1130
1131 #endif /* BSD_KERNEL_PRIVATE */
1132 #endif /* _NETINET6_IN6_VAR_H_ */