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_MAX_TERMINAL_WIDTH   512
	Maximum terminal width we will accept. More...
#define	UNIX_CLI_MAX_TERMINAL_HEIGHT   512
	Maximum terminal height we will accept. More...
#define	UNIX_CLI_DEFAULT_TERMINAL_HEIGHT   24
	Default terminal height. More...
#define	UNIX_CLI_DEFAULT_TERMINAL_WIDTH   80
	Default terminal width. 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...
#define	fl(x, y)   ( (x) ? toupper((y)) : tolower((y)) )

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 (clib_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 (clib_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, clib_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, clib_file_t *uf, u8 *buffer, uword buffer_bytes)
	Process a buffer for CRLF handling before outputting it to the CLI. More...
static void	unix_vlib_cli_output_cursor_left (unix_cli_file_t *cf, clib_file_t *uf)
	Moves the terminal cursor one character to the left, with special handling when it reaches the left edge of the terminal window. More...
static void	unix_cli_cli_prompt (unix_cli_file_t *cf, clib_file_t *uf)
	Output the CLI prompt. More...
static void	unix_cli_pager_prompt (unix_cli_file_t *cf, clib_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, clib_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, clib_file_t *uf)
	Erase the printed pager prompt. More...
static void	unix_cli_ansi_cursor (unix_cli_file_t *cf, clib_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, clib_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_ansi (u8 *term, uword len)
	Identify whether a terminal type is ANSI capable. More...
static u8	unix_cli_terminal_type_noninteractive (u8 *term, uword len)
	Identify whether a terminal type is non-interactive. More...
static void	unix_cli_set_session_noninteractive (unix_cli_file_t *cf)
	Set a session to be non-interactive. 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, clib_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, clib_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, clib_file_main_t *fm, 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_t *	unix_cli_write_ready (clib_file_t *uf)
	Called when a CLI session file descriptor can be written to without blocking. More...
static clib_error_t *	unix_cli_read_ready (clib_file_t *uf)
	Called when a CLI session file descriptor has data to be read. More...
static clib_error_t *	unix_cli_error_detected (clib_file_t *uf)
	Called when a CLI session file descriptor has an error condition. 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_t *	unix_cli_listen_read_ready (clib_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_t *	unix_cli_config (vlib_main_t *vm, unformat_input_t *input)
	Handle configuration directives in the unix section. More...
static clib_error_t *	unix_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_t *	unix_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_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. More...
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. More...
static clib_error_t *	unix_show_files (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_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. More...
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. More...
static clib_error_t *	unix_cli_show_cli_sessions (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
	CLI command to display a list of CLI sessions. More...
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. More...
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. More...
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. More...
static clib_error_t *	unix_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	unix_cli_q_command
	(constructor) VLIB_CLI_COMMAND (unix_cli_q_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_show_files
	(constructor) VLIB_CLI_COMMAND (cli_unix_show_files) 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_show_cli_sessions
	(constructor) VLIB_CLI_COMMAND (cli_unix_cli_show_cli_sessions) 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 76 of file cli.c.

#define ANSI_BRED   ANSI_BOLD CSI "31m"

ANSI Start bright red text.

Definition at line 82 of file cli.c.

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

ANSI clear screen.

Definition at line 72 of file cli.c.

#define ANSI_CLEARLINE   CSI "2K"

ANSI clear line cursor is on.

Definition at line 84 of file cli.c.

#define ANSI_DIM   CSI "2m"

ANSI Stop bold text.

Definition at line 78 of file cli.c.

#define ANSI_DRED   ANSI_DIM CSI "31m"

ANSI Start dark red text.

Definition at line 80 of file cli.c.

#define ANSI_RESET   CSI "0m"

ANSI reset color settings.

Definition at line 74 of file cli.c.

#define ANSI_RESTCURSOR   CSI "u"

ANSI restore cursor position if previously saved.

Definition at line 90 of file cli.c.

#define ANSI_SAVECURSOR   CSI "s"

ANSI save cursor position.

Definition at line 88 of file cli.c.

#define ANSI_SCROLLDN   CSI "1T"

ANSI scroll screen down one line.

Definition at line 86 of file cli.c.

#define CSI   ESC "["

ANSI Control Sequence Introducer.

Definition at line 69 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

c	An ASCII character.

Returns

A NUL terminated string of type u8[].

Example

CTL('A') returns { 0x01, 0x00 } as a u8[].

Definition at line 338 of file cli.c.

#define ESC   "\x1b"

ANSI escape code.

Definition at line 66 of file cli.c.

#define fl	(		x,
			y
	)		( (x) ? toupper((y)) : tolower((y)) )

#define UNIX_CLI_DEFAULT_TERMINAL_HEIGHT   24

Default terminal height.

Definition at line 101 of file cli.c.

#define UNIX_CLI_DEFAULT_TERMINAL_WIDTH   80

Default terminal width.

Definition at line 103 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 safety measure.

Definition at line 94 of file cli.c.

#define UNIX_CLI_MAX_TERMINAL_HEIGHT   512

Maximum terminal height we will accept.

Definition at line 99 of file cli.c.

#define UNIX_CLI_MAX_TERMINAL_WIDTH   512

Maximum terminal width we will accept.

Definition at line 97 of file cli.c.

Enumeration Type Documentation

enum unix_cli_parse_action_t

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 279 of file cli.c.

enum unix_cli_process_event_type_t

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 448 of file cli.c.

Function Documentation

static void unix_cli_add_pending_output ( clib_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 538 of file cli.c.

Here is the caller graph for this function:

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

static

Uses an ANSI escape sequence to move the cursor.

Definition at line 838 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, clib_file_t *  uf  )

static

Output the CLI prompt.

Definition at line 766 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 2887 of file cli.c.

Here is the call graph for this function:

static void unix_cli_del_pending_output ( clib_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 558 of file cli.c.

Here is the caller graph for this function:

static clib_error_t* unix_cli_error_detected ( clib_file_t *  uf )

static

Called when a CLI session file descriptor has an error condition.

Definition at line 2645 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_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 3117 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 3042 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

name	The name of the session.
fd	The file descriptor for the session I/O.

Returns

The session ID.

Definition at line 2667 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

f	The CLI session whose storage needs to be released.

Definition at line 271 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 1197 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 1246 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 3679 of file cli.c.

Here is the caller graph for this function:

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 2485 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, clib_file_main_t *  fm, 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 2281 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, clib_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 1417 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 ( clib_file_t *  uf )

static

Telnet listening socket has a new connection.

Definition at line 2756 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]	a	Actions list to search within.
[in]	input	String fragment to search for.
[in]	ilen	Length of the string in 'input'.
[out]	matched	Pointer 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 500 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

cf	The CLI session whose pager we are adding to.
line	The 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_index	If 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 915 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, clib_file_t *  uf, char *  message, char *  postfix  )

static

Output a pager "skipping" message.

Definition at line 800 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, clib_file_t *  uf  )

static

Output a pager prompt and show number of buffered lines.

Definition at line 777 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, clib_file_t *  uf  )

static

Erase the printed pager prompt.

Definition at line 816 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, clib_file_t *  uf  )

static

Redraw the currently displayed page of text.

Parameters

cf	CLI session to redraw the pager buffer of.
uf	Unix file of the CLI session.

Definition at line 854 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

cf	The CLI session whose pager buffer should be reindexed.

Definition at line 977 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

f	The CLI session whose pager needs to be reset.

Definition at line 250 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 2520 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 2370 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, clib_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 1271 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 3075 of file cli.c.

Here is the call graph for this function:

static clib_error_t* unix_cli_read_ready ( clib_file_t *  uf )

static

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

Definition at line 2606 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 2847 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static void unix_cli_set_session_noninteractive ( unix_cli_file_t *  cf )

static

Set a session to be non-interactive.

Definition at line 1185 of file cli.c.

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 3639 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 3573 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 3514 of file cli.c.

Here is the call graph for this function:

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

static

CLI command to display a list of CLI sessions.

Definition at line 3434 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 3325 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 3364 of file cli.c.

Here is the call graph for this function:

static u8 unix_cli_terminal_type_ansi ( 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

term	A string with a terminal type in it.
len	The length of the string in term.

Returns

1 if the terminal type is recognized as supporting ANSI terminal sequences; 0 otherwise.

Definition at line 1138 of file cli.c.

Here is the caller graph for this function:

static u8 unix_cli_terminal_type_noninteractive ( u8 *  term, uword  len  )

static

Identify whether a terminal type is non-interactive.

Compares the string given in term with a list of terminal types known to be non-interactive, as send by tools such as vppctl .

This list contains, for example, vppctl.

Parameters

term	A string with a terminal type in it.
len	The length of the string in term.

Returns

1 if the terminal type is recognized as being non-interactive; 0 otherwise.

Definition at line 1170 of file cli.c.

Here is the caller graph for this function:

static clib_error_t* unix_cli_write_ready ( clib_file_t *  uf )

static

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

Definition at line 2564 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 3207 of file cli.c.

Here is the call graph for this function:

static clib_error_t* unix_show_files ( 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 3282 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_index	Index of the CLI session where this output is directed.
buffer	String of printabe bytes to be output.
buffer_bytes	The number of bytes in buffer to be output.

Definition at line 1050 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, clib_file_t *  uf, u8 *  buffer, uword  buffer_bytes  )

static

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

Parameters

cf	Unix CLI session of the desired stream to write to.
uf	The Unix file structure of the desired stream to write to.
buffer	Pointer to the buffer that needs to be written.
buffer_bytes	The number of bytes from buffer to write.

Definition at line 666 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_cursor_left ( unix_cli_file_t *  cf, clib_file_t *  uf  )

static

Moves the terminal cursor one character to the left, with special handling when it reaches the left edge of the terminal window.

Ordinarily we can simply send a '' to move the cursor left, however most terminals will not reverse-wrap to the end of the previous line if the cursor is in the left-most column. To counter this we must check the cursor position + prompt length modulo terminal width and if available use some other means, such as ANSI terminal escape sequences, to move the cursor.

Parameters

cf	Unix CLI session of the desired stream to write to.
uf	The Unix file structure of the desired stream to write to.

Definition at line 719 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, clib_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

cf	Unix CLI session of the desired stream to write to.
uf	The Unix file structure of the desired stream to write to.
buffer	Pointer to the buffer that needs to be written.
buffer_bytes	The number of bytes from buffer to write.

Definition at line 615 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

chr	The byte value to search for.
str	The buffer in which to search for the value.
len	The 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 588 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

prompt

The C string to set the prompt to.

Note

This setting is global; it impacts all current and future CLI sessions.

Definition at line 3061 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 = "exec <filename>",
  .function = unix_cli_exec,
  .is_mp_safe = 1,
}

(constructor) VLIB_CLI_COMMAND (cli_exec)

Definition at line 3197 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]",
  .function = unix_cli_set_terminal_ansi,
}

