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