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>
60 #include <sys/types.h>
63 /** ANSI escape code. */
66 /** ANSI Control Sequence Introducer. */
69 /** ANSI clear screen. */
70 #define ANSI_CLEAR CSI "2J" CSI "1;1H"
71 /** ANSI reset color settings. */
72 #define ANSI_RESET CSI "0m"
73 /** ANSI Start bold text. */
74 #define ANSI_BOLD CSI "1m"
75 /** ANSI Stop bold text. */
76 #define ANSI_DIM CSI "2m"
77 /** ANSI Start dark red text. */
78 #define ANSI_DRED ANSI_DIM CSI "31m"
79 /** ANSI Start bright red text. */
80 #define ANSI_BRED ANSI_BOLD CSI "31m"
81 /** ANSI clear line cursor is on. */
82 #define ANSI_CLEARLINE CSI "2K"
83 /** ANSI scroll screen down one line. */
84 #define ANSI_SCROLLDN CSI "1T"
85 /** ANSI save cursor position. */
86 #define ANSI_SAVECURSOR CSI "s"
87 /** ANSI restore cursor position if previously saved. */
88 #define ANSI_RESTCURSOR CSI "u"
90 /** Maximum depth into a byte stream from which to compile a Telnet
91 * protocol message. This is a saftey measure. */
92 #define UNIX_CLI_MAX_DEPTH_TELNET 24
94 /** Unix standard in */
95 #define UNIX_CLI_STDIN_FD 0
98 /** A CLI banner line. */
101 u8 *line; /**< The line to print. */
102 u32 length; /**< The length of the line without terminating NUL. */
105 #define _(a) { .line = (u8 *)(a), .length = sizeof(a) - 1 }
106 /** Plain welcome banner. */
107 static unix_cli_banner_t unix_cli_banner[] = {
108 _(" _______ _ _ _____ ___ \n"),
109 _(" __/ __/ _ \\ (_)__ | | / / _ \\/ _ \\\n"),
110 _(" _/ _// // / / / _ \\ | |/ / ___/ ___/\n"),
111 _(" /_/ /____(_)_/\\___/ |___/_/ /_/ \n"),
115 /** ANSI color welcome banner. */
116 static unix_cli_banner_t unix_cli_banner_color[] = {
117 _(ANSI_BRED " _______ _ " ANSI_RESET " _ _____ ___ \n"),
118 _(ANSI_BRED " __/ __/ _ \\ (_)__ " ANSI_RESET " | | / / _ \\/ _ \\\n"),
119 _(ANSI_BRED " _/ _// // / / / _ \\" ANSI_RESET " | |/ / ___/ ___/\n"),
120 _(ANSI_BRED " /_/ /____(_)_/\\___/" ANSI_RESET " |___/_/ /_/ \n"),
126 /** Pager line index */
129 /** Index into pager_vector */
132 /** Offset of the string in the line */
135 /** Length of the string in the line */
137 } unix_cli_pager_index_t;
140 /** Unix CLI session. */
143 /** The file index held by unix.c */
146 /** Vector of output pending write to file descriptor. */
149 /** Vector of input saved by Unix input node to be processed by
153 /** This session has command history. */
155 /** Array of vectors of commands in the history. */
156 u8 **command_history;
157 /** The command currently pointed at by the history cursor. */
159 /** How far from the end of the history array the user has browsed. */
162 /** Maximum number of history entries this session will store. */
165 /** Current command line counter */
168 /** The string being searched for in the history. */
170 /** If non-zero then the CLI is searching in the history array.
171 * - @c -1 means search backwards.
172 * - @c 1 means search forwards.
176 /** Position of the insert cursor on the current input line */
179 /** Line mode or char mode */
182 /** Set if the CRLF mode wants CR + LF */
185 /** Can we do ANSI output? */
188 /** Has the session started? */
191 /** Disable the pager? */
197 /** Index of line fragments in the pager buffer */
198 unix_cli_pager_index_t *pager_index;
200 /** Line number of top of page */
203 /** Terminal width */
206 /** Terminal height */
209 /** Process node identifier */
210 u32 process_node_index;
213 /** Resets the pager buffer and other data.
214 * @param f The CLI session whose pager needs to be reset.
217 unix_cli_pager_reset (unix_cli_file_t * f)
223 vec_free (f->pager_index);
226 vec_foreach (p, f->pager_vector)
230 vec_free (f->pager_vector);
234 /** Release storage used by a CLI session.
235 * @param f The CLI session whose storage needs to be released.
238 unix_cli_file_free (unix_cli_file_t * f)
240 vec_free (f->output_vector);
241 vec_free (f->input_vector);
242 unix_cli_pager_reset (f);
248 UNIX_CLI_PARSE_ACTION_NOACTION = 0, /**< No action */
249 UNIX_CLI_PARSE_ACTION_CRLF, /**< Carriage return, newline or enter */
250 UNIX_CLI_PARSE_ACTION_TAB, /**< Tab key */
251 UNIX_CLI_PARSE_ACTION_ERASE, /**< Erase cursor left */
252 UNIX_CLI_PARSE_ACTION_ERASERIGHT, /**< Erase cursor right */
253 UNIX_CLI_PARSE_ACTION_UP, /**< Up arrow */
254 UNIX_CLI_PARSE_ACTION_DOWN, /**< Down arrow */
255 UNIX_CLI_PARSE_ACTION_LEFT, /**< Left arrow */
256 UNIX_CLI_PARSE_ACTION_RIGHT, /**< Right arrow */
257 UNIX_CLI_PARSE_ACTION_HOME, /**< Home key (jump to start of line) */
258 UNIX_CLI_PARSE_ACTION_END, /**< End key (jump to end of line) */
259 UNIX_CLI_PARSE_ACTION_WORDLEFT, /**< Jump cursor to start of left word */
260 UNIX_CLI_PARSE_ACTION_WORDRIGHT, /**< Jump cursor to start of right word */
261 UNIX_CLI_PARSE_ACTION_ERASELINELEFT, /**< Erase line to left of cursor */
262 UNIX_CLI_PARSE_ACTION_ERASELINERIGHT, /**< Erase line to right & including cursor */
263 UNIX_CLI_PARSE_ACTION_CLEAR, /**< Clear the terminal */
264 UNIX_CLI_PARSE_ACTION_REVSEARCH, /**< Search backwards in command history */
265 UNIX_CLI_PARSE_ACTION_FWDSEARCH, /**< Search forwards in command history */
266 UNIX_CLI_PARSE_ACTION_YANK, /**< Undo last erase action */
267 UNIX_CLI_PARSE_ACTION_TELNETIAC, /**< Telnet control code */
269 UNIX_CLI_PARSE_ACTION_PAGER_CRLF, /**< Enter pressed (CR, CRLF, LF, etc) */
270 UNIX_CLI_PARSE_ACTION_PAGER_QUIT, /**< Exit the pager session */
271 UNIX_CLI_PARSE_ACTION_PAGER_NEXT, /**< Scroll to next page */
272 UNIX_CLI_PARSE_ACTION_PAGER_DN, /**< Scroll to next line */
273 UNIX_CLI_PARSE_ACTION_PAGER_UP, /**< Scroll to previous line */
274 UNIX_CLI_PARSE_ACTION_PAGER_TOP, /**< Scroll to first line */
275 UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM, /**< Scroll to last line */
276 UNIX_CLI_PARSE_ACTION_PAGER_PGDN, /**< Scroll to next page */
277 UNIX_CLI_PARSE_ACTION_PAGER_PGUP, /**< Scroll to previous page */
278 UNIX_CLI_PARSE_ACTION_PAGER_REDRAW, /**< Clear and redraw the page on the terminal */
279 UNIX_CLI_PARSE_ACTION_PAGER_SEARCH, /**< Search the pager buffer */
281 UNIX_CLI_PARSE_ACTION_PARTIALMATCH, /**< Action parser found a partial match */
282 UNIX_CLI_PARSE_ACTION_NOMATCH /**< Action parser did not find any match */
283 } unix_cli_parse_action_t;
285 /** @brief Mapping of input buffer strings to action values.
286 * @note This won't work as a hash since we need to be able to do
287 * partial matches on the string.
291 u8 *input; /**< Input string to match. */
292 u32 len; /**< Length of input without final NUL. */
293 unix_cli_parse_action_t action; /**< Action to take when matched. */
294 } unix_cli_parse_actions_t;
296 /** @brief Given a capital ASCII letter character return a @c NUL terminated
297 * string with the control code for that letter.
299 * @param c An ASCII character.
300 * @return A @c NUL terminated string of type @c u8[].
303 * @c CTL('A') returns <code>{ 0x01, 0x00 }</code> as a @c u8[].
305 #define CTL(c) (u8[]){ (c) - '@', 0 }
307 #define _(a,b) { .input = (u8 *)(a), .len = sizeof(a) - 1, .action = (b) }
309 * Patterns to match on a CLI input stream.
312 static unix_cli_parse_actions_t unix_cli_parse_strings[] = {
314 _("\r\n", UNIX_CLI_PARSE_ACTION_CRLF), /* Must be before '\r' */
315 _("\n", UNIX_CLI_PARSE_ACTION_CRLF),
316 _("\r\0", UNIX_CLI_PARSE_ACTION_CRLF), /* Telnet does this */
317 _("\r", UNIX_CLI_PARSE_ACTION_CRLF),
319 /* Unix shell control codes */
320 _(CTL ('B'), UNIX_CLI_PARSE_ACTION_LEFT),
321 _(CTL ('F'), UNIX_CLI_PARSE_ACTION_RIGHT),
322 _(CTL ('P'), UNIX_CLI_PARSE_ACTION_UP),
323 _(CTL ('N'), UNIX_CLI_PARSE_ACTION_DOWN),
324 _(CTL ('A'), UNIX_CLI_PARSE_ACTION_HOME),
325 _(CTL ('E'), UNIX_CLI_PARSE_ACTION_END),
326 _(CTL ('D'), UNIX_CLI_PARSE_ACTION_ERASERIGHT),
327 _(CTL ('U'), UNIX_CLI_PARSE_ACTION_ERASELINELEFT),
328 _(CTL ('K'), UNIX_CLI_PARSE_ACTION_ERASELINERIGHT),
329 _(CTL ('Y'), UNIX_CLI_PARSE_ACTION_YANK),
330 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_CLEAR),
331 _(ESC "b", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* Alt-B */
332 _(ESC "f", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* Alt-F */
333 _("\b", UNIX_CLI_PARSE_ACTION_ERASE), /* ^H */
334 _("\x7f", UNIX_CLI_PARSE_ACTION_ERASE), /* Backspace */
335 _("\t", UNIX_CLI_PARSE_ACTION_TAB), /* ^I */
337 /* VT100 Normal mode - Broadest support */
338 _(CSI "A", UNIX_CLI_PARSE_ACTION_UP),
339 _(CSI "B", UNIX_CLI_PARSE_ACTION_DOWN),
340 _(CSI "C", UNIX_CLI_PARSE_ACTION_RIGHT),
341 _(CSI "D", UNIX_CLI_PARSE_ACTION_LEFT),
342 _(CSI "H", UNIX_CLI_PARSE_ACTION_HOME),
343 _(CSI "F", UNIX_CLI_PARSE_ACTION_END),
344 _(CSI "3~", UNIX_CLI_PARSE_ACTION_ERASERIGHT), /* Delete */
345 _(CSI "1;5D", UNIX_CLI_PARSE_ACTION_WORDLEFT), /* C-Left */
346 _(CSI "1;5C", UNIX_CLI_PARSE_ACTION_WORDRIGHT), /* C-Right */
348 /* VT100 Application mode - Some Gnome Terminal functions use these */
349 _(ESC "OA", UNIX_CLI_PARSE_ACTION_UP),
350 _(ESC "OB", UNIX_CLI_PARSE_ACTION_DOWN),
351 _(ESC "OC", UNIX_CLI_PARSE_ACTION_RIGHT),
352 _(ESC "OD", UNIX_CLI_PARSE_ACTION_LEFT),
353 _(ESC "OH", UNIX_CLI_PARSE_ACTION_HOME),
354 _(ESC "OF", UNIX_CLI_PARSE_ACTION_END),
356 /* ANSI X3.41-1974 - sent by Microsoft Telnet and PuTTY */
357 _(CSI "1~", UNIX_CLI_PARSE_ACTION_HOME),
358 _(CSI "4~", UNIX_CLI_PARSE_ACTION_END),
360 /* Emacs-ish history search */
361 _(CTL ('S'), UNIX_CLI_PARSE_ACTION_FWDSEARCH),
362 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_REVSEARCH),
364 /* Other protocol things */
365 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
366 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
367 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
371 * Patterns to match when a CLI session is in the pager.
374 static unix_cli_parse_actions_t unix_cli_parse_pager[] = {
376 _("\r\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Must be before '\r' */
377 _("\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
378 _("\r\0", UNIX_CLI_PARSE_ACTION_PAGER_CRLF), /* Telnet does this */
379 _("\r", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
382 _(" ", UNIX_CLI_PARSE_ACTION_PAGER_NEXT),
383 _("q", UNIX_CLI_PARSE_ACTION_PAGER_QUIT),
384 _(CTL ('L'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
385 _(CTL ('R'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
386 _("/", UNIX_CLI_PARSE_ACTION_PAGER_SEARCH),
389 _(CSI "A", UNIX_CLI_PARSE_ACTION_PAGER_UP),
390 _(CSI "B", UNIX_CLI_PARSE_ACTION_PAGER_DN),
391 _(CSI "H", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
392 _(CSI "F", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
394 /* VT100 Application mode */
395 _(ESC "OA", UNIX_CLI_PARSE_ACTION_PAGER_UP),
396 _(ESC "OB", UNIX_CLI_PARSE_ACTION_PAGER_DN),
397 _(ESC "OH", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
398 _(ESC "OF", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
400 /* ANSI X3.41-1974 */
401 _(CSI "1~", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
402 _(CSI "4~", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
403 _(CSI "5~", UNIX_CLI_PARSE_ACTION_PAGER_PGUP),
404 _(CSI "6~", UNIX_CLI_PARSE_ACTION_PAGER_PGDN),
406 /* Other protocol things */
407 _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC), /* IAC */
408 _("\0", UNIX_CLI_PARSE_ACTION_NOACTION), /* NUL */
409 _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
414 /** CLI session events. */
417 UNIX_CLI_PROCESS_EVENT_READ_READY, /**< A file descriptor has data to be read. */
418 UNIX_CLI_PROCESS_EVENT_QUIT, /**< A CLI session wants to close. */
419 } unix_cli_process_event_type_t;
421 /** CLI global state. */
424 /** Prompt string for CLI. */
427 /** Vec pool of CLI sessions. */
428 unix_cli_file_t *cli_file_pool;
430 /** Vec pool of unused session indices. */
431 u32 *unused_cli_process_node_indices;
433 /** The session index of the stdin cli */
434 u32 stdin_cli_file_index;
436 /** File pool index of current input. */
437 u32 current_input_file_index;
440 /** CLI global state */
441 static unix_cli_main_t unix_cli_main;
444 * @brief Search for a byte sequence in the action list.
446 * Searches the @ref unix_cli_parse_actions_t list in @a a for a match with
447 * the bytes in @a input of maximum length @a ilen bytes.
448 * When a match is made @a *matched indicates how many bytes were matched.
449 * Returns a value from the enum @ref unix_cli_parse_action_t to indicate
450 * whether no match was found, a partial match was found or a complete
451 * match was found and what action, if any, should be taken.
453 * @param[in] a Actions list to search within.
454 * @param[in] input String fragment to search for.
455 * @param[in] ilen Length of the string in 'input'.
456 * @param[out] matched Pointer to an integer that will contain the number
457 * of bytes matched when a complete match is found.
459 * @return Action from @ref unix_cli_parse_action_t that the string fragment
461 * @ref UNIX_CLI_PARSE_ACTION_PARTIALMATCH is returned when the
462 * whole input string matches the start of at least one action.
463 * @ref UNIX_CLI_PARSE_ACTION_NOMATCH is returned when there is no
466 static unix_cli_parse_action_t
467 unix_cli_match_action (unix_cli_parse_actions_t * a,
468 u8 * input, u32 ilen, i32 * matched)
476 /* see if the start of the input buffer exactly matches the current
478 if (memcmp (input, a->input, a->len) == 0)
486 /* if the first ilen characters match, flag this as a partial -
487 * meaning keep collecting bytes in case of a future match */
488 if (memcmp (input, a->input, ilen) == 0)
492 /* check next action */
497 UNIX_CLI_PARSE_ACTION_PARTIALMATCH : UNIX_CLI_PARSE_ACTION_NOMATCH;
501 /** Add bytes to the output vector and then flagg the I/O system that bytes
502 * are available to be sent.
505 unix_cli_add_pending_output (unix_file_t * uf,
506 unix_cli_file_t * cf,
507 u8 * buffer, uword buffer_bytes)
509 unix_main_t *um = &unix_main;
511 vec_add (cf->output_vector, buffer, buffer_bytes);
512 if (vec_len (cf->output_vector) > 0)
514 int skip_update = 0 != (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
515 uf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
517 um->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
521 /** Delete all bytes from the output vector and flag the I/O system
522 * that no more bytes are available to be sent.
525 unix_cli_del_pending_output (unix_file_t * uf,
526 unix_cli_file_t * cf, uword n_bytes)
528 unix_main_t *um = &unix_main;
530 vec_delete (cf->output_vector, n_bytes, 0);
531 if (vec_len (cf->output_vector) <= 0)
533 int skip_update = 0 == (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
534 uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
536 um->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
540 /** @brief A bit like strchr with a buffer length limit.
541 * Search a buffer for the first instance of a character up to the limit of
542 * the buffer length. If found then return the position of that character.
544 * The key departure from strchr is that if the character is not found then
545 * return the buffer length.
547 * @param chr The byte value to search for.
548 * @param str The buffer in which to search for the value.
549 * @param len The depth into the buffer to search.
551 * @return The index of the first occurence of \c chr. If \c chr is not
552 * found then \c len instead.
555 unix_vlib_findchr (u8 chr, u8 * str, word len)
558 for (i = 0; i < len; i++, str++)
566 /** @brief Send a buffer to the CLI stream if possible, enqueue it otherwise.
567 * Attempts to write given buffer to the file descriptor of the given
568 * Unix CLI session. If that session already has data in the output buffer
569 * or if the write attempt tells us to try again later then the given buffer
570 * is appended to the pending output buffer instead.
572 * This is typically called only from \c unix_vlib_cli_output_cooked since
573 * that is where CRLF handling occurs or from places where we explicitly do
574 * not want cooked handling.
576 * @param cf Unix CLI session of the desired stream to write to.
577 * @param uf The Unix file structure of the desired stream to write to.
578 * @param buffer Pointer to the buffer that needs to be written.
579 * @param buffer_bytes The number of bytes from \c buffer to write.
582 unix_vlib_cli_output_raw (unix_cli_file_t * cf,
583 unix_file_t * uf, u8 * buffer, uword buffer_bytes)
587 if (vec_len (cf->output_vector) == 0)
588 n = write (uf->file_descriptor, buffer, buffer_bytes);
590 if (n < 0 && errno != EAGAIN)
592 clib_unix_warning ("write");
594 else if ((word) n < (word) buffer_bytes)
596 /* We got EAGAIN or we already have stuff in the buffer;
597 * queue up whatever didn't get sent for later. */
600 unix_cli_add_pending_output (uf, cf, buffer + n, buffer_bytes - n);
604 /** @brief Process a buffer for CRLF handling before outputting it to the CLI.
606 * @param cf Unix CLI session of the desired stream to write to.
607 * @param uf The Unix file structure of the desired stream to write to.
608 * @param buffer Pointer to the buffer that needs to be written.
609 * @param buffer_bytes The number of bytes from \c buffer to write.
612 unix_vlib_cli_output_cooked (unix_cli_file_t * cf,
614 u8 * buffer, uword buffer_bytes)
616 word end = 0, start = 0;
618 while (end < buffer_bytes)
622 /* iterate the line on \n's so we can insert a \r before it */
623 end = unix_vlib_findchr ('\n',
625 buffer_bytes - start) + start;
629 /* otherwise just send the whole buffer */
633 unix_vlib_cli_output_raw (cf, uf, buffer + start, end - start);
637 if (end < buffer_bytes)
639 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\r\n", 2);
640 end++; /* skip the \n that we already sent */
647 /** @brief Output the CLI prompt */
649 unix_cli_cli_prompt (unix_cli_file_t * cf, unix_file_t * uf)
651 unix_cli_main_t *cm = &unix_cli_main;
653 unix_vlib_cli_output_raw (cf, uf, cm->cli_prompt, vec_len (cm->cli_prompt));
656 /** @brief Output a pager prompt and show number of buffered lines */
658 unix_cli_pager_prompt (unix_cli_file_t * cf, unix_file_t * uf)
663 h = cf->pager_start + (cf->height - 1);
664 if (h > vec_len (cf->pager_index))
665 h = vec_len (cf->pager_index);
667 prompt = format (0, "\r%s-- more -- (%d-%d/%d)%s",
668 cf->ansi_capable ? ANSI_BOLD : "",
671 vec_len (cf->pager_index),
672 cf->ansi_capable ? ANSI_RESET : "");
674 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
679 /** @brief Output a pager "skipping" message */
681 unix_cli_pager_message (unix_cli_file_t * cf, unix_file_t * uf,
682 char *message, char *postfix)
686 prompt = format (0, "\r%s-- %s --%s%s",
687 cf->ansi_capable ? ANSI_BOLD : "",
688 message, cf->ansi_capable ? ANSI_RESET : "", postfix);
690 unix_vlib_cli_output_cooked (cf, uf, prompt, vec_len (prompt));
695 /** @brief Erase the printed pager prompt */
697 unix_cli_pager_prompt_erase (unix_cli_file_t * cf, unix_file_t * uf)
699 if (cf->ansi_capable)
701 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
702 unix_vlib_cli_output_cooked (cf, uf,
703 (u8 *) ANSI_CLEARLINE,
704 sizeof (ANSI_CLEARLINE) - 1);
710 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
711 for (i = 0; i < cf->width - 1; i++)
712 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
713 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\r", 1);
717 /** @brief Uses an ANSI escape sequence to move the cursor */
719 unix_cli_ansi_cursor (unix_cli_file_t * cf, unix_file_t * uf, u16 x, u16 y)
723 str = format (0, "%s%d;%dH", CSI, y, x);
725 unix_vlib_cli_output_cooked (cf, uf, str, vec_len (str));
730 /** Redraw the currently displayed page of text.
731 * @param cf CLI session to redraw the pager buffer of.
732 * @param uf Unix file of the CLI session.
735 unix_cli_pager_redraw (unix_cli_file_t * cf, unix_file_t * uf)
737 unix_cli_pager_index_t *pi = NULL;
741 /* No active pager? Do nothing. */
742 if (!vec_len (cf->pager_index))
745 if (cf->ansi_capable)
747 /* If we have ANSI, send the clear screen sequence */
748 unix_vlib_cli_output_cooked (cf, uf,
750 sizeof (ANSI_CLEAR) - 1);
754 /* Otherwise make sure we're on a blank line */
755 unix_cli_pager_prompt_erase (cf, uf);
758 /* (Re-)send the current page of content */
759 for (i = 0; i < cf->height - 1 &&
760 i + cf->pager_start < vec_len (cf->pager_index); i++)
762 pi = &cf->pager_index[cf->pager_start + i];
763 line = cf->pager_vector[pi->line] + pi->offset;
765 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
767 /* if the last line didn't end in newline, add a newline */
768 if (pi && line[pi->length - 1] != '\n')
769 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
771 unix_cli_pager_prompt (cf, uf);
774 /** @brief Process and add a line to the pager index.
775 * In normal operation this function will take the given character string
776 * found in @c line and with length @c len_or_index and iterates the over the
777 * contents, adding each line of text discovered within it to the
778 * pager index. Lines are identified by newlines ("<code>\\n</code>") and by
779 * strings longer than the width of the terminal.
781 * If instead @c line is @c NULL then @c len_or_index is taken to mean the
782 * index of an existing line in the pager buffer; this simply means that the
783 * input line does not need to be cloned since we alreayd have it. This is
784 * typical if we are reindexing the pager buffer.
786 * @param cf The CLI session whose pager we are adding to.
787 * @param line The string of text to be indexed into the pager buffer.
788 * If @c line is @c NULL then the mode of operation
789 * changes slightly; see the description above.
790 * @param len_or_index If @c line is a pointer to a string then this parameter
791 * indicates the length of that string; Otherwise this
792 * value provides the index in the pager buffer of an
793 * existing string to be indexed.
796 unix_cli_pager_add_line (unix_cli_file_t * cf, u8 * line, word len_or_index)
800 word line_index, len;
801 u32 width = cf->width;
802 unix_cli_pager_index_t *pi;
806 /* Use a line already in the pager buffer */
807 line_index = len_or_index;
808 p = cf->pager_vector[line_index];
814 /* Add a copy of the raw string to the pager buffer */
815 p = vec_new (u8, len);
816 clib_memcpy (p, line, len);
818 /* store in pager buffer */
819 line_index = vec_len (cf->pager_vector);
820 vec_add1 (cf->pager_vector, p);
826 /* Find the next line, or run to terminal width, or run to EOL */
828 j = unix_vlib_findchr ((u8) '\n', p, l < width ? l : width);
830 if (j < l && p[j] == '\n') /* incl \n */
833 /* Add the line to the index */
834 k = vec_len (cf->pager_index);
835 vec_validate (cf->pager_index, k);
836 pi = &cf->pager_index[k];
838 pi->line = line_index;
847 /** @brief Reindex entire pager buffer.
848 * Resets the current pager index and then re-adds the lines in the pager
849 * buffer to the index.
851 * Additionally this function attempts to retain the current page start
852 * line offset by searching for the same top-of-screen line in the new index.
854 * @param cf The CLI session whose pager buffer should be reindexed.
857 unix_cli_pager_reindex (unix_cli_file_t * cf)
859 word i, old_line, old_offset;
860 unix_cli_pager_index_t *pi;
862 /* If there is nothing in the pager buffer then make sure the index
863 * is empty and move on.
865 if (cf->pager_vector == 0)
867 vec_reset_length (cf->pager_index);
871 /* Retain a pointer to the current page start line so we can
874 pi = &cf->pager_index[cf->pager_start];
876 old_offset = pi->offset;
878 /* Re-add the buffered lines to the index */
879 vec_reset_length (cf->pager_index);
880 vec_foreach_index (i, cf->pager_vector)
882 unix_cli_pager_add_line (cf, NULL, i);
885 /* Attempt to re-locate the previously stored page start line */
886 vec_foreach_index (i, cf->pager_index)
888 pi = &cf->pager_index[i];
890 if (pi->line == old_line &&
891 (pi->offset <= old_offset || pi->offset + pi->length > old_offset))
899 /* In case the start line was not found (rare), ensure the pager start
900 * index is within bounds
902 if (cf->pager_start >= vec_len (cf->pager_index))
904 if (!cf->height || vec_len (cf->pager_index) < (cf->height - 1))
907 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
911 /** VLIB CLI output function.
913 * If the terminal has a pager configured then this function takes care
914 * of collating output into the pager buffer; ensuring only the first page
915 * is displayed and any lines in excess of the first page are buffered.
917 * If the maximum number of index lines in the buffer is exceeded then the
918 * pager is cancelled and the contents of the current buffer are sent to the
921 * If there is no pager configured then the output is sent directly to the
924 * @param cli_file_index Index of the CLI session where this output is
926 * @param buffer String of printabe bytes to be output.
927 * @param buffer_bytes The number of bytes in @c buffer to be output.
930 unix_vlib_cli_output (uword cli_file_index, u8 * buffer, uword buffer_bytes)
932 unix_main_t *um = &unix_main;
933 unix_cli_main_t *cm = &unix_cli_main;
937 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
938 uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
940 if (cf->no_pager || um->cli_pager_buffer_limit == 0 || cf->height == 0)
942 unix_vlib_cli_output_cooked (cf, uf, buffer, buffer_bytes);
946 word row = vec_len (cf->pager_index);
948 unix_cli_pager_index_t *pi;
950 /* Index and add the output lines to the pager buffer. */
951 unix_cli_pager_add_line (cf, buffer, buffer_bytes);
953 /* Now iterate what was added to display the lines.
954 * If we reach the bottom of the page, display a prompt.
956 while (row < vec_len (cf->pager_index))
958 if (row < cf->height - 1)
960 /* output this line */
961 pi = &cf->pager_index[row];
962 line = cf->pager_vector[pi->line] + pi->offset;
963 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
965 /* if the last line didn't end in newline, and we're at the
966 * bottom of the page, add a newline */
967 if (line[pi->length - 1] != '\n' && row == cf->height - 2)
968 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
972 /* Display the pager prompt every 10 lines */
974 unix_cli_pager_prompt (cf, uf);
979 /* Check if we went over the pager buffer limit */
980 if (vec_len (cf->pager_index) > um->cli_pager_buffer_limit)
982 /* Stop using the pager for the remainder of this CLI command */
985 /* If we likely printed the prompt, erase it */
986 if (vec_len (cf->pager_index) > cf->height - 1)
987 unix_cli_pager_prompt_erase (cf, uf);
989 /* Dump out the contents of the buffer */
990 for (row = cf->pager_start + (cf->height - 1);
991 row < vec_len (cf->pager_index); row++)
993 pi = &cf->pager_index[row];
994 line = cf->pager_vector[pi->line] + pi->offset;
995 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
998 unix_cli_pager_reset (cf);
1003 /** Identify whether a terminal type is ANSI capable.
1005 * Compares the string given in @c term with a list of terminal types known
1006 * to support ANSI escape sequences.
1008 * This list contains, for example, @c xterm, @c screen and @c ansi.
1010 * @param term A string with a terminal type in it.
1011 * @param len The length of the string in @c term.
1013 * @return @c 1 if the terminal type is recognized as supporting ANSI
1014 * terminal sequences; @c 0 otherwise.
1017 unix_cli_terminal_type (u8 * term, uword len)
1019 /* This may later be better done as a hash of some sort. */
1021 if (strncasecmp(a, (char *)term, (size_t)len) == 0) return 1; \
1026 _("xterm-256color"); /* iTerm on Mac */
1028 _("screen-256color"); /* Screen and tmux */
1029 _("ansi"); /* Microsoft Telnet */
1035 /** @brief Emit initial welcome banner and prompt on a connection. */
1037 unix_cli_file_welcome (unix_cli_main_t * cm, unix_cli_file_t * cf)
1039 unix_main_t *um = &unix_main;
1040 unix_file_t *uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
1041 unix_cli_banner_t *banner;
1045 * Put the first bytes directly into the buffer so that further output is
1046 * queued until everything is ready. (oterwise initial prompt can appear
1047 * mid way through VPP initialization)
1049 unix_cli_add_pending_output (uf, cf, (u8 *) "\r", 1);
1051 if (!um->cli_no_banner)
1053 if (cf->ansi_capable)
1055 banner = unix_cli_banner_color;
1056 len = ARRAY_LEN (unix_cli_banner_color);
1060 banner = unix_cli_banner;
1061 len = ARRAY_LEN (unix_cli_banner);
1064 for (i = 0; i < len; i++)
1066 unix_vlib_cli_output_cooked (cf, uf,
1067 banner[i].line, banner[i].length);
1072 unix_cli_cli_prompt (cf, uf);
1077 /** @brief A failsafe triggered on a timer to ensure we send the prompt
1078 * to telnet sessions that fail to negotiate the terminal type. */
1080 unix_cli_file_welcome_timer (any arg, f64 delay)
1082 unix_cli_main_t *cm = &unix_cli_main;
1083 unix_cli_file_t *cf;
1086 /* Check the connection didn't close already */
1087 if (pool_is_free_index (cm->cli_file_pool, (uword) arg))
1090 cf = pool_elt_at_index (cm->cli_file_pool, (uword) arg);
1093 unix_cli_file_welcome (cm, cf);
1096 /** @brief A mostly no-op Telnet state machine.
1097 * Process Telnet command bytes in a way that ensures we're mostly
1098 * transparent to the Telnet protocol. That is, it's mostly a no-op.
1100 * @return -1 if we need more bytes, otherwise a positive integer number of
1101 * bytes to consume from the input_vector, not including the initial
1105 unix_cli_process_telnet (unix_main_t * um,
1106 unix_cli_file_t * cf,
1107 unix_file_t * uf, u8 * input_vector, uword len)
1109 /* Input_vector starts at IAC byte.
1110 * See if we have a complete message; if not, return -1 so we wait for more.
1111 * if we have a complete message, consume those bytes from the vector.
1116 return -1; /* want more bytes */
1118 switch (input_vector[1])
1121 /* two IAC's in a row means to pass through 0xff.
1122 * since that makes no sense here, just consume it.
1131 /* Expect 3 bytes */
1132 if (vec_len (input_vector) < 3)
1133 return -1; /* want more bytes */
1140 /* Sub option - search ahead for IAC SE to end it */
1142 for (i = 3; i < len && i < UNIX_CLI_MAX_DEPTH_TELNET; i++)
1144 if (input_vector[i - 1] == IAC && input_vector[i] == SE)
1146 /* We have a complete message; see if we care about it */
1147 switch (input_vector[2])
1150 if (input_vector[3] != 0)
1152 /* See if the terminal type is ANSI capable */
1154 unix_cli_terminal_type (input_vector + 4, i - 5);
1155 /* If session not started, we can release the pause */
1157 /* Send the welcome banner and initial prompt */
1158 unix_cli_file_welcome (&unix_cli_main, cf);
1163 if (i != 8) /* check message is correct size */
1166 clib_net_to_host_u16 (*((u16 *) (input_vector + 3)));
1168 clib_net_to_host_u16 (*((u16 *) (input_vector + 5)));
1169 /* reindex pager buffer */
1170 unix_cli_pager_reindex (cf);
1172 unix_cli_pager_redraw (cf, uf);
1178 /* Consume it all */
1184 if (i == UNIX_CLI_MAX_DEPTH_TELNET)
1185 consume = 1; /* hit max search depth, advance one byte */
1188 return -1; /* want more bytes */
1206 /* Simple one-byte messages */
1211 /* Are You There - trigger a visible response */
1213 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "fd.io VPP\n", 10);
1217 /* Unknown command! Eat the IAC byte */
1224 /** @brief Process actionable input.
1225 * Based on the \c action process the input; this typically involves
1226 * searching the command history or editing the current command line.
1229 unix_cli_line_process_one (unix_cli_main_t * cm,
1231 unix_cli_file_t * cf,
1233 u8 input, unix_cli_parse_action_t action)
1237 u8 **possible_commands;
1242 case UNIX_CLI_PARSE_ACTION_NOACTION:
1245 case UNIX_CLI_PARSE_ACTION_REVSEARCH:
1246 case UNIX_CLI_PARSE_ACTION_FWDSEARCH:
1247 if (!cf->has_history || !cf->history_limit)
1249 if (cf->search_mode == 0)
1251 /* Erase the current command (if any) */
1252 for (j = 0; j < (vec_len (cf->current_command)); j++)
1253 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b \b", 3);
1255 vec_reset_length (cf->search_key);
1256 vec_reset_length (cf->current_command);
1257 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1258 cf->search_mode = -1;
1260 cf->search_mode = 1;
1265 if (action == UNIX_CLI_PARSE_ACTION_REVSEARCH)
1266 cf->search_mode = -1;
1268 cf->search_mode = 1;
1270 cf->excursion += cf->search_mode;
1275 case UNIX_CLI_PARSE_ACTION_ERASELINELEFT:
1276 /* Erase the command from the cursor to the start */
1278 /* Shimmy forwards to the new end of line position */
1279 delta = vec_len (cf->current_command) - cf->cursor;
1280 for (j = cf->cursor; j > delta; j--)
1281 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1282 /* Zap from here to the end of what is currently displayed */
1283 for (; j < (vec_len (cf->current_command)); j++)
1284 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1285 /* Get back to the start of the line */
1286 for (j = 0; j < (vec_len (cf->current_command)); j++)
1287 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1289 j = vec_len (cf->current_command) - cf->cursor;
1290 memmove (cf->current_command, cf->current_command + cf->cursor, j);
1291 _vec_len (cf->current_command) = j;
1293 /* Print the new contents */
1294 unix_vlib_cli_output_cooked (cf, uf, cf->current_command, j);
1295 /* Shimmy back to the start */
1296 for (j = 0; j < (vec_len (cf->current_command)); j++)
1297 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1300 cf->search_mode = 0;
1303 case UNIX_CLI_PARSE_ACTION_ERASELINERIGHT:
1304 /* Erase the command from the cursor to the end */
1306 /* Zap from cursor to end of what is currently displayed */
1307 for (j = cf->cursor; j < (vec_len (cf->current_command)); j++)
1308 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1309 /* Get back to where we were */
1310 for (j = cf->cursor; j < (vec_len (cf->current_command)); j++)
1311 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1313 /* Truncate the line at the cursor */
1314 _vec_len (cf->current_command) = cf->cursor;
1316 cf->search_mode = 0;
1319 case UNIX_CLI_PARSE_ACTION_LEFT:
1322 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1326 cf->search_mode = 0;
1329 case UNIX_CLI_PARSE_ACTION_RIGHT:
1330 if (cf->cursor < vec_len (cf->current_command))
1332 /* have to emit the character under the cursor */
1333 unix_vlib_cli_output_cooked (cf, uf,
1334 cf->current_command + cf->cursor, 1);
1338 cf->search_mode = 0;
1341 case UNIX_CLI_PARSE_ACTION_UP:
1342 case UNIX_CLI_PARSE_ACTION_DOWN:
1343 if (!cf->has_history || !cf->history_limit)
1345 cf->search_mode = 0;
1346 /* Erase the command */
1347 for (j = cf->cursor; j < (vec_len (cf->current_command)); j++)
1348 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " ", 1);
1349 for (j = 0; j < (vec_len (cf->current_command)); j++)
1350 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b \b", 3);
1351 vec_reset_length (cf->current_command);
1352 if (vec_len (cf->command_history))
1354 if (action == UNIX_CLI_PARSE_ACTION_UP)
1359 cf->excursion += delta;
1361 if (cf->excursion == vec_len (cf->command_history))
1363 /* down-arrowed to last entry - want a blank line */
1364 _vec_len (cf->current_command) = 0;
1366 else if (cf->excursion < 0)
1368 /* up-arrowed over the start to the end, want a blank line */
1369 cf->excursion = vec_len (cf->command_history);
1370 _vec_len (cf->current_command) = 0;
1374 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1375 /* down-arrowed past end - wrap to start */
1378 /* Print the command at the current position */
1379 prev = cf->command_history[cf->excursion];
1380 vec_validate (cf->current_command, vec_len (prev) - 1);
1382 clib_memcpy (cf->current_command, prev, vec_len (prev));
1383 _vec_len (cf->current_command) = vec_len (prev);
1384 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
1385 vec_len (cf->current_command));
1387 cf->cursor = vec_len (cf->current_command);
1393 case UNIX_CLI_PARSE_ACTION_HOME:
1394 if (vec_len (cf->current_command) && cf->cursor > 0)
1398 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1403 cf->search_mode = 0;
1406 case UNIX_CLI_PARSE_ACTION_END:
1407 if (vec_len (cf->current_command) &&
1408 cf->cursor < vec_len (cf->current_command))
1410 unix_vlib_cli_output_cooked (cf, uf,
1411 cf->current_command + cf->cursor,
1412 vec_len (cf->current_command) -
1414 cf->cursor = vec_len (cf->current_command);
1417 cf->search_mode = 0;
1420 case UNIX_CLI_PARSE_ACTION_WORDLEFT:
1421 if (vec_len (cf->current_command) && cf->cursor > 0)
1425 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1428 while (j && isspace (cf->current_command[j]))
1430 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1433 while (j && !isspace (cf->current_command[j]))
1435 if (isspace (cf->current_command[j - 1]))
1437 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1444 cf->search_mode = 0;
1447 case UNIX_CLI_PARSE_ACTION_WORDRIGHT:
1448 if (vec_len (cf->current_command) &&
1449 cf->cursor < vec_len (cf->current_command))
1451 int e = vec_len (cf->current_command);
1453 while (j < e && !isspace (cf->current_command[j]))
1455 while (j < e && isspace (cf->current_command[j]))
1457 unix_vlib_cli_output_cooked (cf, uf,
1458 cf->current_command + cf->cursor,
1463 cf->search_mode = 0;
1467 case UNIX_CLI_PARSE_ACTION_ERASE:
1468 if (vec_len (cf->current_command))
1470 if (cf->cursor == vec_len (cf->current_command))
1472 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b \b", 3);
1473 _vec_len (cf->current_command)--;
1476 else if (cf->cursor > 0)
1478 /* shift everything at & to the right of the cursor left by 1 */
1479 j = vec_len (cf->current_command) - cf->cursor;
1480 memmove (cf->current_command + cf->cursor - 1,
1481 cf->current_command + cf->cursor, j);
1482 _vec_len (cf->current_command)--;
1484 /* redraw the rest of the line */
1485 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1486 unix_vlib_cli_output_cooked (cf, uf,
1487 cf->current_command + cf->cursor,
1489 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " \b\b", 3);
1490 /* and shift the terminal cursor back where it should be */
1492 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1495 cf->search_mode = 0;
1497 vec_reset_length (cf->search_key);
1500 case UNIX_CLI_PARSE_ACTION_ERASERIGHT:
1501 if (vec_len (cf->current_command))
1503 if (cf->cursor < vec_len (cf->current_command))
1505 /* shift everything to the right of the cursor left by 1 */
1506 j = vec_len (cf->current_command) - cf->cursor - 1;
1507 memmove (cf->current_command + cf->cursor,
1508 cf->current_command + cf->cursor + 1, j);
1509 _vec_len (cf->current_command)--;
1510 /* redraw the rest of the line */
1511 unix_vlib_cli_output_cooked (cf, uf,
1512 cf->current_command + cf->cursor,
1514 unix_vlib_cli_output_cooked (cf, uf, (u8 *) " \b", 2);
1515 /* and shift the terminal cursor back where it should be */
1518 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1520 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1524 else if (input == 'D' - '@')
1526 /* ^D with no command entered = quit */
1527 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "quit\n", 5);
1528 vlib_process_signal_event (um->vlib_main,
1529 vlib_current_process (um->vlib_main),
1530 UNIX_CLI_PROCESS_EVENT_QUIT,
1531 cf - cm->cli_file_pool);
1533 cf->search_mode = 0;
1535 vec_reset_length (cf->search_key);
1538 case UNIX_CLI_PARSE_ACTION_CLEAR:
1539 /* If we're in ANSI mode, clear the screen.
1540 * Then redraw the prompt and any existing command input, then put
1541 * the cursor back where it was in that line.
1543 if (cf->ansi_capable)
1544 unix_vlib_cli_output_cooked (cf, uf,
1546 sizeof (ANSI_CLEAR) - 1);
1548 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1550 unix_vlib_cli_output_raw (cf, uf,
1551 cm->cli_prompt, vec_len (cm->cli_prompt));
1552 unix_vlib_cli_output_raw (cf, uf,
1553 cf->current_command,
1554 vec_len (cf->current_command));
1555 for (j = cf->cursor; j < vec_len (cf->current_command); j++)
1556 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b", 1);
1560 case UNIX_CLI_PARSE_ACTION_TAB:
1561 if (cf->cursor < vec_len (cf->current_command))
1563 /* if we are in the middle of a line, complete only if
1564 * the cursor points to whitespace */
1565 if (isspace (cf->current_command[cf->cursor]))
1567 /* save and clear any input that is after the cursor */
1568 vec_resize (save, vec_len (cf->current_command) - cf->cursor);
1569 clib_memcpy (save, cf->current_command + cf->cursor,
1570 vec_len (cf->current_command) - cf->cursor);
1571 _vec_len (cf->current_command) = cf->cursor;
1575 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1580 vlib_cli_get_possible_completions (cf->current_command);
1581 if (vec_len (possible_commands) == 1)
1584 u8 *completed = possible_commands[0];
1586 /* find the last word of current_command */
1587 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1590 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\b", 1);
1592 _vec_len (cf->current_command) = j;
1594 /* replace it with the newly expanded command */
1595 vec_append (cf->current_command, completed);
1597 /* echo to the terminal */
1598 unix_vlib_cli_output_raw (cf, uf, completed, vec_len (completed));
1600 /* add one trailing space if needed */
1601 if (vec_len (save) == 0)
1603 vec_add1 (cf->current_command, ' ');
1604 unix_vlib_cli_output_raw (cf, uf, (u8 *) " ", 1);
1607 cf->cursor = vec_len (cf->current_command);
1610 else if (vec_len (possible_commands) >= 2)
1612 u8 **possible_command;
1613 uword max_command_len = 0, min_command_len = ~0;
1616 vec_foreach (possible_command, possible_commands)
1618 if (vec_len (*possible_command) > max_command_len)
1620 max_command_len = vec_len (*possible_command);
1622 if (vec_len (*possible_command) < min_command_len)
1624 min_command_len = vec_len (*possible_command);
1628 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1631 vec_foreach (possible_command, possible_commands)
1633 if (i + max_command_len >= cf->width)
1635 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1638 unix_vlib_cli_output_raw (cf, uf, *possible_command,
1639 vec_len (*possible_command));
1640 for (j = vec_len (*possible_command); j < max_command_len + 2;
1643 unix_vlib_cli_output_raw (cf, uf, (u8 *) " ", 1);
1645 i += max_command_len + 2;
1648 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1650 /* rewrite prompt */
1651 unix_cli_cli_prompt (cf, uf);
1652 unix_vlib_cli_output_raw (cf, uf, cf->current_command,
1653 vec_len (cf->current_command));
1655 /* count length of last word */
1658 while (j >= 1 && !isspace (cf->current_command[j - 1]))
1664 /* determine smallest common command */
1665 for (; i < min_command_len; i++)
1669 vec_foreach (possible_command, possible_commands)
1673 common = (*possible_command)[i];
1675 else if (common != (*possible_command)[i])
1683 vec_add1 (cf->current_command, common);
1685 unix_vlib_cli_output_raw (cf, uf, (u8 *) & common, 1);
1695 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\a", 1);
1698 if (vec_len (save) > 0)
1700 /* restore remaining input if tab was hit in the middle of a line */
1701 unix_vlib_cli_output_raw (cf, uf, save, vec_len (save));
1702 for (j = 0; j < vec_len (save); j++)
1704 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\b", 1);
1706 vec_append (cf->current_command, save);
1709 vec_free (possible_commands);
1712 case UNIX_CLI_PARSE_ACTION_YANK:
1717 case UNIX_CLI_PARSE_ACTION_PAGER_QUIT:
1719 unix_cli_pager_prompt_erase (cf, uf);
1720 unix_cli_pager_reset (cf);
1721 unix_cli_cli_prompt (cf, uf);
1724 case UNIX_CLI_PARSE_ACTION_PAGER_NEXT:
1725 case UNIX_CLI_PARSE_ACTION_PAGER_PGDN:
1726 /* show next page of the buffer */
1727 if (cf->height + cf->pager_start < vec_len (cf->pager_index))
1730 unix_cli_pager_index_t *pi = NULL;
1732 int m = cf->pager_start + (cf->height - 1);
1733 unix_cli_pager_prompt_erase (cf, uf);
1735 j < vec_len (cf->pager_index) && cf->pager_start < m;
1736 j++, cf->pager_start++)
1738 pi = &cf->pager_index[j];
1739 line = cf->pager_vector[pi->line] + pi->offset;
1740 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1742 /* if the last line didn't end in newline, add a newline */
1743 if (pi && line[pi->length - 1] != '\n')
1744 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1745 unix_cli_pager_prompt (cf, uf);
1749 if (action == UNIX_CLI_PARSE_ACTION_PAGER_NEXT)
1750 /* no more in buffer, exit, but only if it was <space> */
1755 case UNIX_CLI_PARSE_ACTION_PAGER_DN:
1756 case UNIX_CLI_PARSE_ACTION_PAGER_CRLF:
1757 /* display the next line of the buffer */
1758 if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
1761 unix_cli_pager_index_t *pi;
1763 unix_cli_pager_prompt_erase (cf, uf);
1764 pi = &cf->pager_index[cf->pager_start + (cf->height - 1)];
1765 line = cf->pager_vector[pi->line] + pi->offset;
1766 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1768 /* if the last line didn't end in newline, add a newline */
1769 if (line[pi->length - 1] != '\n')
1770 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1771 unix_cli_pager_prompt (cf, uf);
1775 if (action == UNIX_CLI_PARSE_ACTION_PAGER_CRLF)
1776 /* no more in buffer, exit, but only if it was <enter> */
1782 case UNIX_CLI_PARSE_ACTION_PAGER_UP:
1783 /* scroll the page back one line */
1784 if (cf->pager_start > 0)
1787 unix_cli_pager_index_t *pi = NULL;
1790 if (cf->ansi_capable)
1792 pi = &cf->pager_index[cf->pager_start];
1793 line = cf->pager_vector[pi->line] + pi->offset;
1794 unix_cli_pager_prompt_erase (cf, uf);
1795 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SCROLLDN,
1796 sizeof (ANSI_SCROLLDN) - 1);
1797 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_SAVECURSOR,
1798 sizeof (ANSI_SAVECURSOR) - 1);
1799 unix_cli_ansi_cursor (cf, uf, 1, 1);
1800 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_CLEARLINE,
1801 sizeof (ANSI_CLEARLINE) - 1);
1802 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1803 unix_vlib_cli_output_cooked (cf, uf, (u8 *) ANSI_RESTCURSOR,
1804 sizeof (ANSI_RESTCURSOR) - 1);
1805 unix_cli_pager_prompt_erase (cf, uf);
1806 unix_cli_pager_prompt (cf, uf);
1810 int m = cf->pager_start + (cf->height - 1);
1811 unix_cli_pager_prompt_erase (cf, uf);
1812 for (j = cf->pager_start;
1813 j < vec_len (cf->pager_index) && j < m; j++)
1815 pi = &cf->pager_index[j];
1816 line = cf->pager_vector[pi->line] + pi->offset;
1817 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1819 /* if the last line didn't end in newline, add a newline */
1820 if (pi && line[pi->length - 1] != '\n')
1821 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1822 unix_cli_pager_prompt (cf, uf);
1827 case UNIX_CLI_PARSE_ACTION_PAGER_TOP:
1828 /* back to the first page of the buffer */
1829 if (cf->pager_start > 0)
1832 unix_cli_pager_index_t *pi = NULL;
1834 cf->pager_start = 0;
1835 int m = cf->pager_start + (cf->height - 1);
1836 unix_cli_pager_prompt_erase (cf, uf);
1837 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
1840 pi = &cf->pager_index[j];
1841 line = cf->pager_vector[pi->line] + pi->offset;
1842 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1844 /* if the last line didn't end in newline, add a newline */
1845 if (pi && line[pi->length - 1] != '\n')
1846 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1847 unix_cli_pager_prompt (cf, uf);
1851 case UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM:
1852 /* skip to the last page of the buffer */
1853 if (cf->pager_start < vec_len (cf->pager_index) - (cf->height - 1))
1856 unix_cli_pager_index_t *pi = NULL;
1858 cf->pager_start = vec_len (cf->pager_index) - (cf->height - 1);
1859 unix_cli_pager_prompt_erase (cf, uf);
1860 unix_cli_pager_message (cf, uf, "skipping", "\n");
1861 for (j = cf->pager_start; j < vec_len (cf->pager_index); j++)
1863 pi = &cf->pager_index[j];
1864 line = cf->pager_vector[pi->line] + pi->offset;
1865 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1867 /* if the last line didn't end in newline, add a newline */
1868 if (pi && line[pi->length - 1] != '\n')
1869 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1870 unix_cli_pager_prompt (cf, uf);
1874 case UNIX_CLI_PARSE_ACTION_PAGER_PGUP:
1875 /* wander back one page in the buffer */
1876 if (cf->pager_start > 0)
1879 unix_cli_pager_index_t *pi = NULL;
1882 if (cf->pager_start >= cf->height)
1883 cf->pager_start -= cf->height - 1;
1885 cf->pager_start = 0;
1886 m = cf->pager_start + cf->height - 1;
1887 unix_cli_pager_prompt_erase (cf, uf);
1888 for (j = cf->pager_start; j < vec_len (cf->pager_index) && j < m;
1891 pi = &cf->pager_index[j];
1892 line = cf->pager_vector[pi->line] + pi->offset;
1893 unix_vlib_cli_output_cooked (cf, uf, line, pi->length);
1895 /* if the last line didn't end in newline, add a newline */
1896 if (pi && line[pi->length - 1] != '\n')
1897 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1898 unix_cli_pager_prompt (cf, uf);
1902 case UNIX_CLI_PARSE_ACTION_PAGER_REDRAW:
1903 /* Redraw the current pager screen */
1904 unix_cli_pager_redraw (cf, uf);
1907 case UNIX_CLI_PARSE_ACTION_PAGER_SEARCH:
1908 /* search forwards in the buffer */
1912 case UNIX_CLI_PARSE_ACTION_CRLF:
1914 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\n", 1);
1916 if (cf->has_history && cf->history_limit)
1918 if (cf->command_history
1919 && vec_len (cf->command_history) >= cf->history_limit)
1921 vec_free (cf->command_history[0]);
1922 vec_delete (cf->command_history, 1, 0);
1924 /* Don't add blank lines to the cmd history */
1925 if (vec_len (cf->current_command))
1927 /* Don't duplicate the previous command */
1928 j = vec_len (cf->command_history);
1930 (vec_len (cf->current_command) !=
1931 vec_len (cf->command_history[j - 1])
1932 || memcmp (cf->current_command, cf->command_history[j - 1],
1933 vec_len (cf->current_command)) != 0))
1935 /* copy the command to the history */
1937 vec_append (c, cf->current_command);
1938 vec_add1 (cf->command_history, c);
1939 cf->command_number++;
1942 cf->excursion = vec_len (cf->command_history);
1945 cf->search_mode = 0;
1946 vec_reset_length (cf->search_key);
1951 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
1952 case UNIX_CLI_PARSE_ACTION_NOMATCH:
1953 if (vec_len (cf->pager_index))
1957 else if (cf->has_history && cf->search_mode && isprint (input))
1959 int k, limit, offset;
1962 vec_add1 (cf->search_key, input);
1965 for (j = 0; j < vec_len (cf->command_history); j++)
1967 if (cf->excursion > (i32) vec_len (cf->command_history) - 1)
1969 else if (cf->excursion < 0)
1970 cf->excursion = vec_len (cf->command_history) - 1;
1972 item = cf->command_history[cf->excursion];
1974 limit = (vec_len (cf->search_key) > vec_len (item)) ?
1975 vec_len (item) : vec_len (cf->search_key);
1977 for (offset = 0; offset <= vec_len (item) - limit; offset++)
1979 for (k = 0; k < limit; k++)
1981 if (item[k + offset] != cf->search_key[k])
1984 goto found_at_offset;
1992 for (j = 0; j < vec_len (cf->current_command); j++)
1993 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\b \b", 3);
1995 vec_validate (cf->current_command, vec_len (item) - 1);
1996 clib_memcpy (cf->current_command, item, vec_len (item));
1997 _vec_len (cf->current_command) = vec_len (item);
1999 unix_vlib_cli_output_cooked (cf, uf, cf->current_command,
2000 vec_len (cf->current_command));
2001 cf->cursor = vec_len (cf->current_command);
2005 cf->excursion += cf->search_mode;
2008 unix_vlib_cli_output_cooked (cf, uf, (u8 *) "\nNo match...", 12);
2009 vec_reset_length (cf->search_key);
2010 vec_reset_length (cf->current_command);
2011 cf->search_mode = 0;
2015 else if (isprint (input)) /* skip any errant control codes */
2017 if (cf->cursor == vec_len (cf->current_command))
2020 vec_add1 (cf->current_command, input);
2023 /* Echo the character back to the client */
2024 unix_vlib_cli_output_raw (cf, uf, &input, 1);
2028 /* Insert at cursor: resize +1 byte, move everything over */
2029 j = vec_len (cf->current_command) - cf->cursor;
2030 vec_add1 (cf->current_command, (u8) 'A');
2031 memmove (cf->current_command + cf->cursor + 1,
2032 cf->current_command + cf->cursor, j);
2033 cf->current_command[cf->cursor] = input;
2034 /* Redraw the line */
2036 unix_vlib_cli_output_raw (cf, uf,
2037 cf->current_command + cf->cursor, j);
2038 /* Put terminal cursor back */
2040 unix_vlib_cli_output_raw (cf, uf, (u8 *) "\b", 1);
2046 /* no-op - not printable or otherwise not actionable */
2053 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2059 /** @brief Process input bytes on a stream to provide line editing and
2060 * command history in the CLI. */
2062 unix_cli_line_edit (unix_cli_main_t * cm,
2063 unix_main_t * um, unix_cli_file_t * cf)
2065 unix_file_t *uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
2068 for (i = 0; i < vec_len (cf->input_vector); i++)
2070 unix_cli_parse_action_t action;
2072 unix_cli_parse_actions_t *a;
2074 /* If we're in the pager mode, search the pager actions */
2076 vec_len (cf->pager_index) ? unix_cli_parse_pager :
2077 unix_cli_parse_strings;
2079 /* See if the input buffer is some sort of control code */
2080 action = unix_cli_match_action (a, &cf->input_vector[i],
2081 vec_len (cf->input_vector) - i,
2086 case UNIX_CLI_PARSE_ACTION_PARTIALMATCH:
2089 /* There was a partial match which means we need more bytes
2090 * than the input buffer currently has.
2091 * Since the bytes before here have been processed, shift
2092 * the remaining contents to the start of the input buffer.
2094 vec_delete (cf->input_vector, i, 0);
2096 return 1; /* wait for more */
2098 case UNIX_CLI_PARSE_ACTION_TELNETIAC:
2099 /* process telnet options */
2100 matched = unix_cli_process_telnet (um, cf, uf,
2101 cf->input_vector + i,
2102 vec_len (cf->input_vector) - i);
2107 /* There was a partial match which means we need more bytes
2108 * than the input buffer currently has.
2109 * Since the bytes before here have been processed, shift
2110 * the remaining contents to the start of the input buffer.
2112 vec_delete (cf->input_vector, i, 0);
2114 return 1; /* wait for more */
2119 /* process the action */
2120 if (!unix_cli_line_process_one (cm, um, cf, uf,
2121 cf->input_vector[i], action))
2123 /* CRLF found. Consume the bytes from the input_vector */
2124 vec_delete (cf->input_vector, i + matched, 0);
2125 /* And tell our caller to execute cf->input_command */
2133 vec_reset_length (cf->input_vector);
2137 /** @brief Process input to a CLI session. */
2139 unix_cli_process_input (unix_cli_main_t * cm, uword cli_file_index)
2141 unix_main_t *um = &unix_main;
2143 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2144 unformat_input_t input;
2145 int vlib_parse_eval (u8 *);
2148 /* Try vlibplex first. Someday... */
2149 if (0 && vlib_parse_eval (cf->input_vector) == 0)
2154 /* just treat whatever we got as a complete line of input */
2155 cf->current_command = cf->input_vector;
2159 /* Line edit, echo, etc. */
2160 if (unix_cli_line_edit (cm, um, cf))
2161 /* want more input */
2168 vec_reset_length (lv);
2169 lv = format (lv, "%U[%d]: %v",
2170 format_timeval, 0 /* current bat-time */ ,
2171 0 /* current bat-format */ ,
2172 cli_file_index, cf->input_vector);
2174 int rv __attribute__ ((unused)) =
2175 write (um->log_fd, lv, vec_len (lv));
2179 /* Copy our input command to a new string */
2180 unformat_init_vector (&input, cf->current_command);
2182 /* Remove leading white space from input. */
2183 (void) unformat (&input, "");
2185 cm->current_input_file_index = cli_file_index;
2186 cf->pager_start = 0; /* start a new pager session */
2188 if (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
2189 vlib_cli_input (um->vlib_main, &input, unix_vlib_cli_output,
2192 /* Zero buffer since otherwise unformat_free will call vec_free on it. */
2195 unformat_free (&input);
2197 /* Re-fetch pointer since pool may have moved. */
2198 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2199 uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
2202 /* reset vector; we'll re-use it later */
2204 vec_reset_length (cf->input_vector);
2206 vec_reset_length (cf->current_command);
2208 if (cf->no_pager == 2)
2210 /* Pager was programmatically disabled */
2211 unix_cli_pager_message (cf, uf, "pager buffer overflowed", "\n");
2212 cf->no_pager = um->cli_no_pager;
2215 if (vec_len (cf->pager_index) == 0
2216 || vec_len (cf->pager_index) < cf->height)
2218 /* There was no need for the pager */
2219 unix_cli_pager_reset (cf);
2222 unix_cli_cli_prompt (cf, uf);
2226 /* Display the pager prompt */
2227 unix_cli_pager_prompt (cf, uf);
2230 /* Any residual data in the input vector? */
2231 if (vec_len (cf->input_vector))
2235 /** Destroy a CLI session.
2236 * @note If we destroy the @c stdin session this additionally signals
2237 * the shutdown of VPP.
2240 unix_cli_kill (unix_cli_main_t * cm, uword cli_file_index)
2242 unix_main_t *um = &unix_main;
2243 unix_cli_file_t *cf;
2247 cf = pool_elt_at_index (cm->cli_file_pool, cli_file_index);
2248 uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
2250 /* Quit/EOF on stdin means quit program. */
2251 if (uf->file_descriptor == UNIX_CLI_STDIN_FD)
2252 clib_longjmp (&um->vlib_main->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
2254 vec_free (cf->current_command);
2255 vec_free (cf->search_key);
2257 for (i = 0; i < vec_len (cf->command_history); i++)
2258 vec_free (cf->command_history[i]);
2260 vec_free (cf->command_history);
2262 unix_file_del (um, uf);
2264 unix_cli_file_free (cf);
2265 pool_put (cm->cli_file_pool, cf);
2268 /** Handle system events. */
2270 unix_cli_process (vlib_main_t * vm,
2271 vlib_node_runtime_t * rt, vlib_frame_t * f)
2273 unix_cli_main_t *cm = &unix_cli_main;
2278 unix_cli_process_event_type_t event_type;
2279 vlib_process_wait_for_event (vm);
2280 event_type = vlib_process_get_events (vm, &data);
2284 case UNIX_CLI_PROCESS_EVENT_READ_READY:
2285 for (i = 0; i < vec_len (data); i++)
2286 unix_cli_process_input (cm, data[i]);
2289 case UNIX_CLI_PROCESS_EVENT_QUIT:
2290 /* Kill this process. */
2291 for (i = 0; i < vec_len (data); i++)
2292 unix_cli_kill (cm, data[i]);
2297 _vec_len (data) = 0;
2303 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
2305 /* Add node index so we can re-use this process later. */
2306 vec_add1 (cm->unused_cli_process_node_indices, rt->node_index);
2311 /** Called when a CLI session file descriptor can be written to without
2313 static clib_error_t *
2314 unix_cli_write_ready (unix_file_t * uf)
2316 unix_cli_main_t *cm = &unix_cli_main;
2317 unix_cli_file_t *cf;
2320 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2322 /* Flush output vector. */
2323 n = write (uf->file_descriptor,
2324 cf->output_vector, vec_len (cf->output_vector));
2326 if (n < 0 && errno != EAGAIN)
2327 return clib_error_return_unix (0, "write");
2330 unix_cli_del_pending_output (uf, cf, n);
2332 return /* no error */ 0;
2335 /** Called when a CLI session file descriptor has data to be read. */
2336 static clib_error_t *
2337 unix_cli_read_ready (unix_file_t * uf)
2339 unix_main_t *um = &unix_main;
2340 unix_cli_main_t *cm = &unix_cli_main;
2341 unix_cli_file_t *cf;
2343 int n, n_read, n_try;
2345 cf = pool_elt_at_index (cm->cli_file_pool, uf->private_data);
2350 l = vec_len (cf->input_vector);
2351 vec_resize (cf->input_vector, l + n_try);
2353 n = read (uf->file_descriptor, cf->input_vector + l, n_try);
2356 if (n < 0 && errno != EAGAIN)
2357 return clib_error_return_unix (0, "read");
2359 n_read = n < 0 ? 0 : n;
2360 _vec_len (cf->input_vector) = l + n_read;
2364 vlib_process_signal_event (um->vlib_main,
2365 cf->process_node_index,
2367 ? UNIX_CLI_PROCESS_EVENT_QUIT
2368 : UNIX_CLI_PROCESS_EVENT_READ_READY),
2369 /* event data */ uf->private_data);
2371 return /* no error */ 0;
2374 /** Store a new CLI session.
2375 * @param name The name of the session.
2376 * @param fd The file descriptor for the session I/O.
2377 * @return The session ID.
2380 unix_cli_file_add (unix_cli_main_t * cm, char *name, int fd)
2382 unix_main_t *um = &unix_main;
2383 unix_cli_file_t *cf;
2384 unix_file_t template = { 0 };
2385 vlib_main_t *vm = um->vlib_main;
2388 name = (char *) format (0, "unix-cli-%s", name);
2390 if (vec_len (cm->unused_cli_process_node_indices) > 0)
2392 uword l = vec_len (cm->unused_cli_process_node_indices);
2394 /* Find node and give it new name. */
2395 n = vlib_get_node (vm, cm->unused_cli_process_node_indices[l - 1]);
2397 n->name = (u8 *) name;
2399 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
2401 _vec_len (cm->unused_cli_process_node_indices) = l - 1;
2405 static vlib_node_registration_t r = {
2406 .function = unix_cli_process,
2407 .type = VLIB_NODE_TYPE_PROCESS,
2408 .process_log2_n_stack_bytes = 16,
2412 vlib_register_node (vm, &r);
2415 n = vlib_get_node (vm, r.index);
2418 pool_get (cm->cli_file_pool, cf);
2419 memset (cf, 0, sizeof (*cf));
2421 template.read_function = unix_cli_read_ready;
2422 template.write_function = unix_cli_write_ready;
2423 template.file_descriptor = fd;
2424 template.private_data = cf - cm->cli_file_pool;
2426 cf->process_node_index = n->index;
2427 cf->unix_file_index = unix_file_add (um, &template);
2428 cf->output_vector = 0;
2429 cf->input_vector = 0;
2431 vlib_start_process (vm, n->runtime_index);
2433 vlib_process_t *p = vlib_get_process_from_node (vm, n);
2434 p->output_function = unix_vlib_cli_output;
2435 p->output_function_arg = cf - cm->cli_file_pool;
2437 return cf - cm->cli_file_pool;
2440 /** Telnet listening socket has a new connection. */
2441 static clib_error_t *
2442 unix_cli_listen_read_ready (unix_file_t * uf)
2444 unix_main_t *um = &unix_main;
2445 unix_cli_main_t *cm = &unix_cli_main;
2446 clib_socket_t *s = &um->cli_listen_socket;
2447 clib_socket_t client;
2449 clib_error_t *error;
2450 unix_cli_file_t *cf;
2453 error = clib_socket_accept (s, &client);
2457 client_name = (char *) format (0, "%U%c", format_sockaddr, &client.peer, 0);
2459 cf_index = unix_cli_file_add (cm, client_name, client.fd);
2460 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2462 /* No longer need CLIB version of socket. */
2463 clib_socket_free (&client);
2465 vec_free (client_name);
2467 /* if we're supposed to run telnet session in character mode (default) */
2468 if (um->cli_line_mode == 0)
2471 * Set telnet client character mode, echo on, suppress "go-ahead".
2472 * Technically these should be negotiated, but this works.
2474 u8 charmode_option[] = {
2475 IAC, WONT, TELOPT_LINEMODE, /* server will do char-by-char */
2476 IAC, DONT, TELOPT_LINEMODE, /* client should do char-by-char */
2477 IAC, WILL, TELOPT_SGA, /* server willl supress GA */
2478 IAC, DO, TELOPT_SGA, /* client should supress Go Ahead */
2479 IAC, WILL, TELOPT_ECHO, /* server will do echo */
2480 IAC, DONT, TELOPT_ECHO, /* client should not echo */
2481 IAC, DO, TELOPT_TTYPE, /* client should tell us its term type */
2482 IAC, SB, TELOPT_TTYPE, 1, IAC, SE, /* now tell me ttype */
2483 IAC, DO, TELOPT_NAWS, /* client should tell us its window sz */
2484 IAC, SB, TELOPT_NAWS, 1, IAC, SE, /* now tell me window size */
2487 /* Enable history on this CLI */
2488 cf->history_limit = um->cli_history_limit;
2489 cf->has_history = cf->history_limit != 0;
2491 /* Make sure this session is in line mode */
2497 /* Setup the pager */
2498 cf->no_pager = um->cli_no_pager;
2500 uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
2502 /* Send the telnet options */
2503 unix_vlib_cli_output_raw (cf, uf, charmode_option,
2504 ARRAY_LEN (charmode_option));
2506 /* In case the client doesn't negotiate terminal type, use
2507 * a timer to kick off the initial prompt. */
2508 timer_call (unix_cli_file_welcome_timer, cf_index, 1);
2514 /** The system terminal has informed us that the window size
2518 unix_cli_resize_interrupt (int signum)
2520 unix_main_t *um = &unix_main;
2521 unix_cli_main_t *cm = &unix_cli_main;
2522 unix_cli_file_t *cf = pool_elt_at_index (cm->cli_file_pool,
2523 cm->stdin_cli_file_index);
2524 unix_file_t *uf = pool_elt_at_index (um->file_pool, cf->unix_file_index);
2528 /* Terminal resized, fetch the new size */
2529 if (ioctl (UNIX_CLI_STDIN_FD, TIOCGWINSZ, &ws) < 0)
2531 /* "Should never happen..." */
2532 clib_unix_warning ("TIOCGWINSZ");
2533 /* We can't trust ws.XXX... */
2536 cf->width = ws.ws_col;
2537 cf->height = ws.ws_row;
2539 /* Reindex the pager buffer */
2540 unix_cli_pager_reindex (cf);
2542 /* Redraw the page */
2543 unix_cli_pager_redraw (cf, uf);
2546 /** Handle configuration directives in the @em unix section. */
2547 static clib_error_t *
2548 unix_cli_config (vlib_main_t * vm, unformat_input_t * input)
2550 unix_main_t *um = &unix_main;
2551 unix_cli_main_t *cm = &unix_cli_main;
2553 clib_error_t *error = 0;
2554 unix_cli_file_t *cf;
2557 struct sigaction sa;
2561 /* We depend on unix flags being set. */
2562 if ((error = vlib_call_config_function (vm, unix_config)))
2565 if (um->flags & UNIX_FLAG_INTERACTIVE)
2567 /* Set stdin to be non-blocking. */
2568 if ((flags = fcntl (UNIX_CLI_STDIN_FD, F_GETFL, 0)) < 0)
2570 (void) fcntl (UNIX_CLI_STDIN_FD, F_SETFL, flags | O_NONBLOCK);
2572 cf_index = unix_cli_file_add (cm, "stdin", UNIX_CLI_STDIN_FD);
2573 cf = pool_elt_at_index (cm->cli_file_pool, cf_index);
2574 cm->stdin_cli_file_index = cf_index;
2576 /* If stdin is a tty and we are using chacracter mode, enable
2577 * history on the CLI and set the tty line discipline accordingly. */
2578 if (isatty (UNIX_CLI_STDIN_FD) && um->cli_line_mode == 0)
2580 /* Capture terminal resize events */
2581 memset (&sa, 0, sizeof (sa));
2582 sa.sa_handler = unix_cli_resize_interrupt;
2583 if (sigaction (SIGWINCH, &sa, 0) < 0)
2584 clib_panic ("sigaction");
2586 /* Retrieve the current terminal size */
2587 ioctl (UNIX_CLI_STDIN_FD, TIOCGWINSZ, &ws);
2588 cf->width = ws.ws_col;
2589 cf->height = ws.ws_row;
2591 if (cf->width == 0 || cf->height == 0)
2592 /* We have a tty, but no size. Stick to line mode. */
2595 /* Setup the history */
2596 cf->history_limit = um->cli_history_limit;
2597 cf->has_history = cf->history_limit != 0;
2599 /* Setup the pager */
2600 cf->no_pager = um->cli_no_pager;
2602 /* We're going to be in char by char mode */
2605 /* Save the original tty state so we can restore it later */
2606 tcgetattr (UNIX_CLI_STDIN_FD, &um->tio_stdin);
2609 /* Tweak the tty settings */
2610 tio = um->tio_stdin;
2611 /* echo off, canonical mode off, ext'd input processing off */
2612 tio.c_lflag &= ~(ECHO | ICANON | IEXTEN);
2613 tio.c_cc[VMIN] = 1; /* 1 byte at a time */
2614 tio.c_cc[VTIME] = 0; /* no timer */
2615 tcsetattr (UNIX_CLI_STDIN_FD, TCSAFLUSH, &tio);
2617 /* See if we can do ANSI/VT100 output */
2618 term = (u8 *) getenv ("TERM");
2620 cf->ansi_capable = unix_cli_terminal_type (term,
2627 /* No tty, so make sure these things are off */
2629 cf->history_limit = 0;
2630 cf->has_history = 0;
2634 /* Send banner and initial prompt */
2635 unix_cli_file_welcome (cm, cf);
2638 /* If we have socket config, LISTEN, otherwise, don't */
2639 clib_socket_t *s = &um->cli_listen_socket;
2640 if (s->config && s->config[0] != 0)
2643 unix_file_t template = { 0 };
2645 /* mkdir of file socketu, only under /run */
2646 if (strncmp (s->config, "/run", 4) == 0)
2648 u8 *tmp = format (0, "%s", s->config);
2649 int i = vec_len (tmp);
2650 while (i && tmp[--i] != '/')
2656 vlib_unix_recursive_mkdir ((char *) tmp);
2660 s->flags = SOCKET_IS_SERVER | /* listen, don't connect */
2661 SOCKET_ALLOW_GROUP_WRITE; /* PF_LOCAL socket only */
2662 error = clib_socket_init (s);
2667 template.read_function = unix_cli_listen_read_ready;
2668 template.file_descriptor = s->fd;
2670 unix_file_add (um, &template);
2673 /* Set CLI prompt. */
2674 if (!cm->cli_prompt)
2675 cm->cli_prompt = format (0, "VLIB: ");
2681 * This module has no configurable parameters.
2683 VLIB_CONFIG_FUNCTION (unix_cli_config, "unix-cli");
2685 /** Called when VPP is shutting down, this restores the system
2686 * terminal state if previously saved.
2688 static clib_error_t *
2689 unix_cli_exit (vlib_main_t * vm)
2691 unix_main_t *um = &unix_main;
2693 /* If stdin is a tty and we saved the tty state, reset the tty state */
2694 if (isatty (UNIX_CLI_STDIN_FD) && um->tio_isset)
2695 tcsetattr (UNIX_CLI_STDIN_FD, TCSAFLUSH, &um->tio_stdin);
2700 VLIB_MAIN_LOOP_EXIT_FUNCTION (unix_cli_exit);
2702 /** Set the CLI prompt.
2703 * @param prompt The C string to set the prompt to.
2704 * @note This setting is global; it impacts all current
2705 * and future CLI sessions.
2708 vlib_unix_cli_set_prompt (char *prompt)
2710 char *fmt = (prompt[strlen (prompt) - 1] == ' ') ? "%s" : "%s ";
2711 unix_cli_main_t *cm = &unix_cli_main;
2713 vec_free (cm->cli_prompt);
2714 cm->cli_prompt = format (0, fmt, prompt);
2717 /** CLI command to quit the terminal session.
2718 * @note If this is a stdin session then this will
2719 * shutdown VPP also.
2721 static clib_error_t *
2722 unix_cli_quit (vlib_main_t * vm,
2723 unformat_input_t * input, vlib_cli_command_t * cmd)
2725 unix_cli_main_t *cm = &unix_cli_main;
2727 vlib_process_signal_event (vm,
2728 vlib_current_process (vm),
2729 UNIX_CLI_PROCESS_EVENT_QUIT,
2730 cm->current_input_file_index);
2735 * Terminates the current CLI session.
2737 * If VPP is running in @em interactive mode and this is the console session
2738 * (that is, the session on @c stdin) then this will also terminate VPP.
2741 VLIB_CLI_COMMAND (unix_cli_quit_command, static) = {
2743 .short_help = "Exit CLI",
2744 .function = unix_cli_quit,
2748 /** CLI command to execute a VPP command script. */
2749 static clib_error_t *
2750 unix_cli_exec (vlib_main_t * vm,
2751 unformat_input_t * input, vlib_cli_command_t * cmd)
2755 unformat_input_t sub_input;
2756 clib_error_t *error;
2762 if (!unformat (input, "%s", &file_name))
2764 error = clib_error_return (0, "expecting file name, got `%U'",
2765 format_unformat_error, input);
2769 fd = open (file_name, O_RDONLY);
2772 error = clib_error_return_unix (0, "failed to open `%s'", file_name);
2776 /* Make sure its a regular file. */
2780 if (fstat (fd, &s) < 0)
2782 error = clib_error_return_unix (0, "failed to stat `%s'", file_name);
2786 if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
2788 error = clib_error_return (0, "not a regular file `%s'", file_name);
2793 unformat_init_unix_file (&sub_input, fd);
2795 vlib_cli_input (vm, &sub_input, 0, 0);
2796 unformat_free (&sub_input);
2801 vec_free (file_name);
2807 * Executes a sequence of CLI commands which are read from a file.
2809 * If a command is unrecognised or otherwise invalid then the usual CLI
2810 * feedback will be generated, however execution of subsequent commands
2811 * from the file will continue.
2814 VLIB_CLI_COMMAND (cli_exec, static) = {
2816 .short_help = "Execute commands from file",
2817 .function = unix_cli_exec,
2822 /** CLI command to show various unix error statistics. */
2823 static clib_error_t *
2824 unix_show_errors (vlib_main_t * vm,
2825 unformat_input_t * input, vlib_cli_command_t * cmd)
2827 unix_main_t *um = &unix_main;
2828 clib_error_t *error = 0;
2829 int i, n_errors_to_show;
2830 unix_error_history_t *unix_errors = 0;
2832 n_errors_to_show = 1 << 30;
2834 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2836 if (!unformat (input, "%d", &n_errors_to_show))
2839 clib_error_return (0,
2840 "expecting integer number of errors to show, got `%U'",
2841 format_unformat_error, input);
2847 clib_min (ARRAY_LEN (um->error_history), n_errors_to_show);
2850 um->error_history_index >
2851 0 ? um->error_history_index - 1 : ARRAY_LEN (um->error_history) - 1;
2853 while (n_errors_to_show > 0)
2855 unix_error_history_t *eh = um->error_history + i;
2860 vec_add1 (unix_errors, eh[0]);
2861 n_errors_to_show -= 1;
2863 i = ARRAY_LEN (um->error_history) - 1;
2868 if (vec_len (unix_errors) == 0)
2869 vlib_cli_output (vm, "no Unix errors so far");
2872 vlib_cli_output (vm, "%Ld total errors seen", um->n_total_errors);
2873 for (i = vec_len (unix_errors) - 1; i >= 0; i--)
2875 unix_error_history_t *eh = vec_elt_at_index (unix_errors, i);
2876 vlib_cli_output (vm, "%U: %U",
2877 format_time_interval, "h:m:s:u", eh->time,
2878 format_clib_error, eh->error);
2880 vlib_cli_output (vm, "%U: time now",
2881 format_time_interval, "h:m:s:u", vlib_time_now (vm));
2885 vec_free (unix_errors);
2890 VLIB_CLI_COMMAND (cli_unix_show_errors, static) = {
2891 .path = "show unix-errors",
2892 .short_help = "Show Unix system call error history",
2893 .function = unix_show_errors,
2897 /** CLI command to show session command history. */
2898 static clib_error_t *
2899 unix_cli_show_history (vlib_main_t * vm,
2900 unformat_input_t * input, vlib_cli_command_t * cmd)
2902 unix_cli_main_t *cm = &unix_cli_main;
2903 unix_cli_file_t *cf;
2906 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
2908 if (cf->has_history && cf->history_limit)
2910 i = 1 + cf->command_number - vec_len (cf->command_history);
2911 for (j = 0; j < vec_len (cf->command_history); j++)
2912 vlib_cli_output (vm, "%d %v\n", i + j, cf->command_history[j]);
2916 vlib_cli_output (vm, "History not enabled.\n");
2923 * Displays the command history for the current session, if any.
2926 VLIB_CLI_COMMAND (cli_unix_cli_show_history, static) = {
2928 .short_help = "Show current session command history",
2929 .function = unix_cli_show_history,
2933 /** CLI command to show terminal status. */
2934 static clib_error_t *
2935 unix_cli_show_terminal (vlib_main_t * vm,
2936 unformat_input_t * input, vlib_cli_command_t * cmd)
2938 unix_main_t *um = &unix_main;
2939 unix_cli_main_t *cm = &unix_cli_main;
2940 unix_cli_file_t *cf;
2943 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
2944 n = vlib_get_node (vm, cf->process_node_index);
2946 vlib_cli_output (vm, "Terminal name: %v\n", n->name);
2947 vlib_cli_output (vm, "Terminal mode: %s\n", cf->line_mode ?
2948 "line-by-line" : "char-by-char");
2949 vlib_cli_output (vm, "Terminal width: %d\n", cf->width);
2950 vlib_cli_output (vm, "Terminal height: %d\n", cf->height);
2951 vlib_cli_output (vm, "ANSI capable: %s\n",
2952 cf->ansi_capable ? "yes" : "no");
2953 vlib_cli_output (vm, "History enabled: %s%s\n",
2954 cf->has_history ? "yes" : "no", !cf->has_history
2955 || cf->history_limit ? "" :
2956 " (disabled by history limit)");
2957 if (cf->has_history)
2958 vlib_cli_output (vm, "History limit: %d\n", cf->history_limit);
2959 vlib_cli_output (vm, "Pager enabled: %s%s%s\n",
2960 cf->no_pager ? "no" : "yes",
2962 || cf->height ? "" : " (disabled by terminal height)",
2964 || um->cli_pager_buffer_limit ? "" :
2965 " (disabled by buffer limit)");
2967 vlib_cli_output (vm, "Pager limit: %d\n", um->cli_pager_buffer_limit);
2968 vlib_cli_output (vm, "CRLF mode: %s\n",
2969 cf->crlf_mode ? "CR+LF" : "LF");
2975 * Displays various information about the state of the current terminal
2979 * @cliexstart{show terminal}
2980 * Terminal name: unix-cli-stdin
2981 * Terminal mode: char-by-char
2982 * Terminal width: 123
2983 * Terminal height: 48
2985 * History enabled: yes
2987 * Pager enabled: yes
2988 * Pager limit: 100000
2993 VLIB_CLI_COMMAND (cli_unix_cli_show_terminal, static) = {
2994 .path = "show terminal",
2995 .short_help = "Show current session terminal settings",
2996 .function = unix_cli_show_terminal,
3000 /** CLI command to set terminal pager settings. */
3001 static clib_error_t *
3002 unix_cli_set_terminal_pager (vlib_main_t * vm,
3003 unformat_input_t * input,
3004 vlib_cli_command_t * cmd)
3006 unix_main_t *um = &unix_main;
3007 unix_cli_main_t *cm = &unix_cli_main;
3008 unix_cli_file_t *cf;
3009 unformat_input_t _line_input, *line_input = &_line_input;
3010 clib_error_t *error = 0;
3012 if (!unformat_user (input, unformat_line_input, line_input))
3015 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3017 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3019 if (unformat (line_input, "on"))
3021 else if (unformat (line_input, "off"))
3023 else if (unformat (line_input, "limit %u", &um->cli_pager_buffer_limit))
3024 vlib_cli_output (vm,
3025 "Pager limit set to %u lines; note, this is global.\n",
3026 um->cli_pager_buffer_limit);
3029 error = clib_error_return (0, "unknown parameter: `%U`",
3030 format_unformat_error, line_input);
3036 unformat_free (line_input);
3042 * Enables or disables the terminal pager for this session. Generally
3043 * this defaults to enabled.
3045 * Additionally allows the pager buffer size to be set; though note that
3046 * this value is set globally and not per session.
3049 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager, static) = {
3050 .path = "set terminal pager",
3051 .short_help = "set terminal pager [on|off] [limit <lines>]",
3052 .function = unix_cli_set_terminal_pager,
3056 /** CLI command to set terminal history settings. */
3057 static clib_error_t *
3058 unix_cli_set_terminal_history (vlib_main_t * vm,
3059 unformat_input_t * input,
3060 vlib_cli_command_t * cmd)
3062 unix_cli_main_t *cm = &unix_cli_main;
3063 unix_cli_file_t *cf;
3064 unformat_input_t _line_input, *line_input = &_line_input;
3066 clib_error_t *error = 0;
3068 if (!unformat_user (input, unformat_line_input, line_input))
3071 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3073 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
3075 if (unformat (line_input, "on"))
3076 cf->has_history = 1;
3077 else if (unformat (line_input, "off"))
3078 cf->has_history = 0;
3079 else if (unformat (line_input, "limit %u", &cf->history_limit))
3083 error = clib_error_return (0, "unknown parameter: `%U`",
3084 format_unformat_error, line_input);
3088 /* If we reduced history size, or turned it off, purge the history */
3089 limit = cf->has_history ? cf->history_limit : 0;
3091 while (cf->command_history && vec_len (cf->command_history) >= limit)
3093 vec_free (cf->command_history[0]);
3094 vec_delete (cf->command_history, 1, 0);
3099 unformat_free (line_input);
3105 * Enables or disables the command history function of the current
3106 * terminal. Generally this defaults to enabled.
3108 * This command also allows the maximum size of the history buffer for
3109 * this session to be altered.
3112 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history, static) = {
3113 .path = "set terminal history",
3114 .short_help = "set terminal history [on|off] [limit <lines>]",
3115 .function = unix_cli_set_terminal_history,
3119 /** CLI command to set terminal ANSI settings. */
3120 static clib_error_t *
3121 unix_cli_set_terminal_ansi (vlib_main_t * vm,
3122 unformat_input_t * input,
3123 vlib_cli_command_t * cmd)
3125 unix_cli_main_t *cm = &unix_cli_main;
3126 unix_cli_file_t *cf;
3128 cf = pool_elt_at_index (cm->cli_file_pool, cm->current_input_file_index);
3130 if (unformat (input, "on"))
3131 cf->ansi_capable = 1;
3132 else if (unformat (input, "off"))
3133 cf->ansi_capable = 0;
3135 return clib_error_return (0, "unknown parameter: `%U`",
3136 format_unformat_error, input);
3142 * Enables or disables the use of ANSI control sequences by this terminal.
3143 * The default will vary based on terminal detection at the start of the
3146 * ANSI control sequences are used in a small number of places to provide,
3147 * for example, color text output and to control the cursor in the pager.
3150 VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi, static) = {
3151 .path = "set terminal ansi",
3152 .short_help = "set terminal ansi [on|off]",
3153 .function = unix_cli_set_terminal_ansi,
3157 static clib_error_t *
3158 unix_cli_init (vlib_main_t * vm)
3163 VLIB_INIT_FUNCTION (unix_cli_init);
3166 * fd.io coding-style-patch-verification: ON
3169 * eval: (c-set-style "gnu")