DAOS API (v2.0)
Loading...
Searching...
No Matches
daos_obj_class.h
1
6#ifndef __DAOS_OBJ_CLASS_H__
7#define __DAOS_OBJ_CLASS_H__
8
9#if defined(__cplusplus)
10extern "C" {
11#endif
12
17enum daos_obj_redun {
21 OR_RP_1 = 1,
22
27 OR_RP_2 = 8,
28 OR_RP_3,
29 OR_RP_4,
30 OR_RP_5,
31 OR_RP_6,
32 OR_RP_8,
33 OR_RP_12,
34 OR_RP_16,
35 OR_RP_24,
36 OR_RP_32,
37 OR_RP_48,
38 OR_RP_64,
39 OR_RP_128,
40
53 OR_RS_2P1 = 32,
54 OR_RS_2P2,
55 OR_RS_4P1,
56 OR_RS_4P2,
57 OR_RS_8P1,
58 OR_RS_8P2,
59 OR_RS_16P1,
60 OR_RS_16P2,
61};
62
63
64#define MAX_NUM_GROUPS ((1 << 16UL) - 1)
65#define OC_REDUN_SHIFT 24
66#define OBJ_CLASS_DEF(redun, grp_nr) ((redun << OC_REDUN_SHIFT) | grp_nr)
71enum {
72 OC_UNKNOWN = 0,
77 OC_BACK_COMPAT = 50,
79 OC_TINY,
85 OC_SMALL,
91 OC_LARGE,
97 OC_MAX,
98
106 OC_RP_TINY = 60,
112 OC_RP_SMALL,
118 OC_RP_LARGE,
124 OC_RP_MAX,
125
136 OC_RP_SF_TINY = 70,
142 OC_RP_SF_SMALL,
148 OC_RP_SF_LARGE,
154 OC_RP_SF_MAX,
155
160 OC_RP_XSF = 80,
161
169 OC_EC_TINY = 100,
175 OC_EC_SMALL,
181 OC_EC_LARGE,
187 OC_EC_MAX,
197 OC_S1 = OBJ_CLASS_DEF(OR_RP_1, 1ULL),
198 OC_S2 = OBJ_CLASS_DEF(OR_RP_1, 2ULL),
199 OC_S4 = OBJ_CLASS_DEF(OR_RP_1, 4ULL),
200 OC_S6 = OBJ_CLASS_DEF(OR_RP_1, 6ULL),
201 OC_S8 = OBJ_CLASS_DEF(OR_RP_1, 8ULL),
202 OC_S12 = OBJ_CLASS_DEF(OR_RP_1, 12ULL),
203 OC_S16 = OBJ_CLASS_DEF(OR_RP_1, 16ULL),
204 OC_S32 = OBJ_CLASS_DEF(OR_RP_1, 32ULL),
205 OC_SX = OBJ_CLASS_DEF(OR_RP_1, MAX_NUM_GROUPS),
206
218 OC_RP_2G1 = OBJ_CLASS_DEF(OR_RP_2, 1ULL),
219 OC_RP_2G2 = OBJ_CLASS_DEF(OR_RP_2, 2ULL),
220 OC_RP_2G4 = OBJ_CLASS_DEF(OR_RP_2, 4ULL),
221 OC_RP_2G6 = OBJ_CLASS_DEF(OR_RP_2, 6ULL),
222 OC_RP_2G8 = OBJ_CLASS_DEF(OR_RP_2, 8ULL),
223 OC_RP_2G12 = OBJ_CLASS_DEF(OR_RP_2, 12ULL),
224 OC_RP_2G16 = OBJ_CLASS_DEF(OR_RP_2, 16ULL),
225 OC_RP_2G32 = OBJ_CLASS_DEF(OR_RP_2, 32ULL),
226 OC_RP_2GX = OBJ_CLASS_DEF(OR_RP_2, MAX_NUM_GROUPS),
227
229 OC_RP_3G1 = OBJ_CLASS_DEF(OR_RP_3, 1ULL),
230 OC_RP_3G2 = OBJ_CLASS_DEF(OR_RP_3, 2ULL),
231 OC_RP_3G4 = OBJ_CLASS_DEF(OR_RP_3, 4ULL),
232 OC_RP_3G6 = OBJ_CLASS_DEF(OR_RP_3, 6ULL),
233 OC_RP_3G8 = OBJ_CLASS_DEF(OR_RP_3, 8ULL),
234 OC_RP_3G12 = OBJ_CLASS_DEF(OR_RP_3, 12ULL),
235 OC_RP_3G16 = OBJ_CLASS_DEF(OR_RP_3, 16ULL),
236 OC_RP_3G32 = OBJ_CLASS_DEF(OR_RP_3, 32ULL),
237 OC_RP_3GX = OBJ_CLASS_DEF(OR_RP_3, MAX_NUM_GROUPS),
238
240 OC_RP_4G1 = OBJ_CLASS_DEF(OR_RP_4, 1ULL),
241 OC_RP_4G2 = OBJ_CLASS_DEF(OR_RP_4, 2ULL),
242 OC_RP_4G4 = OBJ_CLASS_DEF(OR_RP_4, 4ULL),
243 OC_RP_4G6 = OBJ_CLASS_DEF(OR_RP_4, 6ULL),
244 OC_RP_4G8 = OBJ_CLASS_DEF(OR_RP_4, 8ULL),
245 OC_RP_4G12 = OBJ_CLASS_DEF(OR_RP_4, 12ULL),
246 OC_RP_4G16 = OBJ_CLASS_DEF(OR_RP_4, 16ULL),
247 OC_RP_4G32 = OBJ_CLASS_DEF(OR_RP_4, 32ULL),
248 OC_RP_4GX = OBJ_CLASS_DEF(OR_RP_4, MAX_NUM_GROUPS),
249
251 OC_RP_5G1 = OBJ_CLASS_DEF(OR_RP_5, 1ULL),
252 OC_RP_5G2 = OBJ_CLASS_DEF(OR_RP_5, 2ULL),
253 OC_RP_5G4 = OBJ_CLASS_DEF(OR_RP_5, 4ULL),
254 OC_RP_5G6 = OBJ_CLASS_DEF(OR_RP_5, 6ULL),
255 OC_RP_5G8 = OBJ_CLASS_DEF(OR_RP_5, 8ULL),
256 OC_RP_5G12 = OBJ_CLASS_DEF(OR_RP_5, 12ULL),
257 OC_RP_5G16 = OBJ_CLASS_DEF(OR_RP_5, 16ULL),
258 OC_RP_5G32 = OBJ_CLASS_DEF(OR_RP_5, 32ULL),
259 OC_RP_5GX = OBJ_CLASS_DEF(OR_RP_5, MAX_NUM_GROUPS),
260
262 OC_RP_6G1 = OBJ_CLASS_DEF(OR_RP_6, 1ULL),
263 OC_RP_6G2 = OBJ_CLASS_DEF(OR_RP_6, 2ULL),
264 OC_RP_6G4 = OBJ_CLASS_DEF(OR_RP_6, 4ULL),
265 OC_RP_6G6 = OBJ_CLASS_DEF(OR_RP_6, 6ULL),
266 OC_RP_6G8 = OBJ_CLASS_DEF(OR_RP_6, 8ULL),
267 OC_RP_6G12 = OBJ_CLASS_DEF(OR_RP_6, 12ULL),
268 OC_RP_6G16 = OBJ_CLASS_DEF(OR_RP_6, 16ULL),
269 OC_RP_6G32 = OBJ_CLASS_DEF(OR_RP_6, 32ULL),
270 OC_RP_6GX = OBJ_CLASS_DEF(OR_RP_6, MAX_NUM_GROUPS),
271
272 /* OC_XSF will map to one of these */
273 OC_RP_12G1 = OBJ_CLASS_DEF(OR_RP_12, 1ULL),
274 OC_RP_16G1 = OBJ_CLASS_DEF(OR_RP_16, 1ULL),
275 OC_RP_24G1 = OBJ_CLASS_DEF(OR_RP_24, 1ULL),
276 OC_RP_32G1 = OBJ_CLASS_DEF(OR_RP_32, 1ULL),
277 OC_RP_48G1 = OBJ_CLASS_DEF(OR_RP_48, 1ULL),
278 OC_RP_64G1 = OBJ_CLASS_DEF(OR_RP_64, 1ULL),
279 OC_RP_128G1 = OBJ_CLASS_DEF(OR_RP_128, 1ULL),
280
294 OC_EC_2P1G1 = OBJ_CLASS_DEF(OR_RS_2P1, 1ULL),
295 OC_EC_2P1G2 = OBJ_CLASS_DEF(OR_RS_2P1, 2ULL),
296 OC_EC_2P1G4 = OBJ_CLASS_DEF(OR_RS_2P1, 4ULL),
297 OC_EC_2P1G6 = OBJ_CLASS_DEF(OR_RS_2P1, 6ULL),
298 OC_EC_2P1G8 = OBJ_CLASS_DEF(OR_RS_2P1, 8ULL),
299 OC_EC_2P1G12 = OBJ_CLASS_DEF(OR_RS_2P1, 12ULL),
300 OC_EC_2P1G16 = OBJ_CLASS_DEF(OR_RS_2P1, 16ULL),
301 OC_EC_2P1G32 = OBJ_CLASS_DEF(OR_RS_2P1, 32ULL),
302 OC_EC_2P1GX = OBJ_CLASS_DEF(OR_RS_2P1, MAX_NUM_GROUPS),
303
305 OC_EC_2P2G1 = OBJ_CLASS_DEF(OR_RS_2P2, 1ULL),
306 OC_EC_2P2G2 = OBJ_CLASS_DEF(OR_RS_2P2, 2ULL),
307 OC_EC_2P2G4 = OBJ_CLASS_DEF(OR_RS_2P2, 4ULL),
308 OC_EC_2P2G6 = OBJ_CLASS_DEF(OR_RS_2P2, 6ULL),
309 OC_EC_2P2G8 = OBJ_CLASS_DEF(OR_RS_2P2, 8ULL),
310 OC_EC_2P2G12 = OBJ_CLASS_DEF(OR_RS_2P2, 12ULL),
311 OC_EC_2P2G16 = OBJ_CLASS_DEF(OR_RS_2P2, 16ULL),
312 OC_EC_2P2G32 = OBJ_CLASS_DEF(OR_RS_2P2, 32ULL),
313 OC_EC_2P2GX = OBJ_CLASS_DEF(OR_RS_2P2, MAX_NUM_GROUPS),
314
316 OC_EC_4P1G1 = OBJ_CLASS_DEF(OR_RS_4P1, 1ULL),
317 OC_EC_4P1G2 = OBJ_CLASS_DEF(OR_RS_4P1, 2ULL),
318 OC_EC_4P1G4 = OBJ_CLASS_DEF(OR_RS_4P1, 4ULL),
319 OC_EC_4P1G6 = OBJ_CLASS_DEF(OR_RS_4P1, 6ULL),
320 OC_EC_4P1G8 = OBJ_CLASS_DEF(OR_RS_4P1, 8ULL),
321 OC_EC_4P1G12 = OBJ_CLASS_DEF(OR_RS_4P1, 12ULL),
322 OC_EC_4P1G16 = OBJ_CLASS_DEF(OR_RS_4P1, 16ULL),
323 OC_EC_4P1G32 = OBJ_CLASS_DEF(OR_RS_4P1, 32ULL),
324 OC_EC_4P1GX = OBJ_CLASS_DEF(OR_RS_4P1, MAX_NUM_GROUPS),
325
327 OC_EC_4P2G1 = OBJ_CLASS_DEF(OR_RS_4P2, 1ULL),
328 OC_EC_4P2G2 = OBJ_CLASS_DEF(OR_RS_4P2, 2ULL),
329 OC_EC_4P2G4 = OBJ_CLASS_DEF(OR_RS_4P2, 4ULL),
330 OC_EC_4P2G6 = OBJ_CLASS_DEF(OR_RS_4P2, 6ULL),
331 OC_EC_4P2G8 = OBJ_CLASS_DEF(OR_RS_4P2, 8ULL),
332 OC_EC_4P2G12 = OBJ_CLASS_DEF(OR_RS_4P2, 12ULL),
333 OC_EC_4P2G16 = OBJ_CLASS_DEF(OR_RS_4P2, 16ULL),
334 OC_EC_4P2G32 = OBJ_CLASS_DEF(OR_RS_4P2, 32ULL),
335 OC_EC_4P2GX = OBJ_CLASS_DEF(OR_RS_4P2, MAX_NUM_GROUPS),
336
338 OC_EC_8P1G1 = OBJ_CLASS_DEF(OR_RS_8P1, 1ULL),
339 OC_EC_8P1G2 = OBJ_CLASS_DEF(OR_RS_8P1, 2ULL),
340 OC_EC_8P1G4 = OBJ_CLASS_DEF(OR_RS_8P1, 4ULL),
341 OC_EC_8P1G6 = OBJ_CLASS_DEF(OR_RS_8P1, 6ULL),
342 OC_EC_8P1G8 = OBJ_CLASS_DEF(OR_RS_8P1, 8ULL),
343 OC_EC_8P1G12 = OBJ_CLASS_DEF(OR_RS_8P1, 12ULL),
344 OC_EC_8P1G16 = OBJ_CLASS_DEF(OR_RS_8P1, 16ULL),
345 OC_EC_8P1G32 = OBJ_CLASS_DEF(OR_RS_8P1, 32ULL),
346 OC_EC_8P1GX = OBJ_CLASS_DEF(OR_RS_8P1, MAX_NUM_GROUPS),
347
349 OC_EC_8P2G1 = OBJ_CLASS_DEF(OR_RS_8P2, 1ULL),
350 OC_EC_8P2G2 = OBJ_CLASS_DEF(OR_RS_8P2, 2ULL),
351 OC_EC_8P2G4 = OBJ_CLASS_DEF(OR_RS_8P2, 4ULL),
352 OC_EC_8P2G6 = OBJ_CLASS_DEF(OR_RS_8P2, 6ULL),
353 OC_EC_8P2G8 = OBJ_CLASS_DEF(OR_RS_8P2, 8ULL),
354 OC_EC_8P2G12 = OBJ_CLASS_DEF(OR_RS_8P2, 12ULL),
355 OC_EC_8P2G16 = OBJ_CLASS_DEF(OR_RS_8P2, 16ULL),
356 OC_EC_8P2G32 = OBJ_CLASS_DEF(OR_RS_8P2, 32ULL),
357 OC_EC_8P2GX = OBJ_CLASS_DEF(OR_RS_8P2, MAX_NUM_GROUPS),
358
360 OC_EC_16P1G1 = OBJ_CLASS_DEF(OR_RS_16P1, 1ULL),
361 OC_EC_16P1G2 = OBJ_CLASS_DEF(OR_RS_16P1, 2ULL),
362 OC_EC_16P1G4 = OBJ_CLASS_DEF(OR_RS_16P1, 4ULL),
363 OC_EC_16P1G6 = OBJ_CLASS_DEF(OR_RS_16P1, 6ULL),
364 OC_EC_16P1G8 = OBJ_CLASS_DEF(OR_RS_16P1, 8ULL),
365 OC_EC_16P1G12 = OBJ_CLASS_DEF(OR_RS_16P1, 12ULL),
366 OC_EC_16P1G16 = OBJ_CLASS_DEF(OR_RS_16P1, 16ULL),
367 OC_EC_16P1G32 = OBJ_CLASS_DEF(OR_RS_16P1, 32ULL),
368 OC_EC_16P1GX = OBJ_CLASS_DEF(OR_RS_16P1, MAX_NUM_GROUPS),
369
371 OC_EC_16P2G1 = OBJ_CLASS_DEF(OR_RS_16P2, 1ULL),
372 OC_EC_16P2G2 = OBJ_CLASS_DEF(OR_RS_16P2, 2ULL),
373 OC_EC_16P2G4 = OBJ_CLASS_DEF(OR_RS_16P2, 4ULL),
374 OC_EC_16P2G6 = OBJ_CLASS_DEF(OR_RS_16P2, 6ULL),
375 OC_EC_16P2G8 = OBJ_CLASS_DEF(OR_RS_16P2, 8ULL),
376 OC_EC_16P2G12 = OBJ_CLASS_DEF(OR_RS_16P2, 12ULL),
377 OC_EC_16P2G16 = OBJ_CLASS_DEF(OR_RS_16P2, 16ULL),
378 OC_EC_16P2G32 = OBJ_CLASS_DEF(OR_RS_16P2, 32ULL),
379 OC_EC_16P2GX = OBJ_CLASS_DEF(OR_RS_16P2, MAX_NUM_GROUPS),
380
382 OC_RESERVED = 1 << 30,
383
384};
385
386enum daos_obj_schema {
387 DAOS_OS_SINGLE,
388 DAOS_OS_STRIPED,
389 DAOS_OS_DYN_STRIPED,
390 DAOS_OS_DYN_CHUNKED,
391};
392
393enum daos_obj_resil {
394 DAOS_RES_EC,
395 DAOS_RES_REPL,
396};
397
401 enum daos_obj_schema ca_schema;
403 enum daos_obj_resil ca_resil;
405 unsigned int ca_resil_degree;
407 unsigned int ca_grp_nr;
408 union {
410 struct daos_rp_attr {
412 unsigned int r_proto;
414 unsigned int r_num;
415 } rp;
416
418 struct daos_ec_attr {
420 unsigned short e_k;
422 unsigned short e_p;
424 unsigned int e_len;
425 } ec;
426 } u;
428};
429
431typedef uint32_t daos_oclass_id_t;
433typedef uint16_t daos_oclass_hints_t;
434
438 uint32_t cl_nr;
440 uint32_t cl_nr_out;
442 daos_oclass_id_t *cl_cids;
445};
446
454int
455daos_oclass_name2id(const char *name);
456
465size_t
466daos_oclass_names_list(size_t size, char *str);
467
476int
477daos_oclass_nr(int opts);
478
488int
489daos_oclass_id2name(daos_oclass_id_t oc_id, char *name);
490
510int
511daos_obj_register_class(daos_handle_t coh, daos_oclass_id_t cid,
512 struct daos_oclass_attr *attr, daos_event_t *ev);
513
531int
532daos_obj_query_class(daos_handle_t coh, daos_oclass_id_t cid,
533 struct daos_oclass_attr *attr, daos_event_t *ev);
534
554int
555daos_obj_list_class(daos_handle_t coh, struct daos_oclass_list *list,
556 daos_anchor_t *anchor, daos_event_t *ev);
557
558#if defined(__cplusplus)
559}
560#endif
561
562#endif /* __DAOS_OBJ_CLASS_H__ */
enum daos_obj_schema ca_schema
unsigned int ca_grp_nr
unsigned int r_num
unsigned short e_p
enum daos_obj_resil ca_resil
unsigned short e_k
unsigned int ca_resil_degree
unsigned int e_len
unsigned int r_proto
struct daos_oclass_attr * cl_cattrs
daos_oclass_id_t * cl_cids