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