blob: 4ae0a5c860898d44376fd18c5403ed7c0c021a34 [file] [log] [blame]
Aaron Carrolld60e92d2007-09-17 10:32:59 +02001.TH fio 1 "September 2007" "User Manual"
2.SH NAME
3fio \- flexible I/O tester
4.SH SYNOPSIS
5.B fio
6[\fIoptions\fR] [\fIjobfile\fR]...
7.SH DESCRIPTION
8.B fio
9is a tool that will spawn a number of threads or processes doing a
10particular type of I/O action as specified by the user.
11The typical use of fio is to write a job file matching the I/O load
12one wants to simulate.
13.SH OPTIONS
14.TP
15.BI \-\-output \fR=\fPfilename
16Write output to \fIfilename\fR.
17.TP
18.BI \-\-timeout \fR=\fPtimeout
19Limit run time to \fItimeout\fR seconds.
20.TP
21.B \-\-latency\-log
22Generate per-job latency logs.
23.TP
24.B \-\-bandwidth\-log
25Generate per-job bandwidth logs.
26.TP
27.B \-\-minimal
Aaron Carrolld1429b52007-09-18 08:10:57 +020028Print statistics in a terse, semicolon-delimited format.
Aaron Carrolld60e92d2007-09-17 10:32:59 +020029.TP
30.BI \-\-showcmd \fR=\fPjobfile
31Convert \fIjobfile\fR to a set of command-line options.
32.TP
33.B \-\-readonly
34Enable read-only safety checks.
35.TP
36.BI \-\-eta \fR=\fPwhen
37Specifies when real-time ETA estimate should be printed. \fIwhen\fR may
38be one of `always', `never' or `auto'.
39.TP
Aaron Carrollc0a5d352008-02-26 23:10:39 +010040.BI \-\-section \fR=\fPsec
41Only run section \fIsec\fR from job file.
42.TP
Aaron Carrolld60e92d2007-09-17 10:32:59 +020043.BI \-\-cmdhelp \fR=\fPcommand
44Print help information for \fIcommand\fR. May be `all' for all commands.
45.TP
Jens Axboe91837882008-02-05 12:02:07 +010046.BI \-\-debug \fR=\fPtype
47Enable verbose tracing of various fio actions. May be `all' for all types
48or individual types seperated by a comma (eg --debug=io,file). `help' will
49list all available tracing options.
50.TP
Aaron Carrolld60e92d2007-09-17 10:32:59 +020051.B \-\-help
52Display usage information and exit.
53.TP
54.B \-\-version
55Display version information and exit.
56.SH "JOB FILE FORMAT"
57Job files are in `ini' format. They consist of one or more
58job definitions, which begin with a job name in square brackets and
59extend to the next job name. The job name can be any ASCII string
60except `global', which has a special meaning. Following the job name is
61a sequence of zero or more parameters, one per line, that define the
62behavior of the job. Any line starting with a `;' or `#' character is
Aaron Carrolld1429b52007-09-18 08:10:57 +020063considered a comment and ignored.
Aaron Carrolld9956b62007-11-16 12:12:45 +010064.P
65If \fIjobfile\fR is specified as `-', the job file will be read from
66standard input.
Aaron Carrolld60e92d2007-09-17 10:32:59 +020067.SS "Global Section"
68The global section contains default parameters for jobs specified in the
69job file. A job is only affected by global sections residing above it,
70and there may be any number of global sections. Specific job definitions
71may override any parameter set in global sections.
72.SH "JOB PARAMETERS"
73.SS Types
74Some parameters may take arguments of a specific type. The types used are:
75.TP
76.I str
77String: a sequence of alphanumeric characters.
78.TP
79.I int
Aaron Carrolld60e92d2007-09-17 10:32:59 +020080SI integer: a whole number, possibly containing a suffix denoting the base unit
81of the value. Accepted suffixes are `k', 'M' and 'G', denoting kilo (1024),
Jens Axboef7fa2652009-03-09 14:20:20 +010082mega (1024*1024) and giga (1024*1024*1024) respectively. If prefixed with '0x',
83the value is assumed to be base 16 (hexadecimal).
Aaron Carrolld60e92d2007-09-17 10:32:59 +020084.TP
85.I bool
86Boolean: a true or false value. `0' denotes false, `1' denotes true.
87.TP
88.I irange
89Integer range: a range of integers specified in the format
Aaron Carrolld1429b52007-09-18 08:10:57 +020090\fIlower\fR:\fIupper\fR or \fIlower\fR\-\fIupper\fR. \fIlower\fR and
91\fIupper\fR may contain a suffix as described above. If an option allows two
92sets of ranges, they are separated with a `,' or `/' character. For example:
93`8\-8k/8M\-4G'.
Aaron Carrolld60e92d2007-09-17 10:32:59 +020094.SS "Parameter List"
95.TP
96.BI name \fR=\fPstr
Aaron Carrolld9956b62007-11-16 12:12:45 +010097May be used to override the job name. On the command line, this parameter
Aaron Carrolld60e92d2007-09-17 10:32:59 +020098has the special purpose of signalling the start of a new job.
99.TP
100.BI description \fR=\fPstr
101Human-readable description of the job. It is printed when the job is run, but
102otherwise has no special purpose.
103.TP
104.BI directory \fR=\fPstr
105Prefix filenames with this directory. Used to place files in a location other
106than `./'.
107.TP
108.BI filename \fR=\fPstr
109.B fio
110normally makes up a file name based on the job name, thread number, and file
Aaron Carrolld1429b52007-09-18 08:10:57 +0200111number. If you want to share files between threads in a job or several jobs,
112specify a \fIfilename\fR for each of them to override the default. If the I/O
113engine used is `net', \fIfilename\fR is the host and port to connect to in the
114format \fIhost\fR/\fIport\fR. If the I/O engine is file-based, you can specify
115a number of files by separating the names with a `:' character. `\-' is a
116reserved name, meaning stdin or stdout, depending on the read/write direction
117set.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200118.TP
119.BI opendir \fR=\fPstr
120Recursively open any files below directory \fIstr\fR.
121.TP
122.BI readwrite \fR=\fPstr "\fR,\fP rw" \fR=\fPstr
123Type of I/O pattern. Accepted values are:
124.RS
125.RS
126.TP
127.B read
Aaron Carrolld1429b52007-09-18 08:10:57 +0200128Sequential reads.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200129.TP
130.B write
Aaron Carrolld1429b52007-09-18 08:10:57 +0200131Sequential writes.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200132.TP
133.B randread
Aaron Carrolld1429b52007-09-18 08:10:57 +0200134Random reads.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200135.TP
136.B randwrite
Aaron Carrolld1429b52007-09-18 08:10:57 +0200137Random writes.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200138.TP
139.B rw
Aaron Carrolld1429b52007-09-18 08:10:57 +0200140Mixed sequential reads and writes.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200141.TP
142.B randrw
Aaron Carrolld1429b52007-09-18 08:10:57 +0200143Mixed random reads and writes.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200144.RE
145.P
Aaron Carrolld1429b52007-09-18 08:10:57 +0200146For mixed I/O, the default split is 50/50. For random I/O, the number of I/Os
147to perform before getting a new offset can be specified by appending
148`:\fIint\fR' to the pattern type. The default is 1.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200149.RE
150.TP
151.BI randrepeat \fR=\fPbool
152Seed the random number generator in a predictable way so results are repeatable
Aaron Carrolld1429b52007-09-18 08:10:57 +0200153across runs. Default: true.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200154.TP
155.BI fadvise_hint \fR=\fPbool
Aaron Carrolld1429b52007-09-18 08:10:57 +0200156Disable use of \fIposix_fadvise\fR\|(2) to advise the kernel what I/O patterns
157are likely to be issued. Default: true.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200158.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100159.BI size \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200160Total size of I/O for this job. \fBfio\fR will run until this many bytes have
161been transfered, unless limited by other options (\fBruntime\fR, for instance).
162Unless \fBnr_files\fR and \fBfilesize\fR options are given, this amount will be
163divided between the available files for the job.
164.TP
165.BI filesize \fR=\fPirange
166Individual file sizes. May be a range, in which case \fBfio\fR will select sizes
Aaron Carrolld1429b52007-09-18 08:10:57 +0200167for files at random within the given range, limited to \fBsize\fR in total (if
168that is given). If \fBfilesize\fR is not specified, each created file is the
169same size.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200170.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100171.BI blocksize \fR=\fPint[,int] "\fR,\fB bs" \fR=\fPint[,int]
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200172Block size for I/O units. Default: 4k. Values for reads and writes can be
173specified seperately in the format \fIread\fR,\fIwrite\fR, either of
174which may be empty to leave that value at its default.
175.TP
Jens Axboe91837882008-02-05 12:02:07 +0100176.BI blocksize_range \fR=\fPirange[,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange]
Aaron Carrolld1429b52007-09-18 08:10:57 +0200177Specify a range of I/O block sizes. The issued I/O unit will always be a
178multiple of the minimum size, unless \fBblocksize_unaligned\fR is set. Applies
Jens Axboe91837882008-02-05 12:02:07 +0100179to both reads and writes if only one range is given, but can be specified
180seperately with a comma seperating the values. Example: bsrange=1k-4k,2k-8k.
181Also (see \fBblocksize\fR).
182.TP
183.BI bssplit \fR=\fPstr
184This option allows even finer grained control of the block sizes issued,
185not just even splits between them. With this option, you can weight various
186block sizes for exact control of the issued IO for a job that has mixed
187block sizes. The format of the option is bssplit=blocksize/percentage,
188optionally adding as many definitions as needed seperated by a colon.
189Example: bssplit=4k/10:64k/50:32k/40 would issue 50% 64k blocks, 10% 4k
190blocks and 40% 32k blocks.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200191.TP
192.B blocksize_unaligned\fR,\fP bs_unaligned
Aaron Carrolld1429b52007-09-18 08:10:57 +0200193If set, any size in \fBblocksize_range\fR may be used. This typically won't
194work with direct I/O, as that normally requires sector alignment.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200195.TP
196.B zero_buffers
197Initialise buffers with all zeros. Default: fill buffers with random data.
198.TP
199.BI nrfiles \fR=\fPint
200Number of files to use for this job. Default: 1.
201.TP
202.BI openfiles \fR=\fPint
203Number of files to keep open at the same time. Default: \fBnrfiles\fR.
204.TP
205.BI file_service_type \fR=\fPstr
206Defines how files to service are selected. The following types are defined:
207.RS
208.RS
209.TP
210.B random
211Choose a file at random
212.TP
213.B roundrobin
214Round robin over open files (default).
215.RE
216.P
217The number of I/Os to issue before switching a new file can be specified by
218appending `:\fIint\fR' to the service type.
219.RE
220.TP
221.BI ioengine \fR=\fPstr
222Defines how the job issues I/O. The following types are defined:
223.RS
224.RS
225.TP
226.B sync
227Basic \fIread\fR\|(2) or \fIwrite\fR\|(2) I/O. \fIfseek\fR\|(2) is used to
228position the I/O location.
229.TP
gurudas paia31041e2007-10-23 15:12:30 +0200230.B psync
231Basic \fIpread\fR\|(2) or \fIpwrite\fR\|(2) I/O.
232.TP
Jens Axboe91837882008-02-05 12:02:07 +0100233.B vsync
234Basic \fIreadv\fR\|(2) or \fIwritev\fR\|(2) I/O. Will emulate queuing by
235coalescing adjacents IOs into a single submission.
236.TP
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200237.B libaio
238Linux native asynchronous I/O.
239.TP
240.B posixaio
241glibc POSIX asynchronous I/O using \fIaio_read\fR\|(3) and \fIaio_write\fR\|(3).
242.TP
243.B mmap
Aaron Carrolld1429b52007-09-18 08:10:57 +0200244File is memory mapped with \fImmap\fR\|(2) and data copied using
245\fImemcpy\fR\|(3).
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200246.TP
247.B splice
Aaron Carrolld1429b52007-09-18 08:10:57 +0200248\fIsplice\fR\|(2) is used to transfer the data and \fIvmsplice\fR\|(2) to
249transfer data from user-space to the kernel.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200250.TP
251.B syslet-rw
252Use the syslet system calls to make regular read/write asynchronous.
253.TP
254.B sg
255SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if
Aaron Carrolld1429b52007-09-18 08:10:57 +0200256the target is an sg character device, we use \fIread\fR\|(2) and
257\fIwrite\fR\|(2) for asynchronous I/O.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200258.TP
259.B null
260Doesn't transfer any data, just pretends to. Mainly used to exercise \fBfio\fR
261itself and for debugging and testing purposes.
262.TP
263.B net
264Transfer over the network. \fBfilename\fR must be set appropriately to
265`\fIhost\fR/\fIport\fR' regardless of data direction. If receiving, only the
266\fIport\fR argument is used.
267.TP
268.B netsplice
269Like \fBnet\fR, but uses \fIsplice\fR\|(2) and \fIvmsplice\fR\|(2) to map data
270and send/receive.
271.TP
gurudas pai53aec0a2007-10-05 13:20:18 +0200272.B cpuio
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200273Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and
274\fBcpucycles\fR parameters.
275.TP
276.B guasi
277The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface
278approach to asycnronous I/O.
Aaron Carrolld1429b52007-09-18 08:10:57 +0200279.br
280See <http://www.xmailserver.org/guasi\-lib.html>.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200281.TP
282.B external
283Loads an external I/O engine object file. Append the engine filename as
284`:\fIenginepath\fR'.
285.RE
286.RE
287.TP
288.BI iodepth \fR=\fPint
289Number of I/O units to keep in flight against the file. Default: 1.
290.TP
291.BI iodepth_batch \fR=\fPint
292Number of I/Os to submit at once. Default: \fBiodepth\fR.
293.TP
294.BI iodepth_low \fR=\fPint
295Low watermark indicating when to start filling the queue again. Default:
296\fBiodepth\fR.
297.TP
298.BI direct \fR=\fPbool
299If true, use non-buffered I/O (usually O_DIRECT). Default: false.
300.TP
301.BI buffered \fR=\fPbool
302If true, use buffered I/O. This is the opposite of the \fBdirect\fR parameter.
303Default: true.
304.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100305.BI offset \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200306Offset in the file to start I/O. Data before the offset will not be touched.
307.TP
308.BI fsync \fR=\fPint
Aaron Carrolld1429b52007-09-18 08:10:57 +0200309How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data. If
3100, don't sync. Default: 0.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200311.TP
312.BI overwrite \fR=\fPbool
Aaron Carrolld1429b52007-09-18 08:10:57 +0200313If writing, setup the file first and do overwrites. Default: false.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200314.TP
315.BI end_fsync \fR=\fPbool
Aaron Carrolld1429b52007-09-18 08:10:57 +0200316Sync file contents when job exits. Default: false.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200317.TP
318.BI fsync_on_close \fR=\fPbool
319If true, sync file contents on close. This differs from \fBend_fsync\fR in that
Aaron Carrolld1429b52007-09-18 08:10:57 +0200320it will happen on every close, not just at the end of the job. Default: false.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200321.TP
322.BI rwmixcycle \fR=\fPint
323How many milliseconds before switching between reads and writes for a mixed
324workload. Default: 500ms.
325.TP
326.BI rwmixread \fR=\fPint
327Percentage of a mixed workload that should be reads. Default: 50.
328.TP
329.BI rwmixwrite \fR=\fPint
Aaron Carrolld1429b52007-09-18 08:10:57 +0200330Percentage of a mixed workload that should be writes. If \fBrwmixread\fR and
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200331\fBwrmixwrite\fR are given and do not sum to 100%, the latter of the two
Aaron Carrolld1429b52007-09-18 08:10:57 +0200332overrides the first. Default: 50.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200333.TP
334.B norandommap
335Normally \fBfio\fR will cover every block of the file when doing random I/O. If
336this parameter is given, a new offset will be chosen without looking at past
337I/O history. This parameter is mutually exclusive with \fBverify\fR.
338.TP
339.BI nice \fR=\fPint
340Run job with given nice value. See \fInice\fR\|(2).
341.TP
342.BI prio \fR=\fPint
343Set I/O priority value of this job between 0 (highest) and 7 (lowest). See
344\fIionice\fR\|(1).
345.TP
346.BI prioclass \fR=\fPint
347Set I/O priority class. See \fIionice\fR\|(1).
348.TP
349.BI thinktime \fR=\fPint
350Stall job for given number of microseconds between issuing I/Os.
351.TP
352.BI thinktime_spin \fR=\fPint
353Pretend to spend CPU time for given number of microseconds, sleeping the rest
354of the time specified by \fBthinktime\fR. Only valid if \fBthinktime\fR is set.
355.TP
356.BI thinktime_blocks \fR=\fPint
357Number of blocks to issue before waiting \fBthinktime\fR microseconds.
358Default: 1.
359.TP
360.BI rate \fR=\fPint
361Cap bandwidth used by this job to this number of KiB/s.
362.TP
363.BI ratemin \fR=\fPint
364Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth.
365Failing to meet this requirement will cause the job to exit.
366.TP
367.BI rate_iops \fR=\fPint
368Cap the bandwidth to this number of IOPS. If \fBblocksize\fR is a range, the
369smallest block size is used as the metric.
370.TP
371.BI rate_iops_min \fR=\fPint
372If this rate of I/O is not met, the job will exit.
373.TP
374.BI ratecycle \fR=\fPint
375Average bandwidth for \fBrate\fR and \fBratemin\fR over this number of
376milliseconds. Default: 1000ms.
377.TP
378.BI cpumask \fR=\fPint
379Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job
380may run on. See \fBsched_setaffinity\fR\|(2).
381.TP
382.BI cpus_allowed \fR=\fPstr
383Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers.
384.TP
385.BI startdelay \fR=\fPint
386Delay start of job for the specified number of seconds.
387.TP
388.BI runtime \fR=\fPint
389Terminate processing after the specified number of seconds.
390.TP
391.B time_based
392If given, run for the specified \fBruntime\fR duration even if the files are
393completely read or written. The same workload will be repeated as many times
394as \fBruntime\fR allows.
395.TP
396.BI invalidate \fR=\fPbool
397Invalidate buffer-cache for the file prior to starting I/O. Default: true.
398.TP
399.BI sync \fR=\fPbool
400Use synchronous I/O for buffered writes. For the majority of I/O engines,
Aaron Carrolld1429b52007-09-18 08:10:57 +0200401this means using O_SYNC. Default: false.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200402.TP
403.BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
404Allocation method for I/O unit buffer. Allowed values are:
405.RS
406.RS
407.TP
408.B malloc
409Allocate memory with \fImalloc\fR\|(3).
410.TP
411.B shm
412Use shared memory buffers allocated through \fIshmget\fR\|(2).
413.TP
414.B shmhuge
415Same as \fBshm\fR, but use huge pages as backing.
416.TP
417.B mmap
418Use \fImmap\fR\|(2) for allocation. Uses anonymous memory unless a filename
419is given after the option in the format `:\fIfile\fR'.
420.TP
421.B mmaphuge
422Same as \fBmmap\fR, but use huge files as backing.
423.RE
424.P
425The amount of memory allocated is the maximum allowed \fBblocksize\fR for the
426job multiplied by \fBiodepth\fR. For \fBshmhuge\fR or \fBmmaphuge\fR to work,
427the system must have free huge pages allocated. \fBmmaphuge\fR also needs to
428have hugetlbfs mounted, and \fIfile\fR must point there.
429.RE
430.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100431.BI hugepage\-size \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200432Defines the size of a huge page. Must be at least equal to the system setting.
433Should be a multiple of 1MiB. Default: 4MiB.
434.TP
435.B exitall
436Terminate all jobs when one finishes. Default: wait for each job to finish.
437.TP
438.BI bwavgtime \fR=\fPint
439Average bandwidth calculations over the given time in milliseconds. Default:
440500ms.
441.TP
442.BI create_serialize \fR=\fPbool
Aaron Carrolld1429b52007-09-18 08:10:57 +0200443If true, serialize file creation for the jobs. Default: true.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200444.TP
445.BI create_fsync \fR=\fPbool
446\fIfsync\fR\|(2) data file after creation. Default: true.
447.TP
448.BI unlink \fR=\fPbool
449Unlink job files when done. Default: false.
450.TP
451.BI loops \fR=\fPint
452Specifies the number of iterations (runs of the same workload) of this job.
453Default: 1.
454.TP
455.BI do_verify \fR=\fPbool
456Run the verify phase after a write phase. Only valid if \fBverify\fR is set.
457Default: true.
458.TP
459.BI verify \fR=\fPstr
460Method of verifying file contents after each iteration of the job. Allowed
461values are:
462.RS
463.RS
464.TP
465.B md5 crc16 crc32 crc64 crc7 sha256 sha512
466Store appropriate checksum in the header of each block.
467.TP
468.B meta
469Write extra information about each I/O (timestamp, block number, etc.). The
470block number is verified.
471.TP
472.B pattern
473Fill I/O buffers with a specific pattern that is used to verify. The pattern is
474specified by appending `:\fIint\fR' to the parameter. \fIint\fR cannot be larger
475than 32-bits.
476.TP
477.B null
478Pretend to verify. Used for testing internals.
479.RE
480.RE
481.TP
482.BI verify_sort \fR=\fPbool
483If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to
484read them back in a sorted manner. Default: true.
485.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100486.BI verify_offset \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200487Swap the verification header with data somewhere else in the block before
Aaron Carrolld1429b52007-09-18 08:10:57 +0200488writing. It is swapped back before verifying.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200489.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100490.BI verify_interval \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200491Write the verification header for this number of bytes, which should divide
492\fBblocksize\fR. Default: \fBblocksize\fR.
493.TP
494.BI verify_fatal \fR=\fPbool
495If true, exit the job on the first observed verification failure. Default:
496false.
497.TP
498.B stonewall
Aaron Carrolld1429b52007-09-18 08:10:57 +0200499Wait for preceeding jobs in the job file to exit before starting this one.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200500\fBstonewall\fR implies \fBnew_group\fR.
501.TP
502.B new_group
503Start a new reporting group. If not given, all jobs in a file will be part
504of the same reporting group, unless separated by a stonewall.
505.TP
506.BI numjobs \fR=\fPint
507Number of clones (processes/threads performing the same workload) of this job.
508Default: 1.
509.TP
510.B group_reporting
511If set, display per-group reports instead of per-job when \fBnumjobs\fR is
512specified.
513.TP
514.B thread
515Use threads created with \fBpthread_create\fR\|(3) instead of processes created
516with \fBfork\fR\|(2).
517.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100518.BI zonesize \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200519Divide file into zones of the specified size in bytes. See \fBzoneskip\fR.
520.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100521.BI zoneskip \fR=\fPint
Aaron Carrolld1429b52007-09-18 08:10:57 +0200522Skip the specified number of bytes when \fBzonesize\fR bytes of data have been
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200523read.
524.TP
525.BI write_iolog \fR=\fPstr
526Write the issued I/O patterns to the specified file.
527.TP
528.BI read_iolog \fR=\fPstr
529Replay the I/O patterns contained in the specified file generated by
530\fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file.
531.TP
532.B write_bw_log
533If given, write bandwidth logs of the jobs in this file.
534.TP
535.B write_lat_log
536Same as \fBwrite_bw_log\fR, but writes I/O completion latencies.
537.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100538.BI lockmem \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200539Pin the specified amount of memory with \fBmlock\fR\|(2). Can be used to
540simulate a smaller amount of memory.
541.TP
542.BI exec_prerun \fR=\fPstr
543Before running the job, execute the specified command with \fBsystem\fR\|(3).
544.TP
545.BI exec_postrun \fR=\fPstr
546Same as \fBexec_prerun\fR, but the command is executed after the job completes.
547.TP
548.BI ioscheduler \fR=\fPstr
549Attempt to switch the device hosting the file to the specified I/O scheduler.
550.TP
551.BI cpuload \fR=\fPint
552If the job is a CPU cycle-eater, attempt to use the specified percentage of
553CPU cycles.
554.TP
555.BI cpuchunks \fR=\fPint
556If the job is a CPU cycle-eater, split the load into cycles of the
557given time in milliseconds.
558.TP
559.BI disk_util \fR=\fPbool
Aaron Carrolld1429b52007-09-18 08:10:57 +0200560Generate disk utilization statistics if the platform supports it. Default: true.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200561.SH OUTPUT
Aaron Carrolld1429b52007-09-18 08:10:57 +0200562While running, \fBfio\fR will display the status of the created jobs. For
563example:
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200564.RS
Aaron Carrolld1429b52007-09-18 08:10:57 +0200565.P
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200566Threads: 1: [_r] [24.8% done] [ 13509/ 8334 kb/s] [eta 00h:01m:31s]
567.RE
568.P
Aaron Carrolld1429b52007-09-18 08:10:57 +0200569The characters in the first set of brackets denote the current status of each
570threads. The possible values are:
571.P
572.PD 0
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200573.RS
574.TP
575.B P
576Setup but not started.
577.TP
578.B C
579Thread created.
580.TP
581.B I
582Initialized, waiting.
583.TP
584.B R
585Running, doing sequential reads.
586.TP
587.B r
588Running, doing random reads.
589.TP
590.B W
591Running, doing sequential writes.
592.TP
593.B w
594Running, doing random writes.
595.TP
596.B M
597Running, doing mixed sequential reads/writes.
598.TP
599.B m
600Running, doing mixed random reads/writes.
601.TP
602.B F
603Running, currently waiting for \fBfsync\fR\|(2).
604.TP
605.B V
606Running, verifying written data.
607.TP
608.B E
609Exited, not reaped by main thread.
610.TP
611.B \-
612Exited, thread reaped.
613.RE
Aaron Carrolld1429b52007-09-18 08:10:57 +0200614.PD
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200615.P
616The second set of brackets shows the estimated completion percentage of
617the current group. The third set shows the read and write I/O rate,
618respectively. Finally, the estimated run time of the job is displayed.
619.P
620When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data
621for each thread, each group of threads, and each disk, in that order.
622.P
623Per-thread statistics first show the threads client number, group-id, and
624error code. The remaining figures are as follows:
625.RS
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200626.TP
627.B io
628Number of megabytes of I/O performed.
629.TP
630.B bw
631Average data rate (bandwidth).
632.TP
633.B runt
634Threads run time.
635.TP
636.B slat
637Submission latency minimum, maximum, average and standard deviation. This is
638the time it took to submit the I/O.
639.TP
640.B clat
641Completion latency minimum, maximum, average and standard deviation. This
642is the time between submission and completion.
643.TP
644.B bw
645Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average
646and standard deviation.
647.TP
648.B cpu
649CPU usage statistics. Includes user and system time, number of context switches
650this thread went through and number of major and minor page faults.
651.TP
652.B IO depths
653Distribution of I/O depths. Each depth includes everything less than (or equal)
654to it, but greater than the previous depth.
655.TP
656.B IO issued
657Number of read/write requests issued, and number of short read/write requests.
658.TP
659.B IO latencies
660Distribution of I/O completion latencies. The numbers follow the same pattern
661as \fBIO depths\fR.
662.RE
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200663.P
664The group statistics show:
Aaron Carrolld1429b52007-09-18 08:10:57 +0200665.PD 0
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200666.RS
667.TP
668.B io
669Number of megabytes I/O performed.
670.TP
671.B aggrb
672Aggregate bandwidth of threads in the group.
673.TP
674.B minb
675Minimum average bandwidth a thread saw.
676.TP
677.B maxb
678Maximum average bandwidth a thread saw.
679.TP
680.B mint
Aaron Carrolld1429b52007-09-18 08:10:57 +0200681Shortest runtime of threads in the group.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200682.TP
683.B maxt
684Longest runtime of threads in the group.
685.RE
Aaron Carrolld1429b52007-09-18 08:10:57 +0200686.PD
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200687.P
688Finally, disk statistics are printed with reads first:
Aaron Carrolld1429b52007-09-18 08:10:57 +0200689.PD 0
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200690.RS
691.TP
692.B ios
693Number of I/Os performed by all groups.
694.TP
695.B merge
696Number of merges in the I/O scheduler.
697.TP
698.B ticks
699Number of ticks we kept the disk busy.
700.TP
701.B io_queue
702Total time spent in the disk queue.
703.TP
704.B util
705Disk utilization.
706.RE
Aaron Carrolld1429b52007-09-18 08:10:57 +0200707.PD
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200708.SH TERSE OUTPUT
709If the \fB\-\-minimal\fR option is given, the results will be printed in a
710semicolon-delimited format suitable for scripted use. The fields are:
711.P
712.RS
713.B jobname, groupid, error
714.P
715Read status:
716.RS
717.B KiB I/O, bandwidth \fR(KiB/s)\fP, runtime \fR(ms)\fP
718.P
719Submission latency:
720.RS
721.B min, max, mean, standard deviation
722.RE
723Completion latency:
724.RS
725.B min, max, mean, standard deviation
726.RE
727Bandwidth:
728.RS
729.B min, max, aggregate percentage of total, mean, standard deviation
730.RE
731.RE
732.P
733Write status:
734.RS
735.B KiB I/O, bandwidth \fR(KiB/s)\fP, runtime \fR(ms)\fP
736.P
737Submission latency:
738.RS
739.B min, max, mean, standard deviation
740.RE
741Completion latency:
742.RS
743.B min, max, mean, standard deviation
744.RE
745Bandwidth:
746.RS
747.B min, max, aggregate percentage of total, mean, standard deviation
748.RE
749.RE
750.P
Aaron Carrolld1429b52007-09-18 08:10:57 +0200751CPU usage:
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200752.RS
Carl Henrik Lundebd2626f2008-06-12 09:17:46 +0200753.B user, system, context switches, major page faults, minor page faults
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200754.RE
755.P
756IO depth distribution:
757.RS
758.B <=1, 2, 4, 8, 16, 32, >=64
759.RE
760.P
761IO latency distribution (ms):
762.RS
763.B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, >=2000
764.RE
765.P
766.B text description
767.RE
768.SH AUTHORS
769.B fio
770was written by Jens Axboe <jens.axboe@oracle.com>.
Aaron Carrolld1429b52007-09-18 08:10:57 +0200771.br
772This man page was written by Aaron Carroll <aaronc@cse.unsw.edu.au> based
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200773on documentation by Jens Axboe.
774.SH "REPORTING BUGS"
Aaron Carrolld1429b52007-09-18 08:10:57 +0200775Report bugs to the \fBfio\fR mailing list <fio-devel@kernel.dk>.
776See \fBREADME\fR.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200777.SH "SEE ALSO"
Aaron Carrolld1429b52007-09-18 08:10:57 +0200778For further documentation see \fBHOWTO\fR and \fBREADME\fR.
779.br
780Sample jobfiles are available in the \fBexamples\fR directory.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200781