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