Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 1 | /* |
| 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: |
| 6 | * |
| 7 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | * |
| 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. |
| 14 | */ |
| 15 | /* |
| 16 | * ip6/packet.h: ip6 packet format |
| 17 | * |
| 18 | * Copyright (c) 2008 Eliot Dresselhaus |
| 19 | * |
| 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: |
| 27 | * |
| 28 | * The above copyright notice and this permission notice shall be |
| 29 | * included in all copies or substantial portions of the Software. |
| 30 | * |
| 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. |
| 38 | */ |
| 39 | |
| 40 | #ifndef included_ip6_packet_h |
| 41 | #define included_ip6_packet_h |
| 42 | |
Neale Ranns | f7040f0 | 2022-02-15 09:02:27 +0000 | [diff] [blame] | 43 | #include <vlib/vlib.h> |
Pierre Pfister | 1dabaaf | 2016-04-25 14:15:15 +0100 | [diff] [blame] | 44 | #include <vnet/ip/ip4_packet.h> |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 45 | #include <stdbool.h> |
Pierre Pfister | 1dabaaf | 2016-04-25 14:15:15 +0100 | [diff] [blame] | 46 | |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 47 | typedef union |
| 48 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 49 | u8 as_u8[16]; |
| 50 | u16 as_u16[8]; |
| 51 | u32 as_u32[4]; |
| 52 | u64 as_u64[2]; |
Neale Ranns | 3ec09e9 | 2020-02-24 13:32:30 +0000 | [diff] [blame] | 53 | u64x2 as_u128; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 54 | uword as_uword[16 / sizeof (uword)]; |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 55 | } |
Neale Ranns | 3ec09e9 | 2020-02-24 13:32:30 +0000 | [diff] [blame] | 56 | __clib_packed ip6_address_t; |
| 57 | |
| 58 | STATIC_ASSERT_SIZEOF (ip6_address_t, 16); |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 59 | |
Damjan Marion | a35cc14 | 2018-03-16 01:25:27 +0100 | [diff] [blame] | 60 | typedef struct |
| 61 | { |
| 62 | ip6_address_t addr, mask; |
| 63 | } ip6_address_and_mask_t; |
| 64 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 65 | /* Packed so that the mhash key doesn't include uninitialized pad bytes */ |
| 66 | typedef CLIB_PACKED (struct { |
| 67 | /* IP address must be first for ip_interface_address_get_address() to work */ |
| 68 | ip6_address_t ip6_addr; |
| 69 | u32 fib_index; |
| 70 | }) ip6_address_fib_t; |
| 71 | |
Eyal Bari | c5b1360 | 2016-11-24 19:42:43 +0200 | [diff] [blame] | 72 | always_inline void |
Neale Ranns | d69f439 | 2018-08-31 06:30:16 -0400 | [diff] [blame] | 73 | ip6_addr_fib_init (ip6_address_fib_t * addr_fib, |
| 74 | const ip6_address_t * address, u32 fib_index) |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 75 | { |
Eyal Bari | e101e1f | 2017-03-15 08:23:42 +0200 | [diff] [blame] | 76 | addr_fib->ip6_addr = *address; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 77 | addr_fib->fib_index = fib_index; |
| 78 | } |
| 79 | |
| 80 | /* Special addresses: |
| 81 | unspecified ::/128 |
| 82 | loopback ::1/128 |
| 83 | global unicast 2000::/3 |
| 84 | unique local unicast fc00::/7 |
| 85 | link local unicast fe80::/10 |
| 86 | multicast ff00::/8 |
| 87 | ietf reserved everything else. */ |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 88 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 89 | #define foreach_ip6_multicast_address_scope \ |
| 90 | _ (loopback, 0x1) \ |
| 91 | _ (link_local, 0x2) \ |
| 92 | _ (admin_local, 0x4) \ |
| 93 | _ (site_local, 0x5) \ |
| 94 | _ (organization_local, 0x8) \ |
| 95 | _ (global, 0xe) |
| 96 | |
| 97 | #define foreach_ip6_multicast_link_local_group_id \ |
| 98 | _ (all_hosts, 0x1) \ |
| 99 | _ (all_routers, 0x2) \ |
| 100 | _ (rip_routers, 0x9) \ |
| 101 | _ (eigrp_routers, 0xa) \ |
| 102 | _ (pim_routers, 0xd) \ |
| 103 | _ (mldv2_routers, 0x16) |
| 104 | |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 105 | typedef enum |
| 106 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 107 | #define _(f,n) IP6_MULTICAST_SCOPE_##f = n, |
| 108 | foreach_ip6_multicast_address_scope |
| 109 | #undef _ |
| 110 | } ip6_multicast_address_scope_t; |
| 111 | |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 112 | typedef enum |
| 113 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 114 | #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n, |
| 115 | foreach_ip6_multicast_link_local_group_id |
| 116 | #undef _ |
| 117 | } ip6_multicast_link_local_group_id_t; |
| 118 | |
| 119 | always_inline uword |
Neale Ranns | d69f439 | 2018-08-31 06:30:16 -0400 | [diff] [blame] | 120 | ip6_address_is_multicast (const ip6_address_t * a) |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 121 | { |
| 122 | return a->as_u8[0] == 0xff; |
| 123 | } |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 124 | |
| 125 | always_inline void |
Neale Ranns | 3702930 | 2018-08-10 05:30:06 -0700 | [diff] [blame] | 126 | ip6_address_copy (ip6_address_t * dst, const ip6_address_t * src) |
| 127 | { |
| 128 | dst->as_u64[0] = src->as_u64[0]; |
| 129 | dst->as_u64[1] = src->as_u64[1]; |
| 130 | } |
| 131 | |
| 132 | always_inline void |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 133 | ip6_set_reserved_multicast_address (ip6_address_t * a, |
| 134 | ip6_multicast_address_scope_t scope, |
| 135 | u16 id) |
| 136 | { |
| 137 | a->as_u64[0] = a->as_u64[1] = 0; |
| 138 | a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope); |
| 139 | a->as_u16[7] = clib_host_to_net_u16 (id); |
| 140 | } |
| 141 | |
| 142 | always_inline void |
| 143 | ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id) |
| 144 | { |
| 145 | /* 0xff02::1:ffXX:XXXX. */ |
| 146 | a->as_u64[0] = a->as_u64[1] = 0; |
| 147 | a->as_u16[0] = clib_host_to_net_u16 (0xff02); |
| 148 | a->as_u8[11] = 1; |
| 149 | ASSERT ((id >> 24) == 0); |
| 150 | id |= 0xff << 24; |
| 151 | a->as_u32[3] = clib_host_to_net_u32 (id); |
| 152 | } |
| 153 | |
| 154 | always_inline void |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 155 | ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id) |
| 156 | { |
| 157 | ethernet_address[0] = 0x33; |
| 158 | ethernet_address[1] = 0x33; |
| 159 | ethernet_address[2] = ((group_id >> 24) & 0xff); |
| 160 | ethernet_address[3] = ((group_id >> 16) & 0xff); |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 161 | ethernet_address[4] = ((group_id >> 8) & 0xff); |
| 162 | ethernet_address[5] = ((group_id >> 0) & 0xff); |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 163 | } |
| 164 | |
| 165 | always_inline uword |
Neale Ranns | d69f439 | 2018-08-31 06:30:16 -0400 | [diff] [blame] | 166 | ip6_address_is_equal (const ip6_address_t * a, const ip6_address_t * b) |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 167 | { |
| 168 | int i; |
| 169 | for (i = 0; i < ARRAY_LEN (a->as_uword); i++) |
| 170 | if (a->as_uword[i] != b->as_uword[i]) |
| 171 | return 0; |
| 172 | return 1; |
| 173 | } |
| 174 | |
| 175 | always_inline uword |
Neale Ranns | d69f439 | 2018-08-31 06:30:16 -0400 | [diff] [blame] | 176 | ip6_address_is_equal_masked (const ip6_address_t * a, |
| 177 | const ip6_address_t * b, |
| 178 | const ip6_address_t * mask) |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 179 | { |
| 180 | int i; |
| 181 | for (i = 0; i < ARRAY_LEN (a->as_uword); i++) |
| 182 | { |
| 183 | uword a_masked, b_masked; |
| 184 | a_masked = a->as_uword[i] & mask->as_uword[i]; |
| 185 | b_masked = b->as_uword[i] & mask->as_uword[i]; |
| 186 | |
| 187 | if (a_masked != b_masked) |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 188 | return 0; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 189 | } |
| 190 | return 1; |
| 191 | } |
| 192 | |
| 193 | always_inline void |
Neale Ranns | d69f439 | 2018-08-31 06:30:16 -0400 | [diff] [blame] | 194 | ip6_address_mask (ip6_address_t * a, const ip6_address_t * mask) |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 195 | { |
| 196 | int i; |
| 197 | for (i = 0; i < ARRAY_LEN (a->as_uword); i++) |
| 198 | a->as_uword[i] &= mask->as_uword[i]; |
| 199 | } |
| 200 | |
| 201 | always_inline void |
| 202 | ip6_address_set_zero (ip6_address_t * a) |
| 203 | { |
| 204 | int i; |
| 205 | for (i = 0; i < ARRAY_LEN (a->as_uword); i++) |
| 206 | a->as_uword[i] = 0; |
| 207 | } |
| 208 | |
| 209 | always_inline void |
| 210 | ip6_address_mask_from_width (ip6_address_t * a, u32 width) |
| 211 | { |
| 212 | int i, byte, bit, bitnum; |
| 213 | ASSERT (width <= 128); |
Dave Barach | b7b9299 | 2018-10-17 10:38:51 -0400 | [diff] [blame] | 214 | clib_memset (a, 0, sizeof (a[0])); |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 215 | for (i = 0; i < width; i++) |
| 216 | { |
| 217 | bitnum = (7 - (i & 7)); |
| 218 | byte = i / 8; |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 219 | bit = 1 << bitnum; |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 220 | a->as_u8[byte] |= bit; |
| 221 | } |
| 222 | } |
| 223 | |
| 224 | always_inline uword |
Neale Ranns | d69f439 | 2018-08-31 06:30:16 -0400 | [diff] [blame] | 225 | ip6_address_is_zero (const ip6_address_t * a) |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 226 | { |
| 227 | int i; |
| 228 | for (i = 0; i < ARRAY_LEN (a->as_uword); i++) |
| 229 | if (a->as_uword[i] != 0) |
| 230 | return 0; |
| 231 | return 1; |
| 232 | } |
| 233 | |
| 234 | /* Check for unspecified address ::0 */ |
| 235 | always_inline uword |
Neale Ranns | d69f439 | 2018-08-31 06:30:16 -0400 | [diff] [blame] | 236 | ip6_address_is_unspecified (const ip6_address_t * a) |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 237 | { |
| 238 | return ip6_address_is_zero (a); |
| 239 | } |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 240 | |
| 241 | /* Check for loopback address ::1 */ |
| 242 | always_inline uword |
Neale Ranns | d69f439 | 2018-08-31 06:30:16 -0400 | [diff] [blame] | 243 | ip6_address_is_loopback (const ip6_address_t * a) |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 244 | { |
Neale Ranns | d69f439 | 2018-08-31 06:30:16 -0400 | [diff] [blame] | 245 | return (a->as_u64[0] == 0 && |
| 246 | a->as_u32[2] == 0 && |
| 247 | a->as_u16[6] == 0 && a->as_u8[14] == 0 && a->as_u8[15] == 1); |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 248 | } |
| 249 | |
| 250 | /* Check for link local unicast fe80::/10. */ |
| 251 | always_inline uword |
Neale Ranns | 53da221 | 2018-02-24 02:11:19 -0800 | [diff] [blame] | 252 | ip6_address_is_link_local_unicast (const ip6_address_t * a) |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 253 | { |
| 254 | return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80; |
| 255 | } |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 256 | |
| 257 | /* Check for unique local unicast fc00::/7. */ |
| 258 | always_inline uword |
Neale Ranns | d69f439 | 2018-08-31 06:30:16 -0400 | [diff] [blame] | 259 | ip6_address_is_local_unicast (const ip6_address_t * a) |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 260 | { |
| 261 | return (a->as_u8[0] & 0xfe) == 0xfc; |
| 262 | } |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 263 | |
Chris Luke | bfd32fd | 2016-06-24 20:38:06 -0400 | [diff] [blame] | 264 | /* Check for unique global unicast 2000::/3. */ |
| 265 | always_inline uword |
Neale Ranns | d69f439 | 2018-08-31 06:30:16 -0400 | [diff] [blame] | 266 | ip6_address_is_global_unicast (const ip6_address_t * a) |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 267 | { |
| 268 | return (a->as_u8[0] & 0xe0) == 0x20; |
| 269 | } |
Chris Luke | bfd32fd | 2016-06-24 20:38:06 -0400 | [diff] [blame] | 270 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 271 | /* Check for solicited node multicast 0xff02::1:ff00:0/104 */ |
| 272 | always_inline uword |
Neale Ranns | d69f439 | 2018-08-31 06:30:16 -0400 | [diff] [blame] | 273 | ip6_is_solicited_node_multicast_address (const ip6_address_t * a) |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 274 | { |
| 275 | return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000) |
| 276 | && a->as_u32[1] == 0 |
| 277 | && a->as_u32[2] == clib_host_to_net_u32 (1) |
| 278 | && a->as_u8[12] == 0xff); |
| 279 | } |
| 280 | |
Neale Ranns | cd35e53 | 2018-08-31 02:51:45 -0700 | [diff] [blame] | 281 | always_inline u32 |
| 282 | ip6_address_hash_to_u32 (const ip6_address_t * a) |
| 283 | { |
| 284 | return (a->as_u32[0] ^ a->as_u32[1] ^ a->as_u32[2] ^ a->as_u32[3]); |
| 285 | } |
| 286 | |
| 287 | always_inline u64 |
| 288 | ip6_address_hash_to_u64 (const ip6_address_t * a) |
| 289 | { |
| 290 | return (a->as_u64[0] ^ a->as_u64[1]); |
| 291 | } |
| 292 | |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 293 | typedef struct |
| 294 | { |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 295 | /* 4 bit version, 8 bit traffic class and 20 bit flow label. */ |
| 296 | u32 ip_version_traffic_class_and_flow_label; |
| 297 | |
| 298 | /* Total packet length not including this header (but including |
| 299 | any extension headers if present). */ |
| 300 | u16 payload_length; |
| 301 | |
| 302 | /* Protocol for next header. */ |
| 303 | u8 protocol; |
| 304 | |
| 305 | /* Hop limit decremented by router at each hop. */ |
| 306 | u8 hop_limit; |
| 307 | |
| 308 | /* Source and destination address. */ |
| 309 | ip6_address_t src_address, dst_address; |
| 310 | } ip6_header_t; |
| 311 | |
Neale Ranns | 041add7 | 2020-01-02 04:06:10 +0000 | [diff] [blame] | 312 | #define IP6_PACKET_TC_MASK 0x0FF00000 |
| 313 | #define IP6_PACKET_DSCP_MASK 0x0FC00000 |
| 314 | #define IP6_PACKET_ECN_MASK 0x00300000 |
Ahmed Abdelsalam | f2984bb | 2020-11-20 18:56:09 +0000 | [diff] [blame] | 315 | #define IP6_PACKET_FL_MASK 0x000FFFFF |
Neale Ranns | 041add7 | 2020-01-02 04:06:10 +0000 | [diff] [blame] | 316 | |
Neale Ranns | 038e1df | 2019-07-19 14:01:02 +0000 | [diff] [blame] | 317 | always_inline ip_dscp_t |
Neale Ranns | 31ed744 | 2018-02-23 05:29:09 -0800 | [diff] [blame] | 318 | ip6_traffic_class (const ip6_header_t * i) |
Ole Troan | 5c74973 | 2017-03-13 13:39:52 +0100 | [diff] [blame] | 319 | { |
Neale Ranns | 041add7 | 2020-01-02 04:06:10 +0000 | [diff] [blame] | 320 | return (i->ip_version_traffic_class_and_flow_label & IP6_PACKET_TC_MASK) >> |
| 321 | 20; |
Ole Troan | 5c74973 | 2017-03-13 13:39:52 +0100 | [diff] [blame] | 322 | } |
| 323 | |
Neale Ranns | 038e1df | 2019-07-19 14:01:02 +0000 | [diff] [blame] | 324 | static_always_inline ip_dscp_t |
Neale Ranns | 31ed744 | 2018-02-23 05:29:09 -0800 | [diff] [blame] | 325 | ip6_traffic_class_network_order (const ip6_header_t * ip6) |
| 326 | { |
| 327 | return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label) |
Neale Ranns | 041add7 | 2020-01-02 04:06:10 +0000 | [diff] [blame] | 328 | & IP6_PACKET_TC_MASK) >> 20; |
Neale Ranns | 31ed744 | 2018-02-23 05:29:09 -0800 | [diff] [blame] | 329 | } |
| 330 | |
Neale Ranns | 9534696 | 2019-11-25 13:04:44 +0000 | [diff] [blame] | 331 | static_always_inline ip_dscp_t |
| 332 | ip6_dscp_network_order (const ip6_header_t * ip6) |
| 333 | { |
| 334 | return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label) |
Neale Ranns | 041add7 | 2020-01-02 04:06:10 +0000 | [diff] [blame] | 335 | & IP6_PACKET_DSCP_MASK) >> 22; |
Neale Ranns | 9534696 | 2019-11-25 13:04:44 +0000 | [diff] [blame] | 336 | } |
| 337 | |
| 338 | static_always_inline ip_ecn_t |
| 339 | ip6_ecn_network_order (const ip6_header_t * ip6) |
| 340 | { |
| 341 | return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label) |
Neale Ranns | 041add7 | 2020-01-02 04:06:10 +0000 | [diff] [blame] | 342 | & IP6_PACKET_ECN_MASK) >> 20; |
Neale Ranns | 9534696 | 2019-11-25 13:04:44 +0000 | [diff] [blame] | 343 | } |
| 344 | |
Neale Ranns | 31ed744 | 2018-02-23 05:29:09 -0800 | [diff] [blame] | 345 | static_always_inline void |
Neale Ranns | 038e1df | 2019-07-19 14:01:02 +0000 | [diff] [blame] | 346 | ip6_set_traffic_class_network_order (ip6_header_t * ip6, ip_dscp_t dscp) |
Neale Ranns | 31ed744 | 2018-02-23 05:29:09 -0800 | [diff] [blame] | 347 | { |
| 348 | u32 tmp = |
| 349 | clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label); |
Neale Ranns | 039cbfe | 2018-02-27 03:45:38 -0800 | [diff] [blame] | 350 | tmp &= 0xf00fffff; |
Neale Ranns | 31ed744 | 2018-02-23 05:29:09 -0800 | [diff] [blame] | 351 | tmp |= (dscp << 20); |
| 352 | ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp); |
| 353 | } |
| 354 | |
Neale Ranns | 9534696 | 2019-11-25 13:04:44 +0000 | [diff] [blame] | 355 | static_always_inline void |
| 356 | ip6_set_dscp_network_order (ip6_header_t * ip6, ip_dscp_t dscp) |
| 357 | { |
| 358 | u32 tmp = |
| 359 | clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label); |
| 360 | tmp &= 0xf03fffff; |
| 361 | tmp |= (dscp << 22); |
| 362 | ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp); |
| 363 | } |
| 364 | |
| 365 | static_always_inline void |
| 366 | ip6_set_ecn_network_order (ip6_header_t * ip6, ip_ecn_t ecn) |
| 367 | { |
| 368 | u32 tmp = |
| 369 | clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label); |
| 370 | tmp &= 0xffcfffff; |
Neale Ranns | a91cb45 | 2021-02-04 11:02:52 +0000 | [diff] [blame] | 371 | tmp |= ((0x3 & ecn) << 20); |
Neale Ranns | 9534696 | 2019-11-25 13:04:44 +0000 | [diff] [blame] | 372 | ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp); |
| 373 | } |
| 374 | |
Neale Ranns | a91cb45 | 2021-02-04 11:02:52 +0000 | [diff] [blame] | 375 | static_always_inline u32 |
| 376 | ip6_flow_label_network_order (const ip6_header_t *ip6) |
| 377 | { |
| 378 | u32 tmp = |
| 379 | clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label); |
| 380 | return (tmp & 0xfffff); |
| 381 | } |
| 382 | |
| 383 | static_always_inline void |
| 384 | ip6_set_flow_label_network_order (ip6_header_t *ip6, u32 flow_label) |
| 385 | { |
| 386 | u32 tmp = |
| 387 | clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label); |
| 388 | tmp &= 0xfff00000; |
| 389 | tmp |= flow_label & 0x000fffff; |
| 390 | ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp); |
| 391 | } |
| 392 | |
| 393 | static_always_inline u32 |
| 394 | ip6_hop_limit_network_order (const ip6_header_t *ip6) |
| 395 | { |
| 396 | return (ip6->hop_limit); |
| 397 | } |
| 398 | |
| 399 | static_always_inline void |
| 400 | ip6_set_hop_limit_network_order (ip6_header_t *ip6, u8 hop_limit) |
| 401 | { |
| 402 | ip6->hop_limit = hop_limit; |
| 403 | } |
| 404 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 405 | always_inline void * |
| 406 | ip6_next_header (ip6_header_t * i) |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 407 | { |
| 408 | return (void *) (i + 1); |
| 409 | } |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 410 | |
| 411 | always_inline void |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 412 | ip6_copy_header (ip6_header_t * dst, const ip6_header_t * src) |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 413 | { |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 414 | dst->ip_version_traffic_class_and_flow_label = |
| 415 | src->ip_version_traffic_class_and_flow_label; |
| 416 | dst->payload_length = src->payload_length; |
| 417 | dst->protocol = src->protocol; |
| 418 | dst->hop_limit = src->hop_limit; |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 419 | |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 420 | dst->src_address.as_uword[0] = src->src_address.as_uword[0]; |
| 421 | dst->src_address.as_uword[1] = src->src_address.as_uword[1]; |
| 422 | dst->dst_address.as_uword[0] = src->dst_address.as_uword[0]; |
| 423 | dst->dst_address.as_uword[1] = src->dst_address.as_uword[1]; |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 424 | } |
| 425 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 426 | typedef CLIB_PACKED (struct { |
| 427 | u8 data; |
| 428 | }) ip6_pad1_option_t; |
| 429 | |
| 430 | typedef CLIB_PACKED (struct { |
| 431 | u8 type; |
| 432 | u8 len; |
| 433 | u8 data[0]; |
| 434 | }) ip6_padN_option_t; |
| 435 | |
| 436 | typedef CLIB_PACKED (struct { |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 437 | #define IP6_MLDP_ALERT_TYPE 0x5 |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 438 | u8 type; |
| 439 | u8 len; |
| 440 | u16 value; |
| 441 | }) ip6_router_alert_option_t; |
| 442 | |
| 443 | typedef CLIB_PACKED (struct { |
| 444 | u8 next_hdr; |
| 445 | /* Length of this header plus option data in 8 byte units. */ |
| 446 | u8 n_data_u64s; |
Shwetha | b78292e | 2016-09-13 11:51:00 +0100 | [diff] [blame] | 447 | }) ip6_ext_header_t; |
| 448 | |
Damjan Marion | 831d238 | 2019-03-22 13:58:08 +0100 | [diff] [blame] | 449 | #define foreach_ext_hdr_type \ |
| 450 | _(IP6_HOP_BY_HOP_OPTIONS) \ |
| 451 | _(IPV6_ROUTE) \ |
Damjan Marion | 831d238 | 2019-03-22 13:58:08 +0100 | [diff] [blame] | 452 | _(IP6_DESTINATION_OPTIONS) \ |
| 453 | _(MOBILITY) \ |
| 454 | _(HIP) \ |
| 455 | _(SHIM6) |
| 456 | |
Klement Sekera | 769145c | 2019-03-06 11:59:57 +0100 | [diff] [blame] | 457 | always_inline u8 |
| 458 | ip6_ext_hdr (u8 nexthdr) |
Shwetha | b78292e | 2016-09-13 11:51:00 +0100 | [diff] [blame] | 459 | { |
Damjan Marion | 831d238 | 2019-03-22 13:58:08 +0100 | [diff] [blame] | 460 | #ifdef CLIB_HAVE_VEC128 |
| 461 | static const u8x16 ext_hdr_types = { |
| 462 | #define _(x) IP_PROTOCOL_##x, |
Klement Sekera | 769145c | 2019-03-06 11:59:57 +0100 | [diff] [blame] | 463 | foreach_ext_hdr_type |
Damjan Marion | 831d238 | 2019-03-22 13:58:08 +0100 | [diff] [blame] | 464 | #undef _ |
| 465 | }; |
| 466 | |
| 467 | return !u8x16_is_all_zero (ext_hdr_types == u8x16_splat (nexthdr)); |
| 468 | #else |
Shwetha | b78292e | 2016-09-13 11:51:00 +0100 | [diff] [blame] | 469 | /* |
| 470 | * find out if nexthdr is an extension header or a protocol |
| 471 | */ |
Klement Sekera | 769145c | 2019-03-06 11:59:57 +0100 | [diff] [blame] | 472 | return 0 |
Damjan Marion | 831d238 | 2019-03-22 13:58:08 +0100 | [diff] [blame] | 473 | #define _(x) || (nexthdr == IP_PROTOCOL_##x) |
Klement Sekera | 769145c | 2019-03-06 11:59:57 +0100 | [diff] [blame] | 474 | foreach_ext_hdr_type; |
Damjan Marion | 831d238 | 2019-03-22 13:58:08 +0100 | [diff] [blame] | 475 | #undef _ |
| 476 | #endif |
Shwetha | b78292e | 2016-09-13 11:51:00 +0100 | [diff] [blame] | 477 | } |
| 478 | |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 479 | typedef CLIB_PACKED (struct { |
| 480 | u8 next_hdr; |
| 481 | /* Length of this header plus option data in 8 byte units. */ |
| 482 | u8 n_data_u64s; |
| 483 | u8 data[0]; |
| 484 | }) ip6_hop_by_hop_ext_t; |
| 485 | |
| 486 | typedef CLIB_PACKED (struct { |
| 487 | u8 next_hdr; |
| 488 | u8 rsv; |
| 489 | u16 fragment_offset_and_more; |
| 490 | u32 identification; |
| 491 | }) ip6_frag_hdr_t; |
| 492 | |
| 493 | #define ip6_frag_hdr_offset(hdr) \ |
| 494 | (clib_net_to_host_u16 ((hdr)->fragment_offset_and_more) >> 3) |
| 495 | |
| 496 | #define ip6_frag_hdr_offset_bytes(hdr) (8 * ip6_frag_hdr_offset (hdr)) |
| 497 | |
| 498 | #define ip6_frag_hdr_more(hdr) \ |
| 499 | (clib_net_to_host_u16 ((hdr)->fragment_offset_and_more) & 0x1) |
| 500 | |
| 501 | #define ip6_frag_hdr_offset_and_more(offset, more) \ |
| 502 | clib_host_to_net_u16 (((offset) << 3) + !!(more)) |
| 503 | |
Pablo Camarillo | fb38095 | 2016-12-07 18:34:18 +0100 | [diff] [blame] | 504 | #define ip6_ext_header_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+1) << 3) |
| 505 | #define ip6_ext_authhdr_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+2) << 2) |
Shwetha | b78292e | 2016-09-13 11:51:00 +0100 | [diff] [blame] | 506 | |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 507 | static inline int |
| 508 | ip6_ext_header_len_s (ip_protocol_t nh, void *p) |
| 509 | { |
| 510 | if (ip6_ext_hdr (nh)) |
| 511 | return ip6_ext_header_len (p); |
| 512 | switch (nh) |
| 513 | { |
| 514 | case IP_PROTOCOL_IPSEC_AH: |
| 515 | return ip6_ext_authhdr_len (p); |
| 516 | case IP_PROTOCOL_IPV6_FRAGMENTATION: |
| 517 | return sizeof (ip6_frag_hdr_t); |
| 518 | case IP_PROTOCOL_ICMP6: |
| 519 | return 4; |
| 520 | case IP_PROTOCOL_UDP: |
| 521 | return 8; |
| 522 | case IP_PROTOCOL_TCP: |
| 523 | return 20; |
| 524 | default: /* Caller is responsible for validating the length of terminating |
| 525 | protocols */ |
| 526 | ; |
| 527 | } |
| 528 | return 0; |
| 529 | } |
| 530 | |
Shwetha | b78292e | 2016-09-13 11:51:00 +0100 | [diff] [blame] | 531 | always_inline void * |
Klement Sekera | 769145c | 2019-03-06 11:59:57 +0100 | [diff] [blame] | 532 | ip6_ext_next_header (ip6_ext_header_t * ext_hdr) |
| 533 | { |
| 534 | return (void *) ((u8 *) ext_hdr + ip6_ext_header_len (ext_hdr)); |
Pablo Camarillo | fb38095 | 2016-12-07 18:34:18 +0100 | [diff] [blame] | 535 | } |
| 536 | |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 537 | always_inline void * |
| 538 | ip6_ext_next_header_offset (void *hdr, u16 offset) |
| 539 | { |
| 540 | return (hdr + offset); |
| 541 | } |
| 542 | |
Klement Sekera | 769145c | 2019-03-06 11:59:57 +0100 | [diff] [blame] | 543 | always_inline int |
| 544 | vlib_object_within_buffer_data (vlib_main_t * vm, vlib_buffer_t * b, |
| 545 | void *obj, size_t len) |
| 546 | { |
| 547 | u8 *o = obj; |
| 548 | if (o < b->data || |
| 549 | o + len > b->data + vlib_buffer_get_default_data_size (vm)) |
| 550 | return 0; |
| 551 | return 1; |
| 552 | } |
Pablo Camarillo | fb38095 | 2016-12-07 18:34:18 +0100 | [diff] [blame] | 553 | |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 554 | /* Returns the number of bytes left in buffer from p. */ |
| 555 | static inline u32 |
| 556 | vlib_bytes_left_in_buffer (vlib_buffer_t *b, void *obj) |
Klement Sekera | 769145c | 2019-03-06 11:59:57 +0100 | [diff] [blame] | 557 | { |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 558 | return b->current_length - (((u8 *) obj - b->data) - b->current_data); |
| 559 | } |
| 560 | |
| 561 | always_inline void * |
| 562 | ip6_ext_next_header_s (ip_protocol_t cur_nh, void *hdr, u32 max_offset, |
| 563 | u32 *offset, int *res_nh, bool *last) |
| 564 | { |
| 565 | u16 hdrlen = 0; |
| 566 | int new_nh = -1; |
| 567 | void *res = 0; |
| 568 | if (ip6_ext_hdr (cur_nh)) |
Klement Sekera | 769145c | 2019-03-06 11:59:57 +0100 | [diff] [blame] | 569 | { |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 570 | hdrlen = ip6_ext_header_len (hdr); |
| 571 | new_nh = ((ip6_ext_header_t *) hdr)->next_hdr; |
| 572 | res = hdr + hdrlen; |
| 573 | } |
| 574 | else if (cur_nh == IP_PROTOCOL_IPV6_FRAGMENTATION) |
| 575 | { |
| 576 | ip6_frag_hdr_t *frag_hdr = (ip6_frag_hdr_t *) hdr; |
| 577 | if (ip6_frag_hdr_offset (frag_hdr) > 0) |
| 578 | *last = true; |
| 579 | new_nh = frag_hdr->next_hdr; |
| 580 | hdrlen = sizeof (ip6_frag_hdr_t); |
| 581 | res = hdr + hdrlen; |
| 582 | } |
| 583 | else if (cur_nh == IP_PROTOCOL_IPSEC_AH) |
| 584 | { |
| 585 | new_nh = ((ip6_ext_header_t *) hdr)->next_hdr; |
| 586 | hdrlen = ip6_ext_authhdr_len (hdr); |
| 587 | res = hdr + hdrlen; |
Klement Sekera | 769145c | 2019-03-06 11:59:57 +0100 | [diff] [blame] | 588 | } |
| 589 | else |
| 590 | { |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 591 | ; |
Klement Sekera | 769145c | 2019-03-06 11:59:57 +0100 | [diff] [blame] | 592 | } |
Klement Sekera | 769145c | 2019-03-06 11:59:57 +0100 | [diff] [blame] | 593 | |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 594 | if (res && (*offset + hdrlen) >= max_offset) |
Klement Sekera | f126e74 | 2019-10-10 09:46:06 +0000 | [diff] [blame] | 595 | { |
Klement Sekera | f126e74 | 2019-10-10 09:46:06 +0000 | [diff] [blame] | 596 | return 0; |
| 597 | } |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 598 | *res_nh = new_nh; |
| 599 | *offset += hdrlen; |
| 600 | return res; |
| 601 | } |
| 602 | |
| 603 | #define IP6_EXT_HDR_MAX (4) /* Maximum number of headers */ |
| 604 | #define IP6_EXT_HDR_MAX_DEPTH (256) /* Maximum header depth */ |
| 605 | typedef struct |
| 606 | { |
| 607 | int length; |
| 608 | struct |
| 609 | { |
| 610 | u16 protocol; |
| 611 | u16 offset; |
| 612 | } eh[IP6_EXT_HDR_MAX]; |
| 613 | } ip6_ext_hdr_chain_t; |
| 614 | |
| 615 | /* |
Ole Troan | de3648d | 2022-01-11 16:08:23 +0100 | [diff] [blame] | 616 | * Find ipv6 extension header within ipv6 header within |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 617 | * whichever is smallest of buffer or IP6_EXT_HDR_MAX_DEPTH. |
| 618 | * The complete header chain must be in first buffer. |
| 619 | * |
| 620 | * The complete header chain (up to the terminating header) is |
| 621 | * returned in res. |
| 622 | * Returns the index of the find_hdr_type if > 0. Otherwise |
| 623 | * it returns the index of the last header. |
| 624 | */ |
| 625 | always_inline int |
| 626 | ip6_ext_header_walk (vlib_buffer_t *b, ip6_header_t *ip, int find_hdr_type, |
| 627 | ip6_ext_hdr_chain_t *res) |
| 628 | { |
| 629 | int i = 0; |
| 630 | int found = -1; |
| 631 | void *next_header = ip6_next_header (ip); |
| 632 | int next_proto = ip->protocol; |
| 633 | res->length = 0; |
| 634 | u32 n_bytes_this_buffer = |
| 635 | clib_min (vlib_bytes_left_in_buffer (b, ip), IP6_EXT_HDR_MAX_DEPTH); |
| 636 | u32 max_offset = clib_min (n_bytes_this_buffer, |
| 637 | sizeof (ip6_header_t) + |
| 638 | clib_net_to_host_u16 (ip->payload_length)); |
| 639 | u32 offset = sizeof (ip6_header_t); |
| 640 | if ((ip6_ext_header_len_s (ip->protocol, next_header) + offset) > max_offset) |
Klement Sekera | f126e74 | 2019-10-10 09:46:06 +0000 | [diff] [blame] | 641 | { |
| 642 | return -1; |
| 643 | } |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 644 | bool last = false; |
| 645 | while (next_header) |
Klement Sekera | f126e74 | 2019-10-10 09:46:06 +0000 | [diff] [blame] | 646 | { |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 647 | /* Move on to next header */ |
| 648 | res->eh[i].offset = offset; |
| 649 | res->eh[i].protocol = next_proto; |
| 650 | if (next_proto == find_hdr_type) |
| 651 | found = i; |
| 652 | i++; |
| 653 | if (last) |
| 654 | break; |
| 655 | if (i > IP6_EXT_HDR_MAX) |
| 656 | break; |
| 657 | next_header = ip6_ext_next_header_s (next_proto, next_header, max_offset, |
| 658 | &offset, &next_proto, &last); |
Klement Sekera | f126e74 | 2019-10-10 09:46:06 +0000 | [diff] [blame] | 659 | } |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 660 | res->length = i; |
| 661 | if (find_hdr_type < 0) |
Ole Troan | de3648d | 2022-01-11 16:08:23 +0100 | [diff] [blame] | 662 | return i - 1; |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 663 | return found != -1 ? found : i - 1; |
| 664 | } |
| 665 | |
| 666 | always_inline void * |
| 667 | ip6_ext_header_find (vlib_main_t *vm, vlib_buffer_t *b, ip6_header_t *ip, |
| 668 | int find_hdr_type, ip6_ext_header_t **prev_ext_header) |
| 669 | { |
| 670 | ip6_ext_hdr_chain_t hdr_chain; |
| 671 | int res = ip6_ext_header_walk (b, ip, find_hdr_type, &hdr_chain); |
| 672 | if (res < 0) |
| 673 | return 0; |
| 674 | |
| 675 | if (prev_ext_header) |
| 676 | { |
| 677 | if (res > 0) |
Klement Sekera | f126e74 | 2019-10-10 09:46:06 +0000 | [diff] [blame] | 678 | { |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 679 | *prev_ext_header = |
| 680 | ip6_ext_next_header_offset (ip, hdr_chain.eh[res - 1].offset); |
Klement Sekera | f126e74 | 2019-10-10 09:46:06 +0000 | [diff] [blame] | 681 | } |
| 682 | else |
| 683 | { |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 684 | *prev_ext_header = 0; |
Klement Sekera | f126e74 | 2019-10-10 09:46:06 +0000 | [diff] [blame] | 685 | } |
Klement Sekera | f126e74 | 2019-10-10 09:46:06 +0000 | [diff] [blame] | 686 | } |
Ole Troan | 03092c1 | 2021-11-23 15:55:39 +0100 | [diff] [blame] | 687 | if (find_hdr_type == hdr_chain.eh[res].protocol) |
| 688 | return ip6_ext_next_header_offset (ip, hdr_chain.eh[res].offset); |
Klement Sekera | f126e74 | 2019-10-10 09:46:06 +0000 | [diff] [blame] | 689 | return 0; |
| 690 | } |
| 691 | |
Ed Warnicke | cb9cada | 2015-12-08 15:45:58 -0700 | [diff] [blame] | 692 | #endif /* included_ip6_packet_h */ |
Dave Barach | d7cb1b5 | 2016-12-09 09:52:16 -0500 | [diff] [blame] | 693 | |
| 694 | /* |
| 695 | * fd.io coding-style-patch-verification: ON |
| 696 | * |
| 697 | * Local Variables: |
| 698 | * eval: (c-set-style "gnu") |
| 699 | * End: |
| 700 | */ |