2 * Copyright (c) 2016 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 #include <vnet/fib/fib_table.h>
17 #include <vnet/fib/fib_entry.h>
18 #include <vnet/fib/ip4_fib.h>
21 * A table of prefixes to be added to tables and the sources for them
23 typedef struct ip4_fib_table_special_prefix_t_ {
24 fib_prefix_t ift_prefix;
25 fib_source_t ift_source;
26 fib_entry_flag_t ift_flag;
27 } ip4_fib_table_special_prefix_t;
29 static const ip4_fib_table_special_prefix_t ip4_specials[] = {
37 .fp_proto = FIB_PROTOCOL_IP4,
39 .ift_source = FIB_SOURCE_DEFAULT_ROUTE,
40 .ift_flag = FIB_ENTRY_FLAG_DROP,
49 .fp_proto = FIB_PROTOCOL_IP4,
51 .ift_source = FIB_SOURCE_DEFAULT_ROUTE,
52 .ift_flag = FIB_ENTRY_FLAG_DROP,
61 .ip4.data_u32 = 0xf0000000,
64 .fp_proto = FIB_PROTOCOL_IP4,
66 .ift_source = FIB_SOURCE_SPECIAL,
67 .ift_flag = FIB_ENTRY_FLAG_DROP,
77 .ip4.data_u32 = 0xe0000000,
80 .fp_proto = FIB_PROTOCOL_IP4,
82 .ift_source = FIB_SOURCE_SPECIAL,
83 .ift_flag = FIB_ENTRY_FLAG_DROP,
88 * drop, but we'll allow it to be usurped by the likes of DHCP
92 .ip4.data_u32 = 0xffffffff,
95 .fp_proto = FIB_PROTOCOL_IP4,
97 .ift_source = FIB_SOURCE_DEFAULT_ROUTE,
98 .ift_flag = FIB_ENTRY_FLAG_DROP,
104 ip4_create_fib_with_table_id (u32 table_id,
107 fib_table_t *fib_table;
111 pool_get(ip4_main.fibs, fib_table);
112 clib_memset(fib_table, 0, sizeof(*fib_table));
114 old_heap = clib_mem_set_heap (ip4_main.mtrie_mheap);
115 pool_get_aligned(ip4_main.v4_fibs, v4_fib, CLIB_CACHE_LINE_BYTES);
116 clib_mem_set_heap (old_heap);
118 ASSERT((fib_table - ip4_main.fibs) ==
119 (v4_fib - ip4_main.v4_fibs));
121 fib_table->ft_proto = FIB_PROTOCOL_IP4;
122 fib_table->ft_index =
124 (fib_table - ip4_main.fibs);
126 hash_set (ip4_main.fib_index_by_table_id, table_id, fib_table->ft_index);
128 fib_table->ft_table_id =
131 fib_table->ft_flow_hash_config = IP_FLOW_HASH_DEFAULT;
133 fib_table_lock(fib_table->ft_index, FIB_PROTOCOL_IP4, src);
135 ip4_mtrie_init(&v4_fib->mtrie);
138 * add the special entries into the new FIB
142 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
144 fib_prefix_t prefix = ip4_specials[ii].ift_prefix;
146 prefix.fp_addr.ip4.data_u32 =
147 clib_host_to_net_u32(prefix.fp_addr.ip4.data_u32);
149 fib_table_entry_special_add(fib_table->ft_index,
151 ip4_specials[ii].ift_source,
152 ip4_specials[ii].ift_flag);
155 return (fib_table->ft_index);
159 ip4_fib_table_destroy (u32 fib_index)
161 fib_table_t *fib_table = pool_elt_at_index(ip4_main.fibs, fib_index);
162 ip4_fib_t *v4_fib = pool_elt_at_index(ip4_main.v4_fibs, fib_index);
167 * remove all the specials we added when the table was created.
168 * In reverse order so the default route is last.
170 for (ii = ARRAY_LEN(ip4_specials) - 1; ii >= 0; ii--)
172 fib_prefix_t prefix = ip4_specials[ii].ift_prefix;
174 prefix.fp_addr.ip4.data_u32 =
175 clib_host_to_net_u32(prefix.fp_addr.ip4.data_u32);
177 fib_table_entry_special_remove(fib_table->ft_index,
179 ip4_specials[ii].ift_source);
183 * validate no more routes.
186 if (0 != fib_table->ft_total_route_counts)
187 fib_table_assert_empty(fib_table);
190 vec_foreach(n_locks, fib_table->ft_src_route_counts)
192 ASSERT(0 == *n_locks);
195 if (~0 != fib_table->ft_table_id)
197 hash_unset (ip4_main.fib_index_by_table_id, fib_table->ft_table_id);
200 vec_free(fib_table->ft_src_route_counts);
201 ip4_mtrie_free(&v4_fib->mtrie);
203 pool_put(ip4_main.v4_fibs, v4_fib);
204 pool_put(ip4_main.fibs, fib_table);
209 ip4_fib_table_find_or_create_and_lock (u32 table_id,
214 index = ip4_fib_index_from_table_id(table_id);
216 return ip4_create_fib_with_table_id(table_id, src);
218 fib_table_lock(index, FIB_PROTOCOL_IP4, src);
224 ip4_fib_table_create_and_lock (fib_source_t src)
226 return (ip4_create_fib_with_table_id(~0, src));
230 ip4_fib_table_get_index_for_sw_if_index (u32 sw_if_index)
232 if (sw_if_index >= vec_len(ip4_main.fib_index_by_sw_if_index))
235 * This is the case for interfaces that are not yet mapped to
240 return (ip4_main.fib_index_by_sw_if_index[sw_if_index]);
244 * ip4_fib_table_lookup_exact_match
246 * Exact match prefix lookup
249 ip4_fib_table_lookup_exact_match (const ip4_fib_t *fib,
250 const ip4_address_t *addr,
253 uword * hash, * result;
256 hash = fib->fib_entry_by_dst_address[len];
257 key = (addr->data_u32 & ip4_main.fib_masks[len]);
259 result = hash_get(hash, key);
261 if (NULL != result) {
264 return (FIB_NODE_INDEX_INVALID);
268 * ip4_fib_table_lookup_adj
270 * Longest prefix match
273 ip4_fib_table_lookup_lb (ip4_fib_t *fib,
274 const ip4_address_t *addr)
276 fib_node_index_t fei;
278 fei = ip4_fib_table_lookup(fib, addr, 32);
280 if (FIB_NODE_INDEX_INVALID != fei)
284 dpo = fib_entry_contribute_ip_forwarding(fei);
286 return (dpo->dpoi_index);
288 return (INDEX_INVALID);
292 * ip4_fib_table_lookup
294 * Longest prefix match
297 ip4_fib_table_lookup (const ip4_fib_t *fib,
298 const ip4_address_t *addr,
301 uword * hash, * result;
305 for (mask_len = len; mask_len >= 0; mask_len--)
307 hash = fib->fib_entry_by_dst_address[mask_len];
308 key = (addr->data_u32 & ip4_main.fib_masks[mask_len]);
310 result = hash_get (hash, key);
312 if (NULL != result) {
316 return (FIB_NODE_INDEX_INVALID);
320 ip4_fib_table_entry_insert (ip4_fib_t *fib,
321 const ip4_address_t *addr,
323 fib_node_index_t fib_entry_index)
325 uword * hash, * result;
328 key = (addr->data_u32 & ip4_main.fib_masks[len]);
329 hash = fib->fib_entry_by_dst_address[len];
330 result = hash_get (hash, key);
332 if (NULL == result) {
337 old_heap = clib_mem_set_heap (ip4_main.mtrie_mheap);
340 hash = hash_create (32 /* elts */, sizeof (uword));
341 hash_set_flags (hash, HASH_FLAG_NO_AUTO_SHRINK);
344 hash = hash_set(hash, key, fib_entry_index);
345 fib->fib_entry_by_dst_address[len] = hash;
346 clib_mem_set_heap (old_heap);
355 ip4_fib_table_entry_remove (ip4_fib_t *fib,
356 const ip4_address_t *addr,
359 uword * hash, * result;
362 key = (addr->data_u32 & ip4_main.fib_masks[len]);
363 hash = fib->fib_entry_by_dst_address[len];
364 result = hash_get (hash, key);
369 * removing a non-existent entry. i'll allow it.
376 old_heap = clib_mem_set_heap (ip4_main.mtrie_mheap);
377 hash_unset(hash, key);
378 clib_mem_set_heap (old_heap);
381 fib->fib_entry_by_dst_address[len] = hash;
385 ip4_fib_table_fwding_dpo_update (ip4_fib_t *fib,
386 const ip4_address_t *addr,
390 ip4_fib_mtrie_route_add(&fib->mtrie, addr, len, dpo->dpoi_index);
394 ip4_fib_table_fwding_dpo_remove (ip4_fib_t *fib,
395 const ip4_address_t *addr,
400 const fib_prefix_t *cover_prefix;
401 const dpo_id_t *cover_dpo;
404 * We need to pass the MTRIE the LB index and address length of the
405 * covering prefix, so it can fill the plys with the correct replacement
406 * for the entry being removed
408 cover_prefix = fib_entry_get_prefix(cover_index);
409 cover_dpo = fib_entry_contribute_ip_forwarding(cover_index);
411 ip4_fib_mtrie_route_del(&fib->mtrie,
412 addr, len, dpo->dpoi_index,
413 cover_prefix->fp_len,
414 cover_dpo->dpoi_index);
418 ip4_fib_table_walk (ip4_fib_t *fib,
419 fib_table_walk_fn_t fn,
422 fib_prefix_t root = {
423 .fp_proto = FIB_PROTOCOL_IP4,
424 // address and length default to all 0
428 * A full tree walk is the dengenerate case of a sub-tree from
431 return (ip4_fib_table_sub_tree_walk(fib, &root, fn, ctx));
435 ip4_fib_table_sub_tree_walk (ip4_fib_t *fib,
436 const fib_prefix_t *root,
437 fib_table_walk_fn_t fn,
440 fib_prefix_t *sub_trees = NULL;
444 * There is no efficient way to walk this array of hash tables.
445 * so we walk each table with a mask length greater than and equal to
446 * the required root and check it is covered by the root.
448 for (i = root->fp_len;
449 i < ARRAY_LEN (fib->fib_entry_by_dst_address);
452 uword * hash = fib->fib_entry_by_dst_address[i];
459 hash_foreach_pair (p, hash,
462 if (ip4_destination_matches_route(&ip4_main,
467 const fib_prefix_t *sub_tree;
471 * exclude sub-trees the walk does not want to explore
473 vec_foreach(sub_tree, sub_trees)
475 if (ip4_destination_matches_route(&ip4_main,
477 &sub_tree->fp_addr.ip4,
487 switch (fn(p->value[0], ctx))
489 case FIB_TABLE_WALK_CONTINUE:
491 case FIB_TABLE_WALK_SUB_TREE_STOP: {
493 .fp_proto = FIB_PROTOCOL_IP4,
497 vec_add1(sub_trees, pfx);
500 case FIB_TABLE_WALK_STOP:
516 typedef struct ip4_fib_show_walk_ctx_t_
518 fib_node_index_t *ifsw_indicies;
519 } ip4_fib_show_walk_ctx_t;
521 static fib_table_walk_rc_t
522 ip4_fib_show_walk_cb (fib_node_index_t fib_entry_index,
525 ip4_fib_show_walk_ctx_t *ctx = arg;
527 vec_add1(ctx->ifsw_indicies, fib_entry_index);
529 return (FIB_TABLE_WALK_CONTINUE);
533 ip4_fib_table_show_all (ip4_fib_t *fib,
536 ip4_fib_show_walk_ctx_t ctx = {
537 .ifsw_indicies = NULL,
539 fib_node_index_t *fib_entry_index;
541 ip4_fib_table_walk(fib, ip4_fib_show_walk_cb, &ctx);
542 vec_sort_with_function(ctx.ifsw_indicies,
543 fib_entry_cmp_for_sort);
545 vec_foreach(fib_entry_index, ctx.ifsw_indicies)
547 vlib_cli_output(vm, "%U",
550 FIB_ENTRY_FORMAT_BRIEF);
553 vec_free(ctx.ifsw_indicies);
557 ip4_fib_table_show_one (ip4_fib_t *fib,
559 ip4_address_t *address,
563 vlib_cli_output(vm, "%U",
565 ip4_fib_table_lookup(fib, address, mask_len),
567 FIB_ENTRY_FORMAT_DETAIL2 :
568 FIB_ENTRY_FORMAT_DETAIL));
572 format_ip4_fib_table_memory (u8 * s, va_list * args)
574 #if USE_DLMALLOC == 0
575 s = format(s, "%=30s %=6d %=12ld\n",
577 pool_elts(ip4_main.fibs),
578 mheap_bytes(ip4_main.mtrie_mheap));
580 s = format(s, "%=30s %=6d %=12ld\n",
582 pool_elts(ip4_main.fibs),
583 mspace_footprint(ip4_main.mtrie_mheap));
590 static clib_error_t *
591 ip4_show_fib (vlib_main_t * vm,
592 unformat_input_t * input,
593 vlib_cli_command_t * cmd)
595 ip4_main_t * im4 = &ip4_main;
596 fib_table_t * fib_table;
597 u64 total_mtrie_memory, total_hash_memory;
598 int verbose, matching, mtrie, memory;
599 ip4_address_t matching_address;
600 u32 matching_mask = 32;
601 int i, table_id = -1, fib_index = ~0;
605 matching = mtrie = memory = 0;
606 total_hash_memory = total_mtrie_memory = 0;
608 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
610 if (unformat (input, "brief") || unformat (input, "summary")
611 || unformat (input, "sum"))
614 else if (unformat (input, "detail") || unformat (input, "det"))
617 else if (unformat (input, "mtrie"))
620 else if (unformat (input, "mem") ||
621 unformat (input, "memory"))
624 else if (unformat (input, "%U/%d",
625 unformat_ip4_address, &matching_address, &matching_mask))
628 else if (unformat (input, "%U", unformat_ip4_address, &matching_address))
631 else if (unformat (input, "table %d", &table_id))
633 else if (unformat (input, "index %d", &fib_index))
639 pool_foreach (fib_table, im4->fibs,
641 ip4_fib_t *fib = pool_elt_at_index(im4->v4_fibs, fib_table->ft_index);
645 if (table_id >= 0 && table_id != (int)fib->table_id)
647 if (fib_index != ~0 && fib_index != (int)fib->index)
652 uword mtrie_size, hash_size, *old_heap;
655 mtrie_size = ip4_fib_mtrie_memory_usage(&fib->mtrie);
658 old_heap = clib_mem_set_heap (ip4_main.mtrie_mheap);
659 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
661 uword * hash = fib->fib_entry_by_dst_address[i];
664 hash_size += hash_bytes(hash);
667 clib_mem_set_heap (old_heap);
670 vlib_cli_output (vm, "%U mtrie:%d hash:%d",
671 format_fib_table_name, fib->index,
675 total_mtrie_memory += mtrie_size;
676 total_hash_memory += hash_size;
680 s = format(s, "%U, fib_index:%d, flow hash:[%U] epoch:%d flags:%U locks:[",
681 format_fib_table_name, fib->index,
684 format_ip_flow_hash_config,
685 fib_table->ft_flow_hash_config,
687 format_fib_table_flags, fib_table->ft_flags);
688 vec_foreach_index(source, fib_table->ft_locks)
690 if (0 != fib_table->ft_locks[source])
692 s = format(s, "%U:%d, ",
693 format_fib_source, source,
694 fib_table->ft_locks[source]);
698 vlib_cli_output (vm, "%v", s);
704 vlib_cli_output (vm, "%U", format_ip4_fib_mtrie, &fib->mtrie, verbose);
709 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
710 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
712 uword * hash = fib->fib_entry_by_dst_address[i];
713 uword n_elts = hash_elts (hash);
715 vlib_cli_output (vm, "%20d%16d", i, n_elts);
722 ip4_fib_table_show_all(fib, vm);
726 ip4_fib_table_show_one(fib, vm, &matching_address,
727 matching_mask, detail);
733 vlib_cli_output (vm, "totals: mtrie:%ld hash:%ld all:%ld",
736 total_mtrie_memory + total_hash_memory);
737 vlib_cli_output (vm, "\nMtrie Mheap Usage: %U\n",
738 format_mheap, ip4_main.mtrie_mheap, 1);
744 * This command displays the IPv4 FIB Tables (VRF Tables) and the route
745 * entries for each table.
747 * @note This command will run for a long time when the FIB tables are
748 * comprised of millions of entries. For those senarios, consider displaying
749 * a single table or summary mode.
752 * Example of how to display all the IPv4 FIB tables:
753 * @cliexstart{show ip fib}
754 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
757 * [@0]: dpo-load-balance: [index:0 buckets:1 uRPF:0 to:[0:0]]
758 * [0] [@0]: dpo-drop ip6
761 * [@0]: dpo-load-balance: [index:1 buckets:1 uRPF:1 to:[0:0]]
762 * [0] [@0]: dpo-drop ip6
765 * [@0]: dpo-load-balance: [index:30 buckets:1 uRPF:29 to:[0:0]]
766 * [0] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
769 * [@0]: dpo-load-balance: [index:31 buckets:4 uRPF:30 to:[0:0]]
770 * [0] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
771 * [1] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
772 * [2] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
773 * [3] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
776 * [@0]: dpo-load-balance: [index:3 buckets:1 uRPF:3 to:[0:0]]
777 * [0] [@0]: dpo-drop ip6
780 * [@0]: dpo-load-balance: [index:2 buckets:1 uRPF:2 to:[0:0]]
781 * [0] [@0]: dpo-drop ip6
784 * [@0]: dpo-load-balance: [index:4 buckets:1 uRPF:4 to:[0:0]]
785 * [0] [@0]: dpo-drop ip6
786 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
789 * [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
790 * [0] [@0]: dpo-drop ip6
793 * [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
794 * [0] [@0]: dpo-drop ip6
797 * [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
798 * [0] [@4]: ipv4-glean: af_packet0
801 * [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
802 * [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
805 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
806 * [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
809 * [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
810 * [0] [@4]: ipv4-glean: af_packet1
813 * [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
814 * [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
817 * [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
818 * [0] [@0]: dpo-drop ip6
821 * [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
822 * [0] [@0]: dpo-drop ip6
825 * [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
826 * [0] [@0]: dpo-drop ip6
828 * Example of how to display a single IPv4 FIB table:
829 * @cliexstart{show ip fib table 7}
830 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
833 * [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
834 * [0] [@0]: dpo-drop ip6
837 * [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
838 * [0] [@0]: dpo-drop ip6
841 * [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
842 * [0] [@4]: ipv4-glean: af_packet0
845 * [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
846 * [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
849 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
850 * [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
853 * [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
854 * [0] [@4]: ipv4-glean: af_packet1
857 * [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
858 * [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
861 * [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
862 * [0] [@0]: dpo-drop ip6
865 * [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
866 * [0] [@0]: dpo-drop ip6
869 * [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
870 * [0] [@0]: dpo-drop ip6
872 * Example of how to display a summary of all IPv4 FIB tables:
873 * @cliexstart{show ip fib summary}
874 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
875 * Prefix length Count
879 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
880 * Prefix length Count
888 VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
889 .path = "show ip fib",
890 .short_help = "show ip fib [summary] [table <table-id>] [index <fib-id>] [<ip4-addr>[/<mask>]] [mtrie] [detail]",
891 .function = ip4_show_fib,