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
  53 /*
  54  * Default size of the ip6 fib hash table
  55  */
  56 #define IP6_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
  57 #define IP6_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
  58
  59 typedef struct
  60 {
  61   ip6_address_t addr;
  62   u32 dst_address_length;
  63   u32 vrf_index;
  64 } ip6_fib_key_t;
  65
  66 typedef struct
  67 {
  68   /* Table ID (hash key) for this FIB. */
  69   u32 table_id;
  70
  71   /* Index into FIB vector. */
  72   u32 index;
  73
  74   /* flow hash configuration */
  75   flow_hash_config_t flow_hash_config;
  76 } ip6_fib_t;
  77
  78 struct ip6_main_t;
  79
  80 typedef void (ip6_add_del_interface_address_function_t)
  81   (struct ip6_main_t * im,
  82    uword opaque,
  83    u32 sw_if_index,
  84    ip6_address_t * address,
  85    u32 address_length, u32 if_address_index, u32 is_del);
  86
  87 typedef struct
  88 {
  89   ip6_add_del_interface_address_function_t *function;
  90   uword function_opaque;
  91 } ip6_add_del_interface_address_callback_t;
  92
  93 /**
  94  * Enumeration of the FIB table instance types
  95  */
  96 typedef enum ip6_fib_table_instance_type_t_
  97 {
  98     /**
  99      * This table stores the routes that are used to forward traffic.
 100      * The key is the prefix, the result the adjacnecy to forward on.
 101      */
 102   IP6_FIB_TABLE_FWDING,
 103     /**
 104      * The table that stores ALL routes learned by the DP.
 105      * Some of these routes may not be ready to install in forwarding
 106      * at a given time.
 107      * The key in this table is the prefix, the result is the fib_entry_t
 108      */
 109   IP6_FIB_TABLE_NON_FWDING,
 110 } ip6_fib_table_instance_type_t;
 111
 112 #define IP6_FIB_NUM_TABLES (IP6_FIB_TABLE_NON_FWDING+1)
 113
 114 /**
 115  * A represenation of a single IP6 table
 116  */
 117 typedef struct ip6_fib_table_instance_t_
 118 {
 119   /* The hash table */
 120   BVT (clib_bihash) ip6_hash;
 121
 122   /* bitmap / refcounts / vector of mask widths to search */
 123   uword *non_empty_dst_address_length_bitmap;
 124   u8 *prefix_lengths_in_search_order;
 125   i32 dst_address_length_refcounts[129];
 126 } ip6_fib_table_instance_t;
 127
 128 typedef struct ip6_main_t
 129 {
 130   /**
 131    * The two FIB tables; fwding and non-fwding
 132    */
 133   ip6_fib_table_instance_t ip6_table[IP6_FIB_NUM_TABLES];
 134
 135   ip_lookup_main_t lookup_main;
 136
 137   /* Pool of FIBs. */
 138   struct fib_table_t_ *fibs;
 139
 140   /* Network byte orders subnet mask for each prefix length */
 141   ip6_address_t fib_masks[129];
 142
 143   /* Table index indexed by software interface. */
 144   u32 *fib_index_by_sw_if_index;
 145
 146   /* IP6 enabled count by software interface */
 147   u8 *ip_enabled_by_sw_if_index;
 148
 149   /* Hash table mapping table id to fib index.
 150      ID space is not necessarily dense; index space is dense. */
 151   uword *fib_index_by_table_id;
 152
 153   /* Hash table mapping interface rewrite adjacency index by sw if index. */
 154   uword *interface_route_adj_index_by_sw_if_index;
 155
 156   /* Functions to call when interface address changes. */
 157     ip6_add_del_interface_address_callback_t
 158     * add_del_interface_address_callbacks;
 159
 160   /* Template used to generate IP6 neighbor solicitation packets. */
 161   vlib_packet_template_t discover_neighbor_packet_template;
 162
 163   /* ip6 lookup table config parameters */
 164   u32 lookup_table_nbuckets;
 165   uword lookup_table_size;
 166
 167   /* Seed for Jenkins hash used to compute ip6 flow hash. */
 168   u32 flow_hash_seed;
 169
 170   struct
 171   {
 172     /* TTL to use for host generated packets. */
 173     u8 ttl;
 174
 175     u8 pad[3];
 176   } host_config;
 177
 178   /* HBH processing enabled? */
 179   u8 hbh_enabled;
 180 } ip6_main_t;
 181
 182 /* Global ip6 main structure. */
 183 extern ip6_main_t ip6_main;
 184
 185 /* Global ip6 input node.  Errors get attached to ip6 input node. */
 186 extern vlib_node_registration_t ip6_input_node;
 187 extern vlib_node_registration_t ip6_rewrite_node;
 188 extern vlib_node_registration_t ip6_rewrite_local_node;
 189 extern vlib_node_registration_t ip6_discover_neighbor_node;
 190 extern vlib_node_registration_t ip6_glean_node;
 191 extern vlib_node_registration_t ip6_midchain_node;
 192
 193 extern vlib_node_registration_t ip6_icmp_neighbor_discovery_event_node;
 194
 195 /* ipv6 neighbor discovery - timer/event types */
 196 typedef enum
 197 {
 198   ICMP6_ND_EVENT_INIT,
 199 } ip6_icmp_neighbor_discovery_event_type_t;
 200
 201 typedef union
 202 {
 203   u32 add_del_swindex;
 204   struct
 205   {
 206     u32 up_down_swindex;
 207     u32 fib_index;
 208   } up_down_event;
 209 } ip6_icmp_neighbor_discovery_event_data_t;
 210
 211 always_inline uword
 212 ip6_destination_matches_route (const ip6_main_t * im,
 213                                const ip6_address_t * key,
 214                                const ip6_address_t * dest, uword dest_length)
 215 {
 216   int i;
 217   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
 218     {
 219       if ((key->as_uword[i] ^ dest->as_uword[i]) & im->
 220           fib_masks[dest_length].as_uword[i])
 221         return 0;
 222     }
 223   return 1;
 224 }
 225
 226 always_inline uword
 227 ip6_destination_matches_interface (ip6_main_t * im,
 228                                    ip6_address_t * key,
 229                                    ip_interface_address_t * ia)
 230 {
 231   ip6_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
 232   return ip6_destination_matches_route (im, key, a, ia->address_length);
 233 }
 234
 235 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
 236 always_inline uword
 237 ip6_unaligned_destination_matches_route (ip6_main_t * im,
 238                                          ip6_address_t * key,
 239                                          ip6_address_t * dest,
 240                                          uword dest_length)
 241 {
 242   int i;
 243   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
 244     {
 245       if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i])
 246           & im->fib_masks[dest_length].as_uword[i])
 247         return 0;
 248     }
 249   return 1;
 250 }
 251
 252 always_inline int
 253 ip6_src_address_for_packet (ip_lookup_main_t * lm,
 254                             u32 sw_if_index, ip6_address_t * src)
 255 {
 256   u32 if_add_index = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
 257   if (PREDICT_TRUE (if_add_index != ~0))
 258     {
 259       ip_interface_address_t *if_add =
 260         pool_elt_at_index (lm->if_address_pool, if_add_index);
 261       ip6_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
 262       *src = *if_ip;
 263       return (0);
 264     }
 265   else
 266     {
 267       src->as_u64[0] = 0;
 268       src->as_u64[1] = 0;
 269     }
 270   return (!0);
 271 }
 272
 273 /* Find interface address which matches destination. */
 274 always_inline ip6_address_t *
 275 ip6_interface_address_matching_destination (ip6_main_t * im,
 276                                             ip6_address_t * dst,
 277                                             u32 sw_if_index,
 278                                             ip_interface_address_t **
 279                                             result_ia)
 280 {
 281   ip_lookup_main_t *lm = &im->lookup_main;
 282   ip_interface_address_t *ia;
 283   ip6_address_t *result = 0;
 284
 285   /* *INDENT-OFF* */
 286   foreach_ip_interface_address (lm, ia, sw_if_index,
 287                                 1 /* honor unnumbered */,
 288   ({
 289     ip6_address_t * a = ip_interface_address_get_address (lm, ia);
 290     if (ip6_destination_matches_route (im, dst, a, ia->address_length))
 291       {
 292         result = a;
 293         break;
 294       }
 295   }));
 296   /* *INDENT-ON* */
 297   if (result_ia)
 298     *result_ia = result ? ia : 0;
 299   return result;
 300 }
 301
 302 clib_error_t *ip6_add_del_interface_address (vlib_main_t * vm,
 303                                              u32 sw_if_index,
 304                                              ip6_address_t * address,
 305                                              u32 address_length, u32 is_del);
 306 void ip6_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
 307
 308 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
 309
 310 clib_error_t *ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst,
 311                                   u32 sw_if_index);
 312
 313 clib_error_t *ip6_set_neighbor_limit (u32 neighbor_limit);
 314
 315 uword
 316 ip6_udp_register_listener (vlib_main_t * vm,
 317                            u16 dst_port, u32 next_node_index);
 318
 319 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
 320                                        ip6_header_t * ip0,
 321                                        int *bogus_lengthp);
 322
 323 void ip6_register_protocol (u32 protocol, u32 node_index);
 324
 325 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
 326
 327 void ip6_ethernet_update_adjacency (vnet_main_t * vnm,
 328                                     u32 sw_if_index, u32 ai);
 329
 330 int
 331 vnet_set_ip6_ethernet_neighbor (vlib_main_t * vm,
 332                                 u32 sw_if_index,
 333                                 ip6_address_t * a,
 334                                 u8 * link_layer_address,
 335                                 uword n_bytes_link_layer_address,
 336                                 int is_static);
 337 int
 338 vnet_unset_ip6_ethernet_neighbor (vlib_main_t * vm,
 339                                   u32 sw_if_index,
 340                                   ip6_address_t * a,
 341                                   u8 * link_layer_address,
 342                                   uword n_bytes_link_layer_address);
 343
 344 void
 345 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t * ip,
 346                                                   u8 * mac);
 347
 348 void
 349 ip6_ethernet_mac_address_from_link_local_address (u8 * mac,
 350                                                   ip6_address_t * ip);
 351
 352 int vnet_set_ip6_flow_hash (u32 table_id,
 353                             flow_hash_config_t flow_hash_config);
 354
 355 int
 356 ip6_neighbor_ra_config (vlib_main_t * vm, u32 sw_if_index,
 357                         u8 suppress, u8 managed, u8 other,
 358                         u8 ll_option, u8 send_unicast, u8 cease,
 359                         u8 use_lifetime, u32 lifetime,
 360                         u32 initial_count, u32 initial_interval,
 361                         u32 max_interval, u32 min_interval, u8 is_no);
 362
 363 int
 364 ip6_neighbor_ra_prefix (vlib_main_t * vm, u32 sw_if_index,
 365                         ip6_address_t * prefix_addr, u8 prefix_len,
 366                         u8 use_default, u32 val_lifetime, u32 pref_lifetime,
 367                         u8 no_advertise, u8 off_link, u8 no_autoconfig,
 368                         u8 no_onlink, u8 is_no);
 369
 370
 371 clib_error_t *enable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
 372
 373 clib_error_t *disable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
 374
 375 int ip6_interface_enabled (vlib_main_t * vm, u32 sw_if_index);
 376
 377 clib_error_t *set_ip6_link_local_address (vlib_main_t * vm,
 378                                           u32 sw_if_index,
 379                                           ip6_address_t * address,
 380                                           u8 address_length);
 381
 382 void vnet_register_ip6_neighbor_resolution_event (vnet_main_t * vnm,
 383                                                   void *address_arg,
 384                                                   uword node_index,
 385                                                   uword type_opaque,
 386                                                   uword data);
 387
 388 int vnet_add_del_ip6_nd_change_event (vnet_main_t * vnm,
 389                                       void *data_callback,
 390                                       u32 pid,
 391                                       void *address_arg,
 392                                       uword node_index,
 393                                       uword type_opaque,
 394                                       uword data, int is_add);
 395
 396 int vnet_ip6_nd_term (vlib_main_t * vm,
 397                       vlib_node_runtime_t * node,
 398                       vlib_buffer_t * p0,
 399                       ethernet_header_t * eth,
 400                       ip6_header_t * ip,
 401                       u32 sw_if_index, u16 bd_index, u8 shg);
 402
 403 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
 404                                  u32 table_index);
 405 extern vlib_node_registration_t ip6_lookup_node;
 406
 407 /* Compute flow hash.  We'll use it to select which Sponge to use for this
 408    flow.  And other things. */
 409 always_inline u32
 410 ip6_compute_flow_hash (const ip6_header_t * ip,
 411                        flow_hash_config_t flow_hash_config)
 412 {
 413   tcp_header_t *tcp = (void *) (ip + 1);
 414   u64 a, b, c;
 415   u64 t1, t2;
 416   uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
 417                       || ip->protocol == IP_PROTOCOL_UDP);
 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) ? ip->protocol : 0;
 428
 429   t1 = is_tcp_udp ? tcp->ports.src : 0;
 430   t2 = is_tcp_udp ? tcp->ports.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 /*
 443  * Hop-by-Hop handling
 444  */
 445 typedef struct
 446 {
 447   /* Array of function pointers to HBH option handling routines */
 448   int (*options[256]) (vlib_buffer_t * b, ip6_header_t * ip,
 449                        ip6_hop_by_hop_option_t * opt);
 450   u8 *(*trace[256]) (u8 * s, ip6_hop_by_hop_option_t * opt);
 451   uword next_override;
 452 } ip6_hop_by_hop_main_t;
 453
 454 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
 455
 456 int ip6_hbh_register_option (u8 option,
 457                              int options (vlib_buffer_t * b,
 458                                           ip6_header_t * ip,
 459                                           ip6_hop_by_hop_option_t * opt),
 460                              u8 * trace (u8 * s,
 461                                          ip6_hop_by_hop_option_t * opt));
 462 int ip6_hbh_unregister_option (u8 option);
 463 void ip6_hbh_set_next_override (uword next);
 464
 465 /* Flag used by IOAM code. Classifier sets it pop-hop-by-hop checks it */
 466 #define OI_DECAP   0x80000000
 467
 468 #endif /* included_ip_ip6_h */
 469
 470 /*
 471  * fd.io coding-style-patch-verification: ON
 472  *
 473  * Local Variables:
 474  * eval: (c-set-style "gnu")
 475  * End:
 476  */