saimetadatatypes.h

Go to the documentation of this file.

 
#ifndef __SAIMETADATATYPES_H_
#define __SAIMETADATATYPES_H_
 
#define SAI_INVALID_ATTRIBUTE_ID ((sai_attr_id_t)-1)
 
typedef struct _sai_object_meta_key_t
{
    sai_object_type_t           objecttype;
 
    sai_object_key_t            objectkey;
 
} sai_object_meta_key_t;
 
typedef enum _sai_attr_value_type_t
{
    SAI_ATTR_VALUE_TYPE_BOOL,
 
    SAI_ATTR_VALUE_TYPE_CHARDATA,
 
    SAI_ATTR_VALUE_TYPE_UINT8,
 
    SAI_ATTR_VALUE_TYPE_INT8,
 
    SAI_ATTR_VALUE_TYPE_UINT16,
 
    SAI_ATTR_VALUE_TYPE_INT16,
 
    SAI_ATTR_VALUE_TYPE_UINT32,
 
    SAI_ATTR_VALUE_TYPE_INT32,
 
    SAI_ATTR_VALUE_TYPE_UINT64,
 
    SAI_ATTR_VALUE_TYPE_INT64,
 
    SAI_ATTR_VALUE_TYPE_POINTER,
 
    SAI_ATTR_VALUE_TYPE_MAC,
 
    SAI_ATTR_VALUE_TYPE_IPV4,
 
    SAI_ATTR_VALUE_TYPE_IPV6,
 
    SAI_ATTR_VALUE_TYPE_IP_ADDRESS,
 
    SAI_ATTR_VALUE_TYPE_IP_PREFIX,
 
    SAI_ATTR_VALUE_TYPE_PRBS_RX_STATE,
 
    SAI_ATTR_VALUE_TYPE_OBJECT_ID,
 
    SAI_ATTR_VALUE_TYPE_OBJECT_LIST,
 
    SAI_ATTR_VALUE_TYPE_UINT8_LIST,
 
    SAI_ATTR_VALUE_TYPE_INT8_LIST,
 
    SAI_ATTR_VALUE_TYPE_UINT16_LIST,
 
    SAI_ATTR_VALUE_TYPE_INT16_LIST,
 
    SAI_ATTR_VALUE_TYPE_UINT32_LIST,
 
    SAI_ATTR_VALUE_TYPE_INT32_LIST,
 
    SAI_ATTR_VALUE_TYPE_UINT32_RANGE,
 
    SAI_ATTR_VALUE_TYPE_UINT16_RANGE_LIST,
 
    SAI_ATTR_VALUE_TYPE_INT32_RANGE,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_BOOL,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT8,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_INT8,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT16,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_INT16,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT32,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_INT32,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT64,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_MAC,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_IPV4,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_IPV6,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_MACSEC_SCI,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_OBJECT_ID,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_OBJECT_LIST,
 
    SAI_ATTR_VALUE_TYPE_ACL_FIELD_DATA_UINT8_LIST,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_BOOL,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_UINT8,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_INT8,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_UINT16,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_INT16,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_UINT32,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_INT32,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_MAC,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_IPV4,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_IPV6,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_IP_ADDRESS,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_OBJECT_ID,
 
    SAI_ATTR_VALUE_TYPE_ACL_ACTION_DATA_OBJECT_LIST,
 
    SAI_ATTR_VALUE_TYPE_ACL_CAPABILITY,
 
    SAI_ATTR_VALUE_TYPE_ACL_RESOURCE_LIST,
 
    SAI_ATTR_VALUE_TYPE_MAP_LIST,
 
    SAI_ATTR_VALUE_TYPE_VLAN_LIST,
 
    SAI_ATTR_VALUE_TYPE_QOS_MAP_LIST,
 
    SAI_ATTR_VALUE_TYPE_TLV_LIST,
 
    SAI_ATTR_VALUE_TYPE_SEGMENT_LIST,
 
    SAI_ATTR_VALUE_TYPE_IP_ADDRESS_LIST,
 
    SAI_ATTR_VALUE_TYPE_PORT_EYE_VALUES_LIST,
 
    SAI_ATTR_VALUE_TYPE_TIMESPEC,
 
    SAI_ATTR_VALUE_TYPE_NAT_ENTRY_DATA,
 
    SAI_ATTR_VALUE_TYPE_MACSEC_SCI,
 
    SAI_ATTR_VALUE_TYPE_MACSEC_SSCI,
 
    SAI_ATTR_VALUE_TYPE_MACSEC_SAK,
 
    SAI_ATTR_VALUE_TYPE_MACSEC_AUTH_KEY,
 
    SAI_ATTR_VALUE_TYPE_MACSEC_SALT,
 
    SAI_ATTR_VALUE_TYPE_SYSTEM_PORT_CONFIG,
 
    SAI_ATTR_VALUE_TYPE_SYSTEM_PORT_CONFIG_LIST,
 
    SAI_ATTR_VALUE_TYPE_FABRIC_PORT_REACHABILITY,
 
    SAI_ATTR_VALUE_TYPE_PORT_ERR_STATUS_LIST,
 
    SAI_ATTR_VALUE_TYPE_ENCRYPT_KEY,
 
    SAI_ATTR_VALUE_TYPE_AUTH_KEY,
 
    SAI_ATTR_VALUE_TYPE_LATCH_STATUS,
 
    SAI_ATTR_VALUE_TYPE_PORT_LANE_LATCH_STATUS_LIST,
 
    SAI_ATTR_VALUE_TYPE_JSON,
 
    SAI_ATTR_VALUE_TYPE_IP_PREFIX_LIST,
 
    SAI_ATTR_VALUE_TYPE_ACL_CHAIN_LIST,
 
    SAI_ATTR_VALUE_TYPE_PORT_FREQUENCY_OFFSET_PPM_LIST,
 
    SAI_ATTR_VALUE_TYPE_PORT_SNR_LIST,
 
    SAI_ATTR_VALUE_TYPE_TWAMP_STATS_DATA,
} sai_attr_value_type_t;
 
