dict_util.c File Reference

Multi-protocol AVP dictionary API. More...

#include <freeradius-devel/util/atexit.h>
#include <freeradius-devel/util/conf.h>
#include <freeradius-devel/util/dict.h>
#include <freeradius-devel/util/dict_ext_priv.h>
#include <freeradius-devel/util/dict_fixup_priv.h>
#include <freeradius-devel/util/proto.h>
#include <freeradius-devel/util/rand.h>
#include <freeradius-devel/util/syserror.h>

Include dependency graph for dict_util.c:

Go to the source code of this file.

Data Structures
struct	fr_dict_autoload_talloc_s
	Structure used to managed the lifetime of a dictionary. More...

Macros
#define	_DICT_PRIVATE   1
#define	DICT_ATTR_ALLOWED_CHARS
#define	DICT_NAME_APPEND(_in, _dict)
#define	FNV_MAGIC_INIT   (0x811c9dc5)
#define	FNV_MAGIC_PRIME   (0x01000193)

Typedefs
typedef fr_slen_t(*	dict_attr_resolve_func_t) (fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_attr_t const *parent, fr_sbuff_t *in, fr_sbuff_term_t const *tt)
	Callback function for resolving dictionary attributes.

Functions
fr_dict_attr_t *	_dict_attr_alloc (char const *filename, int line, TALLOC_CTX *ctx, fr_dict_attr_t const *parent, char const *name, int attr, fr_type_t type, dict_attr_args_t const *args)
	Allocate a dictionary attribute on the heap.
fr_dict_attr_t *	_dict_attr_alloc_root (char const *filename, int line, TALLOC_CTX *ctx, fr_dict_t const *dict, char const *name, int proto_number, dict_attr_args_t const *args)
	Allocate a dictionary root attribute on the heap.
static int	_dict_attr_free (fr_dict_attr_t *da)
int	_dict_attr_init (char const *filename, int line, fr_dict_attr_t **da_p, fr_dict_attr_t const *parent, char const *name, unsigned int attr, fr_type_t type, dict_attr_args_t const *args)
	Initialise fields in a dictionary attribute structure.
int	_dict_attr_init_name_only (char const *filename, int line, fr_dict_attr_t **da_p, fr_dict_attr_t const *parent, char const *name, fr_type_t type, dict_attr_args_t const *args)
	Initialise fields in a dictionary attribute structure.
static fr_cmp_ret_t	_dict_dependent_cmp (void const *a, void const *b)
	Find a dependent in the tree of dependents.
static int	_dict_free (fr_dict_t *dict)
static int	_dict_global_free (fr_dict_gctx_t *gctx)
static int	_dict_global_free_at_exit (void *uctx)
int	_fr_dict_autofree (fr_dict_autoload_t const *to_free, char const *dependent)
	Decrement the reference count on a previously loaded dictionary.
int	_fr_dict_autoload (fr_dict_autoload_t const *to_load, char const *dependent)
	Process a dict_autoload element to load a protocol.
fr_dict_autoload_talloc_t *	_fr_dict_autoload_talloc (TALLOC_CTX *ctx, fr_dict_t const **out, char const *proto, char const *dependent)
	Autoload a dictionary and bind the lifetime to a talloc chunk.
static int	_fr_dict_autoload_talloc_free (fr_dict_autoload_talloc_t const *to_free)
	Talloc destructor to automatically free dictionaries.
static void	dependent_debug (fr_dict_t *dict)
fr_dict_t *	dict_alloc (TALLOC_CTX *ctx)
	Allocate a new dictionary.
fr_dict_attr_t *	dict_attr_acopy (TALLOC_CTX *ctx, fr_dict_attr_t const *parent, fr_dict_attr_t const *in, char const *name)
	Copy a an existing attribute, possibly to a new location.
int	dict_attr_acopy_aliases (UNUSED fr_dict_attr_t *dst, fr_dict_attr_t const *src)
	Copy aliases of an existing attribute to a new one.
static int	dict_attr_acopy_child (fr_dict_t *dict, fr_dict_attr_t *dst, fr_dict_attr_t const *src, fr_dict_attr_t const *child)
int	dict_attr_acopy_children (fr_dict_t *dict, fr_dict_attr_t *dst, fr_dict_attr_t const *src)
	Copy the children of an existing attribute.
int	dict_attr_acopy_enumv (fr_dict_attr_t *dst, fr_dict_attr_t const *src)
	Copy the VALUEs of an existing attribute, by casting them.
int	dict_attr_add_to_namespace (fr_dict_attr_t const *parent, fr_dict_attr_t *da)
	Add an attribute to the name table for an attribute.
static fr_dict_attr_t const *	dict_attr_alias (fr_dict_attr_err_t *err, fr_dict_attr_t const *da)
	Resolve an alias attribute to the concrete attribute it points to.
int	dict_attr_alias_add (fr_dict_attr_t const *parent, char const *alias, fr_dict_attr_t const *ref, bool from_public)
	Add an alias to an existing attribute.
fr_dict_attr_t *	dict_attr_alloc_null (TALLOC_CTX *ctx, fr_dict_protocol_t const *proto)
	Allocate a partially completed attribute.
fr_dict_attr_t *	dict_attr_by_name (fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *name)
bool	dict_attr_can_have_children (fr_dict_attr_t const *da)
	See if a fr_dict_attr_t can have children.
int	dict_attr_child_add (fr_dict_attr_t *parent, fr_dict_attr_t *child)
	Add a child to a parent.
fr_dict_attr_t *	dict_attr_child_by_num (fr_dict_attr_t const *parent, unsigned int attr)
	Internal version of fr_dict_attr_child_by_num.
static int	dict_attr_children_init (fr_dict_attr_t **da_p)
	Add a child/nesting extension to an attribute.
int	dict_attr_enum_add_name (fr_dict_attr_t *da, char const *name, fr_value_box_t const *value, bool coerce, bool takes_precedence, fr_dict_attr_t const *key_child_ref)
static int	dict_attr_enumv_init (fr_dict_attr_t **da_p)
	Initialise a per-attribute enumeration table.
int	dict_attr_finalise (fr_dict_attr_t **da_p, char const *name)
	Set remaining fields in a dictionary attribute before insertion.
static int	dict_attr_init_common (char const *filename, int line, fr_dict_attr_t **da_p, fr_dict_attr_t const *parent, fr_type_t type, dict_attr_args_t const *args)
void	dict_attr_location_init (fr_dict_t *dict, fr_dict_attr_t *da, char const *filename, int line)
	Set where the dictionary attribute was defined.
static fr_cmp_ret_t	dict_attr_name_cmp (void const *one, void const *two)
	Compare two attribute names.
static uint32_t	dict_attr_name_hash (void const *data)
	Wrap name hash function for fr_dict_attr_t.
static int	dict_attr_name_set (fr_dict_attr_t **da_p, char const *name)
	Set a dictionary attribute's name.
static int	dict_attr_namespace_init (fr_dict_attr_t **da_p)
	Initialise a per-attribute namespace.
int	dict_attr_num_init (fr_dict_attr_t *da, unsigned int num)
	Set the attribute number (if any)
int	dict_attr_num_init_name_only (fr_dict_attr_t *da)
	Set the attribute number (if any)
int	dict_attr_parent_init (fr_dict_attr_t **da_p, fr_dict_attr_t const *parent)
	Initialise fields which depend on a parent attribute.
static fr_slen_t	dict_attr_search (fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_t const *dict_def, fr_sbuff_t *in, fr_sbuff_term_t const *tt, bool internal, bool foreign, dict_attr_resolve_func_t func)
	Internal function for searching for attributes in multiple dictionaries.
static fr_slen_t	dict_attr_search_qualified (fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_t const *dict_def, fr_sbuff_t *in, fr_sbuff_term_t const *tt, bool internal, bool foreign, dict_attr_resolve_func_t func)
	Internal function for searching for attributes in multiple dictionaries.
int	dict_attr_type_init (fr_dict_attr_t **da_p, fr_type_t type)
	Initialise type specific fields within the dictionary attribute.
static int	dict_attr_vendor_set (fr_dict_attr_t **da_p, fr_dict_attr_t const *vendor)
	Cache the vendor pointer for an attribute.
static int	dict_autoref_free (fr_dict_t *dict)
fr_dict_t *	dict_by_da (fr_dict_attr_t const *da)
	Internal version of fr_dict_by_da.
fr_dict_t *	dict_by_protocol_name (char const *name)
	Internal version of fr_dict_by_protocol_name.
fr_dict_t *	dict_by_protocol_num (unsigned int num)
	Internal version of fr_dict_by_protocol_num.
fr_slen_t	dict_by_protocol_substr (fr_dict_attr_err_t *err, fr_dict_t **out, fr_sbuff_t *name, fr_dict_t const *dict_def)
int	dict_dependent_add (fr_dict_t *dict, char const *dependent)
	Record a new dependency on a dictionary.
int	dict_dependent_remove (fr_dict_t *dict, char const *dependent)
	Decrement ref count for a dependent in a dictionary.
int	dict_dlopen (fr_dict_t *dict, char const *name)
static fr_cmp_ret_t	dict_enum_name_cmp (void const *one, void const *two)
	Compare two dictionary attribute enum values.
static uint32_t	dict_enum_name_hash (void const *data)
	Hash a enumeration name.
static fr_cmp_ret_t	dict_enum_value_cmp (void const *one, void const *two)
	Compare two dictionary enum values.
static uint32_t	dict_enum_value_hash (void const *data)
	Hash a dictionary enum value.
static int8_t	dict_filename_cmp (void const *one, void const *two)
	Compare two fr_dict_filename_t by filename.
static uint32_t	dict_filename_hash (void const *data)
	Hash the filename of a fr_dict_filename_t.
fr_dict_filename_t *	dict_filename_intern (fr_dict_t *dict, char const *filename)
	Return the table entry for a filename, creating the entry if the filename is not in the table.
bool	dict_has_dependents (fr_dict_t *dict)
	Check if a dictionary still has dependents.
static uint32_t	dict_hash_name (char const *name, size_t len)
	Apply a simple (case insensitive) hashing function to the name of an attribute, vendor or protocol.
int	dict_protocol_add (fr_dict_t *dict)
	Add a protocol to the global protocol table.
static fr_cmp_ret_t	dict_protocol_name_cmp (void const *one, void const *two)
	Compare two protocol names.
static uint32_t	dict_protocol_name_hash (void const *data)
	Wrap name hash function for fr_dict_protocol_t.
