Log and dump short ios
[fio.git] / HOWTO
diff --git a/HOWTO b/HOWTO
index d8c09d07aa40ddb4829c79a0a30b60a4f0c4b1f7..aeb87ddb37cc59cdd057a56bd99ea9f901efbd68 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -211,7 +211,9 @@ filename=str        Fio normally makes up a filename based on the job name,
                ioengine is file based, you can specify a number of files
                by seperating the names with a ':' colon. So if you wanted
                a job to open /dev/sda and /dev/sdb as the two working files,
-               you would use filename=/dev/sda:/dev/sdb
+               you would use filename=/dev/sda:/dev/sdb. '-' is a reserved
+               name, meaning stdin or stdout. Which of the two depends
+               on the read/write direction set.
 
 opendir=str    Tell fio to recursively add any file it can find in this
                directory and down the file system tree.
@@ -228,11 +230,25 @@ rw=str            Type of io pattern. Accepted values are:
 
                For the mixed io types, the default is to split them 50/50.
                For certain types of io the result may still be skewed a bit,
-               since the speed may be different.
+               since the speed may be different. It is possible to specify
+               a number of IO's to do before getting a new offset - this
+               is only useful for random IO, where fio would normally
+               generate a new random offset for every IO. If you append
+               eg 8 to randread, you would get a new random offset for
+               every 8 IO's. The result would be a seek for only every 8
+               IO's, instead of for every IO. Use rw=randread:8 to specify
+               that.
 
 randrepeat=bool        For random IO workloads, seed the generator in a predictable
                way so that results are repeatable across repetitions.
 
+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.
+
 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
@@ -330,6 +346,14 @@ ioengine=str       Defines how the job issues io to the file. The following
                                will cause that job to do nothing but burn
                                85% of the CPU.
 
+                       guasi   The GUASI IO engine is the Generic Userspace
+                               Asyncronous Syscall Interface approach
+                               to async IO. See
+
+                               http://www.xmailserver.org/guasi-lib.html
+
+                               for more info on GUASI.
+
                        external Prefix to specify loading an external
                                IO engine object file. Append the engine
                                filename, eg ioengine=external:/tmp/foo.o
@@ -533,10 +557,22 @@ verify=str        If writing to a file, fio can verify the file contents
                        crc32   Use a crc32 sum of the data area and store
                                it in the header of each block.
 
+                       null    Only pretend to verify. Useful for testing
+                               internals with ioengine=null, not for much
+                               else.
+
                This option can be used for repeated burn-in tests of a
                system to make sure that the written data is also
                correctly read back.
 
+verifysort=bool        If set, fio will sort written verify blocks when it deems
+               it faster to read them back in a sorted manner. This is
+               often the case when overwriting an existing file, since
+               the blocks are already laid out in the file system. You
+               can ignore this option unless doing huge amounts of really
+               fast IO where the red-black tree sorting CPU time becomes
+               significant.
+               
 stonewall      Wait for preceeding jobs in the job file to exit, before
                starting this one. Can be used to insert serialization
                points in the job file. A stone wall also implies starting
@@ -648,6 +684,7 @@ Client1 (g=0): err= 0:
     bw (KiB/s) : min=    0, max= 1196, per=51.00%, avg=664.02, stdev=681.68
   cpu        : usr=1.49%, sys=0.25%, ctx=7969
   IO depths    : 1=0.1%, 2=0.3%, 4=0.5%, 8=99.0%, 16=0.0%, 32=0.0%, >32=0.0%
+     issued r/w: total=0/32768, short=0/0
      lat (msec): 2=1.6%, 4=0.0%, 10=3.2%, 20=12.8%, 50=38.4%, 100=24.8%,
      lat (msec): 250=15.2%, 500=0.0%, 750=0.0%, 1000=0.0%, >=2048=0.0%
 
@@ -679,6 +716,8 @@ IO depths=  The distribution of io depths over the job life time. The
                16= entries includes depths up to that value but higher
                than the previous entry. In other words, it covers the
                range from 16 to 31.
+IO issued=     The number of read/write requests issued, and how many
+               of them were short.
 IO latencies=  The distribution of IO completion latencies. This is the
                time from when IO leaves fio and when it gets completed.
                The numbers follow the same pattern as the IO depths,