]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/netinet/ip6.h
xnu-7195.101.1.tar.gz
[apple/xnu.git] / bsd / netinet / ip6.h
index c677f2b6a806e46d9a2f64aa10261dff9bc256d9..7024165fb47842489dddaa0cc58d1437482b5ef8 100644 (file)
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2019 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
- * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
- * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*     $KAME: ip6.h,v 1.18 2001/03/29 05:34:30 itojun Exp $*/
 
 
 #ifndef _NETINET_IP6_H_
 #define _NETINET_IP6_H_
+#ifndef DRIVERKIT
 #include <sys/appleapiopts.h>
+#else
+#include <sys/_types.h>
+#include <netinet/in.h>
+#include <machine/endian.h>
+#endif /* DRIVERKIT */
 
 /*
  * Definition for internet protocol version 6.
 struct ip6_hdr {
        union {
                struct ip6_hdrctl {
-                       u_int32_t ip6_un1_flow; /* 20 bits of flow-ID */
-                       u_int16_t ip6_un1_plen; /* payload length */
-                       u_int8_t  ip6_un1_nxt;  /* next header */
-                       u_int8_t  ip6_un1_hlim; /* hop limit */
+                       u_int32_t ip6_un1_flow; /* 20 bits of flow-ID */
+                       u_int16_t ip6_un1_plen; /* payload length */
+                       u_int8_t  ip6_un1_nxt;  /* next header */
+                       u_int8_t  ip6_un1_hlim; /* hop limit */
                } ip6_un1;
-               u_int8_t ip6_un2_vfc;   /* 4 bits version, top 4 bits class */
+               u_int8_t ip6_un2_vfc;   /* 4 bits version, top 4 bits class */
        } ip6_ctlun;
-       struct in6_addr ip6_src;        /* source address */
-       struct in6_addr ip6_dst;        /* destination address */
+       struct in6_addr ip6_src;        /* source address */
+       struct in6_addr ip6_dst;        /* destination address */
 } __attribute__((__packed__));
 
-#define ip6_vfc                ip6_ctlun.ip6_un2_vfc
-#define ip6_flow       ip6_ctlun.ip6_un1.ip6_un1_flow
-#define ip6_plen       ip6_ctlun.ip6_un1.ip6_un1_plen
-#define ip6_nxt                ip6_ctlun.ip6_un1.ip6_un1_nxt
-#define ip6_hlim       ip6_ctlun.ip6_un1.ip6_un1_hlim
-#define ip6_hops       ip6_ctlun.ip6_un1.ip6_un1_hlim
+#define ip6_vfc         ip6_ctlun.ip6_un2_vfc
+#define ip6_flow        ip6_ctlun.ip6_un1.ip6_un1_flow
+#define ip6_plen        ip6_ctlun.ip6_un1.ip6_un1_plen
+#define ip6_nxt         ip6_ctlun.ip6_un1.ip6_un1_nxt
+#define ip6_hlim        ip6_ctlun.ip6_un1.ip6_un1_hlim
+#define ip6_hops        ip6_ctlun.ip6_un1.ip6_un1_hlim
 
-#define IPV6_VERSION           0x60
-#define IPV6_VERSION_MASK      0xf0
+#define IPV6_VERSION            0x60
+#define IPV6_VERSION_MASK       0xf0
 
 #if BYTE_ORDER == BIG_ENDIAN
-#define IPV6_FLOWINFO_MASK     0x0fffffff      /* flow info (28 bits) */
-#define IPV6_FLOWLABEL_MASK    0x000fffff      /* flow label (20 bits) */
+#define IPV6_FLOWINFO_MASK      0x0fffffff      /* flow info (28 bits) */
+#define IPV6_FLOWLABEL_MASK     0x000fffff      /* flow label (20 bits) */
+#define IPV6_FLOW_ECN_MASK      0x00300000      /* the 2 ECN bits */
 #else
 #if BYTE_ORDER == LITTLE_ENDIAN
-#define IPV6_FLOWINFO_MASK     0xffffff0f      /* flow info (28 bits) */
-#define IPV6_FLOWLABEL_MASK    0xffff0f00      /* flow label (20 bits) */
+#define IPV6_FLOWINFO_MASK      0xffffff0f      /* flow info (28 bits) */
+#define IPV6_FLOWLABEL_MASK     0xffff0f00      /* flow label (20 bits) */
+#define IPV6_FLOW_ECN_MASK      0x00003000      /* the 2 ECN bits */
 #endif /* LITTLE_ENDIAN */
 #endif
 #if 1
 /* ECN bits proposed by Sally Floyd */
