2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * ip6/packet.h: ip6 packet format
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #ifndef included_ip6_packet_h
41 #define included_ip6_packet_h
43 #include <vnet/tcp/tcp_packet.h>
44 #include <vnet/ip/ip4_packet.h>
52 uword as_uword[16 / sizeof (uword)];
58 ip6_address_t addr, mask;
59 } ip6_address_and_mask_t;
61 /* Packed so that the mhash key doesn't include uninitialized pad bytes */
63 typedef CLIB_PACKED (struct {
64 /* IP address must be first for ip_interface_address_get_address() to work */
65 ip6_address_t ip6_addr;
78 typedef CLIB_PACKED (union {
88 #define ip46_address_is_ip4(ip46) (((ip46)->pad[0] | (ip46)->pad[1] | (ip46)->pad[2]) == 0)
89 #define ip46_address_mask_ip4(ip46) ((ip46)->pad[0] = (ip46)->pad[1] = (ip46)->pad[2] = 0)
90 #define ip46_address_set_ip4(ip46, ip) (ip46_address_mask_ip4(ip46), (ip46)->ip4 = (ip)[0])
91 #define ip46_address_reset(ip46) ((ip46)->as_u64[0] = (ip46)->as_u64[1] = 0)
92 #define ip46_address_cmp(ip46_1, ip46_2) (memcmp(ip46_1, ip46_2, sizeof(*ip46_1)))
93 #define ip46_address_is_zero(ip46) (((ip46)->as_u64[0] == 0) && ((ip46)->as_u64[1] == 0))
94 #define ip46_address_is_equal(a1, a2) (((a1)->as_u64[0] == (a2)->as_u64[0]) \
95 && ((a1)->as_u64[1] == (a2)->as_u64[1]))
96 #define ip46_address_initializer {{{ 0 }}}
98 static_always_inline void
99 ip46_address_copy (ip46_address_t * dst, const ip46_address_t * src)
101 dst->as_u64[0] = src->as_u64[0];
102 dst->as_u64[1] = src->as_u64[1];
105 static_always_inline void
106 ip46_address_set_ip6 (ip46_address_t * dst, const ip6_address_t * src)
108 dst->as_u64[0] = src->as_u64[0];
109 dst->as_u64[1] = src->as_u64[1];
112 always_inline ip46_address_t
113 to_ip46 (u32 is_ipv6, u8 * buf)
117 ip.ip6 = *((ip6_address_t *) buf);
119 ip46_address_set_ip4 (&ip, (ip4_address_t *) buf);
125 ip6_addr_fib_init (ip6_address_fib_t * addr_fib,
126 const ip6_address_t * address, u32 fib_index)
128 addr_fib->ip6_addr = *address;
129 addr_fib->fib_index = fib_index;
132 /* Special addresses:
135 global unicast 2000::/3
136 unique local unicast fc00::/7
137 link local unicast fe80::/10
139 ietf reserved everything else. */
141 #define foreach_ip6_multicast_address_scope \
143 _ (link_local, 0x2) \
144 _ (admin_local, 0x4) \
145 _ (site_local, 0x5) \
146 _ (organization_local, 0x8) \
149 #define foreach_ip6_multicast_link_local_group_id \
151 _ (all_routers, 0x2) \
152 _ (rip_routers, 0x9) \
153 _ (eigrp_routers, 0xa) \
154 _ (pim_routers, 0xd) \
155 _ (mldv2_routers, 0x16)
159 #define _(f,n) IP6_MULTICAST_SCOPE_##f = n,
160 foreach_ip6_multicast_address_scope
162 } ip6_multicast_address_scope_t;
166 #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n,
167 foreach_ip6_multicast_link_local_group_id
169 } ip6_multicast_link_local_group_id_t;
172 ip6_address_is_multicast (const ip6_address_t * a)
174 return a->as_u8[0] == 0xff;
178 ip46_address_is_multicast (const ip46_address_t * a)
180 return ip46_address_is_ip4 (a) ? ip4_address_is_multicast (&a->ip4) :
181 ip6_address_is_multicast (&a->ip6);
185 ip6_address_copy (ip6_address_t * dst, const ip6_address_t * src)
187 dst->as_u64[0] = src->as_u64[0];
188 dst->as_u64[1] = src->as_u64[1];
192 ip6_set_reserved_multicast_address (ip6_address_t * a,
193 ip6_multicast_address_scope_t scope,
196 a->as_u64[0] = a->as_u64[1] = 0;
197 a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope);
198 a->as_u16[7] = clib_host_to_net_u16 (id);
202 ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
204 /* 0xff02::1:ffXX:XXXX. */
205 a->as_u64[0] = a->as_u64[1] = 0;
206 a->as_u16[0] = clib_host_to_net_u16 (0xff02);
208 ASSERT ((id >> 24) == 0);
210 a->as_u32[3] = clib_host_to_net_u32 (id);
214 ip6_link_local_address_from_ethernet_address (ip6_address_t * a,
215 const u8 * ethernet_address)
217 a->as_u64[0] = a->as_u64[1] = 0;
218 a->as_u16[0] = clib_host_to_net_u16 (0xfe80);
219 /* Always set locally administered bit (6). */
220 a->as_u8[0x8] = ethernet_address[0] | (1 << 6);
221 a->as_u8[0x9] = ethernet_address[1];
222 a->as_u8[0xa] = ethernet_address[2];
223 a->as_u8[0xb] = 0xff;
224 a->as_u8[0xc] = 0xfe;
225 a->as_u8[0xd] = ethernet_address[3];
226 a->as_u8[0xe] = ethernet_address[4];
227 a->as_u8[0xf] = ethernet_address[5];
231 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
233 ethernet_address[0] = 0x33;
234 ethernet_address[1] = 0x33;
235 ethernet_address[2] = ((group_id >> 24) & 0xff);
236 ethernet_address[3] = ((group_id >> 16) & 0xff);
237 ethernet_address[4] = ((group_id >> 8) & 0xff);
238 ethernet_address[5] = ((group_id >> 0) & 0xff);
242 ip6_address_is_equal (const ip6_address_t * a, const ip6_address_t * b)
245 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
246 if (a->as_uword[i] != b->as_uword[i])
252 ip6_address_is_equal_masked (const ip6_address_t * a,
253 const ip6_address_t * b,
254 const ip6_address_t * mask)
257 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
259 uword a_masked, b_masked;
260 a_masked = a->as_uword[i] & mask->as_uword[i];
261 b_masked = b->as_uword[i] & mask->as_uword[i];
263 if (a_masked != b_masked)
270 ip6_address_mask (ip6_address_t * a, const ip6_address_t * mask)
273 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
274 a->as_uword[i] &= mask->as_uword[i];
278 ip6_address_set_zero (ip6_address_t * a)
281 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
286 ip6_address_mask_from_width (ip6_address_t * a, u32 width)
288 int i, byte, bit, bitnum;
289 ASSERT (width <= 128);
290 clib_memset (a, 0, sizeof (a[0]));
291 for (i = 0; i < width; i++)
293 bitnum = (7 - (i & 7));
296 a->as_u8[byte] |= bit;
301 ip6_address_is_zero (const ip6_address_t * a)
304 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
305 if (a->as_uword[i] != 0)
310 /* Check for unspecified address ::0 */
312 ip6_address_is_unspecified (const ip6_address_t * a)
314 return ip6_address_is_zero (a);
317 /* Check for loopback address ::1 */
319 ip6_address_is_loopback (const ip6_address_t * a)
321 return (a->as_u64[0] == 0 &&
323 a->as_u16[6] == 0 && a->as_u8[14] == 0 && a->as_u8[15] == 1);
326 /* Check for link local unicast fe80::/10. */
328 ip6_address_is_link_local_unicast (const ip6_address_t * a)
330 return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80;
333 /* Check for unique local unicast fc00::/7. */
335 ip6_address_is_local_unicast (const ip6_address_t * a)
337 return (a->as_u8[0] & 0xfe) == 0xfc;
340 /* Check for unique global unicast 2000::/3. */
342 ip6_address_is_global_unicast (const ip6_address_t * a)
344 return (a->as_u8[0] & 0xe0) == 0x20;
347 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
349 ip6_is_solicited_node_multicast_address (const ip6_address_t * a)
351 return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
353 && a->as_u32[2] == clib_host_to_net_u32 (1)
354 && a->as_u8[12] == 0xff);
358 ip6_address_hash_to_u32 (const ip6_address_t * a)
360 return (a->as_u32[0] ^ a->as_u32[1] ^ a->as_u32[2] ^ a->as_u32[3]);
364 ip6_address_hash_to_u64 (const ip6_address_t * a)
366 return (a->as_u64[0] ^ a->as_u64[1]);
371 /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
372 u32 ip_version_traffic_class_and_flow_label;
374 /* Total packet length not including this header (but including
375 any extension headers if present). */
378 /* Protocol for next header. */
381 /* Hop limit decremented by router at each hop. */
384 /* Source and destination address. */
385 ip6_address_t src_address, dst_address;
389 ip6_traffic_class (const ip6_header_t * i)
391 return (i->ip_version_traffic_class_and_flow_label & 0x0FF00000) >> 20;
394 static_always_inline u8
395 ip6_traffic_class_network_order (const ip6_header_t * ip6)
397 return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
401 static_always_inline void
402 ip6_set_traffic_class_network_order (ip6_header_t * ip6, u8 dscp)
405 clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
408 ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
412 ip6_next_header (ip6_header_t * i)
414 return (void *) (i + 1);
418 ip6_copy_header (ip6_header_t * dst, const ip6_header_t * src)
420 dst->ip_version_traffic_class_and_flow_label =
421 src->ip_version_traffic_class_and_flow_label;
422 dst->payload_length = src->payload_length;
423 dst->protocol = src->protocol;
424 dst->hop_limit = src->hop_limit;
426 dst->src_address.as_uword[0] = src->src_address.as_uword[0];
427 dst->src_address.as_uword[1] = src->src_address.as_uword[1];
428 dst->dst_address.as_uword[0] = src->dst_address.as_uword[0];
429 dst->dst_address.as_uword[1] = src->dst_address.as_uword[1];
433 ip6_tcp_reply_x1 (ip6_header_t * ip0, tcp_header_t * tcp0)
436 ip6_address_t src0, dst0;
438 src0 = ip0->src_address;
439 dst0 = ip0->dst_address;
440 ip0->src_address = dst0;
441 ip0->dst_address = src0;
455 ip6_tcp_reply_x2 (ip6_header_t * ip0, ip6_header_t * ip1,
456 tcp_header_t * tcp0, tcp_header_t * tcp1)
459 ip6_address_t src0, dst0, src1, dst1;
461 src0 = ip0->src_address;
462 src1 = ip1->src_address;
463 dst0 = ip0->dst_address;
464 dst1 = ip1->dst_address;
465 ip0->src_address = dst0;
466 ip1->src_address = dst1;
467 ip0->dst_address = src0;
468 ip1->dst_address = src1;
472 u16 src0, dst0, src1, dst1;
487 typedef CLIB_PACKED (struct {
489 }) ip6_pad1_option_t;
493 typedef CLIB_PACKED (struct {
497 }) ip6_padN_option_t;
501 typedef CLIB_PACKED (struct {
502 #define IP6_MLDP_ALERT_TYPE 0x5
506 }) ip6_router_alert_option_t;
510 typedef CLIB_PACKED (struct {
512 /* Length of this header plus option data in 8 byte units. */
516 #define foreach_ext_hdr_type \
517 _(IP6_HOP_BY_HOP_OPTIONS) \
519 _(IPV6_FRAGMENTATION) \
522 _(IP6_DESTINATION_OPTIONS) \
527 always_inline u8 ip6_ext_hdr(u8 nexthdr)
529 #ifdef CLIB_HAVE_VEC128
530 static const u8x16 ext_hdr_types = {
531 #define _(x) IP_PROTOCOL_##x,
536 return !u8x16_is_all_zero (ext_hdr_types == u8x16_splat (nexthdr));
539 * find out if nexthdr is an extension header or a protocol
542 #define _(x) || (nexthdr == IP_PROTOCOL_##x)
543 foreach_ext_hdr_type;
548 #define ip6_ext_header_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+1) << 3)
549 #define ip6_ext_authhdr_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+2) << 2)
552 ip6_ext_next_header (ip6_ext_header_t *ext_hdr )
553 { return (void *)((u8 *) ext_hdr + ip6_ext_header_len(ext_hdr)); }
556 * Macro to find the IPv6 ext header of type t
557 * I is the IPv6 header
558 * P is the previous IPv6 ext header (NULL if none)
559 * M is the matched IPv6 ext header of type t
561 #define ip6_ext_header_find_t(i, p, m, t) \
562 if ((i)->protocol == t) \
564 (m) = (void *)((i)+1); \
570 (p) = (void *)((i)+1); \
571 while (ip6_ext_hdr((p)->next_hdr) && \
572 ((ip6_ext_header_t *)(p))->next_hdr != (t)) \
574 (p) = ip6_ext_next_header((p)); \
576 if ( ((p)->next_hdr) == (t)) \
578 (m) = (void *)(ip6_ext_next_header((p))); \
583 typedef CLIB_PACKED (struct {
585 /* Length of this header plus option data in 8 byte units. */
588 }) ip6_hop_by_hop_ext_t;
592 typedef CLIB_PACKED (struct {
595 u16 fragment_offset_and_more;
600 #define ip6_frag_hdr_offset(hdr) \
601 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) >> 3)
603 #define ip6_frag_hdr_offset_bytes(hdr) \
604 (8 * ip6_frag_hdr_offset(hdr))
606 #define ip6_frag_hdr_more(hdr) \
607 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) & 0x1)
609 #define ip6_frag_hdr_offset_and_more(offset, more) \
610 clib_host_to_net_u16(((offset) << 3) + !!(more))
612 #endif /* included_ip6_packet_h */
615 * fd.io coding-style-patch-verification: ON
618 * eval: (c-set-style "gnu")