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 ip4_specials[] = {
31 .fp_proto = FIB_PROTOCOL_IP4,
36 ip4_create_mfib_with_table_id (u32 table_id,
39 mfib_table_t *mfib_table;
41 pool_get_aligned(ip4_main.mfibs, mfib_table, CLIB_CACHE_LINE_BYTES);
42 clib_memset(mfib_table, 0, sizeof(*mfib_table));
44 mfib_table->mft_proto = FIB_PROTOCOL_IP4;
45 mfib_table->mft_index =
46 mfib_table->v4.index =
47 (mfib_table - ip4_main.mfibs);
49 hash_set (ip4_main.mfib_index_by_table_id,
51 mfib_table->mft_index);
53 mfib_table->mft_table_id =
54 mfib_table->v4.table_id =
57 mfib_table_lock(mfib_table->mft_index, FIB_PROTOCOL_IP4, src);
60 * add the special entries into the new FIB
64 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
66 mfib_prefix_t prefix = ip4_specials[ii];
68 prefix.fp_src_addr.ip4.data_u32 =
69 clib_host_to_net_u32(prefix.fp_src_addr.ip4.data_u32);
70 prefix.fp_grp_addr.ip4.data_u32 =
71 clib_host_to_net_u32(prefix.fp_grp_addr.ip4.data_u32);
73 mfib_table_entry_update(mfib_table->mft_index,
75 MFIB_SOURCE_DEFAULT_ROUTE,
77 MFIB_ENTRY_FLAG_DROP);
80 return (mfib_table->mft_index);
84 ip4_mfib_table_destroy (ip4_mfib_t *mfib)
86 mfib_table_t *mfib_table = (mfib_table_t*)mfib;
90 * remove all the specials we added when the table was created.
92 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
94 fib_node_index_t mfei;
95 mfib_prefix_t prefix = ip4_specials[ii];
97 prefix.fp_src_addr.ip4.data_u32 =
98 clib_host_to_net_u32(prefix.fp_src_addr.ip4.data_u32);
99 prefix.fp_grp_addr.ip4.data_u32 =
100 clib_host_to_net_u32(prefix.fp_grp_addr.ip4.data_u32);
102 mfei = mfib_table_lookup(mfib_table->mft_index, &prefix);
103 mfib_table_entry_delete_index(mfei, MFIB_SOURCE_DEFAULT_ROUTE);
107 * validate no more routes.
109 ASSERT(0 == mfib_table->mft_total_route_counts);
110 ASSERT(~0 != mfib_table->mft_table_id);
112 hash_unset (ip4_main.mfib_index_by_table_id, mfib_table->mft_table_id);
113 pool_put(ip4_main.mfibs, mfib_table);
117 ip4_mfib_table_find_or_create_and_lock (u32 table_id,
122 index = ip4_mfib_index_from_table_id(table_id);
124 return ip4_create_mfib_with_table_id(table_id, src);
125 mfib_table_lock(index, FIB_PROTOCOL_IP4, src);
131 ip4_mfib_table_get_index_for_sw_if_index (u32 sw_if_index)
133 if (sw_if_index >= vec_len(ip4_main.mfib_index_by_sw_if_index))
136 * This is the case for interfaces that are not yet mapped to
141 return (ip4_main.mfib_index_by_sw_if_index[sw_if_index]);
144 #define IPV4_MFIB_GRP_LEN(_len)\
145 (_len > 32 ? 32 : _len)
147 #define IP4_MFIB_MK_KEY(_grp, _src, _len, _key) \
149 _key = ((u64)(_grp->data_u32 & \
150 ip4_main.fib_masks[IPV4_MFIB_GRP_LEN(_len)])) << 32; \
151 _key |= _src->data_u32; \
153 #define IP4_MFIB_MK_GRP_KEY(_grp, _len, _key) \
155 _key = ((u64)(_grp->data_u32 & \
156 ip4_main.fib_masks[IPV4_MFIB_GRP_LEN(_len)])) << 32; \
160 * ip4_fib_table_lookup_exact_match
162 * Exact match prefix lookup
165 ip4_mfib_table_lookup_exact_match (const ip4_mfib_t *mfib,
166 const ip4_address_t *grp,
167 const ip4_address_t *src,
170 uword * hash, * result;
173 hash = mfib->fib_entry_by_dst_address[len];
174 IP4_MFIB_MK_KEY(grp, src, len, key);
176 result = hash_get(hash, key);
178 if (NULL != result) {
181 return (FIB_NODE_INDEX_INVALID);
185 * ip4_fib_table_lookup
187 * Longest prefix match
190 ip4_mfib_table_lookup (const ip4_mfib_t *mfib,
191 const ip4_address_t *src,
192 const ip4_address_t *grp,
195 uword * hash, * result;
201 if (PREDICT_TRUE(64 == mask_len))
203 hash = mfib->fib_entry_by_dst_address[mask_len];
204 IP4_MFIB_MK_KEY(grp, src, mask_len, key);
206 result = hash_get (hash, key);
208 if (NULL != result) {
213 for (mask_len = (len == 64 ? 32 : len); mask_len >= 0; mask_len--)
215 hash = mfib->fib_entry_by_dst_address[mask_len];
216 IP4_MFIB_MK_GRP_KEY(grp, mask_len, key);
218 result = hash_get (hash, key);
220 if (NULL != result) {
224 return (FIB_NODE_INDEX_INVALID);
228 ip4_mfib_table_get_less_specific (const ip4_mfib_t *mfib,
229 const ip4_address_t *src,
230 const ip4_address_t *grp,
236 * in the absence of a tree structure for the table that allows for an O(1)
237 * parent get, a cheeky way to find the cover is to LPM for the prefix with
239 * there should always be a cover, though it may be the default route. the
240 * default route's cover is the default route.
244 /* go from (S,G) to (*,G*) */
256 return (ip4_mfib_table_lookup(mfib, src, grp, mask_len));
260 ip4_mfib_table_entry_insert (ip4_mfib_t *mfib,
261 const ip4_address_t *grp,
262 const ip4_address_t *src,
264 fib_node_index_t fib_entry_index)
266 uword * hash, * result;
269 IP4_MFIB_MK_KEY(grp, src, len, key);
270 hash = mfib->fib_entry_by_dst_address[len];
271 result = hash_get (hash, key);
273 if (NULL == result) {
278 hash = hash_create (32 /* elts */, sizeof (uword));
279 hash_set_flags (hash, HASH_FLAG_NO_AUTO_SHRINK);
281 hash = hash_set(hash, key, fib_entry_index);
282 mfib->fib_entry_by_dst_address[len] = hash;
291 ip4_mfib_table_entry_remove (ip4_mfib_t *mfib,
292 const ip4_address_t *grp,
293 const ip4_address_t *src,
296 uword * hash, * result;
299 IP4_MFIB_MK_KEY(grp, src, len, key);
300 hash = mfib->fib_entry_by_dst_address[len];
301 result = hash_get (hash, key);
306 * removing a non-existent entry. i'll allow it.
311 hash_unset(hash, key);
314 mfib->fib_entry_by_dst_address[len] = hash;
318 ip4_mfib_table_walk (ip4_mfib_t *mfib,
319 mfib_table_walk_fn_t fn,
324 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
326 uword * hash = mfib->fib_entry_by_dst_address[i];
332 hash_foreach_pair (p, hash,
334 fn(p->value[0], ctx);
341 format_ip4_mfib_table_memory (u8 * s, va_list * args)
343 mfib_table_t *mfib_table;
348 pool_foreach (mfib_table, ip4_main.mfibs,
350 ip4_mfib_t *mfib = &mfib_table->v4;
356 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
358 uword * hash = mfib->fib_entry_by_dst_address[i];
362 mfib_size += hash_bytes(hash);
366 total_memory += mfib_size;
369 s = format(s, "%=30s %=6d %=12ld\n",
371 pool_elts(ip4_main.mfibs), total_memory);
377 ip4_mfib_table_show_all (ip4_mfib_t *mfib,
380 fib_node_index_t *mfib_entry_indicies;
381 fib_node_index_t *mfib_entry_index;
384 mfib_entry_indicies = NULL;
386 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
388 uword * hash = mfib->fib_entry_by_dst_address[i];
394 hash_foreach_pair (p, hash,
396 vec_add1(mfib_entry_indicies, p->value[0]);
401 vec_sort_with_function(mfib_entry_indicies, mfib_entry_cmp_for_sort);
403 vec_foreach(mfib_entry_index, mfib_entry_indicies)
405 vlib_cli_output(vm, "%U",
408 MFIB_ENTRY_FORMAT_BRIEF);
411 vec_free(mfib_entry_indicies);
415 ip4_mfib_table_show_one (ip4_mfib_t *mfib,
421 vlib_cli_output(vm, "%U",
423 ip4_mfib_table_lookup(mfib, src, grp, mask_len),
424 MFIB_ENTRY_FORMAT_DETAIL);
427 static clib_error_t *
428 ip4_show_mfib (vlib_main_t * vm,
429 unformat_input_t * input,
430 vlib_cli_command_t * cmd)
432 ip4_main_t * im4 = &ip4_main;
433 mfib_table_t *mfib_table;
434 int verbose, matching, memory;
435 ip4_address_t grp, src = {{0}};
437 u64 total_hash_memory;
438 int i, table_id = -1, fib_index = ~0;
441 memory = matching = 0;
442 total_hash_memory = 0;
444 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
446 if (unformat (input, "brief") || unformat (input, "summary")
447 || unformat (input, "sum"))
449 else if (unformat (input, "mem") || unformat (input, "memory"))
451 else if (unformat (input, "%U %U",
452 unformat_ip4_address, &src,
453 unformat_ip4_address, &grp))
458 else if (unformat (input, "%U/%d", unformat_ip4_address, &grp, &mask))
460 clib_memset(&src, 0, sizeof(src));
463 else if (unformat (input, "%U", unformat_ip4_address, &grp))
465 clib_memset(&src, 0, sizeof(src));
469 else if (unformat (input, "table %d", &table_id))
471 else if (unformat (input, "index %d", &fib_index))
477 pool_foreach (mfib_table, im4->mfibs,
479 ip4_mfib_t *mfib = &mfib_table->v4;
481 if (table_id >= 0 && table_id != (int)mfib->table_id)
483 if (fib_index != ~0 && fib_index != (int)mfib->index)
492 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
494 uword * hash = mfib->fib_entry_by_dst_address[i];
497 hash_size += hash_bytes(hash);
501 vlib_cli_output (vm, "%U hash:%d",
502 format_mfib_table_name, mfib->index,
505 total_hash_memory += hash_size;
509 vlib_cli_output (vm, "%U, fib_index:%d flags:%U",
510 format_mfib_table_name, mfib->index, FIB_PROTOCOL_IP4,
512 format_mfib_table_flags, mfib_table->mft_flags);
517 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
518 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
520 uword * hash = mfib->fib_entry_by_dst_address[i];
521 uword n_elts = hash_elts (hash);
523 vlib_cli_output (vm, "%20d%16d", i, n_elts);
530 ip4_mfib_table_show_all(mfib, vm);
534 ip4_mfib_table_show_one(mfib, vm, &src, &grp, mask);
538 vlib_cli_output (vm, "totals: hash:%ld", total_hash_memory);
544 * This command displays the IPv4 MulticasrFIB Tables (VRF Tables) and
545 * the route 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 Multicast FIB tables:
553 * @cliexstart{show ip fib}
554 * ipv4-VRF:0, fib_index 0
555 * (*, 0.0.0.0/0): flags:D,
557 * multicast-ip4-chain
561 * test-eth1: Forward,
562 * test-eth2: Forward,
564 * multicast-ip4-chain
565 * [@2]: dpo-replicate: [index:1 buckets:2 to:[0:0]]
566 * [0] [@1]: ipv4-mcast: test-eth1: IP4: d0:d1:d2:d3:d4:01 -> 01:00:05:00:00:00
567 * [1] [@1]: ipv4-mcast: test-eth2: IP4: d0:d1:d2:d3:d4:02 -> 01:00:05:00:00:00
570 * Example of how to display a summary of all IPv4 FIB tables:
571 * @cliexstart{show ip fib summary}
572 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
573 * Prefix length Count
577 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
578 * Prefix length Count
586 VLIB_CLI_COMMAND (ip4_show_mfib_command, static) = {
587 .path = "show ip mfib",
588 .short_help = "show ip mfib [summary] [table <table-id>] [index <fib-id>] [<grp-addr>[/<mask>]] [<grp-addr>] [<src-addr> <grp-addr>]",
589 .function = ip4_show_mfib,