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