xref: /freebsd/sys/netinet6/ip6_var.h (revision dcc3a33188bceb5b6e819efdb9c5f72d059084b6)
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 	u_quad_t ip6s_total;		/* total packets received */
185 	u_quad_t ip6s_tooshort;		/* packet too short */
186 	u_quad_t ip6s_toosmall;		/* not enough data */
187 	u_quad_t ip6s_fragments;	/* fragments received */
188 	u_quad_t ip6s_fragdropped;	/* frags dropped(dups, out of space) */
189 	u_quad_t ip6s_fragtimeout;	/* fragments timed out */
190 	u_quad_t ip6s_fragoverflow;	/* fragments that exceeded limit */
191 	u_quad_t ip6s_forward;		/* packets forwarded */
192 	u_quad_t ip6s_cantforward;	/* packets rcvd for unreachable dest */
193 	u_quad_t ip6s_redirectsent;	/* packets forwarded on same net */
194 	u_quad_t ip6s_delivered;	/* datagrams delivered to upper level*/
195 	u_quad_t ip6s_localout;		/* total ip packets generated here */
196 	u_quad_t ip6s_odropped;		/* lost packets due to nobufs, etc. */
197 	u_quad_t ip6s_reassembled;	/* total packets reassembled ok */
198 	u_quad_t ip6s_fragmented;	/* datagrams successfully fragmented */
199 	u_quad_t ip6s_ofragments;	/* output fragments created */
200 	u_quad_t ip6s_cantfrag;		/* don't fragment flag was set, etc. */
201 	u_quad_t ip6s_badoptions;	/* error in option processing */
202 	u_quad_t ip6s_noroute;		/* packets discarded due to no route */
203 	u_quad_t ip6s_badvers;		/* ip6 version != 6 */
204 	u_quad_t ip6s_rawout;		/* total raw ip packets generated */
205 	u_quad_t ip6s_badscope;		/* scope error */
206 	u_quad_t ip6s_notmember;	/* don't join this multicast group */
207 	u_quad_t ip6s_nxthist[256];	/* next header history */
208 	u_quad_t ip6s_m1;		/* one mbuf */
209 	u_quad_t ip6s_m2m[32];		/* two or more mbuf */
210 	u_quad_t ip6s_mext1;		/* one ext mbuf */
211 	u_quad_t ip6s_mext2m;		/* two or more ext mbuf */
212 	u_quad_t ip6s_exthdrtoolong;	/* ext hdr are not continuous */
213 	u_quad_t ip6s_nogif;		/* no match gif found */
214 	u_quad_t ip6s_toomanyhdr;	/* discarded due to too many headers */
215 
216 	/*
217 	 * statistics for improvement of the source address selection
218 	 * algorithm:
219 	 * XXX: hardcoded 16 = # of ip6 multicast scope types + 1
220 	 */
221 	/* number of times that address selection fails */
222 	u_quad_t ip6s_sources_none;
223 	/* number of times that an address on the outgoing I/F is chosen */
224 	u_quad_t ip6s_sources_sameif[16];
225 	/* number of times that an address on a non-outgoing I/F is chosen */
226 	u_quad_t ip6s_sources_otherif[16];
227 	/*
228 	 * number of times that an address that has the same scope
229 	 * from the destination is chosen.
230 	 */
231 	u_quad_t ip6s_sources_samescope[16];
232 	/*
233 	 * number of times that an address that has a different scope
234 	 * from the destination is chosen.
235 	 */
236 	u_quad_t ip6s_sources_otherscope[16];
237 	/* number of times that a deprecated address is chosen */
238 	u_quad_t ip6s_sources_deprecated[16];
239 
240 	/* number of times that each rule of source selection is applied. */
241 	u_quad_t ip6s_sources_rule[16];
242 };
243 
244 #ifdef _KERNEL
245 #define	IP6STAT_ADD(name, val)	V_ip6stat.name += (val)
246 #define	IP6STAT_SUB(name, val)	V_ip6stat.name -= (val)
247 #define	IP6STAT_INC(name)	IP6STAT_ADD(name, 1)
248 #define	IP6STAT_DEC(name)	IP6STAT_SUB(name, 1)
249 #endif
250 
251 #ifdef _KERNEL
252 /*
253  * IPv6 onion peeling state.
254  * it will be initialized when we come into ip6_input().
255  * XXX do not make it a kitchen sink!
256  */
257 struct ip6aux {
258 	u_int32_t ip6a_flags;
259 #define IP6A_SWAP	0x01		/* swapped home/care-of on packet */
260 #define IP6A_HASEEN	0x02		/* HA was present */
261 #define IP6A_BRUID	0x04		/* BR Unique Identifier was present */
262 #define IP6A_RTALERTSEEN 0x08		/* rtalert present */
263 
264 	/* ip6.ip6_src */
265 	struct in6_addr ip6a_careof;	/* care-of address of the peer */
266 	struct in6_addr ip6a_home;	/* home address of the peer */
267 	u_int16_t	ip6a_bruid;	/* BR unique identifier */
268 
269 	/* ip6.ip6_dst */
270 	struct in6_ifaddr *ip6a_dstia6;	/* my ifaddr that matches ip6_dst */
271 
272 	/* rtalert */
273 	u_int16_t ip6a_rtalert;		/* rtalert option value */
274 
275 	/*
276 	 * decapsulation history will be here.
277 	 * with IPsec it may not be accurate.
278 	 */
279 };
280 #endif
281 
282 #ifdef _KERNEL
283 /* flags passed to ip6_output as last parameter */
284 #define	IPV6_UNSPECSRC		0x01	/* allow :: as the source address */
285 #define	IPV6_FORWARDING		0x02	/* most of IPv6 header exists */
286 #define	IPV6_MINMTU		0x04	/* use minimum MTU (IPV6_USE_MIN_MTU) */
287 
288 #ifdef __NO_STRICT_ALIGNMENT
289 #define IP6_HDR_ALIGNED_P(ip)	1
290 #else
291 #define IP6_HDR_ALIGNED_P(ip)	((((intptr_t) (ip)) & 3) == 0)
292 #endif
293 
294 VNET_DECLARE(struct ip6stat, ip6stat);	/* statistics */
295 VNET_DECLARE(int, ip6_defhlim);		/* default hop limit */
296 VNET_DECLARE(int, ip6_defmcasthlim);	/* default multicast hop limit */
297 VNET_DECLARE(int, ip6_forwarding);	/* act as router? */
298 VNET_DECLARE(int, ip6_gif_hlim);	/* Hop limit for gif encap packet */
299 VNET_DECLARE(int, ip6_use_deprecated);	/* allow deprecated addr as source */
300 VNET_DECLARE(int, ip6_rr_prune);	/* router renumbering prefix
301 					 * walk list every 5 sec.    */
302 VNET_DECLARE(int, ip6_mcast_pmtu);	/* enable pMTU discovery for multicast? */
303 VNET_DECLARE(int, ip6_v6only);
304 VNET_DECLARE(struct socket *, ip6_mrouter);	/* multicast routing daemon */
305 VNET_DECLARE(int, ip6_sendredirects);	/* send IP redirects when forwarding? */
306 VNET_DECLARE(int, ip6_maxfragpackets);	/* Maximum packets in reassembly
307 					 * queue */
308 VNET_DECLARE(int, ip6_maxfrags);	/* Maximum fragments in reassembly
309 					 * queue */
310 VNET_DECLARE(int, ip6_accept_rtadv);	/* Acts as a host not a router */
311 VNET_DECLARE(int, ip6_keepfaith);	/* Firewall Aided Internet Translator */
312 VNET_DECLARE(int, ip6_log_interval);
313 VNET_DECLARE(time_t, ip6_log_time);
314 VNET_DECLARE(int, ip6_hdrnestlimit);	/* upper limit of # of extension
315 					 * headers */
316 VNET_DECLARE(int, ip6_dad_count);	/* DupAddrDetectionTransmits */
317 
318 VNET_DECLARE(int, ip6_auto_flowlabel);
319 VNET_DECLARE(int, ip6_auto_linklocal);
320 
321 VNET_DECLARE(int, ip6_use_tempaddr);	/* Whether to use temporary addresses */
322 VNET_DECLARE(int, ip6_prefer_tempaddr);	/* Whether to prefer temporary
323 					 * addresses in the source address
324 					 * selection */
325 
326 #ifdef IPSTEALTH
327 VNET_DECLARE(int, ip6stealth);
328 #endif
329 
330 VNET_DECLARE(int, ip6_use_defzone);	/* Whether to use the default scope
331 					 * zone when unspecified */
332 
333 #define	V_ip6stat			VNET(ip6stat)
334 #define	V_ip6_defhlim			VNET(ip6_defhlim)
335 #define	V_ip6_defmcasthlim		VNET(ip6_defmcasthlim)
336 #define	V_ip6_forwarding		VNET(ip6_forwarding)
337 #define	V_ip6_gif_hlim			VNET(ip6_gif_hlim)
338 #define	V_ip6_use_deprecated		VNET(ip6_use_deprecated)
339 #define	V_ip6_rr_prune			VNET(ip6_rr_prune)
340 #define	V_ip6_mcast_pmtu		VNET(ip6_mcast_pmtu)
341 #define	V_ip6_v6only			VNET(ip6_v6only)
342 #define	V_ip6_mrouter			VNET(ip6_mrouter)
343 #define	V_ip6_sendredirects		VNET(ip6_sendredirects)
344 #define	V_ip6_maxfragpackets		VNET(ip6_maxfragpackets)
345 #define	V_ip6_maxfrags			VNET(ip6_maxfrags)
346 #define	V_ip6_accept_rtadv		VNET(ip6_accept_rtadv)
347 #define	V_ip6_keepfaith			VNET(ip6_keepfaith)
348 #define	V_ip6_log_interval		VNET(ip6_log_interval)
349 #define	V_ip6_log_time			VNET(ip6_log_time)
350 #define	V_ip6_hdrnestlimit		VNET(ip6_hdrnestlimit)
351 #define	V_ip6_dad_count			VNET(ip6_dad_count)
352 #define	V_ip6_auto_flowlabel		VNET(ip6_auto_flowlabel)
353 #define	V_ip6_auto_linklocal		VNET(ip6_auto_linklocal)
354 #define	V_ip6_use_tempaddr		VNET(ip6_use_tempaddr)
355 #define	V_ip6_prefer_tempaddr		VNET(ip6_prefer_tempaddr)
356 #ifdef IPSTEALTH
357 #define	V_ip6stealth			VNET(ip6stealth)
358 #endif
359 #define	V_ip6_use_defzone		VNET(ip6_use_defzone)
360 
361 extern	struct pfil_head inet6_pfil_hook;	/* packet filter hooks */
362 
363 extern struct	pr_usrreqs rip6_usrreqs;
364 struct sockopt;
365 
366 struct inpcb;
367 
368 int	icmp6_ctloutput __P((struct socket *, struct sockopt *sopt));
369 
370 struct in6_ifaddr;
371 void	ip6_init __P((void));
372 #ifdef VIMAGE
373 void	ip6_destroy __P((void));
374 #endif
375 void	ip6_input __P((struct mbuf *));
376 struct in6_ifaddr *ip6_getdstifaddr __P((struct mbuf *));
377 void	ip6_freepcbopts __P((struct ip6_pktopts *));
378 
379 int	ip6_unknown_opt __P((u_int8_t *, struct mbuf *, int));
380 char *	ip6_get_prevhdr __P((struct mbuf *, int));
381 int	ip6_nexthdr __P((struct mbuf *, int, int, int *));
382 int	ip6_lasthdr __P((struct mbuf *, int, int, int *));
383 
384 struct ip6aux *ip6_addaux __P((struct mbuf *));
385 struct ip6aux *ip6_findaux __P((struct mbuf *));
386 void	ip6_delaux __P((struct mbuf *));
387 
388 extern int	(*ip6_mforward)(struct ip6_hdr *, struct ifnet *,
389     struct mbuf *);
390 
391 int	ip6_process_hopopts __P((struct mbuf *, u_int8_t *, int, u_int32_t *,
392 				 u_int32_t *));
393 struct mbuf	**ip6_savecontrol_v4(struct inpcb *, struct mbuf *,
394 	    struct mbuf **, int *);
395 void	ip6_savecontrol __P((struct inpcb *, struct mbuf *, struct mbuf **));
396 void	ip6_notify_pmtu __P((struct inpcb *, struct sockaddr_in6 *,
397 			     u_int32_t *));
398 int	ip6_sysctl __P((int *, u_int, void *, size_t *, void *, size_t));
399 
400 void	ip6_forward __P((struct mbuf *, int));
401 
402 void	ip6_mloopback __P((struct ifnet *, struct mbuf *, struct sockaddr_in6 *));
403 int	ip6_output __P((struct mbuf *, struct ip6_pktopts *,
404 			struct route_in6 *,
405 			int,
406 			struct ip6_moptions *, struct ifnet **,
407 			struct inpcb *));
408 int	ip6_ctloutput __P((struct socket *, struct sockopt *));
409 int	ip6_raw_ctloutput __P((struct socket *, struct sockopt *));
410 void	ip6_initpktopts __P((struct ip6_pktopts *));
411 int	ip6_setpktopts __P((struct mbuf *, struct ip6_pktopts *,
412 	struct ip6_pktopts *, struct ucred *, int));
413 void	ip6_clearpktopts __P((struct ip6_pktopts *, int));
414 struct ip6_pktopts *ip6_copypktopts __P((struct ip6_pktopts *, int));
415 int	ip6_optlen __P((struct inpcb *));
416 
417 int	route6_input __P((struct mbuf **, int *, int));
418 
419 void	frag6_init __P((void));
420 int	frag6_input __P((struct mbuf **, int *, int));
421 void	frag6_slowtimo __P((void));
422 void	frag6_drain __P((void));
423 
424 void	rip6_init __P((void));
425 int	rip6_input __P((struct mbuf **, int *, int));
426 void	rip6_ctlinput __P((int, struct sockaddr *, void *));
427 int	rip6_ctloutput __P((struct socket *, struct sockopt *));
428 int	rip6_output __P((struct mbuf *, ...));
429 int	rip6_usrreq __P((struct socket *,
430 	    int, struct mbuf *, struct mbuf *, struct mbuf *, struct thread *));
431 
432 int	dest6_input __P((struct mbuf **, int *, int));
433 int	none_input __P((struct mbuf **, int *, int));
434 
435 int	in6_selectsrc(struct sockaddr_in6 *, struct ip6_pktopts *,
436 	struct inpcb *inp, struct route_in6 *, struct ucred *cred,
437 	struct ifnet **, struct in6_addr *);
438 int in6_selectroute __P((struct sockaddr_in6 *, struct ip6_pktopts *,
439 	struct ip6_moptions *, struct route_in6 *, struct ifnet **,
440 	struct rtentry **));
441 u_int32_t ip6_randomid __P((void));
442 u_int32_t ip6_randomflowlabel __P((void));
443 #endif /* _KERNEL */
444 
445 #endif /* !_NETINET6_IP6_VAR_H_ */
446