src/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 {
  50   /* Hash table for each prefix length mapping. */
  51   uword *fib_entry_by_dst_address[33];
  52
  53   /* Mtrie for fast lookups.  Hash is used to maintain overlapping prefixes. */
  54   ip4_fib_mtrie_t mtrie;
  55
  56   /* Table ID (hash key) for this FIB. */
  57   u32 table_id;
  58
  59   /* Index into FIB vector. */
  60   u32 index;
  61
  62   /* flow hash configuration */
  63   flow_hash_config_t flow_hash_config;
  64
  65   /* N-tuple classifier indices */
  66   u32 fwd_classify_table_index;
  67   u32 rev_classify_table_index;
  68
  69 } ip4_fib_t;
  70
  71 struct ip4_main_t;
  72
  73 typedef void (ip4_add_del_interface_address_function_t)
  74   (struct ip4_main_t * im,
  75    uword opaque,
  76    u32 sw_if_index,
  77    ip4_address_t * address,
  78    u32 address_length, u32 if_address_index, u32 is_del);
  79
  80 typedef struct
  81 {
  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 {
  97   ip_lookup_main_t lookup_main;
  98
  99   /** Vector of FIBs. */
 100   struct fib_table_t_ *fibs;
 101
 102   u32 fib_masks[33];
 103
 104   /** Table index indexed by software interface. */
 105   u32 *fib_index_by_sw_if_index;
 106
 107   /* IP4 enabled count by software interface */
 108   u8 *ip_enabled_by_sw_if_index;
 109
 110   /** Hash table mapping table id to fib index.
 111      ID space is not necessarily dense; index space is dense. */
 112   uword *fib_index_by_table_id;
 113
 114   /** Functions to call when interface address changes. */
 115     ip4_add_del_interface_address_callback_t
 116     * add_del_interface_address_callbacks;
 117
 118   /** Template used to generate IP4 ARP packets. */
 119   vlib_packet_template_t ip4_arp_request_packet_template;
 120
 121   /** Seed for Jenkins hash used to compute ip4 flow hash. */
 122   u32 flow_hash_seed;
 123
 124   /** @brief Template information for VPP generated packets */
 125   struct
 126   {
 127     /** TTL to use for host generated packets. */
 128     u8 ttl;
 129
 130     /** TOS byte to use for host generated packets. */
 131     u8 tos;
 132
 133     u8 pad[2];
 134   } host_config;
 135 } ip4_main_t;
 136
 137 /** Global ip4 main structure. */
 138 extern ip4_main_t ip4_main;
 139
 140 /** Global ip4 input node.  Errors get attached to ip4 input node. */
 141 extern vlib_node_registration_t ip4_input_node;
 142 extern vlib_node_registration_t ip4_lookup_node;
 143 extern vlib_node_registration_t ip4_rewrite_node;
 144 extern vlib_node_registration_t ip4_rewrite_local_node;
 145 extern vlib_node_registration_t ip4_arp_node;
 146 extern vlib_node_registration_t ip4_glean_node;
 147 extern vlib_node_registration_t ip4_midchain_node;
 148
 149 always_inline uword
 150 ip4_destination_matches_route (const ip4_main_t * im,
 151                                const ip4_address_t * key,
 152                                const ip4_address_t * dest, uword dest_length)
 153 {
 154   return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]);
 155 }
 156
 157 always_inline uword
 158 ip4_destination_matches_interface (ip4_main_t * im,
 159                                    ip4_address_t * key,
 160                                    ip_interface_address_t * ia)
 161 {
 162   ip4_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
 163   return ip4_destination_matches_route (im, key, a, ia->address_length);
 164 }
 165
 166 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
 167 always_inline uword
 168 ip4_unaligned_destination_matches_route (ip4_main_t * im,
 169                                          ip4_address_t * key,
 170                                          ip4_address_t * dest,
 171                                          uword dest_length)
 172 {
 173   return 0 ==
 174     ((clib_mem_unaligned (&key->data_u32, u32) ^ dest->
 175       data_u32) & im->fib_masks[dest_length]);
 176 }
 177
 178 always_inline int
 179 ip4_src_address_for_packet (ip_lookup_main_t * lm,
 180                             u32 sw_if_index, ip4_address_t * src)
 181 {
 182   u32 if_add_index = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
 183   if (PREDICT_TRUE (if_add_index != ~0))
 184     {
 185       ip_interface_address_t *if_add =
 186         pool_elt_at_index (lm->if_address_pool, if_add_index);
 187       ip4_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
 188       *src = *if_ip;
 189       return 0;
 190     }
 191   else
 192     {
 193       src->as_u32 = 0;
 194     }
 195   return (!0);
 196 }
 197
 198 /* Find interface address which matches destination. */
 199 always_inline ip4_address_t *
 200 ip4_interface_address_matching_destination (ip4_main_t * im,
 201                                             ip4_address_t * dst,
 202                                             u32 sw_if_index,
 203                                             ip_interface_address_t **
 204                                             result_ia)
 205 {
 206   ip_lookup_main_t *lm = &im->lookup_main;
 207   ip_interface_address_t *ia;
 208   ip4_address_t *result = 0;
 209
 210   /* *INDENT-OFF* */
 211   foreach_ip_interface_address (lm, ia, sw_if_index,
 212                                 1 /* honor unnumbered */,
 213   ({
 214     ip4_address_t * a = ip_interface_address_get_address (lm, ia);
 215     if (ip4_destination_matches_route (im, dst, a, ia->address_length))
 216       {
 217         result = a;
 218         break;
 219       }
 220   }));
 221   /* *INDENT-ON* */
 222   if (result_ia)
 223     *result_ia = result ? ia : 0;
 224   return result;
 225 }
 226
 227 ip4_address_t *ip4_interface_first_address (ip4_main_t * im, u32 sw_if_index,
 228                                             ip_interface_address_t **
 229                                             result_ia);
 230
 231 clib_error_t *ip4_add_del_interface_address (vlib_main_t * vm,
 232                                              u32 sw_if_index,
 233                                              ip4_address_t * address,
 234                                              u32 address_length, u32 is_del);
 235
 236 void ip4_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
 237
 238 int ip4_address_compare (ip4_address_t * a1, ip4_address_t * a2);
 239
 240 /* Send an ARP request to see if given destination is reachable on given interface. */
 241 clib_error_t *ip4_probe_neighbor (vlib_main_t * vm, ip4_address_t * dst,
 242                                   u32 sw_if_index);
 243
 244 clib_error_t *ip4_set_arp_limit (u32 arp_limit);
 245
 246 uword
 247 ip4_udp_register_listener (vlib_main_t * vm,
 248                            u16 dst_port, u32 next_node_index);
 249
 250 void
 251 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type, u32 node_index);
 252
 253 u16 ip4_tcp_udp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
 254                                   ip4_header_t * ip0);
 255
 256 void ip4_register_protocol (u32 protocol, u32 node_index);
 257
 258 serialize_function_t serialize_vnet_ip4_main, unserialize_vnet_ip4_main;
 259
 260 int vnet_set_ip4_flow_hash (u32 table_id,
 261                             flow_hash_config_t flow_hash_config);
 262
 263 void ip4_mtrie_init (ip4_fib_mtrie_t * m);
 264
 265 int vnet_set_ip4_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
 266                                  u32 table_index);
 267
 268 /* Compute flow hash.  We'll use it to select which adjacency to use for this
 269    flow.  And other things. */
 270 always_inline u32
 271 ip4_compute_flow_hash (const ip4_header_t * ip,
 272                        flow_hash_config_t flow_hash_config)
 273 {
 274   tcp_header_t *tcp = (void *) (ip + 1);
 275   u32 a, b, c, t1, t2;
 276   uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
 277                       || ip->protocol == IP_PROTOCOL_UDP);
 278
 279   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR)
 280     ? ip->src_address.data_u32 : 0;
 281   t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR)
 282     ? ip->dst_address.data_u32 : 0;
 283
 284   a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
 285   b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
 286   b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
 287
 288   t1 = is_tcp_udp ? tcp->ports.src : 0;
 289   t2 = is_tcp_udp ? tcp->ports.dst : 0;
 290
 291   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
 292   t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
 293
 294   c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
 295     (t1 << 16) | t2 : (t2 << 16) | t1;
 296
 297   hash_v3_mix32 (a, b, c);
 298   hash_v3_finalize32 (a, b, c);
 299
 300   return c;
 301 }
 302
 303 void
 304 ip4_forward_next_trace (vlib_main_t * vm,
 305                         vlib_node_runtime_t * node,
 306                         vlib_frame_t * frame,
 307                         vlib_rx_or_tx_t which_adj_index);
 308
 309 u8 *format_ip4_forward_next_trace (u8 * s, va_list * args);
 310
 311 u32 ip4_tcp_udp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
 312
 313 #endif /* included_ip_ip4_h */
 314
 315 /*
 316  * fd.io coding-style-patch-verification: ON
 317  *
 318  * Local Variables:
 319  * eval: (c-set-style "gnu")
 320  * End:
 321  */