src/vnet/ip/ip6_packet.h

   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
  43 #include <vnet/tcp/tcp_packet.h>
  44 #include <vnet/ip/ip4_packet.h>
  45
  46 typedef union
  47 {
  48   u8 as_u8[16];
  49   u16 as_u16[8];
  50   u32 as_u32[4];
  51   u64 as_u64[2];
  52   uword as_uword[16 / sizeof (uword)];
  53 }
  54 ip6_address_t;
  55
  56 /* Packed so that the mhash key doesn't include uninitialized pad bytes */
  57 /* *INDENT-OFF* */
  58 typedef CLIB_PACKED (struct {
  59   /* IP address must be first for ip_interface_address_get_address() to work */
  60   ip6_address_t ip6_addr;
  61   u32 fib_index;
  62 }) ip6_address_fib_t;
  63 /* *INDENT-ON* */
  64
  65 /* *INDENT-OFF* */
  66 typedef CLIB_PACKED (union {
  67   struct {
  68     u32 pad[3];
  69     ip4_address_t ip4;
  70   };
  71   ip6_address_t ip6;
  72   u8 as_u8[16];
  73   u64 as_u64[2];
  74 }) ip46_address_t;
  75 /* *INDENT-ON* */
  76 #define ip46_address_is_ip4(ip46)       (((ip46)->pad[0] | (ip46)->pad[1] | (ip46)->pad[2]) == 0)
  77 #define ip46_address_mask_ip4(ip46)     ((ip46)->pad[0] = (ip46)->pad[1] = (ip46)->pad[2] = 0)
  78 #define ip46_address_set_ip4(ip46, ip)  (ip46_address_mask_ip4(ip46), (ip46)->ip4 = (ip)[0])
  79 #define ip46_address_reset(ip46)        ((ip46)->as_u64[0] = (ip46)->as_u64[1] = 0)
  80 #define ip46_address_cmp(ip46_1, ip46_2) (memcmp(ip46_1, ip46_2, sizeof(*ip46_1)))
  81 #define ip46_address_is_zero(ip46)      (((ip46)->as_u64[0] == 0) && ((ip46)->as_u64[1] == 0))
  82 #define ip46_address_is_equal(a1, a2)   (((a1)->as_u64[0] == (a2)->as_u64[0]) \
  83                                          && ((a1)->as_u64[1] == (a2)->as_u64[1]))
  84
  85 always_inline ip46_address_t
  86 to_ip46 (u32 is_ipv6, u8 * buf)
  87 {
  88   ip46_address_t ip;
  89   if (is_ipv6)
  90     ip.ip6 = *((ip6_address_t *) buf);
  91   else
  92     ip46_address_set_ip4 (&ip, (ip4_address_t *) buf);
  93   return ip;
  94 }
  95
  96
  97 always_inline void
  98 ip6_addr_fib_init (ip6_address_fib_t * addr_fib, ip6_address_t * address,
  99                    u32 fib_index)
 100 {
 101   addr_fib->ip6_addr = *address;
 102   addr_fib->fib_index = fib_index;
 103 }
 104
 105 /* Special addresses:
 106    unspecified          ::/128
 107    loopback             ::1/128
 108    global unicast       2000::/3
 109    unique local unicast fc00::/7
 110    link local unicast   fe80::/10
 111    multicast            ff00::/8
 112    ietf reserved        everything else. */
 113
 114 #define foreach_ip6_multicast_address_scope     \
 115   _ (loopback, 0x1)                             \
 116   _ (link_local, 0x2)                           \
 117   _ (admin_local, 0x4)                          \
 118   _ (site_local, 0x5)                           \
 119   _ (organization_local, 0x8)                   \
 120   _ (global, 0xe)
 121
 122 #define foreach_ip6_multicast_link_local_group_id       \
 123   _ (all_hosts, 0x1)                                    \
 124   _ (all_routers, 0x2)                                  \
 125   _ (rip_routers, 0x9)                                  \
 126   _ (eigrp_routers, 0xa)                                \
 127   _ (pim_routers, 0xd)                            \
 128  _ (mldv2_routers, 0x16)
 129
 130 typedef enum
 131 {
 132 #define _(f,n) IP6_MULTICAST_SCOPE_##f = n,
 133   foreach_ip6_multicast_address_scope
 134 #undef _
 135 } ip6_multicast_address_scope_t;
 136
 137 typedef enum
 138 {
 139 #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n,
 140   foreach_ip6_multicast_link_local_group_id
 141 #undef _
 142 } ip6_multicast_link_local_group_id_t;
 143
 144 always_inline uword
 145 ip6_address_is_multicast (ip6_address_t * a)
 146 {
 147   return a->as_u8[0] == 0xff;
 148 }
 149
 150 always_inline uword
 151 ip46_address_is_multicast (ip46_address_t * a)
 152 {
 153   return ip46_address_is_ip4 (a) ? ip4_address_is_multicast (&a->ip4) :
 154     ip6_address_is_multicast (&a->ip6);
 155 }
 156
 157 always_inline void
 158 ip6_set_reserved_multicast_address (ip6_address_t * a,
 159                                     ip6_multicast_address_scope_t scope,
 160                                     u16 id)
 161 {
 162   a->as_u64[0] = a->as_u64[1] = 0;
 163   a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope);
 164   a->as_u16[7] = clib_host_to_net_u16 (id);
 165 }
 166
 167 always_inline void
 168 ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
 169 {
 170   /* 0xff02::1:ffXX:XXXX. */
 171   a->as_u64[0] = a->as_u64[1] = 0;
 172   a->as_u16[0] = clib_host_to_net_u16 (0xff02);
 173   a->as_u8[11] = 1;
 174   ASSERT ((id >> 24) == 0);
 175   id |= 0xff << 24;
 176   a->as_u32[3] = clib_host_to_net_u32 (id);
 177 }
 178
 179 always_inline void
 180 ip6_link_local_address_from_ethernet_address (ip6_address_t * a,
 181                                               u8 * ethernet_address)
 182 {
 183   a->as_u64[0] = a->as_u64[1] = 0;
 184   a->as_u16[0] = clib_host_to_net_u16 (0xfe80);
 185   /* Always set locally administered bit (6). */
 186   a->as_u8[0x8] = ethernet_address[0] | (1 << 6);
 187   a->as_u8[0x9] = ethernet_address[1];
 188   a->as_u8[0xa] = ethernet_address[2];
 189   a->as_u8[0xb] = 0xff;
 190   a->as_u8[0xc] = 0xfe;
 191   a->as_u8[0xd] = ethernet_address[3];
 192   a->as_u8[0xe] = ethernet_address[4];
 193   a->as_u8[0xf] = ethernet_address[5];
 194 }
 195
 196 always_inline void
 197 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
 198 {
 199   ethernet_address[0] = 0x33;
 200   ethernet_address[1] = 0x33;
 201   ethernet_address[2] = ((group_id >> 24) & 0xff);
 202   ethernet_address[3] = ((group_id >> 16) & 0xff);
 203   ethernet_address[4] = ((group_id >> 8) & 0xff);
 204   ethernet_address[5] = ((group_id >> 0) & 0xff);
 205 }
 206
 207 always_inline uword
 208 ip6_address_is_equal (ip6_address_t * a, ip6_address_t * b)
 209 {
 210   int i;
 211   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
 212     if (a->as_uword[i] != b->as_uword[i])
 213       return 0;
 214   return 1;
 215 }
 216
 217 always_inline uword
 218 ip6_address_is_equal_masked (ip6_address_t * a, ip6_address_t * b,
 219                              ip6_address_t * mask)
 220 {
 221   int i;
 222   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
 223     {
 224       uword a_masked, b_masked;
 225       a_masked = a->as_uword[i] & mask->as_uword[i];
 226       b_masked = b->as_uword[i] & mask->as_uword[i];
 227
 228       if (a_masked != b_masked)
 229         return 0;
 230     }
 231   return 1;
 232 }
 233
 234 always_inline void
 235 ip6_address_mask (ip6_address_t * a, ip6_address_t * mask)
 236 {
 237   int i;
 238   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
 239     a->as_uword[i] &= mask->as_uword[i];
 240 }
 241
 242 always_inline void
 243 ip6_address_set_zero (ip6_address_t * a)
 244 {
 245   int i;
 246   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
 247     a->as_uword[i] = 0;
 248 }
 249
 250 always_inline void
 251 ip6_address_mask_from_width (ip6_address_t * a, u32 width)
 252 {
 253   int i, byte, bit, bitnum;
 254   ASSERT (width <= 128);
 255   memset (a, 0, sizeof (a[0]));
 256   for (i = 0; i < width; i++)
 257     {
 258       bitnum = (7 - (i & 7));
 259       byte = i / 8;
 260       bit = 1 << bitnum;
 261       a->as_u8[byte] |= bit;
 262     }
 263 }
 264
 265 always_inline uword
 266 ip6_address_is_zero (ip6_address_t * a)
 267 {
 268   int i;
 269   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
 270     if (a->as_uword[i] != 0)
 271       return 0;
 272   return 1;
 273 }
 274
 275 /* Check for unspecified address ::0 */
 276 always_inline uword
 277 ip6_address_is_unspecified (ip6_address_t * a)
 278 {
 279   return ip6_address_is_zero (a);
 280 }
 281
 282 /* Check for loopback address ::1 */
 283 always_inline uword
 284 ip6_address_is_loopback (ip6_address_t * a)
 285 {
 286   uword is_loopback;
 287   u8 save = a->as_u8[15];
 288   a->as_u8[15] = save ^ 1;
 289   is_loopback = ip6_address_is_zero (a);
 290   a->as_u8[15] = save;
 291   return is_loopback;
 292 }
 293
 294 /* Check for link local unicast fe80::/10. */
 295 always_inline uword
 296 ip6_address_is_link_local_unicast (const ip6_address_t * a)
 297 {
 298   return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80;
 299 }
 300
 301 /* Check for unique local unicast fc00::/7. */
 302 always_inline uword
 303 ip6_address_is_local_unicast (ip6_address_t * a)
 304 {
 305   return (a->as_u8[0] & 0xfe) == 0xfc;
 306 }
 307
 308 /* Check for unique global unicast 2000::/3. */
 309 always_inline uword
 310 ip6_address_is_global_unicast (ip6_address_t * a)
 311 {
 312   return (a->as_u8[0] & 0xe0) == 0x20;
 313 }
 314
 315 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
 316 always_inline uword
 317 ip6_is_solicited_node_multicast_address (ip6_address_t * a)
 318 {
 319   return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
 320           && a->as_u32[1] == 0
 321           && a->as_u32[2] == clib_host_to_net_u32 (1)
 322           && a->as_u8[12] == 0xff);
 323 }
 324
 325 typedef struct
 326 {
 327   /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
 328   u32 ip_version_traffic_class_and_flow_label;
 329
 330   /* Total packet length not including this header (but including
 331      any extension headers if present). */
 332   u16 payload_length;
 333
 334   /* Protocol for next header. */
 335   u8 protocol;
 336
 337   /* Hop limit decremented by router at each hop. */
 338   u8 hop_limit;
 339
 340   /* Source and destination address. */
 341   ip6_address_t src_address, dst_address;
 342 } ip6_header_t;
 343
 344 always_inline u8
 345 ip6_traffic_class (const ip6_header_t * i)
 346 {
 347   return (i->ip_version_traffic_class_and_flow_label & 0x0FF00000) >> 20;
 348 }
 349
 350 static_always_inline u8
 351 ip6_traffic_class_network_order (const ip6_header_t * ip6)
 352 {
 353   return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
 354           & 0x0ff00000) >> 20;
 355 }
 356
 357 static_always_inline void
 358 ip6_set_traffic_class_network_order (ip6_header_t * ip6, u8 dscp)
 359 {
 360   u32 tmp =
 361     clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
 362   tmp |= (dscp << 20);
 363   ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
 364 }
 365
 366 always_inline void *
 367 ip6_next_header (ip6_header_t * i)
 368 {
 369   return (void *) (i + 1);
 370 }
 371
 372 always_inline void
 373 ip6_copy_header (ip6_header_t * dst, const ip6_header_t * src)
 374 {
 375   dst->ip_version_traffic_class_and_flow_label =
 376     src->ip_version_traffic_class_and_flow_label;
 377   dst->payload_length = src->payload_length;
 378   dst->protocol = src->protocol;
 379   dst->hop_limit = src->hop_limit;
 380
 381   dst->src_address.as_uword[0] = src->src_address.as_uword[0];
 382   dst->src_address.as_uword[1] = src->src_address.as_uword[1];
 383   dst->dst_address.as_uword[0] = src->dst_address.as_uword[0];
 384   dst->dst_address.as_uword[1] = src->dst_address.as_uword[1];
 385 }
 386
 387 always_inline void
 388 ip6_tcp_reply_x1 (ip6_header_t * ip0, tcp_header_t * tcp0)
 389 {
 390   {
 391     ip6_address_t src0, dst0;
 392
 393     src0 = ip0->src_address;
 394     dst0 = ip0->dst_address;
 395     ip0->src_address = dst0;
 396     ip0->dst_address = src0;
 397   }
 398
 399   {
 400     u16 src0, dst0;
 401
 402     src0 = tcp0->src;
 403     dst0 = tcp0->dst;
 404     tcp0->src = dst0;
 405     tcp0->dst = src0;
 406   }
 407 }
 408
 409 always_inline void
 410 ip6_tcp_reply_x2 (ip6_header_t * ip0, ip6_header_t * ip1,
 411                   tcp_header_t * tcp0, tcp_header_t * tcp1)
 412 {
 413   {
 414     ip6_address_t src0, dst0, src1, dst1;
 415
 416     src0 = ip0->src_address;
 417     src1 = ip1->src_address;
 418     dst0 = ip0->dst_address;
 419     dst1 = ip1->dst_address;
 420     ip0->src_address = dst0;
 421     ip1->src_address = dst1;
 422     ip0->dst_address = src0;
 423     ip1->dst_address = src1;
 424   }
 425
 426   {
 427     u16 src0, dst0, src1, dst1;
 428
 429     src0 = tcp0->src;
 430     src1 = tcp1->src;
 431     dst0 = tcp0->dst;
 432     dst1 = tcp1->dst;
 433     tcp0->src = dst0;
 434     tcp1->src = dst1;
 435     tcp0->dst = src0;
 436     tcp1->dst = src1;
 437   }
 438 }
 439
 440
 441 /* *INDENT-OFF* */
 442 typedef CLIB_PACKED (struct {
 443   u8 data;
 444 }) ip6_pad1_option_t;
 445 /* *INDENT-ON* */
 446
 447 /* *INDENT-OFF* */
 448 typedef CLIB_PACKED (struct {
 449   u8 type;
 450   u8 len;
 451   u8 data[0];
 452 }) ip6_padN_option_t;
 453 /* *INDENT-ON* */
 454
 455 /* *INDENT-OFF* */
 456 typedef CLIB_PACKED (struct {
 457 #define IP6_MLDP_ALERT_TYPE  0x5
 458   u8 type;
 459   u8 len;
 460   u16 value;
 461 }) ip6_router_alert_option_t;
 462 /* *INDENT-ON* */
 463
 464 /* *INDENT-OFF* */
 465 typedef CLIB_PACKED (struct {
 466   u8 next_hdr;
 467   /* Length of this header plus option data in 8 byte units. */
 468   u8 n_data_u64s;
 469 }) ip6_ext_header_t;
 470
 471 always_inline u8 ip6_ext_hdr(u8 nexthdr)
 472 {
 473   /*
 474    * find out if nexthdr is an extension header or a protocol
 475    */
 476   return   (nexthdr == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS) ||
 477     (nexthdr == IP_PROTOCOL_IPV6_FRAGMENTATION)  ||
 478     (nexthdr == IP_PROTOCOL_IPSEC_AH)      ||
 479     (nexthdr == IP_PROTOCOL_IPV6_ROUTE)      ||
 480     (nexthdr == IP_PROTOCOL_IP6_DESTINATION_OPTIONS);
 481 }
 482
 483 #define ip6_ext_header_len(p)  ((((ip6_ext_header_t *)(p))->n_data_u64s+1) << 3)
 484 #define ip6_ext_authhdr_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+2) << 2)
 485
 486 always_inline void *
 487 ip6_ext_next_header (ip6_ext_header_t *ext_hdr )
 488 { return (void *)((u8 *) ext_hdr + ip6_ext_header_len(ext_hdr)); }
 489
 490 /*
 491  * Macro to find the IPv6 ext header of type t
 492  * I is the IPv6 header
 493  * P is the previous IPv6 ext header (NULL if none)
 494  * M is the matched IPv6 ext header of type t
 495  */
 496 #define ip6_ext_header_find_t(i, p, m, t)               \
 497 if ((i)->protocol == t)                                 \
 498 {                                                       \
 499   (m) = (void *)((i)+1);                                \
 500   (p) = NULL;                                           \
 501 }                                                       \
 502 else                                                    \
 503 {                                                       \
 504   (m) = NULL;                                           \
 505   (p) = (void *)((i)+1);                                \
 506   while (ip6_ext_hdr((p)->next_hdr) &&                  \
 507     ((ip6_ext_header_t *)(p))->next_hdr != (t))         \
 508   {                                                     \
 509     (p) = ip6_ext_next_header((p));                     \
 510   }                                                     \
 511   if ( ((p)->next_hdr) == (t))                          \
 512   {                                                     \
 513     (m) = (void *)(ip6_ext_next_header((p)));           \
 514   }                                                     \
 515 }
 516
 517
 518 typedef CLIB_PACKED (struct {
 519   u8 next_hdr;
 520   /* Length of this header plus option data in 8 byte units. */
 521   u8 n_data_u64s;
 522   u8 data[0];
 523 }) ip6_hop_by_hop_ext_t;
 524 /* *INDENT-ON* */
 525
 526 /* *INDENT-OFF* */
 527 typedef CLIB_PACKED (struct {
 528   u8 next_hdr;
 529   u8 rsv;
 530   u16 fragment_offset_and_more;
 531   u32 identification;
 532 }) ip6_frag_hdr_t;
 533 /* *INDENT-ON* */
 534
 535 #define ip6_frag_hdr_offset(hdr) \
 536   (clib_net_to_host_u16((hdr)->fragment_offset_and_more) >> 3)
 537
 538 #define ip6_frag_hdr_offset_bytes(hdr) \
 539   (8 * ip6_frag_hdr_offset(hdr))
 540
 541 #define ip6_frag_hdr_more(hdr) \
 542   (clib_net_to_host_u16((hdr)->fragment_offset_and_more) & 0x1)
 543
 544 #define ip6_frag_hdr_offset_and_more(offset, more) \
 545   clib_host_to_net_u16(((offset) << 3) + !!(more))
 546
 547 #endif /* included_ip6_packet_h */
 548
 549 /*
 550  * fd.io coding-style-patch-verification: ON
 551  *
 552  * Local Variables:
 553  * eval: (c-set-style "gnu")
 554  * End:
 555  */