xref: /freebsd/sys/netinet6/ip6_var.h (revision 0bf48626aaa33768078f5872b922b1487b3a9296)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the project nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	$KAME: ip6_var.h,v 1.62 2001/05/03 14:51:48 itojun Exp $
32  */
33 
34 /*-
35  * Copyright (c) 1982, 1986, 1993
36  *	The Regents of the University of California.  All rights reserved.
37  *
38  * Redistribution and use in source and binary forms, with or without
39  * modification, are permitted provided that the following conditions
40  * are met:
41  * 1. Redistributions of source code must retain the above copyright
42  *    notice, this list of conditions and the following disclaimer.
43  * 2. Redistributions in binary form must reproduce the above copyright
44  *    notice, this list of conditions and the following disclaimer in the
45  *    documentation and/or other materials provided with the distribution.
46  * 3. Neither the name of the University nor the names of its contributors
47  *    may be used to endorse or promote products derived from this software
48  *    without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
54  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
60  * SUCH DAMAGE.
61  *
62  *	@(#)ip_var.h	8.1 (Berkeley) 6/10/93
63  * $FreeBSD$
64  */
65 
66 #ifndef _NETINET6_IP6_VAR_H_
67 #define _NETINET6_IP6_VAR_H_
68 
69 #include <sys/epoch.h>
70 
71 /*
72  * IP6 reassembly queue structure.  Each fragment
73  * being reassembled is attached to one of these structures.
74  */
75 struct	ip6q {
76 	struct ip6asfrag *ip6q_down;
77 	struct ip6asfrag *ip6q_up;
78 	u_int32_t	ip6q_ident;
79 	u_int8_t	ip6q_nxt;
80 	u_int8_t	ip6q_ecn;
81 	u_int8_t	ip6q_ttl;
82 	struct in6_addr ip6q_src, ip6q_dst;
83 	struct ip6q	*ip6q_next;
84 	struct ip6q	*ip6q_prev;
85 	int		ip6q_unfrglen;	/* len of unfragmentable part */
86 #ifdef notyet
87 	u_char		*ip6q_nxtp;
88 #endif
89 	int		ip6q_nfrag;	/* # of fragments */
90 	struct label	*ip6q_label;
91 };
92 
93 struct	ip6asfrag {
94 	struct ip6asfrag *ip6af_down;
95 	struct ip6asfrag *ip6af_up;
96 	struct mbuf	*ip6af_m;
97 	int		ip6af_offset;	/* offset in ip6af_m to next header */
98 	int		ip6af_frglen;	/* fragmentable part length */
99 	int		ip6af_off;	/* fragment offset */
100 	u_int16_t	ip6af_mff;	/* more fragment bit in frag off */
101 };
102 
103 #define IP6_REASS_MBUF(ip6af) (*(struct mbuf **)&((ip6af)->ip6af_m))
104 
105 /*
106  * IP6 reinjecting structure.
107  */
108 struct ip6_direct_ctx {
109 	uint32_t	ip6dc_nxt;	/* next header to process */
110 	uint32_t	ip6dc_off;	/* offset to next header */
111 };
112 
113 #if defined(_NETINET6_IN6_VAR_H_) && defined(_KERNEL)
114 /*
115  * Structure attached to inpcb.in6p_moptions and
116  * passed to ip6_output when IPv6 multicast options are in use.
117  * This structure is lazy-allocated.
118  */
119 struct ip6_moptions {
120 	struct	ifnet *im6o_multicast_ifp; /* ifp for outgoing multicasts */
121 	u_char	im6o_multicast_hlim;	/* hoplimit for outgoing multicasts */
122 	u_char	im6o_multicast_loop;	/* 1 >= hear sends if a member */
123 	struct ip6_mfilter_head im6o_head; /* group membership list */
124 };
125 #else
126 struct ip6_moptions;
127 #endif
128 /*
129  * Control options for outgoing packets
130  */
131 
132 /* Routing header related info */
133 struct	ip6po_rhinfo {
134 	struct	ip6_rthdr *ip6po_rhi_rthdr; /* Routing header */
135 	struct	route_in6 ip6po_rhi_route; /* Route to the 1st hop */
136 };
137 #define ip6po_rthdr	ip6po_rhinfo.ip6po_rhi_rthdr
138 #define ip6po_route	ip6po_rhinfo.ip6po_rhi_route
139 
140 /* Nexthop related info */
141 struct	ip6po_nhinfo {
142 	struct	sockaddr *ip6po_nhi_nexthop;
143 	struct	route_in6 ip6po_nhi_route; /* Route to the nexthop */
144 };
145 #define ip6po_nexthop	ip6po_nhinfo.ip6po_nhi_nexthop
146 #define ip6po_nextroute	ip6po_nhinfo.ip6po_nhi_route
147 
148 struct	ip6_pktopts {
149 	struct	mbuf *ip6po_m;	/* Pointer to mbuf storing the data */
150 	int	ip6po_hlim;	/* Hoplimit for outgoing packets */
151 
152 	/* Outgoing IF/address information */
153 	struct	in6_pktinfo *ip6po_pktinfo;
154 
155 	/* Next-hop address information */
156 	struct	ip6po_nhinfo ip6po_nhinfo;
157 
158 	struct	ip6_hbh *ip6po_hbh; /* Hop-by-Hop options header */
159 
160 	/* Destination options header (before a routing header) */
161 	struct	ip6_dest *ip6po_dest1;
162 
163 	/* Routing header related info. */
164 	struct	ip6po_rhinfo ip6po_rhinfo;
165 
166 	/* Destination options header (after a routing header) */
167 	struct	ip6_dest *ip6po_dest2;
168 
169 	int	ip6po_tclass;	/* traffic class */
170 
171 	int	ip6po_minmtu;  /* fragment vs PMTU discovery policy */
172 #define IP6PO_MINMTU_MCASTONLY	-1 /* default; send at min MTU for multicast*/
173 #define IP6PO_MINMTU_DISABLE	 0 /* always perform pmtu disc */
174 #define IP6PO_MINMTU_ALL	 1 /* always send at min MTU */
175 
176 	int	ip6po_prefer_tempaddr;  /* whether temporary addresses are
177 					   preferred as source address */
178 #define IP6PO_TEMPADDR_SYSTEM	-1 /* follow the system default */
179 #define IP6PO_TEMPADDR_NOTPREFER 0 /* not prefer temporary address */
180 #define IP6PO_TEMPADDR_PREFER	 1 /* prefer temporary address */
181 
182 	int ip6po_flags;
183 #if 0	/* parameters in this block is obsolete. do not reuse the values. */
184 #define IP6PO_REACHCONF	0x01	/* upper-layer reachability confirmation. */
185 #define IP6PO_MINMTU	0x02	/* use minimum MTU (IPV6_USE_MIN_MTU) */
186 #endif
187 #define IP6PO_DONTFRAG	0x04	/* disable fragmentation (IPV6_DONTFRAG) */
188 #define IP6PO_USECOA	0x08	/* use care of address */
189 };
190 
191 /*
192  * Control options for incoming packets
193  */
194 
195 struct	ip6stat {
196 	uint64_t ip6s_total;		/* total packets received */
197 	uint64_t ip6s_tooshort;		/* packet too short */
198 	uint64_t ip6s_toosmall;		/* not enough data */
199 	uint64_t ip6s_fragments;	/* fragments received */
200 	uint64_t ip6s_fragdropped;	/* frags dropped(dups, out of space) */
201 	uint64_t ip6s_fragtimeout;	/* fragments timed out */
202 	uint64_t ip6s_fragoverflow;	/* fragments that exceeded limit */
203 	uint64_t ip6s_forward;		/* packets forwarded */
204 	uint64_t ip6s_cantforward;	/* packets rcvd for unreachable dest */
205 	uint64_t ip6s_redirectsent;	/* packets forwarded on same net */
206 	uint64_t ip6s_delivered;	/* datagrams delivered to upper level*/
207 	uint64_t ip6s_localout;		/* total ip packets generated here */
208 	uint64_t ip6s_odropped;		/* lost packets due to nobufs, etc. */
209 	uint64_t ip6s_reassembled;	/* total packets reassembled ok */
210 	uint64_t ip6s_atomicfrags;	/* atomic fragments */
211 	uint64_t ip6s_fragmented;	/* datagrams successfully fragmented */
212 	uint64_t ip6s_ofragments;	/* output fragments created */
213 	uint64_t ip6s_cantfrag;		/* don't fragment flag was set, etc. */
214 	uint64_t ip6s_badoptions;	/* error in option processing */
215 	uint64_t ip6s_noroute;		/* packets discarded due to no route */
216 	uint64_t ip6s_badvers;		/* ip6 version != 6 */
217 	uint64_t ip6s_rawout;		/* total raw ip packets generated */
218 	uint64_t ip6s_badscope;		/* scope error */
219 	uint64_t ip6s_notmember;	/* don't join this multicast group */
220 #define	IP6S_HDRCNT		256	/* headers count */
221 	uint64_t ip6s_nxthist[IP6S_HDRCNT]; /* next header history */
222 	uint64_t ip6s_m1;		/* one mbuf */
223 #define	IP6S_M2MMAX		32
224 	uint64_t ip6s_m2m[IP6S_M2MMAX];	/* two or more mbuf */
225 	uint64_t ip6s_mext1;		/* one ext mbuf */
226 	uint64_t ip6s_mext2m;		/* two or more ext mbuf */
227 	uint64_t ip6s_exthdrtoolong;	/* ext hdr are not contiguous */
228 	uint64_t ip6s_nogif;		/* no match gif found */
229 	uint64_t ip6s_toomanyhdr;	/* discarded due to too many headers */
230 
231 	/*
232 	 * statistics for improvement of the source address selection
233 	 * algorithm:
234 	 * XXX: hardcoded 16 = # of ip6 multicast scope types + 1
235 	 */
236 #define	IP6S_RULESMAX		16
237 #define	IP6S_SCOPECNT		16
238 	/* number of times that address selection fails */
239 	uint64_t ip6s_sources_none;
240 	/* number of times that an address on the outgoing I/F is chosen */
241 	uint64_t ip6s_sources_sameif[IP6S_SCOPECNT];
242 	/* number of times that an address on a non-outgoing I/F is chosen */
243 	uint64_t ip6s_sources_otherif[IP6S_SCOPECNT];
244 	/*
245 	 * number of times that an address that has the same scope
246 	 * from the destination is chosen.
247 	 */
248 	uint64_t ip6s_sources_samescope[IP6S_SCOPECNT];
249 	/*
250 	 * number of times that an address that has a different scope
251 	 * from the destination is chosen.
252 	 */
253 	uint64_t ip6s_sources_otherscope[IP6S_SCOPECNT];
254 	/* number of times that a deprecated address is chosen */
255 	uint64_t ip6s_sources_deprecated[IP6S_SCOPECNT];
256 
257 	/* number of times that each rule of source selection is applied. */
258 	uint64_t ip6s_sources_rule[IP6S_RULESMAX];
259 };
260 
261 #ifdef _KERNEL
262 #include <sys/counter.h>
263 
264 VNET_PCPUSTAT_DECLARE(struct ip6stat, ip6stat);
265 #define	IP6STAT_ADD(name, val)	\
266     VNET_PCPUSTAT_ADD(struct ip6stat, ip6stat, name, (val))
267 #define	IP6STAT_SUB(name, val)	IP6STAT_ADD(name, -(val))
268 #define	IP6STAT_INC(name)	IP6STAT_ADD(name, 1)
269 #define	IP6STAT_DEC(name)	IP6STAT_SUB(name, 1)
270 #endif
271 
272 #ifdef _KERNEL
273 /* flags passed to ip6_output as last parameter */
274 #define	IPV6_UNSPECSRC		0x01	/* allow :: as the source address */
275 #define	IPV6_FORWARDING		0x02	/* most of IPv6 header exists */
276 #define	IPV6_MINMTU		0x04	/* use minimum MTU (IPV6_USE_MIN_MTU) */
277 
278 #ifdef __NO_STRICT_ALIGNMENT
279 #define IP6_HDR_ALIGNED_P(ip)	1
280 #else
281 #define IP6_HDR_ALIGNED_P(ip)	((((intptr_t) (ip)) & 3) == 0)
282 #endif
283 
284 VNET_DECLARE(int, ip6_defhlim);		/* default hop limit */
285 VNET_DECLARE(int, ip6_defmcasthlim);	/* default multicast hop limit */
286 VNET_DECLARE(int, ip6_forwarding);	/* act as router? */
287 VNET_DECLARE(int, ip6_use_deprecated);	/* allow deprecated addr as source */
288 VNET_DECLARE(int, ip6_rr_prune);	/* router renumbering prefix
289 					 * walk list every 5 sec.    */
290 VNET_DECLARE(int, ip6_mcast_pmtu);	/* enable pMTU discovery for multicast? */
291 VNET_DECLARE(int, ip6_v6only);
292 #define	V_ip6_defhlim			VNET(ip6_defhlim)
293 #define	V_ip6_defmcasthlim		VNET(ip6_defmcasthlim)
294 #define	V_ip6_forwarding		VNET(ip6_forwarding)
295 #define	V_ip6_use_deprecated		VNET(ip6_use_deprecated)
296 #define	V_ip6_rr_prune			VNET(ip6_rr_prune)
297 #define	V_ip6_mcast_pmtu		VNET(ip6_mcast_pmtu)
298 #define	V_ip6_v6only			VNET(ip6_v6only)
299 
300 VNET_DECLARE(struct socket *, ip6_mrouter);	/* multicast routing daemon */
301 VNET_DECLARE(int, ip6_sendredirects);	/* send IP redirects when forwarding? */
302 VNET_DECLARE(int, ip6_accept_rtadv);	/* Acts as a host not a router */
303 VNET_DECLARE(int, ip6_no_radr);		/* No defroute from RA */
304 VNET_DECLARE(int, ip6_norbit_raif);	/* Disable R-bit in NA on RA
305 					 * receiving IF. */
306 VNET_DECLARE(int, ip6_rfc6204w3);	/* Accept defroute from RA even when
307 					   forwarding enabled */
308 VNET_DECLARE(int, ip6_log_interval);
309 VNET_DECLARE(time_t, ip6_log_time);
310 VNET_DECLARE(int, ip6_hdrnestlimit);	/* upper limit of # of extension
311 					 * headers */
312 VNET_DECLARE(int, ip6_dad_count);	/* DupAddrDetectionTransmits */
313 #define	V_ip6_mrouter			VNET(ip6_mrouter)
314 #define	V_ip6_sendredirects		VNET(ip6_sendredirects)
315 #define	V_ip6_accept_rtadv		VNET(ip6_accept_rtadv)
316 #define	V_ip6_no_radr			VNET(ip6_no_radr)
317 #define	V_ip6_norbit_raif		VNET(ip6_norbit_raif)
318 #define	V_ip6_rfc6204w3			VNET(ip6_rfc6204w3)
319 #define	V_ip6_log_interval		VNET(ip6_log_interval)
320 #define	V_ip6_log_time			VNET(ip6_log_time)
321 #define	V_ip6_hdrnestlimit		VNET(ip6_hdrnestlimit)
322 #define	V_ip6_dad_count			VNET(ip6_dad_count)
323 
324 VNET_DECLARE(int, ip6_auto_flowlabel);
325 VNET_DECLARE(int, ip6_auto_linklocal);
326 #define	V_ip6_auto_flowlabel		VNET(ip6_auto_flowlabel)
327 #define	V_ip6_auto_linklocal		VNET(ip6_auto_linklocal)
328 
329 VNET_DECLARE(int, ip6_use_tempaddr);	/* Whether to use temporary addresses */
330 VNET_DECLARE(int, ip6_prefer_tempaddr);	/* Whether to prefer temporary
331 					 * addresses in the source address
332 					 * selection */
333 #define	V_ip6_use_tempaddr		VNET(ip6_use_tempaddr)
334 #define	V_ip6_prefer_tempaddr		VNET(ip6_prefer_tempaddr)
335 
336 VNET_DECLARE(int, ip6_use_defzone);	/* Whether to use the default scope
337 					 * zone when unspecified */
338 #define	V_ip6_use_defzone		VNET(ip6_use_defzone)
339 
340 VNET_DECLARE(struct pfil_head *, inet6_pfil_head);
341 #define	V_inet6_pfil_head	VNET(inet6_pfil_head)
342 #define	PFIL_INET6_NAME		"inet6"
343 
344 #ifdef IPSTEALTH
345 VNET_DECLARE(int, ip6stealth);
346 #define	V_ip6stealth			VNET(ip6stealth)
347 #endif
348 
349 #ifdef EXPERIMENTAL
350 VNET_DECLARE(int, nd6_ignore_ipv6_only_ra);
351 #define	V_nd6_ignore_ipv6_only_ra	VNET(nd6_ignore_ipv6_only_ra)
352 #endif
353 
354 extern struct	pr_usrreqs rip6_usrreqs;
355 struct sockopt;
356 
357 struct inpcb;
358 
359 int	icmp6_ctloutput(struct socket *, struct sockopt *sopt);
360 
361 struct in6_ifaddr;
362 void	ip6_init(void);
363 int	ip6proto_register(short);
364 int	ip6proto_unregister(short);
365 
366 void	ip6_input(struct mbuf *);
367 void	ip6_direct_input(struct mbuf *);
368 void	ip6_freepcbopts(struct ip6_pktopts *);
369 
370 int	ip6_unknown_opt(u_int8_t *, struct mbuf *, int);
371 int	ip6_get_prevhdr(const struct mbuf *, int);
372 int	ip6_nexthdr(const struct mbuf *, int, int, int *);
373 int	ip6_lasthdr(const struct mbuf *, int, int, int *);
374 
375 extern int	(*ip6_mforward)(struct ip6_hdr *, struct ifnet *,
376     struct mbuf *);
377 
378 int	ip6_process_hopopts(struct mbuf *, u_int8_t *, int, u_int32_t *,
379 				 u_int32_t *);
380 struct mbuf	**ip6_savecontrol_v4(struct inpcb *, struct mbuf *,
381 	    struct mbuf **, int *);
382 void	ip6_savecontrol(struct inpcb *, struct mbuf *, struct mbuf **);
383 void	ip6_notify_pmtu(struct inpcb *, struct sockaddr_in6 *, u_int32_t);
384 int	ip6_sysctl(int *, u_int, void *, size_t *, void *, size_t);
385 
386 void	ip6_forward(struct mbuf *, int);
387 
388 void	ip6_mloopback(struct ifnet *, struct mbuf *);
389 int	ip6_output(struct mbuf *, struct ip6_pktopts *,
390 			struct route_in6 *,
391 			int,
392 			struct ip6_moptions *, struct ifnet **,
393 			struct inpcb *);
394 int	ip6_ctloutput(struct socket *, struct sockopt *);
395 int	ip6_raw_ctloutput(struct socket *, struct sockopt *);
396 void	ip6_initpktopts(struct ip6_pktopts *);
397 int	ip6_setpktopts(struct mbuf *, struct ip6_pktopts *,
398 	struct ip6_pktopts *, struct ucred *, int);
399 void	ip6_clearpktopts(struct ip6_pktopts *, int);
400 struct ip6_pktopts *ip6_copypktopts(struct ip6_pktopts *, int);
401 int	ip6_optlen(struct inpcb *);
402 int	ip6_deletefraghdr(struct mbuf *, int, int);
403 int	ip6_fragment(struct ifnet *, struct mbuf *, int, u_char, int,
404 			uint32_t);
405 
406 int	route6_input(struct mbuf **, int *, int);
407 
408 void	frag6_init(void);
409 int	frag6_input(struct mbuf **, int *, int);
410 void	frag6_slowtimo(void);
411 void	frag6_drain(void);
412 
413 void	rip6_init(void);
414 int	rip6_input(struct mbuf **, int *, int);
415 void	rip6_ctlinput(int, struct sockaddr *, void *);
416 int	rip6_ctloutput(struct socket *, struct sockopt *);
417 int	rip6_output(struct mbuf *, struct socket *, ...);
418 int	rip6_usrreq(struct socket *,
419 	    int, struct mbuf *, struct mbuf *, struct mbuf *, struct thread *);
420 
421 int	dest6_input(struct mbuf **, int *, int);
422 int	none_input(struct mbuf **, int *, int);
423 
424 int	in6_selectsrc_socket(struct sockaddr_in6 *, struct ip6_pktopts *,
425     struct inpcb *, struct ucred *, int, struct in6_addr *, int *);
426 int	in6_selectsrc_addr(uint32_t, const struct in6_addr *,
427     uint32_t, struct ifnet *, struct in6_addr *, int *);
428 int in6_selectroute(struct sockaddr_in6 *, struct ip6_pktopts *,
429 	struct ip6_moptions *, struct route_in6 *, struct ifnet **,
430 	struct rtentry **);
431 int	in6_selectroute_fib(struct sockaddr_in6 *, struct ip6_pktopts *,
432 	    struct ip6_moptions *, struct route_in6 *, struct ifnet **,
433 	    struct rtentry **, u_int);
434 u_int32_t ip6_randomid(void);
435 u_int32_t ip6_randomflowlabel(void);
436 void in6_delayed_cksum(struct mbuf *m, uint32_t plen, u_short offset);
437 #endif /* _KERNEL */
438 
439 #endif /* !_NETINET6_IP6_VAR_H_ */
440