static fr_cmp_ret_t	dict_protocol_num_cmp (void const *one, void const *two)
	Compare two protocol numbers.
static uint32_t	dict_protocol_num_hash (void const *data)
	Hash a protocol number.
int	dict_vendor_add (fr_dict_t *dict, char const *name, unsigned int num)
	Add a vendor to the dictionary.
static fr_cmp_ret_t	dict_vendor_name_cmp (void const *one, void const *two)
	Compare two attribute names.
static uint32_t	dict_vendor_name_hash (void const *data)
	Wrap name hash function for fr_dict_vendor_t.
static fr_cmp_ret_t	dict_vendor_pen_cmp (void const *one, void const *two)
	Compare two vendor numbers.
static uint32_t	dict_vendor_pen_hash (void const *data)
	Hash a vendor number.
static int	dict_walk (fr_dict_attr_t const *da, fr_dict_walk_t callback, void *uctx)
	Call the specified callback for da and then for all its children.
int	fr_dict_attr_acopy_local (fr_dict_attr_t const *dst, fr_dict_attr_t const *src)
int	fr_dict_attr_add (fr_dict_t *dict, fr_dict_attr_t const *parent, char const *name, unsigned int attr, fr_type_t type, fr_dict_attr_flags_t const *flags)
	Add an attribute to the dictionary.
int	fr_dict_attr_add_initialised (fr_dict_attr_t *da)
	A variant of fr_dict_attr_t that allows a pre-allocated, populated fr_dict_attr_t to be added.
int	fr_dict_attr_add_name_only (fr_dict_t *dict, fr_dict_attr_t const *parent, char const *name, fr_type_t type, fr_dict_attr_flags_t const *flags)
	Add an attribute to the dictionary.
int	fr_dict_attr_autoload (fr_dict_attr_autoload_t const *to_load)
	Process a dict_attr_autoload element to load/verify a dictionary attribute.
fr_dict_attr_t const *	fr_dict_attr_by_name (fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *name)
	Locate a fr_dict_attr_t by its name.
fr_slen_t	fr_dict_attr_by_name_substr (fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_attr_t const *parent, fr_sbuff_t *name, UNUSED fr_sbuff_term_t const *tt)
	Look up a dictionary attribute by a name embedded in another string.
fr_dict_attr_t const *	fr_dict_attr_by_oid (fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *oid)
	Resolve an attribute using an OID string.
ssize_t	fr_dict_attr_by_oid_legacy (fr_dict_attr_t const **parent, unsigned int *attr, char const *oid)
	Get the leaf attribute of an OID string.
fr_slen_t	fr_dict_attr_by_oid_substr (fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_attr_t const *parent, fr_sbuff_t *in, fr_sbuff_term_t const *tt)
	Resolve an attribute using an OID string.
bool	fr_dict_attr_can_contain (fr_dict_attr_t const *parent, fr_dict_attr_t const *child)
	See if a structural da is allowed to contain another da.
fr_dict_attr_t const *	fr_dict_attr_child_by_num (fr_dict_attr_t const *parent, unsigned int attr)
	Check if a child attribute exists in a parent using an attribute number.
fr_dict_attr_t const *	fr_dict_attr_common_parent (fr_dict_attr_t const *a, fr_dict_attr_t const *b, bool is_ancestor)
	Find a common ancestor that two TLV type attributes share.
char const *	fr_dict_attr_filename (fr_dict_attr_t const *da)
	Resolve an attribute's location file id to the filename.
fr_dict_attr_t const *	fr_dict_attr_iterate_children (fr_dict_attr_t const *parent, fr_dict_attr_t const **prev)
	Iterate over children of a DA.
int8_t	fr_dict_attr_ordered_cmp (fr_dict_attr_t const *a, fr_dict_attr_t const *b)
	Compare two attributes by total order.
fr_slen_t	fr_dict_attr_search_by_name_substr (fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_t const *dict_def, fr_sbuff_t *name, fr_sbuff_term_t const *tt, bool internal, bool foreign)
	Locate a fr_dict_attr_t by its name in the top level namespace of a dictionary.
fr_slen_t	fr_dict_attr_search_by_oid_substr (fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_t const *dict_def, fr_sbuff_t *in, fr_sbuff_term_t const *tt, bool internal, bool foreign)
	Locate a qualified fr_dict_attr_t by a dictionary using a non-qualified OID string.
fr_slen_t	fr_dict_attr_search_by_qualified_name_substr (fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_t const *dict_def, fr_sbuff_t *name, fr_sbuff_term_t const *tt, bool internal, bool foreign)
	Locate a qualified fr_dict_attr_t by its name and a dictionary qualifier.
fr_dict_attr_t const *	fr_dict_attr_search_by_qualified_oid (fr_dict_attr_err_t *err, fr_dict_t const *dict_def, char const *name, bool internal, bool foreign)
	Locate a qualified fr_dict_attr_t by its name and a dictionary qualifier.
fr_slen_t	fr_dict_attr_search_by_qualified_oid_substr (fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_t const *dict_def, fr_sbuff_t *in, fr_sbuff_term_t const *tt, bool internal, bool foreign)
	Locate a qualified fr_dict_attr_t by a dictionary qualified OID string.
int	fr_dict_attr_set_group (fr_dict_attr_t **da_p, fr_dict_attr_t const *ref)
fr_dict_attr_t *	fr_dict_attr_unconst (fr_dict_attr_t const *da)
	Coerce to non-const.
void	fr_dict_attr_verify (char const *file, int line, fr_dict_attr_t const *da)
fr_dict_t const *	fr_dict_by_da (fr_dict_attr_t const *da)
	Attempt to locate the protocol dictionary containing an attribute.
fr_dict_t const *	fr_dict_by_protocol_name (char const *name)
	Lookup a protocol by its name.
fr_dict_t const *	fr_dict_by_protocol_num (unsigned int num)
	Lookup a protocol by its number.
fr_slen_t	fr_dict_by_protocol_substr (fr_dict_attr_err_t *err, fr_dict_t const **out, fr_sbuff_t *name, fr_dict_t const *dict_def)
	Look up a protocol name embedded in another string.
bool	fr_dict_compatible (fr_dict_t const *dict1, fr_dict_t const *dict2)
	See if two dictionaries have the same end parent.
int	fr_dict_const_free (fr_dict_t const **dict, char const *dependent)
	Decrement the reference count on a previously loaded dictionary.
int	fr_dict_dependent_add (fr_dict_t const *dict, char const *dependent)
	Manually increase the reference count for a dictionary.
dl_t *	fr_dict_dl (fr_dict_t const *dict)
int	fr_dict_enum_add_name (fr_dict_attr_t *da, char const *name, fr_value_box_t const *value, bool coerce, bool takes_precedence)
	Add a value name.
int	fr_dict_enum_add_name_next (fr_dict_attr_t *da, char const *name)
	Add an name to an integer attribute hashing the name for the integer value.
int	fr_dict_enum_autoload (fr_dict_enum_autoload_t const *to_load)
	Process a dict_attr_autoload element to load/verify a dictionary attribute.
fr_dict_enum_value_t const *	fr_dict_enum_by_name (fr_dict_attr_t const *da, char const *name, ssize_t len)
fr_slen_t	fr_dict_enum_by_name_substr (fr_dict_enum_value_t **out, fr_dict_attr_t const *da, fr_sbuff_t *in)
fr_dict_enum_value_t const *	fr_dict_enum_by_value (fr_dict_attr_t const *da, fr_value_box_t const *value)
	Lookup the structure representing an enum value in a fr_dict_attr_t.
fr_dict_enum_value_t const *	fr_dict_enum_iter_init (fr_dict_attr_t const *da, fr_dict_enum_iter_t *iter)
	Iterate over all enumeration values for an attribute.
fr_dict_enum_value_t const *	fr_dict_enum_iter_next (fr_dict_attr_t const *da, fr_dict_enum_iter_t *iter)
char const *	fr_dict_enum_name_by_value (fr_dict_attr_t const *da, fr_value_box_t const *value)
	Lookup the name of an enum value in a fr_dict_attr_t.
fr_slen_t	fr_dict_enum_name_from_substr (fr_sbuff_t *out, fr_sbuff_parse_error_t *err, fr_sbuff_t *in, fr_sbuff_term_t const *tt)
	Extract an enumeration name from a string.
int	fr_dict_free (fr_dict_t **dict, char const *dependent)
	Decrement the reference count on a previously loaded dictionary.
void	fr_dict_gctx_debug (FILE *fp, fr_dict_gctx_t const *gctx)
	Dump information about currently loaded dictionaries.
char const *	fr_dict_global_ctx_dir (void)
int	fr_dict_global_ctx_dir_set (char const *dict_dir)
	Allow the default dict dir to be changed after initialisation.
int	fr_dict_global_ctx_free (fr_dict_gctx_t const *gctx)
	Explicitly free all data associated with a global dictionary context.
fr_dict_gctx_t *	fr_dict_global_ctx_init (TALLOC_CTX *ctx, bool free_at_exit, char const *dict_dir)
	Initialise the global protocol hashes.
fr_dict_t *	fr_dict_global_ctx_iter_init (fr_dict_global_ctx_iter_t *iter)
	Iterate protocols by name.
fr_dict_t *	fr_dict_global_ctx_iter_next (fr_dict_global_ctx_iter_t *iter)
void	fr_dict_global_ctx_perm_check (fr_dict_gctx_t *gctx, bool enable)
	Set whether we check dictionary file permissions.
void	fr_dict_global_ctx_read_only (void)
	Mark all dictionaries and the global dictionary ctx as read only.
void	fr_dict_global_ctx_set (fr_dict_gctx_t const *gctx)
	Set a new, active, global dictionary context.
fr_dict_t const *	fr_dict_internal (void)
bool	fr_dict_is_read_only (fr_dict_t const *dict)
fr_slen_t	fr_dict_oid_component (fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_attr_t const *parent, fr_sbuff_t *in, fr_sbuff_term_t const *tt)
	Parse an OID component, resolving it to a defined attribute.
int	fr_dict_oid_component_legacy (unsigned int *out, char const **oid)
	Process a single OID component.
fr_dict_t const *	fr_dict_proto_dict (fr_dict_t const *dict)
fr_dict_protocol_t const *	fr_dict_protocol (fr_dict_t const *dict)
	Return the protocol descriptor for the dictionary.
fr_dict_t *	fr_dict_protocol_alloc (fr_dict_t const *parent)
	Allocate a new local dictionary.
fr_dict_attr_t const *	fr_dict_root (fr_dict_t const *dict)
	Return the root attribute of a dictionary.
