Fio 1.16.9
[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 - basically anything that has to
44 do with fio. An automated mail detailing recent commits is automatically
45 sent to the list at most daily. The list address is fio-devel@kernel.dk,
46 subscribe by sending an empty email to fio-devel+subscribe@kernel.dk.
47
48
49 Building
50 --------
51
52 Just type 'make' and 'make install'. If on FreeBSD, for now you have to
53 specify the FreeBSD Makefile with -f, eg:
54
55 $ make -f Makefile.Freebsd && make -f Makefile.FreeBSD install
56
57 Likewise with OpenSolaris, use the Makefile.solaris to compile there.
58 This might change in the future if I opt for an autoconf type setup.
59
60
61 Command line
62 ------------
63
64 $ fio
65         --output        Write output to file
66         --runtime       Runtime in seconds
67         --latency-log   Generate per-job latency logs
68         --bandwidth-log Generate per-job bandwidth logs
69         --minimal       Minimal (terse) output
70         --version       Print version info and exit
71         --help          Print this page
72         --cmdhelp=cmd   Print command help, "all" for all of them
73         --showcmd       Turn a job file into command line options
74
75 Any parameters following the options will be assumed to be job files,
76 unless they match a job file parameter. You can add as many as you want,
77 each job file will be regarded as a separate group and fio will stonewall
78 its execution.
79
80
81 Job file
82 --------
83
84 See the HOWTO file for a more detailed description of parameters and what
85 they mean. This file contains the terse version.  Only a few options can
86 be controlled with command line parameters, generally it's a lot easier to
87 just write a simple job file to describe the workload. The job file format
88 is in the ini style format, as it's easy to read and write for the user.
89
90 The job file parameters are:
91
92         name=x          Use 'x' as the identifier for this job.
93         description=x   'x' is a text description of the job.
94         directory=x     Use 'x' as the top level directory for storing files
95         filename=x      Force the use of 'x' as the filename for all files
96                         in this thread. If not given, fio will make up
97                         a suitable filename based on the thread and file
98                         number.
99         rw=x            'x' may be: read, randread, write, randwrite,
100                         rw (read-write mix), randrw (read-write random mix)
101         rwmixcycle=x    Base cycle for switching between read and write
102                         in msecs.
103         rwmixread=x     'x' percentage of rw mix ios will be reads. If
104                         rwmixwrite is also given, the last of the two will
105                          be used if they don't add up to 100%.
106         rwmixwrite=x    'x' percentage of rw mix ios will be writes. See
107                         rwmixread.
108         rand_repeatable=x  The sequence of random io blocks can be repeatable
109                         across runs, if 'x' is 1.
110         size=x          Set file size to x bytes (x string can include k/m/g)
111         ioengine=x      'x' may be: aio/libaio/linuxaio for Linux aio,
112                         posixaio for POSIX aio, sync for regular read/write io,
113                         mmap for mmap'ed io, syslet-rw for syslet driven
114                         read/write, splice for using splice/vmsplice,
115                         sgio for direct SG_IO io, net for network io, or cpuio
116                         for a cycler burner load. sgio only works on Linux on
117                         SCSI (or SCSI-like devices, such as usb-storage or
118                         sata/libata driven) devices. Fio also has a null io
119                         engine, which is mainly used for testing fio itself.
120         iodepth=x       For async io, allow 'x' ios in flight
121         overwrite=x     If 'x', layout a write file first.
122         nrfiles=x       Spread io load over 'x' number of files per job,
123                         if possible.
124         prio=x          Run io at prio X, 0-7 is the kernel allowed range
125         prioclass=x     Run io at prio class X
126         bs=x            Use 'x' for thread blocksize. May include k/m postfix.
127         bsrange=x-y     Mix thread block sizes randomly between x and y. May
128                         also include k/m postfix.
129         direct=x        1 for direct IO, 0 for buffered IO
130         thinktime=x     "Think" x usec after each io
131         rate=x          Throttle rate to x KiB/sec
132         ratemin=x       Quit if rate of x KiB/sec can't be met
133         ratecycle=x     ratemin averaged over x msecs
134         cpumask=x       Only allow job to run on CPUs defined by mask.
135         cpus_allowed=x  Like 'cpumask', but allow text setting of CPU affinity.
136         fsync=x         If writing with buffered IO, fsync after every
137                         'x' blocks have been written.
138         end_fsync=x     If 'x', run fsync() after end-of-job.
139         startdelay=x    Start this thread x seconds after startup
140         runtime=x       Terminate x seconds after startup. Can include a
141                         normal time suffix if not given in seconds, such as
142                         'm' for minutes, 'h' for hours, and 'd' for days.
143         offset=x        Start io at offset x (x string can include k/m/g)
144         invalidate=x    Invalidate page cache for file prior to doing io
145         sync=x          Use sync writes if x and writing buffered IO.
146         mem=x           If x == malloc, use malloc for buffers. If x == shm,
147                         use shared memory for buffers. If x == mmap, use
148                         anonymous mmap.
149         exitall         When one thread quits, terminate the others
150         bwavgtime=x     Average bandwidth stats over an x msec window.
151         create_serialize=x      If 'x', serialize file creation.
152         create_fsync=x  If 'x', run fsync() after file creation.
153         unlink          If set, unlink files when done.
154         loops=x         Run the job 'x' number of times.
155         verify=x        If 'x' == md5, use md5 for verifies. If 'x' == crc32,
156                         use crc32 for verifies. md5 is 'safer', but crc32 is
157                         a lot faster. Only makes sense for writing to a file.
158         stonewall       Wait for preceeding jobs to end before running.
159         numjobs=x       Create 'x' similar entries for this job
160         thread          Use pthreads instead of forked jobs
161         zonesize=x
162         zoneskip=y      Zone options must be paired. If given, the job
163                         will skip y bytes for every x read/written. This
164                         can be used to gauge hard drive speed over the entire
165                         platter, without reading everything. Both x/y can
166                         include k/m/g suffix.
167         iolog=x         Open and read io pattern from file 'x'. The file must
168                         contain one io action per line in the following format:
169                         rw, offset, length
170                         where with rw=0/1 for read/write, and the offset
171                         and length entries being in bytes.
172         write_iolog=x   Write an iolog to file 'x' in the same format as iolog.
173                         The iolog options are exclusive, if both given the
174                         read iolog will be performed.
175         write_bw_log    Write a bandwidth log.
176         write_lat_log   Write a latency log.
177         lockmem=x       Lock down x amount of memory on the machine, to
178                         simulate a machine with less memory available. x can
179                         include k/m/g suffix.
180         nice=x          Run job at given nice value.
181         exec_prerun=x   Run 'x' before job io is begun.
182         exec_postrun=x  Run 'x' after job io has finished.
183         ioscheduler=x   Use ioscheduler 'x' for this job.
184         cpuload=x       For a CPU io thread, percentage of CPU time to attempt
185                         to burn.
186         cpuchunks=x     Split burn cycles into pieces of x usecs.
187
188
189 Author
190 ------
191
192 Fio was written by Jens Axboe <axboe@kernel.dk> to enable flexible testing
193 of the Linux IO subsystem and schedulers. He got tired of writing
194 specific test applications to simulate a given workload, and found that
195 the existing io benchmark/test tools out there weren't flexible enough
196 to do what he wanted.
197
198 Jens Axboe <axboe@kernel.dk> 20060905
199