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,
45 static const fib_route_path_t ip4_special_path =
47 .frp_proto = DPO_PROTO_IP4,
51 .frp_sw_if_index = ~0,
54 .frp_flags = FIB_ROUTE_PATH_LOCAL,
55 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
59 ip4_create_mfib_with_table_id (u32 table_id,
62 mfib_table_t *mfib_table;
64 pool_get_aligned(ip4_main.mfibs, mfib_table, CLIB_CACHE_LINE_BYTES);
65 clib_memset(mfib_table, 0, sizeof(*mfib_table));
67 mfib_table->mft_proto = FIB_PROTOCOL_IP4;
68 mfib_table->mft_index =
69 mfib_table->v4.index =
70 (mfib_table - ip4_main.mfibs);
72 hash_set (ip4_main.mfib_index_by_table_id,
74 mfib_table->mft_index);
76 mfib_table->mft_table_id =
77 mfib_table->v4.table_id =
80 mfib_table_lock(mfib_table->mft_index, FIB_PROTOCOL_IP4, src);
83 * add the default route into the new FIB
85 mfib_table_entry_update(mfib_table->mft_index,
87 MFIB_SOURCE_DEFAULT_ROUTE,
89 MFIB_ENTRY_FLAG_DROP);
93 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
95 mfib_table_entry_path_update(mfib_table->mft_index,
102 return (mfib_table->mft_index);
106 ip4_mfib_table_destroy (ip4_mfib_t *mfib)
108 mfib_table_t *mfib_table = (mfib_table_t*)mfib;
112 * remove all the specials we added when the table was created.
114 mfib_table_entry_delete(mfib_table->mft_index,
116 MFIB_SOURCE_DEFAULT_ROUTE);
118 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
120 mfib_table_entry_path_remove(mfib_table->mft_index,
127 * validate no more routes.
129 ASSERT(0 == mfib_table->mft_total_route_counts);
130 ASSERT(~0 != mfib_table->mft_table_id);
132 for (u32 i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
133 hash_free (mfib->fib_entry_by_dst_address[i]);
134 hash_unset (ip4_main.mfib_index_by_table_id, mfib_table->mft_table_id);
135 pool_put(ip4_main.mfibs, mfib_table);
139 ip4_mfib_interface_enable_disable (u32 sw_if_index, int is_enable)
141 const fib_route_path_t path = {
142 .frp_proto = DPO_PROTO_IP4,
143 .frp_addr = zero_addr,
144 .frp_sw_if_index = sw_if_index,
147 .frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT,
152 mfib_index = ip4_mfib_table_get_index_for_sw_if_index(sw_if_index);
154 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
158 mfib_table_entry_path_update(mfib_index,
161 MFIB_ENTRY_FLAG_NONE,
166 mfib_table_entry_path_remove(mfib_index,
175 ip4_mfib_table_find_or_create_and_lock (u32 table_id,
180 index = ip4_mfib_index_from_table_id(table_id);
182 return ip4_create_mfib_with_table_id(table_id, src);
183 mfib_table_lock(index, FIB_PROTOCOL_IP4, src);
189 ip4_mfib_table_get_index_for_sw_if_index (u32 sw_if_index)
191 if (sw_if_index >= vec_len(ip4_main.mfib_index_by_sw_if_index))
194 * This is the case for interfaces that are not yet mapped to
199 return (ip4_main.mfib_index_by_sw_if_index[sw_if_index]);
202 #define IPV4_MFIB_GRP_LEN(_len)\
203 (_len > 32 ? 32 : _len)
205 #define IP4_MFIB_MK_KEY(_grp, _src, _len, _key) \
207 _key = ((u64)(_grp->data_u32 & \
208 ip4_main.fib_masks[IPV4_MFIB_GRP_LEN(_len)])) << 32; \
209 _key |= _src->data_u32; \
211 #define IP4_MFIB_MK_GRP_KEY(_grp, _len, _key) \
213 _key = ((u64)(_grp->data_u32 & \
214 ip4_main.fib_masks[IPV4_MFIB_GRP_LEN(_len)])) << 32; \
218 * ip4_fib_table_lookup_exact_match
220 * Exact match prefix lookup
223 ip4_mfib_table_lookup_exact_match (const ip4_mfib_t *mfib,
224 const ip4_address_t *grp,
225 const ip4_address_t *src,
228 uword * hash, * result;
231 hash = mfib->fib_entry_by_dst_address[len];
232 IP4_MFIB_MK_KEY(grp, src, len, key);
234 result = hash_get(hash, key);
236 if (NULL != result) {
239 return (FIB_NODE_INDEX_INVALID);
243 * ip4_fib_table_lookup
245 * Longest prefix match
248 ip4_mfib_table_lookup (const ip4_mfib_t *mfib,
249 const ip4_address_t *src,
250 const ip4_address_t *grp,
253 uword * hash, * result;
259 if (PREDICT_TRUE(64 == mask_len))
261 hash = mfib->fib_entry_by_dst_address[mask_len];
262 IP4_MFIB_MK_KEY(grp, src, mask_len, key);
264 result = hash_get (hash, key);
266 if (NULL != result) {
271 for (mask_len = (len == 64 ? 32 : len); mask_len >= 0; mask_len--)
273 hash = mfib->fib_entry_by_dst_address[mask_len];
274 IP4_MFIB_MK_GRP_KEY(grp, mask_len, key);
276 result = hash_get (hash, key);
278 if (NULL != result) {
282 return (FIB_NODE_INDEX_INVALID);
286 ip4_mfib_table_get_less_specific (const ip4_mfib_t *mfib,
287 const ip4_address_t *src,
288 const ip4_address_t *grp,
294 * in the absence of a tree structure for the table that allows for an O(1)
295 * parent get, a cheeky way to find the cover is to LPM for the prefix with
297 * there should always be a cover, though it may be the default route. the
298 * default route's cover is the default route.
302 /* go from (S,G) to (*,G*) */
314 return (ip4_mfib_table_lookup(mfib, src, grp, mask_len));
318 ip4_mfib_table_entry_insert (ip4_mfib_t *mfib,
319 const ip4_address_t *grp,
320 const ip4_address_t *src,
322 fib_node_index_t fib_entry_index)
324 uword * hash, * result;
327 IP4_MFIB_MK_KEY(grp, src, len, key);
328 hash = mfib->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 mfib->fib_entry_by_dst_address[len] = hash;
349 ip4_mfib_table_entry_remove (ip4_mfib_t *mfib,
350 const ip4_address_t *grp,
351 const ip4_address_t *src,
354 uword * hash, * result;
357 IP4_MFIB_MK_KEY(grp, src, len, key);
358 hash = mfib->fib_entry_by_dst_address[len];
359 result = hash_get (hash, key);
364 * removing a non-existent entry. i'll allow it.
369 hash_unset(hash, key);
372 mfib->fib_entry_by_dst_address[len] = hash;
376 ip4_mfib_table_walk (ip4_mfib_t *mfib,
377 mfib_table_walk_fn_t fn,
382 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
384 uword * hash = mfib->fib_entry_by_dst_address[i];
390 hash_foreach_pair (p, hash,
392 fn(p->value[0], ctx);
399 format_ip4_mfib_table_memory (u8 * s, va_list * args)
401 mfib_table_t *mfib_table;
406 pool_foreach (mfib_table, ip4_main.mfibs)
408 ip4_mfib_t *mfib = &mfib_table->v4;
414 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
416 uword * hash = mfib->fib_entry_by_dst_address[i];
420 mfib_size += hash_bytes(hash);
424 total_memory += mfib_size;
427 s = format(s, "%=30s %=6d %=12ld\n",
429 pool_elts(ip4_main.mfibs), total_memory);
435 ip4_mfib_table_show_all (ip4_mfib_t *mfib,
438 fib_node_index_t *mfib_entry_indicies;
439 fib_node_index_t *mfib_entry_index;
442 mfib_entry_indicies = NULL;
444 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
446 uword * hash = mfib->fib_entry_by_dst_address[i];
452 hash_foreach_pair (p, hash,
454 vec_add1(mfib_entry_indicies, p->value[0]);
459 vec_sort_with_function(mfib_entry_indicies, mfib_entry_cmp_for_sort);
461 vec_foreach(mfib_entry_index, mfib_entry_indicies)
463 vlib_cli_output(vm, "%U",
466 MFIB_ENTRY_FORMAT_BRIEF);
469 vec_free(mfib_entry_indicies);
473 ip4_mfib_table_show_one (ip4_mfib_t *mfib,
479 vlib_cli_output(vm, "%U",
481 ip4_mfib_table_lookup(mfib, src, grp, mask_len),
482 MFIB_ENTRY_FORMAT_DETAIL);
485 static clib_error_t *
486 ip4_show_mfib (vlib_main_t * vm,
487 unformat_input_t * input,
488 vlib_cli_command_t * cmd)
490 ip4_main_t * im4 = &ip4_main;
491 mfib_table_t *mfib_table;
492 int verbose, matching, memory;
493 ip4_address_t grp, src = {{0}};
495 u64 total_hash_memory;
496 int i, table_id = -1, fib_index = ~0;
499 memory = matching = 0;
500 total_hash_memory = 0;
502 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
504 if (unformat (input, "brief") || unformat (input, "summary")
505 || unformat (input, "sum"))
507 else if (unformat (input, "mem") || unformat (input, "memory"))
509 else if (unformat (input, "%U %U",
510 unformat_ip4_address, &src,
511 unformat_ip4_address, &grp))
516 else if (unformat (input, "%U/%d", unformat_ip4_address, &grp, &mask))
518 clib_memset(&src, 0, sizeof(src));
521 else if (unformat (input, "%U", unformat_ip4_address, &grp))
523 clib_memset(&src, 0, sizeof(src));
527 else if (unformat (input, "table %d", &table_id))
529 else if (unformat (input, "index %d", &fib_index))
535 pool_foreach (mfib_table, im4->mfibs)
537 ip4_mfib_t *mfib = &mfib_table->v4;
539 if (table_id >= 0 && table_id != (int)mfib->table_id)
541 if (fib_index != ~0 && fib_index != (int)mfib->index)
550 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
552 uword * hash = mfib->fib_entry_by_dst_address[i];
555 hash_size += hash_bytes(hash);
559 vlib_cli_output (vm, "%U hash:%d",
560 format_mfib_table_name, mfib->index,
563 total_hash_memory += hash_size;
567 vlib_cli_output (vm, "%U, fib_index:%d flags:%U",
568 format_mfib_table_name, mfib->index, FIB_PROTOCOL_IP4,
570 format_mfib_table_flags, mfib_table->mft_flags);
575 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
576 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
578 uword * hash = mfib->fib_entry_by_dst_address[i];
579 uword n_elts = hash_elts (hash);
581 vlib_cli_output (vm, "%20d%16d", i, n_elts);
588 ip4_mfib_table_show_all(mfib, vm);
592 ip4_mfib_table_show_one(mfib, vm, &src, &grp, mask);
596 vlib_cli_output (vm, "totals: hash:%ld", total_hash_memory);
601 /* clang-format off */
603 * This command displays the IPv4 MulticasrFIB Tables (VRF Tables) and
604 * the route entries for each table.
606 * @note This command will run for a long time when the FIB tables are
607 * comprised of millions of entries. For those scenarios, consider displaying
608 * a single table or summary mode.
611 * Example of how to display all the IPv4 Multicast FIB tables:
612 * @cliexstart{show ip fib}
613 * ipv4-VRF:0, fib_index 0
614 * (*, 0.0.0.0/0): flags:D,
616 * multicast-ip4-chain
620 * test-eth1: Forward,
621 * test-eth2: Forward,
623 * multicast-ip4-chain
624 * [@2]: dpo-replicate: [index:1 buckets:2 to:[0:0]]
625 * [0] [@1]: ipv4-mcast: test-eth1: IP4: d0:d1:d2:d3:d4:01 -> 01:00:05:00:00:00
626 * [1] [@1]: ipv4-mcast: test-eth2: IP4: d0:d1:d2:d3:d4:02 -> 01:00:05:00:00:00
629 * Example of how to display a summary of all IPv4 FIB tables:
630 * @cliexstart{show ip fib summary}
631 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
632 * Prefix length Count
636 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
637 * Prefix length Count
644 /* clang-format on */
645 VLIB_CLI_COMMAND (ip4_show_mfib_command, static) = {
646 .path = "show ip mfib",
647 .short_help = "show ip mfib [summary] [table <table-id>] [index <fib-id>] [<grp-addr>[/<mask>]] [<grp-addr>] [<src-addr> <grp-addr>]",
648 .function = ip4_show_mfib,