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