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