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)
38 mfib_table_t *mfib_table;
40 pool_get_aligned(ip4_main.mfibs, mfib_table, CLIB_CACHE_LINE_BYTES);
41 memset(mfib_table, 0, sizeof(*mfib_table));
43 mfib_table->mft_proto = FIB_PROTOCOL_IP4;
44 mfib_table->mft_index =
45 mfib_table->v4.index =
46 (mfib_table - ip4_main.mfibs);
48 hash_set (ip4_main.mfib_index_by_table_id,
50 mfib_table->mft_index);
52 mfib_table->mft_table_id =
53 mfib_table->v4.table_id =
56 mfib_table_lock(mfib_table->mft_index, FIB_PROTOCOL_IP4);
59 * add the special entries into the new FIB
63 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
65 mfib_prefix_t prefix = ip4_specials[ii];
67 prefix.fp_src_addr.ip4.data_u32 =
68 clib_host_to_net_u32(prefix.fp_src_addr.ip4.data_u32);
69 prefix.fp_grp_addr.ip4.data_u32 =
70 clib_host_to_net_u32(prefix.fp_grp_addr.ip4.data_u32);
72 mfib_table_entry_update(mfib_table->mft_index,
74 MFIB_SOURCE_DEFAULT_ROUTE,
76 MFIB_ENTRY_FLAG_DROP);
79 return (mfib_table->mft_index);
83 ip4_mfib_table_destroy (ip4_mfib_t *mfib)
85 mfib_table_t *mfib_table = (mfib_table_t*)mfib;
89 * remove all the specials we added when the table was created.
91 for (ii = 0; ii < ARRAY_LEN(ip4_specials); ii++)
93 fib_node_index_t mfei;
94 mfib_prefix_t prefix = ip4_specials[ii];
96 prefix.fp_src_addr.ip4.data_u32 =
97 clib_host_to_net_u32(prefix.fp_src_addr.ip4.data_u32);
98 prefix.fp_grp_addr.ip4.data_u32 =
99 clib_host_to_net_u32(prefix.fp_grp_addr.ip4.data_u32);
101 mfei = mfib_table_lookup(mfib_table->mft_index, &prefix);
102 mfib_table_entry_delete_index(mfei, MFIB_SOURCE_DEFAULT_ROUTE);
106 * validate no more routes.
108 ASSERT(0 == mfib_table->mft_total_route_counts);
109 ASSERT(~0 != mfib_table->mft_table_id);
111 hash_unset (ip4_main.mfib_index_by_table_id, mfib_table->mft_table_id);
112 pool_put(ip4_main.mfibs, mfib_table);
116 ip4_mfib_table_find_or_create_and_lock (u32 table_id)
120 index = ip4_mfib_index_from_table_id(table_id);
122 return ip4_create_mfib_with_table_id(table_id);
123 mfib_table_lock(index, FIB_PROTOCOL_IP4);
129 ip4_mfib_table_get_index_for_sw_if_index (u32 sw_if_index)
131 if (sw_if_index >= vec_len(ip4_main.mfib_index_by_sw_if_index))
134 * This is the case for interfaces that are not yet mapped to
139 return (ip4_main.mfib_index_by_sw_if_index[sw_if_index]);
142 #define IPV4_MFIB_GRP_LEN(_len)\
143 (_len > 32 ? 32 : _len)
145 #define IP4_MFIB_MK_KEY(_grp, _src, _len, _key) \
147 _key = ((u64)(_grp->data_u32 & \
148 ip4_main.fib_masks[IPV4_MFIB_GRP_LEN(_len)])) << 32; \
149 _key |= _src->data_u32; \
151 #define IP4_MFIB_MK_GRP_KEY(_grp, _len, _key) \
153 _key = ((u64)(_grp->data_u32 & \
154 ip4_main.fib_masks[IPV4_MFIB_GRP_LEN(_len)])) << 32; \
158 * ip4_fib_table_lookup_exact_match
160 * Exact match prefix lookup
163 ip4_mfib_table_lookup_exact_match (const ip4_mfib_t *mfib,
164 const ip4_address_t *grp,
165 const ip4_address_t *src,
168 uword * hash, * result;
171 hash = mfib->fib_entry_by_dst_address[len];
172 IP4_MFIB_MK_KEY(grp, src, len, key);
174 result = hash_get(hash, key);
176 if (NULL != result) {
179 return (FIB_NODE_INDEX_INVALID);
183 * ip4_fib_table_lookup
185 * Longest prefix match
188 ip4_mfib_table_lookup (const ip4_mfib_t *mfib,
189 const ip4_address_t *src,
190 const ip4_address_t *grp,
193 uword * hash, * result;
199 if (PREDICT_TRUE(64 == mask_len))
201 hash = mfib->fib_entry_by_dst_address[mask_len];
202 IP4_MFIB_MK_KEY(grp, src, mask_len, key);
204 result = hash_get (hash, key);
206 if (NULL != result) {
211 for (mask_len = 32; mask_len >= 0; mask_len--)
213 hash = mfib->fib_entry_by_dst_address[mask_len];
214 IP4_MFIB_MK_GRP_KEY(grp, mask_len, key);
216 result = hash_get (hash, key);
218 if (NULL != result) {
222 return (FIB_NODE_INDEX_INVALID);
226 ip4_mfib_table_entry_insert (ip4_mfib_t *mfib,
227 const ip4_address_t *grp,
228 const ip4_address_t *src,
230 fib_node_index_t fib_entry_index)
232 uword * hash, * result;
235 IP4_MFIB_MK_KEY(grp, src, len, key);
236 hash = mfib->fib_entry_by_dst_address[len];
237 result = hash_get (hash, key);
239 if (NULL == result) {
244 hash = hash_create (32 /* elts */, sizeof (uword));
245 hash_set_flags (hash, HASH_FLAG_NO_AUTO_SHRINK);
247 hash = hash_set(hash, key, fib_entry_index);
248 mfib->fib_entry_by_dst_address[len] = hash;
257 ip4_mfib_table_entry_remove (ip4_mfib_t *mfib,
258 const ip4_address_t *grp,
259 const ip4_address_t *src,
262 uword * hash, * result;
265 IP4_MFIB_MK_KEY(grp, src, len, key);
266 hash = mfib->fib_entry_by_dst_address[len];
267 result = hash_get (hash, key);
272 * removing a non-existant entry. i'll allow it.
277 hash_unset(hash, key);
280 mfib->fib_entry_by_dst_address[len] = hash;
284 ip4_mfib_table_walk (ip4_mfib_t *mfib,
285 mfib_table_walk_fn_t fn,
290 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
292 uword * hash = mfib->fib_entry_by_dst_address[i];
298 hash_foreach_pair (p, hash,
300 fn(p->value[0], ctx);
307 ip4_mfib_table_show_all (ip4_mfib_t *mfib,
310 fib_node_index_t *mfib_entry_indicies;
311 fib_node_index_t *mfib_entry_index;
314 mfib_entry_indicies = NULL;
316 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
318 uword * hash = mfib->fib_entry_by_dst_address[i];
324 hash_foreach_pair (p, hash,
326 vec_add1(mfib_entry_indicies, p->value[0]);
331 vec_sort_with_function(mfib_entry_indicies, mfib_entry_cmp_for_sort);
333 vec_foreach(mfib_entry_index, mfib_entry_indicies)
335 vlib_cli_output(vm, "%U",
338 MFIB_ENTRY_FORMAT_BRIEF);
341 vec_free(mfib_entry_indicies);
345 ip4_mfib_table_show_one (ip4_mfib_t *mfib,
351 vlib_cli_output(vm, "%U",
353 ip4_mfib_table_lookup(mfib, src, grp, mask_len),
354 MFIB_ENTRY_FORMAT_DETAIL);
357 static clib_error_t *
358 ip4_show_mfib (vlib_main_t * vm,
359 unformat_input_t * input,
360 vlib_cli_command_t * cmd)
362 ip4_main_t * im4 = &ip4_main;
363 mfib_table_t *mfib_table;
364 int verbose, matching;
365 ip4_address_t grp, src = {{0}};
367 int i, table_id = -1, fib_index = ~0;
372 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
374 if (unformat (input, "brief") || unformat (input, "summary")
375 || unformat (input, "sum"))
378 else if (unformat (input, "%U %U",
379 unformat_ip4_address, &src,
380 unformat_ip4_address, &grp))
385 else if (unformat (input, "%U/%d", unformat_ip4_address, &grp, &mask))
387 memset(&src, 0, sizeof(src));
390 else if (unformat (input, "%U", unformat_ip4_address, &grp))
392 memset(&src, 0, sizeof(src));
396 else if (unformat (input, "table %d", &table_id))
398 else if (unformat (input, "index %d", &fib_index))
404 pool_foreach (mfib_table, im4->mfibs,
406 ip4_mfib_t *mfib = &mfib_table->v4;
408 if (table_id >= 0 && table_id != (int)mfib->table_id)
410 if (fib_index != ~0 && fib_index != (int)mfib->index)
413 vlib_cli_output (vm, "%U, fib_index %d",
414 format_mfib_table_name, mfib->index, FIB_PROTOCOL_IP4,
420 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
421 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
423 uword * hash = mfib->fib_entry_by_dst_address[i];
424 uword n_elts = hash_elts (hash);
426 vlib_cli_output (vm, "%20d%16d", i, n_elts);
433 ip4_mfib_table_show_all(mfib, vm);
437 ip4_mfib_table_show_one(mfib, vm, &src, &grp, mask);
445 * This command displays the IPv4 MulticasrFIB Tables (VRF Tables) and
446 * the route entries for each table.
448 * @note This command will run for a long time when the FIB tables are
449 * comprised of millions of entries. For those senarios, consider displaying
450 * a single table or summary mode.
453 * Example of how to display all the IPv4 Multicast FIB tables:
454 * @cliexstart{show ip fib}
455 * ipv4-VRF:0, fib_index 0
456 * (*, 0.0.0.0/0): flags:D,
458 * multicast-ip4-chain
462 * test-eth1: Forward,
463 * test-eth2: Forward,
465 * multicast-ip4-chain
466 * [@2]: dpo-replicate: [index:1 buckets:2 to:[0:0]]
467 * [0] [@1]: ipv4-mcast: test-eth1: IP4: d0:d1:d2:d3:d4:01 -> 01:00:05:00:00:00
468 * [1] [@1]: ipv4-mcast: test-eth2: IP4: d0:d1:d2:d3:d4:02 -> 01:00:05:00:00:00
471 * Example of how to display a summary of all IPv4 FIB tables:
472 * @cliexstart{show ip fib summary}
473 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
474 * Prefix length Count
478 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
479 * Prefix length Count
487 VLIB_CLI_COMMAND (ip4_show_mfib_command, static) = {
488 .path = "show ip mfib",
489 .short_help = "show ip mfib [summary] [table <table-id>] [index <fib-id>] [<grp-addr>[/<mask>]] [<grp-addr>] [<src-addr> <grp-addr>]",
490 .function = ip4_show_mfib,