FD.io VPP  v17.01.1-3-gc6833f8
Vector Packet Processing
cli.c File Reference

Unix stdin/socket command line interface. More...

+ Include dependency graph for cli.c:

Go to the source code of this file.

Data Structures

struct  unix_cli_banner_t
 A CLI banner line. More...
 
struct  unix_cli_pager_index_t
 Pager line index. More...
 
struct  unix_cli_file_t
 Unix CLI session. More...
 
struct  unix_cli_parse_actions_t
 Mapping of input buffer strings to action values. More...
 
struct  unix_cli_main_t
 CLI global state. More...
 

Macros

#define ESC   "\x1b"
 ANSI escape code. More...
 
#define CSI   ESC "["
 ANSI Control Sequence Introducer. More...
 
#define ANSI_CLEAR   CSI "2J" CSI "1;1H"
 ANSI clear screen. More...
 
#define ANSI_RESET   CSI "0m"
 ANSI reset color settings. More...
 
#define ANSI_BOLD   CSI "1m"
 ANSI Start bold text. More...
 
#define ANSI_DIM   CSI "2m"
 ANSI Stop bold text. More...
 
#define ANSI_DRED   ANSI_DIM CSI "31m"
 ANSI Start dark red text. More...
 
#define ANSI_BRED   ANSI_BOLD CSI "31m"
 ANSI Start bright red text. More...
 
#define ANSI_CLEARLINE   CSI "2K"
 ANSI clear line cursor is on. More...
 
#define ANSI_SCROLLDN   CSI "1T"
 ANSI scroll screen down one line. More...
 
#define ANSI_SAVECURSOR   CSI "s"
 ANSI save cursor position. More...
 
#define ANSI_RESTCURSOR   CSI "u"
 ANSI restore cursor position if previously saved. More...
 
#define UNIX_CLI_MAX_DEPTH_TELNET   24
 Maximum depth into a byte stream from which to compile a Telnet protocol message. More...
 
#define UNIX_CLI_STDIN_FD   0
 Unix standard in. More...
 
#define CTL(c)   (u8[]){ (c) - '@', 0 }
 Given a capital ASCII letter character return a NUL terminated string with the control code for that letter. More...
 

Enumerations

enum  unix_cli_parse_action_t {
  UNIX_CLI_PARSE_ACTION_NOACTION = 0, UNIX_CLI_PARSE_ACTION_CRLF, UNIX_CLI_PARSE_ACTION_TAB, UNIX_CLI_PARSE_ACTION_ERASE,
  UNIX_CLI_PARSE_ACTION_ERASERIGHT, UNIX_CLI_PARSE_ACTION_UP, UNIX_CLI_PARSE_ACTION_DOWN, UNIX_CLI_PARSE_ACTION_LEFT,
  UNIX_CLI_PARSE_ACTION_RIGHT, UNIX_CLI_PARSE_ACTION_HOME, UNIX_CLI_PARSE_ACTION_END, UNIX_CLI_PARSE_ACTION_WORDLEFT,
  UNIX_CLI_PARSE_ACTION_WORDRIGHT, UNIX_CLI_PARSE_ACTION_ERASELINELEFT, UNIX_CLI_PARSE_ACTION_ERASELINERIGHT, UNIX_CLI_PARSE_ACTION_CLEAR,
  UNIX_CLI_PARSE_ACTION_REVSEARCH, UNIX_CLI_PARSE_ACTION_FWDSEARCH, UNIX_CLI_PARSE_ACTION_YANK, UNIX_CLI_PARSE_ACTION_TELNETIAC,
  UNIX_CLI_PARSE_ACTION_PAGER_CRLF, UNIX_CLI_PARSE_ACTION_PAGER_QUIT, UNIX_CLI_PARSE_ACTION_PAGER_NEXT, UNIX_CLI_PARSE_ACTION_PAGER_DN,
  UNIX_CLI_PARSE_ACTION_PAGER_UP, UNIX_CLI_PARSE_ACTION_PAGER_TOP, UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM, UNIX_CLI_PARSE_ACTION_PAGER_PGDN,
  UNIX_CLI_PARSE_ACTION_PAGER_PGUP, UNIX_CLI_PARSE_ACTION_PAGER_REDRAW, UNIX_CLI_PARSE_ACTION_PAGER_SEARCH, UNIX_CLI_PARSE_ACTION_PARTIALMATCH,
  UNIX_CLI_PARSE_ACTION_NOMATCH
}
 CLI actions. More...
 
enum  unix_cli_process_event_type_t { UNIX_CLI_PROCESS_EVENT_READ_READY, UNIX_CLI_PROCESS_EVENT_QUIT }
 CLI session events. More...
 

Functions

static void unix_cli_pager_reset (unix_cli_file_t *f)
 Resets the pager buffer and other data. More...
 
