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
  27 Binary packages
  28 ---------------
  29
  30 Debian:
  31 Starting with Debian "Squeeze", fio packages are part of the official
  32 Debian repository. http://packages.debian.org/search?keywords=fio
  33
  34 Ubuntu:
  35 Starting with Ubuntu 10.04 LTS (aka "Lucid Lynx"), fio packages are part
  36 of the Ubuntu "universe" repository.
  37 http://packages.ubuntu.com/search?keywords=fio
  38
  39 SUSE:
  40 Pascal Bleser <guru@unixtech.be> has fio RPMs in his repository for SUSE
  41 variants, you can find them here:
  42 http://linux01.gwdg.de/~pbleser/rpm-navigation.php?cat=System/fio
  43
  44 Red Hat, CentOS & Co:
  45 Dag Wieërs has RPMs for Red Hat related distros, find them here:
  46 http://dag.wieers.com/rpm/packages/fio/
  47
  48 Mandriva:
  49 Mandriva has integrated fio into their package repository, so installing
  50 on that distro should be as easy as typing 'urpmi fio'.
  51
  52 Solaris:
  53 Packages for Solaris are available from OpenCSW. Install their pkgutil
  54 tool (http://www.opencsw.org/get-it/pkgutil/) and then install fio via
  55 'pkgutil -i fio'.
  56
  57 Windows:
  58 Bruce Cran <bruce@cran.org.uk> has fio packages for Windows at
  59 http://www.bluestop.org/fio .
  60
  61
  62 Mailing list
  63 ------------
  64
  65 There's a mailing list associated with fio. It's meant for general
  66 discussion, bug reporting, questions, and development - basically anything
  67 that has to do with fio. An automated mail detailing recent commits is
  68 automatically sent to the list at most daily. The list address is
  69 fio@vger.kernel.org, subscribe by sending an email to
  70 majordomo@vger.kernel.org with
  71
  72 subscribe fio
  73
  74 in the body of the email. Archives can be found here:
  75
  76 http://www.spinics.net/lists/fio/
  77
  78 and archives for the old list can be found here:
  79
  80 http://maillist.kernel.dk/fio-devel/
  81
  82
  83 Building
  84 --------
  85
  86 Just type 'make' and 'make install'. If on BSD, for now you have to
  87 specify the BSD Makefile with -f and use gmake (not make), eg:
  88
  89 $ gmake -f Makefile.FreeBSD && gmake -f Makefile.FreeBSD install
  90
  91 Same goes for AIX:
  92
  93 $ gmake -f Makefile.aix && gmake -f Makefile.aix install
  94
  95 Likewise with OpenSolaris, use the Makefile.solaris to compile there.
  96 The OpenSolaris make should work fine. This might change in the
  97 future if I opt for an autoconf type setup.
  98
  99 If your compile fails with an error like this:
 100
 101     CC gettime.o
 102 In file included from fio.h:23,
 103                  from gettime.c:8:
 104 os/os.h:15:20: error: libaio.h: No such file or directory
 105 In file included from gettime.c:8:
 106 fio.h:119: error: field 'iocb' has incomplete type
 107 make: *** [gettime.o] Error 1
 108
 109 Check that you have the libaio development package installed. On RPM
 110 based distros, it's typically called libaio-devel.
 111
 112
 113 Command line
 114 ------------
 115
 116 $ fio
 117         --debug         Enable some debugging options (see below)
 118         --output        Write output to file
 119         --timeout       Runtime in seconds
 120         --latency-log   Generate per-job latency logs
 121         --bandwidth-log Generate per-job bandwidth logs
 122         --minimal       Minimal (terse) output
 123         --version       Print version info and exit
 124         --help          Print this page
 125         --cmdhelp=cmd   Print command help, "all" for all of them
 126         --showcmd       Turn a job file into command line options
 127         --readonly      Turn on safety read-only checks, preventing writes
 128         --eta=when      When ETA estimate should be printed
 129                         May be "always", "never" or "auto"
 130         --section=name  Only run specified section in job file
 131         --alloc-size=kb Set smalloc pool to this size in kb (def 1024)
 132
 133
 134 Any parameters following the options will be assumed to be job files,
 135 unless they match a job file parameter. You can add as many as you want,
 136 each job file will be regarded as a separate group and fio will stonewall
 137 its execution.
 138
 139 The --readonly switch is an extra safety guard to prevent accidentally
 140 turning on a write setting when that is not desired. Fio will only write
 141 if rw=write/randwrite/rw/randrw is given, but this extra safety net can
 142 be used as an extra precaution. It will also enable a write check in the
 143 io engine core to prevent an accidental write due to a fio bug.
 144
 145 The debug switch allows adding options that trigger certain logging
 146 options in fio. Currently the options are:
 147
 148         process         Dump info related to processes
 149         file            Dump info related to file actions
 150         io              Dump info related to IO queuing
 151         mem             Dump info related to memory allocations
 152         blktrace        Dump info related to blktrace setup
 153         verify          Dump info related to IO verification
 154         all             Enable all debug options
 155         random          Dump info related to random offset generation
 156         parse           Dump info related to option matching and parsing
 157         diskutil        Dump info related to disk utilization updates
 158         job:x           Dump info only related to job number x
 159         mutex           Dump info only related to mutex up/down ops
 160         profile         Dump info related to profile extensions
 161         time            Dump info related to internal time keeping
 162         ? or help       Show available debug options.
 163
 164 You can specify as many as you want, eg --debug=file,mem will enable
 165 file and memory debugging.
 166
 167 The section switch is meant to make it easier to ship a bigger job file
 168 instead of several smaller ones. Say you define a job file with light,
 169 moderate, and heavy parts. Then you can ask fio to run the given part
 170 only by giving it a --section=heavy command line option. The section
 171 option only applies to job sections, the reserved 'global' section is
 172 always parsed and taken into account.
 173
 174 Fio has an internal allocator for shared memory called smalloc. It
 175 allocates shared structures from this pool. The pool defaults to 1024k
 176 in size, and can grow to 128 pools. If running large jobs with randommap
 177 enabled it can run out of memory, in which case the --alloc-size switch
 178 is handy for starting with a larger pool size. The backing store is
 179 files in /tmp. Fio cleans up after itself, while it is running you
 180 may see .fio_smalloc.* files in /tmp.
 181
 182
 183 Job file
 184 --------
 185
 186 See the HOWTO file for a more detailed description of parameters and what
 187 they mean. This file contains the terse version. You can describe big and
 188 complex setups with the command line, but generally it's a lot easier to
 189 just write a simple job file to describe the workload. The job file format
 190 is in the ini style format, as that is easy to read and write for the user.
 191
 192 The job file parameters are:
 193
 194         name=x          Use 'x' as the identifier for this job.
 195         description=x   'x' is a text description of the job.
 196         directory=x     Use 'x' as the top level directory for storing files
 197         filename=x      Force the use of 'x' as the filename for all files
 198                         in this thread. If not given, fio will make up
 199                         a suitable filename based on the thread and file
 200                         number.
 201         rw=x            'x' may be: read, randread, write, randwrite,
 202                         rw (read-write mix), randrw (read-write random mix)
 203         rwmixcycle=x    Base cycle for switching between read and write
 204                         in msecs.
 205         rwmixread=x     'x' percentage of rw mix ios will be reads. If
 206                         rwmixwrite is also given, the last of the two will
 207                          be used if they don't add up to 100%.
 208         rwmixwrite=x    'x' percentage of rw mix ios will be writes. See
 209                         rwmixread.
 210         rand_repeatable=x  The sequence of random io blocks can be repeatable
 211                         across runs, if 'x' is 1.
 212         size=x          Set file size to x bytes (x string can include k/m/g)
 213         ioengine=x      'x' may be: aio/libaio/linuxaio for Linux aio,
 214                         posixaio for POSIX aio, solarisaio for Solaris
 215                         native async IO, windowsaio for Windows native async IO,
 216                         sync for regular read/write io,
 217                         psync for regular pread/pwrite io, vsync for regular
 218                         readv/writev (with queuing emulation) mmap for mmap'ed
 219                         io, syslet-rw for syslet driven read/write, splice for
 220                         using splice/vmsplice, sg for direct SG_IO io, net
 221                         for network io, or cpuio for a cycler burner load. sg
 222                         only works on Linux on SCSI (or SCSI-like devices, such
 223                         as usb-storage or sata/libata driven) devices. Fio also
 224                         has a null io engine, which is mainly used for testing
 225                         fio itself.
 226
 227         iodepth=x       For async io, allow 'x' ios in flight
 228         overwrite=x     If 'x', layout a write file first.
 229         nrfiles=x       Spread io load over 'x' number of files per job,
 230                         if possible.
 231         prio=x          Run io at prio X, 0-7 is the kernel allowed range
 232         prioclass=x     Run io at prio class X
 233         bs=x            Use 'x' for thread blocksize. May include k/m postfix.
 234         bsrange=x-y     Mix thread block sizes randomly between x and y. May
 235                         also include k/m postfix.
 236         direct=x        1 for direct IO, 0 for buffered IO
 237         thinktime=x     "Think" x usec after each io
 238         rate=x          Throttle rate to x KB/sec
 239         ratemin=x       Quit if rate of x KB/sec can't be met
 240         ratecycle=x     ratemin averaged over x msecs
 241         cpumask=x       Only allow job to run on CPUs defined by mask.
 242         cpus_allowed=x  Like 'cpumask', but allow text setting of CPU affinity.
 243         fsync=x         If writing with buffered IO, fsync after every
 244                         'x' blocks have been written.
 245         end_fsync=x     If 'x', run fsync() after end-of-job.
 246         startdelay=x    Start this thread x seconds after startup
 247         runtime=x       Terminate x seconds after startup. Can include a
 248                         normal time suffix if not given in seconds, such as
 249                         'm' for minutes, 'h' for hours, and 'd' for days.
 250         offset=x        Start io at offset x (x string can include k/m/g)
 251         invalidate=x    Invalidate page cache for file prior to doing io
 252         sync=x          Use sync writes if x and writing buffered IO.
 253         mem=x           If x == malloc, use malloc for buffers. If x == shm,
 254                         use shared memory for buffers. If x == mmap, use
 255                         anonymous mmap.
 256         exitall         When one thread quits, terminate the others
 257         bwavgtime=x     Average bandwidth stats over an x msec window.
 258         create_serialize=x      If 'x', serialize file creation.
 259         create_fsync=x  If 'x', run fsync() after file creation.
 260         unlink          If set, unlink files when done.
 261         loops=x         Run the job 'x' number of times.
 262         verify=x        If 'x' == md5, use md5 for verifies. If 'x' == crc32,
 263                         use crc32 for verifies. md5 is 'safer', but crc32 is
 264                         a lot faster. Only makes sense for writing to a file.
 265                         For other types of checksumming, see HOWTO.
 266         stonewall       Wait for preceeding jobs to end before running.
 267         numjobs=x       Create 'x' similar entries for this job
 268         thread          Use pthreads instead of forked jobs
 269         zonesize=x
 270         zoneskip=y      Zone options must be paired. If given, the job
 271                         will skip y bytes for every x read/written. This
 272                         can be used to gauge hard drive speed over the entire
 273                         platter, without reading everything. Both x/y can
 274                         include k/m/g suffix.
 275         iolog=x         Open and read io pattern from file 'x'. The file must
 276                         contain one io action per line in the following format:
 277                         rw, offset, length
 278                         where with rw=0/1 for read/write, and the offset
 279                         and length entries being in bytes.
 280         write_iolog=x   Write an iolog to file 'x' in the same format as iolog.
 281                         The iolog options are exclusive, if both given the
 282                         read iolog will be performed.  Specify a separate file
 283                         for each job, otherwise the iologs will be interspersed
 284                         and the file may be corrupt.
 285         write_bw_log    Write a bandwidth log.
 286         write_lat_log   Write a latency log.
 287         lockmem=x       Lock down x amount of memory on the machine, to
 288                         simulate a machine with less memory available. x can
 289                         include k/m/g suffix.
 290         nice=x          Run job at given nice value.
 291         exec_prerun=x   Run 'x' before job io is begun.
 292         exec_postrun=x  Run 'x' after job io has finished.
 293         ioscheduler=x   Use ioscheduler 'x' for this job.
 294         cpuload=x       For a CPU io thread, percentage of CPU time to attempt
 295                         to burn.
 296         cpuchunks=x     Split burn cycles into pieces of x usecs.
 297
 298
 299
 300 Platforms
 301 ---------
 302
 303 Fio works on (at least) Linux, Solaris, AIX, OSX, NetBSD, Windows and FreeBSD.
 304 Some features and/or options may only be available on some of the platforms,
 305 typically because those features only apply to that platform (like the
 306 solarisaio engine, or the splice engine on Linux).
 307
 308 Some features are not available on FreeBSD/Solaris even if they could be
 309 implemented, I'd be happy to take patches for that. An example of that is
 310 disk utility statistics and (I think) huge page support, support for that
 311 does exist in FreeBSD/Solaris.
 312
 313 Fio uses pthread mutexes for signalling and locking and FreeBSD does not
 314 support process shared pthread mutexes. As a result, only threads are
 315 supported on FreeBSD. This could be fixed with sysv ipc locking or
 316 other locking alternatives.
 317
 318 Other *BSD platforms are untested, but fio should work there almost out
 319 of the box. Since I don't do test runs or even compiles on those platforms,
 320 your mileage may vary. Sending me patches for other platforms is greatly
 321 appreciated. There's a lot of value in having the same test/benchmark tool
 322 available on all platforms.
 323
 324 Note that POSIX aio is not enabled by default on AIX. If you get messages like:
 325
 326     Symbol resolution failed for /usr/lib/libc.a(posix_aio.o) because:
 327         Symbol _posix_kaio_rdwr (number 2) is not exported from dependent module /unix.
 328
 329 you need to enable POSIX aio. Run the following commands as root:
 330
 331     # lsdev -C -l posix_aio0
 332         posix_aio0 Defined  Posix Asynchronous I/O
 333     # cfgmgr -l posix_aio0
 334     # lsdev -C -l posix_aio0
 335         posix_aio0 Available  Posix Asynchronous I/O
 336
 337 POSIX aio should work now. To make the change permanent:
 338
 339     # chdev -l posix_aio0 -P -a autoconfig='available'
 340         posix_aio0 changed
 341
 342
 343 Author
 344 ------
 345
 346 Fio was written by Jens Axboe <axboe@kernel.dk> to enable flexible testing
 347 of the Linux IO subsystem and schedulers. He got tired of writing
 348 specific test applications to simulate a given workload, and found that
 349 the existing io benchmark/test tools out there weren't flexible enough
 350 to do what he wanted.
 351
 352 Jens Axboe <axboe@kernel.dk> 20060905
 353