Functions for building and managing the structure of internal format config items. More...

#include <string.h>
#include <freeradius-devel/server/cf_file.h>
#include <freeradius-devel/server/cf_priv.h>
#include <freeradius-devel/server/log.h>
#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/atexit.h>
#include <freeradius-devel/util/sbuff.h>

Include dependency graph for cf_util.c:

Go to the source code of this file.

Macros
#define	FILENAME_TRUNCATE 60

#define	IS_WILDCARD(_ident) (_ident == CF_IDENT_ANY)

Functions
static int	_cd_free (CONF_DATA *cd)
	Free user data associated with CONF_DATA.

void	_cf_canonicalize_error (CONF_ITEM ci, ssize_t slen, char const msg, char const *str)

CONF_DATA const *	_cf_data_add (CONF_ITEM ci, void const data, char const name, bool do_free, char const filename, int lineno)
	Add talloced user data to a config section.

CONF_DATA const *	_cf_data_add_static (CONF_ITEM ci, void const data, char const type, char const name, char const *filename, int lineno)
	Add non-talloced user data to a config section.

CONF_DATA const *	_cf_data_find (CONF_ITEM const ci, char const type, char const *name)
	Find user data in a config section.

CONF_DATA *	_cf_data_find_in_parent (CONF_ITEM const ci, char const type, char const *name)
	Find matching data in the specified section or one of its parents.

CONF_DATA const *	_cf_data_find_next (CONF_ITEM const ci, CONF_ITEM const prev, char const type, char const name)
	Return the next item of user data.

void *	_cf_data_remove (CONF_ITEM parent, CONF_DATA const cd)
	Remove data from a configuration section.

int	_cf_data_walk (CONF_ITEM ci, char const type, cf_walker_t cb, void *ctx)
	Walk over a specific type of CONF_DATA.

bool	_cf_expand_variables (void)

char const *	_cf_filename (CONF_ITEM const *ci)
	Return the filename the CONF_ITEM was parsed in.

void	_cf_filename_set (CONF_ITEM ci, char const filename)
	Set the filename of a CONF_ITEM.

static fr_cmp_ret_t	_cf_ident1_cmp (void const one, void const two)
	Compare the first identifier of a child.

static fr_cmp_ret_t	_cf_ident2_cmp (void const a, void const b)
	Compare the first and second identifiers of a child.

int	_cf_item_add (CONF_ITEM parent, CONF_ITEM child)
	Add a child.

void	_cf_item_debug (CONF_ITEM const *ci)
	Print out debugging information about a CONFIG_ITEM.

bool	_cf_item_is_parsed (CONF_ITEM *ci)
	Return whether an item has already been parsed.

void	_cf_item_mark_parsed (CONF_ITEM *ci)
	Mark an item as parsed.

CONF_ITEM *	_cf_item_next (CONF_ITEM const parent, CONF_ITEM const curr)
	Return the next child of the CONF_ITEM.

CONF_ITEM *	_cf_item_prev (CONF_ITEM const ci, CONF_ITEM const curr)
	Return the next child of cs.

CONF_ITEM *	_cf_item_remove (CONF_ITEM parent, CONF_ITEM child)
	Remove item from parent and fixup trees.

int	_cf_lineno (CONF_ITEM const *ci)
	Return the lineno the CONF_ITEM was parsed at.

void	_cf_lineno_set (CONF_ITEM *ci, int lineno)
	Set the line number of a CONF_ITEM.

void	_cf_log (fr_log_type_t type, CONF_ITEM const ci, char const file, int line, char const *fmt,...)
	Log an error message relating to a CONF_ITEM.

void	_cf_log_by_child (fr_log_type_t type, CONF_SECTION const parent, char const child, char const file, int line, char const fmt,...)
	Log an error message in the context of a child pair of the specified parent.

void	_cf_log_perr (fr_log_type_t type, CONF_ITEM const ci, char const file, int line, fr_log_perror_format_t const f_rules, char const fmt,...)
	Log an error message relating to a CONF_ITEM.

void	_cf_log_perr_by_child (fr_log_type_t type, CONF_SECTION const parent, char const child, char const file, int line, fr_log_perror_format_t const f_rules, char const *fmt,...)
	Log an error message in the context of a child pair of the specified parent.

void	_cf_log_with_filename (fr_log_type_t type, CONF_ITEM const ci, char const file, int line, char const *fmt,...)
	Log a debug message relating to a CONF_ITEM.

CONF_ITEM *	_cf_parent (CONF_ITEM const *ci)
	Return the parent of a CONF_ITEM.

bool	_cf_preserve_comments (void)

CONF_SECTION *	_cf_root (CONF_ITEM const *ci)
	Return the top level CONF_SECTION holding all other CONF_ITEM.

CONF_SECTION *	_cf_section_alloc (TALLOC_CTX ctx, CONF_SECTION parent, char const name1, char const name2, char const *filename, int lineno)
	Allocate a CONF_SECTION.

CONF_SECTION *	_cf_section_find_in_parent (CONF_ITEM const ci, char const name1, char const *name2)
	Find an ancestor of the passed CONF_ITEM which has a child matching a specific name1 and optionally name2.

CONF_SECTION *	_cf_section_find_parent (CONF_ITEM const ci, char const name1, char const *name2)
	Find a parent CONF_SECTION with name1 and optionally name2.

static int	_cf_section_free (CONF_SECTION *cs)
	Free a section and associated trees.

void	_cf_vlog (fr_log_type_t type, CONF_ITEM const ci, char const file, int line, char const *fmt, va_list ap)
	Log an error message relating to a CONF_ITEM.

void	_cf_vlog_perr (fr_log_type_t type, CONF_ITEM const ci, char const file, int line, fr_log_perror_format_t const f_rules, char const fmt, va_list ap)
	Log an error message relating to a CONF_ITEM.

static void	_pair_count (int count, CONF_SECTION const cs)
	Callback to determine the number of pairs in a section.

CONF_COMMENT *	cf_comment_alloc (CONF_SECTION parent, char const text)
	Allocate a new comment item attached to `parent`.

char const *	cf_comment_text (CONF_COMMENT const *c)

CONF_ITEM *	cf_comment_to_item (CONF_COMMENT const *c)
	Cast a CONF_COMMENT back to a CONF_ITEM.

static CONF_DATA *	cf_data_alloc (CONF_ITEM parent, void const data, char const type, char const name, bool do_free)
	Allocate a new user data container.

CONF_ITEM *	cf_data_to_item (CONF_DATA const *cd)
	Cast CONF_DATA to a CONF_ITEM.

void *	cf_data_value (CONF_DATA const *cd)
	Return the user assigned value of CONF_DATA.

void	cf_expand_variables_set (bool expand)
	Opt out of `${var}` expansion when reading config (default: enabled).

static CONF_ITEM *	cf_find (CONF_ITEM const parent, CONF_ITEM_TYPE type, char const ident1, char const *ident2)
	Return the next child that's of the specified type with the specified identifiers.

static CONF_ITEM *	cf_find_next (CONF_ITEM const parent, CONF_ITEM const prev, CONF_ITEM_TYPE type, char const ident1, char const ident2)
	Return the next child that's of the specified type with the specified identifiers.

