2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the project nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * $KAME: in6_var.h,v 1.56 2001/03/29 05:34:31 itojun Exp $
35 * Copyright (c) 1985, 1986, 1993
36 * The Regents of the University of California. All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * 3. Neither the name of the University nor the names of its contributors
47 * may be used to endorse or promote products derived from this software
48 * without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
54 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
62 * @(#)in_var.h 8.1 (Berkeley) 6/10/93
66 #ifndef _NETINET6_IN6_VAR_H_
67 #define _NETINET6_IN6_VAR_H_
70 #include <sys/counter.h>
73 #include <sys/fnv_hash.h>
74 #include <sys/libkern.h>
78 * Interface address, Internet version. One of these structures
79 * is allocated for each interface with an Internet address.
80 * The ifaddr structure contains the protocol-independent part
81 * of the structure and is assumed to be first.
85 * pltime/vltime are just for future reference (required to implements 2
86 * hour rule for hosts). they should never be modified by nd6_timeout or
88 * userland -> kernel: accept pltime/vltime
89 * kernel -> userland: throw up everything
90 * in kernel: modify preferred/expire only
92 struct in6_addrlifetime {
93 time_t ia6t_expire; /* valid lifetime expiration time */
94 time_t ia6t_preferred; /* preferred lifetime expiration time */
95 u_int32_t ia6t_vltime; /* valid lifetime */
96 u_int32_t ia6t_pltime; /* prefix lifetime */
105 counter_u64_t *in6_ifstat;
106 counter_u64_t *icmp6_ifstat;
107 struct nd_ifinfo *nd_ifinfo;
108 struct scope6_id *scope6_id;
109 struct lltable *lltable;
110 struct mld_ifsoftc *mld_ifinfo;
113 #define LLTABLE6(ifp) (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->lltable)
117 struct ifaddr ia_ifa; /* protocol-independent info */
118 #define ia_ifp ia_ifa.ifa_ifp
119 #define ia_flags ia_ifa.ifa_flags
120 struct sockaddr_in6 ia_addr; /* interface address */
121 struct sockaddr_in6 ia_net; /* network number of interface */
122 struct sockaddr_in6 ia_dstaddr; /* space for destination addr */
123 struct sockaddr_in6 ia_prefixmask; /* prefix mask */
124 u_int32_t ia_plen; /* prefix length */
125 TAILQ_ENTRY(in6_ifaddr) ia_link; /* list of IPv6 addresses */
128 struct in6_addrlifetime ia6_lifetime;
129 time_t ia6_createtime; /* the creation time of this address, which is
130 * currently used for temporary addresses only.
132 time_t ia6_updatetime;
134 /* back pointer to the ND prefix (for autoconfigured addresses only) */
135 struct nd_prefix *ia6_ndpr;
137 /* multicast addresses joined from the kernel */
138 LIST_HEAD(, in6_multi_mship) ia6_memberships;
139 /* entry in bucket of inet6 addresses */
140 LIST_ENTRY(in6_ifaddr) ia6_hash;
143 /* List of in6_ifaddr's. */
144 TAILQ_HEAD(in6_ifaddrhead, in6_ifaddr);
145 LIST_HEAD(in6_ifaddrlisthead, in6_ifaddr);
148 /* control structure to manage address selection policy */
149 struct in6_addrpolicy {
150 struct sockaddr_in6 addr; /* prefix address */
151 struct sockaddr_in6 addrmask; /* prefix mask */
152 int preced; /* precedence */
153 int label; /* matching label */
154 u_quad_t use; /* statistics */
158 * IPv6 interface statistics, as defined in RFC2465 Ipv6IfStatsEntry (p12).
161 uint64_t ifs6_in_receive; /* # of total input datagram */
162 uint64_t ifs6_in_hdrerr; /* # of datagrams with invalid hdr */
163 uint64_t ifs6_in_toobig; /* # of datagrams exceeded MTU */
164 uint64_t ifs6_in_noroute; /* # of datagrams with no route */
165 uint64_t ifs6_in_addrerr; /* # of datagrams with invalid dst */
166 uint64_t ifs6_in_protounknown; /* # of datagrams with unknown proto */
167 /* NOTE: increment on final dst if */
168 uint64_t ifs6_in_truncated; /* # of truncated datagrams */
169 uint64_t ifs6_in_discard; /* # of discarded datagrams */
170 /* NOTE: fragment timeout is not here */
171 uint64_t ifs6_in_deliver; /* # of datagrams delivered to ULP */
172 /* NOTE: increment on final dst if */
173 uint64_t ifs6_out_forward; /* # of datagrams forwarded */
174 /* NOTE: increment on outgoing if */
175 uint64_t ifs6_out_request; /* # of outgoing datagrams from ULP */
176 /* NOTE: does not include forwrads */
177 uint64_t ifs6_out_discard; /* # of discarded datagrams */
178 uint64_t ifs6_out_fragok; /* # of datagrams fragmented */
179 uint64_t ifs6_out_fragfail; /* # of datagrams failed on fragment */
180 uint64_t ifs6_out_fragcreat; /* # of fragment datagrams */
181 /* NOTE: this is # after fragment */
182 uint64_t ifs6_reass_reqd; /* # of incoming fragmented packets */
183 /* NOTE: increment on final dst if */
184 uint64_t ifs6_reass_ok; /* # of reassembled packets */
185 /* NOTE: this is # after reass */
186 /* NOTE: increment on final dst if */
187 uint64_t ifs6_reass_fail; /* # of reass failures */
188 /* NOTE: may not be packet count */
189 /* NOTE: increment on final dst if */
190 uint64_t ifs6_in_mcast; /* # of inbound multicast datagrams */
191 uint64_t ifs6_out_mcast; /* # of outbound multicast datagrams */
195 * ICMPv6 interface statistics, as defined in RFC2466 Ipv6IfIcmpEntry.
196 * XXX: I'm not sure if this file is the right place for this structure...
198 struct icmp6_ifstat {
202 /* ipv6IfIcmpInMsgs, total # of input messages */
203 uint64_t ifs6_in_msg;
204 /* ipv6IfIcmpInErrors, # of input error messages */
205 uint64_t ifs6_in_error;
206 /* ipv6IfIcmpInDestUnreachs, # of input dest unreach errors */
207 uint64_t ifs6_in_dstunreach;
208 /* ipv6IfIcmpInAdminProhibs, # of input administratively prohibited errs */
209 uint64_t ifs6_in_adminprohib;
210 /* ipv6IfIcmpInTimeExcds, # of input time exceeded errors */
211 uint64_t ifs6_in_timeexceed;
212 /* ipv6IfIcmpInParmProblems, # of input parameter problem errors */
213 uint64_t ifs6_in_paramprob;
214 /* ipv6IfIcmpInPktTooBigs, # of input packet too big errors */
215 uint64_t ifs6_in_pkttoobig;
216 /* ipv6IfIcmpInEchos, # of input echo requests */
217 uint64_t ifs6_in_echo;
218 /* ipv6IfIcmpInEchoReplies, # of input echo replies */
219 uint64_t ifs6_in_echoreply;
220 /* ipv6IfIcmpInRouterSolicits, # of input router solicitations */
221 uint64_t ifs6_in_routersolicit;
222 /* ipv6IfIcmpInRouterAdvertisements, # of input router advertisements */
223 uint64_t ifs6_in_routeradvert;
224 /* ipv6IfIcmpInNeighborSolicits, # of input neighbor solicitations */
225 uint64_t ifs6_in_neighborsolicit;
226 /* ipv6IfIcmpInNeighborAdvertisements, # of input neighbor advertisements */
227 uint64_t ifs6_in_neighboradvert;
228 /* ipv6IfIcmpInRedirects, # of input redirects */
229 uint64_t ifs6_in_redirect;
230 /* ipv6IfIcmpInGroupMembQueries, # of input MLD queries */
231 uint64_t ifs6_in_mldquery;
232 /* ipv6IfIcmpInGroupMembResponses, # of input MLD reports */
233 uint64_t ifs6_in_mldreport;
234 /* ipv6IfIcmpInGroupMembReductions, # of input MLD done */
235 uint64_t ifs6_in_mlddone;
238 * Output statistics. We should solve unresolved routing problem...
240 /* ipv6IfIcmpOutMsgs, total # of output messages */
241 uint64_t ifs6_out_msg;
242 /* ipv6IfIcmpOutErrors, # of output error messages */
243 uint64_t ifs6_out_error;
244 /* ipv6IfIcmpOutDestUnreachs, # of output dest unreach errors */
245 uint64_t ifs6_out_dstunreach;
246 /* ipv6IfIcmpOutAdminProhibs, # of output administratively prohibited errs */
247 uint64_t ifs6_out_adminprohib;
248 /* ipv6IfIcmpOutTimeExcds, # of output time exceeded errors */
249 uint64_t ifs6_out_timeexceed;
250 /* ipv6IfIcmpOutParmProblems, # of output parameter problem errors */
251 uint64_t ifs6_out_paramprob;
252 /* ipv6IfIcmpOutPktTooBigs, # of output packet too big errors */
253 uint64_t ifs6_out_pkttoobig;
254 /* ipv6IfIcmpOutEchos, # of output echo requests */
255 uint64_t ifs6_out_echo;
256 /* ipv6IfIcmpOutEchoReplies, # of output echo replies */
257 uint64_t ifs6_out_echoreply;
258 /* ipv6IfIcmpOutRouterSolicits, # of output router solicitations */
259 uint64_t ifs6_out_routersolicit;
260 /* ipv6IfIcmpOutRouterAdvertisements, # of output router advertisements */
261 uint64_t ifs6_out_routeradvert;
262 /* ipv6IfIcmpOutNeighborSolicits, # of output neighbor solicitations */
263 uint64_t ifs6_out_neighborsolicit;
264 /* ipv6IfIcmpOutNeighborAdvertisements, # of output neighbor advertisements */
265 uint64_t ifs6_out_neighboradvert;
266 /* ipv6IfIcmpOutRedirects, # of output redirects */
267 uint64_t ifs6_out_redirect;
268 /* ipv6IfIcmpOutGroupMembQueries, # of output MLD queries */
269 uint64_t ifs6_out_mldquery;
270 /* ipv6IfIcmpOutGroupMembResponses, # of output MLD reports */
271 uint64_t ifs6_out_mldreport;
272 /* ipv6IfIcmpOutGroupMembReductions, # of output MLD done */
273 uint64_t ifs6_out_mlddone;
277 char ifr_name[IFNAMSIZ];
279 struct sockaddr_in6 ifru_addr;
280 struct sockaddr_in6 ifru_dstaddr;
285 struct in6_addrlifetime ifru_lifetime;
286 struct in6_ifstat ifru_stat;
287 struct icmp6_ifstat ifru_icmp6stat;
288 u_int32_t ifru_scope_id[16];
292 struct in6_aliasreq {
293 char ifra_name[IFNAMSIZ];
294 struct sockaddr_in6 ifra_addr;
295 struct sockaddr_in6 ifra_dstaddr;
296 struct sockaddr_in6 ifra_prefixmask;
298 struct in6_addrlifetime ifra_lifetime;
302 /* pre-10.x compat */
303 struct oin6_aliasreq {
304 char ifra_name[IFNAMSIZ];
305 struct sockaddr_in6 ifra_addr;
306 struct sockaddr_in6 ifra_dstaddr;
307 struct sockaddr_in6 ifra_prefixmask;
309 struct in6_addrlifetime ifra_lifetime;
312 /* prefix type macro */
313 #define IN6_PREFIX_ND 1
314 #define IN6_PREFIX_RR 2
317 * prefix related flags passed between kernel(NDP related part) and
318 * user land command(ifconfig) and daemon(rtadvd).
323 u_char autonomous : 1;
326 u_char prf_reserved1;
327 u_short prf_reserved2;
328 /* want to put this on 4byte offset */
330 u_char decrvalid : 1;
331 u_char decrprefd : 1;
334 u_char prf_reserved3;
335 u_short prf_reserved4;
338 struct in6_prefixreq {
339 char ipr_name[IFNAMSIZ];
342 u_int32_t ipr_vltime;
343 u_int32_t ipr_pltime;
344 struct in6_prflags ipr_flags;
345 struct sockaddr_in6 ipr_prefix;
350 #define PR_ORIG_STATIC 2
351 #define PR_ORIG_KERNEL 3
353 #define ipr_raf_onlink ipr_flags.prf_ra.onlink
354 #define ipr_raf_auto ipr_flags.prf_ra.autonomous
356 #define ipr_statef_onlink ipr_flags.prf_state.onlink
358 #define ipr_rrf_decrvalid ipr_flags.prf_rr.decrvalid
359 #define ipr_rrf_decrprefd ipr_flags.prf_rr.decrprefd
361 struct in6_rrenumreq {
362 char irr_name[IFNAMSIZ];
364 u_char irr_m_len; /* match len for matchprefix */
365 u_char irr_m_minlen; /* minlen for matching prefix */
366 u_char irr_m_maxlen; /* maxlen for matching prefix */
367 u_char irr_u_uselen; /* uselen for adding prefix */
368 u_char irr_u_keeplen; /* keeplen from matching prefix */
369 struct irr_raflagmask {
371 u_char autonomous : 1;
374 u_int32_t irr_vltime;
375 u_int32_t irr_pltime;
376 struct in6_prflags irr_flags;
377 struct sockaddr_in6 irr_matchprefix;
378 struct sockaddr_in6 irr_useprefix;
381 #define irr_raf_mask_onlink irr_raflagmask.onlink
382 #define irr_raf_mask_auto irr_raflagmask.autonomous
383 #define irr_raf_mask_reserved irr_raflagmask.reserved
385 #define irr_raf_onlink irr_flags.prf_ra.onlink
386 #define irr_raf_auto irr_flags.prf_ra.autonomous
388 #define irr_statef_onlink irr_flags.prf_state.onlink
390 #define irr_rrf irr_flags.prf_rr
391 #define irr_rrf_decrvalid irr_flags.prf_rr.decrvalid
392 #define irr_rrf_decrprefd irr_flags.prf_rr.decrprefd
395 * Given a pointer to an in6_ifaddr (ifaddr),
396 * return a pointer to the addr as a sockaddr_in6
398 #define IA6_IN6(ia) (&((ia)->ia_addr.sin6_addr))
399 #define IA6_DSTIN6(ia) (&((ia)->ia_dstaddr.sin6_addr))
400 #define IA6_MASKIN6(ia) (&((ia)->ia_prefixmask.sin6_addr))
401 #define IA6_SIN6(ia) (&((ia)->ia_addr))
402 #define IA6_DSTSIN6(ia) (&((ia)->ia_dstaddr))
403 #define IFA_IN6(x) (&((struct sockaddr_in6 *)((x)->ifa_addr))->sin6_addr)
404 #define IFA_DSTIN6(x) (&((struct sockaddr_in6 *)((x)->ifa_dstaddr))->sin6_addr)
406 #define IFPR_IN6(x) (&((struct sockaddr_in6 *)((x)->ifpr_prefix))->sin6_addr)
409 #define IN6_ARE_MASKED_ADDR_EQUAL(d, a, m) ( \
410 (((d)->s6_addr32[0] ^ (a)->s6_addr32[0]) & (m)->s6_addr32[0]) == 0 && \
411 (((d)->s6_addr32[1] ^ (a)->s6_addr32[1]) & (m)->s6_addr32[1]) == 0 && \
412 (((d)->s6_addr32[2] ^ (a)->s6_addr32[2]) & (m)->s6_addr32[2]) == 0 && \
413 (((d)->s6_addr32[3] ^ (a)->s6_addr32[3]) & (m)->s6_addr32[3]) == 0 )
414 #define IN6_MASK_ADDR(a, m) do { \
415 (a)->s6_addr32[0] &= (m)->s6_addr32[0]; \
416 (a)->s6_addr32[1] &= (m)->s6_addr32[1]; \
417 (a)->s6_addr32[2] &= (m)->s6_addr32[2]; \
418 (a)->s6_addr32[3] &= (m)->s6_addr32[3]; \
422 #define SIOCSIFADDR_IN6 _IOW('i', 12, struct in6_ifreq)
423 #define SIOCGIFADDR_IN6 _IOWR('i', 33, struct in6_ifreq)
427 * SIOCSxxx ioctls should be unused (see comments in in6.c), but
428 * we do not shift numbers for binary compatibility.
430 #define SIOCSIFDSTADDR_IN6 _IOW('i', 14, struct in6_ifreq)
431 #define SIOCSIFNETMASK_IN6 _IOW('i', 22, struct in6_ifreq)
434 #define SIOCGIFDSTADDR_IN6 _IOWR('i', 34, struct in6_ifreq)
435 #define SIOCGIFNETMASK_IN6 _IOWR('i', 37, struct in6_ifreq)
437 #define SIOCDIFADDR_IN6 _IOW('i', 25, struct in6_ifreq)
438 #define OSIOCAIFADDR_IN6 _IOW('i', 26, struct oin6_aliasreq)
439 #define SIOCAIFADDR_IN6 _IOW('i', 27, struct in6_aliasreq)
441 #define SIOCSIFPHYADDR_IN6 _IOW('i', 70, struct in6_aliasreq)
442 #define SIOCGIFPSRCADDR_IN6 _IOWR('i', 71, struct in6_ifreq)
443 #define SIOCGIFPDSTADDR_IN6 _IOWR('i', 72, struct in6_ifreq)
445 #define SIOCGIFAFLAG_IN6 _IOWR('i', 73, struct in6_ifreq)
448 #define OSIOCGIFINFO_IN6 _IOWR('i', 76, struct in6_ondireq)
450 #define SIOCGIFINFO_IN6 _IOWR('i', 108, struct in6_ndireq)
451 #define SIOCSIFINFO_IN6 _IOWR('i', 109, struct in6_ndireq)
452 #define SIOCSNDFLUSH_IN6 _IOWR('i', 77, struct in6_ifreq)
453 #define SIOCGNBRINFO_IN6 _IOWR('i', 78, struct in6_nbrinfo)
454 #define SIOCSPFXFLUSH_IN6 _IOWR('i', 79, struct in6_ifreq)
455 #define SIOCSRTRFLUSH_IN6 _IOWR('i', 80, struct in6_ifreq)
457 #define SIOCGIFALIFETIME_IN6 _IOWR('i', 81, struct in6_ifreq)
458 #define SIOCGIFSTAT_IN6 _IOWR('i', 83, struct in6_ifreq)
459 #define SIOCGIFSTAT_ICMP6 _IOWR('i', 84, struct in6_ifreq)
461 #define SIOCSDEFIFACE_IN6 _IOWR('i', 85, struct in6_ndifreq)
462 #define SIOCGDEFIFACE_IN6 _IOWR('i', 86, struct in6_ndifreq)
464 #define SIOCSIFINFO_FLAGS _IOWR('i', 87, struct in6_ndireq) /* XXX */
466 #define SIOCSSCOPE6 _IOW('i', 88, struct in6_ifreq)
467 #define SIOCGSCOPE6 _IOWR('i', 89, struct in6_ifreq)
468 #define SIOCGSCOPE6DEF _IOWR('i', 90, struct in6_ifreq)
470 #define SIOCSIFPREFIX_IN6 _IOW('i', 100, struct in6_prefixreq) /* set */
471 #define SIOCGIFPREFIX_IN6 _IOWR('i', 101, struct in6_prefixreq) /* get */
472 #define SIOCDIFPREFIX_IN6 _IOW('i', 102, struct in6_prefixreq) /* del */
473 #define SIOCAIFPREFIX_IN6 _IOW('i', 103, struct in6_rrenumreq) /* add */
474 #define SIOCCIFPREFIX_IN6 _IOW('i', 104, \
475 struct in6_rrenumreq) /* change */
476 #define SIOCSGIFPREFIX_IN6 _IOW('i', 105, \
477 struct in6_rrenumreq) /* set global */
479 #define SIOCGETSGCNT_IN6 _IOWR('u', 106, \
480 struct sioc_sg_req6) /* get s,g pkt cnt */
481 #define SIOCGETMIFCNT_IN6 _IOWR('u', 107, \
482 struct sioc_mif_req6) /* get pkt cnt per if */
484 #define SIOCAADDRCTL_POLICY _IOW('u', 108, struct in6_addrpolicy)
485 #define SIOCDADDRCTL_POLICY _IOW('u', 109, struct in6_addrpolicy)
487 #define IN6_IFF_ANYCAST 0x01 /* anycast address */
488 #define IN6_IFF_TENTATIVE 0x02 /* tentative address */
489 #define IN6_IFF_DUPLICATED 0x04 /* DAD detected duplicate */
490 #define IN6_IFF_DETACHED 0x08 /* may be detached from the link */
491 #define IN6_IFF_DEPRECATED 0x10 /* deprecated address */
492 #define IN6_IFF_NODAD 0x20 /* don't perform DAD on this address
495 #define IN6_IFF_AUTOCONF 0x40 /* autoconfigurable address. */
496 #define IN6_IFF_TEMPORARY 0x80 /* temporary (anonymous) address. */
497 #define IN6_IFF_PREFER_SOURCE 0x0100 /* preferred address for SAS */
499 /* do not input/output */
500 #define IN6_IFF_NOTREADY (IN6_IFF_TENTATIVE|IN6_IFF_DUPLICATED)
503 #define IN6_ARE_SCOPE_CMP(a,b) ((a)-(b))
504 #define IN6_ARE_SCOPE_EQUAL(a,b) ((a)==(b))
508 VNET_DECLARE(struct in6_ifaddrhead, in6_ifaddrhead);
509 VNET_DECLARE(struct in6_ifaddrlisthead *, in6_ifaddrhashtbl);
510 VNET_DECLARE(u_long, in6_ifaddrhmask);
511 #define V_in6_ifaddrhead VNET(in6_ifaddrhead)
512 #define V_in6_ifaddrhashtbl VNET(in6_ifaddrhashtbl)
513 #define V_in6_ifaddrhmask VNET(in6_ifaddrhmask)
515 #define IN6ADDR_NHASH_LOG2 8
516 #define IN6ADDR_NHASH (1 << IN6ADDR_NHASH_LOG2)
517 #define IN6ADDR_HASHVAL(x) (in6_addrhash(x))
518 #define IN6ADDR_HASH(x) \
519 (&V_in6_ifaddrhashtbl[IN6ADDR_HASHVAL(x) & V_in6_ifaddrhmask])
521 static __inline uint32_t
522 in6_addrhash(const struct in6_addr *in6)
526 x = in6->s6_addr32[0] ^ in6->s6_addr32[1] ^ in6->s6_addr32[2] ^
528 return (fnv_32_buf(&x, sizeof(x), FNV1_32_INIT));
531 extern struct rmlock in6_ifaddr_lock;
532 #define IN6_IFADDR_LOCK_ASSERT() rm_assert(&in6_ifaddr_lock, RA_LOCKED)
533 #define IN6_IFADDR_RLOCK(t) rm_rlock(&in6_ifaddr_lock, (t))
534 #define IN6_IFADDR_RLOCK_ASSERT() rm_assert(&in6_ifaddr_lock, RA_RLOCKED)
535 #define IN6_IFADDR_RUNLOCK(t) rm_runlock(&in6_ifaddr_lock, (t))
536 #define IN6_IFADDR_WLOCK() rm_wlock(&in6_ifaddr_lock)
537 #define IN6_IFADDR_WLOCK_ASSERT() rm_assert(&in6_ifaddr_lock, RA_WLOCKED)
538 #define IN6_IFADDR_WUNLOCK() rm_wunlock(&in6_ifaddr_lock)
540 #define in6_ifstat_inc(ifp, tag) \
543 counter_u64_add(((struct in6_ifextra *) \
544 ((ifp)->if_afdata[AF_INET6]))->in6_ifstat[ \
545 offsetof(struct in6_ifstat, tag) / sizeof(uint64_t)], 1);\
546 } while (/*CONSTCOND*/ 0)
548 extern u_char inet6ctlerrmap[];
549 VNET_DECLARE(unsigned long, in6_maxmtu);
550 #define V_in6_maxmtu VNET(in6_maxmtu)
554 * IPv6 multicast MLD-layer source entry.
557 RB_ENTRY(ip6_msource) im6s_link; /* RB tree links */
558 struct in6_addr im6s_addr;
560 uint16_t ex; /* # of exclusive members */
561 uint16_t in; /* # of inclusive members */
562 } im6s_st[2]; /* state at t0, t1 */
563 uint8_t im6s_stp; /* pending query */
565 RB_HEAD(ip6_msource_tree, ip6_msource);
568 * IPv6 multicast PCB-layer source entry.
570 * NOTE: overlapping use of struct ip6_msource fields at start.
573 RB_ENTRY(ip6_msource) im6s_link; /* Common field */
574 struct in6_addr im6s_addr; /* Common field */
575 uint8_t im6sl_st[2]; /* state before/at commit */
580 * IPv6 source tree comparison function.
582 * An ordered predicate is necessary; bcmp() is not documented to return
583 * an indication of order, memcmp() is, and is an ISO C99 requirement.
586 ip6_msource_cmp(const struct ip6_msource *a, const struct ip6_msource *b)
589 return (memcmp(&a->im6s_addr, &b->im6s_addr, sizeof(struct in6_addr)));
591 RB_PROTOTYPE(ip6_msource_tree, ip6_msource, im6s_link, ip6_msource_cmp);
594 * IPv6 multicast PCB-layer group filter descriptor.
597 struct ip6_msource_tree im6f_sources; /* source list for (S,G) */
598 u_long im6f_nsrc; /* # of source entries */
599 uint8_t im6f_st[2]; /* state before/at commit */
603 * Legacy KAME IPv6 multicast membership descriptor.
605 struct in6_multi_mship {
606 struct in6_multi *i6mm_maddr;
607 LIST_ENTRY(in6_multi_mship) i6mm_chain;
611 * IPv6 group descriptor.
613 * For every entry on an ifnet's if_multiaddrs list which represents
614 * an IP multicast group, there is one of these structures.
616 * If any source filters are present, then a node will exist in the RB-tree
617 * to permit fast lookup by source whenever an operation takes place.
618 * This permits pre-order traversal when we issue reports.
619 * Source filter trees are kept separately from the socket layer to
620 * greatly simplify locking.
622 * When MLDv2 is active, in6m_timer is the response to group query timer.
623 * The state-change timer in6m_sctimer is separate; whenever state changes
624 * for the group the state change record is generated and transmitted,
625 * and kept if retransmissions are necessary.
627 * FUTURE: in6m_link is now only used when groups are being purged
628 * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but
629 * because it is at the very start of the struct, we can't do this
630 * w/o breaking the ABI for ifmcstat.
633 LIST_ENTRY(in6_multi) in6m_entry; /* list glue */
634 struct in6_addr in6m_addr; /* IPv6 multicast address */
635 struct ifnet *in6m_ifp; /* back pointer to ifnet */
636 struct ifmultiaddr *in6m_ifma; /* back pointer to ifmultiaddr */
637 u_int in6m_refcount; /* reference count */
638 u_int in6m_state; /* state of the membership */
639 u_int in6m_timer; /* MLD6 listener report timer */
641 /* New fields for MLDv2 follow. */
642 struct mld_ifsoftc *in6m_mli; /* MLD info */
643 SLIST_ENTRY(in6_multi) in6m_nrele; /* to-be-released by MLD */
644 struct ip6_msource_tree in6m_srcs; /* tree of sources */
645 u_long in6m_nsrc; /* # of tree entries */
647 struct mbufq in6m_scq; /* queue of pending
648 * state-change packets */
649 struct timeval in6m_lastgsrtv; /* last G-S-R query */
650 uint16_t in6m_sctimer; /* state-change timer */
651 uint16_t in6m_scrv; /* state-change rexmit count */
654 * SSM state counters which track state at T0 (the time the last
655 * state-change report's RV timer went to zero) and T1
656 * (time of pending report, i.e. now).
657 * Used for computing MLDv2 state-change reports. Several refcounts
658 * are maintained here to optimize for common use-cases.
661 uint16_t iss_fmode; /* MLD filter mode */
662 uint16_t iss_asm; /* # of ASM listeners */
663 uint16_t iss_ex; /* # of exclusive members */
664 uint16_t iss_in; /* # of inclusive members */
665 uint16_t iss_rec; /* # of recorded sources */
666 } in6m_st[2]; /* state at t0, t1 */
670 * Helper function to derive the filter mode on a source entry
671 * from its internal counters. Predicates are:
672 * A source is only excluded if all listeners exclude it.
673 * A source is only included if no listeners exclude it,
674 * and at least one listener includes it.
675 * May be used by ifmcstat(8).
677 static __inline uint8_t
678 im6s_get_mode(const struct in6_multi *inm, const struct ip6_msource *ims,
683 if (inm->in6m_st[t].iss_ex > 0 &&
684 inm->in6m_st[t].iss_ex == ims->im6s_st[t].ex)
685 return (MCAST_EXCLUDE);
686 else if (ims->im6s_st[t].in > 0 && ims->im6s_st[t].ex == 0)
687 return (MCAST_INCLUDE);
688 return (MCAST_UNDEFINED);
692 * Lock macros for IPv6 layer multicast address lists. IPv6 lock goes
693 * before link layer multicast locks in the lock order. In most cases,
694 * consumers of IN_*_MULTI() macros should acquire the locks before
695 * calling them; users of the in_{add,del}multi() functions should not.
697 extern struct mtx in6_multi_mtx;
698 #define IN6_MULTI_LOCK() mtx_lock(&in6_multi_mtx)
699 #define IN6_MULTI_UNLOCK() mtx_unlock(&in6_multi_mtx)
700 #define IN6_MULTI_LOCK_ASSERT() mtx_assert(&in6_multi_mtx, MA_OWNED)
701 #define IN6_MULTI_UNLOCK_ASSERT() mtx_assert(&in6_multi_mtx, MA_NOTOWNED)
704 * Look up an in6_multi record for an IPv6 multicast address
705 * on the interface ifp.
706 * If no record found, return NULL.
708 * SMPng: The IN6_MULTI_LOCK and IF_ADDR_LOCK on ifp must be held.
710 static __inline struct in6_multi *
711 in6m_lookup_locked(struct ifnet *ifp, const struct in6_addr *mcaddr)
713 struct ifmultiaddr *ifma;
714 struct in6_multi *inm;
716 IN6_MULTI_LOCK_ASSERT();
717 IF_ADDR_LOCK_ASSERT(ifp);
720 TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) {
721 if (ifma->ifma_addr->sa_family == AF_INET6) {
722 inm = (struct in6_multi *)ifma->ifma_protospec;
723 if (IN6_ARE_ADDR_EQUAL(&inm->in6m_addr, mcaddr))
732 * Wrapper for in6m_lookup_locked().
734 * SMPng: Assumes that neithr the IN6_MULTI_LOCK() or IF_ADDR_LOCK() are held.
736 static __inline struct in6_multi *
737 in6m_lookup(struct ifnet *ifp, const struct in6_addr *mcaddr)
739 struct in6_multi *inm;
743 inm = in6m_lookup_locked(ifp, mcaddr);
744 IF_ADDR_RUNLOCK(ifp);
750 /* Acquire an in6_multi record. */
752 in6m_acquire_locked(struct in6_multi *inm)
755 IN6_MULTI_LOCK_ASSERT();
756 ++inm->in6m_refcount;
762 /* Multicast KPIs. */
763 int im6o_mc_filter(const struct ip6_moptions *, const struct ifnet *,
764 const struct sockaddr *, const struct sockaddr *);
765 int in6_mc_join(struct ifnet *, const struct in6_addr *,
766 struct in6_mfilter *, struct in6_multi **, int);
767 int in6_mc_join_locked(struct ifnet *, const struct in6_addr *,
768 struct in6_mfilter *, struct in6_multi **, int);
769 int in6_mc_leave(struct in6_multi *, struct in6_mfilter *);
770 int in6_mc_leave_locked(struct in6_multi *, struct in6_mfilter *);
771 void in6m_clear_recorded(struct in6_multi *);
772 void in6m_commit(struct in6_multi *);
773 void in6m_print(const struct in6_multi *);
774 int in6m_record_source(struct in6_multi *, const struct in6_addr *);
775 void in6m_release_locked(struct in6_multi *);
776 void ip6_freemoptions(struct ip6_moptions *);
777 int ip6_getmoptions(struct inpcb *, struct sockopt *);
778 int ip6_setmoptions(struct inpcb *, struct sockopt *);
780 /* Legacy KAME multicast KPIs. */
781 struct in6_multi_mship *
782 in6_joingroup(struct ifnet *, struct in6_addr *, int *, int);
783 int in6_leavegroup(struct in6_multi_mship *);
785 /* flags to in6_update_ifa */
786 #define IN6_IFAUPDATE_DADDELAY 0x1 /* first time to configure an address */
788 int in6_mask2len(struct in6_addr *, u_char *);
789 int in6_control(struct socket *, u_long, caddr_t, struct ifnet *,
791 int in6_update_ifa(struct ifnet *, struct in6_aliasreq *,
792 struct in6_ifaddr *, int);
793 void in6_prepare_ifra(struct in6_aliasreq *, const struct in6_addr *,
794 const struct in6_addr *);
795 void in6_purgeaddr(struct ifaddr *);
796 int in6if_do_dad(struct ifnet *);
797 void in6_savemkludge(struct in6_ifaddr *);
798 void *in6_domifattach(struct ifnet *);
799 void in6_domifdetach(struct ifnet *, void *);
800 int in6_domifmtu(struct ifnet *);
801 void in6_setmaxmtu(void);
802 int in6_if2idlen(struct ifnet *);
803 struct in6_ifaddr *in6ifa_ifpforlinklocal(struct ifnet *, int);
804 struct in6_ifaddr *in6ifa_ifpwithaddr(struct ifnet *, const struct in6_addr *);
805 struct in6_ifaddr *in6ifa_ifwithaddr(const struct in6_addr *, uint32_t);
806 struct in6_ifaddr *in6ifa_llaonifp(struct ifnet *);
807 int in6_addr2zoneid(struct ifnet *, struct in6_addr *, u_int32_t *);
808 int in6_matchlen(struct in6_addr *, struct in6_addr *);
809 int in6_are_prefix_equal(struct in6_addr *, struct in6_addr *, int);
810 void in6_prefixlen2mask(struct in6_addr *, int);
811 int in6_prefix_ioctl(struct socket *, u_long, caddr_t,
813 int in6_prefix_add_ifid(int, struct in6_ifaddr *);
814 void in6_prefix_remove_ifid(int, struct in6_ifaddr *);
815 void in6_purgeprefix(struct ifnet *);
817 int in6_is_addr_deprecated(struct sockaddr_in6 *);
818 int in6_src_ioctl(u_long, caddr_t);
820 void in6_newaddrmsg(struct in6_ifaddr *, int);
822 * Extended API for IPv6 FIB support.
824 struct mbuf *ip6_tryforward(struct mbuf *);
825 void in6_rtredirect(struct sockaddr *, struct sockaddr *, struct sockaddr *,
826 int, struct sockaddr *, u_int);
827 int in6_rtrequest(int, struct sockaddr *, struct sockaddr *,
828 struct sockaddr *, int, struct rtentry **, u_int);
829 void in6_rtalloc(struct route_in6 *, u_int);
830 void in6_rtalloc_ign(struct route_in6 *, u_long, u_int);
831 struct rtentry *in6_rtalloc1(struct sockaddr *, int, u_long, u_int);
834 #endif /* _NETINET6_IN6_VAR_H_ */