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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * cli.c: Unix stdin/socket CLI.
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
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.
45 /*? %%clicmd:group_label Command line session %% ?*/
46 /*? %%syscfg:group_label Command line session %% ?*/
48 #include <vlib/vlib.h>
49 #include <vlib/unix/unix.h>
50 #include <vppinfra/timer.h>
58 #include <arpa/telnet.h>
59 #include <sys/ioctl.h>
60 #include <sys/types.h>
64 /** ANSI escape code. */
67 /** ANSI Control Sequence Introducer. */
70 /** ANSI clear screen. */
71 #define ANSI_CLEAR CSI "2J" CSI "1;1H"
72 /** ANSI reset color settings. */
73 #define ANSI_RESET CSI "0m"
74 /** ANSI Start bold text. */
75 #define ANSI_BOLD CSI "1m"
76 /** ANSI Stop bold text. */
77 #define ANSI_DIM CSI "2m"
78 /** ANSI Start dark red text. */
79 #define ANSI_DRED ANSI_DIM CSI "31m"
80 /** ANSI Start bright red text. */
81 #define ANSI_BRED ANSI_BOLD CSI "31m"
82 /** ANSI clear line cursor is on. */
83 #define ANSI_CLEARLINE CSI "2K"
84 /** ANSI scroll screen down one line. */
85 #define ANSI_SCROLLDN CSI "1T"
86 /** ANSI save cursor position. */
87 #define ANSI_SAVECURSOR CSI "s"
88 /** ANSI restore cursor position if previously saved. */
89 #define ANSI_RESTCURSOR CSI "u"
91 /** Maximum depth into a byte stream from which to compile a Telnet
92 * protocol message. This is a safety measure. */
93 #define UNIX_CLI_MAX_DEPTH_TELNET 24
95 /** Maximum terminal width we will accept */
96 #define UNIX_CLI_MAX_TERMINAL_WIDTH 512
97 /** Maximum terminal height we will accept */
98 #define UNIX_CLI_MAX_TERMINAL_HEIGHT 512
99 /** Default terminal height */
100 #define UNIX_CLI_DEFAULT_TERMINAL_HEIGHT 24
101 /** Default terminal width */
102 #define UNIX_CLI_DEFAULT_TERMINAL_WIDTH 80
104 /** A CLI banner line. */
107 u8 *line; /**< The line to print. */
108 u32 length; /**< The length of the line without terminating NUL. */
111 #define _(a) { .line = (u8 *)(a), .length = sizeof(a) - 1 }
112 /** Plain welcome banner. */
113 static unix_cli_banner_t unix_cli_banner[] = {
114 _(" _______ _ _ _____ ___ \n"),
115 _(" __/ __/ _ \\ (_)__ | | / / _ \\/ _ \\\n"),
116 _(" _/ _// // / / / _ \\ | |/ / ___/ ___/\n"),
117 _(" /_/ /____(_)_/\\___/ |___/_/ /_/ \n"),
121 /** ANSI color welcome banner. */
122 static unix_cli_banner_t unix_cli_banner_color[] = {
123 _(ANSI_BRED " _______ _ " ANSI_RESET " _ _____ ___ \n"),
124 _(ANSI_BRED " __/ __/ _ \\ (_)__ " ANSI_RESET " | | / / _ \\/ _ \\\n"),
125 _(ANSI_BRED " _/ _// // / / / _ \\" ANSI_RESET " | |/ / ___/ ___/\n"),
126 _(ANSI_BRED " /_/ /____(_)_/\\___/" ANSI_RESET " |___/_/ /_/ \n"),
132 /** Pager line index */
135 /** Index into pager_vector */
138 /** Offset of the string in the line */
141 /** Length of the string in the line */
143 } unix_cli_pager_index_t;
146 /** Unix CLI session. */
149 /** The file index held by unix.c */
152 /** Vector of output pending write to file descriptor. */
155 /** Vector of input saved by Unix input node to be processed by
159 /** This session has command history. */
161 /** Array of vectors of commands in the history. */
162 u8 **command_history;
163 /** The command currently pointed at by the history cursor. */
165 /** How far from the end of the history array the user has browsed. */
168 /** Maximum number of history entries this session will store. */
171 /** Current command line counter */
174 /** The string being searched for in the history. */
176 /** If non-zero then the CLI is searching in the history array.
177 * - @c -1 means search backwards.
178 * - @c 1 means search forwards.
182 /** Position of the insert cursor on the current input line */
185 /** Line mode or char mode */
188 /** Set if the CRLF mode wants CR + LF */
191 /** Can we do ANSI output? */
194 /** Has the session started? */
197 /** Disable the pager? */
200 /** Whether the session is interactive or not.
201 * Controls things like initial banner, the CLI prompt etc. */
204 /** Whether the session is attached to a socket. */
207 /** If EPIPE has been detected, prevent further write-related
208 * activity on the descriptor.
215 /** Index of line fragments in the pager buffer */
216 unix_cli_pager_index_t *pager_index;
218 /** Line number of top of page */
221 /** Terminal width */
224 /** Terminal height */
227 /** Process node identifier */
228 u32 process_node_index;
230 /** The current direction of cursor travel.
231 * This is important since when advancing left-to-right, at the
232 * right hand edge of the console the terminal typically defers
233 * wrapping the cursor to the next line until a character is
234 * actually displayed.
235 * This messes up our heuristic for whether to use ANSI to return
236 * the cursor to the end of the line and instead we have to
237 * nudge the cursor to the next line.
238 * A Value of @c 0 means we're advancing left-to-right; @c 1 means
245 /** Resets the pager buffer and other data.
246 * @param f The CLI session whose pager needs to be reset.
249 unix_cli_pager_reset (unix_cli_file_t * f)
255 vec_free (f->pager_index);
258 vec_foreach (p, f->pager_vector)
262 vec_free (f->pager_vector);
266 /** Release storage used by a CLI session.
267 * @param f The CLI session whose storage needs to be released.
270 unix_cli_file_free (unix_cli_file_t * f)
272 vec_free (f->output_vector);
273 vec_free (f->input_vector);
274 unix_cli_pager_reset (f);
280 UNIX_CLI_PARSE_ACTION_NOACTION = 0, /**< No action */
281 UNIX_CLI_PARSE_ACTION_CRLF, /**< Carriage return, newline or enter */
282 UNIX_CLI_PARSE_ACTION_TAB, /**< Tab key */
283 UNIX_CLI_PARSE_ACTION_ERASE, /**< Erase cursor left */
284 UNIX_CLI_PARSE_ACTION_ERASERIGHT, /**< Erase cursor right */
285 UNIX_CLI_PARSE_ACTION_UP, /**< Up arrow */
286 UNIX_CLI_PARSE_ACTION_DOWN, /**< Down arrow */
287 UNIX_CLI_PARSE_ACTION_LEFT, /**< Left arrow */
288 UNIX_CLI_PARSE_ACTION_RIGHT, /**< Right arrow */
289 UNIX_CLI_PARSE_ACTION_HOME, /**< Home key (jump to start of line) */
290 UNIX_CLI_PARSE_ACTION_END, /**< End key (jump to end of line) */
291 UNIX_CLI_PARSE_ACTION_WORDLEFT, /**< Jump cursor to start of left word */
292 UNIX_CLI_PARSE_ACTION_WORDRIGHT, /**< Jump cursor to start of right word */
293 UNIX_CLI_PARSE_ACTION_ERASELINELEFT, /**< Erase line to left of cursor */
294 UNIX_CLI_PARSE_ACTION_ERASELINERIGHT, /**< Erase line to right & including cursor */
295 UNIX_CLI_PARSE_ACTION_CLEAR, /**< Clear the terminal */
296 UNIX_CLI_PARSE_ACTION_REVSEARCH, /**< Search backwards in command history */
297 UNIX_CLI_PARSE_ACTION_FWDSEARCH, /**< Search forwards in command history */
298 UNIX_CLI_PARSE_ACTION_YANK, /**< Undo last erase action */
299 UNIX_CLI_PARSE_ACTION_TELNETIAC, /**< Telnet control code */
301 UNIX_CLI_PARSE_ACTION_PAGER_CRLF, /**< Enter pressed (CR, CRLF, LF, etc) */
302 UNIX_CLI_PARSE_ACTION_PAGER_QUIT, /**< Exit the pager session */
303 UNIX_CLI_PARSE_ACTION_PAGER_NEXT, /**< Scroll to next page */
304 UNIX_CLI_PARSE_ACTION_PAGER_DN, /**< Scroll to next line */
305 UNIX_CLI_PARSE_ACTION_PAGER_UP, /**< Scroll to previous line */
306 UNIX_CLI_PARSE_ACTION_PAGER_TOP, /**< Scroll to first line */
307 UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM, /**< Scroll to last line */
308 UNIX_CLI_PARSE_ACTION_PAGER_PGDN, /**< Scroll to next page */
309 UNIX_CLI_PARSE_ACTION_PAGER_PGUP, /**< Scroll to previous page */
310 UNIX_CLI_PARSE_ACTION_PAGER_REDRAW, /**< Clear and redraw the page on the terminal */
311 UNIX_CLI_PARSE_ACTION_PAGER_SEARCH, /**< Search the pager buffer */
313 UNIX_CLI_PARSE_ACTION_PARTIALMATCH, /**< Action parser found a partial match */
314 UNIX_CLI_PARSE_ACTION_NOMATCH /**< Action parser did not find any match */
315 } unix_cli_parse_action_t;
317 /** @brief Mapping of input buffer strings to action values.
318 * @note This won't work as a hash since we need to be able to do
319 * partial matches on the string.
323 u8 *input; /**< Input string to match. */
324 u32 len; /**< Length of input without final NUL. */
325 unix_cli_parse_action_t action; /**< Action to take when matched. */
326 } unix_cli_parse_actions_t;
328 /** @brief Given a capital ASCII letter character return a @c NUL terminated
329 * string with the control code for that letter.
331 * @param c An ASCII character.
332 * @return A @c NUL terminated string of type @c u8[].
335 * @c CTL('A') returns <code>{ 0x01, 0x00 }</code> as a @c u8[].
337 #define CTL(c) (u8[]){ (c) - '@', 0 }
339 #define _(a,b) { .input = (u8 *)(a), .len = sizeof(a) - 1, .action = (b) }
341 * Patterns to match on a CLI input stream.
344 static unix_cli_parse_actions_t unix_cli_parse_strings[] = {
346 _("\r\n", UNIX_CLI_PARSE_ACTION_CRLF), /* Must be before '\r' */
347 _("\n", UNIX_CLI_PARSE_ACTION_CRLF),
348 _("\r\0", UNIX_CLI_PARSE_ACTION_CRLF), /* Telnet does this */
349 _("\r", UNIX_CLI_PARSE_ACTION_CRLF),
351 /* Unix shell control codes */
352 _(CTL ('B'), UNIX_CLI_PARSE_ACTION_LEFT),
353 _(CTL ('F'), UNIX_CLI_PARSE_ACTION_RIGHT),
354 _(CTL ('P'), UNIX_CLI_PARSE_ACTION_UP),
355 _(CTL ('N'), UNIX_CLI_PARSE_ACTION_DOWN),
356 _(CTL ('A'), UNIX_CLI_PARSE_ACTION_HOME),
357 _(CTL ('E'), UNIX_CLI_PARSE_ACTION_END),
358 _(CTL ('D'), UNIX_CLI_PARSE_ACTION_ERASERIGHT),
359 _(CTL ('U'), UNIX_CLI_PARSE_ACTION_ERASELINELEFT),
360 _(CTL ('K'), UNIX_CLI_PARSE_ACTION_ERASELINERIGHT),
361 _(CTL ('Y'), UNIX_CLI_PARSE_ACTION_YANK),
362 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_CLEAR),
363 _(ESC "b", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* Alt-B */
364 _(ESC "f", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* Alt-F */
365 _("\b", UNIX_CLI_PARSE_ACTION_ERASE), /* ^H */
366 _("\x7f", UNIX_CLI_PARSE_ACTION_ERASE), /* Backspace */
367 _("\t", UNIX_CLI_PARSE_ACTION_TAB), /* ^I */
369 /* VT100 Normal mode - Broadest support */
370 _(CSI "A", UNIX_CLI_PARSE_ACTION_UP),
371 _(CSI "B", UNIX_CLI_PARSE_ACTION_DOWN),
372 _(CSI "C", UNIX_CLI_PARSE_ACTION_RIGHT),
373 _(CSI "D", UNIX_CLI_PARSE_ACTION_LEFT),
374 _(CSI "H", UNIX_CLI_PARSE_ACTION_HOME),
375 _(CSI "F", UNIX_CLI_PARSE_ACTION_END),
376 _(CSI "3~", UNIX_CLI_PARSE_ACTION_ERASERIGHT), /* Delete */
377 _(CSI "1;5D", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* C-Left */
378 _(CSI "1;5C", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* C-Right */
380 /* VT100 Application mode - Some Gnome Terminal functions use these */
381 _(ESC "OA", UNIX_CLI_PARSE_ACTION_UP),
382 _(ESC "OB", UNIX_CLI_PARSE_ACTION_DOWN),
383 _(ESC "OC", UNIX_CLI_PARSE_ACTION_RIGHT),
384 _(ESC "OD", UNIX_CLI_PARSE_ACTION_LEFT),
385 _(ESC "OH", UNIX_CLI_PARSE_ACTION_HOME),
386 _(ESC "OF", UNIX_CLI_PARSE_ACTION_END),
388 /* ANSI X3.41-1974 - sent by Microsoft Telnet and PuTTY */
389 _(CSI "1~", UNIX_CLI_PARSE_ACTION_HOME),
390 _(CSI "4~", UNIX_CLI_PARSE_ACTION_END),
392 /* Emacs-ish history search */
393 _(CTL ('S'), UNIX_CLI_PARSE_ACTION_FWDSEARCH),
394 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_REVSEARCH),
396 /* Other protocol things */
397 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
398 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
399 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
403 * Patterns to match when a CLI session is in the pager.
406 static unix_cli_parse_actions_t unix_cli_parse_pager[] = {
408 _("\r\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Must be before '\r' */
409 _("\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
410 _("\r\0", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Telnet does this */
411 _("\r", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
414 _(" ", UNIX_CLI_PARSE_ACTION_PAGER_NEXT),
415 _("q", UNIX_CLI_PARSE_ACTION_PAGER_QUIT),
416 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
417 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
418 _("/", UNIX_CLI_PARSE_ACTION_PAGER_SEARCH),
421 _(CSI "A", UNIX_CLI_PARSE_ACTION_PAGER_UP),
422 _(CSI "B", UNIX_CLI_PARSE_ACTION_PAGER_DN),
423 _(CSI "H", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
424 _(CSI "F", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
426 /* VT100 Application mode */
427 _(ESC "OA", UNIX_CLI_PARSE_ACTION_PAGER_UP),
428 _(ESC "OB", UNIX_CLI_PARSE_ACTION_PAGER_DN),
429 _(ESC "OH", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
430 _(ESC "OF", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
432 /* ANSI X3.41-1974 */
433 _(CSI "1~", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
434 _(CSI "4~", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
435 _(CSI "5~", UNIX_CLI_PARSE_ACTION_PAGER_PGUP),
436 _(CSI "6~", UNIX_CLI_PARSE_ACTION_PAGER_PGDN),
438 /* Other protocol things */
439 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
440 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
441 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
446 /** CLI session events. */
449 UNIX_CLI_PROCESS_EVENT_READ_READY, /**< A file descriptor has data to be read. */
450 UNIX_CLI_PROCESS_EVENT_QUIT, /**< A CLI session wants to close. */
451 } unix_cli_process_event_type_t;
453 /** CLI global state. */
456 /** Prompt string for CLI. */
459 /** Vec pool of CLI sessions. */
460 unix_cli_file_t *cli_file_pool;
462 /** Vec pool of unused session indices. */
463 u32 *unused_cli_process_node_indices;
465 /** The session index of the stdin cli */
466 u32 stdin_cli_file_index;
468 /** File pool index of current input. */
469 u32 current_input_file_index;
472 /** CLI global state */
473 static unix_cli_main_t unix_cli_main;
476 * @brief Search for a byte sequence in the action list.
478 * Searches the @ref unix_cli_parse_actions_t list in @a a for a match with
479 * the bytes in @a input of maximum length @a ilen bytes.
480 * When a match is made @a *matched indicates how many bytes were matched.
481 * Returns a value from the enum @ref unix_cli_parse_action_t to indicate
482 * whether no match was found, a partial match was found or a complete
483 * match was found and what action, if any, should be taken.
485 * @param[in] a Actions list to search within.
486 * @param[in] input String fragment to search for.
487 * @param[in] ilen Length of the string in 'input'.
488 * @param[out] matched Pointer to an integer that will contain the number
489 * of bytes matched when a complete match is found.
491 * @return Action from @ref unix_cli_parse_action_t that the string fragment
493 * @ref UNIX_CLI_PARSE_ACTION_PARTIALMATCH is returned when the
494 * whole input string matches the start of at least one action.
495 * @ref UNIX_CLI_PARSE_ACTION_NOMATCH is returned when there is no
498 static unix_cli_parse_action_t
499 unix_cli_match_action (unix_cli_parse_actions_t * a,
500 u8 * input, u32 ilen, i32 * matched)
508 /* see if the start of the input buffer exactly matches the current
510 if (memcmp (input, a->input, a->len) == 0)
518 /* if the first ilen characters match, flag this as a partial -
519 * meaning keep collecting bytes in case of a future match */
520 if (memcmp (input, a->input, ilen) == 0)
524 /* check next action */
529 UNIX_CLI_PARSE_ACTION_PARTIALMATCH : UNIX_CLI_PARSE_ACTION_NOMATCH;
533 /** Add bytes to the output vector and then flagg the I/O system that bytes
534 * are available to be sent.
537 unix_cli_add_pending_output (clib_file_t * uf,
538 unix_cli_file_t * cf,
539 u8 * buffer, uword buffer_bytes)
541 clib_file_main_t *fm = &file_main;
543 vec_add (cf->output_vector, buffer, buffer_bytes);
544 if (vec_len (cf->output_vector) > 0)
546 int skip_update = 0 != (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
547 uf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
549 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
553 /** Delete all bytes from the output vector and flag the I/O system
554 * that no more bytes are available to be sent.
557 unix_cli_del_pending_output (clib_file_t * uf,
558 unix_cli_file_t * cf, uword n_bytes)
560 clib_file_main_t *fm = &file_main;
562 vec_delete (cf->output_vector, n_bytes, 0);
563 if (vec_len (cf->output_vector) <= 0)
565 int skip_update = 0 == (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
566 uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
568 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
572 /** @brief A bit like strchr with a buffer length limit.
573 * Search a buffer for the first instance of a character up to the limit of
574 * the buffer length. If found then return the position of that character.
576 * The key departure from strchr is that if the character is not found then
577 * return the buffer length.
579 * @param chr The byte value to search for.
580 * @param str The buffer in which to search for the value.
581 * @param len The depth into the buffer to search.
583 * @return The index of the first occurence of \c chr. If \c chr is not
584 * found then \c len instead.
587 unix_vlib_findchr (u8 chr, u8 * str, word len)
590 for (i = 0; i < len; i++, str++)
598 /** @brief Send a buffer to the CLI stream if possible, enqueue it otherwise.
599 * Attempts to write given buffer to the file descriptor of the given
600 * Unix CLI session. If that session already has data in the output buffer
601 * or if the write attempt tells us to try again later then the given buffer
602 * is appended to the pending output buffer instead.
604 * This is typically called only from \c unix_vlib_cli_output_cooked since
605 * that is where CRLF handling occurs or from places where we explicitly do
606 * not want cooked handling.
608 * @param cf Unix CLI session of the desired stream to write to.
609 * @param uf The Unix file structure of the desired stream to write to.
610 * @param buffer Pointer to the buffer that needs to be written.
611 * @param buffer_bytes The number of bytes from \c buffer to write.
614 unix_vlib_cli_output_raw (unix_cli_file_t * cf,
615 clib_file_t * uf, u8 * buffer, uword buffer_bytes)
619 if (cf->has_epipe) /* don't try writing anything */
622 if (vec_len (cf->output_vector) == 0)
625 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
626 n = send (uf->file_descriptor, buffer, buffer_bytes, MSG_NOSIGNAL);
628 n = write (uf->file_descriptor, buffer, buffer_bytes);
631 if (n < 0 && errno != EAGAIN)
635 /* connection closed on us */
636 unix_main_t *um = &unix_main;
638 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
639 UNIX_CLI_PROCESS_EVENT_QUIT,
644 clib_unix_warning ("write");
647 else if ((word) n < (word) buffer_bytes)
649 /* We got EAGAIN or we already have stuff in the buffer;
650 * queue up whatever didn't get sent for later. */
653 unix_cli_add_pending_output (uf, cf, buffer + n, buffer_bytes - n);
657 /** @brief Process a buffer for CRLF handling before outputting it to the CLI.
659 * @param cf Unix CLI session of the desired stream to write to.
660 * @param uf The Unix file structure of the desired stream to write to.
661 * @param buffer Pointer to the buffer that needs to be written.
662 * @param buffer_bytes The number of bytes from \c buffer to write.
665 unix_vlib_cli_output_cooked (unix_cli_file_t * cf,
667 u8 * buffer, uword buffer_bytes)
669 word end = 0, start = 0;
671 while (end < buffer_bytes)
675 /* iterate the line on \n's so we can insert a \r before it */
676 end = unix_vlib_findchr ('\n',
678 buffer_bytes - start) + start;
682 /* otherwise just send the whole buffer */
686 unix_vlib_cli_output_raw (cf, uf, buffer + start, end - start);
690 if (end < buffer_bytes)
692 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\r\n", 2);
693 end++; /* skip the \n that we already sent */
699 /* Use the last character to determine the last direction of the cursor. */
700 if (buffer_bytes > 0)
701 cf->cursor_direction = (buffer[buffer_bytes - 1] == (u8) '\b');
704 /** @brief Moves the terminal cursor one character to the left, with
705 * special handling when it reaches the left edge of the terminal window.
707 * Ordinarily we can simply send a '\b' to move the cursor left, however
708 * most terminals will not reverse-wrap to the end of the previous line
709 * if the cursor is in the left-most column. To counter this we must
710 * check the cursor position + prompt length modulo terminal width and
711 * if available use some other means, such as ANSI terminal escape
712 * sequences, to move the cursor.
714 * @param cf Unix CLI session of the desired stream to write to.
715 * @param uf The Unix file structure of the desired stream to write to.
718 unix_vlib_cli_output_cursor_left (unix_cli_file_t * cf, clib_file_t * uf)
720 unix_cli_main_t *cm = &unix_cli_main;
721 static u8 *ansi = 0; /* assumes no reentry */
724 if (!cf->is_interactive || !cf->ansi_capable || !cf->width)
726 /* No special handling for dumb terminals */
727 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
731 position = ((u32) vec_len (cm->cli_prompt) + cf->cursor) % cf->width;
735 /* No special handling required if we're not at the left edge */
736 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
740 if (!cf->cursor_direction)
742 /* Special handling for when we are at the left edge but
743 * the cursor was going left-to-right, but in this situation
744 * xterm-like terminals actually hide the cursor off the right
745 * edge. A \b here seems to jump one char too many, so let's
746 * force the cursor onto the next line instead.
748 if (cf->cursor < vec_len (cf->current_command))
749 unix_vlib_cli_output_cooked (cf, uf, &cf->current_command[cf->cursor],
752 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
753 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
756 /* Relocate the cursor at the right hand edge one line above */
757 ansi = format (ansi, CSI "A" CSI "%dC", cf->width - 1);
758 unix_vlib_cli_output_cooked (cf, uf, ansi, vec_len (ansi));
759 vec_reset_length (ansi); /* keep the vec around for next time */
760 cf->cursor_direction = 1; /* going backwards now */
763 /** @brief Output the CLI prompt */
765 unix_cli_cli_prompt (unix_cli_file_t * cf, clib_file_t * uf)
767 unix_cli_main_t *cm = &unix_cli_main;
769 if (cf->is_interactive) /* Only interactive sessions get a prompt */
770 unix_vlib_cli_output_raw (cf, uf, cm->cli_prompt,
771 vec_len (cm->cli_prompt));
774 /** @brief Output a pager prompt and show number of buffered lines */
776 unix_cli_pager_prompt (unix_cli_file_t * cf, clib_file_t * uf)
781 h = cf->pager_start + (cf->height - 1);
782 if (h > vec_len (cf->pager_index))
783 h = vec_len (cf->pager_index);
785 prompt = format (0, "\r%s-- more -- (%d-%d/%d)%s",
786 cf->ansi_capable ? ANSI_BOLD : "",
789 vec_len (cf->pager_index),
790 cf->ansi_capable ? ANSI_RESET : "");
792 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
797 /** @brief Output a pager "skipping" message */
799 unix_cli_pager_message (unix_cli_file_t * cf, clib_file_t * uf,
800 char *message, char *postfix)
804 prompt = format (0, "\r%s-- %s --%s%s",
805 cf->ansi_capable ? ANSI_BOLD : "",
806 message, cf->ansi_capable ? ANSI_RESET : "", postfix);
808 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
813 /** @brief Erase the printed pager prompt */
815 unix_cli_pager_prompt_erase (unix_cli_file_t * cf, clib_file_t * uf)
817 if (cf->ansi_capable)
819 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
820 unix_vlib_cli_output_cooked (cf, uf,
821 (u8 *) ANSI_CLEARLINE,
822 sizeof (ANSI_CLEARLINE) - 1);
828 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
829 for (i = 0; i < cf->width - 1; i++)
830 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
831 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
835 /** @brief Uses an ANSI escape sequence to move the cursor */
837 unix_cli_ansi_cursor (unix_cli_file_t * cf, clib_file_t * uf, u16 x, u16 y)
841 str = format (0, "%s%d;%dH", CSI, y, x);
843 unix_vlib_cli_output_cooked (cf, uf, str, vec_len (str));
848 /** Redraw the currently displayed page of text.
849 * @param cf CLI session to redraw the pager buffer of.
850 * @param uf Unix file of the CLI session.
853 unix_cli_pager_redraw (unix_cli_file_t * cf, clib_file_t * uf)
855 unix_cli_pager_index_t *pi = NULL;
859 /* No active pager? Do nothing. */
860 if (!vec_len (cf->pager_index))
863 if (cf->ansi_capable)
865 /* If we have ANSI, send the clear screen sequence */
866 unix_vlib_cli_output_cooked (cf, uf,
868 sizeof (ANSI_CLEAR) - 1);
872 /* Otherwise make sure we're on a blank line */
873 unix_cli_pager_prompt_erase (cf, uf);
876 /* (Re-)send the current page of content */
877 for (i = 0; i < cf->height - 1 &&
878 i + cf->pager_start < vec_len (cf->pager_index); i++)
880 pi = &cf->pager_index[cf->pager_start + i];
881 line = cf->pager_vector[pi->line] + pi->offset;
883 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
885 /* if the last line didn't end in newline, add a newline */
886 if (pi && line[pi->length - 1] != '\n')
887 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
889 unix_cli_pager_prompt (cf, uf);
892 /** @brief Process and add a line to the pager index.
893 * In normal operation this function will take the given character string
894 * found in @c line and with length @c len_or_index and iterates the over the
895 * contents, adding each line of text discovered within it to the
896 * pager index. Lines are identified by newlines ("<code>\\n</code>") and by
897 * strings longer than the width of the terminal.
899 * If instead @c line is @c NULL then @c len_or_index is taken to mean the
900 * index of an existing line in the pager buffer; this simply means that the
901 * input line does not need to be cloned since we alreayd have it. This is
902 * typical if we are reindexing the pager buffer.
904 * @param cf The CLI session whose pager we are adding to.
905 * @param line The string of text to be indexed into the pager buffer.
906 * If @c line is @c NULL then the mode of operation
907 * changes slightly; see the description above.
908 * @param len_or_index If @c line is a pointer to a string then this parameter
909 * indicates the length of that string; Otherwise this
910 * value provides the index in the pager buffer of an
911 * existing string to be indexed.
914 unix_cli_pager_add_line (unix_cli_file_t * cf, u8 * line, word len_or_index)
918 word line_index, len;
919 u32 width = cf->width;
920 unix_cli_pager_index_t *pi;
924 /* Use a line already in the pager buffer */
925 line_index = len_or_index;
926 if (cf->pager_vector != NULL)
927 p = cf->pager_vector[line_index];
933 /* Add a copy of the raw string to the pager buffer */
934 p = vec_new (u8, len);
935 clib_memcpy (p, line, len);
937 /* store in pager buffer */
938 line_index = vec_len (cf->pager_vector);
939 vec_add1 (cf->pager_vector, p);
945 /* Find the next line, or run to terminal width, or run to EOL */
947 j = unix_vlib_findchr ((u8) '\n', p, l < width ? l : width);
949 if (j < l && p[j] == '\n') /* incl \n */
952 /* Add the line to the index */
953 k = vec_len (cf->pager_index);
954 vec_validate (cf->pager_index, k);
955 pi = &cf->pager_index[k];
957 pi->line = line_index;
966 /** @brief Reindex entire pager buffer.
967 * Resets the current pager index and then re-adds the lines in the pager
968 * buffer to the index.
970 * Additionally this function attempts to retain the current page start
971 * line offset by searching for the same top-of-screen line in the new index.
973 * @param cf The CLI session whose pager buffer should be reindexed.
976 unix_cli_pager_reindex (unix_cli_file_t * cf)
978 word i, old_line, old_offset;
979 unix_cli_pager_index_t *pi;
981 /* If there is nothing in the pager buffer then make sure the index
982 * is empty and move on.
984 if (cf->pager_vector == 0)
986 vec_reset_length (cf->pager_index);
990 /* Retain a pointer to the current page start line so we can
993 pi = &cf->pager_index[cf->pager_start];
995 old_offset = pi->offset;
997 /* Re-add the buffered lines to the index */
998 vec_reset_length (cf->pager_index);
999 vec_foreach_index (i, cf->pager_vector)
1001 unix_cli_pager_add_line (cf, NULL, i);
1004 /* Attempt to re-locate the previously stored page start line */
1005 vec_foreach_index (i, cf->pager_index)
1007 pi = &cf->pager_index[i];
1009 if (pi->line == old_line &&
1010 (pi->offset <= old_offset || pi->offset + pi->length > old_offset))
1013 cf->pager_start = i;
1018 /* In case the start line was not found (rare), ensure the pager start
1019 * index is within bounds
1021 if (cf->pager_start >= vec_len (cf->pager_index))
1023 if (!cf->height || vec_len (cf->pager_index) < (cf->height - 1))
1024 cf->pager_start = 0;
1026 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
1030 /** VLIB CLI output function.
1032 * If the terminal has a pager configured then this function takes care
1033 * of collating output into the pager buffer; ensuring only the first page
1034 * is displayed and any lines in excess of the first page are buffered.
1036 * If the maximum number of index lines in the buffer is exceeded then the
1037 * pager is cancelled and the contents of the current buffer are sent to the
1040 * If there is no pager configured then the output is sent directly to the
1043 * @param cli_file_index Index of the CLI session where this output is
1045 * @param buffer String of printabe bytes to be output.
1046 * @param buffer_bytes The number of bytes in @c buffer to be output.
1049 unix_vlib_cli_output (uword cli_file_index, u8 * buffer, uword buffer_bytes)
1051 unix_main_t *um = &unix_main;
1052 clib_file_main_t *fm = &file_main;
1053 unix_cli_main_t *cm = &unix_cli_main;
1054 unix_cli_file_t *cf;
1057 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
1058 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1060 if (cf->no_pager || um->cli_pager_buffer_limit == 0 || cf->height == 0)
1062 unix_vlib_cli_output_cooked (cf, uf, buffer, buffer_bytes);
1066 word row = vec_len (cf->pager_index);
1068 unix_cli_pager_index_t *pi;
1070 /* Index and add the output lines to the pager buffer. */
1071 unix_cli_pager_add_line (cf, buffer, buffer_bytes);
1073 /* Now iterate what was added to display the lines.
1074 * If we reach the bottom of the page, display a prompt.
1076 while (row < vec_len (cf->pager_index))
1078 if (row < cf->height - 1)
1080 /* output this line */
1081 pi = &cf->pager_index[row];
1082 line = cf->pager_vector[pi->line] + pi->offset;
1083 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1085 /* if the last line didn't end in newline, and we're at the
1086 * bottom of the page, add a newline */
1087 if (line[pi->length - 1] != '\n' && row == cf->height - 2)
1088 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1092 /* Display the pager prompt every 10 lines */
1094 unix_cli_pager_prompt (cf, uf);
1099 /* Check if we went over the pager buffer limit */
1100 if (vec_len (cf->pager_index) > um->cli_pager_buffer_limit)
1102 /* Stop using the pager for the remainder of this CLI command */
1105 /* If we likely printed the prompt, erase it */
1106 if (vec_len (cf->pager_index) > cf->height - 1)
1107 unix_cli_pager_prompt_erase (cf, uf);
1109 /* Dump out the contents of the buffer */
1110 for (row = cf->pager_start + (cf->height - 1);
1111 row < vec_len (cf->pager_index); row++)
1113 pi = &cf->pager_index[row];
1114 line = cf->pager_vector[pi->line] + pi->offset;
1115 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1118 unix_cli_pager_reset (cf);
1123 /** Identify whether a terminal type is ANSI capable.
1125 * Compares the string given in @c term with a list of terminal types known
1126 * to support ANSI escape sequences.
1128 * This list contains, for example, @c xterm, @c screen and @c ansi.
1130 * @param term A string with a terminal type in it.
1131 * @param len The length of the string in @c term.
1133 * @return @c 1 if the terminal type is recognized as supporting ANSI
1134 * terminal sequences; @c 0 otherwise.
1137 unix_cli_terminal_type_ansi (u8 * term, uword len)
1139 /* This may later be better done as a hash of some sort. */
1141 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1146 _("xterm-256color"); /* iTerm on Mac */
1148 _("screen-256color"); /* Screen and tmux */
1149 _("ansi"); /* Microsoft Telnet */
1155 /** Identify whether a terminal type is non-interactive.
1157 * Compares the string given in @c term with a list of terminal types known
1158 * to be non-interactive, as send by tools such as @c vppctl .
1160 * This list contains, for example, @c vppctl.
1162 * @param term A string with a terminal type in it.
1163 * @param len The length of the string in @c term.
1165 * @return @c 1 if the terminal type is recognized as being non-interactive;
1169 unix_cli_terminal_type_noninteractive (u8 * term, uword len)
1171 /* This may later be better done as a hash of some sort. */
1173 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1182 /** Set a session to be non-interactive. */
1184 unix_cli_set_session_noninteractive (unix_cli_file_t * cf)
1186 /* Non-interactive sessions don't get these */
1187 cf->is_interactive = 0;
1189 cf->history_limit = 0;
1190 cf->has_history = 0;
1194 /** @brief Emit initial welcome banner and prompt on a connection. */
1196 unix_cli_file_welcome (unix_cli_main_t * cm, unix_cli_file_t * cf)
1198 unix_main_t *um = &unix_main;
1199 clib_file_main_t *fm = &file_main;
1200 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1201 unix_cli_banner_t *banner;
1204 /* Mark the session as started if we get here */
1207 if (!(cf->is_interactive)) /* No banner for non-interactive sessions */
1211 * Put the first bytes directly into the buffer so that further output is
1212 * queued until everything is ready. (oterwise initial prompt can appear
1213 * mid way through VPP initialization)
1215 unix_cli_add_pending_output (uf, cf, (u8 *) "\r", 1);
1217 if (!um->cli_no_banner)
1219 if (cf->ansi_capable)
1221 banner = unix_cli_banner_color;
1222 len = ARRAY_LEN (unix_cli_banner_color);
1226 banner = unix_cli_banner;
1227 len = ARRAY_LEN (unix_cli_banner);
1230 for (i = 0; i < len; i++)
1232 unix_vlib_cli_output_cooked (cf, uf,
1233 banner[i].line, banner[i].length);
1238 unix_cli_cli_prompt (cf, uf);
1242 /** @brief A failsafe triggered on a timer to ensure we send the prompt
1243 * to telnet sessions that fail to negotiate the terminal type. */
1245 unix_cli_file_welcome_timer (any arg, f64 delay)
1247 unix_cli_main_t *cm = &unix_cli_main;
1248 unix_cli_file_t *cf;
1251 /* Check the connection didn't close already */
1252 if (pool_is_free_index (cm->cli_file_pool, (uword) arg))
1255 cf = pool_elt_at_index (cm->cli_file_pool, (uword) arg);
1258 unix_cli_file_welcome (cm, cf);
1261 /** @brief A mostly no-op Telnet state machine.
1262 * Process Telnet command bytes in a way that ensures we're mostly
1263 * transparent to the Telnet protocol. That is, it's mostly a no-op.
1265 * @return -1 if we need more bytes, otherwise a positive integer number of
1266 * bytes to consume from the input_vector, not including the initial
1270 unix_cli_process_telnet (unix_main_t * um,
1271 unix_cli_file_t * cf,
1272 clib_file_t * uf, u8 * input_vector, uword len)
1274 /* Input_vector starts at IAC byte.
1275 * See if we have a complete message; if not, return -1 so we wait for more.
1276 * if we have a complete message, consume those bytes from the vector.
1281 return -1; /* want more bytes */
1283 switch (input_vector[1])
1286 /* two IAC's in a row means to pass through 0xff.
1287 * since that makes no sense here, just consume it.
1296 /* Expect 3 bytes */
1297 if (vec_len (input_vector) < 3)
1298 return -1; /* want more bytes */
1305 /* Sub option - search ahead for IAC SE to end it */
1307 for (i = 3; i < len && i < UNIX_CLI_MAX_DEPTH_TELNET; i++)
1309 if (input_vector[i - 1] == IAC && input_vector[i] == SE)
1311 /* We have a complete message; see if we care about it */
1312 switch (input_vector[2])
1315 if (input_vector[3] != 0)
1318 /* See if the the terminal type is recognized */
1319 u8 *term = input_vector + 4;
1322 /* See if the terminal type is ANSI capable */
1324 unix_cli_terminal_type_ansi (term, len);
1326 /* See if the terminal type indicates non-interactive */
1327 if (unix_cli_terminal_type_noninteractive (term, len))
1328 unix_cli_set_session_noninteractive (cf);
1331 /* If session not started, we can release the pause */
1333 /* Send the welcome banner and initial prompt */
1334 unix_cli_file_welcome (&unix_cli_main, cf);
1339 if (i != 8) /* check message is correct size */
1343 clib_net_to_host_u16 (*((u16 *) (input_vector + 3)));
1344 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
1345 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
1347 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
1350 clib_net_to_host_u16 (*((u16 *) (input_vector + 5)));
1351 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
1352 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
1353 if (cf->height == 0)
1354 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
1356 /* reindex pager buffer */
1357 unix_cli_pager_reindex (cf);
1359 unix_cli_pager_redraw (cf, uf);
1365 /* Consume it all */
1371 if (i == UNIX_CLI_MAX_DEPTH_TELNET)
1372 consume = 1; /* hit max search depth, advance one byte */
1375 return -1; /* want more bytes */
1393 /* Simple one-byte messages */
1398 /* Are You There - trigger a visible response */
1400 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "fd.io VPP\n", 10);
1404 /* Unknown command! Eat the IAC byte */
1411 /** @brief Process actionable input.
1412 * Based on the \c action process the input; this typically involves
1413 * searching the command history or editing the current command line.
1416 unix_cli_line_process_one (unix_cli_main_t * cm,
1418 unix_cli_file_t * cf,
1420 u8 input, unix_cli_parse_action_t action)
1424 u8 **possible_commands;
1429 case UNIX_CLI_PARSE_ACTION_NOACTION:
1432 case UNIX_CLI_PARSE_ACTION_REVSEARCH:
1433 case UNIX_CLI_PARSE_ACTION_FWDSEARCH:
1434 if (!cf->has_history || !cf->history_limit)
1436 if (cf->search_mode == 0)
1438 /* Erase the current command (if any) */
1439 for (; cf->cursor > 0; cf->cursor--)
1441 unix_vlib_cli_output_cursor_left (cf, uf);
1442 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1443 unix_vlib_cli_output_cursor_left (cf, uf);
1446 vec_reset_length (cf->search_key);
1447 vec_reset_length (cf->current_command);
1449 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1450 cf->search_mode = -1;
1452 cf->search_mode = 1;
1456 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1457 cf->search_mode = -1;
1459 cf->search_mode = 1;
1461 cf->excursion += cf->search_mode;
1466 case UNIX_CLI_PARSE_ACTION_ERASELINELEFT:
1467 /* Erase the command from the cursor to the start */
1470 /* Shimmy backwards to the new end of line position */
1471 delta = vec_len (cf->current_command) - cf->cursor;
1472 for (; cf->cursor > delta; cf->cursor--)
1473 unix_vlib_cli_output_cursor_left (cf, uf);
1474 /* Zap from here to the end of what is currently displayed */
1475 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1476 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1477 /* Get back to the start of the line */
1478 for (; cf->cursor > 0; cf->cursor--)
1479 unix_vlib_cli_output_cursor_left (cf, uf);
1481 /* Delete the desired text from the command */
1482 memmove (cf->current_command, cf->current_command + j, delta);
1483 _vec_len (cf->current_command) = delta;
1485 /* Print the new contents */
1486 unix_vlib_cli_output_cooked (cf, uf, cf->current_command, delta);
1487 cf->cursor = delta; /* for backspace tracking */
1489 /* Shimmy back to the start */
1490 for (; cf->cursor > 0; cf->cursor--)
1491 unix_vlib_cli_output_cursor_left (cf, uf);
1493 cf->search_mode = 0;
1496 case UNIX_CLI_PARSE_ACTION_ERASELINERIGHT:
1497 /* Erase the command from the cursor to the end */
1500 /* Zap from cursor to end of what is currently displayed */
1501 for (; cf->cursor < (vec_len (cf->current_command)); cf->cursor++)
1502 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1503 /* Get back to where we were */
1504 for (; cf->cursor > j; cf->cursor--)
1505 unix_vlib_cli_output_cursor_left (cf, uf);
1507 /* Truncate the line at the cursor */
1508 _vec_len (cf->current_command) = cf->cursor;
1510 cf->search_mode = 0;
1513 case UNIX_CLI_PARSE_ACTION_LEFT:
1516 unix_vlib_cli_output_cursor_left (cf, uf);
1520 cf->search_mode = 0;
1523 case UNIX_CLI_PARSE_ACTION_RIGHT:
1524 if (cf->cursor < vec_len (cf->current_command))
1526 /* have to emit the character under the cursor */
1527 unix_vlib_cli_output_cooked (cf, uf,
1528 cf->current_command + cf->cursor, 1);
1532 cf->search_mode = 0;
1535 case UNIX_CLI_PARSE_ACTION_UP:
1536 case UNIX_CLI_PARSE_ACTION_DOWN:
1537 if (!cf->has_history || !cf->history_limit)
1539 cf->search_mode = 0;
1540 /* Erase the command */
1541 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1542 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1543 for (; cf->cursor > 0; cf->cursor--)
1545 unix_vlib_cli_output_cursor_left (cf, uf);
1546 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1547 unix_vlib_cli_output_cursor_left (cf, uf);
1549 vec_reset_length (cf->current_command);
1550 if (vec_len (cf->command_history))
1552 if (action == UNIX_CLI_PARSE_ACTION_UP)
1557 cf->excursion += delta;
1559 if (cf->excursion == vec_len (cf->command_history))
1561 /* down-arrowed to last entry - want a blank line */
1562 _vec_len (cf->current_command) = 0;
1564 else if (cf->excursion < 0)
1566 /* up-arrowed over the start to the end, want a blank line */
1567 cf->excursion = vec_len (cf->command_history);
1568 _vec_len (cf->current_command) = 0;
1572 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1573 /* down-arrowed past end - wrap to start */
1576 /* Print the command at the current position */
1577 prev = cf->command_history[cf->excursion];
1578 vec_validate (cf->current_command, vec_len (prev) - 1);
1580 clib_memcpy (cf->current_command, prev, vec_len (prev));
1581 _vec_len (cf->current_command) = vec_len (prev);
1582 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1583 vec_len (cf->current_command));
1586 cf->cursor = vec_len (cf->current_command);
1589 case UNIX_CLI_PARSE_ACTION_HOME:
1590 if (vec_len (cf->current_command) && cf->cursor > 0)
1592 for (; cf->cursor > 0; cf->cursor--)
1593 unix_vlib_cli_output_cursor_left (cf, uf);
1596 cf->search_mode = 0;
1599 case UNIX_CLI_PARSE_ACTION_END:
1600 if (vec_len (cf->current_command) &&
1601 cf->cursor < vec_len (cf->current_command))
1603 unix_vlib_cli_output_cooked (cf, uf,
1604 cf->current_command + cf->cursor,
1605 vec_len (cf->current_command) -
1607 cf->cursor = vec_len (cf->current_command);
1610 cf->search_mode = 0;
1613 case UNIX_CLI_PARSE_ACTION_WORDLEFT:
1614 if (vec_len (cf->current_command) && cf->cursor > 0)
1616 unix_vlib_cli_output_cursor_left (cf, uf);
1619 while (cf->cursor && isspace (cf->current_command[cf->cursor]))
1621 unix_vlib_cli_output_cursor_left (cf, uf);
1624 while (cf->cursor && !isspace (cf->current_command[cf->cursor]))
1626 if (isspace (cf->current_command[cf->cursor - 1]))
1628 unix_vlib_cli_output_cursor_left (cf, uf);
1634 cf->search_mode = 0;
1637 case UNIX_CLI_PARSE_ACTION_WORDRIGHT:
1638 if (vec_len (cf->current_command) &&
1639 cf->cursor < vec_len (cf->current_command))
1641 int e = vec_len (cf->current_command);
1643 while (j < e && !isspace (cf->current_command[j]))
1645 while (j < e && isspace (cf->current_command[j]))
1647 unix_vlib_cli_output_cooked (cf, uf,
1648 cf->current_command + cf->cursor,
1653 cf->search_mode = 0;
1657 case UNIX_CLI_PARSE_ACTION_ERASE:
1658 if (vec_len (cf->current_command))
1660 if (cf->cursor == vec_len (cf->current_command))
1662 unix_vlib_cli_output_cursor_left (cf, uf);
1664 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1666 unix_vlib_cli_output_cursor_left (cf, uf);
1668 _vec_len (cf->current_command)--;
1670 else if (cf->cursor > 0)
1672 /* shift everything at & to the right of the cursor left by 1 */
1673 j = vec_len (cf->current_command) - cf->cursor;
1674 memmove (cf->current_command + cf->cursor - 1,
1675 cf->current_command + cf->cursor, j);
1676 _vec_len (cf->current_command)--;
1678 /* redraw the rest of the line */
1679 unix_vlib_cli_output_cursor_left (cf, uf);
1681 unix_vlib_cli_output_cooked (cf, uf,
1682 cf->current_command + cf->cursor,
1685 /* erase last char */
1686 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1689 /* and shift the terminal cursor back where it should be */
1690 j += 2; /* account for old string length and offset position */
1693 unix_vlib_cli_output_cursor_left (cf, uf);
1698 cf->search_mode = 0;
1700 vec_reset_length (cf->search_key);
1703 case UNIX_CLI_PARSE_ACTION_ERASERIGHT:
1704 if (vec_len (cf->current_command))
1706 if (cf->cursor < vec_len (cf->current_command))
1708 /* shift everything to the right of the cursor left by 1 */
1709 j = vec_len (cf->current_command) - cf->cursor - 1;
1710 memmove (cf->current_command + cf->cursor,
1711 cf->current_command + cf->cursor + 1, j);
1712 _vec_len (cf->current_command)--;
1713 /* redraw the rest of the line */
1714 unix_vlib_cli_output_cooked (cf, uf,
1715 cf->current_command + cf->cursor,
1718 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1720 unix_vlib_cli_output_cursor_left (cf, uf);
1722 /* and shift the terminal cursor back where it should be */
1725 unix_vlib_cli_output_cursor_left (cf, uf);
1729 unix_vlib_cli_output_cursor_left (cf, uf);
1735 else if (input == 'D' - '@')
1737 /* ^D with no command entered = quit */
1738 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "quit\n", 5);
1739 vlib_process_signal_event (um->vlib_main,
1740 vlib_current_process (um->vlib_main),
1741 UNIX_CLI_PROCESS_EVENT_QUIT,
1742 cf - cm->cli_file_pool);
1744 cf->search_mode = 0;
1746 vec_reset_length (cf->search_key);
1749 case UNIX_CLI_PARSE_ACTION_CLEAR:
1750 /* If we're in ANSI mode, clear the screen.
1751 * Then redraw the prompt and any existing command input, then put
1752 * the cursor back where it was in that line.
1754 if (cf->ansi_capable)
1755 unix_vlib_cli_output_cooked (cf, uf,
1757 sizeof (ANSI_CLEAR) - 1);
1759 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1761 unix_vlib_cli_output_raw (cf, uf,
1762 cm->cli_prompt, vec_len (cm->cli_prompt));
1763 unix_vlib_cli_output_cooked (cf, uf,
1764 cf->current_command,
1765 vec_len (cf->current_command));
1767 cf->cursor = vec_len (cf->current_command);
1768 for (; cf->cursor > j; cf->cursor--)
1769 unix_vlib_cli_output_cursor_left (cf, uf);
1773 case UNIX_CLI_PARSE_ACTION_TAB:
1774 if (cf->cursor < vec_len (cf->current_command))
1776 /* if we are in the middle of a line, complete only if
1777 * the cursor points to whitespace */
1778 if (isspace (cf->current_command[cf->cursor]))
1780 /* save and clear any input that is after the cursor */
1781 vec_resize (save, vec_len (cf->current_command) - cf->cursor);
1782 clib_memcpy (save, cf->current_command + cf->cursor,
1783 vec_len (cf->current_command) - cf->cursor);
1784 _vec_len (cf->current_command) = cf->cursor;
1788 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1793 vlib_cli_get_possible_completions (cf->current_command);
1794 if (vec_len (possible_commands) == 1)
1796 u8 *completed = possible_commands[0];
1799 /* find the last word of current_command */
1800 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1802 unix_vlib_cli_output_cursor_left (cf, uf);
1806 _vec_len (cf->current_command) = j;
1808 /* replace it with the newly expanded command */
1809 vec_append (cf->current_command, completed);
1811 /* echo to the terminal */
1812 unix_vlib_cli_output_cooked (cf, uf, completed,
1813 vec_len (completed));
1815 /* add one trailing space if needed */
1816 if (vec_len (save) == 0)
1818 vec_add1 (cf->current_command, ' ');
1819 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1822 cf->cursor = vec_len (cf->current_command);
1825 else if (vec_len (possible_commands) >= 2)
1827 u8 **possible_command;
1828 uword max_command_len = 0, min_command_len = ~0;
1831 vec_foreach (possible_command, possible_commands)
1833 if (vec_len (*possible_command) > max_command_len)
1834 max_command_len = vec_len (*possible_command);
1835 if (vec_len (*possible_command) < min_command_len)
1836 min_command_len = vec_len (*possible_command);
1839 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1842 vec_foreach (possible_command, possible_commands)
1844 if (i + max_command_len >= cf->width)
1846 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1849 unix_vlib_cli_output_cooked (cf, uf, *possible_command,
1850 vec_len (*possible_command));
1851 for (j = vec_len (*possible_command); j < max_command_len + 2;
1854 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1856 i += max_command_len + 2;
1859 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1861 /* rewrite prompt */
1862 unix_cli_cli_prompt (cf, uf);
1863 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1864 vec_len (cf->current_command));
1866 /* count length of last word */
1869 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1875 /* determine smallest common command */
1876 for (; i < min_command_len; i++)
1881 vec_foreach (possible_command, possible_commands)
1885 common = (*possible_command)[i];
1887 else if (common != (*possible_command)[i])
1896 vec_add1 (cf->current_command, common);
1898 unix_vlib_cli_output_cooked (cf, uf, (u8 *) & common, 1);
1908 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1911 if (vec_len (save) > 0)
1913 /* restore remaining input if tab was hit in the middle of a line */
1914 unix_vlib_cli_output_cooked (cf, uf, save, vec_len (save));
1915 cf->cursor += vec_len (save);
1916 for (j = 0; j < vec_len (save); j++, cf->cursor--)
1917 unix_vlib_cli_output_cursor_left (cf, uf);
1918 vec_append (cf->current_command, save);
1921 vec_free (possible_commands);
1924 case UNIX_CLI_PARSE_ACTION_YANK:
1929 case UNIX_CLI_PARSE_ACTION_PAGER_QUIT:
1931 unix_cli_pager_prompt_erase (cf, uf);
1932 unix_cli_pager_reset (cf);
1933 unix_cli_cli_prompt (cf, uf);
1936 case UNIX_CLI_PARSE_ACTION_PAGER_NEXT:
1937 case UNIX_CLI_PARSE_ACTION_PAGER_PGDN:
1938 /* show next page of the buffer */
1939 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
1942 unix_cli_pager_index_t *pi = NULL;
1944 int m = cf->pager_start + (cf->height - 1);
1945 unix_cli_pager_prompt_erase (cf, uf);
1947 j < vec_len (cf->pager_index) && cf->pager_start < m;
1948 j++, cf->pager_start++)
1950 pi = &cf->pager_index[j];
1951 line = cf->pager_vector[pi->line] + pi->offset;
1952 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1954 /* if the last line didn't end in newline, add a newline */
1955 if (pi && line[pi->length - 1] != '\n')
1956 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1957 unix_cli_pager_prompt (cf, uf);
1961 if (action == UNIX_CLI_PARSE_ACTION_PAGER_NEXT)
1962 /* no more in buffer, exit, but only if it was <space> */
1967 case UNIX_CLI_PARSE_ACTION_PAGER_DN:
1968 case UNIX_CLI_PARSE_ACTION_PAGER_CRLF:
1969 /* display the next line of the buffer */
1970 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
1973 unix_cli_pager_index_t *pi;
1975 unix_cli_pager_prompt_erase (cf, uf);
1976 pi = &cf->pager_index[cf->pager_start + (cf->height - 1)];
1977 line = cf->pager_vector[pi->line] + pi->offset;
1978 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1980 /* if the last line didn't end in newline, add a newline */
1981 if (line[pi->length - 1] != '\n')
1982 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1983 unix_cli_pager_prompt (cf, uf);
1987 if (action == UNIX_CLI_PARSE_ACTION_PAGER_CRLF)
1988 /* no more in buffer, exit, but only if it was <enter> */
1994 case UNIX_CLI_PARSE_ACTION_PAGER_UP:
1995 /* scroll the page back one line */
1996 if (cf->pager_start > 0)
1999 unix_cli_pager_index_t *pi = NULL;
2002 if (cf->ansi_capable)
2004 pi = &cf->pager_index[cf->pager_start];
2005 line = cf->pager_vector[pi->line] + pi->offset;
2006 unix_cli_pager_prompt_erase (cf, uf);
2007 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SCROLLDN,
2008 sizeof (ANSI_SCROLLDN) - 1);
2009 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SAVECURSOR,
2010 sizeof (ANSI_SAVECURSOR) - 1);
2011 unix_cli_ansi_cursor (cf, uf, 1, 1);
2012 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_CLEARLINE,
2013 sizeof (ANSI_CLEARLINE) - 1);
2014 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2015 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_RESTCURSOR,
2016 sizeof (ANSI_RESTCURSOR) - 1);
2017 unix_cli_pager_prompt_erase (cf, uf);
2018 unix_cli_pager_prompt (cf, uf);
2022 int m = cf->pager_start + (cf->height - 1);
2023 unix_cli_pager_prompt_erase (cf, uf);
2024 for (j = cf->pager_start;
2025 j < vec_len (cf->pager_index) && j < m; j++)
2027 pi = &cf->pager_index[j];
2028 line = cf->pager_vector[pi->line] + pi->offset;
2029 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2031 /* if the last line didn't end in newline, add a newline */
2032 if (pi && line[pi->length - 1] != '\n')
2033 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2034 unix_cli_pager_prompt (cf, uf);
2039 case UNIX_CLI_PARSE_ACTION_PAGER_TOP:
2040 /* back to the first page of the buffer */
2041 if (cf->pager_start > 0)
2044 unix_cli_pager_index_t *pi = NULL;
2046 cf->pager_start = 0;
2047 int m = cf->pager_start + (cf->height - 1);
2048 unix_cli_pager_prompt_erase (cf, uf);
2049 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2052 pi = &cf->pager_index[j];
2053 line = cf->pager_vector[pi->line] + pi->offset;
2054 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2056 /* if the last line didn't end in newline, add a newline */
2057 if (pi && line[pi->length - 1] != '\n')
2058 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2059 unix_cli_pager_prompt (cf, uf);
2063 case UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM:
2064 /* skip to the last page of the buffer */
2065 if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
2068 unix_cli_pager_index_t *pi = NULL;
2070 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
2071 unix_cli_pager_prompt_erase (cf, uf);
2072 unix_cli_pager_message (cf, uf, "skipping", "\n");
2073 for (j = cf->pager_start; j < vec_len (cf->pager_index); j++)
2075 pi = &cf->pager_index[j];
2076 line = cf->pager_vector[pi->line] + pi->offset;
2077 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2079 /* if the last line didn't end in newline, add a newline */
2080 if (pi && line[pi->length - 1] != '\n')
2081 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2082 unix_cli_pager_prompt (cf, uf);
2086 case UNIX_CLI_PARSE_ACTION_PAGER_PGUP:
2087 /* wander back one page in the buffer */
2088 if (cf->pager_start > 0)
2091 unix_cli_pager_index_t *pi = NULL;
2094 if (cf->pager_start >= cf->height)
2095 cf->pager_start -= cf->height - 1;
2097 cf->pager_start = 0;
2098 m = cf->pager_start + cf->height - 1;
2099 unix_cli_pager_prompt_erase (cf, uf);
2100 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2103 pi = &cf->pager_index[j];
2104 line = cf->pager_vector[pi->line] + pi->offset;
2105 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2107 /* if the last line didn't end in newline, add a newline */
2108 if (pi && line[pi->length - 1] != '\n')
2109 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2110 unix_cli_pager_prompt (cf, uf);
2114 case UNIX_CLI_PARSE_ACTION_PAGER_REDRAW:
2115 /* Redraw the current pager screen */
2116 unix_cli_pager_redraw (cf, uf);
2119 case UNIX_CLI_PARSE_ACTION_PAGER_SEARCH:
2120 /* search forwards in the buffer */
2124 case UNIX_CLI_PARSE_ACTION_CRLF:
2126 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2128 if (cf->has_history && cf->history_limit)
2130 if (cf->command_history
2131 && vec_len (cf->command_history) >= cf->history_limit)
2133 vec_free (cf->command_history[0]);
2134 vec_delete (cf->command_history, 1, 0);
2136 /* Don't add blank lines to the cmd history */
2137 if (vec_len (cf->current_command))
2139 /* Don't duplicate the previous command */
2140 j = vec_len (cf->command_history);
2142 (vec_len (cf->current_command) !=
2143 vec_len (cf->command_history[j - 1])
2144 || memcmp (cf->current_command, cf->command_history[j - 1],
2145 vec_len (cf->current_command)) != 0))
2147 /* copy the command to the history */
2149 vec_append (c, cf->current_command);
2150 vec_add1 (cf->command_history, c);
2151 cf->command_number++;
2154 cf->excursion = vec_len (cf->command_history);
2157 cf->search_mode = 0;
2158 vec_reset_length (cf->search_key);
2163 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2164 case UNIX_CLI_PARSE_ACTION_NOMATCH:
2165 if (vec_len (cf->pager_index))
2169 else if (cf->has_history && cf->search_mode != 0 && isprint (input))
2171 int k, limit, offset;
2174 vec_add1 (cf->search_key, input);
2177 for (j = 0; j < vec_len (cf->command_history); j++)
2179 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
2181 else if (cf->excursion < 0)
2182 cf->excursion = vec_len (cf->command_history) - 1;
2184 item = cf->command_history[cf->excursion];
2186 limit = (vec_len (cf->search_key) > vec_len (item)) ?
2187 vec_len (item) : vec_len (cf->search_key);
2189 for (offset = 0; offset <= vec_len (item) - limit; offset++)
2191 for (k = 0; k < limit; k++)
2193 if (item[k + offset] != cf->search_key[k])
2196 goto found_at_offset;
2204 for (; cf->cursor > 0; cf->cursor--)
2206 unix_vlib_cli_output_cursor_left (cf, uf);
2207 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2208 unix_vlib_cli_output_cursor_left (cf, uf);
2211 vec_validate (cf->current_command, vec_len (item) - 1);
2212 clib_memcpy (cf->current_command, item, vec_len (item));
2213 _vec_len (cf->current_command) = vec_len (item);
2215 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2216 vec_len (cf->current_command));
2217 cf->cursor = vec_len (cf->current_command);
2221 cf->excursion += cf->search_mode;
2224 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\nNo match...", 12);
2225 vec_reset_length (cf->search_key);
2226 vec_reset_length (cf->current_command);
2227 cf->search_mode = 0;
2231 else if (isprint (input)) /* skip any errant control codes */
2233 if (cf->cursor == vec_len (cf->current_command))
2236 vec_add1 (cf->current_command, input);
2239 /* Echo the character back to the client */
2240 unix_vlib_cli_output_cooked (cf, uf, &input, 1);
2244 /* Insert at cursor: resize +1 byte, move everything over */
2245 j = vec_len (cf->current_command) - cf->cursor;
2246 vec_add1 (cf->current_command, (u8) 'A');
2247 memmove (cf->current_command + cf->cursor + 1,
2248 cf->current_command + cf->cursor, j);
2249 cf->current_command[cf->cursor] = input;
2250 /* Redraw the line */
2252 unix_vlib_cli_output_cooked (cf, uf,
2253 cf->current_command + cf->cursor,
2257 /* Put terminal cursor back */
2258 for (; j > 0; j--, cf->cursor--)
2259 unix_vlib_cli_output_cursor_left (cf, uf);
2264 /* no-op - not printable or otherwise not actionable */
2271 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2277 /** @brief Process input bytes on a stream to provide line editing and
2278 * command history in the CLI. */
2280 unix_cli_line_edit (unix_cli_main_t * cm, unix_main_t * um,
2281 clib_file_main_t * fm, unix_cli_file_t * cf)
2283 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2286 for (i = 0; i < vec_len (cf->input_vector); i++)
2288 unix_cli_parse_action_t action;
2290 unix_cli_parse_actions_t *a;
2292 /* If we're in the pager mode, search the pager actions */
2294 vec_len (cf->pager_index) ? unix_cli_parse_pager :
2295 unix_cli_parse_strings;
2297 /* See if the input buffer is some sort of control code */
2298 action = unix_cli_match_action (a, &cf->input_vector[i],
2299 vec_len (cf->input_vector) - i,
2304 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2307 /* There was a partial match which means we need more bytes
2308 * than the input buffer currently has.
2309 * Since the bytes before here have been processed, shift
2310 * the remaining contents to the start of the input buffer.
2312 vec_delete (cf->input_vector, i, 0);
2314 return 1; /* wait for more */
2316 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2317 /* process telnet options */
2318 matched = unix_cli_process_telnet (um, cf, uf,
2319 cf->input_vector + i,
2320 vec_len (cf->input_vector) - i);
2323 /* There was a partial match which means we need more bytes
2324 * than the input buffer currently has.
2329 * Since the bytes before here have been processed, shift
2330 * the remaining contents to the start of the input buffer.
2332 vec_delete (cf->input_vector, i, 0);
2334 return 1; /* wait for more */
2339 /* If telnet option processing switched us to line mode, get us
2344 vec_delete (cf->input_vector, i, 0);
2345 cf->current_command = cf->input_vector;
2349 /* process the action */
2350 if (!unix_cli_line_process_one (cm, um, cf, uf,
2351 cf->input_vector[i], action))
2353 /* CRLF found. Consume the bytes from the input_vector */
2354 vec_delete (cf->input_vector, i + matched, 0);
2355 /* And tell our caller to execute cf->input_command */
2363 vec_reset_length (cf->input_vector);
2367 /** @brief Process input to a CLI session. */
2369 unix_cli_process_input (unix_cli_main_t * cm, uword cli_file_index)
2371 unix_main_t *um = &unix_main;
2372 clib_file_main_t *fm = &file_main;
2374 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2375 unformat_input_t input;
2376 int vlib_parse_eval (u8 *);
2378 cm->current_input_file_index = cli_file_index;
2381 /* Try vlibplex first. Someday... */
2382 if (0 && vlib_parse_eval (cf->input_vector) == 0)
2388 /* just treat whatever we got as a complete line of input */
2389 cf->current_command = cf->input_vector;
2393 /* Line edit, echo, etc. */
2394 if (unix_cli_line_edit (cm, um, fm, cf))
2395 /* want more input */
2402 vec_reset_length (lv);
2403 lv = format (lv, "%U[%d]: %v",
2404 format_timeval, 0 /* current bat-time */ ,
2405 0 /* current bat-format */ ,
2406 cli_file_index, cf->current_command);
2407 int rv __attribute__ ((unused)) = write (um->log_fd, lv, vec_len (lv));
2410 /* Build an unformat structure around our command */
2411 unformat_init_vector (&input, cf->current_command);
2413 /* Remove leading white space from input. */
2414 (void) unformat (&input, "");
2416 cf->pager_start = 0; /* start a new pager session */
2418 if (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
2419 vlib_cli_input (um->vlib_main, &input, unix_vlib_cli_output,
2422 /* Zero buffer since otherwise unformat_free will call vec_free on it. */
2425 unformat_free (&input);
2427 /* Re-fetch pointer since pool may have moved. */
2428 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2429 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2432 /* reset vector; we'll re-use it later */
2435 vec_reset_length (cf->input_vector);
2436 cf->current_command = 0;
2440 vec_reset_length (cf->current_command);
2443 if (cf->no_pager == 2)
2445 /* Pager was programmatically disabled */
2446 unix_cli_pager_message (cf, uf, "pager buffer overflowed", "\n");
2447 cf->no_pager = um->cli_no_pager;
2450 if (vec_len (cf->pager_index) == 0
2451 || vec_len (cf->pager_index) < cf->height)
2453 /* There was no need for the pager */
2454 unix_cli_pager_reset (cf);
2457 unix_cli_cli_prompt (cf, uf);
2461 /* Display the pager prompt */
2462 unix_cli_pager_prompt (cf, uf);
2465 /* Any residual data in the input vector? */
2466 if (vec_len (cf->input_vector))
2469 /* For non-interactive sessions send a NUL byte.
2470 * Specifically this is because vppctl needs to see some traffic in
2471 * order to move on to closing the session. Commands with no output
2472 * would thus cause vppctl to hang indefinitely in non-interactive mode
2473 * since there is also no prompt sent after the command completes.
2475 if (!cf->is_interactive)
2476 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\0", 1);
2479 /** Destroy a CLI session.
2480 * @note If we destroy the @c stdin session this additionally signals
2481 * the shutdown of VPP.
2484 unix_cli_kill (unix_cli_main_t * cm, uword cli_file_index)
2486 unix_main_t *um = &unix_main;
2487 clib_file_main_t *fm = &file_main;
2488 unix_cli_file_t *cf;
2492 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2493 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2495 /* Quit/EOF on stdin means quit program. */
2496 if (uf->file_descriptor == STDIN_FILENO)
2497 clib_longjmp (&um->vlib_main->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
2499 vec_free (cf->current_command);
2500 vec_free (cf->search_key);
2502 for (i = 0; i < vec_len (cf->command_history); i++)
2503 vec_free (cf->command_history[i]);
2505 vec_free (cf->command_history);
2507 clib_file_del (fm, uf);
2509 unix_cli_file_free (cf);
2510 pool_put (cm->cli_file_pool, cf);
2513 /** Handle system events. */
2515 unix_cli_process (vlib_main_t * vm,
2516 vlib_node_runtime_t * rt, vlib_frame_t * f)
2518 unix_cli_main_t *cm = &unix_cli_main;
2523 unix_cli_process_event_type_t event_type;
2524 vlib_process_wait_for_event (vm);
2525 event_type = vlib_process_get_events (vm, &data);
2529 case UNIX_CLI_PROCESS_EVENT_READ_READY:
2530 for (i = 0; i < vec_len (data); i++)
2531 unix_cli_process_input (cm, data[i]);
2534 case UNIX_CLI_PROCESS_EVENT_QUIT:
2535 /* Kill this process. */
2536 for (i = 0; i < vec_len (data); i++)
2537 unix_cli_kill (cm, data[i]);
2542 _vec_len (data) = 0;
2548 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
2550 /* Add node index so we can re-use this process later. */
2551 vec_add1 (cm->unused_cli_process_node_indices, rt->node_index);
2556 /** Called when a CLI session file descriptor can be written to without
2558 static clib_error_t *
2559 unix_cli_write_ready (clib_file_t * uf)
2561 unix_cli_main_t *cm = &unix_cli_main;
2562 unix_cli_file_t *cf;
2565 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2567 /* Flush output vector. */
2569 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
2570 n = send (uf->file_descriptor,
2571 cf->output_vector, vec_len (cf->output_vector), MSG_NOSIGNAL);
2573 n = write (uf->file_descriptor,
2574 cf->output_vector, vec_len (cf->output_vector));
2576 if (n < 0 && errno != EAGAIN)
2580 /* connection closed on us */
2581 unix_main_t *um = &unix_main;
2583 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
2584 UNIX_CLI_PROCESS_EVENT_QUIT,
2589 return clib_error_return_unix (0, "write");
2594 unix_cli_del_pending_output (uf, cf, n);
2596 return /* no error */ 0;
2599 /** Called when a CLI session file descriptor has data to be read. */
2600 static clib_error_t *
2601 unix_cli_read_ready (clib_file_t * uf)
2603 unix_main_t *um = &unix_main;
2604 unix_cli_main_t *cm = &unix_cli_main;
2605 unix_cli_file_t *cf;
2607 int n, n_read, n_try;
2609 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2614 l = vec_len (cf->input_vector);
2615 vec_resize (cf->input_vector, l + n_try);
2617 n = read (uf->file_descriptor, cf->input_vector + l, n_try);
2620 if (n < 0 && errno != EAGAIN)
2621 return clib_error_return_unix (0, "read");
2623 n_read = n < 0 ? 0 : n;
2624 _vec_len (cf->input_vector) = l + n_read;
2628 vlib_process_signal_event (um->vlib_main,
2629 cf->process_node_index,
2631 ? UNIX_CLI_PROCESS_EVENT_QUIT
2632 : UNIX_CLI_PROCESS_EVENT_READ_READY),
2633 /* event data */ uf->private_data);
2635 return /* no error */ 0;
2638 /** Called when a CLI session file descriptor has an error condition. */
2639 static clib_error_t *
2640 unix_cli_error_detected (clib_file_t * uf)
2642 unix_main_t *um = &unix_main;
2643 unix_cli_main_t *cm = &unix_cli_main;
2644 unix_cli_file_t *cf;
2646 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2647 cf->has_epipe = 1; /* prevent writes while the close is pending */
2648 vlib_process_signal_event (um->vlib_main,
2649 cf->process_node_index,
2650 UNIX_CLI_PROCESS_EVENT_QUIT,
2651 /* event data */ uf->private_data);
2653 return /* no error */ 0;
2656 /** Store a new CLI session.
2657 * @param name The name of the session.
2658 * @param fd The file descriptor for the session I/O.
2659 * @return The session ID.
2662 unix_cli_file_add (unix_cli_main_t * cm, char *name, int fd)
2664 unix_main_t *um = &unix_main;
2665 clib_file_main_t *fm = &file_main;
2666 unix_cli_file_t *cf;
2667 clib_file_t template = { 0 };
2668 vlib_main_t *vm = um->vlib_main;
2672 file_desc = format (0, "%s", name);
2674 name = (char *) format (0, "unix-cli-%s", name);
2676 if (vec_len (cm->unused_cli_process_node_indices) > 0)
2678 uword l = vec_len (cm->unused_cli_process_node_indices);
2680 /* Find node and give it new name. */
2681 n = vlib_get_node (vm, cm->unused_cli_process_node_indices[l - 1]);
2683 n->name = (u8 *) name;
2685 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
2687 _vec_len (cm->unused_cli_process_node_indices) = l - 1;
2691 static vlib_node_registration_t r = {
2692 .function = unix_cli_process,
2693 .type = VLIB_NODE_TYPE_PROCESS,
2694 .process_log2_n_stack_bytes = 16,
2698 vlib_register_node (vm, &r);
2701 n = vlib_get_node (vm, r.index);
2704 pool_get (cm->cli_file_pool, cf);
2705 memset (cf, 0, sizeof (*cf));
2707 template.read_function = unix_cli_read_ready;
2708 template.write_function = unix_cli_write_ready;
2709 template.error_function = unix_cli_error_detected;
2710 template.file_descriptor = fd;
2711 template.private_data = cf - cm->cli_file_pool;
2712 template.description = file_desc;
2714 cf->process_node_index = n->index;
2715 cf->clib_file_index = clib_file_add (fm, &template);
2716 cf->output_vector = 0;
2717 cf->input_vector = 0;
2719 vlib_start_process (vm, n->runtime_index);
2721 vlib_process_t *p = vlib_get_process_from_node (vm, n);
2722 p->output_function = unix_vlib_cli_output;
2723 p->output_function_arg = cf - cm->cli_file_pool;
2725 return cf - cm->cli_file_pool;
2728 /** Telnet listening socket has a new connection. */
2729 static clib_error_t *
2730 unix_cli_listen_read_ready (clib_file_t * uf)
2732 unix_main_t *um = &unix_main;
2733 clib_file_main_t *fm = &file_main;
2734 unix_cli_main_t *cm = &unix_cli_main;
2735 clib_socket_t *s = &um->cli_listen_socket;
2736 clib_socket_t client;
2738 clib_error_t *error;
2739 unix_cli_file_t *cf;
2742 error = clib_socket_accept (s, &client);
2746 client_name = (char *) format (0, "%U%c", format_sockaddr, &client.peer, 0);
2748 cf_index = unix_cli_file_add (cm, client_name, client.fd);
2749 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2752 /* No longer need CLIB version of socket. */
2753 clib_socket_free (&client);
2754 vec_free (client_name);
2756 /* if we're supposed to run telnet session in character mode (default) */
2757 if (um->cli_line_mode == 0)
2760 * Set telnet client character mode, echo on, suppress "go-ahead".
2761 * Technically these should be negotiated, but this works.
2763 u8 charmode_option[] = {
2764 IAC, WONT, TELOPT_LINEMODE, /* server will do char-by-char */
2765 IAC, DONT, TELOPT_LINEMODE, /* client should do char-by-char */
2766 IAC, WILL, TELOPT_SGA, /* server willl supress GA */
2767 IAC, DO, TELOPT_SGA, /* client should supress Go Ahead */
2768 IAC, WILL, TELOPT_ECHO, /* server will do echo */
2769 IAC, DONT, TELOPT_ECHO, /* client should not echo */
2770 IAC, DO, TELOPT_TTYPE, /* client should tell us its term type */
2771 IAC, SB, TELOPT_TTYPE, 1, IAC, SE, /* now tell me ttype */
2772 IAC, DO, TELOPT_NAWS, /* client should tell us its window sz */
2773 IAC, SB, TELOPT_NAWS, 1, IAC, SE, /* now tell me window size */
2776 /* Enable history on this CLI */
2777 cf->history_limit = um->cli_history_limit;
2778 cf->has_history = cf->history_limit != 0;
2780 /* This is an interactive session until we decide otherwise */
2781 cf->is_interactive = 1;
2783 /* Make sure this session is in line mode */
2789 /* Setup the pager */
2790 cf->no_pager = um->cli_no_pager;
2792 /* Default terminal dimensions, should the terminal
2793 * fail to provide any.
2795 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
2796 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
2798 /* Send the telnet options */
2799 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2800 unix_vlib_cli_output_raw (cf, uf, charmode_option,
2801 ARRAY_LEN (charmode_option));
2803 /* In case the client doesn't negotiate terminal type, use
2804 * a timer to kick off the initial prompt. */
2805 timer_call (unix_cli_file_welcome_timer, cf_index, 1);
2811 /** The system terminal has informed us that the window size
2815 unix_cli_resize_interrupt (int signum)
2817 clib_file_main_t *fm = &file_main;
2818 unix_cli_main_t *cm = &unix_cli_main;
2819 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
2820 cm->stdin_cli_file_index);
2821 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2825 /* Terminal resized, fetch the new size */
2826 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) < 0)
2828 /* "Should never happen..." */
2829 clib_unix_warning ("TIOCGWINSZ");
2830 /* We can't trust ws.XXX... */
2834 cf->width = ws.ws_col;
2835 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
2836 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
2838 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
2840 cf->height = ws.ws_row;
2841 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
2842 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
2843 if (cf->height == 0)
2844 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
2846 /* Reindex the pager buffer */
2847 unix_cli_pager_reindex (cf);
2849 /* Redraw the page */
2850 unix_cli_pager_redraw (cf, uf);
2853 /** Handle configuration directives in the @em unix section. */
2854 static clib_error_t *
2855 unix_cli_config (vlib_main_t * vm, unformat_input_t * input)
2857 unix_main_t *um = &unix_main;
2858 clib_file_main_t *fm = &file_main;
2859 unix_cli_main_t *cm = &unix_cli_main;
2861 clib_error_t *error = 0;
2862 unix_cli_file_t *cf;
2865 struct sigaction sa;
2869 /* We depend on unix flags being set. */
2870 if ((error = vlib_call_config_function (vm, unix_config)))
2873 if (um->flags & UNIX_FLAG_INTERACTIVE)
2875 /* Set stdin to be non-blocking. */
2876 if ((flags = fcntl (STDIN_FILENO, F_GETFL, 0)) < 0)
2878 (void) fcntl (STDIN_FILENO, F_SETFL, flags | O_NONBLOCK);
2880 cf_index = unix_cli_file_add (cm, "stdin", STDIN_FILENO);
2881 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2882 cm->stdin_cli_file_index = cf_index;
2884 /* If stdin is a tty and we are using chacracter mode, enable
2885 * history on the CLI and set the tty line discipline accordingly. */
2886 if (isatty (STDIN_FILENO) && um->cli_line_mode == 0)
2888 /* Capture terminal resize events */
2889 memset (&sa, 0, sizeof (sa));
2890 sa.sa_handler = unix_cli_resize_interrupt;
2891 if (sigaction (SIGWINCH, &sa, 0) < 0)
2892 clib_panic ("sigaction");
2894 /* Retrieve the current terminal size */
2895 ioctl (STDIN_FILENO, TIOCGWINSZ, &ws);
2896 cf->width = ws.ws_col;
2897 cf->height = ws.ws_row;
2899 if (cf->width == 0 || cf->height == 0)
2902 * We have a tty, but no size. Use defaults.
2903 * vpp "unix interactive" inside emacs + gdb ends up here.
2905 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
2906 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
2909 /* Setup the history */
2910 cf->history_limit = um->cli_history_limit;
2911 cf->has_history = cf->history_limit != 0;
2913 /* Setup the pager */
2914 cf->no_pager = um->cli_no_pager;
2916 /* This is an interactive session until we decide otherwise */
2917 cf->is_interactive = 1;
2919 /* We're going to be in char by char mode */
2922 /* Save the original tty state so we can restore it later */
2923 tcgetattr (STDIN_FILENO, &um->tio_stdin);
2926 /* Tweak the tty settings */
2927 tio = um->tio_stdin;
2928 /* echo off, canonical mode off, ext'd input processing off */
2929 tio.c_lflag &= ~(ECHO | ICANON | IEXTEN);
2930 /* disable XON/XOFF, so ^S invokes the history search */
2931 tio.c_iflag &= ~(IXON | IXOFF);
2932 tio.c_cc[VMIN] = 1; /* 1 byte at a time */
2933 tio.c_cc[VTIME] = 0; /* no timer */
2934 tio.c_cc[VSTOP] = _POSIX_VDISABLE; /* not ^S */
2935 tio.c_cc[VSTART] = _POSIX_VDISABLE; /* not ^Q */
2936 tcsetattr (STDIN_FILENO, TCSAFLUSH, &tio);
2938 /* See if we can do ANSI/VT100 output */
2939 term = (u8 *) getenv ("TERM");
2942 int len = strlen ((char *) term);
2943 cf->ansi_capable = unix_cli_terminal_type_ansi (term, len);
2944 if (unix_cli_terminal_type_noninteractive (term, len))
2945 unix_cli_set_session_noninteractive (cf);
2950 /* No tty, so make sure the session doesn't have tty-like features */
2951 unix_cli_set_session_noninteractive (cf);
2954 /* Send banner and initial prompt */
2955 unix_cli_file_welcome (cm, cf);
2958 /* If we have socket config, LISTEN, otherwise, don't */
2959 clib_socket_t *s = &um->cli_listen_socket;
2960 if (s->config && s->config[0] != 0)
2963 clib_file_t template = { 0 };
2965 /* mkdir of file socketu, only under /run */
2966 if (strncmp (s->config, "/run", 4) == 0)
2968 u8 *tmp = format (0, "%s", s->config);
2969 int i = vec_len (tmp);
2970 while (i && tmp[--i] != '/')
2976 vlib_unix_recursive_mkdir ((char *) tmp);
2980 s->flags = CLIB_SOCKET_F_IS_SERVER | /* listen, don't connect */
2981 CLIB_SOCKET_F_ALLOW_GROUP_WRITE; /* PF_LOCAL socket only */
2982 error = clib_socket_init (s);
2987 template.read_function = unix_cli_listen_read_ready;
2988 template.file_descriptor = s->fd;
2989 template.description = format (0, "cli listener %s", s->config);
2991 clib_file_add (fm, &template);
2994 /* Set CLI prompt. */
2995 if (!cm->cli_prompt)
2996 cm->cli_prompt = format (0, "VLIB: ");
3002 * This module has no configurable parameters.
3004 VLIB_CONFIG_FUNCTION (unix_cli_config, "unix-cli");
3006 /** Called when VPP is shutting down, this restores the system
3007 * terminal state if previously saved.
3009 static clib_error_t *
3010 unix_cli_exit (vlib_main_t * vm)
3012 unix_main_t *um = &unix_main;
3014 /* If stdin is a tty and we saved the tty state, reset the tty state */
3015 if (isatty (STDIN_FILENO) && um->tio_isset)
3016 tcsetattr (STDIN_FILENO, TCSAFLUSH, &um->tio_stdin);
3021 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_cli_exit);
3023 /** Set the CLI prompt.
3024 * @param prompt The C string to set the prompt to.
3025 * @note This setting is global; it impacts all current
3026 * and future CLI sessions.
3029 vlib_unix_cli_set_prompt (char *prompt)
3031 char *fmt = (prompt[strlen (prompt) - 1] == ' ') ? "%s" : "%s ";
3032 unix_cli_main_t *cm = &unix_cli_main;
3034 vec_free (cm->cli_prompt);
3035 cm->cli_prompt = format (0, fmt, prompt);
3038 /** CLI command to quit the terminal session.
3039 * @note If this is a stdin session then this will
3040 * shutdown VPP also.
3042 static clib_error_t *
3043 unix_cli_quit (vlib_main_t * vm,
3044 unformat_input_t * input, vlib_cli_command_t * cmd)
3046 unix_cli_main_t *cm = &unix_cli_main;
3047 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
3048 cm->current_input_file_index);
3050 /* Cosmetic: suppress the final prompt from appearing before we die */
3051 cf->is_interactive = 0;
3054 vlib_process_signal_event (vm,
3055 vlib_current_process (vm),
3056 UNIX_CLI_PROCESS_EVENT_QUIT,
3057 cm->current_input_file_index);
3062 * Terminates the current CLI session.
3064 * If VPP is running in @em interactive mode and this is the console session
3065 * (that is, the session on @c stdin) then this will also terminate VPP.
3068 VLIB_CLI_COMMAND (unix_cli_quit_command, static) = {
3070 .short_help = "Exit CLI",
3071 .function = unix_cli_quit,
3076 VLIB_CLI_COMMAND (unix_cli_q_command, static) = {
3078 .short_help = "Exit CLI",
3079 .function = unix_cli_quit,
3083 /** CLI command to execute a VPP command script. */
3084 static clib_error_t *
3085 unix_cli_exec (vlib_main_t * vm,
3086 unformat_input_t * input, vlib_cli_command_t * cmd)
3090 unformat_input_t sub_input;
3091 clib_error_t *error;
3097 if (!unformat (input, "%s", &file_name))
3099 error = clib_error_return (0, "expecting file name, got `%U'",
3100 format_unformat_error, input);
3104 fd = open (file_name, O_RDONLY);
3107 error = clib_error_return_unix (0, "failed to open `%s'", file_name);
3111 /* Make sure its a regular file. */
3115 if (fstat (fd, &s) < 0)
3117 error = clib_error_return_unix (0, "failed to stat `%s'", file_name);
3121 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
3123 error = clib_error_return (0, "not a regular file `%s'", file_name);
3128 unformat_init_clib_file (&sub_input, fd);
3130 vlib_cli_input (vm, &sub_input, 0, 0);
3131 unformat_free (&sub_input);
3136 vec_free (file_name);
3142 * Executes a sequence of CLI commands which are read from a file. If
3143 * a command is unrecognised or otherwise invalid then the usual CLI
3144 * feedback will be generated, however execution of subsequent commands
3145 * from the file will continue.
3147 * The VPP code is indifferent to the file location. However, if SELinux
3148 * is enabled, then the file needs to have an SELinux label the VPP
3149 * process is allowed to access. For example, if a file is created in
3150 * '<em>/usr/share/vpp/</em>', it will be allowed. However, files manually
3151 * created in '/tmp/' or '/home/<user>/' will not be accessible by the VPP
3152 * process when SELinux is enabled.
3157 * <b><em>$ cat /usr/share/vpp/scripts/gigup.txt</em></b>
3158 * set interface state GigabitEthernet0/8/0 up
3159 * set interface state GigabitEthernet0/9/0 up
3161 * Example of how to execute a set of CLI commands from a file:
3162 * @cliexcmd{exec /usr/share/vpp/scripts/gigup.txt}
3165 VLIB_CLI_COMMAND (cli_exec, static) = {
3167 .short_help = "exec <filename>",
3168 .function = unix_cli_exec,
3173 /** CLI command to show various unix error statistics. */
3174 static clib_error_t *
3175 unix_show_errors (vlib_main_t * vm,
3176 unformat_input_t * input, vlib_cli_command_t * cmd)
3178 unix_main_t *um = &unix_main;
3179 clib_error_t *error = 0;
3180 int i, n_errors_to_show;
3181 unix_error_history_t *unix_errors = 0;
3183 n_errors_to_show = 1 << 30;
3185 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3187 if (!unformat (input, "%d", &n_errors_to_show))
3190 clib_error_return (0,
3191 "expecting integer number of errors to show, got `%U'",
3192 format_unformat_error, input);
3198 clib_min (ARRAY_LEN (um->error_history), n_errors_to_show);
3201 um->error_history_index >
3202 0 ? um->error_history_index - 1 : ARRAY_LEN (um->error_history) - 1;
3204 while (n_errors_to_show > 0)
3206 unix_error_history_t *eh = um->error_history + i;
3211 vec_add1 (unix_errors, eh[0]);
3212 n_errors_to_show -= 1;
3214 i = ARRAY_LEN (um->error_history) - 1;
3219 if (vec_len (unix_errors) == 0)
3220 vlib_cli_output (vm, "no Unix errors so far");
3223 vlib_cli_output (vm, "%Ld total errors seen", um->n_total_errors);
3224 for (i = vec_len (unix_errors) - 1; i >= 0; i--)
3226 unix_error_history_t *eh = vec_elt_at_index (unix_errors, i);
3227 vlib_cli_output (vm, "%U: %U",
3228 format_time_interval, "h:m:s:u", eh->time,
3229 format_clib_error, eh->error);
3231 vlib_cli_output (vm, "%U: time now",
3232 format_time_interval, "h:m:s:u", vlib_time_now (vm));
3236 vec_free (unix_errors);
3241 VLIB_CLI_COMMAND (cli_unix_show_errors, static) = {
3242 .path = "show unix errors",
3243 .short_help = "Show Unix system call error history",
3244 .function = unix_show_errors,
3248 /** CLI command to show various unix error statistics. */
3249 static clib_error_t *
3250 unix_show_files (vlib_main_t * vm,
3251 unformat_input_t * input, vlib_cli_command_t * cmd)
3253 clib_error_t *error = 0;
3254 clib_file_main_t *fm = &file_main;
3256 char path[PATH_MAX];
3259 vlib_cli_output (vm, "%3s %6s %12s %12s %12s %-32s %s", "FD", "Thread",
3260 "Read", "Write", "Error", "File Name", "Description");
3263 pool_foreach (f, fm->file_pool,(
3266 s = format (s, "/proc/self/fd/%d%c", f->file_descriptor, 0);
3267 rv = readlink((char *) s, path, PATH_MAX - 1);
3269 path[rv < 0 ? 0 : rv] = 0;
3271 vlib_cli_output (vm, "%3d %6d %12d %12d %12d %-32s %v",
3272 f->file_descriptor, f->polling_thread_index,
3273 f->read_events, f->write_events, f->error_events,
3274 path, f->description);
3275 vec_reset_length (s);
3284 VLIB_CLI_COMMAND (cli_unix_show_files, static) = {
3285 .path = "show unix files",
3286 .short_help = "Show Unix files in use",
3287 .function = unix_show_files,
3291 /** CLI command to show session command history. */
3292 static clib_error_t *
3293 unix_cli_show_history (vlib_main_t * vm,
3294 unformat_input_t * input, vlib_cli_command_t * cmd)
3296 unix_cli_main_t *cm = &unix_cli_main;
3297 unix_cli_file_t *cf;
3300 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3302 if (!cf->is_interactive)
3303 return clib_error_return (0, "invalid for non-interactive sessions");
3305 if (cf->has_history && cf->history_limit)
3307 i = 1 + cf->command_number - vec_len (cf->command_history);
3308 for (j = 0; j < vec_len (cf->command_history); j++)
3309 vlib_cli_output (vm, "%d %v\n", i + j, cf->command_history[j]);
3313 vlib_cli_output (vm, "History not enabled.\n");
3320 * Displays the command history for the current session, if any.
3323 VLIB_CLI_COMMAND (cli_unix_cli_show_history, static) = {
3325 .short_help = "Show current session command history",
3326 .function = unix_cli_show_history,
3330 /** CLI command to show terminal status. */
3331 static clib_error_t *
3332 unix_cli_show_terminal (vlib_main_t * vm,
3333 unformat_input_t * input, vlib_cli_command_t * cmd)
3335 unix_main_t *um = &unix_main;
3336 unix_cli_main_t *cm = &unix_cli_main;
3337 unix_cli_file_t *cf;
3340 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3341 n = vlib_get_node (vm, cf->process_node_index);
3343 vlib_cli_output (vm, "Terminal name: %v\n", n->name);
3344 vlib_cli_output (vm, "Terminal mode: %s\n", cf->line_mode ?
3345 "line-by-line" : "char-by-char");
3346 vlib_cli_output (vm, "Terminal width: %d\n", cf->width);
3347 vlib_cli_output (vm, "Terminal height: %d\n", cf->height);
3348 vlib_cli_output (vm, "ANSI capable: %s\n",
3349 cf->ansi_capable ? "yes" : "no");
3350 vlib_cli_output (vm, "Interactive: %s\n",
3351 cf->is_interactive ? "yes" : "no");
3352 vlib_cli_output (vm, "History enabled: %s%s\n",
3353 cf->has_history ? "yes" : "no", !cf->has_history
3354 || cf->history_limit ? "" :
3355 " (disabled by history limit)");
3356 if (cf->has_history)
3357 vlib_cli_output (vm, "History limit: %d\n", cf->history_limit);
3358 vlib_cli_output (vm, "Pager enabled: %s%s%s\n",
3359 cf->no_pager ? "no" : "yes",
3361 || cf->height ? "" : " (disabled by terminal height)",
3363 || um->cli_pager_buffer_limit ? "" :
3364 " (disabled by buffer limit)");
3366 vlib_cli_output (vm, "Pager limit: %d\n", um->cli_pager_buffer_limit);
3367 vlib_cli_output (vm, "CRLF mode: %s\n",
3368 cf->crlf_mode ? "CR+LF" : "LF");
3374 * Displays various information about the state of the current terminal
3378 * @cliexstart{show terminal}
3379 * Terminal name: unix-cli-stdin
3380 * Terminal mode: char-by-char
3381 * Terminal width: 123
3382 * Terminal height: 48
3385 * History enabled: yes
3387 * Pager enabled: yes
3388 * Pager limit: 100000
3393 VLIB_CLI_COMMAND (cli_unix_cli_show_terminal, static) = {
3394 .path = "show terminal",
3395 .short_help = "Show current session terminal settings",
3396 .function = unix_cli_show_terminal,
3400 /** CLI command to display a list of CLI sessions. */
3401 static clib_error_t *
3402 unix_cli_show_cli_sessions (vlib_main_t * vm,
3403 unformat_input_t * input,
3404 vlib_cli_command_t * cmd)
3406 unix_cli_main_t *cm = &unix_cli_main;
3407 clib_file_main_t *fm = &file_main;
3408 unix_cli_file_t *cf;
3412 vlib_cli_output (vm, "%-5s %-5s %-20s %s", "PNI", "FD", "Name", "Flags");
3414 #define fl(x, y) ( (x) ? toupper((y)) : tolower((y)) )
3416 pool_foreach (cf, cm->cli_file_pool, ({
3417 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3418 n = vlib_get_node (vm, cf->process_node_index);
3419 vlib_cli_output (vm,
3420 "%-5d %-5d %-20v %c%c%c%c%c\n",
3421 cf->process_node_index,
3422 uf->file_descriptor,
3424 fl (cf->is_interactive, 'i'),
3425 fl (cf->is_socket, 's'),
3426 fl (cf->line_mode, 'l'),
3427 fl (cf->has_epipe, 'p'),
3428 fl (cf->ansi_capable, 'a'));
3437 * Displays a summary of all the current CLI sessions.
3439 * Typically used to diagnose connection issues with the CLI
3443 * @cliexstart{show cli-sessions}
3445 * 343 0 unix-cli-stdin IslpA
3446 * 344 7 unix-cli-local:20 ISlpA
3447 * 346 8 unix-cli-local:21 iSLpa
3450 * In this example we have the debug console of the running process
3451 * on stdin/out, we have an interactive socket session and we also
3452 * have a non-interactive socket session.
3456 * - @em PNI: Process node index.
3457 * - @em FD: Unix file descriptor.
3458 * - @em Name: Name of the session.
3459 * - @em Flags: Various flags that describe the state of the session.
3461 * @em Flags have the following meanings; lower-case typically negates
3464 * - @em I Interactive session.
3465 * - @em S Connected by socket.
3466 * - @em s Not a socket, likely stdin.
3467 * - @em L Line-by-line mode.
3468 * - @em l Char-by-char mode.
3469 * - @em P EPIPE detected on connection; it will close soon.
3470 * - @em A ANSI-capable terminal.
3473 VLIB_CLI_COMMAND (cli_unix_cli_show_cli_sessions, static) = {
3474 .path = "show cli-sessions",
3475 .short_help = "Show current CLI sessions",
3476 .function = unix_cli_show_cli_sessions,
3480 /** CLI command to set terminal pager settings. */
3481 static clib_error_t *
3482 unix_cli_set_terminal_pager (vlib_main_t * vm,
3483 unformat_input_t * input,
3484 vlib_cli_command_t * cmd)
3486 unix_main_t *um = &unix_main;
3487 unix_cli_main_t *cm = &unix_cli_main;
3488 unix_cli_file_t *cf;
3489 unformat_input_t _line_input, *line_input = &_line_input;
3490 clib_error_t *error = 0;
3492 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3494 if (!cf->is_interactive)
3495 return clib_error_return (0, "invalid for non-interactive sessions");
3497 if (!unformat_user (input, unformat_line_input, line_input))
3500 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3502 if (unformat (line_input, "on"))
3504 else if (unformat (line_input, "off"))
3506 else if (unformat (line_input, "limit %u", &um->cli_pager_buffer_limit))
3507 vlib_cli_output (vm,
3508 "Pager limit set to %u lines; note, this is global.\n",
3509 um->cli_pager_buffer_limit);
3512 error = clib_error_return (0, "unknown parameter: `%U`",
3513 format_unformat_error, line_input);
3519 unformat_free (line_input);
3525 * Enables or disables the terminal pager for this session. Generally
3526 * this defaults to enabled.
3528 * Additionally allows the pager buffer size to be set; though note that
3529 * this value is set globally and not per session.
3532 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager, static) = {
3533 .path = "set terminal pager",
3534 .short_help = "set terminal pager [on|off] [limit <lines>]",
3535 .function = unix_cli_set_terminal_pager,
3539 /** CLI command to set terminal history settings. */
3540 static clib_error_t *
3541 unix_cli_set_terminal_history (vlib_main_t * vm,
3542 unformat_input_t * input,
3543 vlib_cli_command_t * cmd)
3545 unix_cli_main_t *cm = &unix_cli_main;
3546 unix_cli_file_t *cf;
3547 unformat_input_t _line_input, *line_input = &_line_input;
3549 clib_error_t *error = 0;
3551 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3553 if (!cf->is_interactive)
3554 return clib_error_return (0, "invalid for non-interactive sessions");
3556 if (!unformat_user (input, unformat_line_input, line_input))
3559 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3561 if (unformat (line_input, "on"))
3562 cf->has_history = 1;
3563 else if (unformat (line_input, "off"))
3564 cf->has_history = 0;
3565 else if (unformat (line_input, "limit %u", &cf->history_limit))
3569 error = clib_error_return (0, "unknown parameter: `%U`",
3570 format_unformat_error, line_input);
3574 /* If we reduced history size, or turned it off, purge the history */
3575 limit = cf->has_history ? cf->history_limit : 0;
3577 while (cf->command_history && vec_len (cf->command_history) >= limit)
3579 vec_free (cf->command_history[0]);
3580 vec_delete (cf->command_history, 1, 0);
3585 unformat_free (line_input);
3591 * Enables or disables the command history function of the current
3592 * terminal. Generally this defaults to enabled.
3594 * This command also allows the maximum size of the history buffer for
3595 * this session to be altered.
3598 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history, static) = {
3599 .path = "set terminal history",
3600 .short_help = "set terminal history [on|off] [limit <lines>]",
3601 .function = unix_cli_set_terminal_history,
3605 /** CLI command to set terminal ANSI settings. */
3606 static clib_error_t *
3607 unix_cli_set_terminal_ansi (vlib_main_t * vm,
3608 unformat_input_t * input,
3609 vlib_cli_command_t * cmd)
3611 unix_cli_main_t *cm = &unix_cli_main;
3612 unix_cli_file_t *cf;
3614 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3616 if (!cf->is_interactive)
3617 return clib_error_return (0, "invalid for non-interactive sessions");
3619 if (unformat (input, "on"))
3620 cf->ansi_capable = 1;
3621 else if (unformat (input, "off"))
3622 cf->ansi_capable = 0;
3624 return clib_error_return (0, "unknown parameter: `%U`",
3625 format_unformat_error, input);
3631 * Enables or disables the use of ANSI control sequences by this terminal.
3632 * The default will vary based on terminal detection at the start of the
3635 * ANSI control sequences are used in a small number of places to provide,
3636 * for example, color text output and to control the cursor in the pager.
3639 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi, static) = {
3640 .path = "set terminal ansi",
3641 .short_help = "set terminal ansi [on|off]",
3642 .function = unix_cli_set_terminal_ansi,
3646 static clib_error_t *
3647 unix_cli_init (vlib_main_t * vm)
3652 VLIB_INIT_FUNCTION (unix_cli_init);
3655 * fd.io coding-style-patch-verification: ON
3658 * eval: (c-set-style "gnu")