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 /* Check the connection didn't close already */
1316 if (pool_is_free_index (cm->cli_file_pool, event_data[0]))
1319 ns.cf_index = event_data[0];
1320 ns.deadline = vlib_time_now (vm) + 1.0;
1322 vec_add1 (cm->new_sessions, ns);
1325 wait = 0.1; /* force a re-evaluation soon, but not too soon */
1330 clib_warning ("BUG: unknown event type 0x%wx", event_type);
1334 vec_reset_length (event_data);
1336 if (vlib_process_suspend_time_is_zero (wait))
1338 /* Scan the list looking for expired deadlines.
1339 * Emit needed prompts and remove from the list.
1340 * While scanning, look for the nearest new deadline
1341 * for the next iteration.
1342 * Since the list is ordered with newest sessions first
1343 * we can make assumptions about expired sessions being
1344 * contiguous at the beginning and the next deadline is the
1345 * next entry on the list, if any.
1347 f64 now = vlib_time_now (vm);
1348 unix_cli_new_session_t *nsp;
1353 vec_foreach (nsp, cm->new_sessions)
1355 if (vlib_process_suspend_time_is_zero (nsp->deadline - now))
1357 /* Deadline reached */
1358 unix_cli_file_t *cf;
1360 /* Mark the highwater */
1363 /* Check the connection didn't close already */
1364 if (pool_is_free_index (cm->cli_file_pool, nsp->cf_index))
1367 cf = pool_elt_at_index (cm->cli_file_pool, nsp->cf_index);
1370 unix_cli_file_welcome (cm, cf);
1374 wait = nsp->deadline - now;
1381 /* We have sessions to remove */
1382 vec_delete (cm->new_sessions, index, 0);
1391 /** @brief A mostly no-op Telnet state machine.
1392 * Process Telnet command bytes in a way that ensures we're mostly
1393 * transparent to the Telnet protocol. That is, it's mostly a no-op.
1395 * @return -1 if we need more bytes, otherwise a positive integer number of
1396 * bytes to consume from the input_vector, not including the initial
1400 unix_cli_process_telnet (unix_main_t * um,
1401 unix_cli_file_t * cf,
1402 clib_file_t * uf, u8 * input_vector, uword len)
1404 /* Input_vector starts at IAC byte.
1405 * See if we have a complete message; if not, return -1 so we wait for more.
1406 * if we have a complete message, consume those bytes from the vector.
1411 return -1; /* want more bytes */
1413 switch (input_vector[1])
1416 /* two IAC's in a row means to pass through 0xff.
1417 * since that makes no sense here, just consume it.
1426 /* Expect 3 bytes */
1428 return -1; /* want more bytes */
1435 /* Sub option - search ahead for IAC SE to end it */
1437 for (i = 3; i < len && i < UNIX_CLI_MAX_DEPTH_TELNET; i++)
1439 if (input_vector[i - 1] == IAC && input_vector[i] == SE)
1441 /* We have a complete message; see if we care about it */
1442 switch (input_vector[2])
1445 if (input_vector[3] != 0)
1448 /* See if the the terminal type is recognized */
1449 u8 *term = input_vector + 4;
1452 /* See if the terminal type is ANSI capable */
1454 unix_cli_terminal_type_ansi (term, len);
1456 /* See if the terminal type indicates non-interactive */
1457 if (unix_cli_terminal_type_noninteractive (term, len))
1458 unix_cli_set_session_noninteractive (cf);
1461 /* If session not started, we can release the pause */
1463 /* Send the welcome banner and initial prompt */
1464 unix_cli_file_welcome (&unix_cli_main, cf);
1469 if (i != 8) /* check message is correct size */
1473 clib_net_to_host_u16 (*((u16 *) (input_vector + 3)));
1474 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
1475 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
1477 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
1480 clib_net_to_host_u16 (*((u16 *) (input_vector + 5)));
1481 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
1482 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
1483 if (cf->height == 0)
1484 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
1486 /* reindex pager buffer */
1487 unix_cli_pager_reindex (cf);
1489 unix_cli_pager_redraw (cf, uf);
1495 /* Consume it all */
1501 if (i == UNIX_CLI_MAX_DEPTH_TELNET)
1502 consume = 1; /* hit max search depth, advance one byte */
1505 return -1; /* want more bytes */
1523 /* Simple one-byte messages */
1528 /* Are You There - trigger a visible response */
1530 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "fd.io VPP\n", 10);
1534 /* Unknown command! Eat the IAC byte */
1541 /** @brief Process actionable input.
1542 * Based on the \c action process the input; this typically involves
1543 * searching the command history or editing the current command line.
1546 unix_cli_line_process_one (unix_cli_main_t * cm,
1548 unix_cli_file_t * cf,
1550 u8 input, unix_cli_parse_action_t action)
1554 u8 **possible_commands;
1559 case UNIX_CLI_PARSE_ACTION_NOACTION:
1562 case UNIX_CLI_PARSE_ACTION_REVSEARCH:
1563 case UNIX_CLI_PARSE_ACTION_FWDSEARCH:
1564 if (!cf->has_history || !cf->history_limit)
1566 if (cf->search_mode == 0)
1568 /* Erase the current command (if any) */
1569 for (; cf->cursor > 0; cf->cursor--)
1571 unix_vlib_cli_output_cursor_left (cf, uf);
1572 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1573 unix_vlib_cli_output_cursor_left (cf, uf);
1576 vec_reset_length (cf->search_key);
1577 vec_reset_length (cf->current_command);
1579 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1580 cf->search_mode = -1;
1582 cf->search_mode = 1;
1586 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1587 cf->search_mode = -1;
1589 cf->search_mode = 1;
1591 cf->excursion += cf->search_mode;
1596 case UNIX_CLI_PARSE_ACTION_ERASELINELEFT:
1597 /* Erase the command from the cursor to the start */
1600 /* Shimmy backwards to the new end of line position */
1601 delta = vec_len (cf->current_command) - cf->cursor;
1602 for (; cf->cursor > delta; cf->cursor--)
1603 unix_vlib_cli_output_cursor_left (cf, uf);
1604 /* Zap from here to the end of what is currently displayed */
1605 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1606 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1607 /* Get back to the start of the line */
1608 for (; cf->cursor > 0; cf->cursor--)
1609 unix_vlib_cli_output_cursor_left (cf, uf);
1611 /* Delete the desired text from the command */
1612 memmove (cf->current_command, cf->current_command + j, delta);
1613 vec_set_len (cf->current_command, delta);
1615 /* Print the new contents */
1616 unix_vlib_cli_output_cooked (cf, uf, cf->current_command, delta);
1617 cf->cursor = delta; /* for backspace tracking */
1619 /* Shimmy back to the start */
1620 for (; cf->cursor > 0; cf->cursor--)
1621 unix_vlib_cli_output_cursor_left (cf, uf);
1623 cf->search_mode = 0;
1626 case UNIX_CLI_PARSE_ACTION_ERASELINERIGHT:
1627 /* Erase the command from the cursor to the end */
1630 /* Zap from cursor to end of what is currently displayed */
1631 for (; cf->cursor < (vec_len (cf->current_command)); cf->cursor++)
1632 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1633 /* Get back to where we were */
1634 for (; cf->cursor > j; cf->cursor--)
1635 unix_vlib_cli_output_cursor_left (cf, uf);
1637 /* Truncate the line at the cursor */
1638 vec_set_len (cf->current_command, cf->cursor);
1640 cf->search_mode = 0;
1643 case UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT:
1644 /* calculate num of caracter to be erased */
1646 while (cf->cursor > delta
1647 && cf->current_command[cf->cursor - delta - 1] == ' ')
1649 while (cf->cursor > delta
1650 && cf->current_command[cf->cursor - delta - 1] != ' ')
1653 if (vec_len (cf->current_command))
1657 /* move cursor left delta times */
1658 for (j = delta; j > 0; j--, cf->cursor--)
1659 unix_vlib_cli_output_cursor_left (cf, uf);
1660 save = cf->current_command + cf->cursor;
1662 /* redraw remainder of line */
1663 memmove (cf->current_command + cf->cursor,
1664 cf->current_command + cf->cursor + delta,
1665 _vec_len (cf->current_command) - cf->cursor - delta);
1666 unix_vlib_cli_output_cooked (cf, uf,
1667 cf->current_command + cf->cursor,
1668 _vec_len (cf->current_command) -
1670 cf->cursor += _vec_len (cf->current_command) - cf->cursor;
1672 /* print delta amount of blank spaces,
1673 * then finally fix the cursor position */
1674 for (j = delta; j > 0; j--, cf->cursor--)
1675 unix_vlib_cli_output_cursor_left (cf, uf);
1676 for (j = delta; j > 0; j--, cf->cursor++)
1677 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1678 for (; (cf->current_command + cf->cursor) > save; cf->cursor--)
1679 unix_vlib_cli_output_cursor_left (cf, uf);
1680 vec_dec_len (cf->current_command, delta);
1683 cf->search_mode = 0;
1685 vec_reset_length (cf->search_key);
1688 case UNIX_CLI_PARSE_ACTION_LEFT:
1691 unix_vlib_cli_output_cursor_left (cf, uf);
1695 cf->search_mode = 0;
1698 case UNIX_CLI_PARSE_ACTION_RIGHT:
1699 if (cf->cursor < vec_len (cf->current_command))
1701 /* have to emit the character under the cursor */
1702 unix_vlib_cli_output_cooked (cf, uf,
1703 cf->current_command + cf->cursor, 1);
1707 cf->search_mode = 0;
1710 case UNIX_CLI_PARSE_ACTION_UP:
1711 case UNIX_CLI_PARSE_ACTION_DOWN:
1712 if (!cf->has_history || !cf->history_limit)
1714 cf->search_mode = 0;
1715 /* Erase the command */
1716 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1717 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1718 for (; cf->cursor > 0; cf->cursor--)
1720 unix_vlib_cli_output_cursor_left (cf, uf);
1721 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1722 unix_vlib_cli_output_cursor_left (cf, uf);
1724 vec_reset_length (cf->current_command);
1725 if (vec_len (cf->command_history))
1727 if (action == UNIX_CLI_PARSE_ACTION_UP)
1732 cf->excursion += delta;
1734 if (cf->excursion == vec_len (cf->command_history))
1736 /* down-arrowed to last entry - want a blank line */
1737 vec_set_len (cf->current_command, 0);
1739 else if (cf->excursion < 0)
1741 /* up-arrowed over the start to the end, want a blank line */
1742 cf->excursion = vec_len (cf->command_history);
1743 vec_set_len (cf->current_command, 0);
1747 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1748 /* down-arrowed past end - wrap to start */
1751 /* Print the command at the current position */
1752 prev = cf->command_history[cf->excursion];
1753 vec_validate (cf->current_command, vec_len (prev) - 1);
1755 clib_memcpy (cf->current_command, prev, vec_len (prev));
1756 vec_set_len (cf->current_command, vec_len (prev));
1757 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1758 vec_len (cf->current_command));
1761 cf->cursor = vec_len (cf->current_command);
1764 case UNIX_CLI_PARSE_ACTION_HOME:
1765 if (vec_len (cf->current_command) && cf->cursor > 0)
1767 for (; cf->cursor > 0; cf->cursor--)
1768 unix_vlib_cli_output_cursor_left (cf, uf);
1771 cf->search_mode = 0;
1774 case UNIX_CLI_PARSE_ACTION_END:
1775 if (vec_len (cf->current_command) &&
1776 cf->cursor < vec_len (cf->current_command))
1778 unix_vlib_cli_output_cooked (cf, uf,
1779 cf->current_command + cf->cursor,
1780 vec_len (cf->current_command) -
1782 cf->cursor = vec_len (cf->current_command);
1785 cf->search_mode = 0;
1788 case UNIX_CLI_PARSE_ACTION_WORDLEFT:
1789 if (vec_len (cf->current_command) && cf->cursor > 0)
1791 unix_vlib_cli_output_cursor_left (cf, uf);
1794 while (cf->cursor && isspace (cf->current_command[cf->cursor]))
1796 unix_vlib_cli_output_cursor_left (cf, uf);
1799 while (cf->cursor && !isspace (cf->current_command[cf->cursor]))
1801 if (isspace (cf->current_command[cf->cursor - 1]))
1803 unix_vlib_cli_output_cursor_left (cf, uf);
1809 cf->search_mode = 0;
1812 case UNIX_CLI_PARSE_ACTION_WORDRIGHT:
1813 if (vec_len (cf->current_command) &&
1814 cf->cursor < vec_len (cf->current_command))
1816 int e = vec_len (cf->current_command);
1818 while (j < e && !isspace (cf->current_command[j]))
1820 while (j < e && isspace (cf->current_command[j]))
1822 unix_vlib_cli_output_cooked (cf, uf,
1823 cf->current_command + cf->cursor,
1828 cf->search_mode = 0;
1832 case UNIX_CLI_PARSE_ACTION_ERASE:
1833 if (vec_len (cf->current_command))
1835 if (cf->cursor == vec_len (cf->current_command))
1837 unix_vlib_cli_output_cursor_left (cf, uf);
1839 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1841 unix_vlib_cli_output_cursor_left (cf, uf);
1843 vec_dec_len (cf->current_command, 1);
1845 else if (cf->cursor > 0)
1847 /* shift everything at & to the right of the cursor left by 1 */
1848 j = vec_len (cf->current_command) - cf->cursor;
1849 memmove (cf->current_command + cf->cursor - 1,
1850 cf->current_command + cf->cursor, j);
1851 vec_dec_len (cf->current_command, 1);
1853 /* redraw the rest of the line */
1854 unix_vlib_cli_output_cursor_left (cf, uf);
1856 unix_vlib_cli_output_cooked (cf, uf,
1857 cf->current_command + cf->cursor,
1860 /* erase last char */
1861 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1864 /* and shift the terminal cursor back where it should be */
1865 j += 2; /* account for old string length and offset position */
1868 unix_vlib_cli_output_cursor_left (cf, uf);
1873 cf->search_mode = 0;
1875 vec_reset_length (cf->search_key);
1878 case UNIX_CLI_PARSE_ACTION_ERASERIGHT:
1879 if (vec_len (cf->current_command))
1881 if (cf->cursor < vec_len (cf->current_command))
1883 /* shift everything to the right of the cursor left by 1 */
1884 j = vec_len (cf->current_command) - cf->cursor - 1;
1885 memmove (cf->current_command + cf->cursor,
1886 cf->current_command + cf->cursor + 1, j);
1887 vec_dec_len (cf->current_command, 1);
1888 /* redraw the rest of the line */
1889 unix_vlib_cli_output_cooked (cf, uf,
1890 cf->current_command + cf->cursor,
1893 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1895 unix_vlib_cli_output_cursor_left (cf, uf);
1897 /* and shift the terminal cursor back where it should be */
1900 unix_vlib_cli_output_cursor_left (cf, uf);
1904 unix_vlib_cli_output_cursor_left (cf, uf);
1910 else if (input == 'D' - '@')
1912 /* ^D with no command entered = quit */
1913 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "quit\n", 5);
1914 vlib_process_signal_event (um->vlib_main,
1915 vlib_current_process (um->vlib_main),
1916 UNIX_CLI_PROCESS_EVENT_QUIT,
1917 cf - cm->cli_file_pool);
1919 cf->search_mode = 0;
1921 vec_reset_length (cf->search_key);
1924 case UNIX_CLI_PARSE_ACTION_CLEAR:
1925 /* If we're in ANSI mode, clear the screen.
1926 * Then redraw the prompt and any existing command input, then put
1927 * the cursor back where it was in that line.
1929 if (cf->ansi_capable)
1930 unix_vlib_cli_output_cooked (cf, uf,
1932 sizeof (ANSI_CLEAR) - 1);
1934 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1936 unix_vlib_cli_output_raw (cf, uf,
1937 cm->cli_prompt, vec_len (cm->cli_prompt));
1938 unix_vlib_cli_output_cooked (cf, uf,
1939 cf->current_command,
1940 vec_len (cf->current_command));
1942 cf->cursor = vec_len (cf->current_command);
1943 for (; cf->cursor > j; cf->cursor--)
1944 unix_vlib_cli_output_cursor_left (cf, uf);
1948 case UNIX_CLI_PARSE_ACTION_TAB:
1949 if (cf->cursor < vec_len (cf->current_command))
1951 /* if we are in the middle of a line, complete only if
1952 * the cursor points to whitespace */
1953 if (isspace (cf->current_command[cf->cursor]))
1955 /* save and clear any input that is after the cursor */
1956 vec_resize (save, vec_len (cf->current_command) - cf->cursor);
1957 clib_memcpy (save, cf->current_command + cf->cursor,
1958 vec_len (cf->current_command) - cf->cursor);
1959 vec_set_len (cf->current_command, cf->cursor);
1963 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1968 vlib_cli_get_possible_completions (cf->current_command);
1969 if (vec_len (possible_commands) == 1)
1971 u8 *completed = possible_commands[0];
1974 /* find the last word of current_command */
1975 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1977 unix_vlib_cli_output_cursor_left (cf, uf);
1981 vec_set_len (cf->current_command, j);
1983 /* replace it with the newly expanded command */
1984 vec_append (cf->current_command, completed);
1986 /* echo to the terminal */
1987 unix_vlib_cli_output_cooked (cf, uf, completed,
1988 vec_len (completed));
1990 /* add one trailing space if needed */
1991 if (vec_len (save) == 0)
1993 vec_add1 (cf->current_command, ' ');
1994 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1997 cf->cursor = vec_len (cf->current_command);
2000 else if (vec_len (possible_commands) >= 2)
2002 u8 **possible_command;
2003 uword max_command_len = 0, min_command_len = ~0;
2006 vec_foreach (possible_command, possible_commands)
2008 if (vec_len (*possible_command) > max_command_len)
2009 max_command_len = vec_len (*possible_command);
2010 if (vec_len (*possible_command) < min_command_len)
2011 min_command_len = vec_len (*possible_command);
2014 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2017 vec_foreach (possible_command, possible_commands)
2019 if (i + max_command_len >= cf->width)
2021 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2024 unix_vlib_cli_output_cooked (cf, uf, *possible_command,
2025 vec_len (*possible_command));
2026 for (j = vec_len (*possible_command); j < max_command_len + 2;
2029 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2031 i += max_command_len + 2;
2034 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2036 /* rewrite prompt */
2037 unix_cli_cli_prompt (cf, uf);
2038 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2039 vec_len (cf->current_command));
2041 /* count length of last word */
2044 while (j >= 1 && !isspace (cf->current_command[j - 1]))
2050 /* determine smallest common command */
2051 for (; i < min_command_len; i++)
2056 vec_foreach (possible_command, possible_commands)
2060 common = (*possible_command)[i];
2062 else if (common != (*possible_command)[i])
2071 vec_add1 (cf->current_command, common);
2073 unix_vlib_cli_output_cooked (cf, uf, (u8 *) & common, 1);
2083 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
2086 if (vec_len (save) > 0)
2088 /* restore remaining input if tab was hit in the middle of a line */
2089 unix_vlib_cli_output_cooked (cf, uf, save, vec_len (save));
2090 cf->cursor += vec_len (save);
2091 for (j = 0; j < vec_len (save); j++, cf->cursor--)
2092 unix_vlib_cli_output_cursor_left (cf, uf);
2093 vec_append (cf->current_command, save);
2096 vec_free (possible_commands);
2099 case UNIX_CLI_PARSE_ACTION_YANK:
2104 case UNIX_CLI_PARSE_ACTION_PAGER_QUIT:
2106 unix_cli_pager_prompt_erase (cf, uf);
2107 unix_cli_pager_reset (cf);
2108 unix_cli_cli_prompt (cf, uf);
2111 case UNIX_CLI_PARSE_ACTION_PAGER_NEXT:
2112 case UNIX_CLI_PARSE_ACTION_PAGER_PGDN:
2113 /* show next page of the buffer */
2114 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
2117 unix_cli_pager_index_t *pi = NULL;
2119 int m = cf->pager_start + (cf->height - 1);
2120 unix_cli_pager_prompt_erase (cf, uf);
2122 j < vec_len (cf->pager_index) && cf->pager_start < m;
2123 j++, cf->pager_start++)
2125 pi = &cf->pager_index[j];
2126 line = cf->pager_vector[pi->line] + pi->offset;
2127 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2129 /* if the last line didn't end in newline, add a newline */
2130 if (pi && line[pi->length - 1] != '\n')
2131 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2132 unix_cli_pager_prompt (cf, uf);
2136 if (action == UNIX_CLI_PARSE_ACTION_PAGER_NEXT)
2137 /* no more in buffer, exit, but only if it was <space> */
2142 case UNIX_CLI_PARSE_ACTION_PAGER_DN:
2143 case UNIX_CLI_PARSE_ACTION_PAGER_CRLF:
2144 /* display the next line of the buffer */
2145 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
2148 unix_cli_pager_index_t *pi;
2150 unix_cli_pager_prompt_erase (cf, uf);
2151 pi = &cf->pager_index[cf->pager_start + (cf->height - 1)];
2152 line = cf->pager_vector[pi->line] + pi->offset;
2153 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2155 /* if the last line didn't end in newline, add a newline */
2156 if (line[pi->length - 1] != '\n')
2157 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2158 unix_cli_pager_prompt (cf, uf);
2162 if (action == UNIX_CLI_PARSE_ACTION_PAGER_CRLF)
2163 /* no more in buffer, exit, but only if it was <enter> */
2169 case UNIX_CLI_PARSE_ACTION_PAGER_UP:
2170 /* scroll the page back one line */
2171 if (cf->pager_start > 0)
2174 unix_cli_pager_index_t *pi = NULL;
2177 if (cf->ansi_capable)
2179 pi = &cf->pager_index[cf->pager_start];
2180 line = cf->pager_vector[pi->line] + pi->offset;
2181 unix_cli_pager_prompt_erase (cf, uf);
2182 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SCROLLDN,
2183 sizeof (ANSI_SCROLLDN) - 1);
2184 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SAVECURSOR,
2185 sizeof (ANSI_SAVECURSOR) - 1);
2186 unix_cli_ansi_cursor (cf, uf, 1, 1);
2187 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_CLEARLINE,
2188 sizeof (ANSI_CLEARLINE) - 1);
2189 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2190 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_RESTCURSOR,
2191 sizeof (ANSI_RESTCURSOR) - 1);
2192 unix_cli_pager_prompt_erase (cf, uf);
2193 unix_cli_pager_prompt (cf, uf);
2197 int m = cf->pager_start + (cf->height - 1);
2198 unix_cli_pager_prompt_erase (cf, uf);
2199 for (j = cf->pager_start;
2200 j < vec_len (cf->pager_index) && j < m; j++)
2202 pi = &cf->pager_index[j];
2203 line = cf->pager_vector[pi->line] + pi->offset;
2204 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2206 /* if the last line didn't end in newline, add a newline */
2207 if (pi && line[pi->length - 1] != '\n')
2208 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2209 unix_cli_pager_prompt (cf, uf);
2214 case UNIX_CLI_PARSE_ACTION_PAGER_TOP:
2215 /* back to the first page of the buffer */
2216 if (cf->pager_start > 0)
2219 unix_cli_pager_index_t *pi = NULL;
2221 cf->pager_start = 0;
2222 int m = cf->pager_start + (cf->height - 1);
2223 unix_cli_pager_prompt_erase (cf, uf);
2224 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2227 pi = &cf->pager_index[j];
2228 line = cf->pager_vector[pi->line] + pi->offset;
2229 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2231 /* if the last line didn't end in newline, add a newline */
2232 if (pi && line[pi->length - 1] != '\n')
2233 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2234 unix_cli_pager_prompt (cf, uf);
2238 case UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM:
2239 /* skip to the last page of the buffer */
2240 if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
2243 unix_cli_pager_index_t *pi = NULL;
2245 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
2246 unix_cli_pager_prompt_erase (cf, uf);
2247 unix_cli_pager_message (cf, uf, "skipping", "\n");
2248 for (j = cf->pager_start; j < vec_len (cf->pager_index); j++)
2250 pi = &cf->pager_index[j];
2251 line = cf->pager_vector[pi->line] + pi->offset;
2252 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2254 /* if the last line didn't end in newline, add a newline */
2255 if (pi && line[pi->length - 1] != '\n')
2256 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2257 unix_cli_pager_prompt (cf, uf);
2261 case UNIX_CLI_PARSE_ACTION_PAGER_PGUP:
2262 /* wander back one page in the buffer */
2263 if (cf->pager_start > 0)
2266 unix_cli_pager_index_t *pi = NULL;
2269 if (cf->pager_start >= cf->height)
2270 cf->pager_start -= cf->height - 1;
2272 cf->pager_start = 0;
2273 m = cf->pager_start + cf->height - 1;
2274 unix_cli_pager_prompt_erase (cf, uf);
2275 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2278 pi = &cf->pager_index[j];
2279 line = cf->pager_vector[pi->line] + pi->offset;
2280 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2282 /* if the last line didn't end in newline, add a newline */
2283 if (pi && line[pi->length - 1] != '\n')
2284 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2285 unix_cli_pager_prompt (cf, uf);
2289 case UNIX_CLI_PARSE_ACTION_PAGER_REDRAW:
2290 /* Redraw the current pager screen */
2291 unix_cli_pager_redraw (cf, uf);
2294 case UNIX_CLI_PARSE_ACTION_PAGER_SEARCH:
2295 /* search forwards in the buffer */
2299 case UNIX_CLI_PARSE_ACTION_CRLF:
2301 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2303 if (cf->has_history && cf->history_limit)
2305 if (cf->command_history
2306 && vec_len (cf->command_history) >= cf->history_limit)
2308 vec_free (cf->command_history[0]);
2309 vec_delete (cf->command_history, 1, 0);
2311 /* Don't add blank lines to the cmd history */
2312 if (vec_len (cf->current_command))
2314 /* Don't duplicate the previous command */
2315 j = vec_len (cf->command_history);
2317 (vec_len (cf->current_command) !=
2318 vec_len (cf->command_history[j - 1])
2319 || memcmp (cf->current_command, cf->command_history[j - 1],
2320 vec_len (cf->current_command)) != 0))
2322 /* copy the command to the history */
2324 vec_append (c, cf->current_command);
2325 vec_add1 (cf->command_history, c);
2326 cf->command_number++;
2329 cf->excursion = vec_len (cf->command_history);
2332 cf->search_mode = 0;
2333 vec_reset_length (cf->search_key);
2338 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2339 case UNIX_CLI_PARSE_ACTION_NOMATCH:
2340 if (vec_len (cf->pager_index))
2344 else if (cf->has_history && cf->search_mode != 0 && isprint (input))
2346 int k, limit, offset;
2349 vec_add1 (cf->search_key, input);
2352 for (j = 0; j < vec_len (cf->command_history); j++)
2354 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
2356 else if (cf->excursion < 0)
2357 cf->excursion = vec_len (cf->command_history) - 1;
2359 item = cf->command_history[cf->excursion];
2361 limit = (vec_len (cf->search_key) > vec_len (item)) ?
2362 vec_len (item) : vec_len (cf->search_key);
2364 for (offset = 0; offset <= vec_len (item) - limit; offset++)
2366 for (k = 0; k < limit; k++)
2368 if (item[k + offset] != cf->search_key[k])
2371 goto found_at_offset;
2379 for (; cf->cursor > 0; cf->cursor--)
2381 unix_vlib_cli_output_cursor_left (cf, uf);
2382 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2383 unix_vlib_cli_output_cursor_left (cf, uf);
2386 vec_validate (cf->current_command, vec_len (item) - 1);
2387 clib_memcpy (cf->current_command, item, vec_len (item));
2388 vec_set_len (cf->current_command, vec_len (item));
2390 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2391 vec_len (cf->current_command));
2392 cf->cursor = vec_len (cf->current_command);
2396 cf->excursion += cf->search_mode;
2399 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\nNo match...", 12);
2400 vec_reset_length (cf->search_key);
2401 vec_reset_length (cf->current_command);
2402 cf->search_mode = 0;
2406 else if (isprint (input)) /* skip any errant control codes */
2408 if (cf->cursor == vec_len (cf->current_command))
2411 vec_add1 (cf->current_command, input);
2414 /* Echo the character back to the client */
2415 unix_vlib_cli_output_cooked (cf, uf, &input, 1);
2419 /* Insert at cursor: resize +1 byte, move everything over */
2420 j = vec_len (cf->current_command) - cf->cursor;
2421 vec_add1 (cf->current_command, (u8) 'A');
2422 memmove (cf->current_command + cf->cursor + 1,
2423 cf->current_command + cf->cursor, j);
2424 cf->current_command[cf->cursor] = input;
2425 /* Redraw the line */
2427 unix_vlib_cli_output_cooked (cf, uf,
2428 cf->current_command + cf->cursor,
2432 /* Put terminal cursor back */
2433 for (; j > 0; j--, cf->cursor--)
2434 unix_vlib_cli_output_cursor_left (cf, uf);
2439 /* no-op - not printable or otherwise not actionable */
2446 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2452 /** @brief Process input bytes on a stream to provide line editing and
2453 * command history in the CLI. */
2455 unix_cli_line_edit (unix_cli_main_t * cm, unix_main_t * um,
2456 clib_file_main_t * fm, unix_cli_file_t * cf)
2458 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2461 for (i = 0; i < vec_len (cf->input_vector); i++)
2463 unix_cli_parse_action_t action;
2465 unix_cli_parse_actions_t *a;
2467 /* If we're in the pager mode, search the pager actions */
2469 vec_len (cf->pager_index) ? unix_cli_parse_pager :
2470 unix_cli_parse_strings;
2472 /* See if the input buffer is some sort of control code */
2473 action = unix_cli_match_action (a, &cf->input_vector[i],
2474 vec_len (cf->input_vector) - i,
2479 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2482 /* There was a partial match which means we need more bytes
2483 * than the input buffer currently has.
2484 * Since the bytes before here have been processed, shift
2485 * the remaining contents to the start of the input buffer.
2487 vec_delete (cf->input_vector, i, 0);
2489 return 1; /* wait for more */
2491 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2492 /* process telnet options */
2493 matched = unix_cli_process_telnet (um, cf, uf,
2494 cf->input_vector + i,
2495 vec_len (cf->input_vector) - i);
2498 /* There was a partial match which means we need more bytes
2499 * than the input buffer currently has.
2504 * Since the bytes before here have been processed, shift
2505 * the remaining contents to the start of the input buffer.
2507 vec_delete (cf->input_vector, i, 0);
2509 return 1; /* wait for more */
2514 /* If telnet option processing switched us to line mode, get us
2519 vec_delete (cf->input_vector, i, 0);
2520 vec_free (cf->current_command);
2521 cf->current_command = cf->input_vector;
2525 /* process the action */
2526 if (!unix_cli_line_process_one (cm, um, cf, uf,
2527 cf->input_vector[i], action))
2529 /* CRLF found. Consume the bytes from the input_vector */
2530 vec_delete (cf->input_vector, i + matched, 0);
2531 /* And tell our caller to execute cf->input_command */
2539 vec_reset_length (cf->input_vector);
2543 /** @brief Process input to a CLI session. */
2545 unix_cli_process_input (unix_cli_main_t * cm, uword cli_file_index)
2547 unix_main_t *um = &unix_main;
2548 clib_file_main_t *fm = &file_main;
2550 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2551 unformat_input_t input;
2552 int vlib_parse_eval (u8 *);
2554 cm->current_input_file_index = cli_file_index;
2557 /* Try vlibplex first. Someday... */
2558 if (0 && vlib_parse_eval (cf->input_vector) == 0)
2564 /* just treat whatever we got as a complete line of input */
2565 cf->current_command = cf->input_vector;
2569 /* Line edit, echo, etc. */
2570 if (unix_cli_line_edit (cm, um, fm, cf))
2571 /* want more input */
2578 vec_reset_length (lv);
2579 lv = format (lv, "%U[%d]: %v",
2580 format_timeval, 0 /* current bat-time */ ,
2581 0 /* current bat-format */ ,
2582 cli_file_index, cf->current_command);
2583 if ((vec_len (cf->current_command) > 0) &&
2584 (cf->current_command[vec_len (cf->current_command) - 1] != '\n'))
2585 lv = format (lv, "\n");
2586 int rv __attribute__ ((unused)) = write (um->log_fd, lv, vec_len (lv));
2589 /* Run the command through the macro processor */
2590 if (vec_len (cf->current_command))
2593 vec_validate (cf->current_command, vec_len (cf->current_command));
2594 cf->current_command[vec_len (cf->current_command) - 1] = 0;
2595 /* The macro expander expects proper C-strings, not vectors */
2596 expanded = (u8 *) clib_macro_eval (&cf->macro_main,
2597 (i8 *) cf->current_command,
2600 8 /* max_level */ );
2601 /* Macro processor NULL terminates the return */
2602 vec_dec_len (expanded, 1);
2603 vec_reset_length (cf->current_command);
2604 vec_append (cf->current_command, expanded);
2605 vec_free (expanded);
2608 /* Build an unformat structure around our command */
2609 unformat_init_vector (&input, cf->current_command);
2611 /* Remove leading white space from input. */
2612 (void) unformat (&input, "");
2614 cf->pager_start = 0; /* start a new pager session */
2616 if (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
2617 vlib_cli_input (um->vlib_main, &input, unix_vlib_cli_output,
2620 /* Zero buffer since otherwise unformat_free will call vec_free on it. */
2623 unformat_free (&input);
2625 /* Re-fetch pointer since pool may have moved. */
2626 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2627 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2630 /* reset vector; we'll re-use it later */
2633 vec_reset_length (cf->input_vector);
2634 cf->current_command = 0;
2638 vec_reset_length (cf->current_command);
2641 if (cf->no_pager == 2)
2643 /* Pager was programmatically disabled */
2644 unix_cli_pager_message (cf, uf, "pager buffer overflowed", "\n");
2645 cf->no_pager = um->cli_no_pager;
2648 if (vec_len (cf->pager_index) == 0
2649 || vec_len (cf->pager_index) < cf->height)
2651 /* There was no need for the pager */
2652 unix_cli_pager_reset (cf);
2655 unix_cli_cli_prompt (cf, uf);
2659 /* Display the pager prompt */
2660 unix_cli_pager_prompt (cf, uf);
2663 /* Any residual data in the input vector? */
2664 if (vec_len (cf->input_vector))
2667 /* For non-interactive sessions send a NUL byte.
2668 * Specifically this is because vppctl needs to see some traffic in
2669 * order to move on to closing the session. Commands with no output
2670 * would thus cause vppctl to hang indefinitely in non-interactive mode
2671 * since there is also no prompt sent after the command completes.
2673 if (!cf->is_interactive)
2674 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\0", 1);
2677 /** Destroy a CLI session.
2678 * @note If we destroy the @c stdin session this additionally signals
2679 * the shutdown of VPP.
2682 unix_cli_kill (unix_cli_main_t * cm, uword cli_file_index)
2684 unix_main_t *um = &unix_main;
2685 clib_file_main_t *fm = &file_main;
2686 unix_cli_file_t *cf;
2690 /* Validate cli_file_index */
2691 if (pool_is_free_index (cm->cli_file_pool, cli_file_index))
2694 vec_foreach_index (i, cm->new_sessions)
2696 unix_cli_new_session_t *ns = vec_elt_at_index (cm->new_sessions, i);
2698 if (ns->cf_index == cli_file_index)
2705 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2706 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2708 /* Quit/EOF on stdin means quit program. */
2709 if (uf->file_descriptor == STDIN_FILENO)
2710 clib_longjmp (&um->vlib_main->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
2712 vec_free (cf->current_command);
2713 vec_free (cf->search_key);
2715 for (i = 0; i < vec_len (cf->command_history); i++)
2716 vec_free (cf->command_history[i]);
2718 vec_free (cf->command_history);
2719 vec_free (cf->input_vector);
2721 clib_file_del (fm, uf);
2723 unix_cli_file_free (cf);
2724 clib_macro_free (&cf->macro_main);
2725 pool_put (cm->cli_file_pool, cf);
2728 /** Handle system events. */
2730 unix_cli_process (vlib_main_t * vm,
2731 vlib_node_runtime_t * rt, vlib_frame_t * f)
2733 unix_cli_main_t *cm = &unix_cli_main;
2738 unix_cli_process_event_type_t event_type;
2739 vlib_process_wait_for_event (vm);
2740 event_type = vlib_process_get_events (vm, &data);
2744 case UNIX_CLI_PROCESS_EVENT_READ_READY:
2745 for (i = 0; i < vec_len (data); i++)
2746 unix_cli_process_input (cm, data[i]);
2749 case UNIX_CLI_PROCESS_EVENT_QUIT:
2750 /* Kill this process. */
2751 for (i = 0; i < vec_len (data); i++)
2752 unix_cli_kill (cm, data[i]);
2757 vec_set_len (data, 0);
2763 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
2765 /* Add node index so we can re-use this process later. */
2766 vec_add1 (cm->unused_cli_process_node_indices, rt->node_index);
2771 /** Called when a CLI session file descriptor can be written to without
2773 static clib_error_t *
2774 unix_cli_write_ready (clib_file_t * uf)
2776 unix_cli_main_t *cm = &unix_cli_main;
2777 unix_cli_file_t *cf;
2780 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2782 /* Flush output vector. */
2784 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
2785 n = send (uf->file_descriptor,
2786 cf->output_vector, vec_len (cf->output_vector), MSG_NOSIGNAL);
2788 n = write (uf->file_descriptor,
2789 cf->output_vector, vec_len (cf->output_vector));
2791 if (n < 0 && errno != EAGAIN)
2795 /* connection closed on us */
2796 unix_main_t *um = &unix_main;
2798 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
2799 UNIX_CLI_PROCESS_EVENT_QUIT,
2804 return clib_error_return_unix (0, "write");
2809 unix_cli_del_pending_output (uf, cf, n);
2811 return /* no error */ 0;
2814 /** Called when a CLI session file descriptor has data to be read. */
2815 static clib_error_t *
2816 unix_cli_read_ready (clib_file_t * uf)
2818 unix_main_t *um = &unix_main;
2819 unix_cli_main_t *cm = &unix_cli_main;
2820 unix_cli_file_t *cf;
2822 int n, n_read, n_try;
2824 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2829 l = vec_len (cf->input_vector);
2830 vec_resize (cf->input_vector, l + n_try);
2832 n = read (uf->file_descriptor, cf->input_vector + l, n_try);
2835 if (n < 0 && errno != EAGAIN)
2836 return clib_error_return_unix (0, "read");
2838 n_read = n < 0 ? 0 : n;
2839 vec_set_len (cf->input_vector, l + n_read);
2843 vlib_process_signal_event (um->vlib_main,
2844 cf->process_node_index,
2846 ? UNIX_CLI_PROCESS_EVENT_QUIT
2847 : UNIX_CLI_PROCESS_EVENT_READ_READY),
2848 /* event data */ uf->private_data);
2850 return /* no error */ 0;
2853 /** Called when a CLI session file descriptor has an error condition. */
2854 static clib_error_t *
2855 unix_cli_error_detected (clib_file_t * uf)
2857 unix_main_t *um = &unix_main;
2858 unix_cli_main_t *cm = &unix_cli_main;
2859 unix_cli_file_t *cf;
2861 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2862 cf->has_epipe = 1; /* prevent writes while the close is pending */
2863 vlib_process_signal_event (um->vlib_main,
2864 cf->process_node_index,
2865 UNIX_CLI_PROCESS_EVENT_QUIT,
2866 /* event data */ uf->private_data);
2868 return /* no error */ 0;
2871 /** Store a new CLI session.
2872 * @param name The name of the session.
2873 * @param fd The file descriptor for the session I/O.
2874 * @return The session ID.
2877 unix_cli_file_add (unix_cli_main_t * cm, char *name, int fd)
2879 unix_main_t *um = &unix_main;
2880 clib_file_main_t *fm = &file_main;
2881 vlib_node_main_t *nm = &vlib_get_main ()->node_main;
2882 unix_cli_file_t *cf;
2883 clib_file_t template = { 0 };
2884 vlib_main_t *vm = um->vlib_main;
2888 file_desc = format (0, "%s", name);
2890 name = (char *) format (0, "unix-cli-%s", name);
2892 if (vec_len (cm->unused_cli_process_node_indices) > 0)
2894 uword l = vec_len (cm->unused_cli_process_node_indices);
2896 vlib_main_t *this_vlib_main;
2900 * Nodes are bulk-copied, so node name pointers are shared.
2901 * Find the cli node in all graph replicas, and give all of them
2902 * the same new name.
2903 * Then, throw away the old shared name-vector.
2905 for (i = 0; i < vlib_get_n_threads (); i++)
2907 this_vlib_main = vlib_get_main_by_index (i);
2908 if (this_vlib_main == 0)
2910 n = vlib_get_node (this_vlib_main,
2911 cm->unused_cli_process_node_indices[l - 1]);
2913 n->name = (u8 *) name;
2916 hash_unset (nm->node_by_name, old_name);
2917 hash_set (nm->node_by_name, name, n->index);
2918 vec_free (old_name);
2920 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
2921 vec_set_len (cm->unused_cli_process_node_indices, l - 1);
2925 static vlib_node_registration_t r = {
2926 .function = unix_cli_process,
2927 .type = VLIB_NODE_TYPE_PROCESS,
2928 .process_log2_n_stack_bytes = 18,
2931 vlib_worker_thread_barrier_sync (vm);
2933 vlib_register_node (vm, &r, "%v", name);
2936 n = vlib_get_node (vm, r.index);
2937 vlib_worker_thread_node_runtime_update ();
2938 vlib_worker_thread_barrier_release (vm);
2941 pool_get (cm->cli_file_pool, cf);
2942 clib_memset (cf, 0, sizeof (*cf));
2943 clib_macro_init (&cf->macro_main);
2945 template.read_function = unix_cli_read_ready;
2946 template.write_function = unix_cli_write_ready;
2947 template.error_function = unix_cli_error_detected;
2948 template.file_descriptor = fd;
2949 template.private_data = cf - cm->cli_file_pool;
2950 template.description = file_desc;
2952 cf->process_node_index = n->index;
2953 cf->clib_file_index = clib_file_add (fm, &template);
2954 cf->output_vector = 0;
2955 cf->input_vector = 0;
2956 vec_validate (cf->current_command, 0);
2957 vec_set_len (cf->current_command, 0);
2959 vlib_start_process (vm, n->runtime_index);
2961 vlib_process_t *p = vlib_get_process_from_node (vm, n);
2962 p->output_function = unix_vlib_cli_output;
2963 p->output_function_arg = cf - cm->cli_file_pool;
2965 return cf - cm->cli_file_pool;
2968 /** Telnet listening socket has a new connection. */
2969 static clib_error_t *
2970 unix_cli_listen_read_ready (clib_file_t * uf)
2972 unix_main_t *um = &unix_main;
2973 clib_file_main_t *fm = &file_main;
2974 unix_cli_main_t *cm = &unix_cli_main;
2975 clib_socket_t *s = &um->cli_listen_socket;
2976 clib_socket_t client;
2978 clib_error_t *error;
2979 unix_cli_file_t *cf;
2983 error = clib_socket_accept (s, &client);
2987 /* Disable Nagle, ignore any errors doing so eg on PF_LOCAL socket */
2989 (void) setsockopt (client.fd, IPPROTO_TCP, TCP_NODELAY,
2990 (void *) &one, sizeof (one));
2992 client_name = (char *) format (0, "%U%c", format_sockaddr, &client.peer, 0);
2994 cf_index = unix_cli_file_add (cm, client_name, client.fd);
2995 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2998 /* No longer need CLIB version of socket. */
2999 clib_socket_free (&client);
3000 vec_free (client_name);
3002 /* if we're supposed to run telnet session in character mode (default) */
3003 if (um->cli_line_mode == 0)
3006 * Set telnet client character mode, echo on, suppress "go-ahead".
3007 * Technically these should be negotiated, but this works.
3009 u8 charmode_option[] = {
3010 IAC, WONT, TELOPT_LINEMODE, /* server will do char-by-char */
3011 IAC, DONT, TELOPT_LINEMODE, /* client should do char-by-char */
3012 IAC, WILL, TELOPT_SGA, /* server willl supress GA */
3013 IAC, DO, TELOPT_SGA, /* client should supress Go Ahead */
3014 IAC, WILL, TELOPT_ECHO, /* server will do echo */
3015 IAC, DONT, TELOPT_ECHO, /* client should not echo */
3016 IAC, DO, TELOPT_TTYPE, /* client should tell us its term type */
3017 IAC, SB, TELOPT_TTYPE, 1, IAC, SE, /* now tell me ttype */
3018 IAC, DO, TELOPT_NAWS, /* client should tell us its window sz */
3019 IAC, SB, TELOPT_NAWS, 1, IAC, SE, /* now tell me window size */
3022 /* Enable history on this CLI */
3023 cf->history_limit = um->cli_history_limit;
3024 cf->has_history = cf->history_limit != 0;
3026 /* This is an interactive session until we decide otherwise */
3027 cf->is_interactive = 1;
3029 /* Make sure this session is in line mode */
3035 /* Setup the pager */
3036 cf->no_pager = um->cli_no_pager;
3038 /* Default terminal dimensions, should the terminal
3039 * fail to provide any.
3041 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3042 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3044 /* Send the telnet options */
3045 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3046 unix_vlib_cli_output_raw (cf, uf, charmode_option,
3047 ARRAY_LEN (charmode_option));
3049 if (cm->new_session_process_node_index == ~0)
3051 /* Create thw new session deadline process */
3052 cm->new_session_process_node_index =
3053 vlib_process_create (um->vlib_main, "unix-cli-new-session",
3054 unix_cli_new_session_process,
3055 16 /* log2_n_stack_bytes */ );
3058 /* In case the client doesn't negotiate terminal type, register
3059 * our session with a process that will emit the prompt if
3060 * a deadline passes */
3061 vlib_process_signal_event (um->vlib_main,
3062 cm->new_session_process_node_index,
3063 UNIX_CLI_NEW_SESSION_EVENT_ADD, cf_index);
3070 /** The system terminal has informed us that the window size
3074 unix_cli_resize_interrupt (int signum)
3076 clib_file_main_t *fm = &file_main;
3077 unix_cli_main_t *cm = &unix_cli_main;
3078 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
3079 cm->stdin_cli_file_index);
3080 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3084 /* Terminal resized, fetch the new size */
3085 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) < 0)
3087 /* "Should never happen..." */
3088 clib_unix_warning ("TIOCGWINSZ");
3089 /* We can't trust ws.XXX... */
3093 cf->width = ws.ws_col;
3094 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
3095 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
3097 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3099 cf->height = ws.ws_row;
3100 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
3101 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
3102 if (cf->height == 0)
3103 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3105 /* Reindex the pager buffer */
3106 unix_cli_pager_reindex (cf);
3108 /* Redraw the page */
3109 unix_cli_pager_redraw (cf, uf);
3112 /** Handle configuration directives in the @em unix section. */
3113 static clib_error_t *
3114 unix_cli_config (vlib_main_t * vm, unformat_input_t * input)
3116 unix_main_t *um = &unix_main;
3117 clib_file_main_t *fm = &file_main;
3118 unix_cli_main_t *cm = &unix_cli_main;
3120 clib_error_t *error = 0;
3121 unix_cli_file_t *cf;
3124 struct sigaction sa;
3128 /* We depend on unix flags being set. */
3129 if ((error = vlib_call_config_function (vm, unix_config)))
3132 if (um->flags & UNIX_FLAG_INTERACTIVE)
3134 /* Set stdin to be non-blocking. */
3135 if ((flags = fcntl (STDIN_FILENO, F_GETFL, 0)) < 0)
3137 (void) fcntl (STDIN_FILENO, F_SETFL, flags | O_NONBLOCK);
3139 cf_index = unix_cli_file_add (cm, "stdin", STDIN_FILENO);
3140 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
3141 cm->stdin_cli_file_index = cf_index;
3143 /* If stdin is a tty and we are using chacracter mode, enable
3144 * history on the CLI and set the tty line discipline accordingly. */
3145 if (isatty (STDIN_FILENO) && um->cli_line_mode == 0)
3147 /* Capture terminal resize events */
3148 clib_memset (&sa, 0, sizeof (sa));
3149 sa.sa_handler = unix_cli_resize_interrupt;
3150 if (sigaction (SIGWINCH, &sa, 0) < 0)
3151 clib_panic ("sigaction");
3153 /* Retrieve the current terminal size */
3154 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) == 0)
3156 cf->width = ws.ws_col;
3157 cf->height = ws.ws_row;
3160 if (cf->width == 0 || cf->height == 0)
3163 * We have a tty, but no size. Use defaults.
3164 * vpp "unix interactive" inside emacs + gdb ends up here.
3166 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3167 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3170 /* Setup the history */
3171 cf->history_limit = um->cli_history_limit;
3172 cf->has_history = cf->history_limit != 0;
3174 /* Setup the pager */
3175 cf->no_pager = um->cli_no_pager;
3177 /* This is an interactive session until we decide otherwise */
3178 cf->is_interactive = 1;
3180 /* We're going to be in char by char mode */
3183 /* Save the original tty state so we can restore it later */
3184 tcgetattr (STDIN_FILENO, &um->tio_stdin);
3187 /* Tweak the tty settings */
3188 tio = um->tio_stdin;
3189 /* echo off, canonical mode off, ext'd input processing off */
3190 tio.c_lflag &= ~(ECHO | ICANON | IEXTEN);
3191 /* disable XON/XOFF, so ^S invokes the history search */
3192 tio.c_iflag &= ~(IXON | IXOFF);
3193 tio.c_cc[VMIN] = 1; /* 1 byte at a time */
3194 tio.c_cc[VTIME] = 0; /* no timer */
3195 tio.c_cc[VSTOP] = _POSIX_VDISABLE; /* not ^S */
3196 tio.c_cc[VSTART] = _POSIX_VDISABLE; /* not ^Q */
3197 tcsetattr (STDIN_FILENO, TCSAFLUSH, &tio);
3199 /* See if we can do ANSI/VT100 output */
3200 term = (u8 *) getenv ("TERM");
3203 int len = strlen ((char *) term);
3204 cf->ansi_capable = unix_cli_terminal_type_ansi (term, len);
3205 if (unix_cli_terminal_type_noninteractive (term, len))
3206 unix_cli_set_session_noninteractive (cf);
3211 /* No tty, so make sure the session doesn't have tty-like features */
3212 unix_cli_set_session_noninteractive (cf);
3215 /* Send banner and initial prompt */
3216 unix_cli_file_welcome (cm, cf);
3219 /* If we have socket config, LISTEN, otherwise, don't */
3220 clib_socket_t *s = &um->cli_listen_socket;
3221 if (s->config && s->config[0] != 0)
3224 clib_file_t template = { 0 };
3226 /* mkdir of file socketu, only under /run */
3227 if (strncmp (s->config, "/run", 4) == 0)
3229 u8 *tmp = format (0, "%s", s->config);
3230 int i = vec_len (tmp);
3231 while (i && tmp[--i] != '/')
3237 vlib_unix_recursive_mkdir ((char *) tmp);
3241 s->flags = CLIB_SOCKET_F_IS_SERVER | /* listen, don't connect */
3242 CLIB_SOCKET_F_ALLOW_GROUP_WRITE; /* PF_LOCAL socket only */
3243 error = clib_socket_init (s);
3248 template.read_function = unix_cli_listen_read_ready;
3249 template.file_descriptor = s->fd;
3250 template.description = format (0, "cli listener %s", s->config);
3252 clib_file_add (fm, &template);
3255 /* Set CLI prompt. */
3256 if (!cm->cli_prompt)
3257 cm->cli_prompt = format (0, "VLIB: ");
3263 * This module has no configurable parameters.
3265 VLIB_CONFIG_FUNCTION (unix_cli_config, "unix-cli");
3267 /** Called when VPP is shutting down, this restores the system
3268 * terminal state if previously saved.
3270 static clib_error_t *
3271 unix_cli_exit (vlib_main_t * vm)
3273 unix_main_t *um = &unix_main;
3275 /* If stdin is a tty and we saved the tty state, reset the tty state */
3276 if (isatty (STDIN_FILENO) && um->tio_isset)
3277 tcsetattr (STDIN_FILENO, TCSAFLUSH, &um->tio_stdin);
3282 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_cli_exit);
3284 /** Set the CLI prompt.
3285 * @param prompt The C string to set the prompt to.
3286 * @note This setting is global; it impacts all current
3287 * and future CLI sessions.
3290 vlib_unix_cli_set_prompt (char *prompt)
3292 char *fmt = (prompt[strlen (prompt) - 1] == ' ') ? "%s" : "%s ";
3293 unix_cli_main_t *cm = &unix_cli_main;
3295 vec_free (cm->cli_prompt);
3296 cm->cli_prompt = format (0, fmt, prompt);
3299 static unix_cli_file_t *
3300 unix_cli_file_if_exists (unix_cli_main_t * cm)
3302 if (!cm->cli_file_pool)
3304 return pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3307 static unix_cli_file_t *
3308 unix_cli_file_if_interactive (unix_cli_main_t * cm)
3310 unix_cli_file_t *cf;
3311 if ((cf = unix_cli_file_if_exists (cm)) && !cf->is_interactive)
3316 /** CLI command to quit the terminal session.
3317 * @note If this is a stdin session then this will
3318 * shutdown VPP also.
3320 static clib_error_t *
3321 unix_cli_quit (vlib_main_t * vm,
3322 unformat_input_t * input, vlib_cli_command_t * cmd)
3324 unix_cli_main_t *cm = &unix_cli_main;
3325 unix_cli_file_t *cf;
3327 if (!(cf = unix_cli_file_if_exists (cm)))
3328 return clib_error_return (0, "invalid session");
3330 /* Cosmetic: suppress the final prompt from appearing before we die */
3331 cf->is_interactive = 0;
3334 vlib_process_signal_event (vm,
3335 vlib_current_process (vm),
3336 UNIX_CLI_PROCESS_EVENT_QUIT,
3337 cm->current_input_file_index);
3342 * Terminates the current CLI session.
3344 * If VPP is running in @em interactive mode and this is the console session
3345 * (that is, the session on @c stdin) then this will also terminate VPP.
3348 VLIB_CLI_COMMAND (unix_cli_quit_command, static) = {
3350 .short_help = "Exit CLI",
3351 .function = unix_cli_quit,
3356 VLIB_CLI_COMMAND (unix_cli_q_command, static) = {
3358 .short_help = "Exit CLI",
3359 .function = unix_cli_quit,
3363 /** CLI command to execute a VPP command script. */
3364 static clib_error_t *
3365 unix_cli_exec (vlib_main_t * vm,
3366 unformat_input_t * input, vlib_cli_command_t * cmd)
3370 unformat_input_t sub_input;
3371 clib_error_t *error;
3372 unix_cli_main_t *cm = &unix_cli_main;
3373 unix_cli_file_t *cf;
3381 if (!unformat (input, "%s", &file_name))
3383 error = clib_error_return (0, "expecting file name, got `%U'",
3384 format_unformat_error, input);
3388 fd = open (file_name, O_RDONLY);
3391 error = clib_error_return_unix (0, "failed to open `%s'", file_name);
3395 /* Make sure its a regular file. */
3396 if (fstat (fd, &s) < 0)
3398 error = clib_error_return_unix (0, "failed to stat `%s'", file_name);
3402 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
3404 error = clib_error_return (0, "not a regular file `%s'", file_name);
3409 vec_validate (file_data, s.st_size);
3411 if (read (fd, file_data, s.st_size) != s.st_size)
3413 error = clib_error_return_unix (0, "Failed to read %d bytes from '%s'",
3414 s.st_size, file_name);
3415 vec_free (file_data);
3419 /* The macro expander expects a c string... */
3420 vec_add1 (file_data, 0);
3422 unformat_init_vector (&sub_input, file_data);
3424 /* Run the file contents through the macro processor */
3425 if (vec_len (sub_input.buffer) > 1)
3428 clib_macro_main_t *mm = 0;
3430 /* Initial config process? Use the global macro table. */
3431 if (pool_is_free_index
3432 (cm->cli_file_pool, cm->current_input_file_index))
3433 mm = &cm->macro_main;
3436 /* Otherwise, use the per-cli-process macro table */
3437 cf = pool_elt_at_index (cm->cli_file_pool,
3438 cm->current_input_file_index);
3439 mm = &cf->macro_main;
3442 expanded = (u8 *) clib_macro_eval (mm,
3443 (i8 *) sub_input.buffer,
3446 8 /* max_level */ );
3447 /* Macro processor NULL terminates the return */
3448 vec_dec_len (expanded, 1);
3449 vec_reset_length (sub_input.buffer);
3450 vec_append (sub_input.buffer, expanded);
3451 vec_free (expanded);
3454 vlib_cli_input (vm, &sub_input, 0, 0);
3455 unformat_free (&sub_input);
3460 vec_free (file_name);
3466 * Executes a sequence of CLI commands which are read from a file. If
3467 * a command is unrecognized or otherwise invalid then the usual CLI
3468 * feedback will be generated, however execution of subsequent commands
3469 * from the file will continue.
3471 * The VPP code is indifferent to the file location. However, if SELinux
3472 * is enabled, then the file needs to have an SELinux label the VPP
3473 * process is allowed to access. For example, if a file is created in
3474 * '<em>/usr/share/vpp/</em>', it will be allowed. However, files manually
3475 * created in '/tmp/' or '/home/<user>/' will not be accessible by the VPP
3476 * process when SELinux is enabled.
3481 * <b><em>$ cat /usr/share/vpp/scripts/gigup.txt</em></b>
3482 * set interface state GigabitEthernet0/8/0 up
3483 * set interface state GigabitEthernet0/9/0 up
3485 * Example of how to execute a set of CLI commands from a file:
3486 * @cliexcmd{exec /usr/share/vpp/scripts/gigup.txt}
3489 VLIB_CLI_COMMAND (cli_exec, static) = {
3491 .short_help = "exec <filename>",
3492 .function = unix_cli_exec,
3497 /** CLI command to show various unix error statistics. */
3498 static clib_error_t *
3499 unix_show_errors (vlib_main_t * vm,
3500 unformat_input_t * input, vlib_cli_command_t * cmd)
3502 unix_main_t *um = &unix_main;
3503 clib_error_t *error = 0;
3504 int i, n_errors_to_show;
3505 unix_error_history_t *unix_errors = 0;
3507 n_errors_to_show = 1 << 30;
3509 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3511 if (!unformat (input, "%d", &n_errors_to_show))
3514 clib_error_return (0,
3515 "expecting integer number of errors to show, got `%U'",
3516 format_unformat_error, input);
3522 clib_min (ARRAY_LEN (um->error_history), n_errors_to_show);
3525 um->error_history_index >
3526 0 ? um->error_history_index - 1 : ARRAY_LEN (um->error_history) - 1;
3528 while (n_errors_to_show > 0)
3530 unix_error_history_t *eh = um->error_history + i;
3535 vec_add1 (unix_errors, eh[0]);
3536 n_errors_to_show -= 1;
3538 i = ARRAY_LEN (um->error_history) - 1;
3543 if (vec_len (unix_errors) == 0)
3544 vlib_cli_output (vm, "no Unix errors so far");
3547 vlib_cli_output (vm, "%Ld total errors seen", um->n_total_errors);
3548 for (i = vec_len (unix_errors) - 1; i >= 0; i--)
3550 unix_error_history_t *eh = vec_elt_at_index (unix_errors, i);
3551 vlib_cli_output (vm, "%U: %U",
3552 format_time_interval, "h:m:s:u", eh->time,
3553 format_clib_error, eh->error);
3555 vlib_cli_output (vm, "%U: time now",
3556 format_time_interval, "h:m:s:u", vlib_time_now (vm));
3560 vec_free (unix_errors);
3565 VLIB_CLI_COMMAND (cli_unix_show_errors, static) = {
3566 .path = "show unix errors",
3567 .short_help = "Show Unix system call error history",
3568 .function = unix_show_errors,
3572 /** CLI command to show various unix error statistics. */
3573 static clib_error_t *
3574 unix_show_files (vlib_main_t * vm,
3575 unformat_input_t * input, vlib_cli_command_t * cmd)
3577 clib_error_t *error = 0;
3578 clib_file_main_t *fm = &file_main;
3580 char path[PATH_MAX];
3583 vlib_cli_output (vm, "%3s %6s %12s %12s %12s %-32s %s", "FD", "Thread",
3584 "Read", "Write", "Error", "File Name", "Description");
3587 pool_foreach (f, fm->file_pool)
3590 s = format (s, "/proc/self/fd/%d%c", f->file_descriptor, 0);
3591 rv = readlink((char *) s, path, PATH_MAX - 1);
3593 path[rv < 0 ? 0 : rv] = 0;
3595 vlib_cli_output (vm, "%3d %6d %12d %12d %12d %-32s %v",
3596 f->file_descriptor, f->polling_thread_index,
3597 f->read_events, f->write_events, f->error_events,
3598 path, f->description);
3599 vec_reset_length (s);
3608 VLIB_CLI_COMMAND (cli_unix_show_files, static) = {
3609 .path = "show unix files",
3610 .short_help = "Show Unix files in use",
3611 .function = unix_show_files,
3615 /** CLI command to show session command history. */
3616 static clib_error_t *
3617 unix_cli_show_history (vlib_main_t * vm,
3618 unformat_input_t * input, vlib_cli_command_t * cmd)
3620 unix_cli_main_t *cm = &unix_cli_main;
3621 unix_cli_file_t *cf;
3624 if (!(cf = unix_cli_file_if_interactive (cm)))
3625 return clib_error_return (0, "invalid for non-interactive sessions");
3627 if (cf->has_history && cf->history_limit)
3629 i = 1 + cf->command_number - vec_len (cf->command_history);
3630 for (j = 0; j < vec_len (cf->command_history); j++)
3631 vlib_cli_output (vm, "%d %v\n", i + j, cf->command_history[j]);
3635 vlib_cli_output (vm, "History not enabled.\n");
3642 * Displays the command history for the current session, if any.
3645 VLIB_CLI_COMMAND (cli_unix_cli_show_history, static) = {
3647 .short_help = "Show current session command history",
3648 .function = unix_cli_show_history,
3652 /** CLI command to show terminal status. */
3653 static clib_error_t *
3654 unix_cli_show_terminal (vlib_main_t * vm,
3655 unformat_input_t * input, vlib_cli_command_t * cmd)
3657 unix_main_t *um = &unix_main;
3658 unix_cli_main_t *cm = &unix_cli_main;
3659 unix_cli_file_t *cf;
3662 if (!(cf = unix_cli_file_if_exists (cm)))
3663 return clib_error_return (0, "invalid session");
3665 n = vlib_get_node (vm, cf->process_node_index);
3667 vlib_cli_output (vm, "Terminal name: %v\n", n->name);
3668 vlib_cli_output (vm, "Terminal mode: %s\n", cf->line_mode ?
3669 "line-by-line" : "char-by-char");
3670 vlib_cli_output (vm, "Terminal width: %d\n", cf->width);
3671 vlib_cli_output (vm, "Terminal height: %d\n", cf->height);
3672 vlib_cli_output (vm, "ANSI capable: %s\n",
3673 cf->ansi_capable ? "yes" : "no");
3674 vlib_cli_output (vm, "Interactive: %s\n",
3675 cf->is_interactive ? "yes" : "no");
3676 vlib_cli_output (vm, "History enabled: %s%s\n",
3677 cf->has_history ? "yes" : "no", !cf->has_history
3678 || cf->history_limit ? "" :
3679 " (disabled by history limit)");
3680 if (cf->has_history)
3681 vlib_cli_output (vm, "History limit: %d\n", cf->history_limit);
3682 vlib_cli_output (vm, "Pager enabled: %s%s%s\n",
3683 cf->no_pager ? "no" : "yes",
3685 || cf->height ? "" : " (disabled by terminal height)",
3687 || um->cli_pager_buffer_limit ? "" :
3688 " (disabled by buffer limit)");
3690 vlib_cli_output (vm, "Pager limit: %d\n", um->cli_pager_buffer_limit);
3691 vlib_cli_output (vm, "CRLF mode: %s\n",
3692 cf->crlf_mode ? "CR+LF" : "LF");
3698 * Displays various information about the state of the current terminal
3702 * @cliexstart{show terminal}
3703 * Terminal name: unix-cli-stdin
3704 * Terminal mode: char-by-char
3705 * Terminal width: 123
3706 * Terminal height: 48
3709 * History enabled: yes
3711 * Pager enabled: yes
3712 * Pager limit: 100000
3717 VLIB_CLI_COMMAND (cli_unix_cli_show_terminal, static) = {
3718 .path = "show terminal",
3719 .short_help = "Show current session terminal settings",
3720 .function = unix_cli_show_terminal,
3724 /** CLI command to display a list of CLI sessions. */
3725 static clib_error_t *
3726 unix_cli_show_cli_sessions (vlib_main_t * vm,
3727 unformat_input_t * input,
3728 vlib_cli_command_t * cmd)
3730 unix_cli_main_t *cm = &unix_cli_main;
3731 clib_file_main_t *fm = &file_main;
3732 unix_cli_file_t *cf;
3736 vlib_cli_output (vm, "%-5s %-5s %-20s %s", "PNI", "FD", "Name", "Flags");
3738 #define fl(x, y) ( (x) ? toupper((y)) : tolower((y)) )
3740 pool_foreach (cf, cm->cli_file_pool) {
3741 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3742 n = vlib_get_node (vm, cf->process_node_index);
3743 vlib_cli_output (vm,
3744 "%-5d %-5d %-20v %c%c%c%c%c\n",
3745 cf->process_node_index,
3746 uf->file_descriptor,
3748 fl (cf->is_interactive, 'i'),
3749 fl (cf->is_socket, 's'),
3750 fl (cf->line_mode, 'l'),
3751 fl (cf->has_epipe, 'p'),
3752 fl (cf->ansi_capable, 'a'));
3761 * Displays a summary of all the current CLI sessions.
3763 * Typically used to diagnose connection issues with the CLI
3767 * @cliexstart{show cli-sessions}
3769 * 343 0 unix-cli-stdin IslpA
3770 * 344 7 unix-cli-local:20 ISlpA
3771 * 346 8 unix-cli-local:21 iSLpa
3774 * In this example we have the debug console of the running process
3775 * on stdin/out, we have an interactive socket session and we also
3776 * have a non-interactive socket session.
3780 * - @em PNI: Process node index.
3781 * - @em FD: Unix file descriptor.
3782 * - @em Name: Name of the session.
3783 * - @em Flags: Various flags that describe the state of the session.
3785 * @em Flags have the following meanings; lower-case typically negates
3788 * - @em I Interactive session.
3789 * - @em S Connected by socket.
3790 * - @em s Not a socket, likely stdin.
3791 * - @em L Line-by-line mode.
3792 * - @em l Char-by-char mode.
3793 * - @em P EPIPE detected on connection; it will close soon.
3794 * - @em A ANSI-capable terminal.
3797 VLIB_CLI_COMMAND (cli_unix_cli_show_cli_sessions, static) = {
3798 .path = "show cli-sessions",
3799 .short_help = "Show current CLI sessions",
3800 .function = unix_cli_show_cli_sessions,
3804 /** CLI command to set terminal pager settings. */
3805 static clib_error_t *
3806 unix_cli_set_terminal_pager (vlib_main_t * vm,
3807 unformat_input_t * input,
3808 vlib_cli_command_t * cmd)
3810 unix_main_t *um = &unix_main;
3811 unix_cli_main_t *cm = &unix_cli_main;
3812 unix_cli_file_t *cf;
3813 unformat_input_t _line_input, *line_input = &_line_input;
3814 clib_error_t *error = 0;
3816 if (!(cf = unix_cli_file_if_interactive (cm)))
3817 return clib_error_return (0, "invalid for non-interactive sessions");
3819 if (!unformat_user (input, unformat_line_input, line_input))
3822 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3824 if (unformat (line_input, "on"))
3826 else if (unformat (line_input, "off"))
3828 else if (unformat (line_input, "limit %u", &um->cli_pager_buffer_limit))
3829 vlib_cli_output (vm,
3830 "Pager limit set to %u lines; note, this is global.\n",
3831 um->cli_pager_buffer_limit);
3834 error = clib_error_return (0, "unknown parameter: `%U`",
3835 format_unformat_error, line_input);
3841 unformat_free (line_input);
3847 * Enables or disables the terminal pager for this session. Generally
3848 * this defaults to enabled.
3850 * Additionally allows the pager buffer size to be set; though note that
3851 * this value is set globally and not per session.
3854 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager, static) = {
3855 .path = "set terminal pager",
3856 .short_help = "set terminal pager [on|off] [limit <lines>]",
3857 .function = unix_cli_set_terminal_pager,
3861 /** CLI command to set terminal history settings. */
3862 static clib_error_t *
3863 unix_cli_set_terminal_history (vlib_main_t * vm,
3864 unformat_input_t * input,
3865 vlib_cli_command_t * cmd)
3867 unix_cli_main_t *cm = &unix_cli_main;
3868 unix_cli_file_t *cf;
3869 unformat_input_t _line_input, *line_input = &_line_input;
3871 clib_error_t *error = 0;
3873 if (!(cf = unix_cli_file_if_interactive (cm)))
3874 return clib_error_return (0, "invalid for non-interactive sessions");
3876 if (!unformat_user (input, unformat_line_input, line_input))
3879 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3881 if (unformat (line_input, "on"))
3882 cf->has_history = 1;
3883 else if (unformat (line_input, "off"))
3884 cf->has_history = 0;
3885 else if (unformat (line_input, "limit %u", &cf->history_limit))
3889 error = clib_error_return (0, "unknown parameter: `%U`",
3890 format_unformat_error, line_input);
3896 /* If we reduced history size, or turned it off, purge the history */
3897 limit = cf->has_history ? cf->history_limit : 0;
3898 if (limit < vec_len (cf->command_history))
3902 /* How many items to remove from the start of history */
3903 limit = vec_len (cf->command_history) - limit;
3905 for (i = 0; i < limit; i++)
3906 vec_free (cf->command_history[i]);
3908 vec_delete (cf->command_history, limit, 0);
3912 unformat_free (line_input);
3918 * Enables or disables the command history function of the current
3919 * terminal. Generally this defaults to enabled.
3921 * This command also allows the maximum size of the history buffer for
3922 * this session to be altered.
3925 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history, static) = {
3926 .path = "set terminal history",
3927 .short_help = "set terminal history [on|off] [limit <lines>]",
3928 .function = unix_cli_set_terminal_history,
3932 /** CLI command to set terminal ANSI settings. */
3933 static clib_error_t *
3934 unix_cli_set_terminal_ansi (vlib_main_t * vm,
3935 unformat_input_t * input,
3936 vlib_cli_command_t * cmd)
3938 unix_cli_main_t *cm = &unix_cli_main;
3939 unix_cli_file_t *cf;
3941 if (!(cf = unix_cli_file_if_interactive (cm)))
3942 return clib_error_return (0, "invalid for non-interactive sessions");
3944 if (unformat (input, "on"))
3945 cf->ansi_capable = 1;
3946 else if (unformat (input, "off"))
3947 cf->ansi_capable = 0;
3949 return clib_error_return (0, "unknown parameter: `%U`",
3950 format_unformat_error, input);
3956 * Enables or disables the use of ANSI control sequences by this terminal.
3957 * The default will vary based on terminal detection at the start of the
3960 * ANSI control sequences are used in a small number of places to provide,
3961 * for example, color text output and to control the cursor in the pager.
3964 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi, static) = {
3965 .path = "set terminal ansi",
3966 .short_help = "set terminal ansi [on|off]",
3967 .function = unix_cli_set_terminal_ansi,
3972 #define MAX_CLI_WAIT 86400
3973 /** CLI command to wait <sec> seconds. Useful for exec script. */
3974 static clib_error_t *
3975 unix_wait_cmd (vlib_main_t * vm,
3976 unformat_input_t * input, vlib_cli_command_t * cmd)
3978 unformat_input_t _line_input, *line_input = &_line_input;
3981 if (!unformat_user (input, unformat_line_input, line_input))
3984 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3986 if (unformat (line_input, "%f", &sec))
3989 return clib_error_return (0, "unknown parameter: `%U`",
3990 format_unformat_error, input);
3993 if (sec <= 0 || sec > MAX_CLI_WAIT || floor (sec * 1000) / 1000 != sec)
3994 return clib_error_return (0,
3995 "<sec> must be a positive value and less than 86400 (one day) with no more than msec precision.");
3997 vlib_process_wait_for_event_or_clock (vm, sec);
3998 vlib_cli_output (vm, "waited %.3f sec.", sec);
4000 unformat_free (line_input);
4004 VLIB_CLI_COMMAND (cli_unix_wait_cmd, static) = {
4006 .short_help = "wait <sec>",
4007 .function = unix_wait_cmd,
4011 static clib_error_t *
4012 echo_cmd (vlib_main_t * vm,
4013 unformat_input_t * input, vlib_cli_command_t * cmd)
4015 unformat_input_t _line_input, *line_input = &_line_input;
4017 /* Get a line of input. */
4018 if (!unformat_user (input, unformat_line_input, line_input))
4020 vlib_cli_output (vm, "");
4024 vlib_cli_output (vm, "%v", line_input->buffer);
4026 unformat_free (line_input);
4031 VLIB_CLI_COMMAND (cli_unix_echo_cmd, static) = {
4033 .short_help = "echo <rest-of-line>",
4034 .function = echo_cmd,
4038 static clib_error_t *
4039 define_cmd_fn (vlib_main_t * vm,
4040 unformat_input_t * input, vlib_cli_command_t * cmd)
4043 unformat_input_t _line_input, *line_input = &_line_input;
4044 clib_macro_main_t *mm = get_macro_main ();
4045 clib_error_t *error;
4047 if (!unformat (input, "%s", ¯o_name))
4048 return clib_error_return (0, "missing variable name...");
4050 /* Remove white space */
4051 (void) unformat (input, "");
4053 /* Get a line of input. */
4054 if (!unformat_user (input, unformat_line_input, line_input))
4056 error = clib_error_return (0, "missing value for '%s'...", macro_name);
4057 vec_free (macro_name);
4060 /* the macro expander expects c-strings, not vectors... */
4061 vec_add1 (line_input->buffer, 0);
4062 clib_macro_set_value (mm, (char *) macro_name, (char *) line_input->buffer);
4063 vec_free (macro_name);
4064 unformat_free (line_input);
4069 VLIB_CLI_COMMAND (define_cmd, static) = {
4071 .short_help = "define <variable-name> <value>",
4072 .function = define_cmd_fn,
4077 static clib_error_t *
4078 undefine_cmd_fn (vlib_main_t * vm,
4079 unformat_input_t * input, vlib_cli_command_t * cmd)
4082 clib_macro_main_t *mm = get_macro_main ();
4084 if (!unformat (input, "%s", ¯o_name))
4085 return clib_error_return (0, "missing variable name...");
4087 if (clib_macro_unset (mm, (char *) macro_name))
4088 vlib_cli_output (vm, "%s wasn't set...", macro_name);
4090 vec_free (macro_name);
4095 VLIB_CLI_COMMAND (undefine_cmd, static) = {
4097 .short_help = "undefine <variable-name>",
4098 .function = undefine_cmd_fn,
4102 static clib_error_t *
4103 show_macro_cmd_fn (vlib_main_t * vm,
4104 unformat_input_t * input, vlib_cli_command_t * cmd)
4106 clib_macro_main_t *mm = get_macro_main ();
4109 if (unformat (input, "noevaluate %=", &evaluate, 0))
4111 else if (unformat (input, "noeval %=", &evaluate, 0))
4114 vlib_cli_output (vm, "%U", format_clib_macro_main, mm, evaluate);
4119 VLIB_CLI_COMMAND (show_macro, static) = {
4120 .path = "show macro",
4121 .short_help = "show macro [noevaluate]",
4122 .function = show_macro_cmd_fn,
4126 static clib_error_t *
4127 unix_cli_init (vlib_main_t * vm)
4129 unix_cli_main_t *cm = &unix_cli_main;
4131 /* Breadcrumb to indicate the new session process
4132 * has not been started */
4133 cm->new_session_process_node_index = ~0;
4134 clib_macro_init (&cm->macro_main);
4139 VLIB_INIT_FUNCTION (unix_cli_init);
4142 * fd.io coding-style-patch-verification: ON
4145 * eval: (c-set-style "gnu")