daos_obj_class.h

 
#ifndef __DAOS_OBJ_CLASS_H__
#define __DAOS_OBJ_CLASS_H__
 
#if defined(__cplusplus)
extern "C" {
#endif
 
#include <sys/types.h>
#include <inttypes.h>
 
#include <daos_types.h>
 
#define MAX_OBJ_CLASS_NAME_LEN       24
 
#define MAX_NUM_GROUPS               ((1 << 16UL) - 1)
#define OC_REDUN_SHIFT               24
#define OBJ_CLASS_DEF(redun, grp_nr) ((redun << OC_REDUN_SHIFT) | grp_nr)
 
enum daos_obj_redun {
    OC_UNKNOWN = 0,
 
    OR_RP_1 = 1,
 
    OR_RP_2 = 8,
    OR_RP_3,
    OR_RP_4,
    OR_RP_5,
    OR_RP_6,
    OR_RP_8,
    OR_RP_12,
    OR_RP_16,
    OR_RP_24,
    OR_RP_32,
    OR_RP_48,
    OR_RP_64,
    OR_RP_128,
 
    OR_RS_2P1 = 32,
    OR_RS_2P2,
    OR_RS_4P1,
    OR_RS_4P2,
    OR_RS_8P1,
    OR_RS_8P2,
    OR_RS_16P1,
    OR_RS_16P2,
 
    /*
     * Predefined object classes that can be used directly by the API user.
     * It describes schema of data distribution & protection.
     */
    OC_BACK_COMPAT = 50,
    OC_TINY,
    OC_SMALL,
    OC_LARGE,
    OC_MAX,
 
    OC_RP_TINY = 60,
    OC_RP_SMALL,
    OC_RP_LARGE,
    OC_RP_MAX,
 
    OC_RP_SF_TINY = 70,
    OC_RP_SF_SMALL,
    OC_RP_SF_LARGE,
    OC_RP_SF_MAX,
 
    OC_RP_XSF = 80,
 
    OC_EC_TINY = 100,
    OC_EC_SMALL,
    OC_EC_LARGE,
    OC_EC_MAX,
    OC_S1  = OBJ_CLASS_DEF(OR_RP_1, 1ULL),
    OC_S2  = OBJ_CLASS_DEF(OR_RP_1, 2ULL),
    OC_S4  = OBJ_CLASS_DEF(OR_RP_1, 4ULL),
    OC_S6  = OBJ_CLASS_DEF(OR_RP_1, 6ULL),
    OC_S8  = OBJ_CLASS_DEF(OR_RP_1, 8ULL),
    OC_S12 = OBJ_CLASS_DEF(OR_RP_1, 12ULL),
    OC_S16 = OBJ_CLASS_DEF(OR_RP_1, 16ULL),
    OC_S32 = OBJ_CLASS_DEF(OR_RP_1, 32ULL),
    OC_SX  = OBJ_CLASS_DEF(OR_RP_1, MAX_NUM_GROUPS),
 
    OC_RP_2G1  = OBJ_CLASS_DEF(OR_RP_2, 1ULL),
    OC_RP_2G2  = OBJ_CLASS_DEF(OR_RP_2, 2ULL),
    OC_RP_2G4  = OBJ_CLASS_DEF(OR_RP_2, 4ULL),
    OC_RP_2G6  = OBJ_CLASS_DEF(OR_RP_2, 6ULL),
    OC_RP_2G8  = OBJ_CLASS_DEF(OR_RP_2, 8ULL),
    OC_RP_2G12 = OBJ_CLASS_DEF(OR_RP_2, 12ULL),
    OC_RP_2G16 = OBJ_CLASS_DEF(OR_RP_2, 16ULL),
    OC_RP_2G32 = OBJ_CLASS_DEF(OR_RP_2, 32ULL),
    OC_RP_2GX  = OBJ_CLASS_DEF(OR_RP_2, MAX_NUM_GROUPS),
 
    OC_RP_3G1  = OBJ_CLASS_DEF(OR_RP_3, 1ULL),
    OC_RP_3G2  = OBJ_CLASS_DEF(OR_RP_3, 2ULL),
    OC_RP_3G4  = OBJ_CLASS_DEF(OR_RP_3, 4ULL),
    OC_RP_3G6  = OBJ_CLASS_DEF(OR_RP_3, 6ULL),
    OC_RP_3G8  = OBJ_CLASS_DEF(OR_RP_3, 8ULL),
    OC_RP_3G12 = OBJ_CLASS_DEF(OR_RP_3, 12ULL),
    OC_RP_3G16 = OBJ_CLASS_DEF(OR_RP_3, 16ULL),
    OC_RP_3G32 = OBJ_CLASS_DEF(OR_RP_3, 32ULL),
    OC_RP_3GX  = OBJ_CLASS_DEF(OR_RP_3, MAX_NUM_GROUPS),
 
    OC_RP_4G1  = OBJ_CLASS_DEF(OR_RP_4, 1ULL),
    OC_RP_4G2  = OBJ_CLASS_DEF(OR_RP_4, 2ULL),
    OC_RP_4G4  = OBJ_CLASS_DEF(OR_RP_4, 4ULL),
    OC_RP_4G6  = OBJ_CLASS_DEF(OR_RP_4, 6ULL),
    OC_RP_4G8  = OBJ_CLASS_DEF(OR_RP_4, 8ULL),
    OC_RP_4G12 = OBJ_CLASS_DEF(OR_RP_4, 12ULL),
    OC_RP_4G16 = OBJ_CLASS_DEF(OR_RP_4, 16ULL),
    OC_RP_4G32 = OBJ_CLASS_DEF(OR_RP_4, 32ULL),
    OC_RP_4GX  = OBJ_CLASS_DEF(OR_RP_4, MAX_NUM_GROUPS),
 
    OC_RP_5G1  = OBJ_CLASS_DEF(OR_RP_5, 1ULL),
    OC_RP_5G2  = OBJ_CLASS_DEF(OR_RP_5, 2ULL),
    OC_RP_5G4  = OBJ_CLASS_DEF(OR_RP_5, 4ULL),
    OC_RP_5G6  = OBJ_CLASS_DEF(OR_RP_5, 6ULL),
    OC_RP_5G8  = OBJ_CLASS_DEF(OR_RP_5, 8ULL),
    OC_RP_5G12 = OBJ_CLASS_DEF(OR_RP_5, 12ULL),
    OC_RP_5G16 = OBJ_CLASS_DEF(OR_RP_5, 16ULL),
    OC_RP_5G32 = OBJ_CLASS_DEF(OR_RP_5, 32ULL),
    OC_RP_5GX  = OBJ_CLASS_DEF(OR_RP_5, MAX_NUM_GROUPS),
 
    OC_RP_6G1  = OBJ_CLASS_DEF(OR_RP_6, 1ULL),
    OC_RP_6G2  = OBJ_CLASS_DEF(OR_RP_6, 2ULL),
    OC_RP_6G4  = OBJ_CLASS_DEF(OR_RP_6, 4ULL),
    OC_RP_6G6  = OBJ_CLASS_DEF(OR_RP_6, 6ULL),
    OC_RP_6G8  = OBJ_CLASS_DEF(OR_RP_6, 8ULL),
    OC_RP_6G12 = OBJ_CLASS_DEF(OR_RP_6, 12ULL),
    OC_RP_6G16 = OBJ_CLASS_DEF(OR_RP_6, 16ULL),
    OC_RP_6G32 = OBJ_CLASS_DEF(OR_RP_6, 32ULL),
    OC_RP_6GX  = OBJ_CLASS_DEF(OR_RP_6, MAX_NUM_GROUPS),
 
    /* OC_XSF will map to one of these */
    OC_RP_12G1  = OBJ_CLASS_DEF(OR_RP_12, 1ULL),
    OC_RP_16G1  = OBJ_CLASS_DEF(OR_RP_16, 1ULL),
    OC_RP_24G1  = OBJ_CLASS_DEF(OR_RP_24, 1ULL),
    OC_RP_32G1  = OBJ_CLASS_DEF(OR_RP_32, 1ULL),
    OC_RP_48G1  = OBJ_CLASS_DEF(OR_RP_48, 1ULL),
    OC_RP_64G1  = OBJ_CLASS_DEF(OR_RP_64, 1ULL),
    OC_RP_128G1 = OBJ_CLASS_DEF(OR_RP_128, 1ULL),
 
    OC_EC_2P1G1  = OBJ_CLASS_DEF(OR_RS_2P1, 1ULL),
    OC_EC_2P1G2  = OBJ_CLASS_DEF(OR_RS_2P1, 2ULL),
    OC_EC_2P1G4  = OBJ_CLASS_DEF(OR_RS_2P1, 4ULL),
    OC_EC_2P1G6  = OBJ_CLASS_DEF(OR_RS_2P1, 6ULL),
    OC_EC_2P1G8  = OBJ_CLASS_DEF(OR_RS_2P1, 8ULL),
    OC_EC_2P1G12 = OBJ_CLASS_DEF(OR_RS_2P1, 12ULL),
    OC_EC_2P1G16 = OBJ_CLASS_DEF(OR_RS_2P1, 16ULL),
    OC_EC_2P1G32 = OBJ_CLASS_DEF(OR_RS_2P1, 32ULL),
    OC_EC_2P1GX  = OBJ_CLASS_DEF(OR_RS_2P1, MAX_NUM_GROUPS),
 
    OC_EC_2P2G1  = OBJ_CLASS_DEF(OR_RS_2P2, 1ULL),
    OC_EC_2P2G2  = OBJ_CLASS_DEF(OR_RS_2P2, 2ULL),
    OC_EC_2P2G4  = OBJ_CLASS_DEF(OR_RS_2P2, 4ULL),
    OC_EC_2P2G6  = OBJ_CLASS_DEF(OR_RS_2P2, 6ULL),
    OC_EC_2P2G8  = OBJ_CLASS_DEF(OR_RS_2P2, 8ULL),
    OC_EC_2P2G12 = OBJ_CLASS_DEF(OR_RS_2P2, 12ULL),
    OC_EC_2P2G16 = OBJ_CLASS_DEF(OR_RS_2P2, 16ULL),
    OC_EC_2P2G32 = OBJ_CLASS_DEF(OR_RS_2P2, 32ULL),
    OC_EC_2P2GX  = OBJ_CLASS_DEF(OR_RS_2P2, MAX_NUM_GROUPS),
 
    OC_EC_4P1G1  = OBJ_CLASS_DEF(OR_RS_4P1, 1ULL),
    OC_EC_4P1G2  = OBJ_CLASS_DEF(OR_RS_4P1, 2ULL),
    OC_EC_4P1G4  = OBJ_CLASS_DEF(OR_RS_4P1, 4ULL),
    OC_EC_4P1G6  = OBJ_CLASS_DEF(OR_RS_4P1, 6ULL),
    OC_EC_4P1G8  = OBJ_CLASS_DEF(OR_RS_4P1, 8ULL),
    OC_EC_4P1G12 = OBJ_CLASS_DEF(OR_RS_4P1, 12ULL),
    OC_EC_4P1G16 = OBJ_CLASS_DEF(OR_RS_4P1, 16ULL),
    OC_EC_4P1G32 = OBJ_CLASS_DEF(OR_RS_4P1, 32ULL),
    OC_EC_4P1GX  = OBJ_CLASS_DEF(OR_RS_4P1, MAX_NUM_GROUPS),
 
    OC_EC_4P2G1  = OBJ_CLASS_DEF(OR_RS_4P2, 1ULL),
    OC_EC_4P2G2  = OBJ_CLASS_DEF(OR_RS_4P2, 2ULL),
    OC_EC_4P2G4  = OBJ_CLASS_DEF(OR_RS_4P2, 4ULL),
    OC_EC_4P2G6  = OBJ_CLASS_DEF(OR_RS_4P2, 6ULL),
    OC_EC_4P2G8  = OBJ_CLASS_DEF(OR_RS_4P2, 8ULL),
    OC_EC_4P2G12 = OBJ_CLASS_DEF(OR_RS_4P2, 12ULL),
    OC_EC_4P2G16 = OBJ_CLASS_DEF(OR_RS_4P2, 16ULL),
    OC_EC_4P2G32 = OBJ_CLASS_DEF(OR_RS_4P2, 32ULL),
    OC_EC_4P2GX  = OBJ_CLASS_DEF(OR_RS_4P2, MAX_NUM_GROUPS),
 
    OC_EC_8P1G1  = OBJ_CLASS_DEF(OR_RS_8P1, 1ULL),
    OC_EC_8P1G2  = OBJ_CLASS_DEF(OR_RS_8P1, 2ULL),
    OC_EC_8P1G4  = OBJ_CLASS_DEF(OR_RS_8P1, 4ULL),
    OC_EC_8P1G6  = OBJ_CLASS_DEF(OR_RS_8P1, 6ULL),
    OC_EC_8P1G8  = OBJ_CLASS_DEF(OR_RS_8P1, 8ULL),
    OC_EC_8P1G12 = OBJ_CLASS_DEF(OR_RS_8P1, 12ULL),
    OC_EC_8P1G16 = OBJ_CLASS_DEF(OR_RS_8P1, 16ULL),
    OC_EC_8P1G32 = OBJ_CLASS_DEF(OR_RS_8P1, 32ULL),
    OC_EC_8P1GX  = OBJ_CLASS_DEF(OR_RS_8P1, MAX_NUM_GROUPS),
 
    OC_EC_8P2G1  = OBJ_CLASS_DEF(OR_RS_8P2, 1ULL),
    OC_EC_8P2G2  = OBJ_CLASS_DEF(OR_RS_8P2, 2ULL),
    OC_EC_8P2G4  = OBJ_CLASS_DEF(OR_RS_8P2, 4ULL),
    OC_EC_8P2G6  = OBJ_CLASS_DEF(OR_RS_8P2, 6ULL),
    OC_EC_8P2G8  = OBJ_CLASS_DEF(OR_RS_8P2, 8ULL),
    OC_EC_8P2G12 = OBJ_CLASS_DEF(OR_RS_8P2, 12ULL),
    OC_EC_8P2G16 = OBJ_CLASS_DEF(OR_RS_8P2, 16ULL),
    OC_EC_8P2G32 = OBJ_CLASS_DEF(OR_RS_8P2, 32ULL),
    OC_EC_8P2GX  = OBJ_CLASS_DEF(OR_RS_8P2, MAX_NUM_GROUPS),
 
    OC_EC_16P1G1  = OBJ_CLASS_DEF(OR_RS_16P1, 1ULL),
    OC_EC_16P1G2  = OBJ_CLASS_DEF(OR_RS_16P1, 2ULL),
    OC_EC_16P1G4  = OBJ_CLASS_DEF(OR_RS_16P1, 4ULL),
    OC_EC_16P1G6  = OBJ_CLASS_DEF(OR_RS_16P1, 6ULL),
    OC_EC_16P1G8  = OBJ_CLASS_DEF(OR_RS_16P1, 8ULL),
    OC_EC_16P1G12 = OBJ_CLASS_DEF(OR_RS_16P1, 12ULL),
    OC_EC_16P1G16 = OBJ_CLASS_DEF(OR_RS_16P1, 16ULL),
    OC_EC_16P1G32 = OBJ_CLASS_DEF(OR_RS_16P1, 32ULL),
    OC_EC_16P1GX  = OBJ_CLASS_DEF(OR_RS_16P1, MAX_NUM_GROUPS),
 
    OC_EC_16P2G1  = OBJ_CLASS_DEF(OR_RS_16P2, 1ULL),
    OC_EC_16P2G2  = OBJ_CLASS_DEF(OR_RS_16P2, 2ULL),
    OC_EC_16P2G4  = OBJ_CLASS_DEF(OR_RS_16P2, 4ULL),
    OC_EC_16P2G6  = OBJ_CLASS_DEF(OR_RS_16P2, 6ULL),
    OC_EC_16P2G8  = OBJ_CLASS_DEF(OR_RS_16P2, 8ULL),
    OC_EC_16P2G12 = OBJ_CLASS_DEF(OR_RS_16P2, 12ULL),
    OC_EC_16P2G16 = OBJ_CLASS_DEF(OR_RS_16P2, 16ULL),
    OC_EC_16P2G32 = OBJ_CLASS_DEF(OR_RS_16P2, 32ULL),
    OC_EC_16P2GX  = OBJ_CLASS_DEF(OR_RS_16P2, MAX_NUM_GROUPS),
 
    OC_RESERVED = 1 << 30,
 
};
 
enum daos_obj_schema {
    DAOS_OS_SINGLE,     
    DAOS_OS_STRIPED,    
    DAOS_OS_DYN_STRIPED,    
    DAOS_OS_DYN_CHUNKED,    
};
 
enum daos_obj_resil {
    DAOS_RES_EC,            
    DAOS_RES_REPL,          
};
 
struct daos_oclass_attr {
    enum daos_obj_schema         ca_schema;
    enum daos_obj_resil      ca_resil;
    unsigned int             ca_resil_degree;
    unsigned int             ca_grp_nr;
    union {
        struct daos_rp_attr {
            unsigned int     r_proto;
            unsigned int     r_num;
        } rp;
 
        struct daos_ec_attr {
            unsigned short   e_k;
            unsigned short   e_p;
            unsigned int     e_len;
        } ec;
    } u;
};
 
typedef uint32_t        daos_oclass_id_t;
typedef uint16_t        daos_oclass_hints_t;
 
struct daos_oclass_list {
    uint32_t         cl_nr;
    uint32_t         cl_nr_out;
    daos_oclass_id_t    *cl_cids;
    struct daos_oclass_attr *cl_cattrs;
};
 
int
daos_oclass_name2id(const char *name);
 
ssize_t
daos_oclass_names_list(size_t size, char *str);
 
int
daos_oclass_nr(int opts);
 
int
daos_oclass_id2name(daos_oclass_id_t oc_id, char *name);
 
int
daos_obj_register_class(daos_handle_t coh, daos_oclass_id_t cid,
            struct daos_oclass_attr *attr, daos_event_t *ev);
 
int
daos_obj_query_class(daos_handle_t coh, daos_oclass_id_t cid,
             struct daos_oclass_attr *attr, daos_event_t *ev);
 
int
daos_obj_list_class(daos_handle_t coh, struct daos_oclass_list *list,
            daos_anchor_t *anchor, daos_event_t *ev);
 
#if defined(__cplusplus)
}
#endif
 
#endif /* __DAOS_OBJ_CLASS_H__ */