API to create and manipulate internal format configurations. More...

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
#include <unistd.h>
#include <sys/time.h>
#include <freeradius-devel/util/rb.h>
#include <freeradius-devel/util/table.h>
#include <freeradius-devel/util/token.h>
#include <freeradius-devel/util/log.h>

Include dependency graph for cf_util.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	cf_canonicalize_error(_ci, _slen, _msg, _str) _cf_canonicalize_error(CF_TO_ITEM(_ci), _slen, _msg, _str)

#define	cf_data_add(_cf, _data, _name, _free) _cf_data_add(CF_TO_ITEM(_cf), (void const *) _data, _name, _free, __FILE__, __LINE__)

#define	cf_data_add_static(_cf, _data, _type, _name) _cf_data_add_static(CF_TO_ITEM(_cf), _data, #_type, _name, __FILE__, __LINE__)

#define	cf_data_find(_cf, _type, _name) _cf_data_find(CF_TO_ITEM(_cf), #_type, _name)

#define	cf_data_find_in_parent(_cf, _type, _name) _cf_data_find_in_parent(CF_TO_ITEM(_cf), #_type, _name)

#define	cf_data_find_next(_cf, _prev, _type, _name) _cf_data_find_next(CF_TO_ITEM(_cf), CF_TO_ITEM(_prev), #_type, _name)

#define	cf_data_remove(_cf, _type, _name) _cf_data_remove(CF_TO_ITEM(_cf), cf_data_find(_cf, _type, _name))
	Remove an item from a parent by type and name. More...

#define	cf_data_remove_by_data(_cf, _cd) _cf_data_remove(CF_TO_ITEM(_cf), _cd)
	Remove an item from a parent. More...

#define	cf_data_walk(_cf, _type, _cb, _ctx) _cf_data_walk(CF_TO_ITEM(_cf), #_type, _cb, _ctx)

#define	cf_filename(_cf) _cf_filename(CF_TO_ITEM(_cf))

#define	cf_filename_set(_ci, _filename) _cf_filename_set(CF_TO_ITEM(_ci), _filename)

#define	CF_IDENT_ANY ((void *) (-1))

#define	cf_item_add(_parent, _child) _cf_item_add(CF_TO_ITEM(_parent), CF_TO_ITEM(_child))

#define	cf_item_debug(_cf) _cf_item_debug(CF_TO_ITEM(_cf))

#define	cf_item_insert_after(_parent, _prev, _child) _cf_item_insert_after(CF_TO_ITEM(_parent), CF_TO_ITEM(_prev), CF_TO_ITEM(_child))

#define	cf_item_next(_ci, _curr) _cf_item_next(CF_TO_ITEM(_ci), _curr)

#define	cf_item_prev(_ci, _curr) _cf_item_prev(CF_TO_ITEM(_ci), _curr)

#define	cf_item_remove(_parent, _child) _cf_item_remove(CF_TO_ITEM(_parent), CF_TO_ITEM(_child))

#define	cf_lineno(_cf) _cf_lineno(CF_TO_ITEM(_cf))

#define	cf_lineno_set(_ci, _lineno) _cf_lineno_set(CF_TO_ITEM(_ci), _lineno)

#define	cf_log_debug(_cf, _fmt, ...) _cf_log(L_DBG, CF_TO_ITEM(_cf), __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

#define	cf_log_debug_by_child(_parent, _child, _fmt, ...) _cf_log_by_child(L_DBG, _parent, _child, __FILE__, __LINE__, _fmt, ## __VA_ARGS__)
	Log a debug message against a specified child. More...

#define	cf_log_debug_prefix(_cf, _fmt, ...) _cf_log_with_filename(L_DBG, CF_TO_ITEM(_cf), __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

#define	cf_log_err(_cf, _fmt, ...) _cf_log(L_ERR, CF_TO_ITEM(_cf), __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

#define	cf_log_err_by_child(_parent, _child, _fmt, ...) _cf_log_by_child(L_ERR, _parent, _child, __FILE__, __LINE__, _fmt, ## __VA_ARGS__)
	Log an error message against a specified child. More...

