table.h File Reference

Lookup table functions. More...

#include <ctype.h>
#include <string.h>
#include <stddef.h>
#include <stdint.h>
#include <sys/types.h>

Include dependency graph for table.h:

Go to the source code of this file.

Data Structures
struct	fr_table_elem_name_t
struct	fr_table_num_indexed_bit_pos_t
	An element in a table indexed by bit position. More...
struct	fr_table_num_indexed_t
	An element in a table indexed by numeric value. More...
struct	fr_table_num_ordered_t
	An element in an arbitrarily ordered array of name to num mappings. More...
struct	fr_table_num_sorted_t
	An element in a lexicographically sorted array of name to num mappings. More...
struct	fr_table_ptr_ordered_t
	An element in an arbitrarily ordered array of name to ptr mappings. More...
struct	fr_table_ptr_sorted_t
	An element in a lexicographically sorted array of name to ptr mappings. More...

Macros
#define	ELEM_LEN(_offset)   (*((fr_table_elem_name_t const *)(_offset))).len
#define	ELEM_STR(_offset)   (*((fr_table_elem_name_t const *)(_offset))).str
#define	fr_table_max_needle_len(_table)
#define	fr_table_str_by_str_value(_table, _str_value, _def)
	Brute force search a sorted or ordered ptr table, assuming the pointers are strings. More...
#define	fr_table_str_by_value(_table, _number, _def)
	Convert an integer to a string. More...
#define	fr_table_value_by_longest_prefix(_match_len, _table, _name, _name_len, _def)
	Find the longest string match using a sorted or ordered table. More...
#define	fr_table_value_by_str(_table, _name, _def)
	Convert a string to a value using a sorted or ordered table. More...
#define	fr_table_value_by_substr(_table, _name, _name_len, _def)
	Convert a partial string to a value using an ordered or sorted table. More...
#define	NAME_NUMBER_NOT_FOUND   INT32_MIN
	Macro to use as dflt. More...
#define	TABLE_IDX(_table, _idx, _element_size)   (((uint8_t const *)(_table)) + ((_idx) * (_element_size)))
#define	TABLE_TYPE_NAME_FUNC(_func, _our_table_type, _our_name, _our_def_type, _our_return_type)
	Create a type-specific name-to-value function. More...
#define	TABLE_TYPE_NAME_FUNC_RPTR(_func, _our_table_type, _our_name, _our_def_type, _our_out_type)
	Create a type-specific name-to-value function. More...
#define	TABLE_TYPE_NAME_LEN_FUNC(_func, _our_table_type, _our_name, _our_def_type, _our_return_type)
	Create a type-specific name-to-value function that can perform substring matching with a 'name_len' argument. More...
#define	TABLE_TYPE_NAME_LEN_FUNC_RPTR(_func, _our_table_type, _our_name, _our_def_type, _our_out_type)
	Create a type-specific name-to-value function that can perform substring matching with a 'name_len' argument. More...
#define	TABLE_TYPE_NAME_MATCH_LEN_FUNC(_func, _our_table_type, _our_name, _our_def_type, _our_return_type)
	Create a type-specific name-to-value function that can perform substring matching with a 'name_len' argument, and passes back the length of the matched string. More...
#define	TABLE_TYPE_NAME_MATCH_LEN_FUNC_RPTR(_func, _our_table_type, _our_name, _our_def_type, _our_out_type)
	Create a type-specific name-to-value function that can perform substring matching with a 'name_len' argument, and passes back the length of the matched string. More...
#define	TABLE_TYPE_NEEDLE_LEN_FUNC(_our_table_type, _our_name)
#define	TABLE_TYPE_VALUE_FUNC(_our_table_type, _our_name, _our_value_type)
	Create a type-specific value-to-name function. More...
#define	TABLE_TYPE_VALUE_INDEX_BIT_FIELD_FUNC(_our_table_type, _our_name, _our_value_type)
	Create a type-specific value-to-name function, which uses the highest bit set in the value as an index into the table. More...
#define	TABLE_TYPE_VALUE_INDEX_FUNC(_our_table_type, _our_name, _our_value_type)
	Create a type-specific value-to-name function, which uses the value as an index into the table. More...

Functions
char const *	_fr_table_ptr_by_str_value (fr_table_ptr_sorted_t const *table, size_t table_len, char const *str_val, char const *def)
	Brute force search a sorted or ordered ptr table, assuming the pointers are strings. More...
