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