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/fib/ip6_fib.h>
17 #include <vnet/fib/fib_table.h>
20 vnet_ip6_fib_init (u32 fib_index)
23 .fp_proto = FIB_PROTOCOL_IP6,
33 * Add the default route.
35 fib_table_entry_special_add(fib_index,
37 FIB_SOURCE_DEFAULT_ROUTE,
41 * all link local for us
43 pfx.fp_addr.ip6.as_u64[0] = clib_host_to_net_u64 (0xFE80000000000000ULL);
44 pfx.fp_addr.ip6.as_u64[1] = 0;
46 fib_table_entry_special_add(fib_index,
49 FIB_ENTRY_FLAG_LOCAL);
53 create_fib_with_table_id (u32 table_id)
55 fib_table_t *fib_table;
58 pool_get_aligned(ip6_main.fibs, fib_table, CLIB_CACHE_LINE_BYTES);
59 pool_get_aligned(ip6_main.v6_fibs, v6_fib, CLIB_CACHE_LINE_BYTES);
61 memset(fib_table, 0, sizeof(*fib_table));
62 memset(v6_fib, 0, sizeof(*v6_fib));
64 ASSERT((fib_table - ip6_main.fibs) ==
65 (v6_fib - ip6_main.v6_fibs));
67 fib_table->ft_proto = FIB_PROTOCOL_IP6;
70 (fib_table - ip6_main.fibs);
72 hash_set(ip6_main.fib_index_by_table_id, table_id, fib_table->ft_index);
74 fib_table->ft_table_id =
77 fib_table->ft_flow_hash_config =
78 v6_fib->flow_hash_config =
81 vnet_ip6_fib_init(fib_table->ft_index);
82 fib_table_lock(fib_table->ft_index, FIB_PROTOCOL_IP6);
84 return (fib_table->ft_index);
88 ip6_fib_table_find_or_create_and_lock (u32 table_id)
92 p = hash_get (ip6_main.fib_index_by_table_id, table_id);
94 return create_fib_with_table_id(table_id);
96 fib_table_lock(p[0], FIB_PROTOCOL_IP6);
102 ip6_fib_table_create_and_lock (void)
104 return (create_fib_with_table_id(~0));
108 ip6_fib_table_destroy (u32 fib_index)
111 .fp_proto = FIB_PROTOCOL_IP6,
123 fib_table_entry_special_remove(fib_index,
125 FIB_SOURCE_DEFAULT_ROUTE);
131 ip6_set_solicited_node_multicast_address(&pfx.fp_addr.ip6, 0);
133 fib_table_entry_special_remove(fib_index,
138 * all-routers multicast address
140 ip6_set_reserved_multicast_address (&pfx.fp_addr.ip6,
141 IP6_MULTICAST_SCOPE_link_local,
142 IP6_MULTICAST_GROUP_ID_all_routers);
144 fib_table_entry_special_remove(fib_index,
149 * all-nodes multicast address
151 ip6_set_reserved_multicast_address (&pfx.fp_addr.ip6,
152 IP6_MULTICAST_SCOPE_link_local,
153 IP6_MULTICAST_GROUP_ID_all_hosts);
155 fib_table_entry_special_remove(fib_index,
160 * all-mldv2 multicast address
162 ip6_set_reserved_multicast_address (&pfx.fp_addr.ip6,
163 IP6_MULTICAST_SCOPE_link_local,
164 IP6_MULTICAST_GROUP_ID_mldv2_routers);
166 fib_table_entry_special_remove(fib_index,
173 pfx.fp_addr.ip6.as_u64[0] = clib_host_to_net_u64 (0xFE80000000000000ULL);
174 pfx.fp_addr.ip6.as_u64[1] = 0;
176 fib_table_entry_special_remove(fib_index,
180 fib_table_t *fib_table = fib_table_get(fib_index, FIB_PROTOCOL_IP6);
184 * validate no more routes.
186 ASSERT(0 == fib_table->ft_total_route_counts);
187 FOR_EACH_FIB_SOURCE(source)
189 ASSERT(0 == fib_table->ft_src_route_counts[source]);
192 if (~0 != fib_table->ft_table_id)
194 hash_unset (ip6_main.fib_index_by_table_id, fib_table->ft_table_id);
196 pool_put_index(ip6_main.v6_fibs, fib_table->ft_index);
197 pool_put(ip6_main.fibs, fib_table);
201 ip6_fib_table_lookup (u32 fib_index,
202 const ip6_address_t *addr,
205 const ip6_fib_table_instance_t *table;
206 BVT(clib_bihash_kv) kv, value;
210 table = &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING];
211 n_p = vec_len (table->prefix_lengths_in_search_order);
213 kv.key[0] = addr->as_u64[0];
214 kv.key[1] = addr->as_u64[1];
215 fib = ((u64)((fib_index))<<32);
218 * start search from a mask length same length or shorter.
219 * we don't want matches longer than the mask passed
222 while (i < n_p && table->prefix_lengths_in_search_order[i] > len)
229 int dst_address_length = table->prefix_lengths_in_search_order[i];
230 ip6_address_t * mask = &ip6_main.fib_masks[dst_address_length];
232 ASSERT(dst_address_length >= 0 && dst_address_length <= 128);
233 //As lengths are decreasing, masks are increasingly specific.
234 kv.key[0] &= mask->as_u64[0];
235 kv.key[1] &= mask->as_u64[1];
236 kv.key[2] = fib | dst_address_length;
238 rv = BV(clib_bihash_search_inline_2)(&table->ip6_hash, &kv, &value);
243 return (FIB_NODE_INDEX_INVALID);
247 ip6_fib_table_lookup_exact_match (u32 fib_index,
248 const ip6_address_t *addr,
251 const ip6_fib_table_instance_t *table;
252 BVT(clib_bihash_kv) kv, value;
257 table = &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING];
258 mask = &ip6_main.fib_masks[len];
259 fib = ((u64)((fib_index))<<32);
261 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
262 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
263 kv.key[2] = fib | len;
265 rv = BV(clib_bihash_search_inline_2)(&table->ip6_hash, &kv, &value);
269 return (FIB_NODE_INDEX_INVALID);
273 compute_prefix_lengths_in_search_order (ip6_fib_table_instance_t *table)
276 vec_reset_length (table->prefix_lengths_in_search_order);
277 /* Note: bitmap reversed so this is in fact a longest prefix match */
278 clib_bitmap_foreach (i, table->non_empty_dst_address_length_bitmap,
280 int dst_address_length = 128 - i;
281 vec_add1(table->prefix_lengths_in_search_order, dst_address_length);
286 ip6_fib_table_entry_remove (u32 fib_index,
287 const ip6_address_t *addr,
290 ip6_fib_table_instance_t *table;
291 BVT(clib_bihash_kv) kv;
295 table = &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING];
296 mask = &ip6_main.fib_masks[len];
297 fib = ((u64)((fib_index))<<32);
299 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
300 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
301 kv.key[2] = fib | len;
303 BV(clib_bihash_add_del)(&table->ip6_hash, &kv, 0);
305 /* refcount accounting */
306 ASSERT (table->dst_address_length_refcounts[len] > 0);
307 if (--table->dst_address_length_refcounts[len] == 0)
309 table->non_empty_dst_address_length_bitmap =
310 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
312 compute_prefix_lengths_in_search_order (table);
317 ip6_fib_table_entry_insert (u32 fib_index,
318 const ip6_address_t *addr,
320 fib_node_index_t fib_entry_index)
322 ip6_fib_table_instance_t *table;
323 BVT(clib_bihash_kv) kv;
327 table = &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING];
328 mask = &ip6_main.fib_masks[len];
329 fib = ((u64)((fib_index))<<32);
331 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
332 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
333 kv.key[2] = fib | len;
334 kv.value = fib_entry_index;
336 BV(clib_bihash_add_del)(&table->ip6_hash, &kv, 1);
338 table->dst_address_length_refcounts[len]++;
340 table->non_empty_dst_address_length_bitmap =
341 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
343 compute_prefix_lengths_in_search_order (table);
347 ip6_fib_table_fwding_lookup (ip6_main_t * im,
349 const ip6_address_t * dst)
351 const ip6_fib_table_instance_t *table;
354 BVT(clib_bihash_kv) kv, value;
357 table = &ip6_main.ip6_table[IP6_FIB_TABLE_FWDING];
358 len = vec_len (table->prefix_lengths_in_search_order);
360 kv.key[0] = dst->as_u64[0];
361 kv.key[1] = dst->as_u64[1];
362 fib = ((u64)((fib_index))<<32);
364 for (i = 0; i < len; i++)
366 int dst_address_length = table->prefix_lengths_in_search_order[i];
367 ip6_address_t * mask = &ip6_main.fib_masks[dst_address_length];
369 ASSERT(dst_address_length >= 0 && dst_address_length <= 128);
370 //As lengths are decreasing, masks are increasingly specific.
371 kv.key[0] &= mask->as_u64[0];
372 kv.key[1] &= mask->as_u64[1];
373 kv.key[2] = fib | dst_address_length;
375 rv = BV(clib_bihash_search_inline_2)(&table->ip6_hash, &kv, &value);
380 /* default route is always present */
385 u32 ip6_fib_table_fwding_lookup_with_if_index (ip6_main_t * im,
387 const ip6_address_t * dst)
389 u32 fib_index = vec_elt (im->fib_index_by_sw_if_index, sw_if_index);
390 return ip6_fib_table_fwding_lookup(im, fib_index, dst);
394 ip6_fib_table_get_flow_hash_config (u32 fib_index)
396 return (ip6_fib_get(fib_index)->flow_hash_config);
400 ip6_fib_table_get_index_for_sw_if_index (u32 sw_if_index)
402 if (sw_if_index >= vec_len(ip6_main.fib_index_by_sw_if_index))
405 * This is the case for interfaces that are not yet mapped to
410 return (ip6_main.fib_index_by_sw_if_index[sw_if_index]);
414 ip6_fib_table_fwding_dpo_update (u32 fib_index,
415 const ip6_address_t *addr,
419 ip6_fib_table_instance_t *table;
420 BVT(clib_bihash_kv) kv;
424 table = &ip6_main.ip6_table[IP6_FIB_TABLE_FWDING];
425 mask = &ip6_main.fib_masks[len];
426 fib = ((u64)((fib_index))<<32);
428 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
429 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
430 kv.key[2] = fib | len;
431 kv.value = dpo->dpoi_index;
433 BV(clib_bihash_add_del)(&table->ip6_hash, &kv, 1);
435 table->dst_address_length_refcounts[len]++;
437 table->non_empty_dst_address_length_bitmap =
438 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
440 compute_prefix_lengths_in_search_order (table);
444 ip6_fib_table_fwding_dpo_remove (u32 fib_index,
445 const ip6_address_t *addr,
449 ip6_fib_table_instance_t *table;
450 BVT(clib_bihash_kv) kv;
454 table = &ip6_main.ip6_table[IP6_FIB_TABLE_FWDING];
455 mask = &ip6_main.fib_masks[len];
456 fib = ((u64)((fib_index))<<32);
458 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
459 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
460 kv.key[2] = fib | len;
461 kv.value = dpo->dpoi_index;
463 BV(clib_bihash_add_del)(&table->ip6_hash, &kv, 0);
465 /* refcount accounting */
466 ASSERT (table->dst_address_length_refcounts[len] > 0);
467 if (--table->dst_address_length_refcounts[len] == 0)
469 table->non_empty_dst_address_length_bitmap =
470 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
472 compute_prefix_lengths_in_search_order (table);
477 * @brief Context when walking the IPv6 table. Since all VRFs are in the
478 * same hash table, we need to filter only those we need as we walk
480 typedef struct ip6_fib_walk_ctx_t_
483 fib_table_walk_fn_t i6w_fn;
485 } ip6_fib_walk_ctx_t;
488 ip6_fib_walk_cb (clib_bihash_kv_24_8_t * kvp,
491 ip6_fib_walk_ctx_t *ctx = arg;
493 if ((kvp->key[2] >> 32) == ctx->i6w_fib_index)
495 ctx->i6w_fn(kvp->value, ctx->i6w_ctx);
502 ip6_fib_table_walk (u32 fib_index,
503 fib_table_walk_fn_t fn,
506 ip6_fib_walk_ctx_t ctx = {
507 .i6w_fib_index = fib_index,
511 ip6_main_t *im = &ip6_main;
513 BV(clib_bihash_foreach_key_value_pair)(&im->ip6_table[IP6_FIB_TABLE_NON_FWDING].ip6_hash,
519 typedef struct ip6_fib_show_ctx_t_ {
520 fib_node_index_t *entries;
521 } ip6_fib_show_ctx_t;
524 ip6_fib_table_show_walk (fib_node_index_t fib_entry_index,
527 ip6_fib_show_ctx_t *ctx = arg;
529 vec_add1(ctx->entries, fib_entry_index);
535 ip6_fib_table_show_all (ip6_fib_t *fib,
538 fib_node_index_t *fib_entry_index;
539 ip6_fib_show_ctx_t ctx = {
543 ip6_fib_table_walk(fib->index, ip6_fib_table_show_walk, &ctx);
544 vec_sort_with_function(ctx.entries, fib_entry_cmp_for_sort);
546 vec_foreach(fib_entry_index, ctx.entries)
548 vlib_cli_output(vm, "%U",
551 FIB_ENTRY_FORMAT_BRIEF);
554 vec_free(ctx.entries);
558 ip6_fib_table_show_one (ip6_fib_t *fib,
560 ip6_address_t *address,
564 vlib_cli_output(vm, "%U",
566 ip6_fib_table_lookup(fib->index, address, mask_len),
568 FIB_ENTRY_FORMAT_DETAIL2:
569 FIB_ENTRY_FORMAT_DETAIL));
574 u64 count_by_prefix_length[129];
575 } count_routes_in_fib_at_prefix_length_arg_t;
578 count_routes_in_fib_at_prefix_length (BVT(clib_bihash_kv) * kvp,
581 count_routes_in_fib_at_prefix_length_arg_t * ap = arg;
584 if ((kvp->key[2]>>32) != ap->fib_index)
587 mask_width = kvp->key[2] & 0xFF;
589 ap->count_by_prefix_length[mask_width]++;
592 static clib_error_t *
593 ip6_show_fib (vlib_main_t * vm,
594 unformat_input_t * input,
595 vlib_cli_command_t * cmd)
597 count_routes_in_fib_at_prefix_length_arg_t _ca, *ca = &_ca;
598 ip6_main_t * im6 = &ip6_main;
599 fib_table_t *fib_table;
601 int verbose, matching;
602 ip6_address_t matching_address;
604 int table_id = -1, fib_index = ~0;
610 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
612 if (unformat (input, "brief") ||
613 unformat (input, "summary") ||
614 unformat (input, "sum"))
617 else if (unformat (input, "detail") ||
618 unformat (input, "det"))
621 else if (unformat (input, "%U/%d",
622 unformat_ip6_address, &matching_address, &mask_len))
625 else if (unformat (input, "%U", unformat_ip6_address, &matching_address))
628 else if (unformat (input, "table %d", &table_id))
630 else if (unformat (input, "index %d", &fib_index))
636 pool_foreach (fib_table, im6->fibs,
638 fib = pool_elt_at_index(im6->v6_fibs, fib_table->ft_index);
639 if (table_id >= 0 && table_id != (int)fib->table_id)
641 if (fib_index != ~0 && fib_index != (int)fib->index)
644 vlib_cli_output (vm, "%s, fib_index %d, flow hash: %U",
645 fib_table->ft_desc, fib->index,
646 format_ip_flow_hash_config, fib->flow_hash_config);
651 BVT(clib_bihash) * h = &im6->ip6_table[IP6_FIB_TABLE_NON_FWDING].ip6_hash;
654 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
656 memset (ca, 0, sizeof(*ca));
657 ca->fib_index = fib->index;
659 BV(clib_bihash_foreach_key_value_pair)
660 (h, count_routes_in_fib_at_prefix_length, ca);
662 for (len = 128; len >= 0; len--)
664 if (ca->count_by_prefix_length[len])
665 vlib_cli_output (vm, "%=20d%=16lld",
666 len, ca->count_by_prefix_length[len]);
673 ip6_fib_table_show_all(fib, vm);
677 ip6_fib_table_show_one(fib, vm, &matching_address, mask_len, detail);
685 * This command displays the IPv6 FIB Tables (VRF Tables) and the route
686 * entries for each table.
688 * @note This command will run for a long time when the FIB tables are
689 * comprised of millions of entries. For those senarios, consider displaying
694 * Example of how to display all the IPv6 FIB tables:
695 * @cliexstart{show ip6 fib}
696 * ipv6-VRF:0, fib_index 0, flow hash: src dst sport dport proto
699 * [@0]: dpo-load-balance: [index:5 buckets:1 uRPF:5 to:[0:0]]
700 * [0] [@0]: dpo-drop ip6
703 * [@0]: dpo-load-balance: [index:10 buckets:1 uRPF:10 to:[0:0]]
704 * [0] [@2]: dpo-receive
707 * [@0]: dpo-load-balance: [index:8 buckets:1 uRPF:8 to:[0:0]]
708 * [0] [@2]: dpo-receive
711 * [@0]: dpo-load-balance: [index:7 buckets:1 uRPF:7 to:[0:0]]
712 * [0] [@2]: dpo-receive
715 * [@0]: dpo-load-balance: [index:9 buckets:1 uRPF:9 to:[0:0]]
716 * [0] [@2]: dpo-receive
719 * [@0]: dpo-load-balance: [index:6 buckets:1 uRPF:6 to:[0:0]]
720 * [0] [@2]: dpo-receive
721 * ipv6-VRF:8, fib_index 1, flow hash: src dst sport dport proto
724 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
725 * [0] [@0]: dpo-drop ip6
728 * [@0]: dpo-load-balance: [index:27 buckets:1 uRPF:26 to:[0:0]]
729 * [0] [@4]: ipv6-glean: af_packet0
732 * [@0]: dpo-load-balance: [index:28 buckets:1 uRPF:27 to:[0:0]]
733 * [0] [@2]: dpo-receive: @::a:1:1:0:7 on af_packet0
736 * [@0]: dpo-load-balance: [index:26 buckets:1 uRPF:25 to:[0:0]]
737 * [0] [@2]: dpo-receive
738 * fe80::fe:3eff:fe3e:9222/128
740 * [@0]: dpo-load-balance: [index:29 buckets:1 uRPF:28 to:[0:0]]
741 * [0] [@2]: dpo-receive: fe80::fe:3eff:fe3e:9222 on af_packet0
744 * [@0]: dpo-load-balance: [index:24 buckets:1 uRPF:23 to:[0:0]]
745 * [0] [@2]: dpo-receive
748 * [@0]: dpo-load-balance: [index:23 buckets:1 uRPF:22 to:[0:0]]
749 * [0] [@2]: dpo-receive
752 * [@0]: dpo-load-balance: [index:25 buckets:1 uRPF:24 to:[0:0]]
753 * [0] [@2]: dpo-receive
756 * [@0]: dpo-load-balance: [index:22 buckets:1 uRPF:21 to:[0:0]]
757 * [0] [@2]: dpo-receive
760 * Example of how to display a summary of all IPv6 FIB tables:
761 * @cliexstart{show ip6 fib summary}
762 * ipv6-VRF:0, fib_index 0, flow hash: src dst sport dport proto
763 * Prefix length Count
768 * ipv6-VRF:8, fib_index 1, flow hash: src dst sport dport proto
769 * Prefix length Count
779 VLIB_CLI_COMMAND (ip6_show_fib_command, static) = {
780 .path = "show ip6 fib",
781 .short_help = "show ip6 fib [summary] [table <table-id>] [index <fib-id>] [<ip6-addr>[/<width>]] [detail]",
782 .function = ip6_show_fib,