char const *	fr_table_indexed_str_by_bit_field (fr_table_num_indexed_bit_pos_t const *table, size_t table_len, uint64_t number, char const *def)
char const *	fr_table_indexed_str_by_num (fr_table_num_indexed_t const *table, size_t table_len, unsigned int number, char const *def)
int	fr_table_ordered_num_by_longest_prefix (size_t *match_len, fr_table_num_ordered_t const *table, size_t table_len, char const *name, ssize_t name_len, int def)
int	fr_table_ordered_num_by_str (fr_table_num_ordered_t const *table, size_t table_len, char const *name, int def)
int	fr_table_ordered_num_by_substr (fr_table_num_ordered_t const *table, size_t table_len, char const *name, ssize_t name_len, int def)
void *	fr_table_ordered_ptr_by_longest_prefix (size_t *match_len, fr_table_ptr_ordered_t const *table, size_t table_len, char const *name, ssize_t name_len, void const *def)
void *	fr_table_ordered_ptr_by_str (fr_table_ptr_ordered_t const *table, size_t table_len, char const *name, void const *def)
void *	fr_table_ordered_ptr_by_substr (fr_table_ptr_ordered_t const *table, size_t table_len, char const *name, ssize_t name_len, void const *def)
char const *	fr_table_ordered_str_by_num (fr_table_num_ordered_t const *table, size_t table_len, int number, char const *def)
char const *	fr_table_ordered_str_by_ptr (fr_table_ptr_ordered_t const *table, size_t table_len, void const *ptr, char const *def)
int	fr_table_sorted_num_by_longest_prefix (size_t *match_len, fr_table_num_sorted_t const *table, size_t table_len, char const *name, ssize_t name_len, int def)
int	fr_table_sorted_num_by_str (fr_table_num_sorted_t const *table, size_t table_len, char const *name, int def)
int	fr_table_sorted_num_by_substr (fr_table_num_sorted_t const *table, size_t table_len, char const *name, ssize_t name_len, int def)
void *	fr_table_sorted_ptr_by_longest_prefix (size_t *match_len, fr_table_ptr_sorted_t const *table, size_t table_len, char const *name, ssize_t name_len, void const *def)
void *	fr_table_sorted_ptr_by_str (fr_table_ptr_sorted_t const *table, size_t table_len, char const *name, void const *def)
void *	fr_table_sorted_ptr_by_substr (fr_table_ptr_sorted_t const *table, size_t table_len, char const *name, ssize_t name_len, void const *def)
char const *	fr_table_sorted_str_by_num (fr_table_num_sorted_t const *table, size_t table_len, int number, char const *def)
char const *	fr_table_sorted_str_by_ptr (fr_table_ptr_sorted_t const *table, size_t table_len, void const *ptr, char const *def)
static void const *	table_ordered_value_by_longest_prefix (size_t *match_len, void const *table, size_t table_len, size_t element_size, char const *name, ssize_t name_len)
	Find the longest string match using an arbitrarily ordered table. More...
static void const *	table_ordered_value_by_str (void const *table, size_t table_len, size_t element_size, char const *name)
	Convert a string to a value using an arbitrarily ordered table. More...
static void const *	table_ordered_value_by_substr (void const *table, size_t table_len, size_t element_size, char const *name, ssize_t name_len)
	Convert a string matching part of name to an integer using an arbitrarily ordered table. More...
static void const *	table_sorted_value_by_longest_prefix (size_t *match_len, void const *table, size_t table_len, size_t element_size, char const *name, ssize_t name_len)
	Find the longest string match using a lexicographically sorted table. More...
static void const *	table_sorted_value_by_str (void const *table, size_t table_len, size_t element_size, char const *name)
	Convert a string to a value using a lexicographically sorted table. More...
static void const *	table_sorted_value_by_substr (void const *table, size_t table_len, size_t element_size, char const *name, ssize_t name_len)
	Convert a string matching part of name to an integer using a lexicographically sorted table. More...

Detailed Description

Lookup table functions.

Id

5d94d934fbd9666fabd2f3152c4c4e3a9ffa7829

Copyright

2019 The FreeRADIUS server project

2019 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 table.h.

---

Data Structure Documentation

fr_table_elem_name_t

struct fr_table_elem_name_t

Definition at line 41 of file table.h.

Data Fields
size_t	len	Literal string length.
char const *	str	Literal string.

fr_table_num_indexed_bit_pos_t

struct fr_table_num_indexed_bit_pos_t

An element in a table indexed by bit position.

i.e. if only the first bit is set in a bitfield, the entry at index 0 will be returned.

Definition at line 83 of file table.h.

Collaboration diagram for fr_table_num_indexed_bit_pos_t:

Data Fields
fr_table_elem_name_t	name
uint64_t	value

fr_table_num_indexed_t

struct fr_table_num_indexed_t

An element in a table indexed by numeric value.

i.e. if the value is 0, we return the string mapped to the first element of the table.

Definition at line 92 of file table.h.

Collaboration diagram for fr_table_num_indexed_t:

Data Fields
fr_table_elem_name_t	name
unsigned int	value

fr_table_num_ordered_t

struct fr_table_num_ordered_t

An element in an arbitrarily ordered array of name to num mappings.

Definition at line 57 of file table.h.

Collaboration diagram for fr_table_num_ordered_t:

Data Fields
fr_table_elem_name_t	name
int	value

fr_table_num_sorted_t

struct fr_table_num_sorted_t

An element in a lexicographically sorted array of name to num mappings.

Definition at line 49 of file table.h.

Collaboration diagram for fr_table_num_sorted_t:

Data Fields
fr_table_elem_name_t	name
int	value

fr_table_ptr_ordered_t

struct fr_table_ptr_ordered_t