fr_dict_t *	fr_dict_unconst (fr_dict_t const *dict)
	Coerce to non-const.
fr_dict_attr_t const *	fr_dict_unlocal (fr_dict_attr_t const *da)
ssize_t	fr_dict_valid_name (char const *name, ssize_t len)
ssize_t	fr_dict_valid_oid_str (char const *name, ssize_t len)
fr_dict_vendor_t const *	fr_dict_vendor_by_da (fr_dict_attr_t const *da)
	Look up a vendor by one of its child attributes.
fr_dict_vendor_t const *	fr_dict_vendor_by_name (fr_dict_t const *dict, char const *name)
	Look up a vendor by its name.
fr_dict_vendor_t const *	fr_dict_vendor_by_num (fr_dict_t const *dict, uint32_t vendor_pen)
	Look up a vendor by its PEN.
fr_dict_attr_t const *	fr_dict_vendor_da_by_num (fr_dict_attr_t const *vendor_root, uint32_t vendor_pen)
	Return vendor attribute for the specified dictionary and pen.
int	fr_dict_walk (fr_dict_attr_t const *da, fr_dict_walk_t callback, void *uctx)
int	fr_dl_dict_attr_autoload (UNUSED dl_t const *module, void *symbol, UNUSED void *user_ctx)
	Callback to automatically resolve attributes and check the types are correct.
void	fr_dl_dict_autofree (UNUSED dl_t const *module, void *symbol, UNUSED void *user_ctx)
	Callback to automatically free a dictionary when the module is unloaded.
int	fr_dl_dict_autoload (UNUSED dl_t const *module, void *symbol, UNUSED void *user_ctx)
	Callback to automatically load dictionaries required by modules.
int	fr_dl_dict_enum_autoload (UNUSED dl_t const *module, void *symbol, UNUSED void *user_ctx)
	Callback to automatically resolve enum values.

Variables
fr_dict_gctx_t *	dict_gctx = NULL
	Top level structure containing global dictionary state.
static fr_dict_protocol_t	dict_proto_default
	Default protocol rules set for every dictionary.
bool const	fr_dict_attr_allowed_chars [SBUFF_CHAR_CLASS]
	Characters allowed in a single dictionary attribute name.
bool const	fr_dict_attr_nested_allowed_chars [SBUFF_CHAR_CLASS]
	Characters allowed in a nested dictionary attribute name.
bool const	fr_dict_enum_allowed_chars [SBUFF_CHAR_CLASS]
	Characters allowed in enumeration value names.

Detailed Description

Multi-protocol AVP dictionary API.

Copyright

2000,2006 The FreeRADIUS server project

2024 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 dict_util.c.

---

Data Structure Documentation

fr_dict_autoload_talloc_s

struct fr_dict_autoload_talloc_s

Structure used to managed the lifetime of a dictionary.

This should only be used when dictionaries are being dynamically loaded during compilation. It should not be used to load dictionaries at runtime, or if modules need to load dictionaries (use static fr_dict_autoload_t defs).

Definition at line 4625 of file dict_util.c.

Collaboration diagram for fr_dict_autoload_talloc_s:

Data Fields
char const *	dependent	Dependent that loaded the dictionary.
fr_dict_autoload_t	load[2]	Autoloader def.

Macro Definition Documentation

_DICT_PRIVATE

#define _DICT_PRIVATE   1

Definition at line 26 of file dict_util.c.

DICT_ATTR_ALLOWED_CHARS

#define DICT_ATTR_ALLOWED_CHARS

Value:

        ['-'] = true, ['/'] = true, ['_'] = true, \
        [ '0' ... '9' ] = true, \
        [ 'A' ... 'Z' ] = true, \
        [ 'a' ... 'z' ] = true

Definition at line 47 of file dict_util.c.

DICT_NAME_APPEND

#define DICT_NAME_APPEND	(		_in,
			_dict
	)

Value:

do { \
        char *_n; \
        _n = talloc_strdup_append_buffer(_in, fr_dict_root(_dict)->name); \
        if (unlikely(!_n)) { \
                talloc_free(_in); \
                goto done; \
        } \
        _in = _n; \
        _n = talloc_strdup_append_buffer(_in, ", "); \
        if (unlikely(!_n)) { \
                talloc_free(_in); \
                goto done; \
        } \
        _in = _n; \
} while (0)

FNV_MAGIC_INIT

#define FNV_MAGIC_INIT   (0x811c9dc5)

Definition at line 93 of file dict_util.c.

FNV_MAGIC_PRIME

#define FNV_MAGIC_PRIME   (0x01000193)

Definition at line 94 of file dict_util.c.

Typedef Documentation

dict_attr_resolve_func_t

typedef fr_slen_t(* dict_attr_resolve_func_t) (fr_dict_attr_err_t *err, fr_dict_attr_t const **out, fr_dict_attr_t const *parent, fr_sbuff_t *in, fr_sbuff_term_t const *tt)

Callback function for resolving dictionary attributes.

Parameters

[out]	err	Where to write error codes. Any error other than FR_DICT_ATTR_NOTFOUND will prevent resolution from continuing.
[out]	out	Where to write resolved DA.
[in]	parent	The dictionary root or other attribute to search from.
[in]	in	Contains the string to resolve.
[in]	tt	Terminal sequences to use to determine the portion of in to search.

Returns

• < 0 on failure.
• The number of bytes of name consumed on success.

Definition at line 3078 of file dict_util.c.

Function Documentation

_dict_attr_alloc()

fr_dict_attr_t * _dict_attr_alloc	(	char const *	filename,
		int	line,
		TALLOC_CTX *	ctx,
		fr_dict_attr_t const *	parent,
		char const *	name,
		int	attr,
		fr_type_t	type,
		dict_attr_args_t const *	args
	)

Allocate a dictionary attribute on the heap.

Parameters

[in]	filename	file.
[in]	line	number.
[in]	ctx	to allocate the attribute in.
[in]	parent	of the attribute.
[in]	name	of the attribute. If NULL an OID string will be created and set as the name.
[in]	attr	number.
[in]	type	of the attribute.
[in]	args	optional initialisation arguments.

Returns

• A new fr_dict_attr_t on success.
• NULL on failure.

Definition at line 1116 of file dict_util.c.

Here is the call graph for this function:

_dict_attr_alloc_root()

fr_dict_attr_t * _dict_attr_alloc_root	(	char const *	filename,
		int	line,
		TALLOC_CTX *	ctx,
		fr_dict_t const *	dict,
		char const *	name,
		int	proto_number,
		dict_attr_args_t const *	args
	)

Allocate a dictionary root attribute on the heap.

Parameters

[in]	filename	file.
[in]	line	number.
[in]	ctx	to allocate the attribute in.
[in]	dict	the attribute will be used in.
[in]	name	of the attribute. If NULL an OID string will be created and set as the name.
[in]	proto_number	number. This should be
[in]	args	optional initialisation arguments.

Returns

• A new fr_dict_attr_t on success.
• NULL on failure.

Definition at line 1082 of file dict_util.c.

Here is the call graph for this function:

_dict_attr_free()

static int _dict_attr_free ( fr_dict_attr_t *  da )

static

Definition at line 1007 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_dict_attr_init()

int _dict_attr_init	(	char const *	filename,
		int	line,
		fr_dict_attr_t **	da_p,
		fr_dict_attr_t const *	parent,
		char const *	name,
		unsigned int	attr,
		fr_type_t	type,
		dict_attr_args_t const *	args
	)

Initialise fields in a dictionary attribute structure.

This function is a wrapper around the other initialisation functions.

The reason for the separation, is that sometimes we're initialising a dictionary attribute by parsing an actual dictionary file, and other times we're copying attribute, or initialising them programatically.

This function should only be used for the second case, where we have a complet attribute definition already.

Note

This function can only be used before the attribute is inserted into the dictionary.

Parameters

[in]	filename	file.
[in]	line	number.
[in]	da_p	to initialise.
[in]	parent	of the attribute, if none, this attribute will be initialised as a dictionary root.
[in]	name	of attribute. Pass NULL for auto-generated name.
[in]	attr	number.
[in]	type	of the attribute.
[in]	args	optional initialisation arguments.

Returns

• 0 on success.
• <0 on error.

Definition at line 942 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_dict_attr_init_name_only()

int _dict_attr_init_name_only	(	char const *	filename,
		int	line,
		fr_dict_attr_t **	da_p,
		fr_dict_attr_t const *	parent,
		char const *	name,
		fr_type_t	type,
		dict_attr_args_t const *	args
	)

Initialise fields in a dictionary attribute structure.

This function is a wrapper around the other initialisation functions.

The reason for the separation, is that sometimes we're initialising a dictionary attribute by parsing an actual dictionary file, and other times we're copying attribute, or initialising them programatically.

This function should only be used for the second case, where we have a complet attribute definition already.

Note

This function can only be used before the attribute is inserted into the dictionary.

Parameters

[in]	filename	file.
[in]	line	number.
[in]	da_p	to initialise.
[in]	parent	of the attribute, if none, this attribute will be initialised as a dictionary root.
[in]	name	of attribute. Pass NULL for auto-generated name. automatically generated.
[in]	type	of the attribute.
[in]	args	optional initialisation arguments.

Returns

• 0 on success.
• <0 on error.

Definition at line 989 of file dict_util.c.

Here is the call graph for this function:

_dict_dependent_cmp()

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

static

Find a dependent in the tree of dependents.

Definition at line 4013 of file dict_util.c.

Here is the caller graph for this function:

_dict_free()

static int _dict_free ( fr_dict_t *  dict )

static

Definition at line 4175 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_dict_global_free()

static int _dict_global_free ( fr_dict_gctx_t *  gctx )

static

Definition at line 4745 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_dict_global_free_at_exit()

static int _dict_global_free_at_exit ( void *  uctx )

static

Definition at line 4740 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_fr_dict_autofree()

int _fr_dict_autofree	(	fr_dict_autoload_t const *	to_free,
		char const *	dependent
	)

Decrement the reference count on a previously loaded dictionary.

Parameters

[in]	to_free	previously loaded dictionary to free.
[in]	dependent	that originally allocated this dictionary

Definition at line 4601 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_fr_dict_autoload()

int _fr_dict_autoload	(	fr_dict_autoload_t const *	to_load,
		char const *	dependent
	)

Process a dict_autoload element to load a protocol.

Parameters

[in]	to_load	dictionary definition.
[in]	dependent	that is loading this dictionary.

Returns

• 0 on success.
• -1 on failure.

