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