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>
63 #include <netinet/tcp.h>
65 /** ANSI escape code. */
68 /** ANSI Control Sequence Introducer. */
71 /** ANSI clear screen. */
72 #define ANSI_CLEAR CSI "2J" CSI "1;1H"
73 /** ANSI reset color settings. */
74 #define ANSI_RESET CSI "0m"
75 /** ANSI Start bold text. */
76 #define ANSI_BOLD CSI "1m"
77 /** ANSI Stop bold text. */
78 #define ANSI_DIM CSI "2m"
79 /** ANSI Start dark red text. */
80 #define ANSI_DRED ANSI_DIM CSI "31m"
81 /** ANSI Start bright red text. */
82 #define ANSI_BRED ANSI_BOLD CSI "31m"
83 /** ANSI clear line cursor is on. */
84 #define ANSI_CLEARLINE CSI "2K"
85 /** ANSI scroll screen down one line. */
86 #define ANSI_SCROLLDN CSI "1T"
87 /** ANSI save cursor position. */
88 #define ANSI_SAVECURSOR CSI "s"
89 /** ANSI restore cursor position if previously saved. */
90 #define ANSI_RESTCURSOR CSI "u"
92 /** Maximum depth into a byte stream from which to compile a Telnet
93 * protocol message. This is a safety measure. */
94 #define UNIX_CLI_MAX_DEPTH_TELNET 24
96 /** Maximum terminal width we will accept */
97 #define UNIX_CLI_MAX_TERMINAL_WIDTH 512
98 /** Maximum terminal height we will accept */
99 #define UNIX_CLI_MAX_TERMINAL_HEIGHT 512
100 /** Default terminal height */
101 #define UNIX_CLI_DEFAULT_TERMINAL_HEIGHT 24
102 /** Default terminal width */
103 #define UNIX_CLI_DEFAULT_TERMINAL_WIDTH 80
105 /** A CLI banner line. */
108 u8 *line; /**< The line to print. */
109 u32 length; /**< The length of the line without terminating NUL. */
112 #define _(a) { .line = (u8 *)(a), .length = sizeof(a) - 1 }
113 /** Plain welcome banner. */
114 static unix_cli_banner_t unix_cli_banner[] = {
115 _(" _______ _ _ _____ ___ \n"),
116 _(" __/ __/ _ \\ (_)__ | | / / _ \\/ _ \\\n"),
117 _(" _/ _// // / / / _ \\ | |/ / ___/ ___/\n"),
118 _(" /_/ /____(_)_/\\___/ |___/_/ /_/ \n"),
122 /** ANSI color welcome banner. */
123 static unix_cli_banner_t unix_cli_banner_color[] = {
124 _(ANSI_BRED " _______ _ " ANSI_RESET " _ _____ ___ \n"),
125 _(ANSI_BRED " __/ __/ _ \\ (_)__ " ANSI_RESET " | | / / _ \\/ _ \\\n"),
126 _(ANSI_BRED " _/ _// // / / / _ \\" ANSI_RESET " | |/ / ___/ ___/\n"),
127 _(ANSI_BRED " /_/ /____(_)_/\\___/" ANSI_RESET " |___/_/ /_/ \n"),
133 /** Pager line index */
136 /** Index into pager_vector */
139 /** Offset of the string in the line */
142 /** Length of the string in the line */
144 } unix_cli_pager_index_t;
147 /** Unix CLI session. */
150 /** The file index held by unix.c */
153 /** Vector of output pending write to file descriptor. */
156 /** Vector of input saved by Unix input node to be processed by
160 /** This session has command history. */
162 /** Array of vectors of commands in the history. */
163 u8 **command_history;
164 /** The command currently pointed at by the history cursor. */
166 /** How far from the end of the history array the user has browsed. */
169 /** Maximum number of history entries this session will store. */
172 /** Current command line counter */
175 /** The string being searched for in the history. */
177 /** If non-zero then the CLI is searching in the history array.
178 * - @c -1 means search backwards.
179 * - @c 1 means search forwards.
183 /** Position of the insert cursor on the current input line */
186 /** Line mode or char mode */
189 /** Set if the CRLF mode wants CR + LF */
192 /** Can we do ANSI output? */
195 /** Has the session started? */
198 /** Disable the pager? */
201 /** Whether the session is interactive or not.
202 * Controls things like initial banner, the CLI prompt etc. */
205 /** Whether the session is attached to a socket. */
208 /** If EPIPE has been detected, prevent further write-related
209 * activity on the descriptor.
216 /** Index of line fragments in the pager buffer */
217 unix_cli_pager_index_t *pager_index;
219 /** Line number of top of page */
222 /** Terminal width */
225 /** Terminal height */
228 /** Process node identifier */
229 u32 process_node_index;
231 /** The current direction of cursor travel.
232 * This is important since when advancing left-to-right, at the
233 * right hand edge of the console the terminal typically defers
234 * wrapping the cursor to the next line until a character is
235 * actually displayed.
236 * This messes up our heuristic for whether to use ANSI to return
237 * the cursor to the end of the line and instead we have to
238 * nudge the cursor to the next line.
239 * A Value of @c 0 means we're advancing left-to-right; @c 1 means
246 /** Resets the pager buffer and other data.
247 * @param f The CLI session whose pager needs to be reset.
250 unix_cli_pager_reset (unix_cli_file_t * f)
256 vec_free (f->pager_index);
259 vec_foreach (p, f->pager_vector)
263 vec_free (f->pager_vector);
267 /** Release storage used by a CLI session.
268 * @param f The CLI session whose storage needs to be released.
271 unix_cli_file_free (unix_cli_file_t * f)
273 vec_free (f->output_vector);
274 vec_free (f->input_vector);
275 unix_cli_pager_reset (f);
281 UNIX_CLI_PARSE_ACTION_NOACTION = 0, /**< No action */
282 UNIX_CLI_PARSE_ACTION_CRLF, /**< Carriage return, newline or enter */
283 UNIX_CLI_PARSE_ACTION_TAB, /**< Tab key */
284 UNIX_CLI_PARSE_ACTION_ERASE, /**< Erase cursor left */
285 UNIX_CLI_PARSE_ACTION_ERASERIGHT, /**< Erase cursor right */
286 UNIX_CLI_PARSE_ACTION_UP, /**< Up arrow */
287 UNIX_CLI_PARSE_ACTION_DOWN, /**< Down arrow */
288 UNIX_CLI_PARSE_ACTION_LEFT, /**< Left arrow */
289 UNIX_CLI_PARSE_ACTION_RIGHT, /**< Right arrow */
290 UNIX_CLI_PARSE_ACTION_HOME, /**< Home key (jump to start of line) */
291 UNIX_CLI_PARSE_ACTION_END, /**< End key (jump to end of line) */
292 UNIX_CLI_PARSE_ACTION_WORDLEFT, /**< Jump cursor to start of left word */
293 UNIX_CLI_PARSE_ACTION_WORDRIGHT, /**< Jump cursor to start of right word */
294 UNIX_CLI_PARSE_ACTION_ERASELINELEFT, /**< Erase line to left of cursor */
295 UNIX_CLI_PARSE_ACTION_ERASELINERIGHT, /**< Erase line to right & including cursor */
296 UNIX_CLI_PARSE_ACTION_CLEAR, /**< Clear the terminal */
297 UNIX_CLI_PARSE_ACTION_REVSEARCH, /**< Search backwards in command history */
298 UNIX_CLI_PARSE_ACTION_FWDSEARCH, /**< Search forwards in command history */
299 UNIX_CLI_PARSE_ACTION_YANK, /**< Undo last erase action */
300 UNIX_CLI_PARSE_ACTION_TELNETIAC, /**< Telnet control code */
302 UNIX_CLI_PARSE_ACTION_PAGER_CRLF, /**< Enter pressed (CR, CRLF, LF, etc) */
303 UNIX_CLI_PARSE_ACTION_PAGER_QUIT, /**< Exit the pager session */
304 UNIX_CLI_PARSE_ACTION_PAGER_NEXT, /**< Scroll to next page */
305 UNIX_CLI_PARSE_ACTION_PAGER_DN, /**< Scroll to next line */
306 UNIX_CLI_PARSE_ACTION_PAGER_UP, /**< Scroll to previous line */
307 UNIX_CLI_PARSE_ACTION_PAGER_TOP, /**< Scroll to first line */
308 UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM, /**< Scroll to last line */
309 UNIX_CLI_PARSE_ACTION_PAGER_PGDN, /**< Scroll to next page */
310 UNIX_CLI_PARSE_ACTION_PAGER_PGUP, /**< Scroll to previous page */
311 UNIX_CLI_PARSE_ACTION_PAGER_REDRAW, /**< Clear and redraw the page on the terminal */
312 UNIX_CLI_PARSE_ACTION_PAGER_SEARCH, /**< Search the pager buffer */
314 UNIX_CLI_PARSE_ACTION_PARTIALMATCH, /**< Action parser found a partial match */
315 UNIX_CLI_PARSE_ACTION_NOMATCH /**< Action parser did not find any match */
316 } unix_cli_parse_action_t;
318 /** @brief Mapping of input buffer strings to action values.
319 * @note This won't work as a hash since we need to be able to do
320 * partial matches on the string.
324 u8 *input; /**< Input string to match. */
325 u32 len; /**< Length of input without final NUL. */
326 unix_cli_parse_action_t action; /**< Action to take when matched. */
327 } unix_cli_parse_actions_t;
329 /** @brief Given a capital ASCII letter character return a @c NUL terminated
330 * string with the control code for that letter.
332 * @param c An ASCII character.
333 * @return A @c NUL terminated string of type @c u8[].
336 * @c CTL('A') returns <code>{ 0x01, 0x00 }</code> as a @c u8[].
338 #define CTL(c) (u8[]){ (c) - '@', 0 }
340 #define _(a,b) { .input = (u8 *)(a), .len = sizeof(a) - 1, .action = (b) }
342 * Patterns to match on a CLI input stream.
345 static unix_cli_parse_actions_t unix_cli_parse_strings[] = {
347 _("\r\n", UNIX_CLI_PARSE_ACTION_CRLF), /* Must be before '\r' */
348 _("\n", UNIX_CLI_PARSE_ACTION_CRLF),
349 _("\r\0", UNIX_CLI_PARSE_ACTION_CRLF), /* Telnet does this */
350 _("\r", UNIX_CLI_PARSE_ACTION_CRLF),
352 /* Unix shell control codes */
353 _(CTL ('B'), UNIX_CLI_PARSE_ACTION_LEFT),
354 _(CTL ('F'), UNIX_CLI_PARSE_ACTION_RIGHT),
355 _(CTL ('P'), UNIX_CLI_PARSE_ACTION_UP),
356 _(CTL ('N'), UNIX_CLI_PARSE_ACTION_DOWN),
357 _(CTL ('A'), UNIX_CLI_PARSE_ACTION_HOME),
358 _(CTL ('E'), UNIX_CLI_PARSE_ACTION_END),
359 _(CTL ('D'), UNIX_CLI_PARSE_ACTION_ERASERIGHT),
360 _(CTL ('U'), UNIX_CLI_PARSE_ACTION_ERASELINELEFT),
361 _(CTL ('K'), UNIX_CLI_PARSE_ACTION_ERASELINERIGHT),
362 _(CTL ('Y'), UNIX_CLI_PARSE_ACTION_YANK),
363 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_CLEAR),
364 _(ESC "b", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* Alt-B */
365 _(ESC "f", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* Alt-F */
366 _("\b", UNIX_CLI_PARSE_ACTION_ERASE), /* ^H */
367 _("\x7f", UNIX_CLI_PARSE_ACTION_ERASE), /* Backspace */
368 _("\t", UNIX_CLI_PARSE_ACTION_TAB), /* ^I */
370 /* VT100 Normal mode - Broadest support */
371 _(CSI "A", UNIX_CLI_PARSE_ACTION_UP),
372 _(CSI "B", UNIX_CLI_PARSE_ACTION_DOWN),
373 _(CSI "C", UNIX_CLI_PARSE_ACTION_RIGHT),
374 _(CSI "D", UNIX_CLI_PARSE_ACTION_LEFT),
375 _(CSI "H", UNIX_CLI_PARSE_ACTION_HOME),
376 _(CSI "F", UNIX_CLI_PARSE_ACTION_END),
377 _(CSI "3~", UNIX_CLI_PARSE_ACTION_ERASERIGHT), /* Delete */
378 _(CSI "1;5D", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* C-Left */
379 _(CSI "1;5C", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* C-Right */
381 /* VT100 Application mode - Some Gnome Terminal functions use these */
382 _(ESC "OA", UNIX_CLI_PARSE_ACTION_UP),
383 _(ESC "OB", UNIX_CLI_PARSE_ACTION_DOWN),
384 _(ESC "OC", UNIX_CLI_PARSE_ACTION_RIGHT),
385 _(ESC "OD", UNIX_CLI_PARSE_ACTION_LEFT),
386 _(ESC "OH", UNIX_CLI_PARSE_ACTION_HOME),
387 _(ESC "OF", UNIX_CLI_PARSE_ACTION_END),
389 /* ANSI X3.41-1974 - sent by Microsoft Telnet and PuTTY */
390 _(CSI "1~", UNIX_CLI_PARSE_ACTION_HOME),
391 _(CSI "4~", UNIX_CLI_PARSE_ACTION_END),
393 /* Emacs-ish history search */
394 _(CTL ('S'), UNIX_CLI_PARSE_ACTION_FWDSEARCH),
395 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_REVSEARCH),
397 /* Other protocol things */
398 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
399 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
400 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
404 * Patterns to match when a CLI session is in the pager.
407 static unix_cli_parse_actions_t unix_cli_parse_pager[] = {
409 _("\r\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Must be before '\r' */
410 _("\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
411 _("\r\0", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Telnet does this */
412 _("\r", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
415 _(" ", UNIX_CLI_PARSE_ACTION_PAGER_NEXT),
416 _("q", UNIX_CLI_PARSE_ACTION_PAGER_QUIT),
417 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
418 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
419 _("/", UNIX_CLI_PARSE_ACTION_PAGER_SEARCH),
422 _(CSI "A", UNIX_CLI_PARSE_ACTION_PAGER_UP),
423 _(CSI "B", UNIX_CLI_PARSE_ACTION_PAGER_DN),
424 _(CSI "H", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
425 _(CSI "F", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
427 /* VT100 Application mode */
428 _(ESC "OA", UNIX_CLI_PARSE_ACTION_PAGER_UP),
429 _(ESC "OB", UNIX_CLI_PARSE_ACTION_PAGER_DN),
430 _(ESC "OH", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
431 _(ESC "OF", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
433 /* ANSI X3.41-1974 */
434 _(CSI "1~", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
435 _(CSI "4~", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
436 _(CSI "5~", UNIX_CLI_PARSE_ACTION_PAGER_PGUP),
437 _(CSI "6~", UNIX_CLI_PARSE_ACTION_PAGER_PGDN),
439 /* Other protocol things */
440 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
441 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
442 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
447 /** CLI session events. */
450 UNIX_CLI_PROCESS_EVENT_READ_READY, /**< A file descriptor has data to be read. */
451 UNIX_CLI_PROCESS_EVENT_QUIT, /**< A CLI session wants to close. */
452 } unix_cli_process_event_type_t;
454 /** CLI global state. */
457 /** Prompt string for CLI. */
460 /** Vec pool of CLI sessions. */
461 unix_cli_file_t *cli_file_pool;
463 /** Vec pool of unused session indices. */
464 u32 *unused_cli_process_node_indices;
466 /** The session index of the stdin cli */
467 u32 stdin_cli_file_index;
469 /** File pool index of current input. */
470 u32 current_input_file_index;
473 /** CLI global state */
474 static unix_cli_main_t unix_cli_main;
477 * @brief Search for a byte sequence in the action list.
479 * Searches the @ref unix_cli_parse_actions_t list in @a a for a match with
480 * the bytes in @a input of maximum length @a ilen bytes.
481 * When a match is made @a *matched indicates how many bytes were matched.
482 * Returns a value from the enum @ref unix_cli_parse_action_t to indicate
483 * whether no match was found, a partial match was found or a complete
484 * match was found and what action, if any, should be taken.
486 * @param[in] a Actions list to search within.
487 * @param[in] input String fragment to search for.
488 * @param[in] ilen Length of the string in 'input'.
489 * @param[out] matched Pointer to an integer that will contain the number
490 * of bytes matched when a complete match is found.
492 * @return Action from @ref unix_cli_parse_action_t that the string fragment
494 * @ref UNIX_CLI_PARSE_ACTION_PARTIALMATCH is returned when the
495 * whole input string matches the start of at least one action.
496 * @ref UNIX_CLI_PARSE_ACTION_NOMATCH is returned when there is no
499 static unix_cli_parse_action_t
500 unix_cli_match_action (unix_cli_parse_actions_t * a,
501 u8 * input, u32 ilen, i32 * matched)
509 /* see if the start of the input buffer exactly matches the current
511 if (memcmp (input, a->input, a->len) == 0)
519 /* if the first ilen characters match, flag this as a partial -
520 * meaning keep collecting bytes in case of a future match */
521 if (memcmp (input, a->input, ilen) == 0)
525 /* check next action */
530 UNIX_CLI_PARSE_ACTION_PARTIALMATCH : UNIX_CLI_PARSE_ACTION_NOMATCH;
534 /** Add bytes to the output vector and then flagg the I/O system that bytes
535 * are available to be sent.
538 unix_cli_add_pending_output (clib_file_t * uf,
539 unix_cli_file_t * cf,
540 u8 * buffer, uword buffer_bytes)
542 clib_file_main_t *fm = &file_main;
544 vec_add (cf->output_vector, buffer, buffer_bytes);
545 if (vec_len (cf->output_vector) > 0)
547 int skip_update = 0 != (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
548 uf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
550 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
554 /** Delete all bytes from the output vector and flag the I/O system
555 * that no more bytes are available to be sent.
558 unix_cli_del_pending_output (clib_file_t * uf,
559 unix_cli_file_t * cf, uword n_bytes)
561 clib_file_main_t *fm = &file_main;
563 vec_delete (cf->output_vector, n_bytes, 0);
564 if (vec_len (cf->output_vector) <= 0)
566 int skip_update = 0 == (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
567 uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
569 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
573 /** @brief A bit like strchr with a buffer length limit.
574 * Search a buffer for the first instance of a character up to the limit of
575 * the buffer length. If found then return the position of that character.
577 * The key departure from strchr is that if the character is not found then
578 * return the buffer length.
580 * @param chr The byte value to search for.
581 * @param str The buffer in which to search for the value.
582 * @param len The depth into the buffer to search.
584 * @return The index of the first occurrence of \c chr. If \c chr is not
585 * found then \c len instead.
588 unix_vlib_findchr (u8 chr, u8 * str, word len)
591 for (i = 0; i < len; i++, str++)
599 /** @brief Send a buffer to the CLI stream if possible, enqueue it otherwise.
600 * Attempts to write given buffer to the file descriptor of the given
601 * Unix CLI session. If that session already has data in the output buffer
602 * or if the write attempt tells us to try again later then the given buffer
603 * is appended to the pending output buffer instead.
605 * This is typically called only from \c unix_vlib_cli_output_cooked since
606 * that is where CRLF handling occurs or from places where we explicitly do
607 * not want cooked handling.
609 * @param cf Unix CLI session of the desired stream to write to.
610 * @param uf The Unix file structure of the desired stream to write to.
611 * @param buffer Pointer to the buffer that needs to be written.
612 * @param buffer_bytes The number of bytes from \c buffer to write.
615 unix_vlib_cli_output_raw (unix_cli_file_t * cf,
616 clib_file_t * uf, u8 * buffer, uword buffer_bytes)
620 if (cf->has_epipe) /* don't try writing anything */
623 if (vec_len (cf->output_vector) == 0)
626 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
627 n = send (uf->file_descriptor, buffer, buffer_bytes, MSG_NOSIGNAL);
629 n = write (uf->file_descriptor, buffer, buffer_bytes);
632 if (n < 0 && errno != EAGAIN)
636 /* connection closed on us */
637 unix_main_t *um = &unix_main;
639 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
640 UNIX_CLI_PROCESS_EVENT_QUIT,
645 clib_unix_warning ("write");
648 else if ((word) n < (word) buffer_bytes)
650 /* We got EAGAIN or we already have stuff in the buffer;
651 * queue up whatever didn't get sent for later. */
654 unix_cli_add_pending_output (uf, cf, buffer + n, buffer_bytes - n);
658 /** @brief Process a buffer for CRLF handling before outputting it to the CLI.
660 * @param cf Unix CLI session of the desired stream to write to.
661 * @param uf The Unix file structure of the desired stream to write to.
662 * @param buffer Pointer to the buffer that needs to be written.
663 * @param buffer_bytes The number of bytes from \c buffer to write.
666 unix_vlib_cli_output_cooked (unix_cli_file_t * cf,
668 u8 * buffer, uword buffer_bytes)
670 word end = 0, start = 0;
672 while (end < buffer_bytes)
676 /* iterate the line on \n's so we can insert a \r before it */
677 end = unix_vlib_findchr ('\n',
679 buffer_bytes - start) + start;
683 /* otherwise just send the whole buffer */
687 unix_vlib_cli_output_raw (cf, uf, buffer + start, end - start);
691 if (end < buffer_bytes)
693 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\r\n", 2);
694 end++; /* skip the \n that we already sent */
700 /* Use the last character to determine the last direction of the cursor. */
701 if (buffer_bytes > 0)
702 cf->cursor_direction = (buffer[buffer_bytes - 1] == (u8) '\b');
705 /** @brief Moves the terminal cursor one character to the left, with
706 * special handling when it reaches the left edge of the terminal window.
708 * Ordinarily we can simply send a '\b' to move the cursor left, however
709 * most terminals will not reverse-wrap to the end of the previous line
710 * if the cursor is in the left-most column. To counter this we must
711 * check the cursor position + prompt length modulo terminal width and
712 * if available use some other means, such as ANSI terminal escape
713 * sequences, to move the cursor.
715 * @param cf Unix CLI session of the desired stream to write to.
716 * @param uf The Unix file structure of the desired stream to write to.
719 unix_vlib_cli_output_cursor_left (unix_cli_file_t * cf, clib_file_t * uf)
721 unix_cli_main_t *cm = &unix_cli_main;
722 static u8 *ansi = 0; /* assumes no reentry */
725 if (!cf->is_interactive || !cf->ansi_capable || !cf->width)
727 /* No special handling for dumb terminals */
728 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
732 position = ((u32) vec_len (cm->cli_prompt) + cf->cursor) % cf->width;
736 /* No special handling required if we're not at the left edge */
737 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
741 if (!cf->cursor_direction)
743 /* Special handling for when we are at the left edge but
744 * the cursor was going left-to-right, but in this situation
745 * xterm-like terminals actually hide the cursor off the right
746 * edge. A \b here seems to jump one char too many, so let's
747 * force the cursor onto the next line instead.
749 if (cf->cursor < vec_len (cf->current_command))
750 unix_vlib_cli_output_cooked (cf, uf, &cf->current_command[cf->cursor],
753 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
754 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
757 /* Relocate the cursor at the right hand edge one line above */
758 ansi = format (ansi, CSI "A" CSI "%dC", cf->width - 1);
759 unix_vlib_cli_output_cooked (cf, uf, ansi, vec_len (ansi));
760 vec_reset_length (ansi); /* keep the vec around for next time */
761 cf->cursor_direction = 1; /* going backwards now */
764 /** @brief Output the CLI prompt */
766 unix_cli_cli_prompt (unix_cli_file_t * cf, clib_file_t * uf)
768 unix_cli_main_t *cm = &unix_cli_main;
770 if (cf->is_interactive) /* Only interactive sessions get a prompt */
771 unix_vlib_cli_output_raw (cf, uf, cm->cli_prompt,
772 vec_len (cm->cli_prompt));
775 /** @brief Output a pager prompt and show number of buffered lines */
777 unix_cli_pager_prompt (unix_cli_file_t * cf, clib_file_t * uf)
782 h = cf->pager_start + (cf->height - 1);
783 if (h > vec_len (cf->pager_index))
784 h = vec_len (cf->pager_index);
786 prompt = format (0, "\r%s-- more -- (%d-%d/%d)%s",
787 cf->ansi_capable ? ANSI_BOLD : "",
790 vec_len (cf->pager_index),
791 cf->ansi_capable ? ANSI_RESET : "");
793 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
798 /** @brief Output a pager "skipping" message */
800 unix_cli_pager_message (unix_cli_file_t * cf, clib_file_t * uf,
801 char *message, char *postfix)
805 prompt = format (0, "\r%s-- %s --%s%s",
806 cf->ansi_capable ? ANSI_BOLD : "",
807 message, cf->ansi_capable ? ANSI_RESET : "", postfix);
809 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
814 /** @brief Erase the printed pager prompt */
816 unix_cli_pager_prompt_erase (unix_cli_file_t * cf, clib_file_t * uf)
818 if (cf->ansi_capable)
820 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
821 unix_vlib_cli_output_cooked (cf, uf,
822 (u8 *) ANSI_CLEARLINE,
823 sizeof (ANSI_CLEARLINE) - 1);
829 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
830 for (i = 0; i < cf->width - 1; i++)
831 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
832 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
836 /** @brief Uses an ANSI escape sequence to move the cursor */
838 unix_cli_ansi_cursor (unix_cli_file_t * cf, clib_file_t * uf, u16 x, u16 y)
842 str = format (0, "%s%d;%dH", CSI, y, x);
844 unix_vlib_cli_output_cooked (cf, uf, str, vec_len (str));
849 /** Redraw the currently displayed page of text.
850 * @param cf CLI session to redraw the pager buffer of.
851 * @param uf Unix file of the CLI session.
854 unix_cli_pager_redraw (unix_cli_file_t * cf, clib_file_t * uf)
856 unix_cli_pager_index_t *pi = NULL;
860 /* No active pager? Do nothing. */
861 if (!vec_len (cf->pager_index))
864 if (cf->ansi_capable)
866 /* If we have ANSI, send the clear screen sequence */
867 unix_vlib_cli_output_cooked (cf, uf,
869 sizeof (ANSI_CLEAR) - 1);
873 /* Otherwise make sure we're on a blank line */
874 unix_cli_pager_prompt_erase (cf, uf);
877 /* (Re-)send the current page of content */
878 for (i = 0; i < cf->height - 1 &&
879 i + cf->pager_start < vec_len (cf->pager_index); i++)
881 pi = &cf->pager_index[cf->pager_start + i];
882 line = cf->pager_vector[pi->line] + pi->offset;
884 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
886 /* if the last line didn't end in newline, add a newline */
887 if (pi && line[pi->length - 1] != '\n')
888 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
890 unix_cli_pager_prompt (cf, uf);
893 /** @brief Process and add a line to the pager index.
894 * In normal operation this function will take the given character string
895 * found in @c line and with length @c len_or_index and iterates the over the
896 * contents, adding each line of text discovered within it to the
897 * pager index. Lines are identified by newlines ("<code>\\n</code>") and by
898 * strings longer than the width of the terminal.
900 * If instead @c line is @c NULL then @c len_or_index is taken to mean the
901 * index of an existing line in the pager buffer; this simply means that the
902 * input line does not need to be cloned since we already have it. This is
903 * typical if we are reindexing the pager buffer.
905 * @param cf The CLI session whose pager we are adding to.
906 * @param line The string of text to be indexed into the pager buffer.
907 * If @c line is @c NULL then the mode of operation
908 * changes slightly; see the description above.
909 * @param len_or_index If @c line is a pointer to a string then this parameter
910 * indicates the length of that string; Otherwise this
911 * value provides the index in the pager buffer of an
912 * existing string to be indexed.
915 unix_cli_pager_add_line (unix_cli_file_t * cf, u8 * line, word len_or_index)
919 word line_index, len;
920 u32 width = cf->width;
921 unix_cli_pager_index_t *pi;
925 /* Use a line already in the pager buffer */
926 line_index = len_or_index;
927 if (cf->pager_vector != NULL)
928 p = cf->pager_vector[line_index];
934 /* Add a copy of the raw string to the pager buffer */
935 p = vec_new (u8, len);
936 clib_memcpy (p, line, len);
938 /* store in pager buffer */
939 line_index = vec_len (cf->pager_vector);
940 vec_add1 (cf->pager_vector, p);
946 /* Find the next line, or run to terminal width, or run to EOL */
948 j = unix_vlib_findchr ((u8) '\n', p, l < width ? l : width);
950 if (j < l && p[j] == '\n') /* incl \n */
953 /* Add the line to the index */
954 k = vec_len (cf->pager_index);
955 vec_validate (cf->pager_index, k);
956 pi = &cf->pager_index[k];
958 pi->line = line_index;
967 /** @brief Reindex entire pager buffer.
968 * Resets the current pager index and then re-adds the lines in the pager
969 * buffer to the index.
971 * Additionally this function attempts to retain the current page start
972 * line offset by searching for the same top-of-screen line in the new index.
974 * @param cf The CLI session whose pager buffer should be reindexed.
977 unix_cli_pager_reindex (unix_cli_file_t * cf)
979 word i, old_line, old_offset;
980 unix_cli_pager_index_t *pi;
982 /* If there is nothing in the pager buffer then make sure the index
983 * is empty and move on.
985 if (cf->pager_vector == 0)
987 vec_reset_length (cf->pager_index);
991 /* Retain a pointer to the current page start line so we can
994 pi = &cf->pager_index[cf->pager_start];
996 old_offset = pi->offset;
998 /* Re-add the buffered lines to the index */
999 vec_reset_length (cf->pager_index);
1000 vec_foreach_index (i, cf->pager_vector)
1002 unix_cli_pager_add_line (cf, NULL, i);
1005 /* Attempt to re-locate the previously stored page start line */
1006 vec_foreach_index (i, cf->pager_index)
1008 pi = &cf->pager_index[i];
1010 if (pi->line == old_line &&
1011 (pi->offset <= old_offset || pi->offset + pi->length > old_offset))
1014 cf->pager_start = i;
1019 /* In case the start line was not found (rare), ensure the pager start
1020 * index is within bounds
1022 if (cf->pager_start >= vec_len (cf->pager_index))
1024 if (!cf->height || vec_len (cf->pager_index) < (cf->height - 1))
1025 cf->pager_start = 0;
1027 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
1031 /** VLIB CLI output function.
1033 * If the terminal has a pager configured then this function takes care
1034 * of collating output into the pager buffer; ensuring only the first page
1035 * is displayed and any lines in excess of the first page are buffered.
1037 * If the maximum number of index lines in the buffer is exceeded then the
1038 * pager is cancelled and the contents of the current buffer are sent to the
1041 * If there is no pager configured then the output is sent directly to the
1044 * @param cli_file_index Index of the CLI session where this output is
1046 * @param buffer String of printabe bytes to be output.
1047 * @param buffer_bytes The number of bytes in @c buffer to be output.
1050 unix_vlib_cli_output (uword cli_file_index, u8 * buffer, uword buffer_bytes)
1052 unix_main_t *um = &unix_main;
1053 clib_file_main_t *fm = &file_main;
1054 unix_cli_main_t *cm = &unix_cli_main;
1055 unix_cli_file_t *cf;
1058 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
1059 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1061 if (cf->no_pager || um->cli_pager_buffer_limit == 0 || cf->height == 0)
1063 unix_vlib_cli_output_cooked (cf, uf, buffer, buffer_bytes);
1067 word row = vec_len (cf->pager_index);
1069 unix_cli_pager_index_t *pi;
1071 /* Index and add the output lines to the pager buffer. */
1072 unix_cli_pager_add_line (cf, buffer, buffer_bytes);
1074 /* Now iterate what was added to display the lines.
1075 * If we reach the bottom of the page, display a prompt.
1077 while (row < vec_len (cf->pager_index))
1079 if (row < cf->height - 1)
1081 /* output this line */
1082 pi = &cf->pager_index[row];
1083 line = cf->pager_vector[pi->line] + pi->offset;
1084 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1086 /* if the last line didn't end in newline, and we're at the
1087 * bottom of the page, add a newline */
1088 if (line[pi->length - 1] != '\n' && row == cf->height - 2)
1089 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1093 /* Display the pager prompt every 10 lines */
1095 unix_cli_pager_prompt (cf, uf);
1100 /* Check if we went over the pager buffer limit */
1101 if (vec_len (cf->pager_index) > um->cli_pager_buffer_limit)
1103 /* Stop using the pager for the remainder of this CLI command */
1106 /* If we likely printed the prompt, erase it */
1107 if (vec_len (cf->pager_index) > cf->height - 1)
1108 unix_cli_pager_prompt_erase (cf, uf);
1110 /* Dump out the contents of the buffer */
1111 for (row = cf->pager_start + (cf->height - 1);
1112 row < vec_len (cf->pager_index); row++)
1114 pi = &cf->pager_index[row];
1115 line = cf->pager_vector[pi->line] + pi->offset;
1116 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1119 unix_cli_pager_reset (cf);
1124 /** Identify whether a terminal type is ANSI capable.
1126 * Compares the string given in @c term with a list of terminal types known
1127 * to support ANSI escape sequences.
1129 * This list contains, for example, @c xterm, @c screen and @c ansi.
1131 * @param term A string with a terminal type in it.
1132 * @param len The length of the string in @c term.
1134 * @return @c 1 if the terminal type is recognized as supporting ANSI
1135 * terminal sequences; @c 0 otherwise.
1138 unix_cli_terminal_type_ansi (u8 * term, uword len)
1140 /* This may later be better done as a hash of some sort. */
1142 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1147 _("xterm-256color"); /* iTerm on Mac */
1149 _("screen-256color"); /* Screen and tmux */
1150 _("ansi"); /* Microsoft Telnet */
1156 /** Identify whether a terminal type is non-interactive.
1158 * Compares the string given in @c term with a list of terminal types known
1159 * to be non-interactive, as send by tools such as @c vppctl .
1161 * This list contains, for example, @c vppctl.
1163 * @param term A string with a terminal type in it.
1164 * @param len The length of the string in @c term.
1166 * @return @c 1 if the terminal type is recognized as being non-interactive;
1170 unix_cli_terminal_type_noninteractive (u8 * term, uword len)
1172 /* This may later be better done as a hash of some sort. */
1174 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1183 /** Set a session to be non-interactive. */
1185 unix_cli_set_session_noninteractive (unix_cli_file_t * cf)
1187 /* Non-interactive sessions don't get these */
1188 cf->is_interactive = 0;
1190 cf->history_limit = 0;
1191 cf->has_history = 0;
1195 /** @brief Emit initial welcome banner and prompt on a connection. */
1197 unix_cli_file_welcome (unix_cli_main_t * cm, unix_cli_file_t * cf)
1199 unix_main_t *um = &unix_main;
1200 clib_file_main_t *fm = &file_main;
1201 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1202 unix_cli_banner_t *banner;
1205 /* Mark the session as started if we get here */
1208 if (!(cf->is_interactive)) /* No banner for non-interactive sessions */
1212 * Put the first bytes directly into the buffer so that further output is
1213 * queued until everything is ready. (oterwise initial prompt can appear
1214 * mid way through VPP initialization)
1216 unix_cli_add_pending_output (uf, cf, (u8 *) "\r", 1);
1218 if (!um->cli_no_banner)
1220 if (cf->ansi_capable)
1222 banner = unix_cli_banner_color;
1223 len = ARRAY_LEN (unix_cli_banner_color);
1227 banner = unix_cli_banner;
1228 len = ARRAY_LEN (unix_cli_banner);
1231 for (i = 0; i < len; i++)
1233 unix_vlib_cli_output_cooked (cf, uf,
1234 banner[i].line, banner[i].length);
1239 unix_cli_cli_prompt (cf, uf);
1243 /** @brief A failsafe triggered on a timer to ensure we send the prompt
1244 * to telnet sessions that fail to negotiate the terminal type. */
1246 unix_cli_file_welcome_timer (any arg, f64 delay)
1248 unix_cli_main_t *cm = &unix_cli_main;
1249 unix_cli_file_t *cf;
1252 /* Check the connection didn't close already */
1253 if (pool_is_free_index (cm->cli_file_pool, (uword) arg))
1256 cf = pool_elt_at_index (cm->cli_file_pool, (uword) arg);
1259 unix_cli_file_welcome (cm, cf);
1262 /** @brief A mostly no-op Telnet state machine.
1263 * Process Telnet command bytes in a way that ensures we're mostly
1264 * transparent to the Telnet protocol. That is, it's mostly a no-op.
1266 * @return -1 if we need more bytes, otherwise a positive integer number of
1267 * bytes to consume from the input_vector, not including the initial
1271 unix_cli_process_telnet (unix_main_t * um,
1272 unix_cli_file_t * cf,
1273 clib_file_t * uf, u8 * input_vector, uword len)
1275 /* Input_vector starts at IAC byte.
1276 * See if we have a complete message; if not, return -1 so we wait for more.
1277 * if we have a complete message, consume those bytes from the vector.
1282 return -1; /* want more bytes */
1284 switch (input_vector[1])
1287 /* two IAC's in a row means to pass through 0xff.
1288 * since that makes no sense here, just consume it.
1297 /* Expect 3 bytes */
1299 return -1; /* want more bytes */
1306 /* Sub option - search ahead for IAC SE to end it */
1308 for (i = 3; i < len && i < UNIX_CLI_MAX_DEPTH_TELNET; i++)
1310 if (input_vector[i - 1] == IAC && input_vector[i] == SE)
1312 /* We have a complete message; see if we care about it */
1313 switch (input_vector[2])
1316 if (input_vector[3] != 0)
1319 /* See if the the terminal type is recognized */
1320 u8 *term = input_vector + 4;
1323 /* See if the terminal type is ANSI capable */
1325 unix_cli_terminal_type_ansi (term, len);
1327 /* See if the terminal type indicates non-interactive */
1328 if (unix_cli_terminal_type_noninteractive (term, len))
1329 unix_cli_set_session_noninteractive (cf);
1332 /* If session not started, we can release the pause */
1334 /* Send the welcome banner and initial prompt */
1335 unix_cli_file_welcome (&unix_cli_main, cf);
1340 if (i != 8) /* check message is correct size */
1344 clib_net_to_host_u16 (*((u16 *) (input_vector + 3)));
1345 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
1346 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
1348 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
1351 clib_net_to_host_u16 (*((u16 *) (input_vector + 5)));
1352 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
1353 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
1354 if (cf->height == 0)
1355 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
1357 /* reindex pager buffer */
1358 unix_cli_pager_reindex (cf);
1360 unix_cli_pager_redraw (cf, uf);
1366 /* Consume it all */
1372 if (i == UNIX_CLI_MAX_DEPTH_TELNET)
1373 consume = 1; /* hit max search depth, advance one byte */
1376 return -1; /* want more bytes */
1394 /* Simple one-byte messages */
1399 /* Are You There - trigger a visible response */
1401 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "fd.io VPP\n", 10);
1405 /* Unknown command! Eat the IAC byte */
1412 /** @brief Process actionable input.
1413 * Based on the \c action process the input; this typically involves
1414 * searching the command history or editing the current command line.
1417 unix_cli_line_process_one (unix_cli_main_t * cm,
1419 unix_cli_file_t * cf,
1421 u8 input, unix_cli_parse_action_t action)
1425 u8 **possible_commands;
1430 case UNIX_CLI_PARSE_ACTION_NOACTION:
1433 case UNIX_CLI_PARSE_ACTION_REVSEARCH:
1434 case UNIX_CLI_PARSE_ACTION_FWDSEARCH:
1435 if (!cf->has_history || !cf->history_limit)
1437 if (cf->search_mode == 0)
1439 /* Erase the current command (if any) */
1440 for (; cf->cursor > 0; cf->cursor--)
1442 unix_vlib_cli_output_cursor_left (cf, uf);
1443 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1444 unix_vlib_cli_output_cursor_left (cf, uf);
1447 vec_reset_length (cf->search_key);
1448 vec_reset_length (cf->current_command);
1450 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1451 cf->search_mode = -1;
1453 cf->search_mode = 1;
1457 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1458 cf->search_mode = -1;
1460 cf->search_mode = 1;
1462 cf->excursion += cf->search_mode;
1467 case UNIX_CLI_PARSE_ACTION_ERASELINELEFT:
1468 /* Erase the command from the cursor to the start */
1471 /* Shimmy backwards to the new end of line position */
1472 delta = vec_len (cf->current_command) - cf->cursor;
1473 for (; cf->cursor > delta; cf->cursor--)
1474 unix_vlib_cli_output_cursor_left (cf, uf);
1475 /* Zap from here to the end of what is currently displayed */
1476 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1477 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1478 /* Get back to the start of the line */
1479 for (; cf->cursor > 0; cf->cursor--)
1480 unix_vlib_cli_output_cursor_left (cf, uf);
1482 /* Delete the desired text from the command */
1483 memmove (cf->current_command, cf->current_command + j, delta);
1484 _vec_len (cf->current_command) = delta;
1486 /* Print the new contents */
1487 unix_vlib_cli_output_cooked (cf, uf, cf->current_command, delta);
1488 cf->cursor = delta; /* for backspace tracking */
1490 /* Shimmy back to the start */
1491 for (; cf->cursor > 0; cf->cursor--)
1492 unix_vlib_cli_output_cursor_left (cf, uf);
1494 cf->search_mode = 0;
1497 case UNIX_CLI_PARSE_ACTION_ERASELINERIGHT:
1498 /* Erase the command from the cursor to the end */
1501 /* Zap from cursor to end of what is currently displayed */
1502 for (; cf->cursor < (vec_len (cf->current_command)); cf->cursor++)
1503 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1504 /* Get back to where we were */
1505 for (; cf->cursor > j; cf->cursor--)
1506 unix_vlib_cli_output_cursor_left (cf, uf);
1508 /* Truncate the line at the cursor */
1509 _vec_len (cf->current_command) = cf->cursor;
1511 cf->search_mode = 0;
1514 case UNIX_CLI_PARSE_ACTION_LEFT:
1517 unix_vlib_cli_output_cursor_left (cf, uf);
1521 cf->search_mode = 0;
1524 case UNIX_CLI_PARSE_ACTION_RIGHT:
1525 if (cf->cursor < vec_len (cf->current_command))
1527 /* have to emit the character under the cursor */
1528 unix_vlib_cli_output_cooked (cf, uf,
1529 cf->current_command + cf->cursor, 1);
1533 cf->search_mode = 0;
1536 case UNIX_CLI_PARSE_ACTION_UP:
1537 case UNIX_CLI_PARSE_ACTION_DOWN:
1538 if (!cf->has_history || !cf->history_limit)
1540 cf->search_mode = 0;
1541 /* Erase the command */
1542 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1543 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1544 for (; cf->cursor > 0; cf->cursor--)
1546 unix_vlib_cli_output_cursor_left (cf, uf);
1547 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1548 unix_vlib_cli_output_cursor_left (cf, uf);
1550 vec_reset_length (cf->current_command);
1551 if (vec_len (cf->command_history))
1553 if (action == UNIX_CLI_PARSE_ACTION_UP)
1558 cf->excursion += delta;
1560 if (cf->excursion == vec_len (cf->command_history))
1562 /* down-arrowed to last entry - want a blank line */
1563 _vec_len (cf->current_command) = 0;
1565 else if (cf->excursion < 0)
1567 /* up-arrowed over the start to the end, want a blank line */
1568 cf->excursion = vec_len (cf->command_history);
1569 _vec_len (cf->current_command) = 0;
1573 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1574 /* down-arrowed past end - wrap to start */
1577 /* Print the command at the current position */
1578 prev = cf->command_history[cf->excursion];
1579 vec_validate (cf->current_command, vec_len (prev) - 1);
1581 clib_memcpy (cf->current_command, prev, vec_len (prev));
1582 _vec_len (cf->current_command) = vec_len (prev);
1583 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1584 vec_len (cf->current_command));
1587 cf->cursor = vec_len (cf->current_command);
1590 case UNIX_CLI_PARSE_ACTION_HOME:
1591 if (vec_len (cf->current_command) && cf->cursor > 0)
1593 for (; cf->cursor > 0; cf->cursor--)
1594 unix_vlib_cli_output_cursor_left (cf, uf);
1597 cf->search_mode = 0;
1600 case UNIX_CLI_PARSE_ACTION_END:
1601 if (vec_len (cf->current_command) &&
1602 cf->cursor < vec_len (cf->current_command))
1604 unix_vlib_cli_output_cooked (cf, uf,
1605 cf->current_command + cf->cursor,
1606 vec_len (cf->current_command) -
1608 cf->cursor = vec_len (cf->current_command);
1611 cf->search_mode = 0;
1614 case UNIX_CLI_PARSE_ACTION_WORDLEFT:
1615 if (vec_len (cf->current_command) && cf->cursor > 0)
1617 unix_vlib_cli_output_cursor_left (cf, uf);
1620 while (cf->cursor && isspace (cf->current_command[cf->cursor]))
1622 unix_vlib_cli_output_cursor_left (cf, uf);
1625 while (cf->cursor && !isspace (cf->current_command[cf->cursor]))
1627 if (isspace (cf->current_command[cf->cursor - 1]))
1629 unix_vlib_cli_output_cursor_left (cf, uf);
1635 cf->search_mode = 0;
1638 case UNIX_CLI_PARSE_ACTION_WORDRIGHT:
1639 if (vec_len (cf->current_command) &&
1640 cf->cursor < vec_len (cf->current_command))
1642 int e = vec_len (cf->current_command);
1644 while (j < e && !isspace (cf->current_command[j]))
1646 while (j < e && isspace (cf->current_command[j]))
1648 unix_vlib_cli_output_cooked (cf, uf,
1649 cf->current_command + cf->cursor,
1654 cf->search_mode = 0;
1658 case UNIX_CLI_PARSE_ACTION_ERASE:
1659 if (vec_len (cf->current_command))
1661 if (cf->cursor == vec_len (cf->current_command))
1663 unix_vlib_cli_output_cursor_left (cf, uf);
1665 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1667 unix_vlib_cli_output_cursor_left (cf, uf);
1669 _vec_len (cf->current_command)--;
1671 else if (cf->cursor > 0)
1673 /* shift everything at & to the right of the cursor left by 1 */
1674 j = vec_len (cf->current_command) - cf->cursor;
1675 memmove (cf->current_command + cf->cursor - 1,
1676 cf->current_command + cf->cursor, j);
1677 _vec_len (cf->current_command)--;
1679 /* redraw the rest of the line */
1680 unix_vlib_cli_output_cursor_left (cf, uf);
1682 unix_vlib_cli_output_cooked (cf, uf,
1683 cf->current_command + cf->cursor,
1686 /* erase last char */
1687 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1690 /* and shift the terminal cursor back where it should be */
1691 j += 2; /* account for old string length and offset position */
1694 unix_vlib_cli_output_cursor_left (cf, uf);
1699 cf->search_mode = 0;
1701 vec_reset_length (cf->search_key);
1704 case UNIX_CLI_PARSE_ACTION_ERASERIGHT:
1705 if (vec_len (cf->current_command))
1707 if (cf->cursor < vec_len (cf->current_command))
1709 /* shift everything to the right of the cursor left by 1 */
1710 j = vec_len (cf->current_command) - cf->cursor - 1;
1711 memmove (cf->current_command + cf->cursor,
1712 cf->current_command + cf->cursor + 1, j);
1713 _vec_len (cf->current_command)--;
1714 /* redraw the rest of the line */
1715 unix_vlib_cli_output_cooked (cf, uf,
1716 cf->current_command + cf->cursor,
1719 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1721 unix_vlib_cli_output_cursor_left (cf, uf);
1723 /* and shift the terminal cursor back where it should be */
1726 unix_vlib_cli_output_cursor_left (cf, uf);
1730 unix_vlib_cli_output_cursor_left (cf, uf);
1736 else if (input == 'D' - '@')
1738 /* ^D with no command entered = quit */
1739 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "quit\n", 5);
1740 vlib_process_signal_event (um->vlib_main,
1741 vlib_current_process (um->vlib_main),
1742 UNIX_CLI_PROCESS_EVENT_QUIT,
1743 cf - cm->cli_file_pool);
1745 cf->search_mode = 0;
1747 vec_reset_length (cf->search_key);
1750 case UNIX_CLI_PARSE_ACTION_CLEAR:
1751 /* If we're in ANSI mode, clear the screen.
1752 * Then redraw the prompt and any existing command input, then put
1753 * the cursor back where it was in that line.
1755 if (cf->ansi_capable)
1756 unix_vlib_cli_output_cooked (cf, uf,
1758 sizeof (ANSI_CLEAR) - 1);
1760 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1762 unix_vlib_cli_output_raw (cf, uf,
1763 cm->cli_prompt, vec_len (cm->cli_prompt));
1764 unix_vlib_cli_output_cooked (cf, uf,
1765 cf->current_command,
1766 vec_len (cf->current_command));
1768 cf->cursor = vec_len (cf->current_command);
1769 for (; cf->cursor > j; cf->cursor--)
1770 unix_vlib_cli_output_cursor_left (cf, uf);
1774 case UNIX_CLI_PARSE_ACTION_TAB:
1775 if (cf->cursor < vec_len (cf->current_command))
1777 /* if we are in the middle of a line, complete only if
1778 * the cursor points to whitespace */
1779 if (isspace (cf->current_command[cf->cursor]))
1781 /* save and clear any input that is after the cursor */
1782 vec_resize (save, vec_len (cf->current_command) - cf->cursor);
1783 clib_memcpy (save, cf->current_command + cf->cursor,
1784 vec_len (cf->current_command) - cf->cursor);
1785 _vec_len (cf->current_command) = cf->cursor;
1789 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1794 vlib_cli_get_possible_completions (cf->current_command);
1795 if (vec_len (possible_commands) == 1)
1797 u8 *completed = possible_commands[0];
1800 /* find the last word of current_command */
1801 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1803 unix_vlib_cli_output_cursor_left (cf, uf);
1807 _vec_len (cf->current_command) = j;
1809 /* replace it with the newly expanded command */
1810 vec_append (cf->current_command, completed);
1812 /* echo to the terminal */
1813 unix_vlib_cli_output_cooked (cf, uf, completed,
1814 vec_len (completed));
1816 /* add one trailing space if needed */
1817 if (vec_len (save) == 0)
1819 vec_add1 (cf->current_command, ' ');
1820 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1823 cf->cursor = vec_len (cf->current_command);
1826 else if (vec_len (possible_commands) >= 2)
1828 u8 **possible_command;
1829 uword max_command_len = 0, min_command_len = ~0;
1832 vec_foreach (possible_command, possible_commands)
1834 if (vec_len (*possible_command) > max_command_len)
1835 max_command_len = vec_len (*possible_command);
1836 if (vec_len (*possible_command) < min_command_len)
1837 min_command_len = vec_len (*possible_command);
1840 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1843 vec_foreach (possible_command, possible_commands)
1845 if (i + max_command_len >= cf->width)
1847 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1850 unix_vlib_cli_output_cooked (cf, uf, *possible_command,
1851 vec_len (*possible_command));
1852 for (j = vec_len (*possible_command); j < max_command_len + 2;
1855 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1857 i += max_command_len + 2;
1860 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1862 /* rewrite prompt */
1863 unix_cli_cli_prompt (cf, uf);
1864 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1865 vec_len (cf->current_command));
1867 /* count length of last word */
1870 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1876 /* determine smallest common command */
1877 for (; i < min_command_len; i++)
1882 vec_foreach (possible_command, possible_commands)
1886 common = (*possible_command)[i];
1888 else if (common != (*possible_command)[i])
1897 vec_add1 (cf->current_command, common);
1899 unix_vlib_cli_output_cooked (cf, uf, (u8 *) & common, 1);
1909 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1912 if (vec_len (save) > 0)
1914 /* restore remaining input if tab was hit in the middle of a line */
1915 unix_vlib_cli_output_cooked (cf, uf, save, vec_len (save));
1916 cf->cursor += vec_len (save);
1917 for (j = 0; j < vec_len (save); j++, cf->cursor--)
1918 unix_vlib_cli_output_cursor_left (cf, uf);
1919 vec_append (cf->current_command, save);
1922 vec_free (possible_commands);
1925 case UNIX_CLI_PARSE_ACTION_YANK:
1930 case UNIX_CLI_PARSE_ACTION_PAGER_QUIT:
1932 unix_cli_pager_prompt_erase (cf, uf);
1933 unix_cli_pager_reset (cf);
1934 unix_cli_cli_prompt (cf, uf);
1937 case UNIX_CLI_PARSE_ACTION_PAGER_NEXT:
1938 case UNIX_CLI_PARSE_ACTION_PAGER_PGDN:
1939 /* show next page of the buffer */
1940 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
1943 unix_cli_pager_index_t *pi = NULL;
1945 int m = cf->pager_start + (cf->height - 1);
1946 unix_cli_pager_prompt_erase (cf, uf);
1948 j < vec_len (cf->pager_index) && cf->pager_start < m;
1949 j++, cf->pager_start++)
1951 pi = &cf->pager_index[j];
1952 line = cf->pager_vector[pi->line] + pi->offset;
1953 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1955 /* if the last line didn't end in newline, add a newline */
1956 if (pi && line[pi->length - 1] != '\n')
1957 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1958 unix_cli_pager_prompt (cf, uf);
1962 if (action == UNIX_CLI_PARSE_ACTION_PAGER_NEXT)
1963 /* no more in buffer, exit, but only if it was <space> */
1968 case UNIX_CLI_PARSE_ACTION_PAGER_DN:
1969 case UNIX_CLI_PARSE_ACTION_PAGER_CRLF:
1970 /* display the next line of the buffer */
1971 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
1974 unix_cli_pager_index_t *pi;
1976 unix_cli_pager_prompt_erase (cf, uf);
1977 pi = &cf->pager_index[cf->pager_start + (cf->height - 1)];
1978 line = cf->pager_vector[pi->line] + pi->offset;
1979 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1981 /* if the last line didn't end in newline, add a newline */
1982 if (line[pi->length - 1] != '\n')
1983 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1984 unix_cli_pager_prompt (cf, uf);
1988 if (action == UNIX_CLI_PARSE_ACTION_PAGER_CRLF)
1989 /* no more in buffer, exit, but only if it was <enter> */
1995 case UNIX_CLI_PARSE_ACTION_PAGER_UP:
1996 /* scroll the page back one line */
1997 if (cf->pager_start > 0)
2000 unix_cli_pager_index_t *pi = NULL;
2003 if (cf->ansi_capable)
2005 pi = &cf->pager_index[cf->pager_start];
2006 line = cf->pager_vector[pi->line] + pi->offset;
2007 unix_cli_pager_prompt_erase (cf, uf);
2008 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SCROLLDN,
2009 sizeof (ANSI_SCROLLDN) - 1);
2010 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SAVECURSOR,
2011 sizeof (ANSI_SAVECURSOR) - 1);
2012 unix_cli_ansi_cursor (cf, uf, 1, 1);
2013 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_CLEARLINE,
2014 sizeof (ANSI_CLEARLINE) - 1);
2015 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2016 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_RESTCURSOR,
2017 sizeof (ANSI_RESTCURSOR) - 1);
2018 unix_cli_pager_prompt_erase (cf, uf);
2019 unix_cli_pager_prompt (cf, uf);
2023 int m = cf->pager_start + (cf->height - 1);
2024 unix_cli_pager_prompt_erase (cf, uf);
2025 for (j = cf->pager_start;
2026 j < vec_len (cf->pager_index) && j < m; j++)
2028 pi = &cf->pager_index[j];
2029 line = cf->pager_vector[pi->line] + pi->offset;
2030 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2032 /* if the last line didn't end in newline, add a newline */
2033 if (pi && line[pi->length - 1] != '\n')
2034 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2035 unix_cli_pager_prompt (cf, uf);
2040 case UNIX_CLI_PARSE_ACTION_PAGER_TOP:
2041 /* back to the first page of the buffer */
2042 if (cf->pager_start > 0)
2045 unix_cli_pager_index_t *pi = NULL;
2047 cf->pager_start = 0;
2048 int m = cf->pager_start + (cf->height - 1);
2049 unix_cli_pager_prompt_erase (cf, uf);
2050 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2053 pi = &cf->pager_index[j];
2054 line = cf->pager_vector[pi->line] + pi->offset;
2055 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2057 /* if the last line didn't end in newline, add a newline */
2058 if (pi && line[pi->length - 1] != '\n')
2059 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2060 unix_cli_pager_prompt (cf, uf);
2064 case UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM:
2065 /* skip to the last page of the buffer */
2066 if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
2069 unix_cli_pager_index_t *pi = NULL;
2071 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
2072 unix_cli_pager_prompt_erase (cf, uf);
2073 unix_cli_pager_message (cf, uf, "skipping", "\n");
2074 for (j = cf->pager_start; j < vec_len (cf->pager_index); j++)
2076 pi = &cf->pager_index[j];
2077 line = cf->pager_vector[pi->line] + pi->offset;
2078 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2080 /* if the last line didn't end in newline, add a newline */
2081 if (pi && line[pi->length - 1] != '\n')
2082 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2083 unix_cli_pager_prompt (cf, uf);
2087 case UNIX_CLI_PARSE_ACTION_PAGER_PGUP:
2088 /* wander back one page in the buffer */
2089 if (cf->pager_start > 0)
2092 unix_cli_pager_index_t *pi = NULL;
2095 if (cf->pager_start >= cf->height)
2096 cf->pager_start -= cf->height - 1;
2098 cf->pager_start = 0;
2099 m = cf->pager_start + cf->height - 1;
2100 unix_cli_pager_prompt_erase (cf, uf);
2101 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2104 pi = &cf->pager_index[j];
2105 line = cf->pager_vector[pi->line] + pi->offset;
2106 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2108 /* if the last line didn't end in newline, add a newline */
2109 if (pi && line[pi->length - 1] != '\n')
2110 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2111 unix_cli_pager_prompt (cf, uf);
2115 case UNIX_CLI_PARSE_ACTION_PAGER_REDRAW:
2116 /* Redraw the current pager screen */
2117 unix_cli_pager_redraw (cf, uf);
2120 case UNIX_CLI_PARSE_ACTION_PAGER_SEARCH:
2121 /* search forwards in the buffer */
2125 case UNIX_CLI_PARSE_ACTION_CRLF:
2127 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2129 if (cf->has_history && cf->history_limit)
2131 if (cf->command_history
2132 && vec_len (cf->command_history) >= cf->history_limit)
2134 vec_free (cf->command_history[0]);
2135 vec_delete (cf->command_history, 1, 0);
2137 /* Don't add blank lines to the cmd history */
2138 if (vec_len (cf->current_command))
2140 /* Don't duplicate the previous command */
2141 j = vec_len (cf->command_history);
2143 (vec_len (cf->current_command) !=
2144 vec_len (cf->command_history[j - 1])
2145 || memcmp (cf->current_command, cf->command_history[j - 1],
2146 vec_len (cf->current_command)) != 0))
2148 /* copy the command to the history */
2150 vec_append (c, cf->current_command);
2151 vec_add1 (cf->command_history, c);
2152 cf->command_number++;
2155 cf->excursion = vec_len (cf->command_history);
2158 cf->search_mode = 0;
2159 vec_reset_length (cf->search_key);
2164 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2165 case UNIX_CLI_PARSE_ACTION_NOMATCH:
2166 if (vec_len (cf->pager_index))
2170 else if (cf->has_history && cf->search_mode != 0 && isprint (input))
2172 int k, limit, offset;
2175 vec_add1 (cf->search_key, input);
2178 for (j = 0; j < vec_len (cf->command_history); j++)
2180 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
2182 else if (cf->excursion < 0)
2183 cf->excursion = vec_len (cf->command_history) - 1;
2185 item = cf->command_history[cf->excursion];
2187 limit = (vec_len (cf->search_key) > vec_len (item)) ?
2188 vec_len (item) : vec_len (cf->search_key);
2190 for (offset = 0; offset <= vec_len (item) - limit; offset++)
2192 for (k = 0; k < limit; k++)
2194 if (item[k + offset] != cf->search_key[k])
2197 goto found_at_offset;
2205 for (; cf->cursor > 0; cf->cursor--)
2207 unix_vlib_cli_output_cursor_left (cf, uf);
2208 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2209 unix_vlib_cli_output_cursor_left (cf, uf);
2212 vec_validate (cf->current_command, vec_len (item) - 1);
2213 clib_memcpy (cf->current_command, item, vec_len (item));
2214 _vec_len (cf->current_command) = vec_len (item);
2216 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2217 vec_len (cf->current_command));
2218 cf->cursor = vec_len (cf->current_command);
2222 cf->excursion += cf->search_mode;
2225 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\nNo match...", 12);
2226 vec_reset_length (cf->search_key);
2227 vec_reset_length (cf->current_command);
2228 cf->search_mode = 0;
2232 else if (isprint (input)) /* skip any errant control codes */
2234 if (cf->cursor == vec_len (cf->current_command))
2237 vec_add1 (cf->current_command, input);
2240 /* Echo the character back to the client */
2241 unix_vlib_cli_output_cooked (cf, uf, &input, 1);
2245 /* Insert at cursor: resize +1 byte, move everything over */
2246 j = vec_len (cf->current_command) - cf->cursor;
2247 vec_add1 (cf->current_command, (u8) 'A');
2248 memmove (cf->current_command + cf->cursor + 1,
2249 cf->current_command + cf->cursor, j);
2250 cf->current_command[cf->cursor] = input;
2251 /* Redraw the line */
2253 unix_vlib_cli_output_cooked (cf, uf,
2254 cf->current_command + cf->cursor,
2258 /* Put terminal cursor back */
2259 for (; j > 0; j--, cf->cursor--)
2260 unix_vlib_cli_output_cursor_left (cf, uf);
2265 /* no-op - not printable or otherwise not actionable */
2272 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2278 /** @brief Process input bytes on a stream to provide line editing and
2279 * command history in the CLI. */
2281 unix_cli_line_edit (unix_cli_main_t * cm, unix_main_t * um,
2282 clib_file_main_t * fm, unix_cli_file_t * cf)
2284 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2287 for (i = 0; i < vec_len (cf->input_vector); i++)
2289 unix_cli_parse_action_t action;
2291 unix_cli_parse_actions_t *a;
2293 /* If we're in the pager mode, search the pager actions */
2295 vec_len (cf->pager_index) ? unix_cli_parse_pager :
2296 unix_cli_parse_strings;
2298 /* See if the input buffer is some sort of control code */
2299 action = unix_cli_match_action (a, &cf->input_vector[i],
2300 vec_len (cf->input_vector) - i,
2305 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2308 /* There was a partial match which means we need more bytes
2309 * than the input buffer currently has.
2310 * Since the bytes before here have been processed, shift
2311 * the remaining contents to the start of the input buffer.
2313 vec_delete (cf->input_vector, i, 0);
2315 return 1; /* wait for more */
2317 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2318 /* process telnet options */
2319 matched = unix_cli_process_telnet (um, cf, uf,
2320 cf->input_vector + i,
2321 vec_len (cf->input_vector) - i);
2324 /* There was a partial match which means we need more bytes
2325 * than the input buffer currently has.
2330 * Since the bytes before here have been processed, shift
2331 * the remaining contents to the start of the input buffer.
2333 vec_delete (cf->input_vector, i, 0);
2335 return 1; /* wait for more */
2340 /* If telnet option processing switched us to line mode, get us
2345 vec_delete (cf->input_vector, i, 0);
2346 cf->current_command = cf->input_vector;
2350 /* process the action */
2351 if (!unix_cli_line_process_one (cm, um, cf, uf,
2352 cf->input_vector[i], action))
2354 /* CRLF found. Consume the bytes from the input_vector */
2355 vec_delete (cf->input_vector, i + matched, 0);
2356 /* And tell our caller to execute cf->input_command */
2364 vec_reset_length (cf->input_vector);
2368 /** @brief Process input to a CLI session. */
2370 unix_cli_process_input (unix_cli_main_t * cm, uword cli_file_index)
2372 unix_main_t *um = &unix_main;
2373 clib_file_main_t *fm = &file_main;
2375 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2376 unformat_input_t input;
2377 int vlib_parse_eval (u8 *);
2379 cm->current_input_file_index = cli_file_index;
2382 /* Try vlibplex first. Someday... */
2383 if (0 && vlib_parse_eval (cf->input_vector) == 0)
2389 /* just treat whatever we got as a complete line of input */
2390 cf->current_command = cf->input_vector;
2394 /* Line edit, echo, etc. */
2395 if (unix_cli_line_edit (cm, um, fm, cf))
2396 /* want more input */
2403 vec_reset_length (lv);
2404 lv = format (lv, "%U[%d]: %v",
2405 format_timeval, 0 /* current bat-time */ ,
2406 0 /* current bat-format */ ,
2407 cli_file_index, cf->current_command);
2408 int rv __attribute__ ((unused)) = write (um->log_fd, lv, vec_len (lv));
2411 /* Build an unformat structure around our command */
2412 unformat_init_vector (&input, cf->current_command);
2414 /* Remove leading white space from input. */
2415 (void) unformat (&input, "");
2417 cf->pager_start = 0; /* start a new pager session */
2419 if (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
2420 vlib_cli_input (um->vlib_main, &input, unix_vlib_cli_output,
2423 /* Zero buffer since otherwise unformat_free will call vec_free on it. */
2426 unformat_free (&input);
2428 /* Re-fetch pointer since pool may have moved. */
2429 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2430 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2433 /* reset vector; we'll re-use it later */
2436 vec_reset_length (cf->input_vector);
2437 cf->current_command = 0;
2441 vec_reset_length (cf->current_command);
2444 if (cf->no_pager == 2)
2446 /* Pager was programmatically disabled */
2447 unix_cli_pager_message (cf, uf, "pager buffer overflowed", "\n");
2448 cf->no_pager = um->cli_no_pager;
2451 if (vec_len (cf->pager_index) == 0
2452 || vec_len (cf->pager_index) < cf->height)
2454 /* There was no need for the pager */
2455 unix_cli_pager_reset (cf);
2458 unix_cli_cli_prompt (cf, uf);
2462 /* Display the pager prompt */
2463 unix_cli_pager_prompt (cf, uf);
2466 /* Any residual data in the input vector? */
2467 if (vec_len (cf->input_vector))
2470 /* For non-interactive sessions send a NUL byte.
2471 * Specifically this is because vppctl needs to see some traffic in
2472 * order to move on to closing the session. Commands with no output
2473 * would thus cause vppctl to hang indefinitely in non-interactive mode
2474 * since there is also no prompt sent after the command completes.
2476 if (!cf->is_interactive)
2477 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\0", 1);
2480 /** Destroy a CLI session.
2481 * @note If we destroy the @c stdin session this additionally signals
2482 * the shutdown of VPP.
2485 unix_cli_kill (unix_cli_main_t * cm, uword cli_file_index)
2487 unix_main_t *um = &unix_main;
2488 clib_file_main_t *fm = &file_main;
2489 unix_cli_file_t *cf;
2493 /* Validate cli_file_index */
2494 if (pool_is_free_index (cm->cli_file_pool, cli_file_index))
2497 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2498 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2500 /* Quit/EOF on stdin means quit program. */
2501 if (uf->file_descriptor == STDIN_FILENO)
2502 clib_longjmp (&um->vlib_main->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
2504 vec_free (cf->current_command);
2505 vec_free (cf->search_key);
2507 for (i = 0; i < vec_len (cf->command_history); i++)
2508 vec_free (cf->command_history[i]);
2510 vec_free (cf->command_history);
2512 clib_file_del (fm, uf);
2514 unix_cli_file_free (cf);
2515 pool_put (cm->cli_file_pool, cf);
2518 /** Handle system events. */
2520 unix_cli_process (vlib_main_t * vm,
2521 vlib_node_runtime_t * rt, vlib_frame_t * f)
2523 unix_cli_main_t *cm = &unix_cli_main;
2528 unix_cli_process_event_type_t event_type;
2529 vlib_process_wait_for_event (vm);
2530 event_type = vlib_process_get_events (vm, &data);
2534 case UNIX_CLI_PROCESS_EVENT_READ_READY:
2535 for (i = 0; i < vec_len (data); i++)
2536 unix_cli_process_input (cm, data[i]);
2539 case UNIX_CLI_PROCESS_EVENT_QUIT:
2540 /* Kill this process. */
2541 for (i = 0; i < vec_len (data); i++)
2542 unix_cli_kill (cm, data[i]);
2547 _vec_len (data) = 0;
2553 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
2555 /* Add node index so we can re-use this process later. */
2556 vec_add1 (cm->unused_cli_process_node_indices, rt->node_index);
2561 /** Called when a CLI session file descriptor can be written to without
2563 static clib_error_t *
2564 unix_cli_write_ready (clib_file_t * uf)
2566 unix_cli_main_t *cm = &unix_cli_main;
2567 unix_cli_file_t *cf;
2570 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2572 /* Flush output vector. */
2574 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
2575 n = send (uf->file_descriptor,
2576 cf->output_vector, vec_len (cf->output_vector), MSG_NOSIGNAL);
2578 n = write (uf->file_descriptor,
2579 cf->output_vector, vec_len (cf->output_vector));
2581 if (n < 0 && errno != EAGAIN)
2585 /* connection closed on us */
2586 unix_main_t *um = &unix_main;
2588 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
2589 UNIX_CLI_PROCESS_EVENT_QUIT,
2594 return clib_error_return_unix (0, "write");
2599 unix_cli_del_pending_output (uf, cf, n);
2601 return /* no error */ 0;
2604 /** Called when a CLI session file descriptor has data to be read. */
2605 static clib_error_t *
2606 unix_cli_read_ready (clib_file_t * uf)
2608 unix_main_t *um = &unix_main;
2609 unix_cli_main_t *cm = &unix_cli_main;
2610 unix_cli_file_t *cf;
2612 int n, n_read, n_try;
2614 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2619 l = vec_len (cf->input_vector);
2620 vec_resize (cf->input_vector, l + n_try);
2622 n = read (uf->file_descriptor, cf->input_vector + l, n_try);
2625 if (n < 0 && errno != EAGAIN)
2626 return clib_error_return_unix (0, "read");
2628 n_read = n < 0 ? 0 : n;
2629 _vec_len (cf->input_vector) = l + n_read;
2633 vlib_process_signal_event (um->vlib_main,
2634 cf->process_node_index,
2636 ? UNIX_CLI_PROCESS_EVENT_QUIT
2637 : UNIX_CLI_PROCESS_EVENT_READ_READY),
2638 /* event data */ uf->private_data);
2640 return /* no error */ 0;
2643 /** Called when a CLI session file descriptor has an error condition. */
2644 static clib_error_t *
2645 unix_cli_error_detected (clib_file_t * uf)
2647 unix_main_t *um = &unix_main;
2648 unix_cli_main_t *cm = &unix_cli_main;
2649 unix_cli_file_t *cf;
2651 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2652 cf->has_epipe = 1; /* prevent writes while the close is pending */
2653 vlib_process_signal_event (um->vlib_main,
2654 cf->process_node_index,
2655 UNIX_CLI_PROCESS_EVENT_QUIT,
2656 /* event data */ uf->private_data);
2658 return /* no error */ 0;
2661 /** Store a new CLI session.
2662 * @param name The name of the session.
2663 * @param fd The file descriptor for the session I/O.
2664 * @return The session ID.
2667 unix_cli_file_add (unix_cli_main_t * cm, char *name, int fd)
2669 unix_main_t *um = &unix_main;
2670 clib_file_main_t *fm = &file_main;
2671 unix_cli_file_t *cf;
2672 clib_file_t template = { 0 };
2673 vlib_main_t *vm = um->vlib_main;
2677 file_desc = format (0, "%s", name);
2679 name = (char *) format (0, "unix-cli-%s", name);
2681 if (vec_len (cm->unused_cli_process_node_indices) > 0)
2683 uword l = vec_len (cm->unused_cli_process_node_indices);
2685 vlib_main_t *this_vlib_main;
2689 * Nodes are bulk-copied, so node name pointers are shared.
2690 * Find the cli node in all graph replicas, and give all of them
2691 * the same new name.
2692 * Then, throw away the old shared name-vector.
2694 for (i = 0; i < vec_len (vlib_mains); i++)
2696 this_vlib_main = vlib_mains[i];
2697 if (this_vlib_main == 0)
2699 n = vlib_get_node (this_vlib_main,
2700 cm->unused_cli_process_node_indices[l - 1]);
2702 n->name = (u8 *) name;
2704 vec_free (old_name);
2706 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
2708 _vec_len (cm->unused_cli_process_node_indices) = l - 1;
2712 static vlib_node_registration_t r = {
2713 .function = unix_cli_process,
2714 .type = VLIB_NODE_TYPE_PROCESS,
2715 .process_log2_n_stack_bytes = 16,
2720 vlib_worker_thread_barrier_sync (vm);
2722 vlib_register_node (vm, &r);
2725 n = vlib_get_node (vm, r.index);
2726 vlib_worker_thread_node_runtime_update ();
2727 vlib_worker_thread_barrier_release (vm);
2730 pool_get (cm->cli_file_pool, cf);
2731 clib_memset (cf, 0, sizeof (*cf));
2733 template.read_function = unix_cli_read_ready;
2734 template.write_function = unix_cli_write_ready;
2735 template.error_function = unix_cli_error_detected;
2736 template.file_descriptor = fd;
2737 template.private_data = cf - cm->cli_file_pool;
2738 template.description = file_desc;
2740 cf->process_node_index = n->index;
2741 cf->clib_file_index = clib_file_add (fm, &template);
2742 cf->output_vector = 0;
2743 cf->input_vector = 0;
2745 vlib_start_process (vm, n->runtime_index);
2747 vlib_process_t *p = vlib_get_process_from_node (vm, n);
2748 p->output_function = unix_vlib_cli_output;
2749 p->output_function_arg = cf - cm->cli_file_pool;
2751 return cf - cm->cli_file_pool;
2754 /** Telnet listening socket has a new connection. */
2755 static clib_error_t *
2756 unix_cli_listen_read_ready (clib_file_t * uf)
2758 unix_main_t *um = &unix_main;
2759 clib_file_main_t *fm = &file_main;
2760 unix_cli_main_t *cm = &unix_cli_main;
2761 clib_socket_t *s = &um->cli_listen_socket;
2762 clib_socket_t client;
2764 clib_error_t *error;
2765 unix_cli_file_t *cf;
2769 error = clib_socket_accept (s, &client);
2773 /* Disable Nagle, ignore any errors doing so eg on PF_LOCAL socket */
2775 (void) setsockopt (client.fd, IPPROTO_TCP, TCP_NODELAY,
2776 (void *) &one, sizeof (one));
2778 client_name = (char *) format (0, "%U%c", format_sockaddr, &client.peer, 0);
2780 cf_index = unix_cli_file_add (cm, client_name, client.fd);
2781 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2784 /* No longer need CLIB version of socket. */
2785 clib_socket_free (&client);
2786 vec_free (client_name);
2788 /* if we're supposed to run telnet session in character mode (default) */
2789 if (um->cli_line_mode == 0)
2792 * Set telnet client character mode, echo on, suppress "go-ahead".
2793 * Technically these should be negotiated, but this works.
2795 u8 charmode_option[] = {
2796 IAC, WONT, TELOPT_LINEMODE, /* server will do char-by-char */
2797 IAC, DONT, TELOPT_LINEMODE, /* client should do char-by-char */
2798 IAC, WILL, TELOPT_SGA, /* server willl supress GA */
2799 IAC, DO, TELOPT_SGA, /* client should supress Go Ahead */
2800 IAC, WILL, TELOPT_ECHO, /* server will do echo */
2801 IAC, DONT, TELOPT_ECHO, /* client should not echo */
2802 IAC, DO, TELOPT_TTYPE, /* client should tell us its term type */
2803 IAC, SB, TELOPT_TTYPE, 1, IAC, SE, /* now tell me ttype */
2804 IAC, DO, TELOPT_NAWS, /* client should tell us its window sz */
2805 IAC, SB, TELOPT_NAWS, 1, IAC, SE, /* now tell me window size */
2808 /* Enable history on this CLI */
2809 cf->history_limit = um->cli_history_limit;
2810 cf->has_history = cf->history_limit != 0;
2812 /* This is an interactive session until we decide otherwise */
2813 cf->is_interactive = 1;
2815 /* Make sure this session is in line mode */
2821 /* Setup the pager */
2822 cf->no_pager = um->cli_no_pager;
2824 /* Default terminal dimensions, should the terminal
2825 * fail to provide any.
2827 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
2828 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
2830 /* Send the telnet options */
2831 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2832 unix_vlib_cli_output_raw (cf, uf, charmode_option,
2833 ARRAY_LEN (charmode_option));
2835 /* In case the client doesn't negotiate terminal type, use
2836 * a timer to kick off the initial prompt. */
2837 timer_call (unix_cli_file_welcome_timer, cf_index, 1);
2843 /** The system terminal has informed us that the window size
2847 unix_cli_resize_interrupt (int signum)
2849 clib_file_main_t *fm = &file_main;
2850 unix_cli_main_t *cm = &unix_cli_main;
2851 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
2852 cm->stdin_cli_file_index);
2853 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2857 /* Terminal resized, fetch the new size */
2858 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) < 0)
2860 /* "Should never happen..." */
2861 clib_unix_warning ("TIOCGWINSZ");
2862 /* We can't trust ws.XXX... */
2866 cf->width = ws.ws_col;
2867 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
2868 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
2870 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
2872 cf->height = ws.ws_row;
2873 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
2874 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
2875 if (cf->height == 0)
2876 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
2878 /* Reindex the pager buffer */
2879 unix_cli_pager_reindex (cf);
2881 /* Redraw the page */
2882 unix_cli_pager_redraw (cf, uf);
2885 /** Handle configuration directives in the @em unix section. */
2886 static clib_error_t *
2887 unix_cli_config (vlib_main_t * vm, unformat_input_t * input)
2889 unix_main_t *um = &unix_main;
2890 clib_file_main_t *fm = &file_main;
2891 unix_cli_main_t *cm = &unix_cli_main;
2893 clib_error_t *error = 0;
2894 unix_cli_file_t *cf;
2897 struct sigaction sa;
2901 /* We depend on unix flags being set. */
2902 if ((error = vlib_call_config_function (vm, unix_config)))
2905 if (um->flags & UNIX_FLAG_INTERACTIVE)
2907 /* Set stdin to be non-blocking. */
2908 if ((flags = fcntl (STDIN_FILENO, F_GETFL, 0)) < 0)
2910 (void) fcntl (STDIN_FILENO, F_SETFL, flags | O_NONBLOCK);
2912 cf_index = unix_cli_file_add (cm, "stdin", STDIN_FILENO);
2913 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2914 cm->stdin_cli_file_index = cf_index;
2916 /* If stdin is a tty and we are using chacracter mode, enable
2917 * history on the CLI and set the tty line discipline accordingly. */
2918 if (isatty (STDIN_FILENO) && um->cli_line_mode == 0)
2920 /* Capture terminal resize events */
2921 clib_memset (&sa, 0, sizeof (sa));
2922 sa.sa_handler = unix_cli_resize_interrupt;
2923 if (sigaction (SIGWINCH, &sa, 0) < 0)
2924 clib_panic ("sigaction");
2926 /* Retrieve the current terminal size */
2927 ioctl (STDIN_FILENO, TIOCGWINSZ, &ws);
2928 cf->width = ws.ws_col;
2929 cf->height = ws.ws_row;
2931 if (cf->width == 0 || cf->height == 0)
2934 * We have a tty, but no size. Use defaults.
2935 * vpp "unix interactive" inside emacs + gdb ends up here.
2937 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
2938 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
2941 /* Setup the history */
2942 cf->history_limit = um->cli_history_limit;
2943 cf->has_history = cf->history_limit != 0;
2945 /* Setup the pager */
2946 cf->no_pager = um->cli_no_pager;
2948 /* This is an interactive session until we decide otherwise */
2949 cf->is_interactive = 1;
2951 /* We're going to be in char by char mode */
2954 /* Save the original tty state so we can restore it later */
2955 tcgetattr (STDIN_FILENO, &um->tio_stdin);
2958 /* Tweak the tty settings */
2959 tio = um->tio_stdin;
2960 /* echo off, canonical mode off, ext'd input processing off */
2961 tio.c_lflag &= ~(ECHO | ICANON | IEXTEN);
2962 /* disable XON/XOFF, so ^S invokes the history search */
2963 tio.c_iflag &= ~(IXON | IXOFF);
2964 tio.c_cc[VMIN] = 1; /* 1 byte at a time */
2965 tio.c_cc[VTIME] = 0; /* no timer */
2966 tio.c_cc[VSTOP] = _POSIX_VDISABLE; /* not ^S */
2967 tio.c_cc[VSTART] = _POSIX_VDISABLE; /* not ^Q */
2968 tcsetattr (STDIN_FILENO, TCSAFLUSH, &tio);
2970 /* See if we can do ANSI/VT100 output */
2971 term = (u8 *) getenv ("TERM");
2974 int len = strlen ((char *) term);
2975 cf->ansi_capable = unix_cli_terminal_type_ansi (term, len);
2976 if (unix_cli_terminal_type_noninteractive (term, len))
2977 unix_cli_set_session_noninteractive (cf);
2982 /* No tty, so make sure the session doesn't have tty-like features */
2983 unix_cli_set_session_noninteractive (cf);
2986 /* Send banner and initial prompt */
2987 unix_cli_file_welcome (cm, cf);
2990 /* If we have socket config, LISTEN, otherwise, don't */
2991 clib_socket_t *s = &um->cli_listen_socket;
2992 if (s->config && s->config[0] != 0)
2995 clib_file_t template = { 0 };
2997 /* mkdir of file socketu, only under /run */
2998 if (strncmp (s->config, "/run", 4) == 0)
3000 u8 *tmp = format (0, "%s", s->config);
3001 int i = vec_len (tmp);
3002 while (i && tmp[--i] != '/')
3008 vlib_unix_recursive_mkdir ((char *) tmp);
3012 s->flags = CLIB_SOCKET_F_IS_SERVER | /* listen, don't connect */
3013 CLIB_SOCKET_F_ALLOW_GROUP_WRITE; /* PF_LOCAL socket only */
3014 error = clib_socket_init (s);
3019 template.read_function = unix_cli_listen_read_ready;
3020 template.file_descriptor = s->fd;
3021 template.description = format (0, "cli listener %s", s->config);
3023 clib_file_add (fm, &template);
3026 /* Set CLI prompt. */
3027 if (!cm->cli_prompt)
3028 cm->cli_prompt = format (0, "VLIB: ");
3034 * This module has no configurable parameters.
3036 VLIB_CONFIG_FUNCTION (unix_cli_config, "unix-cli");
3038 /** Called when VPP is shutting down, this restores the system
3039 * terminal state if previously saved.
3041 static clib_error_t *
3042 unix_cli_exit (vlib_main_t * vm)
3044 unix_main_t *um = &unix_main;
3046 /* If stdin is a tty and we saved the tty state, reset the tty state */
3047 if (isatty (STDIN_FILENO) && um->tio_isset)
3048 tcsetattr (STDIN_FILENO, TCSAFLUSH, &um->tio_stdin);
3053 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_cli_exit);
3055 /** Set the CLI prompt.
3056 * @param prompt The C string to set the prompt to.
3057 * @note This setting is global; it impacts all current
3058 * and future CLI sessions.
3061 vlib_unix_cli_set_prompt (char *prompt)
3063 char *fmt = (prompt[strlen (prompt) - 1] == ' ') ? "%s" : "%s ";
3064 unix_cli_main_t *cm = &unix_cli_main;
3066 vec_free (cm->cli_prompt);
3067 cm->cli_prompt = format (0, fmt, prompt);
3070 /** CLI command to quit the terminal session.
3071 * @note If this is a stdin session then this will
3072 * shutdown VPP also.
3074 static clib_error_t *
3075 unix_cli_quit (vlib_main_t * vm,
3076 unformat_input_t * input, vlib_cli_command_t * cmd)
3078 unix_cli_main_t *cm = &unix_cli_main;
3079 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
3080 cm->current_input_file_index);
3082 /* Cosmetic: suppress the final prompt from appearing before we die */
3083 cf->is_interactive = 0;
3086 vlib_process_signal_event (vm,
3087 vlib_current_process (vm),
3088 UNIX_CLI_PROCESS_EVENT_QUIT,
3089 cm->current_input_file_index);
3094 * Terminates the current CLI session.
3096 * If VPP is running in @em interactive mode and this is the console session
3097 * (that is, the session on @c stdin) then this will also terminate VPP.
3100 VLIB_CLI_COMMAND (unix_cli_quit_command, static) = {
3102 .short_help = "Exit CLI",
3103 .function = unix_cli_quit,
3108 VLIB_CLI_COMMAND (unix_cli_q_command, static) = {
3110 .short_help = "Exit CLI",
3111 .function = unix_cli_quit,
3115 /** CLI command to execute a VPP command script. */
3116 static clib_error_t *
3117 unix_cli_exec (vlib_main_t * vm,
3118 unformat_input_t * input, vlib_cli_command_t * cmd)
3122 unformat_input_t sub_input;
3123 clib_error_t *error;
3129 if (!unformat (input, "%s", &file_name))
3131 error = clib_error_return (0, "expecting file name, got `%U'",
3132 format_unformat_error, input);
3136 fd = open (file_name, O_RDONLY);
3139 error = clib_error_return_unix (0, "failed to open `%s'", file_name);
3143 /* Make sure its a regular file. */
3147 if (fstat (fd, &s) < 0)
3149 error = clib_error_return_unix (0, "failed to stat `%s'", file_name);
3153 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
3155 error = clib_error_return (0, "not a regular file `%s'", file_name);
3160 unformat_init_clib_file (&sub_input, fd);
3162 vlib_cli_input (vm, &sub_input, 0, 0);
3163 unformat_free (&sub_input);
3168 vec_free (file_name);
3174 * Executes a sequence of CLI commands which are read from a file. If
3175 * a command is unrecognised or otherwise invalid then the usual CLI
3176 * feedback will be generated, however execution of subsequent commands
3177 * from the file will continue.
3179 * The VPP code is indifferent to the file location. However, if SELinux
3180 * is enabled, then the file needs to have an SELinux label the VPP
3181 * process is allowed to access. For example, if a file is created in
3182 * '<em>/usr/share/vpp/</em>', it will be allowed. However, files manually
3183 * created in '/tmp/' or '/home/<user>/' will not be accessible by the VPP
3184 * process when SELinux is enabled.
3189 * <b><em>$ cat /usr/share/vpp/scripts/gigup.txt</em></b>
3190 * set interface state GigabitEthernet0/8/0 up
3191 * set interface state GigabitEthernet0/9/0 up
3193 * Example of how to execute a set of CLI commands from a file:
3194 * @cliexcmd{exec /usr/share/vpp/scripts/gigup.txt}
3197 VLIB_CLI_COMMAND (cli_exec, static) = {
3199 .short_help = "exec <filename>",
3200 .function = unix_cli_exec,
3205 /** CLI command to show various unix error statistics. */
3206 static clib_error_t *
3207 unix_show_errors (vlib_main_t * vm,
3208 unformat_input_t * input, vlib_cli_command_t * cmd)
3210 unix_main_t *um = &unix_main;
3211 clib_error_t *error = 0;
3212 int i, n_errors_to_show;
3213 unix_error_history_t *unix_errors = 0;
3215 n_errors_to_show = 1 << 30;
3217 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3219 if (!unformat (input, "%d", &n_errors_to_show))
3222 clib_error_return (0,
3223 "expecting integer number of errors to show, got `%U'",
3224 format_unformat_error, input);
3230 clib_min (ARRAY_LEN (um->error_history), n_errors_to_show);
3233 um->error_history_index >
3234 0 ? um->error_history_index - 1 : ARRAY_LEN (um->error_history) - 1;
3236 while (n_errors_to_show > 0)
3238 unix_error_history_t *eh = um->error_history + i;
3243 vec_add1 (unix_errors, eh[0]);
3244 n_errors_to_show -= 1;
3246 i = ARRAY_LEN (um->error_history) - 1;
3251 if (vec_len (unix_errors) == 0)
3252 vlib_cli_output (vm, "no Unix errors so far");
3255 vlib_cli_output (vm, "%Ld total errors seen", um->n_total_errors);
3256 for (i = vec_len (unix_errors) - 1; i >= 0; i--)
3258 unix_error_history_t *eh = vec_elt_at_index (unix_errors, i);
3259 vlib_cli_output (vm, "%U: %U",
3260 format_time_interval, "h:m:s:u", eh->time,
3261 format_clib_error, eh->error);
3263 vlib_cli_output (vm, "%U: time now",
3264 format_time_interval, "h:m:s:u", vlib_time_now (vm));
3268 vec_free (unix_errors);
3273 VLIB_CLI_COMMAND (cli_unix_show_errors, static) = {
3274 .path = "show unix errors",
3275 .short_help = "Show Unix system call error history",
3276 .function = unix_show_errors,
3280 /** CLI command to show various unix error statistics. */
3281 static clib_error_t *
3282 unix_show_files (vlib_main_t * vm,
3283 unformat_input_t * input, vlib_cli_command_t * cmd)
3285 clib_error_t *error = 0;
3286 clib_file_main_t *fm = &file_main;
3288 char path[PATH_MAX];
3291 vlib_cli_output (vm, "%3s %6s %12s %12s %12s %-32s %s", "FD", "Thread",
3292 "Read", "Write", "Error", "File Name", "Description");
3295 pool_foreach (f, fm->file_pool,(
3298 s = format (s, "/proc/self/fd/%d%c", f->file_descriptor, 0);
3299 rv = readlink((char *) s, path, PATH_MAX - 1);
3301 path[rv < 0 ? 0 : rv] = 0;
3303 vlib_cli_output (vm, "%3d %6d %12d %12d %12d %-32s %v",
3304 f->file_descriptor, f->polling_thread_index,
3305 f->read_events, f->write_events, f->error_events,
3306 path, f->description);
3307 vec_reset_length (s);
3316 VLIB_CLI_COMMAND (cli_unix_show_files, static) = {
3317 .path = "show unix files",
3318 .short_help = "Show Unix files in use",
3319 .function = unix_show_files,
3323 /** CLI command to show session command history. */
3324 static clib_error_t *
3325 unix_cli_show_history (vlib_main_t * vm,
3326 unformat_input_t * input, vlib_cli_command_t * cmd)
3328 unix_cli_main_t *cm = &unix_cli_main;
3329 unix_cli_file_t *cf;
3332 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3334 if (!cf->is_interactive)
3335 return clib_error_return (0, "invalid for non-interactive sessions");
3337 if (cf->has_history && cf->history_limit)
3339 i = 1 + cf->command_number - vec_len (cf->command_history);
3340 for (j = 0; j < vec_len (cf->command_history); j++)
3341 vlib_cli_output (vm, "%d %v\n", i + j, cf->command_history[j]);
3345 vlib_cli_output (vm, "History not enabled.\n");
3352 * Displays the command history for the current session, if any.
3355 VLIB_CLI_COMMAND (cli_unix_cli_show_history, static) = {
3357 .short_help = "Show current session command history",
3358 .function = unix_cli_show_history,
3362 /** CLI command to show terminal status. */
3363 static clib_error_t *
3364 unix_cli_show_terminal (vlib_main_t * vm,
3365 unformat_input_t * input, vlib_cli_command_t * cmd)
3367 unix_main_t *um = &unix_main;
3368 unix_cli_main_t *cm = &unix_cli_main;
3369 unix_cli_file_t *cf;
3372 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3373 n = vlib_get_node (vm, cf->process_node_index);
3375 vlib_cli_output (vm, "Terminal name: %v\n", n->name);
3376 vlib_cli_output (vm, "Terminal mode: %s\n", cf->line_mode ?
3377 "line-by-line" : "char-by-char");
3378 vlib_cli_output (vm, "Terminal width: %d\n", cf->width);
3379 vlib_cli_output (vm, "Terminal height: %d\n", cf->height);
3380 vlib_cli_output (vm, "ANSI capable: %s\n",
3381 cf->ansi_capable ? "yes" : "no");
3382 vlib_cli_output (vm, "Interactive: %s\n",
3383 cf->is_interactive ? "yes" : "no");
3384 vlib_cli_output (vm, "History enabled: %s%s\n",
3385 cf->has_history ? "yes" : "no", !cf->has_history
3386 || cf->history_limit ? "" :
3387 " (disabled by history limit)");
3388 if (cf->has_history)
3389 vlib_cli_output (vm, "History limit: %d\n", cf->history_limit);
3390 vlib_cli_output (vm, "Pager enabled: %s%s%s\n",
3391 cf->no_pager ? "no" : "yes",
3393 || cf->height ? "" : " (disabled by terminal height)",
3395 || um->cli_pager_buffer_limit ? "" :
3396 " (disabled by buffer limit)");
3398 vlib_cli_output (vm, "Pager limit: %d\n", um->cli_pager_buffer_limit);
3399 vlib_cli_output (vm, "CRLF mode: %s\n",
3400 cf->crlf_mode ? "CR+LF" : "LF");
3406 * Displays various information about the state of the current terminal
3410 * @cliexstart{show terminal}
3411 * Terminal name: unix-cli-stdin
3412 * Terminal mode: char-by-char
3413 * Terminal width: 123
3414 * Terminal height: 48
3417 * History enabled: yes
3419 * Pager enabled: yes
3420 * Pager limit: 100000
3425 VLIB_CLI_COMMAND (cli_unix_cli_show_terminal, static) = {
3426 .path = "show terminal",
3427 .short_help = "Show current session terminal settings",
3428 .function = unix_cli_show_terminal,
3432 /** CLI command to display a list of CLI sessions. */
3433 static clib_error_t *
3434 unix_cli_show_cli_sessions (vlib_main_t * vm,
3435 unformat_input_t * input,
3436 vlib_cli_command_t * cmd)
3438 unix_cli_main_t *cm = &unix_cli_main;
3439 clib_file_main_t *fm = &file_main;
3440 unix_cli_file_t *cf;
3444 vlib_cli_output (vm, "%-5s %-5s %-20s %s", "PNI", "FD", "Name", "Flags");
3446 #define fl(x, y) ( (x) ? toupper((y)) : tolower((y)) )
3448 pool_foreach (cf, cm->cli_file_pool, ({
3449 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3450 n = vlib_get_node (vm, cf->process_node_index);
3451 vlib_cli_output (vm,
3452 "%-5d %-5d %-20v %c%c%c%c%c\n",
3453 cf->process_node_index,
3454 uf->file_descriptor,
3456 fl (cf->is_interactive, 'i'),
3457 fl (cf->is_socket, 's'),
3458 fl (cf->line_mode, 'l'),
3459 fl (cf->has_epipe, 'p'),
3460 fl (cf->ansi_capable, 'a'));
3469 * Displays a summary of all the current CLI sessions.
3471 * Typically used to diagnose connection issues with the CLI
3475 * @cliexstart{show cli-sessions}
3477 * 343 0 unix-cli-stdin IslpA
3478 * 344 7 unix-cli-local:20 ISlpA
3479 * 346 8 unix-cli-local:21 iSLpa
3482 * In this example we have the debug console of the running process
3483 * on stdin/out, we have an interactive socket session and we also
3484 * have a non-interactive socket session.
3488 * - @em PNI: Process node index.
3489 * - @em FD: Unix file descriptor.
3490 * - @em Name: Name of the session.
3491 * - @em Flags: Various flags that describe the state of the session.
3493 * @em Flags have the following meanings; lower-case typically negates
3496 * - @em I Interactive session.
3497 * - @em S Connected by socket.
3498 * - @em s Not a socket, likely stdin.
3499 * - @em L Line-by-line mode.
3500 * - @em l Char-by-char mode.
3501 * - @em P EPIPE detected on connection; it will close soon.
3502 * - @em A ANSI-capable terminal.
3505 VLIB_CLI_COMMAND (cli_unix_cli_show_cli_sessions, static) = {
3506 .path = "show cli-sessions",
3507 .short_help = "Show current CLI sessions",
3508 .function = unix_cli_show_cli_sessions,
3512 /** CLI command to set terminal pager settings. */
3513 static clib_error_t *
3514 unix_cli_set_terminal_pager (vlib_main_t * vm,
3515 unformat_input_t * input,
3516 vlib_cli_command_t * cmd)
3518 unix_main_t *um = &unix_main;
3519 unix_cli_main_t *cm = &unix_cli_main;
3520 unix_cli_file_t *cf;
3521 unformat_input_t _line_input, *line_input = &_line_input;
3522 clib_error_t *error = 0;
3524 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3526 if (!cf->is_interactive)
3527 return clib_error_return (0, "invalid for non-interactive sessions");
3529 if (!unformat_user (input, unformat_line_input, line_input))
3532 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3534 if (unformat (line_input, "on"))
3536 else if (unformat (line_input, "off"))
3538 else if (unformat (line_input, "limit %u", &um->cli_pager_buffer_limit))
3539 vlib_cli_output (vm,
3540 "Pager limit set to %u lines; note, this is global.\n",
3541 um->cli_pager_buffer_limit);
3544 error = clib_error_return (0, "unknown parameter: `%U`",
3545 format_unformat_error, line_input);
3551 unformat_free (line_input);
3557 * Enables or disables the terminal pager for this session. Generally
3558 * this defaults to enabled.
3560 * Additionally allows the pager buffer size to be set; though note that
3561 * this value is set globally and not per session.
3564 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager, static) = {
3565 .path = "set terminal pager",
3566 .short_help = "set terminal pager [on|off] [limit <lines>]",
3567 .function = unix_cli_set_terminal_pager,
3571 /** CLI command to set terminal history settings. */
3572 static clib_error_t *
3573 unix_cli_set_terminal_history (vlib_main_t * vm,
3574 unformat_input_t * input,
3575 vlib_cli_command_t * cmd)
3577 unix_cli_main_t *cm = &unix_cli_main;
3578 unix_cli_file_t *cf;
3579 unformat_input_t _line_input, *line_input = &_line_input;
3581 clib_error_t *error = 0;
3583 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3585 if (!cf->is_interactive)
3586 return clib_error_return (0, "invalid for non-interactive sessions");
3588 if (!unformat_user (input, unformat_line_input, line_input))
3591 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3593 if (unformat (line_input, "on"))
3594 cf->has_history = 1;
3595 else if (unformat (line_input, "off"))
3596 cf->has_history = 0;
3597 else if (unformat (line_input, "limit %u", &cf->history_limit))
3601 error = clib_error_return (0, "unknown parameter: `%U`",
3602 format_unformat_error, line_input);
3606 /* If we reduced history size, or turned it off, purge the history */
3607 limit = cf->has_history ? cf->history_limit : 0;
3609 while (cf->command_history && vec_len (cf->command_history) >= limit)
3611 vec_free (cf->command_history[0]);
3612 vec_delete (cf->command_history, 1, 0);
3617 unformat_free (line_input);
3623 * Enables or disables the command history function of the current
3624 * terminal. Generally this defaults to enabled.
3626 * This command also allows the maximum size of the history buffer for
3627 * this session to be altered.
3630 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history, static) = {
3631 .path = "set terminal history",
3632 .short_help = "set terminal history [on|off] [limit <lines>]",
3633 .function = unix_cli_set_terminal_history,
3637 /** CLI command to set terminal ANSI settings. */
3638 static clib_error_t *
3639 unix_cli_set_terminal_ansi (vlib_main_t * vm,
3640 unformat_input_t * input,
3641 vlib_cli_command_t * cmd)
3643 unix_cli_main_t *cm = &unix_cli_main;
3644 unix_cli_file_t *cf;
3646 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3648 if (!cf->is_interactive)
3649 return clib_error_return (0, "invalid for non-interactive sessions");
3651 if (unformat (input, "on"))
3652 cf->ansi_capable = 1;
3653 else if (unformat (input, "off"))
3654 cf->ansi_capable = 0;
3656 return clib_error_return (0, "unknown parameter: `%U`",
3657 format_unformat_error, input);
3663 * Enables or disables the use of ANSI control sequences by this terminal.
3664 * The default will vary based on terminal detection at the start of the
3667 * ANSI control sequences are used in a small number of places to provide,
3668 * for example, color text output and to control the cursor in the pager.
3671 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi, static) = {
3672 .path = "set terminal ansi",
3673 .short_help = "set terminal ansi [on|off]",
3674 .function = unix_cli_set_terminal_ansi,
3678 static clib_error_t *
3679 unix_cli_init (vlib_main_t * vm)
3684 VLIB_INIT_FUNCTION (unix_cli_init);
3687 * fd.io coding-style-patch-verification: ON
3690 * eval: (c-set-style "gnu")