Skip to contentSkip to conversation

block: add documentation for io_timeout

PATCH Applied Weiping Zhang 3 participants 3 messages Dec 26, 2018 – Jan 5, 2019

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 block: add documentation for io_timeout

Add documentation for /sys/block/<disk>/queue/io_timeout.

---
 Documentation/ABI/testing/sysfs-block | 9 +++++++++
 Documentation/block/queue-sysfs.txt   | 7 +++++++
 2 files changed, 16 insertions(+)
Documentation/ABI/testing/sysfs-block +9 -0
index 7710d4022b19..dfad7427817c 100644
@@ -279,3 +279,12 @@ Description:
 		size in 512B sectors of the zones of the device, with
 		the eventual exception of the last zone of the device
 		which may be smaller.
+
+What:		/sys/block/<disk>/queue/io_timeout
+Date:		November 2018
+Contact:	Weiping Zhang <[email protected]>
+Description:
+		io_timeout is the request timeout in milliseconds. If a request
+		does not complete in this time then the block driver timeout
+		handler is invoked. That timeout handler can decide to retry
+		the request, to fail it or to start a device recovery strategy.
Documentation/block/queue-sysfs.txt +7 -0
index 39e286d7afc9..83b457e24bba 100644
@@ -67,6 +67,13 @@ If set to a value larger than 0, the kernel will put the process issuing
 IO to sleep for this amount of microseconds before entering classic
 polling.
 
+io_timeout (RW)
+---------------
+io_timeout is the request timeout in milliseconds. If a request does not
+complete in this time then the block driver timeout handler is invoked.
+That timeout handler can decide to retry the request, to fail it or to start
+a device recovery strategy.
+
 iostats (RW)
 -------------
 This file is used to control (on/off) the iostats accounting of the
Signature · 1 line
2.14.1
Reviewed-by on v4 1/1
#1 lore raw
Quoted 38 lines · Weiping Zhang

Add documentation for /sys/block/<disk>/queue/io_timeout.

Documentation/ABI/testing/sysfs-block |9 +-+-+-+-+-+-+-+-+-
Documentation/block/queue-sysfs.txt |7 +-+-+-+-+-+-+-

2 files changed, 16 insertions(+-)
Documentation/ABI/testing/sysfs-block +1 -1
index 7710d4022b19..dfad7427817c 100644
--- a/Documentation/ABI/testing/sysfs-block
+-+-+- b/Documentation/ABI/testing/sysfs-block

@@-279,3 +-279,12 @@Description:
size in 512B sectors of the zones of the device, with the eventual exception of the last zone of the device which may be smaller.

+-
+-What:		/sys/block/<disk>/queue/io_timeout
+-Date:		November 2018
+-Contact:	Weiping Zhang <[email protected]>>+-Description:
+-		io_timeout is the request timeout in milliseconds. If a request
+-		does not complete in this time then the block driver timeout
+-		handler is invoked. That timeout handler can decide to retry
+-		the request, to fail it or to start a device recovery strategy.
Documentation/block/queue-sysfs.txt +1 -1
index 39e286d7afc9..83b457e24bba 100644
--- a/Documentation/block/queue-sysfs.txt
+-+-+- b/Documentation/block/queue-sysfs.txt

@@-67,6 +-67,13 @@If set to a value larger than 0, the kernel will put the process issuing IO to sleep for this amount of microseconds before entering classic polling.

+-io_timeout (RW)
+----------------
+-io_timeout is the request timeout in milliseconds. If a request does not
+-complete in this time then the block driver timeout handler is invoked.
+-That timeout handler can decide to retry the request, to fail it or to start
+-a device recovery strategy.
+-
Quoted 3 lines

iostats (RW)
-------------
This file is used to control (on/off) the iostats accounting of the

maintainer Applied
#2 lore raw
In reply to Weiping Zhang
Quoted 1 line · Weiping Zhang

Add documentation for /sys/block/<disk>/queue/io_timeout.

Applied, thanks.

Signature · 1 line
Jens Axboe