Document trim workload choices and other nits
[fio.git] / HOWTO
diff --git a/HOWTO b/HOWTO
index 577eed903e1d88c8c55e801829b71044ca82123b..181e94ca99a68c39c9f082916c89e0034fbfba62 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -297,7 +297,7 @@ irange      Integer range with suffix. Allows value range to be given, such
        1k:4k. If the option allows two sets of ranges, they can be
        specified with a ',' or '/' delimiter: 1k-4k/8k-32k. Also see
        int.
-float_list     A list of floating numbers, separated by a ':' character.
+float_list     A list of floating point numbers, separated by a ':' character.
 
 With the above in mind, here follows the complete list of fio job
 parameters.
@@ -398,12 +398,13 @@ rw=str            Type of io pattern. Accepted values are:
 
                        read            Sequential reads
                        write           Sequential writes
+                       trim            Sequential trims
                        randwrite       Random writes
                        randread        Random reads
+                       randtrim        Random trims
                        rw,readwrite    Sequential mixed reads and writes
                        randrw          Random mixed reads and writes
-                       trimwrite       Mixed trims and writes. Blocks will be
-                                       trimmed first, then written to.
+                       trimwrite       Sequential trim+write sequences
 
                Fio defaults to read if the option is not specified.
                For the mixed io types, the default is to split them 50/50.
@@ -444,7 +445,7 @@ kb_base=int The base unit for a kilobyte. The defacto base is 2^10, 1024.
                1024 or 1000, with 1024 being the default.
 
 unified_rw_reporting=bool      Fio normally reports statistics on a per
-               data direction basis, meaning that read, write, and trim are
+               data direction basis, meaning that reads, writes, and trims are
                accounted and reported separately. If this option is set,
                the fio will sum the results and report them as "mixed"
                instead.
@@ -476,8 +477,17 @@ fadvise_hint=bool By default, fio will use fadvise() to advise the kernel
                on what IO patterns it is likely to issue. Sometimes you
                want to test specific IO patterns without telling the
                kernel about it, in which case you can disable this option.
-               If set, fio will use POSIX_FADV_SEQUENTIAL for sequential
-               IO and POSIX_FADV_RANDOM for random IO.
+               The following options are supported:
+
+                       sequential      Use FADV_SEQUENTIAL
+                       random          Use FADV_RANDOM
+                       1               Backwards-compatible hint for basing
+                                       the hint on the fio workload. Will use
+                                       FADV_SEQUENTIAL for a sequential
+                                       workload, and FADV_RANDOM for a random
+                                       workload.
+                       0               Backwards-compatible setting for not
+                                       issing a fadvise hint.
 
 fadvise_stream=int Notify the kernel what write stream ID to place these
                writes under. Only supported on Linux. Note, this option
@@ -819,6 +829,9 @@ ioengine=str        Defines how the job issues io to the file. The following
                        pmemblk Read and write through the NVML libpmemblk
                                interface.
 
+                       dev-dax Read and write through a DAX device exposed
+                               from persistent memory.
+
                        external Prefix to specify loading an external
                                IO engine object file. Append the engine
                                filename, eg ioengine=external:/tmp/foo.o
@@ -1218,6 +1231,48 @@ ramp_time=time   If set, fio will run the specified workload for this amount
                thus it will increase the total runtime if a special timeout
                or runtime is specified.
 
+steadystate=str:float
+ss=str:float   Define the criterion and limit for assessing steady state
+               performance. The first parameter designates the criterion
+               whereas the second parameter sets the threshold. When the
+               criterion falls below the threshold for the specified duration,
+               the job will stop. For example, iops_slope:0.1% will direct fio
+               to terminate the job when the least squares regression slope
+               falls below 0.1% of the mean IOPS. If group_reporting is
+               enabled this will apply to all jobs in the group. Below is the
+               list of available steady state assessment criteria. All
+               assessments are carried out using only data from the rolling
+               collection window. Threshold limits can be expressed as a fixed
+               value or as a percentage of the mean in the collection window.
+                       iops    Collect IOPS data. Stop the job if all
+                               individual IOPS measurements are within the
+                               specified limit of the mean IOPS (e.g., iops:2
+                               means that all individual IOPS values must be
+                               within 2 of the mean, whereas iops:0.2% means
+                               that all individual IOPS values must be within
+                               0.2% of the mean IOPS to terminate the job).
+                       iops_slope
+                               Collect IOPS data and calculate the least
+                               squares regression slope. Stop the job if the
+                               slope falls below the specified limit.
+                       bw      Collect bandwidth data. Stop the job if all
+                               individual bandwidth measurements are within
+                               the specified limit of the mean bandwidth.
+                       bw_slope
+                               Collect bandwidth data and calculate the least
+                               squares regression slope. Stop the job if the
+                               slope falls below the specified limit.
+
+steadystate_duration=time
+ss_dur=time    A rolling window of this duration will be used to judge whether
+               steady state has been reached. Data will be collected once per
+               second. The default is 0 which disables steady state detection.
+
+steadystate_ramp_time=time
+ss_ramp=time   Allow the job to run for the specified duration before
+               beginning data collection for checking the steady state job
+               termination criterion. The default is 0.
+
 invalidate=bool        Invalidate the buffer/page cache parts for this file prior
                to starting io. Defaults to true.