1PMEM2_CONFIG_SET_REQUIRED_STPOMRDEK_GPPRrMAoENgMUr2La_AmCRmOIeNTrFY'I(sG3_)MSaEnTu_aRlEQUIRED_STORE_GRANULARITY(3)
2
3
4

NAME

6       pmem2_config_set_required_store_granularity()  -  set  a granularity in
7       pmem2_config structure.
8

SYNOPSIS

10              #include <libpmem2.h>
11
12              enum pmem2_granularity {
13                  PMEM2_GRANULARITY_BYTE,
14                  PMEM2_GRANULARITY_CACHE_LINE,
15                  PMEM2_GRANULARITY_PAGE,
16              };
17              int pmem2_config_set_required_store_granularity(struct pmem2_config *cfg,
18                      enum pmem2_granularity g);
19

DESCRIPTION

21       The pmem2_config_set_required_store_granularity() sets a  maximum  per‐
22       mitted granularity g requested by user in the pmem2_config structure.
23
24       Granularity must be one of the following values:
25
26       • PMEM2_GRANULARITY_BYTE
27
28       • PMEM2_GRANULARITY_CACHE_LINE
29
30       • PMEM2_GRANULARITY_PAGE
31
32       A  description  of  the granularity concept can be found in libpmem2(7)
33       manpage.
34

RETURN VALUE

36       The pmem2_config_set_required_store_granularity() function returns 0 on
37       success or a negative error code on failure.
38

ERRORS

40       The  pmem2_config_set_required_store_granularity()  can  fail  with the
41       following errors:
42
43       • PMEM2_E_GRANULARITY_NOT_SUPPORTED - granularity g is not a valid val‐
44         ue.
45

SEE ALSO

47       pmem2_config_new(3), libpmem2(7) and <https://pmem.io>
48
49
50
51PMDK - pmem2 API version 1.0    PM2E0M221_-C0O9N-F2I4G_SET_REQUIRED_STORE_GRANULARITY(3)
Impressum