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;
699 save_function = cp->output_function;
700 save_function_arg = cp->output_function_arg;
702 cp->output_function = function;
703 cp->output_function_arg = function_arg;
707 vec_reset_length (cm->parse_rule_data);
708 error = vlib_cli_dispatch_sub_commands (vm, &vm->cli_main, input, /* parent */
711 while (!error && !unformat (input, "%U", unformat_eof));
715 vlib_cli_output (vm, "%v", error->what);
716 vlib_unix_error_report (vm, error);
717 /* clib_error_return is unfortunately often called with a '0'
719 rv = error->code != 0 ? error->code : -1;
720 clib_error_free (error);
723 cp->output_function = save_function;
724 cp->output_function_arg = save_function_arg;
728 /* Output to current CLI connection. */
730 vlib_cli_output (vlib_main_t * vm, char *fmt, ...)
732 vlib_process_t *cp = vlib_get_current_process (vm);
737 s = va_format (0, fmt, &va);
740 /* Terminate with \n if not present. */
741 if (vec_len (s) > 0 && s[vec_len (s) - 1] != '\n')
744 if ((!cp) || (!cp->output_function))
745 fformat (stdout, "%v", s);
747 cp->output_function (cp->output_function_arg, s, vec_len (s));
752 void *vl_msg_push_heap (void) __attribute__ ((weak));
753 void vl_msg_pop_heap (void *oldheap) __attribute__ ((weak));
755 static clib_error_t *
756 show_memory_usage (vlib_main_t * vm,
757 unformat_input_t * input, vlib_cli_command_t * cmd)
759 int verbose __attribute__ ((unused)) = 0, api_segment = 0;
763 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
765 if (unformat (input, "verbose"))
767 else if (unformat (input, "api-segment"))
771 error = clib_error_return (0, "unknown input `%U'",
772 format_unformat_error, input);
779 void *oldheap = vl_msg_push_heap ();
781 format (0, "%U\n", format_mheap, clib_mem_get_heap (), 1);
782 vl_msg_pop_heap (oldheap);
783 u8 *s = vec_dup (s_in_svm);
785 oldheap = vl_msg_push_heap ();
787 vl_msg_pop_heap (oldheap);
788 vlib_cli_output (vm, "API segment start:");
789 vlib_cli_output (vm, "%v", s);
790 vlib_cli_output (vm, "API segment end:");
794 #if USE_DLMALLOC == 0
798 mheap_t *h = mheap_header (clib_per_cpu_mheaps[index]);
799 vlib_cli_output (vm, "%sThread %d %s\n", index ? "\n":"", index,
800 vlib_worker_threads[index].name);
801 vlib_cli_output (vm, " %U\n", format_page_map, pointer_to_uword (h) -
802 h->vm_alloc_offset_from_header,
804 vlib_cli_output (vm, " %U\n", format_mheap, clib_per_cpu_mheaps[index],
811 uword clib_mem_trace_enable_disable (uword enable);
815 * Note: the foreach_vlib_main cause allocator traffic,
816 * so shut off tracing before we go there...
818 was_enabled = clib_mem_trace_enable_disable (0);
823 struct dlmallinfo mi;
825 mspace = clib_per_cpu_mheaps[index];
827 mi = mspace_mallinfo (mspace);
828 vlib_cli_output (vm, "%sThread %d %s\n", index ? "\n":"", index,
829 vlib_worker_threads[index].name);
830 vlib_cli_output (vm, " %U\n", format_page_map,
831 pointer_to_uword (mspace_least_addr(mspace)),
833 vlib_cli_output (vm, " %U\n", format_mheap, clib_per_cpu_mheaps[index],
839 /* Restore the trace flag */
840 clib_mem_trace_enable_disable (was_enabled);
842 #endif /* USE_DLMALLOC */
847 VLIB_CLI_COMMAND (show_memory_usage_command, static) = {
848 .path = "show memory",
849 .short_help = "[verbose | api-segment] Show current memory usage",
850 .function = show_memory_usage,
854 static clib_error_t *
855 show_cpu (vlib_main_t * vm, unformat_input_t * input,
856 vlib_cli_command_t * cmd)
858 #define _(a,b,c) vlib_cli_output (vm, "%-25s " b, a ":", c);
859 _("Model name", "%U", format_cpu_model_name);
860 _("Microarch model (family)", "%U", format_cpu_uarch);
861 _("Flags", "%U", format_cpu_flags);
862 _("Base frequency", "%.2f GHz",
863 ((f64) vm->clib_time.clocks_per_second) * 1e-9);
869 * Displays various information about the CPU.
872 * @cliexstart{show cpu}
873 * Model name: Intel(R) Xeon(R) CPU E5-2667 v4 @ 3.20GHz
874 * Microarchitecture: Broadwell (Broadwell-EP/EX)
875 * Flags: sse3 ssse3 sse41 sse42 avx avx2 aes
876 * Base Frequency: 3.20 GHz
880 VLIB_CLI_COMMAND (show_cpu_command, static) = {
882 .short_help = "Show cpu information",
883 .function = show_cpu,
888 static clib_error_t *
889 enable_disable_memory_trace (vlib_main_t * vm,
890 unformat_input_t * input,
891 vlib_cli_command_t * cmd)
893 unformat_input_t _line_input, *line_input = &_line_input;
899 if (!unformat_user (input, unformat_line_input, line_input))
902 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
904 if (unformat (line_input, "%U", unformat_vlib_enable_disable, &enable))
906 else if (unformat (line_input, "api-segment"))
910 unformat_free (line_input);
911 return clib_error_return (0, "invalid input");
914 unformat_free (line_input);
917 oldheap = vl_msg_push_heap ();
918 clib_mem_trace (enable);
920 vl_msg_pop_heap (oldheap);
926 VLIB_CLI_COMMAND (enable_disable_memory_trace_command, static) = {
927 .path = "memory-trace",
928 .short_help = "on|off [api-segment] Enable/disable memory allocation trace",
929 .function = enable_disable_memory_trace,
934 static clib_error_t *
935 test_heap_validate (vlib_main_t * vm, unformat_input_t * input,
936 vlib_cli_command_t * cmd)
938 #if USE_DLMALLOC == 0
939 clib_error_t *error = 0;
943 if (unformat (input, "on"))
947 heap = clib_per_cpu_mheaps[this_vlib_main->thread_index];
948 mheap = mheap_header(heap);
949 mheap->flags |= MHEAP_FLAG_VALIDATE;
950 // Turn off small object cache because it delays detection of errors
951 mheap->flags &= ~MHEAP_FLAG_SMALL_OBJECT_CACHE;
956 else if (unformat (input, "off"))
960 heap = clib_per_cpu_mheaps[this_vlib_main->thread_index];
961 mheap = mheap_header(heap);
962 mheap->flags &= ~MHEAP_FLAG_VALIDATE;
963 mheap->flags |= MHEAP_FLAG_SMALL_OBJECT_CACHE;
967 else if (unformat (input, "now"))
971 heap = clib_per_cpu_mheaps[this_vlib_main->thread_index];
972 mheap = mheap_header(heap);
973 mheap_validate(heap);
976 vlib_cli_output (vm, "heap validation complete");
981 return clib_error_return (0, "unknown input `%U'",
982 format_unformat_error, input);
987 return clib_error_return (0, "unimplemented...");
988 #endif /* USE_DLMALLOC */
992 VLIB_CLI_COMMAND (cmd_test_heap_validate,static) = {
993 .path = "test heap-validate",
994 .short_help = "<on/off/now> validate heap on future allocs/frees or right now",
995 .function = test_heap_validate,
999 static clib_error_t *
1000 restart_cmd_fn (vlib_main_t * vm, unformat_input_t * input,
1001 vlib_cli_command_t * cmd)
1003 clib_file_main_t *fm = &file_main;
1006 /* environ(7) does not indicate a header for this */
1007 extern char **environ;
1009 /* Close all known open files */
1011 pool_foreach(f, fm->file_pool,
1013 if (f->file_descriptor > 2)
1014 close(f->file_descriptor);
1019 execve (vm->name, (char **) vm->argv, environ);
1025 VLIB_CLI_COMMAND (restart_cmd,static) = {
1027 .short_help = "restart process",
1028 .function = restart_cmd_fn,
1034 * A trivial test harness to verify the per-process output_function
1035 * is working correcty.
1038 static clib_error_t *
1039 sleep_ten_seconds (vlib_main_t * vm,
1040 unformat_input_t * input, vlib_cli_command_t * cmd)
1043 u16 my_id = rand ();
1045 vlib_cli_output (vm, "Starting 10 seconds sleep with id %u\n", my_id);
1047 for (i = 0; i < 10; i++)
1049 vlib_process_wait_for_event_or_clock (vm, 1.0);
1050 vlib_cli_output (vm, "Iteration number %u, my id: %u\n", i, my_id);
1052 vlib_cli_output (vm, "Done with sleep with id %u\n", my_id);
1057 VLIB_CLI_COMMAND (ping_command, static) = {
1058 .path = "test sleep",
1059 .function = sleep_ten_seconds,
1060 .short_help = "Sleep for 10 seconds",
1063 #endif /* ifdef TEST_CODE */
1066 vlib_cli_normalize_path (char *input, char **result)
1071 uword index_of_last_space = ~0;
1076 /* Multiple white space -> single space. */
1083 if (l > 0 && s[l - 1] != ' ')
1091 if (l > 0 && s[l - 1] == ' ')
1092 index_of_last_space = vec_len (s);
1099 /* Remove any extra space at end. */
1100 if (l > 0 && s[l - 1] == ' ')
1104 return index_of_last_space;
1108 parent_path_len (char *path)
1111 for (i = vec_len (path) - 1; i >= 0; i--)
1120 add_sub_command (vlib_cli_main_t * cm, uword parent_index, uword child_index)
1122 vlib_cli_command_t *p, *c;
1123 vlib_cli_sub_command_t *sub_c;
1127 p = vec_elt_at_index (cm->commands, parent_index);
1128 c = vec_elt_at_index (cm->commands, child_index);
1130 l = parent_path_len (c->path);
1132 sub_name = vec_dup ((u8 *) c->path);
1135 ASSERT (l + 1 < vec_len (c->path));
1137 vec_add (sub_name, c->path + l + 1, vec_len (c->path) - (l + 1));
1140 if (sub_name[0] == '%')
1143 vlib_cli_sub_rule_t *sr;
1146 vec_delete (sub_name, 1, 0);
1148 if (!p->sub_rule_index_by_name)
1149 p->sub_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1150 sizeof (sub_name[0]),
1152 q = hash_get_mem (p->sub_rule_index_by_name, sub_name);
1155 sr = vec_elt_at_index (p->sub_rules, q[0]);
1156 ASSERT (sr->command_index == child_index);
1160 q = hash_get_mem (cm->parse_rule_index_by_name, sub_name);
1163 clib_error ("reference to unknown rule `%%%v' in path `%v'",
1168 hash_set_mem (p->sub_rule_index_by_name, sub_name,
1169 vec_len (p->sub_rules));
1170 vec_add2 (p->sub_rules, sr, 1);
1171 sr->name = sub_name;
1172 sr->rule_index = q[0];
1173 sr->command_index = child_index;
1177 if (!p->sub_command_index_by_name)
1178 p->sub_command_index_by_name = hash_create_vec ( /* initial length */ 32,
1179 sizeof (c->path[0]),
1182 /* Check if sub-command has already been created. */
1183 if (hash_get_mem (p->sub_command_index_by_name, sub_name))
1185 vec_free (sub_name);
1189 vec_add2 (p->sub_commands, sub_c, 1);
1190 sub_c->index = child_index;
1191 sub_c->name = sub_name;
1192 hash_set_mem (p->sub_command_index_by_name, sub_c->name,
1193 sub_c - p->sub_commands);
1195 vec_validate (p->sub_command_positions, vec_len (sub_c->name) - 1);
1196 for (i = 0; i < vec_len (sub_c->name); i++)
1199 vlib_cli_parse_position_t *pos;
1201 pos = vec_elt_at_index (p->sub_command_positions, i);
1204 pos->min_char = sub_c->name[i];
1206 n = sub_c->name[i] - pos->min_char;
1209 pos->min_char = sub_c->name[i];
1210 vec_insert (pos->bitmaps, -n, 0);
1214 vec_validate (pos->bitmaps, n);
1216 clib_bitmap_ori (pos->bitmaps[n], sub_c - p->sub_commands);
1221 vlib_cli_make_parent (vlib_cli_main_t * cm, uword ci)
1223 uword p_len, pi, *p;
1225 vlib_cli_command_t *c, *parent;
1227 /* Root command (index 0) should have already been added. */
1228 ASSERT (vec_len (cm->commands) > 0);
1230 c = vec_elt_at_index (cm->commands, ci);
1231 p_len = parent_path_len (c->path);
1233 /* No space? Parent is root command. */
1236 add_sub_command (cm, 0, ci);
1241 vec_add (p_path, c->path, p_len);
1243 p = hash_get_mem (cm->command_index_by_path, p_path);
1245 /* Parent exists? */
1248 /* Parent does not exist; create it. */
1249 vec_add2 (cm->commands, parent, 1);
1250 parent->path = p_path;
1251 hash_set_mem (cm->command_index_by_path, parent->path,
1252 parent - cm->commands);
1253 pi = parent - cm->commands;
1261 add_sub_command (cm, pi, ci);
1263 /* Create parent's parent. */
1265 vlib_cli_make_parent (cm, pi);
1269 vlib_cli_command_is_empty (vlib_cli_command_t * c)
1271 return (c->long_help == 0 && c->short_help == 0 && c->function == 0);
1275 vlib_cli_register (vlib_main_t * vm, vlib_cli_command_t * c)
1277 vlib_cli_main_t *cm = &vm->cli_main;
1278 clib_error_t *error = 0;
1280 char *normalized_path;
1282 if ((error = vlib_call_init_function (vm, vlib_cli_init)))
1285 (void) vlib_cli_normalize_path (c->path, &normalized_path);
1287 if (!cm->command_index_by_path)
1288 cm->command_index_by_path = hash_create_vec ( /* initial length */ 32,
1289 sizeof (c->path[0]),
1292 /* See if command already exists with given path. */
1293 p = hash_get_mem (cm->command_index_by_path, normalized_path);
1296 vlib_cli_command_t *d;
1299 d = vec_elt_at_index (cm->commands, ci);
1301 /* If existing command was created via vlib_cli_make_parent
1302 replaced it with callers data. */
1303 if (vlib_cli_command_is_empty (d))
1305 vlib_cli_command_t save = d[0];
1307 ASSERT (!vlib_cli_command_is_empty (c));
1309 /* Copy callers fields. */
1312 /* Save internal fields. */
1313 d->path = save.path;
1314 d->sub_commands = save.sub_commands;
1315 d->sub_command_index_by_name = save.sub_command_index_by_name;
1316 d->sub_command_positions = save.sub_command_positions;
1317 d->sub_rules = save.sub_rules;
1321 clib_error_return (0, "duplicate command name with path %v",
1324 vec_free (normalized_path);
1330 /* Command does not exist: create it. */
1332 /* Add root command (index 0). */
1333 if (vec_len (cm->commands) == 0)
1335 /* Create command with index 0; path is empty string. */
1336 vec_resize (cm->commands, 1);
1339 ci = vec_len (cm->commands);
1340 hash_set_mem (cm->command_index_by_path, normalized_path, ci);
1341 vec_add1 (cm->commands, c[0]);
1343 c = vec_elt_at_index (cm->commands, ci);
1344 c->path = normalized_path;
1346 /* Don't inherit from registration. */
1347 c->sub_commands = 0;
1348 c->sub_command_index_by_name = 0;
1349 c->sub_command_positions = 0;
1352 vlib_cli_make_parent (cm, ci);
1357 vlib_cli_register_parse_rule (vlib_main_t * vm, vlib_cli_parse_rule_t * r_reg)
1359 vlib_cli_main_t *cm = &vm->cli_main;
1360 vlib_cli_parse_rule_t *r;
1361 clib_error_t *error = 0;
1365 if (!cm->parse_rule_index_by_name)
1366 cm->parse_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1367 sizeof (r->name[0]),
1370 /* Make vector copy of name. */
1371 r_name = format (0, "%s", r_reg->name);
1373 if ((p = hash_get_mem (cm->parse_rule_index_by_name, r_name)))
1376 return clib_error_return (0, "duplicate parse rule name `%s'",
1380 vec_add2 (cm->parse_rules, r, 1);
1382 r->name = (char *) r_name;
1383 hash_set_mem (cm->parse_rule_index_by_name, r->name, r - cm->parse_rules);
1389 /* $$$ turn back on again someday, maybe */
1390 static clib_error_t *vlib_cli_register_parse_rules (vlib_main_t * vm,
1391 vlib_cli_parse_rule_t *
1393 vlib_cli_parse_rule_t *
1395 __attribute__ ((unused))
1397 clib_error_t *error = 0;
1398 vlib_cli_parse_rule_t *r;
1400 for (r = lo; r < hi; r = clib_elf_section_data_next (r, 0))
1402 if (!r->name || strlen (r->name) == 0)
1404 error = clib_error_return (0, "parse rule with no name");
1408 error = vlib_cli_register_parse_rule (vm, r);
1419 cli_path_compare (void *a1, void *a2)
1424 if ((vec_len (*s1) < vec_len (*s2)) &&
1425 memcmp ((char *) *s1, (char *) *s2, vec_len (*s1)) == 0)
1429 if ((vec_len (*s1) > vec_len (*s2)) &&
1430 memcmp ((char *) *s1, (char *) *s2, vec_len (*s2)) == 0)
1433 return vec_cmp (*s1, *s2);
1436 static clib_error_t *
1437 show_cli_cmd_fn (vlib_main_t * vm, unformat_input_t * input,
1438 vlib_cli_command_t * cmd)
1440 vlib_cli_main_t *cm = &vm->cli_main;
1441 vlib_cli_command_t *cli;
1442 u8 **paths = 0, **s;
1445 vec_foreach (cli, cm->commands)
1446 if (vec_len (cli->path) > 0)
1447 vec_add1 (paths, (u8 *) cli->path);
1449 vec_sort_with_function (paths, cli_path_compare);
1451 vec_foreach (s, paths)
1452 vlib_cli_output (vm, "%v", *s);
1460 VLIB_CLI_COMMAND (show_cli_command, static) = {
1462 .short_help = "Show cli commands",
1463 .function = show_cli_cmd_fn,
1467 static clib_error_t *
1468 elog_trace_command_fn (vlib_main_t * vm,
1469 unformat_input_t * input, vlib_cli_command_t * cmd)
1471 unformat_input_t _line_input, *line_input = &_line_input;
1473 int api = 0, cli = 0, barrier = 0, dispatch = 0, circuit = 0;
1474 u32 circuit_node_index;
1476 if (!unformat_user (input, unformat_line_input, line_input))
1479 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1481 if (unformat (line_input, "api"))
1483 else if (unformat (line_input, "dispatch"))
1485 else if (unformat (line_input, "circuit-node %U",
1486 unformat_vlib_node, vm, &circuit_node_index))
1488 else if (unformat (line_input, "cli"))
1490 else if (unformat (line_input, "barrier"))
1492 else if (unformat (line_input, "disable"))
1494 else if (unformat (line_input, "enable"))
1499 unformat_free (line_input);
1501 vm->elog_trace_api_messages = api ? enable : vm->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 vm->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 vlib_cli_init (vlib_main_t * vm)
1578 vlib_cli_main_t *cm = &vm->cli_main;
1579 clib_error_t *error = 0;
1580 vlib_cli_command_t *cmd;
1582 cmd = cm->cli_command_registrations;
1586 error = vlib_cli_register (vm, cmd);
1589 cmd = cmd->next_cli_command;
1594 VLIB_INIT_FUNCTION (vlib_cli_init);
1597 * fd.io coding-style-patch-verification: ON
1600 * eval: (c-set-style "gnu")