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/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);
  52 int vl_api_get_elog_trace_api_messages (void);
  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 *
  90 vlib_cli_sub_command_match (vlib_cli_command_t * c, unformat_input_t * input)
  91 {
  92   int i, n;
  93   uword *match = 0;
  94   vlib_cli_parse_position_t *p;
  95
  96   unformat_skip_white_space (input);
  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':
 116         case UNFORMAT_END_OF_INPUT:
 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             {
 122               p = vec_elt_at_index (c->sub_command_positions, i);
 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
 140       p = vec_elt_at_index (c->sub_command_positions, i);
 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
 163 unformat_vlib_cli_sub_input (unformat_input_t * i, va_list * args)
 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 *
 199 get_sub_command (vlib_cli_main_t * cm, vlib_cli_command_t * parent, u32 si)
 200 {
 201   vlib_cli_sub_command_t *s = vec_elt_at_index (parent->sub_commands, si);
 202   return vec_elt_at_index (cm->commands, s->index);
 203 }
 204
 205 static uword
 206 unformat_vlib_cli_sub_command (unformat_input_t * i, va_list * args)
 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 **
 237 vlib_cli_get_possible_completions (u8 * str)
 238 {
 239   vlib_cli_command_t *c;
 240   vlib_cli_sub_command_t *sc;
 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)
 325     vec_sort_with_function (result, vlib_cli_cmp_strings);
 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 *
 354 all_subs (vlib_cli_main_t * cm, vlib_cli_command_t * subs, u32 command_index)
 355 {
 356   vlib_cli_command_t *c = vec_elt_at_index (cm->commands, command_index);
 357   vlib_cli_sub_command_t *sc;
 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 *
 386 vlib_cli_dispatch_sub_commands (vlib_main_t * vm,
 387                                 vlib_cli_main_t * cm,
 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 =
 403         unformat_check_input (input) == UNFORMAT_END_OF_INPUT;
 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)
 421         vlib_cli_output (vm, "%U", format_vlib_cli_command_help, c,
 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;
 430           vlib_cli_sub_command_t *sc;
 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
 440           vec_sort_with_function (subs, vlib_cli_cmp_rule);
 441
 442           for (i = 0; i < vec_len (subs); i++)
 443             {
 444               vlib_cli_command_t *d;
 445
 446               d = vec_elt_at_index (cm->commands, subs[i].command_index);
 447               vlib_cli_output
 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);
 462       vec_sort_with_function (subs, vlib_cli_cmp_command);
 463       vec_foreach (sub, subs)
 464         vlib_cli_output (vm, "  %-40U %U",
 465                          format_vlib_cli_path, sub->path,
 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;
 487       if (current_traced_heap)
 488         {
 489           void *oldheap;
 490           oldheap = clib_mem_set_heap (current_traced_heap);
 491           clib_mem_trace (0);
 492           clib_mem_set_heap (oldheap);
 493           current_traced_heap = 0;
 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
 509       (void) clib_mem_trace_enable_disable (0);
 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     {
 520       unformat_input_t *si;
 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. */
 539           unformat_skip_white_space (si);
 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             {
 548               if (PREDICT_FALSE (vm->elog_trace_cli_commands))
 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)
 566                 vlib_worker_thread_barrier_sync (vm);
 567               if (PREDICT_FALSE (vec_len (cm->perf_counter_cbs) != 0))
 568                 clib_call_callbacks (cm->perf_counter_cbs, cm,
 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))
 575                 clib_call_callbacks (cm->perf_counter_cbs, cm,
 576                                      c - cm->commands, 1 /* after */ );
 577               if (!c->is_mp_safe)
 578                 vlib_worker_thread_barrier_release (vm);
 579
 580               if (PREDICT_FALSE (vm->elog_trace_cli_commands))
 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
 646 void vlib_unix_error_report (vlib_main_t *, clib_error_t *)
 647   __attribute__ ((weak));
 648
 649 void
 650 vlib_unix_error_report (vlib_main_t * vm, clib_error_t * error)
 651 {
 652 }
 653
 654 /* Process CLI input. */
 655 int
 656 vlib_cli_input (vlib_main_t * vm,
 657                 unformat_input_t * input,
 658                 vlib_cli_output_function_t * function, uword function_arg)
 659 {
 660   vlib_process_t *cp = vlib_get_current_process (vm);
 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 {
 698   vlib_process_t *cp = vlib_get_current_process (vm);
 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 *
 720 vl_msg_push_heap (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 *
 739 show_memory_usage (vlib_main_t * vm,
 740                    unformat_input_t * input, vlib_cli_command_t * cmd)
 741 {
 742   clib_mem_main_t *mm = &clib_mem_main;
 743   int verbose __attribute__ ((unused)) = 0;
 744   int api_segment = 0, stats_segment = 0, main_heap = 0, numa_heaps = 0;
 745   clib_error_t *error;
 746   u32 index = 0;
 747   int i;
 748   uword clib_mem_trace_enable_disable (uword enable);
 749   uword was_enabled;
 750
 751
 752   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 753     {
 754       if (unformat (input, "verbose"))
 755         verbose = 1;
 756       else if (unformat (input, "api-segment"))
 757         api_segment = 1;
 758       else if (unformat (input, "stats-segment"))
 759         stats_segment = 1;
 760       else if (unformat (input, "main-heap"))
 761         main_heap = 1;
 762       else if (unformat (input, "numa-heaps"))
 763         numa_heaps = 1;
 764       else
 765         {
 766           error = clib_error_return (0, "unknown input `%U'",
 767                                      format_unformat_error, input);
 768           return error;
 769         }
 770     }
 771
 772   if ((api_segment + stats_segment + main_heap + numa_heaps) == 0)
 773     return clib_error_return
 774       (0, "Need one of api-segment, stats-segment, main-heap or numa-heaps");
 775
 776   if (api_segment)
 777     {
 778       void *oldheap = vl_msg_push_heap ();
 779       was_enabled = clib_mem_trace_enable_disable (0);
 780       u8 *s_in_svm =
 781         format (0, "%U\n", format_mheap, clib_mem_get_heap (), 1);
 782       vl_msg_pop_heap (oldheap);
 783       u8 *s = vec_dup (s_in_svm);
 784
 785       oldheap = vl_msg_push_heap ();
 786       vec_free (s_in_svm);
 787       clib_mem_trace_enable_disable (was_enabled);
 788       vl_msg_pop_heap (oldheap);
 789       vlib_cli_output (vm, "API segment");
 790       vlib_cli_output (vm, "%v", s);
 791       vec_free (s);
 792     }
 793   if (stats_segment)
 794     {
 795       void *oldheap = vlib_stats_push_heap (0);
 796       was_enabled = clib_mem_trace_enable_disable (0);
 797       u8 *s_in_svm =
 798         format (0, "%U\n", format_mheap, clib_mem_get_heap (), 1);
 799       if (oldheap)
 800         clib_mem_set_heap (oldheap);
 801       u8 *s = vec_dup (s_in_svm);
 802
 803       oldheap = vlib_stats_push_heap (0);
 804       vec_free (s_in_svm);
 805       if (oldheap)
 806         {
 807           clib_mem_trace_enable_disable (was_enabled);
 808           clib_mem_set_heap (oldheap);
 809         }
 810       vlib_cli_output (vm, "Stats segment");
 811       vlib_cli_output (vm, "%v", s);
 812       vec_free (s);
 813     }
 814
 815
 816   {
 817     if (main_heap)
 818       {
 819         /*
 820          * Note: the foreach_vlib_main causes allocator traffic,
 821          * so shut off tracing before we go there...
 822          */
 823         was_enabled = clib_mem_trace_enable_disable (0);
 824
 825         /* *INDENT-OFF* */
 826         foreach_vlib_main (
 827         ({
 828           struct dlmallinfo mi;
 829           void *mspace;
 830           mspace = mm->per_cpu_mheaps[index];
 831
 832           mi = mspace_mallinfo (mspace);
 833           vlib_cli_output (vm, "%sThread %d %s\n", index ? "\n":"", index,
 834                            vlib_worker_threads[index].name);
 835           vlib_cli_output (vm, "  %U\n", format_page_map,
 836                            pointer_to_uword (mspace_least_addr(mspace)),
 837                            mi.arena);
 838           vlib_cli_output (vm, "  %U\n", format_mheap,
 839                            mm->per_cpu_mheaps[index],
 840                            verbose);
 841           index++;
 842         }));
 843         /* *INDENT-ON* */
 844
 845         /* Restore the trace flag */
 846         clib_mem_trace_enable_disable (was_enabled);
 847       }
 848     if (numa_heaps)
 849       {
 850         struct dlmallinfo mi;
 851         void *mspace;
 852
 853         for (i = 0; i < ARRAY_LEN (mm->per_numa_mheaps); i++)
 854           {
 855             if (mm->per_numa_mheaps[i] == 0)
 856               continue;
 857             if (mm->per_numa_mheaps[i] == mm->per_cpu_mheaps[i])
 858               {
 859                 vlib_cli_output (vm, "Numa %d uses the main heap...", i);
 860                 continue;
 861               }
 862             was_enabled = clib_mem_trace_enable_disable (0);
 863             mspace = mm->per_numa_mheaps[i];
 864
 865             mi = mspace_mallinfo (mspace);
 866             vlib_cli_output (vm, "Numa %d:", i);
 867             vlib_cli_output (vm, "  %U\n", format_page_map,
 868                              pointer_to_uword (mspace_least_addr (mspace)),
 869                              mi.arena);
 870             vlib_cli_output (vm, "  %U\n", format_mheap,
 871                              mm->per_numa_mheaps[index], verbose);
 872           }
 873       }
 874   }
 875   return 0;
 876 }
 877
 878 /* *INDENT-OFF* */
 879 VLIB_CLI_COMMAND (show_memory_usage_command, static) = {
 880   .path = "show memory",
 881   .short_help = "show memory [api-segment][stats-segment][verbose]\n"
 882   "            [numa-heaps]",
 883   .function = show_memory_usage,
 884 };
 885 /* *INDENT-ON* */
 886
 887 static clib_error_t *
 888 show_cpu (vlib_main_t * vm, unformat_input_t * input,
 889           vlib_cli_command_t * cmd)
 890 {
 891 #define _(a,b,c) vlib_cli_output (vm, "%-25s " b, a ":", c);
 892   _("Model name", "%U", format_cpu_model_name);
 893   _("Microarch model (family)", "%U", format_cpu_uarch);
 894   _("Flags", "%U", format_cpu_flags);
 895   _("Base frequency", "%.2f GHz",
 896     ((f64) vm->clib_time.clocks_per_second) * 1e-9);
 897 #undef _
 898   return 0;
 899 }
 900
 901 /*?
 902  * Displays various information about the CPU.
 903  *
 904  * @cliexpar
 905  * @cliexstart{show cpu}
 906  * Model name:               Intel(R) Xeon(R) CPU E5-2667 v4 @ 3.20GHz
 907  * Microarchitecture:        Broadwell (Broadwell-EP/EX)
 908  * Flags:                    sse3 ssse3 sse41 sse42 avx avx2 aes
 909  * Base Frequency:           3.20 GHz
 910  * @cliexend
 911 ?*/
 912 /* *INDENT-OFF* */
 913 VLIB_CLI_COMMAND (show_cpu_command, static) = {
 914   .path = "show cpu",
 915   .short_help = "Show cpu information",
 916   .function = show_cpu,
 917 };
 918 /* *INDENT-ON* */
 919
 920 static clib_error_t *
 921 enable_disable_memory_trace (vlib_main_t * vm,
 922                              unformat_input_t * input,
 923                              vlib_cli_command_t * cmd)
 924 {
 925   clib_mem_main_t *mm = &clib_mem_main;
 926   unformat_input_t _line_input, *line_input = &_line_input;
 927   int enable = 1;
 928   int api_segment = 0;
 929   int stats_segment = 0;
 930   int main_heap = 0;
 931   u32 numa_id = ~0;
 932   void *oldheap;
 933
 934   if (!unformat_user (input, unformat_line_input, line_input))
 935     return 0;
 936
 937   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 938     {
 939       if (unformat (line_input, "%U", unformat_vlib_enable_disable, &enable))
 940         ;
 941       else if (unformat (line_input, "api-segment"))
 942         api_segment = 1;
 943       else if (unformat (line_input, "stats-segment"))
 944         stats_segment = 1;
 945       else if (unformat (line_input, "main-heap"))
 946         main_heap = 1;
 947       else if (unformat (line_input, "numa-heap %d", &numa_id))
 948         ;
 949       else
 950         {
 951           unformat_free (line_input);
 952           return clib_error_return (0, "invalid input");
 953         }
 954     }
 955   unformat_free (line_input);
 956
 957   if ((api_segment + stats_segment + main_heap + (enable == 0)
 958        + (numa_id != ~0)) == 0)
 959     {
 960       return clib_error_return
 961         (0, "Need one of main-heap, stats-segment, api-segment,\n"
 962          "numa-heap <nn> or disable");
 963     }
 964
 965   /* Turn off current trace, if any */
 966   if (current_traced_heap)
 967     {
 968       void *oldheap;
 969       oldheap = clib_mem_set_heap (current_traced_heap);
 970       clib_mem_trace (0);
 971       clib_mem_set_heap (oldheap);
 972       current_traced_heap = 0;
 973     }
 974
 975   if (enable == 0)
 976     return 0;
 977
 978   /* API segment */
 979   if (api_segment)
 980     {
 981       oldheap = vl_msg_push_heap ();
 982       current_traced_heap = clib_mem_get_heap ();
 983       clib_mem_trace (1);
 984       vl_msg_pop_heap (oldheap);
 985
 986     }
 987
 988   /* Stats segment */
 989   if (stats_segment)
 990     {
 991       oldheap = vlib_stats_push_heap (0);
 992       current_traced_heap = clib_mem_get_heap ();
 993       clib_mem_trace (stats_segment);
 994       /* We don't want to call vlib_stats_pop_heap... */
 995       if (oldheap)
 996         clib_mem_set_heap (oldheap);
 997     }
 998
 999   /* main_heap */
1000   if (main_heap)
1001     {
1002       current_traced_heap = clib_mem_get_heap ();
1003       clib_mem_trace (main_heap);
1004     }
1005
1006   if (numa_id != ~0)
1007     {
1008       if (numa_id >= ARRAY_LEN (mm->per_numa_mheaps))
1009         return clib_error_return (0, "Numa %d out of range", numa_id);
1010       if (mm->per_numa_mheaps[numa_id] == 0)
1011         return clib_error_return (0, "Numa %d heap not active", numa_id);
1012
1013       if (mm->per_numa_mheaps[numa_id] == clib_mem_get_heap ())
1014         return clib_error_return (0, "Numa %d uses the main heap...",
1015                                   numa_id);
1016       current_traced_heap = mm->per_numa_mheaps[numa_id];
1017       oldheap = clib_mem_set_heap (current_traced_heap);
1018       clib_mem_trace (1);
1019       clib_mem_set_heap (oldheap);
1020     }
1021
1022
1023   return 0;
1024 }
1025
1026 /* *INDENT-OFF* */
1027 VLIB_CLI_COMMAND (enable_disable_memory_trace_command, static) = {
1028   .path = "memory-trace",
1029   .short_help = "memory-trace on|off [api-segment][stats-segment][main-heap]\n"
1030   "                   [numa-heap <numa-id>]\n",
1031   .function = enable_disable_memory_trace,
1032 };
1033 /* *INDENT-ON* */
1034
1035 static clib_error_t *
1036 restart_cmd_fn (vlib_main_t * vm, unformat_input_t * input,
1037                 vlib_cli_command_t * cmd)
1038 {
1039   clib_file_main_t *fm = &file_main;
1040   clib_file_t *f;
1041
1042   /* environ(7) does not indicate a header for this */
1043   extern char **environ;
1044
1045   /* Close all known open files */
1046   /* *INDENT-OFF* */
1047   pool_foreach(f, fm->file_pool,
1048     ({
1049       if (f->file_descriptor > 2)
1050         close(f->file_descriptor);
1051     }));
1052   /* *INDENT-ON* */
1053
1054   /* Exec ourself */
1055   execve (vm->name, (char **) vm->argv, environ);
1056
1057   return 0;
1058 }
1059
1060 /* *INDENT-OFF* */
1061 VLIB_CLI_COMMAND (restart_cmd,static) = {
1062     .path = "restart",
1063     .short_help = "restart process",
1064     .function = restart_cmd_fn,
1065 };
1066 /* *INDENT-ON* */
1067
1068 #ifdef TEST_CODE
1069 /*
1070  * A trivial test harness to verify the per-process output_function
1071  * is working correcty.
1072  */
1073
1074 static clib_error_t *
1075 sleep_ten_seconds (vlib_main_t * vm,
1076                    unformat_input_t * input, vlib_cli_command_t * cmd)
1077 {
1078   u16 i;
1079   u16 my_id = rand ();
1080
1081   vlib_cli_output (vm, "Starting 10 seconds sleep with id %u\n", my_id);
1082
1083   for (i = 0; i < 10; i++)
1084     {
1085       vlib_process_wait_for_event_or_clock (vm, 1.0);
1086       vlib_cli_output (vm, "Iteration number %u, my id: %u\n", i, my_id);
1087     }
1088   vlib_cli_output (vm, "Done with sleep with id %u\n", my_id);
1089   return 0;
1090 }
1091
1092 /* *INDENT-OFF* */
1093 VLIB_CLI_COMMAND (ping_command, static) = {
1094   .path = "test sleep",
1095   .function = sleep_ten_seconds,
1096   .short_help = "Sleep for 10 seconds",
1097 };
1098 /* *INDENT-ON* */
1099 #endif /* ifdef TEST_CODE */
1100
1101 static uword
1102 vlib_cli_normalize_path (char *input, char **result)
1103 {
1104   char *i = input;
1105   char *s = 0;
1106   uword l = 0;
1107   uword index_of_last_space = ~0;
1108
1109   while (*i != 0)
1110     {
1111       u8 c = *i++;
1112       /* Multiple white space -> single space. */
1113       switch (c)
1114         {
1115         case ' ':
1116         case '\t':
1117         case '\n':
1118         case '\r':
1119           if (l > 0 && s[l - 1] != ' ')
1120             {
1121               vec_add1 (s, ' ');
1122               l++;
1123             }
1124           break;
1125
1126         default:
1127           if (l > 0 && s[l - 1] == ' ')
1128             index_of_last_space = vec_len (s);
1129           vec_add1 (s, c);
1130           l++;
1131           break;
1132         }
1133     }
1134
1135   /* Remove any extra space at end. */
1136   if (l > 0 && s[l - 1] == ' ')
1137     _vec_len (s) -= 1;
1138
1139   *result = s;
1140   return index_of_last_space;
1141 }
1142
1143 always_inline uword
1144 parent_path_len (char *path)
1145 {
1146   word i;
1147   for (i = vec_len (path) - 1; i >= 0; i--)
1148     {
1149       if (path[i] == ' ')
1150         return i;
1151     }
1152   return ~0;
1153 }
1154
1155 static void
1156 add_sub_command (vlib_cli_main_t * cm, uword parent_index, uword child_index)
1157 {
1158   vlib_cli_command_t *p, *c;
1159   vlib_cli_sub_command_t *sub_c;
1160   u8 *sub_name;
1161   word i, l;
1162
1163   p = vec_elt_at_index (cm->commands, parent_index);
1164   c = vec_elt_at_index (cm->commands, child_index);
1165
1166   l = parent_path_len (c->path);
1167   if (l == ~0)
1168     sub_name = vec_dup ((u8 *) c->path);
1169   else
1170     {
1171       ASSERT (l + 1 < vec_len (c->path));
1172       sub_name = 0;
1173       vec_add (sub_name, c->path + l + 1, vec_len (c->path) - (l + 1));
1174     }
1175
1176   if (sub_name[0] == '%')
1177     {
1178       uword *q;
1179       vlib_cli_sub_rule_t *sr;
1180
1181       /* Remove %. */
1182       vec_delete (sub_name, 1, 0);
1183
1184       if (!p->sub_rule_index_by_name)
1185         p->sub_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1186                                                      sizeof (sub_name[0]),
1187                                                      sizeof (uword));
1188       q = hash_get_mem (p->sub_rule_index_by_name, sub_name);
1189       if (q)
1190         {
1191           sr = vec_elt_at_index (p->sub_rules, q[0]);
1192           ASSERT (sr->command_index == child_index);
1193           return;
1194         }
1195
1196       hash_set_mem (p->sub_rule_index_by_name, sub_name,
1197                     vec_len (p->sub_rules));
1198       vec_add2 (p->sub_rules, sr, 1);
1199       sr->name = sub_name;
1200       sr->rule_index = sr - p->sub_rules;
1201       sr->command_index = child_index;
1202       return;
1203     }
1204
1205   if (!p->sub_command_index_by_name)
1206     p->sub_command_index_by_name = hash_create_vec ( /* initial length */ 32,
1207                                                     sizeof (c->path[0]),
1208                                                     sizeof (uword));
1209
1210   /* Check if sub-command has already been created. */
1211   if (hash_get_mem (p->sub_command_index_by_name, sub_name))
1212     {
1213       vec_free (sub_name);
1214       return;
1215     }
1216
1217   vec_add2 (p->sub_commands, sub_c, 1);
1218   sub_c->index = child_index;
1219   sub_c->name = sub_name;
1220   hash_set_mem (p->sub_command_index_by_name, sub_c->name,
1221                 sub_c - p->sub_commands);
1222
1223   vec_validate (p->sub_command_positions, vec_len (sub_c->name) - 1);
1224   for (i = 0; i < vec_len (sub_c->name); i++)
1225     {
1226       int n;
1227       vlib_cli_parse_position_t *pos;
1228
1229       pos = vec_elt_at_index (p->sub_command_positions, i);
1230
1231       if (!pos->bitmaps)
1232         pos->min_char = sub_c->name[i];
1233
1234       n = sub_c->name[i] - pos->min_char;
1235       if (n < 0)
1236         {
1237           pos->min_char = sub_c->name[i];
1238           vec_insert (pos->bitmaps, -n, 0);
1239           n = 0;
1240         }
1241
1242       vec_validate (pos->bitmaps, n);
1243       pos->bitmaps[n] =
1244         clib_bitmap_ori (pos->bitmaps[n], sub_c - p->sub_commands);
1245     }
1246 }
1247
1248 static void
1249 vlib_cli_make_parent (vlib_cli_main_t * cm, uword ci)
1250 {
1251   uword p_len, pi, *p;
1252   char *p_path;
1253   vlib_cli_command_t *c, *parent;
1254
1255   /* Root command (index 0) should have already been added. */
1256   ASSERT (vec_len (cm->commands) > 0);
1257
1258   c = vec_elt_at_index (cm->commands, ci);
1259   p_len = parent_path_len (c->path);
1260
1261   /* No space?  Parent is root command. */
1262   if (p_len == ~0)
1263     {
1264       add_sub_command (cm, 0, ci);
1265       return;
1266     }
1267
1268   p_path = 0;
1269   vec_add (p_path, c->path, p_len);
1270
1271   p = hash_get_mem (cm->command_index_by_path, p_path);
1272
1273   /* Parent exists? */
1274   if (!p)
1275     {
1276       /* Parent does not exist; create it. */
1277       vec_add2 (cm->commands, parent, 1);
1278       parent->path = p_path;
1279       hash_set_mem (cm->command_index_by_path, parent->path,
1280                     parent - cm->commands);
1281       pi = parent - cm->commands;
1282     }
1283   else
1284     {
1285       pi = p[0];
1286       vec_free (p_path);
1287     }
1288
1289   add_sub_command (cm, pi, ci);
1290
1291   /* Create parent's parent. */
1292   if (!p)
1293     vlib_cli_make_parent (cm, pi);
1294 }
1295
1296 always_inline uword
1297 vlib_cli_command_is_empty (vlib_cli_command_t * c)
1298 {
1299   return (c->long_help == 0 && c->short_help == 0 && c->function == 0);
1300 }
1301
1302 clib_error_t *
1303 vlib_cli_register (vlib_main_t * vm, vlib_cli_command_t * c)
1304 {
1305   vlib_cli_main_t *cm = &vm->cli_main;
1306   clib_error_t *error = 0;
1307   uword ci, *p;
1308   char *normalized_path;
1309
1310   if ((error = vlib_call_init_function (vm, vlib_cli_init)))
1311     return error;
1312
1313   (void) vlib_cli_normalize_path (c->path, &normalized_path);
1314
1315   if (!cm->command_index_by_path)
1316     cm->command_index_by_path = hash_create_vec ( /* initial length */ 32,
1317                                                  sizeof (c->path[0]),
1318                                                  sizeof (uword));
1319
1320   /* See if command already exists with given path. */
1321   p = hash_get_mem (cm->command_index_by_path, normalized_path);
1322   if (p)
1323     {
1324       vlib_cli_command_t *d;
1325
1326       ci = p[0];
1327       d = vec_elt_at_index (cm->commands, ci);
1328
1329       /* If existing command was created via vlib_cli_make_parent
1330          replaced it with callers data. */
1331       if (vlib_cli_command_is_empty (d))
1332         {
1333           vlib_cli_command_t save = d[0];
1334
1335           ASSERT (!vlib_cli_command_is_empty (c));
1336
1337           /* Copy callers fields. */
1338           d[0] = c[0];
1339
1340           /* Save internal fields. */
1341           d->path = save.path;
1342           d->sub_commands = save.sub_commands;
1343           d->sub_command_index_by_name = save.sub_command_index_by_name;
1344           d->sub_command_positions = save.sub_command_positions;
1345           d->sub_rules = save.sub_rules;
1346         }
1347       else
1348         error =
1349           clib_error_return (0, "duplicate command name with path %v",
1350                              normalized_path);
1351
1352       vec_free (normalized_path);
1353       if (error)
1354         return error;
1355     }
1356   else
1357     {
1358       /* Command does not exist: create it. */
1359
1360       /* Add root command (index 0). */
1361       if (vec_len (cm->commands) == 0)
1362         {
1363           /* Create command with index 0; path is empty string. */
1364           vec_resize (cm->commands, 1);
1365         }
1366
1367       ci = vec_len (cm->commands);
1368       hash_set_mem (cm->command_index_by_path, normalized_path, ci);
1369       vec_add1 (cm->commands, c[0]);
1370
1371       c = vec_elt_at_index (cm->commands, ci);
1372       c->path = normalized_path;
1373
1374       /* Don't inherit from registration. */
1375       c->sub_commands = 0;
1376       c->sub_command_index_by_name = 0;
1377       c->sub_command_positions = 0;
1378     }
1379
1380   vlib_cli_make_parent (cm, ci);
1381   return 0;
1382 }
1383
1384 #if 0
1385 /* $$$ turn back on again someday, maybe */
1386 clib_error_t *
1387 vlib_cli_register_parse_rule (vlib_main_t * vm, vlib_cli_parse_rule_t * r_reg)
1388 {
1389   vlib_cli_main_t *cm = &vm->cli_main;
1390   vlib_cli_parse_rule_t *r;
1391   clib_error_t *error = 0;
1392   u8 *r_name;
1393   uword *p;
1394
1395   if (!cm->parse_rule_index_by_name)
1396     cm->parse_rule_index_by_name = hash_create_vec ( /* initial length */ 32,
1397                                                     sizeof (r->name[0]),
1398                                                     sizeof (uword));
1399
1400   /* Make vector copy of name. */
1401   r_name = format (0, "%s", r_reg->name);
1402
1403   if ((p = hash_get_mem (cm->parse_rule_index_by_name, r_name)))
1404     {
1405       vec_free (r_name);
1406       return clib_error_return (0, "duplicate parse rule name `%s'",
1407                                 r_reg->name);
1408     }
1409
1410   vec_add2 (cm->parse_rules, r, 1);
1411   r[0] = r_reg[0];
1412   r->name = (char *) r_name;
1413   hash_set_mem (cm->parse_rule_index_by_name, r->name, r - cm->parse_rules);
1414
1415   return error;
1416 }
1417
1418 static clib_error_t *vlib_cli_register_parse_rules (vlib_main_t * vm,
1419                                                     vlib_cli_parse_rule_t *
1420                                                     lo,
1421                                                     vlib_cli_parse_rule_t *
1422                                                     hi)
1423   __attribute__ ((unused))
1424 {
1425   clib_error_t *error = 0;
1426   vlib_cli_parse_rule_t *r;
1427
1428   for (r = lo; r < hi; r = clib_elf_section_data_next (r, 0))
1429     {
1430       if (!r->name || strlen (r->name) == 0)
1431         {
1432           error = clib_error_return (0, "parse rule with no name");
1433           goto done;
1434         }
1435
1436       error = vlib_cli_register_parse_rule (vm, r);
1437       if (error)
1438         goto done;
1439     }
1440
1441 done:
1442   return error;
1443 }
1444 #endif
1445
1446 static clib_error_t *
1447 elog_trace_command_fn (vlib_main_t * vm,
1448                        unformat_input_t * input, vlib_cli_command_t * cmd)
1449 {
1450   unformat_input_t _line_input, *line_input = &_line_input;
1451   int enable = 1;
1452   int api = 0, cli = 0, barrier = 0, dispatch = 0, circuit = 0;
1453   u32 circuit_node_index;
1454
1455   if (!unformat_user (input, unformat_line_input, line_input))
1456     goto print_status;
1457
1458   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1459     {
1460       if (unformat (line_input, "api"))
1461         api = 1;
1462       else if (unformat (line_input, "dispatch"))
1463         dispatch = 1;
1464       else if (unformat (line_input, "circuit-node %U",
1465                          unformat_vlib_node, vm, &circuit_node_index))
1466         circuit = 1;
1467       else if (unformat (line_input, "cli"))
1468         cli = 1;
1469       else if (unformat (line_input, "barrier"))
1470         barrier = 1;
1471       else if (unformat (line_input, "disable"))
1472         enable = 0;
1473       else if (unformat (line_input, "enable"))
1474         enable = 1;
1475       else
1476         break;
1477     }
1478   unformat_free (line_input);
1479
1480   vl_api_set_elog_trace_api_messages
1481     (api ? enable : vl_api_get_elog_trace_api_messages ());
1482   vm->elog_trace_cli_commands = cli ? enable : vm->elog_trace_cli_commands;
1483   vm->elog_trace_graph_dispatch = dispatch ?
1484     enable : vm->elog_trace_graph_dispatch;
1485   vm->elog_trace_graph_circuit = circuit ?
1486     enable : vm->elog_trace_graph_circuit;
1487   vlib_worker_threads->barrier_elog_enabled =
1488     barrier ? enable : vlib_worker_threads->barrier_elog_enabled;
1489   vm->elog_trace_graph_circuit_node_index = circuit_node_index;
1490
1491   /*
1492    * Set up start-of-buffer logic-analyzer trigger
1493    * for main loop event logs, which are fairly heavyweight.
1494    * See src/vlib/main/vlib_elog_main_loop_event(...), which
1495    * will fully disable the scheme when the elog buffer fills.
1496    */
1497   if (dispatch || circuit)
1498     {
1499       elog_main_t *em = &vm->elog_main;
1500
1501       em->n_total_events_disable_limit =
1502         em->n_total_events + vec_len (em->event_ring);
1503     }
1504
1505
1506 print_status:
1507   vlib_cli_output (vm, "Current status:");
1508
1509   vlib_cli_output
1510     (vm, "    Event log API message trace: %s\n    CLI command trace: %s",
1511      vl_api_get_elog_trace_api_messages ()? "on" : "off",
1512      vm->elog_trace_cli_commands ? "on" : "off");
1513   vlib_cli_output
1514     (vm, "    Barrier sync trace: %s",
1515      vlib_worker_threads->barrier_elog_enabled ? "on" : "off");
1516   vlib_cli_output
1517     (vm, "    Graph Dispatch: %s",
1518      vm->elog_trace_graph_dispatch ? "on" : "off");
1519   vlib_cli_output
1520     (vm, "    Graph Circuit: %s",
1521      vm->elog_trace_graph_circuit ? "on" : "off");
1522   if (vm->elog_trace_graph_circuit)
1523     vlib_cli_output
1524       (vm, "                   node %U",
1525        format_vlib_node_name, vm, vm->elog_trace_graph_circuit_node_index);
1526
1527   return 0;
1528 }
1529
1530 /*?
1531  * Control event logging of api, cli, and thread barrier events
1532  * With no arguments, displays the current trace status.
1533  * Name the event groups you wish to trace or stop tracing.
1534  *
1535  * @cliexpar
1536  * @clistart
1537  * elog trace api cli barrier
1538  * elog trace api cli barrier disable
1539  * elog trace dispatch
1540  * elog trace circuit-node ethernet-input
1541  * elog trace
1542  * @cliend
1543  * @cliexcmd{elog trace [api][cli][barrier][disable]}
1544 ?*/
1545 /* *INDENT-OFF* */
1546 VLIB_CLI_COMMAND (elog_trace_command, static) =
1547 {
1548   .path = "elog trace",
1549   .short_help = "elog trace [api][cli][barrier][dispatch]\n"
1550   "[circuit-node <name> e.g. ethernet-input][disable]",
1551   .function = elog_trace_command_fn,
1552 };
1553 /* *INDENT-ON* */
1554
1555 static clib_error_t *
1556 suspend_command_fn (vlib_main_t * vm,
1557                     unformat_input_t * input, vlib_cli_command_t * cmd)
1558 {
1559   vlib_process_suspend (vm, 30e-3);
1560   return 0;
1561 }
1562
1563 /* *INDENT-OFF* */
1564 VLIB_CLI_COMMAND (suspend_command, static) =
1565 {
1566   .path = "suspend",
1567   .short_help = "suspend debug CLI for 30ms",
1568   .function = suspend_command_fn,
1569   .is_mp_safe = 1,
1570 };
1571 /* *INDENT-ON* */
1572
1573
1574 static int
1575 sort_cmds_by_path (void *a1, void *a2)
1576 {
1577   u32 *index1 = a1;
1578   u32 *index2 = a2;
1579   vlib_main_t *vm = vlib_get_main ();
1580   vlib_cli_main_t *cm = &vm->cli_main;
1581   vlib_cli_command_t *c1, *c2;
1582   int i, lmin;
1583
1584   c1 = vec_elt_at_index (cm->commands, *index1);
1585   c2 = vec_elt_at_index (cm->commands, *index2);
1586
1587   lmin = vec_len (c1->path);
1588   lmin = (vec_len (c2->path) >= lmin) ? lmin : vec_len (c2->path);
1589
1590   for (i = 0; i < lmin; i++)
1591     {
1592       if (c1->path[i] < c2->path[i])
1593         return -1;
1594       else if (c1->path[i] > c2->path[i])
1595         return 1;
1596     }
1597
1598   return 0;
1599 }
1600
1601 typedef struct
1602 {
1603   vlib_cli_main_t *cm;
1604   u32 parent_command_index;
1605   int show_mp_safe;
1606   int show_not_mp_safe;
1607   int show_hit;
1608   int clear_hit;
1609 } vlib_cli_walk_args_t;
1610
1611 static void
1612 cli_recursive_walk (vlib_cli_walk_args_t * aa)
1613 {
1614   vlib_cli_command_t *parent;
1615   vlib_cli_sub_command_t *sub;
1616   vlib_cli_walk_args_t _a, *a = &_a;
1617   vlib_cli_main_t *cm;
1618   int i;
1619
1620   /* Copy args into this stack frame */
1621   *a = *aa;
1622   cm = a->cm;
1623
1624   parent = vec_elt_at_index (cm->commands, a->parent_command_index);
1625
1626   if (parent->function)
1627     {
1628       if (((a->show_mp_safe && parent->is_mp_safe)
1629            || (a->show_not_mp_safe && !parent->is_mp_safe))
1630           && (a->show_hit == 0 || parent->hit_counter))
1631         {
1632           vec_add1 (cm->sort_vector, a->parent_command_index);
1633         }
1634
1635       if (a->clear_hit)
1636         parent->hit_counter = 0;
1637     }
1638
1639   for (i = 0; i < vec_len (parent->sub_commands); i++)
1640     {
1641       sub = vec_elt_at_index (parent->sub_commands, i);
1642       a->parent_command_index = sub->index;
1643       cli_recursive_walk (a);
1644     }
1645 }
1646
1647 static u8 *
1648 format_mp_safe (u8 * s, va_list * args)
1649 {
1650   vlib_cli_main_t *cm = va_arg (*args, vlib_cli_main_t *);
1651   int show_mp_safe = va_arg (*args, int);
1652   int show_not_mp_safe = va_arg (*args, int);
1653   int show_hit = va_arg (*args, int);
1654   int clear_hit = va_arg (*args, int);
1655   vlib_cli_command_t *c;
1656   vlib_cli_walk_args_t _a, *a = &_a;
1657   int i;
1658   char *format_string = "\n%v";
1659
1660   if (show_hit)
1661     format_string = "\n%v: %u";
1662
1663   vec_reset_length (cm->sort_vector);
1664
1665   a->cm = cm;
1666   a->parent_command_index = 0;
1667   a->show_mp_safe = show_mp_safe;
1668   a->show_not_mp_safe = show_not_mp_safe;
1669   a->show_hit = show_hit;
1670   a->clear_hit = clear_hit;
1671
1672   cli_recursive_walk (a);
1673
1674   vec_sort_with_function (cm->sort_vector, sort_cmds_by_path);
1675
1676   for (i = 0; i < vec_len (cm->sort_vector); i++)
1677     {
1678       c = vec_elt_at_index (cm->commands, cm->sort_vector[i]);
1679       s = format (s, format_string, c->path, c->hit_counter);
1680     }
1681
1682   return s;
1683 }
1684
1685
1686 static clib_error_t *
1687 show_cli_command_fn (vlib_main_t * vm,
1688                      unformat_input_t * input, vlib_cli_command_t * cmd)
1689 {
1690   int show_mp_safe = 0;
1691   int show_not_mp_safe = 0;
1692   int show_hit = 0;
1693   int clear_hit = 0;
1694
1695   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1696     {
1697       if (unformat (input, "mp-safe"))
1698         show_mp_safe = 1;
1699       if (unformat (input, "not-mp-safe"))
1700         show_not_mp_safe = 1;
1701       else if (unformat (input, "hit"))
1702         show_hit = 1;
1703       else if (unformat (input, "clear-hit"))
1704         clear_hit = 1;
1705       else
1706         break;
1707     }
1708
1709   /* default set: all cli commands */
1710   if (clear_hit == 0 && (show_mp_safe + show_not_mp_safe) == 0)
1711     show_mp_safe = show_not_mp_safe = 1;
1712
1713   vlib_cli_output (vm, "%U", format_mp_safe, &vm->cli_main,
1714                    show_mp_safe, show_not_mp_safe, show_hit, clear_hit);
1715   if (clear_hit)
1716     vlib_cli_output (vm, "hit counters cleared...");
1717
1718   return 0;
1719 }
1720
1721 /*?
1722  * Displays debug cli command information
1723  *
1724  * @cliexpar
1725  * @cliexstart{show cli [mp-safe][not-mp-safe][hit][clear-hit]}
1726  *
1727  * "show cli" displays the entire debug cli:
1728  *
1729  * abf attach
1730  * abf policy
1731  * adjacency counters
1732  * api trace
1733  * app ns
1734  * bfd key del
1735  * ... and so on ...
1736  *
1737  * "show cli mp-safe" displays mp-safe debug CLI commands:
1738  *
1739  * abf policy
1740  * binary-api
1741  * create vhost-user
1742  * exec
1743  * ip container
1744  * ip mroute
1745  * ip probe-neighbor
1746  * ip route
1747  * ip scan-neighbor
1748  * ip table
1749  * ip6 table
1750  *
1751  * "show cli not-mp-safe" displays debug CLI commands
1752  * which cause worker thread barrier synchronization
1753  *
1754  * "show cli hit" displays commands which have been executed. Qualify
1755  * as desired with "mp-safe" or "not-mp-safe".
1756  *
1757  * "show cli clear-hit" clears the per-command hit counters.
1758  * @cliexend
1759 ?*/
1760
1761 /* *INDENT-OFF* */
1762 VLIB_CLI_COMMAND (show_cli_command, static) =
1763 {
1764   .path = "show cli",
1765   .short_help = "show cli [mp-safe][not-mp-safe][hit][clear-hit]",
1766   .function = show_cli_command_fn,
1767   .is_mp_safe = 1,
1768 };
1769 /* *INDENT-ON* */
1770
1771 static clib_error_t *
1772 vlib_cli_init (vlib_main_t * vm)
1773 {
1774   vlib_cli_main_t *cm = &vm->cli_main;
1775   clib_error_t *error = 0;
1776   vlib_cli_command_t *cmd;
1777
1778   cmd = cm->cli_command_registrations;
1779
1780   while (cmd)
1781     {
1782       error = vlib_cli_register (vm, cmd);
1783       if (error)
1784         return error;
1785       cmd = cmd->next_cli_command;
1786     }
1787   return error;
1788 }
1789
1790 VLIB_INIT_FUNCTION (vlib_cli_init);
1791
1792 /*
1793  * fd.io coding-style-patch-verification: ON
1794  *
1795  * Local Variables:
1796  * eval: (c-set-style "gnu")
1797  * End:
1798  */