]> git.saurik.com Git - apple/xnu.git/blame - bsd/netinet/ip6.h
xnu-4570.51.1.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) */
813fb2f6 130#define IPV6_FLOW_ECN_MASK 0x00300000 /* the 2 ECN bits */
1c79356b
A
131#else
132#if BYTE_ORDER == LITTLE_ENDIAN
133#define IPV6_FLOWINFO_MASK 0xffffff0f /* flow info (28 bits) */
134#define IPV6_FLOWLABEL_MASK 0xffff0f00 /* flow label (20 bits) */
813fb2f6 135#define IPV6_FLOW_ECN_MASK 0x00000300 /* the 2 ECN bits */
1c79356b
A
136#endif /* LITTLE_ENDIAN */
137#endif
138#if 1
139/* ECN bits proposed by Sally Floyd */
140#define IP6TOS_CE 0x01 /* congestion experienced */
141#define IP6TOS_ECT 0x02 /* ECN-capable transport */
142#endif
143
813fb2f6
A
144#define IP6FLOW_ECN_MASK 0x00300000
145
39037602
A
146/*
147 * To access the 6 bits of the DSCP value in the 32 bits ip6_flow field
148 */
149#define IP6FLOW_DSCP_MASK 0x0fc00000
150#define IP6FLOW_DSCP_SHIFT 22
151
1c79356b
A
152/*
153 * Extension Headers
154 */
155
156struct ip6_ext {
9bccf70c
A
157 u_int8_t ip6e_nxt;
158 u_int8_t ip6e_len;
159} __attribute__((__packed__));
1c79356b
A
160
161/* Hop-by-Hop options header */
162/* XXX should we pad it to force alignment on an 8-byte boundary? */
163struct ip6_hbh {
164 u_int8_t ip6h_nxt; /* next header */
165 u_int8_t ip6h_len; /* length in units of 8 octets */
166 /* followed by options */
9bccf70c 167} __attribute__((__packed__));
1c79356b
A
168
169/* Destination options header */
170/* XXX should we pad it to force alignment on an 8-byte boundary? */
171struct ip6_dest {
172 u_int8_t ip6d_nxt; /* next header */
173 u_int8_t ip6d_len; /* length in units of 8 octets */
174 /* followed by options */
9bccf70c 175} __attribute__((__packed__));
1c79356b
A
176
177/* Option types and related macros */
178#define IP6OPT_PAD1 0x00 /* 00 0 00000 */
179#define IP6OPT_PADN 0x01 /* 00 0 00001 */
180#define IP6OPT_JUMBO 0xC2 /* 11 0 00010 = 194 */
181#define IP6OPT_NSAP_ADDR 0xC3 /* 11 0 00011 */
182#define IP6OPT_TUNNEL_LIMIT 0x04 /* 00 0 00100 */
6d2010ae 183#ifndef KERNEL_PRIVATE
1c79356b 184#define IP6OPT_RTALERT 0x05 /* 00 0 00101 (KAME definition) */
6d2010ae
A
185#endif
186#define IP6OPT_ROUTER_ALERT 0x05 /* 00 0 00101 (RFC3542, recommended) */
1c79356b
A
187
188#define IP6OPT_RTALERT_LEN 4
189#define IP6OPT_RTALERT_MLD 0 /* Datagram contains an MLD message */
190#define IP6OPT_RTALERT_RSVP 1 /* Datagram contains an RSVP message */
191#define IP6OPT_RTALERT_ACTNET 2 /* contains an Active Networks msg */
192#define IP6OPT_MINLEN 2
193
9bccf70c 194#define IP6OPT_EID 0x8a /* 10 0 01010 */
1c79356b
A
195
196#define IP6OPT_TYPE(o) ((o) & 0xC0)
197#define IP6OPT_TYPE_SKIP 0x00
198#define IP6OPT_TYPE_DISCARD 0x40
199#define IP6OPT_TYPE_FORCEICMP 0x80
200#define IP6OPT_TYPE_ICMP 0xC0
201
202#define IP6OPT_MUTABLE 0x20
203
6d2010ae
A
204/* IPv6 options: common part */
205struct ip6_opt {
206 u_int8_t ip6o_type;
207 u_int8_t ip6o_len;
208} __attribute__((__packed__));
209
210/* Jumbo Payload Option */
211struct ip6_opt_jumbo {
212 u_int8_t ip6oj_type;
213 u_int8_t ip6oj_len;
214 u_int8_t ip6oj_jumbo_len[4];
215} __attribute__((__packed__));
9bccf70c 216#define IP6OPT_JUMBO_LEN 6
1c79356b 217
6d2010ae
A
218/* NSAP Address Option */
219struct ip6_opt_nsap {
220 u_int8_t ip6on_type;
221 u_int8_t ip6on_len;
222 u_int8_t ip6on_src_nsap_len;
223 u_int8_t ip6on_dst_nsap_len;
224 /* followed by source NSAP */
225 /* followed by destination NSAP */
226}__attribute__((__packed__));
227
228/* Tunnel Limit Option */
229struct ip6_opt_tunnel {
230 u_int8_t ip6ot_type;
231 u_int8_t ip6ot_len;
232 u_int8_t ip6ot_encap_limit;
233}__attribute__((__packed__));
234
235/* Router Alert Option */
236struct ip6_opt_router {
237 u_int8_t ip6or_type;
238 u_int8_t ip6or_len;
239 u_int8_t ip6or_value[2];
240}__attribute__((__packed__));
241/* Router alert values (in network byte order) */
242#if BYTE_ORDER == BIG_ENDIAN
243#define IP6_ALERT_MLD 0x0000
244#define IP6_ALERT_RSVP 0x0001
245#define IP6_ALERT_AN 0x0002
246#else
247#if BYTE_ORDER == LITTLE_ENDIAN
248#define IP6_ALERT_MLD 0x0000
249#define IP6_ALERT_RSVP 0x0100
250#define IP6_ALERT_AN 0x0200
251#endif /* LITTLE_ENDIAN */
252#endif
253
1c79356b
A
254/* Routing header */
255struct ip6_rthdr {
256 u_int8_t ip6r_nxt; /* next header */
257 u_int8_t ip6r_len; /* length in units of 8 octets */
258 u_int8_t ip6r_type; /* routing type */
259 u_int8_t ip6r_segleft; /* segments left */
260 /* followed by routing type specific data */
9bccf70c 261} __attribute__((__packed__));
1c79356b
A
262
263/* Type 0 Routing header */
264struct ip6_rthdr0 {
265 u_int8_t ip6r0_nxt; /* next header */
266 u_int8_t ip6r0_len; /* length in units of 8 octets */
267 u_int8_t ip6r0_type; /* always zero */
268 u_int8_t ip6r0_segleft; /* segments left */
9bccf70c
A
269 u_int8_t ip6r0_reserved; /* reserved field */
270 u_int8_t ip6r0_slmap[3]; /* strict/loose bit map */
271 struct in6_addr ip6r0_addr[1]; /* up to 23 addresses */
272} __attribute__((__packed__));
1c79356b
A
273
274/* Fragment header */
275struct ip6_frag {
276 u_int8_t ip6f_nxt; /* next header */
277 u_int8_t ip6f_reserved; /* reserved field */
278 u_int16_t ip6f_offlg; /* offset, reserved, and flag */
279 u_int32_t ip6f_ident; /* identification */
9bccf70c 280} __attribute__((__packed__));
1c79356b
A
281
282#if BYTE_ORDER == BIG_ENDIAN
283#define IP6F_OFF_MASK 0xfff8 /* mask out offset from _offlg */
284#define IP6F_RESERVED_MASK 0x0006 /* reserved bits in ip6f_offlg */
285#define IP6F_MORE_FRAG 0x0001 /* more-fragments flag */
286#else /* BYTE_ORDER == LITTLE_ENDIAN */
287#define IP6F_OFF_MASK 0xf8ff /* mask out offset from _offlg */
288#define IP6F_RESERVED_MASK 0x0600 /* reserved bits in ip6f_offlg */
289#define IP6F_MORE_FRAG 0x0100 /* more-fragments flag */
290#endif /* BYTE_ORDER == LITTLE_ENDIAN */
291
292/*
293 * Internet implementation parameters.
294 */
6d2010ae 295#define IPV6_MAXHLIM 255 /* maximum hoplimit */
1c79356b 296#define IPV6_DEFHLIM 64 /* default hlim */
39236c6e 297#define IPV6_FRAGTTL 60 /* ttl for fragment packets (seconds) */
6d2010ae 298#define IPV6_HLIMDEC 1 /* subtracted when forwarding */
1c79356b
A
299
300#define IPV6_MMTU 1280 /* minimal MTU and reassembly. 1024 + 256 */
301#define IPV6_MAXPACKET 65535 /* ip6 max packet size without Jumbo payload*/
6d2010ae 302#define IPV6_MAXOPTHDR 2048 /* max option header size, 256 64-bit words */
1c79356b 303
39236c6e 304#ifdef BSD_KERNEL_PRIVATE
1c79356b
A
305/*
306 * IP6_EXTHDR_CHECK ensures that region between the IP6 header and the
307 * target header (including IPv6 itself, extension headers and
308 * TCP/UDP/ICMP6 headers) are continuous. KAME requires drivers
309 * to store incoming data into one internal mbuf or one or more external
310 * mbufs(never into two or more internal mbufs). Thus, the third case is
311 * supposed to never be matched but is prepared just in case.
312 */
313
91447636 314#define IP6_EXTHDR_CHECK(m, off, hlen, action) \
1c79356b
A
315do { \
316 if ((m)->m_next != NULL) { \
317 if (((m)->m_flags & M_LOOP) && \
318 ((m)->m_len < (off) + (hlen)) && \
319 (((m) = m_pullup((m), (off) + (hlen))) == NULL)) { \
320 ip6stat.ip6s_exthdrtoolong++; \
91447636 321 action; \
1c79356b
A
322 } else if ((m)->m_flags & M_EXT) { \
323 if ((m)->m_len < (off) + (hlen)) { \
324 ip6stat.ip6s_exthdrtoolong++; \
325 m_freem(m); \
39236c6e 326 (m) = NULL; \
91447636 327 action; \
1c79356b
A
328 } \
329 } else { \
330 if ((m)->m_len < (off) + (hlen)) { \
331 ip6stat.ip6s_exthdrtoolong++; \
332 m_freem(m); \
39236c6e 333 (m) = NULL; \
91447636 334 action; \
1c79356b
A
335 } \
336 } \
9bccf70c 337 } else { \
1c79356b
A
338 if ((m)->m_len < (off) + (hlen)) { \
339 ip6stat.ip6s_tooshort++; \
340 in6_ifstat_inc(m->m_pkthdr.rcvif, ifs6_in_truncated); \
341 m_freem(m); \
39236c6e 342 (m) = NULL; \
91447636 343 action; \
1c79356b
A
344 } \
345 } \
346} while (0)
347
348/*
349 * IP6_EXTHDR_GET ensures that intermediate protocol header (from "off" to
350 * "len") is located in single mbuf, on contiguous memory region.
351 * The pointer to the region will be returned to pointer variable "val",
352 * with type "typ".
353 * IP6_EXTHDR_GET0 does the same, except that it aligns the structure at the
354 * very top of mbuf. GET0 is likely to make memory copy than GET.
1c79356b 355 */
6d2010ae
A
356#define IP6_EXTHDR_GET(val, typ, m, off, len) \
357 M_STRUCT_GET(val, typ, m, off, len)
1c79356b 358
6d2010ae
A
359#define IP6_EXTHDR_GET0(val, typ, m, off, len) \
360 M_STRUCT_GET0(val, typ, m, off, len)
1c79356b 361
39236c6e 362#endif /* BSD_KERNEL_PRIVATE */
b0d623f7 363#endif /* !_NETINET_IP6_H_ */