Definition at line 4568 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_fr_dict_autoload_talloc()

fr_dict_autoload_talloc_t * _fr_dict_autoload_talloc	(	TALLOC_CTX *	ctx,
		fr_dict_t const **	out,
		char const *	proto,
		char const *	dependent
	)

Autoload a dictionary and bind the lifetime to a talloc chunk.

Mainly useful for resolving "forward" references from unlang immediately.

Note

If the talloc chunk is freed it does not mean the dictionary will be immediately freed. It will be freed when all other references to the dictionary are gone.

Parameters

[in]	ctx	to bind the dictionary lifetime to.
[out]	out	pointer to the loaded dictionary.
[in]	proto	to load.
[in]	dependent	to register this reference to. Will be dupd.

Definition at line 4652 of file dict_util.c.

Here is the call graph for this function:

_fr_dict_autoload_talloc_free()

static int _fr_dict_autoload_talloc_free ( fr_dict_autoload_talloc_t const *  to_free )

static

Talloc destructor to automatically free dictionaries.

Parameters

[in]

to_free

dictionary autoloader definition describing the dictionary to free.

Definition at line 4634 of file dict_util.c.

Here is the call graph for this function:

dependent_debug()

static void dependent_debug ( fr_dict_t *  dict )

static

Definition at line 4130 of file dict_util.c.

Here is the call graph for this function:

dict_alloc()

fr_dict_t * dict_alloc

(

TALLOC_CTX *

ctx

)

Allocate a new dictionary.

Parameters

[in]

ctx

to allocate dictionary in.

Returns

• NULL on memory allocation error.

Definition at line 4273 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_acopy()

fr_dict_attr_t * dict_attr_acopy	(	TALLOC_CTX *	ctx,
		fr_dict_attr_t const *	parent,
		fr_dict_attr_t const *	in,
		char const *	name
	)

Copy a an existing attribute, possibly to a new location.

Parameters

[in]	ctx	to allocate new attribute in.
[in]	parent	where to parent the copy from. If NULL, in->parent is used.
[in]	in	attribute to copy.
[in]	name	to assign to the attribute. If NULL, in->name is used.

Returns

• A copy of the input fr_dict_attr_t on success.
• NULL on failure.

Definition at line 1145 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_acopy_aliases()

int dict_attr_acopy_aliases	(	UNUSED fr_dict_attr_t *	dst,
		fr_dict_attr_t const *	src
	)

Copy aliases of an existing attribute to a new one.

Parameters

[in]	dst	where to copy the children to
[in]	src	where to copy the children from

Returns

• 0 on success
• <0 on error

Definition at line 1375 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_acopy_child()

static int dict_attr_acopy_child ( fr_dict_t *  dict, fr_dict_attr_t *  dst, fr_dict_attr_t const *  src, fr_dict_attr_t const *  child  )

static

Definition at line 1205 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_acopy_children()

int dict_attr_acopy_children	(	fr_dict_t *	dict,
		fr_dict_attr_t *	dst,
		fr_dict_attr_t const *	src
	)

Copy the children of an existing attribute.

Parameters

[in]	dict	to allocate the children in
[in]	dst	where to copy the children to
[in]	src	where to copy the children from

Returns

• 0 on success
• <0 on error

Definition at line 1243 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_acopy_enumv()

int dict_attr_acopy_enumv	(	fr_dict_attr_t *	dst,
		fr_dict_attr_t const *	src
	)

Copy the VALUEs of an existing attribute, by casting them.

Parameters

[in]	dst	where to cast the VALUEs to
[in]	src	where to cast the VALUEs from

Returns

• 0 on success
• <0 on error

Definition at line 1340 of file dict_util.c.

Here is the call graph for this function:

dict_attr_add_to_namespace()

int dict_attr_add_to_namespace	(	fr_dict_attr_t const *	parent,
		fr_dict_attr_t *	da
	)

Add an attribute to the name table for an attribute.

Parameters

[in]	parent	containing the namespace to add this attribute to.
[in]	da	to add to the name lookup tables.

Returns

• 0 on success.
• -1 on failure.

Definition at line 1831 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_alias()

static fr_dict_attr_t const * dict_attr_alias ( fr_dict_attr_err_t *  err, fr_dict_attr_t const *  da  )

inlinestatic

Resolve an alias attribute to the concrete attribute it points to.

Parameters

[out]	err	where to write the error (if any).
[in]	da	to resolve.

Returns

• NULL on error.
• The concrete attribute on success.

Definition at line 358 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_alias_add()

int dict_attr_alias_add	(	fr_dict_attr_t const *	parent,
		char const *	alias,
		fr_dict_attr_t const *	ref,
		bool	from_public
	)

Add an alias to an existing attribute.

Definition at line 1456 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_alloc_null()

fr_dict_attr_t * dict_attr_alloc_null	(	TALLOC_CTX *	ctx,
		fr_dict_protocol_t const *	proto
	)

Allocate a partially completed attribute.

Partial initialisation functions.

This is useful in some instances where we need to pre-allocate the attribute for talloc hierarchy reasons, but want to finish initialising it with dict_attr_init later.

Parameters

[in]	ctx	to allocate attribute in.
[in]	proto	protocol specific extensions.

Returns

• A new, partially completed, fr_dict_attr_t on success.
• NULL on failure (memory allocation error).

Definition at line 1041 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_by_name()

fr_dict_attr_t * dict_attr_by_name	(	fr_dict_attr_err_t *	err,
		fr_dict_attr_t const *	parent,
		char const *	name
	)

Definition at line 3555 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_can_have_children()

bool dict_attr_can_have_children

(

fr_dict_attr_t const *

da

)

See if a fr_dict_attr_t can have children.

Parameters

da	the dictionary attribute to check.

Definition at line 1707 of file dict_util.c.

Here is the caller graph for this function:

dict_attr_child_add()

int dict_attr_child_add	(	fr_dict_attr_t *	parent,
		fr_dict_attr_t *	child
	)

Add a child to a parent.

Parameters

[in]	parent	we're adding a child to.
[in]	child	to add to parent.

Returns

• 0 on success.
• -1 on failure (memory allocation error).

Definition at line 1732 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_child_by_num()

fr_dict_attr_t * dict_attr_child_by_num	(	fr_dict_attr_t const *	parent,
		unsigned int	attr
	)

Internal version of fr_dict_attr_child_by_num.

Definition at line 3621 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_children_init()

static int dict_attr_children_init ( fr_dict_attr_t **  da_p )

inlinestatic

Add a child/nesting extension to an attribute.

Note

This function can only be used before the attribute is inserted into the dictionary.

Parameters

[in]

da_p

to set a group reference for.

Definition at line 436 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_enum_add_name()

int dict_attr_enum_add_name	(	fr_dict_attr_t *	da,
		char const *	name,
		fr_value_box_t const *	value,
		bool	coerce,
		bool	takes_precedence,
		fr_dict_attr_t const *	key_child_ref
	)

Definition at line 2076 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_enumv_init()

static int dict_attr_enumv_init ( fr_dict_attr_t **  da_p )

inlinestatic

Initialise a per-attribute enumeration table.

Note

This function can only be used before the attribute is inserted into the dictionary.

Parameters

[in]

da_p

to set a group reference for.

Definition at line 473 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_finalise()

int dict_attr_finalise	(	fr_dict_attr_t **	da_p,
		char const *	name
	)

Set remaining fields in a dictionary attribute before insertion.

Parameters

[in]	da_p	to finalise.
[in]	name	of the attribute.

Returns

• 0 on success.
• < 0 on error.

Definition at line 810 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_init_common()

static int dict_attr_init_common ( char const *  filename, int  line, fr_dict_attr_t **  da_p, fr_dict_attr_t const *  parent, fr_type_t  type, dict_attr_args_t const *  args  )

inlinestatic

Definition at line 881 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_location_init()

void dict_attr_location_init	(	fr_dict_t *	dict,
		fr_dict_attr_t *	da,
		char const *	filename,
		int	line
	)

Set where the dictionary attribute was defined.

The dict may be NULL when the attribute has no dictionary yet, in which case no location is recorded, and fr_dict_attr_filename() returns "<unknown>" for the attribute.

Definition at line 777 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_name_cmp()

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

static

Compare two attribute names.

Definition at line 185 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_name_hash()

static uint32_t dict_attr_name_hash ( void const *  data )

static

Wrap name hash function for fr_dict_attr_t.

Parameters

data	fr_dict_attr_t to hash.

Returns

the hash derived from the name of the attribute.

Definition at line 173 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_name_set()

static int dict_attr_name_set ( fr_dict_attr_t **  da_p, char const *  name  )

inlinestatic

Set a dictionary attribute's name.

Note

This function can only be used before the attribute is inserted into the dictionary.

Parameters

[in]	da_p	to set name for.
[in]	name	to set. If NULL a name will be automatically generated.

Definition at line 383 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_namespace_init()

static int dict_attr_namespace_init ( fr_dict_attr_t **  da_p )

inlinestatic

Initialise a per-attribute namespace.

Note

This function can only be used before the attribute is inserted into the dictionary.

Parameters

[in]

da_p

to set a group reference for.

Definition at line 489 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_num_init()

int dict_attr_num_init	(	fr_dict_attr_t *	da,
		unsigned int	num
	)

Set the attribute number (if any)

Parameters

[in]	da	to set the attribute number for.
[in]	num	to set.

Definition at line 693 of file dict_util.c.

Here is the caller graph for this function:

dict_attr_num_init_name_only()

int dict_attr_num_init_name_only

(

fr_dict_attr_t *

da

)

Set the attribute number (if any)

Note

Must have a parent set.

Parameters

[in]

da

to set the attribute number for.

Definition at line 711 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_parent_init()

int dict_attr_parent_init	(	fr_dict_attr_t **	da_p,
		fr_dict_attr_t const *	parent
	)

Initialise fields which depend on a parent attribute.

Parameters

[in,out]	da_p	to initialise.
[in]	parent	of the attribute.

Returns

• 0 on success.
• < 0 on error.

Definition at line 611 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_search()

static fr_slen_t dict_attr_search ( fr_dict_attr_err_t *  err, fr_dict_attr_t const **  out, fr_dict_t const *  dict_def, fr_sbuff_t *  in, fr_sbuff_term_t const *  tt, bool  internal, bool  foreign, dict_attr_resolve_func_t  func  )

inlinestatic

Internal function for searching for attributes in multiple dictionaries.

Parameters