#define	cf_log_info(_cf, _fmt, ...) _cf_log(L_INFO, CF_TO_ITEM(_cf), __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

#define	cf_log_info_by_child(_parent, _child, _fmt, ...) _cf_log_by_child(L_INFO, _parent, _child, __FILE__, __LINE__, _fmt, ## __VA_ARGS__)
	Log an info message against a specified child. More...

#define	cf_log_perr(_cf, _fmt, ...) _cf_log_perr(L_ERR, CF_TO_ITEM(_cf), __FILE__, __LINE__, NULL, _fmt, ## __VA_ARGS__)

#define	cf_log_perr_by_child(_parent, _child, _f_rules, _fmt, ...) _cf_log_perr_by_child(L_ERR, _parent, _child, __FILE__, __LINE__, _f_rules, _fmt, ## __VA_ARGS__)
	Log an error message against a specified child, draining the thread local error stack. More...

#define	cf_log_pwarn(_cf, _fmt, ...) _cf_log_perr(L_WARN, CF_TO_ITEM(_cf), __FILE__, __LINE__, NULL, _fmt, ## __VA_ARGS__)

#define	cf_log_warn(_cf, _fmt, ...) _cf_log(L_WARN, CF_TO_ITEM(_cf), __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

#define	cf_log_warn_by_child(_parent, _child, _fmt, ...) _cf_log_by_child(L_WARN, _parent, _child, __FILE__, __LINE__, _fmt, ## __VA_ARGS__)
	Log a warning message against a specified child. More...

#define	cf_parent(_cf) _cf_parent(CF_TO_ITEM(_cf))

#define	cf_root(_cf) _cf_root(CF_TO_ITEM(_cf))

#define	cf_section_alloc(_ctx, _parent, _name1, _name2) _cf_section_alloc(_ctx, _parent, _name1, _name2, __FILE__, __LINE__)

#define	cf_section_find_in_parent(_cf, _name1, _name2) _cf_section_find_in_parent(CF_TO_ITEM(_cf), _name1, _name2)

#define	cf_section_find_parent(_cf, _name1, _name2) _cf_section_find_parent(CF_TO_ITEM(_cf), _name1, _name2)

#define	cf_section_foreach(_parent, _iter) for (CONF_SECTION *_iter = cf_section_first(_parent); _iter; _iter = cf_section_next(_parent, _iter))

#define	cf_section_free_children(_x) cf_item_free_children(cf_section_to_item(_x))

#define	CF_TO_ITEM(_cf)
	Auto cast from the input type to CONF_ITEM (which is the base type) More...

#define	FR_TIMESPEC_TO_MS(_x) (((_x)->tv_usec / 1000000) + ((_x)->tv_sec * (uint64_t)1000))

#define	FR_TIMEVAL_TO_MS(_x) (((_x)->tv_usec / 1000) + ((_x)->tv_sec * (uint64_t)1000))

Typedefs
typedef int(*	cf_walker_t) (void data, void ctx)

typedef struct cf_data	CONF_DATA
	CONF_ITEM used to associate arbitrary data with a CONF_PAIR or CONF_SECTION. More...

typedef struct cf_item	CONF_ITEM
	Generic configuration element, extended to become a CONF_PAIR, a CONF_SECTION or CONF_DATA. More...

typedef struct cf_pair	CONF_PAIR
	CONF_ITEM with an attribute, an operator and a value. More...

typedef struct cf_section	CONF_SECTION
	CONF_ITEM used to group multiple CONF_PAIR and CONF_SECTION, together. More...

Functions
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 free, char const filename, int lineno)
	Add talloced user data to a config section. More...

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. More...

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

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. More...

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. More...

void *	_cf_data_remove (CONF_ITEM ci, CONF_DATA const _cd)
	Remove data from a configuration section. More...

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

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

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

void	_cf_item_add (CONF_ITEM parent, CONF_ITEM child)
	Add a child. More...

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