An element in an arbitrarily ordered array of name to ptr mappings.

Definition at line 73 of file table.h.

Collaboration diagram for fr_table_ptr_ordered_t:

Data Fields
fr_table_elem_name_t	name
void const *	value

fr_table_ptr_sorted_t

struct fr_table_ptr_sorted_t

An element in a lexicographically sorted array of name to ptr mappings.

Definition at line 65 of file table.h.

Collaboration diagram for fr_table_ptr_sorted_t:

Data Fields
fr_table_elem_name_t	name
void const *	value

Macro Definition Documentation

ELEM_LEN

#define ELEM_LEN

(

_offset

)

(*((fr_table_elem_name_t const *)(_offset))).len

Definition at line 106 of file table.h.

ELEM_STR

#define ELEM_STR

(

_offset

)

(*((fr_table_elem_name_t const *)(_offset))).str

Definition at line 105 of file table.h.

fr_table_max_needle_len

#define fr_table_max_needle_len

(

_table

)

Value:

_Generic((_table), \
         fr_table_num_sorted_t const *          : fr_table_num_sorted_max_needle_len,           \
         fr_table_num_ordered_t const *         : fr_table_num_ordered_max_needle_len,          \
         fr_table_num_sorted_t *                : fr_table_num_sorted_max_needle_len,           \
         fr_table_num_ordered_t *               : fr_table_num_ordered_max_needle_len,          \
         fr_table_ptr_sorted_t const *          : fr_table_ptr_sorted_max_needle_len,           \
         fr_table_ptr_ordered_t const *         : fr_table_ptr_ordered_max_needle_len,          \
         fr_table_ptr_sorted_t *                : fr_table_ptr_sorted_max_needle_len,           \
         fr_table_ptr_ordered_t *               : fr_table_ptr_ordered_max_needle_len,          \
         fr_table_num_indexed_bit_pos_t *       : fr_table_num_indexed_bit_pos_max_needle_len,  \
         fr_table_num_indexed_bit_pos_t const * : fr_table_num_indexed_bit_pos_max_needle_len,  \
         fr_table_num_indexed_t *               : fr_table_num_indexed_max_needle_len,          \
         fr_table_num_indexed_t const *         : fr_table_num_indexed_max_needle_len           \
)(_table, _table ## _len)

Definition at line 803 of file table.h.

fr_table_str_by_str_value

#define fr_table_str_by_str_value	(		_table,
			_str_value,
			_def
	)

Value:

_Generic((_table), \
         fr_table_ptr_sorted_t const *          : _fr_table_ptr_by_str_value((fr_table_ptr_sorted_t const *)_table, _table ## _len, _str_value, _def), \
         fr_table_ptr_ordered_t const *         : _fr_table_ptr_by_str_value((fr_table_ptr_sorted_t const *)_table, _table ## _len, _str_value, _def), \
         fr_table_ptr_sorted_t *                : _fr_table_ptr_by_str_value((fr_table_ptr_sorted_t const *)_table, _table ## _len, _str_value, _def), \
         fr_table_ptr_ordered_t *               : _fr_table_ptr_by_str_value((fr_table_ptr_sorted_t const *)_table, _table ## _len, _str_value, _def))

Brute force search a sorted or ordered ptr table, assuming the pointers are strings.

Parameters

[in]	_table	to search in.
[in]	_str_value	to compare against the ptr field.
[in]	_def	default value.

Definition at line 625 of file table.h.

fr_table_str_by_value

#define fr_table_str_by_value	(		_table,
			_number,
			_def
	)

Value:

_Generic((_table), \
         fr_table_num_sorted_t const *          : fr_table_sorted_str_by_num,                   \
         fr_table_num_ordered_t const *         : fr_table_ordered_str_by_num,                  \
         fr_table_num_sorted_t *                : fr_table_sorted_str_by_num,                   \
         fr_table_num_ordered_t *               : fr_table_ordered_str_by_num,                  \
         fr_table_ptr_sorted_t const *          : fr_table_sorted_str_by_ptr,                   \
         fr_table_ptr_ordered_t const *         : fr_table_ordered_str_by_ptr,                  \
         fr_table_ptr_sorted_t *                : fr_table_sorted_str_by_ptr,                   \
         fr_table_ptr_ordered_t *               : fr_table_ordered_str_by_ptr,                  \
         fr_table_num_indexed_bit_pos_t *       : fr_table_indexed_str_by_bit_field,            \
         fr_table_num_indexed_bit_pos_t const * : fr_table_indexed_str_by_bit_field,            \
         fr_table_num_indexed_t *               : fr_table_indexed_str_by_num,                  \
         fr_table_num_indexed_t const *         : fr_table_indexed_str_by_num                   \
)(_table, _table ## _len, _number, _def)

Convert an integer to a string.

Parameters

[in]	_table	to search in.
[in]	_number	to resolve to a string.
[in]	_def	Default string to return if there's no match.

Returns

• _def if _number name matched no entries in the table.
• the string value of the matching entry.

Definition at line 772 of file table.h.

fr_table_value_by_longest_prefix

#define fr_table_value_by_longest_prefix	(		_match_len,
			_table,
			_name,
			_name_len,
			_def
	)

Value:

_Generic((_table), \
         fr_table_num_sorted_t const *          : fr_table_sorted_num_by_longest_prefix,        \
         fr_table_num_ordered_t const *         : fr_table_ordered_num_by_longest_prefix,       \
         fr_table_num_sorted_t *                : fr_table_sorted_num_by_longest_prefix,        \
         fr_table_num_ordered_t *               : fr_table_ordered_num_by_longest_prefix,       \
         fr_table_ptr_sorted_t const *          : fr_table_sorted_ptr_by_longest_prefix,        \
         fr_table_ptr_ordered_t const *         : fr_table_ordered_ptr_by_longest_prefix,       \
         fr_table_ptr_sorted_t *                : fr_table_sorted_ptr_by_longest_prefix,        \
         fr_table_ptr_ordered_t *               : fr_table_ordered_ptr_by_longest_prefix,       \
         fr_table_num_indexed_bit_pos_t *       : fr_table_ordered_num_by_longest_prefix,       \
         fr_table_num_indexed_bit_pos_t const * : fr_table_ordered_num_by_longest_prefix,       \
         fr_table_num_indexed_t *               : fr_table_ordered_num_by_longest_prefix,       \
         fr_table_num_indexed_t const *         : fr_table_ordered_num_by_longest_prefix        \
)(_match_len, _table, _table ## _len, _name, _name_len, _def)

Find the longest string match using a sorted or ordered table.

Parameters

[out]	_match_len	How much of the input string matched.
[in]	_table	to search in.
[in]	_name	to resolve to a number.
[in]	_name_len	The amount of name to match.
[in]	_def	Default value if no entry matched.

Returns

• _def if name matched no entries in the table.
• the value of the matching entry.

Definition at line 732 of file table.h.

fr_table_value_by_str

#define fr_table_value_by_str	(		_table,
			_name,
			_def
	)

Value:

_Generic((_table), \
         fr_table_num_sorted_t const *          : fr_table_sorted_num_by_str,                   \
         fr_table_num_ordered_t const *         : fr_table_ordered_num_by_str,                  \
         fr_table_num_sorted_t *                : fr_table_sorted_num_by_str,                   \
         fr_table_num_ordered_t *               : fr_table_ordered_num_by_str,                  \
         fr_table_ptr_sorted_t const *          : fr_table_sorted_ptr_by_str,                   \
         fr_table_ptr_ordered_t const *         : fr_table_ordered_ptr_by_str,                  \
         fr_table_ptr_sorted_t *                : fr_table_sorted_ptr_by_str,                   \
         fr_table_ptr_ordered_t *               : fr_table_ordered_ptr_by_str,                  \
         fr_table_num_indexed_bit_pos_t *       : fr_table_ordered_num_by_str,                  \
         fr_table_num_indexed_bit_pos_t const * : fr_table_ordered_num_by_str,                  \
         fr_table_num_indexed_t *               : fr_table_ordered_num_by_str,                  \
         fr_table_num_indexed_t const *         : fr_table_ordered_num_by_str                   \
)(_table, _table ## _len, _name, _def)

Convert a string to a value using a sorted or ordered table.

Parameters

[in]	_table	to search in.
[in]	_name	to resolve to a number.
[in]	_def	Default value if no entry matched.

Returns

• _def if name matched no entries in the table.
• the numeric value of the matching entry.

Definition at line 653 of file table.h.

fr_table_value_by_substr

#define fr_table_value_by_substr	(		_table,
			_name,
			_name_len,
			_def
	)

Value:

_Generic((_table), \
         fr_table_num_sorted_t const *          : fr_table_sorted_num_by_substr,                \
         fr_table_num_ordered_t const *         : fr_table_ordered_num_by_substr,               \
         fr_table_num_sorted_t *                : fr_table_sorted_num_by_substr,                \
         fr_table_num_ordered_t *               : fr_table_ordered_num_by_substr,               \
         fr_table_ptr_sorted_t const *          : fr_table_sorted_ptr_by_substr,                \
         fr_table_ptr_ordered_t const *         : fr_table_ordered_ptr_by_substr,               \
         fr_table_ptr_sorted_t *                : fr_table_sorted_ptr_by_substr,                \
         fr_table_ptr_ordered_t *               : fr_table_ordered_ptr_by_substr,               \
         fr_table_num_indexed_bit_pos_t *       : fr_table_ordered_num_by_substr,               \
         fr_table_num_indexed_bit_pos_t const * : fr_table_ordered_num_by_substr,               \
         fr_table_num_indexed_t *               : fr_table_ordered_num_by_substr,               \
         fr_table_num_indexed_t const *         : fr_table_ordered_num_by_substr                \
)(_table, _table ## _len, _name, _name_len, _def)

Convert a partial string to a value using an ordered or sorted table.

Parameters

[in]	_table	to search in.
[in]	_name	to resolve to a number.
[in]	_name_len	The amount of name to match. If < 0, the length of the name in the table element will be used as the maximum match length.
[in]	_def	Default value if no entry matched.

Returns

• _def if name matched no entries in the table.
• the numeric value of the matching entry.

Definition at line 693 of file table.h.

NAME_NUMBER_NOT_FOUND

#define NAME_NUMBER_NOT_FOUND   INT32_MIN

Macro to use as dflt.

Definition at line 100 of file table.h.

TABLE_IDX

#define TABLE_IDX	(		_table,
			_idx,
			_element_size
	)		(((uint8_t const *)(_table)) + ((_idx) * (_element_size)))

Definition at line 104 of file table.h.

TABLE_TYPE_NAME_FUNC

#define TABLE_TYPE_NAME_FUNC	(		_func,
			_our_table_type,
			_our_name,
			_our_def_type,
			_our_return_type
	)

Value:

_our_return_type _our_name(_our_table_type table, size_t table_len, char const *name, _our_def_type def) \
{ \
        _our_return_type ret; \
        _our_table_type found; \
        found = (_our_table_type)_func(table, table_len, sizeof(((_our_table_type)0)[0]), name); \
        if (!found) { \
                memcpy(&ret, &def, sizeof(ret)); \
                return ret; \
        } \
        memcpy(&ret, &found->value, sizeof(ret)); \
        return ret; \
}

Create a type-specific name-to-value function.

Parameters

[in]	_func	Used for resolving the name portion of an array element to a value. Should be one of the following: table_sorted_value_by_str - for lexicographically sorted tables. table_ordered_value_by_str - for arbitrarily ordered tables.
[in]	_our_table_type	C type of the table elements.
[in]	_our_name	name of the search function to define.
[in]	_our_def_type	C type of the default value.
[in]	_our_return_type	C type of the return value, i.e. the value part of the element.

Definition at line 119 of file table.h.

TABLE_TYPE_NAME_FUNC_RPTR

#define TABLE_TYPE_NAME_FUNC_RPTR	(		_func,
			_our_table_type,
			_our_name,
			_our_def_type,
			_our_out_type
	)

Value:

bool _our_name(_our_out_type *out, _our_table_type table, size_t table_len, char const *name, _our_def_type def) \
{ \
        _our_table_type found; \
        found = (_our_table_type)_func(table, table_len, sizeof(((_our_table_type)0)[0]), name); \
        if (!found) { \
                *out = def; \
                return false; \
        } \
        *out = &found->value; \
        return true; \
}

Create a type-specific name-to-value function.

Parameters

[in]	_func	Used for resolving the name portion of an array element to a value. Should be one of the following: table_sorted_value_by_str - for lexicographically sorted tables. table_ordered_value_by_str - for arbitrarily ordered tables.
[in]	_our_table_type	C type of the table elements.
[in]	_our_name	name of the search function to define.
[in]	_our_def_type	C type of the default value.
[in]	_our_out_type	C type of the return/output value, i.e. the value part of the element.

Definition at line 144 of file table.h.

TABLE_TYPE_NAME_LEN_FUNC

#define TABLE_TYPE_NAME_LEN_FUNC	(		_func,
			_our_table_type,
			_our_name,
			_our_def_type,
			_our_return_type
	)

Value:

_our_return_type _our_name(_our_table_type table, size_t table_len, char const *name, ssize_t name_len, _our_def_type def) \
{ \
        _our_return_type ret; \
        _our_table_type found; \
        found = (_our_table_type)_func(table, table_len, sizeof(((_our_table_type)0)[0]), name, name_len); \
        if (!found) { \
                memcpy(&ret, &def, sizeof(ret)); \
                return ret; \
        } \
        memcpy(&ret, &found->value, sizeof(ret)); \
        return ret; \
}

Create a type-specific name-to-value function that can perform substring matching with a 'name_len' argument.

Parameters

[in]	_func	Used for resolving the name portion of an array element to a value. Should be one of the following: table_sorted_value_by_substr - for lexicographically sorted tables with partial matching. table_ordered_value_by_substr - for arbitrarily ordered tables. with partial matching.
[in]	_our_table_type	C type of the table elements. Must contain two fields, an fr_table_elem_name_t called name and an arbitraryily typed field called value. A pointer to thi
[in]	_our_name	name of the search function to define.
[in]	_our_def_type	C type of the default value.
[in]	_our_return_type	C type of the return value, i.e. the value part of the element.

Definition at line 173 of file table.h.

TABLE_TYPE_NAME_LEN_FUNC_RPTR

#define TABLE_TYPE_NAME_LEN_FUNC_RPTR	(		_func,
			_our_table_type,
			_our_name,
			_our_def_type,
			_our_out_type
	)

