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 * cli.c: command line interface
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/unix/unix.h>
42 #include <vppinfra/callback.h>
43 #include <vppinfra/cpu.h>
44 #include <vppinfra/elog.h>
48 /** \file src/vlib/cli.c Debug CLI Implementation
51 int vl_api_set_elog_trace_api_messages (int enable);
52 int vl_api_get_elog_trace_api_messages (void);
54 static void *current_traced_heap;
56 /* Root of all show commands. */
58 VLIB_CLI_COMMAND (vlib_cli_show_command, static) = {
60 .short_help = "Show commands",
64 /* Root of all clear commands. */
66 VLIB_CLI_COMMAND (vlib_cli_clear_command, static) = {
68 .short_help = "Clear commands",
72 /* Root of all set commands. */
74 VLIB_CLI_COMMAND (vlib_cli_set_command, static) = {
76 .short_help = "Set commands",
80 /* Root of all test commands. */
82 VLIB_CLI_COMMAND (vlib_cli_test_command, static) = {
84 .short_help = "Test commands",
88 /* Returns bitmap of commands which match key. */
90 vlib_cli_sub_command_match (vlib_cli_command_t * c, unformat_input_t * input)
94 vlib_cli_parse_position_t *p;
96 unformat_skip_white_space (input);
102 k = unformat_get_input (input);
116 case UNFORMAT_END_OF_INPUT:
117 /* White space or end of input removes any non-white
118 matches that were before possible. */
119 if (i < vec_len (c->sub_command_positions)
120 && clib_bitmap_count_set_bits (match) > 1)
122 p = vec_elt_at_index (c->sub_command_positions, i);
123 for (n = 0; n < vec_len (p->bitmaps); n++)
124 match = clib_bitmap_andnot (match, p->bitmaps[n]);
129 unformat_put_input (input);
133 if (i >= vec_len (c->sub_command_positions))
136 clib_bitmap_free (match);
140 p = vec_elt_at_index (c->sub_command_positions, i);
141 if (vec_len (p->bitmaps) == 0)
145 if (n < 0 || n >= vec_len (p->bitmaps))
149 match = clib_bitmap_dup (p->bitmaps[n]);
151 match = clib_bitmap_and (match, p->bitmaps[n]);
153 if (clib_bitmap_is_zero (match))
161 /* Looks for string based sub-input formatted { SUB-INPUT }. */
163 unformat_vlib_cli_sub_input (unformat_input_t * i, va_list * args)
165 unformat_input_t *sub_input = va_arg (*args, unformat_input_t *);
171 c = unformat_get_input (i);
183 /* Put back paren. */
184 if (c != UNFORMAT_END_OF_INPUT)
185 unformat_put_input (i);
187 if (c == '{' && unformat (i, "%v", &s))
189 unformat_init_vector (sub_input, s);
198 static vlib_cli_command_t *
199 get_sub_command (vlib_cli_main_t * cm, vlib_cli_command_t * parent, u32 si)
201 vlib_cli_sub_command_t *s = vec_elt_at_index (parent->sub_commands, si);
202 return vec_elt_at_index (cm->commands, s->index);
206 unformat_vlib_cli_sub_command (unformat_input_t * i, va_list * args)
208 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
209 vlib_cli_command_t *c = va_arg (*args, vlib_cli_command_t *);
210 vlib_cli_command_t **result = va_arg (*args, vlib_cli_command_t **);
211 vlib_cli_main_t *cm = &vm->cli_main;
212 uword *match_bitmap, is_unique, index;
214 match_bitmap = vlib_cli_sub_command_match (c, i);
215 is_unique = clib_bitmap_count_set_bits (match_bitmap) == 1;
219 index = clib_bitmap_first_set (match_bitmap);
220 *result = get_sub_command (cm, c, index);
222 clib_bitmap_free (match_bitmap);
228 vlib_cli_cmp_strings (void *a1, void *a2)
230 u8 *c1 = *(u8 **) a1;
231 u8 *c2 = *(u8 **) a2;
233 return vec_cmp (c1, c2);
237 vlib_cli_get_possible_completions (u8 * str)
239 vlib_cli_command_t *c;
240 vlib_cli_sub_command_t *sc;
241 vlib_main_t *vm = vlib_get_main ();
242 vlib_cli_main_t *vcm = &vm->cli_main;
243 uword *match_bitmap = 0;
244 uword index, is_unique, help_next_level;
246 unformat_input_t input;
247 unformat_init_vector (&input, vec_dup (str));
248 c = vec_elt_at_index (vcm->commands, 0);
250 /* remove trailing whitespace, except for one of them */
251 while (vec_len (input.buffer) >= 2 &&
252 isspace (input.buffer[vec_len (input.buffer) - 1]) &&
253 isspace (input.buffer[vec_len (input.buffer) - 2]))
255 vec_del1 (input.buffer, vec_len (input.buffer) - 1);
258 /* if input is empty, directly return list of root commands */
259 if (vec_len (input.buffer) == 0 ||
260 (vec_len (input.buffer) == 1 && isspace (input.buffer[0])))
262 vec_foreach (sc, c->sub_commands)
264 vec_add1 (result, (u8 *) sc->name);
269 /* add a trailing '?' so that vlib_cli_sub_command_match can find
270 * all commands starting with the input string */
271 vec_add1 (input.buffer, '?');
275 match_bitmap = vlib_cli_sub_command_match (c, &input);
276 /* no match: return no result */
277 if (match_bitmap == 0)
281 is_unique = clib_bitmap_count_set_bits (match_bitmap) == 1;
282 /* unique match: try to step one subcommand level further */
285 /* stop if no more input */
286 if (input.index >= vec_len (input.buffer) - 1)
291 index = clib_bitmap_first_set (match_bitmap);
292 c = get_sub_command (vcm, c, index);
293 clib_bitmap_free (match_bitmap);
296 /* multiple matches: stop here, return all matches */
300 /* remove trailing '?' */
301 vec_del1 (input.buffer, vec_len (input.buffer) - 1);
303 /* if we have a space at the end of input, and a unique match,
304 * autocomplete the next level of subcommands */
305 help_next_level = (vec_len (str) == 0) || isspace (str[vec_len (str) - 1]);
307 clib_bitmap_foreach (index, match_bitmap) {
308 if (help_next_level && is_unique) {
309 c = get_sub_command (vcm, c, index);
310 vec_foreach (sc, c->sub_commands) {
311 vec_add1 (result, (u8*) sc->name);
313 goto done; /* break doesn't work in this macro-loop */
315 sc = &c->sub_commands[index];
316 vec_add1(result, (u8*) sc->name);
321 clib_bitmap_free (match_bitmap);
322 unformat_free (&input);
325 vec_sort_with_function (result, vlib_cli_cmp_strings);
330 format_vlib_cli_command_help (u8 * s, va_list * args)
332 vlib_cli_command_t *c = va_arg (*args, vlib_cli_command_t *);
333 int is_long = va_arg (*args, int);
334 if (is_long && c->long_help)
335 s = format (s, "%s", c->long_help);
336 else if (c->short_help)
337 s = format (s, "%s", c->short_help);
339 s = format (s, "%v commands", c->path);
344 format_vlib_cli_path (u8 * s, va_list * args)
346 u8 *path = va_arg (*args, u8 *);
348 s = format (s, "%v", path);
353 static vlib_cli_command_t *
354 all_subs (vlib_cli_main_t * cm, vlib_cli_command_t * subs, u32 command_index)
356 vlib_cli_command_t *c = vec_elt_at_index (cm->commands, command_index);
357 vlib_cli_sub_command_t *sc;
360 vec_add1 (subs, c[0]);
362 vec_foreach (sc, c->sub_commands) subs = all_subs (cm, subs, sc->index);
368 vlib_cli_cmp_rule (void *a1, void *a2)
370 vlib_cli_sub_rule_t *r1 = a1;
371 vlib_cli_sub_rule_t *r2 = a2;
373 return vec_cmp (r1->name, r2->name);
377 vlib_cli_cmp_command (void *a1, void *a2)
379 vlib_cli_command_t *c1 = a1;
380 vlib_cli_command_t *c2 = a2;
382 return vec_cmp (c1->path, c2->path);
385 static clib_error_t *
386 vlib_cli_dispatch_sub_commands (vlib_main_t * vm,
387 vlib_cli_main_t * cm,
388 unformat_input_t * input,
389 uword parent_command_index)
391 vlib_cli_command_t *parent, *c;
392 clib_error_t *error = 0;
393 unformat_input_t sub_input;
395 uword is_main_dispatch = cm == &vm->cli_main;
397 parent = vec_elt_at_index (cm->commands, parent_command_index);
398 if (is_main_dispatch && unformat (input, "help"))
400 uword help_at_end_of_line, i;
402 help_at_end_of_line =
403 unformat_check_input (input) == UNFORMAT_END_OF_INPUT;
408 (input, unformat_vlib_cli_sub_command, vm, c, &parent))
411 else if (!(unformat_check_input (input) == UNFORMAT_END_OF_INPUT))
418 /* help SUB-COMMAND => long format help.
419 "help" at end of line: show all commands. */
420 if (!help_at_end_of_line)
421 vlib_cli_output (vm, "%U", format_vlib_cli_command_help, c,
424 else if (vec_len (c->sub_commands) == 0)
425 vlib_cli_output (vm, "%v: no sub-commands", c->path);
429 vlib_cli_sub_rule_t *sr, *subs = 0;
430 vlib_cli_sub_command_t *sc;
432 vec_foreach (sc, c->sub_commands)
434 vec_add2 (subs, sr, 1);
436 sr->command_index = sc->index;
440 vec_sort_with_function (subs, vlib_cli_cmp_rule);
442 for (i = 0; i < vec_len (subs); i++)
444 vlib_cli_command_t *d;
446 d = vec_elt_at_index (cm->commands, subs[i].command_index);
448 (vm, " %-30v %U", subs[i].name,
449 format_vlib_cli_command_help, d, /* is_long */ 0);
456 else if (is_main_dispatch
457 && (unformat (input, "choices") || unformat (input, "?")))
459 vlib_cli_command_t *sub, *subs;
461 subs = all_subs (cm, 0, parent_command_index);
462 vec_sort_with_function (subs, vlib_cli_cmp_command);
463 vec_foreach (sub, subs)
464 vlib_cli_output (vm, " %-40U %U",
465 format_vlib_cli_path, sub->path,
466 format_vlib_cli_command_help, sub, /* is_long */ 0);
470 else if (unformat (input, "comment %v", &string))
475 else if (unformat (input, "vpplog %v", &string))
479 * Delete leading whitespace, so "vpplog { this and that }"
480 * and "vpplog this" line up nicely.
482 for (i = 0; i < vec_len (string); i++)
483 if (string[i] != ' ')
486 vec_delete (string, i, 0);
488 vlib_log_notice (cm->log, "CLI: %v", string);
492 else if (unformat (input, "uncomment %U",
493 unformat_vlib_cli_sub_input, &sub_input))
496 vlib_cli_dispatch_sub_commands (vm, cm, &sub_input,
497 parent_command_index);
498 unformat_free (&sub_input);
500 else if (unformat (input, "leak-check %U",
501 unformat_vlib_cli_sub_input, &sub_input))
504 if (current_traced_heap)
507 oldheap = clib_mem_set_heap (current_traced_heap);
509 clib_mem_set_heap (oldheap);
510 current_traced_heap = 0;
514 vlib_cli_dispatch_sub_commands (vm, cm, &sub_input,
515 parent_command_index);
516 unformat_free (&sub_input);
518 /* Otherwise, the clib_error_t shows up as a leak... */
521 vlib_cli_output (vm, "%v", error->what);
522 clib_error_free (error);
526 (void) clib_mem_trace_enable_disable (0);
527 leak_report = format (0, "%U", format_clib_mem_heap, 0,
528 1 /* verbose, i.e. print leaks */ );
530 vlib_cli_output (vm, "%v", leak_report);
531 vec_free (leak_report);
535 if (unformat_user (input, unformat_vlib_cli_sub_command, vm, parent, &c))
537 unformat_input_t *si;
538 uword has_sub_commands =
539 vec_len (c->sub_commands) + vec_len (c->sub_rules) > 0;
542 if (unformat_user (input, unformat_vlib_cli_sub_input, &sub_input))
545 if (has_sub_commands)
546 error = vlib_cli_dispatch_sub_commands (vm, cm, si, c - cm->commands);
548 if (has_sub_commands && !error)
549 /* Found valid sub-command. */ ;
551 else if (c->function)
553 clib_error_t *c_error;
555 /* Skip white space for benefit of called function. */
556 unformat_skip_white_space (si);
558 if (unformat (si, "?"))
560 vlib_cli_output (vm, " %-40U %U", format_vlib_cli_path, c->path, format_vlib_cli_command_help, c, /* is_long */
565 if (PREDICT_FALSE (vm->elog_trace_cli_commands))
568 ELOG_TYPE_DECLARE (e) =
570 .format = "cli-cmd: %s",
578 ed = ELOG_DATA (&vm->elog_main, e);
579 ed->c = elog_string (&vm->elog_main, "%v", c->path);
583 vlib_worker_thread_barrier_sync (vm);
584 if (PREDICT_FALSE (vec_len (cm->perf_counter_cbs) != 0))
585 clib_call_callbacks (cm->perf_counter_cbs, cm,
586 c - cm->commands, 0 /* before */ );
589 c_error = c->function (vm, si, c);
591 if (PREDICT_FALSE (vec_len (cm->perf_counter_cbs) != 0))
592 clib_call_callbacks (cm->perf_counter_cbs, cm,
593 c - cm->commands, 1 /* after */ );
595 vlib_worker_thread_barrier_release (vm);
597 if (PREDICT_FALSE (vm->elog_trace_cli_commands))
600 ELOG_TYPE_DECLARE (e) =
602 .format = "cli-cmd: %s %s",
603 .format_args = "T4T4",
610 ed = ELOG_DATA (&vm->elog_main, e);
611 ed->c = elog_string (&vm->elog_main, "%v", c->path);
614 vec_add1 (c_error->what, 0);
616 elog_string (&vm->elog_main, (char *) c_error->what);
617 _vec_len (c_error->what) -= 1;
620 ed->err = elog_string (&vm->elog_main, "OK");
626 clib_error_return (0, "%v: %v", c->path, c_error->what);
627 clib_error_free (c_error);
628 /* Free sub input. */
636 /* Free any previous error. */
637 clib_error_free (error);
641 error = clib_error_return (0, "%v: no sub-commands", c->path);
643 /* Free sub input. */
655 return clib_error_return (0, "%v: unknown input `%U'", parent->path,
656 format_unformat_error, input);
658 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
663 void vlib_unix_error_report (vlib_main_t *, clib_error_t *)
664 __attribute__ ((weak));
667 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
671 /* Process CLI input. */
673 vlib_cli_input (vlib_main_t * vm,
674 unformat_input_t * input,
675 vlib_cli_output_function_t * function, uword function_arg)
677 vlib_process_t *cp = vlib_get_current_process (vm);
679 vlib_cli_output_function_t *save_function;
680 uword save_function_arg;
683 save_function = cp->output_function;
684 save_function_arg = cp->output_function_arg;
686 cp->output_function = function;
687 cp->output_function_arg = function_arg;
691 error = vlib_cli_dispatch_sub_commands (vm, &vm->cli_main, input,
694 while (!error && !unformat (input, "%U", unformat_eof));
698 vlib_cli_output (vm, "%v", error->what);
699 vlib_unix_error_report (vm, error);
700 /* clib_error_return is unfortunately often called with a '0'
702 rv = error->code != 0 ? error->code : -1;
703 clib_error_free (error);
706 cp->output_function = save_function;
707 cp->output_function_arg = save_function_arg;
711 /* Output to current CLI connection. */
713 vlib_cli_output (vlib_main_t * vm, char *fmt, ...)
715 vlib_process_t *cp = vlib_get_current_process (vm);
720 s = va_format (0, fmt, &va);
723 /* some format functions might return 0
724 * e.g. show int addr */
728 /* Terminate with \n if not present. */
729 if (vec_len (s) > 0 && s[vec_len (s) - 1] != '\n')
732 if ((!cp) || (!cp->output_function))
733 fformat (stdout, "%v", s);
735 cp->output_function (cp->output_function_arg, s, vec_len (s));
740 void *vl_msg_push_heap (void) __attribute__ ((weak));
742 vl_msg_push_heap (void)
747 void vl_msg_pop_heap (void *oldheap) __attribute__ ((weak));
749 vl_msg_pop_heap (void *oldheap)
753 void *vlib_stats_push_heap (void *) __attribute__ ((weak));
755 vlib_stats_push_heap (void *notused)
760 static clib_error_t *
761 show_memory_usage (vlib_main_t * vm,
762 unformat_input_t * input, vlib_cli_command_t * cmd)
764 clib_mem_main_t *mm = &clib_mem_main;
765 int verbose __attribute__ ((unused)) = 0;
766 int api_segment = 0, stats_segment = 0, main_heap = 0, numa_heaps = 0;
771 uword clib_mem_trace_enable_disable (uword enable);
775 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
777 if (unformat (input, "verbose"))
779 else if (unformat (input, "api-segment"))
781 else if (unformat (input, "stats-segment"))
783 else if (unformat (input, "main-heap"))
785 else if (unformat (input, "numa-heaps"))
787 else if (unformat (input, "map"))
791 error = clib_error_return (0, "unknown input `%U'",
792 format_unformat_error, input);
797 if ((api_segment + stats_segment + main_heap + numa_heaps + map) == 0)
798 return clib_error_return
799 (0, "Need one of api-segment, stats-segment, main-heap, numa-heaps "
804 void *oldheap = vl_msg_push_heap ();
805 was_enabled = clib_mem_trace_enable_disable (0);
806 u8 *s_in_svm = format (0, "%U\n", format_clib_mem_heap, 0, 1);
807 vl_msg_pop_heap (oldheap);
808 u8 *s = vec_dup (s_in_svm);
810 oldheap = vl_msg_push_heap ();
812 clib_mem_trace_enable_disable (was_enabled);
813 vl_msg_pop_heap (oldheap);
814 vlib_cli_output (vm, "API segment");
815 vlib_cli_output (vm, "%v", s);
820 void *oldheap = vlib_stats_push_heap (0);
821 was_enabled = clib_mem_trace_enable_disable (0);
822 u8 *s_in_svm = format (0, "%U\n", format_clib_mem_heap, 0, 1);
824 clib_mem_set_heap (oldheap);
825 u8 *s = vec_dup (s_in_svm);
827 oldheap = vlib_stats_push_heap (0);
831 clib_mem_trace_enable_disable (was_enabled);
832 clib_mem_set_heap (oldheap);
834 vlib_cli_output (vm, "Stats segment");
835 vlib_cli_output (vm, "%v", s);
844 * Note: the foreach_vlib_main causes allocator traffic,
845 * so shut off tracing before we go there...
847 was_enabled = clib_mem_trace_enable_disable (0);
852 vlib_cli_output (vm, "%sThread %d %s\n", index ? "\n":"", index,
853 vlib_worker_threads[index].name);
854 vlib_cli_output (vm, " %U\n", format_clib_mem_heap,
855 mm->per_cpu_mheaps[index],
861 /* Restore the trace flag */
862 clib_mem_trace_enable_disable (was_enabled);
866 for (i = 0; i < ARRAY_LEN (mm->per_numa_mheaps); i++)
868 if (mm->per_numa_mheaps[i] == 0)
870 if (mm->per_numa_mheaps[i] == mm->per_cpu_mheaps[i])
872 vlib_cli_output (vm, "Numa %d uses the main heap...", i);
875 was_enabled = clib_mem_trace_enable_disable (0);
877 vlib_cli_output (vm, "Numa %d:", i);
878 vlib_cli_output (vm, " %U\n", format_clib_mem_heap,
879 mm->per_numa_mheaps[index], verbose);
884 clib_mem_page_stats_t stats = { };
885 clib_mem_vm_map_hdr_t *hdr = 0;
889 s = format (s, "\n%-16s%7s%5s%7s%7s",
890 "StartAddr", "size", "FD", "PageSz", "Pages");
891 while ((numa = vlib_mem_get_next_numa_node (numa)) != -1)
892 s = format (s, " Numa%u", numa);
893 s = format (s, " NotMap");
894 s = format (s, " Name");
895 vlib_cli_output (vm, "%v", s);
896 vec_reset_length (s);
898 while ((hdr = clib_mem_vm_get_next_map_hdr (hdr)))
900 clib_mem_get_page_stats ((void *) hdr->base_addr,
901 hdr->log2_page_sz, hdr->num_pages,
903 s = format (s, "%016lx%7U",
904 hdr->base_addr, format_memory_size,
905 hdr->num_pages << hdr->log2_page_sz);
908 s = format (s, "%5d", hdr->fd);
910 s = format (s, "%5s", " ");
912 s = format (s, "%7U%7lu",
913 format_log2_page_size, hdr->log2_page_sz,
915 while ((numa = vlib_mem_get_next_numa_node (numa)) != -1)
916 s = format (s, "%6lu", stats.per_numa[numa]);
917 s = format (s, "%7lu", stats.not_mapped);
918 s = format (s, " %s", hdr->name);
919 vlib_cli_output (vm, "%v", s);
920 vec_reset_length (s);
929 VLIB_CLI_COMMAND (show_memory_usage_command, static) = {
930 .path = "show memory",
931 .short_help = "show memory [api-segment][stats-segment][verbose]\n"
932 " [numa-heaps][map]",
933 .function = show_memory_usage,
937 static clib_error_t *
938 show_cpu (vlib_main_t * vm, unformat_input_t * input,
939 vlib_cli_command_t * cmd)
941 #define _(a,b,c) vlib_cli_output (vm, "%-25s " b, a ":", c);
942 _("Model name", "%U", format_cpu_model_name);
943 _("Microarch model (family)", "%U", format_cpu_uarch);
944 _("Flags", "%U", format_cpu_flags);
945 _("Base frequency", "%.2f GHz",
946 ((f64) vm->clib_time.clocks_per_second) * 1e-9);
952 * Displays various information about the CPU.
955 * @cliexstart{show cpu}
956 * Model name: Intel(R) Xeon(R) CPU E5-2667 v4 @ 3.20GHz
957 * Microarchitecture: Broadwell (Broadwell-EP/EX)
958 * Flags: sse3 ssse3 sse41 sse42 avx avx2 aes
959 * Base Frequency: 3.20 GHz
963 VLIB_CLI_COMMAND (show_cpu_command, static) = {
965 .short_help = "Show cpu information",
966 .function = show_cpu,
970 static clib_error_t *
971 enable_disable_memory_trace (vlib_main_t * vm,
972 unformat_input_t * input,
973 vlib_cli_command_t * cmd)
975 clib_mem_main_t *mm = &clib_mem_main;
976 unformat_input_t _line_input, *line_input = &_line_input;
979 int stats_segment = 0;
984 if (!unformat_user (input, unformat_line_input, line_input))
987 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
989 if (unformat (line_input, "%U", unformat_vlib_enable_disable, &enable))
991 else if (unformat (line_input, "api-segment"))
993 else if (unformat (line_input, "stats-segment"))
995 else if (unformat (line_input, "main-heap"))
997 else if (unformat (line_input, "numa-heap %d", &numa_id))
1001 unformat_free (line_input);
1002 return clib_error_return (0, "invalid input");
1005 unformat_free (line_input);
1007 if ((api_segment + stats_segment + main_heap + (enable == 0)
1008 + (numa_id != ~0)) == 0)
1010 return clib_error_return
1011 (0, "Need one of main-heap, stats-segment, api-segment,\n"
1012 "numa-heap <nn> or disable");
1015 /* Turn off current trace, if any */
1016 if (current_traced_heap)
1019 oldheap = clib_mem_set_heap (current_traced_heap);
1021 clib_mem_set_heap (oldheap);
1022 current_traced_heap = 0;
1031 oldheap = vl_msg_push_heap ();
1032 current_traced_heap = clib_mem_get_heap ();
1034 vl_msg_pop_heap (oldheap);
1041 oldheap = vlib_stats_push_heap (0);
1042 current_traced_heap = clib_mem_get_heap ();
1043 clib_mem_trace (stats_segment);
1044 /* We don't want to call vlib_stats_pop_heap... */
1046 clib_mem_set_heap (oldheap);
1052 current_traced_heap = clib_mem_get_heap ();
1053 clib_mem_trace (main_heap);
1058 if (numa_id >= ARRAY_LEN (mm->per_numa_mheaps))
1059 return clib_error_return (0, "Numa %d out of range", numa_id);
1060 if (mm->per_numa_mheaps[numa_id] == 0)
1061 return clib_error_return (0, "Numa %d heap not active", numa_id);
1063 if (mm->per_numa_mheaps[numa_id] == clib_mem_get_heap ())
1064 return clib_error_return (0, "Numa %d uses the main heap...",
1066 current_traced_heap = mm->per_numa_mheaps[numa_id];
1067 oldheap = clib_mem_set_heap (current_traced_heap);
1069 clib_mem_set_heap (oldheap);
1077 VLIB_CLI_COMMAND (enable_disable_memory_trace_command, static) = {
1078 .path = "memory-trace",
1079 .short_help = "memory-trace on|off [api-segment][stats-segment][main-heap]\n"
1080 " [numa-heap <numa-id>]\n",
1081 .function = enable_disable_memory_trace,
1085 static clib_error_t *
1086 restart_cmd_fn (vlib_main_t * vm, unformat_input_t * input,
1087 vlib_cli_command_t * cmd)
1089 clib_file_main_t *fm = &file_main;
1092 /* environ(7) does not indicate a header for this */
1093 extern char **environ;
1095 /* Close all known open files */
1097 pool_foreach (f, fm->file_pool)
1099 if (f->file_descriptor > 2)
1100 close(f->file_descriptor);
1105 execve (vm->name, (char **) vm->argv, environ);
1111 VLIB_CLI_COMMAND (restart_cmd,static) = {
1113 .short_help = "restart process",
1114 .function = restart_cmd_fn,
1120 * A trivial test harness to verify the per-process output_function
1121 * is working correcty.
1124 static clib_error_t *
1125 sleep_ten_seconds (vlib_main_t * vm,
1126 unformat_input_t * input, vlib_cli_command_t * cmd)
1129 u16 my_id = rand ();
1131 vlib_cli_output (vm, "Starting 10 seconds sleep with id %u\n", my_id);
1133 for (i = 0; i < 10; i++)
1135 vlib_process_wait_for_event_or_clock (vm, 1.0);
1136 vlib_cli_output (vm, "Iteration number %u, my id: %u\n", i, my_id);
1138 vlib_cli_output (vm, "Done with sleep with id %u\n", my_id);
1143 VLIB_CLI_COMMAND (ping_command, static) = {
1144 .path = "test sleep",
1145 .function = sleep_ten_seconds,
1146 .short_help = "Sleep for 10 seconds",
1149 #endif /* ifdef TEST_CODE */
1152 vlib_cli_normalize_path (char *input, char **result)
1157 uword index_of_last_space = ~0;
1162 /* Multiple white space -> single space. */
1169 if (l > 0 && s[l - 1] != ' ')
1177 if (l > 0 && s[l - 1] == ' ')
1178 index_of_last_space = vec_len (s);
1185 /* Remove any extra space at end. */
1186 if (l > 0 && s[l - 1] == ' ')
1190 return index_of_last_space;
1194 parent_path_len (char *path)
1197 for (i = vec_len (path) - 1; i >= 0; i--)
1206 add_sub_command (vlib_cli_main_t * cm, uword parent_index, uword child_index)
1208 vlib_cli_command_t *p, *c;
1209 vlib_cli_sub_command_t *sub_c;
1213 p = vec_elt_at_index (cm->commands, parent_index);
1214 c = vec_elt_at_index (cm->commands, child_index);
1216 l = parent_path_len (c->path);
1218 sub_name = vec_dup ((u8 *) c->path);
1221 ASSERT (l + 1 < vec_len (c->path));
1223 vec_add (sub_name, c->path + l + 1, vec_len (c->path) - (l + 1));
1226 if (sub_name[0] == '%')
1229 vlib_cli_sub_rule_t *sr;
1232 vec_delete (sub_name, 1, 0);
1234 if (!p->sub_rule_index_by_name)
1235 p->sub_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1236 sizeof (sub_name[0]),
1238 q = hash_get_mem (p->sub_rule_index_by_name, sub_name);
1241 sr = vec_elt_at_index (p->sub_rules, q[0]);
1242 ASSERT (sr->command_index == child_index);
1246 hash_set_mem (p->sub_rule_index_by_name, sub_name,
1247 vec_len (p->sub_rules));
1248 vec_add2 (p->sub_rules, sr, 1);
1249 sr->name = sub_name;
1250 sr->rule_index = sr - p->sub_rules;
1251 sr->command_index = child_index;
1255 if (!p->sub_command_index_by_name)
1256 p->sub_command_index_by_name = hash_create_vec ( /* initial length */ 32,
1257 sizeof (c->path[0]),
1260 /* Check if sub-command has already been created. */
1261 if (hash_get_mem (p->sub_command_index_by_name, sub_name))
1263 vec_free (sub_name);
1267 vec_add2 (p->sub_commands, sub_c, 1);
1268 sub_c->index = child_index;
1269 sub_c->name = sub_name;
1270 hash_set_mem (p->sub_command_index_by_name, sub_c->name,
1271 sub_c - p->sub_commands);
1273 vec_validate (p->sub_command_positions, vec_len (sub_c->name) - 1);
1274 for (i = 0; i < vec_len (sub_c->name); i++)
1277 vlib_cli_parse_position_t *pos;
1279 pos = vec_elt_at_index (p->sub_command_positions, i);
1282 pos->min_char = sub_c->name[i];
1284 n = sub_c->name[i] - pos->min_char;
1287 pos->min_char = sub_c->name[i];
1288 vec_insert (pos->bitmaps, -n, 0);
1292 vec_validate (pos->bitmaps, n);
1294 clib_bitmap_ori (pos->bitmaps[n], sub_c - p->sub_commands);
1299 vlib_cli_make_parent (vlib_cli_main_t * cm, uword ci)
1301 uword p_len, pi, *p;
1303 vlib_cli_command_t *c, *parent;
1305 /* Root command (index 0) should have already been added. */
1306 ASSERT (vec_len (cm->commands) > 0);
1308 c = vec_elt_at_index (cm->commands, ci);
1309 p_len = parent_path_len (c->path);
1311 /* No space? Parent is root command. */
1314 add_sub_command (cm, 0, ci);
1319 vec_add (p_path, c->path, p_len);
1321 p = hash_get_mem (cm->command_index_by_path, p_path);
1323 /* Parent exists? */
1326 /* Parent does not exist; create it. */
1327 vec_add2 (cm->commands, parent, 1);
1328 parent->path = p_path;
1329 hash_set_mem (cm->command_index_by_path, parent->path,
1330 parent - cm->commands);
1331 pi = parent - cm->commands;
1339 add_sub_command (cm, pi, ci);
1341 /* Create parent's parent. */
1343 vlib_cli_make_parent (cm, pi);
1347 vlib_cli_command_is_empty (vlib_cli_command_t * c)
1349 return (c->long_help == 0 && c->short_help == 0 && c->function == 0);
1353 vlib_cli_register (vlib_main_t * vm, vlib_cli_command_t * c)
1355 vlib_cli_main_t *cm = &vm->cli_main;
1356 clib_error_t *error = 0;
1358 char *normalized_path;
1360 if ((error = vlib_call_init_function (vm, vlib_cli_init)))
1363 (void) vlib_cli_normalize_path (c->path, &normalized_path);
1365 if (!cm->command_index_by_path)
1366 cm->command_index_by_path = hash_create_vec ( /* initial length */ 32,
1367 sizeof (c->path[0]),
1370 /* See if command already exists with given path. */
1371 p = hash_get_mem (cm->command_index_by_path, normalized_path);
1374 vlib_cli_command_t *d;
1377 d = vec_elt_at_index (cm->commands, ci);
1379 /* If existing command was created via vlib_cli_make_parent
1380 replaced it with callers data. */
1381 if (vlib_cli_command_is_empty (d))
1383 vlib_cli_command_t save = d[0];
1385 ASSERT (!vlib_cli_command_is_empty (c));
1387 /* Copy callers fields. */
1390 /* Save internal fields. */
1391 d->path = save.path;
1392 d->sub_commands = save.sub_commands;
1393 d->sub_command_index_by_name = save.sub_command_index_by_name;
1394 d->sub_command_positions = save.sub_command_positions;
1395 d->sub_rules = save.sub_rules;
1399 clib_error_return (0, "duplicate command name with path %v",
1402 vec_free (normalized_path);
1408 /* Command does not exist: create it. */
1410 /* Add root command (index 0). */
1411 if (vec_len (cm->commands) == 0)
1413 /* Create command with index 0; path is empty string. */
1414 vec_resize (cm->commands, 1);
1417 ci = vec_len (cm->commands);
1418 hash_set_mem (cm->command_index_by_path, normalized_path, ci);
1419 vec_add1 (cm->commands, c[0]);
1421 c = vec_elt_at_index (cm->commands, ci);
1422 c->path = normalized_path;
1424 /* Don't inherit from registration. */
1425 c->sub_commands = 0;
1426 c->sub_command_index_by_name = 0;
1427 c->sub_command_positions = 0;
1430 vlib_cli_make_parent (cm, ci);
1435 /* $$$ turn back on again someday, maybe */
1437 vlib_cli_register_parse_rule (vlib_main_t * vm, vlib_cli_parse_rule_t * r_reg)
1439 vlib_cli_main_t *cm = &vm->cli_main;
1440 vlib_cli_parse_rule_t *r;
1441 clib_error_t *error = 0;
1445 if (!cm->parse_rule_index_by_name)
1446 cm->parse_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1447 sizeof (r->name[0]),
1450 /* Make vector copy of name. */
1451 r_name = format (0, "%s", r_reg->name);
1453 if ((p = hash_get_mem (cm->parse_rule_index_by_name, r_name)))
1456 return clib_error_return (0, "duplicate parse rule name `%s'",
1460 vec_add2 (cm->parse_rules, r, 1);
1462 r->name = (char *) r_name;
1463 hash_set_mem (cm->parse_rule_index_by_name, r->name, r - cm->parse_rules);
1468 static clib_error_t *vlib_cli_register_parse_rules (vlib_main_t * vm,
1469 vlib_cli_parse_rule_t *
1471 vlib_cli_parse_rule_t *
1473 __attribute__ ((unused))
1475 clib_error_t *error = 0;
1476 vlib_cli_parse_rule_t *r;
1478 for (r = lo; r < hi; r = clib_elf_section_data_next (r, 0))
1480 if (!r->name || strlen (r->name) == 0)
1482 error = clib_error_return (0, "parse rule with no name");
1486 error = vlib_cli_register_parse_rule (vm, r);
1496 static clib_error_t *
1497 event_logger_trace_command_fn (vlib_main_t * vm,
1498 unformat_input_t * input,
1499 vlib_cli_command_t * cmd)
1501 unformat_input_t _line_input, *line_input = &_line_input;
1503 int api = 0, cli = 0, barrier = 0, dispatch = 0, circuit = 0;
1504 u32 circuit_node_index;
1506 if (!unformat_user (input, unformat_line_input, line_input))
1509 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1511 if (unformat (line_input, "api"))
1513 else if (unformat (line_input, "dispatch"))
1515 else if (unformat (line_input, "circuit-node %U",
1516 unformat_vlib_node, vm, &circuit_node_index))
1518 else if (unformat (line_input, "cli"))
1520 else if (unformat (line_input, "barrier"))
1522 else if (unformat (line_input, "disable"))
1524 else if (unformat (line_input, "enable"))
1529 unformat_free (line_input);
1531 vl_api_set_elog_trace_api_messages
1532 (api ? enable : vl_api_get_elog_trace_api_messages ());
1533 vm->elog_trace_cli_commands = cli ? enable : vm->elog_trace_cli_commands;
1534 vm->elog_trace_graph_dispatch = dispatch ?
1535 enable : vm->elog_trace_graph_dispatch;
1536 vm->elog_trace_graph_circuit = circuit ?
1537 enable : vm->elog_trace_graph_circuit;
1538 vlib_worker_threads->barrier_elog_enabled =
1539 barrier ? enable : vlib_worker_threads->barrier_elog_enabled;
1540 vm->elog_trace_graph_circuit_node_index = circuit_node_index;
1543 * Set up start-of-buffer logic-analyzer trigger
1544 * for main loop event logs, which are fairly heavyweight.
1545 * See src/vlib/main/vlib_elog_main_loop_event(...), which
1546 * will fully disable the scheme when the elog buffer fills.
1548 if (dispatch || circuit)
1550 elog_main_t *em = &vm->elog_main;
1552 em->n_total_events_disable_limit =
1553 em->n_total_events + vec_len (em->event_ring);
1558 vlib_cli_output (vm, "Current status:");
1561 (vm, " Event log API message trace: %s\n CLI command trace: %s",
1562 vl_api_get_elog_trace_api_messages ()? "on" : "off",
1563 vm->elog_trace_cli_commands ? "on" : "off");
1565 (vm, " Barrier sync trace: %s",
1566 vlib_worker_threads->barrier_elog_enabled ? "on" : "off");
1568 (vm, " Graph Dispatch: %s",
1569 vm->elog_trace_graph_dispatch ? "on" : "off");
1571 (vm, " Graph Circuit: %s",
1572 vm->elog_trace_graph_circuit ? "on" : "off");
1573 if (vm->elog_trace_graph_circuit)
1576 format_vlib_node_name, vm, vm->elog_trace_graph_circuit_node_index);
1582 * Control event logging of api, cli, and thread barrier events
1583 * With no arguments, displays the current trace status.
1584 * Name the event groups you wish to trace or stop tracing.
1588 * event-logger trace api cli barrier
1589 * event-logger trace api cli barrier disable
1590 * event-logger trace dispatch
1591 * event-logger trace circuit-node ethernet-input
1593 * @cliexcmd{event-logger trace [api][cli][barrier][disable]}
1596 VLIB_CLI_COMMAND (event_logger_trace_command, static) =
1598 .path = "event-logger trace",
1599 .short_help = "event-logger trace [api][cli][barrier][dispatch]\n"
1600 "[circuit-node <name> e.g. ethernet-input][disable]",
1601 .function = event_logger_trace_command_fn,
1605 static clib_error_t *
1606 suspend_command_fn (vlib_main_t * vm,
1607 unformat_input_t * input, vlib_cli_command_t * cmd)
1609 vlib_process_suspend (vm, 30e-3);
1614 VLIB_CLI_COMMAND (suspend_command, static) =
1617 .short_help = "suspend debug CLI for 30ms",
1618 .function = suspend_command_fn,
1625 sort_cmds_by_path (void *a1, void *a2)
1629 vlib_main_t *vm = vlib_get_main ();
1630 vlib_cli_main_t *cm = &vm->cli_main;
1631 vlib_cli_command_t *c1, *c2;
1634 c1 = vec_elt_at_index (cm->commands, *index1);
1635 c2 = vec_elt_at_index (cm->commands, *index2);
1637 lmin = vec_len (c1->path);
1638 lmin = (vec_len (c2->path) >= lmin) ? lmin : vec_len (c2->path);
1640 for (i = 0; i < lmin; i++)
1642 if (c1->path[i] < c2->path[i])
1644 else if (c1->path[i] > c2->path[i])
1653 vlib_cli_main_t *cm;
1654 u32 parent_command_index;
1656 int show_not_mp_safe;
1659 } vlib_cli_walk_args_t;
1662 cli_recursive_walk (vlib_cli_walk_args_t * aa)
1664 vlib_cli_command_t *parent;
1665 vlib_cli_sub_command_t *sub;
1666 vlib_cli_walk_args_t _a, *a = &_a;
1667 vlib_cli_main_t *cm;
1670 /* Copy args into this stack frame */
1674 parent = vec_elt_at_index (cm->commands, a->parent_command_index);
1676 if (parent->function)
1678 if (((a->show_mp_safe && parent->is_mp_safe)
1679 || (a->show_not_mp_safe && !parent->is_mp_safe))
1680 && (a->show_hit == 0 || parent->hit_counter))
1682 vec_add1 (cm->sort_vector, a->parent_command_index);
1686 parent->hit_counter = 0;
1689 for (i = 0; i < vec_len (parent->sub_commands); i++)
1691 sub = vec_elt_at_index (parent->sub_commands, i);
1692 a->parent_command_index = sub->index;
1693 cli_recursive_walk (a);
1698 format_mp_safe (u8 * s, va_list * args)
1700 vlib_cli_main_t *cm = va_arg (*args, vlib_cli_main_t *);
1701 int show_mp_safe = va_arg (*args, int);
1702 int show_not_mp_safe = va_arg (*args, int);
1703 int show_hit = va_arg (*args, int);
1704 int clear_hit = va_arg (*args, int);
1705 vlib_cli_command_t *c;
1706 vlib_cli_walk_args_t _a, *a = &_a;
1708 char *format_string = "\n%v";
1711 format_string = "\n%v: %u";
1713 vec_reset_length (cm->sort_vector);
1716 a->parent_command_index = 0;
1717 a->show_mp_safe = show_mp_safe;
1718 a->show_not_mp_safe = show_not_mp_safe;
1719 a->show_hit = show_hit;
1720 a->clear_hit = clear_hit;
1722 cli_recursive_walk (a);
1724 vec_sort_with_function (cm->sort_vector, sort_cmds_by_path);
1726 for (i = 0; i < vec_len (cm->sort_vector); i++)
1728 c = vec_elt_at_index (cm->commands, cm->sort_vector[i]);
1729 s = format (s, format_string, c->path, c->hit_counter);
1736 static clib_error_t *
1737 show_cli_command_fn (vlib_main_t * vm,
1738 unformat_input_t * input, vlib_cli_command_t * cmd)
1740 int show_mp_safe = 0;
1741 int show_not_mp_safe = 0;
1745 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1747 if (unformat (input, "mp-safe"))
1749 if (unformat (input, "not-mp-safe"))
1750 show_not_mp_safe = 1;
1751 else if (unformat (input, "hit"))
1753 else if (unformat (input, "clear-hit"))
1759 /* default set: all cli commands */
1760 if (clear_hit == 0 && (show_mp_safe + show_not_mp_safe) == 0)
1761 show_mp_safe = show_not_mp_safe = 1;
1763 vlib_cli_output (vm, "%U", format_mp_safe, &vm->cli_main,
1764 show_mp_safe, show_not_mp_safe, show_hit, clear_hit);
1766 vlib_cli_output (vm, "hit counters cleared...");
1772 * Displays debug cli command information
1775 * @cliexstart{show cli [mp-safe][not-mp-safe][hit][clear-hit]}
1777 * "show cli" displays the entire debug cli:
1781 * adjacency counters
1787 * "show cli mp-safe" displays mp-safe debug CLI commands:
1801 * "show cli not-mp-safe" displays debug CLI commands
1802 * which cause worker thread barrier synchronization
1804 * "show cli hit" displays commands which have been executed. Qualify
1805 * as desired with "mp-safe" or "not-mp-safe".
1807 * "show cli clear-hit" clears the per-command hit counters.
1812 VLIB_CLI_COMMAND (show_cli_command, static) =
1815 .short_help = "show cli [mp-safe][not-mp-safe][hit][clear-hit]",
1816 .function = show_cli_command_fn,
1821 static clib_error_t *
1822 vlib_cli_init (vlib_main_t * vm)
1824 vlib_cli_main_t *cm = &vm->cli_main;
1825 clib_error_t *error = 0;
1826 vlib_cli_command_t *cmd;
1828 cmd = cm->cli_command_registrations;
1832 error = vlib_cli_register (vm, cmd);
1835 cmd = cmd->next_cli_command;
1838 cm->log = vlib_log_register_class_rate_limit (
1839 "cli", "log", 0x7FFFFFFF /* aka no rate limit */);
1843 VLIB_INIT_FUNCTION (vlib_cli_init);
1846 * fd.io coding-style-patch-verification: ON
1849 * eval: (c-set-style "gnu")