static void unix_cli_file_free (unix_cli_file_t *f)
 Release storage used by a CLI session. More...
 
static unix_cli_parse_action_t unix_cli_match_action (unix_cli_parse_actions_t *a, u8 *input, u32 ilen, i32 *matched)
 Search for a byte sequence in the action list. More...
 
static void unix_cli_add_pending_output (unix_file_t *uf, unix_cli_file_t *cf, u8 *buffer, uword buffer_bytes)
 Add bytes to the output vector and then flagg the I/O system that bytes are available to be sent. More...
 
static void unix_cli_del_pending_output (unix_file_t *uf, unix_cli_file_t *cf, uword n_bytes)
 Delete all bytes from the output vector and flag the I/O system that no more bytes are available to be sent. More...
 
static word unix_vlib_findchr (u8 chr, u8 *str, word len)
 A bit like strchr with a buffer length limit. More...
 
static void unix_vlib_cli_output_raw (unix_cli_file_t *cf, unix_file_t *uf, u8 *buffer, uword buffer_bytes)
 Send a buffer to the CLI stream if possible, enqueue it otherwise. More...
 
static void unix_vlib_cli_output_cooked (unix_cli_file_t *cf, unix_file_t *uf, u8 *buffer, uword buffer_bytes)
 Process a buffer for CRLF handling before outputting it to the CLI. More...
 
static void unix_cli_cli_prompt (unix_cli_file_t *cf, unix_file_t *uf)
 Output the CLI prompt. More...
 
static void unix_cli_pager_prompt (unix_cli_file_t *cf, unix_file_t *uf)
 Output a pager prompt and show number of buffered lines. More...
 
static void unix_cli_pager_message (unix_cli_file_t *cf, unix_file_t *uf, char *message, char *postfix)
 Output a pager "skipping" message. More...
 
static void unix_cli_pager_prompt_erase (unix_cli_file_t *cf, unix_file_t *uf)
 Erase the printed pager prompt. More...
 
static void unix_cli_ansi_cursor (unix_cli_file_t *cf, unix_file_t *uf, u16 x, u16 y)
 Uses an ANSI escape sequence to move the cursor. More...
 
static void unix_cli_pager_redraw (unix_cli_file_t *cf, unix_file_t *uf)
 Redraw the currently displayed page of text. More...
 
static void unix_cli_pager_add_line (unix_cli_file_t *cf, u8 *line, word len_or_index)
 Process and add a line to the pager index. More...
 
static void unix_cli_pager_reindex (unix_cli_file_t *cf)
 Reindex entire pager buffer. More...
 
static void unix_vlib_cli_output (uword cli_file_index, u8 *buffer, uword buffer_bytes)
 VLIB CLI output function. More...
 
static u8 unix_cli_terminal_type (u8 *term, uword len)
 Identify whether a terminal type is ANSI capable. More...
 
static void unix_cli_file_welcome (unix_cli_main_t *cm, unix_cli_file_t *cf)
 Emit initial welcome banner and prompt on a connection. More...
 
static void unix_cli_file_welcome_timer (any arg, f64 delay)
 A failsafe triggered on a timer to ensure we send the prompt to telnet sessions that fail to negotiate the terminal type. More...
 
static i32 unix_cli_process_telnet (unix_main_t *um, unix_cli_file_t *cf, unix_file_t *uf, u8 *input_vector, uword len)
 A mostly no-op Telnet state machine. More...
 
static int unix_cli_line_process_one (unix_cli_main_t *cm, unix_main_t *um, unix_cli_file_t *cf, unix_file_t *uf, u8 input, unix_cli_parse_action_t action)
 Process actionable input. More...
 
static int unix_cli_line_edit (unix_cli_main_t *cm, unix_main_t *um, unix_cli_file_t *cf)
 Process input bytes on a stream to provide line editing and command history in the CLI. More...
 
static void unix_cli_process_input (unix_cli_main_t *cm, uword cli_file_index)
 Process input to a CLI session. More...
 
static void unix_cli_kill (unix_cli_main_t *cm, uword cli_file_index)
 Destroy a CLI session. More...
 
static uword unix_cli_process (vlib_main_t *vm, vlib_node_runtime_t *rt, vlib_frame_t *f)
 Handle system events. More...
 
static clib_error_tunix_cli_write_ready (unix_file_t *uf)
 Called when a CLI session file descriptor can be written to without blocking. More...
 
static clib_error_tunix_cli_read_ready (unix_file_t *uf)
 Called when a CLI session file descriptor has data to be read. More...
 
static u32 unix_cli_file_add (unix_cli_main_t *cm, char *name, int fd)
 Store a new CLI session. More...
 
static clib_error_tunix_cli_listen_read_ready (unix_file_t *uf)
 Telnet listening socket has a new connection. More...
 
