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