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>
50 #include <vppinfra/timer.h>
58 #include <arpa/telnet.h>
59 #include <sys/ioctl.h>
61 /** ANSI escape code. */
64 /** ANSI Control Sequence Introducer. */
67 /** ANSI clear screen. */
68 #define ANSI_CLEAR CSI "2J" CSI "1;1H"
69 /** ANSI reset color settings. */
70 #define ANSI_RESET CSI "0m"
71 /** ANSI Start bold text. */
72 #define ANSI_BOLD CSI "1m"
73 /** ANSI Stop bold text. */
74 #define ANSI_DIM CSI "2m"
75 /** ANSI Start dark red text. */
76 #define ANSI_DRED ANSI_DIM CSI "31m"
77 /** ANSI Start bright red text. */
78 #define ANSI_BRED ANSI_BOLD CSI "31m"
79 /** ANSI clear line cursor is on. */
80 #define ANSI_CLEARLINE CSI "2K"
81 /** ANSI scroll screen down one line. */
82 #define ANSI_SCROLLDN CSI "1T"
83 /** ANSI save cursor position. */
84 #define ANSI_SAVECURSOR CSI "s"
85 /** ANSI restore cursor position if previously saved. */
86 #define ANSI_RESTCURSOR CSI "u"
88 /** Maximum depth into a byte stream from which to compile a Telnet
89 * protocol message. This is a saftey measure. */
90 #define UNIX_CLI_MAX_DEPTH_TELNET 24
92 /** Unix standard in */
93 #define UNIX_CLI_STDIN_FD 0
96 /** A CLI banner line. */
99 u8 *line; /**< The line to print. */
100 u32 length; /**< The length of the line without terminating NUL. */
103 #define _(a) { .line = (u8 *)(a), .length = sizeof(a) - 1 }
104 /** Plain welcome banner. */
105 static unix_cli_banner_t unix_cli_banner[] = {
106 _(" _______ _ _ _____ ___ \n"),
107 _(" __/ __/ _ \\ (_)__ | | / / _ \\/ _ \\\n"),
108 _(" _/ _// // / / / _ \\ | |/ / ___/ ___/\n"),
109 _(" /_/ /____(_)_/\\___/ |___/_/ /_/ \n"),
113 /** ANSI color welcome banner. */
114 static unix_cli_banner_t unix_cli_banner_color[] = {
115 _(ANSI_BRED " _______ _ " ANSI_RESET " _ _____ ___ \n"),
116 _(ANSI_BRED " __/ __/ _ \\ (_)__ " ANSI_RESET " | | / / _ \\/ _ \\\n"),
117 _(ANSI_BRED " _/ _// // / / / _ \\" ANSI_RESET " | |/ / ___/ ___/\n"),
118 _(ANSI_BRED " /_/ /____(_)_/\\___/" ANSI_RESET " |___/_/ /_/ \n"),
124 /** Pager line index */
127 /** Index into pager_vector */
130 /** Offset of the string in the line */
133 /** Length of the string in the line */
135 } unix_cli_pager_index_t;
138 /** Unix CLI session. */
141 /** The file index held by unix.c */
144 /** Vector of output pending write to file descriptor. */
147 /** Vector of input saved by Unix input node to be processed by
151 /** This session has command history. */
153 /** Array of vectors of commands in the history. */
154 u8 **command_history;
155 /** The command currently pointed at by the history cursor. */
157 /** How far from the end of the history array the user has browsed. */
160 /** Maximum number of history entries this session will store. */
163 /** Current command line counter */
166 /** The string being searched for in the history. */
168 /** If non-zero then the CLI is searching in the history array.
169 * - @c -1 means search backwards.
170 * - @c 1 means search forwards.
174 /** Position of the insert cursor on the current input line */
177 /** Line mode or char mode */
180 /** Set if the CRLF mode wants CR + LF */
183 /** Can we do ANSI output? */
186 /** Has the session started? */
189 /** Disable the pager? */
195 /** Index of line fragments in the pager buffer */
196 unix_cli_pager_index_t *pager_index;
198 /** Line number of top of page */
201 /** Terminal width */
204 /** Terminal height */
207 /** Process node identifier */
208 u32 process_node_index;
211 /** Resets the pager buffer and other data.
212 * @param f The CLI session whose pager needs to be reset.
215 unix_cli_pager_reset (unix_cli_file_t * f)
221 vec_free (f->pager_index);
224 vec_foreach (p, f->pager_vector)
228 vec_free (f->pager_vector);
232 /** Release storage used by a CLI session.
233 * @param f The CLI session whose storage needs to be released.
236 unix_cli_file_free (unix_cli_file_t * f)
238 vec_free (f->output_vector);
239 vec_free (f->input_vector);
240 unix_cli_pager_reset (f);
246 UNIX_CLI_PARSE_ACTION_NOACTION = 0, /**< No action */
247 UNIX_CLI_PARSE_ACTION_CRLF, /**< Carriage return, newline or enter */
248 UNIX_CLI_PARSE_ACTION_TAB, /**< Tab key */
249 UNIX_CLI_PARSE_ACTION_ERASE, /**< Erase cursor left */
250 UNIX_CLI_PARSE_ACTION_ERASERIGHT, /**< Erase cursor right */
251 UNIX_CLI_PARSE_ACTION_UP, /**< Up arrow */
252 UNIX_CLI_PARSE_ACTION_DOWN, /**< Down arrow */
253 UNIX_CLI_PARSE_ACTION_LEFT, /**< Left arrow */
254 UNIX_CLI_PARSE_ACTION_RIGHT, /**< Right arrow */
255 UNIX_CLI_PARSE_ACTION_HOME, /**< Home key (jump to start of line) */
256 UNIX_CLI_PARSE_ACTION_END, /**< End key (jump to end of line) */
257 UNIX_CLI_PARSE_ACTION_WORDLEFT, /**< Jump cursor to start of left word */
258 UNIX_CLI_PARSE_ACTION_WORDRIGHT, /**< Jump cursor to start of right word */
259 UNIX_CLI_PARSE_ACTION_ERASELINELEFT, /**< Erase line to left of cursor */
260 UNIX_CLI_PARSE_ACTION_ERASELINERIGHT, /**< Erase line to right & including cursor */
261 UNIX_CLI_PARSE_ACTION_CLEAR, /**< Clear the terminal */
262 UNIX_CLI_PARSE_ACTION_REVSEARCH, /**< Search backwards in command history */
263 UNIX_CLI_PARSE_ACTION_FWDSEARCH, /**< Search forwards in command history */
264 UNIX_CLI_PARSE_ACTION_YANK, /**< Undo last erase action */
265 UNIX_CLI_PARSE_ACTION_TELNETIAC, /**< Telnet control code */
267 UNIX_CLI_PARSE_ACTION_PAGER_CRLF, /**< Enter pressed (CR, CRLF, LF, etc) */
268 UNIX_CLI_PARSE_ACTION_PAGER_QUIT, /**< Exit the pager session */
269 UNIX_CLI_PARSE_ACTION_PAGER_NEXT, /**< Scroll to next page */
270 UNIX_CLI_PARSE_ACTION_PAGER_DN, /**< Scroll to next line */
271 UNIX_CLI_PARSE_ACTION_PAGER_UP, /**< Scroll to previous line */
272 UNIX_CLI_PARSE_ACTION_PAGER_TOP, /**< Scroll to first line */
273 UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM, /**< Scroll to last line */
274 UNIX_CLI_PARSE_ACTION_PAGER_PGDN, /**< Scroll to next page */
275 UNIX_CLI_PARSE_ACTION_PAGER_PGUP, /**< Scroll to previous page */
276 UNIX_CLI_PARSE_ACTION_PAGER_REDRAW, /**< Clear and redraw the page on the terminal */
277 UNIX_CLI_PARSE_ACTION_PAGER_SEARCH, /**< Search the pager buffer */
279 UNIX_CLI_PARSE_ACTION_PARTIALMATCH, /**< Action parser found a partial match */
280 UNIX_CLI_PARSE_ACTION_NOMATCH /**< Action parser did not find any match */
281 } unix_cli_parse_action_t;
283 /** @brief Mapping of input buffer strings to action values.
284 * @note This won't work as a hash since we need to be able to do
285 * partial matches on the string.
289 u8 *input; /**< Input string to match. */
290 u32 len; /**< Length of input without final NUL. */
291 unix_cli_parse_action_t action; /**< Action to take when matched. */
292 } unix_cli_parse_actions_t;
294 /** @brief Given a capital ASCII letter character return a @c NUL terminated
295 * string with the control code for that letter.
297 * @param c An ASCII character.
298 * @return A @c NUL terminated string of type @c u8[].
301 * @c CTL('A') returns <code>{ 0x01, 0x00 }</code> as a @c u8[].
303 #define CTL(c) (u8[]){ (c) - '@', 0 }
305 #define _(a,b) { .input = (u8 *)(a), .len = sizeof(a) - 1, .action = (b) }
307 * Patterns to match on a CLI input stream.
310 static unix_cli_parse_actions_t unix_cli_parse_strings[] = {
312 _("\r\n", UNIX_CLI_PARSE_ACTION_CRLF), /* Must be before '\r' */
313 _("\n", UNIX_CLI_PARSE_ACTION_CRLF),
314 _("\r\0", UNIX_CLI_PARSE_ACTION_CRLF), /* Telnet does this */
315 _("\r", UNIX_CLI_PARSE_ACTION_CRLF),
317 /* Unix shell control codes */
318 _(CTL ('B'), UNIX_CLI_PARSE_ACTION_LEFT),
319 _(CTL ('F'), UNIX_CLI_PARSE_ACTION_RIGHT),
320 _(CTL ('P'), UNIX_CLI_PARSE_ACTION_UP),
321 _(CTL ('N'), UNIX_CLI_PARSE_ACTION_DOWN),
322 _(CTL ('A'), UNIX_CLI_PARSE_ACTION_HOME),
323 _(CTL ('E'), UNIX_CLI_PARSE_ACTION_END),
324 _(CTL ('D'), UNIX_CLI_PARSE_ACTION_ERASERIGHT),
325 _(CTL ('U'), UNIX_CLI_PARSE_ACTION_ERASELINELEFT),
326 _(CTL ('K'), UNIX_CLI_PARSE_ACTION_ERASELINERIGHT),
327 _(CTL ('Y'), UNIX_CLI_PARSE_ACTION_YANK),
328 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_CLEAR),
329 _(ESC "b", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* Alt-B */
330 _(ESC "f", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* Alt-F */
331 _("\b", UNIX_CLI_PARSE_ACTION_ERASE), /* ^H */
332 _("\x7f", UNIX_CLI_PARSE_ACTION_ERASE), /* Backspace */
333 _("\t", UNIX_CLI_PARSE_ACTION_TAB), /* ^I */
335 /* VT100 Normal mode - Broadest support */
336 _(CSI "A", UNIX_CLI_PARSE_ACTION_UP),
337 _(CSI "B", UNIX_CLI_PARSE_ACTION_DOWN),
338 _(CSI "C", UNIX_CLI_PARSE_ACTION_RIGHT),
339 _(CSI "D", UNIX_CLI_PARSE_ACTION_LEFT),
340 _(CSI "H", UNIX_CLI_PARSE_ACTION_HOME),
341 _(CSI "F", UNIX_CLI_PARSE_ACTION_END),
342 _(CSI "3~", UNIX_CLI_PARSE_ACTION_ERASERIGHT), /* Delete */
343 _(CSI "1;5D", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* C-Left */
344 _(CSI "1;5C", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* C-Right */
346 /* VT100 Application mode - Some Gnome Terminal functions use these */
347 _(ESC "OA", UNIX_CLI_PARSE_ACTION_UP),
348 _(ESC "OB", UNIX_CLI_PARSE_ACTION_DOWN),
349 _(ESC "OC", UNIX_CLI_PARSE_ACTION_RIGHT),
350 _(ESC "OD", UNIX_CLI_PARSE_ACTION_LEFT),
351 _(ESC "OH", UNIX_CLI_PARSE_ACTION_HOME),
352 _(ESC "OF", UNIX_CLI_PARSE_ACTION_END),
354 /* ANSI X3.41-1974 - sent by Microsoft Telnet and PuTTY */
355 _(CSI "1~", UNIX_CLI_PARSE_ACTION_HOME),
356 _(CSI "4~", UNIX_CLI_PARSE_ACTION_END),
358 /* Emacs-ish history search */
359 _(CTL ('S'), UNIX_CLI_PARSE_ACTION_FWDSEARCH),
360 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_REVSEARCH),
362 /* Other protocol things */
363 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
364 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
365 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
369 * Patterns to match when a CLI session is in the pager.
372 static unix_cli_parse_actions_t unix_cli_parse_pager[] = {
374 _("\r\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Must be before '\r' */
375 _("\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
376 _("\r\0", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Telnet does this */
377 _("\r", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
380 _(" ", UNIX_CLI_PARSE_ACTION_PAGER_NEXT),
381 _("q", UNIX_CLI_PARSE_ACTION_PAGER_QUIT),
382 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
383 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
384 _("/", UNIX_CLI_PARSE_ACTION_PAGER_SEARCH),
387 _(CSI "A", UNIX_CLI_PARSE_ACTION_PAGER_UP),
388 _(CSI "B", UNIX_CLI_PARSE_ACTION_PAGER_DN),
389 _(CSI "H", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
390 _(CSI "F", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
392 /* VT100 Application mode */
393 _(ESC "OA", UNIX_CLI_PARSE_ACTION_PAGER_UP),
394 _(ESC "OB", UNIX_CLI_PARSE_ACTION_PAGER_DN),
395 _(ESC "OH", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
396 _(ESC "OF", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
398 /* ANSI X3.41-1974 */
399 _(CSI "1~", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
400 _(CSI "4~", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
401 _(CSI "5~", UNIX_CLI_PARSE_ACTION_PAGER_PGUP),
402 _(CSI "6~", UNIX_CLI_PARSE_ACTION_PAGER_PGDN),
404 /* Other protocol things */
405 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
406 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
407 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
412 /** CLI session events. */
415 UNIX_CLI_PROCESS_EVENT_READ_READY, /**< A file descriptor has data to be read. */
416 UNIX_CLI_PROCESS_EVENT_QUIT, /**< A CLI session wants to close. */
417 } unix_cli_process_event_type_t;
419 /** CLI global state. */
422 /** Prompt string for CLI. */
425 /** Vec pool of CLI sessions. */
426 unix_cli_file_t *cli_file_pool;
428 /** Vec pool of unused session indices. */
429 u32 *unused_cli_process_node_indices;
431 /** The session index of the stdin cli */
432 u32 stdin_cli_file_index;
434 /** File pool index of current input. */
435 u32 current_input_file_index;
438 /** CLI global state */
439 static unix_cli_main_t unix_cli_main;
442 * @brief Search for a byte sequence in the action list.
444 * Searches the @ref unix_cli_parse_actions_t list in @a a for a match with
445 * the bytes in @a input of maximum length @a ilen bytes.
446 * When a match is made @a *matched indicates how many bytes were matched.
447 * Returns a value from the enum @ref unix_cli_parse_action_t to indicate
448 * whether no match was found, a partial match was found or a complete
449 * match was found and what action, if any, should be taken.
451 * @param[in] a Actions list to search within.
452 * @param[in] input String fragment to search for.
453 * @param[in] ilen Length of the string in 'input'.
454 * @param[out] matched Pointer to an integer that will contain the number
455 * of bytes matched when a complete match is found.
457 * @return Action from @ref unix_cli_parse_action_t that the string fragment
459 * @ref UNIX_CLI_PARSE_ACTION_PARTIALMATCH is returned when the
460 * whole input string matches the start of at least one action.
461 * @ref UNIX_CLI_PARSE_ACTION_NOMATCH is returned when there is no
464 static unix_cli_parse_action_t
465 unix_cli_match_action (unix_cli_parse_actions_t * a,
466 u8 * input, u32 ilen, i32 * matched)
474 /* see if the start of the input buffer exactly matches the current
476 if (memcmp (input, a->input, a->len) == 0)
484 /* if the first ilen characters match, flag this as a partial -
485 * meaning keep collecting bytes in case of a future match */
486 if (memcmp (input, a->input, ilen) == 0)
490 /* check next action */
495 UNIX_CLI_PARSE_ACTION_PARTIALMATCH : UNIX_CLI_PARSE_ACTION_NOMATCH;
499 /** Add bytes to the output vector and then flagg the I/O system that bytes
500 * are available to be sent.
503 unix_cli_add_pending_output (unix_file_t * uf,
504 unix_cli_file_t * cf,
505 u8 * buffer, uword buffer_bytes)
507 unix_main_t *um = &unix_main;
509 vec_add (cf->output_vector, buffer, buffer_bytes);
510 if (vec_len (cf->output_vector) > 0)
512 int skip_update = 0 != (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
513 uf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
515 um->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
519 /** Delete all bytes from the output vector and flag the I/O system
520 * that no more bytes are available to be sent.
523 unix_cli_del_pending_output (unix_file_t * uf,
524 unix_cli_file_t * cf, uword n_bytes)
526 unix_main_t *um = &unix_main;
528 vec_delete (cf->output_vector, n_bytes, 0);
529 if (vec_len (cf->output_vector) <= 0)
531 int skip_update = 0 == (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
532 uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
534 um->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
538 /** @brief A bit like strchr with a buffer length limit.
539 * Search a buffer for the first instance of a character up to the limit of
540 * the buffer length. If found then return the position of that character.
542 * The key departure from strchr is that if the character is not found then
543 * return the buffer length.
545 * @param chr The byte value to search for.
546 * @param str The buffer in which to search for the value.
547 * @param len The depth into the buffer to search.
549 * @return The index of the first occurence of \c chr. If \c chr is not
550 * found then \c len instead.
553 unix_vlib_findchr (u8 chr, u8 * str, word len)
556 for (i = 0; i < len; i++, str++)
564 /** @brief Send a buffer to the CLI stream if possible, enqueue it otherwise.
565 * Attempts to write given buffer to the file descriptor of the given
566 * Unix CLI session. If that session already has data in the output buffer
567 * or if the write attempt tells us to try again later then the given buffer
568 * is appended to the pending output buffer instead.
570 * This is typically called only from \c unix_vlib_cli_output_cooked since
571 * that is where CRLF handling occurs or from places where we explicitly do
572 * not want cooked handling.
574 * @param cf Unix CLI session of the desired stream to write to.
575 * @param uf The Unix file structure of the desired stream to write to.
576 * @param buffer Pointer to the buffer that needs to be written.
577 * @param buffer_bytes The number of bytes from \c buffer to write.
580 unix_vlib_cli_output_raw (unix_cli_file_t * cf,
581 unix_file_t * uf, u8 * buffer, uword buffer_bytes)
585 if (vec_len (cf->output_vector) == 0)
586 n = write (uf->file_descriptor, buffer, buffer_bytes);
588 if (n < 0 && errno != EAGAIN)
590 clib_unix_warning ("write");
592 else if ((word) n < (word) buffer_bytes)
594 /* We got EAGAIN or we already have stuff in the buffer;
595 * queue up whatever didn't get sent for later. */
598 unix_cli_add_pending_output (uf, cf, buffer + n, buffer_bytes - n);
602 /** @brief Process a buffer for CRLF handling before outputting it to the CLI.
604 * @param cf Unix CLI session of the desired stream to write to.
605 * @param uf The Unix file structure of the desired stream to write to.
606 * @param buffer Pointer to the buffer that needs to be written.
607 * @param buffer_bytes The number of bytes from \c buffer to write.
610 unix_vlib_cli_output_cooked (unix_cli_file_t * cf,
612 u8 * buffer, uword buffer_bytes)
614 word end = 0, start = 0;
616 while (end < buffer_bytes)
620 /* iterate the line on \n's so we can insert a \r before it */
621 end = unix_vlib_findchr ('\n',
623 buffer_bytes - start) + start;
627 /* otherwise just send the whole buffer */
631 unix_vlib_cli_output_raw (cf, uf, buffer + start, end - start);
635 if (end < buffer_bytes)
637 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\r\n", 2);
638 end++; /* skip the \n that we already sent */
645 /** @brief Output the CLI prompt */
647 unix_cli_cli_prompt (unix_cli_file_t * cf, unix_file_t * uf)
649 unix_cli_main_t *cm = &unix_cli_main;
651 unix_vlib_cli_output_raw (cf, uf, cm->cli_prompt, vec_len (cm->cli_prompt));
654 /** @brief Output a pager prompt and show number of buffered lines */
656 unix_cli_pager_prompt (unix_cli_file_t * cf, unix_file_t * uf)
661 h = cf->pager_start + (cf->height - 1);
662 if (h > vec_len (cf->pager_index))
663 h = vec_len (cf->pager_index);
665 prompt = format (0, "\r%s-- more -- (%d-%d/%d)%s",
666 cf->ansi_capable ? ANSI_BOLD : "",
669 vec_len (cf->pager_index),
670 cf->ansi_capable ? ANSI_RESET : "");
672 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
677 /** @brief Output a pager "skipping" message */
679 unix_cli_pager_message (unix_cli_file_t * cf, unix_file_t * uf,
680 char *message, char *postfix)
684 prompt = format (0, "\r%s-- %s --%s%s",
685 cf->ansi_capable ? ANSI_BOLD : "",
686 message, cf->ansi_capable ? ANSI_RESET : "", postfix);
688 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
693 /** @brief Erase the printed pager prompt */
695 unix_cli_pager_prompt_erase (unix_cli_file_t * cf, unix_file_t * uf)
697 if (cf->ansi_capable)
699 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
700 unix_vlib_cli_output_cooked (cf, uf,
701 (u8 *) ANSI_CLEARLINE,
702 sizeof (ANSI_CLEARLINE) - 1);
708 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
709 for (i = 0; i < cf->width - 1; i++)
710 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
711 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
715 /** @brief Uses an ANSI escape sequence to move the cursor */
717 unix_cli_ansi_cursor (unix_cli_file_t * cf, unix_file_t * uf, u16 x, u16 y)
721 str = format (0, "%s%d;%dH", CSI, y, x);
723 unix_vlib_cli_output_cooked (cf, uf, str, vec_len (str));
728 /** Redraw the currently displayed page of text.
729 * @param cf CLI session to redraw the pager buffer of.
730 * @param uf Unix file of the CLI session.
733 unix_cli_pager_redraw (unix_cli_file_t * cf, unix_file_t * uf)
735 unix_cli_pager_index_t *pi = NULL;
739 /* No active pager? Do nothing. */
740 if (!vec_len (cf->pager_index))
743 if (cf->ansi_capable)
745 /* If we have ANSI, send the clear screen sequence */
746 unix_vlib_cli_output_cooked (cf, uf,
748 sizeof (ANSI_CLEAR) - 1);
752 /* Otherwise make sure we're on a blank line */
753 unix_cli_pager_prompt_erase (cf, uf);
756 /* (Re-)send the current page of content */
757 for (i = 0; i < cf->height - 1 &&
758 i + cf->pager_start < vec_len (cf->pager_index); i++)
760 pi = &cf->pager_index[cf->pager_start + i];
761 line = cf->pager_vector[pi->line] + pi->offset;
763 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
765 /* if the last line didn't end in newline, add a newline */
766 if (pi && line[pi->length - 1] != '\n')
767 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
769 unix_cli_pager_prompt (cf, uf);
772 /** @brief Process and add a line to the pager index.
773 * In normal operation this function will take the given character string
774 * found in @c line and with length @c len_or_index and iterates the over the
775 * contents, adding each line of text discovered within it to the
776 * pager index. Lines are identified by newlines ("<code>\\n</code>") and by
777 * strings longer than the width of the terminal.
779 * If instead @c line is @c NULL then @c len_or_index is taken to mean the
780 * index of an existing line in the pager buffer; this simply means that the
781 * input line does not need to be cloned since we alreayd have it. This is
782 * typical if we are reindexing the pager buffer.
784 * @param cf The CLI session whose pager we are adding to.
785 * @param line The string of text to be indexed into the pager buffer.
786 * If @c line is @c NULL then the mode of operation
787 * changes slightly; see the description above.
788 * @param len_or_index If @c line is a pointer to a string then this parameter
789 * indicates the length of that string; Otherwise this
790 * value provides the index in the pager buffer of an
791 * existing string to be indexed.
794 unix_cli_pager_add_line (unix_cli_file_t * cf, u8 * line, word len_or_index)
798 word line_index, len;
799 u32 width = cf->width;
800 unix_cli_pager_index_t *pi;
804 /* Use a line already in the pager buffer */
805 line_index = len_or_index;
806 p = cf->pager_vector[line_index];
812 /* Add a copy of the raw string to the pager buffer */
813 p = vec_new (u8, len);
814 clib_memcpy (p, line, len);
816 /* store in pager buffer */
817 line_index = vec_len (cf->pager_vector);
818 vec_add1 (cf->pager_vector, p);
824 /* Find the next line, or run to terminal width, or run to EOL */
826 j = unix_vlib_findchr ((u8) '\n', p, l < width ? l : width);
828 if (j < l && p[j] == '\n') /* incl \n */
831 /* Add the line to the index */
832 k = vec_len (cf->pager_index);
833 vec_validate (cf->pager_index, k);
834 pi = &cf->pager_index[k];
836 pi->line = line_index;
845 /** @brief Reindex entire pager buffer.
846 * Resets the current pager index and then re-adds the lines in the pager
847 * buffer to the index.
849 * Additionally this function attempts to retain the current page start
850 * line offset by searching for the same top-of-screen line in the new index.
852 * @param cf The CLI session whose pager buffer should be reindexed.
855 unix_cli_pager_reindex (unix_cli_file_t * cf)
857 word i, old_line, old_offset;
858 unix_cli_pager_index_t *pi;
860 /* If there is nothing in the pager buffer then make sure the index
861 * is empty and move on.
863 if (cf->pager_vector == 0)
865 vec_reset_length (cf->pager_index);
869 /* Retain a pointer to the current page start line so we can
872 pi = &cf->pager_index[cf->pager_start];
874 old_offset = pi->offset;
876 /* Re-add the buffered lines to the index */
877 vec_reset_length (cf->pager_index);
878 vec_foreach_index (i, cf->pager_vector)
880 unix_cli_pager_add_line (cf, NULL, i);
883 /* Attempt to re-locate the previously stored page start line */
884 vec_foreach_index (i, cf->pager_index)
886 pi = &cf->pager_index[i];
888 if (pi->line == old_line &&
889 (pi->offset <= old_offset || pi->offset + pi->length > old_offset))
897 /* In case the start line was not found (rare), ensure the pager start
898 * index is within bounds
900 if (cf->pager_start >= vec_len (cf->pager_index))
902 if (!cf->height || vec_len (cf->pager_index) < (cf->height - 1))
905 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
909 /** VLIB CLI output function.
911 * If the terminal has a pager configured then this function takes care
912 * of collating output into the pager buffer; ensuring only the first page
913 * is displayed and any lines in excess of the first page are buffered.
915 * If the maximum number of index lines in the buffer is exceeded then the
916 * pager is cancelled and the contents of the current buffer are sent to the
919 * If there is no pager configured then the output is sent directly to the
922 * @param cli_file_index Index of the CLI session where this output is
924 * @param buffer String of printabe bytes to be output.
925 * @param buffer_bytes The number of bytes in @c buffer to be output.
928 unix_vlib_cli_output (uword cli_file_index, u8 * buffer, uword buffer_bytes)
930 unix_main_t *um = &unix_main;
931 unix_cli_main_t *cm = &unix_cli_main;
935 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
936 uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
938 if (cf->no_pager || um->cli_pager_buffer_limit == 0 || cf->height == 0)
940 unix_vlib_cli_output_cooked (cf, uf, buffer, buffer_bytes);
944 word row = vec_len (cf->pager_index);
946 unix_cli_pager_index_t *pi;
948 /* Index and add the output lines to the pager buffer. */
949 unix_cli_pager_add_line (cf, buffer, buffer_bytes);
951 /* Now iterate what was added to display the lines.
952 * If we reach the bottom of the page, display a prompt.
954 while (row < vec_len (cf->pager_index))
956 if (row < cf->height - 1)
958 /* output this line */
959 pi = &cf->pager_index[row];
960 line = cf->pager_vector[pi->line] + pi->offset;
961 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
963 /* if the last line didn't end in newline, and we're at the
964 * bottom of the page, add a newline */
965 if (line[pi->length - 1] != '\n' && row == cf->height - 2)
966 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
970 /* Display the pager prompt every 10 lines */
972 unix_cli_pager_prompt (cf, uf);
977 /* Check if we went over the pager buffer limit */
978 if (vec_len (cf->pager_index) > um->cli_pager_buffer_limit)
980 /* Stop using the pager for the remainder of this CLI command */
983 /* If we likely printed the prompt, erase it */
984 if (vec_len (cf->pager_index) > cf->height - 1)
985 unix_cli_pager_prompt_erase (cf, uf);
987 /* Dump out the contents of the buffer */
988 for (row = cf->pager_start + (cf->height - 1);
989 row < vec_len (cf->pager_index); row++)
991 pi = &cf->pager_index[row];
992 line = cf->pager_vector[pi->line] + pi->offset;
993 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
996 unix_cli_pager_reset (cf);
1001 /** Identify whether a terminal type is ANSI capable.
1003 * Compares the string given in @c term with a list of terminal types known
1004 * to support ANSI escape sequences.
1006 * This list contains, for example, @c xterm, @c screen and @c ansi.
1008 * @param term A string with a terminal type in it.
1009 * @param len The length of the string in @c term.
1011 * @return @c 1 if the terminal type is recognized as supporting ANSI
1012 * terminal sequences; @c 0 otherwise.
1015 unix_cli_terminal_type (u8 * term, uword len)
1017 /* This may later be better done as a hash of some sort. */
1019 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1024 _("xterm-256color"); /* iTerm on Mac */
1026 _("ansi"); /* Microsoft Telnet */
1032 /** @brief Emit initial welcome banner and prompt on a connection. */
1034 unix_cli_file_welcome (unix_cli_main_t * cm, unix_cli_file_t * cf)
1036 unix_main_t *um = &unix_main;
1037 unix_file_t *uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
1038 unix_cli_banner_t *banner;
1042 * Put the first bytes directly into the buffer so that further output is
1043 * queued until everything is ready. (oterwise initial prompt can appear
1044 * mid way through VPP initialization)
1046 unix_cli_add_pending_output (uf, cf, (u8 *) "\r", 1);
1048 if (!um->cli_no_banner)
1050 if (cf->ansi_capable)
1052 banner = unix_cli_banner_color;
1053 len = ARRAY_LEN (unix_cli_banner_color);
1057 banner = unix_cli_banner;
1058 len = ARRAY_LEN (unix_cli_banner);
1061 for (i = 0; i < len; i++)
1063 unix_vlib_cli_output_cooked (cf, uf,
1064 banner[i].line, banner[i].length);
1069 unix_cli_cli_prompt (cf, uf);
1074 /** @brief A failsafe triggered on a timer to ensure we send the prompt
1075 * to telnet sessions that fail to negotiate the terminal type. */
1077 unix_cli_file_welcome_timer (any arg, f64 delay)
1079 unix_cli_main_t *cm = &unix_cli_main;
1080 unix_cli_file_t *cf;
1083 /* Check the connection didn't close already */
1084 if (pool_is_free_index (cm->cli_file_pool, (uword) arg))
1087 cf = pool_elt_at_index (cm->cli_file_pool, (uword) arg);
1090 unix_cli_file_welcome (cm, cf);
1093 /** @brief A mostly no-op Telnet state machine.
1094 * Process Telnet command bytes in a way that ensures we're mostly
1095 * transparent to the Telnet protocol. That is, it's mostly a no-op.
1097 * @return -1 if we need more bytes, otherwise a positive integer number of
1098 * bytes to consume from the input_vector, not including the initial
1102 unix_cli_process_telnet (unix_main_t * um,
1103 unix_cli_file_t * cf,
1104 unix_file_t * uf, u8 * input_vector, uword len)
1106 /* Input_vector starts at IAC byte.
1107 * See if we have a complete message; if not, return -1 so we wait for more.
1108 * if we have a complete message, consume those bytes from the vector.
1113 return -1; /* want more bytes */
1115 switch (input_vector[1])
1118 /* two IAC's in a row means to pass through 0xff.
1119 * since that makes no sense here, just consume it.
1128 /* Expect 3 bytes */
1129 if (vec_len (input_vector) < 3)
1130 return -1; /* want more bytes */
1137 /* Sub option - search ahead for IAC SE to end it */
1139 for (i = 3; i < len && i < UNIX_CLI_MAX_DEPTH_TELNET; i++)
1141 if (input_vector[i - 1] == IAC && input_vector[i] == SE)
1143 /* We have a complete message; see if we care about it */
1144 switch (input_vector[2])
1147 if (input_vector[3] != 0)
1149 /* See if the terminal type is ANSI capable */
1151 unix_cli_terminal_type (input_vector + 4, i - 5);
1152 /* If session not started, we can release the pause */
1154 /* Send the welcome banner and initial prompt */
1155 unix_cli_file_welcome (&unix_cli_main, cf);
1160 if (i != 8) /* check message is correct size */
1163 clib_net_to_host_u16 (*((u16 *) (input_vector + 3)));
1165 clib_net_to_host_u16 (*((u16 *) (input_vector + 5)));
1166 /* reindex pager buffer */
1167 unix_cli_pager_reindex (cf);
1169 unix_cli_pager_redraw (cf, uf);
1175 /* Consume it all */
1181 if (i == UNIX_CLI_MAX_DEPTH_TELNET)
1182 consume = 1; /* hit max search depth, advance one byte */
1185 return -1; /* want more bytes */
1203 /* Simple one-byte messages */
1208 /* Are You There - trigger a visible response */
1210 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "fd.io VPP\n", 10);
1214 /* Unknown command! Eat the IAC byte */
1221 /** @brief Process actionable input.
1222 * Based on the \c action process the input; this typically involves
1223 * searching the command history or editing the current command line.
1226 unix_cli_line_process_one (unix_cli_main_t * cm,
1228 unix_cli_file_t * cf,
1230 u8 input, unix_cli_parse_action_t action)
1237 case UNIX_CLI_PARSE_ACTION_NOACTION:
1240 case UNIX_CLI_PARSE_ACTION_REVSEARCH:
1241 case UNIX_CLI_PARSE_ACTION_FWDSEARCH:
1242 if (!cf->has_history || !cf->history_limit)
1244 if (cf->search_mode == 0)
1246 /* Erase the current command (if any) */
1247 for (j = 0; j < (vec_len (cf->current_command)); j++)
1248 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b \b", 3);
1250 vec_reset_length (cf->search_key);
1251 vec_reset_length (cf->current_command);
1252 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1253 cf->search_mode = -1;
1255 cf->search_mode = 1;
1260 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1261 cf->search_mode = -1;
1263 cf->search_mode = 1;
1265 cf->excursion += cf->search_mode;
1270 case UNIX_CLI_PARSE_ACTION_ERASELINELEFT:
1271 /* Erase the command from the cursor to the start */
1273 /* Shimmy forwards to the new end of line position */
1274 delta = vec_len (cf->current_command) - cf->cursor;
1275 for (j = cf->cursor; j > delta; j--)
1276 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1277 /* Zap from here to the end of what is currently displayed */
1278 for (; j < (vec_len (cf->current_command)); j++)
1279 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1280 /* Get back to the start of the line */
1281 for (j = 0; j < (vec_len (cf->current_command)); j++)
1282 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1284 j = vec_len (cf->current_command) - cf->cursor;
1285 memmove (cf->current_command, cf->current_command + cf->cursor, j);
1286 _vec_len (cf->current_command) = j;
1288 /* Print the new contents */
1289 unix_vlib_cli_output_cooked (cf, uf, cf->current_command, j);
1290 /* Shimmy back to the start */
1291 for (j = 0; j < (vec_len (cf->current_command)); j++)
1292 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1295 cf->search_mode = 0;
1298 case UNIX_CLI_PARSE_ACTION_ERASELINERIGHT:
1299 /* Erase the command from the cursor to the end */
1301 /* Zap from cursor to end of what is currently displayed */
1302 for (j = cf->cursor; j < (vec_len (cf->current_command)); j++)
1303 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1304 /* Get back to where we were */
1305 for (j = cf->cursor; j < (vec_len (cf->current_command)); j++)
1306 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1308 /* Truncate the line at the cursor */
1309 _vec_len (cf->current_command) = cf->cursor;
1311 cf->search_mode = 0;
1314 case UNIX_CLI_PARSE_ACTION_LEFT:
1317 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1321 cf->search_mode = 0;
1324 case UNIX_CLI_PARSE_ACTION_RIGHT:
1325 if (cf->cursor < vec_len (cf->current_command))
1327 /* have to emit the character under the cursor */
1328 unix_vlib_cli_output_cooked (cf, uf,
1329 cf->current_command + cf->cursor, 1);
1333 cf->search_mode = 0;
1336 case UNIX_CLI_PARSE_ACTION_UP:
1337 case UNIX_CLI_PARSE_ACTION_DOWN:
1338 if (!cf->has_history || !cf->history_limit)
1340 cf->search_mode = 0;
1341 /* Erase the command */
1342 for (j = cf->cursor; j < (vec_len (cf->current_command)); j++)
1343 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1344 for (j = 0; j < (vec_len (cf->current_command)); j++)
1345 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b \b", 3);
1346 vec_reset_length (cf->current_command);
1347 if (vec_len (cf->command_history))
1349 if (action == UNIX_CLI_PARSE_ACTION_UP)
1354 cf->excursion += delta;
1356 if (cf->excursion == vec_len (cf->command_history))
1358 /* down-arrowed to last entry - want a blank line */
1359 _vec_len (cf->current_command) = 0;
1361 else if (cf->excursion < 0)
1363 /* up-arrowed over the start to the end, want a blank line */
1364 cf->excursion = vec_len (cf->command_history);
1365 _vec_len (cf->current_command) = 0;
1369 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1370 /* down-arrowed past end - wrap to start */
1373 /* Print the command at the current position */
1374 prev = cf->command_history[cf->excursion];
1375 vec_validate (cf->current_command, vec_len (prev) - 1);
1377 clib_memcpy (cf->current_command, prev, vec_len (prev));
1378 _vec_len (cf->current_command) = vec_len (prev);
1379 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1380 vec_len (cf->current_command));
1382 cf->cursor = vec_len (cf->current_command);
1388 case UNIX_CLI_PARSE_ACTION_HOME:
1389 if (vec_len (cf->current_command) && cf->cursor > 0)
1393 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1398 cf->search_mode = 0;
1401 case UNIX_CLI_PARSE_ACTION_END:
1402 if (vec_len (cf->current_command) &&
1403 cf->cursor < vec_len (cf->current_command))
1405 unix_vlib_cli_output_cooked (cf, uf,
1406 cf->current_command + cf->cursor,
1407 vec_len (cf->current_command) -
1409 cf->cursor = vec_len (cf->current_command);
1412 cf->search_mode = 0;
1415 case UNIX_CLI_PARSE_ACTION_WORDLEFT:
1416 if (vec_len (cf->current_command) && cf->cursor > 0)
1420 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1423 while (j && isspace (cf->current_command[j]))
1425 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1428 while (j && !isspace (cf->current_command[j]))
1430 if (isspace (cf->current_command[j - 1]))
1432 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1439 cf->search_mode = 0;
1442 case UNIX_CLI_PARSE_ACTION_WORDRIGHT:
1443 if (vec_len (cf->current_command) &&
1444 cf->cursor < vec_len (cf->current_command))
1446 int e = vec_len (cf->current_command);
1448 while (j < e && !isspace (cf->current_command[j]))
1450 while (j < e && isspace (cf->current_command[j]))
1452 unix_vlib_cli_output_cooked (cf, uf,
1453 cf->current_command + cf->cursor,
1458 cf->search_mode = 0;
1462 case UNIX_CLI_PARSE_ACTION_ERASE:
1463 if (vec_len (cf->current_command))
1465 if (cf->cursor == vec_len (cf->current_command))
1467 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b \b", 3);
1468 _vec_len (cf->current_command)--;
1471 else if (cf->cursor > 0)
1473 /* shift everything at & to the right of the cursor left by 1 */
1474 j = vec_len (cf->current_command) - cf->cursor;
1475 memmove (cf->current_command + cf->cursor - 1,
1476 cf->current_command + cf->cursor, j);
1477 _vec_len (cf->current_command)--;
1479 /* redraw the rest of the line */
1480 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1481 unix_vlib_cli_output_cooked (cf, uf,
1482 cf->current_command + cf->cursor,
1484 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " \b\b", 3);
1485 /* and shift the terminal cursor back where it should be */
1487 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1490 cf->search_mode = 0;
1492 vec_reset_length (cf->search_key);
1495 case UNIX_CLI_PARSE_ACTION_ERASERIGHT:
1496 if (vec_len (cf->current_command))
1498 if (cf->cursor < vec_len (cf->current_command))
1500 /* shift everything to the right of the cursor left by 1 */
1501 j = vec_len (cf->current_command) - cf->cursor - 1;
1502 memmove (cf->current_command + cf->cursor,
1503 cf->current_command + cf->cursor + 1, j);
1504 _vec_len (cf->current_command)--;
1505 /* redraw the rest of the line */
1506 unix_vlib_cli_output_cooked (cf, uf,
1507 cf->current_command + cf->cursor,
1509 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " \b", 2);
1510 /* and shift the terminal cursor back where it should be */
1513 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1515 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1519 else if (input == 'D' - '@')
1521 /* ^D with no command entered = quit */
1522 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "quit\n", 5);
1523 vlib_process_signal_event (um->vlib_main,
1524 vlib_current_process (um->vlib_main),
1525 UNIX_CLI_PROCESS_EVENT_QUIT,
1526 cf - cm->cli_file_pool);
1528 cf->search_mode = 0;
1530 vec_reset_length (cf->search_key);
1533 case UNIX_CLI_PARSE_ACTION_CLEAR:
1534 /* If we're in ANSI mode, clear the screen.
1535 * Then redraw the prompt and any existing command input, then put
1536 * the cursor back where it was in that line.
1538 if (cf->ansi_capable)
1539 unix_vlib_cli_output_cooked (cf, uf,
1541 sizeof (ANSI_CLEAR) - 1);
1543 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1545 unix_vlib_cli_output_raw (cf, uf,
1546 cm->cli_prompt, vec_len (cm->cli_prompt));
1547 unix_vlib_cli_output_raw (cf, uf,
1548 cf->current_command,
1549 vec_len (cf->current_command));
1550 for (j = cf->cursor; j < vec_len (cf->current_command); j++)
1551 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1555 case UNIX_CLI_PARSE_ACTION_TAB:
1556 case UNIX_CLI_PARSE_ACTION_YANK:
1561 case UNIX_CLI_PARSE_ACTION_PAGER_QUIT:
1563 unix_cli_pager_prompt_erase (cf, uf);
1564 unix_cli_pager_reset (cf);
1565 unix_cli_cli_prompt (cf, uf);
1568 case UNIX_CLI_PARSE_ACTION_PAGER_NEXT:
1569 case UNIX_CLI_PARSE_ACTION_PAGER_PGDN:
1570 /* show next page of the buffer */
1571 if (cf->height + cf->pager_start < vec_len (cf->pager_index))
1574 unix_cli_pager_index_t *pi = NULL;
1576 int m = cf->pager_start + (cf->height - 1);
1577 unix_cli_pager_prompt_erase (cf, uf);
1579 j < vec_len (cf->pager_index) && cf->pager_start < m;
1580 j++, cf->pager_start++)
1582 pi = &cf->pager_index[j];
1583 line = cf->pager_vector[pi->line] + pi->offset;
1584 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1586 /* if the last line didn't end in newline, add a newline */
1587 if (pi && line[pi->length - 1] != '\n')
1588 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1589 unix_cli_pager_prompt (cf, uf);
1593 if (action == UNIX_CLI_PARSE_ACTION_PAGER_NEXT)
1594 /* no more in buffer, exit, but only if it was <space> */
1599 case UNIX_CLI_PARSE_ACTION_PAGER_DN:
1600 case UNIX_CLI_PARSE_ACTION_PAGER_CRLF:
1601 /* display the next line of the buffer */
1602 if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
1605 unix_cli_pager_index_t *pi;
1607 unix_cli_pager_prompt_erase (cf, uf);
1608 pi = &cf->pager_index[cf->pager_start + (cf->height - 1)];
1609 line = cf->pager_vector[pi->line] + pi->offset;
1610 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1612 /* if the last line didn't end in newline, add a newline */
1613 if (line[pi->length - 1] != '\n')
1614 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1615 unix_cli_pager_prompt (cf, uf);
1619 if (action == UNIX_CLI_PARSE_ACTION_PAGER_CRLF)
1620 /* no more in buffer, exit, but only if it was <enter> */
1626 case UNIX_CLI_PARSE_ACTION_PAGER_UP:
1627 /* scroll the page back one line */
1628 if (cf->pager_start > 0)
1631 unix_cli_pager_index_t *pi = NULL;
1634 if (cf->ansi_capable)
1636 pi = &cf->pager_index[cf->pager_start];
1637 line = cf->pager_vector[pi->line] + pi->offset;
1638 unix_cli_pager_prompt_erase (cf, uf);
1639 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SCROLLDN,
1640 sizeof (ANSI_SCROLLDN) - 1);
1641 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SAVECURSOR,
1642 sizeof (ANSI_SAVECURSOR) - 1);
1643 unix_cli_ansi_cursor (cf, uf, 1, 1);
1644 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_CLEARLINE,
1645 sizeof (ANSI_CLEARLINE) - 1);
1646 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1647 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_RESTCURSOR,
1648 sizeof (ANSI_RESTCURSOR) - 1);
1649 unix_cli_pager_prompt_erase (cf, uf);
1650 unix_cli_pager_prompt (cf, uf);
1654 int m = cf->pager_start + (cf->height - 1);
1655 unix_cli_pager_prompt_erase (cf, uf);
1656 for (j = cf->pager_start;
1657 j < vec_len (cf->pager_index) && j < m; j++)
1659 pi = &cf->pager_index[j];
1660 line = cf->pager_vector[pi->line] + pi->offset;
1661 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1663 /* if the last line didn't end in newline, add a newline */
1664 if (pi && line[pi->length - 1] != '\n')
1665 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1666 unix_cli_pager_prompt (cf, uf);
1671 case UNIX_CLI_PARSE_ACTION_PAGER_TOP:
1672 /* back to the first page of the buffer */
1673 if (cf->pager_start > 0)
1676 unix_cli_pager_index_t *pi = NULL;
1678 cf->pager_start = 0;
1679 int m = cf->pager_start + (cf->height - 1);
1680 unix_cli_pager_prompt_erase (cf, uf);
1681 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
1684 pi = &cf->pager_index[j];
1685 line = cf->pager_vector[pi->line] + pi->offset;
1686 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1688 /* if the last line didn't end in newline, add a newline */
1689 if (pi && line[pi->length - 1] != '\n')
1690 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1691 unix_cli_pager_prompt (cf, uf);
1695 case UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM:
1696 /* skip to the last page of the buffer */
1697 if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
1700 unix_cli_pager_index_t *pi = NULL;
1702 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
1703 unix_cli_pager_prompt_erase (cf, uf);
1704 unix_cli_pager_message (cf, uf, "skipping", "\n");
1705 for (j = cf->pager_start; j < vec_len (cf->pager_index); j++)
1707 pi = &cf->pager_index[j];
1708 line = cf->pager_vector[pi->line] + pi->offset;
1709 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1711 /* if the last line didn't end in newline, add a newline */
1712 if (pi && line[pi->length - 1] != '\n')
1713 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1714 unix_cli_pager_prompt (cf, uf);
1718 case UNIX_CLI_PARSE_ACTION_PAGER_PGUP:
1719 /* wander back one page in the buffer */
1720 if (cf->pager_start > 0)
1723 unix_cli_pager_index_t *pi = NULL;
1726 if (cf->pager_start >= cf->height)
1727 cf->pager_start -= cf->height - 1;
1729 cf->pager_start = 0;
1730 m = cf->pager_start + cf->height - 1;
1731 unix_cli_pager_prompt_erase (cf, uf);
1732 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
1735 pi = &cf->pager_index[j];
1736 line = cf->pager_vector[pi->line] + pi->offset;
1737 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1739 /* if the last line didn't end in newline, add a newline */
1740 if (pi && line[pi->length - 1] != '\n')
1741 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1742 unix_cli_pager_prompt (cf, uf);
1746 case UNIX_CLI_PARSE_ACTION_PAGER_REDRAW:
1747 /* Redraw the current pager screen */
1748 unix_cli_pager_redraw (cf, uf);
1751 case UNIX_CLI_PARSE_ACTION_PAGER_SEARCH:
1752 /* search forwards in the buffer */
1756 case UNIX_CLI_PARSE_ACTION_CRLF:
1758 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1760 if (cf->has_history && cf->history_limit)
1762 if (cf->command_history
1763 && vec_len (cf->command_history) >= cf->history_limit)
1765 vec_free (cf->command_history[0]);
1766 vec_delete (cf->command_history, 1, 0);
1768 /* Don't add blank lines to the cmd history */
1769 if (vec_len (cf->current_command))
1771 /* Don't duplicate the previous command */
1772 j = vec_len (cf->command_history);
1774 (vec_len (cf->current_command) !=
1775 vec_len (cf->command_history[j - 1])
1776 || memcmp (cf->current_command, cf->command_history[j - 1],
1777 vec_len (cf->current_command)) != 0))
1779 /* copy the command to the history */
1781 vec_append (c, cf->current_command);
1782 vec_add1 (cf->command_history, c);
1783 cf->command_number++;
1786 cf->excursion = vec_len (cf->command_history);
1789 cf->search_mode = 0;
1790 vec_reset_length (cf->search_key);
1795 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
1796 case UNIX_CLI_PARSE_ACTION_NOMATCH:
1797 if (vec_len (cf->pager_index))
1801 else if (cf->has_history && cf->search_mode && isprint (input))
1803 int k, limit, offset;
1806 vec_add1 (cf->search_key, input);
1809 for (j = 0; j < vec_len (cf->command_history); j++)
1811 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1813 else if (cf->excursion < 0)
1814 cf->excursion = vec_len (cf->command_history) - 1;
1816 item = cf->command_history[cf->excursion];
1818 limit = (vec_len (cf->search_key) > vec_len (item)) ?
1819 vec_len (item) : vec_len (cf->search_key);
1821 for (offset = 0; offset <= vec_len (item) - limit; offset++)
1823 for (k = 0; k < limit; k++)
1825 if (item[k + offset] != cf->search_key[k])
1828 goto found_at_offset;
1836 for (j = 0; j < vec_len (cf->current_command); j++)
1837 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b \b", 3);
1839 vec_validate (cf->current_command, vec_len (item) - 1);
1840 clib_memcpy (cf->current_command, item, vec_len (item));
1841 _vec_len (cf->current_command) = vec_len (item);
1843 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1844 vec_len (cf->current_command));
1845 cf->cursor = vec_len (cf->current_command);
1849 cf->excursion += cf->search_mode;
1852 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\nNo match...", 12);
1853 vec_reset_length (cf->search_key);
1854 vec_reset_length (cf->current_command);
1855 cf->search_mode = 0;
1859 else if (isprint (input)) /* skip any errant control codes */
1861 if (cf->cursor == vec_len (cf->current_command))
1864 vec_add1 (cf->current_command, input);
1867 /* Echo the character back to the client */
1868 unix_vlib_cli_output_raw (cf, uf, &input, 1);
1872 /* Insert at cursor: resize +1 byte, move everything over */
1873 j = vec_len (cf->current_command) - cf->cursor;
1874 vec_add1 (cf->current_command, (u8) 'A');
1875 memmove (cf->current_command + cf->cursor + 1,
1876 cf->current_command + cf->cursor, j);
1877 cf->current_command[cf->cursor] = input;
1878 /* Redraw the line */
1880 unix_vlib_cli_output_raw (cf, uf,
1881 cf->current_command + cf->cursor, j);
1882 /* Put terminal cursor back */
1884 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\b", 1);
1890 /* no-op - not printable or otherwise not actionable */
1897 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
1903 /** @brief Process input bytes on a stream to provide line editing and
1904 * command history in the CLI. */
1906 unix_cli_line_edit (unix_cli_main_t * cm,
1907 unix_main_t * um, unix_cli_file_t * cf)
1909 unix_file_t *uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
1912 for (i = 0; i < vec_len (cf->input_vector); i++)
1914 unix_cli_parse_action_t action;
1916 unix_cli_parse_actions_t *a;
1918 /* If we're in the pager mode, search the pager actions */
1920 vec_len (cf->pager_index) ? unix_cli_parse_pager :
1921 unix_cli_parse_strings;
1923 /* See if the input buffer is some sort of control code */
1924 action = unix_cli_match_action (a, &cf->input_vector[i],
1925 vec_len (cf->input_vector) - i,
1930 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
1933 /* There was a partial match which means we need more bytes
1934 * than the input buffer currently has.
1935 * Since the bytes before here have been processed, shift
1936 * the remaining contents to the start of the input buffer.
1938 vec_delete (cf->input_vector, i, 0);
1940 return 1; /* wait for more */
1942 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
1943 /* process telnet options */
1944 matched = unix_cli_process_telnet (um, cf, uf,
1945 cf->input_vector + i,
1946 vec_len (cf->input_vector) - i);
1951 /* There was a partial match which means we need more bytes
1952 * than the input buffer currently has.
1953 * Since the bytes before here have been processed, shift
1954 * the remaining contents to the start of the input buffer.
1956 vec_delete (cf->input_vector, i, 0);
1958 return 1; /* wait for more */
1963 /* process the action */
1964 if (!unix_cli_line_process_one (cm, um, cf, uf,
1965 cf->input_vector[i], action))
1967 /* CRLF found. Consume the bytes from the input_vector */
1968 vec_delete (cf->input_vector, i + matched, 0);
1969 /* And tell our caller to execute cf->input_command */
1977 vec_reset_length (cf->input_vector);
1981 /** @brief Process input to a CLI session. */
1983 unix_cli_process_input (unix_cli_main_t * cm, uword cli_file_index)
1985 unix_main_t *um = &unix_main;
1987 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
1988 unformat_input_t input;
1989 int vlib_parse_eval (u8 *);
1992 /* Try vlibplex first. Someday... */
1993 if (0 && vlib_parse_eval (cf->input_vector) == 0)
1998 /* just treat whatever we got as a complete line of input */
1999 cf->current_command = cf->input_vector;
2003 /* Line edit, echo, etc. */
2004 if (unix_cli_line_edit (cm, um, cf))
2005 /* want more input */
2012 vec_reset_length (lv);
2013 lv = format (lv, "%U[%d]: %v",
2014 format_timeval, 0 /* current bat-time */ ,
2015 0 /* current bat-format */ ,
2016 cli_file_index, cf->input_vector);
2018 int rv __attribute__ ((unused)) =
2019 write (um->log_fd, lv, vec_len (lv));
2023 /* Copy our input command to a new string */
2024 unformat_init_vector (&input, cf->current_command);
2026 /* Remove leading white space from input. */
2027 (void) unformat (&input, "");
2029 cm->current_input_file_index = cli_file_index;
2030 cf->pager_start = 0; /* start a new pager session */
2032 if (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
2033 vlib_cli_input (um->vlib_main, &input, unix_vlib_cli_output,
2036 /* Zero buffer since otherwise unformat_free will call vec_free on it. */
2039 unformat_free (&input);
2041 /* Re-fetch pointer since pool may have moved. */
2042 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2043 uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
2046 /* reset vector; we'll re-use it later */
2048 vec_reset_length (cf->input_vector);
2050 vec_reset_length (cf->current_command);
2052 if (cf->no_pager == 2)
2054 /* Pager was programmatically disabled */
2055 unix_cli_pager_message (cf, uf, "pager buffer overflowed", "\n");
2056 cf->no_pager = um->cli_no_pager;
2059 if (vec_len (cf->pager_index) == 0
2060 || vec_len (cf->pager_index) < cf->height)
2062 /* There was no need for the pager */
2063 unix_cli_pager_reset (cf);
2066 unix_cli_cli_prompt (cf, uf);
2070 /* Display the pager prompt */
2071 unix_cli_pager_prompt (cf, uf);
2074 /* Any residual data in the input vector? */
2075 if (vec_len (cf->input_vector))
2079 /** Destroy a CLI session.
2080 * @note If we destroy the @c stdin session this additionally signals
2081 * the shutdown of VPP.
2084 unix_cli_kill (unix_cli_main_t * cm, uword cli_file_index)
2086 unix_main_t *um = &unix_main;
2087 unix_cli_file_t *cf;
2091 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2092 uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
2094 /* Quit/EOF on stdin means quit program. */
2095 if (uf->file_descriptor == UNIX_CLI_STDIN_FD)
2096 clib_longjmp (&um->vlib_main->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
2098 vec_free (cf->current_command);
2099 vec_free (cf->search_key);
2101 for (i = 0; i < vec_len (cf->command_history); i++)
2102 vec_free (cf->command_history[i]);
2104 vec_free (cf->command_history);
2106 unix_file_del (um, uf);
2108 unix_cli_file_free (cf);
2109 pool_put (cm->cli_file_pool, cf);
2112 /** Handle system events. */
2114 unix_cli_process (vlib_main_t * vm,
2115 vlib_node_runtime_t * rt, vlib_frame_t * f)
2117 unix_cli_main_t *cm = &unix_cli_main;
2122 unix_cli_process_event_type_t event_type;
2123 vlib_process_wait_for_event (vm);
2124 event_type = vlib_process_get_events (vm, &data);
2128 case UNIX_CLI_PROCESS_EVENT_READ_READY:
2129 for (i = 0; i < vec_len (data); i++)
2130 unix_cli_process_input (cm, data[i]);
2133 case UNIX_CLI_PROCESS_EVENT_QUIT:
2134 /* Kill this process. */
2135 for (i = 0; i < vec_len (data); i++)
2136 unix_cli_kill (cm, data[i]);
2141 _vec_len (data) = 0;
2147 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
2149 /* Add node index so we can re-use this process later. */
2150 vec_add1 (cm->unused_cli_process_node_indices, rt->node_index);
2155 /** Called when a CLI session file descriptor can be written to without
2157 static clib_error_t *
2158 unix_cli_write_ready (unix_file_t * uf)
2160 unix_cli_main_t *cm = &unix_cli_main;
2161 unix_cli_file_t *cf;
2164 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2166 /* Flush output vector. */
2167 n = write (uf->file_descriptor,
2168 cf->output_vector, vec_len (cf->output_vector));
2170 if (n < 0 && errno != EAGAIN)
2171 return clib_error_return_unix (0, "write");
2174 unix_cli_del_pending_output (uf, cf, n);
2176 return /* no error */ 0;
2179 /** Called when a CLI session file descriptor has data to be read. */
2180 static clib_error_t *
2181 unix_cli_read_ready (unix_file_t * uf)
2183 unix_main_t *um = &unix_main;
2184 unix_cli_main_t *cm = &unix_cli_main;
2185 unix_cli_file_t *cf;
2187 int n, n_read, n_try;
2189 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2194 l = vec_len (cf->input_vector);
2195 vec_resize (cf->input_vector, l + n_try);
2197 n = read (uf->file_descriptor, cf->input_vector + l, n_try);
2200 if (n < 0 && errno != EAGAIN)
2201 return clib_error_return_unix (0, "read");
2203 n_read = n < 0 ? 0 : n;
2204 _vec_len (cf->input_vector) = l + n_read;
2208 vlib_process_signal_event (um->vlib_main,
2209 cf->process_node_index,
2211 ? UNIX_CLI_PROCESS_EVENT_QUIT
2212 : UNIX_CLI_PROCESS_EVENT_READ_READY),
2213 /* event data */ uf->private_data);
2215 return /* no error */ 0;
2218 /** Store a new CLI session.
2219 * @param name The name of the session.
2220 * @param fd The file descriptor for the session I/O.
2221 * @return The session ID.
2224 unix_cli_file_add (unix_cli_main_t * cm, char *name, int fd)
2226 unix_main_t *um = &unix_main;
2227 unix_cli_file_t *cf;
2228 unix_file_t template = { 0 };
2229 vlib_main_t *vm = um->vlib_main;
2232 name = (char *) format (0, "unix-cli-%s", name);
2234 if (vec_len (cm->unused_cli_process_node_indices) > 0)
2236 uword l = vec_len (cm->unused_cli_process_node_indices);
2238 /* Find node and give it new name. */
2239 n = vlib_get_node (vm, cm->unused_cli_process_node_indices[l - 1]);
2241 n->name = (u8 *) name;
2243 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
2245 _vec_len (cm->unused_cli_process_node_indices) = l - 1;
2249 static vlib_node_registration_t r = {
2250 .function = unix_cli_process,
2251 .type = VLIB_NODE_TYPE_PROCESS,
2252 .process_log2_n_stack_bytes = 16,
2256 vlib_register_node (vm, &r);
2259 n = vlib_get_node (vm, r.index);
2262 pool_get (cm->cli_file_pool, cf);
2263 memset (cf, 0, sizeof (*cf));
2265 template.read_function = unix_cli_read_ready;
2266 template.write_function = unix_cli_write_ready;
2267 template.file_descriptor = fd;
2268 template.private_data = cf - cm->cli_file_pool;
2270 cf->process_node_index = n->index;
2271 cf->unix_file_index = unix_file_add (um, &template);
2272 cf->output_vector = 0;
2273 cf->input_vector = 0;
2275 vlib_start_process (vm, n->runtime_index);
2277 vlib_process_t *p = vlib_get_process_from_node (vm, n);
2278 p->output_function = unix_vlib_cli_output;
2279 p->output_function_arg = cf - cm->cli_file_pool;
2281 return cf - cm->cli_file_pool;
2284 /** Telnet listening socket has a new connection. */
2285 static clib_error_t *
2286 unix_cli_listen_read_ready (unix_file_t * uf)
2288 unix_main_t *um = &unix_main;
2289 unix_cli_main_t *cm = &unix_cli_main;
2290 clib_socket_t *s = &um->cli_listen_socket;
2291 clib_socket_t client;
2293 clib_error_t *error;
2294 unix_cli_file_t *cf;
2297 error = clib_socket_accept (s, &client);
2301 client_name = (char *) format (0, "%U%c", format_sockaddr, &client.peer, 0);
2303 cf_index = unix_cli_file_add (cm, client_name, client.fd);
2304 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2306 /* No longer need CLIB version of socket. */
2307 clib_socket_free (&client);
2309 vec_free (client_name);
2311 /* if we're supposed to run telnet session in character mode (default) */
2312 if (um->cli_line_mode == 0)
2315 * Set telnet client character mode, echo on, suppress "go-ahead".
2316 * Technically these should be negotiated, but this works.
2318 u8 charmode_option[] = {
2319 IAC, WONT, TELOPT_LINEMODE, /* server will do char-by-char */
2320 IAC, DONT, TELOPT_LINEMODE, /* client should do char-by-char */
2321 IAC, WILL, TELOPT_SGA, /* server willl supress GA */
2322 IAC, DO, TELOPT_SGA, /* client should supress Go Ahead */
2323 IAC, WILL, TELOPT_ECHO, /* server will do echo */
2324 IAC, DONT, TELOPT_ECHO, /* client should not echo */
2325 IAC, DO, TELOPT_TTYPE, /* client should tell us its term type */
2326 IAC, SB, TELOPT_TTYPE, 1, IAC, SE, /* now tell me ttype */
2327 IAC, DO, TELOPT_NAWS, /* client should tell us its window sz */
2328 IAC, SB, TELOPT_NAWS, 1, IAC, SE, /* now tell me window size */
2331 /* Enable history on this CLI */
2332 cf->history_limit = um->cli_history_limit;
2333 cf->has_history = cf->history_limit != 0;
2335 /* Make sure this session is in line mode */
2341 /* Setup the pager */
2342 cf->no_pager = um->cli_no_pager;
2344 uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
2346 /* Send the telnet options */
2347 unix_vlib_cli_output_raw (cf, uf, charmode_option,
2348 ARRAY_LEN (charmode_option));
2350 /* In case the client doesn't negotiate terminal type, use
2351 * a timer to kick off the initial prompt. */
2352 timer_call (unix_cli_file_welcome_timer, cf_index, 1);
2358 /** The system terminal has informed us that the window size
2362 unix_cli_resize_interrupt (int signum)
2364 unix_main_t *um = &unix_main;
2365 unix_cli_main_t *cm = &unix_cli_main;
2366 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
2367 cm->stdin_cli_file_index);
2368 unix_file_t *uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
2372 /* Terminal resized, fetch the new size */
2373 if (ioctl (UNIX_CLI_STDIN_FD, TIOCGWINSZ, &ws) < 0)
2375 /* "Should never happen..." */
2376 clib_unix_warning ("TIOCGWINSZ");
2377 /* We can't trust ws.XXX... */
2380 cf->width = ws.ws_col;
2381 cf->height = ws.ws_row;
2383 /* Reindex the pager buffer */
2384 unix_cli_pager_reindex (cf);
2386 /* Redraw the page */
2387 unix_cli_pager_redraw (cf, uf);
2390 /** Handle configuration directives in the @em unix section. */
2391 static clib_error_t *
2392 unix_cli_config (vlib_main_t * vm, unformat_input_t * input)
2394 unix_main_t *um = &unix_main;
2395 unix_cli_main_t *cm = &unix_cli_main;
2397 clib_error_t *error = 0;
2398 unix_cli_file_t *cf;
2401 struct sigaction sa;
2405 /* We depend on unix flags being set. */
2406 if ((error = vlib_call_config_function (vm, unix_config)))
2409 if (um->flags & UNIX_FLAG_INTERACTIVE)
2411 /* Set stdin to be non-blocking. */
2412 if ((flags = fcntl (UNIX_CLI_STDIN_FD, F_GETFL, 0)) < 0)
2414 (void) fcntl (UNIX_CLI_STDIN_FD, F_SETFL, flags | O_NONBLOCK);
2416 cf_index = unix_cli_file_add (cm, "stdin", UNIX_CLI_STDIN_FD);
2417 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2418 cm->stdin_cli_file_index = cf_index;
2420 /* If stdin is a tty and we are using chacracter mode, enable
2421 * history on the CLI and set the tty line discipline accordingly. */
2422 if (isatty (UNIX_CLI_STDIN_FD) && um->cli_line_mode == 0)
2424 /* Capture terminal resize events */
2425 memset (&sa, 0, sizeof (sa));
2426 sa.sa_handler = unix_cli_resize_interrupt;
2427 if (sigaction (SIGWINCH, &sa, 0) < 0)
2428 clib_panic ("sigaction");
2430 /* Retrieve the current terminal size */
2431 ioctl (UNIX_CLI_STDIN_FD, TIOCGWINSZ, &ws);
2432 cf->width = ws.ws_col;
2433 cf->height = ws.ws_row;
2435 if (cf->width == 0 || cf->height == 0)
2436 /* We have a tty, but no size. Stick to line mode. */
2439 /* Setup the history */
2440 cf->history_limit = um->cli_history_limit;
2441 cf->has_history = cf->history_limit != 0;
2443 /* Setup the pager */
2444 cf->no_pager = um->cli_no_pager;
2446 /* We're going to be in char by char mode */
2449 /* Save the original tty state so we can restore it later */
2450 tcgetattr (UNIX_CLI_STDIN_FD, &um->tio_stdin);
2453 /* Tweak the tty settings */
2454 tio = um->tio_stdin;
2455 /* echo off, canonical mode off, ext'd input processing off */
2456 tio.c_lflag &= ~(ECHO | ICANON | IEXTEN);
2457 tio.c_cc[VMIN] = 1; /* 1 byte at a time */
2458 tio.c_cc[VTIME] = 0; /* no timer */
2459 tcsetattr (UNIX_CLI_STDIN_FD, TCSAFLUSH, &tio);
2461 /* See if we can do ANSI/VT100 output */
2462 term = (u8 *) getenv ("TERM");
2464 cf->ansi_capable = unix_cli_terminal_type (term,
2471 /* No tty, so make sure these things are off */
2473 cf->history_limit = 0;
2474 cf->has_history = 0;
2478 /* Send banner and initial prompt */
2479 unix_cli_file_welcome (cm, cf);
2482 /* If we have socket config, LISTEN, otherwise, don't */
2483 clib_socket_t *s = &um->cli_listen_socket;
2484 if (s->config && s->config[0] != 0)
2487 unix_file_t template = { 0 };
2489 s->flags = SOCKET_IS_SERVER; /* listen, don't connect */
2490 error = clib_socket_init (s);
2495 template.read_function = unix_cli_listen_read_ready;
2496 template.file_descriptor = s->fd;
2498 unix_file_add (um, &template);
2501 /* Set CLI prompt. */
2502 if (!cm->cli_prompt)
2503 cm->cli_prompt = format (0, "VLIB: ");
2509 * This module has no configurable parameters.
2511 VLIB_CONFIG_FUNCTION (unix_cli_config, "unix-cli");
2513 /** Called when VPP is shutting down, this restores the system
2514 * terminal state if previously saved.
2516 static clib_error_t *
2517 unix_cli_exit (vlib_main_t * vm)
2519 unix_main_t *um = &unix_main;
2521 /* If stdin is a tty and we saved the tty state, reset the tty state */
2522 if (isatty (UNIX_CLI_STDIN_FD) && um->tio_isset)
2523 tcsetattr (UNIX_CLI_STDIN_FD, TCSAFLUSH, &um->tio_stdin);
2528 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_cli_exit);
2530 /** Set the CLI prompt.
2531 * @param prompt The C string to set the prompt to.
2532 * @note This setting is global; it impacts all current
2533 * and future CLI sessions.
2536 vlib_unix_cli_set_prompt (char *prompt)
2538 char *fmt = (prompt[strlen (prompt) - 1] == ' ') ? "%s" : "%s ";
2539 unix_cli_main_t *cm = &unix_cli_main;
2541 vec_free (cm->cli_prompt);
2542 cm->cli_prompt = format (0, fmt, prompt);
2545 /** CLI command to quit the terminal session.
2546 * @note If this is a stdin session then this will
2547 * shutdown VPP also.
2549 static clib_error_t *
2550 unix_cli_quit (vlib_main_t * vm,
2551 unformat_input_t * input, vlib_cli_command_t * cmd)
2553 unix_cli_main_t *cm = &unix_cli_main;
2555 vlib_process_signal_event (vm,
2556 vlib_current_process (vm),
2557 UNIX_CLI_PROCESS_EVENT_QUIT,
2558 cm->current_input_file_index);
2563 * Terminates the current CLI session.
2565 * If VPP is running in @em interactive mode and this is the console session
2566 * (that is, the session on @c stdin) then this will also terminate VPP.
2569 VLIB_CLI_COMMAND (unix_cli_quit_command, static) = {
2571 .short_help = "Exit CLI",
2572 .function = unix_cli_quit,
2576 /** CLI command to execute a VPP command script. */
2577 static clib_error_t *
2578 unix_cli_exec (vlib_main_t * vm,
2579 unformat_input_t * input, vlib_cli_command_t * cmd)
2583 unformat_input_t sub_input;
2584 clib_error_t *error;
2590 if (!unformat (input, "%s", &file_name))
2592 error = clib_error_return (0, "expecting file name, got `%U'",
2593 format_unformat_error, input);
2597 fd = open (file_name, O_RDONLY);
2600 error = clib_error_return_unix (0, "failed to open `%s'", file_name);
2604 /* Make sure its a regular file. */
2608 if (fstat (fd, &s) < 0)
2610 error = clib_error_return_unix (0, "failed to stat `%s'", file_name);
2614 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
2616 error = clib_error_return (0, "not a regular file `%s'", file_name);
2621 unformat_init_unix_file (&sub_input, fd);
2623 vlib_cli_input (vm, &sub_input, 0, 0);
2624 unformat_free (&sub_input);
2629 vec_free (file_name);
2635 * Executes a sequence of CLI commands which are read from a file.
2637 * If a command is unrecognised or otherwise invalid then the usual CLI
2638 * feedback will be generated, however execution of subsequent commands
2639 * from the file will continue.
2642 VLIB_CLI_COMMAND (cli_exec, static) = {
2644 .short_help = "Execute commands from file",
2645 .function = unix_cli_exec,
2650 /** CLI command to show various unix error statistics. */
2651 static clib_error_t *
2652 unix_show_errors (vlib_main_t * vm,
2653 unformat_input_t * input, vlib_cli_command_t * cmd)
2655 unix_main_t *um = &unix_main;
2656 clib_error_t *error = 0;
2657 int i, n_errors_to_show;
2658 unix_error_history_t *unix_errors = 0;
2660 n_errors_to_show = 1 << 30;
2662 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2664 if (!unformat (input, "%d", &n_errors_to_show))
2667 clib_error_return (0,
2668 "expecting integer number of errors to show, got `%U'",
2669 format_unformat_error, input);
2675 clib_min (ARRAY_LEN (um->error_history), n_errors_to_show);
2678 um->error_history_index >
2679 0 ? um->error_history_index - 1 : ARRAY_LEN (um->error_history) - 1;
2681 while (n_errors_to_show > 0)
2683 unix_error_history_t *eh = um->error_history + i;
2688 vec_add1 (unix_errors, eh[0]);
2689 n_errors_to_show -= 1;
2691 i = ARRAY_LEN (um->error_history) - 1;
2696 if (vec_len (unix_errors) == 0)
2697 vlib_cli_output (vm, "no Unix errors so far");
2700 vlib_cli_output (vm, "%Ld total errors seen", um->n_total_errors);
2701 for (i = vec_len (unix_errors) - 1; i >= 0; i--)
2703 unix_error_history_t *eh = vec_elt_at_index (unix_errors, i);
2704 vlib_cli_output (vm, "%U: %U",
2705 format_time_interval, "h:m:s:u", eh->time,
2706 format_clib_error, eh->error);
2708 vlib_cli_output (vm, "%U: time now",
2709 format_time_interval, "h:m:s:u", vlib_time_now (vm));
2713 vec_free (unix_errors);
2718 VLIB_CLI_COMMAND (cli_unix_show_errors, static) = {
2719 .path = "show unix-errors",
2720 .short_help = "Show Unix system call error history",
2721 .function = unix_show_errors,
2725 /** CLI command to show session command history. */
2726 static clib_error_t *
2727 unix_cli_show_history (vlib_main_t * vm,
2728 unformat_input_t * input, vlib_cli_command_t * cmd)
2730 unix_cli_main_t *cm = &unix_cli_main;
2731 unix_cli_file_t *cf;
2734 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
2736 if (cf->has_history && cf->history_limit)
2738 i = 1 + cf->command_number - vec_len (cf->command_history);
2739 for (j = 0; j < vec_len (cf->command_history); j++)
2740 vlib_cli_output (vm, "%d %v\n", i + j, cf->command_history[j]);
2744 vlib_cli_output (vm, "History not enabled.\n");
2751 * Displays the command history for the current session, if any.
2754 VLIB_CLI_COMMAND (cli_unix_cli_show_history, static) = {
2756 .short_help = "Show current session command history",
2757 .function = unix_cli_show_history,
2761 /** CLI command to show terminal status. */
2762 static clib_error_t *
2763 unix_cli_show_terminal (vlib_main_t * vm,
2764 unformat_input_t * input, vlib_cli_command_t * cmd)
2766 unix_main_t *um = &unix_main;
2767 unix_cli_main_t *cm = &unix_cli_main;
2768 unix_cli_file_t *cf;
2771 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
2772 n = vlib_get_node (vm, cf->process_node_index);
2774 vlib_cli_output (vm, "Terminal name: %v\n", n->name);
2775 vlib_cli_output (vm, "Terminal mode: %s\n", cf->line_mode ?
2776 "line-by-line" : "char-by-char");
2777 vlib_cli_output (vm, "Terminal width: %d\n", cf->width);
2778 vlib_cli_output (vm, "Terminal height: %d\n", cf->height);
2779 vlib_cli_output (vm, "ANSI capable: %s\n",
2780 cf->ansi_capable ? "yes" : "no");
2781 vlib_cli_output (vm, "History enabled: %s%s\n",
2782 cf->has_history ? "yes" : "no", !cf->has_history
2783 || cf->history_limit ? "" :
2784 " (disabled by history limit)");
2785 if (cf->has_history)
2786 vlib_cli_output (vm, "History limit: %d\n", cf->history_limit);
2787 vlib_cli_output (vm, "Pager enabled: %s%s%s\n",
2788 cf->no_pager ? "no" : "yes",
2790 || cf->height ? "" : " (disabled by terminal height)",
2792 || um->cli_pager_buffer_limit ? "" :
2793 " (disabled by buffer limit)");
2795 vlib_cli_output (vm, "Pager limit: %d\n", um->cli_pager_buffer_limit);
2796 vlib_cli_output (vm, "CRLF mode: %s\n",
2797 cf->crlf_mode ? "CR+LF" : "LF");
2803 * Displays various information about the state of the current terminal
2807 * @cliexstart{show terminal}
2808 * Terminal name: unix-cli-stdin
2809 * Terminal mode: char-by-char
2810 * Terminal width: 123
2811 * Terminal height: 48
2813 * History enabled: yes
2815 * Pager enabled: yes
2816 * Pager limit: 100000
2821 VLIB_CLI_COMMAND (cli_unix_cli_show_terminal, static) = {
2822 .path = "show terminal",
2823 .short_help = "Show current session terminal settings",
2824 .function = unix_cli_show_terminal,
2828 /** CLI command to set terminal pager settings. */
2829 static clib_error_t *
2830 unix_cli_set_terminal_pager (vlib_main_t * vm,
2831 unformat_input_t * input,
2832 vlib_cli_command_t * cmd)
2834 unix_main_t *um = &unix_main;
2835 unix_cli_main_t *cm = &unix_cli_main;
2836 unix_cli_file_t *cf;
2837 unformat_input_t _line_input, *line_input = &_line_input;
2838 clib_error_t *error = 0;
2840 if (!unformat_user (input, unformat_line_input, line_input))
2843 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
2845 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2847 if (unformat (line_input, "on"))
2849 else if (unformat (line_input, "off"))
2851 else if (unformat (line_input, "limit %u", &um->cli_pager_buffer_limit))
2852 vlib_cli_output (vm,
2853 "Pager limit set to %u lines; note, this is global.\n",
2854 um->cli_pager_buffer_limit);
2857 error = clib_error_return (0, "unknown parameter: `%U`",
2858 format_unformat_error, line_input);
2864 unformat_free (line_input);
2870 * Enables or disables the terminal pager for this session. Generally
2871 * this defaults to enabled.
2873 * Additionally allows the pager buffer size to be set; though note that
2874 * this value is set globally and not per session.
2877 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager, static) = {
2878 .path = "set terminal pager",
2879 .short_help = "set terminal pager [on|off] [limit <lines>]",
2880 .function = unix_cli_set_terminal_pager,
2884 /** CLI command to set terminal history settings. */
2885 static clib_error_t *
2886 unix_cli_set_terminal_history (vlib_main_t * vm,
2887 unformat_input_t * input,
2888 vlib_cli_command_t * cmd)
2890 unix_cli_main_t *cm = &unix_cli_main;
2891 unix_cli_file_t *cf;
2892 unformat_input_t _line_input, *line_input = &_line_input;
2894 clib_error_t *error = 0;
2896 if (!unformat_user (input, unformat_line_input, line_input))
2899 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
2901 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2903 if (unformat (line_input, "on"))
2904 cf->has_history = 1;
2905 else if (unformat (line_input, "off"))
2906 cf->has_history = 0;
2907 else if (unformat (line_input, "limit %u", &cf->history_limit))
2911 error = clib_error_return (0, "unknown parameter: `%U`",
2912 format_unformat_error, line_input);
2916 /* If we reduced history size, or turned it off, purge the history */
2917 limit = cf->has_history ? cf->history_limit : 0;
2919 while (cf->command_history && vec_len (cf->command_history) >= limit)
2921 vec_free (cf->command_history[0]);
2922 vec_delete (cf->command_history, 1, 0);
2927 unformat_free (line_input);
2933 * Enables or disables the command history function of the current
2934 * terminal. Generally this defaults to enabled.
2936 * This command also allows the maximum size of the history buffer for
2937 * this session to be altered.
2940 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history, static) = {
2941 .path = "set terminal history",
2942 .short_help = "set terminal history [on|off] [limit <lines>]",
2943 .function = unix_cli_set_terminal_history,
2947 /** CLI command to set terminal ANSI settings. */
2948 static clib_error_t *
2949 unix_cli_set_terminal_ansi (vlib_main_t * vm,
2950 unformat_input_t * input,
2951 vlib_cli_command_t * cmd)
2953 unix_cli_main_t *cm = &unix_cli_main;
2954 unix_cli_file_t *cf;
2956 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
2958 if (unformat (input, "on"))
2959 cf->ansi_capable = 1;
2960 else if (unformat (input, "off"))
2961 cf->ansi_capable = 0;
2963 return clib_error_return (0, "unknown parameter: `%U`",
2964 format_unformat_error, input);
2970 * Enables or disables the use of ANSI control sequences by this terminal.
2971 * The default will vary based on terminal detection at the start of the
2974 * ANSI control sequences are used in a small number of places to provide,
2975 * for example, color text output and to control the cursor in the pager.
2978 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi, static) = {
2979 .path = "set terminal ansi",
2980 .short_help = "set terminal ansi [on|off]",
2981 .function = unix_cli_set_terminal_ansi,
2985 static clib_error_t *
2986 unix_cli_init (vlib_main_t * vm)
2991 VLIB_INIT_FUNCTION (unix_cli_init);
2994 * fd.io coding-style-patch-verification: ON
2997 * eval: (c-set-style "gnu")