Add some missing options to the man page
[fio.git] / fio.1
1 .TH fio 1 "September 2007" "User Manual"
3 fio \- flexible I/O tester
5 .B fio
6 [\fIoptions\fR] [\fIjobfile\fR]...
8 .B fio
9 is a tool that will spawn a number of threads or processes doing a
10 particular type of I/O action as specified by the user.
11 The typical use of fio is to write a job file matching the I/O load
12 one wants to simulate.
14 .TP
15 .BI \-\-output \fR=\fPfilename
16 Write output to \fIfilename\fR.
17 .TP
18 .BI \-\-timeout \fR=\fPtimeout
19 Limit run time to \fItimeout\fR seconds.
20 .TP
21 .B \-\-latency\-log
22 Generate per-job latency logs.
23 .TP
24 .B \-\-bandwidth\-log
25 Generate per-job bandwidth logs.
26 .TP
27 .B \-\-minimal
28 Print statistics in a terse, semicolon-delimited format.
29 .TP
30 .BI \-\-showcmd \fR=\fPjobfile
31 Convert \fIjobfile\fR to a set of command-line options.
32 .TP
33 .B \-\-readonly
34 Enable read-only safety checks.
35 .TP
36 .BI \-\-eta \fR=\fPwhen
37 Specifies when real-time ETA estimate should be printed.  \fIwhen\fR may
38 be one of `always', `never' or `auto'.
39 .TP
40 .BI \-\-section \fR=\fPsec
41 Only run section \fIsec\fR from job file.
42 .TP
43 .BI \-\-cmdhelp \fR=\fPcommand
44 Print help information for \fIcommand\fR.  May be `all' for all commands.
45 .TP
46 .BI \-\-debug \fR=\fPtype
47 Enable verbose tracing of various fio actions. May be `all' for all types
48 or individual types seperated by a comma (eg --debug=io,file). `help' will
49 list all available tracing options.
50 .TP
51 .B \-\-help
52 Display usage information and exit.
53 .TP
54 .B \-\-version
55 Display version information and exit.
57 Job files are in `ini' format. They consist of one or more
58 job definitions, which begin with a job name in square brackets and
59 extend to the next job name.  The job name can be any ASCII string
60 except `global', which has a special meaning.  Following the job name is
61 a sequence of zero or more parameters, one per line, that define the
62 behavior of the job.  Any line starting with a `;' or `#' character is
63 considered a comment and ignored.
64 .P
65 If \fIjobfile\fR is specified as `-', the job file will be read from
66 standard input.
67 .SS "Global Section"
68 The global section contains default parameters for jobs specified in the
69 job file.  A job is only affected by global sections residing above it,
70 and there may be any number of global sections.  Specific job definitions
71 may override any parameter set in global sections.
73 .SS Types
74 Some parameters may take arguments of a specific type.  The types used are:
75 .TP
76 .I str
77 String: a sequence of alphanumeric characters.
78 .TP
79 .I int
80 SI integer: a whole number, possibly containing a suffix denoting the base unit
81 of the value.  Accepted suffixes are `k', 'M' and 'G', denoting kilo (1024),
82 mega (1024*1024) and giga (1024*1024*1024) respectively. If prefixed with '0x',
83 the value is assumed to be base 16 (hexadecimal).
84 .TP
85 .I bool
86 Boolean: a true or false value. `0' denotes false, `1' denotes true.
87 .TP
88 .I irange
89 Integer range: a range of integers specified in the format
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
92 sets of ranges, they are separated with a `,' or `/' character. For example:
93 `8\-8k/8M\-4G'.
94 .SS "Parameter List"
95 .TP
96 .BI name \fR=\fPstr
97 May be used to override the job name.  On the command line, this parameter
98 has the special purpose of signalling the start of a new job.
99 .TP
100 .BI description \fR=\fPstr
101 Human-readable description of the job. It is printed when the job is run, but
102 otherwise has no special purpose.
103 .TP
104 .BI directory \fR=\fPstr
105 Prefix filenames with this directory.  Used to place files in a location other
106 than `./'.
107 .TP
108 .BI filename \fR=\fPstr
109 .B fio
110 normally makes up a file name based on the job name, thread number, and file
111 number. If you want to share files between threads in a job or several jobs,
112 specify a \fIfilename\fR for each of them to override the default. If the I/O
113 engine used is `net', \fIfilename\fR is the host and port to connect to in the
114 format \fIhost\fR/\fIport\fR. If the I/O engine is file-based, you can specify
115 a number of files by separating the names with a `:' character. `\-' is a
116 reserved name, meaning stdin or stdout, depending on the read/write direction
117 set.
118 .TP
119 .BI opendir \fR=\fPstr
120 Recursively open any files below directory \fIstr\fR.
121 .TP
122 .BI readwrite \fR=\fPstr "\fR,\fP rw" \fR=\fPstr
123 Type of I/O pattern.  Accepted values are:
124 .RS
125 .RS
126 .TP
127 .B read
128 Sequential reads.
129 .TP
130 .B write
131 Sequential writes.
132 .TP
133 .B randread
134 Random reads.
135 .TP
136 .B randwrite
137 Random writes.
138 .TP
139 .B rw
140 Mixed sequential reads and writes.
141 .TP
142 .B randrw 
143 Mixed random reads and writes.
144 .RE
145 .P
146 For mixed I/O, the default split is 50/50.  For random I/O, the number of I/Os
147 to perform before getting a new offset can be specified by appending
148 `:\fIint\fR' to the pattern type.  The default is 1.
149 .RE
150 .TP
151 .BI randrepeat \fR=\fPbool
152 Seed the random number generator in a predictable way so results are repeatable
153 across runs.  Default: true.
154 .TP
155 .BI fadvise_hint \fR=\fPbool
156 Disable use of \fIposix_fadvise\fR\|(2) to advise the kernel what I/O patterns
157 are likely to be issued. Default: true.
158 .TP
159 .BI size \fR=\fPint
160 Total size of I/O for this job.  \fBfio\fR will run until this many bytes have
161 been transfered, unless limited by other options (\fBruntime\fR, for instance).
162 Unless \fBnr_files\fR and \fBfilesize\fR options are given, this amount will be
163 divided between the available files for the job.
164 .TP
165 .BI filesize \fR=\fPirange
166 Individual file sizes. May be a range, in which case \fBfio\fR will select sizes
167 for files at random within the given range, limited to \fBsize\fR in total (if
168 that is given). If \fBfilesize\fR is not specified, each created file is the
169 same size.
170 .TP
171 .BI blocksize \fR=\fPint[,int] "\fR,\fB bs" \fR=\fPint[,int]
172 Block size for I/O units.  Default: 4k.  Values for reads and writes can be
173 specified seperately in the format \fIread\fR,\fIwrite\fR, either of
174 which may be empty to leave that value at its default.
175 .TP
176 .BI blocksize_range \fR=\fPirange[,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange]
177 Specify a range of I/O block sizes.  The issued I/O unit will always be a
178 multiple of the minimum size, unless \fBblocksize_unaligned\fR is set.  Applies
179 to both reads and writes if only one range is given, but can be specified
180 seperately with a comma seperating the values. Example: bsrange=1k-4k,2k-8k.
181 Also (see \fBblocksize\fR).
182 .TP
183 .BI bssplit \fR=\fPstr
184 This option allows even finer grained control of the block sizes issued,
185 not just even splits between them. With this option, you can weight various
186 block sizes for exact control of the issued IO for a job that has mixed
187 block sizes. The format of the option is bssplit=blocksize/percentage,
188 optionally adding as many definitions as needed seperated by a colon.
189 Example: bssplit=4k/10:64k/50:32k/40 would issue 50% 64k blocks, 10% 4k
190 blocks and 40% 32k blocks.
191 .TP
192 .B blocksize_unaligned\fR,\fP bs_unaligned
193 If set, any size in \fBblocksize_range\fR may be used.  This typically won't
194 work with direct I/O, as that normally requires sector alignment.
195 .TP
196 .BI blockalign \fR=\fPint[,int] "\fR,\fB ba" \fR=\fPint[,int]
197 At what boundary to align random IO offsets. Defaults to the same as
198 'blocksize' the minimum blocksize given.  Minimum alignment is typically 512b
199 for using direct IO, though it usually depends on the hardware block size.
200 This option is mutually exclusive with using a random map for files, so it
201 will turn off that option.
202 .TP
203 .B zero_buffers
204 Initialise buffers with all zeros. Default: fill buffers with random data.
205 .TP
206 .B refill_buffers
207 If this option is given, fio will refill the IO buffers on every submit. The
208 default is to only fill it at init time and reuse that data. Only makes sense
209 if zero_buffers isn't specified, naturally. If data verification is enabled,
210 refill_buffers is also automatically enabled.
211 .TP
212 .BI nrfiles \fR=\fPint
213 Number of files to use for this job.  Default: 1.
214 .TP
215 .BI openfiles \fR=\fPint
216 Number of files to keep open at the same time.  Default: \fBnrfiles\fR.
217 .TP
218 .BI file_service_type \fR=\fPstr
219 Defines how files to service are selected.  The following types are defined:
220 .RS
221 .RS
222 .TP
223 .B random
224 Choose a file at random
225 .TP
226 .B roundrobin
227 Round robin over open files (default).
228 .B sequential
229 Do each file in the set sequentially.
230 .RE
231 .P
232 The number of I/Os to issue before switching a new file can be specified by
233 appending `:\fIint\fR' to the service type.
234 .RE
235 .TP
236 .BI ioengine \fR=\fPstr
237 Defines how the job issues I/O.  The following types are defined:
238 .RS
239 .RS
240 .TP
241 .B sync
242 Basic \fIread\fR\|(2) or \fIwrite\fR\|(2) I/O.  \fIfseek\fR\|(2) is used to
243 position the I/O location.
244 .TP
245 .B psync
246 Basic \fIpread\fR\|(2) or \fIpwrite\fR\|(2) I/O.
247 .TP
248 .B vsync
249 Basic \fIreadv\fR\|(2) or \fIwritev\fR\|(2) I/O. Will emulate queuing by
250 coalescing adjacents IOs into a single submission.
251 .TP
252 .B libaio
253 Linux native asynchronous I/O.
254 .TP
255 .B posixaio
256 glibc POSIX asynchronous I/O using \fIaio_read\fR\|(3) and \fIaio_write\fR\|(3).
257 .TP
258 .B mmap
259 File is memory mapped with \fImmap\fR\|(2) and data copied using
260 \fImemcpy\fR\|(3).
261 .TP
262 .B splice
263 \fIsplice\fR\|(2) is used to transfer the data and \fIvmsplice\fR\|(2) to
264 transfer data from user-space to the kernel.
265 .TP
266 .B syslet-rw
267 Use the syslet system calls to make regular read/write asynchronous.
268 .TP
269 .B sg
270 SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if
271 the target is an sg character device, we use \fIread\fR\|(2) and
272 \fIwrite\fR\|(2) for asynchronous I/O.
273 .TP
274 .B null
275 Doesn't transfer any data, just pretends to.  Mainly used to exercise \fBfio\fR
276 itself and for debugging and testing purposes.
277 .TP
278 .B net
279 Transfer over the network.  \fBfilename\fR must be set appropriately to
280 `\fIhost\fR/\fIport\fR' regardless of data direction.  If receiving, only the
281 \fIport\fR argument is used.
282 .TP
283 .B netsplice
284 Like \fBnet\fR, but uses \fIsplice\fR\|(2) and \fIvmsplice\fR\|(2) to map data
285 and send/receive.
286 .TP
287 .B cpuio
288 Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and
289 \fBcpucycles\fR parameters.
290 .TP
291 .B guasi
292 The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface
293 approach to asycnronous I/O.
294 .br
295 See <\-lib.html>.
296 .TP
297 .B external
298 Loads an external I/O engine object file.  Append the engine filename as
299 `:\fIenginepath\fR'.
300 .RE
301 .RE
302 .TP
303 .BI iodepth \fR=\fPint
304 Number of I/O units to keep in flight against the file.  Default: 1.
305 .TP
306 .BI iodepth_batch \fR=\fPint
307 Number of I/Os to submit at once.  Default: \fBiodepth\fR.
308 .TP
309 .BI iodepth_low \fR=\fPint
310 Low watermark indicating when to start filling the queue again.  Default:
311 \fBiodepth\fR. 
312 .TP
313 .BI direct \fR=\fPbool
314 If true, use non-buffered I/O (usually O_DIRECT).  Default: false.
315 .TP
316 .BI buffered \fR=\fPbool
317 If true, use buffered I/O.  This is the opposite of the \fBdirect\fR parameter.
318 Default: true.
319 .TP
320 .BI offset \fR=\fPint
321 Offset in the file to start I/O. Data before the offset will not be touched.
322 .TP
323 .BI fsync \fR=\fPint
324 How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data.  If
325 0, don't sync.  Default: 0.
326 .TP
327 .BI overwrite \fR=\fPbool
328 If writing, setup the file first and do overwrites.  Default: false.
329 .TP
330 .BI end_fsync \fR=\fPbool
331 Sync file contents when job exits.  Default: false.
332 .TP
333 .BI fsync_on_close \fR=\fPbool
334 If true, sync file contents on close.  This differs from \fBend_fsync\fR in that
335 it will happen on every close, not just at the end of the job.  Default: false.
336 .TP
337 .BI rwmixcycle \fR=\fPint
338 How many milliseconds before switching between reads and writes for a mixed
339 workload. Default: 500ms.
340 .TP
341 .BI rwmixread \fR=\fPint
342 Percentage of a mixed workload that should be reads. Default: 50.
343 .TP
344 .BI rwmixwrite \fR=\fPint
345 Percentage of a mixed workload that should be writes.  If \fBrwmixread\fR and
346 \fBwrmixwrite\fR are given and do not sum to 100%, the latter of the two
347 overrides the first.  Default: 50.
348 .TP
349 .B norandommap
350 Normally \fBfio\fR will cover every block of the file when doing random I/O. If
351 this parameter is given, a new offset will be chosen without looking at past
352 I/O history.  This parameter is mutually exclusive with \fBverify\fR.
353 .TP
354 .BI nice \fR=\fPint
355 Run job with given nice value.  See \fInice\fR\|(2).
356 .TP
357 .BI prio \fR=\fPint
358 Set I/O priority value of this job between 0 (highest) and 7 (lowest).  See
359 \fIionice\fR\|(1).
360 .TP
361 .BI prioclass \fR=\fPint
362 Set I/O priority class.  See \fIionice\fR\|(1).
363 .TP
364 .BI thinktime \fR=\fPint
365 Stall job for given number of microseconds between issuing I/Os.
366 .TP
367 .BI thinktime_spin \fR=\fPint
368 Pretend to spend CPU time for given number of microseconds, sleeping the rest
369 of the time specified by \fBthinktime\fR.  Only valid if \fBthinktime\fR is set.
370 .TP
371 .BI thinktime_blocks \fR=\fPint
372 Number of blocks to issue before waiting \fBthinktime\fR microseconds.
373 Default: 1.
374 .TP
375 .BI rate \fR=\fPint
376 Cap bandwidth used by this job to this number of KiB/s.
377 .TP
378 .BI ratemin \fR=\fPint
379 Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth.
380 Failing to meet this requirement will cause the job to exit.
381 .TP
382 .BI rate_iops \fR=\fPint
383 Cap the bandwidth to this number of IOPS.  If \fBblocksize\fR is a range, the
384 smallest block size is used as the metric.
385 .TP
386 .BI rate_iops_min \fR=\fPint
387 If this rate of I/O is not met, the job will exit.
388 .TP
389 .BI ratecycle \fR=\fPint
390 Average bandwidth for \fBrate\fR and \fBratemin\fR over this number of
391 milliseconds.  Default: 1000ms.
392 .TP
393 .BI cpumask \fR=\fPint
394 Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job
395 may run on.  See \fBsched_setaffinity\fR\|(2).
396 .TP
397 .BI cpus_allowed \fR=\fPstr
398 Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers.
399 .TP
400 .BI startdelay \fR=\fPint
401 Delay start of job for the specified number of seconds.
402 .TP
403 .BI runtime \fR=\fPint
404 Terminate processing after the specified number of seconds.
405 .TP
406 .B time_based
407 If given, run for the specified \fBruntime\fR duration even if the files are
408 completely read or written. The same workload will be repeated as many times
409 as \fBruntime\fR allows.
410 .TP
411 .BI ramp_time \fR=\fPint
412 If set, fio will run the specified workload for this amount of time before
413 logging any performance numbers. Useful for letting performance settle before
414 logging results, thus minimizing the runtime required for stable results. Note
415 that the ramp_time is considered lead in time for a job, thus it will increase
416 the total runtime if a special timeout or runtime is specified.
417 .TP
418 .BI invalidate \fR=\fPbool
419 Invalidate buffer-cache for the file prior to starting I/O.  Default: true.
420 .TP
421 .BI sync \fR=\fPbool
422 Use synchronous I/O for buffered writes.  For the majority of I/O engines,
423 this means using O_SYNC.  Default: false.
424 .TP
425 .BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
426 Allocation method for I/O unit buffer.  Allowed values are:
427 .RS
428 .RS
429 .TP
430 .B malloc
431 Allocate memory with \fImalloc\fR\|(3).
432 .TP
433 .B shm
434 Use shared memory buffers allocated through \fIshmget\fR\|(2).
435 .TP
436 .B shmhuge
437 Same as \fBshm\fR, but use huge pages as backing.
438 .TP
439 .B mmap
440 Use \fImmap\fR\|(2) for allocation.  Uses anonymous memory unless a filename
441 is given after the option in the format `:\fIfile\fR'.
442 .TP
443 .B mmaphuge
444 Same as \fBmmap\fR, but use huge files as backing.
445 .RE
446 .P
447 The amount of memory allocated is the maximum allowed \fBblocksize\fR for the
448 job multiplied by \fBiodepth\fR.  For \fBshmhuge\fR or \fBmmaphuge\fR to work,
449 the system must have free huge pages allocated.  \fBmmaphuge\fR also needs to
450 have hugetlbfs mounted, and \fIfile\fR must point there.
451 .RE
452 .TP
453 .BI hugepage\-size \fR=\fPint
454 Defines the size of a huge page.  Must be at least equal to the system setting.
455 Should be a multiple of 1MiB. Default: 4MiB.
456 .TP
457 .B exitall
458 Terminate all jobs when one finishes.  Default: wait for each job to finish.
459 .TP
460 .BI bwavgtime \fR=\fPint
461 Average bandwidth calculations over the given time in milliseconds.  Default:
462 500ms.
463 .TP
464 .BI create_serialize \fR=\fPbool
465 If true, serialize file creation for the jobs.  Default: true.
466 .TP
467 .BI create_fsync \fR=\fPbool
468 \fIfsync\fR\|(2) data file after creation.  Default: true.
469 .TP
470 .BI create_on_open \fR=\fPbool
471 If true, the files are not created until they are opened for IO by the job.
472 .TP
473 .BI unlink \fR=\fPbool
474 Unlink job files when done.  Default: false.
475 .TP
476 .BI loops \fR=\fPint
477 Specifies the number of iterations (runs of the same workload) of this job.
478 Default: 1.
479 .TP
480 .BI do_verify \fR=\fPbool
481 Run the verify phase after a write phase.  Only valid if \fBverify\fR is set.
482 Default: true.
483 .TP
484 .BI verify \fR=\fPstr
485 Method of verifying file contents after each iteration of the job.  Allowed
486 values are:
487 .RS
488 .RS
489 .TP
490 .B md5 crc16 crc32 crc64 crc7 sha256 sha512
491 Store appropriate checksum in the header of each block.
492 .TP
493 .B meta
494 Write extra information about each I/O (timestamp, block number, etc.). The
495 block number is verified.
496 .TP
497 .B pattern
498 Fill I/O buffers with a specific pattern that is used to verify.  The pattern is
499 specified by appending `:\fIint\fR' to the parameter. \fIint\fR cannot be larger
500 than 32-bits. 
501 .TP
502 .B null
503 Pretend to verify.  Used for testing internals.
504 .RE
505 .RE
506 .TP
507 .BI verify_sort \fR=\fPbool
508 If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to
509 read them back in a sorted manner.  Default: true.
510 .TP
511 .BI verify_offset \fR=\fPint
512 Swap the verification header with data somewhere else in the block before
513 writing.  It is swapped back before verifying.
514 .TP
515 .BI verify_interval \fR=\fPint
516 Write the verification header for this number of bytes, which should divide
517 \fBblocksize\fR.  Default: \fBblocksize\fR.
518 .TP
519 .BI verify_fatal \fR=\fPbool
520 If true, exit the job on the first observed verification failure.  Default:
521 false.
522 .TP
523 .B stonewall
524 Wait for preceeding jobs in the job file to exit before starting this one.
525 \fBstonewall\fR implies \fBnew_group\fR.
526 .TP
527 .B new_group
528 Start a new reporting group.  If not given, all jobs in a file will be part
529 of the same reporting group, unless separated by a stonewall.
530 .TP
531 .BI numjobs \fR=\fPint
532 Number of clones (processes/threads performing the same workload) of this job.  
533 Default: 1.
534 .TP
535 .B group_reporting
536 If set, display per-group reports instead of per-job when \fBnumjobs\fR is
537 specified.
538 .TP
539 .B thread
540 Use threads created with \fBpthread_create\fR\|(3) instead of processes created
541 with \fBfork\fR\|(2).
542 .TP
543 .BI zonesize \fR=\fPint
544 Divide file into zones of the specified size in bytes.  See \fBzoneskip\fR.
545 .TP
546 .BI zoneskip \fR=\fPint
547 Skip the specified number of bytes when \fBzonesize\fR bytes of data have been
548 read.
549 .TP
550 .BI write_iolog \fR=\fPstr
551 Write the issued I/O patterns to the specified file.
552 .TP
553 .BI read_iolog \fR=\fPstr
554 Replay the I/O patterns contained in the specified file generated by
555 \fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file.
556 .TP
557 .B write_bw_log \fR=\fPstr
558 If given, write a bandwidth log of the jobs in this job file. Can be used to
559 store data of the bandwidth of the jobs in their lifetime. The included
560 fio_generate_plots script uses gnuplot to turn these text files into nice
561 graphs. See \fBwrite_log_log\fR for behaviour of given filename. For this
562 option, the postfix is _bw.log.
563 .TP
564 .B write_lat_log
565 Same as \fBwrite_bw_log\fR, but writes I/O completion latencies.  If no
566 filename is given with this option, the default filename of "jobname_type.log"
567 is used. Even if the filename is given, fio will still append the type of log.
568 .TP
569 .B disable_clat \fR=\fPbool
570 Disable measurements of completion latency numbers. Useful only for cutting
571 back the number of calls to gettimeofday, as that does impact performance at
572 really high IOPS rates.  Note that to really get rid of a large amount of these
573 calls, this option must be used with disable_slat and disable_bw as well.
574 .TP
575 .B disable_slat \fR=\fPbool
576 Disable measurements of submission latency numbers. See \fBdisable_clat\fR.
577 .TP
578 .B disable_bw_measurement \fR=\fPbool
579 Disable measurements of throughput/bandwidth numbers. See \fBdisable_clat\fR.
580 .TP
581 .BI lockmem \fR=\fPint
582 Pin the specified amount of memory with \fBmlock\fR\|(2).  Can be used to
583 simulate a smaller amount of memory.
584 .TP
585 .BI exec_prerun \fR=\fPstr
586 Before running the job, execute the specified command with \fBsystem\fR\|(3).
587 .TP
588 .BI exec_postrun \fR=\fPstr
589 Same as \fBexec_prerun\fR, but the command is executed after the job completes.
590 .TP
591 .BI ioscheduler \fR=\fPstr
592 Attempt to switch the device hosting the file to the specified I/O scheduler.
593 .TP
594 .BI cpuload \fR=\fPint
595 If the job is a CPU cycle-eater, attempt to use the specified percentage of
596 CPU cycles.
597 .TP
598 .BI cpuchunks \fR=\fPint
599 If the job is a CPU cycle-eater, split the load into cycles of the
600 given time in milliseconds.
601 .TP
602 .BI disk_util \fR=\fPbool
603 Generate disk utilization statistics if the platform supports it. Default: true.
604 .TP
605 .BI gtod_reduce \fR=\fPbool
606 Enable all of the gettimeofday() reducing options (disable_clat, disable_slat,
607 disable_bw) plus reduce precision of the timeout somewhat to really shrink the
608 gettimeofday() call count. With this option enabled, we only do about 0.4% of
609 the gtod() calls we would have done if all time keeping was enabled.
610 .TP
611 .BI gtod_cpu \fR=\fPint
612 Sometimes it's cheaper to dedicate a single thread of execution to just getting
613 the current time. Fio (and databases, for instance) are very intensive on
614 gettimeofday() calls. With this option, you can set one CPU aside for doing
615 nothing but logging current time to a shared memory location. Then the other
616 threads/processes that run IO workloads need only copy that segment, instead of
617 entering the kernel with a gettimeofday() call. The CPU set aside for doing
618 these time calls will be excluded from other uses. Fio will manually clear it
619 from the CPU mask of other jobs.
621 While running, \fBfio\fR will display the status of the created jobs.  For
622 example:
623 .RS
624 .P
625 Threads: 1: [_r] [24.8% done] [ 13509/  8334 kb/s] [eta 00h:01m:31s]
626 .RE
627 .P
628 The characters in the first set of brackets denote the current status of each
629 threads.  The possible values are:
630 .P
631 .PD 0
632 .RS
633 .TP
634 .B P
635 Setup but not started.
636 .TP
637 .B C
638 Thread created.
639 .TP
640 .B I
641 Initialized, waiting.
642 .TP
643 .B R
644 Running, doing sequential reads.
645 .TP
646 .B r
647 Running, doing random reads.
648 .TP
649 .B W
650 Running, doing sequential writes.
651 .TP
652 .B w
653 Running, doing random writes.
654 .TP
655 .B M
656 Running, doing mixed sequential reads/writes.
657 .TP
658 .B m
659 Running, doing mixed random reads/writes.
660 .TP
661 .B F
662 Running, currently waiting for \fBfsync\fR\|(2).
663 .TP
664 .B V
665 Running, verifying written data.
666 .TP
667 .B E
668 Exited, not reaped by main thread.
669 .TP
670 .B \-
671 Exited, thread reaped.
672 .RE
673 .PD
674 .P
675 The second set of brackets shows the estimated completion percentage of
676 the current group.  The third set shows the read and write I/O rate,
677 respectively. Finally, the estimated run time of the job is displayed.
678 .P
679 When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data
680 for each thread, each group of threads, and each disk, in that order.
681 .P
682 Per-thread statistics first show the threads client number, group-id, and
683 error code.  The remaining figures are as follows:
684 .RS
685 .TP
686 .B io
687 Number of megabytes of I/O performed.
688 .TP
689 .B bw
690 Average data rate (bandwidth).
691 .TP
692 .B runt
693 Threads run time.
694 .TP
695 .B slat
696 Submission latency minimum, maximum, average and standard deviation. This is
697 the time it took to submit the I/O.
698 .TP
699 .B clat
700 Completion latency minimum, maximum, average and standard deviation.  This
701 is the time between submission and completion.
702 .TP
703 .B bw
704 Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average
705 and standard deviation.
706 .TP
707 .B cpu
708 CPU usage statistics. Includes user and system time, number of context switches
709 this thread went through and number of major and minor page faults.
710 .TP
711 .B IO depths
712 Distribution of I/O depths.  Each depth includes everything less than (or equal)
713 to it, but greater than the previous depth.
714 .TP
715 .B IO issued
716 Number of read/write requests issued, and number of short read/write requests.
717 .TP
718 .B IO latencies
719 Distribution of I/O completion latencies.  The numbers follow the same pattern
720 as \fBIO depths\fR.
721 .RE
722 .P
723 The group statistics show:
724 .PD 0
725 .RS
726 .TP
727 .B io
728 Number of megabytes I/O performed.
729 .TP
730 .B aggrb
731 Aggregate bandwidth of threads in the group.
732 .TP
733 .B minb
734 Minimum average bandwidth a thread saw.
735 .TP
736 .B maxb
737 Maximum average bandwidth a thread saw.
738 .TP
739 .B mint
740 Shortest runtime of threads in the group.
741 .TP
742 .B maxt
743 Longest runtime of threads in the group.
744 .RE
745 .PD
746 .P
747 Finally, disk statistics are printed with reads first:
748 .PD 0
749 .RS
750 .TP
751 .B ios
752 Number of I/Os performed by all groups.
753 .TP
754 .B merge
755 Number of merges in the I/O scheduler.
756 .TP
757 .B ticks
758 Number of ticks we kept the disk busy.
759 .TP
760 .B io_queue
761 Total time spent in the disk queue.
762 .TP
763 .B util
764 Disk utilization.
765 .RE
766 .PD
768 If the \fB\-\-minimal\fR option is given, the results will be printed in a
769 semicolon-delimited format suitable for scripted use.  The fields are:
770 .P
771 .RS
772 .B jobname, groupid, error
773 .P
774 Read status:
775 .RS
776 .B KiB I/O, bandwidth \fR(KiB/s)\fP, runtime \fR(ms)\fP
777 .P
778 Submission latency:
779 .RS
780 .B min, max, mean, standard deviation
781 .RE
782 Completion latency:
783 .RS
784 .B min, max, mean, standard deviation
785 .RE
786 Bandwidth:
787 .RS
788 .B min, max, aggregate percentage of total, mean, standard deviation
789 .RE
790 .RE
791 .P
792 Write status:
793 .RS
794 .B KiB I/O, bandwidth \fR(KiB/s)\fP, runtime \fR(ms)\fP
795 .P
796 Submission latency:
797 .RS
798 .B min, max, mean, standard deviation
799 .RE
800 Completion latency:
801 .RS
802 .B min, max, mean, standard deviation
803 .RE
804 Bandwidth:
805 .RS
806 .B min, max, aggregate percentage of total, mean, standard deviation
807 .RE
808 .RE
809 .P
810 CPU usage:
811 .RS
812 .B user, system, context switches, major page faults, minor page faults
813 .RE
814 .P
815 IO depth distribution:
816 .RS
817 .B <=1, 2, 4, 8, 16, 32, >=64
818 .RE
819 .P
820 IO latency distribution (ms):
821 .RS
822 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, >=2000
823 .RE
824 .P
825 .B text description
826 .RE
828 .B fio
829 was written by Jens Axboe <>.
830 .br
831 This man page was written by Aaron Carroll <> based
832 on documentation by Jens Axboe.
834 Report bugs to the \fBfio\fR mailing list <>.
835 See \fBREADME\fR.
836 .SH "SEE ALSO"
837 For further documentation see \fBHOWTO\fR and \fBREADME\fR.
838 .br
839 Sample jobfiles are available in the \fBexamples\fR directory.