typedef enum _sai_attr_flags_t
{
    SAI_ATTR_FLAGS_MANDATORY_ON_CREATE = (1 << 0),
 
    SAI_ATTR_FLAGS_CREATE_ONLY         = (1 << 1),
 
    SAI_ATTR_FLAGS_CREATE_AND_SET      = (1 << 2),
 
    SAI_ATTR_FLAGS_READ_ONLY           = (1 << 3),
 
    SAI_ATTR_FLAGS_KEY                 = (1 << 4),
 
    SAI_ATTR_FLAGS_DYNAMIC             = (1 << 5),
 
    SAI_ATTR_FLAGS_SPECIAL             = (1 << 6),
 
} sai_attr_flags_t;
 
#define SAI_HAS_FLAG_MANDATORY_ON_CREATE(x)   (((x) & SAI_ATTR_FLAGS_MANDATORY_ON_CREATE) == SAI_ATTR_FLAGS_MANDATORY_ON_CREATE)
 
#define SAI_HAS_FLAG_CREATE_ONLY(x)           (((x) & SAI_ATTR_FLAGS_CREATE_ONLY) == SAI_ATTR_FLAGS_CREATE_ONLY)
 
#define SAI_HAS_FLAG_CREATE_AND_SET(x)        (((x) & SAI_ATTR_FLAGS_CREATE_AND_SET) == SAI_ATTR_FLAGS_CREATE_AND_SET)
 
#define SAI_HAS_FLAG_READ_ONLY(x)             (((x) & SAI_ATTR_FLAGS_READ_ONLY) == SAI_ATTR_FLAGS_READ_ONLY)
 
#define SAI_HAS_FLAG_KEY(x)                   (((x) & SAI_ATTR_FLAGS_KEY) == SAI_ATTR_FLAGS_KEY)
 
