README

   1 fio
   2 ---
   3
   4 fio is a tool that will spawn a number of threads or processes doing a
   5 particular type of io action as specified by the user. fio takes a
   6 number of global parameters, each inherited by the thread unless
   7 otherwise parameters given to them overriding that setting is given.
   8 The typical use of fio is to write a job file matching the io load
   9 one wants to simulate.
  10
  11
  12 Source
  13 ------
  14
  15 fio resides in a git repo, the canonical place is:
  16
  17 git://git.kernel.dk/fio.git
  18
  19 The http protocol also works, path is the same.
  20
  21 Snapshots are frequently generated and they include the git meta data as
  22 well. You can download them here:
  23
  24 http://brick.kernel.dk/snaps/
  25
  26 Pascal Bleser <guru@unixtech.be> has fio RPMs in his repository for
  27 SUSE variants, you can find them here:
  28
  29 http://linux01.gwdg.de/~pbleser/rpm-navigation.php?cat=System/fio
  30
  31 Dag Wieërs has RPMs for Red Hat related distros, find them here:
  32
  33 http://dag.wieers.com/rpm/packages/fio/
  34
  35 Mandriva has integrated fio into their package repository, so installing
  36 on that distro should be as easy as typing 'urpmi fio'.
  37
  38
  39 Mailing list
  40 ------------
  41
  42 There's a mailing list associated with fio. It's meant for general
  43 discussion, bug reporting, questions - basically anything that has to
  44 do with fio. An automated mail detailing recent commits is automatically
  45 sent to the list at most daily. The list address is fio-devel@kernel.dk,
  46 subscribe by sending an empty email to fio-devel+subscribe@kernel.dk.
  47
  48
  49 Building
  50 --------
  51
  52 Just type 'make' and 'make install'. If on FreeBSD, for now you have to
  53 specify the FreeBSD Makefile with -f, eg:
  54
  55 $ make -f Makefile.Freebsd && make -f Makefile.FreeBSD install
  56
  57 Likewise with OpenSolaris, use the Makefile.solaris to compile there.
  58 This might change in the future if I opt for an autoconf type setup.
  59
  60
  61 Command line
  62 ------------
  63
  64 $ fio
  65         --debug         Enable some debugging options (see below)
  66         --output        Write output to file
  67         --timeout       Runtime in seconds
  68         --latency-log   Generate per-job latency logs
  69         --bandwidth-log Generate per-job bandwidth logs
  70         --minimal       Minimal (terse) output
  71         --version       Print version info and exit
  72         --help          Print this page
  73         --cmdhelp=cmd   Print command help, "all" for all of them
  74         --showcmd       Turn a job file into command line options
  75         --readonly      Turn on safety read-only checks, preventing writes
  76         --eta=when      When ETA estimate should be printed
  77                         May be "always", "never" or "auto"
  78         --section=name  Only run specified section in job file
  79
  80
  81 Any parameters following the options will be assumed to be job files,
  82 unless they match a job file parameter. You can add as many as you want,
  83 each job file will be regarded as a separate group and fio will stonewall
  84 its execution.
  85
  86 The --readonly switch is an extra safety guard to prevent accidentically
  87 turning on a write setting when that is not desired. Fio will only write
  88 if rw=write/randwrite/rw/randrw is given, but this extra safety net can
  89 be used as an extra precaution. It will also enable a write check in the
  90 io engine core to prevent an accidental write due to a fio bug.
  91
  92 The debug switch allows adding options that trigger certain logging
  93 options in fio. Currently the options are:
  94
  95         process         Dump info related to processes
  96         file            Dump info related to file actions
  97         io              Dump info related to IO queuing
  98         mem             Dump info related to memory allocations
  99         blktrace        Dump info related to blktrace setup
 100         verify          Dump info related to IO verification
 101         all             Enable all debug options
 102         ? or help       Show available debug options.
 103
 104 You can specify as many as you want, eg --debug=file,mem will enable
 105 file and memory debugging.
 106
 107 The section switch is meant to make it easier to ship a bigger job file
 108 instead of several smaller ones. Say you define a job file with light,
 109 moderate, and heavy parts. Then you can ask fio to run the given part
 110 only by giving it a --section=heavy command line option. The section
 111 option only applies to job sections, the reserved 'global' section is
 112 always parsed and taken into account.
 113
 114
 115 Job file
 116 --------
 117
 118 See the HOWTO file for a more detailed description of parameters and what
 119 they mean. This file contains the terse version. You can describe big and
 120 complex setups with the command line, but generally it's a lot easier to
 121 just write a simple job file to describe the workload. The job file format
 122 is in the ini style format, as that is easy to read and write for the user.
 123
 124 The job file parameters are:
 125
 126         name=x          Use 'x' as the identifier for this job.
 127         description=x   'x' is a text description of the job.
 128         directory=x     Use 'x' as the top level directory for storing files
 129         filename=x      Force the use of 'x' as the filename for all files
 130                         in this thread. If not given, fio will make up
 131                         a suitable filename based on the thread and file
 132                         number.
 133         rw=x            'x' may be: read, randread, write, randwrite,
 134                         rw (read-write mix), randrw (read-write random mix)
 135         rwmixcycle=x    Base cycle for switching between read and write
 136                         in msecs.
 137         rwmixread=x     'x' percentage of rw mix ios will be reads. If
 138                         rwmixwrite is also given, the last of the two will
 139                          be used if they don't add up to 100%.
 140         rwmixwrite=x    'x' percentage of rw mix ios will be writes. See
 141                         rwmixread.
 142         rand_repeatable=x  The sequence of random io blocks can be repeatable
 143                         across runs, if 'x' is 1.
 144         size=x          Set file size to x bytes (x string can include k/m/g)
 145         ioengine=x      'x' may be: aio/libaio/linuxaio for Linux aio,
 146                         posixaio for POSIX aio, sync for regular read/write io,
 147                         psync for regular pread/pwrite io, vsync for regular
 148                         readv/writev (with queuing emulation) mmap for mmap'ed
 149                         io, syslet-rw for syslet driven read/write, splice for
 150                         using splice/vmsplice, sgio for direct SG_IO io, net
 151                         for network io, or cpuio for a cycler burner load. sgio
 152                         only works on Linux on SCSI (or SCSI-like devices, such
 153                         as usb-storage or sata/libata driven) devices. Fio also
 154                         has a null io engine, which is mainly used for testing
 155                         fio itself.
 156
 157         iodepth=x       For async io, allow 'x' ios in flight
 158         overwrite=x     If 'x', layout a write file first.
 159         nrfiles=x       Spread io load over 'x' number of files per job,
 160                         if possible.
 161         prio=x          Run io at prio X, 0-7 is the kernel allowed range
 162         prioclass=x     Run io at prio class X
 163         bs=x            Use 'x' for thread blocksize. May include k/m postfix.
 164         bsrange=x-y     Mix thread block sizes randomly between x and y. May
 165                         also include k/m postfix.
 166         direct=x        1 for direct IO, 0 for buffered IO
 167         thinktime=x     "Think" x usec after each io
 168         rate=x          Throttle rate to x KiB/sec
 169         ratemin=x       Quit if rate of x KiB/sec can't be met
 170         ratecycle=x     ratemin averaged over x msecs
 171         cpumask=x       Only allow job to run on CPUs defined by mask.
 172         cpus_allowed=x  Like 'cpumask', but allow text setting of CPU affinity.
 173         fsync=x         If writing with buffered IO, fsync after every
 174                         'x' blocks have been written.
 175         end_fsync=x     If 'x', run fsync() after end-of-job.
 176         startdelay=x    Start this thread x seconds after startup
 177         runtime=x       Terminate x seconds after startup. Can include a
 178                         normal time suffix if not given in seconds, such as
 179                         'm' for minutes, 'h' for hours, and 'd' for days.
 180         offset=x        Start io at offset x (x string can include k/m/g)
 181         invalidate=x    Invalidate page cache for file prior to doing io
 182         sync=x          Use sync writes if x and writing buffered IO.
 183         mem=x           If x == malloc, use malloc for buffers. If x == shm,
 184                         use shared memory for buffers. If x == mmap, use
 185                         anonymous mmap.
 186         exitall         When one thread quits, terminate the others
 187         bwavgtime=x     Average bandwidth stats over an x msec window.
 188         create_serialize=x      If 'x', serialize file creation.
 189         create_fsync=x  If 'x', run fsync() after file creation.
 190         unlink          If set, unlink files when done.
 191         loops=x         Run the job 'x' number of times.
 192         verify=x        If 'x' == md5, use md5 for verifies. If 'x' == crc32,
 193                         use crc32 for verifies. md5 is 'safer', but crc32 is
 194                         a lot faster. Only makes sense for writing to a file.
 195         stonewall       Wait for preceeding jobs to end before running.
 196         numjobs=x       Create 'x' similar entries for this job
 197         thread          Use pthreads instead of forked jobs
 198         zonesize=x
 199         zoneskip=y      Zone options must be paired. If given, the job
 200                         will skip y bytes for every x read/written. This
 201                         can be used to gauge hard drive speed over the entire
 202                         platter, without reading everything. Both x/y can
 203                         include k/m/g suffix.
 204         iolog=x         Open and read io pattern from file 'x'. The file must
 205                         contain one io action per line in the following format:
 206                         rw, offset, length
 207                         where with rw=0/1 for read/write, and the offset
 208                         and length entries being in bytes.
 209         write_iolog=x   Write an iolog to file 'x' in the same format as iolog.
 210                         The iolog options are exclusive, if both given the
 211                         read iolog will be performed.
 212         write_bw_log    Write a bandwidth log.
 213         write_lat_log   Write a latency log.
 214         lockmem=x       Lock down x amount of memory on the machine, to
 215                         simulate a machine with less memory available. x can
 216                         include k/m/g suffix.
 217         nice=x          Run job at given nice value.
 218         exec_prerun=x   Run 'x' before job io is begun.
 219         exec_postrun=x  Run 'x' after job io has finished.
 220         ioscheduler=x   Use ioscheduler 'x' for this job.
 221         cpuload=x       For a CPU io thread, percentage of CPU time to attempt
 222                         to burn.
 223         cpuchunks=x     Split burn cycles into pieces of x usecs.
 224
 225
 226 Author
 227 ------
 228
 229 Fio was written by Jens Axboe <axboe@kernel.dk> to enable flexible testing
 230 of the Linux IO subsystem and schedulers. He got tired of writing
 231 specific test applications to simulate a given workload, and found that
 232 the existing io benchmark/test tools out there weren't flexible enough
 233 to do what he wanted.
 234
 235 Jens Axboe <axboe@kernel.dk> 20060905
 236