static fr_cmp_ret_t	cf_ident2_cmp (void const one, void const two)
	Compare only the second identifier of a child.

void	cf_item_free_children (CONF_ITEM *ci)

static void	cf_item_init (CONF_ITEM ci, CONF_ITEM_TYPE type, CONF_ITEM parent, char const *filename, int lineno)
	Initialize a CONF_ITEM, so we don't have repeated code.

bool	cf_item_is_comment (CONF_ITEM const *ci)
	Determine if CONF_ITEM is a CONF_COMMENT.

bool	cf_item_is_data (CONF_ITEM const *ci)
	Determine if CONF_ITEM is CONF_DATA.

bool	cf_item_is_pair (CONF_ITEM const *ci)
	Determine if CONF_ITEM is a CONF_PAIR.

bool	cf_item_is_section (CONF_ITEM const *ci)
	Determine if CONF_ITEM is a CONF_SECTION.

CONF_COMMENT *	cf_item_to_comment (CONF_ITEM const *ci)
	Cast a CONF_ITEM to a CONF_COMMENT (asserts on type mismatch).

CONF_DATA *	cf_item_to_data (CONF_ITEM const *ci)
	Cast CONF_ITEM to CONF_DATA performing a type check.

CONF_PAIR *	cf_item_to_pair (CONF_ITEM const *ci)
	Cast a CONF_ITEM to a CONF_PAIR.

CONF_SECTION *	cf_item_to_section (CONF_ITEM const *ci)
	Cast a CONF_ITEM to a CONF_SECTION.

static CONF_ITEM *	cf_next (CONF_ITEM const parent, CONF_ITEM const current, CONF_ITEM_TYPE type)
	Return the next child that's of the specified type.

CONF_PAIR *	cf_pair_alloc (CONF_SECTION parent, char const attr, char const *value, fr_token_t op, fr_token_t lhs_quote, fr_token_t rhs_quote)
	Allocate a CONF_PAIR.

char const *	cf_pair_attr (CONF_PAIR const *pair)
	Return the attr of a CONF_PAIR.

fr_token_t	cf_pair_attr_quote (CONF_PAIR const *pair)
	Return the value (lhs) quoting of a pair.

unsigned int	cf_pair_count (CONF_SECTION const cs, char const attr)
	Count the number of times an attribute occurs in a parent section.

unsigned int	cf_pair_count_descendents (CONF_SECTION const *cs)
	Count the number of conf pairs beneath a section.

void	cf_pair_debug (CONF_PAIR *cp)
	Ease of use from debugger.

CONF_PAIR *	cf_pair_dup (CONF_SECTION parent, CONF_PAIR cp, bool copy_meta)
	Duplicate a CONF_PAIR.

CONF_PAIR *	cf_pair_find (CONF_SECTION const cs, char const attr)
	Search for a CONF_PAIR with a specific name.

CONF_PAIR *	cf_pair_find_in_parent (CONF_SECTION const cs, char const attr)
	Find a pair with a name matching attr in the specified section or one of its parents.

CONF_PAIR *	cf_pair_find_next (CONF_SECTION const cs, CONF_PAIR const prev, char const *attr)
	Find a pair with a name matching attr, after specified pair.

CONF_PAIR *	cf_pair_first (CONF_SECTION const *cs)
	Return the first child that's a CONF_PAIR.

int	cf_pair_in_table (int32_t out, fr_table_num_sorted_t const table, size_t table_len, CONF_PAIR *cp)
	Check to see if the CONF_PAIR value is present in the specified table.

CONF_PAIR *	cf_pair_next (CONF_SECTION const cs, CONF_PAIR const curr)
	Return the next child that's a CONF_PAIR.

fr_token_t	cf_pair_operator (CONF_PAIR const *pair)
	Return the operator of a pair.

CONF_PAIR *	cf_pair_prev (CONF_SECTION const cs, CONF_PAIR const curr)
	Return the previous child that's a CONF_PAIR.

int	cf_pair_replace (CONF_SECTION cs, CONF_PAIR cp, char const *value)
	Replace pair value in a given section with the given value.

int	cf_pair_replace_or_add (CONF_SECTION cs, char const ref, char const *value)

CONF_ITEM *	cf_pair_to_item (CONF_PAIR const *cp)
	Cast a CONF_PAIR to a CONF_ITEM.

char const *	cf_pair_value (CONF_PAIR const *pair)
	Return the value of a CONF_PAIR.

fr_token_t	cf_pair_value_quote (CONF_PAIR const *pair)
	Return the value (rhs) quoting of a pair.

void	cf_preserve_comments_set (bool preserve)
	Control whether the CF parser preserves `# ...` comments.

static CONF_ITEM *	cf_prev (CONF_ITEM const parent, CONF_ITEM const current, CONF_ITEM_TYPE type)
	Return the previous child that's of the specified type.

char const *	cf_section_argv (CONF_SECTION const *cs, int argc)
	Return variadic argument at the specified index.

fr_token_t	cf_section_argv_quote (CONF_SECTION const *cs, int argc)
	Return the quoting for one of the variadic arguments.

void	cf_section_debug (CONF_SECTION *cs)
	Ease of use from debugger.

CONF_SECTION *	cf_section_dup (TALLOC_CTX ctx, CONF_SECTION parent, CONF_SECTION const cs, char const name1, char const *name2, bool copy_meta)
	Duplicate a configuration section.

CONF_SECTION *	cf_section_find (CONF_SECTION const cs, char const name1, char const *name2)
	Find a CONF_SECTION with name1 and optionally name2.

CONF_SECTION *	cf_section_find_next (CONF_SECTION const cs, CONF_SECTION const prev, char const name1, char const name2)
	Return the next matching section.

CONF_SECTION *	cf_section_first (CONF_SECTION const *cs)
	Return the first child in a CONF_SECTION.

static unsigned int	cf_section_item_count (CONF_SECTION const cs, unsigned int total)
	Count the items in a section, giving up once the count reaches a limit.

char const *	cf_section_name (CONF_SECTION const *cs)
	Return name2 if set, else name1.

char const *	cf_section_name1 (CONF_SECTION const *cs)
	Return the first identifier of a CONF_SECTION.

char const *	cf_section_name2 (CONF_SECTION const *cs)
	Return the second identifier of a CONF_SECTION.

fr_token_t	cf_section_name2_quote (CONF_SECTION const *cs)
	Return the quoting of the name2 identifier.

fr_cmp_ret_t	cf_section_name_cmp (CONF_SECTION const cs, char const name1, char const *name2)
	Check if a given section matches the specified name1/name2 identifiers.

CONF_SECTION *	cf_section_next (CONF_SECTION const cs, CONF_SECTION const curr)
	Return the next child that's a CONF_SECTION.

CONF_SECTION *	cf_section_prev (CONF_SECTION const cs, CONF_SECTION const curr)
	Return the previous child that's a CONF_SECTION.

CONF_ITEM *	cf_section_to_item (CONF_SECTION const *cs)
	Cast a CONF_SECTION to a CONF_ITEM.

char const *	cf_section_value_find (CONF_SECTION const cs, char const attr)
	Find a pair in a CONF_SECTION.