[out]	err	Any errors that occurred searching.
[out]	out	The attribute we found.
[in]	dict_def	The default dictionary to search in.
[in]	in	string to resolve to an attribute.
[in]	tt	terminals that indicate the end of the string.
[in]	internal	Resolve the attribute in the internal dictionary.
[in]	foreign	Resolve attribute in a foreign dictionary, i.e. one other than dict_def.
[in]	func	to use for resolution.

Returns

• <=0 on error (the offset of the error).
• >0 on success.

Definition at line 3098 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_search_qualified()

static fr_slen_t dict_attr_search_qualified ( fr_dict_attr_err_t *  err, fr_dict_attr_t const **  out, fr_dict_t const *  dict_def, fr_sbuff_t *  in, fr_sbuff_term_t const *  tt, bool  internal, bool  foreign, dict_attr_resolve_func_t  func  )

inlinestatic

Internal function for searching for attributes in multiple dictionaries.

Unlike dict_attr_search this function searches for a protocol name preceding the attribute identifier.

Definition at line 3246 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_type_init()

int dict_attr_type_init	(	fr_dict_attr_t **	da_p,
		fr_type_t	type
	)

Initialise type specific fields within the dictionary attribute.

Call when the type of the attribute is known.

Parameters

[in,out]	da_p	to set the type for.
[in]	type	to set.

Returns

• 0 on success.
• < 0 on error.

Definition at line 526 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_attr_vendor_set()

static int dict_attr_vendor_set ( fr_dict_attr_t **  da_p, fr_dict_attr_t const *  vendor  )

inlinestatic

Cache the vendor pointer for an attribute.

Note

This function can only be used before the attribute is inserted into the dictionary.

Parameters

[in]	da_p	to set a group reference for.
[in]	vendor	to set.

Definition at line 455 of file dict_util.c.

Here is the call graph for this function:

dict_autoref_free()

static int dict_autoref_free ( fr_dict_t *  dict )

static

Definition at line 4148 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_by_da()

fr_dict_t * dict_by_da

(

fr_dict_attr_t const *

da

)

Internal version of fr_dict_by_da.

Note

For internal use by the dictionary API only.

Attempt to locate the protocol dictionary containing an attribute.

Definition at line 2867 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_by_protocol_name()

fr_dict_t * dict_by_protocol_name

(

char const *

name

)

Internal version of fr_dict_by_protocol_name.

Note

For internal use by the dictionary API only.

Lookup a protocol by its name.

Definition at line 2831 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_by_protocol_num()

fr_dict_t * dict_by_protocol_num

(

unsigned int

num

)

Internal version of fr_dict_by_protocol_num.

Note

For internal use by the dictionary API only.

Lookup a protocol by its number.

Definition at line 2849 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_by_protocol_substr()

fr_slen_t dict_by_protocol_substr	(	fr_dict_attr_err_t *	err,
		fr_dict_t **	out,
		fr_sbuff_t *	name,
		fr_dict_t const *	dict_def
	)

Definition at line 2735 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_dependent_add()

int dict_dependent_add	(	fr_dict_t *	dict,
		char const *	dependent
	)

Record a new dependency on a dictionary.

These are used to determine what is currently depending on a dictionary.

Parameters

[in]	dict	to record dependency on.
[in]	dependent	Either C src file, or another dictionary.

Returns

• 0 on success.
• -1 on failure.

Definition at line 4033 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_dependent_remove()

int dict_dependent_remove	(	fr_dict_t *	dict,
		char const *	dependent
	)

Decrement ref count for a dependent in a dictionary.

Parameters

[in]	dict	to remove dependency from.
[in]	dependent	Either C src, or another dictionary dependent. What depends on this dictionary.

Definition at line 4092 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_dlopen()

int dict_dlopen	(	fr_dict_t *	dict,
		char const *	name
	)

Definition at line 3942 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_enum_name_cmp()

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

static

Compare two dictionary attribute enum values.

Definition at line 316 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_enum_name_hash()

static uint32_t dict_enum_name_hash ( void const *  data )

static

Hash a enumeration name.

Definition at line 306 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_enum_value_cmp()

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

static

Compare two dictionary enum values.

Definition at line 342 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_enum_value_hash()

static uint32_t dict_enum_value_hash ( void const *  data )

static

Hash a dictionary enum value.

Definition at line 332 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_filename_cmp()

static int8_t dict_filename_cmp ( void const *  one, void const *  two  )

static

Compare two fr_dict_filename_t by filename.

Definition at line 4261 of file dict_util.c.

Here is the caller graph for this function:

dict_filename_hash()

static uint32_t dict_filename_hash ( void const *  data )

static

Hash the filename of a fr_dict_filename_t.

Definition at line 4254 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_filename_intern()

fr_dict_filename_t * dict_filename_intern	(	fr_dict_t *	dict,
		char const *	filename
	)

Return the table entry for a filename, creating the entry if the filename is not in the table.

Definition at line 729 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_has_dependents()

bool dict_has_dependents

(

fr_dict_t *

dict

)

Check if a dictionary still has dependents.

Parameters

[in]

dict

to check

Returns

• true if there's still at least one dependent.
• false if there are no dependents.

Definition at line 4124 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_hash_name()

static uint32_t dict_hash_name ( char const *  name, size_t  len  )

static

Apply a simple (case insensitive) hashing function to the name of an attribute, vendor or protocol.

Parameters

[in]	name	of the attribute, vendor or protocol.
[in]	len	length of the input string.

Returns

the hashed derived from the name.

Definition at line 103 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_protocol_add()

int dict_protocol_add

(

fr_dict_t *

dict

)

Add a protocol to the global protocol table.

Inserts a protocol into the global protocol table. Uses the root attributes of the dictionary for comparisons.

Parameters

[in]

dict

of protocol we're inserting.

Returns

• 0 on success.
• -1 on failure.

Definition at line 1564 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_protocol_name_cmp()

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

static

Compare two protocol names.

Definition at line 139 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_protocol_name_hash()

static uint32_t dict_protocol_name_hash ( void const *  data )

static

Wrap name hash function for fr_dict_protocol_t.

Parameters

[in]

data

fr_dict_attr_t to hash.

Returns

the hash derived from the name of the attribute.

Definition at line 127 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_protocol_num_cmp()

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

static

Compare two protocol numbers.

Definition at line 160 of file dict_util.c.

Here is the caller graph for this function:

dict_protocol_num_hash()

static uint32_t dict_protocol_num_hash ( void const *  data )

static

Hash a protocol number.

Definition at line 152 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_vendor_add()

int dict_vendor_add	(	fr_dict_t *	dict,
		char const *	name,
		unsigned int	num
	)

Add a vendor to the dictionary.

Inserts a vendor entry into the vendor hash table. This must be done before adding attributes under a VSA.

Parameters

[in]	dict	of protocol context we're operating in. If NULL the internal dictionary will be used.
[in]	name	of the vendor.
[in]	num	Vendor's Private Enterprise Number.

Returns

• 0 on success.
• -1 on failure.

Definition at line 1637 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_vendor_name_cmp()

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

static

Compare two attribute names.

Definition at line 273 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_vendor_name_hash()

static uint32_t dict_vendor_name_hash ( void const *  data )

static

Wrap name hash function for fr_dict_vendor_t.

Parameters

data	fr_dict_vendor_t to hash.

Returns

the hash derived from the name of the attribute.

Definition at line 261 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_vendor_pen_cmp()

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

static

Compare two vendor numbers.

Definition at line 295 of file dict_util.c.

Here is the caller graph for this function:

dict_vendor_pen_hash()

static uint32_t dict_vendor_pen_hash ( void const *  data )

static

Hash a vendor number.

Definition at line 286 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

dict_walk()

static int dict_walk ( fr_dict_attr_t const *  da, fr_dict_walk_t  callback, void *  uctx  )

static

Call the specified callback for da and then for all its children.

Definition at line 5176 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_acopy_local()

int fr_dict_attr_acopy_local	(	fr_dict_attr_t const *	dst,
		fr_dict_attr_t const *	src
	)

Definition at line 1181 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_add()

int fr_dict_attr_add	(	fr_dict_t *	dict,
		fr_dict_attr_t const *	parent,
		char const *	name,
		unsigned int	attr,
		fr_type_t	type,
		fr_dict_attr_flags_t const *	flags
	)

Add an attribute to the dictionary.

Parameters

[in]	dict	of protocol context we're operating in. If NULL the internal dictionary will be used.
[in]	parent	to add attribute under.
[in]	name	of the attribute.
[in]	attr	number.
[in]	type	of attribute.
[in]	flags	to set in the attribute.

Returns

• 0 on success.
• -1 on failure.

Definition at line 2023 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_add_initialised()

int fr_dict_attr_add_initialised

(

fr_dict_attr_t *

da

)

A variant of fr_dict_attr_t that allows a pre-allocated, populated fr_dict_attr_t to be added.

Definition at line 1897 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_add_name_only()

int fr_dict_attr_add_name_only	(	fr_dict_t *	dict,
		fr_dict_attr_t const *	parent,
		char const *	name,
		fr_type_t	type,
		fr_dict_attr_flags_t const *	flags
	)

Add an attribute to the dictionary.

Parameters

[in]	dict	of protocol context we're operating in. If NULL the internal dictionary will be used.
[in]	parent	to add attribute under.
[in]	name	of the attribute.
[in]	type	of attribute.
[in]	flags	to set in the attribute.

Returns

• 0 on success.
• -1 on failure.

Definition at line 2062 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_autoload()

int fr_dict_attr_autoload

(

fr_dict_attr_autoload_t const *

to_load

)

Process a dict_attr_autoload element to load/verify a dictionary attribute.

Parameters

[in]

to_load

attribute definition

Returns

• 0 on success.
• -1 on failure.

Definition at line 4503 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_by_name()

fr_dict_attr_t const * fr_dict_attr_by_name	(	fr_dict_attr_err_t *	err,
		fr_dict_attr_t const *	parent,
		char const *	name
	)

Locate a fr_dict_attr_t by its name.

Parameters

[out]

err

Why the lookup failed. May be NULL.

See also

fr_dict_attr_err_t.

Parameters

[in]	parent	containing the namespace we're searching in.
[in]	name	of the attribute to locate.

Returns

• Attribute matching name.
• NULL if no matching attribute could be found.

Definition at line 3601 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_by_name_substr()

fr_slen_t fr_dict_attr_by_name_substr	(	fr_dict_attr_err_t *	err,
		fr_dict_attr_t const **	out,
		fr_dict_attr_t const *	parent,
		fr_sbuff_t *	name,
		UNUSED fr_sbuff_term_t const *	tt
	)

