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>
66 /** ANSI escape code. */
69 /** ANSI Control Sequence Introducer. */
72 /** ANSI clear screen. */
73 #define ANSI_CLEAR CSI "2J" CSI "1;1H"
74 /** ANSI reset color settings. */
75 #define ANSI_RESET CSI "0m"
76 /** ANSI Start bold text. */
77 #define ANSI_BOLD CSI "1m"
78 /** ANSI Stop bold text. */
79 #define ANSI_DIM CSI "2m"
80 /** ANSI Start dark red text. */
81 #define ANSI_DRED ANSI_DIM CSI "31m"
82 /** ANSI Start bright red text. */
83 #define ANSI_BRED ANSI_BOLD CSI "31m"
84 /** ANSI clear line cursor is on. */
85 #define ANSI_CLEARLINE CSI "2K"
86 /** ANSI scroll screen down one line. */
87 #define ANSI_SCROLLDN CSI "1T"
88 /** ANSI save cursor position. */
89 #define ANSI_SAVECURSOR CSI "s"
90 /** ANSI restore cursor position if previously saved. */
91 #define ANSI_RESTCURSOR CSI "u"
93 /** Maximum depth into a byte stream from which to compile a Telnet
94 * protocol message. This is a safety measure. */
95 #define UNIX_CLI_MAX_DEPTH_TELNET 32
97 /** Maximum terminal width we will accept */
98 #define UNIX_CLI_MAX_TERMINAL_WIDTH 512
99 /** Maximum terminal height we will accept */
100 #define UNIX_CLI_MAX_TERMINAL_HEIGHT 512
101 /** Default terminal height */
102 #define UNIX_CLI_DEFAULT_TERMINAL_HEIGHT 24
103 /** Default terminal width */
104 #define UNIX_CLI_DEFAULT_TERMINAL_WIDTH 80
106 /** A CLI banner line. */
109 u8 *line; /**< The line to print. */
110 u32 length; /**< The length of the line without terminating NUL. */
113 #define _(a) { .line = (u8 *)(a), .length = sizeof(a) - 1 }
114 /** Plain welcome banner. */
115 static unix_cli_banner_t unix_cli_banner[] = {
116 _(" _______ _ _ _____ ___ \n"),
117 _(" __/ __/ _ \\ (_)__ | | / / _ \\/ _ \\\n"),
118 _(" _/ _// // / / / _ \\ | |/ / ___/ ___/\n"),
119 _(" /_/ /____(_)_/\\___/ |___/_/ /_/ \n"),
123 /** ANSI color welcome banner. */
124 static unix_cli_banner_t unix_cli_banner_color[] = {
125 _(ANSI_BRED " _______ _ " ANSI_RESET " _ _____ ___ \n"),
126 _(ANSI_BRED " __/ __/ _ \\ (_)__ " ANSI_RESET " | | / / _ \\/ _ \\\n"),
127 _(ANSI_BRED " _/ _// // / / / _ \\" ANSI_RESET " | |/ / ___/ ___/\n"),
128 _(ANSI_BRED " /_/ /____(_)_/\\___/" ANSI_RESET " |___/_/ /_/ \n"),
134 /** Pager line index */
137 /** Index into pager_vector */
140 /** Offset of the string in the line */
143 /** Length of the string in the line */
145 } unix_cli_pager_index_t;
148 /** Unix CLI session. */
151 /** The file index held by unix.c */
154 /** Vector of output pending write to file descriptor. */
157 /** Vector of input saved by Unix input node to be processed by
161 /** This session has command history. */
163 /** Array of vectors of commands in the history. */
164 u8 **command_history;
165 /** The command currently pointed at by the history cursor. */
167 /** How far from the end of the history array the user has browsed. */
170 /** Maximum number of history entries this session will store. */
173 /** Current command line counter */
176 /** The string being searched for in the history. */
178 /** If non-zero then the CLI is searching in the history array.
179 * - @c -1 means search backwards.
180 * - @c 1 means search forwards.
184 /** Position of the insert cursor on the current input line */
187 /** Line mode or char mode */
190 /** Set if the CRLF mode wants CR + LF */
193 /** Can we do ANSI output? */
196 /** Has the session started? */
199 /** Disable the pager? */
202 /** Whether the session is interactive or not.
203 * Controls things like initial banner, the CLI prompt etc. */
206 /** Whether the session is attached to a socket. */
209 /** If EPIPE has been detected, prevent further write-related
210 * activity on the descriptor.
217 /** Index of line fragments in the pager buffer */
218 unix_cli_pager_index_t *pager_index;
220 /** Line number of top of page */
223 /** Terminal width */
226 /** Terminal height */
229 /** Process node identifier */
230 u32 process_node_index;
232 /** The current direction of cursor travel.
233 * This is important since when advancing left-to-right, at the
234 * right hand edge of the console the terminal typically defers
235 * wrapping the cursor to the next line until a character is
236 * actually displayed.
237 * This messes up our heuristic for whether to use ANSI to return
238 * the cursor to the end of the line and instead we have to
239 * nudge the cursor to the next line.
240 * A Value of @c 0 means we're advancing left-to-right; @c 1 means
245 /** Macro tables for this session */
246 clib_macro_main_t macro_main;
249 /** Resets the pager buffer and other data.
250 * @param f The CLI session whose pager needs to be reset.
253 unix_cli_pager_reset (unix_cli_file_t * f)
259 vec_free (f->pager_index);
262 vec_foreach (p, f->pager_vector)
266 vec_free (f->pager_vector);
270 /** Release storage used by a CLI session.
271 * @param f The CLI session whose storage needs to be released.
274 unix_cli_file_free (unix_cli_file_t * f)
276 vec_free (f->output_vector);
277 vec_free (f->input_vector);
278 unix_cli_pager_reset (f);
284 UNIX_CLI_PARSE_ACTION_NOACTION = 0, /**< No action */
285 UNIX_CLI_PARSE_ACTION_CRLF, /**< Carriage return, newline or enter */
286 UNIX_CLI_PARSE_ACTION_TAB, /**< Tab key */
287 UNIX_CLI_PARSE_ACTION_ERASE, /**< Erase cursor left */
288 UNIX_CLI_PARSE_ACTION_ERASERIGHT, /**< Erase cursor right */
289 UNIX_CLI_PARSE_ACTION_UP, /**< Up arrow */
290 UNIX_CLI_PARSE_ACTION_DOWN, /**< Down arrow */
291 UNIX_CLI_PARSE_ACTION_LEFT, /**< Left arrow */
292 UNIX_CLI_PARSE_ACTION_RIGHT, /**< Right arrow */
293 UNIX_CLI_PARSE_ACTION_HOME, /**< Home key (jump to start of line) */
294 UNIX_CLI_PARSE_ACTION_END, /**< End key (jump to end of line) */
295 UNIX_CLI_PARSE_ACTION_WORDLEFT, /**< Jump cursor to start of left word */
296 UNIX_CLI_PARSE_ACTION_WORDRIGHT, /**< Jump cursor to start of right word */
297 UNIX_CLI_PARSE_ACTION_ERASELINELEFT, /**< Erase line to left of cursor */
298 UNIX_CLI_PARSE_ACTION_ERASELINERIGHT, /**< Erase line to right & including cursor */
299 UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT, /**< Erase word left */
300 UNIX_CLI_PARSE_ACTION_CLEAR, /**< Clear the terminal */
301 UNIX_CLI_PARSE_ACTION_REVSEARCH, /**< Search backwards in command history */
302 UNIX_CLI_PARSE_ACTION_FWDSEARCH, /**< Search forwards in command history */
303 UNIX_CLI_PARSE_ACTION_YANK, /**< Undo last erase action */
304 UNIX_CLI_PARSE_ACTION_TELNETIAC, /**< Telnet control code */
306 UNIX_CLI_PARSE_ACTION_PAGER_CRLF, /**< Enter pressed (CR, CRLF, LF, etc) */
307 UNIX_CLI_PARSE_ACTION_PAGER_QUIT, /**< Exit the pager session */
308 UNIX_CLI_PARSE_ACTION_PAGER_NEXT, /**< Scroll to next page */
309 UNIX_CLI_PARSE_ACTION_PAGER_DN, /**< Scroll to next line */
310 UNIX_CLI_PARSE_ACTION_PAGER_UP, /**< Scroll to previous line */
311 UNIX_CLI_PARSE_ACTION_PAGER_TOP, /**< Scroll to first line */
312 UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM, /**< Scroll to last line */
313 UNIX_CLI_PARSE_ACTION_PAGER_PGDN, /**< Scroll to next page */
314 UNIX_CLI_PARSE_ACTION_PAGER_PGUP, /**< Scroll to previous page */
315 UNIX_CLI_PARSE_ACTION_PAGER_REDRAW, /**< Clear and redraw the page on the terminal */
316 UNIX_CLI_PARSE_ACTION_PAGER_SEARCH, /**< Search the pager buffer */
318 UNIX_CLI_PARSE_ACTION_PARTIALMATCH, /**< Action parser found a partial match */
319 UNIX_CLI_PARSE_ACTION_NOMATCH /**< Action parser did not find any match */
320 } unix_cli_parse_action_t;
322 /** @brief Mapping of input buffer strings to action values.
323 * @note This won't work as a hash since we need to be able to do
324 * partial matches on the string.
328 u8 *input; /**< Input string to match. */
329 u32 len; /**< Length of input without final NUL. */
330 unix_cli_parse_action_t action; /**< Action to take when matched. */
331 } unix_cli_parse_actions_t;
333 /** @brief Given a capital ASCII letter character return a @c NUL terminated
334 * string with the control code for that letter.
336 * @param c An ASCII character.
337 * @return A @c NUL terminated string of type @c u8[].
340 * @c CTL('A') returns <code>{ 0x01, 0x00 }</code> as a @c u8[].
342 #define CTL(c) (u8[]){ (c) - '@', 0 }
344 #define _(a,b) { .input = (u8 *)(a), .len = sizeof(a) - 1, .action = (b) }
346 * Patterns to match on a CLI input stream.
349 static unix_cli_parse_actions_t unix_cli_parse_strings[] = {
351 _("\r\n", UNIX_CLI_PARSE_ACTION_CRLF), /* Must be before '\r' */
352 _("\n", UNIX_CLI_PARSE_ACTION_CRLF),
353 _("\r\0", UNIX_CLI_PARSE_ACTION_CRLF), /* Telnet does this */
354 _("\r", UNIX_CLI_PARSE_ACTION_CRLF),
356 /* Unix shell control codes */
357 _(CTL ('B'), UNIX_CLI_PARSE_ACTION_LEFT),
358 _(CTL ('F'), UNIX_CLI_PARSE_ACTION_RIGHT),
359 _(CTL ('P'), UNIX_CLI_PARSE_ACTION_UP),
360 _(CTL ('N'), UNIX_CLI_PARSE_ACTION_DOWN),
361 _(CTL ('A'), UNIX_CLI_PARSE_ACTION_HOME),
362 _(CTL ('E'), UNIX_CLI_PARSE_ACTION_END),
363 _(CTL ('D'), UNIX_CLI_PARSE_ACTION_ERASERIGHT),
364 _(CTL ('U'), UNIX_CLI_PARSE_ACTION_ERASELINELEFT),
365 _(CTL ('K'), UNIX_CLI_PARSE_ACTION_ERASELINERIGHT),
366 _(CTL ('W'), UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT),
367 _(CTL ('Y'), UNIX_CLI_PARSE_ACTION_YANK),
368 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_CLEAR),
369 _(ESC "b", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* Alt-B */
370 _(ESC "f", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* Alt-F */
371 _("\b", UNIX_CLI_PARSE_ACTION_ERASE), /* ^H */
372 _("\x7f", UNIX_CLI_PARSE_ACTION_ERASE), /* Backspace */
373 _("\t", UNIX_CLI_PARSE_ACTION_TAB), /* ^I */
375 /* VT100 Normal mode - Broadest support */
376 _(CSI "A", UNIX_CLI_PARSE_ACTION_UP),
377 _(CSI "B", UNIX_CLI_PARSE_ACTION_DOWN),
378 _(CSI "C", UNIX_CLI_PARSE_ACTION_RIGHT),
379 _(CSI "D", UNIX_CLI_PARSE_ACTION_LEFT),
380 _(CSI "H", UNIX_CLI_PARSE_ACTION_HOME),
381 _(CSI "F", UNIX_CLI_PARSE_ACTION_END),
382 _(CSI "3~", UNIX_CLI_PARSE_ACTION_ERASERIGHT), /* Delete */
383 _(CSI "1;5D", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* C-Left */
384 _(CSI "1;5C", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* C-Right */
386 /* VT100 Application mode - Some Gnome Terminal functions use these */
387 _(ESC "OA", UNIX_CLI_PARSE_ACTION_UP),
388 _(ESC "OB", UNIX_CLI_PARSE_ACTION_DOWN),
389 _(ESC "OC", UNIX_CLI_PARSE_ACTION_RIGHT),
390 _(ESC "OD", UNIX_CLI_PARSE_ACTION_LEFT),
391 _(ESC "OH", UNIX_CLI_PARSE_ACTION_HOME),
392 _(ESC "OF", UNIX_CLI_PARSE_ACTION_END),
394 /* ANSI X3.41-1974 - sent by Microsoft Telnet and PuTTY */
395 _(CSI "1~", UNIX_CLI_PARSE_ACTION_HOME),
396 _(CSI "4~", UNIX_CLI_PARSE_ACTION_END),
398 /* Emacs-ish history search */
399 _(CTL ('S'), UNIX_CLI_PARSE_ACTION_FWDSEARCH),
400 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_REVSEARCH),
402 /* Other protocol things */
403 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
404 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
405 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
409 * Patterns to match when a CLI session is in the pager.
412 static unix_cli_parse_actions_t unix_cli_parse_pager[] = {
414 _("\r\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Must be before '\r' */
415 _("\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
416 _("\r\0", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Telnet does this */
417 _("\r", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
420 _(" ", UNIX_CLI_PARSE_ACTION_PAGER_NEXT),
421 _("q", UNIX_CLI_PARSE_ACTION_PAGER_QUIT),
422 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
423 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
424 _("/", UNIX_CLI_PARSE_ACTION_PAGER_SEARCH),
427 _(CSI "A", UNIX_CLI_PARSE_ACTION_PAGER_UP),
428 _(CSI "B", UNIX_CLI_PARSE_ACTION_PAGER_DN),
429 _(CSI "H", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
430 _(CSI "F", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
432 /* VT100 Application mode */
433 _(ESC "OA", UNIX_CLI_PARSE_ACTION_PAGER_UP),
434 _(ESC "OB", UNIX_CLI_PARSE_ACTION_PAGER_DN),
435 _(ESC "OH", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
436 _(ESC "OF", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
438 /* ANSI X3.41-1974 */
439 _(CSI "1~", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
440 _(CSI "4~", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
441 _(CSI "5~", UNIX_CLI_PARSE_ACTION_PAGER_PGUP),
442 _(CSI "6~", UNIX_CLI_PARSE_ACTION_PAGER_PGDN),
444 /* Other protocol things */
445 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
446 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
447 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
452 /** CLI session telnet negotiation timer events. */
455 UNIX_CLI_NEW_SESSION_EVENT_ADD, /**< Add a CLI session to the new session list */
456 } unix_cli_timeout_event_type_t;
458 /** Each new session is stored on a list with a deadline after which
459 * a prompt is issued, in case the session TELNET negotiation fails to
463 uword cf_index; /**< Session index of the new session. */
464 f64 deadline; /**< Deadline after which the new session must have a prompt. */
465 } unix_cli_new_session_t;
467 /** CLI global state. */
470 /** Prompt string for CLI. */
473 /** Vec pool of CLI sessions. */
474 unix_cli_file_t *cli_file_pool;
476 /** Vec pool of unused session indices. */
477 u32 *unused_cli_process_node_indices;
479 /** The session index of the stdin cli */
480 u32 stdin_cli_file_index;
482 /** File pool index of current input. */
483 u32 current_input_file_index;
485 /** New session process node identifier */
486 u32 new_session_process_node_index;
488 /** List of new sessions */
489 unix_cli_new_session_t *new_sessions;
491 /** system default macro table */
492 clib_macro_main_t macro_main;
496 /** CLI global state */
497 static unix_cli_main_t unix_cli_main;
499 /** Return the macro main / tables we should use for this session
501 static clib_macro_main_t *
502 get_macro_main (void)
504 unix_cli_main_t *cm = &unix_cli_main;
505 vlib_main_t *vm = vlib_get_main ();
506 vlib_process_t *cp = vlib_get_current_process (vm);
509 if (pool_is_free_index (cm->cli_file_pool, cp->output_function_arg))
510 return (&cm->macro_main);
512 cf = pool_elt_at_index (cm->cli_file_pool, cp->output_function_arg);
514 return (&cf->macro_main);
518 * @brief Search for a byte sequence in the action list.
520 * Searches the @ref unix_cli_parse_actions_t list in @a a for a match with
521 * the bytes in @a input of maximum length @a ilen bytes.
522 * When a match is made @a *matched indicates how many bytes were matched.
523 * Returns a value from the enum @ref unix_cli_parse_action_t to indicate
524 * whether no match was found, a partial match was found or a complete
525 * match was found and what action, if any, should be taken.
527 * @param[in] a Actions list to search within.
528 * @param[in] input String fragment to search for.
529 * @param[in] ilen Length of the string in 'input'.
530 * @param[out] matched Pointer to an integer that will contain the number
531 * of bytes matched when a complete match is found.
533 * @return Action from @ref unix_cli_parse_action_t that the string fragment
535 * @ref UNIX_CLI_PARSE_ACTION_PARTIALMATCH is returned when the
536 * whole input string matches the start of at least one action.
537 * @ref UNIX_CLI_PARSE_ACTION_NOMATCH is returned when there is no
540 static unix_cli_parse_action_t
541 unix_cli_match_action (unix_cli_parse_actions_t * a,
542 u8 * input, u32 ilen, i32 * matched)
550 /* see if the start of the input buffer exactly matches the current
552 if (memcmp (input, a->input, a->len) == 0)
560 /* if the first ilen characters match, flag this as a partial -
561 * meaning keep collecting bytes in case of a future match */
562 if (memcmp (input, a->input, ilen) == 0)
566 /* check next action */
571 UNIX_CLI_PARSE_ACTION_PARTIALMATCH : UNIX_CLI_PARSE_ACTION_NOMATCH;
575 /** Add bytes to the output vector and then flagg the I/O system that bytes
576 * are available to be sent.
579 unix_cli_add_pending_output (clib_file_t * uf,
580 unix_cli_file_t * cf,
581 u8 * buffer, uword buffer_bytes)
583 clib_file_main_t *fm = &file_main;
585 vec_add (cf->output_vector, buffer, buffer_bytes);
586 if (vec_len (cf->output_vector) > 0)
588 int skip_update = 0 != (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
589 uf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
591 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
595 /** Delete all bytes from the output vector and flag the I/O system
596 * that no more bytes are available to be sent.
599 unix_cli_del_pending_output (clib_file_t * uf,
600 unix_cli_file_t * cf, uword n_bytes)
602 clib_file_main_t *fm = &file_main;
604 vec_delete (cf->output_vector, n_bytes, 0);
605 if (vec_len (cf->output_vector) <= 0)
607 int skip_update = 0 == (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
608 uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
610 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
614 /** @brief A bit like strchr with a buffer length limit.
615 * Search a buffer for the first instance of a character up to the limit of
616 * the buffer length. If found then return the position of that character.
618 * The key departure from strchr is that if the character is not found then
619 * return the buffer length.
621 * @param chr The byte value to search for.
622 * @param str The buffer in which to search for the value.
623 * @param len The depth into the buffer to search.
625 * @return The index of the first occurrence of \c chr. If \c chr is not
626 * found then \c len instead.
629 unix_vlib_findchr (u8 chr, u8 * str, word len)
632 for (i = 0; i < len; i++, str++)
640 /** @brief Send a buffer to the CLI stream if possible, enqueue it otherwise.
641 * Attempts to write given buffer to the file descriptor of the given
642 * Unix CLI session. If that session already has data in the output buffer
643 * or if the write attempt tells us to try again later then the given buffer
644 * is appended to the pending output buffer instead.
646 * This is typically called only from \c unix_vlib_cli_output_cooked since
647 * that is where CRLF handling occurs or from places where we explicitly do
648 * not want cooked handling.
650 * @param cf Unix CLI session of the desired stream to write to.
651 * @param uf The Unix file structure of the desired stream to write to.
652 * @param buffer Pointer to the buffer that needs to be written.
653 * @param buffer_bytes The number of bytes from \c buffer to write.
656 unix_vlib_cli_output_raw (unix_cli_file_t * cf,
657 clib_file_t * uf, u8 * buffer, uword buffer_bytes)
661 if (cf->has_epipe) /* don't try writing anything */
664 if (vec_len (cf->output_vector) == 0)
667 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
668 n = send (uf->file_descriptor, buffer, buffer_bytes, MSG_NOSIGNAL);
670 n = write (uf->file_descriptor, buffer, buffer_bytes);
673 if (n < 0 && errno != EAGAIN)
677 /* connection closed on us */
678 unix_main_t *um = &unix_main;
680 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
681 UNIX_CLI_PROCESS_EVENT_QUIT,
686 clib_unix_warning ("write");
689 else if ((word) n < (word) buffer_bytes)
691 /* We got EAGAIN or we already have stuff in the buffer;
692 * queue up whatever didn't get sent for later. */
695 unix_cli_add_pending_output (uf, cf, buffer + n, buffer_bytes - n);
699 /** @brief Process a buffer for CRLF handling before outputting it to the CLI.
701 * @param cf Unix CLI session of the desired stream to write to.
702 * @param uf The Unix file structure of the desired stream to write to.
703 * @param buffer Pointer to the buffer that needs to be written.
704 * @param buffer_bytes The number of bytes from \c buffer to write.
707 unix_vlib_cli_output_cooked (unix_cli_file_t * cf,
709 u8 * buffer, uword buffer_bytes)
711 word end = 0, start = 0;
713 while (end < buffer_bytes)
717 /* iterate the line on \n's so we can insert a \r before it */
718 end = unix_vlib_findchr ('\n',
720 buffer_bytes - start) + start;
724 /* otherwise just send the whole buffer */
728 unix_vlib_cli_output_raw (cf, uf, buffer + start, end - start);
732 if (end < buffer_bytes)
734 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\r\n", 2);
735 end++; /* skip the \n that we already sent */
741 /* Use the last character to determine the last direction of the cursor. */
742 if (buffer_bytes > 0)
743 cf->cursor_direction = (buffer[buffer_bytes - 1] == (u8) '\b');
746 /** @brief Moves the terminal cursor one character to the left, with
747 * special handling when it reaches the left edge of the terminal window.
749 * Ordinarily we can simply send a '\b' to move the cursor left, however
750 * most terminals will not reverse-wrap to the end of the previous line
751 * if the cursor is in the left-most column. To counter this we must
752 * check the cursor position + prompt length modulo terminal width and
753 * if available use some other means, such as ANSI terminal escape
754 * sequences, to move the cursor.
756 * @param cf Unix CLI session of the desired stream to write to.
757 * @param uf The Unix file structure of the desired stream to write to.
760 unix_vlib_cli_output_cursor_left (unix_cli_file_t * cf, clib_file_t * uf)
762 unix_cli_main_t *cm = &unix_cli_main;
763 static u8 *ansi = 0; /* assumes no reentry */
766 if (!cf->is_interactive || !cf->ansi_capable || !cf->width)
768 /* No special handling for dumb terminals */
769 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
773 position = ((u32) vec_len (cm->cli_prompt) + cf->cursor) % cf->width;
777 /* No special handling required if we're not at the left edge */
778 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
782 if (!cf->cursor_direction)
784 /* Special handling for when we are at the left edge but
785 * the cursor was going left-to-right, but in this situation
786 * xterm-like terminals actually hide the cursor off the right
787 * edge. A \b here seems to jump one char too many, so let's
788 * force the cursor onto the next line instead.
790 if (cf->cursor < vec_len (cf->current_command))
791 unix_vlib_cli_output_cooked (cf, uf, &cf->current_command[cf->cursor],
794 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
795 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
798 /* Relocate the cursor at the right hand edge one line above */
799 ansi = format (ansi, CSI "A" CSI "%dC", cf->width - 1);
800 unix_vlib_cli_output_cooked (cf, uf, ansi, vec_len (ansi));
801 vec_reset_length (ansi); /* keep the vec around for next time */
802 cf->cursor_direction = 1; /* going backwards now */
805 /** @brief Output the CLI prompt */
807 unix_cli_cli_prompt (unix_cli_file_t * cf, clib_file_t * uf)
809 unix_cli_main_t *cm = &unix_cli_main;
811 if (cf->is_interactive) /* Only interactive sessions get a prompt */
812 unix_vlib_cli_output_raw (cf, uf, cm->cli_prompt,
813 vec_len (cm->cli_prompt));
816 /** @brief Output a pager prompt and show number of buffered lines */
818 unix_cli_pager_prompt (unix_cli_file_t * cf, clib_file_t * uf)
823 h = cf->pager_start + (cf->height - 1);
824 if (h > vec_len (cf->pager_index))
825 h = vec_len (cf->pager_index);
827 prompt = format (0, "\r%s-- more -- (%d-%d/%d)%s",
828 cf->ansi_capable ? ANSI_BOLD : "",
831 vec_len (cf->pager_index),
832 cf->ansi_capable ? ANSI_RESET : "");
834 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
839 /** @brief Output a pager "skipping" message */
841 unix_cli_pager_message (unix_cli_file_t * cf, clib_file_t * uf,
842 char *message, char *postfix)
846 prompt = format (0, "\r%s-- %s --%s%s",
847 cf->ansi_capable ? ANSI_BOLD : "",
848 message, cf->ansi_capable ? ANSI_RESET : "", postfix);
850 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
855 /** @brief Erase the printed pager prompt */
857 unix_cli_pager_prompt_erase (unix_cli_file_t * cf, clib_file_t * uf)
859 if (cf->ansi_capable)
861 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
862 unix_vlib_cli_output_cooked (cf, uf,
863 (u8 *) ANSI_CLEARLINE,
864 sizeof (ANSI_CLEARLINE) - 1);
870 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
871 for (i = 0; i < cf->width - 1; i++)
872 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
873 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
877 /** @brief Uses an ANSI escape sequence to move the cursor */
879 unix_cli_ansi_cursor (unix_cli_file_t * cf, clib_file_t * uf, u16 x, u16 y)
883 str = format (0, "%s%d;%dH", CSI, y, x);
885 unix_vlib_cli_output_cooked (cf, uf, str, vec_len (str));
890 /** Redraw the currently displayed page of text.
891 * @param cf CLI session to redraw the pager buffer of.
892 * @param uf Unix file of the CLI session.
895 unix_cli_pager_redraw (unix_cli_file_t * cf, clib_file_t * uf)
897 unix_cli_pager_index_t *pi = NULL;
901 /* No active pager? Do nothing. */
902 if (!vec_len (cf->pager_index))
905 if (cf->ansi_capable)
907 /* If we have ANSI, send the clear screen sequence */
908 unix_vlib_cli_output_cooked (cf, uf,
910 sizeof (ANSI_CLEAR) - 1);
914 /* Otherwise make sure we're on a blank line */
915 unix_cli_pager_prompt_erase (cf, uf);
918 /* (Re-)send the current page of content */
919 for (i = 0; i < cf->height - 1 &&
920 i + cf->pager_start < vec_len (cf->pager_index); i++)
922 pi = &cf->pager_index[cf->pager_start + i];
923 line = cf->pager_vector[pi->line] + pi->offset;
925 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
927 /* if the last line didn't end in newline, add a newline */
928 if (pi && line[pi->length - 1] != '\n')
929 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
931 unix_cli_pager_prompt (cf, uf);
934 /** @brief Process and add a line to the pager index.
935 * In normal operation this function will take the given character string
936 * found in @c line and with length @c len_or_index and iterates the over the
937 * contents, adding each line of text discovered within it to the
938 * pager index. Lines are identified by newlines ("<code>\\n</code>") and by
939 * strings longer than the width of the terminal.
941 * If instead @c line is @c NULL then @c len_or_index is taken to mean the
942 * index of an existing line in the pager buffer; this simply means that the
943 * input line does not need to be cloned since we already have it. This is
944 * typical if we are reindexing the pager buffer.
946 * @param cf The CLI session whose pager we are adding to.
947 * @param line The string of text to be indexed into the pager buffer.
948 * If @c line is @c NULL then the mode of operation
949 * changes slightly; see the description above.
950 * @param len_or_index If @c line is a pointer to a string then this parameter
951 * indicates the length of that string; Otherwise this
952 * value provides the index in the pager buffer of an
953 * existing string to be indexed.
956 unix_cli_pager_add_line (unix_cli_file_t * cf, u8 * line, word len_or_index)
960 word line_index, len;
961 u32 width = cf->width;
962 unix_cli_pager_index_t *pi;
966 /* Use a line already in the pager buffer */
967 line_index = len_or_index;
968 if (cf->pager_vector != NULL)
969 p = cf->pager_vector[line_index];
975 /* Add a copy of the raw string to the pager buffer */
976 p = vec_new (u8, len);
977 clib_memcpy (p, line, len);
979 /* store in pager buffer */
980 line_index = vec_len (cf->pager_vector);
981 vec_add1 (cf->pager_vector, p);
987 /* Find the next line, or run to terminal width, or run to EOL */
989 j = unix_vlib_findchr ((u8) '\n', p, l < width ? l : width);
991 if (j < l && p[j] == '\n') /* incl \n */
994 /* Add the line to the index */
995 k = vec_len (cf->pager_index);
996 vec_validate (cf->pager_index, k);
997 pi = &cf->pager_index[k];
999 pi->line = line_index;
1008 /** @brief Reindex entire pager buffer.
1009 * Resets the current pager index and then re-adds the lines in the pager
1010 * buffer to the index.
1012 * Additionally this function attempts to retain the current page start
1013 * line offset by searching for the same top-of-screen line in the new index.
1015 * @param cf The CLI session whose pager buffer should be reindexed.
1018 unix_cli_pager_reindex (unix_cli_file_t * cf)
1020 word i, old_line, old_offset;
1021 unix_cli_pager_index_t *pi;
1023 /* If there is nothing in the pager buffer then make sure the index
1024 * is empty and move on.
1026 if (cf->pager_vector == 0)
1028 vec_reset_length (cf->pager_index);
1032 /* Retain a pointer to the current page start line so we can
1035 pi = &cf->pager_index[cf->pager_start];
1036 old_line = pi->line;
1037 old_offset = pi->offset;
1039 /* Re-add the buffered lines to the index */
1040 vec_reset_length (cf->pager_index);
1041 vec_foreach_index (i, cf->pager_vector)
1043 unix_cli_pager_add_line (cf, NULL, i);
1046 /* Attempt to re-locate the previously stored page start line */
1047 vec_foreach_index (i, cf->pager_index)
1049 pi = &cf->pager_index[i];
1051 if (pi->line == old_line &&
1052 (pi->offset <= old_offset || pi->offset + pi->length > old_offset))
1055 cf->pager_start = i;
1060 /* In case the start line was not found (rare), ensure the pager start
1061 * index is within bounds
1063 if (cf->pager_start >= vec_len (cf->pager_index))
1065 if (!cf->height || vec_len (cf->pager_index) < (cf->height - 1))
1066 cf->pager_start = 0;
1068 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
1072 /** VLIB CLI output function.
1074 * If the terminal has a pager configured then this function takes care
1075 * of collating output into the pager buffer; ensuring only the first page
1076 * is displayed and any lines in excess of the first page are buffered.
1078 * If the maximum number of index lines in the buffer is exceeded then the
1079 * pager is cancelled and the contents of the current buffer are sent to the
1082 * If there is no pager configured then the output is sent directly to the
1085 * @param cli_file_index Index of the CLI session where this output is
1087 * @param buffer String of printabe bytes to be output.
1088 * @param buffer_bytes The number of bytes in @c buffer to be output.
1091 unix_vlib_cli_output (uword cli_file_index, u8 * buffer, uword buffer_bytes)
1093 unix_main_t *um = &unix_main;
1094 clib_file_main_t *fm = &file_main;
1095 unix_cli_main_t *cm = &unix_cli_main;
1096 unix_cli_file_t *cf;
1099 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
1100 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1102 if (cf->no_pager || um->cli_pager_buffer_limit == 0 || cf->height == 0)
1104 unix_vlib_cli_output_cooked (cf, uf, buffer, buffer_bytes);
1108 word row = vec_len (cf->pager_index);
1110 unix_cli_pager_index_t *pi;
1112 /* Index and add the output lines to the pager buffer. */
1113 unix_cli_pager_add_line (cf, buffer, buffer_bytes);
1115 /* Now iterate what was added to display the lines.
1116 * If we reach the bottom of the page, display a prompt.
1118 while (row < vec_len (cf->pager_index))
1120 if (row < cf->height - 1)
1122 /* output this line */
1123 pi = &cf->pager_index[row];
1124 line = cf->pager_vector[pi->line] + pi->offset;
1125 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1127 /* if the last line didn't end in newline, and we're at the
1128 * bottom of the page, add a newline */
1129 if (line[pi->length - 1] != '\n' && row == cf->height - 2)
1130 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1134 /* Display the pager prompt every 10 lines */
1136 unix_cli_pager_prompt (cf, uf);
1141 /* Check if we went over the pager buffer limit */
1142 if (vec_len (cf->pager_index) > um->cli_pager_buffer_limit)
1144 /* Stop using the pager for the remainder of this CLI command */
1147 /* If we likely printed the prompt, erase it */
1148 if (vec_len (cf->pager_index) > cf->height - 1)
1149 unix_cli_pager_prompt_erase (cf, uf);
1151 /* Dump out the contents of the buffer */
1152 for (row = cf->pager_start + (cf->height - 1);
1153 row < vec_len (cf->pager_index); row++)
1155 pi = &cf->pager_index[row];
1156 line = cf->pager_vector[pi->line] + pi->offset;
1157 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1160 unix_cli_pager_reset (cf);
1165 /** Identify whether a terminal type is ANSI capable.
1167 * Compares the string given in @c term with a list of terminal types known
1168 * to support ANSI escape sequences.
1170 * This list contains, for example, @c xterm, @c screen and @c ansi.
1172 * @param term A string with a terminal type in it.
1173 * @param len The length of the string in @c term.
1175 * @return @c 1 if the terminal type is recognized as supporting ANSI
1176 * terminal sequences; @c 0 otherwise.
1179 unix_cli_terminal_type_ansi (u8 * term, uword len)
1181 /* This may later be better done as a hash of some sort. */
1183 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1188 _("xterm-256color"); /* iTerm on Mac */
1190 _("screen-256color"); /* Screen and tmux */
1191 _("ansi"); /* Microsoft Telnet */
1197 /** Identify whether a terminal type is non-interactive.
1199 * Compares the string given in @c term with a list of terminal types known
1200 * to be non-interactive, as send by tools such as @c vppctl .
1202 * This list contains, for example, @c vppctl.
1204 * @param term A string with a terminal type in it.
1205 * @param len The length of the string in @c term.
1207 * @return @c 1 if the terminal type is recognized as being non-interactive;
1211 unix_cli_terminal_type_noninteractive (u8 * term, uword len)
1213 /* This may later be better done as a hash of some sort. */
1215 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1224 /** Set a session to be non-interactive. */
1226 unix_cli_set_session_noninteractive (unix_cli_file_t * cf)
1228 /* Non-interactive sessions don't get these */
1229 cf->is_interactive = 0;
1231 cf->history_limit = 0;
1232 cf->has_history = 0;
1236 /** @brief Emit initial welcome banner and prompt on a connection. */
1238 unix_cli_file_welcome (unix_cli_main_t * cm, unix_cli_file_t * cf)
1240 unix_main_t *um = &unix_main;
1241 clib_file_main_t *fm = &file_main;
1242 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1243 unix_cli_banner_t *banner;
1246 /* Mark the session as started if we get here */
1249 if (!(cf->is_interactive)) /* No banner for non-interactive sessions */
1253 * Put the first bytes directly into the buffer so that further output is
1254 * queued until everything is ready. (oterwise initial prompt can appear
1255 * mid way through VPP initialization)
1257 unix_cli_add_pending_output (uf, cf, (u8 *) "\r", 1);
1259 if (!um->cli_no_banner && (um->flags & UNIX_FLAG_NOBANNER) == 0)
1261 if (cf->ansi_capable && (um->flags & UNIX_FLAG_NOCOLOR) == 0)
1263 banner = unix_cli_banner_color;
1264 len = ARRAY_LEN (unix_cli_banner_color);
1268 banner = unix_cli_banner;
1269 len = ARRAY_LEN (unix_cli_banner);
1272 for (i = 0; i < len; i++)
1274 unix_vlib_cli_output_cooked (cf, uf,
1275 banner[i].line, banner[i].length);
1280 unix_cli_cli_prompt (cf, uf);
1285 * @brief A failsafe manager that ensures CLI sessions issue an initial
1286 * prompt if TELNET negotiation fails.
1289 unix_cli_new_session_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1292 unix_cli_main_t *cm = &unix_cli_main;
1293 uword event_type, *event_data = 0;
1298 if (vec_len (cm->new_sessions) > 0)
1299 wait = vlib_process_wait_for_event_or_clock (vm, wait);
1301 vlib_process_wait_for_event (vm);
1303 event_type = vlib_process_get_events (vm, &event_data);
1307 case ~0: /* no events => timeout */
1310 case UNIX_CLI_NEW_SESSION_EVENT_ADD:
1312 /* Add an identifier to the new session list */
1313 unix_cli_new_session_t ns;
1315 ns.cf_index = event_data[0];
1316 ns.deadline = vlib_time_now (vm) + 1.0;
1318 vec_add1 (cm->new_sessions, ns);
1321 wait = 0.1; /* force a re-evaluation soon, but not too soon */
1326 clib_warning ("BUG: unknown event type 0x%wx", event_type);
1330 vec_reset_length (event_data);
1332 if (vlib_process_suspend_time_is_zero (wait))
1334 /* Scan the list looking for expired deadlines.
1335 * Emit needed prompts and remove from the list.
1336 * While scanning, look for the nearest new deadline
1337 * for the next iteration.
1338 * Since the list is ordered with newest sessions first
1339 * we can make assumptions about expired sessions being
1340 * contiguous at the beginning and the next deadline is the
1341 * next entry on the list, if any.
1343 f64 now = vlib_time_now (vm);
1344 unix_cli_new_session_t *nsp;
1349 vec_foreach (nsp, cm->new_sessions)
1351 if (vlib_process_suspend_time_is_zero (nsp->deadline - now))
1353 /* Deadline reached */
1354 unix_cli_file_t *cf;
1356 /* Mark the highwater */
1359 /* Check the connection didn't close already */
1360 if (pool_is_free_index (cm->cli_file_pool, nsp->cf_index))
1363 cf = pool_elt_at_index (cm->cli_file_pool, nsp->cf_index);
1366 unix_cli_file_welcome (cm, cf);
1370 wait = nsp->deadline - now;
1377 /* We have sessions to remove */
1378 vec_delete (cm->new_sessions, index, 0);
1387 /** @brief A mostly no-op Telnet state machine.
1388 * Process Telnet command bytes in a way that ensures we're mostly
1389 * transparent to the Telnet protocol. That is, it's mostly a no-op.
1391 * @return -1 if we need more bytes, otherwise a positive integer number of
1392 * bytes to consume from the input_vector, not including the initial
1396 unix_cli_process_telnet (unix_main_t * um,
1397 unix_cli_file_t * cf,
1398 clib_file_t * uf, u8 * input_vector, uword len)
1400 /* Input_vector starts at IAC byte.
1401 * See if we have a complete message; if not, return -1 so we wait for more.
1402 * if we have a complete message, consume those bytes from the vector.
1407 return -1; /* want more bytes */
1409 switch (input_vector[1])
1412 /* two IAC's in a row means to pass through 0xff.
1413 * since that makes no sense here, just consume it.
1422 /* Expect 3 bytes */
1424 return -1; /* want more bytes */
1431 /* Sub option - search ahead for IAC SE to end it */
1433 for (i = 3; i < len && i < UNIX_CLI_MAX_DEPTH_TELNET; i++)
1435 if (input_vector[i - 1] == IAC && input_vector[i] == SE)
1437 /* We have a complete message; see if we care about it */
1438 switch (input_vector[2])
1441 if (input_vector[3] != 0)
1444 /* See if the the terminal type is recognized */
1445 u8 *term = input_vector + 4;
1448 /* See if the terminal type is ANSI capable */
1450 unix_cli_terminal_type_ansi (term, len);
1452 /* See if the terminal type indicates non-interactive */
1453 if (unix_cli_terminal_type_noninteractive (term, len))
1454 unix_cli_set_session_noninteractive (cf);
1457 /* If session not started, we can release the pause */
1459 /* Send the welcome banner and initial prompt */
1460 unix_cli_file_welcome (&unix_cli_main, cf);
1465 if (i != 8) /* check message is correct size */
1469 clib_net_to_host_u16 (*((u16 *) (input_vector + 3)));
1470 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
1471 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
1473 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
1476 clib_net_to_host_u16 (*((u16 *) (input_vector + 5)));
1477 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
1478 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
1479 if (cf->height == 0)
1480 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
1482 /* reindex pager buffer */
1483 unix_cli_pager_reindex (cf);
1485 unix_cli_pager_redraw (cf, uf);
1491 /* Consume it all */
1497 if (i == UNIX_CLI_MAX_DEPTH_TELNET)
1498 consume = 1; /* hit max search depth, advance one byte */
1501 return -1; /* want more bytes */
1519 /* Simple one-byte messages */
1524 /* Are You There - trigger a visible response */
1526 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "fd.io VPP\n", 10);
1530 /* Unknown command! Eat the IAC byte */
1537 /** @brief Process actionable input.
1538 * Based on the \c action process the input; this typically involves
1539 * searching the command history or editing the current command line.
1542 unix_cli_line_process_one (unix_cli_main_t * cm,
1544 unix_cli_file_t * cf,
1546 u8 input, unix_cli_parse_action_t action)
1550 u8 **possible_commands;
1555 case UNIX_CLI_PARSE_ACTION_NOACTION:
1558 case UNIX_CLI_PARSE_ACTION_REVSEARCH:
1559 case UNIX_CLI_PARSE_ACTION_FWDSEARCH:
1560 if (!cf->has_history || !cf->history_limit)
1562 if (cf->search_mode == 0)
1564 /* Erase the current command (if any) */
1565 for (; cf->cursor > 0; cf->cursor--)
1567 unix_vlib_cli_output_cursor_left (cf, uf);
1568 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1569 unix_vlib_cli_output_cursor_left (cf, uf);
1572 vec_reset_length (cf->search_key);
1573 vec_reset_length (cf->current_command);
1575 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1576 cf->search_mode = -1;
1578 cf->search_mode = 1;
1582 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1583 cf->search_mode = -1;
1585 cf->search_mode = 1;
1587 cf->excursion += cf->search_mode;
1592 case UNIX_CLI_PARSE_ACTION_ERASELINELEFT:
1593 /* Erase the command from the cursor to the start */
1596 /* Shimmy backwards to the new end of line position */
1597 delta = vec_len (cf->current_command) - cf->cursor;
1598 for (; cf->cursor > delta; cf->cursor--)
1599 unix_vlib_cli_output_cursor_left (cf, uf);
1600 /* Zap from here to the end of what is currently displayed */
1601 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1602 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1603 /* Get back to the start of the line */
1604 for (; cf->cursor > 0; cf->cursor--)
1605 unix_vlib_cli_output_cursor_left (cf, uf);
1607 /* Delete the desired text from the command */
1608 memmove (cf->current_command, cf->current_command + j, delta);
1609 _vec_len (cf->current_command) = delta;
1611 /* Print the new contents */
1612 unix_vlib_cli_output_cooked (cf, uf, cf->current_command, delta);
1613 cf->cursor = delta; /* for backspace tracking */
1615 /* Shimmy back to the start */
1616 for (; cf->cursor > 0; cf->cursor--)
1617 unix_vlib_cli_output_cursor_left (cf, uf);
1619 cf->search_mode = 0;
1622 case UNIX_CLI_PARSE_ACTION_ERASELINERIGHT:
1623 /* Erase the command from the cursor to the end */
1626 /* Zap from cursor to end of what is currently displayed */
1627 for (; cf->cursor < (vec_len (cf->current_command)); cf->cursor++)
1628 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1629 /* Get back to where we were */
1630 for (; cf->cursor > j; cf->cursor--)
1631 unix_vlib_cli_output_cursor_left (cf, uf);
1633 /* Truncate the line at the cursor */
1634 _vec_len (cf->current_command) = cf->cursor;
1636 cf->search_mode = 0;
1639 case UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT:
1640 /* calculate num of caracter to be erased */
1642 while (cf->cursor > delta
1643 && cf->current_command[cf->cursor - delta - 1] == ' ')
1645 while (cf->cursor > delta
1646 && cf->current_command[cf->cursor - delta - 1] != ' ')
1649 if (vec_len (cf->current_command))
1653 /* move cursor left delta times */
1654 for (j = delta; j > 0; j--, cf->cursor--)
1655 unix_vlib_cli_output_cursor_left (cf, uf);
1656 save = cf->current_command + cf->cursor;
1658 /* redraw remainder of line */
1659 memmove (cf->current_command + cf->cursor,
1660 cf->current_command + cf->cursor + delta,
1661 _vec_len (cf->current_command) - cf->cursor - delta);
1662 unix_vlib_cli_output_cooked (cf, uf,
1663 cf->current_command + cf->cursor,
1664 _vec_len (cf->current_command) -
1666 cf->cursor += _vec_len (cf->current_command) - cf->cursor;
1668 /* print delta amount of blank spaces,
1669 * then finally fix the cursor position */
1670 for (j = delta; j > 0; j--, cf->cursor--)
1671 unix_vlib_cli_output_cursor_left (cf, uf);
1672 for (j = delta; j > 0; j--, cf->cursor++)
1673 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1674 for (; (cf->current_command + cf->cursor) > save; cf->cursor--)
1675 unix_vlib_cli_output_cursor_left (cf, uf);
1676 _vec_len (cf->current_command) -= delta;
1679 cf->search_mode = 0;
1681 vec_reset_length (cf->search_key);
1684 case UNIX_CLI_PARSE_ACTION_LEFT:
1687 unix_vlib_cli_output_cursor_left (cf, uf);
1691 cf->search_mode = 0;
1694 case UNIX_CLI_PARSE_ACTION_RIGHT:
1695 if (cf->cursor < vec_len (cf->current_command))
1697 /* have to emit the character under the cursor */
1698 unix_vlib_cli_output_cooked (cf, uf,
1699 cf->current_command + cf->cursor, 1);
1703 cf->search_mode = 0;
1706 case UNIX_CLI_PARSE_ACTION_UP:
1707 case UNIX_CLI_PARSE_ACTION_DOWN:
1708 if (!cf->has_history || !cf->history_limit)
1710 cf->search_mode = 0;
1711 /* Erase the command */
1712 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1713 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1714 for (; cf->cursor > 0; cf->cursor--)
1716 unix_vlib_cli_output_cursor_left (cf, uf);
1717 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1718 unix_vlib_cli_output_cursor_left (cf, uf);
1720 vec_reset_length (cf->current_command);
1721 if (vec_len (cf->command_history))
1723 if (action == UNIX_CLI_PARSE_ACTION_UP)
1728 cf->excursion += delta;
1730 if (cf->excursion == vec_len (cf->command_history))
1732 /* down-arrowed to last entry - want a blank line */
1733 _vec_len (cf->current_command) = 0;
1735 else if (cf->excursion < 0)
1737 /* up-arrowed over the start to the end, want a blank line */
1738 cf->excursion = vec_len (cf->command_history);
1739 _vec_len (cf->current_command) = 0;
1743 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1744 /* down-arrowed past end - wrap to start */
1747 /* Print the command at the current position */
1748 prev = cf->command_history[cf->excursion];
1749 vec_validate (cf->current_command, vec_len (prev) - 1);
1751 clib_memcpy (cf->current_command, prev, vec_len (prev));
1752 _vec_len (cf->current_command) = vec_len (prev);
1753 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1754 vec_len (cf->current_command));
1757 cf->cursor = vec_len (cf->current_command);
1760 case UNIX_CLI_PARSE_ACTION_HOME:
1761 if (vec_len (cf->current_command) && cf->cursor > 0)
1763 for (; cf->cursor > 0; cf->cursor--)
1764 unix_vlib_cli_output_cursor_left (cf, uf);
1767 cf->search_mode = 0;
1770 case UNIX_CLI_PARSE_ACTION_END:
1771 if (vec_len (cf->current_command) &&
1772 cf->cursor < vec_len (cf->current_command))
1774 unix_vlib_cli_output_cooked (cf, uf,
1775 cf->current_command + cf->cursor,
1776 vec_len (cf->current_command) -
1778 cf->cursor = vec_len (cf->current_command);
1781 cf->search_mode = 0;
1784 case UNIX_CLI_PARSE_ACTION_WORDLEFT:
1785 if (vec_len (cf->current_command) && cf->cursor > 0)
1787 unix_vlib_cli_output_cursor_left (cf, uf);
1790 while (cf->cursor && isspace (cf->current_command[cf->cursor]))
1792 unix_vlib_cli_output_cursor_left (cf, uf);
1795 while (cf->cursor && !isspace (cf->current_command[cf->cursor]))
1797 if (isspace (cf->current_command[cf->cursor - 1]))
1799 unix_vlib_cli_output_cursor_left (cf, uf);
1805 cf->search_mode = 0;
1808 case UNIX_CLI_PARSE_ACTION_WORDRIGHT:
1809 if (vec_len (cf->current_command) &&
1810 cf->cursor < vec_len (cf->current_command))
1812 int e = vec_len (cf->current_command);
1814 while (j < e && !isspace (cf->current_command[j]))
1816 while (j < e && isspace (cf->current_command[j]))
1818 unix_vlib_cli_output_cooked (cf, uf,
1819 cf->current_command + cf->cursor,
1824 cf->search_mode = 0;
1828 case UNIX_CLI_PARSE_ACTION_ERASE:
1829 if (vec_len (cf->current_command))
1831 if (cf->cursor == vec_len (cf->current_command))
1833 unix_vlib_cli_output_cursor_left (cf, uf);
1835 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1837 unix_vlib_cli_output_cursor_left (cf, uf);
1839 _vec_len (cf->current_command)--;
1841 else if (cf->cursor > 0)
1843 /* shift everything at & to the right of the cursor left by 1 */
1844 j = vec_len (cf->current_command) - cf->cursor;
1845 memmove (cf->current_command + cf->cursor - 1,
1846 cf->current_command + cf->cursor, j);
1847 _vec_len (cf->current_command)--;
1849 /* redraw the rest of the line */
1850 unix_vlib_cli_output_cursor_left (cf, uf);
1852 unix_vlib_cli_output_cooked (cf, uf,
1853 cf->current_command + cf->cursor,
1856 /* erase last char */
1857 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1860 /* and shift the terminal cursor back where it should be */
1861 j += 2; /* account for old string length and offset position */
1864 unix_vlib_cli_output_cursor_left (cf, uf);
1869 cf->search_mode = 0;
1871 vec_reset_length (cf->search_key);
1874 case UNIX_CLI_PARSE_ACTION_ERASERIGHT:
1875 if (vec_len (cf->current_command))
1877 if (cf->cursor < vec_len (cf->current_command))
1879 /* shift everything to the right of the cursor left by 1 */
1880 j = vec_len (cf->current_command) - cf->cursor - 1;
1881 memmove (cf->current_command + cf->cursor,
1882 cf->current_command + cf->cursor + 1, j);
1883 _vec_len (cf->current_command)--;
1884 /* redraw the rest of the line */
1885 unix_vlib_cli_output_cooked (cf, uf,
1886 cf->current_command + cf->cursor,
1889 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1891 unix_vlib_cli_output_cursor_left (cf, uf);
1893 /* and shift the terminal cursor back where it should be */
1896 unix_vlib_cli_output_cursor_left (cf, uf);
1900 unix_vlib_cli_output_cursor_left (cf, uf);
1906 else if (input == 'D' - '@')
1908 /* ^D with no command entered = quit */
1909 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "quit\n", 5);
1910 vlib_process_signal_event (um->vlib_main,
1911 vlib_current_process (um->vlib_main),
1912 UNIX_CLI_PROCESS_EVENT_QUIT,
1913 cf - cm->cli_file_pool);
1915 cf->search_mode = 0;
1917 vec_reset_length (cf->search_key);
1920 case UNIX_CLI_PARSE_ACTION_CLEAR:
1921 /* If we're in ANSI mode, clear the screen.
1922 * Then redraw the prompt and any existing command input, then put
1923 * the cursor back where it was in that line.
1925 if (cf->ansi_capable)
1926 unix_vlib_cli_output_cooked (cf, uf,
1928 sizeof (ANSI_CLEAR) - 1);
1930 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1932 unix_vlib_cli_output_raw (cf, uf,
1933 cm->cli_prompt, vec_len (cm->cli_prompt));
1934 unix_vlib_cli_output_cooked (cf, uf,
1935 cf->current_command,
1936 vec_len (cf->current_command));
1938 cf->cursor = vec_len (cf->current_command);
1939 for (; cf->cursor > j; cf->cursor--)
1940 unix_vlib_cli_output_cursor_left (cf, uf);
1944 case UNIX_CLI_PARSE_ACTION_TAB:
1945 if (cf->cursor < vec_len (cf->current_command))
1947 /* if we are in the middle of a line, complete only if
1948 * the cursor points to whitespace */
1949 if (isspace (cf->current_command[cf->cursor]))
1951 /* save and clear any input that is after the cursor */
1952 vec_resize (save, vec_len (cf->current_command) - cf->cursor);
1953 clib_memcpy (save, cf->current_command + cf->cursor,
1954 vec_len (cf->current_command) - cf->cursor);
1955 _vec_len (cf->current_command) = cf->cursor;
1959 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1964 vlib_cli_get_possible_completions (cf->current_command);
1965 if (vec_len (possible_commands) == 1)
1967 u8 *completed = possible_commands[0];
1970 /* find the last word of current_command */
1971 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1973 unix_vlib_cli_output_cursor_left (cf, uf);
1977 _vec_len (cf->current_command) = j;
1979 /* replace it with the newly expanded command */
1980 vec_append (cf->current_command, completed);
1982 /* echo to the terminal */
1983 unix_vlib_cli_output_cooked (cf, uf, completed,
1984 vec_len (completed));
1986 /* add one trailing space if needed */
1987 if (vec_len (save) == 0)
1989 vec_add1 (cf->current_command, ' ');
1990 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1993 cf->cursor = vec_len (cf->current_command);
1996 else if (vec_len (possible_commands) >= 2)
1998 u8 **possible_command;
1999 uword max_command_len = 0, min_command_len = ~0;
2002 vec_foreach (possible_command, possible_commands)
2004 if (vec_len (*possible_command) > max_command_len)
2005 max_command_len = vec_len (*possible_command);
2006 if (vec_len (*possible_command) < min_command_len)
2007 min_command_len = vec_len (*possible_command);
2010 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2013 vec_foreach (possible_command, possible_commands)
2015 if (i + max_command_len >= cf->width)
2017 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2020 unix_vlib_cli_output_cooked (cf, uf, *possible_command,
2021 vec_len (*possible_command));
2022 for (j = vec_len (*possible_command); j < max_command_len + 2;
2025 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2027 i += max_command_len + 2;
2030 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2032 /* rewrite prompt */
2033 unix_cli_cli_prompt (cf, uf);
2034 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2035 vec_len (cf->current_command));
2037 /* count length of last word */
2040 while (j >= 1 && !isspace (cf->current_command[j - 1]))
2046 /* determine smallest common command */
2047 for (; i < min_command_len; i++)
2052 vec_foreach (possible_command, possible_commands)
2056 common = (*possible_command)[i];
2058 else if (common != (*possible_command)[i])
2067 vec_add1 (cf->current_command, common);
2069 unix_vlib_cli_output_cooked (cf, uf, (u8 *) & common, 1);
2079 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
2082 if (vec_len (save) > 0)
2084 /* restore remaining input if tab was hit in the middle of a line */
2085 unix_vlib_cli_output_cooked (cf, uf, save, vec_len (save));
2086 cf->cursor += vec_len (save);
2087 for (j = 0; j < vec_len (save); j++, cf->cursor--)
2088 unix_vlib_cli_output_cursor_left (cf, uf);
2089 vec_append (cf->current_command, save);
2092 vec_free (possible_commands);
2095 case UNIX_CLI_PARSE_ACTION_YANK:
2100 case UNIX_CLI_PARSE_ACTION_PAGER_QUIT:
2102 unix_cli_pager_prompt_erase (cf, uf);
2103 unix_cli_pager_reset (cf);
2104 unix_cli_cli_prompt (cf, uf);
2107 case UNIX_CLI_PARSE_ACTION_PAGER_NEXT:
2108 case UNIX_CLI_PARSE_ACTION_PAGER_PGDN:
2109 /* show next page of the buffer */
2110 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
2113 unix_cli_pager_index_t *pi = NULL;
2115 int m = cf->pager_start + (cf->height - 1);
2116 unix_cli_pager_prompt_erase (cf, uf);
2118 j < vec_len (cf->pager_index) && cf->pager_start < m;
2119 j++, cf->pager_start++)
2121 pi = &cf->pager_index[j];
2122 line = cf->pager_vector[pi->line] + pi->offset;
2123 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2125 /* if the last line didn't end in newline, add a newline */
2126 if (pi && line[pi->length - 1] != '\n')
2127 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2128 unix_cli_pager_prompt (cf, uf);
2132 if (action == UNIX_CLI_PARSE_ACTION_PAGER_NEXT)
2133 /* no more in buffer, exit, but only if it was <space> */
2138 case UNIX_CLI_PARSE_ACTION_PAGER_DN:
2139 case UNIX_CLI_PARSE_ACTION_PAGER_CRLF:
2140 /* display the next line of the buffer */
2141 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
2144 unix_cli_pager_index_t *pi;
2146 unix_cli_pager_prompt_erase (cf, uf);
2147 pi = &cf->pager_index[cf->pager_start + (cf->height - 1)];
2148 line = cf->pager_vector[pi->line] + pi->offset;
2149 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2151 /* if the last line didn't end in newline, add a newline */
2152 if (line[pi->length - 1] != '\n')
2153 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2154 unix_cli_pager_prompt (cf, uf);
2158 if (action == UNIX_CLI_PARSE_ACTION_PAGER_CRLF)
2159 /* no more in buffer, exit, but only if it was <enter> */
2165 case UNIX_CLI_PARSE_ACTION_PAGER_UP:
2166 /* scroll the page back one line */
2167 if (cf->pager_start > 0)
2170 unix_cli_pager_index_t *pi = NULL;
2173 if (cf->ansi_capable)
2175 pi = &cf->pager_index[cf->pager_start];
2176 line = cf->pager_vector[pi->line] + pi->offset;
2177 unix_cli_pager_prompt_erase (cf, uf);
2178 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SCROLLDN,
2179 sizeof (ANSI_SCROLLDN) - 1);
2180 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SAVECURSOR,
2181 sizeof (ANSI_SAVECURSOR) - 1);
2182 unix_cli_ansi_cursor (cf, uf, 1, 1);
2183 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_CLEARLINE,
2184 sizeof (ANSI_CLEARLINE) - 1);
2185 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2186 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_RESTCURSOR,
2187 sizeof (ANSI_RESTCURSOR) - 1);
2188 unix_cli_pager_prompt_erase (cf, uf);
2189 unix_cli_pager_prompt (cf, uf);
2193 int m = cf->pager_start + (cf->height - 1);
2194 unix_cli_pager_prompt_erase (cf, uf);
2195 for (j = cf->pager_start;
2196 j < vec_len (cf->pager_index) && j < m; j++)
2198 pi = &cf->pager_index[j];
2199 line = cf->pager_vector[pi->line] + pi->offset;
2200 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2202 /* if the last line didn't end in newline, add a newline */
2203 if (pi && line[pi->length - 1] != '\n')
2204 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2205 unix_cli_pager_prompt (cf, uf);
2210 case UNIX_CLI_PARSE_ACTION_PAGER_TOP:
2211 /* back to the first page of the buffer */
2212 if (cf->pager_start > 0)
2215 unix_cli_pager_index_t *pi = NULL;
2217 cf->pager_start = 0;
2218 int m = cf->pager_start + (cf->height - 1);
2219 unix_cli_pager_prompt_erase (cf, uf);
2220 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2223 pi = &cf->pager_index[j];
2224 line = cf->pager_vector[pi->line] + pi->offset;
2225 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2227 /* if the last line didn't end in newline, add a newline */
2228 if (pi && line[pi->length - 1] != '\n')
2229 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2230 unix_cli_pager_prompt (cf, uf);
2234 case UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM:
2235 /* skip to the last page of the buffer */
2236 if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
2239 unix_cli_pager_index_t *pi = NULL;
2241 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
2242 unix_cli_pager_prompt_erase (cf, uf);
2243 unix_cli_pager_message (cf, uf, "skipping", "\n");
2244 for (j = cf->pager_start; j < vec_len (cf->pager_index); j++)
2246 pi = &cf->pager_index[j];
2247 line = cf->pager_vector[pi->line] + pi->offset;
2248 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2250 /* if the last line didn't end in newline, add a newline */
2251 if (pi && line[pi->length - 1] != '\n')
2252 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2253 unix_cli_pager_prompt (cf, uf);
2257 case UNIX_CLI_PARSE_ACTION_PAGER_PGUP:
2258 /* wander back one page in the buffer */
2259 if (cf->pager_start > 0)
2262 unix_cli_pager_index_t *pi = NULL;
2265 if (cf->pager_start >= cf->height)
2266 cf->pager_start -= cf->height - 1;
2268 cf->pager_start = 0;
2269 m = cf->pager_start + cf->height - 1;
2270 unix_cli_pager_prompt_erase (cf, uf);
2271 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2274 pi = &cf->pager_index[j];
2275 line = cf->pager_vector[pi->line] + pi->offset;
2276 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2278 /* if the last line didn't end in newline, add a newline */
2279 if (pi && line[pi->length - 1] != '\n')
2280 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2281 unix_cli_pager_prompt (cf, uf);
2285 case UNIX_CLI_PARSE_ACTION_PAGER_REDRAW:
2286 /* Redraw the current pager screen */
2287 unix_cli_pager_redraw (cf, uf);
2290 case UNIX_CLI_PARSE_ACTION_PAGER_SEARCH:
2291 /* search forwards in the buffer */
2295 case UNIX_CLI_PARSE_ACTION_CRLF:
2297 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2299 if (cf->has_history && cf->history_limit)
2301 if (cf->command_history
2302 && vec_len (cf->command_history) >= cf->history_limit)
2304 vec_free (cf->command_history[0]);
2305 vec_delete (cf->command_history, 1, 0);
2307 /* Don't add blank lines to the cmd history */
2308 if (vec_len (cf->current_command))
2310 /* Don't duplicate the previous command */
2311 j = vec_len (cf->command_history);
2313 (vec_len (cf->current_command) !=
2314 vec_len (cf->command_history[j - 1])
2315 || memcmp (cf->current_command, cf->command_history[j - 1],
2316 vec_len (cf->current_command)) != 0))
2318 /* copy the command to the history */
2320 vec_append (c, cf->current_command);
2321 vec_add1 (cf->command_history, c);
2322 cf->command_number++;
2325 cf->excursion = vec_len (cf->command_history);
2328 cf->search_mode = 0;
2329 vec_reset_length (cf->search_key);
2334 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2335 case UNIX_CLI_PARSE_ACTION_NOMATCH:
2336 if (vec_len (cf->pager_index))
2340 else if (cf->has_history && cf->search_mode != 0 && isprint (input))
2342 int k, limit, offset;
2345 vec_add1 (cf->search_key, input);
2348 for (j = 0; j < vec_len (cf->command_history); j++)
2350 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
2352 else if (cf->excursion < 0)
2353 cf->excursion = vec_len (cf->command_history) - 1;
2355 item = cf->command_history[cf->excursion];
2357 limit = (vec_len (cf->search_key) > vec_len (item)) ?
2358 vec_len (item) : vec_len (cf->search_key);
2360 for (offset = 0; offset <= vec_len (item) - limit; offset++)
2362 for (k = 0; k < limit; k++)
2364 if (item[k + offset] != cf->search_key[k])
2367 goto found_at_offset;
2375 for (; cf->cursor > 0; cf->cursor--)
2377 unix_vlib_cli_output_cursor_left (cf, uf);
2378 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2379 unix_vlib_cli_output_cursor_left (cf, uf);
2382 vec_validate (cf->current_command, vec_len (item) - 1);
2383 clib_memcpy (cf->current_command, item, vec_len (item));
2384 _vec_len (cf->current_command) = vec_len (item);
2386 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2387 vec_len (cf->current_command));
2388 cf->cursor = vec_len (cf->current_command);
2392 cf->excursion += cf->search_mode;
2395 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\nNo match...", 12);
2396 vec_reset_length (cf->search_key);
2397 vec_reset_length (cf->current_command);
2398 cf->search_mode = 0;
2402 else if (isprint (input)) /* skip any errant control codes */
2404 if (cf->cursor == vec_len (cf->current_command))
2407 vec_add1 (cf->current_command, input);
2410 /* Echo the character back to the client */
2411 unix_vlib_cli_output_cooked (cf, uf, &input, 1);
2415 /* Insert at cursor: resize +1 byte, move everything over */
2416 j = vec_len (cf->current_command) - cf->cursor;
2417 vec_add1 (cf->current_command, (u8) 'A');
2418 memmove (cf->current_command + cf->cursor + 1,
2419 cf->current_command + cf->cursor, j);
2420 cf->current_command[cf->cursor] = input;
2421 /* Redraw the line */
2423 unix_vlib_cli_output_cooked (cf, uf,
2424 cf->current_command + cf->cursor,
2428 /* Put terminal cursor back */
2429 for (; j > 0; j--, cf->cursor--)
2430 unix_vlib_cli_output_cursor_left (cf, uf);
2435 /* no-op - not printable or otherwise not actionable */
2442 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2448 /** @brief Process input bytes on a stream to provide line editing and
2449 * command history in the CLI. */
2451 unix_cli_line_edit (unix_cli_main_t * cm, unix_main_t * um,
2452 clib_file_main_t * fm, unix_cli_file_t * cf)
2454 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2457 for (i = 0; i < vec_len (cf->input_vector); i++)
2459 unix_cli_parse_action_t action;
2461 unix_cli_parse_actions_t *a;
2463 /* If we're in the pager mode, search the pager actions */
2465 vec_len (cf->pager_index) ? unix_cli_parse_pager :
2466 unix_cli_parse_strings;
2468 /* See if the input buffer is some sort of control code */
2469 action = unix_cli_match_action (a, &cf->input_vector[i],
2470 vec_len (cf->input_vector) - i,
2475 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2478 /* There was a partial match which means we need more bytes
2479 * than the input buffer currently has.
2480 * Since the bytes before here have been processed, shift
2481 * the remaining contents to the start of the input buffer.
2483 vec_delete (cf->input_vector, i, 0);
2485 return 1; /* wait for more */
2487 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2488 /* process telnet options */
2489 matched = unix_cli_process_telnet (um, cf, uf,
2490 cf->input_vector + i,
2491 vec_len (cf->input_vector) - i);
2494 /* There was a partial match which means we need more bytes
2495 * than the input buffer currently has.
2500 * Since the bytes before here have been processed, shift
2501 * the remaining contents to the start of the input buffer.
2503 vec_delete (cf->input_vector, i, 0);
2505 return 1; /* wait for more */
2510 /* If telnet option processing switched us to line mode, get us
2515 vec_delete (cf->input_vector, i, 0);
2516 vec_free (cf->current_command);
2517 cf->current_command = cf->input_vector;
2521 /* process the action */
2522 if (!unix_cli_line_process_one (cm, um, cf, uf,
2523 cf->input_vector[i], action))
2525 /* CRLF found. Consume the bytes from the input_vector */
2526 vec_delete (cf->input_vector, i + matched, 0);
2527 /* And tell our caller to execute cf->input_command */
2535 vec_reset_length (cf->input_vector);
2539 /** @brief Process input to a CLI session. */
2541 unix_cli_process_input (unix_cli_main_t * cm, uword cli_file_index)
2543 unix_main_t *um = &unix_main;
2544 clib_file_main_t *fm = &file_main;
2546 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2547 unformat_input_t input;
2548 int vlib_parse_eval (u8 *);
2550 cm->current_input_file_index = cli_file_index;
2553 /* Try vlibplex first. Someday... */
2554 if (0 && vlib_parse_eval (cf->input_vector) == 0)
2560 /* just treat whatever we got as a complete line of input */
2561 cf->current_command = cf->input_vector;
2565 /* Line edit, echo, etc. */
2566 if (unix_cli_line_edit (cm, um, fm, cf))
2567 /* want more input */
2574 vec_reset_length (lv);
2575 lv = format (lv, "%U[%d]: %v",
2576 format_timeval, 0 /* current bat-time */ ,
2577 0 /* current bat-format */ ,
2578 cli_file_index, cf->current_command);
2579 if ((vec_len (cf->current_command) > 0) &&
2580 (cf->current_command[vec_len (cf->current_command) - 1] != '\n'))
2581 lv = format (lv, "\n");
2582 int rv __attribute__ ((unused)) = write (um->log_fd, lv, vec_len (lv));
2585 /* Run the command through the macro processor */
2586 if (vec_len (cf->current_command))
2589 vec_validate (cf->current_command, vec_len (cf->current_command));
2590 cf->current_command[vec_len (cf->current_command) - 1] = 0;
2591 /* The macro expander expects proper C-strings, not vectors */
2592 expanded = (u8 *) clib_macro_eval (&cf->macro_main,
2593 (i8 *) cf->current_command,
2596 8 /* max_level */ );
2597 /* Macro processor NULL terminates the return */
2598 _vec_len (expanded) -= 1;
2599 vec_reset_length (cf->current_command);
2600 vec_append (cf->current_command, expanded);
2601 vec_free (expanded);
2604 /* Build an unformat structure around our command */
2605 unformat_init_vector (&input, cf->current_command);
2607 /* Remove leading white space from input. */
2608 (void) unformat (&input, "");
2610 cf->pager_start = 0; /* start a new pager session */
2612 if (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
2613 vlib_cli_input (um->vlib_main, &input, unix_vlib_cli_output,
2616 /* Zero buffer since otherwise unformat_free will call vec_free on it. */
2619 unformat_free (&input);
2621 /* Re-fetch pointer since pool may have moved. */
2622 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2623 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2626 /* reset vector; we'll re-use it later */
2629 vec_reset_length (cf->input_vector);
2630 cf->current_command = 0;
2634 vec_reset_length (cf->current_command);
2637 if (cf->no_pager == 2)
2639 /* Pager was programmatically disabled */
2640 unix_cli_pager_message (cf, uf, "pager buffer overflowed", "\n");
2641 cf->no_pager = um->cli_no_pager;
2644 if (vec_len (cf->pager_index) == 0
2645 || vec_len (cf->pager_index) < cf->height)
2647 /* There was no need for the pager */
2648 unix_cli_pager_reset (cf);
2651 unix_cli_cli_prompt (cf, uf);
2655 /* Display the pager prompt */
2656 unix_cli_pager_prompt (cf, uf);
2659 /* Any residual data in the input vector? */
2660 if (vec_len (cf->input_vector))
2663 /* For non-interactive sessions send a NUL byte.
2664 * Specifically this is because vppctl needs to see some traffic in
2665 * order to move on to closing the session. Commands with no output
2666 * would thus cause vppctl to hang indefinitely in non-interactive mode
2667 * since there is also no prompt sent after the command completes.
2669 if (!cf->is_interactive)
2670 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\0", 1);
2673 /** Destroy a CLI session.
2674 * @note If we destroy the @c stdin session this additionally signals
2675 * the shutdown of VPP.
2678 unix_cli_kill (unix_cli_main_t * cm, uword cli_file_index)
2680 unix_main_t *um = &unix_main;
2681 clib_file_main_t *fm = &file_main;
2682 unix_cli_file_t *cf;
2686 /* Validate cli_file_index */
2687 if (pool_is_free_index (cm->cli_file_pool, cli_file_index))
2690 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2691 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2693 /* Quit/EOF on stdin means quit program. */
2694 if (uf->file_descriptor == STDIN_FILENO)
2695 clib_longjmp (&um->vlib_main->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
2697 vec_free (cf->current_command);
2698 vec_free (cf->search_key);
2700 for (i = 0; i < vec_len (cf->command_history); i++)
2701 vec_free (cf->command_history[i]);
2703 vec_free (cf->command_history);
2704 vec_free (cf->input_vector);
2706 clib_file_del (fm, uf);
2708 unix_cli_file_free (cf);
2709 clib_macro_free (&cf->macro_main);
2710 pool_put (cm->cli_file_pool, cf);
2713 /** Handle system events. */
2715 unix_cli_process (vlib_main_t * vm,
2716 vlib_node_runtime_t * rt, vlib_frame_t * f)
2718 unix_cli_main_t *cm = &unix_cli_main;
2723 unix_cli_process_event_type_t event_type;
2724 vlib_process_wait_for_event (vm);
2725 event_type = vlib_process_get_events (vm, &data);
2729 case UNIX_CLI_PROCESS_EVENT_READ_READY:
2730 for (i = 0; i < vec_len (data); i++)
2731 unix_cli_process_input (cm, data[i]);
2734 case UNIX_CLI_PROCESS_EVENT_QUIT:
2735 /* Kill this process. */
2736 for (i = 0; i < vec_len (data); i++)
2737 unix_cli_kill (cm, data[i]);
2742 _vec_len (data) = 0;
2748 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
2750 /* Add node index so we can re-use this process later. */
2751 vec_add1 (cm->unused_cli_process_node_indices, rt->node_index);
2756 /** Called when a CLI session file descriptor can be written to without
2758 static clib_error_t *
2759 unix_cli_write_ready (clib_file_t * uf)
2761 unix_cli_main_t *cm = &unix_cli_main;
2762 unix_cli_file_t *cf;
2765 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2767 /* Flush output vector. */
2769 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
2770 n = send (uf->file_descriptor,
2771 cf->output_vector, vec_len (cf->output_vector), MSG_NOSIGNAL);
2773 n = write (uf->file_descriptor,
2774 cf->output_vector, vec_len (cf->output_vector));
2776 if (n < 0 && errno != EAGAIN)
2780 /* connection closed on us */
2781 unix_main_t *um = &unix_main;
2783 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
2784 UNIX_CLI_PROCESS_EVENT_QUIT,
2789 return clib_error_return_unix (0, "write");
2794 unix_cli_del_pending_output (uf, cf, n);
2796 return /* no error */ 0;
2799 /** Called when a CLI session file descriptor has data to be read. */
2800 static clib_error_t *
2801 unix_cli_read_ready (clib_file_t * uf)
2803 unix_main_t *um = &unix_main;
2804 unix_cli_main_t *cm = &unix_cli_main;
2805 unix_cli_file_t *cf;
2807 int n, n_read, n_try;
2809 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2814 l = vec_len (cf->input_vector);
2815 vec_resize (cf->input_vector, l + n_try);
2817 n = read (uf->file_descriptor, cf->input_vector + l, n_try);
2820 if (n < 0 && errno != EAGAIN)
2821 return clib_error_return_unix (0, "read");
2823 n_read = n < 0 ? 0 : n;
2824 _vec_len (cf->input_vector) = l + n_read;
2828 vlib_process_signal_event (um->vlib_main,
2829 cf->process_node_index,
2831 ? UNIX_CLI_PROCESS_EVENT_QUIT
2832 : UNIX_CLI_PROCESS_EVENT_READ_READY),
2833 /* event data */ uf->private_data);
2835 return /* no error */ 0;
2838 /** Called when a CLI session file descriptor has an error condition. */
2839 static clib_error_t *
2840 unix_cli_error_detected (clib_file_t * uf)
2842 unix_main_t *um = &unix_main;
2843 unix_cli_main_t *cm = &unix_cli_main;
2844 unix_cli_file_t *cf;
2846 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2847 cf->has_epipe = 1; /* prevent writes while the close is pending */
2848 vlib_process_signal_event (um->vlib_main,
2849 cf->process_node_index,
2850 UNIX_CLI_PROCESS_EVENT_QUIT,
2851 /* event data */ uf->private_data);
2853 return /* no error */ 0;
2856 /** Store a new CLI session.
2857 * @param name The name of the session.
2858 * @param fd The file descriptor for the session I/O.
2859 * @return The session ID.
2862 unix_cli_file_add (unix_cli_main_t * cm, char *name, int fd)
2864 unix_main_t *um = &unix_main;
2865 clib_file_main_t *fm = &file_main;
2866 unix_cli_file_t *cf;
2867 clib_file_t template = { 0 };
2868 vlib_main_t *vm = um->vlib_main;
2872 file_desc = format (0, "%s", name);
2874 name = (char *) format (0, "unix-cli-%s", name);
2876 if (vec_len (cm->unused_cli_process_node_indices) > 0)
2878 uword l = vec_len (cm->unused_cli_process_node_indices);
2880 vlib_main_t *this_vlib_main;
2884 * Nodes are bulk-copied, so node name pointers are shared.
2885 * Find the cli node in all graph replicas, and give all of them
2886 * the same new name.
2887 * Then, throw away the old shared name-vector.
2889 for (i = 0; i < vlib_get_n_threads (); i++)
2891 this_vlib_main = vlib_get_main_by_index (i);
2892 if (this_vlib_main == 0)
2894 n = vlib_get_node (this_vlib_main,
2895 cm->unused_cli_process_node_indices[l - 1]);
2897 n->name = (u8 *) name;
2899 vec_free (old_name);
2901 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
2903 _vec_len (cm->unused_cli_process_node_indices) = l - 1;
2907 static vlib_node_registration_t r = {
2908 .function = unix_cli_process,
2909 .type = VLIB_NODE_TYPE_PROCESS,
2910 .process_log2_n_stack_bytes = 18,
2915 vlib_worker_thread_barrier_sync (vm);
2917 vlib_register_node (vm, &r);
2920 n = vlib_get_node (vm, r.index);
2921 vlib_worker_thread_node_runtime_update ();
2922 vlib_worker_thread_barrier_release (vm);
2925 pool_get (cm->cli_file_pool, cf);
2926 clib_memset (cf, 0, sizeof (*cf));
2927 clib_macro_init (&cf->macro_main);
2929 template.read_function = unix_cli_read_ready;
2930 template.write_function = unix_cli_write_ready;
2931 template.error_function = unix_cli_error_detected;
2932 template.file_descriptor = fd;
2933 template.private_data = cf - cm->cli_file_pool;
2934 template.description = file_desc;
2936 cf->process_node_index = n->index;
2937 cf->clib_file_index = clib_file_add (fm, &template);
2938 cf->output_vector = 0;
2939 cf->input_vector = 0;
2940 vec_validate (cf->current_command, 0);
2941 _vec_len (cf->current_command) = 0;
2943 vlib_start_process (vm, n->runtime_index);
2945 vlib_process_t *p = vlib_get_process_from_node (vm, n);
2946 p->output_function = unix_vlib_cli_output;
2947 p->output_function_arg = cf - cm->cli_file_pool;
2949 return cf - cm->cli_file_pool;
2952 /** Telnet listening socket has a new connection. */
2953 static clib_error_t *
2954 unix_cli_listen_read_ready (clib_file_t * uf)
2956 unix_main_t *um = &unix_main;
2957 clib_file_main_t *fm = &file_main;
2958 unix_cli_main_t *cm = &unix_cli_main;
2959 clib_socket_t *s = &um->cli_listen_socket;
2960 clib_socket_t client;
2962 clib_error_t *error;
2963 unix_cli_file_t *cf;
2967 error = clib_socket_accept (s, &client);
2971 /* Disable Nagle, ignore any errors doing so eg on PF_LOCAL socket */
2973 (void) setsockopt (client.fd, IPPROTO_TCP, TCP_NODELAY,
2974 (void *) &one, sizeof (one));
2976 client_name = (char *) format (0, "%U%c", format_sockaddr, &client.peer, 0);
2978 cf_index = unix_cli_file_add (cm, client_name, client.fd);
2979 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2982 /* No longer need CLIB version of socket. */
2983 clib_socket_free (&client);
2984 vec_free (client_name);
2986 /* if we're supposed to run telnet session in character mode (default) */
2987 if (um->cli_line_mode == 0)
2990 * Set telnet client character mode, echo on, suppress "go-ahead".
2991 * Technically these should be negotiated, but this works.
2993 u8 charmode_option[] = {
2994 IAC, WONT, TELOPT_LINEMODE, /* server will do char-by-char */
2995 IAC, DONT, TELOPT_LINEMODE, /* client should do char-by-char */
2996 IAC, WILL, TELOPT_SGA, /* server willl supress GA */
2997 IAC, DO, TELOPT_SGA, /* client should supress Go Ahead */
2998 IAC, WILL, TELOPT_ECHO, /* server will do echo */
2999 IAC, DONT, TELOPT_ECHO, /* client should not echo */
3000 IAC, DO, TELOPT_TTYPE, /* client should tell us its term type */
3001 IAC, SB, TELOPT_TTYPE, 1, IAC, SE, /* now tell me ttype */
3002 IAC, DO, TELOPT_NAWS, /* client should tell us its window sz */
3003 IAC, SB, TELOPT_NAWS, 1, IAC, SE, /* now tell me window size */
3006 /* Enable history on this CLI */
3007 cf->history_limit = um->cli_history_limit;
3008 cf->has_history = cf->history_limit != 0;
3010 /* This is an interactive session until we decide otherwise */
3011 cf->is_interactive = 1;
3013 /* Make sure this session is in line mode */
3019 /* Setup the pager */
3020 cf->no_pager = um->cli_no_pager;
3022 /* Default terminal dimensions, should the terminal
3023 * fail to provide any.
3025 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3026 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3028 /* Send the telnet options */
3029 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3030 unix_vlib_cli_output_raw (cf, uf, charmode_option,
3031 ARRAY_LEN (charmode_option));
3033 if (cm->new_session_process_node_index == ~0)
3035 /* Create thw new session deadline process */
3036 cm->new_session_process_node_index =
3037 vlib_process_create (um->vlib_main, "unix-cli-new-session",
3038 unix_cli_new_session_process,
3039 16 /* log2_n_stack_bytes */ );
3042 /* In case the client doesn't negotiate terminal type, register
3043 * our session with a process that will emit the prompt if
3044 * a deadline passes */
3045 vlib_process_signal_event (um->vlib_main,
3046 cm->new_session_process_node_index,
3047 UNIX_CLI_NEW_SESSION_EVENT_ADD, cf_index);
3054 /** The system terminal has informed us that the window size
3058 unix_cli_resize_interrupt (int signum)
3060 clib_file_main_t *fm = &file_main;
3061 unix_cli_main_t *cm = &unix_cli_main;
3062 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
3063 cm->stdin_cli_file_index);
3064 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3068 /* Terminal resized, fetch the new size */
3069 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) < 0)
3071 /* "Should never happen..." */
3072 clib_unix_warning ("TIOCGWINSZ");
3073 /* We can't trust ws.XXX... */
3077 cf->width = ws.ws_col;
3078 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
3079 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
3081 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3083 cf->height = ws.ws_row;
3084 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
3085 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
3086 if (cf->height == 0)
3087 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3089 /* Reindex the pager buffer */
3090 unix_cli_pager_reindex (cf);
3092 /* Redraw the page */
3093 unix_cli_pager_redraw (cf, uf);
3096 /** Handle configuration directives in the @em unix section. */
3097 static clib_error_t *
3098 unix_cli_config (vlib_main_t * vm, unformat_input_t * input)
3100 unix_main_t *um = &unix_main;
3101 clib_file_main_t *fm = &file_main;
3102 unix_cli_main_t *cm = &unix_cli_main;
3104 clib_error_t *error = 0;
3105 unix_cli_file_t *cf;
3108 struct sigaction sa;
3112 /* We depend on unix flags being set. */
3113 if ((error = vlib_call_config_function (vm, unix_config)))
3116 if (um->flags & UNIX_FLAG_INTERACTIVE)
3118 /* Set stdin to be non-blocking. */
3119 if ((flags = fcntl (STDIN_FILENO, F_GETFL, 0)) < 0)
3121 (void) fcntl (STDIN_FILENO, F_SETFL, flags | O_NONBLOCK);
3123 cf_index = unix_cli_file_add (cm, "stdin", STDIN_FILENO);
3124 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
3125 cm->stdin_cli_file_index = cf_index;
3127 /* If stdin is a tty and we are using chacracter mode, enable
3128 * history on the CLI and set the tty line discipline accordingly. */
3129 if (isatty (STDIN_FILENO) && um->cli_line_mode == 0)
3131 /* Capture terminal resize events */
3132 clib_memset (&sa, 0, sizeof (sa));
3133 sa.sa_handler = unix_cli_resize_interrupt;
3134 if (sigaction (SIGWINCH, &sa, 0) < 0)
3135 clib_panic ("sigaction");
3137 /* Retrieve the current terminal size */
3138 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) == 0)
3140 cf->width = ws.ws_col;
3141 cf->height = ws.ws_row;
3144 if (cf->width == 0 || cf->height == 0)
3147 * We have a tty, but no size. Use defaults.
3148 * vpp "unix interactive" inside emacs + gdb ends up here.
3150 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3151 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3154 /* Setup the history */
3155 cf->history_limit = um->cli_history_limit;
3156 cf->has_history = cf->history_limit != 0;
3158 /* Setup the pager */
3159 cf->no_pager = um->cli_no_pager;
3161 /* This is an interactive session until we decide otherwise */
3162 cf->is_interactive = 1;
3164 /* We're going to be in char by char mode */
3167 /* Save the original tty state so we can restore it later */
3168 tcgetattr (STDIN_FILENO, &um->tio_stdin);
3171 /* Tweak the tty settings */
3172 tio = um->tio_stdin;
3173 /* echo off, canonical mode off, ext'd input processing off */
3174 tio.c_lflag &= ~(ECHO | ICANON | IEXTEN);
3175 /* disable XON/XOFF, so ^S invokes the history search */
3176 tio.c_iflag &= ~(IXON | IXOFF);
3177 tio.c_cc[VMIN] = 1; /* 1 byte at a time */
3178 tio.c_cc[VTIME] = 0; /* no timer */
3179 tio.c_cc[VSTOP] = _POSIX_VDISABLE; /* not ^S */
3180 tio.c_cc[VSTART] = _POSIX_VDISABLE; /* not ^Q */
3181 tcsetattr (STDIN_FILENO, TCSAFLUSH, &tio);
3183 /* See if we can do ANSI/VT100 output */
3184 term = (u8 *) getenv ("TERM");
3187 int len = strlen ((char *) term);
3188 cf->ansi_capable = unix_cli_terminal_type_ansi (term, len);
3189 if (unix_cli_terminal_type_noninteractive (term, len))
3190 unix_cli_set_session_noninteractive (cf);
3195 /* No tty, so make sure the session doesn't have tty-like features */
3196 unix_cli_set_session_noninteractive (cf);
3199 /* Send banner and initial prompt */
3200 unix_cli_file_welcome (cm, cf);
3203 /* If we have socket config, LISTEN, otherwise, don't */
3204 clib_socket_t *s = &um->cli_listen_socket;
3205 if (s->config && s->config[0] != 0)
3208 clib_file_t template = { 0 };
3210 /* mkdir of file socketu, only under /run */
3211 if (strncmp (s->config, "/run", 4) == 0)
3213 u8 *tmp = format (0, "%s", s->config);
3214 int i = vec_len (tmp);
3215 while (i && tmp[--i] != '/')
3221 vlib_unix_recursive_mkdir ((char *) tmp);
3225 s->flags = CLIB_SOCKET_F_IS_SERVER | /* listen, don't connect */
3226 CLIB_SOCKET_F_ALLOW_GROUP_WRITE; /* PF_LOCAL socket only */
3227 error = clib_socket_init (s);
3232 template.read_function = unix_cli_listen_read_ready;
3233 template.file_descriptor = s->fd;
3234 template.description = format (0, "cli listener %s", s->config);
3236 clib_file_add (fm, &template);
3239 /* Set CLI prompt. */
3240 if (!cm->cli_prompt)
3241 cm->cli_prompt = format (0, "VLIB: ");
3247 * This module has no configurable parameters.
3249 VLIB_CONFIG_FUNCTION (unix_cli_config, "unix-cli");
3251 /** Called when VPP is shutting down, this restores the system
3252 * terminal state if previously saved.
3254 static clib_error_t *
3255 unix_cli_exit (vlib_main_t * vm)
3257 unix_main_t *um = &unix_main;
3259 /* If stdin is a tty and we saved the tty state, reset the tty state */
3260 if (isatty (STDIN_FILENO) && um->tio_isset)
3261 tcsetattr (STDIN_FILENO, TCSAFLUSH, &um->tio_stdin);
3266 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_cli_exit);
3268 /** Set the CLI prompt.
3269 * @param prompt The C string to set the prompt to.
3270 * @note This setting is global; it impacts all current
3271 * and future CLI sessions.
3274 vlib_unix_cli_set_prompt (char *prompt)
3276 char *fmt = (prompt[strlen (prompt) - 1] == ' ') ? "%s" : "%s ";
3277 unix_cli_main_t *cm = &unix_cli_main;
3279 vec_free (cm->cli_prompt);
3280 cm->cli_prompt = format (0, fmt, prompt);
3283 static unix_cli_file_t *
3284 unix_cli_file_if_exists (unix_cli_main_t * cm)
3286 if (!cm->cli_file_pool)
3288 return pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3291 static unix_cli_file_t *
3292 unix_cli_file_if_interactive (unix_cli_main_t * cm)
3294 unix_cli_file_t *cf;
3295 if ((cf = unix_cli_file_if_exists (cm)) && !cf->is_interactive)
3300 /** CLI command to quit the terminal session.
3301 * @note If this is a stdin session then this will
3302 * shutdown VPP also.
3304 static clib_error_t *
3305 unix_cli_quit (vlib_main_t * vm,
3306 unformat_input_t * input, vlib_cli_command_t * cmd)
3308 unix_cli_main_t *cm = &unix_cli_main;
3309 unix_cli_file_t *cf;
3311 if (!(cf = unix_cli_file_if_exists (cm)))
3312 return clib_error_return (0, "invalid session");
3314 /* Cosmetic: suppress the final prompt from appearing before we die */
3315 cf->is_interactive = 0;
3318 vlib_process_signal_event (vm,
3319 vlib_current_process (vm),
3320 UNIX_CLI_PROCESS_EVENT_QUIT,
3321 cm->current_input_file_index);
3326 * Terminates the current CLI session.
3328 * If VPP is running in @em interactive mode and this is the console session
3329 * (that is, the session on @c stdin) then this will also terminate VPP.
3332 VLIB_CLI_COMMAND (unix_cli_quit_command, static) = {
3334 .short_help = "Exit CLI",
3335 .function = unix_cli_quit,
3340 VLIB_CLI_COMMAND (unix_cli_q_command, static) = {
3342 .short_help = "Exit CLI",
3343 .function = unix_cli_quit,
3347 /** CLI command to execute a VPP command script. */
3348 static clib_error_t *
3349 unix_cli_exec (vlib_main_t * vm,
3350 unformat_input_t * input, vlib_cli_command_t * cmd)
3354 unformat_input_t sub_input;
3355 unformat_input_t _line_input, *line_input = &_line_input;
3356 clib_error_t *error;
3357 unix_cli_main_t *cm = &unix_cli_main;
3358 unix_cli_file_t *cf;
3366 if (!unformat (input, "%s", &file_name))
3368 error = clib_error_return (0, "expecting file name, got `%U'",
3369 format_unformat_error, input);
3373 fd = open (file_name, O_RDONLY);
3376 error = clib_error_return_unix (0, "failed to open `%s'", file_name);
3380 /* Make sure its a regular file. */
3381 if (fstat (fd, &s) < 0)
3383 error = clib_error_return_unix (0, "failed to stat `%s'", file_name);
3387 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
3389 error = clib_error_return (0, "not a regular file `%s'", file_name);
3394 vec_validate (file_data, s.st_size);
3396 if (read (fd, file_data, s.st_size) != s.st_size)
3398 error = clib_error_return_unix (0, "Failed to read %d bytes from '%s'",
3399 s.st_size, file_name);
3400 vec_free (file_data);
3404 /* The macro expander expects a c string... */
3405 vec_add1 (file_data, 0);
3407 unformat_init_vector (&sub_input, file_data);
3409 /* Run the file contents through the macro processor */
3410 if (vec_len (sub_input.buffer) > 1)
3413 clib_macro_main_t *mm = 0;
3415 /* Initial config process? Use the global macro table. */
3416 if (pool_is_free_index
3417 (cm->cli_file_pool, cm->current_input_file_index))
3418 mm = &cm->macro_main;
3421 /* Otherwise, use the per-cli-process macro table */
3422 cf = pool_elt_at_index (cm->cli_file_pool,
3423 cm->current_input_file_index);
3424 mm = &cf->macro_main;
3427 expanded = (u8 *) clib_macro_eval (mm,
3428 (i8 *) sub_input.buffer,
3431 8 /* max_level */ );
3432 /* Macro processor NULL terminates the return */
3433 _vec_len (expanded) -= 1;
3434 vec_reset_length (sub_input.buffer);
3435 vec_append (sub_input.buffer, expanded);
3436 vec_free (expanded);
3439 while (unformat_user (&sub_input, unformat_line_input, line_input))
3441 vlib_cli_input (vm, line_input, 0, 0);
3442 unformat_free (line_input);
3444 unformat_free (&sub_input);
3449 vec_free (file_name);
3455 * Executes a sequence of CLI commands which are read from a file. If
3456 * a command is unrecognised or otherwise invalid then the usual CLI
3457 * feedback will be generated, however execution of subsequent commands
3458 * from the file will continue.
3460 * The VPP code is indifferent to the file location. However, if SELinux
3461 * is enabled, then the file needs to have an SELinux label the VPP
3462 * process is allowed to access. For example, if a file is created in
3463 * '<em>/usr/share/vpp/</em>', it will be allowed. However, files manually
3464 * created in '/tmp/' or '/home/<user>/' will not be accessible by the VPP
3465 * process when SELinux is enabled.
3470 * <b><em>$ cat /usr/share/vpp/scripts/gigup.txt</em></b>
3471 * set interface state GigabitEthernet0/8/0 up
3472 * set interface state GigabitEthernet0/9/0 up
3474 * Example of how to execute a set of CLI commands from a file:
3475 * @cliexcmd{exec /usr/share/vpp/scripts/gigup.txt}
3478 VLIB_CLI_COMMAND (cli_exec, static) = {
3480 .short_help = "exec <filename>",
3481 .function = unix_cli_exec,
3486 /** CLI command to show various unix error statistics. */
3487 static clib_error_t *
3488 unix_show_errors (vlib_main_t * vm,
3489 unformat_input_t * input, vlib_cli_command_t * cmd)
3491 unix_main_t *um = &unix_main;
3492 clib_error_t *error = 0;
3493 int i, n_errors_to_show;
3494 unix_error_history_t *unix_errors = 0;
3496 n_errors_to_show = 1 << 30;
3498 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3500 if (!unformat (input, "%d", &n_errors_to_show))
3503 clib_error_return (0,
3504 "expecting integer number of errors to show, got `%U'",
3505 format_unformat_error, input);
3511 clib_min (ARRAY_LEN (um->error_history), n_errors_to_show);
3514 um->error_history_index >
3515 0 ? um->error_history_index - 1 : ARRAY_LEN (um->error_history) - 1;
3517 while (n_errors_to_show > 0)
3519 unix_error_history_t *eh = um->error_history + i;
3524 vec_add1 (unix_errors, eh[0]);
3525 n_errors_to_show -= 1;
3527 i = ARRAY_LEN (um->error_history) - 1;
3532 if (vec_len (unix_errors) == 0)
3533 vlib_cli_output (vm, "no Unix errors so far");
3536 vlib_cli_output (vm, "%Ld total errors seen", um->n_total_errors);
3537 for (i = vec_len (unix_errors) - 1; i >= 0; i--)
3539 unix_error_history_t *eh = vec_elt_at_index (unix_errors, i);
3540 vlib_cli_output (vm, "%U: %U",
3541 format_time_interval, "h:m:s:u", eh->time,
3542 format_clib_error, eh->error);
3544 vlib_cli_output (vm, "%U: time now",
3545 format_time_interval, "h:m:s:u", vlib_time_now (vm));
3549 vec_free (unix_errors);
3554 VLIB_CLI_COMMAND (cli_unix_show_errors, static) = {
3555 .path = "show unix errors",
3556 .short_help = "Show Unix system call error history",
3557 .function = unix_show_errors,
3561 /** CLI command to show various unix error statistics. */
3562 static clib_error_t *
3563 unix_show_files (vlib_main_t * vm,
3564 unformat_input_t * input, vlib_cli_command_t * cmd)
3566 clib_error_t *error = 0;
3567 clib_file_main_t *fm = &file_main;
3569 char path[PATH_MAX];
3572 vlib_cli_output (vm, "%3s %6s %12s %12s %12s %-32s %s", "FD", "Thread",
3573 "Read", "Write", "Error", "File Name", "Description");
3576 pool_foreach (f, fm->file_pool)
3579 s = format (s, "/proc/self/fd/%d%c", f->file_descriptor, 0);
3580 rv = readlink((char *) s, path, PATH_MAX - 1);
3582 path[rv < 0 ? 0 : rv] = 0;
3584 vlib_cli_output (vm, "%3d %6d %12d %12d %12d %-32s %v",
3585 f->file_descriptor, f->polling_thread_index,
3586 f->read_events, f->write_events, f->error_events,
3587 path, f->description);
3588 vec_reset_length (s);
3597 VLIB_CLI_COMMAND (cli_unix_show_files, static) = {
3598 .path = "show unix files",
3599 .short_help = "Show Unix files in use",
3600 .function = unix_show_files,
3604 /** CLI command to show session command history. */
3605 static clib_error_t *
3606 unix_cli_show_history (vlib_main_t * vm,
3607 unformat_input_t * input, vlib_cli_command_t * cmd)
3609 unix_cli_main_t *cm = &unix_cli_main;
3610 unix_cli_file_t *cf;
3613 if (!(cf = unix_cli_file_if_interactive (cm)))
3614 return clib_error_return (0, "invalid for non-interactive sessions");
3616 if (cf->has_history && cf->history_limit)
3618 i = 1 + cf->command_number - vec_len (cf->command_history);
3619 for (j = 0; j < vec_len (cf->command_history); j++)
3620 vlib_cli_output (vm, "%d %v\n", i + j, cf->command_history[j]);
3624 vlib_cli_output (vm, "History not enabled.\n");
3631 * Displays the command history for the current session, if any.
3634 VLIB_CLI_COMMAND (cli_unix_cli_show_history, static) = {
3636 .short_help = "Show current session command history",
3637 .function = unix_cli_show_history,
3641 /** CLI command to show terminal status. */
3642 static clib_error_t *
3643 unix_cli_show_terminal (vlib_main_t * vm,
3644 unformat_input_t * input, vlib_cli_command_t * cmd)
3646 unix_main_t *um = &unix_main;
3647 unix_cli_main_t *cm = &unix_cli_main;
3648 unix_cli_file_t *cf;
3651 if (!(cf = unix_cli_file_if_exists (cm)))
3652 return clib_error_return (0, "invalid session");
3654 n = vlib_get_node (vm, cf->process_node_index);
3656 vlib_cli_output (vm, "Terminal name: %v\n", n->name);
3657 vlib_cli_output (vm, "Terminal mode: %s\n", cf->line_mode ?
3658 "line-by-line" : "char-by-char");
3659 vlib_cli_output (vm, "Terminal width: %d\n", cf->width);
3660 vlib_cli_output (vm, "Terminal height: %d\n", cf->height);
3661 vlib_cli_output (vm, "ANSI capable: %s\n",
3662 cf->ansi_capable ? "yes" : "no");
3663 vlib_cli_output (vm, "Interactive: %s\n",
3664 cf->is_interactive ? "yes" : "no");
3665 vlib_cli_output (vm, "History enabled: %s%s\n",
3666 cf->has_history ? "yes" : "no", !cf->has_history
3667 || cf->history_limit ? "" :
3668 " (disabled by history limit)");
3669 if (cf->has_history)
3670 vlib_cli_output (vm, "History limit: %d\n", cf->history_limit);
3671 vlib_cli_output (vm, "Pager enabled: %s%s%s\n",
3672 cf->no_pager ? "no" : "yes",
3674 || cf->height ? "" : " (disabled by terminal height)",
3676 || um->cli_pager_buffer_limit ? "" :
3677 " (disabled by buffer limit)");
3679 vlib_cli_output (vm, "Pager limit: %d\n", um->cli_pager_buffer_limit);
3680 vlib_cli_output (vm, "CRLF mode: %s\n",
3681 cf->crlf_mode ? "CR+LF" : "LF");
3687 * Displays various information about the state of the current terminal
3691 * @cliexstart{show terminal}
3692 * Terminal name: unix-cli-stdin
3693 * Terminal mode: char-by-char
3694 * Terminal width: 123
3695 * Terminal height: 48
3698 * History enabled: yes
3700 * Pager enabled: yes
3701 * Pager limit: 100000
3706 VLIB_CLI_COMMAND (cli_unix_cli_show_terminal, static) = {
3707 .path = "show terminal",
3708 .short_help = "Show current session terminal settings",
3709 .function = unix_cli_show_terminal,
3713 /** CLI command to display a list of CLI sessions. */
3714 static clib_error_t *
3715 unix_cli_show_cli_sessions (vlib_main_t * vm,
3716 unformat_input_t * input,
3717 vlib_cli_command_t * cmd)
3719 unix_cli_main_t *cm = &unix_cli_main;
3720 clib_file_main_t *fm = &file_main;
3721 unix_cli_file_t *cf;
3725 vlib_cli_output (vm, "%-5s %-5s %-20s %s", "PNI", "FD", "Name", "Flags");
3727 #define fl(x, y) ( (x) ? toupper((y)) : tolower((y)) )
3729 pool_foreach (cf, cm->cli_file_pool) {
3730 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3731 n = vlib_get_node (vm, cf->process_node_index);
3732 vlib_cli_output (vm,
3733 "%-5d %-5d %-20v %c%c%c%c%c\n",
3734 cf->process_node_index,
3735 uf->file_descriptor,
3737 fl (cf->is_interactive, 'i'),
3738 fl (cf->is_socket, 's'),
3739 fl (cf->line_mode, 'l'),
3740 fl (cf->has_epipe, 'p'),
3741 fl (cf->ansi_capable, 'a'));
3750 * Displays a summary of all the current CLI sessions.
3752 * Typically used to diagnose connection issues with the CLI
3756 * @cliexstart{show cli-sessions}
3758 * 343 0 unix-cli-stdin IslpA
3759 * 344 7 unix-cli-local:20 ISlpA
3760 * 346 8 unix-cli-local:21 iSLpa
3763 * In this example we have the debug console of the running process
3764 * on stdin/out, we have an interactive socket session and we also
3765 * have a non-interactive socket session.
3769 * - @em PNI: Process node index.
3770 * - @em FD: Unix file descriptor.
3771 * - @em Name: Name of the session.
3772 * - @em Flags: Various flags that describe the state of the session.
3774 * @em Flags have the following meanings; lower-case typically negates
3777 * - @em I Interactive session.
3778 * - @em S Connected by socket.
3779 * - @em s Not a socket, likely stdin.
3780 * - @em L Line-by-line mode.
3781 * - @em l Char-by-char mode.
3782 * - @em P EPIPE detected on connection; it will close soon.
3783 * - @em A ANSI-capable terminal.
3786 VLIB_CLI_COMMAND (cli_unix_cli_show_cli_sessions, static) = {
3787 .path = "show cli-sessions",
3788 .short_help = "Show current CLI sessions",
3789 .function = unix_cli_show_cli_sessions,
3793 /** CLI command to set terminal pager settings. */
3794 static clib_error_t *
3795 unix_cli_set_terminal_pager (vlib_main_t * vm,
3796 unformat_input_t * input,
3797 vlib_cli_command_t * cmd)
3799 unix_main_t *um = &unix_main;
3800 unix_cli_main_t *cm = &unix_cli_main;
3801 unix_cli_file_t *cf;
3802 unformat_input_t _line_input, *line_input = &_line_input;
3803 clib_error_t *error = 0;
3805 if (!(cf = unix_cli_file_if_interactive (cm)))
3806 return clib_error_return (0, "invalid for non-interactive sessions");
3808 if (!unformat_user (input, unformat_line_input, line_input))
3811 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3813 if (unformat (line_input, "on"))
3815 else if (unformat (line_input, "off"))
3817 else if (unformat (line_input, "limit %u", &um->cli_pager_buffer_limit))
3818 vlib_cli_output (vm,
3819 "Pager limit set to %u lines; note, this is global.\n",
3820 um->cli_pager_buffer_limit);
3823 error = clib_error_return (0, "unknown parameter: `%U`",
3824 format_unformat_error, line_input);
3830 unformat_free (line_input);
3836 * Enables or disables the terminal pager for this session. Generally
3837 * this defaults to enabled.
3839 * Additionally allows the pager buffer size to be set; though note that
3840 * this value is set globally and not per session.
3843 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager, static) = {
3844 .path = "set terminal pager",
3845 .short_help = "set terminal pager [on|off] [limit <lines>]",
3846 .function = unix_cli_set_terminal_pager,
3850 /** CLI command to set terminal history settings. */
3851 static clib_error_t *
3852 unix_cli_set_terminal_history (vlib_main_t * vm,
3853 unformat_input_t * input,
3854 vlib_cli_command_t * cmd)
3856 unix_cli_main_t *cm = &unix_cli_main;
3857 unix_cli_file_t *cf;
3858 unformat_input_t _line_input, *line_input = &_line_input;
3860 clib_error_t *error = 0;
3862 if (!(cf = unix_cli_file_if_interactive (cm)))
3863 return clib_error_return (0, "invalid for non-interactive sessions");
3865 if (!unformat_user (input, unformat_line_input, line_input))
3868 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3870 if (unformat (line_input, "on"))
3871 cf->has_history = 1;
3872 else if (unformat (line_input, "off"))
3873 cf->has_history = 0;
3874 else if (unformat (line_input, "limit %u", &cf->history_limit))
3878 error = clib_error_return (0, "unknown parameter: `%U`",
3879 format_unformat_error, line_input);
3885 /* If we reduced history size, or turned it off, purge the history */
3886 limit = cf->has_history ? cf->history_limit : 0;
3887 if (limit < vec_len (cf->command_history))
3891 /* How many items to remove from the start of history */
3892 limit = vec_len (cf->command_history) - limit;
3894 for (i = 0; i < limit; i++)
3895 vec_free (cf->command_history[i]);
3897 vec_delete (cf->command_history, limit, 0);
3901 unformat_free (line_input);
3907 * Enables or disables the command history function of the current
3908 * terminal. Generally this defaults to enabled.
3910 * This command also allows the maximum size of the history buffer for
3911 * this session to be altered.
3914 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history, static) = {
3915 .path = "set terminal history",
3916 .short_help = "set terminal history [on|off] [limit <lines>]",
3917 .function = unix_cli_set_terminal_history,
3921 /** CLI command to set terminal ANSI settings. */
3922 static clib_error_t *
3923 unix_cli_set_terminal_ansi (vlib_main_t * vm,
3924 unformat_input_t * input,
3925 vlib_cli_command_t * cmd)
3927 unix_cli_main_t *cm = &unix_cli_main;
3928 unix_cli_file_t *cf;
3930 if (!(cf = unix_cli_file_if_interactive (cm)))
3931 return clib_error_return (0, "invalid for non-interactive sessions");
3933 if (unformat (input, "on"))
3934 cf->ansi_capable = 1;
3935 else if (unformat (input, "off"))
3936 cf->ansi_capable = 0;
3938 return clib_error_return (0, "unknown parameter: `%U`",
3939 format_unformat_error, input);
3945 * Enables or disables the use of ANSI control sequences by this terminal.
3946 * The default will vary based on terminal detection at the start of the
3949 * ANSI control sequences are used in a small number of places to provide,
3950 * for example, color text output and to control the cursor in the pager.
3953 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi, static) = {
3954 .path = "set terminal ansi",
3955 .short_help = "set terminal ansi [on|off]",
3956 .function = unix_cli_set_terminal_ansi,
3961 #define MAX_CLI_WAIT 86400
3962 /** CLI command to wait <sec> seconds. Useful for exec script. */
3963 static clib_error_t *
3964 unix_wait_cmd (vlib_main_t * vm,
3965 unformat_input_t * input, vlib_cli_command_t * cmd)
3967 unformat_input_t _line_input, *line_input = &_line_input;
3970 if (!unformat_user (input, unformat_line_input, line_input))
3973 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3975 if (unformat (line_input, "%f", &sec))
3978 return clib_error_return (0, "unknown parameter: `%U`",
3979 format_unformat_error, input);
3982 if (sec <= 0 || sec > MAX_CLI_WAIT || floor (sec * 1000) / 1000 != sec)
3983 return clib_error_return (0,
3984 "<sec> must be a positive value and less than 86400 (one day) with no more than msec precision.");
3986 vlib_process_wait_for_event_or_clock (vm, sec);
3987 vlib_cli_output (vm, "waited %.3f sec.", sec);
3989 unformat_free (line_input);
3993 VLIB_CLI_COMMAND (cli_unix_wait_cmd, static) = {
3995 .short_help = "wait <sec>",
3996 .function = unix_wait_cmd,
4000 static clib_error_t *
4001 echo_cmd (vlib_main_t * vm,
4002 unformat_input_t * input, vlib_cli_command_t * cmd)
4004 unformat_input_t _line_input, *line_input = &_line_input;
4006 /* Get a line of input. */
4007 if (!unformat_user (input, unformat_line_input, line_input))
4009 vlib_cli_output (vm, "");
4013 vlib_cli_output (vm, "%v", line_input->buffer);
4015 unformat_free (line_input);
4020 VLIB_CLI_COMMAND (cli_unix_echo_cmd, static) = {
4022 .short_help = "echo <rest-of-line>",
4023 .function = echo_cmd,
4027 static clib_error_t *
4028 define_cmd_fn (vlib_main_t * vm,
4029 unformat_input_t * input, vlib_cli_command_t * cmd)
4032 unformat_input_t _line_input, *line_input = &_line_input;
4033 clib_macro_main_t *mm = get_macro_main ();
4034 clib_error_t *error;
4036 if (!unformat (input, "%s", ¯o_name))
4037 return clib_error_return (0, "missing variable name...");
4039 /* Remove white space */
4040 (void) unformat (input, "");
4042 /* Get a line of input. */
4043 if (!unformat_user (input, unformat_line_input, line_input))
4045 error = clib_error_return (0, "missing value for '%s'...", macro_name);
4046 vec_free (macro_name);
4049 /* the macro expander expects c-strings, not vectors... */
4050 vec_add1 (line_input->buffer, 0);
4051 clib_macro_set_value (mm, (char *) macro_name, (char *) line_input->buffer);
4052 vec_free (macro_name);
4053 unformat_free (line_input);
4058 VLIB_CLI_COMMAND (define_cmd, static) = {
4060 .short_help = "define <variable-name> <value>",
4061 .function = define_cmd_fn,
4066 static clib_error_t *
4067 undefine_cmd_fn (vlib_main_t * vm,
4068 unformat_input_t * input, vlib_cli_command_t * cmd)
4071 clib_macro_main_t *mm = get_macro_main ();
4073 if (!unformat (input, "%s", ¯o_name))
4074 return clib_error_return (0, "missing variable name...");
4076 if (clib_macro_unset (mm, (char *) macro_name))
4077 vlib_cli_output (vm, "%s wasn't set...", macro_name);
4079 vec_free (macro_name);
4084 VLIB_CLI_COMMAND (undefine_cmd, static) = {
4086 .short_help = "undefine <variable-name>",
4087 .function = undefine_cmd_fn,
4091 static clib_error_t *
4092 show_macro_cmd_fn (vlib_main_t * vm,
4093 unformat_input_t * input, vlib_cli_command_t * cmd)
4095 clib_macro_main_t *mm = get_macro_main ();
4098 if (unformat (input, "noevaluate %=", &evaluate, 0))
4100 else if (unformat (input, "noeval %=", &evaluate, 0))
4103 vlib_cli_output (vm, "%U", format_clib_macro_main, mm, evaluate);
4108 VLIB_CLI_COMMAND (show_macro, static) = {
4109 .path = "show macro",
4110 .short_help = "show macro [noevaluate]",
4111 .function = show_macro_cmd_fn,
4115 static clib_error_t *
4116 unix_cli_init (vlib_main_t * vm)
4118 unix_cli_main_t *cm = &unix_cli_main;
4120 /* Breadcrumb to indicate the new session process
4121 * has not been started */
4122 cm->new_session_process_node_index = ~0;
4123 clib_macro_init (&cm->macro_main);
4128 VLIB_INIT_FUNCTION (unix_cli_init);
4131 * fd.io coding-style-patch-verification: ON
4134 * eval: (c-set-style "gnu")