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