src/vnet/ip/ip6.h

   1 /*
   2  * Copyright (c) 2016 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  * ip/ip6.h: ip6 main include file
  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_ip_ip6_h
  41 #define included_ip_ip6_h
  42
  43 #include <vlib/mc.h>
  44 #include <vlib/buffer.h>
  45 #include <vnet/ethernet/packet.h>
  46 #include <vnet/ip/ip6_packet.h>
  47 #include <vnet/ip/ip6_hop_by_hop_packet.h>
  48 #include <vnet/ip/lookup.h>
  49 #include <stdbool.h>
  50 #include <vppinfra/bihash_24_8.h>
  51 #include <vppinfra/bihash_template.h>
  52 #include <vnet/util/radix.h>
  53
  54 /*
  55  * Default size of the ip6 fib hash table
  56  */
  57 #define IP6_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
  58 #define IP6_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
  59
  60 typedef struct
  61 {
  62   ip6_address_t addr;
  63   u32 dst_address_length;
  64   u32 vrf_index;
  65 } ip6_fib_key_t;
  66
  67 typedef struct
  68 {
  69   /* Table ID (hash key) for this FIB. */
  70   u32 table_id;
  71
  72   /* Index into FIB vector. */
  73   u32 index;
  74 } ip6_fib_t;
  75
  76 typedef struct ip6_mfib_t
  77 {
  78   /* Table ID (hash key) for this FIB. */
  79   u32 table_id;
  80
  81   /* Index into FIB vector. */
  82   u32 index;
  83
  84   /*
  85    *  Pointer to the top of a radix tree.
  86    * This cannot be realloc'd, hence it cannot be inlined with this table
  87    */
  88   struct radix_node_head *rhead;
  89 } ip6_mfib_t;
  90
  91 struct ip6_main_t;
  92
  93 typedef void (ip6_add_del_interface_address_function_t)
  94   (struct ip6_main_t * im,
  95    uword opaque,
  96    u32 sw_if_index,
  97    ip6_address_t * address,
  98    u32 address_length, u32 if_address_index, u32 is_del);
  99
 100 typedef struct
 101 {
 102   ip6_add_del_interface_address_function_t *function;
 103   uword function_opaque;
 104 } ip6_add_del_interface_address_callback_t;
 105
 106 /**
 107  * Enumeration of the FIB table instance types
 108  */
 109 typedef enum ip6_fib_table_instance_type_t_
 110 {
 111     /**
 112      * This table stores the routes that are used to forward traffic.
 113      * The key is the prefix, the result the adjacnecy to forward on.
 114      */
 115   IP6_FIB_TABLE_FWDING,
 116     /**
 117      * The table that stores ALL routes learned by the DP.
 118      * Some of these routes may not be ready to install in forwarding
 119      * at a given time.
 120      * The key in this table is the prefix, the result is the fib_entry_t
 121      */
 122   IP6_FIB_TABLE_NON_FWDING,
 123 } ip6_fib_table_instance_type_t;
 124
 125 #define IP6_FIB_NUM_TABLES (IP6_FIB_TABLE_NON_FWDING+1)
 126
 127 /**
 128  * A represenation of a single IP6 table
 129  */
 130 typedef struct ip6_fib_table_instance_t_
 131 {
 132   /* The hash table */
 133   BVT (clib_bihash) ip6_hash;
 134
 135   /* bitmap / refcounts / vector of mask widths to search */
 136   uword *non_empty_dst_address_length_bitmap;
 137   u8 *prefix_lengths_in_search_order;
 138   i32 dst_address_length_refcounts[129];
 139 } ip6_fib_table_instance_t;
 140
 141 typedef struct ip6_main_t
 142 {
 143   /**
 144    * The two FIB tables; fwding and non-fwding
 145    */
 146   ip6_fib_table_instance_t ip6_table[IP6_FIB_NUM_TABLES];
 147
 148   ip_lookup_main_t lookup_main;
 149
 150   /* Pool of FIBs. */
 151   struct fib_table_t_ *fibs;
 152
 153   /* Pool of V6 FIBs. */
 154   ip6_fib_t *v6_fibs;
 155
 156   /** Vector of MFIBs. */
 157   struct mfib_table_t_ *mfibs;
 158
 159   /* Network byte orders subnet mask for each prefix length */
 160   ip6_address_t fib_masks[129];
 161
 162   /* Table index indexed by software interface. */
 163   u32 *fib_index_by_sw_if_index;
 164
 165   /** Table index indexed by software interface. */
 166   u32 *mfib_index_by_sw_if_index;
 167
 168   /* IP6 enabled count by software interface */
 169   u8 *ip_enabled_by_sw_if_index;
 170
 171   /* Hash table mapping table id to fib index.
 172      ID space is not necessarily dense; index space is dense. */
 173   uword *fib_index_by_table_id;
 174
 175   /** Hash table mapping table id to multicast fib index.
 176      ID space is not necessarily dense; index space is dense. */
 177   uword *mfib_index_by_table_id;
 178
 179   /* Hash table mapping interface rewrite adjacency index by sw if index. */
 180   uword *interface_route_adj_index_by_sw_if_index;
 181
 182   /* Functions to call when interface address changes. */
 183     ip6_add_del_interface_address_callback_t
 184     * add_del_interface_address_callbacks;
 185
 186   /* Template used to generate IP6 neighbor solicitation packets. */
 187   vlib_packet_template_t discover_neighbor_packet_template;
 188
 189   /* ip6 lookup table config parameters */
 190   u32 lookup_table_nbuckets;
 191   uword lookup_table_size;
 192
 193   /* Seed for Jenkins hash used to compute ip6 flow hash. */
 194   u32 flow_hash_seed;
 195
 196   struct
 197   {
 198     /* TTL to use for host generated packets. */
 199     u8 ttl;
 200
 201     u8 pad[3];
 202   } host_config;
 203
 204   /* HBH processing enabled? */
 205   u8 hbh_enabled;
 206 } ip6_main_t;
 207
 208 /* Global ip6 main structure. */
 209 extern ip6_main_t ip6_main;
 210
 211 /* Global ip6 input node.  Errors get attached to ip6 input node. */
 212 extern vlib_node_registration_t ip6_input_node;
 213 extern vlib_node_registration_t ip6_rewrite_node;
 214 extern vlib_node_registration_t ip6_rewrite_mcast_node;
 215 extern vlib_node_registration_t ip6_rewrite_local_node;
 216 extern vlib_node_registration_t ip6_discover_neighbor_node;
 217 extern vlib_node_registration_t ip6_glean_node;
 218 extern vlib_node_registration_t ip6_midchain_node;
 219
 220 always_inline uword
 221 ip6_destination_matches_route (const ip6_main_t * im,
 222                                const ip6_address_t * key,
 223                                const ip6_address_t * dest, uword dest_length)
 224 {
 225   int i;
 226   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
 227     {
 228       if ((key->as_uword[i] ^ dest->as_uword[i]) & im->
 229           fib_masks[dest_length].as_uword[i])
 230         return 0;
 231     }
 232   return 1;
 233 }
 234
 235 always_inline uword
 236 ip6_destination_matches_interface (ip6_main_t * im,
 237                                    ip6_address_t * key,
 238                                    ip_interface_address_t * ia)
 239 {
 240   ip6_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
 241   return ip6_destination_matches_route (im, key, a, ia->address_length);
 242 }
 243
 244 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
 245 always_inline uword
 246 ip6_unaligned_destination_matches_route (ip6_main_t * im,
 247                                          ip6_address_t * key,
 248                                          ip6_address_t * dest,
 249                                          uword dest_length)
 250 {
 251   int i;
 252   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
 253     {
 254       if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i])
 255           & im->fib_masks[dest_length].as_uword[i])
 256         return 0;
 257     }
 258   return 1;
 259 }
 260
 261 always_inline int
 262 ip6_src_address_for_packet (ip_lookup_main_t * lm,
 263                             u32 sw_if_index, ip6_address_t * src)
 264 {
 265   u32 if_add_index = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
 266   if (PREDICT_TRUE (if_add_index != ~0))
 267     {
 268       ip_interface_address_t *if_add =
 269         pool_elt_at_index (lm->if_address_pool, if_add_index);
 270       ip6_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
 271       *src = *if_ip;
 272       return (0);
 273     }
 274   else
 275     {
 276       src->as_u64[0] = 0;
 277       src->as_u64[1] = 0;
 278     }
 279   return (!0);
 280 }
 281
 282 /* Find interface address which matches destination. */
 283 always_inline ip6_address_t *
 284 ip6_interface_address_matching_destination (ip6_main_t * im,
 285                                             ip6_address_t * dst,
 286                                             u32 sw_if_index,
 287                                             ip_interface_address_t **
 288                                             result_ia)
 289 {
 290   ip_lookup_main_t *lm = &im->lookup_main;
 291   ip_interface_address_t *ia;
 292   ip6_address_t *result = 0;
 293
 294   /* *INDENT-OFF* */
 295   foreach_ip_interface_address (lm, ia, sw_if_index,
 296                                 1 /* honor unnumbered */,
 297   ({
 298     ip6_address_t * a = ip_interface_address_get_address (lm, ia);
 299     if (ip6_destination_matches_route (im, dst, a, ia->address_length))
 300       {
 301         result = a;
 302         break;
 303       }
 304   }));
 305   /* *INDENT-ON* */
 306   if (result_ia)
 307     *result_ia = result ? ia : 0;
 308   return result;
 309 }
 310
 311 clib_error_t *ip6_add_del_interface_address (vlib_main_t * vm,
 312                                              u32 sw_if_index,
 313                                              ip6_address_t * address,
 314                                              u32 address_length, u32 is_del);
 315 void ip6_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
 316
 317 /**
 318  * @brie get first IPv6 interface address
 319  */
 320 ip6_address_t *ip6_interface_first_address (ip6_main_t * im, u32 sw_if_index);
 321
 322 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
 323
 324 clib_error_t *ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst,
 325                                   u32 sw_if_index);
 326
 327 uword
 328 ip6_udp_register_listener (vlib_main_t * vm,
 329                            u16 dst_port, u32 next_node_index);
 330
 331 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
 332                                        ip6_header_t * ip0,
 333                                        int *bogus_lengthp);
 334
 335 void ip6_register_protocol (u32 protocol, u32 node_index);
 336
 337 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
 338
 339 void ip6_ethernet_update_adjacency (vnet_main_t * vnm,
 340                                     u32 sw_if_index, u32 ai);
 341
 342
 343 void
 344 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t * ip,
 345                                                   u8 * mac);
 346
 347 void
 348 ip6_ethernet_mac_address_from_link_local_address (u8 * mac,
 349                                                   ip6_address_t * ip);
 350
 351 int vnet_set_ip6_flow_hash (u32 table_id,
 352                             flow_hash_config_t flow_hash_config);
 353
 354 clib_error_t *enable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
 355
 356 clib_error_t *disable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
 357
 358 int ip6_interface_enabled (vlib_main_t * vm, u32 sw_if_index);
 359
 360 clib_error_t *set_ip6_link_local_address (vlib_main_t * vm,
 361                                           u32 sw_if_index,
 362                                           ip6_address_t * address);
 363
 364 int vnet_add_del_ip6_nd_change_event (vnet_main_t * vnm,
 365                                       void *data_callback,
 366                                       u32 pid,
 367                                       void *address_arg,
 368                                       uword node_index,
 369                                       uword type_opaque,
 370                                       uword data, int is_add);
 371
 372 int vnet_ip6_nd_term (vlib_main_t * vm,
 373                       vlib_node_runtime_t * node,
 374                       vlib_buffer_t * p0,
 375                       ethernet_header_t * eth,
 376                       ip6_header_t * ip, u32 sw_if_index, u16 bd_index);
 377
 378 void send_ip6_na (vlib_main_t * vm, vnet_hw_interface_t * hi);
 379
 380 u8 *format_ip6_forward_next_trace (u8 * s, va_list * args);
 381
 382 u32 ip6_tcp_udp_icmp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
 383
 384 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
 385                                  u32 table_index);
 386 extern vlib_node_registration_t ip6_lookup_node;
 387
 388 /* Compute flow hash.  We'll use it to select which Sponge to use for this
 389    flow.  And other things. */
 390 always_inline u32
 391 ip6_compute_flow_hash (const ip6_header_t * ip,
 392                        flow_hash_config_t flow_hash_config)
 393 {
 394   tcp_header_t *tcp;
 395   u64 a, b, c;
 396   u64 t1, t2;
 397   uword is_tcp_udp = 0;
 398   u8 protocol = ip->protocol;
 399
 400   if (PREDICT_TRUE
 401       ((ip->protocol == IP_PROTOCOL_TCP)
 402        || (ip->protocol == IP_PROTOCOL_UDP)))
 403     {
 404       is_tcp_udp = 1;
 405       tcp = (void *) (ip + 1);
 406     }
 407   else if (ip->protocol == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS)
 408     {
 409       ip6_hop_by_hop_header_t *hbh = (ip6_hop_by_hop_header_t *) (ip + 1);
 410       if ((hbh->protocol == IP_PROTOCOL_TCP) ||
 411           (hbh->protocol == IP_PROTOCOL_UDP))
 412         {
 413           is_tcp_udp = 1;
 414           tcp = (tcp_header_t *) ((u8 *) hbh + ((hbh->length + 1) << 3));
 415         }
 416       protocol = hbh->protocol;
 417     }
 418
 419   t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
 420   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
 421
 422   t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
 423   t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
 424
 425   a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
 426   b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
 427   b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? protocol : 0;
 428
 429   t1 = is_tcp_udp ? tcp->src : 0;
 430   t2 = is_tcp_udp ? tcp->dst : 0;
 431
 432   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
 433   t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
 434
 435   c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
 436     ((t1 << 16) | t2) : ((t2 << 16) | t1);
 437
 438   hash_mix64 (a, b, c);
 439   return (u32) c;
 440 }
 441
 442 /* ip6_locate_header
 443  *
 444  * This function is to search for the header specified by the protocol number
 445  * in find_hdr_type.
 446  * This is used to locate a specific IPv6 extension header
 447  * or to find transport layer header.
 448  *   1. If the find_hdr_type < 0 then it finds and returns the protocol number and
 449  *   offset stored in *offset of the transport or ESP header in the chain if
 450  *   found.
 451  *   2. If a header with find_hdr_type > 0 protocol number is found then the
 452  *      offset is stored in *offset and protocol number of the header is
 453  *      returned.
 454  *   3. If find_hdr_type is not found or packet is malformed or
 455  *      it is a non-first fragment -1 is returned.
 456  */
 457 always_inline int
 458 ip6_locate_header (vlib_buffer_t * p0,
 459                    ip6_header_t * ip0, int find_hdr_type, u32 * offset)
 460 {
 461   u8 next_proto = ip0->protocol;
 462   u8 *next_header;
 463   u8 done = 0;
 464   u32 cur_offset;
 465   u8 *temp_nxthdr = 0;
 466   u32 exthdr_len = 0;
 467
 468   next_header = ip6_next_header (ip0);
 469   cur_offset = sizeof (ip6_header_t);
 470   while (1)
 471     {
 472       done = (next_proto == find_hdr_type);
 473       if (PREDICT_FALSE
 474           (next_header >=
 475            (u8 *) vlib_buffer_get_current (p0) + p0->current_length))
 476         {
 477           //A malicious packet could set an extension header with a too big size
 478           return (-1);
 479         }
 480       if (done)
 481         break;
 482       if ((!ip6_ext_hdr (next_proto)) || next_proto == IP_PROTOCOL_IP6_NONXT)
 483         {
 484           if (find_hdr_type < 0)
 485             break;
 486           return -1;
 487         }
 488       if (next_proto == IP_PROTOCOL_IPV6_FRAGMENTATION)
 489         {
 490           ip6_frag_hdr_t *frag_hdr = (ip6_frag_hdr_t *) next_header;
 491           u16 frag_off = ip6_frag_hdr_offset (frag_hdr);
 492           /* Non first fragment return -1 */
 493           if (frag_off)
 494             return (-1);
 495           exthdr_len = sizeof (ip6_frag_hdr_t);
 496           temp_nxthdr = next_header + exthdr_len;
 497         }
 498       else if (next_proto == IP_PROTOCOL_IPSEC_AH)
 499         {
 500           exthdr_len =
 501             ip6_ext_authhdr_len (((ip6_ext_header_t *) next_header));
 502           temp_nxthdr = next_header + exthdr_len;
 503         }
 504       else
 505         {
 506           exthdr_len =
 507             ip6_ext_header_len (((ip6_ext_header_t *) next_header));
 508           temp_nxthdr = next_header + exthdr_len;
 509         }
 510       next_proto = ((ip6_ext_header_t *) next_header)->next_hdr;
 511       next_header = temp_nxthdr;
 512       cur_offset += exthdr_len;
 513     }
 514
 515   *offset = cur_offset;
 516   return (next_proto);
 517 }
 518
 519 u8 *format_ip6_hop_by_hop_ext_hdr (u8 * s, va_list * args);
 520 /*
 521  * Hop-by-Hop handling
 522  */
 523 typedef struct
 524 {
 525   /* Array of function pointers to HBH option handling routines */
 526   int (*options[256]) (vlib_buffer_t * b, ip6_header_t * ip,
 527                        ip6_hop_by_hop_option_t * opt);
 528   u8 *(*trace[256]) (u8 * s, ip6_hop_by_hop_option_t * opt);
 529   uword next_override;
 530 } ip6_hop_by_hop_main_t;
 531
 532 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
 533
 534 int ip6_hbh_register_option (u8 option,
 535                              int options (vlib_buffer_t * b,
 536                                           ip6_header_t * ip,
 537                                           ip6_hop_by_hop_option_t * opt),
 538                              u8 * trace (u8 * s,
 539                                          ip6_hop_by_hop_option_t * opt));
 540 int ip6_hbh_unregister_option (u8 option);
 541 void ip6_hbh_set_next_override (uword next);
 542
 543 /**
 544  * Push IPv6 header to buffer
 545  *
 546  * @param vm - vlib_main
 547  * @param b - buffer to write the header to
 548  * @param src - source IP
 549  * @param dst - destination IP
 550  * @param prot - payload proto
 551  *
 552  * @return - pointer to start of IP header
 553  */
 554 always_inline void *
 555 vlib_buffer_push_ip6 (vlib_main_t * vm, vlib_buffer_t * b,
 556                       ip6_address_t * src, ip6_address_t * dst, int proto)
 557 {
 558   ip6_header_t *ip6h;
 559   u16 payload_length;
 560
 561   /* make some room */
 562   ip6h = vlib_buffer_push_uninit (b, sizeof (ip6_header_t));
 563
 564   ip6h->ip_version_traffic_class_and_flow_label =
 565     clib_host_to_net_u32 (0x6 << 28);
 566
 567   /* calculate ip6 payload length */
 568   payload_length = vlib_buffer_length_in_chain (vm, b);
 569   payload_length -= sizeof (*ip6h);
 570
 571   ip6h->payload_length = clib_host_to_net_u16 (payload_length);
 572
 573   ip6h->hop_limit = 0xff;
 574   ip6h->protocol = proto;
 575   clib_memcpy (ip6h->src_address.as_u8, src->as_u8,
 576                sizeof (ip6h->src_address));
 577   clib_memcpy (ip6h->dst_address.as_u8, dst->as_u8,
 578                sizeof (ip6h->src_address));
 579   b->flags |= VNET_BUFFER_F_IS_IP6;
 580
 581   return ip6h;
 582 }
 583
 584 #endif /* included_ip_ip6_h */
 585
 586 /*
 587  * fd.io coding-style-patch-verification: ON
 588  *
 589  * Local Variables:
 590  * eval: (c-set-style "gnu")
 591  * End:
 592  */