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 <vppinfra/mhash.h>
17 #include <vnet/ip/ip.h>
18 #include <vnet/adj/adj.h>
19 #include <vnet/dpo/load_balance.h>
20 #include <vnet/dpo/load_balance_map.h>
22 #include <vnet/fib/fib_path_list.h>
23 #include <vnet/fib/fib_internal.h>
24 #include <vnet/fib/fib_node_list.h>
25 #include <vnet/fib/fib_walk.h>
26 #include <vnet/fib/fib_urpf_list.h>
27 #include <vnet/fib/fib_path_ext.h>
28 #include <vnet/fib/fib_table.h>
31 * The magic number of child entries that make a path-list popular.
32 * There's a trade-off here between convergnece and forwarding speed.
33 * Popular path-lists generate load-balance maps for the entries that
34 * use them. If the map is present there is a switch path cost to indirect
35 * through the map - this indirection provides the fast convergence - so
36 * without the map convergence is slower.
38 #define FIB_PATH_LIST_POPULAR 64
42 * A representation of the list/set of path trough which a prefix is reachable
44 typedef struct fib_path_list_t_ {
46 * A path-list is a node in the FIB graph.
51 * Flags on the path-list
53 fib_path_list_flags_t fpl_flags;
56 * Vector of paths indicies for all configured paths.
57 * For shareable path-lists this list MUST not change.
59 fib_node_index_t *fpl_paths;
62 * the RPF list calculated for this path list
64 fib_node_index_t fpl_urpf;
67 * Hash table of paths. valid only with INDEXED flag
73 * Array of strings/names for the FIB sources
75 static const char *fib_path_list_attr_names[] = FIB_PATH_LIST_ATTRIBUTES;
78 * The memory pool from which we allocate all the path-lists
80 static fib_path_list_t * fib_path_list_pool;
83 * The data-base of shared path-lists
85 static uword *fib_path_list_db;
90 vlib_log_class_t fib_path_list_logger;
95 #define FIB_PATH_LIST_DBG(_pl, _fmt, _args...) \
97 vlib_log_debug(fib_path_list_logger, \
99 format_fib_path_list, \
100 fib_path_list_get_index(_pl), 0, \
104 static fib_path_list_t *
105 fib_path_list_get (fib_node_index_t index)
107 return (pool_elt_at_index(fib_path_list_pool, index));
111 fib_path_list_get_node (fib_node_index_t index)
113 return ((fib_node_t*)fib_path_list_get(index));
116 static fib_path_list_t*
117 fib_path_list_from_fib_node (fib_node_t *node)
119 ASSERT(FIB_NODE_TYPE_PATH_LIST == node->fn_type);
120 return ((fib_path_list_t*)node);
123 static fib_node_index_t
124 fib_path_list_get_index (fib_path_list_t *path_list)
126 return (path_list - fib_path_list_pool);
130 format_fib_path_list (u8 * s, va_list * args)
132 fib_node_index_t *path_index, path_list_index;
133 fib_path_list_attribute_t attr;
134 fib_path_list_t *path_list;
137 path_list_index = va_arg (*args, fib_node_index_t);
138 indent = va_arg (*args, u32);
139 path_list = fib_path_list_get(path_list_index);
141 s = format (s, "%Upath-list:[%d]",
142 format_white_space, indent,
143 fib_path_list_get_index(path_list));
144 s = format (s, " locks:%u", path_list->fpl_node.fn_locks);
146 if (FIB_PATH_LIST_FLAG_NONE != path_list->fpl_flags)
148 s = format (s, " flags:");
149 FOR_EACH_PATH_LIST_ATTRIBUTE(attr)
151 if ((1<<attr) & path_list->fpl_flags)
153 s = format (s, "%s,", fib_path_list_attr_names[attr]);
157 s = format (s, " %U\n", format_fib_urpf_list, path_list->fpl_urpf);
159 vec_foreach (path_index, path_list->fpl_paths)
161 s = format(s, "%U", format_fib_path, *path_index, indent+2,
162 FIB_PATH_FORMAT_FLAGS_NONE);
170 fib_path_list_format (fib_node_index_t path_list_index,
173 return (format(s, "%U", format_fib_path_list, path_list_index, 4));
177 fib_path_list_hash (fib_path_list_t *path_list)
179 uword old_path_list_hash, new_path_list_hash, path_hash;
180 fib_node_index_t *path_index;
184 new_path_list_hash = old_path_list_hash = vec_len(path_list->fpl_paths);
186 vec_foreach (path_index, path_list->fpl_paths)
188 path_hash = fib_path_hash(*path_index);
190 hash_mix64(path_hash, old_path_list_hash, new_path_list_hash);
192 hash_mix32(path_hash, old_path_list_hash, new_path_list_hash);
196 return (new_path_list_hash);
200 fib_path_list_db_hash_key_from_index (uword index)
206 fib_path_list_db_hash_key_is_index (uword key)
212 fib_path_list_db_hash_key_2_index (uword key)
214 ASSERT (fib_path_list_db_hash_key_is_index (key));
218 static fib_path_list_t*
219 fib_path_list_db_get_from_hash_key (uword key)
221 fib_path_list_t *path_list;
223 if (fib_path_list_db_hash_key_is_index (key))
225 fib_node_index_t path_list_index;
227 path_list_index = fib_path_list_db_hash_key_2_index(key);
228 path_list = fib_path_list_get(path_list_index);
232 path_list = uword_to_pointer (key, fib_path_list_t *);
239 fib_path_list_db_hash_key_sum (hash_t * h,
242 fib_path_list_t *path_list;
244 path_list = fib_path_list_db_get_from_hash_key(key);
246 return (fib_path_list_hash(path_list));
250 fib_path_list_db_hash_key_equal (hash_t * h,
254 fib_path_list_t *path_list1, *path_list2;
256 path_list1 = fib_path_list_db_get_from_hash_key(key1);
257 path_list2 = fib_path_list_db_get_from_hash_key(key2);
259 return (fib_path_list_hash(path_list1) ==
260 fib_path_list_hash(path_list2));
263 static fib_node_index_t
264 fib_path_list_db_find (fib_path_list_t *path_list)
268 p = hash_get(fib_path_list_db, path_list);
275 return (FIB_NODE_INDEX_INVALID);
279 fib_path_list_db_insert (fib_node_index_t path_list_index)
281 fib_path_list_t *path_list;
283 path_list = fib_path_list_get(path_list_index);
285 ASSERT(FIB_NODE_INDEX_INVALID == fib_path_list_db_find(path_list));
287 hash_set (fib_path_list_db,
288 fib_path_list_db_hash_key_from_index(path_list_index),
291 FIB_PATH_LIST_DBG(path_list, "DB-inserted");
295 fib_path_list_db_remove (fib_node_index_t path_list_index)
297 fib_path_list_t *path_list;
299 path_list = fib_path_list_get(path_list_index);
301 ASSERT(FIB_NODE_INDEX_INVALID != fib_path_list_db_find(path_list));
303 hash_unset(fib_path_list_db,
304 fib_path_list_db_hash_key_from_index(path_list_index));
306 FIB_PATH_LIST_DBG(path_list, "DB-removed");
310 fib_path_list_destroy (fib_path_list_t *path_list)
312 fib_node_index_t *path_index;
314 FIB_PATH_LIST_DBG(path_list, "destroy");
316 vec_foreach (path_index, path_list->fpl_paths)
318 fib_path_destroy(*path_index);
321 vec_free(path_list->fpl_paths);
322 fib_urpf_list_unlock(path_list->fpl_urpf);
324 fib_node_deinit(&path_list->fpl_node);
325 pool_put(fib_path_list_pool, path_list);
329 fib_path_list_last_lock_gone (fib_node_t *node)
331 fib_path_list_t *path_list;
333 path_list = fib_path_list_from_fib_node(node);
335 FIB_PATH_LIST_DBG(path_list, "last-lock");
337 if (path_list->fpl_flags & FIB_PATH_LIST_FLAG_SHARED)
339 fib_path_list_db_remove(fib_path_list_get_index(path_list));
341 fib_path_list_destroy(path_list);
344 static load_balance_flags_t
345 fib_path_list_fwd_flags_2_load_balance (fib_path_list_fwd_flags_t pl_flags)
347 load_balance_flags_t lb_flags = LOAD_BALANCE_FLAG_NONE;
349 if (pl_flags & FIB_PATH_LIST_FWD_FLAG_STICKY)
351 lb_flags |= LOAD_BALANCE_ATTR_STICKY;
359 * update the multipath adj this path-list will contribute to its
360 * children's forwarding.
363 fib_path_list_mk_lb (fib_path_list_t *path_list,
364 fib_forward_chain_type_t fct,
366 fib_path_list_fwd_flags_t flags)
368 fib_node_index_t *path_index;
369 load_balance_path_t *nhs;
373 dproto = fib_forw_chain_type_to_dpo_proto(fct);
376 * We gather the DPOs from resolved paths.
378 vec_foreach (path_index, path_list->fpl_paths)
380 if ((flags & FIB_PATH_LIST_FWD_FLAG_STICKY) ||
381 fib_path_is_resolved(*path_index))
383 nhs = fib_path_append_nh_for_multipath_hash(*path_index,
389 * Path-list load-balances, which if used, would be shared and hence
390 * never need a load-balance map.
395 load_balance_create(vec_len(nhs),
397 load_balance_get_default_flow_hash(dproto)));
398 load_balance_multipath_update(dpo, nhs,
399 fib_path_list_fwd_flags_2_load_balance(flags));
401 FIB_PATH_LIST_DBG(path_list, "mk lb: %d", dpo->dpoi_index);
407 * @brief [re]build the path list's uRPF list
410 fib_path_list_mk_urpf (fib_path_list_t *path_list)
412 fib_node_index_t *path_index;
415 * ditch the old one. by iterating through all paths we are going
416 * to re-find all the adjs that were in the old one anyway. If we
417 * keep the old one, then the |sort|uniq requires more work.
418 * All users of the RPF list have their own lock, so we can release
421 fib_urpf_list_unlock(path_list->fpl_urpf);
422 path_list->fpl_urpf = fib_urpf_list_alloc_and_lock();
424 vec_foreach (path_index, path_list->fpl_paths)
426 fib_path_contribute_urpf(*path_index, path_list->fpl_urpf);
429 fib_urpf_list_bake(path_list->fpl_urpf);
433 * @brief Contribute (add) this path list's uRPF list. This allows the child
434 * to construct an aggregate list.
437 fib_path_list_contribute_urpf (fib_node_index_t path_list_index,
440 fib_path_list_t *path_list;
442 path_list = fib_path_list_get(path_list_index);
444 fib_urpf_list_combine(urpf, path_list->fpl_urpf);
448 * @brief Return the the child the RPF list pre-built for this path list
451 fib_path_list_get_urpf (fib_node_index_t path_list_index)
453 fib_path_list_t *path_list;
455 path_list = fib_path_list_get(path_list_index);
457 return (path_list->fpl_urpf);
461 * fib_path_list_back_walk
463 * Called from one of this path-list's paths to progate
467 fib_path_list_back_walk (fib_node_index_t path_list_index,
468 fib_node_back_walk_ctx_t *ctx)
470 fib_path_list_t *path_list;
472 path_list = fib_path_list_get(path_list_index);
474 fib_path_list_mk_urpf(path_list);
476 FIB_PATH_LIST_DBG(path_list, "bw:%U",
477 format_fib_node_bw_reason, ctx->fnbw_reason);
480 * propagate the backwalk further
482 if (path_list->fpl_flags & FIB_PATH_LIST_FLAG_POPULAR)
485 * many children. schedule a async walk
487 fib_walk_async(FIB_NODE_TYPE_PATH_LIST,
489 FIB_WALK_PRIORITY_LOW,
495 * only a few children. continue the walk synchronously
497 fib_walk_sync(FIB_NODE_TYPE_PATH_LIST, path_list_index, ctx);
502 * fib_path_list_back_walk_notify
504 * A back walk has reach this path-list.
506 static fib_node_back_walk_rc_t
507 fib_path_list_back_walk_notify (fib_node_t *node,
508 fib_node_back_walk_ctx_t *ctx)
511 * the path-list is not a direct child of any other node type
512 * paths, which do not change thier to-list-mapping, save the
513 * list they are a member of, and invoke the BW function directly.
517 return (FIB_NODE_BACK_WALK_CONTINUE);
521 * Display the path-list memory usage
524 fib_path_list_memory_show (void)
526 fib_show_memory_usage("Path-list",
527 pool_elts(fib_path_list_pool),
528 pool_len(fib_path_list_pool),
529 sizeof(fib_path_list_t));
530 fib_urpf_list_show_mem();
534 * The FIB path-list's graph node virtual function table
536 static const fib_node_vft_t fib_path_list_vft = {
537 .fnv_get = fib_path_list_get_node,
538 .fnv_last_lock = fib_path_list_last_lock_gone,
539 .fnv_back_walk = fib_path_list_back_walk_notify,
540 .fnv_mem_show = fib_path_list_memory_show,
543 static inline fib_path_list_t *
544 fib_path_list_alloc (fib_node_index_t *path_list_index)
546 fib_path_list_t *path_list;
548 pool_get(fib_path_list_pool, path_list);
549 clib_memset(path_list, 0, sizeof(*path_list));
551 fib_node_init(&path_list->fpl_node,
552 FIB_NODE_TYPE_PATH_LIST);
553 path_list->fpl_urpf = INDEX_INVALID;
554 path_list->fpl_paths = NULL;
556 *path_list_index = fib_path_list_get_index(path_list);
558 FIB_PATH_LIST_DBG(path_list, "alloc");
563 static fib_path_list_t *
564 fib_path_list_resolve (fib_path_list_t *path_list)
566 fib_node_index_t *path_index, *paths, path_list_index;
568 ASSERT(!(path_list->fpl_flags & FIB_PATH_LIST_FLAG_RESOLVED));
571 * resolving a path-list is a recursive action. this means more path
572 * lists can be created during this call, and hence this path-list
573 * can be realloc'd. so we work with copies.
574 * this function is called only once per-path list, so its no great overhead.
576 path_list_index = fib_path_list_get_index(path_list);
577 paths = vec_dup(path_list->fpl_paths);
579 vec_foreach (path_index, paths)
581 fib_path_resolve(*path_index);
585 path_list = fib_path_list_get(path_list_index);
587 FIB_PATH_LIST_DBG(path_list, "resovled");
589 if (!(path_list->fpl_flags & FIB_PATH_LIST_FLAG_NO_URPF))
591 fib_path_list_mk_urpf(path_list);
597 fib_path_list_get_n_paths (fib_node_index_t path_list_index)
599 fib_path_list_t *path_list;
601 if (FIB_NODE_INDEX_INVALID == path_list_index)
606 path_list = fib_path_list_get(path_list_index);
608 return (vec_len(path_list->fpl_paths));
613 fib_path_list_get_resolving_interface (fib_node_index_t path_list_index)
615 fib_node_index_t *path_index;
616 fib_path_list_t *path_list;
619 path_list = fib_path_list_get(path_list_index);
622 vec_foreach (path_index, path_list->fpl_paths)
624 sw_if_index = fib_path_get_resolving_interface(*path_index);
625 if (~0 != sw_if_index)
627 return (sw_if_index);
631 return (sw_if_index);
635 fib_path_list_get_proto (fib_node_index_t path_list_index)
637 fib_path_list_t *path_list;
639 path_list = fib_path_list_get(path_list_index);
642 * we don't support a mix of path protocols, so we can return the proto
645 return (fib_path_get_proto(path_list->fpl_paths[0]));
649 fib_path_list_is_looped (fib_node_index_t path_list_index)
651 fib_path_list_t *path_list;
653 path_list = fib_path_list_get(path_list_index);
655 return (path_list->fpl_flags & FIB_PATH_LIST_FLAG_LOOPED);
659 fib_path_list_is_popular (fib_node_index_t path_list_index)
661 fib_path_list_t *path_list;
663 path_list = fib_path_list_get(path_list_index);
665 return (path_list->fpl_flags & FIB_PATH_LIST_FLAG_POPULAR);
668 static fib_path_list_flags_t
669 fib_path_list_flags_fixup (fib_path_list_flags_t flags)
672 * we do no share drop nor exclusive path-lists
674 if (flags & FIB_PATH_LIST_FLAG_DROP ||
675 flags & FIB_PATH_LIST_FLAG_EXCLUSIVE)
677 flags &= ~FIB_PATH_LIST_FLAG_SHARED;
684 fib_path_list_create (fib_path_list_flags_t flags,
685 const fib_route_path_t *rpaths)
687 fib_node_index_t path_list_index, old_path_list_index;
688 fib_path_list_t *path_list;
691 flags = fib_path_list_flags_fixup(flags);
692 path_list = fib_path_list_alloc(&path_list_index);
693 path_list->fpl_flags = flags;
697 vec_foreach_index(i, rpaths)
699 vec_add1(path_list->fpl_paths,
700 fib_path_create(path_list_index,
704 * we sort the paths since the key for the path-list is
705 * the description of the paths it contains. The paths need to
706 * be sorted else this description will differ.
708 if (vec_len(path_list->fpl_paths) > 1)
710 vec_sort_with_function(path_list->fpl_paths,
711 fib_path_cmp_for_sort);
716 * If a shared path list is requested, consult the DB for a match
718 if (flags & FIB_PATH_LIST_FLAG_SHARED)
721 * check for a matching path-list in the DB.
722 * If we find one then we can return the existing one and destroy the
723 * new one just created.
725 old_path_list_index = fib_path_list_db_find(path_list);
726 if (FIB_NODE_INDEX_INVALID != old_path_list_index)
728 fib_path_list_destroy(path_list);
730 path_list_index = old_path_list_index;
735 * if there was not a matching path-list, then this
736 * new one will need inserting into the DB and resolving.
738 fib_path_list_db_insert(path_list_index);
739 path_list = fib_path_list_resolve(path_list);
745 * no shared path list requested. resolve and use the one
748 path_list = fib_path_list_resolve(path_list);
751 return (path_list_index);
754 static fib_path_cfg_flags_t
755 fib_path_list_flags_2_path_flags (fib_path_list_flags_t plf)
757 fib_path_cfg_flags_t pf = FIB_PATH_CFG_FLAG_NONE;
759 if (plf & FIB_PATH_LIST_FLAG_DROP)
761 pf |= FIB_PATH_CFG_FLAG_DROP;
763 if (plf & FIB_PATH_LIST_FLAG_EXCLUSIVE)
765 pf |= FIB_PATH_CFG_FLAG_EXCLUSIVE;
767 if (plf & FIB_PATH_LIST_FLAG_LOCAL)
769 pf |= FIB_PATH_CFG_FLAG_LOCAL;
776 fib_path_list_create_special (dpo_proto_t nh_proto,
777 fib_path_list_flags_t flags,
780 fib_node_index_t path_index, path_list_index;
781 fib_path_list_t *path_list;
783 path_list = fib_path_list_alloc(&path_list_index);
784 path_list->fpl_flags = flags;
787 fib_path_create_special(path_list_index,
789 fib_path_list_flags_2_path_flags(flags),
791 vec_add1(path_list->fpl_paths, path_index);
794 * we don't share path-lists. we can do PIC on them so why bother.
796 path_list = fib_path_list_resolve(path_list);
798 return (path_list_index);
802 * return the index info the path-lists's vector of paths, of the matching path.
806 fib_path_list_find_rpath (fib_node_index_t path_list_index,
807 const fib_route_path_t *rpath)
809 fib_path_list_t *path_list;
812 path_list = fib_path_list_get(path_list_index);
814 vec_foreach_index (ii, path_list->fpl_paths)
816 if (!fib_path_cmp_w_route_path(path_list->fpl_paths[ii], rpath))
826 * fib_path_list_copy_and_path_add
828 * Create a copy of a path-list and append one more path to it.
829 * The path-list returned could either have been newly created, or
830 * can be a shared path-list from the data-base.
833 fib_path_list_paths_add (fib_node_index_t path_list_index,
834 const fib_route_path_t *rpaths)
836 fib_node_index_t *new_path_indices, *path_index;
837 const fib_route_path_t *rpath;
838 fib_path_list_t *path_list;
842 * alloc the new list before we retrieve the old one, lest
843 * the alloc result in a realloc
845 path_list = fib_path_list_get(path_list_index);
847 ASSERT(!(path_list->fpl_flags & FIB_PATH_LIST_FLAG_SHARED));
849 FIB_PATH_LIST_DBG(path_list, "paths-add");
851 new_path_indices = NULL;
852 vec_validate_init_empty(new_path_indices,
854 FIB_NODE_INDEX_INVALID);
856 vec_foreach (path_index, path_list->fpl_paths)
859 * don't add duplicate paths
863 vec_foreach_index(ii, rpaths)
866 if (0 == fib_path_cmp_w_route_path(*path_index, rpath))
874 new_path_indices[ii] = *path_index;
879 * new_path_indices array contains INVALID for each path not found
880 * and something valid for matches
882 vec_foreach_index (ii, new_path_indices)
884 path_index = &new_path_indices[ii];
887 if (FIB_NODE_INDEX_INVALID == *path_index)
889 *path_index = fib_path_create(path_list_index, rpath);
891 * Add the new path - no sort, no sharing, no key..
893 vec_add1(path_list->fpl_paths, *path_index);
896 * no shared path list requested. resolve and use the one
899 fib_path_resolve(*path_index);
903 FIB_PATH_LIST_DBG(path_list, "paths-added");
905 return (new_path_indices);
909 fib_path_list_copy_and_path_add (fib_node_index_t orig_path_list_index,
910 fib_path_list_flags_t flags,
911 const fib_route_path_t *rpaths)
913 fib_node_index_t new_path_index, *orig_path_index;
914 fib_path_list_t *path_list, *orig_path_list;
915 fib_node_index_t exist_path_list_index;
916 fib_node_index_t path_list_index;
917 const fib_route_path_t *rpath;
921 * alloc the new list before we retrieve the old one, lest
922 * the alloc result in a realloc
924 path_list = fib_path_list_alloc(&path_list_index);
926 orig_path_list = fib_path_list_get(orig_path_list_index);
928 FIB_PATH_LIST_DBG(orig_path_list, "copy-add");
930 flags = fib_path_list_flags_fixup(flags);
931 path_list->fpl_flags = flags;
933 vec_validate(path_list->fpl_paths,
934 (vec_len(orig_path_list->fpl_paths) +
935 vec_len(rpaths) - 1));
938 vec_foreach(orig_path_index, orig_path_list->fpl_paths)
941 * copy the original paths over to the new list
943 path_list->fpl_paths[pi++] = fib_path_copy(*orig_path_index,
946 vec_foreach(rpath, rpaths)
950 new_path_index = fib_path_create(path_list_index, rpath);
952 vec_foreach(orig_path_index, orig_path_list->fpl_paths)
955 * don't add duplicate paths
956 * In the unlikely event the path is a duplicate, then we'll
957 * find a matching path-list later and this one will be toast.
959 if (0 == fib_path_cmp(new_path_index, *orig_path_index))
967 _vec_len(path_list->fpl_paths) =
968 vec_len(path_list->fpl_paths) - 1;
969 fib_path_destroy(new_path_index);
973 path_list->fpl_paths[pi++] = new_path_index;
978 * we sort the paths since the key for the path-list is
979 * the description of the paths it contains. The paths need to
980 * be sorted else this description will differ.
982 vec_sort_with_function(path_list->fpl_paths, fib_path_cmp_for_sort);
984 FIB_PATH_LIST_DBG(path_list, "path-added");
987 * check for a matching path-list in the DB.
988 * If we find one then we can return the existing one and destroy the
989 * new one just created.
991 if (path_list->fpl_flags & FIB_PATH_LIST_FLAG_SHARED)
993 exist_path_list_index = fib_path_list_db_find(path_list);
994 if (FIB_NODE_INDEX_INVALID != exist_path_list_index)
996 fib_path_list_destroy(path_list);
998 path_list_index = exist_path_list_index;
1003 * if there was not a matching path-list, then this
1004 * new one will need inserting into the DB and resolving.
1006 fib_path_list_db_insert(path_list_index);
1008 path_list = fib_path_list_resolve(path_list);
1014 * no shared path list requested. resolve and use the one
1017 path_list = fib_path_list_resolve(path_list);
1020 return (path_list_index);
1024 * fib_path_list_paths_remove
1027 fib_path_list_paths_remove (fib_node_index_t path_list_index,
1028 const fib_route_path_t *rpaths)
1030 fib_node_index_t *match_path_indices;
1031 fib_path_list_t *path_list;
1034 path_list = fib_path_list_get(path_list_index);
1035 match_path_indices = NULL;
1036 vec_validate_init_empty(match_path_indices,
1037 vec_len(rpaths) - 1,
1038 FIB_NODE_INDEX_INVALID);
1040 ASSERT(!(path_list->fpl_flags & FIB_PATH_LIST_FLAG_SHARED));
1042 FIB_PATH_LIST_DBG(path_list, "path-remove");
1045 * the number of existing paths is likely to be larger than the
1046 * number of paths being added.
1047 * walk in reverse so the vec_del is ok
1049 vec_foreach_index_backwards(ii, path_list->fpl_paths)
1053 vec_foreach_index(jj, rpaths)
1055 if (0 == fib_path_cmp_w_route_path(path_list->fpl_paths[ii],
1064 fib_node_index_t match_path_index;
1068 match_path_index = path_list->fpl_paths[ii];
1069 vec_del1(path_list->fpl_paths, ii);
1070 fib_path_destroy(match_path_index);
1071 match_path_indices[jj] = match_path_index;
1075 FIB_PATH_LIST_DBG(path_list, "paths-removed");
1077 return (match_path_indices);
1081 * fib_path_list_copy_and_path_remove
1083 * Copy the path-list excluding the path passed.
1084 * If the path is the last one, then the index reurned will be invalid.
1085 * i.e. the path-list is toast.
1088 fib_path_list_copy_and_path_remove (fib_node_index_t orig_path_list_index,
1089 fib_path_list_flags_t flags,
1090 const fib_route_path_t *rpaths)
1092 fib_node_index_t *orig_path_index, path_list_index, tmp_path_index;
1093 fib_path_list_t *path_list, *orig_path_list;
1094 const fib_route_path_t *rpath;
1095 fib_node_index_t pi;
1097 path_list = fib_path_list_alloc(&path_list_index);
1099 flags = fib_path_list_flags_fixup(flags);
1100 orig_path_list = fib_path_list_get(orig_path_list_index);
1102 FIB_PATH_LIST_DBG(orig_path_list, "copy-remove");
1104 path_list->fpl_flags = flags;
1106 * allocate as many paths as we might need in one go, rather than
1107 * using vec_add to do a few at a time.
1109 vec_validate(path_list->fpl_paths,
1110 vec_len(orig_path_list->fpl_paths) - 1);
1114 * create a representation of the path to be removed, so it
1115 * can be used as a comparison object during the copy.
1117 vec_foreach(orig_path_index, orig_path_list->fpl_paths)
1120 * copy the original paths over to the new list
1122 path_list->fpl_paths[pi++] = fib_path_copy(*orig_path_index,
1125 vec_foreach(rpath, rpaths)
1128 tmp_path_index = fib_path_create(path_list_index, rpath);
1130 vec_foreach_index(pi, path_list->fpl_paths)
1132 if (0 == fib_path_cmp(tmp_path_index, path_list->fpl_paths[pi]))
1140 fib_path_destroy(path_list->fpl_paths[pi]);
1141 vec_del1(path_list->fpl_paths, pi);
1143 fib_path_destroy(tmp_path_index);
1147 * if there are no paths, then the new path-list is aborted
1149 if (0 == vec_len(path_list->fpl_paths)) {
1150 FIB_PATH_LIST_DBG(path_list, "last-path-removed");
1152 fib_path_list_destroy(path_list);
1154 path_list_index = FIB_NODE_INDEX_INVALID;
1157 * we sort the paths since the key for the path-list is
1158 * the description of the paths it contains. The paths need to
1159 * be sorted else this description will differ.
1161 vec_sort_with_function(path_list->fpl_paths, fib_path_cmp_for_sort);
1164 * If a shared path list is requested, consult the DB for a match
1166 if (path_list->fpl_flags & FIB_PATH_LIST_FLAG_SHARED)
1168 fib_node_index_t exist_path_list_index;
1171 * check for a matching path-list in the DB.
1172 * If we find one then we can return the existing one and destroy the
1173 * new one just created.
1175 exist_path_list_index = fib_path_list_db_find(path_list);
1176 if (FIB_NODE_INDEX_INVALID != exist_path_list_index)
1178 fib_path_list_destroy(path_list);
1180 path_list_index = exist_path_list_index;
1185 * if there was not a matching path-list, then this
1186 * new one will need inserting into the DB and resolving.
1188 fib_path_list_db_insert(path_list_index);
1190 path_list = fib_path_list_resolve(path_list);
1196 * no shared path list requested. resolve and use the one
1199 path_list = fib_path_list_resolve(path_list);
1203 return (path_list_index);
1207 * fib_path_list_contribute_forwarding
1209 * Return the index of a load-balance that user of this path-list should
1210 * use for forwarding
1213 fib_path_list_contribute_forwarding (fib_node_index_t path_list_index,
1214 fib_forward_chain_type_t fct,
1215 fib_path_list_fwd_flags_t flags,
1218 fib_path_list_t *path_list;
1220 path_list = fib_path_list_get(path_list_index);
1222 fib_path_list_mk_lb(path_list, fct, dpo, flags);
1224 ASSERT(DPO_LOAD_BALANCE == dpo->dpoi_type);
1227 * If there's only one bucket in the load-balance then we can
1230 if ((1 == load_balance_n_buckets(dpo->dpoi_index)) &&
1231 (FIB_PATH_LIST_FWD_FLAG_COLLAPSE & flags))
1233 dpo_copy(dpo, load_balance_get_bucket(dpo->dpoi_index, 0));
1238 * fib_path_list_get_adj
1240 * Return the index of a adjacency for the first path that user of this
1241 * path-list should use for forwarding
1244 fib_path_list_get_adj (fib_node_index_t path_list_index,
1245 fib_forward_chain_type_t type)
1247 fib_path_list_t *path_list;
1249 path_list = fib_path_list_get(path_list_index);
1250 return (fib_path_get_adj(path_list->fpl_paths[0]));
1254 fib_path_list_recursive_loop_detect (fib_node_index_t path_list_index,
1255 fib_node_index_t **entry_indicies)
1257 fib_node_index_t *path_index;
1258 int is_looped, list_looped;
1259 fib_path_list_t *path_list;
1262 path_list = fib_path_list_get(path_list_index);
1264 vec_foreach (path_index, path_list->fpl_paths)
1266 fib_node_index_t *copy, **copy_ptr;
1269 * we need a copy of the nodes visited so that when we add entries
1270 * we explore on the nth path and a looped is detected, those entries
1271 * are not again searched for n+1 path and so finding a loop that does
1274 copy = vec_dup(*entry_indicies);
1277 is_looped = fib_path_recursive_loop_detect(*path_index, copy_ptr);
1278 list_looped += is_looped;
1283 FIB_PATH_LIST_DBG(path_list, "loop-detect: eval:%d", list_looped);
1287 path_list->fpl_flags |= FIB_PATH_LIST_FLAG_LOOPED;
1291 path_list->fpl_flags &= ~FIB_PATH_LIST_FLAG_LOOPED;
1294 return (list_looped);
1298 fib_path_list_child_add (fib_node_index_t path_list_index,
1299 fib_node_type_t child_type,
1300 fib_node_index_t child_index)
1304 sibling = fib_node_child_add(FIB_NODE_TYPE_PATH_LIST,
1309 if (FIB_PATH_LIST_POPULAR == fib_node_get_n_children(FIB_NODE_TYPE_PATH_LIST,
1313 * Set the popular flag on the path-list once we pass the magic
1314 * threshold. then walk children to update.
1315 * We don't undo this action. The rational being that the number
1316 * of entries using this prefix is large enough such that it is a
1317 * non-trival amount of effort to converge them. If we get into the
1318 * situation where we are adding and removing entries such that we
1319 * flip-flop over the threshold, then this non-trivial work is added
1320 * to each of those routes adds/deletes - not a situation we want.
1322 fib_node_back_walk_ctx_t ctx = {
1323 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE,
1325 fib_path_list_t *path_list;
1327 path_list = fib_path_list_get(path_list_index);
1328 path_list->fpl_flags |= FIB_PATH_LIST_FLAG_POPULAR;
1330 fib_walk_sync(FIB_NODE_TYPE_PATH_LIST, path_list_index, &ctx);
1337 fib_path_list_child_remove (fib_node_index_t path_list_index,
1340 fib_node_child_remove(FIB_NODE_TYPE_PATH_LIST,
1346 fib_path_list_lock(fib_node_index_t path_list_index)
1348 fib_path_list_t *path_list;
1350 if (FIB_NODE_INDEX_INVALID != path_list_index)
1352 path_list = fib_path_list_get(path_list_index);
1354 fib_node_lock(&path_list->fpl_node);
1359 fib_path_list_unlock (fib_node_index_t path_list_index)
1361 fib_path_list_t *path_list;
1363 if (FIB_NODE_INDEX_INVALID != path_list_index)
1365 path_list = fib_path_list_get(path_list_index);
1367 fib_node_unlock(&path_list->fpl_node);
1372 fib_path_list_pool_size (void)
1374 return (pool_elts(fib_path_list_pool));
1378 fib_path_list_db_size (void)
1380 return (hash_elts(fib_path_list_db));
1384 fib_path_list_walk (fib_node_index_t path_list_index,
1385 fib_path_list_walk_fn_t func,
1388 fib_node_index_t *path_index;
1389 fib_path_list_t *path_list;
1391 path_list = fib_path_list_get(path_list_index);
1393 vec_foreach(path_index, path_list->fpl_paths)
1395 if (FIB_PATH_LIST_WALK_STOP == func(path_list_index,
1403 fib_path_list_walk_w_ext (fib_node_index_t path_list_index,
1404 const fib_path_ext_list_t *ext_list,
1405 fib_path_list_walk_w_ext_fn_t func,
1408 fib_node_index_t *path_index;
1409 fib_path_list_t *path_list;
1410 fib_path_ext_t *path_ext;
1412 path_list = fib_path_list_get(path_list_index);
1414 vec_foreach(path_index, path_list->fpl_paths)
1416 path_ext = fib_path_ext_list_find_by_path_index(ext_list, *path_index);
1418 if (FIB_PATH_LIST_WALK_STOP == func(path_list_index,
1427 fib_path_list_module_init (void)
1429 fib_node_register_type (FIB_NODE_TYPE_PATH_LIST, &fib_path_list_vft);
1431 fib_path_list_db = hash_create2 (/* elts */ 0,
1433 /* value_bytes */ sizeof (fib_node_index_t),
1434 fib_path_list_db_hash_key_sum,
1435 fib_path_list_db_hash_key_equal,
1436 /* format pair/arg */
1438 fib_path_list_logger = vlib_log_register_class("fib", "path-list");
1441 static clib_error_t *
1442 show_fib_path_list_command (vlib_main_t * vm,
1443 unformat_input_t * input,
1444 vlib_cli_command_t * cmd)
1446 fib_path_list_t *path_list;
1447 fib_node_index_t pli;
1449 if (unformat (input, "%d", &pli))
1452 * show one in detail
1454 if (!pool_is_free_index(fib_path_list_pool, pli))
1456 path_list = fib_path_list_get(pli);
1457 u8 *s = fib_path_list_format(pli, NULL);
1458 s = format(s, "children:");
1459 s = fib_node_children_format(path_list->fpl_node.fn_children, s);
1460 vlib_cli_output (vm, "%s", s);
1465 vlib_cli_output (vm, "path list %d invalid", pli);
1473 vlib_cli_output (vm, "FIB Path Lists");
1474 pool_foreach_index (pli, fib_path_list_pool,
1476 vlib_cli_output (vm, "%U", format_fib_path_list, pli, 0);
1482 VLIB_CLI_COMMAND (show_fib_path_list, static) = {
1483 .path = "show fib path-lists",
1484 .function = show_fib_path_list_command,
1485 .short_help = "show fib path-lists",