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 {
70 #define ip46_address_is_ip4(ip46) (((ip46)->pad[0] | (ip46)->pad[1] | (ip46)->pad[2]) == 0)
71 #define ip46_address_mask_ip4(ip46) ((ip46)->pad[0] = (ip46)->pad[1] = (ip46)->pad[2] = 0)
72 #define ip46_address_set_ip4(ip46, ip) (ip46_address_mask_ip4(ip46), (ip46)->ip4 = (ip)[0])
73 #define ip46_address_reset(ip46) ((ip46)->as_u64[0] = (ip46)->as_u64[1] = 0)
74 #define ip46_address_cmp(ip46_1, ip46_2) (memcmp(ip46_1, ip46_2, sizeof(*ip46_1)))
75 #define ip46_address_is_zero(ip46) (((ip46)->as_u64[0] == 0) && ((ip46)->as_u64[1] == 0))
78 ip46_from_addr_buf(u32 is_ipv6, u8 *buf, ip46_address_t *ip)
81 ip->ip6 = *((ip6_address_t *) buf);
83 ip46_address_set_ip4(ip, (ip4_address_t *) buf);
87 ip6_addr_fib_init (ip6_address_fib_t * addr_fib, ip6_address_t * address,
90 addr_fib->ip6_addr.as_u64[0] = address->as_u64[0];
91 addr_fib->ip6_addr.as_u64[1] = address->as_u64[1];
92 addr_fib->fib_index = fib_index;
98 global unicast 2000::/3
99 unique local unicast fc00::/7
100 link local unicast fe80::/10
102 ietf reserved everything else. */
104 #define foreach_ip6_multicast_address_scope \
106 _ (link_local, 0x2) \
107 _ (admin_local, 0x4) \
108 _ (site_local, 0x5) \
109 _ (organization_local, 0x8) \
112 #define foreach_ip6_multicast_link_local_group_id \
114 _ (all_routers, 0x2) \
115 _ (rip_routers, 0x9) \
116 _ (eigrp_routers, 0xa) \
117 _ (pim_routers, 0xd) \
118 _ (mldv2_routers, 0x16)
121 #define _(f,n) IP6_MULTICAST_SCOPE_##f = n,
122 foreach_ip6_multicast_address_scope
124 } ip6_multicast_address_scope_t;
127 #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n,
128 foreach_ip6_multicast_link_local_group_id
130 } ip6_multicast_link_local_group_id_t;
133 ip6_address_is_multicast (ip6_address_t * a)
134 { return a->as_u8[0] == 0xff; }
137 ip46_address_is_multicast (ip46_address_t * a)
139 return ip46_address_is_ip4(a) ? ip4_address_is_multicast(&a->ip4) :
140 ip6_address_is_multicast(&a->ip6);
144 ip6_set_reserved_multicast_address (ip6_address_t * a,
145 ip6_multicast_address_scope_t scope,
148 a->as_u64[0] = a->as_u64[1] = 0;
149 a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope);
150 a->as_u16[7] = clib_host_to_net_u16 (id);
154 ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
156 /* 0xff02::1:ffXX:XXXX. */
157 a->as_u64[0] = a->as_u64[1] = 0;
158 a->as_u16[0] = clib_host_to_net_u16 (0xff02);
160 ASSERT ((id >> 24) == 0);
162 a->as_u32[3] = clib_host_to_net_u32 (id);
166 ip6_link_local_address_from_ethernet_address (ip6_address_t * a, u8 * ethernet_address)
168 a->as_u64[0] = a->as_u64[1] = 0;
169 a->as_u16[0] = clib_host_to_net_u16 (0xfe80);
170 /* Always set locally administered bit (6). */
171 a->as_u8[0x8] = ethernet_address[0] | (1 << 6);
172 a->as_u8[0x9] = ethernet_address[1];
173 a->as_u8[0xa] = ethernet_address[2];
174 a->as_u8[0xb] = 0xff;
175 a->as_u8[0xc] = 0xfe;
176 a->as_u8[0xd] = ethernet_address[3];
177 a->as_u8[0xe] = ethernet_address[4];
178 a->as_u8[0xf] = ethernet_address[5];
182 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
184 ethernet_address[0] = 0x33;
185 ethernet_address[1] = 0x33;
186 ethernet_address[2] = ((group_id >> 24) & 0xff);
187 ethernet_address[3] = ((group_id >> 16) & 0xff);
188 ethernet_address[4] = ((group_id >> 8) & 0xff);
189 ethernet_address[5] = ((group_id >> 0) & 0xff);
193 ip6_address_is_equal (ip6_address_t * a, ip6_address_t * b)
196 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
197 if (a->as_uword[i] != b->as_uword[i])
203 ip6_address_is_equal_masked (ip6_address_t * a, ip6_address_t * b,
204 ip6_address_t * mask)
207 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
209 uword a_masked, b_masked;
210 a_masked = a->as_uword[i] & mask->as_uword[i];
211 b_masked = b->as_uword[i] & mask->as_uword[i];
213 if (a_masked != b_masked)
220 ip6_address_mask (ip6_address_t * a, ip6_address_t * mask)
223 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
224 a->as_uword[i] &= mask->as_uword[i];
228 ip6_address_set_zero (ip6_address_t * a)
231 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
236 ip6_address_mask_from_width (ip6_address_t * a, u32 width)
238 int i, byte, bit, bitnum;
239 ASSERT (width <= 128);
240 memset (a, 0, sizeof (a[0]));
241 for (i = 0; i < width; i++)
243 bitnum = (7 - (i & 7));
246 a->as_u8[byte] |= bit;
251 ip6_address_is_zero (ip6_address_t * a)
254 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
255 if (a->as_uword[i] != 0)
260 /* Check for unspecified address ::0 */
262 ip6_address_is_unspecified (ip6_address_t * a)
263 { return ip6_address_is_zero (a); }
265 /* Check for loopback address ::1 */
267 ip6_address_is_loopback (ip6_address_t * a)
270 u8 save = a->as_u8[15];
271 a->as_u8[15] = save ^ 1;
272 is_loopback = ip6_address_is_zero (a);
277 /* Check for link local unicast fe80::/10. */
279 ip6_address_is_link_local_unicast (ip6_address_t * a)
280 { return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80; }
282 /* Check for unique local unicast fc00::/7. */
284 ip6_address_is_local_unicast (ip6_address_t * a)
285 { return (a->as_u8[0] & 0xfe) == 0xfc; }
287 /* Check for unique global unicast 2000::/3. */
289 ip6_address_is_global_unicast (ip6_address_t * a)
290 { return (a->as_u8[0] & 0xe0) == 0x20; }
292 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
294 ip6_is_solicited_node_multicast_address (ip6_address_t * a)
296 return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
298 && a->as_u32[2] == clib_host_to_net_u32 (1)
299 && a->as_u8[12] == 0xff);
303 /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
304 u32 ip_version_traffic_class_and_flow_label;
306 /* Total packet length not including this header (but including
307 any extension headers if present). */
310 /* Protocol for next header. */
313 /* Hop limit decremented by router at each hop. */
316 /* Source and destination address. */
317 ip6_address_t src_address, dst_address;
321 ip6_next_header (ip6_header_t * i)
322 { return (void *) (i + 1); }
325 ip6_copy_header (ip6_header_t * dst,
326 const ip6_header_t *src)
328 dst->ip_version_traffic_class_and_flow_label =
329 src->ip_version_traffic_class_and_flow_label;
330 dst->payload_length = src->payload_length;
331 dst->protocol = src->protocol;
332 dst->hop_limit = src->hop_limit;
334 dst->src_address.as_uword[0] = src->src_address.as_uword[0];
335 dst->src_address.as_uword[1] = src->src_address.as_uword[1];
336 dst->dst_address.as_uword[0] = src->dst_address.as_uword[0];
337 dst->dst_address.as_uword[1] = src->dst_address.as_uword[1];
341 ip6_tcp_reply_x1 (ip6_header_t * ip0, tcp_header_t * tcp0)
344 ip6_address_t src0, dst0;
346 src0 = ip0->src_address;
347 dst0 = ip0->dst_address;
348 ip0->src_address = dst0;
349 ip0->dst_address = src0;
355 src0 = tcp0->ports.src;
356 dst0 = tcp0->ports.dst;
357 tcp0->ports.src = dst0;
358 tcp0->ports.dst = src0;
363 ip6_tcp_reply_x2 (ip6_header_t * ip0, ip6_header_t * ip1,
364 tcp_header_t * tcp0, tcp_header_t * tcp1)
367 ip6_address_t src0, dst0, src1, dst1;
369 src0 = ip0->src_address;
370 src1 = ip1->src_address;
371 dst0 = ip0->dst_address;
372 dst1 = ip1->dst_address;
373 ip0->src_address = dst0;
374 ip1->src_address = dst1;
375 ip0->dst_address = src0;
376 ip1->dst_address = src1;
380 u16 src0, dst0, src1, dst1;
382 src0 = tcp0->ports.src;
383 src1 = tcp1->ports.src;
384 dst0 = tcp0->ports.dst;
385 dst1 = tcp1->ports.dst;
386 tcp0->ports.src = dst0;
387 tcp1->ports.src = dst1;
388 tcp0->ports.dst = src0;
389 tcp1->ports.dst = src1;
394 typedef CLIB_PACKED (struct {
396 }) ip6_pad1_option_t;
398 typedef CLIB_PACKED (struct {
402 }) ip6_padN_option_t;
404 typedef CLIB_PACKED (struct {
405 #define IP6_MLDP_ALERT_TYPE 0x5
409 }) ip6_router_alert_option_t;
411 typedef CLIB_PACKED (struct {
413 /* Length of this header plus option data in 8 byte units. */
416 }) ip6_hop_by_hop_ext_t;
418 typedef CLIB_PACKED (struct {
421 u16 fragment_offset_and_more;
425 #define ip6_frag_hdr_offset(hdr) \
426 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) >> 3)
428 #define ip6_frag_hdr_more(hdr) \
429 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) & 0x1)
431 #define ip6_frag_hdr_offset_and_more(offset, more) \
432 clib_host_to_net_u16(((offset) << 3) + !!(more))
434 #endif /* included_ip6_packet_h */