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 <vnet/ip/ip6_packet.h>
  45 #include <vnet/ip/lookup.h>
  46
  47 #include <vppinfra/bihash_24_8.h>
  48 #include <vppinfra/bihash_template.h>
  49
  50 /*
  51  * Default size of the ip6 fib hash table
  52  */
  53 #define IP6_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
  54 #define IP6_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
  55
  56 typedef struct {
  57   ip6_address_t addr;
  58   u32 dst_address_length;
  59   u32 vrf_index;
  60 } ip6_fib_key_t;
  61
  62 typedef struct {
  63   /* Table ID (hash key) for this FIB. */
  64   u32 table_id;
  65
  66   /* Index into FIB vector. */
  67   u32 index;
  68
  69   /* flow hash configuration */
  70   u32 flow_hash_config;
  71 } ip6_fib_t;
  72
  73 struct ip6_main_t;
  74
  75 typedef void (ip6_add_del_route_function_t)
  76   (struct ip6_main_t * im,
  77    uword opaque,
  78    ip6_fib_t * fib,
  79    u32 flags,
  80    ip6_address_t * address,
  81    u32 address_length,
  82    void * old_result,
  83    void * new_result);
  84
  85 typedef struct {
  86   ip6_add_del_route_function_t * function;
  87   uword required_flags;
  88   uword function_opaque;
  89 } ip6_add_del_route_callback_t;
  90
  91 typedef void (ip6_add_del_interface_address_function_t)
  92   (struct ip6_main_t * im,
  93    uword opaque,
  94    u32 sw_if_index,
  95    ip6_address_t * address,
  96    u32 address_length,
  97    u32 if_address_index,
  98    u32 is_del);
  99
 100 typedef struct {
 101   ip6_add_del_interface_address_function_t * function;
 102   uword function_opaque;
 103 } ip6_add_del_interface_address_callback_t;
 104
 105 typedef enum {
 106   /* First check access list to either permit or deny this
 107      packet based on classification. */
 108   IP6_RX_FEATURE_CHECK_ACCESS,
 109
 110   /* RPF check: verify that source address is reachable via
 111      RX interface or via any interface. */
 112   IP6_RX_FEATURE_CHECK_SOURCE_REACHABLE_VIA_RX,
 113   IP6_RX_FEATURE_CHECK_SOURCE_REACHABLE_VIA_ANY,
 114
 115   /* IPSec */
 116   IP6_RX_FEATURE_IPSEC,
 117
 118   /* Intercept and decap L2TPv3 packets. */
 119   IP6_RX_FEATURE_L2TPV3,
 120
 121   /* vPath forwarding: won't return to call next feature
 122      so any feature needed before vPath forwarding must be prior
 123      to this entry */
 124   IP6_RX_FEATURE_VPATH,
 125
 126   /* Must be last: perform forwarding lookup. */
 127   IP6_RX_FEATURE_LOOKUP,
 128
 129   IP6_N_RX_FEATURE,
 130 } ip6_rx_feature_type_t;
 131
 132 typedef struct ip6_main_t {
 133   BVT(clib_bihash) ip6_lookup_table;
 134
 135   ip_lookup_main_t lookup_main;
 136
 137   /* bitmap / refcounts / vector of mask widths to search */
 138   uword * non_empty_dst_address_length_bitmap;
 139   u8 * prefix_lengths_in_search_order;
 140   i32 dst_address_length_refcounts[129];
 141
 142   /* Vector of FIBs. */
 143   ip6_fib_t * fibs;
 144
 145   ip6_address_t fib_masks[129];
 146
 147   /* Table index indexed by software interface. */
 148   u32 * fib_index_by_sw_if_index;
 149
 150   /* Hash table mapping table id to fib index.
 151      ID space is not necessarily dense; index space is dense. */
 152   uword * fib_index_by_table_id;
 153
 154   /* Vector of functions to call when routes are added/deleted. */
 155   ip6_add_del_route_callback_t * add_del_route_callbacks;
 156
 157   /* Hash table mapping interface rewrite adjacency index by sw if index. */
 158   uword * interface_route_adj_index_by_sw_if_index;
 159
 160   /* Functions to call when interface address changes. */
 161   ip6_add_del_interface_address_callback_t * add_del_interface_address_callbacks;
 162
 163   /* Template used to generate IP6 neighbor solicitation packets. */
 164   vlib_packet_template_t discover_neighbor_packet_template;
 165
 166   /* ip6 lookup table config parameters */
 167   u32 lookup_table_nbuckets;
 168   uword lookup_table_size;
 169
 170   /* Seed for Jenkins hash used to compute ip6 flow hash. */
 171   u32 flow_hash_seed;
 172
 173   struct {
 174     /* TTL to use for host generated packets. */
 175     u8 ttl;
 176
 177     u8 pad[3];
 178   } host_config;
 179 } ip6_main_t;
 180
 181 /* Global ip6 main structure. */
 182 extern ip6_main_t ip6_main;
 183
 184 /* Global ip6 input node.  Errors get attached to ip6 input node. */
 185 extern vlib_node_registration_t ip6_input_node;
 186 extern vlib_node_registration_t ip6_rewrite_node;
 187 extern vlib_node_registration_t ip6_discover_neighbor_node;
 188
 189 extern vlib_node_registration_t ip6_icmp_neighbor_discovery_event_node;
 190
 191 /* ipv6 neighbor discovery - timer/event types */
 192 typedef enum {
 193   ICMP6_ND_EVENT_INIT,
 194 } ip6_icmp_neighbor_discovery_event_type_t;
 195
 196 typedef union {
 197   u32 add_del_swindex;
 198   struct {
 199     u32 up_down_swindex;
 200     u32 fib_index;
 201   } up_down_event;
 202 } ip6_icmp_neighbor_discovery_event_data_t;
 203
 204 u32 ip6_fib_lookup (ip6_main_t * im, u32 sw_if_index, ip6_address_t * dst);
 205 u32 ip6_fib_lookup_with_table (ip6_main_t * im, u32 fib_index,
 206                                ip6_address_t * dst);
 207
 208 /**
 209  * \brief Get or create an IPv6 fib.
 210  *
 211  * Get or create an IPv6 fib with the provided fib ID or index.
 212  * The fib ID is a possibly-sparse user-defined value while
 213  * the fib index defines the position of the fib in the fib vector.
 214  *
 215  * \param im
 216  *      ip6_main pointer.
 217  * \param table_index_or_id
 218  *      The table index if \c IP6_ROUTE_FLAG_FIB_INDEX bit is set in \p flags.
 219  *      Otherwise, when set to \c ~0, an arbitrary and unused fib ID is picked
 220  *      and can be retrieved with \c ret->table_id.
 221  *      Otherwise, it is the fib ID to be used to retrieve or create the desired fib.
 222  * \param flags
 223  *      Indicates whether \p table_index_or_id is the fib index or ID.
 224  *      When the bit \c IP6_ROUTE_FLAG_FIB_INDEX is set, \p table_index_or_id
 225  *      is considered as the fib index, and the fib ID otherwise.
 226  * \return A pointer to the retrieved or created fib.
 227  *
 228  * \remark When getting a fib with the fib index, the fib MUST already exist.
 229  */
 230 ip6_fib_t * find_ip6_fib_by_table_index_or_id (ip6_main_t * im,
 231                                                u32 table_index_or_id,
 232                                                u32 flags);
 233
 234 always_inline uword
 235 ip6_destination_matches_route (ip6_main_t * im,
 236                                ip6_address_t * key,
 237                                ip6_address_t * dest,
 238                                uword dest_length)
 239 {
 240   int i;
 241   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
 242     {
 243       if ((key->as_uword[i] ^ dest->as_uword[i]) & im->fib_masks[dest_length].as_uword[i])
 244         return 0;
 245     }
 246   return 1;
 247 }
 248
 249 always_inline uword
 250 ip6_destination_matches_interface (ip6_main_t * im,
 251                                    ip6_address_t * key,
 252                                    ip_interface_address_t * ia)
 253 {
 254   ip6_address_t * a = ip_interface_address_get_address (&im->lookup_main, ia);
 255   return ip6_destination_matches_route (im, key, a, ia->address_length);
 256 }
 257
 258 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
 259 always_inline uword
 260 ip6_unaligned_destination_matches_route (ip6_main_t * im,
 261                                          ip6_address_t * key,
 262                                          ip6_address_t * dest,
 263                                          uword dest_length)
 264 {
 265   int i;
 266   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
 267     {
 268       if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i]) & im->fib_masks[dest_length].as_uword[i])
 269         return 0;
 270     }
 271   return 1;
 272 }
 273
 274 always_inline void
 275 ip6_src_address_for_packet (ip6_main_t * im, vlib_buffer_t * p, ip6_address_t * src, u32 sw_if_index)
 276 {
 277   ip_lookup_main_t * lm = &im->lookup_main;
 278   ip_interface_address_t * ia = ip_interface_address_for_packet (lm, p, sw_if_index);
 279   ip6_address_t * a = ip_interface_address_get_address (lm, ia);
 280   *src = a[0];
 281 }
 282
 283 always_inline u32
 284 ip6_src_lookup_for_packet (ip6_main_t * im, vlib_buffer_t * b, ip6_header_t * i)
 285 {
 286   if (vnet_buffer (b)->ip.adj_index[VLIB_RX] == ~0)
 287     vnet_buffer (b)->ip.adj_index[VLIB_RX]
 288       = ip6_fib_lookup (im, vnet_buffer (b)->sw_if_index[VLIB_RX],
 289                         &i->src_address);
 290   return vnet_buffer (b)->ip.adj_index[VLIB_RX];
 291 }
 292
 293 /* Find interface address which matches destination. */
 294 always_inline ip6_address_t *
 295 ip6_interface_address_matching_destination (ip6_main_t * im, ip6_address_t * dst, u32 sw_if_index,
 296                                             ip_interface_address_t ** result_ia)
 297 {
 298   ip_lookup_main_t * lm = &im->lookup_main;
 299   ip_interface_address_t * ia;
 300   ip6_address_t * result = 0;
 301
 302   foreach_ip_interface_address (lm, ia, sw_if_index,
 303                                 1 /* honor unnumbered */,
 304   ({
 305     ip6_address_t * a = ip_interface_address_get_address (lm, ia);
 306     if (ip6_destination_matches_route (im, dst, a, ia->address_length))
 307       {
 308         result = a;
 309         break;
 310       }
 311   }));
 312   if (result_ia)
 313     *result_ia = result ? ia : 0;
 314   return result;
 315 }
 316
 317 clib_error_t *
 318 ip6_add_del_interface_address (vlib_main_t * vm, u32 sw_if_index,
 319                                ip6_address_t * address, u32 address_length,
 320                                u32 is_del);
 321
 322 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
 323
 324 /* Add/del a route to the FIB. */
 325
 326 #define IP6_ROUTE_FLAG_ADD (0 << 0)
 327 #define IP6_ROUTE_FLAG_DEL (1 << 0)
 328 #define IP6_ROUTE_FLAG_TABLE_ID  (0 << 1)
 329 #define IP6_ROUTE_FLAG_FIB_INDEX (1 << 1)
 330 #define IP6_ROUTE_FLAG_KEEP_OLD_ADJACENCY (1 << 2)
 331 #define IP6_ROUTE_FLAG_NO_REDISTRIBUTE (1 << 3)
 332 #define IP6_ROUTE_FLAG_NOT_LAST_IN_GROUP (1 << 4)
 333 /* Dynamic route created via neighbor discovery. */
 334 #define IP6_ROUTE_FLAG_NEIGHBOR (1 << 5)
 335
 336 typedef struct {
 337   /* IP6_ROUTE_FLAG_* */
 338   u32 flags;
 339
 340   /* Either index of fib or table_id to hash and get fib.
 341      IP6_ROUTE_FLAG_FIB_INDEX specifies index; otherwise table_id is assumed. */
 342   u32 table_index_or_table_id;
 343
 344   /* Destination address (prefix) and length. */
 345   ip6_address_t dst_address;
 346   u32 dst_address_length;
 347
 348   /* Adjacency to use for this destination. */
 349   u32 adj_index;
 350
 351   /* If specified adjacencies to add and then
 352      use for this destination.  add_adj/n_add_adj
 353      are override adj_index if specified. */
 354   ip_adjacency_t * add_adj;
 355   u32 n_add_adj;
 356 } ip6_add_del_route_args_t;
 357
 358 void ip6_add_del_route (ip6_main_t * im, ip6_add_del_route_args_t * args);
 359
 360 void ip6_add_del_route_next_hop (ip6_main_t * im,
 361                                  u32 flags,
 362                                  ip6_address_t * dst_address,
 363                                  u32 dst_address_length,
 364                                  ip6_address_t * next_hop,
 365                                  u32 next_hop_sw_if_index,
 366                                  u32 next_hop_weight, u32 adj_index,
 367                                  u32 explicit_fib_index);
 368 u32
 369 ip6_get_route (ip6_main_t * im,
 370                u32 fib_index_or_table_id,
 371                u32 flags,
 372                ip6_address_t * address,
 373                u32 address_length);
 374
 375 void
 376 ip6_foreach_matching_route (ip6_main_t * im,
 377                             u32 table_index_or_table_id,
 378                             u32 flags,
 379                             ip6_address_t * address,
 380                             u32 address_length,
 381                             ip6_address_t ** results,
 382                             u8 ** result_length);
 383
 384 void ip6_delete_matching_routes (ip6_main_t * im,
 385                                  u32 table_index_or_table_id,
 386                                  u32 flags,
 387                                  ip6_address_t * address,
 388                                  u32 address_length);
 389
 390 void ip6_maybe_remap_adjacencies (ip6_main_t * im,
 391                                   u32 table_index_or_table_id,
 392                                   u32 flags);
 393
 394 void ip6_adjacency_set_interface_route (vnet_main_t * vnm,
 395                                         ip_adjacency_t * adj,
 396                                         u32 sw_if_index,
 397                                         u32 if_address_index);
 398
 399 u32
 400 vnet_ip6_neighbor_glean_add(u32 fib_index, void * next_hop_arg);
 401
 402 clib_error_t *
 403 ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst, u32 sw_if_index);
 404
 405 clib_error_t *
 406 ip6_set_neighbor_limit (u32 neighbor_limit);
 407
 408 uword
 409 ip6_udp_register_listener (vlib_main_t * vm,
 410                            u16 dst_port,
 411                            u32 next_node_index);
 412
 413 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0, ip6_header_t * ip0, int *bogus_lengthp);
 414
 415 void ip6_register_protocol (u32 protocol, u32 node_index);
 416
 417 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
 418
 419 int
 420 vnet_set_ip6_ethernet_neighbor (vlib_main_t * vm,
 421                                 u32 sw_if_index,
 422                                 ip6_address_t * a,
 423                                 u8 * link_layer_address,
 424                                 uword n_bytes_link_layer_address,
 425                                 int is_static);
 426 int
 427 vnet_unset_ip6_ethernet_neighbor (vlib_main_t * vm,
 428                                   u32 sw_if_index,
 429                                   ip6_address_t * a,
 430                                   u8 * link_layer_address,
 431                                   uword n_bytes_link_layer_address);
 432 void
 433 vnet_ip6_fib_init (ip6_main_t * im, u32 fib_index);
 434
 435 void
 436 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t *ip,
 437                                                   u8 *mac);
 438
 439 void
 440 ip6_ethernet_mac_address_from_link_local_address (u8 *mac,
 441                                                   ip6_address_t *ip);
 442
 443 int vnet_set_ip6_flow_hash (u32 table_id, u32 flow_hash_config);
 444
 445 int
 446 ip6_neighbor_ra_config(vlib_main_t * vm, u32 sw_if_index,
 447                        u8 surpress, u8 managed, u8 other,
 448                        u8 ll_option,  u8 send_unicast,  u8 cease,
 449                        u8 use_lifetime,  u32 lifetime,
 450                        u32 initial_count,  u32 initial_interval,
 451                        u32 max_interval,  u32 min_interval,
 452                        u8 is_no);
 453
 454 int
 455 ip6_neighbor_ra_prefix(vlib_main_t * vm, u32 sw_if_index,
 456                        ip6_address_t *prefix_addr,  u8 prefix_len,
 457                        u8 use_default,  u32 val_lifetime, u32 pref_lifetime,
 458                        u8 no_advertise,  u8 off_link, u8 no_autoconfig, u8 no_onlink,
 459                        u8 is_no);
 460
 461
 462 clib_error_t *
 463 enable_ip6_interface(vlib_main_t * vm,
 464                      u32 sw_if_index);
 465
 466 clib_error_t *
 467 disable_ip6_interface(vlib_main_t * vm,
 468                      u32 sw_if_index);
 469
 470 int
 471 ip6_interface_enabled(vlib_main_t * vm,
 472                       u32 sw_if_index);
 473
 474 clib_error_t *
 475 set_ip6_link_local_address(vlib_main_t * vm,
 476                            u32 sw_if_index,
 477                            ip6_address_t *address,
 478                            u8 address_length);
 479
 480 void vnet_register_ip6_neighbor_resolution_event(vnet_main_t * vnm,
 481                                                  void * address_arg,
 482                                                  uword node_index,
 483                                                  uword type_opaque,
 484                                                  uword data);
 485
 486 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
 487                                  u32 table_index);
 488 extern vlib_node_registration_t ip6_lookup_node;
 489
 490 /* Compute flow hash.  We'll use it to select which Sponge to use for this
 491    flow.  And other things. */
 492 always_inline u32
 493 ip6_compute_flow_hash (ip6_header_t * ip, u32 flow_hash_config)
 494 {
 495     tcp_header_t * tcp = (void *) (ip + 1);
 496     u64 a, b, c;
 497     u64 t1, t2;
 498     uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
 499                         || ip->protocol == IP_PROTOCOL_UDP);
 500
 501     t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
 502     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
 503
 504     t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
 505     t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
 506
 507     a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
 508     b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
 509     b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
 510
 511     t1 = is_tcp_udp ? tcp->ports.src : 0;
 512     t2 = is_tcp_udp ? tcp->ports.dst : 0;
 513
 514     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
 515     t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
 516
 517     c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
 518         ((t1<<16) | t2) : ((t2<<16) | t1);
 519
 520     hash_mix64 (a, b, c);
 521     return (u32) c;
 522 }
 523
 524 #endif /* included_ip_ip6_h */