bsd/netinet/ip6.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*      $KAME: ip6.h,v 1.18 2001/03/29 05:34:30 itojun Exp $*/
  24
  25 /*
  26  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
  27  * All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  * 1. Redistributions of source code must retain the above copyright
  33  *    notice, this list of conditions and the following disclaimer.
  34  * 2. Redistributions in binary form must reproduce the above copyright
  35  *    notice, this list of conditions and the following disclaimer in the
  36  *    documentation and/or other materials provided with the distribution.
  37  * 3. Neither the name of the project nor the names of its contributors
  38  *    may be used to endorse or promote products derived from this software
  39  *    without specific prior written permission.
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  */
  53
  54 /*
  55  * Copyright (c) 1982, 1986, 1993
  56  *      The Regents of the University of California.  All rights reserved.
  57  *
  58  * Redistribution and use in source and binary forms, with or without
  59  * modification, are permitted provided that the following conditions
  60  * are met:
  61  * 1. Redistributions of source code must retain the above copyright
  62  *    notice, this list of conditions and the following disclaimer.
  63  * 2. Redistributions in binary form must reproduce the above copyright
  64  *    notice, this list of conditions and the following disclaimer in the
  65  *    documentation and/or other materials provided with the distribution.
  66  * 3. All advertising materials mentioning features or use of this software
  67  *    must display the following acknowledgement:
  68  *      This product includes software developed by the University of
  69  *      California, Berkeley and its contributors.
  70  * 4. Neither the name of the University nor the names of its contributors
  71  *    may be used to endorse or promote products derived from this software
  72  *    without specific prior written permission.
  73  *
  74  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  75  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  76  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  77  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  78  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  79  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  80  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  81  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  82  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  83  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  84  * SUCH DAMAGE.
  85  *
  86  *      @(#)ip.h        8.1 (Berkeley) 6/10/93
  87  */
  88
  89 #ifndef _NETINET_IP6_H_
  90 #define _NETINET_IP6_H_
  91 #include <sys/appleapiopts.h>
  92
  93 /*
  94  * Definition for internet protocol version 6.
  95  * RFC 2460
  96  */
  97
  98 struct ip6_hdr {
  99         union {
 100                 struct ip6_hdrctl {
 101                         u_int32_t ip6_un1_flow; /* 20 bits of flow-ID */
 102                         u_int16_t ip6_un1_plen; /* payload length */
 103                         u_int8_t  ip6_un1_nxt;  /* next header */
 104                         u_int8_t  ip6_un1_hlim; /* hop limit */
 105                 } ip6_un1;
 106                 u_int8_t ip6_un2_vfc;   /* 4 bits version, top 4 bits class */
 107         } ip6_ctlun;
 108         struct in6_addr ip6_src;        /* source address */
 109         struct in6_addr ip6_dst;        /* destination address */
 110 } __attribute__((__packed__));
 111
 112 #define ip6_vfc         ip6_ctlun.ip6_un2_vfc
 113 #define ip6_flow        ip6_ctlun.ip6_un1.ip6_un1_flow
 114 #define ip6_plen        ip6_ctlun.ip6_un1.ip6_un1_plen
 115 #define ip6_nxt         ip6_ctlun.ip6_un1.ip6_un1_nxt
 116 #define ip6_hlim        ip6_ctlun.ip6_un1.ip6_un1_hlim
 117 #define ip6_hops        ip6_ctlun.ip6_un1.ip6_un1_hlim
 118
 119 #define IPV6_VERSION            0x60
 120 #define IPV6_VERSION_MASK       0xf0
 121
 122 #if BYTE_ORDER == BIG_ENDIAN
 123 #define IPV6_FLOWINFO_MASK      0x0fffffff      /* flow info (28 bits) */
 124 #define IPV6_FLOWLABEL_MASK     0x000fffff      /* flow label (20 bits) */
 125 #else
 126 #if BYTE_ORDER == LITTLE_ENDIAN
 127 #define IPV6_FLOWINFO_MASK      0xffffff0f      /* flow info (28 bits) */
 128 #define IPV6_FLOWLABEL_MASK     0xffff0f00      /* flow label (20 bits) */
 129 #endif /* LITTLE_ENDIAN */
 130 #endif
 131 #if 1
 132 /* ECN bits proposed by Sally Floyd */
 133 #define IP6TOS_CE               0x01    /* congestion experienced */
 134 #define IP6TOS_ECT              0x02    /* ECN-capable transport */
 135 #endif
 136
 137 /*
 138  * Extension Headers
 139  */
 140
 141 struct  ip6_ext {
 142         u_int8_t ip6e_nxt;
 143         u_int8_t ip6e_len;
 144 } __attribute__((__packed__));
 145
 146 /* Hop-by-Hop options header */
 147 /* XXX should we pad it to force alignment on an 8-byte boundary? */
 148 struct ip6_hbh {
 149         u_int8_t ip6h_nxt;      /* next header */
 150         u_int8_t ip6h_len;      /* length in units of 8 octets */
 151         /* followed by options */
 152 } __attribute__((__packed__));
 153
 154 /* Destination options header */
 155 /* XXX should we pad it to force alignment on an 8-byte boundary? */
 156 struct ip6_dest {
 157         u_int8_t ip6d_nxt;      /* next header */
 158         u_int8_t ip6d_len;      /* length in units of 8 octets */
 159         /* followed by options */
 160 } __attribute__((__packed__));
 161
 162 /* Option types and related macros */
 163 #define IP6OPT_PAD1             0x00    /* 00 0 00000 */
 164 #define IP6OPT_PADN             0x01    /* 00 0 00001 */
 165 #define IP6OPT_JUMBO            0xC2    /* 11 0 00010 = 194 */
 166 #define IP6OPT_NSAP_ADDR        0xC3    /* 11 0 00011 */
 167 #define IP6OPT_TUNNEL_LIMIT     0x04    /* 00 0 00100 */
 168 #define IP6OPT_RTALERT          0x05    /* 00 0 00101 (KAME definition) */
 169
 170 #define IP6OPT_RTALERT_LEN      4
 171 #define IP6OPT_RTALERT_MLD      0       /* Datagram contains an MLD message */
 172 #define IP6OPT_RTALERT_RSVP     1       /* Datagram contains an RSVP message */
 173 #define IP6OPT_RTALERT_ACTNET   2       /* contains an Active Networks msg */
 174 #define IP6OPT_MINLEN           2
 175
 176 #define IP6OPT_BINDING_UPDATE   0xc6    /* 11 0 00110 */
 177 #define IP6OPT_BINDING_ACK      0x07    /* 00 0 00111 */
 178 #define IP6OPT_BINDING_REQ      0x08    /* 00 0 01000 */
 179 #define IP6OPT_HOME_ADDRESS     0xc9    /* 11 0 01001 */
 180 #define IP6OPT_EID              0x8a    /* 10 0 01010 */
 181
 182 #define IP6OPT_TYPE(o)          ((o) & 0xC0)
 183 #define IP6OPT_TYPE_SKIP        0x00
 184 #define IP6OPT_TYPE_DISCARD     0x40
 185 #define IP6OPT_TYPE_FORCEICMP   0x80
 186 #define IP6OPT_TYPE_ICMP        0xC0
 187
 188 #define IP6OPT_MUTABLE          0x20
 189
 190 #define IP6OPT_JUMBO_LEN        6
 191
 192 /* Routing header */
 193 struct ip6_rthdr {
 194         u_int8_t  ip6r_nxt;     /* next header */
 195         u_int8_t  ip6r_len;     /* length in units of 8 octets */
 196         u_int8_t  ip6r_type;    /* routing type */
 197         u_int8_t  ip6r_segleft; /* segments left */
 198         /* followed by routing type specific data */
 199 } __attribute__((__packed__));
 200
 201 /* Type 0 Routing header */
 202 struct ip6_rthdr0 {
 203         u_int8_t  ip6r0_nxt;            /* next header */
 204         u_int8_t  ip6r0_len;            /* length in units of 8 octets */
 205         u_int8_t  ip6r0_type;           /* always zero */
 206         u_int8_t  ip6r0_segleft;        /* segments left */
 207         u_int8_t  ip6r0_reserved;       /* reserved field */
 208         u_int8_t  ip6r0_slmap[3];       /* strict/loose bit map */
 209         struct in6_addr  ip6r0_addr[1]; /* up to 23 addresses */
 210 } __attribute__((__packed__));
 211
 212 /* Fragment header */
 213 struct ip6_frag {
 214         u_int8_t  ip6f_nxt;             /* next header */
 215         u_int8_t  ip6f_reserved;        /* reserved field */
 216         u_int16_t ip6f_offlg;           /* offset, reserved, and flag */
 217         u_int32_t ip6f_ident;           /* identification */
 218 } __attribute__((__packed__));
 219
 220 #if BYTE_ORDER == BIG_ENDIAN
 221 #define IP6F_OFF_MASK           0xfff8  /* mask out offset from _offlg */
 222 #define IP6F_RESERVED_MASK      0x0006  /* reserved bits in ip6f_offlg */
 223 #define IP6F_MORE_FRAG          0x0001  /* more-fragments flag */
 224 #else /* BYTE_ORDER == LITTLE_ENDIAN */
 225 #define IP6F_OFF_MASK           0xf8ff  /* mask out offset from _offlg */
 226 #define IP6F_RESERVED_MASK      0x0600  /* reserved bits in ip6f_offlg */
 227 #define IP6F_MORE_FRAG          0x0100  /* more-fragments flag */
 228 #endif /* BYTE_ORDER == LITTLE_ENDIAN */
 229
 230 /*
 231  * Internet implementation parameters.
 232  */
 233 #define IPV6_MAXHLIM    255     /* maximun hoplimit */
 234 #define IPV6_DEFHLIM    64      /* default hlim */
 235 #define IPV6_FRAGTTL    120     /* ttl for fragment packets, in slowtimo tick */
 236 #define IPV6_HLIMDEC    1       /* subtracted when forwaeding */
 237
 238 #define IPV6_MMTU       1280    /* minimal MTU and reassembly. 1024 + 256 */
 239 #define IPV6_MAXPACKET  65535   /* ip6 max packet size without Jumbo payload*/
 240
 241 #ifdef KERNEL_PRIVATE
 242 /*
 243  * IP6_EXTHDR_CHECK ensures that region between the IP6 header and the
 244  * target header (including IPv6 itself, extension headers and
 245  * TCP/UDP/ICMP6 headers) are continuous. KAME requires drivers
 246  * to store incoming data into one internal mbuf or one or more external
 247  * mbufs(never into two or more internal mbufs). Thus, the third case is
 248  * supposed to never be matched but is prepared just in case.
 249  */
 250
 251 #define IP6_EXTHDR_CHECK(m, off, hlen, action)                          \
 252 do {                                                                    \
 253     if ((m)->m_next != NULL) {                                          \
 254         if (((m)->m_flags & M_LOOP) &&                                  \
 255             ((m)->m_len < (off) + (hlen)) &&                            \
 256             (((m) = m_pullup((m), (off) + (hlen))) == NULL)) {          \
 257                 ip6stat.ip6s_exthdrtoolong++;                           \
 258                 action;                                                 \
 259         } else if ((m)->m_flags & M_EXT) {                              \
 260                 if ((m)->m_len < (off) + (hlen)) {                      \
 261                         ip6stat.ip6s_exthdrtoolong++;                   \
 262                         m_freem(m);                                     \
 263                         action;                                         \
 264                 }                                                       \
 265         } else {                                                        \
 266                 if ((m)->m_len < (off) + (hlen)) {                      \
 267                         ip6stat.ip6s_exthdrtoolong++;                   \
 268                         m_freem(m);                                     \
 269                         action;                                         \
 270                 }                                                       \
 271         }                                                               \
 272     } else {                                                            \
 273         if ((m)->m_len < (off) + (hlen)) {                              \
 274                 ip6stat.ip6s_tooshort++;                                \
 275                 in6_ifstat_inc(m->m_pkthdr.rcvif, ifs6_in_truncated);   \
 276                 m_freem(m);                                             \
 277                 action;                                                 \
 278         }                                                               \
 279     }                                                                   \
 280 } while (0)
 281
 282 /*
 283  * IP6_EXTHDR_GET ensures that intermediate protocol header (from "off" to
 284  * "len") is located in single mbuf, on contiguous memory region.
 285  * The pointer to the region will be returned to pointer variable "val",
 286  * with type "typ".
 287  * IP6_EXTHDR_GET0 does the same, except that it aligns the structure at the
 288  * very top of mbuf.  GET0 is likely to make memory copy than GET.
 289  *
 290  * XXX we're now testing this, needs m_pulldown()
 291  */
 292 #define IP6_EXTHDR_GET(val, typ, m, off, len) \
 293 do {                                                                    \
 294         struct mbuf *t;                                                 \
 295         int tmp;                                                        \
 296         if ((m)->m_len >= (off) + (len))                                \
 297                 (val) = (typ)(mtod((m), caddr_t) + (off));              \
 298         else {                                                          \
 299                 t = m_pulldown((m), (off), (len), &tmp);                \
 300                 if (t) {                                                \
 301                         if (t->m_len < tmp + (len))                     \
 302                                 panic("m_pulldown malfunction");        \
 303                         (val) = (typ)(mtod(t, caddr_t) + tmp);          \
 304                 } else {                                                \
 305                         (val) = (typ)NULL;                              \
 306                         (m) = NULL;                                     \
 307                 }                                                       \
 308         }                                                               \
 309 } while (0)
 310
 311 #define IP6_EXTHDR_GET0(val, typ, m, off, len) \
 312 do {                                                                    \
 313         struct mbuf *t;                                                 \
 314         if ((off) == 0)                                                 \
 315                 (val) = (typ)mtod(m, caddr_t);                          \
 316         else {                                                          \
 317                 t = m_pulldown((m), (off), (len), NULL);                \
 318                 if (t) {                                                \
 319                         if (t->m_len < (len))                           \
 320                                 panic("m_pulldown malfunction");        \
 321                         (val) = (typ)mtod(t, caddr_t);                  \
 322                 } else {                                                \
 323                         (val) = (typ)NULL;                              \
 324                         (m) = NULL;                                     \
 325                 }                                                       \
 326         }                                                               \
 327 } while (0)
 328
 329 #endif KERNEL_PRIVATE
 330 #endif !_NETINET_IP6_H_