sys/netinet/ip6.h

   1 /*      $FreeBSD: src/sys/netinet/ip6.h,v 1.2.2.2 2001/07/03 11:01:46 ume Exp $ */
   2 /*      $DragonFly: src/sys/netinet/ip6.h,v 1.8 2008/09/04 09:08:22 hasso Exp $ */
   3 /*      $KAME: ip6.h,v 1.18 2001/03/29 05:34:30 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.h        8.1 (Berkeley) 6/10/93
  67  */
  68
  69 #ifndef _NETINET_IP6_H_
  70 #define _NETINET_IP6_H_
  71
  72 #ifndef _SYS_TYPES_H_
  73 #include <sys/types.h>
  74 #endif
  75 #ifndef _NETINET_IN_H_
  76 #include <netinet/in.h>
  77 #endif
  78 #ifndef _MACHINE_ENDIAN_H_
  79 #include <machine/endian.h>
  80 #endif
  81
  82
  83 /*
  84  * Definition for internet protocol version 6.
  85  * RFC 2460
  86  */
  87
  88 struct ip6_hdr {
  89         union {
  90                 struct ip6_hdrctl {
  91                         u_int32_t ip6_un1_flow; /* 20 bits of flow-ID */
  92                         u_int16_t ip6_un1_plen; /* payload length */
  93                         u_int8_t  ip6_un1_nxt;  /* next header */
  94                         u_int8_t  ip6_un1_hlim; /* hop limit */
  95                 } ip6_un1;
  96                 u_int8_t ip6_un2_vfc;   /* 4 bits version, top 4 bits class */
  97         } ip6_ctlun;
  98         struct in6_addr ip6_src;        /* source address */
  99         struct in6_addr ip6_dst;        /* destination address */
 100 } __attribute__((__packed__));
 101
 102 #define ip6_vfc         ip6_ctlun.ip6_un2_vfc
 103 #define ip6_flow        ip6_ctlun.ip6_un1.ip6_un1_flow
 104 #define ip6_plen        ip6_ctlun.ip6_un1.ip6_un1_plen
 105 #define ip6_nxt         ip6_ctlun.ip6_un1.ip6_un1_nxt
 106 #define ip6_hlim        ip6_ctlun.ip6_un1.ip6_un1_hlim
 107 #define ip6_hops        ip6_ctlun.ip6_un1.ip6_un1_hlim
 108
 109 #define IPV6_VERSION            0x60
 110 #define IPV6_VERSION_MASK       0xf0
 111
 112 #if _BYTE_ORDER == _BIG_ENDIAN
 113 #define IPV6_FLOWINFO_MASK      0x0fffffff      /* flow info (28 bits) */
 114 #define IPV6_FLOWLABEL_MASK     0x000fffff      /* flow label (20 bits) */
 115 #elif _BYTE_ORDER == _LITTLE_ENDIAN
 116 #define IPV6_FLOWINFO_MASK      0xffffff0f      /* flow info (28 bits) */
 117 #define IPV6_FLOWLABEL_MASK     0xffff0f00      /* flow label (20 bits) */
 118 #else
 119 #error "Byte order not implemented"
 120 #endif
 121 #if 1
 122 /* ECN bits proposed by Sally Floyd */
 123 #define IP6TOS_CE               0x01    /* congestion experienced */
 124 #define IP6TOS_ECT              0x02    /* ECN-capable transport */
 125 #endif
 126
 127 /*
 128  * Extension Headers
 129  */
 130
 131 struct  ip6_ext {
 132         u_int8_t ip6e_nxt;
 133         u_int8_t ip6e_len;
 134 } __attribute__((__packed__));
 135
 136 /* Hop-by-Hop options header */
 137 /* XXX should we pad it to force alignment on an 8-byte boundary? */
 138 struct ip6_hbh {
 139         u_int8_t ip6h_nxt;      /* next header */
 140         u_int8_t ip6h_len;      /* length in units of 8 octets */
 141         /* followed by options */
 142 } __attribute__((__packed__));
 143
 144 /* Destination options header */
 145 /* XXX should we pad it to force alignment on an 8-byte boundary? */
 146 struct ip6_dest {
 147         u_int8_t ip6d_nxt;      /* next header */
 148         u_int8_t ip6d_len;      /* length in units of 8 octets */
 149         /* followed by options */
 150 } __attribute__((__packed__));
 151
 152 /* Option types and related macros */
 153 #define IP6OPT_PAD1             0x00    /* 00 0 00000 */
 154 #define IP6OPT_PADN             0x01    /* 00 0 00001 */
 155 #define IP6OPT_JUMBO            0xC2    /* 11 0 00010 = 194 */
 156 #define IP6OPT_NSAP_ADDR        0xC3    /* 11 0 00011 */
 157 #define IP6OPT_TUNNEL_LIMIT     0x04    /* 00 0 00100 */
 158 #define IP6OPT_RTALERT          0x05    /* 00 0 00101 (KAME definition) */
 159
 160 #define IP6OPT_ROUTER_ALERT     0x05    /* 00 0 00101 (RFC3542, recommended) */
 161 #define IP6OPT_RTALERT_LEN      4
 162 #define IP6OPT_RTALERT_MLD      0       /* Datagram contains an MLD message */
 163 #define IP6OPT_RTALERT_RSVP     1       /* Datagram contains an RSVP message */
 164 #define IP6OPT_RTALERT_ACTNET   2       /* contains an Active Networks msg */
 165 #define IP6OPT_MINLEN           2
 166
 167 #define IP6OPT_BINDING_UPDATE   0xc6    /* 11 0 00110 */
 168 #define IP6OPT_BINDING_ACK      0x07    /* 00 0 00111 */
 169 #define IP6OPT_BINDING_REQ      0x08    /* 00 0 01000 */
 170 #define IP6OPT_HOME_ADDRESS     0xc9    /* 11 0 01001 */
 171 #define IP6OPT_EID              0x8a    /* 10 0 01010 */
 172
 173 #define IP6OPT_TYPE(o)          ((o) & 0xC0)
 174 #define IP6OPT_TYPE_SKIP        0x00
 175 #define IP6OPT_TYPE_DISCARD     0x40
 176 #define IP6OPT_TYPE_FORCEICMP   0x80
 177 #define IP6OPT_TYPE_ICMP        0xC0
 178
 179 #define IP6OPT_MUTABLE          0x20
 180
 181 /* Jumbo Payload Option */
 182 struct ip6_opt_jumbo {
 183         u_int8_t ip6oj_type;
 184         u_int8_t ip6oj_len;
 185         u_int8_t ip6oj_jumbo_len[4];
 186 } __attribute__((__packed__));
 187 #define IP6OPT_JUMBO_LEN        6
 188
 189 /* IPv6 options: common part */
 190 struct ip6_opt {
 191         u_int8_t ip6o_type;
 192         u_int8_t ip6o_len;
 193 } __attribute__((__packed__));
 194
 195
 196 /* NSAP Address Option */
 197 struct ip6_opt_nsap {
 198         u_int8_t ip6on_type;
 199         u_int8_t ip6on_len;
 200         u_int8_t ip6on_src_nsap_len;
 201         u_int8_t ip6on_dst_nsap_len;
 202         /* followed by source NSAP */
 203         /* followed by destination NSAP */
 204 } __attribute__((__packed__));
 205
 206 /* Tunnel Limit Option */
 207 struct ip6_opt_tunnel {
 208         u_int8_t ip6ot_type;
 209         u_int8_t ip6ot_len;
 210         u_int8_t ip6ot_encap_limit;
 211 } __attribute__((__packed__));
 212
 213 /* Router Alert Option */
 214 struct ip6_opt_router {
 215         u_int8_t ip6or_type;
 216         u_int8_t ip6or_len;
 217         u_int8_t ip6or_value[2];
 218 } __attribute__((__packed__));
 219
 220 /* Router alert values (in network byte order) */
 221 #if BYTE_ORDER == BIG_ENDIAN
 222 #define IP6_ALERT_MLD   0x0000
 223 #define IP6_ALERT_RSVP  0x0001
 224 #define IP6_ALERT_AN    0x0002
 225 #else
 226 #if BYTE_ORDER == LITTLE_ENDIAN
 227 #define IP6_ALERT_MLD   0x0000
 228 #define IP6_ALERT_RSVP  0x0100
 229 #define IP6_ALERT_AN    0x0200
 230 #endif /* LITTLE_ENDIAN */
 231 #endif
 232
 233 /* Routing header */
 234 struct ip6_rthdr {
 235         u_int8_t  ip6r_nxt;     /* next header */
 236         u_int8_t  ip6r_len;     /* length in units of 8 octets */
 237         u_int8_t  ip6r_type;    /* routing type */
 238         u_int8_t  ip6r_segleft; /* segments left */
 239         /* followed by routing type specific data */
 240 } __attribute__((__packed__));
 241
 242 /* Fragment header */
 243 struct ip6_frag {
 244         u_int8_t  ip6f_nxt;             /* next header */
 245         u_int8_t  ip6f_reserved;        /* reserved field */
 246         u_int16_t ip6f_offlg;           /* offset, reserved, and flag */
 247         u_int32_t ip6f_ident;           /* identification */
 248 } __attribute__((__packed__));
 249
 250 #if _BYTE_ORDER == _BIG_ENDIAN
 251 #define IP6F_OFF_MASK           0xfff8  /* mask out offset from _offlg */
 252 #define IP6F_RESERVED_MASK      0x0006  /* reserved bits in ip6f_offlg */
 253 #define IP6F_MORE_FRAG          0x0001  /* more-fragments flag */
 254 #elif _BYTE_ORDER == _LITTLE_ENDIAN
 255 #define IP6F_OFF_MASK           0xf8ff  /* mask out offset from _offlg */
 256 #define IP6F_RESERVED_MASK      0x0600  /* reserved bits in ip6f_offlg */
 257 #define IP6F_MORE_FRAG          0x0100  /* more-fragments flag */
 258 #else
 259 #error "Byte order not implemented"
 260 #endif
 261
 262 /*
 263  * Internet implementation parameters.
 264  */
 265 #define IPV6_MAXHLIM    255     /* maximun hoplimit */
 266 #define IPV6_DEFHLIM    64      /* default hlim */
 267 #define IPV6_FRAGTTL    120     /* ttl for fragment packets, in slowtimo tick */
 268 #define IPV6_HLIMDEC    1       /* subtracted when forwaeding */
 269
 270 #define IPV6_MMTU       1280    /* minimal MTU and reassembly. 1024 + 256 */
 271 #define IPV6_MAXPACKET  65535   /* ip6 max packet size without Jumbo payload*/
 272
 273 #ifdef _KERNEL
 274 /*
 275  * IP6_EXTHDR_CHECK ensures that region between the IP6 header and the
 276  * target header (including IPv6 itself, extension headers and
 277  * TCP/UDP/ICMP6 headers) are continuous. KAME requires drivers
 278  * to store incoming data into one internal mbuf or one or more external
 279  * mbufs(never into two or more internal mbufs). Thus, the third case is
 280  * supposed to never be matched but is prepared just in case.
 281  */
 282
 283 #define IP6_EXTHDR_CHECK(m, off, hlen, ret)                             \
 284 do {                                                                    \
 285     if ((m)->m_next != NULL) {                                          \
 286         if (((m)->m_flags & M_LOOP) &&                                  \
 287             ((m)->m_len < (off) + (hlen)) &&                            \
 288             (((m) = m_pullup((m), (off) + (hlen))) == NULL)) {          \
 289                 ip6stat.ip6s_exthdrtoolong++;                           \
 290                 return ret;                                             \
 291         } else if ((m)->m_flags & M_EXT) {                              \
 292                 if ((m)->m_len < (off) + (hlen)) {                      \
 293                         ip6stat.ip6s_exthdrtoolong++;                   \
 294                         m_freem(m);                                     \
 295                         return ret;                                     \
 296                 }                                                       \
 297         } else {                                                        \
 298                 if ((m)->m_len < (off) + (hlen)) {                      \
 299                         ip6stat.ip6s_exthdrtoolong++;                   \
 300                         m_freem(m);                                     \
 301                         return ret;                                     \
 302                 }                                                       \
 303         }                                                               \
 304     } else {                                                            \
 305         if ((m)->m_len < (off) + (hlen)) {                              \
 306                 ip6stat.ip6s_tooshort++;                                \
 307                 in6_ifstat_inc(m->m_pkthdr.rcvif, ifs6_in_truncated);   \
 308                 m_freem(m);                                             \
 309                 return ret;                                             \
 310         }                                                               \
 311     }                                                                   \
 312 } while (0)
 313
 314 #define IP6_EXTHDR_CHECK_VOIDRET(m, off, hlen)          \
 315         IP6_EXTHDR_CHECK(m, off, hlen, )
 316
 317 /*
 318  * IP6_EXTHDR_GET ensures that intermediate protocol header (from "off" to
 319  * "len") is located in single mbuf, on contiguous memory region.
 320  * The pointer to the region will be returned to pointer variable "val",
 321  * with type "typ".
 322  * IP6_EXTHDR_GET0 does the same, except that it aligns the structure at the
 323  * very top of mbuf.  GET0 is likely to make memory copy than GET.
 324  *
 325  * XXX we're now testing this, needs m_pulldown()
 326  */
 327 #define IP6_EXTHDR_GET(val, typ, m, off, len) \
 328 do {                                                                    \
 329         struct mbuf *t;                                                 \
 330         int tmp;                                                        \
 331         if ((m)->m_len >= (off) + (len))                                \
 332                 (val) = (typ)(mtod((m), caddr_t) + (off));              \
 333         else {                                                          \
 334                 t = m_pulldown((m), (off), (len), &tmp);                \
 335                 if (t) {                                                \
 336                         if (t->m_len < tmp + (len))                     \
 337                                 panic("m_pulldown malfunction");        \
 338                         (val) = (typ)(mtod(t, caddr_t) + tmp);          \
 339                 } else {                                                \
 340                         (val) = (typ)NULL;                              \
 341                         (m) = NULL;                                     \
 342                 }                                                       \
 343         }                                                               \
 344 } while (0)
 345
 346 #define IP6_EXTHDR_GET0(val, typ, m, off, len) \
 347 do {                                                                    \
 348         struct mbuf *t;                                                 \
 349         if ((off) == 0)                                                 \
 350                 (val) = (typ)mtod(m, caddr_t);                          \
 351         else {                                                          \
 352                 t = m_pulldown((m), (off), (len), NULL);                \
 353                 if (t) {                                                \
 354                         if (t->m_len < (len))                           \
 355                                 panic("m_pulldown malfunction");        \
 356                         (val) = (typ)mtod(t, caddr_t);                  \
 357                 } else {                                                \
 358                         (val) = (typ)NULL;                              \
 359                         (m) = NULL;                                     \
 360                 }                                                       \
 361         }                                                               \
 362 } while (0)
 363 #endif /*_KERNEL*/
 364
 365 #endif /* not _NETINET_IP6_H_ */