Add cpus_allowed option

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index aeb87ddb37cc59cdd057a56bd99ea9f901efbd68..0c243076ef65be503d7fc17d63ba4f7737182ec9 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -170,7 +170,7 @@ Some parameters take an option of a given type, such as an integer or
 a string. The following types are used:
 
 str    String. This is a sequence of alpha characters.
-int    Integer. A whole number value, may be negative.
+int    Integer. A whole number value, can be negative.
 siint  SI integer. A whole number value, which may contain a postfix
        describing the base of the number. Accepted postfixes are k/m/g,
        meaning kilo, mega, and giga. So if you want to specify 4096,
@@ -249,12 +249,12 @@ fadvise_hint=bool By default, fio will use fadvise() to advise the kernel
                If set, fio will use POSIX_FADV_SEQUENTIAL for sequential
                IO and POSIX_FADV_RANDOM for random IO.
 
-size=siint     The total size of file io for this job. This may describe
-               the size of the single file the job uses, or it may be
-               divided between the number of files in the job. If the
-               file already exists, the file size will be adjusted to this
-               size if larger than the current file size. If this parameter
-               is not given and the file exists, the file size will be used.
+size=siint     The total size of file io for this job. Fio will run until
+               this many bytes has been transferred, unless runtime is
+               limited by other options (such as 'runtime', for instance).
+               Unless specific nr_files and filesize options are given,
+               fio will divide this size between the available files
+               specified by the job.
 
 filesize=siint Individual file sizes. May be a range, in which case fio
                will select sizes for files at random within the given range
@@ -285,6 +285,9 @@ 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.
 
+zero_buffers   If this option is given, fio will init the IO buffers to
+               all zeroes. The default is to fill them with random data.
+
 nrfiles=int    Number of files to use for this job. Defaults to 1.
 
 openfiles=int  Number of files to keep open at the same time. Defaults to
@@ -416,7 +419,9 @@ norandommap Normally fio will cover every block of the file when doing
                new random offset without looking at past io history. This
                means that some blocks may not be read or written, and that
                some blocks may be read/written more than once. This option
-               is mutually exclusive with verify= for that reason.
+               is mutually exclusive with verify= for that reason, since
+               fio doesn't track potential block rewrites which may alter
+               the calculated checksum for that block.
 
 nice=int       Run the job with the given nice value. See man nice(2).
 
@@ -461,8 +466,15 @@ ratecycle=int      Average bandwidth for 'rate' and 'ratemin' over this number
                of milliseconds.
 
 cpumask=int    Set the CPU affinity of this job. The parameter given is a
-               bitmask of allowed CPU's the job may run on. See man
-               sched_setaffinity(2).
+               bitmask of allowed CPU's the job may run on. So if you want
+               the allowed CPUs to be 1 and 5, you would pass the decimal
+               value of (1 << 1 | 1 << 5), or 34. See man
+               sched_setaffinity(2). This may not work on all supported
+               operating systems or kernel versions.
+
+cpus_allowed=str Controls the same options as cpumask, but it allows a text
+               setting of the permitted CPUs instead. So to use CPUs 1 and
+               5, you would specify cpus_allowed=1,5.
 
 startdelay=int Start this job the specified number of seconds after fio
                has started. Only useful if the job file contains several
@@ -474,6 +486,11 @@ runtime=int        Tell fio to terminate processing after the specified number
                a specified job will run, so this parameter is handy to
                cap the total runtime to a given time.
 
+time_based     If set, fio will run for the duration of the runtime
+               specified even if the file(s) are completey read or
+               written. It will simply loop over the same workload
+               as many times as the runtime allows.
+
 invalidate=bool        Invalidate the buffer/page cache parts for this file prior
                to starting io. Defaults to true.
 
@@ -610,7 +627,12 @@ write_iolog=str    Write the issued io patterns to the specified file. See
 
 read_iolog=str Open an iolog with the specified file name and replay the
                io patterns it contains. This can be used to store a
-               workload and replay it sometime later.
+               workload and replay it sometime later. The iolog given
+               may also be a blktrace binary file, which allows fio
+               to replay a workload captured by blktrace. See blktrace
+               for how to capture such logging data. For blktrace replay,
+               the file needs to be turned into a blkparse binary data
+               file first (blktrace <device> -d file_for_fio.bin).
 
 write_bw_log   If given, write a bandwidth log of the jobs in this job
                file. Can be used to store data of the bandwidth of the
@@ -640,6 +662,9 @@ cpuload=int If the job is a CPU cycle eater, attempt to use the specified
 cpuchunks=int  If the job is a CPU cycle eater, split the load into
                cycles of the given time. In milliseconds.
 
+disk_util=bool Generate disk utilization statistics, if the platform
+               supports it. Defaults to on.
+
 
 6.0 Interpreting the output
 ---------------------------