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 events. */
455 UNIX_CLI_PROCESS_EVENT_READ_READY, /**< A file descriptor has data to be read. */
456 UNIX_CLI_PROCESS_EVENT_QUIT, /**< A CLI session wants to close. */
457 } unix_cli_process_event_type_t;
459 /** CLI session telnet negotiation timer events. */
462 UNIX_CLI_NEW_SESSION_EVENT_ADD, /**< Add a CLI session to the new session list */
463 } unix_cli_timeout_event_type_t;
465 /** Each new session is stored on a list with a deadline after which
466 * a prompt is issued, in case the session TELNET negotiation fails to
470 uword cf_index; /**< Session index of the new session. */
471 f64 deadline; /**< Deadline after which the new session must have a prompt. */
472 } unix_cli_new_session_t;
474 /** CLI global state. */
477 /** Prompt string for CLI. */
480 /** Vec pool of CLI sessions. */
481 unix_cli_file_t *cli_file_pool;
483 /** Vec pool of unused session indices. */
484 u32 *unused_cli_process_node_indices;
486 /** The session index of the stdin cli */
487 u32 stdin_cli_file_index;
489 /** File pool index of current input. */
490 u32 current_input_file_index;
492 /** New session process node identifier */
493 u32 new_session_process_node_index;
495 /** List of new sessions */
496 unix_cli_new_session_t *new_sessions;
498 /** system default macro table */
499 clib_macro_main_t macro_main;
503 /** CLI global state */
504 static unix_cli_main_t unix_cli_main;
506 /** Return the macro main / tables we should use for this session
508 static clib_macro_main_t *
509 get_macro_main (void)
511 unix_cli_main_t *cm = &unix_cli_main;
512 vlib_main_t *vm = vlib_get_main ();
513 vlib_process_t *cp = vlib_get_current_process (vm);
516 if (pool_is_free_index (cm->cli_file_pool, cp->output_function_arg))
517 return (&cm->macro_main);
519 cf = pool_elt_at_index (cm->cli_file_pool, cp->output_function_arg);
521 return (&cf->macro_main);
525 * @brief Search for a byte sequence in the action list.
527 * Searches the @ref unix_cli_parse_actions_t list in @a a for a match with
528 * the bytes in @a input of maximum length @a ilen bytes.
529 * When a match is made @a *matched indicates how many bytes were matched.
530 * Returns a value from the enum @ref unix_cli_parse_action_t to indicate
531 * whether no match was found, a partial match was found or a complete
532 * match was found and what action, if any, should be taken.
534 * @param[in] a Actions list to search within.
535 * @param[in] input String fragment to search for.
536 * @param[in] ilen Length of the string in 'input'.
537 * @param[out] matched Pointer to an integer that will contain the number
538 * of bytes matched when a complete match is found.
540 * @return Action from @ref unix_cli_parse_action_t that the string fragment
542 * @ref UNIX_CLI_PARSE_ACTION_PARTIALMATCH is returned when the
543 * whole input string matches the start of at least one action.
544 * @ref UNIX_CLI_PARSE_ACTION_NOMATCH is returned when there is no
547 static unix_cli_parse_action_t
548 unix_cli_match_action (unix_cli_parse_actions_t * a,
549 u8 * input, u32 ilen, i32 * matched)
557 /* see if the start of the input buffer exactly matches the current
559 if (memcmp (input, a->input, a->len) == 0)
567 /* if the first ilen characters match, flag this as a partial -
568 * meaning keep collecting bytes in case of a future match */
569 if (memcmp (input, a->input, ilen) == 0)
573 /* check next action */
578 UNIX_CLI_PARSE_ACTION_PARTIALMATCH : UNIX_CLI_PARSE_ACTION_NOMATCH;
582 /** Add bytes to the output vector and then flagg the I/O system that bytes
583 * are available to be sent.
586 unix_cli_add_pending_output (clib_file_t * uf,
587 unix_cli_file_t * cf,
588 u8 * buffer, uword buffer_bytes)
590 clib_file_main_t *fm = &file_main;
592 vec_add (cf->output_vector, buffer, buffer_bytes);
593 if (vec_len (cf->output_vector) > 0)
595 int skip_update = 0 != (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
596 uf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
598 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
602 /** Delete all bytes from the output vector and flag the I/O system
603 * that no more bytes are available to be sent.
606 unix_cli_del_pending_output (clib_file_t * uf,
607 unix_cli_file_t * cf, uword n_bytes)
609 clib_file_main_t *fm = &file_main;
611 vec_delete (cf->output_vector, n_bytes, 0);
612 if (vec_len (cf->output_vector) <= 0)
614 int skip_update = 0 == (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
615 uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
617 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
621 /** @brief A bit like strchr with a buffer length limit.
622 * Search a buffer for the first instance of a character up to the limit of
623 * the buffer length. If found then return the position of that character.
625 * The key departure from strchr is that if the character is not found then
626 * return the buffer length.
628 * @param chr The byte value to search for.
629 * @param str The buffer in which to search for the value.
630 * @param len The depth into the buffer to search.
632 * @return The index of the first occurrence of \c chr. If \c chr is not
633 * found then \c len instead.
636 unix_vlib_findchr (u8 chr, u8 * str, word len)
639 for (i = 0; i < len; i++, str++)
647 /** @brief Send a buffer to the CLI stream if possible, enqueue it otherwise.
648 * Attempts to write given buffer to the file descriptor of the given
649 * Unix CLI session. If that session already has data in the output buffer
650 * or if the write attempt tells us to try again later then the given buffer
651 * is appended to the pending output buffer instead.
653 * This is typically called only from \c unix_vlib_cli_output_cooked since
654 * that is where CRLF handling occurs or from places where we explicitly do
655 * not want cooked handling.
657 * @param cf Unix CLI session of the desired stream to write to.
658 * @param uf The Unix file structure of the desired stream to write to.
659 * @param buffer Pointer to the buffer that needs to be written.
660 * @param buffer_bytes The number of bytes from \c buffer to write.
663 unix_vlib_cli_output_raw (unix_cli_file_t * cf,
664 clib_file_t * uf, u8 * buffer, uword buffer_bytes)
668 if (cf->has_epipe) /* don't try writing anything */
671 if (vec_len (cf->output_vector) == 0)
674 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
675 n = send (uf->file_descriptor, buffer, buffer_bytes, MSG_NOSIGNAL);
677 n = write (uf->file_descriptor, buffer, buffer_bytes);
680 if (n < 0 && errno != EAGAIN)
684 /* connection closed on us */
685 unix_main_t *um = &unix_main;
687 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
688 UNIX_CLI_PROCESS_EVENT_QUIT,
693 clib_unix_warning ("write");
696 else if ((word) n < (word) buffer_bytes)
698 /* We got EAGAIN or we already have stuff in the buffer;
699 * queue up whatever didn't get sent for later. */
702 unix_cli_add_pending_output (uf, cf, buffer + n, buffer_bytes - n);
706 /** @brief Process a buffer for CRLF handling before outputting it to the CLI.
708 * @param cf Unix CLI session of the desired stream to write to.
709 * @param uf The Unix file structure of the desired stream to write to.
710 * @param buffer Pointer to the buffer that needs to be written.
711 * @param buffer_bytes The number of bytes from \c buffer to write.
714 unix_vlib_cli_output_cooked (unix_cli_file_t * cf,
716 u8 * buffer, uword buffer_bytes)
718 word end = 0, start = 0;
720 while (end < buffer_bytes)
724 /* iterate the line on \n's so we can insert a \r before it */
725 end = unix_vlib_findchr ('\n',
727 buffer_bytes - start) + start;
731 /* otherwise just send the whole buffer */
735 unix_vlib_cli_output_raw (cf, uf, buffer + start, end - start);
739 if (end < buffer_bytes)
741 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\r\n", 2);
742 end++; /* skip the \n that we already sent */
748 /* Use the last character to determine the last direction of the cursor. */
749 if (buffer_bytes > 0)
750 cf->cursor_direction = (buffer[buffer_bytes - 1] == (u8) '\b');
753 /** @brief Moves the terminal cursor one character to the left, with
754 * special handling when it reaches the left edge of the terminal window.
756 * Ordinarily we can simply send a '\b' to move the cursor left, however
757 * most terminals will not reverse-wrap to the end of the previous line
758 * if the cursor is in the left-most column. To counter this we must
759 * check the cursor position + prompt length modulo terminal width and
760 * if available use some other means, such as ANSI terminal escape
761 * sequences, to move the cursor.
763 * @param cf Unix CLI session of the desired stream to write to.
764 * @param uf The Unix file structure of the desired stream to write to.
767 unix_vlib_cli_output_cursor_left (unix_cli_file_t * cf, clib_file_t * uf)
769 unix_cli_main_t *cm = &unix_cli_main;
770 static u8 *ansi = 0; /* assumes no reentry */
773 if (!cf->is_interactive || !cf->ansi_capable || !cf->width)
775 /* No special handling for dumb terminals */
776 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
780 position = ((u32) vec_len (cm->cli_prompt) + cf->cursor) % cf->width;
784 /* No special handling required if we're not at the left edge */
785 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
789 if (!cf->cursor_direction)
791 /* Special handling for when we are at the left edge but
792 * the cursor was going left-to-right, but in this situation
793 * xterm-like terminals actually hide the cursor off the right
794 * edge. A \b here seems to jump one char too many, so let's
795 * force the cursor onto the next line instead.
797 if (cf->cursor < vec_len (cf->current_command))
798 unix_vlib_cli_output_cooked (cf, uf, &cf->current_command[cf->cursor],
801 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
802 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
805 /* Relocate the cursor at the right hand edge one line above */
806 ansi = format (ansi, CSI "A" CSI "%dC", cf->width - 1);
807 unix_vlib_cli_output_cooked (cf, uf, ansi, vec_len (ansi));
808 vec_reset_length (ansi); /* keep the vec around for next time */
809 cf->cursor_direction = 1; /* going backwards now */
812 /** @brief Output the CLI prompt */
814 unix_cli_cli_prompt (unix_cli_file_t * cf, clib_file_t * uf)
816 unix_cli_main_t *cm = &unix_cli_main;
818 if (cf->is_interactive) /* Only interactive sessions get a prompt */
819 unix_vlib_cli_output_raw (cf, uf, cm->cli_prompt,
820 vec_len (cm->cli_prompt));
823 /** @brief Output a pager prompt and show number of buffered lines */
825 unix_cli_pager_prompt (unix_cli_file_t * cf, clib_file_t * uf)
830 h = cf->pager_start + (cf->height - 1);
831 if (h > vec_len (cf->pager_index))
832 h = vec_len (cf->pager_index);
834 prompt = format (0, "\r%s-- more -- (%d-%d/%d)%s",
835 cf->ansi_capable ? ANSI_BOLD : "",
838 vec_len (cf->pager_index),
839 cf->ansi_capable ? ANSI_RESET : "");
841 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
846 /** @brief Output a pager "skipping" message */
848 unix_cli_pager_message (unix_cli_file_t * cf, clib_file_t * uf,
849 char *message, char *postfix)
853 prompt = format (0, "\r%s-- %s --%s%s",
854 cf->ansi_capable ? ANSI_BOLD : "",
855 message, cf->ansi_capable ? ANSI_RESET : "", postfix);
857 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
862 /** @brief Erase the printed pager prompt */
864 unix_cli_pager_prompt_erase (unix_cli_file_t * cf, clib_file_t * uf)
866 if (cf->ansi_capable)
868 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
869 unix_vlib_cli_output_cooked (cf, uf,
870 (u8 *) ANSI_CLEARLINE,
871 sizeof (ANSI_CLEARLINE) - 1);
877 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
878 for (i = 0; i < cf->width - 1; i++)
879 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
880 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
884 /** @brief Uses an ANSI escape sequence to move the cursor */
886 unix_cli_ansi_cursor (unix_cli_file_t * cf, clib_file_t * uf, u16 x, u16 y)
890 str = format (0, "%s%d;%dH", CSI, y, x);
892 unix_vlib_cli_output_cooked (cf, uf, str, vec_len (str));
897 /** Redraw the currently displayed page of text.
898 * @param cf CLI session to redraw the pager buffer of.
899 * @param uf Unix file of the CLI session.
902 unix_cli_pager_redraw (unix_cli_file_t * cf, clib_file_t * uf)
904 unix_cli_pager_index_t *pi = NULL;
908 /* No active pager? Do nothing. */
909 if (!vec_len (cf->pager_index))
912 if (cf->ansi_capable)
914 /* If we have ANSI, send the clear screen sequence */
915 unix_vlib_cli_output_cooked (cf, uf,
917 sizeof (ANSI_CLEAR) - 1);
921 /* Otherwise make sure we're on a blank line */
922 unix_cli_pager_prompt_erase (cf, uf);
925 /* (Re-)send the current page of content */
926 for (i = 0; i < cf->height - 1 &&
927 i + cf->pager_start < vec_len (cf->pager_index); i++)
929 pi = &cf->pager_index[cf->pager_start + i];
930 line = cf->pager_vector[pi->line] + pi->offset;
932 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
934 /* if the last line didn't end in newline, add a newline */
935 if (pi && line[pi->length - 1] != '\n')
936 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
938 unix_cli_pager_prompt (cf, uf);
941 /** @brief Process and add a line to the pager index.
942 * In normal operation this function will take the given character string
943 * found in @c line and with length @c len_or_index and iterates the over the
944 * contents, adding each line of text discovered within it to the
945 * pager index. Lines are identified by newlines ("<code>\\n</code>") and by
946 * strings longer than the width of the terminal.
948 * If instead @c line is @c NULL then @c len_or_index is taken to mean the
949 * index of an existing line in the pager buffer; this simply means that the
950 * input line does not need to be cloned since we already have it. This is
951 * typical if we are reindexing the pager buffer.
953 * @param cf The CLI session whose pager we are adding to.
954 * @param line The string of text to be indexed into the pager buffer.
955 * If @c line is @c NULL then the mode of operation
956 * changes slightly; see the description above.
957 * @param len_or_index If @c line is a pointer to a string then this parameter
958 * indicates the length of that string; Otherwise this
959 * value provides the index in the pager buffer of an
960 * existing string to be indexed.
963 unix_cli_pager_add_line (unix_cli_file_t * cf, u8 * line, word len_or_index)
967 word line_index, len;
968 u32 width = cf->width;
969 unix_cli_pager_index_t *pi;
973 /* Use a line already in the pager buffer */
974 line_index = len_or_index;
975 if (cf->pager_vector != NULL)
976 p = cf->pager_vector[line_index];
982 /* Add a copy of the raw string to the pager buffer */
983 p = vec_new (u8, len);
984 clib_memcpy (p, line, len);
986 /* store in pager buffer */
987 line_index = vec_len (cf->pager_vector);
988 vec_add1 (cf->pager_vector, p);
994 /* Find the next line, or run to terminal width, or run to EOL */
996 j = unix_vlib_findchr ((u8) '\n', p, l < width ? l : width);
998 if (j < l && p[j] == '\n') /* incl \n */
1001 /* Add the line to the index */
1002 k = vec_len (cf->pager_index);
1003 vec_validate (cf->pager_index, k);
1004 pi = &cf->pager_index[k];
1006 pi->line = line_index;
1015 /** @brief Reindex entire pager buffer.
1016 * Resets the current pager index and then re-adds the lines in the pager
1017 * buffer to the index.
1019 * Additionally this function attempts to retain the current page start
1020 * line offset by searching for the same top-of-screen line in the new index.
1022 * @param cf The CLI session whose pager buffer should be reindexed.
1025 unix_cli_pager_reindex (unix_cli_file_t * cf)
1027 word i, old_line, old_offset;
1028 unix_cli_pager_index_t *pi;
1030 /* If there is nothing in the pager buffer then make sure the index
1031 * is empty and move on.
1033 if (cf->pager_vector == 0)
1035 vec_reset_length (cf->pager_index);
1039 /* Retain a pointer to the current page start line so we can
1042 pi = &cf->pager_index[cf->pager_start];
1043 old_line = pi->line;
1044 old_offset = pi->offset;
1046 /* Re-add the buffered lines to the index */
1047 vec_reset_length (cf->pager_index);
1048 vec_foreach_index (i, cf->pager_vector)
1050 unix_cli_pager_add_line (cf, NULL, i);
1053 /* Attempt to re-locate the previously stored page start line */
1054 vec_foreach_index (i, cf->pager_index)
1056 pi = &cf->pager_index[i];
1058 if (pi->line == old_line &&
1059 (pi->offset <= old_offset || pi->offset + pi->length > old_offset))
1062 cf->pager_start = i;
1067 /* In case the start line was not found (rare), ensure the pager start
1068 * index is within bounds
1070 if (cf->pager_start >= vec_len (cf->pager_index))
1072 if (!cf->height || vec_len (cf->pager_index) < (cf->height - 1))
1073 cf->pager_start = 0;
1075 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
1079 /** VLIB CLI output function.
1081 * If the terminal has a pager configured then this function takes care
1082 * of collating output into the pager buffer; ensuring only the first page
1083 * is displayed and any lines in excess of the first page are buffered.
1085 * If the maximum number of index lines in the buffer is exceeded then the
1086 * pager is cancelled and the contents of the current buffer are sent to the
1089 * If there is no pager configured then the output is sent directly to the
1092 * @param cli_file_index Index of the CLI session where this output is
1094 * @param buffer String of printabe bytes to be output.
1095 * @param buffer_bytes The number of bytes in @c buffer to be output.
1098 unix_vlib_cli_output (uword cli_file_index, u8 * buffer, uword buffer_bytes)
1100 unix_main_t *um = &unix_main;
1101 clib_file_main_t *fm = &file_main;
1102 unix_cli_main_t *cm = &unix_cli_main;
1103 unix_cli_file_t *cf;
1106 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
1107 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1109 if (cf->no_pager || um->cli_pager_buffer_limit == 0 || cf->height == 0)
1111 unix_vlib_cli_output_cooked (cf, uf, buffer, buffer_bytes);
1115 word row = vec_len (cf->pager_index);
1117 unix_cli_pager_index_t *pi;
1119 /* Index and add the output lines to the pager buffer. */
1120 unix_cli_pager_add_line (cf, buffer, buffer_bytes);
1122 /* Now iterate what was added to display the lines.
1123 * If we reach the bottom of the page, display a prompt.
1125 while (row < vec_len (cf->pager_index))
1127 if (row < cf->height - 1)
1129 /* output this line */
1130 pi = &cf->pager_index[row];
1131 line = cf->pager_vector[pi->line] + pi->offset;
1132 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1134 /* if the last line didn't end in newline, and we're at the
1135 * bottom of the page, add a newline */
1136 if (line[pi->length - 1] != '\n' && row == cf->height - 2)
1137 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1141 /* Display the pager prompt every 10 lines */
1143 unix_cli_pager_prompt (cf, uf);
1148 /* Check if we went over the pager buffer limit */
1149 if (vec_len (cf->pager_index) > um->cli_pager_buffer_limit)
1151 /* Stop using the pager for the remainder of this CLI command */
1154 /* If we likely printed the prompt, erase it */
1155 if (vec_len (cf->pager_index) > cf->height - 1)
1156 unix_cli_pager_prompt_erase (cf, uf);
1158 /* Dump out the contents of the buffer */
1159 for (row = cf->pager_start + (cf->height - 1);
1160 row < vec_len (cf->pager_index); row++)
1162 pi = &cf->pager_index[row];
1163 line = cf->pager_vector[pi->line] + pi->offset;
1164 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1167 unix_cli_pager_reset (cf);
1172 /** Identify whether a terminal type is ANSI capable.
1174 * Compares the string given in @c term with a list of terminal types known
1175 * to support ANSI escape sequences.
1177 * This list contains, for example, @c xterm, @c screen and @c ansi.
1179 * @param term A string with a terminal type in it.
1180 * @param len The length of the string in @c term.
1182 * @return @c 1 if the terminal type is recognized as supporting ANSI
1183 * terminal sequences; @c 0 otherwise.
1186 unix_cli_terminal_type_ansi (u8 * term, uword len)
1188 /* This may later be better done as a hash of some sort. */
1190 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1195 _("xterm-256color"); /* iTerm on Mac */
1197 _("screen-256color"); /* Screen and tmux */
1198 _("ansi"); /* Microsoft Telnet */
1204 /** Identify whether a terminal type is non-interactive.
1206 * Compares the string given in @c term with a list of terminal types known
1207 * to be non-interactive, as send by tools such as @c vppctl .
1209 * This list contains, for example, @c vppctl.
1211 * @param term A string with a terminal type in it.
1212 * @param len The length of the string in @c term.
1214 * @return @c 1 if the terminal type is recognized as being non-interactive;
1218 unix_cli_terminal_type_noninteractive (u8 * term, uword len)
1220 /* This may later be better done as a hash of some sort. */
1222 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1231 /** Set a session to be non-interactive. */
1233 unix_cli_set_session_noninteractive (unix_cli_file_t * cf)
1235 /* Non-interactive sessions don't get these */
1236 cf->is_interactive = 0;
1238 cf->history_limit = 0;
1239 cf->has_history = 0;
1243 /** @brief Emit initial welcome banner and prompt on a connection. */
1245 unix_cli_file_welcome (unix_cli_main_t * cm, unix_cli_file_t * cf)
1247 unix_main_t *um = &unix_main;
1248 clib_file_main_t *fm = &file_main;
1249 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
1250 unix_cli_banner_t *banner;
1253 /* Mark the session as started if we get here */
1256 if (!(cf->is_interactive)) /* No banner for non-interactive sessions */
1260 * Put the first bytes directly into the buffer so that further output is
1261 * queued until everything is ready. (oterwise initial prompt can appear
1262 * mid way through VPP initialization)
1264 unix_cli_add_pending_output (uf, cf, (u8 *) "\r", 1);
1266 if (!um->cli_no_banner && (um->flags & UNIX_FLAG_NOBANNER) == 0)
1268 if (cf->ansi_capable && (um->flags & UNIX_FLAG_NOCOLOR) == 0)
1270 banner = unix_cli_banner_color;
1271 len = ARRAY_LEN (unix_cli_banner_color);
1275 banner = unix_cli_banner;
1276 len = ARRAY_LEN (unix_cli_banner);
1279 for (i = 0; i < len; i++)
1281 unix_vlib_cli_output_cooked (cf, uf,
1282 banner[i].line, banner[i].length);
1287 unix_cli_cli_prompt (cf, uf);
1292 * @brief A failsafe manager that ensures CLI sessions issue an initial
1293 * prompt if TELNET negotiation fails.
1296 unix_cli_new_session_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1299 unix_cli_main_t *cm = &unix_cli_main;
1300 uword event_type, *event_data = 0;
1305 if (vec_len (cm->new_sessions) > 0)
1306 wait = vlib_process_wait_for_event_or_clock (vm, wait);
1308 vlib_process_wait_for_event (vm);
1310 event_type = vlib_process_get_events (vm, &event_data);
1314 case ~0: /* no events => timeout */
1317 case UNIX_CLI_NEW_SESSION_EVENT_ADD:
1319 /* Add an identifier to the new session list */
1320 unix_cli_new_session_t ns;
1322 ns.cf_index = event_data[0];
1323 ns.deadline = vlib_time_now (vm) + 1.0;
1325 vec_add1 (cm->new_sessions, ns);
1328 wait = 0.1; /* force a re-evaluation soon, but not too soon */
1333 clib_warning ("BUG: unknown event type 0x%wx", event_type);
1337 vec_reset_length (event_data);
1339 if (vlib_process_suspend_time_is_zero (wait))
1341 /* Scan the list looking for expired deadlines.
1342 * Emit needed prompts and remove from the list.
1343 * While scanning, look for the nearest new deadline
1344 * for the next iteration.
1345 * Since the list is ordered with newest sessions first
1346 * we can make assumptions about expired sessions being
1347 * contiguous at the beginning and the next deadline is the
1348 * next entry on the list, if any.
1350 f64 now = vlib_time_now (vm);
1351 unix_cli_new_session_t *nsp;
1356 vec_foreach (nsp, cm->new_sessions)
1358 if (vlib_process_suspend_time_is_zero (nsp->deadline - now))
1360 /* Deadline reached */
1361 unix_cli_file_t *cf;
1363 /* Mark the highwater */
1366 /* Check the connection didn't close already */
1367 if (pool_is_free_index (cm->cli_file_pool, nsp->cf_index))
1370 cf = pool_elt_at_index (cm->cli_file_pool, nsp->cf_index);
1373 unix_cli_file_welcome (cm, cf);
1377 wait = nsp->deadline - now;
1384 /* We have sessions to remove */
1385 vec_delete (cm->new_sessions, index, 0);
1394 /** @brief A mostly no-op Telnet state machine.
1395 * Process Telnet command bytes in a way that ensures we're mostly
1396 * transparent to the Telnet protocol. That is, it's mostly a no-op.
1398 * @return -1 if we need more bytes, otherwise a positive integer number of
1399 * bytes to consume from the input_vector, not including the initial
1403 unix_cli_process_telnet (unix_main_t * um,
1404 unix_cli_file_t * cf,
1405 clib_file_t * uf, u8 * input_vector, uword len)
1407 /* Input_vector starts at IAC byte.
1408 * See if we have a complete message; if not, return -1 so we wait for more.
1409 * if we have a complete message, consume those bytes from the vector.
1414 return -1; /* want more bytes */
1416 switch (input_vector[1])
1419 /* two IAC's in a row means to pass through 0xff.
1420 * since that makes no sense here, just consume it.
1429 /* Expect 3 bytes */
1431 return -1; /* want more bytes */
1438 /* Sub option - search ahead for IAC SE to end it */
1440 for (i = 3; i < len && i < UNIX_CLI_MAX_DEPTH_TELNET; i++)
1442 if (input_vector[i - 1] == IAC && input_vector[i] == SE)
1444 /* We have a complete message; see if we care about it */
1445 switch (input_vector[2])
1448 if (input_vector[3] != 0)
1451 /* See if the the terminal type is recognized */
1452 u8 *term = input_vector + 4;
1455 /* See if the terminal type is ANSI capable */
1457 unix_cli_terminal_type_ansi (term, len);
1459 /* See if the terminal type indicates non-interactive */
1460 if (unix_cli_terminal_type_noninteractive (term, len))
1461 unix_cli_set_session_noninteractive (cf);
1464 /* If session not started, we can release the pause */
1466 /* Send the welcome banner and initial prompt */
1467 unix_cli_file_welcome (&unix_cli_main, cf);
1472 if (i != 8) /* check message is correct size */
1476 clib_net_to_host_u16 (*((u16 *) (input_vector + 3)));
1477 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
1478 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
1480 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
1483 clib_net_to_host_u16 (*((u16 *) (input_vector + 5)));
1484 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
1485 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
1486 if (cf->height == 0)
1487 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
1489 /* reindex pager buffer */
1490 unix_cli_pager_reindex (cf);
1492 unix_cli_pager_redraw (cf, uf);
1498 /* Consume it all */
1504 if (i == UNIX_CLI_MAX_DEPTH_TELNET)
1505 consume = 1; /* hit max search depth, advance one byte */
1508 return -1; /* want more bytes */
1526 /* Simple one-byte messages */
1531 /* Are You There - trigger a visible response */
1533 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "fd.io VPP\n", 10);
1537 /* Unknown command! Eat the IAC byte */
1544 /** @brief Process actionable input.
1545 * Based on the \c action process the input; this typically involves
1546 * searching the command history or editing the current command line.
1549 unix_cli_line_process_one (unix_cli_main_t * cm,
1551 unix_cli_file_t * cf,
1553 u8 input, unix_cli_parse_action_t action)
1557 u8 **possible_commands;
1562 case UNIX_CLI_PARSE_ACTION_NOACTION:
1565 case UNIX_CLI_PARSE_ACTION_REVSEARCH:
1566 case UNIX_CLI_PARSE_ACTION_FWDSEARCH:
1567 if (!cf->has_history || !cf->history_limit)
1569 if (cf->search_mode == 0)
1571 /* Erase the current command (if any) */
1572 for (; cf->cursor > 0; cf->cursor--)
1574 unix_vlib_cli_output_cursor_left (cf, uf);
1575 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1576 unix_vlib_cli_output_cursor_left (cf, uf);
1579 vec_reset_length (cf->search_key);
1580 vec_reset_length (cf->current_command);
1582 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1583 cf->search_mode = -1;
1585 cf->search_mode = 1;
1589 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1590 cf->search_mode = -1;
1592 cf->search_mode = 1;
1594 cf->excursion += cf->search_mode;
1599 case UNIX_CLI_PARSE_ACTION_ERASELINELEFT:
1600 /* Erase the command from the cursor to the start */
1603 /* Shimmy backwards to the new end of line position */
1604 delta = vec_len (cf->current_command) - cf->cursor;
1605 for (; cf->cursor > delta; cf->cursor--)
1606 unix_vlib_cli_output_cursor_left (cf, uf);
1607 /* Zap from here to the end of what is currently displayed */
1608 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1609 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1610 /* Get back to the start of the line */
1611 for (; cf->cursor > 0; cf->cursor--)
1612 unix_vlib_cli_output_cursor_left (cf, uf);
1614 /* Delete the desired text from the command */
1615 memmove (cf->current_command, cf->current_command + j, delta);
1616 _vec_len (cf->current_command) = delta;
1618 /* Print the new contents */
1619 unix_vlib_cli_output_cooked (cf, uf, cf->current_command, delta);
1620 cf->cursor = delta; /* for backspace tracking */
1622 /* Shimmy back to the start */
1623 for (; cf->cursor > 0; cf->cursor--)
1624 unix_vlib_cli_output_cursor_left (cf, uf);
1626 cf->search_mode = 0;
1629 case UNIX_CLI_PARSE_ACTION_ERASELINERIGHT:
1630 /* Erase the command from the cursor to the end */
1633 /* Zap from cursor to end of what is currently displayed */
1634 for (; cf->cursor < (vec_len (cf->current_command)); cf->cursor++)
1635 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1636 /* Get back to where we were */
1637 for (; cf->cursor > j; cf->cursor--)
1638 unix_vlib_cli_output_cursor_left (cf, uf);
1640 /* Truncate the line at the cursor */
1641 _vec_len (cf->current_command) = cf->cursor;
1643 cf->search_mode = 0;
1646 case UNIX_CLI_PARSE_ACTION_ERASEWORDLEFT:
1647 /* calculate num of caracter to be erased */
1649 while (cf->cursor > delta
1650 && cf->current_command[cf->cursor - delta - 1] == ' ')
1652 while (cf->cursor > delta
1653 && cf->current_command[cf->cursor - delta - 1] != ' ')
1656 if (vec_len (cf->current_command))
1660 /* move cursor left delta times */
1661 for (j = delta; j > 0; j--, cf->cursor--)
1662 unix_vlib_cli_output_cursor_left (cf, uf);
1663 save = cf->current_command + cf->cursor;
1665 /* redraw remainder of line */
1666 memmove (cf->current_command + cf->cursor,
1667 cf->current_command + cf->cursor + delta,
1668 _vec_len (cf->current_command) - cf->cursor - delta);
1669 unix_vlib_cli_output_cooked (cf, uf,
1670 cf->current_command + cf->cursor,
1671 _vec_len (cf->current_command) -
1673 cf->cursor += _vec_len (cf->current_command) - cf->cursor;
1675 /* print delta amount of blank spaces,
1676 * then finally fix the cursor position */
1677 for (j = delta; j > 0; j--, cf->cursor--)
1678 unix_vlib_cli_output_cursor_left (cf, uf);
1679 for (j = delta; j > 0; j--, cf->cursor++)
1680 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1681 for (; (cf->current_command + cf->cursor) > save; cf->cursor--)
1682 unix_vlib_cli_output_cursor_left (cf, uf);
1683 _vec_len (cf->current_command) -= delta;
1686 cf->search_mode = 0;
1688 vec_reset_length (cf->search_key);
1691 case UNIX_CLI_PARSE_ACTION_LEFT:
1694 unix_vlib_cli_output_cursor_left (cf, uf);
1698 cf->search_mode = 0;
1701 case UNIX_CLI_PARSE_ACTION_RIGHT:
1702 if (cf->cursor < vec_len (cf->current_command))
1704 /* have to emit the character under the cursor */
1705 unix_vlib_cli_output_cooked (cf, uf,
1706 cf->current_command + cf->cursor, 1);
1710 cf->search_mode = 0;
1713 case UNIX_CLI_PARSE_ACTION_UP:
1714 case UNIX_CLI_PARSE_ACTION_DOWN:
1715 if (!cf->has_history || !cf->history_limit)
1717 cf->search_mode = 0;
1718 /* Erase the command */
1719 for (; cf->cursor < vec_len (cf->current_command); cf->cursor++)
1720 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1721 for (; cf->cursor > 0; cf->cursor--)
1723 unix_vlib_cli_output_cursor_left (cf, uf);
1724 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1725 unix_vlib_cli_output_cursor_left (cf, uf);
1727 vec_reset_length (cf->current_command);
1728 if (vec_len (cf->command_history))
1730 if (action == UNIX_CLI_PARSE_ACTION_UP)
1735 cf->excursion += delta;
1737 if (cf->excursion == vec_len (cf->command_history))
1739 /* down-arrowed to last entry - want a blank line */
1740 _vec_len (cf->current_command) = 0;
1742 else if (cf->excursion < 0)
1744 /* up-arrowed over the start to the end, want a blank line */
1745 cf->excursion = vec_len (cf->command_history);
1746 _vec_len (cf->current_command) = 0;
1750 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1751 /* down-arrowed past end - wrap to start */
1754 /* Print the command at the current position */
1755 prev = cf->command_history[cf->excursion];
1756 vec_validate (cf->current_command, vec_len (prev) - 1);
1758 clib_memcpy (cf->current_command, prev, vec_len (prev));
1759 _vec_len (cf->current_command) = vec_len (prev);
1760 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1761 vec_len (cf->current_command));
1764 cf->cursor = vec_len (cf->current_command);
1767 case UNIX_CLI_PARSE_ACTION_HOME:
1768 if (vec_len (cf->current_command) && cf->cursor > 0)
1770 for (; cf->cursor > 0; cf->cursor--)
1771 unix_vlib_cli_output_cursor_left (cf, uf);
1774 cf->search_mode = 0;
1777 case UNIX_CLI_PARSE_ACTION_END:
1778 if (vec_len (cf->current_command) &&
1779 cf->cursor < vec_len (cf->current_command))
1781 unix_vlib_cli_output_cooked (cf, uf,
1782 cf->current_command + cf->cursor,
1783 vec_len (cf->current_command) -
1785 cf->cursor = vec_len (cf->current_command);
1788 cf->search_mode = 0;
1791 case UNIX_CLI_PARSE_ACTION_WORDLEFT:
1792 if (vec_len (cf->current_command) && cf->cursor > 0)
1794 unix_vlib_cli_output_cursor_left (cf, uf);
1797 while (cf->cursor && isspace (cf->current_command[cf->cursor]))
1799 unix_vlib_cli_output_cursor_left (cf, uf);
1802 while (cf->cursor && !isspace (cf->current_command[cf->cursor]))
1804 if (isspace (cf->current_command[cf->cursor - 1]))
1806 unix_vlib_cli_output_cursor_left (cf, uf);
1812 cf->search_mode = 0;
1815 case UNIX_CLI_PARSE_ACTION_WORDRIGHT:
1816 if (vec_len (cf->current_command) &&
1817 cf->cursor < vec_len (cf->current_command))
1819 int e = vec_len (cf->current_command);
1821 while (j < e && !isspace (cf->current_command[j]))
1823 while (j < e && isspace (cf->current_command[j]))
1825 unix_vlib_cli_output_cooked (cf, uf,
1826 cf->current_command + cf->cursor,
1831 cf->search_mode = 0;
1835 case UNIX_CLI_PARSE_ACTION_ERASE:
1836 if (vec_len (cf->current_command))
1838 if (cf->cursor == vec_len (cf->current_command))
1840 unix_vlib_cli_output_cursor_left (cf, uf);
1842 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1844 unix_vlib_cli_output_cursor_left (cf, uf);
1846 _vec_len (cf->current_command)--;
1848 else if (cf->cursor > 0)
1850 /* shift everything at & to the right of the cursor left by 1 */
1851 j = vec_len (cf->current_command) - cf->cursor;
1852 memmove (cf->current_command + cf->cursor - 1,
1853 cf->current_command + cf->cursor, j);
1854 _vec_len (cf->current_command)--;
1856 /* redraw the rest of the line */
1857 unix_vlib_cli_output_cursor_left (cf, uf);
1859 unix_vlib_cli_output_cooked (cf, uf,
1860 cf->current_command + cf->cursor,
1863 /* erase last char */
1864 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1867 /* and shift the terminal cursor back where it should be */
1868 j += 2; /* account for old string length and offset position */
1871 unix_vlib_cli_output_cursor_left (cf, uf);
1876 cf->search_mode = 0;
1878 vec_reset_length (cf->search_key);
1881 case UNIX_CLI_PARSE_ACTION_ERASERIGHT:
1882 if (vec_len (cf->current_command))
1884 if (cf->cursor < vec_len (cf->current_command))
1886 /* shift everything to the right of the cursor left by 1 */
1887 j = vec_len (cf->current_command) - cf->cursor - 1;
1888 memmove (cf->current_command + cf->cursor,
1889 cf->current_command + cf->cursor + 1, j);
1890 _vec_len (cf->current_command)--;
1891 /* redraw the rest of the line */
1892 unix_vlib_cli_output_cooked (cf, uf,
1893 cf->current_command + cf->cursor,
1896 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1898 unix_vlib_cli_output_cursor_left (cf, uf);
1900 /* and shift the terminal cursor back where it should be */
1903 unix_vlib_cli_output_cursor_left (cf, uf);
1907 unix_vlib_cli_output_cursor_left (cf, uf);
1913 else if (input == 'D' - '@')
1915 /* ^D with no command entered = quit */
1916 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "quit\n", 5);
1917 vlib_process_signal_event (um->vlib_main,
1918 vlib_current_process (um->vlib_main),
1919 UNIX_CLI_PROCESS_EVENT_QUIT,
1920 cf - cm->cli_file_pool);
1922 cf->search_mode = 0;
1924 vec_reset_length (cf->search_key);
1927 case UNIX_CLI_PARSE_ACTION_CLEAR:
1928 /* If we're in ANSI mode, clear the screen.
1929 * Then redraw the prompt and any existing command input, then put
1930 * the cursor back where it was in that line.
1932 if (cf->ansi_capable)
1933 unix_vlib_cli_output_cooked (cf, uf,
1935 sizeof (ANSI_CLEAR) - 1);
1937 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1939 unix_vlib_cli_output_raw (cf, uf,
1940 cm->cli_prompt, vec_len (cm->cli_prompt));
1941 unix_vlib_cli_output_cooked (cf, uf,
1942 cf->current_command,
1943 vec_len (cf->current_command));
1945 cf->cursor = vec_len (cf->current_command);
1946 for (; cf->cursor > j; cf->cursor--)
1947 unix_vlib_cli_output_cursor_left (cf, uf);
1951 case UNIX_CLI_PARSE_ACTION_TAB:
1952 if (cf->cursor < vec_len (cf->current_command))
1954 /* if we are in the middle of a line, complete only if
1955 * the cursor points to whitespace */
1956 if (isspace (cf->current_command[cf->cursor]))
1958 /* save and clear any input that is after the cursor */
1959 vec_resize (save, vec_len (cf->current_command) - cf->cursor);
1960 clib_memcpy (save, cf->current_command + cf->cursor,
1961 vec_len (cf->current_command) - cf->cursor);
1962 _vec_len (cf->current_command) = cf->cursor;
1966 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1971 vlib_cli_get_possible_completions (cf->current_command);
1972 if (vec_len (possible_commands) == 1)
1974 u8 *completed = possible_commands[0];
1977 /* find the last word of current_command */
1978 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1980 unix_vlib_cli_output_cursor_left (cf, uf);
1984 _vec_len (cf->current_command) = j;
1986 /* replace it with the newly expanded command */
1987 vec_append (cf->current_command, completed);
1989 /* echo to the terminal */
1990 unix_vlib_cli_output_cooked (cf, uf, completed,
1991 vec_len (completed));
1993 /* add one trailing space if needed */
1994 if (vec_len (save) == 0)
1996 vec_add1 (cf->current_command, ' ');
1997 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2000 cf->cursor = vec_len (cf->current_command);
2003 else if (vec_len (possible_commands) >= 2)
2005 u8 **possible_command;
2006 uword max_command_len = 0, min_command_len = ~0;
2009 vec_foreach (possible_command, possible_commands)
2011 if (vec_len (*possible_command) > max_command_len)
2012 max_command_len = vec_len (*possible_command);
2013 if (vec_len (*possible_command) < min_command_len)
2014 min_command_len = vec_len (*possible_command);
2017 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2020 vec_foreach (possible_command, possible_commands)
2022 if (i + max_command_len >= cf->width)
2024 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2027 unix_vlib_cli_output_cooked (cf, uf, *possible_command,
2028 vec_len (*possible_command));
2029 for (j = vec_len (*possible_command); j < max_command_len + 2;
2032 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2034 i += max_command_len + 2;
2037 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2039 /* rewrite prompt */
2040 unix_cli_cli_prompt (cf, uf);
2041 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2042 vec_len (cf->current_command));
2044 /* count length of last word */
2047 while (j >= 1 && !isspace (cf->current_command[j - 1]))
2053 /* determine smallest common command */
2054 for (; i < min_command_len; i++)
2059 vec_foreach (possible_command, possible_commands)
2063 common = (*possible_command)[i];
2065 else if (common != (*possible_command)[i])
2074 vec_add1 (cf->current_command, common);
2076 unix_vlib_cli_output_cooked (cf, uf, (u8 *) & common, 1);
2086 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
2089 if (vec_len (save) > 0)
2091 /* restore remaining input if tab was hit in the middle of a line */
2092 unix_vlib_cli_output_cooked (cf, uf, save, vec_len (save));
2093 cf->cursor += vec_len (save);
2094 for (j = 0; j < vec_len (save); j++, cf->cursor--)
2095 unix_vlib_cli_output_cursor_left (cf, uf);
2096 vec_append (cf->current_command, save);
2099 vec_free (possible_commands);
2102 case UNIX_CLI_PARSE_ACTION_YANK:
2107 case UNIX_CLI_PARSE_ACTION_PAGER_QUIT:
2109 unix_cli_pager_prompt_erase (cf, uf);
2110 unix_cli_pager_reset (cf);
2111 unix_cli_cli_prompt (cf, uf);
2114 case UNIX_CLI_PARSE_ACTION_PAGER_NEXT:
2115 case UNIX_CLI_PARSE_ACTION_PAGER_PGDN:
2116 /* show next page of the buffer */
2117 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
2120 unix_cli_pager_index_t *pi = NULL;
2122 int m = cf->pager_start + (cf->height - 1);
2123 unix_cli_pager_prompt_erase (cf, uf);
2125 j < vec_len (cf->pager_index) && cf->pager_start < m;
2126 j++, cf->pager_start++)
2128 pi = &cf->pager_index[j];
2129 line = cf->pager_vector[pi->line] + pi->offset;
2130 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2132 /* if the last line didn't end in newline, add a newline */
2133 if (pi && line[pi->length - 1] != '\n')
2134 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2135 unix_cli_pager_prompt (cf, uf);
2139 if (action == UNIX_CLI_PARSE_ACTION_PAGER_NEXT)
2140 /* no more in buffer, exit, but only if it was <space> */
2145 case UNIX_CLI_PARSE_ACTION_PAGER_DN:
2146 case UNIX_CLI_PARSE_ACTION_PAGER_CRLF:
2147 /* display the next line of the buffer */
2148 if (cf->height + cf->pager_start <= vec_len (cf->pager_index))
2151 unix_cli_pager_index_t *pi;
2153 unix_cli_pager_prompt_erase (cf, uf);
2154 pi = &cf->pager_index[cf->pager_start + (cf->height - 1)];
2155 line = cf->pager_vector[pi->line] + pi->offset;
2156 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2158 /* if the last line didn't end in newline, add a newline */
2159 if (line[pi->length - 1] != '\n')
2160 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2161 unix_cli_pager_prompt (cf, uf);
2165 if (action == UNIX_CLI_PARSE_ACTION_PAGER_CRLF)
2166 /* no more in buffer, exit, but only if it was <enter> */
2172 case UNIX_CLI_PARSE_ACTION_PAGER_UP:
2173 /* scroll the page back one line */
2174 if (cf->pager_start > 0)
2177 unix_cli_pager_index_t *pi = NULL;
2180 if (cf->ansi_capable)
2182 pi = &cf->pager_index[cf->pager_start];
2183 line = cf->pager_vector[pi->line] + pi->offset;
2184 unix_cli_pager_prompt_erase (cf, uf);
2185 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SCROLLDN,
2186 sizeof (ANSI_SCROLLDN) - 1);
2187 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SAVECURSOR,
2188 sizeof (ANSI_SAVECURSOR) - 1);
2189 unix_cli_ansi_cursor (cf, uf, 1, 1);
2190 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_CLEARLINE,
2191 sizeof (ANSI_CLEARLINE) - 1);
2192 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2193 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_RESTCURSOR,
2194 sizeof (ANSI_RESTCURSOR) - 1);
2195 unix_cli_pager_prompt_erase (cf, uf);
2196 unix_cli_pager_prompt (cf, uf);
2200 int m = cf->pager_start + (cf->height - 1);
2201 unix_cli_pager_prompt_erase (cf, uf);
2202 for (j = cf->pager_start;
2203 j < vec_len (cf->pager_index) && j < m; j++)
2205 pi = &cf->pager_index[j];
2206 line = cf->pager_vector[pi->line] + pi->offset;
2207 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2209 /* if the last line didn't end in newline, add a newline */
2210 if (pi && line[pi->length - 1] != '\n')
2211 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2212 unix_cli_pager_prompt (cf, uf);
2217 case UNIX_CLI_PARSE_ACTION_PAGER_TOP:
2218 /* back to the first page of the buffer */
2219 if (cf->pager_start > 0)
2222 unix_cli_pager_index_t *pi = NULL;
2224 cf->pager_start = 0;
2225 int m = cf->pager_start + (cf->height - 1);
2226 unix_cli_pager_prompt_erase (cf, uf);
2227 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2230 pi = &cf->pager_index[j];
2231 line = cf->pager_vector[pi->line] + pi->offset;
2232 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2234 /* if the last line didn't end in newline, add a newline */
2235 if (pi && line[pi->length - 1] != '\n')
2236 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2237 unix_cli_pager_prompt (cf, uf);
2241 case UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM:
2242 /* skip to the last page of the buffer */
2243 if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
2246 unix_cli_pager_index_t *pi = NULL;
2248 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
2249 unix_cli_pager_prompt_erase (cf, uf);
2250 unix_cli_pager_message (cf, uf, "skipping", "\n");
2251 for (j = cf->pager_start; j < vec_len (cf->pager_index); j++)
2253 pi = &cf->pager_index[j];
2254 line = cf->pager_vector[pi->line] + pi->offset;
2255 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2257 /* if the last line didn't end in newline, add a newline */
2258 if (pi && line[pi->length - 1] != '\n')
2259 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2260 unix_cli_pager_prompt (cf, uf);
2264 case UNIX_CLI_PARSE_ACTION_PAGER_PGUP:
2265 /* wander back one page in the buffer */
2266 if (cf->pager_start > 0)
2269 unix_cli_pager_index_t *pi = NULL;
2272 if (cf->pager_start >= cf->height)
2273 cf->pager_start -= cf->height - 1;
2275 cf->pager_start = 0;
2276 m = cf->pager_start + cf->height - 1;
2277 unix_cli_pager_prompt_erase (cf, uf);
2278 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
2281 pi = &cf->pager_index[j];
2282 line = cf->pager_vector[pi->line] + pi->offset;
2283 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
2285 /* if the last line didn't end in newline, add a newline */
2286 if (pi && line[pi->length - 1] != '\n')
2287 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2288 unix_cli_pager_prompt (cf, uf);
2292 case UNIX_CLI_PARSE_ACTION_PAGER_REDRAW:
2293 /* Redraw the current pager screen */
2294 unix_cli_pager_redraw (cf, uf);
2297 case UNIX_CLI_PARSE_ACTION_PAGER_SEARCH:
2298 /* search forwards in the buffer */
2302 case UNIX_CLI_PARSE_ACTION_CRLF:
2304 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
2306 if (cf->has_history && cf->history_limit)
2308 if (cf->command_history
2309 && vec_len (cf->command_history) >= cf->history_limit)
2311 vec_free (cf->command_history[0]);
2312 vec_delete (cf->command_history, 1, 0);
2314 /* Don't add blank lines to the cmd history */
2315 if (vec_len (cf->current_command))
2317 /* Don't duplicate the previous command */
2318 j = vec_len (cf->command_history);
2320 (vec_len (cf->current_command) !=
2321 vec_len (cf->command_history[j - 1])
2322 || memcmp (cf->current_command, cf->command_history[j - 1],
2323 vec_len (cf->current_command)) != 0))
2325 /* copy the command to the history */
2327 vec_append (c, cf->current_command);
2328 vec_add1 (cf->command_history, c);
2329 cf->command_number++;
2332 cf->excursion = vec_len (cf->command_history);
2335 cf->search_mode = 0;
2336 vec_reset_length (cf->search_key);
2341 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2342 case UNIX_CLI_PARSE_ACTION_NOMATCH:
2343 if (vec_len (cf->pager_index))
2347 else if (cf->has_history && cf->search_mode != 0 && isprint (input))
2349 int k, limit, offset;
2352 vec_add1 (cf->search_key, input);
2355 for (j = 0; j < vec_len (cf->command_history); j++)
2357 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
2359 else if (cf->excursion < 0)
2360 cf->excursion = vec_len (cf->command_history) - 1;
2362 item = cf->command_history[cf->excursion];
2364 limit = (vec_len (cf->search_key) > vec_len (item)) ?
2365 vec_len (item) : vec_len (cf->search_key);
2367 for (offset = 0; offset <= vec_len (item) - limit; offset++)
2369 for (k = 0; k < limit; k++)
2371 if (item[k + offset] != cf->search_key[k])
2374 goto found_at_offset;
2382 for (; cf->cursor > 0; cf->cursor--)
2384 unix_vlib_cli_output_cursor_left (cf, uf);
2385 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
2386 unix_vlib_cli_output_cursor_left (cf, uf);
2389 vec_validate (cf->current_command, vec_len (item) - 1);
2390 clib_memcpy (cf->current_command, item, vec_len (item));
2391 _vec_len (cf->current_command) = vec_len (item);
2393 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2394 vec_len (cf->current_command));
2395 cf->cursor = vec_len (cf->current_command);
2399 cf->excursion += cf->search_mode;
2402 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\nNo match...", 12);
2403 vec_reset_length (cf->search_key);
2404 vec_reset_length (cf->current_command);
2405 cf->search_mode = 0;
2409 else if (isprint (input)) /* skip any errant control codes */
2411 if (cf->cursor == vec_len (cf->current_command))
2414 vec_add1 (cf->current_command, input);
2417 /* Echo the character back to the client */
2418 unix_vlib_cli_output_cooked (cf, uf, &input, 1);
2422 /* Insert at cursor: resize +1 byte, move everything over */
2423 j = vec_len (cf->current_command) - cf->cursor;
2424 vec_add1 (cf->current_command, (u8) 'A');
2425 memmove (cf->current_command + cf->cursor + 1,
2426 cf->current_command + cf->cursor, j);
2427 cf->current_command[cf->cursor] = input;
2428 /* Redraw the line */
2430 unix_vlib_cli_output_cooked (cf, uf,
2431 cf->current_command + cf->cursor,
2435 /* Put terminal cursor back */
2436 for (; j > 0; j--, cf->cursor--)
2437 unix_vlib_cli_output_cursor_left (cf, uf);
2442 /* no-op - not printable or otherwise not actionable */
2449 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2455 /** @brief Process input bytes on a stream to provide line editing and
2456 * command history in the CLI. */
2458 unix_cli_line_edit (unix_cli_main_t * cm, unix_main_t * um,
2459 clib_file_main_t * fm, unix_cli_file_t * cf)
2461 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2464 for (i = 0; i < vec_len (cf->input_vector); i++)
2466 unix_cli_parse_action_t action;
2468 unix_cli_parse_actions_t *a;
2470 /* If we're in the pager mode, search the pager actions */
2472 vec_len (cf->pager_index) ? unix_cli_parse_pager :
2473 unix_cli_parse_strings;
2475 /* See if the input buffer is some sort of control code */
2476 action = unix_cli_match_action (a, &cf->input_vector[i],
2477 vec_len (cf->input_vector) - i,
2482 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2485 /* There was a partial match which means we need more bytes
2486 * than the input buffer currently has.
2487 * Since the bytes before here have been processed, shift
2488 * the remaining contents to the start of the input buffer.
2490 vec_delete (cf->input_vector, i, 0);
2492 return 1; /* wait for more */
2494 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2495 /* process telnet options */
2496 matched = unix_cli_process_telnet (um, cf, uf,
2497 cf->input_vector + i,
2498 vec_len (cf->input_vector) - i);
2501 /* There was a partial match which means we need more bytes
2502 * than the input buffer currently has.
2507 * Since the bytes before here have been processed, shift
2508 * the remaining contents to the start of the input buffer.
2510 vec_delete (cf->input_vector, i, 0);
2512 return 1; /* wait for more */
2517 /* If telnet option processing switched us to line mode, get us
2522 vec_delete (cf->input_vector, i, 0);
2523 vec_free (cf->current_command);
2524 cf->current_command = cf->input_vector;
2528 /* process the action */
2529 if (!unix_cli_line_process_one (cm, um, cf, uf,
2530 cf->input_vector[i], action))
2532 /* CRLF found. Consume the bytes from the input_vector */
2533 vec_delete (cf->input_vector, i + matched, 0);
2534 /* And tell our caller to execute cf->input_command */
2542 vec_reset_length (cf->input_vector);
2546 /** @brief Process input to a CLI session. */
2548 unix_cli_process_input (unix_cli_main_t * cm, uword cli_file_index)
2550 unix_main_t *um = &unix_main;
2551 clib_file_main_t *fm = &file_main;
2553 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2554 unformat_input_t input;
2555 int vlib_parse_eval (u8 *);
2557 cm->current_input_file_index = cli_file_index;
2560 /* Try vlibplex first. Someday... */
2561 if (0 && vlib_parse_eval (cf->input_vector) == 0)
2567 /* just treat whatever we got as a complete line of input */
2568 cf->current_command = cf->input_vector;
2572 /* Line edit, echo, etc. */
2573 if (unix_cli_line_edit (cm, um, fm, cf))
2574 /* want more input */
2581 vec_reset_length (lv);
2582 lv = format (lv, "%U[%d]: %v",
2583 format_timeval, 0 /* current bat-time */ ,
2584 0 /* current bat-format */ ,
2585 cli_file_index, cf->current_command);
2586 if ((vec_len (cf->current_command) > 0) &&
2587 (cf->current_command[vec_len (cf->current_command) - 1] != '\n'))
2588 lv = format (lv, "\n");
2589 int rv __attribute__ ((unused)) = write (um->log_fd, lv, vec_len (lv));
2592 /* Run the command through the macro processor */
2593 if (vec_len (cf->current_command))
2596 vec_validate (cf->current_command, vec_len (cf->current_command));
2597 cf->current_command[vec_len (cf->current_command) - 1] = 0;
2598 /* The macro expander expects proper C-strings, not vectors */
2599 expanded = (u8 *) clib_macro_eval (&cf->macro_main,
2600 (i8 *) cf->current_command,
2603 8 /* max_level */ );
2604 /* Macro processor NULL terminates the return */
2605 _vec_len (expanded) -= 1;
2606 vec_reset_length (cf->current_command);
2607 vec_append (cf->current_command, expanded);
2608 vec_free (expanded);
2611 /* Build an unformat structure around our command */
2612 unformat_init_vector (&input, cf->current_command);
2614 /* Remove leading white space from input. */
2615 (void) unformat (&input, "");
2617 cf->pager_start = 0; /* start a new pager session */
2619 if (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
2620 vlib_cli_input (um->vlib_main, &input, unix_vlib_cli_output,
2623 /* Zero buffer since otherwise unformat_free will call vec_free on it. */
2626 unformat_free (&input);
2628 /* Re-fetch pointer since pool may have moved. */
2629 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2630 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2633 /* reset vector; we'll re-use it later */
2636 vec_reset_length (cf->input_vector);
2637 cf->current_command = 0;
2641 vec_reset_length (cf->current_command);
2644 if (cf->no_pager == 2)
2646 /* Pager was programmatically disabled */
2647 unix_cli_pager_message (cf, uf, "pager buffer overflowed", "\n");
2648 cf->no_pager = um->cli_no_pager;
2651 if (vec_len (cf->pager_index) == 0
2652 || vec_len (cf->pager_index) < cf->height)
2654 /* There was no need for the pager */
2655 unix_cli_pager_reset (cf);
2658 unix_cli_cli_prompt (cf, uf);
2662 /* Display the pager prompt */
2663 unix_cli_pager_prompt (cf, uf);
2666 /* Any residual data in the input vector? */
2667 if (vec_len (cf->input_vector))
2670 /* For non-interactive sessions send a NUL byte.
2671 * Specifically this is because vppctl needs to see some traffic in
2672 * order to move on to closing the session. Commands with no output
2673 * would thus cause vppctl to hang indefinitely in non-interactive mode
2674 * since there is also no prompt sent after the command completes.
2676 if (!cf->is_interactive)
2677 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\0", 1);
2680 /** Destroy a CLI session.
2681 * @note If we destroy the @c stdin session this additionally signals
2682 * the shutdown of VPP.
2685 unix_cli_kill (unix_cli_main_t * cm, uword cli_file_index)
2687 unix_main_t *um = &unix_main;
2688 clib_file_main_t *fm = &file_main;
2689 unix_cli_file_t *cf;
2693 /* Validate cli_file_index */
2694 if (pool_is_free_index (cm->cli_file_pool, cli_file_index))
2697 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2698 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
2700 /* Quit/EOF on stdin means quit program. */
2701 if (uf->file_descriptor == STDIN_FILENO)
2702 clib_longjmp (&um->vlib_main->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
2704 vec_free (cf->current_command);
2705 vec_free (cf->search_key);
2707 for (i = 0; i < vec_len (cf->command_history); i++)
2708 vec_free (cf->command_history[i]);
2710 vec_free (cf->command_history);
2711 vec_free (cf->input_vector);
2713 clib_file_del (fm, uf);
2715 unix_cli_file_free (cf);
2716 clib_macro_free (&cf->macro_main);
2717 pool_put (cm->cli_file_pool, cf);
2720 /** Handle system events. */
2722 unix_cli_process (vlib_main_t * vm,
2723 vlib_node_runtime_t * rt, vlib_frame_t * f)
2725 unix_cli_main_t *cm = &unix_cli_main;
2730 unix_cli_process_event_type_t event_type;
2731 vlib_process_wait_for_event (vm);
2732 event_type = vlib_process_get_events (vm, &data);
2736 case UNIX_CLI_PROCESS_EVENT_READ_READY:
2737 for (i = 0; i < vec_len (data); i++)
2738 unix_cli_process_input (cm, data[i]);
2741 case UNIX_CLI_PROCESS_EVENT_QUIT:
2742 /* Kill this process. */
2743 for (i = 0; i < vec_len (data); i++)
2744 unix_cli_kill (cm, data[i]);
2749 _vec_len (data) = 0;
2755 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
2757 /* Add node index so we can re-use this process later. */
2758 vec_add1 (cm->unused_cli_process_node_indices, rt->node_index);
2763 /** Called when a CLI session file descriptor can be written to without
2765 static clib_error_t *
2766 unix_cli_write_ready (clib_file_t * uf)
2768 unix_cli_main_t *cm = &unix_cli_main;
2769 unix_cli_file_t *cf;
2772 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2774 /* Flush output vector. */
2776 /* If it's a socket we use MSG_NOSIGNAL to prevent SIGPIPE */
2777 n = send (uf->file_descriptor,
2778 cf->output_vector, vec_len (cf->output_vector), MSG_NOSIGNAL);
2780 n = write (uf->file_descriptor,
2781 cf->output_vector, vec_len (cf->output_vector));
2783 if (n < 0 && errno != EAGAIN)
2787 /* connection closed on us */
2788 unix_main_t *um = &unix_main;
2790 vlib_process_signal_event (um->vlib_main, cf->process_node_index,
2791 UNIX_CLI_PROCESS_EVENT_QUIT,
2796 return clib_error_return_unix (0, "write");
2801 unix_cli_del_pending_output (uf, cf, n);
2803 return /* no error */ 0;
2806 /** Called when a CLI session file descriptor has data to be read. */
2807 static clib_error_t *
2808 unix_cli_read_ready (clib_file_t * uf)
2810 unix_main_t *um = &unix_main;
2811 unix_cli_main_t *cm = &unix_cli_main;
2812 unix_cli_file_t *cf;
2814 int n, n_read, n_try;
2816 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2821 l = vec_len (cf->input_vector);
2822 vec_resize (cf->input_vector, l + n_try);
2824 n = read (uf->file_descriptor, cf->input_vector + l, n_try);
2827 if (n < 0 && errno != EAGAIN)
2828 return clib_error_return_unix (0, "read");
2830 n_read = n < 0 ? 0 : n;
2831 _vec_len (cf->input_vector) = l + n_read;
2835 vlib_process_signal_event (um->vlib_main,
2836 cf->process_node_index,
2838 ? UNIX_CLI_PROCESS_EVENT_QUIT
2839 : UNIX_CLI_PROCESS_EVENT_READ_READY),
2840 /* event data */ uf->private_data);
2842 return /* no error */ 0;
2845 /** Called when a CLI session file descriptor has an error condition. */
2846 static clib_error_t *
2847 unix_cli_error_detected (clib_file_t * uf)
2849 unix_main_t *um = &unix_main;
2850 unix_cli_main_t *cm = &unix_cli_main;
2851 unix_cli_file_t *cf;
2853 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2854 cf->has_epipe = 1; /* prevent writes while the close is pending */
2855 vlib_process_signal_event (um->vlib_main,
2856 cf->process_node_index,
2857 UNIX_CLI_PROCESS_EVENT_QUIT,
2858 /* event data */ uf->private_data);
2860 return /* no error */ 0;
2863 /** Store a new CLI session.
2864 * @param name The name of the session.
2865 * @param fd The file descriptor for the session I/O.
2866 * @return The session ID.
2869 unix_cli_file_add (unix_cli_main_t * cm, char *name, int fd)
2871 unix_main_t *um = &unix_main;
2872 clib_file_main_t *fm = &file_main;
2873 unix_cli_file_t *cf;
2874 clib_file_t template = { 0 };
2875 vlib_main_t *vm = um->vlib_main;
2879 file_desc = format (0, "%s", name);
2881 name = (char *) format (0, "unix-cli-%s", name);
2883 if (vec_len (cm->unused_cli_process_node_indices) > 0)
2885 uword l = vec_len (cm->unused_cli_process_node_indices);
2887 vlib_main_t *this_vlib_main;
2891 * Nodes are bulk-copied, so node name pointers are shared.
2892 * Find the cli node in all graph replicas, and give all of them
2893 * the same new name.
2894 * Then, throw away the old shared name-vector.
2896 for (i = 0; i < vec_len (vlib_mains); i++)
2898 this_vlib_main = vlib_mains[i];
2899 if (this_vlib_main == 0)
2901 n = vlib_get_node (this_vlib_main,
2902 cm->unused_cli_process_node_indices[l - 1]);
2904 n->name = (u8 *) name;
2906 vec_free (old_name);
2908 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
2910 _vec_len (cm->unused_cli_process_node_indices) = l - 1;
2914 static vlib_node_registration_t r = {
2915 .function = unix_cli_process,
2916 .type = VLIB_NODE_TYPE_PROCESS,
2917 .process_log2_n_stack_bytes = 18,
2922 vlib_worker_thread_barrier_sync (vm);
2924 vlib_register_node (vm, &r);
2927 n = vlib_get_node (vm, r.index);
2928 vlib_worker_thread_node_runtime_update ();
2929 vlib_worker_thread_barrier_release (vm);
2932 pool_get (cm->cli_file_pool, cf);
2933 clib_memset (cf, 0, sizeof (*cf));
2934 clib_macro_init (&cf->macro_main);
2936 template.read_function = unix_cli_read_ready;
2937 template.write_function = unix_cli_write_ready;
2938 template.error_function = unix_cli_error_detected;
2939 template.file_descriptor = fd;
2940 template.private_data = cf - cm->cli_file_pool;
2941 template.description = file_desc;
2943 cf->process_node_index = n->index;
2944 cf->clib_file_index = clib_file_add (fm, &template);
2945 cf->output_vector = 0;
2946 cf->input_vector = 0;
2947 vec_validate (cf->current_command, 0);
2948 _vec_len (cf->current_command) = 0;
2950 vlib_start_process (vm, n->runtime_index);
2952 vlib_process_t *p = vlib_get_process_from_node (vm, n);
2953 p->output_function = unix_vlib_cli_output;
2954 p->output_function_arg = cf - cm->cli_file_pool;
2956 return cf - cm->cli_file_pool;
2959 /** Telnet listening socket has a new connection. */
2960 static clib_error_t *
2961 unix_cli_listen_read_ready (clib_file_t * uf)
2963 unix_main_t *um = &unix_main;
2964 clib_file_main_t *fm = &file_main;
2965 unix_cli_main_t *cm = &unix_cli_main;
2966 clib_socket_t *s = &um->cli_listen_socket;
2967 clib_socket_t client;
2969 clib_error_t *error;
2970 unix_cli_file_t *cf;
2974 error = clib_socket_accept (s, &client);
2978 /* Disable Nagle, ignore any errors doing so eg on PF_LOCAL socket */
2980 (void) setsockopt (client.fd, IPPROTO_TCP, TCP_NODELAY,
2981 (void *) &one, sizeof (one));
2983 client_name = (char *) format (0, "%U%c", format_sockaddr, &client.peer, 0);
2985 cf_index = unix_cli_file_add (cm, client_name, client.fd);
2986 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2989 /* No longer need CLIB version of socket. */
2990 clib_socket_free (&client);
2991 vec_free (client_name);
2993 /* if we're supposed to run telnet session in character mode (default) */
2994 if (um->cli_line_mode == 0)
2997 * Set telnet client character mode, echo on, suppress "go-ahead".
2998 * Technically these should be negotiated, but this works.
3000 u8 charmode_option[] = {
3001 IAC, WONT, TELOPT_LINEMODE, /* server will do char-by-char */
3002 IAC, DONT, TELOPT_LINEMODE, /* client should do char-by-char */
3003 IAC, WILL, TELOPT_SGA, /* server willl supress GA */
3004 IAC, DO, TELOPT_SGA, /* client should supress Go Ahead */
3005 IAC, WILL, TELOPT_ECHO, /* server will do echo */
3006 IAC, DONT, TELOPT_ECHO, /* client should not echo */
3007 IAC, DO, TELOPT_TTYPE, /* client should tell us its term type */
3008 IAC, SB, TELOPT_TTYPE, 1, IAC, SE, /* now tell me ttype */
3009 IAC, DO, TELOPT_NAWS, /* client should tell us its window sz */
3010 IAC, SB, TELOPT_NAWS, 1, IAC, SE, /* now tell me window size */
3013 /* Enable history on this CLI */
3014 cf->history_limit = um->cli_history_limit;
3015 cf->has_history = cf->history_limit != 0;
3017 /* This is an interactive session until we decide otherwise */
3018 cf->is_interactive = 1;
3020 /* Make sure this session is in line mode */
3026 /* Setup the pager */
3027 cf->no_pager = um->cli_no_pager;
3029 /* Default terminal dimensions, should the terminal
3030 * fail to provide any.
3032 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3033 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3035 /* Send the telnet options */
3036 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3037 unix_vlib_cli_output_raw (cf, uf, charmode_option,
3038 ARRAY_LEN (charmode_option));
3040 if (cm->new_session_process_node_index == ~0)
3042 /* Create thw new session deadline process */
3043 cm->new_session_process_node_index =
3044 vlib_process_create (um->vlib_main, "unix-cli-new-session",
3045 unix_cli_new_session_process,
3046 16 /* log2_n_stack_bytes */ );
3049 /* In case the client doesn't negotiate terminal type, register
3050 * our session with a process that will emit the prompt if
3051 * a deadline passes */
3052 vlib_process_signal_event (um->vlib_main,
3053 cm->new_session_process_node_index,
3054 UNIX_CLI_NEW_SESSION_EVENT_ADD, cf_index);
3061 /** The system terminal has informed us that the window size
3065 unix_cli_resize_interrupt (int signum)
3067 clib_file_main_t *fm = &file_main;
3068 unix_cli_main_t *cm = &unix_cli_main;
3069 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
3070 cm->stdin_cli_file_index);
3071 clib_file_t *uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3075 /* Terminal resized, fetch the new size */
3076 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) < 0)
3078 /* "Should never happen..." */
3079 clib_unix_warning ("TIOCGWINSZ");
3080 /* We can't trust ws.XXX... */
3084 cf->width = ws.ws_col;
3085 if (cf->width > UNIX_CLI_MAX_TERMINAL_WIDTH)
3086 cf->width = UNIX_CLI_MAX_TERMINAL_WIDTH;
3088 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3090 cf->height = ws.ws_row;
3091 if (cf->height > UNIX_CLI_MAX_TERMINAL_HEIGHT)
3092 cf->height = UNIX_CLI_MAX_TERMINAL_HEIGHT;
3093 if (cf->height == 0)
3094 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3096 /* Reindex the pager buffer */
3097 unix_cli_pager_reindex (cf);
3099 /* Redraw the page */
3100 unix_cli_pager_redraw (cf, uf);
3103 /** Handle configuration directives in the @em unix section. */
3104 static clib_error_t *
3105 unix_cli_config (vlib_main_t * vm, unformat_input_t * input)
3107 unix_main_t *um = &unix_main;
3108 clib_file_main_t *fm = &file_main;
3109 unix_cli_main_t *cm = &unix_cli_main;
3111 clib_error_t *error = 0;
3112 unix_cli_file_t *cf;
3115 struct sigaction sa;
3119 /* We depend on unix flags being set. */
3120 if ((error = vlib_call_config_function (vm, unix_config)))
3123 if (um->flags & UNIX_FLAG_INTERACTIVE)
3125 /* Set stdin to be non-blocking. */
3126 if ((flags = fcntl (STDIN_FILENO, F_GETFL, 0)) < 0)
3128 (void) fcntl (STDIN_FILENO, F_SETFL, flags | O_NONBLOCK);
3130 cf_index = unix_cli_file_add (cm, "stdin", STDIN_FILENO);
3131 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
3132 cm->stdin_cli_file_index = cf_index;
3134 /* If stdin is a tty and we are using chacracter mode, enable
3135 * history on the CLI and set the tty line discipline accordingly. */
3136 if (isatty (STDIN_FILENO) && um->cli_line_mode == 0)
3138 /* Capture terminal resize events */
3139 clib_memset (&sa, 0, sizeof (sa));
3140 sa.sa_handler = unix_cli_resize_interrupt;
3141 if (sigaction (SIGWINCH, &sa, 0) < 0)
3142 clib_panic ("sigaction");
3144 /* Retrieve the current terminal size */
3145 if (ioctl (STDIN_FILENO, TIOCGWINSZ, &ws) == 0)
3147 cf->width = ws.ws_col;
3148 cf->height = ws.ws_row;
3151 if (cf->width == 0 || cf->height == 0)
3154 * We have a tty, but no size. Use defaults.
3155 * vpp "unix interactive" inside emacs + gdb ends up here.
3157 cf->width = UNIX_CLI_DEFAULT_TERMINAL_WIDTH;
3158 cf->height = UNIX_CLI_DEFAULT_TERMINAL_HEIGHT;
3161 /* Setup the history */
3162 cf->history_limit = um->cli_history_limit;
3163 cf->has_history = cf->history_limit != 0;
3165 /* Setup the pager */
3166 cf->no_pager = um->cli_no_pager;
3168 /* This is an interactive session until we decide otherwise */
3169 cf->is_interactive = 1;
3171 /* We're going to be in char by char mode */
3174 /* Save the original tty state so we can restore it later */
3175 tcgetattr (STDIN_FILENO, &um->tio_stdin);
3178 /* Tweak the tty settings */
3179 tio = um->tio_stdin;
3180 /* echo off, canonical mode off, ext'd input processing off */
3181 tio.c_lflag &= ~(ECHO | ICANON | IEXTEN);
3182 /* disable XON/XOFF, so ^S invokes the history search */
3183 tio.c_iflag &= ~(IXON | IXOFF);
3184 tio.c_cc[VMIN] = 1; /* 1 byte at a time */
3185 tio.c_cc[VTIME] = 0; /* no timer */
3186 tio.c_cc[VSTOP] = _POSIX_VDISABLE; /* not ^S */
3187 tio.c_cc[VSTART] = _POSIX_VDISABLE; /* not ^Q */
3188 tcsetattr (STDIN_FILENO, TCSAFLUSH, &tio);
3190 /* See if we can do ANSI/VT100 output */
3191 term = (u8 *) getenv ("TERM");
3194 int len = strlen ((char *) term);
3195 cf->ansi_capable = unix_cli_terminal_type_ansi (term, len);
3196 if (unix_cli_terminal_type_noninteractive (term, len))
3197 unix_cli_set_session_noninteractive (cf);
3202 /* No tty, so make sure the session doesn't have tty-like features */
3203 unix_cli_set_session_noninteractive (cf);
3206 /* Send banner and initial prompt */
3207 unix_cli_file_welcome (cm, cf);
3210 /* If we have socket config, LISTEN, otherwise, don't */
3211 clib_socket_t *s = &um->cli_listen_socket;
3212 if (s->config && s->config[0] != 0)
3215 clib_file_t template = { 0 };
3217 /* mkdir of file socketu, only under /run */
3218 if (strncmp (s->config, "/run", 4) == 0)
3220 u8 *tmp = format (0, "%s", s->config);
3221 int i = vec_len (tmp);
3222 while (i && tmp[--i] != '/')
3228 vlib_unix_recursive_mkdir ((char *) tmp);
3232 s->flags = CLIB_SOCKET_F_IS_SERVER | /* listen, don't connect */
3233 CLIB_SOCKET_F_ALLOW_GROUP_WRITE; /* PF_LOCAL socket only */
3234 error = clib_socket_init (s);
3239 template.read_function = unix_cli_listen_read_ready;
3240 template.file_descriptor = s->fd;
3241 template.description = format (0, "cli listener %s", s->config);
3243 clib_file_add (fm, &template);
3246 /* Set CLI prompt. */
3247 if (!cm->cli_prompt)
3248 cm->cli_prompt = format (0, "VLIB: ");
3254 * This module has no configurable parameters.
3256 VLIB_CONFIG_FUNCTION (unix_cli_config, "unix-cli");
3258 /** Called when VPP is shutting down, this restores the system
3259 * terminal state if previously saved.
3261 static clib_error_t *
3262 unix_cli_exit (vlib_main_t * vm)
3264 unix_main_t *um = &unix_main;
3266 /* If stdin is a tty and we saved the tty state, reset the tty state */
3267 if (isatty (STDIN_FILENO) && um->tio_isset)
3268 tcsetattr (STDIN_FILENO, TCSAFLUSH, &um->tio_stdin);
3273 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_cli_exit);
3275 /** Set the CLI prompt.
3276 * @param prompt The C string to set the prompt to.
3277 * @note This setting is global; it impacts all current
3278 * and future CLI sessions.
3281 vlib_unix_cli_set_prompt (char *prompt)
3283 char *fmt = (prompt[strlen (prompt) - 1] == ' ') ? "%s" : "%s ";
3284 unix_cli_main_t *cm = &unix_cli_main;
3286 vec_free (cm->cli_prompt);
3287 cm->cli_prompt = format (0, fmt, prompt);
3290 static unix_cli_file_t *
3291 unix_cli_file_if_exists (unix_cli_main_t * cm)
3293 if (!cm->cli_file_pool)
3295 return pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3298 static unix_cli_file_t *
3299 unix_cli_file_if_interactive (unix_cli_main_t * cm)
3301 unix_cli_file_t *cf;
3302 if ((cf = unix_cli_file_if_exists (cm)) && !cf->is_interactive)
3307 /** CLI command to quit the terminal session.
3308 * @note If this is a stdin session then this will
3309 * shutdown VPP also.
3311 static clib_error_t *
3312 unix_cli_quit (vlib_main_t * vm,
3313 unformat_input_t * input, vlib_cli_command_t * cmd)
3315 unix_cli_main_t *cm = &unix_cli_main;
3316 unix_cli_file_t *cf;
3318 if (!(cf = unix_cli_file_if_exists (cm)))
3319 return clib_error_return (0, "invalid session");
3321 /* Cosmetic: suppress the final prompt from appearing before we die */
3322 cf->is_interactive = 0;
3325 vlib_process_signal_event (vm,
3326 vlib_current_process (vm),
3327 UNIX_CLI_PROCESS_EVENT_QUIT,
3328 cm->current_input_file_index);
3333 * Terminates the current CLI session.
3335 * If VPP is running in @em interactive mode and this is the console session
3336 * (that is, the session on @c stdin) then this will also terminate VPP.
3339 VLIB_CLI_COMMAND (unix_cli_quit_command, static) = {
3341 .short_help = "Exit CLI",
3342 .function = unix_cli_quit,
3347 VLIB_CLI_COMMAND (unix_cli_q_command, static) = {
3349 .short_help = "Exit CLI",
3350 .function = unix_cli_quit,
3354 /** CLI command to execute a VPP command script. */
3355 static clib_error_t *
3356 unix_cli_exec (vlib_main_t * vm,
3357 unformat_input_t * input, vlib_cli_command_t * cmd)
3361 unformat_input_t sub_input;
3362 clib_error_t *error;
3363 unix_cli_main_t *cm = &unix_cli_main;
3364 unix_cli_file_t *cf;
3372 if (!unformat (input, "%s", &file_name))
3374 error = clib_error_return (0, "expecting file name, got `%U'",
3375 format_unformat_error, input);
3379 fd = open (file_name, O_RDONLY);
3382 error = clib_error_return_unix (0, "failed to open `%s'", file_name);
3386 /* Make sure its a regular file. */
3387 if (fstat (fd, &s) < 0)
3389 error = clib_error_return_unix (0, "failed to stat `%s'", file_name);
3393 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
3395 error = clib_error_return (0, "not a regular file `%s'", file_name);
3400 vec_validate (file_data, s.st_size);
3402 if (read (fd, file_data, s.st_size) != s.st_size)
3404 error = clib_error_return_unix (0, "Failed to read %d bytes from '%s'",
3405 s.st_size, file_name);
3406 vec_free (file_data);
3410 /* The macro expander expects a c string... */
3411 vec_add1 (file_data, 0);
3413 unformat_init_vector (&sub_input, file_data);
3415 /* Run the file contents through the macro processor */
3416 if (vec_len (sub_input.buffer) > 1)
3419 clib_macro_main_t *mm = 0;
3421 /* Initial config process? Use the global macro table. */
3422 if (pool_is_free_index
3423 (cm->cli_file_pool, cm->current_input_file_index))
3424 mm = &cm->macro_main;
3427 /* Otherwise, use the per-cli-process macro table */
3428 cf = pool_elt_at_index (cm->cli_file_pool,
3429 cm->current_input_file_index);
3430 mm = &cf->macro_main;
3433 expanded = (u8 *) clib_macro_eval (mm,
3434 (i8 *) sub_input.buffer,
3437 8 /* max_level */ );
3438 /* Macro processor NULL terminates the return */
3439 _vec_len (expanded) -= 1;
3440 vec_reset_length (sub_input.buffer);
3441 vec_append (sub_input.buffer, expanded);
3442 vec_free (expanded);
3445 vlib_cli_input (vm, &sub_input, 0, 0);
3446 unformat_free (&sub_input);
3451 vec_free (file_name);
3457 * Executes a sequence of CLI commands which are read from a file. If
3458 * a command is unrecognised or otherwise invalid then the usual CLI
3459 * feedback will be generated, however execution of subsequent commands
3460 * from the file will continue.
3462 * The VPP code is indifferent to the file location. However, if SELinux
3463 * is enabled, then the file needs to have an SELinux label the VPP
3464 * process is allowed to access. For example, if a file is created in
3465 * '<em>/usr/share/vpp/</em>', it will be allowed. However, files manually
3466 * created in '/tmp/' or '/home/<user>/' will not be accessible by the VPP
3467 * process when SELinux is enabled.
3472 * <b><em>$ cat /usr/share/vpp/scripts/gigup.txt</em></b>
3473 * set interface state GigabitEthernet0/8/0 up
3474 * set interface state GigabitEthernet0/9/0 up
3476 * Example of how to execute a set of CLI commands from a file:
3477 * @cliexcmd{exec /usr/share/vpp/scripts/gigup.txt}
3480 VLIB_CLI_COMMAND (cli_exec, static) = {
3482 .short_help = "exec <filename>",
3483 .function = unix_cli_exec,
3488 /** CLI command to show various unix error statistics. */
3489 static clib_error_t *
3490 unix_show_errors (vlib_main_t * vm,
3491 unformat_input_t * input, vlib_cli_command_t * cmd)
3493 unix_main_t *um = &unix_main;
3494 clib_error_t *error = 0;
3495 int i, n_errors_to_show;
3496 unix_error_history_t *unix_errors = 0;
3498 n_errors_to_show = 1 << 30;
3500 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3502 if (!unformat (input, "%d", &n_errors_to_show))
3505 clib_error_return (0,
3506 "expecting integer number of errors to show, got `%U'",
3507 format_unformat_error, input);
3513 clib_min (ARRAY_LEN (um->error_history), n_errors_to_show);
3516 um->error_history_index >
3517 0 ? um->error_history_index - 1 : ARRAY_LEN (um->error_history) - 1;
3519 while (n_errors_to_show > 0)
3521 unix_error_history_t *eh = um->error_history + i;
3526 vec_add1 (unix_errors, eh[0]);
3527 n_errors_to_show -= 1;
3529 i = ARRAY_LEN (um->error_history) - 1;
3534 if (vec_len (unix_errors) == 0)
3535 vlib_cli_output (vm, "no Unix errors so far");
3538 vlib_cli_output (vm, "%Ld total errors seen", um->n_total_errors);
3539 for (i = vec_len (unix_errors) - 1; i >= 0; i--)
3541 unix_error_history_t *eh = vec_elt_at_index (unix_errors, i);
3542 vlib_cli_output (vm, "%U: %U",
3543 format_time_interval, "h:m:s:u", eh->time,
3544 format_clib_error, eh->error);
3546 vlib_cli_output (vm, "%U: time now",
3547 format_time_interval, "h:m:s:u", vlib_time_now (vm));
3551 vec_free (unix_errors);
3556 VLIB_CLI_COMMAND (cli_unix_show_errors, static) = {
3557 .path = "show unix errors",
3558 .short_help = "Show Unix system call error history",
3559 .function = unix_show_errors,
3563 /** CLI command to show various unix error statistics. */
3564 static clib_error_t *
3565 unix_show_files (vlib_main_t * vm,
3566 unformat_input_t * input, vlib_cli_command_t * cmd)
3568 clib_error_t *error = 0;
3569 clib_file_main_t *fm = &file_main;
3571 char path[PATH_MAX];
3574 vlib_cli_output (vm, "%3s %6s %12s %12s %12s %-32s %s", "FD", "Thread",
3575 "Read", "Write", "Error", "File Name", "Description");
3578 pool_foreach (f, fm->file_pool,(
3581 s = format (s, "/proc/self/fd/%d%c", f->file_descriptor, 0);
3582 rv = readlink((char *) s, path, PATH_MAX - 1);
3584 path[rv < 0 ? 0 : rv] = 0;
3586 vlib_cli_output (vm, "%3d %6d %12d %12d %12d %-32s %v",
3587 f->file_descriptor, f->polling_thread_index,
3588 f->read_events, f->write_events, f->error_events,
3589 path, f->description);
3590 vec_reset_length (s);
3599 VLIB_CLI_COMMAND (cli_unix_show_files, static) = {
3600 .path = "show unix files",
3601 .short_help = "Show Unix files in use",
3602 .function = unix_show_files,
3606 /** CLI command to show session command history. */
3607 static clib_error_t *
3608 unix_cli_show_history (vlib_main_t * vm,
3609 unformat_input_t * input, vlib_cli_command_t * cmd)
3611 unix_cli_main_t *cm = &unix_cli_main;
3612 unix_cli_file_t *cf;
3615 if (!(cf = unix_cli_file_if_interactive (cm)))
3616 return clib_error_return (0, "invalid for non-interactive sessions");
3618 if (cf->has_history && cf->history_limit)
3620 i = 1 + cf->command_number - vec_len (cf->command_history);
3621 for (j = 0; j < vec_len (cf->command_history); j++)
3622 vlib_cli_output (vm, "%d %v\n", i + j, cf->command_history[j]);
3626 vlib_cli_output (vm, "History not enabled.\n");
3633 * Displays the command history for the current session, if any.
3636 VLIB_CLI_COMMAND (cli_unix_cli_show_history, static) = {
3638 .short_help = "Show current session command history",
3639 .function = unix_cli_show_history,
3643 /** CLI command to show terminal status. */
3644 static clib_error_t *
3645 unix_cli_show_terminal (vlib_main_t * vm,
3646 unformat_input_t * input, vlib_cli_command_t * cmd)
3648 unix_main_t *um = &unix_main;
3649 unix_cli_main_t *cm = &unix_cli_main;
3650 unix_cli_file_t *cf;
3653 if (!(cf = unix_cli_file_if_exists (cm)))
3654 return clib_error_return (0, "invalid session");
3656 n = vlib_get_node (vm, cf->process_node_index);
3658 vlib_cli_output (vm, "Terminal name: %v\n", n->name);
3659 vlib_cli_output (vm, "Terminal mode: %s\n", cf->line_mode ?
3660 "line-by-line" : "char-by-char");
3661 vlib_cli_output (vm, "Terminal width: %d\n", cf->width);
3662 vlib_cli_output (vm, "Terminal height: %d\n", cf->height);
3663 vlib_cli_output (vm, "ANSI capable: %s\n",
3664 cf->ansi_capable ? "yes" : "no");
3665 vlib_cli_output (vm, "Interactive: %s\n",
3666 cf->is_interactive ? "yes" : "no");
3667 vlib_cli_output (vm, "History enabled: %s%s\n",
3668 cf->has_history ? "yes" : "no", !cf->has_history
3669 || cf->history_limit ? "" :
3670 " (disabled by history limit)");
3671 if (cf->has_history)
3672 vlib_cli_output (vm, "History limit: %d\n", cf->history_limit);
3673 vlib_cli_output (vm, "Pager enabled: %s%s%s\n",
3674 cf->no_pager ? "no" : "yes",
3676 || cf->height ? "" : " (disabled by terminal height)",
3678 || um->cli_pager_buffer_limit ? "" :
3679 " (disabled by buffer limit)");
3681 vlib_cli_output (vm, "Pager limit: %d\n", um->cli_pager_buffer_limit);
3682 vlib_cli_output (vm, "CRLF mode: %s\n",
3683 cf->crlf_mode ? "CR+LF" : "LF");
3689 * Displays various information about the state of the current terminal
3693 * @cliexstart{show terminal}
3694 * Terminal name: unix-cli-stdin
3695 * Terminal mode: char-by-char
3696 * Terminal width: 123
3697 * Terminal height: 48
3700 * History enabled: yes
3702 * Pager enabled: yes
3703 * Pager limit: 100000
3708 VLIB_CLI_COMMAND (cli_unix_cli_show_terminal, static) = {
3709 .path = "show terminal",
3710 .short_help = "Show current session terminal settings",
3711 .function = unix_cli_show_terminal,
3715 /** CLI command to display a list of CLI sessions. */
3716 static clib_error_t *
3717 unix_cli_show_cli_sessions (vlib_main_t * vm,
3718 unformat_input_t * input,
3719 vlib_cli_command_t * cmd)
3721 unix_cli_main_t *cm = &unix_cli_main;
3722 clib_file_main_t *fm = &file_main;
3723 unix_cli_file_t *cf;
3727 vlib_cli_output (vm, "%-5s %-5s %-20s %s", "PNI", "FD", "Name", "Flags");
3729 #define fl(x, y) ( (x) ? toupper((y)) : tolower((y)) )
3731 pool_foreach (cf, cm->cli_file_pool, ({
3732 uf = pool_elt_at_index (fm->file_pool, cf->clib_file_index);
3733 n = vlib_get_node (vm, cf->process_node_index);
3734 vlib_cli_output (vm,
3735 "%-5d %-5d %-20v %c%c%c%c%c\n",
3736 cf->process_node_index,
3737 uf->file_descriptor,
3739 fl (cf->is_interactive, 'i'),
3740 fl (cf->is_socket, 's'),
3741 fl (cf->line_mode, 'l'),
3742 fl (cf->has_epipe, 'p'),
3743 fl (cf->ansi_capable, 'a'));
3752 * Displays a summary of all the current CLI sessions.
3754 * Typically used to diagnose connection issues with the CLI
3758 * @cliexstart{show cli-sessions}
3760 * 343 0 unix-cli-stdin IslpA
3761 * 344 7 unix-cli-local:20 ISlpA
3762 * 346 8 unix-cli-local:21 iSLpa
3765 * In this example we have the debug console of the running process
3766 * on stdin/out, we have an interactive socket session and we also
3767 * have a non-interactive socket session.
3771 * - @em PNI: Process node index.
3772 * - @em FD: Unix file descriptor.
3773 * - @em Name: Name of the session.
3774 * - @em Flags: Various flags that describe the state of the session.
3776 * @em Flags have the following meanings; lower-case typically negates
3779 * - @em I Interactive session.
3780 * - @em S Connected by socket.
3781 * - @em s Not a socket, likely stdin.
3782 * - @em L Line-by-line mode.
3783 * - @em l Char-by-char mode.
3784 * - @em P EPIPE detected on connection; it will close soon.
3785 * - @em A ANSI-capable terminal.
3788 VLIB_CLI_COMMAND (cli_unix_cli_show_cli_sessions, static) = {
3789 .path = "show cli-sessions",
3790 .short_help = "Show current CLI sessions",
3791 .function = unix_cli_show_cli_sessions,
3795 /** CLI command to set terminal pager settings. */
3796 static clib_error_t *
3797 unix_cli_set_terminal_pager (vlib_main_t * vm,
3798 unformat_input_t * input,
3799 vlib_cli_command_t * cmd)
3801 unix_main_t *um = &unix_main;
3802 unix_cli_main_t *cm = &unix_cli_main;
3803 unix_cli_file_t *cf;
3804 unformat_input_t _line_input, *line_input = &_line_input;
3805 clib_error_t *error = 0;
3807 if (!(cf = unix_cli_file_if_interactive (cm)))
3808 return clib_error_return (0, "invalid for non-interactive sessions");
3810 if (!unformat_user (input, unformat_line_input, line_input))
3813 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3815 if (unformat (line_input, "on"))
3817 else if (unformat (line_input, "off"))
3819 else if (unformat (line_input, "limit %u", &um->cli_pager_buffer_limit))
3820 vlib_cli_output (vm,
3821 "Pager limit set to %u lines; note, this is global.\n",
3822 um->cli_pager_buffer_limit);
3825 error = clib_error_return (0, "unknown parameter: `%U`",
3826 format_unformat_error, line_input);
3832 unformat_free (line_input);
3838 * Enables or disables the terminal pager for this session. Generally
3839 * this defaults to enabled.
3841 * Additionally allows the pager buffer size to be set; though note that
3842 * this value is set globally and not per session.
3845 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager, static) = {
3846 .path = "set terminal pager",
3847 .short_help = "set terminal pager [on|off] [limit <lines>]",
3848 .function = unix_cli_set_terminal_pager,
3852 /** CLI command to set terminal history settings. */
3853 static clib_error_t *
3854 unix_cli_set_terminal_history (vlib_main_t * vm,
3855 unformat_input_t * input,
3856 vlib_cli_command_t * cmd)
3858 unix_cli_main_t *cm = &unix_cli_main;
3859 unix_cli_file_t *cf;
3860 unformat_input_t _line_input, *line_input = &_line_input;
3862 clib_error_t *error = 0;
3864 if (!(cf = unix_cli_file_if_interactive (cm)))
3865 return clib_error_return (0, "invalid for non-interactive sessions");
3867 if (!unformat_user (input, unformat_line_input, line_input))
3870 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3872 if (unformat (line_input, "on"))
3873 cf->has_history = 1;
3874 else if (unformat (line_input, "off"))
3875 cf->has_history = 0;
3876 else if (unformat (line_input, "limit %u", &cf->history_limit))
3880 error = clib_error_return (0, "unknown parameter: `%U`",
3881 format_unformat_error, line_input);
3887 /* If we reduced history size, or turned it off, purge the history */
3888 limit = cf->has_history ? cf->history_limit : 0;
3889 if (limit < vec_len (cf->command_history))
3893 /* How many items to remove from the start of history */
3894 limit = vec_len (cf->command_history) - limit;
3896 for (i = 0; i < limit; i++)
3897 vec_free (cf->command_history[i]);
3899 vec_delete (cf->command_history, limit, 0);
3903 unformat_free (line_input);
3909 * Enables or disables the command history function of the current
3910 * terminal. Generally this defaults to enabled.
3912 * This command also allows the maximum size of the history buffer for
3913 * this session to be altered.
3916 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history, static) = {
3917 .path = "set terminal history",
3918 .short_help = "set terminal history [on|off] [limit <lines>]",
3919 .function = unix_cli_set_terminal_history,
3923 /** CLI command to set terminal ANSI settings. */
3924 static clib_error_t *
3925 unix_cli_set_terminal_ansi (vlib_main_t * vm,
3926 unformat_input_t * input,
3927 vlib_cli_command_t * cmd)
3929 unix_cli_main_t *cm = &unix_cli_main;
3930 unix_cli_file_t *cf;
3932 if (!(cf = unix_cli_file_if_interactive (cm)))
3933 return clib_error_return (0, "invalid for non-interactive sessions");
3935 if (unformat (input, "on"))
3936 cf->ansi_capable = 1;
3937 else if (unformat (input, "off"))
3938 cf->ansi_capable = 0;
3940 return clib_error_return (0, "unknown parameter: `%U`",
3941 format_unformat_error, input);
3947 * Enables or disables the use of ANSI control sequences by this terminal.
3948 * The default will vary based on terminal detection at the start of the
3951 * ANSI control sequences are used in a small number of places to provide,
3952 * for example, color text output and to control the cursor in the pager.
3955 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi, static) = {
3956 .path = "set terminal ansi",
3957 .short_help = "set terminal ansi [on|off]",
3958 .function = unix_cli_set_terminal_ansi,
3963 #define MAX_CLI_WAIT 86400
3964 /** CLI command to wait <sec> seconds. Useful for exec script. */
3965 static clib_error_t *
3966 unix_wait_cmd (vlib_main_t * vm,
3967 unformat_input_t * input, vlib_cli_command_t * cmd)
3969 unformat_input_t _line_input, *line_input = &_line_input;
3972 if (!unformat_user (input, unformat_line_input, line_input))
3975 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3977 if (unformat (line_input, "%f", &sec))
3980 return clib_error_return (0, "unknown parameter: `%U`",
3981 format_unformat_error, input);
3984 if (sec <= 0 || sec > MAX_CLI_WAIT || floor (sec * 1000) / 1000 != sec)
3985 return clib_error_return (0,
3986 "<sec> must be a positive value and less than 86400 (one day) with no more than msec precision.");
3988 vlib_process_wait_for_event_or_clock (vm, sec);
3989 vlib_cli_output (vm, "waited %.3f sec.", sec);
3991 unformat_free (line_input);
3995 VLIB_CLI_COMMAND (cli_unix_wait_cmd, static) = {
3997 .short_help = "wait <sec>",
3998 .function = unix_wait_cmd,
4002 static clib_error_t *
4003 echo_cmd (vlib_main_t * vm,
4004 unformat_input_t * input, vlib_cli_command_t * cmd)
4006 unformat_input_t _line_input, *line_input = &_line_input;
4008 /* Get a line of input. */
4009 if (!unformat_user (input, unformat_line_input, line_input))
4011 vlib_cli_output (vm, "");
4015 vlib_cli_output (vm, "%v", line_input->buffer);
4017 unformat_free (line_input);
4022 VLIB_CLI_COMMAND (cli_unix_echo_cmd, static) = {
4024 .short_help = "echo <rest-of-line>",
4025 .function = echo_cmd,
4029 static clib_error_t *
4030 define_cmd_fn (vlib_main_t * vm,
4031 unformat_input_t * input, vlib_cli_command_t * cmd)
4034 unformat_input_t _line_input, *line_input = &_line_input;
4035 clib_macro_main_t *mm = get_macro_main ();
4036 clib_error_t *error;
4038 if (!unformat (input, "%s", ¯o_name))
4039 return clib_error_return (0, "missing variable name...");
4041 /* Remove white space */
4042 (void) unformat (input, "");
4044 /* Get a line of input. */
4045 if (!unformat_user (input, unformat_line_input, line_input))
4047 error = clib_error_return (0, "missing value for '%s'...", macro_name);
4048 vec_free (macro_name);
4051 /* the macro expander expects c-strings, not vectors... */
4052 vec_add1 (line_input->buffer, 0);
4053 clib_macro_set_value (mm, (char *) macro_name, (char *) line_input->buffer);
4054 vec_free (macro_name);
4055 unformat_free (line_input);
4060 VLIB_CLI_COMMAND (define_cmd, static) = {
4062 .short_help = "define <variable-name> <value>",
4063 .function = define_cmd_fn,
4068 static clib_error_t *
4069 undefine_cmd_fn (vlib_main_t * vm,
4070 unformat_input_t * input, vlib_cli_command_t * cmd)
4073 clib_macro_main_t *mm = get_macro_main ();
4075 if (!unformat (input, "%s", ¯o_name))
4076 return clib_error_return (0, "missing variable name...");
4078 if (clib_macro_unset (mm, (char *) macro_name))
4079 vlib_cli_output (vm, "%s wasn't set...", macro_name);
4081 vec_free (macro_name);
4086 VLIB_CLI_COMMAND (undefine_cmd, static) = {
4088 .short_help = "undefine <variable-name>",
4089 .function = undefine_cmd_fn,
4093 static clib_error_t *
4094 show_macro_cmd_fn (vlib_main_t * vm,
4095 unformat_input_t * input, vlib_cli_command_t * cmd)
4097 clib_macro_main_t *mm = get_macro_main ();
4100 if (unformat (input, "noevaluate %=", &evaluate, 0))
4102 else if (unformat (input, "noeval %=", &evaluate, 0))
4105 vlib_cli_output (vm, "%U", format_clib_macro_main, mm, evaluate);
4110 VLIB_CLI_COMMAND (show_macro, static) = {
4111 .path = "show macro",
4112 .short_help = "show macro [noevaluate]",
4113 .function = show_macro_cmd_fn,
4117 static clib_error_t *
4118 unix_cli_init (vlib_main_t * vm)
4120 unix_cli_main_t *cm = &unix_cli_main;
4122 /* Breadcrumb to indicate the new session process
4123 * has not been started */
4124 cm->new_session_process_node_index = ~0;
4125 clib_macro_init (&cm->macro_main);
4130 VLIB_INIT_FUNCTION (unix_cli_init);
4133 * fd.io coding-style-patch-verification: ON
4136 * eval: (c-set-style "gnu")