static void unix_cli_resize_interrupt (int signum)
 The system terminal has informed us that the window size has changed. More...
 
static clib_error_tunix_cli_config (vlib_main_t *vm, unformat_input_t *input)
 Handle configuration directives in the unix section. More...
 
static clib_error_tunix_cli_exit (vlib_main_t *vm)
 Called when VPP is shutting down, this restores the system terminal state if previously saved. More...
 
void vlib_unix_cli_set_prompt (char *prompt)
 Set the CLI prompt. More...
 
static clib_error_tunix_cli_quit (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 CLI command to quit the terminal session. More...
 
static clib_error_tunix_cli_exec (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 CLI command to execute a VPP command script. More...
 
static clib_error_tunix_show_errors (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 CLI command to show various unix error statistics. More...
 
static clib_error_tunix_cli_show_history (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 CLI command to show session command history. More...
 
static clib_error_tunix_cli_show_terminal (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 CLI command to show terminal status. More...
 
static clib_error_tunix_cli_set_terminal_pager (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 CLI command to set terminal pager settings. More...
 
static clib_error_tunix_cli_set_terminal_history (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 CLI command to set terminal history settings. More...
 
static clib_error_tunix_cli_set_terminal_ansi (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 CLI command to set terminal ANSI settings. More...
 
static clib_error_tunix_cli_init (vlib_main_t *vm)
 

Variables

static unix_cli_banner_t unix_cli_banner []
 Plain welcome banner. More...
 
static unix_cli_banner_t unix_cli_banner_color []
 ANSI color welcome banner. More...
 
static unix_cli_parse_actions_t unix_cli_parse_strings []
 Patterns to match on a CLI input stream. More...
 
static unix_cli_parse_actions_t unix_cli_parse_pager []
 Patterns to match when a CLI session is in the pager. More...
 
static unix_cli_main_t unix_cli_main
 CLI global state. More...
 
static vlib_cli_command_t unix_cli_quit_command
 (constructor) VLIB_CLI_COMMAND (unix_cli_quit_command) More...
 
static vlib_cli_command_t cli_exec
 (constructor) VLIB_CLI_COMMAND (cli_exec) More...
 
static vlib_cli_command_t cli_unix_show_errors
 (constructor) VLIB_CLI_COMMAND (cli_unix_show_errors) More...
 
static vlib_cli_command_t cli_unix_cli_show_history
 (constructor) VLIB_CLI_COMMAND (cli_unix_cli_show_history) More...
 
static vlib_cli_command_t cli_unix_cli_show_terminal
 (constructor) VLIB_CLI_COMMAND (cli_unix_cli_show_terminal) More...
 
static vlib_cli_command_t cli_unix_cli_set_terminal_pager
 (constructor) VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager) More...
 
static vlib_cli_command_t cli_unix_cli_set_terminal_history
 (constructor) VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history) More...
 
static vlib_cli_command_t cli_unix_cli_set_terminal_ansi
 (constructor) VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi) More...
 

Detailed Description

Unix stdin/socket command line interface.

Provides a command line interface so humans can interact with VPP. This is predominantly a debugging and testing mechanism.

Definition in file cli.c.

Macro Definition Documentation

#define ANSI_BOLD   CSI "1m"

ANSI Start bold text.

Definition at line 72 of file cli.c.

#define ANSI_BRED   ANSI_BOLD CSI "31m"

ANSI Start bright red text.

Definition at line 78 of file cli.c.

#define ANSI_CLEAR   CSI "2J" CSI "1;1H"

ANSI clear screen.

Definition at line 68 of file cli.c.

#define ANSI_CLEARLINE   CSI "2K"

ANSI clear line cursor is on.

Definition at line 80 of file cli.c.

#define ANSI_DIM   CSI "2m"

ANSI Stop bold text.

Definition at line 74 of file cli.c.

#define ANSI_DRED   ANSI_DIM CSI "31m"

ANSI Start dark red text.

Definition at line 76 of file cli.c.

#define ANSI_RESET   CSI "0m"

ANSI reset color settings.

Definition at line 70 of file cli.c.

#define ANSI_RESTCURSOR   CSI "u"

ANSI restore cursor position if previously saved.

Definition at line 86 of file cli.c.

#define ANSI_SAVECURSOR   CSI "s"

ANSI save cursor position.

Definition at line 84 of file cli.c.

#define ANSI_SCROLLDN   CSI "1T"

ANSI scroll screen down one line.

Definition at line 82 of file cli.c.

#define CSI   ESC "["

ANSI Control Sequence Introducer.

Definition at line 65 of file cli.c.

#define CTL (   c)    (u8[]){ (c) - '@', 0 }

Given a capital ASCII letter character return a NUL terminated string with the control code for that letter.

Parameters
cAn ASCII character.
Returns
A NUL terminated string of type u8[].
Example
CTL('A') returns { 0x01, 0x00 } as a u8[].

Definition at line 303 of file cli.c.

#define ESC   "\x1b"

ANSI escape code.

Definition at line 62 of file cli.c.

#define UNIX_CLI_MAX_DEPTH_TELNET   24

Maximum depth into a byte stream from which to compile a Telnet protocol message.

This is a saftey measure.

Definition at line 90 of file cli.c.

#define UNIX_CLI_STDIN_FD   0

Unix standard in.

Definition at line 93 of file cli.c.

Enumeration Type Documentation

CLI actions.

Enumerator
UNIX_CLI_PARSE_ACTION_NOACTION 

No action.

UNIX_CLI_PARSE_ACTION_CRLF 

Carriage return, newline or enter.

UNIX_CLI_PARSE_ACTION_TAB 

Tab key.

UNIX_CLI_PARSE_ACTION_ERASE 

Erase cursor left.

UNIX_CLI_PARSE_ACTION_ERASERIGHT 

Erase cursor right.

UNIX_CLI_PARSE_ACTION_UP 

Up arrow.

UNIX_CLI_PARSE_ACTION_DOWN 

Down arrow.

UNIX_CLI_PARSE_ACTION_LEFT 

Left arrow.

UNIX_CLI_PARSE_ACTION_RIGHT 

Right arrow.

UNIX_CLI_PARSE_ACTION_HOME 

Home key (jump to start of line)

UNIX_CLI_PARSE_ACTION_END 

End key (jump to end of line)

UNIX_CLI_PARSE_ACTION_WORDLEFT 

Jump cursor to start of left word.

UNIX_CLI_PARSE_ACTION_WORDRIGHT 

Jump cursor to start of right word.

UNIX_CLI_PARSE_ACTION_ERASELINELEFT 

Erase line to left of cursor.

UNIX_CLI_PARSE_ACTION_ERASELINERIGHT 

Erase line to right & including cursor.

UNIX_CLI_PARSE_ACTION_CLEAR 

Clear the terminal.

UNIX_CLI_PARSE_ACTION_REVSEARCH 

Search backwards in command history.

UNIX_CLI_PARSE_ACTION_FWDSEARCH 

Search forwards in command history.

UNIX_CLI_PARSE_ACTION_YANK 

Undo last erase action.

UNIX_CLI_PARSE_ACTION_TELNETIAC 

Telnet control code.

UNIX_CLI_PARSE_ACTION_PAGER_CRLF 

Enter pressed (CR, CRLF, LF, etc)

UNIX_CLI_PARSE_ACTION_PAGER_QUIT 

Exit the pager session.

UNIX_CLI_PARSE_ACTION_PAGER_NEXT 

Scroll to next page.

UNIX_CLI_PARSE_ACTION_PAGER_DN 

Scroll to next line.

UNIX_CLI_PARSE_ACTION_PAGER_UP 

Scroll to previous line.

UNIX_CLI_PARSE_ACTION_PAGER_TOP 

Scroll to first line.

UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM 

Scroll to last line.

UNIX_CLI_PARSE_ACTION_PAGER_PGDN 

Scroll to next page.

UNIX_CLI_PARSE_ACTION_PAGER_PGUP 

Scroll to previous page.

UNIX_CLI_PARSE_ACTION_PAGER_REDRAW 

Clear and redraw the page on the terminal.

UNIX_CLI_PARSE_ACTION_PAGER_SEARCH 

Search the pager buffer.

UNIX_CLI_PARSE_ACTION_PARTIALMATCH 

Action parser found a partial match.

UNIX_CLI_PARSE_ACTION_NOMATCH 

Action parser did not find any match.

Definition at line 244 of file cli.c.

CLI session events.

Enumerator
UNIX_CLI_PROCESS_EVENT_READ_READY 

A file descriptor has data to be read.

UNIX_CLI_PROCESS_EVENT_QUIT 

A CLI session wants to close.

Definition at line 413 of file cli.c.

Function Documentation

static void unix_cli_add_pending_output ( unix_file_t uf,
unix_cli_file_t cf,
u8 buffer,
uword  buffer_bytes 
)
static

Add bytes to the output vector and then flagg the I/O system that bytes are available to be sent.

Definition at line 503 of file cli.c.

+ Here is the caller graph for this function:

static void unix_cli_ansi_cursor ( unix_cli_file_t cf,
unix_file_t uf,
u16  x,
u16  y 
)
static

Uses an ANSI escape sequence to move the cursor.

Definition at line 717 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_cli_cli_prompt ( unix_cli_file_t cf,
unix_file_t uf 
)
static

Output the CLI prompt.

Definition at line 647 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* unix_cli_config ( vlib_main_t vm,
unformat_input_t input 
)
static

Handle configuration directives in the unix section.

Definition at line 2392 of file cli.c.

+ Here is the call graph for this function:

static void unix_cli_del_pending_output ( unix_file_t uf,
unix_cli_file_t cf,
uword  n_bytes 
)
static

Delete all bytes from the output vector and flag the I/O system that no more bytes are available to be sent.

Definition at line 523 of file cli.c.

+ Here is the caller graph for this function:

static clib_error_t* unix_cli_exec ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cmd 
)
static

CLI command to execute a VPP command script.

Definition at line 2578 of file cli.c.

+ Here is the call graph for this function:

static clib_error_t* unix_cli_exit ( vlib_main_t vm)
static

Called when VPP is shutting down, this restores the system terminal state if previously saved.

Definition at line 2517 of file cli.c.

static u32 unix_cli_file_add ( unix_cli_main_t cm,
char *  name,
int  fd 
)
static

Store a new CLI session.

Parameters
nameThe name of the session.
fdThe file descriptor for the session I/O.
Returns
The session ID.

Definition at line 2224 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_cli_file_free ( unix_cli_file_t f)
inlinestatic

Release storage used by a CLI session.

Parameters
fThe CLI session whose storage needs to be released.

Definition at line 236 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_cli_file_welcome ( unix_cli_main_t cm,
unix_cli_file_t cf 
)
static

Emit initial welcome banner and prompt on a connection.

Definition at line 1034 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_cli_file_welcome_timer ( any  arg,
f64  delay 
)
static

A failsafe triggered on a timer to ensure we send the prompt to telnet sessions that fail to negotiate the terminal type.

Definition at line 1077 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* unix_cli_init ( vlib_main_t vm)
static

Definition at line 2976 of file cli.c.

static void unix_cli_kill ( unix_cli_main_t cm,
uword  cli_file_index 
)
static

Destroy a CLI session.

Note
If we destroy the stdin session this additionally signals the shutdown of VPP.

Definition at line 2084 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static int unix_cli_line_edit ( unix_cli_main_t cm,
unix_main_t um,
unix_cli_file_t cf 
)
static

Process input bytes on a stream to provide line editing and command history in the CLI.

Definition at line 1906 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static int unix_cli_line_process_one ( unix_cli_main_t cm,
unix_main_t um,
unix_cli_file_t cf,
unix_file_t uf,
u8  input,
unix_cli_parse_action_t  action 
)
static

Process actionable input.

Based on the action process the input; this typically involves searching the command history or editing the current command line.

Definition at line 1226 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* unix_cli_listen_read_ready ( unix_file_t uf)
static

Telnet listening socket has a new connection.

Definition at line 2286 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static unix_cli_parse_action_t unix_cli_match_action ( unix_cli_parse_actions_t a,
u8 input,
u32  ilen,
i32 matched 
)
static

Search for a byte sequence in the action list.

Searches the unix_cli_parse_actions_t list in a for a match with the bytes in input of maximum length ilen bytes. When a match is made *matched indicates how many bytes were matched. Returns a value from the enum unix_cli_parse_action_t to indicate whether no match was found, a partial match was found or a complete match was found and what action, if any, should be taken.

Parameters
[in]aActions list to search within.
[in]inputString fragment to search for.
[in]ilenLength of the string in 'input'.
[out]matchedPointer to an integer that will contain the number of bytes matched when a complete match is found.
Returns
Action from unix_cli_parse_action_t that the string fragment matches. UNIX_CLI_PARSE_ACTION_PARTIALMATCH is returned when the whole input string matches the start of at least one action. UNIX_CLI_PARSE_ACTION_NOMATCH is returned when there is no match at all.

Definition at line 465 of file cli.c.

+ Here is the caller graph for this function:

static void unix_cli_pager_add_line ( unix_cli_file_t cf,
u8 line,
word  len_or_index 
)
static

Process and add a line to the pager index.

In normal operation this function will take the given character string found in line and with length len_or_index and iterates the over the contents, adding each line of text discovered within it to the pager index. Lines are identified by newlines ("<code>\\n</code>") and by strings longer than the width of the terminal.

If instead line is NULL then len_or_index is taken to mean the index of an existing line in the pager buffer; this simply means that the input line does not need to be cloned since we alreayd have it. This is typical if we are reindexing the pager buffer.

Parameters
cfThe CLI session whose pager we are adding to.
lineThe string of text to be indexed into the pager buffer. If line is NULL then the mode of operation changes slightly; see the description above.
len_or_indexIf line is a pointer to a string then this parameter indicates the length of that string; Otherwise this value provides the index in the pager buffer of an existing string to be indexed.

Definition at line 794 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_cli_pager_message ( unix_cli_file_t cf,
unix_file_t uf,
char *  message,
char *  postfix 
)
static

Output a pager "skipping" message.

Definition at line 679 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_cli_pager_prompt ( unix_cli_file_t cf,
unix_file_t uf 
)
static

Output a pager prompt and show number of buffered lines.

Definition at line 656 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_cli_pager_prompt_erase ( unix_cli_file_t cf,
unix_file_t uf 
)
static

Erase the printed pager prompt.

Definition at line 695 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_cli_pager_redraw ( unix_cli_file_t cf,
unix_file_t uf 
)
static

Redraw the currently displayed page of text.

Parameters
cfCLI session to redraw the pager buffer of.
ufUnix file of the CLI session.

Definition at line 733 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_cli_pager_reindex ( unix_cli_file_t cf)
static

Reindex entire pager buffer.

Resets the current pager index and then re-adds the lines in the pager buffer to the index.

Additionally this function attempts to retain the current page start line offset by searching for the same top-of-screen line in the new index.

Parameters
cfThe CLI session whose pager buffer should be reindexed.

Definition at line 855 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_cli_pager_reset ( unix_cli_file_t f)
inlinestatic

Resets the pager buffer and other data.

Parameters
fThe CLI session whose pager needs to be reset.

Definition at line 215 of file cli.c.

+ Here is the caller graph for this function:

static uword unix_cli_process ( vlib_main_t vm,
vlib_node_runtime_t rt,
vlib_frame_t f 
)
static

Handle system events.

Definition at line 2114 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_cli_process_input ( unix_cli_main_t cm,
uword  cli_file_index 
)
static

Process input to a CLI session.

Definition at line 1983 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static i32 unix_cli_process_telnet ( unix_main_t um,
unix_cli_file_t cf,
unix_file_t uf,
u8 input_vector,
uword  len 
)
static

A mostly no-op Telnet state machine.

Process Telnet command bytes in a way that ensures we're mostly transparent to the Telnet protocol. That is, it's mostly a no-op.

Returns
-1 if we need more bytes, otherwise a positive integer number of bytes to consume from the input_vector, not including the initial IAC byte.

Definition at line 1102 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* unix_cli_quit ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cmd 
)
static

CLI command to quit the terminal session.

Note
If this is a stdin session then this will shutdown VPP also.

Definition at line 2550 of file cli.c.

+ Here is the call graph for this function:

static clib_error_t* unix_cli_read_ready ( unix_file_t uf)
static

Called when a CLI session file descriptor has data to be read.

Definition at line 2181 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_cli_resize_interrupt ( int  signum)
static

The system terminal has informed us that the window size has changed.

Definition at line 2362 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* unix_cli_set_terminal_ansi ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cmd 
)
static

CLI command to set terminal ANSI settings.

Definition at line 2939 of file cli.c.

+ Here is the call graph for this function:

static clib_error_t* unix_cli_set_terminal_history ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cmd 
)
static

CLI command to set terminal history settings.

Definition at line 2881 of file cli.c.

+ Here is the call graph for this function:

static clib_error_t* unix_cli_set_terminal_pager ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cmd 
)
static

