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
48 uword as_uword[16 / sizeof (uword)];
51 /* Packed so that the mhash key doesn't include uninitialized pad bytes */
52 typedef CLIB_PACKED (struct {
53 /* IP address must be first for ip_interface_address_get_address() to work */
54 ip6_address_t ip6_addr;
59 ip6_addr_fib_init (ip6_address_fib_t * addr_fib, ip6_address_t * address,
62 addr_fib->ip6_addr.as_u64[0] = address->as_u64[0];
63 addr_fib->ip6_addr.as_u64[1] = address->as_u64[1];
64 addr_fib->fib_index = fib_index;
70 global unicast 2000::/3
71 unique local unicast fc00::/7
72 link local unicast fe80::/10
74 ietf reserved everything else. */
76 #define foreach_ip6_multicast_address_scope \
79 _ (admin_local, 0x4) \
81 _ (organization_local, 0x8) \
84 #define foreach_ip6_multicast_link_local_group_id \
86 _ (all_routers, 0x2) \
87 _ (rip_routers, 0x9) \
88 _ (eigrp_routers, 0xa) \
89 _ (pim_routers, 0xd) \
90 _ (mldv2_routers, 0x16)
93 #define _(f,n) IP6_MULTICAST_SCOPE_##f = n,
94 foreach_ip6_multicast_address_scope
96 } ip6_multicast_address_scope_t;
99 #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n,
100 foreach_ip6_multicast_link_local_group_id
102 } ip6_multicast_link_local_group_id_t;
105 ip6_address_is_multicast (ip6_address_t * a)
106 { return a->as_u8[0] == 0xff; }
109 ip6_set_reserved_multicast_address (ip6_address_t * a,
110 ip6_multicast_address_scope_t scope,
113 a->as_u64[0] = a->as_u64[1] = 0;
114 a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope);
115 a->as_u16[7] = clib_host_to_net_u16 (id);
119 ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
121 /* 0xff02::1:ffXX:XXXX. */
122 a->as_u64[0] = a->as_u64[1] = 0;
123 a->as_u16[0] = clib_host_to_net_u16 (0xff02);
125 ASSERT ((id >> 24) == 0);
127 a->as_u32[3] = clib_host_to_net_u32 (id);
131 ip6_link_local_address_from_ethernet_address (ip6_address_t * a, u8 * ethernet_address)
133 a->as_u64[0] = a->as_u64[1] = 0;
134 a->as_u16[0] = clib_host_to_net_u16 (0xfe80);
135 /* Always set locally administered bit (6). */
136 a->as_u8[0x8] = ethernet_address[0] | (1 << 6);
137 a->as_u8[0x9] = ethernet_address[1];
138 a->as_u8[0xa] = ethernet_address[2];
139 a->as_u8[0xb] = 0xff;
140 a->as_u8[0xc] = 0xfe;
141 a->as_u8[0xd] = ethernet_address[3];
142 a->as_u8[0xe] = ethernet_address[4];
143 a->as_u8[0xf] = ethernet_address[5];
147 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
149 ethernet_address[0] = 0x33;
150 ethernet_address[1] = 0x33;
151 ethernet_address[2] = ((group_id >> 24) & 0xff);
152 ethernet_address[3] = ((group_id >> 16) & 0xff);
153 ethernet_address[4] = ((group_id >> 8) & 0xff);
154 ethernet_address[5] = ((group_id >> 0) & 0xff);
158 ip6_address_is_equal (ip6_address_t * a, ip6_address_t * b)
161 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
162 if (a->as_uword[i] != b->as_uword[i])
168 ip6_address_is_equal_masked (ip6_address_t * a, ip6_address_t * b,
169 ip6_address_t * mask)
172 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
174 uword a_masked, b_masked;
175 a_masked = a->as_uword[i] & mask->as_uword[i];
176 b_masked = b->as_uword[i] & mask->as_uword[i];
178 if (a_masked != b_masked)
185 ip6_address_mask (ip6_address_t * a, ip6_address_t * mask)
188 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
189 a->as_uword[i] &= mask->as_uword[i];
193 ip6_address_set_zero (ip6_address_t * a)
196 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
201 ip6_address_mask_from_width (ip6_address_t * a, u32 width)
203 int i, byte, bit, bitnum;
204 ASSERT (width <= 128);
205 memset (a, 0, sizeof (a[0]));
206 for (i = 0; i < width; i++)
208 bitnum = (7 - (i & 7));
211 a->as_u8[byte] |= bit;
216 ip6_address_is_zero (ip6_address_t * a)
219 for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
220 if (a->as_uword[i] != 0)
225 /* Check for unspecified address ::0 */
227 ip6_address_is_unspecified (ip6_address_t * a)
228 { return ip6_address_is_zero (a); }
230 /* Check for loopback address ::1 */
232 ip6_address_is_loopback (ip6_address_t * a)
235 u8 save = a->as_u8[15];
236 a->as_u8[15] = save ^ 1;
237 is_loopback = ip6_address_is_zero (a);
242 /* Check for link local unicast fe80::/10. */
244 ip6_address_is_link_local_unicast (ip6_address_t * a)
245 { return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80; }
247 /* Check for unique local unicast fc00::/7. */
249 ip6_address_is_local_unicast (ip6_address_t * a)
250 { return (a->as_u8[0] & 0xfe) == 0xfc; }
252 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
254 ip6_is_solicited_node_multicast_address (ip6_address_t * a)
256 return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
258 && a->as_u32[2] == clib_host_to_net_u32 (1)
259 && a->as_u8[12] == 0xff);
263 /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
264 u32 ip_version_traffic_class_and_flow_label;
266 /* Total packet length not including this header (but including
267 any extension headers if present). */
270 /* Protocol for next header. */
273 /* Hop limit decremented by router at each hop. */
276 /* Source and destination address. */
277 ip6_address_t src_address, dst_address;
281 ip6_next_header (ip6_header_t * i)
282 { return (void *) (i + 1); }
285 ip6_tcp_reply_x1 (ip6_header_t * ip0, tcp_header_t * tcp0)
288 ip6_address_t src0, dst0;
290 src0 = ip0->src_address;
291 dst0 = ip0->dst_address;
292 ip0->src_address = dst0;
293 ip0->dst_address = src0;
299 src0 = tcp0->ports.src;
300 dst0 = tcp0->ports.dst;
301 tcp0->ports.src = dst0;
302 tcp0->ports.dst = src0;
307 ip6_tcp_reply_x2 (ip6_header_t * ip0, ip6_header_t * ip1,
308 tcp_header_t * tcp0, tcp_header_t * tcp1)
311 ip6_address_t src0, dst0, src1, dst1;
313 src0 = ip0->src_address;
314 src1 = ip1->src_address;
315 dst0 = ip0->dst_address;
316 dst1 = ip1->dst_address;
317 ip0->src_address = dst0;
318 ip1->src_address = dst1;
319 ip0->dst_address = src0;
320 ip1->dst_address = src1;
324 u16 src0, dst0, src1, dst1;
326 src0 = tcp0->ports.src;
327 src1 = tcp1->ports.src;
328 dst0 = tcp0->ports.dst;
329 dst1 = tcp1->ports.dst;
330 tcp0->ports.src = dst0;
331 tcp1->ports.src = dst1;
332 tcp0->ports.dst = src0;
333 tcp1->ports.dst = src1;
338 typedef CLIB_PACKED (struct {
340 }) ip6_pad1_option_t;
342 typedef CLIB_PACKED (struct {
346 }) ip6_padN_option_t;
348 typedef CLIB_PACKED (struct {
349 #define IP6_MLDP_ALERT_TYPE 0x5
353 }) ip6_router_alert_option_t;
355 typedef CLIB_PACKED (struct {
357 /* Length of this header plus option data in 8 byte units. */
360 }) ip6_hop_by_hop_ext_t;
362 typedef CLIB_PACKED (struct {
365 u16 fragment_offset_and_more;
369 #define ip6_frag_hdr_offset(hdr) \
370 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) >> 3)
372 #define ip6_frag_hdr_more(hdr) \
373 (clib_net_to_host_u16((hdr)->fragment_offset_and_more) & 0x1)
375 #define ip6_frag_hdr_offset_and_more(offset, more) \
376 clib_host_to_net_u16(((offset) << 3) + !!(more))
378 #endif /* included_ip6_packet_h */