Internal commands for the server. More...

#include <freeradius-devel/server/command.h>
#include <freeradius-devel/server/log.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/skip.h>

Include dependency graph for command.c:

Go to the source code of this file.

Data Structures
struct	fr_cmd_argv_s

struct	fr_cmd_s

struct	fr_cmd_stack_t
	A stack for walking commands. More...

Macros
#define	FR_TYPE_ALTERNATE FR_TYPE_VSA

#define	FR_TYPE_ALTERNATE_CHOICE FR_TYPE_GROUP

#define	FR_TYPE_FIXED FR_TYPE_TIME_DELTA

#define	FR_TYPE_OPTIONAL FR_TYPE_STRUCT

#define	FR_TYPE_VARARGS FR_TYPE_TLV

#define	MATCHED_NAME ((!p \|\| isspace((uint8_t) p)) && !*q)

#define	MATCHED_START ((text + start) >= word) && ((text + start) <= p)

#define	SKIP_NAME(name)

#define	TOO_FAR (p && (q > *p))

Typedefs
typedef struct fr_cmd_argv_s	fr_cmd_argv_t

Functions
static int	expand_all (fr_cmd_t cmd, fr_cmd_info_t info, fr_cmd_argv_t argv, int count, int max_expansions, char const *expansions)

static int	expand_syntax (fr_cmd_t cmd, fr_cmd_info_t info, fr_cmd_argv_t argv, char const text, int start, char const word_p, int count, int max_expansions, char const expansions)

int	fr_command_add (TALLOC_CTX talloc_ctx, fr_cmd_t head, char const name, void ctx, fr_cmd_table_t const table)
	Add one command to the global command tree.

int	fr_command_add_multi (TALLOC_CTX talloc_ctx, fr_cmd_t head, char const name, void ctx, fr_cmd_table_t const table)
	Add multiple commands to the global command tree.

static int	fr_command_add_syntax (TALLOC_CTX ctx, char syntax, fr_cmd_argv_t **head, bool allow_varargs)

static fr_cmd_t *	fr_command_alloc (TALLOC_CTX ctx, fr_cmd_t head, char const name)
	Allocate an fr_cmd_t structure.

int	fr_command_clear (int new_argc, fr_cmd_info_t *info)
	Clear out any value boxes etc.

int	fr_command_complete (fr_cmd_t head, char const text, int start, int max_expansions, char const **expansions)
	Do readline-style command completions.

void	fr_command_debug (FILE fp, fr_cmd_t head)

static void	fr_command_debug_internal (FILE fp, fr_cmd_t head, int depth)

static void	fr_command_debug_node (FILE fp, fr_cmd_t cmd, int depth)

static fr_cmd_t *	fr_command_find (fr_cmd_t *head, char const name, fr_cmd_t ***insert)
	Find a command.

char const *	fr_command_help (fr_cmd_t head, int argc, char argv[])
	Get help text for a particular command.

void	fr_command_info_init (TALLOC_CTX ctx, fr_cmd_info_t info)
	Initialize an fr_cmd_info_t structure.

void	fr_command_list (FILE fp, int max_depth, fr_cmd_t head, int options)

static void	fr_command_list_internal (FILE fp, fr_cmd_t head, int depth, int max_depth, char const **argv, int options)

static void	fr_command_list_node (FILE fp, fr_cmd_t cmd, int depth, char const **argv, int options)

int	fr_command_print_help (FILE fp, fr_cmd_t head, char const *text)
	Do readline-style help completions.

static int	fr_command_register (UNUSED TALLOC_CTX talloc_ctx, UNUSED char const name, UNUSED void ctx, UNUSED fr_cmd_table_t table)

int	fr_command_run (FILE fp, FILE fp_err, fr_cmd_info_t *info, bool read_only)
	Run a particular command.

static int	fr_command_run_partial (FILE fp, FILE fp_err, fr_cmd_info_t info, bool read_only, int offset, fr_cmd_t head)

int	fr_command_str_to_argv (fr_cmd_t head, fr_cmd_info_t info, char const *text)
	Split a string in-place, updating argv[].

bool	fr_command_strncmp (const char word, const char name)

int	fr_command_tab_expand (TALLOC_CTX ctx, fr_cmd_t head, fr_cmd_info_t info, int max_expansions, char const *expansions)
	Get the commands && help at a particular level.

static int	fr_command_tab_expand_argv (TALLOC_CTX ctx, fr_cmd_t cmd, fr_cmd_info_t info, char const name, fr_cmd_argv_t argv, int max_expansions, char const *expansions)

static int	fr_command_tab_expand_partial (fr_cmd_t head, char const partial, int max_expansions, char const **expansions)

static int	fr_command_tab_expand_syntax (TALLOC_CTX ctx, fr_cmd_t cmd, int syntax_offset, fr_cmd_info_t info, int max_expansions, char const *expansions)

static bool	fr_command_valid_name (char const *name)

static bool	fr_command_valid_syntax (fr_cmd_argv_t *argv)

static int	fr_command_verify_argv (fr_cmd_info_t info, int start, int verify, int argc, fr_cmd_argv_t *argv_p, bool optional)

int	fr_command_walk (fr_cmd_t head, void walk_ctx, void ctx, fr_cmd_walk_t callback)
	Walk over a command hierarchy.

static void	print_help (FILE fp, fr_cmd_t cmd)

static char const *	skip_word (char const *text)

static int	split (char input, char output, bool syntax_string)

static int	split_alternation (char input, char output)

static int	syntax_str_to_argv (int start_argc, fr_cmd_argv_t start, fr_cmd_info_t info, char const *text, bool runnable)
	Check the syntax of a command, starting at `*text`

Variables
fr_command_register_hook_t	fr_command_register_hook = fr_command_register

static const char *	tabs = "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t"

Detailed Description

Internal commands for the server.

Id: b6a0c541f011f3d71a27a4eeb28f3b0fedac71b3

Copyright: 2018 The FreeRADIUS server project; 2018 Alan DeKok (aland.nosp@m.@fre.nosp@m.eradi.nosp@m.us.o.nosp@m.rg)

Definition in file command.c.

Data Structure Documentation

◆ fr_cmd_argv_s

struct fr_cmd_argv_s

Definition at line 45 of file command.c.

Collaboration diagram for fr_cmd_argv_s:

Data Fields
fr_cmd_argv_t *	child
char const *	name
fr_cmd_argv_t *	next
fr_type_t	type

◆ fr_cmd_s

struct fr_cmd_s

Definition at line 52 of file command.c.

Collaboration diagram for fr_cmd_s:

Data Fields
bool	added_name	was this name added?
struct fr_cmd_s *	child	if there are subcommands
void *	ctx
fr_cmd_func_t	func
char const *	help	Todo: long / short help
bool	intermediate	intermediate commands can't have callbacks
bool	live	is this entry live?
char const *	name
struct fr_cmd_s *	next
bool	read_only
char const *	syntax	only for terminal nodes
fr_cmd_argv_t *	syntax_argv	arguments and types
fr_cmd_tab_t	tab_expand

◆ fr_cmd_stack_t

struct fr_cmd_stack_t

A stack for walking commands.

Definition at line 1007 of file command.c.

Collaboration diagram for fr_cmd_stack_t:

Data Fields
int	depth
fr_cmd_t *	entry[CMD_MAX_ARGV]
char const **	parents

Macro Definition Documentation

◆ FR_TYPE_ALTERNATE

#define FR_TYPE_ALTERNATE FR_TYPE_VSA

Definition at line 88 of file command.c.

◆ FR_TYPE_ALTERNATE_CHOICE

#define FR_TYPE_ALTERNATE_CHOICE FR_TYPE_GROUP

Definition at line 89 of file command.c.

◆ FR_TYPE_FIXED

#define FR_TYPE_FIXED FR_TYPE_TIME_DELTA

Definition at line 84 of file command.c.

◆ FR_TYPE_OPTIONAL

#define FR_TYPE_OPTIONAL FR_TYPE_STRUCT

Definition at line 87 of file command.c.

◆ FR_TYPE_VARARGS

#define FR_TYPE_VARARGS FR_TYPE_TLV

Definition at line 86 of file command.c.

◆ MATCHED_NAME

#define MATCHED_NAME ((!*p || isspace((uint8_t) *p)) && !*q)

Definition at line 1372 of file command.c.

◆ MATCHED_START

#define MATCHED_START ((text + start) >= word) && ((text + start) <= p)

Definition at line 1374 of file command.c.

◆ SKIP_NAME

#define SKIP_NAME ( name )

Value:

                                do { p = word; q = name; while (*p && *q && (*p == *q)) { \
                                p++; \
                                q++; \
                        } } while (0)

Definition at line 1368 of file command.c.

◆ TOO_FAR

#define TOO_FAR (*p && (*q > *p))

Definition at line 1373 of file command.c.

Typedef Documentation

◆ fr_cmd_argv_t

typedef struct fr_cmd_argv_s fr_cmd_argv_t

Definition at line 44 of file command.c.

Function Documentation

◆ expand_all()

static int expand_all	(	fr_cmd_t *	cmd,
		fr_cmd_info_t *	info,
		fr_cmd_argv_t *	argv,
		int	count,
		int	max_expansions,
		char const **	expansions
	)

static

Definition at line 2417 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ expand_syntax()

static int expand_syntax	(	fr_cmd_t *	cmd,
		fr_cmd_info_t *	info,
		fr_cmd_argv_t *	argv,
		char const *	text,
		int	start,
		char const **	word_p,
		int	count,
		int	max_expansions,
		char const **	expansions
	)

static

Definition at line 2478 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_add()

int fr_command_add	(	TALLOC_CTX *	talloc_ctx,
		fr_cmd_t **	head,
		char const *	name,
		void *	ctx,
		fr_cmd_table_t const *	table
	)

Add one command to the global command tree.

We do not do any sanity checks on "name". If it has spaces in it, or "special" characters, that's up to you. We assume that other things in the server will sanity check them.

Parameters

talloc_ctx	the talloc context
head	pointer to the head of the command table.
name	of the command to allocate. Can be NULL for "top level" commands
ctx	for any callback function
table	of information about the current command

Returns

<0 on error
0 on success

Definition at line 733 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_add_multi()

int fr_command_add_multi	(	TALLOC_CTX *	talloc_ctx,
		fr_cmd_t **	head,
		char const *	name,
		void *	ctx,
		fr_cmd_table_t const *	table
	)

Add multiple commands to the global command tree.

e.g. for module "foo", add "show module foo", "set module foo", etc.

Parameters

talloc_ctx	the talloc context
head	pointer to the head of the command table.
name	of the command to allocate
ctx	for any callback function
table	array of tables, terminated by "help == NULL"

Returns

<0 on error
0 on success

Definition at line 993 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_add_syntax()

static int fr_command_add_syntax	(	TALLOC_CTX *	ctx,
		char *	syntax,
		fr_cmd_argv_t **	head,
		bool	allow_varargs
	)

static

Definition at line 561 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_alloc()

static fr_cmd_t * fr_command_alloc	(	TALLOC_CTX *	ctx,
		fr_cmd_t **	head,
		char const *	name
	)

static

Allocate an fr_cmd_t structure.

We presume that this allocation is done after a call to fr_command_find()

Parameters

ctx	talloc ctx for the allocation
head	of the command list (singly linked)
name	of the command to allocate

Returns

fr_cmd_t structure which has been allocated. Only "name" is filled in.

Definition at line 158 of file command.c.

Here is the caller graph for this function:

◆ fr_command_clear()

int fr_command_clear	(	int	new_argc,
		fr_cmd_info_t *	info
	)

Clear out any value boxes etc.

Parameters

new_argc	the argc to set inside of info
info	the information with the current argc

Definition at line 2377 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_complete()

int fr_command_complete	(	fr_cmd_t *	head,
		char const *	text,
		int	start,
		int	max_expansions,
		char const **	expansions
	)

Do readline-style command completions.

Most useful as part of readline tab expansions. The expansions are strdup() strings, and MUST be free'd by the caller.

Parameters

	head	of the command tree
	text	the text to check
	start	offset in the text where the completions should start
	max_expansions	how many entries in the "expansions" array.
[in,out]	expansions	where the expansions are stored.

Returns

<0 on error
>= 0 number of expansions in the array

Definition at line 2667 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_debug()

void fr_command_debug	(	FILE *	fp,
		fr_cmd_t *	head
	)

Definition at line 1610 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_debug_internal()

static void fr_command_debug_internal	(	FILE *	fp,
		fr_cmd_t *	head,
		int	depth
	)

static

Definition at line 1598 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_debug_node()

static void fr_command_debug_node	(	FILE *	fp,
		fr_cmd_t *	cmd,
		int	depth
	)

static

Definition at line 1591 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_find()

static fr_cmd_t * fr_command_find	(	fr_cmd_t **	head,
		char const *	name,
		fr_cmd_t ***	insert
	)

static

Find a command.

Parameters

head	the head of the list
name	of the command to find
insert	where the new command should be inserted

Returns

NULL for "not found". In which case "head" is the insertion point for the new command
!NULL for the command which was found.

Definition at line 100 of file command.c.

Here is the caller graph for this function:

◆ fr_command_help()

char const * fr_command_help	(	fr_cmd_t *	head,
		int	argc,
		char *	argv[]
	)

Get help text for a particular command.

Parameters

head	the head of the hierarchy.
argc	the number of arguments in argv
argv	the arguments

