]> git.saurik.com Git - apple/xnu.git/blame - bsd/netinet/ip6.h
xnu-3789.1.32.tar.gz
[apple/xnu.git] / bsd / netinet / ip6.h
CommitLineData
1c79356b 1/*
39037602 2 * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
5d5c5d0d 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
8f6c56a5 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b 27 */
9bccf70c 28/* $KAME: ip6.h,v 1.18 2001/03/29 05:34:30 itojun Exp $*/
1c79356b
A
29
30/*
31 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
32 * All rights reserved.
33 *
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions
36 * are met:
37 * 1. Redistributions of source code must retain the above copyright
38 * notice, this list of conditions and the following disclaimer.
39 * 2. Redistributions in binary form must reproduce the above copyright
40 * notice, this list of conditions and the following disclaimer in the
41 * documentation and/or other materials provided with the distribution.
42 * 3. Neither the name of the project nor the names of its contributors
43 * may be used to endorse or promote products derived from this software
44 * without specific prior written permission.
45 *
46 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
47 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
50 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
51 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
52 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
53 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
54 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56 * SUCH DAMAGE.
57 */
58
59/*
60 * Copyright (c) 1982, 1986, 1993
61 * The Regents of the University of California. All rights reserved.
62 *
63 * Redistribution and use in source and binary forms, with or without
64 * modification, are permitted provided that the following conditions
65 * are met:
66 * 1. Redistributions of source code must retain the above copyright
67 * notice, this list of conditions and the following disclaimer.
68 * 2. Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in the
70 * documentation and/or other materials provided with the distribution.
71 * 3. All advertising materials mentioning features or use of this software
72 * must display the following acknowledgement:
73 * This product includes software developed by the University of
74 * California, Berkeley and its contributors.
75 * 4. Neither the name of the University nor the names of its contributors
76 * may be used to endorse or promote products derived from this software
77 * without specific prior written permission.
78 *
79 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
80 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
81 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
82 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
83 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
84 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
85 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
86 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
87 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
88 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
89 * SUCH DAMAGE.
90 *
91 * @(#)ip.h 8.1 (Berkeley) 6/10/93
92 */
93
94#ifndef _NETINET_IP6_H_
95#define _NETINET_IP6_H_
9bccf70c 96#include <sys/appleapiopts.h>
1c79356b
A
97
98/*
99 * Definition for internet protocol version 6.
100 * RFC 2460
101 */
102
103struct ip6_hdr {
104 union {
105 struct ip6_hdrctl {
106 u_int32_t ip6_un1_flow; /* 20 bits of flow-ID */
107 u_int16_t ip6_un1_plen; /* payload length */
108 u_int8_t ip6_un1_nxt; /* next header */
109 u_int8_t ip6_un1_hlim; /* hop limit */
110 } ip6_un1;
111 u_int8_t ip6_un2_vfc; /* 4 bits version, top 4 bits class */
112 } ip6_ctlun;
113 struct in6_addr ip6_src; /* source address */
114 struct in6_addr ip6_dst; /* destination address */
9bccf70c 115} __attribute__((__packed__));
1c79356b
A
116
117#define ip6_vfc ip6_ctlun.ip6_un2_vfc
118#define ip6_flow ip6_ctlun.ip6_un1.ip6_un1_flow
119#define ip6_plen ip6_ctlun.ip6_un1.ip6_un1_plen
120#define ip6_nxt ip6_ctlun.ip6_un1.ip6_un1_nxt
121#define ip6_hlim ip6_ctlun.ip6_un1.ip6_un1_hlim
122#define ip6_hops ip6_ctlun.ip6_un1.ip6_un1_hlim
123
124#define IPV6_VERSION 0x60
125#define IPV6_VERSION_MASK 0xf0
126
127#if BYTE_ORDER == BIG_ENDIAN
128#define IPV6_FLOWINFO_MASK 0x0fffffff /* flow info (28 bits) */
129#define IPV6_FLOWLABEL_MASK 0x000fffff /* flow label (20 bits) */
130#else
131#if BYTE_ORDER == LITTLE_ENDIAN
132#define IPV6_FLOWINFO_MASK 0xffffff0f /* flow info (28 bits) */
133#define IPV6_FLOWLABEL_MASK 0xffff0f00 /* flow label (20 bits) */
134#endif /* LITTLE_ENDIAN */
135#endif
136#if 1
137/* ECN bits proposed by Sally Floyd */
138#define IP6TOS_CE 0x01 /* congestion experienced */
139#define IP6TOS_ECT 0x02 /* ECN-capable transport */
140#endif
141
39037602
A
142/*
143 * To access the 6 bits of the DSCP value in the 32 bits ip6_flow field
144 */
145#define IP6FLOW_DSCP_MASK 0x0fc00000
146#define IP6FLOW_DSCP_SHIFT 22
147
1c79356b
A
148/*
149 * Extension Headers
150 */
151
152struct ip6_ext {
9bccf70c
A
153 u_int8_t ip6e_nxt;
154 u_int8_t ip6e_len;
155} __attribute__((__packed__));
1c79356b
A
156
157/* Hop-by-Hop options header */
158/* XXX should we pad it to force alignment on an 8-byte boundary? */
159struct ip6_hbh {
160 u_int8_t ip6h_nxt; /* next header */
161 u_int8_t ip6h_len; /* length in units of 8 octets */
162 /* followed by options */
9bccf70c 163} __attribute__((__packed__));
1c79356b
A
164
165/* Destination options header */
166/* XXX should we pad it to force alignment on an 8-byte boundary? */
167struct ip6_dest {
168 u_int8_t ip6d_nxt; /* next header */
169 u_int8_t ip6d_len; /* length in units of 8 octets */
170 /* followed by options */
9bccf70c 171} __attribute__((__packed__));
1c79356b
A
172
173/* Option types and related macros */
174#define IP6OPT_PAD1 0x00 /* 00 0 00000 */
175#define IP6OPT_PADN 0x01 /* 00 0 00001 */
176#define IP6OPT_JUMBO 0xC2 /* 11 0 00010 = 194 */
177#define IP6OPT_NSAP_ADDR 0xC3 /* 11 0 00011 */
178#define IP6OPT_TUNNEL_LIMIT 0x04 /* 00 0 00100 */
6d2010ae 179#ifndef KERNEL_PRIVATE
1c79356b 180#define IP6OPT_RTALERT 0x05 /* 00 0 00101 (KAME definition) */
6d2010ae
A
181#endif
182#define IP6OPT_ROUTER_ALERT 0x05 /* 00 0 00101 (RFC3542, recommended) */
1c79356b
A
183
184#define IP6OPT_RTALERT_LEN 4
185#define IP6OPT_RTALERT_MLD 0 /* Datagram contains an MLD message */
186#define IP6OPT_RTALERT_RSVP 1 /* Datagram contains an RSVP message */
187#define IP6OPT_RTALERT_ACTNET 2 /* contains an Active Networks msg */
188#define IP6OPT_MINLEN 2
189
9bccf70c 190#define IP6OPT_EID 0x8a /* 10 0 01010 */
1c79356b
A
191
192#define IP6OPT_TYPE(o) ((o) & 0xC0)
193#define IP6OPT_TYPE_SKIP 0x00
194#define IP6OPT_TYPE_DISCARD 0x40
195#define IP6OPT_TYPE_FORCEICMP 0x80
196#define IP6OPT_TYPE_ICMP 0xC0
197
198#define IP6OPT_MUTABLE 0x20
199
6d2010ae
A
200/* IPv6 options: common part */
201struct ip6_opt {
202 u_int8_t ip6o_type;
203 u_int8_t ip6o_len;
204} __attribute__((__packed__));
205
206/* Jumbo Payload Option */
207struct ip6_opt_jumbo {
208 u_int8_t ip6oj_type;
209 u_int8_t ip6oj_len;
210 u_int8_t ip6oj_jumbo_len[4];
211} __attribute__((__packed__));
9bccf70c 212#define IP6OPT_JUMBO_LEN 6
1c79356b 213
6d2010ae
A
214/* NSAP Address Option */
215struct ip6_opt_nsap {
216 u_int8_t ip6on_type;
217 u_int8_t ip6on_len;
218 u_int8_t ip6on_src_nsap_len;
219 u_int8_t ip6on_dst_nsap_len;
220 /* followed by source NSAP */
221 /* followed by destination NSAP */
222}__attribute__((__packed__));
223
224/* Tunnel Limit Option */
225struct ip6_opt_tunnel {
226 u_int8_t ip6ot_type;
227 u_int8_t ip6ot_len;
228 u_int8_t ip6ot_encap_limit;
229}__attribute__((__packed__));
230
231/* Router Alert Option */
232struct ip6_opt_router {
233 u_int8_t ip6or_type;
234 u_int8_t ip6or_len;
235 u_int8_t ip6or_value[2];
236}__attribute__((__packed__));
237/* Router alert values (in network byte order) */
238#if BYTE_ORDER == BIG_ENDIAN
239#define IP6_ALERT_MLD 0x0000
240#define IP6_ALERT_RSVP 0x0001
241#define IP6_ALERT_AN 0x0002
242#else
243#if BYTE_ORDER == LITTLE_ENDIAN
244#define IP6_ALERT_MLD 0x0000
245#define IP6_ALERT_RSVP 0x0100
246#define IP6_ALERT_AN 0x0200
247#endif /* LITTLE_ENDIAN */
248#endif
249
1c79356b
A
250/* Routing header */
251struct ip6_rthdr {
252 u_int8_t ip6r_nxt; /* next header */
253 u_int8_t ip6r_len; /* length in units of 8 octets */
254 u_int8_t ip6r_type; /* routing type */
255 u_int8_t ip6r_segleft; /* segments left */
256 /* followed by routing type specific data */
9bccf70c 257} __attribute__((__packed__));
1c79356b
A
258
259/* Type 0 Routing header */
260struct ip6_rthdr0 {
261 u_int8_t ip6r0_nxt; /* next header */
262 u_int8_t ip6r0_len; /* length in units of 8 octets */
263 u_int8_t ip6r0_type; /* always zero */
264 u_int8_t ip6r0_segleft; /* segments left */
9bccf70c
A
265 u_int8_t ip6r0_reserved; /* reserved field */
266 u_int8_t ip6r0_slmap[3]; /* strict/loose bit map */
267 struct in6_addr ip6r0_addr[1]; /* up to 23 addresses */
268} __attribute__((__packed__));
1c79356b
A
269
270/* Fragment header */
271struct ip6_frag {
272 u_int8_t ip6f_nxt; /* next header */
273 u_int8_t ip6f_reserved; /* reserved field */
274 u_int16_t ip6f_offlg; /* offset, reserved, and flag */
275 u_int32_t ip6f_ident; /* identification */
9bccf70c 276} __attribute__((__packed__));
1c79356b
A
277
278#if BYTE_ORDER == BIG_ENDIAN
279#define IP6F_OFF_MASK 0xfff8 /* mask out offset from _offlg */
280#define IP6F_RESERVED_MASK 0x0006 /* reserved bits in ip6f_offlg */
281#define IP6F_MORE_FRAG 0x0001 /* more-fragments flag */
282#else /* BYTE_ORDER == LITTLE_ENDIAN */
283#define IP6F_OFF_MASK 0xf8ff /* mask out offset from _offlg */
284#define IP6F_RESERVED_MASK 0x0600 /* reserved bits in ip6f_offlg */
285#define IP6F_MORE_FRAG 0x0100 /* more-fragments flag */
286#endif /* BYTE_ORDER == LITTLE_ENDIAN */
287
288/*
289 * Internet implementation parameters.
290 */
6d2010ae 291#define IPV6_MAXHLIM 255 /* maximum hoplimit */
1c79356b 292#define IPV6_DEFHLIM 64 /* default hlim */
39236c6e 293#define IPV6_FRAGTTL 60 /* ttl for fragment packets (seconds) */
6d2010ae 294#define IPV6_HLIMDEC 1 /* subtracted when forwarding */
1c79356b
A
295
296#define IPV6_MMTU 1280 /* minimal MTU and reassembly. 1024 + 256 */
297#define IPV6_MAXPACKET 65535 /* ip6 max packet size without Jumbo payload*/
6d2010ae 298#define IPV6_MAXOPTHDR 2048 /* max option header size, 256 64-bit words */
1c79356b 299
39236c6e 300#ifdef BSD_KERNEL_PRIVATE
1c79356b
A
301/*
302 * IP6_EXTHDR_CHECK ensures that region between the IP6 header and the
303 * target header (including IPv6 itself, extension headers and
304 * TCP/UDP/ICMP6 headers) are continuous. KAME requires drivers
305 * to store incoming data into one internal mbuf or one or more external
306 * mbufs(never into two or more internal mbufs). Thus, the third case is
307 * supposed to never be matched but is prepared just in case.
308 */
309
91447636 310#define IP6_EXTHDR_CHECK(m, off, hlen, action) \
1c79356b
A
311do { \
312 if ((m)->m_next != NULL) { \
313 if (((m)->m_flags & M_LOOP) && \
314 ((m)->m_len < (off) + (hlen)) && \
315 (((m) = m_pullup((m), (off) + (hlen))) == NULL)) { \
316 ip6stat.ip6s_exthdrtoolong++; \
91447636 317 action; \
1c79356b
A
318 } else if ((m)->m_flags & M_EXT) { \
319 if ((m)->m_len < (off) + (hlen)) { \
320 ip6stat.ip6s_exthdrtoolong++; \
321 m_freem(m); \
39236c6e 322 (m) = NULL; \
91447636 323 action; \
1c79356b
A
324 } \
325 } else { \
326 if ((m)->m_len < (off) + (hlen)) { \
327 ip6stat.ip6s_exthdrtoolong++; \
328 m_freem(m); \
39236c6e 329 (m) = NULL; \
91447636 330 action; \
1c79356b
A
331 } \
332 } \
9bccf70c 333 } else { \
1c79356b
A
334 if ((m)->m_len < (off) + (hlen)) { \
335 ip6stat.ip6s_tooshort++; \
336 in6_ifstat_inc(m->m_pkthdr.rcvif, ifs6_in_truncated); \
337 m_freem(m); \
39236c6e 338 (m) = NULL; \
91447636 339 action; \
1c79356b
A
340 } \
341 } \
342} while (0)
343
344/*
345 * IP6_EXTHDR_GET ensures that intermediate protocol header (from "off" to
346 * "len") is located in single mbuf, on contiguous memory region.
347 * The pointer to the region will be returned to pointer variable "val",
348 * with type "typ".
349 * IP6_EXTHDR_GET0 does the same, except that it aligns the structure at the
350 * very top of mbuf. GET0 is likely to make memory copy than GET.
1c79356b 351 */
6d2010ae
A
352#define IP6_EXTHDR_GET(val, typ, m, off, len) \
353 M_STRUCT_GET(val, typ, m, off, len)
1c79356b 354
6d2010ae
A
355#define IP6_EXTHDR_GET0(val, typ, m, off, len) \
356 M_STRUCT_GET0(val, typ, m, off, len)
1c79356b 357
39236c6e 358#endif /* BSD_KERNEL_PRIVATE */
b0d623f7 359#endif /* !_NETINET_IP6_H_ */