xref: /dragonfly/sys/netinet/ip6.h (revision 611395e5)
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.4 2004/09/24 12:39:25 joerg 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 /*
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 } __attribute__((__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 #elif _BYTE_ORDER == _LITTLE_ENDIAN
105 #define IPV6_FLOWINFO_MASK	0xffffff0f	/* flow info (28 bits) */
106 #define IPV6_FLOWLABEL_MASK	0xffff0f00	/* flow label (20 bits) */
107 #else
108 #error "Byte order not implemented"
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 /*
117  * Extension Headers
118  */
119 
120 struct	ip6_ext {
121 	u_int8_t ip6e_nxt;
122 	u_int8_t ip6e_len;
123 } __attribute__((__packed__));
124 
125 /* Hop-by-Hop options header */
126 /* XXX should we pad it to force alignment on an 8-byte boundary? */
127 struct ip6_hbh {
128 	u_int8_t ip6h_nxt;	/* next header */
129 	u_int8_t ip6h_len;	/* length in units of 8 octets */
130 	/* followed by options */
131 } __attribute__((__packed__));
132 
133 /* Destination options header */
134 /* XXX should we pad it to force alignment on an 8-byte boundary? */
135 struct ip6_dest {
136 	u_int8_t ip6d_nxt;	/* next header */
137 	u_int8_t ip6d_len;	/* length in units of 8 octets */
138 	/* followed by options */
139 } __attribute__((__packed__));
140 
141 /* Option types and related macros */
142 #define IP6OPT_PAD1		0x00	/* 00 0 00000 */
143 #define IP6OPT_PADN		0x01	/* 00 0 00001 */
144 #define IP6OPT_JUMBO		0xC2	/* 11 0 00010 = 194 */
145 #define IP6OPT_NSAP_ADDR	0xC3	/* 11 0 00011 */
146 #define IP6OPT_TUNNEL_LIMIT	0x04	/* 00 0 00100 */
147 #define IP6OPT_RTALERT		0x05	/* 00 0 00101 (KAME definition) */
148 
149 #define IP6OPT_RTALERT_LEN	4
150 #define IP6OPT_RTALERT_MLD	0	/* Datagram contains an MLD message */
151 #define IP6OPT_RTALERT_RSVP	1	/* Datagram contains an RSVP message */
152 #define IP6OPT_RTALERT_ACTNET	2 	/* contains an Active Networks msg */
153 #define IP6OPT_MINLEN		2
154 
155 #define IP6OPT_BINDING_UPDATE	0xc6	/* 11 0 00110 */
156 #define IP6OPT_BINDING_ACK	0x07	/* 00 0 00111 */
157 #define IP6OPT_BINDING_REQ	0x08	/* 00 0 01000 */
158 #define IP6OPT_HOME_ADDRESS	0xc9	/* 11 0 01001 */
159 #define IP6OPT_EID		0x8a	/* 10 0 01010 */
160 
161 #define IP6OPT_TYPE(o)		((o) & 0xC0)
162 #define IP6OPT_TYPE_SKIP	0x00
163 #define IP6OPT_TYPE_DISCARD	0x40
164 #define IP6OPT_TYPE_FORCEICMP	0x80
165 #define IP6OPT_TYPE_ICMP	0xC0
166 
167 #define IP6OPT_MUTABLE		0x20
168 
169 #define IP6OPT_JUMBO_LEN	6
170 
171 /* Routing header */
172 struct ip6_rthdr {
173 	u_int8_t  ip6r_nxt;	/* next header */
174 	u_int8_t  ip6r_len;	/* length in units of 8 octets */
175 	u_int8_t  ip6r_type;	/* routing type */
176 	u_int8_t  ip6r_segleft;	/* segments left */
177 	/* followed by routing type specific data */
178 } __attribute__((__packed__));
179 
180 /* Type 0 Routing header */
181 struct ip6_rthdr0 {
182 	u_int8_t  ip6r0_nxt;		/* next header */
183 	u_int8_t  ip6r0_len;		/* length in units of 8 octets */
184 	u_int8_t  ip6r0_type;		/* always zero */
185 	u_int8_t  ip6r0_segleft;	/* segments left */
186 	u_int8_t  ip6r0_reserved;	/* reserved field */
187 	u_int8_t  ip6r0_slmap[3];	/* strict/loose bit map */
188 	struct in6_addr  ip6r0_addr[1];	/* up to 23 addresses */
189 } __attribute__((__packed__));
190 
191 /* Fragment header */
192 struct ip6_frag {
193 	u_int8_t  ip6f_nxt;		/* next header */
194 	u_int8_t  ip6f_reserved;	/* reserved field */
195 	u_int16_t ip6f_offlg;		/* offset, reserved, and flag */
196 	u_int32_t ip6f_ident;		/* identification */
197 } __attribute__((__packed__));
198 
199 #if _BYTE_ORDER == _BIG_ENDIAN
200 #define IP6F_OFF_MASK		0xfff8	/* mask out offset from _offlg */
201 #define IP6F_RESERVED_MASK	0x0006	/* reserved bits in ip6f_offlg */
202 #define IP6F_MORE_FRAG		0x0001	/* more-fragments flag */
203 #elif _BYTE_ORDER == _LITTLE_ENDIAN
204 #define IP6F_OFF_MASK		0xf8ff	/* mask out offset from _offlg */
205 #define IP6F_RESERVED_MASK	0x0600	/* reserved bits in ip6f_offlg */
206 #define IP6F_MORE_FRAG		0x0100	/* more-fragments flag */
207 #else
208 #error "Byte order not implemented"
209 #endif
210 
211 /*
212  * Internet implementation parameters.
213  */
214 #define IPV6_MAXHLIM	255	/* maximun hoplimit */
215 #define IPV6_DEFHLIM	64	/* default hlim */
216 #define IPV6_FRAGTTL	120	/* ttl for fragment packets, in slowtimo tick */
217 #define IPV6_HLIMDEC	1	/* subtracted when forwaeding */
218 
219 #define IPV6_MMTU	1280	/* minimal MTU and reassembly. 1024 + 256 */
220 #define IPV6_MAXPACKET	65535	/* ip6 max packet size without Jumbo payload*/
221 
222 #ifdef _KERNEL
223 /*
224  * IP6_EXTHDR_CHECK ensures that region between the IP6 header and the
225  * target header (including IPv6 itself, extension headers and
226  * TCP/UDP/ICMP6 headers) are continuous. KAME requires drivers
227  * to store incoming data into one internal mbuf or one or more external
228  * mbufs(never into two or more internal mbufs). Thus, the third case is
229  * supposed to never be matched but is prepared just in case.
230  */
231 
232 #define IP6_EXTHDR_CHECK(m, off, hlen, ret)				\
233 do {									\
234     if ((m)->m_next != NULL) {						\
235 	if (((m)->m_flags & M_LOOP) &&					\
236 	    ((m)->m_len < (off) + (hlen)) &&				\
237 	    (((m) = m_pullup((m), (off) + (hlen))) == NULL)) {		\
238 		ip6stat.ip6s_exthdrtoolong++;				\
239 		return ret;						\
240 	} else if ((m)->m_flags & M_EXT) {				\
241 		if ((m)->m_len < (off) + (hlen)) {			\
242 			ip6stat.ip6s_exthdrtoolong++;			\
243 			m_freem(m);					\
244 			return ret;					\
245 		}							\
246 	} else {							\
247 		if ((m)->m_len < (off) + (hlen)) {			\
248 			ip6stat.ip6s_exthdrtoolong++;			\
249 			m_freem(m);					\
250 			return ret;					\
251 		}							\
252 	}								\
253     } else {								\
254 	if ((m)->m_len < (off) + (hlen)) {				\
255 		ip6stat.ip6s_tooshort++;				\
256 		in6_ifstat_inc(m->m_pkthdr.rcvif, ifs6_in_truncated);	\
257 		m_freem(m);						\
258 		return ret;						\
259 	}								\
260     }									\
261 } while (0)
262 
263 /*
264  * IP6_EXTHDR_GET ensures that intermediate protocol header (from "off" to
265  * "len") is located in single mbuf, on contiguous memory region.
266  * The pointer to the region will be returned to pointer variable "val",
267  * with type "typ".
268  * IP6_EXTHDR_GET0 does the same, except that it aligns the structure at the
269  * very top of mbuf.  GET0 is likely to make memory copy than GET.
270  *
271  * XXX we're now testing this, needs m_pulldown()
272  */
273 #define IP6_EXTHDR_GET(val, typ, m, off, len) \
274 do {									\
275 	struct mbuf *t;							\
276 	int tmp;							\
277 	if ((m)->m_len >= (off) + (len))				\
278 		(val) = (typ)(mtod((m), caddr_t) + (off));		\
279 	else {								\
280 		t = m_pulldown((m), (off), (len), &tmp);		\
281 		if (t) {						\
282 			if (t->m_len < tmp + (len))			\
283 				panic("m_pulldown malfunction");	\
284 			(val) = (typ)(mtod(t, caddr_t) + tmp);		\
285 		} else {						\
286 			(val) = (typ)NULL;				\
287 			(m) = NULL;					\
288 		}							\
289 	}								\
290 } while (0)
291 
292 #define IP6_EXTHDR_GET0(val, typ, m, off, len) \
293 do {									\
294 	struct mbuf *t;							\
295 	if ((off) == 0)							\
296 		(val) = (typ)mtod(m, caddr_t);				\
297 	else {								\
298 		t = m_pulldown((m), (off), (len), NULL);		\
299 		if (t) {						\
300 			if (t->m_len < (len))				\
301 				panic("m_pulldown malfunction");	\
302 			(val) = (typ)mtod(t, caddr_t);			\
303 		} else {						\
304 			(val) = (typ)NULL;				\
305 			(m) = NULL;					\
306 		}							\
307 	}								\
308 } while (0)
309 #endif /*_KERNEL*/
310 
311 #endif /* not _NETINET_IP6_H_ */
312