xref: /freebsd/sys/netinet6/ip6_var.h (revision 52ec752989b2e6d4e9a59a8ff25d8ff596d85e62)
1 /*	$FreeBSD$	*/
2 /*	$KAME: ip6_var.h,v 1.62 2001/05/03 14:51:48 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) 1982, 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. All advertising materials mentioning features or use of this software
46  *    must display the following acknowledgement:
47  *	This product includes software developed by the University of
48  *	California, Berkeley and its contributors.
49  * 4. Neither the name of the University nor the names of its contributors
50  *    may be used to endorse or promote products derived from this software
51  *    without specific prior written permission.
52  *
53  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
54  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
55  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
56  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
57  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
58  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
59  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
61  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
62  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63  * SUCH DAMAGE.
64  *
65  *	@(#)ip_var.h	8.1 (Berkeley) 6/10/93
66  */
67 
68 #ifndef _NETINET6_IP6_VAR_H_
69 #define _NETINET6_IP6_VAR_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 	u_int32_t	ip6q_head;
77 	u_int16_t	ip6q_len;
78 	u_int8_t	ip6q_nxt;	/* ip6f_nxt in first fragment */
79 	u_int8_t	ip6q_hlim;
80 	struct ip6asfrag *ip6q_down;
81 	struct ip6asfrag *ip6q_up;
82 	u_int32_t	ip6q_ident;
83 	u_int8_t	ip6q_arrive;
84 	u_int8_t	ip6q_ttl;
85 	struct in6_addr	ip6q_src, ip6q_dst;
86 	struct ip6q	*ip6q_next;
87 	struct ip6q	*ip6q_prev;
88 	int		ip6q_unfrglen;	/* len of unfragmentable part */
89 #ifdef notyet
90 	u_char		*ip6q_nxtp;
91 #endif
92 	int		ip6q_nfrag;	/* # of fragments */
93 };
94 
95 struct	ip6asfrag {
96 	u_int32_t	ip6af_head;
97 	u_int16_t	ip6af_len;
98 	u_int8_t	ip6af_nxt;
99 	u_int8_t	ip6af_hlim;
100 	/* must not override the above members during reassembling */
101 	struct ip6asfrag *ip6af_down;
102 	struct ip6asfrag *ip6af_up;
103 	struct mbuf	*ip6af_m;
104 	int		ip6af_offset;	/* offset in ip6af_m to next header */
105 	int		ip6af_frglen;	/* fragmentable part length */
106 	int		ip6af_off;	/* fragment offset */
107 	u_int16_t	ip6af_mff;	/* more fragment bit in frag off */
108 };
109 
110 #define IP6_REASS_MBUF(ip6af) (*(struct mbuf **)&((ip6af)->ip6af_m))
111 
112 struct	ip6_moptions {
113 	struct	ifnet *im6o_multicast_ifp; /* ifp for outgoing multicasts */
114 	u_char	im6o_multicast_hlim;	/* hoplimit for outgoing multicasts */
115 	u_char	im6o_multicast_loop;	/* 1 >= hear sends if a member */
116 	LIST_HEAD(, in6_multi_mship) im6o_memberships;
117 };
118 
119 /*
120  * Control options for outgoing packets
121  */
122 
123 /* Routing header related info */
124 struct	ip6po_rhinfo {
125 	struct	ip6_rthdr *ip6po_rhi_rthdr; /* Routing header */
126 	struct	route_in6 ip6po_rhi_route; /* Route to the 1st hop */
127 };
128 #define ip6po_rthdr	ip6po_rhinfo.ip6po_rhi_rthdr
129 #define ip6po_route	ip6po_rhinfo.ip6po_rhi_route
130 
131 /* Nexthop related info */
132 struct	ip6po_nhinfo {
133 	struct	sockaddr *ip6po_nhi_nexthop;
134 	struct	route_in6 ip6po_nhi_route; /* Route to the nexthop */
135 };
136 #define ip6po_nexthop	ip6po_nhinfo.ip6po_nhi_nexthop
137 #define ip6po_nextroute	ip6po_nhinfo.ip6po_nhi_route
138 
139 struct	ip6_pktopts {
140 	struct	mbuf *ip6po_m;	/* Pointer to mbuf storing the data */
141 	int	ip6po_hlim;	/* Hoplimit for outgoing packets */
142 
143 	/* Outgoing IF/address information */
144 	struct	in6_pktinfo *ip6po_pktinfo;
145 
146 	/* Next-hop address information */
147 	struct	ip6po_nhinfo ip6po_nhinfo;
148 
149 	struct	ip6_hbh *ip6po_hbh; /* Hop-by-Hop options header */
150 
151 	/* Destination options header (before a routing header) */
152 	struct	ip6_dest *ip6po_dest1;
153 
154 	/* Routing header related info. */
155 	struct	ip6po_rhinfo ip6po_rhinfo;
156 
157 	/* Destination options header (after a routing header) */
158 	struct	ip6_dest *ip6po_dest2;
159 
160 	int	ip6po_tclass;	/* traffic class */
161 
162 	int	ip6po_minmtu;  /* fragment vs PMTU discovery policy */
163 #define IP6PO_MINMTU_MCASTONLY	-1 /* default; send at min MTU for multicast*/
164 #define IP6PO_MINMTU_DISABLE	 0 /* always perform pmtu disc */
165 #define IP6PO_MINMTU_ALL	 1 /* always send at min MTU */
166 
167 	int	ip6po_prefer_tempaddr;  /* whether temporary addresses are
168 					   preferred as source address */
169 #define IP6PO_TEMPADDR_SYSTEM	-1 /* follow the system default */
170 #define IP6PO_TEMPADDR_NOTPREFER 0 /* not prefer temporary address */
171 #define IP6PO_TEMPADDR_PREFER	 1 /* prefer temporary address */
172 
173 	int ip6po_flags;
174 #if 0	/* parameters in this block is obsolete. do not reuse the values. */
175 #define IP6PO_REACHCONF	0x01	/* upper-layer reachability confirmation. */
176 #define IP6PO_MINMTU	0x02	/* use minimum MTU (IPV6_USE_MIN_MTU) */
177 #endif
178 #define IP6PO_DONTFRAG	0x04	/* disable fragmentation (IPV6_DONTFRAG) */
179 #define IP6PO_USECOA	0x08	/* use care of address */
180 
181 	int	needfree;	/* members dynamically allocated */
182 };
183 
184 /*
185  * Control options for incoming packets
186  */
187 
188 struct	ip6stat {
189 	u_quad_t ip6s_total;		/* total packets received */
190 	u_quad_t ip6s_tooshort;		/* packet too short */
191 	u_quad_t ip6s_toosmall;		/* not enough data */
192 	u_quad_t ip6s_fragments;	/* fragments received */
193 	u_quad_t ip6s_fragdropped;	/* frags dropped(dups, out of space) */
194 	u_quad_t ip6s_fragtimeout;	/* fragments timed out */
195 	u_quad_t ip6s_fragoverflow;	/* fragments that exceeded limit */
196 	u_quad_t ip6s_forward;		/* packets forwarded */
197 	u_quad_t ip6s_cantforward;	/* packets rcvd for unreachable dest */
198 	u_quad_t ip6s_redirectsent;	/* packets forwarded on same net */
199 	u_quad_t ip6s_delivered;	/* datagrams delivered to upper level*/
200 	u_quad_t ip6s_localout;		/* total ip packets generated here */
201 	u_quad_t ip6s_odropped;		/* lost packets due to nobufs, etc. */
202 	u_quad_t ip6s_reassembled;	/* total packets reassembled ok */
203 	u_quad_t ip6s_fragmented;	/* datagrams successfully fragmented */
204 	u_quad_t ip6s_ofragments;	/* output fragments created */
205 	u_quad_t ip6s_cantfrag;		/* don't fragment flag was set, etc. */
206 	u_quad_t ip6s_badoptions;	/* error in option processing */
207 	u_quad_t ip6s_noroute;		/* packets discarded due to no route */
208 	u_quad_t ip6s_badvers;		/* ip6 version != 6 */
209 	u_quad_t ip6s_rawout;		/* total raw ip packets generated */
210 	u_quad_t ip6s_badscope;		/* scope error */
211 	u_quad_t ip6s_notmember;	/* don't join this multicast group */
212 	u_quad_t ip6s_nxthist[256];	/* next header history */
213 	u_quad_t ip6s_m1;		/* one mbuf */
214 	u_quad_t ip6s_m2m[32];		/* two or more mbuf */
215 	u_quad_t ip6s_mext1;		/* one ext mbuf */
216 	u_quad_t ip6s_mext2m;		/* two or more ext mbuf */
217 	u_quad_t ip6s_exthdrtoolong;	/* ext hdr are not continuous */
218 	u_quad_t ip6s_nogif;		/* no match gif found */
219 	u_quad_t ip6s_toomanyhdr;	/* discarded due to too many headers */
220 
221 	/*
222 	 * statistics for improvement of the source address selection
223 	 * algorithm:
224 	 * XXX: hardcoded 16 = # of ip6 multicast scope types + 1
225 	 */
226 	/* number of times that address selection fails */
227 	u_quad_t ip6s_sources_none;
228 	/* number of times that an address on the outgoing I/F is chosen */
229 	u_quad_t ip6s_sources_sameif[16];
230 	/* number of times that an address on a non-outgoing I/F is chosen */
231 	u_quad_t ip6s_sources_otherif[16];
232 	/*
233 	 * number of times that an address that has the same scope
234 	 * from the destination is chosen.
235 	 */
236 	u_quad_t ip6s_sources_samescope[16];
237 	/*
238 	 * number of times that an address that has a different scope
239 	 * from the destination is chosen.
240 	 */
241 	u_quad_t ip6s_sources_otherscope[16];
242 	/* number of times that a deprecated address is chosen */
243 	u_quad_t ip6s_sources_deprecated[16];
244 
245 	u_quad_t ip6s_forward_cachehit;
246 	u_quad_t ip6s_forward_cachemiss;
247 
248 	/* number of times that each rule of source selection is applied. */
249 	u_quad_t ip6s_sources_rule[16];
250 };
251 
252 #ifdef _KERNEL
253 /*
254  * IPv6 onion peeling state.
255  * it will be initialized when we come into ip6_input().
256  * XXX do not make it a kitchen sink!
257  */
258 struct ip6aux {
259 	u_int32_t ip6a_flags;
260 #define IP6A_SWAP	0x01		/* swapped home/care-of on packet */
261 #define IP6A_HASEEN	0x02		/* HA was present */
262 #define IP6A_BRUID	0x04		/* BR Unique Identifier was present */
263 #define IP6A_RTALERTSEEN 0x08		/* rtalert present */
264 
265 	/* ip6.ip6_src */
266 	struct in6_addr ip6a_careof;	/* care-of address of the peer */
267 	struct in6_addr ip6a_home;	/* home address of the peer */
268 	u_int16_t	ip6a_bruid;	/* BR unique identifier */
269 
270 	/* ip6.ip6_dst */
271 	struct in6_ifaddr *ip6a_dstia6;	/* my ifaddr that matches ip6_dst */
272 
273 	/* rtalert */
274 	u_int16_t ip6a_rtalert;		/* rtalert option value */
275 
276 	/*
277 	 * decapsulation history will be here.
278 	 * with IPsec it may not be accurate.
279 	 */
280 };
281 #endif
282 
283 #ifdef _KERNEL
284 /* flags passed to ip6_output as last parameter */
285 #define	IPV6_DADOUTPUT		0x01	/* DAD */
286 #define	IPV6_FORWARDING		0x02	/* most of IPv6 header exists */
287 #define	IPV6_MINMTU		0x04	/* use minimum MTU (IPV6_USE_MIN_MTU) */
288 
289 extern struct	ip6stat ip6stat;	/* statistics */
290 #ifndef RANDOM_IP_ID
291 extern u_int32_t ip6_id;		/* fragment identifier */
292 #endif
293 extern int	ip6_defhlim;		/* default hop limit */
294 extern int	ip6_defmcasthlim;	/* default multicast hop limit */
295 extern int	ip6_forwarding;		/* act as router? */
296 extern int	ip6_forward_srcrt;	/* forward src-routed? */
297 extern int	ip6_gif_hlim;		/* Hop limit for gif encap packet */
298 extern int	ip6_use_deprecated;	/* allow deprecated addr as source */
299 extern int	ip6_rr_prune;		/* router renumbering prefix
300 					 * walk list every 5 sec.    */
301 extern int	ip6_v6only;
302 
303 extern struct socket *ip6_mrouter; 	/* multicast routing daemon */
304 extern int	ip6_sendredirects;	/* send IP redirects when forwarding? */
305 extern int	ip6_maxfragpackets; /* Maximum packets in reassembly queue */
306 extern int	ip6_maxfrags;	/* Maximum fragments in reassembly queue */
307 extern int	ip6_sourcecheck;	/* Verify source interface */
308 extern int	ip6_sourcecheck_interval; /* Interval between log messages */
309 extern int	ip6_accept_rtadv;	/* Acts as a host not a router */
310 extern int	ip6_keepfaith;		/* Firewall Aided Internet Translator */
311 extern int	ip6_log_interval;
312 extern time_t	ip6_log_time;
313 extern int	ip6_hdrnestlimit; /* upper limit of # of extension headers */
314 extern int	ip6_dad_count;		/* DupAddrDetectionTransmits */
315 
316 #ifndef RANDOM_IP_ID
317 extern u_int32_t ip6_flow_seq;
318 #endif
319 extern int ip6_auto_flowlabel;
320 extern int ip6_auto_linklocal;
321 
322 extern int   ip6_anonportmin;		/* minimum ephemeral port */
323 extern int   ip6_anonportmax;		/* maximum ephemeral port */
324 extern int   ip6_lowportmin;		/* minimum reserved port */
325 extern int   ip6_lowportmax;		/* maximum reserved port */
326 
327 extern int	ip6_use_tempaddr; /* whether to use temporary addresses. */
328 extern int	ip6_prefer_tempaddr; /* whether to prefer temporary addresses
329 					in the source address selection */
330 
331 #ifdef PFIL_HOOKS
332 extern	struct pfil_head inet6_pfil_hook;
333 #endif
334 
335 extern struct	pr_usrreqs rip6_usrreqs;
336 struct sockopt;
337 
338 struct inpcb;
339 
340 int	icmp6_ctloutput __P((struct socket *, struct sockopt *sopt));
341 
342 struct in6_ifaddr;
343 void	ip6_init __P((void));
344 void	ip6_input __P((struct mbuf *));
345 struct in6_ifaddr *ip6_getdstifaddr __P((struct mbuf *));
346 void	ip6_freepcbopts __P((struct ip6_pktopts *));
347 void	ip6_freemoptions __P((struct ip6_moptions *));
348 int	ip6_unknown_opt __P((u_int8_t *, struct mbuf *, int));
349 char *	ip6_get_prevhdr __P((struct mbuf *, int));
350 int	ip6_nexthdr __P((struct mbuf *, int, int, int *));
351 int	ip6_lasthdr __P((struct mbuf *, int, int, int *));
352 
353 struct ip6aux *ip6_addaux __P((struct mbuf *));
354 struct ip6aux *ip6_findaux __P((struct mbuf *));
355 void	ip6_delaux __P((struct mbuf *));
356 
357 int	ip6_mforward __P((struct ip6_hdr *, struct ifnet *, struct mbuf *));
358 int	ip6_process_hopopts __P((struct mbuf *, u_int8_t *, int, u_int32_t *,
359 				 u_int32_t *));
360 void	ip6_savecontrol __P((struct inpcb *, struct mbuf *, struct mbuf **));
361 void	ip6_notify_pmtu __P((struct inpcb *, struct sockaddr_in6 *,
362 			     u_int32_t *));
363 int	ip6_sysctl __P((int *, u_int, void *, size_t *, void *, size_t));
364 
365 void	ip6_forward __P((struct mbuf *, int));
366 
367 void	ip6_mloopback __P((struct ifnet *, struct mbuf *, struct sockaddr_in6 *));
368 int	ip6_output __P((struct mbuf *, struct ip6_pktopts *,
369 			struct route_in6 *,
370 			int,
371 			struct ip6_moptions *, struct ifnet **,
372 			struct inpcb *));
373 int	ip6_ctloutput __P((struct socket *, struct sockopt *));
374 int	ip6_raw_ctloutput __P((struct socket *, struct sockopt *));
375 void	init_ip6pktopts __P((struct ip6_pktopts *));
376 int	ip6_setpktoptions __P((struct mbuf *, struct ip6_pktopts *,
377 			       struct ip6_pktopts *, int, int, int));
378 void	ip6_clearpktopts __P((struct ip6_pktopts *, int));
379 struct ip6_pktopts *ip6_copypktopts __P((struct ip6_pktopts *, int));
380 int	ip6_optlen __P((struct inpcb *));
381 
382 int	route6_input __P((struct mbuf **, int *, int));
383 
384 void	frag6_init __P((void));
385 int	frag6_input __P((struct mbuf **, int *, int));
386 void	frag6_slowtimo __P((void));
387 void	frag6_drain __P((void));
388 
389 void	rip6_init __P((void));
390 int	rip6_input __P((struct mbuf **, int *, int));
391 void	rip6_ctlinput __P((int, struct sockaddr *, void *));
392 int	rip6_ctloutput __P((struct socket *, struct sockopt *));
393 int	rip6_output __P((struct mbuf *, ...));
394 int	rip6_usrreq __P((struct socket *,
395 	    int, struct mbuf *, struct mbuf *, struct mbuf *, struct thread *));
396 
397 int	dest6_input __P((struct mbuf **, int *, int));
398 int	none_input __P((struct mbuf **, int *, int));
399 
400 struct in6_addr *in6_selectsrc __P((struct sockaddr_in6 *,
401 	struct ip6_pktopts *, struct ip6_moptions *, struct route_in6 *,
402 	struct in6_addr *, int *));
403 int in6_selectroute __P((struct sockaddr_in6 *, struct ip6_pktopts *,
404 	struct ip6_moptions *, struct route_in6 *, struct ifnet **,
405 	struct rtentry **, int));
406 #ifdef RANDOM_IP_ID
407 u_int32_t ip6_randomid __P((void));
408 u_int32_t ip6_randomflowlabel __P((void));
409 #endif
410 #endif /* _KERNEL */
411 
412 #endif /* !_NETINET6_IP6_VAR_H_ */
413