Compile error with FIO_USE_TIMEOUT defined

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index a2070d666ce78dc28506f68386a451152ce4b32d..460b456ce44b312a016346a62c30a7a8093bb86b 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -176,6 +176,8 @@ siint       SI integer. A whole number value, which may contain a postfix
        meaning kilo, mega, and giga. So if you want to specify 4096,
        you could either write out '4096' or just give 4k. The postfixes
        signify base 2 values, so 1024 is 1k and 1024k is 1m and so on.
+       If the option accepts an upper and lower range, use a colon ':'
+       or minus '-' to seperate such values. See irange.
 bool   Boolean. Usually parsed as an integer, however only defined for
        true and false (1 and 0).
 irange Integer range with postfix. Allows value range to be given, such
@@ -214,6 +216,7 @@ filename=str        Fio normally makes up a filename based on the job name,
 opendir=str    Tell fio to recursively add any file it can find in this
                directory and down the file system tree.
 
+readwrite=str
 rw=str         Type of io pattern. Accepted values are:
 
                        read            Sequential reads
@@ -242,6 +245,7 @@ filesize=siint      Individual file sizes. May be a range, in which case fio
                and limited to 'size' in total (if that is given). If not
                given, each created file is the same size.
 
+blocksize=siint
 bs=siint       The block size used for the io units. Defaults to 4k. Values
                can be given for both read and writes. If a single siint is
                given, it will apply to both. If a second siint is specified
@@ -252,6 +256,7 @@ bs=siint    The block size used for the io units. Defaults to 4k. Values
                can do so by passing an empty read size - bs=,8k will set
                8k for writes and leave the read default value.
 
+blocksize_range=irange
 bsrange=irange Instead of giving a single block size, specify a range
                and fio will mix the issued io block sizes. The issued
                io unit will always be a multiple of the minimum value
@@ -259,6 +264,7 @@ bsrange=irange      Instead of giving a single block size, specify a range
                writes, however a second range can be given after a comma.
                See bs=.
 
+blocksize_unaligned
 bs_unaligned   If this option is given, any byte size value within bsrange
                may be used as a block range. This typically wont work with
                direct IO, as that normally requires sector alignment.
@@ -416,7 +422,16 @@ thinktime_blocks
 rate=int       Cap the bandwidth used by this job to this number of KiB/sec.
 
 ratemin=int    Tell fio to do whatever it can to maintain at least this
-               bandwidth.
+               bandwidth. Failing to meet this requirement, will cause
+               the job to exit.
+
+rate_iops=int  Cap the bandwidth to this number of IOPS. Basically the same
+               as rate, just specified independently of bandwidth. If the
+               job is given a block size range instead of a fixed value,
+               the smallest block size is used as the metric.
+
+rate_iops_min=int If fio doesn't meet this rate of IO, it will cause
+               the job to exit.
 
 ratecycle=int  Average bandwidth for 'rate' and 'ratemin' over this number
                of milliseconds.
@@ -441,6 +456,7 @@ invalidate=bool     Invalidate the buffer/page cache parts for this file prior
 sync=bool      Use sync io for buffered writes. For the majority of the
                io engines, this means using O_SYNC.
 
+iomem=str
 mem=str                Fio can use various types of memory as the io unit buffer.
                The allowed values are: