types.h

Go to the documentation of this file.

#pragma once
/*
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
/** Types of values contained within an #fr_value_box_t
 *
 * @file src/lib/util/types.h
 *
 * @copyright 2021 Arran Cudbard-Bell (a.cudbardb@freeradius.org)
 * @copyright 2017 The FreeRADIUS server project
 */
RCSIDH(types_h, "$Id: a310f3ed4d2839eff56a7e525ee91414c30d2d15 $")
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <freeradius-devel/util/table.h>
#include <freeradius-devel/util/talloc.h>
#include <stdbool.h>
 
/** Internal data types
 */
typedef enum {
        FR_TYPE_NULL = 0,                       //!< Invalid (uninitialised) attribute type.
 
        FR_TYPE_STRING,                         //!< String of printable characters.
        FR_TYPE_OCTETS,                         //!< Raw octets.
 
        FR_TYPE_IPV4_ADDR,                      //!< 32 Bit IPv4 Address.
        FR_TYPE_IPV4_PREFIX,                    //!< IPv4 Prefix.
        FR_TYPE_IPV6_ADDR,                      //!< 128 Bit IPv6 Address.
        FR_TYPE_IPV6_PREFIX,                    //!< IPv6 Prefix.
        FR_TYPE_IFID,                           //!< Interface ID.
        FR_TYPE_COMBO_IP_ADDR,                  //!< IPv4 or IPv6 address depending on length.
        FR_TYPE_COMBO_IP_PREFIX,                //!< IPv4 or IPv6 address prefix depending on length.
        FR_TYPE_ETHERNET,                       //!< 48 Bit Mac-Address.
 
        FR_TYPE_BOOL,                           //!< A truth value.
 
        FR_TYPE_UINT8,                          //!< 8 Bit unsigned integer.
        FR_TYPE_UINT16,                         //!< 16 Bit unsigned integer.
        FR_TYPE_UINT32,                         //!< 32 Bit unsigned integer.
        FR_TYPE_UINT64,                         //!< 64 Bit unsigned integer.
 
 
        FR_TYPE_INT8,                           //!< 8 Bit signed integer.
        FR_TYPE_INT16,                          //!< 16 Bit signed integer.
        FR_TYPE_INT32,                          //!< 32 Bit signed integer.
        FR_TYPE_INT64,                          //!< 64 Bit signed integer.
 
        FR_TYPE_FLOAT32,                        //!< Single precision floating point.
        FR_TYPE_FLOAT64,                        //!< Double precision floating point.
 
        FR_TYPE_DATE,                           //!< Unix time stamp, always has value >2^31
 
        FR_TYPE_TIME_DELTA,                     //!< A period of time measured in nanoseconds.
 
        FR_TYPE_SIZE,                           //!< Unsigned integer capable of representing any memory
                                                //!< address on the local system.
 
        FR_TYPE_TLV,                            //!< Contains nested attributes.
        FR_TYPE_STRUCT,                         //!< like TLV, but without T or L, and fixed-width children
 
        FR_TYPE_VSA,                            //!< Vendor-Specific, for RADIUS attribute 26.
        FR_TYPE_VENDOR,                         //!< Attribute that represents a vendor in the attribute tree.
 
        FR_TYPE_GROUP,                          //!< A grouping of other attributes
        FR_TYPE_UNION,                          //!< A union of limited children
        FR_TYPE_VALUE_BOX,                      //!< A boxed value.
        FR_TYPE_ATTR,                           //!< A contains an attribute reference
 
        FR_TYPE_VOID,                           //!< User data.  Should be a talloced chunk
                                                ///< assigned to the ptr value of the union.
 
        FR_TYPE_VALUE_BOX_CURSOR,               //!< cursor over a #fr_value_box_t
 
        FR_TYPE_PAIR_CURSOR,                    //!< cursor over a #fr_pair_t
 
        FR_TYPE_MAX                             //!< Number of defined data types.
} fr_type_t;
 
/** @name Type grouping macros
 *
 * @{
 */
 
/** All integer types except bool
 *
 * - Integers
 * - Dates
 * - Delta
 */