static void	truncate_filename (char const e, char const p, int len, char const filename)

Variables
static bool	cf_expand_vars = true

static bool	cf_preserve_comments = false

static fr_sbuff_term_t const	ref_char = FR_SBUFF_TERMS(L("."), L("["))

static fr_sbuff_term_t const	ref_char_end = FR_SBUFF_TERMS(L("]"))

Detailed Description

Functions for building and managing the structure of internal format config items.

Id: 82d314f5384ba5d00bd08f480929d6546e077d41

Copyright: 2017 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

Definition in file cf_util.c.

Macro Definition Documentation

◆ FILENAME_TRUNCATE

#define FILENAME_TRUNCATE 60

◆ IS_WILDCARD

#define IS_WILDCARD ( _ident ) (_ident == CF_IDENT_ANY)

Definition at line 76 of file cf_util.c.

Function Documentation

◆ _cd_free()

static int _cd_free ( CONF_DATA * cd )

static

Free user data associated with CONF_DATA.

Parameters

[in] cd being freed.

Returns: 0

Definition at line 1812 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _cf_canonicalize_error()

void _cf_canonicalize_error	(	CONF_ITEM *	ci,
		ssize_t	slen,
		char const *	msg,
		char const *	str
	)

Definition at line 2590 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_data_add()

CONF_DATA const * _cf_data_add	(	CONF_ITEM *	ci,
		void const *	data,
		char const *	name,
		bool	do_free,
		char const *	filename,
		int	lineno
	)

Add talloced user data to a config section.

Parameters

[in]	ci	to add data to.
[in]	data	to add.
[in]	name	String identifier of the user data.
[in]	do_free	Function to free user data when the CONF_SECTION is freed.
[in]	filename	Source file the CONF_DATA was added in.
[in]	lineno	the CONF_DATA was added at.

Returns

CONF_DATA - opaque handle to the stored data - on success.
NULL error.

Definition at line 1945 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_data_add_static()

CONF_DATA const * _cf_data_add_static	(	CONF_ITEM *	ci,
		void const *	data,
		char const *	type,
		char const *	name,
		char const *	filename,
		int	lineno
	)

Add non-talloced user data to a config section.

Parameters

[in]	ci	to add data to.
[in]	data	to add.
[in]	type	identifier of the user data.
[in]	name	String identifier of the user data.
[in]	filename	Source file the CONF_DATA was added in.
[in]	lineno	the CONF_DATA was added at. CONF_DATA - opaque handle to the stored data - on success. NULL error.

Definition at line 1987 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _cf_data_find()

CONF_DATA const * _cf_data_find	(	CONF_ITEM const *	ci,
		char const *	type,
		char const *	name
	)

Find user data in a config section.

Parameters

[in]	ci	The section to search for data in.
[in]	type	of user data. Used for name spacing and walking over a specific type of user data.
[in]	name	String identifier of the user data. Special value CF_IDENT_ANY may be used to match on type only.

Returns

The user data.
NULL if no user data exists.

Definition at line 1869 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _cf_data_find_in_parent()

CONF_DATA * _cf_data_find_in_parent	(	CONF_ITEM const *	ci,
		char const *	type,
		char const *	name
	)

Find matching data in the specified section or one of its parents.

Parameters

[in]	ci	The section to search for data in.
[in]	type	of user data. Used for name spacing and walking over a specific type of user data.
[in]	name	String identifier of the user data. Special value CF_IDENT_ANY may be used to match on type only.

Returns

The next matching CONF_DATA.
NULL if there is no more matching CONF_DATA.

Definition at line 1903 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_data_find_next()

CONF_DATA const * _cf_data_find_next	(	CONF_ITEM const *	ci,
		CONF_ITEM const *	prev,
		char const *	type,
		char const *	name
	)

Return the next item of user data.

Parameters

[in]	ci	The section to search for data in.
[in]	prev	section we found. May be NULL in which case we just return the next section after prev.
[in]	type	of user data. Used for name spacing and walking over a specific type of user data.
[in]	name	String identifier of the user data. Special value CF_IDENT_ANY can be used to match any name2 value.

Returns

The next matching CONF_DATA.
NULL if there is no more matching CONF_DATA.

Definition at line 1887 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_data_remove()

void * _cf_data_remove	(	CONF_ITEM *	parent,
		CONF_DATA const *	cd
	)

Remove data from a configuration section.

Note: If cd was not found it will not be freed, and it is the caller's responsibility to free it explicitly, or free the section it belongs to.

Parameters

[in]	parent	to remove data from.
[in]	cd	opaque handle of the stored data.

Returns

The value stored within the data (if cd is valid and was found and removed).
NULL if not found.

Definition at line 2031 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _cf_data_walk()

int _cf_data_walk	(	CONF_ITEM *	ci,
		char const *	type,
		cf_walker_t	cb,
		void *	ctx
	)

Walk over a specific type of CONF_DATA.

Parameters

[in]	ci	containing the CONF_DATA to walk over.
[in]	type	of CONF_DATA to walk over.
[in]	cb	to call when we find CONF_DATA of the specified type.
[in]	ctx	to pass to cb.

Returns

0 on success.
-1 on failure.

Definition at line 2056 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_expand_variables()

bool _cf_expand_variables ( void )

Definition at line 816 of file cf_util.c.

Here is the caller graph for this function:

◆ _cf_filename()

char const * _cf_filename ( CONF_ITEM const * ci )

Return the filename the CONF_ITEM was parsed in.

Parameters

[in] ci to return the location of.

Returns

NULL if the CONF_ITEM was created programmatically.
The path of the config file the CONF_ITEM was located in.

Definition at line 591 of file cf_util.c.

◆ _cf_filename_set()

void _cf_filename_set	(	CONF_ITEM *	ci,
		char const *	filename
	)

Set the filename of a CONF_ITEM.

Parameters

[in]	ci	to set filename on.
[in]	filename	to set.

Definition at line 977 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_ident1_cmp()

static fr_cmp_ret_t _cf_ident1_cmp	(	void const *	one,
		void const *	two
	)

inlinestatic

Compare the first identifier of a child.

For CONF_ITEM_PAIR this is 'attr'. For CONF_ITEM_SECTION this is 'name1'. For CONF_ITEM_DATA this is 'type'.

Parameters

[in]	one	First CONF_ITEM to compare.
[in]	two	Second CONF_ITEM to compare.

Returns: CMP(one, two)

Definition at line 272 of file cf_util.c.

Here is the caller graph for this function:

◆ _cf_ident2_cmp()

static fr_cmp_ret_t _cf_ident2_cmp	(	void const *	a,
		void const *	b
	)

static

Compare the first and second identifiers of a child.

For CONF_ITEM_SECTION this is 'name2'. For CONF_ITEM_DATA this is 'name'.

Parameters

[in]	a	First CONF_ITEM to compare.
[in]	b	Second CONF_ITEM to compare.

Returns: CMP(a, b)

Definition at line 379 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _cf_item_add()

int _cf_item_add	(	CONF_ITEM *	parent,
		CONF_ITEM *	child
	)

Add a child.

Parameters

[in]	parent	to add child to.
[in]	child	to add.

Definition at line 394 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_item_debug()

