1 .TH fio 1 "September 2007" "User Manual"
3 fio \- flexible I/O tester
6 [\fIoptions\fR] [\fIjobfile\fR]...
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.
15 .BI \-\-output \fR=\fPfilename
16 Write output to \fIfilename\fR.
18 .BI \-\-timeout \fR=\fPtimeout
19 Limit run time to \fItimeout\fR seconds.
22 Generate per-job latency logs.
25 Generate per-job bandwidth logs.
28 Print statistics in a terse, semicolon-delimited format.
30 .BI \-\-showcmd \fR=\fPjobfile
31 Convert \fIjobfile\fR to a set of command-line options.
34 Enable read-only safety checks.
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'.
40 .BI \-\-section \fR=\fPsec
41 Only run section \fIsec\fR from job file.
43 .BI \-\-cmdhelp \fR=\fPcommand
44 Print help information for \fIcommand\fR. May be `all' for all commands.
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.
52 Display usage information and exit.
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.
65 If \fIjobfile\fR is specified as `-', the job file will be read from
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.
74 Some parameters may take arguments of a specific type. The types used are:
77 String: a sequence of alphanumeric characters.
80 SI integer: a whole number, possibly containing a suffix denoting the base unit
81 of the value. Accepted suffixes are `k', 'M', 'G', 'T', and 'P', denoting
82 kilo (1024), mega (1024^2), giga (1024^3), tera (1024^4), and peta (1024^5)
83 respectively. The suffix is not case sensitive. If prefixed with '0x', the
84 value is assumed to be base 16 (hexadecimal). A suffix may include a trailing
85 'b', for instance 'kb' is identical to 'k'. You can specify a base 10 value
86 by using 'KiB', 'MiB', 'GiB', etc. This is useful for disk drives where
87 values are often given in base 10 values. Specifying '30GiB' will get you
91 Boolean: a true or false value. `0' denotes false, `1' denotes true.
94 Integer range: a range of integers specified in the format
95 \fIlower\fR:\fIupper\fR or \fIlower\fR\-\fIupper\fR. \fIlower\fR and
96 \fIupper\fR may contain a suffix as described above. If an option allows two
97 sets of ranges, they are separated with a `,' or `/' character. For example:
102 May be used to override the job name. On the command line, this parameter
103 has the special purpose of signalling the start of a new job.
105 .BI description \fR=\fPstr
106 Human-readable description of the job. It is printed when the job is run, but
107 otherwise has no special purpose.
109 .BI directory \fR=\fPstr
110 Prefix filenames with this directory. Used to place files in a location other
113 .BI filename \fR=\fPstr
115 normally makes up a file name based on the job name, thread number, and file
116 number. If you want to share files between threads in a job or several jobs,
117 specify a \fIfilename\fR for each of them to override the default. If the I/O
118 engine used is `net', \fIfilename\fR is the host and port to connect to in the
119 format \fIhost\fR/\fIport\fR. If the I/O engine is file-based, you can specify
120 a number of files by separating the names with a `:' character. `\-' is a
121 reserved name, meaning stdin or stdout, depending on the read/write direction
124 .BI lockfile \fR=\fPstr
125 Fio defaults to not locking any files before it does IO to them. If a file or
126 file descriptor is shared, fio can serialize IO to that file to make the end
127 result consistent. This is usual for emulating real workloads that share files.
133 No locking. This is the default.
136 Only one thread or process may do IO at the time, excluding all others.
139 Read-write locking on the file. Many readers may access the file at the same
140 time, but writes get exclusive access.
143 The option may be post-fixed with a lock batch number. If set, then each
144 thread/process may do that amount of IOs to the file before giving up the lock.
145 Since lock acquisition is expensive, batching the lock/unlocks will speed up IO.
148 .BI opendir \fR=\fPstr
149 Recursively open any files below directory \fIstr\fR.
151 .BI readwrite \fR=\fPstr "\fR,\fP rw" \fR=\fPstr
152 Type of I/O pattern. Accepted values are:
169 Mixed sequential reads and writes.
172 Mixed random reads and writes.
175 For mixed I/O, the default split is 50/50. For certain types of io the result
176 may still be skewed a bit, since the speed may be different. It is possible to
177 specify a number of IO's to do before getting a new offset, this is one by
178 appending a `:\fI<nr>\fR to the end of the string given. For a random read, it
179 would look like \fBrw=randread:8\fR for passing in an offset modifier with a
180 value of 8. See the \fBrw_sequencer\fR option.
183 .BI rw_sequencer \fR=\fPstr
184 If an offset modifier is given by appending a number to the \fBrw=<str>\fR line,
185 then this option controls how that number modifies the IO offset being
186 generated. Accepted values are:
191 Generate sequential offset
194 Generate the same offset
197 \fBsequential\fR is only useful for random IO, where fio would normally
198 generate a new random offset for every IO. If you append eg 8 to randread, you
199 would get a new random offset for every 8 IO's. The result would be a seek for
200 only every 8 IO's, instead of for every IO. Use \fBrw=randread:8\fR to specify
201 that. As sequential IO is already sequential, setting \fBsequential\fR for that
202 would not result in any differences. \fBidentical\fR behaves in a similar
203 fashion, except it sends the same offset 8 number of times before generating a
208 .BI kb_base \fR=\fPint
209 The base unit for a kilobyte. The defacto base is 2^10, 1024. Storage
210 manufacturers like to use 10^3 or 1000 as a base ten unit instead, for obvious
211 reasons. Allow values are 1024 or 1000, with 1024 being the default.
213 .BI randrepeat \fR=\fPbool
214 Seed the random number generator in a predictable way so results are repeatable
215 across runs. Default: true.
217 .BI fallocate \fR=\fPbool
218 By default, fio will use fallocate() to advise the system of the size of the
219 file we are going to write. This can be turned off with fallocate=0. May not
220 be available on all supported platforms.
222 .BI fadvise_hint \fR=\fPbool
223 Disable use of \fIposix_fadvise\fR\|(2) to advise the kernel what I/O patterns
224 are likely to be issued. Default: true.
227 Total size of I/O for this job. \fBfio\fR will run until this many bytes have
228 been transfered, unless limited by other options (\fBruntime\fR, for instance).
229 Unless \fBnrfiles\fR and \fBfilesize\fR options are given, this amount will be
230 divided between the available files for the job. If not set, fio will use the
231 full size of the given files or devices. If the the files do not exist, size
234 .BI fill_device \fR=\fPbool "\fR,\fB fill_fs" \fR=\fPbool
235 Sets size to something really large and waits for ENOSPC (no space left on
236 device) as the terminating condition. Only makes sense with sequential write.
237 For a read workload, the mount point will be filled first then IO started on
238 the result. This option doesn't make sense if operating on a raw device node,
239 since the size of that is already known by the file system. Additionally,
240 writing beyond end-of-device will not return ENOSPC there.
242 .BI filesize \fR=\fPirange
243 Individual file sizes. May be a range, in which case \fBfio\fR will select sizes
244 for files at random within the given range, limited to \fBsize\fR in total (if
245 that is given). If \fBfilesize\fR is not specified, each created file is the
248 .BI blocksize \fR=\fPint[,int] "\fR,\fB bs" \fR=\fPint[,int]
249 Block size for I/O units. Default: 4k. Values for reads and writes can be
250 specified separately in the format \fIread\fR,\fIwrite\fR, either of
251 which may be empty to leave that value at its default.
253 .BI blocksize_range \fR=\fPirange[,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange]
254 Specify a range of I/O block sizes. The issued I/O unit will always be a
255 multiple of the minimum size, unless \fBblocksize_unaligned\fR is set. Applies
256 to both reads and writes if only one range is given, but can be specified
257 separately with a comma seperating the values. Example: bsrange=1k-4k,2k-8k.
258 Also (see \fBblocksize\fR).
260 .BI bssplit \fR=\fPstr
261 This option allows even finer grained control of the block sizes issued,
262 not just even splits between them. With this option, you can weight various
263 block sizes for exact control of the issued IO for a job that has mixed
264 block sizes. The format of the option is bssplit=blocksize/percentage,
265 optionally adding as many definitions as needed seperated by a colon.
266 Example: bssplit=4k/10:64k/50:32k/40 would issue 50% 64k blocks, 10% 4k
267 blocks and 40% 32k blocks. \fBbssplit\fR also supports giving separate
268 splits to reads and writes. The format is identical to what the
269 \fBbs\fR option accepts, the read and write parts are separated with a
272 .B blocksize_unaligned\fR,\fP bs_unaligned
273 If set, any size in \fBblocksize_range\fR may be used. This typically won't
274 work with direct I/O, as that normally requires sector alignment.
276 .BI blockalign \fR=\fPint[,int] "\fR,\fB ba" \fR=\fPint[,int]
277 At what boundary to align random IO offsets. Defaults to the same as 'blocksize'
278 the minimum blocksize given. Minimum alignment is typically 512b
279 for using direct IO, though it usually depends on the hardware block size.
280 This option is mutually exclusive with using a random map for files, so it
281 will turn off that option.
284 Initialise buffers with all zeros. Default: fill buffers with random data.
287 If this option is given, fio will refill the IO buffers on every submit. The
288 default is to only fill it at init time and reuse that data. Only makes sense
289 if zero_buffers isn't specified, naturally. If data verification is enabled,
290 refill_buffers is also automatically enabled.
292 .BI nrfiles \fR=\fPint
293 Number of files to use for this job. Default: 1.
295 .BI openfiles \fR=\fPint
296 Number of files to keep open at the same time. Default: \fBnrfiles\fR.
298 .BI file_service_type \fR=\fPstr
299 Defines how files to service are selected. The following types are defined:
304 Choose a file at random
307 Round robin over open files (default).
309 Do each file in the set sequentially.
312 The number of I/Os to issue before switching a new file can be specified by
313 appending `:\fIint\fR' to the service type.
316 .BI ioengine \fR=\fPstr
317 Defines how the job issues I/O. The following types are defined:
322 Basic \fIread\fR\|(2) or \fIwrite\fR\|(2) I/O. \fIfseek\fR\|(2) is used to
323 position the I/O location.
326 Basic \fIpread\fR\|(2) or \fIpwrite\fR\|(2) I/O.
329 Basic \fIreadv\fR\|(2) or \fIwritev\fR\|(2) I/O. Will emulate queuing by
330 coalescing adjacents IOs into a single submission.
333 Linux native asynchronous I/O.
336 POSIX asynchronous I/O using \fIaio_read\fR\|(3) and \fIaio_write\fR\|(3).
339 Solaris native asynchronous I/O.
342 Windows native asynchronous I/O.
345 File is memory mapped with \fImmap\fR\|(2) and data copied using
349 \fIsplice\fR\|(2) is used to transfer the data and \fIvmsplice\fR\|(2) to
350 transfer data from user-space to the kernel.
353 Use the syslet system calls to make regular read/write asynchronous.
356 SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if
357 the target is an sg character device, we use \fIread\fR\|(2) and
358 \fIwrite\fR\|(2) for asynchronous I/O.
361 Doesn't transfer any data, just pretends to. Mainly used to exercise \fBfio\fR
362 itself and for debugging and testing purposes.
365 Transfer over the network. \fBfilename\fR must be set appropriately to
366 `\fIhost\fR/\fIport\fR' regardless of data direction. If receiving, only the
367 \fIport\fR argument is used.
370 Like \fBnet\fR, but uses \fIsplice\fR\|(2) and \fIvmsplice\fR\|(2) to map data
374 Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and
375 \fBcpucycles\fR parameters.
378 The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface
379 approach to asycnronous I/O.
381 See <http://www.xmailserver.org/guasi\-lib.html>.
384 Loads an external I/O engine object file. Append the engine filename as
389 .BI iodepth \fR=\fPint
390 Number of I/O units to keep in flight against the file. Note that increasing
391 iodepth beyond 1 will not affect synchronous ioengines (except for small
392 degress when verify_async is in use). Even async engines my impose OS
393 restrictions causing the desired depth not to be achieved. This may happen on
394 Linux when using libaio and not setting \fBdirect\fR=1, since buffered IO is
395 not async on that OS. Keep an eye on the IO depth distribution in the
396 fio output to verify that the achieved depth is as expected. Default: 1.
398 .BI iodepth_batch \fR=\fPint
399 Number of I/Os to submit at once. Default: \fBiodepth\fR.
401 .BI iodepth_batch_complete \fR=\fPint
402 This defines how many pieces of IO to retrieve at once. It defaults to 1 which
403 means that we'll ask for a minimum of 1 IO in the retrieval process from the
404 kernel. The IO retrieval will go on until we hit the limit set by
405 \fBiodepth_low\fR. If this variable is set to 0, then fio will always check for
406 completed events before queuing more IO. This helps reduce IO latency, at the
407 cost of more retrieval system calls.
409 .BI iodepth_low \fR=\fPint
410 Low watermark indicating when to start filling the queue again. Default:
413 .BI direct \fR=\fPbool
414 If true, use non-buffered I/O (usually O_DIRECT). Default: false.
416 .BI buffered \fR=\fPbool
417 If true, use buffered I/O. This is the opposite of the \fBdirect\fR parameter.
420 .BI offset \fR=\fPint
421 Offset in the file to start I/O. Data before the offset will not be touched.
424 How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data. If
425 0, don't sync. Default: 0.
427 .BI fdatasync \fR=\fPint
428 Like \fBfsync\fR, but uses \fBfdatasync\fR\|(2) instead to only sync the
429 data parts of the file. Default: 0.
431 .BI sync_file_range \fR=\fPstr:int
432 Use sync_file_range() for every \fRval\fP number of write operations. Fio will
433 track range of writes that have happened since the last sync_file_range() call.
434 \fRstr\fP can currently be one or more of:
438 SYNC_FILE_RANGE_WAIT_BEFORE
441 SYNC_FILE_RANGE_WRITE
444 SYNC_FILE_RANGE_WRITE
448 So if you do sync_file_range=wait_before,write:8, fio would use
449 \fBSYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE\fP for every 8 writes.
450 Also see the sync_file_range(2) man page. This option is Linux specific.
452 .BI overwrite \fR=\fPbool
453 If writing, setup the file first and do overwrites. Default: false.
455 .BI end_fsync \fR=\fPbool
456 Sync file contents when job exits. Default: false.
458 .BI fsync_on_close \fR=\fPbool
459 If true, sync file contents on close. This differs from \fBend_fsync\fR in that
460 it will happen on every close, not just at the end of the job. Default: false.
462 .BI rwmixcycle \fR=\fPint
463 How many milliseconds before switching between reads and writes for a mixed
464 workload. Default: 500ms.
466 .BI rwmixread \fR=\fPint
467 Percentage of a mixed workload that should be reads. Default: 50.
469 .BI rwmixwrite \fR=\fPint
470 Percentage of a mixed workload that should be writes. If \fBrwmixread\fR and
471 \fBrwmixwrite\fR are given and do not sum to 100%, the latter of the two
472 overrides the first. This may interfere with a given rate setting, if fio is
473 asked to limit reads or writes to a certain rate. If that is the case, then
474 the distribution may be skewed. Default: 50.
477 Normally \fBfio\fR will cover every block of the file when doing random I/O. If
478 this parameter is given, a new offset will be chosen without looking at past
479 I/O history. This parameter is mutually exclusive with \fBverify\fR.
482 See \fBnorandommap\fR. If fio runs with the random block map enabled and it
483 fails to allocate the map, if this option is set it will continue without a
484 random block map. As coverage will not be as complete as with random maps, this
485 option is disabled by default.
488 Run job with given nice value. See \fInice\fR\|(2).
491 Set I/O priority value of this job between 0 (highest) and 7 (lowest). See
494 .BI prioclass \fR=\fPint
495 Set I/O priority class. See \fIionice\fR\|(1).
497 .BI thinktime \fR=\fPint
498 Stall job for given number of microseconds between issuing I/Os.
500 .BI thinktime_spin \fR=\fPint
501 Pretend to spend CPU time for given number of microseconds, sleeping the rest
502 of the time specified by \fBthinktime\fR. Only valid if \fBthinktime\fR is set.
504 .BI thinktime_blocks \fR=\fPint
505 Number of blocks to issue before waiting \fBthinktime\fR microseconds.
509 Cap bandwidth used by this job. The number is in bytes/sec, the normal postfix
510 rules apply. You can use \fBrate\fR=500k to limit reads and writes to 500k each,
511 or you can specify read and writes separately. Using \fBrate\fR=1m,500k would
512 limit reads to 1MB/sec and writes to 500KB/sec. Capping only reads or writes
513 can be done with \fBrate\fR=,500k or \fBrate\fR=500k,. The former will only
514 limit writes (to 500KB/sec), the latter will only limit reads.
516 .BI ratemin \fR=\fPint
517 Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth.
518 Failing to meet this requirement will cause the job to exit. The same format
519 as \fBrate\fR is used for read vs write separation.
521 .BI rate_iops \fR=\fPint
522 Cap the bandwidth to this number of IOPS. Basically the same as rate, just
523 specified independently of bandwidth. The same format as \fBrate\fR is used for
524 read vs write seperation. If \fBblocksize\fR is a range, the smallest block
525 size is used as the metric.
527 .BI rate_iops_min \fR=\fPint
528 If this rate of I/O is not met, the job will exit. The same format as \fBrate\fR
529 is used for read vs write seperation.
531 .BI ratecycle \fR=\fPint
532 Average bandwidth for \fBrate\fR and \fBratemin\fR over this number of
533 milliseconds. Default: 1000ms.
535 .BI cpumask \fR=\fPint
536 Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job
537 may run on. See \fBsched_setaffinity\fR\|(2).
539 .BI cpus_allowed \fR=\fPstr
540 Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers.
542 .BI startdelay \fR=\fPint
543 Delay start of job for the specified number of seconds.
545 .BI runtime \fR=\fPint
546 Terminate processing after the specified number of seconds.
549 If given, run for the specified \fBruntime\fR duration even if the files are
550 completely read or written. The same workload will be repeated as many times
551 as \fBruntime\fR allows.
553 .BI ramp_time \fR=\fPint
554 If set, fio will run the specified workload for this amount of time before
555 logging any performance numbers. Useful for letting performance settle before
556 logging results, thus minimizing the runtime required for stable results. Note
557 that the \fBramp_time\fR is considered lead in time for a job, thus it will
558 increase the total runtime if a special timeout or runtime is specified.
560 .BI invalidate \fR=\fPbool
561 Invalidate buffer-cache for the file prior to starting I/O. Default: true.
564 Use synchronous I/O for buffered writes. For the majority of I/O engines,
565 this means using O_SYNC. Default: false.
567 .BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
568 Allocation method for I/O unit buffer. Allowed values are:
573 Allocate memory with \fImalloc\fR\|(3).
576 Use shared memory buffers allocated through \fIshmget\fR\|(2).
579 Same as \fBshm\fR, but use huge pages as backing.
582 Use \fImmap\fR\|(2) for allocation. Uses anonymous memory unless a filename
583 is given after the option in the format `:\fIfile\fR'.
586 Same as \fBmmap\fR, but use huge files as backing.
589 The amount of memory allocated is the maximum allowed \fBblocksize\fR for the
590 job multiplied by \fBiodepth\fR. For \fBshmhuge\fR or \fBmmaphuge\fR to work,
591 the system must have free huge pages allocated. \fBmmaphuge\fR also needs to
592 have hugetlbfs mounted, and \fIfile\fR must point there. At least on Linux,
593 huge pages must be manually allocated. See \fB/proc/sys/vm/nr_hugehages\fR
594 and the documentation for that. Normally you just need to echo an appropriate
595 number, eg echoing 8 will ensure that the OS has 8 huge pages ready for
599 .BI iomem_align \fR=\fPint
600 This indiciates the memory alignment of the IO memory buffers. Note that the
601 given alignment is applied to the first IO unit buffer, if using \fBiodepth\fR
602 the alignment of the following buffers are given by the \fBbs\fR used. In
603 other words, if using a \fBbs\fR that is a multiple of the page sized in the
604 system, all buffers will be aligned to this value. If using a \fBbs\fR that
605 is not page aligned, the alignment of subsequent IO memory buffers is the
606 sum of the \fBiomem_align\fR and \fBbs\fR used.
608 .BI hugepage\-size \fR=\fPint
609 Defines the size of a huge page. Must be at least equal to the system setting.
610 Should be a multiple of 1MB. Default: 4MB.
613 Terminate all jobs when one finishes. Default: wait for each job to finish.
615 .BI bwavgtime \fR=\fPint
616 Average bandwidth calculations over the given time in milliseconds. Default:
619 .BI create_serialize \fR=\fPbool
620 If true, serialize file creation for the jobs. Default: true.
622 .BI create_fsync \fR=\fPbool
623 \fIfsync\fR\|(2) data file after creation. Default: true.
625 .BI create_on_open \fR=\fPbool
626 If true, the files are not created until they are opened for IO by the job.
628 .BI pre_read \fR=\fPbool
629 If this is given, files will be pre-read into memory before starting the given
630 IO operation. This will also clear the \fR \fBinvalidate\fR flag, since it is
631 pointless to pre-read and then drop the cache. This will only work for IO
632 engines that are seekable, since they allow you to read the same data
633 multiple times. Thus it will not work on eg network or splice IO.
635 .BI unlink \fR=\fPbool
636 Unlink job files when done. Default: false.
639 Specifies the number of iterations (runs of the same workload) of this job.
642 .BI do_verify \fR=\fPbool
643 Run the verify phase after a write phase. Only valid if \fBverify\fR is set.
646 .BI verify \fR=\fPstr
647 Method of verifying file contents after each iteration of the job. Allowed
652 .B md5 crc16 crc32 crc32c crc32c-intel crc64 crc7 sha256 sha512 sha1
653 Store appropriate checksum in the header of each block. crc32c-intel is
654 hardware accelerated SSE4.2 driven, falls back to regular crc32c if
655 not supported by the system.
658 Write extra information about each I/O (timestamp, block number, etc.). The
659 block number is verified. See \fBverify_pattern\fR as well.
662 Pretend to verify. Used for testing internals.
665 This option can be used for repeated burn-in tests of a system to make sure
666 that the written data is also correctly read back. If the data direction given
667 is a read or random read, fio will assume that it should verify a previously
668 written file. If the data direction includes any form of write, the verify will
669 be of the newly written data.
672 .BI verify_sort \fR=\fPbool
673 If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to
674 read them back in a sorted manner. Default: true.
676 .BI verify_offset \fR=\fPint
677 Swap the verification header with data somewhere else in the block before
678 writing. It is swapped back before verifying.
680 .BI verify_interval \fR=\fPint
681 Write the verification header for this number of bytes, which should divide
682 \fBblocksize\fR. Default: \fBblocksize\fR.
684 .BI verify_pattern \fR=\fPstr
685 If set, fio will fill the io buffers with this pattern. Fio defaults to filling
686 with totally random bytes, but sometimes it's interesting to fill with a known
687 pattern for io verification purposes. Depending on the width of the pattern,
688 fio will fill 1/2/3/4 bytes of the buffer at the time(it can be either a
689 decimal or a hex number). The verify_pattern if larger than a 32-bit quantity
690 has to be a hex number that starts with either "0x" or "0X". Use with
693 .BI verify_fatal \fR=\fPbool
694 If true, exit the job on the first observed verification failure. Default:
697 .BI verify_dump \fR=\fPbool
698 If set, dump the contents of both the original data block and the data block we
699 read off disk to files. This allows later analysis to inspect just what kind of
700 data corruption occurred. On by default.
702 .BI verify_async \fR=\fPint
703 Fio will normally verify IO inline from the submitting thread. This option
704 takes an integer describing how many async offload threads to create for IO
705 verification instead, causing fio to offload the duty of verifying IO contents
706 to one or more separate threads. If using this offload option, even sync IO
707 engines can benefit from using an \fBiodepth\fR setting higher than 1, as it
708 allows them to have IO in flight while verifies are running.
710 .BI verify_async_cpus \fR=\fPstr
711 Tell fio to set the given CPU affinity on the async IO verification threads.
712 See \fBcpus_allowed\fP for the format used.
714 .BI verify_backlog \fR=\fPint
715 Fio will normally verify the written contents of a job that utilizes verify
716 once that job has completed. In other words, everything is written then
717 everything is read back and verified. You may want to verify continually
718 instead for a variety of reasons. Fio stores the meta data associated with an
719 IO block in memory, so for large verify workloads, quite a bit of memory would
720 be used up holding this meta data. If this option is enabled, fio will write
721 only N blocks before verifying these blocks.
723 .BI verify_backlog_batch \fR=\fPint
724 Control how many blocks fio will verify if verify_backlog is set. If not set,
725 will default to the value of \fBverify_backlog\fR (meaning the entire queue is
726 read back and verified). If \fBverify_backlog_batch\fR is less than
727 \fBverify_backlog\fR then not all blocks will be verified, if
728 \fBverify_backlog_batch\fR is larger than \fBverify_backlog\fR, some blocks
729 will be verified more than once.
732 Wait for preceeding jobs in the job file to exit before starting this one.
733 \fBstonewall\fR implies \fBnew_group\fR.
736 Start a new reporting group. If not given, all jobs in a file will be part
737 of the same reporting group, unless separated by a stonewall.
739 .BI numjobs \fR=\fPint
740 Number of clones (processes/threads performing the same workload) of this job.
744 If set, display per-group reports instead of per-job when \fBnumjobs\fR is
748 Use threads created with \fBpthread_create\fR\|(3) instead of processes created
749 with \fBfork\fR\|(2).
751 .BI zonesize \fR=\fPint
752 Divide file into zones of the specified size in bytes. See \fBzoneskip\fR.
754 .BI zoneskip \fR=\fPint
755 Skip the specified number of bytes when \fBzonesize\fR bytes of data have been
758 .BI write_iolog \fR=\fPstr
759 Write the issued I/O patterns to the specified file. Specify a separate file
760 for each job, otherwise the iologs will be interspersed and the file may be
763 .BI read_iolog \fR=\fPstr
764 Replay the I/O patterns contained in the specified file generated by
765 \fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file.
767 .BI replay_no_stall \fR=\fPint
768 While replaying I/O patterns using \fBread_iolog\fR the default behavior
769 attempts to respect timing information between I/Os. Enabling
770 \fBreplay_no_stall\fR causes I/Os to be replayed as fast as possible while
771 still respecting ordering.
773 .BI replay_redirect \fR=\fPstr
774 While replaying I/O patterns using \fBread_iolog\fR the default behavior
775 is to replay the IOPS onto the major/minor device that each IOP was recorded
776 from. Setting \fBreplay_redirect\fR causes all IOPS to be replayed onto the
777 single specified device regardless of the device it was recorded from.
779 .B write_bw_log \fR=\fPstr
780 If given, write a bandwidth log of the jobs in this job file. Can be used to
781 store data of the bandwidth of the jobs in their lifetime. The included
782 fio_generate_plots script uses gnuplot to turn these text files into nice
783 graphs. See \fBwrite_log_log\fR for behaviour of given filename. For this
784 option, the postfix is _bw.log.
786 .B write_lat_log \fR=\fPstr
787 Same as \fBwrite_bw_log\fR, but writes I/O completion latencies. If no
788 filename is given with this option, the default filename of "jobname_type.log"
789 is used. Even if the filename is given, fio will still append the type of log.
791 .B disable_lat \fR=\fPbool
792 Disable measurements of total latency numbers. Useful only for cutting
793 back the number of calls to gettimeofday, as that does impact performance at
794 really high IOPS rates. Note that to really get rid of a large amount of these
795 calls, this option must be used with disable_slat and disable_bw as well.
797 .B disable_clat \fR=\fPbool
798 Disable measurements of submission latency numbers. See \fBdisable_lat\fR.
800 .B disable_slat \fR=\fPbool
801 Disable measurements of submission latency numbers. See \fBdisable_lat\fR.
803 .B disable_bw_measurement \fR=\fPbool
804 Disable measurements of throughput/bandwidth numbers. See \fBdisable_lat\fR.
806 .BI lockmem \fR=\fPint
807 Pin the specified amount of memory with \fBmlock\fR\|(2). Can be used to
808 simulate a smaller amount of memory.
810 .BI exec_prerun \fR=\fPstr
811 Before running the job, execute the specified command with \fBsystem\fR\|(3).
813 .BI exec_postrun \fR=\fPstr
814 Same as \fBexec_prerun\fR, but the command is executed after the job completes.
816 .BI ioscheduler \fR=\fPstr
817 Attempt to switch the device hosting the file to the specified I/O scheduler.
819 .BI cpuload \fR=\fPint
820 If the job is a CPU cycle-eater, attempt to use the specified percentage of
823 .BI cpuchunks \fR=\fPint
824 If the job is a CPU cycle-eater, split the load into cycles of the
825 given time in milliseconds.
827 .BI disk_util \fR=\fPbool
828 Generate disk utilization statistics if the platform supports it. Default: true.
830 .BI gtod_reduce \fR=\fPbool
831 Enable all of the gettimeofday() reducing options (disable_clat, disable_slat,
832 disable_bw) plus reduce precision of the timeout somewhat to really shrink the
833 gettimeofday() call count. With this option enabled, we only do about 0.4% of
834 the gtod() calls we would have done if all time keeping was enabled.
836 .BI gtod_cpu \fR=\fPint
837 Sometimes it's cheaper to dedicate a single thread of execution to just getting
838 the current time. Fio (and databases, for instance) are very intensive on
839 gettimeofday() calls. With this option, you can set one CPU aside for doing
840 nothing but logging current time to a shared memory location. Then the other
841 threads/processes that run IO workloads need only copy that segment, instead of
842 entering the kernel with a gettimeofday() call. The CPU set aside for doing
843 these time calls will be excluded from other uses. Fio will manually clear it
844 from the CPU mask of other jobs.
846 .BI cgroup \fR=\fPstr
847 Add job to this control group. If it doesn't exist, it will be created.
848 The system must have a mounted cgroup blkio mount point for this to work. If
849 your system doesn't have it mounted, you can do so with:
851 # mount -t cgroup -o blkio none /cgroup
853 .BI cgroup_weight \fR=\fPint
854 Set the weight of the cgroup to this value. See the documentation that comes
855 with the kernel, allowed values are in the range of 100..1000.
857 .BI cgroup_nodelete \fR=\fPbool
858 Normally fio will delete the cgroups it has created after the job completion.
859 To override this behavior and to leave cgroups around after the job completion,
860 set cgroup_nodelete=1. This can be useful if one wants to inspect various
861 cgroup files after job completion. Default: false
864 Instead of running as the invoking user, set the user ID to this value before
865 the thread/process does any work.
868 Set group ID, see \fBuid\fR.
870 While running, \fBfio\fR will display the status of the created jobs. For
874 Threads: 1: [_r] [24.8% done] [ 13509/ 8334 kb/s] [eta 00h:01m:31s]
877 The characters in the first set of brackets denote the current status of each
878 threads. The possible values are:
884 Setup but not started.
890 Initialized, waiting.
893 Running, doing sequential reads.
896 Running, doing random reads.
899 Running, doing sequential writes.
902 Running, doing random writes.
905 Running, doing mixed sequential reads/writes.
908 Running, doing mixed random reads/writes.
911 Running, currently waiting for \fBfsync\fR\|(2).
914 Running, verifying written data.
917 Exited, not reaped by main thread.
920 Exited, thread reaped.
924 The second set of brackets shows the estimated completion percentage of
925 the current group. The third set shows the read and write I/O rate,
926 respectively. Finally, the estimated run time of the job is displayed.
928 When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data
929 for each thread, each group of threads, and each disk, in that order.
931 Per-thread statistics first show the threads client number, group-id, and
932 error code. The remaining figures are as follows:
936 Number of megabytes of I/O performed.
939 Average data rate (bandwidth).
945 Submission latency minimum, maximum, average and standard deviation. This is
946 the time it took to submit the I/O.
949 Completion latency minimum, maximum, average and standard deviation. This
950 is the time between submission and completion.
953 Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average
954 and standard deviation.
957 CPU usage statistics. Includes user and system time, number of context switches
958 this thread went through and number of major and minor page faults.
961 Distribution of I/O depths. Each depth includes everything less than (or equal)
962 to it, but greater than the previous depth.
965 Number of read/write requests issued, and number of short read/write requests.
968 Distribution of I/O completion latencies. The numbers follow the same pattern
972 The group statistics show:
977 Number of megabytes I/O performed.
980 Aggregate bandwidth of threads in the group.
983 Minimum average bandwidth a thread saw.
986 Maximum average bandwidth a thread saw.
989 Shortest runtime of threads in the group.
992 Longest runtime of threads in the group.
996 Finally, disk statistics are printed with reads first:
1001 Number of I/Os performed by all groups.
1004 Number of merges in the I/O scheduler.
1007 Number of ticks we kept the disk busy.
1010 Total time spent in the disk queue.
1017 If the \fB\-\-minimal\fR option is given, the results will be printed in a
1018 semicolon-delimited format suitable for scripted use - a job description
1019 (if provided) follows on a new line. Note that the first
1020 number in the line is the version number. If the output has to be changed
1021 for some reason, this number will be incremented by 1 to signify that
1022 change. The fields are:
1025 .B version, jobname, groupid, error
1029 .B KB I/O, bandwidth \fR(KB/s)\fP, runtime \fR(ms)\fP
1033 .B min, max, mean, standard deviation
1037 .B min, max, mean, standard deviation
1041 .B min, max, mean, standard deviation
1045 .B min, max, aggregate percentage of total, mean, standard deviation
1051 .B KB I/O, bandwidth \fR(KB/s)\fP, runtime \fR(ms)\fP
1055 .B min, max, mean, standard deviation
1059 .B min, max, mean, standard deviation
1063 .B min, max, mean, standard deviation
1067 .B min, max, aggregate percentage of total, mean, standard deviation
1073 .B user, system, context switches, major page faults, minor page faults
1076 IO depth distribution:
1078 .B <=1, 2, 4, 8, 16, 32, >=64
1081 IO latency distribution:
1085 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
1089 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000
1093 Error Info (dependant on continue_on_error, default off):
1095 .B total # errors, first error code
1098 .B text description (if provided in config - appears on newline)
1102 was written by Jens Axboe <jens.axboe@oracle.com>,
1103 now Jens Axboe <jaxboe@fusionio.com>.
1105 This man page was written by Aaron Carroll <aaronc@cse.unsw.edu.au> based
1106 on documentation by Jens Axboe.
1107 .SH "REPORTING BUGS"
1108 Report bugs to the \fBfio\fR mailing list <fio@vger.kernel.org>.
1111 For further documentation see \fBHOWTO\fR and \fBREADME\fR.
1113 Sample jobfiles are available in the \fBexamples\fR directory.
projects / fio.git / blob