[PATCH] Support for splice IO engine
[fio.git] / README
diff --git a/README b/README
index afef8ec50203d7c367b8cc03537612545db3fedd..92cf5c4948677df98640b0e093df73a527246aac 100644 (file)
--- a/README
+++ b/README
@@ -6,6 +6,20 @@ type of io action as specified by the user. fio takes a number of
 global parameters, each inherited by the thread unless otherwise
 parameters given to them overriding that setting is given.
 
+
+Source
+------
+
+fio resides in a git repo, the canonical place is:
+
+git://brick.kernel.dk/data/git/fio.git
+
+Snapshots are frequently generated as well and they include the git
+meta data as well. You can download them here:
+
+http://brick.kernel.dk/snaps/
+
+
 Options
 -------
 
@@ -19,19 +33,21 @@ $ fio
        -l Generate per-job latency logs
        -w Generate per-job bandwidth logs
        -f <file> Read <file> for job descriptions
+       -h Print help info
        -v Print version information and exit
 
 The <jobs> format is as follows:
 
        directory=x     Use 'x' as the top level directory for storing files
-       rw=x            'x' may be: read, randread, write, or randwrite
+       rw=x            'x' may be: read, randread, write, randwrite,
+                       rw (read-write mix), randrw (read-write random mix)
        size=x          Set file size to x bytes (x string can include k/m/g)
        ioengine=x      'x' may be: aio/libaio/linuxaio for Linux aio,
                        posixaio for POSIX aio, sync for regular read/write io,
-                       mmap for mmap'ed io, or sgio for direct SG_IO io. The
-                       latter only works on Linux on SCSI (or SCSI-like
-                       devices, such as usb-storage or sata/libata driven)
-                       devices.
+                       mmap for mmap'ed io, splice for using splice/vmsplice,
+                       or sgio for direct SG_IO io. The latter only works on
+                       Linux on SCSI (or SCSI-like devices, such as
+                       usb-storage or sata/libata driven) devices.
        iodepth=x       For async io, allow 'x' ios in flight
        overwrite=x     If 'x', layout a write file first.
        prio=x          Run io at prio X, 0-7 is the kernel allowed range
@@ -64,6 +80,17 @@ The <jobs> format is as follows:
        stonewall       Wait for preceeding jobs to end before running.
        numjobs=x       Create 'x' similar entries for this job
        thread          Use pthreads instead of forked jobs
+       zonesize=x
+       zoneskip=y      Zone options must be paired. If given, the job
+                       will skip y bytes for every x read/written. This
+                       can be used to gauge hard drive speed over the entire
+                       platter, without reading everything. Both x/y can
+                       include k/m/g suffix.
+       iolog=x         Open and read io pattern from file 'x'. The file must
+                       contain one io action per line in the following format:
+                       rw, offset, length
+                       where with rw=0/1 for read/write, and the offset
+                       and length entries being in bytes.
 
 
 Examples using a job file