void	_cf_item_insert_after (CONF_ITEM parent, CONF_ITEM prev, CONF_ITEM *child)
	Insert a child after a given one. More...

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

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

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

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

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

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. More...

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. More...

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. More...

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. More...

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. More...

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

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

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. More...

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. More...

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. More...

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. More...

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. More...

CONF_ITEM *	cf_data_to_item (CONF_DATA const *cs)
	Cast CONF_DATA to a CONF_ITEM. More...

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

void	cf_item_free_children (CONF_ITEM *ci)

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

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

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

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

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

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

CONF_PAIR *	cf_pair_alloc (CONF_SECTION parent, char const attr, char const *value, fr_token_t op, fr_token_t lhs_type, fr_token_t rhs_type)
	Allocate a CONF_PAIR. More...

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

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

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

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

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

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

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

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. More...

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

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

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. More...

bool	cf_pair_is_parsed (CONF_PAIR *cp)
	Return whether a pair has already been parsed. More...

void	cf_pair_mark_parsed (CONF_PAIR *cp)
	Mark a pair as parsed. More...

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

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

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

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

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

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

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

fr_slen_t	cf_pair_values_concat (fr_sbuff_t sbuff, CONF_SECTION const cs, char const attr, char const sep)
	Concatenate the values of any pairs with name attr. More...

void	cf_section_add_name2_quote (CONF_SECTION *cs, fr_token_t token)
	Set the quoting of the name2 identifier. More...

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

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

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

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. More...

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

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

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

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

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

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

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

int8_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. More...

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

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

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

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

Detailed Description

API to create and manipulate internal format configurations.

Id: da4a47ea5a14dea7badf696056e7da0ae1b1bc41

Copyright: 2017 The FreeRADIUS server project

Definition in file cf_util.h.

Macro Definition Documentation

◆ cf_canonicalize_error

#define cf_canonicalize_error	(	_ci,
		_slen,
		_msg,
		_str
	)	_cf_canonicalize_error(CF_TO_ITEM(_ci), _slen, _msg, _str)

Definition at line 367 of file cf_util.h.

◆ cf_data_add

#define cf_data_add	(	_cf,
		_data,
		_name,
		_free
	)	_cf_data_add(CF_TO_ITEM(_cf), (void const *) _data, _name, _free, __FILE__, __LINE__)

Definition at line 255 of file cf_util.h.

◆ cf_data_add_static

#define cf_data_add_static	(	_cf,
		_data,
		_type,
		_name
	)	_cf_data_add_static(CF_TO_ITEM(_cf), _data, #_type, _name, __FILE__, __LINE__)

Definition at line 258 of file cf_util.h.

◆ cf_data_find

#define cf_data_find	(	_cf,
		_type,
		_name
	)	_cf_data_find(CF_TO_ITEM(_cf), #_type, _name)

Definition at line 244 of file cf_util.h.

◆ cf_data_find_in_parent

#define cf_data_find_in_parent	(	_cf,
		_type,
		_name
	)	_cf_data_find_in_parent(CF_TO_ITEM(_cf), #_type, _name)

Definition at line 250 of file cf_util.h.

◆ cf_data_find_next

#define cf_data_find_next	(	_cf,
		_prev,
		_type,
		_name
	)	_cf_data_find_next(CF_TO_ITEM(_cf), CF_TO_ITEM(_prev), #_type, _name)

Definition at line 247 of file cf_util.h.

◆ cf_data_remove

#define cf_data_remove	(	_cf,
		_type,
		_name
	)	_cf_data_remove(CF_TO_ITEM(_cf), cf_data_find(_cf, _type, _name))

Remove an item from a parent by type and name.

Parameters

[in]	_cf	conf section or pair to remove data from.
[in]	_type	of data to remove.
[in]	_name	of data to remove.

Definition at line 267 of file cf_util.h.

◆ cf_data_remove_by_data

#define cf_data_remove_by_data	(	_cf,
		_cd
	)	_cf_data_remove(CF_TO_ITEM(_cf), _cd)

Remove an item from a parent.

Parameters

