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 ip46_address_t_ {
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 int
99 ip46_address_is_equal_v4 (const ip46_address_t * ip46,
100 const ip4_address_t * ip4)
102 return (ip46->ip4.as_u32 == ip4->as_u32);
105 static_always_inline int
106 ip46_address_is_equal_v6 (const ip46_address_t * ip46,
107 const ip6_address_t * ip6)
109 return ((ip46->ip6.as_u64[0] == ip6->as_u64[0]) &&
110 (ip46->ip6.as_u64[1] == ip6->as_u64[1]));
113 static_always_inline void
114 ip46_address_copy (ip46_address_t * dst, const ip46_address_t * src)
116 dst->as_u64[0] = src->as_u64[0];
117 dst->as_u64[1] = src->as_u64[1];
120 static_always_inline void
121 ip46_address_set_ip6 (ip46_address_t * dst, const ip6_address_t * src)
123 dst->as_u64[0] = src->as_u64[0];
124 dst->as_u64[1] = src->as_u64[1];
127 always_inline ip46_address_t
128 to_ip46 (u32 is_ipv6, u8 * buf)
132 ip.ip6 = *((ip6_address_t *) buf);
134 ip46_address_set_ip4 (&ip, (ip4_address_t *) buf);
140 ip6_addr_fib_init (ip6_address_fib_t * addr_fib,
141 const ip6_address_t * address, u32 fib_index)
143 addr_fib->ip6_addr = *address;
144 addr_fib->fib_index = fib_index;
147 /* Special addresses:
150 global unicast 2000::/3
151 unique local unicast fc00::/7
152 link local unicast fe80::/10
154 ietf reserved everything else. */
156 #define foreach_ip6_multicast_address_scope \
158 _ (link_local, 0x2) \
159 _ (admin_local, 0x4) \
160 _ (site_local, 0x5) \
161 _ (organization_local, 0x8) \
164 #define foreach_ip6_multicast_link_local_group_id \
166 _ (all_routers, 0x2) \
167 _ (rip_routers, 0x9) \
168 _ (eigrp_routers, 0xa) \
169 _ (pim_routers, 0xd) \
170 _ (mldv2_routers, 0x16)
174 #define _(f,n) IP6_MULTICAST_SCOPE_##f = n,
175 foreach_ip6_multicast_address_scope
177 } ip6_multicast_address_scope_t;
181 #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n,
182 foreach_ip6_multicast_link_local_group_id
184 } ip6_multicast_link_local_group_id_t;
187 ip6_address_is_multicast (const ip6_address_t * a)
189 return a->as_u8[0] == 0xff;
193 ip46_address_is_multicast (const ip46_address_t * a)
195 return ip46_address_is_ip4 (a) ? ip4_address_is_multicast (&a->ip4) :
196 ip6_address_is_multicast (&a->ip6);
200 ip6_address_copy (ip6_address_t * dst, const ip6_address_t * src)
202 dst->as_u64[0] = src->as_u64[0];
203 dst->as_u64[1] = src->as_u64[1];
207 ip6_set_reserved_multicast_address (ip6_address_t * a,
208 ip6_multicast_address_scope_t scope,
211 a->as_u64[0] = a->as_u64[1] = 0;
212 a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope);
213 a->as_u16[7] = clib_host_to_net_u16 (id);
217 ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
219 /* 0xff02::1:ffXX:XXXX. */
220 a->as_u64[0] = a->as_u64[1] = 0;
221 a->as_u16[0] = clib_host_to_net_u16 (0xff02);
223 ASSERT ((id >> 24) == 0);
225 a->as_u32[3] = clib_host_to_net_u32 (id);
229 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
231 ethernet_address[0] = 0x33;
232 ethernet_address[1] = 0x33;
233 ethernet_address[2] = ((group_id >> 24) & 0xff);
234 ethernet_address[3] = ((group_id >> 16) & 0xff);
235 ethernet_address[4] = ((group_id >> 8) & 0xff);
236 ethernet_address[5] = ((group_id >> 0) & 0xff);
240 ip6_address_is_equal (const ip6_address_t * a, const ip6_address_t * b)
243 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
244 if (a->as_uword[i] != b->as_uword[i])
250 ip6_address_is_equal_masked (const ip6_address_t * a,
251 const ip6_address_t * b,
252 const ip6_address_t * mask)
255 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
257 uword a_masked, b_masked;
258 a_masked = a->as_uword[i] & mask->as_uword[i];
259 b_masked = b->as_uword[i] & mask->as_uword[i];
261 if (a_masked != b_masked)
268 ip6_address_mask (ip6_address_t * a, const ip6_address_t * mask)
271 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
272 a->as_uword[i] &= mask->as_uword[i];
276 ip6_address_set_zero (ip6_address_t * a)
279 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
284 ip6_address_mask_from_width (ip6_address_t * a, u32 width)
286 int i, byte, bit, bitnum;
287 ASSERT (width <= 128);
288 clib_memset (a, 0, sizeof (a[0]));
289 for (i = 0; i < width; i++)
291 bitnum = (7 - (i & 7));
294 a->as_u8[byte] |= bit;
299 ip6_address_is_zero (const ip6_address_t * a)
302 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
303 if (a->as_uword[i] != 0)
308 /* Check for unspecified address ::0 */
310 ip6_address_is_unspecified (const ip6_address_t * a)
312 return ip6_address_is_zero (a);
315 /* Check for loopback address ::1 */
317 ip6_address_is_loopback (const ip6_address_t * a)
319 return (a->as_u64[0] == 0 &&
321 a->as_u16[6] == 0 && a->as_u8[14] == 0 && a->as_u8[15] == 1);
324 /* Check for link local unicast fe80::/10. */
326 ip6_address_is_link_local_unicast (const ip6_address_t * a)
328 return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80;
331 /* Check for unique local unicast fc00::/7. */
333 ip6_address_is_local_unicast (const ip6_address_t * a)
335 return (a->as_u8[0] & 0xfe) == 0xfc;
338 /* Check for unique global unicast 2000::/3. */
340 ip6_address_is_global_unicast (const ip6_address_t * a)
342 return (a->as_u8[0] & 0xe0) == 0x20;
345 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
347 ip6_is_solicited_node_multicast_address (const ip6_address_t * a)
349 return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
351 && a->as_u32[2] == clib_host_to_net_u32 (1)
352 && a->as_u8[12] == 0xff);
356 ip6_address_hash_to_u32 (const ip6_address_t * a)
358 return (a->as_u32[0] ^ a->as_u32[1] ^ a->as_u32[2] ^ a->as_u32[3]);
362 ip6_address_hash_to_u64 (const ip6_address_t * a)
364 return (a->as_u64[0] ^ a->as_u64[1]);
369 /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
370 u32 ip_version_traffic_class_and_flow_label;
372 /* Total packet length not including this header (but including
373 any extension headers if present). */
376 /* Protocol for next header. */
379 /* Hop limit decremented by router at each hop. */
382 /* Source and destination address. */
383 ip6_address_t src_address, dst_address;
386 always_inline ip_dscp_t
387 ip6_traffic_class (const ip6_header_t * i)
389 return (i->ip_version_traffic_class_and_flow_label & 0x0FF00000) >> 20;
392 static_always_inline ip_dscp_t
393 ip6_traffic_class_network_order (const ip6_header_t * ip6)
395 return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
399 static_always_inline ip_dscp_t
400 ip6_dscp_network_order (const ip6_header_t * ip6)
402 return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
406 static_always_inline ip_ecn_t
407 ip6_ecn_network_order (const ip6_header_t * ip6)
409 return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
413 static_always_inline void
414 ip6_set_traffic_class_network_order (ip6_header_t * ip6, ip_dscp_t dscp)
417 clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
420 ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
423 static_always_inline void
424 ip6_set_dscp_network_order (ip6_header_t * ip6, ip_dscp_t dscp)
427 clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
430 ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
433 static_always_inline void
434 ip6_set_ecn_network_order (ip6_header_t * ip6, ip_ecn_t ecn)
437 clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
440 ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
444 ip6_next_header (ip6_header_t * i)
446 return (void *) (i + 1);
450 ip6_copy_header (ip6_header_t * dst, const ip6_header_t * src)
452 dst->ip_version_traffic_class_and_flow_label =
453 src->ip_version_traffic_class_and_flow_label;
454 dst->payload_length = src->payload_length;
455 dst->protocol = src->protocol;
456 dst->hop_limit = src->hop_limit;
458 dst->src_address.as_uword[0] = src->src_address.as_uword[0];
459 dst->src_address.as_uword[1] = src->src_address.as_uword[1];
460 dst->dst_address.as_uword[0] = src->dst_address.as_uword[0];
461 dst->dst_address.as_uword[1] = src->dst_address.as_uword[1];
465 ip6_tcp_reply_x1 (ip6_header_t * ip0, tcp_header_t * tcp0)
468 ip6_address_t src0, dst0;
470 src0 = ip0->src_address;
471 dst0 = ip0->dst_address;
472 ip0->src_address = dst0;
473 ip0->dst_address = src0;
487 ip6_tcp_reply_x2 (ip6_header_t * ip0, ip6_header_t * ip1,
488 tcp_header_t * tcp0, tcp_header_t * tcp1)
491 ip6_address_t src0, dst0, src1, dst1;
493 src0 = ip0->src_address;
494 src1 = ip1->src_address;
495 dst0 = ip0->dst_address;
496 dst1 = ip1->dst_address;
497 ip0->src_address = dst0;
498 ip1->src_address = dst1;
499 ip0->dst_address = src0;
500 ip1->dst_address = src1;
504 u16 src0, dst0, src1, dst1;
519 typedef CLIB_PACKED (struct {
521 }) ip6_pad1_option_t;
525 typedef CLIB_PACKED (struct {
529 }) ip6_padN_option_t;
533 typedef CLIB_PACKED (struct {
534 #define IP6_MLDP_ALERT_TYPE 0x5
538 }) ip6_router_alert_option_t;
542 typedef CLIB_PACKED (struct {
544 /* Length of this header plus option data in 8 byte units. */
549 #define foreach_ext_hdr_type \
550 _(IP6_HOP_BY_HOP_OPTIONS) \
552 _(IPV6_FRAGMENTATION) \
555 _(IP6_DESTINATION_OPTIONS) \
561 ip6_ext_hdr (u8 nexthdr)
563 #ifdef CLIB_HAVE_VEC128
564 static const u8x16 ext_hdr_types = {
565 #define _(x) IP_PROTOCOL_##x,
570 return !u8x16_is_all_zero (ext_hdr_types == u8x16_splat (nexthdr));
573 * find out if nexthdr is an extension header or a protocol
576 #define _(x) || (nexthdr == IP_PROTOCOL_##x)
577 foreach_ext_hdr_type;
582 #define ip6_ext_header_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+1) << 3)
583 #define ip6_ext_authhdr_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+2) << 2)
586 ip6_ext_next_header (ip6_ext_header_t * ext_hdr)
588 return (void *) ((u8 *) ext_hdr + ip6_ext_header_len (ext_hdr));
592 vlib_object_within_buffer_data (vlib_main_t * vm, vlib_buffer_t * b,
593 void *obj, size_t len)
597 o + len > b->data + vlib_buffer_get_default_data_size (vm))
603 * find ipv6 extension header within ipv6 header within buffer b
606 * @param b buffer to limit search to
607 * @param ip6_header ipv6 header
608 * @param header_type extension header type to search for
609 * @param[out] prev_ext_header address of header preceding found header
612 ip6_ext_header_find (vlib_main_t * vm, vlib_buffer_t * b,
613 ip6_header_t * ip6_header, u8 header_type,
614 ip6_ext_header_t ** prev_ext_header)
616 ip6_ext_header_t *prev = NULL;
617 ip6_ext_header_t *result = NULL;
618 if ((ip6_header)->protocol == header_type)
620 result = (void *) (ip6_header + 1);
621 if (!vlib_object_within_buffer_data (vm, b, result,
622 ip6_ext_header_len (result)))
630 prev = (void *) (ip6_header + 1);
631 while (ip6_ext_hdr (prev->next_hdr) && prev->next_hdr != header_type)
633 prev = ip6_ext_next_header (prev);
634 if (!vlib_object_within_buffer_data (vm, b, prev,
635 ip6_ext_header_len (prev)))
641 if (prev && (prev->next_hdr == header_type))
643 result = ip6_ext_next_header (prev);
644 if (!vlib_object_within_buffer_data (vm, b, result,
645 ip6_ext_header_len (result)))
653 *prev_ext_header = prev;
659 typedef CLIB_PACKED (struct {
661 /* Length of this header plus option data in 8 byte units. */
664 }) ip6_hop_by_hop_ext_t;
668 typedef CLIB_PACKED (struct {
671 u16 fragment_offset_and_more;
676 #define ip6_frag_hdr_offset(hdr) \
677 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) >> 3)
679 #define ip6_frag_hdr_offset_bytes(hdr) \
680 (8 * ip6_frag_hdr_offset(hdr))
682 #define ip6_frag_hdr_more(hdr) \
683 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) & 0x1)
685 #define ip6_frag_hdr_offset_and_more(offset, more) \
686 clib_host_to_net_u16(((offset) << 3) + !!(more))
688 #endif /* included_ip6_packet_h */
691 * fd.io coding-style-patch-verification: ON
694 * eval: (c-set-style "gnu")