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