Look up a dictionary attribute by a name embedded in another string.

Find the first invalid attribute name char in the string pointed to by name.

Copy the characters between the start of the name string and the first none fr_dict_attr_allowed_chars char to a buffer and perform a dictionary lookup using that value.

If the attribute exists, advance the pointer pointed to by name to the first none fr_dict_attr_allowed_chars char, and return the DA.

If the attribute does not exist, don't advance the pointer and return NULL.

Parameters

[out]

err

Why parsing failed. May be NULL.

See also

fr_dict_attr_err_t

Parameters

[out]	out	Where to store the resolve attribute.
[in]	parent	containing the namespace to search in.
[in]	name	string start.
[in]	tt	Terminal sequences to use to determine the portion of in to search.

Returns

• <= 0 on failure.
• The number of bytes of name consumed on success.

Definition at line 3470 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_by_oid()

fr_dict_attr_t const * fr_dict_attr_by_oid	(	fr_dict_attr_err_t *	err,
		fr_dict_attr_t const *	parent,
		char const *	oid
	)

Resolve an attribute using an OID string.

Parameters

[out]	err	The parsing error that occurred.
[in]	parent	Where to resolve relative attributes from.
[in]	oid	string to parse.

Returns

• NULL if we couldn't resolve the attribute.
• The resolved attribute.

Definition at line 2693 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_by_oid_legacy()

ssize_t fr_dict_attr_by_oid_legacy	(	fr_dict_attr_t const **	parent,
		unsigned int *	attr,
		char const *	oid
	)

Get the leaf attribute of an OID string.

Note

On error, vendor will be set (if present), parent will be the maximum depth we managed to resolve to, and attr will be the child we failed to resolve.

Parameters

[out]	attr	Number we parsed.
[in,out]	parent	attribute (or root of dictionary). Will be updated to the parent directly beneath the leaf.
[in]	oid	string to parse.

Returns

• > 0 on success (number of bytes parsed).
• <= 0 on parse error (negative offset of parse error).

Definition at line 2454 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_by_oid_substr()

fr_slen_t fr_dict_attr_by_oid_substr	(	fr_dict_attr_err_t *	err,
		fr_dict_attr_t const **	out,
		fr_dict_attr_t const *	parent,
		fr_sbuff_t *	in,
		fr_sbuff_term_t const *	tt
	)

Resolve an attribute using an OID string.

Note

Will leave the sbuff pointing at the component the error occurred at so that the caller can attempt to process the component in another way. An err pointer should be provided in order to determine if an error occurred.

Parameters

[out]	err	The parsing error that occurred.
[out]	out	The deepest attribute we resolved.
[in]	parent	Where to resolve relative attributes from.
[in]	in	string to parse.
[in]	tt	Terminal strings.

Returns

The number of bytes of name consumed.

Definition at line 2644 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_can_contain()

bool fr_dict_attr_can_contain	(	fr_dict_attr_t const *	parent,
		fr_dict_attr_t const *	child
	)

See if a structural da is allowed to contain another da.

We have some complex rules with different structural types, different protocol dictionaries, references to other protocols, etc.

Parameters

[in]	parent	The parent da, must be structural
[in]	child	The alleged child

Returns

• false - the child is not allowed to be contained by the parent
• true - the child is allowed to be contained by the parent

Definition at line 5297 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_child_by_num()

fr_dict_attr_t const * fr_dict_attr_child_by_num	(	fr_dict_attr_t const *	parent,
		unsigned int	attr
	)

Check if a child attribute exists in a parent using an attribute number.

Parameters

[in]	parent	to check for child in.
[in]	attr	number to look for.

Returns

• The child attribute on success.
• NULL if the child attribute does not exist.

Definition at line 3668 of file dict_util.c.

Here is the call graph for this function:

fr_dict_attr_common_parent()

fr_dict_attr_t const * fr_dict_attr_common_parent	(	fr_dict_attr_t const *	a,
		fr_dict_attr_t const *	b,
		bool	is_ancestor
	)

Find a common ancestor that two TLV type attributes share.

Parameters

[in]	a	first TLV attribute.
[in]	b	second TLV attribute.
[in]	is_ancestor	Enforce a->b relationship (a is parent or ancestor of b).

Returns

• Common ancestor if one exists.
• NULL if no common ancestor exists.

Definition at line 2368 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_attr_filename()

char const * fr_dict_attr_filename

(

fr_dict_attr_t const *

da

)

Resolve an attribute's location file id to the filename.

Definition at line 795 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_attr_iterate_children()

fr_dict_attr_t const * fr_dict_attr_iterate_children	(	fr_dict_attr_t const *	parent,
		fr_dict_attr_t const **	prev
	)

Iterate over children of a DA.

Parameters

[in]	parent	the parent da to iterate over
[in,out]	prev	pointer to NULL to start, otherwise pointer to the previously returned child

Returns

• NULL for end of iteration
• !NULL for a valid child. This child MUST be passed to the next loop.

Definition at line 5122 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_ordered_cmp()

int8_t fr_dict_attr_ordered_cmp	(	fr_dict_attr_t const *	a,
		fr_dict_attr_t const *	b
	)

Compare two attributes by total order.

This function is safe / ordered even when the attributes are in different dictionaries. This allows it to work for local variables, as those are in a different dictionary from the protocol ones.

This function orders parents first, then their children.

Definition at line 203 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_search_by_name_substr()

fr_slen_t fr_dict_attr_search_by_name_substr	(	fr_dict_attr_err_t *	err,
		fr_dict_attr_t const **	out,
		fr_dict_t const *	dict_def,
		fr_sbuff_t *	name,
		fr_sbuff_term_t const *	tt,
		bool	internal,
		bool	foreign
	)

Locate a fr_dict_attr_t by its name in the top level namespace of a dictionary.

This function will search through all loaded dictionaries, or a subset of loaded dictionaries, for a matching attribute in the top level namespace.

Note

If calling this function from the server any list or request qualifiers should be stripped first.

Parameters

[out]

err

Why parsing failed. May be NULL.

See also

fr_dict_attr_err_t

Parameters

[out]	out	Dictionary found attribute.
[in]	dict_def	Default dictionary for non-qualified dictionaries.
[in]	name	Dictionary/Attribute name.
[in]	tt	Terminal strings.
[in]	internal	If true, fallback to the internal dictionary.
[in]	foreign	If true, fallback to foreign dictionaries.

Returns

• < 0 on failure.
• The number of bytes of name consumed on success.

Definition at line 3342 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_search_by_oid_substr()

fr_slen_t fr_dict_attr_search_by_oid_substr	(	fr_dict_attr_err_t *	err,
		fr_dict_attr_t const **	out,
		fr_dict_t const *	dict_def,
		fr_sbuff_t *	in,
		fr_sbuff_term_t const *	tt,
		bool	internal,
		bool	foreign
	)

Locate a qualified fr_dict_attr_t by a dictionary using a non-qualified OID string.

This function will search through all loaded dictionaries, or a subset of loaded dictionaries, for a matching attribute.

Note

If calling this function from the server any list or request qualifiers should be stripped first.

err should be checked to determine if a parse error occurred.

Parameters

[out]

err

Why parsing failed. May be NULL.

See also

fr_dict_attr_err_t

Parameters

[out]	out	Dictionary found attribute.
[in]	dict_def	Default dictionary for non-qualified dictionaries.
[in]	in	Dictionary/Attribute name.
[in]	tt	Terminal strings.
[in]	internal	If true, fallback to the internal dictionary.
[in]	foreign	If true, fallback to foreign dictionaries.

Returns

The number of bytes of name consumed.

Definition at line 3400 of file dict_util.c.

Here is the call graph for this function:

fr_dict_attr_search_by_qualified_name_substr()

fr_slen_t fr_dict_attr_search_by_qualified_name_substr	(	fr_dict_attr_err_t *	err,
		fr_dict_attr_t const **	out,
		fr_dict_t const *	dict_def,
		fr_sbuff_t *	name,
		fr_sbuff_term_t const *	tt,
		bool	internal,
		bool	foreign
	)

Locate a qualified fr_dict_attr_t by its name and a dictionary qualifier.

This function will search through all loaded dictionaries, or a subset of loaded dictionaries, for a matching attribute in the top level namespace.

This attribute may be qualified with <protocol>. to selection an attribute in a specific case.

Note

If calling this function from the server any list or request qualifiers should be stripped first.

Parameters

[out]

err

Why parsing failed. May be NULL.

See also

fr_dict_attr_err_t

Parameters

[out]	out	Dictionary found attribute.
[in]	dict_def	Default dictionary for non-qualified dictionaries.
[in]	name	Dictionary/Attribute name.
[in]	tt	Terminal strings.
[in]	internal	If true, fallback to the internal dictionary.
[in]	foreign	If true, fallback to foreign dictionaries.

Returns

• < 0 on failure.
• The number of bytes of name consumed on success.

Definition at line 3313 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_search_by_qualified_oid()

fr_dict_attr_t const * fr_dict_attr_search_by_qualified_oid	(	fr_dict_attr_err_t *	err,
		fr_dict_t const *	dict_def,
		char const *	name,
		bool	internal,
		bool	foreign
	)

Locate a qualified fr_dict_attr_t by its name and a dictionary qualifier.

Parameters

[out]

err

Why parsing failed. May be NULL.

See also

fr_dict_attr_err_t.

Parameters

[in]	dict_def	Default dictionary for non-qualified dictionaries.
[in]	name	Dictionary/Attribute name.
[in]	internal	If true, fallback to the internal dictionary.
[in]	foreign	If true, fallback to foreign dictionaries.

Returns

an fr_dict_attr_err_t value.

Definition at line 3419 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_search_by_qualified_oid_substr()

fr_slen_t fr_dict_attr_search_by_qualified_oid_substr	(	fr_dict_attr_err_t *	err,
		fr_dict_attr_t const **	out,
		fr_dict_t const *	dict_def,
		fr_sbuff_t *	in,
		fr_sbuff_term_t const *	tt,
		bool	internal,
		bool	foreign
	)

Locate a qualified fr_dict_attr_t by a dictionary qualified OID string.

This function will search through all loaded dictionaries, or a subset of loaded dictionaries, for a matching attribute.

Note

If calling this function from the server any list or request qualifiers should be stripped first.

err should be checked to determine if a parse error occurred.

Parameters

[out]

err

Why parsing failed. May be NULL.

See also

fr_dict_attr_err_t

Parameters

