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>
29 * The magic number of child entries that make a path-list popular.
30 * There's a trade-off here between convergnece and forwarding speed.
31 * Popular path-lists generate load-balance maps for the entires that
32 * use them. If the map is present there is a switch path cost to indirect
33 * through the map - this indirection provides the fast convergence - so
34 * without the map convergence is slower.
36 #define FIB_PATH_LIST_POPULAR 64
40 * A representation of the list/set of path trough which a prefix is reachable
42 typedef struct fib_path_list_t_ {
44 * A path-list is a node in the FIB graph.
49 * Flags on the path-list
51 fib_path_list_flags_t fpl_flags;
54 * Vector of paths indicies for all configured paths.
55 * For shareable path-lists this list MUST not change.
57 fib_node_index_t *fpl_paths;
60 * the RPF list calculated for this path list
62 fib_node_index_t fpl_urpf;
65 * Hash table of paths. valid only with INDEXED flag
71 * Array of strings/names for the FIB sources
73 static const char *fib_path_list_attr_names[] = FIB_PATH_LIST_ATTRIBUTES;
76 * The memory pool from which we allocate all the path-lists
78 static fib_path_list_t * fib_path_list_pool;
81 * The data-base of shared path-lists
83 static uword *fib_path_list_db;
89 #define FIB_PATH_LIST_DBG(_pl, _fmt, _args...) \
92 _tmp = fib_path_list_format( \
93 fib_path_list_get_index(_pl), _tmp); \
94 clib_warning("pl:[%d:%p:%p:%s]:" _fmt, \
95 fib_path_list_get_index(_pl), \
96 _pl, _pl->fpl_paths, _tmp, \
101 #define FIB_PATH_LIST_DBG(_pl, _fmt, _args...)
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_path_list_attribute_t attr;
133 fib_node_index_t *path_index;
134 fib_path_list_t *path_list;
136 path_list = va_arg (*args, fib_path_list_t *);
138 s = format (s, " index:%u", fib_path_list_get_index(path_list));
139 s = format (s, " locks:%u", path_list->fpl_node.fn_locks);
141 if (FIB_PATH_LIST_FLAG_NONE != path_list->fpl_flags)
143 s = format (s, " flags:");
144 FOR_EACH_PATH_LIST_ATTRIBUTE(attr)
146 if ((1<<attr) & path_list->fpl_flags)
148 s = format (s, "%s,", fib_path_list_attr_names[attr]);
152 s = format (s, " %U\n", format_fib_urpf_list, path_list->fpl_urpf);
154 vec_foreach (path_index, path_list->fpl_paths)
156 s = fib_path_format(*path_index, s);
164 fib_path_list_format (fib_node_index_t path_list_index,
167 fib_path_list_t *path_list;
169 path_list = fib_path_list_get(path_list_index);
171 return (format(s, "%U", format_fib_path_list, path_list));
175 fib_path_list_hash (fib_path_list_t *path_list)
177 uword old_path_list_hash, new_path_list_hash, path_hash;
178 fib_node_index_t *path_index;
182 new_path_list_hash = old_path_list_hash = vec_len(path_list->fpl_paths);
184 vec_foreach (path_index, path_list->fpl_paths)
186 path_hash = fib_path_hash(*path_index);
188 hash_mix64(path_hash, old_path_list_hash, new_path_list_hash);
190 hash_mix32(path_hash, old_path_list_hash, new_path_list_hash);
194 return (new_path_list_hash);
198 fib_path_list_db_hash_key_from_index (uword index)
204 fib_path_list_db_hash_key_is_index (uword key)
210 fib_path_list_db_hash_key_2_index (uword key)
212 ASSERT (fib_path_list_db_hash_key_is_index (key));
216 static fib_path_list_t*
217 fib_path_list_db_get_from_hash_key (uword key)
219 fib_path_list_t *path_list;
221 if (fib_path_list_db_hash_key_is_index (key))
223 fib_node_index_t path_list_index;
225 path_list_index = fib_path_list_db_hash_key_2_index(key);
226 path_list = fib_path_list_get(path_list_index);
230 path_list = uword_to_pointer (key, fib_path_list_t *);
237 fib_path_list_db_hash_key_sum (hash_t * h,
240 fib_path_list_t *path_list;
242 path_list = fib_path_list_db_get_from_hash_key(key);
244 return (fib_path_list_hash(path_list));
248 fib_path_list_db_hash_key_equal (hash_t * h,
252 fib_path_list_t *path_list1, *path_list2;
254 path_list1 = fib_path_list_db_get_from_hash_key(key1);
255 path_list2 = fib_path_list_db_get_from_hash_key(key2);
257 return (fib_path_list_hash(path_list1) ==
258 fib_path_list_hash(path_list2));
261 static fib_node_index_t
262 fib_path_list_db_find (fib_path_list_t *path_list)
266 p = hash_get(fib_path_list_db, path_list);
273 return (FIB_NODE_INDEX_INVALID);
277 fib_path_list_db_insert (fib_node_index_t path_list_index)
279 fib_path_list_t *path_list;
281 path_list = fib_path_list_get(path_list_index);
283 ASSERT(FIB_NODE_INDEX_INVALID == fib_path_list_db_find(path_list));
285 hash_set (fib_path_list_db,
286 fib_path_list_db_hash_key_from_index(path_list_index),
289 FIB_PATH_LIST_DBG(path_list, "DB-inserted");
293 fib_path_list_db_remove (fib_node_index_t path_list_index)
295 fib_path_list_t *path_list;
297 path_list = fib_path_list_get(path_list_index);
299 ASSERT(FIB_NODE_INDEX_INVALID != fib_path_list_db_find(path_list));
301 hash_unset(fib_path_list_db,
302 fib_path_list_db_hash_key_from_index(path_list_index));
304 FIB_PATH_LIST_DBG(path_list, "DB-removed");
308 fib_path_list_destroy (fib_path_list_t *path_list)
310 fib_node_index_t *path_index;
312 FIB_PATH_LIST_DBG(path_list, "destroy");
314 vec_foreach (path_index, path_list->fpl_paths)
316 fib_path_destroy(*path_index);
319 vec_free(path_list->fpl_paths);
320 fib_urpf_list_unlock(path_list->fpl_urpf);
322 fib_node_deinit(&path_list->fpl_node);
323 pool_put(fib_path_list_pool, path_list);
327 fib_path_list_last_lock_gone (fib_node_t *node)
329 fib_path_list_t *path_list;
331 path_list = fib_path_list_from_fib_node(node);
333 FIB_PATH_LIST_DBG(path_list, "last-lock");
335 if (path_list->fpl_flags & FIB_PATH_LIST_FLAG_SHARED)
337 fib_path_list_db_remove(fib_path_list_get_index(path_list));
339 fib_path_list_destroy(path_list);
345 * update the multipath adj this path-list will contribute to its
346 * children's forwarding.
349 fib_path_list_mk_lb (fib_path_list_t *path_list,
350 fib_forward_chain_type_t fct,
353 load_balance_path_t *nhs;
354 fib_node_index_t *path_index;
358 if (!dpo_id_is_valid(dpo))
365 fib_forw_chain_type_to_dpo_proto(fct),
366 load_balance_create(0,
367 fib_forw_chain_type_to_dpo_proto(fct),
368 0 /* FIXME FLOW HASH */));
372 * We gather the DPOs from resolved paths.
374 vec_foreach (path_index, path_list->fpl_paths)
376 nhs = fib_path_append_nh_for_multipath_hash(*path_index,
382 * Path-list load-balances, which if used, would be shared and hence
383 * never need a load-balance map.
385 load_balance_multipath_update(dpo, nhs, LOAD_BALANCE_FLAG_NONE);
387 FIB_PATH_LIST_DBG(path_list, "mk lb: %d", dpo->dpoi_index);
393 * @brief [re]build the path list's uRPF list
396 fib_path_list_mk_urpf (fib_path_list_t *path_list)
398 fib_node_index_t *path_index;
401 * ditch the old one. by iterating through all paths we are going
402 * to re-find all the adjs that were in the old one anyway. If we
403 * keep the old one, then the |sort|uniq requires more work.
404 * All users of the RPF list have their own lock, so we can release
407 fib_urpf_list_unlock(path_list->fpl_urpf);
408 path_list->fpl_urpf = fib_urpf_list_alloc_and_lock();
410 vec_foreach (path_index, path_list->fpl_paths)
412 fib_path_contribute_urpf(*path_index, path_list->fpl_urpf);
415 fib_urpf_list_bake(path_list->fpl_urpf);
419 * @brief Contribute (add) this path list's uRPF list. This allows the child
420 * to construct an aggregate list.
423 fib_path_list_contribute_urpf (fib_node_index_t path_list_index,
426 fib_path_list_t *path_list;
428 path_list = fib_path_list_get(path_list_index);
430 fib_urpf_list_combine(urpf, path_list->fpl_urpf);
434 * @brief Return the the child the RPF list pre-built for this path list
437 fib_path_list_get_urpf (fib_node_index_t path_list_index)
439 fib_path_list_t *path_list;
441 path_list = fib_path_list_get(path_list_index);
443 return (path_list->fpl_urpf);
447 * fib_path_list_back_walk
449 * Called from one of this path-list's paths to progate
453 fib_path_list_back_walk (fib_node_index_t path_list_index,
454 fib_node_back_walk_ctx_t *ctx)
456 fib_path_list_t *path_list;
458 path_list = fib_path_list_get(path_list_index);
460 fib_path_list_mk_urpf(path_list);
463 * propagate the backwalk further
465 if (path_list->fpl_flags & FIB_PATH_LIST_FLAG_POPULAR)
468 * many children. schedule a async walk
470 fib_walk_async(FIB_NODE_TYPE_PATH_LIST,
472 FIB_WALK_PRIORITY_LOW,
478 * only a few children. continue the walk synchronously
480 fib_walk_sync(FIB_NODE_TYPE_PATH_LIST, path_list_index, ctx);
485 * fib_path_list_back_walk_notify
487 * A back walk has reach this path-list.
489 static fib_node_back_walk_rc_t
490 fib_path_list_back_walk_notify (fib_node_t *node,
491 fib_node_back_walk_ctx_t *ctx)
494 * the path-list is not a direct child of any other node type
495 * paths, which do not change thier to-list-mapping, save the
496 * list they are a member of, and invoke the BW function directly.
500 return (FIB_NODE_BACK_WALK_CONTINUE);
504 * Display the path-list memory usage
507 fib_path_list_memory_show (void)
509 fib_show_memory_usage("Path-list",
510 pool_elts(fib_path_list_pool),
511 pool_len(fib_path_list_pool),
512 sizeof(fib_path_list_t));
513 fib_urpf_list_show_mem();
517 * The FIB path-list's graph node virtual function table
519 static const fib_node_vft_t fib_path_list_vft = {
520 .fnv_get = fib_path_list_get_node,
521 .fnv_last_lock = fib_path_list_last_lock_gone,
522 .fnv_back_walk = fib_path_list_back_walk_notify,
523 .fnv_mem_show = fib_path_list_memory_show,
526 static inline fib_path_list_t *
527 fib_path_list_alloc (fib_node_index_t *path_list_index)
529 fib_path_list_t *path_list;
531 pool_get(fib_path_list_pool, path_list);
532 memset(path_list, 0, sizeof(*path_list));
534 fib_node_init(&path_list->fpl_node,
535 FIB_NODE_TYPE_PATH_LIST);
536 path_list->fpl_urpf = INDEX_INVALID;
537 path_list->fpl_paths = NULL;
539 *path_list_index = fib_path_list_get_index(path_list);
541 FIB_PATH_LIST_DBG(path_list, "alloc");
546 static fib_path_list_t *
547 fib_path_list_resolve (fib_path_list_t *path_list)
549 fib_node_index_t *path_index, *paths, path_list_index;
551 ASSERT(!(path_list->fpl_flags & FIB_PATH_LIST_FLAG_RESOLVED));
554 * resolving a path-list is a recursive action. this means more path
555 * lists can be created during this call, and hence this path-list
556 * can be realloc'd. so we work with copies.
557 * this function is called only once per-path list, so its no great overhead.
559 path_list_index = fib_path_list_get_index(path_list);
560 paths = vec_dup(path_list->fpl_paths);
562 vec_foreach (path_index, paths)
564 fib_path_resolve(*path_index);
568 path_list = fib_path_list_get(path_list_index);
570 FIB_PATH_LIST_DBG(path_list, "resovled");
572 if (!(path_list->fpl_flags & FIB_PATH_LIST_FLAG_NO_URPF))
574 fib_path_list_mk_urpf(path_list);
580 fib_path_list_get_n_paths (fib_node_index_t path_list_index)
582 fib_path_list_t *path_list;
584 if (FIB_NODE_INDEX_INVALID == path_list_index)
589 path_list = fib_path_list_get(path_list_index);
591 return (vec_len(path_list->fpl_paths));
596 fib_path_list_get_resolving_interface (fib_node_index_t path_list_index)
598 fib_node_index_t *path_index;
599 fib_path_list_t *path_list;
602 path_list = fib_path_list_get(path_list_index);
605 vec_foreach (path_index, path_list->fpl_paths)
607 sw_if_index = fib_path_get_resolving_interface(*path_index);
608 if (~0 != sw_if_index)
610 return (sw_if_index);
614 return (sw_if_index);
618 fib_path_list_get_proto (fib_node_index_t path_list_index)
620 fib_path_list_t *path_list;
622 path_list = fib_path_list_get(path_list_index);
625 * we don't support a mix of path protocols, so we can return the proto
628 return (fib_path_get_proto(path_list->fpl_paths[0]));
632 fib_path_list_is_looped (fib_node_index_t path_list_index)
634 fib_path_list_t *path_list;
636 path_list = fib_path_list_get(path_list_index);
638 return (path_list->fpl_flags & FIB_PATH_LIST_FLAG_LOOPED);
642 fib_path_list_is_popular (fib_node_index_t path_list_index)
644 fib_path_list_t *path_list;
646 path_list = fib_path_list_get(path_list_index);
648 return (path_list->fpl_flags & FIB_PATH_LIST_FLAG_POPULAR);
651 static fib_path_list_flags_t
652 fib_path_list_flags_fixup (fib_path_list_flags_t flags)
655 * we do no share drop nor exclusive path-lists
657 if (flags & FIB_PATH_LIST_FLAG_DROP ||
658 flags & FIB_PATH_LIST_FLAG_EXCLUSIVE)
660 flags &= ~FIB_PATH_LIST_FLAG_SHARED;
667 fib_path_list_create (fib_path_list_flags_t flags,
668 const fib_route_path_t *rpaths)
670 fib_node_index_t path_list_index, old_path_list_index;
671 fib_path_list_t *path_list;
674 flags = fib_path_list_flags_fixup(flags);
675 path_list = fib_path_list_alloc(&path_list_index);
676 path_list->fpl_flags = flags;
680 vec_foreach_index(i, rpaths)
682 vec_add1(path_list->fpl_paths,
683 fib_path_create(path_list_index,
687 * we sort the paths since the key for the path-list is
688 * the description of the paths it contains. The paths need to
689 * be sorted else this description will differ.
691 if (vec_len(path_list->fpl_paths) > 1)
693 vec_sort_with_function(path_list->fpl_paths,
694 fib_path_cmp_for_sort);
699 * If a shared path list is requested, consult the DB for a match
701 if (flags & FIB_PATH_LIST_FLAG_SHARED)
704 * check for a matching path-list in the DB.
705 * If we find one then we can return the existing one and destroy the
706 * new one just created.
708 old_path_list_index = fib_path_list_db_find(path_list);
709 if (FIB_NODE_INDEX_INVALID != old_path_list_index)
711 fib_path_list_destroy(path_list);
713 path_list_index = old_path_list_index;
718 * if there was not a matching path-list, then this
719 * new one will need inserting into the DB and resolving.
721 fib_path_list_db_insert(path_list_index);
722 path_list = fib_path_list_resolve(path_list);
728 * no shared path list requested. resolve and use the one
731 path_list = fib_path_list_resolve(path_list);
734 return (path_list_index);
737 static fib_path_cfg_flags_t
738 fib_path_list_flags_2_path_flags (fib_path_list_flags_t plf)
740 fib_path_cfg_flags_t pf = FIB_PATH_CFG_FLAG_NONE;
742 if (plf & FIB_PATH_LIST_FLAG_DROP)
744 pf |= FIB_PATH_CFG_FLAG_DROP;
746 if (plf & FIB_PATH_LIST_FLAG_EXCLUSIVE)
748 pf |= FIB_PATH_CFG_FLAG_EXCLUSIVE;
750 if (plf & FIB_PATH_LIST_FLAG_LOCAL)
752 pf |= FIB_PATH_CFG_FLAG_LOCAL;
759 fib_path_list_create_special (dpo_proto_t nh_proto,
760 fib_path_list_flags_t flags,
763 fib_node_index_t path_index, path_list_index;
764 fib_path_list_t *path_list;
766 path_list = fib_path_list_alloc(&path_list_index);
767 path_list->fpl_flags = flags;
770 fib_path_create_special(path_list_index,
772 fib_path_list_flags_2_path_flags(flags),
774 vec_add1(path_list->fpl_paths, path_index);
777 * we don't share path-lists. we can do PIC on them so why bother.
779 path_list = fib_path_list_resolve(path_list);
781 return (path_list_index);
785 * return the index info the path-lists's vector of paths, of the matching path.
789 fib_path_list_find_rpath (fib_node_index_t path_list_index,
790 const fib_route_path_t *rpath)
792 fib_path_list_t *path_list;
795 path_list = fib_path_list_get(path_list_index);
797 vec_foreach_index (ii, path_list->fpl_paths)
799 if (!fib_path_cmp_w_route_path(path_list->fpl_paths[ii], rpath))
809 * fib_path_list_copy_and_path_add
811 * Create a copy of a path-list and append one more path to it.
812 * The path-list returned could either have been newly created, or
813 * can be a shared path-list from the data-base.
816 fib_path_list_path_add (fib_node_index_t path_list_index,
817 const fib_route_path_t *rpaths)
819 fib_node_index_t new_path_index, *orig_path_index;
820 fib_path_list_t *path_list;
823 * alloc the new list before we retrieve the old one, lest
824 * the alloc result in a realloc
826 path_list = fib_path_list_get(path_list_index);
828 ASSERT(1 == vec_len(rpaths));
829 ASSERT(!(path_list->fpl_flags & FIB_PATH_LIST_FLAG_SHARED));
831 FIB_PATH_LIST_DBG(orig_path_list, "path-add");
833 new_path_index = fib_path_create(path_list_index,
836 vec_foreach (orig_path_index, path_list->fpl_paths)
839 * don't add duplicate paths
841 if (0 == fib_path_cmp(new_path_index, *orig_path_index))
843 fib_path_destroy(new_path_index);
844 return (*orig_path_index);
849 * Add the new path - no sort, no sharing, no key..
851 vec_add1(path_list->fpl_paths, new_path_index);
853 FIB_PATH_LIST_DBG(path_list, "path-added");
856 * no shared path list requested. resolve and use the one
859 fib_path_resolve(new_path_index);
861 return (new_path_index);
865 fib_path_list_copy_and_path_add (fib_node_index_t orig_path_list_index,
866 fib_path_list_flags_t flags,
867 const fib_route_path_t *rpaths)
869 fib_node_index_t path_index, new_path_index, *orig_path_index;
870 fib_path_list_t *path_list, *orig_path_list;
871 fib_node_index_t exist_path_list_index;
872 fib_node_index_t path_list_index;
875 ASSERT(1 == vec_len(rpaths));
878 * alloc the new list before we retrieve the old one, lest
879 * the alloc result in a realloc
881 path_list = fib_path_list_alloc(&path_list_index);
883 orig_path_list = fib_path_list_get(orig_path_list_index);
885 FIB_PATH_LIST_DBG(orig_path_list, "copy-add");
887 flags = fib_path_list_flags_fixup(flags);
888 path_list->fpl_flags = flags;
890 vec_validate(path_list->fpl_paths, vec_len(orig_path_list->fpl_paths));
893 new_path_index = fib_path_create(path_list_index,
896 vec_foreach (orig_path_index, orig_path_list->fpl_paths)
899 * don't add duplicate paths
900 * In the unlikely event the path is a duplicate, then we'll
901 * find a matching path-list later and this one will be toast.
903 if (0 != fib_path_cmp(new_path_index, *orig_path_index))
905 path_index = fib_path_copy(*orig_path_index, path_list_index);
906 path_list->fpl_paths[pi++] = path_index;
910 _vec_len(path_list->fpl_paths) = vec_len(orig_path_list->fpl_paths);
914 path_list->fpl_paths[pi] = new_path_index;
917 * we sort the paths since the key for the path-list is
918 * the description of the paths it contains. The paths need to
919 * be sorted else this description will differ.
921 vec_sort_with_function(path_list->fpl_paths, fib_path_cmp_for_sort);
923 FIB_PATH_LIST_DBG(path_list, "path-added");
926 * check for a matching path-list in the DB.
927 * If we find one then we can return the existing one and destroy the
928 * new one just created.
930 if (path_list->fpl_flags & FIB_PATH_LIST_FLAG_SHARED)
932 exist_path_list_index = fib_path_list_db_find(path_list);
933 if (FIB_NODE_INDEX_INVALID != exist_path_list_index)
935 fib_path_list_destroy(path_list);
937 path_list_index = exist_path_list_index;
942 * if there was not a matching path-list, then this
943 * new one will need inserting into the DB and resolving.
945 fib_path_list_db_insert(path_list_index);
947 path_list = fib_path_list_resolve(path_list);
953 * no shared path list requested. resolve and use the one
956 path_list = fib_path_list_resolve(path_list);
959 return (path_list_index);
963 * fib_path_list_path_remove
966 fib_path_list_path_remove (fib_node_index_t path_list_index,
967 const fib_route_path_t *rpaths)
969 fib_node_index_t match_path_index, tmp_path_index;
970 fib_path_list_t *path_list;
973 path_list = fib_path_list_get(path_list_index);
975 ASSERT(1 == vec_len(rpaths));
976 ASSERT(!(path_list->fpl_flags & FIB_PATH_LIST_FLAG_SHARED));
978 FIB_PATH_LIST_DBG(orig_path_list, "path-remove");
981 * create a representation of the path to be removed, so it
982 * can be used as a comparison object during the copy.
984 tmp_path_index = fib_path_create(path_list_index,
986 match_path_index = FIB_NODE_INDEX_INVALID;
988 vec_foreach_index (pi, path_list->fpl_paths)
990 if (0 == fib_path_cmp(tmp_path_index,
991 path_list->fpl_paths[pi]))
996 match_path_index = path_list->fpl_paths[pi];
997 fib_path_destroy(match_path_index);
998 vec_del1(path_list->fpl_paths, pi);
1003 * done with the temporary now
1005 fib_path_destroy(tmp_path_index);
1007 return (match_path_index);
1011 * fib_path_list_copy_and_path_remove
1013 * Copy the path-list excluding the path passed.
1014 * If the path is the last one, then the index reurned will be invalid.
1015 * i.e. the path-list is toast.
1018 fib_path_list_copy_and_path_remove (fib_node_index_t orig_path_list_index,
1019 fib_path_list_flags_t flags,
1020 const fib_route_path_t *rpaths)
1022 fib_node_index_t path_index, *orig_path_index, path_list_index, tmp_path_index;
1023 fib_path_list_t *path_list, *orig_path_list;
1024 fib_node_index_t pi;
1026 ASSERT(1 == vec_len(rpaths));
1028 path_list = fib_path_list_alloc(&path_list_index);
1030 flags = fib_path_list_flags_fixup(flags);
1031 orig_path_list = fib_path_list_get(orig_path_list_index);
1033 FIB_PATH_LIST_DBG(orig_path_list, "copy-remove");
1035 path_list->fpl_flags = flags;
1037 * allocate as many paths as we might need in one go, rather than
1038 * using vec_add to do a few at a time.
1040 if (vec_len(orig_path_list->fpl_paths) > 1)
1042 vec_validate(path_list->fpl_paths, vec_len(orig_path_list->fpl_paths) - 2);
1047 * create a representation of the path to be removed, so it
1048 * can be used as a comparison object during the copy.
1050 tmp_path_index = fib_path_create(path_list_index,
1053 vec_foreach (orig_path_index, orig_path_list->fpl_paths)
1055 if (0 != fib_path_cmp(tmp_path_index, *orig_path_index)) {
1056 path_index = fib_path_copy(*orig_path_index, path_list_index);
1057 if (pi < vec_len(path_list->fpl_paths))
1059 path_list->fpl_paths[pi++] = path_index;
1064 * this is the unlikely case that the path being
1065 * removed does not match one in the path-list, so
1066 * we end up with as many paths as we started with.
1067 * the paths vector was sized above with the expectation
1068 * that we would have 1 less.
1070 vec_add1(path_list->fpl_paths, path_index);
1076 * done with the temporary now
1078 fib_path_destroy(tmp_path_index);
1081 * if there are no paths, then the new path-list is aborted
1083 if (0 == vec_len(path_list->fpl_paths)) {
1084 FIB_PATH_LIST_DBG(path_list, "last-path-removed");
1086 fib_path_list_destroy(path_list);
1088 path_list_index = FIB_NODE_INDEX_INVALID;
1091 * we sort the paths since the key for the path-list is
1092 * the description of the paths it contains. The paths need to
1093 * be sorted else this description will differ.
1095 vec_sort_with_function(path_list->fpl_paths, fib_path_cmp_for_sort);
1098 * If a shared path list is requested, consult the DB for a match
1100 if (path_list->fpl_flags & FIB_PATH_LIST_FLAG_SHARED)
1102 fib_node_index_t exist_path_list_index;
1105 * check for a matching path-list in the DB.
1106 * If we find one then we can return the existing one and destroy the
1107 * new one just created.
1109 exist_path_list_index = fib_path_list_db_find(path_list);
1110 if (FIB_NODE_INDEX_INVALID != exist_path_list_index)
1112 fib_path_list_destroy(path_list);
1114 path_list_index = exist_path_list_index;
1119 * if there was not a matching path-list, then this
1120 * new one will need inserting into the DB and resolving.
1122 fib_path_list_db_insert(path_list_index);
1124 path_list = fib_path_list_resolve(path_list);
1130 * no shared path list requested. resolve and use the one
1133 path_list = fib_path_list_resolve(path_list);
1137 return (path_list_index);
1141 * fib_path_list_contribute_forwarding
1143 * Return the index of a load-balance that user of this path-list should
1144 * use for forwarding
1147 fib_path_list_contribute_forwarding (fib_node_index_t path_list_index,
1148 fib_forward_chain_type_t fct,
1151 fib_path_list_t *path_list;
1153 path_list = fib_path_list_get(path_list_index);
1155 fib_path_list_mk_lb(path_list, fct, dpo);
1159 * fib_path_list_get_adj
1161 * Return the index of a adjacency for the first path that user of this
1162 * path-list should use for forwarding
1165 fib_path_list_get_adj (fib_node_index_t path_list_index,
1166 fib_forward_chain_type_t type)
1168 fib_path_list_t *path_list;
1170 path_list = fib_path_list_get(path_list_index);
1171 return (fib_path_get_adj(path_list->fpl_paths[0]));
1175 fib_path_list_recursive_loop_detect (fib_node_index_t path_list_index,
1176 fib_node_index_t **entry_indicies)
1178 fib_node_index_t *path_index;
1179 int is_looped, list_looped;
1180 fib_path_list_t *path_list;
1183 path_list = fib_path_list_get(path_list_index);
1185 vec_foreach (path_index, path_list->fpl_paths)
1187 fib_node_index_t *copy, **copy_ptr;
1190 * we need a copy of the nodes visited so that when we add entries
1191 * we explore on the nth path and a looped is detected, those entries
1192 * are not again searched for n+1 path and so finding a loop that does
1195 copy = vec_dup(*entry_indicies);
1198 is_looped = fib_path_recursive_loop_detect(*path_index, copy_ptr);
1199 list_looped += is_looped;
1202 FIB_PATH_LIST_DBG(path_list, "loop-detect: eval:%d", eval);
1206 path_list->fpl_flags |= FIB_PATH_LIST_FLAG_LOOPED;
1210 path_list->fpl_flags &= ~FIB_PATH_LIST_FLAG_LOOPED;
1213 return (list_looped);
1217 fib_path_list_child_add (fib_node_index_t path_list_index,
1218 fib_node_type_t child_type,
1219 fib_node_index_t child_index)
1223 sibling = fib_node_child_add(FIB_NODE_TYPE_PATH_LIST,
1228 if (FIB_PATH_LIST_POPULAR == fib_node_get_n_children(FIB_NODE_TYPE_PATH_LIST,
1232 * Set the popular flag on the path-list once we pass the magic
1233 * threshold. then walk children to update.
1234 * We don't undo this action. The rational being that the number
1235 * of entries using this prefix is large enough such that it is a
1236 * non-trival amount of effort to converge them. If we get into the
1237 * situation where we are adding and removing entries such that we
1238 * flip-flop over the threshold, then this non-trivial work is added
1239 * to each of those routes adds/deletes - not a situation we want.
1241 fib_node_back_walk_ctx_t ctx = {
1242 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE,
1244 fib_path_list_t *path_list;
1246 path_list = fib_path_list_get(path_list_index);
1247 path_list->fpl_flags |= FIB_PATH_LIST_FLAG_POPULAR;
1249 fib_walk_sync(FIB_NODE_TYPE_PATH_LIST, path_list_index, &ctx);
1256 fib_path_list_child_remove (fib_node_index_t path_list_index,
1259 fib_node_child_remove(FIB_NODE_TYPE_PATH_LIST,
1265 fib_path_list_lock(fib_node_index_t path_list_index)
1267 fib_path_list_t *path_list;
1269 if (FIB_NODE_INDEX_INVALID != path_list_index)
1271 path_list = fib_path_list_get(path_list_index);
1273 fib_node_lock(&path_list->fpl_node);
1274 FIB_PATH_LIST_DBG(path_list, "lock");
1279 fib_path_list_unlock (fib_node_index_t path_list_index)
1281 fib_path_list_t *path_list;
1283 if (FIB_NODE_INDEX_INVALID != path_list_index)
1285 path_list = fib_path_list_get(path_list_index);
1286 FIB_PATH_LIST_DBG(path_list, "unlock");
1288 fib_node_unlock(&path_list->fpl_node);
1293 fib_path_list_pool_size (void)
1295 return (pool_elts(fib_path_list_pool));
1299 fib_path_list_db_size (void)
1301 return (hash_elts(fib_path_list_db));
1305 fib_path_list_walk (fib_node_index_t path_list_index,
1306 fib_path_list_walk_fn_t func,
1309 fib_node_index_t *path_index;
1310 fib_path_list_t *path_list;
1312 path_list = fib_path_list_get(path_list_index);
1314 vec_foreach(path_index, path_list->fpl_paths)
1316 if (FIB_PATH_LIST_WALK_STOP == func(path_list_index,
1325 fib_path_list_module_init (void)
1327 fib_node_register_type (FIB_NODE_TYPE_PATH_LIST, &fib_path_list_vft);
1329 fib_path_list_db = hash_create2 (/* elts */ 0,
1331 /* value_bytes */ sizeof (fib_node_index_t),
1332 fib_path_list_db_hash_key_sum,
1333 fib_path_list_db_hash_key_equal,
1334 /* format pair/arg */
1338 static clib_error_t *
1339 show_fib_path_list_command (vlib_main_t * vm,
1340 unformat_input_t * input,
1341 vlib_cli_command_t * cmd)
1343 fib_path_list_t *path_list;
1344 fib_node_index_t pli;
1346 if (unformat (input, "%d", &pli))
1349 * show one in detail
1351 if (!pool_is_free_index(fib_path_list_pool, pli))
1353 path_list = fib_path_list_get(pli);
1354 u8 *s = fib_path_list_format(pli, NULL);
1355 s = format(s, "children:");
1356 s = fib_node_children_format(path_list->fpl_node.fn_children, s);
1357 vlib_cli_output (vm, "%s", s);
1362 vlib_cli_output (vm, "path list %d invalid", pli);
1370 vlib_cli_output (vm, "FIB Path Lists");
1371 pool_foreach(path_list, fib_path_list_pool,
1373 vlib_cli_output (vm, "%U", format_fib_path_list, path_list);
1379 VLIB_CLI_COMMAND (show_fib_path_list, static) = {
1380 .path = "show fib path-lists",
1381 .function = show_fib_path_list_command,
1382 .short_help = "show fib path-lists",