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)
106 fib_table_t *fib_table;
109 pool_get_aligned(ip4_main.fibs, fib_table, CLIB_CACHE_LINE_BYTES);
110 memset(fib_table, 0, sizeof(*fib_table));
112 pool_get_aligned(ip4_main.v4_fibs, v4_fib, CLIB_CACHE_LINE_BYTES);
114 ASSERT((fib_table - ip4_main.fibs) ==
115 (v4_fib - ip4_main.v4_fibs));
117 fib_table->ft_proto = FIB_PROTOCOL_IP4;
118 fib_table->ft_index =
120 (fib_table - ip4_main.fibs);
122 hash_set (ip4_main.fib_index_by_table_id, table_id, fib_table->ft_index);
124 fib_table->ft_table_id =
127 fib_table->ft_flow_hash_config =
128 v4_fib->flow_hash_config =
129 IP_FLOW_HASH_DEFAULT;
130 v4_fib->fwd_classify_table_index = ~0;
131 v4_fib->rev_classify_table_index = ~0;
133 fib_table_lock(fib_table->ft_index, FIB_PROTOCOL_IP4);
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);
166 * remove all the specials we added when the table was created.
167 * In reverse order so the default route is last.
169 for (ii = ARRAY_LEN(ip4_specials) - 1; ii >= 0; ii--)
171 fib_prefix_t prefix = ip4_specials[ii].ift_prefix;
173 prefix.fp_addr.ip4.data_u32 =
174 clib_host_to_net_u32(prefix.fp_addr.ip4.data_u32);
176 fib_table_entry_special_remove(fib_table->ft_index,
178 ip4_specials[ii].ift_source);
182 * validate no more routes.
184 ASSERT(0 == fib_table->ft_total_route_counts);
185 FOR_EACH_FIB_SOURCE(ii)
187 ASSERT(0 == fib_table->ft_src_route_counts[ii]);
190 if (~0 != fib_table->ft_table_id)
192 hash_unset (ip4_main.fib_index_by_table_id, fib_table->ft_table_id);
195 ip4_mtrie_free(&v4_fib->mtrie);
197 pool_put(ip4_main.v4_fibs, v4_fib);
198 pool_put(ip4_main.fibs, fib_table);
203 ip4_fib_table_find_or_create_and_lock (u32 table_id)
207 index = ip4_fib_index_from_table_id(table_id);
209 return ip4_create_fib_with_table_id(table_id);
211 fib_table_lock(index, FIB_PROTOCOL_IP4);
217 ip4_fib_table_create_and_lock (void)
219 return (ip4_create_fib_with_table_id(~0));
223 ip4_fib_table_get_index_for_sw_if_index (u32 sw_if_index)
225 if (sw_if_index >= vec_len(ip4_main.fib_index_by_sw_if_index))
228 * This is the case for interfaces that are not yet mapped to
233 return (ip4_main.fib_index_by_sw_if_index[sw_if_index]);
237 ip4_fib_table_get_flow_hash_config (u32 fib_index)
239 return (ip4_fib_get(fib_index)->flow_hash_config);
243 * ip4_fib_table_lookup_exact_match
245 * Exact match prefix lookup
248 ip4_fib_table_lookup_exact_match (const ip4_fib_t *fib,
249 const ip4_address_t *addr,
252 uword * hash, * result;
255 hash = fib->fib_entry_by_dst_address[len];
256 key = (addr->data_u32 & ip4_main.fib_masks[len]);
258 result = hash_get(hash, key);
260 if (NULL != result) {
263 return (FIB_NODE_INDEX_INVALID);
267 * ip4_fib_table_lookup_adj
269 * Longest prefix match
272 ip4_fib_table_lookup_lb (ip4_fib_t *fib,
273 const ip4_address_t *addr)
275 fib_node_index_t fei;
277 fei = ip4_fib_table_lookup(fib, addr, 32);
279 if (FIB_NODE_INDEX_INVALID != fei)
283 dpo = fib_entry_contribute_ip_forwarding(fei);
285 return (dpo->dpoi_index);
287 return (INDEX_INVALID);
291 * ip4_fib_table_lookup
293 * Longest prefix match
296 ip4_fib_table_lookup (const ip4_fib_t *fib,
297 const ip4_address_t *addr,
300 uword * hash, * result;
304 for (mask_len = len; mask_len >= 0; mask_len--)
306 hash = fib->fib_entry_by_dst_address[mask_len];
307 key = (addr->data_u32 & ip4_main.fib_masks[mask_len]);
309 result = hash_get (hash, key);
311 if (NULL != result) {
315 return (FIB_NODE_INDEX_INVALID);
319 ip4_fib_table_entry_insert (ip4_fib_t *fib,
320 const ip4_address_t *addr,
322 fib_node_index_t fib_entry_index)
324 uword * hash, * result;
327 key = (addr->data_u32 & ip4_main.fib_masks[len]);
328 hash = fib->fib_entry_by_dst_address[len];
329 result = hash_get (hash, key);
331 if (NULL == result) {
336 hash = hash_create (32 /* elts */, sizeof (uword));
337 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-existant 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 fib_prefix_t cover_prefix = {
393 const dpo_id_t *cover_dpo;
396 * We need to pass the MTRIE the LB index and address length of the
397 * covering prefix, so it can fill the plys with the correct replacement
398 * for the entry being removed
400 fib_entry_get_prefix(cover_index, &cover_prefix);
401 cover_dpo = fib_entry_contribute_ip_forwarding(cover_index);
403 ip4_fib_mtrie_route_del(&fib->mtrie,
404 addr, len, dpo->dpoi_index,
406 cover_dpo->dpoi_index);
410 ip4_fib_table_walk (ip4_fib_t *fib,
411 fib_table_walk_fn_t fn,
416 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
418 uword * hash = fib->fib_entry_by_dst_address[i];
424 hash_foreach_pair (p, hash,
426 fn(p->value[0], ctx);
435 typedef struct ip4_fib_show_walk_ctx_t_
437 fib_node_index_t *ifsw_indicies;
438 } ip4_fib_show_walk_ctx_t;
441 ip4_fib_show_walk_cb (fib_node_index_t fib_entry_index,
444 ip4_fib_show_walk_ctx_t *ctx = arg;
446 vec_add1(ctx->ifsw_indicies, fib_entry_index);
452 ip4_fib_table_show_all (ip4_fib_t *fib,
455 ip4_fib_show_walk_ctx_t ctx = {
456 .ifsw_indicies = NULL,
458 fib_node_index_t *fib_entry_index;
460 ip4_fib_table_walk(fib, ip4_fib_show_walk_cb, &ctx);
461 vec_sort_with_function(ctx.ifsw_indicies,
462 fib_entry_cmp_for_sort);
464 vec_foreach(fib_entry_index, ctx.ifsw_indicies)
466 vlib_cli_output(vm, "%U",
469 FIB_ENTRY_FORMAT_BRIEF);
472 vec_free(ctx.ifsw_indicies);
476 ip4_fib_table_show_one (ip4_fib_t *fib,
478 ip4_address_t *address,
482 vlib_cli_output(vm, "%U",
484 ip4_fib_table_lookup(fib, address, mask_len),
486 FIB_ENTRY_FORMAT_DETAIL2 :
487 FIB_ENTRY_FORMAT_DETAIL));
490 static clib_error_t *
491 ip4_show_fib (vlib_main_t * vm,
492 unformat_input_t * input,
493 vlib_cli_command_t * cmd)
495 ip4_main_t * im4 = &ip4_main;
496 fib_table_t * fib_table;
497 int verbose, matching, mtrie;
498 ip4_address_t matching_address;
499 u32 matching_mask = 32;
500 int i, table_id = -1, fib_index = ~0;
506 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
508 if (unformat (input, "brief") || unformat (input, "summary")
509 || unformat (input, "sum"))
512 else if (unformat (input, "detail") || unformat (input, "det"))
515 else if (unformat (input, "mtrie"))
518 else if (unformat (input, "%U/%d",
519 unformat_ip4_address, &matching_address, &matching_mask))
522 else if (unformat (input, "%U", unformat_ip4_address, &matching_address))
525 else if (unformat (input, "table %d", &table_id))
527 else if (unformat (input, "index %d", &fib_index))
533 pool_foreach (fib_table, im4->fibs,
535 ip4_fib_t *fib = pool_elt_at_index(im4->v4_fibs, fib_table->ft_index);
537 if (table_id >= 0 && table_id != (int)fib->table_id)
539 if (fib_index != ~0 && fib_index != (int)fib->index)
542 vlib_cli_output (vm, "%U, fib_index %d, flow hash: %U",
543 format_fib_table_name, fib->index, FIB_PROTOCOL_IP4,
545 format_ip_flow_hash_config, fib->flow_hash_config);
550 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
551 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
553 uword * hash = fib->fib_entry_by_dst_address[i];
554 uword n_elts = hash_elts (hash);
556 vlib_cli_output (vm, "%20d%16d", i, n_elts);
562 vlib_cli_output (vm, "%U", format_ip4_fib_mtrie, &fib->mtrie);
568 ip4_fib_table_show_all(fib, vm);
572 ip4_fib_table_show_one(fib, vm, &matching_address,
573 matching_mask, detail);
581 * This command displays the IPv4 FIB Tables (VRF Tables) and the route
582 * entries for each table.
584 * @note This command will run for a long time when the FIB tables are
585 * comprised of millions of entries. For those senarios, consider displaying
586 * a single table or summary mode.
589 * Example of how to display all the IPv4 FIB tables:
590 * @cliexstart{show ip fib}
591 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
594 * [@0]: dpo-load-balance: [index:0 buckets:1 uRPF:0 to:[0:0]]
595 * [0] [@0]: dpo-drop ip6
598 * [@0]: dpo-load-balance: [index:1 buckets:1 uRPF:1 to:[0:0]]
599 * [0] [@0]: dpo-drop ip6
602 * [@0]: dpo-load-balance: [index:30 buckets:1 uRPF:29 to:[0:0]]
603 * [0] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
606 * [@0]: dpo-load-balance: [index:31 buckets:4 uRPF:30 to:[0:0]]
607 * [0] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
608 * [1] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
609 * [2] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
610 * [3] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
613 * [@0]: dpo-load-balance: [index:3 buckets:1 uRPF:3 to:[0:0]]
614 * [0] [@0]: dpo-drop ip6
617 * [@0]: dpo-load-balance: [index:2 buckets:1 uRPF:2 to:[0:0]]
618 * [0] [@0]: dpo-drop ip6
621 * [@0]: dpo-load-balance: [index:4 buckets:1 uRPF:4 to:[0:0]]
622 * [0] [@0]: dpo-drop ip6
623 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
626 * [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
627 * [0] [@0]: dpo-drop ip6
630 * [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
631 * [0] [@0]: dpo-drop ip6
634 * [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
635 * [0] [@4]: ipv4-glean: af_packet0
638 * [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
639 * [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
642 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
643 * [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
646 * [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
647 * [0] [@4]: ipv4-glean: af_packet1
650 * [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
651 * [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
654 * [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
655 * [0] [@0]: dpo-drop ip6
658 * [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
659 * [0] [@0]: dpo-drop ip6
662 * [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
663 * [0] [@0]: dpo-drop ip6
665 * Example of how to display a single IPv4 FIB table:
666 * @cliexstart{show ip fib table 7}
667 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
670 * [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
671 * [0] [@0]: dpo-drop ip6
674 * [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
675 * [0] [@0]: dpo-drop ip6
678 * [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
679 * [0] [@4]: ipv4-glean: af_packet0
682 * [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
683 * [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
686 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
687 * [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
690 * [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
691 * [0] [@4]: ipv4-glean: af_packet1
694 * [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
695 * [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
698 * [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
699 * [0] [@0]: dpo-drop ip6
702 * [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
703 * [0] [@0]: dpo-drop ip6
706 * [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
707 * [0] [@0]: dpo-drop ip6
709 * Example of how to display a summary of all IPv4 FIB tables:
710 * @cliexstart{show ip fib summary}
711 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
712 * Prefix length Count
716 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
717 * Prefix length Count
725 VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
726 .path = "show ip fib",
727 .short_help = "show ip fib [summary] [table <table-id>] [index <fib-id>] [<ip4-addr>[/<mask>]] [mtrie] [detail]",
728 .function = ip4_show_fib,