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/mfib/ip4_mfib.h>
18 #include <vnet/mfib/mfib_table.h>
19 #include <vnet/mfib/mfib_entry.h>
21 static const mfib_prefix_t all_zeros =
23 .fp_proto = FIB_PROTOCOL_IP4,
25 static const mfib_prefix_t ip4_specials[] =
27 /* ALL prefixes are in network order */
29 /* (*,224.0.0.1)/32 - all hosts */
31 .ip4.data_u32 = 0x010000e0,
34 .fp_proto = FIB_PROTOCOL_IP4,
37 /* (*,224.0.0.2)/32 - all routers */
39 .ip4.data_u32 = 0x020000e0,
42 .fp_proto = FIB_PROTOCOL_IP4,
47 ip4_create_mfib_with_table_id (u32 table_id,
50 mfib_table_t *mfib_table;
52 pool_get_aligned(ip4_main.mfibs, mfib_table, CLIB_CACHE_LINE_BYTES);
53 clib_memset(mfib_table, 0, sizeof(*mfib_table));
55 mfib_table->mft_proto = FIB_PROTOCOL_IP4;
56 mfib_table->mft_index =
57 mfib_table->v4.index =
58 (mfib_table - ip4_main.mfibs);
60 hash_set (ip4_main.mfib_index_by_table_id,
62 mfib_table->mft_index);
64 mfib_table->mft_table_id =
65 mfib_table->v4.table_id =
68 mfib_table_lock(mfib_table->mft_index, FIB_PROTOCOL_IP4, src);
71 * add the default route into the new FIB
73 mfib_table_entry_update(mfib_table->mft_index,
75 MFIB_SOURCE_DEFAULT_ROUTE,
77 MFIB_ENTRY_FLAG_DROP);
79 const fib_route_path_t path = {
80 .frp_proto = DPO_PROTO_IP4,
81 .frp_addr = zero_addr,
82 .frp_sw_if_index = ~0,
85 .frp_flags = FIB_ROUTE_PATH_LOCAL,
86 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
90 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
92 mfib_table_entry_path_update(mfib_table->mft_index,
99 return (mfib_table->mft_index);
103 ip4_mfib_table_destroy (ip4_mfib_t *mfib)
105 mfib_table_t *mfib_table = (mfib_table_t*)mfib;
109 * remove all the specials we added when the table was created.
111 mfib_table_entry_delete(mfib_table->mft_index,
113 MFIB_SOURCE_DEFAULT_ROUTE);
115 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
117 mfib_table_entry_delete(mfib_table->mft_index,
119 MFIB_SOURCE_SPECIAL);
123 * validate no more routes.
125 ASSERT(0 == mfib_table->mft_total_route_counts);
126 ASSERT(~0 != mfib_table->mft_table_id);
128 hash_unset (ip4_main.mfib_index_by_table_id, mfib_table->mft_table_id);
129 pool_put(ip4_main.mfibs, mfib_table);
133 ip4_mfib_interface_enable_disable (u32 sw_if_index, int is_enable)
135 const fib_route_path_t path = {
136 .frp_proto = DPO_PROTO_IP4,
137 .frp_addr = zero_addr,
138 .frp_sw_if_index = sw_if_index,
141 .frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT,
146 mfib_index = ip4_mfib_table_get_index_for_sw_if_index(sw_if_index);
148 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
152 mfib_table_entry_path_update(mfib_index,
155 MFIB_ENTRY_FLAG_NONE,
160 mfib_table_entry_path_remove(mfib_index,
169 ip4_mfib_table_find_or_create_and_lock (u32 table_id,
174 index = ip4_mfib_index_from_table_id(table_id);
176 return ip4_create_mfib_with_table_id(table_id, src);
177 mfib_table_lock(index, FIB_PROTOCOL_IP4, src);
183 ip4_mfib_table_get_index_for_sw_if_index (u32 sw_if_index)
185 if (sw_if_index >= vec_len(ip4_main.mfib_index_by_sw_if_index))
188 * This is the case for interfaces that are not yet mapped to
193 return (ip4_main.mfib_index_by_sw_if_index[sw_if_index]);
196 #define IPV4_MFIB_GRP_LEN(_len)\
197 (_len > 32 ? 32 : _len)
199 #define IP4_MFIB_MK_KEY(_grp, _src, _len, _key) \
201 _key = ((u64)(_grp->data_u32 & \
202 ip4_main.fib_masks[IPV4_MFIB_GRP_LEN(_len)])) << 32; \
203 _key |= _src->data_u32; \
205 #define IP4_MFIB_MK_GRP_KEY(_grp, _len, _key) \
207 _key = ((u64)(_grp->data_u32 & \
208 ip4_main.fib_masks[IPV4_MFIB_GRP_LEN(_len)])) << 32; \
212 * ip4_fib_table_lookup_exact_match
214 * Exact match prefix lookup
217 ip4_mfib_table_lookup_exact_match (const ip4_mfib_t *mfib,
218 const ip4_address_t *grp,
219 const ip4_address_t *src,
222 uword * hash, * result;
225 hash = mfib->fib_entry_by_dst_address[len];
226 IP4_MFIB_MK_KEY(grp, src, len, key);
228 result = hash_get(hash, key);
230 if (NULL != result) {
233 return (FIB_NODE_INDEX_INVALID);
237 * ip4_fib_table_lookup
239 * Longest prefix match
242 ip4_mfib_table_lookup (const ip4_mfib_t *mfib,
243 const ip4_address_t *src,
244 const ip4_address_t *grp,
247 uword * hash, * result;
253 if (PREDICT_TRUE(64 == mask_len))
255 hash = mfib->fib_entry_by_dst_address[mask_len];
256 IP4_MFIB_MK_KEY(grp, src, mask_len, key);
258 result = hash_get (hash, key);
260 if (NULL != result) {
265 for (mask_len = (len == 64 ? 32 : len); mask_len >= 0; mask_len--)
267 hash = mfib->fib_entry_by_dst_address[mask_len];
268 IP4_MFIB_MK_GRP_KEY(grp, mask_len, key);
270 result = hash_get (hash, key);
272 if (NULL != result) {
276 return (FIB_NODE_INDEX_INVALID);
280 ip4_mfib_table_get_less_specific (const ip4_mfib_t *mfib,
281 const ip4_address_t *src,
282 const ip4_address_t *grp,
288 * in the absence of a tree structure for the table that allows for an O(1)
289 * parent get, a cheeky way to find the cover is to LPM for the prefix with
291 * there should always be a cover, though it may be the default route. the
292 * default route's cover is the default route.
296 /* go from (S,G) to (*,G*) */
308 return (ip4_mfib_table_lookup(mfib, src, grp, mask_len));
312 ip4_mfib_table_entry_insert (ip4_mfib_t *mfib,
313 const ip4_address_t *grp,
314 const ip4_address_t *src,
316 fib_node_index_t fib_entry_index)
318 uword * hash, * result;
321 IP4_MFIB_MK_KEY(grp, src, len, key);
322 hash = mfib->fib_entry_by_dst_address[len];
323 result = hash_get (hash, key);
325 if (NULL == result) {
330 hash = hash_create (32 /* elts */, sizeof (uword));
331 hash_set_flags (hash, HASH_FLAG_NO_AUTO_SHRINK);
333 hash = hash_set(hash, key, fib_entry_index);
334 mfib->fib_entry_by_dst_address[len] = hash;
343 ip4_mfib_table_entry_remove (ip4_mfib_t *mfib,
344 const ip4_address_t *grp,
345 const ip4_address_t *src,
348 uword * hash, * result;
351 IP4_MFIB_MK_KEY(grp, src, len, key);
352 hash = mfib->fib_entry_by_dst_address[len];
353 result = hash_get (hash, key);
358 * removing a non-existent entry. i'll allow it.
363 hash_unset(hash, key);
366 mfib->fib_entry_by_dst_address[len] = hash;
370 ip4_mfib_table_walk (ip4_mfib_t *mfib,
371 mfib_table_walk_fn_t fn,
376 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
378 uword * hash = mfib->fib_entry_by_dst_address[i];
384 hash_foreach_pair (p, hash,
386 fn(p->value[0], ctx);
393 format_ip4_mfib_table_memory (u8 * s, va_list * args)
395 mfib_table_t *mfib_table;
400 pool_foreach (mfib_table, ip4_main.mfibs)
402 ip4_mfib_t *mfib = &mfib_table->v4;
408 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
410 uword * hash = mfib->fib_entry_by_dst_address[i];
414 mfib_size += hash_bytes(hash);
418 total_memory += mfib_size;
421 s = format(s, "%=30s %=6d %=12ld\n",
423 pool_elts(ip4_main.mfibs), total_memory);
429 ip4_mfib_table_show_all (ip4_mfib_t *mfib,
432 fib_node_index_t *mfib_entry_indicies;
433 fib_node_index_t *mfib_entry_index;
436 mfib_entry_indicies = NULL;
438 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
440 uword * hash = mfib->fib_entry_by_dst_address[i];
446 hash_foreach_pair (p, hash,
448 vec_add1(mfib_entry_indicies, p->value[0]);
453 vec_sort_with_function(mfib_entry_indicies, mfib_entry_cmp_for_sort);
455 vec_foreach(mfib_entry_index, mfib_entry_indicies)
457 vlib_cli_output(vm, "%U",
460 MFIB_ENTRY_FORMAT_BRIEF);
463 vec_free(mfib_entry_indicies);
467 ip4_mfib_table_show_one (ip4_mfib_t *mfib,
473 vlib_cli_output(vm, "%U",
475 ip4_mfib_table_lookup(mfib, src, grp, mask_len),
476 MFIB_ENTRY_FORMAT_DETAIL);
479 static clib_error_t *
480 ip4_show_mfib (vlib_main_t * vm,
481 unformat_input_t * input,
482 vlib_cli_command_t * cmd)
484 ip4_main_t * im4 = &ip4_main;
485 mfib_table_t *mfib_table;
486 int verbose, matching, memory;
487 ip4_address_t grp, src = {{0}};
489 u64 total_hash_memory;
490 int i, table_id = -1, fib_index = ~0;
493 memory = matching = 0;
494 total_hash_memory = 0;
496 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
498 if (unformat (input, "brief") || unformat (input, "summary")
499 || unformat (input, "sum"))
501 else if (unformat (input, "mem") || unformat (input, "memory"))
503 else if (unformat (input, "%U %U",
504 unformat_ip4_address, &src,
505 unformat_ip4_address, &grp))
510 else if (unformat (input, "%U/%d", unformat_ip4_address, &grp, &mask))
512 clib_memset(&src, 0, sizeof(src));
515 else if (unformat (input, "%U", unformat_ip4_address, &grp))
517 clib_memset(&src, 0, sizeof(src));
521 else if (unformat (input, "table %d", &table_id))
523 else if (unformat (input, "index %d", &fib_index))
529 pool_foreach (mfib_table, im4->mfibs)
531 ip4_mfib_t *mfib = &mfib_table->v4;
533 if (table_id >= 0 && table_id != (int)mfib->table_id)
535 if (fib_index != ~0 && fib_index != (int)mfib->index)
544 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
546 uword * hash = mfib->fib_entry_by_dst_address[i];
549 hash_size += hash_bytes(hash);
553 vlib_cli_output (vm, "%U hash:%d",
554 format_mfib_table_name, mfib->index,
557 total_hash_memory += hash_size;
561 vlib_cli_output (vm, "%U, fib_index:%d flags:%U",
562 format_mfib_table_name, mfib->index, FIB_PROTOCOL_IP4,
564 format_mfib_table_flags, mfib_table->mft_flags);
569 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
570 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
572 uword * hash = mfib->fib_entry_by_dst_address[i];
573 uword n_elts = hash_elts (hash);
575 vlib_cli_output (vm, "%20d%16d", i, n_elts);
582 ip4_mfib_table_show_all(mfib, vm);
586 ip4_mfib_table_show_one(mfib, vm, &src, &grp, mask);
590 vlib_cli_output (vm, "totals: hash:%ld", total_hash_memory);
595 /* clang-format off */
597 * This command displays the IPv4 MulticasrFIB Tables (VRF Tables) and
598 * the route entries for each table.
600 * @note This command will run for a long time when the FIB tables are
601 * comprised of millions of entries. For those scenarios, consider displaying
602 * a single table or summary mode.
605 * Example of how to display all the IPv4 Multicast FIB tables:
606 * @cliexstart{show ip fib}
607 * ipv4-VRF:0, fib_index 0
608 * (*, 0.0.0.0/0): flags:D,
610 * multicast-ip4-chain
614 * test-eth1: Forward,
615 * test-eth2: Forward,
617 * multicast-ip4-chain
618 * [@2]: dpo-replicate: [index:1 buckets:2 to:[0:0]]
619 * [0] [@1]: ipv4-mcast: test-eth1: IP4: d0:d1:d2:d3:d4:01 -> 01:00:05:00:00:00
620 * [1] [@1]: ipv4-mcast: test-eth2: IP4: d0:d1:d2:d3:d4:02 -> 01:00:05:00:00:00
623 * Example of how to display a summary of all IPv4 FIB tables:
624 * @cliexstart{show ip fib summary}
625 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
626 * Prefix length Count
630 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
631 * Prefix length Count
638 /* clang-format on */
639 VLIB_CLI_COMMAND (ip4_show_mfib_command, static) = {
640 .path = "show ip mfib",
641 .short_help = "show ip mfib [summary] [table <table-id>] [index <fib-id>] [<grp-addr>[/<mask>]] [<grp-addr>] [<src-addr> <grp-addr>]",
642 .function = ip4_show_mfib,