CLI command to set terminal pager settings.

Definition at line 2830 of file cli.c.

+ Here is the call graph for this function:

static clib_error_t* unix_cli_show_history ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cmd 
)
static

CLI command to show session command history.

Definition at line 2727 of file cli.c.

+ Here is the call graph for this function:

static clib_error_t* unix_cli_show_terminal ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cmd 
)
static

CLI command to show terminal status.

Definition at line 2763 of file cli.c.

+ Here is the call graph for this function:

static u8 unix_cli_terminal_type ( u8 term,
uword  len 
)
static

Identify whether a terminal type is ANSI capable.

Compares the string given in term with a list of terminal types known to support ANSI escape sequences.

This list contains, for example, xterm, screen and ansi.

Parameters
termA string with a terminal type in it.
lenThe length of the string in term.
Returns
1 if the terminal type is recognized as supporting ANSI terminal sequences; 0 otherwise.

Definition at line 1015 of file cli.c.

+ Here is the caller graph for this function:

static clib_error_t* unix_cli_write_ready ( unix_file_t uf)
static

Called when a CLI session file descriptor can be written to without blocking.

Definition at line 2158 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* unix_show_errors ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cmd 
)
static

CLI command to show various unix error statistics.

Definition at line 2652 of file cli.c.

+ Here is the call graph for this function:

