1/*	NetBSD: ip6.h,v 1.9 2000/07/13 05:34:21 itojun Exp	*/
2/*	$KAME: ip6.h,v 1.9 2000/07/02 21:01:32 itojun 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. Neither the name of the University nor the names of its contributors
46 *    may be used to endorse or promote products derived from this software
47 *    without specific prior written permission.
48 *
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59 * SUCH DAMAGE.
60 *
61 *	@(#)ip.h	8.1 (Berkeley) 6/10/93
62 */
63
64#ifndef ND_IP6_H_
65#define ND_IP6_H_
66
67/*
68 * Definition for internet protocol version 6.
69 * RFC 2460
70 */
71
72struct ip6_hdr {
73	union {
74		struct ip6_hdrctl {
75			nd_uint32_t ip6_un1_flow;	/* 20 bits of flow-ID */
76			nd_uint16_t ip6_un1_plen;	/* payload length */
77			nd_uint8_t  ip6_un1_nxt;	/* next header */
78			nd_uint8_t  ip6_un1_hlim;	/* hop limit */
79		} ip6_un1;
80		nd_uint8_t ip6_un2_vfc;	/* 4 bits version, top 4 bits class */
81	} ip6_ctlun;
82	nd_ipv6 ip6_src;	/* source address */
83	nd_ipv6 ip6_dst;	/* destination address */
84};
85
86#define ip6_vfc		ip6_ctlun.ip6_un2_vfc
87#define IP6_VERSION(ip6_hdr)	((GET_U_1((ip6_hdr)->ip6_vfc) & 0xf0) >> 4)
88#define ip6_flow	ip6_ctlun.ip6_un1.ip6_un1_flow
89#define ip6_plen	ip6_ctlun.ip6_un1.ip6_un1_plen
90#define ip6_nxt		ip6_ctlun.ip6_un1.ip6_un1_nxt
91#define ip6_hlim	ip6_ctlun.ip6_un1.ip6_un1_hlim
92#define ip6_hops	ip6_ctlun.ip6_un1.ip6_un1_hlim
93
94/* in network endian */
95#define IPV6_FLOWINFO_MASK	((uint32_t)htonl(0x0fffffff))	/* flow info (28 bits) */
96#define IPV6_FLOWLABEL_MASK	((uint32_t)htonl(0x000fffff))	/* flow label (20 bits) */
97
98/*
99 * Extension Headers
100 */
101
102struct	ip6_ext {
103	nd_uint8_t ip6e_nxt;
104	nd_uint8_t ip6e_len;
105};
106
107/* Hop-by-Hop options header */
108struct ip6_hbh {
109	nd_uint8_t ip6h_nxt;	/* next header */
110	nd_uint8_t ip6h_len;	/* length in units of 8 octets */
111	/* followed by options */
112};
113
114/* Destination options header */
115struct ip6_dest {
116	nd_uint8_t ip6d_nxt;	/* next header */
117	nd_uint8_t ip6d_len;	/* length in units of 8 octets */
118	/* followed by options */
119};
120
121/* https://www.iana.org/assignments/ipv6-parameters/ipv6-parameters.xhtml */
122
123/* Option types and related macros */
124#define IP6OPT_PAD1		0x00	/* 00 0 00000 */
125#define IP6OPT_PADN		0x01	/* 00 0 00001 */
126#define IP6OPT_JUMBO		0xC2	/* 11 0 00010 = 194 */
127#define IP6OPT_JUMBO_LEN	6
128#define IP6OPT_RPL		0x63	/* 01 1 00011 */
129#define IP6OPT_TUN_ENC_LIMIT	0x04	/* 00 0 00100 */
130#define IP6OPT_ROUTER_ALERT	0x05	/* 00 0 00101 */
131
132#define IP6OPT_RTALERT_LEN	4
133#define IP6OPT_RTALERT_MLD	0	/* Datagram contains an MLD message */
134#define IP6OPT_RTALERT_RSVP	1	/* Datagram contains an RSVP message */
135#define IP6OPT_RTALERT_ACTNET	2	/* contains an Active Networks msg */
136#define IP6OPT_MINLEN		2
137
138#define IP6OPT_QUICK_START	0x26	/* 00 1 00110 */
139#define IP6OPT_CALIPSO		0x07	/* 00 0 00111 */
140#define IP6OPT_SMF_DPD		0x08	/* 00 0 01000 */
141#define IP6OPT_HOME_ADDRESS	0xc9	/* 11 0 01001 */
142#define IP6OPT_HOMEADDR_MINLEN	18
143#define IP6OPT_EID		0x8a	/* 10 0 01010 */
144#define IP6OPT_ILNP_NOTICE	0x8b	/* 10 0 01011 */
145#define IP6OPT_LINE_ID		0x8c	/* 10 0 01100 */
146#define IP6OPT_MPL		0x6d	/* 01 1 01101 */
147#define IP6OPT_IP_DFF		0xee	/* 11 1 01110 */
148
149#define IP6OPT_TYPE(o)		((o) & 0xC0)
150#define IP6OPT_TYPE_SKIP	0x00
151#define IP6OPT_TYPE_DISCARD	0x40
152#define IP6OPT_TYPE_FORCEICMP	0x80
153#define IP6OPT_TYPE_ICMP	0xC0
154
155#define IP6OPT_MUTABLE		0x20
156
157/* Routing header */
158struct ip6_rthdr {
159	nd_uint8_t  ip6r_nxt;		/* next header */
160	nd_uint8_t  ip6r_len;		/* length in units of 8 octets */
161	nd_uint8_t  ip6r_type;		/* routing type */
162	nd_uint8_t  ip6r_segleft;	/* segments left */
163	/* followed by routing type specific data */
164};
165
166#define IPV6_RTHDR_TYPE_0 0
167#define IPV6_RTHDR_TYPE_2 2
168#define IPV6_RTHDR_TYPE_4 4
169
170/* Type 0 Routing header */
171/* Also used for Type 2 */
172struct ip6_rthdr0 {
173	nd_uint8_t  ip6r0_nxt;		/* next header */
174	nd_uint8_t  ip6r0_len;		/* length in units of 8 octets */
175	nd_uint8_t  ip6r0_type;		/* always zero */
176	nd_uint8_t  ip6r0_segleft;	/* segments left */
177	nd_uint32_t ip6r0_reserved;	/* reserved field */
178	nd_ipv6     ip6r0_addr[1];	/* up to 23 addresses */
179};
180
181/**
182 * Type 4 Routing header
183 * known as Segment Routing Header 'SRH'
184 */
185struct ip6_srh {
186	nd_uint8_t	srh_nxt;		/* next header */
187	nd_uint8_t	srh_len;		/* length in units of 8 octets */
188	nd_uint8_t	srh_type;		/* Routing Type 4 */
189	nd_uint8_t	srh_segleft;		/* segments left */
190	nd_uint8_t	srh_last_ent;		/* Last Entry*/
191	nd_uint8_t	srh_flags;		/* Flags */
192	nd_uint16_t	srh_tag;		/* Tag */
193	nd_ipv6		srh_segments[1];	/* SRH segments list*/
194};
195
196/* Fragment header */
197struct ip6_frag {
198	nd_uint8_t  ip6f_nxt;		/* next header */
199	nd_uint8_t  ip6f_reserved;	/* reserved field */
200	nd_uint16_t ip6f_offlg;		/* offset, reserved, and flag */
201	nd_uint32_t ip6f_ident;		/* identification */
202};
203
204#define IP6F_OFF_MASK		0xfff8	/* mask out offset from ip6f_offlg */
205#define IP6F_RESERVED_MASK	0x0006	/* reserved bits in ip6f_offlg */
206#define IP6F_MORE_FRAG		0x0001	/* more-fragments flag */
207
208#endif /* not ND_IP6_H_ */
209