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;
108 pool_get_aligned(ip4_main.fibs, fib_table, CLIB_CACHE_LINE_BYTES);
109 memset(fib_table, 0, sizeof(*fib_table));
111 fib_table->ft_proto = FIB_PROTOCOL_IP4;
112 fib_table->ft_index =
113 fib_table->v4.index =
114 (fib_table - ip4_main.fibs);
116 hash_set (ip4_main.fib_index_by_table_id, table_id, fib_table->ft_index);
118 fib_table->ft_table_id =
119 fib_table->v4.table_id =
121 fib_table->ft_flow_hash_config =
122 fib_table->v4.flow_hash_config =
123 IP_FLOW_HASH_DEFAULT;
124 fib_table->v4.fwd_classify_table_index = ~0;
125 fib_table->v4.rev_classify_table_index = ~0;
127 fib_table_lock(fib_table->ft_index, FIB_PROTOCOL_IP4);
129 ip4_mtrie_init(&fib_table->v4.mtrie);
132 * add the special entries into the new FIB
136 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
138 fib_prefix_t prefix = ip4_specials[ii].ift_prefix;
140 prefix.fp_addr.ip4.data_u32 =
141 clib_host_to_net_u32(prefix.fp_addr.ip4.data_u32);
143 fib_table_entry_special_add(fib_table->ft_index,
145 ip4_specials[ii].ift_source,
146 ip4_specials[ii].ift_flag,
150 return (fib_table->ft_index);
154 ip4_fib_table_destroy (ip4_fib_t *fib)
156 fib_table_t *fib_table = (fib_table_t*)fib;
160 * remove all the specials we added when the table was created.
161 * In reverse order so the default route is last.
163 for (ii = ARRAY_LEN(ip4_specials) - 1; ii >= 0; ii--)
165 fib_prefix_t prefix = ip4_specials[ii].ift_prefix;
167 prefix.fp_addr.ip4.data_u32 =
168 clib_host_to_net_u32(prefix.fp_addr.ip4.data_u32);
170 fib_table_entry_special_remove(fib_table->ft_index,
172 ip4_specials[ii].ift_source);
176 * validate no more routes.
178 ASSERT(0 == fib_table->ft_total_route_counts);
179 FOR_EACH_FIB_SOURCE(ii)
181 ASSERT(0 == fib_table->ft_src_route_counts[ii]);
184 if (~0 != fib_table->ft_table_id)
186 hash_unset (ip4_main.fib_index_by_table_id, fib_table->ft_table_id);
188 pool_put(ip4_main.fibs, fib_table);
193 ip4_fib_table_find_or_create_and_lock (u32 table_id)
197 index = ip4_fib_index_from_table_id(table_id);
199 return ip4_create_fib_with_table_id(table_id);
201 fib_table_lock(index, FIB_PROTOCOL_IP4);
207 ip4_fib_table_create_and_lock (void)
209 return (ip4_create_fib_with_table_id(~0));
213 ip4_fib_table_get_index_for_sw_if_index (u32 sw_if_index)
215 if (sw_if_index >= vec_len(ip4_main.fib_index_by_sw_if_index))
218 * This is the case for interfaces that are not yet mapped to
223 return (ip4_main.fib_index_by_sw_if_index[sw_if_index]);
227 ip4_fib_table_get_flow_hash_config (u32 fib_index)
229 return (ip4_fib_get(fib_index)->flow_hash_config);
233 * ip4_fib_table_lookup_exact_match
235 * Exact match prefix lookup
238 ip4_fib_table_lookup_exact_match (const ip4_fib_t *fib,
239 const ip4_address_t *addr,
242 uword * hash, * result;
245 hash = fib->fib_entry_by_dst_address[len];
246 key = (addr->data_u32 & ip4_main.fib_masks[len]);
248 result = hash_get(hash, key);
250 if (NULL != result) {
253 return (FIB_NODE_INDEX_INVALID);
257 * ip4_fib_table_lookup_adj
259 * Longest prefix match
262 ip4_fib_table_lookup_lb (ip4_fib_t *fib,
263 const ip4_address_t *addr)
265 fib_node_index_t fei;
267 fei = ip4_fib_table_lookup(fib, addr, 32);
269 if (FIB_NODE_INDEX_INVALID != fei)
273 dpo = fib_entry_contribute_ip_forwarding(fei);
275 return (dpo->dpoi_index);
277 return (INDEX_INVALID);
281 * ip4_fib_table_lookup
283 * Longest prefix match
286 ip4_fib_table_lookup (const ip4_fib_t *fib,
287 const ip4_address_t *addr,
290 uword * hash, * result;
294 for (mask_len = len; mask_len >= 0; mask_len--)
296 hash = fib->fib_entry_by_dst_address[mask_len];
297 key = (addr->data_u32 & ip4_main.fib_masks[mask_len]);
299 result = hash_get (hash, key);
301 if (NULL != result) {
305 return (FIB_NODE_INDEX_INVALID);
309 ip4_fib_table_entry_insert (ip4_fib_t *fib,
310 const ip4_address_t *addr,
312 fib_node_index_t fib_entry_index)
314 uword * hash, * result;
317 key = (addr->data_u32 & ip4_main.fib_masks[len]);
318 hash = fib->fib_entry_by_dst_address[len];
319 result = hash_get (hash, key);
321 if (NULL == result) {
326 hash = hash_create (32 /* elts */, sizeof (uword));
327 hash_set_flags (hash, HASH_FLAG_NO_AUTO_SHRINK);
329 hash = hash_set(hash, key, fib_entry_index);
330 fib->fib_entry_by_dst_address[len] = hash;
339 ip4_fib_table_entry_remove (ip4_fib_t *fib,
340 const ip4_address_t *addr,
343 uword * hash, * result;
346 key = (addr->data_u32 & ip4_main.fib_masks[len]);
347 hash = fib->fib_entry_by_dst_address[len];
348 result = hash_get (hash, key);
353 * removing a non-existant entry. i'll allow it.
358 hash_unset(hash, key);
361 fib->fib_entry_by_dst_address[len] = hash;
365 ip4_fib_table_fwding_dpo_update (ip4_fib_t *fib,
366 const ip4_address_t *addr,
370 ip4_fib_mtrie_add_del_route(fib, *addr, len, dpo->dpoi_index, 0); // ADD
374 ip4_fib_table_fwding_dpo_remove (ip4_fib_t *fib,
375 const ip4_address_t *addr,
379 ip4_fib_mtrie_add_del_route(fib, *addr, len, dpo->dpoi_index, 1); // DELETE
383 ip4_fib_table_walk (ip4_fib_t *fib,
384 fib_table_walk_fn_t fn,
389 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
391 uword * hash = fib->fib_entry_by_dst_address[i];
397 hash_foreach_pair (p, hash,
399 fn(p->value[0], ctx);
408 typedef struct ip4_fib_show_walk_ctx_t_
410 fib_node_index_t *ifsw_indicies;
411 } ip4_fib_show_walk_ctx_t;
414 ip4_fib_show_walk_cb (fib_node_index_t fib_entry_index,
417 ip4_fib_show_walk_ctx_t *ctx = arg;
419 vec_add1(ctx->ifsw_indicies, fib_entry_index);
425 ip4_fib_table_show_all (ip4_fib_t *fib,
428 ip4_fib_show_walk_ctx_t ctx = {
429 .ifsw_indicies = NULL,
431 fib_node_index_t *fib_entry_index;
433 ip4_fib_table_walk(fib, ip4_fib_show_walk_cb, &ctx);
434 vec_sort_with_function(ctx.ifsw_indicies,
435 fib_entry_cmp_for_sort);
437 vec_foreach(fib_entry_index, ctx.ifsw_indicies)
439 vlib_cli_output(vm, "%U",
442 FIB_ENTRY_FORMAT_BRIEF);
445 vec_free(ctx.ifsw_indicies);
449 ip4_fib_table_show_one (ip4_fib_t *fib,
451 ip4_address_t *address,
454 vlib_cli_output(vm, "%U",
456 ip4_fib_table_lookup(fib, address, mask_len),
457 FIB_ENTRY_FORMAT_DETAIL);
460 static clib_error_t *
461 ip4_show_fib (vlib_main_t * vm,
462 unformat_input_t * input,
463 vlib_cli_command_t * cmd)
465 ip4_main_t * im4 = &ip4_main;
466 fib_table_t * fib_table;
467 int verbose, matching, mtrie;
468 ip4_address_t matching_address;
469 u32 matching_mask = 32;
470 int i, table_id = -1, fib_index = ~0;
475 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
477 if (unformat (input, "brief") || unformat (input, "summary")
478 || unformat (input, "sum"))
481 else if (unformat (input, "mtrie"))
484 else if (unformat (input, "%U/%d",
485 unformat_ip4_address, &matching_address, &matching_mask))
488 else if (unformat (input, "%U", unformat_ip4_address, &matching_address))
491 else if (unformat (input, "table %d", &table_id))
493 else if (unformat (input, "index %d", &fib_index))
499 pool_foreach (fib_table, im4->fibs,
501 ip4_fib_t *fib = &fib_table->v4;
503 if (table_id >= 0 && table_id != (int)fib->table_id)
505 if (fib_index != ~0 && fib_index != (int)fib->index)
508 vlib_cli_output (vm, "%U, fib_index %d, flow hash: %U",
509 format_fib_table_name, fib->index, FIB_PROTOCOL_IP4,
511 format_ip_flow_hash_config, fib->flow_hash_config);
516 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
517 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
519 uword * hash = fib->fib_entry_by_dst_address[i];
520 uword n_elts = hash_elts (hash);
522 vlib_cli_output (vm, "%20d%16d", i, n_elts);
529 ip4_fib_table_show_all(fib, vm);
533 ip4_fib_table_show_one(fib, vm, &matching_address, matching_mask);
537 vlib_cli_output (vm, "%U", format_ip4_fib_mtrie, &fib->mtrie);
544 * This command displays the IPv4 FIB Tables (VRF Tables) and the route
545 * entries for each table.
547 * @note This command will run for a long time when the FIB tables are
548 * comprised of millions of entries. For those senarios, consider displaying
549 * a single table or summary mode.
552 * Example of how to display all the IPv4 FIB tables:
553 * @cliexstart{show ip fib}
554 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
557 * [@0]: dpo-load-balance: [index:0 buckets:1 uRPF:0 to:[0:0]]
558 * [0] [@0]: dpo-drop ip6
561 * [@0]: dpo-load-balance: [index:1 buckets:1 uRPF:1 to:[0:0]]
562 * [0] [@0]: dpo-drop ip6
565 * [@0]: dpo-load-balance: [index:30 buckets:1 uRPF:29 to:[0:0]]
566 * [0] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
569 * [@0]: dpo-load-balance: [index:31 buckets:4 uRPF:30 to:[0:0]]
570 * [0] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
571 * [1] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
572 * [2] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
573 * [3] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
576 * [@0]: dpo-load-balance: [index:3 buckets:1 uRPF:3 to:[0:0]]
577 * [0] [@0]: dpo-drop ip6
580 * [@0]: dpo-load-balance: [index:2 buckets:1 uRPF:2 to:[0:0]]
581 * [0] [@0]: dpo-drop ip6
584 * [@0]: dpo-load-balance: [index:4 buckets:1 uRPF:4 to:[0:0]]
585 * [0] [@0]: dpo-drop ip6
586 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
589 * [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
590 * [0] [@0]: dpo-drop ip6
593 * [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
594 * [0] [@0]: dpo-drop ip6
597 * [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
598 * [0] [@4]: ipv4-glean: af_packet0
601 * [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
602 * [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
605 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
606 * [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
609 * [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
610 * [0] [@4]: ipv4-glean: af_packet1
613 * [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
614 * [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
617 * [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
618 * [0] [@0]: dpo-drop ip6
621 * [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
622 * [0] [@0]: dpo-drop ip6
625 * [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
626 * [0] [@0]: dpo-drop ip6
628 * Example of how to display a single IPv4 FIB table:
629 * @cliexstart{show ip fib table 7}
630 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
633 * [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
634 * [0] [@0]: dpo-drop ip6
637 * [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
638 * [0] [@0]: dpo-drop ip6
641 * [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
642 * [0] [@4]: ipv4-glean: af_packet0
645 * [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
646 * [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
649 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
650 * [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
653 * [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
654 * [0] [@4]: ipv4-glean: af_packet1
657 * [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
658 * [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
661 * [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
662 * [0] [@0]: dpo-drop ip6
665 * [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
666 * [0] [@0]: dpo-drop ip6
669 * [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
670 * [0] [@0]: dpo-drop ip6
672 * Example of how to display a summary of all IPv4 FIB tables:
673 * @cliexstart{show ip fib summary}
674 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
675 * Prefix length Count
679 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
680 * Prefix length Count
688 VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
689 .path = "show ip fib",
690 .short_help = "show ip fib [summary] [table <table-id>] [index <fib-id>] [<ip4-addr>[/<mask>]] [mtrie]",
691 .function = ip4_show_fib,