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/cpu.h>
43 #include <vppinfra/elog.h>
47 /** \file src/vlib/cli.c Debug CLI Implementation
50 int vl_api_set_elog_trace_api_messages (int enable);
51 int vl_api_get_elog_trace_api_messages (void);
53 static void *current_traced_heap;
55 /* Root of all show commands. */
57 VLIB_CLI_COMMAND (vlib_cli_show_command, static) = {
59 .short_help = "Show commands",
63 /* Root of all clear commands. */
65 VLIB_CLI_COMMAND (vlib_cli_clear_command, static) = {
67 .short_help = "Clear commands",
71 /* Root of all set commands. */
73 VLIB_CLI_COMMAND (vlib_cli_set_command, static) = {
75 .short_help = "Set commands",
79 /* Root of all test commands. */
81 VLIB_CLI_COMMAND (vlib_cli_test_command, static) = {
83 .short_help = "Test commands",
87 /* Returns bitmap of commands which match key. */
89 vlib_cli_sub_command_match (vlib_cli_command_t * c, unformat_input_t * input)
93 vlib_cli_parse_position_t *p;
95 unformat_skip_white_space (input);
101 k = unformat_get_input (input);
115 case UNFORMAT_END_OF_INPUT:
116 /* White space or end of input removes any non-white
117 matches that were before possible. */
118 if (i < vec_len (c->sub_command_positions)
119 && clib_bitmap_count_set_bits (match) > 1)
121 p = vec_elt_at_index (c->sub_command_positions, i);
122 for (n = 0; n < vec_len (p->bitmaps); n++)
123 match = clib_bitmap_andnot (match, p->bitmaps[n]);
128 unformat_put_input (input);
132 if (i >= vec_len (c->sub_command_positions))
135 clib_bitmap_free (match);
139 p = vec_elt_at_index (c->sub_command_positions, i);
140 if (vec_len (p->bitmaps) == 0)
144 if (n < 0 || n >= vec_len (p->bitmaps))
148 match = clib_bitmap_dup (p->bitmaps[n]);
150 match = clib_bitmap_and (match, p->bitmaps[n]);
152 if (clib_bitmap_is_zero (match))
160 /* Looks for string based sub-input formatted { SUB-INPUT }. */
162 unformat_vlib_cli_sub_input (unformat_input_t * i, va_list * args)
164 unformat_input_t *sub_input = va_arg (*args, unformat_input_t *);
170 c = unformat_get_input (i);
182 /* Put back paren. */
183 if (c != UNFORMAT_END_OF_INPUT)
184 unformat_put_input (i);
186 if (c == '{' && unformat (i, "%v", &s))
188 unformat_init_vector (sub_input, s);
197 static vlib_cli_command_t *
198 get_sub_command (vlib_cli_main_t * cm, vlib_cli_command_t * parent, u32 si)
200 vlib_cli_sub_command_t *s = vec_elt_at_index (parent->sub_commands, si);
201 return vec_elt_at_index (cm->commands, s->index);
205 unformat_vlib_cli_sub_command (unformat_input_t * i, va_list * args)
207 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
208 vlib_cli_command_t *c = va_arg (*args, vlib_cli_command_t *);
209 vlib_cli_command_t **result = va_arg (*args, vlib_cli_command_t **);
210 vlib_cli_main_t *cm = &vm->cli_main;
211 uword *match_bitmap, is_unique, index;
213 match_bitmap = vlib_cli_sub_command_match (c, i);
214 is_unique = clib_bitmap_count_set_bits (match_bitmap) == 1;
218 index = clib_bitmap_first_set (match_bitmap);
219 *result = get_sub_command (cm, c, index);
221 clib_bitmap_free (match_bitmap);
227 vlib_cli_cmp_strings (void *a1, void *a2)
229 u8 *c1 = *(u8 **) a1;
230 u8 *c2 = *(u8 **) a2;
232 return vec_cmp (c1, c2);
236 vlib_cli_get_possible_completions (u8 * str)
238 vlib_cli_command_t *c;
239 vlib_cli_sub_command_t *sc;
240 vlib_main_t *vm = vlib_get_main ();
241 vlib_cli_main_t *vcm = &vm->cli_main;
242 uword *match_bitmap = 0;
243 uword index, is_unique, help_next_level;
245 unformat_input_t input;
246 unformat_init_vector (&input, vec_dup (str));
247 c = vec_elt_at_index (vcm->commands, 0);
249 /* remove trailing whitespace, except for one of them */
250 while (vec_len (input.buffer) >= 2 &&
251 isspace (input.buffer[vec_len (input.buffer) - 1]) &&
252 isspace (input.buffer[vec_len (input.buffer) - 2]))
254 vec_del1 (input.buffer, vec_len (input.buffer) - 1);
257 /* if input is empty, directly return list of root commands */
258 if (vec_len (input.buffer) == 0 ||
259 (vec_len (input.buffer) == 1 && isspace (input.buffer[0])))
261 vec_foreach (sc, c->sub_commands)
263 vec_add1 (result, (u8 *) sc->name);
268 /* add a trailing '?' so that vlib_cli_sub_command_match can find
269 * all commands starting with the input string */
270 vec_add1 (input.buffer, '?');
274 match_bitmap = vlib_cli_sub_command_match (c, &input);
275 /* no match: return no result */
276 if (match_bitmap == 0)
280 is_unique = clib_bitmap_count_set_bits (match_bitmap) == 1;
281 /* unique match: try to step one subcommand level further */
284 /* stop if no more input */
285 if (input.index >= vec_len (input.buffer) - 1)
290 index = clib_bitmap_first_set (match_bitmap);
291 c = get_sub_command (vcm, c, index);
292 clib_bitmap_free (match_bitmap);
295 /* multiple matches: stop here, return all matches */
299 /* remove trailing '?' */
300 vec_del1 (input.buffer, vec_len (input.buffer) - 1);
302 /* if we have a space at the end of input, and a unique match,
303 * autocomplete the next level of subcommands */
304 help_next_level = (vec_len (str) == 0) || isspace (str[vec_len (str) - 1]);
306 clib_bitmap_foreach(index, match_bitmap, {
307 if (help_next_level && is_unique) {
308 c = get_sub_command (vcm, c, index);
309 vec_foreach (sc, c->sub_commands) {
310 vec_add1 (result, (u8*) sc->name);
312 goto done; /* break doesn't work in this macro-loop */
314 sc = &c->sub_commands[index];
315 vec_add1(result, (u8*) sc->name);
320 clib_bitmap_free (match_bitmap);
321 unformat_free (&input);
324 vec_sort_with_function (result, vlib_cli_cmp_strings);
329 format_vlib_cli_command_help (u8 * s, va_list * args)
331 vlib_cli_command_t *c = va_arg (*args, vlib_cli_command_t *);
332 int is_long = va_arg (*args, int);
333 if (is_long && c->long_help)
334 s = format (s, "%s", c->long_help);
335 else if (c->short_help)
336 s = format (s, "%s", c->short_help);
338 s = format (s, "%v commands", c->path);
343 format_vlib_cli_path (u8 * s, va_list * args)
345 u8 *path = va_arg (*args, u8 *);
347 s = format (s, "%v", path);
352 static vlib_cli_command_t *
353 all_subs (vlib_cli_main_t * cm, vlib_cli_command_t * subs, u32 command_index)
355 vlib_cli_command_t *c = vec_elt_at_index (cm->commands, command_index);
356 vlib_cli_sub_command_t *sc;
359 vec_add1 (subs, c[0]);
361 vec_foreach (sc, c->sub_commands) subs = all_subs (cm, subs, sc->index);
367 vlib_cli_cmp_rule (void *a1, void *a2)
369 vlib_cli_sub_rule_t *r1 = a1;
370 vlib_cli_sub_rule_t *r2 = a2;
372 return vec_cmp (r1->name, r2->name);
376 vlib_cli_cmp_command (void *a1, void *a2)
378 vlib_cli_command_t *c1 = a1;
379 vlib_cli_command_t *c2 = a2;
381 return vec_cmp (c1->path, c2->path);
384 static clib_error_t *
385 vlib_cli_dispatch_sub_commands (vlib_main_t * vm,
386 vlib_cli_main_t * cm,
387 unformat_input_t * input,
388 uword parent_command_index)
390 vlib_cli_command_t *parent, *c;
391 clib_error_t *error = 0;
392 unformat_input_t sub_input;
394 uword is_main_dispatch = cm == &vm->cli_main;
396 parent = vec_elt_at_index (cm->commands, parent_command_index);
397 if (is_main_dispatch && unformat (input, "help"))
399 uword help_at_end_of_line, i;
401 help_at_end_of_line =
402 unformat_check_input (input) == UNFORMAT_END_OF_INPUT;
407 (input, unformat_vlib_cli_sub_command, vm, c, &parent))
410 else if (!(unformat_check_input (input) == UNFORMAT_END_OF_INPUT))
417 /* help SUB-COMMAND => long format help.
418 "help" at end of line: show all commands. */
419 if (!help_at_end_of_line)
420 vlib_cli_output (vm, "%U", format_vlib_cli_command_help, c,
423 else if (vec_len (c->sub_commands) == 0)
424 vlib_cli_output (vm, "%v: no sub-commands", c->path);
428 vlib_cli_sub_rule_t *sr, *subs = 0;
429 vlib_cli_sub_command_t *sc;
431 vec_foreach (sc, c->sub_commands)
433 vec_add2 (subs, sr, 1);
435 sr->command_index = sc->index;
439 vec_sort_with_function (subs, vlib_cli_cmp_rule);
441 for (i = 0; i < vec_len (subs); i++)
443 vlib_cli_command_t *d;
445 d = vec_elt_at_index (cm->commands, subs[i].command_index);
447 (vm, " %-30v %U", subs[i].name,
448 format_vlib_cli_command_help, d, /* is_long */ 0);
455 else if (is_main_dispatch
456 && (unformat (input, "choices") || unformat (input, "?")))
458 vlib_cli_command_t *sub, *subs;
460 subs = all_subs (cm, 0, parent_command_index);
461 vec_sort_with_function (subs, vlib_cli_cmp_command);
462 vec_foreach (sub, subs)
463 vlib_cli_output (vm, " %-40U %U",
464 format_vlib_cli_path, sub->path,
465 format_vlib_cli_command_help, sub, /* is_long */ 0);
469 else if (unformat (input, "comment %v", &string))
474 else if (unformat (input, "uncomment %U",
475 unformat_vlib_cli_sub_input, &sub_input))
478 vlib_cli_dispatch_sub_commands (vm, cm, &sub_input,
479 parent_command_index);
480 unformat_free (&sub_input);
482 else if (unformat (input, "leak-check %U",
483 unformat_vlib_cli_sub_input, &sub_input))
486 if (current_traced_heap)
489 oldheap = clib_mem_set_heap (current_traced_heap);
491 clib_mem_set_heap (oldheap);
492 current_traced_heap = 0;
496 vlib_cli_dispatch_sub_commands (vm, cm, &sub_input,
497 parent_command_index);
498 unformat_free (&sub_input);
500 /* Otherwise, the clib_error_t shows up as a leak... */
503 vlib_cli_output (vm, "%v", error->what);
504 clib_error_free (error);
508 (void) clib_mem_trace_enable_disable (0);
509 leak_report = format (0, "%U", format_mheap, clib_mem_get_heap (),
510 1 /* verbose, i.e. print leaks */ );
512 vlib_cli_output (vm, "%v", leak_report);
513 vec_free (leak_report);
517 if (unformat_user (input, unformat_vlib_cli_sub_command, vm, parent, &c))
519 unformat_input_t *si;
520 uword has_sub_commands =
521 vec_len (c->sub_commands) + vec_len (c->sub_rules) > 0;
524 if (unformat_user (input, unformat_vlib_cli_sub_input, &sub_input))
527 if (has_sub_commands)
528 error = vlib_cli_dispatch_sub_commands (vm, cm, si, c - cm->commands);
530 if (has_sub_commands && !error)
531 /* Found valid sub-command. */ ;
533 else if (c->function)
535 clib_error_t *c_error;
537 /* Skip white space for benefit of called function. */
538 unformat_skip_white_space (si);
540 if (unformat (si, "?"))
542 vlib_cli_output (vm, " %-40U %U", format_vlib_cli_path, c->path, format_vlib_cli_command_help, c, /* is_long */
547 if (PREDICT_FALSE (vm->elog_trace_cli_commands))
550 ELOG_TYPE_DECLARE (e) =
552 .format = "cli-cmd: %s",
560 ed = ELOG_DATA (&vm->elog_main, e);
561 ed->c = elog_string (&vm->elog_main, "%v", c->path);
565 vlib_worker_thread_barrier_sync (vm);
568 c_error = c->function (vm, si, c);
571 vlib_worker_thread_barrier_release (vm);
573 if (PREDICT_FALSE (vm->elog_trace_cli_commands))
576 ELOG_TYPE_DECLARE (e) =
578 .format = "cli-cmd: %s %s",
579 .format_args = "T4T4",
586 ed = ELOG_DATA (&vm->elog_main, e);
587 ed->c = elog_string (&vm->elog_main, "%v", c->path);
590 vec_add1 (c_error->what, 0);
592 elog_string (&vm->elog_main, (char *) c_error->what);
593 _vec_len (c_error->what) -= 1;
596 ed->err = elog_string (&vm->elog_main, "OK");
602 clib_error_return (0, "%v: %v", c->path, c_error->what);
603 clib_error_free (c_error);
604 /* Free sub input. */
612 /* Free any previous error. */
613 clib_error_free (error);
617 error = clib_error_return (0, "%v: no sub-commands", c->path);
619 /* Free sub input. */
631 return clib_error_return (0, "%v: unknown input `%U'", parent->path,
632 format_unformat_error, input);
634 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
639 void vlib_unix_error_report (vlib_main_t *, clib_error_t *)
640 __attribute__ ((weak));
643 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
647 /* Process CLI input. */
649 vlib_cli_input (vlib_main_t * vm,
650 unformat_input_t * input,
651 vlib_cli_output_function_t * function, uword function_arg)
653 vlib_process_t *cp = vlib_get_current_process (vm);
655 vlib_cli_output_function_t *save_function;
656 uword save_function_arg;
659 save_function = cp->output_function;
660 save_function_arg = cp->output_function_arg;
662 cp->output_function = function;
663 cp->output_function_arg = function_arg;
667 error = vlib_cli_dispatch_sub_commands (vm, &vm->cli_main, input,
670 while (!error && !unformat (input, "%U", unformat_eof));
674 vlib_cli_output (vm, "%v", error->what);
675 vlib_unix_error_report (vm, error);
676 /* clib_error_return is unfortunately often called with a '0'
678 rv = error->code != 0 ? error->code : -1;
679 clib_error_free (error);
682 cp->output_function = save_function;
683 cp->output_function_arg = save_function_arg;
687 /* Output to current CLI connection. */
689 vlib_cli_output (vlib_main_t * vm, char *fmt, ...)
691 vlib_process_t *cp = vlib_get_current_process (vm);
696 s = va_format (0, fmt, &va);
699 /* Terminate with \n if not present. */
700 if (vec_len (s) > 0 && s[vec_len (s) - 1] != '\n')
703 if ((!cp) || (!cp->output_function))
704 fformat (stdout, "%v", s);
706 cp->output_function (cp->output_function_arg, s, vec_len (s));
711 void *vl_msg_push_heap (void) __attribute__ ((weak));
713 vl_msg_push_heap (void)
718 void vl_msg_pop_heap (void *oldheap) __attribute__ ((weak));
720 vl_msg_pop_heap (void *oldheap)
724 void *vlib_stats_push_heap (void *) __attribute__ ((weak));
726 vlib_stats_push_heap (void *notused)
731 static clib_error_t *
732 show_memory_usage (vlib_main_t * vm,
733 unformat_input_t * input, vlib_cli_command_t * cmd)
735 int verbose __attribute__ ((unused)) = 0;
736 int api_segment = 0, stats_segment = 0, main_heap = 0;
739 uword clib_mem_trace_enable_disable (uword enable);
743 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
745 if (unformat (input, "verbose"))
747 else if (unformat (input, "api-segment"))
749 else if (unformat (input, "stats-segment"))
751 else if (unformat (input, "main-heap"))
755 error = clib_error_return (0, "unknown input `%U'",
756 format_unformat_error, input);
761 if ((api_segment + stats_segment + main_heap) == 0)
762 return clib_error_return
763 (0, "Please supply one of api-segment, stats-segment or main-heap");
767 void *oldheap = vl_msg_push_heap ();
768 was_enabled = clib_mem_trace_enable_disable (0);
770 format (0, "%U\n", format_mheap, clib_mem_get_heap (), 1);
771 vl_msg_pop_heap (oldheap);
772 u8 *s = vec_dup (s_in_svm);
774 oldheap = vl_msg_push_heap ();
776 clib_mem_trace_enable_disable (was_enabled);
777 vl_msg_pop_heap (oldheap);
778 vlib_cli_output (vm, "API segment");
779 vlib_cli_output (vm, "%v", s);
784 void *oldheap = vlib_stats_push_heap (0);
785 was_enabled = clib_mem_trace_enable_disable (0);
787 format (0, "%U\n", format_mheap, clib_mem_get_heap (), 1);
789 clib_mem_set_heap (oldheap);
790 u8 *s = vec_dup (s_in_svm);
792 oldheap = vlib_stats_push_heap (0);
796 clib_mem_trace_enable_disable (was_enabled);
797 clib_mem_set_heap (oldheap);
799 vlib_cli_output (vm, "Stats segment");
800 vlib_cli_output (vm, "%v", s);
804 #if USE_DLMALLOC == 0
808 mheap_t *h = mheap_header (clib_per_cpu_mheaps[index]);
809 vlib_cli_output (vm, "%sThread %d %s\n", index ? "\n":"", index,
810 vlib_worker_threads[index].name);
811 vlib_cli_output (vm, " %U\n", format_page_map, pointer_to_uword (h) -
812 h->vm_alloc_offset_from_header,
814 vlib_cli_output (vm, " %U\n", format_mheap, clib_per_cpu_mheaps[index],
824 * Note: the foreach_vlib_main causes allocator traffic,
825 * so shut off tracing before we go there...
827 was_enabled = clib_mem_trace_enable_disable (0);
832 struct dlmallinfo mi;
834 mspace = clib_per_cpu_mheaps[index];
836 mi = mspace_mallinfo (mspace);
837 vlib_cli_output (vm, "%sThread %d %s\n", index ? "\n":"", index,
838 vlib_worker_threads[index].name);
839 vlib_cli_output (vm, " %U\n", format_page_map,
840 pointer_to_uword (mspace_least_addr(mspace)),
842 vlib_cli_output (vm, " %U\n", format_mheap,
843 clib_per_cpu_mheaps[index],
849 /* Restore the trace flag */
850 clib_mem_trace_enable_disable (was_enabled);
853 #endif /* USE_DLMALLOC */
858 VLIB_CLI_COMMAND (show_memory_usage_command, static) = {
859 .path = "show memory",
860 .short_help = "show memory [api-segment][stats-segment][verbose]",
861 .function = show_memory_usage,
865 static clib_error_t *
866 show_cpu (vlib_main_t * vm, unformat_input_t * input,
867 vlib_cli_command_t * cmd)
869 #define _(a,b,c) vlib_cli_output (vm, "%-25s " b, a ":", c);
870 _("Model name", "%U", format_cpu_model_name);
871 _("Microarch model (family)", "%U", format_cpu_uarch);
872 _("Flags", "%U", format_cpu_flags);
873 _("Base frequency", "%.2f GHz",
874 ((f64) vm->clib_time.clocks_per_second) * 1e-9);
880 * Displays various information about the CPU.
883 * @cliexstart{show cpu}
884 * Model name: Intel(R) Xeon(R) CPU E5-2667 v4 @ 3.20GHz
885 * Microarchitecture: Broadwell (Broadwell-EP/EX)
886 * Flags: sse3 ssse3 sse41 sse42 avx avx2 aes
887 * Base Frequency: 3.20 GHz
891 VLIB_CLI_COMMAND (show_cpu_command, static) = {
893 .short_help = "Show cpu information",
894 .function = show_cpu,
898 static clib_error_t *
899 enable_disable_memory_trace (vlib_main_t * vm,
900 unformat_input_t * input,
901 vlib_cli_command_t * cmd)
903 unformat_input_t _line_input, *line_input = &_line_input;
906 int stats_segment = 0;
910 if (!unformat_user (input, unformat_line_input, line_input))
913 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
915 if (unformat (line_input, "%U", unformat_vlib_enable_disable, &enable))
917 else if (unformat (line_input, "api-segment"))
919 else if (unformat (line_input, "stats-segment"))
921 else if (unformat (line_input, "main-heap"))
925 unformat_free (line_input);
926 return clib_error_return (0, "invalid input");
929 unformat_free (line_input);
931 if ((api_segment + stats_segment + main_heap + (enable == 0)) == 0)
933 return clib_error_return
934 (0, "Need one of main-heap, stats-segment or api-segment");
937 /* Turn off current trace, if any */
938 if (current_traced_heap)
941 oldheap = clib_mem_set_heap (current_traced_heap);
943 clib_mem_set_heap (oldheap);
944 current_traced_heap = 0;
953 oldheap = vl_msg_push_heap ();
954 current_traced_heap = clib_mem_get_heap ();
956 vl_msg_pop_heap (oldheap);
963 oldheap = vlib_stats_push_heap (0);
964 current_traced_heap = clib_mem_get_heap ();
965 clib_mem_trace (stats_segment);
966 /* We don't want to call vlib_stats_pop_heap... */
968 clib_mem_set_heap (oldheap);
974 current_traced_heap = clib_mem_get_heap ();
975 clib_mem_trace (main_heap);
982 VLIB_CLI_COMMAND (enable_disable_memory_trace_command, static) = {
983 .path = "memory-trace",
984 .short_help = "memory-trace on|off [api-segment][stats-segment][main-heap]\n",
985 .function = enable_disable_memory_trace,
990 static clib_error_t *
991 test_heap_validate (vlib_main_t * vm, unformat_input_t * input,
992 vlib_cli_command_t * cmd)
994 #if USE_DLMALLOC == 0
995 clib_error_t *error = 0;
999 if (unformat (input, "on"))
1003 heap = clib_per_cpu_mheaps[this_vlib_main->thread_index];
1004 mheap = mheap_header(heap);
1005 mheap->flags |= MHEAP_FLAG_VALIDATE;
1006 // Turn off small object cache because it delays detection of errors
1007 mheap->flags &= ~MHEAP_FLAG_SMALL_OBJECT_CACHE;
1012 else if (unformat (input, "off"))
1016 heap = clib_per_cpu_mheaps[this_vlib_main->thread_index];
1017 mheap = mheap_header(heap);
1018 mheap->flags &= ~MHEAP_FLAG_VALIDATE;
1019 mheap->flags |= MHEAP_FLAG_SMALL_OBJECT_CACHE;
1023 else if (unformat (input, "now"))
1027 heap = clib_per_cpu_mheaps[this_vlib_main->thread_index];
1028 mheap = mheap_header(heap);
1029 mheap_validate(heap);
1032 vlib_cli_output (vm, "heap validation complete");
1037 return clib_error_return (0, "unknown input `%U'",
1038 format_unformat_error, input);
1043 return clib_error_return (0, "unimplemented...");
1044 #endif /* USE_DLMALLOC */
1048 VLIB_CLI_COMMAND (cmd_test_heap_validate,static) = {
1049 .path = "test heap-validate",
1050 .short_help = "<on/off/now> validate heap on future allocs/frees or right now",
1051 .function = test_heap_validate,
1055 static clib_error_t *
1056 restart_cmd_fn (vlib_main_t * vm, unformat_input_t * input,
1057 vlib_cli_command_t * cmd)
1059 clib_file_main_t *fm = &file_main;
1062 /* environ(7) does not indicate a header for this */
1063 extern char **environ;
1065 /* Close all known open files */
1067 pool_foreach(f, fm->file_pool,
1069 if (f->file_descriptor > 2)
1070 close(f->file_descriptor);
1075 execve (vm->name, (char **) vm->argv, environ);
1081 VLIB_CLI_COMMAND (restart_cmd,static) = {
1083 .short_help = "restart process",
1084 .function = restart_cmd_fn,
1090 * A trivial test harness to verify the per-process output_function
1091 * is working correcty.
1094 static clib_error_t *
1095 sleep_ten_seconds (vlib_main_t * vm,
1096 unformat_input_t * input, vlib_cli_command_t * cmd)
1099 u16 my_id = rand ();
1101 vlib_cli_output (vm, "Starting 10 seconds sleep with id %u\n", my_id);
1103 for (i = 0; i < 10; i++)
1105 vlib_process_wait_for_event_or_clock (vm, 1.0);
1106 vlib_cli_output (vm, "Iteration number %u, my id: %u\n", i, my_id);
1108 vlib_cli_output (vm, "Done with sleep with id %u\n", my_id);
1113 VLIB_CLI_COMMAND (ping_command, static) = {
1114 .path = "test sleep",
1115 .function = sleep_ten_seconds,
1116 .short_help = "Sleep for 10 seconds",
1119 #endif /* ifdef TEST_CODE */
1122 vlib_cli_normalize_path (char *input, char **result)
1127 uword index_of_last_space = ~0;
1132 /* Multiple white space -> single space. */
1139 if (l > 0 && s[l - 1] != ' ')
1147 if (l > 0 && s[l - 1] == ' ')
1148 index_of_last_space = vec_len (s);
1155 /* Remove any extra space at end. */
1156 if (l > 0 && s[l - 1] == ' ')
1160 return index_of_last_space;
1164 parent_path_len (char *path)
1167 for (i = vec_len (path) - 1; i >= 0; i--)
1176 add_sub_command (vlib_cli_main_t * cm, uword parent_index, uword child_index)
1178 vlib_cli_command_t *p, *c;
1179 vlib_cli_sub_command_t *sub_c;
1183 p = vec_elt_at_index (cm->commands, parent_index);
1184 c = vec_elt_at_index (cm->commands, child_index);
1186 l = parent_path_len (c->path);
1188 sub_name = vec_dup ((u8 *) c->path);
1191 ASSERT (l + 1 < vec_len (c->path));
1193 vec_add (sub_name, c->path + l + 1, vec_len (c->path) - (l + 1));
1196 if (sub_name[0] == '%')
1199 vlib_cli_sub_rule_t *sr;
1202 vec_delete (sub_name, 1, 0);
1204 if (!p->sub_rule_index_by_name)
1205 p->sub_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1206 sizeof (sub_name[0]),
1208 q = hash_get_mem (p->sub_rule_index_by_name, sub_name);
1211 sr = vec_elt_at_index (p->sub_rules, q[0]);
1212 ASSERT (sr->command_index == child_index);
1216 hash_set_mem (p->sub_rule_index_by_name, sub_name,
1217 vec_len (p->sub_rules));
1218 vec_add2 (p->sub_rules, sr, 1);
1219 sr->name = sub_name;
1220 sr->rule_index = q[0];
1221 sr->command_index = child_index;
1225 if (!p->sub_command_index_by_name)
1226 p->sub_command_index_by_name = hash_create_vec ( /* initial length */ 32,
1227 sizeof (c->path[0]),
1230 /* Check if sub-command has already been created. */
1231 if (hash_get_mem (p->sub_command_index_by_name, sub_name))
1233 vec_free (sub_name);
1237 vec_add2 (p->sub_commands, sub_c, 1);
1238 sub_c->index = child_index;
1239 sub_c->name = sub_name;
1240 hash_set_mem (p->sub_command_index_by_name, sub_c->name,
1241 sub_c - p->sub_commands);
1243 vec_validate (p->sub_command_positions, vec_len (sub_c->name) - 1);
1244 for (i = 0; i < vec_len (sub_c->name); i++)
1247 vlib_cli_parse_position_t *pos;
1249 pos = vec_elt_at_index (p->sub_command_positions, i);
1252 pos->min_char = sub_c->name[i];
1254 n = sub_c->name[i] - pos->min_char;
1257 pos->min_char = sub_c->name[i];
1258 vec_insert (pos->bitmaps, -n, 0);
1262 vec_validate (pos->bitmaps, n);
1264 clib_bitmap_ori (pos->bitmaps[n], sub_c - p->sub_commands);
1269 vlib_cli_make_parent (vlib_cli_main_t * cm, uword ci)
1271 uword p_len, pi, *p;
1273 vlib_cli_command_t *c, *parent;
1275 /* Root command (index 0) should have already been added. */
1276 ASSERT (vec_len (cm->commands) > 0);
1278 c = vec_elt_at_index (cm->commands, ci);
1279 p_len = parent_path_len (c->path);
1281 /* No space? Parent is root command. */
1284 add_sub_command (cm, 0, ci);
1289 vec_add (p_path, c->path, p_len);
1291 p = hash_get_mem (cm->command_index_by_path, p_path);
1293 /* Parent exists? */
1296 /* Parent does not exist; create it. */
1297 vec_add2 (cm->commands, parent, 1);
1298 parent->path = p_path;
1299 hash_set_mem (cm->command_index_by_path, parent->path,
1300 parent - cm->commands);
1301 pi = parent - cm->commands;
1309 add_sub_command (cm, pi, ci);
1311 /* Create parent's parent. */
1313 vlib_cli_make_parent (cm, pi);
1317 vlib_cli_command_is_empty (vlib_cli_command_t * c)
1319 return (c->long_help == 0 && c->short_help == 0 && c->function == 0);
1323 vlib_cli_register (vlib_main_t * vm, vlib_cli_command_t * c)
1325 vlib_cli_main_t *cm = &vm->cli_main;
1326 clib_error_t *error = 0;
1328 char *normalized_path;
1330 if ((error = vlib_call_init_function (vm, vlib_cli_init)))
1333 (void) vlib_cli_normalize_path (c->path, &normalized_path);
1335 if (!cm->command_index_by_path)
1336 cm->command_index_by_path = hash_create_vec ( /* initial length */ 32,
1337 sizeof (c->path[0]),
1340 /* See if command already exists with given path. */
1341 p = hash_get_mem (cm->command_index_by_path, normalized_path);
1344 vlib_cli_command_t *d;
1347 d = vec_elt_at_index (cm->commands, ci);
1349 /* If existing command was created via vlib_cli_make_parent
1350 replaced it with callers data. */
1351 if (vlib_cli_command_is_empty (d))
1353 vlib_cli_command_t save = d[0];
1355 ASSERT (!vlib_cli_command_is_empty (c));
1357 /* Copy callers fields. */
1360 /* Save internal fields. */
1361 d->path = save.path;
1362 d->sub_commands = save.sub_commands;
1363 d->sub_command_index_by_name = save.sub_command_index_by_name;
1364 d->sub_command_positions = save.sub_command_positions;
1365 d->sub_rules = save.sub_rules;
1369 clib_error_return (0, "duplicate command name with path %v",
1372 vec_free (normalized_path);
1378 /* Command does not exist: create it. */
1380 /* Add root command (index 0). */
1381 if (vec_len (cm->commands) == 0)
1383 /* Create command with index 0; path is empty string. */
1384 vec_resize (cm->commands, 1);
1387 ci = vec_len (cm->commands);
1388 hash_set_mem (cm->command_index_by_path, normalized_path, ci);
1389 vec_add1 (cm->commands, c[0]);
1391 c = vec_elt_at_index (cm->commands, ci);
1392 c->path = normalized_path;
1394 /* Don't inherit from registration. */
1395 c->sub_commands = 0;
1396 c->sub_command_index_by_name = 0;
1397 c->sub_command_positions = 0;
1400 vlib_cli_make_parent (cm, ci);
1405 /* $$$ turn back on again someday, maybe */
1407 vlib_cli_register_parse_rule (vlib_main_t * vm, vlib_cli_parse_rule_t * r_reg)
1409 vlib_cli_main_t *cm = &vm->cli_main;
1410 vlib_cli_parse_rule_t *r;
1411 clib_error_t *error = 0;
1415 if (!cm->parse_rule_index_by_name)
1416 cm->parse_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1417 sizeof (r->name[0]),
1420 /* Make vector copy of name. */
1421 r_name = format (0, "%s", r_reg->name);
1423 if ((p = hash_get_mem (cm->parse_rule_index_by_name, r_name)))
1426 return clib_error_return (0, "duplicate parse rule name `%s'",
1430 vec_add2 (cm->parse_rules, r, 1);
1432 r->name = (char *) r_name;
1433 hash_set_mem (cm->parse_rule_index_by_name, r->name, r - cm->parse_rules);
1438 static clib_error_t *vlib_cli_register_parse_rules (vlib_main_t * vm,
1439 vlib_cli_parse_rule_t *
1441 vlib_cli_parse_rule_t *
1443 __attribute__ ((unused))
1445 clib_error_t *error = 0;
1446 vlib_cli_parse_rule_t *r;
1448 for (r = lo; r < hi; r = clib_elf_section_data_next (r, 0))
1450 if (!r->name || strlen (r->name) == 0)
1452 error = clib_error_return (0, "parse rule with no name");
1456 error = vlib_cli_register_parse_rule (vm, r);
1466 static clib_error_t *
1467 elog_trace_command_fn (vlib_main_t * vm,
1468 unformat_input_t * input, vlib_cli_command_t * cmd)
1470 unformat_input_t _line_input, *line_input = &_line_input;
1472 int api = 0, cli = 0, barrier = 0, dispatch = 0, circuit = 0;
1473 u32 circuit_node_index;
1475 if (!unformat_user (input, unformat_line_input, line_input))
1478 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1480 if (unformat (line_input, "api"))
1482 else if (unformat (line_input, "dispatch"))
1484 else if (unformat (line_input, "circuit-node %U",
1485 unformat_vlib_node, vm, &circuit_node_index))
1487 else if (unformat (line_input, "cli"))
1489 else if (unformat (line_input, "barrier"))
1491 else if (unformat (line_input, "disable"))
1493 else if (unformat (line_input, "enable"))
1498 unformat_free (line_input);
1500 vl_api_set_elog_trace_api_messages
1501 (api ? enable : vl_api_get_elog_trace_api_messages ());
1502 vm->elog_trace_cli_commands = cli ? enable : vm->elog_trace_cli_commands;
1503 vm->elog_trace_graph_dispatch = dispatch ?
1504 enable : vm->elog_trace_graph_dispatch;
1505 vm->elog_trace_graph_circuit = circuit ?
1506 enable : vm->elog_trace_graph_circuit;
1507 vlib_worker_threads->barrier_elog_enabled =
1508 barrier ? enable : vlib_worker_threads->barrier_elog_enabled;
1509 vm->elog_trace_graph_circuit_node_index = circuit_node_index;
1512 * Set up start-of-buffer logic-analyzer trigger
1513 * for main loop event logs, which are fairly heavyweight.
1514 * See src/vlib/main/vlib_elog_main_loop_event(...), which
1515 * will fully disable the scheme when the elog buffer fills.
1517 if (dispatch || circuit)
1519 elog_main_t *em = &vm->elog_main;
1521 em->n_total_events_disable_limit =
1522 em->n_total_events + vec_len (em->event_ring);
1527 vlib_cli_output (vm, "Current status:");
1530 (vm, " Event log API message trace: %s\n CLI command trace: %s",
1531 vl_api_get_elog_trace_api_messages ()? "on" : "off",
1532 vm->elog_trace_cli_commands ? "on" : "off");
1534 (vm, " Barrier sync trace: %s",
1535 vlib_worker_threads->barrier_elog_enabled ? "on" : "off");
1537 (vm, " Graph Dispatch: %s",
1538 vm->elog_trace_graph_dispatch ? "on" : "off");
1540 (vm, " Graph Circuit: %s",
1541 vm->elog_trace_graph_circuit ? "on" : "off");
1542 if (vm->elog_trace_graph_circuit)
1545 format_vlib_node_name, vm, vm->elog_trace_graph_circuit_node_index);
1551 * Control event logging of api, cli, and thread barrier events
1552 * With no arguments, displays the current trace status.
1553 * Name the event groups you wish to trace or stop tracing.
1557 * elog trace api cli barrier
1558 * elog trace api cli barrier disable
1559 * elog trace dispatch
1560 * elog trace circuit-node ethernet-input
1563 * @cliexcmd{elog trace [api][cli][barrier][disable]}
1566 VLIB_CLI_COMMAND (elog_trace_command, static) =
1568 .path = "elog trace",
1569 .short_help = "elog trace [api][cli][barrier][dispatch]\n"
1570 "[circuit-node <name> e.g. ethernet-input][disable]",
1571 .function = elog_trace_command_fn,
1575 static clib_error_t *
1576 suspend_command_fn (vlib_main_t * vm,
1577 unformat_input_t * input, vlib_cli_command_t * cmd)
1579 vlib_process_suspend (vm, 30e-3);
1584 VLIB_CLI_COMMAND (suspend_command, static) =
1587 .short_help = "suspend debug CLI for 30ms",
1588 .function = suspend_command_fn,
1595 sort_cmds_by_path (void *a1, void *a2)
1599 vlib_main_t *vm = vlib_get_main ();
1600 vlib_cli_main_t *cm = &vm->cli_main;
1601 vlib_cli_command_t *c1, *c2;
1604 c1 = vec_elt_at_index (cm->commands, *index1);
1605 c2 = vec_elt_at_index (cm->commands, *index2);
1607 lmin = vec_len (c1->path);
1608 lmin = (vec_len (c2->path) >= lmin) ? lmin : vec_len (c2->path);
1610 for (i = 0; i < lmin; i++)
1612 if (c1->path[i] < c2->path[i])
1614 else if (c1->path[i] > c2->path[i])
1623 vlib_cli_main_t *cm;
1624 u32 parent_command_index;
1626 int show_not_mp_safe;
1629 } vlib_cli_walk_args_t;
1632 cli_recursive_walk (vlib_cli_walk_args_t * aa)
1634 vlib_cli_command_t *parent;
1635 vlib_cli_sub_command_t *sub;
1636 vlib_cli_walk_args_t _a, *a = &_a;
1637 vlib_cli_main_t *cm;
1640 /* Copy args into this stack frame */
1644 parent = vec_elt_at_index (cm->commands, a->parent_command_index);
1646 if (parent->function)
1648 if (((a->show_mp_safe && parent->is_mp_safe)
1649 || (a->show_not_mp_safe && !parent->is_mp_safe))
1650 && (a->show_hit == 0 || parent->hit_counter))
1652 vec_add1 (cm->sort_vector, a->parent_command_index);
1656 parent->hit_counter = 0;
1659 for (i = 0; i < vec_len (parent->sub_commands); i++)
1661 sub = vec_elt_at_index (parent->sub_commands, i);
1662 a->parent_command_index = sub->index;
1663 cli_recursive_walk (a);
1668 format_mp_safe (u8 * s, va_list * args)
1670 vlib_cli_main_t *cm = va_arg (*args, vlib_cli_main_t *);
1671 int show_mp_safe = va_arg (*args, int);
1672 int show_not_mp_safe = va_arg (*args, int);
1673 int show_hit = va_arg (*args, int);
1674 int clear_hit = va_arg (*args, int);
1675 vlib_cli_command_t *c;
1676 vlib_cli_walk_args_t _a, *a = &_a;
1678 char *format_string = "\n%v";
1681 format_string = "\n%v: %u";
1683 vec_reset_length (cm->sort_vector);
1686 a->parent_command_index = 0;
1687 a->show_mp_safe = show_mp_safe;
1688 a->show_not_mp_safe = show_not_mp_safe;
1689 a->show_hit = show_hit;
1690 a->clear_hit = clear_hit;
1692 cli_recursive_walk (a);
1694 vec_sort_with_function (cm->sort_vector, sort_cmds_by_path);
1696 for (i = 0; i < vec_len (cm->sort_vector); i++)
1698 c = vec_elt_at_index (cm->commands, cm->sort_vector[i]);
1699 s = format (s, format_string, c->path, c->hit_counter);
1706 static clib_error_t *
1707 show_cli_command_fn (vlib_main_t * vm,
1708 unformat_input_t * input, vlib_cli_command_t * cmd)
1710 int show_mp_safe = 0;
1711 int show_not_mp_safe = 0;
1715 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1717 if (unformat (input, "mp-safe"))
1719 if (unformat (input, "not-mp-safe"))
1720 show_not_mp_safe = 1;
1721 else if (unformat (input, "hit"))
1723 else if (unformat (input, "clear-hit"))
1729 /* default set: all cli commands */
1730 if (clear_hit == 0 && (show_mp_safe + show_not_mp_safe) == 0)
1731 show_mp_safe = show_not_mp_safe = 1;
1733 vlib_cli_output (vm, "%U", format_mp_safe, &vm->cli_main,
1734 show_mp_safe, show_not_mp_safe, show_hit, clear_hit);
1736 vlib_cli_output (vm, "hit counters cleared...");
1742 * Displays debug cli command information
1745 * @cliexstart{show cli [mp-safe][not-mp-safe][hit][clear-hit]}
1747 * "show cli" displays the entire debug cli:
1751 * adjacency counters
1757 * "show cli mp-safe" displays mp-safe debug CLI commands:
1771 * "show cli not-mp-safe" displays debug CLI commands
1772 * which cause worker thread barrier synchronization
1774 * "show cli hit" displays commands which have been executed. Qualify
1775 * as desired with "mp-safe" or "not-mp-safe".
1777 * "show cli clear-hit" clears the per-command hit counters.
1782 VLIB_CLI_COMMAND (show_cli_command, static) =
1785 .short_help = "show cli [mp-safe][not-mp-safe][hit][clear-hit]",
1786 .function = show_cli_command_fn,
1791 static clib_error_t *
1792 vlib_cli_init (vlib_main_t * vm)
1794 vlib_cli_main_t *cm = &vm->cli_main;
1795 clib_error_t *error = 0;
1796 vlib_cli_command_t *cmd;
1798 cmd = cm->cli_command_registrations;
1802 error = vlib_cli_register (vm, cmd);
1805 cmd = cmd->next_cli_command;
1810 VLIB_INIT_FUNCTION (vlib_cli_init);
1813 * fd.io coding-style-patch-verification: ON
1816 * eval: (c-set-style "gnu")