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 #ifndef included_ip_lookup_h
41 #define included_ip_lookup_h
43 #include <vnet/vnet.h>
44 #include <vlib/buffer.h>
45 #include <vnet/ip/ip4_packet.h>
46 #include <vnet/ip/ip6_packet.h>
48 /* Common (IP4/IP6) next index stored in adjacency. */
50 /* Packet does not match any route in table. */
53 /* Adjacency says to drop or punt this packet. */
57 /* This packet is for one of our own IP addresses. */
60 /* This packet matches an "interface route" and packets
61 need to be passed to ARP to find rewrite string for
65 /* This packet is to be rewritten and forwarded to the next
66 processing node. This is typically the output interface but
67 might be another node for further output processing. */
68 IP_LOOKUP_NEXT_REWRITE,
70 /* This packet needs to be classified */
71 IP_LOOKUP_NEXT_CLASSIFY,
73 /* This packet needs to go to MAP - RFC7596, RFC7597 */
76 /* This packet needs to go to MAP with Translation - RFC7599 */
79 /* This packets needs to go to indirect next hop */
80 IP_LOOKUP_NEXT_INDIRECT,
82 IP_LOOKUP_NEXT_ICMP_ERROR,
88 IP4_LOOKUP_N_NEXT = IP_LOOKUP_N_NEXT,
92 /* Hop-by-hop header handling */
93 IP6_LOOKUP_NEXT_HOP_BY_HOP = IP_LOOKUP_N_NEXT,
94 IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP,
95 IP6_LOOKUP_NEXT_POP_HOP_BY_HOP,
99 #define IP4_LOOKUP_NEXT_NODES { \
100 [IP_LOOKUP_NEXT_MISS] = "ip4-miss", \
101 [IP_LOOKUP_NEXT_DROP] = "ip4-drop", \
102 [IP_LOOKUP_NEXT_PUNT] = "ip4-punt", \
103 [IP_LOOKUP_NEXT_LOCAL] = "ip4-local", \
104 [IP_LOOKUP_NEXT_ARP] = "ip4-arp", \
105 [IP_LOOKUP_NEXT_REWRITE] = "ip4-rewrite-transit", \
106 [IP_LOOKUP_NEXT_CLASSIFY] = "ip4-classify", \
107 [IP_LOOKUP_NEXT_MAP] = "ip4-map", \
108 [IP_LOOKUP_NEXT_MAP_T] = "ip4-map-t", \
109 [IP_LOOKUP_NEXT_INDIRECT] = "ip4-indirect", \
110 [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip4-icmp-error", \
113 #define IP6_LOOKUP_NEXT_NODES { \
114 [IP_LOOKUP_NEXT_MISS] = "ip6-miss", \
115 [IP_LOOKUP_NEXT_DROP] = "ip6-drop", \
116 [IP_LOOKUP_NEXT_PUNT] = "ip6-punt", \
117 [IP_LOOKUP_NEXT_LOCAL] = "ip6-local", \
118 [IP_LOOKUP_NEXT_ARP] = "ip6-discover-neighbor", \
119 [IP_LOOKUP_NEXT_REWRITE] = "ip6-rewrite", \
120 [IP_LOOKUP_NEXT_CLASSIFY] = "ip6-classify", \
121 [IP_LOOKUP_NEXT_MAP] = "ip6-map", \
122 [IP_LOOKUP_NEXT_MAP_T] = "ip6-map-t", \
123 [IP_LOOKUP_NEXT_INDIRECT] = "ip6-indirect", \
124 [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip6-icmp-error", \
125 [IP6_LOOKUP_NEXT_HOP_BY_HOP] = "ip6-hop-by-hop", \
126 [IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP] = "ip6-add-hop-by-hop", \
127 [IP6_LOOKUP_NEXT_POP_HOP_BY_HOP] = "ip6-pop-hop-by-hop", \
130 /* Flow hash configuration */
131 #define IP_FLOW_HASH_SRC_ADDR (1<<0)
132 #define IP_FLOW_HASH_DST_ADDR (1<<1)
133 #define IP_FLOW_HASH_PROTO (1<<2)
134 #define IP_FLOW_HASH_SRC_PORT (1<<3)
135 #define IP_FLOW_HASH_DST_PORT (1<<4)
136 #define IP_FLOW_HASH_REVERSE_SRC_DST (1<<5)
138 /* Default: 5-tuple without the "reverse" bit */
139 #define IP_FLOW_HASH_DEFAULT (0x1F)
141 #define foreach_flow_hash_bit \
142 _(src, IP_FLOW_HASH_SRC_ADDR) \
143 _(dst, IP_FLOW_HASH_DST_ADDR) \
144 _(sport, IP_FLOW_HASH_SRC_PORT) \
145 _(dport, IP_FLOW_HASH_DST_PORT) \
146 _(proto, IP_FLOW_HASH_PROTO) \
147 _(reverse, IP_FLOW_HASH_REVERSE_SRC_DST)
149 /* IP unicast adjacency. */
151 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
152 /* Handle for this adjacency in adjacency heap. */
155 STRUCT_MARK(signature_start);
157 /* Interface address index for this local/arp adjacency. */
158 u32 if_address_index;
160 /* Number of adjecencies in block. Greater than 1 means multipath;
161 otherwise equal to 1. */
164 /* Next hop after ip4-lookup. */
166 ip_lookup_next_t lookup_next_index : 16;
167 u16 lookup_next_index_as_int;
170 /* Force re-lookup in a different FIB. ~0 => normal behavior */
171 i16 explicit_fib_index;
172 u16 mcast_group_index;
174 /* Highest possible perf subgraph arc interposition, e.g. for ip6 ioam */
175 u16 saved_lookup_next_index;
178 /* IP_LOOKUP_NEXT_ARP only */
180 ip46_address_t next_hop;
182 /* IP_LOOKUP_NEXT_CLASSIFY only */
186 /* IP_LOOKUP_NEXT_INDIRECT only */
188 ip46_address_t next_hop;
192 STRUCT_MARK(signature_end);
194 /* Number of FIB entries sharing this adjacency */
196 /* Use this adjacency instead */
197 u32 next_adj_with_signature;
199 CLIB_CACHE_LINE_ALIGN_MARK(cacheline1);
201 /* Rewrite in second/third cache lines */
202 vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
206 vnet_ip_adjacency_signature (ip_adjacency_t * adj)
208 uword signature = 0xfeedfaceULL;
210 /* Skip heap handle, sum everything up to but not including share_count */
211 signature = hash_memory
212 (STRUCT_MARK_PTR(adj, signature_start),
213 STRUCT_OFFSET_OF(ip_adjacency_t, signature_end)
214 - STRUCT_OFFSET_OF(ip_adjacency_t, signature_start),
217 /* and the rewrite */
218 signature = hash_memory (&adj->rewrite_header, VLIB_BUFFER_PRE_DATA_SIZE,
224 vnet_ip_adjacency_share_compare (ip_adjacency_t * a1, ip_adjacency_t *a2)
226 if (memcmp (STRUCT_MARK_PTR(a1, signature_start),
227 STRUCT_MARK_PTR(a2, signature_start),
228 STRUCT_OFFSET_OF(ip_adjacency_t, signature_end)
229 - STRUCT_OFFSET_OF(ip_adjacency_t, signature_start)))
231 if (memcmp (&a1->rewrite_header, &a2->rewrite_header,
232 VLIB_BUFFER_PRE_DATA_SIZE))
237 /* Index into adjacency table. */
238 typedef u32 ip_adjacency_index_t;
241 /* Directly connected next-hop adjacency index. */
242 u32 next_hop_adj_index;
244 /* Path weight for this adjacency. */
246 } ip_multipath_next_hop_t;
249 /* Adjacency index of first index in block. */
252 /* Power of 2 size of adjacency block. */
255 /* Number of prefixes that point to this adjacency. */
258 /* Normalized next hops are used as hash keys: they are sorted by weight
259 and weights are chosen so they add up to 1 << log2_n_adj_in_block (with
260 zero-weighted next hops being deleted).
261 Unnormalized next hops are saved so that control plane has a record of exactly
262 what the RIB told it. */
264 /* Number of hops in the multipath. */
267 /* Offset into next hop heap for this block. */
270 /* Heap handle used to for example free block when we're done with it. */
272 } normalized_next_hops, unnormalized_next_hops;
273 } ip_multipath_adjacency_t;
275 /* IP multicast adjacency. */
277 /* Handle for this adjacency in adjacency heap. */
280 /* Number of adjecencies in block. */
283 /* Rewrite string. */
284 vnet_declare_rewrite (64 - 2*sizeof(u32));
285 } ip_multicast_rewrite_t;
288 /* ip4-multicast-rewrite next index. */
293 u8 rewrite_string[64 - 1*sizeof(u32) - 1*sizeof(u8)];
294 } ip_multicast_rewrite_string_t;
297 ip_multicast_rewrite_t * rewrite_heap;
299 ip_multicast_rewrite_string_t * rewrite_strings;
301 /* Negative rewrite string index; >= 0 sw_if_index.
302 Sorted. Used to hash. */
303 i32 ** adjacency_id_vector;
305 uword * adjacency_by_id_vector;
306 } ip_multicast_lookup_main_t;
309 /* Key for mhash; in fact, just a byte offset into mhash key vector. */
312 /* Interface which has this address. */
315 /* Adjacency for neighbor probe (ARP) for this interface address. */
316 u32 neighbor_probe_adj_index;
318 /* Address (prefix) length for this interface. */
321 /* Will be used for something eventually. Primary vs. secondary? */
324 /* Next and previous pointers for doubly linked list of
325 addresses per software interface. */
326 u32 next_this_sw_interface;
327 u32 prev_this_sw_interface;
328 } ip_interface_address_t;
333 IP_LOCAL_NEXT_UDP_LOOKUP,
338 struct ip_lookup_main_t;
340 typedef void (* ip_add_del_adjacency_callback_t) (struct ip_lookup_main_t * lm,
342 ip_adjacency_t * adj,
346 vnet_config_main_t config_main;
348 u32 * config_index_by_sw_if_index;
351 typedef struct ip_lookup_main_t {
352 /* Adjacency heap. */
353 ip_adjacency_t * adjacency_heap;
355 /* Adjacency packet/byte counters indexed by adjacency index. */
356 vlib_combined_counter_main_t adjacency_counters;
358 /* Heap of (next hop, weight) blocks. Sorted by next hop. */
359 ip_multipath_next_hop_t * next_hop_heap;
361 /* Indexed by heap_handle from ip_adjacency_t. */
362 ip_multipath_adjacency_t * multipath_adjacencies;
364 /* Adjacency by signature hash */
365 uword * adj_index_by_signature;
367 /* Temporary vectors for looking up next hops in hash. */
368 ip_multipath_next_hop_t * next_hop_hash_lookup_key;
369 ip_multipath_next_hop_t * next_hop_hash_lookup_key_normalized;
371 /* Hash table mapping normalized next hops and weights
372 to multipath adjacency index. */
373 uword * multipath_adjacency_by_next_hops;
375 u32 * adjacency_remap_table;
376 u32 n_adjacency_remaps;
378 /* If average error per adjacency is less than this threshold adjacency block
380 f64 multipath_next_hop_error_tolerance;
382 /* Adjacency index for routing table misses, local punts, and drops. */
383 u32 miss_adj_index, drop_adj_index, local_adj_index;
385 /* Miss adjacency is always first in adjacency table. */
386 #define IP_LOOKUP_MISS_ADJ_INDEX 0
388 ip_add_del_adjacency_callback_t * add_del_adjacency_callbacks;
390 /* Pool of addresses that are assigned to interfaces. */
391 ip_interface_address_t * if_address_pool;
393 /* Hash table mapping address to index in interface address pool. */
394 mhash_t address_to_if_address_index;
396 /* Head of doubly linked list of interface addresses for each software interface.
397 ~0 means this interface has no address. */
398 u32 * if_address_pool_index_by_sw_if_index;
400 /* First table index to use for this interface, ~0 => none */
401 u32 * classify_table_index_by_sw_if_index;
403 /* rx/tx interface/feature configuration. */
404 ip_config_main_t rx_config_mains[VNET_N_CAST], tx_config_main;
406 /* Number of bytes in a fib result. Must be at least
407 sizeof (uword). First word is always adjacency index. */
408 u32 fib_result_n_bytes, fib_result_n_words;
410 format_function_t * format_fib_result;
412 /* 1 for ip6; 0 for ip4. */
415 /* Either format_ip4_address_and_length or format_ip6_address_and_length. */
416 format_function_t * format_address_and_length;
418 /* Table mapping ip protocol to ip[46]-local node next index. */
419 u8 local_next_by_ip_protocol[256];
421 /* IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header. */
422 u8 builtin_protocol_by_ip_protocol[256];
425 always_inline ip_adjacency_t *
426 ip_get_adjacency (ip_lookup_main_t * lm,
429 ip_adjacency_t * adj;
431 adj = vec_elt_at_index (lm->adjacency_heap, adj_index);
433 ASSERT (adj->heap_handle != ~0);
438 #define ip_prefetch_adjacency(lm,adj_index,type) \
440 ip_adjacency_t * _adj = (lm)->adjacency_heap + (adj_index); \
441 CLIB_PREFETCH (_adj, sizeof (_adj[0]), type); \
445 ip_register_add_del_adjacency_callback(ip_lookup_main_t * lm,
446 ip_add_del_adjacency_callback_t cb)
448 vec_add1(lm->add_del_adjacency_callbacks, cb);
452 ip_call_add_del_adjacency_callbacks (ip_lookup_main_t * lm, u32 adj_index, u32 is_del)
454 ip_adjacency_t * adj;
456 adj = ip_get_adjacency (lm, adj_index);
457 for (i = 0; i < vec_len (lm->add_del_adjacency_callbacks); i++)
458 lm->add_del_adjacency_callbacks[i] (lm, adj_index, adj, is_del);
461 /* Create new block of given number of contiguous adjacencies. */
463 ip_add_adjacency (ip_lookup_main_t * lm,
464 ip_adjacency_t * adj,
466 u32 * adj_index_result);
468 void ip_del_adjacency (ip_lookup_main_t * lm, u32 adj_index);
470 ip_update_adjacency (ip_lookup_main_t * lm,
472 ip_adjacency_t * copy_adj);
475 ip_adjacency_is_multipath(ip_lookup_main_t * lm, u32 adj_index)
477 if (!vec_len(lm->multipath_adjacencies))
480 if (vec_len(lm->multipath_adjacencies) < adj_index - 1)
484 return (lm->multipath_adjacencies[adj_index].adj_index == adj_index &&
485 lm->multipath_adjacencies[adj_index].n_adj_in_block > 0);
489 ip_multipath_adjacency_free (ip_lookup_main_t * lm,
490 ip_multipath_adjacency_t * a);
493 ip_multipath_adjacency_add_del_next_hop (ip_lookup_main_t * lm,
495 u32 old_mp_adj_index,
496 u32 next_hop_adj_index,
498 u32 * new_mp_adj_index);
501 ip_interface_address_add_del (ip_lookup_main_t * lm,
508 always_inline ip_interface_address_t *
509 ip_get_interface_address (ip_lookup_main_t * lm, void * addr_fib)
511 uword * p = mhash_get (&lm->address_to_if_address_index, addr_fib);
512 return p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
516 ip_interface_address_get_address (ip_lookup_main_t * lm, ip_interface_address_t * a)
517 { return mhash_key_to_mem (&lm->address_to_if_address_index, a->address_key); }
519 always_inline ip_interface_address_t *
520 ip_interface_address_for_packet (ip_lookup_main_t * lm, vlib_buffer_t * b, u32 sw_if_index)
522 ip_adjacency_t * adj;
523 u32 if_address_index;
525 adj = ip_get_adjacency (lm, vnet_buffer (b)->ip.adj_index[VLIB_TX]);
527 ASSERT (adj->lookup_next_index == IP_LOOKUP_NEXT_ARP
528 || adj->lookup_next_index == IP_LOOKUP_NEXT_LOCAL);
529 if_address_index = adj->if_address_index;
530 if_address_index = (if_address_index == ~0 ?
531 vec_elt (lm->if_address_pool_index_by_sw_if_index, sw_if_index)
534 return (if_address_index != ~0)?pool_elt_at_index (lm->if_address_pool, if_address_index):NULL;
537 #define foreach_ip_interface_address(lm,a,sw_if_index,loop,body) \
539 vnet_main_t *_vnm = vnet_get_main(); \
540 u32 _sw_if_index = sw_if_index; \
541 vnet_sw_interface_t *_swif; \
542 _swif = vnet_get_sw_interface (_vnm, _sw_if_index); \
545 * Loop => honor unnumbered interface addressing. \
547 if (loop && _swif->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED) \
548 _sw_if_index = _swif->unnumbered_sw_if_index; \
550 (vec_len((lm)->if_address_pool_index_by_sw_if_index) \
552 ? vec_elt ((lm)->if_address_pool_index_by_sw_if_index, \
553 (_sw_if_index)) : (u32)~0; \
554 ip_interface_address_t * _a; \
557 _a = pool_elt_at_index ((lm)->if_address_pool, _ia); \
558 _ia = _a->next_this_sw_interface; \
564 void ip_lookup_init (ip_lookup_main_t * lm, u32 ip_lookup_node_index);
566 #endif /* included_ip_lookup_h */