[out]	out	Dictionary found attribute.
[in]	dict_def	Default dictionary for non-qualified dictionaries.
[in]	in	Dictionary/Attribute name.
[in]	tt	Terminal strings.
[in]	internal	If true, fallback to the internal dictionary.
[in]	foreign	If true, fallback to foreign dictionaries.

Returns

The number of bytes of name consumed.

Definition at line 3371 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_set_group()

int fr_dict_attr_set_group	(	fr_dict_attr_t **	da_p,
		fr_dict_attr_t const *	ref
	)

Definition at line 5391 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_unconst()

fr_dict_attr_t * fr_dict_attr_unconst

(

fr_dict_attr_t const *

da

)

Coerce to non-const.

Definition at line 5023 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_attr_verify()

void fr_dict_attr_verify	(	char const *	file,
		int	line,
		fr_dict_attr_t const *	da
	)

Definition at line 5207 of file dict_util.c.

Here is the call graph for this function:

fr_dict_by_da()

fr_dict_t const * fr_dict_by_da

(

fr_dict_attr_t const *

da

)

Attempt to locate the protocol dictionary containing an attribute.

Note

Unlike fr_dict_by_attr_name, doesn't search through all the dictionaries, just uses the fr_dict_attr_t hierarchy and the talloc hierarchy to locate the dictionary (much much faster and more scalable).

Parameters

[in]

da

To get the containing dictionary for.

Returns

• The dictionary containing da.
• NULL.

Definition at line 2937 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_by_protocol_name()

fr_dict_t const * fr_dict_by_protocol_name

(

char const *

name

)

Lookup a protocol by its name.

Note

For internal use by the dictionary API only.

Parameters

[in]

name

of the protocol to locate.

Returns

• Attribute matching name.
• NULL if no matching protocol could be found.

Definition at line 2908 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_by_protocol_num()

fr_dict_t const * fr_dict_by_protocol_num

(

unsigned int

num

)

Lookup a protocol by its number.

Returns the fr_dict_t belonging to the protocol with the specified number if any have been registered.

Parameters

[in]

num

to search for.

Returns

dictionary representing the protocol (if it exists).

Definition at line 2921 of file dict_util.c.

Here is the call graph for this function:

fr_dict_by_protocol_substr()

fr_slen_t fr_dict_by_protocol_substr	(	fr_dict_attr_err_t *	err,
		fr_dict_t const **	out,
		fr_sbuff_t *	name,
		fr_dict_t const *	dict_def
	)

Look up a protocol name embedded in another string.

Parameters

[out]	err	Parsing error.
[out]	out	the resolve dictionary or NULL if the dictionary couldn't be resolved.
[in]	name	string start.
[in]	dict_def	The dictionary to return if no dictionary qualifier was found.

Returns

• 0 and *out != NULL. Couldn't find a dictionary qualifier, so returned dict_def.
• < 0 on error and (*out == NULL) (offset as negative integer)
• > 0 on success (number of bytes parsed).

Definition at line 2820 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_compatible()

bool fr_dict_compatible	(	fr_dict_t const *	dict1,
		fr_dict_t const *	dict2
	)

See if two dictionaries have the same end parent.

Parameters

[in]	dict1	one dictionary
[in]	dict2	two dictionary

Returns

• true the dictionaries have the same end parent
• false the dictionaries do not have the same end parent.

Definition at line 2950 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_const_free()

int fr_dict_const_free	(	fr_dict_t const **	dict,
		char const *	dependent
	)

Decrement the reference count on a previously loaded dictionary.

Parameters

[in]	dict	to free.
[in]	dependent	that originally allocated this dictionary.

Returns

