[PATCH] Document how to setup/use huge pages
[fio.git] / HOWTO
diff --git a/HOWTO b/HOWTO
index 78a9be037839b1692bdca1e64f6283daaa3aad4c..996da23a1ce998665d1f9af7d65faaf064eced64 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -52,7 +52,7 @@ bottom, it contains the following basic parameters:
                        could be using splice, async io, or even
                        SG (SCSI generic sg).
 
-       IO depth        If the io engine is async, how large a queueing
+       IO depth        If the io engine is async, how large a queuing
                        depth do we want to maintain?
 
        IO type         Should we be doing buffered io, or direct/raw io?
@@ -96,7 +96,7 @@ job until a new [] job entry is seen.
 
 fio does not need to run as root, except if the files or devices specified
 in the job section requires that. Some other options may also be restricted,
-such as memory locking, io scheduler switching, and descreasing the nice value.
+such as memory locking, io scheduler switching, and decreasing the nice value.
 
 
 4.0 Job file format
@@ -173,7 +173,7 @@ str String. This is a sequence of alpha characters.
 int    Integer. A whole number value, may 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 specifiy 4096,
+       meaning kilo, mega, and giga. So if you want to specify 4096,
        you could either write out '4096' or just give 4k. The postfixes
        signify base 2 values, so 1024 is 1k and 1024k is 1m and so on.
 bool   Boolean. Usually parsed as an integer, however only defined for
@@ -187,7 +187,7 @@ parameters.
 name=str       ASCII name of the job. This may be used to override the
                name printed by fio for this job. Otherwise the job
                name is used. On the command line this parameter has the
-               special purpose of also signalling the start of a new
+               special purpose of also signaling the start of a new
                job.
 
 directory=str  Prefix filenames with this directory. Used to places files
@@ -218,22 +218,22 @@ size=siint        The total size of file io for this job. This may describe
                size if larger than the current file size. If this parameter
                is not given and the file exists, the file size will be used.
 
-bs=siint       The block size used for the io units. Defaults to 4k.
-
-read_bs=siint
-write_bs=siint If the workload is a mixed read-write workload, you can use
-               these options to set seperate block sizes.
+bs=siint       The block size used for the io units. Defaults to 4k. Values
+               can be given for both read and writes. If a single siint is
+               given, it will apply to both. If a second siint is specified
+               after a comma, it will apply to writes only. In other words,
+               the format is either bs=read_and_write or bs=read,write.
+               bs=4k,8k will thus use 4k blocks for reads, and 8k blocks
+               for writes. If you only wish to set the write size, you
+               can do so by passing an empty read size - bs=,8k will set
+               8k for writes and leave the read default value.
 
 bsrange=irange Instead of giving a single block size, specify a range
                and fio will mix the issued io block sizes. The issued
                io unit will always be a multiple of the minimum value
-               given (also see bs_unaligned).
-
-read_bsrange=irange
-write_bsrange=irange
-               If the workload is a mixed read-write workload, you can use
-               one of these options to set separate block size ranges for
-               reads and writes.
+               given (also see bs_unaligned). Applies to both reads and
+               writes, however a second range can be given after a comma.
+               See bs=.
 
 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
@@ -259,11 +259,15 @@ ioengine=str      Defines how the job issues io to the file. The following
                                space to the kernel.
 
                        sg      SCSI generic sg v3 io. May either be
-                               syncrhonous using the SG_IO ioctl, or if
+                               synchronous using the SG_IO ioctl, or if
                                the target is an sg character device
                                we use read(2) and write(2) for asynchronous
                                io.
 
+                       null    Doesn't transfer any data, just pretends
+                               to. This is mainly used to exercise fio
+                               itself and for debugging/testing purposes.
+
 iodepth=int    This defines how many io units to keep in flight against
                the file. The default is 1 for each file defined in this
                job, can be overridden with a larger value for higher
@@ -281,13 +285,13 @@ fsync=int If writing to a file, issue a sync of the dirty data
                32 as a parameter, fio will sync the file for every 32
                writes issued. If fio is using non-buffered io, we may
                not sync the file. The exception is the sg io engine, which
-               syncronizes the disk cache anyway.
+               synchronizes the disk cache anyway.
 
 overwrite=bool If writing to a file, setup the file first and do overwrites.
 
 end_fsync=bool If true, fsync file contents when the job exits.
 
-rwmixcycle=int Value in miliseconds describing how often to switch between
+rwmixcycle=int Value in milliseconds describing how often to switch between
                reads and writes for a mixed workload. The default is
                500 msecs.
 
@@ -323,7 +327,7 @@ ratemin=int Tell fio to do whatever it can to maintain at least this
                bandwidth.
 
 ratecycle=int  Average bandwidth for 'rate' and 'ratemin' over this number