static void unix_vlib_cli_output ( uword  cli_file_index,
u8 buffer,
uword  buffer_bytes 
)
static

VLIB CLI output function.

If the terminal has a pager configured then this function takes care of collating output into the pager buffer; ensuring only the first page is displayed and any lines in excess of the first page are buffered.

If the maximum number of index lines in the buffer is exceeded then the pager is cancelled and the contents of the current buffer are sent to the terminal.

If there is no pager configured then the output is sent directly to the terminal.

Parameters
cli_file_indexIndex of the CLI session where this output is directed.
bufferString of printabe bytes to be output.
buffer_bytesThe number of bytes in buffer to be output.

Definition at line 928 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_vlib_cli_output_cooked ( unix_cli_file_t cf,
unix_file_t uf,
u8 buffer,
uword  buffer_bytes 
)
static

Process a buffer for CRLF handling before outputting it to the CLI.

Parameters
cfUnix CLI session of the desired stream to write to.
ufThe Unix file structure of the desired stream to write to.
bufferPointer to the buffer that needs to be written.
buffer_bytesThe number of bytes from buffer to write.

Definition at line 610 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void unix_vlib_cli_output_raw ( unix_cli_file_t cf,
unix_file_t uf,
u8 buffer,
uword  buffer_bytes 
)
static

