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>
53 uword as_uword[16 / sizeof (uword)];
55 __clib_packed ip6_address_t;
57 STATIC_ASSERT_SIZEOF (ip6_address_t, 16);
61 ip6_address_t addr, mask;
62 } ip6_address_and_mask_t;
64 /* Packed so that the mhash key doesn't include uninitialized pad bytes */
66 typedef CLIB_PACKED (struct {
67 /* IP address must be first for ip_interface_address_get_address() to work */
68 ip6_address_t ip6_addr;
74 ip6_addr_fib_init (ip6_address_fib_t * addr_fib,
75 const ip6_address_t * address, u32 fib_index)
77 addr_fib->ip6_addr = *address;
78 addr_fib->fib_index = fib_index;
84 global unicast 2000::/3
85 unique local unicast fc00::/7
86 link local unicast fe80::/10
88 ietf reserved everything else. */
90 #define foreach_ip6_multicast_address_scope \
93 _ (admin_local, 0x4) \
95 _ (organization_local, 0x8) \
98 #define foreach_ip6_multicast_link_local_group_id \
100 _ (all_routers, 0x2) \
101 _ (rip_routers, 0x9) \
102 _ (eigrp_routers, 0xa) \
103 _ (pim_routers, 0xd) \
104 _ (mldv2_routers, 0x16)
108 #define _(f,n) IP6_MULTICAST_SCOPE_##f = n,
109 foreach_ip6_multicast_address_scope
111 } ip6_multicast_address_scope_t;
115 #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n,
116 foreach_ip6_multicast_link_local_group_id
118 } ip6_multicast_link_local_group_id_t;
121 ip6_address_is_multicast (const ip6_address_t * a)
123 return a->as_u8[0] == 0xff;
127 ip6_address_copy (ip6_address_t * dst, const ip6_address_t * src)
129 dst->as_u64[0] = src->as_u64[0];
130 dst->as_u64[1] = src->as_u64[1];
134 ip6_set_reserved_multicast_address (ip6_address_t * a,
135 ip6_multicast_address_scope_t scope,
138 a->as_u64[0] = a->as_u64[1] = 0;
139 a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope);
140 a->as_u16[7] = clib_host_to_net_u16 (id);
144 ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
146 /* 0xff02::1:ffXX:XXXX. */
147 a->as_u64[0] = a->as_u64[1] = 0;
148 a->as_u16[0] = clib_host_to_net_u16 (0xff02);
150 ASSERT ((id >> 24) == 0);
152 a->as_u32[3] = clib_host_to_net_u32 (id);
156 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
158 ethernet_address[0] = 0x33;
159 ethernet_address[1] = 0x33;
160 ethernet_address[2] = ((group_id >> 24) & 0xff);
161 ethernet_address[3] = ((group_id >> 16) & 0xff);
162 ethernet_address[4] = ((group_id >> 8) & 0xff);
163 ethernet_address[5] = ((group_id >> 0) & 0xff);
167 ip6_address_is_equal (const ip6_address_t * a, const ip6_address_t * b)
170 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
171 if (a->as_uword[i] != b->as_uword[i])
177 ip6_address_is_equal_masked (const ip6_address_t * a,
178 const ip6_address_t * b,
179 const ip6_address_t * mask)
182 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
184 uword a_masked, b_masked;
185 a_masked = a->as_uword[i] & mask->as_uword[i];
186 b_masked = b->as_uword[i] & mask->as_uword[i];
188 if (a_masked != b_masked)
195 ip6_address_mask (ip6_address_t * a, const ip6_address_t * mask)
198 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
199 a->as_uword[i] &= mask->as_uword[i];
203 ip6_address_set_zero (ip6_address_t * a)
206 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
211 ip6_address_mask_from_width (ip6_address_t * a, u32 width)
213 int i, byte, bit, bitnum;
214 ASSERT (width <= 128);
215 clib_memset (a, 0, sizeof (a[0]));
216 for (i = 0; i < width; i++)
218 bitnum = (7 - (i & 7));
221 a->as_u8[byte] |= bit;
226 ip6_address_is_zero (const ip6_address_t * a)
229 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
230 if (a->as_uword[i] != 0)
235 /* Check for unspecified address ::0 */
237 ip6_address_is_unspecified (const ip6_address_t * a)
239 return ip6_address_is_zero (a);
242 /* Check for loopback address ::1 */
244 ip6_address_is_loopback (const ip6_address_t * a)
246 return (a->as_u64[0] == 0 &&
248 a->as_u16[6] == 0 && a->as_u8[14] == 0 && a->as_u8[15] == 1);
251 /* Check for link local unicast fe80::/10. */
253 ip6_address_is_link_local_unicast (const ip6_address_t * a)
255 return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80;
258 /* Check for unique local unicast fc00::/7. */
260 ip6_address_is_local_unicast (const ip6_address_t * a)
262 return (a->as_u8[0] & 0xfe) == 0xfc;
265 /* Check for unique global unicast 2000::/3. */
267 ip6_address_is_global_unicast (const ip6_address_t * a)
269 return (a->as_u8[0] & 0xe0) == 0x20;
272 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
274 ip6_is_solicited_node_multicast_address (const ip6_address_t * a)
276 return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
278 && a->as_u32[2] == clib_host_to_net_u32 (1)
279 && a->as_u8[12] == 0xff);
283 ip6_address_hash_to_u32 (const ip6_address_t * a)
285 return (a->as_u32[0] ^ a->as_u32[1] ^ a->as_u32[2] ^ a->as_u32[3]);
289 ip6_address_hash_to_u64 (const ip6_address_t * a)
291 return (a->as_u64[0] ^ a->as_u64[1]);
296 /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
297 u32 ip_version_traffic_class_and_flow_label;
299 /* Total packet length not including this header (but including
300 any extension headers if present). */
303 /* Protocol for next header. */
306 /* Hop limit decremented by router at each hop. */
309 /* Source and destination address. */
310 ip6_address_t src_address, dst_address;
313 #define IP6_PACKET_TC_MASK 0x0FF00000
314 #define IP6_PACKET_DSCP_MASK 0x0FC00000
315 #define IP6_PACKET_ECN_MASK 0x00300000
316 #define IP6_PACKET_FL_MASK 0x000FFFFF
318 always_inline ip_dscp_t
319 ip6_traffic_class (const ip6_header_t * i)
321 return (i->ip_version_traffic_class_and_flow_label & IP6_PACKET_TC_MASK) >>
325 static_always_inline ip_dscp_t
326 ip6_traffic_class_network_order (const ip6_header_t * ip6)
328 return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
329 & IP6_PACKET_TC_MASK) >> 20;
332 static_always_inline ip_dscp_t
333 ip6_dscp_network_order (const ip6_header_t * ip6)
335 return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
336 & IP6_PACKET_DSCP_MASK) >> 22;
339 static_always_inline ip_ecn_t
340 ip6_ecn_network_order (const ip6_header_t * ip6)
342 return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
343 & IP6_PACKET_ECN_MASK) >> 20;
346 static_always_inline void
347 ip6_set_traffic_class_network_order (ip6_header_t * ip6, ip_dscp_t dscp)
350 clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
353 ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
356 static_always_inline void
357 ip6_set_dscp_network_order (ip6_header_t * ip6, ip_dscp_t dscp)
360 clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
363 ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
366 static_always_inline void
367 ip6_set_ecn_network_order (ip6_header_t * ip6, ip_ecn_t ecn)
370 clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
373 ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
377 ip6_next_header (ip6_header_t * i)
379 return (void *) (i + 1);
383 ip6_copy_header (ip6_header_t * dst, const ip6_header_t * src)
385 dst->ip_version_traffic_class_and_flow_label =
386 src->ip_version_traffic_class_and_flow_label;
387 dst->payload_length = src->payload_length;
388 dst->protocol = src->protocol;
389 dst->hop_limit = src->hop_limit;
391 dst->src_address.as_uword[0] = src->src_address.as_uword[0];
392 dst->src_address.as_uword[1] = src->src_address.as_uword[1];
393 dst->dst_address.as_uword[0] = src->dst_address.as_uword[0];
394 dst->dst_address.as_uword[1] = src->dst_address.as_uword[1];
398 ip6_tcp_reply_x1 (ip6_header_t * ip0, tcp_header_t * tcp0)
401 ip6_address_t src0, dst0;
403 src0 = ip0->src_address;
404 dst0 = ip0->dst_address;
405 ip0->src_address = dst0;
406 ip0->dst_address = src0;
420 ip6_tcp_reply_x2 (ip6_header_t * ip0, ip6_header_t * ip1,
421 tcp_header_t * tcp0, tcp_header_t * tcp1)
424 ip6_address_t src0, dst0, src1, dst1;
426 src0 = ip0->src_address;
427 src1 = ip1->src_address;
428 dst0 = ip0->dst_address;
429 dst1 = ip1->dst_address;
430 ip0->src_address = dst0;
431 ip1->src_address = dst1;
432 ip0->dst_address = src0;
433 ip1->dst_address = src1;
437 u16 src0, dst0, src1, dst1;
452 typedef CLIB_PACKED (struct {
454 }) ip6_pad1_option_t;
458 typedef CLIB_PACKED (struct {
462 }) ip6_padN_option_t;
466 typedef CLIB_PACKED (struct {
467 #define IP6_MLDP_ALERT_TYPE 0x5
471 }) ip6_router_alert_option_t;
475 typedef CLIB_PACKED (struct {
477 /* Length of this header plus option data in 8 byte units. */
482 #define foreach_ext_hdr_type \
483 _(IP6_HOP_BY_HOP_OPTIONS) \
485 _(IPV6_FRAGMENTATION) \
488 _(IP6_DESTINATION_OPTIONS) \
494 ip6_ext_hdr (u8 nexthdr)
496 #ifdef CLIB_HAVE_VEC128
497 static const u8x16 ext_hdr_types = {
498 #define _(x) IP_PROTOCOL_##x,
503 return !u8x16_is_all_zero (ext_hdr_types == u8x16_splat (nexthdr));
506 * find out if nexthdr is an extension header or a protocol
509 #define _(x) || (nexthdr == IP_PROTOCOL_##x)
510 foreach_ext_hdr_type;
515 #define ip6_ext_header_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+1) << 3)
516 #define ip6_ext_authhdr_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+2) << 2)
519 ip6_ext_next_header (ip6_ext_header_t * ext_hdr)
521 return (void *) ((u8 *) ext_hdr + ip6_ext_header_len (ext_hdr));
525 vlib_object_within_buffer_data (vlib_main_t * vm, vlib_buffer_t * b,
526 void *obj, size_t len)
530 o + len > b->data + vlib_buffer_get_default_data_size (vm))
536 * find ipv6 extension header within ipv6 header within buffer b
539 * @param b buffer to limit search to
540 * @param ip6_header ipv6 header
541 * @param header_type extension header type to search for
542 * @param[out] prev_ext_header address of header preceding found header
545 ip6_ext_header_find (vlib_main_t * vm, vlib_buffer_t * b,
546 ip6_header_t * ip6_header, u8 header_type,
547 ip6_ext_header_t ** prev_ext_header)
549 ip6_ext_header_t *prev = NULL;
550 ip6_ext_header_t *result = NULL;
551 if ((ip6_header)->protocol == header_type)
553 result = (void *) (ip6_header + 1);
554 if (!vlib_object_within_buffer_data (vm, b, result,
555 ip6_ext_header_len (result)))
563 prev = (void *) (ip6_header + 1);
564 while (ip6_ext_hdr (prev->next_hdr) && prev->next_hdr != header_type)
566 prev = ip6_ext_next_header (prev);
567 if (!vlib_object_within_buffer_data (vm, b, prev,
568 ip6_ext_header_len (prev)))
574 if (prev && (prev->next_hdr == header_type))
576 result = ip6_ext_next_header (prev);
577 if (!vlib_object_within_buffer_data (vm, b, result,
578 ip6_ext_header_len (result)))
586 *prev_ext_header = prev;
592 * walk extension headers, looking for a specific extension header and last
593 * extension header, calculating length of all extension headers
596 * @param b buffer to limit search to
597 * @param ip6_header ipv6 header
598 * @param find_hdr extension header to look for (ignored if ext_hdr is NULL)
599 * @param length[out] length of all extension headers
600 * @param ext_hdr[out] extension header of type find_hdr (may be NULL)
601 * @param last_ext_hdr[out] last extension header (may be NULL)
603 * @return 0 on success, -1 on failure (ext headers crossing buffer boundary)
606 ip6_walk_ext_hdr (vlib_main_t * vm, vlib_buffer_t * b,
607 const ip6_header_t * ip6_header, u8 find_hdr, u32 * length,
608 ip6_ext_header_t ** ext_hdr,
609 ip6_ext_header_t ** last_ext_hdr)
611 if (!ip6_ext_hdr (ip6_header->protocol))
615 *last_ext_hdr = NULL;
619 ip6_ext_header_t *h = (void *) (ip6_header + 1);
620 if (!vlib_object_within_buffer_data (vm, b, h, ip6_ext_header_len (h)))
624 *length += ip6_ext_header_len (h);
627 if (ip6_header->protocol == find_hdr)
631 while (ip6_ext_hdr (h->next_hdr))
633 if (h->next_hdr == find_hdr)
635 h = ip6_ext_next_header (h);
640 h = ip6_ext_next_header (h);
642 if (!vlib_object_within_buffer_data (vm, b, h, ip6_ext_header_len (h)))
646 *length += ip6_ext_header_len (h);
653 typedef CLIB_PACKED (struct {
655 /* Length of this header plus option data in 8 byte units. */
658 }) ip6_hop_by_hop_ext_t;
662 typedef CLIB_PACKED (struct {
665 u16 fragment_offset_and_more;
670 #define ip6_frag_hdr_offset(hdr) \
671 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) >> 3)
673 #define ip6_frag_hdr_offset_bytes(hdr) \
674 (8 * ip6_frag_hdr_offset(hdr))
676 #define ip6_frag_hdr_more(hdr) \
677 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) & 0x1)
679 #define ip6_frag_hdr_offset_and_more(offset, more) \
680 clib_host_to_net_u16(((offset) << 3) + !!(more))
682 #endif /* included_ip6_packet_h */
685 * fd.io coding-style-patch-verification: ON
688 * eval: (c-set-style "gnu")