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   u32 * discover_neighbor_next_index_by_hw_if_index;
 167
 168   /* ip6 lookup table config parameters */
 169   u32 lookup_table_nbuckets;
 170   uword lookup_table_size;
 171
 172   /* Seed for Jenkins hash used to compute ip6 flow hash. */
 173   u32 flow_hash_seed;
 174
 175   struct {
 176     /* TTL to use for host generated packets. */
 177     u8 ttl;
 178
 179     u8 pad[3];
 180   } host_config;
 181 } ip6_main_t;
 182
 183 /* Global ip6 main structure. */
 184 extern ip6_main_t ip6_main;
 185
 186 /* Global ip6 input node.  Errors get attached to ip6 input node. */
 187 extern vlib_node_registration_t ip6_input_node;
 188 extern vlib_node_registration_t ip6_rewrite_node;
 189 extern vlib_node_registration_t ip6_discover_neighbor_node;
 190
 191 extern vlib_node_registration_t ip6_icmp_neighbor_discovery_event_node;
 192
 193 /* ipv6 neighbor discovery - timer/event types */
 194 typedef enum {
 195   ICMP6_ND_EVENT_INIT,
 196 } ip6_icmp_neighbor_discovery_event_type_t;
 197
 198 typedef union {
 199   u32 add_del_swindex;
 200   struct {
 201     u32 up_down_swindex;
 202     u32 fib_index;
 203   } up_down_event;
 204 } ip6_icmp_neighbor_discovery_event_data_t;
 205
 206 u32 ip6_fib_lookup (ip6_main_t * im, u32 sw_if_index, ip6_address_t * dst);
 207 u32 ip6_fib_lookup_with_table (ip6_main_t * im, u32 fib_index,
 208                                ip6_address_t * dst);
 209 ip6_fib_t * find_ip6_fib_by_table_index_or_id (ip6_main_t * im,
 210                                                u32 table_index_or_id,
 211                                                u32 flags);
 212
 213 always_inline uword
 214 ip6_destination_matches_route (ip6_main_t * im,
 215                                ip6_address_t * key,
 216                                ip6_address_t * dest,
 217                                uword dest_length)
 218 {
 219   int i;
 220   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
 221     {
 222       if ((key->as_uword[i] ^ dest->as_uword[i]) & im->fib_masks[dest_length].as_uword[i])
 223         return 0;
 224     }
 225   return 1;
 226 }
 227
 228 always_inline uword
 229 ip6_destination_matches_interface (ip6_main_t * im,
 230                                    ip6_address_t * key,
 231                                    ip_interface_address_t * ia)
 232 {
 233   ip6_address_t * a = ip_interface_address_get_address (&im->lookup_main, ia);
 234   return ip6_destination_matches_route (im, key, a, ia->address_length);
 235 }
 236
 237 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
 238 always_inline uword
 239 ip6_unaligned_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 ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i]) & im->fib_masks[dest_length].as_uword[i])
 248         return 0;
 249     }
 250   return 1;
 251 }
 252
 253 always_inline void
 254 ip6_src_address_for_packet (ip6_main_t * im, vlib_buffer_t * p, ip6_address_t * src, u32 sw_if_index)
 255 {
 256   ip_lookup_main_t * lm = &im->lookup_main;
 257   ip_interface_address_t * ia = ip_interface_address_for_packet (lm, p, sw_if_index);
 258   ip6_address_t * a = ip_interface_address_get_address (lm, ia);
 259   *src = a[0];
 260 }
 261
 262 always_inline u32
 263 ip6_src_lookup_for_packet (ip6_main_t * im, vlib_buffer_t * b, ip6_header_t * i)
 264 {
 265   if (vnet_buffer (b)->ip.adj_index[VLIB_RX] == ~0)
 266     vnet_buffer (b)->ip.adj_index[VLIB_RX]
 267       = ip6_fib_lookup (im, vnet_buffer (b)->sw_if_index[VLIB_RX],
 268                         &i->src_address);
 269   return vnet_buffer (b)->ip.adj_index[VLIB_RX];
 270 }
 271
 272 /* Find interface address which matches destination. */
 273 always_inline ip6_address_t *
 274 ip6_interface_address_matching_destination (ip6_main_t * im, ip6_address_t * dst, u32 sw_if_index,
 275                                             ip_interface_address_t ** result_ia)
 276 {
 277   ip_lookup_main_t * lm = &im->lookup_main;
 278   ip_interface_address_t * ia;
 279   ip6_address_t * result = 0;
 280
 281   foreach_ip_interface_address (lm, ia, sw_if_index,
 282                                 1 /* honor unnumbered */,
 283   ({
 284     ip6_address_t * a = ip_interface_address_get_address (lm, ia);
 285     if (ip6_destination_matches_route (im, dst, a, ia->address_length))
 286       {
 287         result = a;
 288         break;
 289       }
 290   }));
 291   if (result_ia)
 292     *result_ia = result ? ia : 0;
 293   return result;
 294 }
 295
 296 clib_error_t *
 297 ip6_add_del_interface_address (vlib_main_t * vm, u32 sw_if_index,
 298                                ip6_address_t * address, u32 address_length,
 299                                u32 is_del);
 300
 301 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
 302
 303 /* Add/del a route to the FIB. */
 304
 305 #define IP6_ROUTE_FLAG_ADD (0 << 0)
 306 #define IP6_ROUTE_FLAG_DEL (1 << 0)
 307 #define IP6_ROUTE_FLAG_TABLE_ID  (0 << 1)
 308 #define IP6_ROUTE_FLAG_FIB_INDEX (1 << 1)
 309 #define IP6_ROUTE_FLAG_KEEP_OLD_ADJACENCY (1 << 2)
 310 #define IP6_ROUTE_FLAG_NO_REDISTRIBUTE (1 << 3)
 311 #define IP6_ROUTE_FLAG_NOT_LAST_IN_GROUP (1 << 4)
 312 /* Dynamic route created via neighbor discovery. */
 313 #define IP6_ROUTE_FLAG_NEIGHBOR (1 << 5)
 314
 315 typedef struct {
 316   /* IP6_ROUTE_FLAG_* */
 317   u32 flags;
 318
 319   /* Either index of fib or table_id to hash and get fib.
 320      IP6_ROUTE_FLAG_FIB_INDEX specifies index; otherwise table_id is assumed. */
 321   u32 table_index_or_table_id;
 322
 323   /* Destination address (prefix) and length. */
 324   ip6_address_t dst_address;
 325   u32 dst_address_length;
 326
 327   /* Adjacency to use for this destination. */
 328   u32 adj_index;
 329
 330   /* If specified adjacencies to add and then
 331      use for this destination.  add_adj/n_add_adj
 332      are override adj_index if specified. */
 333   ip_adjacency_t * add_adj;
 334   u32 n_add_adj;
 335 } ip6_add_del_route_args_t;
 336
 337 void ip6_add_del_route (ip6_main_t * im, ip6_add_del_route_args_t * args);
 338
 339 void ip6_add_del_route_next_hop (ip6_main_t * im,
 340                                  u32 flags,
 341                                  ip6_address_t * dst_address,
 342                                  u32 dst_address_length,
 343                                  ip6_address_t * next_hop,
 344                                  u32 next_hop_sw_if_index,
 345                                  u32 next_hop_weight, u32 adj_index,
 346                                  u32 explicit_fib_index);
 347 u32
 348 ip6_get_route (ip6_main_t * im,
 349                u32 fib_index_or_table_id,
 350                u32 flags,
 351                ip6_address_t * address,
 352                u32 address_length);
 353
 354 void
 355 ip6_foreach_matching_route (ip6_main_t * im,
 356                             u32 table_index_or_table_id,
 357                             u32 flags,
 358                             ip6_address_t * address,
 359                             u32 address_length,
 360                             ip6_address_t ** results,
 361                             u8 ** result_length);
 362
 363 void ip6_delete_matching_routes (ip6_main_t * im,
 364                                  u32 table_index_or_table_id,
 365                                  u32 flags,
 366                                  ip6_address_t * address,
 367                                  u32 address_length);
 368
 369 void ip6_maybe_remap_adjacencies (ip6_main_t * im,
 370                                   u32 table_index_or_table_id,
 371                                   u32 flags);
 372
 373 void ip6_adjacency_set_interface_route (vnet_main_t * vnm,
 374                                         ip_adjacency_t * adj,
 375                                         u32 sw_if_index,
 376                                         u32 if_address_index);
 377
 378 clib_error_t *
 379 ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst, u32 sw_if_index);
 380
 381 clib_error_t *
 382 ip6_set_neighbor_limit (u32 neighbor_limit);
 383
 384 uword
 385 ip6_tcp_register_listener (vlib_main_t * vm,
 386                            u16 dst_port,
 387                            u32 next_node_index);
 388 uword
 389 ip6_udp_register_listener (vlib_main_t * vm,
 390                            u16 dst_port,
 391                            u32 next_node_index);
 392
 393 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0, ip6_header_t * ip0, int *bogus_lengthp);
 394
 395 void ip6_register_protocol (u32 protocol, u32 node_index);
 396
 397 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
 398
 399 int
 400 vnet_set_ip6_ethernet_neighbor (vlib_main_t * vm,
 401                                 u32 sw_if_index,
 402                                 ip6_address_t * a,
 403                                 u8 * link_layer_address,
 404                                 uword n_bytes_link_layer_address);
 405 int
 406 vnet_unset_ip6_ethernet_neighbor (vlib_main_t * vm,
 407                                   u32 sw_if_index,
 408                                   ip6_address_t * a,
 409                                   u8 * link_layer_address,
 410                                   uword n_bytes_link_layer_address);
 411 void
 412 vnet_ip6_fib_init (ip6_main_t * im, u32 fib_index);
 413
 414 void
 415 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t *ip,
 416                                                   u8 *mac);
 417
 418 void
 419 ip6_ethernet_mac_address_from_link_local_address (u8 *mac,
 420                                                   ip6_address_t *ip);
 421
 422 int vnet_set_ip6_flow_hash (u32 table_id, u32 flow_hash_config);
 423
 424 int
 425 ip6_neighbor_ra_config(vlib_main_t * vm, u32 sw_if_index,
 426                        u8 surpress, u8 managed, u8 other,
 427                        u8 ll_option,  u8 send_unicast,  u8 cease,
 428                        u8 use_lifetime,  u32 lifetime,
 429                        u32 initial_count,  u32 initial_interval,
 430                        u32 max_interval,  u32 min_interval,
 431                        u8 is_no);
 432
 433 int
 434 ip6_neighbor_ra_prefix(vlib_main_t * vm, u32 sw_if_index,
 435                        ip6_address_t *prefix_addr,  u8 prefix_len,
 436                        u8 use_default,  u32 val_lifetime, u32 pref_lifetime,
 437                        u8 no_advertise,  u8 off_link, u8 no_autoconfig, u8 no_onlink,
 438                        u8 is_no);
 439
 440
 441 clib_error_t *
 442 enable_ip6_interface(vlib_main_t * vm,
 443                      u32 sw_if_index);
 444
 445 clib_error_t *
 446 disable_ip6_interface(vlib_main_t * vm,
 447                      u32 sw_if_index);
 448
 449 int
 450 ip6_interface_enabled(vlib_main_t * vm,
 451                       u32 sw_if_index);
 452
 453 clib_error_t *
 454 set_ip6_link_local_address(vlib_main_t * vm,
 455                            u32 sw_if_index,
 456                            ip6_address_t *address,
 457                            u8 address_length);
 458
 459 void vnet_register_ip6_neighbor_resolution_event(vnet_main_t * vnm,
 460                                                  void * address_arg,
 461                                                  uword node_index,
 462                                                  uword type_opaque,
 463                                                  uword data);
 464
 465 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
 466                                  u32 table_index);
 467 extern vlib_node_registration_t ip6_lookup_node;
 468
 469 /* Compute flow hash.  We'll use it to select which Sponge to use for this
 470    flow.  And other things. */
 471 always_inline u32
 472 ip6_compute_flow_hash (ip6_header_t * ip, u32 flow_hash_config)
 473 {
 474     tcp_header_t * tcp = (void *) (ip + 1);
 475     u64 a, b, c;
 476     u64 t1, t2;
 477     uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
 478                         || ip->protocol == IP_PROTOCOL_UDP);
 479
 480     t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
 481     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
 482
 483     t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
 484     t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
 485
 486     a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
 487     b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
 488     b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
 489
 490     t1 = is_tcp_udp ? tcp->ports.src : 0;
 491     t2 = is_tcp_udp ? tcp->ports.dst : 0;
 492
 493     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
 494     t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
 495
 496     c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
 497         ((t1<<16) | t2) : ((t2<<16) | t1);
 498
 499     hash_mix64 (a, b, c);
 500     return (u32) c;
 501 }
 502
 503 #endif /* included_ip_ip6_h */