#define FR_TYPE_INTEGER_EXCEPT_BOOL_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_UINT8) \
        _mid(FR_TYPE_UINT16) \
        _mid(FR_TYPE_UINT32) \
        _mid(FR_TYPE_UINT64) \
        _mid(FR_TYPE_INT8) \
        _mid(FR_TYPE_INT16) \
        _mid(FR_TYPE_INT32) \
        _mid(FR_TYPE_INT64) \
        _mid(FR_TYPE_DATE) \
        _mid(FR_TYPE_TIME_DELTA) \
        _end(FR_TYPE_SIZE)
 
/** Signed or unsigned integers
 *
 * - Integers
 * - Dates
 * - Deltas
 * - Bools
 */
#define FR_TYPE_INTEGER_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_BOOL) \
        FR_TYPE_INTEGER_EXCEPT_BOOL_DEF(_mid, _mid, _end)
 
/** Signed values
 *
 * - Int8, 16, 32, 64
 * - Deltas
 * - Floats
 */
#define FR_TYPE_SIGNED_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_INT8) \
        _mid(FR_TYPE_INT16) \
        _mid(FR_TYPE_INT32) \
        _mid(FR_TYPE_INT64) \
        _mid(FR_TYPE_TIME_DELTA) \
        _mid(FR_TYPE_FLOAT32) \
        _end(FR_TYPE_FLOAT64)
 
/** Naturally numeric types
 *
 * - Integers
 * - Dates
 * - Deltas
 * - Bools
 * - Floats
 */
#define FR_TYPE_NUMERIC_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_FLOAT32) \
        _mid(FR_TYPE_FLOAT64) \
        FR_TYPE_INTEGER_DEF(_mid, _mid, _end)
 
/** Types which can fit in an #fr_ipaddr_t
 *
 * - Combo IP addresses
 * - Combo IP prefixes
 * - IPv4 addresses
 * - IPv6 addresses
 * - IPv4 prefix
 * - IPv6 prefix
 */
#define FR_TYPE_IP_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_COMBO_IP_ADDR) \
        _mid(FR_TYPE_COMBO_IP_PREFIX) \
        _mid(FR_TYPE_IPV4_ADDR) \
        _mid(FR_TYPE_IPV4_PREFIX) \
        _mid(FR_TYPE_IPV6_ADDR) \
        _end(FR_TYPE_IPV6_PREFIX)
 
/** Match all fixed length types
 *
 * - Network addresses
 * - Integers
 * - All other fixed types
 */
#define FR_TYPE_FIXED_SIZE_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_ETHERNET) \
        _mid(FR_TYPE_IFID) \
        _mid(FR_TYPE_IPV4_ADDR) \
        _mid(FR_TYPE_IPV4_PREFIX) \
        _mid(FR_TYPE_IPV6_ADDR) \
        _mid(FR_TYPE_IPV6_PREFIX) \
        FR_TYPE_NUMERIC_DEF(_mid, _mid, _end)
 
/** Match all variable length types
 *
 * @note Whilst combo IP addresses and prefixes may technically be
 *       variable length on the wire, these groupings are referring
 *       to our internal box representation which is fixed size.
 *
 * - Strings
 * - Octets
 */
#define FR_TYPE_VARIABLE_SIZE_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_STRING) \
        _end(FR_TYPE_OCTETS)
 
/** Types which should be wrapped in double quotes when printed
 *
 * - Strings
 * - Dates
 */
#define FR_TYPE_QUOTED_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_STRING) \
        _end(FR_TYPE_DATE)
 
/** Stupid hack for things which produce special error messages for VSAs
 *
 * - Groups
 * - Structs
 * - TLVs
 * - Vendors
 */
#define FR_TYPE_STRUCTURAL_EXCEPT_VSA_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_GROUP) \
        _mid(FR_TYPE_STRUCT) \
        _mid(FR_TYPE_TLV) \
        _mid(FR_TYPE_UNION) \
        _end(FR_TYPE_VENDOR)
 
/** Hack for truthiness check
 *
 * - VSAs
 * - Structs
 * - TLVs
 * - Vendors
 */
#define FR_TYPE_STRUCTURAL_EXCEPT_GROUP_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_VSA) \
        _mid(FR_TYPE_STRUCT) \
        _mid(FR_TYPE_TLV) \
        _mid(FR_TYPE_UNION) \
        _end(FR_TYPE_VENDOR)
 
/** Match all non value types in case statements
 *
 * - Groups
 * - Structs
 * - TLVs
 * - Vendors
 * - VSAs (i.e. a container of vendors)
 */
