Change comment to reflect that X11BASE moved.
[dragonfly.git] / sys / netinet6 / ip6_var.h
blobbd9f9dd5c05edbe46cf29e888ceb708fd0412aba
1 /* $FreeBSD: src/sys/netinet6/ip6_var.h,v 1.2.2.4 2003/01/23 21:06:47 sam Exp $ */
2 /* $DragonFly: src/sys/netinet6/ip6_var.h,v 1.12 2007/05/07 12:40:30 hasso Exp $ */
3 /* $KAME: ip6_var.h,v 1.62 2001/05/03 14:51:48 itojun Exp $ */
5 /*
6 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
7 * All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the project nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
35 * Copyright (c) 1982, 1986, 1993
36 * The Regents of the University of California. All rights reserved.
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. All advertising materials mentioning features or use of this software
47 * must display the following acknowledgement:
48 * This product includes software developed by the University of
49 * California, Berkeley and its contributors.
50 * 4. Neither the name of the University nor the names of its contributors
51 * may be used to endorse or promote products derived from this software
52 * without specific prior written permission.
54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64 * SUCH DAMAGE.
66 * @(#)ip_var.h 8.1 (Berkeley) 6/10/93
69 #ifndef _NETINET6_IP6_VAR_H_
70 #define _NETINET6_IP6_VAR_H_
72 #ifndef _SYS_TYPES_H_
73 #include <sys/types.h>
74 #endif
75 #ifndef _SYS_QUEUE_H_
76 #include <sys/queue.h>
77 #endif
78 #ifndef _NETINET_IN_H_
79 #include <netinet/in.h>
80 #endif
83 * IP6 reassembly queue structure. Each fragment
84 * being reassembled is attached to one of these structures.
86 struct ip6q {
87 u_int32_t ip6q_head;
88 u_int16_t ip6q_len;
89 u_int8_t ip6q_nxt; /* ip6f_nxt in first fragment */
90 u_int8_t ip6q_hlim;
91 struct ip6asfrag *ip6q_down;
92 struct ip6asfrag *ip6q_up;
93 u_int32_t ip6q_ident;
94 u_int8_t ip6q_arrive;
95 u_int8_t ip6q_ttl;
96 struct in6_addr ip6q_src, ip6q_dst;
97 struct ip6q *ip6q_next;
98 struct ip6q *ip6q_prev;
99 int ip6q_unfrglen; /* len of unfragmentable part */
100 #ifdef notyet
101 u_char *ip6q_nxtp;
102 #endif
105 struct ip6asfrag {
106 u_int32_t ip6af_head;
107 u_int16_t ip6af_len;
108 u_int8_t ip6af_nxt;
109 u_int8_t ip6af_hlim;
110 /* must not override the above members during reassembling */
111 struct ip6asfrag *ip6af_down;
112 struct ip6asfrag *ip6af_up;
113 struct mbuf *ip6af_m;
114 int ip6af_offset; /* offset in ip6af_m to next header */
115 int ip6af_frglen; /* fragmentable part length */
116 int ip6af_off; /* fragment offset */
117 u_int16_t ip6af_mff; /* more fragment bit in frag off */
120 #define IP6_REASS_MBUF(ip6af) (*(struct mbuf **)&((ip6af)->ip6af_m))
122 struct ip6_moptions {
123 struct ifnet *im6o_multicast_ifp; /* ifp for outgoing multicasts */
124 u_char im6o_multicast_hlim; /* hoplimit for outgoing multicasts */
125 u_char im6o_multicast_loop; /* 1 >= hear sends if a member */
126 LIST_HEAD(, in6_multi_mship) im6o_memberships;
130 * Control options for outgoing packets
133 /* Routing header related info */
134 struct ip6po_rhinfo {
135 struct ip6_rthdr *ip6po_rhi_rthdr; /* Routing header */
136 struct route_in6 ip6po_rhi_route; /* Route to the 1st hop */
138 #define ip6po_rthdr ip6po_rhinfo.ip6po_rhi_rthdr
139 #define ip6po_route ip6po_rhinfo.ip6po_rhi_route
141 struct ip6_pktopts {
142 struct mbuf *ip6po_m; /* Pointer to mbuf storing the data */
143 int ip6po_hlim; /* Hoplimit for outgoing packets */
145 /* Outgoing IF/address information */
146 struct in6_pktinfo *ip6po_pktinfo;
148 struct sockaddr *ip6po_nexthop; /* Next-hop address */
150 struct ip6_hbh *ip6po_hbh; /* Hop-by-Hop options header */
152 /* Destination options header (before a routing header) */
153 struct ip6_dest *ip6po_dest1;
155 /* Routing header related info. */
156 struct ip6po_rhinfo ip6po_rhinfo;
158 /* Destination options header (after a routing header) */
159 struct ip6_dest *ip6po_dest2;
163 * Control options for incoming packets
166 struct ip6stat {
167 u_quad_t ip6s_total; /* total packets received */
168 u_quad_t ip6s_tooshort; /* packet too short */
169 u_quad_t ip6s_toosmall; /* not enough data */
170 u_quad_t ip6s_fragments; /* fragments received */
171 u_quad_t ip6s_fragdropped; /* frags dropped(dups, out of space) */
172 u_quad_t ip6s_fragtimeout; /* fragments timed out */
173 u_quad_t ip6s_fragoverflow; /* fragments that exceeded limit */
174 u_quad_t ip6s_forward; /* packets forwarded */
175 u_quad_t ip6s_cantforward; /* packets rcvd for unreachable dest */
176 u_quad_t ip6s_redirectsent; /* packets forwarded on same net */
177 u_quad_t ip6s_delivered; /* datagrams delivered to upper level*/
178 u_quad_t ip6s_localout; /* total ip packets generated here */
179 u_quad_t ip6s_odropped; /* lost packets due to nobufs, etc. */
180 u_quad_t ip6s_reassembled; /* total packets reassembled ok */
181 u_quad_t ip6s_fragmented; /* datagrams successfully fragmented */
182 u_quad_t ip6s_ofragments; /* output fragments created */
183 u_quad_t ip6s_cantfrag; /* don't fragment flag was set, etc. */
184 u_quad_t ip6s_badoptions; /* error in option processing */
185 u_quad_t ip6s_noroute; /* packets discarded due to no route */
186 u_quad_t ip6s_badvers; /* ip6 version != 6 */
187 u_quad_t ip6s_rawout; /* total raw ip packets generated */
188 u_quad_t ip6s_badscope; /* scope error */
189 u_quad_t ip6s_notmember; /* don't join this multicast group */
190 u_quad_t ip6s_nxthist[256]; /* next header history */
191 u_quad_t ip6s_m1; /* one mbuf */
192 u_quad_t ip6s_m2m[32]; /* two or more mbuf */
193 u_quad_t ip6s_mext1; /* one ext mbuf */
194 u_quad_t ip6s_mext2m; /* two or more ext mbuf */
195 u_quad_t ip6s_exthdrtoolong; /* ext hdr are not continuous */
196 u_quad_t ip6s_nogif; /* no match gif found */
197 u_quad_t ip6s_toomanyhdr; /* discarded due to too many headers */
200 * statistics for improvement of the source address selection
201 * algorithm:
202 * XXX: hardcoded 16 = # of ip6 multicast scope types + 1
204 /* number of times that address selection fails */
205 u_quad_t ip6s_sources_none;
206 /* number of times that an address on the outgoing I/F is chosen */
207 u_quad_t ip6s_sources_sameif[16];
208 /* number of times that an address on a non-outgoing I/F is chosen */
209 u_quad_t ip6s_sources_otherif[16];
211 * number of times that an address that has the same scope
212 * from the destination is chosen.
214 u_quad_t ip6s_sources_samescope[16];
216 * number of times that an address that has a different scope
217 * from the destination is chosen.
219 u_quad_t ip6s_sources_otherscope[16];
220 /* number of times that an deprecated address is chosen */
221 u_quad_t ip6s_sources_deprecated[16];
223 u_quad_t ip6s_forward_cachehit;
224 u_quad_t ip6s_forward_cachemiss;
227 #ifdef _KERNEL
229 * IPv6 onion peeling state.
230 * it will be initialized when we come into ip6_input().
231 * XXX do not make it a kitchen sink!
233 struct ip6aux {
234 u_int32_t ip6a_flags;
235 #define IP6A_SWAP 0x01 /* swapped home/care-of on packet */
236 #define IP6A_HASEEN 0x02 /* HA was present */
237 #define IP6A_BRUID 0x04 /* BR Unique Identifier was present */
238 #define IP6A_RTALERTSEEN 0x08 /* rtalert present */
240 /* ip6.ip6_src */
241 struct in6_addr ip6a_careof; /* care-of address of the peer */
242 struct in6_addr ip6a_home; /* home address of the peer */
243 u_int16_t ip6a_bruid; /* BR unique identifier */
245 /* ip6.ip6_dst */
246 struct in6_ifaddr *ip6a_dstia6; /* my ifaddr that matches ip6_dst */
248 /* rtalert */
249 u_int16_t ip6a_rtalert; /* rtalert option value */
252 * decapsulation history will be here.
253 * with IPsec it may not be accurate.
256 #endif
258 #ifdef _KERNEL
259 /* flags passed to ip6_output as last parameter */
260 #define IPV6_DADOUTPUT 0x01 /* DAD */
261 #define IPV6_FORWARDING 0x02 /* most of IPv6 header exists */
262 #define IPV6_MINMTU 0x04 /* use minimum MTU (IPV6_USE_MIN_MTU) */
264 extern struct ip6stat ip6stat; /* statistics */
265 extern u_int32_t ip6_id; /* fragment identifier */
266 extern int ip6_defhlim; /* default hop limit */
267 extern int ip6_defmcasthlim; /* default multicast hop limit */
268 extern int ip6_forwarding; /* act as router? */
269 extern int ip6_forward_srcrt; /* forward src-routed? */
270 extern int ip6_gif_hlim; /* Hop limit for gif encap packet */
271 extern int ip6_use_deprecated; /* allow deprecated addr as source */
272 extern int ip6_rr_prune; /* router renumbering prefix
273 * walk list every 5 sec. */
274 extern int ip6_v6only;
276 extern struct socket *ip6_mrouter; /* multicast routing daemon */
277 extern int ip6_sendredirects; /* send IP redirects when forwarding? */
278 extern int ip6_maxfragpackets; /* Maximum packets in reassembly queue */
279 extern int ip6_sourcecheck; /* Verify source interface */
280 extern int ip6_sourcecheck_interval; /* Interval between log messages */
281 extern int ip6_accept_rtadv; /* Acts as a host not a router */
282 extern int ip6_keepfaith; /* Firewall Aided Internet Translator */
283 extern int ip6_log_interval;
284 extern time_t ip6_log_time;
285 extern int ip6_hdrnestlimit; /* upper limit of # of extension headers */
286 extern int ip6_dad_count; /* DupAddrDetectionTransmits */
288 extern u_int32_t ip6_flow_seq;
289 extern int ip6_auto_flowlabel;
290 extern int ip6_auto_linklocal;
292 extern int ip6_anonportmin; /* minimum ephemeral port */
293 extern int ip6_anonportmax; /* maximum ephemeral port */
294 extern int ip6_lowportmin; /* minimum reserved port */
295 extern int ip6_lowportmax; /* maximum reserved port */
297 extern int ip6_use_tempaddr; /* whether to use temporary addresses. */
299 extern struct pfil_head inet6_pfil_hook;
301 extern struct pr_usrreqs rip6_usrreqs;
303 struct proc;
304 struct inpcb;
305 struct sockopt;
306 struct in6_ifaddr;
307 struct ip6_hdr;
308 struct netmsg;
310 int icmp6_ctloutput (struct socket *, struct sockopt *sopt);
312 void ip6_init (void);
313 void ip6intr (void);
314 struct in6_ifaddr *ip6_getdstifaddr (struct mbuf *);
315 void ip6_freepcbopts (struct ip6_pktopts *);
316 void ip6_freemoptions (struct ip6_moptions *);
317 int ip6_unknown_opt (u_int8_t *, struct mbuf *, int);
318 char * ip6_get_prevhdr (struct mbuf *, int);
319 int ip6_nexthdr (struct mbuf *, int, int, int *);
320 int ip6_lasthdr (struct mbuf *, int, int, int *);
322 struct ip6aux *ip6_addaux (struct mbuf *);
323 struct ip6aux *ip6_findaux (struct mbuf *);
324 void ip6_delaux (struct mbuf *);
326 int ip6_mforward (struct ip6_hdr *, struct ifnet *, struct mbuf *);
327 int ip6_process_hopopts (struct mbuf *, u_int8_t *, int, u_int32_t *,
328 u_int32_t *);
329 void ip6_savecontrol (struct inpcb *, struct mbuf **, struct ip6_hdr *,
330 struct mbuf *);
331 void ip6_notify_pmtu (struct inpcb *, struct sockaddr_in6 *,
332 u_int32_t *);
333 int ip6_sysctl (int *, u_int, void *, size_t *, void *, size_t);
335 void ip6_forward (struct mbuf *, int);
337 void ip6_mloopback (struct ifnet *, struct mbuf *, struct sockaddr_in6 *);
338 int ip6_output (struct mbuf *, struct ip6_pktopts *,
339 struct route_in6 *,
340 int,
341 struct ip6_moptions *, struct ifnet **,
342 struct inpcb *);
343 int ip6_ctloutput (struct socket *, struct sockopt *sopt);
344 void init_ip6pktopts (struct ip6_pktopts *);
345 int ip6_setpktoptions (struct mbuf *, struct ip6_pktopts *, int, int);
346 void ip6_clearpktopts (struct ip6_pktopts *, int, int);
347 struct ip6_pktopts *ip6_copypktopts (struct ip6_pktopts *, int);
348 int ip6_optlen (struct inpcb *);
350 int route6_input (struct mbuf **, int *, int);
352 void frag6_init (void);
353 int frag6_input (struct mbuf **, int *, int);
354 void frag6_slowtimo (void);
355 void frag6_drain (void);
357 void rip6_init (void);
358 int rip6_input (struct mbuf **mp, int *offp, int proto);
359 void rip6_ctlinput (int, struct sockaddr *, void *);
360 int rip6_ctloutput (struct socket *so, struct sockopt *sopt);
361 int rip6_output (struct mbuf *, struct socket *, ...);
362 int rip6_usrreq (struct socket *,
363 int, struct mbuf *, struct mbuf *, struct mbuf *, struct proc *);
365 int dest6_input (struct mbuf **, int *, int);
366 int none_input (struct mbuf **, int *, int);
367 #endif /* _KERNEL */
369 #endif /* !_NETINET6_IP6_VAR_H_ */