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");
167 indent = format_get_indent (s);
169 l = n->stats_total.clocks - n->stats_last_clear.clocks;
170 c = n->stats_total.calls - n->stats_last_clear.calls;
171 p = n->stats_total.vectors - n->stats_last_clear.vectors;
172 d = n->stats_total.suspends - n->stats_last_clear.suspends;
173 maxc = (f64) n->stats_total.max_clock;
174 maxn = n->stats_total.max_clock_n;
175 if (n->stats_total.max_clock_n)
176 maxcn = (f64) n->stats_total.max_clock / (f64) maxn;
180 /* Clocks per packet, per call or per suspend. */
183 x = (f64) l / (f64) p;
185 x = (f64) l / (f64) c;
187 x = (f64) l / (f64) d;
190 v = (double) p / (double) c;
194 if (n->type == VLIB_NODE_TYPE_PROCESS)
196 vlib_process_t *p = vlib_get_process_from_node (vm, n);
198 /* Show processes with events pending. This helps spot bugs where events are not
200 if (!clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
201 misc_info = format (misc_info, "events pending, ");
206 s = format (s, "%-30v%=17.2e%=16d%=16.2e%=16.2e%=16.2e",
207 ns, maxc, maxn, maxcn, x, v);
209 s = format (s, "%-30v%=12U%16Ld%16Ld%16Ld%16.2e%16.2f", ns,
210 format_vlib_node_state, vm, n, c, p, d, x, v);
217 s = format (s, "\n%U%v", format_white_space, indent + 4, misc_info);
218 vec_free (misc_info);
224 static clib_error_t *
225 show_node_runtime (vlib_main_t * vm,
226 unformat_input_t * input, vlib_cli_command_t * cmd)
228 vlib_node_main_t *nm = &vm->node_main;
232 vlib_node_t ***node_dups = 0;
233 f64 *vectors_per_main_loop = 0;
234 f64 *last_vector_length_per_node = 0;
236 time_now = vlib_time_now (vm);
238 if (unformat (input, "%U", unformat_vlib_node, vm, &node_index))
240 n = vlib_get_node (vm, node_index);
241 vlib_node_sync_stats (vm, n);
242 vlib_cli_output (vm, "%U\n", format_vlib_node_stats, vm, 0, 0);
243 vlib_cli_output (vm, "%U\n", format_vlib_node_stats, vm, n, 0);
250 u64 n_input, n_output, n_drop, n_punt;
251 u64 n_internal_vectors, n_internal_calls;
252 u64 n_clocks, l, v, c, d;
255 vlib_main_t **stat_vms = 0, *stat_vm;
257 /* Suppress nodes with zero calls since last clear */
258 if (unformat (input, "brief") || unformat (input, "b"))
260 if (unformat (input, "verbose") || unformat (input, "v"))
262 if (unformat (input, "max") || unformat (input, "m"))
265 for (i = 0; i < vec_len (vlib_mains); i++)
267 stat_vm = vlib_mains[i];
269 vec_add1 (stat_vms, stat_vm);
273 * Barrier sync across stats scraping.
274 * Otherwise, the counts will be grossly inaccurate.
276 vlib_worker_thread_barrier_sync (vm);
278 for (j = 0; j < vec_len (stat_vms); j++)
280 stat_vm = stat_vms[j];
281 nm = &stat_vm->node_main;
283 for (i = 0; i < vec_len (nm->nodes); i++)
286 vlib_node_sync_stats (stat_vm, n);
289 nodes = vec_dup (nm->nodes);
291 vec_add1 (node_dups, nodes);
292 vec_add1 (vectors_per_main_loop,
293 vlib_last_vectors_per_main_loop_as_f64 (stat_vm));
294 vec_add1 (last_vector_length_per_node,
295 vlib_last_vector_length_per_node (stat_vm));
297 vlib_worker_thread_barrier_release (vm);
300 for (j = 0; j < vec_len (stat_vms); j++)
302 stat_vm = stat_vms[j];
303 nodes = node_dups[j];
305 vec_sort_with_function (nodes, node_cmp);
307 n_input = n_output = n_drop = n_punt = n_clocks = 0;
308 n_internal_vectors = n_internal_calls = 0;
309 for (i = 0; i < vec_len (nodes); i++)
313 l = n->stats_total.clocks - n->stats_last_clear.clocks;
316 v = n->stats_total.vectors - n->stats_last_clear.vectors;
317 c = n->stats_total.calls - n->stats_last_clear.calls;
324 case VLIB_NODE_TYPE_INTERNAL:
325 n_output += (n->flags & VLIB_NODE_FLAG_IS_OUTPUT) ? v : 0;
326 n_drop += (n->flags & VLIB_NODE_FLAG_IS_DROP) ? v : 0;
327 n_punt += (n->flags & VLIB_NODE_FLAG_IS_PUNT) ? v : 0;
328 if (!(n->flags & VLIB_NODE_FLAG_IS_OUTPUT))
330 n_internal_vectors += v;
331 n_internal_calls += c;
333 if (n->flags & VLIB_NODE_FLAG_IS_HANDOFF)
337 case VLIB_NODE_TYPE_INPUT:
343 if (vec_len (vlib_mains) > 1)
345 vlib_worker_thread_t *w = vlib_worker_threads + j;
347 vlib_cli_output (vm, "---------------");
350 vlib_cli_output (vm, "Thread %d %s (lcore %u)", j, w->name,
353 vlib_cli_output (vm, "Thread %d %s", j, w->name);
356 dt = time_now - nm->time_last_runtime_stats_clear;
359 "Time %.1f, average vectors/node %.2f, last %d main loops %.2f per node %.2f"
360 "\n vector rates in %.4e, out %.4e, drop %.4e, punt %.4e",
362 (n_internal_calls > 0
363 ? (f64) n_internal_vectors / (f64) n_internal_calls
365 1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE,
366 vectors_per_main_loop[j],
367 last_vector_length_per_node[j],
369 (f64) n_output / dt, (f64) n_drop / dt, (f64) n_punt / dt);
371 vlib_cli_output (vm, "%U", format_vlib_node_stats, stat_vm, 0, max);
372 for (i = 0; i < vec_len (nodes); i++)
375 nodes[i]->stats_total.calls -
376 nodes[i]->stats_last_clear.calls;
378 nodes[i]->stats_total.suspends -
379 nodes[i]->stats_last_clear.suspends;
380 if (c || d || !brief)
382 vlib_cli_output (vm, "%U", format_vlib_node_stats, stat_vm,
389 vec_free (node_dups);
390 vec_free (vectors_per_main_loop);
391 vec_free (last_vector_length_per_node);
398 VLIB_CLI_COMMAND (show_node_runtime_command, static) = {
399 .path = "show runtime",
400 .short_help = "Show packet processing runtime",
401 .function = show_node_runtime,
406 static clib_error_t *
407 clear_node_runtime (vlib_main_t * vm,
408 unformat_input_t * input, vlib_cli_command_t * cmd)
410 vlib_node_main_t *nm;
413 vlib_main_t **stat_vms = 0, *stat_vm;
414 vlib_node_runtime_t *r;
416 for (i = 0; i < vec_len (vlib_mains); i++)
418 stat_vm = vlib_mains[i];
420 vec_add1 (stat_vms, stat_vm);
423 vlib_worker_thread_barrier_sync (vm);
425 for (j = 0; j < vec_len (stat_vms); j++)
427 stat_vm = stat_vms[j];
428 nm = &stat_vm->node_main;
430 for (i = 0; i < vec_len (nm->nodes); i++)
433 vlib_node_sync_stats (stat_vm, n);
434 n->stats_last_clear = n->stats_total;
436 r = vlib_node_get_runtime (stat_vm, n->index);
439 /* Note: input/output rates computed using vlib_global_main */
440 nm->time_last_runtime_stats_clear = vlib_time_now (vm);
443 vlib_worker_thread_barrier_release (vm);
451 VLIB_CLI_COMMAND (clear_node_runtime_command, static) = {
452 .path = "clear runtime",
453 .short_help = "Clear packet processing runtime statistics",
454 .function = clear_node_runtime,
458 static clib_error_t *
459 show_node (vlib_main_t * vm, unformat_input_t * input,
460 vlib_cli_command_t * cmd)
462 unformat_input_t _line_input, *line_input = &_line_input;
463 clib_error_t *error = 0;
464 vlib_node_main_t *nm = &vm->node_main;
467 u32 i, node_index = ~0;
469 u8 valid_node_name = 0;
471 if (!unformat_user (input, unformat_line_input, line_input))
474 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
476 if (unformat (line_input, "index %u", &node_index))
479 if (unformat (line_input, "%U", unformat_vlib_node, vm, &node_index))
481 else if (!valid_node_name)
482 error = clib_error_return (0, "unknown node name: '%U'",
483 format_unformat_error, line_input);
485 error = clib_error_return (0, "unknown input '%U'",
486 format_unformat_error, line_input);
489 unformat_free (line_input);
494 if (node_index >= vec_len (vm->node_main.nodes))
495 return clib_error_return (0, "please specify valid node");
497 n = vlib_get_node (vm, node_index);
498 vlib_node_sync_stats (vm, n);
502 case VLIB_NODE_TYPE_INTERNAL:
503 type_str = "internal";
505 case VLIB_NODE_TYPE_INPUT:
508 case VLIB_NODE_TYPE_PRE_INPUT:
509 type_str = "pre-input";
511 case VLIB_NODE_TYPE_PROCESS:
512 type_str = "process";
515 type_str = "unknown";
519 s = format (s, ", sibling-of %s", n->sibling_of);
521 vlib_cli_output (vm, "node %s, type %s, state %U, index %d%v\n",
522 n->name, type_str, format_vlib_node_state, vm, n,
524 vec_reset_length (s);
526 if (n->node_fn_registrations)
528 vlib_node_fn_registration_t *fnr = n->node_fn_registrations;
531 if (vec_len (s) == 0)
532 s = format (s, "\n %-15s %=8s %6s",
533 "Name", "Priority", "Active");
534 s = format (s, "\n %-15s %=8u %=6s", fnr->name, fnr->priority,
535 fnr->function == n->function ? "yes" : "");
536 fnr = fnr->next_registration;
540 s = format (s, "\n default only");
541 vlib_cli_output (vm, " node function variants:%v\n", s);
542 vec_reset_length (s);
544 for (i = 0; i < vec_len (n->next_nodes); i++)
547 if (n->next_nodes[i] == VLIB_INVALID_NODE_INDEX)
550 pn = vec_elt (nm->nodes, n->next_nodes[i]);
552 if (vec_len (s) == 0)
553 s = format (s, "\n %10s %10s %=30s %8s",
554 "next-index", "node-index", "Node", "Vectors");
556 s = format (s, "\n %=10u %=10u %-30v %=8llu", i, n->next_nodes[i],
557 pn->name, vec_elt (n->n_vectors_by_next_node, i));
560 if (vec_len (s) == 0)
561 s = format (s, "\n none");
562 vlib_cli_output (vm, "\n next nodes:%v\n", s);
563 vec_reset_length (s);
565 if (n->type == VLIB_NODE_TYPE_INTERNAL)
569 clib_bitmap_foreach (i, n->prev_node_bitmap, ({
570 vlib_node_t *pn = vlib_get_node (vm, i);
572 s = format (s, "\n ");
573 s2 = format (s2, "%v (%u)", pn->name, i);
574 s = format (s, "%-35v", s2);
575 vec_reset_length (s2);
579 if (vec_len (s) == 0)
580 s = format (s, "\n none");
581 vlib_cli_output (vm, "\n known previous nodes:%v\n", s);
582 vec_reset_length (s);
591 VLIB_CLI_COMMAND (show_node_command, static) = {
593 .short_help = "show node [index] <node-name | node-index>",
594 .function = show_node,
597 static clib_error_t *
598 set_node_fn(vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
600 unformat_input_t _line_input, *line_input = &_line_input;
603 clib_error_t *err = 0;
604 vlib_node_fn_registration_t *fnr;
607 if (!unformat_user (input, unformat_line_input, line_input))
610 if (!unformat (line_input, "%U", unformat_vlib_node, vm, &node_index))
612 err = clib_error_return (0, "please specify valid node name");
616 if (!unformat (line_input, "%s", &variant))
618 err = clib_error_return (0, "please specify node functional variant");
622 n = vlib_get_node (vm, node_index);
624 if (n->node_fn_registrations == 0)
626 err = clib_error_return (0, "node doesn't have functional variants");
630 fnr = n->node_fn_registrations;
631 vec_add1 (variant, 0);
635 if (!strncmp (fnr->name, (char *) variant, vec_len (variant) - 1))
639 n->function = fnr->function;
641 for (i = 0; i < vec_len (vlib_mains); i++)
643 vlib_node_runtime_t *nrt;
644 nrt = vlib_node_get_runtime (vlib_mains[i], n->index);
645 nrt->function = fnr->function;
649 fnr = fnr->next_registration;
652 err = clib_error_return (0, "node functional variant '%s' not found", variant);
656 unformat_free (line_input);
661 VLIB_CLI_COMMAND (set_node_fn_command, static) = {
662 .path = "set node function",
663 .short_help = "set node function <node-name> <variant-name>",
664 .function = set_node_fn,
668 /* Dummy function to get us linked in. */
670 vlib_node_cli_reference (void)
675 * fd.io coding-style-patch-verification: ON
678 * eval: (c-set-style "gnu")