Value:

bool _our_name(_our_out_type *out, _our_table_type table, size_t table_len, char const *name, ssize_t name_len, _our_def_type def) \
{ \
        _our_table_type found; \
        found = (_our_table_type)_func(table, table_len, sizeof(((_our_table_type)0)[0]), name, name_len); \
        if (!found) { \
                *out = def; \
                return false; \
        } \
        *out = &found->value; \
        return true; \
}

Create a type-specific name-to-value function that can perform substring matching with a 'name_len' argument.

Note

The functions created by this macro return true on a match, false on no match, and write a pointer to the value field of the table element to the 'out' argument.

Parameters

[in]	_func	Used for resolving the name portion of an array element to a value. Should be one of the following: table_sorted_value_by_substr - for lexicographically sorted tables with partial matching. table_ordered_value_by_substr - for arbitrarily ordered tables. with partial matching.
[in]	_our_table_type	C type of the table elements. Must contain two fields, an fr_table_elem_name_t called name and an arbitraryily typed field called value. A pointer to thi
[in]	_our_name	name of the search function to define.
[in]	_our_def_type	C type of the default value.
[in]	_our_out_type	C type of the return/output value, i.e. the value part of the element.

Definition at line 206 of file table.h.

TABLE_TYPE_NAME_MATCH_LEN_FUNC

