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 If your compile fails with an error like this:
  61
  62     CC gettime.o
  63 In file included from fio.h:23,
  64                  from gettime.c:8:
  65 os/os.h:15:20: error: libaio.h: No such file or directory
  66 In file included from gettime.c:8:
  67 fio.h:119: error: field 'iocb' has incomplete type
  68 make: *** [gettime.o] Error 1
  69
  70 Check that you have the libaio development package installed. On RPM
  71 based distros, it's typically called libaio-devel.
  72
  73
  74 Command line
  75 ------------
  76
  77 $ fio
  78         --debug         Enable some debugging options (see below)
  79         --output        Write output to file
  80         --timeout       Runtime in seconds
  81         --latency-log   Generate per-job latency logs
  82         --bandwidth-log Generate per-job bandwidth logs
  83         --minimal       Minimal (terse) output
  84         --version       Print version info and exit
  85         --help          Print this page
  86         --cmdhelp=cmd   Print command help, "all" for all of them
  87         --showcmd       Turn a job file into command line options
  88         --readonly      Turn on safety read-only checks, preventing writes
  89         --eta=when      When ETA estimate should be printed
  90                         May be "always", "never" or "auto"
  91         --section=name  Only run specified section in job file
  92         --alloc-size=kb Set smalloc pool to this size in kb (def 1024)
  93
  94
  95 Any parameters following the options will be assumed to be job files,
  96 unless they match a job file parameter. You can add as many as you want,
  97 each job file will be regarded as a separate group and fio will stonewall
  98 its execution.
  99
 100 The --readonly switch is an extra safety guard to prevent accidentically
 101 turning on a write setting when that is not desired. Fio will only write
 102 if rw=write/randwrite/rw/randrw is given, but this extra safety net can
 103 be used as an extra precaution. It will also enable a write check in the
 104 io engine core to prevent an accidental write due to a fio bug.
 105
 106 The debug switch allows adding options that trigger certain logging
 107 options in fio. Currently the options are:
 108
 109         process         Dump info related to processes
 110         file            Dump info related to file actions
 111         io              Dump info related to IO queuing
 112         mem             Dump info related to memory allocations
 113         blktrace        Dump info related to blktrace setup
 114         verify          Dump info related to IO verification
 115         all             Enable all debug options
 116         random          Dump info related to random offset generation
 117         parse           Dump info related to option matching and parsing
 118         diskutil        Dump info related to disk utilization updates
 119         ? or help       Show available debug options.
 120
 121 You can specify as many as you want, eg --debug=file,mem will enable
 122 file and memory debugging.
 123
 124 The section switch is meant to make it easier to ship a bigger job file
 125 instead of several smaller ones. Say you define a job file with light,
 126 moderate, and heavy parts. Then you can ask fio to run the given part
 127 only by giving it a --section=heavy command line option. The section
 128 option only applies to job sections, the reserved 'global' section is
 129 always parsed and taken into account.
 130
 131 Fio has an internal allocator for shared memory called smalloc. It
 132 allocates shared structures from this pool. The pool defaults to 1024k
 133 in size, and can grow to 32 pools. If running large jobs with randommap
 134 enabled it can run out of memory, in which case the --alloc-size switch
 135 is handy for starting with a larger pool size.
 136
 137
 138 Job file
 139 --------
 140
 141 See the HOWTO file for a more detailed description of parameters and what
 142 they mean. This file contains the terse version. You can describe big and
 143 complex setups with the command line, but generally it's a lot easier to
 144 just write a simple job file to describe the workload. The job file format
 145 is in the ini style format, as that is easy to read and write for the user.
 146
 147 The job file parameters are:
 148
 149         name=x          Use 'x' as the identifier for this job.
 150         description=x   'x' is a text description of the job.
 151         directory=x     Use 'x' as the top level directory for storing files
 152         filename=x      Force the use of 'x' as the filename for all files
 153                         in this thread. If not given, fio will make up
 154                         a suitable filename based on the thread and file
 155                         number.
 156         rw=x            'x' may be: read, randread, write, randwrite,
 157                         rw (read-write mix), randrw (read-write random mix)
 158         rwmixcycle=x    Base cycle for switching between read and write
 159                         in msecs.
 160         rwmixread=x     'x' percentage of rw mix ios will be reads. If
 161                         rwmixwrite is also given, the last of the two will
 162                          be used if they don't add up to 100%.
 163         rwmixwrite=x    'x' percentage of rw mix ios will be writes. See
 164                         rwmixread.
 165         rand_repeatable=x  The sequence of random io blocks can be repeatable
 166                         across runs, if 'x' is 1.
 167         size=x          Set file size to x bytes (x string can include k/m/g)
 168         ioengine=x      'x' may be: aio/libaio/linuxaio for Linux aio,
 169                         posixaio for POSIX aio, sync for regular read/write io,
 170                         psync for regular pread/pwrite io, vsync for regular
 171                         readv/writev (with queuing emulation) mmap for mmap'ed
 172                         io, syslet-rw for syslet driven read/write, splice for
 173                         using splice/vmsplice, sgio for direct SG_IO io, net
 174                         for network io, or cpuio for a cycler burner load. sgio
 175                         only works on Linux on SCSI (or SCSI-like devices, such
 176                         as usb-storage or sata/libata driven) devices. Fio also
 177                         has a null io engine, which is mainly used for testing
 178                         fio itself.
 179
 180         iodepth=x       For async io, allow 'x' ios in flight
 181         overwrite=x     If 'x', layout a write file first.
 182         nrfiles=x       Spread io load over 'x' number of files per job,
 183                         if possible.
 184         prio=x          Run io at prio X, 0-7 is the kernel allowed range
 185         prioclass=x     Run io at prio class X
 186         bs=x            Use 'x' for thread blocksize. May include k/m postfix.
 187         bsrange=x-y     Mix thread block sizes randomly between x and y. May
 188                         also include k/m postfix.
 189         direct=x        1 for direct IO, 0 for buffered IO
 190         thinktime=x     "Think" x usec after each io
 191         rate=x          Throttle rate to x KiB/sec
 192         ratemin=x       Quit if rate of x KiB/sec can't be met
 193         ratecycle=x     ratemin averaged over x msecs
 194         cpumask=x       Only allow job to run on CPUs defined by mask.
 195         cpus_allowed=x  Like 'cpumask', but allow text setting of CPU affinity.
 196         fsync=x         If writing with buffered IO, fsync after every
 197                         'x' blocks have been written.
 198         end_fsync=x     If 'x', run fsync() after end-of-job.
 199         startdelay=x    Start this thread x seconds after startup
 200         runtime=x       Terminate x seconds after startup. Can include a
 201                         normal time suffix if not given in seconds, such as
 202                         'm' for minutes, 'h' for hours, and 'd' for days.
 203         offset=x        Start io at offset x (x string can include k/m/g)
 204         invalidate=x    Invalidate page cache for file prior to doing io
 205         sync=x          Use sync writes if x and writing buffered IO.
 206         mem=x           If x == malloc, use malloc for buffers. If x == shm,
 207                         use shared memory for buffers. If x == mmap, use
 208                         anonymous mmap.
 209         exitall         When one thread quits, terminate the others
 210         bwavgtime=x     Average bandwidth stats over an x msec window.
 211         create_serialize=x      If 'x', serialize file creation.
 212         create_fsync=x  If 'x', run fsync() after file creation.
 213         unlink          If set, unlink files when done.
 214         loops=x         Run the job 'x' number of times.
 215         verify=x        If 'x' == md5, use md5 for verifies. If 'x' == crc32,
 216                         use crc32 for verifies. md5 is 'safer', but crc32 is
 217                         a lot faster. Only makes sense for writing to a file.
 218         stonewall       Wait for preceeding jobs to end before running.
 219         numjobs=x       Create 'x' similar entries for this job
 220         thread          Use pthreads instead of forked jobs
 221         zonesize=x
 222         zoneskip=y      Zone options must be paired. If given, the job
 223                         will skip y bytes for every x read/written. This
 224                         can be used to gauge hard drive speed over the entire
 225                         platter, without reading everything. Both x/y can
 226                         include k/m/g suffix.
 227         iolog=x         Open and read io pattern from file 'x'. The file must
 228                         contain one io action per line in the following format:
 229                         rw, offset, length
 230                         where with rw=0/1 for read/write, and the offset
 231                         and length entries being in bytes.
 232         write_iolog=x   Write an iolog to file 'x' in the same format as iolog.
 233                         The iolog options are exclusive, if both given the
 234                         read iolog will be performed.
 235         write_bw_log    Write a bandwidth log.
 236         write_lat_log   Write a latency log.
 237         lockmem=x       Lock down x amount of memory on the machine, to
 238                         simulate a machine with less memory available. x can
 239                         include k/m/g suffix.
 240         nice=x          Run job at given nice value.
 241         exec_prerun=x   Run 'x' before job io is begun.
 242         exec_postrun=x  Run 'x' after job io has finished.
 243         ioscheduler=x   Use ioscheduler 'x' for this job.
 244         cpuload=x       For a CPU io thread, percentage of CPU time to attempt
 245                         to burn.
 246         cpuchunks=x     Split burn cycles into pieces of x usecs.
 247
 248
 249 Author
 250 ------
 251
 252 Fio was written by Jens Axboe <axboe@kernel.dk> to enable flexible testing
 253 of the Linux IO subsystem and schedulers. He got tired of writing
 254 specific test applications to simulate a given workload, and found that
 255 the existing io benchmark/test tools out there weren't flexible enough
 256 to do what he wanted.
 257
 258 Jens Axboe <axboe@kernel.dk> 20060905
 259