f30f0ca6668a8e650adfdc9266c1ca22256c4c5d
[dragonfly.git] / sys / netinet6 / ip6_var.h
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.13 2008/09/04 09:08:22 hasso Exp $   */
3 /*      $KAME: ip6_var.h,v 1.62 2001/05/03 14:51:48 itojun Exp $        */
4
5 /*
6  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
7  * All rights reserved.
8  *
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.
20  *
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.
32  */
33
34 /*
35  * Copyright (c) 1982, 1986, 1993
36  *      The Regents of the University of California.  All rights reserved.
37  *
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.
53  *
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.
65  *
66  *      @(#)ip_var.h    8.1 (Berkeley) 6/10/93
67  */
68
69 #ifndef _NETINET6_IP6_VAR_H_
70 #define _NETINET6_IP6_VAR_H_
71
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
81
82 /*
83  * IP6 reassembly queue structure.  Each fragment
84  * being reassembled is attached to one of these structures.
85  */
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
103 };
104
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 */
118 };
119
120 #define IP6_REASS_MBUF(ip6af) (*(struct mbuf **)&((ip6af)->ip6af_m))
121
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;
127 };
128
129 /*
130  * Control options for outgoing packets
131  */
132
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 */
137 };
138 #define ip6po_rthdr     ip6po_rhinfo.ip6po_rhi_rthdr
139 #define ip6po_route     ip6po_rhinfo.ip6po_rhi_route
140
141 /* Nexthop related info */
142 struct  ip6po_nhinfo {
143         struct  sockaddr *ip6po_nhi_nexthop;
144         struct  route_in6 ip6po_nhi_route; /* Route to the nexthop */
145 };
146 #define ip6po_nexthop   ip6po_nhinfo.ip6po_nhi_nexthop
147 #define ip6po_nextroute ip6po_nhinfo.ip6po_nhi_route
148
149 struct  ip6_pktopts {
150         struct  mbuf *ip6po_m;  /* Pointer to mbuf storing the data */
151         int     ip6po_hlim;     /* Hoplimit for outgoing packets */
152
153         /* Outgoing IF/address information */
154         struct  in6_pktinfo *ip6po_pktinfo;
155
156         /* Next-hop address information */
157         struct  ip6po_nhinfo ip6po_nhinfo;
158         
159         struct  ip6_hbh *ip6po_hbh; /* Hop-by-Hop options header */
160
161         /* Destination options header (before a routing header) */
162         struct  ip6_dest *ip6po_dest1;
163
164         /* Routing header related info. */
165         struct  ip6po_rhinfo ip6po_rhinfo;
166
167         /* Destination options header (after a routing header) */
168         struct  ip6_dest *ip6po_dest2;
169         /*
170          * below fields are introduced in RFC3542
171          */
172         int     ip6po_tclass;   /* traffic class */
173         int     ip6po_minmtu;  /* fragment vs PMTU discovery policy */
174 #define IP6PO_MINMTU_MCASTONLY  -1 /* default; send at min MTU for multicast*/
175 #define IP6PO_MINMTU_DISABLE     0 /* always perform pmtu disc */
176 #define IP6PO_MINMTU_ALL         1 /* always send at min MTU */
177         int     ip6po_prefer_tempaddr;  /* whether temporary addresses are
178                                            preferred as source address */
179 #define IP6PO_TEMPADDR_SYSTEM   -1 /* follow the system default */
180 #define IP6PO_TEMPADDR_NOTPREFER 0 /* not prefer temporary address */
181 #define IP6PO_TEMPADDR_PREFER    1 /* prefer temporary address */
182
183         int ip6po_flags;
184 #if 0   /* Parameters in this block are obsolete. Do not reuse the values. */
185 #define IP6PO_REACHCONF 0x01    /* upper-layer reachability confirmation. */
186 #define IP6PO_MINMTU    0x02    /* use minimum MTU (IPV6_USE_MIN_MTU) */
187 #endif
188 #define IP6PO_DONTFRAG  0x04    /* disable fragmentation (IPV6_DONTFRAG) */
189 #define IP6PO_USECOA    0x08    /* use care of address */
190 };
191
192 /*
193  * Control options for incoming packets
194  */
195 struct  ip6stat {
196         u_quad_t ip6s_total;            /* total packets received */
197         u_quad_t ip6s_tooshort;         /* packet too short */
198         u_quad_t ip6s_toosmall;         /* not enough data */
199         u_quad_t ip6s_fragments;        /* fragments received */
200         u_quad_t ip6s_fragdropped;      /* frags dropped(dups, out of space) */
201         u_quad_t ip6s_fragtimeout;      /* fragments timed out */
202         u_quad_t ip6s_fragoverflow;     /* fragments that exceeded limit */
203         u_quad_t ip6s_forward;          /* packets forwarded */
204         u_quad_t ip6s_cantforward;      /* packets rcvd for unreachable dest */
205         u_quad_t ip6s_redirectsent;     /* packets forwarded on same net */
206         u_quad_t ip6s_delivered;        /* datagrams delivered to upper level*/
207         u_quad_t ip6s_localout;         /* total ip packets generated here */
208         u_quad_t ip6s_odropped;         /* lost packets due to nobufs, etc. */
209         u_quad_t ip6s_reassembled;      /* total packets reassembled ok */
210         u_quad_t ip6s_fragmented;       /* datagrams successfully fragmented */
211         u_quad_t ip6s_ofragments;       /* output fragments created */
212         u_quad_t ip6s_cantfrag;         /* don't fragment flag was set, etc. */
213         u_quad_t ip6s_badoptions;       /* error in option processing */
214         u_quad_t ip6s_noroute;          /* packets discarded due to no route */
215         u_quad_t ip6s_badvers;          /* ip6 version != 6 */
216         u_quad_t ip6s_rawout;           /* total raw ip packets generated */
217         u_quad_t ip6s_badscope;         /* scope error */
218         u_quad_t ip6s_notmember;        /* don't join this multicast group */
219         u_quad_t ip6s_nxthist[256];     /* next header history */
220         u_quad_t ip6s_m1;               /* one mbuf */
221         u_quad_t ip6s_m2m[32];          /* two or more mbuf */
222         u_quad_t ip6s_mext1;            /* one ext mbuf */
223         u_quad_t ip6s_mext2m;           /* two or more ext mbuf */
224         u_quad_t ip6s_exthdrtoolong;    /* ext hdr are not continuous */
225         u_quad_t ip6s_nogif;            /* no match gif found */
226         u_quad_t ip6s_toomanyhdr;       /* discarded due to too many headers */
227
228         /*
229          * statistics for improvement of the source address selection
230          * algorithm:
231          * XXX: hardcoded 16 = # of ip6 multicast scope types + 1
232          */
233         /* number of times that address selection fails */
234         u_quad_t ip6s_sources_none;
235         /* number of times that an address on the outgoing I/F is chosen */
236         u_quad_t ip6s_sources_sameif[16];
237         /* number of times that an address on a non-outgoing I/F is chosen */
238         u_quad_t ip6s_sources_otherif[16];
239         /*
240          * number of times that an address that has the same scope
241          * from the destination is chosen.
242          */
243         u_quad_t ip6s_sources_samescope[16];
244         /*
245          * number of times that an address that has a different scope
246          * from the destination is chosen.
247          */
248         u_quad_t ip6s_sources_otherscope[16];
249         /* number of times that an deprecated address is chosen */
250         u_quad_t ip6s_sources_deprecated[16];
251
252         u_quad_t ip6s_forward_cachehit;
253         u_quad_t ip6s_forward_cachemiss;
254 };
255
256 #ifdef _KERNEL
257 /*
258  * IPv6 onion peeling state.
259  * it will be initialized when we come into ip6_input().
260  * XXX do not make it a kitchen sink!
261  */
262 struct ip6aux {
263         u_int32_t ip6a_flags;
264 #define IP6A_SWAP       0x01            /* swapped home/care-of on packet */
265 #define IP6A_HASEEN     0x02            /* HA was present */
266 #define IP6A_BRUID      0x04            /* BR Unique Identifier was present */
267 #define IP6A_RTALERTSEEN 0x08           /* rtalert present */
268
269         /* ip6.ip6_src */
270         struct in6_addr ip6a_careof;    /* care-of address of the peer */
271         struct in6_addr ip6a_home;      /* home address of the peer */
272         u_int16_t       ip6a_bruid;     /* BR unique identifier */
273
274         /* ip6.ip6_dst */
275         struct in6_ifaddr *ip6a_dstia6; /* my ifaddr that matches ip6_dst */
276
277         /* rtalert */
278         u_int16_t ip6a_rtalert;         /* rtalert option value */
279
280         /*
281          * decapsulation history will be here.
282          * with IPsec it may not be accurate.
283          */
284 };
285 #endif
286
287 #ifdef _KERNEL
288 /* flags passed to ip6_output as last parameter */
289 #define IPV6_DADOUTPUT          0x01    /* DAD */
290 #define IPV6_FORWARDING         0x02    /* most of IPv6 header exists */
291 #define IPV6_MINMTU             0x04    /* use minimum MTU (IPV6_USE_MIN_MTU) */
292
293 /* direction passed to ip_hashfn as last parameter */
294 #define IP6_MPORT_IN            0 /* Find lwkt port for incoming packets */
295 #define IP6_MPORT_OUT           1 /* Find lwkt port for outgoing packets */
296
297 extern struct   ip6stat ip6stat;        /* statistics */
298 extern u_int32_t ip6_id;                /* fragment identifier */
299 extern int      ip6_minhlim;            /* minimum hop limit */
300 extern int      ip6_defhlim;            /* default hop limit */
301 extern int      ip6_defmcasthlim;       /* default multicast hop limit */
302 extern int      ip6_forwarding;         /* act as router? */
303 extern int      ip6_forward_srcrt;      /* forward src-routed? */
304 extern int      ip6_gif_hlim;           /* Hop limit for gif encap packet */
305 extern int      ip6_use_deprecated;     /* allow deprecated addr as source */
306 extern int      ip6_rr_prune;           /* router renumbering prefix
307                                          * walk list every 5 sec.    */
308
309 extern struct socket *ip6_mrouter;      /* multicast routing daemon */
310 extern int      ip6_sendredirects;      /* send IP redirects when forwarding? */
311 extern int      ip6_maxfragpackets; /* Maximum packets in reassembly queue */
312 extern int      ip6_sourcecheck;        /* Verify source interface */
313 extern int      ip6_sourcecheck_interval; /* Interval between log messages */
314 extern int      ip6_accept_rtadv;       /* Acts as a host not a router */
315 extern int      ip6_keepfaith;          /* Firewall Aided Internet Translator */
316 extern int      ip6_log_interval;
317 extern time_t   ip6_log_time;
318 extern int      ip6_hdrnestlimit; /* upper limit of # of extension headers */
319 extern int      ip6_dad_count;          /* DupAddrDetectionTransmits */
320
321 extern u_int32_t ip6_flow_seq;
322 extern int ip6_auto_flowlabel;
323 extern int ip6_auto_linklocal;
324
325 extern int   ip6_anonportmin;           /* minimum ephemeral port */
326 extern int   ip6_anonportmax;           /* maximum ephemeral port */
327 extern int   ip6_lowportmin;            /* minimum reserved port */
328 extern int   ip6_lowportmax;            /* maximum reserved port */
329
330 extern int      ip6_use_tempaddr; /* whether to use temporary addresses. */
331
332 extern struct pfil_head inet6_pfil_hook;
333
334 extern struct   pr_usrreqs rip6_usrreqs;
335
336 struct proc;
337 struct inpcb;
338 struct sockopt;
339 struct in6_ifaddr;
340 struct ip6_hdr;
341 union netmsg;
342
343 void    icmp6_ctloutput (union netmsg *);
344
345 void    ip6_init (void);
346 void    ip6intr (void);
347 struct in6_ifaddr *ip6_getdstifaddr (struct mbuf *);
348 void    ip6_freepcbopts (struct ip6_pktopts *);
349 void    ip6_freemoptions (struct ip6_moptions *);
350 int     ip6_unknown_opt (u_int8_t *, struct mbuf *, int);
351 char *  ip6_get_prevhdr (struct mbuf *, int);
352 int     ip6_nexthdr (struct mbuf *, int, int, int *);
353 int     ip6_lasthdr (struct mbuf *, int, int, int *);
354
355 struct ip6aux *ip6_addaux (struct mbuf *);
356 struct ip6aux *ip6_findaux (struct mbuf *);
357 void    ip6_delaux (struct mbuf *);
358
359 int     ip6_mforward (struct ip6_hdr *, struct ifnet *, struct mbuf *);
360 int     ip6_process_hopopts (struct mbuf *, u_int8_t *, int, u_int32_t *,
361                                  u_int32_t *);
362 void    ip6_savecontrol (struct inpcb *, struct mbuf **, struct ip6_hdr *,
363                              struct mbuf *);
364 void    ip6_notify_pmtu (struct inpcb *, struct sockaddr_in6 *,
365                              u_int32_t *);
366 int     ip6_sysctl (int *, u_int, void *, size_t *, void *, size_t);
367
368 void    ip6_forward (struct mbuf *, int);
369
370 void    ip6_mloopback (struct ifnet *, struct mbuf *, struct sockaddr_in6 *);
371 int     ip6_output (struct mbuf *, struct ip6_pktopts *,
372                         struct route_in6 *,
373                         int,
374                         struct ip6_moptions *, struct ifnet **,
375                         struct inpcb *);
376 void    ip6_ctloutput_dispatch(netmsg_t msg);
377 int     ip6_ctloutput (struct socket *, struct sockopt *);
378 int     ip6_raw_ctloutput (struct socket *, struct sockopt *);
379 void    init_ip6pktopts (struct ip6_pktopts *);
380 int
381 ip6_setpktoptions(struct mbuf *, struct ip6_pktopts *,
382     struct ip6_pktopts *, int , int);
383 void    ip6_clearpktopts (struct ip6_pktopts *, int);
384 struct ip6_pktopts *ip6_copypktopts (struct ip6_pktopts *, int);
385 int     ip6_optlen (struct inpcb *);
386
387 int     route6_input (struct mbuf **, int *, int);
388
389 void    frag6_init (void);
390 int     frag6_input (struct mbuf **, int *, int);
391 void    frag6_slowtimo (void);
392 void    frag6_drain (void);
393
394 void    rip6_init (void);
395 int     rip6_input (struct mbuf **, int *, int);
396 void    rip6_ctlinput (union netmsg *);
397 void    rip6_ctloutput (union netmsg *);
398 int     rip6_output (struct mbuf *, struct socket *, ...);
399 int     rip6_usrreq (struct socket *,
400             int, struct mbuf *, struct mbuf *, struct mbuf *, struct proc *);
401
402 int     dest6_input (struct mbuf **, int *, int);
403 int     none_input (struct mbuf **, int *, int);
404 #endif /* _KERNEL */
405
406 #endif /* !_NETINET6_IP6_VAR_H_ */