pmempool(1)

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

NAME

6       pmempool - Persistent Memory Pool Management Tool
7

SYNOPSIS

9              $ pmempool [--help] [--version] <command> [<args>]
10

DESCRIPTION

12       The pmempool is a management tool for Persistent Memory pool files cre‐
13       ated by PMDK libraries.
14
15       The main purpose of pmempool is to provide a user with a set of  utili‐
16       ties  for  off-line  analysis and manipulation of pools created by pmem
17       libraries.  The pmempool is a generic command which consists of subcom‐
18       mands  for specific purposes.  Some of subcommands are required to work
19       without any impact on processed pool, but some of them may create a new
20       or modify an existing one.
21
22       The pmempool may be useful for troubleshooting by system administrators
23       and for software developers who work on  applications  based  on  PMDK.
24       The  latter  may find these tools useful for testing and debugging pur‐
25       poses also.
26

OPTIONS

28       -V, --version
29
30       Prints the version of pmempool.
31
32       -h, --help
33
34       Prints synopsis and list of commands.
35

COMMANDS

37       Currently there is a following set of commands available:
38
39       • pmempool-info(1) - Prints information and statistics  in  human-read‐
40         able format about specified pool.
41
42       • pmempool-check(1)  - Checks pool's consistency and repairs pool if it
43         is not consistent.
44
45       • pmempool-create(1) - Creates a pool of specified type with additional
46         properties specific for this type of pool.
47
48       • pmempool-dump(1)  - Dumps usable data from pool in hexadecimal or bi‐
49         nary format.
50
51       • pmempool-rm(1) - Removes pool file or all pool files listed  in  pool
52         set configuration file.
53
54       • pmempool-convert(1) - Updates the pool to the latest available layout
55         version.
56
57       • pmempool-sync(1) - Synchronizes replicas within a poolset.
58
59       • pmempool-transform(1) - Modifies internal structure of a poolset.
60
61       • pmempool-feature(1) - Toggle or query a poolset features.
62
63       In order to get more information about specific  command  you  can  use
64       pmempool help .
65

DEBUGGING

67       The  debug  logs  are  available only in the debug version of the tool,
68       which is not provided  by  binary  packages,  but  can  be  built  from
69       sources.   The  pmempool.static-debug  binary  blob can be found in the
70       `src/tools/pmempool/' subdirectory.
71
72       • PMEMPOOL_TOOL_LOG_LEVEL
73
74       The value of PMEMPOOL_TOOL_LOG_LEVEL enables trace points in the  debug
75       version of the tool, as follows:
76
77       • 0  -  This  is  the default level when PMEMPOOL_TOOL_LOG_LEVEL is not
78         set.  No log messages are emitted at this level.
79
80       • 1 - Additional details on any errors detected are logged (in addition
81         to returning the errno-based errors as usual).
82
83       • 2 - A trace of basic operations is logged.
84
85       • 3  -  Enables  a  very verbose amount of function call tracing in the
86         tool.
87
88       • 4 - Enables voluminous and fairly obscure tracing information that is
89         likely only useful to the pmempool developers.
90
91       Unless  PMEMPOOL_TOOL_LOG_FILE  is  set, debugging output is written to
92       stderr.
93
94       • PMEMPOOL_TOOL_LOG_FILE
95
96       Specifies the name of a file where all logging  information  should  be
97       written.  If the last character in the name is “-”, the PID of the cur‐
98       rent process will be appended to the file name when  the  log  file  is
99       created.   If  PMEMPOOL_TOOL_LOG_FILE  is not set, output is written to
100       stderr.
101

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

COMMANDS

DEBUGGING

SEE ALSO