in6_var.h revision 195727
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 195727 2009-07-16 21:13:04Z rwatson $
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 */
88struct 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
95struct nd_ifinfo;
96struct scope6_id;
97struct lltable;
98struct mld_ifinfo;
99
100struct 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
111struct	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. */
137TAILQ_HEAD(in6_ifaddrhead, in6_ifaddr);
138
139/* control structure to manage address selection policy */
140struct 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 */
151struct 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 */
189struct 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
267struct	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
283struct	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};
291
292/* prefix type macro */
293#define IN6_PREFIX_ND	1
294#define IN6_PREFIX_RR	2
295
296/*
297 * prefix related flags passed between kernel(NDP related part) and
298 * user land command(ifconfig) and daemon(rtadvd).
299 */
300struct in6_prflags {
301	struct prf_ra {
302		u_char onlink : 1;
303		u_char autonomous : 1;
304		u_char reserved : 6;
305	} prf_ra;
306	u_char prf_reserved1;
307	u_short prf_reserved2;
308	/* want to put this on 4byte offset */
309	struct prf_rr {
310		u_char decrvalid : 1;
311		u_char decrprefd : 1;
312		u_char reserved : 6;
313	} prf_rr;
314	u_char prf_reserved3;
315	u_short prf_reserved4;
316};
317
318struct  in6_prefixreq {
319	char	ipr_name[IFNAMSIZ];
320	u_char	ipr_origin;
321	u_char	ipr_plen;
322	u_int32_t ipr_vltime;
323	u_int32_t ipr_pltime;
324	struct in6_prflags ipr_flags;
325	struct	sockaddr_in6 ipr_prefix;
326};
327
328#define PR_ORIG_RA	0
329#define PR_ORIG_RR	1
330#define PR_ORIG_STATIC	2
331#define PR_ORIG_KERNEL	3
332
333#define ipr_raf_onlink		ipr_flags.prf_ra.onlink
334#define ipr_raf_auto		ipr_flags.prf_ra.autonomous
335
336#define ipr_statef_onlink	ipr_flags.prf_state.onlink
337
338#define ipr_rrf_decrvalid	ipr_flags.prf_rr.decrvalid
339#define ipr_rrf_decrprefd	ipr_flags.prf_rr.decrprefd
340
341struct	in6_rrenumreq {
342	char	irr_name[IFNAMSIZ];
343	u_char	irr_origin;
344	u_char	irr_m_len;	/* match len for matchprefix */
345	u_char	irr_m_minlen;	/* minlen for matching prefix */
346	u_char	irr_m_maxlen;	/* maxlen for matching prefix */
347	u_char	irr_u_uselen;	/* uselen for adding prefix */
348	u_char	irr_u_keeplen;	/* keeplen from matching prefix */
349	struct irr_raflagmask {
350		u_char onlink : 1;
351		u_char autonomous : 1;
352		u_char reserved : 6;
353	} irr_raflagmask;
354	u_int32_t irr_vltime;
355	u_int32_t irr_pltime;
356	struct in6_prflags irr_flags;
357	struct	sockaddr_in6 irr_matchprefix;
358	struct	sockaddr_in6 irr_useprefix;
359};
360
361#define irr_raf_mask_onlink	irr_raflagmask.onlink
362#define irr_raf_mask_auto	irr_raflagmask.autonomous
363#define irr_raf_mask_reserved	irr_raflagmask.reserved
364
365#define irr_raf_onlink		irr_flags.prf_ra.onlink
366#define irr_raf_auto		irr_flags.prf_ra.autonomous
367
368#define irr_statef_onlink	irr_flags.prf_state.onlink
369
370#define irr_rrf			irr_flags.prf_rr
371#define irr_rrf_decrvalid	irr_flags.prf_rr.decrvalid
372#define irr_rrf_decrprefd	irr_flags.prf_rr.decrprefd
373
374/*
375 * Given a pointer to an in6_ifaddr (ifaddr),
376 * return a pointer to the addr as a sockaddr_in6
377 */
378#define IA6_IN6(ia)	(&((ia)->ia_addr.sin6_addr))
379#define IA6_DSTIN6(ia)	(&((ia)->ia_dstaddr.sin6_addr))
380#define IA6_MASKIN6(ia)	(&((ia)->ia_prefixmask.sin6_addr))
381#define IA6_SIN6(ia)	(&((ia)->ia_addr))
382#define IA6_DSTSIN6(ia)	(&((ia)->ia_dstaddr))
383#define IFA_IN6(x)	(&((struct sockaddr_in6 *)((x)->ifa_addr))->sin6_addr)
384#define IFA_DSTIN6(x)	(&((struct sockaddr_in6 *)((x)->ifa_dstaddr))->sin6_addr)
385
386#define IFPR_IN6(x)	(&((struct sockaddr_in6 *)((x)->ifpr_prefix))->sin6_addr)
387
388#ifdef _KERNEL
389#define IN6_ARE_MASKED_ADDR_EQUAL(d, a, m)	(	\
390	(((d)->s6_addr32[0] ^ (a)->s6_addr32[0]) & (m)->s6_addr32[0]) == 0 && \
391	(((d)->s6_addr32[1] ^ (a)->s6_addr32[1]) & (m)->s6_addr32[1]) == 0 && \
392	(((d)->s6_addr32[2] ^ (a)->s6_addr32[2]) & (m)->s6_addr32[2]) == 0 && \
393	(((d)->s6_addr32[3] ^ (a)->s6_addr32[3]) & (m)->s6_addr32[3]) == 0 )
394#endif
395
396#define SIOCSIFADDR_IN6		 _IOW('i', 12, struct in6_ifreq)
397#define SIOCGIFADDR_IN6		_IOWR('i', 33, struct in6_ifreq)
398
399#ifdef _KERNEL
400/*
401 * SIOCSxxx ioctls should be unused (see comments in in6.c), but
402 * we do not shift numbers for binary compatibility.
403 */
404#define SIOCSIFDSTADDR_IN6	 _IOW('i', 14, struct in6_ifreq)
405#define SIOCSIFNETMASK_IN6	 _IOW('i', 22, struct in6_ifreq)
406#endif
407
408#define SIOCGIFDSTADDR_IN6	_IOWR('i', 34, struct in6_ifreq)
409#define SIOCGIFNETMASK_IN6	_IOWR('i', 37, struct in6_ifreq)
410
411#define SIOCDIFADDR_IN6		 _IOW('i', 25, struct in6_ifreq)
412#define SIOCAIFADDR_IN6		 _IOW('i', 26, struct in6_aliasreq)
413
414#define SIOCSIFPHYADDR_IN6       _IOW('i', 70, struct in6_aliasreq)
415#define	SIOCGIFPSRCADDR_IN6	_IOWR('i', 71, struct in6_ifreq)
416#define	SIOCGIFPDSTADDR_IN6	_IOWR('i', 72, struct in6_ifreq)
417
418#define SIOCGIFAFLAG_IN6	_IOWR('i', 73, struct in6_ifreq)
419
420#define SIOCGDRLST_IN6		_IOWR('i', 74, struct in6_drlist)
421#ifdef _KERNEL
422/* XXX: SIOCGPRLST_IN6 is exposed in KAME but in6_oprlist is not. */
423#define SIOCGPRLST_IN6		_IOWR('i', 75, struct in6_oprlist)
424#endif
425#ifdef _KERNEL
426#define OSIOCGIFINFO_IN6	_IOWR('i', 76, struct in6_ondireq)
427#endif
428#define SIOCGIFINFO_IN6		_IOWR('i', 108, struct in6_ndireq)
429#define SIOCSIFINFO_IN6		_IOWR('i', 109, struct in6_ndireq)
430#define SIOCSNDFLUSH_IN6	_IOWR('i', 77, struct in6_ifreq)
431#define SIOCGNBRINFO_IN6	_IOWR('i', 78, struct in6_nbrinfo)
432#define SIOCSPFXFLUSH_IN6	_IOWR('i', 79, struct in6_ifreq)
433#define SIOCSRTRFLUSH_IN6	_IOWR('i', 80, struct in6_ifreq)
434
435#define SIOCGIFALIFETIME_IN6	_IOWR('i', 81, struct in6_ifreq)
436#define SIOCSIFALIFETIME_IN6	_IOWR('i', 82, struct in6_ifreq)
437#define SIOCGIFSTAT_IN6		_IOWR('i', 83, struct in6_ifreq)
438#define SIOCGIFSTAT_ICMP6	_IOWR('i', 84, struct in6_ifreq)
439
440#define SIOCSDEFIFACE_IN6	_IOWR('i', 85, struct in6_ndifreq)
441#define SIOCGDEFIFACE_IN6	_IOWR('i', 86, struct in6_ndifreq)
442
443#define SIOCSIFINFO_FLAGS	_IOWR('i', 87, struct in6_ndireq) /* XXX */
444
445#define SIOCSSCOPE6		_IOW('i', 88, struct in6_ifreq)
446#define SIOCGSCOPE6		_IOWR('i', 89, struct in6_ifreq)
447#define SIOCGSCOPE6DEF		_IOWR('i', 90, struct in6_ifreq)
448
449#define SIOCSIFPREFIX_IN6	_IOW('i', 100, struct in6_prefixreq) /* set */
450#define SIOCGIFPREFIX_IN6	_IOWR('i', 101, struct in6_prefixreq) /* get */
451#define SIOCDIFPREFIX_IN6	_IOW('i', 102, struct in6_prefixreq) /* del */
452#define SIOCAIFPREFIX_IN6	_IOW('i', 103, struct in6_rrenumreq) /* add */
453#define SIOCCIFPREFIX_IN6	_IOW('i', 104, \
454				     struct in6_rrenumreq) /* change */
455#define SIOCSGIFPREFIX_IN6	_IOW('i', 105, \
456				     struct in6_rrenumreq) /* set global */
457
458#define SIOCGETSGCNT_IN6	_IOWR('u', 106, \
459				      struct sioc_sg_req6) /* get s,g pkt cnt */
460#define SIOCGETMIFCNT_IN6	_IOWR('u', 107, \
461				      struct sioc_mif_req6) /* get pkt cnt per if */
462
463#define SIOCAADDRCTL_POLICY	_IOW('u', 108, struct in6_addrpolicy)
464#define SIOCDADDRCTL_POLICY	_IOW('u', 109, struct in6_addrpolicy)
465
466#define IN6_IFF_ANYCAST		0x01	/* anycast address */
467#define IN6_IFF_TENTATIVE	0x02	/* tentative address */
468#define IN6_IFF_DUPLICATED	0x04	/* DAD detected duplicate */
469#define IN6_IFF_DETACHED	0x08	/* may be detached from the link */
470#define IN6_IFF_DEPRECATED	0x10	/* deprecated address */
471#define IN6_IFF_NODAD		0x20	/* don't perform DAD on this address
472					 * (used only at first SIOC* call)
473					 */
474#define IN6_IFF_AUTOCONF	0x40	/* autoconfigurable address. */
475#define IN6_IFF_TEMPORARY	0x80	/* temporary (anonymous) address. */
476#define IN6_IFF_NOPFX		0x8000	/* skip kernel prefix management.
477					 * XXX: this should be temporary.
478					 */
479
480/* do not input/output */
481#define IN6_IFF_NOTREADY (IN6_IFF_TENTATIVE|IN6_IFF_DUPLICATED)
482
483#ifdef _KERNEL
484#define IN6_ARE_SCOPE_CMP(a,b) ((a)-(b))
485#define IN6_ARE_SCOPE_EQUAL(a,b) ((a)==(b))
486#endif
487
488#ifdef _KERNEL
489VNET_DECLARE(struct in6_ifaddrhead, in6_ifaddrhead);
490VNET_DECLARE(struct icmp6stat, icmp6stat);
491VNET_DECLARE(unsigned long, in6_maxmtu);
492
493#define	V_in6_ifaddrhead		VNET(in6_ifaddrhead)
494#define	V_icmp6stat			VNET(icmp6stat)
495#define	V_in6_maxmtu			VNET(in6_maxmtu)
496
497extern struct rwlock in6_ifaddr_lock;
498#define	IN6_IFADDR_LOCK_ASSERT(	)	rw_assert(&in6_ifaddr_lock, RA_LOCKED)
499#define	IN6_IFADDR_RLOCK()		rw_rlock(&in6_ifaddr_lock)
500#define	IN6_IFADDR_RLOCK_ASSERT()	rw_assert(&in6_ifaddr_lock, RA_RLOCKED)
501#define	IN6_IFADDR_RUNLOCK()		rw_runlock(&in6_ifaddr_lock)
502#define	IN6_IFADDR_WLOCK()		rw_wlock(&in6_ifaddr_lock)
503#define	IN6_IFADDR_WLOCK_ASSERT()	rw_assert(&in6_ifaddr_lock, RA_WLOCKED)
504#define	IN6_IFADDR_WUNLOCK()		rw_wunlock(&in6_ifaddr_lock)
505
506#define in6_ifstat_inc(ifp, tag) \
507do {								\
508	if (ifp)						\
509		((struct in6_ifextra *)((ifp)->if_afdata[AF_INET6]))->in6_ifstat->tag++; \
510} while (/*CONSTCOND*/ 0)
511
512extern struct in6_addr zeroin6_addr;
513extern u_char inet6ctlerrmap[];
514#endif /* _KERNEL */
515
516/*
517 * IPv6 multicast MLD-layer source entry.
518 */
519struct ip6_msource {
520	RB_ENTRY(ip6_msource)	im6s_link;	/* RB tree links */
521	struct in6_addr		im6s_addr;
522	struct im6s_st {
523		uint16_t	ex;		/* # of exclusive members */
524		uint16_t	in;		/* # of inclusive members */
525	}			im6s_st[2];	/* state at t0, t1 */
526	uint8_t			im6s_stp;	/* pending query */
527};
528RB_HEAD(ip6_msource_tree, ip6_msource);
529
530/*
531 * IPv6 multicast PCB-layer source entry.
532 *
533 * NOTE: overlapping use of struct ip6_msource fields at start.
534 */
535struct in6_msource {
536	RB_ENTRY(ip6_msource)	im6s_link;	/* Common field */
537	struct in6_addr		im6s_addr;	/* Common field */
538	uint8_t			im6sl_st[2];	/* state before/at commit */
539};
540
541#ifdef _KERNEL
542/*
543 * IPv6 source tree comparison function.
544 *
545 * An ordered predicate is necessary; bcmp() is not documented to return
546 * an indication of order, memcmp() is, and is an ISO C99 requirement.
547 */
548static __inline int
549ip6_msource_cmp(const struct ip6_msource *a, const struct ip6_msource *b)
550{
551
552	return (memcmp(&a->im6s_addr, &b->im6s_addr, sizeof(struct in6_addr)));
553}
554RB_PROTOTYPE(ip6_msource_tree, ip6_msource, im6s_link, ip6_msource_cmp);
555#endif /* _KERNEL */
556
557/*
558 * IPv6 multicast PCB-layer group filter descriptor.
559 */
560struct in6_mfilter {
561	struct ip6_msource_tree	im6f_sources; /* source list for (S,G) */
562	u_long			im6f_nsrc;    /* # of source entries */
563	uint8_t			im6f_st[2];   /* state before/at commit */
564};
565
566/*
567 * Legacy KAME IPv6 multicast membership descriptor.
568 */
569struct in6_multi_mship {
570	struct	in6_multi *i6mm_maddr;
571	LIST_ENTRY(in6_multi_mship) i6mm_chain;
572};
573
574/*
575 * IPv6 group descriptor.
576 *
577 * For every entry on an ifnet's if_multiaddrs list which represents
578 * an IP multicast group, there is one of these structures.
579 *
580 * If any source filters are present, then a node will exist in the RB-tree
581 * to permit fast lookup by source whenever an operation takes place.
582 * This permits pre-order traversal when we issue reports.
583 * Source filter trees are kept separately from the socket layer to
584 * greatly simplify locking.
585 *
586 * When MLDv2 is active, in6m_timer is the response to group query timer.
587 * The state-change timer in6m_sctimer is separate; whenever state changes
588 * for the group the state change record is generated and transmitted,
589 * and kept if retransmissions are necessary.
590 *
591 * FUTURE: in6m_link is now only used when groups are being purged
592 * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but
593 * because it is at the very start of the struct, we can't do this
594 * w/o breaking the ABI for ifmcstat.
595 */
596struct in6_multi {
597	LIST_ENTRY(in6_multi) in6m_entry; /* list glue */
598	struct	in6_addr in6m_addr;	/* IPv6 multicast address */
599	struct	ifnet *in6m_ifp;	/* back pointer to ifnet */
600	struct	ifmultiaddr *in6m_ifma;	/* back pointer to ifmultiaddr */
601	u_int	in6m_refcount;		/* reference count */
602	u_int	in6m_state;		/* state of the membership */
603	u_int	in6m_timer;		/* MLD6 listener report timer */
604
605	/* New fields for MLDv2 follow. */
606	struct mld_ifinfo	*in6m_mli;	/* MLD info */
607	SLIST_ENTRY(in6_multi)	 in6m_nrele;	/* to-be-released by MLD */
608	struct ip6_msource_tree	 in6m_srcs;	/* tree of sources */
609	u_long			 in6m_nsrc;	/* # of tree entries */
610
611	struct ifqueue		 in6m_scq;	/* queue of pending
612						 * state-change packets */
613	struct timeval		 in6m_lastgsrtv;	/* last G-S-R query */
614	uint16_t		 in6m_sctimer;	/* state-change timer */
615	uint16_t		 in6m_scrv;	/* state-change rexmit count */
616
617	/*
618	 * SSM state counters which track state at T0 (the time the last
619	 * state-change report's RV timer went to zero) and T1
620	 * (time of pending report, i.e. now).
621	 * Used for computing MLDv2 state-change reports. Several refcounts
622	 * are maintained here to optimize for common use-cases.
623	 */
624	struct in6m_st {
625		uint16_t	iss_fmode;	/* MLD filter mode */
626		uint16_t	iss_asm;	/* # of ASM listeners */
627		uint16_t	iss_ex;		/* # of exclusive members */
628		uint16_t	iss_in;		/* # of inclusive members */
629		uint16_t	iss_rec;	/* # of recorded sources */
630	}			in6m_st[2];	/* state at t0, t1 */
631};
632
633/*
634 * Helper function to derive the filter mode on a source entry
635 * from its internal counters. Predicates are:
636 *  A source is only excluded if all listeners exclude it.
637 *  A source is only included if no listeners exclude it,
638 *  and at least one listener includes it.
639 * May be used by ifmcstat(8).
640 */
641static __inline uint8_t
642im6s_get_mode(const struct in6_multi *inm, const struct ip6_msource *ims,
643    uint8_t t)
644{
645
646	t = !!t;
647	if (inm->in6m_st[t].iss_ex > 0 &&
648	    inm->in6m_st[t].iss_ex == ims->im6s_st[t].ex)
649		return (MCAST_EXCLUDE);
650	else if (ims->im6s_st[t].in > 0 && ims->im6s_st[t].ex == 0)
651		return (MCAST_INCLUDE);
652	return (MCAST_UNDEFINED);
653}
654
655#ifdef _KERNEL
656
657/*
658 * Lock macros for IPv6 layer multicast address lists.  IPv6 lock goes
659 * before link layer multicast locks in the lock order.  In most cases,
660 * consumers of IN_*_MULTI() macros should acquire the locks before
661 * calling them; users of the in_{add,del}multi() functions should not.
662 */
663extern struct mtx in6_multi_mtx;
664#define	IN6_MULTI_LOCK()		mtx_lock(&in6_multi_mtx)
665#define	IN6_MULTI_UNLOCK()		mtx_unlock(&in6_multi_mtx)
666#define	IN6_MULTI_LOCK_ASSERT()		mtx_assert(&in6_multi_mtx, MA_OWNED)
667#define	IN6_MULTI_UNLOCK_ASSERT()	mtx_assert(&in6_multi_mtx, MA_NOTOWNED)
668
669/*
670 * Look up an in6_multi record for an IPv6 multicast address
671 * on the interface ifp.
672 * If no record found, return NULL.
673 *
674 * SMPng: The IN6_MULTI_LOCK and IF_ADDR_LOCK on ifp must be held.
675 */
676static __inline struct in6_multi *
677in6m_lookup_locked(struct ifnet *ifp, const struct in6_addr *mcaddr)
678{
679	struct ifmultiaddr *ifma;
680	struct in6_multi *inm;
681
682	IN6_MULTI_LOCK_ASSERT();
683	IF_ADDR_LOCK_ASSERT(ifp);
684
685	inm = NULL;
686	TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) {
687		if (ifma->ifma_addr->sa_family == AF_INET6) {
688			inm = (struct in6_multi *)ifma->ifma_protospec;
689			if (IN6_ARE_ADDR_EQUAL(&inm->in6m_addr, mcaddr))
690				break;
691			inm = NULL;
692		}
693	}
694	return (inm);
695}
696
697/*
698 * Wrapper for in6m_lookup_locked().
699 *
700 * SMPng: Assumes that neithr the IN6_MULTI_LOCK() or IF_ADDR_LOCK() are held.
701 */
702static __inline struct in6_multi *
703in6m_lookup(struct ifnet *ifp, const struct in6_addr *mcaddr)
704{
705	struct in6_multi *inm;
706
707	IN6_MULTI_LOCK();
708	IF_ADDR_LOCK(ifp);
709	inm = in6m_lookup_locked(ifp, mcaddr);
710	IF_ADDR_UNLOCK(ifp);
711	IN6_MULTI_UNLOCK();
712
713	return (inm);
714}
715
716/* Acquire an in6_multi record. */
717static __inline void
718in6m_acquire_locked(struct in6_multi *inm)
719{
720
721	IN6_MULTI_LOCK_ASSERT();
722	++inm->in6m_refcount;
723}
724
725struct ip6_moptions;
726struct sockopt;
727
728/* Multicast KPIs. */
729int	im6o_mc_filter(const struct ip6_moptions *, const struct ifnet *,
730	    const struct sockaddr *, const struct sockaddr *);
731int	in6_mc_join(struct ifnet *, const struct in6_addr *,
732	    struct in6_mfilter *, struct in6_multi **, int);
733int	in6_mc_join_locked(struct ifnet *, const struct in6_addr *,
734	    struct in6_mfilter *, struct in6_multi **, int);
735int	in6_mc_leave(struct in6_multi *, struct in6_mfilter *);
736int	in6_mc_leave_locked(struct in6_multi *, struct in6_mfilter *);
737void	in6m_clear_recorded(struct in6_multi *);
738void	in6m_commit(struct in6_multi *);
739void	in6m_print(const struct in6_multi *);
740int	in6m_record_source(struct in6_multi *, const struct in6_addr *);
741void	in6m_release_locked(struct in6_multi *);
742void	ip6_freemoptions(struct ip6_moptions *);
743int	ip6_getmoptions(struct inpcb *, struct sockopt *);
744int	ip6_setmoptions(struct inpcb *, struct sockopt *);
745
746/* Legacy KAME multicast KPIs. */
747struct in6_multi_mship *
748	in6_joingroup(struct ifnet *, struct in6_addr *, int *, int);
749int	in6_leavegroup(struct in6_multi_mship *);
750
751/* flags to in6_update_ifa */
752#define IN6_IFAUPDATE_DADDELAY	0x1 /* first time to configure an address */
753
754int	in6_mask2len __P((struct in6_addr *, u_char *));
755int	in6_control __P((struct socket *, u_long, caddr_t, struct ifnet *,
756	struct thread *));
757int	in6_update_ifa __P((struct ifnet *, struct in6_aliasreq *,
758	struct in6_ifaddr *, int));
759void	in6_purgeaddr __P((struct ifaddr *));
760int	in6if_do_dad __P((struct ifnet *));
761void	in6_purgeif __P((struct ifnet *));
762void	in6_savemkludge __P((struct in6_ifaddr *));
763void	*in6_domifattach __P((struct ifnet *));
764void	in6_domifdetach __P((struct ifnet *, void *));
765void	in6_setmaxmtu   __P((void));
766int	in6_if2idlen   __P((struct ifnet *));
767struct in6_ifaddr *in6ifa_ifpforlinklocal __P((struct ifnet *, int));
768struct in6_ifaddr *in6ifa_ifpwithaddr __P((struct ifnet *, struct in6_addr *));
769char	*ip6_sprintf __P((char *, const struct in6_addr *));
770int	in6_addr2zoneid __P((struct ifnet *, struct in6_addr *, u_int32_t *));
771int	in6_matchlen __P((struct in6_addr *, struct in6_addr *));
772int	in6_are_prefix_equal __P((struct in6_addr *, struct in6_addr *, int));
773void	in6_prefixlen2mask __P((struct in6_addr *, int));
774int	in6_prefix_ioctl __P((struct socket *, u_long, caddr_t,
775	struct ifnet *));
776int	in6_prefix_add_ifid __P((int, struct in6_ifaddr *));
777void	in6_prefix_remove_ifid __P((int, struct in6_ifaddr *));
778void	in6_purgeprefix __P((struct ifnet *));
779void	in6_ifremloop(struct ifaddr *);
780void	in6_ifaddloop(struct ifaddr *);
781
782int	in6_is_addr_deprecated __P((struct sockaddr_in6 *));
783struct inpcb;
784int in6_src_ioctl __P((u_long, caddr_t));
785#endif /* _KERNEL */
786
787#endif /* _NETINET6_IN6_VAR_H_ */
788