void _cf_item_debug ( CONF_ITEM const * ci )

Print out debugging information about a CONFIG_ITEM.

Parameters

[in] ci being debugged.

Definition at line 2437 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_item_is_parsed()

bool _cf_item_is_parsed ( CONF_ITEM * ci )

Return whether an item has already been parsed.

Parameters

[in] ci to check.

Returns

true if item has been parsed.
false if the pair hasn't been parsed.

Definition at line 1589 of file cf_util.c.

◆ _cf_item_mark_parsed()

void _cf_item_mark_parsed ( CONF_ITEM * ci )

Mark an item as parsed.

Parameters

[in] ci to mark as parsed.

Definition at line 1577 of file cf_util.c.

◆ _cf_item_next()

CONF_ITEM * _cf_item_next	(	CONF_ITEM const *	parent,
		CONF_ITEM const *	curr
	)

Return the next child of the CONF_ITEM.

Parameters

[in]	parent	to return children from.
[in]	curr	child to start searching from.

Returns

The next CONF_ITEM that's a child of cs.
NULL if no more CONF_ITEM.

Definition at line 497 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_item_prev()

CONF_ITEM * _cf_item_prev	(	CONF_ITEM const *	ci,
		CONF_ITEM const *	curr
	)

Return the next child of cs.

Parameters

[in]	ci	to return children from.
[in]	curr	child to start searching from.

Returns

The next CONF_ITEM that's a child of cs.
NULL if no more CONF_ITEM.

Definition at line 512 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_item_remove()

CONF_ITEM * _cf_item_remove	(	CONF_ITEM *	parent,
		CONF_ITEM *	child
	)

Remove item from parent and fixup trees.

Parameters

[in]	parent	to remove child from.
[in]	child	to remove.

Returns

The previous item (makes iteration easier)
NULL if the item wasn't set.

Definition at line 434 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _cf_lineno()

int _cf_lineno ( CONF_ITEM const * ci )

Return the lineno the CONF_ITEM was parsed at.

Parameters

[in] ci to return the location of.

Returns

-1 if the CONF_ITEM was created programmatically.
>= 0 where in the config file the line was parsed from.

Definition at line 577 of file cf_util.c.

◆ _cf_lineno_set()

void _cf_lineno_set	(	CONF_ITEM *	ci,
		int	lineno
	)

Set the line number of a CONF_ITEM.

Parameters

[in]	ci	to set the lineno for.
[in]	lineno	to set.

Definition at line 989 of file cf_util.c.

◆ _cf_log()

void _cf_log	(	fr_log_type_t	type,
		CONF_ITEM const *	ci,
		char const *	file,
		int	line,
		char const *	fmt,
			...
	)

Log an error message relating to a CONF_ITEM.

Parameters

[in]	type	of log message.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	ci	CONF_ITEM to print file/lineno for.
[in]	fmt	of the message.
[in]	...	Message args.

Definition at line 2208 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_log_by_child()

void _cf_log_by_child	(	fr_log_type_t	type,
		CONF_SECTION const *	parent,
		char const *	child,
		char const *	file,
		int	line,
		char const *	fmt,
			...
	)

Log an error message in the context of a child pair of the specified parent.

Parameters

[in]	parent	containing the pair.
[in]	child	name to use as a logging context.
[in]	type	of log message.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	fmt	of the message.
[in]	...	Message args.

Definition at line 2382 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_log_perr()

void _cf_log_perr	(	fr_log_type_t	type,
		CONF_ITEM const *	ci,
		char const *	file,
		int	line,
		fr_log_perror_format_t const *	f_rules,
		char const *	fmt,
			...
	)

Log an error message relating to a CONF_ITEM.

Drains the fr_strerror() stack emitting one or more error messages.

Parameters

[in]	type	of log message.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	ci	CONF_ITEM to print file/lineno for.
[in]	f_rules	Additional optional formatting controls.
[in]	fmt	of the message.
[in]	...	Message args.

Definition at line 2320 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_log_perr_by_child()

void _cf_log_perr_by_child	(	fr_log_type_t	type,
		CONF_SECTION const *	parent,
		char const *	child,
		char const *	file,
		int	line,
		fr_log_perror_format_t const *	f_rules,
		char const *	fmt,
			...
	)

Log an error message in the context of a child pair of the specified parent.

Parameters

[in]	parent	containing the pair.
[in]	child	name to use as a logging context.
[in]	type	of log message.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	f_rules	Line prefixes.
[in]	fmt	of the message.
[in]	...	Message args.

Definition at line 2413 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_log_with_filename()

void _cf_log_with_filename	(	fr_log_type_t	type,
		CONF_ITEM const *	ci,
		char const *	file,
		int	line,
		char const *	fmt,
			...
	)

Log a debug message relating to a CONF_ITEM.

Always emits a filename/lineno prefix if available

Parameters

[in]	type	of log message.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	ci	CONF_ITEM to print file/lineno for.
[in]	fmt	of the message.
[in]	...	Message args.

Definition at line 2343 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_parent()

CONF_ITEM * _cf_parent ( CONF_ITEM const * ci )

Return the parent of a CONF_ITEM.

Parameters

[in] ci to return the parent of.

Returns

NULL if ci was NULL or it has no parents.
The parent of ci.

Definition at line 563 of file cf_util.c.

◆ _cf_preserve_comments()

bool _cf_preserve_comments ( void )

Definition at line 796 of file cf_util.c.

Here is the caller graph for this function:

◆ _cf_root()

CONF_SECTION * _cf_root ( CONF_ITEM const * ci )

Return the top level CONF_SECTION holding all other CONF_ITEM.

Parameters

[in] ci to traverse up from.

Returns

NULL if ci was NULL.
The top level CONF_SECTION

Definition at line 545 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_section_alloc()

CONF_SECTION * _cf_section_alloc	(	TALLOC_CTX *	ctx,
		CONF_SECTION *	parent,
		char const *	name1,
		char const *	name2,
		char const *	filename,
		int	lineno
	)

Allocate a CONF_SECTION.

Parameters

[in]	ctx	to allocate
[in]	parent	CONF_SECTION to hang this CONF_SECTION off of. If parent is not NULL, the new section will be added as a child.
[in]	name1	Primary name.
[in]	name2	Secondary name.
[in]	filename	Caller file name for debugging. May be overridden later.
[in]	lineno	Caller line number for debugging. May be overridden later.

Returns

NULL on error.
A new CONF_SECTION parented by parent.

Definition at line 870 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_section_find_in_parent()

CONF_SECTION * _cf_section_find_in_parent	(	CONF_ITEM const *	ci,
		char const *	name1,
		char const *	name2
	)

Find an ancestor of the passed CONF_ITEM which has a child matching a specific name1 and optionally name2.

Note: Despite the name, this function also searches in ci for a matching item.

Will walk up the configuration tree, searching in each parent until a matching section is found or we hit the root.

Parameters

[in]	ci	The conf item we're searching back from.
[in]	name1	of the section we're searching for. Special value CF_IDENT_ANY can be used to match any name1 value.
[in]	name2	of the section we're searching for. Special value CF_IDENT_ANY can be used to match any name2 value.

Returns

The first matching subsection.
NULL if no subsections match.

