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>
57 #include <arpa/telnet.h>
58 #include <sys/ioctl.h>
59 #include <sys/types.h>
62 #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_ERASEWORDLEFT, /**< Erase word left */
297 UNIX_CLI_PARSE_ACTION_CLEAR, /**< Clear the terminal */
298 UNIX_CLI_PARSE_ACTION_REVSEARCH, /**< Search backwards in command history */
299 UNIX_CLI_PARSE_ACTION_FWDSEARCH, /**< Search forwards in command history */
300 UNIX_CLI_PARSE_ACTION_YANK, /**< Undo last erase action */
301 UNIX_CLI_PARSE_ACTION_TELNETIAC, /**< Telnet control code */
303 UNIX_CLI_PARSE_ACTION_PAGER_CRLF, /**< Enter pressed (CR, CRLF, LF, etc) */
304 UNIX_CLI_PARSE_ACTION_PAGER_QUIT, /**< Exit the pager session */
305 UNIX_CLI_PARSE_ACTION_PAGER_NEXT, /**< Scroll to next page */
306 UNIX_CLI_PARSE_ACTION_PAGER_DN, /**< Scroll to next line */
307 UNIX_CLI_PARSE_ACTION_PAGER_UP, /**< Scroll to previous line */
308 UNIX_CLI_PARSE_ACTION_PAGER_TOP, /**< Scroll to first line */
309 UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM, /**< Scroll to last line */
310 UNIX_CLI_PARSE_ACTION_PAGER_PGDN, /**< Scroll to next page */
311 UNIX_CLI_PARSE_ACTION_PAGER_PGUP, /**< Scroll to previous page */
312 UNIX_CLI_PARSE_ACTION_PAGER_REDRAW, /**< Clear and redraw the page on the terminal */
313 UNIX_CLI_PARSE_ACTION_PAGER_SEARCH, /**< Search the pager buffer */
315 UNIX_CLI_PARSE_ACTION_PARTIALMATCH, /**< Action parser found a partial match */
316 UNIX_CLI_PARSE_ACTION_NOMATCH /**< Action parser did not find any match */
317 } unix_cli_parse_action_t;
319 /** @brief Mapping of input buffer strings to action values.
320 * @note This won't work as a hash since we need to be able to do
321 * partial matches on the string.
325 u8 *input; /**< Input string to match. */
326 u32 len; /**< Length of input without final NUL. */
327 unix_cli_parse_action_t action; /**< Action to take when matched. */
328 } unix_cli_parse_actions_t;
330 /** @brief Given a capital ASCII letter character return a @c NUL terminated
331 * string with the control code for that letter.
333 * @param c An ASCII character.
334 * @return A @c NUL terminated string of type @c u8[].
337 * @c CTL('A') returns <code>{ 0x01, 0x00 }</code> as a @c u8[].
339 #define CTL(c) (u8[]){ (c) - '@', 0 }
341 #define _(a,b) { .input = (u8 *)(a), .len = sizeof(a) - 1, .action = (b) }
343 * Patterns to match on a CLI input stream.
346 static unix_cli_parse_actions_t unix_cli_parse_strings[] = {
348 _("\r\n", UNIX_CLI_PARSE_ACTION_CRLF), /* Must be before '\r' */
349 _("\n", UNIX_CLI_PARSE_ACTION_CRLF),
350 _("\r\0", UNIX_CLI_PARSE_ACTION_CRLF), /* Telnet does this */
351 _("\r", UNIX_CLI_PARSE_ACTION_CRLF),
353 /* Unix shell control codes */
354 _(CTL ('B'), UNIX_CLI_PARSE_ACTION_LEFT),
355 _(CTL ('F'), UNIX_CLI_PARSE_ACTION_RIGHT),
356 _(CTL ('P'), UNIX_CLI_PARSE_ACTION_UP),
357 _(CTL ('N'), UNIX_CLI_PARSE_ACTION_DOWN),
358 _(CTL ('A'), UNIX_CLI_PARSE_ACTION_HOME),
359 _(CTL ('E'), UNIX_CLI_PARSE_ACTION_END),
360 _(CTL ('D'), UNIX_CLI_PARSE_ACTION_ERASERIGHT),
361 _(CTL ('U'), UNIX_CLI_PARSE_ACTION_ERASELINELEFT),
362 _(CTL ('K'), UNIX_CLI_PARSE_ACTION_ERASELINERIGHT),
363 _(CTL ('W'), UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT),
364 _(CTL ('Y'), UNIX_CLI_PARSE_ACTION_YANK),
365 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_CLEAR),
366 _(ESC "b", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* Alt-B */
367 _(ESC "f", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* Alt-F */
368 _("\b", UNIX_CLI_PARSE_ACTION_ERASE), /* ^H */
369 _("\x7f", UNIX_CLI_PARSE_ACTION_ERASE), /* Backspace */
370 _("\t", UNIX_CLI_PARSE_ACTION_TAB), /* ^I */
372 /* VT100 Normal mode - Broadest support */
373 _(CSI "A", UNIX_CLI_PARSE_ACTION_UP),
374 _(CSI "B", UNIX_CLI_PARSE_ACTION_DOWN),
375 _(CSI "C", UNIX_CLI_PARSE_ACTION_RIGHT),
376 _(CSI "D", UNIX_CLI_PARSE_ACTION_LEFT),
377 _(CSI "H", UNIX_CLI_PARSE_ACTION_HOME),
378 _(CSI "F", UNIX_CLI_PARSE_ACTION_END),
379 _(CSI "3~", UNIX_CLI_PARSE_ACTION_ERASERIGHT), /* Delete */
380 _(CSI "1;5D", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* C-Left */
381 _(CSI "1;5C", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* C-Right */
383 /* VT100 Application mode - Some Gnome Terminal functions use these */
384 _(ESC "OA", UNIX_CLI_PARSE_ACTION_UP),
385 _(ESC "OB", UNIX_CLI_PARSE_ACTION_DOWN),
386 _(ESC "OC", UNIX_CLI_PARSE_ACTION_RIGHT),
387 _(ESC "OD", UNIX_CLI_PARSE_ACTION_LEFT),
388 _(ESC "OH", UNIX_CLI_PARSE_ACTION_HOME),
389 _(ESC "OF", UNIX_CLI_PARSE_ACTION_END),
391 /* ANSI X3.41-1974 - sent by Microsoft Telnet and PuTTY */
392 _(CSI "1~", UNIX_CLI_PARSE_ACTION_HOME),
393 _(CSI "4~", UNIX_CLI_PARSE_ACTION_END),
395 /* Emacs-ish history search */
396 _(CTL ('S'), UNIX_CLI_PARSE_ACTION_FWDSEARCH),
397 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_REVSEARCH),
399 /* Other protocol things */
400 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
401 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
402 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
406 * Patterns to match when a CLI session is in the pager.
409 static unix_cli_parse_actions_t unix_cli_parse_pager[] = {
411 _("\r\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Must be before '\r' */
412 _("\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
413 _("\r\0", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Telnet does this */
414 _("\r", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
417 _(" ", UNIX_CLI_PARSE_ACTION_PAGER_NEXT),
418 _("q", UNIX_CLI_PARSE_ACTION_PAGER_QUIT),
419 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
420 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
421 _("/", UNIX_CLI_PARSE_ACTION_PAGER_SEARCH),
424 _(CSI "A", UNIX_CLI_PARSE_ACTION_PAGER_UP),
425 _(CSI "B", UNIX_CLI_PARSE_ACTION_PAGER_DN),
426 _(CSI "H", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
427 _(CSI "F", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
429 /* VT100 Application mode */
430 _(ESC "OA", UNIX_CLI_PARSE_ACTION_PAGER_UP),
431 _(ESC "OB", UNIX_CLI_PARSE_ACTION_PAGER_DN),
432 _(ESC "OH", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
433 _(ESC "OF", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
435 /* ANSI X3.41-1974 */
436 _(CSI "1~", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
437 _(CSI "4~", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
438 _(CSI "5~", UNIX_CLI_PARSE_ACTION_PAGER_PGUP),
439 _(CSI "6~", UNIX_CLI_PARSE_ACTION_PAGER_PGDN),
441 /* Other protocol things */
442 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
443 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
444 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
449 /** CLI session events. */
452 UNIX_CLI_PROCESS_EVENT_READ_READY, /**< A file descriptor has data to be read. */
453 UNIX_CLI_PROCESS_EVENT_QUIT, /**< A CLI session wants to close. */
454 } unix_cli_process_event_type_t;
456 /** CLI session telnet negotiation timer events. */
459 UNIX_CLI_NEW_SESSION_EVENT_ADD, /**< Add a CLI session to the new session list */
460 } unix_cli_timeout_event_type_t;
462 /** Each new session is stored on a list with a deadline after which
463 * a prompt is issued, in case the session TELNET negotiation fails to
467 uword cf_index; /**< Session index of the new session. */
468 f64 deadline; /**< Deadline after which the new session must have a prompt. */
469 } unix_cli_new_session_t;
471 /** CLI global state. */
474 /** Prompt string for CLI. */
477 /** Vec pool of CLI sessions. */
478 unix_cli_file_t *cli_file_pool;
480 /** Vec pool of unused session indices. */
481 u32 *unused_cli_process_node_indices;
483 /** The session index of the stdin cli */
484 u32 stdin_cli_file_index;
486 /** File pool index of current input. */
487 u32 current_input_file_index;
489 /** New session process node identifier */
490 u32 new_session_process_node_index;
492 /** List of new sessions */
493 unix_cli_new_session_t *new_sessions;
496 /** CLI global state */
497 static unix_cli_main_t unix_cli_main;
500 * @brief Search for a byte sequence in the action list.
502 * Searches the @ref unix_cli_parse_actions_t list in @a a for a match with
503 * the bytes in @a input of maximum length @a ilen bytes.
504 * When a match is made @a *matched indicates how many bytes were matched.
505 * Returns a value from the enum @ref unix_cli_parse_action_t to indicate
506 * whether no match was found, a partial match was found or a complete
507 * match was found and what action, if any, should be taken.
509 * @param[in] a Actions list to search within.
510 * @param[in] input String fragment to search for.
511 * @param[in] ilen Length of the string in 'input'.
512 * @param[out] matched Pointer to an integer that will contain the number
513 * of bytes matched when a complete match is found.
515 * @return Action from @ref unix_cli_parse_action_t that the string fragment
517 * @ref UNIX_CLI_PARSE_ACTION_PARTIALMATCH is returned when the
518 * whole input string matches the start of at least one action.
519 * @ref UNIX_CLI_PARSE_ACTION_NOMATCH is returned when there is no
522 static unix_cli_parse_action_t
523 unix_cli_match_action (unix_cli_parse_actions_t * a,
524 u8 * input, u32 ilen, i32 * matched)
532 /* see if the start of the input buffer exactly matches the current
534 if (memcmp (input, a->input, a->len) == 0)
542 /* if the first ilen characters match, flag this as a partial -
543 * meaning keep collecting bytes in case of a future match */
544 if (memcmp (input, a->input, ilen) == 0)
548 /* check next action */
553 UNIX_CLI_PARSE_ACTION_PARTIALMATCH : UNIX_CLI_PARSE_ACTION_NOMATCH;
557 /** Add bytes to the output vector and then flagg the I/O system that bytes
558 * are available to be sent.
561 unix_cli_add_pending_output (clib_file_t * uf,
562 unix_cli_file_t * cf,
563 u8 * buffer, uword buffer_bytes)
565 clib_file_main_t *fm = &file_main;
567 vec_add (cf->output_vector, buffer, buffer_bytes);
568 if (vec_len (cf->output_vector) > 0)
570 int skip_update = 0 != (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
571 uf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
573 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
577 /** Delete all bytes from the output vector and flag the I/O system
578 * that no more bytes are available to be sent.
581 unix_cli_del_pending_output (clib_file_t * uf,
582 unix_cli_file_t * cf, uword n_bytes)
584 clib_file_main_t *fm = &file_main;
586 vec_delete (cf->output_vector, n_bytes, 0);
587 if (vec_len (cf->output_vector) <= 0)
589 int skip_update = 0 == (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
590 uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
592 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
596 /** @brief A bit like strchr with a buffer length limit.
597 * Search a buffer for the first instance of a character up to the limit of
598 * the buffer length. If found then return the position of that character.
600 * The key departure from strchr is that if the character is not found then
601 * return the buffer length.
603 * @param chr The byte value to search for.
604 * @param str The buffer in which to search for the value.
605 * @param len The depth into the buffer to search.
607 * @return The index of the first occurrence of \c chr. If \c chr is not
608 * found then \c len instead.
611 unix_vlib_findchr (u8 chr, u8 * str, word len)
614 for (i = 0; i < len; i++, str++)
622 /** @brief Send a buffer to the CLI stream if possible, enqueue it otherwise.
623 * Attempts to write given buffer to the file descriptor of the given
624 * Unix CLI session. If that session already has data in the output buffer
625 * or if the write attempt tells us to try again later then the given buffer
626 * is appended to the pending output buffer instead.
628 * This is typically called only from \c unix_vlib_cli_output_cooked since
629 * that is where CRLF handling occurs or from places where we explicitly do
630 * not want cooked handling.
632 * @param cf Unix CLI session of the desired stream to write to.
633 * @param uf The Unix file structure of the desired stream to write to.
634 * @param buffer Pointer to the buffer that needs to be written.
635 * @param buffer_bytes The number of bytes from \c buffer to write.
638 unix_vlib_cli_output_raw (unix_cli_file_t * cf,
639 clib_file_t * uf, u8 * buffer, uword buffer_bytes)
643 if (cf->has_epipe) /* don't try writing anything */
646 if (vec_len (cf->output_vector) == 0)
649 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
650 n = send (uf->file_descriptor, buffer, buffer_bytes, MSG_NOSIGNAL);
652 n = write (uf->file_descriptor, buffer, buffer_bytes);
655 if (n < 0 && errno != EAGAIN)
659 /* connection closed on us */
660 unix_main_t *um = &unix_main;
662 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
663 UNIX_CLI_PROCESS_EVENT_QUIT,
668 clib_unix_warning ("write");
671 else if ((word) n < (word) buffer_bytes)
673 /* We got EAGAIN or we already have stuff in the buffer;
674 * queue up whatever didn't get sent for later. */
677 unix_cli_add_pending_output (uf, cf, buffer + n, buffer_bytes - n);
681 /** @brief Process a buffer for CRLF handling before outputting it to the CLI.
683 * @param cf Unix CLI session of the desired stream to write to.
684 * @param uf The Unix file structure of the desired stream to write to.
685 * @param buffer Pointer to the buffer that needs to be written.
686 * @param buffer_bytes The number of bytes from \c buffer to write.
689 unix_vlib_cli_output_cooked (unix_cli_file_t * cf,
691 u8 * buffer, uword buffer_bytes)
693 word end = 0, start = 0;
695 while (end < buffer_bytes)
699 /* iterate the line on \n's so we can insert a \r before it */
700 end = unix_vlib_findchr ('\n',
702 buffer_bytes - start) + start;
706 /* otherwise just send the whole buffer */
710 unix_vlib_cli_output_raw (cf, uf, buffer + start, end - start);
714 if (end < buffer_bytes)
716 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\r\n", 2);
717 end++; /* skip the \n that we already sent */
723 /* Use the last character to determine the last direction of the cursor. */
724 if (buffer_bytes > 0)
725 cf->cursor_direction = (buffer[buffer_bytes - 1] == (u8) '\b');
728 /** @brief Moves the terminal cursor one character to the left, with
729 * special handling when it reaches the left edge of the terminal window.
731 * Ordinarily we can simply send a '\b' to move the cursor left, however
732 * most terminals will not reverse-wrap to the end of the previous line
733 * if the cursor is in the left-most column. To counter this we must
734 * check the cursor position + prompt length modulo terminal width and
735 * if available use some other means, such as ANSI terminal escape
736 * sequences, to move the cursor.
738 * @param cf Unix CLI session of the desired stream to write to.
739 * @param uf The Unix file structure of the desired stream to write to.
742 unix_vlib_cli_output_cursor_left (unix_cli_file_t * cf, clib_file_t * uf)
744 unix_cli_main_t *cm = &unix_cli_main;
745 static u8 *ansi = 0; /* assumes no reentry */
748 if (!cf->is_interactive || !cf->ansi_capable || !cf->width)
750 /* No special handling for dumb terminals */
751 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
755 position = ((u32) vec_len (cm->cli_prompt) + cf->cursor) % cf->width;
759 /* No special handling required if we're not at the left edge */
760 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
764 if (!cf->cursor_direction)
766 /* Special handling for when we are at the left edge but
767 * the cursor was going left-to-right, but in this situation
768 * xterm-like terminals actually hide the cursor off the right
769 * edge. A \b here seems to jump one char too many, so let's
770 * force the cursor onto the next line instead.
772 if (cf->cursor < vec_len (cf->current_command))
773 unix_vlib_cli_output_cooked (cf, uf, &cf->current_command[cf->cursor],
776 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
777 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
780 /* Relocate the cursor at the right hand edge one line above */
781 ansi = format (ansi, CSI "A" CSI "%dC", cf->width - 1);
782 unix_vlib_cli_output_cooked (cf, uf, ansi, vec_len (ansi));
783 vec_reset_length (ansi); /* keep the vec around for next time */
784 cf->cursor_direction = 1; /* going backwards now */
787 /** @brief Output the CLI prompt */
789 unix_cli_cli_prompt (unix_cli_file_t * cf, clib_file_t * uf)
791 unix_cli_main_t *cm = &unix_cli_main;
793 if (cf->is_interactive) /* Only interactive sessions get a prompt */
794 unix_vlib_cli_output_raw (cf, uf, cm->cli_prompt,
795 vec_len (cm->cli_prompt));
798 /** @brief Output a pager prompt and show number of buffered lines */
800 unix_cli_pager_prompt (unix_cli_file_t * cf, clib_file_t * uf)
805 h = cf->pager_start + (cf->height - 1);
806 if (h > vec_len (cf->pager_index))
807 h = vec_len (cf->pager_index);
809 prompt = format (0, "\r%s-- more -- (%d-%d/%d)%s",
810 cf->ansi_capable ? ANSI_BOLD : "",
813 vec_len (cf->pager_index),
814 cf->ansi_capable ? ANSI_RESET : "");
816 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
821 /** @brief Output a pager "skipping" message */
823 unix_cli_pager_message (unix_cli_file_t * cf, clib_file_t * uf,
824 char *message, char *postfix)
828 prompt = format (0, "\r%s-- %s --%s%s",
829 cf->ansi_capable ? ANSI_BOLD : "",
830 message, cf->ansi_capable ? ANSI_RESET : "", postfix);
832 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
837 /** @brief Erase the printed pager prompt */
839 unix_cli_pager_prompt_erase (unix_cli_file_t * cf, clib_file_t * uf)
841 if (cf->ansi_capable)
843 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
844 unix_vlib_cli_output_cooked (cf, uf,
845 (u8 *) ANSI_CLEARLINE,
846 sizeof (ANSI_CLEARLINE) - 1);
852 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
853 for (i = 0; i < cf->width - 1; i++)
854 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
855 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
859 /** @brief Uses an ANSI escape sequence to move the cursor */
861 unix_cli_ansi_cursor (unix_cli_file_t * cf, clib_file_t * uf, u16 x, u16 y)
865 str = format (0, "%s%d;%dH", CSI, y, x);
867 unix_vlib_cli_output_cooked (cf, uf, str, vec_len (str));
872 /** Redraw the currently displayed page of text.
873 * @param cf CLI session to redraw the pager buffer of.
874 * @param uf Unix file of the CLI session.
877 unix_cli_pager_redraw (unix_cli_file_t * cf, clib_file_t * uf)
879 unix_cli_pager_index_t *pi = NULL;
883 /* No active pager? Do nothing. */
884 if (!vec_len (cf->pager_index))
887 if (cf->ansi_capable)
889 /* If we have ANSI, send the clear screen sequence */
890 unix_vlib_cli_output_cooked (cf, uf,
892 sizeof (ANSI_CLEAR) - 1);
896 /* Otherwise make sure we're on a blank line */
897 unix_cli_pager_prompt_erase (cf, uf);
900 /* (Re-)send the current page of content */
901 for (i = 0; i < cf->height - 1 &&
902 i + cf->pager_start < vec_len (cf->pager_index); i++)
904 pi = &cf->pager_index[cf->pager_start + i];
905 line = cf->pager_vector[pi->line] + pi->offset;
907 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
909 /* if the last line didn't end in newline, add a newline */
910 if (pi && line[pi->length - 1] != '\n')
911 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
913 unix_cli_pager_prompt (cf, uf);
916 /** @brief Process and add a line to the pager index.
917 * In normal operation this function will take the given character string
918 * found in @c line and with length @c len_or_index and iterates the over the
919 * contents, adding each line of text discovered within it to the
920 * pager index. Lines are identified by newlines ("<code>\\n</code>") and by
921 * strings longer than the width of the terminal.
923 * If instead @c line is @c NULL then @c len_or_index is taken to mean the
924 * index of an existing line in the pager buffer; this simply means that the
925 * input line does not need to be cloned since we already have it. This is
926 * typical if we are reindexing the pager buffer.
928 * @param cf The CLI session whose pager we are adding to.
929 * @param line The string of text to be indexed into the pager buffer.
930 * If @c line is @c NULL then the mode of operation
931 * changes slightly; see the description above.
932 * @param len_or_index If @c line is a pointer to a string then this parameter
933 * indicates the length of that string; Otherwise this
934 * value provides the index in the pager buffer of an
935 * existing string to be indexed.
938 unix_cli_pager_add_line (unix_cli_file_t * cf, u8 * line, word len_or_index)
942 word line_index, len;
943 u32 width = cf->width;
944 unix_cli_pager_index_t *pi;
948 /* Use a line already in the pager buffer */
949 line_index = len_or_index;
950 if (cf->pager_vector != NULL)
951 p = cf->pager_vector[line_index];
957 /* Add a copy of the raw string to the pager buffer */
958 p = vec_new (u8, len);
959 clib_memcpy (p, line, len);
961 /* store in pager buffer */
962 line_index = vec_len (cf->pager_vector);
963 vec_add1 (cf->pager_vector, p);
969 /* Find the next line, or run to terminal width, or run to EOL */
971 j = unix_vlib_findchr ((u8) '\n', p, l < width ? l : width);
973 if (j < l && p[j] == '\n') /* incl \n */
976 /* Add the line to the index */
977 k = vec_len (cf->pager_index);
978 vec_validate (cf->pager_index, k);
979 pi = &cf->pager_index[k];
981 pi->line = line_index;
990 /** @brief Reindex entire pager buffer.
991 * Resets the current pager index and then re-adds the lines in the pager
992 * buffer to the index.
994 * Additionally this function attempts to retain the current page start
995 * line offset by searching for the same top-of-screen line in the new index.
997 * @param cf The CLI session whose pager buffer should be reindexed.
1000 unix_cli_pager_reindex (unix_cli_file_t * cf)
1002 word i, old_line, old_offset;
1003 unix_cli_pager_index_t *pi;
1005 /* If there is nothing in the pager buffer then make sure the index
1006 * is empty and move on.
1008 if (cf->pager_vector == 0)
1010 vec_reset_length (cf->pager_index);
1014 /* Retain a pointer to the current page start line so we can
1017 pi = &cf->pager_index[cf->pager_start];
1018 old_line = pi->line;
1019 old_offset = pi->offset;
1021 /* Re-add the buffered lines to the index */
1022 vec_reset_length (cf->pager_index);
1023 vec_foreach_index (i, cf->pager_vector)
1025 unix_cli_pager_add_line (cf, NULL, i);
1028 /* Attempt to re-locate the previously stored page start line */
1029 vec_foreach_index (i, cf->pager_index)
1031 pi = &cf->pager_index[i];
1033 if (pi->line == old_line &&
1034 (pi->offset <= old_offset || pi->offset + pi->length > old_offset))
1037 cf->pager_start = i;
1042 /* In case the start line was not found (rare), ensure the pager start
1043 * index is within bounds
1045 if (cf->pager_start >= vec_len (cf->pager_index))
1047 if (!cf->height || vec_len (cf->pager_index) < (cf->height - 1))
1048 cf->pager_start = 0;
1050 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
1054 /** VLIB CLI output function.
1056 * If the terminal has a pager configured then this function takes care
1057 * of collating output into the pager buffer; ensuring only the first page
1058 * is displayed and any lines in excess of the first page are buffered.
1060 * If the maximum number of index lines in the buffer is exceeded then the
1061 * pager is cancelled and the contents of the current buffer are sent to the
1064 * If there is no pager configured then the output is sent directly to the
1067 * @param cli_file_index Index of the CLI session where this output is
1069 * @param buffer String of printabe bytes to be output.
1070 * @param buffer_bytes The number of bytes in @c buffer to be output.
1073 unix_vlib_cli_output (uword cli_file_index, u8 * buffer, uword buffer_bytes)
1075 unix_main_t *um = &unix_main;
1076 clib_file_main_t *fm = &file_main;
1077 unix_cli_main_t *cm = &unix_cli_main;
1078 unix_cli_file_t *cf;
1081 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
1082 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1084 if (cf->no_pager || um->cli_pager_buffer_limit == 0 || cf->height == 0)
1086 unix_vlib_cli_output_cooked (cf, uf, buffer, buffer_bytes);
1090 word row = vec_len (cf->pager_index);
1092 unix_cli_pager_index_t *pi;
1094 /* Index and add the output lines to the pager buffer. */
1095 unix_cli_pager_add_line (cf, buffer, buffer_bytes);
1097 /* Now iterate what was added to display the lines.
1098 * If we reach the bottom of the page, display a prompt.
1100 while (row < vec_len (cf->pager_index))
1102 if (row < cf->height - 1)
1104 /* output this line */
1105 pi = &cf->pager_index[row];
1106 line = cf->pager_vector[pi->line] + pi->offset;
1107 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1109 /* if the last line didn't end in newline, and we're at the
1110 * bottom of the page, add a newline */
1111 if (line[pi->length - 1] != '\n' && row == cf->height - 2)
1112 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1116 /* Display the pager prompt every 10 lines */
1118 unix_cli_pager_prompt (cf, uf);
1123 /* Check if we went over the pager buffer limit */
1124 if (vec_len (cf->pager_index) > um->cli_pager_buffer_limit)
1126 /* Stop using the pager for the remainder of this CLI command */
1129 /* If we likely printed the prompt, erase it */
1130 if (vec_len (cf->pager_index) > cf->height - 1)
1131 unix_cli_pager_prompt_erase (cf, uf);
1133 /* Dump out the contents of the buffer */
1134 for (row = cf->pager_start + (cf->height - 1);
1135 row < vec_len (cf->pager_index); row++)
1137 pi = &cf->pager_index[row];
1138 line = cf->pager_vector[pi->line] + pi->offset;
1139 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1142 unix_cli_pager_reset (cf);
1147 /** Identify whether a terminal type is ANSI capable.
1149 * Compares the string given in @c term with a list of terminal types known
1150 * to support ANSI escape sequences.
1152 * This list contains, for example, @c xterm, @c screen and @c ansi.
1154 * @param term A string with a terminal type in it.
1155 * @param len The length of the string in @c term.
1157 * @return @c 1 if the terminal type is recognized as supporting ANSI
1158 * terminal sequences; @c 0 otherwise.
1161 unix_cli_terminal_type_ansi (u8 * term, uword len)
1163 /* This may later be better done as a hash of some sort. */
1165 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1170 _("xterm-256color"); /* iTerm on Mac */
1172 _("screen-256color"); /* Screen and tmux */
1173 _("ansi"); /* Microsoft Telnet */
1179 /** Identify whether a terminal type is non-interactive.
1181 * Compares the string given in @c term with a list of terminal types known
1182 * to be non-interactive, as send by tools such as @c vppctl .
1184 * This list contains, for example, @c vppctl.
1186 * @param term A string with a terminal type in it.
1187 * @param len The length of the string in @c term.
1189 * @return @c 1 if the terminal type is recognized as being non-interactive;
1193 unix_cli_terminal_type_noninteractive (u8 * term, uword len)
1195 /* This may later be better done as a hash of some sort. */
1197 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1206 /** Set a session to be non-interactive. */
1208 unix_cli_set_session_noninteractive (unix_cli_file_t * cf)
1210 /* Non-interactive sessions don't get these */
1211 cf->is_interactive = 0;
1213 cf->history_limit = 0;
1214 cf->has_history = 0;
1218 /** @brief Emit initial welcome banner and prompt on a connection. */
1220 unix_cli_file_welcome (unix_cli_main_t * cm, unix_cli_file_t * cf)
1222 unix_main_t *um = &unix_main;
1223 clib_file_main_t *fm = &file_main;
1224 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1225 unix_cli_banner_t *banner;
1228 /* Mark the session as started if we get here */
1231 if (!(cf->is_interactive)) /* No banner for non-interactive sessions */
1235 * Put the first bytes directly into the buffer so that further output is
1236 * queued until everything is ready. (oterwise initial prompt can appear
1237 * mid way through VPP initialization)
1239 unix_cli_add_pending_output (uf, cf, (u8 *) "\r", 1);
1241 if (!um->cli_no_banner)
1243 if (cf->ansi_capable)
1245 banner = unix_cli_banner_color;
1246 len = ARRAY_LEN (unix_cli_banner_color);
1250 banner = unix_cli_banner;
1251 len = ARRAY_LEN (unix_cli_banner);
1254 for (i = 0; i < len; i++)
1256 unix_vlib_cli_output_cooked (cf, uf,
1257 banner[i].line, banner[i].length);
1262 unix_cli_cli_prompt (cf, uf);
1267 * @brief A failsafe manager that ensures CLI sessions issue an initial
1268 * prompt if TELNET negotiation fails.
1271 unix_cli_new_session_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1274 unix_cli_main_t *cm = &unix_cli_main;
1275 uword event_type, *event_data = 0;
1280 if (vec_len (cm->new_sessions) > 0)
1281 wait = vlib_process_wait_for_event_or_clock (vm, wait);
1283 vlib_process_wait_for_event (vm);
1285 event_type = vlib_process_get_events (vm, &event_data);
1289 case ~0: /* no events => timeout */
1292 case UNIX_CLI_NEW_SESSION_EVENT_ADD:
1294 /* Add an identifier to the new session list */
1295 unix_cli_new_session_t ns;
1297 ns.cf_index = event_data[0];
1298 ns.deadline = vlib_time_now (vm) + 1.0;
1300 vec_add1 (cm->new_sessions, ns);
1303 wait = 0.1; /* force a re-evaluation soon, but not too soon */
1308 clib_warning ("BUG: unknown event type 0x%wx", event_type);
1312 vec_reset_length (event_data);
1314 if (vlib_process_suspend_time_is_zero (wait))
1316 /* Scan the list looking for expired deadlines.
1317 * Emit needed prompts and remove from the list.
1318 * While scanning, look for the nearest new deadline
1319 * for the next iteration.
1320 * Since the list is ordered with newest sessions first
1321 * we can make assumptions about expired sessions being
1322 * contiguous at the beginning and the next deadline is the
1323 * next entry on the list, if any.
1325 f64 now = vlib_time_now (vm);
1326 unix_cli_new_session_t *nsp;
1331 vec_foreach (nsp, cm->new_sessions)
1333 if (vlib_process_suspend_time_is_zero (nsp->deadline - now))
1335 /* Deadline reached */
1336 unix_cli_file_t *cf;
1338 /* Mark the highwater */
1341 /* Check the connection didn't close already */
1342 if (pool_is_free_index (cm->cli_file_pool, nsp->cf_index))
1345 cf = pool_elt_at_index (cm->cli_file_pool, nsp->cf_index);
1348 unix_cli_file_welcome (cm, cf);
1352 wait = nsp->deadline - now;
1359 /* We have sessions to remove */
1360 vec_delete (cm->new_sessions, index, 0);
1369 /** @brief A mostly no-op Telnet state machine.
1370 * Process Telnet command bytes in a way that ensures we're mostly
1371 * transparent to the Telnet protocol. That is, it's mostly a no-op.
1373 * @return -1 if we need more bytes, otherwise a positive integer number of
1374 * bytes to consume from the input_vector, not including the initial
1378 unix_cli_process_telnet (unix_main_t * um,
1379 unix_cli_file_t * cf,
1380 clib_file_t * uf, u8 * input_vector, uword len)
1382 /* Input_vector starts at IAC byte.
1383 * See if we have a complete message; if not, return -1 so we wait for more.
1384 * if we have a complete message, consume those bytes from the vector.
1389 return -1; /* want more bytes */
1391 switch (input_vector[1])
1394 /* two IAC's in a row means to pass through 0xff.
1395 * since that makes no sense here, just consume it.
1404 /* Expect 3 bytes */
1406 return -1; /* want more bytes */
1413 /* Sub option - search ahead for IAC SE to end it */
1415 for (i = 3; i < len && i < UNIX_CLI_MAX_DEPTH_TELNET; i++)
1417 if (input_vector[i - 1] == IAC && input_vector[i] == SE)
1419 /* We have a complete message; see if we care about it */
1420 switch (input_vector[2])
1423 if (input_vector[3] != 0)
1426 /* See if the the terminal type is recognized */
1427 u8 *term = input_vector + 4;
1430 /* See if the terminal type is ANSI capable */
1432 unix_cli_terminal_type_ansi (term, len);
1434 /* See if the terminal type indicates non-interactive */
1435 if (unix_cli_terminal_type_noninteractive (term, len))
1436 unix_cli_set_session_noninteractive (cf);
1439 /* If session not started, we can release the pause */
1441 /* Send the welcome banner and initial prompt */
1442 unix_cli_file_welcome (&unix_cli_main, cf);
1447 if (i != 8) /* check message is correct size */
1451 clib_net_to_host_u16 (*((u16 *) (input_vector + 3)));
1452 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
1453 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
1455 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
1458 clib_net_to_host_u16 (*((u16 *) (input_vector + 5)));
1459 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
1460 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
1461 if (cf->height == 0)
1462 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
1464 /* reindex pager buffer */
1465 unix_cli_pager_reindex (cf);
1467 unix_cli_pager_redraw (cf, uf);
1473 /* Consume it all */
1479 if (i == UNIX_CLI_MAX_DEPTH_TELNET)
1480 consume = 1; /* hit max search depth, advance one byte */
1483 return -1; /* want more bytes */
1501 /* Simple one-byte messages */
1506 /* Are You There - trigger a visible response */
1508 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "fd.io VPP\n", 10);
1512 /* Unknown command! Eat the IAC byte */
1519 /** @brief Process actionable input.
1520 * Based on the \c action process the input; this typically involves
1521 * searching the command history or editing the current command line.
1524 unix_cli_line_process_one (unix_cli_main_t * cm,
1526 unix_cli_file_t * cf,
1528 u8 input, unix_cli_parse_action_t action)
1532 u8 **possible_commands;
1537 case UNIX_CLI_PARSE_ACTION_NOACTION:
1540 case UNIX_CLI_PARSE_ACTION_REVSEARCH:
1541 case UNIX_CLI_PARSE_ACTION_FWDSEARCH:
1542 if (!cf->has_history || !cf->history_limit)
1544 if (cf->search_mode == 0)
1546 /* Erase the current command (if any) */
1547 for (; cf->cursor > 0; cf->cursor--)
1549 unix_vlib_cli_output_cursor_left (cf, uf);
1550 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1551 unix_vlib_cli_output_cursor_left (cf, uf);
1554 vec_reset_length (cf->search_key);
1555 vec_reset_length (cf->current_command);
1557 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1558 cf->search_mode = -1;
1560 cf->search_mode = 1;
1564 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1565 cf->search_mode = -1;
1567 cf->search_mode = 1;
1569 cf->excursion += cf->search_mode;
1574 case UNIX_CLI_PARSE_ACTION_ERASELINELEFT:
1575 /* Erase the command from the cursor to the start */
1578 /* Shimmy backwards to the new end of line position */
1579 delta = vec_len (cf->current_command) - cf->cursor;
1580 for (; cf->cursor > delta; cf->cursor--)
1581 unix_vlib_cli_output_cursor_left (cf, uf);
1582 /* Zap from here to the end of what is currently displayed */
1583 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1584 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1585 /* Get back to the start of the line */
1586 for (; cf->cursor > 0; cf->cursor--)
1587 unix_vlib_cli_output_cursor_left (cf, uf);
1589 /* Delete the desired text from the command */
1590 memmove (cf->current_command, cf->current_command + j, delta);
1591 _vec_len (cf->current_command) = delta;
1593 /* Print the new contents */
1594 unix_vlib_cli_output_cooked (cf, uf, cf->current_command, delta);
1595 cf->cursor = delta; /* for backspace tracking */
1597 /* Shimmy back to the start */
1598 for (; cf->cursor > 0; cf->cursor--)
1599 unix_vlib_cli_output_cursor_left (cf, uf);
1601 cf->search_mode = 0;
1604 case UNIX_CLI_PARSE_ACTION_ERASELINERIGHT:
1605 /* Erase the command from the cursor to the end */
1608 /* Zap from cursor to end of what is currently displayed */
1609 for (; cf->cursor < (vec_len (cf->current_command)); cf->cursor++)
1610 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1611 /* Get back to where we were */
1612 for (; cf->cursor > j; cf->cursor--)
1613 unix_vlib_cli_output_cursor_left (cf, uf);
1615 /* Truncate the line at the cursor */
1616 _vec_len (cf->current_command) = cf->cursor;
1618 cf->search_mode = 0;
1621 case UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT:
1622 /* calculate num of caracter to be erased */
1624 while (cf->cursor > delta
1625 && cf->current_command[cf->cursor - delta - 1] == ' ')
1627 while (cf->cursor > delta
1628 && cf->current_command[cf->cursor - delta - 1] != ' ')
1631 if (vec_len (cf->current_command))
1635 /* move cursor left delta times */
1636 for (j = delta; j > 0; j--, cf->cursor--)
1637 unix_vlib_cli_output_cursor_left (cf, uf);
1638 save = cf->current_command + cf->cursor;
1640 /* redraw remainder of line */
1641 memmove (cf->current_command + cf->cursor,
1642 cf->current_command + cf->cursor + delta,
1643 _vec_len (cf->current_command) - cf->cursor - delta);
1644 unix_vlib_cli_output_cooked (cf, uf,
1645 cf->current_command + cf->cursor,
1646 _vec_len (cf->current_command) -
1648 cf->cursor += _vec_len (cf->current_command) - cf->cursor;
1650 /* print delta amount of blank spaces,
1651 * then finally fix the cursor position */
1652 for (j = delta; j > 0; j--, cf->cursor--)
1653 unix_vlib_cli_output_cursor_left (cf, uf);
1654 for (j = delta; j > 0; j--, cf->cursor++)
1655 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1656 for (; (cf->current_command + cf->cursor) > save; cf->cursor--)
1657 unix_vlib_cli_output_cursor_left (cf, uf);
1658 _vec_len (cf->current_command) -= delta;
1661 cf->search_mode = 0;
1663 vec_reset_length (cf->search_key);
1666 case UNIX_CLI_PARSE_ACTION_LEFT:
1669 unix_vlib_cli_output_cursor_left (cf, uf);
1673 cf->search_mode = 0;
1676 case UNIX_CLI_PARSE_ACTION_RIGHT:
1677 if (cf->cursor < vec_len (cf->current_command))
1679 /* have to emit the character under the cursor */
1680 unix_vlib_cli_output_cooked (cf, uf,
1681 cf->current_command + cf->cursor, 1);
1685 cf->search_mode = 0;
1688 case UNIX_CLI_PARSE_ACTION_UP:
1689 case UNIX_CLI_PARSE_ACTION_DOWN:
1690 if (!cf->has_history || !cf->history_limit)
1692 cf->search_mode = 0;
1693 /* Erase the command */
1694 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1695 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1696 for (; cf->cursor > 0; cf->cursor--)
1698 unix_vlib_cli_output_cursor_left (cf, uf);
1699 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1700 unix_vlib_cli_output_cursor_left (cf, uf);
1702 vec_reset_length (cf->current_command);
1703 if (vec_len (cf->command_history))
1705 if (action == UNIX_CLI_PARSE_ACTION_UP)
1710 cf->excursion += delta;
1712 if (cf->excursion == vec_len (cf->command_history))
1714 /* down-arrowed to last entry - want a blank line */
1715 _vec_len (cf->current_command) = 0;
1717 else if (cf->excursion < 0)
1719 /* up-arrowed over the start to the end, want a blank line */
1720 cf->excursion = vec_len (cf->command_history);
1721 _vec_len (cf->current_command) = 0;
1725 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1726 /* down-arrowed past end - wrap to start */
1729 /* Print the command at the current position */
1730 prev = cf->command_history[cf->excursion];
1731 vec_validate (cf->current_command, vec_len (prev) - 1);
1733 clib_memcpy (cf->current_command, prev, vec_len (prev));
1734 _vec_len (cf->current_command) = vec_len (prev);
1735 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1736 vec_len (cf->current_command));
1739 cf->cursor = vec_len (cf->current_command);
1742 case UNIX_CLI_PARSE_ACTION_HOME:
1743 if (vec_len (cf->current_command) && cf->cursor > 0)
1745 for (; cf->cursor > 0; cf->cursor--)
1746 unix_vlib_cli_output_cursor_left (cf, uf);
1749 cf->search_mode = 0;
1752 case UNIX_CLI_PARSE_ACTION_END:
1753 if (vec_len (cf->current_command) &&
1754 cf->cursor < vec_len (cf->current_command))
1756 unix_vlib_cli_output_cooked (cf, uf,
1757 cf->current_command + cf->cursor,
1758 vec_len (cf->current_command) -
1760 cf->cursor = vec_len (cf->current_command);
1763 cf->search_mode = 0;
1766 case UNIX_CLI_PARSE_ACTION_WORDLEFT:
1767 if (vec_len (cf->current_command) && cf->cursor > 0)
1769 unix_vlib_cli_output_cursor_left (cf, uf);
1772 while (cf->cursor && isspace (cf->current_command[cf->cursor]))
1774 unix_vlib_cli_output_cursor_left (cf, uf);
1777 while (cf->cursor && !isspace (cf->current_command[cf->cursor]))
1779 if (isspace (cf->current_command[cf->cursor - 1]))
1781 unix_vlib_cli_output_cursor_left (cf, uf);
1787 cf->search_mode = 0;
1790 case UNIX_CLI_PARSE_ACTION_WORDRIGHT:
1791 if (vec_len (cf->current_command) &&
1792 cf->cursor < vec_len (cf->current_command))
1794 int e = vec_len (cf->current_command);
1796 while (j < e && !isspace (cf->current_command[j]))
1798 while (j < e && isspace (cf->current_command[j]))
1800 unix_vlib_cli_output_cooked (cf, uf,
1801 cf->current_command + cf->cursor,
1806 cf->search_mode = 0;
1810 case UNIX_CLI_PARSE_ACTION_ERASE:
1811 if (vec_len (cf->current_command))
1813 if (cf->cursor == vec_len (cf->current_command))
1815 unix_vlib_cli_output_cursor_left (cf, uf);
1817 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1819 unix_vlib_cli_output_cursor_left (cf, uf);
1821 _vec_len (cf->current_command)--;
1823 else if (cf->cursor > 0)
1825 /* shift everything at & to the right of the cursor left by 1 */
1826 j = vec_len (cf->current_command) - cf->cursor;
1827 memmove (cf->current_command + cf->cursor - 1,
1828 cf->current_command + cf->cursor, j);
1829 _vec_len (cf->current_command)--;
1831 /* redraw the rest of the line */
1832 unix_vlib_cli_output_cursor_left (cf, uf);
1834 unix_vlib_cli_output_cooked (cf, uf,
1835 cf->current_command + cf->cursor,
1838 /* erase last char */
1839 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1842 /* and shift the terminal cursor back where it should be */
1843 j += 2; /* account for old string length and offset position */
1846 unix_vlib_cli_output_cursor_left (cf, uf);
1851 cf->search_mode = 0;
1853 vec_reset_length (cf->search_key);
1856 case UNIX_CLI_PARSE_ACTION_ERASERIGHT:
1857 if (vec_len (cf->current_command))
1859 if (cf->cursor < vec_len (cf->current_command))
1861 /* shift everything to the right of the cursor left by 1 */
1862 j = vec_len (cf->current_command) - cf->cursor - 1;
1863 memmove (cf->current_command + cf->cursor,
1864 cf->current_command + cf->cursor + 1, j);
1865 _vec_len (cf->current_command)--;
1866 /* redraw the rest of the line */
1867 unix_vlib_cli_output_cooked (cf, uf,
1868 cf->current_command + cf->cursor,
1871 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1873 unix_vlib_cli_output_cursor_left (cf, uf);
1875 /* and shift the terminal cursor back where it should be */
1878 unix_vlib_cli_output_cursor_left (cf, uf);
1882 unix_vlib_cli_output_cursor_left (cf, uf);
1888 else if (input == 'D' - '@')
1890 /* ^D with no command entered = quit */
1891 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "quit\n", 5);
1892 vlib_process_signal_event (um->vlib_main,
1893 vlib_current_process (um->vlib_main),
1894 UNIX_CLI_PROCESS_EVENT_QUIT,
1895 cf - cm->cli_file_pool);
1897 cf->search_mode = 0;
1899 vec_reset_length (cf->search_key);
1902 case UNIX_CLI_PARSE_ACTION_CLEAR:
1903 /* If we're in ANSI mode, clear the screen.
1904 * Then redraw the prompt and any existing command input, then put
1905 * the cursor back where it was in that line.
1907 if (cf->ansi_capable)
1908 unix_vlib_cli_output_cooked (cf, uf,
1910 sizeof (ANSI_CLEAR) - 1);
1912 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1914 unix_vlib_cli_output_raw (cf, uf,
1915 cm->cli_prompt, vec_len (cm->cli_prompt));
1916 unix_vlib_cli_output_cooked (cf, uf,
1917 cf->current_command,
1918 vec_len (cf->current_command));
1920 cf->cursor = vec_len (cf->current_command);
1921 for (; cf->cursor > j; cf->cursor--)
1922 unix_vlib_cli_output_cursor_left (cf, uf);
1926 case UNIX_CLI_PARSE_ACTION_TAB:
1927 if (cf->cursor < vec_len (cf->current_command))
1929 /* if we are in the middle of a line, complete only if
1930 * the cursor points to whitespace */
1931 if (isspace (cf->current_command[cf->cursor]))
1933 /* save and clear any input that is after the cursor */
1934 vec_resize (save, vec_len (cf->current_command) - cf->cursor);
1935 clib_memcpy (save, cf->current_command + cf->cursor,
1936 vec_len (cf->current_command) - cf->cursor);
1937 _vec_len (cf->current_command) = cf->cursor;
1941 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1946 vlib_cli_get_possible_completions (cf->current_command);
1947 if (vec_len (possible_commands) == 1)
1949 u8 *completed = possible_commands[0];
1952 /* find the last word of current_command */
1953 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1955 unix_vlib_cli_output_cursor_left (cf, uf);
1959 _vec_len (cf->current_command) = j;
1961 /* replace it with the newly expanded command */
1962 vec_append (cf->current_command, completed);
1964 /* echo to the terminal */
1965 unix_vlib_cli_output_cooked (cf, uf, completed,
1966 vec_len (completed));
1968 /* add one trailing space if needed */
1969 if (vec_len (save) == 0)
1971 vec_add1 (cf->current_command, ' ');
1972 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1975 cf->cursor = vec_len (cf->current_command);
1978 else if (vec_len (possible_commands) >= 2)
1980 u8 **possible_command;
1981 uword max_command_len = 0, min_command_len = ~0;
1984 vec_foreach (possible_command, possible_commands)
1986 if (vec_len (*possible_command) > max_command_len)
1987 max_command_len = vec_len (*possible_command);
1988 if (vec_len (*possible_command) < min_command_len)
1989 min_command_len = vec_len (*possible_command);
1992 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1995 vec_foreach (possible_command, possible_commands)
1997 if (i + max_command_len >= cf->width)
1999 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2002 unix_vlib_cli_output_cooked (cf, uf, *possible_command,
2003 vec_len (*possible_command));
2004 for (j = vec_len (*possible_command); j < max_command_len + 2;
2007 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2009 i += max_command_len + 2;
2012 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2014 /* rewrite prompt */
2015 unix_cli_cli_prompt (cf, uf);
2016 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2017 vec_len (cf->current_command));
2019 /* count length of last word */
2022 while (j >= 1 && !isspace (cf->current_command[j - 1]))
2028 /* determine smallest common command */
2029 for (; i < min_command_len; i++)
2034 vec_foreach (possible_command, possible_commands)
2038 common = (*possible_command)[i];
2040 else if (common != (*possible_command)[i])
2049 vec_add1 (cf->current_command, common);
2051 unix_vlib_cli_output_cooked (cf, uf, (u8 *) & common, 1);
2061 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
2064 if (vec_len (save) > 0)
2066 /* restore remaining input if tab was hit in the middle of a line */
2067 unix_vlib_cli_output_cooked (cf, uf, save, vec_len (save));
2068 cf->cursor += vec_len (save);
2069 for (j = 0; j < vec_len (save); j++, cf->cursor--)
2070 unix_vlib_cli_output_cursor_left (cf, uf);
2071 vec_append (cf->current_command, save);
2074 vec_free (possible_commands);
2077 case UNIX_CLI_PARSE_ACTION_YANK:
2082 case UNIX_CLI_PARSE_ACTION_PAGER_QUIT:
2084 unix_cli_pager_prompt_erase (cf, uf);
2085 unix_cli_pager_reset (cf);
2086 unix_cli_cli_prompt (cf, uf);
2089 case UNIX_CLI_PARSE_ACTION_PAGER_NEXT:
2090 case UNIX_CLI_PARSE_ACTION_PAGER_PGDN:
2091 /* show next page of the buffer */
2092 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
2095 unix_cli_pager_index_t *pi = NULL;
2097 int m = cf->pager_start + (cf->height - 1);
2098 unix_cli_pager_prompt_erase (cf, uf);
2100 j < vec_len (cf->pager_index) && cf->pager_start < m;
2101 j++, cf->pager_start++)
2103 pi = &cf->pager_index[j];
2104 line = cf->pager_vector[pi->line] + pi->offset;
2105 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2107 /* if the last line didn't end in newline, add a newline */
2108 if (pi && line[pi->length - 1] != '\n')
2109 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2110 unix_cli_pager_prompt (cf, uf);
2114 if (action == UNIX_CLI_PARSE_ACTION_PAGER_NEXT)
2115 /* no more in buffer, exit, but only if it was <space> */
2120 case UNIX_CLI_PARSE_ACTION_PAGER_DN:
2121 case UNIX_CLI_PARSE_ACTION_PAGER_CRLF:
2122 /* display the next line of the buffer */
2123 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
2126 unix_cli_pager_index_t *pi;
2128 unix_cli_pager_prompt_erase (cf, uf);
2129 pi = &cf->pager_index[cf->pager_start + (cf->height - 1)];
2130 line = cf->pager_vector[pi->line] + pi->offset;
2131 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2133 /* if the last line didn't end in newline, add a newline */
2134 if (line[pi->length - 1] != '\n')
2135 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2136 unix_cli_pager_prompt (cf, uf);
2140 if (action == UNIX_CLI_PARSE_ACTION_PAGER_CRLF)
2141 /* no more in buffer, exit, but only if it was <enter> */
2147 case UNIX_CLI_PARSE_ACTION_PAGER_UP:
2148 /* scroll the page back one line */
2149 if (cf->pager_start > 0)
2152 unix_cli_pager_index_t *pi = NULL;
2155 if (cf->ansi_capable)
2157 pi = &cf->pager_index[cf->pager_start];
2158 line = cf->pager_vector[pi->line] + pi->offset;
2159 unix_cli_pager_prompt_erase (cf, uf);
2160 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SCROLLDN,
2161 sizeof (ANSI_SCROLLDN) - 1);
2162 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SAVECURSOR,
2163 sizeof (ANSI_SAVECURSOR) - 1);
2164 unix_cli_ansi_cursor (cf, uf, 1, 1);
2165 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_CLEARLINE,
2166 sizeof (ANSI_CLEARLINE) - 1);
2167 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2168 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_RESTCURSOR,
2169 sizeof (ANSI_RESTCURSOR) - 1);
2170 unix_cli_pager_prompt_erase (cf, uf);
2171 unix_cli_pager_prompt (cf, uf);
2175 int m = cf->pager_start + (cf->height - 1);
2176 unix_cli_pager_prompt_erase (cf, uf);
2177 for (j = cf->pager_start;
2178 j < vec_len (cf->pager_index) && j < m; j++)
2180 pi = &cf->pager_index[j];
2181 line = cf->pager_vector[pi->line] + pi->offset;
2182 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2184 /* if the last line didn't end in newline, add a newline */
2185 if (pi && line[pi->length - 1] != '\n')
2186 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2187 unix_cli_pager_prompt (cf, uf);
2192 case UNIX_CLI_PARSE_ACTION_PAGER_TOP:
2193 /* back to the first page of the buffer */
2194 if (cf->pager_start > 0)
2197 unix_cli_pager_index_t *pi = NULL;
2199 cf->pager_start = 0;
2200 int m = cf->pager_start + (cf->height - 1);
2201 unix_cli_pager_prompt_erase (cf, uf);
2202 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2205 pi = &cf->pager_index[j];
2206 line = cf->pager_vector[pi->line] + pi->offset;
2207 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2209 /* if the last line didn't end in newline, add a newline */
2210 if (pi && line[pi->length - 1] != '\n')
2211 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2212 unix_cli_pager_prompt (cf, uf);
2216 case UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM:
2217 /* skip to the last page of the buffer */
2218 if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
2221 unix_cli_pager_index_t *pi = NULL;
2223 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
2224 unix_cli_pager_prompt_erase (cf, uf);
2225 unix_cli_pager_message (cf, uf, "skipping", "\n");
2226 for (j = cf->pager_start; j < vec_len (cf->pager_index); j++)
2228 pi = &cf->pager_index[j];
2229 line = cf->pager_vector[pi->line] + pi->offset;
2230 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2232 /* if the last line didn't end in newline, add a newline */
2233 if (pi && line[pi->length - 1] != '\n')
2234 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2235 unix_cli_pager_prompt (cf, uf);
2239 case UNIX_CLI_PARSE_ACTION_PAGER_PGUP:
2240 /* wander back one page in the buffer */
2241 if (cf->pager_start > 0)
2244 unix_cli_pager_index_t *pi = NULL;
2247 if (cf->pager_start >= cf->height)
2248 cf->pager_start -= cf->height - 1;
2250 cf->pager_start = 0;
2251 m = cf->pager_start + cf->height - 1;
2252 unix_cli_pager_prompt_erase (cf, uf);
2253 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2256 pi = &cf->pager_index[j];
2257 line = cf->pager_vector[pi->line] + pi->offset;
2258 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2260 /* if the last line didn't end in newline, add a newline */
2261 if (pi && line[pi->length - 1] != '\n')
2262 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2263 unix_cli_pager_prompt (cf, uf);
2267 case UNIX_CLI_PARSE_ACTION_PAGER_REDRAW:
2268 /* Redraw the current pager screen */
2269 unix_cli_pager_redraw (cf, uf);
2272 case UNIX_CLI_PARSE_ACTION_PAGER_SEARCH:
2273 /* search forwards in the buffer */
2277 case UNIX_CLI_PARSE_ACTION_CRLF:
2279 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2281 if (cf->has_history && cf->history_limit)
2283 if (cf->command_history
2284 && vec_len (cf->command_history) >= cf->history_limit)
2286 vec_free (cf->command_history[0]);
2287 vec_delete (cf->command_history, 1, 0);
2289 /* Don't add blank lines to the cmd history */
2290 if (vec_len (cf->current_command))
2292 /* Don't duplicate the previous command */
2293 j = vec_len (cf->command_history);
2295 (vec_len (cf->current_command) !=
2296 vec_len (cf->command_history[j - 1])
2297 || memcmp (cf->current_command, cf->command_history[j - 1],
2298 vec_len (cf->current_command)) != 0))
2300 /* copy the command to the history */
2302 vec_append (c, cf->current_command);
2303 vec_add1 (cf->command_history, c);
2304 cf->command_number++;
2307 cf->excursion = vec_len (cf->command_history);
2310 cf->search_mode = 0;
2311 vec_reset_length (cf->search_key);
2316 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2317 case UNIX_CLI_PARSE_ACTION_NOMATCH:
2318 if (vec_len (cf->pager_index))
2322 else if (cf->has_history && cf->search_mode != 0 && isprint (input))
2324 int k, limit, offset;
2327 vec_add1 (cf->search_key, input);
2330 for (j = 0; j < vec_len (cf->command_history); j++)
2332 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
2334 else if (cf->excursion < 0)
2335 cf->excursion = vec_len (cf->command_history) - 1;
2337 item = cf->command_history[cf->excursion];
2339 limit = (vec_len (cf->search_key) > vec_len (item)) ?
2340 vec_len (item) : vec_len (cf->search_key);
2342 for (offset = 0; offset <= vec_len (item) - limit; offset++)
2344 for (k = 0; k < limit; k++)
2346 if (item[k + offset] != cf->search_key[k])
2349 goto found_at_offset;
2357 for (; cf->cursor > 0; cf->cursor--)
2359 unix_vlib_cli_output_cursor_left (cf, uf);
2360 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2361 unix_vlib_cli_output_cursor_left (cf, uf);
2364 vec_validate (cf->current_command, vec_len (item) - 1);
2365 clib_memcpy (cf->current_command, item, vec_len (item));
2366 _vec_len (cf->current_command) = vec_len (item);
2368 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2369 vec_len (cf->current_command));
2370 cf->cursor = vec_len (cf->current_command);
2374 cf->excursion += cf->search_mode;
2377 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\nNo match...", 12);
2378 vec_reset_length (cf->search_key);
2379 vec_reset_length (cf->current_command);
2380 cf->search_mode = 0;
2384 else if (isprint (input)) /* skip any errant control codes */
2386 if (cf->cursor == vec_len (cf->current_command))
2389 vec_add1 (cf->current_command, input);
2392 /* Echo the character back to the client */
2393 unix_vlib_cli_output_cooked (cf, uf, &input, 1);
2397 /* Insert at cursor: resize +1 byte, move everything over */
2398 j = vec_len (cf->current_command) - cf->cursor;
2399 vec_add1 (cf->current_command, (u8) 'A');
2400 memmove (cf->current_command + cf->cursor + 1,
2401 cf->current_command + cf->cursor, j);
2402 cf->current_command[cf->cursor] = input;
2403 /* Redraw the line */
2405 unix_vlib_cli_output_cooked (cf, uf,
2406 cf->current_command + cf->cursor,
2410 /* Put terminal cursor back */
2411 for (; j > 0; j--, cf->cursor--)
2412 unix_vlib_cli_output_cursor_left (cf, uf);
2417 /* no-op - not printable or otherwise not actionable */
2424 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2430 /** @brief Process input bytes on a stream to provide line editing and
2431 * command history in the CLI. */
2433 unix_cli_line_edit (unix_cli_main_t * cm, unix_main_t * um,
2434 clib_file_main_t * fm, unix_cli_file_t * cf)
2436 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2439 for (i = 0; i < vec_len (cf->input_vector); i++)
2441 unix_cli_parse_action_t action;
2443 unix_cli_parse_actions_t *a;
2445 /* If we're in the pager mode, search the pager actions */
2447 vec_len (cf->pager_index) ? unix_cli_parse_pager :
2448 unix_cli_parse_strings;
2450 /* See if the input buffer is some sort of control code */
2451 action = unix_cli_match_action (a, &cf->input_vector[i],
2452 vec_len (cf->input_vector) - i,
2457 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2460 /* There was a partial match which means we need more bytes
2461 * than the input buffer currently has.
2462 * Since the bytes before here have been processed, shift
2463 * the remaining contents to the start of the input buffer.
2465 vec_delete (cf->input_vector, i, 0);
2467 return 1; /* wait for more */
2469 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2470 /* process telnet options */
2471 matched = unix_cli_process_telnet (um, cf, uf,
2472 cf->input_vector + i,
2473 vec_len (cf->input_vector) - i);
2476 /* There was a partial match which means we need more bytes
2477 * than the input buffer currently has.
2482 * Since the bytes before here have been processed, shift
2483 * the remaining contents to the start of the input buffer.
2485 vec_delete (cf->input_vector, i, 0);
2487 return 1; /* wait for more */
2492 /* If telnet option processing switched us to line mode, get us
2497 vec_delete (cf->input_vector, i, 0);
2498 cf->current_command = cf->input_vector;
2502 /* process the action */
2503 if (!unix_cli_line_process_one (cm, um, cf, uf,
2504 cf->input_vector[i], action))
2506 /* CRLF found. Consume the bytes from the input_vector */
2507 vec_delete (cf->input_vector, i + matched, 0);
2508 /* And tell our caller to execute cf->input_command */
2516 vec_reset_length (cf->input_vector);
2520 /** @brief Process input to a CLI session. */
2522 unix_cli_process_input (unix_cli_main_t * cm, uword cli_file_index)
2524 unix_main_t *um = &unix_main;
2525 clib_file_main_t *fm = &file_main;
2527 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2528 unformat_input_t input;
2529 int vlib_parse_eval (u8 *);
2531 cm->current_input_file_index = cli_file_index;
2534 /* Try vlibplex first. Someday... */
2535 if (0 && vlib_parse_eval (cf->input_vector) == 0)
2541 /* just treat whatever we got as a complete line of input */
2542 cf->current_command = cf->input_vector;
2546 /* Line edit, echo, etc. */
2547 if (unix_cli_line_edit (cm, um, fm, cf))
2548 /* want more input */
2555 vec_reset_length (lv);
2556 lv = format (lv, "%U[%d]: %v",
2557 format_timeval, 0 /* current bat-time */ ,
2558 0 /* current bat-format */ ,
2559 cli_file_index, cf->current_command);
2560 if ((vec_len (cf->current_command) > 0) &&
2561 (cf->current_command[vec_len (cf->current_command) - 1] != '\n'))
2562 lv = format (lv, "\n");
2563 int rv __attribute__ ((unused)) = write (um->log_fd, lv, vec_len (lv));
2566 /* Build an unformat structure around our command */
2567 unformat_init_vector (&input, cf->current_command);
2569 /* Remove leading white space from input. */
2570 (void) unformat (&input, "");
2572 cf->pager_start = 0; /* start a new pager session */
2574 if (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
2575 vlib_cli_input (um->vlib_main, &input, unix_vlib_cli_output,
2578 /* Zero buffer since otherwise unformat_free will call vec_free on it. */
2581 unformat_free (&input);
2583 /* Re-fetch pointer since pool may have moved. */
2584 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2585 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2588 /* reset vector; we'll re-use it later */
2591 vec_reset_length (cf->input_vector);
2592 cf->current_command = 0;
2596 vec_reset_length (cf->current_command);
2599 if (cf->no_pager == 2)
2601 /* Pager was programmatically disabled */
2602 unix_cli_pager_message (cf, uf, "pager buffer overflowed", "\n");
2603 cf->no_pager = um->cli_no_pager;
2606 if (vec_len (cf->pager_index) == 0
2607 || vec_len (cf->pager_index) < cf->height)
2609 /* There was no need for the pager */
2610 unix_cli_pager_reset (cf);
2613 unix_cli_cli_prompt (cf, uf);
2617 /* Display the pager prompt */
2618 unix_cli_pager_prompt (cf, uf);
2621 /* Any residual data in the input vector? */
2622 if (vec_len (cf->input_vector))
2625 /* For non-interactive sessions send a NUL byte.
2626 * Specifically this is because vppctl needs to see some traffic in
2627 * order to move on to closing the session. Commands with no output
2628 * would thus cause vppctl to hang indefinitely in non-interactive mode
2629 * since there is also no prompt sent after the command completes.
2631 if (!cf->is_interactive)
2632 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\0", 1);
2635 /** Destroy a CLI session.
2636 * @note If we destroy the @c stdin session this additionally signals
2637 * the shutdown of VPP.
2640 unix_cli_kill (unix_cli_main_t * cm, uword cli_file_index)
2642 unix_main_t *um = &unix_main;
2643 clib_file_main_t *fm = &file_main;
2644 unix_cli_file_t *cf;
2648 /* Validate cli_file_index */
2649 if (pool_is_free_index (cm->cli_file_pool, cli_file_index))
2652 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2653 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2655 /* Quit/EOF on stdin means quit program. */
2656 if (uf->file_descriptor == STDIN_FILENO)
2657 clib_longjmp (&um->vlib_main->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
2659 vec_free (cf->current_command);
2660 vec_free (cf->search_key);
2662 for (i = 0; i < vec_len (cf->command_history); i++)
2663 vec_free (cf->command_history[i]);
2665 vec_free (cf->command_history);
2667 clib_file_del (fm, uf);
2669 unix_cli_file_free (cf);
2670 pool_put (cm->cli_file_pool, cf);
2673 /** Handle system events. */
2675 unix_cli_process (vlib_main_t * vm,
2676 vlib_node_runtime_t * rt, vlib_frame_t * f)
2678 unix_cli_main_t *cm = &unix_cli_main;
2683 unix_cli_process_event_type_t event_type;
2684 vlib_process_wait_for_event (vm);
2685 event_type = vlib_process_get_events (vm, &data);
2689 case UNIX_CLI_PROCESS_EVENT_READ_READY:
2690 for (i = 0; i < vec_len (data); i++)
2691 unix_cli_process_input (cm, data[i]);
2694 case UNIX_CLI_PROCESS_EVENT_QUIT:
2695 /* Kill this process. */
2696 for (i = 0; i < vec_len (data); i++)
2697 unix_cli_kill (cm, data[i]);
2702 _vec_len (data) = 0;
2708 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
2710 /* Add node index so we can re-use this process later. */
2711 vec_add1 (cm->unused_cli_process_node_indices, rt->node_index);
2716 /** Called when a CLI session file descriptor can be written to without
2718 static clib_error_t *
2719 unix_cli_write_ready (clib_file_t * uf)
2721 unix_cli_main_t *cm = &unix_cli_main;
2722 unix_cli_file_t *cf;
2725 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2727 /* Flush output vector. */
2729 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
2730 n = send (uf->file_descriptor,
2731 cf->output_vector, vec_len (cf->output_vector), MSG_NOSIGNAL);
2733 n = write (uf->file_descriptor,
2734 cf->output_vector, vec_len (cf->output_vector));
2736 if (n < 0 && errno != EAGAIN)
2740 /* connection closed on us */
2741 unix_main_t *um = &unix_main;
2743 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
2744 UNIX_CLI_PROCESS_EVENT_QUIT,
2749 return clib_error_return_unix (0, "write");
2754 unix_cli_del_pending_output (uf, cf, n);
2756 return /* no error */ 0;
2759 /** Called when a CLI session file descriptor has data to be read. */
2760 static clib_error_t *
2761 unix_cli_read_ready (clib_file_t * uf)
2763 unix_main_t *um = &unix_main;
2764 unix_cli_main_t *cm = &unix_cli_main;
2765 unix_cli_file_t *cf;
2767 int n, n_read, n_try;
2769 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2774 l = vec_len (cf->input_vector);
2775 vec_resize (cf->input_vector, l + n_try);
2777 n = read (uf->file_descriptor, cf->input_vector + l, n_try);
2780 if (n < 0 && errno != EAGAIN)
2781 return clib_error_return_unix (0, "read");
2783 n_read = n < 0 ? 0 : n;
2784 _vec_len (cf->input_vector) = l + n_read;
2788 vlib_process_signal_event (um->vlib_main,
2789 cf->process_node_index,
2791 ? UNIX_CLI_PROCESS_EVENT_QUIT
2792 : UNIX_CLI_PROCESS_EVENT_READ_READY),
2793 /* event data */ uf->private_data);
2795 return /* no error */ 0;
2798 /** Called when a CLI session file descriptor has an error condition. */
2799 static clib_error_t *
2800 unix_cli_error_detected (clib_file_t * uf)
2802 unix_main_t *um = &unix_main;
2803 unix_cli_main_t *cm = &unix_cli_main;
2804 unix_cli_file_t *cf;
2806 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2807 cf->has_epipe = 1; /* prevent writes while the close is pending */
2808 vlib_process_signal_event (um->vlib_main,
2809 cf->process_node_index,
2810 UNIX_CLI_PROCESS_EVENT_QUIT,
2811 /* event data */ uf->private_data);
2813 return /* no error */ 0;
2816 /** Store a new CLI session.
2817 * @param name The name of the session.
2818 * @param fd The file descriptor for the session I/O.
2819 * @return The session ID.
2822 unix_cli_file_add (unix_cli_main_t * cm, char *name, int fd)
2824 unix_main_t *um = &unix_main;
2825 clib_file_main_t *fm = &file_main;
2826 unix_cli_file_t *cf;
2827 clib_file_t template = { 0 };
2828 vlib_main_t *vm = um->vlib_main;
2832 file_desc = format (0, "%s", name);
2834 name = (char *) format (0, "unix-cli-%s", name);
2836 if (vec_len (cm->unused_cli_process_node_indices) > 0)
2838 uword l = vec_len (cm->unused_cli_process_node_indices);
2840 vlib_main_t *this_vlib_main;
2844 * Nodes are bulk-copied, so node name pointers are shared.
2845 * Find the cli node in all graph replicas, and give all of them
2846 * the same new name.
2847 * Then, throw away the old shared name-vector.
2849 for (i = 0; i < vec_len (vlib_mains); i++)
2851 this_vlib_main = vlib_mains[i];
2852 if (this_vlib_main == 0)
2854 n = vlib_get_node (this_vlib_main,
2855 cm->unused_cli_process_node_indices[l - 1]);
2857 n->name = (u8 *) name;
2859 vec_free (old_name);
2861 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
2863 _vec_len (cm->unused_cli_process_node_indices) = l - 1;
2867 static vlib_node_registration_t r = {
2868 .function = unix_cli_process,
2869 .type = VLIB_NODE_TYPE_PROCESS,
2870 .process_log2_n_stack_bytes = 18,
2875 vlib_worker_thread_barrier_sync (vm);
2877 vlib_register_node (vm, &r);
2880 n = vlib_get_node (vm, r.index);
2881 vlib_worker_thread_node_runtime_update ();
2882 vlib_worker_thread_barrier_release (vm);
2885 pool_get (cm->cli_file_pool, cf);
2886 clib_memset (cf, 0, sizeof (*cf));
2888 template.read_function = unix_cli_read_ready;
2889 template.write_function = unix_cli_write_ready;
2890 template.error_function = unix_cli_error_detected;
2891 template.file_descriptor = fd;
2892 template.private_data = cf - cm->cli_file_pool;
2893 template.description = file_desc;
2895 cf->process_node_index = n->index;
2896 cf->clib_file_index = clib_file_add (fm, &template);
2897 cf->output_vector = 0;
2898 cf->input_vector = 0;
2900 vlib_start_process (vm, n->runtime_index);
2902 vlib_process_t *p = vlib_get_process_from_node (vm, n);
2903 p->output_function = unix_vlib_cli_output;
2904 p->output_function_arg = cf - cm->cli_file_pool;
2906 return cf - cm->cli_file_pool;
2909 /** Telnet listening socket has a new connection. */
2910 static clib_error_t *
2911 unix_cli_listen_read_ready (clib_file_t * uf)
2913 unix_main_t *um = &unix_main;
2914 clib_file_main_t *fm = &file_main;
2915 unix_cli_main_t *cm = &unix_cli_main;
2916 clib_socket_t *s = &um->cli_listen_socket;
2917 clib_socket_t client;
2919 clib_error_t *error;
2920 unix_cli_file_t *cf;
2924 error = clib_socket_accept (s, &client);
2928 /* Disable Nagle, ignore any errors doing so eg on PF_LOCAL socket */
2930 (void) setsockopt (client.fd, IPPROTO_TCP, TCP_NODELAY,
2931 (void *) &one, sizeof (one));
2933 client_name = (char *) format (0, "%U%c", format_sockaddr, &client.peer, 0);
2935 cf_index = unix_cli_file_add (cm, client_name, client.fd);
2936 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2939 /* No longer need CLIB version of socket. */
2940 clib_socket_free (&client);
2941 vec_free (client_name);
2943 /* if we're supposed to run telnet session in character mode (default) */
2944 if (um->cli_line_mode == 0)
2947 * Set telnet client character mode, echo on, suppress "go-ahead".
2948 * Technically these should be negotiated, but this works.
2950 u8 charmode_option[] = {
2951 IAC, WONT, TELOPT_LINEMODE, /* server will do char-by-char */
2952 IAC, DONT, TELOPT_LINEMODE, /* client should do char-by-char */
2953 IAC, WILL, TELOPT_SGA, /* server willl supress GA */
2954 IAC, DO, TELOPT_SGA, /* client should supress Go Ahead */
2955 IAC, WILL, TELOPT_ECHO, /* server will do echo */
2956 IAC, DONT, TELOPT_ECHO, /* client should not echo */
2957 IAC, DO, TELOPT_TTYPE, /* client should tell us its term type */
2958 IAC, SB, TELOPT_TTYPE, 1, IAC, SE, /* now tell me ttype */
2959 IAC, DO, TELOPT_NAWS, /* client should tell us its window sz */
2960 IAC, SB, TELOPT_NAWS, 1, IAC, SE, /* now tell me window size */
2963 /* Enable history on this CLI */
2964 cf->history_limit = um->cli_history_limit;
2965 cf->has_history = cf->history_limit != 0;
2967 /* This is an interactive session until we decide otherwise */
2968 cf->is_interactive = 1;
2970 /* Make sure this session is in line mode */
2976 /* Setup the pager */
2977 cf->no_pager = um->cli_no_pager;
2979 /* Default terminal dimensions, should the terminal
2980 * fail to provide any.
2982 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
2983 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
2985 /* Send the telnet options */
2986 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2987 unix_vlib_cli_output_raw (cf, uf, charmode_option,
2988 ARRAY_LEN (charmode_option));
2990 if (cm->new_session_process_node_index == ~0)
2992 /* Create thw new session deadline process */
2993 cm->new_session_process_node_index =
2994 vlib_process_create (um->vlib_main, "unix-cli-new-session",
2995 unix_cli_new_session_process,
2996 16 /* log2_n_stack_bytes */ );
2999 /* In case the client doesn't negotiate terminal type, register
3000 * our session with a process that will emit the prompt if
3001 * a deadline passes */
3002 vlib_process_signal_event (um->vlib_main,
3003 cm->new_session_process_node_index,
3004 UNIX_CLI_NEW_SESSION_EVENT_ADD, cf_index);
3011 /** The system terminal has informed us that the window size
3015 unix_cli_resize_interrupt (int signum)
3017 clib_file_main_t *fm = &file_main;
3018 unix_cli_main_t *cm = &unix_cli_main;
3019 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
3020 cm->stdin_cli_file_index);
3021 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3025 /* Terminal resized, fetch the new size */
3026 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) < 0)
3028 /* "Should never happen..." */
3029 clib_unix_warning ("TIOCGWINSZ");
3030 /* We can't trust ws.XXX... */
3034 cf->width = ws.ws_col;
3035 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
3036 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
3038 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3040 cf->height = ws.ws_row;
3041 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
3042 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
3043 if (cf->height == 0)
3044 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3046 /* Reindex the pager buffer */
3047 unix_cli_pager_reindex (cf);
3049 /* Redraw the page */
3050 unix_cli_pager_redraw (cf, uf);
3053 /** Handle configuration directives in the @em unix section. */
3054 static clib_error_t *
3055 unix_cli_config (vlib_main_t * vm, unformat_input_t * input)
3057 unix_main_t *um = &unix_main;
3058 clib_file_main_t *fm = &file_main;
3059 unix_cli_main_t *cm = &unix_cli_main;
3061 clib_error_t *error = 0;
3062 unix_cli_file_t *cf;
3065 struct sigaction sa;
3069 /* We depend on unix flags being set. */
3070 if ((error = vlib_call_config_function (vm, unix_config)))
3073 if (um->flags & UNIX_FLAG_INTERACTIVE)
3075 /* Set stdin to be non-blocking. */
3076 if ((flags = fcntl (STDIN_FILENO, F_GETFL, 0)) < 0)
3078 (void) fcntl (STDIN_FILENO, F_SETFL, flags | O_NONBLOCK);
3080 cf_index = unix_cli_file_add (cm, "stdin", STDIN_FILENO);
3081 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
3082 cm->stdin_cli_file_index = cf_index;
3084 /* If stdin is a tty and we are using chacracter mode, enable
3085 * history on the CLI and set the tty line discipline accordingly. */
3086 if (isatty (STDIN_FILENO) && um->cli_line_mode == 0)
3088 /* Capture terminal resize events */
3089 clib_memset (&sa, 0, sizeof (sa));
3090 sa.sa_handler = unix_cli_resize_interrupt;
3091 if (sigaction (SIGWINCH, &sa, 0) < 0)
3092 clib_panic ("sigaction");
3094 /* Retrieve the current terminal size */
3095 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) == 0)
3097 cf->width = ws.ws_col;
3098 cf->height = ws.ws_row;
3101 if (cf->width == 0 || cf->height == 0)
3104 * We have a tty, but no size. Use defaults.
3105 * vpp "unix interactive" inside emacs + gdb ends up here.
3107 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3108 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3111 /* Setup the history */
3112 cf->history_limit = um->cli_history_limit;
3113 cf->has_history = cf->history_limit != 0;
3115 /* Setup the pager */
3116 cf->no_pager = um->cli_no_pager;
3118 /* This is an interactive session until we decide otherwise */
3119 cf->is_interactive = 1;
3121 /* We're going to be in char by char mode */
3124 /* Save the original tty state so we can restore it later */
3125 tcgetattr (STDIN_FILENO, &um->tio_stdin);
3128 /* Tweak the tty settings */
3129 tio = um->tio_stdin;
3130 /* echo off, canonical mode off, ext'd input processing off */
3131 tio.c_lflag &= ~(ECHO | ICANON | IEXTEN);
3132 /* disable XON/XOFF, so ^S invokes the history search */
3133 tio.c_iflag &= ~(IXON | IXOFF);
3134 tio.c_cc[VMIN] = 1; /* 1 byte at a time */
3135 tio.c_cc[VTIME] = 0; /* no timer */
3136 tio.c_cc[VSTOP] = _POSIX_VDISABLE; /* not ^S */
3137 tio.c_cc[VSTART] = _POSIX_VDISABLE; /* not ^Q */
3138 tcsetattr (STDIN_FILENO, TCSAFLUSH, &tio);
3140 /* See if we can do ANSI/VT100 output */
3141 term = (u8 *) getenv ("TERM");
3144 int len = strlen ((char *) term);
3145 cf->ansi_capable = unix_cli_terminal_type_ansi (term, len);
3146 if (unix_cli_terminal_type_noninteractive (term, len))
3147 unix_cli_set_session_noninteractive (cf);
3152 /* No tty, so make sure the session doesn't have tty-like features */
3153 unix_cli_set_session_noninteractive (cf);
3156 /* Send banner and initial prompt */
3157 unix_cli_file_welcome (cm, cf);
3160 /* If we have socket config, LISTEN, otherwise, don't */
3161 clib_socket_t *s = &um->cli_listen_socket;
3162 if (s->config && s->config[0] != 0)
3165 clib_file_t template = { 0 };
3167 /* mkdir of file socketu, only under /run */
3168 if (strncmp (s->config, "/run", 4) == 0)
3170 u8 *tmp = format (0, "%s", s->config);
3171 int i = vec_len (tmp);
3172 while (i && tmp[--i] != '/')
3178 vlib_unix_recursive_mkdir ((char *) tmp);
3182 s->flags = CLIB_SOCKET_F_IS_SERVER | /* listen, don't connect */
3183 CLIB_SOCKET_F_ALLOW_GROUP_WRITE; /* PF_LOCAL socket only */
3184 error = clib_socket_init (s);
3189 template.read_function = unix_cli_listen_read_ready;
3190 template.file_descriptor = s->fd;
3191 template.description = format (0, "cli listener %s", s->config);
3193 clib_file_add (fm, &template);
3196 /* Set CLI prompt. */
3197 if (!cm->cli_prompt)
3198 cm->cli_prompt = format (0, "VLIB: ");
3204 * This module has no configurable parameters.
3206 VLIB_CONFIG_FUNCTION (unix_cli_config, "unix-cli");
3208 /** Called when VPP is shutting down, this restores the system
3209 * terminal state if previously saved.
3211 static clib_error_t *
3212 unix_cli_exit (vlib_main_t * vm)
3214 unix_main_t *um = &unix_main;
3216 /* If stdin is a tty and we saved the tty state, reset the tty state */
3217 if (isatty (STDIN_FILENO) && um->tio_isset)
3218 tcsetattr (STDIN_FILENO, TCSAFLUSH, &um->tio_stdin);
3223 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_cli_exit);
3225 /** Set the CLI prompt.
3226 * @param prompt The C string to set the prompt to.
3227 * @note This setting is global; it impacts all current
3228 * and future CLI sessions.
3231 vlib_unix_cli_set_prompt (char *prompt)
3233 char *fmt = (prompt[strlen (prompt) - 1] == ' ') ? "%s" : "%s ";
3234 unix_cli_main_t *cm = &unix_cli_main;
3236 vec_free (cm->cli_prompt);
3237 cm->cli_prompt = format (0, fmt, prompt);
3240 /** CLI command to quit the terminal session.
3241 * @note If this is a stdin session then this will
3242 * shutdown VPP also.
3244 static clib_error_t *
3245 unix_cli_quit (vlib_main_t * vm,
3246 unformat_input_t * input, vlib_cli_command_t * cmd)
3248 unix_cli_main_t *cm = &unix_cli_main;
3249 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
3250 cm->current_input_file_index);
3252 /* Cosmetic: suppress the final prompt from appearing before we die */
3253 cf->is_interactive = 0;
3256 vlib_process_signal_event (vm,
3257 vlib_current_process (vm),
3258 UNIX_CLI_PROCESS_EVENT_QUIT,
3259 cm->current_input_file_index);
3264 * Terminates the current CLI session.
3266 * If VPP is running in @em interactive mode and this is the console session
3267 * (that is, the session on @c stdin) then this will also terminate VPP.
3270 VLIB_CLI_COMMAND (unix_cli_quit_command, static) = {
3272 .short_help = "Exit CLI",
3273 .function = unix_cli_quit,
3278 VLIB_CLI_COMMAND (unix_cli_q_command, static) = {
3280 .short_help = "Exit CLI",
3281 .function = unix_cli_quit,
3285 /** CLI command to execute a VPP command script. */
3286 static clib_error_t *
3287 unix_cli_exec (vlib_main_t * vm,
3288 unformat_input_t * input, vlib_cli_command_t * cmd)
3292 unformat_input_t sub_input;
3293 clib_error_t *error;
3299 if (!unformat (input, "%s", &file_name))
3301 error = clib_error_return (0, "expecting file name, got `%U'",
3302 format_unformat_error, input);
3306 fd = open (file_name, O_RDONLY);
3309 error = clib_error_return_unix (0, "failed to open `%s'", file_name);
3313 /* Make sure its a regular file. */
3317 if (fstat (fd, &s) < 0)
3319 error = clib_error_return_unix (0, "failed to stat `%s'", file_name);
3323 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
3325 error = clib_error_return (0, "not a regular file `%s'", file_name);
3330 unformat_init_clib_file (&sub_input, fd);
3332 vlib_cli_input (vm, &sub_input, 0, 0);
3333 unformat_free (&sub_input);
3338 vec_free (file_name);
3344 * Executes a sequence of CLI commands which are read from a file. If
3345 * a command is unrecognised or otherwise invalid then the usual CLI
3346 * feedback will be generated, however execution of subsequent commands
3347 * from the file will continue.
3349 * The VPP code is indifferent to the file location. However, if SELinux
3350 * is enabled, then the file needs to have an SELinux label the VPP
3351 * process is allowed to access. For example, if a file is created in
3352 * '<em>/usr/share/vpp/</em>', it will be allowed. However, files manually
3353 * created in '/tmp/' or '/home/<user>/' will not be accessible by the VPP
3354 * process when SELinux is enabled.
3359 * <b><em>$ cat /usr/share/vpp/scripts/gigup.txt</em></b>
3360 * set interface state GigabitEthernet0/8/0 up
3361 * set interface state GigabitEthernet0/9/0 up
3363 * Example of how to execute a set of CLI commands from a file:
3364 * @cliexcmd{exec /usr/share/vpp/scripts/gigup.txt}
3367 VLIB_CLI_COMMAND (cli_exec, static) = {
3369 .short_help = "exec <filename>",
3370 .function = unix_cli_exec,
3375 /** CLI command to show various unix error statistics. */
3376 static clib_error_t *
3377 unix_show_errors (vlib_main_t * vm,
3378 unformat_input_t * input, vlib_cli_command_t * cmd)
3380 unix_main_t *um = &unix_main;
3381 clib_error_t *error = 0;
3382 int i, n_errors_to_show;
3383 unix_error_history_t *unix_errors = 0;
3385 n_errors_to_show = 1 << 30;
3387 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3389 if (!unformat (input, "%d", &n_errors_to_show))
3392 clib_error_return (0,
3393 "expecting integer number of errors to show, got `%U'",
3394 format_unformat_error, input);
3400 clib_min (ARRAY_LEN (um->error_history), n_errors_to_show);
3403 um->error_history_index >
3404 0 ? um->error_history_index - 1 : ARRAY_LEN (um->error_history) - 1;
3406 while (n_errors_to_show > 0)
3408 unix_error_history_t *eh = um->error_history + i;
3413 vec_add1 (unix_errors, eh[0]);
3414 n_errors_to_show -= 1;
3416 i = ARRAY_LEN (um->error_history) - 1;
3421 if (vec_len (unix_errors) == 0)
3422 vlib_cli_output (vm, "no Unix errors so far");
3425 vlib_cli_output (vm, "%Ld total errors seen", um->n_total_errors);
3426 for (i = vec_len (unix_errors) - 1; i >= 0; i--)
3428 unix_error_history_t *eh = vec_elt_at_index (unix_errors, i);
3429 vlib_cli_output (vm, "%U: %U",
3430 format_time_interval, "h:m:s:u", eh->time,
3431 format_clib_error, eh->error);
3433 vlib_cli_output (vm, "%U: time now",
3434 format_time_interval, "h:m:s:u", vlib_time_now (vm));
3438 vec_free (unix_errors);
3443 VLIB_CLI_COMMAND (cli_unix_show_errors, static) = {
3444 .path = "show unix errors",
3445 .short_help = "Show Unix system call error history",
3446 .function = unix_show_errors,
3450 /** CLI command to show various unix error statistics. */
3451 static clib_error_t *
3452 unix_show_files (vlib_main_t * vm,
3453 unformat_input_t * input, vlib_cli_command_t * cmd)
3455 clib_error_t *error = 0;
3456 clib_file_main_t *fm = &file_main;
3458 char path[PATH_MAX];
3461 vlib_cli_output (vm, "%3s %6s %12s %12s %12s %-32s %s", "FD", "Thread",
3462 "Read", "Write", "Error", "File Name", "Description");
3465 pool_foreach (f, fm->file_pool,(
3468 s = format (s, "/proc/self/fd/%d%c", f->file_descriptor, 0);
3469 rv = readlink((char *) s, path, PATH_MAX - 1);
3471 path[rv < 0 ? 0 : rv] = 0;
3473 vlib_cli_output (vm, "%3d %6d %12d %12d %12d %-32s %v",
3474 f->file_descriptor, f->polling_thread_index,
3475 f->read_events, f->write_events, f->error_events,
3476 path, f->description);
3477 vec_reset_length (s);
3486 VLIB_CLI_COMMAND (cli_unix_show_files, static) = {
3487 .path = "show unix files",
3488 .short_help = "Show Unix files in use",
3489 .function = unix_show_files,
3493 /** CLI command to show session command history. */
3494 static clib_error_t *
3495 unix_cli_show_history (vlib_main_t * vm,
3496 unformat_input_t * input, vlib_cli_command_t * cmd)
3498 unix_cli_main_t *cm = &unix_cli_main;
3499 unix_cli_file_t *cf;
3502 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3504 if (!cf->is_interactive)
3505 return clib_error_return (0, "invalid for non-interactive sessions");
3507 if (cf->has_history && cf->history_limit)
3509 i = 1 + cf->command_number - vec_len (cf->command_history);
3510 for (j = 0; j < vec_len (cf->command_history); j++)
3511 vlib_cli_output (vm, "%d %v\n", i + j, cf->command_history[j]);
3515 vlib_cli_output (vm, "History not enabled.\n");
3522 * Displays the command history for the current session, if any.
3525 VLIB_CLI_COMMAND (cli_unix_cli_show_history, static) = {
3527 .short_help = "Show current session command history",
3528 .function = unix_cli_show_history,
3532 /** CLI command to show terminal status. */
3533 static clib_error_t *
3534 unix_cli_show_terminal (vlib_main_t * vm,
3535 unformat_input_t * input, vlib_cli_command_t * cmd)
3537 unix_main_t *um = &unix_main;
3538 unix_cli_main_t *cm = &unix_cli_main;
3539 unix_cli_file_t *cf;
3542 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3543 n = vlib_get_node (vm, cf->process_node_index);
3545 vlib_cli_output (vm, "Terminal name: %v\n", n->name);
3546 vlib_cli_output (vm, "Terminal mode: %s\n", cf->line_mode ?
3547 "line-by-line" : "char-by-char");
3548 vlib_cli_output (vm, "Terminal width: %d\n", cf->width);
3549 vlib_cli_output (vm, "Terminal height: %d\n", cf->height);
3550 vlib_cli_output (vm, "ANSI capable: %s\n",
3551 cf->ansi_capable ? "yes" : "no");
3552 vlib_cli_output (vm, "Interactive: %s\n",
3553 cf->is_interactive ? "yes" : "no");
3554 vlib_cli_output (vm, "History enabled: %s%s\n",
3555 cf->has_history ? "yes" : "no", !cf->has_history
3556 || cf->history_limit ? "" :
3557 " (disabled by history limit)");
3558 if (cf->has_history)
3559 vlib_cli_output (vm, "History limit: %d\n", cf->history_limit);
3560 vlib_cli_output (vm, "Pager enabled: %s%s%s\n",
3561 cf->no_pager ? "no" : "yes",
3563 || cf->height ? "" : " (disabled by terminal height)",
3565 || um->cli_pager_buffer_limit ? "" :
3566 " (disabled by buffer limit)");
3568 vlib_cli_output (vm, "Pager limit: %d\n", um->cli_pager_buffer_limit);
3569 vlib_cli_output (vm, "CRLF mode: %s\n",
3570 cf->crlf_mode ? "CR+LF" : "LF");
3576 * Displays various information about the state of the current terminal
3580 * @cliexstart{show terminal}
3581 * Terminal name: unix-cli-stdin
3582 * Terminal mode: char-by-char
3583 * Terminal width: 123
3584 * Terminal height: 48
3587 * History enabled: yes
3589 * Pager enabled: yes
3590 * Pager limit: 100000
3595 VLIB_CLI_COMMAND (cli_unix_cli_show_terminal, static) = {
3596 .path = "show terminal",
3597 .short_help = "Show current session terminal settings",
3598 .function = unix_cli_show_terminal,
3602 /** CLI command to display a list of CLI sessions. */
3603 static clib_error_t *
3604 unix_cli_show_cli_sessions (vlib_main_t * vm,
3605 unformat_input_t * input,
3606 vlib_cli_command_t * cmd)
3608 unix_cli_main_t *cm = &unix_cli_main;
3609 clib_file_main_t *fm = &file_main;
3610 unix_cli_file_t *cf;
3614 vlib_cli_output (vm, "%-5s %-5s %-20s %s", "PNI", "FD", "Name", "Flags");
3616 #define fl(x, y) ( (x) ? toupper((y)) : tolower((y)) )
3618 pool_foreach (cf, cm->cli_file_pool, ({
3619 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3620 n = vlib_get_node (vm, cf->process_node_index);
3621 vlib_cli_output (vm,
3622 "%-5d %-5d %-20v %c%c%c%c%c\n",
3623 cf->process_node_index,
3624 uf->file_descriptor,
3626 fl (cf->is_interactive, 'i'),
3627 fl (cf->is_socket, 's'),
3628 fl (cf->line_mode, 'l'),
3629 fl (cf->has_epipe, 'p'),
3630 fl (cf->ansi_capable, 'a'));
3639 * Displays a summary of all the current CLI sessions.
3641 * Typically used to diagnose connection issues with the CLI
3645 * @cliexstart{show cli-sessions}
3647 * 343 0 unix-cli-stdin IslpA
3648 * 344 7 unix-cli-local:20 ISlpA
3649 * 346 8 unix-cli-local:21 iSLpa
3652 * In this example we have the debug console of the running process
3653 * on stdin/out, we have an interactive socket session and we also
3654 * have a non-interactive socket session.
3658 * - @em PNI: Process node index.
3659 * - @em FD: Unix file descriptor.
3660 * - @em Name: Name of the session.
3661 * - @em Flags: Various flags that describe the state of the session.
3663 * @em Flags have the following meanings; lower-case typically negates
3666 * - @em I Interactive session.
3667 * - @em S Connected by socket.
3668 * - @em s Not a socket, likely stdin.
3669 * - @em L Line-by-line mode.
3670 * - @em l Char-by-char mode.
3671 * - @em P EPIPE detected on connection; it will close soon.
3672 * - @em A ANSI-capable terminal.
3675 VLIB_CLI_COMMAND (cli_unix_cli_show_cli_sessions, static) = {
3676 .path = "show cli-sessions",
3677 .short_help = "Show current CLI sessions",
3678 .function = unix_cli_show_cli_sessions,
3682 /** CLI command to set terminal pager settings. */
3683 static clib_error_t *
3684 unix_cli_set_terminal_pager (vlib_main_t * vm,
3685 unformat_input_t * input,
3686 vlib_cli_command_t * cmd)
3688 unix_main_t *um = &unix_main;
3689 unix_cli_main_t *cm = &unix_cli_main;
3690 unix_cli_file_t *cf;
3691 unformat_input_t _line_input, *line_input = &_line_input;
3692 clib_error_t *error = 0;
3694 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3696 if (!cf->is_interactive)
3697 return clib_error_return (0, "invalid for non-interactive sessions");
3699 if (!unformat_user (input, unformat_line_input, line_input))
3702 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3704 if (unformat (line_input, "on"))
3706 else if (unformat (line_input, "off"))
3708 else if (unformat (line_input, "limit %u", &um->cli_pager_buffer_limit))
3709 vlib_cli_output (vm,
3710 "Pager limit set to %u lines; note, this is global.\n",
3711 um->cli_pager_buffer_limit);
3714 error = clib_error_return (0, "unknown parameter: `%U`",
3715 format_unformat_error, line_input);
3721 unformat_free (line_input);
3727 * Enables or disables the terminal pager for this session. Generally
3728 * this defaults to enabled.
3730 * Additionally allows the pager buffer size to be set; though note that
3731 * this value is set globally and not per session.
3734 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager, static) = {
3735 .path = "set terminal pager",
3736 .short_help = "set terminal pager [on|off] [limit <lines>]",
3737 .function = unix_cli_set_terminal_pager,
3741 /** CLI command to set terminal history settings. */
3742 static clib_error_t *
3743 unix_cli_set_terminal_history (vlib_main_t * vm,
3744 unformat_input_t * input,
3745 vlib_cli_command_t * cmd)
3747 unix_cli_main_t *cm = &unix_cli_main;
3748 unix_cli_file_t *cf;
3749 unformat_input_t _line_input, *line_input = &_line_input;
3751 clib_error_t *error = 0;
3753 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3755 if (!cf->is_interactive)
3756 return clib_error_return (0, "invalid for non-interactive sessions");
3758 if (!unformat_user (input, unformat_line_input, line_input))
3761 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3763 if (unformat (line_input, "on"))
3764 cf->has_history = 1;
3765 else if (unformat (line_input, "off"))
3766 cf->has_history = 0;
3767 else if (unformat (line_input, "limit %u", &cf->history_limit))
3771 error = clib_error_return (0, "unknown parameter: `%U`",
3772 format_unformat_error, line_input);
3778 /* If we reduced history size, or turned it off, purge the history */
3779 limit = cf->has_history ? cf->history_limit : 0;
3780 if (limit < vec_len (cf->command_history))
3784 /* How many items to remove from the start of history */
3785 limit = vec_len (cf->command_history) - limit;
3787 for (i = 0; i < limit; i++)
3788 vec_free (cf->command_history[i]);
3790 vec_delete (cf->command_history, limit, 0);
3794 unformat_free (line_input);
3800 * Enables or disables the command history function of the current
3801 * terminal. Generally this defaults to enabled.
3803 * This command also allows the maximum size of the history buffer for
3804 * this session to be altered.
3807 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history, static) = {
3808 .path = "set terminal history",
3809 .short_help = "set terminal history [on|off] [limit <lines>]",
3810 .function = unix_cli_set_terminal_history,
3814 /** CLI command to set terminal ANSI settings. */
3815 static clib_error_t *
3816 unix_cli_set_terminal_ansi (vlib_main_t * vm,
3817 unformat_input_t * input,
3818 vlib_cli_command_t * cmd)
3820 unix_cli_main_t *cm = &unix_cli_main;
3821 unix_cli_file_t *cf;
3823 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3825 if (!cf->is_interactive)
3826 return clib_error_return (0, "invalid for non-interactive sessions");
3828 if (unformat (input, "on"))
3829 cf->ansi_capable = 1;
3830 else if (unformat (input, "off"))
3831 cf->ansi_capable = 0;
3833 return clib_error_return (0, "unknown parameter: `%U`",
3834 format_unformat_error, input);
3840 * Enables or disables the use of ANSI control sequences by this terminal.
3841 * The default will vary based on terminal detection at the start of the
3844 * ANSI control sequences are used in a small number of places to provide,
3845 * for example, color text output and to control the cursor in the pager.
3848 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi, static) = {
3849 .path = "set terminal ansi",
3850 .short_help = "set terminal ansi [on|off]",
3851 .function = unix_cli_set_terminal_ansi,
3856 #define MAX_CLI_WAIT 86400
3857 /** CLI command to wait <sec> seconds. Useful for exec script. */
3858 static clib_error_t *
3859 unix_wait_cmd (vlib_main_t * vm,
3860 unformat_input_t * input, vlib_cli_command_t * cmd)
3862 unformat_input_t _line_input, *line_input = &_line_input;
3865 if (!unformat_user (input, unformat_line_input, line_input))
3868 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3870 if (unformat (line_input, "%f", &sec))
3873 return clib_error_return (0, "unknown parameter: `%U`",
3874 format_unformat_error, input);
3877 if (sec <= 0 || sec > MAX_CLI_WAIT || floor (sec * 1000) / 1000 != sec)
3878 return clib_error_return (0,
3879 "<sec> must be a positive value and less than 86400 (one day) with no more than msec precision.");
3881 vlib_process_wait_for_event_or_clock (vm, sec);
3882 vlib_cli_output (vm, "waited %.3f sec.", sec);
3884 unformat_free (line_input);
3888 VLIB_CLI_COMMAND (cli_unix_wait_cmd, static) = {
3890 .short_help = "wait <sec>",
3891 .function = unix_wait_cmd,
3895 static clib_error_t *
3896 unix_cli_init (vlib_main_t * vm)
3898 unix_cli_main_t *cm = &unix_cli_main;
3900 /* Breadcrumb to indicate the new session process
3901 * has not been started */
3902 cm->new_session_process_node_index = ~0;
3907 VLIB_INIT_FUNCTION (unix_cli_init);
3910 * fd.io coding-style-patch-verification: ON
3913 * eval: (c-set-style "gnu")