11#ifndef __DAOS_PROP_H__
12#define __DAOS_PROP_H__
14#if defined(__cplusplus)
19#include <daos_types.h>
43 DAOS_PROP_PO_SPACE_RB,
49 DAOS_PROP_PO_SELF_HEAL,
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,
97 DAOS_PROP_PO_GLOBAL_VERSION,
101 DAOS_PROP_PO_UPGRADE_STATUS,
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,
146#define DAOS_PROP_PO_EC_CELL_SZ_MIN (1UL << 10)
147#define DAOS_PROP_PO_EC_CELL_SZ_MAX (1UL << 30)
149#define DAOS_PROP_PO_REDUN_FAC_MAX 4
150#define DAOS_PROP_PO_REDUN_FAC_DEFAULT 0
153daos_rf_is_valid(
unsigned long long rf)
155 return rf <= DAOS_PROP_PO_REDUN_FAC_MAX;
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)
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,
180#define DAOS_PROP_PO_SVC_REDUN_FAC_MAX 4
181#define DAOS_PROP_PO_SVC_REDUN_FAC_DEFAULT 2
184daos_svc_rf_is_valid(uint64_t svc_rf)
186 return svc_rf <= DAOS_PROP_PO_SVC_REDUN_FAC_MAX;
193 DAOS_PROP_PERF_DOMAIN_ROOT = 255,
194 DAOS_PROP_PERF_DOMAIN_GROUP = 200,
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
206#define DAOS_PROP_PO_NUM (DAOS_PROP_PO_MAX - DAOS_PROP_PO_MIN - 1)
210 DAOS_RECLAIM_DISABLED = 0,
212 DAOS_RECLAIM_SNAPSHOT,
218 DAOS_REINT_MODE_DATA_SYNC = 0,
219 DAOS_REINT_MODE_NO_DATA_SYNC = 1,
220 DAOS_REINT_MODE_INCREMENTAL = 2,
226#define DAOS_PROP_PO_REINT_MODE_DEFAULT DAOS_REINT_MODE_DATA_SYNC
233 DAOS_SCRUB_MODE_OFF = 0,
234 DAOS_SCRUB_MODE_LAZY = 1,
235 DAOS_SCRUB_MODE_TIMED = 2,
236 DAOS_SCRUB_MODE_INVALID = 3,
240#define DAOS_PROP_PO_SCRUB_MODE_DEFAULT DAOS_SCRUB_MODE_OFF
242#define DAOS_PROP_PO_SCRUB_FREQ_DEFAULT 604800
243#define DAOS_PROP_PO_SCRUB_THRESH_DEFAULT 0
247 DAOS_CHECKPOINT_DISABLED = 0,
248 DAOS_CHECKPOINT_TIMED,
249 DAOS_CHECKPOINT_LAZY,
252#define DAOS_PROP_PO_CHECKPOINT_MODE_DEFAULT DAOS_CHECKPOINT_TIMED
253#define DAOS_PROP_PO_CHECKPOINT_FREQ_DEFAULT 5
254#define DAOS_PROP_PO_CHECKPOINT_FREQ_MIN 1
255#define DAOS_PROP_PO_CHECKPOINT_FREQ_MAX (1 << 20)
256#define DAOS_PROP_PO_CHECKPOINT_THRESH_DEFAULT 50
257#define DAOS_PROP_PO_CHECKPOINT_THRESH_MAX 75
258#define DAOS_PROP_PO_CHECKPOINT_THRESH_MIN 10
259#define DAOS_PROP_PO_SVC_OPS_ENABLED_DEFAULT 1
260#define DAOS_PROP_PO_SVC_OPS_ENTRY_AGE_DEFAULT 300
261#define DAOS_PROP_PO_SVC_OPS_ENTRY_AGE_MIN 60
262#define DAOS_PROP_PO_SVC_OPS_ENTRY_AGE_MAX 600
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)
273enum daos_cont_props {
274 DAOS_PROP_CO_MIN = 0x1000,
284 DAOS_PROP_CO_LAYOUT_TYPE,
289 DAOS_PROP_CO_LAYOUT_VER,
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,
332 DAOS_PROP_CO_COMPRESS,
342 DAOS_PROP_CO_ENCRYPT,
352 DAOS_PROP_CO_OWNER_GROUP,
364 DAOS_PROP_CO_DEDUP_THRESHOLD,
373 DAOS_PROP_CO_ALLOCED_OID,
375 DAOS_PROP_CO_EC_CELL_SZ,
381 DAOS_PROP_CO_GLOBAL_VERSION,
383 DAOS_PROP_CO_SCRUBBER_DISABLED,
385 DAOS_PROP_CO_OBJ_VERSION,
387 DAOS_PROP_CO_PERF_DOMAIN,
400#define DAOS_PROP_CO_NUM (DAOS_PROP_CO_MAX - DAOS_PROP_CO_MIN - 1)
402typedef uint16_t daos_cont_layout_t;
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
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
433 DAOS_PROP_CO_CSUM_SV_OFF,
434 DAOS_PROP_CO_CSUM_SV_ON
439 DAOS_PROP_CO_DEDUP_OFF,
440 DAOS_PROP_CO_DEDUP_MEMCMP,
441 DAOS_PROP_CO_DEDUP_HASH
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,
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
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,
482 DAOS_PROP_CO_REDUN_MIN = 1,
484 DAOS_PROP_CO_REDUN_RANK = 1,
486 DAOS_PROP_CO_REDUN_NODE = 2,
488 DAOS_PROP_CO_REDUN_FAULT = 3,
489 DAOS_PROP_CO_REDUN_MAX = 254,
493#define DAOS_PROP_CO_REDUN_DEFAULT DAOS_PROP_CO_REDUN_NODE
498 DAOS_PROP_CO_HEALTHY,
504 DAOS_PROP_CO_UNCLEAN,
508#define DAOS_PROP_CO_CLEAR (0x1)
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)))
525static inline uint64_t
528 return DAOS_PROP_CO_STATUS_VAL(co_status->
dcs_status,
534daos_prop_val_2_co_status(uint64_t val,
struct daos_co_status *co_status)
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);
542 DAOS_PROP_ENTRY_NOT_SET = (1 << 0),
565#define DAOS_PROP_ENTRIES_MAX_NR (128)
568#define DAOS_PROP_LABEL_MAX_LEN (127)
570#define DAOS_PROP_MAX_LABEL_BUF_LEN (DAOS_PROP_LABEL_MAX_LEN + 1)
573#define DAOS_PROP_CO_LABEL_DEFAULT "container_label_not_set"
574#define DAOS_PROP_PO_LABEL_DEFAULT "pool_label_not_set"
588daos_label_is_valid(
const char *label)
592 bool maybe_uuid =
false;
599 len = strnlen(label, DAOS_PROP_LABEL_MAX_LEN + 1);
600 if (len == 0 || len > DAOS_PROP_LABEL_MAX_LEN)
604 for (i = 0; i < len; i++) {
607 if (isalnum(c) || c ==
'.' || c ==
'_' || c ==
':')
618 if (maybe_uuid && daos_is_valid_uuid_string(label))
625#define DAOS_PROP_PO_DATA_THRESH_DEFAULT (1UL << 12)
628#define DAOS_PROP_NO_PO_LABEL "pool_label_not_set"
631#define DEFAULT_CONT_LABEL "container_label_not_set"
634#define DAOS_PROP_NO_CO_LABEL DEFAULT_CONT_LABEL
641daos_perf_domain_is_valid(
const char *perf_domain)
643 return daos_label_is_valid(perf_domain);
664daos_prop_alloc(uint32_t entries_nr);
696daos_prop_from_str(
const char *str, daos_size_t len,
daos_prop_t **prop);
731daos_prop_entry_get(
daos_prop_t *prop, uint32_t type);
746daos_prop_set_str(
daos_prop_t *prop, uint32_t type,
const char *str, daos_size_t len);
757daos_prop_entry_set_str(
struct daos_prop_entry *entry,
const char *str, daos_size_t len);
772daos_prop_set_ptr(
daos_prop_t *prop, uint32_t type,
const void *ptr, daos_size_t size);
783daos_prop_entry_set_ptr(
struct daos_prop_entry *entry,
const void *ptr, daos_size_t size);
860 if (entry->
dpe_flags & DAOS_PROP_ENTRY_NOT_SET)
866#if defined(__cplusplus)
struct daos_prop_entry * dpp_entries