Definition at line 1291 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_section_find_parent()

CONF_SECTION * _cf_section_find_parent	(	CONF_ITEM const *	ci,
		char const *	name1,
		char const *	name2
	)

Find a parent CONF_SECTION with name1 and optionally name2.

Parameters

[in]	ci	The section we're searching in.
[in]	name1	of the section we're searching for. Special value CF_IDENT_ANY can be used to match any name1 value.
[in]	name2	of the section we're searching for. Special value CF_IDENT_ANY can be used to match any name2 value.

Returns

The first matching subsection.
NULL if no subsections match.

Definition at line 1315 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_section_free()

static int _cf_section_free ( CONF_SECTION * cs )

static

Free a section and associated trees.

Parameters

[in] cs to free.

Returns: 0

Definition at line 849 of file cf_util.c.

Here is the caller graph for this function:

◆ _cf_vlog()

void _cf_vlog	(	fr_log_type_t	type,
		CONF_ITEM const *	ci,
		char const *	file,
		int	line,
		char const *	fmt,
		va_list	ap
	)

Log an error message relating to a CONF_ITEM.

Parameters

[in]	type	of log message.
[in]	ci	CONF_ITEM to print file/lineno for.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	fmt	of the message.
[in]	ap	Message args.

Definition at line 2169 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _cf_vlog_perr()

void _cf_vlog_perr	(	fr_log_type_t	type,
		CONF_ITEM const *	ci,
		char const *	file,
		int	line,
		fr_log_perror_format_t const *	f_rules,
		char const *	fmt,
		va_list	ap
	)

Log an error message relating to a CONF_ITEM.

Drains the fr_strerror() stack emitting one or more error messages.

Parameters

[in]	type	of log message.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	ci	CONF_ITEM to print file/lineno for.
[in]	f_rules	Additional optional formatting controls.
[in]	fmt	of the message.
[in]	ap	Message args.

Definition at line 2231 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _pair_count()

static void _pair_count	(	int *	count,
		CONF_SECTION const *	cs
	)

static

Callback to determine the number of pairs in a section.

Parameters

[out]	count	Where we store the number of pairs found.
[in]	cs	we're currently searching in.

Definition at line 1687 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_comment_alloc()

CONF_COMMENT * cf_comment_alloc	(	CONF_SECTION *	parent,
		char const *	text
	)

Allocate a new comment item attached to parent.

Inserted into the parent's ordered children list so it appears between the surrounding pairs/sections at output time. Not indexed by name - comment lookup isn't meaningful.

text is talloc_strduped onto the new node so the caller can free their copy. Returns NULL if allocation fails.

Definition at line 821 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_comment_text()

char const * cf_comment_text ( CONF_COMMENT const * c )

Definition at line 773 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_comment_to_item()

CONF_ITEM * cf_comment_to_item ( CONF_COMMENT const * c )

Cast a CONF_COMMENT back to a CONF_ITEM.

Definition at line 767 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_data_alloc()

static CONF_DATA * cf_data_alloc	(	CONF_ITEM *	parent,
		void const *	data,
		char const *	type,
		char const *	name,
		bool	do_free
	)

static

Allocate a new user data container.

Parameters

[in]	parent	CONF_PAIR, or CONF_SECTION to hang CONF_DATA off of.
[in]	data	being added.
[in]	type	of data being added.
[in]	name	String identifier of the user data.
[in]	do_free	function, called when the parent CONF_SECTION is being freed.

Returns

CONF_DATA on success.
NULL on error.

Definition at line 1828 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_data_to_item()

CONF_ITEM * cf_data_to_item ( CONF_DATA const * cd )

Cast CONF_DATA to a CONF_ITEM.

Parameters

[in] cd to cast.

Returns

The common CONF_ITEM header.
NULL if cd was NULL.

Definition at line 741 of file cf_util.c.

◆ cf_data_value()

void * cf_data_value ( CONF_DATA const * cd )

Return the user assigned value of CONF_DATA.

Parameters

[in] cd to return value of.

Returns: the user data stored within the CONF_DATA.

Definition at line 1922 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_expand_variables_set()

void cf_expand_variables_set ( bool expand )

Opt out of ${var} expansion when reading config (default: enabled).

Utilities that round-trip the source - e.g. radjson2conf rebuilding a fragment from JSON - call this with false so values containing ${...} survive verbatim instead of being resolved against an incomplete tree. $INCLUDE handling is a separate parser path and is unaffected.

Definition at line 811 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_find()

static CONF_ITEM * cf_find	(	CONF_ITEM const *	parent,
		CONF_ITEM_TYPE	type,
		char const *	ident1,
		char const *	ident2
	)

static

Return the next child that's of the specified type with the specified identifiers.

Parameters

[in]	parent	The section we're searching in.
[in]	type	of CONF_ITEM we're searching for.
[in]	ident1	The first identifier.
[in]	ident2	The second identifier. Special value CF_IDENT_ANY can be used to match any ident2 value.

Returns

The first matching item.
NULL if no items matched.

Definition at line 89 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_find_next()

static CONF_ITEM * cf_find_next	(	CONF_ITEM const *	parent,
		CONF_ITEM const *	prev,
		CONF_ITEM_TYPE	type,
		char const *	ident1,
		char const *	ident2
	)

static

Return the next child that's of the specified type with the specified identifiers.

Parameters

[in]	parent	The section we're searching in.
[in]	prev	item we found, or NULL to start from the beginning.
[in]	type	of CONF_ITEM we're searching for.
[in]	ident1	The first identifier.
[in]	ident2	The second identifier. Special value CF_IDENT_ANY can be used to match any ident2 value.

Returns

The first matching item.
NULL if no items matched.

Definition at line 186 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_ident2_cmp()

static fr_cmp_ret_t cf_ident2_cmp	(	void const *	one,
		void const *	two
	)

inlinestatic

Compare only the second identifier of a child.

For CONF_ITEM_SECTION this is 'name2'. For CONF_ITEM_DATA this is 'name'.

Parameters

[in]	one	First CONF_ITEM to compare.
[in]	two	Second CONF_ITEM to compare.

Returns: CMP(one,two)

Definition at line 329 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_item_free_children()

void cf_item_free_children ( CONF_ITEM * ci )

Definition at line 2581 of file cf_util.c.

Here is the call graph for this function:

◆ cf_item_init()

static void cf_item_init	(	CONF_ITEM *	ci,
		CONF_ITEM_TYPE	type,
		CONF_ITEM *	parent,
		char const *	filename,
		int	lineno
	)

static

Initialize a CONF_ITEM, so we don't have repeated code.

Parameters

[in]	ci	the CONF_ITEM to initialize
[in]	type	the type to set
[in]	parent	the parent node hosting this one
[in]	filename	which caused this node to be created
[in]	lineno	where in the filename

Definition at line 527 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_item_is_comment()

bool cf_item_is_comment ( CONF_ITEM const * ci )

Determine if CONF_ITEM is a CONF_COMMENT.

Definition at line 750 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_item_is_data()

bool cf_item_is_data ( CONF_ITEM const * ci )

Determine if CONF_ITEM is CONF_DATA.

Parameters

[in] ci to check.

Returns