[in]	_cf	conf section or pair to remove data from.
[in]	_cd	conf data to remove.

Definition at line 274 of file cf_util.h.

◆ cf_data_walk

#define cf_data_walk	(	_cf,
		_type,
		_cb,
		_ctx
	)	_cf_data_walk(CF_TO_ITEM(_cf), #_type, _cb, _ctx)

Definition at line 277 of file cf_util.h.

◆ cf_filename

#define cf_filename ( _cf ) _cf_filename(CF_TO_ITEM(_cf))

Definition at line 107 of file cf_util.h.

◆ cf_filename_set

#define cf_filename_set	(	_ci,
		_filename
	)	_cf_filename_set(CF_TO_ITEM(_ci), _filename)

Definition at line 128 of file cf_util.h.

◆ CF_IDENT_ANY

#define CF_IDENT_ANY ((void *) (-1))

Definition at line 78 of file cf_util.h.

◆ cf_item_add

#define cf_item_add	(	_parent,
		_child
	)	_cf_item_add(CF_TO_ITEM(_parent), CF_TO_ITEM(_child))

Definition at line 83 of file cf_util.h.

◆ cf_item_debug

#define cf_item_debug ( _cf ) _cf_item_debug(CF_TO_ITEM(_cf))

Definition at line 361 of file cf_util.h.

◆ cf_item_insert_after

#define cf_item_insert_after	(	_parent,
		_prev,
		_child
	)	_cf_item_insert_after(CF_TO_ITEM(_parent), CF_TO_ITEM(_prev), CF_TO_ITEM(_child))

Definition at line 86 of file cf_util.h.

◆ cf_item_next

#define cf_item_next	(	_ci,
		_curr
	)	_cf_item_next(CF_TO_ITEM(_ci), _curr)

Definition at line 92 of file cf_util.h.

◆ cf_item_prev

#define cf_item_prev	(	_ci,
		_curr
	)	_cf_item_prev(CF_TO_ITEM(_ci), _curr)

Definition at line 95 of file cf_util.h.

◆ cf_item_remove

#define cf_item_remove	(	_parent,
		_child
	)	_cf_item_remove(CF_TO_ITEM(_parent), CF_TO_ITEM(_child))

Definition at line 89 of file cf_util.h.

◆ cf_lineno

#define cf_lineno ( _cf ) _cf_lineno(CF_TO_ITEM(_cf))

Definition at line 104 of file cf_util.h.

◆ cf_lineno_set

#define cf_lineno_set	(	_ci,
		_lineno
	)	_cf_lineno_set(CF_TO_ITEM(_ci), _lineno)

Definition at line 131 of file cf_util.h.

◆ cf_log_debug

