Add gtod_reduce option
[fio.git] / HOWTO
diff --git a/HOWTO b/HOWTO
index f569f5622de5db7d28d0fb3b7319b6aee9545ef1..f4efd281bbc72e2a4a54dfc233aab2310fa0643d 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -111,7 +111,7 @@ several global sections if so desired. A job is only affected by a global
 section residing above it. If the first character in a line is a ';' or a
 '#', the entire line is discarded as a comment.
 
-So lets look at a really simple job file that define to threads, each
+So let's look at a really simple job file that defines two processes, each
 randomly reading from a 128MiB file.
 
 ; -- start job file --
@@ -133,7 +133,7 @@ line, this job would look as follows:
 $ fio --name=global --rw=randread --size=128m --name=job1 --name=job2
 
 
-Lets look at an example that have a number of processes writing randomly
+Let's look at an example that has a number of processes writing randomly
 to files.
 
 ; -- start job file --
@@ -158,6 +158,33 @@ specify:
 
 $ fio --name=random-writers --ioengine=libaio --iodepth=4 --rw=randwrite --bs=32k --direct=0 --size=64m --numjobs=4
 
+fio also supports environment variable expansion in job files. Any
+substring of the form "${VARNAME}" as part of an option value (in other
+words, on the right of the `='), will be expanded to the value of the
+environment variable called VARNAME.  If no such environment variable
+is defined, or VARNAME is the empty string, the empty string will be
+substituted.
+
+As an example, let's look at a sample fio invocation and job file:
+
+$ SIZE=64m NUMJOBS=4 fio jobfile.fio
+
+; -- start job file --
+[random-writers]
+rw=randwrite
+size=${SIZE}
+numjobs=${NUMJOBS}
+; -- end job file --
+
+This will expand to the following equivalent job file at runtime:
+
+; -- start job file --
+[random-writers]
+rw=randwrite
+size=64m
+numjobs=4
+; -- end job file --
+
 fio ships with a few example job files, you can also look there for
 inspiration.
 
@@ -172,6 +199,9 @@ a string. The following types are used:
 str    String. This is a sequence of alpha characters.
 int    Integer. A whole number value, can be negative. If prefixed with
        0x, the integer is assumed to be of base 16 (hexadecimal).
+time   Integer with possible time postfix. In seconds unless otherwise
+       specified, use eg 10m for 10 minutes. Accepts s/m/h for seconds,
+       minutes, and hours.
 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,
@@ -559,12 +589,12 @@ 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
+startdelay=time        Start this job the specified number of seconds after fio
                has started. Only useful if the job file contains several
                jobs, and you want to delay starting some jobs to a certain
                time.
 
-runtime=int    Tell fio to terminate processing after the specified number
+runtime=time   Tell fio to terminate processing after the specified number
                of seconds. It can be quite hard to determine for how long
                a specified job will run, so this parameter is handy to
                cap the total runtime to a given time.
@@ -574,6 +604,14 @@ time_based If set, fio will run for the duration of the runtime
                written. It will simply loop over the same workload
                as many times as the runtime allows.
 
+ramp_time=time If set, fio will run the specified workload for this amount
+               of time before logging any performance numbers. Useful for
+               letting performance settle before logging results, thus
+               minimizing the runtime required for stable results. Note
+               that the ramp_time is considered lead in time for a job,
+               thus it will increase the total runtime if a special timeout
+               or runtime is specified.
+
 invalidate=bool        Invalidate the buffer/page cache parts for this file prior
                to starting io. Defaults to true.
 
@@ -664,6 +702,9 @@ verify=str  If writing to a file, fio can verify the file contents
                        crc32c  Use a crc32c sum of the data area and store
                                it in the header of each block.
 
+                       crc32c-intel Use hardware assisted crc32c calcuation
+                               provided on SSE4.2 enabled processors.
+
                        crc32   Use a crc32 sum of the data area and store
                                it in the header of each block.
 
@@ -794,6 +835,26 @@ cpuchunks=int      If the job is a CPU cycle eater, split the load into
 disk_util=bool Generate disk utilization statistics, if the platform
                supports it. Defaults to on.
 
+disable_clat=bool Disable measurements of completion latency numbers. Useful
+               only for cutting back the number of calls to gettimeofday,
+               as that does impact performance at really high IOPS rates.
+               Note that to really get rid of a large amount of these
+               calls, this option must be used with disable_slat and
+               disable_bw as well.
+
+disable_slat=bool Disable measurements of submission latency numbers. See
+               disable_clat.
+
+disable_bw=bool        Disable measurements of throughput/bandwidth numbers. See
+               disable_clat.
+
+gtod_reduce=bool Enable all of the gettimeofday() reducing options
+               (disable_clat, disable_slat, disable_bw) plus reduce
+               precision of the timeout somewhat to really shrink
+               the gettimeofday() call count. With this option enabled,
+               we only do about 0.4% of the gtod() calls we would have
+               done if all time keeping was enabled.
+
 
 6.0 Interpreting the output
 ---------------------------
@@ -934,6 +995,8 @@ The format is one long line of values, such as:
 client1;0;0;1906777;1090804;1790;0;0;0.000000;0.000000;0;0;0.000000;0.000000;929380;1152890;25.510151%;1078276.333333;128948.113404;0;0;0;0;0;0.000000;0.000000;0;0;0.000000;0.000000;0;0;0.000000%;0.000000;0.000000;100.000000%;0.000000%;324;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%;0.0%;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%
 ;0.0%;0.0%;0.0%;0.0%;0.0%
 
+To enable terse output, use the --minimal command line option.
+
 Split up, the format is as follows:
 
        jobname, groupid, error