• 0 on success (dictionary freed).
• 1 if other things still depend on the dictionary.
• -1 on error (dependent doesn't exist)

Definition at line 4421 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_dependent_add()

int fr_dict_dependent_add	(	fr_dict_t const *	dict,
		char const *	dependent
	)

Manually increase the reference count for a dictionary.

This is useful if a previously loaded dictionary needs to be bound to the lifetime of an additional object.

Parameters

[in]	dict	to increase the reference count for.
[in]	dependent	requesting the loading of the dictionary.

Returns

• 0 on success.
• -1 on error.

Definition at line 4077 of file dict_util.c.

Here is the call graph for this function:

fr_dict_dl()

dl_t * fr_dict_dl

(

fr_dict_t const *

dict

)

Definition at line 2730 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_enum_add_name()

int fr_dict_enum_add_name	(	fr_dict_attr_t *	da,
		char const *	name,
		fr_value_box_t const *	value,
		bool	coerce,
		bool	takes_precedence
	)

Add a value name.

Aliases are textual (string) names for a given value.

Value names are not limited to integers, and may be added for any non-structural attribute type.

Parameters

[in]	da	to add enumeration value to.
[in]	name	Name of value name.
[in]	value	to associate with name.
[in]	coerce	if the type of the value does not match the type of the da, attempt to cast it to match the type of the da. If this is false and there's a type mismatch, we fail. We also fail if the value cannot be coerced to the attribute type.
[in]	takes_precedence	This name should take precedence over previous names for the same value, when resolving value to name.

Returns

• 0 on success.
• -1 on failure.

Definition at line 2272 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_enum_add_name_next()

int fr_dict_enum_add_name_next	(	fr_dict_attr_t *	da,
		char const *	name
	)

Add an name to an integer attribute hashing the name for the integer value.

If the integer value conflicts with an existing name, it's incremented until we find a free value.

Definition at line 2284 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_enum_autoload()

int fr_dict_enum_autoload

(

fr_dict_enum_autoload_t const *

to_load

)

Process a dict_attr_autoload element to load/verify a dictionary attribute.

Parameters

[in]

to_load

attribute definition

Returns

• 0 on success.
• -1 on failure.

Definition at line 4464 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_enum_by_name()

fr_dict_enum_value_t const * fr_dict_enum_by_name	(	fr_dict_attr_t const *	da,
		char const *	name,
		ssize_t	len
	)

Definition at line 3779 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_enum_by_name_substr()

fr_slen_t fr_dict_enum_by_name_substr	(	fr_dict_enum_value_t **	out,
		fr_dict_attr_t const *	da,
		fr_sbuff_t *	in
	)

Definition at line 3808 of file dict_util.c.

Here is the call graph for this function:

fr_dict_enum_by_value()

fr_dict_enum_value_t const * fr_dict_enum_by_value	(	fr_dict_attr_t const *	da,
		fr_value_box_t const *	value
	)

Lookup the structure representing an enum value in a fr_dict_attr_t.

Parameters

[in]	da	to search in.
[in]	value	to search for.

Returns

• Matching fr_dict_enum_value_t.
• NULL if no matching fr_dict_enum_value_t could be found.

Definition at line 3730 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_enum_iter_init()

fr_dict_enum_value_t const * fr_dict_enum_iter_init	(	fr_dict_attr_t const *	da,
		fr_dict_enum_iter_t *	iter
	)

Iterate over all enumeration values for an attribute.

Parameters

[in]	da	to iterate over.
[in]	iter	to use for iteration.

Returns

• First fr_dict_enum_value_t in the attribute.
• NULL if no enumeration values exist.

Definition at line 3689 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_enum_iter_next()

fr_dict_enum_value_t const * fr_dict_enum_iter_next	(	fr_dict_attr_t const *	da,
		fr_dict_enum_iter_t *	iter
	)

Definition at line 3710 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_enum_name_by_value()

char const * fr_dict_enum_name_by_value	(	fr_dict_attr_t const *	da,
		fr_value_box_t const *	value
	)

Lookup the name of an enum value in a fr_dict_attr_t.

Parameters

[in]	da	to search in.
[in]	value	number to search for.

Returns

• Name of value.
• NULL if no matching value could be found.

Definition at line 3766 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_enum_name_from_substr()

fr_slen_t fr_dict_enum_name_from_substr	(	fr_sbuff_t *	out,
		fr_sbuff_parse_error_t *	err,
		fr_sbuff_t *	in,
		fr_sbuff_term_t const *	tt
	)

Extract an enumeration name from a string.

This function defines the canonical format for an enumeration name.

An enumeration name is made up of one or more fr_dict_attr_allowed_chars with at least one character in the sequence not being a special character i.e. [-+/_] or a number.

This disambiguates enumeration identifiers from mathematical expressions.

If we allowed enumeration names consisting of sequences of numbers separated by special characters it would not be possible to determine if the special character were an operator in a subexpression.

For example take:

&My-Enum-Attr == 01234-5678

Without having access to the enumeration values of My-Enum-Attr (which we might not have during tokenisation), we cannot tell if this is:

(&My-Enum-Attr == 01234-5678)

OR

((&My-Enum-Attr == 01234) - 5678)

If an alpha character occurs anywhere in the string i.e:

(&My-Enum-Attr == 01234-A5678)

we know 01234-A5678 can't be a mathematical sub-expression because the second potential operand can no longer be parsed as an integer constant.

Parameters

[out]	out	The name string we managed to extract. May be NULL in which case only the length of the name will be returned.
[out]	err	Type of parsing error which occurred. May be NULL.
[in]	in	The string containing the enum identifier.
[in]	tt	If non-null verify that a terminal sequence occurs after the enumeration name.

Returns

• <0 the offset at which the parse error occurred.
• >1 the number of bytes parsed.

Definition at line 3902 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_free()

int fr_dict_free	(	fr_dict_t **	dict,
		char const *	dependent
	)

Decrement the reference count on a previously loaded dictionary.

Parameters

[in]	dict	to free.
[in]	dependent	that originally allocated this dictionary.

Returns

• 0 on success (dictionary freed).
• 1 if other things still depend on the dictionary.
• -1 on error (dependent doesn't exist)

Definition at line 4437 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_gctx_debug()

void fr_dict_gctx_debug	(	FILE *	fp,
		fr_dict_gctx_t const *	gctx
	)

Dump information about currently loaded dictionaries.

Intended to be called from a debugger

Definition at line 4954 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_global_ctx_dir()

char const * fr_dict_global_ctx_dir

(

void

)

Definition at line 4918 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_global_ctx_dir_set()

int fr_dict_global_ctx_dir_set

(

char const *

dict_dir

)

Allow the default dict dir to be changed after initialisation.

Parameters

[in]

dict_dir

New default dict dir to use.

Returns

• 0 on success.
• -1 on failure.

Definition at line 4907 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_global_ctx_free()

int fr_dict_global_ctx_free

(

fr_dict_gctx_t const *

gctx

)

Explicitly free all data associated with a global dictionary context.

Note

You should NOT ignore the return code of this function. You should use perror() or PERROR() to print out the reason why freeing failed.

Parameters

[in]

gctx

To set.

Returns

• 0 on success.
• -1 on failure.

Definition at line 4893 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_global_ctx_init()

fr_dict_gctx_t * fr_dict_global_ctx_init	(	TALLOC_CTX *	ctx,
		bool	free_at_exit,
		char const *	dict_dir
	)

Initialise the global protocol hashes.

Note

Must be called before any other dictionary functions.

Parameters

[in]	ctx	to allocate global resources in.
[in]	free_at_exit	Install an at_exit handler to free the global ctx. This is useful when dictionaries are held by other libraries which free them using atexit handlers.
[in]	dict_dir	the default location for the dictionaries.

Returns

• A pointer to the new global context on success.
• NULL on failure.

Definition at line 4821 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_global_ctx_iter_init()

fr_dict_t * fr_dict_global_ctx_iter_init

(

fr_dict_global_ctx_iter_t *

iter

)

Iterate protocols by name.

Definition at line 4993 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_global_ctx_iter_next()

fr_dict_t * fr_dict_global_ctx_iter_next

(

fr_dict_global_ctx_iter_t *

iter

)

Definition at line 5000 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_global_ctx_perm_check()

void fr_dict_global_ctx_perm_check	(	fr_dict_gctx_t *	gctx,
		bool	enable
	)

Set whether we check dictionary file permissions.

Parameters

[in]	gctx	to alter.
[in]	enable	Whether we should check file permissions as they're loaded.

Definition at line 4868 of file dict_util.c.

fr_dict_global_ctx_read_only()

void fr_dict_global_ctx_read_only

(

void

)

Mark all dictionaries and the global dictionary ctx as read only.

Any attempts to add new attributes will now fail.

Definition at line 4927 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_global_ctx_set()

void fr_dict_global_ctx_set

(

fr_dict_gctx_t const *

gctx

)

Set a new, active, global dictionary context.

Parameters

[in]

gctx

To set.

Definition at line 4877 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_internal()

fr_dict_t const * fr_dict_internal

(

void

)

Definition at line 5036 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_is_read_only()

bool fr_dict_is_read_only

(

fr_dict_t const *

dict

)

Definition at line 2725 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_oid_component()

fr_slen_t fr_dict_oid_component	(	fr_dict_attr_err_t *	err,
		fr_dict_attr_t const **	out,
		fr_dict_attr_t const *	parent,
		fr_sbuff_t *	in,
		fr_sbuff_term_t const *	tt
	)

Parse an OID component, resolving it to a defined attribute.

Note

Will leave the sbuff pointing at the component the error occurred at so that the caller can attempt to process the component in another way.

Parameters

[out]	err	The parsing error that occurred.
[out]	out	The deepest attribute we resolved.
[in]	parent	Where to resolve relative attributes from.
[in]	in	string to parse.
[in]	tt	Terminal strings.

Returns

• >0 the number of bytes consumed.
• <0 Parse error occurred here.

Definition at line 2545 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_oid_component_legacy()

int fr_dict_oid_component_legacy	(	unsigned int *	out,
		char const **	oid
	)

Process a single OID component.

Parameters

[out]	out	Value of component.
[in]	oid	string to parse.

Returns

• 0 on success.
• -1 on format error.

Definition at line 2411 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_proto_dict()

fr_dict_t const * fr_dict_proto_dict

(

fr_dict_t const *

dict

)

Definition at line 5384 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_protocol()

fr_dict_protocol_t const * fr_dict_protocol

(

fr_dict_t const *

dict

)

Return the protocol descriptor for the dictionary.

Definition at line 5360 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_protocol_alloc()

fr_dict_t * fr_dict_protocol_alloc

(

fr_dict_t const *

parent

)

Allocate a new local dictionary.

Parameters

[in]

parent

parent dictionary and talloc ctx

Returns

• NULL on memory allocation error.

This dictionary cannot define vendors, or inter-dictionary dependencies. However, we initialize the relevant fields just in case. We should arguably just skip initializing those fields, and just allow the server to crash if programmers do something stupid with it.

Definition at line 4367 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_root()

fr_dict_attr_t const * fr_dict_root

(

fr_dict_t const *

dict

)

Return the root attribute of a dictionary.

Parameters

dict	to return root for.

Returns

the root attribute of the dictionary.

Definition at line 2720 of file dict_util.c.

fr_dict_unconst()

fr_dict_t * fr_dict_unconst

(

fr_dict_t const *

dict

)

Coerce to non-const.

Definition at line 5011 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_unlocal()

fr_dict_attr_t const * fr_dict_unlocal

(

fr_dict_attr_t const *

da

)

Definition at line 5368 of file dict_util.c.

fr_dict_valid_name()

ssize_t fr_dict_valid_name	(	char const *	name,
		ssize_t	len
	)

Definition at line 5046 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_valid_oid_str()

ssize_t fr_dict_valid_oid_str	(	char const *	name,
		ssize_t	len
	)

Definition at line 5089 of file dict_util.c.

Here is the caller graph for this function:

fr_dict_vendor_by_da()

fr_dict_vendor_t const * fr_dict_vendor_by_da

(

fr_dict_attr_t const *

da

)

Look up a vendor by one of its child attributes.

Parameters

[in]

da

The vendor attribute.

Returns

• The vendor.
• NULL if no vendor with that number was registered for this protocol.

Definition at line 2966 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_vendor_by_name()

fr_dict_vendor_t const * fr_dict_vendor_by_name	(	fr_dict_t const *	dict,
		char const *	name
	)

Look up a vendor by its name.

Parameters

[in]	dict	of protocol context we're operating in. If NULL the internal dictionary will be used.
[in]	name	to search for.

Returns

• The vendor.
• NULL if no vendor with that name was registered for this protocol.

Definition at line 2991 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_vendor_by_num()

fr_dict_vendor_t const * fr_dict_vendor_by_num	(	fr_dict_t const *	dict,
		uint32_t	vendor_pen
	)

Look up a vendor by its PEN.

Parameters

[in]	dict	of protocol context we're operating in. If NULL the internal dictionary will be used.
[in]	vendor_pen	to search for.

Returns

• The vendor.
• NULL if no vendor with that number was registered for this protocol.

Definition at line 3014 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_vendor_da_by_num()

fr_dict_attr_t const * fr_dict_vendor_da_by_num	(	fr_dict_attr_t const *	vendor_root,
		uint32_t	vendor_pen
	)

Return vendor attribute for the specified dictionary and pen.

Parameters

[in]	vendor_root	of the vendor root attribute. Could be 26 (for example) in RADIUS.
[in]	vendor_pen	to find.

Returns

• NULL if vendor does not exist.
• A fr_dict_attr_t representing the vendor in the dictionary hierarchy.

Definition at line 3033 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dict_walk()

int fr_dict_walk	(	fr_dict_attr_t const *	da,
		fr_dict_walk_t	callback,
		void *	uctx
	)

Definition at line 5201 of file dict_util.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_dl_dict_attr_autoload()

int fr_dl_dict_attr_autoload	(	UNUSED dl_t const *	module,
		void *	symbol,
		UNUSED void *	user_ctx
	)

Callback to automatically resolve attributes and check the types are correct.

Parameters

[in]	module	being loaded.
[in]	symbol	An array of fr_dict_attr_autoload_t to load.
[in]	user_ctx	unused.

Returns

• 0 on success.
• -1 on failure.

Definition at line 4706 of file dict_util.c.

Here is the call graph for this function:

fr_dl_dict_autofree()

void fr_dl_dict_autofree	(	UNUSED dl_t const *	module,
		void *	symbol,
		UNUSED void *	user_ctx
	)

Callback to automatically free a dictionary when the module is unloaded.

Parameters

[in]	module	being loaded.
[in]	symbol	An array of fr_dict_autoload_t to load.
[in]	user_ctx	unused.

Definition at line 4735 of file dict_util.c.

fr_dl_dict_autoload()

int fr_dl_dict_autoload	(	UNUSED dl_t const *	module,
		void *	symbol,
		UNUSED void *	user_ctx
	)

Callback to automatically load dictionaries required by modules.

Parameters

[in]	module	being loaded.
[in]	symbol	An array of fr_dict_autoload_t to load.
[in]	user_ctx	unused.

Returns

• 0 on success.
• -1 on failure.

Definition at line 4722 of file dict_util.c.

fr_dl_dict_enum_autoload()

int fr_dl_dict_enum_autoload	(	UNUSED dl_t const *	module,
		void *	symbol,
		UNUSED void *	user_ctx
	)

Callback to automatically resolve enum values.

Parameters

[in]	module	being loaded.
[in]	symbol	An array of fr_dict_enum_autoload_t to load.
[in]	user_ctx	unused.

Returns

• 0 on success.
• -1 on failure.

Definition at line 4690 of file dict_util.c.

Here is the call graph for this function:

Variable Documentation

dict_gctx

fr_dict_gctx_t* dict_gctx = NULL

Top level structure containing global dictionary state.

Definition at line 41 of file dict_util.c.

dict_proto_default

fr_dict_protocol_t dict_proto_default

static

Initial value:

= {
        .name = "default",
        .default_type_size = 2,
        .default_type_length = 2,
}

Default protocol rules set for every dictionary.

This is usually overriden by the public symbol from the protocol library associated with the dictionary e.g. libfreeradius-dhcpv6.so -> libfreeradius_dhcpv6_dict_protocol.

Definition at line 82 of file dict_util.c.

fr_dict_attr_allowed_chars

bool const fr_dict_attr_allowed_chars[SBUFF_CHAR_CLASS]

Initial value:

= {
        DICT_ATTR_ALLOWED_CHARS
}

Characters allowed in a single dictionary attribute name.

Definition at line 56 of file dict_util.c.

fr_dict_attr_nested_allowed_chars

bool const fr_dict_attr_nested_allowed_chars[SBUFF_CHAR_CLASS]

Initial value:

= {
        DICT_ATTR_ALLOWED_CHARS,
        [ '.' ] = true
}

Characters allowed in a nested dictionary attribute name.

Definition at line 63 of file dict_util.c.

fr_dict_enum_allowed_chars

bool const fr_dict_enum_allowed_chars[SBUFF_CHAR_CLASS]

Initial value:

= {
         DICT_ATTR_ALLOWED_CHARS,
        ['+'] = true, ['.'] = true,
}

Characters allowed in enumeration value names.

Characters that are allowed in dictionary enumeration value names.

Definition at line 71 of file dict_util.c.