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