Debug CLI Implementation. More...

Include dependency graph for cli.c:

Data Structures
struct	vlib_cli_walk_args_t

Functions
int	vl_api_set_elog_trace_api_messages (int enable)

int	vl_api_get_elog_trace_api_messages (void)

static uword *	vlib_cli_sub_command_match (vlib_cli_command_t c, unformat_input_t input)

uword	unformat_vlib_cli_sub_input (unformat_input_t i, va_list args)

static vlib_cli_command_t *	get_sub_command (vlib_cli_main_t cm, vlib_cli_command_t parent, u32 si)

static uword	unformat_vlib_cli_sub_command (unformat_input_t i, va_list args)

static int	vlib_cli_cmp_strings (void a1, void a2)

u8 **	vlib_cli_get_possible_completions (u8 *str)

static u8 *	format_vlib_cli_command_help (u8 s, va_list args)

static u8 *	format_vlib_cli_parse_rule_name (u8 s, va_list args)

static u8 *	format_vlib_cli_path (u8 s, va_list args)

static vlib_cli_command_t *	all_subs (vlib_cli_main_t cm, vlib_cli_command_t subs, u32 command_index)

static int	vlib_cli_cmp_rule (void a1, void a2)

static int	vlib_cli_cmp_command (void a1, void a2)

static clib_error_t *	vlib_cli_dispatch_sub_commands (vlib_main_t vm, vlib_cli_main_t cm, unformat_input_t *input, uword parent_command_index)

void	vlib_unix_error_report (vlib_main_t , clib_error_t )

int	vlib_cli_input (vlib_main_t vm, unformat_input_t input, vlib_cli_output_function_t *function, uword function_arg)

void	vlib_cli_output (vlib_main_t vm, char fmt,...)

void *	vl_msg_push_heap (void)

void	vl_msg_pop_heap (void *oldheap)

void *	vlib_stats_push_heap (void *)

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

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

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

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

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

static uword	vlib_cli_normalize_path (char input, char *result)

static uword	parent_path_len (char *path)

static void	add_sub_command (vlib_cli_main_t *cm, uword parent_index, uword child_index)

static void	vlib_cli_make_parent (vlib_cli_main_t *cm, uword ci)

static uword	vlib_cli_command_is_empty (vlib_cli_command_t *c)

clib_error_t *	vlib_cli_register (vlib_main_t vm, vlib_cli_command_t c)

clib_error_t *	vlib_cli_register_parse_rule (vlib_main_t vm, vlib_cli_parse_rule_t r_reg)

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

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

static int	sort_cmds_by_path (void a1, void a2)

static void	cli_recursive_walk (vlib_cli_walk_args_t *aa)

static u8 *	format_mp_safe (u8 s, va_list args)

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

static clib_error_t *	vlib_cli_init (vlib_main_t *vm)

Variables
static void *	current_traced_heap

static vlib_cli_command_t	vlib_cli_show_command
	(constructor) VLIB_CLI_COMMAND (vlib_cli_show_command) More...

static vlib_cli_command_t	vlib_cli_clear_command
	(constructor) VLIB_CLI_COMMAND (vlib_cli_clear_command) More...

static vlib_cli_command_t	vlib_cli_set_command
	(constructor) VLIB_CLI_COMMAND (vlib_cli_set_command) More...

static vlib_cli_command_t	vlib_cli_test_command
	(constructor) VLIB_CLI_COMMAND (vlib_cli_test_command) More...

static vlib_cli_command_t	show_memory_usage_command
	(constructor) VLIB_CLI_COMMAND (show_memory_usage_command) More...

static vlib_cli_command_t	show_cpu_command
	(constructor) VLIB_CLI_COMMAND (show_cpu_command) More...

static vlib_cli_command_t	enable_disable_memory_trace_command
	(constructor) VLIB_CLI_COMMAND (enable_disable_memory_trace_command) More...

static vlib_cli_command_t	cmd_test_heap_validate
	(constructor) VLIB_CLI_COMMAND (cmd_test_heap_validate) More...

static vlib_cli_command_t	restart_cmd
	(constructor) VLIB_CLI_COMMAND (restart_cmd) More...

static vlib_cli_command_t	elog_trace_command
	(constructor) VLIB_CLI_COMMAND (elog_trace_command) More...

