From 5faddc64ce0cd3ee272176b02608439d00c145c0 Mon Sep 17 00:00:00 2001 From: Bart Van Assche Date: Thu, 9 Aug 2018 17:02:59 -0700 Subject: [PATCH] Improve zone support documentation Improve the documentation of the zonesize, zoneskip and zonerange job options such that this documentation becomes easier to comprehend. Signed-off-by: Bart Van Assche --- HOWTO | 18 ++++++++++++------ fio.1 | 17 ++++++++++++----- 2 files changed, 24 insertions(+), 11 deletions(-) diff --git a/HOWTO b/HOWTO index 4c117c24..1bec8064 100644 --- a/HOWTO +++ b/HOWTO @@ -952,18 +952,24 @@ Target file/device Unlink job files after each iteration or loop. Default: false. -.. option:: zonesize=int +.. option:: zonerange=int - Divide a file into zones of the specified size. See :option:`zoneskip`. + Size of a single zone in which I/O occurs. See also :option:`zonesize` + and :option:`zoneskip`. -.. option:: zonerange=int +.. option:: zonesize=int - Give size of an I/O zone. See :option:`zoneskip`. + Number of bytes to transfer before skipping :option:`zoneskip` + bytes. If this parameter is smaller than :option:`zonerange` then only + a fraction of each zone with :option:`zonerange` bytes will be + accessed. If this parameter is larger than :option:`zonerange` then + each zone will be accessed multiple times before skipping .. option:: zoneskip=int - Skip the specified number of bytes when :option:`zonesize` data has been - read. The two zone options can be used to only do I/O on zones of a file. + Skip the specified number of bytes when :option:`zonesize` data have + been transferred. The three zone options can be used to do strided I/O + on a file. I/O type diff --git a/fio.1 b/fio.1 index 0c604a6a..18bf6a25 100644 --- a/fio.1 +++ b/fio.1 @@ -724,15 +724,22 @@ false. .BI unlink_each_loop \fR=\fPbool Unlink job files after each iteration or loop. Default: false. .TP -.BI zonesize \fR=\fPint -Divide a file into zones of the specified size. See \fBzoneskip\fR. +Fio supports strided data access. After having read \fBzonesize\fR bytes from an area that is \fBzonerange\fR bytes big, \fBzoneskip\fR bytes are skipped. .TP .BI zonerange \fR=\fPint -Give size of an I/O zone. See \fBzoneskip\fR. +Size of a single zone in which I/O occurs. +.TP +.BI zonesize \fR=\fPint +Number of bytes to transfer before skipping \fBzoneskip\fR bytes. If this +parameter is smaller than \fBzonerange\fR then only a fraction of each zone +with \fBzonerange\fR bytes will be accessed. If this parameter is larger than +\fBzonerange\fR then each zone will be accessed multiple times before skipping +to the next zone. .TP .BI zoneskip \fR=\fPint -Skip the specified number of bytes when \fBzonesize\fR data has been -read. The two zone options can be used to only do I/O on zones of a file. +Skip the specified number of bytes after \fBzonesize\fR bytes of data have been +transferred. + .SS "I/O type" .TP .BI direct \fR=\fPbool -- 2.25.1