-#define IP6TOS_CE              0x01    /* congestion experienced */
-#define IP6TOS_ECT             0x02    /* ECN-capable transport */
+#define IP6TOS_CE               0x01    /* congestion experienced */
+#define IP6TOS_ECT              0x02    /* ECN-capable transport */
 #endif
 
+/*
+ * To access the 6 bits of the DSCP value in the 32 bits ip6_flow field
+ */
+#define IP6FLOW_DSCP_MASK       0x0fc00000
+#define IP6FLOW_DSCP_SHIFT      22
+
 /*
  * Extension Headers
  */
 
-struct ip6_ext {
+struct  ip6_ext {
        u_int8_t ip6e_nxt;
        u_int8_t ip6e_len;
 } __attribute__((__packed__));
@@ -145,99 +165,146 @@ struct   ip6_ext {
 /* Hop-by-Hop options header */
 /* XXX should we pad it to force alignment on an 8-byte boundary? */
 struct ip6_hbh {
-       u_int8_t ip6h_nxt;      /* next header */
-       u_int8_t ip6h_len;      /* length in units of 8 octets */
+       u_int8_t ip6h_nxt;      /* next header */
+       u_int8_t ip6h_len;      /* length in units of 8 octets */
        /* followed by options */
 } __attribute__((__packed__));
 
 /* Destination options header */
 /* XXX should we pad it to force alignment on an 8-byte boundary? */
 struct ip6_dest {
-       u_int8_t ip6d_nxt;      /* next header */
-       u_int8_t ip6d_len;      /* length in units of 8 octets */
+       u_int8_t ip6d_nxt;      /* next header */
+       u_int8_t ip6d_len;      /* length in units of 8 octets */
        /* followed by options */
 } __attribute__((__packed__));
 
 /* Option types and related macros */
-#define IP6OPT_PAD1            0x00    /* 00 0 00000 */
-#define IP6OPT_PADN            0x01    /* 00 0 00001 */
-#define IP6OPT_JUMBO           0xC2    /* 11 0 00010 = 194 */
-#define IP6OPT_NSAP_ADDR       0xC3    /* 11 0 00011 */
-#define IP6OPT_TUNNEL_LIMIT    0x04    /* 00 0 00100 */
-#define IP6OPT_RTALERT         0x05    /* 00 0 00101 (KAME definition) */
-
-#define IP6OPT_RTALERT_LEN     4
-#define IP6OPT_RTALERT_MLD     0       /* Datagram contains an MLD message */
-#define IP6OPT_RTALERT_RSVP    1       /* Datagram contains an RSVP message */
-#define IP6OPT_RTALERT_ACTNET  2       /* contains an Active Networks msg */
-#define IP6OPT_MINLEN          2
-
-#define IP6OPT_BINDING_UPDATE  0xc6    /* 11 0 00110 */
-#define IP6OPT_BINDING_ACK     0x07    /* 00 0 00111 */
-#define IP6OPT_BINDING_REQ     0x08    /* 00 0 01000 */
-#define IP6OPT_HOME_ADDRESS    0xc9    /* 11 0 01001 */
-#define IP6OPT_EID             0x8a    /* 10 0 01010 */
-
-#define IP6OPT_TYPE(o)         ((o) & 0xC0)
-#define IP6OPT_TYPE_SKIP       0x00
-#define IP6OPT_TYPE_DISCARD    0x40
-#define IP6OPT_TYPE_FORCEICMP  0x80
-#define IP6OPT_TYPE_ICMP       0xC0
-
-#define IP6OPT_MUTABLE         0x20
-
-#define IP6OPT_JUMBO_LEN       6
+#define IP6OPT_PAD1             0x00    /* 00 0 00000 */
+#define IP6OPT_PADN             0x01    /* 00 0 00001 */
+#define IP6OPT_JUMBO            0xC2    /* 11 0 00010 = 194 */
+#define IP6OPT_NSAP_ADDR        0xC3    /* 11 0 00011 */
+#define IP6OPT_TUNNEL_LIMIT     0x04    /* 00 0 00100 */
+#ifndef KERNEL_PRIVATE
+#define IP6OPT_RTALERT          0x05    /* 00 0 00101 (KAME definition) */
+#endif
+#define IP6OPT_ROUTER_ALERT     0x05    /* 00 0 00101 (RFC3542, recommended) */
+
+#define IP6OPT_RTALERT_LEN      4
+#define IP6OPT_RTALERT_MLD      0       /* Datagram contains an MLD message */
+#define IP6OPT_RTALERT_RSVP     1       /* Datagram contains an RSVP message */
+#define IP6OPT_RTALERT_ACTNET   2       /* contains an Active Networks msg */
+#define IP6OPT_MINLEN           2
+
+#define IP6OPT_EID              0x8a    /* 10 0 01010 */
+
+#define IP6OPT_TYPE(o)          ((o) & 0xC0)
+#define IP6OPT_TYPE_SKIP        0x00
+#define IP6OPT_TYPE_DISCARD     0x40
+#define IP6OPT_TYPE_FORCEICMP   0x80
+#define IP6OPT_TYPE_ICMP        0xC0
+
+#define IP6OPT_MUTABLE          0x20
+
+/* IPv6 options: common part */
+struct ip6_opt {
+       u_int8_t ip6o_type;
+       u_int8_t ip6o_len;
+} __attribute__((__packed__));
+
+/* Jumbo Payload Option */
+struct ip6_opt_jumbo {
+       u_int8_t ip6oj_type;
+       u_int8_t ip6oj_len;
+       u_int8_t ip6oj_jumbo_len[4];
+} __attribute__((__packed__));
+#define IP6OPT_JUMBO_LEN        6
+
+/* NSAP Address Option */
+struct ip6_opt_nsap {
+       u_int8_t ip6on_type;
+       u_int8_t ip6on_len;
+       u_int8_t ip6on_src_nsap_len;
+       u_int8_t ip6on_dst_nsap_len;
+       /* followed by source NSAP */
+       /* followed by destination NSAP */
+}__attribute__((__packed__));
+
+/* Tunnel Limit Option */
+struct ip6_opt_tunnel {
+       u_int8_t ip6ot_type;
+       u_int8_t ip6ot_len;
+       u_int8_t ip6ot_encap_limit;
+}__attribute__((__packed__));
+
+/* Router Alert Option */
+struct ip6_opt_router {
+       u_int8_t ip6or_type;
+       u_int8_t ip6or_len;
+       u_int8_t ip6or_value[2];
+}__attribute__((__packed__));
+/* Router alert values (in network byte order) */
+#if BYTE_ORDER == BIG_ENDIAN
+#define IP6_ALERT_MLD   0x0000
+#define IP6_ALERT_RSVP  0x0001
+#define IP6_ALERT_AN    0x0002
+#else
+#if BYTE_ORDER == LITTLE_ENDIAN
+#define IP6_ALERT_MLD   0x0000
+#define IP6_ALERT_RSVP  0x0100
+#define IP6_ALERT_AN    0x0200
+#endif /* LITTLE_ENDIAN */
+#endif
 
 /* Routing header */
 struct ip6_rthdr {
-       u_int8_t  ip6r_nxt;     /* next header */
-       u_int8_t  ip6r_len;     /* length in units of 8 octets */
-       u_int8_t  ip6r_type;    /* routing type */
-       u_int8_t  ip6r_segleft; /* segments left */
+       u_int8_t  ip6r_nxt;     /* next header */
+       u_int8_t  ip6r_len;     /* length in units of 8 octets */
+       u_int8_t  ip6r_type;    /* routing type */
+       u_int8_t  ip6r_segleft; /* segments left */
        /* followed by routing type specific data */
 } __attribute__((__packed__));
 
-/* Type 0 Routing header */
+/* Type 0 Routing header, deprecated by RFC 5095. */
 struct ip6_rthdr0 {
-       u_int8_t  ip6r0_nxt;            /* next header */
-       u_int8_t  ip6r0_len;            /* length in units of 8 octets */
-       u_int8_t  ip6r0_type;           /* always zero */
-       u_int8_t  ip6r0_segleft;        /* segments left */
-       u_int8_t  ip6r0_reserved;       /* reserved field */
-       u_int8_t  ip6r0_slmap[3];       /* strict/loose bit map */
-       struct in6_addr  ip6r0_addr[1]; /* up to 23 addresses */
+       u_int8_t  ip6r0_nxt;            /* next header */
+       u_int8_t  ip6r0_len;            /* length in units of 8 octets */
+       u_int8_t  ip6r0_type;           /* always zero */
+       u_int8_t  ip6r0_segleft;        /* segments left */
+       u_int32_t  ip6r0_reserved;      /* reserved field */
+       /* followed by up to 127 struct in6_addr */
 } __attribute__((__packed__));
 
 /* Fragment header */
 struct ip6_frag {
-       u_int8_t  ip6f_nxt;             /* next header */
-       u_int8_t  ip6f_reserved;        /* reserved field */
-       u_int16_t ip6f_offlg;           /* offset, reserved, and flag */
-       u_int32_t ip6f_ident;           /* identification */
+       u_int8_t  ip6f_nxt;             /* next header */
+       u_int8_t  ip6f_reserved;        /* reserved field */
+       u_int16_t ip6f_offlg;           /* offset, reserved, and flag */
+       u_int32_t ip6f_ident;           /* identification */
 } __attribute__((__packed__));
 
 #if BYTE_ORDER == BIG_ENDIAN
-#define IP6F_OFF_MASK          0xfff8  /* mask out offset from _offlg */
-#define IP6F_RESERVED_MASK     0x0006  /* reserved bits in ip6f_offlg */
-#define IP6F_MORE_FRAG         0x0001  /* more-fragments flag */
+#define IP6F_OFF_MASK           0xfff8  /* mask out offset from _offlg */
+#define IP6F_RESERVED_MASK      0x0006  /* reserved bits in ip6f_offlg */
+#define IP6F_MORE_FRAG          0x0001  /* more-fragments flag */
 #else /* BYTE_ORDER == LITTLE_ENDIAN */
-#define IP6F_OFF_MASK          0xf8ff  /* mask out offset from _offlg */
-#define IP6F_RESERVED_MASK     0x0600  /* reserved bits in ip6f_offlg */
-#define IP6F_MORE_FRAG         0x0100  /* more-fragments flag */
+#define IP6F_OFF_MASK           0xf8ff  /* mask out offset from _offlg */
+#define IP6F_RESERVED_MASK      0x0600  /* reserved bits in ip6f_offlg */
+#define IP6F_MORE_FRAG          0x0100  /* more-fragments flag */
 #endif /* BYTE_ORDER == LITTLE_ENDIAN */
 
 /*
  * Internet implementation parameters.
  */
-#define IPV6_MAXHLIM   255     /* maximun hoplimit */
-#define IPV6_DEFHLIM   64      /* default hlim */
-#define IPV6_FRAGTTL   120     /* ttl for fragment packets, in slowtimo tick */
-#define IPV6_HLIMDEC   1       /* subtracted when forwaeding */
+#define IPV6_MAXHLIM    255     /* maximum hoplimit */
+#define IPV6_DEFHLIM    64      /* default hlim */
+#define IPV6_FRAGTTL    60      /* ttl for fragment packets (seconds) */
+#define IPV6_HLIMDEC    1       /* subtracted when forwarding */
 
-#define IPV6_MMTU      1280    /* minimal MTU and reassembly. 1024 + 256 */
-#define IPV6_MAXPACKET 65535   /* ip6 max packet size without Jumbo payload*/
+#define IPV6_MMTU       1280    /* minimal MTU and reassembly. 1024 + 256 */
+#define IPV6_MAXPACKET  65535   /* ip6 max packet size without Jumbo payload*/
+#define IPV6_MAXOPTHDR  2048    /* max option header size, 256 64-bit words */
 
-#ifdef KERNEL_PRIVATE
+#ifdef BSD_KERNEL_PRIVATE
 /*
  * IP6_EXTHDR_CHECK ensures that region between the IP6 header and the
  * target header (including IPv6 itself, extension headers and
@@ -247,35 +314,38 @@ struct ip6_frag {
  * supposed to never be matched but is prepared just in case.
  */
 
-#define IP6_EXTHDR_CHECK(m, off, hlen, action)                         \
-do {                                                                   \
-    if ((m)->m_next != NULL) {                                         \
-       if (((m)->m_flags & M_LOOP) &&                                  \
-           ((m)->m_len < (off) + (hlen)) &&                            \
-           (((m) = m_pullup((m), (off) + (hlen))) == NULL)) {          \
-               ip6stat.ip6s_exthdrtoolong++;                           \
-               action;                                                 \
-       } else if ((m)->m_flags & M_EXT) {                              \
-               if ((m)->m_len < (off) + (hlen)) {                      \
-                       ip6stat.ip6s_exthdrtoolong++;                   \
-                       m_freem(m);                                     \
-                       action;                                         \
-               }                                                       \
-       } else {                                                        \
-               if ((m)->m_len < (off) + (hlen)) {                      \
-                       ip6stat.ip6s_exthdrtoolong++;                   \
-                       m_freem(m);                                     \
-                       action;                                         \
-               }                                                       \
-       }                                                               \
-    } else {                                                           \
-       if ((m)->m_len < (off) + (hlen)) {                              \
-               ip6stat.ip6s_tooshort++;                                \
-               in6_ifstat_inc(m->m_pkthdr.rcvif, ifs6_in_truncated);   \
-               m_freem(m);                                             \
-               action;                                                 \
-       }                                                               \
-    }                                                                  \
+#define IP6_EXTHDR_CHECK(m, off, hlen, action)                          \
+do {                                                                    \
+    if ((m)->m_next != NULL) {                                          \
+       if (((m)->m_flags & M_LOOP) &&                                  \
+           ((m)->m_len < (off) + (hlen)) &&                            \
+           (((m) = m_pullup((m), (off) + (hlen))) == NULL)) {          \
+               ip6stat.ip6s_exthdrtoolong++;                           \
+               action;                                                 \
+       } else if ((m)->m_flags & M_EXT) {                              \
+               if ((m)->m_len < (off) + (hlen)) {                      \
+                       ip6stat.ip6s_exthdrtoolong++;                   \
+                       m_freem(m);                                     \
+                       (m) = NULL;                                     \
+                       action;                                         \
+               }                                                       \
+       } else {                                                        \
+               if ((m)->m_len < (off) + (hlen)) {                      \
+                       ip6stat.ip6s_exthdrtoolong++;                   \
+                       m_freem(m);                                     \
+                       (m) = NULL;                                     \
+                       action;                                         \
+               }                                                       \
+       }                                                               \
+    } else {                                                            \
+       if ((m)->m_len < (off) + (hlen)) {                              \
+               ip6stat.ip6s_tooshort++;                                \
+               in6_ifstat_inc(m->m_pkthdr.rcvif, ifs6_in_truncated);   \
+               m_freem(m);                                             \
+               (m) = NULL;                                             \
+               action;                                                 \
+       }                                                               \
+    }                                                                   \
 } while (0)
 
 /*
@@ -285,45 +355,12 @@ do {                                                                      \
  * with type "typ".
  * IP6_EXTHDR_GET0 does the same, except that it aligns the structure at the
  * very top of mbuf.  GET0 is likely to make memory copy than GET.
- *
- * XXX we're now testing this, needs m_pulldown()
  */
-#define IP6_EXTHDR_GET(val, typ, m, off, len) \
-do {                                                                   \
-       struct mbuf *t;                                                 \
-       int tmp;                                                        \
-       if ((m)->m_len >= (off) + (len))                                \
-               (val) = (typ)(mtod((m), caddr_t) + (off));              \
-       else {                                                          \
-               t = m_pulldown((m), (off), (len), &tmp);                \
-               if (t) {                                                \
-                       if (t->m_len < tmp + (len))                     \
-                               panic("m_pulldown malfunction");        \
-                       (val) = (typ)(mtod(t, caddr_t) + tmp);          \
-               } else {                                                \
-                       (val) = (typ)NULL;                              \
-                       (m) = NULL;                                     \
-               }                                                       \
-       }                                                               \
-} while (0)
+#define IP6_EXTHDR_GET(val, typ, m, off, len)                           \
+       M_STRUCT_GET(val, typ, m, off, len)
 
-#define IP6_EXTHDR_GET0(val, typ, m, off, len) \
-do {                                                                   \
-       struct mbuf *t;                                                 \
-       if ((off) == 0)                                                 \
-               (val) = (typ)mtod(m, caddr_t);                          \
-       else {                                                          \
-               t = m_pulldown((m), (off), (len), NULL);                \
-               if (t) {                                                \
-                       if (t->m_len < (len))                           \
-                               panic("m_pulldown malfunction");        \
-                       (val) = (typ)mtod(t, caddr_t);                  \
-               } else {                                                \
-                       (val) = (typ)NULL;                              \
-                       (m) = NULL;                                     \
-               }                                                       \
-       }                                                               \
-} while (0)
+#define IP6_EXTHDR_GET0(val, typ, m, off, len)                          \
+       M_STRUCT_GET0(val, typ, m, off, len)
 
-#endif KERNEL_PRIVATE
-#endif !_NETINET_IP6_H_
+#endif /* BSD_KERNEL_PRIVATE */
+#endif /* !_NETINET_IP6_H_ */