Move setup_rate() out of log.c

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index ec4f3e21170a49a0cbae4a26571739f36c1e0d6a..c14039318175c6170dbec9c3c7be55d80ff16801 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
@@ -211,6 +213,9 @@ filename=str        Fio normally makes up a filename based on the job name,
                a job to open /dev/sda and /dev/sdb as the two working files,
                you would use filename=/dev/sda:/dev/sdb
 
+opendir=str    Tell fio to recursively add any file it can find in this
+               directory and down the file system tree.
+
 rw=str         Type of io pattern. Accepted values are:
 
                        read            Sequential reads
@@ -234,6 +239,11 @@ size=siint The total size of file io for this job. This may describe
                size if larger than the current file size. If this parameter
                is not given and the file exists, the file size will be used.
 
+filesize=siint Individual file sizes. May be a range, in which case fio
+               will select sizes for files at random within the given range
+               and limited to 'size' in total (if that is given). If not
+               given, each created file is the same size.
+
 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
@@ -408,7 +418,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.