src/vlib/unix/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: Unix stdin/socket CLI.
  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  * @file
  41  * @brief Unix stdin/socket command line interface.
  42  * Provides a command line interface so humans can interact with VPP.
  43  * This is predominantly a debugging and testing mechanism.
  44  */
  45 /*? %%clicmd:group_label Command line session %% ?*/
  46 /*? %%syscfg:group_label Command line session %% ?*/
  47
  48 #include <vlib/vlib.h>
  49 #include <vlib/unix/unix.h>
  50
  51 #include <ctype.h>
  52 #include <fcntl.h>
  53 #include <sys/stat.h>
  54 #include <termios.h>
  55 #include <signal.h>
  56 #include <unistd.h>
  57 #include <arpa/telnet.h>
  58 #include <sys/ioctl.h>
  59 #include <sys/types.h>
  60 #include <unistd.h>
  61 #include <limits.h>
  62 #include <netinet/tcp.h>
  63 #include <math.h>
  64 #include <vppinfra/macros.h>
  65
  66 /** ANSI escape code. */
  67 #define ESC "\x1b"
  68
  69 /** ANSI Control Sequence Introducer. */
  70 #define CSI ESC "["
  71
  72 /** ANSI clear screen. */
  73 #define ANSI_CLEAR      CSI "2J" CSI "1;1H"
  74 /** ANSI reset color settings. */
  75 #define ANSI_RESET      CSI "0m"
  76 /** ANSI Start bold text. */
  77 #define ANSI_BOLD       CSI "1m"
  78 /** ANSI Stop bold text. */
  79 #define ANSI_DIM        CSI "2m"
  80 /** ANSI Start dark red text. */
  81 #define ANSI_DRED       ANSI_DIM CSI "31m"
  82 /** ANSI Start bright red text. */
  83 #define ANSI_BRED       ANSI_BOLD CSI "31m"
  84 /** ANSI clear line cursor is on. */
  85 #define ANSI_CLEARLINE  CSI "2K"
  86 /** ANSI scroll screen down one line. */
  87 #define ANSI_SCROLLDN   CSI "1T"
  88 /** ANSI save cursor position. */
  89 #define ANSI_SAVECURSOR CSI "s"
  90 /** ANSI restore cursor position if previously saved. */
  91 #define ANSI_RESTCURSOR CSI "u"
  92
  93 /** Maximum depth into a byte stream from which to compile a Telnet
  94  * protocol message. This is a safety measure. */
  95 #define UNIX_CLI_MAX_DEPTH_TELNET 32
  96
  97 /** Maximum terminal width we will accept */
  98 #define UNIX_CLI_MAX_TERMINAL_WIDTH 512
  99 /** Maximum terminal height we will accept */
 100 #define UNIX_CLI_MAX_TERMINAL_HEIGHT 512
 101 /** Default terminal height */
 102 #define UNIX_CLI_DEFAULT_TERMINAL_HEIGHT 24
 103 /** Default terminal width */
 104 #define UNIX_CLI_DEFAULT_TERMINAL_WIDTH 80
 105
 106 /** A CLI banner line. */
 107 typedef struct
 108 {
 109   u8 *line;     /**< The line to print. */
 110   u32 length;   /**< The length of the line without terminating NUL. */
 111 } unix_cli_banner_t;
 112
 113 #define _(a) { .line = (u8 *)(a), .length = sizeof(a) - 1 }
 114 /** Plain welcome banner. */
 115 static unix_cli_banner_t unix_cli_banner[] = {
 116   _("    _______    _        _   _____  ___ \n"),
 117   _(" __/ __/ _ \\  (_)__    | | / / _ \\/ _ \\\n"),
 118   _(" _/ _// // / / / _ \\   | |/ / ___/ ___/\n"),
 119   _(" /_/ /____(_)_/\\___/   |___/_/  /_/    \n"),
 120   _("\n")
 121 };
 122
 123 /** ANSI color welcome banner. */
 124 static unix_cli_banner_t unix_cli_banner_color[] = {
 125   _(ANSI_BRED "    _______    _     " ANSI_RESET "   _   _____  ___ \n"),
 126   _(ANSI_BRED " __/ __/ _ \\  (_)__ " ANSI_RESET "   | | / / _ \\/ _ \\\n"),
 127   _(ANSI_BRED " _/ _// // / / / _ \\" ANSI_RESET "   | |/ / ___/ ___/\n"),
 128   _(ANSI_BRED " /_/ /____(_)_/\\___/" ANSI_RESET "   |___/_/  /_/    \n"),
 129   _("\n")
 130 };
 131
 132 #undef _
 133
 134 /** Pager line index */
 135 typedef struct
 136 {
 137   /** Index into pager_vector */
 138   u32 line;
 139
 140   /** Offset of the string in the line */
 141   u32 offset;
 142
 143   /** Length of the string in the line */
 144   u32 length;
 145 } unix_cli_pager_index_t;
 146
 147
 148 /** Unix CLI session. */
 149 typedef struct
 150 {
 151   /** The file index held by unix.c */
 152   u32 clib_file_index;
 153
 154   /** Vector of output pending write to file descriptor. */
 155   u8 *output_vector;
 156
 157   /** Vector of input saved by Unix input node to be processed by
 158      CLI process. */
 159   u8 *input_vector;
 160
 161   /** This session has command history. */
 162   u8 has_history;
 163   /** Array of vectors of commands in the history. */
 164   u8 **command_history;
 165   /** The command currently pointed at by the history cursor. */
 166   u8 *current_command;
 167   /** How far from the end of the history array the user has browsed. */
 168   i32 excursion;
 169
 170   /** Maximum number of history entries this session will store. */
 171   u32 history_limit;
 172
 173   /** Current command line counter */
 174   u32 command_number;
 175
 176   /** The string being searched for in the history. */
 177   u8 *search_key;
 178   /** If non-zero then the CLI is searching in the history array.
 179    * - @c -1 means search backwards.
 180    * - @c 1 means search forwards.
 181    */
 182   int search_mode;
 183
 184   /** Position of the insert cursor on the current input line */
 185   u32 cursor;
 186
 187   /** Line mode or char mode */
 188   u8 line_mode;
 189
 190   /** Set if the CRLF mode wants CR + LF */
 191   u8 crlf_mode;
 192
 193   /** Can we do ANSI output? */
 194   u8 ansi_capable;
 195
 196   /** Has the session started? */
 197   u8 started;
 198
 199   /** Disable the pager? */
 200   u8 no_pager;
 201
 202   /** Whether the session is interactive or not.
 203    * Controls things like initial banner, the CLI prompt etc.  */
 204   u8 is_interactive;
 205
 206   /** Whether the session is attached to a socket. */
 207   u8 is_socket;
 208
 209   /** If EPIPE has been detected, prevent further write-related
 210    * activity on the descriptor.
 211    */
 212   u8 has_epipe;
 213
 214   /** Pager buffer */
 215   u8 **pager_vector;
 216
 217   /** Index of line fragments in the pager buffer */
 218   unix_cli_pager_index_t *pager_index;
 219
 220   /** Line number of top of page */
 221   u32 pager_start;
 222
 223   /** Terminal width */
 224   u32 width;
 225
 226   /** Terminal height */
 227   u32 height;
 228
 229   /** Process node identifier */
 230   u32 process_node_index;
 231
 232   /** The current direction of cursor travel.
 233    *  This is important since when advancing left-to-right, at the
 234    *  right hand edge of the console the terminal typically defers
 235    *  wrapping the cursor to the next line until a character is
 236    *  actually displayed.
 237    *  This messes up our heuristic for whether to use ANSI to return
 238    *  the cursor to the end of the line and instead we have to
 239    *  nudge the cursor to the next line.
 240    *  A Value of @c 0 means we're advancing left-to-right; @c 1 means
 241    *  the opposite.
 242    */
 243   u8 cursor_direction;
 244
 245   /** Macro tables for this session */
 246   clib_macro_main_t macro_main;
 247 } unix_cli_file_t;
 248
 249 /** Resets the pager buffer and other data.
 250  * @param f The CLI session whose pager needs to be reset.
 251  */
 252 always_inline void
 253 unix_cli_pager_reset (unix_cli_file_t * f)
 254 {
 255   u8 **p;
 256
 257   f->pager_start = 0;
 258
 259   vec_free (f->pager_index);
 260   f->pager_index = 0;
 261
 262   vec_foreach (p, f->pager_vector)
 263   {
 264     vec_free (*p);
 265   }
 266   vec_free (f->pager_vector);
 267   f->pager_vector = 0;
 268 }
 269
 270 /** Release storage used by a CLI session.
 271  * @param f The CLI session whose storage needs to be released.
 272  */
 273 always_inline void
 274 unix_cli_file_free (unix_cli_file_t * f)
 275 {
 276   vec_free (f->output_vector);
 277   vec_free (f->input_vector);
 278   unix_cli_pager_reset (f);
 279 }
 280
 281 /** CLI actions */
 282 typedef enum
 283 {
 284   UNIX_CLI_PARSE_ACTION_NOACTION = 0,   /**< No action */
 285   UNIX_CLI_PARSE_ACTION_CRLF,           /**< Carriage return, newline or enter */
 286   UNIX_CLI_PARSE_ACTION_TAB,            /**< Tab key */
 287   UNIX_CLI_PARSE_ACTION_ERASE,          /**< Erase cursor left */
 288   UNIX_CLI_PARSE_ACTION_ERASERIGHT,     /**< Erase cursor right */
 289   UNIX_CLI_PARSE_ACTION_UP,             /**< Up arrow */
 290   UNIX_CLI_PARSE_ACTION_DOWN,           /**< Down arrow */
 291   UNIX_CLI_PARSE_ACTION_LEFT,           /**< Left arrow */
 292   UNIX_CLI_PARSE_ACTION_RIGHT,          /**< Right arrow */
 293   UNIX_CLI_PARSE_ACTION_HOME,           /**< Home key (jump to start of line) */
 294   UNIX_CLI_PARSE_ACTION_END,            /**< End key (jump to end of line) */
 295   UNIX_CLI_PARSE_ACTION_WORDLEFT,       /**< Jump cursor to start of left word */
 296   UNIX_CLI_PARSE_ACTION_WORDRIGHT,      /**< Jump cursor to start of right word */
 297   UNIX_CLI_PARSE_ACTION_ERASELINELEFT,  /**< Erase line to left of cursor */
 298   UNIX_CLI_PARSE_ACTION_ERASELINERIGHT, /**< Erase line to right & including cursor */
 299   UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT,  /**< Erase word left */
 300   UNIX_CLI_PARSE_ACTION_CLEAR,          /**< Clear the terminal */
 301   UNIX_CLI_PARSE_ACTION_REVSEARCH,      /**< Search backwards in command history */
 302   UNIX_CLI_PARSE_ACTION_FWDSEARCH,      /**< Search forwards in command history */
 303   UNIX_CLI_PARSE_ACTION_YANK,           /**< Undo last erase action */
 304   UNIX_CLI_PARSE_ACTION_TELNETIAC,      /**< Telnet control code */
 305
 306   UNIX_CLI_PARSE_ACTION_PAGER_CRLF,     /**< Enter pressed (CR, CRLF, LF, etc) */
 307   UNIX_CLI_PARSE_ACTION_PAGER_QUIT,     /**< Exit the pager session */
 308   UNIX_CLI_PARSE_ACTION_PAGER_NEXT,     /**< Scroll to next page */
 309   UNIX_CLI_PARSE_ACTION_PAGER_DN,       /**< Scroll to next line */
 310   UNIX_CLI_PARSE_ACTION_PAGER_UP,       /**< Scroll to previous line */
 311   UNIX_CLI_PARSE_ACTION_PAGER_TOP,      /**< Scroll to first line */
 312   UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM,   /**< Scroll to last line */
 313   UNIX_CLI_PARSE_ACTION_PAGER_PGDN,     /**< Scroll to next page */
 314   UNIX_CLI_PARSE_ACTION_PAGER_PGUP,     /**< Scroll to previous page */
 315   UNIX_CLI_PARSE_ACTION_PAGER_REDRAW,   /**< Clear and redraw the page on the terminal */
 316   UNIX_CLI_PARSE_ACTION_PAGER_SEARCH,   /**< Search the pager buffer */
 317
 318   UNIX_CLI_PARSE_ACTION_PARTIALMATCH,   /**< Action parser found a partial match */
 319   UNIX_CLI_PARSE_ACTION_NOMATCH         /**< Action parser did not find any match */
 320 } unix_cli_parse_action_t;
 321
 322 /** @brief Mapping of input buffer strings to action values.
 323  * @note This won't work as a hash since we need to be able to do
 324  *       partial matches on the string.
 325  */
 326 typedef struct
 327 {
 328   u8 *input;                        /**< Input string to match. */
 329   u32 len;                          /**< Length of input without final NUL. */
 330   unix_cli_parse_action_t action;   /**< Action to take when matched. */
 331 } unix_cli_parse_actions_t;
 332
 333 /** @brief Given a capital ASCII letter character return a @c NUL terminated
 334  * string with the control code for that letter.
 335  *
 336  * @param c An ASCII character.
 337  * @return A @c NUL terminated string of type @c u8[].
 338  *
 339  * @par Example
 340  *     @c CTL('A') returns <code>{ 0x01, 0x00 }</code> as a @c u8[].
 341  */
 342 #define CTL(c) (u8[]){ (c) - '@', 0 }
 343
 344 #define _(a,b) { .input = (u8 *)(a), .len = sizeof(a) - 1, .action = (b) }
 345 /**
 346  * Patterns to match on a CLI input stream.
 347  * @showinitializer
 348  */
 349 static unix_cli_parse_actions_t unix_cli_parse_strings[] = {
 350   /* Line handling */
 351   _("\r\n", UNIX_CLI_PARSE_ACTION_CRLF),        /* Must be before '\r' */
 352   _("\n", UNIX_CLI_PARSE_ACTION_CRLF),
 353   _("\r\0", UNIX_CLI_PARSE_ACTION_CRLF),        /* Telnet does this */
 354   _("\r", UNIX_CLI_PARSE_ACTION_CRLF),
 355
 356   /* Unix shell control codes */
 357   _(CTL ('B'), UNIX_CLI_PARSE_ACTION_LEFT),
 358   _(CTL ('F'), UNIX_CLI_PARSE_ACTION_RIGHT),
 359   _(CTL ('P'), UNIX_CLI_PARSE_ACTION_UP),
 360   _(CTL ('N'), UNIX_CLI_PARSE_ACTION_DOWN),
 361   _(CTL ('A'), UNIX_CLI_PARSE_ACTION_HOME),
 362   _(CTL ('E'), UNIX_CLI_PARSE_ACTION_END),
 363   _(CTL ('D'), UNIX_CLI_PARSE_ACTION_ERASERIGHT),
 364   _(CTL ('U'), UNIX_CLI_PARSE_ACTION_ERASELINELEFT),
 365   _(CTL ('K'), UNIX_CLI_PARSE_ACTION_ERASELINERIGHT),
 366   _(CTL ('W'), UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT),
 367   _(CTL ('Y'), UNIX_CLI_PARSE_ACTION_YANK),
 368   _(CTL ('L'), UNIX_CLI_PARSE_ACTION_CLEAR),
 369   _(ESC "b", UNIX_CLI_PARSE_ACTION_WORDLEFT),   /* Alt-B */
 370   _(ESC "f", UNIX_CLI_PARSE_ACTION_WORDRIGHT),  /* Alt-F */
 371   _("\b", UNIX_CLI_PARSE_ACTION_ERASE), /* ^H */
 372   _("\x7f", UNIX_CLI_PARSE_ACTION_ERASE),       /* Backspace */
 373   _("\t", UNIX_CLI_PARSE_ACTION_TAB),   /* ^I */
 374
 375   /* VT100 Normal mode - Broadest support */
 376   _(CSI "A", UNIX_CLI_PARSE_ACTION_UP),
 377   _(CSI "B", UNIX_CLI_PARSE_ACTION_DOWN),
 378   _(CSI "C", UNIX_CLI_PARSE_ACTION_RIGHT),
 379   _(CSI "D", UNIX_CLI_PARSE_ACTION_LEFT),
 380   _(CSI "H", UNIX_CLI_PARSE_ACTION_HOME),
 381   _(CSI "F", UNIX_CLI_PARSE_ACTION_END),
 382   _(CSI "3~", UNIX_CLI_PARSE_ACTION_ERASERIGHT),        /* Delete */
 383   _(CSI "1;5D", UNIX_CLI_PARSE_ACTION_WORDLEFT),        /* C-Left */
 384   _(CSI "1;5C", UNIX_CLI_PARSE_ACTION_WORDRIGHT),       /* C-Right */
 385
 386   /* VT100 Application mode - Some Gnome Terminal functions use these */
 387   _(ESC "OA", UNIX_CLI_PARSE_ACTION_UP),
 388   _(ESC "OB", UNIX_CLI_PARSE_ACTION_DOWN),
 389   _(ESC "OC", UNIX_CLI_PARSE_ACTION_RIGHT),
 390   _(ESC "OD", UNIX_CLI_PARSE_ACTION_LEFT),
 391   _(ESC "OH", UNIX_CLI_PARSE_ACTION_HOME),
 392   _(ESC "OF", UNIX_CLI_PARSE_ACTION_END),
 393
 394   /* ANSI X3.41-1974 - sent by Microsoft Telnet and PuTTY */
 395   _(CSI "1~", UNIX_CLI_PARSE_ACTION_HOME),
 396   _(CSI "4~", UNIX_CLI_PARSE_ACTION_END),
 397
 398   /* Emacs-ish history search */
 399   _(CTL ('S'), UNIX_CLI_PARSE_ACTION_FWDSEARCH),
 400   _(CTL ('R'), UNIX_CLI_PARSE_ACTION_REVSEARCH),
 401
 402   /* Other protocol things */
 403   _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC),   /* IAC */
 404   _("\0", UNIX_CLI_PARSE_ACTION_NOACTION),      /* NUL */
 405   _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
 406 };
 407
 408 /**
 409  * Patterns to match when a CLI session is in the pager.
 410  * @showinitializer
 411  */
 412 static unix_cli_parse_actions_t unix_cli_parse_pager[] = {
 413   /* Line handling */
 414   _("\r\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),  /* Must be before '\r' */
 415   _("\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
 416   _("\r\0", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),  /* Telnet does this */
 417   _("\r", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
 418
 419   /* Pager commands */
 420   _(" ", UNIX_CLI_PARSE_ACTION_PAGER_NEXT),
 421   _("q", UNIX_CLI_PARSE_ACTION_PAGER_QUIT),
 422   _(CTL ('L'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
 423   _(CTL ('R'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
 424   _("/", UNIX_CLI_PARSE_ACTION_PAGER_SEARCH),
 425
 426   /* VT100 */
 427   _(CSI "A", UNIX_CLI_PARSE_ACTION_PAGER_UP),
 428   _(CSI "B", UNIX_CLI_PARSE_ACTION_PAGER_DN),
 429   _(CSI "H", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
 430   _(CSI "F", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
 431
 432   /* VT100 Application mode */
 433   _(ESC "OA", UNIX_CLI_PARSE_ACTION_PAGER_UP),
 434   _(ESC "OB", UNIX_CLI_PARSE_ACTION_PAGER_DN),
 435   _(ESC "OH", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
 436   _(ESC "OF", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
 437
 438   /* ANSI X3.41-1974 */
 439   _(CSI "1~", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
 440   _(CSI "4~", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
 441   _(CSI "5~", UNIX_CLI_PARSE_ACTION_PAGER_PGUP),
 442   _(CSI "6~", UNIX_CLI_PARSE_ACTION_PAGER_PGDN),
 443
 444   /* Other protocol things */
 445   _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC),   /* IAC */
 446   _("\0", UNIX_CLI_PARSE_ACTION_NOACTION),      /* NUL */
 447   _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
 448 };
 449
 450 #undef _
 451
 452 /** CLI session events. */
 453 typedef enum
 454 {
 455   UNIX_CLI_PROCESS_EVENT_READ_READY,  /**< A file descriptor has data to be read. */
 456   UNIX_CLI_PROCESS_EVENT_QUIT,        /**< A CLI session wants to close. */
 457 } unix_cli_process_event_type_t;
 458
 459 /** CLI session telnet negotiation timer events. */
 460 typedef enum
 461 {
 462   UNIX_CLI_NEW_SESSION_EVENT_ADD, /**< Add a CLI session to the new session list */
 463 } unix_cli_timeout_event_type_t;
 464
 465 /** Each new session is stored on a list with a deadline after which
 466  * a prompt is issued, in case the session TELNET negotiation fails to
 467  * complete. */
 468 typedef struct
 469 {
 470   uword cf_index; /**< Session index of the new session. */
 471   f64 deadline;   /**< Deadline after which the new session must have a prompt. */
 472 } unix_cli_new_session_t;
 473
 474 /** CLI global state. */
 475 typedef struct
 476 {
 477   /** Prompt string for CLI. */
 478   u8 *cli_prompt;
 479
 480   /** Vec pool of CLI sessions. */
 481   unix_cli_file_t *cli_file_pool;
 482
 483   /** Vec pool of unused session indices. */
 484   u32 *unused_cli_process_node_indices;
 485
 486   /** The session index of the stdin cli */
 487   u32 stdin_cli_file_index;
 488
 489   /** File pool index of current input. */
 490   u32 current_input_file_index;
 491
 492   /** New session process node identifier */
 493   u32 new_session_process_node_index;
 494
 495   /** List of new sessions */
 496   unix_cli_new_session_t *new_sessions;
 497
 498   /** system default macro table */
 499   clib_macro_main_t macro_main;
 500
 501 } unix_cli_main_t;
 502
 503 /** CLI global state */
 504 static unix_cli_main_t unix_cli_main;
 505
 506 /** Return the macro main / tables we should use for this session
 507  */
 508 static clib_macro_main_t *
 509 get_macro_main (void)
 510 {
 511   unix_cli_main_t *cm = &unix_cli_main;
 512   vlib_main_t *vm = vlib_get_main ();
 513   vlib_process_t *cp = vlib_get_current_process (vm);
 514   unix_cli_file_t *cf;
 515
 516   if (pool_is_free_index (cm->cli_file_pool, cp->output_function_arg))
 517     return (&cm->macro_main);
 518
 519   cf = pool_elt_at_index (cm->cli_file_pool, cp->output_function_arg);
 520
 521   return (&cf->macro_main);
 522 }
 523
 524 /**
 525  * @brief Search for a byte sequence in the action list.
 526  *
 527  * Searches the @ref unix_cli_parse_actions_t list in @a a for a match with
 528  * the bytes in @a input of maximum length @a ilen bytes.
 529  * When a match is made @a *matched indicates how many bytes were matched.
 530  * Returns a value from the enum @ref unix_cli_parse_action_t to indicate
 531  * whether no match was found, a partial match was found or a complete
 532  * match was found and what action, if any, should be taken.
 533  *
 534  * @param[in]  a        Actions list to search within.
 535  * @param[in]  input    String fragment to search for.
 536  * @param[in]  ilen     Length of the string in 'input'.
 537  * @param[out] matched  Pointer to an integer that will contain the number
 538  *                      of bytes matched when a complete match is found.
 539  *
 540  * @return Action from @ref unix_cli_parse_action_t that the string fragment
 541  *         matches.
 542  *         @ref UNIX_CLI_PARSE_ACTION_PARTIALMATCH is returned when the
 543  *         whole input string matches the start of at least one action.
 544  *         @ref UNIX_CLI_PARSE_ACTION_NOMATCH is returned when there is no
 545  *         match at all.
 546  */
 547 static unix_cli_parse_action_t
 548 unix_cli_match_action (unix_cli_parse_actions_t * a,
 549                        u8 * input, u32 ilen, i32 * matched)
 550 {
 551   u8 partial = 0;
 552
 553   while (a->input)
 554     {
 555       if (ilen >= a->len)
 556         {
 557           /* see if the start of the input buffer exactly matches the current
 558            * action string. */
 559           if (memcmp (input, a->input, a->len) == 0)
 560             {
 561               *matched = a->len;
 562               return a->action;
 563             }
 564         }
 565       else
 566         {
 567           /* if the first ilen characters match, flag this as a partial -
 568            * meaning keep collecting bytes in case of a future match */
 569           if (memcmp (input, a->input, ilen) == 0)
 570             partial = 1;
 571         }
 572
 573       /* check next action */
 574       a++;
 575     }
 576
 577   return partial ?
 578     UNIX_CLI_PARSE_ACTION_PARTIALMATCH : UNIX_CLI_PARSE_ACTION_NOMATCH;
 579 }
 580
 581
 582 /** Add bytes to the output vector and then flagg the I/O system that bytes
 583  * are available to be sent.
 584  */
 585 static void
 586 unix_cli_add_pending_output (clib_file_t * uf,
 587                              unix_cli_file_t * cf,
 588                              u8 * buffer, uword buffer_bytes)
 589 {
 590   clib_file_main_t *fm = &file_main;
 591
 592   vec_add (cf->output_vector, buffer, buffer_bytes);
 593   if (vec_len (cf->output_vector) > 0)
 594     {
 595       int skip_update = 0 != (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
 596       uf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
 597       if (!skip_update)
 598         fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
 599     }
 600 }
 601
 602 /** Delete all bytes from the output vector and flag the I/O system
 603  * that no more bytes are available to be sent.
 604  */
 605 static void
 606 unix_cli_del_pending_output (clib_file_t * uf,
 607                              unix_cli_file_t * cf, uword n_bytes)
 608 {
 609   clib_file_main_t *fm = &file_main;
 610
 611   vec_delete (cf->output_vector, n_bytes, 0);
 612   if (vec_len (cf->output_vector) <= 0)
 613     {
 614       int skip_update = 0 == (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
 615       uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
 616       if (!skip_update)
 617         fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
 618     }
 619 }
 620
 621 /** @brief A bit like strchr with a buffer length limit.
 622  * Search a buffer for the first instance of a character up to the limit of
 623  * the buffer length. If found then return the position of that character.
 624  *
 625  * The key departure from strchr is that if the character is not found then
 626  * return the buffer length.
 627  *
 628  * @param chr The byte value to search for.
 629  * @param str The buffer in which to search for the value.
 630  * @param len The depth into the buffer to search.
 631  *
 632  * @return The index of the first occurrence of \c chr. If \c chr is not
 633  *          found then \c len instead.
 634  */
 635 always_inline word
 636 unix_vlib_findchr (u8 chr, u8 * str, word len)
 637 {
 638   word i = 0;
 639   for (i = 0; i < len; i++, str++)
 640     {
 641       if (*str == chr)
 642         return i;
 643     }
 644   return len;
 645 }
 646
 647 /** @brief Send a buffer to the CLI stream if possible, enqueue it otherwise.
 648  * Attempts to write given buffer to the file descriptor of the given
 649  * Unix CLI session. If that session already has data in the output buffer
 650  * or if the write attempt tells us to try again later then the given buffer
 651  * is appended to the pending output buffer instead.
 652  *
 653  * This is typically called only from \c unix_vlib_cli_output_cooked since
 654  * that is where CRLF handling occurs or from places where we explicitly do
 655  * not want cooked handling.
 656  *
 657  * @param cf Unix CLI session of the desired stream to write to.
 658  * @param uf The Unix file structure of the desired stream to write to.
 659  * @param buffer Pointer to the buffer that needs to be written.
 660  * @param buffer_bytes The number of bytes from \c buffer to write.
 661  */
 662 static void
 663 unix_vlib_cli_output_raw (unix_cli_file_t * cf,
 664                           clib_file_t * uf, u8 * buffer, uword buffer_bytes)
 665 {
 666   int n = 0;
 667
 668   if (cf->has_epipe)            /* don't try writing anything */
 669     return;
 670
 671   if (vec_len (cf->output_vector) == 0)
 672     {
 673       if (cf->is_socket)
 674         /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
 675         n = send (uf->file_descriptor, buffer, buffer_bytes, MSG_NOSIGNAL);
 676       else
 677         n = write (uf->file_descriptor, buffer, buffer_bytes);
 678     }
 679
 680   if (n < 0 && errno != EAGAIN)
 681     {
 682       if (errno == EPIPE)
 683         {
 684           /* connection closed on us */
 685           unix_main_t *um = &unix_main;
 686           cf->has_epipe = 1;
 687           vlib_process_signal_event (um->vlib_main, cf->process_node_index,
 688                                      UNIX_CLI_PROCESS_EVENT_QUIT,
 689                                      uf->private_data);
 690         }
 691       else
 692         {
 693           clib_unix_warning ("write");
 694         }
 695     }
 696   else if ((word) n < (word) buffer_bytes)
 697     {
 698       /* We got EAGAIN or we already have stuff in the buffer;
 699        * queue up whatever didn't get sent for later. */
 700       if (n < 0)
 701         n = 0;
 702       unix_cli_add_pending_output (uf, cf, buffer + n, buffer_bytes - n);
 703     }
 704 }
 705
 706 /** @brief Process a buffer for CRLF handling before outputting it to the CLI.
 707  *
 708  * @param cf Unix CLI session of the desired stream to write to.
 709  * @param uf The Unix file structure of the desired stream to write to.
 710  * @param buffer Pointer to the buffer that needs to be written.
 711  * @param buffer_bytes The number of bytes from \c buffer to write.
 712  */
 713 static void
 714 unix_vlib_cli_output_cooked (unix_cli_file_t * cf,
 715                              clib_file_t * uf,
 716                              u8 * buffer, uword buffer_bytes)
 717 {
 718   word end = 0, start = 0;
 719
 720   while (end < buffer_bytes)
 721     {
 722       if (cf->crlf_mode)
 723         {
 724           /* iterate the line on \n's so we can insert a \r before it */
 725           end = unix_vlib_findchr ('\n',
 726                                    buffer + start,
 727                                    buffer_bytes - start) + start;
 728         }
 729       else
 730         {
 731           /* otherwise just send the whole buffer */
 732           end = buffer_bytes;
 733         }
 734
 735       unix_vlib_cli_output_raw (cf, uf, buffer + start, end - start);
 736
 737       if (cf->crlf_mode)
 738         {
 739           if (end < buffer_bytes)
 740             {
 741               unix_vlib_cli_output_raw (cf, uf, (u8 *) "\r\n", 2);
 742               end++;            /* skip the \n that we already sent */
 743             }
 744           start = end;
 745         }
 746     }
 747
 748   /* Use the last character to determine the last direction of the cursor. */
 749   if (buffer_bytes > 0)
 750     cf->cursor_direction = (buffer[buffer_bytes - 1] == (u8) '\b');
 751 }
 752
 753 /** @brief Moves the terminal cursor one character to the left, with
 754  * special handling when it reaches the left edge of the terminal window.
 755  *
 756  * Ordinarily we can simply send a '\b' to move the cursor left, however
 757  * most terminals will not reverse-wrap to the end of the previous line
 758  * if the cursor is in the left-most column. To counter this we must
 759  * check the cursor position + prompt length modulo terminal width and
 760  * if available use some other means, such as ANSI terminal escape
 761  * sequences, to move the cursor.
 762  *
 763  * @param cf Unix CLI session of the desired stream to write to.
 764  * @param uf The Unix file structure of the desired stream to write to.
 765  */
 766 static void
 767 unix_vlib_cli_output_cursor_left (unix_cli_file_t * cf, clib_file_t * uf)
 768 {
 769   unix_cli_main_t *cm = &unix_cli_main;
 770   static u8 *ansi = 0;          /* assumes no reentry */
 771   u32 position;
 772
 773   if (!cf->is_interactive || !cf->ansi_capable || !cf->width)
 774     {
 775       /* No special handling for dumb terminals */
 776       unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
 777       return;
 778     }
 779
 780   position = ((u32) vec_len (cm->cli_prompt) + cf->cursor) % cf->width;
 781
 782   if (position != 0)
 783     {
 784       /* No special handling required if we're not at the left edge */
 785       unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
 786       return;
 787     }
 788
 789   if (!cf->cursor_direction)
 790     {
 791       /* Special handling for when we are at the left edge but
 792        * the cursor was going left-to-right, but in this situation
 793        * xterm-like terminals actually hide the cursor off the right
 794        * edge. A \b here seems to jump one char too many, so let's
 795        * force the cursor onto the next line instead.
 796        */
 797       if (cf->cursor < vec_len (cf->current_command))
 798         unix_vlib_cli_output_cooked (cf, uf, &cf->current_command[cf->cursor],
 799                                      1);
 800       else
 801         unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
 802       unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
 803     }
 804
 805   /* Relocate the cursor at the right hand edge one line above */
 806   ansi = format (ansi, CSI "A" CSI "%dC", cf->width - 1);
 807   unix_vlib_cli_output_cooked (cf, uf, ansi, vec_len (ansi));
 808   vec_reset_length (ansi);      /* keep the vec around for next time */
 809   cf->cursor_direction = 1;     /* going backwards now */
 810 }
 811
 812 /** @brief Output the CLI prompt */
 813 static void
 814 unix_cli_cli_prompt (unix_cli_file_t * cf, clib_file_t * uf)
 815 {
 816   unix_cli_main_t *cm = &unix_cli_main;
 817
 818   if (cf->is_interactive)       /* Only interactive sessions get a prompt */
 819     unix_vlib_cli_output_raw (cf, uf, cm->cli_prompt,
 820                               vec_len (cm->cli_prompt));
 821 }
 822
 823 /** @brief Output a pager prompt and show number of buffered lines */
 824 static void
 825 unix_cli_pager_prompt (unix_cli_file_t * cf, clib_file_t * uf)
 826 {
 827   u8 *prompt;
 828   u32 h;
 829
 830   h = cf->pager_start + (cf->height - 1);
 831   if (h > vec_len (cf->pager_index))
 832     h = vec_len (cf->pager_index);
 833
 834   prompt = format (0, "\r%s-- more -- (%d-%d/%d)%s",
 835                    cf->ansi_capable ? ANSI_BOLD : "",
 836                    cf->pager_start + 1,
 837                    h,
 838                    vec_len (cf->pager_index),
 839                    cf->ansi_capable ? ANSI_RESET : "");
 840
 841   unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
 842
 843   vec_free (prompt);
 844 }
 845
 846 /** @brief Output a pager "skipping" message */
 847 static void
 848 unix_cli_pager_message (unix_cli_file_t * cf, clib_file_t * uf,
 849                         char *message, char *postfix)
 850 {
 851   u8 *prompt;
 852
 853   prompt = format (0, "\r%s-- %s --%s%s",
 854                    cf->ansi_capable ? ANSI_BOLD : "",
 855                    message, cf->ansi_capable ? ANSI_RESET : "", postfix);
 856
 857   unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
 858
 859   vec_free (prompt);
 860 }
 861
 862 /** @brief Erase the printed pager prompt */
 863 static void
 864 unix_cli_pager_prompt_erase (unix_cli_file_t * cf, clib_file_t * uf)
 865 {
 866   if (cf->ansi_capable)
 867     {
 868       unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
 869       unix_vlib_cli_output_cooked (cf, uf,
 870                                    (u8 *) ANSI_CLEARLINE,
 871                                    sizeof (ANSI_CLEARLINE) - 1);
 872     }
 873   else
 874     {
 875       int i;
 876
 877       unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
 878       for (i = 0; i < cf->width - 1; i++)
 879         unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
 880       unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
 881     }
 882 }
 883
 884 /** @brief Uses an ANSI escape sequence to move the cursor */
 885 static void
 886 unix_cli_ansi_cursor (unix_cli_file_t * cf, clib_file_t * uf, u16 x, u16 y)
 887 {
 888   u8 *str;
 889
 890   str = format (0, "%s%d;%dH", CSI, y, x);
 891
 892   unix_vlib_cli_output_cooked (cf, uf, str, vec_len (str));
 893
 894   vec_free (str);
 895 }
 896
 897 /** Redraw the currently displayed page of text.
 898  * @param cf CLI session to redraw the pager buffer of.
 899  * @param uf Unix file of the CLI session.
 900  */
 901 static void
 902 unix_cli_pager_redraw (unix_cli_file_t * cf, clib_file_t * uf)
 903 {
 904   unix_cli_pager_index_t *pi = NULL;
 905   u8 *line = NULL;
 906   word i;
 907
 908   /* No active pager? Do nothing. */
 909   if (!vec_len (cf->pager_index))
 910     return;
 911
 912   if (cf->ansi_capable)
 913     {
 914       /* If we have ANSI, send the clear screen sequence */
 915       unix_vlib_cli_output_cooked (cf, uf,
 916                                    (u8 *) ANSI_CLEAR,
 917                                    sizeof (ANSI_CLEAR) - 1);
 918     }
 919   else
 920     {
 921       /* Otherwise make sure we're on a blank line */
 922       unix_cli_pager_prompt_erase (cf, uf);
 923     }
 924
 925   /* (Re-)send the current page of content */
 926   for (i = 0; i < cf->height - 1 &&
 927        i + cf->pager_start < vec_len (cf->pager_index); i++)
 928     {
 929       pi = &cf->pager_index[cf->pager_start + i];
 930       line = cf->pager_vector[pi->line] + pi->offset;
 931
 932       unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
 933     }
 934   /* if the last line didn't end in newline, add a newline */
 935   if (pi && line[pi->length - 1] != '\n')
 936     unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
 937
 938   unix_cli_pager_prompt (cf, uf);
 939 }
 940
 941 /** @brief Process and add a line to the pager index.
 942  * In normal operation this function will take the given character string
 943  * found in @c line and with length @c len_or_index and iterates the over the
 944  * contents, adding each line of text discovered within it to the
 945  * pager index. Lines are identified by newlines ("<code>\\n</code>") and by
 946  * strings longer than the width of the terminal.
 947  *
 948  * If instead @c line is @c NULL then @c len_or_index is taken to mean the
 949  * index of an existing line in the pager buffer; this simply means that the
 950  * input line does not need to be cloned since we already have it. This is
 951  * typical if we are reindexing the pager buffer.
 952  *
 953  * @param cf           The CLI session whose pager we are adding to.
 954  * @param line         The string of text to be indexed into the pager buffer.
 955  *                     If @c line is @c NULL then the mode of operation
 956  *                     changes slightly; see the description above.
 957  * @param len_or_index If @c line is a pointer to a string then this parameter
 958  *                     indicates the length of that string; Otherwise this
 959  *                     value provides the index in the pager buffer of an
 960  *                     existing string to be indexed.
 961  */
 962 static void
 963 unix_cli_pager_add_line (unix_cli_file_t * cf, u8 * line, word len_or_index)
 964 {
 965   u8 *p = NULL;
 966   word i, j, k;
 967   word line_index, len;
 968   u32 width = cf->width;
 969   unix_cli_pager_index_t *pi;
 970
 971   if (line == NULL)
 972     {
 973       /* Use a line already in the pager buffer */
 974       line_index = len_or_index;
 975       if (cf->pager_vector != NULL)
 976         p = cf->pager_vector[line_index];
 977       len = vec_len (p);
 978     }
 979   else
 980     {
 981       len = len_or_index;
 982       /* Add a copy of the raw string to the pager buffer */
 983       p = vec_new (u8, len);
 984       clib_memcpy (p, line, len);
 985
 986       /* store in pager buffer */
 987       line_index = vec_len (cf->pager_vector);
 988       vec_add1 (cf->pager_vector, p);
 989     }
 990
 991   i = 0;
 992   while (i < len)
 993     {
 994       /* Find the next line, or run to terminal width, or run to EOL */
 995       int l = len - i;
 996       j = unix_vlib_findchr ((u8) '\n', p, l < width ? l : width);
 997
 998       if (j < l && p[j] == '\n')        /* incl \n */
 999         j++;
1000
1001       /* Add the line to the index */
1002       k = vec_len (cf->pager_index);
1003       vec_validate (cf->pager_index, k);
1004       pi = &cf->pager_index[k];
1005
1006       pi->line = line_index;
1007       pi->offset = i;
1008       pi->length = j;
1009
1010       i += j;
1011       p += j;
1012     }
1013 }
1014
1015 /** @brief Reindex entire pager buffer.
1016  * Resets the current pager index and then re-adds the lines in the pager
1017  * buffer to the index.
1018  *
1019  * Additionally this function attempts to retain the current page start
1020  * line offset by searching for the same top-of-screen line in the new index.
1021  *
1022  * @param cf The CLI session whose pager buffer should be reindexed.
1023  */
1024 static void
1025 unix_cli_pager_reindex (unix_cli_file_t * cf)
1026 {
1027   word i, old_line, old_offset;
1028   unix_cli_pager_index_t *pi;
1029
1030   /* If there is nothing in the pager buffer then make sure the index
1031    * is empty and move on.
1032    */
1033   if (cf->pager_vector == 0)
1034     {
1035       vec_reset_length (cf->pager_index);
1036       return;
1037     }
1038
1039   /* Retain a pointer to the current page start line so we can
1040    * find it later
1041    */
1042   pi = &cf->pager_index[cf->pager_start];
1043   old_line = pi->line;
1044   old_offset = pi->offset;
1045
1046   /* Re-add the buffered lines to the index */
1047   vec_reset_length (cf->pager_index);
1048   vec_foreach_index (i, cf->pager_vector)
1049   {
1050     unix_cli_pager_add_line (cf, NULL, i);
1051   }
1052
1053   /* Attempt to re-locate the previously stored page start line */
1054   vec_foreach_index (i, cf->pager_index)
1055   {
1056     pi = &cf->pager_index[i];
1057
1058     if (pi->line == old_line &&
1059         (pi->offset <= old_offset || pi->offset + pi->length > old_offset))
1060       {
1061         /* Found it! */
1062         cf->pager_start = i;
1063         break;
1064       }
1065   }
1066
1067   /* In case the start line was not found (rare), ensure the pager start
1068    * index is within bounds
1069    */
1070   if (cf->pager_start >= vec_len (cf->pager_index))
1071     {
1072       if (!cf->height || vec_len (cf->pager_index) < (cf->height - 1))
1073         cf->pager_start = 0;
1074       else
1075         cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
1076     }
1077 }
1078
1079 /** VLIB CLI output function.
1080  *
1081  * If the terminal has a pager configured then this function takes care
1082  * of collating output into the pager buffer; ensuring only the first page
1083  * is displayed and any lines in excess of the first page are buffered.
1084  *
1085  * If the maximum number of index lines in the buffer is exceeded then the
1086  * pager is cancelled and the contents of the current buffer are sent to the
1087  * terminal.
1088  *
1089  * If there is no pager configured then the output is sent directly to the
1090  * terminal.
1091  *
1092  * @param cli_file_index Index of the CLI session where this output is
1093  *                       directed.
1094  * @param buffer         String of printabe bytes to be output.
1095  * @param buffer_bytes   The number of bytes in @c buffer to be output.
1096  */
1097 static void
1098 unix_vlib_cli_output (uword cli_file_index, u8 * buffer, uword buffer_bytes)
1099 {
1100   unix_main_t *um = &unix_main;
1101   clib_file_main_t *fm = &file_main;
1102   unix_cli_main_t *cm = &unix_cli_main;
1103   unix_cli_file_t *cf;
1104   clib_file_t *uf;
1105
1106   cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
1107   uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1108
1109   if (cf->no_pager || um->cli_pager_buffer_limit == 0 || cf->height == 0)
1110     {
1111       unix_vlib_cli_output_cooked (cf, uf, buffer, buffer_bytes);
1112     }
1113   else
1114     {
1115       word row = vec_len (cf->pager_index);
1116       u8 *line;
1117       unix_cli_pager_index_t *pi;
1118
1119       /* Index and add the output lines to the pager buffer. */
1120       unix_cli_pager_add_line (cf, buffer, buffer_bytes);
1121
1122       /* Now iterate what was added to display the lines.
1123        * If we reach the bottom of the page, display a prompt.
1124        */
1125       while (row < vec_len (cf->pager_index))
1126         {
1127           if (row < cf->height - 1)
1128             {
1129               /* output this line */
1130               pi = &cf->pager_index[row];
1131               line = cf->pager_vector[pi->line] + pi->offset;
1132               unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1133
1134               /* if the last line didn't end in newline, and we're at the
1135                * bottom of the page, add a newline */
1136               if (line[pi->length - 1] != '\n' && row == cf->height - 2)
1137                 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1138             }
1139           else
1140             {
1141               /* Display the pager prompt every 10 lines */
1142               if (!(row % 10))
1143                 unix_cli_pager_prompt (cf, uf);
1144             }
1145           row++;
1146         }
1147
1148       /* Check if we went over the pager buffer limit */
1149       if (vec_len (cf->pager_index) > um->cli_pager_buffer_limit)
1150         {
1151           /* Stop using the pager for the remainder of this CLI command */
1152           cf->no_pager = 2;
1153
1154           /* If we likely printed the prompt, erase it */
1155           if (vec_len (cf->pager_index) > cf->height - 1)
1156             unix_cli_pager_prompt_erase (cf, uf);
1157
1158           /* Dump out the contents of the buffer */
1159           for (row = cf->pager_start + (cf->height - 1);
1160                row < vec_len (cf->pager_index); row++)
1161             {
1162               pi = &cf->pager_index[row];
1163               line = cf->pager_vector[pi->line] + pi->offset;
1164               unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1165             }
1166
1167           unix_cli_pager_reset (cf);
1168         }
1169     }
1170 }
1171
1172 /** Identify whether a terminal type is ANSI capable.
1173  *
1174  * Compares the string given in @c term with a list of terminal types known
1175  * to support ANSI escape sequences.
1176  *
1177  * This list contains, for example, @c xterm, @c screen and @c ansi.
1178  *
1179  * @param term A string with a terminal type in it.
1180  * @param len The length of the string in @c term.
1181  *
1182  * @return @c 1 if the terminal type is recognized as supporting ANSI
1183  *         terminal sequences; @c 0 otherwise.
1184  */
1185 static u8
1186 unix_cli_terminal_type_ansi (u8 * term, uword len)
1187 {
1188   /* This may later be better done as a hash of some sort. */
1189 #define _(a) do { \
1190     if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1191   } while(0)
1192
1193   _("xterm");
1194   _("xterm-color");
1195   _("xterm-256color");          /* iTerm on Mac */
1196   _("screen");
1197   _("screen-256color");         /* Screen and tmux */
1198   _("ansi");                    /* Microsoft Telnet */
1199 #undef _
1200
1201   return 0;
1202 }
1203
1204 /** Identify whether a terminal type is non-interactive.
1205  *
1206  * Compares the string given in @c term with a list of terminal types known
1207  * to be non-interactive, as send by tools such as @c vppctl .
1208  *
1209  * This list contains, for example, @c vppctl.
1210  *
1211  * @param term A string with a terminal type in it.
1212  * @param len The length of the string in @c term.
1213  *
1214  * @return @c 1 if the terminal type is recognized as being non-interactive;
1215  *         @c 0 otherwise.
1216  */
1217 static u8
1218 unix_cli_terminal_type_noninteractive (u8 * term, uword len)
1219 {
1220   /* This may later be better done as a hash of some sort. */
1221 #define _(a) do { \
1222     if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1223   } while(0)
1224
1225   _("vppctl");
1226 #undef _
1227
1228   return 0;
1229 }
1230
1231 /** Set a session to be non-interactive. */
1232 static void
1233 unix_cli_set_session_noninteractive (unix_cli_file_t * cf)
1234 {
1235   /* Non-interactive sessions don't get these */
1236   cf->is_interactive = 0;
1237   cf->no_pager = 1;
1238   cf->history_limit = 0;
1239   cf->has_history = 0;
1240   cf->line_mode = 1;
1241 }
1242
1243 /** @brief Emit initial welcome banner and prompt on a connection. */
1244 static void
1245 unix_cli_file_welcome (unix_cli_main_t * cm, unix_cli_file_t * cf)
1246 {
1247   unix_main_t *um = &unix_main;
1248   clib_file_main_t *fm = &file_main;
1249   clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1250   unix_cli_banner_t *banner;
1251   int i, len;
1252
1253   /* Mark the session as started if we get here */
1254   cf->started = 1;
1255
1256   if (!(cf->is_interactive))    /* No banner for non-interactive sessions */
1257     return;
1258
1259   /*
1260    * Put the first bytes directly into the buffer so that further output is
1261    * queued until everything is ready. (oterwise initial prompt can appear
1262    * mid way through VPP initialization)
1263    */
1264   unix_cli_add_pending_output (uf, cf, (u8 *) "\r", 1);
1265
1266   if (!um->cli_no_banner)
1267     {
1268       if (cf->ansi_capable)
1269         {
1270           banner = unix_cli_banner_color;
1271           len = ARRAY_LEN (unix_cli_banner_color);
1272         }
1273       else
1274         {
1275           banner = unix_cli_banner;
1276           len = ARRAY_LEN (unix_cli_banner);
1277         }
1278
1279       for (i = 0; i < len; i++)
1280         {
1281           unix_vlib_cli_output_cooked (cf, uf,
1282                                        banner[i].line, banner[i].length);
1283         }
1284     }
1285
1286   /* Prompt. */
1287   unix_cli_cli_prompt (cf, uf);
1288
1289 }
1290
1291 /**
1292  * @brief A failsafe manager that ensures CLI sessions issue an initial
1293  * prompt if TELNET negotiation fails.
1294  */
1295 static uword
1296 unix_cli_new_session_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1297                               vlib_frame_t * f)
1298 {
1299   unix_cli_main_t *cm = &unix_cli_main;
1300   uword event_type, *event_data = 0;
1301   f64 wait = 10.0;
1302
1303   while (1)
1304     {
1305       if (vec_len (cm->new_sessions) > 0)
1306         wait = vlib_process_wait_for_event_or_clock (vm, wait);
1307       else
1308         vlib_process_wait_for_event (vm);
1309
1310       event_type = vlib_process_get_events (vm, &event_data);
1311
1312       switch (event_type)
1313         {
1314         case ~0:                /* no events => timeout */
1315           break;
1316
1317         case UNIX_CLI_NEW_SESSION_EVENT_ADD:
1318           {
1319             /* Add an identifier to the new session list */
1320             unix_cli_new_session_t ns;
1321
1322             ns.cf_index = event_data[0];
1323             ns.deadline = vlib_time_now (vm) + 1.0;
1324
1325             vec_add1 (cm->new_sessions, ns);
1326
1327             if (wait > 0.1)
1328               wait = 0.1;       /* force a re-evaluation soon, but not too soon */
1329           }
1330           break;
1331
1332         default:
1333           clib_warning ("BUG: unknown event type 0x%wx", event_type);
1334           break;
1335         }
1336
1337       vec_reset_length (event_data);
1338
1339       if (vlib_process_suspend_time_is_zero (wait))
1340         {
1341           /* Scan the list looking for expired deadlines.
1342            * Emit needed prompts and remove from the list.
1343            * While scanning, look for the nearest new deadline
1344            * for the next iteration.
1345            * Since the list is ordered with newest sessions first
1346            * we can make assumptions about expired sessions being
1347            * contiguous at the beginning and the next deadline is the
1348            * next entry on the list, if any.
1349            */
1350           f64 now = vlib_time_now (vm);
1351           unix_cli_new_session_t *nsp;
1352           word index = 0;
1353
1354           wait = INFINITY;
1355
1356           vec_foreach (nsp, cm->new_sessions)
1357           {
1358             if (vlib_process_suspend_time_is_zero (nsp->deadline - now))
1359               {
1360                 /* Deadline reached */
1361                 unix_cli_file_t *cf;
1362
1363                 /* Mark the highwater */
1364                 index++;
1365
1366                 /* Check the connection didn't close already */
1367                 if (pool_is_free_index (cm->cli_file_pool, nsp->cf_index))
1368                   continue;
1369
1370                 cf = pool_elt_at_index (cm->cli_file_pool, nsp->cf_index);
1371
1372                 if (!cf->started)
1373                   unix_cli_file_welcome (cm, cf);
1374               }
1375             else
1376               {
1377                 wait = nsp->deadline - now;
1378                 break;
1379               }
1380           }
1381
1382           if (index)
1383             {
1384               /* We have sessions to remove */
1385               vec_delete (cm->new_sessions, index, 0);
1386             }
1387         }
1388     }
1389
1390   return 0;
1391 }
1392
1393
1394 /** @brief A mostly no-op Telnet state machine.
1395  * Process Telnet command bytes in a way that ensures we're mostly
1396  * transparent to the Telnet protocol. That is, it's mostly a no-op.
1397  *
1398  * @return -1 if we need more bytes, otherwise a positive integer number of
1399  *          bytes to consume from the input_vector, not including the initial
1400  *          IAC byte.
1401  */
1402 static i32
1403 unix_cli_process_telnet (unix_main_t * um,
1404                          unix_cli_file_t * cf,
1405                          clib_file_t * uf, u8 * input_vector, uword len)
1406 {
1407   /* Input_vector starts at IAC byte.
1408    * See if we have a complete message; if not, return -1 so we wait for more.
1409    * if we have a complete message, consume those bytes from the vector.
1410    */
1411   i32 consume = 0;
1412
1413   if (len == 1)
1414     return -1;                  /* want more bytes */
1415
1416   switch (input_vector[1])
1417     {
1418     case IAC:
1419       /* two IAC's in a row means to pass through 0xff.
1420        * since that makes no sense here, just consume it.
1421        */
1422       consume = 1;
1423       break;
1424
1425     case WILL:
1426     case WONT:
1427     case DO:
1428     case DONT:
1429       /* Expect 3 bytes */
1430       if (len < 3)
1431         return -1;              /* want more bytes */
1432
1433       consume = 2;
1434       break;
1435
1436     case SB:
1437       {
1438         /* Sub option - search ahead for IAC SE to end it */
1439         i32 i;
1440         for (i = 3; i < len && i < UNIX_CLI_MAX_DEPTH_TELNET; i++)
1441           {
1442             if (input_vector[i - 1] == IAC && input_vector[i] == SE)
1443               {
1444                 /* We have a complete message; see if we care about it */
1445                 switch (input_vector[2])
1446                   {
1447                   case TELOPT_TTYPE:
1448                     if (input_vector[3] != 0)
1449                       break;
1450                     {
1451                       /* See if the the terminal type is recognized */
1452                       u8 *term = input_vector + 4;
1453                       uword len = i - 5;
1454
1455                       /* See if the terminal type is ANSI capable */
1456                       cf->ansi_capable =
1457                         unix_cli_terminal_type_ansi (term, len);
1458
1459                       /* See if the terminal type indicates non-interactive */
1460                       if (unix_cli_terminal_type_noninteractive (term, len))
1461                         unix_cli_set_session_noninteractive (cf);
1462                     }
1463
1464                     /* If session not started, we can release the pause */
1465                     if (!cf->started)
1466                       /* Send the welcome banner and initial prompt */
1467                       unix_cli_file_welcome (&unix_cli_main, cf);
1468                     break;
1469
1470                   case TELOPT_NAWS:
1471                     /* Window size */
1472                     if (i != 8) /* check message is correct size */
1473                       break;
1474
1475                     cf->width =
1476                       clib_net_to_host_u16 (*((u16 *) (input_vector + 3)));
1477                     if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
1478                       cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
1479                     if (cf->width == 0)
1480                       cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
1481
1482                     cf->height =
1483                       clib_net_to_host_u16 (*((u16 *) (input_vector + 5)));
1484                     if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
1485                       cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
1486                     if (cf->height == 0)
1487                       cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
1488
1489                     /* reindex pager buffer */
1490                     unix_cli_pager_reindex (cf);
1491                     /* redraw page */
1492                     unix_cli_pager_redraw (cf, uf);
1493                     break;
1494
1495                   default:
1496                     break;
1497                   }
1498                 /* Consume it all */
1499                 consume = i;
1500                 break;
1501               }
1502           }
1503
1504         if (i == UNIX_CLI_MAX_DEPTH_TELNET)
1505           consume = 1;          /* hit max search depth, advance one byte */
1506
1507         if (consume == 0)
1508           return -1;            /* want more bytes */
1509
1510         break;
1511       }
1512
1513     case GA:
1514     case EL:
1515     case EC:
1516     case AO:
1517     case IP:
1518     case BREAK:
1519     case DM:
1520     case NOP:
1521     case SE:
1522     case EOR:
1523     case ABORT:
1524     case SUSP:
1525     case xEOF:
1526       /* Simple one-byte messages */
1527       consume = 1;
1528       break;
1529
1530     case AYT:
1531       /* Are You There - trigger a visible response */
1532       consume = 1;
1533       unix_vlib_cli_output_cooked (cf, uf, (u8 *) "fd.io VPP\n", 10);
1534       break;
1535
1536     default:
1537       /* Unknown command! Eat the IAC byte */
1538       break;
1539     }
1540
1541   return consume;
1542 }
1543
1544 /** @brief Process actionable input.
1545  * Based on the \c action process the input; this typically involves
1546  * searching the command history or editing the current command line.
1547  */
1548 static int
1549 unix_cli_line_process_one (unix_cli_main_t * cm,
1550                            unix_main_t * um,
1551                            unix_cli_file_t * cf,
1552                            clib_file_t * uf,
1553                            u8 input, unix_cli_parse_action_t action)
1554 {
1555   u8 *prev;
1556   u8 *save = 0;
1557   u8 **possible_commands;
1558   int j, delta;
1559
1560   switch (action)
1561     {
1562     case UNIX_CLI_PARSE_ACTION_NOACTION:
1563       break;
1564
1565     case UNIX_CLI_PARSE_ACTION_REVSEARCH:
1566     case UNIX_CLI_PARSE_ACTION_FWDSEARCH:
1567       if (!cf->has_history || !cf->history_limit)
1568         break;
1569       if (cf->search_mode == 0)
1570         {
1571           /* Erase the current command (if any) */
1572           for (; cf->cursor > 0; cf->cursor--)
1573             {
1574               unix_vlib_cli_output_cursor_left (cf, uf);
1575               unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1576               unix_vlib_cli_output_cursor_left (cf, uf);
1577             }
1578
1579           vec_reset_length (cf->search_key);
1580           vec_reset_length (cf->current_command);
1581
1582           if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1583             cf->search_mode = -1;
1584           else
1585             cf->search_mode = 1;
1586         }
1587       else
1588         {
1589           if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1590             cf->search_mode = -1;
1591           else
1592             cf->search_mode = 1;
1593
1594           cf->excursion += cf->search_mode;
1595           goto search_again;
1596         }
1597       break;
1598
1599     case UNIX_CLI_PARSE_ACTION_ERASELINELEFT:
1600       /* Erase the command from the cursor to the start */
1601
1602       j = cf->cursor;
1603       /* Shimmy backwards to the new end of line position */
1604       delta = vec_len (cf->current_command) - cf->cursor;
1605       for (; cf->cursor > delta; cf->cursor--)
1606         unix_vlib_cli_output_cursor_left (cf, uf);
1607       /* Zap from here to the end of what is currently displayed */
1608       for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1609         unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1610       /* Get back to the start of the line */
1611       for (; cf->cursor > 0; cf->cursor--)
1612         unix_vlib_cli_output_cursor_left (cf, uf);
1613
1614       /* Delete the desired text from the command */
1615       memmove (cf->current_command, cf->current_command + j, delta);
1616       _vec_len (cf->current_command) = delta;
1617
1618       /* Print the new contents */
1619       unix_vlib_cli_output_cooked (cf, uf, cf->current_command, delta);
1620       cf->cursor = delta;       /* for backspace tracking */
1621
1622       /* Shimmy back to the start */
1623       for (; cf->cursor > 0; cf->cursor--)
1624         unix_vlib_cli_output_cursor_left (cf, uf);
1625
1626       cf->search_mode = 0;
1627       break;
1628
1629     case UNIX_CLI_PARSE_ACTION_ERASELINERIGHT:
1630       /* Erase the command from the cursor to the end */
1631
1632       j = cf->cursor;
1633       /* Zap from cursor to end of what is currently displayed */
1634       for (; cf->cursor < (vec_len (cf->current_command)); cf->cursor++)
1635         unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1636       /* Get back to where we were */
1637       for (; cf->cursor > j; cf->cursor--)
1638         unix_vlib_cli_output_cursor_left (cf, uf);
1639
1640       /* Truncate the line at the cursor */
1641       _vec_len (cf->current_command) = cf->cursor;
1642
1643       cf->search_mode = 0;
1644       break;
1645
1646     case UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT:
1647       /* calculate num of caracter to be erased */
1648       delta = 0;
1649       while (cf->cursor > delta
1650              && cf->current_command[cf->cursor - delta - 1] == ' ')
1651         delta++;
1652       while (cf->cursor > delta
1653              && cf->current_command[cf->cursor - delta - 1] != ' ')
1654         delta++;
1655
1656       if (vec_len (cf->current_command))
1657         {
1658           if (cf->cursor > 0)
1659             {
1660               /* move cursor left delta times */
1661               for (j = delta; j > 0; j--, cf->cursor--)
1662                 unix_vlib_cli_output_cursor_left (cf, uf);
1663               save = cf->current_command + cf->cursor;
1664
1665               /* redraw remainder of line */
1666               memmove (cf->current_command + cf->cursor,
1667                        cf->current_command + cf->cursor + delta,
1668                        _vec_len (cf->current_command) - cf->cursor - delta);
1669               unix_vlib_cli_output_cooked (cf, uf,
1670                                            cf->current_command + cf->cursor,
1671                                            _vec_len (cf->current_command) -
1672                                            cf->cursor);
1673               cf->cursor += _vec_len (cf->current_command) - cf->cursor;
1674
1675               /* print delta amount of blank spaces,
1676                * then finally fix the cursor position */
1677               for (j = delta; j > 0; j--, cf->cursor--)
1678                 unix_vlib_cli_output_cursor_left (cf, uf);
1679               for (j = delta; j > 0; j--, cf->cursor++)
1680                 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1681               for (; (cf->current_command + cf->cursor) > save; cf->cursor--)
1682                 unix_vlib_cli_output_cursor_left (cf, uf);
1683               _vec_len (cf->current_command) -= delta;
1684             }
1685         }
1686       cf->search_mode = 0;
1687       cf->excursion = 0;
1688       vec_reset_length (cf->search_key);
1689       break;
1690
1691     case UNIX_CLI_PARSE_ACTION_LEFT:
1692       if (cf->cursor > 0)
1693         {
1694           unix_vlib_cli_output_cursor_left (cf, uf);
1695           cf->cursor--;
1696         }
1697
1698       cf->search_mode = 0;
1699       break;
1700
1701     case UNIX_CLI_PARSE_ACTION_RIGHT:
1702       if (cf->cursor < vec_len (cf->current_command))
1703         {
1704           /* have to emit the character under the cursor */
1705           unix_vlib_cli_output_cooked (cf, uf,
1706                                        cf->current_command + cf->cursor, 1);
1707           cf->cursor++;
1708         }
1709
1710       cf->search_mode = 0;
1711       break;
1712
1713     case UNIX_CLI_PARSE_ACTION_UP:
1714     case UNIX_CLI_PARSE_ACTION_DOWN:
1715       if (!cf->has_history || !cf->history_limit)
1716         break;
1717       cf->search_mode = 0;
1718       /* Erase the command */
1719       for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1720         unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1721       for (; cf->cursor > 0; cf->cursor--)
1722         {
1723           unix_vlib_cli_output_cursor_left (cf, uf);
1724           unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1725           unix_vlib_cli_output_cursor_left (cf, uf);
1726         }
1727       vec_reset_length (cf->current_command);
1728       if (vec_len (cf->command_history))
1729         {
1730           if (action == UNIX_CLI_PARSE_ACTION_UP)
1731             delta = -1;
1732           else
1733             delta = 1;
1734
1735           cf->excursion += delta;
1736
1737           if (cf->excursion == vec_len (cf->command_history))
1738             {
1739               /* down-arrowed to last entry - want a blank line */
1740               _vec_len (cf->current_command) = 0;
1741             }
1742           else if (cf->excursion < 0)
1743             {
1744               /* up-arrowed over the start to the end, want a blank line */
1745               cf->excursion = vec_len (cf->command_history);
1746               _vec_len (cf->current_command) = 0;
1747             }
1748           else
1749             {
1750               if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1751                 /* down-arrowed past end - wrap to start */
1752                 cf->excursion = 0;
1753
1754               /* Print the command at the current position */
1755               prev = cf->command_history[cf->excursion];
1756               vec_validate (cf->current_command, vec_len (prev) - 1);
1757
1758               clib_memcpy (cf->current_command, prev, vec_len (prev));
1759               _vec_len (cf->current_command) = vec_len (prev);
1760               unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1761                                            vec_len (cf->current_command));
1762             }
1763         }
1764       cf->cursor = vec_len (cf->current_command);
1765       break;
1766
1767     case UNIX_CLI_PARSE_ACTION_HOME:
1768       if (vec_len (cf->current_command) && cf->cursor > 0)
1769         {
1770           for (; cf->cursor > 0; cf->cursor--)
1771             unix_vlib_cli_output_cursor_left (cf, uf);
1772         }
1773
1774       cf->search_mode = 0;
1775       break;
1776
1777     case UNIX_CLI_PARSE_ACTION_END:
1778       if (vec_len (cf->current_command) &&
1779           cf->cursor < vec_len (cf->current_command))
1780         {
1781           unix_vlib_cli_output_cooked (cf, uf,
1782                                        cf->current_command + cf->cursor,
1783                                        vec_len (cf->current_command) -
1784                                        cf->cursor);
1785           cf->cursor = vec_len (cf->current_command);
1786         }
1787
1788       cf->search_mode = 0;
1789       break;
1790
1791     case UNIX_CLI_PARSE_ACTION_WORDLEFT:
1792       if (vec_len (cf->current_command) && cf->cursor > 0)
1793         {
1794           unix_vlib_cli_output_cursor_left (cf, uf);
1795           cf->cursor--;
1796
1797           while (cf->cursor && isspace (cf->current_command[cf->cursor]))
1798             {
1799               unix_vlib_cli_output_cursor_left (cf, uf);
1800               cf->cursor--;
1801             }
1802           while (cf->cursor && !isspace (cf->current_command[cf->cursor]))
1803             {
1804               if (isspace (cf->current_command[cf->cursor - 1]))
1805                 break;
1806               unix_vlib_cli_output_cursor_left (cf, uf);
1807               cf->cursor--;
1808             }
1809
1810         }
1811
1812       cf->search_mode = 0;
1813       break;
1814
1815     case UNIX_CLI_PARSE_ACTION_WORDRIGHT:
1816       if (vec_len (cf->current_command) &&
1817           cf->cursor < vec_len (cf->current_command))
1818         {
1819           int e = vec_len (cf->current_command);
1820           j = cf->cursor;
1821           while (j < e && !isspace (cf->current_command[j]))
1822             j++;
1823           while (j < e && isspace (cf->current_command[j]))
1824             j++;
1825           unix_vlib_cli_output_cooked (cf, uf,
1826                                        cf->current_command + cf->cursor,
1827                                        j - cf->cursor);
1828           cf->cursor = j;
1829         }
1830
1831       cf->search_mode = 0;
1832       break;
1833
1834
1835     case UNIX_CLI_PARSE_ACTION_ERASE:
1836       if (vec_len (cf->current_command))
1837         {
1838           if (cf->cursor == vec_len (cf->current_command))
1839             {
1840               unix_vlib_cli_output_cursor_left (cf, uf);
1841               cf->cursor--;
1842               unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1843               cf->cursor++;
1844               unix_vlib_cli_output_cursor_left (cf, uf);
1845               cf->cursor--;
1846               _vec_len (cf->current_command)--;
1847             }
1848           else if (cf->cursor > 0)
1849             {
1850               /* shift everything at & to the right of the cursor left by 1 */
1851               j = vec_len (cf->current_command) - cf->cursor;
1852               memmove (cf->current_command + cf->cursor - 1,
1853                        cf->current_command + cf->cursor, j);
1854               _vec_len (cf->current_command)--;
1855
1856               /* redraw the rest of the line */
1857               unix_vlib_cli_output_cursor_left (cf, uf);
1858               cf->cursor--;
1859               unix_vlib_cli_output_cooked (cf, uf,
1860                                            cf->current_command + cf->cursor,
1861                                            j);
1862               cf->cursor += j;
1863               /* erase last char */
1864               unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1865               cf->cursor++;
1866
1867               /* and shift the terminal cursor back where it should be */
1868               j += 2;           /* account for old string length and offset position */
1869               while (--j)
1870                 {
1871                   unix_vlib_cli_output_cursor_left (cf, uf);
1872                   cf->cursor--;
1873                 }
1874             }
1875         }
1876       cf->search_mode = 0;
1877       cf->excursion = 0;
1878       vec_reset_length (cf->search_key);
1879       break;
1880
1881     case UNIX_CLI_PARSE_ACTION_ERASERIGHT:
1882       if (vec_len (cf->current_command))
1883         {
1884           if (cf->cursor < vec_len (cf->current_command))
1885             {
1886               /* shift everything to the right of the cursor left by 1 */
1887               j = vec_len (cf->current_command) - cf->cursor - 1;
1888               memmove (cf->current_command + cf->cursor,
1889                        cf->current_command + cf->cursor + 1, j);
1890               _vec_len (cf->current_command)--;
1891               /* redraw the rest of the line */
1892               unix_vlib_cli_output_cooked (cf, uf,
1893                                            cf->current_command + cf->cursor,
1894                                            j);
1895               cf->cursor += j;
1896               unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1897               cf->cursor++;
1898               unix_vlib_cli_output_cursor_left (cf, uf);
1899               cf->cursor--;
1900               /* and shift the terminal cursor back where it should be */
1901               if (j)
1902                 {
1903                   unix_vlib_cli_output_cursor_left (cf, uf);
1904                   cf->cursor--;
1905                   while (--j)
1906                     {
1907                       unix_vlib_cli_output_cursor_left (cf, uf);
1908                       cf->cursor--;
1909                     }
1910                 }
1911             }
1912         }
1913       else if (input == 'D' - '@')
1914         {
1915           /* ^D with no command entered = quit */
1916           unix_vlib_cli_output_cooked (cf, uf, (u8 *) "quit\n", 5);
1917           vlib_process_signal_event (um->vlib_main,
1918                                      vlib_current_process (um->vlib_main),
1919                                      UNIX_CLI_PROCESS_EVENT_QUIT,
1920                                      cf - cm->cli_file_pool);
1921         }
1922       cf->search_mode = 0;
1923       cf->excursion = 0;
1924       vec_reset_length (cf->search_key);
1925       break;
1926
1927     case UNIX_CLI_PARSE_ACTION_CLEAR:
1928       /* If we're in ANSI mode, clear the screen.
1929        * Then redraw the prompt and any existing command input, then put
1930        * the cursor back where it was in that line.
1931        */
1932       if (cf->ansi_capable)
1933         unix_vlib_cli_output_cooked (cf, uf,
1934                                      (u8 *) ANSI_CLEAR,
1935                                      sizeof (ANSI_CLEAR) - 1);
1936       else
1937         unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1938
1939       unix_vlib_cli_output_raw (cf, uf,
1940                                 cm->cli_prompt, vec_len (cm->cli_prompt));
1941       unix_vlib_cli_output_cooked (cf, uf,
1942                                    cf->current_command,
1943                                    vec_len (cf->current_command));
1944       j = cf->cursor;
1945       cf->cursor = vec_len (cf->current_command);
1946       for (; cf->cursor > j; cf->cursor--)
1947         unix_vlib_cli_output_cursor_left (cf, uf);
1948
1949       break;
1950
1951     case UNIX_CLI_PARSE_ACTION_TAB:
1952       if (cf->cursor < vec_len (cf->current_command))
1953         {
1954           /* if we are in the middle of a line, complete only if
1955            * the cursor points to whitespace */
1956           if (isspace (cf->current_command[cf->cursor]))
1957             {
1958               /* save and clear any input that is after the cursor */
1959               vec_resize (save, vec_len (cf->current_command) - cf->cursor);
1960               clib_memcpy (save, cf->current_command + cf->cursor,
1961                            vec_len (cf->current_command) - cf->cursor);
1962               _vec_len (cf->current_command) = cf->cursor;
1963             }
1964           else
1965             {
1966               unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1967               break;
1968             }
1969         }
1970       possible_commands =
1971         vlib_cli_get_possible_completions (cf->current_command);
1972       if (vec_len (possible_commands) == 1)
1973         {
1974           u8 *completed = possible_commands[0];
1975           j = cf->cursor;
1976
1977           /* find the last word of current_command */
1978           while (j >= 1 && !isspace (cf->current_command[j - 1]))
1979             {
1980               unix_vlib_cli_output_cursor_left (cf, uf);
1981               cf->cursor--;
1982               j--;
1983             }
1984           _vec_len (cf->current_command) = j;
1985
1986           /* replace it with the newly expanded command */
1987           vec_append (cf->current_command, completed);
1988
1989           /* echo to the terminal */
1990           unix_vlib_cli_output_cooked (cf, uf, completed,
1991                                        vec_len (completed));
1992
1993           /* add one trailing space if needed */
1994           if (vec_len (save) == 0)
1995             {
1996               vec_add1 (cf->current_command, ' ');
1997               unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1998             }
1999
2000           cf->cursor = vec_len (cf->current_command);
2001
2002         }
2003       else if (vec_len (possible_commands) >= 2)
2004         {
2005           u8 **possible_command;
2006           uword max_command_len = 0, min_command_len = ~0;
2007           u32 i;
2008
2009           vec_foreach (possible_command, possible_commands)
2010           {
2011             if (vec_len (*possible_command) > max_command_len)
2012               max_command_len = vec_len (*possible_command);
2013             if (vec_len (*possible_command) < min_command_len)
2014               min_command_len = vec_len (*possible_command);
2015           }
2016
2017           unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2018
2019           i = 0;
2020           vec_foreach (possible_command, possible_commands)
2021           {
2022             if (i + max_command_len >= cf->width)
2023               {
2024                 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2025                 i = 0;
2026               }
2027             unix_vlib_cli_output_cooked (cf, uf, *possible_command,
2028                                          vec_len (*possible_command));
2029             for (j = vec_len (*possible_command); j < max_command_len + 2;
2030                  j++)
2031               {
2032                 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2033               }
2034             i += max_command_len + 2;
2035           }
2036
2037           unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2038
2039           /* rewrite prompt */
2040           unix_cli_cli_prompt (cf, uf);
2041           unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2042                                        vec_len (cf->current_command));
2043
2044           /* count length of last word */
2045           j = cf->cursor;
2046           i = 0;
2047           while (j >= 1 && !isspace (cf->current_command[j - 1]))
2048             {
2049               j--;
2050               i++;
2051             }
2052
2053           /* determine smallest common command */
2054           for (; i < min_command_len; i++)
2055             {
2056               u8 common = '\0';
2057               int stop = 0;
2058
2059               vec_foreach (possible_command, possible_commands)
2060               {
2061                 if (common == '\0')
2062                   {
2063                     common = (*possible_command)[i];
2064                   }
2065                 else if (common != (*possible_command)[i])
2066                   {
2067                     stop = 1;
2068                     break;
2069                   }
2070               }
2071
2072               if (!stop)
2073                 {
2074                   vec_add1 (cf->current_command, common);
2075                   cf->cursor++;
2076                   unix_vlib_cli_output_cooked (cf, uf, (u8 *) & common, 1);
2077                 }
2078               else
2079                 {
2080                   break;
2081                 }
2082             }
2083         }
2084       else
2085         {
2086           unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
2087         }
2088
2089       if (vec_len (save) > 0)
2090         {
2091           /* restore remaining input if tab was hit in the middle of a line */
2092           unix_vlib_cli_output_cooked (cf, uf, save, vec_len (save));
2093           cf->cursor += vec_len (save);
2094           for (j = 0; j < vec_len (save); j++, cf->cursor--)
2095             unix_vlib_cli_output_cursor_left (cf, uf);
2096           vec_append (cf->current_command, save);
2097           vec_free (save);
2098         }
2099       vec_free (possible_commands);
2100
2101       break;
2102     case UNIX_CLI_PARSE_ACTION_YANK:
2103       /* TODO */
2104       break;
2105
2106
2107     case UNIX_CLI_PARSE_ACTION_PAGER_QUIT:
2108     pager_quit:
2109       unix_cli_pager_prompt_erase (cf, uf);
2110       unix_cli_pager_reset (cf);
2111       unix_cli_cli_prompt (cf, uf);
2112       break;
2113
2114     case UNIX_CLI_PARSE_ACTION_PAGER_NEXT:
2115     case UNIX_CLI_PARSE_ACTION_PAGER_PGDN:
2116       /* show next page of the buffer */
2117       if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
2118         {
2119           u8 *line = NULL;
2120           unix_cli_pager_index_t *pi = NULL;
2121
2122           int m = cf->pager_start + (cf->height - 1);
2123           unix_cli_pager_prompt_erase (cf, uf);
2124           for (j = m;
2125                j < vec_len (cf->pager_index) && cf->pager_start < m;
2126                j++, cf->pager_start++)
2127             {
2128               pi = &cf->pager_index[j];
2129               line = cf->pager_vector[pi->line] + pi->offset;
2130               unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2131             }
2132           /* if the last line didn't end in newline, add a newline */
2133           if (pi && line[pi->length - 1] != '\n')
2134             unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2135           unix_cli_pager_prompt (cf, uf);
2136         }
2137       else
2138         {
2139           if (action == UNIX_CLI_PARSE_ACTION_PAGER_NEXT)
2140             /* no more in buffer, exit, but only if it was <space> */
2141             goto pager_quit;
2142         }
2143       break;
2144
2145     case UNIX_CLI_PARSE_ACTION_PAGER_DN:
2146     case UNIX_CLI_PARSE_ACTION_PAGER_CRLF:
2147       /* display the next line of the buffer */
2148       if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
2149         {
2150           u8 *line;
2151           unix_cli_pager_index_t *pi;
2152
2153           unix_cli_pager_prompt_erase (cf, uf);
2154           pi = &cf->pager_index[cf->pager_start + (cf->height - 1)];
2155           line = cf->pager_vector[pi->line] + pi->offset;
2156           unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2157           cf->pager_start++;
2158           /* if the last line didn't end in newline, add a newline */
2159           if (line[pi->length - 1] != '\n')
2160             unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2161           unix_cli_pager_prompt (cf, uf);
2162         }
2163       else
2164         {
2165           if (action == UNIX_CLI_PARSE_ACTION_PAGER_CRLF)
2166             /* no more in buffer, exit, but only if it was <enter> */
2167             goto pager_quit;
2168         }
2169
2170       break;
2171
2172     case UNIX_CLI_PARSE_ACTION_PAGER_UP:
2173       /* scroll the page back one line */
2174       if (cf->pager_start > 0)
2175         {
2176           u8 *line = NULL;
2177           unix_cli_pager_index_t *pi = NULL;
2178
2179           cf->pager_start--;
2180           if (cf->ansi_capable)
2181             {
2182               pi = &cf->pager_index[cf->pager_start];
2183               line = cf->pager_vector[pi->line] + pi->offset;
2184               unix_cli_pager_prompt_erase (cf, uf);
2185               unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SCROLLDN,
2186                                            sizeof (ANSI_SCROLLDN) - 1);
2187               unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SAVECURSOR,
2188                                            sizeof (ANSI_SAVECURSOR) - 1);
2189               unix_cli_ansi_cursor (cf, uf, 1, 1);
2190               unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_CLEARLINE,
2191                                            sizeof (ANSI_CLEARLINE) - 1);
2192               unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2193               unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_RESTCURSOR,
2194                                            sizeof (ANSI_RESTCURSOR) - 1);
2195               unix_cli_pager_prompt_erase (cf, uf);
2196               unix_cli_pager_prompt (cf, uf);
2197             }
2198           else
2199             {
2200               int m = cf->pager_start + (cf->height - 1);
2201               unix_cli_pager_prompt_erase (cf, uf);
2202               for (j = cf->pager_start;
2203                    j < vec_len (cf->pager_index) && j < m; j++)
2204                 {
2205                   pi = &cf->pager_index[j];
2206                   line = cf->pager_vector[pi->line] + pi->offset;
2207                   unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2208                 }
2209               /* if the last line didn't end in newline, add a newline */
2210               if (pi && line[pi->length - 1] != '\n')
2211                 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2212               unix_cli_pager_prompt (cf, uf);
2213             }
2214         }
2215       break;
2216
2217     case UNIX_CLI_PARSE_ACTION_PAGER_TOP:
2218       /* back to the first page of the buffer */
2219       if (cf->pager_start > 0)
2220         {
2221           u8 *line = NULL;
2222           unix_cli_pager_index_t *pi = NULL;
2223
2224           cf->pager_start = 0;
2225           int m = cf->pager_start + (cf->height - 1);
2226           unix_cli_pager_prompt_erase (cf, uf);
2227           for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2228                j++)
2229             {
2230               pi = &cf->pager_index[j];
2231               line = cf->pager_vector[pi->line] + pi->offset;
2232               unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2233             }
2234           /* if the last line didn't end in newline, add a newline */
2235           if (pi && line[pi->length - 1] != '\n')
2236             unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2237           unix_cli_pager_prompt (cf, uf);
2238         }
2239       break;
2240
2241     case UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM:
2242       /* skip to the last page of the buffer */
2243       if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
2244         {
2245           u8 *line = NULL;
2246           unix_cli_pager_index_t *pi = NULL;
2247
2248           cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
2249           unix_cli_pager_prompt_erase (cf, uf);
2250           unix_cli_pager_message (cf, uf, "skipping", "\n");
2251           for (j = cf->pager_start; j < vec_len (cf->pager_index); j++)
2252             {
2253               pi = &cf->pager_index[j];
2254               line = cf->pager_vector[pi->line] + pi->offset;
2255               unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2256             }
2257           /* if the last line didn't end in newline, add a newline */
2258           if (pi && line[pi->length - 1] != '\n')
2259             unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2260           unix_cli_pager_prompt (cf, uf);
2261         }
2262       break;
2263
2264     case UNIX_CLI_PARSE_ACTION_PAGER_PGUP:
2265       /* wander back one page in the buffer */
2266       if (cf->pager_start > 0)
2267         {
2268           u8 *line = NULL;
2269           unix_cli_pager_index_t *pi = NULL;
2270           int m;
2271
2272           if (cf->pager_start >= cf->height)
2273             cf->pager_start -= cf->height - 1;
2274           else
2275             cf->pager_start = 0;
2276           m = cf->pager_start + cf->height - 1;
2277           unix_cli_pager_prompt_erase (cf, uf);
2278           for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2279                j++)
2280             {
2281               pi = &cf->pager_index[j];
2282               line = cf->pager_vector[pi->line] + pi->offset;
2283               unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2284             }
2285           /* if the last line didn't end in newline, add a newline */
2286           if (pi && line[pi->length - 1] != '\n')
2287             unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2288           unix_cli_pager_prompt (cf, uf);
2289         }
2290       break;
2291
2292     case UNIX_CLI_PARSE_ACTION_PAGER_REDRAW:
2293       /* Redraw the current pager screen */
2294       unix_cli_pager_redraw (cf, uf);
2295       break;
2296
2297     case UNIX_CLI_PARSE_ACTION_PAGER_SEARCH:
2298       /* search forwards in the buffer */
2299       break;
2300
2301
2302     case UNIX_CLI_PARSE_ACTION_CRLF:
2303     crlf:
2304       unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2305
2306       if (cf->has_history && cf->history_limit)
2307         {
2308           if (cf->command_history
2309               && vec_len (cf->command_history) >= cf->history_limit)
2310             {
2311               vec_free (cf->command_history[0]);
2312               vec_delete (cf->command_history, 1, 0);
2313             }
2314           /* Don't add blank lines to the cmd history */
2315           if (vec_len (cf->current_command))
2316             {
2317               /* Don't duplicate the previous command */
2318               j = vec_len (cf->command_history);
2319               if (j == 0 ||
2320                   (vec_len (cf->current_command) !=
2321                    vec_len (cf->command_history[j - 1])
2322                    || memcmp (cf->current_command, cf->command_history[j - 1],
2323                               vec_len (cf->current_command)) != 0))
2324                 {
2325                   /* copy the command to the history */
2326                   u8 *c = 0;
2327                   vec_append (c, cf->current_command);
2328                   vec_add1 (cf->command_history, c);
2329                   cf->command_number++;
2330                 }
2331             }
2332           cf->excursion = vec_len (cf->command_history);
2333         }
2334
2335       cf->search_mode = 0;
2336       vec_reset_length (cf->search_key);
2337       cf->cursor = 0;
2338
2339       return 0;
2340
2341     case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2342     case UNIX_CLI_PARSE_ACTION_NOMATCH:
2343       if (vec_len (cf->pager_index))
2344         {
2345           /* no-op for now */
2346         }
2347       else if (cf->has_history && cf->search_mode != 0 && isprint (input))
2348         {
2349           int k, limit, offset;
2350           u8 *item;
2351
2352           vec_add1 (cf->search_key, input);
2353
2354         search_again:
2355           for (j = 0; j < vec_len (cf->command_history); j++)
2356             {
2357               if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
2358                 cf->excursion = 0;
2359               else if (cf->excursion < 0)
2360                 cf->excursion = vec_len (cf->command_history) - 1;
2361
2362               item = cf->command_history[cf->excursion];
2363
2364               limit = (vec_len (cf->search_key) > vec_len (item)) ?
2365                 vec_len (item) : vec_len (cf->search_key);
2366
2367               for (offset = 0; offset <= vec_len (item) - limit; offset++)
2368                 {
2369                   for (k = 0; k < limit; k++)
2370                     {
2371                       if (item[k + offset] != cf->search_key[k])
2372                         goto next_offset;
2373                     }
2374                   goto found_at_offset;
2375
2376                 next_offset:
2377                   ;
2378                 }
2379               goto next;
2380
2381             found_at_offset:
2382               for (; cf->cursor > 0; cf->cursor--)
2383                 {
2384                   unix_vlib_cli_output_cursor_left (cf, uf);
2385                   unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2386                   unix_vlib_cli_output_cursor_left (cf, uf);
2387                 }
2388
2389               vec_validate (cf->current_command, vec_len (item) - 1);
2390               clib_memcpy (cf->current_command, item, vec_len (item));
2391               _vec_len (cf->current_command) = vec_len (item);
2392
2393               unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2394                                            vec_len (cf->current_command));
2395               cf->cursor = vec_len (cf->current_command);
2396               goto found;
2397
2398             next:
2399               cf->excursion += cf->search_mode;
2400             }
2401
2402           unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\nNo match...", 12);
2403           vec_reset_length (cf->search_key);
2404           vec_reset_length (cf->current_command);
2405           cf->search_mode = 0;
2406           cf->cursor = 0;
2407           goto crlf;
2408         }
2409       else if (isprint (input)) /* skip any errant control codes */
2410         {
2411           if (cf->cursor == vec_len (cf->current_command))
2412             {
2413               /* Append to end */
2414               vec_add1 (cf->current_command, input);
2415               cf->cursor++;
2416
2417               /* Echo the character back to the client */
2418               unix_vlib_cli_output_cooked (cf, uf, &input, 1);
2419             }
2420           else
2421             {
2422               /* Insert at cursor: resize +1 byte, move everything over */
2423               j = vec_len (cf->current_command) - cf->cursor;
2424               vec_add1 (cf->current_command, (u8) 'A');
2425               memmove (cf->current_command + cf->cursor + 1,
2426                        cf->current_command + cf->cursor, j);
2427               cf->current_command[cf->cursor] = input;
2428               /* Redraw the line */
2429               j++;
2430               unix_vlib_cli_output_cooked (cf, uf,
2431                                            cf->current_command + cf->cursor,
2432                                            j);
2433               cf->cursor += j;
2434               j--;
2435               /* Put terminal cursor back */
2436               for (; j > 0; j--, cf->cursor--)
2437                 unix_vlib_cli_output_cursor_left (cf, uf);
2438             }
2439         }
2440       else
2441         {
2442           /* no-op - not printable or otherwise not actionable */
2443         }
2444
2445     found:
2446
2447       break;
2448
2449     case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2450       break;
2451     }
2452   return 1;
2453 }
2454
2455 /** @brief Process input bytes on a stream to provide line editing and
2456  * command history in the CLI. */
2457 static int
2458 unix_cli_line_edit (unix_cli_main_t * cm, unix_main_t * um,
2459                     clib_file_main_t * fm, unix_cli_file_t * cf)
2460 {
2461   clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2462   int i;
2463
2464   for (i = 0; i < vec_len (cf->input_vector); i++)
2465     {
2466       unix_cli_parse_action_t action;
2467       i32 matched = 0;
2468       unix_cli_parse_actions_t *a;
2469
2470       /* If we're in the pager mode, search the pager actions */
2471       a =
2472         vec_len (cf->pager_index) ? unix_cli_parse_pager :
2473         unix_cli_parse_strings;
2474
2475       /* See if the input buffer is some sort of control code */
2476       action = unix_cli_match_action (a, &cf->input_vector[i],
2477                                       vec_len (cf->input_vector) - i,
2478                                       &matched);
2479
2480       switch (action)
2481         {
2482         case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2483           if (i)
2484             {
2485               /* There was a partial match which means we need more bytes
2486                * than the input buffer currently has.
2487                * Since the bytes before here have been processed, shift
2488                * the remaining contents to the start of the input buffer.
2489                */
2490               vec_delete (cf->input_vector, i, 0);
2491             }
2492           return 1;             /* wait for more */
2493
2494         case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2495           /* process telnet options */
2496           matched = unix_cli_process_telnet (um, cf, uf,
2497                                              cf->input_vector + i,
2498                                              vec_len (cf->input_vector) - i);
2499           if (matched < 0)
2500             {
2501               /* There was a partial match which means we need more bytes
2502                * than the input buffer currently has.
2503                */
2504               if (i)
2505                 {
2506                   /*
2507                    * Since the bytes before here have been processed, shift
2508                    * the remaining contents to the start of the input buffer.
2509                    */
2510                   vec_delete (cf->input_vector, i, 0);
2511                 }
2512               return 1;         /* wait for more */
2513             }
2514           break;
2515
2516         default:
2517           /* If telnet option processing switched us to line mode, get us
2518            * out of here!
2519            */
2520           if (cf->line_mode)
2521             {
2522               vec_delete (cf->input_vector, i, 0);
2523               cf->current_command = cf->input_vector;
2524               return 0;
2525             }
2526
2527           /* process the action */
2528           if (!unix_cli_line_process_one (cm, um, cf, uf,
2529                                           cf->input_vector[i], action))
2530             {
2531               /* CRLF found. Consume the bytes from the input_vector */
2532               vec_delete (cf->input_vector, i + matched, 0);
2533               /* And tell our caller to execute cf->input_command */
2534               return 0;
2535             }
2536         }
2537
2538       i += matched;
2539     }
2540
2541   vec_reset_length (cf->input_vector);
2542   return 1;
2543 }
2544
2545 /** @brief Process input to a CLI session. */
2546 static void
2547 unix_cli_process_input (unix_cli_main_t * cm, uword cli_file_index)
2548 {
2549   unix_main_t *um = &unix_main;
2550   clib_file_main_t *fm = &file_main;
2551   clib_file_t *uf;
2552   unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2553   unformat_input_t input;
2554   int vlib_parse_eval (u8 *);
2555
2556   cm->current_input_file_index = cli_file_index;
2557
2558 more:
2559   /* Try vlibplex first.  Someday... */
2560   if (0 && vlib_parse_eval (cf->input_vector) == 0)
2561     goto done;
2562
2563
2564   if (cf->line_mode)
2565     {
2566       /* just treat whatever we got as a complete line of input */
2567       cf->current_command = cf->input_vector;
2568     }
2569   else
2570     {
2571       /* Line edit, echo, etc. */
2572       if (unix_cli_line_edit (cm, um, fm, cf))
2573         /* want more input */
2574         return;
2575     }
2576
2577   if (um->log_fd)
2578     {
2579       static u8 *lv;
2580       vec_reset_length (lv);
2581       lv = format (lv, "%U[%d]: %v",
2582                    format_timeval, 0 /* current bat-time */ ,
2583                    0 /* current bat-format */ ,
2584                    cli_file_index, cf->current_command);
2585       if ((vec_len (cf->current_command) > 0) &&
2586           (cf->current_command[vec_len (cf->current_command) - 1] != '\n'))
2587         lv = format (lv, "\n");
2588       int rv __attribute__ ((unused)) = write (um->log_fd, lv, vec_len (lv));
2589     }
2590
2591   /* Run the command through the macro processor */
2592   if (vec_len (cf->current_command))
2593     {
2594       u8 *expanded;
2595       vec_validate (cf->current_command, vec_len (cf->current_command));
2596       cf->current_command[vec_len (cf->current_command) - 1] = 0;
2597       /* The macro expander expects proper C-strings, not vectors */
2598       expanded = (u8 *) clib_macro_eval (&cf->macro_main,
2599                                          (i8 *) cf->current_command,
2600                                          1 /* complain */ ,
2601                                          0 /* level */ ,
2602                                          8 /* max_level */ );
2603       /* Macro processor NULL terminates the return */
2604       _vec_len (expanded) -= 1;
2605       vec_reset_length (cf->current_command);
2606       vec_append (cf->current_command, expanded);
2607       vec_free (expanded);
2608     }
2609
2610   /* Build an unformat structure around our command */
2611   unformat_init_vector (&input, cf->current_command);
2612
2613   /* Remove leading white space from input. */
2614   (void) unformat (&input, "");
2615
2616   cf->pager_start = 0;          /* start a new pager session */
2617
2618   if (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
2619     vlib_cli_input (um->vlib_main, &input, unix_vlib_cli_output,
2620                     cli_file_index);
2621
2622   /* Zero buffer since otherwise unformat_free will call vec_free on it. */
2623   input.buffer = 0;
2624
2625   unformat_free (&input);
2626
2627   /* Re-fetch pointer since pool may have moved. */
2628   cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2629   uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2630
2631 done:
2632   /* reset vector; we'll re-use it later  */
2633   if (cf->line_mode)
2634     {
2635       vec_reset_length (cf->input_vector);
2636       cf->current_command = 0;
2637     }
2638   else
2639     {
2640       vec_reset_length (cf->current_command);
2641     }
2642
2643   if (cf->no_pager == 2)
2644     {
2645       /* Pager was programmatically disabled */
2646       unix_cli_pager_message (cf, uf, "pager buffer overflowed", "\n");
2647       cf->no_pager = um->cli_no_pager;
2648     }
2649
2650   if (vec_len (cf->pager_index) == 0
2651       || vec_len (cf->pager_index) < cf->height)
2652     {
2653       /* There was no need for the pager */
2654       unix_cli_pager_reset (cf);
2655
2656       /* Prompt. */
2657       unix_cli_cli_prompt (cf, uf);
2658     }
2659   else
2660     {
2661       /* Display the pager prompt */
2662       unix_cli_pager_prompt (cf, uf);
2663     }
2664
2665   /* Any residual data in the input vector? */
2666   if (vec_len (cf->input_vector))
2667     goto more;
2668
2669   /* For non-interactive sessions send a NUL byte.
2670    * Specifically this is because vppctl needs to see some traffic in
2671    * order to move on to closing the session. Commands with no output
2672    * would thus cause vppctl to hang indefinitely in non-interactive mode
2673    * since there is also no prompt sent after the command completes.
2674    */
2675   if (!cf->is_interactive)
2676     unix_vlib_cli_output_raw (cf, uf, (u8 *) "\0", 1);
2677 }
2678
2679 /** Destroy a CLI session.
2680  * @note If we destroy the @c stdin session this additionally signals
2681  *       the shutdown of VPP.
2682  */
2683 static void
2684 unix_cli_kill (unix_cli_main_t * cm, uword cli_file_index)
2685 {
2686   unix_main_t *um = &unix_main;
2687   clib_file_main_t *fm = &file_main;
2688   unix_cli_file_t *cf;
2689   clib_file_t *uf;
2690   int i;
2691
2692   /* Validate cli_file_index */
2693   if (pool_is_free_index (cm->cli_file_pool, cli_file_index))
2694     return;
2695
2696   cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2697   uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2698
2699   /* Quit/EOF on stdin means quit program. */
2700   if (uf->file_descriptor == STDIN_FILENO)
2701     clib_longjmp (&um->vlib_main->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
2702
2703   vec_free (cf->current_command);
2704   vec_free (cf->search_key);
2705
2706   for (i = 0; i < vec_len (cf->command_history); i++)
2707     vec_free (cf->command_history[i]);
2708
2709   vec_free (cf->command_history);
2710
2711   clib_file_del (fm, uf);
2712
2713   unix_cli_file_free (cf);
2714   clib_macro_free (&cf->macro_main);
2715   pool_put (cm->cli_file_pool, cf);
2716 }
2717
2718 /** Handle system events. */
2719 static uword
2720 unix_cli_process (vlib_main_t * vm,
2721                   vlib_node_runtime_t * rt, vlib_frame_t * f)
2722 {
2723   unix_cli_main_t *cm = &unix_cli_main;
2724   uword i, *data = 0;
2725
2726   while (1)
2727     {
2728       unix_cli_process_event_type_t event_type;
2729       vlib_process_wait_for_event (vm);
2730       event_type = vlib_process_get_events (vm, &data);
2731
2732       switch (event_type)
2733         {
2734         case UNIX_CLI_PROCESS_EVENT_READ_READY:
2735           for (i = 0; i < vec_len (data); i++)
2736             unix_cli_process_input (cm, data[i]);
2737           break;
2738
2739         case UNIX_CLI_PROCESS_EVENT_QUIT:
2740           /* Kill this process. */
2741           for (i = 0; i < vec_len (data); i++)
2742             unix_cli_kill (cm, data[i]);
2743           goto done;
2744         }
2745
2746       if (data)
2747         _vec_len (data) = 0;
2748     }
2749
2750 done:
2751   vec_free (data);
2752
2753   vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
2754
2755   /* Add node index so we can re-use this process later. */
2756   vec_add1 (cm->unused_cli_process_node_indices, rt->node_index);
2757
2758   return 0;
2759 }
2760
2761 /** Called when a CLI session file descriptor can be written to without
2762  * blocking. */
2763 static clib_error_t *
2764 unix_cli_write_ready (clib_file_t * uf)
2765 {
2766   unix_cli_main_t *cm = &unix_cli_main;
2767   unix_cli_file_t *cf;
2768   int n;
2769
2770   cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2771
2772   /* Flush output vector. */
2773   if (cf->is_socket)
2774     /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
2775     n = send (uf->file_descriptor,
2776               cf->output_vector, vec_len (cf->output_vector), MSG_NOSIGNAL);
2777   else
2778     n = write (uf->file_descriptor,
2779                cf->output_vector, vec_len (cf->output_vector));
2780
2781   if (n < 0 && errno != EAGAIN)
2782     {
2783       if (errno == EPIPE)
2784         {
2785           /* connection closed on us */
2786           unix_main_t *um = &unix_main;
2787           cf->has_epipe = 1;
2788           vlib_process_signal_event (um->vlib_main, cf->process_node_index,
2789                                      UNIX_CLI_PROCESS_EVENT_QUIT,
2790                                      uf->private_data);
2791         }
2792       else
2793         {
2794           return clib_error_return_unix (0, "write");
2795         }
2796     }
2797
2798   else if (n > 0)
2799     unix_cli_del_pending_output (uf, cf, n);
2800
2801   return /* no error */ 0;
2802 }
2803
2804 /** Called when a CLI session file descriptor has data to be read. */
2805 static clib_error_t *
2806 unix_cli_read_ready (clib_file_t * uf)
2807 {
2808   unix_main_t *um = &unix_main;
2809   unix_cli_main_t *cm = &unix_cli_main;
2810   unix_cli_file_t *cf;
2811   uword l;
2812   int n, n_read, n_try;
2813
2814   cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2815
2816   n = n_try = 4096;
2817   while (n == n_try)
2818     {
2819       l = vec_len (cf->input_vector);
2820       vec_resize (cf->input_vector, l + n_try);
2821
2822       n = read (uf->file_descriptor, cf->input_vector + l, n_try);
2823
2824       /* Error? */
2825       if (n < 0 && errno != EAGAIN)
2826         return clib_error_return_unix (0, "read");
2827
2828       n_read = n < 0 ? 0 : n;
2829       _vec_len (cf->input_vector) = l + n_read;
2830     }
2831
2832   if (!(n < 0))
2833     vlib_process_signal_event (um->vlib_main,
2834                                cf->process_node_index,
2835                                (n_read == 0
2836                                 ? UNIX_CLI_PROCESS_EVENT_QUIT
2837                                 : UNIX_CLI_PROCESS_EVENT_READ_READY),
2838                                /* event data */ uf->private_data);
2839
2840   return /* no error */ 0;
2841 }
2842
2843 /** Called when a CLI session file descriptor has an error condition. */
2844 static clib_error_t *
2845 unix_cli_error_detected (clib_file_t * uf)
2846 {
2847   unix_main_t *um = &unix_main;
2848   unix_cli_main_t *cm = &unix_cli_main;
2849   unix_cli_file_t *cf;
2850
2851   cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2852   cf->has_epipe = 1;            /* prevent writes while the close is pending */
2853   vlib_process_signal_event (um->vlib_main,
2854                              cf->process_node_index,
2855                              UNIX_CLI_PROCESS_EVENT_QUIT,
2856                              /* event data */ uf->private_data);
2857
2858   return /* no error */ 0;
2859 }
2860
2861 /** Store a new CLI session.
2862  * @param name The name of the session.
2863  * @param fd   The file descriptor for the session I/O.
2864  * @return The session ID.
2865  */
2866 static u32
2867 unix_cli_file_add (unix_cli_main_t * cm, char *name, int fd)
2868 {
2869   unix_main_t *um = &unix_main;
2870   clib_file_main_t *fm = &file_main;
2871   unix_cli_file_t *cf;
2872   clib_file_t template = { 0 };
2873   vlib_main_t *vm = um->vlib_main;
2874   vlib_node_t *n = 0;
2875   u8 *file_desc = 0;
2876
2877   file_desc = format (0, "%s", name);
2878
2879   name = (char *) format (0, "unix-cli-%s", name);
2880
2881   if (vec_len (cm->unused_cli_process_node_indices) > 0)
2882     {
2883       uword l = vec_len (cm->unused_cli_process_node_indices);
2884       int i;
2885       vlib_main_t *this_vlib_main;
2886       u8 *old_name = 0;
2887
2888       /*
2889        * Nodes are bulk-copied, so node name pointers are shared.
2890        * Find the cli node in all graph replicas, and give all of them
2891        * the same new name.
2892        * Then, throw away the old shared name-vector.
2893        */
2894       for (i = 0; i < vec_len (vlib_mains); i++)
2895         {
2896           this_vlib_main = vlib_mains[i];
2897           if (this_vlib_main == 0)
2898             continue;
2899           n = vlib_get_node (this_vlib_main,
2900                              cm->unused_cli_process_node_indices[l - 1]);
2901           old_name = n->name;
2902           n->name = (u8 *) name;
2903         }
2904       vec_free (old_name);
2905
2906       vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
2907
2908       _vec_len (cm->unused_cli_process_node_indices) = l - 1;
2909     }
2910   else
2911     {
2912       static vlib_node_registration_t r = {
2913         .function = unix_cli_process,
2914         .type = VLIB_NODE_TYPE_PROCESS,
2915         .process_log2_n_stack_bytes = 18,
2916       };
2917
2918       r.name = name;
2919
2920       vlib_worker_thread_barrier_sync (vm);
2921
2922       vlib_register_node (vm, &r);
2923       vec_free (name);
2924
2925       n = vlib_get_node (vm, r.index);
2926       vlib_worker_thread_node_runtime_update ();
2927       vlib_worker_thread_barrier_release (vm);
2928     }
2929
2930   pool_get (cm->cli_file_pool, cf);
2931   clib_memset (cf, 0, sizeof (*cf));
2932   clib_macro_init (&cf->macro_main);
2933
2934   template.read_function = unix_cli_read_ready;
2935   template.write_function = unix_cli_write_ready;
2936   template.error_function = unix_cli_error_detected;
2937   template.file_descriptor = fd;
2938   template.private_data = cf - cm->cli_file_pool;
2939   template.description = file_desc;
2940
2941   cf->process_node_index = n->index;
2942   cf->clib_file_index = clib_file_add (fm, &template);
2943   cf->output_vector = 0;
2944   cf->input_vector = 0;
2945   vec_validate (cf->current_command, 0);
2946   _vec_len (cf->current_command) = 0;
2947
2948   vlib_start_process (vm, n->runtime_index);
2949
2950   vlib_process_t *p = vlib_get_process_from_node (vm, n);
2951   p->output_function = unix_vlib_cli_output;
2952   p->output_function_arg = cf - cm->cli_file_pool;
2953
2954   return cf - cm->cli_file_pool;
2955 }
2956
2957 /** Telnet listening socket has a new connection. */
2958 static clib_error_t *
2959 unix_cli_listen_read_ready (clib_file_t * uf)
2960 {
2961   unix_main_t *um = &unix_main;
2962   clib_file_main_t *fm = &file_main;
2963   unix_cli_main_t *cm = &unix_cli_main;
2964   clib_socket_t *s = &um->cli_listen_socket;
2965   clib_socket_t client;
2966   char *client_name;
2967   clib_error_t *error;
2968   unix_cli_file_t *cf;
2969   u32 cf_index;
2970   int one;
2971
2972   error = clib_socket_accept (s, &client);
2973   if (error)
2974     return error;
2975
2976   /* Disable Nagle, ignore any errors doing so eg on PF_LOCAL socket */
2977   one = 1;
2978   (void) setsockopt (client.fd, IPPROTO_TCP, TCP_NODELAY,
2979                      (void *) &one, sizeof (one));
2980
2981   client_name = (char *) format (0, "%U%c", format_sockaddr, &client.peer, 0);
2982
2983   cf_index = unix_cli_file_add (cm, client_name, client.fd);
2984   cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2985   cf->is_socket = 1;
2986
2987   /* No longer need CLIB version of socket. */
2988   clib_socket_free (&client);
2989   vec_free (client_name);
2990
2991   /* if we're supposed to run telnet session in character mode (default) */
2992   if (um->cli_line_mode == 0)
2993     {
2994       /*
2995        * Set telnet client character mode, echo on, suppress "go-ahead".
2996        * Technically these should be negotiated, but this works.
2997        */
2998       u8 charmode_option[] = {
2999         IAC, WONT, TELOPT_LINEMODE,     /* server will do char-by-char */
3000         IAC, DONT, TELOPT_LINEMODE,     /* client should do char-by-char */
3001         IAC, WILL, TELOPT_SGA,  /* server willl supress GA */
3002         IAC, DO, TELOPT_SGA,    /* client should supress Go Ahead */
3003         IAC, WILL, TELOPT_ECHO, /* server will do echo */
3004         IAC, DONT, TELOPT_ECHO, /* client should not echo */
3005         IAC, DO, TELOPT_TTYPE,  /* client should tell us its term type */
3006         IAC, SB, TELOPT_TTYPE, 1, IAC, SE,      /* now tell me ttype */
3007         IAC, DO, TELOPT_NAWS,   /* client should tell us its window sz */
3008         IAC, SB, TELOPT_NAWS, 1, IAC, SE,       /* now tell me window size */
3009       };
3010
3011       /* Enable history on this CLI */
3012       cf->history_limit = um->cli_history_limit;
3013       cf->has_history = cf->history_limit != 0;
3014
3015       /* This is an interactive session until we decide otherwise */
3016       cf->is_interactive = 1;
3017
3018       /* Make sure this session is in line mode */
3019       cf->line_mode = 0;
3020
3021       /* We need CRLF */
3022       cf->crlf_mode = 1;
3023
3024       /* Setup the pager */
3025       cf->no_pager = um->cli_no_pager;
3026
3027       /* Default terminal dimensions, should the terminal
3028        * fail to provide any.
3029        */
3030       cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3031       cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3032
3033       /* Send the telnet options */
3034       uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3035       unix_vlib_cli_output_raw (cf, uf, charmode_option,
3036                                 ARRAY_LEN (charmode_option));
3037
3038       if (cm->new_session_process_node_index == ~0)
3039         {
3040           /* Create thw new session deadline process */
3041           cm->new_session_process_node_index =
3042             vlib_process_create (um->vlib_main, "unix-cli-new-session",
3043                                  unix_cli_new_session_process,
3044                                  16 /* log2_n_stack_bytes */ );
3045         }
3046
3047       /* In case the client doesn't negotiate terminal type, register
3048        * our session with a process that will emit the prompt if
3049        * a deadline passes */
3050       vlib_process_signal_event (um->vlib_main,
3051                                  cm->new_session_process_node_index,
3052                                  UNIX_CLI_NEW_SESSION_EVENT_ADD, cf_index);
3053
3054     }
3055
3056   return error;
3057 }
3058
3059 /** The system terminal has informed us that the window size
3060  * has changed.
3061  */
3062 static void
3063 unix_cli_resize_interrupt (int signum)
3064 {
3065   clib_file_main_t *fm = &file_main;
3066   unix_cli_main_t *cm = &unix_cli_main;
3067   unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
3068                                            cm->stdin_cli_file_index);
3069   clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3070   struct winsize ws;
3071   (void) signum;
3072
3073   /* Terminal resized, fetch the new size */
3074   if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) < 0)
3075     {
3076       /* "Should never happen..." */
3077       clib_unix_warning ("TIOCGWINSZ");
3078       /* We can't trust ws.XXX... */
3079       return;
3080     }
3081
3082   cf->width = ws.ws_col;
3083   if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
3084     cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
3085   if (cf->width == 0)
3086     cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3087
3088   cf->height = ws.ws_row;
3089   if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
3090     cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
3091   if (cf->height == 0)
3092     cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3093
3094   /* Reindex the pager buffer */
3095   unix_cli_pager_reindex (cf);
3096
3097   /* Redraw the page */
3098   unix_cli_pager_redraw (cf, uf);
3099 }
3100
3101 /** Handle configuration directives in the @em unix section. */
3102 static clib_error_t *
3103 unix_cli_config (vlib_main_t * vm, unformat_input_t * input)
3104 {
3105   unix_main_t *um = &unix_main;
3106   clib_file_main_t *fm = &file_main;
3107   unix_cli_main_t *cm = &unix_cli_main;
3108   int flags;
3109   clib_error_t *error = 0;
3110   unix_cli_file_t *cf;
3111   u32 cf_index;
3112   struct termios tio;
3113   struct sigaction sa;
3114   struct winsize ws;
3115   u8 *term;
3116
3117   /* We depend on unix flags being set. */
3118   if ((error = vlib_call_config_function (vm, unix_config)))
3119     return error;
3120
3121   if (um->flags & UNIX_FLAG_INTERACTIVE)
3122     {
3123       /* Set stdin to be non-blocking. */
3124       if ((flags = fcntl (STDIN_FILENO, F_GETFL, 0)) < 0)
3125         flags = 0;
3126       (void) fcntl (STDIN_FILENO, F_SETFL, flags | O_NONBLOCK);
3127
3128       cf_index = unix_cli_file_add (cm, "stdin", STDIN_FILENO);
3129       cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
3130       cm->stdin_cli_file_index = cf_index;
3131
3132       /* If stdin is a tty and we are using chacracter mode, enable
3133        * history on the CLI and set the tty line discipline accordingly. */
3134       if (isatty (STDIN_FILENO) && um->cli_line_mode == 0)
3135         {
3136           /* Capture terminal resize events */
3137           clib_memset (&sa, 0, sizeof (sa));
3138           sa.sa_handler = unix_cli_resize_interrupt;
3139           if (sigaction (SIGWINCH, &sa, 0) < 0)
3140             clib_panic ("sigaction");
3141
3142           /* Retrieve the current terminal size */
3143           if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) == 0)
3144             {
3145               cf->width = ws.ws_col;
3146               cf->height = ws.ws_row;
3147             }
3148
3149           if (cf->width == 0 || cf->height == 0)
3150             {
3151               /*
3152                * We have a tty, but no size. Use defaults.
3153                * vpp "unix interactive" inside emacs + gdb ends up here.
3154                */
3155               cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3156               cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3157             }
3158
3159           /* Setup the history */
3160           cf->history_limit = um->cli_history_limit;
3161           cf->has_history = cf->history_limit != 0;
3162
3163           /* Setup the pager */
3164           cf->no_pager = um->cli_no_pager;
3165
3166           /* This is an interactive session until we decide otherwise */
3167           cf->is_interactive = 1;
3168
3169           /* We're going to be in char by char mode */
3170           cf->line_mode = 0;
3171
3172           /* Save the original tty state so we can restore it later */
3173           tcgetattr (STDIN_FILENO, &um->tio_stdin);
3174           um->tio_isset = 1;
3175
3176           /* Tweak the tty settings */
3177           tio = um->tio_stdin;
3178           /* echo off, canonical mode off, ext'd input processing off */
3179           tio.c_lflag &= ~(ECHO | ICANON | IEXTEN);
3180           /* disable XON/XOFF, so ^S invokes the history search */
3181           tio.c_iflag &= ~(IXON | IXOFF);
3182           tio.c_cc[VMIN] = 1;   /* 1 byte at a time */
3183           tio.c_cc[VTIME] = 0;  /* no timer */
3184           tio.c_cc[VSTOP] = _POSIX_VDISABLE;    /* not ^S */
3185           tio.c_cc[VSTART] = _POSIX_VDISABLE;   /* not ^Q */
3186           tcsetattr (STDIN_FILENO, TCSAFLUSH, &tio);
3187
3188           /* See if we can do ANSI/VT100 output */
3189           term = (u8 *) getenv ("TERM");
3190           if (term != NULL)
3191             {
3192               int len = strlen ((char *) term);
3193               cf->ansi_capable = unix_cli_terminal_type_ansi (term, len);
3194               if (unix_cli_terminal_type_noninteractive (term, len))
3195                 unix_cli_set_session_noninteractive (cf);
3196             }
3197         }
3198       else
3199         {
3200           /* No tty, so make sure the session doesn't have tty-like features */
3201           unix_cli_set_session_noninteractive (cf);
3202         }
3203
3204       /* Send banner and initial prompt */
3205       unix_cli_file_welcome (cm, cf);
3206     }
3207
3208   /* If we have socket config, LISTEN, otherwise, don't */
3209   clib_socket_t *s = &um->cli_listen_socket;
3210   if (s->config && s->config[0] != 0)
3211     {
3212       /* CLI listen. */
3213       clib_file_t template = { 0 };
3214
3215       /* mkdir of file socketu, only under /run  */
3216       if (strncmp (s->config, "/run", 4) == 0)
3217         {
3218           u8 *tmp = format (0, "%s", s->config);
3219           int i = vec_len (tmp);
3220           while (i && tmp[--i] != '/')
3221             ;
3222
3223           tmp[i] = '\0';
3224
3225           if (i)
3226             vlib_unix_recursive_mkdir ((char *) tmp);
3227           vec_free (tmp);
3228         }
3229
3230       s->flags = CLIB_SOCKET_F_IS_SERVER |      /* listen, don't connect */
3231         CLIB_SOCKET_F_ALLOW_GROUP_WRITE;        /* PF_LOCAL socket only */
3232       error = clib_socket_init (s);
3233
3234       if (error)
3235         return error;
3236
3237       template.read_function = unix_cli_listen_read_ready;
3238       template.file_descriptor = s->fd;
3239       template.description = format (0, "cli listener %s", s->config);
3240
3241       clib_file_add (fm, &template);
3242     }
3243
3244   /* Set CLI prompt. */
3245   if (!cm->cli_prompt)
3246     cm->cli_prompt = format (0, "VLIB: ");
3247
3248   return 0;
3249 }
3250
3251 /*?
3252  * This module has no configurable parameters.
3253 ?*/
3254 VLIB_CONFIG_FUNCTION (unix_cli_config, "unix-cli");
3255
3256 /** Called when VPP is shutting down, this restores the system
3257  * terminal state if previously saved.
3258  */
3259 static clib_error_t *
3260 unix_cli_exit (vlib_main_t * vm)
3261 {
3262   unix_main_t *um = &unix_main;
3263
3264   /* If stdin is a tty and we saved the tty state, reset the tty state */
3265   if (isatty (STDIN_FILENO) && um->tio_isset)
3266     tcsetattr (STDIN_FILENO, TCSAFLUSH, &um->tio_stdin);
3267
3268   return 0;
3269 }
3270
3271 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_cli_exit);
3272
3273 /** Set the CLI prompt.
3274  * @param prompt The C string to set the prompt to.
3275  * @note This setting is global; it impacts all current
3276  *       and future CLI sessions.
3277  */
3278 void
3279 vlib_unix_cli_set_prompt (char *prompt)
3280 {
3281   char *fmt = (prompt[strlen (prompt) - 1] == ' ') ? "%s" : "%s ";
3282   unix_cli_main_t *cm = &unix_cli_main;
3283   if (cm->cli_prompt)
3284     vec_free (cm->cli_prompt);
3285   cm->cli_prompt = format (0, fmt, prompt);
3286 }
3287
3288 static unix_cli_file_t *
3289 unix_cli_file_if_exists (unix_cli_main_t * cm)
3290 {
3291   if (!cm->cli_file_pool)
3292     return 0;
3293   return pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3294 }
3295
3296 static unix_cli_file_t *
3297 unix_cli_file_if_interactive (unix_cli_main_t * cm)
3298 {
3299   unix_cli_file_t *cf;
3300   if ((cf = unix_cli_file_if_exists (cm)) && !cf->is_interactive)
3301     return 0;
3302   return cf;
3303 }
3304
3305 /** CLI command to quit the terminal session.
3306  * @note If this is a stdin session then this will
3307  *       shutdown VPP also.
3308  */
3309 static clib_error_t *
3310 unix_cli_quit (vlib_main_t * vm,
3311                unformat_input_t * input, vlib_cli_command_t * cmd)
3312 {
3313   unix_cli_main_t *cm = &unix_cli_main;
3314   unix_cli_file_t *cf;
3315
3316   if (!(cf = unix_cli_file_if_exists (cm)))
3317     return clib_error_return (0, "invalid session");
3318
3319   /* Cosmetic: suppress the final prompt from appearing before we die */
3320   cf->is_interactive = 0;
3321   cf->started = 1;
3322
3323   vlib_process_signal_event (vm,
3324                              vlib_current_process (vm),
3325                              UNIX_CLI_PROCESS_EVENT_QUIT,
3326                              cm->current_input_file_index);
3327   return 0;
3328 }
3329
3330 /*?
3331  * Terminates the current CLI session.
3332  *
3333  * If VPP is running in @em interactive mode and this is the console session
3334  * (that is, the session on @c stdin) then this will also terminate VPP.
3335 ?*/
3336 /* *INDENT-OFF* */
3337 VLIB_CLI_COMMAND (unix_cli_quit_command, static) = {
3338   .path = "quit",
3339   .short_help = "Exit CLI",
3340   .function = unix_cli_quit,
3341 };
3342 /* *INDENT-ON* */
3343
3344 /* *INDENT-OFF* */
3345 VLIB_CLI_COMMAND (unix_cli_q_command, static) = {
3346   .path = "q",
3347   .short_help = "Exit CLI",
3348   .function = unix_cli_quit,
3349 };
3350 /* *INDENT-ON* */
3351
3352 /** CLI command to execute a VPP command script. */
3353 static clib_error_t *
3354 unix_cli_exec (vlib_main_t * vm,
3355                unformat_input_t * input, vlib_cli_command_t * cmd)
3356 {
3357   char *file_name;
3358   int fd;
3359   unformat_input_t sub_input;
3360   clib_error_t *error;
3361
3362   file_name = 0;
3363   fd = -1;
3364   error = 0;
3365
3366   if (!unformat (input, "%s", &file_name))
3367     {
3368       error = clib_error_return (0, "expecting file name, got `%U'",
3369                                  format_unformat_error, input);
3370       goto done;
3371     }
3372
3373   fd = open (file_name, O_RDONLY);
3374   if (fd < 0)
3375     {
3376       error = clib_error_return_unix (0, "failed to open `%s'", file_name);
3377       goto done;
3378     }
3379
3380   /* Make sure its a regular file. */
3381   {
3382     struct stat s;
3383
3384     if (fstat (fd, &s) < 0)
3385       {
3386         error = clib_error_return_unix (0, "failed to stat `%s'", file_name);
3387         goto done;
3388       }
3389
3390     if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
3391       {
3392         error = clib_error_return (0, "not a regular file `%s'", file_name);
3393         goto done;
3394       }
3395   }
3396
3397   unformat_init_clib_file (&sub_input, fd);
3398
3399   vlib_cli_input (vm, &sub_input, 0, 0);
3400   unformat_free (&sub_input);
3401
3402 done:
3403   if (fd >= 0)
3404     close (fd);
3405   vec_free (file_name);
3406
3407   return error;
3408 }
3409
3410 /*?
3411  * Executes a sequence of CLI commands which are read from a file. If
3412  * a command is unrecognised or otherwise invalid then the usual CLI
3413  * feedback will be generated, however execution of subsequent commands
3414  * from the file will continue.
3415  *
3416  * The VPP code is indifferent to the file location. However, if SELinux
3417  * is enabled, then the file needs to have an SELinux label the VPP
3418  * process is allowed to access. For example, if a file is created in
3419  * '<em>/usr/share/vpp/</em>', it will be allowed. However, files manually
3420  * created in '/tmp/' or '/home/<user>/' will not be accessible by the VPP
3421  * process when SELinux is enabled.
3422  *
3423  * @cliexpar
3424  * Sample file:
3425  * @clistart
3426  * <b><em>$ cat /usr/share/vpp/scripts/gigup.txt</em></b>
3427  * set interface state GigabitEthernet0/8/0 up
3428  * set interface state GigabitEthernet0/9/0 up
3429  * @cliend
3430  * Example of how to execute a set of CLI commands from a file:
3431  * @cliexcmd{exec /usr/share/vpp/scripts/gigup.txt}
3432 ?*/
3433 /* *INDENT-OFF* */
3434 VLIB_CLI_COMMAND (cli_exec, static) = {
3435   .path = "exec",
3436   .short_help = "exec <filename>",
3437   .function = unix_cli_exec,
3438   .is_mp_safe = 1,
3439 };
3440 /* *INDENT-ON* */
3441
3442 /** CLI command to show various unix error statistics. */
3443 static clib_error_t *
3444 unix_show_errors (vlib_main_t * vm,
3445                   unformat_input_t * input, vlib_cli_command_t * cmd)
3446 {
3447   unix_main_t *um = &unix_main;
3448   clib_error_t *error = 0;
3449   int i, n_errors_to_show;
3450   unix_error_history_t *unix_errors = 0;
3451
3452   n_errors_to_show = 1 << 30;
3453
3454   if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3455     {
3456       if (!unformat (input, "%d", &n_errors_to_show))
3457         {
3458           error =
3459             clib_error_return (0,
3460                                "expecting integer number of errors to show, got `%U'",
3461                                format_unformat_error, input);
3462           goto done;
3463         }
3464     }
3465
3466   n_errors_to_show =
3467     clib_min (ARRAY_LEN (um->error_history), n_errors_to_show);
3468
3469   i =
3470     um->error_history_index >
3471     0 ? um->error_history_index - 1 : ARRAY_LEN (um->error_history) - 1;
3472
3473   while (n_errors_to_show > 0)
3474     {
3475       unix_error_history_t *eh = um->error_history + i;
3476
3477       if (!eh->error)
3478         break;
3479
3480       vec_add1 (unix_errors, eh[0]);
3481       n_errors_to_show -= 1;
3482       if (i == 0)
3483         i = ARRAY_LEN (um->error_history) - 1;
3484       else
3485         i--;
3486     }
3487
3488   if (vec_len (unix_errors) == 0)
3489     vlib_cli_output (vm, "no Unix errors so far");
3490   else
3491     {
3492       vlib_cli_output (vm, "%Ld total errors seen", um->n_total_errors);
3493       for (i = vec_len (unix_errors) - 1; i >= 0; i--)
3494         {
3495           unix_error_history_t *eh = vec_elt_at_index (unix_errors, i);
3496           vlib_cli_output (vm, "%U: %U",
3497                            format_time_interval, "h:m:s:u", eh->time,
3498                            format_clib_error, eh->error);
3499         }
3500       vlib_cli_output (vm, "%U: time now",
3501                        format_time_interval, "h:m:s:u", vlib_time_now (vm));
3502     }
3503
3504 done:
3505   vec_free (unix_errors);
3506   return error;
3507 }
3508
3509 /* *INDENT-OFF* */
3510 VLIB_CLI_COMMAND (cli_unix_show_errors, static) = {
3511   .path = "show unix errors",
3512   .short_help = "Show Unix system call error history",
3513   .function = unix_show_errors,
3514 };
3515 /* *INDENT-ON* */
3516
3517 /** CLI command to show various unix error statistics. */
3518 static clib_error_t *
3519 unix_show_files (vlib_main_t * vm,
3520                  unformat_input_t * input, vlib_cli_command_t * cmd)
3521 {
3522   clib_error_t *error = 0;
3523   clib_file_main_t *fm = &file_main;
3524   clib_file_t *f;
3525   char path[PATH_MAX];
3526   u8 *s = 0;
3527
3528   vlib_cli_output (vm, "%3s %6s %12s %12s %12s %-32s %s", "FD", "Thread",
3529                    "Read", "Write", "Error", "File Name", "Description");
3530
3531   /* *INDENT-OFF* */
3532   pool_foreach (f, fm->file_pool,(
3533    {
3534       int rv;
3535       s = format (s, "/proc/self/fd/%d%c", f->file_descriptor, 0);
3536       rv = readlink((char *) s, path, PATH_MAX - 1);
3537
3538       path[rv < 0 ? 0 : rv] = 0;
3539
3540       vlib_cli_output (vm, "%3d %6d %12d %12d %12d %-32s %v",
3541                        f->file_descriptor, f->polling_thread_index,
3542                        f->read_events, f->write_events, f->error_events,
3543                        path, f->description);
3544       vec_reset_length (s);
3545     }));
3546   /* *INDENT-ON* */
3547   vec_free (s);
3548
3549   return error;
3550 }
3551
3552 /* *INDENT-OFF* */
3553 VLIB_CLI_COMMAND (cli_unix_show_files, static) = {
3554   .path = "show unix files",
3555   .short_help = "Show Unix files in use",
3556   .function = unix_show_files,
3557 };
3558 /* *INDENT-ON* */
3559
3560 /** CLI command to show session command history. */
3561 static clib_error_t *
3562 unix_cli_show_history (vlib_main_t * vm,
3563                        unformat_input_t * input, vlib_cli_command_t * cmd)
3564 {
3565   unix_cli_main_t *cm = &unix_cli_main;
3566   unix_cli_file_t *cf;
3567   int i, j;
3568
3569   if (!(cf = unix_cli_file_if_interactive (cm)))
3570     return clib_error_return (0, "invalid for non-interactive sessions");
3571
3572   if (cf->has_history && cf->history_limit)
3573     {
3574       i = 1 + cf->command_number - vec_len (cf->command_history);
3575       for (j = 0; j < vec_len (cf->command_history); j++)
3576         vlib_cli_output (vm, "%d  %v\n", i + j, cf->command_history[j]);
3577     }
3578   else
3579     {
3580       vlib_cli_output (vm, "History not enabled.\n");
3581     }
3582
3583   return 0;
3584 }
3585
3586 /*?
3587  * Displays the command history for the current session, if any.
3588 ?*/
3589 /* *INDENT-OFF* */
3590 VLIB_CLI_COMMAND (cli_unix_cli_show_history, static) = {
3591   .path = "history",
3592   .short_help = "Show current session command history",
3593   .function = unix_cli_show_history,
3594 };
3595 /* *INDENT-ON* */
3596
3597 /** CLI command to show terminal status. */
3598 static clib_error_t *
3599 unix_cli_show_terminal (vlib_main_t * vm,
3600                         unformat_input_t * input, vlib_cli_command_t * cmd)
3601 {
3602   unix_main_t *um = &unix_main;
3603   unix_cli_main_t *cm = &unix_cli_main;
3604   unix_cli_file_t *cf;
3605   vlib_node_t *n;
3606
3607   if (!(cf = unix_cli_file_if_exists (cm)))
3608     return clib_error_return (0, "invalid session");
3609
3610   n = vlib_get_node (vm, cf->process_node_index);
3611
3612   vlib_cli_output (vm, "Terminal name:   %v\n", n->name);
3613   vlib_cli_output (vm, "Terminal mode:   %s\n", cf->line_mode ?
3614                    "line-by-line" : "char-by-char");
3615   vlib_cli_output (vm, "Terminal width:  %d\n", cf->width);
3616   vlib_cli_output (vm, "Terminal height: %d\n", cf->height);
3617   vlib_cli_output (vm, "ANSI capable:    %s\n",
3618                    cf->ansi_capable ? "yes" : "no");
3619   vlib_cli_output (vm, "Interactive:     %s\n",
3620                    cf->is_interactive ? "yes" : "no");
3621   vlib_cli_output (vm, "History enabled: %s%s\n",
3622                    cf->has_history ? "yes" : "no", !cf->has_history
3623                    || cf->history_limit ? "" :
3624                    " (disabled by history limit)");
3625   if (cf->has_history)
3626     vlib_cli_output (vm, "History limit:   %d\n", cf->history_limit);
3627   vlib_cli_output (vm, "Pager enabled:   %s%s%s\n",
3628                    cf->no_pager ? "no" : "yes",
3629                    cf->no_pager
3630                    || cf->height ? "" : " (disabled by terminal height)",
3631                    cf->no_pager
3632                    || um->cli_pager_buffer_limit ? "" :
3633                    " (disabled by buffer limit)");
3634   if (!cf->no_pager)
3635     vlib_cli_output (vm, "Pager limit:     %d\n", um->cli_pager_buffer_limit);
3636   vlib_cli_output (vm, "CRLF mode:       %s\n",
3637                    cf->crlf_mode ? "CR+LF" : "LF");
3638
3639   return 0;
3640 }
3641
3642 /*?
3643  * Displays various information about the state of the current terminal
3644  * session.
3645  *
3646  * @cliexpar
3647  * @cliexstart{show terminal}
3648  * Terminal name:   unix-cli-stdin
3649  * Terminal mode:   char-by-char
3650  * Terminal width:  123
3651  * Terminal height: 48
3652  * ANSI capable:    yes
3653  * Interactive:     yes
3654  * History enabled: yes
3655  * History limit:   50
3656  * Pager enabled:   yes
3657  * Pager limit:     100000
3658  * CRLF mode:       LF
3659  * @cliexend
3660 ?*/
3661 /* *INDENT-OFF* */
3662 VLIB_CLI_COMMAND (cli_unix_cli_show_terminal, static) = {
3663   .path = "show terminal",
3664   .short_help = "Show current session terminal settings",
3665   .function = unix_cli_show_terminal,
3666 };
3667 /* *INDENT-ON* */
3668
3669 /** CLI command to display a list of CLI sessions. */
3670 static clib_error_t *
3671 unix_cli_show_cli_sessions (vlib_main_t * vm,
3672                             unformat_input_t * input,
3673                             vlib_cli_command_t * cmd)
3674 {
3675   unix_cli_main_t *cm = &unix_cli_main;
3676   clib_file_main_t *fm = &file_main;
3677   unix_cli_file_t *cf;
3678   clib_file_t *uf;
3679   vlib_node_t *n;
3680
3681   vlib_cli_output (vm, "%-5s %-5s %-20s %s", "PNI", "FD", "Name", "Flags");
3682
3683 #define fl(x, y) ( (x) ? toupper((y)) : tolower((y)) )
3684   /* *INDENT-OFF* */
3685   pool_foreach (cf, cm->cli_file_pool, ({
3686     uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3687     n = vlib_get_node (vm, cf->process_node_index);
3688     vlib_cli_output (vm,
3689                      "%-5d %-5d %-20v %c%c%c%c%c\n",
3690                      cf->process_node_index,
3691                      uf->file_descriptor,
3692                      n->name,
3693                      fl (cf->is_interactive, 'i'),
3694                      fl (cf->is_socket, 's'),
3695                      fl (cf->line_mode, 'l'),
3696                      fl (cf->has_epipe, 'p'),
3697                      fl (cf->ansi_capable, 'a'));
3698   }));
3699   /* *INDENT-ON* */
3700 #undef fl
3701
3702   return 0;
3703 }
3704
3705 /*?
3706  * Displays a summary of all the current CLI sessions.
3707  *
3708  * Typically used to diagnose connection issues with the CLI
3709  * socket.
3710  *
3711  * @cliexpar
3712  * @cliexstart{show cli-sessions}
3713  * PNI   FD    Name                 Flags
3714  * 343   0     unix-cli-stdin       IslpA
3715  * 344   7     unix-cli-local:20    ISlpA
3716  * 346   8     unix-cli-local:21    iSLpa
3717  * @cliexend
3718
3719  * In this example we have the debug console of the running process
3720  * on stdin/out, we have an interactive socket session and we also
3721  * have a non-interactive socket session.
3722  *
3723  * Fields:
3724  *
3725  * - @em PNI: Process node index.
3726  * - @em FD: Unix file descriptor.
3727  * - @em Name: Name of the session.
3728  * - @em Flags: Various flags that describe the state of the session.
3729  *
3730  * @em Flags have the following meanings; lower-case typically negates
3731  * upper-case:
3732  *
3733  * - @em I Interactive session.
3734  * - @em S Connected by socket.
3735  * - @em s Not a socket, likely stdin.
3736  * - @em L Line-by-line mode.
3737  * - @em l Char-by-char mode.
3738  * - @em P EPIPE detected on connection; it will close soon.
3739  * - @em A ANSI-capable terminal.
3740 ?*/
3741 /* *INDENT-OFF* */
3742 VLIB_CLI_COMMAND (cli_unix_cli_show_cli_sessions, static) = {
3743   .path = "show cli-sessions",
3744   .short_help = "Show current CLI sessions",
3745   .function = unix_cli_show_cli_sessions,
3746 };
3747 /* *INDENT-ON* */
3748
3749 /** CLI command to set terminal pager settings. */
3750 static clib_error_t *
3751 unix_cli_set_terminal_pager (vlib_main_t * vm,
3752                              unformat_input_t * input,
3753                              vlib_cli_command_t * cmd)
3754 {
3755   unix_main_t *um = &unix_main;
3756   unix_cli_main_t *cm = &unix_cli_main;
3757   unix_cli_file_t *cf;
3758   unformat_input_t _line_input, *line_input = &_line_input;
3759   clib_error_t *error = 0;
3760
3761   if (!(cf = unix_cli_file_if_interactive (cm)))
3762     return clib_error_return (0, "invalid for non-interactive sessions");
3763
3764   if (!unformat_user (input, unformat_line_input, line_input))
3765     return 0;
3766
3767   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3768     {
3769       if (unformat (line_input, "on"))
3770         cf->no_pager = 0;
3771       else if (unformat (line_input, "off"))
3772         cf->no_pager = 1;
3773       else if (unformat (line_input, "limit %u", &um->cli_pager_buffer_limit))
3774         vlib_cli_output (vm,
3775                          "Pager limit set to %u lines; note, this is global.\n",
3776                          um->cli_pager_buffer_limit);
3777       else
3778         {
3779           error = clib_error_return (0, "unknown parameter: `%U`",
3780                                      format_unformat_error, line_input);
3781           goto done;
3782         }
3783     }
3784
3785 done:
3786   unformat_free (line_input);
3787
3788   return error;
3789 }
3790
3791 /*?
3792  * Enables or disables the terminal pager for this session. Generally
3793  * this defaults to enabled.
3794  *
3795  * Additionally allows the pager buffer size to be set; though note that
3796  * this value is set globally and not per session.
3797 ?*/
3798 /* *INDENT-OFF* */
3799 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager, static) = {
3800   .path = "set terminal pager",
3801   .short_help = "set terminal pager [on|off] [limit <lines>]",
3802   .function = unix_cli_set_terminal_pager,
3803 };
3804 /* *INDENT-ON* */
3805
3806 /** CLI command to set terminal history settings. */
3807 static clib_error_t *
3808 unix_cli_set_terminal_history (vlib_main_t * vm,
3809                                unformat_input_t * input,
3810                                vlib_cli_command_t * cmd)
3811 {
3812   unix_cli_main_t *cm = &unix_cli_main;
3813   unix_cli_file_t *cf;
3814   unformat_input_t _line_input, *line_input = &_line_input;
3815   u32 limit;
3816   clib_error_t *error = 0;
3817
3818   if (!(cf = unix_cli_file_if_interactive (cm)))
3819     return clib_error_return (0, "invalid for non-interactive sessions");
3820
3821   if (!unformat_user (input, unformat_line_input, line_input))
3822     return 0;
3823
3824   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3825     {
3826       if (unformat (line_input, "on"))
3827         cf->has_history = 1;
3828       else if (unformat (line_input, "off"))
3829         cf->has_history = 0;
3830       else if (unformat (line_input, "limit %u", &cf->history_limit))
3831         ;
3832       else
3833         {
3834           error = clib_error_return (0, "unknown parameter: `%U`",
3835                                      format_unformat_error, line_input);
3836           goto done;
3837         }
3838
3839     }
3840
3841   /* If we reduced history size, or turned it off, purge the history */
3842   limit = cf->has_history ? cf->history_limit : 0;
3843   if (limit < vec_len (cf->command_history))
3844     {
3845       u32 i;
3846
3847       /* How many items to remove from the start of history */
3848       limit = vec_len (cf->command_history) - limit;
3849
3850       for (i = 0; i < limit; i++)
3851         vec_free (cf->command_history[i]);
3852
3853       vec_delete (cf->command_history, limit, 0);
3854     }
3855
3856 done:
3857   unformat_free (line_input);
3858
3859   return error;
3860 }
3861
3862 /*?
3863  * Enables or disables the command history function of the current
3864  * terminal. Generally this defaults to enabled.
3865  *
3866  * This command also allows the maximum size of the history buffer for
3867  * this session to be altered.
3868 ?*/
3869 /* *INDENT-OFF* */
3870 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history, static) = {
3871   .path = "set terminal history",
3872   .short_help = "set terminal history [on|off] [limit <lines>]",
3873   .function = unix_cli_set_terminal_history,
3874 };
3875 /* *INDENT-ON* */
3876
3877 /** CLI command to set terminal ANSI settings. */
3878 static clib_error_t *
3879 unix_cli_set_terminal_ansi (vlib_main_t * vm,
3880                             unformat_input_t * input,
3881                             vlib_cli_command_t * cmd)
3882 {
3883   unix_cli_main_t *cm = &unix_cli_main;
3884   unix_cli_file_t *cf;
3885
3886   if (!(cf = unix_cli_file_if_interactive (cm)))
3887     return clib_error_return (0, "invalid for non-interactive sessions");
3888
3889   if (unformat (input, "on"))
3890     cf->ansi_capable = 1;
3891   else if (unformat (input, "off"))
3892     cf->ansi_capable = 0;
3893   else
3894     return clib_error_return (0, "unknown parameter: `%U`",
3895                               format_unformat_error, input);
3896
3897   return 0;
3898 }
3899
3900 /*?
3901  * Enables or disables the use of ANSI control sequences by this terminal.
3902  * The default will vary based on terminal detection at the start of the
3903  * session.
3904  *
3905  * ANSI control sequences are used in a small number of places to provide,
3906  * for example, color text output and to control the cursor in the pager.
3907 ?*/
3908 /* *INDENT-OFF* */
3909 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi, static) = {
3910   .path = "set terminal ansi",
3911   .short_help = "set terminal ansi [on|off]",
3912   .function = unix_cli_set_terminal_ansi,
3913 };
3914 /* *INDENT-ON* */
3915
3916
3917 #define MAX_CLI_WAIT 86400
3918 /** CLI command to wait <sec> seconds. Useful for exec script. */
3919 static clib_error_t *
3920 unix_wait_cmd (vlib_main_t * vm,
3921                unformat_input_t * input, vlib_cli_command_t * cmd)
3922 {
3923   unformat_input_t _line_input, *line_input = &_line_input;
3924   f64 sec = 1.0;
3925
3926   if (!unformat_user (input, unformat_line_input, line_input))
3927     return 0;
3928
3929   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3930     {
3931       if (unformat (line_input, "%f", &sec))
3932         ;
3933       else
3934         return clib_error_return (0, "unknown parameter: `%U`",
3935                                   format_unformat_error, input);
3936     }
3937
3938   if (sec <= 0 || sec > MAX_CLI_WAIT || floor (sec * 1000) / 1000 != sec)
3939     return clib_error_return (0,
3940                               "<sec> must be a positive value and less than 86400 (one day) with no more than msec precision.");
3941
3942   vlib_process_wait_for_event_or_clock (vm, sec);
3943   vlib_cli_output (vm, "waited %.3f sec.", sec);
3944
3945   unformat_free (line_input);
3946   return 0;
3947 }
3948 /* *INDENT-OFF* */
3949 VLIB_CLI_COMMAND (cli_unix_wait_cmd, static) = {
3950   .path = "wait",
3951   .short_help = "wait <sec>",
3952   .function = unix_wait_cmd,
3953 };
3954 /* *INDENT-ON* */
3955
3956 static clib_error_t *
3957 echo_cmd (vlib_main_t * vm,
3958           unformat_input_t * input, vlib_cli_command_t * cmd)
3959 {
3960   unformat_input_t _line_input, *line_input = &_line_input;
3961
3962   /* Get a line of input. */
3963   if (!unformat_user (input, unformat_line_input, line_input))
3964     {
3965       vlib_cli_output (vm, "");
3966       return 0;
3967     }
3968
3969   vlib_cli_output (vm, "%v", line_input->buffer);
3970
3971   unformat_free (line_input);
3972   return 0;
3973 }
3974
3975 /* *INDENT-OFF* */
3976 VLIB_CLI_COMMAND (cli_unix_echo_cmd, static) = {
3977   .path = "echo",
3978   .short_help = "echo <rest-of-line>",
3979   .function = echo_cmd,
3980 };
3981 /* *INDENT-ON* */
3982
3983 static clib_error_t *
3984 define_cmd_fn (vlib_main_t * vm,
3985                unformat_input_t * input, vlib_cli_command_t * cmd)
3986 {
3987   u8 *macro_name;
3988   unformat_input_t _line_input, *line_input = &_line_input;
3989   clib_macro_main_t *mm = get_macro_main ();
3990   clib_error_t *error;
3991
3992   if (!unformat (input, "%s", &macro_name))
3993     return clib_error_return (0, "missing variable name...");
3994
3995   /* Remove white space */
3996   (void) unformat (input, "");
3997
3998   /* Get a line of input. */
3999   if (!unformat_user (input, unformat_line_input, line_input))
4000     {
4001       error = clib_error_return (0, "missing value for '%s'...", macro_name);
4002       vec_free (macro_name);
4003       return error;
4004     }
4005   /* the macro expander expects c-strings, not vectors... */
4006   vec_add1 (line_input->buffer, 0);
4007   clib_macro_set_value (mm, (char *) macro_name, (char *) line_input->buffer);
4008   vec_free (macro_name);
4009   unformat_free (line_input);
4010   return 0;
4011 }
4012
4013 /* *INDENT-OFF* */
4014 VLIB_CLI_COMMAND (define_cmd, static) = {
4015   .path = "define",
4016   .short_help = "define <variable-name> <value>",
4017   .function = define_cmd_fn,
4018 };
4019
4020 /* *INDENT-ON* */
4021
4022 static clib_error_t *
4023 undefine_cmd_fn (vlib_main_t * vm,
4024                  unformat_input_t * input, vlib_cli_command_t * cmd)
4025 {
4026   u8 *macro_name;
4027   clib_macro_main_t *mm = get_macro_main ();
4028
4029   if (!unformat (input, "%s", &macro_name))
4030     return clib_error_return (0, "missing variable name...");
4031
4032   if (clib_macro_unset (mm, (char *) macro_name))
4033     vlib_cli_output (vm, "%s wasn't set...", macro_name);
4034
4035   vec_free (macro_name);
4036   return 0;
4037 }
4038
4039 /* *INDENT-OFF* */
4040 VLIB_CLI_COMMAND (undefine_cmd, static) = {
4041   .path = "undefine",
4042   .short_help = "undefine <variable-name>",
4043   .function = undefine_cmd_fn,
4044 };
4045 /* *INDENT-ON* */
4046
4047 static clib_error_t *
4048 show_macro_cmd_fn (vlib_main_t * vm,
4049                    unformat_input_t * input, vlib_cli_command_t * cmd)
4050 {
4051   clib_macro_main_t *mm = get_macro_main ();
4052   int evaluate = 1;
4053
4054   if (unformat (input, "noevaluate %=", &evaluate, 0))
4055     ;
4056   else if (unformat (input, "noeval %=", &evaluate, 0))
4057     ;
4058
4059   vlib_cli_output (vm, "%U", format_clib_macro_main, mm, evaluate);
4060   return 0;
4061 }
4062
4063 /* *INDENT-OFF* */
4064 VLIB_CLI_COMMAND (show_macro, static) = {
4065   .path = "show macro",
4066   .short_help = "show macro [noevaluate]",
4067   .function = show_macro_cmd_fn,
4068 };
4069 /* *INDENT-ON* */
4070
4071 static clib_error_t *
4072 unix_cli_init (vlib_main_t * vm)
4073 {
4074   unix_cli_main_t *cm = &unix_cli_main;
4075
4076   /* Breadcrumb to indicate the new session process
4077    * has not been started */
4078   cm->new_session_process_node_index = ~0;
4079   clib_macro_init (&cm->macro_main);
4080
4081   return 0;
4082 }
4083
4084 VLIB_INIT_FUNCTION (unix_cli_init);
4085
4086 /*
4087  * fd.io coding-style-patch-verification: ON
4088  *
4089  * Local Variables:
4090  * eval: (c-set-style "gnu")
4091  * End:
4092  */