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/feature/feature.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   /** Seed for Jenkins hash used to compute ip4 flow hash. */
 120   u32 flow_hash_seed;
 121
 122   /** @brief Template information for VPP generated packets */
 123   struct {
 124     /** TTL to use for host generated packets. */
 125     u8 ttl;
 126
 127     /** TOS byte to use for host generated packets. */
 128     u8 tos;
 129
 130     u8 pad[2];
 131   } host_config;
 132 } ip4_main_t;
 133
 134 /** Global ip4 main structure. */
 135 extern ip4_main_t ip4_main;
 136
 137 /** Global ip4 input node.  Errors get attached to ip4 input node. */
 138 extern vlib_node_registration_t ip4_input_node;
 139 extern vlib_node_registration_t ip4_lookup_node;
 140 extern vlib_node_registration_t ip4_rewrite_node;
 141 extern vlib_node_registration_t ip4_rewrite_local_node;
 142 extern vlib_node_registration_t ip4_arp_node;
 143 extern vlib_node_registration_t ip4_glean_node;
 144 extern vlib_node_registration_t ip4_midchain_node;
 145
 146 always_inline uword
 147 ip4_destination_matches_route (const ip4_main_t * im,
 148                                const ip4_address_t * key,
 149                                const ip4_address_t * dest,
 150                                uword dest_length)
 151 { return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]); }
 152
 153 always_inline uword
 154 ip4_destination_matches_interface (ip4_main_t * im,
 155                                    ip4_address_t * key,
 156                                    ip_interface_address_t * ia)
 157 {
 158   ip4_address_t * a = ip_interface_address_get_address (&im->lookup_main, ia);
 159   return ip4_destination_matches_route (im, key, a, ia->address_length);
 160 }
 161
 162 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
 163 always_inline uword
 164 ip4_unaligned_destination_matches_route (ip4_main_t * im,
 165                                          ip4_address_t * key,
 166                                          ip4_address_t * dest,
 167                                          uword dest_length)
 168 { return 0 == ((clib_mem_unaligned (&key->data_u32, u32) ^ dest->data_u32) & im->fib_masks[dest_length]); }
 169
 170 always_inline int
 171 ip4_src_address_for_packet (ip_lookup_main_t * lm,
 172                             u32 sw_if_index,
 173                             ip4_address_t * src)
 174 {
 175     u32 if_add_index =
 176         lm->if_address_pool_index_by_sw_if_index[sw_if_index];
 177     if (PREDICT_TRUE(if_add_index != ~0)) {
 178         ip_interface_address_t *if_add =
 179             pool_elt_at_index(lm->if_address_pool, if_add_index);
 180         ip4_address_t *if_ip =
 181             ip_interface_address_get_address(lm, if_add);
 182         *src = *if_ip;
 183         return 0;
 184     }
 185     else
 186     {
 187         ASSERT(0);
 188         src->as_u32 = 0;
 189     }
 190     return (!0);
 191 }
 192
 193 /* Find interface address which matches destination. */
 194 always_inline ip4_address_t *
 195 ip4_interface_address_matching_destination (ip4_main_t * im, ip4_address_t * dst, u32 sw_if_index,
 196                                             ip_interface_address_t ** result_ia)
 197 {
 198   ip_lookup_main_t * lm = &im->lookup_main;
 199   ip_interface_address_t * ia;
 200   ip4_address_t * result = 0;
 201
 202   foreach_ip_interface_address (lm, ia, sw_if_index,
 203                                 1 /* honor unnumbered */,
 204   ({
 205     ip4_address_t * a = ip_interface_address_get_address (lm, ia);
 206     if (ip4_destination_matches_route (im, dst, a, ia->address_length))
 207       {
 208         result = a;
 209         break;
 210       }
 211   }));
 212   if (result_ia)
 213     *result_ia = result ? ia : 0;
 214   return result;
 215 }
 216
 217 ip4_address_t *
 218 ip4_interface_first_address (ip4_main_t * im, u32 sw_if_index,
 219                              ip_interface_address_t ** result_ia);
 220
 221 clib_error_t *
 222 ip4_add_del_interface_address (vlib_main_t * vm, u32 sw_if_index,
 223                                ip4_address_t * address, u32 address_length,
 224                                u32 is_del);
 225
 226 void
 227 ip4_sw_interface_enable_disable (u32 sw_if_index,
 228                                  u32 is_enable);
 229
 230 int ip4_address_compare (ip4_address_t * a1, ip4_address_t * a2);
 231
 232 /* Send an ARP request to see if given destination is reachable on given interface. */
 233 clib_error_t *
 234 ip4_probe_neighbor (vlib_main_t * vm, ip4_address_t * dst, u32 sw_if_index);
 235
 236 clib_error_t *
 237 ip4_set_arp_limit (u32 arp_limit);
 238
 239 uword
 240 ip4_udp_register_listener (vlib_main_t * vm,
 241                            u16 dst_port,
 242                            u32 next_node_index);
 243
 244 void
 245 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type,
 246                         u32 node_index);
 247
 248 u16 ip4_tcp_udp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0, ip4_header_t * ip0);
 249
 250 void ip4_register_protocol (u32 protocol, u32 node_index);
 251
 252 serialize_function_t serialize_vnet_ip4_main, unserialize_vnet_ip4_main;
 253
 254 int vnet_set_ip4_flow_hash (u32 table_id, flow_hash_config_t flow_hash_config);
 255
 256 void ip4_mtrie_init (ip4_fib_mtrie_t * m);
 257
 258 int vnet_set_ip4_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
 259                                  u32 table_index);
 260
 261 /* Compute flow hash.  We'll use it to select which adjacency to use for this
 262    flow.  And other things. */
 263 always_inline u32
 264 ip4_compute_flow_hash (const ip4_header_t * ip,
 265                        flow_hash_config_t flow_hash_config)
 266 {
 267     tcp_header_t * tcp = (void *) (ip + 1);
 268     u32 a, b, c, t1, t2;
 269     uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
 270                         || ip->protocol == IP_PROTOCOL_UDP);
 271
 272     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR)
 273         ? ip->src_address.data_u32 : 0;
 274     t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR)
 275         ? ip->dst_address.data_u32 : 0;
 276
 277     a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
 278     b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
 279     b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
 280
 281     t1 = is_tcp_udp ? tcp->ports.src : 0;
 282     t2 = is_tcp_udp ? tcp->ports.dst : 0;
 283
 284     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
 285     t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
 286
 287     c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
 288         (t1<<16) | t2 : (t2<<16) | t1;
 289
 290     hash_v3_mix32 (a, b, c);
 291     hash_v3_finalize32 (a, b, c);
 292
 293     return c;
 294 }
 295
 296 void
 297 ip4_forward_next_trace (vlib_main_t * vm,
 298                         vlib_node_runtime_t * node,
 299                         vlib_frame_t * frame,
 300                         vlib_rx_or_tx_t which_adj_index);
 301
 302 u8 * format_ip4_forward_next_trace (u8 * s, va_list * args);
 303
 304 u32 ip4_tcp_udp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
 305
 306 #endif /* included_ip_ip4_h */