pmempool-create(1)

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

NAME

6       pmempool-create -- create a persistent memory pool
7

SYNOPSIS

9              $ pmempool create [<options>] [<type>] [<bsize>] <file>
10

DESCRIPTION

12       The  pmempool invoked with create command creates a pool file of speci‐
13       fied type.  Depending on a pool type it is  possible  to  provide  more
14       properties of pool.
15
16       Valid  pool types are: blk, log and obj which stands for pmemblk, pmem‐
17       log and pmemobj pools respectively.  By default the pool file is creat‐
18       ed  with  minimum  allowed  size  for specified pool type.  The minimum
19       sizes for blk, log and  obj  pool  types  are  PMEMBLK_MIN_POOL,  PMEM‐
20       LOG_MIN_POOL  and  PMEMOBJ_MIN_POOL  respectively.   See libpmemblk(7),
21       libpmemlog(7) and libpmemobj(7) for details.
22
23       For pmemblk pool type block size <bsize> is a required argument.
24
25       In order to set custom size of pool use -s option, or use -M option  to
26       create a pool of maximum available size on underlying file system.
27
28       The  size  argument  may  be passed in format that permits only the up‐
29       per-case character for byte - B as specified in IEC 80000-13, IEEE 1541
30       and  the  Metric  Interchange  Format.   Standards accept SI units with
31       obligatory B - kB, MB, GB, ...  which means multiplier by 1000 and  IEC
32       units  with  optional  "iB" - KiB, MiB, GiB, ..., K, M, G, ...  - which
33       means multiplier by 1024.
34
35   Available options:
36       -s, --size <size>
37
38       Size of pool file.
39
40       -M, --max-size
41
42       Set size of pool to available space of underlying file system.
43
44       -m, --mode <octal>
45
46       Set permissions to (the default is 0664) when creating the  files.   If
47       the file already exist the permissions are not changed.
48
49       -i, --inherit <file>
50
51       Create a new pool of the same size and other properties as <file>.
52
53       -f, --force
54
55       Remove the pool before creating.
56
57       -v, --verbose
58
59       Increase verbosity level.
60
61       -h, --help
62
63       Display help message and exit.
64
65   Options for PMEMBLK:
66       By default when creating a pmem blk pool, the BTT layout is not written
67       until the first write operation of block entry is performed.  Using  -w
68       option  you  can  force  writing the BTT layout by writing zero data to
69       specified block number.  By default the write operation is performed to
70       block number 0.  Please refer to libpmemblk(7) for details.
71
72       -w, --write-layout
73
74       Force  writing  the  BTT  layout by performing write operation to block
75       number zero.
76
77   Options for PMEMOBJ:
78       By default when creating a pmem obj pool, the layout name  provided  to
79       the  libpmemobj  library is an empty string.  Please refer to libpmemo‐
80       bj(7) for details.
81
82       -l, --layout <layout>
83
84       Layout name of the pmemobj pool.
85

EXAMPLE

87              $ pmempool create blk 512 pool.blk
88
89       Create a blk pool file of minimum allowed size and block size 512 bytes
90
91              $ pmempool create log -M pool.log
92
93       Create a log pool file of maximum allowed size
94
95              $ pmempool create blk --size=4G --write-layout 1K pool.blk
96
97       Create a blk pool file of size 4G, block size 1K and write the BTT lay‐
98       out
99
100              $ pmempool create --layout my_layout obj pool.obj
101
102       Create an obj pool file of minimum allowed size and layout "my_layout"
103
104              $ pmempool create --inherit=pool.log new_pool.log
105
106       Create a pool file based on pool.log file
107

NAME

SYNOPSIS

DESCRIPTION

EXAMPLE

SEE ALSO