xref: /freebsd/sys/netinet6/ip6.h (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
1 /*
2  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the project nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 /*
33  * Copyright (c) 1982, 1986, 1993
34  *	The Regents of the University of California.  All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  * 3. All advertising materials mentioning features or use of this software
45  *    must display the following acknowledgement:
46  *	This product includes software developed by the University of
47  *	California, Berkeley and its contributors.
48  * 4. Neither the name of the University nor the names of its contributors
49  *    may be used to endorse or promote products derived from this software
50  *    without specific prior written permission.
51  *
52  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
53  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
55  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
56  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
57  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
58  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
59  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
60  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
61  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
62  * SUCH DAMAGE.
63  *
64  *	@(#)ip.h	8.1 (Berkeley) 6/10/93
65  */
66 
67 #ifndef _NETINET6_IPV6_H_
68 #define _NETINET6_IPV6_H_
69 
70 #if !defined(_KERNEL) && !defined(__KAME_NETINET_IP6_H_INCLUDED_)
71 #if 0 /* XXX: waiting for contrib/addrtoname.c fix */
72 #error "do not include netinet6/ip6.h directly, include netinet/ip6.h"
73 #endif
74 #endif
75 
76 /*
77  * Definition for internet protocol version 6.
78  * RFC 2460
79  */
80 
81 struct ip6_hdr {
82 	union {
83 		struct ip6_hdrctl {
84 			u_int32_t	ip6_un1_flow;	/* 4 bits version,
85 							 * 8 bits traffic
86 							 * class,
87 							 * 20 bits flow-ID */
88 			u_int16_t	ip6_un1_plen;	/* payload length */
89 			u_int8_t	ip6_un1_nxt;	/* next header */
90 			u_int8_t	ip6_un1_hlim;	/* hop limit */
91 		} ip6_un1;
92 		u_int8_t	ip6_un2_vfc; /* 4 bits version,
93 					      *	top 4 bits trafic class */
94 	} ip6_ctlun;
95 	struct	in6_addr ip6_src;	/* source address */
96 	struct	in6_addr ip6_dst;	/* destination address */
97 };
98 
99 #define	ip6_vfc		ip6_ctlun.ip6_un2_vfc
100 #define	ip6_flow	ip6_ctlun.ip6_un1.ip6_un1_flow
101 #define	ip6_plen	ip6_ctlun.ip6_un1.ip6_un1_plen
102 #define	ip6_nxt		ip6_ctlun.ip6_un1.ip6_un1_nxt
103 #define	ip6_hlim	ip6_ctlun.ip6_un1.ip6_un1_hlim
104 #define	ip6_hops	ip6_ctlun.ip6_un1.ip6_un1_hlim
105 
106 #define	IPV6_VERSION		0x60
107 #define	IPV6_VERSION_MASK	0xf0
108 
109 #if BYTE_ORDER == BIG_ENDIAN
110 #define	IPV6_FLOWINFO_MASK	0x0fffffff	/* flow info (28 bits) */
111 #define	IPV6_FLOWLABEL_MASK	0x000fffff	/* flow label (20 bits) */
112 #endif /* BIG_ENDIAN */
113 #if BYTE_ORDER == LITTLE_ENDIAN
114 #define	IPV6_FLOWINFO_MASK	0xffffff0f	/* flow info (28 bits) */
115 #define	IPV6_FLOWLABEL_MASK	0xffff0f00	/* flow label (20 bits) */
116 #endif /* LITTLE_ENDIAN */
117 /* ECN bits proposed by Sally Floyd */
118 #define	IP6TOS_CE		0x01	/* congestion experienced */
119 #define	IP6TOS_ECT		0x02	/* ECN-capable transport */
120 
121 /*
122  * Extension Headers
123  */
124 
125 struct	ip6_ext {
126 	u_char	ip6e_nxt;
127 	u_char	ip6e_len;
128 };
129 
130 /* Hop-by-Hop options header */
131 /* XXX should we pad it to force alignment on an 8-byte boundary? */
132 struct ip6_hbh {
133 	u_int8_t	ip6h_nxt;	/* next header */
134 	u_int8_t	ip6h_len;	/* length in units of 8 octets */
135 	/* followed by options */
136 };
137 
138 /* Destination options header */
139 /* XXX should we pad it to force alignment on an 8-byte boundary? */
140 struct ip6_dest {
141 	u_int8_t	ip6d_nxt;	/* next header */
142 	u_int8_t	ip6d_len;	/* length in units of 8 octets */
143 	/* followed by options */
144 };
145 
146 /* Option types and related macros */
147 #define	IP6OPT_PAD1		0x00	/* 00 0 00000 */
148 #define	IP6OPT_PADN		0x01	/* 00 0 00001 */
149 #define	IP6OPT_JUMBO		0xC2	/* 11 0 00010 = 194 */
150 #define	IP6OPT_JUMBO_LEN	6
151 #define	IP6OPT_RTALERT		0x05	/* 00 0 00101 */
152 #define	IP6OPT_RTALERT_LEN	4
153 #define	IP6OPT_RTALERT_MLD	0	/* Datagram contains an MLD message */
154 #define	IP6OPT_RTALERT_RSVP	1	/* Datagram contains an RSVP message */
155 #define	IP6OPT_RTALERT_ACTNET	2 	/* contains an Active Networks msg */
156 #define	IP6OPT_MINLEN		2
157 
158 #define	IP6OPT_TYPE(o)		((o) & 0xC0)
159 #define	IP6OPT_TYPE_SKIP	0x00
160 #define	IP6OPT_TYPE_DISCARD	0x40
161 #define	IP6OPT_TYPE_FORCEICMP	0x80
162 #define	IP6OPT_TYPE_ICMP	0xC0
163 
164 #define	IP6OPT_MUTABLE		0x20
165 
166 /* Routing header */
167 struct ip6_rthdr {
168 	u_int8_t	ip6r_nxt;	/* next header */
169 	u_int8_t	ip6r_len;	/* length in units of 8 octets */
170 	u_int8_t	ip6r_type;	/* routing type */
171 	u_int8_t	ip6r_segleft;	/* segments left */
172 	/* followed by routing type specific data */
173 };
174 
175 /* Type 0 Routing header */
176 struct ip6_rthdr0 {
177 	u_int8_t	ip6r0_nxt;		/* next header */
178 	u_int8_t	ip6r0_len;		/* length in units of 8 octets */
179 	u_int8_t	ip6r0_type;		/* always zero */
180 	u_int8_t	ip6r0_segleft;	/* segments left */
181 	u_int8_t	ip6r0_reserved;	/* reserved field */
182 	u_int8_t	ip6r0_slmap[3];	/* strict/loose bit map */
183 	struct	in6_addr  ip6r0_addr[1];	/* up to 23 addresses */
184 };
185 
186 /* Fragment header */
187 struct ip6_frag {
188 	u_int8_t	ip6f_nxt;		/* next header */
189 	u_int8_t	ip6f_reserved;	/* reserved field */
190 	u_int16_t	ip6f_offlg;		/* offset, reserved, and flag */
191 	u_int32_t	ip6f_ident;		/* identification */
192 };
193 
194 #if BYTE_ORDER == BIG_ENDIAN
195 #define	IP6F_OFF_MASK		0xfff8	/* mask out offset from _offlg */
196 #define	IP6F_RESERVED_MASK	0x0006	/* reserved bits in ip6f_offlg */
197 #define	IP6F_MORE_FRAG		0x0001	/* more-fragments flag */
198 #else /* BYTE_ORDER == LITTLE_ENDIAN */
199 #define	IP6F_OFF_MASK		0xf8ff	/* mask out offset from _offlg */
200 #define	IP6F_RESERVED_MASK	0x0600	/* reserved bits in ip6f_offlg */
201 #define	IP6F_MORE_FRAG		0x0100	/* more-fragments flag */
202 #endif /* BYTE_ORDER == LITTLE_ENDIAN */
203 
204 /*
205  * Internet implementation parameters.
206  */
207 #define	IPV6_MAXHLIM	255	/* maximun hoplimit */
208 #define	IPV6_DEFHLIM	64	/* default hlim */
209 #define	IPV6_FRAGTTL	120	/* ttl for fragment packets, in slowtimo tick */
210 #define	IPV6_HLIMDEC	1	/* subtracted when forwaeding */
211 
212 #define	IPV6_MMTU	1280	/* minimal MTU and reassembly. 1024 + 256 */
213 #define	IPV6_MAXPACKET	65535	/* ip6 max packet size without Jumbo payload*/
214 
215 /*
216  * IP6_EXTHDR_CHECK ensures that region between the IP6 header and the
217  * target header (including IPv6 itself, extension headers and
218  * TCP/UDP/ICMP6 headers) are continuous. KAME requires drivers
219  * to store incoming data into one internal mbuf or one or more external
220  * mbufs(never into two or more internal mbufs). Thus, the third case is
221  * supposed to never be matched but is prepared just in case.
222  */
223 
224 #define	IP6_EXTHDR_CHECK(m, off, hlen, ret)				\
225 do {									\
226     if ((m)->m_next != NULL) {						\
227 	if (((m)->m_flags & M_LOOP) &&					\
228 	    ((m)->m_len < (off) + (hlen)) &&				\
229 	    (((m) = m_pullup((m), (off) + (hlen))) == NULL)) {		\
230 		ip6stat.ip6s_exthdrtoolong++;				\
231 		return ret;						\
232 	} else if ((m)->m_flags & M_EXT) {				\
233 		if ((m)->m_len < (off) + (hlen)) {			\
234 			ip6stat.ip6s_exthdrtoolong++;			\
235 			m_freem(m);					\
236 			return ret;					\
237 		}							\
238 	} else {							\
239 		if ((m)->m_len < (off) + (hlen)) {			\
240 			ip6stat.ip6s_exthdrtoolong++;			\
241 			m_freem(m);					\
242 			return ret;					\
243 		}							\
244 	}								\
245     } else {								\
246 	if ((m)->m_len < (off) + (hlen)) {				\
247 		ip6stat.ip6s_tooshort++;				\
248 		in6_ifstat_inc(m->m_pkthdr.rcvif, ifs6_in_truncated);	\
249 		m_freem(m);						\
250 		return ret;						\
251 	}								\
252     }									\
253 } while (0)
254 
255 #endif /* not _NETINET_IPV6_H_ */
256