Cleanup various type-o's in comments.
[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.9 2004/08/25 01:53:36 dillon 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 /*
73  * IP6 reassembly queue structure.  Each fragment
74  * being reassembled is attached to one of these structures.
75  */
76 struct  ip6q {
77         u_int32_t       ip6q_head;
78         u_int16_t       ip6q_len;
79         u_int8_t        ip6q_nxt;       /* ip6f_nxt in first fragment */
80         u_int8_t        ip6q_hlim;
81         struct ip6asfrag *ip6q_down;
82         struct ip6asfrag *ip6q_up;
83         u_int32_t       ip6q_ident;
84         u_int8_t        ip6q_arrive;
85         u_int8_t        ip6q_ttl;
86         struct in6_addr ip6q_src, ip6q_dst;
87         struct ip6q     *ip6q_next;
88         struct ip6q     *ip6q_prev;
89         int             ip6q_unfrglen;  /* len of unfragmentable part */
90 #ifdef notyet
91         u_char          *ip6q_nxtp;
92 #endif
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 struct  ip6_pktopts {
132         struct  mbuf *ip6po_m;  /* Pointer to mbuf storing the data */
133         int     ip6po_hlim;     /* Hoplimit for outgoing packets */
134
135         /* Outgoing IF/address information */
136         struct  in6_pktinfo *ip6po_pktinfo;
137
138         struct  sockaddr *ip6po_nexthop; /* Next-hop address */
139         
140         struct  ip6_hbh *ip6po_hbh; /* Hop-by-Hop options header */
141
142         /* Destination options header (before a routing header) */
143         struct  ip6_dest *ip6po_dest1;
144
145         /* Routing header related info. */
146         struct  ip6po_rhinfo ip6po_rhinfo;
147
148         /* Destination options header (after a routing header) */
149         struct  ip6_dest *ip6po_dest2;
150 };
151
152 /*
153  * Control options for incoming packets
154  */
155
156 struct  ip6stat {
157         u_quad_t ip6s_total;            /* total packets received */
158         u_quad_t ip6s_tooshort;         /* packet too short */
159         u_quad_t ip6s_toosmall;         /* not enough data */
160         u_quad_t ip6s_fragments;        /* fragments received */
161         u_quad_t ip6s_fragdropped;      /* frags dropped(dups, out of space) */
162         u_quad_t ip6s_fragtimeout;      /* fragments timed out */
163         u_quad_t ip6s_fragoverflow;     /* fragments that exceeded limit */
164         u_quad_t ip6s_forward;          /* packets forwarded */
165         u_quad_t ip6s_cantforward;      /* packets rcvd for unreachable dest */
166         u_quad_t ip6s_redirectsent;     /* packets forwarded on same net */
167         u_quad_t ip6s_delivered;        /* datagrams delivered to upper level*/
168         u_quad_t ip6s_localout;         /* total ip packets generated here */
169         u_quad_t ip6s_odropped;         /* lost packets due to nobufs, etc. */
170         u_quad_t ip6s_reassembled;      /* total packets reassembled ok */
171         u_quad_t ip6s_fragmented;       /* datagrams successfully fragmented */
172         u_quad_t ip6s_ofragments;       /* output fragments created */
173         u_quad_t ip6s_cantfrag;         /* don't fragment flag was set, etc. */
174         u_quad_t ip6s_badoptions;       /* error in option processing */
175         u_quad_t ip6s_noroute;          /* packets discarded due to no route */
176         u_quad_t ip6s_badvers;          /* ip6 version != 6 */
177         u_quad_t ip6s_rawout;           /* total raw ip packets generated */
178         u_quad_t ip6s_badscope;         /* scope error */
179         u_quad_t ip6s_notmember;        /* don't join this multicast group */
180         u_quad_t ip6s_nxthist[256];     /* next header history */
181         u_quad_t ip6s_m1;               /* one mbuf */
182         u_quad_t ip6s_m2m[32];          /* two or more mbuf */
183         u_quad_t ip6s_mext1;            /* one ext mbuf */
184         u_quad_t ip6s_mext2m;           /* two or more ext mbuf */
185         u_quad_t ip6s_exthdrtoolong;    /* ext hdr are not continuous */
186         u_quad_t ip6s_nogif;            /* no match gif found */
187         u_quad_t ip6s_toomanyhdr;       /* discarded due to too many headers */
188
189         /*
190          * statistics for improvement of the source address selection
191          * algorithm:
192          * XXX: hardcoded 16 = # of ip6 multicast scope types + 1
193          */
194         /* number of times that address selection fails */
195         u_quad_t ip6s_sources_none;
196         /* number of times that an address on the outgoing I/F is chosen */
197         u_quad_t ip6s_sources_sameif[16];
198         /* number of times that an address on a non-outgoing I/F is chosen */
199         u_quad_t ip6s_sources_otherif[16];
200         /*
201          * number of times that an address that has the same scope
202          * from the destination is chosen.
203          */
204         u_quad_t ip6s_sources_samescope[16];
205         /*
206          * number of times that an address that has a different scope
207          * from the destination is chosen.
208          */
209         u_quad_t ip6s_sources_otherscope[16];
210         /* number of times that an deprecated address is chosen */
211         u_quad_t ip6s_sources_deprecated[16];
212
213         u_quad_t ip6s_forward_cachehit;
214         u_quad_t ip6s_forward_cachemiss;
215 };
216
217 #ifdef _KERNEL
218 /*
219  * IPv6 onion peeling state.
220  * it will be initialized when we come into ip6_input().
221  * XXX do not make it a kitchen sink!
222  */
223 struct ip6aux {
224         u_int32_t ip6a_flags;
225 #define IP6A_SWAP       0x01            /* swapped home/care-of on packet */
226 #define IP6A_HASEEN     0x02            /* HA was present */
227 #define IP6A_BRUID      0x04            /* BR Unique Identifier was present */
228 #define IP6A_RTALERTSEEN 0x08           /* rtalert present */
229
230         /* ip6.ip6_src */
231         struct in6_addr ip6a_careof;    /* care-of address of the peer */
232         struct in6_addr ip6a_home;      /* home address of the peer */
233         u_int16_t       ip6a_bruid;     /* BR unique identifier */
234
235         /* ip6.ip6_dst */
236         struct in6_ifaddr *ip6a_dstia6; /* my ifaddr that matches ip6_dst */
237
238         /* rtalert */
239         u_int16_t ip6a_rtalert;         /* rtalert option value */
240
241         /*
242          * decapsulation history will be here.
243          * with IPsec it may not be accurate.
244          */
245 };
246 #endif
247
248 #ifdef _KERNEL
249 /* flags passed to ip6_output as last parameter */
250 #define IPV6_DADOUTPUT          0x01    /* DAD */
251 #define IPV6_FORWARDING         0x02    /* most of IPv6 header exists */
252 #define IPV6_MINMTU             0x04    /* use minimum MTU (IPV6_USE_MIN_MTU) */
253
254 extern struct   ip6stat ip6stat;        /* statistics */
255 extern u_int32_t ip6_id;                /* fragment identifier */
256 extern int      ip6_defhlim;            /* default hop limit */
257 extern int      ip6_defmcasthlim;       /* default multicast hop limit */
258 extern int      ip6_forwarding;         /* act as router? */
259 extern int      ip6_forward_srcrt;      /* forward src-routed? */
260 extern int      ip6_gif_hlim;           /* Hop limit for gif encap packet */
261 extern int      ip6_use_deprecated;     /* allow deprecated addr as source */
262 extern int      ip6_rr_prune;           /* router renumbering prefix
263                                          * walk list every 5 sec.    */
264 extern int      ip6_v6only;
265
266 extern struct socket *ip6_mrouter;      /* multicast routing daemon */
267 extern int      ip6_sendredirects;      /* send IP redirects when forwarding? */
268 extern int      ip6_maxfragpackets; /* Maximum packets in reassembly queue */
269 extern int      ip6_sourcecheck;        /* Verify source interface */
270 extern int      ip6_sourcecheck_interval; /* Interval between log messages */
271 extern int      ip6_accept_rtadv;       /* Acts as a host not a router */
272 extern int      ip6_keepfaith;          /* Firewall Aided Internet Translator */
273 extern int      ip6_log_interval;
274 extern time_t   ip6_log_time;
275 extern int      ip6_hdrnestlimit; /* upper limit of # of extension headers */
276 extern int      ip6_dad_count;          /* DupAddrDetectionTransmits */
277
278 extern u_int32_t ip6_flow_seq;
279 extern int ip6_auto_flowlabel;
280 extern int ip6_auto_linklocal;
281
282 extern int   ip6_anonportmin;           /* minimum ephemeral port */
283 extern int   ip6_anonportmax;           /* maximum ephemeral port */
284 extern int   ip6_lowportmin;            /* minimum reserved port */
285 extern int   ip6_lowportmax;            /* maximum reserved port */
286
287 extern int      ip6_use_tempaddr; /* whether to use temporary addresses. */
288
289 extern struct pfil_head inet6_pfil_hook;
290
291 extern struct   pr_usrreqs rip6_usrreqs;
292 struct sockopt;
293
294 struct inpcb;
295
296 int     icmp6_ctloutput (struct socket *, struct sockopt *sopt);
297
298 struct in6_ifaddr;
299 void    ip6_init (void);
300 void    ip6intr (void);
301 struct netmsg;
302 struct in6_ifaddr *ip6_getdstifaddr (struct mbuf *);
303 void    ip6_freepcbopts (struct ip6_pktopts *);
304 void    ip6_freemoptions (struct ip6_moptions *);
305 int     ip6_unknown_opt (u_int8_t *, struct mbuf *, int);
306 char *  ip6_get_prevhdr (struct mbuf *, int);
307 int     ip6_nexthdr (struct mbuf *, int, int, int *);
308 int     ip6_lasthdr (struct mbuf *, int, int, int *);
309
310 struct ip6aux *ip6_addaux (struct mbuf *);
311 struct ip6aux *ip6_findaux (struct mbuf *);
312 void    ip6_delaux (struct mbuf *);
313
314 int     ip6_mforward (struct ip6_hdr *, struct ifnet *, struct mbuf *);
315 int     ip6_process_hopopts (struct mbuf *, u_int8_t *, int, u_int32_t *,
316                                  u_int32_t *);
317 void    ip6_savecontrol (struct inpcb *, struct mbuf **, struct ip6_hdr *,
318                              struct mbuf *);
319 void    ip6_notify_pmtu (struct inpcb *, struct sockaddr_in6 *,
320                              u_int32_t *);
321 int     ip6_sysctl (int *, u_int, void *, size_t *, void *, size_t);
322
323 void    ip6_forward (struct mbuf *, int);
324
325 void    ip6_mloopback (struct ifnet *, struct mbuf *, struct sockaddr_in6 *);
326 int     ip6_output (struct mbuf *, struct ip6_pktopts *,
327                         struct route_in6 *,
328                         int,
329                         struct ip6_moptions *, struct ifnet **,
330                         struct inpcb *);
331 int     ip6_ctloutput (struct socket *, struct sockopt *sopt);
332 void    init_ip6pktopts (struct ip6_pktopts *);
333 int     ip6_setpktoptions (struct mbuf *, struct ip6_pktopts *, int, int);
334 void    ip6_clearpktopts (struct ip6_pktopts *, int, int);
335 struct ip6_pktopts *ip6_copypktopts (struct ip6_pktopts *, int);
336 int     ip6_optlen (struct inpcb *);
337
338 int     route6_input (struct mbuf **, int *, int);
339
340 void    frag6_init (void);
341 int     frag6_input (struct mbuf **, int *, int);
342 void    frag6_slowtimo (void);
343 void    frag6_drain (void);
344
345 void    rip6_init (void);
346 int     rip6_input (struct mbuf **mp, int *offp, int proto);
347 void    rip6_ctlinput (int, struct sockaddr *, void *);
348 int     rip6_ctloutput (struct socket *so, struct sockopt *sopt);
349 int     rip6_output (struct mbuf *, struct socket *, ...);
350 int     rip6_usrreq (struct socket *,
351             int, struct mbuf *, struct mbuf *, struct mbuf *, struct proc *);
352
353 int     dest6_input (struct mbuf **, int *, int);
354 int     none_input (struct mbuf **, int *, int);
355 #endif /* _KERNEL */
356
357 #endif /* !_NETINET6_IP6_VAR_H_ */