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 * fib_entry_by_dst_address[33];
  51
  52   /* Mtrie for fast lookups.  Hash is used to maintain overlapping prefixes. */
  53   ip4_fib_mtrie_t mtrie;
  54
  55   /* Table ID (hash key) for this FIB. */
  56   u32 table_id;
  57
  58   /* Index into FIB vector. */
  59   u32 index;
  60
  61   /* flow hash configuration */
  62   flow_hash_config_t flow_hash_config;
  63
  64   /* N-tuple classifier indices */
  65   u32 fwd_classify_table_index;
  66   u32 rev_classify_table_index;
  67
  68 } ip4_fib_t;
  69
  70 struct ip4_main_t;
  71
  72 typedef void (ip4_add_del_interface_address_function_t)
  73   (struct ip4_main_t * im,
  74    uword opaque,
  75    u32 sw_if_index,
  76    ip4_address_t * address,
  77    u32 address_length,
  78    u32 if_address_index,
  79    u32 is_del);
  80
  81 typedef struct {
  82   ip4_add_del_interface_address_function_t * function;
  83   uword function_opaque;
  84 } ip4_add_del_interface_address_callback_t;
  85
  86 /**
  87  * @brief IPv4 main type.
  88  *
  89  * State of IPv4 VPP processing including:
  90  * - FIBs
  91  * - Feature indices used in feature topological sort
  92  * - Feature node run time references
  93  */
  94
  95 typedef struct ip4_main_t {
  96   ip_lookup_main_t lookup_main;
  97
  98   /** Vector of FIBs. */
  99   struct fib_table_t_ * fibs;
 100
 101   u32 fib_masks[33];
 102
 103   /** Table index indexed by software interface. */
 104   u32 * fib_index_by_sw_if_index;
 105
 106   /* IP4 enabled count by software interface */
 107   u8 * ip_enabled_by_sw_if_index;
 108
 109   /** Hash table mapping table id to fib index.
 110      ID space is not necessarily dense; index space is dense. */
 111   uword * fib_index_by_table_id;
 112
 113   /** Functions to call when interface address changes. */
 114   ip4_add_del_interface_address_callback_t * add_del_interface_address_callbacks;
 115
 116   /** Template used to generate IP4 ARP packets. */
 117   vlib_packet_template_t ip4_arp_request_packet_template;
 118
 119   /** Feature path configuration lists */
 120   vnet_ip_feature_registration_t * next_feature[VNET_N_IP_FEAT];
 121
 122   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 123   u32 ip4_unicast_rx_feature_check_access;
 124   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 125   u32 ip4_unicast_rx_feature_source_reachable_via_rx;
 126   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 127   u32 ip4_unicast_rx_feature_source_reachable_via_any;
 128   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 129   u32 ip4_unicast_rx_feature_policer_classify;
 130   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 131   u32 ip4_unicast_rx_feature_ipsec;
 132   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 133   u32 ip4_unicast_rx_feature_vpath;
 134   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 135   u32 ip4_unicast_rx_feature_lookup;
 136   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 137   u32 ip4_unicast_rx_feature_source_and_port_range_check;
 138   /** Built-in unicast feature path indice, see @ref ip_feature_init_cast()  */
 139   u32 ip4_unicast_rx_feature_drop;
 140
 141   /** Built-in multicast feature path index */
 142   u32 ip4_multicast_rx_feature_vpath;
 143   /** Built-in multicast feature path index */
 144   u32 ip4_multicast_rx_feature_lookup;
 145   /** Built-in multicast feature path indices */
 146   u32 ip4_multicast_rx_feature_drop;
 147
 148   /** Built-in unicast feature path index, see @ref ip_feature_init_cast()  */
 149   u32 ip4_unicast_tx_feature_source_and_port_range_check;
 150
 151   /** Built-in tx feature path index */
 152   u32 ip4_tx_feature_interface_output;
 153
 154   /** Save results for show command */
 155   char ** feature_nodes[VNET_N_IP_FEAT];
 156
 157   /** Seed for Jenkins hash used to compute ip4 flow hash. */
 158   u32 flow_hash_seed;
 159
 160   /** @brief Template information for VPP generated packets */
 161   struct {
 162     /** TTL to use for host generated packets. */
 163     u8 ttl;
 164
 165     /** TOS byte to use for host generated packets. */
 166     u8 tos;
 167
 168     u8 pad[2];
 169   } host_config;
 170 } ip4_main_t;
 171
 172 /** Global ip4 main structure. */
 173 extern ip4_main_t ip4_main;
 174
 175 #define VNET_IP4_UNICAST_FEATURE_INIT(x,...)                    \
 176   __VA_ARGS__ vnet_ip_feature_registration_t uc_##x;            \
 177 static void __vnet_add_feature_registration_uc_##x (void)       \
 178   __attribute__((__constructor__)) ;                            \
 179 static void __vnet_add_feature_registration_uc_##x (void)       \
 180 {                                                               \
 181   ip4_main_t * im = &ip4_main;                                  \
 182   uc_##x.next = im->next_feature[VNET_IP_RX_UNICAST_FEAT];      \
 183   im->next_feature[VNET_IP_RX_UNICAST_FEAT] = &uc_##x;          \
 184 }                                                               \
 185 __VA_ARGS__ vnet_ip_feature_registration_t uc_##x
 186
 187 #define VNET_IP4_MULTICAST_FEATURE_INIT(x,...)                  \
 188   __VA_ARGS__ vnet_ip_feature_registration_t mc_##x;            \
 189 static void __vnet_add_feature_registration_mc_##x (void)       \
 190   __attribute__((__constructor__)) ;                            \
 191 static void __vnet_add_feature_registration_mc_##x (void)       \
 192 {                                                               \
 193   ip4_main_t * im = &ip4_main;                                  \
 194   mc_##x.next = im->next_feature[VNET_IP_RX_MULTICAST_FEAT];    \
 195   im->next_feature[VNET_IP_RX_MULTICAST_FEAT] = &mc_##x;        \
 196 }                                                               \
 197 __VA_ARGS__ vnet_ip_feature_registration_t mc_##x
 198
 199 #define VNET_IP4_TX_FEATURE_INIT(x,...)                         \
 200   __VA_ARGS__ vnet_ip_feature_registration_t tx_##x;            \
 201 static void __vnet_add_feature_registration_tx_##x (void)       \
 202   __attribute__((__constructor__)) ;                            \
 203 static void __vnet_add_feature_registration_tx_##x (void)       \
 204 {                                                               \
 205   ip4_main_t * im = &ip4_main;                                  \
 206   tx_##x.next = im->next_feature[VNET_IP_TX_FEAT];              \
 207   im->next_feature[VNET_IP_TX_FEAT] = &tx_##x;                  \
 208 }                                                               \
 209 __VA_ARGS__ vnet_ip_feature_registration_t tx_##x
 210
 211
 212 /** Global ip4 input node.  Errors get attached to ip4 input node. */
 213 extern vlib_node_registration_t ip4_input_node;
 214 extern vlib_node_registration_t ip4_lookup_node;
 215 extern vlib_node_registration_t ip4_rewrite_node;
 216 extern vlib_node_registration_t ip4_rewrite_local_node;
 217 extern vlib_node_registration_t ip4_arp_node;
 218 extern vlib_node_registration_t ip4_glean_node;
 219 extern vlib_node_registration_t ip4_midchain_node;
 220
 221 always_inline uword
 222 ip4_destination_matches_route (const ip4_main_t * im,
 223                                const ip4_address_t * key,
 224                                const ip4_address_t * dest,
 225                                uword dest_length)
 226 { return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]); }
 227
 228 always_inline uword
 229 ip4_destination_matches_interface (ip4_main_t * im,
 230                                    ip4_address_t * key,
 231                                    ip_interface_address_t * ia)
 232 {
 233   ip4_address_t * a = ip_interface_address_get_address (&im->lookup_main, ia);
 234   return ip4_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 ip4_unaligned_destination_matches_route (ip4_main_t * im,
 240                                          ip4_address_t * key,
 241                                          ip4_address_t * dest,
 242                                          uword dest_length)
 243 { return 0 == ((clib_mem_unaligned (&key->data_u32, u32) ^ dest->data_u32) & im->fib_masks[dest_length]); }
 244
 245 always_inline int
 246 ip4_src_address_for_packet (ip_lookup_main_t * lm,
 247                             u32 sw_if_index,
 248                             ip4_address_t * src)
 249 {
 250     u32 if_add_index =
 251         lm->if_address_pool_index_by_sw_if_index[sw_if_index];
 252     if (PREDICT_TRUE(if_add_index != ~0)) {
 253         ip_interface_address_t *if_add =
 254             pool_elt_at_index(lm->if_address_pool, if_add_index);
 255         ip4_address_t *if_ip =
 256             ip_interface_address_get_address(lm, if_add);
 257         *src = *if_ip;
 258         return 0;
 259     }
 260     else
 261     {
 262         ASSERT(0);
 263         src->as_u32 = 0;
 264     }
 265     return (!0);
 266 }
 267
 268 /* Find interface address which matches destination. */
 269 always_inline ip4_address_t *
 270 ip4_interface_address_matching_destination (ip4_main_t * im, ip4_address_t * dst, u32 sw_if_index,
 271                                             ip_interface_address_t ** result_ia)
 272 {
 273   ip_lookup_main_t * lm = &im->lookup_main;
 274   ip_interface_address_t * ia;
 275   ip4_address_t * result = 0;
 276
 277   foreach_ip_interface_address (lm, ia, sw_if_index,
 278                                 1 /* honor unnumbered */,
 279   ({
 280     ip4_address_t * a = ip_interface_address_get_address (lm, ia);
 281     if (ip4_destination_matches_route (im, dst, a, ia->address_length))
 282       {
 283         result = a;
 284         break;
 285       }
 286   }));
 287   if (result_ia)
 288     *result_ia = result ? ia : 0;
 289   return result;
 290 }
 291
 292 ip4_address_t *
 293 ip4_interface_first_address (ip4_main_t * im, u32 sw_if_index,
 294                              ip_interface_address_t ** result_ia);
 295
 296 clib_error_t *
 297 ip4_add_del_interface_address (vlib_main_t * vm, u32 sw_if_index,
 298                                ip4_address_t * address, u32 address_length,
 299                                u32 is_del);
 300
 301 void
 302 ip4_sw_interface_enable_disable (u32 sw_if_index,
 303                                  u32 is_enable);
 304
 305 int ip4_address_compare (ip4_address_t * a1, ip4_address_t * a2);
 306
 307 /* Send an ARP request to see if given destination is reachable on given interface. */
 308 clib_error_t *
 309 ip4_probe_neighbor (vlib_main_t * vm, ip4_address_t * dst, u32 sw_if_index);
 310
 311 clib_error_t *
 312 ip4_set_arp_limit (u32 arp_limit);
 313
 314 uword
 315 ip4_udp_register_listener (vlib_main_t * vm,
 316                            u16 dst_port,
 317                            u32 next_node_index);
 318
 319 void
 320 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type,
 321                         u32 node_index);
 322
 323 u16 ip4_tcp_udp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0, ip4_header_t * ip0);
 324
 325 void ip4_register_protocol (u32 protocol, u32 node_index);
 326
 327 serialize_function_t serialize_vnet_ip4_main, unserialize_vnet_ip4_main;
 328
 329 int vnet_set_ip4_flow_hash (u32 table_id, flow_hash_config_t flow_hash_config);
 330
 331 void ip4_mtrie_init (ip4_fib_mtrie_t * m);
 332
 333 int vnet_set_ip4_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
 334                                  u32 table_index);
 335
 336 /* Compute flow hash.  We'll use it to select which adjacency to use for this
 337    flow.  And other things. */
 338 always_inline u32
 339 ip4_compute_flow_hash (const ip4_header_t * ip,
 340                        flow_hash_config_t flow_hash_config)
 341 {
 342     tcp_header_t * tcp = (void *) (ip + 1);
 343     u32 a, b, c, t1, t2;
 344     uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
 345                         || ip->protocol == IP_PROTOCOL_UDP);
 346
 347     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR)
 348         ? ip->src_address.data_u32 : 0;
 349     t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR)
 350         ? ip->dst_address.data_u32 : 0;
 351
 352     a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
 353     b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
 354     b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
 355
 356     t1 = is_tcp_udp ? tcp->ports.src : 0;
 357     t2 = is_tcp_udp ? tcp->ports.dst : 0;
 358
 359     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
 360     t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
 361
 362     c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
 363         (t1<<16) | t2 : (t2<<16) | t1;
 364
 365     hash_v3_mix32 (a, b, c);
 366     hash_v3_finalize32 (a, b, c);
 367
 368     return c;
 369 }
 370
 371 #endif /* included_ip_ip4_h */