#define FR_TYPE_STRUCTURAL_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_VSA) \
        FR_TYPE_STRUCTURAL_EXCEPT_VSA_DEF(_mid, _mid, _end)
 
/** Types which represent concrete values
 *
 * - Network addresses
 * - Strings
 * - Octets
 * - Numbers
 */
#define FR_TYPE_LEAF_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_ETHERNET) \
        _mid(FR_TYPE_IFID) \
        _mid(FR_TYPE_ATTR) \
        FR_TYPE_IP_DEF(_mid, _mid, _mid) \
        FR_TYPE_VARIABLE_SIZE_DEF(_mid, _mid, _mid) \
        FR_TYPE_NUMERIC_DEF(_mid, _mid, _end)
 
/** Types which are internal, and should not be used for real data.
 *
 * - Boxes (can represent any type)
 * - Void (opaque types)
 * - Invalid values
 */
#define FR_TYPE_INTERNAL_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_VALUE_BOX) \
        _mid(FR_TYPE_VOID) \
        _mid(FR_TYPE_VALUE_BOX_CURSOR) \
        _mid(FR_TYPE_PAIR_CURSOR) \
        _end(FR_TYPE_MAX)
 
/** Types which do not represent leaf values
 *
 * - Structural
 * - Boxes (can represent any type)
 * - Void (opaque types)
 * - Null (lack of value)
 * - Invalid values
 */
#define FR_TYPE_NON_LEAF_DEF(_beg, _mid, _end) \
        _beg(FR_TYPE_NULL) \
        FR_TYPE_INTERNAL_DEF(_mid, _mid, _mid) \
        FR_TYPE_STRUCTURAL_DEF(_mid, _mid, _end)
 
/** @} */
 
/** @name Macros that emit multiple case statements to group types
 *
 * @{
 */
#define CASE_BEG(_type)         _type:
#define CASE_MID(_type)         case _type:
#define CASE_END(_type)         case _type
 
#define FR_TYPE_INTEGER_EXCEPT_BOOL             FR_TYPE_INTEGER_EXCEPT_BOOL_DEF(CASE_BEG, CASE_MID, CASE_END)
#define FR_TYPE_INTEGER                         FR_TYPE_INTEGER_DEF(CASE_BEG, CASE_MID, CASE_END)
#define FR_TYPE_SIGNED                          FR_TYPE_SIGNED_DEF(CASE_BEG, CASE_MID, CASE_END)
#define FR_TYPE_NUMERIC                         FR_TYPE_NUMERIC_DEF(CASE_BEG, CASE_MID, CASE_END)
 
#define FR_TYPE_IP                              FR_TYPE_IP_DEF(CASE_BEG, CASE_MID, CASE_END)
 
#define FR_TYPE_FIXED_SIZE                      FR_TYPE_FIXED_SIZE_DEF(CASE_BEG, CASE_MID, CASE_END)
#define FR_TYPE_VARIABLE_SIZE                   FR_TYPE_VARIABLE_SIZE_DEF(CASE_BEG, CASE_MID, CASE_END)
#define FR_TYPE_QUOTED                          FR_TYPE_QUOTED_DEF(CASE_BEG, CASE_MID, CASE_END)
 
#define FR_TYPE_STRUCTURAL_EXCEPT_VSA           FR_TYPE_STRUCTURAL_EXCEPT_VSA_DEF(CASE_BEG, CASE_MID, CASE_END)
#define FR_TYPE_STRUCTURAL_EXCEPT_GROUP         FR_TYPE_STRUCTURAL_EXCEPT_GROUP_DEF(CASE_BEG, CASE_MID, CASE_END)
#define FR_TYPE_STRUCTURAL                      FR_TYPE_STRUCTURAL_DEF(CASE_BEG, CASE_MID, CASE_END)
#define FR_TYPE_LEAF                            FR_TYPE_LEAF_DEF(CASE_BEG, CASE_MID, CASE_END)
#define FR_TYPE_NON_LEAF                        FR_TYPE_NON_LEAF_DEF(CASE_BEG, CASE_MID, CASE_END)
#define FR_TYPE_INTERNAL                        FR_TYPE_INTERNAL_DEF(CASE_BEG, CASE_MID, CASE_END)
/** @} */
 
/** @name Bool arrays that group types
 *
 * @{
 */
