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