-               of miliseconds.
+               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
@@ -353,18 +357,39 @@ mem=str           Fio can use various types of memory as the io unit buffer.
                        shm     Use shared memory as the buffers. Allocated
                                through shmget(2).
 
+                       shmhuge Same as shm, but use huge pages as backing.
+
                        mmap    Use anonymous memory maps as the buffers.
                                Allocated through mmap(2).
 
+                       mmaphuge Use a memory mapped huge file as the buffer
+                               backing. Append filename after mmaphuge, ala
+                               mem=mmaphuge:/hugetlbfs/file
+
                The area allocated is a function of the maximum allowed
-               bs size for the job, multiplied by the io depth given.
+               bs size for the job, multiplied by the io depth given. Note
+               that for shmhuge and mmaphuge to work, the system must have
+               free huge pages allocated. This can normally be checked
+               and set by reading/writing /proc/sys/vm/nr_hugepages on a
+               Linux system. Fio assumes a huge page is 4MiB in size. So
+               to calculate the number of huge pages you need for a given
+               job file, add up the io depth of all jobs (normally one unless
+               iodepth= is used) and multiply by the maximum bs set. Then
+               divide that number by the huge page size. You can see the
+               size of the huge pages in /proc/meminfo. If no huge pages
+               are allocated by having a non-zero number in nr_hugepages,
+               using mmaphuge or shmhuge will fail.
+
+               mmaphuge also needs to have hugetlbfs mounted and the file
+               location should point there. So if it's mounted in /huge,
+               you would use mem=mmaphuge:/huge/somefile.
 
 exitall                When one job finishes, terminate the rest. The default is
                to wait for each job to finish, sometimes that is not the
                desired action.
 
 bwavgtime=int  Average the calculated bandwidth over the given time. Value
-               is specified in miliseconds.
+               is specified in milliseconds.
 
 create_serialize=bool  If true, serialize the file creating for the jobs.
                        This may be handy to avoid interleaving of data
@@ -390,7 +415,7 @@ 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.
 
-               This option can be used for repeated burnin tests of a
+               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.
 
@@ -445,7 +470,7 @@ cpuload=int If the job is a CPU cycle eater, attempt to use the specified
                percentage of CPU cycles.
 
 cpuchunks=int  If the job is a CPU cycle eater, split the load into
-               cycles of the given time. In miliseconds.
+               cycles of the given time. In milliseconds.
 
 
 6.0 Interpreting the output
@@ -454,7 +479,7 @@ cpuchunks=int       If the job is a CPU cycle eater, split the load into
 fio spits out a lot of output. While running, fio will display the
 status of the jobs created. An example of that would be:
 
-Threads running: 1: [_r] [24.79% done] [eta 00h:01m:31s]
+Threads running: 1: [_r] [24.79% done] [ 13509/  8334 kb/s] [eta 00h:01m:31s]
 
 The characters inside the square brackets denote the current status of
 each thread. The possible values (in typical life cycle order) are:
@@ -476,9 +501,9 @@ E           Thread exited, not reaped by main thread yet.
 _              Thread reaped.
 
 The other values are fairly self explanatory - number of threads
-currently running and doing io, and the estimated completion percentage
-and time for the running group. It's impossible to estimate runtime
-of the following groups (if any).
+currently running and doing io, rate of io since last check, and the estimated
+completion percentage and time for the running group. It's impossible to
+estimate runtime of the following groups (if any).
 
 When fio is done (or interrupted by ctrl-c), it will show the data for
 each thread, group of threads, and disks in that order. For each data
@@ -551,7 +576,7 @@ util=               The disk utilization. A value of 100% means we kept the disk
 ----------------
 
 For scripted usage where you typically want to generate tables or graphs
-of the results, fio can output the results in a comma seperated format.
+of the results, fio can output the results in a comma separated format.
 The format is one long line of values, such as:
 
 client1,0,0,936,331,2894,0,0,0.000000,0.000000,1,170,22.115385,34.290410,16,714,84.252874%,366.500000,566.417819,3496,1237,2894,0,0,0.000000,0.000000,0,246,6.671625,21.436952,0,2534,55.465300%,1406.600000,2008.044216,0.000000%,0.431928%,1109
@@ -563,11 +588,11 @@ Split up, the format is as follows:
                KiB IO, bandwidth (KiB/sec), runtime (msec)
                Submission latency: min, max, mean, deviation
                Completion latency: min, max, mean, deviation
-               Bw: min, max, aggreate percentage of total, mean, deviation
+               Bw: min, max, aggregate percentage of total, mean, deviation
        WRITE status:
                KiB IO, bandwidth (KiB/sec), runtime (msec)
                Submission latency: min, max, mean, deviation
                Completion latency: min, max, mean, deviation
-               Bw: min, max, aggreate percentage of total, mean, deviation
+               Bw: min, max, aggregate percentage of total, mean, deviation
        CPU usage: user, system, context switches