FD.io VPP  v18.01-8-g0eacf49
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 #include <vppinfra/timer.h>
51 
52 #include <ctype.h>
53 #include <fcntl.h>
54 #include <sys/stat.h>
55 #include <termios.h>
56 #include <signal.h>
57 #include <unistd.h>
58 #include <arpa/telnet.h>
59 #include <sys/ioctl.h>
60 #include <sys/types.h>
61 #include <unistd.h>
62 
63 /** ANSI escape code. */
64 #define ESC "\x1b"
65 
66 /** ANSI Control Sequence Introducer. */
67 #define CSI ESC "["
68 
69 /** ANSI clear screen. */
70 #define ANSI_CLEAR CSI "2J" CSI "1;1H"
71 /** ANSI reset color settings. */
72 #define ANSI_RESET CSI "0m"
73 /** ANSI Start bold text. */
74 #define ANSI_BOLD CSI "1m"
75 /** ANSI Stop bold text. */
76 #define ANSI_DIM CSI "2m"
77 /** ANSI Start dark red text. */
78 #define ANSI_DRED ANSI_DIM CSI "31m"
79 /** ANSI Start bright red text. */
80 #define ANSI_BRED ANSI_BOLD CSI "31m"
81 /** ANSI clear line cursor is on. */
82 #define ANSI_CLEARLINE CSI "2K"
83 /** ANSI scroll screen down one line. */
84 #define ANSI_SCROLLDN CSI "1T"
85 /** ANSI save cursor position. */
86 #define ANSI_SAVECURSOR CSI "s"
87 /** ANSI restore cursor position if previously saved. */
88 #define ANSI_RESTCURSOR CSI "u"
89 
90 /** Maximum depth into a byte stream from which to compile a Telnet
91  * protocol message. This is a safety measure. */
92 #define UNIX_CLI_MAX_DEPTH_TELNET 24
93 
94 /** Maximum terminal width we will accept */
95 #define UNIX_CLI_MAX_TERMINAL_WIDTH 512
96 /** Maximum terminal height we will accept */
97 #define UNIX_CLI_MAX_TERMINAL_HEIGHT 512
98 /** Default terminal height */
99 #define UNIX_CLI_DEFAULT_TERMINAL_HEIGHT 24
100 /** Default terminal width */
101 #define UNIX_CLI_DEFAULT_TERMINAL_WIDTH 80
102 
103 /** A CLI banner line. */
104 typedef struct
105 {
106  u8 *line; /**< The line to print. */
107  u32 length; /**< The length of the line without terminating NUL. */
109 
110 #define _(a) { .line = (u8 *)(a), .length = sizeof(a) - 1 }
111 /** Plain welcome banner. */
112 static unix_cli_banner_t unix_cli_banner[] = {
113  _(" _______ _ _ _____ ___ \n"),
114  _(" __/ __/ _ \\ (_)__ | | / / _ \\/ _ \\\n"),
115  _(" _/ _// // / / / _ \\ | |/ / ___/ ___/\n"),
116  _(" /_/ /____(_)_/\\___/ |___/_/ /_/ \n"),
117  _("\n")
118 };
119 
120 /** ANSI color welcome banner. */
121 static unix_cli_banner_t unix_cli_banner_color[] = {
122  _(ANSI_BRED " _______ _ " ANSI_RESET " _ _____ ___ \n"),
123  _(ANSI_BRED " __/ __/ _ \\ (_)__ " ANSI_RESET " | | / / _ \\/ _ \\\n"),
124  _(ANSI_BRED " _/ _// // / / / _ \\" ANSI_RESET " | |/ / ___/ ___/\n"),
125  _(ANSI_BRED " /_/ /____(_)_/\\___/" ANSI_RESET " |___/_/ /_/ \n"),
126  _("\n")
127 };
128 
129 #undef _
130 
131 /** Pager line index */
132 typedef struct
133 {
134  /** Index into pager_vector */
136 
137  /** Offset of the string in the line */
139 
140  /** Length of the string in the line */
143 
144 
145 /** Unix CLI session. */
146 typedef struct
147 {
148  /** The file index held by unix.c */
150 
151  /** Vector of output pending write to file descriptor. */
153 
154  /** Vector of input saved by Unix input node to be processed by
155  CLI process. */
157 
158  /** This session has command history. */
160  /** Array of vectors of commands in the history. */
162  /** The command currently pointed at by the history cursor. */
164  /** How far from the end of the history array the user has browsed. */
166 
167  /** Maximum number of history entries this session will store. */
169 
170  /** Current command line counter */
172 
173  /** The string being searched for in the history. */
175  /** If non-zero then the CLI is searching in the history array.
176  * - @c -1 means search backwards.
177  * - @c 1 means search forwards.
178  */
180 
181  /** Position of the insert cursor on the current input line */
183 
184  /** Line mode or char mode */
186 
187  /** Set if the CRLF mode wants CR + LF */
189 
190  /** Can we do ANSI output? */
192 
193  /** Has the session started? */
195 
196  /** Disable the pager? */
198 
199  /** Whether the session is interactive or not.
200  * Controls things like initial banner, the CLI prompt etc. */
202 
203  /** Whether the session is attached to a socket. */
205 
206  /** If EPIPE has been detected, prevent further write-related
207  * activity on the descriptor.
208  */
210 
211  /** Pager buffer */
213 
214  /** Index of line fragments in the pager buffer */
216 
217  /** Line number of top of page */
219 
220  /** Terminal width */
222 
223  /** Terminal height */
225 
226  /** Process node identifier */
229 
230 /** Resets the pager buffer and other data.
231  * @param f The CLI session whose pager needs to be reset.
232  */
233 always_inline void
235 {
236  u8 **p;
237 
238  f->pager_start = 0;
239 
240  vec_free (f->pager_index);
241  f->pager_index = 0;
242 
243  vec_foreach (p, f->pager_vector)
244  {
245  vec_free (*p);
246  }
247  vec_free (f->pager_vector);
248  f->pager_vector = 0;
249 }
250 
251 /** Release storage used by a CLI session.
252  * @param f The CLI session whose storage needs to be released.
253  */
254 always_inline void
256 {
257  vec_free (f->output_vector);
258  vec_free (f->input_vector);
260 }
261 
262 /** CLI actions */
263 typedef enum
264 {
265  UNIX_CLI_PARSE_ACTION_NOACTION = 0, /**< No action */
266  UNIX_CLI_PARSE_ACTION_CRLF, /**< Carriage return, newline or enter */
267  UNIX_CLI_PARSE_ACTION_TAB, /**< Tab key */
268  UNIX_CLI_PARSE_ACTION_ERASE, /**< Erase cursor left */
269  UNIX_CLI_PARSE_ACTION_ERASERIGHT, /**< Erase cursor right */
270  UNIX_CLI_PARSE_ACTION_UP, /**< Up arrow */
271  UNIX_CLI_PARSE_ACTION_DOWN, /**< Down arrow */
272  UNIX_CLI_PARSE_ACTION_LEFT, /**< Left arrow */
273  UNIX_CLI_PARSE_ACTION_RIGHT, /**< Right arrow */
274  UNIX_CLI_PARSE_ACTION_HOME, /**< Home key (jump to start of line) */
275  UNIX_CLI_PARSE_ACTION_END, /**< End key (jump to end of line) */
276  UNIX_CLI_PARSE_ACTION_WORDLEFT, /**< Jump cursor to start of left word */
277  UNIX_CLI_PARSE_ACTION_WORDRIGHT, /**< Jump cursor to start of right word */
278  UNIX_CLI_PARSE_ACTION_ERASELINELEFT, /**< Erase line to left of cursor */
279  UNIX_CLI_PARSE_ACTION_ERASELINERIGHT, /**< Erase line to right & including cursor */
280  UNIX_CLI_PARSE_ACTION_CLEAR, /**< Clear the terminal */
281  UNIX_CLI_PARSE_ACTION_REVSEARCH, /**< Search backwards in command history */
282  UNIX_CLI_PARSE_ACTION_FWDSEARCH, /**< Search forwards in command history */
283  UNIX_CLI_PARSE_ACTION_YANK, /**< Undo last erase action */
284  UNIX_CLI_PARSE_ACTION_TELNETIAC, /**< Telnet control code */
285 
286  UNIX_CLI_PARSE_ACTION_PAGER_CRLF, /**< Enter pressed (CR, CRLF, LF, etc) */
287  UNIX_CLI_PARSE_ACTION_PAGER_QUIT, /**< Exit the pager session */
288  UNIX_CLI_PARSE_ACTION_PAGER_NEXT, /**< Scroll to next page */
289  UNIX_CLI_PARSE_ACTION_PAGER_DN, /**< Scroll to next line */
290  UNIX_CLI_PARSE_ACTION_PAGER_UP, /**< Scroll to previous line */
291  UNIX_CLI_PARSE_ACTION_PAGER_TOP, /**< Scroll to first line */
292  UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM, /**< Scroll to last line */
293  UNIX_CLI_PARSE_ACTION_PAGER_PGDN, /**< Scroll to next page */
294  UNIX_CLI_PARSE_ACTION_PAGER_PGUP, /**< Scroll to previous page */
295  UNIX_CLI_PARSE_ACTION_PAGER_REDRAW, /**< Clear and redraw the page on the terminal */
296  UNIX_CLI_PARSE_ACTION_PAGER_SEARCH, /**< Search the pager buffer */
297 
298  UNIX_CLI_PARSE_ACTION_PARTIALMATCH, /**< Action parser found a partial match */
299  UNIX_CLI_PARSE_ACTION_NOMATCH /**< Action parser did not find any match */
301 
302 /** @brief Mapping of input buffer strings to action values.
303  * @note This won't work as a hash since we need to be able to do
304  * partial matches on the string.
305  */
306 typedef struct
307 {
308  u8 *input; /**< Input string to match. */
309  u32 len; /**< Length of input without final NUL. */
310  unix_cli_parse_action_t action; /**< Action to take when matched. */
312 
313 /** @brief Given a capital ASCII letter character return a @c NUL terminated
314  * string with the control code for that letter.
315  *
316  * @param c An ASCII character.
317  * @return A @c NUL terminated string of type @c u8[].
318  *
319  * @par Example
320  * @c CTL('A') returns <code>{ 0x01, 0x00 }</code> as a @c u8[].
321  */
322 #define CTL(c) (u8[]){ (c) - '@', 0 }
323 
324 #define _(a,b) { .input = (u8 *)(a), .len = sizeof(a) - 1, .action = (b) }
325 /**
326  * Patterns to match on a CLI input stream.
327  * @showinitializer
328  */
329 static unix_cli_parse_actions_t unix_cli_parse_strings[] = {
330  /* Line handling */
331  _("\r\n", UNIX_CLI_PARSE_ACTION_CRLF), /* Must be before '\r' */
333  _("\r\0", UNIX_CLI_PARSE_ACTION_CRLF), /* Telnet does this */
335 
336  /* Unix shell control codes */
339  _(CTL ('P'), UNIX_CLI_PARSE_ACTION_UP),
342  _(CTL ('E'), UNIX_CLI_PARSE_ACTION_END),
348  _(ESC "b", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* Alt-B */
349  _(ESC "f", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* Alt-F */
350  _("\b", UNIX_CLI_PARSE_ACTION_ERASE), /* ^H */
351  _("\x7f", UNIX_CLI_PARSE_ACTION_ERASE), /* Backspace */
352  _("\t", UNIX_CLI_PARSE_ACTION_TAB), /* ^I */
353 
354  /* VT100 Normal mode - Broadest support */
361  _(CSI "3~", UNIX_CLI_PARSE_ACTION_ERASERIGHT), /* Delete */
362  _(CSI "1;5D", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* C-Left */
363  _(CSI "1;5C", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* C-Right */
364 
365  /* VT100 Application mode - Some Gnome Terminal functions use these */
366  _(ESC "OA", UNIX_CLI_PARSE_ACTION_UP),
372 
373  /* ANSI X3.41-1974 - sent by Microsoft Telnet and PuTTY */
376 
377  /* Emacs-ish history search */
380 
381  /* Other protocol things */
382  _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
383  _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
385 };
386 
387 /**
388  * Patterns to match when a CLI session is in the pager.
389  * @showinitializer
390  */
391 static unix_cli_parse_actions_t unix_cli_parse_pager[] = {
392  /* Line handling */
393  _("\r\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Must be before '\r' */
395  _("\r\0", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Telnet does this */
397 
398  /* Pager commands */
404 
405  /* VT100 */
410 
411  /* VT100 Application mode */
416 
417  /* ANSI X3.41-1974 */
422 
423  /* Other protocol things */
424  _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
425  _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
427 };
428 
429 #undef _
430 
431 /** CLI session events. */
432 typedef enum
433 {
434  UNIX_CLI_PROCESS_EVENT_READ_READY, /**< A file descriptor has data to be read. */
435  UNIX_CLI_PROCESS_EVENT_QUIT, /**< A CLI session wants to close. */
437 
438 /** CLI global state. */
439 typedef struct
440 {
441  /** Prompt string for CLI. */
443 
444  /** Vec pool of CLI sessions. */
446 
447  /** Vec pool of unused session indices. */
449 
450  /** The session index of the stdin cli */
452 
453  /** File pool index of current input. */
456 
457 /** CLI global state */
459 
460 /**
461  * @brief Search for a byte sequence in the action list.
462  *
463  * Searches the @ref unix_cli_parse_actions_t list in @a a for a match with
464  * the bytes in @a input of maximum length @a ilen bytes.
465  * When a match is made @a *matched indicates how many bytes were matched.
466  * Returns a value from the enum @ref unix_cli_parse_action_t to indicate
467  * whether no match was found, a partial match was found or a complete
468  * match was found and what action, if any, should be taken.
469  *
470  * @param[in] a Actions list to search within.
471  * @param[in] input String fragment to search for.
472  * @param[in] ilen Length of the string in 'input'.
473  * @param[out] matched Pointer to an integer that will contain the number
474  * of bytes matched when a complete match is found.
475  *
476  * @return Action from @ref unix_cli_parse_action_t that the string fragment
477  * matches.
478  * @ref UNIX_CLI_PARSE_ACTION_PARTIALMATCH is returned when the
479  * whole input string matches the start of at least one action.
480  * @ref UNIX_CLI_PARSE_ACTION_NOMATCH is returned when there is no
481  * match at all.
482  */
485  u8 * input, u32 ilen, i32 * matched)
486 {
487  u8 partial = 0;
488 
489  while (a->input)
490  {
491  if (ilen >= a->len)
492  {
493  /* see if the start of the input buffer exactly matches the current
494  * action string. */
495  if (memcmp (input, a->input, a->len) == 0)
496  {
497  *matched = a->len;
498  return a->action;
499  }
500  }
501  else
502  {
503  /* if the first ilen characters match, flag this as a partial -
504  * meaning keep collecting bytes in case of a future match */
505  if (memcmp (input, a->input, ilen) == 0)
506  partial = 1;
507  }
508 
509  /* check next action */
510  a++;
511  }
512 
513  return partial ?
515 }
516 
517 
518 /** Add bytes to the output vector and then flagg the I/O system that bytes
519  * are available to be sent.
520  */
521 static void
523  unix_cli_file_t * cf,
524  u8 * buffer, uword buffer_bytes)
525 {
527 
528  vec_add (cf->output_vector, buffer, buffer_bytes);
529  if (vec_len (cf->output_vector) > 0)
530  {
531  int skip_update = 0 != (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
533  if (!skip_update)
535  }
536 }
537 
538 /** Delete all bytes from the output vector and flag the I/O system
539  * that no more bytes are available to be sent.
540  */
541 static void
543  unix_cli_file_t * cf, uword n_bytes)
544 {
546 
547  vec_delete (cf->output_vector, n_bytes, 0);
548  if (vec_len (cf->output_vector) <= 0)
549  {
550  int skip_update = 0 == (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
552  if (!skip_update)
554  }
555 }
556 
557 /** @brief A bit like strchr with a buffer length limit.
558  * Search a buffer for the first instance of a character up to the limit of
559  * the buffer length. If found then return the position of that character.
560  *
561  * The key departure from strchr is that if the character is not found then
562  * return the buffer length.
563  *
564  * @param chr The byte value to search for.
565  * @param str The buffer in which to search for the value.
566  * @param len The depth into the buffer to search.
567  *
568  * @return The index of the first occurence of \c chr. If \c chr is not
569  * found then \c len instead.
570  */
572 unix_vlib_findchr (u8 chr, u8 * str, word len)
573 {
574  word i = 0;
575  for (i = 0; i < len; i++, str++)
576  {
577  if (*str == chr)
578  return i;
579  }
580  return len;
581 }
582 
583 /** @brief Send a buffer to the CLI stream if possible, enqueue it otherwise.
584  * Attempts to write given buffer to the file descriptor of the given
585  * Unix CLI session. If that session already has data in the output buffer
586  * or if the write attempt tells us to try again later then the given buffer
587  * is appended to the pending output buffer instead.
588  *
589  * This is typically called only from \c unix_vlib_cli_output_cooked since
590  * that is where CRLF handling occurs or from places where we explicitly do
591  * not want cooked handling.
592  *
593  * @param cf Unix CLI session of the desired stream to write to.
594  * @param uf The Unix file structure of the desired stream to write to.
595  * @param buffer Pointer to the buffer that needs to be written.
596  * @param buffer_bytes The number of bytes from \c buffer to write.
597  */
598 static void
600  clib_file_t * uf, u8 * buffer, uword buffer_bytes)
601 {
602  int n = 0;
603 
604  if (cf->has_epipe) /* don't try writing anything */
605  return;
606 
607  if (vec_len (cf->output_vector) == 0)
608  {
609  if (cf->is_socket)
610  /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
611  n = send (uf->file_descriptor, buffer, buffer_bytes, MSG_NOSIGNAL);
612  else
613  n = write (uf->file_descriptor, buffer, buffer_bytes);
614  }
615 
616  if (n < 0 && errno != EAGAIN)
617  {
618  if (errno == EPIPE)
619  {
620  /* connection closed on us */
621  unix_main_t *um = &unix_main;
622  cf->has_epipe = 1;
625  uf->private_data);
626  }
627  else
628  {
629  clib_unix_warning ("write");
630  }
631  }
632  else if ((word) n < (word) buffer_bytes)
633  {
634  /* We got EAGAIN or we already have stuff in the buffer;
635  * queue up whatever didn't get sent for later. */
636  if (n < 0)
637  n = 0;
638  unix_cli_add_pending_output (uf, cf, buffer + n, buffer_bytes - n);
639  }
640 }
641 
642 /** @brief Process a buffer for CRLF handling before outputting it to the CLI.
643  *
644  * @param cf Unix CLI session of the desired stream to write to.
645  * @param uf The Unix file structure of the desired stream to write to.
646  * @param buffer Pointer to the buffer that needs to be written.
647  * @param buffer_bytes The number of bytes from \c buffer to write.
648  */
649 static void
651  clib_file_t * uf,
652  u8 * buffer, uword buffer_bytes)
653 {
654  word end = 0, start = 0;
655 
656  while (end < buffer_bytes)
657  {
658  if (cf->crlf_mode)
659  {
660  /* iterate the line on \n's so we can insert a \r before it */
661  end = unix_vlib_findchr ('\n',
662  buffer + start,
663  buffer_bytes - start) + start;
664  }
665  else
666  {
667  /* otherwise just send the whole buffer */
668  end = buffer_bytes;
669  }
670 
671  unix_vlib_cli_output_raw (cf, uf, buffer + start, end - start);
672 
673  if (cf->crlf_mode)
674  {
675  if (end < buffer_bytes)
676  {
677  unix_vlib_cli_output_raw (cf, uf, (u8 *) "\r\n", 2);
678  end++; /* skip the \n that we already sent */
679  }
680  start = end;
681  }
682  }
683 }
684 
685 /** @brief Output the CLI prompt */
686 static void
688 {
690 
691  if (cf->is_interactive) /* Only interactive sessions get a prompt */
693  vec_len (cm->cli_prompt));
694 }
695 
696 /** @brief Output a pager prompt and show number of buffered lines */
697 static void
699 {
700  u8 *prompt;
701  u32 h;
702 
703  h = cf->pager_start + (cf->height - 1);
704  if (h > vec_len (cf->pager_index))
705  h = vec_len (cf->pager_index);
706 
707  prompt = format (0, "\r%s-- more -- (%d-%d/%d)%s",
708  cf->ansi_capable ? ANSI_BOLD : "",
709  cf->pager_start + 1,
710  h,
711  vec_len (cf->pager_index),
712  cf->ansi_capable ? ANSI_RESET : "");
713 
714  unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
715 
716  vec_free (prompt);
717 }
718 
719 /** @brief Output a pager "skipping" message */
720 static void
722  char *message, char *postfix)
723 {
724  u8 *prompt;
725 
726  prompt = format (0, "\r%s-- %s --%s%s",
727  cf->ansi_capable ? ANSI_BOLD : "",
728  message, cf->ansi_capable ? ANSI_RESET : "", postfix);
729 
730  unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
731 
732  vec_free (prompt);
733 }
734 
735 /** @brief Erase the printed pager prompt */
736 static void
738 {
739  if (cf->ansi_capable)
740  {
741  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
743  (u8 *) ANSI_CLEARLINE,
744  sizeof (ANSI_CLEARLINE) - 1);
745  }
746  else
747  {
748  int i;
749 
750  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
751  for (i = 0; i < cf->width - 1; i++)
752  unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
753  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
754  }
755 }
756 
757 /** @brief Uses an ANSI escape sequence to move the cursor */
758 static void
760 {
761  u8 *str;
762 
763  str = format (0, "%s%d;%dH", CSI, y, x);
764 
765  unix_vlib_cli_output_cooked (cf, uf, str, vec_len (str));
766 
767  vec_free (str);
768 }
769 
770 /** Redraw the currently displayed page of text.
771  * @param cf CLI session to redraw the pager buffer of.
772  * @param uf Unix file of the CLI session.
773  */
774 static void
776 {
778  u8 *line = NULL;
779  word i;
780 
781  /* No active pager? Do nothing. */
782  if (!vec_len (cf->pager_index))
783  return;
784 
785  if (cf->ansi_capable)
786  {
787  /* If we have ANSI, send the clear screen sequence */
789  (u8 *) ANSI_CLEAR,
790  sizeof (ANSI_CLEAR) - 1);
791  }
792  else
793  {
794  /* Otherwise make sure we're on a blank line */
796  }
797 
798  /* (Re-)send the current page of content */
799  for (i = 0; i < cf->height - 1 &&
800  i + cf->pager_start < vec_len (cf->pager_index); i++)
801  {
802  pi = &cf->pager_index[cf->pager_start + i];
803  line = cf->pager_vector[pi->line] + pi->offset;
804 
805  unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
806  }
807  /* if the last line didn't end in newline, add a newline */
808  if (pi && line[pi->length - 1] != '\n')
809  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
810 
811  unix_cli_pager_prompt (cf, uf);
812 }
813 
814 /** @brief Process and add a line to the pager index.
815  * In normal operation this function will take the given character string
816  * found in @c line and with length @c len_or_index and iterates the over the
817  * contents, adding each line of text discovered within it to the
818  * pager index. Lines are identified by newlines ("<code>\\n</code>") and by
819  * strings longer than the width of the terminal.
820  *
821  * If instead @c line is @c NULL then @c len_or_index is taken to mean the
822  * index of an existing line in the pager buffer; this simply means that the
823  * input line does not need to be cloned since we alreayd have it. This is
824  * typical if we are reindexing the pager buffer.
825  *
826  * @param cf The CLI session whose pager we are adding to.
827  * @param line The string of text to be indexed into the pager buffer.
828  * If @c line is @c NULL then the mode of operation
829  * changes slightly; see the description above.
830  * @param len_or_index If @c line is a pointer to a string then this parameter
831  * indicates the length of that string; Otherwise this
832  * value provides the index in the pager buffer of an
833  * existing string to be indexed.
834  */
835 static void
836 unix_cli_pager_add_line (unix_cli_file_t * cf, u8 * line, word len_or_index)
837 {
838  u8 *p = NULL;
839  word i, j, k;
840  word line_index, len;
841  u32 width = cf->width;
843 
844  if (line == NULL)
845  {
846  /* Use a line already in the pager buffer */
847  line_index = len_or_index;
848  if (cf->pager_vector != NULL)
849  p = cf->pager_vector[line_index];
850  len = vec_len (p);
851  }
852  else
853  {
854  len = len_or_index;
855  /* Add a copy of the raw string to the pager buffer */
856  p = vec_new (u8, len);
857  clib_memcpy (p, line, len);
858 
859  /* store in pager buffer */
860  line_index = vec_len (cf->pager_vector);
861  vec_add1 (cf->pager_vector, p);
862  }
863 
864  i = 0;
865  while (i < len)
866  {
867  /* Find the next line, or run to terminal width, or run to EOL */
868  int l = len - i;
869  j = unix_vlib_findchr ((u8) '\n', p, l < width ? l : width);
870 
871  if (j < l && p[j] == '\n') /* incl \n */
872  j++;
873 
874  /* Add the line to the index */
875  k = vec_len (cf->pager_index);
876  vec_validate (cf->pager_index, k);
877  pi = &cf->pager_index[k];
878 
879  pi->line = line_index;
880  pi->offset = i;
881  pi->length = j;
882 
883  i += j;
884  p += j;
885  }
886 }
887 
888 /** @brief Reindex entire pager buffer.
889  * Resets the current pager index and then re-adds the lines in the pager
890  * buffer to the index.
891  *
892  * Additionally this function attempts to retain the current page start
893  * line offset by searching for the same top-of-screen line in the new index.
894  *
895  * @param cf The CLI session whose pager buffer should be reindexed.
896  */
897 static void
899 {
900  word i, old_line, old_offset;
902 
903  /* If there is nothing in the pager buffer then make sure the index
904  * is empty and move on.
905  */
906  if (cf->pager_vector == 0)
907  {
909  return;
910  }
911 
912  /* Retain a pointer to the current page start line so we can
913  * find it later
914  */
915  pi = &cf->pager_index[cf->pager_start];
916  old_line = pi->line;
917  old_offset = pi->offset;
918 
919  /* Re-add the buffered lines to the index */
922  {
923  unix_cli_pager_add_line (cf, NULL, i);
924  }
925 
926  /* Attempt to re-locate the previously stored page start line */
928  {
929  pi = &cf->pager_index[i];
930 
931  if (pi->line == old_line &&
932  (pi->offset <= old_offset || pi->offset + pi->length > old_offset))
933  {
934  /* Found it! */
935  cf->pager_start = i;
936  break;
937  }
938  }
939 
940  /* In case the start line was not found (rare), ensure the pager start
941  * index is within bounds
942  */
943  if (cf->pager_start >= vec_len (cf->pager_index))
944  {
945  if (!cf->height || vec_len (cf->pager_index) < (cf->height - 1))
946  cf->pager_start = 0;
947  else
948  cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
949  }
950 }
951 
952 /** VLIB CLI output function.
953  *
954  * If the terminal has a pager configured then this function takes care
955  * of collating output into the pager buffer; ensuring only the first page
956  * is displayed and any lines in excess of the first page are buffered.
957  *
958  * If the maximum number of index lines in the buffer is exceeded then the
959  * pager is cancelled and the contents of the current buffer are sent to the
960  * terminal.
961  *
962  * If there is no pager configured then the output is sent directly to the
963  * terminal.
964  *
965  * @param cli_file_index Index of the CLI session where this output is
966  * directed.
967  * @param buffer String of printabe bytes to be output.
968  * @param buffer_bytes The number of bytes in @c buffer to be output.
969  */
970 static void
971 unix_vlib_cli_output (uword cli_file_index, u8 * buffer, uword buffer_bytes)
972 {
973  unix_main_t *um = &unix_main;
976  unix_cli_file_t *cf;
977  clib_file_t *uf;
978 
979  cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
981 
982  if (cf->no_pager || um->cli_pager_buffer_limit == 0 || cf->height == 0)
983  {
984  unix_vlib_cli_output_cooked (cf, uf, buffer, buffer_bytes);
985  }
986  else
987  {
988  word row = vec_len (cf->pager_index);
989  u8 *line;
991 
992  /* Index and add the output lines to the pager buffer. */
993  unix_cli_pager_add_line (cf, buffer, buffer_bytes);
994 
995  /* Now iterate what was added to display the lines.
996  * If we reach the bottom of the page, display a prompt.
997  */
998  while (row < vec_len (cf->pager_index))
999  {
1000  if (row < cf->height - 1)
1001  {
1002  /* output this line */
1003  pi = &cf->pager_index[row];
1004  line = cf->pager_vector[pi->line] + pi->offset;
1005  unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1006 
1007  /* if the last line didn't end in newline, and we're at the
1008  * bottom of the page, add a newline */
1009  if (line[pi->length - 1] != '\n' && row == cf->height - 2)
1010  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1011  }
1012  else
1013  {
1014  /* Display the pager prompt every 10 lines */
1015  if (!(row % 10))
1016  unix_cli_pager_prompt (cf, uf);
1017  }
1018  row++;
1019  }
1020 
1021  /* Check if we went over the pager buffer limit */
1022  if (vec_len (cf->pager_index) > um->cli_pager_buffer_limit)
1023  {
1024  /* Stop using the pager for the remainder of this CLI command */
1025  cf->no_pager = 2;
1026 
1027  /* If we likely printed the prompt, erase it */
1028  if (vec_len (cf->pager_index) > cf->height - 1)
1029  unix_cli_pager_prompt_erase (cf, uf);
1030 
1031  /* Dump out the contents of the buffer */
1032  for (row = cf->pager_start + (cf->height - 1);
1033  row < vec_len (cf->pager_index); row++)
1034  {
1035  pi = &cf->pager_index[row];
1036  line = cf->pager_vector[pi->line] + pi->offset;
1037  unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1038  }
1039 
1040  unix_cli_pager_reset (cf);
1041  }
1042  }
1043 }
1044 
1045 /** Identify whether a terminal type is ANSI capable.
1046  *
1047  * Compares the string given in @c term with a list of terminal types known
1048  * to support ANSI escape sequences.
1049  *
1050  * This list contains, for example, @c xterm, @c screen and @c ansi.
1051  *
1052  * @param term A string with a terminal type in it.
1053  * @param len The length of the string in @c term.
1054  *
1055  * @return @c 1 if the terminal type is recognized as supporting ANSI
1056  * terminal sequences; @c 0 otherwise.
1057  */
1058 static u8
1060 {
1061  /* This may later be better done as a hash of some sort. */
1062 #define _(a) do { \
1063  if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1064  } while(0)
1065 
1066  _("xterm");
1067  _("xterm-color");
1068  _("xterm-256color"); /* iTerm on Mac */
1069  _("screen");
1070  _("screen-256color"); /* Screen and tmux */
1071  _("ansi"); /* Microsoft Telnet */
1072 #undef _
1073 
1074  return 0;
1075 }
1076 
1077 /** Identify whether a terminal type is non-interactive.
1078  *
1079  * Compares the string given in @c term with a list of terminal types known
1080  * to be non-interactive, as send by tools such as @c vppctl .
1081  *
1082  * This list contains, for example, @c vppctl.
1083  *
1084  * @param term A string with a terminal type in it.
1085  * @param len The length of the string in @c term.
1086  *
1087  * @return @c 1 if the terminal type is recognized as being non-interactive;
1088  * @c 0 otherwise.
1089  */
1090 static u8
1092 {
1093  /* This may later be better done as a hash of some sort. */
1094 #define _(a) do { \
1095  if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1096  } while(0)
1097 
1098  _("vppctl");
1099 #undef _
1100 
1101  return 0;
1102 }
1103 
1104 /** Set a session to be non-interactive. */
1105 static void
1107 {
1108  /* Non-interactive sessions don't get these */
1109  cf->is_interactive = 0;
1110  cf->no_pager = 1;
1111  cf->history_limit = 0;
1112  cf->has_history = 0;
1113  cf->line_mode = 1;
1114 }
1115 
1116 /** @brief Emit initial welcome banner and prompt on a connection. */
1117 static void
1119 {
1120  unix_main_t *um = &unix_main;
1121  clib_file_main_t *fm = &file_main;
1123  unix_cli_banner_t *banner;
1124  int i, len;
1125 
1126  /* Mark the session as started if we get here */
1127  cf->started = 1;
1128 
1129  if (!(cf->is_interactive)) /* No banner for non-interactive sessions */
1130  return;
1131 
1132  /*
1133  * Put the first bytes directly into the buffer so that further output is
1134  * queued until everything is ready. (oterwise initial prompt can appear
1135  * mid way through VPP initialization)
1136  */
1137  unix_cli_add_pending_output (uf, cf, (u8 *) "\r", 1);
1138 
1139  if (!um->cli_no_banner)
1140  {
1141  if (cf->ansi_capable)
1142  {
1143  banner = unix_cli_banner_color;
1144  len = ARRAY_LEN (unix_cli_banner_color);
1145  }
1146  else
1147  {
1148  banner = unix_cli_banner;
1149  len = ARRAY_LEN (unix_cli_banner);
1150  }
1151 
1152  for (i = 0; i < len; i++)
1153  {
1155  banner[i].line, banner[i].length);
1156  }
1157  }
1158 
1159  /* Prompt. */
1160  unix_cli_cli_prompt (cf, uf);
1161 
1162 }
1163 
1164 /** @brief A failsafe triggered on a timer to ensure we send the prompt
1165  * to telnet sessions that fail to negotiate the terminal type. */
1166 static void
1168 {
1170  unix_cli_file_t *cf;
1171  (void) delay;
1172 
1173  /* Check the connection didn't close already */
1174  if (pool_is_free_index (cm->cli_file_pool, (uword) arg))
1175  return;
1176 
1177  cf = pool_elt_at_index (cm->cli_file_pool, (uword) arg);
1178 
1179  if (!cf->started)
1180  unix_cli_file_welcome (cm, cf);
1181 }
1182 
1183 /** @brief A mostly no-op Telnet state machine.
1184  * Process Telnet command bytes in a way that ensures we're mostly
1185  * transparent to the Telnet protocol. That is, it's mostly a no-op.
1186  *
1187  * @return -1 if we need more bytes, otherwise a positive integer number of
1188  * bytes to consume from the input_vector, not including the initial
1189  * IAC byte.
1190  */
1191 static i32
1193  unix_cli_file_t * cf,
1194  clib_file_t * uf, u8 * input_vector, uword len)
1195 {
1196  /* Input_vector starts at IAC byte.
1197  * See if we have a complete message; if not, return -1 so we wait for more.
1198  * if we have a complete message, consume those bytes from the vector.
1199  */
1200  i32 consume = 0;
1201 
1202  if (len == 1)
1203  return -1; /* want more bytes */
1204 
1205  switch (input_vector[1])
1206  {
1207  case IAC:
1208  /* two IAC's in a row means to pass through 0xff.
1209  * since that makes no sense here, just consume it.
1210  */
1211  consume = 1;
1212  break;
1213 
1214  case WILL:
1215  case WONT:
1216  case DO:
1217  case DONT:
1218  /* Expect 3 bytes */
1219  if (vec_len (input_vector) < 3)
1220  return -1; /* want more bytes */
1221 
1222  consume = 2;
1223  break;
1224 
1225  case SB:
1226  {
1227  /* Sub option - search ahead for IAC SE to end it */
1228  i32 i;
1229  for (i = 3; i < len && i < UNIX_CLI_MAX_DEPTH_TELNET; i++)
1230  {
1231  if (input_vector[i - 1] == IAC && input_vector[i] == SE)
1232  {
1233  /* We have a complete message; see if we care about it */
1234  switch (input_vector[2])
1235  {
1236  case TELOPT_TTYPE:
1237  if (input_vector[3] != 0)
1238  break;
1239  {
1240  /* See if the the terminal type is recognized */
1241  u8 *term = input_vector + 4;
1242  uword len = i - 5;
1243 
1244  /* See if the terminal type is ANSI capable */
1245  cf->ansi_capable =
1246  unix_cli_terminal_type_ansi (term, len);
1247 
1248  /* See if the terminal type indicates non-interactive */
1249  if (unix_cli_terminal_type_noninteractive (term, len))
1251  }
1252 
1253  /* If session not started, we can release the pause */
1254  if (!cf->started)
1255  /* Send the welcome banner and initial prompt */
1256  unix_cli_file_welcome (&unix_cli_main, cf);
1257  break;
1258 
1259  case TELOPT_NAWS:
1260  /* Window size */
1261  if (i != 8) /* check message is correct size */
1262  break;
1263 
1264  cf->width =
1265  clib_net_to_host_u16 (*((u16 *) (input_vector + 3)));
1268  if (cf->width == 0)
1270 
1271  cf->height =
1272  clib_net_to_host_u16 (*((u16 *) (input_vector + 5)));
1275  if (cf->height == 0)
1277 
1278  /* reindex pager buffer */
1280  /* redraw page */
1281  unix_cli_pager_redraw (cf, uf);
1282  break;
1283 
1284  default:
1285  break;
1286  }
1287  /* Consume it all */
1288  consume = i;
1289  break;
1290  }
1291  }
1292 
1293  if (i == UNIX_CLI_MAX_DEPTH_TELNET)
1294  consume = 1; /* hit max search depth, advance one byte */
1295 
1296  if (consume == 0)
1297  return -1; /* want more bytes */
1298 
1299  break;
1300  }
1301 
1302  case GA:
1303  case EL:
1304  case EC:
1305  case AO:
1306  case IP:
1307  case BREAK:
1308  case DM:
1309  case NOP:
1310  case SE:
1311  case EOR:
1312  case ABORT:
1313  case SUSP:
1314  case xEOF:
1315  /* Simple one-byte messages */
1316  consume = 1;
1317  break;
1318 
1319  case AYT:
1320  /* Are You There - trigger a visible response */
1321  consume = 1;
1322  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "fd.io VPP\n", 10);
1323  break;
1324 
1325  default:
1326  /* Unknown command! Eat the IAC byte */
1327  break;
1328  }
1329 
1330  return consume;
1331 }
1332 
1333 /** @brief Process actionable input.
1334  * Based on the \c action process the input; this typically involves
1335  * searching the command history or editing the current command line.
1336  */
1337 static int
1339  unix_main_t * um,
1340  unix_cli_file_t * cf,
1341  clib_file_t * uf,
1342  u8 input, unix_cli_parse_action_t action)
1343 {
1344  u8 *prev;
1345  u8 *save = 0;
1346  u8 **possible_commands;
1347  int j, delta;
1348 
1349  switch (action)
1350  {
1352  break;
1353 
1356  if (!cf->has_history || !cf->history_limit)
1357  break;
1358  if (cf->search_mode == 0)
1359  {
1360  /* Erase the current command (if any) */
1361  for (j = 0; j < (vec_len (cf->current_command)); j++)
1362  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b \b", 3);
1363 
1366  if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1367  cf->search_mode = -1;
1368  else
1369  cf->search_mode = 1;
1370  cf->cursor = 0;
1371  }
1372  else
1373  {
1374  if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1375  cf->search_mode = -1;
1376  else
1377  cf->search_mode = 1;
1378 
1379  cf->excursion += cf->search_mode;
1380  goto search_again;
1381  }
1382  break;
1383 
1385  /* Erase the command from the cursor to the start */
1386 
1387  /* Shimmy forwards to the new end of line position */
1388  delta = vec_len (cf->current_command) - cf->cursor;
1389  for (j = cf->cursor; j > delta; j--)
1390  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1391  /* Zap from here to the end of what is currently displayed */
1392  for (; j < (vec_len (cf->current_command)); j++)
1393  unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1394  /* Get back to the start of the line */
1395  for (j = 0; j < (vec_len (cf->current_command)); j++)
1396  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1397 
1398  j = vec_len (cf->current_command) - cf->cursor;
1399  memmove (cf->current_command, cf->current_command + cf->cursor, j);
1400  _vec_len (cf->current_command) = j;
1401 
1402  /* Print the new contents */
1404  /* Shimmy back to the start */
1405  for (j = 0; j < (vec_len (cf->current_command)); j++)
1406  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1407  cf->cursor = 0;
1408 
1409  cf->search_mode = 0;
1410  break;
1411 
1413  /* Erase the command from the cursor to the end */
1414 
1415  /* Zap from cursor to end of what is currently displayed */
1416  for (j = cf->cursor; j < (vec_len (cf->current_command)); j++)
1417  unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1418  /* Get back to where we were */
1419  for (j = cf->cursor; j < (vec_len (cf->current_command)); j++)
1420  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1421 
1422  /* Truncate the line at the cursor */
1423  _vec_len (cf->current_command) = cf->cursor;
1424 
1425  cf->search_mode = 0;
1426  break;
1427 
1429  if (cf->cursor > 0)
1430  {
1431  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1432  cf->cursor--;
1433  }
1434 
1435  cf->search_mode = 0;
1436  break;
1437 
1439  if (cf->cursor < vec_len (cf->current_command))
1440  {
1441  /* have to emit the character under the cursor */
1443  cf->current_command + cf->cursor, 1);
1444  cf->cursor++;
1445  }
1446 
1447  cf->search_mode = 0;
1448  break;
1449 
1452  if (!cf->has_history || !cf->history_limit)
1453  break;
1454  cf->search_mode = 0;
1455  /* Erase the command */
1456  for (j = cf->cursor; j < (vec_len (cf->current_command)); j++)
1457  unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1458  for (j = 0; j < (vec_len (cf->current_command)); j++)
1459  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b \b", 3);
1461  if (vec_len (cf->command_history))
1462  {
1463  if (action == UNIX_CLI_PARSE_ACTION_UP)
1464  delta = -1;
1465  else
1466  delta = 1;
1467 
1468  cf->excursion += delta;
1469 
1470  if (cf->excursion == vec_len (cf->command_history))
1471  {
1472  /* down-arrowed to last entry - want a blank line */
1473  _vec_len (cf->current_command) = 0;
1474  }
1475  else if (cf->excursion < 0)
1476  {
1477  /* up-arrowed over the start to the end, want a blank line */
1478  cf->excursion = vec_len (cf->command_history);
1479  _vec_len (cf->current_command) = 0;
1480  }
1481  else
1482  {
1483  if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1484  /* down-arrowed past end - wrap to start */
1485  cf->excursion = 0;
1486 
1487  /* Print the command at the current position */
1488  prev = cf->command_history[cf->excursion];
1489  vec_validate (cf->current_command, vec_len (prev) - 1);
1490 
1491  clib_memcpy (cf->current_command, prev, vec_len (prev));
1492  _vec_len (cf->current_command) = vec_len (prev);
1494  vec_len (cf->current_command));
1495  }
1496  }
1497  cf->cursor = vec_len (cf->current_command);
1498  break;
1499 
1501  if (vec_len (cf->current_command) && cf->cursor > 0)
1502  {
1503  while (cf->cursor)
1504  {
1505  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1506  cf->cursor--;
1507  }
1508  }
1509 
1510  cf->search_mode = 0;
1511  break;
1512 
1514  if (vec_len (cf->current_command) &&
1515  cf->cursor < vec_len (cf->current_command))
1516  {
1518  cf->current_command + cf->cursor,
1519  vec_len (cf->current_command) -
1520  cf->cursor);
1521  cf->cursor = vec_len (cf->current_command);
1522  }
1523 
1524  cf->search_mode = 0;
1525  break;
1526 
1528  if (vec_len (cf->current_command) && cf->cursor > 0)
1529  {
1530  j = cf->cursor;
1531 
1532  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1533  j--;
1534 
1535  while (j && isspace (cf->current_command[j]))
1536  {
1537  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1538  j--;
1539  }
1540  while (j && !isspace (cf->current_command[j]))
1541  {
1542  if (isspace (cf->current_command[j - 1]))
1543  break;
1544  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1545  j--;
1546  }
1547 
1548  cf->cursor = j;
1549  }
1550 
1551  cf->search_mode = 0;
1552  break;
1553 
1555  if (vec_len (cf->current_command) &&
1556  cf->cursor < vec_len (cf->current_command))
1557  {
1558  int e = vec_len (cf->current_command);
1559  j = cf->cursor;
1560  while (j < e && !isspace (cf->current_command[j]))
1561  j++;
1562  while (j < e && isspace (cf->current_command[j]))
1563  j++;
1565  cf->current_command + cf->cursor,
1566  j - cf->cursor);
1567  cf->cursor = j;
1568  }
1569 
1570  cf->search_mode = 0;
1571  break;
1572 
1573 
1575  if (vec_len (cf->current_command))
1576  {
1577  if (cf->cursor == vec_len (cf->current_command))
1578  {
1579  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b \b", 3);
1580  _vec_len (cf->current_command)--;
1581  cf->cursor--;
1582  }
1583  else if (cf->cursor > 0)
1584  {
1585  /* shift everything at & to the right of the cursor left by 1 */
1586  j = vec_len (cf->current_command) - cf->cursor;
1587  memmove (cf->current_command + cf->cursor - 1,
1588  cf->current_command + cf->cursor, j);
1589  _vec_len (cf->current_command)--;
1590  cf->cursor--;
1591  /* redraw the rest of the line */
1592  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1594  cf->current_command + cf->cursor,
1595  j);
1596  unix_vlib_cli_output_cooked (cf, uf, (u8 *) " \b\b", 3);
1597  /* and shift the terminal cursor back where it should be */
1598  while (--j)
1599  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1600  }
1601  }
1602  cf->search_mode = 0;
1603  cf->excursion = 0;
1605  break;
1606 
1608  if (vec_len (cf->current_command))
1609  {
1610  if (cf->cursor < vec_len (cf->current_command))
1611  {
1612  /* shift everything to the right of the cursor left by 1 */
1613  j = vec_len (cf->current_command) - cf->cursor - 1;
1614  memmove (cf->current_command + cf->cursor,
1615  cf->current_command + cf->cursor + 1, j);
1616  _vec_len (cf->current_command)--;
1617  /* redraw the rest of the line */
1619  cf->current_command + cf->cursor,
1620  j);
1621  unix_vlib_cli_output_cooked (cf, uf, (u8 *) " \b", 2);
1622  /* and shift the terminal cursor back where it should be */
1623  if (j)
1624  {
1625  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1626  while (--j)
1627  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1628  }
1629  }
1630  }
1631  else if (input == 'D' - '@')
1632  {
1633  /* ^D with no command entered = quit */
1634  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "quit\n", 5);
1638  cf - cm->cli_file_pool);
1639  }
1640  cf->search_mode = 0;
1641  cf->excursion = 0;
1643  break;
1644 
1646  /* If we're in ANSI mode, clear the screen.
1647  * Then redraw the prompt and any existing command input, then put
1648  * the cursor back where it was in that line.
1649  */
1650  if (cf->ansi_capable)
1652  (u8 *) ANSI_CLEAR,
1653  sizeof (ANSI_CLEAR) - 1);
1654  else
1655  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1656 
1657  unix_vlib_cli_output_raw (cf, uf,
1658  cm->cli_prompt, vec_len (cm->cli_prompt));
1659  unix_vlib_cli_output_raw (cf, uf,
1660  cf->current_command,
1661  vec_len (cf->current_command));
1662  for (j = cf->cursor; j < vec_len (cf->current_command); j++)
1663  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1664 
1665  break;
1666 
1668  if (cf->cursor < vec_len (cf->current_command))
1669  {
1670  /* if we are in the middle of a line, complete only if
1671  * the cursor points to whitespace */
1672  if (isspace (cf->current_command[cf->cursor]))
1673  {
1674  /* save and clear any input that is after the cursor */
1675  vec_resize (save, vec_len (cf->current_command) - cf->cursor);
1676  clib_memcpy (save, cf->current_command + cf->cursor,
1677  vec_len (cf->current_command) - cf->cursor);
1678  _vec_len (cf->current_command) = cf->cursor;
1679  }
1680  else
1681  {
1682  unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1683  break;
1684  }
1685  }
1686  possible_commands =
1688  if (vec_len (possible_commands) == 1)
1689  {
1690  u32 j = cf->cursor;
1691  u8 *completed = possible_commands[0];
1692 
1693  /* find the last word of current_command */
1694  while (j >= 1 && !isspace (cf->current_command[j - 1]))
1695  {
1696  j--;
1697  unix_vlib_cli_output_raw (cf, uf, (u8 *) "\b", 1);
1698  }
1699  _vec_len (cf->current_command) = j;
1700 
1701  /* replace it with the newly expanded command */
1702  vec_append (cf->current_command, completed);
1703 
1704  /* echo to the terminal */
1705  unix_vlib_cli_output_raw (cf, uf, completed, vec_len (completed));
1706 
1707  /* add one trailing space if needed */
1708  if (vec_len (save) == 0)
1709  {
1710  vec_add1 (cf->current_command, ' ');
1711  unix_vlib_cli_output_raw (cf, uf, (u8 *) " ", 1);
1712  }
1713 
1714  cf->cursor = vec_len (cf->current_command);
1715 
1716  }
1717  else if (vec_len (possible_commands) >= 2)
1718  {
1719  u8 **possible_command;
1720  uword max_command_len = 0, min_command_len = ~0;
1721  u32 i, j;
1722 
1723  vec_foreach (possible_command, possible_commands)
1724  {
1725  if (vec_len (*possible_command) > max_command_len)
1726  {
1727  max_command_len = vec_len (*possible_command);
1728  }
1729  if (vec_len (*possible_command) < min_command_len)
1730  {
1731  min_command_len = vec_len (*possible_command);
1732  }
1733  }
1734 
1735  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1736 
1737  i = 0;
1738  vec_foreach (possible_command, possible_commands)
1739  {
1740  if (i + max_command_len >= cf->width)
1741  {
1742  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1743  i = 0;
1744  }
1745  unix_vlib_cli_output_raw (cf, uf, *possible_command,
1746  vec_len (*possible_command));
1747  for (j = vec_len (*possible_command); j < max_command_len + 2;
1748  j++)
1749  {
1750  unix_vlib_cli_output_raw (cf, uf, (u8 *) " ", 1);
1751  }
1752  i += max_command_len + 2;
1753  }
1754 
1755  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1756 
1757  /* rewrite prompt */
1758  unix_cli_cli_prompt (cf, uf);
1760  vec_len (cf->current_command));
1761 
1762  /* count length of last word */
1763  j = cf->cursor;
1764  i = 0;
1765  while (j >= 1 && !isspace (cf->current_command[j - 1]))
1766  {
1767  j--;
1768  i++;
1769  }
1770 
1771  /* determine smallest common command */
1772  for (; i < min_command_len; i++)
1773  {
1774  u8 common = '\0';
1775  int stop = 0;
1776  vec_foreach (possible_command, possible_commands)
1777  {
1778  if (common == '\0')
1779  {
1780  common = (*possible_command)[i];
1781  }
1782  else if (common != (*possible_command)[i])
1783  {
1784  stop = 1;
1785  break;
1786  }
1787  }
1788  if (!stop)
1789  {
1790  vec_add1 (cf->current_command, common);
1791  cf->cursor++;
1792  unix_vlib_cli_output_raw (cf, uf, (u8 *) & common, 1);
1793  }
1794  else
1795  {
1796  break;
1797  }
1798  }
1799  }
1800  else
1801  {
1802  unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1803  }
1804 
1805  if (vec_len (save) > 0)
1806  {
1807  /* restore remaining input if tab was hit in the middle of a line */
1808  unix_vlib_cli_output_raw (cf, uf, save, vec_len (save));
1809  for (j = 0; j < vec_len (save); j++)
1810  {
1811  unix_vlib_cli_output_raw (cf, uf, (u8 *) "\b", 1);
1812  }
1813  vec_append (cf->current_command, save);
1814  vec_free (save);
1815  }
1816  vec_free (possible_commands);
1817 
1818  break;
1820  /* TODO */
1821  break;
1822 
1823 
1825  pager_quit:
1826  unix_cli_pager_prompt_erase (cf, uf);
1827  unix_cli_pager_reset (cf);
1828  unix_cli_cli_prompt (cf, uf);
1829  break;
1830 
1833  /* show next page of the buffer */
1834  if (cf->height + cf->pager_start < vec_len (cf->pager_index))
1835  {
1836  u8 *line = NULL;
1838 
1839  int m = cf->pager_start + (cf->height - 1);
1840  unix_cli_pager_prompt_erase (cf, uf);
1841  for (j = m;
1842  j < vec_len (cf->pager_index) && cf->pager_start < m;
1843  j++, cf->pager_start++)
1844  {
1845  pi = &cf->pager_index[j];
1846  line = cf->pager_vector[pi->line] + pi->offset;
1847  unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1848  }
1849  /* if the last line didn't end in newline, add a newline */
1850  if (pi && line[pi->length - 1] != '\n')
1851  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1852  unix_cli_pager_prompt (cf, uf);
1853  }
1854  else
1855  {
1856  if (action == UNIX_CLI_PARSE_ACTION_PAGER_NEXT)
1857  /* no more in buffer, exit, but only if it was <space> */
1858  goto pager_quit;
1859  }
1860  break;
1861 
1864  /* display the next line of the buffer */
1865  if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
1866  {
1867  u8 *line;
1869 
1870  unix_cli_pager_prompt_erase (cf, uf);
1871  pi = &cf->pager_index[cf->pager_start + (cf->height - 1)];
1872  line = cf->pager_vector[pi->line] + pi->offset;
1873  unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1874  cf->pager_start++;
1875  /* if the last line didn't end in newline, add a newline */
1876  if (line[pi->length - 1] != '\n')
1877  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1878  unix_cli_pager_prompt (cf, uf);
1879  }
1880  else
1881  {
1882  if (action == UNIX_CLI_PARSE_ACTION_PAGER_CRLF)
1883  /* no more in buffer, exit, but only if it was <enter> */
1884  goto pager_quit;
1885  }
1886 
1887  break;
1888 
1890  /* scroll the page back one line */
1891  if (cf->pager_start > 0)
1892  {
1893  u8 *line = NULL;
1895 
1896  cf->pager_start--;
1897  if (cf->ansi_capable)
1898  {
1899  pi = &cf->pager_index[cf->pager_start];
1900  line = cf->pager_vector[pi->line] + pi->offset;
1901  unix_cli_pager_prompt_erase (cf, uf);
1903  sizeof (ANSI_SCROLLDN) - 1);
1905  sizeof (ANSI_SAVECURSOR) - 1);
1906  unix_cli_ansi_cursor (cf, uf, 1, 1);
1908  sizeof (ANSI_CLEARLINE) - 1);
1909  unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1911  sizeof (ANSI_RESTCURSOR) - 1);
1912  unix_cli_pager_prompt_erase (cf, uf);
1913  unix_cli_pager_prompt (cf, uf);
1914  }
1915  else
1916  {
1917  int m = cf->pager_start + (cf->height - 1);
1918  unix_cli_pager_prompt_erase (cf, uf);
1919  for (j = cf->pager_start;
1920  j < vec_len (cf->pager_index) && j < m; j++)
1921  {
1922  pi = &cf->pager_index[j];
1923  line = cf->pager_vector[pi->line] + pi->offset;
1924  unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1925  }
1926  /* if the last line didn't end in newline, add a newline */
1927  if (pi && line[pi->length - 1] != '\n')
1928  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1929  unix_cli_pager_prompt (cf, uf);
1930  }
1931  }
1932  break;
1933 
1935  /* back to the first page of the buffer */
1936  if (cf->pager_start > 0)
1937  {
1938  u8 *line = NULL;
1940 
1941  cf->pager_start = 0;
1942  int m = cf->pager_start + (cf->height - 1);
1943  unix_cli_pager_prompt_erase (cf, uf);
1944  for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
1945  j++)
1946  {
1947  pi = &cf->pager_index[j];
1948  line = cf->pager_vector[pi->line] + pi->offset;
1949  unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1950  }
1951  /* if the last line didn't end in newline, add a newline */
1952  if (pi && line[pi->length - 1] != '\n')
1953  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1954  unix_cli_pager_prompt (cf, uf);
1955  }
1956  break;
1957 
1959  /* skip to the last page of the buffer */
1960  if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
1961  {
1962  u8 *line = NULL;
1964 
1965  cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
1966  unix_cli_pager_prompt_erase (cf, uf);
1967  unix_cli_pager_message (cf, uf, "skipping", "\n");
1968  for (j = cf->pager_start; j < vec_len (cf->pager_index); j++)
1969  {
1970  pi = &cf->pager_index[j];
1971  line = cf->pager_vector[pi->line] + pi->offset;
1972  unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1973  }
1974  /* if the last line didn't end in newline, add a newline */
1975  if (pi && line[pi->length - 1] != '\n')
1976  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1977  unix_cli_pager_prompt (cf, uf);
1978  }
1979  break;
1980 
1982  /* wander back one page in the buffer */
1983  if (cf->pager_start > 0)
1984  {
1985  u8 *line = NULL;
1987  int m;
1988 
1989  if (cf->pager_start >= cf->height)
1990  cf->pager_start -= cf->height - 1;
1991  else
1992  cf->pager_start = 0;
1993  m = cf->pager_start + cf->height - 1;
1994  unix_cli_pager_prompt_erase (cf, uf);
1995  for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
1996  j++)
1997  {
1998  pi = &cf->pager_index[j];
1999  line = cf->pager_vector[pi->line] + pi->offset;
2000  unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2001  }
2002  /* if the last line didn't end in newline, add a newline */
2003  if (pi && line[pi->length - 1] != '\n')
2004  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2005  unix_cli_pager_prompt (cf, uf);
2006  }
2007  break;
2008 
2010  /* Redraw the current pager screen */
2011  unix_cli_pager_redraw (cf, uf);
2012  break;
2013 
2015  /* search forwards in the buffer */
2016  break;
2017 
2018 
2020  crlf:
2021  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2022 
2023  if (cf->has_history && cf->history_limit)
2024  {
2025  if (cf->command_history
2026  && vec_len (cf->command_history) >= cf->history_limit)
2027  {
2028  vec_free (cf->command_history[0]);
2029  vec_delete (cf->command_history, 1, 0);
2030  }
2031  /* Don't add blank lines to the cmd history */
2032  if (vec_len (cf->current_command))
2033  {
2034  /* Don't duplicate the previous command */
2035  j = vec_len (cf->command_history);
2036  if (j == 0 ||
2037  (vec_len (cf->current_command) !=
2038  vec_len (cf->command_history[j - 1])
2039  || memcmp (cf->current_command, cf->command_history[j - 1],
2040  vec_len (cf->current_command)) != 0))
2041  {
2042  /* copy the command to the history */
2043  u8 *c = 0;
2044  vec_append (c, cf->current_command);
2045  vec_add1 (cf->command_history, c);
2046  cf->command_number++;
2047  }
2048  }
2049  cf->excursion = vec_len (cf->command_history);
2050  }
2051 
2052  cf->search_mode = 0;
2054  cf->cursor = 0;
2055 
2056  return 0;
2057 
2060  if (vec_len (cf->pager_index))
2061  {
2062  /* no-op for now */
2063  }
2064  else if (cf->has_history && cf->search_mode && isprint (input))
2065  {
2066  int k, limit, offset;
2067  u8 *item;
2068 
2069  vec_add1 (cf->search_key, input);
2070 
2071  search_again:
2072  for (j = 0; j < vec_len (cf->command_history); j++)
2073  {
2074  if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
2075  cf->excursion = 0;
2076  else if (cf->excursion < 0)
2077  cf->excursion = vec_len (cf->command_history) - 1;
2078 
2079  item = cf->command_history[cf->excursion];
2080 
2081  limit = (vec_len (cf->search_key) > vec_len (item)) ?
2082  vec_len (item) : vec_len (cf->search_key);
2083 
2084  for (offset = 0; offset <= vec_len (item) - limit; offset++)
2085  {
2086  for (k = 0; k < limit; k++)
2087  {
2088  if (item[k + offset] != cf->search_key[k])
2089  goto next_offset;
2090  }
2091  goto found_at_offset;
2092 
2093  next_offset:
2094  ;
2095  }
2096  goto next;
2097 
2098  found_at_offset:
2099  for (j = 0; j < vec_len (cf->current_command); j++)
2100  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b \b", 3);
2101 
2102  vec_validate (cf->current_command, vec_len (item) - 1);
2103  clib_memcpy (cf->current_command, item, vec_len (item));
2104  _vec_len (cf->current_command) = vec_len (item);
2105 
2107  vec_len (cf->current_command));
2108  cf->cursor = vec_len (cf->current_command);
2109  goto found;
2110 
2111  next:
2112  cf->excursion += cf->search_mode;
2113  }
2114 
2115  unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\nNo match...", 12);
2118  cf->search_mode = 0;
2119  cf->cursor = 0;
2120  goto crlf;
2121  }
2122  else if (isprint (input)) /* skip any errant control codes */
2123  {
2124  if (cf->cursor == vec_len (cf->current_command))
2125  {
2126  /* Append to end */
2127  vec_add1 (cf->current_command, input);
2128  cf->cursor++;
2129 
2130  /* Echo the character back to the client */
2131  unix_vlib_cli_output_raw (cf, uf, &input, 1);
2132  }
2133  else
2134  {
2135  /* Insert at cursor: resize +1 byte, move everything over */
2136  j = vec_len (cf->current_command) - cf->cursor;
2137  vec_add1 (cf->current_command, (u8) 'A');
2138  memmove (cf->current_command + cf->cursor + 1,
2139  cf->current_command + cf->cursor, j);
2140  cf->current_command[cf->cursor] = input;
2141  /* Redraw the line */
2142  j++;
2143  unix_vlib_cli_output_raw (cf, uf,
2144  cf->current_command + cf->cursor, j);
2145  /* Put terminal cursor back */
2146  while (--j)
2147  unix_vlib_cli_output_raw (cf, uf, (u8 *) "\b", 1);
2148  cf->cursor++;
2149  }
2150  }
2151  else
2152  {
2153  /* no-op - not printable or otherwise not actionable */
2154  }
2155 
2156  found:
2157 
2158  break;
2159 
2161  break;
2162  }
2163  return 1;
2164 }
2165 
2166 /** @brief Process input bytes on a stream to provide line editing and
2167  * command history in the CLI. */
2168 static int
2170  clib_file_main_t * fm, unix_cli_file_t * cf)
2171 {
2173  int i;
2174 
2175  for (i = 0; i < vec_len (cf->input_vector); i++)
2176  {
2177  unix_cli_parse_action_t action;
2178  i32 matched = 0;
2180 
2181  /* If we're in the pager mode, search the pager actions */
2182  a =
2183  vec_len (cf->pager_index) ? unix_cli_parse_pager :
2185 
2186  /* See if the input buffer is some sort of control code */
2187  action = unix_cli_match_action (a, &cf->input_vector[i],
2188  vec_len (cf->input_vector) - i,
2189  &matched);
2190 
2191  switch (action)
2192  {
2194  if (i)
2195  {
2196  /* There was a partial match which means we need more bytes
2197  * than the input buffer currently has.
2198  * Since the bytes before here have been processed, shift
2199  * the remaining contents to the start of the input buffer.
2200  */
2201  vec_delete (cf->input_vector, i, 0);
2202  }
2203  return 1; /* wait for more */
2204 
2206  /* process telnet options */
2207  matched = unix_cli_process_telnet (um, cf, uf,
2208  cf->input_vector + i,
2209  vec_len (cf->input_vector) - i);
2210  if (matched < 0)
2211  {
2212  /* There was a partial match which means we need more bytes
2213  * than the input buffer currently has.
2214  */
2215  if (i)
2216  {
2217  /*
2218  * Since the bytes before here have been processed, shift
2219  * the remaining contents to the start of the input buffer.
2220  */
2221  vec_delete (cf->input_vector, i, 0);
2222  }
2223  return 1; /* wait for more */
2224  }
2225  break;
2226 
2227  default:
2228  /* If telnet option processing switched us to line mode, get us
2229  * out of here!
2230  */
2231  if (cf->line_mode)
2232  {
2233  vec_delete (cf->input_vector, i, 0);
2234  cf->current_command = cf->input_vector;
2235  return 0;
2236  }
2237 
2238  /* process the action */
2239  if (!unix_cli_line_process_one (cm, um, cf, uf,
2240  cf->input_vector[i], action))
2241  {
2242  /* CRLF found. Consume the bytes from the input_vector */
2243  vec_delete (cf->input_vector, i + matched, 0);
2244  /* And tell our caller to execute cf->input_command */
2245  return 0;
2246  }
2247  }
2248 
2249  i += matched;
2250  }
2251 
2253  return 1;
2254 }
2255 
2256 /** @brief Process input to a CLI session. */
2257 static void
2259 {
2260  unix_main_t *um = &unix_main;
2261  clib_file_main_t *fm = &file_main;
2262  clib_file_t *uf;
2263  unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2264  unformat_input_t input;
2265  int vlib_parse_eval (u8 *);
2266 
2267  cm->current_input_file_index = cli_file_index;
2268 
2269 more:
2270  /* Try vlibplex first. Someday... */
2271  if (0 && vlib_parse_eval (cf->input_vector) == 0)
2272  goto done;
2273 
2274 
2275  if (cf->line_mode)
2276  {
2277  /* just treat whatever we got as a complete line of input */
2278  cf->current_command = cf->input_vector;
2279  }
2280  else
2281  {
2282  /* Line edit, echo, etc. */
2283  if (unix_cli_line_edit (cm, um, fm, cf))
2284  /* want more input */
2285  return;
2286  }
2287 
2288  if (um->log_fd)
2289  {
2290  static u8 *lv;
2291  vec_reset_length (lv);
2292  lv = format (lv, "%U[%d]: %v",
2293  format_timeval, 0 /* current bat-time */ ,
2294  0 /* current bat-format */ ,
2295  cli_file_index, cf->current_command);
2296  int rv __attribute__ ((unused)) = write (um->log_fd, lv, vec_len (lv));
2297  }
2298 
2299  /* Build an unformat structure around our command */
2300  unformat_init_vector (&input, cf->current_command);
2301 
2302  /* Remove leading white space from input. */
2303  (void) unformat (&input, "");
2304 
2305  cf->pager_start = 0; /* start a new pager session */
2306 
2309  cli_file_index);
2310 
2311  /* Zero buffer since otherwise unformat_free will call vec_free on it. */
2312  input.buffer = 0;
2313 
2314  unformat_free (&input);
2315 
2316  /* Re-fetch pointer since pool may have moved. */
2317  cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2319 
2320 done:
2321  /* reset vector; we'll re-use it later */
2322  if (cf->line_mode)
2323  {
2325  cf->current_command = 0;
2326  }
2327  else
2328  {
2330  }
2331 
2332  if (cf->no_pager == 2)
2333  {
2334  /* Pager was programmatically disabled */
2335  unix_cli_pager_message (cf, uf, "pager buffer overflowed", "\n");
2336  cf->no_pager = um->cli_no_pager;
2337  }
2338 
2339  if (vec_len (cf->pager_index) == 0
2340  || vec_len (cf->pager_index) < cf->height)
2341  {
2342  /* There was no need for the pager */
2343  unix_cli_pager_reset (cf);
2344 
2345  /* Prompt. */
2346  unix_cli_cli_prompt (cf, uf);
2347  }
2348  else
2349  {
2350  /* Display the pager prompt */
2351  unix_cli_pager_prompt (cf, uf);
2352  }
2353 
2354  /* Any residual data in the input vector? */
2355  if (vec_len (cf->input_vector))
2356  goto more;
2357 
2358  /* For non-interactive sessions send a NUL byte.
2359  * Specifically this is because vppctl needs to see some traffic in
2360  * order to move on to closing the session. Commands with no output
2361  * would thus cause vppctl to hang indefinitely in non-interactive mode
2362  * since there is also no prompt sent after the command completes.
2363  */
2364  if (!cf->is_interactive)
2365  unix_vlib_cli_output_raw (cf, uf, (u8 *) "\0", 1);
2366 }
2367 
2368 /** Destroy a CLI session.
2369  * @note If we destroy the @c stdin session this additionally signals
2370  * the shutdown of VPP.
2371  */
2372 static void
2373 unix_cli_kill (unix_cli_main_t * cm, uword cli_file_index)
2374 {
2375  unix_main_t *um = &unix_main;
2376  clib_file_main_t *fm = &file_main;
2377  unix_cli_file_t *cf;
2378  clib_file_t *uf;
2379  int i;
2380 
2381  cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2383 
2384  /* Quit/EOF on stdin means quit program. */
2385  if (uf->file_descriptor == STDIN_FILENO)
2387 
2388  vec_free (cf->current_command);
2389  vec_free (cf->search_key);
2390 
2391  for (i = 0; i < vec_len (cf->command_history); i++)
2392  vec_free (cf->command_history[i]);
2393 
2394  vec_free (cf->command_history);
2395 
2396  clib_file_del (fm, uf);
2397 
2398  unix_cli_file_free (cf);
2399  pool_put (cm->cli_file_pool, cf);
2400 }
2401 
2402 /** Handle system events. */
2403 static uword
2406 {
2408  uword i, *data = 0;
2409 
2410  while (1)
2411  {
2412  unix_cli_process_event_type_t event_type;
2414  event_type = vlib_process_get_events (vm, &data);
2415 
2416  switch (event_type)
2417  {
2419  for (i = 0; i < vec_len (data); i++)
2420  unix_cli_process_input (cm, data[i]);
2421  break;
2422 
2424  /* Kill this process. */
2425  for (i = 0; i < vec_len (data); i++)
2426  unix_cli_kill (cm, data[i]);
2427  goto done;
2428  }
2429 
2430  if (data)
2431  _vec_len (data) = 0;
2432  }
2433 
2434 done:
2435  vec_free (data);
2436 
2437  vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
2438 
2439  /* Add node index so we can re-use this process later. */
2441 
2442  return 0;
2443 }
2444 
2445 /** Called when a CLI session file descriptor can be written to without
2446  * blocking. */
2447 static clib_error_t *
2449 {
2451  unix_cli_file_t *cf;
2452  int n;
2453 
2455 
2456  /* Flush output vector. */
2457  if (cf->is_socket)
2458  /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
2459  n = send (uf->file_descriptor,
2460  cf->output_vector, vec_len (cf->output_vector), MSG_NOSIGNAL);
2461  else
2462  n = write (uf->file_descriptor,
2463  cf->output_vector, vec_len (cf->output_vector));
2464 
2465  if (n < 0 && errno != EAGAIN)
2466  {
2467  if (errno == EPIPE)
2468  {
2469  /* connection closed on us */
2470  unix_main_t *um = &unix_main;
2471  cf->has_epipe = 1;
2474  uf->private_data);
2475  }
2476  else
2477  {
2478  return clib_error_return_unix (0, "write");
2479  }
2480  }
2481 
2482  else if (n > 0)
2483  unix_cli_del_pending_output (uf, cf, n);
2484 
2485  return /* no error */ 0;
2486 }
2487 
2488 /** Called when a CLI session file descriptor has data to be read. */
2489 static clib_error_t *
2491 {
2492  unix_main_t *um = &unix_main;
2494  unix_cli_file_t *cf;
2495  uword l;
2496  int n, n_read, n_try;
2497 
2499 
2500  n = n_try = 4096;
2501  while (n == n_try)
2502  {
2503  l = vec_len (cf->input_vector);
2504  vec_resize (cf->input_vector, l + n_try);
2505 
2506  n = read (uf->file_descriptor, cf->input_vector + l, n_try);
2507 
2508  /* Error? */
2509  if (n < 0 && errno != EAGAIN)
2510  return clib_error_return_unix (0, "read");
2511 
2512  n_read = n < 0 ? 0 : n;
2513  _vec_len (cf->input_vector) = l + n_read;
2514  }
2515 
2516  if (!(n < 0))
2518  cf->process_node_index,
2519  (n_read == 0
2522  /* event data */ uf->private_data);
2523 
2524  return /* no error */ 0;
2525 }
2526 
2527 /** Called when a CLI session file descriptor has an error condition. */
2528 static clib_error_t *
2530 {
2531  unix_main_t *um = &unix_main;
2533  unix_cli_file_t *cf;
2534 
2536  cf->has_epipe = 1; /* prevent writes while the close is pending */
2538  cf->process_node_index,
2540  /* event data */ uf->private_data);
2541 
2542  return /* no error */ 0;
2543 }
2544 
2545 /** Store a new CLI session.
2546  * @param name The name of the session.
2547  * @param fd The file descriptor for the session I/O.
2548  * @return The session ID.
2549  */
2550 static u32
2551 unix_cli_file_add (unix_cli_main_t * cm, char *name, int fd)
2552 {
2553  unix_main_t *um = &unix_main;
2554  clib_file_main_t *fm = &file_main;
2555  unix_cli_file_t *cf;
2556  clib_file_t template = { 0 };
2557  vlib_main_t *vm = um->vlib_main;
2558  vlib_node_t *n;
2559 
2560  name = (char *) format (0, "unix-cli-%s", name);
2561 
2563  {
2565 
2566  /* Find node and give it new name. */
2567  n = vlib_get_node (vm, cm->unused_cli_process_node_indices[l - 1]);
2568  vec_free (n->name);
2569  n->name = (u8 *) name;
2570 
2571  vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
2572 
2573  _vec_len (cm->unused_cli_process_node_indices) = l - 1;
2574  }
2575  else
2576  {
2577  static vlib_node_registration_t r = {
2578  .function = unix_cli_process,
2579  .type = VLIB_NODE_TYPE_PROCESS,
2580  .process_log2_n_stack_bytes = 16,
2581  };
2582 
2583  r.name = name;
2584  vlib_register_node (vm, &r);
2585  vec_free (name);
2586 
2587  n = vlib_get_node (vm, r.index);
2588  }
2589 
2590  pool_get (cm->cli_file_pool, cf);
2591  memset (cf, 0, sizeof (*cf));
2592 
2593  template.read_function = unix_cli_read_ready;
2594  template.write_function = unix_cli_write_ready;
2595  template.error_function = unix_cli_error_detected;
2596  template.file_descriptor = fd;
2597  template.private_data = cf - cm->cli_file_pool;
2598 
2599  cf->process_node_index = n->index;
2600  cf->clib_file_index = clib_file_add (fm, &template);
2601  cf->output_vector = 0;
2602  cf->input_vector = 0;
2603 
2605 
2608  p->output_function_arg = cf - cm->cli_file_pool;
2609 
2610  return cf - cm->cli_file_pool;
2611 }
2612 
2613 /** Telnet listening socket has a new connection. */
2614 static clib_error_t *
2616 {
2617  unix_main_t *um = &unix_main;
2618  clib_file_main_t *fm = &file_main;
2620  clib_socket_t *s = &um->cli_listen_socket;
2621  clib_socket_t client;
2622  char *client_name;
2623  clib_error_t *error;
2624  unix_cli_file_t *cf;
2625  u32 cf_index;
2626 
2627  error = clib_socket_accept (s, &client);
2628  if (error)
2629  return error;
2630 
2631  client_name = (char *) format (0, "%U%c", format_sockaddr, &client.peer, 0);
2632 
2633  cf_index = unix_cli_file_add (cm, client_name, client.fd);
2634  cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2635  cf->is_socket = 1;
2636 
2637  /* No longer need CLIB version of socket. */
2638  clib_socket_free (&client);
2639  vec_free (client_name);
2640 
2641  /* if we're supposed to run telnet session in character mode (default) */
2642  if (um->cli_line_mode == 0)
2643  {
2644  /*
2645  * Set telnet client character mode, echo on, suppress "go-ahead".
2646  * Technically these should be negotiated, but this works.
2647  */
2648  u8 charmode_option[] = {
2649  IAC, WONT, TELOPT_LINEMODE, /* server will do char-by-char */
2650  IAC, DONT, TELOPT_LINEMODE, /* client should do char-by-char */
2651  IAC, WILL, TELOPT_SGA, /* server willl supress GA */
2652  IAC, DO, TELOPT_SGA, /* client should supress Go Ahead */
2653  IAC, WILL, TELOPT_ECHO, /* server will do echo */
2654  IAC, DONT, TELOPT_ECHO, /* client should not echo */
2655  IAC, DO, TELOPT_TTYPE, /* client should tell us its term type */
2656  IAC, SB, TELOPT_TTYPE, 1, IAC, SE, /* now tell me ttype */
2657  IAC, DO, TELOPT_NAWS, /* client should tell us its window sz */
2658  IAC, SB, TELOPT_NAWS, 1, IAC, SE, /* now tell me window size */
2659  };
2660 
2661  /* Enable history on this CLI */
2662  cf->history_limit = um->cli_history_limit;
2663  cf->has_history = cf->history_limit != 0;
2664 
2665  /* This is an interactive session until we decide otherwise */
2666  cf->is_interactive = 1;
2667 
2668  /* Make sure this session is in line mode */
2669  cf->line_mode = 0;
2670 
2671  /* We need CRLF */
2672  cf->crlf_mode = 1;
2673 
2674  /* Setup the pager */
2675  cf->no_pager = um->cli_no_pager;
2676 
2677  /* Default terminal dimensions, should the terminal
2678  * fail to provide any.
2679  */
2682 
2683  /* Send the telnet options */
2685  unix_vlib_cli_output_raw (cf, uf, charmode_option,
2686  ARRAY_LEN (charmode_option));
2687 
2688  /* In case the client doesn't negotiate terminal type, use
2689  * a timer to kick off the initial prompt. */
2690  timer_call (unix_cli_file_welcome_timer, cf_index, 1);
2691  }
2692 
2693  return error;
2694 }
2695 
2696 /** The system terminal has informed us that the window size
2697  * has changed.
2698  */
2699 static void
2701 {
2702  clib_file_main_t *fm = &file_main;
2705  cm->stdin_cli_file_index);
2707  struct winsize ws;
2708  (void) signum;
2709 
2710  /* Terminal resized, fetch the new size */
2711  if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) < 0)
2712  {
2713  /* "Should never happen..." */
2714  clib_unix_warning ("TIOCGWINSZ");
2715  /* We can't trust ws.XXX... */
2716  return;
2717  }
2718 
2719  cf->width = ws.ws_col;
2722  if (cf->width == 0)
2724 
2725  cf->height = ws.ws_row;
2728  if (cf->height == 0)
2730 
2731  /* Reindex the pager buffer */
2733 
2734  /* Redraw the page */
2735  unix_cli_pager_redraw (cf, uf);
2736 }
2737 
2738 /** Handle configuration directives in the @em unix section. */
2739 static clib_error_t *
2741 {
2742  unix_main_t *um = &unix_main;
2743  clib_file_main_t *fm = &file_main;
2745  int flags;
2746  clib_error_t *error = 0;
2747  unix_cli_file_t *cf;
2748  u32 cf_index;
2749  struct termios tio;
2750  struct sigaction sa;
2751  struct winsize ws;
2752  u8 *term;
2753 
2754  /* We depend on unix flags being set. */
2755  if ((error = vlib_call_config_function (vm, unix_config)))
2756  return error;
2757 
2758  if (um->flags & UNIX_FLAG_INTERACTIVE)
2759  {
2760  /* Set stdin to be non-blocking. */
2761  if ((flags = fcntl (STDIN_FILENO, F_GETFL, 0)) < 0)
2762  flags = 0;
2763  (void) fcntl (STDIN_FILENO, F_SETFL, flags | O_NONBLOCK);
2764 
2765  cf_index = unix_cli_file_add (cm, "stdin", STDIN_FILENO);
2766  cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2767  cm->stdin_cli_file_index = cf_index;
2768 
2769  /* If stdin is a tty and we are using chacracter mode, enable
2770  * history on the CLI and set the tty line discipline accordingly. */
2771  if (isatty (STDIN_FILENO) && um->cli_line_mode == 0)
2772  {
2773  /* Capture terminal resize events */
2774  memset (&sa, 0, sizeof (sa));
2775  sa.sa_handler = unix_cli_resize_interrupt;
2776  if (sigaction (SIGWINCH, &sa, 0) < 0)
2777  clib_panic ("sigaction");
2778 
2779  /* Retrieve the current terminal size */
2780  ioctl (STDIN_FILENO, TIOCGWINSZ, &ws);
2781  cf->width = ws.ws_col;
2782  cf->height = ws.ws_row;
2783 
2784  if (cf->width == 0 || cf->height == 0)
2785  {
2786  /*
2787  * We have a tty, but no size. Use defaults.
2788  * vpp "unix interactive" inside emacs + gdb ends up here.
2789  */
2792  }
2793 
2794  /* Setup the history */
2795  cf->history_limit = um->cli_history_limit;
2796  cf->has_history = cf->history_limit != 0;
2797 
2798  /* Setup the pager */
2799  cf->no_pager = um->cli_no_pager;
2800 
2801  /* This is an interactive session until we decide otherwise */
2802  cf->is_interactive = 1;
2803 
2804  /* We're going to be in char by char mode */
2805  cf->line_mode = 0;
2806 
2807  /* Save the original tty state so we can restore it later */
2808  tcgetattr (STDIN_FILENO, &um->tio_stdin);
2809  um->tio_isset = 1;
2810 
2811  /* Tweak the tty settings */
2812  tio = um->tio_stdin;
2813  /* echo off, canonical mode off, ext'd input processing off */
2814  tio.c_lflag &= ~(ECHO | ICANON | IEXTEN);
2815  tio.c_cc[VMIN] = 1; /* 1 byte at a time */
2816  tio.c_cc[VTIME] = 0; /* no timer */
2817  tcsetattr (STDIN_FILENO, TCSAFLUSH, &tio);
2818 
2819  /* See if we can do ANSI/VT100 output */
2820  term = (u8 *) getenv ("TERM");
2821  if (term != NULL)
2822  {
2823  int len = strlen ((char *) term);
2824  cf->ansi_capable = unix_cli_terminal_type_ansi (term, len);
2825  if (unix_cli_terminal_type_noninteractive (term, len))
2827  }
2828  }
2829  else
2830  {
2831  /* No tty, so make sure the session doesn't have tty-like features */
2833  }
2834 
2835  /* Send banner and initial prompt */
2836  unix_cli_file_welcome (cm, cf);
2837  }
2838 
2839  /* If we have socket config, LISTEN, otherwise, don't */
2840  clib_socket_t *s = &um->cli_listen_socket;
2841  if (s->config && s->config[0] != 0)
2842  {
2843  /* CLI listen. */
2844  clib_file_t template = { 0 };
2845 
2846  /* mkdir of file socketu, only under /run */
2847  if (strncmp (s->config, "/run", 4) == 0)
2848  {
2849  u8 *tmp = format (0, "%s", s->config);
2850  int i = vec_len (tmp);
2851  while (i && tmp[--i] != '/')
2852  ;
2853 
2854  tmp[i] = 0;
2855 
2856  if (i)
2857  vlib_unix_recursive_mkdir ((char *) tmp);
2858  vec_free (tmp);
2859  }
2860 
2861  s->flags = CLIB_SOCKET_F_IS_SERVER | /* listen, don't connect */
2862  CLIB_SOCKET_F_ALLOW_GROUP_WRITE; /* PF_LOCAL socket only */
2863  error = clib_socket_init (s);
2864 
2865  if (error)
2866  return error;
2867 
2868  template.read_function = unix_cli_listen_read_ready;
2869  template.file_descriptor = s->fd;
2870 
2871  clib_file_add (fm, &template);
2872  }
2873 
2874  /* Set CLI prompt. */
2875  if (!cm->cli_prompt)
2876  cm->cli_prompt = format (0, "VLIB: ");
2877 
2878  return 0;
2879 }
2880 
2881 /*?
2882  * This module has no configurable parameters.
2883 ?*/
2885 
2886 /** Called when VPP is shutting down, this restores the system
2887  * terminal state if previously saved.
2888  */
2889 static clib_error_t *
2891 {
2892  unix_main_t *um = &unix_main;
2893 
2894  /* If stdin is a tty and we saved the tty state, reset the tty state */
2895  if (isatty (STDIN_FILENO) && um->tio_isset)
2896  tcsetattr (STDIN_FILENO, TCSAFLUSH, &um->tio_stdin);
2897 
2898  return 0;
2899 }
2900 
2902 
2903 /** Set the CLI prompt.
2904  * @param prompt The C string to set the prompt to.
2905  * @note This setting is global; it impacts all current
2906  * and future CLI sessions.
2907  */
2908 void
2910 {
2911  char *fmt = (prompt[strlen (prompt) - 1] == ' ') ? "%s" : "%s ";
2913  if (cm->cli_prompt)
2914  vec_free (cm->cli_prompt);
2915  cm->cli_prompt = format (0, fmt, prompt);
2916 }
2917 
2918 /** CLI command to quit the terminal session.
2919  * @note If this is a stdin session then this will
2920  * shutdown VPP also.
2921  */
2922 static clib_error_t *
2924  unformat_input_t * input, vlib_cli_command_t * cmd)
2925 {
2929 
2930  /* Cosmetic: suppress the final prompt from appearing before we die */
2931  cf->is_interactive = 0;
2932  cf->started = 1;
2933 
2935  vlib_current_process (vm),
2938  return 0;
2939 }
2940 
2941 /*?
2942  * Terminates the current CLI session.
2943  *
2944  * If VPP is running in @em interactive mode and this is the console session
2945  * (that is, the session on @c stdin) then this will also terminate VPP.
2946 ?*/
2947 /* *INDENT-OFF* */
2948 VLIB_CLI_COMMAND (unix_cli_quit_command, static) = {
2949  .path = "quit",
2950  .short_help = "Exit CLI",
2951  .function = unix_cli_quit,
2952 };
2953 /* *INDENT-ON* */
2954 
2955 /** CLI command to execute a VPP command script. */
2956 static clib_error_t *
2958  unformat_input_t * input, vlib_cli_command_t * cmd)
2959 {
2960  char *file_name;
2961  int fd;
2962  unformat_input_t sub_input;
2963  clib_error_t *error;
2964 
2965  file_name = 0;
2966  fd = -1;
2967  error = 0;
2968 
2969  if (!unformat (input, "%s", &file_name))
2970  {
2971  error = clib_error_return (0, "expecting file name, got `%U'",
2972  format_unformat_error, input);
2973  goto done;
2974  }
2975 
2976  fd = open (file_name, O_RDONLY);
2977  if (fd < 0)
2978  {
2979  error = clib_error_return_unix (0, "failed to open `%s'", file_name);
2980  goto done;
2981  }
2982 
2983  /* Make sure its a regular file. */
2984  {
2985  struct stat s;
2986 
2987  if (fstat (fd, &s) < 0)
2988  {
2989  error = clib_error_return_unix (0, "failed to stat `%s'", file_name);
2990  goto done;
2991  }
2992 
2993  if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
2994  {
2995  error = clib_error_return (0, "not a regular file `%s'", file_name);
2996  goto done;
2997  }
2998  }
2999 
3000  unformat_init_clib_file (&sub_input, fd);
3001 
3002  vlib_cli_input (vm, &sub_input, 0, 0);
3003  unformat_free (&sub_input);
3004 
3005 done:
3006  if (fd > 0)
3007  close (fd);
3008  vec_free (file_name);
3009 
3010  return error;
3011 }
3012 
3013 /*?
3014  * Executes a sequence of CLI commands which are read from a file.
3015  *
3016  * If a command is unrecognised or otherwise invalid then the usual CLI
3017  * feedback will be generated, however execution of subsequent commands
3018  * from the file will continue.
3019 ?*/
3020 /* *INDENT-OFF* */
3021 VLIB_CLI_COMMAND (cli_exec, static) = {
3022  .path = "exec",
3023  .short_help = "Execute commands from file",
3024  .function = unix_cli_exec,
3025  .is_mp_safe = 1,
3026 };
3027 /* *INDENT-ON* */
3028 
3029 /** CLI command to show various unix error statistics. */
3030 static clib_error_t *
3032  unformat_input_t * input, vlib_cli_command_t * cmd)
3033 {
3034  unix_main_t *um = &unix_main;
3035  clib_error_t *error = 0;
3036  int i, n_errors_to_show;
3037  unix_error_history_t *unix_errors = 0;
3038 
3039  n_errors_to_show = 1 << 30;
3040 
3042  {
3043  if (!unformat (input, "%d", &n_errors_to_show))
3044  {
3045  error =
3046  clib_error_return (0,
3047  "expecting integer number of errors to show, got `%U'",
3048  format_unformat_error, input);
3049  goto done;
3050  }
3051  }
3052 
3053  n_errors_to_show =
3054  clib_min (ARRAY_LEN (um->error_history), n_errors_to_show);
3055 
3056  i =
3057  um->error_history_index >
3058  0 ? um->error_history_index - 1 : ARRAY_LEN (um->error_history) - 1;
3059 
3060  while (n_errors_to_show > 0)
3061  {
3062  unix_error_history_t *eh = um->error_history + i;
3063 
3064  if (!eh->error)
3065  break;
3066 
3067  vec_add1 (unix_errors, eh[0]);
3068  n_errors_to_show -= 1;
3069  if (i == 0)
3070  i = ARRAY_LEN (um->error_history) - 1;
3071  else
3072  i--;
3073  }
3074 
3075  if (vec_len (unix_errors) == 0)
3076  vlib_cli_output (vm, "no Unix errors so far");
3077  else
3078  {
3079  vlib_cli_output (vm, "%Ld total errors seen", um->n_total_errors);
3080  for (i = vec_len (unix_errors) - 1; i >= 0; i--)
3081  {
3082  unix_error_history_t *eh = vec_elt_at_index (unix_errors, i);
3083  vlib_cli_output (vm, "%U: %U",
3084  format_time_interval, "h:m:s:u", eh->time,
3085  format_clib_error, eh->error);
3086  }
3087  vlib_cli_output (vm, "%U: time now",
3088  format_time_interval, "h:m:s:u", vlib_time_now (vm));
3089  }
3090 
3091 done:
3092  vec_free (unix_errors);
3093  return error;
3094 }
3095 
3096 /* *INDENT-OFF* */
3097 VLIB_CLI_COMMAND (cli_unix_show_errors, static) = {
3098  .path = "show unix-errors",
3099  .short_help = "Show Unix system call error history",
3100  .function = unix_show_errors,
3101 };
3102 /* *INDENT-ON* */
3103 
3104 /** CLI command to show session command history. */
3105 static clib_error_t *
3107  unformat_input_t * input, vlib_cli_command_t * cmd)
3108 {
3110  unix_cli_file_t *cf;
3111  int i, j;
3112 
3114 
3115  if (!cf->is_interactive)
3116  return clib_error_return (0, "invalid for non-interactive sessions");
3117 
3118  if (cf->has_history && cf->history_limit)
3119  {
3120  i = 1 + cf->command_number - vec_len (cf->command_history);
3121  for (j = 0; j < vec_len (cf->command_history); j++)
3122  vlib_cli_output (vm, "%d %v\n", i + j, cf->command_history[j]);
3123  }
3124  else
3125  {
3126  vlib_cli_output (vm, "History not enabled.\n");
3127  }
3128 
3129  return 0;
3130 }
3131 
3132 /*?
3133  * Displays the command history for the current session, if any.
3134 ?*/
3135 /* *INDENT-OFF* */
3136 VLIB_CLI_COMMAND (cli_unix_cli_show_history, static) = {
3137  .path = "history",
3138  .short_help = "Show current session command history",
3139  .function = unix_cli_show_history,
3140 };
3141 /* *INDENT-ON* */
3142 
3143 /** CLI command to show terminal status. */
3144 static clib_error_t *
3146  unformat_input_t * input, vlib_cli_command_t * cmd)
3147 {
3148  unix_main_t *um = &unix_main;
3150  unix_cli_file_t *cf;
3151  vlib_node_t *n;
3152 
3154  n = vlib_get_node (vm, cf->process_node_index);
3155 
3156  vlib_cli_output (vm, "Terminal name: %v\n", n->name);
3157  vlib_cli_output (vm, "Terminal mode: %s\n", cf->line_mode ?
3158  "line-by-line" : "char-by-char");
3159  vlib_cli_output (vm, "Terminal width: %d\n", cf->width);
3160  vlib_cli_output (vm, "Terminal height: %d\n", cf->height);
3161  vlib_cli_output (vm, "ANSI capable: %s\n",
3162  cf->ansi_capable ? "yes" : "no");
3163  vlib_cli_output (vm, "Interactive: %s\n",
3164  cf->is_interactive ? "yes" : "no");
3165  vlib_cli_output (vm, "History enabled: %s%s\n",
3166  cf->has_history ? "yes" : "no", !cf->has_history
3167  || cf->history_limit ? "" :
3168  " (disabled by history limit)");
3169  if (cf->has_history)
3170  vlib_cli_output (vm, "History limit: %d\n", cf->history_limit);
3171  vlib_cli_output (vm, "Pager enabled: %s%s%s\n",
3172  cf->no_pager ? "no" : "yes",
3173  cf->no_pager
3174  || cf->height ? "" : " (disabled by terminal height)",
3175  cf->no_pager
3176  || um->cli_pager_buffer_limit ? "" :
3177  " (disabled by buffer limit)");
3178  if (!cf->no_pager)
3179  vlib_cli_output (vm, "Pager limit: %d\n", um->cli_pager_buffer_limit);
3180  vlib_cli_output (vm, "CRLF mode: %s\n",
3181  cf->crlf_mode ? "CR+LF" : "LF");
3182 
3183  return 0;
3184 }
3185 
3186 /*?
3187  * Displays various information about the state of the current terminal
3188  * session.
3189  *
3190  * @cliexpar
3191  * @cliexstart{show terminal}
3192  * Terminal name: unix-cli-stdin
3193  * Terminal mode: char-by-char
3194  * Terminal width: 123
3195  * Terminal height: 48
3196  * ANSI capable: yes
3197  * Interactive: yes
3198  * History enabled: yes
3199  * History limit: 50
3200  * Pager enabled: yes
3201  * Pager limit: 100000
3202  * CRLF mode: LF
3203  * @cliexend
3204 ?*/
3205 /* *INDENT-OFF* */
3206 VLIB_CLI_COMMAND (cli_unix_cli_show_terminal, static) = {
3207  .path = "show terminal",
3208  .short_help = "Show current session terminal settings",
3209  .function = unix_cli_show_terminal,
3210 };
3211 /* *INDENT-ON* */
3212 
3213 /** CLI command to display a list of CLI sessions. */
3214 static clib_error_t *
3216  unformat_input_t * input,
3217  vlib_cli_command_t * cmd)
3218 {
3219  //unix_main_t *um = &unix_main;
3221  clib_file_main_t *fm = &file_main;
3222  unix_cli_file_t *cf;
3223  clib_file_t *uf;
3224  vlib_node_t *n;
3225 
3226  vlib_cli_output (vm, "%-5s %-5s %-20s %s", "PNI", "FD", "Name", "Flags");
3227 
3228 #define fl(x, y) ( (x) ? toupper((y)) : tolower((y)) )
3229  /* *INDENT-OFF* */
3230  pool_foreach (cf, cm->cli_file_pool, ({
3231  uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3232  n = vlib_get_node (vm, cf->process_node_index);
3233  vlib_cli_output (vm,
3234  "%-5d %-5d %-20v %c%c%c%c%c\n",
3235  cf->process_node_index,
3236  uf->file_descriptor,
3237  n->name,
3238  fl (cf->is_interactive, 'i'),
3239  fl (cf->is_socket, 's'),
3240  fl (cf->line_mode, 'l'),
3241  fl (cf->has_epipe, 'p'),
3242  fl (cf->ansi_capable, 'a'));
3243  }));
3244  /* *INDENT-ON* */
3245 #undef fl
3246 
3247  return 0;
3248 }
3249 
3250 /*?
3251  * Displays a summary of all the current CLI sessions.
3252  *
3253  * Typically used to diagnose connection issues with the CLI
3254  * socket.
3255  *
3256  * @cliexpar
3257  * @cliexstart{show cli-sessions}
3258  * PNI FD Name Flags
3259  * 343 0 unix-cli-stdin IslpA
3260  * 344 7 unix-cli-local:20 ISlpA
3261  * 346 8 unix-cli-local:21 iSLpa
3262  * @cliexend
3263 
3264  * In this example we have the debug console of the running process
3265  * on stdin/out, we have an interactive socket session and we also
3266  * have a non-interactive socket session.
3267  *
3268  * Fields:
3269  *
3270  * - @em PNI: Process node index.
3271  * - @em FD: Unix file descriptor.
3272  * - @em Name: Name of the session.
3273  * - @em Flags: Various flags that describe the state of the session.
3274  *
3275  * @em Flags have the following meanings; lower-case typically negates
3276  * upper-case:
3277  *
3278  * - @em I Interactive session.
3279  * - @em S Connected by socket.
3280  * - @em s Not a socket, likely stdin.
3281  * - @em L Line-by-line mode.
3282  * - @em l Char-by-char mode.
3283  * - @em P EPIPE detected on connection; it will close soon.
3284  * - @em A ANSI-capable terminal.
3285 ?*/
3286 /* *INDENT-OFF* */
3287 VLIB_CLI_COMMAND (cli_unix_cli_show_cli_sessions, static) = {
3288  .path = "show cli-sessions",
3289  .short_help = "Show current CLI sessions",
3290  .function = unix_cli_show_cli_sessions,
3291 };
3292 /* *INDENT-ON* */
3293 
3294 /** CLI command to set terminal pager settings. */
3295 static clib_error_t *
3297  unformat_input_t * input,
3298  vlib_cli_command_t * cmd)
3299 {
3300  unix_main_t *um = &unix_main;
3302  unix_cli_file_t *cf;
3303  unformat_input_t _line_input, *line_input = &_line_input;
3304  clib_error_t *error = 0;
3305 
3307 
3308  if (!cf->is_interactive)
3309  return clib_error_return (0, "invalid for non-interactive sessions");
3310 
3311  if (!unformat_user (input, unformat_line_input, line_input))
3312  return 0;
3313 
3314  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3315  {
3316  if (unformat (line_input, "on"))
3317  cf->no_pager = 0;
3318  else if (unformat (line_input, "off"))
3319  cf->no_pager = 1;
3320  else if (unformat (line_input, "limit %u", &um->cli_pager_buffer_limit))
3321  vlib_cli_output (vm,
3322  "Pager limit set to %u lines; note, this is global.\n",
3324  else
3325  {
3326  error = clib_error_return (0, "unknown parameter: `%U`",
3327  format_unformat_error, line_input);
3328  goto done;
3329  }
3330  }
3331 
3332 done:
3333  unformat_free (line_input);
3334 
3335  return error;
3336 }
3337 
3338 /*?
3339  * Enables or disables the terminal pager for this session. Generally
3340  * this defaults to enabled.
3341  *
3342  * Additionally allows the pager buffer size to be set; though note that
3343  * this value is set globally and not per session.
3344 ?*/
3345 /* *INDENT-OFF* */
3346 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager, static) = {
3347  .path = "set terminal pager",
3348  .short_help = "set terminal pager [on|off] [limit <lines>]",
3349  .function = unix_cli_set_terminal_pager,
3350 };
3351 /* *INDENT-ON* */
3352 
3353 /** CLI command to set terminal history settings. */
3354 static clib_error_t *
3356  unformat_input_t * input,
3357  vlib_cli_command_t * cmd)
3358 {
3360  unix_cli_file_t *cf;
3361  unformat_input_t _line_input, *line_input = &_line_input;
3362  u32 limit;
3363  clib_error_t *error = 0;
3364 
3366 
3367  if (!cf->is_interactive)
3368  return clib_error_return (0, "invalid for non-interactive sessions");
3369 
3370  if (!unformat_user (input, unformat_line_input, line_input))
3371  return 0;
3372 
3373  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3374  {
3375  if (unformat (line_input, "on"))
3376  cf->has_history = 1;
3377  else if (unformat (line_input, "off"))
3378  cf->has_history = 0;
3379  else if (unformat (line_input, "limit %u", &cf->history_limit))
3380  ;
3381  else
3382  {
3383  error = clib_error_return (0, "unknown parameter: `%U`",
3384  format_unformat_error, line_input);
3385  goto done;
3386  }
3387 
3388  /* If we reduced history size, or turned it off, purge the history */
3389  limit = cf->has_history ? cf->history_limit : 0;
3390 
3391  while (cf->command_history && vec_len (cf->command_history) >= limit)
3392  {
3393  vec_free (cf->command_history[0]);
3394  vec_delete (cf->command_history, 1, 0);
3395  }
3396  }
3397 
3398 done:
3399  unformat_free (line_input);
3400 
3401  return error;
3402 }
3403 
3404 /*?
3405  * Enables or disables the command history function of the current
3406  * terminal. Generally this defaults to enabled.
3407  *
3408  * This command also allows the maximum size of the history buffer for
3409  * this session to be altered.
3410 ?*/
3411 /* *INDENT-OFF* */
3412 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history, static) = {
3413  .path = "set terminal history",
3414  .short_help = "set terminal history [on|off] [limit <lines>]",
3415  .function = unix_cli_set_terminal_history,
3416 };
3417 /* *INDENT-ON* */
3418 
3419 /** CLI command to set terminal ANSI settings. */
3420 static clib_error_t *
3422  unformat_input_t * input,
3423  vlib_cli_command_t * cmd)
3424 {
3426  unix_cli_file_t *cf;
3427 
3429 
3430  if (!cf->is_interactive)
3431  return clib_error_return (0, "invalid for non-interactive sessions");
3432 
3433  if (unformat (input, "on"))
3434  cf->ansi_capable = 1;
3435  else if (unformat (input, "off"))
3436  cf->ansi_capable = 0;
3437  else
3438  return clib_error_return (0, "unknown parameter: `%U`",
3439  format_unformat_error, input);
3440 
3441  return 0;
3442 }
3443 
3444 /*?
3445  * Enables or disables the use of ANSI control sequences by this terminal.
3446  * The default will vary based on terminal detection at the start of the
3447  * session.
3448  *
3449  * ANSI control sequences are used in a small number of places to provide,
3450  * for example, color text output and to control the cursor in the pager.
3451 ?*/
3452 /* *INDENT-OFF* */
3453 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi, static) = {
3454  .path = "set terminal ansi",
3455  .short_help = "set terminal ansi [on|off]",
3456  .function = unix_cli_set_terminal_ansi,
3457 };
3458 /* *INDENT-ON* */
3459 
3460 static clib_error_t *
3462 {
3463  return 0;
3464 }
3465 
3467 
3468 /*
3469  * fd.io coding-style-patch-verification: ON
3470  *
3471  * Local Variables:
3472  * eval: (c-set-style "gnu")
3473  * End:
3474  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:432
u32 history_limit
Maximum number of history entries this session will store.
Definition: cli.c:168
u32 command_number
Current command line counter.
Definition: cli.c:171
uword output_function_arg
Definition: node.h:553
u32 error_history_index
Definition: unix.h:68
unix_main_t unix_main
Definition: main.c:62
#define vec_foreach_index(var, v)
Iterate over vector indices.
u8 * format_clib_error(u8 *s, va_list *va)
Definition: error.c:191
static void clib_file_del(clib_file_main_t *um, clib_file_t *f)
Definition: file.h:94
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:759
#define UNIX_CLI_MAX_DEPTH_TELNET
Maximum depth into a byte stream from which to compile a Telnet protocol message. ...
Definition: cli.c:92
sll srl srl sll sra u16x4 i
Definition: vector_sse2.h:337
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:2529
#define clib_min(x, y)
Definition: clib.h:340
u8 is_interactive
Whether the session is interactive or not.
Definition: cli.c:201
u32 pager_start
Line number of top of page.
Definition: cli.c:218
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:599
Action parser found a partial match.
Definition: cli.c:298
Carriage return, newline or enter.
Definition: cli.c:266
Telnet control code.
Definition: cli.c:284
Search forwards in command history.
Definition: cli.c:282
static u8 unix_cli_terminal_type_noninteractive(u8 *term, uword len)
Identify whether a terminal type is non-interactive.
Definition: cli.c:1091
unix_cli_process_event_type_t
CLI session events.
Definition: cli.c:432
a
Definition: bitmap.h:516
Exit the pager session.
Definition: cli.c:287
u8 * input_vector
Vector of input saved by Unix input node to be processed by CLI process.
Definition: cli.c:156
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:721
static uword * vlib_process_wait_for_event(vlib_main_t *vm)
Definition: node_funcs.h:619
void vlib_cli_input(vlib_main_t *vm, unformat_input_t *input, vlib_cli_output_function_t *function, uword function_arg)
Definition: cli.c:643
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:542
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:3145
static uword vlib_current_process(vlib_main_t *vm)
Definition: node_funcs.h:426
#define CTL(c)
Given a capital ASCII letter character return a NUL terminated string with the control code for that ...
Definition: cli.c:322
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:484
u8 * line
The line to print.
Definition: cli.c:106
u32 flags
Definition: unix.h:58
u32 width
Terminal width.
Definition: cli.c:221
Erase cursor right.
Definition: cli.c:269
u8 * cli_prompt
Prompt string for CLI.
Definition: cli.c:442
#define UNIX_CLI_DEFAULT_TERMINAL_WIDTH
Default terminal width.
Definition: cli.c:101
static void unix_cli_set_session_noninteractive(unix_cli_file_t *cf)
Set a session to be non-interactive.
Definition: cli.c:1106
u32 cli_pager_buffer_limit
Definition: unix.h:97
#define NULL
Definition: clib.h:55
u8 ** command_history
Array of vectors of commands in the history.
Definition: cli.c:161
static void unix_vlib_cli_output(uword cli_file_index, u8 *buffer, uword buffer_bytes)
VLIB CLI output function.
Definition: cli.c:971
u32 index
Definition: node.h:237
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:224
void vlib_unix_cli_set_prompt(char *prompt)
Set the CLI prompt.
Definition: cli.c:2909
Scroll to last line.
Definition: cli.c:292
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:775
struct termios tio_stdin
Definition: unix.h:103
static void unix_cli_file_free(unix_cli_file_t *f)
Release storage used by a CLI session.
Definition: cli.c:255
u32 file_descriptor
Definition: file.h:53
static u32 unix_cli_file_add(unix_cli_main_t *cm, char *name, int fd)
Store a new CLI session.
Definition: cli.c:2551
Scroll to first line.
Definition: cli.c:291
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:518
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:3421
Unix CLI session.
Definition: cli.c:146
unix_cli_pager_index_t * pager_index
Index of line fragments in the pager buffer.
Definition: cli.c:215
struct _vlib_node_registration vlib_node_registration_t
u8 * current_command
The command currently pointed at by the history cursor.
Definition: cli.c:163
clib_error_t * clib_socket_init(clib_socket_t *s)
Definition: socket.c:376
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
#define VLIB_MAIN_LOOP_EXIT_CLI
Definition: main.h:94
#define vlib_call_config_function(vm, x)
Definition: init.h:196
void clib_longjmp(clib_longjmp_t *save, uword return_value)
static clib_error_t * unix_cli_listen_read_ready(clib_file_t *uf)
Telnet listening socket has a new connection.
Definition: cli.c:2615
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
#define UNIX_CLI_MAX_TERMINAL_WIDTH
Maximum terminal width we will accept.
Definition: cli.c:95
add_epi add_epi sub_epi sub_epi adds_epu subs_epu i16x8 y
Definition: vector_sse2.h:293
u32 cursor
Position of the insert cursor on the current input line.
Definition: cli.c:182
clib_socket_t cli_listen_socket
Definition: unix.h:64
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:225
unix_cli_parse_action_t action
Action to take when matched.
Definition: cli.c:310
static clib_error_t * unix_cli_init(vlib_main_t *vm)
Definition: cli.c:3461
void unformat_init_clib_file(unformat_input_t *input, int file_descriptor)
Definition: unformat.c:1058
int log_fd
Definition: unix.h:85
Clear the terminal.
Definition: cli.c:280
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
#define vec_add(V, E, N)
Add N elements to end of vector V (no header, unspecified alignment)
Definition: vec.h:595
#define CLIB_SOCKET_F_IS_SERVER
Definition: socket.h:58
clib_file_t * file_pool
Definition: file.h:76
u8 has_epipe
If EPIPE has been detected, prevent further write-related activity on the descriptor.
Definition: cli.c:209
u8 ansi_capable
Can we do ANSI output?
Definition: cli.c:191
u8 * format_timeval(u8 *s, va_list *args)
Definition: unix-formats.c:761
static void unix_cli_pager_reindex(unix_cli_file_t *cf)
Reindex entire pager buffer.
Definition: cli.c:898
A CLI session wants to close.
Definition: cli.c:435
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:438
u8 * output_vector
Vector of output pending write to file descriptor.
Definition: cli.c:152
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:111
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:542
#define always_inline
Definition: clib.h:92
End key (jump to end of line)
Definition: cli.c:275
#define vec_new(T, N)
Create new vector of given type and length (unspecified alignment, no header).
Definition: vec.h:306
u8 is_socket
Whether the session is attached to a socket.
Definition: cli.c:204
Jump cursor to start of right word.
Definition: cli.c:277
Undo last erase action.
Definition: cli.c:283
int i32
Definition: types.h:81
u32 len
Length of input without final NUL.
Definition: cli.c:309
Mapping of input buffer strings to action values.
Definition: cli.c:306
vlib_parse_match_t vlib_parse_eval(u8 *input)
#define UNIX_CLI_DEFAULT_TERMINAL_HEIGHT
Default terminal height.
Definition: cli.c:99
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
#define clib_error_return(e, args...)
Definition: error.h:99
#define ANSI_SCROLLDN
ANSI scroll screen down one line.
Definition: cli.c:84
clib_file_main_t file_main
Definition: main.c:63
u32 process_node_index
Process node identifier.
Definition: cli.c:227
#define vec_resize(V, N)
Resize a vector (no header, unspecified alignment) Add N elements to end of given vector V...
Definition: vec.h:237
u32 offset
Offset of the string in the line.
Definition: cli.c:138
u32 length
Length of the string in the line.
Definition: cli.c:141
vlib_main_t * vlib_main
Definition: unix.h:56
Erase line to right & including cursor.
Definition: cli.c:279
#define ANSI_CLEARLINE
ANSI clear line cursor is on.
Definition: cli.c:82
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:1192
u32 * unused_cli_process_node_indices
Vec pool of unused session indices.
Definition: cli.c:448
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:2923
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:698
unformat_function_t unformat_line_input
Definition: format.h:281
unix_cli_file_t * cli_file_pool
Vec pool of CLI sessions.
Definition: cli.c:445
int search_mode
If non-zero then the CLI is searching in the history array.
Definition: cli.c:179
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:459
#define ANSI_RESTCURSOR
ANSI restore cursor position if previously saved.
Definition: cli.c:88
int cli_line_mode
Definition: unix.h:88
static void vlib_process_signal_event(vlib_main_t *vm, uword node_index, uword type_opaque, uword data)
Definition: node_funcs.h:950
clib_error_t * clib_socket_accept(clib_socket_t *server, clib_socket_t *client)
Definition: socket.c:514
static void unix_cli_pager_reset(unix_cli_file_t *f)
Resets the pager buffer and other data.
Definition: cli.c:234
Scroll to previous page.
Definition: cli.c:294
u8 ** vlib_cli_get_possible_completions(u8 *str)
Definition: cli.c:249
struct _unformat_input_t unformat_input_t
#define clib_error_return_unix(e, args...)
Definition: error.h:102
static u8 unix_cli_terminal_type_ansi(u8 *term, uword len)
Identify whether a terminal type is ANSI capable.
Definition: cli.c:1059
int cli_no_banner
Definition: unix.h:94
Home key (jump to start of line)
Definition: cli.c:274
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:271
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:2490
#define ANSI_BOLD
ANSI Start bold text.
Definition: cli.c:74
static unix_cli_banner_t unix_cli_banner[]
Plain welcome banner.
Definition: cli.c:112
u32 flags
Definition: file.h:55
void timer_call(timer_func_t *func, any arg, f64 dt)
Definition: timer.c:159
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:3031
#define VLIB_CONFIG_FUNCTION(x, n,...)
Definition: init.h:119
Search backwards in command history.
Definition: cli.c:281
u8 * input
Input string to match.
Definition: cli.c:308
void(* file_update)(clib_file_t *file, clib_file_update_type_t update_type)
Definition: file.h:78
u32 node_index
Node index.
Definition: node.h:437
static void unix_cli_cli_prompt(unix_cli_file_t *cf, clib_file_t *uf)
Output the CLI prompt.
Definition: cli.c:687
word any
Definition: types.h:139
u32 cli_history_limit
Definition: unix.h:91
Scroll to next page.
Definition: cli.c:288
Erase line to left of cursor.
Definition: cli.c:278
u8 * name
Definition: node.h:221
u8 * format_sockaddr(u8 *s, va_list *args)
Definition: unix-formats.c:230
#define CSI
ANSI Control Sequence Introducer.
Definition: cli.c:67
void unformat_init_vector(unformat_input_t *input, u8 *vector_string)
Definition: unformat.c:1031
u8 ** pager_vector
Pager buffer.
Definition: cli.c:212
#define UNFORMAT_END_OF_INPUT
Definition: format.h:143
unix_error_history_t error_history[128]
Definition: unix.h:67
svmdb_client_t * c
u32 runtime_index
Definition: node.h:240
vlib_main_t * vm
Definition: buffer.c:283
vec_header_t h
Definition: buffer.c:282
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:650
static unix_cli_banner_t unix_cli_banner_color[]
ANSI color welcome banner.
Definition: cli.c:121
u32 current_input_file_index
File pool index of current input.
Definition: cli.c:454
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:336
int cli_no_pager
Definition: unix.h:100
#define VLIB_MAIN_LOOP_EXIT_FUNCTION(x)
Definition: init.h:116
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:2448
#define ANSI_SAVECURSOR
ANSI save cursor position.
Definition: cli.c:86
#define clib_memcpy(a, b, c)
Definition: string.h:75
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:3355
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:268
u32 line
Index into pager_vector.
Definition: cli.c:135
Down arrow.
Definition: cli.c:271
#define ARRAY_LEN(x)
Definition: clib.h:59
A file descriptor has data to be read.
Definition: cli.c:434
#define ESC
ANSI escape code.
Definition: cli.c:64
Jump cursor to start of left word.
Definition: cli.c:276
u8 no_pager
Disable the pager?
Definition: cli.c:197
int tio_isset
Definition: unix.h:104
Right arrow.
Definition: cli.c:273
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:154
Enter pressed (CR, CRLF, LF, etc)
Definition: cli.c:286
unsigned int u32
Definition: types.h:88
Up arrow.
Definition: cli.c:270
static void unix_cli_kill(unix_cli_main_t *cm, uword cli_file_index)
Destroy a CLI session.
Definition: cli.c:2373
#define vec_delete(V, N, M)
Delete N elements starting at element M.
Definition: vec.h:781
static word unix_vlib_findchr(u8 chr, u8 *str, word len)
A bit like strchr with a buffer length limit.
Definition: cli.c:572
unix_cli_parse_action_t
CLI actions.
Definition: cli.c:263
static uword clib_file_add(clib_file_main_t *um, clib_file_t *template)
Definition: file.h:84
u32 vlib_register_node(vlib_main_t *vm, vlib_node_registration_t *r)
Definition: node.c:498
#define UNIX_FLAG_INTERACTIVE
Definition: unix.h:60
Erase cursor left.
Definition: cli.c:268
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:3296
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:2740
#define vec_append(v1, v2)
Append v2 after v1.
Definition: vec.h:815
struct _socket_t clib_socket_t
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:1338
#define UNIX_FILE_DATA_AVAILABLE_TO_WRITE
Definition: file.h:56
Scroll to next page.
Definition: cli.c:293
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:147
u8 has_history
This session has command history.
Definition: cli.c:159
A CLI banner line.
Definition: cli.c:104
#define ANSI_CLEAR
ANSI clear screen.
Definition: cli.c:70
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:3106
static void clib_socket_free(clib_socket_t *s)
Definition: socket.h:165
Pager line index.
Definition: cli.c:132
u64 uword
Definition: types.h:112
Action parser did not find any match.
Definition: cli.c:299
u8 started
Has the session started?
Definition: cli.c:194
clib_error_t * vlib_unix_recursive_mkdir(char *path)
Definition: util.c:102
unsigned short u16
Definition: types.h:57
Scroll to next line.
Definition: cli.c:289
i64 word
Definition: types.h:111
clib_error_t * error
Definition: unix.h:50
CLI global state.
Definition: cli.c:439
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
#define ANSI_BRED
ANSI Start bright red text.
Definition: cli.c:80
u8 * search_key
The string being searched for in the history.
Definition: cli.c:174
static void unformat_free(unformat_input_t *i)
Definition: format.h:161
#define clib_unix_warning(format, args...)
Definition: error.h:68
u8 * format_time_interval(u8 *s, va_list *args)
Definition: std-formats.c:122
static uword unix_cli_process(vlib_main_t *vm, vlib_node_runtime_t *rt, vlib_frame_t *f)
Handle system events.
Definition: cli.c:2404
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:1118
static clib_error_t * unix_config(vlib_main_t *vm, unformat_input_t *input)
Definition: main.c:315
struct clib_bihash_value offset
template key/value backing page structure
static vlib_process_t * vlib_get_process_from_node(vlib_main_t *vm, vlib_node_t *node)
Definition: node_funcs.h:207
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
static void unix_cli_pager_prompt_erase(unix_cli_file_t *cf, clib_file_t *uf)
Erase the printed pager prompt.
Definition: cli.c:737
static void unix_cli_resize_interrupt(int signum)
The system terminal has informed us that the window size has changed.
Definition: cli.c:2700
Clear and redraw the page on the terminal.
Definition: cli.c:295
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:2169
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:59
#define vec_foreach(var, vec)
Vector iterator.
uword private_data
Definition: file.h:60
u8 crlf_mode
Set if the CRLF mode wants CR + LF.
Definition: cli.c:188
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:2957
Definition: file.h:50
#define ANSI_RESET
ANSI reset color settings.
Definition: cli.c:72
clib_longjmp_t main_loop_exit
Definition: main.h:90
vlib_cli_output_function_t * output_function
Definition: node.h:552
u32 clib_file_index
The file index held by unix.c.
Definition: cli.c:149
u32 flags
Definition: vhost-user.h:77
static unix_cli_main_t unix_cli_main
CLI global state.
Definition: cli.c:458
#define CLIB_SOCKET_F_ALLOW_GROUP_WRITE
Definition: socket.h:62
i32 excursion
How far from the end of the history array the user has browsed.
Definition: cli.c:165
void vlib_start_process(vlib_main_t *vm, uword process_index)
Definition: main.c:1344
Search the pager buffer.
Definition: cli.c:296
u8 line_mode
Line mode or char mode.
Definition: cli.c:185
u32 length
The length of the line without terminating NUL.
Definition: cli.c:107
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:680
Left arrow.
Definition: cli.c:272
u32 stdin_cli_file_index
The session index of the stdin cli.
Definition: cli.c:451
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:522
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:3215
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:836
#define clib_panic(format, args...)
Definition: error.h:72
#define UNIX_CLI_MAX_TERMINAL_HEIGHT
Maximum terminal height we will accept.
Definition: cli.c:97
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
Scroll to previous line.
Definition: cli.c:290
u64 n_total_errors
Definition: unix.h:69
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:169
u32 height
Terminal height.
Definition: cli.c:224
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:2890
static void unix_cli_file_welcome_timer(any arg, f64 delay)
A failsafe triggered on a timer to ensure we send the prompt to telnet sessions that fail to negotiat...
Definition: cli.c:1167
static void unix_cli_process_input(unix_cli_main_t *cm, uword cli_file_index)
Process input to a CLI session.
Definition: cli.c:2258
static unix_cli_parse_actions_t unix_cli_parse_strings[]
Patterns to match on a CLI input stream.
Definition: cli.c:329