extern bool const fr_type_integer_except_bool[FR_TYPE_MAX + 1];
extern bool const fr_type_integer[FR_TYPE_MAX + 1];
extern bool const fr_type_signed[FR_TYPE_MAX + 1];
extern bool const fr_type_numeric[FR_TYPE_MAX + 1];
 
extern bool const fr_type_ip[FR_TYPE_MAX + 1];
 
extern bool const fr_type_fixed_size[FR_TYPE_MAX + 1];
extern bool const fr_type_variable_size[FR_TYPE_MAX + 1];
extern bool const fr_type_quoted[FR_TYPE_MAX + 1];
 
extern bool const fr_type_structural_except_vsa[FR_TYPE_MAX + 1];
extern bool const fr_type_structural[FR_TYPE_MAX + 1];
extern bool const fr_type_leaf[FR_TYPE_MAX + 1];
extern bool const fr_type_non_leaf[FR_TYPE_MAX + 1];
/** @} */
 
/** @name Type checking macros
 *
 * @{
 */
#define fr_type_is_null(_x)                     ((_x) == FR_TYPE_NULL)
#define fr_type_is_string(_x)                   ((_x) == FR_TYPE_STRING)
#define fr_type_is_octets(_x)                   ((_x) == FR_TYPE_OCTETS)
#define fr_type_is_ipv4addr(_x)                 ((_x) == FR_TYPE_IPV4_ADDR)
#define fr_type_is_ipv4prefix(_x)               ((_x) == FR_TYPE_IPV4_PREFIX)
#define fr_type_is_ipv6addr(_x)                 ((_x) == FR_TYPE_IPV6_ADDR)
#define fr_type_is_ipv6prefix(_x)               ((_x) == FR_TYPE_IPV6_PREFIX)
#define fr_type_is_ifid(_x)                     ((_x) == FR_TYPE_IFID)
#define fr_type_is_combo_ipaddr(_x)             ((_x) == FR_TYPE_COMBO_IP_ADDR)
#define fr_type_is_combo_ipprefix(_x)           ((_x) == FR_TYPE_COMBO_IP_PREFIX)
#define fr_type_is_ethernet(_x)                 ((_x) == FR_TYPE_ETHERNET)
#define fr_type_is_bool(_x)                     ((_x) == FR_TYPE_BOOL)
#define fr_type_is_uint8(_x)                    ((_x) == FR_TYPE_UINT8)
#define fr_type_is_uint16(_x)                   ((_x) == FR_TYPE_UINT16)
#define fr_type_is_uint32(_x)                   ((_x) == FR_TYPE_UINT32)
#define fr_type_is_uint64(_x)                   ((_x) == FR_TYPE_UINT64)
#define fr_type_is_int8(_x)                     ((_x) == FR_TYPE_INT8)
#define fr_type_is_int16(_x)                    ((_x) == FR_TYPE_INT16)
#define fr_type_is_int32(_x)                    ((_x) == FR_TYPE_INT32)
#define fr_type_is_int64(_x)                    ((_x) == FR_TYPE_INT64)
#define fr_type_is_float32(_x)                  ((_x) == FR_TYPE_FLOAT32)
#define fr_type_is_float64(_x)                  ((_x) == FR_TYPE_FLOAT64)
#define fr_type_is_date(_x)                     ((_x) == FR_TYPE_DATE)
#define fr_type_is_time_delta(_x)               ((_x) == FR_TYPE_TIME_DELTA)
#define fr_type_is_size(_x)                     ((_x) == FR_TYPE_SIZE)
#define fr_type_is_tlv(_x)                      ((_x) == FR_TYPE_TLV)
#define fr_type_is_struct(_x)                   ((_x) == FR_TYPE_STRUCT)
#define fr_type_is_vsa(_x)                      ((_x) == FR_TYPE_VSA)
#define fr_type_is_vendor(_x)                   ((_x) == FR_TYPE_VENDOR)
#define fr_type_is_group(_x)                    ((_x) == FR_TYPE_GROUP)
#define fr_type_is_value_box(_x)                ((_x) == FR_TYPE_VALUE_BOX)
#define fr_type_is_void(_x)                     ((_x) == FR_TYPE_VOID)
 
#define fr_type_is_integer_except_bool(_x)      (fr_type_integer_except_bool[_x])
#define fr_type_is_integer(_x)                  (fr_type_integer[_x])
#define fr_type_is_numeric(_x)                  (fr_type_numeric[_x])
#define fr_type_is_signed(_x)                   (fr_type_signed[_x])
 
