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