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