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>
51 uword as_uword[16 / sizeof (uword)];
54 /* Packed so that the mhash key doesn't include uninitialized pad bytes */
55 typedef CLIB_PACKED (struct {
56 /* IP address must be first for ip_interface_address_get_address() to work */
57 ip6_address_t ip6_addr;
61 typedef CLIB_PACKED (union {
69 #define ip46_address_is_ip4(ip46) (((ip46)->pad[0] | (ip46)->pad[1] | (ip46)->pad[2]) == 0)
70 #define ip46_address_mask_ip4(ip46) ((ip46)->pad[0] = (ip46)->pad[1] = (ip46)->pad[2] = 0)
71 #define ip46_address_set_ip4(ip46, ip) (ip46_address_mask_ip4(ip46), (ip46)->ip4 = (ip)[0])
72 #define ip46_address_reset(ip46) ((ip46)->as_u64[0] = (ip46)->as_u64[1] = 0)
73 #define ip46_address_cmp(ip46_1, ip46_2) (memcmp(ip46_1, ip46_2, sizeof(*ip46_1)))
74 #define ip46_address_is_zero(ip46) (((ip46)->as_u64[0] == 0) && ((ip46)->as_u64[1] == 0))
77 ip6_addr_fib_init (ip6_address_fib_t * addr_fib, ip6_address_t * address,
80 addr_fib->ip6_addr.as_u64[0] = address->as_u64[0];
81 addr_fib->ip6_addr.as_u64[1] = address->as_u64[1];
82 addr_fib->fib_index = fib_index;
88 global unicast 2000::/3
89 unique local unicast fc00::/7
90 link local unicast fe80::/10
92 ietf reserved everything else. */
94 #define foreach_ip6_multicast_address_scope \
97 _ (admin_local, 0x4) \
99 _ (organization_local, 0x8) \
102 #define foreach_ip6_multicast_link_local_group_id \
104 _ (all_routers, 0x2) \
105 _ (rip_routers, 0x9) \
106 _ (eigrp_routers, 0xa) \
107 _ (pim_routers, 0xd) \
108 _ (mldv2_routers, 0x16)
111 #define _(f,n) IP6_MULTICAST_SCOPE_##f = n,
112 foreach_ip6_multicast_address_scope
114 } ip6_multicast_address_scope_t;
117 #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n,
118 foreach_ip6_multicast_link_local_group_id
120 } ip6_multicast_link_local_group_id_t;
123 ip6_address_is_multicast (ip6_address_t * a)
124 { return a->as_u8[0] == 0xff; }
127 ip6_set_reserved_multicast_address (ip6_address_t * a,
128 ip6_multicast_address_scope_t scope,
131 a->as_u64[0] = a->as_u64[1] = 0;
132 a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope);
133 a->as_u16[7] = clib_host_to_net_u16 (id);
137 ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
139 /* 0xff02::1:ffXX:XXXX. */
140 a->as_u64[0] = a->as_u64[1] = 0;
141 a->as_u16[0] = clib_host_to_net_u16 (0xff02);
143 ASSERT ((id >> 24) == 0);
145 a->as_u32[3] = clib_host_to_net_u32 (id);
149 ip6_link_local_address_from_ethernet_address (ip6_address_t * a, u8 * ethernet_address)
151 a->as_u64[0] = a->as_u64[1] = 0;
152 a->as_u16[0] = clib_host_to_net_u16 (0xfe80);
153 /* Always set locally administered bit (6). */
154 a->as_u8[0x8] = ethernet_address[0] | (1 << 6);
155 a->as_u8[0x9] = ethernet_address[1];
156 a->as_u8[0xa] = ethernet_address[2];
157 a->as_u8[0xb] = 0xff;
158 a->as_u8[0xc] = 0xfe;
159 a->as_u8[0xd] = ethernet_address[3];
160 a->as_u8[0xe] = ethernet_address[4];
161 a->as_u8[0xf] = ethernet_address[5];
165 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
167 ethernet_address[0] = 0x33;
168 ethernet_address[1] = 0x33;
169 ethernet_address[2] = ((group_id >> 24) & 0xff);
170 ethernet_address[3] = ((group_id >> 16) & 0xff);
171 ethernet_address[4] = ((group_id >> 8) & 0xff);
172 ethernet_address[5] = ((group_id >> 0) & 0xff);
176 ip6_address_is_equal (ip6_address_t * a, ip6_address_t * b)
179 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
180 if (a->as_uword[i] != b->as_uword[i])
186 ip6_address_is_equal_masked (ip6_address_t * a, ip6_address_t * b,
187 ip6_address_t * mask)
190 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
192 uword a_masked, b_masked;
193 a_masked = a->as_uword[i] & mask->as_uword[i];
194 b_masked = b->as_uword[i] & mask->as_uword[i];
196 if (a_masked != b_masked)
203 ip6_address_mask (ip6_address_t * a, ip6_address_t * mask)
206 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
207 a->as_uword[i] &= mask->as_uword[i];
211 ip6_address_set_zero (ip6_address_t * a)
214 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
219 ip6_address_mask_from_width (ip6_address_t * a, u32 width)
221 int i, byte, bit, bitnum;
222 ASSERT (width <= 128);
223 memset (a, 0, sizeof (a[0]));
224 for (i = 0; i < width; i++)
226 bitnum = (7 - (i & 7));
229 a->as_u8[byte] |= bit;
234 ip6_address_is_zero (ip6_address_t * a)
237 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
238 if (a->as_uword[i] != 0)
243 /* Check for unspecified address ::0 */
245 ip6_address_is_unspecified (ip6_address_t * a)
246 { return ip6_address_is_zero (a); }
248 /* Check for loopback address ::1 */
250 ip6_address_is_loopback (ip6_address_t * a)
253 u8 save = a->as_u8[15];
254 a->as_u8[15] = save ^ 1;
255 is_loopback = ip6_address_is_zero (a);
260 /* Check for link local unicast fe80::/10. */
262 ip6_address_is_link_local_unicast (ip6_address_t * a)
263 { return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80; }
265 /* Check for unique local unicast fc00::/7. */
267 ip6_address_is_local_unicast (ip6_address_t * a)
268 { return (a->as_u8[0] & 0xfe) == 0xfc; }
270 /* Check for unique global unicast 2000::/3. */
272 ip6_address_is_global_unicast (ip6_address_t * a)
273 { return (a->as_u8[0] & 0xe0) == 0x20; }
275 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
277 ip6_is_solicited_node_multicast_address (ip6_address_t * a)
279 return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
281 && a->as_u32[2] == clib_host_to_net_u32 (1)
282 && a->as_u8[12] == 0xff);
286 /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
287 u32 ip_version_traffic_class_and_flow_label;
289 /* Total packet length not including this header (but including
290 any extension headers if present). */
293 /* Protocol for next header. */
296 /* Hop limit decremented by router at each hop. */
299 /* Source and destination address. */
300 ip6_address_t src_address, dst_address;
304 ip6_next_header (ip6_header_t * i)
305 { return (void *) (i + 1); }
308 ip6_copy_header (ip6_header_t * dst,
309 const ip6_header_t *src)
311 dst->ip_version_traffic_class_and_flow_label =
312 src->ip_version_traffic_class_and_flow_label;
313 dst->payload_length = src->payload_length;
314 dst->protocol = src->protocol;
315 dst->hop_limit = src->hop_limit;
317 dst->src_address.as_uword[0] = src->src_address.as_uword[0];
318 dst->src_address.as_uword[1] = src->src_address.as_uword[1];
319 dst->dst_address.as_uword[0] = src->dst_address.as_uword[0];
320 dst->dst_address.as_uword[1] = src->dst_address.as_uword[1];
324 ip6_tcp_reply_x1 (ip6_header_t * ip0, tcp_header_t * tcp0)
327 ip6_address_t src0, dst0;
329 src0 = ip0->src_address;
330 dst0 = ip0->dst_address;
331 ip0->src_address = dst0;
332 ip0->dst_address = src0;
338 src0 = tcp0->ports.src;
339 dst0 = tcp0->ports.dst;
340 tcp0->ports.src = dst0;
341 tcp0->ports.dst = src0;
346 ip6_tcp_reply_x2 (ip6_header_t * ip0, ip6_header_t * ip1,
347 tcp_header_t * tcp0, tcp_header_t * tcp1)
350 ip6_address_t src0, dst0, src1, dst1;
352 src0 = ip0->src_address;
353 src1 = ip1->src_address;
354 dst0 = ip0->dst_address;
355 dst1 = ip1->dst_address;
356 ip0->src_address = dst0;
357 ip1->src_address = dst1;
358 ip0->dst_address = src0;
359 ip1->dst_address = src1;
363 u16 src0, dst0, src1, dst1;
365 src0 = tcp0->ports.src;
366 src1 = tcp1->ports.src;
367 dst0 = tcp0->ports.dst;
368 dst1 = tcp1->ports.dst;
369 tcp0->ports.src = dst0;
370 tcp1->ports.src = dst1;
371 tcp0->ports.dst = src0;
372 tcp1->ports.dst = src1;
377 typedef CLIB_PACKED (struct {
379 }) ip6_pad1_option_t;
381 typedef CLIB_PACKED (struct {
385 }) ip6_padN_option_t;
387 typedef CLIB_PACKED (struct {
388 #define IP6_MLDP_ALERT_TYPE 0x5
392 }) ip6_router_alert_option_t;
394 typedef CLIB_PACKED (struct {
396 /* Length of this header plus option data in 8 byte units. */
399 }) ip6_hop_by_hop_ext_t;
401 typedef CLIB_PACKED (struct {
404 u16 fragment_offset_and_more;
408 #define ip6_frag_hdr_offset(hdr) \
409 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) >> 3)
411 #define ip6_frag_hdr_more(hdr) \
412 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) & 0x1)
414 #define ip6_frag_hdr_offset_and_more(offset, more) \
415 clib_host_to_net_u16(((offset) << 3) + !!(more))
417 #endif /* included_ip6_packet_h */