Send a buffer to the CLI stream if possible, enqueue it otherwise.

Attempts to write given buffer to the file descriptor of the given Unix CLI session. If that session already has data in the output buffer or if the write attempt tells us to try again later then the given buffer is appended to the pending output buffer instead.

This is typically called only from unix_vlib_cli_output_cooked since that is where CRLF handling occurs or from places where we explicitly do not want cooked handling.

Parameters
cfUnix CLI session of the desired stream to write to.
ufThe Unix file structure of the desired stream to write to.
bufferPointer to the buffer that needs to be written.
buffer_bytesThe number of bytes from buffer to write.

Definition at line 580 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static word unix_vlib_findchr ( u8  chr,
u8 str,
word  len 
)
inlinestatic

A bit like strchr with a buffer length limit.

Search a buffer for the first instance of a character up to the limit of the buffer length. If found then return the position of that character.

The key departure from strchr is that if the character is not found then return the buffer length.

Parameters
chrThe byte value to search for.
strThe buffer in which to search for the value.
lenThe depth into the buffer to search.
Returns
The index of the first occurence of chr. If chr is not found then len instead.

Definition at line 553 of file cli.c.

+ Here is the caller graph for this function:

void vlib_unix_cli_set_prompt ( char *  prompt)

Set the CLI prompt.