true if ci is CONF_DATA.
false if ci is another specialisation.

Definition at line 633 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_item_is_pair()

bool cf_item_is_pair ( CONF_ITEM const * ci )

Determine if CONF_ITEM is a CONF_PAIR.

Parameters

[in] ci to check.

Returns

true if ci is a CONF_PAIR.
false if ci is another specialisation.

Definition at line 619 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_item_is_section()

bool cf_item_is_section ( CONF_ITEM const * ci )

Determine if CONF_ITEM is a CONF_SECTION.

Parameters

[in] ci to check.

Returns

true if ci is a CONF_SECTION.
false if ci is another specialisation.

Definition at line 605 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_item_to_comment()

CONF_COMMENT * cf_item_to_comment ( CONF_ITEM const * ci )

Cast a CONF_ITEM to a CONF_COMMENT (asserts on type mismatch).

Definition at line 758 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_item_to_data()

CONF_DATA * cf_item_to_data ( CONF_ITEM const * ci )

Cast CONF_ITEM to CONF_DATA performing a type check.

Note: Will assert if ci does not contain CONF_DATA.

Parameters

[in] ci to cast.

Returns

CONF_DATA.
NULL if ci was NULL.

Definition at line 691 of file cf_util.c.

◆ cf_item_to_pair()

CONF_PAIR * cf_item_to_pair ( CONF_ITEM const * ci )

Cast a CONF_ITEM to a CONF_PAIR.

Note: Will assert if ci does not contain CONF_PAIR.

Parameters

[in] ci to cast.

Returns

CONF_PAIR.
NULL if ci was NULL.

Definition at line 651 of file cf_util.c.

◆ cf_item_to_section()

CONF_SECTION * cf_item_to_section ( CONF_ITEM const * ci )

Cast a CONF_ITEM to a CONF_SECTION.

Note: Will assert if ci does not contain CONF_SECTION.

Parameters

[in] ci to cast.

Returns

CONF_SECTION.
NULL if ci was NULL.

Definition at line 671 of file cf_util.c.

◆ cf_next()

static CONF_ITEM * cf_next	(	CONF_ITEM const *	parent,
		CONF_ITEM const *	current,
		CONF_ITEM_TYPE	type
	)

static

Return the next child that's of the specified type.

Parameters

[in]	parent	to return children from.
[in]	current	child to start searching from.
[in]	type	to search for.

Returns

The next CONF_ITEM that's a child of ci matching type.
NULL if no CONF_ITEM matches that criteria.

Definition at line 48 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_pair_alloc()

CONF_PAIR * cf_pair_alloc	(	CONF_SECTION *	parent,
		char const *	attr,
		char const *	value,
		fr_token_t	op,
		fr_token_t	lhs_quote,
		fr_token_t	rhs_quote
	)

Allocate a CONF_PAIR.

Parameters

[in]	parent	CONF_SECTION to hang this CONF_PAIR off of.
[in]	attr	name.
[in]	value	of CONF_PAIR.
[in]	op	T_OP_EQ, T_OP_SET etc.
[in]	lhs_quote	T_BARE_WORD, T_DOUBLE_QUOTED_STRING, T_BACK_QUOTED_STRING.
[in]	rhs_quote	T_BARE_WORD, T_DOUBLE_QUOTED_STRING, T_BACK_QUOTED_STRING.

Returns

NULL on error.
A new CONF_SECTION parented by parent.

Definition at line 1487 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_attr()

char const * cf_pair_attr ( CONF_PAIR const * pair )

Return the attr of a CONF_PAIR.

Return the LHS value of a pair (the attribute).

Parameters

[in] pair to return the attribute for.

Returns

NULL if the pair was NULL.
The attribute name of the pair.

Definition at line 1742 of file cf_util.c.

◆ cf_pair_attr_quote()

fr_token_t cf_pair_attr_quote ( CONF_PAIR const * pair )

Return the value (lhs) quoting of a pair.

Parameters

pair	to extract value type from.

Returns

Definition at line 1787 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_pair_count()

unsigned int cf_pair_count	(	CONF_SECTION const *	cs,
		char const *	attr
	)

Count the number of times an attribute occurs in a parent section.

Parameters

[in]	cs	to search for items in.
[in]	attr	to search for.

Returns: The number of pairs of that attribute type.

Definition at line 1721 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_count_descendents()

unsigned int cf_pair_count_descendents ( CONF_SECTION const * cs )

Count the number of conf pairs beneath a section.

Parameters

[in] cs to search for items in.

Returns: The number of pairs nested within section.

Definition at line 1706 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_debug()

void cf_pair_debug ( CONF_PAIR * cp )

Ease of use from debugger.

Definition at line 2564 of file cf_util.c.

◆ cf_pair_dup()

CONF_PAIR * cf_pair_dup	(	CONF_SECTION *	parent,
		CONF_PAIR *	cp,
		bool	copy_meta
	)

Duplicate a CONF_PAIR.

Parameters

parent	to allocate new pair in.
cp	to duplicate.
copy_meta	Copy additional meta data for a pair

Returns

NULL on error.
A duplicate of the input pair.

Definition at line 1529 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_find()

CONF_PAIR * cf_pair_find	(	CONF_SECTION const *	cs,
		char const *	attr
	)

Search for a CONF_PAIR with a specific name.

Parameters

[in]	cs	to search in.
[in]	attr	to find.

Returns

The next matching CONF_PAIR.
NULL if none matched.

Definition at line 1640 of file cf_util.c.

Here is the call graph for this function:

◆ cf_pair_find_in_parent()

CONF_PAIR * cf_pair_find_in_parent	(	CONF_SECTION const *	cs,
		char const *	attr
	)

Find a pair with a name matching attr in the specified section or one of its parents.

Parameters

[in]	cs	to search in. Will start in the current section and work upwards.
[in]	attr	to find.

Returns

A matching CONF_PAIR.
NULL if none matched.

Definition at line 1668 of file cf_util.c.

Here is the call graph for this function:

◆ cf_pair_find_next()

CONF_PAIR * cf_pair_find_next	(	CONF_SECTION const *	cs,
		CONF_PAIR const *	prev,
		char const *	attr
	)

Find a pair with a name matching attr, after specified pair.

Parameters

[in]	cs	to search in.
[in]	prev	Pair to search from (may be NULL).
[in]	attr	to find (may be NULL in which case any attribute matches).

Returns

The next matching CONF_PAIR
NULL if none matched.

Definition at line 1654 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_first()

CONF_PAIR * cf_pair_first ( CONF_SECTION const * cs )

Return the first child that's a CONF_PAIR.

Parameters

[in] cs to return children from.

Returns

The first CONF_ITEM that's a child of cs and a CONF_PAIR.
NULL if no CONF_ITEM matches that criteria.

Definition at line 1601 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_in_table()

int cf_pair_in_table	(	int32_t *	out,
		fr_table_num_sorted_t const *	table,
		size_t	table_len,
		CONF_PAIR *	cp
	)

Check to see if the CONF_PAIR value is present in the specified table.

If it's not present, return an error and produce a helpful log message

Parameters

[out]	out	The result of parsing the pair value.
[in]	table	to look for string values in.
[in]	table_len	Length of the table.
[in]	cp	to parse.

