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