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)];
56 /* Packed so that the mhash key doesn't include uninitialized pad bytes */
58 typedef CLIB_PACKED (struct {
59 /* IP address must be first for ip_interface_address_get_address() to work */
60 ip6_address_t ip6_addr;
66 typedef CLIB_PACKED (union {
76 #define ip46_address_is_ip4(ip46) (((ip46)->pad[0] | (ip46)->pad[1] | (ip46)->pad[2]) == 0)
77 #define ip46_address_mask_ip4(ip46) ((ip46)->pad[0] = (ip46)->pad[1] = (ip46)->pad[2] = 0)
78 #define ip46_address_set_ip4(ip46, ip) (ip46_address_mask_ip4(ip46), (ip46)->ip4 = (ip)[0])
79 #define ip46_address_reset(ip46) ((ip46)->as_u64[0] = (ip46)->as_u64[1] = 0)
80 #define ip46_address_cmp(ip46_1, ip46_2) (memcmp(ip46_1, ip46_2, sizeof(*ip46_1)))
81 #define ip46_address_is_zero(ip46) (((ip46)->as_u64[0] == 0) && ((ip46)->as_u64[1] == 0))
82 #define ip46_address_is_equal(a1, a2) (((a1)->as_u64[0] == (a2)->as_u64[0]) \
83 && ((a1)->as_u64[1] == (a2)->as_u64[1]))
84 #define ip46_address_initializer {{{ 0 }}}
86 always_inline ip46_address_t
87 to_ip46 (u32 is_ipv6, u8 * buf)
91 ip.ip6 = *((ip6_address_t *) buf);
93 ip46_address_set_ip4 (&ip, (ip4_address_t *) buf);
99 ip6_addr_fib_init (ip6_address_fib_t * addr_fib, ip6_address_t * address,
102 addr_fib->ip6_addr = *address;
103 addr_fib->fib_index = fib_index;
106 /* Special addresses:
109 global unicast 2000::/3
110 unique local unicast fc00::/7
111 link local unicast fe80::/10
113 ietf reserved everything else. */
115 #define foreach_ip6_multicast_address_scope \
117 _ (link_local, 0x2) \
118 _ (admin_local, 0x4) \
119 _ (site_local, 0x5) \
120 _ (organization_local, 0x8) \
123 #define foreach_ip6_multicast_link_local_group_id \
125 _ (all_routers, 0x2) \
126 _ (rip_routers, 0x9) \
127 _ (eigrp_routers, 0xa) \
128 _ (pim_routers, 0xd) \
129 _ (mldv2_routers, 0x16)
133 #define _(f,n) IP6_MULTICAST_SCOPE_##f = n,
134 foreach_ip6_multicast_address_scope
136 } ip6_multicast_address_scope_t;
140 #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n,
141 foreach_ip6_multicast_link_local_group_id
143 } ip6_multicast_link_local_group_id_t;
146 ip6_address_is_multicast (ip6_address_t * a)
148 return a->as_u8[0] == 0xff;
152 ip46_address_is_multicast (ip46_address_t * a)
154 return ip46_address_is_ip4 (a) ? ip4_address_is_multicast (&a->ip4) :
155 ip6_address_is_multicast (&a->ip6);
159 ip6_set_reserved_multicast_address (ip6_address_t * a,
160 ip6_multicast_address_scope_t scope,
163 a->as_u64[0] = a->as_u64[1] = 0;
164 a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope);
165 a->as_u16[7] = clib_host_to_net_u16 (id);
169 ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
171 /* 0xff02::1:ffXX:XXXX. */
172 a->as_u64[0] = a->as_u64[1] = 0;
173 a->as_u16[0] = clib_host_to_net_u16 (0xff02);
175 ASSERT ((id >> 24) == 0);
177 a->as_u32[3] = clib_host_to_net_u32 (id);
181 ip6_link_local_address_from_ethernet_address (ip6_address_t * a,
182 u8 * ethernet_address)
184 a->as_u64[0] = a->as_u64[1] = 0;
185 a->as_u16[0] = clib_host_to_net_u16 (0xfe80);
186 /* Always set locally administered bit (6). */
187 a->as_u8[0x8] = ethernet_address[0] | (1 << 6);
188 a->as_u8[0x9] = ethernet_address[1];
189 a->as_u8[0xa] = ethernet_address[2];
190 a->as_u8[0xb] = 0xff;
191 a->as_u8[0xc] = 0xfe;
192 a->as_u8[0xd] = ethernet_address[3];
193 a->as_u8[0xe] = ethernet_address[4];
194 a->as_u8[0xf] = ethernet_address[5];
198 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
200 ethernet_address[0] = 0x33;
201 ethernet_address[1] = 0x33;
202 ethernet_address[2] = ((group_id >> 24) & 0xff);
203 ethernet_address[3] = ((group_id >> 16) & 0xff);
204 ethernet_address[4] = ((group_id >> 8) & 0xff);
205 ethernet_address[5] = ((group_id >> 0) & 0xff);
209 ip6_address_is_equal (ip6_address_t * a, ip6_address_t * b)
212 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
213 if (a->as_uword[i] != b->as_uword[i])
219 ip6_address_is_equal_masked (ip6_address_t * a, ip6_address_t * b,
220 ip6_address_t * mask)
223 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
225 uword a_masked, b_masked;
226 a_masked = a->as_uword[i] & mask->as_uword[i];
227 b_masked = b->as_uword[i] & mask->as_uword[i];
229 if (a_masked != b_masked)
236 ip6_address_mask (ip6_address_t * a, ip6_address_t * mask)
239 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
240 a->as_uword[i] &= mask->as_uword[i];
244 ip6_address_set_zero (ip6_address_t * a)
247 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
252 ip6_address_mask_from_width (ip6_address_t * a, u32 width)
254 int i, byte, bit, bitnum;
255 ASSERT (width <= 128);
256 memset (a, 0, sizeof (a[0]));
257 for (i = 0; i < width; i++)
259 bitnum = (7 - (i & 7));
262 a->as_u8[byte] |= bit;
267 ip6_address_is_zero (ip6_address_t * a)
270 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
271 if (a->as_uword[i] != 0)
276 /* Check for unspecified address ::0 */
278 ip6_address_is_unspecified (ip6_address_t * a)
280 return ip6_address_is_zero (a);
283 /* Check for loopback address ::1 */
285 ip6_address_is_loopback (ip6_address_t * a)
288 u8 save = a->as_u8[15];
289 a->as_u8[15] = save ^ 1;
290 is_loopback = ip6_address_is_zero (a);
295 /* Check for link local unicast fe80::/10. */
297 ip6_address_is_link_local_unicast (const ip6_address_t * a)
299 return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80;
302 /* Check for unique local unicast fc00::/7. */
304 ip6_address_is_local_unicast (ip6_address_t * a)
306 return (a->as_u8[0] & 0xfe) == 0xfc;
309 /* Check for unique global unicast 2000::/3. */
311 ip6_address_is_global_unicast (ip6_address_t * a)
313 return (a->as_u8[0] & 0xe0) == 0x20;
316 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
318 ip6_is_solicited_node_multicast_address (ip6_address_t * a)
320 return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
322 && a->as_u32[2] == clib_host_to_net_u32 (1)
323 && a->as_u8[12] == 0xff);
328 /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
329 u32 ip_version_traffic_class_and_flow_label;
331 /* Total packet length not including this header (but including
332 any extension headers if present). */
335 /* Protocol for next header. */
338 /* Hop limit decremented by router at each hop. */
341 /* Source and destination address. */
342 ip6_address_t src_address, dst_address;
346 ip6_traffic_class (const ip6_header_t * i)
348 return (i->ip_version_traffic_class_and_flow_label & 0x0FF00000) >> 20;
351 static_always_inline u8
352 ip6_traffic_class_network_order (const ip6_header_t * ip6)
354 return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
358 static_always_inline void
359 ip6_set_traffic_class_network_order (ip6_header_t * ip6, u8 dscp)
362 clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
365 ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
369 ip6_next_header (ip6_header_t * i)
371 return (void *) (i + 1);
375 ip6_copy_header (ip6_header_t * dst, const ip6_header_t * src)
377 dst->ip_version_traffic_class_and_flow_label =
378 src->ip_version_traffic_class_and_flow_label;
379 dst->payload_length = src->payload_length;
380 dst->protocol = src->protocol;
381 dst->hop_limit = src->hop_limit;
383 dst->src_address.as_uword[0] = src->src_address.as_uword[0];
384 dst->src_address.as_uword[1] = src->src_address.as_uword[1];
385 dst->dst_address.as_uword[0] = src->dst_address.as_uword[0];
386 dst->dst_address.as_uword[1] = src->dst_address.as_uword[1];
390 ip6_tcp_reply_x1 (ip6_header_t * ip0, tcp_header_t * tcp0)
393 ip6_address_t src0, dst0;
395 src0 = ip0->src_address;
396 dst0 = ip0->dst_address;
397 ip0->src_address = dst0;
398 ip0->dst_address = src0;
412 ip6_tcp_reply_x2 (ip6_header_t * ip0, ip6_header_t * ip1,
413 tcp_header_t * tcp0, tcp_header_t * tcp1)
416 ip6_address_t src0, dst0, src1, dst1;
418 src0 = ip0->src_address;
419 src1 = ip1->src_address;
420 dst0 = ip0->dst_address;
421 dst1 = ip1->dst_address;
422 ip0->src_address = dst0;
423 ip1->src_address = dst1;
424 ip0->dst_address = src0;
425 ip1->dst_address = src1;
429 u16 src0, dst0, src1, dst1;
444 typedef CLIB_PACKED (struct {
446 }) ip6_pad1_option_t;
450 typedef CLIB_PACKED (struct {
454 }) ip6_padN_option_t;
458 typedef CLIB_PACKED (struct {
459 #define IP6_MLDP_ALERT_TYPE 0x5
463 }) ip6_router_alert_option_t;
467 typedef CLIB_PACKED (struct {
469 /* Length of this header plus option data in 8 byte units. */
473 always_inline u8 ip6_ext_hdr(u8 nexthdr)
476 * find out if nexthdr is an extension header or a protocol
478 return (nexthdr == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS) ||
479 (nexthdr == IP_PROTOCOL_IPV6_FRAGMENTATION) ||
480 (nexthdr == IP_PROTOCOL_IPSEC_AH) ||
481 (nexthdr == IP_PROTOCOL_IPV6_ROUTE) ||
482 (nexthdr == IP_PROTOCOL_IP6_DESTINATION_OPTIONS);
485 #define ip6_ext_header_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+1) << 3)
486 #define ip6_ext_authhdr_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+2) << 2)
489 ip6_ext_next_header (ip6_ext_header_t *ext_hdr )
490 { return (void *)((u8 *) ext_hdr + ip6_ext_header_len(ext_hdr)); }
493 * Macro to find the IPv6 ext header of type t
494 * I is the IPv6 header
495 * P is the previous IPv6 ext header (NULL if none)
496 * M is the matched IPv6 ext header of type t
498 #define ip6_ext_header_find_t(i, p, m, t) \
499 if ((i)->protocol == t) \
501 (m) = (void *)((i)+1); \
507 (p) = (void *)((i)+1); \
508 while (ip6_ext_hdr((p)->next_hdr) && \
509 ((ip6_ext_header_t *)(p))->next_hdr != (t)) \
511 (p) = ip6_ext_next_header((p)); \
513 if ( ((p)->next_hdr) == (t)) \
515 (m) = (void *)(ip6_ext_next_header((p))); \
520 typedef CLIB_PACKED (struct {
522 /* Length of this header plus option data in 8 byte units. */
525 }) ip6_hop_by_hop_ext_t;
529 typedef CLIB_PACKED (struct {
532 u16 fragment_offset_and_more;
537 #define ip6_frag_hdr_offset(hdr) \
538 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) >> 3)
540 #define ip6_frag_hdr_offset_bytes(hdr) \
541 (8 * ip6_frag_hdr_offset(hdr))
543 #define ip6_frag_hdr_more(hdr) \
544 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) & 0x1)
546 #define ip6_frag_hdr_offset_and_more(offset, more) \
547 clib_host_to_net_u16(((offset) << 3) + !!(more))
549 #endif /* included_ip6_packet_h */
552 * fd.io coding-style-patch-verification: ON
555 * eval: (c-set-style "gnu")