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 always_inline ip46_address_t
99 to_ip46 (u32 is_ipv6, u8 * buf)
103 ip.ip6 = *((ip6_address_t *) buf);
105 ip46_address_set_ip4 (&ip, (ip4_address_t *) buf);
111 ip6_addr_fib_init (ip6_address_fib_t * addr_fib,
112 const ip6_address_t * address, u32 fib_index)
114 addr_fib->ip6_addr = *address;
115 addr_fib->fib_index = fib_index;
118 /* Special addresses:
121 global unicast 2000::/3
122 unique local unicast fc00::/7
123 link local unicast fe80::/10
125 ietf reserved everything else. */
127 #define foreach_ip6_multicast_address_scope \
129 _ (link_local, 0x2) \
130 _ (admin_local, 0x4) \
131 _ (site_local, 0x5) \
132 _ (organization_local, 0x8) \
135 #define foreach_ip6_multicast_link_local_group_id \
137 _ (all_routers, 0x2) \
138 _ (rip_routers, 0x9) \
139 _ (eigrp_routers, 0xa) \
140 _ (pim_routers, 0xd) \
141 _ (mldv2_routers, 0x16)
145 #define _(f,n) IP6_MULTICAST_SCOPE_##f = n,
146 foreach_ip6_multicast_address_scope
148 } ip6_multicast_address_scope_t;
152 #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n,
153 foreach_ip6_multicast_link_local_group_id
155 } ip6_multicast_link_local_group_id_t;
158 ip6_address_is_multicast (const ip6_address_t * a)
160 return a->as_u8[0] == 0xff;
164 ip46_address_is_multicast (const ip46_address_t * a)
166 return ip46_address_is_ip4 (a) ? ip4_address_is_multicast (&a->ip4) :
167 ip6_address_is_multicast (&a->ip6);
171 ip6_set_reserved_multicast_address (ip6_address_t * a,
172 ip6_multicast_address_scope_t scope,
175 a->as_u64[0] = a->as_u64[1] = 0;
176 a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope);
177 a->as_u16[7] = clib_host_to_net_u16 (id);
181 ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
183 /* 0xff02::1:ffXX:XXXX. */
184 a->as_u64[0] = a->as_u64[1] = 0;
185 a->as_u16[0] = clib_host_to_net_u16 (0xff02);
187 ASSERT ((id >> 24) == 0);
189 a->as_u32[3] = clib_host_to_net_u32 (id);
193 ip6_link_local_address_from_ethernet_address (ip6_address_t * a,
194 const u8 * ethernet_address)
196 a->as_u64[0] = a->as_u64[1] = 0;
197 a->as_u16[0] = clib_host_to_net_u16 (0xfe80);
198 /* Always set locally administered bit (6). */
199 a->as_u8[0x8] = ethernet_address[0] | (1 << 6);
200 a->as_u8[0x9] = ethernet_address[1];
201 a->as_u8[0xa] = ethernet_address[2];
202 a->as_u8[0xb] = 0xff;
203 a->as_u8[0xc] = 0xfe;
204 a->as_u8[0xd] = ethernet_address[3];
205 a->as_u8[0xe] = ethernet_address[4];
206 a->as_u8[0xf] = ethernet_address[5];
210 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
212 ethernet_address[0] = 0x33;
213 ethernet_address[1] = 0x33;
214 ethernet_address[2] = ((group_id >> 24) & 0xff);
215 ethernet_address[3] = ((group_id >> 16) & 0xff);
216 ethernet_address[4] = ((group_id >> 8) & 0xff);
217 ethernet_address[5] = ((group_id >> 0) & 0xff);
221 ip6_address_is_equal (const ip6_address_t * a, const ip6_address_t * b)
224 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
225 if (a->as_uword[i] != b->as_uword[i])
231 ip6_address_is_equal_masked (const ip6_address_t * a,
232 const ip6_address_t * b,
233 const ip6_address_t * mask)
236 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
238 uword a_masked, b_masked;
239 a_masked = a->as_uword[i] & mask->as_uword[i];
240 b_masked = b->as_uword[i] & mask->as_uword[i];
242 if (a_masked != b_masked)
249 ip6_address_mask (ip6_address_t * a, const ip6_address_t * mask)
252 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
253 a->as_uword[i] &= mask->as_uword[i];
257 ip6_address_set_zero (ip6_address_t * a)
260 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
265 ip6_address_mask_from_width (ip6_address_t * a, u32 width)
267 int i, byte, bit, bitnum;
268 ASSERT (width <= 128);
269 memset (a, 0, sizeof (a[0]));
270 for (i = 0; i < width; i++)
272 bitnum = (7 - (i & 7));
275 a->as_u8[byte] |= bit;
280 ip6_address_is_zero (const ip6_address_t * a)
283 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
284 if (a->as_uword[i] != 0)
289 /* Check for unspecified address ::0 */
291 ip6_address_is_unspecified (const ip6_address_t * a)
293 return ip6_address_is_zero (a);
296 /* Check for loopback address ::1 */
298 ip6_address_is_loopback (const ip6_address_t * a)
300 return (a->as_u64[0] == 0 &&
302 a->as_u16[6] == 0 && a->as_u8[14] == 0 && a->as_u8[15] == 1);
305 /* Check for link local unicast fe80::/10. */
307 ip6_address_is_link_local_unicast (const ip6_address_t * a)
309 return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80;
312 /* Check for unique local unicast fc00::/7. */
314 ip6_address_is_local_unicast (const ip6_address_t * a)
316 return (a->as_u8[0] & 0xfe) == 0xfc;
319 /* Check for unique global unicast 2000::/3. */
321 ip6_address_is_global_unicast (const ip6_address_t * a)
323 return (a->as_u8[0] & 0xe0) == 0x20;
326 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
328 ip6_is_solicited_node_multicast_address (const ip6_address_t * a)
330 return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
332 && a->as_u32[2] == clib_host_to_net_u32 (1)
333 && a->as_u8[12] == 0xff);
338 /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
339 u32 ip_version_traffic_class_and_flow_label;
341 /* Total packet length not including this header (but including
342 any extension headers if present). */
345 /* Protocol for next header. */
348 /* Hop limit decremented by router at each hop. */
351 /* Source and destination address. */
352 ip6_address_t src_address, dst_address;
356 ip6_traffic_class (const ip6_header_t * i)
358 return (i->ip_version_traffic_class_and_flow_label & 0x0FF00000) >> 20;
361 static_always_inline u8
362 ip6_traffic_class_network_order (const ip6_header_t * ip6)
364 return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
368 static_always_inline void
369 ip6_set_traffic_class_network_order (ip6_header_t * ip6, u8 dscp)
372 clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
375 ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
379 ip6_next_header (ip6_header_t * i)
381 return (void *) (i + 1);
385 ip6_copy_header (ip6_header_t * dst, const ip6_header_t * src)
387 dst->ip_version_traffic_class_and_flow_label =
388 src->ip_version_traffic_class_and_flow_label;
389 dst->payload_length = src->payload_length;
390 dst->protocol = src->protocol;
391 dst->hop_limit = src->hop_limit;
393 dst->src_address.as_uword[0] = src->src_address.as_uword[0];
394 dst->src_address.as_uword[1] = src->src_address.as_uword[1];
395 dst->dst_address.as_uword[0] = src->dst_address.as_uword[0];
396 dst->dst_address.as_uword[1] = src->dst_address.as_uword[1];
400 ip6_tcp_reply_x1 (ip6_header_t * ip0, tcp_header_t * tcp0)
403 ip6_address_t src0, dst0;
405 src0 = ip0->src_address;
406 dst0 = ip0->dst_address;
407 ip0->src_address = dst0;
408 ip0->dst_address = src0;
422 ip6_tcp_reply_x2 (ip6_header_t * ip0, ip6_header_t * ip1,
423 tcp_header_t * tcp0, tcp_header_t * tcp1)
426 ip6_address_t src0, dst0, src1, dst1;
428 src0 = ip0->src_address;
429 src1 = ip1->src_address;
430 dst0 = ip0->dst_address;
431 dst1 = ip1->dst_address;
432 ip0->src_address = dst0;
433 ip1->src_address = dst1;
434 ip0->dst_address = src0;
435 ip1->dst_address = src1;
439 u16 src0, dst0, src1, dst1;
454 typedef CLIB_PACKED (struct {
456 }) ip6_pad1_option_t;
460 typedef CLIB_PACKED (struct {
464 }) ip6_padN_option_t;
468 typedef CLIB_PACKED (struct {
469 #define IP6_MLDP_ALERT_TYPE 0x5
473 }) ip6_router_alert_option_t;
477 typedef CLIB_PACKED (struct {
479 /* Length of this header plus option data in 8 byte units. */
483 always_inline u8 ip6_ext_hdr(u8 nexthdr)
486 * find out if nexthdr is an extension header or a protocol
488 return (nexthdr == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS) ||
489 (nexthdr == IP_PROTOCOL_IPV6_FRAGMENTATION) ||
490 (nexthdr == IP_PROTOCOL_IPSEC_AH) ||
491 (nexthdr == IP_PROTOCOL_IPV6_ROUTE) ||
492 (nexthdr == IP_PROTOCOL_IP6_DESTINATION_OPTIONS);
495 #define ip6_ext_header_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+1) << 3)
496 #define ip6_ext_authhdr_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+2) << 2)
499 ip6_ext_next_header (ip6_ext_header_t *ext_hdr )
500 { return (void *)((u8 *) ext_hdr + ip6_ext_header_len(ext_hdr)); }
503 * Macro to find the IPv6 ext header of type t
504 * I is the IPv6 header
505 * P is the previous IPv6 ext header (NULL if none)
506 * M is the matched IPv6 ext header of type t
508 #define ip6_ext_header_find_t(i, p, m, t) \
509 if ((i)->protocol == t) \
511 (m) = (void *)((i)+1); \
517 (p) = (void *)((i)+1); \
518 while (ip6_ext_hdr((p)->next_hdr) && \
519 ((ip6_ext_header_t *)(p))->next_hdr != (t)) \
521 (p) = ip6_ext_next_header((p)); \
523 if ( ((p)->next_hdr) == (t)) \
525 (m) = (void *)(ip6_ext_next_header((p))); \
530 typedef CLIB_PACKED (struct {
532 /* Length of this header plus option data in 8 byte units. */
535 }) ip6_hop_by_hop_ext_t;
539 typedef CLIB_PACKED (struct {
542 u16 fragment_offset_and_more;
547 #define ip6_frag_hdr_offset(hdr) \
548 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) >> 3)
550 #define ip6_frag_hdr_offset_bytes(hdr) \
551 (8 * ip6_frag_hdr_offset(hdr))
553 #define ip6_frag_hdr_more(hdr) \
554 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) & 0x1)
556 #define ip6_frag_hdr_offset_and_more(offset, more) \
557 clib_host_to_net_u16(((offset) << 3) + !!(more))
559 #endif /* included_ip6_packet_h */
562 * fd.io coding-style-patch-verification: ON
565 * eval: (c-set-style "gnu")