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