ef02d27d2887d6c5d53ba8390a27ed5ec4b95388
[vpp.git] / src / vlib / cli.c
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/cpu.h>
43 #include <unistd.h>
44 #include <ctype.h>
45
46 /* Root of all show commands. */
47 /* *INDENT-OFF* */
48 VLIB_CLI_COMMAND (vlib_cli_show_command, static) = {
49   .path = "show",
50   .short_help = "Show commands",
51 };
52 /* *INDENT-ON* */
53
54 /* Root of all clear commands. */
55 /* *INDENT-OFF* */
56 VLIB_CLI_COMMAND (vlib_cli_clear_command, static) = {
57   .path = "clear",
58   .short_help = "Clear commands",
59 };
60 /* *INDENT-ON* */
61
62 /* Root of all set commands. */
63 /* *INDENT-OFF* */
64 VLIB_CLI_COMMAND (vlib_cli_set_command, static) = {
65   .path = "set",
66   .short_help = "Set commands",
67 };
68 /* *INDENT-ON* */
69
70 /* Root of all test commands. */
71 /* *INDENT-OFF* */
72 VLIB_CLI_COMMAND (vlib_cli_test_command, static) = {
73   .path = "test",
74   .short_help = "Test commands",
75 };
76 /* *INDENT-ON* */
77
78 /* Returns bitmap of commands which match key. */
79 static uword *
80 vlib_cli_sub_command_match (vlib_cli_command_t * c, unformat_input_t * input)
81 {
82   int i, n;
83   uword *match = 0;
84   vlib_cli_parse_position_t *p;
85
86   unformat_skip_white_space (input);
87
88   for (i = 0;; i++)
89     {
90       uword k;
91
92       k = unformat_get_input (input);
93       switch (k)
94         {
95         case 'a' ... 'z':
96         case 'A' ... 'Z':
97         case '0' ... '9':
98         case '-':
99         case '_':
100           break;
101
102         case ' ':
103         case '\t':
104         case '\r':
105         case '\n':
106         case UNFORMAT_END_OF_INPUT:
107           /* White space or end of input removes any non-white
108              matches that were before possible. */
109           if (i < vec_len (c->sub_command_positions)
110               && clib_bitmap_count_set_bits (match) > 1)
111             {
112               p = vec_elt_at_index (c->sub_command_positions, i);
113               for (n = 0; n < vec_len (p->bitmaps); n++)
114                 match = clib_bitmap_andnot (match, p->bitmaps[n]);
115             }
116           goto done;
117
118         default:
119           unformat_put_input (input);
120           goto done;
121         }
122
123       if (i >= vec_len (c->sub_command_positions))
124         {
125         no_match:
126           clib_bitmap_free (match);
127           return 0;
128         }
129
130       p = vec_elt_at_index (c->sub_command_positions, i);
131       if (vec_len (p->bitmaps) == 0)
132         goto no_match;
133
134       n = k - p->min_char;
135       if (n < 0 || n >= vec_len (p->bitmaps))
136         goto no_match;
137
138       if (i == 0)
139         match = clib_bitmap_dup (p->bitmaps[n]);
140       else
141         match = clib_bitmap_and (match, p->bitmaps[n]);
142
143       if (clib_bitmap_is_zero (match))
144         goto no_match;
145     }
146
147 done:
148   return match;
149 }
150
151 /* Looks for string based sub-input formatted { SUB-INPUT }. */
152 uword
153 unformat_vlib_cli_sub_input (unformat_input_t * i, va_list * args)
154 {
155   unformat_input_t *sub_input = va_arg (*args, unformat_input_t *);
156   u8 *s;
157   uword c;
158
159   while (1)
160     {
161       c = unformat_get_input (i);
162       switch (c)
163         {
164         case ' ':
165         case '\t':
166         case '\n':
167         case '\r':
168         case '\f':
169           break;
170
171         case '{':
172         default:
173           /* Put back paren. */
174           if (c != UNFORMAT_END_OF_INPUT)
175             unformat_put_input (i);
176
177           if (c == '{' && unformat (i, "%v", &s))
178             {
179               unformat_init_vector (sub_input, s);
180               return 1;
181             }
182           return 0;
183         }
184     }
185   return 0;
186 }
187
188 static vlib_cli_command_t *
189 get_sub_command (vlib_cli_main_t * cm, vlib_cli_command_t * parent, u32 si)
190 {
191   vlib_cli_sub_command_t *s = vec_elt_at_index (parent->sub_commands, si);
192   return vec_elt_at_index (cm->commands, s->index);
193 }
194
195 static uword
196 unformat_vlib_cli_sub_command (unformat_input_t * i, va_list * args)
197 {
198   vlib_main_t *vm = va_arg (*args, vlib_main_t *);
199   vlib_cli_command_t *c = va_arg (*args, vlib_cli_command_t *);
200   vlib_cli_command_t **result = va_arg (*args, vlib_cli_command_t **);
201   vlib_cli_main_t *cm = &vm->cli_main;
202   uword *match_bitmap, is_unique, index;
203
204   {
205     vlib_cli_sub_rule_t *sr;
206     vlib_cli_parse_rule_t *r;
207     vec_foreach (sr, c->sub_rules)
208     {
209       void **d;
210       r = vec_elt_at_index (cm->parse_rules, sr->rule_index);
211       vec_add2 (cm->parse_rule_data, d, 1);
212       vec_reset_length (d[0]);
213       if (r->data_size)
214         d[0] = _vec_resize (d[0],
215                             /* length increment */ 1,
216                             r->data_size,
217                             /* header_bytes */ 0,
218                             /* data align */ sizeof (uword));
219       if (unformat_user (i, r->unformat_function, vm, d[0]))
220         {
221           *result = vec_elt_at_index (cm->commands, sr->command_index);
222           return 1;
223         }
224     }
225   }
226
227   match_bitmap = vlib_cli_sub_command_match (c, i);
228   is_unique = clib_bitmap_count_set_bits (match_bitmap) == 1;
229   index = ~0;
230   if (is_unique)
231     {
232       index = clib_bitmap_first_set (match_bitmap);
233       *result = get_sub_command (cm, c, index);
234     }
235   clib_bitmap_free (match_bitmap);
236
237   return is_unique;
238 }
239
240 static int
241 vlib_cli_cmp_strings (void *a1, void *a2)
242 {
243   u8 *c1 = *(u8 **) a1;
244   u8 *c2 = *(u8 **) a2;
245
246   return vec_cmp (c1, c2);
247 }
248
249 u8 **
250 vlib_cli_get_possible_completions (u8 * str)
251 {
252   vlib_cli_command_t *c;
253   vlib_cli_sub_command_t *sc;
254   vlib_main_t *vm = vlib_get_main ();
255   vlib_cli_main_t *vcm = &vm->cli_main;
256   uword *match_bitmap = 0;
257   uword index, is_unique, help_next_level;
258   u8 **result = 0;
259   unformat_input_t input;
260   unformat_init_vector (&input, vec_dup (str));
261   c = vec_elt_at_index (vcm->commands, 0);
262
263   /* remove trailing whitespace, except for one of them */
264   while (vec_len (input.buffer) >= 2 &&
265          isspace (input.buffer[vec_len (input.buffer) - 1]) &&
266          isspace (input.buffer[vec_len (input.buffer) - 2]))
267     {
268       vec_del1 (input.buffer, vec_len (input.buffer) - 1);
269     }
270
271   /* if input is empty, directly return list of root commands */
272   if (vec_len (input.buffer) == 0 ||
273       (vec_len (input.buffer) == 1 && isspace (input.buffer[0])))
274     {
275       vec_foreach (sc, c->sub_commands)
276       {
277         vec_add1 (result, (u8 *) sc->name);
278       }
279       goto done;
280     }
281
282   /* add a trailing '?' so that vlib_cli_sub_command_match can find
283    * all commands starting with the input string */
284   vec_add1 (input.buffer, '?');
285
286   while (1)
287     {
288       match_bitmap = vlib_cli_sub_command_match (c, &input);
289       /* no match: return no result */
290       if (match_bitmap == 0)
291         {
292           goto done;
293         }
294       is_unique = clib_bitmap_count_set_bits (match_bitmap) == 1;
295       /* unique match: try to step one subcommand level further */
296       if (is_unique)
297         {
298           /* stop if no more input */
299           if (input.index >= vec_len (input.buffer) - 1)
300             {
301               break;
302             }
303
304           index = clib_bitmap_first_set (match_bitmap);
305           c = get_sub_command (vcm, c, index);
306           clib_bitmap_free (match_bitmap);
307           continue;
308         }
309       /* multiple matches: stop here, return all matches */
310       break;
311     }
312
313   /* remove trailing '?' */
314   vec_del1 (input.buffer, vec_len (input.buffer) - 1);
315
316   /* if we have a space at the end of input, and a unique match,
317    * autocomplete the next level of subcommands */
318   help_next_level = (vec_len (str) == 0) || isspace (str[vec_len (str) - 1]);
319   /* *INDENT-OFF* */
320   clib_bitmap_foreach(index, match_bitmap, {
321     if (help_next_level && is_unique) {
322         c = get_sub_command (vcm, c, index);
323         vec_foreach (sc, c->sub_commands) {
324           vec_add1 (result, (u8*) sc->name);
325         }
326         goto done; /* break doesn't work in this macro-loop */
327     }
328     sc = &c->sub_commands[index];
329     vec_add1(result, (u8*) sc->name);
330   });
331   /* *INDENT-ON* */
332
333 done:
334   clib_bitmap_free (match_bitmap);
335   unformat_free (&input);
336
337   if (result)
338     vec_sort_with_function (result, vlib_cli_cmp_strings);
339   return result;
340 }
341
342 static u8 *
343 format_vlib_cli_command_help (u8 * s, va_list * args)
344 {
345   vlib_cli_command_t *c = va_arg (*args, vlib_cli_command_t *);
346   int is_long = va_arg (*args, int);
347   if (is_long && c->long_help)
348     s = format (s, "%s", c->long_help);
349   else if (c->short_help)
350     s = format (s, "%s", c->short_help);
351   else
352     s = format (s, "%v commands", c->path);
353   return s;
354 }
355
356 static u8 *
357 format_vlib_cli_parse_rule_name (u8 * s, va_list * args)
358 {
359   vlib_cli_parse_rule_t *r = va_arg (*args, vlib_cli_parse_rule_t *);
360   return format (s, "<%U>", format_c_identifier, r->name);
361 }
362
363 static u8 *
364 format_vlib_cli_path (u8 * s, va_list * args)
365 {
366   u8 *path = va_arg (*args, u8 *);
367   int i, in_rule;
368   in_rule = 0;
369   for (i = 0; i < vec_len (path); i++)
370     {
371       switch (path[i])
372         {
373         case '%':
374           in_rule = 1;
375           vec_add1 (s, '<');    /* start of <RULE> */
376           break;
377
378         case '_':
379           /* _ -> space in rules. */
380           vec_add1 (s, in_rule ? ' ' : '_');
381           break;
382
383         case ' ':
384           if (in_rule)
385             {
386               vec_add1 (s, '>');        /* end of <RULE> */
387               in_rule = 0;
388             }
389           vec_add1 (s, ' ');
390           break;
391
392         default:
393           vec_add1 (s, path[i]);
394           break;
395         }
396     }
397
398   if (in_rule)
399     vec_add1 (s, '>');          /* terminate <RULE> */
400
401   return s;
402 }
403
404 static vlib_cli_command_t *
405 all_subs (vlib_cli_main_t * cm, vlib_cli_command_t * subs, u32 command_index)
406 {
407   vlib_cli_command_t *c = vec_elt_at_index (cm->commands, command_index);
408   vlib_cli_sub_command_t *sc;
409   vlib_cli_sub_rule_t *sr;
410
411   if (c->function)
412     vec_add1 (subs, c[0]);
413
414   vec_foreach (sr, c->sub_rules)
415     subs = all_subs (cm, subs, sr->command_index);
416   vec_foreach (sc, c->sub_commands) subs = all_subs (cm, subs, sc->index);
417
418   return subs;
419 }
420
421 static int
422 vlib_cli_cmp_rule (void *a1, void *a2)
423 {
424   vlib_cli_sub_rule_t *r1 = a1;
425   vlib_cli_sub_rule_t *r2 = a2;
426
427   return vec_cmp (r1->name, r2->name);
428 }
429
430 static int
431 vlib_cli_cmp_command (void *a1, void *a2)
432 {
433   vlib_cli_command_t *c1 = a1;
434   vlib_cli_command_t *c2 = a2;
435
436   return vec_cmp (c1->path, c2->path);
437 }
438
439 static clib_error_t *
440 vlib_cli_dispatch_sub_commands (vlib_main_t * vm,
441                                 vlib_cli_main_t * cm,
442                                 unformat_input_t * input,
443                                 uword parent_command_index)
444 {
445   vlib_cli_command_t *parent, *c;
446   clib_error_t *error = 0;
447   unformat_input_t sub_input;
448   u8 *string;
449   uword is_main_dispatch = cm == &vm->cli_main;
450
451   parent = vec_elt_at_index (cm->commands, parent_command_index);
452   if (is_main_dispatch && unformat (input, "help"))
453     {
454       uword help_at_end_of_line, i;
455
456       help_at_end_of_line =
457         unformat_check_input (input) == UNFORMAT_END_OF_INPUT;
458       while (1)
459         {
460           c = parent;
461           if (unformat_user
462               (input, unformat_vlib_cli_sub_command, vm, c, &parent))
463             ;
464
465           else if (!(unformat_check_input (input) == UNFORMAT_END_OF_INPUT))
466             goto unknown;
467
468           else
469             break;
470         }
471
472       /* help SUB-COMMAND => long format help.
473          "help" at end of line: show all commands. */
474       if (!help_at_end_of_line)
475         vlib_cli_output (vm, "%U", format_vlib_cli_command_help, c,
476                          /* is_long */ 1);
477
478       else if (vec_len (c->sub_commands) + vec_len (c->sub_rules) == 0)
479         vlib_cli_output (vm, "%v: no sub-commands", c->path);
480
481       else
482         {
483           vlib_cli_sub_command_t *sc;
484           vlib_cli_sub_rule_t *sr, *subs;
485
486           subs = vec_dup (c->sub_rules);
487
488           /* Add in rules if any. */
489           vec_foreach (sc, c->sub_commands)
490           {
491             vec_add2 (subs, sr, 1);
492             sr->name = sc->name;
493             sr->command_index = sc->index;
494             sr->rule_index = ~0;
495           }
496
497           vec_sort_with_function (subs, vlib_cli_cmp_rule);
498
499           for (i = 0; i < vec_len (subs); i++)
500             {
501               vlib_cli_command_t *d;
502               vlib_cli_parse_rule_t *r;
503
504               d = vec_elt_at_index (cm->commands, subs[i].command_index);
505               r =
506                 subs[i].rule_index != ~0 ? vec_elt_at_index (cm->parse_rules,
507                                                              subs
508                                                              [i].rule_index) :
509                 0;
510
511               if (r)
512                 vlib_cli_output
513                   (vm, "  %-30U %U",
514                    format_vlib_cli_parse_rule_name, r,
515                    format_vlib_cli_command_help, d, /* is_long */ 0);
516               else
517                 vlib_cli_output
518                   (vm, "  %-30v %U",
519                    subs[i].name,
520                    format_vlib_cli_command_help, d, /* is_long */ 0);
521             }
522
523           vec_free (subs);
524         }
525     }
526
527   else if (is_main_dispatch
528            && (unformat (input, "choices") || unformat (input, "?")))
529     {
530       vlib_cli_command_t *sub, *subs;
531
532       subs = all_subs (cm, 0, parent_command_index);
533       vec_sort_with_function (subs, vlib_cli_cmp_command);
534       vec_foreach (sub, subs)
535         vlib_cli_output (vm, "  %-40U %U",
536                          format_vlib_cli_path, sub->path,
537                          format_vlib_cli_command_help, sub, /* is_long */ 0);
538       vec_free (subs);
539     }
540
541   else if (unformat (input, "comment %v", &string))
542     {
543       vec_free (string);
544     }
545
546   else if (unformat (input, "uncomment %U",
547                      unformat_vlib_cli_sub_input, &sub_input))
548     {
549       error =
550         vlib_cli_dispatch_sub_commands (vm, cm, &sub_input,
551                                         parent_command_index);
552       unformat_free (&sub_input);
553     }
554
555   else
556     if (unformat_user (input, unformat_vlib_cli_sub_command, vm, parent, &c))
557     {
558       unformat_input_t *si;
559       uword has_sub_commands =
560         vec_len (c->sub_commands) + vec_len (c->sub_rules) > 0;
561
562       si = input;
563       if (unformat_user (input, unformat_vlib_cli_sub_input, &sub_input))
564         si = &sub_input;
565
566       if (has_sub_commands)
567         error = vlib_cli_dispatch_sub_commands (vm, cm, si, c - cm->commands);
568
569       if (has_sub_commands && !error)
570         /* Found valid sub-command. */ ;
571
572       else if (c->function)
573         {
574           clib_error_t *c_error;
575
576           /* Skip white space for benefit of called function. */
577           unformat_skip_white_space (si);
578
579           if (unformat (si, "?"))
580             {
581               vlib_cli_output (vm, "  %-40U %U", format_vlib_cli_path, c->path, format_vlib_cli_command_help, c,        /* is_long */
582                                0);
583             }
584           else
585             {
586               if (!c->is_mp_safe)
587                 vlib_worker_thread_barrier_sync (vm);
588
589               c_error = c->function (vm, si, c);
590
591               if (!c->is_mp_safe)
592                 vlib_worker_thread_barrier_release (vm);
593
594               if (c_error)
595                 {
596                   error =
597                     clib_error_return (0, "%v: %v", c->path, c_error->what);
598                   clib_error_free (c_error);
599                   /* Free sub input. */
600                   if (si != input)
601                     unformat_free (si);
602
603                   return error;
604                 }
605             }
606
607           /* Free any previous error. */
608           clib_error_free (error);
609         }
610
611       else if (!error)
612         error = clib_error_return (0, "%v: no sub-commands", c->path);
613
614       /* Free sub input. */
615       if (si != input)
616         unformat_free (si);
617     }
618
619   else
620     goto unknown;
621
622   return error;
623
624 unknown:
625   if (parent->path)
626     return clib_error_return (0, "%v: unknown input `%U'", parent->path,
627                               format_unformat_error, input);
628   else
629     return clib_error_return (0, "unknown input `%U'", format_unformat_error,
630                               input);
631 }
632
633
634 void vlib_unix_error_report (vlib_main_t *, clib_error_t *)
635   __attribute__ ((weak));
636
637 void
638 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
639 {
640 }
641
642 /* Process CLI input. */
643 void
644 vlib_cli_input (vlib_main_t * vm,
645                 unformat_input_t * input,
646                 vlib_cli_output_function_t * function, uword function_arg)
647 {
648   vlib_process_t *cp = vlib_get_current_process (vm);
649   vlib_cli_main_t *cm = &vm->cli_main;
650   clib_error_t *error;
651   vlib_cli_output_function_t *save_function;
652   uword save_function_arg;
653
654   save_function = cp->output_function;
655   save_function_arg = cp->output_function_arg;
656
657   cp->output_function = function;
658   cp->output_function_arg = function_arg;
659
660   do
661     {
662       vec_reset_length (cm->parse_rule_data);
663       error = vlib_cli_dispatch_sub_commands (vm, &vm->cli_main, input, /* parent */
664                                               0);
665     }
666   while (!error && !unformat (input, "%U", unformat_eof));
667
668   if (error)
669     {
670       vlib_cli_output (vm, "%v", error->what);
671       vlib_unix_error_report (vm, error);
672       clib_error_free (error);
673     }
674
675   cp->output_function = save_function;
676   cp->output_function_arg = save_function_arg;
677 }
678
679 /* Output to current CLI connection. */
680 void
681 vlib_cli_output (vlib_main_t * vm, char *fmt, ...)
682 {
683   vlib_process_t *cp = vlib_get_current_process (vm);
684   va_list va;
685   u8 *s;
686
687   va_start (va, fmt);
688   s = va_format (0, fmt, &va);
689   va_end (va);
690
691   /* Terminate with \n if not present. */
692   if (vec_len (s) > 0 && s[vec_len (s) - 1] != '\n')
693     vec_add1 (s, '\n');
694
695   if ((!cp) || (!cp->output_function))
696     fformat (stdout, "%v", s);
697   else
698     cp->output_function (cp->output_function_arg, s, vec_len (s));
699
700   vec_free (s);
701 }
702
703 void *vl_msg_push_heap (void) __attribute__ ((weak));
704 void vl_msg_pop_heap (void *oldheap) __attribute__ ((weak));
705
706 static clib_error_t *
707 show_memory_usage (vlib_main_t * vm,
708                    unformat_input_t * input, vlib_cli_command_t * cmd)
709 {
710   int verbose __attribute__ ((unused)) = 0, api_segment = 0;
711   clib_error_t *error;
712   u32 index = 0;
713
714   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
715     {
716       if (unformat (input, "verbose"))
717         verbose = 1;
718       else if (unformat (input, "api-segment"))
719         api_segment = 1;
720       else
721         {
722           error = clib_error_return (0, "unknown input `%U'",
723                                      format_unformat_error, input);
724           return error;
725         }
726     }
727
728   if (api_segment)
729     {
730       void *oldheap = vl_msg_push_heap ();
731       u8 *s_in_svm =
732         format (0, "%U\n", format_mheap, clib_mem_get_heap (), 1);
733       vl_msg_pop_heap (oldheap);
734       u8 *s = vec_dup (s_in_svm);
735
736       oldheap = vl_msg_push_heap ();
737       vec_free (s_in_svm);
738       vl_msg_pop_heap (oldheap);
739       vlib_cli_output (vm, "API segment start:");
740       vlib_cli_output (vm, "%v", s);
741       vlib_cli_output (vm, "API segment end:");
742       vec_free (s);
743     }
744
745 #if USE_DLMALLOC == 0
746   /* *INDENT-OFF* */
747   foreach_vlib_main (
748   ({
749       mheap_t *h = mheap_header (clib_per_cpu_mheaps[index]);
750       vlib_cli_output (vm, "%sThread %d %s\n", index ? "\n":"", index,
751                        vlib_worker_threads[index].name);
752       vlib_cli_output (vm, "  %U\n", format_page_map, pointer_to_uword (h) -
753                        h->vm_alloc_offset_from_header,
754                        h->vm_alloc_size);
755       vlib_cli_output (vm, "  %U\n", format_mheap, clib_per_cpu_mheaps[index],
756                        verbose);
757       index++;
758   }));
759   /* *INDENT-ON* */
760 #else
761   {
762     uword clib_mem_trace_enable_disable (uword enable);
763     uword was_enabled;
764
765     /*
766      * Note: the foreach_vlib_main cause allocator traffic,
767      * so shut off tracing before we go there...
768      */
769     was_enabled = clib_mem_trace_enable_disable (0);
770
771     /* *INDENT-OFF* */
772     foreach_vlib_main (
773     ({
774       struct dlmallinfo mi;
775       void *mspace;
776       mspace = clib_per_cpu_mheaps[index];
777
778       mi = mspace_mallinfo (mspace);
779       vlib_cli_output (vm, "%sThread %d %s\n", index ? "\n":"", index,
780                        vlib_worker_threads[index].name);
781       vlib_cli_output (vm, "  %U\n", format_page_map,
782                        pointer_to_uword (mspace_least_addr(mspace)),
783                        mi.arena);
784       vlib_cli_output (vm, "  %U\n", format_mheap, clib_per_cpu_mheaps[index],
785                        verbose);
786       index++;
787     }));
788     /* *INDENT-ON* */
789
790     /* Restore the trace flag */
791     clib_mem_trace_enable_disable (was_enabled);
792   }
793 #endif /* USE_DLMALLOC */
794   return 0;
795 }
796
797 /* *INDENT-OFF* */
798 VLIB_CLI_COMMAND (show_memory_usage_command, static) = {
799   .path = "show memory",
800   .short_help = "[verbose | api-segment] Show current memory usage",
801   .function = show_memory_usage,
802 };
803 /* *INDENT-ON* */
804
805 static clib_error_t *
806 show_cpu (vlib_main_t * vm, unformat_input_t * input,
807           vlib_cli_command_t * cmd)
808 {
809 #define _(a,b,c) vlib_cli_output (vm, "%-25s " b, a ":", c);
810   _("Model name", "%U", format_cpu_model_name);
811   _("Microarchitecture", "%U", format_cpu_uarch);
812   _("Flags", "%U", format_cpu_flags);
813   _("Base frequency", "%.2f GHz",
814     ((f64) vm->clib_time.clocks_per_second) * 1e-9);
815 #undef _
816   return 0;
817 }
818
819 /*?
820  * Displays various information about the CPU.
821  *
822  * @cliexpar
823  * @cliexstart{show cpu}
824  * Model name:               Intel(R) Xeon(R) CPU E5-2667 v4 @ 3.20GHz
825  * Microarchitecture:        Broadwell (Broadwell-EP/EX)
826  * Flags:                    sse3 ssse3 sse41 sse42 avx avx2 aes
827  * Base Frequency:           3.20 GHz
828  * @cliexend
829 ?*/
830 /* *INDENT-OFF* */
831 VLIB_CLI_COMMAND (show_cpu_command, static) = {
832   .path = "show cpu",
833   .short_help = "Show cpu information",
834   .function = show_cpu,
835 };
836
837 /* *INDENT-ON* */
838
839 static clib_error_t *
840 enable_disable_memory_trace (vlib_main_t * vm,
841                              unformat_input_t * input,
842                              vlib_cli_command_t * cmd)
843 {
844   unformat_input_t _line_input, *line_input = &_line_input;
845   int enable;
846   int api_segment = 0;
847   void *oldheap;
848
849
850   if (!unformat_user (input, unformat_line_input, line_input))
851     return 0;
852
853   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
854     {
855       if (unformat (line_input, "%U", unformat_vlib_enable_disable, &enable))
856         ;
857       else if (unformat (line_input, "api-segment"))
858         api_segment = 1;
859       else
860         {
861           unformat_free (line_input);
862           return clib_error_return (0, "invalid input");
863         }
864     }
865   unformat_free (line_input);
866
867   if (api_segment)
868     oldheap = vl_msg_push_heap ();
869   clib_mem_trace (enable);
870   if (api_segment)
871     vl_msg_pop_heap (oldheap);
872
873   return 0;
874 }
875
876 /* *INDENT-OFF* */
877 VLIB_CLI_COMMAND (enable_disable_memory_trace_command, static) = {
878   .path = "memory-trace",
879   .short_help = "on|off [api-segment] Enable/disable memory allocation trace",
880   .function = enable_disable_memory_trace,
881 };
882 /* *INDENT-ON* */
883
884
885 static clib_error_t *
886 test_heap_validate (vlib_main_t * vm, unformat_input_t * input,
887                     vlib_cli_command_t * cmd)
888 {
889 #if USE_DLMALLOC == 0
890   clib_error_t *error = 0;
891   void *heap;
892   mheap_t *mheap;
893
894   if (unformat (input, "on"))
895     {
896         /* *INDENT-OFF* */
897         foreach_vlib_main({
898           heap = clib_per_cpu_mheaps[this_vlib_main->thread_index];
899           mheap = mheap_header(heap);
900           mheap->flags |= MHEAP_FLAG_VALIDATE;
901           // Turn off small object cache because it delays detection of errors
902           mheap->flags &= ~MHEAP_FLAG_SMALL_OBJECT_CACHE;
903         });
904         /* *INDENT-ON* */
905
906     }
907   else if (unformat (input, "off"))
908     {
909         /* *INDENT-OFF* */
910         foreach_vlib_main({
911           heap = clib_per_cpu_mheaps[this_vlib_main->thread_index];
912           mheap = mheap_header(heap);
913           mheap->flags &= ~MHEAP_FLAG_VALIDATE;
914           mheap->flags |= MHEAP_FLAG_SMALL_OBJECT_CACHE;
915         });
916         /* *INDENT-ON* */
917     }
918   else if (unformat (input, "now"))
919     {
920         /* *INDENT-OFF* */
921         foreach_vlib_main({
922           heap = clib_per_cpu_mheaps[this_vlib_main->thread_index];
923           mheap = mheap_header(heap);
924           mheap_validate(heap);
925         });
926         /* *INDENT-ON* */
927       vlib_cli_output (vm, "heap validation complete");
928
929     }
930   else
931     {
932       return clib_error_return (0, "unknown input `%U'",
933                                 format_unformat_error, input);
934     }
935
936   return error;
937 #else
938   return clib_error_return (0, "unimplemented...");
939 #endif /* USE_DLMALLOC */
940 }
941
942 /* *INDENT-OFF* */
943 VLIB_CLI_COMMAND (cmd_test_heap_validate,static) = {
944     .path = "test heap-validate",
945     .short_help = "<on/off/now> validate heap on future allocs/frees or right now",
946     .function = test_heap_validate,
947 };
948 /* *INDENT-ON* */
949
950 static clib_error_t *
951 restart_cmd_fn (vlib_main_t * vm, unformat_input_t * input,
952                 vlib_cli_command_t * cmd)
953 {
954   clib_file_main_t *fm = &file_main;
955   clib_file_t *f;
956
957   /* environ(7) does not indicate a header for this */
958   extern char **environ;
959
960   /* Close all known open files */
961   /* *INDENT-OFF* */
962   pool_foreach(f, fm->file_pool,
963     ({
964       if (f->file_descriptor > 2)
965         close(f->file_descriptor);
966     }));
967   /* *INDENT-ON* */
968
969   /* Exec ourself */
970   execve (vm->name, (char **) vm->argv, environ);
971
972   return 0;
973 }
974
975 /* *INDENT-OFF* */
976 VLIB_CLI_COMMAND (restart_cmd,static) = {
977     .path = "restart",
978     .short_help = "restart process",
979     .function = restart_cmd_fn,
980 };
981 /* *INDENT-ON* */
982
983 #ifdef TEST_CODE
984 /*
985  * A trivial test harness to verify the per-process output_function
986  * is working correcty.
987  */
988
989 static clib_error_t *
990 sleep_ten_seconds (vlib_main_t * vm,
991                    unformat_input_t * input, vlib_cli_command_t * cmd)
992 {
993   u16 i;
994   u16 my_id = rand ();
995
996   vlib_cli_output (vm, "Starting 10 seconds sleep with id %u\n", my_id);
997
998   for (i = 0; i < 10; i++)
999     {
1000       vlib_process_wait_for_event_or_clock (vm, 1.0);
1001       vlib_cli_output (vm, "Iteration number %u, my id: %u\n", i, my_id);
1002     }
1003   vlib_cli_output (vm, "Done with sleep with id %u\n", my_id);
1004   return 0;
1005 }
1006
1007 /* *INDENT-OFF* */
1008 VLIB_CLI_COMMAND (ping_command, static) = {
1009   .path = "test sleep",
1010   .function = sleep_ten_seconds,
1011   .short_help = "Sleep for 10 seconds",
1012 };
1013 /* *INDENT-ON* */
1014 #endif /* ifdef TEST_CODE */
1015
1016 static uword
1017 vlib_cli_normalize_path (char *input, char **result)
1018 {
1019   char *i = input;
1020   char *s = 0;
1021   uword l = 0;
1022   uword index_of_last_space = ~0;
1023
1024   while (*i != 0)
1025     {
1026       u8 c = *i++;
1027       /* Multiple white space -> single space. */
1028       switch (c)
1029         {
1030         case ' ':
1031         case '\t':
1032         case '\n':
1033         case '\r':
1034           if (l > 0 && s[l - 1] != ' ')
1035             {
1036               vec_add1 (s, ' ');
1037               l++;
1038             }
1039           break;
1040
1041         default:
1042           if (l > 0 && s[l - 1] == ' ')
1043             index_of_last_space = vec_len (s);
1044           vec_add1 (s, c);
1045           l++;
1046           break;
1047         }
1048     }
1049
1050   /* Remove any extra space at end. */
1051   if (l > 0 && s[l - 1] == ' ')
1052     _vec_len (s) -= 1;
1053
1054   *result = s;
1055   return index_of_last_space;
1056 }
1057
1058 always_inline uword
1059 parent_path_len (char *path)
1060 {
1061   word i;
1062   for (i = vec_len (path) - 1; i >= 0; i--)
1063     {
1064       if (path[i] == ' ')
1065         return i;
1066     }
1067   return ~0;
1068 }
1069
1070 static void
1071 add_sub_command (vlib_cli_main_t * cm, uword parent_index, uword child_index)
1072 {
1073   vlib_cli_command_t *p, *c;
1074   vlib_cli_sub_command_t *sub_c;
1075   u8 *sub_name;
1076   word i, l;
1077
1078   p = vec_elt_at_index (cm->commands, parent_index);
1079   c = vec_elt_at_index (cm->commands, child_index);
1080
1081   l = parent_path_len (c->path);
1082   if (l == ~0)
1083     sub_name = vec_dup ((u8 *) c->path);
1084   else
1085     {
1086       ASSERT (l + 1 < vec_len (c->path));
1087       sub_name = 0;
1088       vec_add (sub_name, c->path + l + 1, vec_len (c->path) - (l + 1));
1089     }
1090
1091   if (sub_name[0] == '%')
1092     {
1093       uword *q;
1094       vlib_cli_sub_rule_t *sr;
1095
1096       /* Remove %. */
1097       vec_delete (sub_name, 1, 0);
1098
1099       if (!p->sub_rule_index_by_name)
1100         p->sub_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1101                                                      sizeof (sub_name[0]),
1102                                                      sizeof (uword));
1103       q = hash_get_mem (p->sub_rule_index_by_name, sub_name);
1104       if (q)
1105         {
1106           sr = vec_elt_at_index (p->sub_rules, q[0]);
1107           ASSERT (sr->command_index == child_index);
1108           return;
1109         }
1110
1111       q = hash_get_mem (cm->parse_rule_index_by_name, sub_name);
1112       if (!q)
1113         {
1114           clib_error ("reference to unknown rule `%%%v' in path `%v'",
1115                       sub_name, c->path);
1116           return;
1117         }
1118
1119       hash_set_mem (p->sub_rule_index_by_name, sub_name,
1120                     vec_len (p->sub_rules));
1121       vec_add2 (p->sub_rules, sr, 1);
1122       sr->name = sub_name;
1123       sr->rule_index = q[0];
1124       sr->command_index = child_index;
1125       return;
1126     }
1127
1128   if (!p->sub_command_index_by_name)
1129     p->sub_command_index_by_name = hash_create_vec ( /* initial length */ 32,
1130                                                     sizeof (c->path[0]),
1131                                                     sizeof (uword));
1132
1133   /* Check if sub-command has already been created. */
1134   if (hash_get_mem (p->sub_command_index_by_name, sub_name))
1135     {
1136       vec_free (sub_name);
1137       return;
1138     }
1139
1140   vec_add2 (p->sub_commands, sub_c, 1);
1141   sub_c->index = child_index;
1142   sub_c->name = sub_name;
1143   hash_set_mem (p->sub_command_index_by_name, sub_c->name,
1144                 sub_c - p->sub_commands);
1145
1146   vec_validate (p->sub_command_positions, vec_len (sub_c->name) - 1);
1147   for (i = 0; i < vec_len (sub_c->name); i++)
1148     {
1149       int n;
1150       vlib_cli_parse_position_t *pos;
1151
1152       pos = vec_elt_at_index (p->sub_command_positions, i);
1153
1154       if (!pos->bitmaps)
1155         pos->min_char = sub_c->name[i];
1156
1157       n = sub_c->name[i] - pos->min_char;
1158       if (n < 0)
1159         {
1160           pos->min_char = sub_c->name[i];
1161           vec_insert (pos->bitmaps, -n, 0);
1162           n = 0;
1163         }
1164
1165       vec_validate (pos->bitmaps, n);
1166       pos->bitmaps[n] =
1167         clib_bitmap_ori (pos->bitmaps[n], sub_c - p->sub_commands);
1168     }
1169 }
1170
1171 static void
1172 vlib_cli_make_parent (vlib_cli_main_t * cm, uword ci)
1173 {
1174   uword p_len, pi, *p;
1175   char *p_path;
1176   vlib_cli_command_t *c, *parent;
1177
1178   /* Root command (index 0) should have already been added. */
1179   ASSERT (vec_len (cm->commands) > 0);
1180
1181   c = vec_elt_at_index (cm->commands, ci);
1182   p_len = parent_path_len (c->path);
1183
1184   /* No space?  Parent is root command. */
1185   if (p_len == ~0)
1186     {
1187       add_sub_command (cm, 0, ci);
1188       return;
1189     }
1190
1191   p_path = 0;
1192   vec_add (p_path, c->path, p_len);
1193
1194   p = hash_get_mem (cm->command_index_by_path, p_path);
1195
1196   /* Parent exists? */
1197   if (!p)
1198     {
1199       /* Parent does not exist; create it. */
1200       vec_add2 (cm->commands, parent, 1);
1201       parent->path = p_path;
1202       hash_set_mem (cm->command_index_by_path, parent->path,
1203                     parent - cm->commands);
1204       pi = parent - cm->commands;
1205     }
1206   else
1207     {
1208       pi = p[0];
1209       vec_free (p_path);
1210     }
1211
1212   add_sub_command (cm, pi, ci);
1213
1214   /* Create parent's parent. */
1215   if (!p)
1216     vlib_cli_make_parent (cm, pi);
1217 }
1218
1219 always_inline uword
1220 vlib_cli_command_is_empty (vlib_cli_command_t * c)
1221 {
1222   return (c->long_help == 0 && c->short_help == 0 && c->function == 0);
1223 }
1224
1225 clib_error_t *
1226 vlib_cli_register (vlib_main_t * vm, vlib_cli_command_t * c)
1227 {
1228   vlib_cli_main_t *cm = &vm->cli_main;
1229   clib_error_t *error = 0;
1230   uword ci, *p;
1231   char *normalized_path;
1232
1233   if ((error = vlib_call_init_function (vm, vlib_cli_init)))
1234     return error;
1235
1236   (void) vlib_cli_normalize_path (c->path, &normalized_path);
1237
1238   if (!cm->command_index_by_path)
1239     cm->command_index_by_path = hash_create_vec ( /* initial length */ 32,
1240                                                  sizeof (c->path[0]),
1241                                                  sizeof (uword));
1242
1243   /* See if command already exists with given path. */
1244   p = hash_get_mem (cm->command_index_by_path, normalized_path);
1245   if (p)
1246     {
1247       vlib_cli_command_t *d;
1248
1249       ci = p[0];
1250       d = vec_elt_at_index (cm->commands, ci);
1251
1252       /* If existing command was created via vlib_cli_make_parent
1253          replaced it with callers data. */
1254       if (vlib_cli_command_is_empty (d))
1255         {
1256           vlib_cli_command_t save = d[0];
1257
1258           ASSERT (!vlib_cli_command_is_empty (c));
1259
1260           /* Copy callers fields. */
1261           d[0] = c[0];
1262
1263           /* Save internal fields. */
1264           d->path = save.path;
1265           d->sub_commands = save.sub_commands;
1266           d->sub_command_index_by_name = save.sub_command_index_by_name;
1267           d->sub_command_positions = save.sub_command_positions;
1268           d->sub_rules = save.sub_rules;
1269         }
1270       else
1271         error =
1272           clib_error_return (0, "duplicate command name with path %v",
1273                              normalized_path);
1274
1275       vec_free (normalized_path);
1276       if (error)
1277         return error;
1278     }
1279   else
1280     {
1281       /* Command does not exist: create it. */
1282
1283       /* Add root command (index 0). */
1284       if (vec_len (cm->commands) == 0)
1285         {
1286           /* Create command with index 0; path is empty string. */
1287           vec_resize (cm->commands, 1);
1288         }
1289
1290       ci = vec_len (cm->commands);
1291       hash_set_mem (cm->command_index_by_path, normalized_path, ci);
1292       vec_add1 (cm->commands, c[0]);
1293
1294       c = vec_elt_at_index (cm->commands, ci);
1295       c->path = normalized_path;
1296
1297       /* Don't inherit from registration. */
1298       c->sub_commands = 0;
1299       c->sub_command_index_by_name = 0;
1300       c->sub_command_positions = 0;
1301     }
1302
1303   vlib_cli_make_parent (cm, ci);
1304   return 0;
1305 }
1306
1307 clib_error_t *
1308 vlib_cli_register_parse_rule (vlib_main_t * vm, vlib_cli_parse_rule_t * r_reg)
1309 {
1310   vlib_cli_main_t *cm = &vm->cli_main;
1311   vlib_cli_parse_rule_t *r;
1312   clib_error_t *error = 0;
1313   u8 *r_name;
1314   uword *p;
1315
1316   if (!cm->parse_rule_index_by_name)
1317     cm->parse_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1318                                                     sizeof (r->name[0]),
1319                                                     sizeof (uword));
1320
1321   /* Make vector copy of name. */
1322   r_name = format (0, "%s", r_reg->name);
1323
1324   if ((p = hash_get_mem (cm->parse_rule_index_by_name, r_name)))
1325     {
1326       vec_free (r_name);
1327       return clib_error_return (0, "duplicate parse rule name `%s'",
1328                                 r_reg->name);
1329     }
1330
1331   vec_add2 (cm->parse_rules, r, 1);
1332   r[0] = r_reg[0];
1333   r->name = (char *) r_name;
1334   hash_set_mem (cm->parse_rule_index_by_name, r->name, r - cm->parse_rules);
1335
1336   return error;
1337 }
1338
1339 #if 0
1340 /* $$$ turn back on again someday, maybe */
1341 static clib_error_t *vlib_cli_register_parse_rules (vlib_main_t * vm,
1342                                                     vlib_cli_parse_rule_t *
1343                                                     lo,
1344                                                     vlib_cli_parse_rule_t *
1345                                                     hi)
1346   __attribute__ ((unused))
1347 {
1348   clib_error_t *error = 0;
1349   vlib_cli_parse_rule_t *r;
1350
1351   for (r = lo; r < hi; r = clib_elf_section_data_next (r, 0))
1352     {
1353       if (!r->name || strlen (r->name) == 0)
1354         {
1355           error = clib_error_return (0, "parse rule with no name");
1356           goto done;
1357         }
1358
1359       error = vlib_cli_register_parse_rule (vm, r);
1360       if (error)
1361         goto done;
1362     }
1363
1364 done:
1365   return error;
1366 }
1367 #endif
1368
1369 static int
1370 cli_path_compare (void *a1, void *a2)
1371 {
1372   u8 **s1 = a1;
1373   u8 **s2 = a2;
1374
1375   if ((vec_len (*s1) < vec_len (*s2)) &&
1376       memcmp ((char *) *s1, (char *) *s2, vec_len (*s1)) == 0)
1377     return -1;
1378
1379
1380   if ((vec_len (*s1) > vec_len (*s2)) &&
1381       memcmp ((char *) *s1, (char *) *s2, vec_len (*s2)) == 0)
1382     return 1;
1383
1384   return vec_cmp (*s1, *s2);
1385 }
1386
1387 static clib_error_t *
1388 show_cli_cmd_fn (vlib_main_t * vm, unformat_input_t * input,
1389                  vlib_cli_command_t * cmd)
1390 {
1391   vlib_cli_main_t *cm = &vm->cli_main;
1392   vlib_cli_command_t *cli;
1393   u8 **paths = 0, **s;
1394
1395   /* *INDENT-OFF* */
1396   vec_foreach (cli, cm->commands)
1397     if (vec_len (cli->path) > 0)
1398       vec_add1 (paths, (u8 *) cli->path);
1399
1400   vec_sort_with_function (paths, cli_path_compare);
1401
1402   vec_foreach (s, paths)
1403     vlib_cli_output (vm, "%v", *s);
1404   /* *INDENT-ON* */
1405
1406   vec_free (paths);
1407   return 0;
1408 }
1409
1410 /* *INDENT-OFF* */
1411 VLIB_CLI_COMMAND (show_cli_command, static) = {
1412   .path = "show cli",
1413   .short_help = "Show cli commands",
1414   .function = show_cli_cmd_fn,
1415 };
1416 /* *INDENT-ON* */
1417
1418 static clib_error_t *
1419 vlib_cli_init (vlib_main_t * vm)
1420 {
1421   vlib_cli_main_t *cm = &vm->cli_main;
1422   clib_error_t *error = 0;
1423   vlib_cli_command_t *cmd;
1424
1425   cmd = cm->cli_command_registrations;
1426
1427   while (cmd)
1428     {
1429       error = vlib_cli_register (vm, cmd);
1430       if (error)
1431         return error;
1432       cmd = cmd->next_cli_command;
1433     }
1434   return error;
1435 }
1436
1437 VLIB_INIT_FUNCTION (vlib_cli_init);
1438
1439 /*
1440  * fd.io coding-style-patch-verification: ON
1441  *
1442  * Local Variables:
1443  * eval: (c-set-style "gnu")
1444  * End:
1445  */