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