Home | History | Annotate | Line # | Download | only in netinet
ip6.h revision 1.23.90.1
      1 /*	$NetBSD: ip6.h,v 1.23.90.1 2021/03/07 19:13:24 martin Exp $	*/
      2 /*	$KAME: ip6.h,v 1.45 2003/06/05 04:46:38 keiichi 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.h	8.1 (Berkeley) 6/10/93
     62  */
     63 
     64 #ifndef _NETINET_IP6_H_
     65 #define _NETINET_IP6_H_
     66 
     67 #include <sys/types.h>
     68 #include <sys/endian.h>
     69 
     70 #include <netinet/in.h>
     71 
     72 /*
     73  * Definition for internet protocol version 6.
     74  * RFC 2460
     75  */
     76 
     77 struct ip6_hdr {
     78 	union {
     79 		struct ip6_hdrctl {
     80 			u_int32_t ip6_un1_flow;	/* 20 bits of flow-ID */
     81 			u_int16_t ip6_un1_plen;	/* payload length */
     82 			u_int8_t  ip6_un1_nxt;	/* next header */
     83 			u_int8_t  ip6_un1_hlim;	/* hop limit */
     84 		} ip6_un1;
     85 		u_int8_t ip6_un2_vfc;	/* 4 bits version, top 4 bits class */
     86 	} ip6_ctlun;
     87 	struct in6_addr ip6_src;	/* source address */
     88 	struct in6_addr ip6_dst;	/* destination address */
     89 } __packed;
     90 
     91 #define ip6_vfc		ip6_ctlun.ip6_un2_vfc
     92 #define ip6_flow	ip6_ctlun.ip6_un1.ip6_un1_flow
     93 #define ip6_plen	ip6_ctlun.ip6_un1.ip6_un1_plen
     94 #define ip6_nxt		ip6_ctlun.ip6_un1.ip6_un1_nxt
     95 #define ip6_hlim	ip6_ctlun.ip6_un1.ip6_un1_hlim
     96 #define ip6_hops	ip6_ctlun.ip6_un1.ip6_un1_hlim
     97 
     98 #define IPV6_VERSION		0x60
     99 #define IPV6_VERSION_MASK	0xf0
    100 
    101 #if BYTE_ORDER == BIG_ENDIAN
    102 #define IPV6_FLOWINFO_MASK	0x0fffffff	/* flow info (28 bits) */
    103 #define IPV6_FLOWLABEL_MASK	0x000fffff	/* flow label (20 bits) */
    104 #else
    105 #if BYTE_ORDER == LITTLE_ENDIAN
    106 #define IPV6_FLOWINFO_MASK	0xffffff0f	/* flow info (28 bits) */
    107 #define IPV6_FLOWLABEL_MASK	0xffff0f00	/* flow label (20 bits) */
    108 #endif /* LITTLE_ENDIAN */
    109 #endif
    110 #if 1
    111 /* ECN bits proposed by Sally Floyd */
    112 #define IP6TOS_CE		0x01	/* congestion experienced */
    113 #define IP6TOS_ECT		0x02	/* ECN-capable transport */
    114 #endif
    115 
    116 #ifdef _KERNEL
    117 /*
    118  * for IPv6 pseudo header checksum
    119  * XXX nonstandard
    120  */
    121 struct ip6_hdr_pseudo {
    122 	struct in6_addr ip6ph_src;
    123 	struct in6_addr ip6ph_dst;
    124 	u_int32_t	ip6ph_len;
    125 	u_int8_t	ip6ph_zero[3];
    126 	u_int8_t	ip6ph_nxt;
    127 } __packed;
    128 #endif
    129 
    130 /*
    131  * Extension Headers
    132  */
    133 
    134 struct	ip6_ext {
    135 	u_int8_t ip6e_nxt;
    136 	u_int8_t ip6e_len;
    137 } __packed;
    138 
    139 /* Hop-by-Hop options header */
    140 /* XXX should we pad it to force alignment on an 8-byte boundary? */
    141 struct ip6_hbh {
    142 	u_int8_t ip6h_nxt;	/* next header */
    143 	u_int8_t ip6h_len;	/* length in units of 8 octets */
    144 	/* followed by options */
    145 } __packed;
    146 
    147 /* Destination options header */
    148 /* XXX should we pad it to force alignment on an 8-byte boundary? */
    149 struct ip6_dest {
    150 	u_int8_t ip6d_nxt;	/* next header */
    151 	u_int8_t ip6d_len;	/* length in units of 8 octets */
    152 	/* followed by options */
    153 } __packed;
    154 
    155 /* Option types and related macros */
    156 #define IP6OPT_PAD1		0x00	/* 00 0 00000 */
    157 #define IP6OPT_PADN		0x01	/* 00 0 00001 */
    158 #define IP6OPT_JUMBO		0xC2	/* 11 0 00010 = 194 */
    159 #define IP6OPT_NSAP_ADDR	0xC3	/* 11 0 00011 */
    160 #define IP6OPT_TUNNEL_LIMIT	0x04	/* 00 0 00100 */
    161 #define IP6OPT_RTALERT		0x05	/* 00 0 00101 (KAME definition) */
    162 #define IP6OPT_ROUTER_ALERT	0x05	/* (RFC3542 def, recommended) */
    163 
    164 #define IP6OPT_RTALERT_LEN	4
    165 #define IP6OPT_RTALERT_MLD	0	/* Datagram contains an MLD message */
    166 #define IP6OPT_RTALERT_RSVP	1	/* Datagram contains an RSVP message */
    167 #define IP6OPT_RTALERT_ACTNET	2 	/* contains an Active Networks msg */
    168 #define IP6OPT_MINLEN		2
    169 
    170 #define IP6OPT_TYPE(o)		((o) & 0xC0)
    171 #define IP6OPT_TYPE_SKIP	0x00
    172 #define IP6OPT_TYPE_DISCARD	0x40
    173 #define IP6OPT_TYPE_FORCEICMP	0x80
    174 #define IP6OPT_TYPE_ICMP	0xC0
    175 
    176 #define IP6OPT_MUTABLE		0x20
    177 
    178 /* IPv6 options: common part */
    179 struct ip6_opt {
    180 	u_int8_t ip6o_type;
    181 	u_int8_t ip6o_len;
    182 } __packed;
    183 
    184 /* Jumbo Payload Option */
    185 struct ip6_opt_jumbo {
    186 	u_int8_t ip6oj_type;
    187 	u_int8_t ip6oj_len;
    188 	u_int8_t ip6oj_jumbo_len[4];
    189 } __packed;
    190 #define IP6OPT_JUMBO_LEN 6
    191 
    192 /* NSAP Address Option */
    193 struct ip6_opt_nsap {
    194 	u_int8_t ip6on_type;
    195 	u_int8_t ip6on_len;
    196 	u_int8_t ip6on_src_nsap_len;
    197 	u_int8_t ip6on_dst_nsap_len;
    198 	/* followed by source NSAP */
    199 	/* followed by destination NSAP */
    200 } __packed;
    201 
    202 /* Tunnel Limit Option */
    203 struct ip6_opt_tunnel {
    204 	u_int8_t ip6ot_type;
    205 	u_int8_t ip6ot_len;
    206 	u_int8_t ip6ot_encap_limit;
    207 } __packed;
    208 
    209 /* Router Alert Option */
    210 struct ip6_opt_router {
    211 	u_int8_t ip6or_type;
    212 	u_int8_t ip6or_len;
    213 	u_int8_t ip6or_value[2];
    214 } __packed;
    215 /* Router alert values (in network byte order) */
    216 #if BYTE_ORDER == BIG_ENDIAN
    217 #define IP6_ALERT_MLD	0x0000
    218 #define IP6_ALERT_RSVP	0x0001
    219 #define IP6_ALERT_AN	0x0002
    220 #else
    221 #if BYTE_ORDER == LITTLE_ENDIAN
    222 #define IP6_ALERT_MLD	0x0000
    223 #define IP6_ALERT_RSVP	0x0100
    224 #define IP6_ALERT_AN	0x0200
    225 #endif /* LITTLE_ENDIAN */
    226 #endif
    227 
    228 /* Routing header */
    229 struct ip6_rthdr {
    230 	u_int8_t  ip6r_nxt;	/* next header */
    231 	u_int8_t  ip6r_len;	/* length in units of 8 octets */
    232 	u_int8_t  ip6r_type;	/* routing type */
    233 	u_int8_t  ip6r_segleft;	/* segments left */
    234 	/* followed by routing type specific data */
    235 } __packed;
    236 
    237 /* Type 0 Routing header */
    238 struct ip6_rthdr0 {
    239 	u_int8_t  ip6r0_nxt;		/* next header */
    240 	u_int8_t  ip6r0_len;		/* length in units of 8 octets */
    241 	u_int8_t  ip6r0_type;		/* always zero */
    242 	u_int8_t  ip6r0_segleft;	/* segments left */
    243 	u_int32_t ip6r0_reserved;	/* reserved field */
    244 } __packed;
    245 
    246 /* Fragment header */
    247 struct ip6_frag {
    248 	u_int8_t  ip6f_nxt;		/* next header */
    249 	u_int8_t  ip6f_reserved;	/* reserved field */
    250 	u_int16_t ip6f_offlg;		/* offset, reserved, and flag */
    251 	u_int32_t ip6f_ident;		/* identification */
    252 } __packed;
    253 
    254 #if BYTE_ORDER == BIG_ENDIAN
    255 #define IP6F_OFF_MASK		0xfff8	/* mask out offset from _offlg */
    256 #define IP6F_RESERVED_MASK	0x0006	/* reserved bits in ip6f_offlg */
    257 #define IP6F_MORE_FRAG		0x0001	/* more-fragments flag */
    258 #else /* BYTE_ORDER == LITTLE_ENDIAN */
    259 #define IP6F_OFF_MASK		0xf8ff	/* mask out offset from _offlg */
    260 #define IP6F_RESERVED_MASK	0x0600	/* reserved bits in ip6f_offlg */
    261 #define IP6F_MORE_FRAG		0x0100	/* more-fragments flag */
    262 #endif /* BYTE_ORDER == LITTLE_ENDIAN */
    263 
    264 /*
    265  * Internet implementation parameters.
    266  */
    267 #define IPV6_MAXHLIM	255	/* maximum hoplimit */
    268 #define IPV6_DEFHLIM	64	/* default hlim */
    269 #define IPV6_FRAGTTL	120	/* ttl for fragment packets, in slowtimo tick */
    270 #define IPV6_HLIMDEC	1	/* subtracted when forwarding */
    271 
    272 #define IPV6_MMTU	1280	/* minimal MTU and reassembly. 1024 + 256 */
    273 #define IPV6_MAXPACKET	65535	/* ip6 max packet size without Jumbo payload*/
    274 
    275 #ifdef _KERNEL
    276 /*
    277  * IP6_EXTHDR_GET ensures that intermediate protocol header (from "off" to
    278  * "len") is located in single mbuf, on contiguous memory region.
    279  * The pointer to the region will be returned to pointer variable "val",
    280  * with type "typ".
    281  * IP6_EXTHDR_GET0 does the same, except that it aligns the structure at the
    282  * very top of mbuf.  GET0 is likely to make memory copy than GET.
    283  *
    284  * XXX we're now testing this, needs m_pulldown()
    285  */
    286 #define IP6_EXTHDR_GET(val, typ, m, off, len) \
    287 do {									\
    288 	struct mbuf *_t;						\
    289 	int _tmp;							\
    290 	if ((m)->m_len >= (off) + (len))				\
    291 		(val) = (typ)(mtod((m), char *) + (off));		\
    292 	else {								\
    293 		_t = m_pulldown((m), (off), (len), &_tmp);		\
    294 		if (_t) {						\
    295 			if (_t->m_len < _tmp + (len))			\
    296 				panic("m_pulldown malfunction");	\
    297 			(val) = (typ)(mtod(_t, char *) + _tmp);	\
    298 		} else {						\
    299 			(val) = (typ)NULL;				\
    300 			(m) = NULL;					\
    301 		}							\
    302 	}								\
    303 } while (/*CONSTCOND*/ 0)
    304 
    305 #define IP6_EXTHDR_GET0(val, typ, m, off, len) \
    306 do {									\
    307 	struct mbuf *_t;						\
    308 	if ((off) == 0 && (m)->m_len >= len)				\
    309 		(val) = (typ)mtod((m), void *);			\
    310 	else {								\
    311 		_t = m_pulldown((m), (off), (len), NULL);		\
    312 		if (_t) {						\
    313 			if (_t->m_len < (len))				\
    314 				panic("m_pulldown malfunction");	\
    315 			(val) = (typ)mtod(_t, void *);			\
    316 		} else {						\
    317 			(val) = (typ)NULL;				\
    318 			(m) = NULL;					\
    319 		}							\
    320 	}								\
    321 } while (/*CONSTCOND*/ 0)
    322 #endif /*_KERNEL*/
    323 
    324 #endif /* !_NETINET_IP6_H_ */
    325