xref: /openbsd-src/sys/netinet6/in6_var.h (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1 /*	$OpenBSD: in6_var.h,v 1.64 2016/07/05 10:17:14 mpi 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 #ifdef _KERNEL
90 struct nd_ifinfo;
91 struct in6_ifextra {
92 	struct nd_ifinfo *nd_ifinfo;
93 	void *rs_lhcookie;
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 
103 	struct	sockaddr_in6 ia_addr;	/* interface address */
104 	struct	sockaddr_in6 ia_dstaddr; /* space for destination addr */
105 	struct	sockaddr_in6 ia_prefixmask; /* prefix mask */
106 	TAILQ_ENTRY(in6_ifaddr) ia_list;	/* list of IP6 addresses */
107 	int	ia6_flags;
108 
109 	struct in6_addrlifetime ia6_lifetime;
110 	time_t	ia6_createtime; /* the creation time of this address, which is
111 				 * currently used for temporary addresses only.
112 				 */
113 	time_t	ia6_updatetime;
114 
115 	/* back pointer to the prefix (for autoconf) */
116 	struct nd_prefix *ia6_ndpr;
117 
118 	/* multicast addresses joined from the kernel */
119 	LIST_HEAD(, in6_multi_mship) ia6_memberships;
120 };
121 #endif /* _KERNEL */
122 
123 /*
124  * IPv6 interface statistics, as defined in RFC2465 Ipv6IfStatsEntry (p12).
125  */
126 struct in6_ifstat {
127 	u_int64_t ifs6_in_receive;	/* # of total input datagram */
128 	u_int64_t ifs6_in_hdrerr;	/* # of datagrams with invalid hdr */
129 	u_int64_t ifs6_in_toobig;	/* # of datagrams exceeded MTU */
130 	u_int64_t ifs6_in_noroute;	/* # of datagrams with no route */
131 	u_int64_t ifs6_in_addrerr;	/* # of datagrams with invalid dst */
132 	u_int64_t ifs6_in_protounknown;	/* # of datagrams with unknown proto */
133 					/* NOTE: increment on final dst if */
134 	u_int64_t ifs6_in_truncated;	/* # of truncated datagrams */
135 	u_int64_t ifs6_in_discard;	/* # of discarded datagrams */
136 					/* NOTE: fragment timeout is not here */
137 	u_int64_t ifs6_in_deliver;	/* # of datagrams delivered to ULP */
138 					/* NOTE: increment on final dst if */
139 	u_int64_t ifs6_out_forward;	/* # of datagrams forwarded */
140 					/* NOTE: increment on outgoing if */
141 	u_int64_t ifs6_out_request;	/* # of outgoing datagrams from ULP */
142 					/* NOTE: does not include forwrads */
143 	u_int64_t ifs6_out_discard;	/* # of discarded datagrams */
144 	u_int64_t ifs6_out_fragok;	/* # of datagrams fragmented */
145 	u_int64_t ifs6_out_fragfail;	/* # of datagrams failed on fragment */
146 	u_int64_t ifs6_out_fragcreat;	/* # of fragment datagrams */
147 					/* NOTE: this is # after fragment */
148 	u_int64_t ifs6_reass_reqd;	/* # of incoming fragmented packets */
149 					/* NOTE: increment on final dst if */
150 	u_int64_t ifs6_reass_ok;	/* # of reassembled packets */
151 					/* NOTE: this is # after reass */
152 					/* NOTE: increment on final dst if */
153 	u_int64_t ifs6_reass_fail;	/* # of reass failures */
154 					/* NOTE: may not be packet count */
155 					/* NOTE: increment on final dst if */
156 	u_int64_t ifs6_in_mcast;	/* # of inbound multicast datagrams */
157 	u_int64_t ifs6_out_mcast;	/* # of outbound multicast datagrams */
158 };
159 
160 /*
161  * ICMPv6 interface statistics, as defined in RFC2466 Ipv6IfIcmpEntry.
162  * XXX: I'm not sure if this file is the right place for this structure...
163  */
164 struct icmp6_ifstat {
165 	/*
166 	 * Input statistics
167 	 */
168 	/* ipv6IfIcmpInMsgs, total # of input messages */
169 	u_int64_t ifs6_in_msg;
170 	/* ipv6IfIcmpInErrors, # of input error messages */
171 	u_int64_t ifs6_in_error;
172 	/* ipv6IfIcmpInDestUnreachs, # of input dest unreach errors */
173 	u_int64_t ifs6_in_dstunreach;
174 	/* ipv6IfIcmpInAdminProhibs, # of input administratively prohibited errs */
175 	u_int64_t ifs6_in_adminprohib;
176 	/* ipv6IfIcmpInTimeExcds, # of input time exceeded errors */
177 	u_int64_t ifs6_in_timeexceed;
178 	/* ipv6IfIcmpInParmProblems, # of input parameter problem errors */
179 	u_int64_t ifs6_in_paramprob;
180 	/* ipv6IfIcmpInPktTooBigs, # of input packet too big errors */
181 	u_int64_t ifs6_in_pkttoobig;
182 	/* ipv6IfIcmpInEchos, # of input echo requests */
183 	u_int64_t ifs6_in_echo;
184 	/* ipv6IfIcmpInEchoReplies, # of input echo replies */
185 	u_int64_t ifs6_in_echoreply;
186 	/* ipv6IfIcmpInRouterSolicits, # of input router solicitations */
187 	u_int64_t ifs6_in_routersolicit;
188 	/* ipv6IfIcmpInRouterAdvertisements, # of input router advertisements */
189 	u_int64_t ifs6_in_routeradvert;
190 	/* ipv6IfIcmpInNeighborSolicits, # of input neighbor solicitations */
191 	u_int64_t ifs6_in_neighborsolicit;
192 	/* ipv6IfIcmpInNeighborAdvertisements, # of input neighbor advertisements */
193 	u_int64_t ifs6_in_neighboradvert;
194 	/* ipv6IfIcmpInRedirects, # of input redirects */
195 	u_int64_t ifs6_in_redirect;
196 	/* ipv6IfIcmpInGroupMembQueries, # of input MLD queries */
197 	u_int64_t ifs6_in_mldquery;
198 	/* ipv6IfIcmpInGroupMembResponses, # of input MLD reports */
199 	u_int64_t ifs6_in_mldreport;
200 	/* ipv6IfIcmpInGroupMembReductions, # of input MLD done */
201 	u_int64_t ifs6_in_mlddone;
202 
203 	/*
204 	 * Output statistics. We should solve unresolved routing problem...
205 	 */
206 	/* ipv6IfIcmpOutMsgs, total # of output messages */
207 	u_int64_t ifs6_out_msg;
208 	/* ipv6IfIcmpOutErrors, # of output error messages */
209 	u_int64_t ifs6_out_error;
210 	/* ipv6IfIcmpOutDestUnreachs, # of output dest unreach errors */
211 	u_int64_t ifs6_out_dstunreach;
212 	/* ipv6IfIcmpOutAdminProhibs, # of output administratively prohibited errs */
213 	u_int64_t ifs6_out_adminprohib;
214 	/* ipv6IfIcmpOutTimeExcds, # of output time exceeded errors */
215 	u_int64_t ifs6_out_timeexceed;
216 	/* ipv6IfIcmpOutParmProblems, # of output parameter problem errors */
217 	u_int64_t ifs6_out_paramprob;
218 	/* ipv6IfIcmpOutPktTooBigs, # of output packet too big errors */
219 	u_int64_t ifs6_out_pkttoobig;
220 	/* ipv6IfIcmpOutEchos, # of output echo requests */
221 	u_int64_t ifs6_out_echo;
222 	/* ipv6IfIcmpOutEchoReplies, # of output echo replies */
223 	u_int64_t ifs6_out_echoreply;
224 	/* ipv6IfIcmpOutRouterSolicits, # of output router solicitations */
225 	u_int64_t ifs6_out_routersolicit;
226 	/* ipv6IfIcmpOutRouterAdvertisements, # of output router advertisements */
227 	u_int64_t ifs6_out_routeradvert;
228 	/* ipv6IfIcmpOutNeighborSolicits, # of output neighbor solicitations */
229 	u_int64_t ifs6_out_neighborsolicit;
230 	/* ipv6IfIcmpOutNeighborAdvertisements, # of output neighbor advertisements */
231 	u_int64_t ifs6_out_neighboradvert;
232 	/* ipv6IfIcmpOutRedirects, # of output redirects */
233 	u_int64_t ifs6_out_redirect;
234 	/* ipv6IfIcmpOutGroupMembQueries, # of output MLD queries */
235 	u_int64_t ifs6_out_mldquery;
236 	/* ipv6IfIcmpOutGroupMembResponses, # of output MLD reports */
237 	u_int64_t ifs6_out_mldreport;
238 	/* ipv6IfIcmpOutGroupMembReductions, # of output MLD done */
239 	u_int64_t ifs6_out_mlddone;
240 };
241 
242 struct	in6_ifreq {
243 	char	ifr_name[IFNAMSIZ];
244 	union {
245 		struct	sockaddr_in6 ifru_addr;
246 		struct	sockaddr_in6 ifru_dstaddr;
247 		short	ifru_flags;
248 		int	ifru_flags6;
249 		int	ifru_metric;
250 		caddr_t	ifru_data;
251 		struct in6_addrlifetime ifru_lifetime;
252 		struct in6_ifstat ifru_stat;
253 		struct icmp6_ifstat ifru_icmp6stat;
254 	} ifr_ifru;
255 };
256 
257 struct	in6_aliasreq {
258 	char	ifra_name[IFNAMSIZ];
259 	union {
260 		struct	sockaddr_in6 ifrau_addr;
261 		int	ifrau_align;
262 	 } ifra_ifrau;
263 #ifndef ifra_addr
264 #define ifra_addr	ifra_ifrau.ifrau_addr
265 #endif
266 	struct	sockaddr_in6 ifra_dstaddr;
267 	struct	sockaddr_in6 ifra_prefixmask;
268 	int	ifra_flags;
269 	struct in6_addrlifetime ifra_lifetime;
270 };
271 
272 /*
273  * Given a pointer to an in6_ifaddr (ifaddr),
274  * return a pointer to the addr as a sockaddr_in6
275  */
276 #define IA6_IN6(ia)	(&((ia)->ia_addr.sin6_addr))
277 #define IA6_DSTIN6(ia)	(&((ia)->ia_dstaddr.sin6_addr))
278 #define IA6_MASKIN6(ia)	(&((ia)->ia_prefixmask.sin6_addr))
279 #define IA6_SIN6(ia)	(&((ia)->ia_addr))
280 #define IA6_DSTSIN6(ia)	(&((ia)->ia_dstaddr))
281 #define IFA_IN6(x)	(&((struct sockaddr_in6 *)((x)->ifa_addr))->sin6_addr)
282 #define IFA_DSTIN6(x)	(&((struct sockaddr_in6 *)((x)->ifa_dstaddr))->sin6_addr)
283 
284 #ifdef _KERNEL
285 #define IN6_ARE_MASKED_ADDR_EQUAL(d, a, m)	(	\
286 	(((d)->s6_addr32[0] ^ (a)->s6_addr32[0]) & (m)->s6_addr32[0]) == 0 && \
287 	(((d)->s6_addr32[1] ^ (a)->s6_addr32[1]) & (m)->s6_addr32[1]) == 0 && \
288 	(((d)->s6_addr32[2] ^ (a)->s6_addr32[2]) & (m)->s6_addr32[2]) == 0 && \
289 	(((d)->s6_addr32[3] ^ (a)->s6_addr32[3]) & (m)->s6_addr32[3]) == 0 )
290 #endif /* _KERNEL */
291 
292 #define SIOCGIFADDR_IN6		_IOWR('i', 33, struct in6_ifreq)
293 
294 #define SIOCGIFDSTADDR_IN6	_IOWR('i', 34, struct in6_ifreq)
295 #define SIOCGIFNETMASK_IN6	_IOWR('i', 37, struct in6_ifreq)
296 
297 #define SIOCDIFADDR_IN6		 _IOW('i', 25, struct in6_ifreq)
298 #define SIOCAIFADDR_IN6		 _IOW('i', 26, struct in6_aliasreq)
299 
300 #define SIOCSIFPHYADDR_IN6       _IOW('i', 70, struct in6_aliasreq)
301 #define	SIOCGIFPSRCADDR_IN6	_IOWR('i', 71, struct in6_ifreq)
302 #define	SIOCGIFPDSTADDR_IN6	_IOWR('i', 72, struct in6_ifreq)
303 
304 #define SIOCGIFAFLAG_IN6	_IOWR('i', 73, struct in6_ifreq)
305 
306 #define SIOCGIFINFO_IN6		_IOWR('i', 108, struct in6_ndireq)
307 #define SIOCSNDFLUSH_IN6	_IOWR('i', 77, struct in6_ifreq)
308 #define SIOCGNBRINFO_IN6	_IOWR('i', 78, struct in6_nbrinfo)
309 #define SIOCSPFXFLUSH_IN6	_IOWR('i', 79, struct in6_ifreq)
310 #define SIOCSRTRFLUSH_IN6	_IOWR('i', 80, struct in6_ifreq)
311 
312 #define SIOCGIFALIFETIME_IN6	_IOWR('i', 81, struct in6_ifreq)
313 #define SIOCGIFSTAT_IN6		_IOWR('i', 83, struct in6_ifreq)
314 #define SIOCGIFSTAT_ICMP6	_IOWR('i', 84, struct in6_ifreq)
315 
316 #define SIOCSIFINFO_FLAGS	_IOWR('i', 87, struct in6_ndireq) /* XXX */
317 
318 #define SIOCGETSGCNT_IN6	_IOWR('u', 106, \
319 				      struct sioc_sg_req6) /* get s,g pkt cnt */
320 #define SIOCGETMIFCNT_IN6	_IOWR('u', 107, \
321 				      struct sioc_mif_req6) /* get pkt cnt per if */
322 
323 #define IN6_IFF_ANYCAST		0x01	/* anycast address */
324 #define IN6_IFF_TENTATIVE	0x02	/* tentative address */
325 #define IN6_IFF_DUPLICATED	0x04	/* DAD detected duplicate */
326 #define IN6_IFF_DETACHED	0x08	/* may be detached from the link */
327 #define IN6_IFF_DEPRECATED	0x10	/* deprecated address */
328 #define IN6_IFF_AUTOCONF	0x40	/* autoconfigurable address. */
329 #define IN6_IFF_PRIVACY		0x80	/* RFC 4941 temporary address */
330 
331 #ifdef _KERNEL
332 #define IN6_ARE_SCOPE_CMP(a,b) ((a)-(b))
333 #define IN6_ARE_SCOPE_EQUAL(a,b) ((a)==(b))
334 
335 TAILQ_HEAD(in6_ifaddrhead, in6_ifaddr);
336 extern struct in6_ifaddrhead in6_ifaddr;
337 extern struct icmp6stat icmp6stat;
338 
339 /*
340  * Multi-cast membership entry.  One for each group/ifp that a PCB
341  * belongs to.
342  */
343 struct in6_multi_mship {
344 	struct	in6_multi *i6mm_maddr;	/* Multicast address pointer */
345 	LIST_ENTRY(in6_multi_mship) i6mm_chain;  /* multicast options chain */
346 };
347 
348 struct in6_multi {
349 	struct ifmaddr		in6m_ifma;   /* Protocol-independent info */
350 #define in6m_refcnt		in6m_ifma.ifma_refcnt
351 #define in6m_ifidx		in6m_ifma.ifma_ifidx
352 
353 	struct sockaddr_in6	in6m_sin;   /* IPv6 multicast address */
354 #define in6m_addr		in6m_sin.sin6_addr
355 
356 	u_int			in6m_state; /* state of membership */
357 	u_int			in6m_timer; /* MLD6 membership report timer */
358 };
359 
360 static __inline struct in6_multi *
361 ifmatoin6m(struct ifmaddr *ifma)
362 {
363        return ((struct in6_multi *)(ifma));
364 }
365 
366 /*
367  * Macros for looking up the in6_multi record for a given IP6 multicast
368  * address on a given interface. If no matching record is found, "in6m"
369  * returns NULL.
370  */
371 #define IN6_LOOKUP_MULTI(addr, ifp, in6m)				\
372 	/* struct in6_addr addr; */					\
373 	/* struct ifnet *ifp; */					\
374 	/* struct in6_multi *in6m; */					\
375 do {									\
376 	struct ifmaddr *ifma;						\
377 									\
378 	(in6m) = NULL;							\
379 	TAILQ_FOREACH(ifma, &(ifp)->if_maddrlist, ifma_list)		\
380 		if (ifma->ifma_addr->sa_family == AF_INET6 &&		\
381 		    IN6_ARE_ADDR_EQUAL(&ifmatoin6m(ifma)->in6m_addr,	\
382 				       &(addr))) {			\
383 			(in6m) = ifmatoin6m(ifma);			\
384 			break;						\
385 		}							\
386 } while (/* CONSTCOND */ 0)
387 
388 struct	in6_multi *in6_addmulti(struct in6_addr *, struct ifnet *, int *);
389 void	in6_delmulti(struct in6_multi *);
390 int	in6_hasmulti(struct in6_addr *, struct ifnet *);
391 struct in6_multi_mship *in6_joingroup(struct ifnet *, struct in6_addr *, int *);
392 int	in6_leavegroup(struct in6_multi_mship *);
393 int	in6_control(struct socket *, u_long, caddr_t, struct ifnet *);
394 int	in6_ioctl(u_long, caddr_t, struct ifnet *, int);
395 int	in6_update_ifa(struct ifnet *, struct in6_aliasreq *,
396 	struct in6_ifaddr *);
397 void	in6_purgeaddr(struct ifaddr *);
398 int	in6if_do_dad(struct ifnet *);
399 void	*in6_domifattach(struct ifnet *);
400 void	in6_domifdetach(struct ifnet *, void *);
401 struct in6_ifaddr *in6ifa_ifpforlinklocal(struct ifnet *, int);
402 struct in6_ifaddr *in6ifa_ifpwithaddr(struct ifnet *, struct in6_addr *);
403 int	in6_addr2scopeid(unsigned int, struct in6_addr *);
404 int	in6_matchlen(struct in6_addr *, struct in6_addr *);
405 int	in6_are_prefix_equal(struct in6_addr *, struct in6_addr *, int);
406 void	in6_prefixlen2mask(struct in6_addr *, int);
407 void	in6_purgeprefix(struct ifnet *);
408 #endif /* _KERNEL */
409 
410 #endif /* _NETINET6_IN6_VAR_H_ */
411