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,
157 mfib_table_t *mfib_table;
158 mfib_prefix_t pfx = {
159 .fp_proto = FIB_PROTOCOL_IP6,
161 const fib_route_path_t path_for_us = {
162 .frp_proto = DPO_PROTO_IP6,
163 .frp_addr = zero_addr,
164 .frp_sw_if_index = 0xffffffff,
167 .frp_flags = FIB_ROUTE_PATH_LOCAL,
170 pool_get_aligned(ip6_main.mfibs, mfib_table, CLIB_CACHE_LINE_BYTES);
171 memset(mfib_table, 0, sizeof(*mfib_table));
173 mfib_table->mft_proto = FIB_PROTOCOL_IP6;
174 mfib_table->mft_index =
175 mfib_table->v6.index =
176 (mfib_table - ip6_main.mfibs);
178 hash_set (ip6_main.mfib_index_by_table_id,
180 mfib_table->mft_index);
182 mfib_table->mft_table_id =
183 mfib_table->v6.table_id =
186 mfib_table_lock(mfib_table->mft_index, FIB_PROTOCOL_IP6, src);
188 mfib_table->v6.rhead =
189 clib_mem_alloc_aligned (sizeof(*mfib_table->v6.rhead),
190 CLIB_CACHE_LINE_BYTES);
191 rn_inithead0(mfib_table->v6.rhead, 8);
194 * add the special entries into the new FIB
196 mfib_table_entry_update(mfib_table->mft_index,
198 MFIB_SOURCE_DEFAULT_ROUTE,
200 MFIB_ENTRY_FLAG_DROP);
203 * Add each of the specials
205 FOR_EACH_IP6_SPECIAL(&pfx,
207 mfib_table_entry_path_update(mfib_table->mft_index,
211 MFIB_ITF_FLAG_FORWARD);
214 return (mfib_table->mft_index);
218 ip6_mfib_table_destroy (ip6_mfib_t *mfib)
220 mfib_table_t *mfib_table = (mfib_table_t*)mfib;
221 fib_node_index_t mfei;
222 mfib_prefix_t pfx = {
223 .fp_proto = FIB_PROTOCOL_IP6,
225 const fib_route_path_t path_for_us = {
226 .frp_proto = DPO_PROTO_IP6,
227 .frp_addr = zero_addr,
228 .frp_sw_if_index = 0xffffffff,
231 .frp_flags = FIB_ROUTE_PATH_LOCAL,
235 * remove all the specials we added when the table was created.
237 FOR_EACH_IP6_SPECIAL(&pfx,
239 mfib_table_entry_path_remove(mfib_table->mft_index,
245 mfei = mfib_table_lookup_exact_match(mfib_table->mft_index, &all_zeros);
246 mfib_table_entry_delete_index(mfei, MFIB_SOURCE_DEFAULT_ROUTE);
249 * validate no more routes.
251 ASSERT(0 == mfib_table->mft_total_route_counts);
252 ASSERT(~0 != mfib_table->mft_table_id);
254 hash_unset (ip6_main.mfib_index_by_table_id, mfib_table->mft_table_id);
255 clib_mem_free(mfib_table->v6.rhead);
256 pool_put(ip6_main.mfibs, mfib_table);
260 ip6_mfib_interface_enable_disable (u32 sw_if_index, int is_enable)
262 const fib_route_path_t path = {
263 .frp_proto = DPO_PROTO_IP6,
264 .frp_addr = zero_addr,
265 .frp_sw_if_index = sw_if_index,
269 mfib_prefix_t pfx = {
270 .fp_proto = FIB_PROTOCOL_IP6,
274 vec_validate (ip6_main.mfib_index_by_sw_if_index, sw_if_index);
275 mfib_index = ip6_mfib_table_get_index_for_sw_if_index(sw_if_index);
279 FOR_EACH_IP6_SPECIAL(&pfx,
281 mfib_table_entry_path_update(mfib_index,
285 MFIB_ITF_FLAG_ACCEPT);
290 FOR_EACH_IP6_SPECIAL(&pfx,
292 mfib_table_entry_path_remove(mfib_index,
301 ip6_mfib_table_find_or_create_and_lock (u32 table_id,
306 index = ip6_mfib_index_from_table_id(table_id);
308 return ip6_create_mfib_with_table_id(table_id, src);
309 mfib_table_lock(index, FIB_PROTOCOL_IP6, src);
315 ip6_mfib_table_get_index_for_sw_if_index (u32 sw_if_index)
317 if (sw_if_index >= vec_len(ip6_main.mfib_index_by_sw_if_index))
320 * This is the case for interfaces that are not yet mapped to
325 return (ip6_main.mfib_index_by_sw_if_index[sw_if_index]);
328 #define IP6_MFIB_MK_KEY(_grp, _src, _key) \
330 (_key)->key[0] = 33; \
331 memcpy((_key)->key+1, _grp, 16); \
332 memcpy((_key)->key+17, _src, 16); \
335 #define IP6_MFIB_MK_KEY_MASK(_grp, _src, _len, _key) \
337 IP6_MFIB_MK_KEY(_grp, _src, _key); \
339 (_key)->mask[0] = 33; \
342 memcpy((_key)->mask+1, &ip6_main.fib_masks[_len], 16); \
343 memset((_key)->mask+17, 0, 16); \
347 ASSERT(_len == 256); \
348 memcpy((_key)->mask+1, &ip6_main.fib_masks[128], 16); \
349 memcpy((_key)->mask+17, &ip6_main.fib_masks[128], 16); \
354 * ip6_fib_table_lookup_exact_match
356 * Exact match prefix lookup
359 ip6_mfib_table_lookup_exact_match (const ip6_mfib_t *mfib,
360 const ip6_address_t *grp,
361 const ip6_address_t *src,
364 ip6_mfib_node_t *i6mn;
367 IP6_MFIB_MK_KEY_MASK(grp, src, len, &key);
369 i6mn = (ip6_mfib_node_t*) rn_lookup(key.key, key.mask,
370 (struct radix_node_head *)mfib->rhead);
374 return (INDEX_INVALID);
377 return (i6mn->i6mn_entry);
381 * ip6_fib_table_lookup
383 * Longest prefix match
386 ip6_mfib_table_lookup (const ip6_mfib_t *mfib,
387 const ip6_address_t *src,
388 const ip6_address_t *grp,
391 ip6_mfib_node_t *i6mn;
394 IP6_MFIB_MK_KEY_MASK(grp, src, len, &key);
396 i6mn = (ip6_mfib_node_t*) rn_search_m(key.key,
397 mfib->rhead->rnh_treetop,
400 ASSERT(NULL != i6mn);
402 return (i6mn->i6mn_entry);
406 * ip6_fib_table_lookup
408 * Longest prefix match no mask
411 ip6_mfib_table_lookup2 (const ip6_mfib_t *mfib,
412 const ip6_address_t *src,
413 const ip6_address_t *grp)
415 ip6_mfib_node_t *i6mn;
418 IP6_MFIB_MK_KEY(grp, src, &key);
420 i6mn = (ip6_mfib_node_t*) rn_match(key.key,
421 (struct radix_node_head *)mfib->rhead); // const cast
423 ASSERT(NULL != i6mn);
425 return (i6mn->i6mn_entry);
429 ip6_mfib_table_entry_insert (ip6_mfib_t *mfib,
430 const ip6_address_t *grp,
431 const ip6_address_t *src,
433 fib_node_index_t mfib_entry_index)
435 ip6_mfib_node_t *i6mn = clib_mem_alloc(sizeof(*i6mn));
437 memset(i6mn->i6mn_nodes, 0, sizeof(i6mn->i6mn_nodes));
439 IP6_MFIB_MK_KEY_MASK(grp, src, len, &i6mn->i6mn_key);
440 i6mn->i6mn_entry = mfib_entry_index;
442 if (NULL == rn_addroute(i6mn->i6mn_key.key,
452 ip6_mfib_table_entry_remove (ip6_mfib_t *mfib,
453 const ip6_address_t *grp,
454 const ip6_address_t *src,
457 ip6_mfib_node_t *i6mn;
460 IP6_MFIB_MK_KEY_MASK(grp, src, len, &key);
462 i6mn = (ip6_mfib_node_t*) rn_delete(key.key, key.mask, mfib->rhead);
467 static clib_error_t *
468 ip6_mfib_module_init (vlib_main_t * vm)
473 VLIB_INIT_FUNCTION(ip6_mfib_module_init);
476 format_ip6_mfib_table_memory (u8 * s, va_list * args)
478 s = format(s, "%=30s %=6d %=8s\n",
480 pool_elts(ip6_main.mfibs), "???");
486 ip6_mfib_table_show_one (ip6_mfib_t *mfib,
492 vlib_cli_output(vm, "%U",
494 ip6_mfib_table_lookup(mfib, src, grp, mask_len),
495 MFIB_ENTRY_FORMAT_DETAIL);
498 typedef struct ip6_mfib_show_ctx_t_ {
499 fib_node_index_t *entries;
500 } ip6_mfib_show_ctx_t;
504 ip6_mfib_table_collect_entries (fib_node_index_t mfei, void *arg)
506 ip6_mfib_show_ctx_t *ctx = arg;
508 vec_add1(ctx->entries, mfei);
514 ip6_mfib_table_show_all (ip6_mfib_t *mfib,
517 fib_node_index_t *mfib_entry_index;
518 ip6_mfib_show_ctx_t ctx = {
522 ip6_mfib_table_walk(mfib,
523 ip6_mfib_table_collect_entries,
526 vec_sort_with_function(ctx.entries, mfib_entry_cmp_for_sort);
528 vec_foreach(mfib_entry_index, ctx.entries)
530 vlib_cli_output(vm, "%U",
533 MFIB_ENTRY_FORMAT_BRIEF);
536 vec_free(ctx.entries);
539 typedef struct ip6_mfib_radix_walk_ctx_t_
541 mfib_table_walk_fn_t user_fn;
543 } ip6_mfib_radix_walk_ctx_t;
546 ip6_mfib_table_radix_walk (struct radix_node *rn,
549 ip6_mfib_radix_walk_ctx_t *ctx = arg;
550 ip6_mfib_node_t *i6mn;
552 i6mn = (ip6_mfib_node_t*) rn;
554 ctx->user_fn(i6mn->i6mn_entry, ctx->user_ctx);
560 ip6_mfib_table_walk (ip6_mfib_t *mfib,
561 mfib_table_walk_fn_t fn,
564 ip6_mfib_radix_walk_ctx_t rn_ctx = {
569 rn_walktree(mfib->rhead,
570 ip6_mfib_table_radix_walk,
574 static clib_error_t *
575 ip6_show_mfib (vlib_main_t * vm,
576 unformat_input_t * input,
577 vlib_cli_command_t * cmd)
579 ip6_main_t * im6 = &ip6_main;
580 mfib_table_t *mfib_table;
581 int verbose, matching;
582 ip6_address_t grp, src = {{0}};
584 int table_id = -1, fib_index = ~0;
589 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
591 if (unformat (input, "brief") || unformat (input, "summary")
592 || unformat (input, "sum"))
595 else if (unformat (input, "%U %U",
596 unformat_ip6_address, &src,
597 unformat_ip6_address, &grp))
602 else if (unformat (input, "%U/%d", unformat_ip6_address, &grp, &mask))
604 memset(&src, 0, sizeof(src));
607 else if (unformat (input, "%U", unformat_ip6_address, &grp))
609 memset(&src, 0, sizeof(src));
613 else if (unformat (input, "table %d", &table_id))
615 else if (unformat (input, "index %d", &fib_index))
621 pool_foreach (mfib_table, im6->mfibs,
623 ip6_mfib_t *mfib = &mfib_table->v6;
625 if (table_id >= 0 && table_id != (int)mfib->table_id)
627 if (fib_index != ~0 && fib_index != (int)mfib->index)
630 vlib_cli_output (vm, "%U, fib_index %d",
631 format_mfib_table_name, mfib->index, FIB_PROTOCOL_IP6,
637 /* vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count"); */
638 /* for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++) */
640 /* uword * hash = mfib->fib_entry_by_dst_address[i]; */
641 /* uword n_elts = hash_elts (hash); */
642 /* if (n_elts > 0) */
643 /* vlib_cli_output (vm, "%20d%16d", i, n_elts); */
650 ip6_mfib_table_show_all(mfib, vm);
654 ip6_mfib_table_show_one(mfib, vm, &src, &grp, mask);
662 * This command displays the IPv6 MulticasrFIB Tables (VRF Tables) and
663 * the route entries for each table.
665 * @note This command will run for a long time when the FIB tables are
666 * comprised of millions of entries. For those senarios, consider displaying
667 * a single table or summary mode.
670 * Example of how to display all the IPv6 Multicast FIB tables:
671 * @cliexstart{show ip fib}
672 * ipv6-VRF:0, fib_index 0
673 * (*, 0.0.0.0/0): flags:D,
675 * multicast-ip6-chain
679 * test-eth1: Forward,
680 * test-eth2: Forward,
682 * multicast-ip6-chain
683 * [@2]: dpo-replicate: [index:1 buckets:2 to:[0:0]]
684 * [0] [@1]: ipv6-mcast: test-eth1: IP6: d0:d1:d2:d3:d4:01 -> 01:00:05:00:00:00
685 * [1] [@1]: ipv6-mcast: test-eth2: IP6: d0:d1:d2:d3:d4:02 -> 01:00:05:00:00:00
688 * Example of how to display a summary of all IPv6 FIB tables:
689 * @cliexstart{show ip fib summary}
690 * ipv6-VRF:0, fib_index 0, flow hash: src dst sport dport proto
691 * Prefix length Count
695 * ipv6-VRF:7, fib_index 1, flow hash: src dst sport dport proto
696 * Prefix length Count
704 VLIB_CLI_COMMAND (ip6_show_fib_command, static) = {
705 .path = "show ip6 mfib",
706 .short_help = "show ip mfib [summary] [table <table-id>] [index <fib-id>] [<grp-addr>[/<mask>]] [<grp-addr>] [<src-addr> <grp-addr>]",
707 .function = ip6_show_mfib,