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);
152 f64 pmc_ticks_per_packet;
158 "%=30s%=17s%=16s%=16s%=16s%=16s",
159 "Name", "Max Node Clocks", "Vectors at Max",
160 "Max Clocks", "Avg Clocks", "Avg Vectors/Call");
163 "%=30s%=12s%=16s%=16s%=16s%=16s%=16s",
164 "Name", "State", "Calls", "Vectors", "Suspends",
165 "Clocks", "Vectors/Call");
166 if (vm->perf_counter_id)
167 s = format (s, "%=16s", "Perf Ticks");
172 indent = format_get_indent (s);
174 l = n->stats_total.clocks - n->stats_last_clear.clocks;
175 c = n->stats_total.calls - n->stats_last_clear.calls;
176 p = n->stats_total.vectors - n->stats_last_clear.vectors;
177 d = n->stats_total.suspends - n->stats_last_clear.suspends;
178 maxc = (f64) n->stats_total.max_clock;
179 maxn = n->stats_total.max_clock_n;
180 if (n->stats_total.max_clock_n)
181 maxcn = (f64) n->stats_total.max_clock / (f64) maxn;
185 pmc_ticks = n->stats_total.perf_counter_ticks -
186 n->stats_last_clear.perf_counter_ticks;
188 pmc_ticks_per_packet = (f64) pmc_ticks / (f64) p;
190 pmc_ticks_per_packet = 0.0;
192 /* Clocks per packet, per call or per suspend. */
195 x = (f64) l / (f64) p;
197 x = (f64) l / (f64) c;
199 x = (f64) l / (f64) d;
202 v = (double) p / (double) c;
206 if (n->type == VLIB_NODE_TYPE_PROCESS)
208 vlib_process_t *p = vlib_get_process_from_node (vm, n);
210 /* Show processes with events pending. This helps spot bugs where events are not
212 if (!clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
213 misc_info = format (misc_info, "events pending, ");
218 s = format (s, "%-30v%=17.2e%=16d%=16.2e%=16.2e%=16.2e",
219 ns, maxc, maxn, maxcn, x, v);
221 s = format (s, "%-30v%=12U%16Ld%16Ld%16Ld%16.2e%16.2f", ns,
222 format_vlib_node_state, vm, n, c, p, d, x, v);
224 if (pmc_ticks_per_packet > 0.0)
225 s = format (s, "%16.2e", pmc_ticks_per_packet);
232 s = format (s, "\n%U%v", format_white_space, indent + 4, misc_info);
233 vec_free (misc_info);
239 static clib_error_t *
240 show_node_runtime (vlib_main_t * vm,
241 unformat_input_t * input, vlib_cli_command_t * cmd)
243 vlib_node_main_t *nm = &vm->node_main;
247 vlib_node_t ***node_dups = 0;
248 f64 *vectors_per_main_loop = 0;
249 f64 *last_vector_length_per_node = 0;
251 time_now = vlib_time_now (vm);
253 if (unformat (input, "%U", unformat_vlib_node, vm, &node_index))
255 n = vlib_get_node (vm, node_index);
256 vlib_node_sync_stats (vm, n);
257 vlib_cli_output (vm, "%U\n", format_vlib_node_stats, vm, 0, 0);
258 vlib_cli_output (vm, "%U\n", format_vlib_node_stats, vm, n, 0);
265 u64 n_input, n_output, n_drop, n_punt;
266 u64 n_internal_vectors, n_internal_calls;
267 u64 n_clocks, l, v, c, d;
270 vlib_main_t **stat_vms = 0, *stat_vm;
272 /* Suppress nodes with zero calls since last clear */
273 if (unformat (input, "brief") || unformat (input, "b"))
275 if (unformat (input, "verbose") || unformat (input, "v"))
277 if (unformat (input, "max") || unformat (input, "m"))
280 for (i = 0; i < vec_len (vlib_mains); i++)
282 stat_vm = vlib_mains[i];
284 vec_add1 (stat_vms, stat_vm);
288 * Barrier sync across stats scraping.
289 * Otherwise, the counts will be grossly inaccurate.
291 vlib_worker_thread_barrier_sync (vm);
293 for (j = 0; j < vec_len (stat_vms); j++)
295 stat_vm = stat_vms[j];
296 nm = &stat_vm->node_main;
298 for (i = 0; i < vec_len (nm->nodes); i++)
301 vlib_node_sync_stats (stat_vm, n);
304 nodes = vec_dup (nm->nodes);
306 vec_add1 (node_dups, nodes);
307 vec_add1 (vectors_per_main_loop,
308 vlib_last_vectors_per_main_loop_as_f64 (stat_vm));
309 vec_add1 (last_vector_length_per_node,
310 vlib_last_vector_length_per_node (stat_vm));
312 vlib_worker_thread_barrier_release (vm);
315 for (j = 0; j < vec_len (stat_vms); j++)
317 stat_vm = stat_vms[j];
318 nodes = node_dups[j];
320 vec_sort_with_function (nodes, node_cmp);
322 n_input = n_output = n_drop = n_punt = n_clocks = 0;
323 n_internal_vectors = n_internal_calls = 0;
324 for (i = 0; i < vec_len (nodes); i++)
328 l = n->stats_total.clocks - n->stats_last_clear.clocks;
331 v = n->stats_total.vectors - n->stats_last_clear.vectors;
332 c = n->stats_total.calls - n->stats_last_clear.calls;
339 case VLIB_NODE_TYPE_INTERNAL:
340 n_output += (n->flags & VLIB_NODE_FLAG_IS_OUTPUT) ? v : 0;
341 n_drop += (n->flags & VLIB_NODE_FLAG_IS_DROP) ? v : 0;
342 n_punt += (n->flags & VLIB_NODE_FLAG_IS_PUNT) ? v : 0;
343 if (!(n->flags & VLIB_NODE_FLAG_IS_OUTPUT))
345 n_internal_vectors += v;
346 n_internal_calls += c;
348 if (n->flags & VLIB_NODE_FLAG_IS_HANDOFF)
352 case VLIB_NODE_TYPE_INPUT:
358 if (vec_len (vlib_mains) > 1)
360 vlib_worker_thread_t *w = vlib_worker_threads + j;
362 vlib_cli_output (vm, "---------------");
365 vlib_cli_output (vm, "Thread %d %s (lcore %u)", j, w->name,
368 vlib_cli_output (vm, "Thread %d %s", j, w->name);
371 dt = time_now - nm->time_last_runtime_stats_clear;
374 "Time %.1f, average vectors/node %.2f, last %d main loops %.2f per node %.2f"
375 "\n vector rates in %.4e, out %.4e, drop %.4e, punt %.4e",
377 (n_internal_calls > 0
378 ? (f64) n_internal_vectors / (f64) n_internal_calls
380 1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE,
381 vectors_per_main_loop[j],
382 last_vector_length_per_node[j],
384 (f64) n_output / dt, (f64) n_drop / dt, (f64) n_punt / dt);
386 vlib_cli_output (vm, "%U", format_vlib_node_stats, stat_vm, 0, max);
387 for (i = 0; i < vec_len (nodes); i++)
390 nodes[i]->stats_total.calls -
391 nodes[i]->stats_last_clear.calls;
393 nodes[i]->stats_total.suspends -
394 nodes[i]->stats_last_clear.suspends;
395 if (c || d || !brief)
397 vlib_cli_output (vm, "%U", format_vlib_node_stats, stat_vm,
404 vec_free (node_dups);
405 vec_free (vectors_per_main_loop);
406 vec_free (last_vector_length_per_node);
413 VLIB_CLI_COMMAND (show_node_runtime_command, static) = {
414 .path = "show runtime",
415 .short_help = "Show packet processing runtime",
416 .function = show_node_runtime,
421 static clib_error_t *
422 clear_node_runtime (vlib_main_t * vm,
423 unformat_input_t * input, vlib_cli_command_t * cmd)
425 vlib_node_main_t *nm;
428 vlib_main_t **stat_vms = 0, *stat_vm;
429 vlib_node_runtime_t *r;
431 for (i = 0; i < vec_len (vlib_mains); i++)
433 stat_vm = vlib_mains[i];
435 vec_add1 (stat_vms, stat_vm);
438 vlib_worker_thread_barrier_sync (vm);
440 for (j = 0; j < vec_len (stat_vms); j++)
442 stat_vm = stat_vms[j];
443 nm = &stat_vm->node_main;
445 for (i = 0; i < vec_len (nm->nodes); i++)
448 vlib_node_sync_stats (stat_vm, n);
449 n->stats_last_clear = n->stats_total;
451 r = vlib_node_get_runtime (stat_vm, n->index);
454 /* Note: input/output rates computed using vlib_global_main */
455 nm->time_last_runtime_stats_clear = vlib_time_now (vm);
458 vlib_worker_thread_barrier_release (vm);
466 VLIB_CLI_COMMAND (clear_node_runtime_command, static) = {
467 .path = "clear runtime",
468 .short_help = "Clear packet processing runtime statistics",
469 .function = clear_node_runtime,
473 static clib_error_t *
474 show_node (vlib_main_t * vm, unformat_input_t * input,
475 vlib_cli_command_t * cmd)
477 unformat_input_t _line_input, *line_input = &_line_input;
478 clib_error_t *error = 0;
479 vlib_node_main_t *nm = &vm->node_main;
482 u32 i, node_index = ~0;
484 u8 valid_node_name = 0;
486 if (!unformat_user (input, unformat_line_input, line_input))
489 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
491 if (unformat (line_input, "index %u", &node_index))
494 if (unformat (line_input, "%U", unformat_vlib_node, vm, &node_index))
496 else if (!valid_node_name)
497 error = clib_error_return (0, "unknown node name: '%U'",
498 format_unformat_error, line_input);
500 error = clib_error_return (0, "unknown input '%U'",
501 format_unformat_error, line_input);
504 unformat_free (line_input);
509 if (node_index >= vec_len (vm->node_main.nodes))
510 return clib_error_return (0, "please specify valid node");
512 n = vlib_get_node (vm, node_index);
513 vlib_node_sync_stats (vm, n);
517 case VLIB_NODE_TYPE_INTERNAL:
518 type_str = "internal";
520 case VLIB_NODE_TYPE_INPUT:
523 case VLIB_NODE_TYPE_PRE_INPUT:
524 type_str = "pre-input";
526 case VLIB_NODE_TYPE_PROCESS:
527 type_str = "process";
530 type_str = "unknown";
534 s = format (s, ", sibling-of %s", n->sibling_of);
536 vlib_cli_output (vm, "node %s, type %s, state %U, index %d%v\n",
537 n->name, type_str, format_vlib_node_state, vm, n,
539 vec_reset_length (s);
541 if (n->node_fn_registrations)
543 vlib_node_fn_registration_t *fnr = n->node_fn_registrations;
546 if (vec_len (s) == 0)
547 s = format (s, "\n %-15s %=8s %6s",
548 "Name", "Priority", "Active");
549 s = format (s, "\n %-15s %=8u %=6s", fnr->name, fnr->priority,
550 fnr->function == n->function ? "yes" : "");
551 fnr = fnr->next_registration;
555 s = format (s, "\n default only");
556 vlib_cli_output (vm, " node function variants:%v\n", s);
557 vec_reset_length (s);
559 for (i = 0; i < vec_len (n->next_nodes); i++)
562 if (n->next_nodes[i] == VLIB_INVALID_NODE_INDEX)
565 pn = vec_elt (nm->nodes, n->next_nodes[i]);
567 if (vec_len (s) == 0)
568 s = format (s, "\n %10s %10s %=30s %8s",
569 "next-index", "node-index", "Node", "Vectors");
571 s = format (s, "\n %=10u %=10u %-30v %=8llu", i, n->next_nodes[i],
572 pn->name, vec_elt (n->n_vectors_by_next_node, i));
575 if (vec_len (s) == 0)
576 s = format (s, "\n none");
577 vlib_cli_output (vm, "\n next nodes:%v\n", s);
578 vec_reset_length (s);
580 if (n->type == VLIB_NODE_TYPE_INTERNAL)
584 clib_bitmap_foreach (i, n->prev_node_bitmap, ({
585 vlib_node_t *pn = vlib_get_node (vm, i);
587 s = format (s, "\n ");
588 s2 = format (s2, "%v (%u)", pn->name, i);
589 s = format (s, "%-35v", s2);
590 vec_reset_length (s2);
594 if (vec_len (s) == 0)
595 s = format (s, "\n none");
596 vlib_cli_output (vm, "\n known previous nodes:%v\n", s);
597 vec_reset_length (s);
606 VLIB_CLI_COMMAND (show_node_command, static) = {
608 .short_help = "show node [index] <node-name | node-index>",
609 .function = show_node,
612 static clib_error_t *
613 set_node_fn(vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
615 unformat_input_t _line_input, *line_input = &_line_input;
618 clib_error_t *err = 0;
619 vlib_node_fn_registration_t *fnr;
622 if (!unformat_user (input, unformat_line_input, line_input))
625 if (!unformat (line_input, "%U", unformat_vlib_node, vm, &node_index))
627 err = clib_error_return (0, "please specify valid node name");
631 if (!unformat (line_input, "%s", &variant))
633 err = clib_error_return (0, "please specify node functional variant");
637 n = vlib_get_node (vm, node_index);
639 if (n->node_fn_registrations == 0)
641 err = clib_error_return (0, "node doesn't have functional variants");
645 fnr = n->node_fn_registrations;
646 vec_add1 (variant, 0);
650 if (!strncmp (fnr->name, (char *) variant, vec_len (variant) - 1))
654 n->function = fnr->function;
656 for (i = 0; i < vec_len (vlib_mains); i++)
658 vlib_node_runtime_t *nrt;
659 nrt = vlib_node_get_runtime (vlib_mains[i], n->index);
660 nrt->function = fnr->function;
664 fnr = fnr->next_registration;
667 err = clib_error_return (0, "node functional variant '%s' not found", variant);
671 unformat_free (line_input);
676 VLIB_CLI_COMMAND (set_node_fn_command, static) = {
677 .path = "set node function",
678 .short_help = "set node function <node-name> <variant-name>",
679 .function = set_node_fn,
683 /* Dummy function to get us linked in. */
685 vlib_node_cli_reference (void)
690 * fd.io coding-style-patch-verification: ON
693 * eval: (c-set-style "gnu")