(constructor) VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_ansi)

Definition at line 3671 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>]",
  .function = unix_cli_set_terminal_history,
}

(constructor) VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_history)

Definition at line 3630 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>]",
  .function = unix_cli_set_terminal_pager,
}

(constructor) VLIB_CLI_COMMAND (cli_unix_cli_set_terminal_pager)

Definition at line 3564 of file cli.c.

vlib_cli_command_t cli_unix_cli_show_cli_sessions

static

Initial value:

= {
  .path = "show cli-sessions",
  .short_help = "Show current CLI sessions",
  .function = unix_cli_show_cli_sessions,
}

(constructor) VLIB_CLI_COMMAND (cli_unix_cli_show_cli_sessions)

Definition at line 3505 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,
}

(constructor) VLIB_CLI_COMMAND (cli_unix_cli_show_history)

Definition at line 3355 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",
  .function = unix_cli_show_terminal,
}

(constructor) VLIB_CLI_COMMAND (cli_unix_cli_show_terminal)

Definition at line 3425 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,
}

(constructor) VLIB_CLI_COMMAND (cli_unix_show_errors)

Definition at line 3273 of file cli.c.

vlib_cli_command_t cli_unix_show_files

static

Initial value:

= {
  .path = "show unix files",
  .short_help = "Show Unix files in use",
  .function = unix_show_files,
}

