sys/netinet6/ip6_var.h

   1 /*      $NetBSD: ip6_var.h,v 1.52 2009/03/23 18:43:20 liamjfoy Exp $    */
   2 /*      $KAME: ip6_var.h,v 1.33 2000/06/11 14:59:20 jinmei Exp $        */
   3
   4 /*
   5  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of the project nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 /*
  34  * Copyright (c) 1982, 1986, 1993
  35  *      The Regents of the University of California.  All rights reserved.
  36  *
  37  * Redistribution and use in source and binary forms, with or without
  38  * modification, are permitted provided that the following conditions
  39  * are met:
  40  * 1. Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  * 2. Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in the
  44  *    documentation and/or other materials provided with the distribution.
  45  * 3. Neither the name of the University nor the names of its contributors
  46  *    may be used to endorse or promote products derived from this software
  47  *    without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59  * SUCH DAMAGE.
  60  *
  61  *      @(#)ip_var.h    8.1 (Berkeley) 6/10/93
  62  */
  63
  64 #ifndef _NETINET6_IP6_VAR_H_
  65 #define _NETINET6_IP6_VAR_H_
  66
  67 #include <sys/socketvar.h>
  68 #include <net/route.h>
  69
  70 /*
  71  * IP6 reassembly queue structure.  Each fragment
  72  * being reassembled is attached to one of these structures.
  73  */
  74 struct  ip6q {
  75         u_int32_t       ip6q_head;
  76         u_int16_t       ip6q_len;
  77         u_int8_t        ip6q_nxt;       /* ip6f_nxt in first fragment */
  78         u_int8_t        ip6q_hlim;
  79         struct ip6asfrag *ip6q_down;
  80         struct ip6asfrag *ip6q_up;
  81         u_int32_t       ip6q_ident;
  82         u_int8_t        ip6q_arrive;
  83         u_int8_t        ip6q_ttl;
  84         struct in6_addr ip6q_src, ip6q_dst;
  85         struct ip6q     *ip6q_next;
  86         struct ip6q     *ip6q_prev;
  87         int             ip6q_unfrglen;  /* len of unfragmentable part */
  88 #ifdef notyet
  89         u_char          *ip6q_nxtp;
  90 #endif
  91         int             ip6q_nfrag;     /* # of fragments */
  92 };
  93
  94 struct  ip6asfrag {
  95         u_int32_t       ip6af_head;
  96         u_int16_t       ip6af_len;
  97         u_int8_t        ip6af_nxt;
  98         u_int8_t        ip6af_hlim;
  99         /* must not override the above members during reassembling */
 100         struct ip6asfrag *ip6af_down;
 101         struct ip6asfrag *ip6af_up;
 102         struct mbuf     *ip6af_m;
 103         int             ip6af_offset;   /* offset in ip6af_m to next header */
 104         int             ip6af_frglen;   /* fragmentable part length */
 105         int             ip6af_off;      /* fragment offset */
 106         u_int16_t       ip6af_mff;      /* more fragment bit in frag off */
 107 };
 108
 109 #define IP6_REASS_MBUF(ip6af) ((ip6af)->ip6af_m)
 110
 111 struct  ip6_moptions {
 112         struct  ifnet *im6o_multicast_ifp; /* ifp for outgoing multicasts */
 113         u_char  im6o_multicast_hlim;    /* hoplimit for outgoing multicasts */
 114         u_char  im6o_multicast_loop;    /* 1 >= hear sends if a member */
 115         LIST_HEAD(, in6_multi_mship) im6o_memberships;
 116 };
 117
 118 /*
 119  * Control options for outgoing packets
 120  */
 121
 122 /* Routing header related info */
 123 struct  ip6po_rhinfo {
 124         struct  ip6_rthdr *ip6po_rhi_rthdr; /* Routing header */
 125         struct  route ip6po_rhi_route; /* Route to the 1st hop */
 126 };
 127 #define ip6po_rthdr     ip6po_rhinfo.ip6po_rhi_rthdr
 128 #define ip6po_route     ip6po_rhinfo.ip6po_rhi_route
 129
 130 /* Nexthop related info */
 131 struct  ip6po_nhinfo {
 132         struct  sockaddr *ip6po_nhi_nexthop;
 133         struct  route ip6po_nhi_route; /* Route to the nexthop */
 134 };
 135 #define ip6po_nexthop   ip6po_nhinfo.ip6po_nhi_nexthop
 136 #define ip6po_nextroute ip6po_nhinfo.ip6po_nhi_route
 137
 138 struct  ip6_pktopts {
 139         int     ip6po_hlim;             /* Hoplimit for outgoing packets */
 140         struct  in6_pktinfo *ip6po_pktinfo; /* Outgoing IF/address information */
 141         struct  ip6po_nhinfo ip6po_nhinfo; /* Next-hop address information */
 142         struct  ip6_hbh *ip6po_hbh; /* Hop-by-Hop options header */
 143         struct  ip6_dest *ip6po_dest1; /* Destination options header(1st part) */
 144         struct  ip6po_rhinfo ip6po_rhinfo; /* Routing header related info. */
 145         struct  ip6_dest *ip6po_dest2; /* Destination options header(2nd part) */
 146         int     ip6po_tclass;   /* traffic class */
 147         int     ip6po_minmtu;  /* fragment vs PMTU discovery policy */
 148 #define IP6PO_MINMTU_MCASTONLY  -1 /* default; send at min MTU for multicast*/
 149 #define IP6PO_MINMTU_DISABLE     0 /* always perform pmtu disc */
 150 #define IP6PO_MINMTU_ALL         1 /* always send at min MTU */
 151         int ip6po_flags;
 152 #if 0   /* parameters in this block is obsolete. do not reuse the values. */
 153 #define IP6PO_REACHCONF 0x01    /* upper-layer reachability confirmation. */
 154 #define IP6PO_MINMTU    0x02    /* use minimum MTU (IPV6_USE_MIN_MTU) */
 155 #endif
 156 #define IP6PO_DONTFRAG  0x04    /* disable fragmentation (IPV6_DONTFRAG) */
 157 };
 158
 159 /*
 160  * IPv6 statistics.
 161  * Each counter is an unsigned 64-bit value.
 162  */
 163 #define IP6_STAT_TOTAL          0       /* total packets received */
 164 #define IP6_STAT_TOOSHORT       1       /* packet too short */
 165 #define IP6_STAT_TOOSMALL       2       /* not enough data */
 166 #define IP6_STAT_FRAGMENTS      3       /* fragments received */
 167 #define IP6_STAT_FRAGDROPPED    4       /* frags dropped (dups, out of space) */
 168 #define IP6_STAT_FRAGTIMEOUT    5       /* fragments timed out */
 169 #define IP6_STAT_FRAGOVERFLOW   6       /* fragments that exceed limit */
 170 #define IP6_STAT_FORWARD        7       /* packets forwarded */
 171 #define IP6_STAT_CANTFORWARD    8       /* packets rcvd for uncreachable dst */
 172 #define IP6_STAT_REDIRECTSENT   9       /* packets forwarded on same net */
 173 #define IP6_STAT_DELIVERED      10      /* datagrams delivered to upper level */
 174 #define IP6_STAT_LOCALOUT       11      /* total IP packets generated here */
 175 #define IP6_STAT_ODROPPED       12      /* lost packets due to nobufs, etc. */
 176 #define IP6_STAT_REASSEMBLED    13      /* total packets reassembled ok */
 177 #define IP6_STAT_FRAGMENTED     14      /* datagrams successfully fragmented */
 178 #define IP6_STAT_OFRAGMENTS     15      /* output fragments created */
 179 #define IP6_STAT_CANTFRAG       16      /* don't fragment flag was set, etc. */
 180 #define IP6_STAT_BADOPTIONS     17      /* error in option processing */
 181 #define IP6_STAT_NOROUTE        18      /* packets discarded due to no route */
 182 #define IP6_STAT_BADVERS        19      /* ip6 version != 6 */
 183 #define IP6_STAT_RAWOUT         20      /* total raw ip packets generated */
 184 #define IP6_STAT_BADSCOPE       21      /* scope error */
 185 #define IP6_STAT_NOTMEMBER      22      /* don't join this multicast group */
 186 #define IP6_STAT_NXTHIST        23      /* next header histogram */
 187                 /* space for 256 counters */
 188 #define IP6_STAT_M1             279     /* one mbuf */
 189 #define IP6_STAT_M2M            280     /* two or more mbuf */
 190                 /* space for 32 counters */
 191 #define IP6_STAT_MEXT1          312     /* one ext mbuf */
 192 #define IP6_STAT_MEXT2M         313     /* two or more ext mbuf */
 193 #define IP6_STAT_EXTHDRTOOLONG  314     /* ext hdr are not contiguous */
 194 #define IP6_STAT_NOGIF          315     /* no match gif found */
 195 #define IP6_STAT_TOOMANYHDR     316     /* discarded due to too many headers */
 196         /*
 197          * statistics for improvement of the source address selection
 198          * algorithm:
 199          * XXX: hardcoded 16 = # of ip6 multicast scope types + 1
 200          */
 201 #define IP6_STAT_SOURCES_NONE   317     /* number of times that address
 202                                            selection fails */
 203 #define IP6_STAT_SOURCES_SAMEIF 318     /* number of times that an address
 204                                            on the outgoing I/F is chosen */
 205                 /* space for 16 counters */
 206 #define IP6_STAT_SOURCES_OTHERIF 334    /* number of times that an address on
 207                                            a non-outgoing I/F is chosen */
 208                 /* space for 16 counters */
 209 #define IP6_STAT_SOURCES_SAMESCOPE 350  /* number of times that an address that
 210                                            has the same scope from the dest.
 211                                            is chosen */
 212                 /* space for 16 counters */
 213 #define IP6_STAT_SOURCES_OTHERSCOPE 366 /* number of times that an address that
 214                                            has a different scope from the dest.
 215                                            is chosen */
 216                 /* space for 16 counters */
 217 #define IP6_STAT_SOURCES_DEPRECATED 382 /* number of times that a deprecated
 218                                            address is chosen */
 219                 /* space for 16 counters */
 220 #define IP6_STAT_FORWARD_CACHEHIT 398
 221 #define IP6_STAT_FORWARD_CACHEMISS 399
 222 #define IP6_STAT_FASTFORWARD    400     /* packets fast forwarded */
 223 #define IP6_STAT_FASTFORWARDFLOWS 401   /* number of fast forward flows */
 224
 225 #define IP6_NSTATS              402
 226
 227 #define IP6FLOW_HASHBITS         6 /* should not be a multiple of 8 */
 228
 229 /*
 230  * Structure for an IPv6 flow (ip6_fastforward).
 231  */
 232 struct ip6flow {
 233         LIST_ENTRY(ip6flow) ip6f_list;  /* next in active list */
 234         LIST_ENTRY(ip6flow) ip6f_hash;  /* next ip6flow in bucket */
 235         struct in6_addr ip6f_dst;       /* destination address */
 236         struct in6_addr ip6f_src;       /* source address */
 237         struct route ip6f_ro;       /* associated route entry */
 238         u_int32_t ip6f_flow;            /* flow (tos) */
 239         u_quad_t ip6f_uses;               /* number of uses in this period */
 240         u_quad_t ip6f_last_uses;          /* number of uses in last period */
 241         u_quad_t ip6f_dropped;            /* ENOBUFS returned by if_output */
 242         u_quad_t ip6f_forwarded;          /* packets forwarded */
 243         u_int ip6f_timer;               /* lifetime timer */
 244         time_t ip6f_start;              /* creation time */
 245 };
 246
 247 #ifdef _KERNEL
 248 /*
 249  * Auxiliary attributes of incoming IPv6 packets, which is initialized when we
 250  * come into ip6_input().
 251  * XXX do not make it a kitchen sink!
 252  */
 253 struct ip6aux {
 254         /* ip6.ip6_dst */
 255         struct in6_addr ip6a_src;
 256         uint32_t        ip6a_scope_id;
 257         int             ip6a_flags;
 258 };
 259
 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 extern u_int32_t ip6_id;                /* fragment identifier */
 266 extern int      ip6_defhlim;            /* default hop limit */
 267 extern int      ip6_defmcasthlim;       /* default multicast hop limit */
 268 extern int      ip6_forwarding;         /* act as router? */
 269 extern int      ip6_sendredirect;       /* send ICMPv6 redirect? */
 270 extern int      ip6_forward_srcrt;      /* forward src-routed? */
 271 extern int      ip6_use_deprecated;     /* allow deprecated addr as source */
 272 extern int      ip6_rr_prune;           /* router renumbering prefix
 273                                          * walk list every 5 sec.    */
 274 extern int      ip6_mcast_pmtu;         /* enable pMTU discovery for multicast? */
 275 extern int      ip6_v6only;
 276
 277 extern struct socket *ip6_mrouter;      /* multicast routing daemon */
 278 extern int      ip6_sendredirects;      /* send IP redirects when forwarding? */
 279 extern int      ip6_maxfragpackets; /* Maximum packets in reassembly queue */
 280 extern int      ip6_maxfrags;   /* Maximum fragments in reassembly queue */
 281 extern int      ip6_sourcecheck;        /* Verify source interface */
 282 extern int      ip6_sourcecheck_interval; /* Interval between log messages */
 283 extern int      ip6_accept_rtadv;       /* Acts as a host not a router */
 284 extern int      ip6_keepfaith;          /* Firewall Aided Internet Translator */
 285 extern int      ip6_log_interval;
 286 extern time_t   ip6_log_time;
 287 extern int      ip6_hdrnestlimit; /* upper limit of # of extension headers */
 288 extern int      ip6_dad_count;          /* DupAddrDetectionTransmits */
 289
 290 extern int ip6_auto_flowlabel;
 291 extern int ip6_auto_linklocal;
 292
 293 extern int   ip6_anonportmin;           /* minimum ephemeral port */
 294 extern int   ip6_anonportmax;           /* maximum ephemeral port */
 295 extern int   ip6_lowportmin;            /* minimum reserved port */
 296 extern int   ip6_lowportmax;            /* maximum reserved port */
 297
 298 extern int      ip6_use_tempaddr; /* whether to use temporary addresses. */
 299 extern int      ip6_prefer_tempaddr; /* whether to prefer temporary addresses
 300                                         in the source address selection */
 301 extern int      ip6_use_defzone; /* whether to use the default scope zone
 302                                     when unspecified */
 303
 304 #ifdef GATEWAY
 305 extern int      ip6_maxflows;           /* maximum amount of flows for ip6ff */
 306 extern int      ip6_hashsize;           /* size of hash table */
 307 #endif
 308
 309 struct in6pcb;
 310
 311 int     icmp6_ctloutput(int, struct socket *, struct sockopt *);
 312
 313 void    ip6_init(void);
 314 void    ip6intr(void);
 315 void    ip6_input(struct mbuf *);
 316 const struct ip6aux *ip6_getdstifaddr(struct mbuf *);
 317 void    ip6_freepcbopts(struct ip6_pktopts *);
 318 void    ip6_freemoptions(struct ip6_moptions *);
 319 int     ip6_unknown_opt(u_int8_t *, struct mbuf *, int);
 320 u_int8_t *ip6_get_prevhdr(struct mbuf *, int);
 321 int     ip6_nexthdr(struct mbuf *, int, int, int *);
 322 int     ip6_lasthdr(struct mbuf *, int, int, int *);
 323
 324 struct m_tag *ip6_addaux(struct mbuf *);
 325 struct m_tag *ip6_findaux(struct mbuf *);
 326 void    ip6_delaux(struct mbuf *);
 327
 328 int     ip6_mforward(struct ip6_hdr *, struct ifnet *, struct mbuf *);
 329 int     ip6_process_hopopts(struct mbuf *, u_int8_t *, int, u_int32_t *,
 330                                  u_int32_t *);
 331 void    ip6_savecontrol(struct in6pcb *, struct mbuf **, struct ip6_hdr *,
 332                 struct mbuf *);
 333 void    ip6_notify_pmtu(struct in6pcb *, const struct sockaddr_in6 *,
 334                 u_int32_t *);
 335 int     ip6_sysctl(int *, u_int, void *, size_t *, void *, size_t);
 336
 337 void    ip6_forward(struct mbuf *, int);
 338
 339 void    ip6_mloopback(struct ifnet *, struct mbuf *,
 340                       const struct sockaddr_in6 *);
 341 int     ip6_output(struct mbuf *, struct ip6_pktopts *,
 342                         struct route *, int,
 343                         struct ip6_moptions *, struct socket *,
 344                         struct ifnet **);
 345 int     ip6_ctloutput(int, struct socket *, struct sockopt *);
 346 int     ip6_raw_ctloutput(int, struct socket *, struct sockopt *);
 347 void    ip6_initpktopts(struct ip6_pktopts *);
 348 int     ip6_setpktopts(struct mbuf *, struct ip6_pktopts *,
 349                             struct ip6_pktopts *, kauth_cred_t, int);
 350 void    ip6_clearpktopts(struct ip6_pktopts *, int);
 351 struct ip6_pktopts *ip6_copypktopts(struct ip6_pktopts *, int);
 352 int     ip6_optlen(struct in6pcb *);
 353
 354 void    ip6_statinc(u_int);
 355
 356 int     route6_input(struct mbuf **, int *, int);
 357
 358 void    frag6_init(void);
 359 int     frag6_input(struct mbuf **, int *, int);
 360 void    frag6_slowtimo(void);
 361 void    frag6_drain(void);
 362
 363 int     ip6flow_init(int);
 364 void    ip6flow_poolinit(void);
 365 struct  ip6flow *ip6flow_reap(int);
 366 void    ip6flow_create(const struct route *, struct mbuf *);
 367 void    ip6flow_slowtimo(void);
 368 int     ip6flow_invalidate_all(int);
 369
 370 void    rip6_init(void);
 371 int     rip6_input(struct mbuf **, int *, int);
 372 void    *rip6_ctlinput(int, const struct sockaddr *, void *);
 373 int     rip6_ctloutput(int, struct socket *, struct sockopt *);
 374 int     rip6_output(struct mbuf *, struct socket *, struct sockaddr_in6 *,
 375                          struct mbuf *);
 376 int     rip6_usrreq(struct socket *,
 377             int, struct mbuf *, struct mbuf *, struct mbuf *, struct lwp *);
 378
 379 int     dest6_input(struct mbuf **, int *, int);
 380 int     none_input(struct mbuf **, int *, int);
 381
 382 struct route;
 383
 384 struct  in6_addr *in6_selectsrc(struct sockaddr_in6 *,
 385         struct ip6_pktopts *, struct ip6_moptions *, struct route *,
 386         struct in6_addr *, struct ifnet **, int *);
 387 int in6_selectroute(struct sockaddr_in6 *, struct ip6_pktopts *,
 388         struct ip6_moptions *, struct route *, struct ifnet **,
 389         struct rtentry **, int);
 390
 391 u_int32_t ip6_randomid(void);
 392 u_int32_t ip6_randomflowlabel(void);
 393 #endif /* _KERNEL */
 394
 395 #endif /* !_NETINET6_IP6_VAR_H_ */