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>
64 #include <vppinfra/macros.h>
65 #include <vppinfra/format_table.h>
67 /** ANSI escape code. */
70 /** ANSI Control Sequence Introducer. */
73 /** ANSI clear screen. */
74 #define ANSI_CLEAR CSI "2J" CSI "1;1H"
75 /** ANSI reset color settings. */
76 #define ANSI_RESET CSI "0m"
77 /** ANSI Start bold text. */
78 #define ANSI_BOLD CSI "1m"
79 /** ANSI Stop bold text. */
80 #define ANSI_DIM CSI "2m"
81 /** ANSI Start dark red text. */
82 #define ANSI_DRED ANSI_DIM CSI "31m"
83 /** ANSI Start bright red text. */
84 #define ANSI_BRED ANSI_BOLD CSI "31m"
85 /** ANSI clear line cursor is on. */
86 #define ANSI_CLEARLINE CSI "2K"
87 /** ANSI scroll screen down one line. */
88 #define ANSI_SCROLLDN CSI "1T"
89 /** ANSI save cursor position. */
90 #define ANSI_SAVECURSOR CSI "s"
91 /** ANSI restore cursor position if previously saved. */
92 #define ANSI_RESTCURSOR CSI "u"
94 /** Maximum depth into a byte stream from which to compile a Telnet
95 * protocol message. This is a safety measure. */
96 #define UNIX_CLI_MAX_DEPTH_TELNET 32
98 /** Maximum terminal width we will accept */
99 #define UNIX_CLI_MAX_TERMINAL_WIDTH 512
100 /** Maximum terminal height we will accept */
101 #define UNIX_CLI_MAX_TERMINAL_HEIGHT 512
102 /** Default terminal height */
103 #define UNIX_CLI_DEFAULT_TERMINAL_HEIGHT 24
104 /** Default terminal width */
105 #define UNIX_CLI_DEFAULT_TERMINAL_WIDTH 80
107 /** A CLI banner line. */
110 u8 *line; /**< The line to print. */
111 u32 length; /**< The length of the line without terminating NUL. */
114 #define _(a) { .line = (u8 *)(a), .length = sizeof(a) - 1 }
115 /** Plain welcome banner. */
116 static unix_cli_banner_t unix_cli_banner[] = {
117 _(" _______ _ _ _____ ___ \n"),
118 _(" __/ __/ _ \\ (_)__ | | / / _ \\/ _ \\\n"),
119 _(" _/ _// // / / / _ \\ | |/ / ___/ ___/\n"),
120 _(" /_/ /____(_)_/\\___/ |___/_/ /_/ \n"),
124 /** ANSI color welcome banner. */
125 static unix_cli_banner_t unix_cli_banner_color[] = {
126 _(ANSI_BRED " _______ _ " ANSI_RESET " _ _____ ___ \n"),
127 _(ANSI_BRED " __/ __/ _ \\ (_)__ " ANSI_RESET " | | / / _ \\/ _ \\\n"),
128 _(ANSI_BRED " _/ _// // / / / _ \\" ANSI_RESET " | |/ / ___/ ___/\n"),
129 _(ANSI_BRED " /_/ /____(_)_/\\___/" ANSI_RESET " |___/_/ /_/ \n"),
135 /** Pager line index */
138 /** Index into pager_vector */
141 /** Offset of the string in the line */
144 /** Length of the string in the line */
146 } unix_cli_pager_index_t;
149 /** Unix CLI session. */
152 /** The file index held by unix.c */
155 /** Vector of output pending write to file descriptor. */
158 /** Vector of input saved by Unix input node to be processed by
162 /** This session has command history. */
164 /** Array of vectors of commands in the history. */
165 u8 **command_history;
166 /** The command currently pointed at by the history cursor. */
168 /** How far from the end of the history array the user has browsed. */
171 /** Maximum number of history entries this session will store. */
174 /** Current command line counter */
177 /** The string being searched for in the history. */
179 /** If non-zero then the CLI is searching in the history array.
180 * - @c -1 means search backwards.
181 * - @c 1 means search forwards.
185 /** Position of the insert cursor on the current input line */
188 /** Line mode or char mode */
191 /** Set if the CRLF mode wants CR + LF */
194 /** Can we do ANSI output? */
197 /** Has the session started? */
200 /** Disable the pager? */
203 /** Whether the session is interactive or not.
204 * Controls things like initial banner, the CLI prompt etc. */
207 /** Whether the session is attached to a socket. */
210 /** If EPIPE has been detected, prevent further write-related
211 * activity on the descriptor.
218 /** Index of line fragments in the pager buffer */
219 unix_cli_pager_index_t *pager_index;
221 /** Line number of top of page */
224 /** Terminal width */
227 /** Terminal height */
230 /** Process node identifier */
231 u32 process_node_index;
233 /** The current direction of cursor travel.
234 * This is important since when advancing left-to-right, at the
235 * right hand edge of the console the terminal typically defers
236 * wrapping the cursor to the next line until a character is
237 * actually displayed.
238 * This messes up our heuristic for whether to use ANSI to return
239 * the cursor to the end of the line and instead we have to
240 * nudge the cursor to the next line.
241 * A Value of @c 0 means we're advancing left-to-right; @c 1 means
246 /** Macro tables for this session */
247 clib_macro_main_t macro_main;
253 /** Resets the pager buffer and other data.
254 * @param f The CLI session whose pager needs to be reset.
257 unix_cli_pager_reset (unix_cli_file_t * f)
263 vec_free (f->pager_index);
266 vec_foreach (p, f->pager_vector)
270 vec_free (f->pager_vector);
274 /** Release storage used by a CLI session.
275 * @param f The CLI session whose storage needs to be released.
278 unix_cli_file_free (unix_cli_file_t * f)
280 vec_free (f->output_vector);
281 vec_free (f->input_vector);
283 unix_cli_pager_reset (f);
289 UNIX_CLI_PARSE_ACTION_NOACTION = 0, /**< No action */
290 UNIX_CLI_PARSE_ACTION_CRLF, /**< Carriage return, newline or enter */
291 UNIX_CLI_PARSE_ACTION_TAB, /**< Tab key */
292 UNIX_CLI_PARSE_ACTION_ERASE, /**< Erase cursor left */
293 UNIX_CLI_PARSE_ACTION_ERASERIGHT, /**< Erase cursor right */
294 UNIX_CLI_PARSE_ACTION_UP, /**< Up arrow */
295 UNIX_CLI_PARSE_ACTION_DOWN, /**< Down arrow */
296 UNIX_CLI_PARSE_ACTION_LEFT, /**< Left arrow */
297 UNIX_CLI_PARSE_ACTION_RIGHT, /**< Right arrow */
298 UNIX_CLI_PARSE_ACTION_HOME, /**< Home key (jump to start of line) */
299 UNIX_CLI_PARSE_ACTION_END, /**< End key (jump to end of line) */
300 UNIX_CLI_PARSE_ACTION_WORDLEFT, /**< Jump cursor to start of left word */
301 UNIX_CLI_PARSE_ACTION_WORDRIGHT, /**< Jump cursor to start of right word */
302 UNIX_CLI_PARSE_ACTION_ERASELINELEFT, /**< Erase line to left of cursor */
303 UNIX_CLI_PARSE_ACTION_ERASELINERIGHT, /**< Erase line to right & including cursor */
304 UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT, /**< Erase word left */
305 UNIX_CLI_PARSE_ACTION_CLEAR, /**< Clear the terminal */
306 UNIX_CLI_PARSE_ACTION_REVSEARCH, /**< Search backwards in command history */
307 UNIX_CLI_PARSE_ACTION_FWDSEARCH, /**< Search forwards in command history */
308 UNIX_CLI_PARSE_ACTION_YANK, /**< Undo last erase action */
309 UNIX_CLI_PARSE_ACTION_TELNETIAC, /**< Telnet control code */
311 UNIX_CLI_PARSE_ACTION_PAGER_CRLF, /**< Enter pressed (CR, CRLF, LF, etc) */
312 UNIX_CLI_PARSE_ACTION_PAGER_QUIT, /**< Exit the pager session */
313 UNIX_CLI_PARSE_ACTION_PAGER_NEXT, /**< Scroll to next page */
314 UNIX_CLI_PARSE_ACTION_PAGER_DN, /**< Scroll to next line */
315 UNIX_CLI_PARSE_ACTION_PAGER_UP, /**< Scroll to previous line */
316 UNIX_CLI_PARSE_ACTION_PAGER_TOP, /**< Scroll to first line */
317 UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM, /**< Scroll to last line */
318 UNIX_CLI_PARSE_ACTION_PAGER_PGDN, /**< Scroll to next page */
319 UNIX_CLI_PARSE_ACTION_PAGER_PGUP, /**< Scroll to previous page */
320 UNIX_CLI_PARSE_ACTION_PAGER_REDRAW, /**< Clear and redraw the page on the terminal */
321 UNIX_CLI_PARSE_ACTION_PAGER_SEARCH, /**< Search the pager buffer */
323 UNIX_CLI_PARSE_ACTION_PARTIALMATCH, /**< Action parser found a partial match */
324 UNIX_CLI_PARSE_ACTION_NOMATCH /**< Action parser did not find any match */
325 } unix_cli_parse_action_t;
327 /** @brief Mapping of input buffer strings to action values.
328 * @note This won't work as a hash since we need to be able to do
329 * partial matches on the string.
333 u8 *input; /**< Input string to match. */
334 u32 len; /**< Length of input without final NUL. */
335 unix_cli_parse_action_t action; /**< Action to take when matched. */
336 } unix_cli_parse_actions_t;
338 /** @brief Given a capital ASCII letter character return a @c NUL terminated
339 * string with the control code for that letter.
341 * @param c An ASCII character.
342 * @return A @c NUL terminated string of type @c u8[].
345 * @c CTL('A') returns <code>{ 0x01, 0x00 }</code> as a @c u8[].
347 #define CTL(c) (u8[]){ (c) - '@', 0 }
349 #define _(a,b) { .input = (u8 *)(a), .len = sizeof(a) - 1, .action = (b) }
351 * Patterns to match on a CLI input stream.
354 static unix_cli_parse_actions_t unix_cli_parse_strings[] = {
356 _("\r\n", UNIX_CLI_PARSE_ACTION_CRLF), /* Must be before '\r' */
357 _("\n", UNIX_CLI_PARSE_ACTION_CRLF),
358 _("\r\0", UNIX_CLI_PARSE_ACTION_CRLF), /* Telnet does this */
359 _("\r", UNIX_CLI_PARSE_ACTION_CRLF),
361 /* Unix shell control codes */
362 _(CTL ('B'), UNIX_CLI_PARSE_ACTION_LEFT),
363 _(CTL ('F'), UNIX_CLI_PARSE_ACTION_RIGHT),
364 _(CTL ('P'), UNIX_CLI_PARSE_ACTION_UP),
365 _(CTL ('N'), UNIX_CLI_PARSE_ACTION_DOWN),
366 _(CTL ('A'), UNIX_CLI_PARSE_ACTION_HOME),
367 _(CTL ('E'), UNIX_CLI_PARSE_ACTION_END),
368 _(CTL ('D'), UNIX_CLI_PARSE_ACTION_ERASERIGHT),
369 _(CTL ('U'), UNIX_CLI_PARSE_ACTION_ERASELINELEFT),
370 _(CTL ('K'), UNIX_CLI_PARSE_ACTION_ERASELINERIGHT),
371 _(CTL ('W'), UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT),
372 _(CTL ('Y'), UNIX_CLI_PARSE_ACTION_YANK),
373 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_CLEAR),
374 _(ESC "b", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* Alt-B */
375 _(ESC "f", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* Alt-F */
376 _("\b", UNIX_CLI_PARSE_ACTION_ERASE), /* ^H */
377 _("\x7f", UNIX_CLI_PARSE_ACTION_ERASE), /* Backspace */
378 _("\t", UNIX_CLI_PARSE_ACTION_TAB), /* ^I */
380 /* VT100 Normal mode - Broadest support */
381 _(CSI "A", UNIX_CLI_PARSE_ACTION_UP),
382 _(CSI "B", UNIX_CLI_PARSE_ACTION_DOWN),
383 _(CSI "C", UNIX_CLI_PARSE_ACTION_RIGHT),
384 _(CSI "D", UNIX_CLI_PARSE_ACTION_LEFT),
385 _(CSI "H", UNIX_CLI_PARSE_ACTION_HOME),
386 _(CSI "F", UNIX_CLI_PARSE_ACTION_END),
387 _(CSI "3~", UNIX_CLI_PARSE_ACTION_ERASERIGHT), /* Delete */
388 _(CSI "1;5D", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* C-Left */
389 _(CSI "1;5C", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* C-Right */
391 /* VT100 Application mode - Some Gnome Terminal functions use these */
392 _(ESC "OA", UNIX_CLI_PARSE_ACTION_UP),
393 _(ESC "OB", UNIX_CLI_PARSE_ACTION_DOWN),
394 _(ESC "OC", UNIX_CLI_PARSE_ACTION_RIGHT),
395 _(ESC "OD", UNIX_CLI_PARSE_ACTION_LEFT),
396 _(ESC "OH", UNIX_CLI_PARSE_ACTION_HOME),
397 _(ESC "OF", UNIX_CLI_PARSE_ACTION_END),
399 /* ANSI X3.41-1974 - sent by Microsoft Telnet and PuTTY */
400 _(CSI "1~", UNIX_CLI_PARSE_ACTION_HOME),
401 _(CSI "4~", UNIX_CLI_PARSE_ACTION_END),
403 /* Emacs-ish history search */
404 _(CTL ('S'), UNIX_CLI_PARSE_ACTION_FWDSEARCH),
405 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_REVSEARCH),
407 /* Other protocol things */
408 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
409 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
410 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
414 * Patterns to match when a CLI session is in the pager.
417 static unix_cli_parse_actions_t unix_cli_parse_pager[] = {
419 _("\r\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Must be before '\r' */
420 _("\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
421 _("\r\0", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Telnet does this */
422 _("\r", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
425 _(" ", UNIX_CLI_PARSE_ACTION_PAGER_NEXT),
426 _("q", UNIX_CLI_PARSE_ACTION_PAGER_QUIT),
427 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
428 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
429 _("/", UNIX_CLI_PARSE_ACTION_PAGER_SEARCH),
432 _(CSI "A", UNIX_CLI_PARSE_ACTION_PAGER_UP),
433 _(CSI "B", UNIX_CLI_PARSE_ACTION_PAGER_DN),
434 _(CSI "H", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
435 _(CSI "F", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
437 /* VT100 Application mode */
438 _(ESC "OA", UNIX_CLI_PARSE_ACTION_PAGER_UP),
439 _(ESC "OB", UNIX_CLI_PARSE_ACTION_PAGER_DN),
440 _(ESC "OH", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
441 _(ESC "OF", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
443 /* ANSI X3.41-1974 */
444 _(CSI "1~", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
445 _(CSI "4~", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
446 _(CSI "5~", UNIX_CLI_PARSE_ACTION_PAGER_PGUP),
447 _(CSI "6~", UNIX_CLI_PARSE_ACTION_PAGER_PGDN),
449 /* Other protocol things */
450 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
451 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
452 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
457 /** CLI session telnet negotiation timer events. */
460 UNIX_CLI_NEW_SESSION_EVENT_ADD, /**< Add a CLI session to the new session list */
461 } unix_cli_timeout_event_type_t;
463 /** Each new session is stored on a list with a deadline after which
464 * a prompt is issued, in case the session TELNET negotiation fails to
468 uword cf_index; /**< Session index of the new session. */
469 f64 deadline; /**< Deadline after which the new session must have a prompt. */
470 } unix_cli_new_session_t;
472 /** CLI global state. */
475 /** Prompt string for CLI. */
478 /** Vec pool of CLI sessions. */
479 unix_cli_file_t *cli_file_pool;
481 /** Vec pool of unused session indices. */
482 u32 *unused_cli_process_node_indices;
484 /** The session index of the stdin cli */
485 u32 stdin_cli_file_index;
487 /** File pool index of current input. */
488 u32 current_input_file_index;
490 /** New session process node identifier */
491 u32 new_session_process_node_index;
493 /** List of new sessions */
494 unix_cli_new_session_t *new_sessions;
496 /** system default macro table */
497 clib_macro_main_t macro_main;
501 /** CLI global state */
502 static unix_cli_main_t unix_cli_main;
504 /** Return the macro main / tables we should use for this session
506 static clib_macro_main_t *
507 get_macro_main (void)
509 unix_cli_main_t *cm = &unix_cli_main;
510 vlib_main_t *vm = vlib_get_main ();
511 vlib_process_t *cp = vlib_get_current_process (vm);
514 if (pool_is_free_index (cm->cli_file_pool, cp->output_function_arg))
515 return (&cm->macro_main);
517 cf = pool_elt_at_index (cm->cli_file_pool, cp->output_function_arg);
519 return (&cf->macro_main);
523 * @brief Search for a byte sequence in the action list.
525 * Searches the @ref unix_cli_parse_actions_t list in @a a for a match with
526 * the bytes in @a input of maximum length @a ilen bytes.
527 * When a match is made @a *matched indicates how many bytes were matched.
528 * Returns a value from the enum @ref unix_cli_parse_action_t to indicate
529 * whether no match was found, a partial match was found or a complete
530 * match was found and what action, if any, should be taken.
532 * @param[in] a Actions list to search within.
533 * @param[in] input String fragment to search for.
534 * @param[in] ilen Length of the string in 'input'.
535 * @param[out] matched Pointer to an integer that will contain the number
536 * of bytes matched when a complete match is found.
538 * @return Action from @ref unix_cli_parse_action_t that the string fragment
540 * @ref UNIX_CLI_PARSE_ACTION_PARTIALMATCH is returned when the
541 * whole input string matches the start of at least one action.
542 * @ref UNIX_CLI_PARSE_ACTION_NOMATCH is returned when there is no
545 static unix_cli_parse_action_t
546 unix_cli_match_action (unix_cli_parse_actions_t * a,
547 u8 * input, u32 ilen, i32 * matched)
555 /* see if the start of the input buffer exactly matches the current
557 if (memcmp (input, a->input, a->len) == 0)
565 /* if the first ilen characters match, flag this as a partial -
566 * meaning keep collecting bytes in case of a future match */
567 if (memcmp (input, a->input, ilen) == 0)
571 /* check next action */
576 UNIX_CLI_PARSE_ACTION_PARTIALMATCH : UNIX_CLI_PARSE_ACTION_NOMATCH;
580 /** Add bytes to the output vector and then flagg the I/O system that bytes
581 * are available to be sent.
584 unix_cli_add_pending_output (clib_file_t * uf,
585 unix_cli_file_t * cf,
586 u8 * buffer, uword buffer_bytes)
588 clib_file_main_t *fm = &file_main;
590 vec_add (cf->output_vector, buffer, buffer_bytes);
591 if (vec_len (cf->output_vector) > 0)
593 int skip_update = 0 != (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
594 uf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
596 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
600 /** Delete all bytes from the output vector and flag the I/O system
601 * that no more bytes are available to be sent.
604 unix_cli_del_pending_output (clib_file_t * uf,
605 unix_cli_file_t * cf, uword n_bytes)
607 clib_file_main_t *fm = &file_main;
609 vec_delete (cf->output_vector, n_bytes, 0);
610 if (vec_len (cf->output_vector) <= 0)
612 int skip_update = 0 == (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
613 uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
615 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
619 /** @brief A bit like strchr with a buffer length limit.
620 * Search a buffer for the first instance of a character up to the limit of
621 * the buffer length. If found then return the position of that character.
623 * The key departure from strchr is that if the character is not found then
624 * return the buffer length.
626 * @param chr The byte value to search for.
627 * @param str The buffer in which to search for the value.
628 * @param len The depth into the buffer to search.
630 * @return The index of the first occurrence of \c chr. If \c chr is not
631 * found then \c len instead.
634 unix_vlib_findchr (u8 chr, u8 * str, word len)
637 for (i = 0; i < len; i++, str++)
645 /** @brief Send a buffer to the CLI stream if possible, enqueue it otherwise.
646 * Attempts to write given buffer to the file descriptor of the given
647 * Unix CLI session. If that session already has data in the output buffer
648 * or if the write attempt tells us to try again later then the given buffer
649 * is appended to the pending output buffer instead.
651 * This is typically called only from \c unix_vlib_cli_output_cooked since
652 * that is where CRLF handling occurs or from places where we explicitly do
653 * not want cooked handling.
655 * @param cf Unix CLI session of the desired stream to write to.
656 * @param uf The Unix file structure of the desired stream to write to.
657 * @param buffer Pointer to the buffer that needs to be written.
658 * @param buffer_bytes The number of bytes from \c buffer to write.
661 unix_vlib_cli_output_raw (unix_cli_file_t * cf,
662 clib_file_t * uf, u8 * buffer, uword buffer_bytes)
666 if (cf->has_epipe) /* don't try writing anything */
669 if (vec_len (cf->output_vector) == 0)
672 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
673 n = send (uf->file_descriptor, buffer, buffer_bytes, MSG_NOSIGNAL);
675 n = write (uf->file_descriptor, buffer, buffer_bytes);
678 if (n < 0 && errno != EAGAIN)
682 /* connection closed on us */
683 unix_main_t *um = &unix_main;
685 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
686 UNIX_CLI_PROCESS_EVENT_QUIT,
691 clib_unix_warning ("write");
694 else if ((word) n < (word) buffer_bytes)
696 /* We got EAGAIN or we already have stuff in the buffer;
697 * queue up whatever didn't get sent for later. */
700 unix_cli_add_pending_output (uf, cf, buffer + n, buffer_bytes - n);
704 /** @brief Process a buffer for CRLF handling before outputting it to the CLI.
706 * @param cf Unix CLI session of the desired stream to write to.
707 * @param uf The Unix file structure of the desired stream to write to.
708 * @param buffer Pointer to the buffer that needs to be written.
709 * @param buffer_bytes The number of bytes from \c buffer to write.
712 unix_vlib_cli_output_cooked (unix_cli_file_t * cf,
714 u8 * buffer, uword buffer_bytes)
716 word end = 0, start = 0;
718 while (end < buffer_bytes)
722 /* iterate the line on \n's so we can insert a \r before it */
723 end = unix_vlib_findchr ('\n',
725 buffer_bytes - start) + start;
729 /* otherwise just send the whole buffer */
733 unix_vlib_cli_output_raw (cf, uf, buffer + start, end - start);
737 if (end < buffer_bytes)
739 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\r\n", 2);
740 end++; /* skip the \n that we already sent */
746 /* Use the last character to determine the last direction of the cursor. */
747 if (buffer_bytes > 0)
748 cf->cursor_direction = (buffer[buffer_bytes - 1] == (u8) '\b');
751 /** @brief Moves the terminal cursor one character to the left, with
752 * special handling when it reaches the left edge of the terminal window.
754 * Ordinarily we can simply send a '\b' to move the cursor left, however
755 * most terminals will not reverse-wrap to the end of the previous line
756 * if the cursor is in the left-most column. To counter this we must
757 * check the cursor position + prompt length modulo terminal width and
758 * if available use some other means, such as ANSI terminal escape
759 * sequences, to move the cursor.
761 * @param cf Unix CLI session of the desired stream to write to.
762 * @param uf The Unix file structure of the desired stream to write to.
765 unix_vlib_cli_output_cursor_left (unix_cli_file_t * cf, clib_file_t * uf)
767 unix_cli_main_t *cm = &unix_cli_main;
768 static u8 *ansi = 0; /* assumes no reentry */
771 if (!cf->is_interactive || !cf->ansi_capable || !cf->width)
773 /* No special handling for dumb terminals */
774 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
778 position = ((u32) vec_len (cm->cli_prompt) + cf->cursor) % cf->width;
782 /* No special handling required if we're not at the left edge */
783 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
787 if (!cf->cursor_direction)
789 /* Special handling for when we are at the left edge but
790 * the cursor was going left-to-right, but in this situation
791 * xterm-like terminals actually hide the cursor off the right
792 * edge. A \b here seems to jump one char too many, so let's
793 * force the cursor onto the next line instead.
795 if (cf->cursor < vec_len (cf->current_command))
796 unix_vlib_cli_output_cooked (cf, uf, &cf->current_command[cf->cursor],
799 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
800 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
803 /* Relocate the cursor at the right hand edge one line above */
804 ansi = format (ansi, CSI "A" CSI "%dC", cf->width - 1);
805 unix_vlib_cli_output_cooked (cf, uf, ansi, vec_len (ansi));
806 vec_reset_length (ansi); /* keep the vec around for next time */
807 cf->cursor_direction = 1; /* going backwards now */
810 /** @brief Output the CLI prompt */
812 unix_cli_cli_prompt (unix_cli_file_t * cf, clib_file_t * uf)
814 unix_cli_main_t *cm = &unix_cli_main;
816 if (cf->is_interactive) /* Only interactive sessions get a prompt */
817 unix_vlib_cli_output_raw (cf, uf, cm->cli_prompt,
818 vec_len (cm->cli_prompt));
821 /** @brief Output a pager prompt and show number of buffered lines */
823 unix_cli_pager_prompt (unix_cli_file_t * cf, clib_file_t * uf)
828 h = cf->pager_start + (cf->height - 1);
829 if (h > vec_len (cf->pager_index))
830 h = vec_len (cf->pager_index);
832 prompt = format (0, "\r%s-- more -- (%d-%d/%d)%s",
833 cf->ansi_capable ? ANSI_BOLD : "",
836 vec_len (cf->pager_index),
837 cf->ansi_capable ? ANSI_RESET : "");
839 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
844 /** @brief Output a pager "skipping" message */
846 unix_cli_pager_message (unix_cli_file_t * cf, clib_file_t * uf,
847 char *message, char *postfix)
851 prompt = format (0, "\r%s-- %s --%s%s",
852 cf->ansi_capable ? ANSI_BOLD : "",
853 message, cf->ansi_capable ? ANSI_RESET : "", postfix);
855 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
860 /** @brief Erase the printed pager prompt */
862 unix_cli_pager_prompt_erase (unix_cli_file_t * cf, clib_file_t * uf)
864 if (cf->ansi_capable)
866 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
867 unix_vlib_cli_output_cooked (cf, uf,
868 (u8 *) ANSI_CLEARLINE,
869 sizeof (ANSI_CLEARLINE) - 1);
875 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
876 for (i = 0; i < cf->width - 1; i++)
877 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
878 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
882 /** @brief Uses an ANSI escape sequence to move the cursor */
884 unix_cli_ansi_cursor (unix_cli_file_t * cf, clib_file_t * uf, u16 x, u16 y)
888 str = format (0, "%s%d;%dH", CSI, y, x);
890 unix_vlib_cli_output_cooked (cf, uf, str, vec_len (str));
895 /** Redraw the currently displayed page of text.
896 * @param cf CLI session to redraw the pager buffer of.
897 * @param uf Unix file of the CLI session.
900 unix_cli_pager_redraw (unix_cli_file_t * cf, clib_file_t * uf)
902 unix_cli_pager_index_t *pi = NULL;
906 /* No active pager? Do nothing. */
907 if (!vec_len (cf->pager_index))
910 if (cf->ansi_capable)
912 /* If we have ANSI, send the clear screen sequence */
913 unix_vlib_cli_output_cooked (cf, uf,
915 sizeof (ANSI_CLEAR) - 1);
919 /* Otherwise make sure we're on a blank line */
920 unix_cli_pager_prompt_erase (cf, uf);
923 /* (Re-)send the current page of content */
924 for (i = 0; i < cf->height - 1 &&
925 i + cf->pager_start < vec_len (cf->pager_index); i++)
927 pi = &cf->pager_index[cf->pager_start + i];
928 line = cf->pager_vector[pi->line] + pi->offset;
930 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
932 /* if the last line didn't end in newline, add a newline */
933 if (pi && line[pi->length - 1] != '\n')
934 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
936 unix_cli_pager_prompt (cf, uf);
939 /** @brief Process and add a line to the pager index.
940 * In normal operation this function will take the given character string
941 * found in @c line and with length @c len_or_index and iterates the over the
942 * contents, adding each line of text discovered within it to the
943 * pager index. Lines are identified by newlines ("<code>\\n</code>") and by
944 * strings longer than the width of the terminal.
946 * If instead @c line is @c NULL then @c len_or_index is taken to mean the
947 * index of an existing line in the pager buffer; this simply means that the
948 * input line does not need to be cloned since we already have it. This is
949 * typical if we are reindexing the pager buffer.
951 * @param cf The CLI session whose pager we are adding to.
952 * @param line The string of text to be indexed into the pager buffer.
953 * If @c line is @c NULL then the mode of operation
954 * changes slightly; see the description above.
955 * @param len_or_index If @c line is a pointer to a string then this parameter
956 * indicates the length of that string; Otherwise this
957 * value provides the index in the pager buffer of an
958 * existing string to be indexed.
961 unix_cli_pager_add_line (unix_cli_file_t * cf, u8 * line, word len_or_index)
965 word line_index, len;
966 u32 width = cf->width;
967 unix_cli_pager_index_t *pi;
971 /* Use a line already in the pager buffer */
972 line_index = len_or_index;
973 if (cf->pager_vector != NULL)
974 p = cf->pager_vector[line_index];
980 /* Add a copy of the raw string to the pager buffer */
981 p = vec_new (u8, len);
982 clib_memcpy (p, line, len);
984 /* store in pager buffer */
985 line_index = vec_len (cf->pager_vector);
986 vec_add1 (cf->pager_vector, p);
992 /* Find the next line, or run to terminal width, or run to EOL */
994 j = unix_vlib_findchr ((u8) '\n', p, l < width ? l : width);
996 if (j < l && p[j] == '\n') /* incl \n */
999 /* Add the line to the index */
1000 k = vec_len (cf->pager_index);
1001 vec_validate (cf->pager_index, k);
1002 pi = &cf->pager_index[k];
1004 pi->line = line_index;
1013 /** @brief Reindex entire pager buffer.
1014 * Resets the current pager index and then re-adds the lines in the pager
1015 * buffer to the index.
1017 * Additionally this function attempts to retain the current page start
1018 * line offset by searching for the same top-of-screen line in the new index.
1020 * @param cf The CLI session whose pager buffer should be reindexed.
1023 unix_cli_pager_reindex (unix_cli_file_t * cf)
1025 word i, old_line, old_offset;
1026 unix_cli_pager_index_t *pi;
1028 /* If there is nothing in the pager buffer then make sure the index
1029 * is empty and move on.
1031 if (cf->pager_vector == 0)
1033 vec_reset_length (cf->pager_index);
1037 /* Retain a pointer to the current page start line so we can
1040 pi = &cf->pager_index[cf->pager_start];
1041 old_line = pi->line;
1042 old_offset = pi->offset;
1044 /* Re-add the buffered lines to the index */
1045 vec_reset_length (cf->pager_index);
1046 vec_foreach_index (i, cf->pager_vector)
1048 unix_cli_pager_add_line (cf, NULL, i);
1051 /* Attempt to re-locate the previously stored page start line */
1052 vec_foreach_index (i, cf->pager_index)
1054 pi = &cf->pager_index[i];
1056 if (pi->line == old_line &&
1057 (pi->offset <= old_offset || pi->offset + pi->length > old_offset))
1060 cf->pager_start = i;
1065 /* In case the start line was not found (rare), ensure the pager start
1066 * index is within bounds
1068 if (cf->pager_start >= vec_len (cf->pager_index))
1070 if (!cf->height || vec_len (cf->pager_index) < (cf->height - 1))
1071 cf->pager_start = 0;
1073 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
1077 /** VLIB CLI output function.
1079 * If the terminal has a pager configured then this function takes care
1080 * of collating output into the pager buffer; ensuring only the first page
1081 * is displayed and any lines in excess of the first page are buffered.
1083 * If the maximum number of index lines in the buffer is exceeded then the
1084 * pager is cancelled and the contents of the current buffer are sent to the
1087 * If there is no pager configured then the output is sent directly to the
1090 * @param cli_file_index Index of the CLI session where this output is
1092 * @param buffer String of printabe bytes to be output.
1093 * @param buffer_bytes The number of bytes in @c buffer to be output.
1096 unix_vlib_cli_output (uword cli_file_index, u8 * buffer, uword buffer_bytes)
1098 unix_main_t *um = &unix_main;
1099 clib_file_main_t *fm = &file_main;
1100 unix_cli_main_t *cm = &unix_cli_main;
1101 unix_cli_file_t *cf;
1104 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
1105 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1107 if (cf->no_pager || um->cli_pager_buffer_limit == 0 || cf->height == 0)
1109 unix_vlib_cli_output_cooked (cf, uf, buffer, buffer_bytes);
1113 word row = vec_len (cf->pager_index);
1115 unix_cli_pager_index_t *pi;
1117 /* Index and add the output lines to the pager buffer. */
1118 unix_cli_pager_add_line (cf, buffer, buffer_bytes);
1120 /* Now iterate what was added to display the lines.
1121 * If we reach the bottom of the page, display a prompt.
1123 while (row < vec_len (cf->pager_index))
1125 if (row < cf->height - 1)
1127 /* output this line */
1128 pi = &cf->pager_index[row];
1129 line = cf->pager_vector[pi->line] + pi->offset;
1130 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1132 /* if the last line didn't end in newline, and we're at the
1133 * bottom of the page, add a newline */
1134 if (line[pi->length - 1] != '\n' && row == cf->height - 2)
1135 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1139 /* Display the pager prompt every 10 lines */
1141 unix_cli_pager_prompt (cf, uf);
1146 /* Check if we went over the pager buffer limit */
1147 if (vec_len (cf->pager_index) > um->cli_pager_buffer_limit)
1149 /* Stop using the pager for the remainder of this CLI command */
1152 /* If we likely printed the prompt, erase it */
1153 if (vec_len (cf->pager_index) > cf->height - 1)
1154 unix_cli_pager_prompt_erase (cf, uf);
1156 /* Dump out the contents of the buffer */
1157 for (row = cf->pager_start + (cf->height - 1);
1158 row < vec_len (cf->pager_index); row++)
1160 pi = &cf->pager_index[row];
1161 line = cf->pager_vector[pi->line] + pi->offset;
1162 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1165 unix_cli_pager_reset (cf);
1170 /** Identify whether a terminal type is ANSI capable.
1172 * Compares the string given in @c term with a list of terminal types known
1173 * to support ANSI escape sequences.
1175 * This list contains, for example, @c xterm, @c screen and @c ansi.
1177 * @param term A string with a terminal type in it.
1178 * @param len The length of the string in @c term.
1180 * @return @c 1 if the terminal type is recognized as supporting ANSI
1181 * terminal sequences; @c 0 otherwise.
1184 unix_cli_terminal_type_ansi (u8 * term, uword len)
1186 /* This may later be better done as a hash of some sort. */
1188 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1193 _("xterm-256color"); /* iTerm on Mac */
1195 _("screen-256color"); /* Screen and tmux */
1196 _("ansi"); /* Microsoft Telnet */
1202 /** Identify whether a terminal type is non-interactive.
1204 * Compares the string given in @c term with a list of terminal types known
1205 * to be non-interactive, as send by tools such as @c vppctl .
1207 * This list contains, for example, @c vppctl.
1209 * @param term A string with a terminal type in it.
1210 * @param len The length of the string in @c term.
1212 * @return @c 1 if the terminal type is recognized as being non-interactive;
1216 unix_cli_terminal_type_noninteractive (u8 * term, uword len)
1218 /* This may later be better done as a hash of some sort. */
1220 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1229 /** Set a session to be non-interactive. */
1231 unix_cli_set_session_noninteractive (unix_cli_file_t * cf)
1233 /* Non-interactive sessions don't get these */
1234 cf->is_interactive = 0;
1236 cf->history_limit = 0;
1237 cf->has_history = 0;
1241 /** @brief Emit initial welcome banner and prompt on a connection. */
1243 unix_cli_file_welcome (unix_cli_main_t * cm, unix_cli_file_t * cf)
1245 unix_main_t *um = &unix_main;
1246 clib_file_main_t *fm = &file_main;
1247 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1248 unix_cli_banner_t *banner;
1251 /* Mark the session as started if we get here */
1254 if (!(cf->is_interactive)) /* No banner for non-interactive sessions */
1258 * Put the first bytes directly into the buffer so that further output is
1259 * queued until everything is ready. (oterwise initial prompt can appear
1260 * mid way through VPP initialization)
1262 unix_cli_add_pending_output (uf, cf, (u8 *) "\r", 1);
1264 if (!um->cli_no_banner && (um->flags & UNIX_FLAG_NOBANNER) == 0)
1266 if (cf->ansi_capable && (um->flags & UNIX_FLAG_NOCOLOR) == 0)
1268 banner = unix_cli_banner_color;
1269 len = ARRAY_LEN (unix_cli_banner_color);
1273 banner = unix_cli_banner;
1274 len = ARRAY_LEN (unix_cli_banner);
1277 for (i = 0; i < len; i++)
1279 unix_vlib_cli_output_cooked (cf, uf,
1280 banner[i].line, banner[i].length);
1285 unix_cli_cli_prompt (cf, uf);
1290 * @brief A failsafe manager that ensures CLI sessions issue an initial
1291 * prompt if TELNET negotiation fails.
1294 unix_cli_new_session_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1297 unix_cli_main_t *cm = &unix_cli_main;
1298 uword event_type, *event_data = 0;
1303 if (vec_len (cm->new_sessions) > 0)
1304 wait = vlib_process_wait_for_event_or_clock (vm, wait);
1306 vlib_process_wait_for_event (vm);
1308 event_type = vlib_process_get_events (vm, &event_data);
1312 case ~0: /* no events => timeout */
1315 case UNIX_CLI_NEW_SESSION_EVENT_ADD:
1317 /* Add an identifier to the new session list */
1318 unix_cli_new_session_t ns;
1320 /* Check the connection didn't close already */
1321 if (pool_is_free_index (cm->cli_file_pool, event_data[0]))
1324 ns.cf_index = event_data[0];
1325 ns.deadline = vlib_time_now (vm) + 1.0;
1327 vec_add1 (cm->new_sessions, ns);
1330 wait = 0.1; /* force a re-evaluation soon, but not too soon */
1335 clib_warning ("BUG: unknown event type 0x%wx", event_type);
1339 vec_reset_length (event_data);
1341 if (vlib_process_suspend_time_is_zero (wait))
1343 /* Scan the list looking for expired deadlines.
1344 * Emit needed prompts and remove from the list.
1345 * While scanning, look for the nearest new deadline
1346 * for the next iteration.
1347 * Since the list is ordered with newest sessions first
1348 * we can make assumptions about expired sessions being
1349 * contiguous at the beginning and the next deadline is the
1350 * next entry on the list, if any.
1352 f64 now = vlib_time_now (vm);
1353 unix_cli_new_session_t *nsp;
1358 vec_foreach (nsp, cm->new_sessions)
1360 if (vlib_process_suspend_time_is_zero (nsp->deadline - now))
1362 /* Deadline reached */
1363 unix_cli_file_t *cf;
1365 /* Mark the highwater */
1368 /* Check the connection didn't close already */
1369 if (pool_is_free_index (cm->cli_file_pool, nsp->cf_index))
1372 cf = pool_elt_at_index (cm->cli_file_pool, nsp->cf_index);
1375 unix_cli_file_welcome (cm, cf);
1379 wait = nsp->deadline - now;
1386 /* We have sessions to remove */
1387 vec_delete (cm->new_sessions, index, 0);
1396 /** @brief A mostly no-op Telnet state machine.
1397 * Process Telnet command bytes in a way that ensures we're mostly
1398 * transparent to the Telnet protocol. That is, it's mostly a no-op.
1400 * @return -1 if we need more bytes, otherwise a positive integer number of
1401 * bytes to consume from the input_vector, not including the initial
1405 unix_cli_process_telnet (unix_main_t * um,
1406 unix_cli_file_t * cf,
1407 clib_file_t * uf, u8 * input_vector, uword len)
1409 /* Input_vector starts at IAC byte.
1410 * See if we have a complete message; if not, return -1 so we wait for more.
1411 * if we have a complete message, consume those bytes from the vector.
1416 return -1; /* want more bytes */
1418 switch (input_vector[1])
1421 /* two IAC's in a row means to pass through 0xff.
1422 * since that makes no sense here, just consume it.
1431 /* Expect 3 bytes */
1433 return -1; /* want more bytes */
1440 /* Sub option - search ahead for IAC SE to end it */
1442 for (i = 3; i < len && i < UNIX_CLI_MAX_DEPTH_TELNET; i++)
1444 if (input_vector[i - 1] == IAC && input_vector[i] == SE)
1446 /* We have a complete message; see if we care about it */
1447 switch (input_vector[2])
1450 if (input_vector[3] != 0)
1453 /* See if the the terminal type is recognized */
1454 u8 *term = input_vector + 4;
1457 /* See if the terminal type is ANSI capable */
1459 unix_cli_terminal_type_ansi (term, len);
1461 /* See if the terminal type indicates non-interactive */
1462 if (unix_cli_terminal_type_noninteractive (term, len))
1463 unix_cli_set_session_noninteractive (cf);
1466 /* If session not started, we can release the pause */
1468 /* Send the welcome banner and initial prompt */
1469 unix_cli_file_welcome (&unix_cli_main, cf);
1474 if (i != 8) /* check message is correct size */
1478 clib_net_to_host_u16 (*((u16 *) (input_vector + 3)));
1479 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
1480 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
1482 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
1485 clib_net_to_host_u16 (*((u16 *) (input_vector + 5)));
1486 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
1487 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
1488 if (cf->height == 0)
1489 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
1491 /* reindex pager buffer */
1492 unix_cli_pager_reindex (cf);
1494 unix_cli_pager_redraw (cf, uf);
1500 /* Consume it all */
1506 if (i == UNIX_CLI_MAX_DEPTH_TELNET)
1507 consume = 1; /* hit max search depth, advance one byte */
1510 return -1; /* want more bytes */
1528 /* Simple one-byte messages */
1533 /* Are You There - trigger a visible response */
1535 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "fd.io VPP\n", 10);
1539 /* Unknown command! Eat the IAC byte */
1546 /** @brief Process actionable input.
1547 * Based on the \c action process the input; this typically involves
1548 * searching the command history or editing the current command line.
1551 unix_cli_line_process_one (unix_cli_main_t * cm,
1553 unix_cli_file_t * cf,
1555 u8 input, unix_cli_parse_action_t action)
1559 u8 **possible_commands;
1564 case UNIX_CLI_PARSE_ACTION_NOACTION:
1567 case UNIX_CLI_PARSE_ACTION_REVSEARCH:
1568 case UNIX_CLI_PARSE_ACTION_FWDSEARCH:
1569 if (!cf->has_history || !cf->history_limit)
1571 if (cf->search_mode == 0)
1573 /* Erase the current command (if any) */
1574 for (; cf->cursor > 0; cf->cursor--)
1576 unix_vlib_cli_output_cursor_left (cf, uf);
1577 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1578 unix_vlib_cli_output_cursor_left (cf, uf);
1581 vec_reset_length (cf->search_key);
1582 vec_reset_length (cf->current_command);
1584 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1585 cf->search_mode = -1;
1587 cf->search_mode = 1;
1591 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1592 cf->search_mode = -1;
1594 cf->search_mode = 1;
1596 cf->excursion += cf->search_mode;
1601 case UNIX_CLI_PARSE_ACTION_ERASELINELEFT:
1602 /* Erase the command from the cursor to the start */
1605 /* Shimmy backwards to the new end of line position */
1606 delta = vec_len (cf->current_command) - cf->cursor;
1607 for (; cf->cursor > delta; cf->cursor--)
1608 unix_vlib_cli_output_cursor_left (cf, uf);
1609 /* Zap from here to the end of what is currently displayed */
1610 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1611 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1612 /* Get back to the start of the line */
1613 for (; cf->cursor > 0; cf->cursor--)
1614 unix_vlib_cli_output_cursor_left (cf, uf);
1616 /* Delete the desired text from the command */
1617 memmove (cf->current_command, cf->current_command + j, delta);
1618 vec_set_len (cf->current_command, delta);
1620 /* Print the new contents */
1621 unix_vlib_cli_output_cooked (cf, uf, cf->current_command, delta);
1622 cf->cursor = delta; /* for backspace tracking */
1624 /* Shimmy back to the start */
1625 for (; cf->cursor > 0; cf->cursor--)
1626 unix_vlib_cli_output_cursor_left (cf, uf);
1628 cf->search_mode = 0;
1631 case UNIX_CLI_PARSE_ACTION_ERASELINERIGHT:
1632 /* Erase the command from the cursor to the end */
1635 /* Zap from cursor to end of what is currently displayed */
1636 for (; cf->cursor < (vec_len (cf->current_command)); cf->cursor++)
1637 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1638 /* Get back to where we were */
1639 for (; cf->cursor > j; cf->cursor--)
1640 unix_vlib_cli_output_cursor_left (cf, uf);
1642 /* Truncate the line at the cursor */
1643 vec_set_len (cf->current_command, cf->cursor);
1645 cf->search_mode = 0;
1648 case UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT:
1649 /* calculate num of caracter to be erased */
1651 while (cf->cursor > delta
1652 && cf->current_command[cf->cursor - delta - 1] == ' ')
1654 while (cf->cursor > delta
1655 && cf->current_command[cf->cursor - delta - 1] != ' ')
1658 if (vec_len (cf->current_command))
1662 /* move cursor left delta times */
1663 for (j = delta; j > 0; j--, cf->cursor--)
1664 unix_vlib_cli_output_cursor_left (cf, uf);
1665 save = cf->current_command + cf->cursor;
1667 /* redraw remainder of line */
1668 memmove (cf->current_command + cf->cursor,
1669 cf->current_command + cf->cursor + delta,
1670 _vec_len (cf->current_command) - cf->cursor - delta);
1671 unix_vlib_cli_output_cooked (cf, uf,
1672 cf->current_command + cf->cursor,
1673 _vec_len (cf->current_command) -
1675 cf->cursor += _vec_len (cf->current_command) - cf->cursor;
1677 /* print delta amount of blank spaces,
1678 * then finally fix the cursor position */
1679 for (j = delta; j > 0; j--, cf->cursor--)
1680 unix_vlib_cli_output_cursor_left (cf, uf);
1681 for (j = delta; j > 0; j--, cf->cursor++)
1682 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1683 for (; (cf->current_command + cf->cursor) > save; cf->cursor--)
1684 unix_vlib_cli_output_cursor_left (cf, uf);
1685 vec_dec_len (cf->current_command, delta);
1688 cf->search_mode = 0;
1690 vec_reset_length (cf->search_key);
1693 case UNIX_CLI_PARSE_ACTION_LEFT:
1696 unix_vlib_cli_output_cursor_left (cf, uf);
1700 cf->search_mode = 0;
1703 case UNIX_CLI_PARSE_ACTION_RIGHT:
1704 if (cf->cursor < vec_len (cf->current_command))
1706 /* have to emit the character under the cursor */
1707 unix_vlib_cli_output_cooked (cf, uf,
1708 cf->current_command + cf->cursor, 1);
1712 cf->search_mode = 0;
1715 case UNIX_CLI_PARSE_ACTION_UP:
1716 case UNIX_CLI_PARSE_ACTION_DOWN:
1717 if (!cf->has_history || !cf->history_limit)
1719 cf->search_mode = 0;
1720 /* Erase the command */
1721 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1722 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1723 for (; cf->cursor > 0; cf->cursor--)
1725 unix_vlib_cli_output_cursor_left (cf, uf);
1726 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1727 unix_vlib_cli_output_cursor_left (cf, uf);
1729 vec_reset_length (cf->current_command);
1730 if (vec_len (cf->command_history))
1732 if (action == UNIX_CLI_PARSE_ACTION_UP)
1737 cf->excursion += delta;
1739 if (cf->excursion == vec_len (cf->command_history))
1741 /* down-arrowed to last entry - want a blank line */
1742 vec_set_len (cf->current_command, 0);
1744 else if (cf->excursion < 0)
1746 /* up-arrowed over the start to the end, want a blank line */
1747 cf->excursion = vec_len (cf->command_history);
1748 vec_set_len (cf->current_command, 0);
1752 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1753 /* down-arrowed past end - wrap to start */
1756 /* Print the command at the current position */
1757 prev = cf->command_history[cf->excursion];
1758 vec_validate (cf->current_command, vec_len (prev) - 1);
1760 clib_memcpy (cf->current_command, prev, vec_len (prev));
1761 vec_set_len (cf->current_command, vec_len (prev));
1762 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1763 vec_len (cf->current_command));
1766 cf->cursor = vec_len (cf->current_command);
1769 case UNIX_CLI_PARSE_ACTION_HOME:
1770 if (vec_len (cf->current_command) && cf->cursor > 0)
1772 for (; cf->cursor > 0; cf->cursor--)
1773 unix_vlib_cli_output_cursor_left (cf, uf);
1776 cf->search_mode = 0;
1779 case UNIX_CLI_PARSE_ACTION_END:
1780 if (vec_len (cf->current_command) &&
1781 cf->cursor < vec_len (cf->current_command))
1783 unix_vlib_cli_output_cooked (cf, uf,
1784 cf->current_command + cf->cursor,
1785 vec_len (cf->current_command) -
1787 cf->cursor = vec_len (cf->current_command);
1790 cf->search_mode = 0;
1793 case UNIX_CLI_PARSE_ACTION_WORDLEFT:
1794 if (vec_len (cf->current_command) && cf->cursor > 0)
1796 unix_vlib_cli_output_cursor_left (cf, uf);
1799 while (cf->cursor && isspace (cf->current_command[cf->cursor]))
1801 unix_vlib_cli_output_cursor_left (cf, uf);
1804 while (cf->cursor && !isspace (cf->current_command[cf->cursor]))
1806 if (isspace (cf->current_command[cf->cursor - 1]))
1808 unix_vlib_cli_output_cursor_left (cf, uf);
1814 cf->search_mode = 0;
1817 case UNIX_CLI_PARSE_ACTION_WORDRIGHT:
1818 if (vec_len (cf->current_command) &&
1819 cf->cursor < vec_len (cf->current_command))
1821 int e = vec_len (cf->current_command);
1823 while (j < e && !isspace (cf->current_command[j]))
1825 while (j < e && isspace (cf->current_command[j]))
1827 unix_vlib_cli_output_cooked (cf, uf,
1828 cf->current_command + cf->cursor,
1833 cf->search_mode = 0;
1837 case UNIX_CLI_PARSE_ACTION_ERASE:
1838 if (vec_len (cf->current_command))
1840 if (cf->cursor == vec_len (cf->current_command))
1842 unix_vlib_cli_output_cursor_left (cf, uf);
1844 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1846 unix_vlib_cli_output_cursor_left (cf, uf);
1848 vec_dec_len (cf->current_command, 1);
1850 else if (cf->cursor > 0)
1852 /* shift everything at & to the right of the cursor left by 1 */
1853 j = vec_len (cf->current_command) - cf->cursor;
1854 memmove (cf->current_command + cf->cursor - 1,
1855 cf->current_command + cf->cursor, j);
1856 vec_dec_len (cf->current_command, 1);
1858 /* redraw the rest of the line */
1859 unix_vlib_cli_output_cursor_left (cf, uf);
1861 unix_vlib_cli_output_cooked (cf, uf,
1862 cf->current_command + cf->cursor,
1865 /* erase last char */
1866 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1869 /* and shift the terminal cursor back where it should be */
1870 j += 2; /* account for old string length and offset position */
1873 unix_vlib_cli_output_cursor_left (cf, uf);
1878 cf->search_mode = 0;
1880 vec_reset_length (cf->search_key);
1883 case UNIX_CLI_PARSE_ACTION_ERASERIGHT:
1884 if (vec_len (cf->current_command))
1886 if (cf->cursor < vec_len (cf->current_command))
1888 /* shift everything to the right of the cursor left by 1 */
1889 j = vec_len (cf->current_command) - cf->cursor - 1;
1890 memmove (cf->current_command + cf->cursor,
1891 cf->current_command + cf->cursor + 1, j);
1892 vec_dec_len (cf->current_command, 1);
1893 /* redraw the rest of the line */
1894 unix_vlib_cli_output_cooked (cf, uf,
1895 cf->current_command + cf->cursor,
1898 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1900 unix_vlib_cli_output_cursor_left (cf, uf);
1902 /* and shift the terminal cursor back where it should be */
1905 unix_vlib_cli_output_cursor_left (cf, uf);
1909 unix_vlib_cli_output_cursor_left (cf, uf);
1915 else if (input == 'D' - '@')
1917 /* ^D with no command entered = quit */
1918 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "quit\n", 5);
1919 vlib_process_signal_event (um->vlib_main,
1920 vlib_current_process (um->vlib_main),
1921 UNIX_CLI_PROCESS_EVENT_QUIT,
1922 cf - cm->cli_file_pool);
1924 cf->search_mode = 0;
1926 vec_reset_length (cf->search_key);
1929 case UNIX_CLI_PARSE_ACTION_CLEAR:
1930 /* If we're in ANSI mode, clear the screen.
1931 * Then redraw the prompt and any existing command input, then put
1932 * the cursor back where it was in that line.
1934 if (cf->ansi_capable)
1935 unix_vlib_cli_output_cooked (cf, uf,
1937 sizeof (ANSI_CLEAR) - 1);
1939 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1941 unix_vlib_cli_output_raw (cf, uf,
1942 cm->cli_prompt, vec_len (cm->cli_prompt));
1943 unix_vlib_cli_output_cooked (cf, uf,
1944 cf->current_command,
1945 vec_len (cf->current_command));
1947 cf->cursor = vec_len (cf->current_command);
1948 for (; cf->cursor > j; cf->cursor--)
1949 unix_vlib_cli_output_cursor_left (cf, uf);
1953 case UNIX_CLI_PARSE_ACTION_TAB:
1954 if (cf->cursor < vec_len (cf->current_command))
1956 /* if we are in the middle of a line, complete only if
1957 * the cursor points to whitespace */
1958 if (isspace (cf->current_command[cf->cursor]))
1960 /* save and clear any input that is after the cursor */
1961 vec_resize (save, vec_len (cf->current_command) - cf->cursor);
1962 clib_memcpy (save, cf->current_command + cf->cursor,
1963 vec_len (cf->current_command) - cf->cursor);
1964 vec_set_len (cf->current_command, cf->cursor);
1968 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1973 vlib_cli_get_possible_completions (cf->current_command);
1974 if (vec_len (possible_commands) == 1)
1976 u8 *completed = possible_commands[0];
1979 /* find the last word of current_command */
1980 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1982 unix_vlib_cli_output_cursor_left (cf, uf);
1986 vec_set_len (cf->current_command, j);
1988 /* replace it with the newly expanded command */
1989 vec_append (cf->current_command, completed);
1991 /* echo to the terminal */
1992 unix_vlib_cli_output_cooked (cf, uf, completed,
1993 vec_len (completed));
1995 /* add one trailing space if needed */
1996 if (vec_len (save) == 0)
1998 vec_add1 (cf->current_command, ' ');
1999 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2002 cf->cursor = vec_len (cf->current_command);
2005 else if (vec_len (possible_commands) >= 2)
2007 u8 **possible_command;
2008 uword max_command_len = 0, min_command_len = ~0;
2011 vec_foreach (possible_command, possible_commands)
2013 if (vec_len (*possible_command) > max_command_len)
2014 max_command_len = vec_len (*possible_command);
2015 if (vec_len (*possible_command) < min_command_len)
2016 min_command_len = vec_len (*possible_command);
2019 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2022 vec_foreach (possible_command, possible_commands)
2024 if (i + max_command_len >= cf->width)
2026 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2029 unix_vlib_cli_output_cooked (cf, uf, *possible_command,
2030 vec_len (*possible_command));
2031 for (j = vec_len (*possible_command); j < max_command_len + 2;
2034 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2036 i += max_command_len + 2;
2039 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2041 /* rewrite prompt */
2042 unix_cli_cli_prompt (cf, uf);
2043 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2044 vec_len (cf->current_command));
2046 /* count length of last word */
2049 while (j >= 1 && !isspace (cf->current_command[j - 1]))
2055 /* determine smallest common command */
2056 for (; i < min_command_len; i++)
2061 vec_foreach (possible_command, possible_commands)
2065 common = (*possible_command)[i];
2067 else if (common != (*possible_command)[i])
2076 vec_add1 (cf->current_command, common);
2078 unix_vlib_cli_output_cooked (cf, uf, (u8 *) & common, 1);
2088 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
2091 if (vec_len (save) > 0)
2093 /* restore remaining input if tab was hit in the middle of a line */
2094 unix_vlib_cli_output_cooked (cf, uf, save, vec_len (save));
2095 cf->cursor += vec_len (save);
2096 for (j = 0; j < vec_len (save); j++, cf->cursor--)
2097 unix_vlib_cli_output_cursor_left (cf, uf);
2098 vec_append (cf->current_command, save);
2101 vec_free (possible_commands);
2104 case UNIX_CLI_PARSE_ACTION_YANK:
2109 case UNIX_CLI_PARSE_ACTION_PAGER_QUIT:
2111 unix_cli_pager_prompt_erase (cf, uf);
2112 unix_cli_pager_reset (cf);
2113 unix_cli_cli_prompt (cf, uf);
2116 case UNIX_CLI_PARSE_ACTION_PAGER_NEXT:
2117 case UNIX_CLI_PARSE_ACTION_PAGER_PGDN:
2118 /* show next page of the buffer */
2119 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
2122 unix_cli_pager_index_t *pi = NULL;
2124 int m = cf->pager_start + (cf->height - 1);
2125 unix_cli_pager_prompt_erase (cf, uf);
2127 j < vec_len (cf->pager_index) && cf->pager_start < m;
2128 j++, cf->pager_start++)
2130 pi = &cf->pager_index[j];
2131 line = cf->pager_vector[pi->line] + pi->offset;
2132 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2134 /* if the last line didn't end in newline, add a newline */
2135 if (pi && line[pi->length - 1] != '\n')
2136 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2137 unix_cli_pager_prompt (cf, uf);
2141 if (action == UNIX_CLI_PARSE_ACTION_PAGER_NEXT)
2142 /* no more in buffer, exit, but only if it was <space> */
2147 case UNIX_CLI_PARSE_ACTION_PAGER_DN:
2148 case UNIX_CLI_PARSE_ACTION_PAGER_CRLF:
2149 /* display the next line of the buffer */
2150 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
2153 unix_cli_pager_index_t *pi;
2155 unix_cli_pager_prompt_erase (cf, uf);
2156 pi = &cf->pager_index[cf->pager_start + (cf->height - 1)];
2157 line = cf->pager_vector[pi->line] + pi->offset;
2158 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2160 /* if the last line didn't end in newline, add a newline */
2161 if (line[pi->length - 1] != '\n')
2162 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2163 unix_cli_pager_prompt (cf, uf);
2167 if (action == UNIX_CLI_PARSE_ACTION_PAGER_CRLF)
2168 /* no more in buffer, exit, but only if it was <enter> */
2174 case UNIX_CLI_PARSE_ACTION_PAGER_UP:
2175 /* scroll the page back one line */
2176 if (cf->pager_start > 0)
2179 unix_cli_pager_index_t *pi = NULL;
2182 if (cf->ansi_capable)
2184 pi = &cf->pager_index[cf->pager_start];
2185 line = cf->pager_vector[pi->line] + pi->offset;
2186 unix_cli_pager_prompt_erase (cf, uf);
2187 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SCROLLDN,
2188 sizeof (ANSI_SCROLLDN) - 1);
2189 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SAVECURSOR,
2190 sizeof (ANSI_SAVECURSOR) - 1);
2191 unix_cli_ansi_cursor (cf, uf, 1, 1);
2192 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_CLEARLINE,
2193 sizeof (ANSI_CLEARLINE) - 1);
2194 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2195 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_RESTCURSOR,
2196 sizeof (ANSI_RESTCURSOR) - 1);
2197 unix_cli_pager_prompt_erase (cf, uf);
2198 unix_cli_pager_prompt (cf, uf);
2202 int m = cf->pager_start + (cf->height - 1);
2203 unix_cli_pager_prompt_erase (cf, uf);
2204 for (j = cf->pager_start;
2205 j < vec_len (cf->pager_index) && j < m; j++)
2207 pi = &cf->pager_index[j];
2208 line = cf->pager_vector[pi->line] + pi->offset;
2209 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2211 /* if the last line didn't end in newline, add a newline */
2212 if (pi && line[pi->length - 1] != '\n')
2213 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2214 unix_cli_pager_prompt (cf, uf);
2219 case UNIX_CLI_PARSE_ACTION_PAGER_TOP:
2220 /* back to the first page of the buffer */
2221 if (cf->pager_start > 0)
2224 unix_cli_pager_index_t *pi = NULL;
2226 cf->pager_start = 0;
2227 int m = cf->pager_start + (cf->height - 1);
2228 unix_cli_pager_prompt_erase (cf, uf);
2229 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2232 pi = &cf->pager_index[j];
2233 line = cf->pager_vector[pi->line] + pi->offset;
2234 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2236 /* if the last line didn't end in newline, add a newline */
2237 if (pi && line[pi->length - 1] != '\n')
2238 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2239 unix_cli_pager_prompt (cf, uf);
2243 case UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM:
2244 /* skip to the last page of the buffer */
2245 if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
2248 unix_cli_pager_index_t *pi = NULL;
2250 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
2251 unix_cli_pager_prompt_erase (cf, uf);
2252 unix_cli_pager_message (cf, uf, "skipping", "\n");
2253 for (j = cf->pager_start; j < vec_len (cf->pager_index); j++)
2255 pi = &cf->pager_index[j];
2256 line = cf->pager_vector[pi->line] + pi->offset;
2257 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2259 /* if the last line didn't end in newline, add a newline */
2260 if (pi && line[pi->length - 1] != '\n')
2261 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2262 unix_cli_pager_prompt (cf, uf);
2266 case UNIX_CLI_PARSE_ACTION_PAGER_PGUP:
2267 /* wander back one page in the buffer */
2268 if (cf->pager_start > 0)
2271 unix_cli_pager_index_t *pi = NULL;
2274 if (cf->pager_start >= cf->height)
2275 cf->pager_start -= cf->height - 1;
2277 cf->pager_start = 0;
2278 m = cf->pager_start + cf->height - 1;
2279 unix_cli_pager_prompt_erase (cf, uf);
2280 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2283 pi = &cf->pager_index[j];
2284 line = cf->pager_vector[pi->line] + pi->offset;
2285 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2287 /* if the last line didn't end in newline, add a newline */
2288 if (pi && line[pi->length - 1] != '\n')
2289 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2290 unix_cli_pager_prompt (cf, uf);
2294 case UNIX_CLI_PARSE_ACTION_PAGER_REDRAW:
2295 /* Redraw the current pager screen */
2296 unix_cli_pager_redraw (cf, uf);
2299 case UNIX_CLI_PARSE_ACTION_PAGER_SEARCH:
2300 /* search forwards in the buffer */
2304 case UNIX_CLI_PARSE_ACTION_CRLF:
2306 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2308 if (cf->has_history && cf->history_limit)
2310 if (cf->command_history
2311 && vec_len (cf->command_history) >= cf->history_limit)
2313 vec_free (cf->command_history[0]);
2314 vec_delete (cf->command_history, 1, 0);
2316 /* Don't add blank lines to the cmd history */
2317 if (vec_len (cf->current_command))
2319 /* Don't duplicate the previous command */
2320 j = vec_len (cf->command_history);
2322 (vec_len (cf->current_command) !=
2323 vec_len (cf->command_history[j - 1])
2324 || memcmp (cf->current_command, cf->command_history[j - 1],
2325 vec_len (cf->current_command)) != 0))
2327 /* copy the command to the history */
2329 vec_append (c, cf->current_command);
2330 vec_add1 (cf->command_history, c);
2331 cf->command_number++;
2334 cf->excursion = vec_len (cf->command_history);
2337 cf->search_mode = 0;
2338 vec_reset_length (cf->search_key);
2343 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2344 case UNIX_CLI_PARSE_ACTION_NOMATCH:
2345 if (vec_len (cf->pager_index))
2349 else if (cf->has_history && cf->search_mode != 0 && isprint (input))
2351 int k, limit, offset;
2354 vec_add1 (cf->search_key, input);
2357 for (j = 0; j < vec_len (cf->command_history); j++)
2359 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
2361 else if (cf->excursion < 0)
2362 cf->excursion = vec_len (cf->command_history) - 1;
2364 item = cf->command_history[cf->excursion];
2366 limit = (vec_len (cf->search_key) > vec_len (item)) ?
2367 vec_len (item) : vec_len (cf->search_key);
2369 for (offset = 0; offset <= vec_len (item) - limit; offset++)
2371 for (k = 0; k < limit; k++)
2373 if (item[k + offset] != cf->search_key[k])
2376 goto found_at_offset;
2384 for (; cf->cursor > 0; cf->cursor--)
2386 unix_vlib_cli_output_cursor_left (cf, uf);
2387 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2388 unix_vlib_cli_output_cursor_left (cf, uf);
2391 vec_validate (cf->current_command, vec_len (item) - 1);
2392 clib_memcpy (cf->current_command, item, vec_len (item));
2393 vec_set_len (cf->current_command, vec_len (item));
2395 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2396 vec_len (cf->current_command));
2397 cf->cursor = vec_len (cf->current_command);
2401 cf->excursion += cf->search_mode;
2404 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\nNo match...", 12);
2405 vec_reset_length (cf->search_key);
2406 vec_reset_length (cf->current_command);
2407 cf->search_mode = 0;
2411 else if (isprint (input)) /* skip any errant control codes */
2413 if (cf->cursor == vec_len (cf->current_command))
2416 vec_add1 (cf->current_command, input);
2419 /* Echo the character back to the client */
2420 unix_vlib_cli_output_cooked (cf, uf, &input, 1);
2424 /* Insert at cursor: resize +1 byte, move everything over */
2425 j = vec_len (cf->current_command) - cf->cursor;
2426 vec_add1 (cf->current_command, (u8) 'A');
2427 memmove (cf->current_command + cf->cursor + 1,
2428 cf->current_command + cf->cursor, j);
2429 cf->current_command[cf->cursor] = input;
2430 /* Redraw the line */
2432 unix_vlib_cli_output_cooked (cf, uf,
2433 cf->current_command + cf->cursor,
2437 /* Put terminal cursor back */
2438 for (; j > 0; j--, cf->cursor--)
2439 unix_vlib_cli_output_cursor_left (cf, uf);
2444 /* no-op - not printable or otherwise not actionable */
2451 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2457 /** @brief Process input bytes on a stream to provide line editing and
2458 * command history in the CLI. */
2460 unix_cli_line_edit (unix_cli_main_t * cm, unix_main_t * um,
2461 clib_file_main_t * fm, unix_cli_file_t * cf)
2463 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2466 for (i = 0; i < vec_len (cf->input_vector); i++)
2468 unix_cli_parse_action_t action;
2470 unix_cli_parse_actions_t *a;
2472 /* If we're in the pager mode, search the pager actions */
2474 vec_len (cf->pager_index) ? unix_cli_parse_pager :
2475 unix_cli_parse_strings;
2477 /* See if the input buffer is some sort of control code */
2478 action = unix_cli_match_action (a, &cf->input_vector[i],
2479 vec_len (cf->input_vector) - i,
2484 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2487 /* There was a partial match which means we need more bytes
2488 * than the input buffer currently has.
2489 * Since the bytes before here have been processed, shift
2490 * the remaining contents to the start of the input buffer.
2492 vec_delete (cf->input_vector, i, 0);
2494 return 1; /* wait for more */
2496 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2497 /* process telnet options */
2498 matched = unix_cli_process_telnet (um, cf, uf,
2499 cf->input_vector + i,
2500 vec_len (cf->input_vector) - i);
2503 /* There was a partial match which means we need more bytes
2504 * than the input buffer currently has.
2509 * Since the bytes before here have been processed, shift
2510 * the remaining contents to the start of the input buffer.
2512 vec_delete (cf->input_vector, i, 0);
2514 return 1; /* wait for more */
2519 /* If telnet option processing switched us to line mode, get us
2524 vec_delete (cf->input_vector, i, 0);
2525 vec_free (cf->current_command);
2526 cf->current_command = cf->input_vector;
2530 /* process the action */
2531 if (!unix_cli_line_process_one (cm, um, cf, uf,
2532 cf->input_vector[i], action))
2534 /* CRLF found. Consume the bytes from the input_vector */
2535 vec_delete (cf->input_vector, i + matched, 0);
2536 /* And tell our caller to execute cf->input_command */
2544 vec_reset_length (cf->input_vector);
2548 /** @brief Process input to a CLI session. */
2550 unix_cli_process_input (unix_cli_main_t * cm, uword cli_file_index)
2552 unix_main_t *um = &unix_main;
2553 clib_file_main_t *fm = &file_main;
2555 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2556 unformat_input_t input;
2557 int vlib_parse_eval (u8 *);
2559 cm->current_input_file_index = cli_file_index;
2562 /* Try vlibplex first. Someday... */
2563 if (0 && vlib_parse_eval (cf->input_vector) == 0)
2569 /* just treat whatever we got as a complete line of input */
2570 cf->current_command = cf->input_vector;
2574 /* Line edit, echo, etc. */
2575 if (unix_cli_line_edit (cm, um, fm, cf))
2576 /* want more input */
2583 vec_reset_length (lv);
2584 lv = format (lv, "%U[%d]: %v", format_timeval,
2585 NULL /* current bat-format */, 0 /* current bat-time */,
2586 cli_file_index, cf->current_command);
2587 if ((vec_len (cf->current_command) > 0) &&
2588 (cf->current_command[vec_len (cf->current_command) - 1] != '\n'))
2589 lv = format (lv, "\n");
2590 int rv __attribute__ ((unused)) = write (um->log_fd, lv, vec_len (lv));
2593 /* Run the command through the macro processor */
2594 if (vec_len (cf->current_command))
2597 vec_validate (cf->current_command, vec_len (cf->current_command));
2598 cf->current_command[vec_len (cf->current_command) - 1] = 0;
2599 /* The macro expander expects proper C-strings, not vectors */
2600 expanded = (u8 *) clib_macro_eval (&cf->macro_main,
2601 (i8 *) cf->current_command,
2604 8 /* max_level */ );
2605 /* Macro processor NULL terminates the return */
2606 vec_dec_len (expanded, 1);
2607 vec_reset_length (cf->current_command);
2608 vec_append (cf->current_command, expanded);
2609 vec_free (expanded);
2612 /* Build an unformat structure around our command */
2613 unformat_init_vector (&input, cf->current_command);
2615 /* Remove leading white space from input. */
2616 (void) unformat (&input, "");
2618 cf->pager_start = 0; /* start a new pager session */
2620 if (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
2621 vlib_cli_input (um->vlib_main, &input, unix_vlib_cli_output,
2624 /* Zero buffer since otherwise unformat_free will call vec_free on it. */
2627 unformat_free (&input);
2629 /* Re-fetch pointer since pool may have moved. */
2630 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2631 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2634 /* reset vector; we'll re-use it later */
2637 vec_reset_length (cf->input_vector);
2638 cf->current_command = 0;
2642 vec_reset_length (cf->current_command);
2645 if (cf->no_pager == 2)
2647 /* Pager was programmatically disabled */
2648 unix_cli_pager_message (cf, uf, "pager buffer overflowed", "\n");
2649 cf->no_pager = um->cli_no_pager;
2652 if (vec_len (cf->pager_index) == 0
2653 || vec_len (cf->pager_index) < cf->height)
2655 /* There was no need for the pager */
2656 unix_cli_pager_reset (cf);
2659 unix_cli_cli_prompt (cf, uf);
2663 /* Display the pager prompt */
2664 unix_cli_pager_prompt (cf, uf);
2667 /* Any residual data in the input vector? */
2668 if (vec_len (cf->input_vector))
2671 /* For non-interactive sessions send a NUL byte.
2672 * Specifically this is because vppctl needs to see some traffic in
2673 * order to move on to closing the session. Commands with no output
2674 * would thus cause vppctl to hang indefinitely in non-interactive mode
2675 * since there is also no prompt sent after the command completes.
2677 if (!cf->is_interactive)
2678 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\0", 1);
2681 /** Destroy a CLI session.
2682 * @note If we destroy the @c stdin session this additionally signals
2683 * the shutdown of VPP.
2686 unix_cli_kill (unix_cli_main_t * cm, uword cli_file_index)
2688 unix_main_t *um = &unix_main;
2689 clib_file_main_t *fm = &file_main;
2690 unix_cli_file_t *cf;
2694 /* Validate cli_file_index */
2695 if (pool_is_free_index (cm->cli_file_pool, cli_file_index))
2698 vec_foreach_index (i, cm->new_sessions)
2700 unix_cli_new_session_t *ns = vec_elt_at_index (cm->new_sessions, i);
2702 if (ns->cf_index == cli_file_index)
2709 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2710 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2712 /* Quit/EOF on stdin means quit program. */
2713 if (uf->file_descriptor == STDIN_FILENO)
2714 clib_longjmp (&um->vlib_main->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
2716 vec_free (cf->current_command);
2717 vec_free (cf->search_key);
2719 for (i = 0; i < vec_len (cf->command_history); i++)
2720 vec_free (cf->command_history[i]);
2722 vec_free (cf->command_history);
2723 vec_free (cf->input_vector);
2725 clib_file_del (fm, uf);
2727 unix_cli_file_free (cf);
2728 clib_macro_free (&cf->macro_main);
2729 pool_put (cm->cli_file_pool, cf);
2732 /** Handle system events. */
2734 unix_cli_process (vlib_main_t * vm,
2735 vlib_node_runtime_t * rt, vlib_frame_t * f)
2737 unix_cli_main_t *cm = &unix_cli_main;
2742 unix_cli_process_event_type_t event_type;
2743 vlib_process_wait_for_event (vm);
2744 event_type = vlib_process_get_events (vm, &data);
2748 case UNIX_CLI_PROCESS_EVENT_READ_READY:
2749 for (i = 0; i < vec_len (data); i++)
2750 unix_cli_process_input (cm, data[i]);
2753 case UNIX_CLI_PROCESS_EVENT_QUIT:
2754 /* Kill this process. */
2755 for (i = 0; i < vec_len (data); i++)
2756 unix_cli_kill (cm, data[i]);
2761 vec_set_len (data, 0);
2767 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
2769 /* Add node index so we can re-use this process later. */
2770 vec_add1 (cm->unused_cli_process_node_indices, rt->node_index);
2775 /** Called when a CLI session file descriptor can be written to without
2777 static clib_error_t *
2778 unix_cli_write_ready (clib_file_t * uf)
2780 unix_cli_main_t *cm = &unix_cli_main;
2781 unix_cli_file_t *cf;
2784 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2786 /* Flush output vector. */
2788 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
2789 n = send (uf->file_descriptor,
2790 cf->output_vector, vec_len (cf->output_vector), MSG_NOSIGNAL);
2792 n = write (uf->file_descriptor,
2793 cf->output_vector, vec_len (cf->output_vector));
2795 if (n < 0 && errno != EAGAIN)
2799 /* connection closed on us */
2800 unix_main_t *um = &unix_main;
2802 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
2803 UNIX_CLI_PROCESS_EVENT_QUIT,
2808 return clib_error_return_unix (0, "write");
2813 unix_cli_del_pending_output (uf, cf, n);
2815 return /* no error */ 0;
2818 /** Called when a CLI session file descriptor has data to be read. */
2819 static clib_error_t *
2820 unix_cli_read_ready (clib_file_t * uf)
2822 unix_main_t *um = &unix_main;
2823 unix_cli_main_t *cm = &unix_cli_main;
2824 unix_cli_file_t *cf;
2826 int n, n_read, n_try;
2828 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2833 l = vec_len (cf->input_vector);
2834 vec_resize (cf->input_vector, l + n_try);
2836 n = read (uf->file_descriptor, cf->input_vector + l, n_try);
2839 if (n < 0 && errno != EAGAIN)
2840 return clib_error_return_unix (0, "read");
2842 n_read = n < 0 ? 0 : n;
2843 vec_set_len (cf->input_vector, l + n_read);
2847 vlib_process_signal_event (um->vlib_main,
2848 cf->process_node_index,
2850 ? UNIX_CLI_PROCESS_EVENT_QUIT
2851 : UNIX_CLI_PROCESS_EVENT_READ_READY),
2852 /* event data */ uf->private_data);
2854 return /* no error */ 0;
2857 /** Called when a CLI session file descriptor has an error condition. */
2858 static clib_error_t *
2859 unix_cli_error_detected (clib_file_t * uf)
2861 unix_main_t *um = &unix_main;
2862 unix_cli_main_t *cm = &unix_cli_main;
2863 unix_cli_file_t *cf;
2865 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2866 cf->has_epipe = 1; /* prevent writes while the close is pending */
2867 vlib_process_signal_event (um->vlib_main,
2868 cf->process_node_index,
2869 UNIX_CLI_PROCESS_EVENT_QUIT,
2870 /* event data */ uf->private_data);
2872 return /* no error */ 0;
2875 /** Store a new CLI session.
2876 * @param name The name of the session.
2877 * @param fd The file descriptor for the session I/O.
2878 * @return The session ID.
2881 unix_cli_file_add (unix_cli_main_t * cm, char *name, int fd)
2883 unix_main_t *um = &unix_main;
2884 clib_file_main_t *fm = &file_main;
2885 unix_cli_file_t *cf;
2886 clib_file_t template = { 0 };
2887 vlib_main_t *vm = um->vlib_main;
2890 if (vec_len (cm->unused_cli_process_node_indices) > 0)
2892 n = vlib_get_node (vm, vec_pop (cm->unused_cli_process_node_indices));
2894 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
2898 static vlib_node_registration_t r = {
2899 .function = unix_cli_process,
2900 .type = VLIB_NODE_TYPE_PROCESS,
2901 .process_log2_n_stack_bytes = 18,
2903 static u32 count = 0;
2905 vlib_worker_thread_barrier_sync (vm);
2907 vlib_register_node (vm, &r, "unix-cli-process-%u", count++);
2909 n = vlib_get_node (vm, r.index);
2910 vlib_worker_thread_node_runtime_update ();
2911 vlib_worker_thread_barrier_release (vm);
2914 pool_get_zero (cm->cli_file_pool, cf);
2915 clib_macro_init (&cf->macro_main);
2917 template.read_function = unix_cli_read_ready;
2918 template.write_function = unix_cli_write_ready;
2919 template.error_function = unix_cli_error_detected;
2920 template.file_descriptor = fd;
2921 template.private_data = cf - cm->cli_file_pool;
2922 template.description = format (0, "%s", name);
2924 cf->name = format (0, "unix-cli-%s", name);
2925 cf->process_node_index = n->index;
2926 cf->clib_file_index = clib_file_add (fm, &template);
2927 cf->output_vector = 0;
2928 cf->input_vector = 0;
2929 vec_validate (cf->current_command, 0);
2930 vec_set_len (cf->current_command, 0);
2932 vlib_start_process (vm, n->runtime_index);
2934 vlib_process_t *p = vlib_get_process_from_node (vm, n);
2935 p->output_function = unix_vlib_cli_output;
2936 p->output_function_arg = cf - cm->cli_file_pool;
2938 return cf - cm->cli_file_pool;
2941 /** Telnet listening socket has a new connection. */
2942 static clib_error_t *
2943 unix_cli_listen_read_ready (clib_file_t * uf)
2945 unix_main_t *um = &unix_main;
2946 clib_file_main_t *fm = &file_main;
2947 unix_cli_main_t *cm = &unix_cli_main;
2948 clib_socket_t *s = &um->cli_listen_socket;
2949 clib_socket_t client;
2951 clib_error_t *error;
2952 unix_cli_file_t *cf;
2956 error = clib_socket_accept (s, &client);
2960 /* Disable Nagle, ignore any errors doing so eg on PF_LOCAL socket */
2962 (void) setsockopt (client.fd, IPPROTO_TCP, TCP_NODELAY,
2963 (void *) &one, sizeof (one));
2965 client_name = (char *) format (0, "%U%c", format_sockaddr, &client.peer, 0);
2967 cf_index = unix_cli_file_add (cm, client_name, client.fd);
2968 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2971 /* No longer need CLIB version of socket. */
2972 clib_socket_free (&client);
2973 vec_free (client_name);
2975 /* if we're supposed to run telnet session in character mode (default) */
2976 if (um->cli_line_mode == 0)
2979 * Set telnet client character mode, echo on, suppress "go-ahead".
2980 * Technically these should be negotiated, but this works.
2982 u8 charmode_option[] = {
2983 IAC, WONT, TELOPT_LINEMODE, /* server will do char-by-char */
2984 IAC, DONT, TELOPT_LINEMODE, /* client should do char-by-char */
2985 IAC, WILL, TELOPT_SGA, /* server willl supress GA */
2986 IAC, DO, TELOPT_SGA, /* client should supress Go Ahead */
2987 IAC, WILL, TELOPT_ECHO, /* server will do echo */
2988 IAC, DONT, TELOPT_ECHO, /* client should not echo */
2989 IAC, DO, TELOPT_TTYPE, /* client should tell us its term type */
2990 IAC, SB, TELOPT_TTYPE, 1, IAC, SE, /* now tell me ttype */
2991 IAC, DO, TELOPT_NAWS, /* client should tell us its window sz */
2992 IAC, SB, TELOPT_NAWS, 1, IAC, SE, /* now tell me window size */
2995 /* Enable history on this CLI */
2996 cf->history_limit = um->cli_history_limit;
2997 cf->has_history = cf->history_limit != 0;
2999 /* This is an interactive session until we decide otherwise */
3000 cf->is_interactive = 1;
3002 /* Make sure this session is in line mode */
3008 /* Setup the pager */
3009 cf->no_pager = um->cli_no_pager;
3011 /* Default terminal dimensions, should the terminal
3012 * fail to provide any.
3014 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3015 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3017 /* Send the telnet options */
3018 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3019 unix_vlib_cli_output_raw (cf, uf, charmode_option,
3020 ARRAY_LEN (charmode_option));
3022 if (cm->new_session_process_node_index == ~0)
3024 /* Create thw new session deadline process */
3025 cm->new_session_process_node_index =
3026 vlib_process_create (um->vlib_main, "unix-cli-new-session",
3027 unix_cli_new_session_process,
3028 16 /* log2_n_stack_bytes */ );
3031 /* In case the client doesn't negotiate terminal type, register
3032 * our session with a process that will emit the prompt if
3033 * a deadline passes */
3034 vlib_process_signal_event (um->vlib_main,
3035 cm->new_session_process_node_index,
3036 UNIX_CLI_NEW_SESSION_EVENT_ADD, cf_index);
3043 /** The system terminal has informed us that the window size
3047 unix_cli_resize_interrupt (int signum)
3049 clib_file_main_t *fm = &file_main;
3050 unix_cli_main_t *cm = &unix_cli_main;
3051 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
3052 cm->stdin_cli_file_index);
3053 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3057 /* Terminal resized, fetch the new size */
3058 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) < 0)
3060 /* "Should never happen..." */
3061 clib_unix_warning ("TIOCGWINSZ");
3062 /* We can't trust ws.XXX... */
3066 cf->width = ws.ws_col;
3067 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
3068 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
3070 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3072 cf->height = ws.ws_row;
3073 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
3074 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
3075 if (cf->height == 0)
3076 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3078 /* Reindex the pager buffer */
3079 unix_cli_pager_reindex (cf);
3081 /* Redraw the page */
3082 unix_cli_pager_redraw (cf, uf);
3085 /** Handle configuration directives in the @em unix section. */
3086 static clib_error_t *
3087 unix_cli_config (vlib_main_t * vm, unformat_input_t * input)
3089 unix_main_t *um = &unix_main;
3090 clib_file_main_t *fm = &file_main;
3091 unix_cli_main_t *cm = &unix_cli_main;
3093 clib_error_t *error = 0;
3094 unix_cli_file_t *cf;
3097 struct sigaction sa;
3101 /* We depend on unix flags being set. */
3102 if ((error = vlib_call_config_function (vm, unix_config)))
3105 if (um->flags & UNIX_FLAG_INTERACTIVE)
3107 /* Set stdin to be non-blocking. */
3108 if ((flags = fcntl (STDIN_FILENO, F_GETFL, 0)) < 0)
3110 (void) fcntl (STDIN_FILENO, F_SETFL, flags | O_NONBLOCK);
3112 cf_index = unix_cli_file_add (cm, "stdin", STDIN_FILENO);
3113 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
3114 cm->stdin_cli_file_index = cf_index;
3116 /* If stdin is a tty and we are using chacracter mode, enable
3117 * history on the CLI and set the tty line discipline accordingly. */
3118 if (isatty (STDIN_FILENO) && um->cli_line_mode == 0)
3120 /* Capture terminal resize events */
3121 clib_memset (&sa, 0, sizeof (sa));
3122 sa.sa_handler = unix_cli_resize_interrupt;
3123 if (sigaction (SIGWINCH, &sa, 0) < 0)
3124 clib_panic ("sigaction");
3126 /* Retrieve the current terminal size */
3127 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) == 0)
3129 cf->width = ws.ws_col;
3130 cf->height = ws.ws_row;
3133 if (cf->width == 0 || cf->height == 0)
3136 * We have a tty, but no size. Use defaults.
3137 * vpp "unix interactive" inside emacs + gdb ends up here.
3139 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3140 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3143 /* Setup the history */
3144 cf->history_limit = um->cli_history_limit;
3145 cf->has_history = cf->history_limit != 0;
3147 /* Setup the pager */
3148 cf->no_pager = um->cli_no_pager;
3150 /* This is an interactive session until we decide otherwise */
3151 cf->is_interactive = 1;
3153 /* We're going to be in char by char mode */
3156 /* Save the original tty state so we can restore it later */
3157 tcgetattr (STDIN_FILENO, &um->tio_stdin);
3160 /* Tweak the tty settings */
3161 tio = um->tio_stdin;
3162 /* echo off, canonical mode off, ext'd input processing off */
3163 tio.c_lflag &= ~(ECHO | ICANON | IEXTEN);
3164 /* disable XON/XOFF, so ^S invokes the history search */
3165 tio.c_iflag &= ~(IXON | IXOFF);
3166 tio.c_cc[VMIN] = 1; /* 1 byte at a time */
3167 tio.c_cc[VTIME] = 0; /* no timer */
3168 tio.c_cc[VSTOP] = _POSIX_VDISABLE; /* not ^S */
3169 tio.c_cc[VSTART] = _POSIX_VDISABLE; /* not ^Q */
3170 tcsetattr (STDIN_FILENO, TCSAFLUSH, &tio);
3172 /* See if we can do ANSI/VT100 output */
3173 term = (u8 *) getenv ("TERM");
3176 int len = strlen ((char *) term);
3177 cf->ansi_capable = unix_cli_terminal_type_ansi (term, len);
3178 if (unix_cli_terminal_type_noninteractive (term, len))
3179 unix_cli_set_session_noninteractive (cf);
3184 /* No tty, so make sure the session doesn't have tty-like features */
3185 unix_cli_set_session_noninteractive (cf);
3188 /* Send banner and initial prompt */
3189 unix_cli_file_welcome (cm, cf);
3192 /* If we have socket config, LISTEN, otherwise, don't */
3193 clib_socket_t *s = &um->cli_listen_socket;
3194 if (s->config && s->config[0] != 0)
3197 clib_file_t template = { 0 };
3199 /* mkdir of file socketu, only under /run */
3200 if (strncmp (s->config, "/run", 4) == 0)
3202 u8 *tmp = format (0, "%s", s->config);
3203 int i = vec_len (tmp);
3204 while (i && tmp[--i] != '/')
3210 vlib_unix_recursive_mkdir ((char *) tmp);
3214 s->flags = CLIB_SOCKET_F_IS_SERVER | /* listen, don't connect */
3215 CLIB_SOCKET_F_ALLOW_GROUP_WRITE; /* PF_LOCAL socket only */
3216 error = clib_socket_init (s);
3221 template.read_function = unix_cli_listen_read_ready;
3222 template.file_descriptor = s->fd;
3223 template.description = format (0, "cli listener %s", s->config);
3225 clib_file_add (fm, &template);
3228 /* Set CLI prompt. */
3229 if (!cm->cli_prompt)
3230 cm->cli_prompt = format (0, "VLIB: ");
3236 * This module has no configurable parameters.
3238 VLIB_CONFIG_FUNCTION (unix_cli_config, "unix-cli");
3240 /** Called when VPP is shutting down, this restores the system
3241 * terminal state if previously saved.
3243 static clib_error_t *
3244 unix_cli_exit (vlib_main_t * vm)
3246 unix_main_t *um = &unix_main;
3248 /* If stdin is a tty and we saved the tty state, reset the tty state */
3249 if (isatty (STDIN_FILENO) && um->tio_isset)
3250 tcsetattr (STDIN_FILENO, TCSAFLUSH, &um->tio_stdin);
3255 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_cli_exit);
3257 /** Set the CLI prompt.
3258 * @param prompt The C string to set the prompt to.
3259 * @note This setting is global; it impacts all current
3260 * and future CLI sessions.
3263 vlib_unix_cli_set_prompt (char *prompt)
3265 char *fmt = (prompt[strlen (prompt) - 1] == ' ') ? "%s" : "%s ";
3266 unix_cli_main_t *cm = &unix_cli_main;
3268 vec_free (cm->cli_prompt);
3269 cm->cli_prompt = format (0, fmt, prompt);
3272 static unix_cli_file_t *
3273 unix_cli_file_if_exists (unix_cli_main_t * cm)
3275 if (!cm->cli_file_pool)
3277 return pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3280 static unix_cli_file_t *
3281 unix_cli_file_if_interactive (unix_cli_main_t * cm)
3283 unix_cli_file_t *cf;
3284 if ((cf = unix_cli_file_if_exists (cm)) && !cf->is_interactive)
3289 /** CLI command to quit the terminal session.
3290 * @note If this is a stdin session then this will
3291 * shutdown VPP also.
3293 static clib_error_t *
3294 unix_cli_quit (vlib_main_t * vm,
3295 unformat_input_t * input, vlib_cli_command_t * cmd)
3297 unix_cli_main_t *cm = &unix_cli_main;
3298 unix_cli_file_t *cf;
3300 if (!(cf = unix_cli_file_if_exists (cm)))
3301 return clib_error_return (0, "invalid session");
3303 /* Cosmetic: suppress the final prompt from appearing before we die */
3304 cf->is_interactive = 0;
3307 vlib_process_signal_event (vm,
3308 vlib_current_process (vm),
3309 UNIX_CLI_PROCESS_EVENT_QUIT,
3310 cm->current_input_file_index);
3315 * Terminates the current CLI session.
3317 * If VPP is running in @em interactive mode and this is the console session
3318 * (that is, the session on @c stdin) then this will also terminate VPP.
3321 VLIB_CLI_COMMAND (unix_cli_quit_command, static) = {
3323 .short_help = "Exit CLI",
3324 .function = unix_cli_quit,
3329 VLIB_CLI_COMMAND (unix_cli_q_command, static) = {
3331 .short_help = "Exit CLI",
3332 .function = unix_cli_quit,
3336 /** CLI command to execute a VPP command script. */
3337 static clib_error_t *
3338 unix_cli_exec (vlib_main_t * vm,
3339 unformat_input_t * input, vlib_cli_command_t * cmd)
3343 unformat_input_t sub_input, in;
3344 clib_error_t *error;
3345 clib_macro_main_t *mm = 0;
3346 unix_cli_main_t *cm = &unix_cli_main;
3347 unix_cli_file_t *cf;
3355 if (!unformat (input, "%s", &file_name))
3357 error = clib_error_return (0, "expecting file name, got `%U'",
3358 format_unformat_error, input);
3362 fd = open (file_name, O_RDONLY);
3365 error = clib_error_return_unix (0, "failed to open `%s'", file_name);
3369 /* Make sure its a regular file. */
3370 if (fstat (fd, &s) < 0)
3372 error = clib_error_return_unix (0, "failed to stat `%s'", file_name);
3376 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
3378 error = clib_error_return (0, "not a regular file `%s'", file_name);
3384 error = clib_error_return (0, "empty file `%s'", file_name);
3389 vec_validate (file_data, s.st_size - 1);
3391 if (read (fd, file_data, s.st_size) != s.st_size)
3393 error = clib_error_return_unix (0, "Failed to read %d bytes from '%s'",
3394 s.st_size, file_name);
3395 vec_free (file_data);
3399 unformat_init_vector (&sub_input, file_data);
3401 /* Initial config process? Use the global macro table. */
3402 if (pool_is_free_index (cm->cli_file_pool, cm->current_input_file_index))
3403 mm = &cm->macro_main;
3406 /* Otherwise, use the per-cli-process macro table */
3407 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3408 mm = &cf->macro_main;
3411 while (rv == 0 && unformat_user (&sub_input, unformat_vlib_cli_line, &in))
3413 /* Run the file contents through the macro processor */
3414 if (vec_len (in.buffer) > 1)
3418 /* The macro expander expects a c string... */
3419 vec_add1 (in.buffer, 0);
3422 (u8 *) clib_macro_eval (mm, (i8 *) in.buffer, 1 /* complain */,
3423 0 /* level */, 8 /* max_level */);
3424 /* Macro processor NULL terminates the return */
3425 vec_dec_len (expanded, 1);
3426 vec_reset_length (in.buffer);
3427 vec_append (in.buffer, expanded);
3428 vec_free (expanded);
3431 if ((rv = vlib_cli_input (vm, &in, 0, 0)) != 0)
3432 error = clib_error_return (0, "CLI line error: %U",
3433 format_unformat_error, &in);
3434 unformat_free (&in);
3436 unformat_free (&sub_input);
3441 vec_free (file_name);
3447 * Executes a sequence of CLI commands which are read from a file. If
3448 * a command is unrecognized or otherwise invalid then the usual CLI
3449 * feedback will be generated, however execution of subsequent commands
3450 * from the file will continue.
3452 * The VPP code is indifferent to the file location. However, if SELinux
3453 * is enabled, then the file needs to have an SELinux label the VPP
3454 * process is allowed to access. For example, if a file is created in
3455 * '<em>/usr/share/vpp/</em>', it will be allowed. However, files manually
3456 * created in '/tmp/' or '/home/<user>/' will not be accessible by the VPP
3457 * process when SELinux is enabled.
3462 * <b><em>$ cat /usr/share/vpp/scripts/gigup.txt</em></b>
3463 * set interface state GigabitEthernet0/8/0 up
3464 * set interface state GigabitEthernet0/9/0 up
3466 * Example of how to execute a set of CLI commands from a file:
3467 * @cliexcmd{exec /usr/share/vpp/scripts/gigup.txt}
3470 VLIB_CLI_COMMAND (cli_exec, static) = {
3472 .short_help = "exec <filename>",
3473 .function = unix_cli_exec,
3478 /** CLI command to show various unix error statistics. */
3479 static clib_error_t *
3480 unix_show_errors (vlib_main_t * vm,
3481 unformat_input_t * input, vlib_cli_command_t * cmd)
3483 unix_main_t *um = &unix_main;
3484 clib_error_t *error = 0;
3485 int i, n_errors_to_show;
3486 unix_error_history_t *unix_errors = 0;
3488 n_errors_to_show = 1 << 30;
3490 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3492 if (!unformat (input, "%d", &n_errors_to_show))
3495 clib_error_return (0,
3496 "expecting integer number of errors to show, got `%U'",
3497 format_unformat_error, input);
3503 clib_min (ARRAY_LEN (um->error_history), n_errors_to_show);
3506 um->error_history_index >
3507 0 ? um->error_history_index - 1 : ARRAY_LEN (um->error_history) - 1;
3509 while (n_errors_to_show > 0)
3511 unix_error_history_t *eh = um->error_history + i;
3516 vec_add1 (unix_errors, eh[0]);
3517 n_errors_to_show -= 1;
3519 i = ARRAY_LEN (um->error_history) - 1;
3524 if (vec_len (unix_errors) == 0)
3525 vlib_cli_output (vm, "no Unix errors so far");
3528 vlib_cli_output (vm, "%Ld total errors seen", um->n_total_errors);
3529 for (i = vec_len (unix_errors) - 1; i >= 0; i--)
3531 unix_error_history_t *eh = vec_elt_at_index (unix_errors, i);
3532 vlib_cli_output (vm, "%U: %U",
3533 format_time_interval, "h:m:s:u", eh->time,
3534 format_clib_error, eh->error);
3536 vlib_cli_output (vm, "%U: time now",
3537 format_time_interval, "h:m:s:u", vlib_time_now (vm));
3541 vec_free (unix_errors);
3546 VLIB_CLI_COMMAND (cli_unix_show_errors, static) = {
3547 .path = "show unix errors",
3548 .short_help = "Show Unix system call error history",
3549 .function = unix_show_errors,
3553 /** CLI command to show various unix error statistics. */
3554 static clib_error_t *
3555 unix_show_files (vlib_main_t * vm,
3556 unformat_input_t * input, vlib_cli_command_t * cmd)
3558 clib_error_t *error = 0;
3559 clib_file_main_t *fm = &file_main;
3561 char path[PATH_MAX];
3564 vlib_cli_output (vm, "%3s %6s %12s %12s %12s %-32s %s", "FD", "Thread",
3565 "Read", "Write", "Error", "File Name", "Description");
3568 pool_foreach (f, fm->file_pool)
3571 s = format (s, "/proc/self/fd/%d%c", f->file_descriptor, 0);
3572 rv = readlink((char *) s, path, PATH_MAX - 1);
3574 path[rv < 0 ? 0 : rv] = 0;
3576 vlib_cli_output (vm, "%3d %6d %12d %12d %12d %-32s %v",
3577 f->file_descriptor, f->polling_thread_index,
3578 f->read_events, f->write_events, f->error_events,
3579 path, f->description);
3580 vec_reset_length (s);
3589 VLIB_CLI_COMMAND (cli_unix_show_files, static) = {
3590 .path = "show unix files",
3591 .short_help = "Show Unix files in use",
3592 .function = unix_show_files,
3596 /** CLI command to show session command history. */
3597 static clib_error_t *
3598 unix_cli_show_history (vlib_main_t * vm,
3599 unformat_input_t * input, vlib_cli_command_t * cmd)
3601 unix_cli_main_t *cm = &unix_cli_main;
3602 unix_cli_file_t *cf;
3605 if (!(cf = unix_cli_file_if_interactive (cm)))
3606 return clib_error_return (0, "invalid for non-interactive sessions");
3608 if (cf->has_history && cf->history_limit)
3610 i = 1 + cf->command_number - vec_len (cf->command_history);
3611 for (j = 0; j < vec_len (cf->command_history); j++)
3612 vlib_cli_output (vm, "%d %v\n", i + j, cf->command_history[j]);
3616 vlib_cli_output (vm, "History not enabled.\n");
3623 * Displays the command history for the current session, if any.
3626 VLIB_CLI_COMMAND (cli_unix_cli_show_history, static) = {
3628 .short_help = "Show current session command history",
3629 .function = unix_cli_show_history,
3633 /** CLI command to show terminal status. */
3634 static clib_error_t *
3635 unix_cli_show_terminal (vlib_main_t * vm,
3636 unformat_input_t * input, vlib_cli_command_t * cmd)
3638 unix_main_t *um = &unix_main;
3639 unix_cli_main_t *cm = &unix_cli_main;
3640 unix_cli_file_t *cf;
3643 if (!(cf = unix_cli_file_if_exists (cm)))
3644 return clib_error_return (0, "invalid session");
3646 n = vlib_get_node (vm, cf->process_node_index);
3648 vlib_cli_output (vm, "Terminal name: %v\n", cf->name);
3649 vlib_cli_output (vm, "Terminal node: %v\n", n->name);
3650 vlib_cli_output (vm, "Terminal mode: %s\n", cf->line_mode ?
3651 "line-by-line" : "char-by-char");
3652 vlib_cli_output (vm, "Terminal width: %d\n", cf->width);
3653 vlib_cli_output (vm, "Terminal height: %d\n", cf->height);
3654 vlib_cli_output (vm, "ANSI capable: %s\n",
3655 cf->ansi_capable ? "yes" : "no");
3656 vlib_cli_output (vm, "Interactive: %s\n",
3657 cf->is_interactive ? "yes" : "no");
3658 vlib_cli_output (vm, "History enabled: %s%s\n",
3659 cf->has_history ? "yes" : "no", !cf->has_history
3660 || cf->history_limit ? "" :
3661 " (disabled by history limit)");
3662 if (cf->has_history)
3663 vlib_cli_output (vm, "History limit: %d\n", cf->history_limit);
3664 vlib_cli_output (vm, "Pager enabled: %s%s%s\n",
3665 cf->no_pager ? "no" : "yes",
3667 || cf->height ? "" : " (disabled by terminal height)",
3669 || um->cli_pager_buffer_limit ? "" :
3670 " (disabled by buffer limit)");
3672 vlib_cli_output (vm, "Pager limit: %d\n", um->cli_pager_buffer_limit);
3673 vlib_cli_output (vm, "CRLF mode: %s\n",
3674 cf->crlf_mode ? "CR+LF" : "LF");
3680 * Displays various information about the state of the current terminal
3684 * @cliexstart{show terminal}
3685 * Terminal name: unix-cli-stdin
3686 * Terminal mode: char-by-char
3687 * Terminal width: 123
3688 * Terminal height: 48
3691 * History enabled: yes
3693 * Pager enabled: yes
3694 * Pager limit: 100000
3699 VLIB_CLI_COMMAND (cli_unix_cli_show_terminal, static) = {
3700 .path = "show terminal",
3701 .short_help = "Show current session terminal settings",
3702 .function = unix_cli_show_terminal,
3706 /** CLI command to display a list of CLI sessions. */
3707 static clib_error_t *
3708 unix_cli_show_cli_sessions (vlib_main_t * vm,
3709 unformat_input_t * input,
3710 vlib_cli_command_t * cmd)
3712 unix_cli_main_t *cm = &unix_cli_main;
3713 clib_file_main_t *fm = &file_main;
3714 table_t table = {}, *t = &table;
3715 unix_cli_file_t *cf;
3718 table_add_header_col (t, 4, "PNI ", "FD ", "Name", "Flags");
3720 #define fl(x, y) ( (x) ? toupper((y)) : tolower((y)) )
3722 pool_foreach (cf, cm->cli_file_pool)
3726 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3727 table_format_cell (t, i, j++, "%u", cf->process_node_index);
3728 table_format_cell (t, i, j++, "%u", uf->file_descriptor);
3729 table_format_cell (t, i, j++, "%v", cf->name);
3730 table_format_cell (t, i++, j++, "%c%c%c%c%c",
3731 fl (cf->is_interactive, 'i'), fl (cf->is_socket, 's'),
3732 fl (cf->line_mode, 'l'), fl (cf->has_epipe, 'p'),
3733 fl (cf->ansi_capable, 'a'));
3737 t->default_body.align = TTAA_LEFT;
3738 t->default_header_col.align = TTAA_LEFT;
3739 vlib_cli_output (vm, "%U", format_table, t);
3746 * Displays a summary of all the current CLI sessions.
3748 * Typically used to diagnose connection issues with the CLI
3752 * @cliexstart{show cli-sessions}
3754 * 343 0 unix-cli-stdin IslpA
3755 * 344 7 unix-cli-local:20 ISlpA
3756 * 346 8 unix-cli-local:21 iSLpa
3759 * In this example we have the debug console of the running process
3760 * on stdin/out, we have an interactive socket session and we also
3761 * have a non-interactive socket session.
3765 * - @em PNI: Process node index.
3766 * - @em FD: Unix file descriptor.
3767 * - @em Name: Name of the session.
3768 * - @em Flags: Various flags that describe the state of the session.
3770 * @em Flags have the following meanings; lower-case typically negates
3773 * - @em I Interactive session.
3774 * - @em S Connected by socket.
3775 * - @em s Not a socket, likely stdin.
3776 * - @em L Line-by-line mode.
3777 * - @em l Char-by-char mode.
3778 * - @em P EPIPE detected on connection; it will close soon.
3779 * - @em A ANSI-capable terminal.
3782 VLIB_CLI_COMMAND (cli_unix_cli_show_cli_sessions, static) = {
3783 .path = "show cli-sessions",
3784 .short_help = "Show current CLI sessions",
3785 .function = unix_cli_show_cli_sessions,
3789 /** CLI command to set terminal pager settings. */
3790 static clib_error_t *
3791 unix_cli_set_terminal_pager (vlib_main_t * vm,
3792 unformat_input_t * input,
3793 vlib_cli_command_t * cmd)
3795 unix_main_t *um = &unix_main;
3796 unix_cli_main_t *cm = &unix_cli_main;
3797 unix_cli_file_t *cf;
3798 unformat_input_t _line_input, *line_input = &_line_input;
3799 clib_error_t *error = 0;
3801 if (!(cf = unix_cli_file_if_interactive (cm)))
3802 return clib_error_return (0, "invalid for non-interactive sessions");
3804 if (!unformat_user (input, unformat_line_input, line_input))
3807 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3809 if (unformat (line_input, "on"))
3811 else if (unformat (line_input, "off"))
3813 else if (unformat (line_input, "limit %u", &um->cli_pager_buffer_limit))
3814 vlib_cli_output (vm,
3815 "Pager limit set to %u lines; note, this is global.\n",
3816 um->cli_pager_buffer_limit);
3819 error = clib_error_return (0, "unknown parameter: `%U`",
3820 format_unformat_error, line_input);
3826 unformat_free (line_input);
3832 * Enables or disables the terminal pager for this session. Generally
3833 * this defaults to enabled.
3835 * Additionally allows the pager buffer size to be set; though note that
3836 * this value is set globally and not per session.
3839 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager, static) = {
3840 .path = "set terminal pager",
3841 .short_help = "set terminal pager [on|off] [limit <lines>]",
3842 .function = unix_cli_set_terminal_pager,
3846 /** CLI command to set terminal history settings. */
3847 static clib_error_t *
3848 unix_cli_set_terminal_history (vlib_main_t * vm,
3849 unformat_input_t * input,
3850 vlib_cli_command_t * cmd)
3852 unix_cli_main_t *cm = &unix_cli_main;
3853 unix_cli_file_t *cf;
3854 unformat_input_t _line_input, *line_input = &_line_input;
3856 clib_error_t *error = 0;
3858 if (!(cf = unix_cli_file_if_interactive (cm)))
3859 return clib_error_return (0, "invalid for non-interactive sessions");
3861 if (!unformat_user (input, unformat_line_input, line_input))
3864 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3866 if (unformat (line_input, "on"))
3867 cf->has_history = 1;
3868 else if (unformat (line_input, "off"))
3869 cf->has_history = 0;
3870 else if (unformat (line_input, "limit %u", &cf->history_limit))
3874 error = clib_error_return (0, "unknown parameter: `%U`",
3875 format_unformat_error, line_input);
3881 /* If we reduced history size, or turned it off, purge the history */
3882 limit = cf->has_history ? cf->history_limit : 0;
3883 if (limit < vec_len (cf->command_history))
3887 /* How many items to remove from the start of history */
3888 limit = vec_len (cf->command_history) - limit;
3890 for (i = 0; i < limit; i++)
3891 vec_free (cf->command_history[i]);
3893 vec_delete (cf->command_history, limit, 0);
3897 unformat_free (line_input);
3903 * Enables or disables the command history function of the current
3904 * terminal. Generally this defaults to enabled.
3906 * This command also allows the maximum size of the history buffer for
3907 * this session to be altered.
3910 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history, static) = {
3911 .path = "set terminal history",
3912 .short_help = "set terminal history [on|off] [limit <lines>]",
3913 .function = unix_cli_set_terminal_history,
3917 /** CLI command to set terminal ANSI settings. */
3918 static clib_error_t *
3919 unix_cli_set_terminal_ansi (vlib_main_t * vm,
3920 unformat_input_t * input,
3921 vlib_cli_command_t * cmd)
3923 unix_cli_main_t *cm = &unix_cli_main;
3924 unix_cli_file_t *cf;
3926 if (!(cf = unix_cli_file_if_interactive (cm)))
3927 return clib_error_return (0, "invalid for non-interactive sessions");
3929 if (unformat (input, "on"))
3930 cf->ansi_capable = 1;
3931 else if (unformat (input, "off"))
3932 cf->ansi_capable = 0;
3934 return clib_error_return (0, "unknown parameter: `%U`",
3935 format_unformat_error, input);
3941 * Enables or disables the use of ANSI control sequences by this terminal.
3942 * The default will vary based on terminal detection at the start of the
3945 * ANSI control sequences are used in a small number of places to provide,
3946 * for example, color text output and to control the cursor in the pager.
3949 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi, static) = {
3950 .path = "set terminal ansi",
3951 .short_help = "set terminal ansi [on|off]",
3952 .function = unix_cli_set_terminal_ansi,
3957 #define MAX_CLI_WAIT 86400
3958 /** CLI command to wait <sec> seconds. Useful for exec script. */
3959 static clib_error_t *
3960 unix_wait_cmd (vlib_main_t * vm,
3961 unformat_input_t * input, vlib_cli_command_t * cmd)
3963 unformat_input_t _line_input, *line_input = &_line_input;
3966 if (!unformat_user (input, unformat_line_input, line_input))
3969 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3971 if (unformat (line_input, "%f", &sec))
3974 return clib_error_return (0, "unknown parameter: `%U`",
3975 format_unformat_error, input);
3978 if (sec <= 0 || sec > MAX_CLI_WAIT || floor (sec * 1000) / 1000 != sec)
3979 return clib_error_return (0,
3980 "<sec> must be a positive value and less than 86400 (one day) with no more than msec precision.");
3982 vlib_process_wait_for_event_or_clock (vm, sec);
3983 vlib_cli_output (vm, "waited %.3f sec.", sec);
3985 unformat_free (line_input);
3989 VLIB_CLI_COMMAND (cli_unix_wait_cmd, static) = {
3991 .short_help = "wait <sec>",
3992 .function = unix_wait_cmd,
3996 static clib_error_t *
3997 echo_cmd (vlib_main_t * vm,
3998 unformat_input_t * input, vlib_cli_command_t * cmd)
4000 unformat_input_t _line_input, *line_input = &_line_input;
4002 /* Get a line of input. */
4003 if (!unformat_user (input, unformat_line_input, line_input))
4005 vlib_cli_output (vm, "");
4009 vlib_cli_output (vm, "%v", line_input->buffer);
4011 unformat_free (line_input);
4016 VLIB_CLI_COMMAND (cli_unix_echo_cmd, static) = {
4018 .short_help = "echo <rest-of-line>",
4019 .function = echo_cmd,
4023 static clib_error_t *
4024 define_cmd_fn (vlib_main_t * vm,
4025 unformat_input_t * input, vlib_cli_command_t * cmd)
4028 unformat_input_t _line_input, *line_input = &_line_input;
4029 clib_macro_main_t *mm = get_macro_main ();
4030 clib_error_t *error;
4032 if (!unformat (input, "%s", ¯o_name))
4033 return clib_error_return (0, "missing variable name...");
4035 /* Remove white space */
4036 (void) unformat (input, "");
4038 /* Get a line of input. */
4039 if (!unformat_user (input, unformat_line_input, line_input))
4041 error = clib_error_return (0, "missing value for '%s'...", macro_name);
4042 vec_free (macro_name);
4045 /* the macro expander expects c-strings, not vectors... */
4046 vec_add1 (line_input->buffer, 0);
4047 clib_macro_set_value (mm, (char *) macro_name, (char *) line_input->buffer);
4048 vec_free (macro_name);
4049 unformat_free (line_input);
4054 VLIB_CLI_COMMAND (define_cmd, static) = {
4056 .short_help = "define <variable-name> <value>",
4057 .function = define_cmd_fn,
4062 static clib_error_t *
4063 undefine_cmd_fn (vlib_main_t * vm,
4064 unformat_input_t * input, vlib_cli_command_t * cmd)
4067 clib_macro_main_t *mm = get_macro_main ();
4069 if (!unformat (input, "%s", ¯o_name))
4070 return clib_error_return (0, "missing variable name...");
4072 if (clib_macro_unset (mm, (char *) macro_name))
4073 vlib_cli_output (vm, "%s wasn't set...", macro_name);
4075 vec_free (macro_name);
4080 VLIB_CLI_COMMAND (undefine_cmd, static) = {
4082 .short_help = "undefine <variable-name>",
4083 .function = undefine_cmd_fn,
4087 static clib_error_t *
4088 show_macro_cmd_fn (vlib_main_t * vm,
4089 unformat_input_t * input, vlib_cli_command_t * cmd)
4091 clib_macro_main_t *mm = get_macro_main ();
4094 if (unformat (input, "noevaluate %=", &evaluate, 0))
4096 else if (unformat (input, "noeval %=", &evaluate, 0))
4099 vlib_cli_output (vm, "%U", format_clib_macro_main, mm, evaluate);
4104 VLIB_CLI_COMMAND (show_macro, static) = {
4105 .path = "show macro",
4106 .short_help = "show macro [noevaluate]",
4107 .function = show_macro_cmd_fn,
4111 static clib_error_t *
4112 unix_cli_init (vlib_main_t * vm)
4114 unix_cli_main_t *cm = &unix_cli_main;
4116 /* Breadcrumb to indicate the new session process
4117 * has not been started */
4118 cm->new_session_process_node_index = ~0;
4119 clib_macro_init (&cm->macro_main);
4124 VLIB_INIT_FUNCTION (unix_cli_init);
4127 * fd.io coding-style-patch-verification: ON
4130 * eval: (c-set-style "gnu")