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