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,
42 * all link local for us
44 pfx.fp_addr.ip6.as_u64[0] = clib_host_to_net_u64 (0xFE80000000000000ULL);
45 pfx.fp_addr.ip6.as_u64[1] = 0;
47 fib_table_entry_special_add(fib_index,
55 create_fib_with_table_id (u32 table_id)
57 fib_table_t *fib_table;
59 pool_get_aligned(ip6_main.fibs, fib_table, CLIB_CACHE_LINE_BYTES);
60 memset(fib_table, 0, sizeof(*fib_table));
62 fib_table->ft_proto = FIB_PROTOCOL_IP6;
65 (fib_table - ip6_main.fibs);
67 hash_set(ip6_main.fib_index_by_table_id, table_id, fib_table->ft_index);
69 fib_table->ft_table_id =
70 fib_table->v6.table_id =
72 fib_table->ft_flow_hash_config =
73 fib_table->v6.flow_hash_config =
76 vnet_ip6_fib_init(fib_table->ft_index);
77 fib_table_lock(fib_table->ft_index, FIB_PROTOCOL_IP6);
79 return (fib_table->ft_index);
83 ip6_fib_table_find_or_create_and_lock (u32 table_id)
87 p = hash_get (ip6_main.fib_index_by_table_id, table_id);
89 return create_fib_with_table_id(table_id);
91 fib_table_lock(p[0], FIB_PROTOCOL_IP6);
97 ip6_fib_table_create_and_lock (void)
99 return (create_fib_with_table_id(~0));
103 ip6_fib_table_destroy (u32 fib_index)
106 .fp_proto = FIB_PROTOCOL_IP6,
118 fib_table_entry_special_remove(fib_index,
120 FIB_SOURCE_DEFAULT_ROUTE);
126 ip6_set_solicited_node_multicast_address(&pfx.fp_addr.ip6, 0);
128 fib_table_entry_special_remove(fib_index,
133 * all-routers multicast address
135 ip6_set_reserved_multicast_address (&pfx.fp_addr.ip6,
136 IP6_MULTICAST_SCOPE_link_local,
137 IP6_MULTICAST_GROUP_ID_all_routers);
139 fib_table_entry_special_remove(fib_index,
144 * all-nodes multicast address
146 ip6_set_reserved_multicast_address (&pfx.fp_addr.ip6,
147 IP6_MULTICAST_SCOPE_link_local,
148 IP6_MULTICAST_GROUP_ID_all_hosts);
150 fib_table_entry_special_remove(fib_index,
155 * all-mldv2 multicast address
157 ip6_set_reserved_multicast_address (&pfx.fp_addr.ip6,
158 IP6_MULTICAST_SCOPE_link_local,
159 IP6_MULTICAST_GROUP_ID_mldv2_routers);
161 fib_table_entry_special_remove(fib_index,
168 pfx.fp_addr.ip6.as_u64[0] = clib_host_to_net_u64 (0xFE80000000000000ULL);
169 pfx.fp_addr.ip6.as_u64[1] = 0;
171 fib_table_entry_special_remove(fib_index,
175 fib_table_t *fib_table = fib_table_get(fib_index, FIB_PROTOCOL_IP6);
179 * validate no more routes.
181 ASSERT(0 == fib_table->ft_total_route_counts);
182 FOR_EACH_FIB_SOURCE(source)
184 ASSERT(0 == fib_table->ft_src_route_counts[source]);
187 if (~0 != fib_table->ft_table_id)
189 hash_unset (ip6_main.fib_index_by_table_id, fib_table->ft_table_id);
191 pool_put(ip6_main.fibs, fib_table);
195 ip6_fib_table_lookup (u32 fib_index,
196 const ip6_address_t *addr,
199 const ip6_fib_table_instance_t *table;
200 BVT(clib_bihash_kv) kv, value;
204 table = &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING];
205 n_p = vec_len (table->prefix_lengths_in_search_order);
207 kv.key[0] = addr->as_u64[0];
208 kv.key[1] = addr->as_u64[1];
209 fib = ((u64)((fib_index))<<32);
212 * start search from a mask length same length or shorter.
213 * we don't want matches longer than the mask passed
216 while (i < n_p && table->prefix_lengths_in_search_order[i] > len)
223 int dst_address_length = table->prefix_lengths_in_search_order[i];
224 ip6_address_t * mask = &ip6_main.fib_masks[dst_address_length];
226 ASSERT(dst_address_length >= 0 && dst_address_length <= 128);
227 //As lengths are decreasing, masks are increasingly specific.
228 kv.key[0] &= mask->as_u64[0];
229 kv.key[1] &= mask->as_u64[1];
230 kv.key[2] = fib | dst_address_length;
232 rv = BV(clib_bihash_search_inline_2)(&table->ip6_hash, &kv, &value);
237 return (FIB_NODE_INDEX_INVALID);
241 ip6_fib_table_lookup_exact_match (u32 fib_index,
242 const ip6_address_t *addr,
245 const ip6_fib_table_instance_t *table;
246 BVT(clib_bihash_kv) kv, value;
251 table = &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING];
252 mask = &ip6_main.fib_masks[len];
253 fib = ((u64)((fib_index))<<32);
255 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
256 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
257 kv.key[2] = fib | len;
259 rv = BV(clib_bihash_search_inline_2)(&table->ip6_hash, &kv, &value);
263 return (FIB_NODE_INDEX_INVALID);
267 compute_prefix_lengths_in_search_order (ip6_fib_table_instance_t *table)
270 vec_reset_length (table->prefix_lengths_in_search_order);
271 /* Note: bitmap reversed so this is in fact a longest prefix match */
272 clib_bitmap_foreach (i, table->non_empty_dst_address_length_bitmap,
274 int dst_address_length = 128 - i;
275 vec_add1(table->prefix_lengths_in_search_order, dst_address_length);
280 ip6_fib_table_entry_remove (u32 fib_index,
281 const ip6_address_t *addr,
284 ip6_fib_table_instance_t *table;
285 BVT(clib_bihash_kv) kv;
289 table = &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING];
290 mask = &ip6_main.fib_masks[len];
291 fib = ((u64)((fib_index))<<32);
293 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
294 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
295 kv.key[2] = fib | len;
297 BV(clib_bihash_add_del)(&table->ip6_hash, &kv, 0);
299 /* refcount accounting */
300 ASSERT (table->dst_address_length_refcounts[len] > 0);
301 if (--table->dst_address_length_refcounts[len] == 0)
303 table->non_empty_dst_address_length_bitmap =
304 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
306 compute_prefix_lengths_in_search_order (table);
311 ip6_fib_table_entry_insert (u32 fib_index,
312 const ip6_address_t *addr,
314 fib_node_index_t fib_entry_index)
316 ip6_fib_table_instance_t *table;
317 BVT(clib_bihash_kv) kv;
321 table = &ip6_main.ip6_table[IP6_FIB_TABLE_NON_FWDING];
322 mask = &ip6_main.fib_masks[len];
323 fib = ((u64)((fib_index))<<32);
325 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
326 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
327 kv.key[2] = fib | len;
328 kv.value = fib_entry_index;
330 BV(clib_bihash_add_del)(&table->ip6_hash, &kv, 1);
332 table->dst_address_length_refcounts[len]++;
334 table->non_empty_dst_address_length_bitmap =
335 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
337 compute_prefix_lengths_in_search_order (table);
341 ip6_fib_table_fwding_lookup (ip6_main_t * im,
343 const ip6_address_t * dst)
345 const ip6_fib_table_instance_t *table;
348 BVT(clib_bihash_kv) kv, value;
351 table = &ip6_main.ip6_table[IP6_FIB_TABLE_FWDING];
352 len = vec_len (table->prefix_lengths_in_search_order);
354 kv.key[0] = dst->as_u64[0];
355 kv.key[1] = dst->as_u64[1];
356 fib = ((u64)((fib_index))<<32);
358 for (i = 0; i < len; i++)
360 int dst_address_length = table->prefix_lengths_in_search_order[i];
361 ip6_address_t * mask = &ip6_main.fib_masks[dst_address_length];
363 ASSERT(dst_address_length >= 0 && dst_address_length <= 128);
364 //As lengths are decreasing, masks are increasingly specific.
365 kv.key[0] &= mask->as_u64[0];
366 kv.key[1] &= mask->as_u64[1];
367 kv.key[2] = fib | dst_address_length;
369 rv = BV(clib_bihash_search_inline_2)(&table->ip6_hash, &kv, &value);
374 /* default route is always present */
379 u32 ip6_fib_table_fwding_lookup_with_if_index (ip6_main_t * im,
381 const ip6_address_t * dst)
383 u32 fib_index = vec_elt (im->fib_index_by_sw_if_index, sw_if_index);
384 return ip6_fib_table_fwding_lookup(im, fib_index, dst);
388 ip6_fib_table_get_flow_hash_config (u32 fib_index)
390 return (ip6_fib_get(fib_index)->flow_hash_config);
394 ip6_fib_table_get_index_for_sw_if_index (u32 sw_if_index)
396 if (sw_if_index >= vec_len(ip6_main.fib_index_by_sw_if_index))
399 * This is the case for interfaces that are not yet mapped to
404 return (ip6_main.fib_index_by_sw_if_index[sw_if_index]);
408 ip6_fib_table_fwding_dpo_update (u32 fib_index,
409 const ip6_address_t *addr,
413 ip6_fib_table_instance_t *table;
414 BVT(clib_bihash_kv) kv;
418 table = &ip6_main.ip6_table[IP6_FIB_TABLE_FWDING];
419 mask = &ip6_main.fib_masks[len];
420 fib = ((u64)((fib_index))<<32);
422 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
423 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
424 kv.key[2] = fib | len;
425 kv.value = dpo->dpoi_index;
427 BV(clib_bihash_add_del)(&table->ip6_hash, &kv, 1);
429 table->dst_address_length_refcounts[len]++;
431 table->non_empty_dst_address_length_bitmap =
432 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
434 compute_prefix_lengths_in_search_order (table);
438 ip6_fib_table_fwding_dpo_remove (u32 fib_index,
439 const ip6_address_t *addr,
443 ip6_fib_table_instance_t *table;
444 BVT(clib_bihash_kv) kv;
448 table = &ip6_main.ip6_table[IP6_FIB_TABLE_FWDING];
449 mask = &ip6_main.fib_masks[len];
450 fib = ((u64)((fib_index))<<32);
452 kv.key[0] = addr->as_u64[0] & mask->as_u64[0];
453 kv.key[1] = addr->as_u64[1] & mask->as_u64[1];
454 kv.key[2] = fib | len;
455 kv.value = dpo->dpoi_index;
457 BV(clib_bihash_add_del)(&table->ip6_hash, &kv, 0);
459 /* refcount accounting */
460 ASSERT (table->dst_address_length_refcounts[len] > 0);
461 if (--table->dst_address_length_refcounts[len] == 0)
463 table->non_empty_dst_address_length_bitmap =
464 clib_bitmap_set (table->non_empty_dst_address_length_bitmap,
466 compute_prefix_lengths_in_search_order (table);
471 * @brief Context when walking the IPv6 table. Since all VRFs are in the
472 * same hash table, we need to filter only those we need as we walk
474 typedef struct ip6_fib_walk_ctx_t_
477 fib_table_walk_fn_t i6w_fn;
479 } ip6_fib_walk_ctx_t;
482 ip6_fib_walk_cb (clib_bihash_kv_24_8_t * kvp,
485 ip6_fib_walk_ctx_t *ctx = arg;
487 if ((kvp->key[2] >> 32) == ctx->i6w_fib_index)
489 ctx->i6w_fn(kvp->value, ctx->i6w_ctx);
496 ip6_fib_table_walk (u32 fib_index,
497 fib_table_walk_fn_t fn,
500 ip6_fib_walk_ctx_t ctx = {
501 .i6w_fib_index = fib_index,
505 ip6_main_t *im = &ip6_main;
507 BV(clib_bihash_foreach_key_value_pair)(&im->ip6_table[IP6_FIB_TABLE_NON_FWDING].ip6_hash,
513 typedef struct ip6_fib_show_ctx_t_ {
514 fib_node_index_t *entries;
515 } ip6_fib_show_ctx_t;
518 ip6_fib_table_show_walk (fib_node_index_t fib_entry_index,
521 ip6_fib_show_ctx_t *ctx = arg;
523 vec_add1(ctx->entries, fib_entry_index);
529 ip6_fib_table_show_all (ip6_fib_t *fib,
532 fib_node_index_t *fib_entry_index;
533 ip6_fib_show_ctx_t ctx = {
537 ip6_fib_table_walk(fib->index, ip6_fib_table_show_walk, &ctx);
538 vec_sort_with_function(ctx.entries, fib_entry_cmp_for_sort);
540 vec_foreach(fib_entry_index, ctx.entries)
542 vlib_cli_output(vm, "%U",
545 FIB_ENTRY_FORMAT_BRIEF);
548 vec_free(ctx.entries);
552 ip6_fib_table_show_one (ip6_fib_t *fib,
554 ip6_address_t *address,
557 vlib_cli_output(vm, "%U",
559 ip6_fib_table_lookup(fib->index, address, mask_len),
560 FIB_ENTRY_FORMAT_DETAIL);
565 u64 count_by_prefix_length[129];
566 } count_routes_in_fib_at_prefix_length_arg_t;
568 static void count_routes_in_fib_at_prefix_length
569 (BVT(clib_bihash_kv) * kvp, void *arg)
571 count_routes_in_fib_at_prefix_length_arg_t * ap = arg;
574 if ((kvp->key[2]>>32) != ap->fib_index)
577 mask_width = kvp->key[2] & 0xFF;
579 ap->count_by_prefix_length[mask_width]++;
582 static clib_error_t *
583 ip6_show_fib (vlib_main_t * vm,
584 unformat_input_t * input,
585 vlib_cli_command_t * cmd)
587 count_routes_in_fib_at_prefix_length_arg_t _ca, *ca = &_ca;
588 ip6_main_t * im6 = &ip6_main;
589 fib_table_t *fib_table;
591 int verbose, matching;
592 ip6_address_t matching_address;
594 int table_id = -1, fib_index = ~0;
599 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
601 if (unformat (input, "brief") ||
602 unformat (input, "summary") ||
603 unformat (input, "sum"))
606 else if (unformat (input, "%U/%d",
607 unformat_ip6_address, &matching_address, &mask_len))
610 else if (unformat (input, "%U", unformat_ip6_address, &matching_address))
613 else if (unformat (input, "table %d", &table_id))
615 else if (unformat (input, "index %d", &fib_index))
621 pool_foreach (fib_table, im6->fibs,
623 fib = &(fib_table->v6);
624 if (table_id >= 0 && table_id != (int)fib->table_id)
626 if (fib_index != ~0 && fib_index != (int)fib->index)
629 vlib_cli_output (vm, "%s, fib_index %d, flow hash: %U",
630 fib_table->ft_desc, fib->index,
631 format_ip_flow_hash_config, fib->flow_hash_config);
636 BVT(clib_bihash) * h = &im6->ip6_table[IP6_FIB_TABLE_NON_FWDING].ip6_hash;
639 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
641 memset (ca, 0, sizeof(*ca));
642 ca->fib_index = fib->index;
644 BV(clib_bihash_foreach_key_value_pair)
645 (h, count_routes_in_fib_at_prefix_length, ca);
647 for (len = 128; len >= 0; len--)
649 if (ca->count_by_prefix_length[len])
650 vlib_cli_output (vm, "%=20d%=16lld",
651 len, ca->count_by_prefix_length[len]);
658 ip6_fib_table_show_all(fib, vm);
662 ip6_fib_table_show_one(fib, vm, &matching_address, mask_len);
670 * This command displays the IPv6 FIB Tables (VRF Tables) and the route
671 * entries for each table.
673 * @note This command will run for a long time when the FIB tables are
674 * comprised of millions of entries. For those senarios, consider displaying
679 * Example of how to display all the IPv6 FIB tables:
680 * @cliexstart{show ip6 fib}
681 * ipv6-VRF:0, fib_index 0, flow hash: src dst sport dport proto
684 * [@0]: dpo-load-balance: [index:5 buckets:1 uRPF:5 to:[0:0]]
685 * [0] [@0]: dpo-drop ip6
688 * [@0]: dpo-load-balance: [index:10 buckets:1 uRPF:10 to:[0:0]]
689 * [0] [@2]: dpo-receive
692 * [@0]: dpo-load-balance: [index:8 buckets:1 uRPF:8 to:[0:0]]
693 * [0] [@2]: dpo-receive
696 * [@0]: dpo-load-balance: [index:7 buckets:1 uRPF:7 to:[0:0]]
697 * [0] [@2]: dpo-receive
700 * [@0]: dpo-load-balance: [index:9 buckets:1 uRPF:9 to:[0:0]]
701 * [0] [@2]: dpo-receive
704 * [@0]: dpo-load-balance: [index:6 buckets:1 uRPF:6 to:[0:0]]
705 * [0] [@2]: dpo-receive
706 * ipv6-VRF:8, fib_index 1, flow hash: src dst sport dport proto
709 * [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]
710 * [0] [@0]: dpo-drop ip6
713 * [@0]: dpo-load-balance: [index:27 buckets:1 uRPF:26 to:[0:0]]
714 * [0] [@4]: ipv6-glean: af_packet0
717 * [@0]: dpo-load-balance: [index:28 buckets:1 uRPF:27 to:[0:0]]
718 * [0] [@2]: dpo-receive: @::a:1:1:0:7 on af_packet0
721 * [@0]: dpo-load-balance: [index:26 buckets:1 uRPF:25 to:[0:0]]
722 * [0] [@2]: dpo-receive
723 * fe80::fe:3eff:fe3e:9222/128
725 * [@0]: dpo-load-balance: [index:29 buckets:1 uRPF:28 to:[0:0]]
726 * [0] [@2]: dpo-receive: fe80::fe:3eff:fe3e:9222 on af_packet0
729 * [@0]: dpo-load-balance: [index:24 buckets:1 uRPF:23 to:[0:0]]
730 * [0] [@2]: dpo-receive
733 * [@0]: dpo-load-balance: [index:23 buckets:1 uRPF:22 to:[0:0]]
734 * [0] [@2]: dpo-receive
737 * [@0]: dpo-load-balance: [index:25 buckets:1 uRPF:24 to:[0:0]]
738 * [0] [@2]: dpo-receive
741 * [@0]: dpo-load-balance: [index:22 buckets:1 uRPF:21 to:[0:0]]
742 * [0] [@2]: dpo-receive
745 * Example of how to display a summary of all IPv6 FIB tables:
746 * @cliexstart{show ip6 fib summary}
747 * ipv6-VRF:0, fib_index 0, flow hash: src dst sport dport proto
748 * Prefix length Count
753 * ipv6-VRF:8, fib_index 1, flow hash: src dst sport dport proto
754 * Prefix length Count
764 VLIB_CLI_COMMAND (ip6_show_fib_command, static) = {
765 .path = "show ip6 fib",
766 .short_help = "show ip6 fib [summary] [table <table-id>] [index <fib-id>] [<ip6-addr>[/<width>]]",
767 .function = ip6_show_fib,