#define cf_log_debug	(	_cf,
		_fmt,
		...
	)	_cf_log(L_DBG, CF_TO_ITEM(_cf), __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

Definition at line 292 of file cf_util.h.

◆ cf_log_debug_by_child

#define cf_log_debug_by_child	(	_parent,
		_child,
		_fmt,
		...
	)	_cf_log_by_child(L_DBG, _parent, _child, __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

Log a debug message against a specified child.

Parameters

[in]	_parent	CONF_SECTION.
[in]	_child	string identifier.
[in]	_fmt	of message.
[in]	...	arguments.

Definition at line 353 of file cf_util.h.

◆ cf_log_debug_prefix

#define cf_log_debug_prefix	(	_cf,
		_fmt,
		...
	)	_cf_log_with_filename(L_DBG, CF_TO_ITEM(_cf), __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

Definition at line 306 of file cf_util.h.

◆ cf_log_err

#define cf_log_err	(	_cf,
		_fmt,
		...
	)	_cf_log(L_ERR, CF_TO_ITEM(_cf), __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

Definition at line 289 of file cf_util.h.

◆ cf_log_err_by_child

#define cf_log_err_by_child	(	_parent,
		_child,
		_fmt,
		...
	)	_cf_log_by_child(L_ERR, _parent, _child, __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

Log an error message against a specified child.

Parameters

[in]	_parent	CONF_SECTION.
[in]	_child	string identifier.
[in]	_fmt	of message.
[in]	...	arguments.

Definition at line 316 of file cf_util.h.

◆ cf_log_info

#define cf_log_info	(	_cf,
		_fmt,
		...
	)	_cf_log(L_INFO, CF_TO_ITEM(_cf), __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

Definition at line 291 of file cf_util.h.

◆ cf_log_info_by_child

#define cf_log_info_by_child	(	_parent,
		_child,
		_fmt,
		...
	)	_cf_log_by_child(L_INFO, _parent, _child, __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

Log an info message against a specified child.

Parameters

[in]	_parent	CONF_SECTION.
[in]	_child	string identifier.
[in]	_fmt	of message.
[in]	...	arguments.

Definition at line 344 of file cf_util.h.

◆ cf_log_perr

#define cf_log_perr	(	_cf,
		_fmt,
		...
	)	_cf_log_perr(L_ERR, CF_TO_ITEM(_cf), __FILE__, __LINE__, NULL, _fmt, ## __VA_ARGS__)

Definition at line 296 of file cf_util.h.

◆ cf_log_perr_by_child

#define cf_log_perr_by_child	(	_parent,
		_child,
		_f_rules,
		_fmt,
		...
	)	_cf_log_perr_by_child(L_ERR, _parent, _child, __FILE__, __LINE__, _f_rules, _fmt, ## __VA_ARGS__)

Log an error message against a specified child, draining the thread local error stack.

Parameters

[in]	_parent	CONF_SECTION.
[in]	_child	string identifier.
[in]	_f_rules	Line prefixes.
[in]	_fmt	of message.
[in]	...	arguments.

Definition at line 326 of file cf_util.h.

◆ cf_log_pwarn

#define cf_log_pwarn	(	_cf,
		_fmt,
		...
	)	_cf_log_perr(L_WARN, CF_TO_ITEM(_cf), __FILE__, __LINE__, NULL, _fmt, ## __VA_ARGS__)

Definition at line 297 of file cf_util.h.

◆ cf_log_warn

#define cf_log_warn	(	_cf,
		_fmt,
		...
	)	_cf_log(L_WARN, CF_TO_ITEM(_cf), __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

Definition at line 290 of file cf_util.h.

◆ cf_log_warn_by_child

#define cf_log_warn_by_child	(	_parent,
		_child,
		_fmt,
		...
	)	_cf_log_by_child(L_WARN, _parent, _child, __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

Log a warning message against a specified child.

Parameters

[in]	_parent	CONF_SECTION.
[in]	_child	string identifier.
[in]	_fmt	of message.
[in]	...	arguments.

Definition at line 335 of file cf_util.h.

◆ cf_parent

#define cf_parent ( _cf ) _cf_parent(CF_TO_ITEM(_cf))

Definition at line 101 of file cf_util.h.

◆ cf_root

#define cf_root ( _cf ) _cf_root(CF_TO_ITEM(_cf))

Definition at line 98 of file cf_util.h.

◆ cf_section_alloc

#define cf_section_alloc	(	_ctx,
		_parent,
		_name1,
		_name2
	)	_cf_section_alloc(_ctx, _parent, _name1, _name2, __FILE__, __LINE__)

Definition at line 140 of file cf_util.h.

◆ cf_section_find_in_parent

#define cf_section_find_in_parent	(	_cf,
		_name1,
		_name2
	)	_cf_section_find_in_parent(CF_TO_ITEM(_cf), _name1, _name2)

Definition at line 170 of file cf_util.h.

◆ cf_section_find_parent

#define cf_section_find_parent	(	_cf,
		_name1,
		_name2
	)	_cf_section_find_parent(CF_TO_ITEM(_cf), _name1, _name2)

Definition at line 175 of file cf_util.h.

◆ cf_section_foreach

#define cf_section_foreach	(	_parent,
		_iter
	)	for (CONF_SECTION *_iter = cf_section_first(_parent); _iter; _iter = cf_section_next(_parent, _iter))

Definition at line 152 of file cf_util.h.