#define SAI_HAS_FLAG_DYNAMIC(x)               (((x) & SAI_ATTR_FLAGS_DYNAMIC) == SAI_ATTR_FLAGS_DYNAMIC)
 
#define SAI_HAS_FLAG_SPECIAL(x)               (((x) & SAI_ATTR_FLAGS_SPECIAL) == SAI_ATTR_FLAGS_SPECIAL)
 
typedef enum _sai_default_value_type_t
{
    SAI_DEFAULT_VALUE_TYPE_NONE = 0,
 
    SAI_DEFAULT_VALUE_TYPE_CONST,
 
    SAI_DEFAULT_VALUE_TYPE_ATTR_RANGE,
 
    SAI_DEFAULT_VALUE_TYPE_ATTR_VALUE,
 
    SAI_DEFAULT_VALUE_TYPE_EMPTY_LIST,
 
    SAI_DEFAULT_VALUE_TYPE_VENDOR_SPECIFIC,
 
    SAI_DEFAULT_VALUE_TYPE_SWITCH_INTERNAL,
 
} sai_default_value_type_t;
 
typedef enum _sai_attr_condition_type_t
{
    SAI_ATTR_CONDITION_TYPE_NONE = 0,
 
    SAI_ATTR_CONDITION_TYPE_OR,
 
    SAI_ATTR_CONDITION_TYPE_AND,
 
    SAI_ATTR_CONDITION_TYPE_MIXED,
 
} sai_attr_condition_type_t;
 
typedef enum _sai_condition_operator_t
{
    SAI_CONDITION_OPERATOR_EQ = 0,
 
    SAI_CONDITION_OPERATOR_NE,
 
    SAI_CONDITION_OPERATOR_LT,
 
    SAI_CONDITION_OPERATOR_GT,
 
    SAI_CONDITION_OPERATOR_LE,
 
    SAI_CONDITION_OPERATOR_GE,
 
} sai_condition_operator_t;
 
typedef struct _sai_attr_condition_t
{
    sai_attr_id_t                       attrid;
 
    const sai_attribute_value_t         condition;
 
    sai_condition_operator_t            op;
 
    sai_attr_condition_type_t           type;
 
} sai_attr_condition_t;
 
typedef enum _sai_enum_flags_type_t
{
    SAI_ENUM_FLAGS_TYPE_NONE,
 
    SAI_ENUM_FLAGS_TYPE_STRICT,
 
    SAI_ENUM_FLAGS_TYPE_MIXED,
 
    SAI_ENUM_FLAGS_TYPE_RANGES,
 
    SAI_ENUM_FLAGS_TYPE_FREE,
 
    /* future types can be defined */
 
    /* TODO extension type? */
 
} sai_enum_flags_type_t;
 
typedef struct _sai_enum_metadata_t
{
    const char* const               name;
 
    const size_t                    valuescount;
 
    const int* const                values;
 
    const char* const* const        valuesnames;
 
    const char* const* const        valuesshortnames;
 
    bool                            containsflags;
 
    sai_enum_flags_type_t           flagstype;
 
    const int* const                ignorevalues;
 
    const char* const* const        ignorevaluesnames;
 
    sai_object_type_t               objecttype;
 
} sai_enum_metadata_t;
 
typedef struct _sai_attr_capability_metadata_t
{
    uint64_t                    vendorid;
 
    sai_attr_capability_t       operationcapability;
 
    const size_t                enumvaluescount;
 
    const int* const            enumvalues;
 
} sai_attr_capability_metadata_t;
 
