xref: /netbsd-src/sys/netinet/ip6.h (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1 /*	$NetBSD: ip6.h,v 1.15 2003/06/06 08:13:43 itojun 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. All advertising materials mentioning features or use of this software
46  *    must display the following acknowledgement:
47  *	This product includes software developed by the University of
48  *	California, Berkeley and its contributors.
49  * 4. Neither the name of the University nor the names of its contributors
50  *    may be used to endorse or promote products derived from this software
51  *    without specific prior written permission.
52  *
53  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
54  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
55  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
56  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
57  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
58  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
59  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
61  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
62  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63  * SUCH DAMAGE.
64  *
65  *	@(#)ip.h	8.1 (Berkeley) 6/10/93
66  */
67 
68 #ifndef _NETINET_IP6_H_
69 #define _NETINET_IP6_H_
70 
71 /*
72  * Definition for internet protocol version 6.
73  * RFC 2460
74  */
75 
76 struct ip6_hdr {
77 	union {
78 		struct ip6_hdrctl {
79 			u_int32_t ip6_un1_flow;	/* 20 bits of flow-ID */
80 			u_int16_t ip6_un1_plen;	/* payload length */
81 			u_int8_t  ip6_un1_nxt;	/* next header */
82 			u_int8_t  ip6_un1_hlim;	/* hop limit */
83 		} ip6_un1;
84 		u_int8_t ip6_un2_vfc;	/* 4 bits version, top 4 bits class */
85 	} ip6_ctlun;
86 	struct in6_addr ip6_src;	/* source address */
87 	struct in6_addr ip6_dst;	/* destination address */
88 } __attribute__((__packed__));
89 
90 #define ip6_vfc		ip6_ctlun.ip6_un2_vfc
91 #define ip6_flow	ip6_ctlun.ip6_un1.ip6_un1_flow
92 #define ip6_plen	ip6_ctlun.ip6_un1.ip6_un1_plen
93 #define ip6_nxt		ip6_ctlun.ip6_un1.ip6_un1_nxt
94 #define ip6_hlim	ip6_ctlun.ip6_un1.ip6_un1_hlim
95 #define ip6_hops	ip6_ctlun.ip6_un1.ip6_un1_hlim
96 
97 #define IPV6_VERSION		0x60
98 #define IPV6_VERSION_MASK	0xf0
99 
100 #if BYTE_ORDER == BIG_ENDIAN
101 #define IPV6_FLOWINFO_MASK	0x0fffffff	/* flow info (28 bits) */
102 #define IPV6_FLOWLABEL_MASK	0x000fffff	/* flow label (20 bits) */
103 #else
104 #if 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 #endif /* LITTLE_ENDIAN */
108 #endif
109 #if 1
110 /* ECN bits proposed by Sally Floyd */
111 #define IP6TOS_CE		0x01	/* congestion experienced */
112 #define IP6TOS_ECT		0x02	/* ECN-capable transport */
113 #endif
114 
115 /*
116  * Extension Headers
117  */
118 
119 struct	ip6_ext {
120 	u_int8_t ip6e_nxt;
121 	u_int8_t ip6e_len;
122 } __attribute__((__packed__));
123 
124 /* Hop-by-Hop options header */
125 /* XXX should we pad it to force alignment on an 8-byte boundary? */
126 struct ip6_hbh {
127 	u_int8_t ip6h_nxt;	/* next header */
128 	u_int8_t ip6h_len;	/* length in units of 8 octets */
129 	/* followed by options */
130 } __attribute__((__packed__));
131 
132 /* Destination options header */
133 /* XXX should we pad it to force alignment on an 8-byte boundary? */
134 struct ip6_dest {
135 	u_int8_t ip6d_nxt;	/* next header */
136 	u_int8_t ip6d_len;	/* length in units of 8 octets */
137 	/* followed by options */
138 } __attribute__((__packed__));
139 
140 /* Option types and related macros */
141 #define IP6OPT_PAD1		0x00	/* 00 0 00000 */
142 #define IP6OPT_PADN		0x01	/* 00 0 00001 */
143 #define IP6OPT_JUMBO		0xC2	/* 11 0 00010 = 194 */
144 #define IP6OPT_NSAP_ADDR	0xC3	/* 11 0 00011 */
145 #define IP6OPT_TUNNEL_LIMIT	0x04	/* 00 0 00100 */
146 #define IP6OPT_RTALERT		0x05	/* 00 0 00101 (KAME definition) */
147 #define IP6OPT_ROUTER_ALERT	0x05	/* (2292bis def, recommended) */
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_TYPE(o)		((o) & 0xC0)
156 #define IP6OPT_TYPE_SKIP	0x00
157 #define IP6OPT_TYPE_DISCARD	0x40
158 #define IP6OPT_TYPE_FORCEICMP	0x80
159 #define IP6OPT_TYPE_ICMP	0xC0
160 
161 #define IP6OPT_MUTABLE		0x20
162 
163 /* IPv6 options: common part */
164 struct ip6_opt {
165 	u_int8_t ip6o_type;
166 	u_int8_t ip6o_len;
167 } __attribute__((__packed__));
168 
169 /* Jumbo Payload Option */
170 struct ip6_opt_jumbo {
171 	u_int8_t ip6oj_type;
172 	u_int8_t ip6oj_len;
173 	u_int8_t ip6oj_jumbo_len[4];
174 } __attribute__((__packed__));
175 #define IP6OPT_JUMBO_LEN 6
176 
177 /* NSAP Address Option */
178 struct ip6_opt_nsap {
179 	u_int8_t ip6on_type;
180 	u_int8_t ip6on_len;
181 	u_int8_t ip6on_src_nsap_len;
182 	u_int8_t ip6on_dst_nsap_len;
183 	/* followed by source NSAP */
184 	/* followed by destination NSAP */
185 } __attribute__((__packed__));
186 
187 /* Tunnel Limit Option */
188 struct ip6_opt_tunnel {
189 	u_int8_t ip6ot_type;
190 	u_int8_t ip6ot_len;
191 	u_int8_t ip6ot_encap_limit;
192 } __attribute__((__packed__));
193 
194 /* Router Alert Option */
195 struct ip6_opt_router {
196 	u_int8_t ip6or_type;
197 	u_int8_t ip6or_len;
198 	u_int8_t ip6or_value[2];
199 } __attribute__((__packed__));
200 /* Router alert values (in network byte order) */
201 #if BYTE_ORDER == BIG_ENDIAN
202 #define IP6_ALERT_MLD	0x0000
203 #define IP6_ALERT_RSVP	0x0001
204 #define IP6_ALERT_AN	0x0002
205 #else
206 #if BYTE_ORDER == LITTLE_ENDIAN
207 #define IP6_ALERT_MLD	0x0000
208 #define IP6_ALERT_RSVP	0x0100
209 #define IP6_ALERT_AN	0x0200
210 #endif /* LITTLE_ENDIAN */
211 #endif
212 
213 /* Routing header */
214 struct ip6_rthdr {
215 	u_int8_t  ip6r_nxt;	/* next header */
216 	u_int8_t  ip6r_len;	/* length in units of 8 octets */
217 	u_int8_t  ip6r_type;	/* routing type */
218 	u_int8_t  ip6r_segleft;	/* segments left */
219 	/* followed by routing type specific data */
220 } __attribute__((__packed__));
221 
222 /* Type 0 Routing header */
223 struct ip6_rthdr0 {
224 	u_int8_t  ip6r0_nxt;		/* next header */
225 	u_int8_t  ip6r0_len;		/* length in units of 8 octets */
226 	u_int8_t  ip6r0_type;		/* always zero */
227 	u_int8_t  ip6r0_segleft;	/* segments left */
228 	u_int32_t ip6r0_reserved;	/* reserved field */
229 } __attribute__((__packed__));
230 
231 /* Fragment header */
232 struct ip6_frag {
233 	u_int8_t  ip6f_nxt;		/* next header */
234 	u_int8_t  ip6f_reserved;	/* reserved field */
235 	u_int16_t ip6f_offlg;		/* offset, reserved, and flag */
236 	u_int32_t ip6f_ident;		/* identification */
237 } __attribute__((__packed__));
238 
239 #if BYTE_ORDER == BIG_ENDIAN
240 #define IP6F_OFF_MASK		0xfff8	/* mask out offset from _offlg */
241 #define IP6F_RESERVED_MASK	0x0006	/* reserved bits in ip6f_offlg */
242 #define IP6F_MORE_FRAG		0x0001	/* more-fragments flag */
243 #else /* BYTE_ORDER == LITTLE_ENDIAN */
244 #define IP6F_OFF_MASK		0xf8ff	/* mask out offset from _offlg */
245 #define IP6F_RESERVED_MASK	0x0600	/* reserved bits in ip6f_offlg */
246 #define IP6F_MORE_FRAG		0x0100	/* more-fragments flag */
247 #endif /* BYTE_ORDER == LITTLE_ENDIAN */
248 
249 /*
250  * Internet implementation parameters.
251  */
252 #define IPV6_MAXHLIM	255	/* maximun hoplimit */
253 #define IPV6_DEFHLIM	64	/* default hlim */
254 #define IPV6_FRAGTTL	120	/* ttl for fragment packets, in slowtimo tick */
255 #define IPV6_HLIMDEC	1	/* subtracted when forwaeding */
256 
257 #define IPV6_MMTU	1280	/* minimal MTU and reassembly. 1024 + 256 */
258 #define IPV6_MAXPACKET	65535	/* ip6 max packet size without Jumbo payload*/
259 
260 #ifdef _KERNEL
261 /*
262  * IP6_EXTHDR_GET ensures that intermediate protocol header (from "off" to
263  * "len") is located in single mbuf, on contiguous memory region.
264  * The pointer to the region will be returned to pointer variable "val",
265  * with type "typ".
266  * IP6_EXTHDR_GET0 does the same, except that it aligns the structure at the
267  * very top of mbuf.  GET0 is likely to make memory copy than GET.
268  *
269  * XXX we're now testing this, needs m_pulldown()
270  */
271 #define IP6_EXTHDR_GET(val, typ, m, off, len) \
272 do {									\
273 	struct mbuf *t;							\
274 	int tmp;							\
275 	if ((m)->m_len >= (off) + (len))				\
276 		(val) = (typ)(mtod((m), caddr_t) + (off));		\
277 	else {								\
278 		t = m_pulldown((m), (off), (len), &tmp);		\
279 		if (t) {						\
280 			if (t->m_len < tmp + (len))			\
281 				panic("m_pulldown malfunction");	\
282 			(val) = (typ)(mtod(t, caddr_t) + tmp);		\
283 		} else {						\
284 			(val) = (typ)NULL;				\
285 			(m) = NULL;					\
286 		}							\
287 	}								\
288 } while (/*CONSTCOND*/ 0)
289 
290 #define IP6_EXTHDR_GET0(val, typ, m, off, len) \
291 do {									\
292 	struct mbuf *t;							\
293 	if ((off) == 0 && (m)->m_len >= len)				\
294 		(val) = (typ)mtod((m), caddr_t);			\
295 	else {								\
296 		t = m_pulldown((m), (off), (len), NULL);		\
297 		if (t) {						\
298 			if (t->m_len < (len))				\
299 				panic("m_pulldown malfunction");	\
300 			(val) = (typ)mtod(t, caddr_t);			\
301 		} else {						\
302 			(val) = (typ)NULL;				\
303 			(m) = NULL;					\
304 		}							\
305 	}								\
306 } while (/*CONSTCOND*/ 0)
307 #endif /*_KERNEL*/
308 
309 #endif /* not _NETINET_IP6_H_ */
310