src/vnet/ip/lookup.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/ip_lookup.h: ip (4 or 6) lookup structures, adjacencies, ...
  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 /**
  41  * @file
  42  * Definitions for all things IP (v4|v6) unicast and multicast lookup related.
  43  *
  44  * - Adjacency definitions and registration.
  45  * - Callbacks on route add.
  46  * - Callbacks on interface address change.
  47  */
  48 #ifndef included_ip_lookup_h
  49 #define included_ip_lookup_h
  50
  51 #include <vnet/vnet.h>
  52 #include <vlib/buffer.h>
  53 #include <vnet/ip/ip4_packet.h>
  54 #include <vnet/ip/ip6_packet.h>
  55 #include <vnet/fib/fib_node.h>
  56 #include <vnet/dpo/dpo.h>
  57 #include <vnet/feature/feature.h>
  58
  59 /** @brief Common (IP4/IP6) next index stored in adjacency. */
  60 typedef enum
  61 {
  62   /** Adjacency to drop this packet. */
  63   IP_LOOKUP_NEXT_DROP,
  64   /** Adjacency to punt this packet. */
  65   IP_LOOKUP_NEXT_PUNT,
  66
  67   /** This packet is for one of our own IP addresses. */
  68   IP_LOOKUP_NEXT_LOCAL,
  69
  70   /** This packet matches an "incomplete adjacency" and packets
  71      need to be passed to ARP to find rewrite string for
  72      this destination. */
  73   IP_LOOKUP_NEXT_ARP,
  74
  75   /** This packet matches an "interface route" and packets
  76      need to be passed to ARP to find rewrite string for
  77      this destination. */
  78   IP_LOOKUP_NEXT_GLEAN,
  79
  80   /** This packet is to be rewritten and forwarded to the next
  81      processing node.  This is typically the output interface but
  82      might be another node for further output processing. */
  83   IP_LOOKUP_NEXT_REWRITE,
  84
  85   /** This packets follow a load-balance */
  86   IP_LOOKUP_NEXT_LOAD_BALANCE,
  87
  88   /** This packets follow a mid-chain adjacency */
  89   IP_LOOKUP_NEXT_MIDCHAIN,
  90
  91   /** This packets needs to go to ICMP error */
  92   IP_LOOKUP_NEXT_ICMP_ERROR,
  93
  94   IP_LOOKUP_N_NEXT,
  95 } ip_lookup_next_t;
  96
  97 typedef enum
  98 {
  99   IP4_LOOKUP_N_NEXT = IP_LOOKUP_N_NEXT,
 100 } ip4_lookup_next_t;
 101
 102 typedef enum
 103 {
 104   /* Hop-by-hop header handling */
 105   IP6_LOOKUP_NEXT_HOP_BY_HOP = IP_LOOKUP_N_NEXT,
 106   IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP,
 107   IP6_LOOKUP_NEXT_POP_HOP_BY_HOP,
 108   IP6_LOOKUP_N_NEXT,
 109 } ip6_lookup_next_t;
 110
 111 #define IP4_LOOKUP_NEXT_NODES {                                 \
 112     [IP_LOOKUP_NEXT_DROP] = "ip4-drop",                         \
 113     [IP_LOOKUP_NEXT_PUNT] = "ip4-punt",                         \
 114     [IP_LOOKUP_NEXT_LOCAL] = "ip4-local",                       \
 115     [IP_LOOKUP_NEXT_ARP] = "ip4-arp",                           \
 116     [IP_LOOKUP_NEXT_GLEAN] = "ip4-glean",                       \
 117     [IP_LOOKUP_NEXT_REWRITE] = "ip4-rewrite",                   \
 118     [IP_LOOKUP_NEXT_MIDCHAIN] = "ip4-midchain",                 \
 119     [IP_LOOKUP_NEXT_LOAD_BALANCE] = "ip4-load-balance",         \
 120     [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip4-icmp-error",             \
 121 }
 122
 123 #define IP6_LOOKUP_NEXT_NODES {                                 \
 124     [IP_LOOKUP_NEXT_DROP] = "ip6-drop",                         \
 125     [IP_LOOKUP_NEXT_PUNT] = "ip6-punt",                         \
 126     [IP_LOOKUP_NEXT_LOCAL] = "ip6-local",                       \
 127     [IP_LOOKUP_NEXT_ARP] = "ip6-discover-neighbor",             \
 128     [IP_LOOKUP_NEXT_GLEAN] = "ip6-glean",                       \
 129     [IP_LOOKUP_NEXT_REWRITE] = "ip6-rewrite",                   \
 130     [IP_LOOKUP_NEXT_MIDCHAIN] = "ip6-midchain",                 \
 131     [IP_LOOKUP_NEXT_LOAD_BALANCE] = "ip6-load-balance",         \
 132     [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip6-icmp-error",             \
 133     [IP6_LOOKUP_NEXT_HOP_BY_HOP] = "ip6-hop-by-hop",            \
 134     [IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP] = "ip6-add-hop-by-hop",    \
 135     [IP6_LOOKUP_NEXT_POP_HOP_BY_HOP] = "ip6-pop-hop-by-hop",    \
 136 }
 137
 138 /** Flow hash configuration */
 139 #define IP_FLOW_HASH_SRC_ADDR (1<<0)
 140 #define IP_FLOW_HASH_DST_ADDR (1<<1)
 141 #define IP_FLOW_HASH_PROTO (1<<2)
 142 #define IP_FLOW_HASH_SRC_PORT (1<<3)
 143 #define IP_FLOW_HASH_DST_PORT (1<<4)
 144 #define IP_FLOW_HASH_REVERSE_SRC_DST (1<<5)
 145
 146 /** Default: 5-tuple without the "reverse" bit */
 147 #define IP_FLOW_HASH_DEFAULT (0x1F)
 148
 149 #define foreach_flow_hash_bit                   \
 150 _(src, IP_FLOW_HASH_SRC_ADDR)                   \
 151 _(dst, IP_FLOW_HASH_DST_ADDR)                   \
 152 _(sport, IP_FLOW_HASH_SRC_PORT)                 \
 153 _(dport, IP_FLOW_HASH_DST_PORT)                 \
 154 _(proto, IP_FLOW_HASH_PROTO)                    \
 155 _(reverse, IP_FLOW_HASH_REVERSE_SRC_DST)
 156
 157 /**
 158  * A flow hash configuration is a mask of the flow hash options
 159  */
 160 typedef u32 flow_hash_config_t;
 161
 162 /**
 163  * Forward delcartion
 164  */
 165 struct ip_adjacency_t_;
 166
 167 /**
 168  * @brief A function type for post-rewrite fixups on midchain adjacency
 169  */
 170 typedef void (*adj_midchain_fixup_t) (vlib_main_t * vm,
 171                                       struct ip_adjacency_t_ * adj,
 172                                       vlib_buffer_t * b0);
 173
 174 /**
 175  * @brief Flags on an IP adjacency
 176  */
 177 typedef enum ip_adjacency_flags_t_
 178 {
 179     /**
 180      * Currently a sync walk is active. Used to prevent re-entrant walking
 181      */
 182   IP_ADJ_SYNC_WALK_ACTIVE = (1 << 0),
 183 } ip_adjacency_flags_t;
 184
 185 /** @brief IP unicast adjacency.
 186     @note cache aligned.
 187 */
 188 typedef struct ip_adjacency_t_
 189 {
 190   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 191
 192   /** Number of adjecencies in block.  Greater than 1 means multipath;
 193      otherwise equal to 1. */
 194   u16 n_adj;
 195
 196   /** Next hop after ip4-lookup. */
 197   union
 198   {
 199     ip_lookup_next_t lookup_next_index:16;
 200     u16 lookup_next_index_as_int;
 201   };
 202
 203   /** Interface address index for this local/arp adjacency. */
 204   u32 if_address_index;
 205
 206   /** Force re-lookup in a different FIB. ~0 => normal behavior */
 207   u16 mcast_group_index;
 208
 209   /** Highest possible perf subgraph arc interposition, e.g. for ip6 ioam */
 210   u16 saved_lookup_next_index;
 211
 212   /*
 213    * link/ether-type
 214    */
 215   vnet_link_t ia_link;
 216   u8 ia_nh_proto;
 217
 218   union
 219   {
 220     /**
 221      * IP_LOOKUP_NEXT_ARP/IP_LOOKUP_NEXT_REWRITE
 222      *
 223      * neighbour adjacency sub-type;
 224      */
 225     struct
 226     {
 227       ip46_address_t next_hop;
 228     } nbr;
 229       /**
 230        * IP_LOOKUP_NEXT_MIDCHAIN
 231        *
 232        * A nbr adj that is also recursive. Think tunnels.
 233        * A nbr adj can transition to be of type MDICHAIN
 234        * so be sure to leave the two structs with the next_hop
 235        * fields aligned.
 236        */
 237     struct
 238     {
 239           /**
 240            * The recursive next-hop
 241            */
 242       ip46_address_t next_hop;
 243           /**
 244            * The node index of the tunnel's post rewrite/TX function.
 245            */
 246       u32 tx_function_node;
 247           /**
 248            * The next DPO to use
 249            */
 250       dpo_id_t next_dpo;
 251           /**
 252            * A function to perform the post-rewrite fixup
 253            */
 254       adj_midchain_fixup_t fixup_func;
 255     } midchain;
 256       /**
 257        * IP_LOOKUP_NEXT_GLEAN
 258        *
 259        * Glean the address to ARP for from the packet's destination
 260        */
 261     struct
 262     {
 263       ip46_address_t receive_addr;
 264     } glean;
 265   } sub_type;
 266
 267     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 268
 269   /* Rewrite in second/third cache lines */
 270     vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
 271
 272   /*
 273    * member not accessed in the data plane are relgated to the
 274    * remaining cachelines
 275    */
 276   fib_node_t ia_node;
 277
 278   /**
 279    * Flags on the adjacency
 280    */
 281   ip_adjacency_flags_t ia_flags;
 282
 283 } ip_adjacency_t;
 284
 285 STATIC_ASSERT ((STRUCT_OFFSET_OF (ip_adjacency_t, cacheline0) == 0),
 286                "IP adjacency cachline 0 is not offset");
 287 STATIC_ASSERT ((STRUCT_OFFSET_OF (ip_adjacency_t, cacheline1) ==
 288                 CLIB_CACHE_LINE_BYTES),
 289                "IP adjacency cachline 1 is more than one cachline size offset");
 290
 291 /* An all zeros address */
 292 extern const ip46_address_t zero_addr;
 293
 294 /* IP multicast adjacency. */
 295 typedef struct
 296 {
 297   /* Handle for this adjacency in adjacency heap. */
 298   u32 heap_handle;
 299
 300   /* Number of adjecencies in block. */
 301   u32 n_adj;
 302
 303   /* Rewrite string. */
 304     vnet_declare_rewrite (64 - 2 * sizeof (u32));
 305 }
 306 ip_multicast_rewrite_t;
 307
 308 typedef struct
 309 {
 310   /* ip4-multicast-rewrite next index. */
 311   u32 next_index;
 312
 313   u8 n_rewrite_bytes;
 314
 315   u8 rewrite_string[64 - 1 * sizeof (u32) - 1 * sizeof (u8)];
 316 }
 317 ip_multicast_rewrite_string_t;
 318
 319 typedef struct
 320 {
 321   ip_multicast_rewrite_t *rewrite_heap;
 322
 323   ip_multicast_rewrite_string_t *rewrite_strings;
 324
 325   /* Negative rewrite string index; >= 0 sw_if_index.
 326      Sorted.  Used to hash. */
 327   i32 **adjacency_id_vector;
 328
 329   uword *adjacency_by_id_vector;
 330 } ip_multicast_lookup_main_t;
 331
 332 typedef struct
 333 {
 334   /* Key for mhash; in fact, just a byte offset into mhash key vector. */
 335   u32 address_key;
 336
 337   /* Interface which has this address. */
 338   u32 sw_if_index;
 339
 340   /* Adjacency for neighbor probe (ARP) for this interface address. */
 341   u32 neighbor_probe_adj_index;
 342
 343   /* Address (prefix) length for this interface. */
 344   u16 address_length;
 345
 346   /* Will be used for something eventually.  Primary vs. secondary? */
 347   u16 flags;
 348
 349   /* Next and previous pointers for doubly linked list of
 350      addresses per software interface. */
 351   u32 next_this_sw_interface;
 352   u32 prev_this_sw_interface;
 353 } ip_interface_address_t;
 354
 355 typedef enum
 356 {
 357   IP_LOCAL_NEXT_DROP,
 358   IP_LOCAL_NEXT_PUNT,
 359   IP_LOCAL_NEXT_UDP_LOOKUP,
 360   IP_LOCAL_NEXT_ICMP,
 361   IP_LOCAL_N_NEXT,
 362 } ip_local_next_t;
 363
 364 struct ip_lookup_main_t;
 365
 366 typedef struct ip_lookup_main_t
 367 {
 368   /* Adjacency heap. */
 369   ip_adjacency_t *adjacency_heap;
 370
 371   /** load-balance  packet/byte counters indexed by LB index. */
 372   vlib_combined_counter_main_t load_balance_counters;
 373
 374   /** Pool of addresses that are assigned to interfaces. */
 375   ip_interface_address_t *if_address_pool;
 376
 377   /** Hash table mapping address to index in interface address pool. */
 378   mhash_t address_to_if_address_index;
 379
 380   /** Head of doubly linked list of interface addresses for each software interface.
 381      ~0 means this interface has no address. */
 382   u32 *if_address_pool_index_by_sw_if_index;
 383
 384   /** First table index to use for this interface, ~0 => none */
 385   u32 *classify_table_index_by_sw_if_index;
 386
 387   /** Feature arc indices */
 388   u8 mcast_feature_arc_index;
 389   u8 ucast_feature_arc_index;
 390   u8 output_feature_arc_index;
 391
 392   /** Number of bytes in a fib result.  Must be at least
 393      sizeof (uword).  First word is always adjacency index. */
 394   u32 fib_result_n_bytes, fib_result_n_words;
 395
 396   format_function_t *format_fib_result;
 397
 398   /** 1 for ip6; 0 for ip4. */
 399   u32 is_ip6;
 400
 401   /** Either format_ip4_address_and_length or format_ip6_address_and_length. */
 402   format_function_t *format_address_and_length;
 403
 404   /** Special adjacency format functions */
 405   format_function_t **special_adjacency_format_functions;
 406
 407   /** Table mapping ip protocol to ip[46]-local node next index. */
 408   u8 local_next_by_ip_protocol[256];
 409
 410   /** IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header. */
 411   u8 builtin_protocol_by_ip_protocol[256];
 412 } ip_lookup_main_t;
 413
 414 always_inline ip_adjacency_t *
 415 ip_get_adjacency (ip_lookup_main_t * lm, u32 adj_index)
 416 {
 417   ip_adjacency_t *adj;
 418
 419   adj = vec_elt_at_index (lm->adjacency_heap, adj_index);
 420
 421   return adj;
 422 }
 423
 424 #define ip_prefetch_adjacency(lm,adj_index,type)                \
 425 do {                                                            \
 426   ip_adjacency_t * _adj = (lm)->adjacency_heap + (adj_index);   \
 427   CLIB_PREFETCH (_adj, sizeof (_adj[0]), type);                 \
 428 } while (0)
 429
 430 /* Create new block of given number of contiguous adjacencies. */
 431 ip_adjacency_t *ip_add_adjacency (ip_lookup_main_t * lm,
 432                                   ip_adjacency_t * adj,
 433                                   u32 n_adj, u32 * adj_index_result);
 434
 435 clib_error_t *ip_interface_address_add_del (ip_lookup_main_t * lm,
 436                                             u32 sw_if_index,
 437                                             void *address,
 438                                             u32 address_length,
 439                                             u32 is_del, u32 * result_index);
 440
 441 u8 *format_ip_flow_hash_config (u8 * s, va_list * args);
 442
 443 always_inline ip_interface_address_t *
 444 ip_get_interface_address (ip_lookup_main_t * lm, void *addr_fib)
 445 {
 446   uword *p = mhash_get (&lm->address_to_if_address_index, addr_fib);
 447   return p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
 448 }
 449
 450 u32 fib_table_id_find_fib_index (fib_protocol_t proto, u32 table_id);
 451
 452 always_inline void *
 453 ip_interface_address_get_address (ip_lookup_main_t * lm,
 454                                   ip_interface_address_t * a)
 455 {
 456   return mhash_key_to_mem (&lm->address_to_if_address_index, a->address_key);
 457 }
 458
 459 /* *INDENT-OFF* */
 460 #define foreach_ip_interface_address(lm,a,sw_if_index,loop,body)        \
 461 do {                                                                    \
 462     vnet_main_t *_vnm = vnet_get_main();                                     \
 463     u32 _sw_if_index = sw_if_index;                                     \
 464     vnet_sw_interface_t *_swif;                                         \
 465     _swif = vnet_get_sw_interface (_vnm, _sw_if_index);                 \
 466                                                                         \
 467     /*                                                                  \
 468      * Loop => honor unnumbered interface addressing.                   \
 469      */                                                                 \
 470     if (loop && _swif->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED)       \
 471       _sw_if_index = _swif->unnumbered_sw_if_index;                     \
 472     u32 _ia =                                                           \
 473       (vec_len((lm)->if_address_pool_index_by_sw_if_index)              \
 474        > (_sw_if_index))                                                \
 475         ? vec_elt ((lm)->if_address_pool_index_by_sw_if_index,          \
 476                    (_sw_if_index)) : (u32)~0;                           \
 477     ip_interface_address_t * _a;                                        \
 478     while (_ia != ~0)                                                   \
 479     {                                                                   \
 480         _a = pool_elt_at_index ((lm)->if_address_pool, _ia);            \
 481         _ia = _a->next_this_sw_interface;                               \
 482         (a) = _a;                                                       \
 483         body;                                                           \
 484     }                                                                   \
 485 } while (0)
 486 /* *INDENT-ON* */
 487
 488 void ip_lookup_init (ip_lookup_main_t * lm, u32 ip_lookup_node_index);
 489
 490 #endif /* included_ip_lookup_h */
 491
 492 /*
 493  * fd.io coding-style-patch-verification: ON
 494  *
 495  * Local Variables:
 496  * eval: (c-set-style "gnu")
 497  * End:
 498  */