(constructor) VLIB_CLI_COMMAND (cli_unix_show_files)

Definition at line 3316 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 114 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")
}

ANSI color welcome banner.

Definition at line 123 of file cli.c.

unix_cli_main_t unix_cli_main

static

CLI global state.

Definition at line 474 of file cli.c.

unix_cli_parse_actions_t unix_cli_parse_pager[]

static

Initial value:

= {
  
  _("\r\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),  
  _("\n", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),
  _("\r\0", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),  
  _("\r", UNIX_CLI_PARSE_ACTION_PAGER_CRLF),

  
  _(" ", UNIX_CLI_PARSE_ACTION_PAGER_NEXT),
  _("q", UNIX_CLI_PARSE_ACTION_PAGER_QUIT),
  _(CTL ('L'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
  _(CTL ('R'), UNIX_CLI_PARSE_ACTION_PAGER_REDRAW),
  _("/", UNIX_CLI_PARSE_ACTION_PAGER_SEARCH),

  
  _(CSI "A", UNIX_CLI_PARSE_ACTION_PAGER_UP),
  _(CSI "B", UNIX_CLI_PARSE_ACTION_PAGER_DN),
  _(CSI "H", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
  _(CSI "F", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),

  
  _(ESC "OA", UNIX_CLI_PARSE_ACTION_PAGER_UP),
  _(ESC "OB", UNIX_CLI_PARSE_ACTION_PAGER_DN),
  _(ESC "OH", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
  _(ESC "OF", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),

  
  _(CSI "1~", UNIX_CLI_PARSE_ACTION_PAGER_TOP),
  _(CSI "4~", UNIX_CLI_PARSE_ACTION_PAGER_BOTTOM),
  _(CSI "5~", UNIX_CLI_PARSE_ACTION_PAGER_PGUP),
  _(CSI "6~", UNIX_CLI_PARSE_ACTION_PAGER_PGDN),

  
  _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC),   
  _("\0", UNIX_CLI_PARSE_ACTION_NOACTION),      
  _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
}

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

Definition at line 407 of file cli.c.

unix_cli_parse_actions_t unix_cli_parse_strings[]

static

Initial value:

= {
  
  _("\r\n", UNIX_CLI_PARSE_ACTION_CRLF),        
  _("\n", UNIX_CLI_PARSE_ACTION_CRLF),
  _("\r\0", UNIX_CLI_PARSE_ACTION_CRLF),        
  _("\r", UNIX_CLI_PARSE_ACTION_CRLF),

  
  _(CTL ('B'), UNIX_CLI_PARSE_ACTION_LEFT),
  _(CTL ('F'), UNIX_CLI_PARSE_ACTION_RIGHT),
  _(CTL ('P'), UNIX_CLI_PARSE_ACTION_UP),
  _(CTL ('N'), UNIX_CLI_PARSE_ACTION_DOWN),
  _(CTL ('A'), UNIX_CLI_PARSE_ACTION_HOME),
  _(CTL ('E'), UNIX_CLI_PARSE_ACTION_END),
  _(CTL ('D'), UNIX_CLI_PARSE_ACTION_ERASERIGHT),
  _(CTL ('U'), UNIX_CLI_PARSE_ACTION_ERASELINELEFT),
  _(CTL ('K'), UNIX_CLI_PARSE_ACTION_ERASELINERIGHT),
  _(CTL ('Y'), UNIX_CLI_PARSE_ACTION_YANK),
  _(CTL ('L'), UNIX_CLI_PARSE_ACTION_CLEAR),
  _(ESC "b", UNIX_CLI_PARSE_ACTION_WORDLEFT),   
  _(ESC "f", UNIX_CLI_PARSE_ACTION_WORDRIGHT),  
  _("\b", UNIX_CLI_PARSE_ACTION_ERASE), 
  _("\x7f", UNIX_CLI_PARSE_ACTION_ERASE),       
  _("\t", UNIX_CLI_PARSE_ACTION_TAB),   

  
  _(CSI "A", UNIX_CLI_PARSE_ACTION_UP),
  _(CSI "B", UNIX_CLI_PARSE_ACTION_DOWN),
  _(CSI "C", UNIX_CLI_PARSE_ACTION_RIGHT),
  _(CSI "D", UNIX_CLI_PARSE_ACTION_LEFT),
  _(CSI "H", UNIX_CLI_PARSE_ACTION_HOME),
  _(CSI "F", UNIX_CLI_PARSE_ACTION_END),
  _(CSI "3~", UNIX_CLI_PARSE_ACTION_ERASERIGHT),        
  _(CSI "1;5D", UNIX_CLI_PARSE_ACTION_WORDLEFT),        
  _(CSI "1;5C", UNIX_CLI_PARSE_ACTION_WORDRIGHT),       

  
  _(ESC "OA", UNIX_CLI_PARSE_ACTION_UP),
  _(ESC "OB", UNIX_CLI_PARSE_ACTION_DOWN),
  _(ESC "OC", UNIX_CLI_PARSE_ACTION_RIGHT),
  _(ESC "OD", UNIX_CLI_PARSE_ACTION_LEFT),
  _(ESC "OH", UNIX_CLI_PARSE_ACTION_HOME),
  _(ESC "OF", UNIX_CLI_PARSE_ACTION_END),

  
  _(CSI "1~", UNIX_CLI_PARSE_ACTION_HOME),
  _(CSI "4~", UNIX_CLI_PARSE_ACTION_END),

  
  _(CTL ('S'), UNIX_CLI_PARSE_ACTION_FWDSEARCH),
  _(CTL ('R'), UNIX_CLI_PARSE_ACTION_REVSEARCH),

  
  _("\xff", UNIX_CLI_PARSE_ACTION_TELNETIAC),   
  _("\0", UNIX_CLI_PARSE_ACTION_NOACTION),      
  _(NULL, UNIX_CLI_PARSE_ACTION_NOMATCH)
}

Patterns to match on a CLI input stream.

Definition at line 345 of file cli.c.

vlib_cli_command_t unix_cli_q_command

static

Initial value:

= {
  .path = "q",
  .short_help = "Exit CLI",
  .function = unix_cli_quit,
}

(constructor) VLIB_CLI_COMMAND (unix_cli_q_command)

Definition at line 3108 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,
}

(constructor) VLIB_CLI_COMMAND (unix_cli_quit_command)

Definition at line 3100 of file cli.c.