master
1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
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.
18 *
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
29 * SUCH DAMAGE.
30 *
31 * $KAME: in6_var.h,v 1.56 2001/03/29 05:34:31 itojun Exp $
32 */
33
34/*-
35 * Copyright (c) 1985, 1986, 1993
36 * The Regents of the University of California. All rights reserved.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
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.
49 *
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
60 * SUCH DAMAGE.
61 *
62 * @(#)in_var.h 8.1 (Berkeley) 6/10/93
63 */
64
65#ifndef _NETINET6_IN6_VAR_H_
66#define _NETINET6_IN6_VAR_H_
67
68#include <sys/tree.h>
69#include <sys/counter.h>
70
71#ifdef _KERNEL
72#include <sys/fnv_hash.h>
73#include <sys/libkern.h>
74#endif
75
76/*
77 * Interface address, Internet version. One of these structures
78 * is allocated for each interface with an Internet address.
79 * The ifaddr structure contains the protocol-independent part
80 * of the structure and is assumed to be first.
81 */
82
83/*
84 * pltime/vltime are just for future reference (required to implements 2
85 * hour rule for hosts). they should never be modified by nd6_timeout or
86 * anywhere else.
87 * userland -> kernel: accept pltime/vltime
88 * kernel -> userland: throw up everything
89 * in kernel: modify preferred/expire only
90 */
91struct in6_addrlifetime {
92 time_t ia6t_expire; /* valid lifetime expiration time */
93 time_t ia6t_preferred; /* preferred lifetime expiration time */
94 u_int32_t ia6t_vltime; /* valid lifetime */
95 u_int32_t ia6t_pltime; /* prefix lifetime */
96};
97
98struct nd_ifinfo;
99struct scope6_id;
100struct lltable;
101struct mld_ifsoftc;
102struct in6_multi;
103
104struct in6_ifextra {
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;
111};
112
113#define LLTABLE6(ifp) (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->lltable)
114
115#ifdef _KERNEL
116
117SLIST_HEAD(in6_multi_head, in6_multi);
118MALLOC_DECLARE(M_IP6MADDR);
119
120struct in6_ifaddr {
121 struct ifaddr ia_ifa; /* protocol-independent info */
122#define ia_ifp ia_ifa.ifa_ifp
123#define ia_flags ia_ifa.ifa_flags
124 struct sockaddr_in6 ia_addr; /* interface address */
125 struct sockaddr_in6 ia_net; /* network number of interface */
126 struct sockaddr_in6 ia_dstaddr; /* space for destination addr */
127 struct sockaddr_in6 ia_prefixmask; /* prefix mask */
128 u_int32_t ia_plen; /* prefix length */
129 CK_STAILQ_ENTRY(in6_ifaddr) ia_link; /* list of IPv6 addresses */
130 int ia6_flags;
131
132 struct in6_addrlifetime ia6_lifetime;
133 time_t ia6_createtime; /* the creation time of this address, which is
134 * currently used for temporary addresses only.
135 */
136 time_t ia6_updatetime;
137
138 /* back pointer to the ND prefix (for autoconfigured addresses only) */
139 struct nd_prefix *ia6_ndpr;
140
141 /* multicast addresses joined from the kernel */
142 LIST_HEAD(, in6_multi_mship) ia6_memberships;
143 /* entry in bucket of inet6 addresses */
144 CK_LIST_ENTRY(in6_ifaddr) ia6_hash;
145};
146
147/* List of in6_ifaddr's. */
148CK_STAILQ_HEAD(in6_ifaddrhead, in6_ifaddr);
149CK_LIST_HEAD(in6_ifaddrlisthead, in6_ifaddr);
150#endif /* _KERNEL */
151
152/* control structure to manage address selection policy */
153struct in6_addrpolicy {
154 struct sockaddr_in6 addr; /* prefix address */
155 struct sockaddr_in6 addrmask; /* prefix mask */
156 int preced; /* precedence */
157 int label; /* matching label */
158 u_quad_t use; /* statistics */
159};
160
161/*
162 * IPv6 interface statistics, as defined in RFC2465 Ipv6IfStatsEntry (p12).
163 */
164struct in6_ifstat {
165 uint64_t ifs6_in_receive; /* # of total input datagram */
166 uint64_t ifs6_in_hdrerr; /* # of datagrams with invalid hdr */
167 uint64_t ifs6_in_toobig; /* # of datagrams exceeded MTU */
168 uint64_t ifs6_in_noroute; /* # of datagrams with no route */
169 uint64_t ifs6_in_addrerr; /* # of datagrams with invalid dst */
170 uint64_t ifs6_in_protounknown; /* # of datagrams with unknown proto */
171 /* NOTE: increment on final dst if */
172 uint64_t ifs6_in_truncated; /* # of truncated datagrams */
173 uint64_t ifs6_in_discard; /* # of discarded datagrams */
174 /* NOTE: fragment timeout is not here */
175 uint64_t ifs6_in_deliver; /* # of datagrams delivered to ULP */
176 /* NOTE: increment on final dst if */
177 uint64_t ifs6_out_forward; /* # of datagrams forwarded */
178 /* NOTE: increment on outgoing if */
179 uint64_t ifs6_out_request; /* # of outgoing datagrams from ULP */
180 /* NOTE: does not include forwrads */
181 uint64_t ifs6_out_discard; /* # of discarded datagrams */
182 uint64_t ifs6_out_fragok; /* # of datagrams fragmented */
183 uint64_t ifs6_out_fragfail; /* # of datagrams failed on fragment */
184 uint64_t ifs6_out_fragcreat; /* # of fragment datagrams */
185 /* NOTE: this is # after fragment */
186 uint64_t ifs6_reass_reqd; /* # of incoming fragmented packets */
187 /* NOTE: increment on final dst if */
188 uint64_t ifs6_reass_ok; /* # of reassembled packets */
189 /* NOTE: this is # after reass */
190 /* NOTE: increment on final dst if */
191 uint64_t ifs6_reass_fail; /* # of reass failures */
192 /* NOTE: may not be packet count */
193 /* NOTE: increment on final dst if */
194 uint64_t ifs6_in_mcast; /* # of inbound multicast datagrams */
195 uint64_t ifs6_out_mcast; /* # of outbound multicast datagrams */
196};
197
198/*
199 * ICMPv6 interface statistics, as defined in RFC2466 Ipv6IfIcmpEntry.
200 * XXX: I'm not sure if this file is the right place for this structure...
201 */
202struct icmp6_ifstat {
203 /*
204 * Input statistics
205 */
206 /* ipv6IfIcmpInMsgs, total # of input messages */
207 uint64_t ifs6_in_msg;
208 /* ipv6IfIcmpInErrors, # of input error messages */
209 uint64_t ifs6_in_error;
210 /* ipv6IfIcmpInDestUnreachs, # of input dest unreach errors */
211 uint64_t ifs6_in_dstunreach;
212 /* ipv6IfIcmpInAdminProhibs, # of input administratively prohibited errs */
213 uint64_t ifs6_in_adminprohib;
214 /* ipv6IfIcmpInTimeExcds, # of input time exceeded errors */
215 uint64_t ifs6_in_timeexceed;
216 /* ipv6IfIcmpInParmProblems, # of input parameter problem errors */
217 uint64_t ifs6_in_paramprob;
218 /* ipv6IfIcmpInPktTooBigs, # of input packet too big errors */
219 uint64_t ifs6_in_pkttoobig;
220 /* ipv6IfIcmpInEchos, # of input echo requests */
221 uint64_t ifs6_in_echo;
222 /* ipv6IfIcmpInEchoReplies, # of input echo replies */
223 uint64_t ifs6_in_echoreply;
224 /* ipv6IfIcmpInRouterSolicits, # of input router solicitations */
225 uint64_t ifs6_in_routersolicit;
226 /* ipv6IfIcmpInRouterAdvertisements, # of input router advertisements */
227 uint64_t ifs6_in_routeradvert;
228 /* ipv6IfIcmpInNeighborSolicits, # of input neighbor solicitations */
229 uint64_t ifs6_in_neighborsolicit;
230 /* ipv6IfIcmpInNeighborAdvertisements, # of input neighbor advertisements */
231 uint64_t ifs6_in_neighboradvert;
232 /* ipv6IfIcmpInRedirects, # of input redirects */
233 uint64_t ifs6_in_redirect;
234 /* ipv6IfIcmpInGroupMembQueries, # of input MLD queries */
235 uint64_t ifs6_in_mldquery;
236 /* ipv6IfIcmpInGroupMembResponses, # of input MLD reports */
237 uint64_t ifs6_in_mldreport;
238 /* ipv6IfIcmpInGroupMembReductions, # of input MLD done */
239 uint64_t ifs6_in_mlddone;
240
241 /*
242 * Output statistics. We should solve unresolved routing problem...
243 */
244 /* ipv6IfIcmpOutMsgs, total # of output messages */
245 uint64_t ifs6_out_msg;
246 /* ipv6IfIcmpOutErrors, # of output error messages */
247 uint64_t ifs6_out_error;
248 /* ipv6IfIcmpOutDestUnreachs, # of output dest unreach errors */
249 uint64_t ifs6_out_dstunreach;
250 /* ipv6IfIcmpOutAdminProhibs, # of output administratively prohibited errs */
251 uint64_t ifs6_out_adminprohib;
252 /* ipv6IfIcmpOutTimeExcds, # of output time exceeded errors */
253 uint64_t ifs6_out_timeexceed;
254 /* ipv6IfIcmpOutParmProblems, # of output parameter problem errors */
255 uint64_t ifs6_out_paramprob;
256 /* ipv6IfIcmpOutPktTooBigs, # of output packet too big errors */
257 uint64_t ifs6_out_pkttoobig;
258 /* ipv6IfIcmpOutEchos, # of output echo requests */
259 uint64_t ifs6_out_echo;
260 /* ipv6IfIcmpOutEchoReplies, # of output echo replies */
261 uint64_t ifs6_out_echoreply;
262 /* ipv6IfIcmpOutRouterSolicits, # of output router solicitations */
263 uint64_t ifs6_out_routersolicit;
264 /* ipv6IfIcmpOutRouterAdvertisements, # of output router advertisements */
265 uint64_t ifs6_out_routeradvert;
266 /* ipv6IfIcmpOutNeighborSolicits, # of output neighbor solicitations */
267 uint64_t ifs6_out_neighborsolicit;
268 /* ipv6IfIcmpOutNeighborAdvertisements, # of output neighbor advertisements */
269 uint64_t ifs6_out_neighboradvert;
270 /* ipv6IfIcmpOutRedirects, # of output redirects */
271 uint64_t ifs6_out_redirect;
272 /* ipv6IfIcmpOutGroupMembQueries, # of output MLD queries */
273 uint64_t ifs6_out_mldquery;
274 /* ipv6IfIcmpOutGroupMembResponses, # of output MLD reports */
275 uint64_t ifs6_out_mldreport;
276 /* ipv6IfIcmpOutGroupMembReductions, # of output MLD done */
277 uint64_t ifs6_out_mlddone;
278};
279
280struct in6_ifreq {
281 char ifr_name[IFNAMSIZ];
282 union {
283 struct sockaddr_in6 ifru_addr;
284 struct sockaddr_in6 ifru_dstaddr;
285 int ifru_flags;
286 int ifru_flags6;
287 int ifru_metric;
288 caddr_t ifru_data;
289 struct in6_addrlifetime ifru_lifetime;
290 struct in6_ifstat ifru_stat;
291 struct icmp6_ifstat ifru_icmp6stat;
292 u_int32_t ifru_scope_id[16];
293 } ifr_ifru;
294};
295
296struct in6_aliasreq {
297 char ifra_name[IFNAMSIZ];
298 struct sockaddr_in6 ifra_addr;
299 struct sockaddr_in6 ifra_dstaddr;
300 struct sockaddr_in6 ifra_prefixmask;
301 int ifra_flags;
302 struct in6_addrlifetime ifra_lifetime;
303 int ifra_vhid;
304};
305
306/* pre-10.x compat */
307struct oin6_aliasreq {
308 char ifra_name[IFNAMSIZ];
309 struct sockaddr_in6 ifra_addr;
310 struct sockaddr_in6 ifra_dstaddr;
311 struct sockaddr_in6 ifra_prefixmask;
312 int ifra_flags;
313 struct in6_addrlifetime ifra_lifetime;
314};
315
316/* prefix type macro */
317#define IN6_PREFIX_ND 1
318#define IN6_PREFIX_RR 2
319
320/*
321 * prefix related flags passed between kernel(NDP related part) and
322 * user land command(ifconfig) and daemon(rtadvd).
323 */
324struct in6_prflags {
325 struct prf_ra {
326 u_char onlink : 1;
327 u_char autonomous : 1;
328 u_char ra_derived: 1;
329 u_char reserved : 5;
330 } prf_ra;
331 u_char prf_reserved1;
332 u_short prf_reserved2;
333 /* want to put this on 4byte offset */
334 struct prf_rr {
335 u_char decrvalid : 1;
336 u_char decrprefd : 1;
337 u_char reserved : 6;
338 } prf_rr;
339 u_char prf_reserved3;
340 u_short prf_reserved4;
341};
342
343struct in6_prefixreq {
344 char ipr_name[IFNAMSIZ];
345 u_char ipr_origin;
346 u_char ipr_plen;
347 u_int32_t ipr_vltime;
348 u_int32_t ipr_pltime;
349 struct in6_prflags ipr_flags;
350 struct sockaddr_in6 ipr_prefix;
351};
352
353#define PR_ORIG_RA 0
354#define PR_ORIG_RR 1
355#define PR_ORIG_STATIC 2
356#define PR_ORIG_KERNEL 3
357
358#define ipr_raf_onlink ipr_flags.prf_ra.onlink
359#define ipr_raf_auto ipr_flags.prf_ra.autonomous
360#define ipr_raf_ra_derived ipr_flags.prf_ra.ra_derived
361
362#define ipr_statef_onlink ipr_flags.prf_state.onlink
363
364#define ipr_rrf_decrvalid ipr_flags.prf_rr.decrvalid
365#define ipr_rrf_decrprefd ipr_flags.prf_rr.decrprefd
366
367struct in6_rrenumreq {
368 char irr_name[IFNAMSIZ];
369 u_char irr_origin;
370 u_char irr_m_len; /* match len for matchprefix */
371 u_char irr_m_minlen; /* minlen for matching prefix */
372 u_char irr_m_maxlen; /* maxlen for matching prefix */
373 u_char irr_u_uselen; /* uselen for adding prefix */
374 u_char irr_u_keeplen; /* keeplen from matching prefix */
375 struct irr_raflagmask {
376 u_char onlink : 1;
377 u_char autonomous : 1;
378 u_char reserved : 6;
379 } irr_raflagmask;
380 u_int32_t irr_vltime;
381 u_int32_t irr_pltime;
382 struct in6_prflags irr_flags;
383 struct sockaddr_in6 irr_matchprefix;
384 struct sockaddr_in6 irr_useprefix;
385};
386
387#define irr_raf_mask_onlink irr_raflagmask.onlink
388#define irr_raf_mask_auto irr_raflagmask.autonomous
389#define irr_raf_mask_reserved irr_raflagmask.reserved
390
391#define irr_raf_onlink irr_flags.prf_ra.onlink
392#define irr_raf_auto irr_flags.prf_ra.autonomous
393
394#define irr_statef_onlink irr_flags.prf_state.onlink
395
396#define irr_rrf irr_flags.prf_rr
397#define irr_rrf_decrvalid irr_flags.prf_rr.decrvalid
398#define irr_rrf_decrprefd irr_flags.prf_rr.decrprefd
399
400/*
401 * Given a pointer to an in6_ifaddr (ifaddr),
402 * return a pointer to the addr as a sockaddr_in6
403 */
404#define IA6_IN6(ia) (&((ia)->ia_addr.sin6_addr))
405#define IA6_DSTIN6(ia) (&((ia)->ia_dstaddr.sin6_addr))
406#define IA6_MASKIN6(ia) (&((ia)->ia_prefixmask.sin6_addr))
407#define IA6_SIN6(ia) (&((ia)->ia_addr))
408#define IA6_DSTSIN6(ia) (&((ia)->ia_dstaddr))
409#define IFA_IN6(x) (&((struct sockaddr_in6 *)((x)->ifa_addr))->sin6_addr)
410#define IFA_DSTIN6(x) (&((struct sockaddr_in6 *)((x)->ifa_dstaddr))->sin6_addr)
411#define IFA_MASKIN6(x) (&((struct sockaddr_in6 *)((x)->ifa_netmask))->sin6_addr)
412
413#define IFPR_IN6(x) (&((struct sockaddr_in6 *)((x)->ifpr_prefix))->sin6_addr)
414
415#ifdef _KERNEL
416#define IN6_ARE_MASKED_ADDR_EQUAL(d, a, m) ( \
417 (((d)->s6_addr32[0] ^ (a)->s6_addr32[0]) & (m)->s6_addr32[0]) == 0 && \
418 (((d)->s6_addr32[1] ^ (a)->s6_addr32[1]) & (m)->s6_addr32[1]) == 0 && \
419 (((d)->s6_addr32[2] ^ (a)->s6_addr32[2]) & (m)->s6_addr32[2]) == 0 && \
420 (((d)->s6_addr32[3] ^ (a)->s6_addr32[3]) & (m)->s6_addr32[3]) == 0 )
421#define IN6_MASK_ADDR(a, m) do { \
422 (a)->s6_addr32[0] &= (m)->s6_addr32[0]; \
423 (a)->s6_addr32[1] &= (m)->s6_addr32[1]; \
424 (a)->s6_addr32[2] &= (m)->s6_addr32[2]; \
425 (a)->s6_addr32[3] &= (m)->s6_addr32[3]; \
426} while (0)
427#endif
428
429#define SIOCSIFADDR_IN6 _IOW('i', 12, struct in6_ifreq)
430#define SIOCGIFADDR_IN6 _IOWR('i', 33, struct in6_ifreq)
431
432#ifdef _KERNEL
433/*
434 * SIOCSxxx ioctls should be unused (see comments in in6.c), but
435 * we do not shift numbers for binary compatibility.
436 */
437#define SIOCSIFDSTADDR_IN6 _IOW('i', 14, struct in6_ifreq)
438#define SIOCSIFNETMASK_IN6 _IOW('i', 22, struct in6_ifreq)
439#endif
440
441#define SIOCGIFDSTADDR_IN6 _IOWR('i', 34, struct in6_ifreq)
442#define SIOCGIFNETMASK_IN6 _IOWR('i', 37, struct in6_ifreq)
443
444#define SIOCDIFADDR_IN6 _IOW('i', 25, struct in6_ifreq)
445#define OSIOCAIFADDR_IN6 _IOW('i', 26, struct oin6_aliasreq)
446#define SIOCAIFADDR_IN6 _IOW('i', 27, struct in6_aliasreq)
447
448#define SIOCSIFPHYADDR_IN6 _IOW('i', 70, struct in6_aliasreq)
449#define SIOCGIFPSRCADDR_IN6 _IOWR('i', 71, struct in6_ifreq)
450#define SIOCGIFPDSTADDR_IN6 _IOWR('i', 72, struct in6_ifreq)
451
452#define SIOCGIFAFLAG_IN6 _IOWR('i', 73, struct in6_ifreq)
453
454#ifdef _KERNEL
455#define OSIOCGIFINFO_IN6 _IOWR('i', 76, struct in6_ondireq)
456#endif
457#define SIOCGIFINFO_IN6 _IOWR('i', 108, struct in6_ndireq)
458#define SIOCSIFINFO_IN6 _IOWR('i', 109, struct in6_ndireq)
459#define SIOCSNDFLUSH_IN6 _IOWR('i', 77, struct in6_ifreq)
460#define SIOCGNBRINFO_IN6 _IOWR('i', 78, struct in6_nbrinfo)
461#define SIOCSPFXFLUSH_IN6 _IOWR('i', 79, struct in6_ifreq)
462#define SIOCSRTRFLUSH_IN6 _IOWR('i', 80, struct in6_ifreq)
463
464#define SIOCGIFALIFETIME_IN6 _IOWR('i', 81, struct in6_ifreq)
465#define SIOCGIFSTAT_IN6 _IOWR('i', 83, struct in6_ifreq)
466#define SIOCGIFSTAT_ICMP6 _IOWR('i', 84, struct in6_ifreq)
467
468#define SIOCSDEFIFACE_IN6 _IOWR('i', 85, struct in6_ndifreq)
469#define SIOCGDEFIFACE_IN6 _IOWR('i', 86, struct in6_ndifreq)
470
471#define SIOCSIFINFO_FLAGS _IOWR('i', 87, struct in6_ndireq) /* XXX */
472
473#define SIOCSSCOPE6 _IOW('i', 88, struct in6_ifreq)
474#define SIOCGSCOPE6 _IOWR('i', 89, struct in6_ifreq)
475#define SIOCGSCOPE6DEF _IOWR('i', 90, struct in6_ifreq)
476
477#define SIOCSIFPREFIX_IN6 _IOW('i', 100, struct in6_prefixreq) /* set */
478#define SIOCGIFPREFIX_IN6 _IOWR('i', 101, struct in6_prefixreq) /* get */
479#define SIOCDIFPREFIX_IN6 _IOW('i', 102, struct in6_prefixreq) /* del */
480#define SIOCAIFPREFIX_IN6 _IOW('i', 103, struct in6_rrenumreq) /* add */
481#define SIOCCIFPREFIX_IN6 _IOW('i', 104, \
482 struct in6_rrenumreq) /* change */
483#define SIOCSGIFPREFIX_IN6 _IOW('i', 105, \
484 struct in6_rrenumreq) /* set global */
485
486#define SIOCGETSGCNT_IN6 _IOWR('u', 106, \
487 struct sioc_sg_req6) /* get s,g pkt cnt */
488#define SIOCGETMIFCNT_IN6 _IOWR('u', 107, \
489 struct sioc_mif_req6) /* get pkt cnt per if */
490
491#define SIOCAADDRCTL_POLICY _IOW('u', 108, struct in6_addrpolicy)
492#define SIOCDADDRCTL_POLICY _IOW('u', 109, struct in6_addrpolicy)
493
494#define IN6_IFF_ANYCAST 0x01 /* anycast address */
495#define IN6_IFF_TENTATIVE 0x02 /* tentative address */
496#define IN6_IFF_DUPLICATED 0x04 /* DAD detected duplicate */
497#define IN6_IFF_DETACHED 0x08 /* may be detached from the link */
498#define IN6_IFF_DEPRECATED 0x10 /* deprecated address */
499#define IN6_IFF_NODAD 0x20 /* don't perform DAD on this address
500 * (obsolete)
501 */
502#define IN6_IFF_AUTOCONF 0x40 /* autoconfigurable address. */
503#define IN6_IFF_TEMPORARY 0x80 /* temporary (anonymous) address. */
504#define IN6_IFF_PREFER_SOURCE 0x0100 /* preferred address for SAS */
505
506/* do not input/output */
507#define IN6_IFF_NOTREADY (IN6_IFF_TENTATIVE|IN6_IFF_DUPLICATED)
508
509#ifdef _KERNEL
510#define IN6_ARE_SCOPE_CMP(a,b) ((a)-(b))
511#define IN6_ARE_SCOPE_EQUAL(a,b) ((a)==(b))
512#endif
513
514#ifdef _KERNEL
515VNET_DECLARE(struct in6_ifaddrhead, in6_ifaddrhead);
516VNET_DECLARE(struct in6_ifaddrlisthead *, in6_ifaddrhashtbl);
517VNET_DECLARE(u_long, in6_ifaddrhmask);
518#define V_in6_ifaddrhead VNET(in6_ifaddrhead)
519#define V_in6_ifaddrhashtbl VNET(in6_ifaddrhashtbl)
520#define V_in6_ifaddrhmask VNET(in6_ifaddrhmask)
521
522#define IN6ADDR_NHASH_LOG2 8
523#define IN6ADDR_NHASH (1 << IN6ADDR_NHASH_LOG2)
524#define IN6ADDR_HASHVAL(x) (in6_addrhash(x))
525#define IN6ADDR_HASH(x) \
526 (&V_in6_ifaddrhashtbl[IN6ADDR_HASHVAL(x) & V_in6_ifaddrhmask])
527
528static __inline uint32_t
529in6_addrhash(const struct in6_addr *in6)
530{
531 uint32_t x;
532
533 x = in6->s6_addr32[0] ^ in6->s6_addr32[1] ^ in6->s6_addr32[2] ^
534 in6->s6_addr32[3];
535 return (fnv_32_buf(&x, sizeof(x), FNV1_32_INIT));
536}
537
538extern struct rmlock in6_ifaddr_lock;
539#define IN6_IFADDR_LOCK_ASSERT() rm_assert(&in6_ifaddr_lock, RA_LOCKED)
540#define IN6_IFADDR_RLOCK(t) rm_rlock(&in6_ifaddr_lock, (t))
541#define IN6_IFADDR_RLOCK_ASSERT() rm_assert(&in6_ifaddr_lock, RA_RLOCKED)
542#define IN6_IFADDR_RUNLOCK(t) rm_runlock(&in6_ifaddr_lock, (t))
543#define IN6_IFADDR_WLOCK() rm_wlock(&in6_ifaddr_lock)
544#define IN6_IFADDR_WLOCK_ASSERT() rm_assert(&in6_ifaddr_lock, RA_WLOCKED)
545#define IN6_IFADDR_WUNLOCK() rm_wunlock(&in6_ifaddr_lock)
546
547#define in6_ifstat_inc(ifp, tag) \
548do { \
549 if (ifp) \
550 counter_u64_add(((struct in6_ifextra *) \
551 ((ifp)->if_afdata[AF_INET6]))->in6_ifstat[ \
552 offsetof(struct in6_ifstat, tag) / sizeof(uint64_t)], 1);\
553} while (/*CONSTCOND*/ 0)
554
555VNET_DECLARE(unsigned long, in6_maxmtu);
556#define V_in6_maxmtu VNET(in6_maxmtu)
557#endif /* _KERNEL */
558
559/*
560 * IPv6 multicast MLD-layer source entry.
561 */
562struct ip6_msource {
563 RB_ENTRY(ip6_msource) im6s_link; /* RB tree links */
564 struct in6_addr im6s_addr;
565 struct im6s_st {
566 uint16_t ex; /* # of exclusive members */
567 uint16_t in; /* # of inclusive members */
568 } im6s_st[2]; /* state at t0, t1 */
569 uint8_t im6s_stp; /* pending query */
570};
571RB_HEAD(ip6_msource_tree, ip6_msource);
572
573/*
574 * IPv6 multicast PCB-layer source entry.
575 *
576 * NOTE: overlapping use of struct ip6_msource fields at start.
577 */
578struct in6_msource {
579 RB_ENTRY(ip6_msource) im6s_link; /* Common field */
580 struct in6_addr im6s_addr; /* Common field */
581 uint8_t im6sl_st[2]; /* state before/at commit */
582};
583
584#ifdef _KERNEL
585/*
586 * IPv6 source tree comparison function.
587 *
588 * An ordered predicate is necessary; bcmp() is not documented to return
589 * an indication of order, memcmp() is, and is an ISO C99 requirement.
590 */
591static __inline int
592ip6_msource_cmp(const struct ip6_msource *a, const struct ip6_msource *b)
593{
594
595 return (memcmp(&a->im6s_addr, &b->im6s_addr, sizeof(struct in6_addr)));
596}
597RB_PROTOTYPE(ip6_msource_tree, ip6_msource, im6s_link, ip6_msource_cmp);
598
599/*
600 * IPv6 multicast PCB-layer group filter descriptor.
601 */
602struct in6_mfilter {
603 struct ip6_msource_tree im6f_sources; /* source list for (S,G) */
604 u_long im6f_nsrc; /* # of source entries */
605 uint8_t im6f_st[2]; /* state before/at commit */
606 struct in6_multi *im6f_in6m; /* associated multicast address */
607 STAILQ_ENTRY(in6_mfilter) im6f_entry; /* list entry */
608};
609
610/*
611 * Helper types and functions for IPv4 multicast filters.
612 */
613STAILQ_HEAD(ip6_mfilter_head, in6_mfilter);
614
615struct in6_mfilter *ip6_mfilter_alloc(int mflags, int st0, int st1);
616void ip6_mfilter_free(struct in6_mfilter *);
617
618static inline void
619ip6_mfilter_init(struct ip6_mfilter_head *head)
620{
621
622 STAILQ_INIT(head);
623}
624
625static inline struct in6_mfilter *
626ip6_mfilter_first(const struct ip6_mfilter_head *head)
627{
628
629 return (STAILQ_FIRST(head));
630}
631
632static inline void
633ip6_mfilter_insert(struct ip6_mfilter_head *head, struct in6_mfilter *imf)
634{
635
636 STAILQ_INSERT_TAIL(head, imf, im6f_entry);
637}
638
639static inline void
640ip6_mfilter_remove(struct ip6_mfilter_head *head, struct in6_mfilter *imf)
641{
642
643 STAILQ_REMOVE(head, imf, in6_mfilter, im6f_entry);
644}
645
646#define IP6_MFILTER_FOREACH(imf, head) \
647 STAILQ_FOREACH(imf, head, im6f_entry)
648
649static inline size_t
650ip6_mfilter_count(struct ip6_mfilter_head *head)
651{
652 struct in6_mfilter *imf;
653 size_t num = 0;
654
655 STAILQ_FOREACH(imf, head, im6f_entry)
656 num++;
657 return (num);
658}
659
660/*
661 * Legacy KAME IPv6 multicast membership descriptor.
662 */
663struct in6_multi_mship {
664 struct in6_multi *i6mm_maddr;
665 LIST_ENTRY(in6_multi_mship) i6mm_chain;
666};
667
668/*
669 * IPv6 group descriptor.
670 *
671 * For every entry on an ifnet's if_multiaddrs list which represents
672 * an IP multicast group, there is one of these structures.
673 *
674 * If any source filters are present, then a node will exist in the RB-tree
675 * to permit fast lookup by source whenever an operation takes place.
676 * This permits pre-order traversal when we issue reports.
677 * Source filter trees are kept separately from the socket layer to
678 * greatly simplify locking.
679 *
680 * When MLDv2 is active, in6m_timer is the response to group query timer.
681 * The state-change timer in6m_sctimer is separate; whenever state changes
682 * for the group the state change record is generated and transmitted,
683 * and kept if retransmissions are necessary.
684 *
685 * FUTURE: in6m_link is now only used when groups are being purged
686 * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but
687 * because it is at the very start of the struct, we can't do this
688 * w/o breaking the ABI for ifmcstat.
689 */
690struct in6_multi {
691 struct in6_addr in6m_addr; /* IPv6 multicast address */
692 struct ifnet *in6m_ifp; /* back pointer to ifnet */
693 struct ifmultiaddr *in6m_ifma; /* back pointer to ifmultiaddr */
694 u_int in6m_refcount; /* reference count */
695 u_int in6m_state; /* state of the membership */
696 u_int in6m_timer; /* MLD6 listener report timer */
697
698 /* New fields for MLDv2 follow. */
699 struct mld_ifsoftc *in6m_mli; /* MLD info */
700 SLIST_ENTRY(in6_multi) in6m_nrele; /* to-be-released by MLD */
701 SLIST_ENTRY(in6_multi) in6m_defer; /* deferred MLDv1 */
702 struct ip6_msource_tree in6m_srcs; /* tree of sources */
703 u_long in6m_nsrc; /* # of tree entries */
704
705 struct mbufq in6m_scq; /* queue of pending
706 * state-change packets */
707 struct timeval in6m_lastgsrtv; /* last G-S-R query */
708 uint16_t in6m_sctimer; /* state-change timer */
709 uint16_t in6m_scrv; /* state-change rexmit count */
710
711 /*
712 * SSM state counters which track state at T0 (the time the last
713 * state-change report's RV timer went to zero) and T1
714 * (time of pending report, i.e. now).
715 * Used for computing MLDv2 state-change reports. Several refcounts
716 * are maintained here to optimize for common use-cases.
717 */
718 struct in6m_st {
719 uint16_t iss_fmode; /* MLD filter mode */
720 uint16_t iss_asm; /* # of ASM listeners */
721 uint16_t iss_ex; /* # of exclusive members */
722 uint16_t iss_in; /* # of inclusive members */
723 uint16_t iss_rec; /* # of recorded sources */
724 } in6m_st[2]; /* state at t0, t1 */
725};
726
727void in6m_disconnect_locked(struct in6_multi_head *inmh, struct in6_multi *inm);
728
729/*
730 * Helper function to derive the filter mode on a source entry
731 * from its internal counters. Predicates are:
732 * A source is only excluded if all listeners exclude it.
733 * A source is only included if no listeners exclude it,
734 * and at least one listener includes it.
735 * May be used by ifmcstat(8).
736 */
737static __inline uint8_t
738im6s_get_mode(const struct in6_multi *inm, const struct ip6_msource *ims,
739 uint8_t t)
740{
741
742 t = !!t;
743 if (inm->in6m_st[t].iss_ex > 0 &&
744 inm->in6m_st[t].iss_ex == ims->im6s_st[t].ex)
745 return (MCAST_EXCLUDE);
746 else if (ims->im6s_st[t].in > 0 && ims->im6s_st[t].ex == 0)
747 return (MCAST_INCLUDE);
748 return (MCAST_UNDEFINED);
749}
750
751/*
752 * Lock macros for IPv6 layer multicast address lists. IPv6 lock goes
753 * before link layer multicast locks in the lock order. In most cases,
754 * consumers of IN_*_MULTI() macros should acquire the locks before
755 * calling them; users of the in_{add,del}multi() functions should not.
756 */
757extern struct mtx in6_multi_list_mtx;
758extern struct sx in6_multi_sx;
759
760#define IN6_MULTI_LIST_LOCK() mtx_lock(&in6_multi_list_mtx)
761#define IN6_MULTI_LIST_UNLOCK() mtx_unlock(&in6_multi_list_mtx)
762#define IN6_MULTI_LIST_LOCK_ASSERT() mtx_assert(&in6_multi_list_mtx, MA_OWNED)
763#define IN6_MULTI_LIST_UNLOCK_ASSERT() mtx_assert(&in6_multi_list_mtx, MA_NOTOWNED)
764
765#define IN6_MULTI_LOCK() sx_xlock(&in6_multi_sx)
766#define IN6_MULTI_UNLOCK() sx_xunlock(&in6_multi_sx)
767#define IN6_MULTI_LOCK_ASSERT() sx_assert(&in6_multi_sx, SA_XLOCKED)
768#define IN6_MULTI_UNLOCK_ASSERT() sx_assert(&in6_multi_sx, SA_XUNLOCKED)
769
770/*
771 * Get the in6_multi pointer from a ifmultiaddr.
772 * Returns NULL if ifmultiaddr is no longer valid.
773 */
774static __inline struct in6_multi *
775in6m_ifmultiaddr_get_inm(struct ifmultiaddr *ifma)
776{
777
778 return ((ifma->ifma_addr->sa_family != AF_INET6 ||
779 (ifma->ifma_flags & IFMA_F_ENQUEUED) == 0) ? NULL :
780 ifma->ifma_protospec);
781}
782
783struct in6_multi *
784in6m_lookup_locked(struct ifnet *ifp, const struct in6_addr *mcaddr);
785
786/*
787 * Wrapper for in6m_lookup_locked().
788 *
789 * SMPng: Assumes network epoch entered and that IN6_MULTI_LOCK() isn't held.
790 */
791static __inline struct in6_multi *
792in6m_lookup(struct ifnet *ifp, const struct in6_addr *mcaddr)
793{
794 struct in6_multi *inm;
795
796 NET_EPOCH_ASSERT();
797
798 IN6_MULTI_LIST_LOCK();
799 inm = in6m_lookup_locked(ifp, mcaddr);
800 IN6_MULTI_LIST_UNLOCK();
801
802 return (inm);
803}
804
805/* Acquire an in6_multi record. */
806static __inline void
807in6m_acquire_locked(struct in6_multi *inm)
808{
809
810 IN6_MULTI_LIST_LOCK_ASSERT();
811 ++inm->in6m_refcount;
812}
813
814static __inline void
815in6m_acquire(struct in6_multi *inm)
816{
817 IN6_MULTI_LIST_LOCK();
818 in6m_acquire_locked(inm);
819 IN6_MULTI_LIST_UNLOCK();
820}
821
822static __inline void
823in6m_rele_locked(struct in6_multi_head *inmh, struct in6_multi *inm)
824{
825 KASSERT(inm->in6m_refcount > 0, ("refcount == %d inm: %p", inm->in6m_refcount, inm));
826 IN6_MULTI_LIST_LOCK_ASSERT();
827
828 if (--inm->in6m_refcount == 0) {
829 MPASS(inm->in6m_ifp == NULL);
830 inm->in6m_ifma->ifma_protospec = NULL;
831 MPASS(inm->in6m_ifma->ifma_llifma == NULL);
832 SLIST_INSERT_HEAD(inmh, inm, in6m_nrele);
833 }
834}
835
836struct ip6_moptions;
837struct sockopt;
838struct inpcbinfo;
839struct rib_head;
840struct ucred;
841
842/* Multicast KPIs. */
843int im6o_mc_filter(const struct ip6_moptions *, const struct ifnet *,
844 const struct sockaddr *, const struct sockaddr *);
845int in6_joingroup(struct ifnet *, const struct in6_addr *,
846 struct in6_mfilter *, struct in6_multi **, int);
847int in6_leavegroup(struct in6_multi *, struct in6_mfilter *);
848int in6_leavegroup_locked(struct in6_multi *, struct in6_mfilter *);
849void in6m_clear_recorded(struct in6_multi *);
850void in6m_commit(struct in6_multi *);
851void in6m_print(const struct in6_multi *);
852int in6m_record_source(struct in6_multi *, const struct in6_addr *);
853void in6m_release_list_deferred(struct in6_multi_head *);
854void in6m_release_wait(void *);
855void ip6_freemoptions(struct ip6_moptions *);
856int ip6_getmoptions(struct inpcb *, struct sockopt *);
857int ip6_setmoptions(struct inpcb *, struct sockopt *);
858
859/* flags to in6_update_ifa */
860#define IN6_IFAUPDATE_DADDELAY 0x1 /* first time to configure an address */
861
862int in6_mask2len(struct in6_addr *, u_char *);
863int in6_control(struct socket *, u_long, void *, struct ifnet *,
864 struct thread *);
865int in6_control_ioctl(u_long, void *, struct ifnet *, struct ucred *);
866int in6_update_ifa(struct ifnet *, struct in6_aliasreq *,
867 struct in6_ifaddr *, int);
868void in6_prepare_ifra(struct in6_aliasreq *, const struct in6_addr *,
869 const struct in6_addr *);
870int in6_addifaddr(struct ifnet *, struct in6_aliasreq *, struct in6_ifaddr *);
871void in6_purgeaddr(struct ifaddr *);
872void in6_purgeifaddr(struct in6_ifaddr *);
873int in6if_do_dad(struct ifnet *);
874void in6_savemkludge(struct in6_ifaddr *);
875void *in6_domifattach(struct ifnet *);
876void in6_domifdetach(struct ifnet *, void *);
877int in6_domifmtu(struct ifnet *);
878struct rib_head *in6_inithead(uint32_t fibnum);
879void in6_detachhead(struct rib_head *rh);
880void in6_setmaxmtu(void);
881int in6_if2idlen(struct ifnet *);
882struct in6_ifaddr *in6ifa_ifpforlinklocal(struct ifnet *, int);
883struct in6_ifaddr *in6ifa_ifpwithaddr(struct ifnet *, const struct in6_addr *);
884struct in6_ifaddr *in6ifa_ifwithaddr(const struct in6_addr *, uint32_t, bool);
885struct in6_ifaddr *in6ifa_llaonifp(struct ifnet *);
886int in6_addr2zoneid(struct ifnet *, struct in6_addr *, u_int32_t *);
887int in6_matchlen(struct in6_addr *, struct in6_addr *);
888int in6_are_prefix_equal(struct in6_addr *, struct in6_addr *, int);
889void in6_prefixlen2mask(struct in6_addr *, int);
890int in6_prefix_ioctl(struct socket *, u_long, caddr_t,
891 struct ifnet *);
892int in6_prefix_add_ifid(int, struct in6_ifaddr *);
893void in6_prefix_remove_ifid(int, struct in6_ifaddr *);
894void in6_purgeprefix(struct ifnet *);
895
896int in6_is_addr_deprecated(struct sockaddr_in6 *);
897int in6_src_ioctl(u_long, caddr_t);
898
899void in6_newaddrmsg(struct in6_ifaddr *, int);
900
901void in6_purge_proxy_ndp(struct ifnet *);
902/*
903 * Extended API for IPv6 FIB support.
904 */
905struct mbuf *ip6_tryforward(struct mbuf *);
906#endif /* _KERNEL */
907
908#endif /* _NETINET6_IN6_VAR_H_ */