Skip to content

Commit ade260c

Browse files
damien-lemoalaxboe
authored andcommitted
Documentation: admin-guide: blockdev: update zloop parameters
In Documentation/admin-guide/blockdev/zoned_loop.rst, add the description of the zone_append and ordered_zone_append configuration arguments of zloop "add" command (device creation). Signed-off-by: Damien Le Moal <dlemoal@kernel.org> Signed-off-by: Jens Axboe <axboe@kernel.dk>
1 parent fcc6eaa commit ade260c

1 file changed

Lines changed: 37 additions & 24 deletions

File tree

Documentation/admin-guide/blockdev/zoned_loop.rst

Lines changed: 37 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -68,30 +68,43 @@ The options available for the add command can be listed by reading the
6868
In more details, the options that can be used with the "add" command are as
6969
follows.
7070

71-
================ ===========================================================
72-
id Device number (the X in /dev/zloopX).
73-
Default: automatically assigned.
74-
capacity_mb Device total capacity in MiB. This is always rounded up to
75-
the nearest higher multiple of the zone size.
76-
Default: 16384 MiB (16 GiB).
77-
zone_size_mb Device zone size in MiB. Default: 256 MiB.
78-
zone_capacity_mb Device zone capacity (must always be equal to or lower than
79-
the zone size. Default: zone size.
80-
conv_zones Total number of conventioanl zones starting from sector 0.
81-
Default: 8.
82-
base_dir Path to the base directory where to create the directory
83-
containing the zone files of the device.
84-
Default=/var/local/zloop.
85-
The device directory containing the zone files is always
86-
named with the device ID. E.g. the default zone file
87-
directory for /dev/zloop0 is /var/local/zloop/0.
88-
nr_queues Number of I/O queues of the zoned block device. This value is
89-
always capped by the number of online CPUs
90-
Default: 1
91-
queue_depth Maximum I/O queue depth per I/O queue.
92-
Default: 64
93-
buffered_io Do buffered IOs instead of direct IOs (default: false)
94-
================ ===========================================================
71+
=================== =========================================================
72+
id Device number (the X in /dev/zloopX).
73+
Default: automatically assigned.
74+
capacity_mb Device total capacity in MiB. This is always rounded up
75+
to the nearest higher multiple of the zone size.
76+
Default: 16384 MiB (16 GiB).
77+
zone_size_mb Device zone size in MiB. Default: 256 MiB.
78+
zone_capacity_mb Device zone capacity (must always be equal to or lower
79+
than the zone size. Default: zone size.
80+
conv_zones Total number of conventioanl zones starting from
81+
sector 0
82+
Default: 8
83+
base_dir Path to the base directory where to create the directory
84+
containing the zone files of the device.
85+
Default=/var/local/zloop.
86+
The device directory containing the zone files is always
87+
named with the device ID. E.g. the default zone file
88+
directory for /dev/zloop0 is /var/local/zloop/0.
89+
nr_queues Number of I/O queues of the zoned block device. This
90+
value is always capped by the number of online CPUs
91+
Default: 1
92+
queue_depth Maximum I/O queue depth per I/O queue.
93+
Default: 64
94+
buffered_io Do buffered IOs instead of direct IOs (default: false)
95+
zone_append Enable or disable a zloop device native zone append
96+
support.
97+
Default: 1 (enabled).
98+
If native zone append support is disabled, the block layer
99+
will emulate this operation using regular write
100+
operations.
101+
ordered_zone_append Enable zloop mitigation of zone append reordering.
102+
Default: disabled.
103+
This is useful for testing file systems file data mapping
104+
(extents), as when enabled, this can significantly reduce
105+
the number of data extents needed to for a file data
106+
mapping.
107+
=================== =========================================================
95108

96109
3) Deleting a Zoned Device
97110
--------------------------

0 commit comments

Comments
 (0)