FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
cli.c
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /*
16  * cli.c: command line interface
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
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:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
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.
38  */
39 
40 #include <vlib/vlib.h>
41 #include <vlib/unix/unix.h>
42 #include <vppinfra/callback.h>
43 #include <vppinfra/cpu.h>
44 #include <vppinfra/elog.h>
45 #include <unistd.h>
46 #include <ctype.h>
47 
48 /** \file src/vlib/cli.c Debug CLI Implementation
49  */
50 
51 int vl_api_set_elog_trace_api_messages (int enable);
53 
54 static void *current_traced_heap;
55 
56 /* Root of all show commands. */
57 /* *INDENT-OFF* */
58 VLIB_CLI_COMMAND (vlib_cli_show_command, static) = {
59  .path = "show",
60  .short_help = "Show commands",
61 };
62 /* *INDENT-ON* */
63 
64 /* Root of all clear commands. */
65 /* *INDENT-OFF* */
66 VLIB_CLI_COMMAND (vlib_cli_clear_command, static) = {
67  .path = "clear",
68  .short_help = "Clear commands",
69 };
70 /* *INDENT-ON* */
71 
72 /* Root of all set commands. */
73 /* *INDENT-OFF* */
74 VLIB_CLI_COMMAND (vlib_cli_set_command, static) = {
75  .path = "set",
76  .short_help = "Set commands",
77 };
78 /* *INDENT-ON* */
79 
80 /* Root of all test commands. */
81 /* *INDENT-OFF* */
82 VLIB_CLI_COMMAND (vlib_cli_test_command, static) = {
83  .path = "test",
84  .short_help = "Test commands",
85 };
86 /* *INDENT-ON* */
87 
88 /* Returns bitmap of commands which match key. */
89 static uword *
91 {
92  int i, n;
93  uword *match = 0;
95 
97 
98  for (i = 0;; i++)
99  {
100  uword k;
101 
102  k = unformat_get_input (input);
103  switch (k)
104  {
105  case 'a' ... 'z':
106  case 'A' ... 'Z':
107  case '0' ... '9':
108  case '-':
109  case '_':
110  break;
111 
112  case ' ':
113  case '\t':
114  case '\r':
115  case '\n':
117  /* White space or end of input removes any non-white
118  matches that were before possible. */
119  if (i < vec_len (c->sub_command_positions)
120  && clib_bitmap_count_set_bits (match) > 1)
121  {
123  for (n = 0; n < vec_len (p->bitmaps); n++)
124  match = clib_bitmap_andnot (match, p->bitmaps[n]);
125  }
126  goto done;
127 
128  default:
129  unformat_put_input (input);
130  goto done;
131  }
132 
133  if (i >= vec_len (c->sub_command_positions))
134  {
135  no_match:
136  clib_bitmap_free (match);
137  return 0;
138  }
139 
141  if (vec_len (p->bitmaps) == 0)
142  goto no_match;
143 
144  n = k - p->min_char;
145  if (n < 0 || n >= vec_len (p->bitmaps))
146  goto no_match;
147 
148  if (i == 0)
149  match = clib_bitmap_dup (p->bitmaps[n]);
150  else
151  match = clib_bitmap_and (match, p->bitmaps[n]);
152 
153  if (clib_bitmap_is_zero (match))
154  goto no_match;
155  }
156 
157 done:
158  return match;
159 }
160 
161 /* Looks for string based sub-input formatted { SUB-INPUT }. */
162 uword
164 {
165  unformat_input_t *sub_input = va_arg (*args, unformat_input_t *);
166  u8 *s;
167  uword c;
168 
169  while (1)
170  {
171  c = unformat_get_input (i);
172  switch (c)
173  {
174  case ' ':
175  case '\t':
176  case '\n':
177  case '\r':
178  case '\f':
179  break;
180 
181  case '{':
182  default:
183  /* Put back paren. */
184  if (c != UNFORMAT_END_OF_INPUT)
185  unformat_put_input (i);
186 
187  if (c == '{' && unformat (i, "%v", &s))
188  {
189  unformat_init_vector (sub_input, s);
190  return 1;
191  }
192  return 0;
193  }
194  }
195  return 0;
196 }
197 
198 static vlib_cli_command_t *
200 {
202  return vec_elt_at_index (cm->commands, s->index);
203 }
204 
205 static uword
207 {
208  vlib_main_t *vm = va_arg (*args, vlib_main_t *);
209  vlib_cli_command_t *c = va_arg (*args, vlib_cli_command_t *);
210  vlib_cli_command_t **result = va_arg (*args, vlib_cli_command_t **);
211  vlib_cli_main_t *cm = &vm->cli_main;
212  uword *match_bitmap, is_unique, index;
213 
214  match_bitmap = vlib_cli_sub_command_match (c, i);
215  is_unique = clib_bitmap_count_set_bits (match_bitmap) == 1;
216  index = ~0;
217  if (is_unique)
218  {
219  index = clib_bitmap_first_set (match_bitmap);
220  *result = get_sub_command (cm, c, index);
221  }
222  clib_bitmap_free (match_bitmap);
223 
224  return is_unique;
225 }
226 
227 static int
228 vlib_cli_cmp_strings (void *a1, void *a2)
229 {
230  u8 *c1 = *(u8 **) a1;
231  u8 *c2 = *(u8 **) a2;
232 
233  return vec_cmp (c1, c2);
234 }
235 
236 u8 **
238 {
241  vlib_main_t *vm = vlib_get_main ();
242  vlib_cli_main_t *vcm = &vm->cli_main;
243  uword *match_bitmap = 0;
244  uword index, is_unique, help_next_level;
245  u8 **result = 0;
246  unformat_input_t input;
247  unformat_init_vector (&input, vec_dup (str));
248  c = vec_elt_at_index (vcm->commands, 0);
249 
250  /* remove trailing whitespace, except for one of them */
251  while (vec_len (input.buffer) >= 2 &&
252  isspace (input.buffer[vec_len (input.buffer) - 1]) &&
253  isspace (input.buffer[vec_len (input.buffer) - 2]))
254  {
255  vec_del1 (input.buffer, vec_len (input.buffer) - 1);
256  }
257 
258  /* if input is empty, directly return list of root commands */
259  if (vec_len (input.buffer) == 0 ||
260  (vec_len (input.buffer) == 1 && isspace (input.buffer[0])))
261  {
262  vec_foreach (sc, c->sub_commands)
263  {
264  vec_add1 (result, (u8 *) sc->name);
265  }
266  goto done;
267  }
268 
269  /* add a trailing '?' so that vlib_cli_sub_command_match can find
270  * all commands starting with the input string */
271  vec_add1 (input.buffer, '?');
272 
273  while (1)
274  {
275  match_bitmap = vlib_cli_sub_command_match (c, &input);
276  /* no match: return no result */
277  if (match_bitmap == 0)
278  {
279  goto done;
280  }
281  is_unique = clib_bitmap_count_set_bits (match_bitmap) == 1;
282  /* unique match: try to step one subcommand level further */
283  if (is_unique)
284  {
285  /* stop if no more input */
286  if (input.index >= vec_len (input.buffer) - 1)
287  {
288  break;
289  }
290 
291  index = clib_bitmap_first_set (match_bitmap);
292  c = get_sub_command (vcm, c, index);
293  clib_bitmap_free (match_bitmap);
294  continue;
295  }
296  /* multiple matches: stop here, return all matches */
297  break;
298  }
299 
300  /* remove trailing '?' */
301  vec_del1 (input.buffer, vec_len (input.buffer) - 1);
302 
303  /* if we have a space at the end of input, and a unique match,
304  * autocomplete the next level of subcommands */
305  help_next_level = (vec_len (str) == 0) || isspace (str[vec_len (str) - 1]);
306  /* *INDENT-OFF* */
307  clib_bitmap_foreach(index, match_bitmap, {
308  if (help_next_level && is_unique) {
309  c = get_sub_command (vcm, c, index);
310  vec_foreach (sc, c->sub_commands) {
311  vec_add1 (result, (u8*) sc->name);
312  }
313  goto done; /* break doesn't work in this macro-loop */
314  }
315  sc = &c->sub_commands[index];
316  vec_add1(result, (u8*) sc->name);
317  });
318  /* *INDENT-ON* */
319 
320 done:
321  clib_bitmap_free (match_bitmap);
322  unformat_free (&input);
323 
324  if (result)
326  return result;
327 }
328 
329 static u8 *
330 format_vlib_cli_command_help (u8 * s, va_list * args)
331 {
332  vlib_cli_command_t *c = va_arg (*args, vlib_cli_command_t *);
333  int is_long = va_arg (*args, int);
334  if (is_long && c->long_help)
335  s = format (s, "%s", c->long_help);
336  else if (c->short_help)
337  s = format (s, "%s", c->short_help);
338  else
339  s = format (s, "%v commands", c->path);
340  return s;
341 }
342 
343 static u8 *
344 format_vlib_cli_path (u8 * s, va_list * args)
345 {
346  u8 *path = va_arg (*args, u8 *);
347 
348  s = format (s, "%v", path);
349 
350  return s;
351 }
352 
353 static vlib_cli_command_t *
355 {
356  vlib_cli_command_t *c = vec_elt_at_index (cm->commands, command_index);
358 
359  if (c->function)
360  vec_add1 (subs, c[0]);
361 
362  vec_foreach (sc, c->sub_commands) subs = all_subs (cm, subs, sc->index);
363 
364  return subs;
365 }
366 
367 static int
368 vlib_cli_cmp_rule (void *a1, void *a2)
369 {
370  vlib_cli_sub_rule_t *r1 = a1;
371  vlib_cli_sub_rule_t *r2 = a2;
372 
373  return vec_cmp (r1->name, r2->name);
374 }
375 
376 static int
377 vlib_cli_cmp_command (void *a1, void *a2)
378 {
379  vlib_cli_command_t *c1 = a1;
380  vlib_cli_command_t *c2 = a2;
381 
382  return vec_cmp (c1->path, c2->path);
383 }
384 
385 static clib_error_t *
388  unformat_input_t * input,
389  uword parent_command_index)
390 {
391  vlib_cli_command_t *parent, *c;
392  clib_error_t *error = 0;
393  unformat_input_t sub_input;
394  u8 *string;
395  uword is_main_dispatch = cm == &vm->cli_main;
396 
397  parent = vec_elt_at_index (cm->commands, parent_command_index);
398  if (is_main_dispatch && unformat (input, "help"))
399  {
400  uword help_at_end_of_line, i;
401 
402  help_at_end_of_line =
404  while (1)
405  {
406  c = parent;
407  if (unformat_user
408  (input, unformat_vlib_cli_sub_command, vm, c, &parent))
409  ;
410 
411  else if (!(unformat_check_input (input) == UNFORMAT_END_OF_INPUT))
412  goto unknown;
413 
414  else
415  break;
416  }
417 
418  /* help SUB-COMMAND => long format help.
419  "help" at end of line: show all commands. */
420  if (!help_at_end_of_line)
422  /* is_long */ 1);
423 
424  else if (vec_len (c->sub_commands) == 0)
425  vlib_cli_output (vm, "%v: no sub-commands", c->path);
426 
427  else
428  {
429  vlib_cli_sub_rule_t *sr, *subs = 0;
431 
432  vec_foreach (sc, c->sub_commands)
433  {
434  vec_add2 (subs, sr, 1);
435  sr->name = sc->name;
436  sr->command_index = sc->index;
437  sr->rule_index = ~0;
438  }
439 
441 
442  for (i = 0; i < vec_len (subs); i++)
443  {
445 
446  d = vec_elt_at_index (cm->commands, subs[i].command_index);
448  (vm, " %-30v %U", subs[i].name,
449  format_vlib_cli_command_help, d, /* is_long */ 0);
450  }
451 
452  vec_free (subs);
453  }
454  }
455 
456  else if (is_main_dispatch
457  && (unformat (input, "choices") || unformat (input, "?")))
458  {
459  vlib_cli_command_t *sub, *subs;
460 
461  subs = all_subs (cm, 0, parent_command_index);
463  vec_foreach (sub, subs)
464  vlib_cli_output (vm, " %-40U %U",
466  format_vlib_cli_command_help, sub, /* is_long */ 0);
467  vec_free (subs);
468  }
469 
470  else if (unformat (input, "comment %v", &string))
471  {
472  vec_free (string);
473  }
474 
475  else if (unformat (input, "uncomment %U",
476  unformat_vlib_cli_sub_input, &sub_input))
477  {
478  error =
479  vlib_cli_dispatch_sub_commands (vm, cm, &sub_input,
480  parent_command_index);
481  unformat_free (&sub_input);
482  }
483  else if (unformat (input, "leak-check %U",
484  unformat_vlib_cli_sub_input, &sub_input))
485  {
486  u8 *leak_report;
488  {
489  void *oldheap;
491  clib_mem_trace (0);
492  clib_mem_set_heap (oldheap);
494  }
495  clib_mem_trace (1);
496  error =
497  vlib_cli_dispatch_sub_commands (vm, cm, &sub_input,
498  parent_command_index);
499  unformat_free (&sub_input);
500 
501  /* Otherwise, the clib_error_t shows up as a leak... */
502  if (error)
503  {
504  vlib_cli_output (vm, "%v", error->what);
505  clib_error_free (error);
506  error = 0;
507  }
508 
510  leak_report = format (0, "%U", format_mheap, clib_mem_get_heap (),
511  1 /* verbose, i.e. print leaks */ );
512  clib_mem_trace (0);
513  vlib_cli_output (vm, "%v", leak_report);
514  vec_free (leak_report);
515  }
516 
517  else
518  if (unformat_user (input, unformat_vlib_cli_sub_command, vm, parent, &c))
519  {
521  uword has_sub_commands =
522  vec_len (c->sub_commands) + vec_len (c->sub_rules) > 0;
523 
524  si = input;
525  if (unformat_user (input, unformat_vlib_cli_sub_input, &sub_input))
526  si = &sub_input;
527 
528  if (has_sub_commands)
529  error = vlib_cli_dispatch_sub_commands (vm, cm, si, c - cm->commands);
530 
531  if (has_sub_commands && !error)
532  /* Found valid sub-command. */ ;
533 
534  else if (c->function)
535  {
536  clib_error_t *c_error;
537 
538  /* Skip white space for benefit of called function. */
540 
541  if (unformat (si, "?"))
542  {
543  vlib_cli_output (vm, " %-40U %U", format_vlib_cli_path, c->path, format_vlib_cli_command_help, c, /* is_long */
544  0);
545  }
546  else
547  {
549  {
550  /* *INDENT-OFF* */
551  ELOG_TYPE_DECLARE (e) =
552  {
553  .format = "cli-cmd: %s",
554  .format_args = "T4",
555  };
556  /* *INDENT-ON* */
557  struct
558  {
559  u32 c;
560  } *ed;
561  ed = ELOG_DATA (&vm->elog_main, e);
562  ed->c = elog_string (&vm->elog_main, "%v", c->path);
563  }
564 
565  if (!c->is_mp_safe)
567  if (PREDICT_FALSE (vec_len (cm->perf_counter_cbs) != 0))
569  c - cm->commands, 0 /* before */ );
570 
571  c->hit_counter++;
572  c_error = c->function (vm, si, c);
573 
574  if (PREDICT_FALSE (vec_len (cm->perf_counter_cbs) != 0))
576  c - cm->commands, 1 /* after */ );
577  if (!c->is_mp_safe)
579 
581  {
582  /* *INDENT-OFF* */
583  ELOG_TYPE_DECLARE (e) =
584  {
585  .format = "cli-cmd: %s %s",
586  .format_args = "T4T4",
587  };
588  /* *INDENT-ON* */
589  struct
590  {
591  u32 c, err;
592  } *ed;
593  ed = ELOG_DATA (&vm->elog_main, e);
594  ed->c = elog_string (&vm->elog_main, "%v", c->path);
595  if (c_error)
596  {
597  vec_add1 (c_error->what, 0);
598  ed->err =
599  elog_string (&vm->elog_main, (char *) c_error->what);
600  _vec_len (c_error->what) -= 1;
601  }
602  else
603  ed->err = elog_string (&vm->elog_main, "OK");
604  }
605 
606  if (c_error)
607  {
608  error =
609  clib_error_return (0, "%v: %v", c->path, c_error->what);
610  clib_error_free (c_error);
611  /* Free sub input. */
612  if (si != input)
613  unformat_free (si);
614 
615  return error;
616  }
617  }
618 
619  /* Free any previous error. */
620  clib_error_free (error);
621  }
622 
623  else if (!error)
624  error = clib_error_return (0, "%v: no sub-commands", c->path);
625 
626  /* Free sub input. */
627  if (si != input)
628  unformat_free (si);
629  }
630 
631  else
632  goto unknown;
633 
634  return error;
635 
636 unknown:
637  if (parent->path)
638  return clib_error_return (0, "%v: unknown input `%U'", parent->path,
639  format_unformat_error, input);
640  else
641  return clib_error_return (0, "unknown input `%U'", format_unformat_error,
642  input);
643 }
644 
645 
647  __attribute__ ((weak));
648 
649 void
651 {
652 }
653 
654 /* Process CLI input. */
655 int
657  unformat_input_t * input,
658  vlib_cli_output_function_t * function, uword function_arg)
659 {
661  clib_error_t *error;
662  vlib_cli_output_function_t *save_function;
663  uword save_function_arg;
664  int rv = 0;
665 
666  save_function = cp->output_function;
667  save_function_arg = cp->output_function_arg;
668 
669  cp->output_function = function;
670  cp->output_function_arg = function_arg;
671 
672  do
673  {
674  error = vlib_cli_dispatch_sub_commands (vm, &vm->cli_main, input,
675  /* parent */ 0);
676  }
677  while (!error && !unformat (input, "%U", unformat_eof));
678 
679  if (error)
680  {
681  vlib_cli_output (vm, "%v", error->what);
682  vlib_unix_error_report (vm, error);
683  /* clib_error_return is unfortunately often called with a '0'
684  return code */
685  rv = error->code != 0 ? error->code : -1;
686  clib_error_free (error);
687  }
688 
689  cp->output_function = save_function;
690  cp->output_function_arg = save_function_arg;
691  return rv;
692 }
693 
694 /* Output to current CLI connection. */
695 void
696 vlib_cli_output (vlib_main_t * vm, char *fmt, ...)
697 {
699  va_list va;
700  u8 *s;
701 
702  va_start (va, fmt);
703  s = va_format (0, fmt, &va);
704  va_end (va);
705 
706  /* Terminate with \n if not present. */
707  if (vec_len (s) > 0 && s[vec_len (s) - 1] != '\n')
708  vec_add1 (s, '\n');
709 
710  if ((!cp) || (!cp->output_function))
711  fformat (stdout, "%v", s);
712  else
713  cp->output_function (cp->output_function_arg, s, vec_len (s));
714 
715  vec_free (s);
716 }
717 
718 void *vl_msg_push_heap (void) __attribute__ ((weak));
719 void *
721 {
722  return 0;
723 }
724 
725 void vl_msg_pop_heap (void *oldheap) __attribute__ ((weak));
726 void
727 vl_msg_pop_heap (void *oldheap)
728 {
729 }
730 
731 void *vlib_stats_push_heap (void *) __attribute__ ((weak));
732 void *
733 vlib_stats_push_heap (void *notused)
734 {
735  return 0;
736 }
737 
738 static clib_error_t *
740  unformat_input_t * input, vlib_cli_command_t * cmd)
741 {
742  int verbose __attribute__ ((unused)) = 0;
743  int api_segment = 0, stats_segment = 0, main_heap = 0, numa_heaps = 0;
744  clib_error_t *error;
745  u32 index = 0;
746  int i;
748  uword was_enabled;
749 
750 
752  {
753  if (unformat (input, "verbose"))
754  verbose = 1;
755  else if (unformat (input, "api-segment"))
756  api_segment = 1;
757  else if (unformat (input, "stats-segment"))
758  stats_segment = 1;
759  else if (unformat (input, "main-heap"))
760  main_heap = 1;
761  else if (unformat (input, "numa-heaps"))
762  numa_heaps = 1;
763  else
764  {
765  error = clib_error_return (0, "unknown input `%U'",
766  format_unformat_error, input);
767  return error;
768  }
769  }
770 
771  if ((api_segment + stats_segment + main_heap + numa_heaps) == 0)
772  return clib_error_return
773  (0, "Need one of api-segment, stats-segment, main-heap or numa-heaps");
774 
775  if (api_segment)
776  {
777  void *oldheap = vl_msg_push_heap ();
778  was_enabled = clib_mem_trace_enable_disable (0);
779  u8 *s_in_svm =
780  format (0, "%U\n", format_mheap, clib_mem_get_heap (), 1);
781  vl_msg_pop_heap (oldheap);
782  u8 *s = vec_dup (s_in_svm);
783 
784  oldheap = vl_msg_push_heap ();
785  vec_free (s_in_svm);
786  clib_mem_trace_enable_disable (was_enabled);
787  vl_msg_pop_heap (oldheap);
788  vlib_cli_output (vm, "API segment");
789  vlib_cli_output (vm, "%v", s);
790  vec_free (s);
791  }
792  if (stats_segment)
793  {
794  void *oldheap = vlib_stats_push_heap (0);
795  was_enabled = clib_mem_trace_enable_disable (0);
796  u8 *s_in_svm =
797  format (0, "%U\n", format_mheap, clib_mem_get_heap (), 1);
798  if (oldheap)
799  clib_mem_set_heap (oldheap);
800  u8 *s = vec_dup (s_in_svm);
801 
802  oldheap = vlib_stats_push_heap (0);
803  vec_free (s_in_svm);
804  if (oldheap)
805  {
806  clib_mem_trace_enable_disable (was_enabled);
807  clib_mem_set_heap (oldheap);
808  }
809  vlib_cli_output (vm, "Stats segment");
810  vlib_cli_output (vm, "%v", s);
811  vec_free (s);
812  }
813 
814 
815  {
816  if (main_heap)
817  {
818  /*
819  * Note: the foreach_vlib_main causes allocator traffic,
820  * so shut off tracing before we go there...
821  */
822  was_enabled = clib_mem_trace_enable_disable (0);
823 
824  /* *INDENT-OFF* */
826  ({
827  struct dlmallinfo mi;
828  void *mspace;
829  mspace = clib_per_cpu_mheaps[index];
830 
831  mi = mspace_mallinfo (mspace);
832  vlib_cli_output (vm, "%sThread %d %s\n", index ? "\n":"", index,
833  vlib_worker_threads[index].name);
834  vlib_cli_output (vm, " %U\n", format_page_map,
836  mi.arena);
837  vlib_cli_output (vm, " %U\n", format_mheap,
838  clib_per_cpu_mheaps[index],
839  verbose);
840  index++;
841  }));
842  /* *INDENT-ON* */
843 
844  /* Restore the trace flag */
845  clib_mem_trace_enable_disable (was_enabled);
846  }
847  if (numa_heaps)
848  {
849  struct dlmallinfo mi;
850  void *mspace;
851 
852  for (i = 0; i < ARRAY_LEN (clib_per_numa_mheaps); i++)
853  {
854  if (clib_per_numa_mheaps[i] == 0)
855  continue;
857  {
858  vlib_cli_output (vm, "Numa %d uses the main heap...", i);
859  continue;
860  }
861  was_enabled = clib_mem_trace_enable_disable (0);
862  mspace = clib_per_numa_mheaps[i];
863 
864  mi = mspace_mallinfo (mspace);
865  vlib_cli_output (vm, "Numa %d:", i);
866  vlib_cli_output (vm, " %U\n", format_page_map,
868  mi.arena);
869  vlib_cli_output (vm, " %U\n", format_mheap,
870  clib_per_numa_mheaps[index], verbose);
871  }
872  }
873  }
874  return 0;
875 }
876 
877 /* *INDENT-OFF* */
878 VLIB_CLI_COMMAND (show_memory_usage_command, static) = {
879  .path = "show memory",
880  .short_help = "show memory [api-segment][stats-segment][verbose]\n"
881  " [numa-heaps]",
882  .function = show_memory_usage,
883 };
884 /* *INDENT-ON* */
885 
886 static clib_error_t *
888  vlib_cli_command_t * cmd)
889 {
890 #define _(a,b,c) vlib_cli_output (vm, "%-25s " b, a ":", c);
891  _("Model name", "%U", format_cpu_model_name);
892  _("Microarch model (family)", "%U", format_cpu_uarch);
893  _("Flags", "%U", format_cpu_flags);
894  _("Base frequency", "%.2f GHz",
895  ((f64) vm->clib_time.clocks_per_second) * 1e-9);
896 #undef _
897  return 0;
898 }
899 
900 /*?
901  * Displays various information about the CPU.
902  *
903  * @cliexpar
904  * @cliexstart{show cpu}
905  * Model name: Intel(R) Xeon(R) CPU E5-2667 v4 @ 3.20GHz
906  * Microarchitecture: Broadwell (Broadwell-EP/EX)
907  * Flags: sse3 ssse3 sse41 sse42 avx avx2 aes
908  * Base Frequency: 3.20 GHz
909  * @cliexend
910 ?*/
911 /* *INDENT-OFF* */
912 VLIB_CLI_COMMAND (show_cpu_command, static) = {
913  .path = "show cpu",
914  .short_help = "Show cpu information",
915  .function = show_cpu,
916 };
917 /* *INDENT-ON* */
918 
919 static clib_error_t *
921  unformat_input_t * input,
922  vlib_cli_command_t * cmd)
923 {
924  unformat_input_t _line_input, *line_input = &_line_input;
925  int enable = 1;
926  int api_segment = 0;
927  int stats_segment = 0;
928  int main_heap = 0;
929  u32 numa_id = ~0;
930  void *oldheap;
931 
932  if (!unformat_user (input, unformat_line_input, line_input))
933  return 0;
934 
935  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
936  {
937  if (unformat (line_input, "%U", unformat_vlib_enable_disable, &enable))
938  ;
939  else if (unformat (line_input, "api-segment"))
940  api_segment = 1;
941  else if (unformat (line_input, "stats-segment"))
942  stats_segment = 1;
943  else if (unformat (line_input, "main-heap"))
944  main_heap = 1;
945  else if (unformat (line_input, "numa-heap %d", &numa_id))
946  ;
947  else
948  {
949  unformat_free (line_input);
950  return clib_error_return (0, "invalid input");
951  }
952  }
953  unformat_free (line_input);
954 
955  if ((api_segment + stats_segment + main_heap + (enable == 0)
956  + (numa_id != ~0)) == 0)
957  {
958  return clib_error_return
959  (0, "Need one of main-heap, stats-segment, api-segment,\n"
960  "numa-heap <nn> or disable");
961  }
962 
963  /* Turn off current trace, if any */
965  {
966  void *oldheap;
968  clib_mem_trace (0);
969  clib_mem_set_heap (oldheap);
971  }
972 
973  if (enable == 0)
974  return 0;
975 
976  /* API segment */
977  if (api_segment)
978  {
979  oldheap = vl_msg_push_heap ();
981  clib_mem_trace (1);
982  vl_msg_pop_heap (oldheap);
983 
984  }
985 
986  /* Stats segment */
987  if (stats_segment)
988  {
989  oldheap = vlib_stats_push_heap (0);
991  clib_mem_trace (stats_segment);
992  /* We don't want to call vlib_stats_pop_heap... */
993  if (oldheap)
994  clib_mem_set_heap (oldheap);
995  }
996 
997  /* main_heap */
998  if (main_heap)
999  {
1001  clib_mem_trace (main_heap);
1002  }
1003 
1004  if (numa_id != ~0)
1005  {
1006  if (numa_id >= ARRAY_LEN (clib_per_numa_mheaps))
1007  return clib_error_return (0, "Numa %d out of range", numa_id);
1008  if (clib_per_numa_mheaps[numa_id] == 0)
1009  return clib_error_return (0, "Numa %d heap not active", numa_id);
1010 
1011  if (clib_per_numa_mheaps[numa_id] == clib_mem_get_heap ())
1012  return clib_error_return (0, "Numa %d uses the main heap...",
1013  numa_id);
1016  clib_mem_trace (1);
1017  clib_mem_set_heap (oldheap);
1018  }
1019 
1020 
1021  return 0;
1022 }
1023 
1024 /* *INDENT-OFF* */
1025 VLIB_CLI_COMMAND (enable_disable_memory_trace_command, static) = {
1026  .path = "memory-trace",
1027  .short_help = "memory-trace on|off [api-segment][stats-segment][main-heap]\n"
1028  " [numa-heap <numa-id>]\n",
1029  .function = enable_disable_memory_trace,
1030 };
1031 /* *INDENT-ON* */
1032 
1033 static clib_error_t *
1035  vlib_cli_command_t * cmd)
1036 {
1038  clib_file_t *f;
1039 
1040  /* environ(7) does not indicate a header for this */
1041  extern char **environ;
1042 
1043  /* Close all known open files */
1044  /* *INDENT-OFF* */
1045  pool_foreach(f, fm->file_pool,
1046  ({
1047  if (f->file_descriptor > 2)
1048  close(f->file_descriptor);
1049  }));
1050  /* *INDENT-ON* */
1051 
1052  /* Exec ourself */
1053  execve (vm->name, (char **) vm->argv, environ);
1054 
1055  return 0;
1056 }
1057 
1058 /* *INDENT-OFF* */
1059 VLIB_CLI_COMMAND (restart_cmd,static) = {
1060  .path = "restart",
1061  .short_help = "restart process",
1062  .function = restart_cmd_fn,
1063 };
1064 /* *INDENT-ON* */
1065 
1066 #ifdef TEST_CODE
1067 /*
1068  * A trivial test harness to verify the per-process output_function
1069  * is working correcty.
1070  */
1071 
1072 static clib_error_t *
1073 sleep_ten_seconds (vlib_main_t * vm,
1074  unformat_input_t * input, vlib_cli_command_t * cmd)
1075 {
1076  u16 i;
1077  u16 my_id = rand ();
1078 
1079  vlib_cli_output (vm, "Starting 10 seconds sleep with id %u\n", my_id);
1080 
1081  for (i = 0; i < 10; i++)
1082  {
1084  vlib_cli_output (vm, "Iteration number %u, my id: %u\n", i, my_id);
1085  }
1086  vlib_cli_output (vm, "Done with sleep with id %u\n", my_id);
1087  return 0;
1088 }
1089 
1090 /* *INDENT-OFF* */
1091 VLIB_CLI_COMMAND (ping_command, static) = {
1092  .path = "test sleep",
1093  .function = sleep_ten_seconds,
1094  .short_help = "Sleep for 10 seconds",
1095 };
1096 /* *INDENT-ON* */
1097 #endif /* ifdef TEST_CODE */
1098 
1099 static uword
1100 vlib_cli_normalize_path (char *input, char **result)
1101 {
1102  char *i = input;
1103  char *s = 0;
1104  uword l = 0;
1105  uword index_of_last_space = ~0;
1106 
1107  while (*i != 0)
1108  {
1109  u8 c = *i++;
1110  /* Multiple white space -> single space. */
1111  switch (c)
1112  {
1113  case ' ':
1114  case '\t':
1115  case '\n':
1116  case '\r':
1117  if (l > 0 && s[l - 1] != ' ')
1118  {
1119  vec_add1 (s, ' ');
1120  l++;
1121  }
1122  break;
1123 
1124  default:
1125  if (l > 0 && s[l - 1] == ' ')
1126  index_of_last_space = vec_len (s);
1127  vec_add1 (s, c);
1128  l++;
1129  break;
1130  }
1131  }
1132 
1133  /* Remove any extra space at end. */
1134  if (l > 0 && s[l - 1] == ' ')
1135  _vec_len (s) -= 1;
1136 
1137  *result = s;
1138  return index_of_last_space;
1139 }
1140 
1143 {
1144  word i;
1145  for (i = vec_len (path) - 1; i >= 0; i--)
1146  {
1147  if (path[i] == ' ')
1148  return i;
1149  }
1150  return ~0;
1151 }
1152 
1153 static void
1154 add_sub_command (vlib_cli_main_t * cm, uword parent_index, uword child_index)
1155 {
1156  vlib_cli_command_t *p, *c;
1157  vlib_cli_sub_command_t *sub_c;
1158  u8 *sub_name;
1159  word i, l;
1160 
1161  p = vec_elt_at_index (cm->commands, parent_index);
1162  c = vec_elt_at_index (cm->commands, child_index);
1163 
1164  l = parent_path_len (c->path);
1165  if (l == ~0)
1166  sub_name = vec_dup ((u8 *) c->path);
1167  else
1168  {
1169  ASSERT (l + 1 < vec_len (c->path));
1170  sub_name = 0;
1171  vec_add (sub_name, c->path + l + 1, vec_len (c->path) - (l + 1));
1172  }
1173 
1174  if (sub_name[0] == '%')
1175  {
1176  uword *q;
1177  vlib_cli_sub_rule_t *sr;
1178 
1179  /* Remove %. */
1180  vec_delete (sub_name, 1, 0);
1181 
1182  if (!p->sub_rule_index_by_name)
1183  p->sub_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1184  sizeof (sub_name[0]),
1185  sizeof (uword));
1186  q = hash_get_mem (p->sub_rule_index_by_name, sub_name);
1187  if (q)
1188  {
1189  sr = vec_elt_at_index (p->sub_rules, q[0]);
1190  ASSERT (sr->command_index == child_index);
1191  return;
1192  }
1193 
1194  hash_set_mem (p->sub_rule_index_by_name, sub_name,
1195  vec_len (p->sub_rules));
1196  vec_add2 (p->sub_rules, sr, 1);
1197  sr->name = sub_name;
1198  sr->rule_index = sr - p->sub_rules;
1199  sr->command_index = child_index;
1200  return;
1201  }
1202 
1203  if (!p->sub_command_index_by_name)
1204  p->sub_command_index_by_name = hash_create_vec ( /* initial length */ 32,
1205  sizeof (c->path[0]),
1206  sizeof (uword));
1207 
1208  /* Check if sub-command has already been created. */
1209  if (hash_get_mem (p->sub_command_index_by_name, sub_name))
1210  {
1211  vec_free (sub_name);
1212  return;
1213  }
1214 
1215  vec_add2 (p->sub_commands, sub_c, 1);
1216  sub_c->index = child_index;
1217  sub_c->name = sub_name;
1219  sub_c - p->sub_commands);
1220 
1221  vec_validate (p->sub_command_positions, vec_len (sub_c->name) - 1);
1222  for (i = 0; i < vec_len (sub_c->name); i++)
1223  {
1224  int n;
1226 
1228 
1229  if (!pos->bitmaps)
1230  pos->min_char = sub_c->name[i];
1231 
1232  n = sub_c->name[i] - pos->min_char;
1233  if (n < 0)
1234  {
1235  pos->min_char = sub_c->name[i];
1236  vec_insert (pos->bitmaps, -n, 0);
1237  n = 0;
1238  }
1239 
1240  vec_validate (pos->bitmaps, n);
1241  pos->bitmaps[n] =
1242  clib_bitmap_ori (pos->bitmaps[n], sub_c - p->sub_commands);
1243  }
1244 }
1245 
1246 static void
1248 {
1249  uword p_len, pi, *p;
1250  char *p_path;
1251  vlib_cli_command_t *c, *parent;
1252 
1253  /* Root command (index 0) should have already been added. */
1254  ASSERT (vec_len (cm->commands) > 0);
1255 
1256  c = vec_elt_at_index (cm->commands, ci);
1257  p_len = parent_path_len (c->path);
1258 
1259  /* No space? Parent is root command. */
1260  if (p_len == ~0)
1261  {
1262  add_sub_command (cm, 0, ci);
1263  return;
1264  }
1265 
1266  p_path = 0;
1267  vec_add (p_path, c->path, p_len);
1268 
1269  p = hash_get_mem (cm->command_index_by_path, p_path);
1270 
1271  /* Parent exists? */
1272  if (!p)
1273  {
1274  /* Parent does not exist; create it. */
1275  vec_add2 (cm->commands, parent, 1);
1276  parent->path = p_path;
1277  hash_set_mem (cm->command_index_by_path, parent->path,
1278  parent - cm->commands);
1279  pi = parent - cm->commands;
1280  }
1281  else
1282  {
1283  pi = p[0];
1284  vec_free (p_path);
1285  }
1286 
1287  add_sub_command (cm, pi, ci);
1288 
1289  /* Create parent's parent. */
1290  if (!p)
1291  vlib_cli_make_parent (cm, pi);
1292 }
1293 
1296 {
1297  return (c->long_help == 0 && c->short_help == 0 && c->function == 0);
1298 }
1299 
1300 clib_error_t *
1302 {
1303  vlib_cli_main_t *cm = &vm->cli_main;
1304  clib_error_t *error = 0;
1305  uword ci, *p;
1306  char *normalized_path;
1307 
1308  if ((error = vlib_call_init_function (vm, vlib_cli_init)))
1309  return error;
1310 
1311  (void) vlib_cli_normalize_path (c->path, &normalized_path);
1312 
1313  if (!cm->command_index_by_path)
1314  cm->command_index_by_path = hash_create_vec ( /* initial length */ 32,
1315  sizeof (c->path[0]),
1316  sizeof (uword));
1317 
1318  /* See if command already exists with given path. */
1319  p = hash_get_mem (cm->command_index_by_path, normalized_path);
1320  if (p)
1321  {
1322  vlib_cli_command_t *d;
1323 
1324  ci = p[0];
1325  d = vec_elt_at_index (cm->commands, ci);
1326 
1327  /* If existing command was created via vlib_cli_make_parent
1328  replaced it with callers data. */
1329  if (vlib_cli_command_is_empty (d))
1330  {
1331  vlib_cli_command_t save = d[0];
1332 
1334 
1335  /* Copy callers fields. */
1336  d[0] = c[0];
1337 
1338  /* Save internal fields. */
1339  d->path = save.path;
1340  d->sub_commands = save.sub_commands;
1343  d->sub_rules = save.sub_rules;
1344  }
1345  else
1346  error =
1347  clib_error_return (0, "duplicate command name with path %v",
1348  normalized_path);
1349 
1350  vec_free (normalized_path);
1351  if (error)
1352  return error;
1353  }
1354  else
1355  {
1356  /* Command does not exist: create it. */
1357 
1358  /* Add root command (index 0). */
1359  if (vec_len (cm->commands) == 0)
1360  {
1361  /* Create command with index 0; path is empty string. */
1362  vec_resize (cm->commands, 1);
1363  }
1364 
1365  ci = vec_len (cm->commands);
1366  hash_set_mem (cm->command_index_by_path, normalized_path, ci);
1367  vec_add1 (cm->commands, c[0]);
1368 
1369  c = vec_elt_at_index (cm->commands, ci);
1370  c->path = normalized_path;
1371 
1372  /* Don't inherit from registration. */
1373  c->sub_commands = 0;
1375  c->sub_command_positions = 0;
1376  }
1377 
1378  vlib_cli_make_parent (cm, ci);
1379  return 0;
1380 }
1381 
1382 #if 0
1383 /* $$$ turn back on again someday, maybe */
1384 clib_error_t *
1386 {
1387  vlib_cli_main_t *cm = &vm->cli_main;
1389  clib_error_t *error = 0;
1390  u8 *r_name;
1391  uword *p;
1392 
1393  if (!cm->parse_rule_index_by_name)
1394  cm->parse_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1395  sizeof (r->name[0]),
1396  sizeof (uword));
1397 
1398  /* Make vector copy of name. */
1399  r_name = format (0, "%s", r_reg->name);
1400 
1401  if ((p = hash_get_mem (cm->parse_rule_index_by_name, r_name)))
1402  {
1403  vec_free (r_name);
1404  return clib_error_return (0, "duplicate parse rule name `%s'",
1405  r_reg->name);
1406  }
1407 
1408  vec_add2 (cm->parse_rules, r, 1);
1409  r[0] = r_reg[0];
1410  r->name = (char *) r_name;
1411  hash_set_mem (cm->parse_rule_index_by_name, r->name, r - cm->parse_rules);
1412 
1413  return error;
1414 }
1415 
1416 static clib_error_t *vlib_cli_register_parse_rules (vlib_main_t * vm,
1418  lo,
1420  hi)
1421  __attribute__ ((unused))
1422 {
1423  clib_error_t *error = 0;
1425 
1426  for (r = lo; r < hi; r = clib_elf_section_data_next (r, 0))
1427  {
1428  if (!r->name || strlen (r->name) == 0)
1429  {
1430  error = clib_error_return (0, "parse rule with no name");
1431  goto done;
1432  }
1433 
1434  error = vlib_cli_register_parse_rule (vm, r);
1435  if (error)
1436  goto done;
1437  }
1438 
1439 done:
1440  return error;
1441 }
1442 #endif
1443 
1444 static clib_error_t *
1446  unformat_input_t * input, vlib_cli_command_t * cmd)
1447 {
1448  unformat_input_t _line_input, *line_input = &_line_input;
1449  int enable = 1;
1450  int api = 0, cli = 0, barrier = 0, dispatch = 0, circuit = 0;
1451  u32 circuit_node_index;
1452 
1453  if (!unformat_user (input, unformat_line_input, line_input))
1454  goto print_status;
1455 
1456  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1457  {
1458  if (unformat (line_input, "api"))
1459  api = 1;
1460  else if (unformat (line_input, "dispatch"))
1461  dispatch = 1;
1462  else if (unformat (line_input, "circuit-node %U",
1463  unformat_vlib_node, vm, &circuit_node_index))
1464  circuit = 1;
1465  else if (unformat (line_input, "cli"))
1466  cli = 1;
1467  else if (unformat (line_input, "barrier"))
1468  barrier = 1;
1469  else if (unformat (line_input, "disable"))
1470  enable = 0;
1471  else if (unformat (line_input, "enable"))
1472  enable = 1;
1473  else
1474  break;
1475  }
1476  unformat_free (line_input);
1477 
1479  (api ? enable : vl_api_get_elog_trace_api_messages ());
1480  vm->elog_trace_cli_commands = cli ? enable : vm->elog_trace_cli_commands;
1481  vm->elog_trace_graph_dispatch = dispatch ?
1482  enable : vm->elog_trace_graph_dispatch;
1483  vm->elog_trace_graph_circuit = circuit ?
1484  enable : vm->elog_trace_graph_circuit;
1486  barrier ? enable : vlib_worker_threads->barrier_elog_enabled;
1487  vm->elog_trace_graph_circuit_node_index = circuit_node_index;
1488 
1489  /*
1490  * Set up start-of-buffer logic-analyzer trigger
1491  * for main loop event logs, which are fairly heavyweight.
1492  * See src/vlib/main/vlib_elog_main_loop_event(...), which
1493  * will fully disable the scheme when the elog buffer fills.
1494  */
1495  if (dispatch || circuit)
1496  {
1497  elog_main_t *em = &vm->elog_main;
1498 
1500  em->n_total_events + vec_len (em->event_ring);
1501  }
1502 
1503 
1504 print_status:
1505  vlib_cli_output (vm, "Current status:");
1506 
1508  (vm, " Event log API message trace: %s\n CLI command trace: %s",
1509  vl_api_get_elog_trace_api_messages ()? "on" : "off",
1510  vm->elog_trace_cli_commands ? "on" : "off");
1512  (vm, " Barrier sync trace: %s",
1513  vlib_worker_threads->barrier_elog_enabled ? "on" : "off");
1515  (vm, " Graph Dispatch: %s",
1516  vm->elog_trace_graph_dispatch ? "on" : "off");
1518  (vm, " Graph Circuit: %s",
1519  vm->elog_trace_graph_circuit ? "on" : "off");
1520  if (vm->elog_trace_graph_circuit)
1522  (vm, " node %U",
1524 
1525  return 0;
1526 }
1527 
1528 /*?
1529  * Control event logging of api, cli, and thread barrier events
1530  * With no arguments, displays the current trace status.
1531  * Name the event groups you wish to trace or stop tracing.
1532  *
1533  * @cliexpar
1534  * @clistart
1535  * elog trace api cli barrier
1536  * elog trace api cli barrier disable
1537  * elog trace dispatch
1538  * elog trace circuit-node ethernet-input
1539  * elog trace
1540  * @cliend
1541  * @cliexcmd{elog trace [api][cli][barrier][disable]}
1542 ?*/
1543 /* *INDENT-OFF* */
1544 VLIB_CLI_COMMAND (elog_trace_command, static) =
1545 {
1546  .path = "elog trace",
1547  .short_help = "elog trace [api][cli][barrier][dispatch]\n"
1548  "[circuit-node <name> e.g. ethernet-input][disable]",
1549  .function = elog_trace_command_fn,
1550 };
1551 /* *INDENT-ON* */
1552 
1553 static clib_error_t *
1555  unformat_input_t * input, vlib_cli_command_t * cmd)
1556 {
1557  vlib_process_suspend (vm, 30e-3);
1558  return 0;
1559 }
1560 
1561 /* *INDENT-OFF* */
1562 VLIB_CLI_COMMAND (suspend_command, static) =
1563 {
1564  .path = "suspend",
1565  .short_help = "suspend debug CLI for 30ms",
1566  .function = suspend_command_fn,
1567  .is_mp_safe = 1,
1568 };
1569 /* *INDENT-ON* */
1570 
1571 
1572 static int
1573 sort_cmds_by_path (void *a1, void *a2)
1574 {
1575  u32 *index1 = a1;
1576  u32 *index2 = a2;
1577  vlib_main_t *vm = vlib_get_main ();
1578  vlib_cli_main_t *cm = &vm->cli_main;
1579  vlib_cli_command_t *c1, *c2;
1580  int i, lmin;
1581 
1582  c1 = vec_elt_at_index (cm->commands, *index1);
1583  c2 = vec_elt_at_index (cm->commands, *index2);
1584 
1585  lmin = vec_len (c1->path);
1586  lmin = (vec_len (c2->path) >= lmin) ? lmin : vec_len (c2->path);
1587 
1588  for (i = 0; i < lmin; i++)
1589  {
1590  if (c1->path[i] < c2->path[i])
1591  return -1;
1592  else if (c1->path[i] > c2->path[i])
1593  return 1;
1594  }
1595 
1596  return 0;
1597 }
1598 
1599 typedef struct
1600 {
1608 
1609 static void
1611 {
1612  vlib_cli_command_t *parent;
1614  vlib_cli_walk_args_t _a, *a = &_a;
1616  int i;
1617 
1618  /* Copy args into this stack frame */
1619  *a = *aa;
1620  cm = a->cm;
1621 
1622  parent = vec_elt_at_index (cm->commands, a->parent_command_index);
1623 
1624  if (parent->function)
1625  {
1626  if (((a->show_mp_safe && parent->is_mp_safe)
1627  || (a->show_not_mp_safe && !parent->is_mp_safe))
1628  && (a->show_hit == 0 || parent->hit_counter))
1629  {
1631  }
1632 
1633  if (a->clear_hit)
1634  parent->hit_counter = 0;
1635  }
1636 
1637  for (i = 0; i < vec_len (parent->sub_commands); i++)
1638  {
1639  sub = vec_elt_at_index (parent->sub_commands, i);
1640  a->parent_command_index = sub->index;
1641  cli_recursive_walk (a);
1642  }
1643 }
1644 
1645 static u8 *
1646 format_mp_safe (u8 * s, va_list * args)
1647 {
1648  vlib_cli_main_t *cm = va_arg (*args, vlib_cli_main_t *);
1649  int show_mp_safe = va_arg (*args, int);
1650  int show_not_mp_safe = va_arg (*args, int);
1651  int show_hit = va_arg (*args, int);
1652  int clear_hit = va_arg (*args, int);
1654  vlib_cli_walk_args_t _a, *a = &_a;
1655  int i;
1656  char *format_string = "\n%v";
1657 
1658  if (show_hit)
1659  format_string = "\n%v: %u";
1660 
1662 
1663  a->cm = cm;
1664  a->parent_command_index = 0;
1665  a->show_mp_safe = show_mp_safe;
1666  a->show_not_mp_safe = show_not_mp_safe;
1667  a->show_hit = show_hit;
1668  a->clear_hit = clear_hit;
1669 
1670  cli_recursive_walk (a);
1671 
1673 
1674  for (i = 0; i < vec_len (cm->sort_vector); i++)
1675  {
1676  c = vec_elt_at_index (cm->commands, cm->sort_vector[i]);
1677  s = format (s, format_string, c->path, c->hit_counter);
1678  }
1679 
1680  return s;
1681 }
1682 
1683 
1684 static clib_error_t *
1686  unformat_input_t * input, vlib_cli_command_t * cmd)
1687 {
1688  int show_mp_safe = 0;
1689  int show_not_mp_safe = 0;
1690  int show_hit = 0;
1691  int clear_hit = 0;
1692 
1693  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1694  {
1695  if (unformat (input, "mp-safe"))
1696  show_mp_safe = 1;
1697  if (unformat (input, "not-mp-safe"))
1698  show_not_mp_safe = 1;
1699  else if (unformat (input, "hit"))
1700  show_hit = 1;
1701  else if (unformat (input, "clear-hit"))
1702  clear_hit = 1;
1703  else
1704  break;
1705  }
1706 
1707  /* default set: all cli commands */
1708  if (clear_hit == 0 && (show_mp_safe + show_not_mp_safe) == 0)
1709  show_mp_safe = show_not_mp_safe = 1;
1710 
1711  vlib_cli_output (vm, "%U", format_mp_safe, &vm->cli_main,
1712  show_mp_safe, show_not_mp_safe, show_hit, clear_hit);
1713  if (clear_hit)
1714  vlib_cli_output (vm, "hit counters cleared...");
1715 
1716  return 0;
1717 }
1718 
1719 /*?
1720  * Displays debug cli command information
1721  *
1722  * @cliexpar
1723  * @cliexstart{show cli [mp-safe][not-mp-safe][hit][clear-hit]}
1724  *
1725  * "show cli" displays the entire debug cli:
1726  *
1727  * abf attach
1728  * abf policy
1729  * adjacency counters
1730  * api trace
1731  * app ns
1732  * bfd key del
1733  * ... and so on ...
1734  *
1735  * "show cli mp-safe" displays mp-safe debug CLI commands:
1736  *
1737  * abf policy
1738  * binary-api
1739  * create vhost-user
1740  * exec
1741  * ip container
1742  * ip mroute
1743  * ip probe-neighbor
1744  * ip route
1745  * ip scan-neighbor
1746  * ip table
1747  * ip6 table
1748  *
1749  * "show cli not-mp-safe" displays debug CLI commands
1750  * which cause worker thread barrier synchronization
1751  *
1752  * "show cli hit" displays commands which have been executed. Qualify
1753  * as desired with "mp-safe" or "not-mp-safe".
1754  *
1755  * "show cli clear-hit" clears the per-command hit counters.
1756  * @cliexend
1757 ?*/
1758 
1759 /* *INDENT-OFF* */
1760 VLIB_CLI_COMMAND (show_cli_command, static) =
1761 {
1762  .path = "show cli",
1763  .short_help = "show cli [mp-safe][not-mp-safe][hit][clear-hit]",
1764  .function = show_cli_command_fn,
1765  .is_mp_safe = 1,
1766 };
1767 /* *INDENT-ON* */
1768 
1769 static clib_error_t *
1771 {
1772  vlib_cli_main_t *cm = &vm->cli_main;
1773  clib_error_t *error = 0;
1774  vlib_cli_command_t *cmd;
1775 
1776  cmd = cm->cli_command_registrations;
1777 
1778  while (cmd)
1779  {
1780  error = vlib_cli_register (vm, cmd);
1781  if (error)
1782  return error;
1783  cmd = cmd->next_cli_command;
1784  }
1785  return error;
1786 }
1787 
1789 
1790 /*
1791  * fd.io coding-style-patch-verification: ON
1792  *
1793  * Local Variables:
1794  * eval: (c-set-style "gnu")
1795  * End:
1796  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:509
uword output_function_arg
Definition: node.h:608
void * clib_per_cpu_mheaps[CLIB_MAX_MHEAPS]
Definition: mem_dlmalloc.c:24
void * mspace
Definition: dlmalloc.h:1306
static f64 vlib_process_wait_for_event_or_clock(vlib_main_t *vm, f64 dt)
Suspend a cooperative multi-tasking thread Waits for an event, or for the indicated number of seconds...
Definition: node_funcs.h:751
format_function_t format_vlib_node_name
Definition: node_funcs.h:1222
a
Definition: bitmap.h:538
unformat_function_t unformat_eof
Definition: format.h:293
static uword unformat_get_input(unformat_input_t *input)
Definition: format.h:192
int elog_trace_cli_commands
Definition: main.h:228
u32 parent_command_index
Definition: cli.c:1602
vlib_cli_command_t * commands
Definition: cli.h:138
int vl_api_get_elog_trace_api_messages(void)
Definition: api_shared.c:1234
f64 clocks_per_second
Definition: time.h:54
static clib_error_t * show_cli_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:1685
format_function_t format_cpu_flags
Definition: cpu.h:425
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:592
static int vlib_cli_cmp_strings(void *a1, void *a2)
Definition: cli.c:228
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:630
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:989
uword * sub_rule_index_by_name
Definition: cli.h:121
#define hash_set_mem(h, key, value)
Definition: hash.h:275
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
u8 * va_format(u8 *s, const char *fmt, va_list *va)
Definition: format.c:387
clib_time_t clib_time
Definition: main.h:124
vl_api_fib_path_t path
Definition: mfib_types.api:34
DLMALLOC_EXPORT struct dlmallinfo mspace_mallinfo(mspace msp)
int vlib_cli_input(vlib_main_t *vm, unformat_input_t *input, vlib_cli_output_function_t *function, uword function_arg)
Definition: cli.c:656
void * vlib_stats_push_heap(void *)
Definition: cli.c:733
vlib_cli_main_t cli_main
Definition: main.h:192
static clib_error_t * enable_disable_memory_trace(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:920
unsigned char u8
Definition: types.h:56
#define clib_bitmap_dup(v)
Duplicate a bitmap.
Definition: bitmap.h:87
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
double f64
Definition: types.h:142
#define vlib_worker_thread_barrier_sync(X)
Definition: threads.h:205
clib_error_t * vlib_cli_register_parse_rule(struct vlib_main_t *vm, vlib_cli_parse_rule_t *c)
#define fm
#define vec_add(V, E, N)
Add N elements to end of vector V (no header, unspecified alignment)
Definition: vec.h:668
clib_file_t * file_pool
Definition: file.h:88
static uword vlib_process_suspend(vlib_main_t *vm, f64 dt)
Suspend a vlib cooperative multi-tasking thread for a period of time.
Definition: node_funcs.h:482
i64 word
Definition: types.h:111
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:513
static u8 * format_mp_safe(u8 *s, va_list *args)
Definition: cli.c:1646
MALLINFO_FIELD_TYPE arena
Definition: dlmalloc.h:800
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
Callback multiplex scheme For a fully worked-out example, see .../src/vlib/main.
void vlib_unix_error_report(vlib_main_t *, clib_error_t *)
Definition: cli.c:650
static clib_error_t * vlib_cli_dispatch_sub_commands(vlib_main_t *vm, vlib_cli_main_t *cm, unformat_input_t *input, uword parent_command_index)
Definition: cli.c:386
static uword clib_bitmap_is_zero(uword *ai)
predicate function; is an entire bitmap empty?
Definition: bitmap.h:57
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
u8 * format_page_map(u8 *s, va_list *args)
Definition: unix-formats.c:969
#define clib_error_return(e, args...)
Definition: error.h:99
uword * command_index_by_path
Definition: cli.h:141
clib_file_main_t file_main
Definition: main.c:63
static int vlib_cli_cmp_rule(void *a1, void *a2)
Definition: cli.c:368
static void * current_traced_heap
Definition: cli.c:54
u32 command_index
Definition: cli.h:68
#define vec_resize(V, N)
Resize a vector (no header, unspecified alignment) Add N elements to end of given vector V...
Definition: vec.h:281
void * clib_per_numa_mheaps[CLIB_MAX_NUMAS]
Definition: mem_dlmalloc.c:25
static uword vlib_cli_normalize_path(char *input, char **result)
Definition: cli.c:1100
unsigned int u32
Definition: types.h:88
static u8 * format_vlib_cli_path(u8 *s, va_list *args)
Definition: cli.c:344
#define vlib_call_init_function(vm, x)
Definition: init.h:270
uword clib_mem_trace_enable_disable(uword enable)
Definition: mem_dlmalloc.c:491
static clib_error_t * show_memory_usage(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:739
static clib_error_t * show_cpu(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:887
unformat_function_t unformat_line_input
Definition: format.h:283
u8 * format_mheap(u8 *s, va_list *va)
Definition: mem_dlmalloc.c:404
char * name
Definition: main.h:171
vnet_crypto_main_t * cm
Definition: quic_crypto.c:53
vlib_worker_thread_t * vlib_worker_threads
Definition: threads.c:34
#define clib_bitmap_foreach(i, ai, body)
Macro to iterate across set bits in a bitmap.
Definition: bitmap.h:361
static void add_sub_command(vlib_cli_main_t *cm, uword parent_index, uword child_index)
Definition: cli.c:1154
#define vec_insert(V, N, M)
Insert N vector elements starting at element M, initialize new elements to zero (no header...
Definition: vec.h:755
void vl_msg_pop_heap(void *oldheap)
Definition: cli.c:727
vlib_cli_command_function_t * function
Definition: cli.h:102
static uword clib_bitmap_first_set(uword *ai)
Return the lowest numbered set bit in a bitmap.
Definition: bitmap.h:385
static vlib_cli_command_t * get_sub_command(vlib_cli_main_t *cm, vlib_cli_command_t *parent, u32 si)
Definition: cli.c:199
vlib_cli_sub_rule_t * sub_rules
Definition: cli.h:124
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
static int vlib_cli_cmp_command(void *a1, void *a2)
Definition: cli.c:377
#define vec_dup(V)
Return copy of vector (no header, no alignment)
Definition: vec.h:429
#define ELOG_DATA(em, f)
Definition: elog.h:484
elog_event_t * event_ring
Vector of events (circular buffer).
Definition: elog.h:149
#define PREDICT_FALSE(x)
Definition: clib.h:120
#define always_inline
Definition: ipsec.h:28
#define vec_del1(v, i)
Delete the element at index I.
Definition: vec.h:875
static void unformat_put_input(unformat_input_t *input)
Definition: format.h:205
static void vlib_cli_make_parent(vlib_cli_main_t *cm, uword ci)
Definition: cli.c:1247
#define foreach_vlib_main(body)
Definition: threads.h:242
void * vl_msg_push_heap(void)
Definition: cli.c:720
clib_error_t * vlib_cli_register(vlib_main_t *vm, vlib_cli_command_t *c)
Definition: cli.c:1301
word fformat(FILE *f, char *fmt,...)
Definition: format.c:462
void unformat_init_vector(unformat_input_t *input, u8 *vector_string)
Definition: unformat.c:1037
static uword * vlib_cli_sub_command_match(vlib_cli_command_t *c, unformat_input_t *input)
Definition: cli.c:90
The fine-grained event logger allows lightweight, thread-safe event logging at minimum cost...
vlib_cli_sub_command_t * sub_commands
Definition: cli.h:111
u8 ** argv
Definition: main.h:265
#define UNFORMAT_END_OF_INPUT
Definition: format.h:145
svmdb_client_t * c
static vlib_process_t * vlib_get_current_process(vlib_main_t *vm)
Definition: node_funcs.h:444
int elog_trace_graph_dispatch
Definition: main.h:229
int show_not_mp_safe
Definition: cli.c:1604
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:317
int vl_api_set_elog_trace_api_messages(int enable)
Definition: api_shared.c:1223
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:380
static void * clib_mem_set_heap(void *heap)
Definition: mem.h:268
void(** perf_counter_cbs)(struct vlib_cli_main_t *, u32 id, int before_or_after)
Definition: cli.h:152
static uword * clib_bitmap_andnot(uword *ai, uword *bi)
Logical operator across two bitmaps.
elog_main_t elog_main
Definition: main.h:224
static uword parent_path_len(char *path)
Definition: cli.c:1142
static clib_error_t * vlib_cli_init(vlib_main_t *vm)
Definition: cli.c:1770
#define ARRAY_LEN(x)
Definition: clib.h:67
uword ** bitmaps
Definition: cli.h:52
#define ELOG_TYPE_DECLARE(f)
Definition: elog.h:442
u32 n_total_events_disable_limit
When count reaches limit logging is disabled.
Definition: elog.h:139
string name[64]
Definition: ip.api:44
static void * clib_mem_get_heap(void)
Definition: mem.h:262
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:158
uword unformat_vlib_cli_sub_input(unformat_input_t *i, va_list *args)
Definition: cli.c:163
#define clib_elf_section_data_next(a, extra)
Definition: elf_clib.h:57
static clib_error_t * suspend_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:1554
#define ASSERT(truth)
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:696
#define vec_delete(V, N, M)
Delete N elements starting at element M.
Definition: vec.h:854
u32 hit_counter
Definition: cli.h:130
char * long_help
Definition: cli.h:99
uword is_mp_safe
Definition: cli.h:108
char * path
Definition: cli.h:95
#define clib_bitmap_free(v)
Free a bitmap.
Definition: bitmap.h:92
static int sort_cmds_by_path(void *a1, void *a2)
Definition: cli.c:1573
uword * sub_command_index_by_name
Definition: cli.h:114
u32 elog_trace_graph_circuit_node_index
Definition: main.h:231
#define vec_cmp(v1, v2)
Compare two vectors (only applicable to vectors of signed numbers).
Definition: vec.h:991
static uword pointer_to_uword(const void *p)
Definition: types.h:131
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
vl_api_ip4_address_t hi
Definition: arp.api:37
static vlib_cli_command_t * all_subs(vlib_cli_main_t *cm, vlib_cli_command_t *subs, u32 command_index)
Definition: cli.c:354
static uword clib_bitmap_count_set_bits(uword *ai)
Return the number of set bits in a bitmap.
Definition: bitmap.h:462
struct vlib_cli_command_t * next_cli_command
Definition: cli.h:127
#define hash_create_vec(elts, key_bytes, value_bytes)
Definition: hash.h:668
static uword unformat_vlib_cli_sub_command(unformat_input_t *i, va_list *args)
Definition: cli.c:206
u32 elog_string(elog_main_t *em, char *fmt,...)
add a string to the event-log string table
Definition: elog.c:571
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
uword unformat_vlib_enable_disable(unformat_input_t *input, va_list *args)
Definition: format.c:116
static u8 * format_vlib_cli_command_help(u8 *s, va_list *args)
Definition: cli.c:330
static void cli_recursive_walk(vlib_cli_walk_args_t *aa)
Definition: cli.c:1610
static uword vlib_cli_command_is_empty(vlib_cli_command_t *c)
Definition: cli.c:1295
u64 uword
Definition: types.h:112
#define vec_sort_with_function(vec, f)
Sort a vector using the supplied element comparison function.
Definition: vec.h:1055
static void unformat_free(unformat_input_t *i)
Definition: format.h:163
u32 index
Definition: flow_types.api:221
format_function_t format_cpu_uarch
Definition: cpu.h:423
#define clib_error_free(e)
Definition: error.h:86
unformat_function_t unformat_vlib_node
Definition: node_funcs.h:1228
#define hash_get_mem(h, key)
Definition: hash.h:269
static clib_error_t * elog_trace_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:1445
vlib_cli_command_t * cli_command_registrations
Definition: cli.h:144
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
void vlib_worker_thread_barrier_release(vlib_main_t *vm)
Definition: threads.c:1554
#define clib_call_callbacks(h,...)
call the specified callback set
Definition: callback.h:67
#define vec_foreach(var, vec)
Vector iterator.
Definition: file.h:51
vlib_cli_parse_position_t * sub_command_positions
Definition: cli.h:118
u32 n_total_events
Total number of events in buffer.
Definition: elog.h:135
u8 si
Definition: lisp_types.api:47
void() vlib_cli_output_function_t(uword arg, u8 *buffer, uword buffer_bytes)
Definition: cli.h:133
vlib_cli_output_function_t * output_function
Definition: node.h:607
u32 * sort_vector
Definition: cli.h:147
void clib_mem_trace(int enable)
Definition: mem_dlmalloc.c:470
import vnet interface_types api
Definition: sample.api:20
char * short_help
Definition: cli.h:98
static clib_error_t * restart_cmd_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:1034
uword unformat_skip_white_space(unformat_input_t *input)
Definition: unformat.c:821
format_function_t format_cpu_model_name
Definition: cpu.h:424
DLMALLOC_EXPORT void * mspace_least_addr(mspace msp)
int elog_trace_graph_circuit
Definition: main.h:230
static uword * clib_bitmap_and(uword *ai, uword *bi)
Logical operator across two bitmaps.
vlib_cli_main_t * cm
Definition: cli.c:1601
u8 ** vlib_cli_get_possible_completions(u8 *str)
Definition: cli.c:237
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
u32 rule_index
Definition: cli.h:66
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:171