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