typedef struct _sai_attr_metadata_t
{
    sai_object_type_t                           objecttype;
 
    sai_attr_id_t                               attrid;
 
    const char* const                           attridname;
 
    const char* const                           brief;
 
    sai_attr_value_type_t                       attrvaluetype;
 
    sai_attr_flags_t                            flags;
 
    const sai_object_type_t* const              allowedobjecttypes;
 
    size_t                                      allowedobjecttypeslength;
 
    bool                                        allowrepetitiononlist;
 
    bool                                        allowmixedobjecttypes;
 
    bool                                        allowemptylist;
 
    bool                                        allownullobjectid;
 
    bool                                        isoidattribute;
 
    const sai_default_value_type_t              defaultvaluetype;
 
    const sai_attribute_value_t* const          defaultvalue;
 
    sai_object_type_t                           defaultvalueobjecttype;
 
    sai_attr_id_t                               defaultvalueattrid;
 
    bool                                        storedefaultvalue;
 
    bool                                        isenum;
 
    bool                                        isenumlist;
 
    const sai_enum_metadata_t* const            enummetadata;
 
    sai_attr_condition_type_t                   conditiontype;
 
    const sai_attr_condition_t* const* const    conditions;
 
    size_t                                      conditionslength;
 
    bool                                        isconditional;
 
    sai_attr_condition_type_t                   validonlytype;
 
    const sai_attr_condition_t* const* const    validonly;
 
    size_t                                      validonlylength;
 
    bool                                        isvalidonly;
 
    bool                                        getsave;
 
    bool                                        isvlan;
 
    bool                                        isaclfield;
 
    bool                                        isaclaction;
 
    bool                                        isaclmask;
 
    bool                                        ismandatoryoncreate;
 
    bool                                        iscreateonly;
 
    bool                                        iscreateandset;
 
    bool                                        isreadonly;
 
    bool                                        iskey;
 
    bool                                        isprimitive;
 
    int                                         notificationtype;
 
    bool                                        iscallback;
 
    int                                         pointertype;
 
    const sai_attr_capability_metadata_t* const* const capability;
 
    size_t                                      capabilitylength;
 
    bool                                        isextensionattr;
 
    bool                                        isresourcetype;
 
    bool                                        isdeprecated;
 
    bool                                        isconditionrelaxed;
 
} sai_attr_metadata_t;
 
/*
 * TODO since non object id members can have different type and can be located
 * at different object_key union position, we need to find a way to extract
 * those for automatic serialize/deserialize for example extracting value as
 * sai_attribute_value_t and pointing to right serialize/deserialize functions.
 * Also, an automatic generated functions for serialize/deserialize for those non
 * object id structures must be generated, we don't want to update them manually.
 */
 
typedef sai_object_id_t (*sai_meta_get_struct_member_oid_fn)(
        _In_ const sai_object_meta_key_t *object_meta_key);
 
typedef void (*sai_meta_set_struct_member_oid_fn)(
        _Inout_ sai_object_meta_key_t *object_meta_key,
        _In_ sai_object_id_t object_id);
 
typedef struct _sai_struct_member_info_t
{
    sai_attr_value_type_t                               membervaluetype;
 
    const char* const                                   membername;
 
    bool                                                isvlan;
 
    const sai_object_type_t* const                      allowedobjecttypes;
 
    size_t                                              allowedobjecttypeslength;
 
    bool                                                isenum;
 
    const sai_enum_metadata_t* const                    enummetadata;
 
    const sai_meta_get_struct_member_oid_fn             getoid;
 
    const sai_meta_set_struct_member_oid_fn             setoid;
 
    size_t                                              offset;
 
    size_t                                              size;
 
} sai_struct_member_info_t;
 
typedef struct _sai_rev_graph_member_t
{
    sai_object_type_t                       objecttype;
 
    sai_object_type_t                       depobjecttype;
 
    const sai_attr_metadata_t* const        attrmetadata;
 
    const sai_struct_member_info_t* const   structmember;
 
} sai_rev_graph_member_t;
 
/*
 * Generic QUAD API definitions. All APIs can be called using this quad generic
 * functions.
 *
 * When creating switch object or non object id switch_id parameter is ignored,
 * and can be NULL. Currently object type inside sai_object_meta_key_t is
 * ignored and can be skipped.
 *
 * This generic quad API will help us later to call any API, without doing any
 * switch cases for calling different signature functions including non object
 * id structures. Also, later we will generate automatic serialize and
 * deserialize methods for non object id which will deserialize data to object
 * union in sai_object_meta_key_t to right place.
 */
 
