Commit | Line | Data |
---|---|---|
f80dba8d MT |
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 an | |
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. | |
ebac4655 | 23 | |
2b02b546 JA |
24 | |
25 | Source | |
26 | ------ | |
27 | ||
f80dba8d | 28 | Fio resides in a git repo, the canonical place is: |
2b02b546 | 29 | |
4649b352 | 30 | git://git.kernel.dk/fio.git |
97f049c9 | 31 | |
4649b352 GG |
32 | When inside a corporate firewall, git:// URL sometimes does not work. |
33 | If git:// does not work, use the http protocol instead: | |
a9bac3f9 | 34 | |
4649b352 | 35 | http://git.kernel.dk/fio.git |
2b02b546 | 36 | |
f80dba8d | 37 | Snapshots are frequently generated and :file:`fio-git-*.tar.gz` include the git |
88d398d0 | 38 | meta data as well. Other tarballs are archives of official fio releases. |
4649b352 | 39 | Snapshots can download from: |
2b02b546 | 40 | |
4649b352 | 41 | http://brick.kernel.dk/snaps/ |
2b02b546 | 42 | |
f80dba8d MT |
43 | There are also two official mirrors. Both of these are automatically synced with |
44 | the main repository, when changes are pushed. If the main repo is down for some | |
45 | reason, either one of these is safe to use as a backup: | |
01fa84d5 JA |
46 | |
47 | git://git.kernel.org/pub/scm/linux/kernel/git/axboe/fio.git | |
f80dba8d | 48 | |
01fa84d5 JA |
49 | https://git.kernel.org/pub/scm/linux/kernel/git/axboe/fio.git |
50 | ||
51 | or | |
52 | ||
3826b24a | 53 | git://github.com/axboe/fio.git |
244e170e | 54 | |
f80dba8d | 55 | https://github.com/axboe/fio.git |
a71844ff | 56 | |
2b02b546 | 57 | |
726f6ff0 JA |
58 | Mailing list |
59 | ------------ | |
60 | ||
4649b352 | 61 | The fio project mailing list is meant for anything related to fio including |
6468020d TK |
62 | general discussion, bug reporting, questions, and development. For bug reporting, |
63 | see REPORTING-BUGS. | |
2e8552b0 | 64 | |
f80dba8d MT |
65 | An automated mail detailing recent commits is automatically sent to the list at |
66 | most daily. The list address is fio@vger.kernel.org, subscribe by sending an | |
67 | email to majordomo@vger.kernel.org with | |
4649b352 GG |
68 | |
69 | subscribe fio | |
2e8552b0 | 70 | |
4f5d1526 EIB |
71 | in the body of the email. Archives can be found here: |
72 | ||
4649b352 | 73 | http://www.spinics.net/lists/fio/ |
4f5d1526 EIB |
74 | |
75 | and archives for the old list can be found here: | |
2e8552b0 | 76 | |
4649b352 | 77 | http://maillist.kernel.dk/fio-devel/ |
726f6ff0 JA |
78 | |
79 | ||
f80dba8d MT |
80 | Author |
81 | ------ | |
bbfd6b00 | 82 | |
f80dba8d MT |
83 | Fio was written by Jens Axboe <axboe@kernel.dk> to enable flexible testing of |
84 | the Linux I/O subsystem and schedulers. He got tired of writing specific test | |
85 | applications to simulate a given workload, and found that the existing I/O | |
86 | benchmark/test tools out there weren't flexible enough to do what he wanted. | |
6de43c1b | 87 | |
f80dba8d | 88 | Jens Axboe <axboe@kernel.dk> 20060905 |
2382dca7 | 89 | |
c8931876 | 90 | |
f80dba8d MT |
91 | Binary packages |
92 | --------------- | |
bbfd6b00 | 93 | |
f80dba8d MT |
94 | Debian: |
95 | Starting with Debian "Squeeze", fio packages are part of the official | |
a881438b | 96 | Debian repository. http://packages.debian.org/search?keywords=fio . |
53adf64f | 97 | |
f80dba8d MT |
98 | Ubuntu: |
99 | Starting with Ubuntu 10.04 LTS (aka "Lucid Lynx"), fio packages are part | |
100 | of the Ubuntu "universe" repository. | |
a881438b | 101 | http://packages.ubuntu.com/search?keywords=fio . |
53adf64f | 102 | |
a881438b SW |
103 | Red Hat, Fedora, CentOS & Co: |
104 | Starting with Fedora 9/Extra Packages for Enterprise Linux 4, fio | |
105 | packages are part of the Fedora/EPEL repositories. | |
658f3525 | 106 | https://apps.fedoraproject.org/packages/fio . |
f41862f7 | 107 | |
f80dba8d MT |
108 | Mandriva: |
109 | Mandriva has integrated fio into their package repository, so installing | |
110 | on that distro should be as easy as typing ``urpmi fio``. | |
9aa5fe32 | 111 | |
a6415d76 QB |
112 | Arch Linux: |
113 | An Arch Linux package is provided under the Community sub-repository: | |
114 | https://www.archlinux.org/packages/?sort=&q=fio | |
115 | ||
f80dba8d MT |
116 | Solaris: |
117 | Packages for Solaris are available from OpenCSW. Install their pkgutil | |
118 | tool (http://www.opencsw.org/get-it/pkgutil/) and then install fio via | |
119 | ``pkgutil -i fio``. | |
7409711b | 120 | |
f80dba8d MT |
121 | Windows: |
122 | Rebecca Cran <rebecca+fio@bluestop.org> has fio packages for Windows at | |
123 | http://www.bluestop.org/fio/ . | |
78080867 | 124 | |
f80dba8d MT |
125 | BSDs: |
126 | Packages for BSDs may be available from their binary package repositories. | |
127 | Look for a package "fio" using their binary package managers. | |
53adf64f | 128 | |
ebac4655 | 129 | |
f80dba8d | 130 | Building |
79809113 JA |
131 | -------- |
132 | ||
f80dba8d | 133 | Just type:: |
bebe6398 | 134 | |
f80dba8d MT |
135 | $ ./configure |
136 | $ make | |
137 | $ make install | |
bebe6398 | 138 | |
f80dba8d MT |
139 | Note that GNU make is required. On BSDs it's available from devel/gmake within |
140 | ports directory; on Solaris it's in the SUNWgmake package. On platforms where | |
141 | GNU make isn't the default, type ``gmake`` instead of ``make``. | |
811826be | 142 | |
f80dba8d MT |
143 | Configure will print the enabled options. Note that on Linux based platforms, |
144 | the libaio development packages must be installed to use the libaio | |
145 | engine. Depending on distro, it is usually called libaio-devel or libaio-dev. | |
811826be | 146 | |
f80dba8d MT |
147 | For gfio, gtk 2.18 (or newer), associated glib threads, and cairo are required |
148 | to be installed. gfio isn't built automatically and can be enabled with a | |
149 | ``--enable-gfio`` option to configure. | |
bebe6398 | 150 | |
f80dba8d | 151 | To build fio with a cross-compiler:: |
bebe6398 | 152 | |
f80dba8d MT |
153 | $ make clean |
154 | $ make CROSS_COMPILE=/path/to/toolchain/prefix | |
bebe6398 | 155 | |
f80dba8d | 156 | Configure will attempt to determine the target platform automatically. |
bebe6398 | 157 | |
f80dba8d MT |
158 | It's possible to build fio for ESX as well, use the ``--esx`` switch to |
159 | configure. | |
4649b352 | 160 | |
bebe6398 | 161 | |
f80dba8d MT |
162 | Windows |
163 | ~~~~~~~ | |
323255cc | 164 | |
f80dba8d MT |
165 | On Windows, Cygwin (http://www.cygwin.com/) is required in order to build |
166 | fio. To create an MSI installer package install WiX 3.8 from | |
167 | http://wixtoolset.org and run :file:`dobuild.cmd` from the :file:`os/windows` | |
168 | directory. | |
323255cc | 169 | |
f80dba8d | 170 | How to compile fio on 64-bit Windows: |
323255cc | 171 | |
f80dba8d MT |
172 | 1. Install Cygwin (http://www.cygwin.com/). Install **make** and all |
173 | packages starting with **mingw64-i686** and **mingw64-x86_64**. | |
174 | 2. Open the Cygwin Terminal. | |
175 | 3. Go to the fio directory (source files). | |
176 | 4. Run ``make clean && make -j``. | |
39b5f61e | 177 | |
f80dba8d MT |
178 | To build fio on 32-bit Windows, run ``./configure --build-32bit-win`` before |
179 | ``make``. | |
39b5f61e | 180 | |
f80dba8d MT |
181 | It's recommended that once built or installed, fio be run in a Command Prompt or |
182 | other 'native' console such as console2, since there are known to be display and | |
183 | signal issues when running it under a Cygwin shell (see | |
f5c5f869 SW |
184 | https://github.com/mintty/mintty/issues/56 and |
185 | https://github.com/mintty/mintty/wiki/Tips#inputoutput-interaction-with-alien-programs | |
186 | for details). | |
39b5f61e | 187 | |
39b5f61e | 188 | |
f80dba8d MT |
189 | Documentation |
190 | ~~~~~~~~~~~~~ | |
39b5f61e | 191 | |
f80dba8d MT |
192 | Fio uses Sphinx_ to generate documentation from the reStructuredText_ files. |
193 | To build HTML formatted documentation run ``make -C doc html`` and direct your | |
194 | browser to :file:`./doc/output/html/index.html`. To build manual page run | |
195 | ``make -C doc man`` and then ``man doc/output/man/fio.1``. To see what other | |
196 | output formats are supported run ``make -C doc help``. | |
39b5f61e | 197 | |
f80dba8d MT |
198 | .. _reStructuredText: http://www.sphinx-doc.org/rest.html |
199 | .. _Sphinx: http://www.sphinx-doc.org | |
39b5f61e | 200 | |
bebe6398 | 201 | |
217bc04b JA |
202 | Platforms |
203 | --------- | |
204 | ||
1b8c5af7 | 205 | Fio works on (at least) Linux, Solaris, AIX, HP-UX, OSX, NetBSD, OpenBSD, |
2af5bd99 | 206 | Windows, FreeBSD, and DragonFly. Some features and/or options may only be |
f80dba8d MT |
207 | available on some of the platforms, typically because those features only apply |
208 | to that platform (like the solarisaio engine, or the splice engine on Linux). | |
217bc04b JA |
209 | |
210 | Some features are not available on FreeBSD/Solaris even if they could be | |
f80dba8d MT |
211 | implemented, I'd be happy to take patches for that. An example of that is disk |
212 | utility statistics and (I think) huge page support, support for that does exist | |
213 | in FreeBSD/Solaris. | |
217bc04b | 214 | |
06eac6b2 SW |
215 | Fio uses pthread mutexes for signalling and locking and some platforms do not |
216 | support process shared pthread mutexes. As a result, on such platforms only | |
217 | threads are supported. This could be fixed with sysv ipc locking or other | |
218 | locking alternatives. | |
217bc04b | 219 | |
f80dba8d MT |
220 | Other \*BSD platforms are untested, but fio should work there almost out of the |
221 | box. Since I don't do test runs or even compiles on those platforms, your | |
222 | mileage may vary. Sending me patches for other platforms is greatly | |
217bc04b JA |
223 | appreciated. There's a lot of value in having the same test/benchmark tool |
224 | available on all platforms. | |
225 | ||
f80dba8d | 226 | Note that POSIX aio is not enabled by default on AIX. Messages like these:: |
bf2e821a CC |
227 | |
228 | Symbol resolution failed for /usr/lib/libc.a(posix_aio.o) because: | |
229 | Symbol _posix_kaio_rdwr (number 2) is not exported from dependent module /unix. | |
230 | ||
f80dba8d | 231 | indicate one needs to enable POSIX aio. Run the following commands as root:: |
bf2e821a CC |
232 | |
233 | # lsdev -C -l posix_aio0 | |
234 | posix_aio0 Defined Posix Asynchronous I/O | |
235 | # cfgmgr -l posix_aio0 | |
236 | # lsdev -C -l posix_aio0 | |
237 | posix_aio0 Available Posix Asynchronous I/O | |
238 | ||
f80dba8d | 239 | POSIX aio should work now. To make the change permanent:: |
bf2e821a CC |
240 | |
241 | # chdev -l posix_aio0 -P -a autoconfig='available' | |
242 | posix_aio0 changed | |
217bc04b JA |
243 | |
244 | ||
f80dba8d MT |
245 | Running fio |
246 | ----------- | |
79809113 | 247 | |
f80dba8d MT |
248 | Running fio is normally the easiest part - you just give it the job file |
249 | (or job files) as parameters:: | |
79809113 | 250 | |
f80dba8d MT |
251 | $ fio [options] [jobfile] ... |
252 | ||
253 | and it will start doing what the *jobfile* tells it to do. You can give more | |
254 | than one job file on the command line, fio will serialize the running of those | |
255 | files. Internally that is the same as using the :option:`stonewall` parameter | |
256 | described in the parameter section. | |
257 | ||
258 | If the job file contains only one job, you may as well just give the parameters | |
259 | on the command line. The command line parameters are identical to the job | |
260 | parameters, with a few extra that control global parameters. For example, for | |
261 | the job file parameter :option:`iodepth=2 <iodepth>`, the mirror command line | |
262 | option would be :option:`--iodepth 2 <iodepth>` or :option:`--iodepth=2 | |
263 | <iodepth>`. You can also use the command line for giving more than one job | |
264 | entry. For each :option:`--name <name>` option that fio sees, it will start a | |
265 | new job with that name. Command line entries following a | |
266 | :option:`--name <name>` entry will apply to that job, until there are no more | |
267 | entries or a new :option:`--name <name>` entry is seen. This is similar to the | |
268 | job file options, where each option applies to the current job until a new [] | |
269 | job entry is seen. | |
270 | ||
271 | fio does not need to run as root, except if the files or devices specified in | |
272 | the job section requires that. Some other options may also be restricted, such | |
273 | as memory locking, I/O scheduler switching, and decreasing the nice value. | |
79809113 | 274 | |
f80dba8d MT |
275 | If *jobfile* is specified as ``-``, the job file will be read from standard |
276 | input. |