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>
18 #include <vnet/dpo/ip6_ll_dpo.h>
20 #include <vppinfra/bihash_24_8.h>
21 #include <vppinfra/bihash_template.c>
24 vnet_ip6_fib_init (u32 fib_index)
27 .fp_proto = FIB_PROTOCOL_IP6,
37 * Add the default route.
39 fib_table_entry_special_add(fib_index,
41 FIB_SOURCE_DEFAULT_ROUTE,
45 * all link local via the link local lookup DPO
47 pfx.fp_addr.ip6.as_u64[0] = clib_host_to_net_u64 (0xFE80000000000000ULL);
48 pfx.fp_addr.ip6.as_u64[1] = 0;
50 fib_table_entry_special_dpo_add(fib_index,
58 create_fib_with_table_id (u32 table_id,
60 fib_table_flags_t flags,
63 fib_table_t *fib_table;
66 pool_get(ip6_main.fibs, fib_table);
67 pool_get_aligned(ip6_main.v6_fibs, v6_fib, CLIB_CACHE_LINE_BYTES);
69 clib_memset(fib_table, 0, sizeof(*fib_table));
70 clib_memset(v6_fib, 0, sizeof(*v6_fib));
72 ASSERT((fib_table - ip6_main.fibs) ==
73 (v6_fib - ip6_main.v6_fibs));
75 fib_table->ft_proto = FIB_PROTOCOL_IP6;
78 (fib_table - ip6_main.fibs);
80 hash_set(ip6_main.fib_index_by_table_id, table_id, fib_table->ft_index);
82 fib_table->ft_table_id =
85 fib_table->ft_flow_hash_config = IP_FLOW_HASH_DEFAULT;
86 fib_table->ft_flags = flags;
87 fib_table->ft_desc = desc;
89 vnet_ip6_fib_init(fib_table->ft_index);
90 fib_table_lock(fib_table->ft_index, FIB_PROTOCOL_IP6, src);
92 return (fib_table->ft_index);
96 ip6_fib_table_find_or_create_and_lock (u32 table_id,
101 p = hash_get (ip6_main.fib_index_by_table_id, table_id);
103 return create_fib_with_table_id(table_id, src,
107 fib_table_lock(p[0], FIB_PROTOCOL_IP6, src);
113 ip6_fib_table_create_and_lock (fib_source_t src,
114 fib_table_flags_t flags,
117 return (create_fib_with_table_id(~0, src, flags, desc));
121 ip6_fib_table_destroy (u32 fib_index)
124 * all link local first ...
127 .fp_proto = FIB_PROTOCOL_IP6,
138 fib_table_entry_delete(fib_index,
143 * ... then the default route.
145 pfx.fp_addr.ip6.as_u64[0] = 0;
147 fib_table_entry_special_remove(fib_index,
149 FIB_SOURCE_DEFAULT_ROUTE);
151 fib_table_t *fib_table = fib_table_get(fib_index, FIB_PROTOCOL_IP6);
155 * validate no more routes.
157 ASSERT(0 == fib_table->ft_total_route_counts);
158 vec_foreach_index(source, fib_table->ft_src_route_counts)
160 ASSERT(0 == fib_table->ft_src_route_counts[source]);
163 if (~0 != fib_table->ft_table_id)
165 hash_unset (ip6_main.fib_index_by_table_id, fib_table->ft_table_id);
167 vec_free(fib_table->ft_src_route_counts);
168 pool_put_index(ip6_main.v6_fibs, fib_table->ft_index);
169 pool_put(ip6_main.fibs, fib_table);
173 ip6_fib_table_lookup (u32 fib_index,
174 const ip6_address_t *addr,
177 ip6_fib_table_instance_t *table;
178 clib_bihash_kv_24_8_t kv, value;
182 table = &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING];
183 n_p = vec_len (table->prefix_lengths_in_search_order);
185 kv.key[0] = addr->as_u64[0];
186 kv.key[1] = addr->as_u64[1];
187 fib = ((u64)((fib_index))<<32);
190 * start search from a mask length same length or shorter.
191 * we don't want matches longer than the mask passed
194 while (i < n_p && table->prefix_lengths_in_search_order[i] > len)
201 int dst_address_length = table->prefix_lengths_in_search_order[i];
202 ip6_address_t * mask = &ip6_main.fib_masks[dst_address_length];
204 ASSERT(dst_address_length >= 0 && dst_address_length <= 128);
205 //As lengths are decreasing, masks are increasingly specific.
206 kv.key[0] &= mask->as_u64[0];
207 kv.key[1] &= mask->as_u64[1];
208 kv.key[2] = fib | dst_address_length;
210 rv = clib_bihash_search_inline_2_24_8(&table->ip6_hash, &kv, &value);
215 return (FIB_NODE_INDEX_INVALID);
219 ip6_fib_table_lookup_exact_match (u32 fib_index,
220 const ip6_address_t *addr,
223 ip6_fib_table_instance_t *table;
224 clib_bihash_kv_24_8_t kv, value;
229 table = &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING];
230 mask = &ip6_main.fib_masks[len];
231 fib = ((u64)((fib_index))<<32);
233 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
234 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
235 kv.key[2] = fib | len;
237 rv = clib_bihash_search_inline_2_24_8(&table->ip6_hash, &kv, &value);
241 return (FIB_NODE_INDEX_INVALID);
245 compute_prefix_lengths_in_search_order (ip6_fib_table_instance_t *table)
248 vec_reset_length (table->prefix_lengths_in_search_order);
249 /* Note: bitmap reversed so this is in fact a longest prefix match */
250 clib_bitmap_foreach (i, table->non_empty_dst_address_length_bitmap,
252 int dst_address_length = 128 - i;
253 vec_add1(table->prefix_lengths_in_search_order, dst_address_length);
258 ip6_fib_table_entry_remove (u32 fib_index,
259 const ip6_address_t *addr,
262 ip6_fib_table_instance_t *table;
263 clib_bihash_kv_24_8_t kv;
267 table = &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING];
268 mask = &ip6_main.fib_masks[len];
269 fib = ((u64)((fib_index))<<32);
271 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
272 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
273 kv.key[2] = fib | len;
275 clib_bihash_add_del_24_8(&table->ip6_hash, &kv, 0);
277 /* refcount accounting */
278 ASSERT (table->dst_address_length_refcounts[len] > 0);
279 if (--table->dst_address_length_refcounts[len] == 0)
281 table->non_empty_dst_address_length_bitmap =
282 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
284 compute_prefix_lengths_in_search_order (table);
289 ip6_fib_table_entry_insert (u32 fib_index,
290 const ip6_address_t *addr,
292 fib_node_index_t fib_entry_index)
294 ip6_fib_table_instance_t *table;
295 clib_bihash_kv_24_8_t kv;
299 table = &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING];
300 mask = &ip6_main.fib_masks[len];
301 fib = ((u64)((fib_index))<<32);
303 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
304 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
305 kv.key[2] = fib | len;
306 kv.value = fib_entry_index;
308 clib_bihash_add_del_24_8(&table->ip6_hash, &kv, 1);
310 table->dst_address_length_refcounts[len]++;
312 table->non_empty_dst_address_length_bitmap =
313 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
315 compute_prefix_lengths_in_search_order (table);
318 u32 ip6_fib_table_fwding_lookup_with_if_index (ip6_main_t * im,
320 const ip6_address_t * dst)
322 u32 fib_index = vec_elt (im->fib_index_by_sw_if_index, sw_if_index);
323 return ip6_fib_table_fwding_lookup(fib_index, dst);
327 ip6_fib_table_get_index_for_sw_if_index (u32 sw_if_index)
329 if (sw_if_index >= vec_len(ip6_main.fib_index_by_sw_if_index))
332 * This is the case for interfaces that are not yet mapped to
337 return (ip6_main.fib_index_by_sw_if_index[sw_if_index]);
341 ip6_fib_table_fwding_dpo_update (u32 fib_index,
342 const ip6_address_t *addr,
346 ip6_fib_table_instance_t *table;
347 clib_bihash_kv_24_8_t kv;
351 table = &ip6_main.ip6_table[IP6_FIB_TABLE_FWDING];
352 mask = &ip6_main.fib_masks[len];
353 fib = ((u64)((fib_index))<<32);
355 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
356 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
357 kv.key[2] = fib | len;
358 kv.value = dpo->dpoi_index;
360 clib_bihash_add_del_24_8(&table->ip6_hash, &kv, 1);
362 table->dst_address_length_refcounts[len]++;
364 table->non_empty_dst_address_length_bitmap =
365 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
367 compute_prefix_lengths_in_search_order (table);
371 ip6_fib_table_fwding_dpo_remove (u32 fib_index,
372 const ip6_address_t *addr,
376 ip6_fib_table_instance_t *table;
377 clib_bihash_kv_24_8_t kv;
381 table = &ip6_main.ip6_table[IP6_FIB_TABLE_FWDING];
382 mask = &ip6_main.fib_masks[len];
383 fib = ((u64)((fib_index))<<32);
385 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
386 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
387 kv.key[2] = fib | len;
388 kv.value = dpo->dpoi_index;
390 clib_bihash_add_del_24_8(&table->ip6_hash, &kv, 0);
392 /* refcount accounting */
393 ASSERT (table->dst_address_length_refcounts[len] > 0);
394 if (--table->dst_address_length_refcounts[len] == 0)
396 table->non_empty_dst_address_length_bitmap =
397 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
399 compute_prefix_lengths_in_search_order (table);
404 * @brief Context when walking the IPv6 table. Since all VRFs are in the
405 * same hash table, we need to filter only those we need as we walk
407 typedef struct ip6_fib_walk_ctx_t_
410 fib_table_walk_fn_t i6w_fn;
412 fib_prefix_t i6w_root;
413 fib_prefix_t *i6w_sub_trees;
414 } ip6_fib_walk_ctx_t;
417 ip6_fib_walk_cb (clib_bihash_kv_24_8_t * kvp,
420 ip6_fib_walk_ctx_t *ctx = arg;
423 if ((kvp->key[2] >> 32) == ctx->i6w_fib_index)
425 key.as_u64[0] = kvp->key[0];
426 key.as_u64[1] = kvp->key[1];
428 if (ip6_destination_matches_route(&ip6_main,
430 &ctx->i6w_root.fp_addr.ip6,
431 ctx->i6w_root.fp_len))
433 const fib_prefix_t *sub_tree;
437 * exclude sub-trees the walk does not want to explore
439 vec_foreach(sub_tree, ctx->i6w_sub_trees)
441 if (ip6_destination_matches_route(&ip6_main,
443 &sub_tree->fp_addr.ip6,
453 switch (ctx->i6w_fn(kvp->value, ctx->i6w_ctx))
455 case FIB_TABLE_WALK_CONTINUE:
457 case FIB_TABLE_WALK_SUB_TREE_STOP: {
459 .fp_proto = FIB_PROTOCOL_IP6,
460 .fp_len = kvp->key[2] & 0xffffffff,
463 vec_add1(ctx->i6w_sub_trees, pfx);
466 case FIB_TABLE_WALK_STOP:
478 ip6_fib_table_walk (u32 fib_index,
479 fib_table_walk_fn_t fn,
482 ip6_fib_walk_ctx_t ctx = {
483 .i6w_fib_index = fib_index,
487 .fp_proto = FIB_PROTOCOL_IP6,
489 .i6w_sub_trees = NULL,
492 clib_bihash_foreach_key_value_pair_24_8(
493 &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING].ip6_hash,
497 vec_free(ctx.i6w_sub_trees);
501 ip6_fib_table_sub_tree_walk (u32 fib_index,
502 const fib_prefix_t *root,
503 fib_table_walk_fn_t fn,
506 ip6_fib_walk_ctx_t ctx = {
507 .i6w_fib_index = fib_index,
513 clib_bihash_foreach_key_value_pair_24_8(
514 &ip6_main.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;
523 static fib_table_walk_rc_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);
531 return (FIB_TABLE_WALK_CONTINUE);
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));
573 format_ip6_fib_table_memory (u8 * s, va_list * args)
577 bytes_inuse = (alloc_arena_next(&(ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING].ip6_hash)) +
578 alloc_arena_next(&(ip6_main.ip6_table[IP6_FIB_TABLE_FWDING].ip6_hash)));
580 s = format(s, "%=30s %=6d %=12ld\n",
582 pool_elts(ip6_main.fibs),
589 u64 count_by_prefix_length[129];
590 } count_routes_in_fib_at_prefix_length_arg_t;
593 count_routes_in_fib_at_prefix_length (clib_bihash_kv_24_8_t * kvp,
596 count_routes_in_fib_at_prefix_length_arg_t * ap = arg;
599 if ((kvp->key[2]>>32) != ap->fib_index)
600 return (BIHASH_WALK_CONTINUE);
602 mask_width = kvp->key[2] & 0xFF;
604 ap->count_by_prefix_length[mask_width]++;
606 return (BIHASH_WALK_CONTINUE);
609 static clib_error_t *
610 ip6_show_fib (vlib_main_t * vm,
611 unformat_input_t * input,
612 vlib_cli_command_t * cmd)
614 count_routes_in_fib_at_prefix_length_arg_t _ca, *ca = &_ca;
615 ip6_main_t * im6 = &ip6_main;
616 fib_table_t *fib_table;
618 int verbose, matching;
619 ip6_address_t matching_address;
621 int table_id = -1, fib_index = ~0;
628 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
630 if (unformat (input, "brief") ||
631 unformat (input, "summary") ||
632 unformat (input, "sum"))
635 else if (unformat (input, "detail") ||
636 unformat (input, "det"))
639 else if (unformat (input, "hash") ||
640 unformat (input, "mem") ||
641 unformat (input, "memory"))
644 else if (unformat (input, "%U/%d",
645 unformat_ip6_address, &matching_address, &mask_len))
648 else if (unformat (input, "%U", unformat_ip6_address, &matching_address))
651 else if (unformat (input, "table %d", &table_id))
653 else if (unformat (input, "index %d", &fib_index))
661 vlib_cli_output (vm, "IPv6 Non-Forwarding Hash Table:\n%U\n",
663 &im6->ip6_table[IP6_FIB_TABLE_NON_FWDING].ip6_hash,
665 vlib_cli_output (vm, "IPv6 Forwarding Hash Table:\n%U\n",
667 &im6->ip6_table[IP6_FIB_TABLE_FWDING].ip6_hash,
672 pool_foreach (fib_table, im6->fibs,
677 fib = pool_elt_at_index(im6->v6_fibs, fib_table->ft_index);
678 if (table_id >= 0 && table_id != (int)fib->table_id)
680 if (fib_index != ~0 && fib_index != (int)fib->index)
682 if (fib_table->ft_flags & FIB_TABLE_FLAG_IP6_LL)
685 s = format(s, "%U, fib_index:%d, flow hash:[%U] epoch:%d flags:%U locks:[",
686 format_fib_table_name, fib->index,
689 format_ip_flow_hash_config,
690 fib_table->ft_flow_hash_config,
692 format_fib_table_flags, fib_table->ft_flags);
694 vec_foreach_index(source, fib_table->ft_locks)
696 if (0 != fib_table->ft_locks[source])
698 s = format(s, "%U:%d, ",
699 format_fib_source, source,
700 fib_table->ft_locks[source]);
704 vlib_cli_output (vm, "%v", s);
710 clib_bihash_24_8_t * h = &im6->ip6_table[IP6_FIB_TABLE_NON_FWDING].ip6_hash;
713 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
715 clib_memset (ca, 0, sizeof(*ca));
716 ca->fib_index = fib->index;
718 clib_bihash_foreach_key_value_pair_24_8
719 (h, count_routes_in_fib_at_prefix_length, ca);
721 for (len = 128; len >= 0; len--)
723 if (ca->count_by_prefix_length[len])
724 vlib_cli_output (vm, "%=20d%=16lld",
725 len, ca->count_by_prefix_length[len]);
732 ip6_fib_table_show_all(fib, vm);
736 ip6_fib_table_show_one(fib, vm, &matching_address, mask_len, detail);
744 * This command displays the IPv6 FIB Tables (VRF Tables) and the route
745 * entries for each table.
747 * @note This command will run for a long time when the FIB tables are
748 * comprised of millions of entries. For those senarios, consider displaying
753 * Example of how to display all the IPv6 FIB tables:
754 * @cliexstart{show ip6 fib}
755 * ipv6-VRF:0, fib_index 0, flow hash: src dst sport dport proto
758 * [@0]: dpo-load-balance: [index:5 buckets:1 uRPF:5 to:[0:0]]
759 * [0] [@0]: dpo-drop ip6
762 * [@0]: dpo-load-balance: [index:10 buckets:1 uRPF:10 to:[0:0]]
763 * [0] [@2]: dpo-receive
766 * [@0]: dpo-load-balance: [index:8 buckets:1 uRPF:8 to:[0:0]]
767 * [0] [@2]: dpo-receive
770 * [@0]: dpo-load-balance: [index:7 buckets:1 uRPF:7 to:[0:0]]
771 * [0] [@2]: dpo-receive
774 * [@0]: dpo-load-balance: [index:9 buckets:1 uRPF:9 to:[0:0]]
775 * [0] [@2]: dpo-receive
778 * [@0]: dpo-load-balance: [index:6 buckets:1 uRPF:6 to:[0:0]]
779 * [0] [@2]: dpo-receive
780 * ipv6-VRF:8, fib_index 1, flow hash: src dst sport dport proto
783 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
784 * [0] [@0]: dpo-drop ip6
787 * [@0]: dpo-load-balance: [index:27 buckets:1 uRPF:26 to:[0:0]]
788 * [0] [@4]: ipv6-glean: af_packet0
791 * [@0]: dpo-load-balance: [index:28 buckets:1 uRPF:27 to:[0:0]]
792 * [0] [@2]: dpo-receive: @::a:1:1:0:7 on af_packet0
795 * [@0]: dpo-load-balance: [index:26 buckets:1 uRPF:25 to:[0:0]]
796 * [0] [@2]: dpo-receive
797 * fe80::fe:3eff:fe3e:9222/128
799 * [@0]: dpo-load-balance: [index:29 buckets:1 uRPF:28 to:[0:0]]
800 * [0] [@2]: dpo-receive: fe80::fe:3eff:fe3e:9222 on af_packet0
803 * [@0]: dpo-load-balance: [index:24 buckets:1 uRPF:23 to:[0:0]]
804 * [0] [@2]: dpo-receive
807 * [@0]: dpo-load-balance: [index:23 buckets:1 uRPF:22 to:[0:0]]
808 * [0] [@2]: dpo-receive
811 * [@0]: dpo-load-balance: [index:25 buckets:1 uRPF:24 to:[0:0]]
812 * [0] [@2]: dpo-receive
815 * [@0]: dpo-load-balance: [index:22 buckets:1 uRPF:21 to:[0:0]]
816 * [0] [@2]: dpo-receive
819 * Example of how to display a summary of all IPv6 FIB tables:
820 * @cliexstart{show ip6 fib summary}
821 * ipv6-VRF:0, fib_index 0, flow hash: src dst sport dport proto
822 * Prefix length Count
827 * ipv6-VRF:8, fib_index 1, flow hash: src dst sport dport proto
828 * Prefix length Count
838 VLIB_CLI_COMMAND (ip6_show_fib_command, static) = {
839 .path = "show ip6 fib",
840 .short_help = "show ip6 fib [summary] [table <table-id>] [index <fib-id>] [<ip6-addr>[/<width>]] [detail]",
841 .function = ip6_show_fib,