Parameters
promptThe C string to set the prompt to.
Note
This setting is global; it impacts all current and future CLI sessions.

Definition at line 2536 of file cli.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Variable Documentation

vlib_cli_command_t cli_exec
static
Initial value:
= {
.path = "exec",
.short_help = "Execute commands from file",
.function = unix_cli_exec,
.is_mp_safe = 1,
}
static clib_error_t * unix_cli_exec(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
CLI command to execute a VPP command script.
Definition: cli.c:2578

(constructor) VLIB_CLI_COMMAND (cli_exec)

Definition at line 2642 of file cli.c.

vlib_cli_command_t cli_unix_cli_set_terminal_ansi
static
Initial value:
= {
.path = "set terminal ansi",
.short_help = "set terminal ansi [on|off]",
}
static clib_error_t * unix_cli_set_terminal_ansi(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
CLI command to set terminal ANSI settings.
Definition: cli.c:2939

(constructor) VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi)

Definition at line 2968 of file cli.c.

vlib_cli_command_t cli_unix_cli_set_terminal_history
static
Initial value:
= {
.path = "set terminal history",
.short_help = "set terminal history [on|off] [limit <lines>]",
}
static clib_error_t * unix_cli_set_terminal_history(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
CLI command to set terminal history settings.
Definition: cli.c:2881

(constructor) VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history)

Definition at line 2930 of file cli.c.

vlib_cli_command_t cli_unix_cli_set_terminal_pager
static
Initial value:
= {
.path = "set terminal pager",
.short_help = "set terminal pager [on|off] [limit <lines>]",
}
static clib_error_t * unix_cli_set_terminal_pager(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
CLI command to set terminal pager settings.
Definition: cli.c:2830

(constructor) VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager)

Definition at line 2872 of file cli.c.

vlib_cli_command_t cli_unix_cli_show_history
static
Initial value:
= {
.path = "history",
.short_help = "Show current session command history",
.function = unix_cli_show_history,
}
static clib_error_t * unix_cli_show_history(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
CLI command to show session command history.
Definition: cli.c:2727

(constructor) VLIB_CLI_COMMAND (cli_unix_cli_show_history)

Definition at line 2754 of file cli.c.

vlib_cli_command_t cli_unix_cli_show_terminal
static
Initial value:
= {
.path = "show terminal",
.short_help = "Show current session terminal settings",
}
static clib_error_t * unix_cli_show_terminal(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
CLI command to show terminal status.
Definition: cli.c:2763

(constructor) VLIB_CLI_COMMAND (cli_unix_cli_show_terminal)

Definition at line 2821 of file cli.c.

vlib_cli_command_t cli_unix_show_errors
static
Initial value:
= {
.path = "show unix-errors",
.short_help = "Show Unix system call error history",
.function = unix_show_errors,
}
static clib_error_t * unix_show_errors(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
CLI command to show various unix error statistics.
Definition: cli.c:2652

(constructor) VLIB_CLI_COMMAND (cli_unix_show_errors)

Definition at line 2718 of file cli.c.

unix_cli_banner_t unix_cli_banner[]
static
Initial value:
= {
_(" _______ _ _ _____ ___ \n"),
_(" __/ __/ _ \\ (_)__ | | / / _ \\/ _ \\\n"),
_(" _/ _// // / / / _ \\ | |/ / ___/ ___/\n"),
_(" /_/ /____(_)_/\\___/ |___/_/ /_/ \n"),
_("\n")
}

Plain welcome banner.

Definition at line 105 of file cli.c.

unix_cli_banner_t unix_cli_banner_color[]
static
Initial value:
= {
_(ANSI_BRED " _______ _ " ANSI_RESET " _ _____ ___ \n"),
_(ANSI_BRED " __/ __/ _ \\ (_)__ " ANSI_RESET " | | / / _ \\/ _ \\\n"),
_(ANSI_BRED " _/ _// // / / / _ \\" ANSI_RESET " | |/ / ___/ ___/\n"),
_(ANSI_BRED " /_/ /____(_)_/\\___/" ANSI_RESET " |___/_/ /_/ \n"),
_("\n")
}
#define ANSI_RESET
ANSI reset color settings.
Definition: cli.c:70
#define ANSI_BRED
ANSI Start bright red text.
Definition: cli.c:78

ANSI color welcome banner.

Definition at line 114 of file cli.c.

unix_cli_main_t unix_cli_main
static

CLI global state.

Definition at line 439 of file cli.c.

unix_cli_parse_actions_t unix_cli_parse_pager[]
static
Initial value:
= {
}
#define NULL
Definition: clib.h:55
Exit the pager session.
Definition: cli.c:268
Clear and redraw the page on the terminal.
Definition: cli.c:276
#define CSI
ANSI Control Sequence Introducer.
Definition: cli.c:65
Scroll to next line.
Definition: cli.c:270
Scroll to last line.
Definition: cli.c:273
Scroll to previous page.
Definition: cli.c:275
Scroll to next page.
Definition: cli.c:274
Scroll to previous line.
Definition: cli.c:271
Search the pager buffer.
Definition: cli.c:277
#define CTL(c)
Given a capital ASCII letter character return a NUL terminated string with the control code for that ...
Definition: cli.c:303
#define ESC
ANSI escape code.
Definition: cli.c:62
Scroll to first line.
Definition: cli.c:272
Action parser did not find any match.
Definition: cli.c:280
Telnet control code.
Definition: cli.c:265
Enter pressed (CR, CRLF, LF, etc)
Definition: cli.c:267
Scroll to next page.
Definition: cli.c:269

Patterns to match when a CLI session is in the pager.

Definition at line 372 of file cli.c.

unix_cli_parse_actions_t unix_cli_parse_strings[]
static
Initial value:
= {
}
Erase line to right & including cursor.
Definition: cli.c:260
Carriage return, newline or enter.
Definition: cli.c:247
#define NULL
Definition: clib.h:55
Undo last erase action.
Definition: cli.c:264
#define CSI
ANSI Control Sequence Introducer.
Definition: cli.c:65
Left arrow.
Definition: cli.c:253
Jump cursor to start of right word.
Definition: cli.c:258
Erase cursor left.
Definition: cli.c:249
Down arrow.
Definition: cli.c:252
End key (jump to end of line)
Definition: cli.c:256
Jump cursor to start of left word.
Definition: cli.c:257
Search backwards in command history.
Definition: cli.c:262
#define CTL(c)
Given a capital ASCII letter character return a NUL terminated string with the control code for that ...
Definition: cli.c:303
Search forwards in command history.
Definition: cli.c:263
Home key (jump to start of line)
Definition: cli.c:255
Clear the terminal.
Definition: cli.c:261
#define ESC
ANSI escape code.
Definition: cli.c:62
Up arrow.
Definition: cli.c:251
Action parser did not find any match.
Definition: cli.c:280
Telnet control code.
Definition: cli.c:265
Erase cursor right.
Definition: cli.c:250
Erase line to left of cursor.
Definition: cli.c:259
Right arrow.
Definition: cli.c:254

Patterns to match on a CLI input stream.

Definition at line 310 of file cli.c.

vlib_cli_command_t unix_cli_quit_command
static
Initial value:
= {
.path = "quit",
.short_help = "Exit CLI",
.function = unix_cli_quit,
}
static clib_error_t * unix_cli_quit(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
CLI command to quit the terminal session.
Definition: cli.c:2550

(constructor) VLIB_CLI_COMMAND (unix_cli_quit_command)

Definition at line 2569 of file cli.c.