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_feature[VNET_N_IP_FEAT];
 165
 166   /* Built-in unicast feature path indices, see ip_feature_init_cast(...)  */
 167   u32 ip6_unicast_rx_feature_check_access;
 168   u32 ip6_unicast_rx_feature_policer_classify;
 169   u32 ip6_unicast_rx_feature_ipsec;
 170   u32 ip6_unicast_rx_feature_l2tp_decap;
 171   u32 ip6_unicast_rx_feature_vpath;
 172   u32 ip6_unicast_rx_feature_lookup;
 173   u32 ip6_unicast_rx_feature_drop;
 174
 175   /* Built-in multicast feature path indices */
 176   u32 ip6_multicast_rx_feature_drop;
 177   u32 ip6_multicast_rx_feature_vpath;
 178   u32 ip6_multicast_rx_feature_lookup;
 179
 180   /* Built-in tx feature path index */
 181   u32 ip6_tx_feature_interface_output;
 182
 183   /* Save results for show command */
 184   char ** feature_nodes[VNET_N_IP_FEAT];
 185
 186   /* Seed for Jenkins hash used to compute ip6 flow hash. */
 187   u32 flow_hash_seed;
 188
 189   struct {
 190     /* TTL to use for host generated packets. */
 191     u8 ttl;
 192
 193     u8 pad[3];
 194   } host_config;
 195
 196   /* HBH processing enabled? */
 197   u8 hbh_enabled;
 198 } ip6_main_t;
 199
 200 /* Global ip6 main structure. */
 201 extern ip6_main_t ip6_main;
 202
 203 #define VNET_IP6_UNICAST_FEATURE_INIT(x,...)                    \
 204   __VA_ARGS__ vnet_ip_feature_registration_t uc_##x;            \
 205 static void __vnet_add_feature_registration_uc_##x (void)       \
 206   __attribute__((__constructor__)) ;                            \
 207 static void __vnet_add_feature_registration_uc_##x (void)       \
 208 {                                                               \
 209   ip6_main_t * im = &ip6_main;                                  \
 210   uc_##x.next = im->next_feature[VNET_IP_RX_UNICAST_FEAT];      \
 211   im->next_feature[VNET_IP_RX_UNICAST_FEAT] = &uc_##x;          \
 212 }                                                               \
 213 __VA_ARGS__ vnet_ip_feature_registration_t uc_##x
 214
 215 #define VNET_IP6_MULTICAST_FEATURE_INIT(x,...)                  \
 216   __VA_ARGS__ vnet_ip_feature_registration_t mc_##x;            \
 217 static void __vnet_add_feature_registration_mc_##x (void)       \
 218   __attribute__((__constructor__)) ;                            \
 219 static void __vnet_add_feature_registration_mc_##x (void)       \
 220 {                                                               \
 221   ip6_main_t * im = &ip6_main;                                  \
 222   mc_##x.next = im->next_feature[VNET_IP_RX_MULTICAST_FEAT];    \
 223   im->next_feature[VNET_IP_RX_MULTICAST_FEAT] = &mc_##x;        \
 224 }                                                               \
 225 __VA_ARGS__ vnet_ip_feature_registration_t mc_##x
 226
 227 #define VNET_IP6_TX_FEATURE_INIT(x,...)                         \
 228   __VA_ARGS__ vnet_ip_feature_registration_t tx_##x;            \
 229 static void __vnet_add_feature_registration_tx_##x (void)       \
 230   __attribute__((__constructor__)) ;                            \
 231 static void __vnet_add_feature_registration_tx_##x (void)       \
 232 {                                                               \
 233   ip6_main_t * im = &ip6_main;                                  \
 234   tx_##x.next = im->next_feature[VNET_IP_TX_FEAT];              \
 235   im->next_feature[VNET_IP_TX_FEAT] = &tx_##x;                  \
 236 }                                                               \
 237 __VA_ARGS__ vnet_ip_feature_registration_t tx_##x
 238
 239
 240 /* Global ip6 input node.  Errors get attached to ip6 input node. */
 241 extern vlib_node_registration_t ip6_input_node;
 242 extern vlib_node_registration_t ip6_rewrite_node;
 243 extern vlib_node_registration_t ip6_rewrite_local_node;
 244 extern vlib_node_registration_t ip6_discover_neighbor_node;
 245 extern vlib_node_registration_t ip6_glean_node;
 246 extern vlib_node_registration_t ip6_midchain_node;
 247
 248 extern vlib_node_registration_t ip6_icmp_neighbor_discovery_event_node;
 249
 250 /* ipv6 neighbor discovery - timer/event types */
 251 typedef enum {
 252   ICMP6_ND_EVENT_INIT,
 253 } ip6_icmp_neighbor_discovery_event_type_t;
 254
 255 typedef union {
 256   u32 add_del_swindex;
 257   struct {
 258     u32 up_down_swindex;
 259     u32 fib_index;
 260   } up_down_event;
 261 } ip6_icmp_neighbor_discovery_event_data_t;
 262
 263 always_inline uword
 264 ip6_destination_matches_route (const ip6_main_t * im,
 265                                const ip6_address_t * key,
 266                                const ip6_address_t * dest,
 267                                uword dest_length)
 268 {
 269   int i;
 270   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
 271     {
 272       if ((key->as_uword[i] ^ dest->as_uword[i]) & im->fib_masks[dest_length].as_uword[i])
 273         return 0;
 274     }
 275   return 1;
 276 }
 277
 278 always_inline uword
 279 ip6_destination_matches_interface (ip6_main_t * im,
 280                                    ip6_address_t * key,
 281                                    ip_interface_address_t * ia)
 282 {
 283   ip6_address_t * a = ip_interface_address_get_address (&im->lookup_main, ia);
 284   return ip6_destination_matches_route (im, key, a, ia->address_length);
 285 }
 286
 287 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
 288 always_inline uword
 289 ip6_unaligned_destination_matches_route (ip6_main_t * im,
 290                                          ip6_address_t * key,
 291                                          ip6_address_t * dest,
 292                                          uword dest_length)
 293 {
 294   int i;
 295   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
 296     {
 297       if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i]) & im->fib_masks[dest_length].as_uword[i])
 298         return 0;
 299     }
 300   return 1;
 301 }
 302
 303 always_inline int
 304 ip6_src_address_for_packet (ip_lookup_main_t * lm,
 305                             u32 sw_if_index,
 306                             ip6_address_t * src)
 307 {
 308     u32 if_add_index =
 309         lm->if_address_pool_index_by_sw_if_index[sw_if_index];
 310     if (PREDICT_TRUE(if_add_index != ~0)) {
 311         ip_interface_address_t *if_add =
 312             pool_elt_at_index(lm->if_address_pool, if_add_index);
 313         ip6_address_t *if_ip =
 314             ip_interface_address_get_address(lm, if_add);
 315         *src = *if_ip;
 316         return (0);
 317     }
 318     else
 319     {
 320         src->as_u64[0] = 0;
 321         src->as_u64[1] = 0;
 322     }
 323     return (!0);
 324 }
 325
 326 /* Find interface address which matches destination. */
 327 always_inline ip6_address_t *
 328 ip6_interface_address_matching_destination (ip6_main_t * im, ip6_address_t * dst, u32 sw_if_index,
 329                                             ip_interface_address_t ** result_ia)
 330 {
 331   ip_lookup_main_t * lm = &im->lookup_main;
 332   ip_interface_address_t * ia;
 333   ip6_address_t * result = 0;
 334
 335   foreach_ip_interface_address (lm, ia, sw_if_index,
 336                                 1 /* honor unnumbered */,
 337   ({
 338     ip6_address_t * a = ip_interface_address_get_address (lm, ia);
 339     if (ip6_destination_matches_route (im, dst, a, ia->address_length))
 340       {
 341         result = a;
 342         break;
 343       }
 344   }));
 345   if (result_ia)
 346     *result_ia = result ? ia : 0;
 347   return result;
 348 }
 349
 350 clib_error_t *
 351 ip6_add_del_interface_address (vlib_main_t * vm, u32 sw_if_index,
 352                                ip6_address_t * address, u32 address_length,
 353                                u32 is_del);
 354 void
 355 ip6_sw_interface_enable_disable (u32 sw_if_index,
 356                                  u32 is_enable);
 357
 358 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
 359
 360 clib_error_t *
 361 ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst, u32 sw_if_index);
 362
 363 clib_error_t *
 364 ip6_set_neighbor_limit (u32 neighbor_limit);
 365
 366 uword
 367 ip6_udp_register_listener (vlib_main_t * vm,
 368                            u16 dst_port,
 369                            u32 next_node_index);
 370
 371 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0, ip6_header_t * ip0, int *bogus_lengthp);
 372
 373 void ip6_register_protocol (u32 protocol, u32 node_index);
 374
 375 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
 376
 377 int
 378 vnet_set_ip6_ethernet_neighbor (vlib_main_t * vm,
 379                                 u32 sw_if_index,
 380                                 ip6_address_t * a,
 381                                 u8 * link_layer_address,
 382                                 uword n_bytes_link_layer_address,
 383                                 int is_static);
 384 int
 385 vnet_unset_ip6_ethernet_neighbor (vlib_main_t * vm,
 386                                   u32 sw_if_index,
 387                                   ip6_address_t * a,
 388                                   u8 * link_layer_address,
 389                                   uword n_bytes_link_layer_address);
 390
 391 void
 392 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t *ip,
 393                                                   u8 *mac);
 394
 395 void
 396 ip6_ethernet_mac_address_from_link_local_address (u8 *mac,
 397                                                   ip6_address_t *ip);
 398
 399 int vnet_set_ip6_flow_hash (u32 table_id,
 400                             flow_hash_config_t flow_hash_config);
 401
 402 int
 403 ip6_neighbor_ra_config(vlib_main_t * vm, u32 sw_if_index,
 404                        u8 suppress, u8 managed, u8 other,
 405                        u8 ll_option,  u8 send_unicast,  u8 cease,
 406                        u8 use_lifetime,  u32 lifetime,
 407                        u32 initial_count,  u32 initial_interval,
 408                        u32 max_interval,  u32 min_interval,
 409                        u8 is_no);
 410
 411 int
 412 ip6_neighbor_ra_prefix(vlib_main_t * vm, u32 sw_if_index,
 413                        ip6_address_t *prefix_addr,  u8 prefix_len,
 414                        u8 use_default,  u32 val_lifetime, u32 pref_lifetime,
 415                        u8 no_advertise,  u8 off_link, u8 no_autoconfig, u8 no_onlink,
 416                        u8 is_no);
 417
 418
 419 clib_error_t *
 420 enable_ip6_interface(vlib_main_t * vm,
 421                      u32 sw_if_index);
 422
 423 clib_error_t *
 424 disable_ip6_interface(vlib_main_t * vm,
 425                      u32 sw_if_index);
 426
 427 int
 428 ip6_interface_enabled(vlib_main_t * vm,
 429                       u32 sw_if_index);
 430
 431 clib_error_t *
 432 set_ip6_link_local_address(vlib_main_t * vm,
 433                            u32 sw_if_index,
 434                            ip6_address_t *address,
 435                            u8 address_length);
 436
 437 void vnet_register_ip6_neighbor_resolution_event(vnet_main_t * vnm,
 438                                                  void * address_arg,
 439                                                  uword node_index,
 440                                                  uword type_opaque,
 441                                                  uword data);
 442
 443 int vnet_add_del_ip6_nd_change_event (vnet_main_t * vnm,
 444                                       void * data_callback,
 445                                       u32 pid,
 446                                       void * address_arg,
 447                                       uword node_index,
 448                                       uword type_opaque,
 449                                       uword data,
 450                                       int is_add);
 451
 452 int vnet_ip6_nd_term (vlib_main_t * vm,
 453                       vlib_node_runtime_t * node,
 454                       vlib_buffer_t * p0,
 455                       ethernet_header_t * eth,
 456                       ip6_header_t * ip,
 457                       u32 sw_if_index,
 458                       u16 bd_index,
 459                       u8 shg);
 460
 461 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
 462                                  u32 table_index);
 463 extern vlib_node_registration_t ip6_lookup_node;
 464
 465 /* Compute flow hash.  We'll use it to select which Sponge to use for this
 466    flow.  And other things. */
 467 always_inline u32
 468 ip6_compute_flow_hash (const ip6_header_t * ip,
 469                        flow_hash_config_t flow_hash_config)
 470 {
 471     tcp_header_t * tcp = (void *) (ip + 1);
 472     u64 a, b, c;
 473     u64 t1, t2;
 474     uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
 475                         || ip->protocol == IP_PROTOCOL_UDP);
 476
 477     t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
 478     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
 479
 480     t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
 481     t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
 482
 483     a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
 484     b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
 485     b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
 486
 487     t1 = is_tcp_udp ? tcp->ports.src : 0;
 488     t2 = is_tcp_udp ? tcp->ports.dst : 0;
 489
 490     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
 491     t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
 492
 493     c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
 494         ((t1<<16) | t2) : ((t2<<16) | t1);
 495
 496     hash_mix64 (a, b, c);
 497     return (u32) c;
 498 }
 499
 500 /*
 501  * Hop-by-Hop handling
 502  */
 503 typedef struct {
 504   /* Array of function pointers to HBH option handling routines */
 505   int (*options[256])(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt);
 506   u8 *(*trace[256])(u8 *s, ip6_hop_by_hop_option_t *opt);
 507   uword next_override;
 508 } ip6_hop_by_hop_main_t;
 509
 510 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
 511
 512 int ip6_hbh_register_option (u8 option,
 513                              int options(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt),
 514                              u8 *trace(u8 *s, ip6_hop_by_hop_option_t *opt));
 515 int ip6_hbh_unregister_option (u8 option);
 516 void ip6_hbh_set_next_override (uword next);
 517
 518 /* Flag used by IOAM code. Classifier sets it pop-hop-by-hop checks it */
 519 #define OI_DECAP   100
 520
 521 #endif /* included_ip_ip6_h */