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/fib_walk.h>
17 #include <vnet/fib/fib_node_list.h>
22 typedef enum fib_walk_flags_t_
26 * This walk will run to completion, i.e. visit ALL the children.
27 * It is a depth first traversal of the graph.
29 FIB_WALK_FLAG_SYNC = (1 << 0),
31 * An asynchronous walk.
32 * This walk will be scheduled to run in the background. It will thus visits
33 * the children at a later point in time.
34 * It is a depth first traversal of the graph.
36 FIB_WALK_FLAG_ASYNC = (1 << 1),
38 * An indication that the walk is currently executing.
40 FIB_WALK_FLAG_EXECUTING = (1 << 2),
44 * A representation of a graph walk from a parent object to its children
46 typedef struct fib_walk_t_
49 * FIB node linkage. This object is not in the FIB object graph,
50 * but it is present in other node's dependency lists, so it needs to
58 fib_walk_flags_t fw_flags;
61 * Sibling index in the dependency list
66 * Sibling index in the list of all walks
71 * Pointer to the node whose dependants this walk is walking
73 fib_node_ptr_t fw_parent;
76 * Number of nodes visited by this walk. saved for debugging purposes.
81 * Time the walk started
86 * The reasons this walk is occuring.
87 * This is a vector ordered in time. The reasons and the front were started
88 * first, and so should be acted first when a node is visisted.
90 fib_node_back_walk_ctx_t *fw_ctx;
94 * @brief The pool of all walk objects
96 static fib_walk_t *fib_walk_pool;
99 * Statistics maintained per-walk queue
101 typedef enum fib_walk_queue_stats_t_
105 } fib_walk_queue_stats_t;
106 #define FIB_WALK_QUEUE_STATS_NUM ((fib_walk_queue_stats_t)(FIB_WALK_COMPLETED+1))
108 #define FIB_WALK_QUEUE_STATS { \
109 [FIB_WALK_SCHEDULED] = "scheduled", \
110 [FIB_WALK_COMPLETED] = "completed", \
113 #define FOR_EACH_FIB_WALK_QUEUE_STATS(_wqs) \
114 for ((_wqs) = FIB_WALK_SCHEDULED; \
115 (_wqs) < FIB_WALK_QUEUE_STATS_NUM; \
119 * The names of the walk stats
121 static const char * const fib_walk_queue_stats_names[] = FIB_WALK_QUEUE_STATS;
123 * The names of the walk reasons
125 static const char * const fib_node_bw_reason_names[] = FIB_NODE_BW_REASONS;
128 * A represenation of one queue of walk
130 typedef struct fib_walk_queue_t_
135 u64 fwq_stats[FIB_WALK_QUEUE_STATS_NUM];
138 * The node list which acts as the queue
140 fib_node_list_t fwq_queue;
144 * A set of priority queues for outstanding walks
146 typedef struct fib_walk_queues_t_
148 fib_walk_queue_t fwqs_queues[FIB_WALK_PRIORITY_NUM];
152 * The global queues of outstanding walks
154 static fib_walk_queues_t fib_walk_queues;
157 * The names of the walk priorities
159 static const char * const fib_walk_priority_names[] = FIB_WALK_PRIORITIES;
162 * @brief Histogram stats on the lenths of each walk in elemenets visisted.
163 * Store upto 1<<23 elements in increments of 1<<10
165 #define HISTOGRAM_VISITS_PER_WALK_MAX (1<<23)
166 #define HISTOGRAM_VISITS_PER_WALK_INCR (1<<10)
167 #define HISTOGRAM_VISITS_PER_WALK_N_BUCKETS \
168 (HISTOGRAM_VISITS_PER_WALK_MAX/HISTOGRAM_VISITS_PER_WALK_INCR)
169 static u64 fib_walk_hist_vists_per_walk[HISTOGRAM_VISITS_PER_WALK_N_BUCKETS];
172 * @brief History of state for the last 128 walks
174 #define HISTORY_N_WALKS 128
175 #define MAX_HISTORY_REASONS 16
176 static u32 history_last_walk_pos;
177 typedef struct fib_walk_history_t_ {
181 fib_node_ptr_t fwh_parent;
182 fib_walk_flags_t fwh_flags;
183 fib_node_bw_reason_flag_t fwh_reason[MAX_HISTORY_REASONS];
184 } fib_walk_history_t;
185 static fib_walk_history_t fib_walk_history[HISTORY_N_WALKS];
188 format_fib_walk_priority (u8 *s, va_list ap)
190 fib_walk_priority_t prio = va_arg(ap, fib_walk_priority_t);
192 ASSERT(prio < FIB_WALK_PRIORITY_NUM);
194 return (format(s, "%s", fib_walk_priority_names[prio]));
197 format_fib_walk_queue_stats (u8 *s, va_list ap)
199 fib_walk_queue_stats_t wqs = va_arg(ap, fib_walk_queue_stats_t);
201 ASSERT(wqs < FIB_WALK_QUEUE_STATS_NUM);
203 return (format(s, "%s", fib_walk_queue_stats_names[wqs]));
207 fib_walk_get_index (fib_walk_t *fwalk)
209 return (fwalk - fib_walk_pool);
213 fib_walk_get (index_t fwi)
215 return (pool_elt_at_index(fib_walk_pool, fwi));
219 * not static so it can be used in the unit tests
222 fib_walk_queue_get_size (fib_walk_priority_t prio)
224 return (fib_node_list_get_size(fib_walk_queues.fwqs_queues[prio].fwq_queue));
227 static fib_node_index_t
228 fib_walk_queue_get_front (fib_walk_priority_t prio)
232 fib_node_list_get_front(fib_walk_queues.fwqs_queues[prio].fwq_queue, &wp);
234 return (wp.fnp_index);
238 fib_walk_destroy (index_t fwi)
243 fwalk = fib_walk_get(fwi);
245 if (FIB_NODE_INDEX_INVALID != fwalk->fw_prio_sibling)
247 fib_node_list_elt_remove(fwalk->fw_prio_sibling);
249 fib_node_child_remove(fwalk->fw_parent.fnp_type,
250 fwalk->fw_parent.fnp_index,
251 fwalk->fw_dep_sibling);
254 * refetch the walk object. More walks could have been spawned as a result
255 * of releasing the lock on the parent.
257 fwalk = fib_walk_get(fwi);
260 * add the stats to the continuous histogram collection.
262 bucket = (fwalk->fw_n_visits / HISTOGRAM_VISITS_PER_WALK_INCR);
263 bucket = (bucket >= HISTOGRAM_VISITS_PER_WALK_N_BUCKETS ?
264 HISTOGRAM_VISITS_PER_WALK_N_BUCKETS - 1 :
266 fib_walk_hist_vists_per_walk[bucket]++;
269 * save stats to the recent history
272 fib_walk_history[history_last_walk_pos].fwh_n_visits =
274 fib_walk_history[history_last_walk_pos].fwh_completed =
275 vlib_time_now(vlib_get_main());
276 fib_walk_history[history_last_walk_pos].fwh_duration =
277 fib_walk_history[history_last_walk_pos].fwh_completed -
278 fwalk->fw_start_time;
279 fib_walk_history[history_last_walk_pos].fwh_parent =
281 fib_walk_history[history_last_walk_pos].fwh_flags =
284 vec_foreach_index(ii, fwalk->fw_ctx)
286 if (ii < MAX_HISTORY_REASONS)
288 fib_walk_history[history_last_walk_pos].fwh_reason[ii] =
289 fwalk->fw_ctx[ii].fnbw_reason;
293 history_last_walk_pos = (history_last_walk_pos + 1) % HISTORY_N_WALKS;
295 fib_node_deinit(&fwalk->fw_node);
296 vec_free(fwalk->fw_ctx);
297 pool_put(fib_walk_pool, fwalk);
301 * return code when advancing a walk
303 typedef enum fib_walk_advance_rc_t_
306 * The walk is complete
308 FIB_WALK_ADVANCE_DONE,
310 * the walk has more work
312 FIB_WALK_ADVANCE_MORE,
314 * The walk merged with the one in front
316 FIB_WALK_ADVANCE_MERGE,
317 } fib_walk_advance_rc_t;
320 * @brief Advance the walk one element in its work list
322 static fib_walk_advance_rc_t
323 fib_walk_advance (fib_node_index_t fwi)
325 fib_node_back_walk_ctx_t *ctx, *old;
326 fib_node_back_walk_rc_t wrc;
327 fib_node_ptr_t sibling;
332 * this walk function is re-entrant - walks acan spawn walks.
333 * fib_walk_t objects come from a pool, so they can realloc. we need
334 * to retch from said pool at the appropriate times.
336 fwalk = fib_walk_get(fwi);
338 more_elts = fib_node_list_elt_get_next(fwalk->fw_dep_sibling, &sibling);
344 vec_foreach(ctx, fwalk->fw_ctx)
346 wrc = fib_node_back_walk_one(&sibling, ctx);
348 fwalk = fib_walk_get(fwi);
349 fwalk->fw_n_visits++;
351 if (FIB_NODE_BACK_WALK_MERGE == wrc)
354 * this walk has merged with the one further along the node's
357 return (FIB_WALK_ADVANCE_MERGE);
359 if (old != fwalk->fw_ctx)
362 * nasty re-entrant addition of a walk has realloc'd the vector
365 return (FIB_WALK_ADVANCE_MERGE);
369 * move foward to the next node to visit
371 more_elts = fib_node_list_advance(fwalk->fw_dep_sibling);
376 return (FIB_WALK_ADVANCE_MORE);
379 return (FIB_WALK_ADVANCE_DONE);
383 * @breif Enurmerate the times of sleep between walks
385 typedef enum fib_walk_sleep_type_t_
387 FIB_WALK_SHORT_SLEEP,
389 } fib_walk_sleep_type_t;
391 #define FIB_WALK_N_SLEEP (FIB_WALK_LONG_SLEEP+1)
394 * @brief Durations for the sleep types
396 static f64 fib_walk_sleep_duration[] = {
397 [FIB_WALK_LONG_SLEEP] = 1e-3,
398 [FIB_WALK_SHORT_SLEEP] = 1e-8,
402 * @brief The time quota for a walk. When more than this amount of time is
403 * spent, the walk process will yield.
405 static f64 quota = 1e-4;
408 * Histogram on the amount of work done (in msecs) in each walk
410 #define N_TIME_BUCKETS 128
411 #define TIME_INCREMENTS (N_TIME_BUCKETS/2)
412 static u64 fib_walk_work_time_taken[N_TIME_BUCKETS];
415 * Histogram on the number of nodes visted in each quota
417 #define N_ELTS_BUCKETS 128
418 static u32 fib_walk_work_nodes_visisted_incr = 2;
419 static u64 fib_walk_work_nodes_visited[N_ELTS_BUCKETS];
422 * Histogram of the sleep lengths
424 static u64 fib_walk_sleep_lengths[2];
427 * @brief Service the queues
428 * This is not declared static so that it can be unit tested - i know i know...
431 fib_walk_process_queues (vlib_main_t * vm,
434 f64 start_time, consumed_time;
435 fib_walk_sleep_type_t sleep;
436 fib_walk_priority_t prio;
437 fib_walk_advance_rc_t rc;
438 fib_node_index_t fwi;
444 start_time = vlib_time_now(vm);
447 FOR_EACH_FIB_WALK_PRIORITY(prio)
449 while (0 != fib_walk_queue_get_size(prio))
451 fwi = fib_walk_queue_get_front(prio);
454 * set this walk as executing
456 fwalk = fib_walk_get(fwi);
457 fwalk->fw_flags |= FIB_WALK_FLAG_EXECUTING;
461 rc = fib_walk_advance(fwi);
463 consumed_time = (vlib_time_now(vm) - start_time);
464 } while ((consumed_time < quota) &&
465 (FIB_WALK_ADVANCE_MORE == rc));
468 * if this walk has no more work then pop it from the queue
469 * and move on to the next.
471 if (FIB_WALK_ADVANCE_MORE != rc)
473 fib_walk_destroy(fwi);
474 fib_walk_queues.fwqs_queues[prio].fwq_stats[FIB_WALK_COMPLETED]++;
479 * passed our work quota. sleep time.
481 fwalk = fib_walk_get(fwi);
482 fwalk->fw_flags &= ~FIB_WALK_FLAG_EXECUTING;
483 sleep = FIB_WALK_SHORT_SLEEP;
484 goto that_will_do_for_now;
489 * got to the end of all the work
491 sleep = FIB_WALK_LONG_SLEEP;
493 that_will_do_for_now:
497 * - for the number of nodes visisted we store 128 increments
498 * - for the time consumed we store quota/TIME_INCREMENTS increments.
500 bucket = ((n_elts/fib_walk_work_nodes_visisted_incr) > N_ELTS_BUCKETS ?
502 n_elts/fib_walk_work_nodes_visisted_incr);
503 ++fib_walk_work_nodes_visited[bucket];
505 bucket = (consumed_time - quota) / (quota / TIME_INCREMENTS);
506 bucket += N_TIME_BUCKETS/2;
507 bucket = (bucket < 0 ? 0 : bucket);
508 bucket = (bucket > N_TIME_BUCKETS-1 ? N_TIME_BUCKETS-1 : bucket);
509 ++fib_walk_work_time_taken[bucket];
511 ++fib_walk_sleep_lengths[sleep];
513 return (fib_walk_sleep_duration[sleep]);
517 * Events sent to the FIB walk process
519 typedef enum fib_walk_process_event_t_
521 FIB_WALK_PROCESS_EVENT_DATA,
522 FIB_WALK_PROCESS_EVENT_ENABLE,
523 FIB_WALK_PROCESS_EVENT_DISABLE,
524 } fib_walk_process_event;
527 * @brief The 'fib-walk' process's main loop.
530 fib_walk_process (vlib_main_t * vm,
531 vlib_node_runtime_t * node,
534 uword event_type, *event_data = 0;
539 sleep_time = fib_walk_sleep_duration[FIB_WALK_SHORT_SLEEP];
544 * the feature to disable/enable this walk process is only
545 * for testing purposes
549 vlib_process_wait_for_event_or_clock(vm, sleep_time);
553 vlib_process_wait_for_event(vm);
556 event_type = vlib_process_get_events(vm, &event_data);
557 vec_reset_length(event_data);
561 case FIB_WALK_PROCESS_EVENT_ENABLE:
564 case FIB_WALK_PROCESS_EVENT_DISABLE:
573 sleep_time = fib_walk_process_queues(vm, quota);
585 VLIB_REGISTER_NODE (fib_walk_process_node,static) = {
586 .function = fib_walk_process,
587 .type = VLIB_NODE_TYPE_PROCESS,
593 * @brief Allocate a new walk object
596 fib_walk_alloc (fib_node_type_t parent_type,
597 fib_node_index_t parent_index,
598 fib_walk_flags_t flags,
599 fib_node_back_walk_ctx_t *ctx)
603 pool_get(fib_walk_pool, fwalk);
605 fib_node_init(&fwalk->fw_node, FIB_NODE_TYPE_WALK);
607 fwalk->fw_flags = flags;
608 fwalk->fw_dep_sibling = FIB_NODE_INDEX_INVALID;
609 fwalk->fw_prio_sibling = FIB_NODE_INDEX_INVALID;
610 fwalk->fw_parent.fnp_index = parent_index;
611 fwalk->fw_parent.fnp_type = parent_type;
612 fwalk->fw_ctx = NULL;
613 fwalk->fw_start_time = vlib_time_now(vlib_get_main());
614 fwalk->fw_n_visits = 0;
617 * make a copy of the backwalk context so the depth count remains
618 * the same for each sibling visitsed. This is important in the case
619 * where a parent has a loop via one child, but all the others are not.
620 * if the looped child were visited first, the depth count would exceed, the
621 * max and the walk would terminate before it reached the other siblings.
623 vec_add1(fwalk->fw_ctx, *ctx);
629 * @brief Enqueue a walk onto the appropriate priority queue. Then signal
630 * the background process there is work to do.
633 fib_walk_prio_queue_enquue (fib_walk_priority_t prio,
638 sibling = fib_node_list_push_front(fib_walk_queues.fwqs_queues[prio].fwq_queue,
641 fib_walk_get_index(fwalk));
642 fib_walk_queues.fwqs_queues[prio].fwq_stats[FIB_WALK_SCHEDULED]++;
645 * poke the fib-walk process to perform the async walk.
646 * we are not passing it specific data, hence the last two args,
647 * the process will drain the queues
649 vlib_process_signal_event(vlib_get_main(),
650 fib_walk_process_node.index,
651 FIB_WALK_PROCESS_EVENT_DATA,
658 fib_walk_async (fib_node_type_t parent_type,
659 fib_node_index_t parent_index,
660 fib_walk_priority_t prio,
661 fib_node_back_walk_ctx_t *ctx)
665 if (FIB_NODE_GRAPH_MAX_DEPTH < ++ctx->fnbw_depth)
668 * The walk has reached the maximum depth. there is a loop in the graph.
673 if (0 == fib_node_get_n_children(parent_type,
677 * no children to walk - quit now
681 if (ctx->fnbw_flags & FIB_NODE_BW_FLAG_FORCE_SYNC)
684 * the originator of the walk wanted it to be synchronous, but the
685 * parent object chose async - denied.
687 return (fib_walk_sync(parent_type, parent_index, ctx));
691 fwalk = fib_walk_alloc(parent_type,
696 fwalk->fw_dep_sibling = fib_node_child_add(parent_type,
699 fib_walk_get_index(fwalk));
701 fwalk->fw_prio_sibling = fib_walk_prio_queue_enquue(prio, fwalk);
705 * @brief Back walk all the children of a FIB node.
707 * note this is a synchronous depth first walk. Children visited may propagate
708 * the walk to thier children. Other children node types may not propagate,
709 * synchronously but instead queue the walk for later async completion.
712 fib_walk_sync (fib_node_type_t parent_type,
713 fib_node_index_t parent_index,
714 fib_node_back_walk_ctx_t *ctx)
716 fib_walk_advance_rc_t rc;
717 fib_node_index_t fwi;
720 if (FIB_NODE_GRAPH_MAX_DEPTH < ++ctx->fnbw_depth)
723 * The walk has reached the maximum depth. there is a loop in the graph.
728 if (0 == fib_node_get_n_children(parent_type,
732 * no children to walk - quit now
737 fwalk = fib_walk_alloc(parent_type,
742 fwalk->fw_dep_sibling = fib_node_child_add(parent_type,
745 fib_walk_get_index(fwalk));
746 fwi = fib_walk_get_index(fwalk);
751 * set this walk as executing
753 fwalk->fw_flags |= FIB_WALK_FLAG_EXECUTING;
757 rc = fib_walk_advance(fwi);
758 } while (FIB_WALK_ADVANCE_MORE == rc);
762 * this walk function is re-entrant - walks can spawn walks.
763 * fib_walk_t objects come from a pool, so they can realloc. we need
764 * to re-fetch from said pool at the appropriate times.
766 fwalk = fib_walk_get(fwi);
768 if (FIB_WALK_ADVANCE_MERGE == rc)
771 * this sync walk merged with an walk in front.
772 * by reqeusting a sync walk the client wanted all children walked,
773 * so we ditch the walk object in hand and continue with the one
776 fib_node_ptr_t merged_walk;
778 fib_node_list_elt_get_next(fwalk->fw_dep_sibling, &merged_walk);
780 ASSERT(FIB_NODE_INDEX_INVALID != merged_walk.fnp_index);
781 ASSERT(FIB_NODE_TYPE_WALK == merged_walk.fnp_type);
783 fib_walk_destroy(fwi);
785 fwi = merged_walk.fnp_index;
786 fwalk = fib_walk_get(fwi);
788 if (FIB_WALK_FLAG_EXECUTING & fwalk->fw_flags)
791 * we are executing a sync walk, and we have met with another
792 * walk that is also executing. since only one walk executs at once
793 * (there is no multi-threading) this implies we have met ourselves
794 * and hence the is a loop in the graph.
795 * This function is re-entrant, so the walk object we met is being
796 * acted on in a stack frame below this one. We must therefore not
797 * continue with it now, but let the stack unwind and along the
798 * appropriate frame to read the depth count and bail.
807 * the walk reached the end of the depdency list.
815 fib_walk_destroy(fwi);
820 fib_walk_get_node (fib_node_index_t index)
824 fwalk = fib_walk_get(index);
826 return (&(fwalk->fw_node));
830 * Walk objects are not parents, nor are they locked.
834 fib_walk_last_lock_gone (fib_node_t *node)
840 fib_walk_get_from_node (fib_node_t *node)
842 return ((fib_walk_t*)(((char*)node) -
843 STRUCT_OFFSET_OF(fib_walk_t, fw_node)));
847 * @brief Another back walk has reach this walk.
848 * Megre them so there is only one left. It is this node being
849 * visited that will remain, so copy or merge the context onto it.
851 static fib_node_back_walk_rc_t
852 fib_walk_back_walk_notify (fib_node_t *node,
853 fib_node_back_walk_ctx_t *ctx)
855 fib_node_back_walk_ctx_t *last;
858 fwalk = fib_walk_get_from_node(node);
861 * check whether the walk context can be merged with the most recent.
862 * the most recent was the one last added and is thus at the back of the vector.
863 * we can merge walks if the reason for the walk is the same.
865 last = vec_end(fwalk->fw_ctx) - 1;
867 if (last->fnbw_reason == ctx->fnbw_reason)
870 * copy the largest of the depth values. in the presence of a loop,
871 * the same walk will merge with itself. if we take the smaller depth
872 * then it will never end.
874 last->fnbw_depth = ((last->fnbw_depth >= ctx->fnbw_depth) ?
881 * walks could not be merged, this means that the walk infront needs to
882 * perform different action to this one that has caught up. the one in
883 * front was scheduled first so append the new walk context to the back
886 vec_add1(fwalk->fw_ctx, *ctx);
889 return (FIB_NODE_BACK_WALK_MERGE);
893 * The FIB walk's graph node virtual function table
895 static const fib_node_vft_t fib_walk_vft = {
896 .fnv_get = fib_walk_get_node,
897 .fnv_last_lock = fib_walk_last_lock_gone,
898 .fnv_back_walk = fib_walk_back_walk_notify,
902 fib_walk_module_init (void)
904 fib_walk_priority_t prio;
906 FOR_EACH_FIB_WALK_PRIORITY(prio)
908 fib_walk_queues.fwqs_queues[prio].fwq_queue = fib_node_list_create();
911 fib_node_register_type(FIB_NODE_TYPE_WALK, &fib_walk_vft);
915 format_fib_walk (u8* s, va_list ap)
917 fib_node_index_t fwi = va_arg(ap, fib_node_index_t);
920 fwalk = fib_walk_get(fwi);
922 return (format(s, " parent:{%s:%d} visits:%d flags:%d",
923 fib_node_type_get_name(fwalk->fw_parent.fnp_type),
924 fwalk->fw_parent.fnp_index,
929 static clib_error_t *
930 fib_walk_show (vlib_main_t * vm,
931 unformat_input_t * input,
932 vlib_cli_command_t * cmd)
934 fib_walk_queue_stats_t wqs;
935 fib_walk_priority_t prio;
936 fib_node_ptr_t sibling;
937 fib_node_index_t fwi;
943 vlib_cli_output(vm, "FIB Walk Quota = %.2fusec:", quota * USEC);
944 vlib_cli_output(vm, "FIB Walk queues:");
946 FOR_EACH_FIB_WALK_PRIORITY(prio)
948 vlib_cli_output(vm, " %U priority queue:",
949 format_fib_walk_priority, prio);
950 vlib_cli_output(vm, " Stats: ");
952 FOR_EACH_FIB_WALK_QUEUE_STATS(wqs)
954 vlib_cli_output(vm, " %U:%d",
955 format_fib_walk_queue_stats, wqs,
956 fib_walk_queues.fwqs_queues[prio].fwq_stats[wqs]);
958 vlib_cli_output(vm, " Occupancy:%d",
959 fib_node_list_get_size(
960 fib_walk_queues.fwqs_queues[prio].fwq_queue));
962 more_elts = fib_node_list_get_front(
963 fib_walk_queues.fwqs_queues[prio].fwq_queue,
968 ASSERT(FIB_NODE_INDEX_INVALID != sibling.fnp_index);
969 ASSERT(FIB_NODE_TYPE_WALK == sibling.fnp_type);
971 fwi = sibling.fnp_index;
972 fwalk = fib_walk_get(fwi);
974 vlib_cli_output(vm, " %U", format_fib_walk, fwi);
976 more_elts = fib_node_list_elt_get_next(fwalk->fw_prio_sibling,
981 vlib_cli_output(vm, "Histogram Statistics:");
982 vlib_cli_output(vm, " Number of Elements visit per-quota:");
983 for (ii = 0; ii < N_ELTS_BUCKETS; ii++)
985 if (0 != fib_walk_work_nodes_visited[ii])
986 s = format(s, "%d:%d ",
987 (ii * fib_walk_work_nodes_visisted_incr),
988 fib_walk_work_nodes_visited[ii]);
990 vlib_cli_output(vm, " %v", s);
993 vlib_cli_output(vm, " Time consumed per-quota (Quota=%f usec):", quota*USEC);
994 s = format(s, "0:%d ", fib_walk_work_time_taken[0]);
995 for (ii = 1; ii < N_TIME_BUCKETS; ii++)
997 if (0 != fib_walk_work_time_taken[ii])
998 s = format(s, "%d:%d ", (u32)((((ii - N_TIME_BUCKETS/2) *
999 (quota / TIME_INCREMENTS)) + quota) *
1001 fib_walk_work_time_taken[ii]);
1003 vlib_cli_output(vm, " %v", s);
1006 vlib_cli_output(vm, " Sleep Types:");
1007 vlib_cli_output(vm, " Short Long:");
1008 vlib_cli_output(vm, " %d %d:",
1009 fib_walk_sleep_lengths[FIB_WALK_SHORT_SLEEP],
1010 fib_walk_sleep_lengths[FIB_WALK_LONG_SLEEP]);
1012 vlib_cli_output(vm, " Number of Elements visited per-walk:");
1013 for (ii = 0; ii < HISTOGRAM_VISITS_PER_WALK_N_BUCKETS; ii++)
1015 if (0 != fib_walk_hist_vists_per_walk[ii])
1016 s = format(s, "%d:%d ",
1017 ii*HISTOGRAM_VISITS_PER_WALK_INCR,
1018 fib_walk_hist_vists_per_walk[ii]);
1020 vlib_cli_output(vm, " %v", s);
1024 vlib_cli_output(vm, "Brief History (last %d walks):", HISTORY_N_WALKS);
1025 ii = history_last_walk_pos - 1;
1027 ii = HISTORY_N_WALKS - 1;
1029 while (ii != history_last_walk_pos)
1031 if (0 != fib_walk_history[ii].fwh_reason[0])
1033 fib_node_back_walk_reason_t reason;
1037 s = format(s, "[@%d]: %s:%d visits:%d duration:%.2f completed:%.2f ",
1038 ii, fib_node_type_get_name(fib_walk_history[ii].fwh_parent.fnp_type),
1039 fib_walk_history[ii].fwh_parent.fnp_index,
1040 fib_walk_history[ii].fwh_n_visits,
1041 fib_walk_history[ii].fwh_duration,
1042 fib_walk_history[ii].fwh_completed);
1043 if (FIB_WALK_FLAG_SYNC & fib_walk_history[ii].fwh_flags)
1044 s = format(s, "sync, ");
1045 if (FIB_WALK_FLAG_ASYNC & fib_walk_history[ii].fwh_flags)
1046 s = format(s, "async, ");
1048 s = format(s, "reason:");
1050 while (0 != fib_walk_history[ii].fwh_reason[jj])
1052 FOR_EACH_FIB_NODE_BW_REASON(reason) {
1053 if ((1<<reason) & fib_walk_history[ii].fwh_reason[jj]) {
1054 s = format (s, "%s,", fib_node_bw_reason_names[reason]);
1059 vlib_cli_output(vm, "%v", s);
1064 ii = HISTORY_N_WALKS - 1;
1070 VLIB_CLI_COMMAND (fib_walk_show_command, static) = {
1071 .path = "show fib walk",
1072 .short_help = "show fib walk",
1073 .function = fib_walk_show,
1076 static clib_error_t *
1077 fib_walk_set_quota (vlib_main_t * vm,
1078 unformat_input_t * input,
1079 vlib_cli_command_t * cmd)
1081 clib_error_t * error = NULL;
1084 if (unformat (input, "%f", &new_quota))
1090 error = clib_error_return(0 , "Pass a float value");
1096 VLIB_CLI_COMMAND (fib_walk_set_quota_command, static) = {
1097 .path = "set fib walk quota",
1098 .short_help = "set fib walk quota",
1099 .function = fib_walk_set_quota,
1102 static clib_error_t *
1103 fib_walk_set_histogram_elements_size (vlib_main_t * vm,
1104 unformat_input_t * input,
1105 vlib_cli_command_t * cmd)
1107 clib_error_t * error = NULL;
1110 if (unformat (input, "%d", &new))
1112 fib_walk_work_nodes_visisted_incr = new;
1116 error = clib_error_return(0 , "Pass an int value");
1122 VLIB_CLI_COMMAND (fib_walk_set_histogram_elements_size_command, static) = {
1123 .path = "set fib walk histogram elements size",
1124 .short_help = "set fib walk histogram elements size",
1125 .function = fib_walk_set_histogram_elements_size,
1128 static clib_error_t *
1129 fib_walk_clear (vlib_main_t * vm,
1130 unformat_input_t * input,
1131 vlib_cli_command_t * cmd)
1133 memset(fib_walk_hist_vists_per_walk, 0, sizeof(fib_walk_hist_vists_per_walk));
1134 memset(fib_walk_history, 0, sizeof(fib_walk_history));
1135 memset(fib_walk_work_time_taken, 0, sizeof(fib_walk_work_time_taken));
1136 memset(fib_walk_work_nodes_visited, 0, sizeof(fib_walk_work_nodes_visited));
1137 memset(fib_walk_sleep_lengths, 0, sizeof(fib_walk_sleep_lengths));
1142 VLIB_CLI_COMMAND (fib_walk_clear_command, static) = {
1143 .path = "clear fib walk",
1144 .short_help = "clear fib walk",
1145 .function = fib_walk_clear,
1149 fib_walk_process_enable (void)
1151 vlib_process_signal_event(vlib_get_main(),
1152 fib_walk_process_node.index,
1153 FIB_WALK_PROCESS_EVENT_ENABLE,
1158 fib_walk_process_disable (void)
1160 vlib_process_signal_event(vlib_get_main(),
1161 fib_walk_process_node.index,
1162 FIB_WALK_PROCESS_EVENT_DISABLE,
1166 static clib_error_t *
1167 fib_walk_process_enable_disable (vlib_main_t * vm,
1168 unformat_input_t * input,
1169 vlib_cli_command_t * cmd)
1171 if (unformat (input, "enable"))
1173 fib_walk_process_enable();
1175 else if (unformat (input, "disable"))
1177 fib_walk_process_disable();
1181 return clib_error_return(0, "choose enable or disable");
1186 VLIB_CLI_COMMAND (fib_walk_process_command, static) = {
1187 .path = "test fib-walk-process",
1188 .short_help = "test fib-walk-process [enable|disable]",
1189 .function = fib_walk_process_enable_disable,