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 /* Root of all show commands. */
49 VLIB_CLI_COMMAND (vlib_cli_show_command, static) = {
51 .short_help = "Show commands",
55 /* Root of all clear commands. */
57 VLIB_CLI_COMMAND (vlib_cli_clear_command, static) = {
59 .short_help = "Clear commands",
63 /* Root of all set commands. */
65 VLIB_CLI_COMMAND (vlib_cli_set_command, static) = {
67 .short_help = "Set commands",
71 /* Root of all test commands. */
73 VLIB_CLI_COMMAND (vlib_cli_test_command, static) = {
75 .short_help = "Test commands",
79 /* Returns bitmap of commands which match key. */
81 vlib_cli_sub_command_match (vlib_cli_command_t * c, unformat_input_t * input)
85 vlib_cli_parse_position_t *p;
87 unformat_skip_white_space (input);
93 k = unformat_get_input (input);
107 case UNFORMAT_END_OF_INPUT:
108 /* White space or end of input removes any non-white
109 matches that were before possible. */
110 if (i < vec_len (c->sub_command_positions)
111 && clib_bitmap_count_set_bits (match) > 1)
113 p = vec_elt_at_index (c->sub_command_positions, i);
114 for (n = 0; n < vec_len (p->bitmaps); n++)
115 match = clib_bitmap_andnot (match, p->bitmaps[n]);
120 unformat_put_input (input);
124 if (i >= vec_len (c->sub_command_positions))
127 clib_bitmap_free (match);
131 p = vec_elt_at_index (c->sub_command_positions, i);
132 if (vec_len (p->bitmaps) == 0)
136 if (n < 0 || n >= vec_len (p->bitmaps))
140 match = clib_bitmap_dup (p->bitmaps[n]);
142 match = clib_bitmap_and (match, p->bitmaps[n]);
144 if (clib_bitmap_is_zero (match))
152 /* Looks for string based sub-input formatted { SUB-INPUT }. */
154 unformat_vlib_cli_sub_input (unformat_input_t * i, va_list * args)
156 unformat_input_t *sub_input = va_arg (*args, unformat_input_t *);
162 c = unformat_get_input (i);
174 /* Put back paren. */
175 if (c != UNFORMAT_END_OF_INPUT)
176 unformat_put_input (i);
178 if (c == '{' && unformat (i, "%v", &s))
180 unformat_init_vector (sub_input, s);
189 static vlib_cli_command_t *
190 get_sub_command (vlib_cli_main_t * cm, vlib_cli_command_t * parent, u32 si)
192 vlib_cli_sub_command_t *s = vec_elt_at_index (parent->sub_commands, si);
193 return vec_elt_at_index (cm->commands, s->index);
197 unformat_vlib_cli_sub_command (unformat_input_t * i, va_list * args)
199 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
200 vlib_cli_command_t *c = va_arg (*args, vlib_cli_command_t *);
201 vlib_cli_command_t **result = va_arg (*args, vlib_cli_command_t **);
202 vlib_cli_main_t *cm = &vm->cli_main;
203 uword *match_bitmap, is_unique, index;
206 vlib_cli_sub_rule_t *sr;
207 vlib_cli_parse_rule_t *r;
208 vec_foreach (sr, c->sub_rules)
211 r = vec_elt_at_index (cm->parse_rules, sr->rule_index);
212 vec_add2 (cm->parse_rule_data, d, 1);
213 vec_reset_length (d[0]);
215 d[0] = _vec_resize (d[0],
216 /* length increment */ 1,
218 /* header_bytes */ 0,
219 /* data align */ sizeof (uword));
220 if (unformat_user (i, r->unformat_function, vm, d[0]))
222 *result = vec_elt_at_index (cm->commands, sr->command_index);
228 match_bitmap = vlib_cli_sub_command_match (c, i);
229 is_unique = clib_bitmap_count_set_bits (match_bitmap) == 1;
233 index = clib_bitmap_first_set (match_bitmap);
234 *result = get_sub_command (cm, c, index);
236 clib_bitmap_free (match_bitmap);
242 vlib_cli_cmp_strings (void *a1, void *a2)
244 u8 *c1 = *(u8 **) a1;
245 u8 *c2 = *(u8 **) a2;
247 return vec_cmp (c1, c2);
251 vlib_cli_get_possible_completions (u8 * str)
253 vlib_cli_command_t *c;
254 vlib_cli_sub_command_t *sc;
255 vlib_main_t *vm = vlib_get_main ();
256 vlib_cli_main_t *vcm = &vm->cli_main;
257 uword *match_bitmap = 0;
258 uword index, is_unique, help_next_level;
260 unformat_input_t input;
261 unformat_init_vector (&input, vec_dup (str));
262 c = vec_elt_at_index (vcm->commands, 0);
264 /* remove trailing whitespace, except for one of them */
265 while (vec_len (input.buffer) >= 2 &&
266 isspace (input.buffer[vec_len (input.buffer) - 1]) &&
267 isspace (input.buffer[vec_len (input.buffer) - 2]))
269 vec_del1 (input.buffer, vec_len (input.buffer) - 1);
272 /* if input is empty, directly return list of root commands */
273 if (vec_len (input.buffer) == 0 ||
274 (vec_len (input.buffer) == 1 && isspace (input.buffer[0])))
276 vec_foreach (sc, c->sub_commands)
278 vec_add1 (result, (u8 *) sc->name);
283 /* add a trailing '?' so that vlib_cli_sub_command_match can find
284 * all commands starting with the input string */
285 vec_add1 (input.buffer, '?');
289 match_bitmap = vlib_cli_sub_command_match (c, &input);
290 /* no match: return no result */
291 if (match_bitmap == 0)
295 is_unique = clib_bitmap_count_set_bits (match_bitmap) == 1;
296 /* unique match: try to step one subcommand level further */
299 /* stop if no more input */
300 if (input.index >= vec_len (input.buffer) - 1)
305 index = clib_bitmap_first_set (match_bitmap);
306 c = get_sub_command (vcm, c, index);
307 clib_bitmap_free (match_bitmap);
310 /* multiple matches: stop here, return all matches */
314 /* remove trailing '?' */
315 vec_del1 (input.buffer, vec_len (input.buffer) - 1);
317 /* if we have a space at the end of input, and a unique match,
318 * autocomplete the next level of subcommands */
319 help_next_level = (vec_len (str) == 0) || isspace (str[vec_len (str) - 1]);
321 clib_bitmap_foreach(index, match_bitmap, {
322 if (help_next_level && is_unique) {
323 c = get_sub_command (vcm, c, index);
324 vec_foreach (sc, c->sub_commands) {
325 vec_add1 (result, (u8*) sc->name);
327 goto done; /* break doesn't work in this macro-loop */
329 sc = &c->sub_commands[index];
330 vec_add1(result, (u8*) sc->name);
335 clib_bitmap_free (match_bitmap);
336 unformat_free (&input);
339 vec_sort_with_function (result, vlib_cli_cmp_strings);
344 format_vlib_cli_command_help (u8 * s, va_list * args)
346 vlib_cli_command_t *c = va_arg (*args, vlib_cli_command_t *);
347 int is_long = va_arg (*args, int);
348 if (is_long && c->long_help)
349 s = format (s, "%s", c->long_help);
350 else if (c->short_help)
351 s = format (s, "%s", c->short_help);
353 s = format (s, "%v commands", c->path);
358 format_vlib_cli_parse_rule_name (u8 * s, va_list * args)
360 vlib_cli_parse_rule_t *r = va_arg (*args, vlib_cli_parse_rule_t *);
361 return format (s, "<%U>", format_c_identifier, r->name);
365 format_vlib_cli_path (u8 * s, va_list * args)
367 u8 *path = va_arg (*args, u8 *);
370 for (i = 0; i < vec_len (path); i++)
376 vec_add1 (s, '<'); /* start of <RULE> */
380 /* _ -> space in rules. */
381 vec_add1 (s, in_rule ? ' ' : '_');
387 vec_add1 (s, '>'); /* end of <RULE> */
394 vec_add1 (s, path[i]);
400 vec_add1 (s, '>'); /* terminate <RULE> */
405 static vlib_cli_command_t *
406 all_subs (vlib_cli_main_t * cm, vlib_cli_command_t * subs, u32 command_index)
408 vlib_cli_command_t *c = vec_elt_at_index (cm->commands, command_index);
409 vlib_cli_sub_command_t *sc;
410 vlib_cli_sub_rule_t *sr;
413 vec_add1 (subs, c[0]);
415 vec_foreach (sr, c->sub_rules)
416 subs = all_subs (cm, subs, sr->command_index);
417 vec_foreach (sc, c->sub_commands) subs = all_subs (cm, subs, sc->index);
423 vlib_cli_cmp_rule (void *a1, void *a2)
425 vlib_cli_sub_rule_t *r1 = a1;
426 vlib_cli_sub_rule_t *r2 = a2;
428 return vec_cmp (r1->name, r2->name);
432 vlib_cli_cmp_command (void *a1, void *a2)
434 vlib_cli_command_t *c1 = a1;
435 vlib_cli_command_t *c2 = a2;
437 return vec_cmp (c1->path, c2->path);
440 static clib_error_t *
441 vlib_cli_dispatch_sub_commands (vlib_main_t * vm,
442 vlib_cli_main_t * cm,
443 unformat_input_t * input,
444 uword parent_command_index)
446 vlib_cli_command_t *parent, *c;
447 clib_error_t *error = 0;
448 unformat_input_t sub_input;
450 uword is_main_dispatch = cm == &vm->cli_main;
452 parent = vec_elt_at_index (cm->commands, parent_command_index);
453 if (is_main_dispatch && unformat (input, "help"))
455 uword help_at_end_of_line, i;
457 help_at_end_of_line =
458 unformat_check_input (input) == UNFORMAT_END_OF_INPUT;
463 (input, unformat_vlib_cli_sub_command, vm, c, &parent))
466 else if (!(unformat_check_input (input) == UNFORMAT_END_OF_INPUT))
473 /* help SUB-COMMAND => long format help.
474 "help" at end of line: show all commands. */
475 if (!help_at_end_of_line)
476 vlib_cli_output (vm, "%U", format_vlib_cli_command_help, c,
479 else if (vec_len (c->sub_commands) + vec_len (c->sub_rules) == 0)
480 vlib_cli_output (vm, "%v: no sub-commands", c->path);
484 vlib_cli_sub_command_t *sc;
485 vlib_cli_sub_rule_t *sr, *subs;
487 subs = vec_dup (c->sub_rules);
489 /* Add in rules if any. */
490 vec_foreach (sc, c->sub_commands)
492 vec_add2 (subs, sr, 1);
494 sr->command_index = sc->index;
498 vec_sort_with_function (subs, vlib_cli_cmp_rule);
500 for (i = 0; i < vec_len (subs); i++)
502 vlib_cli_command_t *d;
503 vlib_cli_parse_rule_t *r;
505 d = vec_elt_at_index (cm->commands, subs[i].command_index);
507 subs[i].rule_index != ~0 ? vec_elt_at_index (cm->parse_rules,
515 format_vlib_cli_parse_rule_name, r,
516 format_vlib_cli_command_help, d, /* is_long */ 0);
521 format_vlib_cli_command_help, d, /* is_long */ 0);
528 else if (is_main_dispatch
529 && (unformat (input, "choices") || unformat (input, "?")))
531 vlib_cli_command_t *sub, *subs;
533 subs = all_subs (cm, 0, parent_command_index);
534 vec_sort_with_function (subs, vlib_cli_cmp_command);
535 vec_foreach (sub, subs)
536 vlib_cli_output (vm, " %-40U %U",
537 format_vlib_cli_path, sub->path,
538 format_vlib_cli_command_help, sub, /* is_long */ 0);
542 else if (unformat (input, "comment %v", &string))
547 else if (unformat (input, "uncomment %U",
548 unformat_vlib_cli_sub_input, &sub_input))
551 vlib_cli_dispatch_sub_commands (vm, cm, &sub_input,
552 parent_command_index);
553 unformat_free (&sub_input);
557 if (unformat_user (input, unformat_vlib_cli_sub_command, vm, parent, &c))
559 unformat_input_t *si;
560 uword has_sub_commands =
561 vec_len (c->sub_commands) + vec_len (c->sub_rules) > 0;
564 if (unformat_user (input, unformat_vlib_cli_sub_input, &sub_input))
567 if (has_sub_commands)
568 error = vlib_cli_dispatch_sub_commands (vm, cm, si, c - cm->commands);
570 if (has_sub_commands && !error)
571 /* Found valid sub-command. */ ;
573 else if (c->function)
575 clib_error_t *c_error;
577 /* Skip white space for benefit of called function. */
578 unformat_skip_white_space (si);
580 if (unformat (si, "?"))
582 vlib_cli_output (vm, " %-40U %U", format_vlib_cli_path, c->path, format_vlib_cli_command_help, c, /* is_long */
587 if (PREDICT_FALSE (vm->elog_trace_cli_commands))
590 ELOG_TYPE_DECLARE (e) =
592 .format = "cli-cmd: %s",
600 ed = ELOG_DATA (&vm->elog_main, e);
601 ed->c = elog_global_id_for_msg_name (c->path);
605 vlib_worker_thread_barrier_sync (vm);
607 c_error = c->function (vm, si, c);
610 vlib_worker_thread_barrier_release (vm);
612 if (PREDICT_FALSE (vm->elog_trace_cli_commands))
615 ELOG_TYPE_DECLARE (e) =
617 .format = "cli-cmd: %s %s",
618 .format_args = "T4T4",
625 ed = ELOG_DATA (&vm->elog_main, e);
626 ed->c = elog_global_id_for_msg_name (c->path);
629 vec_add1 (c_error->what, 0);
630 ed->err = elog_global_id_for_msg_name
631 ((const char *) c_error->what);
632 _vec_len (c_error->what) -= 1;
635 ed->err = elog_global_id_for_msg_name ("OK");
641 clib_error_return (0, "%v: %v", c->path, c_error->what);
642 clib_error_free (c_error);
643 /* Free sub input. */
651 /* Free any previous error. */
652 clib_error_free (error);
656 error = clib_error_return (0, "%v: no sub-commands", c->path);
658 /* Free sub input. */
670 return clib_error_return (0, "%v: unknown input `%U'", parent->path,
671 format_unformat_error, input);
673 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
678 void vlib_unix_error_report (vlib_main_t *, clib_error_t *)
679 __attribute__ ((weak));
682 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
686 /* Process CLI input. */
688 vlib_cli_input (vlib_main_t * vm,
689 unformat_input_t * input,
690 vlib_cli_output_function_t * function, uword function_arg)
692 vlib_process_t *cp = vlib_get_current_process (vm);
693 vlib_cli_main_t *cm = &vm->cli_main;
695 vlib_cli_output_function_t *save_function;
696 uword save_function_arg;
698 save_function = cp->output_function;
699 save_function_arg = cp->output_function_arg;
701 cp->output_function = function;
702 cp->output_function_arg = function_arg;
706 vec_reset_length (cm->parse_rule_data);
707 error = vlib_cli_dispatch_sub_commands (vm, &vm->cli_main, input, /* parent */
710 while (!error && !unformat (input, "%U", unformat_eof));
714 vlib_cli_output (vm, "%v", error->what);
715 vlib_unix_error_report (vm, error);
716 clib_error_free (error);
719 cp->output_function = save_function;
720 cp->output_function_arg = save_function_arg;
723 /* Output to current CLI connection. */
725 vlib_cli_output (vlib_main_t * vm, char *fmt, ...)
727 vlib_process_t *cp = vlib_get_current_process (vm);
732 s = va_format (0, fmt, &va);
735 /* Terminate with \n if not present. */
736 if (vec_len (s) > 0 && s[vec_len (s) - 1] != '\n')
739 if ((!cp) || (!cp->output_function))
740 fformat (stdout, "%v", s);
742 cp->output_function (cp->output_function_arg, s, vec_len (s));
747 void *vl_msg_push_heap (void) __attribute__ ((weak));
748 void vl_msg_pop_heap (void *oldheap) __attribute__ ((weak));
750 static clib_error_t *
751 show_memory_usage (vlib_main_t * vm,
752 unformat_input_t * input, vlib_cli_command_t * cmd)
754 int verbose __attribute__ ((unused)) = 0, api_segment = 0;
758 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
760 if (unformat (input, "verbose"))
762 else if (unformat (input, "api-segment"))
766 error = clib_error_return (0, "unknown input `%U'",
767 format_unformat_error, input);
774 void *oldheap = vl_msg_push_heap ();
776 format (0, "%U\n", format_mheap, clib_mem_get_heap (), 1);
777 vl_msg_pop_heap (oldheap);
778 u8 *s = vec_dup (s_in_svm);
780 oldheap = vl_msg_push_heap ();
782 vl_msg_pop_heap (oldheap);
783 vlib_cli_output (vm, "API segment start:");
784 vlib_cli_output (vm, "%v", s);
785 vlib_cli_output (vm, "API segment end:");
789 #if USE_DLMALLOC == 0
793 mheap_t *h = mheap_header (clib_per_cpu_mheaps[index]);
794 vlib_cli_output (vm, "%sThread %d %s\n", index ? "\n":"", index,
795 vlib_worker_threads[index].name);
796 vlib_cli_output (vm, " %U\n", format_page_map, pointer_to_uword (h) -
797 h->vm_alloc_offset_from_header,
799 vlib_cli_output (vm, " %U\n", format_mheap, clib_per_cpu_mheaps[index],
806 uword clib_mem_trace_enable_disable (uword enable);
810 * Note: the foreach_vlib_main cause allocator traffic,
811 * so shut off tracing before we go there...
813 was_enabled = clib_mem_trace_enable_disable (0);
818 struct dlmallinfo mi;
820 mspace = clib_per_cpu_mheaps[index];
822 mi = mspace_mallinfo (mspace);
823 vlib_cli_output (vm, "%sThread %d %s\n", index ? "\n":"", index,
824 vlib_worker_threads[index].name);
825 vlib_cli_output (vm, " %U\n", format_page_map,
826 pointer_to_uword (mspace_least_addr(mspace)),
828 vlib_cli_output (vm, " %U\n", format_mheap, clib_per_cpu_mheaps[index],
834 /* Restore the trace flag */
835 clib_mem_trace_enable_disable (was_enabled);
837 #endif /* USE_DLMALLOC */
842 VLIB_CLI_COMMAND (show_memory_usage_command, static) = {
843 .path = "show memory",
844 .short_help = "[verbose | api-segment] Show current memory usage",
845 .function = show_memory_usage,
849 static clib_error_t *
850 show_cpu (vlib_main_t * vm, unformat_input_t * input,
851 vlib_cli_command_t * cmd)
853 #define _(a,b,c) vlib_cli_output (vm, "%-25s " b, a ":", c);
854 _("Model name", "%U", format_cpu_model_name);
855 _("Microarch model (family)", "%U", format_cpu_uarch);
856 _("Flags", "%U", format_cpu_flags);
857 _("Base frequency", "%.2f GHz",
858 ((f64) vm->clib_time.clocks_per_second) * 1e-9);
864 * Displays various information about the CPU.
867 * @cliexstart{show cpu}
868 * Model name: Intel(R) Xeon(R) CPU E5-2667 v4 @ 3.20GHz
869 * Microarchitecture: Broadwell (Broadwell-EP/EX)
870 * Flags: sse3 ssse3 sse41 sse42 avx avx2 aes
871 * Base Frequency: 3.20 GHz
875 VLIB_CLI_COMMAND (show_cpu_command, static) = {
877 .short_help = "Show cpu information",
878 .function = show_cpu,
883 static clib_error_t *
884 enable_disable_memory_trace (vlib_main_t * vm,
885 unformat_input_t * input,
886 vlib_cli_command_t * cmd)
888 unformat_input_t _line_input, *line_input = &_line_input;
894 if (!unformat_user (input, unformat_line_input, line_input))
897 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
899 if (unformat (line_input, "%U", unformat_vlib_enable_disable, &enable))
901 else if (unformat (line_input, "api-segment"))
905 unformat_free (line_input);
906 return clib_error_return (0, "invalid input");
909 unformat_free (line_input);
912 oldheap = vl_msg_push_heap ();
913 clib_mem_trace (enable);
915 vl_msg_pop_heap (oldheap);
921 VLIB_CLI_COMMAND (enable_disable_memory_trace_command, static) = {
922 .path = "memory-trace",
923 .short_help = "on|off [api-segment] Enable/disable memory allocation trace",
924 .function = enable_disable_memory_trace,
929 static clib_error_t *
930 test_heap_validate (vlib_main_t * vm, unformat_input_t * input,
931 vlib_cli_command_t * cmd)
933 #if USE_DLMALLOC == 0
934 clib_error_t *error = 0;
938 if (unformat (input, "on"))
942 heap = clib_per_cpu_mheaps[this_vlib_main->thread_index];
943 mheap = mheap_header(heap);
944 mheap->flags |= MHEAP_FLAG_VALIDATE;
945 // Turn off small object cache because it delays detection of errors
946 mheap->flags &= ~MHEAP_FLAG_SMALL_OBJECT_CACHE;
951 else if (unformat (input, "off"))
955 heap = clib_per_cpu_mheaps[this_vlib_main->thread_index];
956 mheap = mheap_header(heap);
957 mheap->flags &= ~MHEAP_FLAG_VALIDATE;
958 mheap->flags |= MHEAP_FLAG_SMALL_OBJECT_CACHE;
962 else if (unformat (input, "now"))
966 heap = clib_per_cpu_mheaps[this_vlib_main->thread_index];
967 mheap = mheap_header(heap);
968 mheap_validate(heap);
971 vlib_cli_output (vm, "heap validation complete");
976 return clib_error_return (0, "unknown input `%U'",
977 format_unformat_error, input);
982 return clib_error_return (0, "unimplemented...");
983 #endif /* USE_DLMALLOC */
987 VLIB_CLI_COMMAND (cmd_test_heap_validate,static) = {
988 .path = "test heap-validate",
989 .short_help = "<on/off/now> validate heap on future allocs/frees or right now",
990 .function = test_heap_validate,
994 static clib_error_t *
995 restart_cmd_fn (vlib_main_t * vm, unformat_input_t * input,
996 vlib_cli_command_t * cmd)
998 clib_file_main_t *fm = &file_main;
1001 /* environ(7) does not indicate a header for this */
1002 extern char **environ;
1004 /* Close all known open files */
1006 pool_foreach(f, fm->file_pool,
1008 if (f->file_descriptor > 2)
1009 close(f->file_descriptor);
1014 execve (vm->name, (char **) vm->argv, environ);
1020 VLIB_CLI_COMMAND (restart_cmd,static) = {
1022 .short_help = "restart process",
1023 .function = restart_cmd_fn,
1029 * A trivial test harness to verify the per-process output_function
1030 * is working correcty.
1033 static clib_error_t *
1034 sleep_ten_seconds (vlib_main_t * vm,
1035 unformat_input_t * input, vlib_cli_command_t * cmd)
1038 u16 my_id = rand ();
1040 vlib_cli_output (vm, "Starting 10 seconds sleep with id %u\n", my_id);
1042 for (i = 0; i < 10; i++)
1044 vlib_process_wait_for_event_or_clock (vm, 1.0);
1045 vlib_cli_output (vm, "Iteration number %u, my id: %u\n", i, my_id);
1047 vlib_cli_output (vm, "Done with sleep with id %u\n", my_id);
1052 VLIB_CLI_COMMAND (ping_command, static) = {
1053 .path = "test sleep",
1054 .function = sleep_ten_seconds,
1055 .short_help = "Sleep for 10 seconds",
1058 #endif /* ifdef TEST_CODE */
1061 vlib_cli_normalize_path (char *input, char **result)
1066 uword index_of_last_space = ~0;
1071 /* Multiple white space -> single space. */
1078 if (l > 0 && s[l - 1] != ' ')
1086 if (l > 0 && s[l - 1] == ' ')
1087 index_of_last_space = vec_len (s);
1094 /* Remove any extra space at end. */
1095 if (l > 0 && s[l - 1] == ' ')
1099 return index_of_last_space;
1103 parent_path_len (char *path)
1106 for (i = vec_len (path) - 1; i >= 0; i--)
1115 add_sub_command (vlib_cli_main_t * cm, uword parent_index, uword child_index)
1117 vlib_cli_command_t *p, *c;
1118 vlib_cli_sub_command_t *sub_c;
1122 p = vec_elt_at_index (cm->commands, parent_index);
1123 c = vec_elt_at_index (cm->commands, child_index);
1125 l = parent_path_len (c->path);
1127 sub_name = vec_dup ((u8 *) c->path);
1130 ASSERT (l + 1 < vec_len (c->path));
1132 vec_add (sub_name, c->path + l + 1, vec_len (c->path) - (l + 1));
1135 if (sub_name[0] == '%')
1138 vlib_cli_sub_rule_t *sr;
1141 vec_delete (sub_name, 1, 0);
1143 if (!p->sub_rule_index_by_name)
1144 p->sub_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1145 sizeof (sub_name[0]),
1147 q = hash_get_mem (p->sub_rule_index_by_name, sub_name);
1150 sr = vec_elt_at_index (p->sub_rules, q[0]);
1151 ASSERT (sr->command_index == child_index);
1155 q = hash_get_mem (cm->parse_rule_index_by_name, sub_name);
1158 clib_error ("reference to unknown rule `%%%v' in path `%v'",
1163 hash_set_mem (p->sub_rule_index_by_name, sub_name,
1164 vec_len (p->sub_rules));
1165 vec_add2 (p->sub_rules, sr, 1);
1166 sr->name = sub_name;
1167 sr->rule_index = q[0];
1168 sr->command_index = child_index;
1172 if (!p->sub_command_index_by_name)
1173 p->sub_command_index_by_name = hash_create_vec ( /* initial length */ 32,
1174 sizeof (c->path[0]),
1177 /* Check if sub-command has already been created. */
1178 if (hash_get_mem (p->sub_command_index_by_name, sub_name))
1180 vec_free (sub_name);
1184 vec_add2 (p->sub_commands, sub_c, 1);
1185 sub_c->index = child_index;
1186 sub_c->name = sub_name;
1187 hash_set_mem (p->sub_command_index_by_name, sub_c->name,
1188 sub_c - p->sub_commands);
1190 vec_validate (p->sub_command_positions, vec_len (sub_c->name) - 1);
1191 for (i = 0; i < vec_len (sub_c->name); i++)
1194 vlib_cli_parse_position_t *pos;
1196 pos = vec_elt_at_index (p->sub_command_positions, i);
1199 pos->min_char = sub_c->name[i];
1201 n = sub_c->name[i] - pos->min_char;
1204 pos->min_char = sub_c->name[i];
1205 vec_insert (pos->bitmaps, -n, 0);
1209 vec_validate (pos->bitmaps, n);
1211 clib_bitmap_ori (pos->bitmaps[n], sub_c - p->sub_commands);
1216 vlib_cli_make_parent (vlib_cli_main_t * cm, uword ci)
1218 uword p_len, pi, *p;
1220 vlib_cli_command_t *c, *parent;
1222 /* Root command (index 0) should have already been added. */
1223 ASSERT (vec_len (cm->commands) > 0);
1225 c = vec_elt_at_index (cm->commands, ci);
1226 p_len = parent_path_len (c->path);
1228 /* No space? Parent is root command. */
1231 add_sub_command (cm, 0, ci);
1236 vec_add (p_path, c->path, p_len);
1238 p = hash_get_mem (cm->command_index_by_path, p_path);
1240 /* Parent exists? */
1243 /* Parent does not exist; create it. */
1244 vec_add2 (cm->commands, parent, 1);
1245 parent->path = p_path;
1246 hash_set_mem (cm->command_index_by_path, parent->path,
1247 parent - cm->commands);
1248 pi = parent - cm->commands;
1256 add_sub_command (cm, pi, ci);
1258 /* Create parent's parent. */
1260 vlib_cli_make_parent (cm, pi);
1264 vlib_cli_command_is_empty (vlib_cli_command_t * c)
1266 return (c->long_help == 0 && c->short_help == 0 && c->function == 0);
1270 vlib_cli_register (vlib_main_t * vm, vlib_cli_command_t * c)
1272 vlib_cli_main_t *cm = &vm->cli_main;
1273 clib_error_t *error = 0;
1275 char *normalized_path;
1277 if ((error = vlib_call_init_function (vm, vlib_cli_init)))
1280 (void) vlib_cli_normalize_path (c->path, &normalized_path);
1282 if (!cm->command_index_by_path)
1283 cm->command_index_by_path = hash_create_vec ( /* initial length */ 32,
1284 sizeof (c->path[0]),
1287 /* See if command already exists with given path. */
1288 p = hash_get_mem (cm->command_index_by_path, normalized_path);
1291 vlib_cli_command_t *d;
1294 d = vec_elt_at_index (cm->commands, ci);
1296 /* If existing command was created via vlib_cli_make_parent
1297 replaced it with callers data. */
1298 if (vlib_cli_command_is_empty (d))
1300 vlib_cli_command_t save = d[0];
1302 ASSERT (!vlib_cli_command_is_empty (c));
1304 /* Copy callers fields. */
1307 /* Save internal fields. */
1308 d->path = save.path;
1309 d->sub_commands = save.sub_commands;
1310 d->sub_command_index_by_name = save.sub_command_index_by_name;
1311 d->sub_command_positions = save.sub_command_positions;
1312 d->sub_rules = save.sub_rules;
1316 clib_error_return (0, "duplicate command name with path %v",
1319 vec_free (normalized_path);
1325 /* Command does not exist: create it. */
1327 /* Add root command (index 0). */
1328 if (vec_len (cm->commands) == 0)
1330 /* Create command with index 0; path is empty string. */
1331 vec_resize (cm->commands, 1);
1334 ci = vec_len (cm->commands);
1335 hash_set_mem (cm->command_index_by_path, normalized_path, ci);
1336 vec_add1 (cm->commands, c[0]);
1338 c = vec_elt_at_index (cm->commands, ci);
1339 c->path = normalized_path;
1341 /* Don't inherit from registration. */
1342 c->sub_commands = 0;
1343 c->sub_command_index_by_name = 0;
1344 c->sub_command_positions = 0;
1347 vlib_cli_make_parent (cm, ci);
1352 vlib_cli_register_parse_rule (vlib_main_t * vm, vlib_cli_parse_rule_t * r_reg)
1354 vlib_cli_main_t *cm = &vm->cli_main;
1355 vlib_cli_parse_rule_t *r;
1356 clib_error_t *error = 0;
1360 if (!cm->parse_rule_index_by_name)
1361 cm->parse_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1362 sizeof (r->name[0]),
1365 /* Make vector copy of name. */
1366 r_name = format (0, "%s", r_reg->name);
1368 if ((p = hash_get_mem (cm->parse_rule_index_by_name, r_name)))
1371 return clib_error_return (0, "duplicate parse rule name `%s'",
1375 vec_add2 (cm->parse_rules, r, 1);
1377 r->name = (char *) r_name;
1378 hash_set_mem (cm->parse_rule_index_by_name, r->name, r - cm->parse_rules);
1384 /* $$$ turn back on again someday, maybe */
1385 static clib_error_t *vlib_cli_register_parse_rules (vlib_main_t * vm,
1386 vlib_cli_parse_rule_t *
1388 vlib_cli_parse_rule_t *
1390 __attribute__ ((unused))
1392 clib_error_t *error = 0;
1393 vlib_cli_parse_rule_t *r;
1395 for (r = lo; r < hi; r = clib_elf_section_data_next (r, 0))
1397 if (!r->name || strlen (r->name) == 0)
1399 error = clib_error_return (0, "parse rule with no name");
1403 error = vlib_cli_register_parse_rule (vm, r);
1414 cli_path_compare (void *a1, void *a2)
1419 if ((vec_len (*s1) < vec_len (*s2)) &&
1420 memcmp ((char *) *s1, (char *) *s2, vec_len (*s1)) == 0)
1424 if ((vec_len (*s1) > vec_len (*s2)) &&
1425 memcmp ((char *) *s1, (char *) *s2, vec_len (*s2)) == 0)
1428 return vec_cmp (*s1, *s2);
1431 static clib_error_t *
1432 show_cli_cmd_fn (vlib_main_t * vm, unformat_input_t * input,
1433 vlib_cli_command_t * cmd)
1435 vlib_cli_main_t *cm = &vm->cli_main;
1436 vlib_cli_command_t *cli;
1437 u8 **paths = 0, **s;
1440 vec_foreach (cli, cm->commands)
1441 if (vec_len (cli->path) > 0)
1442 vec_add1 (paths, (u8 *) cli->path);
1444 vec_sort_with_function (paths, cli_path_compare);
1446 vec_foreach (s, paths)
1447 vlib_cli_output (vm, "%v", *s);
1455 VLIB_CLI_COMMAND (show_cli_command, static) = {
1457 .short_help = "Show cli commands",
1458 .function = show_cli_cmd_fn,
1462 static clib_error_t *
1463 elog_trace_command_fn (vlib_main_t * vm,
1464 unformat_input_t * input, vlib_cli_command_t * cmd)
1466 unformat_input_t _line_input, *line_input = &_line_input;
1468 int api = 0, cli = 0, barrier = 0, dispatch = 0, circuit = 0;
1469 u32 circuit_node_index;
1471 if (!unformat_user (input, unformat_line_input, line_input))
1474 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1476 if (unformat (line_input, "api"))
1478 else if (unformat (line_input, "dispatch"))
1480 else if (unformat (line_input, "circuit-node %U",
1481 unformat_vlib_node, vm, &circuit_node_index))
1483 else if (unformat (line_input, "cli"))
1485 else if (unformat (line_input, "barrier"))
1487 else if (unformat (line_input, "disable"))
1489 else if (unformat (line_input, "enable"))
1494 unformat_free (line_input);
1496 vm->elog_trace_api_messages = api ? enable : vm->elog_trace_api_messages;
1497 vm->elog_trace_cli_commands = cli ? enable : vm->elog_trace_cli_commands;
1498 vm->elog_trace_graph_dispatch = dispatch ?
1499 enable : vm->elog_trace_graph_dispatch;
1500 vm->elog_trace_graph_circuit = circuit ?
1501 enable : vm->elog_trace_graph_circuit;
1502 vlib_worker_threads->barrier_elog_enabled =
1503 barrier ? enable : vlib_worker_threads->barrier_elog_enabled;
1504 vm->elog_trace_graph_circuit_node_index = circuit_node_index;
1507 * Set up start-of-buffer logic-analyzer trigger
1508 * for main loop event logs, which are fairly heavyweight.
1509 * See src/vlib/main/vlib_elog_main_loop_event(...), which
1510 * will fully disable the scheme when the elog buffer fills.
1512 if (dispatch || circuit)
1514 elog_main_t *em = &vm->elog_main;
1516 em->n_total_events_disable_limit =
1517 em->n_total_events + vec_len (em->event_ring);
1522 vlib_cli_output (vm, "Current status:");
1525 (vm, " Event log API message trace: %s\n CLI command trace: %s",
1526 vm->elog_trace_api_messages ? "on" : "off",
1527 vm->elog_trace_cli_commands ? "on" : "off");
1529 (vm, " Barrier sync trace: %s",
1530 vlib_worker_threads->barrier_elog_enabled ? "on" : "off");
1532 (vm, " Graph Dispatch: %s",
1533 vm->elog_trace_graph_dispatch ? "on" : "off");
1535 (vm, " Graph Circuit: %s",
1536 vm->elog_trace_graph_circuit ? "on" : "off");
1537 if (vm->elog_trace_graph_circuit)
1540 format_vlib_node_name, vm, vm->elog_trace_graph_circuit_node_index);
1546 * Control event logging of api, cli, and thread barrier events
1547 * With no arguments, displays the current trace status.
1548 * Name the event groups you wish to trace or stop tracing.
1552 * elog trace api cli barrier
1553 * elog trace api cli barrier disable
1554 * elog trace dispatch
1555 * elog trace circuit-node ethernet-input
1558 * @cliexcmd{elog trace [api][cli][barrier][disable]}
1561 VLIB_CLI_COMMAND (elog_trace_command, static) =
1563 .path = "elog trace",
1564 .short_help = "elog trace [api][cli][barrier][dispatch]\n"
1565 "[circuit-node <name> e.g. ethernet-input][disable]",
1566 .function = elog_trace_command_fn,
1570 static clib_error_t *
1571 vlib_cli_init (vlib_main_t * vm)
1573 vlib_cli_main_t *cm = &vm->cli_main;
1574 clib_error_t *error = 0;
1575 vlib_cli_command_t *cmd;
1577 cmd = cm->cli_command_registrations;
1581 error = vlib_cli_register (vm, cmd);
1584 cmd = cmd->next_cli_command;
1589 VLIB_INIT_FUNCTION (vlib_cli_init);
1592 * fd.io coding-style-patch-verification: ON
1595 * eval: (c-set-style "gnu")