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>
22 ip6_mfib_table_instance_t ip6_mfib_table;
25 * Key and mask for radix
27 typedef clib_bihash_kv_40_8_t ip6_mfib_key_t;
29 static const mfib_prefix_t all_zeros = {
38 .fp_proto = FIB_PROTOCOL_IP6,
41 typedef enum ip6_mfib_special_type_t_ {
42 IP6_MFIB_SPECIAL_TYPE_NONE,
43 IP6_MFIB_SPECIAL_TYPE_SOLICITED,
44 } ip6_mfib_special_type_t;
46 typedef struct ip6_mfib_special_t_ {
48 * @brief solicited or not
50 ip6_mfib_special_type_t ims_type;
53 * @brief the Prefix length
58 * @brief The last byte of the mcast address
62 * @brief The scope of the address
67 static const ip6_mfib_special_t ip6_mfib_specials[] =
71 * Add ff02::1:ff00:0/104 via local route for all tables.
72 * This is required for neighbor discovery to work.
74 .ims_type = IP6_MFIB_SPECIAL_TYPE_SOLICITED,
79 * all-routers multicast address
81 .ims_type = IP6_MFIB_SPECIAL_TYPE_NONE,
82 .ims_scope = IP6_MULTICAST_SCOPE_link_local,
83 .ims_byte = IP6_MULTICAST_GROUP_ID_all_routers,
88 * all-nodes multicast address
90 .ims_type = IP6_MFIB_SPECIAL_TYPE_NONE,
91 .ims_scope = IP6_MULTICAST_SCOPE_link_local,
92 .ims_byte = IP6_MULTICAST_GROUP_ID_all_hosts,
97 * Add all-mldv2 multicast address via local route for all tables
99 .ims_type = IP6_MFIB_SPECIAL_TYPE_NONE,
101 .ims_scope = IP6_MULTICAST_SCOPE_link_local,
102 .ims_byte = IP6_MULTICAST_GROUP_ID_mldv2_routers,
106 #define FOR_EACH_IP6_SPECIAL(_pfx, _body) \
108 const ip6_mfib_special_t *_spec; \
111 _ii < ARRAY_LEN(ip6_mfib_specials); \
114 _spec = &ip6_mfib_specials[_ii]; \
115 if (IP6_MFIB_SPECIAL_TYPE_SOLICITED == _spec->ims_type) \
117 ip6_set_solicited_node_multicast_address( \
118 &(_pfx)->fp_grp_addr.ip6, 0); \
122 ip6_set_reserved_multicast_address ( \
123 &(_pfx)->fp_grp_addr.ip6, \
127 (_pfx)->fp_len = _spec->ims_len; \
128 do { _body; } while (0); \
134 ip6_create_mfib_with_table_id (u32 table_id,
137 mfib_table_t *mfib_table;
138 mfib_prefix_t pfx = {
139 .fp_proto = FIB_PROTOCOL_IP6,
141 const fib_route_path_t path_for_us = {
142 .frp_proto = DPO_PROTO_IP6,
143 .frp_addr = zero_addr,
144 .frp_sw_if_index = 0xffffffff,
147 .frp_flags = FIB_ROUTE_PATH_LOCAL,
148 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
151 pool_get_aligned(ip6_main.mfibs, mfib_table, CLIB_CACHE_LINE_BYTES);
152 clib_memset(mfib_table, 0, sizeof(*mfib_table));
154 mfib_table->mft_proto = FIB_PROTOCOL_IP6;
155 mfib_table->mft_index =
156 mfib_table->v6.index =
157 (mfib_table - ip6_main.mfibs);
159 hash_set (ip6_main.mfib_index_by_table_id,
161 mfib_table->mft_index);
163 mfib_table->mft_table_id =
164 mfib_table->v6.table_id =
167 mfib_table_lock(mfib_table->mft_index, FIB_PROTOCOL_IP6, src);
170 * add the special entries into the new FIB
172 mfib_table_entry_update(mfib_table->mft_index,
174 MFIB_SOURCE_DEFAULT_ROUTE,
176 MFIB_ENTRY_FLAG_DROP);
179 * Add each of the specials
181 FOR_EACH_IP6_SPECIAL(&pfx,
183 mfib_table_entry_path_update(mfib_table->mft_index,
186 MFIB_ENTRY_FLAG_NONE,
190 return (mfib_table->mft_index);
194 ip6_mfib_table_destroy (ip6_mfib_t *mfib)
196 mfib_table_t *mfib_table = (mfib_table_t*)mfib;
197 fib_node_index_t mfei;
198 mfib_prefix_t pfx = {
199 .fp_proto = FIB_PROTOCOL_IP6,
201 const fib_route_path_t path_for_us = {
202 .frp_proto = DPO_PROTO_IP6,
203 .frp_addr = zero_addr,
204 .frp_sw_if_index = 0xffffffff,
207 .frp_flags = FIB_ROUTE_PATH_LOCAL,
211 * remove all the specials we added when the table was created.
213 FOR_EACH_IP6_SPECIAL(&pfx,
215 mfib_table_entry_path_remove(mfib_table->mft_index,
221 mfei = mfib_table_lookup_exact_match(mfib_table->mft_index, &all_zeros);
222 mfib_table_entry_delete_index(mfei, MFIB_SOURCE_DEFAULT_ROUTE);
225 * validate no more routes.
227 ASSERT(0 == mfib_table->mft_total_route_counts);
228 ASSERT(~0 != mfib_table->mft_table_id);
230 hash_unset (ip6_main.mfib_index_by_table_id, mfib_table->mft_table_id);
231 pool_put(ip6_main.mfibs, mfib_table);
235 ip6_mfib_interface_enable_disable (u32 sw_if_index, int is_enable)
237 const fib_route_path_t path = {
238 .frp_proto = DPO_PROTO_IP6,
239 .frp_addr = zero_addr,
240 .frp_sw_if_index = sw_if_index,
243 .frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT,
245 mfib_prefix_t pfx = {
246 .fp_proto = FIB_PROTOCOL_IP6,
250 mfib_index = ip6_mfib_table_get_index_for_sw_if_index(sw_if_index);
254 FOR_EACH_IP6_SPECIAL(&pfx,
256 mfib_table_entry_path_update(mfib_index,
259 MFIB_ENTRY_FLAG_NONE,
265 FOR_EACH_IP6_SPECIAL(&pfx,
267 mfib_table_entry_path_remove(mfib_index,
276 ip6_mfib_table_find_or_create_and_lock (u32 table_id,
281 index = ip6_mfib_index_from_table_id(table_id);
283 return ip6_create_mfib_with_table_id(table_id, src);
284 mfib_table_lock(index, FIB_PROTOCOL_IP6, src);
290 ip6_mfib_table_get_index_for_sw_if_index (u32 sw_if_index)
292 if (sw_if_index >= vec_len(ip6_main.mfib_index_by_sw_if_index))
295 * This is the case for interfaces that are not yet mapped to
300 return (ip6_main.mfib_index_by_sw_if_index[sw_if_index]);
303 #define IPV6_MFIB_GRP_LEN(_len) \
304 (_len > 128 ? 128 : _len)
306 #define IP6_MFIB_MK_KEY(_mfib, _grp, _src, _len, _key) \
308 _key.key[0] = (_grp->as_u64[0] & \
309 ip6_main.fib_masks[IPV6_MFIB_GRP_LEN(_len)].as_u64[0]); \
310 _key.key[1] = (_grp->as_u64[1] & \
311 ip6_main.fib_masks[IPV6_MFIB_GRP_LEN(_len)].as_u64[1]); \
313 _key.key[2] = _src->as_u64[0]; \
314 _key.key[3] = _src->as_u64[1]; \
319 _key.key[4] = _mfib->index; \
320 _key.key[4] = (_key.key[4] << 32) | len; \
324 * ip6_fib_table_lookup_exact_match
326 * Exact match prefix lookup
329 ip6_mfib_table_lookup_exact_match (const ip6_mfib_t *mfib,
330 const ip6_address_t *grp,
331 const ip6_address_t *src,
334 ip6_mfib_key_t key, value;
337 IP6_MFIB_MK_KEY(mfib, grp, src, len, key);
339 rv = clib_bihash_search_inline_2_40_8(&ip6_mfib_table.ip6_mhash,
344 return (FIB_NODE_INDEX_INVALID);
348 * ip6_fib_table_lookup
350 * Longest prefix match for the forwarding plane (no mask given)
353 ip6_mfib_table_fwd_lookup (const ip6_mfib_t *mfib,
354 const ip6_address_t *src,
355 const ip6_address_t *grp)
357 ip6_mfib_table_instance_t *table;
358 ip6_mfib_key_t key, value;
362 table = &ip6_mfib_table;
363 n = vec_len (table->prefix_lengths_in_search_order);
365 for (i = 0; i < n; i++)
367 len = table->prefix_lengths_in_search_order[i];
369 ASSERT(len >= 0 && len <= 256);
370 IP6_MFIB_MK_KEY(mfib, grp, src, len, key);
371 rv = clib_bihash_search_inline_2_40_8(&table->ip6_mhash, &key, &value);
376 return (FIB_NODE_INDEX_INVALID);
381 ip6_mfib_table_get_less_specific (const ip6_mfib_t *mfib,
382 const ip6_address_t *src,
383 const ip6_address_t *grp,
389 * in the absence of a tree structure for the table that allows for an O(1)
390 * parent get, a cheeky way to find the cover is to LPM for the prefix with
392 * there should always be a cover, though it may be the default route. the
393 * default route's cover is the default route.
397 /* go from (S,G) to (*,G*) */
409 return (ip6_mfib_table_lookup(mfib, src, grp, mask_len));
413 * ip6_fib_table_lookup
415 * Longest prefix match
418 ip6_mfib_table_lookup (const ip6_mfib_t *mfib,
419 const ip6_address_t *src,
420 const ip6_address_t *grp,
423 ip6_mfib_table_instance_t *table;
424 ip6_mfib_key_t key, value;
427 table = &ip6_mfib_table;
428 n = vec_len (table->prefix_lengths_in_search_order);
431 * start search from a mask length same length or shorter.
432 * we don't want matches longer than the mask passed
435 while (i < n && table->prefix_lengths_in_search_order[i] > len)
442 len = table->prefix_lengths_in_search_order[i];
445 IP6_MFIB_MK_KEY(mfib, grp, src, len, key);
447 rv = clib_bihash_search_inline_2_40_8(&table->ip6_mhash, &key, &value);
452 return (FIB_NODE_INDEX_INVALID);
456 compute_prefix_lengths_in_search_order (ip6_mfib_table_instance_t *table)
459 vec_reset_length (table->prefix_lengths_in_search_order);
460 /* Note: bitmap reversed so this is in fact a longest prefix match */
461 clib_bitmap_foreach (i, table->non_empty_dst_address_length_bitmap)
463 vec_add1(table->prefix_lengths_in_search_order, (256 - i));
468 ip6_mfib_table_entry_insert (ip6_mfib_t *mfib,
469 const ip6_address_t *grp,
470 const ip6_address_t *src,
472 fib_node_index_t mfib_entry_index)
474 ip6_mfib_table_instance_t *table;
477 table = &ip6_mfib_table;
478 IP6_MFIB_MK_KEY(mfib, grp, src, len, key);
479 key.value = mfib_entry_index;
481 clib_bihash_add_del_40_8(&table->ip6_mhash, &key, 1);
483 if (0 == table->dst_address_length_refcounts[len]++)
485 table->non_empty_dst_address_length_bitmap =
486 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
488 compute_prefix_lengths_in_search_order (table);
493 ip6_mfib_table_entry_remove (ip6_mfib_t *mfib,
494 const ip6_address_t *grp,
495 const ip6_address_t *src,
498 ip6_mfib_table_instance_t *table;
501 IP6_MFIB_MK_KEY(mfib, grp, src, len, key);
503 table = &ip6_mfib_table;
504 clib_bihash_add_del_40_8(&table->ip6_mhash, &key, 0);
506 ASSERT (table->dst_address_length_refcounts[len] > 0);
507 if (--table->dst_address_length_refcounts[len] == 0)
509 table->non_empty_dst_address_length_bitmap =
510 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
512 compute_prefix_lengths_in_search_order (table);
516 static clib_error_t *
517 ip6_mfib_module_init (vlib_main_t * vm)
522 VLIB_INIT_FUNCTION(ip6_mfib_module_init);
525 format_ip6_mfib_table_memory (u8 * s, va_list * args)
529 bytes_inuse = alloc_arena_next(&(ip6_mfib_table.ip6_mhash));
531 s = format(s, "%=30s %=6d %=12ld\n",
533 pool_elts(ip6_main.mfibs),
540 ip6_mfib_table_show_one (ip6_mfib_t *mfib,
549 vlib_cli_output(vm, "%U",
551 ip6_mfib_table_get_less_specific(mfib, src, grp, mask_len),
552 MFIB_ENTRY_FORMAT_DETAIL);
556 vlib_cli_output(vm, "%U",
558 ip6_mfib_table_lookup(mfib, src, grp, mask_len),
559 MFIB_ENTRY_FORMAT_DETAIL);
563 typedef struct ip6_mfib_show_ctx_t_ {
564 fib_node_index_t *entries;
565 } ip6_mfib_show_ctx_t;
569 ip6_mfib_table_collect_entries (fib_node_index_t mfei, void *arg)
571 ip6_mfib_show_ctx_t *ctx = arg;
573 vec_add1(ctx->entries, mfei);
575 return (WALK_CONTINUE);
579 ip6_mfib_table_show_all (ip6_mfib_t *mfib,
582 fib_node_index_t *mfib_entry_index;
583 ip6_mfib_show_ctx_t ctx = {
587 ip6_mfib_table_walk(mfib,
588 ip6_mfib_table_collect_entries,
591 vec_sort_with_function(ctx.entries, mfib_entry_cmp_for_sort);
593 vec_foreach(mfib_entry_index, ctx.entries)
595 vlib_cli_output(vm, "%U",
598 MFIB_ENTRY_FORMAT_BRIEF);
601 vec_free(ctx.entries);
605 * @brief Context when walking the IPv6 table. Since all VRFs are in the
606 * same hash table, we need to filter only those we need as we walk
608 typedef struct ip6_mfib_walk_ctx_t_
611 mfib_table_walk_fn_t i6w_fn;
613 } ip6_mfib_walk_ctx_t;
616 ip6_mfib_walk_cb (clib_bihash_kv_40_8_t * kvp,
619 ip6_mfib_walk_ctx_t *ctx = arg;
621 if ((kvp->key[4] >> 32) == ctx->i6w_mfib_index)
623 ctx->i6w_fn(kvp->value, ctx->i6w_ctx);
625 return (BIHASH_WALK_CONTINUE);
629 ip6_mfib_table_walk (ip6_mfib_t *mfib,
630 mfib_table_walk_fn_t fn,
633 ip6_mfib_walk_ctx_t ctx = {
634 .i6w_mfib_index = mfib->index,
639 clib_bihash_foreach_key_value_pair_40_8(
640 &ip6_mfib_table.ip6_mhash,
645 static clib_error_t *
646 ip6_show_mfib (vlib_main_t * vm,
647 unformat_input_t * input,
648 vlib_cli_command_t * cmd)
650 ip6_main_t * im6 = &ip6_main;
651 mfib_table_t *mfib_table;
652 int verbose, matching;
653 ip6_address_t grp, src = {{0}};
654 u32 mask = 128, cover;
655 int table_id = -1, fib_index = ~0;
661 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
663 if (unformat (input, "brief") || unformat (input, "summary")
664 || unformat (input, "sum"))
667 else if (unformat (input, "%U %U",
668 unformat_ip6_address, &src,
669 unformat_ip6_address, &grp))
674 else if (unformat (input, "%U/%d", unformat_ip6_address, &grp, &mask))
676 clib_memset(&src, 0, sizeof(src));
679 else if (unformat (input, "%U", unformat_ip6_address, &grp))
681 clib_memset(&src, 0, sizeof(src));
685 else if (unformat (input, "table %d", &table_id))
687 else if (unformat (input, "index %d", &fib_index))
689 else if (unformat (input, "cover"))
695 pool_foreach (mfib_table, im6->mfibs)
697 ip6_mfib_t *mfib = &mfib_table->v6;
699 if (table_id >= 0 && table_id != (int)mfib->table_id)
701 if (fib_index != ~0 && fib_index != (int)mfib->index)
704 vlib_cli_output (vm, "%U, fib_index %d",
705 format_mfib_table_name, mfib->index, FIB_PROTOCOL_IP6,
711 /* vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count"); */
712 /* for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++) */
714 /* uword * hash = mfib->fib_entry_by_dst_address[i]; */
715 /* uword n_elts = hash_elts (hash); */
716 /* if (n_elts > 0) */
717 /* vlib_cli_output (vm, "%20d%16d", i, n_elts); */
724 ip6_mfib_table_show_all(mfib, vm);
728 ip6_mfib_table_show_one(mfib, vm, &src, &grp, mask, cover);
735 /* clang-format off */
737 * This command displays the IPv6 MulticasrFIB Tables (VRF Tables) and
738 * the route entries for each table.
740 * @note This command will run for a long time when the FIB tables are
741 * comprised of millions of entries. For those scenarios, consider displaying
742 * a single table or summary mode.
745 * Example of how to display all the IPv6 Multicast FIB tables:
746 * @cliexstart{show ip fib}
747 * ipv6-VRF:0, fib_index 0
748 * (*, 0.0.0.0/0): flags:D,
750 * multicast-ip6-chain
754 * test-eth1: Forward,
755 * test-eth2: Forward,
757 * multicast-ip6-chain
758 * [@2]: dpo-replicate: [index:1 buckets:2 to:[0:0]]
759 * [0] [@1]: ipv6-mcast: test-eth1: IP6: d0:d1:d2:d3:d4:01 -> 01:00:05:00:00:00
760 * [1] [@1]: ipv6-mcast: test-eth2: IP6: d0:d1:d2:d3:d4:02 -> 01:00:05:00:00:00
763 * Example of how to display a summary of all IPv6 FIB tables:
764 * @cliexstart{show ip fib summary}
765 * ipv6-VRF:0, fib_index 0, flow hash: src dst sport dport proto
766 * Prefix length Count
770 * ipv6-VRF:7, fib_index 1, flow hash: src dst sport dport proto
771 * Prefix length Count
778 /* clang-format on */
779 VLIB_CLI_COMMAND (ip6_show_fib_command, static) = {
780 .path = "show ip6 mfib",
781 .short_help = "show ip mfib [summary] [table <table-id>] [index <fib-id>] [<grp-addr>[/<mask>]] [<grp-addr>] [<src-addr> <grp-addr>]",
782 .function = ip6_show_mfib,
785 static clib_error_t *
786 ip6_mfib_init (vlib_main_t * vm)
788 clib_bihash_init_40_8 (&ip6_mfib_table.ip6_mhash,
790 IP6_MFIB_DEFAULT_HASH_NUM_BUCKETS,
791 IP6_MFIB_DEFAULT_HASH_MEMORY_SIZE);
796 VLIB_INIT_FUNCTION (ip6_mfib_init) =
798 .runs_before = VLIB_INITS("ip6_lookup_init"),