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