Returns

0 on success.
-1 on failure.

Definition at line 2129 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_next()

CONF_PAIR * cf_pair_next	(	CONF_SECTION const *	cs,
		CONF_PAIR const *	curr
	)

Return the next child that's a CONF_PAIR.

Parameters

[in]	cs	to return children from.
[in]	curr	child to start searching from.

Returns

The next CONF_ITEM that's a child of cs and a CONF_PAIR.
NULL if no CONF_ITEM matches that criteria.

Definition at line 1614 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_operator()

fr_token_t cf_pair_operator ( CONF_PAIR const * pair )

Return the operator of a pair.

Parameters

[in] pair to return the operator of.

Returns

T_INVALID if pair was NULL.
T_OP_* (one of the operator constants).

Definition at line 1772 of file cf_util.c.

◆ cf_pair_prev()

CONF_PAIR * cf_pair_prev	(	CONF_SECTION const *	cs,
		CONF_PAIR const *	curr
	)

Return the previous child that's a CONF_PAIR.

Parameters

[in]	cs	to return children from.
[in]	curr	child to start searching from.

Returns

The previous CONF_ITEM that's a child of cs and a CONF_PAIR.
NULL if no CONF_ITEM matches that criteria.

Definition at line 1627 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_replace()

int cf_pair_replace	(	CONF_SECTION *	cs,
		CONF_PAIR *	cp,
		char const *	value
	)

Replace pair value in a given section with the given value.

Note: A new pair with the same metadata as the CONF_PAIR will be added even if the CONF_PAIR can't be found inside the CONF_SECTION.

Parameters

[in]	cs	to replace pair in.
[in]	cp	to replace.
[in]	value	New value to assign to cp.

Returns

0 on success.
-1 on failure.

Definition at line 1561 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_replace_or_add()

int cf_pair_replace_or_add	(	CONF_SECTION *	cs,
		char const *	ref,
		char const *	value
	)

Definition at line 2612 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_to_item()

CONF_ITEM * cf_pair_to_item ( CONF_PAIR const * cp )

Cast a CONF_PAIR to a CONF_ITEM.

Parameters

[in] cp to cast.

Returns

The common CONF_ITEM header.
NULL if cp was NULL.

Definition at line 709 of file cf_util.c.

◆ cf_pair_value()

char const * cf_pair_value ( CONF_PAIR const * pair )

Return the value of a CONF_PAIR.

Return the RHS value of a pair (the value).

Parameters

[in] pair to return the value of.

Returns

NULL if pair was NULL or the pair has no value.
The string value of the pair.

Definition at line 1758 of file cf_util.c.

◆ cf_pair_value_quote()

fr_token_t cf_pair_value_quote ( CONF_PAIR const * pair )

Return the value (rhs) quoting of a pair.

Parameters

pair	to extract value type from.

Returns

Definition at line 1802 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_preserve_comments_set()

void cf_preserve_comments_set ( bool preserve )

Control whether the CF parser preserves # ... comments.

Defaults to off (historical behaviour: comments are dropped at parse time). Utilities that want comments to round-trip through the CF tree should call the setter before cf_file_read(). The runtime server parser never opts in.

Definition at line 786 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_prev()

static CONF_ITEM * cf_prev	(	CONF_ITEM const *	parent,
		CONF_ITEM const *	current,
		CONF_ITEM_TYPE	type
	)

inlinestatic

Return the previous child that's of the specified type.

Parameters

[in]	parent	to return children from.
[in]	current	child to start searching from.
[in]	type	to search for.

Returns

The next CONF_ITEM that's a child of ci matching type.
NULL if no CONF_ITEM matches that criteria.

Definition at line 67 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_section_argv()

char const * cf_section_argv	(	CONF_SECTION const *	cs,
		int	argc
	)

Return variadic argument at the specified index.

Parameters

[in]	cs	containing the arguments.
[in]	argc	Argument index. Note name1 and name2 are not counted in this index.

Returns: the argument value or NULL.

Definition at line 1433 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_section_argv_quote()

fr_token_t cf_section_argv_quote	(	CONF_SECTION const *	cs,
		int	argc
	)

Return the quoting for one of the variadic arguments.

Parameters

[in]	cs	containing the arguments.
[in]	argc	Argument index. Note name1 and name2 are not counted in this index.

Returns

T_BARE_WORD.
T_SINGLE_QUOTED_STRING.
T_BACK_QUOTED_STRING.
T_DOUBLE_QUOTED_STRING.
T_INVALID if cs was NULL or the index was invalid.

Definition at line 1468 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_section_debug()

void cf_section_debug ( CONF_SECTION * cs )

Ease of use from debugger.

Definition at line 2571 of file cf_util.c.

◆ cf_section_dup()

CONF_SECTION * cf_section_dup	(	TALLOC_CTX *	ctx,
		CONF_SECTION *	parent,
		CONF_SECTION const *	cs,
		char const *	name1,
		char const *	name2,
		bool	copy_meta
	)

Duplicate a configuration section.

Note: recursively duplicates any child sections.; does not duplicate any data associated with a section, or its child sections.

Parameters

[in]	ctx	to allocate memory in.
[in]	parent	section (may be NULL).
[in]	cs	to duplicate.
[in]	name1	of new section.
[in]	name2	of new section.
[in]	copy_meta	Copy additional meta data for a section (like template, base, depth, parsed state, and variables).

Returns

A duplicate of the existing section.
NULL on error.

Definition at line 1052 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_section_find()

CONF_SECTION * cf_section_find	(	CONF_SECTION const *	cs,
		char const *	name1,
		char const *	name2
	)

Find a CONF_SECTION with name1 and optionally name2.

Parameters

[in]	cs	The section we're searching in.
[in]	name1	of the section we're searching for. Special value CF_IDENT_ANY can be used to match any name1 value.
[in]	name2	of the section we're searching for. Special value CF_IDENT_ANY can be used to match any name2 value.

Returns

The first matching subsection.
NULL if no subsections match.

Definition at line 1247 of file cf_util.c.

Here is the call graph for this function:

◆ cf_section_find_next()

CONF_SECTION * cf_section_find_next	(	CONF_SECTION const *	cs,
		CONF_SECTION const *	prev,
		char const *	name1,
		char const *	name2
	)

Return the next matching section.

Parameters

[in]	cs	The section we're searching in.
[in]	prev	section we found. May be NULL in which case we just return the next section after prev.
[in]	name1	of the section we're searching for. Special value CF_IDENT_ANY can be used to match any name1 value.
[in]	name2	of the section we're searching for. Special value CF_IDENT_ANY can be used to match any name2 value.

Returns

The next CONF_SECTION.
NULL if there are no more CONF_SECTIONs

Definition at line 1268 of file cf_util.c.

Here is the call graph for this function:

◆ cf_section_first()

CONF_SECTION * cf_section_first ( CONF_SECTION const * cs )

Return the first child in a CONF_SECTION.

Parameters

[in] cs to return children from.

Returns

The next CONF_ITEM that's a child of cs and a CONF_SECTION.
NULL if no CONF_ITEM matches that criteria.

Definition at line 1203 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_section_item_count()