#define TABLE_TYPE_NAME_MATCH_LEN_FUNC	(		_func,
			_our_table_type,
			_our_name,
			_our_def_type,
			_our_return_type
	)

Value:

_our_return_type _our_name(size_t *match_len, _our_table_type table, size_t table_len, char const *name, ssize_t name_len, _our_def_type def) \
{ \
        _our_return_type ret; \
        _our_table_type found; \
        found = (_our_table_type)_func(match_len, table, table_len, sizeof(((_our_table_type)0)[0]), name, name_len); \
        if (!found) { \
                memcpy(&ret, &def, sizeof(ret)); \
                return ret; \
        } \
        memcpy(&ret, &found->value, sizeof(ret)); \
        return ret; \
}

Create a type-specific name-to-value function that can perform substring matching with a 'name_len' argument, and passes back the length of the matched string.

Note

The functions created by this macro return the value field of the table element.

Parameters

[in]	_func	Used for resolving the name portion of an array element to a value. Should be one of the following: table_sorted_value_by_longest_prefix - for lexicographically sorted tables with longest prefix match. table_ordered_value_by_longest_prefix - for arbitrarily ordered tables with longest prefix match.
[in]	_our_table_type	C type of the table elements.
[in]	_our_name	name of the search function to define.
[in]	_our_def_type	C type of the default value.
[in]	_our_return_type	C type of the return value, i.e. the value part of the element.

Definition at line 234 of file table.h.

TABLE_TYPE_NAME_MATCH_LEN_FUNC_RPTR

#define TABLE_TYPE_NAME_MATCH_LEN_FUNC_RPTR	(		_func,
			_our_table_type,
			_our_name,
			_our_def_type,
			_our_out_type
	)

Value:

bool _our_name(size_t *match_len, _our_out_type *out, _our_table_type table, size_t table_len, char const *name, ssize_t name_len, _our_def_type def) \
{ \
        _our_table_type found; \
        found = (_our_table_type)_func(match_len, table, table_len, sizeof(((_our_table_type)0)[0]), name, name_len); \
        if (!found) { \
                *out = def; \
                return false; \
        } \
        *out = &found->value; \
        return true; \
}

Create a type-specific name-to-value function that can perform substring matching with a 'name_len' argument, and passes back the length of the matched string.

Note

The functions created by this macro return true on a match, false on no match, and write a pointer to the value field of the table element to the 'out' argument.

Parameters

[in]	_func	Used for resolving the name portion of an array element to a value. Should be one of the following: table_sorted_value_by_longest_prefix - for lexicographically sorted tables with longest prefix match. table_ordered_value_by_longest_prefix - for arbitrarily ordered tables with longest prefix match.
[in]	_our_table_type	C type of the table elements.
[in]	_our_name	name of the search function to define.
[in]	_our_def_type	C type of the default value.
[in]	_our_out_type	C type of the return/output value, i.e. the value part of the element.

Definition at line 264 of file table.h.

TABLE_TYPE_NEEDLE_LEN_FUNC

#define TABLE_TYPE_NEEDLE_LEN_FUNC	(		_our_table_type,
			_our_name
	)

Value:

static inline size_t _our_name(_our_table_type table, size_t table_len) \
{ \
        size_t i, max = 0; \
        for (i = 0; i < table_len; i++) if (table->name.len > max) max = table->name.len; \
        return max; \
}

Definition at line 788 of file table.h.

TABLE_TYPE_VALUE_FUNC

#define TABLE_TYPE_VALUE_FUNC	(		_our_table_type,
			_our_name,
			_our_value_type
	)

Value:

char const *_our_name(_our_table_type table, size_t table_len, _our_value_type value, char const *def) \
{ \
        size_t          i; \
        for (i = 0; i < table_len; i++) if (table[i].value == value) return table[i].name.str; \
        return def; \
}

Create a type-specific value-to-name function.

Parameters

[in]	_our_table_type	C type of the table elements.
[in]	_our_name	name of the search function to define.
[in]	_our_return_type	C type of the value field of the table element.

Definition at line 283 of file table.h.

TABLE_TYPE_VALUE_INDEX_BIT_FIELD_FUNC

