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