◆ cf_section_free_children

#define cf_section_free_children ( _x ) cf_item_free_children(cf_section_to_item(_x))

Definition at line 196 of file cf_util.h.

◆ CF_TO_ITEM

#define CF_TO_ITEM ( _cf )

Value:

_Generic((_cf), \
        CONF_SECTION *                  : cf_section_to_item((CONF_SECTION const *)_cf), \
        CONF_SECTION const *            : cf_section_to_item((CONF_SECTION const *)_cf), \
        CONF_PAIR *                     : cf_pair_to_item((CONF_PAIR const *)_cf), \
        CONF_PAIR const *               : cf_pair_to_item((CONF_PAIR const *)_cf), \
        CONF_DATA *                     : cf_data_to_item((CONF_DATA const *)_cf), \
        CONF_DATA const *               : cf_data_to_item((CONF_DATA const *)_cf), \
        default: _cf \
)

Auto cast from the input type to CONF_ITEM (which is the base type)

Automatically casts:

To a CONF_ITEM, whilst performing talloc type checks.

Definition at line 65 of file cf_util.h.

◆ FR_TIMESPEC_TO_MS

#define FR_TIMESPEC_TO_MS ( _x ) (((_x)->tv_usec / 1000000) + ((_x)->tv_sec * (uint64_t)1000))

Definition at line 54 of file cf_util.h.

◆ FR_TIMEVAL_TO_MS

#define FR_TIMEVAL_TO_MS ( _x ) (((_x)->tv_usec / 1000) + ((_x)->tv_sec * (uint64_t)1000))

Definition at line 53 of file cf_util.h.

Typedef Documentation

◆ cf_walker_t

typedef int(* cf_walker_t) (void *data, void *ctx)

Definition at line 76 of file cf_util.h.

◆ CONF_DATA

typedef struct cf_data CONF_DATA

CONF_ITEM used to associate arbitrary data with a CONF_PAIR or CONF_SECTION.

Definition at line 1 of file cf_util.h.

◆ CONF_ITEM

typedef struct cf_item CONF_ITEM

Generic configuration element, extended to become a CONF_PAIR, a CONF_SECTION or CONF_DATA.

Definition at line 1 of file cf_util.h.

◆ CONF_PAIR

typedef struct cf_pair CONF_PAIR

CONF_ITEM with an attribute, an operator and a value.

Definition at line 1 of file cf_util.h.

◆ CONF_SECTION

typedef struct cf_section CONF_SECTION

CONF_ITEM used to group multiple CONF_PAIR and CONF_SECTION, together.

Definition at line 1 of file cf_util.h.

Function Documentation

◆ _cf_canonicalize_error()

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

Definition at line 2429 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 1786 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 1828 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 1710 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 1744 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 1728 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 1872 of file cf_util.c.

Here is the call 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 1897 of file cf_util.c.

Here is the call 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 604 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 894 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_item_add()

void _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 382 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 2274 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_item_insert_after()

void _cf_item_insert_after	(	CONF_ITEM *	parent,
		CONF_ITEM *	prev,
		CONF_ITEM *	child
	)

Insert a child after a given one.

Parameters

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

Definition at line 409 of file cf_util.c.

Here is the call graph for this function:

◆ _cf_item_next()

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

Return the next child of the CONF_ITEM.

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 510 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 525 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 447 of file cf_util.c.

Here is the call 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 590 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 906 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 2045 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 2219 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 2157 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 2250 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 2180 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 576 of file cf_util.c.

◆ _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 558 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 787 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 1072 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 1096 of file cf_util.c.

Here is the call 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 2006 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 2068 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 754 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 1763 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 2416 of file cf_util.c.

Here is the call 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 646 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 632 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 618 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 704 of file cf_util.c.

Here is the call graph for this function:

◆ 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 664 of file cf_util.c.

Here is the call graph for this function:

◆ 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 684 of file cf_util.c.

Here is the call 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 1279 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 1578 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 1623 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 1520 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 1505 of file cf_util.c.

Here is the call graph for this function:

