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 When inside a corporate firewall, git:// URL sometimes does not work.
  20 If git:// does not work, use the http protocol instead:
  21
  22         http://git.kernel.dk/fio.git
  23
  24 Snapshots are frequently generated and include the git meta data as well.
  25 Snapshots can download from:
  26
  27         http://brick.kernel.dk/snaps/
  28
  29 There are also two official mirrors. Both of these are synced within
  30 an hour of commits landing at git.kernel.dk. So if the main repo is
  31 down for some reason, either one of those is safe to use:
  32
  33         git://git.kernel.org/pub/scm/linux/kernel/git/axboe/fio.git
  34         https://git.kernel.org/pub/scm/linux/kernel/git/axboe/fio.git
  35
  36 or
  37
  38         https://github.com/axboe/fio.git
  39
  40
  41 Binary packages
  42 ---------------
  43
  44 Debian:
  45 Starting with Debian "Squeeze", fio packages are part of the official
  46 Debian repository. http://packages.debian.org/search?keywords=fio
  47
  48 Ubuntu:
  49 Starting with Ubuntu 10.04 LTS (aka "Lucid Lynx"), fio packages are part
  50 of the Ubuntu "universe" repository.
  51 http://packages.ubuntu.com/search?keywords=fio
  52
  53 Red Hat, CentOS & Co:
  54 Dag Wieërs has RPMs for Red Hat related distros, find them here:
  55 http://dag.wieers.com/rpm/packages/fio/
  56
  57 Mandriva:
  58 Mandriva has integrated fio into their package repository, so installing
  59 on that distro should be as easy as typing 'urpmi fio'.
  60
  61 Solaris:
  62 Packages for Solaris are available from OpenCSW. Install their pkgutil
  63 tool (http://www.opencsw.org/get-it/pkgutil/) and then install fio via
  64 'pkgutil -i fio'.
  65
  66 Windows:
  67 Bruce Cran <bruce@cran.org.uk> has fio packages for Windows at
  68 http://www.bluestop.org/fio/ .
  69
  70
  71 Mailing list
  72 ------------
  73
  74 The fio project mailing list is meant for anything related to fio including
  75 general discussion, bug reporting, questions, and development.
  76
  77 An automated mail detailing recent commits is automatically sent to the
  78 list at most daily. The list address is fio@vger.kernel.org, subscribe
  79 by sending an email to majordomo@vger.kernel.org with
  80
  81         subscribe fio
  82
  83 in the body of the email. Archives can be found here:
  84
  85         http://www.spinics.net/lists/fio/
  86
  87 and archives for the old list can be found here:
  88
  89         http://maillist.kernel.dk/fio-devel/
  90
  91
  92 Building
  93 --------
  94
  95 Just type 'configure', 'make' and 'make install'.
  96
  97 Note that GNU make is required. On BSD it's available from devel/gmake;
  98 on Solaris it's in the SUNWgmake package. On platforms where GNU make
  99 isn't the default, type 'gmake' instead of 'make'.
 100
 101 Configure will print the enabled options. Note that on Linux based
 102 platforms, the libaio development packages must be installed to use
 103 the libaio engine. Depending on distro, it is usually called
 104 libaio-devel or libaio-dev.
 105
 106 For gfio, gtk 2.18 (or newer), associated glib threads, and cairo are required
 107 to be installed.  gfio isn't built automatically and can be enabled
 108 with a --enable-gfio option to configure.
 109
 110 To build FIO with a cross-compiler:
 111  $ make clean
 112  $ make CROSS_COMPILE=/path/to/toolchain/prefix
 113 Configure will attempt to determine the target platform automatically.
 114
 115 It's possible to build fio for ESX as well, use the --esx switch to
 116 configure.
 117
 118
 119 Windows
 120 -------
 121
 122 On Windows, Cygwin (http://www.cygwin.com/) is required in order to
 123 build fio. To create an MSI installer package install WiX 3.8 from
 124 http://wixtoolset.org and run dobuild.cmd from the
 125 os/windows directory.
 126
 127 How to compile fio on 64-bit Windows:
 128
 129  1. Install Cygwin (http://www.cygwin.com/). Install 'make' and all
 130     packages starting with 'mingw64-i686' and 'mingw64-x86_64'.
 131  2. Open the Cygwin Terminal.
 132  3. Go to the fio directory (source files).
 133  4. Run 'make clean && make -j'.
 134
 135 To build fio on 32-bit Windows, run './configure --build-32bit-win' before 'make'.
 136
 137 It's recommended that once built or installed, fio be run in a Command Prompt
 138 or other 'native' console such as console2, since there are known to be display
 139 and signal issues when running it under a Cygwin shell
 140 (see http://code.google.com/p/mintty/issues/detail?id=56 for details).
 141
 142
 143 Command line
 144 ------------
 145
 146 $ fio
 147         --debug                 Enable some debugging options (see below)
 148         --parse-only            Parse options only, don't start any IO
 149         --output                Write output to file
 150         --runtime               Runtime in seconds
 151         --latency-log           Generate per-job latency logs
 152         --bandwidth-log         Generate per-job bandwidth logs
 153         --minimal               Minimal (terse) output
 154         --output-format=type    Output format (terse,json,normal)
 155         --terse-version=type    Terse version output format (default 3, or 2 or 4).
 156         --version               Print version info and exit
 157         --help                  Print this page
 158         --cpuclock-test         Perform test/validation of CPU clock
 159         --crctest[=test]        Test speed of checksum functions
 160         --cmdhelp=cmd           Print command help, "all" for all of them
 161         --enghelp=engine        Print ioengine help, or list available ioengines
 162         --enghelp=engine,cmd    Print help for an ioengine cmd
 163         --showcmd               Turn a job file into command line options
 164         --readonly              Turn on safety read-only checks, preventing
 165                                 writes
 166         --eta=when              When ETA estimate should be printed
 167                                 May be "always", "never" or "auto"
 168         --eta-newline=time      Force a new line for every 'time' period passed
 169         --status-interval=t     Force full status dump every 't' period passed
 170         --section=name          Only run specified section in job file.
 171                                 Multiple sections can be specified.
 172         --alloc-size=kb         Set smalloc pool to this size in kb (def 1024)
 173         --warnings-fatal        Fio parser warnings are fatal
 174         --max-jobs              Maximum number of threads/processes to support
 175         --server=args           Start backend server. See Client/Server section.
 176         --client=host           Connect to specified backend.
 177         --idle-prof=option      Report cpu idleness on a system or percpu basis
 178                                 (option=system,percpu) or run unit work
 179                                 calibration only (option=calibrate).
 180
 181
 182 Any parameters following the options will be assumed to be job files,
 183 unless they match a job file parameter. Multiple job files can be listed
 184 and each job file will be regarded as a separate group. fio will stonewall
 185 execution between each group.
 186
 187 The --readonly option is an extra safety guard to prevent users from
 188 accidentally starting a write workload when that is not desired.  Fio
 189 will only write if rw=write/randwrite/rw/randrw is given.  This extra
 190 safety net can be used as an extra precaution as --readonly will also
 191 enable a write check in the io engine core to prevent writes due to
 192 unknown user space bug(s).
 193
 194 The --debug option triggers additional logging by fio.
 195 Currently, additional logging is available for:
 196
 197         process         Dump info related to processes
 198         file            Dump info related to file actions
 199         io              Dump info related to IO queuing
 200         mem             Dump info related to memory allocations
 201         blktrace        Dump info related to blktrace setup
 202         verify          Dump info related to IO verification
 203         all             Enable all debug options
 204         random          Dump info related to random offset generation
 205         parse           Dump info related to option matching and parsing
 206         diskutil        Dump info related to disk utilization updates
 207         job:x           Dump info only related to job number x
 208         mutex           Dump info only related to mutex up/down ops
 209         profile         Dump info related to profile extensions
 210         time            Dump info related to internal time keeping
 211         net             Dump info related to networking connections
 212         rate            Dump info related to IO rate switching
 213         ? or help       Show available debug options.
 214
 215 One can specify multiple debug options: e.g. --debug=file,mem will enable
 216 file and memory debugging.
 217
 218 The --section option allows one to combine related jobs into one file.
 219 E.g. one job file could define light, moderate, and heavy sections. Tell fio to
 220 run only the "heavy" section by giving --section=heavy command line option.
 221 One can also specify the "write" operations in one section and "verify"
 222 operation in another section.  The --section option only applies to job
 223 sections.  The reserved 'global' section is always parsed and used.
 224
 225 The --alloc-size switch allows one to use a larger pool size for smalloc.
 226 If running large jobs with randommap enabled, fio can run out of memory.
 227 Smalloc is an internal allocator for shared structures from a fixed size
 228 memory pool. The pool size defaults to 1024k and can grow to 128 pools.
 229
 230 NOTE: While running .fio_smalloc.* backing store files are visible in /tmp.
 231
 232
 233 Job file
 234 --------
 235
 236 See the HOWTO file for a complete description of job file syntax and
 237 parameters.  The --cmdhelp option also lists all options. If used with
 238 an option argument, --cmdhelp will detail the given option.  The job file
 239 format is in the ini style format, as that is easy for the user to review
 240 and modify.
 241
 242 This README contains the terse version. Job files can describe big and
 243 complex setups that are not possible with the command line.  Job files
 244 are a good practice even for simple jobs since the file provides an
 245 easily accessed record of the workload and can include comments.
 246
 247 See the examples/ directory for inspiration on how to write job files.  Note
 248 the copyright and license requirements currently apply to examples/ files.
 249
 250
 251 Client/server
 252 ------------
 253
 254 Normally fio is invoked as a stand-alone application on the machine
 255 where the IO workload should be generated. However, the frontend and
 256 backend of fio can be run separately. Ie the fio server can generate
 257 an IO workload on the "Device Under Test" while being controlled from
 258 another machine.
 259
 260 Start the server on the machine which has access to the storage DUT:
 261
 262 fio --server=args
 263
 264 where args defines what fio listens to. The arguments are of the form
 265 'type,hostname or IP,port'. 'type' is either 'ip' (or ip4) for TCP/IP v4,
 266 'ip6' for TCP/IP v6, or 'sock' for a local unix domain socket.
 267 'hostname' is either a hostname or IP address, and 'port' is the port to
 268 listen to (only valid for TCP/IP, not a local socket). Some examples:
 269
 270 1) fio --server
 271
 272    Start a fio server, listening on all interfaces on the default port (8765).
 273
 274 2) fio --server=ip:hostname,4444
 275
 276    Start a fio server, listening on IP belonging to hostname and on port 4444.
 277
 278 3) fio --server=ip6:::1,4444
 279
 280    Start a fio server, listening on IPv6 localhost ::1 and on port 4444.
 281
 282 4) fio --server=,4444
 283
 284    Start a fio server, listening on all interfaces on port 4444.
 285
 286 5) fio --server=1.2.3.4
 287
 288    Start a fio server, listening on IP 1.2.3.4 on the default port.
 289
 290 6) fio --server=sock:/tmp/fio.sock
 291
 292    Start a fio server, listening on the local socket /tmp/fio.sock.
 293
 294 Once a server is running, a "client" can connect to the fio server with:
 295
 296 fio --local-args --client=<server> --remote-args <job file(s)>
 297
 298 where --local-args are arguments for the client where it is
 299 running, 'server' is the connect string, and --remote-args and <job file(s)>
 300 are sent to the server. The 'server' string follows the same format as it
 301 does on the server side, to allow IP/hostname/socket and port strings.
 302
 303 Fio can connect to multiple servers this way:
 304
 305 fio --client=<server1> <job file(s)> --client=<server2> <job file(s)>
 306
 307
 308 Platforms
 309 ---------
 310
 311 Fio works on (at least) Linux, Solaris, AIX, HP-UX, OSX, NetBSD, OpenBSD,
 312 Windows and FreeBSD.  Some features and/or options may only be available on
 313 some of the platforms, typically because those features only apply to that
 314 platform (like the solarisaio engine, or the splice engine on Linux).
 315
 316 Some features are not available on FreeBSD/Solaris even if they could be
 317 implemented, I'd be happy to take patches for that. An example of that is
 318 disk utility statistics and (I think) huge page support, support for that
 319 does exist in FreeBSD/Solaris.
 320
 321 Fio uses pthread mutexes for signalling and locking and FreeBSD does not
 322 support process shared pthread mutexes. As a result, only threads are
 323 supported on FreeBSD. This could be fixed with sysv ipc locking or
 324 other locking alternatives.
 325
 326 Other *BSD platforms are untested, but fio should work there almost out
 327 of the box. Since I don't do test runs or even compiles on those platforms,
 328 your mileage may vary. Sending me patches for other platforms is greatly
 329 appreciated. There's a lot of value in having the same test/benchmark tool
 330 available on all platforms.
 331
 332 Note that POSIX aio is not enabled by default on AIX. Messages like these:
 333
 334     Symbol resolution failed for /usr/lib/libc.a(posix_aio.o) because:
 335         Symbol _posix_kaio_rdwr (number 2) is not exported from dependent module /unix.
 336
 337 indicate one needs to enable POSIX aio. Run the following commands as root:
 338
 339     # lsdev -C -l posix_aio0
 340         posix_aio0 Defined  Posix Asynchronous I/O
 341     # cfgmgr -l posix_aio0
 342     # lsdev -C -l posix_aio0
 343         posix_aio0 Available  Posix Asynchronous I/O
 344
 345 POSIX aio should work now. To make the change permanent:
 346
 347     # chdev -l posix_aio0 -P -a autoconfig='available'
 348         posix_aio0 changed
 349
 350
 351 Author
 352 ------
 353
 354 Fio was written by Jens Axboe <axboe@kernel.dk> to enable flexible testing
 355 of the Linux IO subsystem and schedulers. He got tired of writing
 356 specific test applications to simulate a given workload, and found that
 357 the existing io benchmark/test tools out there weren't flexible enough
 358 to do what he wanted.
 359
 360 Jens Axboe <axboe@kernel.dk> 20060905
 361