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