◆ cf_pair_debug()

void cf_pair_debug ( CONF_PAIR * cp )

Ease of use from debugger.

Definition at line 2399 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 1321 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 1439 of file cf_util.c.

Here is the call graph for this function:

Here is the caller 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 1467 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 1453 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 next child that's a CONF_PAIR.

Parameters

[in] cs to return children 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 1400 of file cf_util.c.

Here is the call 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 1966 of file cf_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cf_pair_is_parsed()

bool cf_pair_is_parsed ( CONF_PAIR * cp )

Return whether a pair has already been parsed.

Parameters

[in] cp to check.

Returns

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

Definition at line 1388 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_pair_mark_parsed()

void cf_pair_mark_parsed ( CONF_PAIR * cp )

Mark a pair as parsed.

Parameters

[in] cp to mark as parsed.

Definition at line 1376 of file cf_util.c.

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 1413 of file cf_util.c.

Here is the call 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 1608 of file cf_util.c.

◆ cf_pair_prev()

CONF_PAIR* cf_pair_prev	(	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 1426 of file cf_util.c.

Here is the call graph for this function:

◆ cf_pair_replace()

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

Replace pair in a given section with a new pair, of 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 1350 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 722 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 1594 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 1638 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_pair_values_concat()

fr_slen_t cf_pair_values_concat	(	fr_sbuff_t *	out,
		CONF_SECTION const *	cs,
		char const *	attr,
		char const *	sep
	)

Concatenate the values of any pairs with name attr.

Parameters

[out]	out	where to write the concatenated values.
[in]	cs	to search in.
[in]	attr	to search for.
[in]	sep	to use to separate values

Returns

Length of the data written to out on success.
< 0 on failure. Number of additional bytes required in buffer.

Definition at line 1540 of file cf_util.c.

Here is the call graph for this function:

◆ cf_section_add_name2_quote()

void cf_section_add_name2_quote	(	CONF_SECTION *	cs,
		fr_token_t	token
	)

Set the quoting of the name2 identifier.

Parameters

[in]	cs	containing name2.
[in]	token	the quote token

Definition at line 1242 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 1213 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 1260 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 2406 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 928 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 1028 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 1049 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 984 of file cf_util.c.

Here is the call 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 1197 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 second 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 1171 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 1185 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 1230 of file cf_util.c.

Here is the caller graph for this function:

◆ cf_section_name_cmp()

int8_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 1139 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 997 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 1010 of file cf_util.c.

Here is the call 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 738 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 1120 of file cf_util.c.

Here is the call graph for this function:

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ 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_remove_by_data

◆ cf_data_walk

◆ cf_filename

◆ cf_filename_set

◆ CF_IDENT_ANY

◆ cf_item_add

◆ cf_item_debug

◆ cf_item_insert_after

◆ cf_item_next

◆ cf_item_prev

◆ cf_item_remove

◆ cf_lineno

◆ cf_lineno_set

◆ cf_log_debug

◆ cf_log_debug_by_child

◆ cf_log_debug_prefix

◆ cf_log_err

◆ cf_log_err_by_child

◆ cf_log_info

◆ cf_log_info_by_child

◆ cf_log_perr

◆ cf_log_perr_by_child

◆ cf_log_pwarn

◆ cf_log_warn

◆ cf_log_warn_by_child

◆ cf_parent

◆ cf_root

◆ cf_section_alloc

◆ cf_section_find_in_parent

◆ cf_section_find_parent

◆ cf_section_foreach

◆ cf_section_free_children

◆ CF_TO_ITEM

◆ FR_TIMESPEC_TO_MS

◆ FR_TIMEVAL_TO_MS

Typedef Documentation

◆ cf_walker_t

◆ CONF_DATA

◆ CONF_ITEM

◆ CONF_PAIR

◆ CONF_SECTION

Function Documentation

◆ _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_filename()

◆ _cf_filename_set()

◆ _cf_item_add()

◆ _cf_item_debug()

◆ _cf_item_insert_after()

◆ _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_root()

◆ _cf_section_alloc()