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)
75 ip6_addr_fib_init (ip6_address_fib_t * addr_fib, ip6_address_t * address,
78 addr_fib->ip6_addr.as_u64[0] = address->as_u64[0];
79 addr_fib->ip6_addr.as_u64[1] = address->as_u64[1];
80 addr_fib->fib_index = fib_index;
86 global unicast 2000::/3
87 unique local unicast fc00::/7
88 link local unicast fe80::/10
90 ietf reserved everything else. */
92 #define foreach_ip6_multicast_address_scope \
95 _ (admin_local, 0x4) \
97 _ (organization_local, 0x8) \
100 #define foreach_ip6_multicast_link_local_group_id \
102 _ (all_routers, 0x2) \
103 _ (rip_routers, 0x9) \
104 _ (eigrp_routers, 0xa) \
105 _ (pim_routers, 0xd) \
106 _ (mldv2_routers, 0x16)
109 #define _(f,n) IP6_MULTICAST_SCOPE_##f = n,
110 foreach_ip6_multicast_address_scope
112 } ip6_multicast_address_scope_t;
115 #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n,
116 foreach_ip6_multicast_link_local_group_id
118 } ip6_multicast_link_local_group_id_t;
121 ip6_address_is_multicast (ip6_address_t * a)
122 { return a->as_u8[0] == 0xff; }
125 ip6_set_reserved_multicast_address (ip6_address_t * a,
126 ip6_multicast_address_scope_t scope,
129 a->as_u64[0] = a->as_u64[1] = 0;
130 a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope);
131 a->as_u16[7] = clib_host_to_net_u16 (id);
135 ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
137 /* 0xff02::1:ffXX:XXXX. */
138 a->as_u64[0] = a->as_u64[1] = 0;
139 a->as_u16[0] = clib_host_to_net_u16 (0xff02);
141 ASSERT ((id >> 24) == 0);
143 a->as_u32[3] = clib_host_to_net_u32 (id);
147 ip6_link_local_address_from_ethernet_address (ip6_address_t * a, u8 * ethernet_address)
149 a->as_u64[0] = a->as_u64[1] = 0;
150 a->as_u16[0] = clib_host_to_net_u16 (0xfe80);
151 /* Always set locally administered bit (6). */
152 a->as_u8[0x8] = ethernet_address[0] | (1 << 6);
153 a->as_u8[0x9] = ethernet_address[1];
154 a->as_u8[0xa] = ethernet_address[2];
155 a->as_u8[0xb] = 0xff;
156 a->as_u8[0xc] = 0xfe;
157 a->as_u8[0xd] = ethernet_address[3];
158 a->as_u8[0xe] = ethernet_address[4];
159 a->as_u8[0xf] = ethernet_address[5];
163 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
165 ethernet_address[0] = 0x33;
166 ethernet_address[1] = 0x33;
167 ethernet_address[2] = ((group_id >> 24) & 0xff);
168 ethernet_address[3] = ((group_id >> 16) & 0xff);
169 ethernet_address[4] = ((group_id >> 8) & 0xff);
170 ethernet_address[5] = ((group_id >> 0) & 0xff);
174 ip6_address_is_equal (ip6_address_t * a, ip6_address_t * b)
177 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
178 if (a->as_uword[i] != b->as_uword[i])
184 ip6_address_is_equal_masked (ip6_address_t * a, ip6_address_t * b,
185 ip6_address_t * mask)
188 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
190 uword a_masked, b_masked;
191 a_masked = a->as_uword[i] & mask->as_uword[i];
192 b_masked = b->as_uword[i] & mask->as_uword[i];
194 if (a_masked != b_masked)
201 ip6_address_mask (ip6_address_t * a, ip6_address_t * mask)
204 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
205 a->as_uword[i] &= mask->as_uword[i];
209 ip6_address_set_zero (ip6_address_t * a)
212 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
217 ip6_address_mask_from_width (ip6_address_t * a, u32 width)
219 int i, byte, bit, bitnum;
220 ASSERT (width <= 128);
221 memset (a, 0, sizeof (a[0]));
222 for (i = 0; i < width; i++)
224 bitnum = (7 - (i & 7));
227 a->as_u8[byte] |= bit;
232 ip6_address_is_zero (ip6_address_t * a)
235 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
236 if (a->as_uword[i] != 0)
241 /* Check for unspecified address ::0 */
243 ip6_address_is_unspecified (ip6_address_t * a)
244 { return ip6_address_is_zero (a); }
246 /* Check for loopback address ::1 */
248 ip6_address_is_loopback (ip6_address_t * a)
251 u8 save = a->as_u8[15];
252 a->as_u8[15] = save ^ 1;
253 is_loopback = ip6_address_is_zero (a);
258 /* Check for link local unicast fe80::/10. */
260 ip6_address_is_link_local_unicast (ip6_address_t * a)
261 { return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80; }
263 /* Check for unique local unicast fc00::/7. */
265 ip6_address_is_local_unicast (ip6_address_t * a)
266 { return (a->as_u8[0] & 0xfe) == 0xfc; }
268 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
270 ip6_is_solicited_node_multicast_address (ip6_address_t * a)
272 return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
274 && a->as_u32[2] == clib_host_to_net_u32 (1)
275 && a->as_u8[12] == 0xff);
279 /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
280 u32 ip_version_traffic_class_and_flow_label;
282 /* Total packet length not including this header (but including
283 any extension headers if present). */
286 /* Protocol for next header. */
289 /* Hop limit decremented by router at each hop. */
292 /* Source and destination address. */
293 ip6_address_t src_address, dst_address;
297 ip6_next_header (ip6_header_t * i)
298 { return (void *) (i + 1); }
301 ip6_tcp_reply_x1 (ip6_header_t * ip0, tcp_header_t * tcp0)
304 ip6_address_t src0, dst0;
306 src0 = ip0->src_address;
307 dst0 = ip0->dst_address;
308 ip0->src_address = dst0;
309 ip0->dst_address = src0;
315 src0 = tcp0->ports.src;
316 dst0 = tcp0->ports.dst;
317 tcp0->ports.src = dst0;
318 tcp0->ports.dst = src0;
323 ip6_tcp_reply_x2 (ip6_header_t * ip0, ip6_header_t * ip1,
324 tcp_header_t * tcp0, tcp_header_t * tcp1)
327 ip6_address_t src0, dst0, src1, dst1;
329 src0 = ip0->src_address;
330 src1 = ip1->src_address;
331 dst0 = ip0->dst_address;
332 dst1 = ip1->dst_address;
333 ip0->src_address = dst0;
334 ip1->src_address = dst1;
335 ip0->dst_address = src0;
336 ip1->dst_address = src1;
340 u16 src0, dst0, src1, dst1;
342 src0 = tcp0->ports.src;
343 src1 = tcp1->ports.src;
344 dst0 = tcp0->ports.dst;
345 dst1 = tcp1->ports.dst;
346 tcp0->ports.src = dst0;
347 tcp1->ports.src = dst1;
348 tcp0->ports.dst = src0;
349 tcp1->ports.dst = src1;
354 typedef CLIB_PACKED (struct {
356 }) ip6_pad1_option_t;
358 typedef CLIB_PACKED (struct {
362 }) ip6_padN_option_t;
364 typedef CLIB_PACKED (struct {
365 #define IP6_MLDP_ALERT_TYPE 0x5
369 }) ip6_router_alert_option_t;
371 typedef CLIB_PACKED (struct {
373 /* Length of this header plus option data in 8 byte units. */
376 }) ip6_hop_by_hop_ext_t;
378 typedef CLIB_PACKED (struct {
381 u16 fragment_offset_and_more;
385 #define ip6_frag_hdr_offset(hdr) \
386 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) >> 3)
388 #define ip6_frag_hdr_more(hdr) \
389 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) & 0x1)
391 #define ip6_frag_hdr_offset_and_more(offset, more) \
392 clib_host_to_net_u16(((offset) << 3) + !!(more))
394 #endif /* included_ip6_packet_h */