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;
110 pool_get(ip4_main.fibs, fib_table);
111 clib_memset(fib_table, 0, sizeof(*fib_table));
113 pool_get_aligned(ip4_main.v4_fibs, v4_fib, CLIB_CACHE_LINE_BYTES);
115 ASSERT((fib_table - ip4_main.fibs) ==
116 (v4_fib - ip4_main.v4_fibs));
118 fib_table->ft_proto = FIB_PROTOCOL_IP4;
119 fib_table->ft_index =
121 (fib_table - ip4_main.fibs);
123 hash_set (ip4_main.fib_index_by_table_id, table_id, fib_table->ft_index);
125 fib_table->ft_table_id =
128 fib_table->ft_flow_hash_config = IP_FLOW_HASH_DEFAULT;
130 fib_table_lock(fib_table->ft_index, FIB_PROTOCOL_IP4, src);
132 ip4_mtrie_init(&v4_fib->mtrie);
135 * add the special entries into the new FIB
139 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
141 fib_prefix_t prefix = ip4_specials[ii].ift_prefix;
143 prefix.fp_addr.ip4.data_u32 =
144 clib_host_to_net_u32(prefix.fp_addr.ip4.data_u32);
146 fib_table_entry_special_add(fib_table->ft_index,
148 ip4_specials[ii].ift_source,
149 ip4_specials[ii].ift_flag);
152 return (fib_table->ft_index);
156 ip4_fib_table_destroy (u32 fib_index)
158 fib_table_t *fib_table = pool_elt_at_index(ip4_main.fibs, fib_index);
159 ip4_fib_t *v4_fib = pool_elt_at_index(ip4_main.v4_fibs, fib_index);
164 * remove all the specials we added when the table was created.
165 * In reverse order so the default route is last.
167 for (ii = ARRAY_LEN(ip4_specials) - 1; ii >= 0; ii--)
169 fib_prefix_t prefix = ip4_specials[ii].ift_prefix;
171 prefix.fp_addr.ip4.data_u32 =
172 clib_host_to_net_u32(prefix.fp_addr.ip4.data_u32);
174 fib_table_entry_special_remove(fib_table->ft_index,
176 ip4_specials[ii].ift_source);
180 * validate no more routes.
183 if (0 != fib_table->ft_total_route_counts)
184 fib_table_assert_empty(fib_table);
187 vec_foreach(n_locks, fib_table->ft_src_route_counts)
189 ASSERT(0 == *n_locks);
192 if (~0 != fib_table->ft_table_id)
194 hash_unset (ip4_main.fib_index_by_table_id, fib_table->ft_table_id);
197 vec_free(fib_table->ft_src_route_counts);
198 ip4_mtrie_free(&v4_fib->mtrie);
200 pool_put(ip4_main.v4_fibs, v4_fib);
201 pool_put(ip4_main.fibs, fib_table);
206 ip4_fib_table_find_or_create_and_lock (u32 table_id,
211 index = ip4_fib_index_from_table_id(table_id);
213 return ip4_create_fib_with_table_id(table_id, src);
215 fib_table_lock(index, FIB_PROTOCOL_IP4, src);
221 ip4_fib_table_create_and_lock (fib_source_t src)
223 return (ip4_create_fib_with_table_id(~0, src));
227 ip4_fib_table_get_index_for_sw_if_index (u32 sw_if_index)
229 if (sw_if_index >= vec_len(ip4_main.fib_index_by_sw_if_index))
232 * This is the case for interfaces that are not yet mapped to
237 return (ip4_main.fib_index_by_sw_if_index[sw_if_index]);
241 * ip4_fib_table_lookup_exact_match
243 * Exact match prefix lookup
246 ip4_fib_table_lookup_exact_match (const ip4_fib_t *fib,
247 const ip4_address_t *addr,
250 uword * hash, * result;
253 hash = fib->fib_entry_by_dst_address[len];
254 key = (addr->data_u32 & ip4_main.fib_masks[len]);
256 result = hash_get(hash, key);
258 if (NULL != result) {
261 return (FIB_NODE_INDEX_INVALID);
265 * ip4_fib_table_lookup_adj
267 * Longest prefix match
270 ip4_fib_table_lookup_lb (ip4_fib_t *fib,
271 const ip4_address_t *addr)
273 fib_node_index_t fei;
275 fei = ip4_fib_table_lookup(fib, addr, 32);
277 if (FIB_NODE_INDEX_INVALID != fei)
281 dpo = fib_entry_contribute_ip_forwarding(fei);
283 return (dpo->dpoi_index);
285 return (INDEX_INVALID);
289 * ip4_fib_table_lookup
291 * Longest prefix match
294 ip4_fib_table_lookup (const ip4_fib_t *fib,
295 const ip4_address_t *addr,
298 uword * hash, * result;
302 for (mask_len = len; mask_len >= 0; mask_len--)
304 hash = fib->fib_entry_by_dst_address[mask_len];
305 key = (addr->data_u32 & ip4_main.fib_masks[mask_len]);
307 result = hash_get (hash, key);
309 if (NULL != result) {
313 return (FIB_NODE_INDEX_INVALID);
317 ip4_fib_table_entry_insert (ip4_fib_t *fib,
318 const ip4_address_t *addr,
320 fib_node_index_t fib_entry_index)
322 uword * hash, * result;
325 key = (addr->data_u32 & ip4_main.fib_masks[len]);
326 hash = fib->fib_entry_by_dst_address[len];
327 result = hash_get (hash, key);
329 if (NULL == result) {
335 hash = hash_create (32 /* elts */, sizeof (uword));
336 hash_set_flags (hash, HASH_FLAG_NO_AUTO_SHRINK);
339 hash = hash_set(hash, key, fib_entry_index);
340 fib->fib_entry_by_dst_address[len] = hash;
349 ip4_fib_table_entry_remove (ip4_fib_t *fib,
350 const ip4_address_t *addr,
353 uword * hash, * result;
356 key = (addr->data_u32 & ip4_main.fib_masks[len]);
357 hash = fib->fib_entry_by_dst_address[len];
358 result = hash_get (hash, key);
363 * removing a non-existent entry. i'll allow it.
368 hash_unset(hash, key);
371 fib->fib_entry_by_dst_address[len] = hash;
375 ip4_fib_table_fwding_dpo_update (ip4_fib_t *fib,
376 const ip4_address_t *addr,
380 ip4_fib_mtrie_route_add(&fib->mtrie, addr, len, dpo->dpoi_index);
384 ip4_fib_table_fwding_dpo_remove (ip4_fib_t *fib,
385 const ip4_address_t *addr,
390 const fib_prefix_t *cover_prefix;
391 const dpo_id_t *cover_dpo;
394 * We need to pass the MTRIE the LB index and address length of the
395 * covering prefix, so it can fill the plys with the correct replacement
396 * for the entry being removed
398 cover_prefix = fib_entry_get_prefix(cover_index);
399 cover_dpo = fib_entry_contribute_ip_forwarding(cover_index);
401 ip4_fib_mtrie_route_del(&fib->mtrie,
402 addr, len, dpo->dpoi_index,
403 cover_prefix->fp_len,
404 cover_dpo->dpoi_index);
408 ip4_fib_table_walk (ip4_fib_t *fib,
409 fib_table_walk_fn_t fn,
412 fib_prefix_t root = {
413 .fp_proto = FIB_PROTOCOL_IP4,
414 // address and length default to all 0
418 * A full tree walk is the dengenerate case of a sub-tree from
421 return (ip4_fib_table_sub_tree_walk(fib, &root, fn, ctx));
425 ip4_fib_table_sub_tree_walk (ip4_fib_t *fib,
426 const fib_prefix_t *root,
427 fib_table_walk_fn_t fn,
430 fib_prefix_t *sub_trees = NULL;
434 * There is no efficient way to walk this array of hash tables.
435 * so we walk each table with a mask length greater than and equal to
436 * the required root and check it is covered by the root.
438 for (i = root->fp_len;
439 i < ARRAY_LEN (fib->fib_entry_by_dst_address);
442 uword * hash = fib->fib_entry_by_dst_address[i];
449 hash_foreach_pair (p, hash,
452 if (ip4_destination_matches_route(&ip4_main,
457 const fib_prefix_t *sub_tree;
461 * exclude sub-trees the walk does not want to explore
463 vec_foreach(sub_tree, sub_trees)
465 if (ip4_destination_matches_route(&ip4_main,
467 &sub_tree->fp_addr.ip4,
477 switch (fn(p->value[0], ctx))
479 case FIB_TABLE_WALK_CONTINUE:
481 case FIB_TABLE_WALK_SUB_TREE_STOP: {
483 .fp_proto = FIB_PROTOCOL_IP4,
487 vec_add1(sub_trees, pfx);
490 case FIB_TABLE_WALK_STOP:
506 typedef struct ip4_fib_show_walk_ctx_t_
508 fib_node_index_t *ifsw_indicies;
509 } ip4_fib_show_walk_ctx_t;
511 static fib_table_walk_rc_t
512 ip4_fib_show_walk_cb (fib_node_index_t fib_entry_index,
515 ip4_fib_show_walk_ctx_t *ctx = arg;
517 vec_add1(ctx->ifsw_indicies, fib_entry_index);
519 return (FIB_TABLE_WALK_CONTINUE);
523 ip4_fib_table_show_all (ip4_fib_t *fib,
526 ip4_fib_show_walk_ctx_t ctx = {
527 .ifsw_indicies = NULL,
529 fib_node_index_t *fib_entry_index;
531 ip4_fib_table_walk(fib, ip4_fib_show_walk_cb, &ctx);
532 vec_sort_with_function(ctx.ifsw_indicies,
533 fib_entry_cmp_for_sort);
535 vec_foreach(fib_entry_index, ctx.ifsw_indicies)
537 vlib_cli_output(vm, "%U",
540 FIB_ENTRY_FORMAT_BRIEF);
543 vec_free(ctx.ifsw_indicies);
547 ip4_fib_table_show_one (ip4_fib_t *fib,
549 ip4_address_t *address,
553 vlib_cli_output(vm, "%U",
555 ip4_fib_table_lookup(fib, address, mask_len),
557 FIB_ENTRY_FORMAT_DETAIL2 :
558 FIB_ENTRY_FORMAT_DETAIL));
562 format_ip4_fib_table_memory (u8 * s, va_list * args)
564 s = format(s, "%=30s %=6d\n",
566 pool_elts(ip4_main.fibs));
570 static clib_error_t *
571 ip4_show_fib (vlib_main_t * vm,
572 unformat_input_t * input,
573 vlib_cli_command_t * cmd)
575 ip4_main_t * im4 = &ip4_main;
576 fib_table_t * fib_table;
577 u64 total_mtrie_memory, total_hash_memory;
578 int verbose, matching, mtrie, memory;
579 ip4_address_t matching_address;
580 u32 matching_mask = 32;
581 int i, table_id = -1, fib_index = ~0;
585 matching = mtrie = memory = 0;
586 total_hash_memory = total_mtrie_memory = 0;
588 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
590 if (unformat (input, "brief") || unformat (input, "summary")
591 || unformat (input, "sum"))
594 else if (unformat (input, "detail") || unformat (input, "det"))
597 else if (unformat (input, "mtrie"))
600 else if (unformat (input, "mem") ||
601 unformat (input, "memory"))
604 else if (unformat (input, "%U/%d",
605 unformat_ip4_address, &matching_address, &matching_mask))
608 else if (unformat (input, "%U", unformat_ip4_address, &matching_address))
611 else if (unformat (input, "table %d", &table_id))
613 else if (unformat (input, "index %d", &fib_index))
619 pool_foreach (fib_table, im4->fibs)
621 ip4_fib_t *fib = pool_elt_at_index(im4->v4_fibs, fib_table->ft_index);
625 if (table_id >= 0 && table_id != (int)fib->table_id)
627 if (fib_index != ~0 && fib_index != (int)fib->index)
632 uword mtrie_size, hash_size;
635 mtrie_size = ip4_fib_mtrie_memory_usage(&fib->mtrie);
638 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
640 uword * hash = fib->fib_entry_by_dst_address[i];
643 hash_size += hash_bytes(hash);
648 vlib_cli_output (vm, "%U mtrie:%d hash:%d",
649 format_fib_table_name, fib->index,
653 total_mtrie_memory += mtrie_size;
654 total_hash_memory += hash_size;
658 s = format(s, "%U, fib_index:%d, flow hash:[%U] epoch:%d flags:%U locks:[",
659 format_fib_table_name, fib->index,
662 format_ip_flow_hash_config,
663 fib_table->ft_flow_hash_config,
665 format_fib_table_flags, fib_table->ft_flags);
666 vec_foreach_index(source, fib_table->ft_locks)
668 if (0 != fib_table->ft_locks[source])
670 s = format(s, "%U:%d, ",
671 format_fib_source, source,
672 fib_table->ft_locks[source]);
676 vlib_cli_output (vm, "%v", s);
682 vlib_cli_output (vm, "%U", format_ip4_fib_mtrie, &fib->mtrie, verbose);
687 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
688 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
690 uword * hash = fib->fib_entry_by_dst_address[i];
691 uword n_elts = hash_elts (hash);
693 vlib_cli_output (vm, "%20d%16d", i, n_elts);
700 ip4_fib_table_show_all(fib, vm);
704 ip4_fib_table_show_one(fib, vm, &matching_address,
705 matching_mask, detail);
711 vlib_cli_output (vm, "totals: mtrie:%ld hash:%ld all:%ld",
714 total_mtrie_memory + total_hash_memory);
720 * This command displays the IPv4 FIB Tables (VRF Tables) and the route
721 * entries for each table.
723 * @note This command will run for a long time when the FIB tables are
724 * comprised of millions of entries. For those senarios, consider displaying
725 * a single table or summary mode.
728 * Example of how to display all the IPv4 FIB tables:
729 * @cliexstart{show ip fib}
730 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
733 * [@0]: dpo-load-balance: [index:0 buckets:1 uRPF:0 to:[0:0]]
734 * [0] [@0]: dpo-drop ip6
737 * [@0]: dpo-load-balance: [index:1 buckets:1 uRPF:1 to:[0:0]]
738 * [0] [@0]: dpo-drop ip6
741 * [@0]: dpo-load-balance: [index:30 buckets:1 uRPF:29 to:[0:0]]
742 * [0] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
745 * [@0]: dpo-load-balance: [index:31 buckets:4 uRPF:30 to:[0:0]]
746 * [0] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
747 * [1] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
748 * [2] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
749 * [3] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
752 * [@0]: dpo-load-balance: [index:3 buckets:1 uRPF:3 to:[0:0]]
753 * [0] [@0]: dpo-drop ip6
756 * [@0]: dpo-load-balance: [index:2 buckets:1 uRPF:2 to:[0:0]]
757 * [0] [@0]: dpo-drop ip6
760 * [@0]: dpo-load-balance: [index:4 buckets:1 uRPF:4 to:[0:0]]
761 * [0] [@0]: dpo-drop ip6
762 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
765 * [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
766 * [0] [@0]: dpo-drop ip6
769 * [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
770 * [0] [@0]: dpo-drop ip6
773 * [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
774 * [0] [@4]: ipv4-glean: af_packet0
777 * [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
778 * [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
781 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
782 * [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
785 * [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
786 * [0] [@4]: ipv4-glean: af_packet1
789 * [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
790 * [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
793 * [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
794 * [0] [@0]: dpo-drop ip6
797 * [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
798 * [0] [@0]: dpo-drop ip6
801 * [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
802 * [0] [@0]: dpo-drop ip6
804 * Example of how to display a single IPv4 FIB table:
805 * @cliexstart{show ip fib table 7}
806 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
809 * [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
810 * [0] [@0]: dpo-drop ip6
813 * [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
814 * [0] [@0]: dpo-drop ip6
817 * [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
818 * [0] [@4]: ipv4-glean: af_packet0
821 * [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
822 * [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
825 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
826 * [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
829 * [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
830 * [0] [@4]: ipv4-glean: af_packet1
833 * [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
834 * [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
837 * [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
838 * [0] [@0]: dpo-drop ip6
841 * [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
842 * [0] [@0]: dpo-drop ip6
845 * [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
846 * [0] [@0]: dpo-drop ip6
848 * Example of how to display a summary of all IPv4 FIB tables:
849 * @cliexstart{show ip fib summary}
850 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
851 * Prefix length Count
855 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
856 * Prefix length Count
864 VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
865 .path = "show ip fib",
866 .short_help = "show ip fib [summary] [table <table-id>] [index <fib-id>] [<ip4-addr>[/<mask>]] [mtrie] [detail]",
867 .function = ip4_show_fib,