#define TABLE_TYPE_VALUE_INDEX_BIT_FIELD_FUNC	(		_our_table_type,
			_our_name,
			_our_value_type
	)

Value:

char const *_our_name(_our_table_type table, size_t table_len, _our_value_type value, char const *def) \
{ \
        uint8_t idx = fr_high_bit_pos(value); \
        if (idx >= table_len) return def; \
        return table[idx].name.str; \
}

Create a type-specific value-to-name function, which uses the highest bit set in the value as an index into the table.

Parameters

[in]	_our_table_type	C type of the table elements.
[in]	_our_name	name of the search function to define.
[in]	_our_return_type	C type of the value field of the table element.

Definition at line 297 of file table.h.

TABLE_TYPE_VALUE_INDEX_FUNC

#define TABLE_TYPE_VALUE_INDEX_FUNC	(		_our_table_type,
			_our_name,
			_our_value_type
	)

Value:

char const *_our_name(_our_table_type table, size_t table_len, _our_value_type value, char const *def) \
{ \
        if (value >= table_len) return def; \
        return table[value].name.str; \
}

Create a type-specific value-to-name function, which uses the value as an index into the table.

Parameters

[in]	_our_table_type	C type of the table elements.
[in]	_our_name	name of the search function to define.
[in]	_our_return_type	C type of the value field of the table element.

Definition at line 311 of file table.h.

Function Documentation

_fr_table_ptr_by_str_value()

char const* _fr_table_ptr_by_str_value	(	fr_table_ptr_sorted_t const *	table,
		size_t	table_len,
		char const *	str_val,
		char const *	def
	)

Brute force search a sorted or ordered ptr table, assuming the pointers are strings.

Parameters

[in]	table	to search in.
[in]	table_len	Number of elements in the table.
[in]	str_val	to compare against the ptr field.
[in]	def	default value.

Definition at line 36 of file table.c.

Here is the call graph for this function:

fr_table_indexed_str_by_bit_field()

char const* fr_table_indexed_str_by_bit_field	(	fr_table_num_indexed_bit_pos_t const *	table,
		size_t	table_len,
		uint64_t	number,
		char const *	def
	)

fr_table_indexed_str_by_num()

char const* fr_table_indexed_str_by_num	(	fr_table_num_indexed_t const *	table,
		size_t	table_len,
		unsigned int	number,
		char const *	def
	)

fr_table_ordered_num_by_longest_prefix()

int fr_table_ordered_num_by_longest_prefix	(	size_t *	match_len,
		fr_table_num_ordered_t const *	table,
		size_t	table_len,
		char const *	name,
		ssize_t	name_len,
		int	def
	)

fr_table_ordered_num_by_str()

int fr_table_ordered_num_by_str	(	fr_table_num_ordered_t const *	table,
		size_t	table_len,
		char const *	name,
		int	def
	)

fr_table_ordered_num_by_substr()

int fr_table_ordered_num_by_substr	(	fr_table_num_ordered_t const *	table,
		size_t	table_len,
		char const *	name,
		ssize_t	name_len,
		int	def
	)

fr_table_ordered_ptr_by_longest_prefix()

void* fr_table_ordered_ptr_by_longest_prefix	(	size_t *	match_len,
		fr_table_ptr_ordered_t const *	table,
		size_t	table_len,
		char const *	name,
		ssize_t	name_len,
		void const *	def
	)

fr_table_ordered_ptr_by_str()

void* fr_table_ordered_ptr_by_str	(	fr_table_ptr_ordered_t const *	table,
		size_t	table_len,
		char const *	name,
		void const *	def
	)

fr_table_ordered_ptr_by_substr()

void* fr_table_ordered_ptr_by_substr	(	fr_table_ptr_ordered_t const *	table,
		size_t	table_len,
		char const *	name,
		ssize_t	name_len,
		void const *	def
	)

fr_table_ordered_str_by_num()

char const* fr_table_ordered_str_by_num	(	fr_table_num_ordered_t const *	table,
		size_t	table_len,
		int	number,
		char const *	def
	)

Here is the caller graph for this function:

fr_table_ordered_str_by_ptr()

char const* fr_table_ordered_str_by_ptr	(	fr_table_ptr_ordered_t const *	table,
		size_t	table_len,
		void const *	ptr,
		char const *	def
	)

fr_table_sorted_num_by_longest_prefix()

int fr_table_sorted_num_by_longest_prefix	(	size_t *	match_len,
		fr_table_num_sorted_t const *	table,
		size_t	table_len,
		char const *	name,
		ssize_t	name_len,
		int	def
	)

fr_table_sorted_num_by_str()

int fr_table_sorted_num_by_str	(	fr_table_num_sorted_t const *	table,
		size_t	table_len,
		char const *	name,
		int	def
	)

fr_table_sorted_num_by_substr()

int fr_table_sorted_num_by_substr	(	fr_table_num_sorted_t const *	table,
		size_t	table_len,
		char const *	name,
		ssize_t	name_len,
		int	def
	)

fr_table_sorted_ptr_by_longest_prefix()

