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/ip/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))
84 ip46_from_addr_buf (u32 is_ipv6, u8 * buf, ip46_address_t * ip)
87 ip->ip6 = *((ip6_address_t *) buf);
89 ip46_address_set_ip4 (ip, (ip4_address_t *) buf);
93 ip6_addr_fib_init (ip6_address_fib_t * addr_fib, ip6_address_t * address,
96 addr_fib->ip6_addr.as_u64[0] = address->as_u64[0];
97 addr_fib->ip6_addr.as_u64[1] = address->as_u64[1];
98 addr_fib->fib_index = fib_index;
101 /* Special addresses:
104 global unicast 2000::/3
105 unique local unicast fc00::/7
106 link local unicast fe80::/10
108 ietf reserved everything else. */
110 #define foreach_ip6_multicast_address_scope \
112 _ (link_local, 0x2) \
113 _ (admin_local, 0x4) \
114 _ (site_local, 0x5) \
115 _ (organization_local, 0x8) \
118 #define foreach_ip6_multicast_link_local_group_id \
120 _ (all_routers, 0x2) \
121 _ (rip_routers, 0x9) \
122 _ (eigrp_routers, 0xa) \
123 _ (pim_routers, 0xd) \
124 _ (mldv2_routers, 0x16)
128 #define _(f,n) IP6_MULTICAST_SCOPE_##f = n,
129 foreach_ip6_multicast_address_scope
131 } ip6_multicast_address_scope_t;
135 #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n,
136 foreach_ip6_multicast_link_local_group_id
138 } ip6_multicast_link_local_group_id_t;
141 ip6_address_is_multicast (ip6_address_t * a)
143 return a->as_u8[0] == 0xff;
147 ip46_address_is_multicast (ip46_address_t * a)
149 return ip46_address_is_ip4 (a) ? ip4_address_is_multicast (&a->ip4) :
150 ip6_address_is_multicast (&a->ip6);
154 ip6_set_reserved_multicast_address (ip6_address_t * a,
155 ip6_multicast_address_scope_t scope,
158 a->as_u64[0] = a->as_u64[1] = 0;
159 a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope);
160 a->as_u16[7] = clib_host_to_net_u16 (id);
164 ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
166 /* 0xff02::1:ffXX:XXXX. */
167 a->as_u64[0] = a->as_u64[1] = 0;
168 a->as_u16[0] = clib_host_to_net_u16 (0xff02);
170 ASSERT ((id >> 24) == 0);
172 a->as_u32[3] = clib_host_to_net_u32 (id);
176 ip6_link_local_address_from_ethernet_address (ip6_address_t * a,
177 u8 * ethernet_address)
179 a->as_u64[0] = a->as_u64[1] = 0;
180 a->as_u16[0] = clib_host_to_net_u16 (0xfe80);
181 /* Always set locally administered bit (6). */
182 a->as_u8[0x8] = ethernet_address[0] | (1 << 6);
183 a->as_u8[0x9] = ethernet_address[1];
184 a->as_u8[0xa] = ethernet_address[2];
185 a->as_u8[0xb] = 0xff;
186 a->as_u8[0xc] = 0xfe;
187 a->as_u8[0xd] = ethernet_address[3];
188 a->as_u8[0xe] = ethernet_address[4];
189 a->as_u8[0xf] = ethernet_address[5];
193 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
195 ethernet_address[0] = 0x33;
196 ethernet_address[1] = 0x33;
197 ethernet_address[2] = ((group_id >> 24) & 0xff);
198 ethernet_address[3] = ((group_id >> 16) & 0xff);
199 ethernet_address[4] = ((group_id >> 8) & 0xff);
200 ethernet_address[5] = ((group_id >> 0) & 0xff);
204 ip6_address_is_equal (ip6_address_t * a, ip6_address_t * b)
207 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
208 if (a->as_uword[i] != b->as_uword[i])
214 ip6_address_is_equal_masked (ip6_address_t * a, ip6_address_t * b,
215 ip6_address_t * mask)
218 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
220 uword a_masked, b_masked;
221 a_masked = a->as_uword[i] & mask->as_uword[i];
222 b_masked = b->as_uword[i] & mask->as_uword[i];
224 if (a_masked != b_masked)
231 ip6_address_mask (ip6_address_t * a, ip6_address_t * mask)
234 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
235 a->as_uword[i] &= mask->as_uword[i];
239 ip6_address_set_zero (ip6_address_t * a)
242 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
247 ip6_address_mask_from_width (ip6_address_t * a, u32 width)
249 int i, byte, bit, bitnum;
250 ASSERT (width <= 128);
251 memset (a, 0, sizeof (a[0]));
252 for (i = 0; i < width; i++)
254 bitnum = (7 - (i & 7));
257 a->as_u8[byte] |= bit;
262 ip6_address_is_zero (ip6_address_t * a)
265 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
266 if (a->as_uword[i] != 0)
271 /* Check for unspecified address ::0 */
273 ip6_address_is_unspecified (ip6_address_t * a)
275 return ip6_address_is_zero (a);
278 /* Check for loopback address ::1 */
280 ip6_address_is_loopback (ip6_address_t * a)
283 u8 save = a->as_u8[15];
284 a->as_u8[15] = save ^ 1;
285 is_loopback = ip6_address_is_zero (a);
290 /* Check for link local unicast fe80::/10. */
292 ip6_address_is_link_local_unicast (ip6_address_t * a)
294 return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80;
297 /* Check for unique local unicast fc00::/7. */
299 ip6_address_is_local_unicast (ip6_address_t * a)
301 return (a->as_u8[0] & 0xfe) == 0xfc;
304 /* Check for unique global unicast 2000::/3. */
306 ip6_address_is_global_unicast (ip6_address_t * a)
308 return (a->as_u8[0] & 0xe0) == 0x20;
311 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
313 ip6_is_solicited_node_multicast_address (ip6_address_t * a)
315 return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
317 && a->as_u32[2] == clib_host_to_net_u32 (1)
318 && a->as_u8[12] == 0xff);
323 /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
324 u32 ip_version_traffic_class_and_flow_label;
326 /* Total packet length not including this header (but including
327 any extension headers if present). */
330 /* Protocol for next header. */
333 /* Hop limit decremented by router at each hop. */
336 /* Source and destination address. */
337 ip6_address_t src_address, dst_address;
341 ip6_next_header (ip6_header_t * i)
343 return (void *) (i + 1);
347 ip6_copy_header (ip6_header_t * dst, const ip6_header_t * src)
349 dst->ip_version_traffic_class_and_flow_label =
350 src->ip_version_traffic_class_and_flow_label;
351 dst->payload_length = src->payload_length;
352 dst->protocol = src->protocol;
353 dst->hop_limit = src->hop_limit;
355 dst->src_address.as_uword[0] = src->src_address.as_uword[0];
356 dst->src_address.as_uword[1] = src->src_address.as_uword[1];
357 dst->dst_address.as_uword[0] = src->dst_address.as_uword[0];
358 dst->dst_address.as_uword[1] = src->dst_address.as_uword[1];
362 ip6_tcp_reply_x1 (ip6_header_t * ip0, tcp_header_t * tcp0)
365 ip6_address_t src0, dst0;
367 src0 = ip0->src_address;
368 dst0 = ip0->dst_address;
369 ip0->src_address = dst0;
370 ip0->dst_address = src0;
376 src0 = tcp0->ports.src;
377 dst0 = tcp0->ports.dst;
378 tcp0->ports.src = dst0;
379 tcp0->ports.dst = src0;
384 ip6_tcp_reply_x2 (ip6_header_t * ip0, ip6_header_t * ip1,
385 tcp_header_t * tcp0, tcp_header_t * tcp1)
388 ip6_address_t src0, dst0, src1, dst1;
390 src0 = ip0->src_address;
391 src1 = ip1->src_address;
392 dst0 = ip0->dst_address;
393 dst1 = ip1->dst_address;
394 ip0->src_address = dst0;
395 ip1->src_address = dst1;
396 ip0->dst_address = src0;
397 ip1->dst_address = src1;
401 u16 src0, dst0, src1, dst1;
403 src0 = tcp0->ports.src;
404 src1 = tcp1->ports.src;
405 dst0 = tcp0->ports.dst;
406 dst1 = tcp1->ports.dst;
407 tcp0->ports.src = dst0;
408 tcp1->ports.src = dst1;
409 tcp0->ports.dst = src0;
410 tcp1->ports.dst = src1;
416 typedef CLIB_PACKED (struct {
418 }) ip6_pad1_option_t;
422 typedef CLIB_PACKED (struct {
426 }) ip6_padN_option_t;
430 typedef CLIB_PACKED (struct {
431 #define IP6_MLDP_ALERT_TYPE 0x5
435 }) ip6_router_alert_option_t;
439 typedef CLIB_PACKED (struct {
441 /* Length of this header plus option data in 8 byte units. */
445 always_inline u8 ip6_ext_hdr(u8 nexthdr)
448 * find out if nexthdr is an extension header or a protocol
450 return (nexthdr == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS) ||
451 (nexthdr == IP_PROTOCOL_IP6_NONXT) ||
452 (nexthdr == IP_PROTOCOL_IPV6_FRAGMENTATION) ||
453 (nexthdr == IP_PROTOCOL_IPSEC_AH) ||
454 (nexthdr == IP_PROTOCOL_IPV6_ROUTE) ||
455 (nexthdr == IP_PROTOCOL_IP6_DESTINATION_OPTIONS);
458 #define ip6_ext_header_len(p) (((p)->n_data_u64s+1) << 3)
459 #define ip6_ext_authhdr_len(p) (((p)->n_data_u64s+2) << 2)
462 ip6_ext_next_header (ip6_ext_header_t *ext_hdr )
463 { return (void *)((u8 *) ext_hdr + ip6_ext_header_len(ext_hdr)); }
465 typedef CLIB_PACKED (struct {
467 /* Length of this header plus option data in 8 byte units. */
470 }) ip6_hop_by_hop_ext_t;
474 typedef CLIB_PACKED (struct {
477 u16 fragment_offset_and_more;
482 #define ip6_frag_hdr_offset(hdr) \
483 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) >> 3)
485 #define ip6_frag_hdr_more(hdr) \
486 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) & 0x1)
488 #define ip6_frag_hdr_offset_and_more(offset, more) \
489 clib_host_to_net_u16(((offset) << 3) + !!(more))
491 #endif /* included_ip6_packet_h */
494 * fd.io coding-style-patch-verification: ON
497 * eval: (c-set-style "gnu")