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