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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * ip/ip_lookup.h: ip (4 or 6) lookup structures, adjacencies, ...
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 /** @file Definitions for all things IP (v4|v6) unicast and multicast lookup related.
41 - Adjacency definitions and registration
42 - callbacks on route add
43 - callbacks on interface address change
45 #ifndef included_ip_lookup_h
46 #define included_ip_lookup_h
48 #include <vnet/vnet.h>
49 #include <vlib/buffer.h>
50 #include <vnet/ip/ip4_packet.h>
51 #include <vnet/ip/ip6_packet.h>
53 /** @brief Common (IP4/IP6) next index stored in adjacency. */
55 /** Packet does not match any route in table. */
58 /** Adjacency to drop this packet. */
60 /** Adjacency to punt this packet. */
63 /** This packet is for one of our own IP addresses. */
66 /** This packet matches an "interface route" and packets
67 need to be passed to ARP to find rewrite string for
71 /** This packet is to be rewritten and forwarded to the next
72 processing node. This is typically the output interface but
73 might be another node for further output processing. */
74 IP_LOOKUP_NEXT_REWRITE,
76 /** This packet needs to be classified */
77 IP_LOOKUP_NEXT_CLASSIFY,
79 /** This packet needs to go to MAP - RFC7596, RFC7597 */
82 /** This packet needs to go to MAP with Translation - RFC7599 */
85 /** This packets needs to go to indirect next hop */
86 IP_LOOKUP_NEXT_INDIRECT,
88 /** This packets needs to go to ICMP error */
89 IP_LOOKUP_NEXT_ICMP_ERROR,
95 IP4_LOOKUP_N_NEXT = IP_LOOKUP_N_NEXT,
99 /** Hop-by-hop header handling */
100 IP6_LOOKUP_NEXT_HOP_BY_HOP = IP_LOOKUP_N_NEXT,
101 IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP,
102 IP6_LOOKUP_NEXT_POP_HOP_BY_HOP,
106 #define IP4_LOOKUP_NEXT_NODES { \
107 [IP_LOOKUP_NEXT_MISS] = "ip4-miss", \
108 [IP_LOOKUP_NEXT_DROP] = "ip4-drop", \
109 [IP_LOOKUP_NEXT_PUNT] = "ip4-punt", \
110 [IP_LOOKUP_NEXT_LOCAL] = "ip4-local", \
111 [IP_LOOKUP_NEXT_ARP] = "ip4-arp", \
112 [IP_LOOKUP_NEXT_REWRITE] = "ip4-rewrite-transit", \
113 [IP_LOOKUP_NEXT_CLASSIFY] = "ip4-classify", \
114 [IP_LOOKUP_NEXT_MAP] = "ip4-map", \
115 [IP_LOOKUP_NEXT_MAP_T] = "ip4-map-t", \
116 [IP_LOOKUP_NEXT_INDIRECT] = "ip4-indirect", \
117 [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip4-icmp-error", \
120 #define IP6_LOOKUP_NEXT_NODES { \
121 [IP_LOOKUP_NEXT_MISS] = "ip6-miss", \
122 [IP_LOOKUP_NEXT_DROP] = "ip6-drop", \
123 [IP_LOOKUP_NEXT_PUNT] = "ip6-punt", \
124 [IP_LOOKUP_NEXT_LOCAL] = "ip6-local", \
125 [IP_LOOKUP_NEXT_ARP] = "ip6-discover-neighbor", \
126 [IP_LOOKUP_NEXT_REWRITE] = "ip6-rewrite", \
127 [IP_LOOKUP_NEXT_CLASSIFY] = "ip6-classify", \
128 [IP_LOOKUP_NEXT_MAP] = "ip6-map", \
129 [IP_LOOKUP_NEXT_MAP_T] = "ip6-map-t", \
130 [IP_LOOKUP_NEXT_INDIRECT] = "ip6-indirect", \
131 [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip6-icmp-error", \
132 [IP6_LOOKUP_NEXT_HOP_BY_HOP] = "ip6-hop-by-hop", \
133 [IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP] = "ip6-add-hop-by-hop", \
134 [IP6_LOOKUP_NEXT_POP_HOP_BY_HOP] = "ip6-pop-hop-by-hop", \
137 /** Flow hash configuration */
138 #define IP_FLOW_HASH_SRC_ADDR (1<<0)
139 #define IP_FLOW_HASH_DST_ADDR (1<<1)
140 #define IP_FLOW_HASH_PROTO (1<<2)
141 #define IP_FLOW_HASH_SRC_PORT (1<<3)
142 #define IP_FLOW_HASH_DST_PORT (1<<4)
143 #define IP_FLOW_HASH_REVERSE_SRC_DST (1<<5)
145 /** Default: 5-tuple without the "reverse" bit */
146 #define IP_FLOW_HASH_DEFAULT (0x1F)
148 #define foreach_flow_hash_bit \
149 _(src, IP_FLOW_HASH_SRC_ADDR) \
150 _(dst, IP_FLOW_HASH_DST_ADDR) \
151 _(sport, IP_FLOW_HASH_SRC_PORT) \
152 _(dport, IP_FLOW_HASH_DST_PORT) \
153 _(proto, IP_FLOW_HASH_PROTO) \
154 _(reverse, IP_FLOW_HASH_REVERSE_SRC_DST)
156 #define IP_ADJACENCY_OPAQUE_SZ 16
157 /** @brief IP unicast adjacency.
161 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
162 /** Handle for this adjacency in adjacency heap. */
165 STRUCT_MARK(signature_start);
167 /** Interface address index for this local/arp adjacency. */
168 u32 if_address_index;
170 /** Number of adjecencies in block. Greater than 1 means multipath;
171 otherwise equal to 1. */
174 /** Next hop after ip4-lookup. */
176 ip_lookup_next_t lookup_next_index : 16;
177 u16 lookup_next_index_as_int;
180 /** Force re-lookup in a different FIB. ~0 => normal behavior */
181 i16 explicit_fib_index;
182 u16 mcast_group_index;
184 /** Highest possible perf subgraph arc interposition, e.g. for ip6 ioam */
185 u16 saved_lookup_next_index;
188 /** IP_LOOKUP_NEXT_ARP only */
190 ip46_address_t next_hop;
192 /** IP_LOOKUP_NEXT_CLASSIFY only */
196 /** IP_LOOKUP_NEXT_INDIRECT only */
198 ip46_address_t next_hop;
200 u8 opaque[IP_ADJACENCY_OPAQUE_SZ];
203 /** @brief Special format function for this adjacency.
204 * Specifically good for cases which use the entire rewrite
205 * for their own purposes. Can easily reduce to a u16 or a u8 if/when
206 * the first cache line reads "full" on the free space gas gauge.
208 u32 special_adjacency_format_function_index; /* 0 is invalid */
209 STRUCT_MARK(signature_end);
211 /** Number of FIB entries sharing this adjacency */
213 /** Use this adjacency instead */
214 u32 next_adj_with_signature;
216 CLIB_CACHE_LINE_ALIGN_MARK(cacheline1);
218 /** Rewrite in second/third cache lines */
219 vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
223 vnet_ip_adjacency_signature (ip_adjacency_t * adj)
225 uword signature = 0xfeedfaceULL;
227 /* Skip heap handle, sum everything up to but not including share_count */
228 signature = hash_memory
229 (STRUCT_MARK_PTR(adj, signature_start),
230 STRUCT_OFFSET_OF(ip_adjacency_t, signature_end)
231 - STRUCT_OFFSET_OF(ip_adjacency_t, signature_start),
234 /* and the rewrite */
235 signature = hash_memory (&adj->rewrite_header, VLIB_BUFFER_PRE_DATA_SIZE,
241 vnet_ip_adjacency_share_compare (ip_adjacency_t * a1, ip_adjacency_t *a2)
243 if (memcmp (STRUCT_MARK_PTR(a1, signature_start),
244 STRUCT_MARK_PTR(a2, signature_start),
245 STRUCT_OFFSET_OF(ip_adjacency_t, signature_end)
246 - STRUCT_OFFSET_OF(ip_adjacency_t, signature_start)))
248 if (memcmp (&a1->rewrite_header, &a2->rewrite_header,
249 VLIB_BUFFER_PRE_DATA_SIZE))
254 /* Index into adjacency table. */
255 typedef u32 ip_adjacency_index_t;
258 /* Directly connected next-hop adjacency index. */
259 u32 next_hop_adj_index;
261 /* Path weight for this adjacency. */
263 } ip_multipath_next_hop_t;
266 /* Adjacency index of first index in block. */
269 /* Power of 2 size of adjacency block. */
272 /* Number of prefixes that point to this adjacency. */
275 /* Normalized next hops are used as hash keys: they are sorted by weight
276 and weights are chosen so they add up to 1 << log2_n_adj_in_block (with
277 zero-weighted next hops being deleted).
278 Unnormalized next hops are saved so that control plane has a record of exactly
279 what the RIB told it. */
281 /* Number of hops in the multipath. */
284 /* Offset into next hop heap for this block. */
287 /* Heap handle used to for example free block when we're done with it. */
289 } normalized_next_hops, unnormalized_next_hops;
290 } ip_multipath_adjacency_t;
292 /* IP multicast adjacency. */
294 /* Handle for this adjacency in adjacency heap. */
297 /* Number of adjecencies in block. */
300 /* Rewrite string. */
301 vnet_declare_rewrite (64 - 2*sizeof(u32));
302 } ip_multicast_rewrite_t;
305 /* ip4-multicast-rewrite next index. */
310 u8 rewrite_string[64 - 1*sizeof(u32) - 1*sizeof(u8)];
311 } ip_multicast_rewrite_string_t;
314 ip_multicast_rewrite_t * rewrite_heap;
316 ip_multicast_rewrite_string_t * rewrite_strings;
318 /* Negative rewrite string index; >= 0 sw_if_index.
319 Sorted. Used to hash. */
320 i32 ** adjacency_id_vector;
322 uword * adjacency_by_id_vector;
323 } ip_multicast_lookup_main_t;
326 /* Key for mhash; in fact, just a byte offset into mhash key vector. */
329 /* Interface which has this address. */
332 /* Adjacency for neighbor probe (ARP) for this interface address. */
333 u32 neighbor_probe_adj_index;
335 /* Address (prefix) length for this interface. */
338 /* Will be used for something eventually. Primary vs. secondary? */
341 /* Next and previous pointers for doubly linked list of
342 addresses per software interface. */
343 u32 next_this_sw_interface;
344 u32 prev_this_sw_interface;
345 } ip_interface_address_t;
350 IP_LOCAL_NEXT_UDP_LOOKUP,
355 struct ip_lookup_main_t;
357 typedef void (* ip_add_del_adjacency_callback_t) (struct ip_lookup_main_t * lm,
359 ip_adjacency_t * adj,
363 vnet_config_main_t config_main;
365 u32 * config_index_by_sw_if_index;
368 //Function type used to register formatting of a custom adjacency formatting
369 typedef u8 *(* ip_adjacency_format_fn)(u8 * s,
370 struct ip_lookup_main_t * lm,
371 ip_adjacency_t *adj);
373 typedef struct ip_adj_register_struct {
374 struct ip_adj_register_struct *next;
375 char *node_name; //Name of the node for this registered adjacency
376 ip_adjacency_format_fn fn; //Formatting function of this adjacency
377 u32 *next_index; //some place where the next index to be used will be put at init
380 typedef struct ip_lookup_main_t {
381 /** Adjacency heap. */
382 ip_adjacency_t * adjacency_heap;
384 /** Adjacency packet/byte counters indexed by adjacency index. */
385 vlib_combined_counter_main_t adjacency_counters;
387 /** Heap of (next hop, weight) blocks. Sorted by next hop. */
388 ip_multipath_next_hop_t * next_hop_heap;
390 /** Indexed by heap_handle from ip_adjacency_t. */
391 ip_multipath_adjacency_t * multipath_adjacencies;
393 /** Adjacency by signature hash */
394 uword * adj_index_by_signature;
396 /** Temporary vectors for looking up next hops in hash. */
397 ip_multipath_next_hop_t * next_hop_hash_lookup_key;
398 ip_multipath_next_hop_t * next_hop_hash_lookup_key_normalized;
400 /** Hash table mapping normalized next hops and weights
401 to multipath adjacency index. */
402 uword * multipath_adjacency_by_next_hops;
404 u32 * adjacency_remap_table;
405 u32 n_adjacency_remaps;
407 /** If average error per adjacency is less than this threshold adjacency block
409 f64 multipath_next_hop_error_tolerance;
411 /** Adjacency index for routing table misses, local punts, and drops. */
412 u32 miss_adj_index, drop_adj_index, local_adj_index;
414 /** Miss adjacency is always first in adjacency table. */
415 #define IP_LOOKUP_MISS_ADJ_INDEX 0
417 ip_add_del_adjacency_callback_t * add_del_adjacency_callbacks;
419 /** Pool of addresses that are assigned to interfaces. */
420 ip_interface_address_t * if_address_pool;
422 /** Hash table mapping address to index in interface address pool. */
423 mhash_t address_to_if_address_index;
425 /** Head of doubly linked list of interface addresses for each software interface.
426 ~0 means this interface has no address. */
427 u32 * if_address_pool_index_by_sw_if_index;
429 /** First table index to use for this interface, ~0 => none */
430 u32 * classify_table_index_by_sw_if_index;
432 /** rx/tx interface/feature configuration. */
433 ip_config_main_t rx_config_mains[VNET_N_CAST], tx_config_main;
435 /** Number of bytes in a fib result. Must be at least
436 sizeof (uword). First word is always adjacency index. */
437 u32 fib_result_n_bytes, fib_result_n_words;
439 format_function_t * format_fib_result;
441 /** 1 for ip6; 0 for ip4. */
444 /** Either format_ip4_address_and_length or format_ip6_address_and_length. */
445 format_function_t * format_address_and_length;
447 /** Special adjacency format functions */
448 format_function_t ** special_adjacency_format_functions;
450 /** Table mapping ip protocol to ip[46]-local node next index. */
451 u8 local_next_by_ip_protocol[256];
453 /** IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header. */
454 u8 builtin_protocol_by_ip_protocol[256];
456 /** Registered adjacencies */
457 ip_adj_register_t *registered_adjacencies;
460 always_inline ip_adjacency_t *
461 ip_get_adjacency (ip_lookup_main_t * lm,
464 ip_adjacency_t * adj;
466 adj = vec_elt_at_index (lm->adjacency_heap, adj_index);
468 ASSERT (adj->heap_handle != ~0);
473 #define ip_prefetch_adjacency(lm,adj_index,type) \
475 ip_adjacency_t * _adj = (lm)->adjacency_heap + (adj_index); \
476 CLIB_PREFETCH (_adj, sizeof (_adj[0]), type); \
479 /* Adds a next node to ip4 or ip6 lookup node which can be then used in adjacencies.
480 * @param vlib_main pointer
481 * @param lm ip4_main.lookup_main or ip6_main.lookup_main
482 * @param reg registration structure
483 * @param next_node_index Returned index to be used in adjacencies.
484 * @return 0 on success. -1 on failure.
486 int ip_register_adjacency(vlib_main_t *vm, u8 is_ip4,
487 ip_adj_register_t *reg);
490 * Construction helpers to add IP adjacency at init.
492 #define VNET_IP_REGISTER_ADJACENCY(ip,x,...) \
493 __VA_ARGS__ ip_adj_register_t ip##adj_##x; \
494 static void __vnet_##ip##_register_adjacency_##x (void) \
495 __attribute__((__constructor__)) ; \
496 static void __vnet_##ip##_register_adjacency_##x (void) \
498 ip_lookup_main_t *lm = &ip##_main.lookup_main; \
499 ip##adj_##x.next = lm->registered_adjacencies; \
500 lm->registered_adjacencies = &ip##adj_##x; \
502 __VA_ARGS__ ip_adj_register_t ip##adj_##x
504 #define VNET_IP4_REGISTER_ADJACENCY(x,...) \
505 VNET_IP_REGISTER_ADJACENCY(ip4, x, __VA_ARGS__)
507 #define VNET_IP6_REGISTER_ADJACENCY(x,...) \
508 VNET_IP_REGISTER_ADJACENCY(ip6, x, __VA_ARGS__)
511 ip_register_add_del_adjacency_callback(ip_lookup_main_t * lm,
512 ip_add_del_adjacency_callback_t cb)
514 vec_add1(lm->add_del_adjacency_callbacks, cb);
518 ip_call_add_del_adjacency_callbacks (ip_lookup_main_t * lm, u32 adj_index, u32 is_del)
520 ip_adjacency_t * adj;
522 adj = ip_get_adjacency (lm, adj_index);
523 for (i = 0; i < vec_len (lm->add_del_adjacency_callbacks); i++)
524 lm->add_del_adjacency_callbacks[i] (lm, adj_index, adj, is_del);
527 /* Create new block of given number of contiguous adjacencies. */
529 ip_add_adjacency (ip_lookup_main_t * lm,
530 ip_adjacency_t * adj,
532 u32 * adj_index_result);
534 void ip_del_adjacency (ip_lookup_main_t * lm, u32 adj_index);
536 ip_update_adjacency (ip_lookup_main_t * lm,
538 ip_adjacency_t * copy_adj);
541 ip_adjacency_is_multipath(ip_lookup_main_t * lm, u32 adj_index)
543 if (!vec_len(lm->multipath_adjacencies))
546 if (vec_len(lm->multipath_adjacencies) < adj_index - 1)
550 return (lm->multipath_adjacencies[adj_index].adj_index == adj_index &&
551 lm->multipath_adjacencies[adj_index].n_adj_in_block > 0);
555 ip_multipath_adjacency_free (ip_lookup_main_t * lm,
556 ip_multipath_adjacency_t * a);
559 ip_multipath_adjacency_add_del_next_hop (ip_lookup_main_t * lm,
561 u32 old_mp_adj_index,
562 u32 next_hop_adj_index,
564 u32 * new_mp_adj_index);
567 ip_interface_address_add_del (ip_lookup_main_t * lm,
574 always_inline ip_interface_address_t *
575 ip_get_interface_address (ip_lookup_main_t * lm, void * addr_fib)
577 uword * p = mhash_get (&lm->address_to_if_address_index, addr_fib);
578 return p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
582 ip_interface_address_get_address (ip_lookup_main_t * lm, ip_interface_address_t * a)
583 { return mhash_key_to_mem (&lm->address_to_if_address_index, a->address_key); }
585 always_inline ip_interface_address_t *
586 ip_interface_address_for_packet (ip_lookup_main_t * lm, vlib_buffer_t * b, u32 sw_if_index)
588 ip_adjacency_t * adj;
589 u32 if_address_index;
591 adj = ip_get_adjacency (lm, vnet_buffer (b)->ip.adj_index[VLIB_TX]);
593 ASSERT (adj->lookup_next_index == IP_LOOKUP_NEXT_ARP
594 || adj->lookup_next_index == IP_LOOKUP_NEXT_LOCAL);
595 if_address_index = adj->if_address_index;
596 if_address_index = (if_address_index == ~0 ?
597 vec_elt (lm->if_address_pool_index_by_sw_if_index, sw_if_index)
600 return (if_address_index != ~0)?pool_elt_at_index (lm->if_address_pool, if_address_index):NULL;
603 #define foreach_ip_interface_address(lm,a,sw_if_index,loop,body) \
605 vnet_main_t *_vnm = vnet_get_main(); \
606 u32 _sw_if_index = sw_if_index; \
607 vnet_sw_interface_t *_swif; \
608 _swif = vnet_get_sw_interface (_vnm, _sw_if_index); \
611 * Loop => honor unnumbered interface addressing. \
613 if (loop && _swif->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED) \
614 _sw_if_index = _swif->unnumbered_sw_if_index; \
616 (vec_len((lm)->if_address_pool_index_by_sw_if_index) \
618 ? vec_elt ((lm)->if_address_pool_index_by_sw_if_index, \
619 (_sw_if_index)) : (u32)~0; \
620 ip_interface_address_t * _a; \
623 _a = pool_elt_at_index ((lm)->if_address_pool, _ia); \
624 _ia = _a->next_this_sw_interface; \
630 void ip_lookup_init (ip_lookup_main_t * lm, u32 ip_lookup_node_index);
631 u32 vnet_register_special_adjacency_format_function
632 (ip_lookup_main_t * lm, format_function_t * fp);
634 #endif /* included_ip_lookup_h */