vnet/vnet/ip/ip4.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/ip4.h: ip4 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_ip4_h
  41 #define included_ip_ip4_h
  42
  43 #include <vnet/ip/ip4_mtrie.h>
  44 #include <vnet/ip/ip4_packet.h>
  45 #include <vnet/ip/lookup.h>
  46 #include <vnet/ip/ip_feature_registration.h>
  47
  48 typedef struct ip4_fib_t {
  49   /* Hash table for each prefix length mapping. */
  50   uword * adj_index_by_dst_address[33];
  51
  52   /* Temporary vectors for holding new/old values for hash_set. */
  53   uword * new_hash_values, * old_hash_values;
  54
  55   /* Mtrie for fast lookups.  Hash is used to maintain overlapping prefixes. */
  56   ip4_fib_mtrie_t mtrie;
  57
  58   /* Table ID (hash key) for this FIB. */
  59   u32 table_id;
  60
  61   /* Index into FIB vector. */
  62   u32 index;
  63
  64   /* flow hash configuration */
  65   u32 flow_hash_config;
  66
  67   /* N-tuple classifier indices */
  68   u32 fwd_classify_table_index;
  69   u32 rev_classify_table_index;
  70
  71 } ip4_fib_t;
  72
  73 struct ip4_main_t;
  74
  75 typedef void (ip4_add_del_route_function_t)
  76   (struct ip4_main_t * im,
  77    uword opaque,
  78    ip4_fib_t * fib,
  79    u32 flags,
  80    ip4_address_t * address,
  81    u32 address_length,
  82    void * old_result,
  83    void * new_result);
  84
  85 typedef struct {
  86   ip4_add_del_route_function_t * function;
  87   uword required_flags;
  88   uword function_opaque;
  89 } ip4_add_del_route_callback_t;
  90
  91 typedef void (ip4_add_del_interface_address_function_t)
  92   (struct ip4_main_t * im,
  93    uword opaque,
  94    u32 sw_if_index,
  95    ip4_address_t * address,
  96    u32 address_length,
  97    u32 if_address_index,
  98    u32 is_del);
  99
 100 typedef struct {
 101   ip4_add_del_interface_address_function_t * function;
 102   uword function_opaque;
 103 } ip4_add_del_interface_address_callback_t;
 104
 105 /**
 106  * @brief IPv4 main type.
 107  *
 108  * State of IPv4 VPP processing including:
 109  * - FIBs
 110  * - Feature indices used in feature topological sort
 111  * - Feature node run time references
 112  */
 113
 114 typedef struct ip4_main_t {
 115   ip_lookup_main_t lookup_main;
 116
 117   /** Vector of FIBs. */
 118   ip4_fib_t * fibs;
 119
 120   u32 fib_masks[33];
 121
 122   /** Table index indexed by software interface. */
 123   u32 * fib_index_by_sw_if_index;
 124
 125   /** Hash table mapping table id to fib index.
 126      ID space is not necessarily dense; index space is dense. */
 127   uword * fib_index_by_table_id;
 128
 129   /** Vector of functions to call when routes are added/deleted. */
 130   ip4_add_del_route_callback_t * add_del_route_callbacks;
 131
 132   /** Hash table mapping interface route rewrite adjacency index by sw if index. */
 133   uword * interface_route_adj_index_by_sw_if_index;
 134
 135   /** Functions to call when interface address changes. */
 136   ip4_add_del_interface_address_callback_t * add_del_interface_address_callbacks;
 137
 138   /** Template used to generate IP4 ARP packets. */
 139   vlib_packet_template_t ip4_arp_request_packet_template;
 140
 141   /** Feature path configuration lists */
 142   vnet_ip_feature_registration_t * next_uc_feature;
 143   vnet_ip_feature_registration_t * next_mc_feature;
 144   vnet_ip_feature_registration_t * next_tx_feature;
 145
 146   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 147   u32 ip4_unicast_rx_feature_check_access;
 148   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 149   u32 ip4_unicast_rx_feature_source_reachable_via_rx;
 150   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 151   u32 ip4_unicast_rx_feature_source_reachable_via_any;
 152   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 153   u32 ip4_unicast_rx_feature_policer_classify;
 154   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 155   u32 ip4_unicast_rx_feature_ipsec;
 156   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 157   u32 ip4_unicast_rx_feature_vpath;
 158   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 159   u32 ip4_unicast_rx_feature_lookup;
 160   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 161   u32 ip4_unicast_rx_feature_source_and_port_range_check;
 162
 163   /** Built-in multicast feature path index */
 164   u32 ip4_multicast_rx_feature_vpath;
 165   /** Built-in multicast feature path index */
 166   u32 ip4_multicast_rx_feature_lookup;
 167
 168   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 169   u32 ip4_unicast_tx_feature_source_and_port_range_check;
 170
 171   /** Built-in tx feature path index */
 172   u32 ip4_tx_feature_interface_output;
 173
 174   /** Save results for show command */
 175   char ** feature_nodes[VNET_N_IP_FEAT];
 176
 177   /** Seed for Jenkins hash used to compute ip4 flow hash. */
 178   u32 flow_hash_seed;
 179
 180   /** @brief Template information for VPP generated packets */
 181   struct {
 182     /** TTL to use for host generated packets. */
 183     u8 ttl;
 184
 185     /** TOS byte to use for host generated packets. */
 186     u8 tos;
 187
 188     u8 pad[2];
 189   } host_config;
 190 } ip4_main_t;
 191
 192 /** Global ip4 main structure. */
 193 extern ip4_main_t ip4_main;
 194
 195 #define VNET_IP4_UNICAST_FEATURE_INIT(x,...)                    \
 196   __VA_ARGS__ vnet_ip_feature_registration_t uc_##x;            \
 197 static void __vnet_add_feature_registration_uc_##x (void)       \
 198   __attribute__((__constructor__)) ;                            \
 199 static void __vnet_add_feature_registration_uc_##x (void)       \
 200 {                                                               \
 201   ip4_main_t * im = &ip4_main;                                  \
 202   uc_##x.next = im->next_uc_feature;                            \
 203   im->next_uc_feature = &uc_##x;                                \
 204 }                                                               \
 205 __VA_ARGS__ vnet_ip_feature_registration_t uc_##x
 206
 207 #define VNET_IP4_MULTICAST_FEATURE_INIT(x,...)                  \
 208   __VA_ARGS__ vnet_ip_feature_registration_t mc_##x;            \
 209 static void __vnet_add_feature_registration_mc_##x (void)       \
 210   __attribute__((__constructor__)) ;                            \
 211 static void __vnet_add_feature_registration_mc_##x (void)       \
 212 {                                                               \
 213   ip4_main_t * im = &ip4_main;                                  \
 214   mc_##x.next = im->next_mc_feature;                            \
 215   im->next_mc_feature = &mc_##x;                                \
 216 }                                                               \
 217 __VA_ARGS__ vnet_ip_feature_registration_t mc_##x
 218
 219 #define VNET_IP4_TX_FEATURE_INIT(x,...)                         \
 220   __VA_ARGS__ vnet_ip_feature_registration_t tx_##x;            \
 221 static void __vnet_add_feature_registration_tx_##x (void)       \
 222   __attribute__((__constructor__)) ;                            \
 223 static void __vnet_add_feature_registration_tx_##x (void)       \
 224 {                                                               \
 225   ip4_main_t * im = &ip4_main;                                  \
 226   tx_##x.next = im->next_tx_feature;                            \
 227   im->next_tx_feature = &tx_##x;                                \
 228 }                                                               \
 229 __VA_ARGS__ vnet_ip_feature_registration_t tx_##x
 230
 231
 232 /** Global ip4 input node.  Errors get attached to ip4 input node. */
 233 extern vlib_node_registration_t ip4_input_node;
 234 extern vlib_node_registration_t ip4_lookup_node;
 235 extern vlib_node_registration_t ip4_rewrite_node;
 236 extern vlib_node_registration_t ip4_rewrite_local_node;
 237 extern vlib_node_registration_t ip4_arp_node;
 238
 239 u32 ip4_fib_lookup_with_table (ip4_main_t * im, u32 fib_index, ip4_address_t * dst,
 240                                u32 disable_default_route);
 241
 242 always_inline u32
 243 ip4_fib_lookup_buffer (ip4_main_t * im, u32 fib_index, ip4_address_t * dst,
 244                        vlib_buffer_t * b)
 245 {
 246   return ip4_fib_lookup_with_table (im, fib_index, dst,
 247                                     /* disable_default_route */ 0);
 248 }
 249
 250 always_inline u32
 251 ip4_fib_lookup (ip4_main_t * im, u32 sw_if_index, ip4_address_t * dst)
 252 {
 253   u32 fib_index = vec_elt (im->fib_index_by_sw_if_index, sw_if_index);
 254   return ip4_fib_lookup_with_table (im, fib_index, dst,
 255                                     /* disable_default_route */ 0);
 256 }
 257
 258 always_inline uword
 259 ip4_destination_matches_route (ip4_main_t * im,
 260                                ip4_address_t * key,
 261                                ip4_address_t * dest,
 262                                uword dest_length)
 263 { return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]); }
 264
 265 always_inline uword
 266 ip4_destination_matches_interface (ip4_main_t * im,
 267                                    ip4_address_t * key,
 268                                    ip_interface_address_t * ia)
 269 {
 270   ip4_address_t * a = ip_interface_address_get_address (&im->lookup_main, ia);
 271   return ip4_destination_matches_route (im, key, a, ia->address_length);
 272 }
 273
 274 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
 275 always_inline uword
 276 ip4_unaligned_destination_matches_route (ip4_main_t * im,
 277                                          ip4_address_t * key,
 278                                          ip4_address_t * dest,
 279                                          uword dest_length)
 280 { return 0 == ((clib_mem_unaligned (&key->data_u32, u32) ^ dest->data_u32) & im->fib_masks[dest_length]); }
 281
 282 always_inline int
 283 ip4_src_address_for_packet (ip4_main_t * im, vlib_buffer_t * p, ip4_address_t * src, u32 sw_if_index)
 284 {
 285   ip_lookup_main_t * lm = &im->lookup_main;
 286   ip_interface_address_t * ia = ip_interface_address_for_packet (lm, p, sw_if_index);
 287   if (ia == NULL)
 288     return -1;
 289   ip4_address_t * a = ip_interface_address_get_address (lm, ia);
 290   *src = a[0];
 291   return 0;
 292 }
 293
 294 /* Find interface address which matches destination. */
 295 always_inline ip4_address_t *
 296 ip4_interface_address_matching_destination (ip4_main_t * im, ip4_address_t * dst, u32 sw_if_index,
 297                                             ip_interface_address_t ** result_ia)
 298 {
 299   ip_lookup_main_t * lm = &im->lookup_main;
 300   ip_interface_address_t * ia;
 301   ip4_address_t * result = 0;
 302
 303   foreach_ip_interface_address (lm, ia, sw_if_index,
 304                                 1 /* honor unnumbered */,
 305   ({
 306     ip4_address_t * a = ip_interface_address_get_address (lm, ia);
 307     if (ip4_destination_matches_route (im, dst, a, ia->address_length))
 308       {
 309         result = a;
 310         break;
 311       }
 312   }));
 313   if (result_ia)
 314     *result_ia = result ? ia : 0;
 315   return result;
 316 }
 317
 318 clib_error_t *
 319 ip4_add_del_interface_address (vlib_main_t * vm, u32 sw_if_index,
 320                                ip4_address_t * address, u32 address_length,
 321                                u32 is_del);
 322
 323 int ip4_address_compare (ip4_address_t * a1, ip4_address_t * a2);
 324
 325 /* Add/del a route to the FIB. */
 326
 327 #define IP4_ROUTE_FLAG_ADD (0 << 0)
 328 #define IP4_ROUTE_FLAG_DEL (1 << 0)
 329 #define IP4_ROUTE_FLAG_TABLE_ID  (0 << 1)
 330 #define IP4_ROUTE_FLAG_FIB_INDEX (1 << 1)
 331 #define IP4_ROUTE_FLAG_KEEP_OLD_ADJACENCY (1 << 2)
 332 #define IP4_ROUTE_FLAG_NO_REDISTRIBUTE (1 << 3)
 333 /* Not last add/del in group.  Facilities batching requests into packets. */
 334 #define IP4_ROUTE_FLAG_NOT_LAST_IN_GROUP (1 << 4)
 335 /* Dynamic route created via ARP reply. */
 336 #define IP4_ROUTE_FLAG_NEIGHBOR (1 << 5)
 337
 338 typedef struct {
 339   /* IP4_ROUTE_FLAG_* */
 340   u32 flags;
 341
 342   /* Either index of fib or table_id to hash and get fib.
 343      IP4_ROUTE_FLAG_FIB_INDEX specifies index; otherwise table_id is assumed. */
 344   u32 table_index_or_table_id;
 345
 346   /* Destination address (prefix) and length. */
 347   ip4_address_t dst_address;
 348   u32 dst_address_length;
 349
 350   /* Adjacency to use for this destination. */
 351   u32 adj_index;
 352
 353   /* If specified adjacencies to add and then
 354      use for this destination.  add_adj/n_add_adj
 355      are override adj_index if specified. */
 356   ip_adjacency_t * add_adj;
 357   u32 n_add_adj;
 358 } ip4_add_del_route_args_t;
 359
 360 /**
 361  * \brief Get or create an IPv4 fib.
 362  *
 363  * Get or create an IPv4 fib with the provided fib ID or index.
 364  * The fib ID is a possibly-sparse user-defined value while
 365  * the fib index defines the position of the fib in the fib vector.
 366  *
 367  * \param im
 368  *      ip4_main pointer.
 369  * \param table_index_or_id
 370  *      The table index if \c IP4_ROUTE_FLAG_FIB_INDEX bit is set in \p flags.
 371  *      Otherwise, when set to \c ~0, an arbitrary and unused fib ID is picked
 372  *      and can be retrieved with \c ret->table_id.
 373  *      Otherwise, the fib ID to be used to retrieve or create the desired fib.
 374  * \param flags
 375  *      Indicates whether \p table_index_or_id is the fib index or ID.
 376  *      When the bit \c IP4_ROUTE_FLAG_FIB_INDEX is set, \p table_index_or_id
 377  *      is considered as the fib index, and the fib ID otherwise.
 378  * \returns A pointer to the retrieved or created fib.
 379  *
 380  * \remark When getting a fib with the fib index, the fib MUST already exist.
 381  */
 382 ip4_fib_t *
 383 find_ip4_fib_by_table_index_or_id (ip4_main_t * im,
 384                                    u32 table_index_or_id, u32 flags);
 385
 386 void ip4_add_del_route (ip4_main_t * im, ip4_add_del_route_args_t * args);
 387
 388 void ip4_add_del_route_next_hop (ip4_main_t * im,
 389                                  u32 flags,
 390                                  ip4_address_t * dst_address,
 391                                  u32 dst_address_length,
 392                                  ip4_address_t * next_hop,
 393                                  u32 next_hop_sw_if_index,
 394                                  u32 next_hop_weight, u32 adj_index,
 395                                  u32 explicit_fib_index);
 396
 397 u32
 398 ip4_route_get_next_hop_adj (ip4_main_t * im,
 399                             u32 fib_index,
 400                             ip4_address_t *next_hop,
 401                             u32 next_hop_sw_if_index,
 402                             u32 explicit_fib_index);
 403
 404 void *
 405 ip4_get_route (ip4_main_t * im,
 406                u32 fib_index_or_table_id,
 407                u32 flags,
 408                u8 * address,
 409                u32 address_length);
 410
 411 void
 412 ip4_foreach_matching_route (ip4_main_t * im,
 413                             u32 table_index_or_table_id,
 414                             u32 flags,
 415                             ip4_address_t * address,
 416                             u32 address_length,
 417                             ip4_address_t ** results,
 418                             u8 ** result_lengths);
 419
 420 void ip4_delete_matching_routes (ip4_main_t * im,
 421                                  u32 table_index_or_table_id,
 422                                  u32 flags,
 423                                  ip4_address_t * address,
 424                                  u32 address_length);
 425
 426 void ip4_maybe_remap_adjacencies (ip4_main_t * im,
 427                                   u32 table_index_or_table_id,
 428                                   u32 flags);
 429
 430 void ip4_adjacency_set_interface_route (vnet_main_t * vnm,
 431                                         ip_adjacency_t * adj,
 432                                         u32 sw_if_index,
 433                                         u32 if_address_index);
 434
 435 ip4_address_t *
 436 ip4_interface_first_address (ip4_main_t * im, u32 sw_if_index,
 437                              ip_interface_address_t ** result_ia);
 438
 439 /* Send an ARP request to see if given destination is reachable on given interface. */
 440 clib_error_t *
 441 ip4_probe_neighbor (vlib_main_t * vm, ip4_address_t * dst, u32 sw_if_index);
 442
 443 clib_error_t *
 444 ip4_set_arp_limit (u32 arp_limit);
 445
 446 uword
 447 ip4_udp_register_listener (vlib_main_t * vm,
 448                            u16 dst_port,
 449                            u32 next_node_index);
 450
 451 void
 452 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type,
 453                         u32 node_index);
 454
 455 u16 ip4_tcp_udp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0, ip4_header_t * ip0);
 456
 457 void ip4_register_protocol (u32 protocol, u32 node_index);
 458
 459 serialize_function_t serialize_vnet_ip4_main, unserialize_vnet_ip4_main;
 460
 461 int vnet_set_ip4_flow_hash (u32 table_id, u32 flow_hash_config);
 462
 463 void ip4_mtrie_init (ip4_fib_mtrie_t * m);
 464
 465 int vnet_set_ip4_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
 466                                  u32 table_index);
 467
 468 /* Compute flow hash.  We'll use it to select which adjacency to use for this
 469    flow.  And other things. */
 470 always_inline u32
 471 ip4_compute_flow_hash (ip4_header_t * ip, u32 flow_hash_config)
 472 {
 473     tcp_header_t * tcp = (void *) (ip + 1);
 474     u32 a, b, c, t1, t2;
 475     uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
 476                         || ip->protocol == IP_PROTOCOL_UDP);
 477
 478     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR)
 479         ? ip->src_address.data_u32 : 0;
 480     t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR)
 481         ? ip->dst_address.data_u32 : 0;
 482
 483     a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
 484     b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
 485     b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
 486
 487     t1 = is_tcp_udp ? tcp->ports.src : 0;
 488     t2 = is_tcp_udp ? tcp->ports.dst : 0;
 489
 490     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
 491     t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
 492
 493     c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
 494         (t1<<16) | t2 : (t2<<16) | t1;
 495
 496     hash_v3_mix32 (a, b, c);
 497     hash_v3_finalize32 (a, b, c);
 498
 499     return c;
 500 }
 501
 502 #endif /* included_ip_ip4_h */