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