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 extern char *ip4_error_strings[];
 182
 183 /** Global ip4 input node.  Errors get attached to ip4 input node. */
 184 extern vlib_node_registration_t ip4_input_node;
 185 extern vlib_node_registration_t ip4_lookup_node;
 186 extern vlib_node_registration_t ip4_local_node;
 187 extern vlib_node_registration_t ip4_rewrite_node;
 188 extern vlib_node_registration_t ip4_rewrite_mcast_node;
 189 extern vlib_node_registration_t ip4_rewrite_local_node;
 190 extern vlib_node_registration_t ip4_arp_node;
 191 extern vlib_node_registration_t ip4_glean_node;
 192 extern vlib_node_registration_t ip4_midchain_node;
 193 extern vlib_node_registration_t ip4_punt_node;
 194
 195 always_inline uword
 196 ip4_destination_matches_route (const ip4_main_t * im,
 197                                const ip4_address_t * key,
 198                                const ip4_address_t * dest, uword dest_length)
 199 {
 200   return 0 == ((key->data_u32 ^ dest->data_u32) & im->fib_masks[dest_length]);
 201 }
 202
 203 always_inline uword
 204 ip4_destination_matches_interface (ip4_main_t * im,
 205                                    ip4_address_t * key,
 206                                    ip_interface_address_t * ia)
 207 {
 208   ip4_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
 209   return ip4_destination_matches_route (im, key, a, ia->address_length);
 210 }
 211
 212 always_inline int
 213 ip4_src_address_for_packet (ip_lookup_main_t * lm,
 214                             u32 sw_if_index, ip4_address_t * src)
 215 {
 216   u32 if_add_index = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
 217   if (PREDICT_TRUE (if_add_index != ~0))
 218     {
 219       ip_interface_address_t *if_add =
 220         pool_elt_at_index (lm->if_address_pool, if_add_index);
 221       ip4_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
 222       *src = *if_ip;
 223       return 0;
 224     }
 225   else
 226     {
 227       src->as_u32 = 0;
 228     }
 229   return (!0);
 230 }
 231
 232 /* Find interface address which matches destination. */
 233 always_inline ip4_address_t *
 234 ip4_interface_address_matching_destination (ip4_main_t * im,
 235                                             const ip4_address_t * dst,
 236                                             u32 sw_if_index,
 237                                             ip_interface_address_t **
 238                                             result_ia)
 239 {
 240   ip_lookup_main_t *lm = &im->lookup_main;
 241   ip_interface_address_t *ia;
 242   ip4_address_t *result = 0;
 243
 244   /* *INDENT-OFF* */
 245   foreach_ip_interface_address (lm, ia, sw_if_index,
 246                                 1 /* honor unnumbered */,
 247   ({
 248     ip4_address_t * a = ip_interface_address_get_address (lm, ia);
 249     if (ip4_destination_matches_route (im, dst, a, ia->address_length))
 250       {
 251         result = a;
 252         break;
 253       }
 254   }));
 255   /* *INDENT-ON* */
 256   if (result_ia)
 257     *result_ia = result ? ia : 0;
 258   return result;
 259 }
 260
 261 ip4_address_t *ip4_interface_first_address (ip4_main_t * im, u32 sw_if_index,
 262                                             ip_interface_address_t **
 263                                             result_ia);
 264
 265 clib_error_t *ip4_add_del_interface_address (vlib_main_t * vm,
 266                                              u32 sw_if_index,
 267                                              ip4_address_t * address,
 268                                              u32 address_length, u32 is_del);
 269
 270 void ip4_directed_broadcast (u32 sw_if_index, u8 enable);
 271
 272 void ip4_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
 273
 274 int ip4_address_compare (ip4_address_t * a1, ip4_address_t * a2);
 275
 276 uword
 277 ip4_udp_register_listener (vlib_main_t * vm,
 278                            u16 dst_port, u32 next_node_index);
 279
 280 u16 ip4_tcp_udp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
 281                                   ip4_header_t * ip0);
 282
 283 void ip4_register_protocol (u32 protocol, u32 node_index);
 284 void ip4_unregister_protocol (u32 protocolx);
 285
 286 serialize_function_t serialize_vnet_ip4_main, unserialize_vnet_ip4_main;
 287
 288 int vnet_set_ip4_flow_hash (u32 table_id,
 289                             flow_hash_config_t flow_hash_config);
 290
 291 int vnet_set_ip4_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
 292                                  u32 table_index);
 293
 294 void ip4_punt_policer_add_del (u8 is_add, u32 policer_index);
 295
 296 void ip4_punt_redirect_add (u32 rx_sw_if_index,
 297                             u32 tx_sw_if_index, ip46_address_t * nh);
 298 void ip4_punt_redirect_add_paths (u32 rx_sw_if_index,
 299                                   fib_route_path_t * paths);
 300
 301 void ip4_punt_redirect_del (u32 rx_sw_if_index);
 302
 303 /* Compute flow hash.  We'll use it to select which adjacency to use for this
 304    flow.  And other things. */
 305 always_inline u32
 306 ip4_compute_flow_hash (const ip4_header_t * ip,
 307                        flow_hash_config_t flow_hash_config)
 308 {
 309   tcp_header_t *tcp = (void *) (ip + 1);
 310   u32 a, b, c, t1, t2;
 311   uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
 312                       || ip->protocol == IP_PROTOCOL_UDP);
 313
 314   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR)
 315     ? ip->src_address.data_u32 : 0;
 316   t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR)
 317     ? ip->dst_address.data_u32 : 0;
 318
 319   a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
 320   b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
 321
 322   t1 = is_tcp_udp ? tcp->src : 0;
 323   t2 = is_tcp_udp ? tcp->dst : 0;
 324
 325   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
 326   t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
 327
 328   if (flow_hash_config & IP_FLOW_HASH_SYMMETRIC)
 329     {
 330       if (b < a)
 331         {
 332           c = a;
 333           a = b;
 334           b = c;
 335         }
 336       if (t2 < t1)
 337         {
 338           t2 += t1;
 339           t1 = t2 - t1;
 340           t2 = t2 - t1;
 341         }
 342     }
 343
 344   b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
 345   c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
 346     (t1 << 16) | t2 : (t2 << 16) | t1;
 347
 348   hash_v3_mix32 (a, b, c);
 349   hash_v3_finalize32 (a, b, c);
 350
 351   return c;
 352 }
 353
 354 void
 355 ip4_forward_next_trace (vlib_main_t * vm,
 356                         vlib_node_runtime_t * node,
 357                         vlib_frame_t * frame,
 358                         vlib_rx_or_tx_t which_adj_index);
 359
 360 u8 *format_ip4_forward_next_trace (u8 * s, va_list * args);
 361
 362 u32 ip4_tcp_udp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
 363
 364 #define IP_DF 0x4000            /* don't fragment */
 365
 366 always_inline void *
 367 vlib_buffer_push_ip4_custom (vlib_main_t * vm, vlib_buffer_t * b,
 368                              ip4_address_t * src, ip4_address_t * dst,
 369                              int proto, u8 csum_offload, u8 is_df)
 370 {
 371   ip4_header_t *ih;
 372
 373   /* make some room */
 374   ih = vlib_buffer_push_uninit (b, sizeof (ip4_header_t));
 375
 376   ih->ip_version_and_header_length = 0x45;
 377   ih->tos = 0;
 378   ih->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b));
 379
 380   /* No fragments */
 381   ih->flags_and_fragment_offset = is_df ? clib_host_to_net_u16 (IP_DF) : 0;
 382   ih->ttl = 255;
 383   ih->protocol = proto;
 384   ih->src_address.as_u32 = src->as_u32;
 385   ih->dst_address.as_u32 = dst->as_u32;
 386
 387   vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
 388   b->flags |= VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID;
 389
 390   /* Offload ip4 header checksum generation */
 391   if (csum_offload)
 392     {
 393       ih->checksum = 0;
 394       b->flags |= VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
 395     }
 396   else
 397     ih->checksum = ip4_header_checksum (ih);
 398
 399   return ih;
 400 }
 401
 402 /**
 403  * Push IPv4 header to buffer
 404  *
 405  * This does not support fragmentation.
 406  *
 407  * @param vm - vlib_main
 408  * @param b - buffer to write the header to
 409  * @param src - source IP
 410  * @param dst - destination IP
 411  * @param prot - payload proto
 412  *
 413  * @return - pointer to start of IP header
 414  */
 415 always_inline void *
 416 vlib_buffer_push_ip4 (vlib_main_t * vm, vlib_buffer_t * b,
 417                       ip4_address_t * src, ip4_address_t * dst, int proto,
 418                       u8 csum_offload)
 419 {
 420   return vlib_buffer_push_ip4_custom (vm, b, src, dst, proto, csum_offload,
 421                                       1 /* is_df */ );
 422 }
 423
 424 always_inline u32
 425 vlib_buffer_get_ip4_fib_index (vlib_buffer_t * b)
 426 {
 427   u32 fib_index, sw_if_index;
 428   sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
 429   fib_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
 430   return (fib_index == (u32) ~ 0) ?
 431     vec_elt (ip4_main.fib_index_by_sw_if_index, sw_if_index) : fib_index;
 432 }
 433 #endif /* included_ip_ip4_h */
 434
 435 /*
 436  * fd.io coding-style-patch-verification: ON
 437  *
 438  * Local Variables:
 439  * eval: (c-set-style "gnu")
 440  * End:
 441  */