]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/netinet6/ip6_var.h
Add UPDATING entry and bump version
[FreeBSD/FreeBSD.git] / sys / netinet6 / ip6_var.h
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the project nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *      $KAME: ip6_var.h,v 1.62 2001/05/03 14:51:48 itojun Exp $
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. Neither the name of the University nor the names of its contributors
47  *    may be used to endorse or promote products derived from this software
48  *    without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
54  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
60  * SUCH DAMAGE.
61  *
62  *      @(#)ip_var.h    8.1 (Berkeley) 6/10/93
63  * $FreeBSD$
64  */
65
66 #ifndef _NETINET6_IP6_VAR_H_
67 #define _NETINET6_IP6_VAR_H_
68
69 #include <sys/epoch.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         struct ip6asfrag *ip6q_down;
77         struct ip6asfrag *ip6q_up;
78         u_int32_t       ip6q_ident;
79         u_int8_t        ip6q_nxt;
80         u_int8_t        ip6q_ecn;
81         u_int8_t        ip6q_ttl;
82         struct in6_addr ip6q_src, ip6q_dst;
83         struct ip6q     *ip6q_next;
84         struct ip6q     *ip6q_prev;
85         int             ip6q_unfrglen;  /* len of unfragmentable part */
86 #ifdef notyet
87         u_char          *ip6q_nxtp;
88 #endif
89         int             ip6q_nfrag;     /* # of fragments */
90         struct label    *ip6q_label;
91 };
92
93 struct  ip6asfrag {
94         struct ip6asfrag *ip6af_down;
95         struct ip6asfrag *ip6af_up;
96         struct mbuf     *ip6af_m;
97         int             ip6af_offset;   /* offset in ip6af_m to next header */
98         int             ip6af_frglen;   /* fragmentable part length */
99         int             ip6af_off;      /* fragment offset */
100         u_int16_t       ip6af_mff;      /* more fragment bit in frag off */
101 };
102
103 #define IP6_REASS_MBUF(ip6af) (*(struct mbuf **)&((ip6af)->ip6af_m))
104
105 /*
106  * IP6 reinjecting structure.
107  */
108 struct ip6_direct_ctx {
109         uint32_t        ip6dc_nxt;      /* next header to process */
110         uint32_t        ip6dc_off;      /* offset to next header */
111 };
112
113 #if defined(_NETINET6_IN6_VAR_H_) && defined(_KERNEL)
114 /*
115  * Structure attached to inpcb.in6p_moptions and
116  * passed to ip6_output when IPv6 multicast options are in use.
117  * This structure is lazy-allocated.
118  */
119 struct ip6_moptions {
120         struct  ifnet *im6o_multicast_ifp; /* ifp for outgoing multicasts */
121         u_char  im6o_multicast_hlim;    /* hoplimit for outgoing multicasts */
122         u_char  im6o_multicast_loop;    /* 1 >= hear sends if a member */
123         struct ip6_mfilter_head im6o_head; /* group membership list */
124 };
125 #else
126 struct ip6_moptions;
127 #endif
128 /*
129  * Control options for outgoing packets
130  */
131
132 /* Routing header related info */
133 struct  ip6po_rhinfo {
134         struct  ip6_rthdr *ip6po_rhi_rthdr; /* Routing header */
135         struct  route_in6 ip6po_rhi_route; /* Route to the 1st hop */
136 };
137 #define ip6po_rthdr     ip6po_rhinfo.ip6po_rhi_rthdr
138 #define ip6po_route     ip6po_rhinfo.ip6po_rhi_route
139
140 /* Nexthop related info */
141 struct  ip6po_nhinfo {
142         struct  sockaddr *ip6po_nhi_nexthop;
143         struct  route_in6 ip6po_nhi_route; /* Route to the nexthop */
144 };
145 #define ip6po_nexthop   ip6po_nhinfo.ip6po_nhi_nexthop
146 #define ip6po_nextroute ip6po_nhinfo.ip6po_nhi_route
147
148 struct  ip6_pktopts {
149         struct  mbuf *ip6po_m;  /* Pointer to mbuf storing the data */
150         int     ip6po_hlim;     /* Hoplimit for outgoing packets */
151
152         /* Outgoing IF/address information */
153         struct  in6_pktinfo *ip6po_pktinfo;
154
155         /* Next-hop address information */
156         struct  ip6po_nhinfo ip6po_nhinfo;
157
158         struct  ip6_hbh *ip6po_hbh; /* Hop-by-Hop options header */
159
160         /* Destination options header (before a routing header) */
161         struct  ip6_dest *ip6po_dest1;
162
163         /* Routing header related info. */
164         struct  ip6po_rhinfo ip6po_rhinfo;
165
166         /* Destination options header (after a routing header) */
167         struct  ip6_dest *ip6po_dest2;
168
169         int     ip6po_tclass;   /* traffic class */
170
171         int     ip6po_minmtu;  /* fragment vs PMTU discovery policy */
172 #define IP6PO_MINMTU_MCASTONLY  -1 /* default; send at min MTU for multicast*/
173 #define IP6PO_MINMTU_DISABLE     0 /* always perform pmtu disc */
174 #define IP6PO_MINMTU_ALL         1 /* always send at min MTU */
175
176         int     ip6po_prefer_tempaddr;  /* whether temporary addresses are
177                                            preferred as source address */
178 #define IP6PO_TEMPADDR_SYSTEM   -1 /* follow the system default */
179 #define IP6PO_TEMPADDR_NOTPREFER 0 /* not prefer temporary address */
180 #define IP6PO_TEMPADDR_PREFER    1 /* prefer temporary address */
181
182         int ip6po_flags;
183 #if 0   /* parameters in this block is obsolete. do not reuse the values. */
184 #define IP6PO_REACHCONF 0x01    /* upper-layer reachability confirmation. */
185 #define IP6PO_MINMTU    0x02    /* use minimum MTU (IPV6_USE_MIN_MTU) */
186 #endif
187 #define IP6PO_DONTFRAG  0x04    /* disable fragmentation (IPV6_DONTFRAG) */
188 #define IP6PO_USECOA    0x08    /* use care of address */
189 };
190
191 /*
192  * Control options for incoming packets
193  */
194
195 struct  ip6stat {
196         uint64_t ip6s_total;            /* total packets received */
197         uint64_t ip6s_tooshort;         /* packet too short */
198         uint64_t ip6s_toosmall;         /* not enough data */
199         uint64_t ip6s_fragments;        /* fragments received */
200         uint64_t ip6s_fragdropped;      /* frags dropped(dups, out of space) */
201         uint64_t ip6s_fragtimeout;      /* fragments timed out */
202         uint64_t ip6s_fragoverflow;     /* fragments that exceeded limit */
203         uint64_t ip6s_forward;          /* packets forwarded */
204         uint64_t ip6s_cantforward;      /* packets rcvd for unreachable dest */
205         uint64_t ip6s_redirectsent;     /* packets forwarded on same net */
206         uint64_t ip6s_delivered;        /* datagrams delivered to upper level*/
207         uint64_t ip6s_localout;         /* total ip packets generated here */
208         uint64_t ip6s_odropped;         /* lost packets due to nobufs, etc. */
209         uint64_t ip6s_reassembled;      /* total packets reassembled ok */
210         uint64_t ip6s_fragmented;       /* datagrams successfully fragmented */
211         uint64_t ip6s_ofragments;       /* output fragments created */
212         uint64_t ip6s_cantfrag;         /* don't fragment flag was set, etc. */
213         uint64_t ip6s_badoptions;       /* error in option processing */
214         uint64_t ip6s_noroute;          /* packets discarded due to no route */
215         uint64_t ip6s_badvers;          /* ip6 version != 6 */
216         uint64_t ip6s_rawout;           /* total raw ip packets generated */
217         uint64_t ip6s_badscope;         /* scope error */
218         uint64_t ip6s_notmember;        /* don't join this multicast group */
219 #define IP6S_HDRCNT             256     /* headers count */
220         uint64_t ip6s_nxthist[IP6S_HDRCNT]; /* next header history */
221         uint64_t ip6s_m1;               /* one mbuf */
222 #define IP6S_M2MMAX             32
223         uint64_t ip6s_m2m[IP6S_M2MMAX]; /* two or more mbuf */
224         uint64_t ip6s_mext1;            /* one ext mbuf */
225         uint64_t ip6s_mext2m;           /* two or more ext mbuf */
226         uint64_t ip6s_exthdrtoolong;    /* ext hdr are not contiguous */
227         uint64_t ip6s_nogif;            /* no match gif found */
228         uint64_t ip6s_toomanyhdr;       /* discarded due to too many headers */
229
230         /*
231          * statistics for improvement of the source address selection
232          * algorithm:
233          * XXX: hardcoded 16 = # of ip6 multicast scope types + 1
234          */
235 #define IP6S_RULESMAX           16
236 #define IP6S_SCOPECNT           16
237         /* number of times that address selection fails */
238         uint64_t ip6s_sources_none;
239         /* number of times that an address on the outgoing I/F is chosen */
240         uint64_t ip6s_sources_sameif[IP6S_SCOPECNT];
241         /* number of times that an address on a non-outgoing I/F is chosen */
242         uint64_t ip6s_sources_otherif[IP6S_SCOPECNT];
243         /*
244          * number of times that an address that has the same scope
245          * from the destination is chosen.
246          */
247         uint64_t ip6s_sources_samescope[IP6S_SCOPECNT];
248         /*
249          * number of times that an address that has a different scope
250          * from the destination is chosen.
251          */
252         uint64_t ip6s_sources_otherscope[IP6S_SCOPECNT];
253         /* number of times that a deprecated address is chosen */
254         uint64_t ip6s_sources_deprecated[IP6S_SCOPECNT];
255
256         /* number of times that each rule of source selection is applied. */
257         uint64_t ip6s_sources_rule[IP6S_RULESMAX];
258 };
259
260 #ifdef _KERNEL
261 #include <sys/counter.h>
262
263 VNET_PCPUSTAT_DECLARE(struct ip6stat, ip6stat);
264 #define IP6STAT_ADD(name, val)  \
265     VNET_PCPUSTAT_ADD(struct ip6stat, ip6stat, name, (val))
266 #define IP6STAT_SUB(name, val)  IP6STAT_ADD(name, -(val))
267 #define IP6STAT_INC(name)       IP6STAT_ADD(name, 1)
268 #define IP6STAT_DEC(name)       IP6STAT_SUB(name, 1)
269 #endif
270
271 #ifdef _KERNEL
272 /* flags passed to ip6_output as last parameter */
273 #define IPV6_UNSPECSRC          0x01    /* allow :: as the source address */
274 #define IPV6_FORWARDING         0x02    /* most of IPv6 header exists */
275 #define IPV6_MINMTU             0x04    /* use minimum MTU (IPV6_USE_MIN_MTU) */
276
277 #ifdef __NO_STRICT_ALIGNMENT
278 #define IP6_HDR_ALIGNED_P(ip)   1
279 #else
280 #define IP6_HDR_ALIGNED_P(ip)   ((((intptr_t) (ip)) & 3) == 0)
281 #endif
282
283 VNET_DECLARE(int, ip6_defhlim);         /* default hop limit */
284 VNET_DECLARE(int, ip6_defmcasthlim);    /* default multicast hop limit */
285 VNET_DECLARE(int, ip6_forwarding);      /* act as router? */
286 VNET_DECLARE(int, ip6_use_deprecated);  /* allow deprecated addr as source */
287 VNET_DECLARE(int, ip6_rr_prune);        /* router renumbering prefix
288                                          * walk list every 5 sec.    */
289 VNET_DECLARE(int, ip6_mcast_pmtu);      /* enable pMTU discovery for multicast? */
290 VNET_DECLARE(int, ip6_v6only);
291 #define V_ip6_defhlim                   VNET(ip6_defhlim)
292 #define V_ip6_defmcasthlim              VNET(ip6_defmcasthlim)
293 #define V_ip6_forwarding                VNET(ip6_forwarding)
294 #define V_ip6_use_deprecated            VNET(ip6_use_deprecated)
295 #define V_ip6_rr_prune                  VNET(ip6_rr_prune)
296 #define V_ip6_mcast_pmtu                VNET(ip6_mcast_pmtu)
297 #define V_ip6_v6only                    VNET(ip6_v6only)
298
299 VNET_DECLARE(struct socket *, ip6_mrouter);     /* multicast routing daemon */
300 VNET_DECLARE(int, ip6_sendredirects);   /* send IP redirects when forwarding? */
301 VNET_DECLARE(int, ip6_maxfragpackets);  /* Maximum packets in reassembly
302                                          * queue */
303 extern int ip6_maxfrags;                /* Maximum fragments in reassembly
304                                          * queue */
305 VNET_DECLARE(int, ip6_maxfragbucketsize); /* Maximum reassembly queues per bucket */
306 VNET_DECLARE(int, ip6_maxfragsperpacket); /* Maximum fragments per packet */
307 VNET_DECLARE(int, ip6_accept_rtadv);    /* Acts as a host not a router */
308 VNET_DECLARE(int, ip6_no_radr);         /* No defroute from RA */
309 VNET_DECLARE(int, ip6_norbit_raif);     /* Disable R-bit in NA on RA
310                                          * receiving IF. */
311 VNET_DECLARE(int, ip6_rfc6204w3);       /* Accept defroute from RA even when
312                                            forwarding enabled */
313 VNET_DECLARE(int, ip6_log_interval);
314 VNET_DECLARE(time_t, ip6_log_time);
315 VNET_DECLARE(int, ip6_hdrnestlimit);    /* upper limit of # of extension
316                                          * headers */
317 VNET_DECLARE(int, ip6_dad_count);       /* DupAddrDetectionTransmits */
318 #define V_ip6_mrouter                   VNET(ip6_mrouter)
319 #define V_ip6_sendredirects             VNET(ip6_sendredirects)
320 #define V_ip6_maxfragpackets            VNET(ip6_maxfragpackets)
321 #define V_ip6_maxfragbucketsize         VNET(ip6_maxfragbucketsize)
322 #define V_ip6_maxfragsperpacket         VNET(ip6_maxfragsperpacket)
323 #define V_ip6_accept_rtadv              VNET(ip6_accept_rtadv)
324 #define V_ip6_no_radr                   VNET(ip6_no_radr)
325 #define V_ip6_norbit_raif               VNET(ip6_norbit_raif)
326 #define V_ip6_rfc6204w3                 VNET(ip6_rfc6204w3)
327 #define V_ip6_log_interval              VNET(ip6_log_interval)
328 #define V_ip6_log_time                  VNET(ip6_log_time)
329 #define V_ip6_hdrnestlimit              VNET(ip6_hdrnestlimit)
330 #define V_ip6_dad_count                 VNET(ip6_dad_count)
331
332 VNET_DECLARE(int, ip6_auto_flowlabel);
333 VNET_DECLARE(int, ip6_auto_linklocal);
334 #define V_ip6_auto_flowlabel            VNET(ip6_auto_flowlabel)
335 #define V_ip6_auto_linklocal            VNET(ip6_auto_linklocal)
336
337 VNET_DECLARE(int, ip6_use_tempaddr);    /* Whether to use temporary addresses */
338 VNET_DECLARE(int, ip6_prefer_tempaddr); /* Whether to prefer temporary
339                                          * addresses in the source address
340                                          * selection */
341 #define V_ip6_use_tempaddr              VNET(ip6_use_tempaddr)
342 #define V_ip6_prefer_tempaddr           VNET(ip6_prefer_tempaddr)
343
344 VNET_DECLARE(int, ip6_use_defzone);     /* Whether to use the default scope
345                                          * zone when unspecified */
346 #define V_ip6_use_defzone               VNET(ip6_use_defzone)
347
348 VNET_DECLARE (struct pfil_head, inet6_pfil_hook);       /* packet filter hooks */
349 #define V_inet6_pfil_hook       VNET(inet6_pfil_hook)
350 #ifdef IPSTEALTH
351 VNET_DECLARE(int, ip6stealth);
352 #define V_ip6stealth                    VNET(ip6stealth)
353 #endif
354
355 extern struct   pr_usrreqs rip6_usrreqs;
356 struct sockopt;
357
358 struct inpcb;
359
360 int     icmp6_ctloutput(struct socket *, struct sockopt *sopt);
361
362 struct in6_ifaddr;
363 void    ip6_init(void);
364 int     ip6proto_register(short);
365 int     ip6proto_unregister(short);
366
367 void    ip6_input(struct mbuf *);
368 void    ip6_direct_input(struct mbuf *);
369 void    ip6_freepcbopts(struct ip6_pktopts *);
370
371 int     ip6_unknown_opt(u_int8_t *, struct mbuf *, int);
372 int     ip6_get_prevhdr(const struct mbuf *, int);
373 int     ip6_nexthdr(const struct mbuf *, int, int, int *);
374 int     ip6_lasthdr(const struct mbuf *, int, int, int *);
375
376 extern int      (*ip6_mforward)(struct ip6_hdr *, struct ifnet *,
377     struct mbuf *);
378
379 int     ip6_process_hopopts(struct mbuf *, u_int8_t *, int, u_int32_t *,
380                                  u_int32_t *);
381 struct mbuf     **ip6_savecontrol_v4(struct inpcb *, struct mbuf *,
382             struct mbuf **, int *);
383 void    ip6_savecontrol(struct inpcb *, struct mbuf *, struct mbuf **);
384 void    ip6_notify_pmtu(struct inpcb *, struct sockaddr_in6 *, u_int32_t);
385 int     ip6_sysctl(int *, u_int, void *, size_t *, void *, size_t);
386
387 void    ip6_forward(struct mbuf *, int);
388
389 void    ip6_mloopback(struct ifnet *, struct mbuf *);
390 int     ip6_output(struct mbuf *, struct ip6_pktopts *,
391                         struct route_in6 *,
392                         int,
393                         struct ip6_moptions *, struct ifnet **,
394                         struct inpcb *);
395 int     ip6_ctloutput(struct socket *, struct sockopt *);
396 int     ip6_raw_ctloutput(struct socket *, struct sockopt *);
397 void    ip6_initpktopts(struct ip6_pktopts *);
398 int     ip6_setpktopts(struct mbuf *, struct ip6_pktopts *,
399         struct ip6_pktopts *, struct ucred *, int);
400 void    ip6_clearpktopts(struct ip6_pktopts *, int);
401 struct ip6_pktopts *ip6_copypktopts(struct ip6_pktopts *, int);
402 int     ip6_optlen(struct inpcb *);
403 int     ip6_deletefraghdr(struct mbuf *, int, int);
404 int     ip6_fragment(struct ifnet *, struct mbuf *, int, u_char, int,
405                         uint32_t);
406
407 int     route6_input(struct mbuf **, int *, int);
408
409 void    frag6_set_bucketsize(void);
410 void    frag6_init(void);
411 int     frag6_input(struct mbuf **, int *, int);
412 void    frag6_slowtimo(void);
413 void    frag6_drain(void);
414
415 void    rip6_init(void);
416 int     rip6_input(struct mbuf **, int *, int);
417 void    rip6_ctlinput(int, struct sockaddr *, void *);
418 int     rip6_ctloutput(struct socket *, struct sockopt *);
419 int     rip6_output(struct mbuf *, struct socket *, ...);
420 int     rip6_usrreq(struct socket *,
421             int, struct mbuf *, struct mbuf *, struct mbuf *, struct thread *);
422
423 int     dest6_input(struct mbuf **, int *, int);
424 int     none_input(struct mbuf **, int *, int);
425
426 int     in6_selectsrc_socket(struct sockaddr_in6 *, struct ip6_pktopts *,
427     struct inpcb *, struct ucred *, int, struct in6_addr *, int *);
428 int     in6_selectsrc_addr(uint32_t, const struct in6_addr *,
429     uint32_t, struct ifnet *, struct in6_addr *, int *);
430 int in6_selectroute(struct sockaddr_in6 *, struct ip6_pktopts *,
431         struct ip6_moptions *, struct route_in6 *, struct ifnet **,
432         struct rtentry **);
433 int     in6_selectroute_fib(struct sockaddr_in6 *, struct ip6_pktopts *,
434             struct ip6_moptions *, struct route_in6 *, struct ifnet **,
435             struct rtentry **, u_int);
436 u_int32_t ip6_randomid(void);
437 u_int32_t ip6_randomflowlabel(void);
438 void in6_delayed_cksum(struct mbuf *m, uint32_t plen, u_short offset);
439 #endif /* _KERNEL */
440
441 #endif /* !_NETINET6_IP6_VAR_H_ */