1()                         PMDK Programmer's Manual                         ()
2
3
4

NAME

6       pmempool-feature - toggle or query pool set features
7

SYNOPSIS

9              $ pmempool feature (-e|-d|-q feature-name) [options] <file>
10

DESCRIPTION

12       The  pmempool  feature  command  enables / disables or queries pool set
13       features.
14
15       Available pool feature-names are:
16
17       • SINGLEHDR - only the first part in each  replica  contains  the  pool
18         part internal metadata.  This value can be used only with -q.  It can
19         not be enabled or disabled.  For details see poolset(5).
20
21       • CHECKSUM_2K - only the first 2KiB of pool part internal  metadata  is
22         checksummed.   Other  features  may depend on this one to store addi‐
23         tional metadata in otherwise unused second 2KiB  part  of  a  header.
24         When CHECKSUM_2K is disabled whole 4KiB is checksummed.
25
26       • SHUTDOWN_STATE  - enables additional check performed during pool open
27         which verifies pool consistency in the presence  of  dirty  shutdown.
28         CHECKSUM_2K  has  to be enabled prior to SHUTDOWN_STATE otherwise en‐
29         abling SHUTDOWN_STATE will fail.
30
31       • CHECK_BAD_BLOCKS - enables checking bad blocks performed during open‐
32         ing  a  pool  and fixing bad blocks performed by pmempool-sync during
33         syncing a pool.  Currently (Linux kernel v4.19, libndctl v62)  check‐
34         ing  and  fixing  bad blocks require read access to the following re‐
35         source files (containing physical addresses) of NVDIMM devices  which
36         only root can read by default:
37
38         /sys/bus/nd/devices/ndbus*/region*/resource
39         /sys/bus/nd/devices/ndbus*/region*/dax*/resource
40         /sys/bus/nd/devices/ndbus*/region*/pfn*/resource
41         /sys/bus/nd/devices/ndbus*/region*/namespace*/resource
42
43       It is possible to use poolset as file argument.
44
45   Available options:
46       -h, --help
47
48       Print help message.
49
50       -v, --verbose
51
52       Increase verbosity level.
53
54       -e, --enable feature-name
55
56       Enable feature for pool set.
57
58       -d, --disable feature-name
59
60       Disable feature for pool set.
61
62       -q, --query feature-name
63
64       Print feature status.
65

COMPATIBILITY

67       Poolsets  with  features  not defined in this document (e.g. enabled by
68       the newer software version) are not supported.
69

DISCLAIMER

71       pmempool feature command is not fail safe.
72

EXAMPLE

74              $ pmempool feature --enable CHECKSUM_2K pool.set
75
76       Enables POOL_FEAT_CKSUM_2K incompat feature flag.
77
78              $ pmempool feature --disable CHECKSUM_2K pool.set
79
80       Disables POOL_FEAT_CKSUM_2K incompat feature flag.
81
82              $ pmempool feature --query CHECKSUM_2K pool.set
83              0
84
85       Prints POOL_FEAT_CKSUM_2K incompat feature flag value.
86

SEE ALSO

88       poolset(5) and <https://pmem.io>
89
90
91
92PMDK -                            2023-06-05                                ()
Impressum