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/ip6_mfib.h>
18 #include <vnet/mfib/mfib_table.h>
19 #include <vnet/mfib/mfib_entry.h>
20 #include <vnet/fib/ip6_fib.h>
23 * The number of bytes in an address/ask key in the radix tree
24 * First byte is the length in bytes.
26 #define IP6_MFIB_KEY_LEN 33
29 * Key and mask for radix
31 typedef struct ip6_mfib_key_t_
33 u8 key[IP6_MFIB_KEY_LEN];
34 u8 mask[IP6_MFIB_KEY_LEN];
38 * An object that is inserted into the radix tree.
39 * Since it's in the tree and has pointers, it cannot realloc and so cannot
40 * come from a vlib pool.
42 typedef struct ip6_mfib_node_t_
44 struct radix_node i6mn_nodes[2];
45 ip6_mfib_key_t i6mn_key;
49 static const mfib_prefix_t all_zeros = {
58 .fp_proto = FIB_PROTOCOL_IP6,
61 typedef enum ip6_mfib_special_type_t_ {
62 IP6_MFIB_SPECIAL_TYPE_NONE,
63 IP6_MFIB_SPECIAL_TYPE_SOLICITED,
64 } ip6_mfib_special_type_t;
66 typedef struct ip6_mfib_special_t_ {
68 * @brief solicited or not
70 ip6_mfib_special_type_t ims_type;
73 * @brief the Prefix length
78 * @brief The last byte of the mcast address
82 * @brief The scope of the address
87 static const ip6_mfib_special_t ip6_mfib_specials[] =
91 * Add ff02::1:ff00:0/104 via local route for all tables.
92 * This is required for neighbor discovery to work.
94 .ims_type = IP6_MFIB_SPECIAL_TYPE_SOLICITED,
99 * all-routers multicast address
101 .ims_type = IP6_MFIB_SPECIAL_TYPE_NONE,
102 .ims_scope = IP6_MULTICAST_SCOPE_link_local,
103 .ims_byte = IP6_MULTICAST_GROUP_ID_all_routers,
108 * all-nodes multicast address
110 .ims_type = IP6_MFIB_SPECIAL_TYPE_NONE,
111 .ims_scope = IP6_MULTICAST_SCOPE_link_local,
112 .ims_byte = IP6_MULTICAST_GROUP_ID_all_hosts,
117 * Add all-mldv2 multicast address via local route for all tables
119 .ims_type = IP6_MFIB_SPECIAL_TYPE_NONE,
121 .ims_scope = IP6_MULTICAST_SCOPE_link_local,
122 .ims_byte = IP6_MULTICAST_GROUP_ID_mldv2_routers,
126 #define FOR_EACH_IP6_SPECIAL(_pfx, _body) \
128 const ip6_mfib_special_t *_spec; \
131 _ii < ARRAY_LEN(ip6_mfib_specials); \
134 _spec = &ip6_mfib_specials[_ii]; \
135 if (IP6_MFIB_SPECIAL_TYPE_SOLICITED == _spec->ims_type) \
137 ip6_set_solicited_node_multicast_address( \
138 &(_pfx)->fp_grp_addr.ip6, 0); \
142 ip6_set_reserved_multicast_address ( \
143 &(_pfx)->fp_grp_addr.ip6, \
147 (_pfx)->fp_len = _spec->ims_len; \
148 do { _body; } while (0); \
154 ip6_create_mfib_with_table_id (u32 table_id)
156 mfib_table_t *mfib_table;
157 mfib_prefix_t pfx = {
158 .fp_proto = FIB_PROTOCOL_IP6,
160 const fib_route_path_t path_for_us = {
161 .frp_proto = FIB_PROTOCOL_IP6,
162 .frp_addr = zero_addr,
163 .frp_sw_if_index = 0xffffffff,
166 .frp_flags = FIB_ROUTE_PATH_LOCAL,
169 pool_get_aligned(ip6_main.mfibs, mfib_table, CLIB_CACHE_LINE_BYTES);
170 memset(mfib_table, 0, sizeof(*mfib_table));
172 mfib_table->mft_proto = FIB_PROTOCOL_IP6;
173 mfib_table->mft_index =
174 mfib_table->v6.index =
175 (mfib_table - ip6_main.mfibs);
177 hash_set (ip6_main.mfib_index_by_table_id,
179 mfib_table->mft_index);
181 mfib_table->mft_table_id =
182 mfib_table->v6.table_id =
185 mfib_table_lock(mfib_table->mft_index, FIB_PROTOCOL_IP6);
187 mfib_table->v6.rhead =
188 clib_mem_alloc_aligned (sizeof(*mfib_table->v6.rhead),
189 CLIB_CACHE_LINE_BYTES);
190 rn_inithead0(mfib_table->v6.rhead, 8);
193 * add the special entries into the new FIB
195 mfib_table_entry_update(mfib_table->mft_index,
197 MFIB_SOURCE_DEFAULT_ROUTE,
199 MFIB_ENTRY_FLAG_DROP);
202 * Add each of the specials
204 FOR_EACH_IP6_SPECIAL(&pfx,
206 mfib_table_entry_path_update(mfib_table->mft_index,
210 MFIB_ITF_FLAG_FORWARD);
213 return (mfib_table->mft_index);
217 ip6_mfib_table_destroy (ip6_mfib_t *mfib)
219 mfib_table_t *mfib_table = (mfib_table_t*)mfib;
220 fib_node_index_t mfei;
221 mfib_prefix_t pfx = {
222 .fp_proto = FIB_PROTOCOL_IP6,
224 const fib_route_path_t path_for_us = {
225 .frp_proto = FIB_PROTOCOL_IP6,
226 .frp_addr = zero_addr,
227 .frp_sw_if_index = 0xffffffff,
230 .frp_flags = FIB_ROUTE_PATH_LOCAL,
234 * remove all the specials we added when the table was created.
236 FOR_EACH_IP6_SPECIAL(&pfx,
238 mfib_table_entry_path_remove(mfib_table->mft_index,
244 mfei = mfib_table_lookup_exact_match(mfib_table->mft_index, &all_zeros);
245 mfib_table_entry_delete_index(mfei, MFIB_SOURCE_DEFAULT_ROUTE);
248 * validate no more routes.
250 ASSERT(0 == mfib_table->mft_total_route_counts);
251 ASSERT(~0 != mfib_table->mft_table_id);
253 hash_unset (ip6_main.mfib_index_by_table_id, mfib_table->mft_table_id);
254 clib_mem_free(mfib_table->v6.rhead);
255 pool_put(ip6_main.mfibs, mfib_table);
259 ip6_mfib_interface_enable_disable (u32 sw_if_index, int is_enable)
261 const fib_route_path_t path = {
262 .frp_proto = FIB_PROTOCOL_IP6,
263 .frp_addr = zero_addr,
264 .frp_sw_if_index = sw_if_index,
268 mfib_prefix_t pfx = {
269 .fp_proto = FIB_PROTOCOL_IP6,
273 vec_validate (ip6_main.mfib_index_by_sw_if_index, sw_if_index);
274 mfib_index = ip6_mfib_table_get_index_for_sw_if_index(sw_if_index);
278 FOR_EACH_IP6_SPECIAL(&pfx,
280 mfib_table_entry_path_update(mfib_index,
284 MFIB_ITF_FLAG_ACCEPT);
289 FOR_EACH_IP6_SPECIAL(&pfx,
291 mfib_table_entry_path_remove(mfib_index,
300 ip6_mfib_table_find_or_create_and_lock (u32 table_id)
304 index = ip6_mfib_index_from_table_id(table_id);
306 return ip6_create_mfib_with_table_id(table_id);
307 mfib_table_lock(index, FIB_PROTOCOL_IP6);
313 ip6_mfib_table_get_index_for_sw_if_index (u32 sw_if_index)
315 if (sw_if_index >= vec_len(ip6_main.mfib_index_by_sw_if_index))
318 * This is the case for interfaces that are not yet mapped to
323 return (ip6_main.mfib_index_by_sw_if_index[sw_if_index]);
326 #define IP6_MFIB_MK_KEY(_grp, _src, _key) \
328 (_key)->key[0] = 33; \
329 memcpy((_key)->key+1, _grp, 16); \
330 memcpy((_key)->key+17, _src, 16); \
333 #define IP6_MFIB_MK_KEY_MASK(_grp, _src, _len, _key) \
335 IP6_MFIB_MK_KEY(_grp, _src, _key); \
337 (_key)->mask[0] = 33; \
340 memcpy((_key)->mask+1, &ip6_main.fib_masks[_len], 16); \
341 memset((_key)->mask+17, 0, 16); \
345 ASSERT(_len == 256); \
346 memcpy((_key)->mask+1, &ip6_main.fib_masks[128], 16); \
347 memcpy((_key)->mask+17, &ip6_main.fib_masks[128], 16); \
352 * ip6_fib_table_lookup_exact_match
354 * Exact match prefix lookup
357 ip6_mfib_table_lookup_exact_match (const ip6_mfib_t *mfib,
358 const ip6_address_t *grp,
359 const ip6_address_t *src,
362 ip6_mfib_node_t *i6mn;
365 IP6_MFIB_MK_KEY_MASK(grp, src, len, &key);
367 i6mn = (ip6_mfib_node_t*) rn_lookup(key.key, key.mask,
368 (struct radix_node_head *)mfib->rhead);
372 return (INDEX_INVALID);
375 return (i6mn->i6mn_entry);
379 * ip6_fib_table_lookup
381 * Longest prefix match
384 ip6_mfib_table_lookup (const ip6_mfib_t *mfib,
385 const ip6_address_t *src,
386 const ip6_address_t *grp,
389 ip6_mfib_node_t *i6mn;
392 IP6_MFIB_MK_KEY_MASK(grp, src, len, &key);
394 i6mn = (ip6_mfib_node_t*) rn_search_m(key.key,
395 mfib->rhead->rnh_treetop,
398 ASSERT(NULL != i6mn);
400 return (i6mn->i6mn_entry);
404 * ip6_fib_table_lookup
406 * Longest prefix match no mask
409 ip6_mfib_table_lookup2 (const ip6_mfib_t *mfib,
410 const ip6_address_t *src,
411 const ip6_address_t *grp)
413 ip6_mfib_node_t *i6mn;
416 IP6_MFIB_MK_KEY(grp, src, &key);
418 i6mn = (ip6_mfib_node_t*) rn_match(key.key,
419 (struct radix_node_head *)mfib->rhead); // const cast
421 ASSERT(NULL != i6mn);
423 return (i6mn->i6mn_entry);
427 ip6_mfib_table_entry_insert (ip6_mfib_t *mfib,
428 const ip6_address_t *grp,
429 const ip6_address_t *src,
431 fib_node_index_t mfib_entry_index)
433 ip6_mfib_node_t *i6mn = clib_mem_alloc(sizeof(*i6mn));
435 memset(i6mn->i6mn_nodes, 0, sizeof(i6mn->i6mn_nodes));
437 IP6_MFIB_MK_KEY_MASK(grp, src, len, &i6mn->i6mn_key);
438 i6mn->i6mn_entry = mfib_entry_index;
440 if (NULL == rn_addroute(i6mn->i6mn_key.key,
450 ip6_mfib_table_entry_remove (ip6_mfib_t *mfib,
451 const ip6_address_t *grp,
452 const ip6_address_t *src,
455 ip6_mfib_node_t *i6mn;
458 IP6_MFIB_MK_KEY_MASK(grp, src, len, &key);
460 i6mn = (ip6_mfib_node_t*) rn_delete(key.key, key.mask, mfib->rhead);
465 static clib_error_t *
466 ip6_mfib_module_init (vlib_main_t * vm)
471 VLIB_INIT_FUNCTION(ip6_mfib_module_init);
474 ip6_mfib_table_show_one (ip6_mfib_t *mfib,
480 vlib_cli_output(vm, "%U",
482 ip6_mfib_table_lookup(mfib, src, grp, mask_len),
483 MFIB_ENTRY_FORMAT_DETAIL);
486 typedef struct ip6_mfib_show_ctx_t_ {
487 fib_node_index_t *entries;
488 } ip6_mfib_show_ctx_t;
492 ip6_mfib_table_collect_entries (fib_node_index_t mfei, void *arg)
494 ip6_mfib_show_ctx_t *ctx = arg;
496 vec_add1(ctx->entries, mfei);
502 ip6_mfib_table_show_all (ip6_mfib_t *mfib,
505 fib_node_index_t *mfib_entry_index;
506 ip6_mfib_show_ctx_t ctx = {
510 ip6_mfib_table_walk(mfib,
511 ip6_mfib_table_collect_entries,
514 vec_sort_with_function(ctx.entries, mfib_entry_cmp_for_sort);
516 vec_foreach(mfib_entry_index, ctx.entries)
518 vlib_cli_output(vm, "%U",
521 MFIB_ENTRY_FORMAT_BRIEF);
524 vec_free(ctx.entries);
527 typedef struct ip6_mfib_radix_walk_ctx_t_
529 mfib_table_walk_fn_t user_fn;
531 } ip6_mfib_radix_walk_ctx_t;
534 ip6_mfib_table_radix_walk (struct radix_node *rn,
537 ip6_mfib_radix_walk_ctx_t *ctx = arg;
538 ip6_mfib_node_t *i6mn;
540 i6mn = (ip6_mfib_node_t*) rn;
542 ctx->user_fn(i6mn->i6mn_entry, ctx->user_ctx);
548 ip6_mfib_table_walk (ip6_mfib_t *mfib,
549 mfib_table_walk_fn_t fn,
552 ip6_mfib_radix_walk_ctx_t rn_ctx = {
557 rn_walktree(mfib->rhead,
558 ip6_mfib_table_radix_walk,
562 static clib_error_t *
563 ip6_show_mfib (vlib_main_t * vm,
564 unformat_input_t * input,
565 vlib_cli_command_t * cmd)
567 ip6_main_t * im4 = &ip6_main;
568 mfib_table_t *mfib_table;
569 int verbose, matching;
570 ip6_address_t grp, src = {{0}};
572 int table_id = -1, fib_index = ~0;
577 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
579 if (unformat (input, "brief") || unformat (input, "summary")
580 || unformat (input, "sum"))
583 else if (unformat (input, "%U %U",
584 unformat_ip6_address, &src,
585 unformat_ip6_address, &grp))
590 else if (unformat (input, "%U", unformat_ip6_address, &grp))
595 else if (unformat (input, "%U/%d",
596 unformat_ip6_address, &grp, &mask))
598 else if (unformat (input, "table %d", &table_id))
600 else if (unformat (input, "index %d", &fib_index))
606 pool_foreach (mfib_table, im4->mfibs,
608 ip6_mfib_t *mfib = &mfib_table->v6;
610 if (table_id >= 0 && table_id != (int)mfib->table_id)
612 if (fib_index != ~0 && fib_index != (int)mfib->index)
615 vlib_cli_output (vm, "%U, fib_index %d",
616 format_mfib_table_name, mfib->index, FIB_PROTOCOL_IP6,
622 /* vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count"); */
623 /* for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++) */
625 /* uword * hash = mfib->fib_entry_by_dst_address[i]; */
626 /* uword n_elts = hash_elts (hash); */
627 /* if (n_elts > 0) */
628 /* vlib_cli_output (vm, "%20d%16d", i, n_elts); */
635 ip6_mfib_table_show_all(mfib, vm);
639 ip6_mfib_table_show_one(mfib, vm, &src, &grp, mask);
647 * This command displays the IPv4 MulticasrFIB Tables (VRF Tables) and
648 * the route entries for each table.
650 * @note This command will run for a long time when the FIB tables are
651 * comprised of millions of entries. For those senarios, consider displaying
652 * a single table or summary mode.
655 * Example of how to display all the IPv4 Multicast FIB tables:
656 * @cliexstart{show ip fib}
657 * ipv4-VRF:0, fib_index 0
658 * (*, 0.0.0.0/0): flags:D,
660 * multicast-ip6-chain
664 * test-eth1: Forward,
665 * test-eth2: Forward,
667 * multicast-ip6-chain
668 * [@2]: dpo-replicate: [index:1 buckets:2 to:[0:0]]
669 * [0] [@1]: ipv4-mcast: test-eth1: IP6: d0:d1:d2:d3:d4:01 -> 01:00:05:00:00:00
670 * [1] [@1]: ipv4-mcast: test-eth2: IP6: d0:d1:d2:d3:d4:02 -> 01:00:05:00:00:00
673 * Example of how to display a summary of all IPv4 FIB tables:
674 * @cliexstart{show ip fib summary}
675 * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
676 * Prefix length Count
680 * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
681 * Prefix length Count
689 VLIB_CLI_COMMAND (ip6_show_fib_command, static) = {
690 .path = "show ip6 mfib",
691 .short_help = "show ip mfib [summary] [table <table-id>] [index <fib-id>] [<grp-addr>[/<mask>]] [<grp-addr>] [<src-addr> <grp-addr>]",
692 .function = ip6_show_mfib,