Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

block: update sysfs documentation

Add the description of the zoned, nr_zones and chunk_sectors sysfs queue
attributes to Documentation/block/queue-sysfs.txt. The description of
the zoned and chunk_sector attributes are mostly copied from
ABI/testing/sysfs-block (added a typo fix). While at it, also fix a
typo in the description of the io_poll_delay attribute.

nr_zones description is also added to ABI/testing/sysfs-block and
contact email address updated for the zoned attribute.

Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>

authored by

Damien Le Moal and committed by
Jens Axboe
f9824952 38a3499f

+38 -3
+10 -2
Documentation/ABI/testing/sysfs-block
··· 244 244 245 245 What: /sys/block/<disk>/queue/zoned 246 246 Date: September 2016 247 - Contact: Damien Le Moal <damien.lemoal@hgst.com> 247 + Contact: Damien Le Moal <damien.lemoal@wdc.com> 248 248 Description: 249 249 zoned indicates if the device is a zoned block device 250 250 and the zone model of the device if it is indeed zoned. ··· 259 259 zone commands, they will be treated as regular block 260 260 devices and zoned will report "none". 261 261 262 + What: /sys/block/<disk>/queue/nr_zones 263 + Date: November 2018 264 + Contact: Damien Le Moal <damien.lemoal@wdc.com> 265 + Description: 266 + nr_zones indicates the total number of zones of a zoned block 267 + device ("host-aware" or "host-managed" zone model). For regular 268 + block devices, the value is always 0. 269 + 262 270 What: /sys/block/<disk>/queue/chunk_sectors 263 271 Date: September 2016 264 272 Contact: Hannes Reinecke <hare@suse.com> ··· 276 268 indicates the size in 512B sectors of the RAID volume 277 269 stripe segment. For a zoned block device, either 278 270 host-aware or host-managed, chunk_sectors indicates the 279 - size of 512B sectors of the zones of the device, with 271 + size in 512B sectors of the zones of the device, with 280 272 the eventual exception of the last zone of the device 281 273 which may be smaller.
+28 -1
Documentation/block/queue-sysfs.txt
··· 64 64 of time, before entering a classic poll loop. This mode might be a 65 65 little slower than pure classic polling, but it will be more efficient. 66 66 If set to a value larger than 0, the kernel will put the process issuing 67 - IO to sleep for this amont of microseconds before entering classic 67 + IO to sleep for this amount of microseconds before entering classic 68 68 polling. 69 69 70 70 iostats (RW) ··· 193 193 blk-throttle makes decision based on the samplings. Lower time means cgroups 194 194 have more smooth throughput, but higher CPU overhead. This exists only when 195 195 CONFIG_BLK_DEV_THROTTLING_LOW is enabled. 196 + 197 + zoned (RO) 198 + ---------- 199 + This indicates if the device is a zoned block device and the zone model of the 200 + device if it is indeed zoned. The possible values indicated by zoned are 201 + "none" for regular block devices and "host-aware" or "host-managed" for zoned 202 + block devices. The characteristics of host-aware and host-managed zoned block 203 + devices are described in the ZBC (Zoned Block Commands) and ZAC 204 + (Zoned Device ATA Command Set) standards. These standards also define the 205 + "drive-managed" zone model. However, since drive-managed zoned block devices 206 + do not support zone commands, they will be treated as regular block devices 207 + and zoned will report "none". 208 + 209 + nr_zones (RO) 210 + ------------- 211 + For zoned block devices (zoned attribute indicating "host-managed" or 212 + "host-aware"), this indicates the total number of zones of the device. 213 + This is always 0 for regular block devices. 214 + 215 + chunk_sectors (RO) 216 + ------------------ 217 + This has different meaning depending on the type of the block device. 218 + For a RAID device (dm-raid), chunk_sectors indicates the size in 512B sectors 219 + of the RAID volume stripe segment. For a zoned block device, either host-aware 220 + or host-managed, chunk_sectors indicates the size in 512B sectors of the zones 221 + of the device, with the eventual exception of the last zone of the device which 222 + may be smaller. 196 223 197 224 Jens Axboe <jens.axboe@oracle.com>, February 2009