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 * @brief There's only one event type sent to the walk process
101 #define FIB_WALK_EVENT 0
104 * Statistics maintained per-walk queue
106 typedef enum fib_walk_queue_stats_t_
110 } fib_walk_queue_stats_t;
111 #define FIB_WALK_QUEUE_STATS_NUM ((fib_walk_queue_stats_t)(FIB_WALK_COMPLETED+1))
113 #define FIB_WALK_QUEUE_STATS { \
114 [FIB_WALK_SCHEDULED] = "scheduled", \
115 [FIB_WALK_COMPLETED] = "completed", \
118 #define FOR_EACH_FIB_WALK_QUEUE_STATS(_wqs) \
119 for ((_wqs) = FIB_WALK_SCHEDULED; \
120 (_wqs) < FIB_WALK_QUEUE_STATS_NUM; \
124 * The names of the walk stats
126 static const char * const fib_walk_queue_stats_names[] = FIB_WALK_QUEUE_STATS;
128 * The names of the walk reasons
130 static const char * const fib_node_bw_reason_names[] = FIB_NODE_BW_REASONS;
133 * A represenation of one queue of walk
135 typedef struct fib_walk_queue_t_
140 u64 fwq_stats[FIB_WALK_QUEUE_STATS_NUM];
143 * The node list which acts as the queue
145 fib_node_list_t fwq_queue;
149 * A set of priority queues for outstanding walks
151 typedef struct fib_walk_queues_t_
153 fib_walk_queue_t fwqs_queues[FIB_WALK_PRIORITY_NUM];
157 * The global queues of outstanding walks
159 static fib_walk_queues_t fib_walk_queues;
162 * The names of the walk priorities
164 static const char * const fib_walk_priority_names[] = FIB_WALK_PRIORITIES;
167 * @brief Histogram stats on the lenths of each walk in elemenets visisted.
168 * Store upto 1<<23 elements in increments of 1<<10
170 #define HISTOGRAM_VISITS_PER_WALK_MAX (1<<23)
171 #define HISTOGRAM_VISITS_PER_WALK_INCR (1<<10)
172 #define HISTOGRAM_VISITS_PER_WALK_N_BUCKETS \
173 (HISTOGRAM_VISITS_PER_WALK_MAX/HISTOGRAM_VISITS_PER_WALK_INCR)
174 static u64 fib_walk_hist_vists_per_walk[HISTOGRAM_VISITS_PER_WALK_N_BUCKETS];
177 * @brief History of state for the last 128 walks
179 #define HISTORY_N_WALKS 128
180 #define MAX_HISTORY_REASONS 16
181 static u32 history_last_walk_pos;
182 typedef struct fib_walk_history_t_ {
186 fib_node_ptr_t fwh_parent;
187 fib_walk_flags_t fwh_flags;
188 fib_node_bw_reason_flag_t fwh_reason[MAX_HISTORY_REASONS];
189 } fib_walk_history_t;
190 static fib_walk_history_t fib_walk_history[HISTORY_N_WALKS];
193 format_fib_walk_priority (u8 *s, va_list ap)
195 fib_walk_priority_t prio = va_arg(ap, fib_walk_priority_t);
197 ASSERT(prio < FIB_WALK_PRIORITY_NUM);
199 return (format(s, "%s", fib_walk_priority_names[prio]));
202 format_fib_walk_queue_stats (u8 *s, va_list ap)
204 fib_walk_queue_stats_t wqs = va_arg(ap, fib_walk_queue_stats_t);
206 ASSERT(wqs < FIB_WALK_QUEUE_STATS_NUM);
208 return (format(s, "%s", fib_walk_queue_stats_names[wqs]));
212 fib_walk_get_index (fib_walk_t *fwalk)
214 return (fwalk - fib_walk_pool);
218 fib_walk_get (index_t fwi)
220 return (pool_elt_at_index(fib_walk_pool, fwi));
224 * not static so it can be used in the unit tests
227 fib_walk_queue_get_size (fib_walk_priority_t prio)
229 return (fib_node_list_get_size(fib_walk_queues.fwqs_queues[prio].fwq_queue));
232 static fib_node_index_t
233 fib_walk_queue_get_front (fib_walk_priority_t prio)
237 fib_node_list_get_front(fib_walk_queues.fwqs_queues[prio].fwq_queue, &wp);
239 return (wp.fnp_index);
243 fib_walk_destroy (fib_walk_t *fwalk)
247 if (FIB_NODE_INDEX_INVALID != fwalk->fw_prio_sibling)
249 fib_node_list_elt_remove(fwalk->fw_prio_sibling);
251 fib_node_child_remove(fwalk->fw_parent.fnp_type,
252 fwalk->fw_parent.fnp_index,
253 fwalk->fw_dep_sibling);
256 * add the stats to the continuous histogram collection.
258 bucket = (fwalk->fw_n_visits / HISTOGRAM_VISITS_PER_WALK_INCR);
259 bucket = (bucket >= HISTOGRAM_VISITS_PER_WALK_N_BUCKETS ?
260 HISTOGRAM_VISITS_PER_WALK_N_BUCKETS - 1 :
262 fib_walk_hist_vists_per_walk[bucket]++;
265 * save stats to the recent history
268 fib_walk_history[history_last_walk_pos].fwh_n_visits =
270 fib_walk_history[history_last_walk_pos].fwh_completed =
271 vlib_time_now(vlib_get_main());
272 fib_walk_history[history_last_walk_pos].fwh_duration =
273 fib_walk_history[history_last_walk_pos].fwh_completed -
274 fwalk->fw_start_time;
275 fib_walk_history[history_last_walk_pos].fwh_parent =
277 fib_walk_history[history_last_walk_pos].fwh_flags =
280 vec_foreach_index(ii, fwalk->fw_ctx)
282 if (ii < MAX_HISTORY_REASONS)
284 fib_walk_history[history_last_walk_pos].fwh_reason[ii] =
285 fwalk->fw_ctx[ii].fnbw_reason;
289 history_last_walk_pos = (history_last_walk_pos + 1) % HISTORY_N_WALKS;
291 fib_node_deinit(&fwalk->fw_node);
292 vec_free(fwalk->fw_ctx);
293 pool_put(fib_walk_pool, fwalk);
297 * return code when advancing a walk
299 typedef enum fib_walk_advance_rc_t_
302 * The walk is complete
304 FIB_WALK_ADVANCE_DONE,
306 * the walk has more work
308 FIB_WALK_ADVANCE_MORE,
310 * The walk merged with the one in front
312 FIB_WALK_ADVANCE_MERGE,
313 } fib_walk_advance_rc_t;
316 * @brief Advance the walk one element in its work list
318 static fib_walk_advance_rc_t
319 fib_walk_advance (fib_node_index_t fwi)
321 fib_node_back_walk_ctx_t *ctx, *old;
322 fib_node_back_walk_rc_t wrc;
323 fib_node_ptr_t sibling;
328 * this walk function is re-entrant - walks acan spawn walks.
329 * fib_walk_t objects come from a pool, so they can realloc. we need
330 * to retch from said pool at the appropriate times.
332 fwalk = fib_walk_get(fwi);
334 more_elts = fib_node_list_elt_get_next(fwalk->fw_dep_sibling, &sibling);
340 vec_foreach(ctx, fwalk->fw_ctx)
342 wrc = fib_node_back_walk_one(&sibling, ctx);
344 fwalk = fib_walk_get(fwi);
345 fwalk->fw_n_visits++;
347 if (FIB_NODE_BACK_WALK_MERGE == wrc)
350 * this walk has merged with the one further along the node's
353 return (FIB_WALK_ADVANCE_MERGE);
355 if (old != fwalk->fw_ctx)
358 * nasty re-entrant addition of a walk has realloc'd the vector
361 return (FIB_WALK_ADVANCE_MERGE);
365 * move foward to the next node to visit
367 more_elts = fib_node_list_advance(fwalk->fw_dep_sibling);
372 return (FIB_WALK_ADVANCE_MORE);
375 return (FIB_WALK_ADVANCE_DONE);
379 * @breif Enurmerate the times of sleep between walks
381 typedef enum fib_walk_sleep_type_t_
383 FIB_WALK_SHORT_SLEEP,
385 } fib_walk_sleep_type_t;
387 #define FIB_WALK_N_SLEEP (FIB_WALK_LONG_SLEEP+1)
390 * @brief Durations for the sleep types
392 static f64 fib_walk_sleep_duration[] = {
393 [FIB_WALK_LONG_SLEEP] = 1e-3,
394 [FIB_WALK_SHORT_SLEEP] = 1e-8,
398 * @brief The time quota for a walk. When more than this amount of time is
399 * spent, the walk process will yield.
401 static f64 quota = 1e-4;
404 * Histogram on the amount of work done (in msecs) in each walk
406 #define N_TIME_BUCKETS 128
407 #define TIME_INCREMENTS (N_TIME_BUCKETS/2)
408 static u64 fib_walk_work_time_taken[N_TIME_BUCKETS];
411 * Histogram on the number of nodes visted in each quota
413 #define N_ELTS_BUCKETS 128
414 static u32 fib_walk_work_nodes_visisted_incr = 2;
415 static u64 fib_walk_work_nodes_visited[N_ELTS_BUCKETS];
418 * Histogram of the sleep lengths
420 static u64 fib_walk_sleep_lengths[2];
423 * @brief Service the queues
424 * This is not declared static so that it can be unit tested - i know i know...
427 fib_walk_process_queues (vlib_main_t * vm,
430 f64 start_time, consumed_time;
431 fib_walk_sleep_type_t sleep;
432 fib_walk_priority_t prio;
433 fib_walk_advance_rc_t rc;
434 fib_node_index_t fwi;
440 start_time = vlib_time_now(vm);
443 FOR_EACH_FIB_WALK_PRIORITY(prio)
445 while (0 != fib_walk_queue_get_size(prio))
447 fwi = fib_walk_queue_get_front(prio);
450 * set this walk as executing
452 fwalk = fib_walk_get(fwi);
453 fwalk->fw_flags |= FIB_WALK_FLAG_EXECUTING;
457 rc = fib_walk_advance(fwi);
459 consumed_time = (vlib_time_now(vm) - start_time);
460 } while ((consumed_time < quota) &&
461 (FIB_WALK_ADVANCE_MORE == rc));
464 * if this walk has no more work then pop it from the queue
465 * and move on to the next.
467 if (FIB_WALK_ADVANCE_MORE != rc)
469 fwalk = fib_walk_get(fwi);
470 fib_walk_destroy(fwalk);
471 fib_walk_queues.fwqs_queues[prio].fwq_stats[FIB_WALK_COMPLETED]++;
476 * passed our work quota. sleep time.
478 fwalk = fib_walk_get(fwi);
479 fwalk->fw_flags &= ~FIB_WALK_FLAG_EXECUTING;
480 sleep = FIB_WALK_SHORT_SLEEP;
481 goto that_will_do_for_now;
486 * got to the end of all the work
488 sleep = FIB_WALK_LONG_SLEEP;
490 that_will_do_for_now:
494 * - for the number of nodes visisted we store 128 increments
495 * - for the time consumed we store quota/TIME_INCREMENTS increments.
497 bucket = ((n_elts/fib_walk_work_nodes_visisted_incr) > N_ELTS_BUCKETS ?
499 n_elts/fib_walk_work_nodes_visisted_incr);
500 ++fib_walk_work_nodes_visited[bucket];
502 bucket = (consumed_time - quota) / (quota / TIME_INCREMENTS);
503 bucket += N_TIME_BUCKETS/2;
504 bucket = (bucket < 0 ? 0 : bucket);
505 bucket = (bucket > N_TIME_BUCKETS-1 ? N_TIME_BUCKETS-1 : bucket);
506 ++fib_walk_work_time_taken[bucket];
508 ++fib_walk_sleep_lengths[sleep];
510 return (fib_walk_sleep_duration[sleep]);
514 * @brief The 'fib-walk' process's main loop.
517 fib_walk_process (vlib_main_t * vm,
518 vlib_node_runtime_t * node,
523 sleep_time = fib_walk_sleep_duration[FIB_WALK_SHORT_SLEEP];
527 vlib_process_wait_for_event_or_clock(vm, sleep_time);
530 * there may be lots of event queued between the processes,
531 * but the walks we want to schedule are in the priority queues,
532 * so we ignore the process events.
534 vlib_process_get_events(vm, NULL);
536 sleep_time = fib_walk_process_queues(vm, quota);
547 VLIB_REGISTER_NODE (fib_walk_process_node,static) = {
548 .function = fib_walk_process,
549 .type = VLIB_NODE_TYPE_PROCESS,
555 * @brief Allocate a new walk object
558 fib_walk_alloc (fib_node_type_t parent_type,
559 fib_node_index_t parent_index,
560 fib_walk_flags_t flags,
561 fib_node_back_walk_ctx_t *ctx)
565 pool_get(fib_walk_pool, fwalk);
567 fib_node_init(&fwalk->fw_node, FIB_NODE_TYPE_WALK);
569 fwalk->fw_flags = flags;
570 fwalk->fw_dep_sibling = FIB_NODE_INDEX_INVALID;
571 fwalk->fw_prio_sibling = FIB_NODE_INDEX_INVALID;
572 fwalk->fw_parent.fnp_index = parent_index;
573 fwalk->fw_parent.fnp_type = parent_type;
574 fwalk->fw_ctx = NULL;
575 fwalk->fw_start_time = vlib_time_now(vlib_get_main());
576 fwalk->fw_n_visits = 0;
579 * make a copy of the backwalk context so the depth count remains
580 * the same for each sibling visitsed. This is important in the case
581 * where a parent has a loop via one child, but all the others are not.
582 * if the looped child were visited first, the depth count would exceed, the
583 * max and the walk would terminate before it reached the other siblings.
585 vec_add1(fwalk->fw_ctx, *ctx);
591 * @brief Enqueue a walk onto the appropriate priority queue. Then signal
592 * the background process there is work to do.
595 fib_walk_prio_queue_enquue (fib_walk_priority_t prio,
600 sibling = fib_node_list_push_front(fib_walk_queues.fwqs_queues[prio].fwq_queue,
603 fib_walk_get_index(fwalk));
604 fib_walk_queues.fwqs_queues[prio].fwq_stats[FIB_WALK_SCHEDULED]++;
607 * poke the fib-walk process to perform the async walk.
608 * we are not passing it specific data, hence the last two args,
609 * the process will drain the queues
611 vlib_process_signal_event(vlib_get_main(),
612 fib_walk_process_node.index,
620 fib_walk_async (fib_node_type_t parent_type,
621 fib_node_index_t parent_index,
622 fib_walk_priority_t prio,
623 fib_node_back_walk_ctx_t *ctx)
627 if (FIB_NODE_GRAPH_MAX_DEPTH < ++ctx->fnbw_depth)
630 * The walk has reached the maximum depth. there is a loop in the graph.
635 if (0 == fib_node_get_n_children(parent_type,
639 * no children to walk - quit now
643 if (ctx->fnbw_flags & FIB_NODE_BW_FLAG_FORCE_SYNC)
646 * the originator of the walk wanted it to be synchronous, but the
647 * parent object chose async - denied.
649 return (fib_walk_sync(parent_type, parent_index, ctx));
653 fwalk = fib_walk_alloc(parent_type,
658 fwalk->fw_dep_sibling = fib_node_child_add(parent_type,
661 fib_walk_get_index(fwalk));
663 fwalk->fw_prio_sibling = fib_walk_prio_queue_enquue(prio, fwalk);
667 * @brief Back walk all the children of a FIB node.
669 * note this is a synchronous depth first walk. Children visited may propagate
670 * the walk to thier children. Other children node types may not propagate,
671 * synchronously but instead queue the walk for later async completion.
674 fib_walk_sync (fib_node_type_t parent_type,
675 fib_node_index_t parent_index,
676 fib_node_back_walk_ctx_t *ctx)
678 fib_walk_advance_rc_t rc;
679 fib_node_index_t fwi;
682 if (FIB_NODE_GRAPH_MAX_DEPTH < ++ctx->fnbw_depth)
685 * The walk has reached the maximum depth. there is a loop in the graph.
690 if (0 == fib_node_get_n_children(parent_type,
694 * no children to walk - quit now
699 fwalk = fib_walk_alloc(parent_type,
704 fwalk->fw_dep_sibling = fib_node_child_add(parent_type,
707 fib_walk_get_index(fwalk));
708 fwi = fib_walk_get_index(fwalk);
713 * set this walk as executing
715 fwalk->fw_flags |= FIB_WALK_FLAG_EXECUTING;
719 rc = fib_walk_advance(fwi);
720 } while (FIB_WALK_ADVANCE_MORE == rc);
724 * this walk function is re-entrant - walks can spawn walks.
725 * fib_walk_t objects come from a pool, so they can realloc. we need
726 * to re-fetch from said pool at the appropriate times.
728 fwalk = fib_walk_get(fwi);
730 if (FIB_WALK_ADVANCE_MERGE == rc)
733 * this sync walk merged with an walk in front.
734 * by reqeusting a sync walk the client wanted all children walked,
735 * so we ditch the walk object in hand and continue with the one
738 fib_node_ptr_t merged_walk;
740 fib_node_list_elt_get_next(fwalk->fw_dep_sibling, &merged_walk);
742 ASSERT(FIB_NODE_INDEX_INVALID != merged_walk.fnp_index);
743 ASSERT(FIB_NODE_TYPE_WALK == merged_walk.fnp_type);
745 fib_walk_destroy(fwalk);
747 fwi = merged_walk.fnp_index;
748 fwalk = fib_walk_get(fwi);
750 if (FIB_WALK_FLAG_EXECUTING & fwalk->fw_flags)
753 * we are executing a sync walk, and we have met with another
754 * walk that is also executing. since only one walk executs at once
755 * (there is no multi-threading) this implies we have met ourselves
756 * and hence the is a loop in the graph.
757 * This function is re-entrant, so the walk object we met is being
758 * acted on in a stack frame below this one. We must therefore not
759 * continue with it now, but let the stack unwind and along the
760 * appropriate frame to read the depth count and bail.
769 * the walk reached the end of the depdency list.
777 fib_walk_destroy(fwalk);
782 fib_walk_get_node (fib_node_index_t index)
786 fwalk = fib_walk_get(index);
788 return (&(fwalk->fw_node));
792 * Walk objects are not parents, nor are they locked.
796 fib_walk_last_lock_gone (fib_node_t *node)
802 fib_walk_get_from_node (fib_node_t *node)
804 return ((fib_walk_t*)(((char*)node) -
805 STRUCT_OFFSET_OF(fib_walk_t, fw_node)));
809 * @brief Another back walk has reach this walk.
810 * Megre them so there is only one left. It is this node being
811 * visited that will remain, so copy or merge the context onto it.
813 static fib_node_back_walk_rc_t
814 fib_walk_back_walk_notify (fib_node_t *node,
815 fib_node_back_walk_ctx_t *ctx)
817 fib_node_back_walk_ctx_t *last;
820 fwalk = fib_walk_get_from_node(node);
823 * check whether the walk context can be merged with the most recent.
824 * the most recent was the one last added and is thus at the back of the vector.
825 * we can merge walks if the reason for the walk is the same.
827 last = vec_end(fwalk->fw_ctx) - 1;
829 if (last->fnbw_reason == ctx->fnbw_reason)
832 * copy the largest of the depth values. in the presence of a loop,
833 * the same walk will merge with itself. if we take the smaller depth
834 * then it will never end.
836 last->fnbw_depth = ((last->fnbw_depth >= ctx->fnbw_depth) ?
843 * walks could not be merged, this means that the walk infront needs to
844 * perform different action to this one that has caught up. the one in
845 * front was scheduled first so append the new walk context to the back
848 vec_add1(fwalk->fw_ctx, *ctx);
851 return (FIB_NODE_BACK_WALK_MERGE);
855 * The FIB walk's graph node virtual function table
857 static const fib_node_vft_t fib_walk_vft = {
858 .fnv_get = fib_walk_get_node,
859 .fnv_last_lock = fib_walk_last_lock_gone,
860 .fnv_back_walk = fib_walk_back_walk_notify,
864 fib_walk_module_init (void)
866 fib_walk_priority_t prio;
868 FOR_EACH_FIB_WALK_PRIORITY(prio)
870 fib_walk_queues.fwqs_queues[prio].fwq_queue = fib_node_list_create();
873 fib_node_register_type(FIB_NODE_TYPE_WALK, &fib_walk_vft);
877 format_fib_walk (u8* s, va_list ap)
879 fib_node_index_t fwi = va_arg(ap, fib_node_index_t);
882 fwalk = fib_walk_get(fwi);
884 return (format(s, " parent:{%s:%d} visits:%d flags:%d",
885 fib_node_type_get_name(fwalk->fw_parent.fnp_type),
886 fwalk->fw_parent.fnp_index,
891 static clib_error_t *
892 fib_walk_show (vlib_main_t * vm,
893 unformat_input_t * input,
894 vlib_cli_command_t * cmd)
896 fib_walk_queue_stats_t wqs;
897 fib_walk_priority_t prio;
898 fib_node_ptr_t sibling;
899 fib_node_index_t fwi;
905 vlib_cli_output(vm, "FIB Walk Quota = %.2fusec:", quota * USEC);
906 vlib_cli_output(vm, "FIB Walk queues:");
908 FOR_EACH_FIB_WALK_PRIORITY(prio)
910 vlib_cli_output(vm, " %U priority queue:",
911 format_fib_walk_priority, prio);
912 vlib_cli_output(vm, " Stats: ");
914 FOR_EACH_FIB_WALK_QUEUE_STATS(wqs)
916 vlib_cli_output(vm, " %U:%d",
917 format_fib_walk_queue_stats, wqs,
918 fib_walk_queues.fwqs_queues[prio].fwq_stats[wqs]);
920 vlib_cli_output(vm, " Occupancy:%d",
921 fib_node_list_get_size(
922 fib_walk_queues.fwqs_queues[prio].fwq_queue));
924 more_elts = fib_node_list_get_front(
925 fib_walk_queues.fwqs_queues[prio].fwq_queue,
930 ASSERT(FIB_NODE_INDEX_INVALID != sibling.fnp_index);
931 ASSERT(FIB_NODE_TYPE_WALK == sibling.fnp_type);
933 fwi = sibling.fnp_index;
934 fwalk = fib_walk_get(fwi);
936 vlib_cli_output(vm, " %U", format_fib_walk, fwi);
938 more_elts = fib_node_list_elt_get_next(fwalk->fw_prio_sibling,
943 vlib_cli_output(vm, "Histogram Statistics:");
944 vlib_cli_output(vm, " Number of Elements visit per-quota:");
945 for (ii = 0; ii < N_ELTS_BUCKETS; ii++)
947 if (0 != fib_walk_work_nodes_visited[ii])
948 s = format(s, "%d:%d ",
949 (ii * fib_walk_work_nodes_visisted_incr),
950 fib_walk_work_nodes_visited[ii]);
952 vlib_cli_output(vm, " %v", s);
955 vlib_cli_output(vm, " Time consumed per-quota (Quota=%f usec):", quota*USEC);
956 s = format(s, "0:%d ", fib_walk_work_time_taken[0]);
957 for (ii = 1; ii < N_TIME_BUCKETS; ii++)
959 if (0 != fib_walk_work_time_taken[ii])
960 s = format(s, "%d:%d ", (u32)((((ii - N_TIME_BUCKETS/2) *
961 (quota / TIME_INCREMENTS)) + quota) *
963 fib_walk_work_time_taken[ii]);
965 vlib_cli_output(vm, " %v", s);
968 vlib_cli_output(vm, " Sleep Types:");
969 vlib_cli_output(vm, " Short Long:");
970 vlib_cli_output(vm, " %d %d:",
971 fib_walk_sleep_lengths[FIB_WALK_SHORT_SLEEP],
972 fib_walk_sleep_lengths[FIB_WALK_LONG_SLEEP]);
974 vlib_cli_output(vm, " Number of Elements visited per-walk:");
975 for (ii = 0; ii < HISTOGRAM_VISITS_PER_WALK_N_BUCKETS; ii++)
977 if (0 != fib_walk_hist_vists_per_walk[ii])
978 s = format(s, "%d:%d ",
979 ii*HISTOGRAM_VISITS_PER_WALK_INCR,
980 fib_walk_hist_vists_per_walk[ii]);
982 vlib_cli_output(vm, " %v", s);
986 vlib_cli_output(vm, "Brief History (last %d walks):", HISTORY_N_WALKS);
987 ii = history_last_walk_pos - 1;
989 ii = HISTORY_N_WALKS - 1;
991 while (ii != history_last_walk_pos)
993 if (0 != fib_walk_history[ii].fwh_reason[0])
995 fib_node_back_walk_reason_t reason;
999 s = format(s, "[@%d]: %s:%d visits:%d duration:%.2f completed:%.2f ",
1000 ii, fib_node_type_get_name(fib_walk_history[ii].fwh_parent.fnp_type),
1001 fib_walk_history[ii].fwh_parent.fnp_index,
1002 fib_walk_history[ii].fwh_n_visits,
1003 fib_walk_history[ii].fwh_duration,
1004 fib_walk_history[ii].fwh_completed);
1005 if (FIB_WALK_FLAG_SYNC & fib_walk_history[ii].fwh_flags)
1006 s = format(s, "sync, ");
1007 if (FIB_WALK_FLAG_ASYNC & fib_walk_history[ii].fwh_flags)
1008 s = format(s, "async, ");
1010 s = format(s, "reason:");
1012 while (0 != fib_walk_history[ii].fwh_reason[jj])
1014 FOR_EACH_FIB_NODE_BW_REASON(reason) {
1015 if ((1<<reason) & fib_walk_history[ii].fwh_reason[jj]) {
1016 s = format (s, "%s,", fib_node_bw_reason_names[reason]);
1021 vlib_cli_output(vm, "%v", s);
1026 ii = HISTORY_N_WALKS - 1;
1032 VLIB_CLI_COMMAND (fib_walk_show_command, static) = {
1033 .path = "show fib walk",
1034 .short_help = "show fib walk",
1035 .function = fib_walk_show,
1038 static clib_error_t *
1039 fib_walk_set_quota (vlib_main_t * vm,
1040 unformat_input_t * input,
1041 vlib_cli_command_t * cmd)
1043 clib_error_t * error = NULL;
1046 if (unformat (input, "%f", &new_quota))
1052 error = clib_error_return(0 , "Pass a float value");
1058 VLIB_CLI_COMMAND (fib_walk_set_quota_command, static) = {
1059 .path = "set fib walk quota",
1060 .short_help = "set fib walk quota",
1061 .function = fib_walk_set_quota,
1064 static clib_error_t *
1065 fib_walk_set_histogram_elements_size (vlib_main_t * vm,
1066 unformat_input_t * input,
1067 vlib_cli_command_t * cmd)
1069 clib_error_t * error = NULL;
1072 if (unformat (input, "%d", &new))
1074 fib_walk_work_nodes_visisted_incr = new;
1078 error = clib_error_return(0 , "Pass an int value");
1084 VLIB_CLI_COMMAND (fib_walk_set_histogram_elements_size_command, static) = {
1085 .path = "set fib walk histogram elements size",
1086 .short_help = "set fib walk histogram elements size",
1087 .function = fib_walk_set_histogram_elements_size,
1090 static clib_error_t *
1091 fib_walk_clear (vlib_main_t * vm,
1092 unformat_input_t * input,
1093 vlib_cli_command_t * cmd)
1095 memset(fib_walk_hist_vists_per_walk, 0, sizeof(fib_walk_hist_vists_per_walk));
1096 memset(fib_walk_history, 0, sizeof(fib_walk_history));
1097 memset(fib_walk_work_time_taken, 0, sizeof(fib_walk_work_time_taken));
1098 memset(fib_walk_work_nodes_visited, 0, sizeof(fib_walk_work_nodes_visited));
1099 memset(fib_walk_sleep_lengths, 0, sizeof(fib_walk_sleep_lengths));
1104 VLIB_CLI_COMMAND (fib_walk_clear_command, static) = {
1105 .path = "clear fib walk",
1106 .short_help = "clear fib walk",
1107 .function = fib_walk_clear,