2 * Copyright (c) 2015 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 * node_cli.c: node CLI
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #include <vlib/vlib.h>
41 #include <vlib/threads.h>
44 node_cmp (void *a1, void *a2)
46 vlib_node_t **n1 = a1;
47 vlib_node_t **n2 = a2;
49 return vec_cmp (n1[0]->name, n2[0]->name);
53 show_node_graph (vlib_main_t * vm,
54 unformat_input_t * input, vlib_cli_command_t * cmd)
56 vlib_node_main_t *nm = &vm->node_main;
60 vlib_cli_output (vm, "%U\n", format_vlib_node_graph, nm, 0);
62 if (unformat (input, "%U", unformat_vlib_node, vm, &node_index))
64 n = vlib_get_node (vm, node_index);
65 vlib_cli_output (vm, "%U\n", format_vlib_node_graph, nm, n);
69 vlib_node_t **nodes = vec_dup (nm->nodes);
72 vec_sort_with_function (nodes, node_cmp);
74 for (i = 0; i < vec_len (nodes); i++)
75 vlib_cli_output (vm, "%U\n\n", format_vlib_node_graph, nm, nodes[i]);
84 VLIB_CLI_COMMAND (show_node_graph_command, static) = {
85 .path = "show vlib graph",
86 .short_help = "Show packet processing node graph",
87 .function = show_node_graph,
92 format_vlib_node_state (u8 * s, va_list * va)
94 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
95 vlib_node_t *n = va_arg (*va, vlib_node_t *);
99 if (n->type == VLIB_NODE_TYPE_PROCESS)
101 vlib_process_t *p = vlib_get_process_from_node (vm, n);
103 switch (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
104 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT))
107 if (!(p->flags & VLIB_PROCESS_IS_RUNNING))
111 case VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK:
115 case VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT:
116 state = "event wait";
119 case (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK):
125 else if (n->type != VLIB_NODE_TYPE_INTERNAL)
128 if (n->state == VLIB_NODE_STATE_DISABLED)
130 else if (n->state == VLIB_NODE_STATE_INTERRUPT)
131 state = "interrupt wait";
134 return format (s, "%s", state);
138 format_vlib_node_stats (u8 * s, va_list * va)
140 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
141 vlib_node_t *n = va_arg (*va, vlib_node_t *);
142 int max = va_arg (*va, int);
156 "%=30s%=17s%=16s%=16s%=16s%=16s",
157 "Name", "Max Node Clocks", "Vectors at Max",
158 "Max Clocks", "Avg Clocks", "Avg Vectors/Call");
161 "%=30s%=12s%=16s%=16s%=16s%=16s%=16s",
162 "Name", "State", "Calls", "Vectors", "Suspends",
163 "Clocks", "Vectors/Call");
166 indent = format_get_indent (s);
168 l = n->stats_total.clocks - n->stats_last_clear.clocks;
169 c = n->stats_total.calls - n->stats_last_clear.calls;
170 p = n->stats_total.vectors - n->stats_last_clear.vectors;
171 d = n->stats_total.suspends - n->stats_last_clear.suspends;
172 maxc = (f64) n->stats_total.max_clock;
173 maxn = n->stats_total.max_clock_n;
174 if (n->stats_total.max_clock_n)
175 maxcn = (f64) n->stats_total.max_clock / (f64) maxn;
179 /* Clocks per packet, per call or per suspend. */
182 x = (f64) l / (f64) p;
184 x = (f64) l / (f64) c;
186 x = (f64) l / (f64) d;
189 v = (double) p / (double) c;
193 if (n->type == VLIB_NODE_TYPE_PROCESS)
195 vlib_process_t *p = vlib_get_process_from_node (vm, n);
197 /* Show processes with events pending. This helps spot bugs where events are not
199 if (!clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
200 misc_info = format (misc_info, "events pending, ");
205 s = format (s, "%-30v%=17.2e%=16d%=16.2e%=16.2e%=16.2e",
206 ns, maxc, maxn, maxcn, x, v);
208 s = format (s, "%-30v%=12U%16Ld%16Ld%16Ld%16.2e%16.2f", ns,
209 format_vlib_node_state, vm, n, c, p, d, x, v);
216 s = format (s, "\n%U%v", format_white_space, indent + 4, misc_info);
217 vec_free (misc_info);
223 static clib_error_t *
224 show_node_runtime (vlib_main_t * vm,
225 unformat_input_t * input, vlib_cli_command_t * cmd)
227 vlib_node_main_t *nm = &vm->node_main;
231 vlib_node_t ***node_dups = 0;
232 f64 *vectors_per_main_loop = 0;
233 f64 *last_vector_length_per_node = 0;
235 time_now = vlib_time_now (vm);
237 if (unformat (input, "%U", unformat_vlib_node, vm, &node_index))
239 n = vlib_get_node (vm, node_index);
240 vlib_node_sync_stats (vm, n);
241 vlib_cli_output (vm, "%U\n", format_vlib_node_stats, vm, 0, 0);
242 vlib_cli_output (vm, "%U\n", format_vlib_node_stats, vm, n, 0);
249 u64 n_input, n_output, n_drop, n_punt;
250 u64 n_internal_vectors, n_internal_calls;
251 u64 n_clocks, l, v, c, d;
254 vlib_main_t **stat_vms = 0, *stat_vm;
256 /* Suppress nodes with zero calls since last clear */
257 if (unformat (input, "brief") || unformat (input, "b"))
259 if (unformat (input, "verbose") || unformat (input, "v"))
261 if (unformat (input, "max") || unformat (input, "m"))
264 for (i = 0; i < vec_len (vlib_mains); i++)
266 stat_vm = vlib_mains[i];
268 vec_add1 (stat_vms, stat_vm);
272 * Barrier sync across stats scraping.
273 * Otherwise, the counts will be grossly inaccurate.
275 vlib_worker_thread_barrier_sync (vm);
277 for (j = 0; j < vec_len (stat_vms); j++)
279 stat_vm = stat_vms[j];
280 nm = &stat_vm->node_main;
282 for (i = 0; i < vec_len (nm->nodes); i++)
285 vlib_node_sync_stats (stat_vm, n);
288 nodes = vec_dup (nm->nodes);
290 vec_add1 (node_dups, nodes);
291 vec_add1 (vectors_per_main_loop,
292 vlib_last_vectors_per_main_loop_as_f64 (stat_vm));
293 vec_add1 (last_vector_length_per_node,
294 vlib_last_vector_length_per_node (stat_vm));
296 vlib_worker_thread_barrier_release (vm);
299 for (j = 0; j < vec_len (stat_vms); j++)
301 stat_vm = stat_vms[j];
302 nodes = node_dups[j];
304 vec_sort_with_function (nodes, node_cmp);
306 n_input = n_output = n_drop = n_punt = n_clocks = 0;
307 n_internal_vectors = n_internal_calls = 0;
308 for (i = 0; i < vec_len (nodes); i++)
312 l = n->stats_total.clocks - n->stats_last_clear.clocks;
315 v = n->stats_total.vectors - n->stats_last_clear.vectors;
316 c = n->stats_total.calls - n->stats_last_clear.calls;
323 case VLIB_NODE_TYPE_INTERNAL:
324 n_output += (n->flags & VLIB_NODE_FLAG_IS_OUTPUT) ? v : 0;
325 n_drop += (n->flags & VLIB_NODE_FLAG_IS_DROP) ? v : 0;
326 n_punt += (n->flags & VLIB_NODE_FLAG_IS_PUNT) ? v : 0;
327 if (!(n->flags & VLIB_NODE_FLAG_IS_OUTPUT))
329 n_internal_vectors += v;
330 n_internal_calls += c;
332 if (n->flags & VLIB_NODE_FLAG_IS_HANDOFF)
336 case VLIB_NODE_TYPE_INPUT:
342 if (vec_len (vlib_mains) > 1)
344 vlib_worker_thread_t *w = vlib_worker_threads + j;
346 vlib_cli_output (vm, "---------------");
348 if (w->lcore_id > -1)
349 vlib_cli_output (vm, "Thread %d %s (lcore %u)", j, w->name,
352 vlib_cli_output (vm, "Thread %d %s", j, w->name);
355 dt = time_now - nm->time_last_runtime_stats_clear;
358 "Time %.1f, average vectors/node %.2f, last %d main loops %.2f per node %.2f"
359 "\n vector rates in %.4e, out %.4e, drop %.4e, punt %.4e",
361 (n_internal_calls > 0
362 ? (f64) n_internal_vectors / (f64) n_internal_calls
364 1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE,
365 vectors_per_main_loop[j],
366 last_vector_length_per_node[j],
368 (f64) n_output / dt, (f64) n_drop / dt, (f64) n_punt / dt);
370 vlib_cli_output (vm, "%U", format_vlib_node_stats, stat_vm, 0, max);
371 for (i = 0; i < vec_len (nodes); i++)
374 nodes[i]->stats_total.calls -
375 nodes[i]->stats_last_clear.calls;
377 nodes[i]->stats_total.suspends -
378 nodes[i]->stats_last_clear.suspends;
379 if (c || d || !brief)
381 vlib_cli_output (vm, "%U", format_vlib_node_stats, stat_vm,
388 vec_free (node_dups);
389 vec_free (vectors_per_main_loop);
390 vec_free (last_vector_length_per_node);
397 VLIB_CLI_COMMAND (show_node_runtime_command, static) = {
398 .path = "show runtime",
399 .short_help = "Show packet processing runtime",
400 .function = show_node_runtime,
405 static clib_error_t *
406 clear_node_runtime (vlib_main_t * vm,
407 unformat_input_t * input, vlib_cli_command_t * cmd)
409 vlib_node_main_t *nm;
412 vlib_main_t **stat_vms = 0, *stat_vm;
413 vlib_node_runtime_t *r;
415 for (i = 0; i < vec_len (vlib_mains); i++)
417 stat_vm = vlib_mains[i];
419 vec_add1 (stat_vms, stat_vm);
422 vlib_worker_thread_barrier_sync (vm);
424 for (j = 0; j < vec_len (stat_vms); j++)
426 stat_vm = stat_vms[j];
427 nm = &stat_vm->node_main;
429 for (i = 0; i < vec_len (nm->nodes); i++)
432 vlib_node_sync_stats (stat_vm, n);
433 n->stats_last_clear = n->stats_total;
435 r = vlib_node_get_runtime (stat_vm, n->index);
438 /* Note: input/output rates computed using vlib_global_main */
439 nm->time_last_runtime_stats_clear = vlib_time_now (vm);
442 vlib_worker_thread_barrier_release (vm);
450 VLIB_CLI_COMMAND (clear_node_runtime_command, static) = {
451 .path = "clear runtime",
452 .short_help = "Clear packet processing runtime statistics",
453 .function = clear_node_runtime,
457 static clib_error_t *
458 show_node (vlib_main_t * vm, unformat_input_t * input,
459 vlib_cli_command_t * cmd)
461 unformat_input_t _line_input, *line_input = &_line_input;
462 vlib_node_main_t *nm = &vm->node_main;
465 u32 i, node_index = ~0;
468 if (!unformat_user (input, unformat_line_input, line_input))
471 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
473 if (unformat (line_input, "%U", unformat_vlib_node, vm, &node_index))
475 else if (unformat (line_input, "index %u", &node_index))
478 return clib_error_return (0, "unknown input '%U'",
479 format_unformat_error, line_input);
481 unformat_free (line_input);
483 if (node_index >= vec_len (vm->node_main.nodes))
484 return clib_error_return (0, "please specify valid node");
486 n = vlib_get_node (vm, node_index);
487 vlib_node_sync_stats (vm, n);
491 case VLIB_NODE_TYPE_INTERNAL:
492 type_str = "internal";
494 case VLIB_NODE_TYPE_INPUT:
497 case VLIB_NODE_TYPE_PRE_INPUT:
498 type_str = "pre-input";
500 case VLIB_NODE_TYPE_PROCESS:
501 type_str = "process";
504 type_str = "unknown";
508 s = format (s, ", sibling-of %s", n->sibling_of);
510 vlib_cli_output (vm, "node %s, type %s, state %U, index %d%v\n",
511 n->name, type_str, format_vlib_node_state, vm, n,
513 vec_reset_length (s);
515 if (n->node_fn_registrations)
517 vlib_node_fn_registration_t *fnr = n->node_fn_registrations;
520 if (vec_len (s) == 0)
521 s = format (s, "\n %-15s %=8s %6s",
522 "Name", "Priority", "Active");
523 s = format (s, "\n %-15s %=8u %=6s", fnr->name, fnr->priority,
524 fnr->function == n->function ? "yes" : "");
525 fnr = fnr->next_registration;
529 s = format (s, "\n defult only");
530 vlib_cli_output (vm, " node function variants:%v\n", s);
531 vec_reset_length (s);
533 for (i = 0; i < vec_len (n->next_nodes); i++)
536 if (n->next_nodes[i] == VLIB_INVALID_NODE_INDEX)
539 pn = vec_elt (nm->nodes, n->next_nodes[i]);
541 if (vec_len (s) == 0)
542 s = format (s, "\n %10s %10s %=30s %8s",
543 "next-index", "node-index", "Node", "Vectors");
545 s = format (s, "\n %=10u %=10u %-30v %=8llu", i, n->next_nodes[i],
546 pn->name, vec_elt (n->n_vectors_by_next_node, i));
549 if (vec_len (s) == 0)
550 s = format (s, "\n none");
551 vlib_cli_output (vm, "\n next nodes:%v\n", s);
552 vec_reset_length (s);
554 if (n->type == VLIB_NODE_TYPE_INTERNAL)
558 clib_bitmap_foreach (i, n->prev_node_bitmap, ({
559 vlib_node_t *pn = vlib_get_node (vm, i);
561 s = format (s, "\n ");
562 s2 = format (s2, "%v (%u)", pn->name, i);
563 s = format (s, "%-35v", s2);
564 vec_reset_length (s2);
568 if (vec_len (s) == 0)
569 s = format (s, "\n none");
570 vlib_cli_output (vm, "\n known previous nodes:%v\n", s);
571 vec_reset_length (s);
580 VLIB_CLI_COMMAND (show_node_command, static) = {
582 .short_help = "show node [index] <node-name | node-index>",
583 .function = show_node,
586 static clib_error_t *
587 set_node_fn(vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
589 unformat_input_t _line_input, *line_input = &_line_input;
592 clib_error_t *err = 0;
593 vlib_node_fn_registration_t *fnr;
596 if (!unformat_user (input, unformat_line_input, line_input))
599 if (!unformat (line_input, "%U", unformat_vlib_node, vm, &node_index))
601 err = clib_error_return (0, "please specify valid node name");
605 if (!unformat (line_input, "%s", &variant))
607 err = clib_error_return (0, "please specify node function variant");
611 n = vlib_get_node (vm, node_index);
613 if (n->node_fn_registrations == 0)
615 err = clib_error_return (0, "node doesn't have fnuctiona varinats");
619 fnr = n->node_fn_registrations;
620 vec_add1 (variant, 0);
624 if (!strncmp (fnr->name, (char *) variant, vec_len (variant) - 1))
628 n->function = fnr->function;
630 for (i = 0; i < vec_len (vlib_mains); i++)
632 vlib_node_runtime_t *nrt;
633 nrt = vlib_node_get_runtime (vlib_mains[i], n->index);
634 nrt->function = fnr->function;
638 fnr = fnr->next_registration;
641 err = clib_error_return (0, "node fnuction variant '%s' not found", variant);
645 unformat_free (line_input);
650 VLIB_CLI_COMMAND (set_node_fn_command, static) = {
651 .path = "set node function",
652 .short_help = "set node function <node-name> <variant-name>",
653 .function = set_node_fn,
657 /* Dummy function to get us linked in. */
659 vlib_node_cli_reference (void)
664 * fd.io coding-style-patch-verification: ON
667 * eval: (c-set-style "gnu")