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_packet.h>
  44 #include <vnet/ip/lookup.h>
  45 #include <vnet/buffer.h>
  46 #include <vnet/feature/feature.h>
  47 #include <vnet/ip/icmp46_packet.h>
  48 #include <vnet/util/throttle.h>
  49
  50 typedef struct ip4_mfib_t
  51 {
  52   /* Hash table for each prefix length mapping. */
  53   uword *fib_entry_by_dst_address[65];
  54
  55   /* Table ID (hash key) for this FIB. */
  56   u32 table_id;
  57
  58   /* Index into FIB vector. */
  59   u32 index;
  60 } ip4_mfib_t;
  61
  62 struct ip4_main_t;
  63
  64 typedef void (ip4_add_del_interface_address_function_t)
  65   (struct ip4_main_t * im,
  66    uword opaque,
  67    u32 sw_if_index,
  68    ip4_address_t * address,
  69    u32 address_length, u32 if_address_index, u32 is_del);
  70
  71 typedef struct
  72 {
  73   ip4_add_del_interface_address_function_t *function;
  74   uword function_opaque;
  75 } ip4_add_del_interface_address_callback_t;
  76
  77 typedef void (ip4_enable_disable_interface_function_t)
  78   (struct ip4_main_t * im, uword opaque, u32 sw_if_index, u32 is_enable);
  79
  80 typedef struct
  81 {
  82   ip4_enable_disable_interface_function_t *function;
  83   uword function_opaque;
  84 } ip4_enable_disable_interface_callback_t;
  85
  86 typedef void (ip4_table_bind_function_t)
  87   (struct ip4_main_t * im,
  88    uword opaque, u32 sw_if_index, u32 new_fib_index, u32 old_fib_index);
  89
  90 typedef struct
  91 {
  92   ip4_table_bind_function_t *function;
  93   uword function_opaque;
  94 } ip4_table_bind_callback_t;
  95
  96 /**
  97  * @brief IPv4 main type.
  98  *
  99  * State of IPv4 VPP processing including:
 100  * - FIBs
 101  * - Feature indices used in feature topological sort
 102  * - Feature node run time references
 103  */
 104
 105 typedef struct ip4_main_t
 106 {
 107   ip_lookup_main_t lookup_main;
 108
 109   /** Vector of FIBs. */
 110   struct fib_table_t_ *fibs;
 111
 112   /** Vector of MTries. */
 113   struct ip4_fib_t_ *v4_fibs;
 114
 115   /** Vector of MFIBs. */
 116   struct mfib_table_t_ *mfibs;
 117
 118   u32 fib_masks[33];
 119
 120   /** Table index indexed by software interface. */
 121   u32 *fib_index_by_sw_if_index;
 122
 123   /** Table index indexed by software interface. */
 124   u32 *mfib_index_by_sw_if_index;
 125
 126   /* IP4 enabled count by software interface */
 127   u8 *ip_enabled_by_sw_if_index;
 128
 129   /** Hash table mapping table id to fib index.
 130      ID space is not necessarily dense; index space is dense. */
 131   uword *fib_index_by_table_id;
 132
 133   /** Hash table mapping table id to multicast fib index.
 134      ID space is not necessarily dense; index space is dense. */
 135   uword *mfib_index_by_table_id;
 136
 137   /** Functions to call when interface address changes. */
 138     ip4_add_del_interface_address_callback_t
 139     * add_del_interface_address_callbacks;
 140
 141   /** Functions to call when interface becomes IPv4 enabled/disable. */
 142     ip4_enable_disable_interface_callback_t
 143     * enable_disable_interface_callbacks;
 144
 145   /** Functions to call when interface to table biding changes. */
 146   ip4_table_bind_callback_t *table_bind_callbacks;
 147
 148   /** Template used to generate IP4 ARP packets. */
 149   vlib_packet_template_t ip4_arp_request_packet_template;
 150
 151   /** Seed for Jenkins hash used to compute ip4 flow hash. */
 152   u32 flow_hash_seed;
 153
 154   /** @brief Template information for VPP generated packets */
 155   struct
 156   {
 157     /** TTL to use for host generated packets. */
 158     u8 ttl;
 159
 160     /** TOS byte to use for host generated packets. */
 161     u8 tos;
 162
 163     u8 pad[2];
 164   } host_config;
 165
 166   /** Heapsize for the Mtries */
 167   uword mtrie_heap_size;
 168
 169   /** The memory heap for the mtries */
 170   void *mtrie_mheap;
 171
 172   /** ARP throttling */
 173   throttle_t arp_throttle;
 174
 175 } ip4_main_t;
 176
 177 #define ARP_THROTTLE_BITS       (512)
 178
 179 /** Global ip4 main structure. */
 180 extern ip4_main_t ip4_main;
 181
 182 /** Global ip4 input node.  Errors get attached to ip4 input node. */
 183 extern vlib_node_registration_t ip4_input_node;
 184 extern vlib_node_registration_t ip4_lookup_node;
 185 extern vlib_node_registration_t ip4_local_node;
 186 extern vlib_node_registration_t ip4_rewrite_node;
 187 extern vlib_node_registration_t ip4_rewrite_mcast_node;
 188 extern vlib_node_registration_t ip4_rewrite_local_node;
 189 extern vlib_node_registration_t ip4_arp_node;
 190 extern vlib_node_registration_t ip4_glean_node;
 191 extern vlib_node_registration_t ip4_midchain_node;
 192
 193 always_inline uword
 194 ip4_destination_matches_route (const ip4_main_t * im,
 195                                const ip4_address_t * key,
 196                                const ip4_address_t * dest, uword dest_length)
 197 {
 198   return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]);
 199 }
 200
 201 always_inline uword
 202 ip4_destination_matches_interface (ip4_main_t * im,
 203                                    ip4_address_t * key,
 204                                    ip_interface_address_t * ia)
 205 {
 206   ip4_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
 207   return ip4_destination_matches_route (im, key, a, ia->address_length);
 208 }
 209
 210 always_inline int
 211 ip4_src_address_for_packet (ip_lookup_main_t * lm,
 212                             u32 sw_if_index, ip4_address_t * src)
 213 {
 214   u32 if_add_index = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
 215   if (PREDICT_TRUE (if_add_index != ~0))
 216     {
 217       ip_interface_address_t *if_add =
 218         pool_elt_at_index (lm->if_address_pool, if_add_index);
 219       ip4_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
 220       *src = *if_ip;
 221       return 0;
 222     }
 223   else
 224     {
 225       src->as_u32 = 0;
 226     }
 227   return (!0);
 228 }
 229
 230 /* Find interface address which matches destination. */
 231 always_inline ip4_address_t *
 232 ip4_interface_address_matching_destination (ip4_main_t * im,
 233                                             ip4_address_t * dst,
 234                                             u32 sw_if_index,
 235                                             ip_interface_address_t **
 236                                             result_ia)
 237 {
 238   ip_lookup_main_t *lm = &im->lookup_main;
 239   ip_interface_address_t *ia;
 240   ip4_address_t *result = 0;
 241
 242   /* *INDENT-OFF* */
 243   foreach_ip_interface_address (lm, ia, sw_if_index,
 244                                 1 /* honor unnumbered */,
 245   ({
 246     ip4_address_t * a = ip_interface_address_get_address (lm, ia);
 247     if (ip4_destination_matches_route (im, dst, a, ia->address_length))
 248       {
 249         result = a;
 250         break;
 251       }
 252   }));
 253   /* *INDENT-ON* */
 254   if (result_ia)
 255     *result_ia = result ? ia : 0;
 256   return result;
 257 }
 258
 259 ip4_address_t *ip4_interface_first_address (ip4_main_t * im, u32 sw_if_index,
 260                                             ip_interface_address_t **
 261                                             result_ia);
 262
 263 clib_error_t *ip4_add_del_interface_address (vlib_main_t * vm,
 264                                              u32 sw_if_index,
 265                                              ip4_address_t * address,
 266                                              u32 address_length, u32 is_del);
 267
 268 void ip4_directed_broadcast (u32 sw_if_index, u8 enable);
 269
 270 void ip4_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
 271
 272 int ip4_address_compare (ip4_address_t * a1, ip4_address_t * a2);
 273
 274 /* Send an ARP request to see if given destination is reachable on given interface. */
 275 clib_error_t *ip4_probe_neighbor (vlib_main_t * vm, ip4_address_t * dst,
 276                                   u32 sw_if_index, u8 refresh);
 277
 278 clib_error_t *ip4_set_arp_limit (u32 arp_limit);
 279
 280 uword
 281 ip4_udp_register_listener (vlib_main_t * vm,
 282                            u16 dst_port, u32 next_node_index);
 283
 284 void
 285 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type, u32 node_index);
 286
 287 u16 ip4_tcp_udp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
 288                                   ip4_header_t * ip0);
 289
 290 void ip4_register_protocol (u32 protocol, u32 node_index);
 291 void ip4_unregister_protocol (u32 protocolx);
 292
 293 serialize_function_t serialize_vnet_ip4_main, unserialize_vnet_ip4_main;
 294
 295 int vnet_set_ip4_flow_hash (u32 table_id,
 296                             flow_hash_config_t flow_hash_config);
 297
 298 int vnet_set_ip4_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
 299                                  u32 table_index);
 300
 301 void ip4_punt_policer_add_del (u8 is_add, u32 policer_index);
 302
 303 void ip4_punt_redirect_add (u32 rx_sw_if_index,
 304                             u32 tx_sw_if_index, ip46_address_t * nh);
 305 void ip4_punt_redirect_del (u32 rx_sw_if_index);
 306
 307 /* Compute flow hash.  We'll use it to select which adjacency to use for this
 308    flow.  And other things. */
 309 always_inline u32
 310 ip4_compute_flow_hash (const ip4_header_t * ip,
 311                        flow_hash_config_t flow_hash_config)
 312 {
 313   tcp_header_t *tcp = (void *) (ip + 1);
 314   u32 a, b, c, t1, t2;
 315   uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
 316                       || ip->protocol == IP_PROTOCOL_UDP);
 317
 318   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR)
 319     ? ip->src_address.data_u32 : 0;
 320   t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR)
 321     ? ip->dst_address.data_u32 : 0;
 322
 323   a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
 324   b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
 325
 326   t1 = is_tcp_udp ? tcp->src : 0;
 327   t2 = is_tcp_udp ? tcp->dst : 0;
 328
 329   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
 330   t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
 331
 332   if (flow_hash_config & IP_FLOW_HASH_SYMMETRIC)
 333     {
 334       if (b < a)
 335         {
 336           c = a;
 337           a = b;
 338           b = c;
 339         }
 340       if (t2 < t1)
 341         {
 342           t2 += t1;
 343           t1 = t2 - t1;
 344           t2 = t2 - t1;
 345         }
 346     }
 347
 348   b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
 349   c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
 350     (t1 << 16) | t2 : (t2 << 16) | t1;
 351
 352   hash_v3_mix32 (a, b, c);
 353   hash_v3_finalize32 (a, b, c);
 354
 355   return c;
 356 }
 357
 358 void
 359 ip4_forward_next_trace (vlib_main_t * vm,
 360                         vlib_node_runtime_t * node,
 361                         vlib_frame_t * frame,
 362                         vlib_rx_or_tx_t which_adj_index);
 363
 364 u8 *format_ip4_forward_next_trace (u8 * s, va_list * args);
 365
 366 u32 ip4_tcp_udp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
 367
 368 #define IP_DF 0x4000            /* don't fragment */
 369
 370 /**
 371  * Push IPv4 header to buffer
 372  *
 373  * This does not support fragmentation.
 374  *
 375  * @param vm - vlib_main
 376  * @param b - buffer to write the header to
 377  * @param src - source IP
 378  * @param dst - destination IP
 379  * @param prot - payload proto
 380  *
 381  * @return - pointer to start of IP header
 382  */
 383 always_inline void *
 384 vlib_buffer_push_ip4 (vlib_main_t * vm, vlib_buffer_t * b,
 385                       ip4_address_t * src, ip4_address_t * dst, int proto,
 386                       u8 csum_offload)
 387 {
 388   ip4_header_t *ih;
 389
 390   /* make some room */
 391   ih = vlib_buffer_push_uninit (b, sizeof (ip4_header_t));
 392
 393   ih->ip_version_and_header_length = 0x45;
 394   ih->tos = 0;
 395   ih->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b));
 396
 397   /* No fragments */
 398   ih->flags_and_fragment_offset = clib_host_to_net_u16 (IP_DF);
 399   ih->ttl = 255;
 400   ih->protocol = proto;
 401   ih->src_address.as_u32 = src->as_u32;
 402   ih->dst_address.as_u32 = dst->as_u32;
 403
 404   /* Offload ip4 header checksum generation */
 405   if (csum_offload)
 406     {
 407       ih->checksum = 0;
 408       b->flags |= VNET_BUFFER_F_OFFLOAD_IP_CKSUM | VNET_BUFFER_F_IS_IP4;
 409       vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
 410       vnet_buffer (b)->l4_hdr_offset = vnet_buffer (b)->l3_hdr_offset +
 411         sizeof (*ih);
 412     }
 413   else
 414     ih->checksum = ip4_header_checksum (ih);
 415
 416   return ih;
 417 }
 418 #endif /* included_ip_ip4_h */
 419
 420 /*
 421  * fd.io coding-style-patch-verification: ON
 422  *
 423  * Local Variables:
 424  * eval: (c-set-style "gnu")
 425  * End:
 426  */