[PATCH] Add support for specifying read/write mix workloads better

[fio.git] / README

diff --git a/README b/README
index 3cf3f13395414bcbcf19c0b6246092fd7216455e..3d59337df57c52ee43c841e5cfafa631c575e9da 100644 (file)
--- a/README
+++ b/README
@@ -41,13 +41,20 @@ 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, randwrite,
                        rw (read-write mix), randrw (read-write random mix)
+       rwmixcycle=x    Base cycle for switching between read and write
+                       in msecs.
+       rwmixread=x     'x' percentage of rw mix ios will be reads. If
+                       rwmixwrite is also given, the last of the two will
+                        be used if they don't add up to 100%.
+       rwmixwrite=x    'x' percentage of rw mix ios will be writes. See
+                       rwmixread.
        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
@@ -73,6 +80,7 @@ The <jobs> format is as follows:
        bwavgtime=x     Average bandwidth stats over an x msec window.
        create_serialize=x      If 'x', serialize file creation.
        create_fsync=x  If 'x', run fsync() after file creation.
+       end_fsync=x     If 'x', run fsync() after end-of-job.
        loops=x         Run the job 'x' number of times.
        verify=x        If 'x' == md5, use md5 for verifies. If 'x' == crc32,
                        use crc32 for verifies. md5 is 'safer', but crc32 is
@@ -86,7 +94,14 @@ The <jobs> format is as follows:
                        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.
+       lockmem=x       Lock down x amount of memory on the machine, to
+                       simulate a machine with less memory available. x can
+                       include k/m/g suffix.
 
 Examples using a job file
 -------------------------