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