Returns

NULL on "no help text"
!NULL is the help text. Do not free or access it.

Definition at line 1561 of file command.c.

Here is the call graph for this function:

◆ fr_command_info_init()

void fr_command_info_init	(	TALLOC_CTX *	ctx,
		fr_cmd_info_t *	info
	)

Initialize an fr_cmd_info_t structure.

Definition at line 2405 of file command.c.

Here is the caller graph for this function:

◆ fr_command_list()

void fr_command_list	(	FILE *	fp,
		int	max_depth,
		fr_cmd_t *	head,
		int	options
	)

Definition at line 1657 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_list_internal()

static void fr_command_list_internal	(	FILE *	fp,
		fr_cmd_t *	head,
		int	depth,
		int	max_depth,
		char const **	argv,
		int	options
	)

static

Definition at line 1639 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_list_node()

static void fr_command_list_node	(	FILE *	fp,
		fr_cmd_t *	cmd,
		int	depth,
		char const **	argv,
		int	options
	)

static

Definition at line 1616 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_print_help()

int fr_command_print_help	(	FILE *	fp,
		fr_cmd_t *	head,
		char const *	text
	)

Do readline-style help completions.

Most useful as part of readline.

Parameters

fp	where the help is printed
head	of the command tree
text	the text to check

Definition at line 2810 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_register()

static int fr_command_register	(	UNUSED TALLOC_CTX *	talloc_ctx,
		UNUSED char const *	name,
		UNUSED void *	ctx,
		UNUSED fr_cmd_table_t *	table
	)

static

Definition at line 37 of file command.c.

◆ fr_command_run()

int fr_command_run	(	FILE *	fp,
		FILE *	fp_err,
		fr_cmd_info_t *	info,
		bool	read_only
	)

Run a particular command.

info->argc is left alone, as are all other fields. If you want to run multiple commands, call fr_command_clear(0, info) to zero out the relevant information.

Parameters

fp	where the output is sent
fp_err	where the error output is sent
info	the structure describing the command to expand
read_only	whether or not this command should be run in read-only mode.

Returns

<0 on error
0 the command was run successfully

Definition at line 1481 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_run_partial()

static int fr_command_run_partial	(	FILE *	fp,
		FILE *	fp_err,
		fr_cmd_info_t *	info,
		bool	read_only,
		int	offset,
		fr_cmd_t *	head
	)

static

Definition at line 1376 of file command.c.

Here is the caller graph for this function:

◆ fr_command_str_to_argv()

int fr_command_str_to_argv	(	fr_cmd_t *	head,
		fr_cmd_info_t *	info,
		char const *	text
	)

Split a string in-place, updating argv[].

This function also respects the various data types (mostly). Strings can have quotes. Nothing else can have quotes. Non-string data types are skipped and only parsed to data types by fr_command_run().

Parameters

head	the head of the hierarchy.
info	the structure describing the command to expand
text	the string to split

Returns

<0 on error.
total number of arguments in the argv[] array. Always >= argc.

Definition at line 2149 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_strncmp()

bool fr_command_strncmp	(	const char *	word,
		const char *	name
	)

Definition at line 2914 of file command.c.

Here is the caller graph for this function:

◆ fr_command_tab_expand()

int fr_command_tab_expand	(	TALLOC_CTX *	ctx,
		fr_cmd_t *	head,
		fr_cmd_info_t *	info,
		int	max_expansions,
		char const **	expansions
	)

Get the commands && help at a particular level.

Parameters

ctx	talloc context for dynamically allocated expansions. The caller should free it to free all expansions it created. Expansions added by this function are "const char *", and are managed by the command hierarchy.
head	the head of the hierarchy.
info	the structure describing the command to expand
max_expansions	the maximum number of entries in the expansions array
expansions	where the expansions will be stored.

Returns

<0 on error
number of entries in the expansions array

Definition at line 1298 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_tab_expand_argv()

static int fr_command_tab_expand_argv	(	TALLOC_CTX *	ctx,
		fr_cmd_t *	cmd,
		fr_cmd_info_t *	info,
		char const *	name,
		fr_cmd_argv_t *	argv,
		int	max_expansions,
		char const **	expansions
	)

static

Definition at line 1166 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_tab_expand_partial()

static int fr_command_tab_expand_partial	(	fr_cmd_t *	head,
		char const *	partial,
		int	max_expansions,
		char const **	expansions
	)

static

Definition at line 1145 of file command.c.

Here is the caller graph for this function:

◆ fr_command_tab_expand_syntax()

