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 pefixes 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_aligned(ip4_main.fibs, fib_table, CLIB_CACHE_LINE_BYTES);
112 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;
132 v4_fib->fwd_classify_table_index = ~0;
133 v4_fib->rev_classify_table_index = ~0;
135 fib_table_lock(fib_table->ft_index, FIB_PROTOCOL_IP4, src);
137 ip4_mtrie_init(&v4_fib->mtrie);
140 * add the special entries into the new FIB
144 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
146 fib_prefix_t prefix = ip4_specials[ii].ift_prefix;
148 prefix.fp_addr.ip4.data_u32 =
149 clib_host_to_net_u32(prefix.fp_addr.ip4.data_u32);
151 fib_table_entry_special_add(fib_table->ft_index,
153 ip4_specials[ii].ift_source,
154 ip4_specials[ii].ift_flag);
157 return (fib_table->ft_index);
161 ip4_fib_table_destroy (u32 fib_index)
163 fib_table_t *fib_table = pool_elt_at_index(ip4_main.fibs, fib_index);
164 ip4_fib_t *v4_fib = pool_elt_at_index(ip4_main.v4_fibs, fib_index);
168 * remove all the specials we added when the table was created.
169 * In reverse order so the default route is last.
171 for (ii = ARRAY_LEN(ip4_specials) - 1; ii >= 0; ii--)
173 fib_prefix_t prefix = ip4_specials[ii].ift_prefix;
175 prefix.fp_addr.ip4.data_u32 =
176 clib_host_to_net_u32(prefix.fp_addr.ip4.data_u32);
178 fib_table_entry_special_remove(fib_table->ft_index,
180 ip4_specials[ii].ift_source);
184 * validate no more routes.
186 ASSERT(0 == fib_table->ft_total_route_counts);
187 FOR_EACH_FIB_SOURCE(ii)
189 ASSERT(0 == fib_table->ft_src_route_counts[ii]);
192 if (~0 != fib_table->ft_table_id)
194 hash_unset (ip4_main.fib_index_by_table_id, fib_table->ft_table_id);
197 ip4_mtrie_free(&v4_fib->mtrie);
199 pool_put(ip4_main.v4_fibs, v4_fib);
200 pool_put(ip4_main.fibs, fib_table);
205 ip4_fib_table_find_or_create_and_lock (u32 table_id,
210 index = ip4_fib_index_from_table_id(table_id);
212 return ip4_create_fib_with_table_id(table_id, src);
214 fib_table_lock(index, FIB_PROTOCOL_IP4, src);
220 ip4_fib_table_create_and_lock (fib_source_t src)
222 return (ip4_create_fib_with_table_id(~0, src));
226 ip4_fib_table_get_index_for_sw_if_index (u32 sw_if_index)
228 if (sw_if_index >= vec_len(ip4_main.fib_index_by_sw_if_index))
231 * This is the case for interfaces that are not yet mapped to
236 return (ip4_main.fib_index_by_sw_if_index[sw_if_index]);
240 * ip4_fib_table_lookup_exact_match
242 * Exact match prefix lookup
245 ip4_fib_table_lookup_exact_match (const ip4_fib_t *fib,
246 const ip4_address_t *addr,
249 uword * hash, * result;
252 hash = fib->fib_entry_by_dst_address[len];
253 key = (addr->data_u32 & ip4_main.fib_masks[len]);
255 result = hash_get(hash, key);
257 if (NULL != result) {
260 return (FIB_NODE_INDEX_INVALID);
264 * ip4_fib_table_lookup_adj
266 * Longest prefix match
269 ip4_fib_table_lookup_lb (ip4_fib_t *fib,
270 const ip4_address_t *addr)
272 fib_node_index_t fei;
274 fei = ip4_fib_table_lookup(fib, addr, 32);
276 if (FIB_NODE_INDEX_INVALID != fei)
280 dpo = fib_entry_contribute_ip_forwarding(fei);
282 return (dpo->dpoi_index);
284 return (INDEX_INVALID);
288 * ip4_fib_table_lookup
290 * Longest prefix match
293 ip4_fib_table_lookup (const ip4_fib_t *fib,
294 const ip4_address_t *addr,
297 uword * hash, * result;
301 for (mask_len = len; mask_len >= 0; mask_len--)
303 hash = fib->fib_entry_by_dst_address[mask_len];
304 key = (addr->data_u32 & ip4_main.fib_masks[mask_len]);
306 result = hash_get (hash, key);
308 if (NULL != result) {
312 return (FIB_NODE_INDEX_INVALID);
316 ip4_fib_table_entry_insert (ip4_fib_t *fib,
317 const ip4_address_t *addr,
319 fib_node_index_t fib_entry_index)
321 uword * hash, * result;
324 key = (addr->data_u32 & ip4_main.fib_masks[len]);
325 hash = fib->fib_entry_by_dst_address[len];
326 result = hash_get (hash, key);
328 if (NULL == result) {
333 old_heap = clib_mem_set_heap (ip4_main.mtrie_mheap);
336 hash = hash_create (32 /* elts */, sizeof (uword));
337 hash_set_flags (hash, HASH_FLAG_NO_AUTO_SHRINK);
340 hash = hash_set(hash, key, fib_entry_index);
341 fib->fib_entry_by_dst_address[len] = hash;
342 clib_mem_set_heap (old_heap);
351 ip4_fib_table_entry_remove (ip4_fib_t *fib,
352 const ip4_address_t *addr,
355 uword * hash, * result;
358 key = (addr->data_u32 & ip4_main.fib_masks[len]);
359 hash = fib->fib_entry_by_dst_address[len];
360 result = hash_get (hash, key);
365 * removing a non-existant entry. i'll allow it.
372 old_heap = clib_mem_set_heap (ip4_main.mtrie_mheap);
373 hash_unset(hash, key);
374 clib_mem_set_heap (old_heap);
377 fib->fib_entry_by_dst_address[len] = hash;
381 ip4_fib_table_fwding_dpo_update (ip4_fib_t *fib,
382 const ip4_address_t *addr,
386 ip4_fib_mtrie_route_add(&fib->mtrie, addr, len, dpo->dpoi_index);
390 ip4_fib_table_fwding_dpo_remove (ip4_fib_t *fib,
391 const ip4_address_t *addr,
396 fib_prefix_t cover_prefix = {
399 const dpo_id_t *cover_dpo;
402 * We need to pass the MTRIE the LB index and address length of the
403 * covering prefix, so it can fill the plys with the correct replacement
404 * for the entry being removed
406 fib_entry_get_prefix(cover_index, &cover_prefix);
407 cover_dpo = fib_entry_contribute_ip_forwarding(cover_index);
409 ip4_fib_mtrie_route_del(&fib->mtrie,
410 addr, len, dpo->dpoi_index,
412 cover_dpo->dpoi_index);
416 ip4_fib_table_walk (ip4_fib_t *fib,
417 fib_table_walk_fn_t fn,
422 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
424 uword * hash = fib->fib_entry_by_dst_address[i];
430 hash_foreach_pair (p, hash,
432 fn(p->value[0], ctx);
441 typedef struct ip4_fib_show_walk_ctx_t_
443 fib_node_index_t *ifsw_indicies;
444 } ip4_fib_show_walk_ctx_t;
447 ip4_fib_show_walk_cb (fib_node_index_t fib_entry_index,
450 ip4_fib_show_walk_ctx_t *ctx = arg;
452 vec_add1(ctx->ifsw_indicies, fib_entry_index);
458 ip4_fib_table_show_all (ip4_fib_t *fib,
461 ip4_fib_show_walk_ctx_t ctx = {
462 .ifsw_indicies = NULL,
464 fib_node_index_t *fib_entry_index;
466 ip4_fib_table_walk(fib, ip4_fib_show_walk_cb, &ctx);
467 vec_sort_with_function(ctx.ifsw_indicies,
468 fib_entry_cmp_for_sort);
470 vec_foreach(fib_entry_index, ctx.ifsw_indicies)
472 vlib_cli_output(vm, "%U",
475 FIB_ENTRY_FORMAT_BRIEF);
478 vec_free(ctx.ifsw_indicies);
482 ip4_fib_table_show_one (ip4_fib_t *fib,
484 ip4_address_t *address,
488 vlib_cli_output(vm, "%U",
490 ip4_fib_table_lookup(fib, address, mask_len),
492 FIB_ENTRY_FORMAT_DETAIL2 :
493 FIB_ENTRY_FORMAT_DETAIL));
497 format_ip4_fib_table_memory (u8 * s, va_list * args)
499 s = format(s, "%=30s %=6d %=8ld\n",
501 pool_elts(ip4_main.fibs),
502 mheap_bytes(ip4_main.mtrie_mheap));
507 static clib_error_t *
508 ip4_show_fib (vlib_main_t * vm,
509 unformat_input_t * input,
510 vlib_cli_command_t * cmd)
512 ip4_main_t * im4 = &ip4_main;
513 fib_table_t * fib_table;
514 u64 total_mtrie_memory, total_hash_memory;
515 int verbose, matching, mtrie, memory;
516 ip4_address_t matching_address;
517 u32 matching_mask = 32;
518 int i, table_id = -1, fib_index = ~0;
522 matching = mtrie = memory = 0;
523 total_hash_memory = total_mtrie_memory = 0;
525 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
527 if (unformat (input, "brief") || unformat (input, "summary")
528 || unformat (input, "sum"))
531 else if (unformat (input, "detail") || unformat (input, "det"))
534 else if (unformat (input, "mtrie"))
537 else if (unformat (input, "mem") ||
538 unformat (input, "memory"))
541 else if (unformat (input, "%U/%d",
542 unformat_ip4_address, &matching_address, &matching_mask))
545 else if (unformat (input, "%U", unformat_ip4_address, &matching_address))
548 else if (unformat (input, "table %d", &table_id))
550 else if (unformat (input, "index %d", &fib_index))
556 pool_foreach (fib_table, im4->fibs,
558 ip4_fib_t *fib = pool_elt_at_index(im4->v4_fibs, fib_table->ft_index);
562 if (table_id >= 0 && table_id != (int)fib->table_id)
564 if (fib_index != ~0 && fib_index != (int)fib->index)
569 uword mtrie_size, hash_size;
571 mtrie_size = ip4_fib_mtrie_memory_usage(&fib->mtrie);
574 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
576 uword * hash = fib->fib_entry_by_dst_address[i];
579 hash_size += hash_bytes(hash);
583 vlib_cli_output (vm, "%U mtrie:%d hash:%d",
584 format_fib_table_name, fib->index,
588 total_mtrie_memory += mtrie_size;
589 total_hash_memory += hash_size;
593 s = format(s, "%U, fib_index:%d, flow hash:[%U] locks:[",
594 format_fib_table_name, fib->index,
597 format_ip_flow_hash_config,
598 fib_table->ft_flow_hash_config);
599 FOR_EACH_FIB_SOURCE(source)
601 if (0 != fib_table->ft_locks[source])
603 s = format(s, "%U:%d, ",
604 format_fib_source, source,
605 fib_table->ft_locks[source]);
609 vlib_cli_output (vm, "%v", s);
615 vlib_cli_output (vm, "%U", format_ip4_fib_mtrie, &fib->mtrie, verbose);
620 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
621 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
623 uword * hash = fib->fib_entry_by_dst_address[i];
624 uword n_elts = hash_elts (hash);
626 vlib_cli_output (vm, "%20d%16d", i, n_elts);
633 ip4_fib_table_show_all(fib, vm);
637 ip4_fib_table_show_one(fib, vm, &matching_address,
638 matching_mask, detail);
643 vlib_cli_output (vm, "totals: mtrie:%ld hash:%ld all:%ld",
646 total_mtrie_memory + total_hash_memory);
652 * This command displays the IPv4 FIB Tables (VRF Tables) and the route
653 * entries for each table.
655 * @note This command will run for a long time when the FIB tables are
656 * comprised of millions of entries. For those senarios, consider displaying
657 * a single table or summary mode.
660 * Example of how to display all the IPv4 FIB tables:
661 * @cliexstart{show ip fib}
662 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
665 * [@0]: dpo-load-balance: [index:0 buckets:1 uRPF:0 to:[0:0]]
666 * [0] [@0]: dpo-drop ip6
669 * [@0]: dpo-load-balance: [index:1 buckets:1 uRPF:1 to:[0:0]]
670 * [0] [@0]: dpo-drop ip6
673 * [@0]: dpo-load-balance: [index:30 buckets:1 uRPF:29 to:[0:0]]
674 * [0] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
677 * [@0]: dpo-load-balance: [index:31 buckets:4 uRPF:30 to:[0:0]]
678 * [0] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
679 * [1] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
680 * [2] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
681 * [3] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
684 * [@0]: dpo-load-balance: [index:3 buckets:1 uRPF:3 to:[0:0]]
685 * [0] [@0]: dpo-drop ip6
688 * [@0]: dpo-load-balance: [index:2 buckets:1 uRPF:2 to:[0:0]]
689 * [0] [@0]: dpo-drop ip6
692 * [@0]: dpo-load-balance: [index:4 buckets:1 uRPF:4 to:[0:0]]
693 * [0] [@0]: dpo-drop ip6
694 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
697 * [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
698 * [0] [@0]: dpo-drop ip6
701 * [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
702 * [0] [@0]: dpo-drop ip6
705 * [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
706 * [0] [@4]: ipv4-glean: af_packet0
709 * [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
710 * [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
713 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
714 * [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
717 * [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
718 * [0] [@4]: ipv4-glean: af_packet1
721 * [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
722 * [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
725 * [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
726 * [0] [@0]: dpo-drop ip6
729 * [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
730 * [0] [@0]: dpo-drop ip6
733 * [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
734 * [0] [@0]: dpo-drop ip6
736 * Example of how to display a single IPv4 FIB table:
737 * @cliexstart{show ip fib table 7}
738 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
741 * [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
742 * [0] [@0]: dpo-drop ip6
745 * [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
746 * [0] [@0]: dpo-drop ip6
749 * [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
750 * [0] [@4]: ipv4-glean: af_packet0
753 * [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
754 * [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
757 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
758 * [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
761 * [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
762 * [0] [@4]: ipv4-glean: af_packet1
765 * [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
766 * [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
769 * [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
770 * [0] [@0]: dpo-drop ip6
773 * [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
774 * [0] [@0]: dpo-drop ip6
777 * [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
778 * [0] [@0]: dpo-drop ip6
780 * Example of how to display a summary of all IPv4 FIB tables:
781 * @cliexstart{show ip fib summary}
782 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
783 * Prefix length Count
787 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
788 * Prefix length Count
796 VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
797 .path = "show ip fib",
798 .short_help = "show ip fib [summary] [table <table-id>] [index <fib-id>] [<ip4-addr>[/<mask>]] [mtrie] [detail]",
799 .function = ip4_show_fib,