static vlib_cli_command_t	suspend_command
	(constructor) VLIB_CLI_COMMAND (suspend_command) More...

static vlib_cli_command_t	show_cli_command
	(constructor) VLIB_CLI_COMMAND (show_cli_command) More...

Detailed Description

Debug CLI Implementation.

Definition in file cli.c.

Function Documentation

◆ add_sub_command()

static void add_sub_command	(	vlib_cli_main_t *	cm,
		uword	parent_index,
		uword	child_index
	)

static

Definition at line 1259 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ all_subs()

static vlib_cli_command_t* all_subs	(	vlib_cli_main_t *	cm,
		vlib_cli_command_t *	subs,
		u32	command_index
	)

static

Definition at line 414 of file cli.c.

Here is the caller graph for this function:

◆ cli_recursive_walk()

static void cli_recursive_walk ( vlib_cli_walk_args_t * aa )

static

Definition at line 1723 of file cli.c.

Here is the caller graph for this function:

◆ elog_trace_command_fn()

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

static

Definition at line 1558 of file cli.c.

Here is the call graph for this function:

◆ enable_disable_memory_trace()

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

static

Definition at line 982 of file cli.c.

Here is the call graph for this function:

◆ format_mp_safe()

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

static

Definition at line 1759 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ format_vlib_cli_command_help()

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

static

Definition at line 352 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ format_vlib_cli_parse_rule_name()

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

static

Definition at line 366 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ format_vlib_cli_path()

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

static

Definition at line 373 of file cli.c.

Here is the caller graph for this function:

◆ get_sub_command()

static vlib_cli_command_t* get_sub_command	(	vlib_cli_main_t *	cm,
		vlib_cli_command_t *	parent,
		u32	si
	)

static

Definition at line 198 of file cli.c.

Here is the caller graph for this function:

◆ parent_path_len()

static uword parent_path_len ( char * path )

inlinestatic

Definition at line 1247 of file cli.c.

Here is the caller graph for this function:

◆ restart_cmd_fn()

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

static

Definition at line 1139 of file cli.c.

◆ show_cli_command_fn()

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

static

Definition at line 1798 of file cli.c.

Here is the call graph for this function:

◆ show_cpu()

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

static

Definition at line 949 of file cli.c.

◆ show_memory_usage()

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

static

Definition at line 815 of file cli.c.

Here is the call graph for this function:

◆ sort_cmds_by_path()

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

static

Definition at line 1686 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ suspend_command_fn()

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

static

Definition at line 1667 of file cli.c.

Here is the call graph for this function:

◆ test_heap_validate()

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

static

Definition at line 1074 of file cli.c.

Here is the call graph for this function:

◆ unformat_vlib_cli_sub_command()

static uword unformat_vlib_cli_sub_command	(	unformat_input_t *	i,
		va_list *	args
	)

static

Definition at line 205 of file cli.c.

Here is the caller graph for this function:

◆ unformat_vlib_cli_sub_input()

uword unformat_vlib_cli_sub_input	(	unformat_input_t *	i,
		va_list *	args
	)

Definition at line 162 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vl_api_get_elog_trace_api_messages()

int vl_api_get_elog_trace_api_messages ( void )

Definition at line 2006 of file main.c.

Here is the caller graph for this function:

◆ vl_api_set_elog_trace_api_messages()

int vl_api_set_elog_trace_api_messages ( int enable )

Definition at line 1998 of file main.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vl_msg_pop_heap()

void vl_msg_pop_heap ( void * oldheap )

Definition at line 803 of file cli.c.

Here is the caller graph for this function:

◆ vl_msg_push_heap()

void * vl_msg_push_heap ( void )

Definition at line 796 of file cli.c.

Here is the caller graph for this function:

◆ vlib_cli_cmp_command()

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

static

Definition at line 440 of file cli.c.

Here is the caller graph for this function:

◆ vlib_cli_cmp_rule()

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

static

Definition at line 431 of file cli.c.

Here is the caller graph for this function:

◆ vlib_cli_cmp_strings()

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

static

Definition at line 250 of file cli.c.

Here is the caller graph for this function:

◆ vlib_cli_command_is_empty()

static uword vlib_cli_command_is_empty ( vlib_cli_command_t * c )

inlinestatic

Definition at line 1408 of file cli.c.

Here is the caller graph for this function:

◆ vlib_cli_dispatch_sub_commands()

static clib_error_t* vlib_cli_dispatch_sub_commands	(	vlib_main_t *	vm,
		vlib_cli_main_t *	cm,
		unformat_input_t *	input,
		uword	parent_command_index
	)

static

Definition at line 449 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vlib_cli_get_possible_completions()

u8** vlib_cli_get_possible_completions ( u8 * str )

Definition at line 259 of file cli.c.

Here is the call graph for this function:

◆ vlib_cli_init()

static clib_error_t* vlib_cli_init ( vlib_main_t * vm )

static

Definition at line 1883 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vlib_cli_input()

int vlib_cli_input	(	vlib_main_t *	vm,
		unformat_input_t *	input,
		vlib_cli_output_function_t *	function,
		uword	function_arg
	)

Definition at line 730 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vlib_cli_make_parent()

static void vlib_cli_make_parent	(	vlib_cli_main_t *	cm,
		uword	ci
	)

static

Definition at line 1360 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vlib_cli_normalize_path()

static uword vlib_cli_normalize_path	(	char *	input,
		char **	result
	)

static

Definition at line 1205 of file cli.c.

Here is the caller graph for this function:

◆ vlib_cli_output()

void vlib_cli_output	(	vlib_main_t *	vm,
		char *	fmt,
			...
	)

Definition at line 772 of file cli.c.

◆ vlib_cli_register()

clib_error_t* vlib_cli_register	(	vlib_main_t *	vm,
		vlib_cli_command_t *	c
	)

Definition at line 1414 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vlib_cli_register_parse_rule()

clib_error_t* vlib_cli_register_parse_rule	(	vlib_main_t *	vm,
		vlib_cli_parse_rule_t *	r_reg
	)

Definition at line 1496 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vlib_cli_sub_command_match()

static uword* vlib_cli_sub_command_match	(	vlib_cli_command_t *	c,
		unformat_input_t *	input
	)

static

Definition at line 89 of file cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vlib_stats_push_heap()

void * vlib_stats_push_heap ( void * notused )

Definition at line 809 of file cli.c.

Here is the caller graph for this function:

◆ vlib_unix_error_report()

void vlib_unix_error_report	(	vlib_main_t *	vm,
		clib_error_t *	error
	)

Definition at line 724 of file cli.c.

Here is the caller graph for this function:

Variable Documentation

◆ cmd_test_heap_validate

vlib_cli_command_t cmd_test_heap_validate

static

Initial value:

= {
    .path = "test heap-validate",
    .short_help = "<on/off/now> validate heap on future allocs/frees or right now",
    .function = test_heap_validate,
}

(constructor) VLIB_CLI_COMMAND (cmd_test_heap_validate)

Definition at line 1131 of file cli.c.

◆ current_traced_heap

void* current_traced_heap

static

Definition at line 53 of file cli.c.

◆ elog_trace_command

vlib_cli_command_t elog_trace_command

static

Initial value:

=
{
  .path = "elog trace",
  .short_help = "elog trace [api][cli][barrier][dispatch]\n"
  "[circuit-node <name> e.g. ethernet-input][disable]",
  .function = elog_trace_command_fn,
}

(constructor) VLIB_CLI_COMMAND (elog_trace_command)

Definition at line 1657 of file cli.c.

◆ enable_disable_memory_trace_command

vlib_cli_command_t enable_disable_memory_trace_command

static

Initial value:

= {
  .path = "memory-trace",
  .short_help = "memory-trace on|off [api-segment][stats-segment][main-heap]\n",
  .function = enable_disable_memory_trace,
}

(constructor) VLIB_CLI_COMMAND (enable_disable_memory_trace_command)

Definition at line 1065 of file cli.c.

◆ restart_cmd

vlib_cli_command_t restart_cmd

static

Initial value:

= {
    .path = "restart",
    .short_help = "restart process",
    .function = restart_cmd_fn,
}

(constructor) VLIB_CLI_COMMAND (restart_cmd)

Definition at line 1164 of file cli.c.

◆ show_cli_command

vlib_cli_command_t show_cli_command

static

Initial value:

=
{
  .path = "show cli",
  .short_help = "show cli [mp-safe][not-mp-safe][hit][clear-hit]",
  .function = show_cli_command_fn,
  .is_mp_safe = 1,
}