void* fr_table_sorted_ptr_by_longest_prefix	(	size_t *	match_len,
		fr_table_ptr_sorted_t const *	table,
		size_t	table_len,
		char const *	name,
		ssize_t	name_len,
		void const *	def
	)

fr_table_sorted_ptr_by_str()

void* fr_table_sorted_ptr_by_str	(	fr_table_ptr_sorted_t const *	table,
		size_t	table_len,
		char const *	name,
		void const *	def
	)

fr_table_sorted_ptr_by_substr()

void* fr_table_sorted_ptr_by_substr	(	fr_table_ptr_sorted_t const *	table,
		size_t	table_len,
		char const *	name,
		ssize_t	name_len,
		void const *	def
	)

fr_table_sorted_str_by_num()

char const* fr_table_sorted_str_by_num	(	fr_table_num_sorted_t const *	table,
		size_t	table_len,
		int	number,
		char const *	def
	)

fr_table_sorted_str_by_ptr()

char const* fr_table_sorted_str_by_ptr	(	fr_table_ptr_sorted_t const *	table,
		size_t	table_len,
		void const *	ptr,
		char const *	def
	)

table_ordered_value_by_longest_prefix()

static void const* table_ordered_value_by_longest_prefix ( size_t *  match_len, void const *  table, size_t  table_len, size_t  element_size, char const *  name, ssize_t  name_len  )

static

Find the longest string match using an arbitrarily ordered table.

i.e. given name of "food", and table of f, foo, of - foo would be returned.

Parameters

[out]	match_len	How much of the input string matched.
[in]	table	to search in.
[in]	table_len	The number of elements in the table.
[in]	element_size	Size of elements in the table.
[in]	name	to locate.
[in]	name_len	the maximum amount of name that should be matched.

Returns

• num value of matching entry.
• def if no matching entries.

Definition at line 568 of file table.h.

table_ordered_value_by_str()

static void const* table_ordered_value_by_str ( void const *  table, size_t  table_len, size_t  element_size, char const *  name  )

static

Convert a string to a value using an arbitrarily ordered table.

Parameters

[in]	table	to search in.
[in]	table_len	The number of elements in the table.
[in]	element_size	Size of elements in the table.
[in]	name	to resolve to a number.

Returns

• value of matching entry.
• NULL if no matching entries.

Definition at line 367 of file table.h.

Here is the call graph for this function:

table_ordered_value_by_substr()

static void const* table_ordered_value_by_substr ( void const *  table, size_t  table_len, size_t  element_size, char const *  name, ssize_t  name_len  )

static

Convert a string matching part of name to an integer using an arbitrarily ordered table.

Parameters

[in]	table	to search in.
[in]	table_len	The number of elements in the table.
[in]	element_size	Size of elements in the table.
[in]	name	to locate.
[in]	name_len	the maximum amount of name that should be matched. If < 0, the length of the name in the table offsetent will be used as the maximum match length.

Returns

• value of matching entry.
• NULL if no matching entries.

Definition at line 443 of file table.h.

Here is the call graph for this function:

table_sorted_value_by_longest_prefix()

static void const* table_sorted_value_by_longest_prefix ( size_t *  match_len, void const *  table, size_t  table_len, size_t  element_size, char const *  name, ssize_t  name_len  )

static

Find the longest string match using a lexicographically sorted table.

Performs a binary search in the specified table, returning the longest offsetent which is a prefix of name.

i.e. given name of "food", and table of f, foo, of - foo would be returned.

Note

The table MUST be sorted lexicographically, else the result may be incorrect.

Parameters

[out]	match_len	How much of the input string matched.
[in]	table	to search in.
[in]	table_len	The number of elements in the table.
[in]	element_size	Size of elements in the table.
[in]	name	to locate.
[in]	name_len	the maximum amount of name that should be matched.

Returns

• num value of matching entry.
• NULL if no matching entries.

Definition at line 492 of file table.h.

Here is the call graph for this function:

table_sorted_value_by_str()

static void const* table_sorted_value_by_str ( void const *  table, size_t  table_len, size_t  element_size, char const *  name  )

static

Convert a string to a value using a lexicographically sorted table.

Parameters

[in]	table	to search in.
[in]	table_len	The number of elements in the table.
[in]	element_size	Size of elements in the table.
[in]	name	to resolve to a value.

Returns

• value of matching entry.
• NULL if no matching entries.

Definition at line 328 of file table.h.

Here is the call graph for this function:

table_sorted_value_by_substr()

static void const* table_sorted_value_by_substr ( void const *  table, size_t  table_len, size_t  element_size, char const *  name, ssize_t  name_len  )

static

Convert a string matching part of name to an integer using a lexicographically sorted table.

Parameters

[in]	table	to search in.
[in]	table_len	The number of elements in the table.
[in]	element_size	Size of elements in the table.
[in]	name	to locate.
[in]	name_len	the maximum amount of name that should be matched. If < 0, the length of the name in the table offsetent will be used as the maximum match length.

Returns

• value of matching entry.
• NULL if no matching entries.

Definition at line 395 of file table.h.

Here is the call graph for this function: