Cleanup verify headers
[fio.git] / README
1 fio
2 ---
3
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.
10
11
12 Source
13 ------
14
15 fio resides in a git repo, the canonical place is:
16
17 git://git.kernel.dk/fio.git
18
19 The http protocol also works, path is the same.
20
21 Snapshots are frequently generated and they include the git meta data as
22 well. You can download them here:
23
24 http://brick.kernel.dk/snaps/
25
26 Pascal Bleser <guru@unixtech.be> has fio RPMs in his repository for
27 SUSE variants, you can find them here:
28
29 http://linux01.gwdg.de/~pbleser/rpm-navigation.php?cat=System/fio
30
31 Dag WieĆ«rs has RPMs for Red Hat related distros, find them here:
32
33 http://dag.wieers.com/rpm/packages/fio/
34
35 Mandriva has integrated fio into their package repository, so installing
36 on that distro should be as easy as typing 'urpmi fio'.
37
38
39 Mailing list
40 ------------
41
42 There's a mailing list associated with fio. It's meant for general
43 discussion, bug reporting, questions, and development - basically anything
44 that has to do with fio. An automated mail detailing recent commits is
45 automatically sent to the list at most daily. The list address is
46 fio@vger.kernel.org, subscribe by sending an email to
47 majordomo@vger.kernel.org with
48
49 subscribe fio
50
51 in the body of the email. There is no archive for the new list yet,
52 archives for the old list can be found here:
53
54 http://maillist.kernel.dk/fio-devel/
55
56
57 Building
58 --------
59
60 Just type 'make' and 'make install'. If on FreeBSD, for now you have to
61 specify the FreeBSD Makefile with -f and use gmake (not make), eg:
62
63 $ gmake -f Makefile.Freebsd && gmake -f Makefile.FreeBSD install
64
65 Likewise with OpenSolaris, use the Makefile.solaris to compile there.
66 The OpenSolaris make should work fine. This might change in the
67 future if I opt for an autoconf type setup.
68
69 If your compile fails with an error like this:
70
71     CC gettime.o
72 In file included from fio.h:23,
73                  from gettime.c:8:
74 os/os.h:15:20: error: libaio.h: No such file or directory
75 In file included from gettime.c:8:
76 fio.h:119: error: field 'iocb' has incomplete type
77 make: *** [gettime.o] Error 1
78
79 Check that you have the libaio development package installed. On RPM
80 based distros, it's typically called libaio-devel.
81
82
83 Command line
84 ------------
85
86 $ fio
87         --debug         Enable some debugging options (see below)
88         --output        Write output to file
89         --timeout       Runtime in seconds
90         --latency-log   Generate per-job latency logs
91         --bandwidth-log Generate per-job bandwidth logs
92         --minimal       Minimal (terse) output
93         --version       Print version info and exit
94         --help          Print this page
95         --cmdhelp=cmd   Print command help, "all" for all of them
96         --showcmd       Turn a job file into command line options
97         --readonly      Turn on safety read-only checks, preventing writes
98         --eta=when      When ETA estimate should be printed
99                         May be "always", "never" or "auto"
100         --section=name  Only run specified section in job file
101         --alloc-size=kb Set smalloc pool to this size in kb (def 1024)
102
103
104 Any parameters following the options will be assumed to be job files,
105 unless they match a job file parameter. You can add as many as you want,
106 each job file will be regarded as a separate group and fio will stonewall
107 its execution.
108
109 The --readonly switch is an extra safety guard to prevent accidentically
110 turning on a write setting when that is not desired. Fio will only write
111 if rw=write/randwrite/rw/randrw is given, but this extra safety net can
112 be used as an extra precaution. It will also enable a write check in the
113 io engine core to prevent an accidental write due to a fio bug.
114
115 The debug switch allows adding options that trigger certain logging
116 options in fio. Currently the options are:
117
118         process         Dump info related to processes
119         file            Dump info related to file actions
120         io              Dump info related to IO queuing
121         mem             Dump info related to memory allocations
122         blktrace        Dump info related to blktrace setup
123         verify          Dump info related to IO verification
124         all             Enable all debug options
125         random          Dump info related to random offset generation
126         parse           Dump info related to option matching and parsing
127         diskutil        Dump info related to disk utilization updates
128         job:x           Dump info only related to job number x
129         mutex           Dump info only related to mutex up/down ops
130         ? or help       Show available debug options.
131
132 You can specify as many as you want, eg --debug=file,mem will enable
133 file and memory debugging.
134
135 The section switch is meant to make it easier to ship a bigger job file
136 instead of several smaller ones. Say you define a job file with light,
137 moderate, and heavy parts. Then you can ask fio to run the given part
138 only by giving it a --section=heavy command line option. The section
139 option only applies to job sections, the reserved 'global' section is
140 always parsed and taken into account.
141
142 Fio has an internal allocator for shared memory called smalloc. It
143 allocates shared structures from this pool. The pool defaults to 1024k
144 in size, and can grow to 128 pools. If running large jobs with randommap
145 enabled it can run out of memory, in which case the --alloc-size switch
146 is handy for starting with a larger pool size. The backing store is
147 files in /tmp. Fio cleans up after itself, while it is running you
148 may see .fio_smalloc.* files in /tmp.
149
150
151 Job file
152 --------
153
154 See the HOWTO file for a more detailed description of parameters and what
155 they mean. This file contains the terse version. You can describe big and
156 complex setups with the command line, but generally it's a lot easier to
157 just write a simple job file to describe the workload. The job file format
158 is in the ini style format, as that is easy to read and write for the user.
159
160 The job file parameters are:
161
162         name=x          Use 'x' as the identifier for this job.
163         description=x   'x' is a text description of the job.
164         directory=x     Use 'x' as the top level directory for storing files
165         filename=x      Force the use of 'x' as the filename for all files
166                         in this thread. If not given, fio will make up
167                         a suitable filename based on the thread and file
168                         number.
169         rw=x            'x' may be: read, randread, write, randwrite,
170                         rw (read-write mix), randrw (read-write random mix)
171         rwmixcycle=x    Base cycle for switching between read and write
172                         in msecs.
173         rwmixread=x     'x' percentage of rw mix ios will be reads. If
174                         rwmixwrite is also given, the last of the two will
175                          be used if they don't add up to 100%.
176         rwmixwrite=x    'x' percentage of rw mix ios will be writes. See
177                         rwmixread.
178         rand_repeatable=x  The sequence of random io blocks can be repeatable
179                         across runs, if 'x' is 1.
180         size=x          Set file size to x bytes (x string can include k/m/g)
181         ioengine=x      'x' may be: aio/libaio/linuxaio for Linux aio,
182                         posixaio for POSIX aio, solarisaio for Solaris
183                         native async IO, sync for regular read/write io,
184                         psync for regular pread/pwrite io, vsync for regular
185                         readv/writev (with queuing emulation) mmap for mmap'ed
186                         io, syslet-rw for syslet driven read/write, splice for
187                         using splice/vmsplice, sg for direct SG_IO io, net
188                         for network io, or cpuio for a cycler burner load. sg
189                         only works on Linux on SCSI (or SCSI-like devices, such
190                         as usb-storage or sata/libata driven) devices. Fio also
191                         has a null io engine, which is mainly used for testing
192                         fio itself.
193
194         iodepth=x       For async io, allow 'x' ios in flight
195         overwrite=x     If 'x', layout a write file first.
196         nrfiles=x       Spread io load over 'x' number of files per job,
197                         if possible.
198         prio=x          Run io at prio X, 0-7 is the kernel allowed range
199         prioclass=x     Run io at prio class X
200         bs=x            Use 'x' for thread blocksize. May include k/m postfix.
201         bsrange=x-y     Mix thread block sizes randomly between x and y. May
202                         also include k/m postfix.
203         direct=x        1 for direct IO, 0 for buffered IO
204         thinktime=x     "Think" x usec after each io
205         rate=x          Throttle rate to x KiB/sec
206         ratemin=x       Quit if rate of x KiB/sec can't be met
207         ratecycle=x     ratemin averaged over x msecs
208         cpumask=x       Only allow job to run on CPUs defined by mask.
209         cpus_allowed=x  Like 'cpumask', but allow text setting of CPU affinity.
210         fsync=x         If writing with buffered IO, fsync after every
211                         'x' blocks have been written.
212         end_fsync=x     If 'x', run fsync() after end-of-job.
213         startdelay=x    Start this thread x seconds after startup
214         runtime=x       Terminate x seconds after startup. Can include a
215                         normal time suffix if not given in seconds, such as
216                         'm' for minutes, 'h' for hours, and 'd' for days.
217         offset=x        Start io at offset x (x string can include k/m/g)
218         invalidate=x    Invalidate page cache for file prior to doing io
219         sync=x          Use sync writes if x and writing buffered IO.
220         mem=x           If x == malloc, use malloc for buffers. If x == shm,
221                         use shared memory for buffers. If x == mmap, use
222                         anonymous mmap.
223         exitall         When one thread quits, terminate the others
224         bwavgtime=x     Average bandwidth stats over an x msec window.
225         create_serialize=x      If 'x', serialize file creation.
226         create_fsync=x  If 'x', run fsync() after file creation.
227         unlink          If set, unlink files when done.
228         loops=x         Run the job 'x' number of times.
229         verify=x        If 'x' == md5, use md5 for verifies. If 'x' == crc32,
230                         use crc32 for verifies. md5 is 'safer', but crc32 is
231                         a lot faster. Only makes sense for writing to a file.
232                         For other types of checksumming, see HOWTO.
233         stonewall       Wait for preceeding jobs to end before running.
234         numjobs=x       Create 'x' similar entries for this job
235         thread          Use pthreads instead of forked jobs
236         zonesize=x
237         zoneskip=y      Zone options must be paired. If given, the job
238                         will skip y bytes for every x read/written. This
239                         can be used to gauge hard drive speed over the entire
240                         platter, without reading everything. Both x/y can
241                         include k/m/g suffix.
242         iolog=x         Open and read io pattern from file 'x'. The file must
243                         contain one io action per line in the following format:
244                         rw, offset, length
245                         where with rw=0/1 for read/write, and the offset
246                         and length entries being in bytes.
247         write_iolog=x   Write an iolog to file 'x' in the same format as iolog.
248                         The iolog options are exclusive, if both given the
249                         read iolog will be performed.
250         write_bw_log    Write a bandwidth log.
251         write_lat_log   Write a latency log.
252         lockmem=x       Lock down x amount of memory on the machine, to
253                         simulate a machine with less memory available. x can
254                         include k/m/g suffix.
255         nice=x          Run job at given nice value.
256         exec_prerun=x   Run 'x' before job io is begun.
257         exec_postrun=x  Run 'x' after job io has finished.
258         ioscheduler=x   Use ioscheduler 'x' for this job.
259         cpuload=x       For a CPU io thread, percentage of CPU time to attempt
260                         to burn.
261         cpuchunks=x     Split burn cycles into pieces of x usecs.
262
263
264
265 Platforms
266 ---------
267
268 Fio works on (at least) Linux, Solaris, and FreeBSD. Some features and/or
269 options may only be available on some of the platforms, typically because
270 those features only apply to that platform (like the solarisaio engine, or
271 the splice engine on Linux).
272
273 Some features are not available on FreeBSD/Solaris even if they could be
274 implemented, I'd be happy to take patches for that. An example of that is
275 disk utility statistics and (I think) huge page support, support for that
276 does exist in FreeBSD/Solaris.
277
278 Fio uses pthread mutexes for signalling and locking and FreeBSD does not
279 support process shared pthread mutexes. As a result, only threads are
280 supported on FreeBSD. This could be fixed with sysv ipc locking or
281 other locking alternatives.
282
283 Other *BSD platforms are untested, but fio should work there almost out
284 of the box. Since I don't do test runs or even compiles on those platforms,
285 your mileage may vary. Sending me patches for other platforms is greatly
286 appreciated. There's a lot of value in having the same test/benchmark tool
287 available on all platforms.
288
289
290
291 Author
292 ------
293
294 Fio was written by Jens Axboe <axboe@kernel.dk> to enable flexible testing
295 of the Linux IO subsystem and schedulers. He got tired of writing
296 specific test applications to simulate a given workload, and found that
297 the existing io benchmark/test tools out there weren't flexible enough
298 to do what he wanted.
299
300 Jens Axboe <axboe@kernel.dk> 20060905
301