Add blockalign/ba option
[fio.git] / fio.1
CommitLineData
d60e92d1
AC
1.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
d1429b5c 28Print statistics in a terse, semicolon-delimited format.
d60e92d1
AC
29.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
c0a5d35e
AC
40.BI \-\-section \fR=\fPsec
41Only run section \fIsec\fR from job file.
42.TP
d60e92d1
AC
43.BI \-\-cmdhelp \fR=\fPcommand
44Print help information for \fIcommand\fR. May be `all' for all commands.
45.TP
9183788d
JA
46.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
d60e92d1
AC
51.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
d1429b5c 63considered a comment and ignored.
d9956b64
AC
64.P
65If \fIjobfile\fR is specified as `-', the job file will be read from
66standard input.
d60e92d1
AC
67.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
d60e92d1
AC
80SI 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),
f7fa2653
JA
82mega (1024*1024) and giga (1024*1024*1024) respectively. If prefixed with '0x',
83the value is assumed to be base 16 (hexadecimal).
d60e92d1
AC
84.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
d1429b5c
AC
90\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'.
d60e92d1
AC
94.SS "Parameter List"
95.TP
96.BI name \fR=\fPstr
d9956b64 97May be used to override the job name. On the command line, this parameter
d60e92d1
AC
98has 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
d1429b5c
AC
111number. 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.
d60e92d1
AC
118.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
d1429b5c 128Sequential reads.
d60e92d1
AC
129.TP
130.B write
d1429b5c 131Sequential writes.
d60e92d1
AC
132.TP
133.B randread
d1429b5c 134Random reads.
d60e92d1
AC
135.TP
136.B randwrite
d1429b5c 137Random writes.
d60e92d1
AC
138.TP
139.B rw
d1429b5c 140Mixed sequential reads and writes.
d60e92d1
AC
141.TP
142.B randrw
d1429b5c 143Mixed random reads and writes.
d60e92d1
AC
144.RE
145.P
d1429b5c
AC
146For 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.
d60e92d1
AC
149.RE
150.TP
151.BI randrepeat \fR=\fPbool
152Seed the random number generator in a predictable way so results are repeatable
d1429b5c 153across runs. Default: true.
d60e92d1
AC
154.TP
155.BI fadvise_hint \fR=\fPbool
d1429b5c
AC
156Disable use of \fIposix_fadvise\fR\|(2) to advise the kernel what I/O patterns
157are likely to be issued. Default: true.
d60e92d1 158.TP
f7fa2653 159.BI size \fR=\fPint
d60e92d1
AC
160Total 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
d1429b5c
AC
167for 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.
d60e92d1 170.TP
f7fa2653 171.BI blocksize \fR=\fPint[,int] "\fR,\fB bs" \fR=\fPint[,int]
d60e92d1
AC
172Block 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
9183788d 176.BI blocksize_range \fR=\fPirange[,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange]
d1429b5c
AC
177Specify 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
9183788d
JA
179to 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.
d60e92d1
AC
191.TP
192.B blocksize_unaligned\fR,\fP bs_unaligned
d1429b5c
AC
193If 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.
d60e92d1 195.TP
2b7a01d0
JA
196.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.
d60e92d1
AC
202.B zero_buffers
203Initialise buffers with all zeros. Default: fill buffers with random data.
204.TP
205.BI nrfiles \fR=\fPint
206Number of files to use for this job. Default: 1.
207.TP
208.BI openfiles \fR=\fPint
209Number of files to keep open at the same time. Default: \fBnrfiles\fR.
210.TP
211.BI file_service_type \fR=\fPstr
212Defines how files to service are selected. The following types are defined:
213.RS
214.RS
215.TP
216.B random
217Choose a file at random
218.TP
219.B roundrobin
220Round robin over open files (default).
6b7f6851
JA
221.B sequential
222Do each file in the set sequentially.
d60e92d1
AC
223.RE
224.P
225The number of I/Os to issue before switching a new file can be specified by
226appending `:\fIint\fR' to the service type.
227.RE
228.TP
229.BI ioengine \fR=\fPstr
230Defines how the job issues I/O. The following types are defined:
231.RS
232.RS
233.TP
234.B sync
235Basic \fIread\fR\|(2) or \fIwrite\fR\|(2) I/O. \fIfseek\fR\|(2) is used to
236position the I/O location.
237.TP
a31041ea 238.B psync
239Basic \fIpread\fR\|(2) or \fIpwrite\fR\|(2) I/O.
240.TP
9183788d
JA
241.B vsync
242Basic \fIreadv\fR\|(2) or \fIwritev\fR\|(2) I/O. Will emulate queuing by
243coalescing adjacents IOs into a single submission.
244.TP
d60e92d1
AC
245.B libaio
246Linux native asynchronous I/O.
247.TP
248.B posixaio
249glibc POSIX asynchronous I/O using \fIaio_read\fR\|(3) and \fIaio_write\fR\|(3).
250.TP
251.B mmap
d1429b5c
AC
252File is memory mapped with \fImmap\fR\|(2) and data copied using
253\fImemcpy\fR\|(3).
d60e92d1
AC
254.TP
255.B splice
d1429b5c
AC
256\fIsplice\fR\|(2) is used to transfer the data and \fIvmsplice\fR\|(2) to
257transfer data from user-space to the kernel.
d60e92d1
AC
258.TP
259.B syslet-rw
260Use the syslet system calls to make regular read/write asynchronous.
261.TP
262.B sg
263SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if
d1429b5c
AC
264the target is an sg character device, we use \fIread\fR\|(2) and
265\fIwrite\fR\|(2) for asynchronous I/O.
d60e92d1
AC
266.TP
267.B null
268Doesn't transfer any data, just pretends to. Mainly used to exercise \fBfio\fR
269itself and for debugging and testing purposes.
270.TP
271.B net
272Transfer over the network. \fBfilename\fR must be set appropriately to
273`\fIhost\fR/\fIport\fR' regardless of data direction. If receiving, only the
274\fIport\fR argument is used.
275.TP
276.B netsplice
277Like \fBnet\fR, but uses \fIsplice\fR\|(2) and \fIvmsplice\fR\|(2) to map data
278and send/receive.
279.TP
53aec0a4 280.B cpuio
d60e92d1
AC
281Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and
282\fBcpucycles\fR parameters.
283.TP
284.B guasi
285The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface
286approach to asycnronous I/O.
d1429b5c
AC
287.br
288See <http://www.xmailserver.org/guasi\-lib.html>.
d60e92d1
AC
289.TP
290.B external
291Loads an external I/O engine object file. Append the engine filename as
292`:\fIenginepath\fR'.
293.RE
294.RE
295.TP
296.BI iodepth \fR=\fPint
297Number of I/O units to keep in flight against the file. Default: 1.
298.TP
299.BI iodepth_batch \fR=\fPint
300Number of I/Os to submit at once. Default: \fBiodepth\fR.
301.TP
302.BI iodepth_low \fR=\fPint
303Low watermark indicating when to start filling the queue again. Default:
304\fBiodepth\fR.
305.TP
306.BI direct \fR=\fPbool
307If true, use non-buffered I/O (usually O_DIRECT). Default: false.
308.TP
309.BI buffered \fR=\fPbool
310If true, use buffered I/O. This is the opposite of the \fBdirect\fR parameter.
311Default: true.
312.TP
f7fa2653 313.BI offset \fR=\fPint
d60e92d1
AC
314Offset in the file to start I/O. Data before the offset will not be touched.
315.TP
316.BI fsync \fR=\fPint
d1429b5c
AC
317How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data. If
3180, don't sync. Default: 0.
d60e92d1
AC
319.TP
320.BI overwrite \fR=\fPbool
d1429b5c 321If writing, setup the file first and do overwrites. Default: false.
d60e92d1
AC
322.TP
323.BI end_fsync \fR=\fPbool
d1429b5c 324Sync file contents when job exits. Default: false.
d60e92d1
AC
325.TP
326.BI fsync_on_close \fR=\fPbool
327If true, sync file contents on close. This differs from \fBend_fsync\fR in that
d1429b5c 328it will happen on every close, not just at the end of the job. Default: false.
d60e92d1
AC
329.TP
330.BI rwmixcycle \fR=\fPint
331How many milliseconds before switching between reads and writes for a mixed
332workload. Default: 500ms.
333.TP
334.BI rwmixread \fR=\fPint
335Percentage of a mixed workload that should be reads. Default: 50.
336.TP
337.BI rwmixwrite \fR=\fPint
d1429b5c 338Percentage of a mixed workload that should be writes. If \fBrwmixread\fR and
d60e92d1 339\fBwrmixwrite\fR are given and do not sum to 100%, the latter of the two
d1429b5c 340overrides the first. Default: 50.
d60e92d1
AC
341.TP
342.B norandommap
343Normally \fBfio\fR will cover every block of the file when doing random I/O. If
344this parameter is given, a new offset will be chosen without looking at past
345I/O history. This parameter is mutually exclusive with \fBverify\fR.
346.TP
347.BI nice \fR=\fPint
348Run job with given nice value. See \fInice\fR\|(2).
349.TP
350.BI prio \fR=\fPint
351Set I/O priority value of this job between 0 (highest) and 7 (lowest). See
352\fIionice\fR\|(1).
353.TP
354.BI prioclass \fR=\fPint
355Set I/O priority class. See \fIionice\fR\|(1).
356.TP
357.BI thinktime \fR=\fPint
358Stall job for given number of microseconds between issuing I/Os.
359.TP
360.BI thinktime_spin \fR=\fPint
361Pretend to spend CPU time for given number of microseconds, sleeping the rest
362of the time specified by \fBthinktime\fR. Only valid if \fBthinktime\fR is set.
363.TP
364.BI thinktime_blocks \fR=\fPint
365Number of blocks to issue before waiting \fBthinktime\fR microseconds.
366Default: 1.
367.TP
368.BI rate \fR=\fPint
369Cap bandwidth used by this job to this number of KiB/s.
370.TP
371.BI ratemin \fR=\fPint
372Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth.
373Failing to meet this requirement will cause the job to exit.
374.TP
375.BI rate_iops \fR=\fPint
376Cap the bandwidth to this number of IOPS. If \fBblocksize\fR is a range, the
377smallest block size is used as the metric.
378.TP
379.BI rate_iops_min \fR=\fPint
380If this rate of I/O is not met, the job will exit.
381.TP
382.BI ratecycle \fR=\fPint
383Average bandwidth for \fBrate\fR and \fBratemin\fR over this number of
384milliseconds. Default: 1000ms.
385.TP
386.BI cpumask \fR=\fPint
387Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job
388may run on. See \fBsched_setaffinity\fR\|(2).
389.TP
390.BI cpus_allowed \fR=\fPstr
391Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers.
392.TP
393.BI startdelay \fR=\fPint
394Delay start of job for the specified number of seconds.
395.TP
396.BI runtime \fR=\fPint
397Terminate processing after the specified number of seconds.
398.TP
399.B time_based
400If given, run for the specified \fBruntime\fR duration even if the files are
401completely read or written. The same workload will be repeated as many times
402as \fBruntime\fR allows.
403.TP
404.BI invalidate \fR=\fPbool
405Invalidate buffer-cache for the file prior to starting I/O. Default: true.
406.TP
407.BI sync \fR=\fPbool
408Use synchronous I/O for buffered writes. For the majority of I/O engines,
d1429b5c 409this means using O_SYNC. Default: false.
d60e92d1
AC
410.TP
411.BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
412Allocation method for I/O unit buffer. Allowed values are:
413.RS
414.RS
415.TP
416.B malloc
417Allocate memory with \fImalloc\fR\|(3).
418.TP
419.B shm
420Use shared memory buffers allocated through \fIshmget\fR\|(2).
421.TP
422.B shmhuge
423Same as \fBshm\fR, but use huge pages as backing.
424.TP
425.B mmap
426Use \fImmap\fR\|(2) for allocation. Uses anonymous memory unless a filename
427is given after the option in the format `:\fIfile\fR'.
428.TP
429.B mmaphuge
430Same as \fBmmap\fR, but use huge files as backing.
431.RE
432.P
433The amount of memory allocated is the maximum allowed \fBblocksize\fR for the
434job multiplied by \fBiodepth\fR. For \fBshmhuge\fR or \fBmmaphuge\fR to work,
435the system must have free huge pages allocated. \fBmmaphuge\fR also needs to
436have hugetlbfs mounted, and \fIfile\fR must point there.
437.RE
438.TP
f7fa2653 439.BI hugepage\-size \fR=\fPint
d60e92d1
AC
440Defines the size of a huge page. Must be at least equal to the system setting.
441Should be a multiple of 1MiB. Default: 4MiB.
442.TP
443.B exitall
444Terminate all jobs when one finishes. Default: wait for each job to finish.
445.TP
446.BI bwavgtime \fR=\fPint
447Average bandwidth calculations over the given time in milliseconds. Default:
448500ms.
449.TP
450.BI create_serialize \fR=\fPbool
d1429b5c 451If true, serialize file creation for the jobs. Default: true.
d60e92d1
AC
452.TP
453.BI create_fsync \fR=\fPbool
454\fIfsync\fR\|(2) data file after creation. Default: true.
455.TP
6b7f6851
JA
456.BI create_on_open \fR=\fPbool
457If true, the files are not created until they are opened for IO by the job.
458.TP
d60e92d1
AC
459.BI unlink \fR=\fPbool
460Unlink job files when done. Default: false.
461.TP
462.BI loops \fR=\fPint
463Specifies the number of iterations (runs of the same workload) of this job.
464Default: 1.
465.TP
466.BI do_verify \fR=\fPbool
467Run the verify phase after a write phase. Only valid if \fBverify\fR is set.
468Default: true.
469.TP
470.BI verify \fR=\fPstr
471Method of verifying file contents after each iteration of the job. Allowed
472values are:
473.RS
474.RS
475.TP
476.B md5 crc16 crc32 crc64 crc7 sha256 sha512
477Store appropriate checksum in the header of each block.
478.TP
479.B meta
480Write extra information about each I/O (timestamp, block number, etc.). The
481block number is verified.
482.TP
483.B pattern
484Fill I/O buffers with a specific pattern that is used to verify. The pattern is
485specified by appending `:\fIint\fR' to the parameter. \fIint\fR cannot be larger
486than 32-bits.
487.TP
488.B null
489Pretend to verify. Used for testing internals.
490.RE
491.RE
492.TP
493.BI verify_sort \fR=\fPbool
494If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to
495read them back in a sorted manner. Default: true.
496.TP
f7fa2653 497.BI verify_offset \fR=\fPint
d60e92d1 498Swap the verification header with data somewhere else in the block before
d1429b5c 499writing. It is swapped back before verifying.
d60e92d1 500.TP
f7fa2653 501.BI verify_interval \fR=\fPint
d60e92d1
AC
502Write the verification header for this number of bytes, which should divide
503\fBblocksize\fR. Default: \fBblocksize\fR.
504.TP
505.BI verify_fatal \fR=\fPbool
506If true, exit the job on the first observed verification failure. Default:
507false.
508.TP
509.B stonewall
d1429b5c 510Wait for preceeding jobs in the job file to exit before starting this one.
d60e92d1
AC
511\fBstonewall\fR implies \fBnew_group\fR.
512.TP
513.B new_group
514Start a new reporting group. If not given, all jobs in a file will be part
515of the same reporting group, unless separated by a stonewall.
516.TP
517.BI numjobs \fR=\fPint
518Number of clones (processes/threads performing the same workload) of this job.
519Default: 1.
520.TP
521.B group_reporting
522If set, display per-group reports instead of per-job when \fBnumjobs\fR is
523specified.
524.TP
525.B thread
526Use threads created with \fBpthread_create\fR\|(3) instead of processes created
527with \fBfork\fR\|(2).
528.TP
f7fa2653 529.BI zonesize \fR=\fPint
d60e92d1
AC
530Divide file into zones of the specified size in bytes. See \fBzoneskip\fR.
531.TP
f7fa2653 532.BI zoneskip \fR=\fPint
d1429b5c 533Skip the specified number of bytes when \fBzonesize\fR bytes of data have been
d60e92d1
AC
534read.
535.TP
536.BI write_iolog \fR=\fPstr
537Write the issued I/O patterns to the specified file.
538.TP
539.BI read_iolog \fR=\fPstr
540Replay the I/O patterns contained in the specified file generated by
541\fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file.
542.TP
543.B write_bw_log
544If given, write bandwidth logs of the jobs in this file.
545.TP
546.B write_lat_log
547Same as \fBwrite_bw_log\fR, but writes I/O completion latencies.
548.TP
f7fa2653 549.BI lockmem \fR=\fPint
d60e92d1
AC
550Pin the specified amount of memory with \fBmlock\fR\|(2). Can be used to
551simulate a smaller amount of memory.
552.TP
553.BI exec_prerun \fR=\fPstr
554Before running the job, execute the specified command with \fBsystem\fR\|(3).
555.TP
556.BI exec_postrun \fR=\fPstr
557Same as \fBexec_prerun\fR, but the command is executed after the job completes.
558.TP
559.BI ioscheduler \fR=\fPstr
560Attempt to switch the device hosting the file to the specified I/O scheduler.
561.TP
562.BI cpuload \fR=\fPint
563If the job is a CPU cycle-eater, attempt to use the specified percentage of
564CPU cycles.
565.TP
566.BI cpuchunks \fR=\fPint
567If the job is a CPU cycle-eater, split the load into cycles of the
568given time in milliseconds.
569.TP
570.BI disk_util \fR=\fPbool
d1429b5c 571Generate disk utilization statistics if the platform supports it. Default: true.
d60e92d1 572.SH OUTPUT
d1429b5c
AC
573While running, \fBfio\fR will display the status of the created jobs. For
574example:
d60e92d1 575.RS
d1429b5c 576.P
d60e92d1
AC
577Threads: 1: [_r] [24.8% done] [ 13509/ 8334 kb/s] [eta 00h:01m:31s]
578.RE
579.P
d1429b5c
AC
580The characters in the first set of brackets denote the current status of each
581threads. The possible values are:
582.P
583.PD 0
d60e92d1
AC
584.RS
585.TP
586.B P
587Setup but not started.
588.TP
589.B C
590Thread created.
591.TP
592.B I
593Initialized, waiting.
594.TP
595.B R
596Running, doing sequential reads.
597.TP
598.B r
599Running, doing random reads.
600.TP
601.B W
602Running, doing sequential writes.
603.TP
604.B w
605Running, doing random writes.
606.TP
607.B M
608Running, doing mixed sequential reads/writes.
609.TP
610.B m
611Running, doing mixed random reads/writes.
612.TP
613.B F
614Running, currently waiting for \fBfsync\fR\|(2).
615.TP
616.B V
617Running, verifying written data.
618.TP
619.B E
620Exited, not reaped by main thread.
621.TP
622.B \-
623Exited, thread reaped.
624.RE
d1429b5c 625.PD
d60e92d1
AC
626.P
627The second set of brackets shows the estimated completion percentage of
628the current group. The third set shows the read and write I/O rate,
629respectively. Finally, the estimated run time of the job is displayed.
630.P
631When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data
632for each thread, each group of threads, and each disk, in that order.
633.P
634Per-thread statistics first show the threads client number, group-id, and
635error code. The remaining figures are as follows:
636.RS
d60e92d1
AC
637.TP
638.B io
639Number of megabytes of I/O performed.
640.TP
641.B bw
642Average data rate (bandwidth).
643.TP
644.B runt
645Threads run time.
646.TP
647.B slat
648Submission latency minimum, maximum, average and standard deviation. This is
649the time it took to submit the I/O.
650.TP
651.B clat
652Completion latency minimum, maximum, average and standard deviation. This
653is the time between submission and completion.
654.TP
655.B bw
656Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average
657and standard deviation.
658.TP
659.B cpu
660CPU usage statistics. Includes user and system time, number of context switches
661this thread went through and number of major and minor page faults.
662.TP
663.B IO depths
664Distribution of I/O depths. Each depth includes everything less than (or equal)
665to it, but greater than the previous depth.
666.TP
667.B IO issued
668Number of read/write requests issued, and number of short read/write requests.
669.TP
670.B IO latencies
671Distribution of I/O completion latencies. The numbers follow the same pattern
672as \fBIO depths\fR.
673.RE
d60e92d1
AC
674.P
675The group statistics show:
d1429b5c 676.PD 0
d60e92d1
AC
677.RS
678.TP
679.B io
680Number of megabytes I/O performed.
681.TP
682.B aggrb
683Aggregate bandwidth of threads in the group.
684.TP
685.B minb
686Minimum average bandwidth a thread saw.
687.TP
688.B maxb
689Maximum average bandwidth a thread saw.
690.TP
691.B mint
d1429b5c 692Shortest runtime of threads in the group.
d60e92d1
AC
693.TP
694.B maxt
695Longest runtime of threads in the group.
696.RE
d1429b5c 697.PD
d60e92d1
AC
698.P
699Finally, disk statistics are printed with reads first:
d1429b5c 700.PD 0
d60e92d1
AC
701.RS
702.TP
703.B ios
704Number of I/Os performed by all groups.
705.TP
706.B merge
707Number of merges in the I/O scheduler.
708.TP
709.B ticks
710Number of ticks we kept the disk busy.
711.TP
712.B io_queue
713Total time spent in the disk queue.
714.TP
715.B util
716Disk utilization.
717.RE
d1429b5c 718.PD
d60e92d1
AC
719.SH TERSE OUTPUT
720If the \fB\-\-minimal\fR option is given, the results will be printed in a
721semicolon-delimited format suitable for scripted use. The fields are:
722.P
723.RS
724.B jobname, groupid, error
725.P
726Read status:
727.RS
728.B KiB I/O, bandwidth \fR(KiB/s)\fP, runtime \fR(ms)\fP
729.P
730Submission latency:
731.RS
732.B min, max, mean, standard deviation
733.RE
734Completion latency:
735.RS
736.B min, max, mean, standard deviation
737.RE
738Bandwidth:
739.RS
740.B min, max, aggregate percentage of total, mean, standard deviation
741.RE
742.RE
743.P
744Write status:
745.RS
746.B KiB I/O, bandwidth \fR(KiB/s)\fP, runtime \fR(ms)\fP
747.P
748Submission latency:
749.RS
750.B min, max, mean, standard deviation
751.RE
752Completion latency:
753.RS
754.B min, max, mean, standard deviation
755.RE
756Bandwidth:
757.RS
758.B min, max, aggregate percentage of total, mean, standard deviation
759.RE
760.RE
761.P
d1429b5c 762CPU usage:
d60e92d1 763.RS
bd2626f0 764.B user, system, context switches, major page faults, minor page faults
d60e92d1
AC
765.RE
766.P
767IO depth distribution:
768.RS
769.B <=1, 2, 4, 8, 16, 32, >=64
770.RE
771.P
772IO latency distribution (ms):
773.RS
774.B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, >=2000
775.RE
776.P
777.B text description
778.RE
779.SH AUTHORS
780.B fio
781was written by Jens Axboe <jens.axboe@oracle.com>.
d1429b5c
AC
782.br
783This man page was written by Aaron Carroll <aaronc@cse.unsw.edu.au> based
d60e92d1
AC
784on documentation by Jens Axboe.
785.SH "REPORTING BUGS"
d1429b5c
AC
786Report bugs to the \fBfio\fR mailing list <fio-devel@kernel.dk>.
787See \fBREADME\fR.
d60e92d1 788.SH "SEE ALSO"
d1429b5c
AC
789For further documentation see \fBHOWTO\fR and \fBREADME\fR.
790.br
791Sample jobfiles are available in the \fBexamples\fR directory.
d60e92d1 792