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.
162 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
164 fib_prefix_t prefix = ip4_specials[ii].ift_prefix;
166 prefix.fp_addr.ip4.data_u32 =
167 clib_host_to_net_u32(prefix.fp_addr.ip4.data_u32);
169 fib_table_entry_special_remove(fib_table->ft_index,
171 ip4_specials[ii].ift_source);
175 * validate no more routes.
177 ASSERT(0 == fib_table->ft_total_route_counts);
178 FOR_EACH_FIB_SOURCE(ii)
180 ASSERT(0 == fib_table->ft_src_route_counts[ii]);
183 if (~0 != fib_table->ft_table_id)
185 hash_unset (ip4_main.fib_index_by_table_id, fib_table->ft_table_id);
187 pool_put(ip4_main.fibs, fib_table);
192 ip4_fib_table_find_or_create_and_lock (u32 table_id)
196 index = ip4_fib_index_from_table_id(table_id);
198 return ip4_create_fib_with_table_id(table_id);
200 fib_table_lock(index, FIB_PROTOCOL_IP4);
206 ip4_fib_table_create_and_lock (void)
208 return (ip4_create_fib_with_table_id(~0));
212 ip4_fib_table_get_index_for_sw_if_index (u32 sw_if_index)
214 if (sw_if_index >= vec_len(ip4_main.fib_index_by_sw_if_index))
217 * This is the case for interfaces that are not yet mapped to
222 return (ip4_main.fib_index_by_sw_if_index[sw_if_index]);
226 ip4_fib_table_get_flow_hash_config (u32 fib_index)
228 return (ip4_fib_get(fib_index)->flow_hash_config);
232 * ip4_fib_table_lookup_exact_match
234 * Exact match prefix lookup
237 ip4_fib_table_lookup_exact_match (const ip4_fib_t *fib,
238 const ip4_address_t *addr,
241 uword * hash, * result;
244 hash = fib->fib_entry_by_dst_address[len];
245 key = (addr->data_u32 & ip4_main.fib_masks[len]);
247 result = hash_get(hash, key);
249 if (NULL != result) {
252 return (FIB_NODE_INDEX_INVALID);
256 * ip4_fib_table_lookup_adj
258 * Longest prefix match
261 ip4_fib_table_lookup_lb (ip4_fib_t *fib,
262 const ip4_address_t *addr)
264 fib_node_index_t fei;
266 fei = ip4_fib_table_lookup(fib, addr, 32);
268 if (FIB_NODE_INDEX_INVALID != fei)
272 dpo = fib_entry_contribute_ip_forwarding(fei);
274 return (dpo->dpoi_index);
276 return (INDEX_INVALID);
280 * ip4_fib_table_lookup
282 * Longest prefix match
285 ip4_fib_table_lookup (const ip4_fib_t *fib,
286 const ip4_address_t *addr,
289 uword * hash, * result;
293 for (mask_len = len; mask_len >= 0; mask_len--)
295 hash = fib->fib_entry_by_dst_address[mask_len];
296 key = (addr->data_u32 & ip4_main.fib_masks[mask_len]);
298 result = hash_get (hash, key);
300 if (NULL != result) {
304 return (FIB_NODE_INDEX_INVALID);
308 ip4_fib_table_entry_insert (ip4_fib_t *fib,
309 const ip4_address_t *addr,
311 fib_node_index_t fib_entry_index)
313 uword * hash, * result;
316 key = (addr->data_u32 & ip4_main.fib_masks[len]);
317 hash = fib->fib_entry_by_dst_address[len];
318 result = hash_get (hash, key);
320 if (NULL == result) {
325 hash = hash_create (32 /* elts */, sizeof (uword));
326 hash_set_flags (hash, HASH_FLAG_NO_AUTO_SHRINK);
328 hash = hash_set(hash, key, fib_entry_index);
329 fib->fib_entry_by_dst_address[len] = hash;
338 ip4_fib_table_entry_remove (ip4_fib_t *fib,
339 const ip4_address_t *addr,
342 uword * hash, * result;
345 key = (addr->data_u32 & ip4_main.fib_masks[len]);
346 hash = fib->fib_entry_by_dst_address[len];
347 result = hash_get (hash, key);
352 * removing a non-existant entry. i'll allow it.
357 hash_unset(hash, key);
360 fib->fib_entry_by_dst_address[len] = hash;
364 ip4_fib_table_fwding_dpo_update (ip4_fib_t *fib,
365 const ip4_address_t *addr,
369 ip4_fib_mtrie_add_del_route(fib, *addr, len, dpo->dpoi_index, 0); // ADD
373 ip4_fib_table_fwding_dpo_remove (ip4_fib_t *fib,
374 const ip4_address_t *addr,
378 ip4_fib_mtrie_add_del_route(fib, *addr, len, dpo->dpoi_index, 1); // DELETE
382 ip4_fib_table_walk (ip4_fib_t *fib,
383 fib_table_walk_fn_t fn,
388 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
390 uword * hash = fib->fib_entry_by_dst_address[i];
396 hash_foreach_pair (p, hash,
398 fn(p->value[0], ctx);
407 typedef struct ip4_fib_show_walk_ctx_t_
409 fib_node_index_t *ifsw_indicies;
410 } ip4_fib_show_walk_ctx_t;
413 ip4_fib_show_walk_cb (fib_node_index_t fib_entry_index,
416 ip4_fib_show_walk_ctx_t *ctx = arg;
418 vec_add1(ctx->ifsw_indicies, fib_entry_index);
424 ip4_fib_table_show_all (ip4_fib_t *fib,
427 ip4_fib_show_walk_ctx_t ctx = {
428 .ifsw_indicies = NULL,
430 fib_node_index_t *fib_entry_index;
432 ip4_fib_table_walk(fib, ip4_fib_show_walk_cb, &ctx);
433 vec_sort_with_function(ctx.ifsw_indicies,
434 fib_entry_cmp_for_sort);
436 vec_foreach(fib_entry_index, ctx.ifsw_indicies)
438 vlib_cli_output(vm, "%U",
441 FIB_ENTRY_FORMAT_BRIEF);
444 vec_free(ctx.ifsw_indicies);
448 ip4_fib_table_show_one (ip4_fib_t *fib,
450 ip4_address_t *address,
453 vlib_cli_output(vm, "%U",
455 ip4_fib_table_lookup(fib, address, mask_len),
456 FIB_ENTRY_FORMAT_DETAIL);
459 static clib_error_t *
460 ip4_show_fib (vlib_main_t * vm,
461 unformat_input_t * input,
462 vlib_cli_command_t * cmd)
464 ip4_main_t * im4 = &ip4_main;
465 fib_table_t * fib_table;
466 int verbose, matching, mtrie;
467 ip4_address_t matching_address;
468 u32 matching_mask = 32;
469 int i, table_id = -1, fib_index = ~0;
474 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
476 if (unformat (input, "brief") || unformat (input, "summary")
477 || unformat (input, "sum"))
480 else if (unformat (input, "mtrie"))
483 else if (unformat (input, "%U/%d",
484 unformat_ip4_address, &matching_address, &matching_mask))
487 else if (unformat (input, "%U", unformat_ip4_address, &matching_address))
490 else if (unformat (input, "table %d", &table_id))
492 else if (unformat (input, "index %d", &fib_index))
498 pool_foreach (fib_table, im4->fibs,
500 ip4_fib_t *fib = &fib_table->v4;
502 if (table_id >= 0 && table_id != (int)fib->table_id)
504 if (fib_index != ~0 && fib_index != (int)fib->index)
507 vlib_cli_output (vm, "%U, fib_index %d, flow hash: %U",
508 format_fib_table_name, fib->index, FIB_PROTOCOL_IP4,
510 format_ip_flow_hash_config, fib->flow_hash_config);
515 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
516 for (i = 0; i < ARRAY_LEN (fib->fib_entry_by_dst_address); i++)
518 uword * hash = fib->fib_entry_by_dst_address[i];
519 uword n_elts = hash_elts (hash);
521 vlib_cli_output (vm, "%20d%16d", i, n_elts);
528 ip4_fib_table_show_all(fib, vm);
532 ip4_fib_table_show_one(fib, vm, &matching_address, matching_mask);
536 vlib_cli_output (vm, "%U", format_ip4_fib_mtrie, &fib->mtrie);
543 * This command displays the IPv4 FIB Tables (VRF Tables) and the route
544 * entries for each table.
546 * @note This command will run for a long time when the FIB tables are
547 * comprised of millions of entries. For those senarios, consider displaying
548 * a single table or summary mode.
551 * Example of how to display all the IPv4 FIB tables:
552 * @cliexstart{show ip fib}
553 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
556 * [@0]: dpo-load-balance: [index:0 buckets:1 uRPF:0 to:[0:0]]
557 * [0] [@0]: dpo-drop ip6
560 * [@0]: dpo-load-balance: [index:1 buckets:1 uRPF:1 to:[0:0]]
561 * [0] [@0]: dpo-drop ip6
564 * [@0]: dpo-load-balance: [index:30 buckets:1 uRPF:29 to:[0:0]]
565 * [0] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
568 * [@0]: dpo-load-balance: [index:31 buckets:4 uRPF:30 to:[0:0]]
569 * [0] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
570 * [1] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
571 * [2] [@3]: arp-ipv4: via 6.0.0.2 af_packet0
572 * [3] [@3]: arp-ipv4: via 6.0.0.1 af_packet0
575 * [@0]: dpo-load-balance: [index:3 buckets:1 uRPF:3 to:[0:0]]
576 * [0] [@0]: dpo-drop ip6
579 * [@0]: dpo-load-balance: [index:2 buckets:1 uRPF:2 to:[0:0]]
580 * [0] [@0]: dpo-drop ip6
583 * [@0]: dpo-load-balance: [index:4 buckets:1 uRPF:4 to:[0:0]]
584 * [0] [@0]: dpo-drop ip6
585 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
588 * [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
589 * [0] [@0]: dpo-drop ip6
592 * [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
593 * [0] [@0]: dpo-drop ip6
596 * [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
597 * [0] [@4]: ipv4-glean: af_packet0
600 * [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
601 * [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
604 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
605 * [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
608 * [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
609 * [0] [@4]: ipv4-glean: af_packet1
612 * [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
613 * [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
616 * [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
617 * [0] [@0]: dpo-drop ip6
620 * [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
621 * [0] [@0]: dpo-drop ip6
624 * [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
625 * [0] [@0]: dpo-drop ip6
627 * Example of how to display a single IPv4 FIB table:
628 * @cliexstart{show ip fib table 7}
629 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
632 * [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]
633 * [0] [@0]: dpo-drop ip6
636 * [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]
637 * [0] [@0]: dpo-drop ip6
640 * [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]
641 * [0] [@4]: ipv4-glean: af_packet0
644 * [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]
645 * [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0
648 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
649 * [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36
652 * [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]
653 * [0] [@4]: ipv4-glean: af_packet1
656 * [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]
657 * [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1
660 * [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]
661 * [0] [@0]: dpo-drop ip6
664 * [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]
665 * [0] [@0]: dpo-drop ip6
668 * [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]
669 * [0] [@0]: dpo-drop ip6
671 * Example of how to display a summary of all IPv4 FIB tables:
672 * @cliexstart{show ip fib summary}
673 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
674 * Prefix length Count
678 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
679 * Prefix length Count
687 VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
688 .path = "show ip fib",
689 .short_help = "show ip fib [summary] [table <table-id>] [index <fib-id>] [<ip4-addr>[/<mask>]] [mtrie]",
690 .function = ip4_show_fib,