#define fr_type_is_ip(_x)                       (fr_type_ip[_x])
 
#define fr_type_is_fixed_size(_x)               (fr_type_fixed_size[_x])
#define fr_type_is_variable_size(_x)            (fr_type_variable_size[_x])
#define fr_type_is_quoted(_x)                   (fr_type_quoted[_x])
 
#define fr_type_is_structural_except_vsa(_x)    (fr_type_structural_except_vsa[_x])
#define fr_type_is_structural(_x)               (fr_type_structural[_x])
#define fr_type_is_leaf(_x)                     (fr_type_leaf[_x])
#define fr_type_is_non_leaf(_x)                 (fr_type_non_leaf[_x])
/** @} */
 
/** Given a variable, return the equivalent FR_TYPE_* value
 *
 * @note Does not work for:
 * - size_t / FR_TYPE_SIZE - Conflicts with other integers on many systems.
 * - fr_ipaddr_t - Too many potential type mappings.
 * - tmpl_t - Not an FR_TYPE_*.
 *
 * @param[in] _ct variable to translate.
 */
#  define FR_CTYPE_TO_TYPE(_ct) \
_Generic(&(_ct), \
        fr_ethernet_t *         : FR_TYPE_ETHERNET, \
        fr_ethernet_t **        : FR_TYPE_ETHERNET, \
        fr_ifid_t *             : FR_TYPE_IFID, \
        fr_ifid_t **            : FR_TYPE_IFID, \
        fr_time_t *             : FR_TYPE_DATE, \
        fr_time_t **            : FR_TYPE_DATE, \
        fr_time_delta_t *       : FR_TYPE_TIME_DELTA, \
        fr_time_delta_t **      : FR_TYPE_TIME_DELTA, \
        char const **           : FR_TYPE_STRING, \
        char const ***          : FR_TYPE_STRING, \
        bool *                  : FR_TYPE_BOOL, \
        bool **                 : FR_TYPE_BOOL, \
        uint8_t const **        : FR_TYPE_OCTETS, \
        uint8_t const ***       : FR_TYPE_OCTETS, \
        uint8_t *               : FR_TYPE_UINT8, \
        uint8_t **              : FR_TYPE_UINT8, \
        uint16_t *              : FR_TYPE_UINT16, \
        uint16_t **             : FR_TYPE_UINT16, \
        uint32_t *              : FR_TYPE_UINT32, \
        uint32_t **             : FR_TYPE_UINT32, \
        uint64_t *              : FR_TYPE_UINT64, \
        uint64_t **             : FR_TYPE_UINT64, \
        int8_t *                : FR_TYPE_INT8, \
        int8_t **               : FR_TYPE_INT8, \
        int16_t *               : FR_TYPE_INT16, \
        int16_t **              : FR_TYPE_INT16, \
        int32_t *               : FR_TYPE_INT32, \
        int32_t **              : FR_TYPE_INT32, \
        int64_t *               : FR_TYPE_INT64, \
        int64_t **              : FR_TYPE_INT64, \
        float *                 : FR_TYPE_FLOAT32, \
        float **                : FR_TYPE_FLOAT32, \
        double *                : FR_TYPE_FLOAT64, \
        double **               : FR_TYPE_FLOAT64, \
        default                 : FR_TYPE_VOID )
 
extern fr_table_num_ordered_t const fr_type_table[];
extern size_t fr_type_table_len;
 
/** Return a static string containing the type name
 *
 * @param[in] type to return name for.
 * @return name of the type
 *
 * @hidecallergraph
 */
static inline char const *fr_type_to_str(fr_type_t type)
{
        return fr_table_str_by_value(fr_type_table, type, "<INVALID>");
}
 
/** Return the constant value representing a type
 *
 * @param[in] type to return the constant value for.
 * @return The constant type value or FR_TYPE_NULL if no type matches.
 */
static inline fr_type_t fr_type_from_str(char const *type)
{
        return fr_table_value_by_str(fr_type_table, type, FR_TYPE_NULL);
}
 
bool            fr_type_cast(fr_type_t dst, fr_type_t src);
fr_type_t       fr_type_promote(fr_type_t a, fr_type_t b);
 
void            **fr_type_array_alloc(TALLOC_CTX *ctx, fr_type_t type, size_t count);
 
#ifdef __cplusplus
}
#endif