xref: /freebsd/sys/netinet6/ip6_var.h (revision e12ff891366cf94db4bfe4c2c810b26a5531053d)
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 struct ip6asfrag;
72 /*
73  * IP6 reassembly queue structure.  Each fragment
74  * being reassembled is attached to one of these structures.
75  */
76 struct	ip6q {
77 	struct ip6asfrag *ip6q_down;
78 	struct ip6asfrag *ip6q_up;
79 	u_int32_t	ip6q_ident;
80 	u_int8_t	ip6q_nxt;
81 	u_int8_t	ip6q_ecn;
82 	u_int8_t	ip6q_ttl;
83 	struct in6_addr ip6q_src, ip6q_dst;
84 	struct ip6q	*ip6q_next;
85 	struct ip6q	*ip6q_prev;
86 	int		ip6q_unfrglen;	/* len of unfragmentable part */
87 	int		ip6q_nfrag;	/* # of fragments */
88 	struct label	*ip6q_label;
89 };
90 
91 /*
92  * IP6 reinjecting structure.
93  */
94 struct ip6_direct_ctx {
95 	uint32_t	ip6dc_nxt;	/* next header to process */
96 	uint32_t	ip6dc_off;	/* offset to next header */
97 };
98 
99 #if defined(_NETINET6_IN6_VAR_H_) && defined(_KERNEL)
100 /*
101  * Structure attached to inpcb.in6p_moptions and
102  * passed to ip6_output when IPv6 multicast options are in use.
103  * This structure is lazy-allocated.
104  */
105 struct ip6_moptions {
106 	struct	ifnet *im6o_multicast_ifp; /* ifp for outgoing multicasts */
107 	u_char	im6o_multicast_hlim;	/* hoplimit for outgoing multicasts */
108 	u_char	im6o_multicast_loop;	/* 1 >= hear sends if a member */
109 	struct ip6_mfilter_head im6o_head; /* group membership list */
110 };
111 #else
112 struct ip6_moptions;
113 #endif
114 /*
115  * Control options for outgoing packets
116  */
117 
118 /* Routing header related info */
119 struct	ip6po_rhinfo {
120 	struct	ip6_rthdr *ip6po_rhi_rthdr; /* Routing header */
121 	struct	route_in6 ip6po_rhi_route; /* Route to the 1st hop */
122 };
123 #define ip6po_rthdr	ip6po_rhinfo.ip6po_rhi_rthdr
124 #define ip6po_route	ip6po_rhinfo.ip6po_rhi_route
125 
126 /* Nexthop related info */
127 struct	ip6po_nhinfo {
128 	struct	sockaddr *ip6po_nhi_nexthop;
129 	struct	route_in6 ip6po_nhi_route; /* Route to the nexthop */
130 };
131 #define ip6po_nexthop	ip6po_nhinfo.ip6po_nhi_nexthop
132 #define ip6po_nextroute	ip6po_nhinfo.ip6po_nhi_route
133 
134 struct	ip6_pktopts {
135 	struct	mbuf *ip6po_m;	/* Pointer to mbuf storing the data */
136 	int	ip6po_hlim;	/* Hoplimit for outgoing packets */
137 
138 	/* Outgoing IF/address information */
139 	struct	in6_pktinfo *ip6po_pktinfo;
140 
141 	/* Next-hop address information */
142 	struct	ip6po_nhinfo ip6po_nhinfo;
143 
144 	struct	ip6_hbh *ip6po_hbh; /* Hop-by-Hop options header */
145 
146 	/* Destination options header (before a routing header) */
147 	struct	ip6_dest *ip6po_dest1;
148 
149 	/* Routing header related info. */
150 	struct	ip6po_rhinfo ip6po_rhinfo;
151 
152 	/* Destination options header (after a routing header) */
153 	struct	ip6_dest *ip6po_dest2;
154 
155 	int	ip6po_tclass;	/* traffic class */
156 
157 	int	ip6po_minmtu;  /* fragment vs PMTU discovery policy */
158 #define IP6PO_MINMTU_MCASTONLY	-1 /* default; send at min MTU for multicast*/
159 #define IP6PO_MINMTU_DISABLE	 0 /* always perform pmtu disc */
160 #define IP6PO_MINMTU_ALL	 1 /* always send at min MTU */
161 
162 	int	ip6po_prefer_tempaddr;  /* whether temporary addresses are
163 					   preferred as source address */
164 #define IP6PO_TEMPADDR_SYSTEM	-1 /* follow the system default */
165 #define IP6PO_TEMPADDR_NOTPREFER 0 /* not prefer temporary address */
166 #define IP6PO_TEMPADDR_PREFER	 1 /* prefer temporary address */
167 
168 	int ip6po_flags;
169 #if 0	/* parameters in this block is obsolete. do not reuse the values. */
170 #define IP6PO_REACHCONF	0x01	/* upper-layer reachability confirmation. */
171 #define IP6PO_MINMTU	0x02	/* use minimum MTU (IPV6_USE_MIN_MTU) */
172 #endif
173 #define IP6PO_DONTFRAG	0x04	/* disable fragmentation (IPV6_DONTFRAG) */
174 #define IP6PO_USECOA	0x08	/* use care of address */
175 };
176 
177 /*
178  * Control options for incoming packets
179  */
180 
181 struct	ip6stat {
182 	uint64_t ip6s_total;		/* total packets received */
183 	uint64_t ip6s_tooshort;		/* packet too short */
184 	uint64_t ip6s_toosmall;		/* not enough data */
185 	uint64_t ip6s_fragments;	/* fragments received */
186 	uint64_t ip6s_fragdropped;	/* frags dropped(dups, out of space) */
187 	uint64_t ip6s_fragtimeout;	/* fragments timed out */
188 	uint64_t ip6s_fragoverflow;	/* fragments that exceeded limit */
189 	uint64_t ip6s_forward;		/* packets forwarded */
190 	uint64_t ip6s_cantforward;	/* packets rcvd for unreachable dest */
191 	uint64_t ip6s_redirectsent;	/* packets forwarded on same net */
192 	uint64_t ip6s_delivered;	/* datagrams delivered to upper level*/
193 	uint64_t ip6s_localout;		/* total ip packets generated here */
194 	uint64_t ip6s_odropped;		/* lost packets due to nobufs, etc. */
195 	uint64_t ip6s_reassembled;	/* total packets reassembled ok */
196 	uint64_t ip6s_atomicfrags;	/* atomic fragments */
197 	uint64_t ip6s_fragmented;	/* datagrams successfully fragmented */
198 	uint64_t ip6s_ofragments;	/* output fragments created */
199 	uint64_t ip6s_cantfrag;		/* don't fragment flag was set, etc. */
200 	uint64_t ip6s_badoptions;	/* error in option processing */
201 	uint64_t ip6s_noroute;		/* packets discarded due to no route */
202 	uint64_t ip6s_badvers;		/* ip6 version != 6 */
203 	uint64_t ip6s_rawout;		/* total raw ip packets generated */
204 	uint64_t ip6s_badscope;		/* scope error */
205 	uint64_t ip6s_notmember;	/* don't join this multicast group */
206 #define	IP6S_HDRCNT		256	/* headers count */
207 	uint64_t ip6s_nxthist[IP6S_HDRCNT]; /* next header history */
208 	uint64_t ip6s_m1;		/* one mbuf */
209 #define	IP6S_M2MMAX		32
210 	uint64_t ip6s_m2m[IP6S_M2MMAX];	/* two or more mbuf */
211 	uint64_t ip6s_mext1;		/* one ext mbuf */
212 	uint64_t ip6s_mext2m;		/* two or more ext mbuf */
213 	uint64_t ip6s_exthdrtoolong;	/* ext hdr are not contiguous */
214 	uint64_t ip6s_nogif;		/* no match gif found */
215 	uint64_t ip6s_toomanyhdr;	/* discarded due to too many headers */
216 
217 	/*
218 	 * statistics for improvement of the source address selection
219 	 * algorithm:
220 	 * XXX: hardcoded 16 = # of ip6 multicast scope types + 1
221 	 */
222 #define	IP6S_RULESMAX		16
223 #define	IP6S_SCOPECNT		16
224 	/* number of times that address selection fails */
225 	uint64_t ip6s_sources_none;
226 	/* number of times that an address on the outgoing I/F is chosen */
227 	uint64_t ip6s_sources_sameif[IP6S_SCOPECNT];
228 	/* number of times that an address on a non-outgoing I/F is chosen */
229 	uint64_t ip6s_sources_otherif[IP6S_SCOPECNT];
230 	/*
231 	 * number of times that an address that has the same scope
232 	 * from the destination is chosen.
233 	 */
234 	uint64_t ip6s_sources_samescope[IP6S_SCOPECNT];
235 	/*
236 	 * number of times that an address that has a different scope
237 	 * from the destination is chosen.
238 	 */
239 	uint64_t ip6s_sources_otherscope[IP6S_SCOPECNT];
240 	/* number of times that a deprecated address is chosen */
241 	uint64_t ip6s_sources_deprecated[IP6S_SCOPECNT];
242 
243 	/* number of times that each rule of source selection is applied. */
244 	uint64_t ip6s_sources_rule[IP6S_RULESMAX];
245 };
246 
247 #ifdef _KERNEL
248 #include <sys/counter.h>
249 
250 VNET_PCPUSTAT_DECLARE(struct ip6stat, ip6stat);
251 #define	IP6STAT_ADD(name, val)	\
252     VNET_PCPUSTAT_ADD(struct ip6stat, ip6stat, name, (val))
253 #define	IP6STAT_SUB(name, val)	IP6STAT_ADD(name, -(val))
254 #define	IP6STAT_INC(name)	IP6STAT_ADD(name, 1)
255 #define	IP6STAT_DEC(name)	IP6STAT_SUB(name, 1)
256 #endif
257 
258 #ifdef _KERNEL
259 /* flags passed to ip6_output as last parameter */
260 #define	IPV6_UNSPECSRC		0x01	/* allow :: as the source address */
261 #define	IPV6_FORWARDING		0x02	/* most of IPv6 header exists */
262 #define	IPV6_MINMTU		0x04	/* use minimum MTU (IPV6_USE_MIN_MTU) */
263 
264 #ifdef __NO_STRICT_ALIGNMENT
265 #define IP6_HDR_ALIGNED_P(ip)	1
266 #else
267 #define IP6_HDR_ALIGNED_P(ip)	((((intptr_t) (ip)) & 3) == 0)
268 #endif
269 
270 VNET_DECLARE(int, ip6_defhlim);		/* default hop limit */
271 VNET_DECLARE(int, ip6_defmcasthlim);	/* default multicast hop limit */
272 VNET_DECLARE(int, ip6_forwarding);	/* act as router? */
273 VNET_DECLARE(int, ip6_use_deprecated);	/* allow deprecated addr as source */
274 VNET_DECLARE(int, ip6_rr_prune);	/* router renumbering prefix
275 					 * walk list every 5 sec.    */
276 VNET_DECLARE(int, ip6_mcast_pmtu);	/* enable pMTU discovery for multicast? */
277 VNET_DECLARE(int, ip6_v6only);
278 #define	V_ip6_defhlim			VNET(ip6_defhlim)
279 #define	V_ip6_defmcasthlim		VNET(ip6_defmcasthlim)
280 #define	V_ip6_forwarding		VNET(ip6_forwarding)
281 #define	V_ip6_use_deprecated		VNET(ip6_use_deprecated)
282 #define	V_ip6_rr_prune			VNET(ip6_rr_prune)
283 #define	V_ip6_mcast_pmtu		VNET(ip6_mcast_pmtu)
284 #define	V_ip6_v6only			VNET(ip6_v6only)
285 
286 VNET_DECLARE(struct socket *, ip6_mrouter);	/* multicast routing daemon */
287 VNET_DECLARE(int, ip6_sendredirects);	/* send IP redirects when forwarding? */
288 VNET_DECLARE(int, ip6_accept_rtadv);	/* Acts as a host not a router */
289 VNET_DECLARE(int, ip6_no_radr);		/* No defroute from RA */
290 VNET_DECLARE(int, ip6_norbit_raif);	/* Disable R-bit in NA on RA
291 					 * receiving IF. */
292 VNET_DECLARE(int, ip6_rfc6204w3);	/* Accept defroute from RA even when
293 					   forwarding enabled */
294 VNET_DECLARE(int, ip6_log_interval);
295 VNET_DECLARE(time_t, ip6_log_time);
296 VNET_DECLARE(int, ip6_hdrnestlimit);	/* upper limit of # of extension
297 					 * headers */
298 VNET_DECLARE(int, ip6_dad_count);	/* DupAddrDetectionTransmits */
299 #define	V_ip6_mrouter			VNET(ip6_mrouter)
300 #define	V_ip6_sendredirects		VNET(ip6_sendredirects)
301 #define	V_ip6_accept_rtadv		VNET(ip6_accept_rtadv)
302 #define	V_ip6_no_radr			VNET(ip6_no_radr)
303 #define	V_ip6_norbit_raif		VNET(ip6_norbit_raif)
304 #define	V_ip6_rfc6204w3			VNET(ip6_rfc6204w3)
305 #define	V_ip6_log_interval		VNET(ip6_log_interval)
306 #define	V_ip6_log_time			VNET(ip6_log_time)
307 #define	V_ip6_hdrnestlimit		VNET(ip6_hdrnestlimit)
308 #define	V_ip6_dad_count			VNET(ip6_dad_count)
309 
310 VNET_DECLARE(int, ip6_auto_flowlabel);
311 VNET_DECLARE(int, ip6_auto_linklocal);
312 #define	V_ip6_auto_flowlabel		VNET(ip6_auto_flowlabel)
313 #define	V_ip6_auto_linklocal		VNET(ip6_auto_linklocal)
314 
315 VNET_DECLARE(int, ip6_use_tempaddr);	/* Whether to use temporary addresses */
316 VNET_DECLARE(int, ip6_prefer_tempaddr);	/* Whether to prefer temporary
317 					 * addresses in the source address
318 					 * selection */
319 #define	V_ip6_use_tempaddr		VNET(ip6_use_tempaddr)
320 #define	V_ip6_prefer_tempaddr		VNET(ip6_prefer_tempaddr)
321 
322 VNET_DECLARE(int, ip6_use_defzone);	/* Whether to use the default scope
323 					 * zone when unspecified */
324 #define	V_ip6_use_defzone		VNET(ip6_use_defzone)
325 
326 VNET_DECLARE(struct pfil_head *, inet6_pfil_head);
327 #define	V_inet6_pfil_head	VNET(inet6_pfil_head)
328 #define	PFIL_INET6_NAME		"inet6"
329 
330 #ifdef IPSTEALTH
331 VNET_DECLARE(int, ip6stealth);
332 #define	V_ip6stealth			VNET(ip6stealth)
333 #endif
334 
335 #ifdef EXPERIMENTAL
336 VNET_DECLARE(int, nd6_ignore_ipv6_only_ra);
337 #define	V_nd6_ignore_ipv6_only_ra	VNET(nd6_ignore_ipv6_only_ra)
338 #endif
339 
340 extern struct	pr_usrreqs rip6_usrreqs;
341 struct sockopt;
342 
343 struct inpcb;
344 
345 int	icmp6_ctloutput(struct socket *, struct sockopt *sopt);
346 
347 struct in6_ifaddr;
348 void	ip6_init(void);
349 int	ip6proto_register(short);
350 int	ip6proto_unregister(short);
351 
352 void	ip6_input(struct mbuf *);
353 void	ip6_direct_input(struct mbuf *);
354 void	ip6_freepcbopts(struct ip6_pktopts *);
355 
356 int	ip6_unknown_opt(u_int8_t *, struct mbuf *, int);
357 int	ip6_get_prevhdr(const struct mbuf *, int);
358 int	ip6_nexthdr(const struct mbuf *, int, int, int *);
359 int	ip6_lasthdr(const struct mbuf *, int, int, int *);
360 
361 extern int	(*ip6_mforward)(struct ip6_hdr *, struct ifnet *,
362     struct mbuf *);
363 
364 int	ip6_process_hopopts(struct mbuf *, u_int8_t *, int, u_int32_t *,
365 				 u_int32_t *);
366 struct mbuf	**ip6_savecontrol_v4(struct inpcb *, struct mbuf *,
367 	    struct mbuf **, int *);
368 void	ip6_savecontrol(struct inpcb *, struct mbuf *, struct mbuf **);
369 void	ip6_notify_pmtu(struct inpcb *, struct sockaddr_in6 *, u_int32_t);
370 int	ip6_sysctl(int *, u_int, void *, size_t *, void *, size_t);
371 
372 void	ip6_forward(struct mbuf *, int);
373 
374 void	ip6_mloopback(struct ifnet *, struct mbuf *);
375 int	ip6_output(struct mbuf *, struct ip6_pktopts *,
376 			struct route_in6 *,
377 			int,
378 			struct ip6_moptions *, struct ifnet **,
379 			struct inpcb *);
380 int	ip6_ctloutput(struct socket *, struct sockopt *);
381 int	ip6_raw_ctloutput(struct socket *, struct sockopt *);
382 void	ip6_initpktopts(struct ip6_pktopts *);
383 int	ip6_setpktopts(struct mbuf *, struct ip6_pktopts *,
384 	struct ip6_pktopts *, struct ucred *, int);
385 void	ip6_clearpktopts(struct ip6_pktopts *, int);
386 struct ip6_pktopts *ip6_copypktopts(struct ip6_pktopts *, int);
387 int	ip6_optlen(struct inpcb *);
388 int	ip6_deletefraghdr(struct mbuf *, int, int);
389 int	ip6_fragment(struct ifnet *, struct mbuf *, int, u_char, int,
390 			uint32_t);
391 
392 int	route6_input(struct mbuf **, int *, int);
393 
394 void	frag6_init(void);
395 int	frag6_input(struct mbuf **, int *, int);
396 void	frag6_slowtimo(void);
397 void	frag6_drain(void);
398 
399 void	rip6_init(void);
400 int	rip6_input(struct mbuf **, int *, int);
401 void	rip6_ctlinput(int, struct sockaddr *, void *);
402 int	rip6_ctloutput(struct socket *, struct sockopt *);
403 int	rip6_output(struct mbuf *, struct socket *, ...);
404 int	rip6_usrreq(struct socket *,
405 	    int, struct mbuf *, struct mbuf *, struct mbuf *, struct thread *);
406 
407 int	dest6_input(struct mbuf **, int *, int);
408 int	none_input(struct mbuf **, int *, int);
409 
410 int	in6_selectsrc_socket(struct sockaddr_in6 *, struct ip6_pktopts *,
411     struct inpcb *, struct ucred *, int, struct in6_addr *, int *);
412 int	in6_selectsrc_addr(uint32_t, const struct in6_addr *,
413     uint32_t, struct ifnet *, struct in6_addr *, int *);
414 int in6_selectroute(struct sockaddr_in6 *, struct ip6_pktopts *,
415 	struct ip6_moptions *, struct route_in6 *, struct ifnet **,
416 	struct rtentry **);
417 int	in6_selectroute_fib(struct sockaddr_in6 *, struct ip6_pktopts *,
418 	    struct ip6_moptions *, struct route_in6 *, struct ifnet **,
419 	    struct rtentry **, u_int);
420 u_int32_t ip6_randomid(void);
421 u_int32_t ip6_randomflowlabel(void);
422 void in6_delayed_cksum(struct mbuf *m, uint32_t plen, u_short offset);
423 #endif /* _KERNEL */
424 
425 #endif /* !_NETINET6_IP6_VAR_H_ */
426