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 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 = 32; 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_entry_insert (ip4_mfib_t *mfib,
229 const ip4_address_t *grp,
230 const ip4_address_t *src,
232 fib_node_index_t fib_entry_index)
234 uword * hash, * result;
237 IP4_MFIB_MK_KEY(grp, src, len, key);
238 hash = mfib->fib_entry_by_dst_address[len];
239 result = hash_get (hash, key);
241 if (NULL == result) {
246 hash = hash_create (32 /* elts */, sizeof (uword));
247 hash_set_flags (hash, HASH_FLAG_NO_AUTO_SHRINK);
249 hash = hash_set(hash, key, fib_entry_index);
250 mfib->fib_entry_by_dst_address[len] = hash;
259 ip4_mfib_table_entry_remove (ip4_mfib_t *mfib,
260 const ip4_address_t *grp,
261 const ip4_address_t *src,
264 uword * hash, * result;
267 IP4_MFIB_MK_KEY(grp, src, len, key);
268 hash = mfib->fib_entry_by_dst_address[len];
269 result = hash_get (hash, key);
274 * removing a non-existant entry. i'll allow it.
279 hash_unset(hash, key);
282 mfib->fib_entry_by_dst_address[len] = hash;
286 ip4_mfib_table_walk (ip4_mfib_t *mfib,
287 mfib_table_walk_fn_t fn,
292 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
294 uword * hash = mfib->fib_entry_by_dst_address[i];
300 hash_foreach_pair (p, hash,
302 fn(p->value[0], ctx);
309 ip4_mfib_table_show_all (ip4_mfib_t *mfib,
312 fib_node_index_t *mfib_entry_indicies;
313 fib_node_index_t *mfib_entry_index;
316 mfib_entry_indicies = NULL;
318 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
320 uword * hash = mfib->fib_entry_by_dst_address[i];
326 hash_foreach_pair (p, hash,
328 vec_add1(mfib_entry_indicies, p->value[0]);
333 vec_sort_with_function(mfib_entry_indicies, mfib_entry_cmp_for_sort);
335 vec_foreach(mfib_entry_index, mfib_entry_indicies)
337 vlib_cli_output(vm, "%U",
340 MFIB_ENTRY_FORMAT_BRIEF);
343 vec_free(mfib_entry_indicies);
347 ip4_mfib_table_show_one (ip4_mfib_t *mfib,
353 vlib_cli_output(vm, "%U",
355 ip4_mfib_table_lookup(mfib, src, grp, mask_len),
356 MFIB_ENTRY_FORMAT_DETAIL);
359 static clib_error_t *
360 ip4_show_mfib (vlib_main_t * vm,
361 unformat_input_t * input,
362 vlib_cli_command_t * cmd)
364 ip4_main_t * im4 = &ip4_main;
365 mfib_table_t *mfib_table;
366 int verbose, matching;
367 ip4_address_t grp, src = {{0}};
369 int i, table_id = -1, fib_index = ~0;
374 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
376 if (unformat (input, "brief") || unformat (input, "summary")
377 || unformat (input, "sum"))
380 else if (unformat (input, "%U %U",
381 unformat_ip4_address, &src,
382 unformat_ip4_address, &grp))
387 else if (unformat (input, "%U/%d", unformat_ip4_address, &grp, &mask))
389 memset(&src, 0, sizeof(src));
392 else if (unformat (input, "%U", unformat_ip4_address, &grp))
394 memset(&src, 0, sizeof(src));
398 else if (unformat (input, "table %d", &table_id))
400 else if (unformat (input, "index %d", &fib_index))
406 pool_foreach (mfib_table, im4->mfibs,
408 ip4_mfib_t *mfib = &mfib_table->v4;
410 if (table_id >= 0 && table_id != (int)mfib->table_id)
412 if (fib_index != ~0 && fib_index != (int)mfib->index)
415 vlib_cli_output (vm, "%U, fib_index %d",
416 format_mfib_table_name, mfib->index, FIB_PROTOCOL_IP4,
422 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
423 for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++)
425 uword * hash = mfib->fib_entry_by_dst_address[i];
426 uword n_elts = hash_elts (hash);
428 vlib_cli_output (vm, "%20d%16d", i, n_elts);
435 ip4_mfib_table_show_all(mfib, vm);
439 ip4_mfib_table_show_one(mfib, vm, &src, &grp, mask);
447 * This command displays the IPv4 MulticasrFIB Tables (VRF Tables) and
448 * the route entries for each table.
450 * @note This command will run for a long time when the FIB tables are
451 * comprised of millions of entries. For those senarios, consider displaying
452 * a single table or summary mode.
455 * Example of how to display all the IPv4 Multicast FIB tables:
456 * @cliexstart{show ip fib}
457 * ipv4-VRF:0, fib_index 0
458 * (*, 0.0.0.0/0): flags:D,
460 * multicast-ip4-chain
464 * test-eth1: Forward,
465 * test-eth2: Forward,
467 * multicast-ip4-chain
468 * [@2]: dpo-replicate: [index:1 buckets:2 to:[0:0]]
469 * [0] [@1]: ipv4-mcast: test-eth1: IP4: d0:d1:d2:d3:d4:01 -> 01:00:05:00:00:00
470 * [1] [@1]: ipv4-mcast: test-eth2: IP4: d0:d1:d2:d3:d4:02 -> 01:00:05:00:00:00
473 * Example of how to display a summary of all IPv4 FIB tables:
474 * @cliexstart{show ip fib summary}
475 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
476 * Prefix length Count
480 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
481 * Prefix length Count
489 VLIB_CLI_COMMAND (ip4_show_mfib_command, static) = {
490 .path = "show ip mfib",
491 .short_help = "show ip mfib [summary] [table <table-id>] [index <fib-id>] [<grp-addr>[/<mask>]] [<grp-addr>] [<src-addr> <grp-addr>]",
492 .function = ip4_show_mfib,