1 /* $FreeBSD: src/sys/netinet/ip6.h,v 1.2.2.2 2001/07/03 11:01:46 ume Exp $ */ 2 /* $KAME: ip6.h,v 1.18 2001/03/29 05:34:30 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. 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 #ifndef _SYS_TYPES_H_ 72 #include <sys/types.h> 73 #endif 74 #ifndef _NETINET_IN_H_ 75 #include <netinet/in.h> 76 #endif 77 #include <machine/endian.h> 78 79 80 /* 81 * Definition for internet protocol version 6. 82 * RFC 2460 83 */ 84 85 struct ip6_hdr { 86 union { 87 struct ip6_hdrctl { 88 u_int32_t ip6_un1_flow; /* 20 bits of flow-ID */ 89 u_int16_t ip6_un1_plen; /* payload length */ 90 u_int8_t ip6_un1_nxt; /* next header */ 91 u_int8_t ip6_un1_hlim; /* hop limit */ 92 } ip6_un1; 93 u_int8_t ip6_un2_vfc; /* 4 bits version, top 4 bits class */ 94 } ip6_ctlun; 95 struct in6_addr ip6_src; /* source address */ 96 struct in6_addr ip6_dst; /* destination address */ 97 } __attribute__((__packed__)); 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 #elif _BYTE_ORDER == _LITTLE_ENDIAN 113 #define IPV6_FLOWINFO_MASK 0xffffff0f /* flow info (28 bits) */ 114 #define IPV6_FLOWLABEL_MASK 0xffff0f00 /* flow label (20 bits) */ 115 #else 116 #error "Byte order not implemented" 117 #endif 118 #if 1 119 /* ECN bits proposed by Sally Floyd */ 120 #define IP6TOS_CE 0x01 /* congestion experienced */ 121 #define IP6TOS_ECT 0x02 /* ECN-capable transport */ 122 #endif 123 124 /* 125 * Extension Headers 126 */ 127 128 struct ip6_ext { 129 u_int8_t ip6e_nxt; 130 u_int8_t ip6e_len; 131 } __attribute__((__packed__)); 132 133 /* Hop-by-Hop options header */ 134 /* XXX should we pad it to force alignment on an 8-byte boundary? */ 135 struct ip6_hbh { 136 u_int8_t ip6h_nxt; /* next header */ 137 u_int8_t ip6h_len; /* length in units of 8 octets */ 138 /* followed by options */ 139 } __attribute__((__packed__)); 140 141 /* Destination options header */ 142 /* XXX should we pad it to force alignment on an 8-byte boundary? */ 143 struct ip6_dest { 144 u_int8_t ip6d_nxt; /* next header */ 145 u_int8_t ip6d_len; /* length in units of 8 octets */ 146 /* followed by options */ 147 } __attribute__((__packed__)); 148 149 /* Option types and related macros */ 150 #define IP6OPT_PAD1 0x00 /* 00 0 00000 */ 151 #define IP6OPT_PADN 0x01 /* 00 0 00001 */ 152 #define IP6OPT_JUMBO 0xC2 /* 11 0 00010 = 194 */ 153 #define IP6OPT_NSAP_ADDR 0xC3 /* 11 0 00011 */ 154 #define IP6OPT_TUNNEL_LIMIT 0x04 /* 00 0 00100 */ 155 #define IP6OPT_RTALERT 0x05 /* 00 0 00101 (KAME definition) */ 156 157 #define IP6OPT_ROUTER_ALERT 0x05 /* 00 0 00101 (RFC3542, recommended) */ 158 #define IP6OPT_RTALERT_LEN 4 159 #define IP6OPT_RTALERT_MLD 0 /* Datagram contains an MLD message */ 160 #define IP6OPT_RTALERT_RSVP 1 /* Datagram contains an RSVP message */ 161 #define IP6OPT_RTALERT_ACTNET 2 /* contains an Active Networks msg */ 162 #define IP6OPT_MINLEN 2 163 164 #define IP6OPT_BINDING_UPDATE 0xc6 /* 11 0 00110 */ 165 #define IP6OPT_BINDING_ACK 0x07 /* 00 0 00111 */ 166 #define IP6OPT_BINDING_REQ 0x08 /* 00 0 01000 */ 167 #define IP6OPT_HOME_ADDRESS 0xc9 /* 11 0 01001 */ 168 #define IP6OPT_EID 0x8a /* 10 0 01010 */ 169 170 #define IP6OPT_TYPE(o) ((o) & 0xC0) 171 #define IP6OPT_TYPE_SKIP 0x00 172 #define IP6OPT_TYPE_DISCARD 0x40 173 #define IP6OPT_TYPE_FORCEICMP 0x80 174 #define IP6OPT_TYPE_ICMP 0xC0 175 176 #define IP6OPT_MUTABLE 0x20 177 178 /* Jumbo Payload Option */ 179 struct ip6_opt_jumbo { 180 u_int8_t ip6oj_type; 181 u_int8_t ip6oj_len; 182 u_int8_t ip6oj_jumbo_len[4]; 183 } __attribute__((__packed__)); 184 #define IP6OPT_JUMBO_LEN 6 185 186 /* IPv6 options: common part */ 187 struct ip6_opt { 188 u_int8_t ip6o_type; 189 u_int8_t ip6o_len; 190 } __attribute__((__packed__)); 191 192 193 /* NSAP Address Option */ 194 struct ip6_opt_nsap { 195 u_int8_t ip6on_type; 196 u_int8_t ip6on_len; 197 u_int8_t ip6on_src_nsap_len; 198 u_int8_t ip6on_dst_nsap_len; 199 /* followed by source NSAP */ 200 /* followed by destination NSAP */ 201 } __attribute__((__packed__)); 202 203 /* Tunnel Limit Option */ 204 struct ip6_opt_tunnel { 205 u_int8_t ip6ot_type; 206 u_int8_t ip6ot_len; 207 u_int8_t ip6ot_encap_limit; 208 } __attribute__((__packed__)); 209 210 /* Router Alert Option */ 211 struct ip6_opt_router { 212 u_int8_t ip6or_type; 213 u_int8_t ip6or_len; 214 u_int8_t ip6or_value[2]; 215 } __attribute__((__packed__)); 216 217 /* Router alert values (in network byte order) */ 218 #if BYTE_ORDER == BIG_ENDIAN 219 #define IP6_ALERT_MLD 0x0000 220 #define IP6_ALERT_RSVP 0x0001 221 #define IP6_ALERT_AN 0x0002 222 #else 223 #if BYTE_ORDER == LITTLE_ENDIAN 224 #define IP6_ALERT_MLD 0x0000 225 #define IP6_ALERT_RSVP 0x0100 226 #define IP6_ALERT_AN 0x0200 227 #endif /* LITTLE_ENDIAN */ 228 #endif 229 230 /* Routing header */ 231 struct ip6_rthdr { 232 u_int8_t ip6r_nxt; /* next header */ 233 u_int8_t ip6r_len; /* length in units of 8 octets */ 234 u_int8_t ip6r_type; /* routing type */ 235 u_int8_t ip6r_segleft; /* segments left */ 236 /* followed by routing type specific data */ 237 } __attribute__((__packed__)); 238 239 /* Fragment header */ 240 struct ip6_frag { 241 u_int8_t ip6f_nxt; /* next header */ 242 u_int8_t ip6f_reserved; /* reserved field */ 243 u_int16_t ip6f_offlg; /* offset, reserved, and flag */ 244 u_int32_t ip6f_ident; /* identification */ 245 } __attribute__((__packed__)); 246 247 #if _BYTE_ORDER == _BIG_ENDIAN 248 #define IP6F_OFF_MASK 0xfff8 /* mask out offset from _offlg */ 249 #define IP6F_RESERVED_MASK 0x0006 /* reserved bits in ip6f_offlg */ 250 #define IP6F_MORE_FRAG 0x0001 /* more-fragments flag */ 251 #elif _BYTE_ORDER == _LITTLE_ENDIAN 252 #define IP6F_OFF_MASK 0xf8ff /* mask out offset from _offlg */ 253 #define IP6F_RESERVED_MASK 0x0600 /* reserved bits in ip6f_offlg */ 254 #define IP6F_MORE_FRAG 0x0100 /* more-fragments flag */ 255 #else 256 #error "Byte order not implemented" 257 #endif 258 259 /* 260 * Internet implementation parameters. 261 */ 262 #define IPV6_MAXHLIM 255 /* maximun hoplimit */ 263 #define IPV6_DEFHLIM 64 /* default hlim */ 264 #define IPV6_MINHLIM 40 /* minimum hop limit */ 265 #define IPV6_FRAGTTL 120 /* ttl for fragment packets, in slowtimo tick */ 266 #define IPV6_HLIMDEC 1 /* subtracted when forwaeding */ 267 268 #define IPV6_MMTU 1280 /* minimal MTU and reassembly. 1024 + 256 */ 269 #define IPV6_MAXPACKET 65535 /* ip6 max packet size without Jumbo payload*/ 270 271 #ifdef _KERNEL 272 /* 273 * IP6_EXTHDR_CHECK ensures that region between the IP6 header and the 274 * target header (including IPv6 itself, extension headers and 275 * TCP/UDP/ICMP6 headers) are continuous. KAME requires drivers 276 * to store incoming data into one internal mbuf or one or more external 277 * mbufs(never into two or more internal mbufs). Thus, the third case is 278 * supposed to never be matched but is prepared just in case. 279 */ 280 281 #define IP6_EXTHDR_CHECK(m, off, hlen, ret) \ 282 do { \ 283 if ((m)->m_next != NULL) { \ 284 if (((m)->m_flags & M_LOOP) && \ 285 ((m)->m_len < (off) + (hlen)) && \ 286 (((m) = m_pullup((m), (off) + (hlen))) == NULL)) { \ 287 ip6stat.ip6s_exthdrtoolong++; \ 288 return ret; \ 289 } else if ((m)->m_flags & M_EXT) { \ 290 if ((m)->m_len < (off) + (hlen)) { \ 291 ip6stat.ip6s_exthdrtoolong++; \ 292 m_freem(m); \ 293 return ret; \ 294 } \ 295 } else { \ 296 if ((m)->m_len < (off) + (hlen)) { \ 297 ip6stat.ip6s_exthdrtoolong++; \ 298 m_freem(m); \ 299 return ret; \ 300 } \ 301 } \ 302 } else { \ 303 if ((m)->m_len < (off) + (hlen)) { \ 304 ip6stat.ip6s_tooshort++; \ 305 in6_ifstat_inc(m->m_pkthdr.rcvif, ifs6_in_truncated); \ 306 m_freem(m); \ 307 return ret; \ 308 } \ 309 } \ 310 } while (0) 311 312 #define IP6_EXTHDR_CHECK_VOIDRET(m, off, hlen) \ 313 IP6_EXTHDR_CHECK(m, off, hlen, ) 314 315 /* 316 * IP6_EXTHDR_GET ensures that intermediate protocol header (from "off" to 317 * "len") is located in single mbuf, on contiguous memory region. 318 * The pointer to the region will be returned to pointer variable "val", 319 * with type "typ". 320 * IP6_EXTHDR_GET0 does the same, except that it aligns the structure at the 321 * very top of mbuf. GET0 is likely to make memory copy than GET. 322 * 323 * XXX we're now testing this, needs m_pulldown() 324 */ 325 #define IP6_EXTHDR_GET(val, typ, m, off, len) \ 326 do { \ 327 struct mbuf *t; \ 328 int tmp; \ 329 if ((m)->m_len >= (off) + (len)) \ 330 (val) = (typ)(mtod((m), caddr_t) + (off)); \ 331 else { \ 332 t = m_pulldown((m), (off), (len), &tmp); \ 333 if (t) { \ 334 if (t->m_len < tmp + (len)) \ 335 panic("m_pulldown malfunction"); \ 336 (val) = (typ)(mtod(t, caddr_t) + tmp); \ 337 } else { \ 338 (val) = NULL; \ 339 (m) = NULL; \ 340 } \ 341 } \ 342 } while (0) 343 344 #define IP6_EXTHDR_GET0(val, typ, m, off, len) \ 345 do { \ 346 struct mbuf *t; \ 347 if ((off) == 0) \ 348 (val) = (typ)mtod(m, caddr_t); \ 349 else { \ 350 t = m_pulldown((m), (off), (len), NULL); \ 351 if (t) { \ 352 if (t->m_len < (len)) \ 353 panic("m_pulldown malfunction"); \ 354 (val) = (typ)mtod(t, caddr_t); \ 355 } else { \ 356 (val) = NULL; \ 357 (m) = NULL; \ 358 } \ 359 } \ 360 } while (0) 361 #endif /*_KERNEL*/ 362 363 #endif /* not _NETINET_IP6_H_ */ 364