xref: /openbsd/sys/netinet6/in6_var.h (revision 891d7ab6)
1 /*	$OpenBSD: in6_var.h,v 1.32 2010/07/08 19:42:46 jsg Exp $	*/
2 /*	$KAME: in6_var.h,v 1.55 2001/02/16 12:49:45 itojun Exp $	*/
3 
4 /*
5  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the project nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1985, 1986, 1993
35  *	The Regents of the University of California.  All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. Neither the name of the University nor the names of its contributors
46  *    may be used to endorse or promote products derived from this software
47  *    without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59  * SUCH DAMAGE.
60  *
61  *	@(#)in_var.h	8.1 (Berkeley) 6/10/93
62  */
63 
64 #ifndef _NETINET6_IN6_VAR_H_
65 #define _NETINET6_IN6_VAR_H_
66 
67 /*
68  * Interface address, Internet version.  One of these structures
69  * is allocated for each interface with an Internet address.
70  * The ifaddr structure contains the protocol-independent part
71  * of the structure and is assumed to be first.
72  */
73 
74 /*
75  * pltime/vltime are just for future reference (required to implements 2
76  * hour rule for hosts).  they should never be modified by nd6_timeout or
77  * anywhere else.
78  *	userland -> kernel: accept pltime/vltime
79  *	kernel -> userland: throw up everything
80  *	in kernel: modify preferred/expire only
81  */
82 struct in6_addrlifetime {
83 	time_t ia6t_expire;	/* valid lifetime expiration time */
84 	time_t ia6t_preferred;	/* preferred lifetime expiration time */
85 	u_int32_t ia6t_vltime;	/* valid lifetime */
86 	u_int32_t ia6t_pltime;	/* prefix lifetime */
87 };
88 
89 struct nd_ifinfo;
90 struct in6_ifextra {
91 	struct in6_ifstat *in6_ifstat;
92 	struct icmp6_ifstat *icmp6_ifstat;
93 	struct nd_ifinfo *nd_ifinfo;
94 	int nprefixes;
95 	int ndefrouters;
96 };
97 
98 struct	in6_ifaddr {
99 	struct	ifaddr ia_ifa;		/* protocol-independent info */
100 #define	ia_ifp		ia_ifa.ifa_ifp
101 #define ia_flags	ia_ifa.ifa_flags
102 	struct	sockaddr_in6 ia_addr;	/* interface address */
103 	struct	sockaddr_in6 ia_net;	/* network number of interface */
104 	struct	sockaddr_in6 ia_dstaddr; /* space for destination addr */
105 	struct	sockaddr_in6 ia_prefixmask; /* prefix mask */
106 	u_int32_t ia_plen;		/* prefix length */
107 	struct	in6_ifaddr *ia_next;	/* next in6 list of IP6 addresses */
108 	LIST_HEAD(in6_multihead, in6_multi) ia6_multiaddrs;
109 					/* list of multicast addresses */
110 	int	ia6_flags;
111 
112 	struct in6_addrlifetime ia6_lifetime;
113 	time_t	ia6_createtime; /* the creation time of this address, which is
114 				 * currently used for temporary addresses only.
115 				 */
116 	time_t	ia6_updatetime;
117 
118 	/* back pointer to the ND prefix (for autoconfigured addresses only) */
119 	struct nd_prefix *ia6_ndpr;
120 
121 	/* multicast addresses joined from the kernel */
122 	LIST_HEAD(, in6_multi_mship) ia6_memberships;
123 };
124 
125 /*
126  * IPv6 interface statistics, as defined in RFC2465 Ipv6IfStatsEntry (p12).
127  */
128 struct in6_ifstat {
129 	u_int64_t ifs6_in_receive;	/* # of total input datagram */
130 	u_int64_t ifs6_in_hdrerr;	/* # of datagrams with invalid hdr */
131 	u_int64_t ifs6_in_toobig;	/* # of datagrams exceeded MTU */
132 	u_int64_t ifs6_in_noroute;	/* # of datagrams with no route */
133 	u_int64_t ifs6_in_addrerr;	/* # of datagrams with invalid dst */
134 	u_int64_t ifs6_in_protounknown;	/* # of datagrams with unknown proto */
135 					/* NOTE: increment on final dst if */
136 	u_int64_t ifs6_in_truncated;	/* # of truncated datagrams */
137 	u_int64_t ifs6_in_discard;	/* # of discarded datagrams */
138 					/* NOTE: fragment timeout is not here */
139 	u_int64_t ifs6_in_deliver;	/* # of datagrams delivered to ULP */
140 					/* NOTE: increment on final dst if */
141 	u_int64_t ifs6_out_forward;	/* # of datagrams forwarded */
142 					/* NOTE: increment on outgoing if */
143 	u_int64_t ifs6_out_request;	/* # of outgoing datagrams from ULP */
144 					/* NOTE: does not include forwrads */
145 	u_int64_t ifs6_out_discard;	/* # of discarded datagrams */
146 	u_int64_t ifs6_out_fragok;	/* # of datagrams fragmented */
147 	u_int64_t ifs6_out_fragfail;	/* # of datagrams failed on fragment */
148 	u_int64_t ifs6_out_fragcreat;	/* # of fragment datagrams */
149 					/* NOTE: this is # after fragment */
150 	u_int64_t ifs6_reass_reqd;	/* # of incoming fragmented packets */
151 					/* NOTE: increment on final dst if */
152 	u_int64_t ifs6_reass_ok;	/* # of reassembled packets */
153 					/* NOTE: this is # after reass */
154 					/* NOTE: increment on final dst if */
155 	u_int64_t ifs6_reass_fail;	/* # of reass failures */
156 					/* NOTE: may not be packet count */
157 					/* NOTE: increment on final dst if */
158 	u_int64_t ifs6_in_mcast;	/* # of inbound multicast datagrams */
159 	u_int64_t ifs6_out_mcast;	/* # of outbound multicast datagrams */
160 };
161 
162 /*
163  * ICMPv6 interface statistics, as defined in RFC2466 Ipv6IfIcmpEntry.
164  * XXX: I'm not sure if this file is the right place for this structure...
165  */
166 struct icmp6_ifstat {
167 	/*
168 	 * Input statistics
169 	 */
170 	/* ipv6IfIcmpInMsgs, total # of input messages */
171 	u_int64_t ifs6_in_msg;
172 	/* ipv6IfIcmpInErrors, # of input error messages */
173 	u_int64_t ifs6_in_error;
174 	/* ipv6IfIcmpInDestUnreachs, # of input dest unreach errors */
175 	u_int64_t ifs6_in_dstunreach;
176 	/* ipv6IfIcmpInAdminProhibs, # of input administratively prohibited errs */
177 	u_int64_t ifs6_in_adminprohib;
178 	/* ipv6IfIcmpInTimeExcds, # of input time exceeded errors */
179 	u_int64_t ifs6_in_timeexceed;
180 	/* ipv6IfIcmpInParmProblems, # of input parameter problem errors */
181 	u_int64_t ifs6_in_paramprob;
182 	/* ipv6IfIcmpInPktTooBigs, # of input packet too big errors */
183 	u_int64_t ifs6_in_pkttoobig;
184 	/* ipv6IfIcmpInEchos, # of input echo requests */
185 	u_int64_t ifs6_in_echo;
186 	/* ipv6IfIcmpInEchoReplies, # of input echo replies */
187 	u_int64_t ifs6_in_echoreply;
188 	/* ipv6IfIcmpInRouterSolicits, # of input router solicitations */
189 	u_int64_t ifs6_in_routersolicit;
190 	/* ipv6IfIcmpInRouterAdvertisements, # of input router advertisements */
191 	u_int64_t ifs6_in_routeradvert;
192 	/* ipv6IfIcmpInNeighborSolicits, # of input neighbor solicitations */
193 	u_int64_t ifs6_in_neighborsolicit;
194 	/* ipv6IfIcmpInNeighborAdvertisements, # of input neighbor advertisements */
195 	u_int64_t ifs6_in_neighboradvert;
196 	/* ipv6IfIcmpInRedirects, # of input redirects */
197 	u_int64_t ifs6_in_redirect;
198 	/* ipv6IfIcmpInGroupMembQueries, # of input MLD queries */
199 	u_int64_t ifs6_in_mldquery;
200 	/* ipv6IfIcmpInGroupMembResponses, # of input MLD reports */
201 	u_int64_t ifs6_in_mldreport;
202 	/* ipv6IfIcmpInGroupMembReductions, # of input MLD done */
203 	u_int64_t ifs6_in_mlddone;
204 
205 	/*
206 	 * Output statistics. We should solve unresolved routing problem...
207 	 */
208 	/* ipv6IfIcmpOutMsgs, total # of output messages */
209 	u_int64_t ifs6_out_msg;
210 	/* ipv6IfIcmpOutErrors, # of output error messages */
211 	u_int64_t ifs6_out_error;
212 	/* ipv6IfIcmpOutDestUnreachs, # of output dest unreach errors */
213 	u_int64_t ifs6_out_dstunreach;
214 	/* ipv6IfIcmpOutAdminProhibs, # of output administratively prohibited errs */
215 	u_int64_t ifs6_out_adminprohib;
216 	/* ipv6IfIcmpOutTimeExcds, # of output time exceeded errors */
217 	u_int64_t ifs6_out_timeexceed;
218 	/* ipv6IfIcmpOutParmProblems, # of output parameter problem errors */
219 	u_int64_t ifs6_out_paramprob;
220 	/* ipv6IfIcmpOutPktTooBigs, # of output packet too big errors */
221 	u_int64_t ifs6_out_pkttoobig;
222 	/* ipv6IfIcmpOutEchos, # of output echo requests */
223 	u_int64_t ifs6_out_echo;
224 	/* ipv6IfIcmpOutEchoReplies, # of output echo replies */
225 	u_int64_t ifs6_out_echoreply;
226 	/* ipv6IfIcmpOutRouterSolicits, # of output router solicitations */
227 	u_int64_t ifs6_out_routersolicit;
228 	/* ipv6IfIcmpOutRouterAdvertisements, # of output router advertisements */
229 	u_int64_t ifs6_out_routeradvert;
230 	/* ipv6IfIcmpOutNeighborSolicits, # of output neighbor solicitations */
231 	u_int64_t ifs6_out_neighborsolicit;
232 	/* ipv6IfIcmpOutNeighborAdvertisements, # of output neighbor advertisements */
233 	u_int64_t ifs6_out_neighboradvert;
234 	/* ipv6IfIcmpOutRedirects, # of output redirects */
235 	u_int64_t ifs6_out_redirect;
236 	/* ipv6IfIcmpOutGroupMembQueries, # of output MLD queries */
237 	u_int64_t ifs6_out_mldquery;
238 	/* ipv6IfIcmpOutGroupMembResponses, # of output MLD reports */
239 	u_int64_t ifs6_out_mldreport;
240 	/* ipv6IfIcmpOutGroupMembReductions, # of output MLD done */
241 	u_int64_t ifs6_out_mlddone;
242 };
243 
244 struct	in6_ifreq {
245 	char	ifr_name[IFNAMSIZ];
246 	union {
247 		struct	sockaddr_in6 ifru_addr;
248 		struct	sockaddr_in6 ifru_dstaddr;
249 		short	ifru_flags;
250 		int	ifru_flags6;
251 		int	ifru_metric;
252 		caddr_t	ifru_data;
253 		struct in6_addrlifetime ifru_lifetime;
254 		struct in6_ifstat ifru_stat;
255 		struct icmp6_ifstat ifru_icmp6stat;
256 	} ifr_ifru;
257 };
258 
259 struct	in6_aliasreq {
260 	char	ifra_name[IFNAMSIZ];
261 	struct	sockaddr_in6 ifra_addr;
262 	struct	sockaddr_in6 ifra_dstaddr;
263 	struct	sockaddr_in6 ifra_prefixmask;
264 	int	ifra_flags;
265 	struct in6_addrlifetime ifra_lifetime;
266 };
267 
268 /* prefix type macro */
269 #define IN6_PREFIX_ND	1
270 #define IN6_PREFIX_RR	2
271 
272 /*
273  * prefix related flags passed between kernel(NDP related part) and
274  * user land command(ifconfig) and daemon(rtadvd).
275  */
276 struct prf_ra {
277 	u_int onlink : 1;
278 	u_int autonomous : 1;
279 	u_int router : 1;
280 	u_int reserved : 5;
281 };
282 
283 struct in6_prflags {
284 	struct prf_ra prf_ra;
285 	u_char prf_reserved1;
286 	u_short prf_reserved2;
287 	/* want to put this on 4byte offset */
288 	struct prf_rr {
289 		u_int decrvalid : 1;
290 		u_int decrprefd : 1;
291 		u_int reserved : 6;
292 	} prf_rr;
293 	u_char prf_reserved3;
294 	u_short prf_reserved4;
295 };
296 
297 struct  in6_prefixreq {
298 	char	ipr_name[IFNAMSIZ];
299 	u_char	ipr_origin;
300 	u_char	ipr_plen;
301 	u_int32_t ipr_vltime;
302 	u_int32_t ipr_pltime;
303 	struct in6_prflags ipr_flags;
304 	struct	sockaddr_in6 ipr_prefix;
305 };
306 
307 #define PR_ORIG_RA	0
308 #define PR_ORIG_RR	1
309 #define PR_ORIG_STATIC	2
310 #define PR_ORIG_KERNEL	3
311 
312 #define ipr_raf_onlink		ipr_flags.prf_ra.onlink
313 #define ipr_raf_auto		ipr_flags.prf_ra.autonomous
314 
315 #define ipr_statef_onlink	ipr_flags.prf_state.onlink
316 
317 #define ipr_rrf_decrvalid	ipr_flags.prf_rr.decrvalid
318 #define ipr_rrf_decrprefd	ipr_flags.prf_rr.decrprefd
319 
320 struct	in6_rrenumreq {
321 	char	irr_name[IFNAMSIZ];
322 	u_char	irr_origin;
323 	u_char	irr_m_len;	/* match len for matchprefix */
324 	u_char	irr_m_minlen;	/* minlen for matching prefix */
325 	u_char	irr_m_maxlen;	/* maxlen for matching prefix */
326 	u_char	irr_u_uselen;	/* uselen for adding prefix */
327 	u_char	irr_u_keeplen;	/* keeplen from matching prefix */
328 	struct irr_raflagmask {
329 		u_int onlink : 1;
330 		u_int autonomous : 1;
331 		u_int reserved : 6;
332 	} irr_raflagmask;
333 	u_int32_t irr_vltime;
334 	u_int32_t irr_pltime;
335 	struct in6_prflags irr_flags;
336 	struct	sockaddr_in6 irr_matchprefix;
337 	struct	sockaddr_in6 irr_useprefix;
338 };
339 
340 #define irr_raf_mask_onlink	irr_raflagmask.onlink
341 #define irr_raf_mask_auto	irr_raflagmask.autonomous
342 #define irr_raf_mask_reserved	irr_raflagmask.reserved
343 
344 #define irr_raf_onlink		irr_flags.prf_ra.onlink
345 #define irr_raf_auto		irr_flags.prf_ra.autonomous
346 
347 #define irr_statef_onlink	irr_flags.prf_state.onlink
348 
349 #define irr_rrf			irr_flags.prf_rr
350 #define irr_rrf_decrvalid	irr_flags.prf_rr.decrvalid
351 #define irr_rrf_decrprefd	irr_flags.prf_rr.decrprefd
352 
353 /*
354  * Given a pointer to an in6_ifaddr (ifaddr),
355  * return a pointer to the addr as a sockaddr_in6
356  */
357 #define IA6_IN6(ia)	(&((ia)->ia_addr.sin6_addr))
358 #define IA6_DSTIN6(ia)	(&((ia)->ia_dstaddr.sin6_addr))
359 #define IA6_MASKIN6(ia)	(&((ia)->ia_prefixmask.sin6_addr))
360 #define IA6_SIN6(ia)	(&((ia)->ia_addr))
361 #define IA6_DSTSIN6(ia)	(&((ia)->ia_dstaddr))
362 #define IFA_IN6(x)	(&((struct sockaddr_in6 *)((x)->ifa_addr))->sin6_addr)
363 #define IFA_DSTIN6(x)	(&((struct sockaddr_in6 *)((x)->ifa_dstaddr))->sin6_addr)
364 
365 #ifdef _KERNEL
366 #define IN6_ARE_MASKED_ADDR_EQUAL(d, a, m)	(	\
367 	(((d)->s6_addr32[0] ^ (a)->s6_addr32[0]) & (m)->s6_addr32[0]) == 0 && \
368 	(((d)->s6_addr32[1] ^ (a)->s6_addr32[1]) & (m)->s6_addr32[1]) == 0 && \
369 	(((d)->s6_addr32[2] ^ (a)->s6_addr32[2]) & (m)->s6_addr32[2]) == 0 && \
370 	(((d)->s6_addr32[3] ^ (a)->s6_addr32[3]) & (m)->s6_addr32[3]) == 0 )
371 #endif
372 
373 #define SIOCSIFADDR_IN6		 _IOW('i', 12, struct in6_ifreq)
374 #define SIOCGIFADDR_IN6		_IOWR('i', 33, struct in6_ifreq)
375 
376 #ifdef _KERNEL
377 /*
378  * SIOCSxxx ioctls should be unused (see comments in in6.c), but
379  * we do not shift numbers for binary compatibility.
380  */
381 #define SIOCSIFDSTADDR_IN6	 _IOW('i', 14, struct in6_ifreq)
382 #define SIOCSIFNETMASK_IN6	 _IOW('i', 22, struct in6_ifreq)
383 #endif
384 
385 #define SIOCGIFDSTADDR_IN6	_IOWR('i', 34, struct in6_ifreq)
386 #define SIOCGIFNETMASK_IN6	_IOWR('i', 37, struct in6_ifreq)
387 
388 #define SIOCDIFADDR_IN6		 _IOW('i', 25, struct in6_ifreq)
389 #define SIOCAIFADDR_IN6		 _IOW('i', 26, struct in6_aliasreq)
390 
391 #define SIOCSIFPHYADDR_IN6       _IOW('i', 70, struct in6_aliasreq)
392 #define	SIOCGIFPSRCADDR_IN6	_IOWR('i', 71, struct in6_ifreq)
393 #define	SIOCGIFPDSTADDR_IN6	_IOWR('i', 72, struct in6_ifreq)
394 
395 #define SIOCGIFAFLAG_IN6	_IOWR('i', 73, struct in6_ifreq)
396 
397 #define SIOCGDRLST_IN6		_IOWR('i', 74, struct in6_drlist)
398 #define SIOCGPRLST_IN6		_IOWR('i', 75, struct in6_prlist)
399 #ifdef _KERNEL
400 #define OSIOCGIFINFO_IN6	_IOWR('i', 76, struct in6_ondireq)
401 #endif
402 #define SIOCGIFINFO_IN6		_IOWR('i', 108, struct in6_ndireq)
403 #define SIOCSNDFLUSH_IN6	_IOWR('i', 77, struct in6_ifreq)
404 #define SIOCGNBRINFO_IN6	_IOWR('i', 78, struct in6_nbrinfo)
405 #define SIOCSPFXFLUSH_IN6	_IOWR('i', 79, struct in6_ifreq)
406 #define SIOCSRTRFLUSH_IN6	_IOWR('i', 80, struct in6_ifreq)
407 
408 #define SIOCGIFALIFETIME_IN6	_IOWR('i', 81, struct in6_ifreq)
409 #define SIOCSIFALIFETIME_IN6	_IOWR('i', 82, struct in6_ifreq)
410 #define SIOCGIFSTAT_IN6		_IOWR('i', 83, struct in6_ifreq)
411 #define SIOCGIFSTAT_ICMP6	_IOWR('i', 84, struct in6_ifreq)
412 
413 #define SIOCSDEFIFACE_IN6	_IOWR('i', 85, struct in6_ndifreq)
414 #define SIOCGDEFIFACE_IN6	_IOWR('i', 86, struct in6_ndifreq)
415 
416 #define SIOCSIFINFO_FLAGS	_IOWR('i', 87, struct in6_ndireq) /* XXX */
417 
418 #define SIOCSIFPREFIX_IN6	_IOW('i', 100, struct in6_prefixreq) /* set */
419 #define SIOCGIFPREFIX_IN6	_IOWR('i', 101, struct in6_prefixreq) /* get */
420 #define SIOCDIFPREFIX_IN6	_IOW('i', 102, struct in6_prefixreq) /* del */
421 #define SIOCAIFPREFIX_IN6	_IOW('i', 103, struct in6_rrenumreq) /* add */
422 #define SIOCCIFPREFIX_IN6	_IOW('i', 104, \
423 				     struct in6_rrenumreq) /* change */
424 #define SIOCSGIFPREFIX_IN6	_IOW('i', 105, \
425 				     struct in6_rrenumreq) /* set global */
426 
427 #define SIOCGETSGCNT_IN6	_IOWR('u', 106, \
428 				      struct sioc_sg_req6) /* get s,g pkt cnt */
429 #define SIOCGETMIFCNT_IN6	_IOWR('u', 107, \
430 				      struct sioc_mif_req6) /* get pkt cnt per if */
431 
432 #define IN6_IFF_ANYCAST		0x01	/* anycast address */
433 #define IN6_IFF_TENTATIVE	0x02	/* tentative address */
434 #define IN6_IFF_DUPLICATED	0x04	/* DAD detected duplicate */
435 #define IN6_IFF_DETACHED	0x08	/* may be detached from the link */
436 #define IN6_IFF_DEPRECATED	0x10	/* deprecated address */
437 #define IN6_IFF_NODAD		0x20	/* don't perform DAD on this address
438 					 * (used only at first SIOC* call)
439 					 */
440 #define IN6_IFF_AUTOCONF	0x40	/* autoconfigurable address. */
441 #define IN6_IFF_PRIVACY		0x80	/* RFC 4941 temporary address */
442 
443 /* do not input/output */
444 #define IN6_IFF_NOTREADY (IN6_IFF_TENTATIVE|IN6_IFF_DUPLICATED)
445 
446 #ifdef _KERNEL
447 #define IN6_ARE_SCOPE_CMP(a,b) ((a)-(b))
448 #define IN6_ARE_SCOPE_EQUAL(a,b) ((a)==(b))
449 #endif
450 
451 #ifdef _KERNEL
452 extern struct in6_ifaddr *in6_ifaddr;
453 
454 extern struct icmp6stat icmp6stat;
455 #define in6_ifstat_inc(ifp, tag) \
456 do {								\
457 	if (ifp)						\
458 		((struct in6_ifextra *)((ifp)->if_afdata[AF_INET6]))->in6_ifstat->tag++; \
459 } while (0)
460 
461 extern struct ifqueue ip6intrq;		/* IP6 packet input queue */
462 extern struct in6_addr zeroin6_addr;
463 extern u_char inet6ctlerrmap[];
464 extern unsigned long in6_maxmtu;
465 
466 /*
467  * Macro for finding the internet address structure (in6_ifaddr) corresponding
468  * to a given interface (ifnet structure).
469  */
470 #define IFP_TO_IA6(ifp, ia)				\
471 /* struct ifnet *ifp; */				\
472 /* struct in6_ifaddr *ia; */				\
473 do {									\
474 	struct ifaddr *ifa;						\
475 	TAILQ_FOREACH(ifa, &(ifp)->if_addrlist, ifa_list) {		\
476 		if (!ifa->ifa_addr)					\
477 			continue;					\
478 		if (ifa->ifa_addr->sa_family == AF_INET6)		\
479 			break;						\
480 	}								\
481 	(ia) = (struct in6_ifaddr *)ifa;				\
482 } while (0)
483 #endif /* _KERNEL */
484 
485 /*
486  * Multi-cast membership entry.  One for each group/ifp that a PCB
487  * belongs to.
488  */
489 struct in6_multi_mship {
490 	struct	in6_multi *i6mm_maddr;	/* Multicast address pointer */
491 	LIST_ENTRY(in6_multi_mship) i6mm_chain;  /* multicast options chain */
492 };
493 
494 struct	in6_multi {
495 	LIST_ENTRY(in6_multi) in6m_entry; /* list glue */
496 	struct	in6_addr in6m_addr;	/* IP6 multicast address */
497 	struct	ifnet *in6m_ifp;	/* back pointer to ifnet */
498 	struct	in6_ifaddr *in6m_ia;	/* back pointer to in6_ifaddr */
499 	u_int	in6m_refcount;		/* # membership claims by sockets */
500 	u_int	in6m_state;		/* state of the membership */
501 	u_int	in6m_timer;		/* MLD6 listener report timer */
502 };
503 
504 #ifdef _KERNEL
505 /*
506  * Structure used by macros below to remember position when stepping through
507  * all of the in6_multi records.
508  */
509 struct	in6_multistep {
510 	struct	in6_ifaddr *i_ia;
511 	struct	in6_multi *i_in6m;
512 };
513 
514 /*
515  * Macros for looking up the in6_multi record for a given IP6 multicast
516  * address on a given interface. If no matching record is found, "in6m"
517  * returns NLL.
518  */
519 
520 #define IN6_LOOKUP_MULTI(addr, ifp, in6m)			\
521 /* struct in6_addr addr; */					\
522 /* struct ifnet *ifp; */					\
523 /* struct in6_multi *in6m; */					\
524 do {								\
525 	struct in6_ifaddr *ia;					\
526 								\
527 	IFP_TO_IA6((ifp), ia);					\
528 	if (ia == NULL)						\
529 	  	(in6m) = NULL;					\
530 	else							\
531 		for ((in6m) = LIST_FIRST(&ia->ia6_multiaddrs);	\
532 		     (in6m) != LIST_END(&ia->ia6_multiaddrs) &&	\
533 		     !IN6_ARE_ADDR_EQUAL(&(in6m)->in6m_addr, &(addr));	\
534 		     (in6m) = LIST_NEXT((in6m), in6m_entry))	\
535 			continue;				\
536 } while (0)
537 
538 /*
539  * Macro to step through all of the in6_multi records, one at a time.
540  * The current position is remembered in "step", which the caller must
541  * provide.  IN6_FIRST_MULTI(), below, must be called to initialize "step"
542  * and get the first record.  Both macros return a NULL "in6m" when there
543  * are no remaining records.
544  */
545 #define IN6_NEXT_MULTI(step, in6m)					\
546 /* struct in6_multistep step; */					\
547 /* struct in6_multi *in6m; */						\
548 do {									\
549 	if (((in6m) = (step).i_in6m) != NULL)				\
550 		(step).i_in6m = LIST_NEXT((in6m), in6m_entry);		\
551 	else								\
552 		while ((step).i_ia != NULL) {				\
553 			(in6m) = LIST_FIRST(&(step).i_ia->ia6_multiaddrs); \
554 			(step).i_ia = (step).i_ia->ia_next;		\
555 			if ((in6m) != NULL) {				\
556 				(step).i_in6m = LIST_NEXT((in6m), in6m_entry); \
557 				break;					\
558 			}						\
559 		}							\
560 } while (0)
561 
562 #define IN6_FIRST_MULTI(step, in6m)		\
563 /* struct in6_multistep step; */		\
564 /* struct in6_multi *in6m */			\
565 do {						\
566 	(step).i_ia = in6_ifaddr;		\
567 	(step).i_in6m = NULL;			\
568 	IN6_NEXT_MULTI((step), (in6m));		\
569 } while (0)
570 
571 struct	in6_multi *in6_addmulti(struct in6_addr *, struct ifnet *, int *);
572 void	in6_delmulti(struct in6_multi *);
573 struct in6_multi_mship *in6_joingroup(struct ifnet *, struct in6_addr *, int *);
574 int	in6_leavegroup(struct in6_multi_mship *);
575 int	in6_mask2len(struct in6_addr *, u_char *);
576 int	in6_control(struct socket *, u_long, caddr_t, struct ifnet *,
577 	struct proc *);
578 int	in6_update_ifa(struct ifnet *, struct in6_aliasreq *,
579 	struct in6_ifaddr *);
580 void	in6_purgeaddr(struct ifaddr *);
581 int	in6if_do_dad(struct ifnet *);
582 void	in6_savemkludge(struct in6_ifaddr *);
583 void	in6_setmaxmtu(void);
584 void	*in6_domifattach(struct ifnet *);
585 void	in6_domifdetach(struct ifnet *, void *);
586 void	in6_restoremkludge(struct in6_ifaddr *, struct ifnet *);
587 void	in6_createmkludge(struct ifnet *);
588 void	in6_purgemkludge(struct ifnet *);
589 struct in6_ifaddr *in6ifa_ifpforlinklocal(struct ifnet *, int);
590 struct in6_ifaddr *in6ifa_ifpwithaddr(struct ifnet *, struct in6_addr *);
591 struct in6_ifaddr *in6ifa_ifplocaladdr(const struct ifnet *,
592 	    const struct in6_addr *);
593 char	*ip6_sprintf(struct in6_addr *);
594 int	in6_addr2scopeid(struct ifnet *, struct in6_addr *);
595 int	in6_matchlen(struct in6_addr *, struct in6_addr *);
596 int	in6_are_prefix_equal(struct in6_addr *, struct in6_addr *, int);
597 void	in6_prefixlen2mask(struct in6_addr *, int);
598 void	in6_purgeprefix(struct ifnet *);
599 void	in6_ifaddloop(struct ifaddr *);
600 void	in6_ifremloop(struct ifaddr *);
601 
602 struct inpcb;
603 int in6_embedscope(struct in6_addr *, const struct sockaddr_in6 *,
604 	struct inpcb *, struct ifnet **);
605 int in6_recoverscope(struct sockaddr_in6 *, const struct in6_addr *,
606 	struct ifnet *);
607 void in6_clearscope(struct in6_addr *);
608 #endif /* _KERNEL */
609 
610 #endif /* _NETINET6_IN6_VAR_H_ */
611