typedef sai_status_t (*sai_meta_generic_create_fn)(
        _Inout_ sai_object_meta_key_t *meta_key,
        _In_ sai_object_id_t switch_id,
        _In_ uint32_t attr_count,
        _In_ const sai_attribute_t *attr_list);
 
typedef sai_status_t (*sai_meta_generic_remove_fn)(
        _In_ const sai_object_meta_key_t *meta_key);
 
typedef sai_status_t (*sai_meta_generic_set_fn)(
        _In_ const sai_object_meta_key_t *meta_key,
        _In_ const sai_attribute_t *attr);
 
typedef sai_status_t (*sai_meta_generic_get_fn)(
        _In_ const sai_object_meta_key_t *meta_key,
        _In_ uint32_t attr_count,
        _Inout_ sai_attribute_t *attr_list);
 
typedef sai_status_t (*sai_meta_generic_get_stats_fn)(
        _In_ const sai_object_meta_key_t *meta_key,
        _In_ uint32_t number_of_counters,
        _In_ const sai_stat_id_t *counter_ids,
        _Out_ uint64_t *counters);
 
typedef sai_status_t (*sai_meta_generic_get_stats_ext_fn)(
        _In_ const sai_object_meta_key_t *meta_key,
        _In_ uint32_t number_of_counters,
        _In_ const sai_stat_id_t *counter_ids,
        _In_ sai_stats_mode_t mode,
        _Out_ uint64_t *counters);
 
typedef sai_status_t (*sai_meta_generic_clear_stats_fn)(
        _In_ const sai_object_meta_key_t *meta_key,
        _In_ uint32_t number_of_counters,
        _In_ const sai_stat_id_t *counter_ids);
 
typedef sai_status_t (*sai_generic_create_fn)(
        _Out_ sai_object_id_t *object_id,
        _In_ sai_object_id_t switch_id,
        _In_ uint32_t attr_count,
        _In_ const sai_attribute_t *attr_list);
 
typedef sai_status_t (*sai_generic_remove_fn)(
        _In_ sai_object_id_t object_id);
 
typedef sai_status_t (*sai_generic_set_fn)(
        _In_ sai_object_id_t object_id,
        _In_ const sai_attribute_t *attr);
 
typedef sai_status_t (*sai_generic_get_fn)(
        _In_ sai_object_id_t object_id,
        _In_ uint32_t attr_count,
        _Inout_ sai_attribute_t *attr_list);
 
typedef struct _sai_object_type_info_t
{
    sai_object_type_t                               objecttype;
 
    const char* const                               objecttypename;
 
    sai_attr_id_t                                   attridstart;
 
    sai_attr_id_t                                   attridend;
 
    const sai_enum_metadata_t* const                enummetadata;
 
    const sai_attr_metadata_t* const* const         attrmetadata;
 
    size_t                                          attrmetadatalength;
 
    bool                                            isnonobjectid;
 
    bool                                            isobjectid;
 
    const sai_struct_member_info_t* const* const    structmembers;
 
    size_t                                          structmemberscount;
 
    const sai_rev_graph_member_t* const* const      revgraphmembers;
 
    size_t                                          revgraphmemberscount;
 
    const sai_meta_generic_create_fn                create;
 
    const sai_meta_generic_remove_fn                remove;
 
    const sai_meta_generic_set_fn                   set;
 
    const sai_meta_generic_get_fn                   get;
 
    const sai_meta_generic_get_stats_fn             getstats;
 
    const sai_meta_generic_get_stats_ext_fn         getstatsext;
 
    const sai_meta_generic_clear_stats_fn           clearstats;
 
    bool                                            isexperimental;
 
    const sai_enum_metadata_t* const                statenum;
 
} sai_object_type_info_t;
 
#endif