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
 145   /** Built-in unicast feature path indice, see @ref ip_feature_init_cast()  */
 146   u32 ip4_unicast_rx_feature_check_access;
 147   /** Built-in unicast feature path indice, see @ref ip_feature_init_cast()  */
 148   u32 ip4_unicast_rx_feature_source_reachable_via_rx;
 149   /** Built-in unicast feature path indice, see @ref ip_feature_init_cast()  */
 150   u32 ip4_unicast_rx_feature_source_reachable_via_any;
 151   /** Built-in unicast feature path indice, see @ref ip_feature_init_cast()  */
 152   u32 ip4_unicast_rx_feature_policer_classify;
 153   /** Built-in unicast feature path indice, see @ref ip_feature_init_cast()  */
 154   u32 ip4_unicast_rx_feature_ipsec;
 155   /** Built-in unicast feature path indice, see @ref ip_feature_init_cast()  */
 156   u32 ip4_unicast_rx_feature_vpath;
 157   /** Built-in unicast feature path indice, see @ref ip_feature_init_cast()  */
 158   u32 ip4_unicast_rx_feature_lookup;
 159   /** Built-in unicast feature path indice, see @ref ip_feature_init_cast()  */
 160   u32 ip4_unicast_rx_feature_source_and_port_range_check;
 161
 162   /** Built-in multicast feature path indices */
 163   u32 ip4_multicast_rx_feature_vpath;
 164   /** Built-in multicast feature path indices */
 165   u32 ip4_multicast_rx_feature_lookup;
 166
 167   /** Save results for show command */
 168   char ** feature_nodes[VNET_N_CAST];
 169
 170   /** Seed for Jenkins hash used to compute ip4 flow hash. */
 171   u32 flow_hash_seed;
 172
 173   /** @brief Template information for VPP generated packets */
 174   struct {
 175     /** TTL to use for host generated packets. */
 176     u8 ttl;
 177
 178     /** TOS byte to use for host generated packets. */
 179     u8 tos;
 180
 181     u8 pad[2];
 182   } host_config;
 183 } ip4_main_t;
 184
 185 /** Global ip4 main structure. */
 186 extern ip4_main_t ip4_main;
 187
 188 #define VNET_IP4_UNICAST_FEATURE_INIT(x,...)                    \
 189   __VA_ARGS__ vnet_ip_feature_registration_t uc_##x;            \
 190 static void __vnet_add_feature_registration_uc_##x (void)       \
 191   __attribute__((__constructor__)) ;                            \
 192 static void __vnet_add_feature_registration_uc_##x (void)       \
 193 {                                                               \
 194   ip4_main_t * im = &ip4_main;                                  \
 195   uc_##x.next = im->next_uc_feature;                            \
 196   im->next_uc_feature = &uc_##x;                                \
 197 }                                                               \
 198 __VA_ARGS__ vnet_ip_feature_registration_t uc_##x
 199
 200 #define VNET_IP4_MULTICAST_FEATURE_INIT(x,...)                  \
 201   __VA_ARGS__ vnet_ip_feature_registration_t mc_##x;            \
 202 static void __vnet_add_feature_registration_mc_##x (void)       \
 203   __attribute__((__constructor__)) ;                            \
 204 static void __vnet_add_feature_registration_mc_##x (void)       \
 205 {                                                               \
 206   ip4_main_t * im = &ip4_main;                                  \
 207   mc_##x.next = im->next_mc_feature;                            \
 208   im->next_mc_feature = &mc_##x;                                \
 209 }                                                               \
 210 __VA_ARGS__ vnet_ip_feature_registration_t mc_##x
 211
 212
 213 /* Global ip4 input node.  Errors get attached to ip4 input node. */
 214 extern vlib_node_registration_t ip4_input_node;
 215 extern vlib_node_registration_t ip4_lookup_node;
 216 extern vlib_node_registration_t ip4_rewrite_node;
 217 extern vlib_node_registration_t ip4_rewrite_local_node;
 218 extern vlib_node_registration_t ip4_arp_node;
 219
 220 u32 ip4_fib_lookup_with_table (ip4_main_t * im, u32 fib_index, ip4_address_t * dst,
 221                                u32 disable_default_route);
 222
 223 always_inline u32
 224 ip4_fib_lookup_buffer (ip4_main_t * im, u32 fib_index, ip4_address_t * dst,
 225                        vlib_buffer_t * b)
 226 {
 227   return ip4_fib_lookup_with_table (im, fib_index, dst,
 228                                     /* disable_default_route */ 0);
 229 }
 230
 231 always_inline u32
 232 ip4_fib_lookup (ip4_main_t * im, u32 sw_if_index, ip4_address_t * dst)
 233 {
 234   u32 fib_index = vec_elt (im->fib_index_by_sw_if_index, sw_if_index);
 235   return ip4_fib_lookup_with_table (im, fib_index, dst,
 236                                     /* disable_default_route */ 0);
 237 }
 238
 239 always_inline uword
 240 ip4_destination_matches_route (ip4_main_t * im,
 241                                ip4_address_t * key,
 242                                ip4_address_t * dest,
 243                                uword dest_length)
 244 { return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]); }
 245
 246 always_inline uword
 247 ip4_destination_matches_interface (ip4_main_t * im,
 248                                    ip4_address_t * key,
 249                                    ip_interface_address_t * ia)
 250 {
 251   ip4_address_t * a = ip_interface_address_get_address (&im->lookup_main, ia);
 252   return ip4_destination_matches_route (im, key, a, ia->address_length);
 253 }
 254
 255 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
 256 always_inline uword
 257 ip4_unaligned_destination_matches_route (ip4_main_t * im,
 258                                          ip4_address_t * key,
 259                                          ip4_address_t * dest,
 260                                          uword dest_length)
 261 { return 0 == ((clib_mem_unaligned (&key->data_u32, u32) ^ dest->data_u32) & im->fib_masks[dest_length]); }
 262
 263 always_inline int
 264 ip4_src_address_for_packet (ip4_main_t * im, vlib_buffer_t * p, ip4_address_t * src, u32 sw_if_index)
 265 {
 266   ip_lookup_main_t * lm = &im->lookup_main;
 267   ip_interface_address_t * ia = ip_interface_address_for_packet (lm, p, sw_if_index);
 268   if (ia == NULL)
 269     return -1;
 270   ip4_address_t * a = ip_interface_address_get_address (lm, ia);
 271   *src = a[0];
 272   return 0;
 273 }
 274
 275 /* Find interface address which matches destination. */
 276 always_inline ip4_address_t *
 277 ip4_interface_address_matching_destination (ip4_main_t * im, ip4_address_t * dst, u32 sw_if_index,
 278                                             ip_interface_address_t ** result_ia)
 279 {
 280   ip_lookup_main_t * lm = &im->lookup_main;
 281   ip_interface_address_t * ia;
 282   ip4_address_t * result = 0;
 283
 284   foreach_ip_interface_address (lm, ia, sw_if_index,
 285                                 1 /* honor unnumbered */,
 286   ({
 287     ip4_address_t * a = ip_interface_address_get_address (lm, ia);
 288     if (ip4_destination_matches_route (im, dst, a, ia->address_length))
 289       {
 290         result = a;
 291         break;
 292       }
 293   }));
 294   if (result_ia)
 295     *result_ia = result ? ia : 0;
 296   return result;
 297 }
 298
 299 clib_error_t *
 300 ip4_add_del_interface_address (vlib_main_t * vm, u32 sw_if_index,
 301                                ip4_address_t * address, u32 address_length,
 302                                u32 is_del);
 303
 304 int ip4_address_compare (ip4_address_t * a1, ip4_address_t * a2);
 305
 306 /* Add/del a route to the FIB. */
 307
 308 #define IP4_ROUTE_FLAG_ADD (0 << 0)
 309 #define IP4_ROUTE_FLAG_DEL (1 << 0)
 310 #define IP4_ROUTE_FLAG_TABLE_ID  (0 << 1)
 311 #define IP4_ROUTE_FLAG_FIB_INDEX (1 << 1)
 312 #define IP4_ROUTE_FLAG_KEEP_OLD_ADJACENCY (1 << 2)
 313 #define IP4_ROUTE_FLAG_NO_REDISTRIBUTE (1 << 3)
 314 /* Not last add/del in group.  Facilities batching requests into packets. */
 315 #define IP4_ROUTE_FLAG_NOT_LAST_IN_GROUP (1 << 4)
 316 /* Dynamic route created via ARP reply. */
 317 #define IP4_ROUTE_FLAG_NEIGHBOR (1 << 5)
 318
 319 typedef struct {
 320   /* IP4_ROUTE_FLAG_* */
 321   u32 flags;
 322
 323   /* Either index of fib or table_id to hash and get fib.
 324      IP4_ROUTE_FLAG_FIB_INDEX specifies index; otherwise table_id is assumed. */
 325   u32 table_index_or_table_id;
 326
 327   /* Destination address (prefix) and length. */
 328   ip4_address_t dst_address;
 329   u32 dst_address_length;
 330
 331   /* Adjacency to use for this destination. */
 332   u32 adj_index;
 333
 334   /* If specified adjacencies to add and then
 335      use for this destination.  add_adj/n_add_adj
 336      are override adj_index if specified. */
 337   ip_adjacency_t * add_adj;
 338   u32 n_add_adj;
 339 } ip4_add_del_route_args_t;
 340
 341 /**
 342  * \brief Get or create an IPv4 fib.
 343  *
 344  * Get or create an IPv4 fib with the provided fib ID or index.
 345  * The fib ID is a possibly-sparse user-defined value while
 346  * the fib index defines the position of the fib in the fib vector.
 347  *
 348  * \param im
 349  *      ip4_main pointer.
 350  * \param table_index_or_id
 351  *      The table index if \c IP4_ROUTE_FLAG_FIB_INDEX bit is set in \p flags.
 352  *      Otherwise, when set to \c ~0, an arbitrary and unused fib ID is picked
 353  *      and can be retrieved with \c ret->table_id.
 354  *      Otherwise, the fib ID to be used to retrieve or create the desired fib.
 355  * \param flags
 356  *      Indicates whether \p table_index_or_id is the fib index or ID.
 357  *      When the bit \c IP4_ROUTE_FLAG_FIB_INDEX is set, \p table_index_or_id
 358  *      is considered as the fib index, and the fib ID otherwise.
 359  * \returns A pointer to the retrieved or created fib.
 360  *
 361  * \remark When getting a fib with the fib index, the fib MUST already exist.
 362  */
 363 ip4_fib_t *
 364 find_ip4_fib_by_table_index_or_id (ip4_main_t * im,
 365                                    u32 table_index_or_id, u32 flags);
 366
 367 void ip4_add_del_route (ip4_main_t * im, ip4_add_del_route_args_t * args);
 368
 369 void ip4_add_del_route_next_hop (ip4_main_t * im,
 370                                  u32 flags,
 371                                  ip4_address_t * dst_address,
 372                                  u32 dst_address_length,
 373                                  ip4_address_t * next_hop,
 374                                  u32 next_hop_sw_if_index,
 375                                  u32 next_hop_weight, u32 adj_index,
 376                                  u32 explicit_fib_index);
 377
 378 u32
 379 ip4_route_get_next_hop_adj (ip4_main_t * im,
 380                             u32 fib_index,
 381                             ip4_address_t *next_hop,
 382                             u32 next_hop_sw_if_index,
 383                             u32 explicit_fib_index);
 384
 385 void *
 386 ip4_get_route (ip4_main_t * im,
 387                u32 fib_index_or_table_id,
 388                u32 flags,
 389                u8 * address,
 390                u32 address_length);
 391
 392 void
 393 ip4_foreach_matching_route (ip4_main_t * im,
 394                             u32 table_index_or_table_id,
 395                             u32 flags,
 396                             ip4_address_t * address,
 397                             u32 address_length,
 398                             ip4_address_t ** results,
 399                             u8 ** result_lengths);
 400
 401 void ip4_delete_matching_routes (ip4_main_t * im,
 402                                  u32 table_index_or_table_id,
 403                                  u32 flags,
 404                                  ip4_address_t * address,
 405                                  u32 address_length);
 406
 407 void ip4_maybe_remap_adjacencies (ip4_main_t * im,
 408                                   u32 table_index_or_table_id,
 409                                   u32 flags);
 410
 411 void ip4_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 ip4_address_t *
 417 ip4_interface_first_address (ip4_main_t * im, u32 sw_if_index,
 418                              ip_interface_address_t ** result_ia);
 419
 420 /* Send an ARP request to see if given destination is reachable on given interface. */
 421 clib_error_t *
 422 ip4_probe_neighbor (vlib_main_t * vm, ip4_address_t * dst, u32 sw_if_index);
 423
 424 clib_error_t *
 425 ip4_set_arp_limit (u32 arp_limit);
 426
 427 uword
 428 ip4_udp_register_listener (vlib_main_t * vm,
 429                            u16 dst_port,
 430                            u32 next_node_index);
 431
 432 void
 433 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type,
 434                         u32 node_index);
 435
 436 u16 ip4_tcp_udp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0, ip4_header_t * ip0);
 437
 438 void ip4_register_protocol (u32 protocol, u32 node_index);
 439
 440 serialize_function_t serialize_vnet_ip4_main, unserialize_vnet_ip4_main;
 441
 442 int vnet_set_ip4_flow_hash (u32 table_id, u32 flow_hash_config);
 443
 444 void ip4_mtrie_init (ip4_fib_mtrie_t * m);
 445
 446 int vnet_set_ip4_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
 447                                  u32 table_index);
 448
 449 /* Compute flow hash.  We'll use it to select which adjacency to use for this
 450    flow.  And other things. */
 451 always_inline u32
 452 ip4_compute_flow_hash (ip4_header_t * ip, u32 flow_hash_config)
 453 {
 454     tcp_header_t * tcp = (void *) (ip + 1);
 455     u32 a, b, c, t1, t2;
 456     uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
 457                         || ip->protocol == IP_PROTOCOL_UDP);
 458
 459     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR)
 460         ? ip->src_address.data_u32 : 0;
 461     t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR)
 462         ? ip->dst_address.data_u32 : 0;
 463
 464     a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
 465     b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
 466     b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
 467
 468     t1 = is_tcp_udp ? tcp->ports.src : 0;
 469     t2 = is_tcp_udp ? tcp->ports.dst : 0;
 470
 471     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
 472     t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
 473
 474     c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
 475         (t1<<16) | t2 : (t2<<16) | t1;
 476
 477     hash_v3_mix32 (a, b, c);
 478     hash_v3_finalize32 (a, b, c);
 479
 480     return c;
 481 }
 482
 483 #endif /* included_ip_ip4_h */