README.rst

   1 Overview and history
   2 --------------------
   3
   4 Fio was originally written to save me the hassle of writing special test case
   5 programs when I wanted to test a specific workload, either for performance
   6 reasons or to find/reproduce a bug. The process of writing such a test app can
   7 be tiresome, especially if you have to do it often.  Hence I needed a tool that
   8 would be able to simulate a given I/O workload without resorting to writing a
   9 tailored test case again and again.
  10
  11 A test work load is difficult to define, though. There can be any number of
  12 processes or threads involved, and they can each be using their own way of
  13 generating I/O. You could have someone dirtying large amounts of memory in a
  14 memory mapped file, or maybe several threads issuing reads using asynchronous
  15 I/O. fio needed to be flexible enough to simulate both of these cases, and many
  16 more.
  17
  18 Fio spawns a number of threads or processes doing a particular type of I/O
  19 action as specified by the user. fio takes a number of global parameters, each
  20 inherited by the thread unless otherwise parameters given to them overriding
  21 that setting is given.  The typical use of fio is to write a job file matching
  22 the I/O load one wants to simulate.
  23
  24
  25 Source
  26 ------
  27
  28 Fio resides in a git repo, the canonical place is:
  29
  30         https://git.kernel.dk/cgit/fio/
  31
  32 Snapshots are frequently generated and :file:`fio-git-*.tar.gz` include the git
  33 meta data as well. Other tarballs are archives of official fio releases.
  34 Snapshots can download from:
  35
  36         https://brick.kernel.dk/snaps/
  37
  38 There are also two official mirrors. Both of these are automatically synced with
  39 the main repository, when changes are pushed. If the main repo is down for some
  40 reason, either one of these is safe to use as a backup:
  41
  42         https://git.kernel.org/pub/scm/linux/kernel/git/axboe/fio.git
  43
  44         https://github.com/axboe/fio.git
  45
  46
  47 Mailing list
  48 ------------
  49
  50 The fio project mailing list is meant for anything related to fio including
  51 general discussion, bug reporting, questions, and development. For bug reporting,
  52 see REPORTING-BUGS.
  53
  54 An automated mail detailing recent commits is automatically sent to the list at
  55 most daily. The list address is fio@vger.kernel.org, subscribe by sending an
  56 email to majordomo@vger.kernel.org with
  57
  58         subscribe fio
  59
  60 in the body of the email. Archives can be found here:
  61
  62         https://www.spinics.net/lists/fio/
  63
  64 or here:
  65
  66         https://lore.kernel.org/fio/
  67
  68 and archives for the old list can be found here:
  69
  70         http://maillist.kernel.dk/fio-devel/
  71
  72
  73 Author
  74 ------
  75
  76 Fio was written by Jens Axboe <axboe@kernel.dk> to enable flexible testing of
  77 the Linux I/O subsystem and schedulers. He got tired of writing specific test
  78 applications to simulate a given workload, and found that the existing I/O
  79 benchmark/test tools out there weren't flexible enough to do what he wanted.
  80
  81 Jens Axboe <axboe@kernel.dk> 20060905
  82
  83
  84 Maintainers
  85 -----------
  86
  87 Fio is maintained by Jens Axboe <axboe@kernel.dk and
  88 Vincent Fu <vincentfu@gmail.com> - however, for reporting bugs please use
  89 the fio reflector or the GitHub page rather than email any of them
  90 directly. By using the public resources, others will be able to learn from
  91 the responses too. Chances are also good that other members will be able to
  92 help with your inquiry as well.
  93
  94
  95 Binary packages
  96 ---------------
  97
  98 Debian:
  99         Starting with Debian "Squeeze", fio packages are part of the official
 100         Debian repository. https://packages.debian.org/search?keywords=fio .
 101
 102 Ubuntu:
 103         Starting with Ubuntu 10.04 LTS (aka "Lucid Lynx"), fio packages are part
 104         of the Ubuntu "universe" repository.
 105         https://packages.ubuntu.com/search?keywords=fio .
 106
 107 Red Hat, Fedora, CentOS & Co:
 108         Starting with Fedora 9/Extra Packages for Enterprise Linux 4, fio
 109         packages are part of the Fedora/EPEL repositories.
 110         https://packages.fedoraproject.org/pkgs/fio/ .
 111
 112 Mandriva:
 113         Mandriva has integrated fio into their package repository, so installing
 114         on that distro should be as easy as typing ``urpmi fio``.
 115
 116 Arch Linux:
 117         An Arch Linux package is provided under the Community sub-repository:
 118         https://www.archlinux.org/packages/?sort=&q=fio
 119
 120 Solaris:
 121         Packages for Solaris are available from OpenCSW. Install their pkgutil
 122         tool (http://www.opencsw.org/get-it/pkgutil/) and then install fio via
 123         ``pkgutil -i fio``.
 124
 125 Windows:
 126         Beginning with fio 3.31 Windows installers for tagged releases are
 127         available on GitHub at https://github.com/axboe/fio/releases. The
 128         latest installers for Windows can also be obtained as GitHub Actions
 129         artifacts by selecting a build from
 130         https://github.com/axboe/fio/actions. These require logging in to a
 131         GitHub account.
 132
 133 BSDs:
 134         Packages for BSDs may be available from their binary package repositories.
 135         Look for a package "fio" using their binary package managers.
 136
 137
 138 Building
 139 --------
 140
 141 Just type::
 142
 143  $ ./configure
 144  $ make
 145  $ make install
 146
 147 Note that GNU make is required. On BSDs it's available from devel/gmake within
 148 ports directory; on Solaris it's in the SUNWgmake package.  On platforms where
 149 GNU make isn't the default, type ``gmake`` instead of ``make``.
 150
 151 Configure will print the enabled options. Note that on Linux based platforms,
 152 the libaio development packages must be installed to use the libaio
 153 engine. Depending on the distro, it is usually called libaio-devel or libaio-dev.
 154
 155 For gfio, gtk 2.18 (or newer), associated glib threads, and cairo are required
 156 to be installed.  gfio isn't built automatically and can be enabled with a
 157 ``--enable-gfio`` option to configure.
 158
 159 To build fio with a cross-compiler::
 160
 161  $ make clean
 162  $ make CROSS_COMPILE=/path/to/toolchain/prefix
 163
 164 Configure will attempt to determine the target platform automatically.
 165
 166 It's possible to build fio for ESX as well, use the ``--esx`` switch to
 167 configure.
 168
 169
 170 Windows
 171 ~~~~~~~
 172
 173 The minimum versions of Windows for building/running fio are Windows 7/Windows
 174 Server 2008 R2. On Windows, Cygwin (https://www.cygwin.com/) is required in
 175 order to build fio. To create an MSI installer package install WiX from
 176 https://wixtoolset.org and run :file:`dobuild.cmd` from the :file:`os/windows`
 177 directory.
 178
 179 How to compile fio on 64-bit Windows:
 180
 181  1. Install Cygwin (https://www.cygwin.com/). Install **make** and all
 182     packages starting with **mingw64-x86_64**. Ensure
 183     **mingw64-x86_64-zlib** are installed if you wish
 184     to enable fio's log compression functionality.
 185  2. Open the Cygwin Terminal.
 186  3. Go to the fio directory (source files).
 187  4. Run ``make clean && make -j``.
 188
 189 To build fio for 32-bit Windows, ensure the -i686 versions of the previously
 190 mentioned -x86_64 packages are installed and run ``./configure
 191 --build-32bit-win`` before ``make``.
 192
 193 It's recommended that once built or installed, fio be run in a Command Prompt or
 194 other 'native' console such as console2, since there are known to be display and
 195 signal issues when running it under a Cygwin shell (see
 196 https://github.com/mintty/mintty/issues/56 and
 197 https://github.com/mintty/mintty/wiki/Tips#inputoutput-interaction-with-alien-programs
 198 for details).
 199
 200
 201 Documentation
 202 ~~~~~~~~~~~~~
 203
 204 Fio uses Sphinx_ to generate documentation from the reStructuredText_ files.
 205 To build HTML formatted documentation run ``make -C doc html`` and direct your
 206 browser to :file:`./doc/output/html/index.html`.  To build manual page run
 207 ``make -C doc man`` and then ``man doc/output/man/fio.1``.  To see what other
 208 output formats are supported run ``make -C doc help``.
 209
 210 .. _reStructuredText: https://www.sphinx-doc.org/rest.html
 211 .. _Sphinx: https://www.sphinx-doc.org
 212
 213
 214 Platforms
 215 ---------
 216
 217 Fio works on (at least) Linux, Solaris, AIX, HP-UX, OSX, NetBSD, OpenBSD,
 218 Windows, FreeBSD, and DragonFly. Some features and/or options may only be
 219 available on some of the platforms, typically because those features only apply
 220 to that platform (like the solarisaio engine, or the splice engine on Linux).
 221
 222 Some features are not available on FreeBSD/Solaris even if they could be
 223 implemented, I'd be happy to take patches for that. An example of that is disk
 224 utility statistics and (I think) huge page support, support for that does exist
 225 in FreeBSD/Solaris.
 226
 227 Fio uses pthread mutexes for signaling and locking and some platforms do not
 228 support process shared pthread mutexes. As a result, on such platforms only
 229 threads are supported. This could be fixed with sysv ipc locking or other
 230 locking alternatives.
 231
 232 Other \*BSD platforms are untested, but fio should work there almost out of the
 233 box. Since I don't do test runs or even compiles on those platforms, your
 234 mileage may vary. Sending me patches for other platforms is greatly
 235 appreciated. There's a lot of value in having the same test/benchmark tool
 236 available on all platforms.
 237
 238 Note that POSIX aio is not enabled by default on AIX. Messages like these::
 239
 240     Symbol resolution failed for /usr/lib/libc.a(posix_aio.o) because:
 241         Symbol _posix_kaio_rdwr (number 2) is not exported from dependent module /unix.
 242
 243 indicate one needs to enable POSIX aio. Run the following commands as root::
 244
 245     # lsdev -C -l posix_aio0
 246         posix_aio0 Defined  Posix Asynchronous I/O
 247     # cfgmgr -l posix_aio0
 248     # lsdev -C -l posix_aio0
 249         posix_aio0 Available  Posix Asynchronous I/O
 250
 251 POSIX aio should work now. To make the change permanent::
 252
 253     # chdev -l posix_aio0 -P -a autoconfig='available'
 254         posix_aio0 changed
 255
 256
 257 Running fio
 258 -----------
 259
 260 Running fio is normally the easiest part - you just give it the job file
 261 (or job files) as parameters::
 262
 263         $ fio [options] [jobfile] ...
 264
 265 and it will start doing what the *jobfile* tells it to do. You can give more
 266 than one job file on the command line, fio will serialize the running of those
 267 files. Internally that is the same as using the :option:`stonewall` parameter
 268 described in the parameter section.
 269
 270 If the job file contains only one job, you may as well just give the parameters
 271 on the command line. The command line parameters are identical to the job
 272 parameters, with a few extra that control global parameters.  For example, for
 273 the job file parameter :option:`iodepth=2 <iodepth>`, the mirror command line
 274 option would be :option:`--iodepth 2 <iodepth>` or :option:`--iodepth=2
 275 <iodepth>`. You can also use the command line for giving more than one job
 276 entry. For each :option:`--name <name>` option that fio sees, it will start a
 277 new job with that name.  Command line entries following a
 278 :option:`--name <name>` entry will apply to that job, until there are no more
 279 entries or a new :option:`--name <name>` entry is seen. This is similar to the
 280 job file options, where each option applies to the current job until a new []
 281 job entry is seen.
 282
 283 fio does not need to run as root, except if the files or devices specified in
 284 the job section requires that. Some other options may also be restricted, such
 285 as memory locking, I/O scheduler switching, and decreasing the nice value.
 286
 287 If *jobfile* is specified as ``-``, the job file will be read from standard
 288 input.