.\" Automatically generated by Pandoc 2.10.1
.\"
.TH "PMEMPOOL-FEATURE" "1" "2020-10-28" "PMDK - pmem Tools version 1.4" "PMDK Programmer's Manual"
.hy
.\" SPDX-License-Identifier: BSD-3-Clause
.\" Copyright 2018, Intel Corporation
.SH NAME
.PP
\f[B]pmempool-feature\f[R] - toggle or query pool set features
.SH SYNOPSIS
.IP
.nf
\f[C]
$ pmempool feature (-e|-d|-q feature-name) [options] <file>
\f[R]
.fi
.SH DESCRIPTION
.PP
The \f[B]pmempool feature\f[R] command enables / disables or queries
pool set features.
.PP
Available pool \f[I]feature-names\f[R] are:
.IP \[bu] 2
\f[B]SINGLEHDR\f[R] - only the first part in each replica contains the
pool part internal metadata.
This value can be used only with \f[B]-q\f[R].
It can not be enabled or disabled.
For details see \f[B]poolset\f[R](5).
.IP \[bu] 2
\f[B]CHECKSUM_2K\f[R] - only the first 2KiB of pool part internal
metadata is checksummed.
Other features may depend on this one to store additional metadata in
otherwise unused second 2KiB part of a header.
When \f[B]CHECKSUM_2K\f[R] is disabled whole 4KiB is checksummed.
.IP \[bu] 2
\f[B]SHUTDOWN_STATE\f[R] - enables additional check performed during
pool open which verifies pool consistency in the presence of dirty
shutdown.
\f[B]CHECKSUM_2K\f[R] has to be enabled prior to
\f[B]SHUTDOWN_STATE\f[R] otherwise enabling \f[B]SHUTDOWN_STATE\f[R]
will fail.
.IP \[bu] 2
\f[B]CHECK_BAD_BLOCKS\f[R] - enables checking bad blocks performed
during opening a pool and fixing bad blocks performed by pmempool-sync
during syncing a pool.
Currently (Linux kernel v4.19, libndctl v62) checking and fixing bad
blocks require read access to the following resource files (containing
physical addresses) of NVDIMM devices which only root can read by
default:
.IP
.nf
\f[C]
/sys/bus/nd/devices/ndbus*/region*/resource
/sys/bus/nd/devices/ndbus*/region*/dax*/resource
/sys/bus/nd/devices/ndbus*/region*/pfn*/resource
/sys/bus/nd/devices/ndbus*/region*/namespace*/resource
\f[R]
.fi
.PP
It is possible to use poolset as \f[I]file\f[R] argument.
But poolsets with remote replicas are not supported.
.SS Available options:
.PP
\f[C]-h, --help\f[R]
.PP
Print help message.
.PP
\f[C]-v, --verbose\f[R]
.PP
Increase verbosity level.
.PP
\f[C]-e, --enable feature-name\f[R]
.PP
Enable feature for pool set.
.PP
\f[C]-d, --disable feature-name\f[R]
.PP
Disable feature for pool set.
.PP
\f[C]-q, --query feature-name\f[R]
.PP
Print feature status.
.SH COMPATIBILITY
.PP
Poolsets with features not defined in this document (e.g.\ enabled by
the newer software version) are not supported.
.SH DISCLAIMER
.PP
\f[C]pmempool feature\f[R] command is not fail safe.
.SH EXAMPLE
.IP
.nf
\f[C]
$ pmempool feature --enable CHECKSUM_2K pool.set
\f[R]
.fi
.PP
Enables POOL_FEAT_CKSUM_2K incompat feature flag.
.IP
.nf
\f[C]
$ pmempool feature --disable CHECKSUM_2K pool.set
\f[R]
.fi
.PP
Disables POOL_FEAT_CKSUM_2K incompat feature flag.
.IP
.nf
\f[C]
$ pmempool feature --query CHECKSUM_2K pool.set
0
\f[R]
.fi
.PP
Prints POOL_FEAT_CKSUM_2K incompat feature flag value.
.SH SEE ALSO
.PP
\f[B]poolset\f[R](5) and \f[B]<https://pmem.io>\f[R]