FD.io VPP  v20.01-rc2-3-g9af7a98cf
Vector Packet Processing
vlib_api_cli.c File Reference
+ Include dependency graph for vlib_api_cli.c:

Go to the source code of this file.

Data Structures

struct  msg_table_unserialize_t
 

Enumerations

enum  vl_api_replay_t { DUMP, CUSTOM_DUMP, REPLAY, INITIALIZERS }
 

Functions

static clib_error_tvl_api_show_histogram_command (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
 
static clib_error_tvl_api_clear_histogram_command (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
 
static clib_error_tvl_api_client_command (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
 
static clib_error_tvl_api_status_command (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
 
static clib_error_tvl_api_message_table_command (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
 
static int range_compare (vl_api_msg_range_t *a0, vl_api_msg_range_t *a1)
 
static u8format_api_msg_range (u8 *s, va_list *args)
 
static clib_error_tvl_api_show_plugin_command (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
 
u8format_vl_msg_api_trace_status (u8 *s, va_list *args)
 
void vl_msg_api_custom_dump_configure (api_main_t *am)
 
static void vl_msg_api_process_file (vlib_main_t *vm, u8 *filename, u32 first_index, u32 last_index, vl_api_replay_t which)
 
static clib_error_tapi_trace_command_fn (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 api_trace_command_fn - control the binary API trace / replay feature More...
 
static clib_error_tvl_api_trace_command (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
 
static clib_error_tapi_trace_config_fn (vlib_main_t *vm, unformat_input_t *input)
 
static clib_error_tapi_queue_config_fn (vlib_main_t *vm, unformat_input_t *input)
 
static u8extract_name (u8 *s)
 
static u8extract_crc (u8 *s)
 
static int table_id_cmp (void *a1, void *a2)
 
static int table_name_and_crc_cmp (void *a1, void *a2)
 
static clib_error_tdump_api_table_file_command_fn (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 

Variables

static vlib_cli_command_t cli_show_api_histogram_command
 (constructor) VLIB_CLI_COMMAND (cli_show_api_histogram_command) More...
 
static vlib_cli_command_t cli_clear_api_histogram_command
 (constructor) VLIB_CLI_COMMAND (cli_clear_api_histogram_command) More...
 
static vlib_cli_command_t cli_show_api_command
 (constructor) VLIB_CLI_COMMAND (cli_show_api_command) More...
 
static vlib_cli_command_t cli_show_api_clients_command
 (constructor) VLIB_CLI_COMMAND (cli_show_api_clients_command) More...
 
static vlib_cli_command_t cli_show_api_status_command
 (constructor) VLIB_CLI_COMMAND (cli_show_api_status_command) More...
 
static vlib_cli_command_t cli_show_api_message_table_command
 (constructor) VLIB_CLI_COMMAND (cli_show_api_message_table_command) More...
 
static vlib_cli_command_t cli_show_api_plugin_command
 (constructor) VLIB_CLI_COMMAND (cli_show_api_plugin_command) More...
 
static vlib_cli_command_t api_trace_command
 (constructor) VLIB_CLI_COMMAND (api_trace_command) More...
 
static vlib_cli_command_t trace
 (constructor) VLIB_CLI_COMMAND (trace) More...
 
static vlib_cli_command_t dump_api_table_file
 (constructor) VLIB_CLI_COMMAND (dump_api_table_file) More...
 

Enumeration Type Documentation

◆ vl_api_replay_t

Enumerator
DUMP 
CUSTOM_DUMP 
REPLAY 
INITIALIZERS 

Definition at line 344 of file vlib_api_cli.c.

Function Documentation

◆ api_queue_config_fn()

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

Definition at line 942 of file vlib_api_cli.c.

+ Here is the call graph for this function:

◆ api_trace_command_fn()

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

api_trace_command_fn - control the binary API trace / replay feature

Note: this command MUST be marked thread-safe. Replay with multiple worker threads depends in many cases on worker thread graph replica maintenance. If we (implicitly) assert a worker thread barrier at the debug CLI level, all graph replica changes are deferred until the replay operation completes. If an interface is deleted, the wheels fall off.

Definition at line 685 of file vlib_api_cli.c.

+ Here is the call graph for this function:

◆ api_trace_config_fn()

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

Definition at line 907 of file vlib_api_cli.c.

+ Here is the call graph for this function:

◆ dump_api_table_file_command_fn()

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

Definition at line 1029 of file vlib_api_cli.c.

+ Here is the call graph for this function:

◆ extract_crc()

static u8* extract_crc ( u8 s)
static

Definition at line 983 of file vlib_api_cli.c.

+ Here is the caller graph for this function:

◆ extract_name()

static u8* extract_name ( u8 s)
static

Definition at line 968 of file vlib_api_cli.c.

+ Here is the caller graph for this function:

◆ format_api_msg_range()

static u8* format_api_msg_range ( u8 s,
va_list *  args 
)
static

Definition at line 289 of file vlib_api_cli.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ format_vl_msg_api_trace_status()

u8* format_vl_msg_api_trace_status ( u8 s,
va_list *  args 
)

Definition at line 353 of file vlib_api_cli.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ range_compare()

static int range_compare ( vl_api_msg_range_t a0,
vl_api_msg_range_t a1 
)
static

Definition at line 278 of file vlib_api_cli.c.

+ Here is the caller graph for this function:

◆ table_id_cmp()

static int table_id_cmp ( void *  a1,
void *  a2 
)
static

Definition at line 1011 of file vlib_api_cli.c.

+ Here is the caller graph for this function:

◆ table_name_and_crc_cmp()

static int table_name_and_crc_cmp ( void *  a1,
void *  a2 
)
static

Definition at line 1020 of file vlib_api_cli.c.

+ Here is the caller graph for this function:

◆ vl_api_clear_histogram_command()

static clib_error_t* vl_api_clear_histogram_command ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cli_cmd 
)
static

Definition at line 74 of file vlib_api_cli.c.

◆ vl_api_client_command()

static clib_error_t* vl_api_client_command ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cli_cmd 
)
static

Definition at line 98 of file vlib_api_cli.c.

+ Here is the call graph for this function:

◆ vl_api_message_table_command()

static clib_error_t* vl_api_message_table_command ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cli_cmd 
)
static

Definition at line 227 of file vlib_api_cli.c.

+ Here is the call graph for this function:

◆ vl_api_show_histogram_command()

static clib_error_t* vl_api_show_histogram_command ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cli_cmd 
)
static

Definition at line 27 of file vlib_api_cli.c.

+ Here is the call graph for this function:

◆ vl_api_show_plugin_command()

static clib_error_t* vl_api_show_plugin_command ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cli_cmd 
)
static

Definition at line 303 of file vlib_api_cli.c.

+ Here is the call graph for this function:

◆ vl_api_status_command()

static clib_error_t* vl_api_status_command ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cli_cmd 
)
static

Definition at line 161 of file vlib_api_cli.c.

+ Here is the call graph for this function:

◆ vl_api_trace_command()

static clib_error_t* vl_api_trace_command ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cli_cmd 
)
static

Definition at line 829 of file vlib_api_cli.c.

+ Here is the call graph for this function:

◆ vl_msg_api_custom_dump_configure()

void vl_msg_api_custom_dump_configure ( api_main_t am)

Definition at line 391 of file vlib_api_cli.c.

+ Here is the caller graph for this function:

◆ vl_msg_api_process_file()

static void vl_msg_api_process_file ( vlib_main_t vm,
u8 filename,
u32  first_index,
u32  last_index,
vl_api_replay_t  which 
)
static

Definition at line 396 of file vlib_api_cli.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ api_trace_command

vlib_cli_command_t api_trace_command
static
Initial value:
=
{
.path = "api trace",
.short_help = "api trace [on|off][first <n>][last <n>][status][free]"
"[post-mortem-on][dump|custom-dump|save|replay <file>]",
.function = api_trace_command_fn,
.is_mp_safe = 1,
}
static clib_error_t * api_trace_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
api_trace_command_fn - control the binary API trace / replay feature
Definition: vlib_api_cli.c:685

(constructor) VLIB_CLI_COMMAND (api_trace_command)

Definition at line 818 of file vlib_api_cli.c.

◆ cli_clear_api_histogram_command

vlib_cli_command_t cli_clear_api_histogram_command
static
Initial value:
=
{
.path = "clear api histogram",
.short_help = "clear api histogram",
}
static clib_error_t * vl_api_clear_histogram_command(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
Definition: vlib_api_cli.c:74

(constructor) VLIB_CLI_COMMAND (cli_clear_api_histogram_command)

Definition at line 89 of file vlib_api_cli.c.

◆ cli_show_api_clients_command

vlib_cli_command_t cli_show_api_clients_command
static
Initial value:
=
{
.path = "show api clients",
.short_help = "Client information",
.function = vl_api_client_command,
}
static clib_error_t * vl_api_client_command(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
Definition: vlib_api_cli.c:98

(constructor) VLIB_CLI_COMMAND (cli_show_api_clients_command)

Definition at line 206 of file vlib_api_cli.c.

◆ cli_show_api_command

vlib_cli_command_t cli_show_api_command
static
Initial value:
=
{
.path = "show api",
.short_help = "Show API information",
}

(constructor) VLIB_CLI_COMMAND (cli_show_api_command)

Definition at line 195 of file vlib_api_cli.c.

◆ cli_show_api_histogram_command

vlib_cli_command_t cli_show_api_histogram_command
static
Initial value:
=
{
.path = "show api histogram",
.short_help = "show api histogram",
}
static clib_error_t * vl_api_show_histogram_command(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
Definition: vlib_api_cli.c:27

(constructor) VLIB_CLI_COMMAND (cli_show_api_histogram_command)

Definition at line 65 of file vlib_api_cli.c.

◆ cli_show_api_message_table_command

vlib_cli_command_t cli_show_api_message_table_command
static
Initial value:
=
{
.path = "show api message-table",
.short_help = "Message Table",
}
static clib_error_t * vl_api_message_table_command(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
Definition: vlib_api_cli.c:227

(constructor) VLIB_CLI_COMMAND (cli_show_api_message_table_command)

Definition at line 269 of file vlib_api_cli.c.

◆ cli_show_api_plugin_command

vlib_cli_command_t cli_show_api_plugin_command
static
Initial value:
=
{
.path = "show api plugin",
.short_help = "show api plugin",
}
static clib_error_t * vl_api_show_plugin_command(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
Definition: vlib_api_cli.c:303

(constructor) VLIB_CLI_COMMAND (cli_show_api_plugin_command)

Definition at line 336 of file vlib_api_cli.c.

◆ cli_show_api_status_command

vlib_cli_command_t cli_show_api_status_command
static
Initial value:
=
{
.path = "show api trace-status",
.short_help = "Display API trace status",
.function = vl_api_status_command,
}
static clib_error_t * vl_api_status_command(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
Definition: vlib_api_cli.c:161

(constructor) VLIB_CLI_COMMAND (cli_show_api_status_command)

Definition at line 218 of file vlib_api_cli.c.

◆ dump_api_table_file

vlib_cli_command_t dump_api_table_file
static
Initial value:
=
{
.path = "show api dump",
.short_help = "show api dump file <filename> [numeric | compare-current]",
}
static clib_error_t * dump_api_table_file_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)

(constructor) VLIB_CLI_COMMAND (dump_api_table_file)

Definition at line 1235 of file vlib_api_cli.c.

◆ trace

vlib_cli_command_t trace
static
Initial value:
=
{
.path = "set api-trace",
.short_help = "API trace [on][on tx][on rx][off][free][debug on][debug off]",
.function = vl_api_trace_command,
}
static clib_error_t * vl_api_trace_command(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cli_cmd)
Definition: vlib_api_cli.c:829

(constructor) VLIB_CLI_COMMAND (trace)

Definition at line 898 of file vlib_api_cli.c.