]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/netinet6/ip6_var.h
Import OpenCSD -- an ARM CoreSight(tm) Trace Decode Library.
[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 /*
70  * IP6 reassembly queue structure.  Each fragment
71  * being reassembled is attached to one of these structures.
72  */
73 struct  ip6q {
74         struct ip6asfrag *ip6q_down;
75         struct ip6asfrag *ip6q_up;
76         u_int32_t       ip6q_ident;
77         u_int8_t        ip6q_nxt;
78         u_int8_t        ip6q_ecn;
79         u_int8_t        ip6q_ttl;
80         struct in6_addr ip6q_src, ip6q_dst;
81         struct ip6q     *ip6q_next;
82         struct ip6q     *ip6q_prev;
83         int             ip6q_unfrglen;  /* len of unfragmentable part */
84 #ifdef notyet
85         u_char          *ip6q_nxtp;
86 #endif
87         int             ip6q_nfrag;     /* # of fragments */
88         struct label    *ip6q_label;
89 };
90
91 struct  ip6asfrag {
92         struct ip6asfrag *ip6af_down;
93         struct ip6asfrag *ip6af_up;
94         struct mbuf     *ip6af_m;
95         int             ip6af_offset;   /* offset in ip6af_m to next header */
96         int             ip6af_frglen;   /* fragmentable part length */
97         int             ip6af_off;      /* fragment offset */
98         u_int16_t       ip6af_mff;      /* more fragment bit in frag off */
99 };
100
101 #define IP6_REASS_MBUF(ip6af) (*(struct mbuf **)&((ip6af)->ip6af_m))
102
103 /*
104  * IP6 reinjecting structure.
105  */
106 struct ip6_direct_ctx {
107         uint32_t        ip6dc_nxt;      /* next header to process */
108         uint32_t        ip6dc_off;      /* offset to next header */
109 };
110
111 /*
112  * Structure attached to inpcb.in6p_moptions and
113  * passed to ip6_output when IPv6 multicast options are in use.
114  * This structure is lazy-allocated.
115  */
116 struct ip6_moptions {
117         struct  ifnet *im6o_multicast_ifp; /* ifp for outgoing multicasts */
118         u_char  im6o_multicast_hlim;    /* hoplimit for outgoing multicasts */
119         u_char  im6o_multicast_loop;    /* 1 >= hear sends if a member */
120         u_short im6o_num_memberships;   /* no. memberships this socket */
121         u_short im6o_max_memberships;   /* max memberships this socket */
122         struct  in6_multi **im6o_membership;    /* group memberships */
123         struct  in6_mfilter *im6o_mfilters;     /* source filters */
124 };
125
126 /*
127  * Control options for outgoing packets
128  */
129
130 /* Routing header related info */
131 struct  ip6po_rhinfo {
132         struct  ip6_rthdr *ip6po_rhi_rthdr; /* Routing header */
133         struct  route_in6 ip6po_rhi_route; /* Route to the 1st hop */
134 };
135 #define ip6po_rthdr     ip6po_rhinfo.ip6po_rhi_rthdr
136 #define ip6po_route     ip6po_rhinfo.ip6po_rhi_route
137
138 /* Nexthop related info */
139 struct  ip6po_nhinfo {
140         struct  sockaddr *ip6po_nhi_nexthop;
141         struct  route_in6 ip6po_nhi_route; /* Route to the nexthop */
142 };
143 #define ip6po_nexthop   ip6po_nhinfo.ip6po_nhi_nexthop
144 #define ip6po_nextroute ip6po_nhinfo.ip6po_nhi_route
145
146 struct  ip6_pktopts {
147         struct  mbuf *ip6po_m;  /* Pointer to mbuf storing the data */
148         int     ip6po_hlim;     /* Hoplimit for outgoing packets */
149
150         /* Outgoing IF/address information */
151         struct  in6_pktinfo *ip6po_pktinfo;
152
153         /* Next-hop address information */
154         struct  ip6po_nhinfo ip6po_nhinfo;
155
156         struct  ip6_hbh *ip6po_hbh; /* Hop-by-Hop options header */
157
158         /* Destination options header (before a routing header) */
159         struct  ip6_dest *ip6po_dest1;
160
161         /* Routing header related info. */
162         struct  ip6po_rhinfo ip6po_rhinfo;
163
164         /* Destination options header (after a routing header) */
165         struct  ip6_dest *ip6po_dest2;
166
167         int     ip6po_tclass;   /* traffic class */
168
169         int     ip6po_minmtu;  /* fragment vs PMTU discovery policy */
170 #define IP6PO_MINMTU_MCASTONLY  -1 /* default; send at min MTU for multicast*/
171 #define IP6PO_MINMTU_DISABLE     0 /* always perform pmtu disc */
172 #define IP6PO_MINMTU_ALL         1 /* always send at min MTU */
173
174         int     ip6po_prefer_tempaddr;  /* whether temporary addresses are
175                                            preferred as source address */
176 #define IP6PO_TEMPADDR_SYSTEM   -1 /* follow the system default */
177 #define IP6PO_TEMPADDR_NOTPREFER 0 /* not prefer temporary address */
178 #define IP6PO_TEMPADDR_PREFER    1 /* prefer temporary address */
179
180         int ip6po_flags;
181 #if 0   /* parameters in this block is obsolete. do not reuse the values. */
182 #define IP6PO_REACHCONF 0x01    /* upper-layer reachability confirmation. */
183 #define IP6PO_MINMTU    0x02    /* use minimum MTU (IPV6_USE_MIN_MTU) */
184 #endif
185 #define IP6PO_DONTFRAG  0x04    /* disable fragmentation (IPV6_DONTFRAG) */
186 #define IP6PO_USECOA    0x08    /* use care of address */
187 };
188
189 /*
190  * Control options for incoming packets
191  */
192
193 struct  ip6stat {
194         uint64_t ip6s_total;            /* total packets received */
195         uint64_t ip6s_tooshort;         /* packet too short */
196         uint64_t ip6s_toosmall;         /* not enough data */
197         uint64_t ip6s_fragments;        /* fragments received */
198         uint64_t ip6s_fragdropped;      /* frags dropped(dups, out of space) */
199         uint64_t ip6s_fragtimeout;      /* fragments timed out */
200         uint64_t ip6s_fragoverflow;     /* fragments that exceeded limit */
201         uint64_t ip6s_forward;          /* packets forwarded */
202         uint64_t ip6s_cantforward;      /* packets rcvd for unreachable dest */
203         uint64_t ip6s_redirectsent;     /* packets forwarded on same net */
204         uint64_t ip6s_delivered;        /* datagrams delivered to upper level*/
205         uint64_t ip6s_localout;         /* total ip packets generated here */
206         uint64_t ip6s_odropped;         /* lost packets due to nobufs, etc. */
207         uint64_t ip6s_reassembled;      /* total packets reassembled ok */
208         uint64_t ip6s_fragmented;       /* datagrams successfully fragmented */
209         uint64_t ip6s_ofragments;       /* output fragments created */
210         uint64_t ip6s_cantfrag;         /* don't fragment flag was set, etc. */
211         uint64_t ip6s_badoptions;       /* error in option processing */
212         uint64_t ip6s_noroute;          /* packets discarded due to no route */
213         uint64_t ip6s_badvers;          /* ip6 version != 6 */
214         uint64_t ip6s_rawout;           /* total raw ip packets generated */
215         uint64_t ip6s_badscope;         /* scope error */
216         uint64_t ip6s_notmember;        /* don't join this multicast group */
217 #define IP6S_HDRCNT             256     /* headers count */
218         uint64_t ip6s_nxthist[IP6S_HDRCNT]; /* next header history */
219         uint64_t ip6s_m1;               /* one mbuf */
220 #define IP6S_M2MMAX             32
221         uint64_t ip6s_m2m[IP6S_M2MMAX]; /* two or more mbuf */
222         uint64_t ip6s_mext1;            /* one ext mbuf */
223         uint64_t ip6s_mext2m;           /* two or more ext mbuf */
224         uint64_t ip6s_exthdrtoolong;    /* ext hdr are not contiguous */
225         uint64_t ip6s_nogif;            /* no match gif found */
226         uint64_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 #define IP6S_RULESMAX           16
234 #define IP6S_SCOPECNT           16
235         /* number of times that address selection fails */
236         uint64_t ip6s_sources_none;
237         /* number of times that an address on the outgoing I/F is chosen */
238         uint64_t ip6s_sources_sameif[IP6S_SCOPECNT];
239         /* number of times that an address on a non-outgoing I/F is chosen */
240         uint64_t ip6s_sources_otherif[IP6S_SCOPECNT];
241         /*
242          * number of times that an address that has the same scope
243          * from the destination is chosen.
244          */
245         uint64_t ip6s_sources_samescope[IP6S_SCOPECNT];
246         /*
247          * number of times that an address that has a different scope
248          * from the destination is chosen.
249          */
250         uint64_t ip6s_sources_otherscope[IP6S_SCOPECNT];
251         /* number of times that a deprecated address is chosen */
252         uint64_t ip6s_sources_deprecated[IP6S_SCOPECNT];
253
254         /* number of times that each rule of source selection is applied. */
255         uint64_t ip6s_sources_rule[IP6S_RULESMAX];
256 };
257
258 #ifdef _KERNEL
259 #include <sys/counter.h>
260
261 VNET_PCPUSTAT_DECLARE(struct ip6stat, ip6stat);
262 #define IP6STAT_ADD(name, val)  \
263     VNET_PCPUSTAT_ADD(struct ip6stat, ip6stat, name, (val))
264 #define IP6STAT_SUB(name, val)  IP6STAT_ADD(name, -(val))
265 #define IP6STAT_INC(name)       IP6STAT_ADD(name, 1)
266 #define IP6STAT_DEC(name)       IP6STAT_SUB(name, 1)
267 #endif
268
269 #ifdef _KERNEL
270 /* flags passed to ip6_output as last parameter */
271 #define IPV6_UNSPECSRC          0x01    /* allow :: as the source address */
272 #define IPV6_FORWARDING         0x02    /* most of IPv6 header exists */
273 #define IPV6_MINMTU             0x04    /* use minimum MTU (IPV6_USE_MIN_MTU) */
274
275 #ifdef __NO_STRICT_ALIGNMENT
276 #define IP6_HDR_ALIGNED_P(ip)   1
277 #else
278 #define IP6_HDR_ALIGNED_P(ip)   ((((intptr_t) (ip)) & 3) == 0)
279 #endif
280
281 VNET_DECLARE(int, ip6_defhlim);         /* default hop limit */
282 VNET_DECLARE(int, ip6_defmcasthlim);    /* default multicast hop limit */
283 VNET_DECLARE(int, ip6_forwarding);      /* act as router? */
284 VNET_DECLARE(int, ip6_use_deprecated);  /* allow deprecated addr as source */
285 VNET_DECLARE(int, ip6_rr_prune);        /* router renumbering prefix
286                                          * walk list every 5 sec.    */
287 VNET_DECLARE(int, ip6_mcast_pmtu);      /* enable pMTU discovery for multicast? */
288 VNET_DECLARE(int, ip6_v6only);
289 #define V_ip6_defhlim                   VNET(ip6_defhlim)
290 #define V_ip6_defmcasthlim              VNET(ip6_defmcasthlim)
291 #define V_ip6_forwarding                VNET(ip6_forwarding)
292 #define V_ip6_use_deprecated            VNET(ip6_use_deprecated)
293 #define V_ip6_rr_prune                  VNET(ip6_rr_prune)
294 #define V_ip6_mcast_pmtu                VNET(ip6_mcast_pmtu)
295 #define V_ip6_v6only                    VNET(ip6_v6only)
296
297 VNET_DECLARE(struct socket *, ip6_mrouter);     /* multicast routing daemon */
298 VNET_DECLARE(int, ip6_sendredirects);   /* send IP redirects when forwarding? */
299 VNET_DECLARE(int, ip6_maxfragpackets);  /* Maximum packets in reassembly
300                                          * queue */
301 VNET_DECLARE(int, ip6_maxfrags);        /* Maximum fragments in reassembly
302                                          * queue */
303 VNET_DECLARE(int, ip6_accept_rtadv);    /* Acts as a host not a router */
304 VNET_DECLARE(int, ip6_no_radr);         /* No defroute from RA */
305 VNET_DECLARE(int, ip6_norbit_raif);     /* Disable R-bit in NA on RA
306                                          * receiving IF. */
307 VNET_DECLARE(int, ip6_rfc6204w3);       /* Accept defroute from RA even when
308                                            forwarding enabled */
309 VNET_DECLARE(int, ip6_log_interval);
310 VNET_DECLARE(time_t, ip6_log_time);
311 VNET_DECLARE(int, ip6_hdrnestlimit);    /* upper limit of # of extension
312                                          * headers */
313 VNET_DECLARE(int, ip6_dad_count);       /* DupAddrDetectionTransmits */
314 #define V_ip6_mrouter                   VNET(ip6_mrouter)
315 #define V_ip6_sendredirects             VNET(ip6_sendredirects)
316 #define V_ip6_maxfragpackets            VNET(ip6_maxfragpackets)
317 #define V_ip6_maxfrags                  VNET(ip6_maxfrags)
318 #define V_ip6_accept_rtadv              VNET(ip6_accept_rtadv)
319 #define V_ip6_no_radr                   VNET(ip6_no_radr)
320 #define V_ip6_norbit_raif               VNET(ip6_norbit_raif)
321 #define V_ip6_rfc6204w3                 VNET(ip6_rfc6204w3)
322 #define V_ip6_log_interval              VNET(ip6_log_interval)
323 #define V_ip6_log_time                  VNET(ip6_log_time)
324 #define V_ip6_hdrnestlimit              VNET(ip6_hdrnestlimit)
325 #define V_ip6_dad_count                 VNET(ip6_dad_count)
326
327 VNET_DECLARE(int, ip6_auto_flowlabel);
328 VNET_DECLARE(int, ip6_auto_linklocal);
329 #define V_ip6_auto_flowlabel            VNET(ip6_auto_flowlabel)
330 #define V_ip6_auto_linklocal            VNET(ip6_auto_linklocal)
331
332 VNET_DECLARE(int, ip6_use_tempaddr);    /* Whether to use temporary addresses */
333 VNET_DECLARE(int, ip6_prefer_tempaddr); /* Whether to prefer temporary
334                                          * addresses in the source address
335                                          * selection */
336 #define V_ip6_use_tempaddr              VNET(ip6_use_tempaddr)
337 #define V_ip6_prefer_tempaddr           VNET(ip6_prefer_tempaddr)
338
339 VNET_DECLARE(int, ip6_use_defzone);     /* Whether to use the default scope
340                                          * zone when unspecified */
341 #define V_ip6_use_defzone               VNET(ip6_use_defzone)
342
343 VNET_DECLARE (struct pfil_head, inet6_pfil_hook);       /* packet filter hooks */
344 #define V_inet6_pfil_hook       VNET(inet6_pfil_hook)
345 #ifdef IPSTEALTH
346 VNET_DECLARE(int, ip6stealth);
347 #define V_ip6stealth                    VNET(ip6stealth)
348 #endif
349
350 extern struct   pr_usrreqs rip6_usrreqs;
351 struct sockopt;
352
353 struct inpcb;
354
355 int     icmp6_ctloutput(struct socket *, struct sockopt *sopt);
356
357 struct in6_ifaddr;
358 void    ip6_init(void);
359 int     ip6proto_register(short);
360 int     ip6proto_unregister(short);
361
362 void    ip6_input(struct mbuf *);
363 void    ip6_direct_input(struct mbuf *);
364 void    ip6_freepcbopts(struct ip6_pktopts *);
365
366 int     ip6_unknown_opt(u_int8_t *, struct mbuf *, int);
367 int     ip6_get_prevhdr(const struct mbuf *, int);
368 int     ip6_nexthdr(const struct mbuf *, int, int, int *);
369 int     ip6_lasthdr(const struct mbuf *, int, int, int *);
370
371 extern int      (*ip6_mforward)(struct ip6_hdr *, struct ifnet *,
372     struct mbuf *);
373
374 int     ip6_process_hopopts(struct mbuf *, u_int8_t *, int, u_int32_t *,
375                                  u_int32_t *);
376 struct mbuf     **ip6_savecontrol_v4(struct inpcb *, struct mbuf *,
377             struct mbuf **, int *);
378 void    ip6_savecontrol(struct inpcb *, struct mbuf *, struct mbuf **);
379 void    ip6_notify_pmtu(struct inpcb *, struct sockaddr_in6 *, u_int32_t);
380 int     ip6_sysctl(int *, u_int, void *, size_t *, void *, size_t);
381
382 void    ip6_forward(struct mbuf *, int);
383
384 void    ip6_mloopback(struct ifnet *, struct mbuf *);
385 int     ip6_output(struct mbuf *, struct ip6_pktopts *,
386                         struct route_in6 *,
387                         int,
388                         struct ip6_moptions *, struct ifnet **,
389                         struct inpcb *);
390 int     ip6_ctloutput(struct socket *, struct sockopt *);
391 int     ip6_raw_ctloutput(struct socket *, struct sockopt *);
392 void    ip6_initpktopts(struct ip6_pktopts *);
393 int     ip6_setpktopts(struct mbuf *, struct ip6_pktopts *,
394         struct ip6_pktopts *, struct ucred *, int);
395 void    ip6_clearpktopts(struct ip6_pktopts *, int);
396 struct ip6_pktopts *ip6_copypktopts(struct ip6_pktopts *, int);
397 int     ip6_optlen(struct inpcb *);
398 int     ip6_deletefraghdr(struct mbuf *, int, int);
399 int     ip6_fragment(struct ifnet *, struct mbuf *, int, u_char, int,
400                         uint32_t);
401
402 int     route6_input(struct mbuf **, int *, int);
403
404 void    frag6_init(void);
405 int     frag6_input(struct mbuf **, int *, int);
406 void    frag6_slowtimo(void);
407 void    frag6_drain(void);
408
409 void    rip6_init(void);
410 int     rip6_input(struct mbuf **, int *, int);
411 void    rip6_ctlinput(int, struct sockaddr *, void *);
412 int     rip6_ctloutput(struct socket *, struct sockopt *);
413 int     rip6_output(struct mbuf *, struct socket *, ...);
414 int     rip6_usrreq(struct socket *,
415             int, struct mbuf *, struct mbuf *, struct mbuf *, struct thread *);
416
417 int     dest6_input(struct mbuf **, int *, int);
418 int     none_input(struct mbuf **, int *, int);
419
420 int     in6_selectsrc_socket(struct sockaddr_in6 *, struct ip6_pktopts *,
421     struct inpcb *, struct ucred *, int, struct in6_addr *, int *);
422 int     in6_selectsrc_addr(uint32_t, const struct in6_addr *,
423     uint32_t, struct ifnet *, struct in6_addr *, int *);
424 int in6_selectroute(struct sockaddr_in6 *, struct ip6_pktopts *,
425         struct ip6_moptions *, struct route_in6 *, struct ifnet **,
426         struct rtentry **);
427 int     in6_selectroute_fib(struct sockaddr_in6 *, struct ip6_pktopts *,
428             struct ip6_moptions *, struct route_in6 *, struct ifnet **,
429             struct rtentry **, u_int);
430 u_int32_t ip6_randomid(void);
431 u_int32_t ip6_randomflowlabel(void);
432 void in6_delayed_cksum(struct mbuf *m, uint32_t plen, u_short offset);
433 #endif /* _KERNEL */
434
435 #endif /* !_NETINET6_IP6_VAR_H_ */