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