xref: /dragonfly/sys/netinet/ip6.h (revision fcce2b94)
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.6 2006/05/20 02:42:12 dillon 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_RTALERT_LEN	4
161 #define IP6OPT_RTALERT_MLD	0	/* Datagram contains an MLD message */
162 #define IP6OPT_RTALERT_RSVP	1	/* Datagram contains an RSVP message */
163 #define IP6OPT_RTALERT_ACTNET	2	/* contains an Active Networks msg */
164 #define IP6OPT_MINLEN		2
165 
166 #define IP6OPT_BINDING_UPDATE	0xc6	/* 11 0 00110 */
167 #define IP6OPT_BINDING_ACK	0x07	/* 00 0 00111 */
168 #define IP6OPT_BINDING_REQ	0x08	/* 00 0 01000 */
169 #define IP6OPT_HOME_ADDRESS	0xc9	/* 11 0 01001 */
170 #define IP6OPT_EID		0x8a	/* 10 0 01010 */
171 
172 #define IP6OPT_TYPE(o)		((o) & 0xC0)
173 #define IP6OPT_TYPE_SKIP	0x00
174 #define IP6OPT_TYPE_DISCARD	0x40
175 #define IP6OPT_TYPE_FORCEICMP	0x80
176 #define IP6OPT_TYPE_ICMP	0xC0
177 
178 #define IP6OPT_MUTABLE		0x20
179 
180 #define IP6OPT_JUMBO_LEN	6
181 
182 /* Routing header */
183 struct ip6_rthdr {
184 	u_int8_t  ip6r_nxt;	/* next header */
185 	u_int8_t  ip6r_len;	/* length in units of 8 octets */
186 	u_int8_t  ip6r_type;	/* routing type */
187 	u_int8_t  ip6r_segleft;	/* segments left */
188 	/* followed by routing type specific data */
189 } __attribute__((__packed__));
190 
191 /* Type 0 Routing header */
192 struct ip6_rthdr0 {
193 	u_int8_t  ip6r0_nxt;		/* next header */
194 	u_int8_t  ip6r0_len;		/* length in units of 8 octets */
195 	u_int8_t  ip6r0_type;		/* always zero */
196 	u_int8_t  ip6r0_segleft;	/* segments left */
197 	u_int8_t  ip6r0_reserved;	/* reserved field */
198 	u_int8_t  ip6r0_slmap[3];	/* strict/loose bit map */
199 	struct in6_addr  ip6r0_addr[1];	/* up to 23 addresses */
200 } __attribute__((__packed__));
201 
202 /* Fragment header */
203 struct ip6_frag {
204 	u_int8_t  ip6f_nxt;		/* next header */
205 	u_int8_t  ip6f_reserved;	/* reserved field */
206 	u_int16_t ip6f_offlg;		/* offset, reserved, and flag */
207 	u_int32_t ip6f_ident;		/* identification */
208 } __attribute__((__packed__));
209 
210 #if _BYTE_ORDER == _BIG_ENDIAN
211 #define IP6F_OFF_MASK		0xfff8	/* mask out offset from _offlg */
212 #define IP6F_RESERVED_MASK	0x0006	/* reserved bits in ip6f_offlg */
213 #define IP6F_MORE_FRAG		0x0001	/* more-fragments flag */
214 #elif _BYTE_ORDER == _LITTLE_ENDIAN
215 #define IP6F_OFF_MASK		0xf8ff	/* mask out offset from _offlg */
216 #define IP6F_RESERVED_MASK	0x0600	/* reserved bits in ip6f_offlg */
217 #define IP6F_MORE_FRAG		0x0100	/* more-fragments flag */
218 #else
219 #error "Byte order not implemented"
220 #endif
221 
222 /*
223  * Internet implementation parameters.
224  */
225 #define IPV6_MAXHLIM	255	/* maximun hoplimit */
226 #define IPV6_DEFHLIM	64	/* default hlim */
227 #define IPV6_FRAGTTL	120	/* ttl for fragment packets, in slowtimo tick */
228 #define IPV6_HLIMDEC	1	/* subtracted when forwaeding */
229 
230 #define IPV6_MMTU	1280	/* minimal MTU and reassembly. 1024 + 256 */
231 #define IPV6_MAXPACKET	65535	/* ip6 max packet size without Jumbo payload*/
232 
233 #ifdef _KERNEL
234 /*
235  * IP6_EXTHDR_CHECK ensures that region between the IP6 header and the
236  * target header (including IPv6 itself, extension headers and
237  * TCP/UDP/ICMP6 headers) are continuous. KAME requires drivers
238  * to store incoming data into one internal mbuf or one or more external
239  * mbufs(never into two or more internal mbufs). Thus, the third case is
240  * supposed to never be matched but is prepared just in case.
241  */
242 
243 #define IP6_EXTHDR_CHECK(m, off, hlen, ret)				\
244 do {									\
245     if ((m)->m_next != NULL) {						\
246 	if (((m)->m_flags & M_LOOP) &&					\
247 	    ((m)->m_len < (off) + (hlen)) &&				\
248 	    (((m) = m_pullup((m), (off) + (hlen))) == NULL)) {		\
249 		ip6stat.ip6s_exthdrtoolong++;				\
250 		return ret;						\
251 	} else if ((m)->m_flags & M_EXT) {				\
252 		if ((m)->m_len < (off) + (hlen)) {			\
253 			ip6stat.ip6s_exthdrtoolong++;			\
254 			m_freem(m);					\
255 			return ret;					\
256 		}							\
257 	} else {							\
258 		if ((m)->m_len < (off) + (hlen)) {			\
259 			ip6stat.ip6s_exthdrtoolong++;			\
260 			m_freem(m);					\
261 			return ret;					\
262 		}							\
263 	}								\
264     } else {								\
265 	if ((m)->m_len < (off) + (hlen)) {				\
266 		ip6stat.ip6s_tooshort++;				\
267 		in6_ifstat_inc(m->m_pkthdr.rcvif, ifs6_in_truncated);	\
268 		m_freem(m);						\
269 		return ret;						\
270 	}								\
271     }									\
272 } while (0)
273 
274 /*
275  * IP6_EXTHDR_GET ensures that intermediate protocol header (from "off" to
276  * "len") is located in single mbuf, on contiguous memory region.
277  * The pointer to the region will be returned to pointer variable "val",
278  * with type "typ".
279  * IP6_EXTHDR_GET0 does the same, except that it aligns the structure at the
280  * very top of mbuf.  GET0 is likely to make memory copy than GET.
281  *
282  * XXX we're now testing this, needs m_pulldown()
283  */
284 #define IP6_EXTHDR_GET(val, typ, m, off, len) \
285 do {									\
286 	struct mbuf *t;							\
287 	int tmp;							\
288 	if ((m)->m_len >= (off) + (len))				\
289 		(val) = (typ)(mtod((m), caddr_t) + (off));		\
290 	else {								\
291 		t = m_pulldown((m), (off), (len), &tmp);		\
292 		if (t) {						\
293 			if (t->m_len < tmp + (len))			\
294 				panic("m_pulldown malfunction");	\
295 			(val) = (typ)(mtod(t, caddr_t) + tmp);		\
296 		} else {						\
297 			(val) = (typ)NULL;				\
298 			(m) = NULL;					\
299 		}							\
300 	}								\
301 } while (0)
302 
303 #define IP6_EXTHDR_GET0(val, typ, m, off, len) \
304 do {									\
305 	struct mbuf *t;							\
306 	if ((off) == 0)							\
307 		(val) = (typ)mtod(m, caddr_t);				\
308 	else {								\
309 		t = m_pulldown((m), (off), (len), NULL);		\
310 		if (t) {						\
311 			if (t->m_len < (len))				\
312 				panic("m_pulldown malfunction");	\
313 			(val) = (typ)mtod(t, caddr_t);			\
314 		} else {						\
315 			(val) = (typ)NULL;				\
316 			(m) = NULL;					\
317 		}							\
318 	}								\
319 } while (0)
320 #endif /*_KERNEL*/
321 
322 #endif /* not _NETINET_IP6_H_ */
323