DAOS API (v2.1 - dev)
Loading...
Searching...
No Matches
daos_prop.h
1
11#ifndef __DAOS_PROP_H__
12#define __DAOS_PROP_H__
13
14#if defined(__cplusplus)
15extern "C" {
16#endif
17
18#include <ctype.h>
19#include <daos_types.h>
20
25enum daos_pool_props {
26 DAOS_PROP_PO_MIN = 0,
31 DAOS_PROP_PO_LABEL,
38 DAOS_PROP_PO_ACL,
43 DAOS_PROP_PO_SPACE_RB,
49 DAOS_PROP_PO_SELF_HEAL,
56 DAOS_PROP_PO_RECLAIM,
61 DAOS_PROP_PO_OWNER,
66 DAOS_PROP_PO_OWNER_GROUP,
70 DAOS_PROP_PO_SVC_LIST,
74 DAOS_PROP_PO_EC_CELL_SZ,
78 DAOS_PROP_PO_DATA_THRESH,
82 DAOS_PROP_PO_REDUN_FAC,
86 DAOS_PROP_PO_EC_PDA,
91 DAOS_PROP_PO_RP_PDA,
92
97 DAOS_PROP_PO_GLOBAL_VERSION,
101 DAOS_PROP_PO_UPGRADE_STATUS,
102 /*
103 * Schedule that the checksum scrubber will run. See
104 * DAOS_SCRUBBER_SCHED_*
105 *
106 * default: DAOS_SCRUB_MODE_OFF
107 */
108 DAOS_PROP_PO_SCRUB_MODE,
114 DAOS_PROP_PO_SCRUB_FREQ,
120 DAOS_PROP_PO_SCRUB_THRESH,
124 DAOS_PROP_PO_SVC_REDUN_FAC,
126 DAOS_PROP_PO_OBJ_VERSION,
130 DAOS_PROP_PO_PERF_DOMAIN,
132 DAOS_PROP_PO_CHECKPOINT_MODE,
134 DAOS_PROP_PO_CHECKPOINT_FREQ,
136 DAOS_PROP_PO_CHECKPOINT_THRESH,
138 DAOS_PROP_PO_REINT_MODE,
140 DAOS_PROP_PO_SVC_OPS_ENABLED,
142 DAOS_PROP_PO_SVC_OPS_ENTRY_AGE,
143 DAOS_PROP_PO_MAX,
144};
145
146#define DAOS_PROP_PO_EC_CELL_SZ_MIN (1UL << 10)
147#define DAOS_PROP_PO_EC_CELL_SZ_MAX (1UL << 30)
148
149#define DAOS_PROP_PO_REDUN_FAC_MAX 4
150#define DAOS_PROP_PO_REDUN_FAC_DEFAULT 0
151
152static inline bool
153daos_rf_is_valid(unsigned long long rf)
154{
155 return rf <= DAOS_PROP_PO_REDUN_FAC_MAX;
156}
157
158#define DAOS_PROP_PDA_MAX ((uint32_t)-1)
165#define DAOS_PROP_PO_RP_PDA_DEFAULT DAOS_PROP_PDA_MAX
170#define DAOS_PROP_PO_EC_PDA_DEFAULT ((uint32_t)1)
171
173enum {
174 DAOS_UPGRADE_STATUS_NOT_STARTED = 0,
175 DAOS_UPGRADE_STATUS_IN_PROGRESS = 1,
176 DAOS_UPGRADE_STATUS_COMPLETED = 2,
177 DAOS_UPGRADE_STATUS_FAILED = 3,
178};
179
180#define DAOS_PROP_PO_SVC_REDUN_FAC_MAX 4
181#define DAOS_PROP_PO_SVC_REDUN_FAC_DEFAULT 2
182
183static inline bool
184daos_svc_rf_is_valid(uint64_t svc_rf)
185{
186 return svc_rf <= DAOS_PROP_PO_SVC_REDUN_FAC_MAX;
187}
188
192enum {
193 DAOS_PROP_PERF_DOMAIN_ROOT = 255,
194 DAOS_PROP_PERF_DOMAIN_GROUP = 200,
195};
196
200#define DAOS_PROP_PO_PERF_DOMAIN_DEFAULT DAOS_PROP_PERF_DOMAIN_ROOT
201#define DAOS_PROP_CO_PERF_DOMAIN_DEFAULT DAOS_PROP_PERF_DOMAIN_ROOT
202
206#define DAOS_PROP_PO_NUM (DAOS_PROP_PO_MAX - DAOS_PROP_PO_MIN - 1)
207
209enum {
210 DAOS_RECLAIM_DISABLED = 0,
211 DAOS_RECLAIM_LAZY,
212 DAOS_RECLAIM_SNAPSHOT,
213 DAOS_RECLAIM_BATCH,
214 DAOS_RECLAIM_TIME,
215};
216
217enum {
218 DAOS_REINT_MODE_DATA_SYNC = 0,
219 DAOS_REINT_MODE_NO_DATA_SYNC = 1,
220 DAOS_REINT_MODE_INCREMENTAL = 2,
221};
222
226#define DAOS_PROP_PO_REINT_MODE_DEFAULT DAOS_REINT_MODE_DATA_SYNC
227
232enum {
233 DAOS_SCRUB_MODE_OFF = 0,
234 DAOS_SCRUB_MODE_LAZY = 1,
235 DAOS_SCRUB_MODE_TIMED = 2,
236 DAOS_SCRUB_MODE_INVALID = 3,
237};
238
239/* Checksum Scrubbing Defaults */
240#define DAOS_PROP_PO_SCRUB_MODE_DEFAULT DAOS_SCRUB_MODE_OFF
241
242#define DAOS_PROP_PO_SCRUB_FREQ_DEFAULT 604800 /* 1 week in seconds */
243#define DAOS_PROP_PO_SCRUB_THRESH_DEFAULT 0
244
246enum {
247 DAOS_CHECKPOINT_DISABLED = 0,
248 DAOS_CHECKPOINT_TIMED,
249 DAOS_CHECKPOINT_LAZY,
250};
251
252#define DAOS_PROP_PO_CHECKPOINT_MODE_DEFAULT DAOS_CHECKPOINT_TIMED
253#define DAOS_PROP_PO_CHECKPOINT_FREQ_DEFAULT 5 /* 5 seconds */
254#define DAOS_PROP_PO_CHECKPOINT_FREQ_MIN 1 /* 1 seconds */
255#define DAOS_PROP_PO_CHECKPOINT_FREQ_MAX (1 << 20) /* 1 million seconds */
256#define DAOS_PROP_PO_CHECKPOINT_THRESH_DEFAULT 50 /* 50 % WAL capacity */
257#define DAOS_PROP_PO_CHECKPOINT_THRESH_MAX 75 /* 75 % WAL capacity */
258#define DAOS_PROP_PO_CHECKPOINT_THRESH_MIN 10 /* 10 % WAL capacity */
259#define DAOS_PROP_PO_SVC_OPS_ENABLED_DEFAULT 1 /* true: enabled by default */
260#define DAOS_PROP_PO_SVC_OPS_ENTRY_AGE_DEFAULT 300 /* 300 seconds */
261#define DAOS_PROP_PO_SVC_OPS_ENTRY_AGE_MIN 60 /* 60 seconds */
262#define DAOS_PROP_PO_SVC_OPS_ENTRY_AGE_MAX 600 /* 600 seconds */
263
265#define DAOS_SELF_HEAL_AUTO_EXCLUDE (1U << 0)
266#define DAOS_SELF_HEAL_AUTO_REBUILD (1U << 1)
267#define DAOS_SELF_HEAL_DELAY_REBUILD (1U << 2)
268
273enum daos_cont_props {
274 DAOS_PROP_CO_MIN = 0x1000,
279 DAOS_PROP_CO_LABEL,
284 DAOS_PROP_CO_LAYOUT_TYPE,
289 DAOS_PROP_CO_LAYOUT_VER,
294 DAOS_PROP_CO_CSUM,
299 DAOS_PROP_CO_CSUM_CHUNK_SIZE,
304 DAOS_PROP_CO_CSUM_SERVER_VERIFY,
310 DAOS_PROP_CO_REDUN_FAC,
315 DAOS_PROP_CO_REDUN_LVL,
319 DAOS_PROP_CO_SNAPSHOT_MAX,
326 DAOS_PROP_CO_ACL,
332 DAOS_PROP_CO_COMPRESS,
342 DAOS_PROP_CO_ENCRYPT,
347 DAOS_PROP_CO_OWNER,
352 DAOS_PROP_CO_OWNER_GROUP,
359 DAOS_PROP_CO_DEDUP,
364 DAOS_PROP_CO_DEDUP_THRESHOLD,
366 DAOS_PROP_CO_ROOTS,
371 DAOS_PROP_CO_STATUS,
373 DAOS_PROP_CO_ALLOCED_OID,
375 DAOS_PROP_CO_EC_CELL_SZ,
377 DAOS_PROP_CO_EC_PDA,
379 DAOS_PROP_CO_RP_PDA,
381 DAOS_PROP_CO_GLOBAL_VERSION,
383 DAOS_PROP_CO_SCRUBBER_DISABLED,
385 DAOS_PROP_CO_OBJ_VERSION,
387 DAOS_PROP_CO_PERF_DOMAIN,
388 DAOS_PROP_CO_MAX,
389};
390
396
400#define DAOS_PROP_CO_NUM (DAOS_PROP_CO_MAX - DAOS_PROP_CO_MIN - 1)
401
402typedef uint16_t daos_cont_layout_t;
403
405enum {
406 DAOS_PROP_CO_LAYOUT_UNKNOWN,
407 DAOS_PROP_CO_LAYOUT_UNKOWN = DAOS_PROP_CO_LAYOUT_UNKNOWN,
408 DAOS_PROP_CO_LAYOUT_POSIX,
409 DAOS_PROP_CO_LAYOUT_HDF5,
410 DAOS_PROP_CO_LAYOUT_PYTHON,
411 DAOS_PROP_CO_LAYOUT_SPARK,
412 DAOS_PROP_CO_LAYOUT_DATABASE,
413 DAOS_PROP_CO_LAYOUT_ROOT,
414 DAOS_PROP_CO_LAYOUT_SEISMIC,
415 DAOS_PROP_CO_LAYOUT_METEO,
416 DAOS_PROP_CO_LAYOUT_MAX
417};
418
420enum {
421 DAOS_PROP_CO_CSUM_OFF,
422 DAOS_PROP_CO_CSUM_CRC16,
423 DAOS_PROP_CO_CSUM_CRC32,
424 DAOS_PROP_CO_CSUM_CRC64,
425 DAOS_PROP_CO_CSUM_SHA1,
426 DAOS_PROP_CO_CSUM_SHA256,
427 DAOS_PROP_CO_CSUM_SHA512,
428 DAOS_PROP_CO_CSUM_ADLER32
429};
430
432enum {
433 DAOS_PROP_CO_CSUM_SV_OFF,
434 DAOS_PROP_CO_CSUM_SV_ON
435};
436
438enum {
439 DAOS_PROP_CO_DEDUP_OFF,
440 DAOS_PROP_CO_DEDUP_MEMCMP,
441 DAOS_PROP_CO_DEDUP_HASH
442};
443
445enum {
446 DAOS_PROP_CO_COMPRESS_OFF,
447 DAOS_PROP_CO_COMPRESS_LZ4,
448 DAOS_PROP_CO_COMPRESS_DEFLATE,
449 DAOS_PROP_CO_COMPRESS_DEFLATE1,
450 DAOS_PROP_CO_COMPRESS_DEFLATE2,
451 DAOS_PROP_CO_COMPRESS_DEFLATE3,
452 DAOS_PROP_CO_COMPRESS_DEFLATE4,
453};
454
456enum {
457 DAOS_PROP_CO_ENCRYPT_OFF,
458 DAOS_PROP_CO_ENCRYPT_AES_XTS128,
459 DAOS_PROP_CO_ENCRYPT_AES_XTS256,
460 DAOS_PROP_CO_ENCRYPT_AES_CBC128,
461 DAOS_PROP_CO_ENCRYPT_AES_CBC192,
462 DAOS_PROP_CO_ENCRYPT_AES_CBC256,
463 DAOS_PROP_CO_ENCRYPT_AES_GCM128,
464 DAOS_PROP_CO_ENCRYPT_AES_GCM256
465};
466
468enum {
469 DAOS_PROP_CO_REDUN_RF0 = 0,
470 DAOS_PROP_CO_REDUN_RF1 = 1,
471 DAOS_PROP_CO_REDUN_RF2 = 2,
472 DAOS_PROP_CO_REDUN_RF3 = 3,
473 DAOS_PROP_CO_REDUN_RF4 = 4,
474 DAOS_RF_MAX = 4,
475};
476
481enum {
482 DAOS_PROP_CO_REDUN_MIN = 1,
483 /* server rank (engine) level */
484 DAOS_PROP_CO_REDUN_RANK = 1,
485 /* server node level */
486 DAOS_PROP_CO_REDUN_NODE = 2,
487 /* pool fault domain level */
488 DAOS_PROP_CO_REDUN_FAULT = 3,
489 DAOS_PROP_CO_REDUN_MAX = 254,
490};
491
493#define DAOS_PROP_CO_REDUN_DEFAULT DAOS_PROP_CO_REDUN_NODE
494
496enum {
497 /* in healthy status, data protection work as expected */
498 DAOS_PROP_CO_HEALTHY,
499 /* in unclean status, data protection possibly cannot work.
500 * typical scenario - cascading failed targets exceed the container
501 * redundancy factor, that possibly cause lost data cannot be detected
502 * or rebuilt.
503 */
504 DAOS_PROP_CO_UNCLEAN,
505};
506
508#define DAOS_PROP_CO_CLEAR (0x1)
509
513 uint16_t dcs_status;
515 uint16_t dcs_flags;
517 uint32_t dcs_pm_ver;
518};
519
520#define DAOS_PROP_CO_STATUS_VAL(status, flag, pm_ver) \
521 ((((uint64_t)(flag)) << 48) | \
522 (((uint64_t)(status) & 0xFFFF) << 32) | \
523 ((uint64_t)(pm_ver)))
524
525static inline uint64_t
526daos_prop_co_status_2_val(struct daos_co_status *co_status)
527{
528 return DAOS_PROP_CO_STATUS_VAL(co_status->dcs_status,
529 co_status->dcs_flags,
530 co_status->dcs_pm_ver);
531}
532
533static inline void
534daos_prop_val_2_co_status(uint64_t val, struct daos_co_status *co_status)
535{
536 co_status->dcs_flags = (uint16_t)(val >> 48);
537 co_status->dcs_status = (uint16_t)((val >> 32) & 0xFFFF);
538 co_status->dcs_pm_ver = (uint32_t)(val & 0xFFFFFFFF);
539}
540
541enum {
542 DAOS_PROP_ENTRY_NOT_SET = (1 << 0),
543};
544
548 uint32_t dpe_type;
550 uint16_t dpe_flags;
552 uint16_t dpe_reserv;
557 union {
558 uint64_t dpe_val;
559 d_string_t dpe_str;
560 void *dpe_val_ptr;
561 };
562};
563
565#define DAOS_PROP_ENTRIES_MAX_NR (128)
566
568#define DAOS_PROP_LABEL_MAX_LEN (127)
570#define DAOS_PROP_MAX_LABEL_BUF_LEN (DAOS_PROP_LABEL_MAX_LEN + 1)
571
573#define DAOS_PROP_CO_LABEL_DEFAULT "container_label_not_set"
574#define DAOS_PROP_PO_LABEL_DEFAULT "pool_label_not_set"
575
587static inline bool
588daos_label_is_valid(const char *label)
589{
590 int len;
591 int i;
592 bool maybe_uuid = false;
593
595 if (label == NULL)
596 return false;
597
599 len = strnlen(label, DAOS_PROP_LABEL_MAX_LEN + 1);
600 if (len == 0 || len > DAOS_PROP_LABEL_MAX_LEN)
601 return false;
602
604 for (i = 0; i < len; i++) {
605 char c = label[i];
606
607 if (isalnum(c) || c == '.' || c == '_' || c == ':')
608 continue;
609 if (c == '-') {
610 maybe_uuid = true;
611 continue;
612 }
613
614 return false;
615 }
616
618 if (maybe_uuid && daos_is_valid_uuid_string(label))
619 return false;
620
621 return true;
622}
623
624/* default data threshold size of 4KiB */
625#define DAOS_PROP_PO_DATA_THRESH_DEFAULT (1UL << 12)
626
627/* For the case of no label is set for the pool. */
628#define DAOS_PROP_NO_PO_LABEL "pool_label_not_set"
629
630/* Default container label */
631#define DEFAULT_CONT_LABEL "container_label_not_set"
632
633/* For the case of no label is set for the container. */
634#define DAOS_PROP_NO_CO_LABEL DEFAULT_CONT_LABEL
635
640static inline bool
641daos_perf_domain_is_valid(const char *perf_domain)
642{
643 return daos_label_is_valid(perf_domain);
644}
645
647typedef struct {
649 uint32_t dpp_nr;
651 uint32_t dpp_reserv;
655
664daos_prop_alloc(uint32_t entries_nr);
665
671void
672daos_prop_fini(daos_prop_t *prop);
673
679void
680daos_prop_free(daos_prop_t *prop);
681
695int
696daos_prop_from_str(const char *str, daos_size_t len, daos_prop_t **prop);
697
708int
709daos_prop_merge2(daos_prop_t *old_prop, daos_prop_t *new_prop, daos_prop_t **out_prop);
710
720daos_prop_merge(daos_prop_t *old_prop, daos_prop_t *new_prop);
721
730struct daos_prop_entry *
731daos_prop_entry_get(daos_prop_t *prop, uint32_t type);
732
745int
746daos_prop_set_str(daos_prop_t *prop, uint32_t type, const char *str, daos_size_t len);
747
756int
757daos_prop_entry_set_str(struct daos_prop_entry *entry, const char *str, daos_size_t len);
758
771int
772daos_prop_set_ptr(daos_prop_t *prop, uint32_t type, const void *ptr, daos_size_t size);
773
782int
783daos_prop_entry_set_ptr(struct daos_prop_entry *entry, const void *ptr, daos_size_t size);
784
796int
797daos_prop_entry_dup_ptr(struct daos_prop_entry *entry_dst,
798 struct daos_prop_entry *entry_src, size_t len);
799
809int
810daos_prop_entry_cmp_acl(struct daos_prop_entry *entry1,
811 struct daos_prop_entry *entry2);
812
823int
824daos_prop_entry_dup_co_roots(struct daos_prop_entry *dst,
825 struct daos_prop_entry *src);
826
835bool
836daos_prop_has_str(struct daos_prop_entry *entry);
837
846bool
847daos_prop_has_ptr(struct daos_prop_entry *entry);
848
857static inline bool
858daos_prop_is_set(struct daos_prop_entry *entry)
859{
860 if (entry->dpe_flags & DAOS_PROP_ENTRY_NOT_SET)
861 return false;
862
863 return true;
864}
865
866#if defined(__cplusplus)
867}
868#endif
869
870#endif /* __DAOS_PROP_H__ */
uint16_t dcs_status
Definition daos_prop.h:513
uint16_t dcs_flags
Definition daos_prop.h:515
uint32_t dcs_pm_ver
Definition daos_prop.h:517
daos_obj_id_t cr_oids[4]
Definition daos_prop.h:394
Definition daos_prop.h:546
uint16_t dpe_flags
Definition daos_prop.h:550
uint16_t dpe_reserv
Definition daos_prop.h:552
uint32_t dpe_type
Definition daos_prop.h:548
struct daos_prop_entry * dpp_entries
Definition daos_prop.h:653
uint32_t dpp_reserv
Definition daos_prop.h:651
uint32_t dpp_nr
Definition daos_prop.h:649