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