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