static int fr_command_tab_expand_syntax	(	TALLOC_CTX *	ctx,
		fr_cmd_t *	cmd,
		int	syntax_offset,
		fr_cmd_info_t *	info,
		int	max_expansions,
		char const **	expansions
	)

static

Definition at line 1270 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_valid_name()

static bool fr_command_valid_name ( char const * name )

static

Definition at line 182 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_valid_syntax()

static bool fr_command_valid_syntax ( fr_cmd_argv_t * argv )

static

Definition at line 212 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_verify_argv()

static int fr_command_verify_argv	(	fr_cmd_info_t *	info,
		int	start,
		int	verify,
		int	argc,
		fr_cmd_argv_t **	argv_p,
		bool	optional
	)

static

Definition at line 1680 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fr_command_walk()

int fr_command_walk	(	fr_cmd_t *	head,
		void **	walk_ctx,
		void *	ctx,
		fr_cmd_walk_t	callback
	)

Walk over a command hierarchy.

Parameters

	head	the head of the hierarchy. Call it with NULL to clean up `walk_ctx`
[in,out]	walk_ctx	to track across multiple function calls. MUST point to a `void*` when starting
	ctx	for the callback
	callback	to call with fr_walk_info_t about each command

Returns

<0 on error
0 for nothing more to do.
1 for "please call me again to get the next command". and walk_ctx now points to data allocated by, and managed by this function. It MUST be cleaned up via another call to this function.

Definition at line 1027 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print_help()

static void print_help	(	FILE *	fp,
		fr_cmd_t *	cmd
	)

static

Definition at line 2793 of file command.c.

Here is the caller graph for this function:

◆ skip_word()

static char const * skip_word ( char const * text )

static

Definition at line 1880 of file command.c.

Here is the caller graph for this function:

◆ split()

static int split	(	char **	input,
		char **	output,
		bool	syntax_string
	)

static

Definition at line 393 of file command.c.

Here is the caller graph for this function:

◆ split_alternation()

static int split_alternation	(	char **	input,
		char **	output
	)

static

Definition at line 276 of file command.c.

Here is the caller graph for this function:

◆ syntax_str_to_argv()

static int syntax_str_to_argv	(	int	start_argc,
		fr_cmd_argv_t *	start,
		fr_cmd_info_t *	info,
		char const **	text,
		bool *	runnable
	)

static

Check the syntax of a command, starting at *text

Note that we don't keep a stack of where we are for partial commands. So we MUST re-parse the ENTIRE input every time.

Definition at line 1912 of file command.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ fr_command_register_hook

fr_command_register_hook_t fr_command_register_hook = fr_command_register

Definition at line 42 of file command.c.

◆ tabs

const char* tabs = "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t"

static

Definition at line 1589 of file command.c.

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Data Structure Documentation

◆ fr_cmd_argv_s

◆ fr_cmd_s

◆ fr_cmd_stack_t

Macro Definition Documentation

◆ FR_TYPE_ALTERNATE

◆ FR_TYPE_ALTERNATE_CHOICE

◆ FR_TYPE_FIXED

◆ FR_TYPE_OPTIONAL

◆ FR_TYPE_VARARGS

◆ MATCHED_NAME

◆ MATCHED_START

◆ SKIP_NAME

◆ TOO_FAR

Typedef Documentation

◆ fr_cmd_argv_t

Function Documentation

◆ expand_all()

◆ expand_syntax()

◆ fr_command_add()

◆ fr_command_add_multi()

◆ fr_command_add_syntax()

◆ fr_command_alloc()

◆ fr_command_clear()

◆ fr_command_complete()

◆ fr_command_debug()

◆ fr_command_debug_internal()

◆ fr_command_debug_node()

◆ fr_command_find()

◆ fr_command_help()

◆ fr_command_info_init()

◆ fr_command_list()

◆ fr_command_list_internal()

◆ fr_command_list_node()

◆ fr_command_print_help()

◆ fr_command_register()

◆ fr_command_run()

◆ fr_command_run_partial()

◆ fr_command_str_to_argv()

◆ fr_command_strncmp()

◆ fr_command_tab_expand()

◆ fr_command_tab_expand_argv()

◆ fr_command_tab_expand_partial()

◆ fr_command_tab_expand_syntax()

◆ fr_command_valid_name()

◆ fr_command_valid_syntax()

◆ fr_command_verify_argv()

◆ fr_command_walk()

◆ print_help()

◆ skip_word()

◆ split()

◆ split_alternation()

◆ syntax_str_to_argv()

Variable Documentation

◆ fr_command_register_hook

◆ tabs