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