(constructor) VLIB_CLI_COMMAND (show_cli_command)

Definition at line 1873 of file cli.c.

◆ show_cpu_command

vlib_cli_command_t show_cpu_command

static

Initial value:

= {
  .path = "show cpu",
  .short_help = "Show cpu information",
  .function = show_cpu,
}

(constructor) VLIB_CLI_COMMAND (show_cpu_command)

Definition at line 974 of file cli.c.

◆ show_memory_usage_command

vlib_cli_command_t show_memory_usage_command

static

Initial value:

= {
  .path = "show memory",
  .short_help = "show memory [api-segment][stats-segment][verbose]",
  .function = show_memory_usage,
}

(constructor) VLIB_CLI_COMMAND (show_memory_usage_command)

Definition at line 941 of file cli.c.

◆ suspend_command

vlib_cli_command_t suspend_command

static

Initial value:

=
{
  .path = "suspend",
  .short_help = "suspend debug CLI for 30ms",
  .function = suspend_command_fn,
  .is_mp_safe = 1,
}

(constructor) VLIB_CLI_COMMAND (suspend_command)

Definition at line 1675 of file cli.c.

◆ vlib_cli_clear_command

vlib_cli_command_t vlib_cli_clear_command

static

Initial value:

= {
  .path = "clear",
  .short_help = "Clear commands",
}

(constructor) VLIB_CLI_COMMAND (vlib_cli_clear_command)

Definition at line 65 of file cli.c.

◆ vlib_cli_set_command

vlib_cli_command_t vlib_cli_set_command

static

Initial value:

= {
  .path = "set",
  .short_help = "Set commands",
}

(constructor) VLIB_CLI_COMMAND (vlib_cli_set_command)

Definition at line 73 of file cli.c.

◆ vlib_cli_show_command

vlib_cli_command_t vlib_cli_show_command

static

Initial value:

= {
  .path = "show",
  .short_help = "Show commands",
}

(constructor) VLIB_CLI_COMMAND (vlib_cli_show_command)

Definition at line 57 of file cli.c.

◆ vlib_cli_test_command

vlib_cli_command_t vlib_cli_test_command

static

Initial value:

= {
  .path = "test",
  .short_help = "Test commands",
}

(constructor) VLIB_CLI_COMMAND (vlib_cli_test_command)

Definition at line 81 of file cli.c.

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ add_sub_command()

◆ all_subs()

◆ cli_recursive_walk()

◆ elog_trace_command_fn()

◆ enable_disable_memory_trace()

◆ format_mp_safe()

◆ format_vlib_cli_command_help()

◆ format_vlib_cli_parse_rule_name()

◆ format_vlib_cli_path()

◆ get_sub_command()

◆ parent_path_len()

◆ restart_cmd_fn()

◆ show_cli_command_fn()

◆ show_cpu()

◆ show_memory_usage()

◆ sort_cmds_by_path()

◆ suspend_command_fn()

◆ test_heap_validate()

◆ unformat_vlib_cli_sub_command()

◆ unformat_vlib_cli_sub_input()

◆ vl_api_get_elog_trace_api_messages()

◆ vl_api_set_elog_trace_api_messages()

◆ vl_msg_pop_heap()

◆ vl_msg_push_heap()

◆ vlib_cli_cmp_command()

◆ vlib_cli_cmp_rule()

◆ vlib_cli_cmp_strings()

◆ vlib_cli_command_is_empty()

◆ vlib_cli_dispatch_sub_commands()

◆ vlib_cli_get_possible_completions()

◆ vlib_cli_init()

◆ vlib_cli_input()

◆ vlib_cli_make_parent()

◆ vlib_cli_normalize_path()

◆ vlib_cli_output()

◆ vlib_cli_register()

◆ vlib_cli_register_parse_rule()

◆ vlib_cli_sub_command_match()

◆ vlib_stats_push_heap()

◆ vlib_unix_error_report()

Variable Documentation

◆ cmd_test_heap_validate

◆ current_traced_heap

◆ elog_trace_command

◆ enable_disable_memory_trace_command

◆ restart_cmd

◆ show_cli_command

◆ show_cpu_command

◆ show_memory_usage_command

◆ suspend_command

◆ vlib_cli_clear_command

◆ vlib_cli_set_command

◆ vlib_cli_show_command

◆ vlib_cli_test_command