blob: 04dcb73c7feed4c215a759acba536d410b1b56a7 [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
Jens Axboe2b7a01d2009-03-11 11:00:13 +0100196.BI blockalign \fR=\fPint[,int] "\fR,\fB ba" \fR=\fPint[,int]
197At what boundary to align random IO offsets. Defaults to the same as
198'blocksize' the minimum blocksize given. Minimum alignment is typically 512b
199for using direct IO, though it usually depends on the hardware block size.
200This option is mutually exclusive with using a random map for files, so it
201will turn off that option.
Jens Axboe43602662009-03-14 20:08:47 +0100202.TP
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200203.B zero_buffers
204Initialise buffers with all zeros. Default: fill buffers with random data.
205.TP
206.BI nrfiles \fR=\fPint
207Number of files to use for this job. Default: 1.
208.TP
209.BI openfiles \fR=\fPint
210Number of files to keep open at the same time. Default: \fBnrfiles\fR.
211.TP
212.BI file_service_type \fR=\fPstr
213Defines how files to service are selected. The following types are defined:
214.RS
215.RS
216.TP
217.B random
218Choose a file at random
219.TP
220.B roundrobin
221Round robin over open files (default).
Jens Axboe6b7f6852009-03-09 14:22:56 +0100222.B sequential
223Do each file in the set sequentially.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200224.RE
225.P
226The number of I/Os to issue before switching a new file can be specified by
227appending `:\fIint\fR' to the service type.
228.RE
229.TP
230.BI ioengine \fR=\fPstr
231Defines how the job issues I/O. The following types are defined:
232.RS
233.RS
234.TP
235.B sync
236Basic \fIread\fR\|(2) or \fIwrite\fR\|(2) I/O. \fIfseek\fR\|(2) is used to
237position the I/O location.
238.TP
gurudas paia31041e2007-10-23 15:12:30 +0200239.B psync
240Basic \fIpread\fR\|(2) or \fIpwrite\fR\|(2) I/O.
241.TP
Jens Axboe91837882008-02-05 12:02:07 +0100242.B vsync
243Basic \fIreadv\fR\|(2) or \fIwritev\fR\|(2) I/O. Will emulate queuing by
244coalescing adjacents IOs into a single submission.
245.TP
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200246.B libaio
247Linux native asynchronous I/O.
248.TP
249.B posixaio
250glibc POSIX asynchronous I/O using \fIaio_read\fR\|(3) and \fIaio_write\fR\|(3).
251.TP
252.B mmap
Aaron Carrolld1429b52007-09-18 08:10:57 +0200253File is memory mapped with \fImmap\fR\|(2) and data copied using
254\fImemcpy\fR\|(3).
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200255.TP
256.B splice
Aaron Carrolld1429b52007-09-18 08:10:57 +0200257\fIsplice\fR\|(2) is used to transfer the data and \fIvmsplice\fR\|(2) to
258transfer data from user-space to the kernel.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200259.TP
260.B syslet-rw
261Use the syslet system calls to make regular read/write asynchronous.
262.TP
263.B sg
264SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if
Aaron Carrolld1429b52007-09-18 08:10:57 +0200265the target is an sg character device, we use \fIread\fR\|(2) and
266\fIwrite\fR\|(2) for asynchronous I/O.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200267.TP
268.B null
269Doesn't transfer any data, just pretends to. Mainly used to exercise \fBfio\fR
270itself and for debugging and testing purposes.
271.TP
272.B net
273Transfer over the network. \fBfilename\fR must be set appropriately to
274`\fIhost\fR/\fIport\fR' regardless of data direction. If receiving, only the
275\fIport\fR argument is used.
276.TP
277.B netsplice
278Like \fBnet\fR, but uses \fIsplice\fR\|(2) and \fIvmsplice\fR\|(2) to map data
279and send/receive.
280.TP
gurudas pai53aec0a2007-10-05 13:20:18 +0200281.B cpuio
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200282Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and
283\fBcpucycles\fR parameters.
284.TP
285.B guasi
286The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface
287approach to asycnronous I/O.
Aaron Carrolld1429b52007-09-18 08:10:57 +0200288.br
289See <http://www.xmailserver.org/guasi\-lib.html>.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200290.TP
291.B external
292Loads an external I/O engine object file. Append the engine filename as
293`:\fIenginepath\fR'.
294.RE
295.RE
296.TP
297.BI iodepth \fR=\fPint
298Number of I/O units to keep in flight against the file. Default: 1.
299.TP
300.BI iodepth_batch \fR=\fPint
301Number of I/Os to submit at once. Default: \fBiodepth\fR.
302.TP
303.BI iodepth_low \fR=\fPint
304Low watermark indicating when to start filling the queue again. Default:
305\fBiodepth\fR.
306.TP
307.BI direct \fR=\fPbool
308If true, use non-buffered I/O (usually O_DIRECT). Default: false.
309.TP
310.BI buffered \fR=\fPbool
311If true, use buffered I/O. This is the opposite of the \fBdirect\fR parameter.
312Default: true.
313.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100314.BI offset \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200315Offset in the file to start I/O. Data before the offset will not be touched.
316.TP
317.BI fsync \fR=\fPint
Aaron Carrolld1429b52007-09-18 08:10:57 +0200318How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data. If
3190, don't sync. Default: 0.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200320.TP
321.BI overwrite \fR=\fPbool
Aaron Carrolld1429b52007-09-18 08:10:57 +0200322If writing, setup the file first and do overwrites. Default: false.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200323.TP
324.BI end_fsync \fR=\fPbool
Aaron Carrolld1429b52007-09-18 08:10:57 +0200325Sync file contents when job exits. Default: false.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200326.TP
327.BI fsync_on_close \fR=\fPbool
328If true, sync file contents on close. This differs from \fBend_fsync\fR in that
Aaron Carrolld1429b52007-09-18 08:10:57 +0200329it will happen on every close, not just at the end of the job. Default: false.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200330.TP
331.BI rwmixcycle \fR=\fPint
332How many milliseconds before switching between reads and writes for a mixed
333workload. Default: 500ms.
334.TP
335.BI rwmixread \fR=\fPint
336Percentage of a mixed workload that should be reads. Default: 50.
337.TP
338.BI rwmixwrite \fR=\fPint
Aaron Carrolld1429b52007-09-18 08:10:57 +0200339Percentage of a mixed workload that should be writes. If \fBrwmixread\fR and
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200340\fBwrmixwrite\fR are given and do not sum to 100%, the latter of the two
Aaron Carrolld1429b52007-09-18 08:10:57 +0200341overrides the first. Default: 50.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200342.TP
343.B norandommap
344Normally \fBfio\fR will cover every block of the file when doing random I/O. If
345this parameter is given, a new offset will be chosen without looking at past
346I/O history. This parameter is mutually exclusive with \fBverify\fR.
347.TP
348.BI nice \fR=\fPint
349Run job with given nice value. See \fInice\fR\|(2).
350.TP
351.BI prio \fR=\fPint
352Set I/O priority value of this job between 0 (highest) and 7 (lowest). See
353\fIionice\fR\|(1).
354.TP
355.BI prioclass \fR=\fPint
356Set I/O priority class. See \fIionice\fR\|(1).
357.TP
358.BI thinktime \fR=\fPint
359Stall job for given number of microseconds between issuing I/Os.
360.TP
361.BI thinktime_spin \fR=\fPint
362Pretend to spend CPU time for given number of microseconds, sleeping the rest
363of the time specified by \fBthinktime\fR. Only valid if \fBthinktime\fR is set.
364.TP
365.BI thinktime_blocks \fR=\fPint
366Number of blocks to issue before waiting \fBthinktime\fR microseconds.
367Default: 1.
368.TP
369.BI rate \fR=\fPint
370Cap bandwidth used by this job to this number of KiB/s.
371.TP
372.BI ratemin \fR=\fPint
373Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth.
374Failing to meet this requirement will cause the job to exit.
375.TP
376.BI rate_iops \fR=\fPint
377Cap the bandwidth to this number of IOPS. If \fBblocksize\fR is a range, the
378smallest block size is used as the metric.
379.TP
380.BI rate_iops_min \fR=\fPint
381If this rate of I/O is not met, the job will exit.
382.TP
383.BI ratecycle \fR=\fPint
384Average bandwidth for \fBrate\fR and \fBratemin\fR over this number of
385milliseconds. Default: 1000ms.
386.TP
387.BI cpumask \fR=\fPint
388Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job
389may run on. See \fBsched_setaffinity\fR\|(2).
390.TP
391.BI cpus_allowed \fR=\fPstr
392Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers.
393.TP
394.BI startdelay \fR=\fPint
395Delay start of job for the specified number of seconds.
396.TP
397.BI runtime \fR=\fPint
398Terminate processing after the specified number of seconds.
399.TP
400.B time_based
401If given, run for the specified \fBruntime\fR duration even if the files are
402completely read or written. The same workload will be repeated as many times
403as \fBruntime\fR allows.
404.TP
405.BI invalidate \fR=\fPbool
406Invalidate buffer-cache for the file prior to starting I/O. Default: true.
407.TP
408.BI sync \fR=\fPbool
409Use synchronous I/O for buffered writes. For the majority of I/O engines,
Aaron Carrolld1429b52007-09-18 08:10:57 +0200410this means using O_SYNC. Default: false.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200411.TP
412.BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
413Allocation method for I/O unit buffer. Allowed values are:
414.RS
415.RS
416.TP
417.B malloc
418Allocate memory with \fImalloc\fR\|(3).
419.TP
420.B shm
421Use shared memory buffers allocated through \fIshmget\fR\|(2).
422.TP
423.B shmhuge
424Same as \fBshm\fR, but use huge pages as backing.
425.TP
426.B mmap
427Use \fImmap\fR\|(2) for allocation. Uses anonymous memory unless a filename
428is given after the option in the format `:\fIfile\fR'.
429.TP
430.B mmaphuge
431Same as \fBmmap\fR, but use huge files as backing.
432.RE
433.P
434The amount of memory allocated is the maximum allowed \fBblocksize\fR for the
435job multiplied by \fBiodepth\fR. For \fBshmhuge\fR or \fBmmaphuge\fR to work,
436the system must have free huge pages allocated. \fBmmaphuge\fR also needs to
437have hugetlbfs mounted, and \fIfile\fR must point there.
438.RE
439.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100440.BI hugepage\-size \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200441Defines the size of a huge page. Must be at least equal to the system setting.
442Should be a multiple of 1MiB. Default: 4MiB.
443.TP
444.B exitall
445Terminate all jobs when one finishes. Default: wait for each job to finish.
446.TP
447.BI bwavgtime \fR=\fPint
448Average bandwidth calculations over the given time in milliseconds. Default:
449500ms.
450.TP
451.BI create_serialize \fR=\fPbool
Aaron Carrolld1429b52007-09-18 08:10:57 +0200452If true, serialize file creation for the jobs. Default: true.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200453.TP
454.BI create_fsync \fR=\fPbool
455\fIfsync\fR\|(2) data file after creation. Default: true.
456.TP
Jens Axboe6b7f6852009-03-09 14:22:56 +0100457.BI create_on_open \fR=\fPbool
458If true, the files are not created until they are opened for IO by the job.
459.TP
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200460.BI unlink \fR=\fPbool
461Unlink job files when done. Default: false.
462.TP
463.BI loops \fR=\fPint
464Specifies the number of iterations (runs of the same workload) of this job.
465Default: 1.
466.TP
467.BI do_verify \fR=\fPbool
468Run the verify phase after a write phase. Only valid if \fBverify\fR is set.
469Default: true.
470.TP
471.BI verify \fR=\fPstr
472Method of verifying file contents after each iteration of the job. Allowed
473values are:
474.RS
475.RS
476.TP
477.B md5 crc16 crc32 crc64 crc7 sha256 sha512
478Store appropriate checksum in the header of each block.
479.TP
480.B meta
481Write extra information about each I/O (timestamp, block number, etc.). The
482block number is verified.
483.TP
484.B pattern
485Fill I/O buffers with a specific pattern that is used to verify. The pattern is
486specified by appending `:\fIint\fR' to the parameter. \fIint\fR cannot be larger
487than 32-bits.
488.TP
489.B null
490Pretend to verify. Used for testing internals.
491.RE
492.RE
493.TP
494.BI verify_sort \fR=\fPbool
495If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to
496read them back in a sorted manner. Default: true.
497.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100498.BI verify_offset \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200499Swap the verification header with data somewhere else in the block before
Aaron Carrolld1429b52007-09-18 08:10:57 +0200500writing. It is swapped back before verifying.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200501.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100502.BI verify_interval \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200503Write the verification header for this number of bytes, which should divide
504\fBblocksize\fR. Default: \fBblocksize\fR.
505.TP
506.BI verify_fatal \fR=\fPbool
507If true, exit the job on the first observed verification failure. Default:
508false.
509.TP
510.B stonewall
Aaron Carrolld1429b52007-09-18 08:10:57 +0200511Wait for preceeding jobs in the job file to exit before starting this one.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200512\fBstonewall\fR implies \fBnew_group\fR.
513.TP
514.B new_group
515Start a new reporting group. If not given, all jobs in a file will be part
516of the same reporting group, unless separated by a stonewall.
517.TP
518.BI numjobs \fR=\fPint
519Number of clones (processes/threads performing the same workload) of this job.
520Default: 1.
521.TP
522.B group_reporting
523If set, display per-group reports instead of per-job when \fBnumjobs\fR is
524specified.
525.TP
526.B thread
527Use threads created with \fBpthread_create\fR\|(3) instead of processes created
528with \fBfork\fR\|(2).
529.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100530.BI zonesize \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200531Divide file into zones of the specified size in bytes. See \fBzoneskip\fR.
532.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100533.BI zoneskip \fR=\fPint
Aaron Carrolld1429b52007-09-18 08:10:57 +0200534Skip the specified number of bytes when \fBzonesize\fR bytes of data have been
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200535read.
536.TP
537.BI write_iolog \fR=\fPstr
538Write the issued I/O patterns to the specified file.
539.TP
540.BI read_iolog \fR=\fPstr
541Replay the I/O patterns contained in the specified file generated by
542\fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file.
543.TP
544.B write_bw_log
545If given, write bandwidth logs of the jobs in this file.
546.TP
547.B write_lat_log
548Same as \fBwrite_bw_log\fR, but writes I/O completion latencies.
549.TP
Jens Axboef7fa2652009-03-09 14:20:20 +0100550.BI lockmem \fR=\fPint
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200551Pin the specified amount of memory with \fBmlock\fR\|(2). Can be used to
552simulate a smaller amount of memory.
553.TP
554.BI exec_prerun \fR=\fPstr
555Before running the job, execute the specified command with \fBsystem\fR\|(3).
556.TP
557.BI exec_postrun \fR=\fPstr
558Same as \fBexec_prerun\fR, but the command is executed after the job completes.
559.TP
560.BI ioscheduler \fR=\fPstr
561Attempt to switch the device hosting the file to the specified I/O scheduler.
562.TP
563.BI cpuload \fR=\fPint
564If the job is a CPU cycle-eater, attempt to use the specified percentage of
565CPU cycles.
566.TP
567.BI cpuchunks \fR=\fPint
568If the job is a CPU cycle-eater, split the load into cycles of the
569given time in milliseconds.
570.TP
571.BI disk_util \fR=\fPbool
Aaron Carrolld1429b52007-09-18 08:10:57 +0200572Generate disk utilization statistics if the platform supports it. Default: true.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200573.SH OUTPUT
Aaron Carrolld1429b52007-09-18 08:10:57 +0200574While running, \fBfio\fR will display the status of the created jobs. For
575example:
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200576.RS
Aaron Carrolld1429b52007-09-18 08:10:57 +0200577.P
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200578Threads: 1: [_r] [24.8% done] [ 13509/ 8334 kb/s] [eta 00h:01m:31s]
579.RE
580.P
Aaron Carrolld1429b52007-09-18 08:10:57 +0200581The characters in the first set of brackets denote the current status of each
582threads. The possible values are:
583.P
584.PD 0
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200585.RS
586.TP
587.B P
588Setup but not started.
589.TP
590.B C
591Thread created.
592.TP
593.B I
594Initialized, waiting.
595.TP
596.B R
597Running, doing sequential reads.
598.TP
599.B r
600Running, doing random reads.
601.TP
602.B W
603Running, doing sequential writes.
604.TP
605.B w
606Running, doing random writes.
607.TP
608.B M
609Running, doing mixed sequential reads/writes.
610.TP
611.B m
612Running, doing mixed random reads/writes.
613.TP
614.B F
615Running, currently waiting for \fBfsync\fR\|(2).
616.TP
617.B V
618Running, verifying written data.
619.TP
620.B E
621Exited, not reaped by main thread.
622.TP
623.B \-
624Exited, thread reaped.
625.RE
Aaron Carrolld1429b52007-09-18 08:10:57 +0200626.PD
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200627.P
628The second set of brackets shows the estimated completion percentage of
629the current group. The third set shows the read and write I/O rate,
630respectively. Finally, the estimated run time of the job is displayed.
631.P
632When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data
633for each thread, each group of threads, and each disk, in that order.
634.P
635Per-thread statistics first show the threads client number, group-id, and
636error code. The remaining figures are as follows:
637.RS
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200638.TP
639.B io
640Number of megabytes of I/O performed.
641.TP
642.B bw
643Average data rate (bandwidth).
644.TP
645.B runt
646Threads run time.
647.TP
648.B slat
649Submission latency minimum, maximum, average and standard deviation. This is
650the time it took to submit the I/O.
651.TP
652.B clat
653Completion latency minimum, maximum, average and standard deviation. This
654is the time between submission and completion.
655.TP
656.B bw
657Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average
658and standard deviation.
659.TP
660.B cpu
661CPU usage statistics. Includes user and system time, number of context switches
662this thread went through and number of major and minor page faults.
663.TP
664.B IO depths
665Distribution of I/O depths. Each depth includes everything less than (or equal)
666to it, but greater than the previous depth.
667.TP
668.B IO issued
669Number of read/write requests issued, and number of short read/write requests.
670.TP
671.B IO latencies
672Distribution of I/O completion latencies. The numbers follow the same pattern
673as \fBIO depths\fR.
674.RE
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200675.P
676The group statistics show:
Aaron Carrolld1429b52007-09-18 08:10:57 +0200677.PD 0
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200678.RS
679.TP
680.B io
681Number of megabytes I/O performed.
682.TP
683.B aggrb
684Aggregate bandwidth of threads in the group.
685.TP
686.B minb
687Minimum average bandwidth a thread saw.
688.TP
689.B maxb
690Maximum average bandwidth a thread saw.
691.TP
692.B mint
Aaron Carrolld1429b52007-09-18 08:10:57 +0200693Shortest runtime of threads in the group.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200694.TP
695.B maxt
696Longest runtime of threads in the group.
697.RE
Aaron Carrolld1429b52007-09-18 08:10:57 +0200698.PD
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200699.P
700Finally, disk statistics are printed with reads first:
Aaron Carrolld1429b52007-09-18 08:10:57 +0200701.PD 0
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200702.RS
703.TP
704.B ios
705Number of I/Os performed by all groups.
706.TP
707.B merge
708Number of merges in the I/O scheduler.
709.TP
710.B ticks
711Number of ticks we kept the disk busy.
712.TP
713.B io_queue
714Total time spent in the disk queue.
715.TP
716.B util
717Disk utilization.
718.RE
Aaron Carrolld1429b52007-09-18 08:10:57 +0200719.PD
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200720.SH TERSE OUTPUT
721If the \fB\-\-minimal\fR option is given, the results will be printed in a
722semicolon-delimited format suitable for scripted use. The fields are:
723.P
724.RS
725.B jobname, groupid, error
726.P
727Read status:
728.RS
729.B KiB I/O, bandwidth \fR(KiB/s)\fP, runtime \fR(ms)\fP
730.P
731Submission latency:
732.RS
733.B min, max, mean, standard deviation
734.RE
735Completion latency:
736.RS
737.B min, max, mean, standard deviation
738.RE
739Bandwidth:
740.RS
741.B min, max, aggregate percentage of total, mean, standard deviation
742.RE
743.RE
744.P
745Write status:
746.RS
747.B KiB I/O, bandwidth \fR(KiB/s)\fP, runtime \fR(ms)\fP
748.P
749Submission latency:
750.RS
751.B min, max, mean, standard deviation
752.RE
753Completion latency:
754.RS
755.B min, max, mean, standard deviation
756.RE
757Bandwidth:
758.RS
759.B min, max, aggregate percentage of total, mean, standard deviation
760.RE
761.RE
762.P
Aaron Carrolld1429b52007-09-18 08:10:57 +0200763CPU usage:
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200764.RS
Carl Henrik Lundebd2626f2008-06-12 09:17:46 +0200765.B user, system, context switches, major page faults, minor page faults
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200766.RE
767.P
768IO depth distribution:
769.RS
770.B <=1, 2, 4, 8, 16, 32, >=64
771.RE
772.P
773IO latency distribution (ms):
774.RS
775.B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, >=2000
776.RE
777.P
778.B text description
779.RE
780.SH AUTHORS
781.B fio
782was written by Jens Axboe <jens.axboe@oracle.com>.
Aaron Carrolld1429b52007-09-18 08:10:57 +0200783.br
784This man page was written by Aaron Carroll <aaronc@cse.unsw.edu.au> based
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200785on documentation by Jens Axboe.
786.SH "REPORTING BUGS"
Aaron Carrolld1429b52007-09-18 08:10:57 +0200787Report bugs to the \fBfio\fR mailing list <fio-devel@kernel.dk>.
788See \fBREADME\fR.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200789.SH "SEE ALSO"
Aaron Carrolld1429b52007-09-18 08:10:57 +0200790For further documentation see \fBHOWTO\fR and \fBREADME\fR.
791.br
792Sample jobfiles are available in the \fBexamples\fR directory.
Aaron Carrolld60e92d2007-09-17 10:32:59 +0200793