static unsigned int cf_section_item_count	(	CONF_SECTION const *	cs,
		unsigned int *	total
	)

static

Count the items in a section, giving up once the count reaches a limit.

total is the running count, shared by every level of the walk. Each level adds its own children to it, so the caller reads the whole subtree from one variable rather than from a return value which each level would have to add up by hand.

Stopping early is what keeps this cheap. The answer only has to be good enough to compare against the limit, so the walk never costs more than the limit itself, however large the section is.

Parameters

[in]	cs	to count, including everything nested inside it. NULL counts as nothing, because cf_section_dup() is called with a NULL parent.
[in,out]	total	the running count, which the caller sets to 0.

Returns: *total, so that a caller which wants only the answer can take it from here.

Definition at line 1012 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_section_name()

char const * cf_section_name ( CONF_SECTION const * cs )

Return name2 if set, else name1.

Parameters

[in] cs to return identifiers for.

Returns: name1 or name2 identifier.

Definition at line 1417 of file cf_util.c.

Here is the call graph for this function:

◆ cf_section_name1()

char const * cf_section_name1 ( CONF_SECTION const * cs )

Return the first identifier of a CONF_SECTION.

Parameters

[in] cs to return identifiers for.

Returns

The first identifier.
NULL if cs was NULL or no name1 set.

Definition at line 1391 of file cf_util.c.

◆ cf_section_name2()

char const * cf_section_name2 ( CONF_SECTION const * cs )

Return the second identifier of a CONF_SECTION.

Parameters

[in] cs to return identifiers for.

Returns

The second identifier.
NULL if cs was NULL or no name2 set.

Definition at line 1405 of file cf_util.c.

◆ cf_section_name2_quote()

fr_token_t cf_section_name2_quote ( CONF_SECTION const * cs )

Return the quoting of the name2 identifier.

Parameters

[in] cs containing name2.

Returns

Definition at line 1450 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_section_name_cmp()

fr_cmp_ret_t cf_section_name_cmp	(	CONF_SECTION const *	cs,
		char const *	name1,
		char const *	name2
	)

Check if a given section matches the specified name1/name2 identifiers.

Parameters

[in]	cs	to check.
[in]	name1	identifier. May be CF_IDENT_ANY for wildcard matches.
[in]	name2	identifier. May be CF_IDENT_ANY for wildcard matches.

Returns

>1 if cs is greater than the identifiers.
0 if cs matches the identifiers.
<0 if cs is less than the identifiers.

Definition at line 1358 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_section_next()

CONF_SECTION * cf_section_next	(	CONF_SECTION const *	cs,
		CONF_SECTION const *	curr
	)

Return the next child that's a CONF_SECTION.

Parameters

[in]	cs	to return children from.
[in]	curr	child to start searching from.

Returns

The next CONF_ITEM that's a child of cs and a CONF_SECTION.
NULL if no CONF_ITEM matches that criteria.

Definition at line 1216 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_section_prev()

CONF_SECTION * cf_section_prev	(	CONF_SECTION const *	cs,
		CONF_SECTION const *	curr
	)

Return the previous child that's a CONF_SECTION.

Parameters

[in]	cs	to return children from.
[in]	curr	child to start searching from.

Returns

The next CONF_ITEM that's a child of cs and a CONF_SECTION.
NULL if no CONF_ITEM matches that criteria.

Definition at line 1229 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_section_to_item()

CONF_ITEM * cf_section_to_item ( CONF_SECTION const * cs )

Cast a CONF_SECTION to a CONF_ITEM.

Parameters

[in] cs to cast.

Returns

The common CONF_ITEM header.
NULL if cs was NULL.

Definition at line 725 of file cf_util.c.

◆ cf_section_value_find()

char const * cf_section_value_find	(	CONF_SECTION const *	cs,
		char const *	attr
	)

Find a pair in a CONF_SECTION.

Parameters

[in]	cs	the CONF_SECTION to search in.
[in]	attr	to search for.

Returns

NULL if no pair can be found.
The value of the pair found.

Definition at line 1339 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ truncate_filename()

static void truncate_filename	(	char const **	e,
		char const **	p,
		int *	len,
		char const *	filename
	)

inlinestatic

Definition at line 2088 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ cf_expand_vars

bool cf_expand_vars = true

static

Definition at line 809 of file cf_util.c.

◆ cf_preserve_comments

bool cf_preserve_comments = false

static

Definition at line 784 of file cf_util.c.

◆ ref_char

fr_sbuff_term_t const ref_char = FR_SBUFF_TERMS(L("."), L("["))

static

Definition at line 2604 of file cf_util.c.

◆ ref_char_end

fr_sbuff_term_t const ref_char_end = FR_SBUFF_TERMS(L("]"))

static

Definition at line 2605 of file cf_util.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ FILENAME_TRUNCATE

◆ IS_WILDCARD

Function Documentation

◆ _cd_free()

◆ _cf_canonicalize_error()

◆ _cf_data_add()

◆ _cf_data_add_static()

◆ _cf_data_find()

◆ _cf_data_find_in_parent()

◆ _cf_data_find_next()

◆ _cf_data_remove()

◆ _cf_data_walk()

◆ _cf_expand_variables()

◆ _cf_filename()

◆ _cf_filename_set()

◆ _cf_ident1_cmp()

◆ _cf_ident2_cmp()

◆ _cf_item_add()

◆ _cf_item_debug()

◆ _cf_item_is_parsed()

◆ _cf_item_mark_parsed()

◆ _cf_item_next()

◆ _cf_item_prev()

◆ _cf_item_remove()

◆ _cf_lineno()

◆ _cf_lineno_set()

◆ _cf_log()

◆ _cf_log_by_child()

◆ _cf_log_perr()

◆ _cf_log_perr_by_child()

◆ _cf_log_with_filename()

◆ _cf_parent()

◆ _cf_preserve_comments()

◆ _cf_root()

◆ _cf_section_alloc()

◆ _cf_section_find_in_parent()

◆ _cf_section_find_parent()

◆ _cf_section_free()

◆ _cf_vlog()

◆ _cf_vlog_perr()

◆ _pair_count()

◆ cf_comment_alloc()

◆ cf_comment_text()

◆ cf_comment_to_item()

◆ cf_data_alloc()

◆ cf_data_to_item()

◆ cf_data_value()

◆ cf_expand_variables_set()

◆ cf_find()

◆ cf_find_next()

◆ cf_ident2_cmp()

◆ cf_item_free_children()

◆ cf_item_init()

◆ cf_item_is_comment()

◆ cf_item_is_data()

◆ cf_item_is_pair()

◆ cf_item_is_section()

◆ cf_item_to_comment()

◆ cf_item_to_data()

◆ cf_item_to_pair()

◆ cf_item_to_section()

◆ cf_next()

◆ cf_pair_alloc()

◆ cf_pair_attr()

◆ cf_pair_attr_quote()

◆ cf_pair_count()

◆ cf_pair_count_descendents()

◆ cf_pair_debug()

◆ cf_pair_dup()

◆ cf_pair_find()

◆ cf_pair_find_in_parent()

◆ cf_pair_find_next()

◆ cf_pair_first()

◆ cf_pair_in_table()

◆ cf_pair_next()