Commit | Line | Data |
---|---|---|
ebac4655 JA |
1 | fio |
2 | --- | |
3 | ||
79809113 JA |
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. | |
ebac4655 | 10 | |
2b02b546 JA |
11 | |
12 | Source | |
13 | ------ | |
14 | ||
15 | fio resides in a git repo, the canonical place is: | |
16 | ||
6b3eccb1 | 17 | git://git.kernel.dk/fio.git |
97f049c9 | 18 | |
a9bac3f9 JA |
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 | |
2b02b546 | 23 | |
79809113 JA |
24 | Snapshots are frequently generated and they include the git meta data as |
25 | well. You can download them here: | |
2b02b546 JA |
26 | |
27 | http://brick.kernel.dk/snaps/ | |
28 | ||
1053a106 | 29 | |
d85b1add SK |
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 | SUSE: | |
43 | Pascal Bleser <guru@unixtech.be> has fio RPMs in his repository for SUSE | |
44 | variants, you can find them here: | |
1053a106 JA |
45 | http://linux01.gwdg.de/~pbleser/rpm-navigation.php?cat=System/fio |
46 | ||
d85b1add | 47 | Red Hat, CentOS & Co: |
a68594cb | 48 | Dag Wieërs has RPMs for Red Hat related distros, find them here: |
a68594cb JA |
49 | http://dag.wieers.com/rpm/packages/fio/ |
50 | ||
d85b1add | 51 | Mandriva: |
244e170e JA |
52 | Mandriva has integrated fio into their package repository, so installing |
53 | on that distro should be as easy as typing 'urpmi fio'. | |
54 | ||
d85b1add SK |
55 | Solaris: |
56 | Packages for Solaris are available from OpenCSW. Install their pkgutil | |
57 | tool (http://www.opencsw.org/get-it/pkgutil/) and then install fio via | |
58 | 'pkgutil -i fio'. | |
59 | ||
ecc314ba BC |
60 | Windows: |
61 | Bruce Cran <bruce@cran.org.uk> has fio packages for Windows at | |
62 | http://www.bluestop.org/fio . | |
63 | ||
2b02b546 | 64 | |
726f6ff0 JA |
65 | Mailing list |
66 | ------------ | |
67 | ||
68 | There's a mailing list associated with fio. It's meant for general | |
2e8552b0 JA |
69 | discussion, bug reporting, questions, and development - basically anything |
70 | that has to do with fio. An automated mail detailing recent commits is | |
71 | automatically sent to the list at most daily. The list address is | |
72 | fio@vger.kernel.org, subscribe by sending an email to | |
73 | majordomo@vger.kernel.org with | |
74 | ||
75 | subscribe fio | |
76 | ||
4f5d1526 EIB |
77 | in the body of the email. Archives can be found here: |
78 | ||
79 | http://www.spinics.net/lists/fio/ | |
80 | ||
81 | and archives for the old list can be found here: | |
2e8552b0 JA |
82 | |
83 | http://maillist.kernel.dk/fio-devel/ | |
726f6ff0 JA |
84 | |
85 | ||
bbfd6b00 JA |
86 | Building |
87 | -------- | |
88 | ||
d015e398 | 89 | Just type 'make' and 'make install'. |
bbfd6b00 | 90 | |
d015e398 BC |
91 | Note that GNU make is required. On BSD it's available from devel/gmake; |
92 | on Solaris it's in the SUNWgmake package. On platforms where GNU make | |
93 | isn't the default, type 'gmake' instead of 'make'. | |
bbfd6b00 | 94 | |
6de43c1b JA |
95 | If your compile fails with an error like this: |
96 | ||
97 | CC gettime.o | |
98 | In file included from fio.h:23, | |
99 | from gettime.c:8: | |
100 | os/os.h:15:20: error: libaio.h: No such file or directory | |
101 | In file included from gettime.c:8: | |
102 | fio.h:119: error: field 'iocb' has incomplete type | |
103 | make: *** [gettime.o] Error 1 | |
104 | ||
105 | Check that you have the libaio development package installed. On RPM | |
106 | based distros, it's typically called libaio-devel. | |
107 | ||
bbfd6b00 | 108 | |
53adf64f BC |
109 | Windows |
110 | ------- | |
111 | ||
93bcfd20 BC |
112 | On Windows MinGW (http://www.mingw.org/) is required in order to |
113 | build fio. To create an MSI installer package install WiX 3.6 from | |
114 | http://wix.sourceforge.net/releases/ and run dobuild.cmd from the | |
115 | os/windows directory. | |
53adf64f BC |
116 | |
117 | ||
972cfd25 JA |
118 | Command line |
119 | ------------ | |
ebac4655 JA |
120 | |
121 | $ fio | |
1cfd036f BC |
122 | --debug Enable some debugging options (see below) |
123 | --output Write output to file | |
b2cecdc2 | 124 | --runtime Runtime in seconds |
bebe6398 JA |
125 | --latency-log Generate per-job latency logs |
126 | --bandwidth-log Generate per-job bandwidth logs | |
1cfd036f | 127 | --minimal Minimal (terse) output |
f3afa57e | 128 | --output-format=type Output format (terse,json,normal) |
3449ab8c | 129 | --terse-version=type Terse version output format (default 3, or 2 or 4). |
f3afa57e | 130 | --version Print version info and exit |
1cfd036f | 131 | --help Print this page |
23893646 | 132 | --cpuclock-test Perform test/validation of CPU clock |
bebe6398 | 133 | --cmdhelp=cmd Print command help, "all" for all of them |
de890a1e SL |
134 | --enghelp=engine Print ioengine help, or list available ioengines |
135 | --enghelp=engine,cmd Print help for an ioengine cmd | |
1cfd036f | 136 | --showcmd Turn a job file into command line options |
ad0a2735 | 137 | --readonly Turn on safety read-only checks, preventing |
bebe6398 | 138 | writes |
1cfd036f | 139 | --eta=when When ETA estimate should be printed |
bebe6398 JA |
140 | May be "always", "never" or "auto" |
141 | --section=name Only run specified section in job file. | |
142 | Multiple sections can be specified. | |
e7cb819b | 143 | --alloc-size=kb Set smalloc pool to this size in kb (def 1024) |
144 | --warnings-fatal Fio parser warnings are fatal | |
fca70358 | 145 | --max-jobs Maximum number of threads/processes to support |
bebe6398 JA |
146 | --server=args Start backend server. See Client/Server section. |
147 | --client=host Connect to specified backend. | |
e592a06b | 148 | |
b4692828 JA |
149 | |
150 | Any parameters following the options will be assumed to be job files, | |
151 | unless they match a job file parameter. You can add as many as you want, | |
152 | each job file will be regarded as a separate group and fio will stonewall | |
153 | its execution. | |
972cfd25 | 154 | |
ecc314ba | 155 | The --readonly switch is an extra safety guard to prevent accidentally |
724e4435 JA |
156 | turning on a write setting when that is not desired. Fio will only write |
157 | if rw=write/randwrite/rw/randrw is given, but this extra safety net can | |
158 | be used as an extra precaution. It will also enable a write check in the | |
159 | io engine core to prevent an accidental write due to a fio bug. | |
160 | ||
ee56ad50 JA |
161 | The debug switch allows adding options that trigger certain logging |
162 | options in fio. Currently the options are: | |
163 | ||
164 | process Dump info related to processes | |
165 | file Dump info related to file actions | |
e7cb819b | 166 | io Dump info related to IO queuing |
167 | mem Dump info related to memory allocations | |
bd6f78b2 JA |
168 | blktrace Dump info related to blktrace setup |
169 | verify Dump info related to IO verification | |
e7cb819b | 170 | all Enable all debug options |
811a0d06 | 171 | random Dump info related to random offset generation |
a3d741fa | 172 | parse Dump info related to option matching and parsing |
cd991b9e | 173 | diskutil Dump info related to disk utilization updates |
5e1d306e | 174 | job:x Dump info only related to job number x |
29adda3c | 175 | mutex Dump info only related to mutex up/down ops |
c223da83 JA |
176 | profile Dump info related to profile extensions |
177 | time Dump info related to internal time keeping | |
bd6f78b2 | 178 | ? or help Show available debug options. |
ee56ad50 JA |
179 | |
180 | You can specify as many as you want, eg --debug=file,mem will enable | |
bd6f78b2 | 181 | file and memory debugging. |
ee56ad50 | 182 | |
01f06b63 JA |
183 | The section switch is meant to make it easier to ship a bigger job file |
184 | instead of several smaller ones. Say you define a job file with light, | |
185 | moderate, and heavy parts. Then you can ask fio to run the given part | |
186 | only by giving it a --section=heavy command line option. The section | |
187 | option only applies to job sections, the reserved 'global' section is | |
188 | always parsed and taken into account. | |
189 | ||
2b386d25 JA |
190 | Fio has an internal allocator for shared memory called smalloc. It |
191 | allocates shared structures from this pool. The pool defaults to 1024k | |
931823ca | 192 | in size, and can grow to 128 pools. If running large jobs with randommap |
2b386d25 | 193 | enabled it can run out of memory, in which case the --alloc-size switch |
931823ca JA |
194 | is handy for starting with a larger pool size. The backing store is |
195 | files in /tmp. Fio cleans up after itself, while it is running you | |
196 | may see .fio_smalloc.* files in /tmp. | |
2b386d25 | 197 | |
79809113 JA |
198 | |
199 | Job file | |
200 | -------- | |
201 | ||
71bfa161 | 202 | See the HOWTO file for a more detailed description of parameters and what |
4661f3d0 JA |
203 | they mean. This file contains the terse version. You can describe big and |
204 | complex setups with the command line, but generally it's a lot easier to | |
71bfa161 | 205 | just write a simple job file to describe the workload. The job file format |
4661f3d0 | 206 | is in the ini style format, as that is easy to read and write for the user. |
79809113 JA |
207 | |
208 | The job file parameters are: | |
ebac4655 | 209 | |
01452055 | 210 | name=x Use 'x' as the identifier for this job. |
61697c37 | 211 | description=x 'x' is a text description of the job. |
ebac4655 | 212 | directory=x Use 'x' as the top level directory for storing files |
b50b8755 JA |
213 | filename=x Force the use of 'x' as the filename for all files |
214 | in this thread. If not given, fio will make up | |
215 | a suitable filename based on the thread and file | |
216 | number. | |
3d60d1ed JA |
217 | rw=x 'x' may be: read, randread, write, randwrite, |
218 | rw (read-write mix), randrw (read-write random mix) | |
a6ccc7be JA |
219 | rwmixcycle=x Base cycle for switching between read and write |
220 | in msecs. | |
221 | rwmixread=x 'x' percentage of rw mix ios will be reads. If | |
222 | rwmixwrite is also given, the last of the two will | |
223 | be used if they don't add up to 100%. | |
224 | rwmixwrite=x 'x' percentage of rw mix ios will be writes. See | |
225 | rwmixread. | |
9ebc27e1 JA |
226 | rand_repeatable=x The sequence of random io blocks can be repeatable |
227 | across runs, if 'x' is 1. | |
ebac4655 JA |
228 | size=x Set file size to x bytes (x string can include k/m/g) |
229 | ioengine=x 'x' may be: aio/libaio/linuxaio for Linux aio, | |
78e7b3e7 | 230 | posixaio for POSIX aio, solarisaio for Solaris |
03e20d68 BC |
231 | native async IO, windowsaio for Windows native async IO, |
232 | sync for regular read/write io, | |
1d2af02a JA |
233 | psync for regular pread/pwrite io, vsync for regular |
234 | readv/writev (with queuing emulation) mmap for mmap'ed | |
235 | io, syslet-rw for syslet driven read/write, splice for | |
d0c70934 | 236 | using splice/vmsplice, sg for direct SG_IO io, net |
d0b937ed YR |
237 | for network io, rdma for RDMA io, or cpuio for a |
238 | cycler burner load. sg only works on Linux on | |
239 | SCSI (or SCSI-like devices, such as usb-storage or | |
240 | sata/libata driven) devices. Fio also has a null | |
241 | io engine, which is mainly used for testing | |
1d2af02a JA |
242 | fio itself. |
243 | ||
ebac4655 JA |
244 | iodepth=x For async io, allow 'x' ios in flight |
245 | overwrite=x If 'x', layout a write file first. | |
53cdc686 JA |
246 | nrfiles=x Spread io load over 'x' number of files per job, |
247 | if possible. | |
ebac4655 JA |
248 | prio=x Run io at prio X, 0-7 is the kernel allowed range |
249 | prioclass=x Run io at prio class X | |
250 | bs=x Use 'x' for thread blocksize. May include k/m postfix. | |
251 | bsrange=x-y Mix thread block sizes randomly between x and y. May | |
252 | also include k/m postfix. | |
253 | direct=x 1 for direct IO, 0 for buffered IO | |
254 | thinktime=x "Think" x usec after each io | |
b22989b9 JA |
255 | rate=x Throttle rate to x KB/sec |
256 | ratemin=x Quit if rate of x KB/sec can't be met | |
ebac4655 JA |
257 | ratecycle=x ratemin averaged over x msecs |
258 | cpumask=x Only allow job to run on CPUs defined by mask. | |
d2e268b0 | 259 | cpus_allowed=x Like 'cpumask', but allow text setting of CPU affinity. |
d0b937ed YR |
260 | numa_cpu_nodes=x,y-z Allow job to run on specified NUMA nodes' CPU. |
261 | numa_mem_policy=m:x,y-z Setup numa memory allocation policy. | |
262 | 'm' stands for policy, such as local, interleave, | |
263 | bind, prefer, local. 'x, y-z' are numa node(s) for | |
264 | memory allocation according to policy. | |
795407ca JA |
265 | fsync=x If writing with buffered IO, fsync after every |
266 | 'x' blocks have been written. | |
267 | end_fsync=x If 'x', run fsync() after end-of-job. | |
ebac4655 | 268 | startdelay=x Start this thread x seconds after startup |
03b74b3e | 269 | runtime=x Terminate x seconds after startup. Can include a |
906c8d75 JA |
270 | normal time suffix if not given in seconds, such as |
271 | 'm' for minutes, 'h' for hours, and 'd' for days. | |
ebac4655 JA |
272 | offset=x Start io at offset x (x string can include k/m/g) |
273 | invalidate=x Invalidate page cache for file prior to doing io | |
795407ca | 274 | sync=x Use sync writes if x and writing buffered IO. |
ebac4655 | 275 | mem=x If x == malloc, use malloc for buffers. If x == shm, |
795407ca JA |
276 | use shared memory for buffers. If x == mmap, use |
277 | anonymous mmap. | |
ebac4655 JA |
278 | exitall When one thread quits, terminate the others |
279 | bwavgtime=x Average bandwidth stats over an x msec window. | |
280 | create_serialize=x If 'x', serialize file creation. | |
281 | create_fsync=x If 'x', run fsync() after file creation. | |
f6cbb269 | 282 | unlink If set, unlink files when done. |
ebac4655 JA |
283 | loops=x Run the job 'x' number of times. |
284 | verify=x If 'x' == md5, use md5 for verifies. If 'x' == crc32, | |
285 | use crc32 for verifies. md5 is 'safer', but crc32 is | |
286 | a lot faster. Only makes sense for writing to a file. | |
bac39e0e | 287 | For other types of checksumming, see HOWTO. |
ebac4655 JA |
288 | stonewall Wait for preceeding jobs to end before running. |
289 | numjobs=x Create 'x' similar entries for this job | |
290 | thread Use pthreads instead of forked jobs | |
20dc95c4 JA |
291 | zonesize=x |
292 | zoneskip=y Zone options must be paired. If given, the job | |
293 | will skip y bytes for every x read/written. This | |
294 | can be used to gauge hard drive speed over the entire | |
295 | platter, without reading everything. Both x/y can | |
296 | include k/m/g suffix. | |
25c8b9d7 PD |
297 | read_iolog=x Open and read io pattern from file 'x'. The file format |
298 | is described in the HOWTO. | |
843a7413 JA |
299 | write_iolog=x Write an iolog to file 'x' in the same format as iolog. |
300 | The iolog options are exclusive, if both given the | |
5b42a488 SH |
301 | read iolog will be performed. Specify a separate file |
302 | for each job, otherwise the iologs will be interspersed | |
303 | and the file may be corrupt. | |
ec94ec56 JA |
304 | write_bw_log Write a bandwidth log. |
305 | write_lat_log Write a latency log. | |
c04f7ec3 JA |
306 | lockmem=x Lock down x amount of memory on the machine, to |
307 | simulate a machine with less memory available. x can | |
308 | include k/m/g suffix. | |
b6f4d880 | 309 | nice=x Run job at given nice value. |
4e0ba8af JA |
310 | exec_prerun=x Run 'x' before job io is begun. |
311 | exec_postrun=x Run 'x' after job io has finished. | |
da86774e | 312 | ioscheduler=x Use ioscheduler 'x' for this job. |
b990b5c0 JA |
313 | cpuload=x For a CPU io thread, percentage of CPU time to attempt |
314 | to burn. | |
ba0fbe10 | 315 | cpuchunks=x Split burn cycles into pieces of x usecs. |
ebac4655 | 316 | |
79809113 | 317 | |
217bc04b | 318 | |
bebe6398 JA |
319 | Client/server |
320 | ------------ | |
321 | ||
322 | Normally you would run fio as a stand-alone application on the machine | |
323 | where the IO workload should be generated. However, it is also possible to | |
324 | run the frontend and backend of fio separately. This makes it possible to | |
325 | have a fio server running on the machine(s) where the IO workload should | |
326 | be running, while controlling it from another machine. | |
327 | ||
328 | To start the server, you would do: | |
329 | ||
330 | fio --server=args | |
331 | ||
332 | on that machine, where args defines what fio listens to. The arguments | |
811826be JA |
333 | are of the form 'type,hostname or IP,port'. 'type' is either 'ip' (or ip4) |
334 | for TCP/IP v4, 'ip6' for TCP/IP v6, or 'sock' for a local unix domain socket. | |
335 | 'hostname' is either a hostname or IP address, and 'port' is the port to | |
336 | listen to (only valid for TCP/IP, not a local socket). Some examples: | |
bebe6398 JA |
337 | |
338 | 1) fio --server | |
339 | ||
340 | Start a fio server, listening on all interfaces on the default port (8765). | |
341 | ||
811826be | 342 | 2) fio --server=ip:hostname,4444 |
bebe6398 JA |
343 | |
344 | Start a fio server, listening on IP belonging to hostname and on port 4444. | |
345 | ||
811826be JA |
346 | 3) fio --server=ip6:::1,4444 |
347 | ||
348 | Start a fio server, listening on IPv6 localhost ::1 and on port 4444. | |
349 | ||
350 | 4) fio --server=,4444 | |
bebe6398 JA |
351 | |
352 | Start a fio server, listening on all interfaces on port 4444. | |
353 | ||
811826be | 354 | 5) fio --server=1.2.3.4 |
bebe6398 JA |
355 | |
356 | Start a fio server, listening on IP 1.2.3.4 on the default port. | |
357 | ||
811826be | 358 | 6) fio --server=sock:/tmp/fio.sock |
bebe6398 JA |
359 | |
360 | Start a fio server, listening on the local socket /tmp/fio.sock. | |
361 | ||
362 | When a server is running, you can connect to it from a client. The client | |
363 | is run with: | |
364 | ||
365 | fio --local-args --client=server --remote-args <job file(s)> | |
366 | ||
367 | where --local-args are arguments that are local to the client where it is | |
368 | running, 'server' is the connect string, and --remote-args and <job file(s)> | |
369 | are sent to the server. The 'server' string follows the same format as it | |
370 | does on the server side, to allow IP/hostname/socket and port strings. | |
371 | You can connect to multiple clients as well, to do that you could run: | |
372 | ||
a7321eed | 373 | fio --client=server2 <job file(s)> --client=server2 <job file(s)> |
bebe6398 JA |
374 | |
375 | ||
217bc04b JA |
376 | Platforms |
377 | --------- | |
378 | ||
ce600ac9 JA |
379 | Fio works on (at least) Linux, Solaris, AIX, HP-UX, OSX, NetBSD, Windows |
380 | and FreeBSD. Some features and/or options may only be available on some of | |
381 | the platforms, typically because those features only apply to that platform | |
382 | (like the solarisaio engine, or the splice engine on Linux). | |
217bc04b JA |
383 | |
384 | Some features are not available on FreeBSD/Solaris even if they could be | |
385 | implemented, I'd be happy to take patches for that. An example of that is | |
386 | disk utility statistics and (I think) huge page support, support for that | |
387 | does exist in FreeBSD/Solaris. | |
388 | ||
389 | Fio uses pthread mutexes for signalling and locking and FreeBSD does not | |
390 | support process shared pthread mutexes. As a result, only threads are | |
391 | supported on FreeBSD. This could be fixed with sysv ipc locking or | |
392 | other locking alternatives. | |
393 | ||
394 | Other *BSD platforms are untested, but fio should work there almost out | |
395 | of the box. Since I don't do test runs or even compiles on those platforms, | |
396 | your mileage may vary. Sending me patches for other platforms is greatly | |
397 | appreciated. There's a lot of value in having the same test/benchmark tool | |
398 | available on all platforms. | |
399 | ||
bf2e821a CC |
400 | Note that POSIX aio is not enabled by default on AIX. If you get messages like: |
401 | ||
402 | Symbol resolution failed for /usr/lib/libc.a(posix_aio.o) because: | |
403 | Symbol _posix_kaio_rdwr (number 2) is not exported from dependent module /unix. | |
404 | ||
405 | you need to enable POSIX aio. Run the following commands as root: | |
406 | ||
407 | # lsdev -C -l posix_aio0 | |
408 | posix_aio0 Defined Posix Asynchronous I/O | |
409 | # cfgmgr -l posix_aio0 | |
410 | # lsdev -C -l posix_aio0 | |
411 | posix_aio0 Available Posix Asynchronous I/O | |
412 | ||
413 | POSIX aio should work now. To make the change permanent: | |
414 | ||
415 | # chdev -l posix_aio0 -P -a autoconfig='available' | |
416 | posix_aio0 changed | |
217bc04b JA |
417 | |
418 | ||
79809113 JA |
419 | Author |
420 | ------ | |
421 | ||
aae22ca7 | 422 | Fio was written by Jens Axboe <axboe@kernel.dk> to enable flexible testing |
79809113 JA |
423 | of the Linux IO subsystem and schedulers. He got tired of writing |
424 | specific test applications to simulate a given workload, and found that | |
425 | the existing io benchmark/test tools out there weren't flexible enough | |
426 | to do what he wanted. | |
427 | ||
aae22ca7 | 428 | Jens Axboe <axboe@kernel.dk> 20060905 |
79809113 | 429 |