pmempool(1)

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

NAME

6       pmempool - Persistent Memory Pool Management Tool
7
8              NOTE:  Support  for  Windows  and  FreeBSD deprecated since PMDK
9              1.13.0 release and will be removed in the PMDK 1.14.0 release.
10

SYNOPSIS

12              $ pmempool [--help] [--version] <command> [<args>]
13

NOTE

15              NOTICE: The libpmemblk and libpmemlog libraries  are  deprecated
16              since PMDK 1.13.0 release.
17

DESCRIPTION

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

OPTIONS

35       -V, --version
36
37       Prints the version of pmempool.
38
39       -h, --help
40
41       Prints synopsis and list of commands.
42

COMMANDS

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

DEBUGGING

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