[fio.git] / fio.1
1 .TH fio 1 "December 2014" "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 \-\-debug \fR=\fPtype
16 Enable verbose tracing of various fio actions. May be `all' for all types
17 or individual types separated by a comma (eg \-\-debug=io,file). `help' will
18 list all available tracing options.
19 .TP
20 .BI \-\-output \fR=\fPfilename
21 Write output to \fIfilename\fR.
22 .TP
23 .BI \-\-output-format \fR=\fPformat
24 Set the reporting format to \fInormal\fR, \fIterse\fR, or \fIjson\fR.
25 .TP
26 .BI \-\-runtime \fR=\fPruntime
27 Limit run time to \fIruntime\fR seconds.
28 .TP
29 .B \-\-bandwidth\-log
30 Generate per-job bandwidth logs.
31 .TP
32 .B \-\-minimal
33 Print statistics in a terse, semicolon-delimited format.
34 .TP
35 .B \-\-append-terse
36 Print statistics in selected mode AND terse, semicolon-delimited format.
37 .TP
38 .B \-\-version
39 Display version information and exit.
40 .TP
41 .BI \-\-terse\-version \fR=\fPversion
42 Set terse version output format (Current version 3, or older version 2).
43 .TP
44 .B \-\-help
45 Display usage information and exit.
46 .TP
47 .B \-\-cpuclock-test
48 Perform test and validation of internal CPU clock
49 .TP
50 .BI \-\-crctest[\fR=\fPtest]
51 Test the speed of the builtin checksumming functions. If no argument is given,
52 all of them are tested. Or a comma separated list can be passed, in which
53 case the given ones are tested.
54 .TP
55 .BI \-\-cmdhelp \fR=\fPcommand
56 Print help information for \fIcommand\fR.  May be `all' for all commands.
57 .TP
58 .BI \-\-enghelp \fR=\fPioengine[,command]
59 List all commands defined by \fIioengine\fR, or print help for \fIcommand\fR defined by \fIioengine\fR.
60 .TP
61 .BI \-\-showcmd \fR=\fPjobfile
62 Convert \fIjobfile\fR to a set of command-line options.
63 .TP
64 .BI \-\-eta \fR=\fPwhen
65 Specifies when real-time ETA estimate should be printed.  \fIwhen\fR may
66 be one of `always', `never' or `auto'.
67 .TP
68 .BI \-\-eta\-newline \fR=\fPtime
69 Force an ETA newline for every `time` period passed.
70 .TP
71 .BI \-\-status\-interval \fR=\fPtime
72 Report full output status every `time` period passed.
73 .TP
74 .BI \-\-readonly
75 Turn on safety read-only checks, preventing any attempted write.
76 .TP
77 .BI \-\-section \fR=\fPsec
78 Only run section \fIsec\fR from job file. This option can be used multiple times to add more sections to run.
79 .TP
80 .BI \-\-alloc\-size \fR=\fPkb
81 Set the internal smalloc pool size to \fIkb\fP kilobytes.
82 .TP
83 .BI \-\-warnings\-fatal
84 All fio parser warnings are fatal, causing fio to exit with an error.
85 .TP
86 .BI \-\-max\-jobs \fR=\fPnr
87 Set the maximum allowed number of jobs (threads/processes) to support.
88 .TP
89 .BI \-\-server \fR=\fPargs
90 Start a backend server, with \fIargs\fP specifying what to listen to. See client/server section.
91 .TP
92 .BI \-\-daemonize \fR=\fPpidfile
93 Background a fio server, writing the pid to the given pid file.
94 .TP
95 .BI \-\-client \fR=\fPhost
96 Instead of running the jobs locally, send and run them on the given host or set of hosts.  See client/server section.
97 .TP
98 .BI \-\-idle\-prof \fR=\fPoption
99 Report cpu idleness on a system or percpu basis (\fIoption\fP=system,percpu) or run unit work calibration only (\fIoption\fP=calibrate).
101 Job files are in `ini' format. They consist of one or more
102 job definitions, which begin with a job name in square brackets and
103 extend to the next job name.  The job name can be any ASCII string
104 except `global', which has a special meaning.  Following the job name is
105 a sequence of zero or more parameters, one per line, that define the
106 behavior of the job.  Any line starting with a `;' or `#' character is
107 considered a comment and ignored.
108 .P
109 If \fIjobfile\fR is specified as `-', the job file will be read from
110 standard input.
111 .SS "Global Section"
112 The global section contains default parameters for jobs specified in the
113 job file.  A job is only affected by global sections residing above it,
114 and there may be any number of global sections.  Specific job definitions
115 may override any parameter set in global sections.
117 .SS Types
118 Some parameters may take arguments of a specific type.
119 Anywhere a numeric value is required, an arithmetic expression may be used,
120 provided it is surrounded by parentheses. Supported operators are:
121 .RS
122 .RS
123 .TP
124 .B addition (+)
125 .TP
126 .B subtraction (-)
127 .TP
128 .B multiplication (*)
129 .TP
130 .B division (/)
131 .TP
132 .B modulus (%)
133 .TP
134 .B exponentiation (^)
135 .RE
136 .RE
137 .P
138 For time values in expressions, units are microseconds by default. This is
139 different than for time values not in expressions (not enclosed in
140 parentheses). The types used are:
141 .TP
142 .I str
143 String: a sequence of alphanumeric characters.
144 .TP
145 .I int
146 SI integer: a whole number, possibly containing a suffix denoting the base unit
147 of the value.  Accepted suffixes are `k', 'M', 'G', 'T', and 'P', denoting
148 kilo (1024), mega (1024^2), giga (1024^3), tera (1024^4), and peta (1024^5)
149 respectively. If prefixed with '0x', the value is assumed to be base 16
150 (hexadecimal). A suffix may include a trailing 'b', for instance 'kb' is
151 identical to 'k'. You can specify a base 10 value by using 'KiB', 'MiB','GiB',
152 etc. This is useful for disk drives where values are often given in base 10
153 values. Specifying '30GiB' will get you 30*1000^3 bytes.
154 When specifying times the default suffix meaning changes, still denoting the
155 base unit of the value, but accepted suffixes are 'D' (days), 'H' (hours), 'M'
156 (minutes), 'S' Seconds, 'ms' (or msec) milli seconds, 'us' (or 'usec') micro
157 seconds. Time values without a unit specify seconds.
158 The suffixes are not case sensitive.
159 .TP
160 .I bool
161 Boolean: a true or false value. `0' denotes false, `1' denotes true.
162 .TP
163 .I irange
164 Integer range: a range of integers specified in the format
165 \fIlower\fR:\fIupper\fR or \fIlower\fR\-\fIupper\fR. \fIlower\fR and
166 \fIupper\fR may contain a suffix as described above.  If an option allows two
167 sets of ranges, they are separated with a `,' or `/' character. For example:
168 `8\-8k/8M\-4G'.
169 .TP
170 .I float_list
171 List of floating numbers: A list of floating numbers, separated by
172 a ':' character.
173 .SS "Parameter List"
174 .TP
175 .BI name \fR=\fPstr
176 May be used to override the job name.  On the command line, this parameter
177 has the special purpose of signalling the start of a new job.
178 .TP
179 .BI description \fR=\fPstr
180 Human-readable description of the job. It is printed when the job is run, but
181 otherwise has no special purpose.
182 .TP
183 .BI directory \fR=\fPstr
184 Prefix filenames with this directory.  Used to place files in a location other
185 than `./'.
186 You can specify a number of directories by separating the names with a ':'
187 character. These directories will be assigned equally distributed to job clones
188 creates with \fInumjobs\fR as long as they are using generated filenames.
189 If specific \fIfilename(s)\fR are set fio will use the first listed directory,
190 and thereby matching the  \fIfilename\fR semantic which generates a file each
191 clone if not specified, but let all clones use the same if set. See
192 \fIfilename\fR for considerations regarding escaping certain characters on
193 some platforms.
194 .TP
195 .BI filename \fR=\fPstr
196 .B fio
197 normally makes up a file name based on the job name, thread number, and file
198 number. If you want to share files between threads in a job or several jobs,
199 specify a \fIfilename\fR for each of them to override the default.
200 If the I/O engine is file-based, you can specify
201 a number of files by separating the names with a `:' character. `\-' is a
202 reserved name, meaning stdin or stdout, depending on the read/write direction
203 set. On Windows, disk devices are accessed as \\.\PhysicalDrive0 for the first
204 device, \\.\PhysicalDrive1 for the second etc. Note: Windows and FreeBSD
205 prevent write access to areas of the disk containing in-use data
206 (e.g. filesystems). If the wanted filename does need to include a colon, then
207 escape that with a '\\' character. For instance, if the filename is
208 "/dev/dsk/foo@3,0:c", then you would use filename="/dev/dsk/foo@3,0\\:c".
209 .TP
210 .BI filename_format \fR=\fPstr
211 If sharing multiple files between jobs, it is usually necessary to have
212 fio generate the exact names that you want. By default, fio will name a file
213 based on the default file format specification of
214 \fBjobname.jobnumber.filenumber\fP. With this option, that can be
215 customized. Fio will recognize and replace the following keywords in this
216 string:
217 .RS
218 .RS
219 .TP
220 .B $jobname
221 The name of the worker thread or process.
222 .TP
223 .B $jobnum
224 The incremental number of the worker thread or process.
225 .TP
226 .B $filenum
227 The incremental number of the file for that worker thread or process.
228 .RE
229 .P
230 To have dependent jobs share a set of files, this option can be set to
231 have fio generate filenames that are shared between the two. For instance,
232 if \fBtestfiles.$filenum\fR is specified, file number 4 for any job will
233 be named \fBtestfiles.4\fR. The default of \fB$jobname.$jobnum.$filenum\fR
234 will be used if no other format specifier is given.
235 .RE
236 .P
237 .TP
238 .BI lockfile \fR=\fPstr
239 Fio defaults to not locking any files before it does IO to them. If a file or
240 file descriptor is shared, fio can serialize IO to that file to make the end
241 result consistent. This is usual for emulating real workloads that share files.
242 The lock modes are:
243 .RS
244 .RS
245 .TP
246 .B none
247 No locking. This is the default.
248 .TP
249 .B exclusive
250 Only one thread or process may do IO at a time, excluding all others.
251 .TP
252 .B readwrite
253 Read-write locking on the file. Many readers may access the file at the same
254 time, but writes get exclusive access.
255 .RE
256 .RE
257 .P
258 .BI opendir \fR=\fPstr
259 Recursively open any files below directory \fIstr\fR.
260 .TP
261 .BI readwrite \fR=\fPstr "\fR,\fP rw" \fR=\fPstr
262 Type of I/O pattern.  Accepted values are:
263 .RS
264 .RS
265 .TP
266 .B read
267 Sequential reads.
268 .TP
269 .B write
270 Sequential writes.
271 .TP
272 .B trim
273 Sequential trim (Linux block devices only).
274 .TP
275 .B randread
276 Random reads.
277 .TP
278 .B randwrite
279 Random writes.
280 .TP
281 .B randtrim
282 Random trim (Linux block devices only).
283 .TP
284 .B rw, readwrite
285 Mixed sequential reads and writes.
286 .TP
287 .B randrw 
288 Mixed random reads and writes.
289 .TP
290 .B trimwrite
291 Trim and write mixed workload. Blocks will be trimmed first, then the same
292 blocks will be written to.
293 .RE
294 .P
295 For mixed I/O, the default split is 50/50. For certain types of io the result
296 may still be skewed a bit, since the speed may be different. It is possible to
297 specify a number of IO's to do before getting a new offset, this is done by
298 appending a `:\fI<nr>\fR to the end of the string given. For a random read, it
299 would look like \fBrw=randread:8\fR for passing in an offset modifier with a
300 value of 8. If the postfix is used with a sequential IO pattern, then the value
301 specified will be added to the generated offset for each IO. For instance,
302 using \fBrw=write:4k\fR will skip 4k for every write. It turns sequential IO
303 into sequential IO with holes. See the \fBrw_sequencer\fR option.
304 .RE
305 .TP
306 .BI rw_sequencer \fR=\fPstr
307 If an offset modifier is given by appending a number to the \fBrw=<str>\fR line,
308 then this option controls how that number modifies the IO offset being
309 generated. Accepted values are:
310 .RS
311 .RS
312 .TP
313 .B sequential
314 Generate sequential offset
315 .TP
316 .B identical
317 Generate the same offset
318 .RE
319 .P
320 \fBsequential\fR is only useful for random IO, where fio would normally
321 generate a new random offset for every IO. If you append eg 8 to randread, you
322 would get a new random offset for every 8 IO's. The result would be a seek for
323 only every 8 IO's, instead of for every IO. Use \fBrw=randread:8\fR to specify
324 that. As sequential IO is already sequential, setting \fBsequential\fR for that
325 would not result in any differences.  \fBidentical\fR behaves in a similar
326 fashion, except it sends the same offset 8 number of times before generating a
327 new offset.
328 .RE
329 .P
330 .TP
331 .BI kb_base \fR=\fPint
332 The base unit for a kilobyte. The defacto base is 2^10, 1024.  Storage
333 manufacturers like to use 10^3 or 1000 as a base ten unit instead, for obvious
334 reasons. Allowed values are 1024 or 1000, with 1024 being the default.
335 .TP
336 .BI unified_rw_reporting \fR=\fPbool
337 Fio normally reports statistics on a per data direction basis, meaning that
338 read, write, and trim are accounted and reported separately. If this option is
339 set fio sums the results and reports them as "mixed" instead.
340 .TP
341 .BI randrepeat \fR=\fPbool
342 Seed the random number generator used for random I/O patterns in a predictable
343 way so the pattern is repeatable across runs.  Default: true.
344 .TP
345 .BI allrandrepeat \fR=\fPbool
346 Seed all random number generators in a predictable way so results are
347 repeatable across runs.  Default: false.
348 .TP
349 .BI randseed \fR=\fPint
350 Seed the random number generators based on this seed value, to be able to
351 control what sequence of output is being generated. If not set, the random
352 sequence depends on the \fBrandrepeat\fR setting.
353 .TP
354 .BI fallocate \fR=\fPstr
355 Whether pre-allocation is performed when laying down files. Accepted values
356 are:
357 .RS
358 .RS
359 .TP
360 .B none
361 Do not pre-allocate space.
362 .TP
363 .B posix
364 Pre-allocate via \fBposix_fallocate\fR\|(3).
365 .TP
366 .B keep
367 Pre-allocate via \fBfallocate\fR\|(2) with FALLOC_FL_KEEP_SIZE set.
368 .TP
369 .B 0
370 Backward-compatible alias for 'none'.
371 .TP
372 .B 1
373 Backward-compatible alias for 'posix'.
374 .RE
375 .P
376 May not be available on all supported platforms. 'keep' is only
377 available on Linux. If using ZFS on Solaris this must be set to 'none'
378 because ZFS doesn't support it. Default: 'posix'.
379 .RE
380 .TP
381 .BI fadvise_hint \fR=\fPbool
382 Use \fBposix_fadvise\fR\|(2) to advise the kernel what I/O patterns
383 are likely to be issued. Default: true.
384 .TP
385 .BI fadvise_stream \fR=\fPint
386 Use \fBposix_fadvise\fR\|(2) to advise the kernel what stream ID the
387 writes issued belong to. Only supported on Linux. Note, this option
388 may change going forward.
389 .TP
390 .BI size \fR=\fPint
391 Total size of I/O for this job.  \fBfio\fR will run until this many bytes have
392 been transferred, unless limited by other options (\fBruntime\fR, for instance,
393 or increased/descreased by \fBio_size\fR). Unless \fBnrfiles\fR and
394 \fBfilesize\fR options are given, this amount will be divided between the
395 available files for the job. If not set, fio will use the full size of the
396 given files or devices. If the files do not exist, size must be given. It is
397 also possible to give size as a percentage between 1 and 100. If size=20% is
398 given, fio will use 20% of the full size of the given files or devices.
399 .TP
400 .BI io_size \fR=\fPint "\fR,\fB io_limit \fR=\fPint
401 Normally fio operates within the region set by \fBsize\fR, which means that
402 the \fBsize\fR option sets both the region and size of IO to be performed.
403 Sometimes that is not what you want. With this option, it is possible to
404 define just the amount of IO that fio should do. For instance, if \fBsize\fR
405 is set to 20G and \fBio_limit\fR is set to 5G, fio will perform IO within
406 the first 20G but exit when 5G have been done. The opposite is also
407 possible - if \fBsize\fR is set to 20G, and \fBio_size\fR is set to 40G, then
408 fio will do 40G of IO within the 0..20G region.
409 .TP
410 .BI fill_device \fR=\fPbool "\fR,\fB fill_fs" \fR=\fPbool
411 Sets size to something really large and waits for ENOSPC (no space left on
412 device) as the terminating condition. Only makes sense with sequential write.
413 For a read workload, the mount point will be filled first then IO started on
414 the result. This option doesn't make sense if operating on a raw device node,
415 since the size of that is already known by the file system. Additionally,
416 writing beyond end-of-device will not return ENOSPC there.
417 .TP
418 .BI filesize \fR=\fPirange
419 Individual file sizes. May be a range, in which case \fBfio\fR will select sizes
420 for files at random within the given range, limited to \fBsize\fR in total (if
421 that is given). If \fBfilesize\fR is not specified, each created file is the
422 same size.
423 .TP
424 .BI file_append \fR=\fPbool
425 Perform IO after the end of the file. Normally fio will operate within the
426 size of a file. If this option is set, then fio will append to the file
427 instead. This has identical behavior to setting \fRoffset\fP to the size
428 of a file. This option is ignored on non-regular files.
429 .TP
430 .BI blocksize \fR=\fPint[,int] "\fR,\fB bs" \fR=\fPint[,int]
431 Block size for I/O units.  Default: 4k.  Values for reads, writes, and trims
432 can be specified separately in the format \fIread\fR,\fIwrite\fR,\fItrim\fR
433 either of which may be empty to leave that value at its default. If a trailing
434 comma isn't given, the remainder will inherit the last value set.
435 .TP
436 .BI blocksize_range \fR=\fPirange[,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange]
437 Specify a range of I/O block sizes.  The issued I/O unit will always be a
438 multiple of the minimum size, unless \fBblocksize_unaligned\fR is set.  Applies
439 to both reads and writes if only one range is given, but can be specified
440 separately with a comma separating the values. Example: bsrange=1k-4k,2k-8k.
441 Also (see \fBblocksize\fR).
442 .TP
443 .BI bssplit \fR=\fPstr
444 This option allows even finer grained control of the block sizes issued,
445 not just even splits between them. With this option, you can weight various
446 block sizes for exact control of the issued IO for a job that has mixed
447 block sizes. The format of the option is bssplit=blocksize/percentage,
448 optionally adding as many definitions as needed separated by a colon.
449 Example: bssplit=4k/10:64k/50:32k/40 would issue 50% 64k blocks, 10% 4k
450 blocks and 40% 32k blocks. \fBbssplit\fR also supports giving separate
451 splits to reads and writes. The format is identical to what the
452 \fBbs\fR option accepts, the read and write parts are separated with a
453 comma.
454 .TP
455 .B blocksize_unaligned\fR,\fP bs_unaligned
456 If set, any size in \fBblocksize_range\fR may be used.  This typically won't
457 work with direct I/O, as that normally requires sector alignment.
458 .TP
459 .BI blockalign \fR=\fPint[,int] "\fR,\fB ba" \fR=\fPint[,int]
460 At what boundary to align random IO offsets. Defaults to the same as 'blocksize'
461 the minimum blocksize given.  Minimum alignment is typically 512b
462 for using direct IO, though it usually depends on the hardware block size.
463 This option is mutually exclusive with using a random map for files, so it
464 will turn off that option.
465 .TP
466 .BI bs_is_seq_rand \fR=\fPbool
467 If this option is set, fio will use the normal read,write blocksize settings as
468 sequential,random instead. Any random read or write will use the WRITE
469 blocksize settings, and any sequential read or write will use the READ
470 blocksize setting.
471 .TP
472 .B zero_buffers
473 Initialize buffers with all zeros. Default: fill buffers with random data.
474 .TP
475 .B refill_buffers
476 If this option is given, fio will refill the IO buffers on every submit. The
477 default is to only fill it at init time and reuse that data. Only makes sense
478 if zero_buffers isn't specified, naturally. If data verification is enabled,
479 refill_buffers is also automatically enabled.
480 .TP
481 .BI scramble_buffers \fR=\fPbool
482 If \fBrefill_buffers\fR is too costly and the target is using data
483 deduplication, then setting this option will slightly modify the IO buffer
484 contents to defeat normal de-dupe attempts. This is not enough to defeat
485 more clever block compression attempts, but it will stop naive dedupe
486 of blocks. Default: true.
487 .TP
488 .BI buffer_compress_percentage \fR=\fPint
489 If this is set, then fio will attempt to provide IO buffer content (on WRITEs)
490 that compress to the specified level. Fio does this by providing a mix of
491 random data and a fixed pattern. The fixed pattern is either zeroes, or the
492 pattern specified by \fBbuffer_pattern\fR. If the pattern option is used, it
493 might skew the compression ratio slightly. Note that this is per block size
494 unit, for file/disk wide compression level that matches this setting. Note
495 that this is per block size unit, for file/disk wide compression level that
496 matches this setting, you'll also want to set refill_buffers.
497 .TP
498 .BI buffer_compress_chunk \fR=\fPint
499 See \fBbuffer_compress_percentage\fR. This setting allows fio to manage how
500 big the ranges of random data and zeroed data is. Without this set, fio will
501 provide \fBbuffer_compress_percentage\fR of blocksize random data, followed by
502 the remaining zeroed. With this set to some chunk size smaller than the block
503 size, fio can alternate random and zeroed data throughout the IO buffer.
504 .TP
505 .BI buffer_pattern \fR=\fPstr
506 If set, fio will fill the IO buffers with this pattern. If not set, the contents
507 of IO buffers is defined by the other options related to buffer contents. The
508 setting can be any pattern of bytes, and can be prefixed with 0x for hex
509 values. It may also be a string, where the string must then be wrapped with
510 "", e.g.:
511 .RS
512 .RS
513 \fBbuffer_pattern\fR="abcd"
514 .RS
515 or
516 .RE
517 \fBbuffer_pattern\fR=-12
518 .RS
519 or
520 .RE
521 \fBbuffer_pattern\fR=0xdeadface
522 .RE
523 .LP
524 Also you can combine everything together in any order:
525 .LP
526 .RS
527 \fBbuffer_pattern\fR=0xdeadface"abcd"-12
528 .RE
529 .RE
530 .TP
531 .BI dedupe_percentage \fR=\fPint
532 If set, fio will generate this percentage of identical buffers when writing.
533 These buffers will be naturally dedupable. The contents of the buffers depend
534 on what other buffer compression settings have been set. It's possible to have
535 the individual buffers either fully compressible, or not at all. This option
536 only controls the distribution of unique buffers.
537 .TP
538 .BI nrfiles \fR=\fPint
539 Number of files to use for this job.  Default: 1.
540 .TP
541 .BI openfiles \fR=\fPint
542 Number of files to keep open at the same time.  Default: \fBnrfiles\fR.
543 .TP
544 .BI file_service_type \fR=\fPstr
545 Defines how files to service are selected.  The following types are defined:
546 .RS
547 .RS
548 .TP
549 .B random
550 Choose a file at random.
551 .TP
552 .B roundrobin
553 Round robin over opened files (default).
554 .TP
555 .B sequential
556 Do each file in the set sequentially.
557 .RE
558 .P
559 The number of I/Os to issue before switching to a new file can be specified by
560 appending `:\fIint\fR' to the service type.
561 .RE
562 .TP
563 .BI ioengine \fR=\fPstr
564 Defines how the job issues I/O.  The following types are defined:
565 .RS
566 .RS
567 .TP
568 .B sync
569 Basic \fBread\fR\|(2) or \fBwrite\fR\|(2) I/O.  \fBfseek\fR\|(2) is used to
570 position the I/O location.
571 .TP
572 .B psync
573 Basic \fBpread\fR\|(2) or \fBpwrite\fR\|(2) I/O.
574 .TP
575 .B vsync
576 Basic \fBreadv\fR\|(2) or \fBwritev\fR\|(2) I/O. Will emulate queuing by
577 coalescing adjacent IOs into a single submission.
578 .TP
579 .B pvsync
580 Basic \fBpreadv\fR\|(2) or \fBpwritev\fR\|(2) I/O.
581 .TP
582 .B libaio
583 Linux native asynchronous I/O. This ioengine defines engine specific options.
584 .TP
585 .B posixaio
586 POSIX asynchronous I/O using \fBaio_read\fR\|(3) and \fBaio_write\fR\|(3).
587 .TP
588 .B solarisaio
589 Solaris native asynchronous I/O.
590 .TP
591 .B windowsaio
592 Windows native asynchronous I/O.
593 .TP
594 .B mmap
595 File is memory mapped with \fBmmap\fR\|(2) and data copied using
596 \fBmemcpy\fR\|(3).
597 .TP
598 .B splice
599 \fBsplice\fR\|(2) is used to transfer the data and \fBvmsplice\fR\|(2) to
600 transfer data from user-space to the kernel.
601 .TP
602 .B syslet-rw
603 Use the syslet system calls to make regular read/write asynchronous.
604 .TP
605 .B sg
606 SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if
607 the target is an sg character device, we use \fBread\fR\|(2) and
608 \fBwrite\fR\|(2) for asynchronous I/O.
609 .TP
610 .B null
611 Doesn't transfer any data, just pretends to.  Mainly used to exercise \fBfio\fR
612 itself and for debugging and testing purposes.
613 .TP
614 .B net
615 Transfer over the network.  The protocol to be used can be defined with the
616 \fBprotocol\fR parameter.  Depending on the protocol, \fBfilename\fR,
617 \fBhostname\fR, \fBport\fR, or \fBlisten\fR must be specified.
618 This ioengine defines engine specific options.
619 .TP
620 .B netsplice
621 Like \fBnet\fR, but uses \fBsplice\fR\|(2) and \fBvmsplice\fR\|(2) to map data
622 and send/receive. This ioengine defines engine specific options.
623 .TP
624 .B cpuio
625 Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and
626 \fBcpucycles\fR parameters.
627 .TP
628 .B guasi
629 The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface
630 approach to asynchronous I/O.
631 .br
632 See <\-lib.html>.
633 .TP
634 .B rdma
635 The RDMA I/O engine supports both RDMA memory semantics (RDMA_WRITE/RDMA_READ)
636 and channel semantics (Send/Recv) for the InfiniBand, RoCE and iWARP protocols.
637 .TP
638 .B external
639 Loads an external I/O engine object file.  Append the engine filename as
640 `:\fIenginepath\fR'.
641 .TP
642 .B falloc
643    IO engine that does regular linux native fallocate call to simulate data
644 transfer as fio ioengine
645 .br
646   DDIR_READ  does fallocate(,mode = FALLOC_FL_KEEP_SIZE,)
647 .br
648   DIR_WRITE does fallocate(,mode = 0)
649 .br
651 .TP
652 .B e4defrag
653 IO engine that does regular EXT4_IOC_MOVE_EXT ioctls to simulate defragment activity
654 request to DDIR_WRITE event
655 .TP
656 .B rbd
657 IO engine supporting direct access to Ceph Rados Block Devices (RBD) via librbd 
658 without the need to use the kernel rbd driver. This ioengine defines engine specific 
659 options.
660 .TP
661 .B gfapi
662 Using Glusterfs libgfapi sync interface to direct access to Glusterfs volumes without
663 having to go through FUSE. This ioengine defines engine specific
664 options.
665 .TP
666 .B gfapi_async
667 Using Glusterfs libgfapi async interface to direct access to Glusterfs volumes without
668 having to go through FUSE. This ioengine defines engine specific
669 options.
670 .TP
671 .B libhdfs
672 Read and write through Hadoop (HDFS).  The \fBfilename\fR option is used to
673 specify host,port of the hdfs name-node to connect. This engine interprets
674 offsets a little differently. In HDFS, files once created cannot be modified.
675 So random writes are not possible. To imitate this, libhdfs engine expects
676 bunch of small files to be created over HDFS, and engine will randomly pick a
677 file out of those files based on the offset generated by fio backend. (see the
678 example job file to create such files, use rw=write option). Please note, you
679 might want to set necessary environment variables to work with hdfs/libhdfs
680 properly.
681 .TP
682 .B mtd
683 Read, write and erase an MTD character device (e.g., /dev/mtd0). Discards are
684 treated as erases. Depending on the underlying device type, the I/O may have
685 to go in a certain pattern, e.g., on NAND, writing sequentially to erase blocks
686 and discarding before overwriting. The writetrim mode works well for this
687 constraint.
688 .RE
689 .P
690 .RE
691 .TP
692 .BI iodepth \fR=\fPint
693 Number of I/O units to keep in flight against the file. Note that increasing
694 iodepth beyond 1 will not affect synchronous ioengines (except for small
695 degress when verify_async is in use). Even async engines may impose OS
696 restrictions causing the desired depth not to be achieved.  This may happen on
697 Linux when using libaio and not setting \fBdirect\fR=1, since buffered IO is
698 not async on that OS. Keep an eye on the IO depth distribution in the
699 fio output to verify that the achieved depth is as expected. Default: 1.
700 .TP
701 .BI iodepth_batch \fR=\fPint "\fR,\fP iodepth_batch_submit" \fR=\fPint
702 This defines how many pieces of IO to submit at once. It defaults to 1
703 which means that we submit each IO as soon as it is available, but can
704 be raised to submit bigger batches of IO at the time. If it is set to 0
705 the \fBiodepth\fR value will be used.
706 .TP
707 .BI iodepth_batch_complete \fR=\fPint
708 This defines how many pieces of IO to retrieve at once. It defaults to 1 which
709  means that we'll ask for a minimum of 1 IO in the retrieval process from the
710 kernel. The IO retrieval will go on until we hit the limit set by
711 \fBiodepth_low\fR. If this variable is set to 0, then fio will always check for
712 completed events before queuing more IO. This helps reduce IO latency, at the
713 cost of more retrieval system calls.
714 .TP
715 .BI iodepth_low \fR=\fPint
716 Low watermark indicating when to start filling the queue again.  Default:
717 \fBiodepth\fR. 
718 .TP
719 .BI io_submit_mode \fR=\fPstr
720 This option controls how fio submits the IO to the IO engine. The default is
721 \fBinline\fR, which means that the fio job threads submit and reap IO directly.
722 If set to \fBoffload\fR, the job threads will offload IO submission to a
723 dedicated pool of IO threads. This requires some coordination and thus has a
724 bit of extra overhead, especially for lower queue depth IO where it can
725 increase latencies. The benefit is that fio can manage submission rates
726 independently of the device completion rates. This avoids skewed latency
727 reporting if IO gets back up on the device side (the coordinated omission
728 problem).
729 .TP
730 .BI direct \fR=\fPbool
731 If true, use non-buffered I/O (usually O_DIRECT).  Default: false.
732 .TP
733 .BI atomic \fR=\fPbool
734 If value is true, attempt to use atomic direct IO. Atomic writes are guaranteed
735 to be stable once acknowledged by the operating system. Only Linux supports
736 O_ATOMIC right now.
737 .TP
738 .BI buffered \fR=\fPbool
739 If true, use buffered I/O.  This is the opposite of the \fBdirect\fR parameter.
740 Default: true.
741 .TP
742 .BI offset \fR=\fPint
743 Offset in the file to start I/O. Data before the offset will not be touched.
744 .TP
745 .BI offset_increment \fR=\fPint
746 If this is provided, then the real offset becomes the
747 offset + offset_increment * thread_number, where the thread number is a
748 counter that starts at 0 and is incremented for each sub-job (i.e. when
749 numjobs option is specified). This option is useful if there are several jobs
750 which are intended to operate on a file in parallel disjoint segments, with
751 even spacing between the starting points.
752 .TP
753 .BI number_ios \fR=\fPint
754 Fio will normally perform IOs until it has exhausted the size of the region
755 set by \fBsize\fR, or if it exhaust the allocated time (or hits an error
756 condition). With this setting, the range/size can be set independently of
757 the number of IOs to perform. When fio reaches this number, it will exit
758 normally and report status. Note that this does not extend the amount
759 of IO that will be done, it will only stop fio if this condition is met
760 before other end-of-job criteria.
761 .TP
762 .BI fsync \fR=\fPint
763 How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data.  If
764 0, don't sync.  Default: 0.
765 .TP
766 .BI fdatasync \fR=\fPint
767 Like \fBfsync\fR, but uses \fBfdatasync\fR\|(2) instead to only sync the
768 data parts of the file. Default: 0.
769 .TP
770 .BI write_barrier \fR=\fPint
771 Make every Nth write a barrier write.
772 .TP
773 .BI sync_file_range \fR=\fPstr:int
774 Use \fBsync_file_range\fR\|(2) for every \fRval\fP number of write operations. Fio will
775 track range of writes that have happened since the last \fBsync_file_range\fR\|(2) call.
776 \fRstr\fP can currently be one or more of:
777 .RS
778 .TP
779 .B wait_before
781 .TP
782 .B write
784 .TP
785 .B wait_after
787 .TP
788 .RE
789 .P
790 So if you do sync_file_range=wait_before,write:8, fio would use
792 Also see the \fBsync_file_range\fR\|(2) man page.  This option is Linux specific.
793 .TP
794 .BI overwrite \fR=\fPbool
795 If writing, setup the file first and do overwrites.  Default: false.
796 .TP
797 .BI end_fsync \fR=\fPbool
798 Sync file contents when a write stage has completed.  Default: false.
799 .TP
800 .BI fsync_on_close \fR=\fPbool
801 If true, sync file contents on close.  This differs from \fBend_fsync\fR in that
802 it will happen on every close, not just at the end of the job.  Default: false.
803 .TP
804 .BI rwmixread \fR=\fPint
805 Percentage of a mixed workload that should be reads. Default: 50.
806 .TP
807 .BI rwmixwrite \fR=\fPint
808 Percentage of a mixed workload that should be writes.  If \fBrwmixread\fR and
809 \fBrwmixwrite\fR are given and do not sum to 100%, the latter of the two
810 overrides the first. This may interfere with a given rate setting, if fio is
811 asked to limit reads or writes to a certain rate. If that is the case, then
812 the distribution may be skewed. Default: 50.
813 .TP
814 .BI random_distribution \fR=\fPstr:float
815 By default, fio will use a completely uniform random distribution when asked
816 to perform random IO. Sometimes it is useful to skew the distribution in
817 specific ways, ensuring that some parts of the data is more hot than others.
818 Fio includes the following distribution models:
819 .RS
820 .TP
821 .B random
822 Uniform random distribution
823 .TP
824 .B zipf
825 Zipf distribution
826 .TP
827 .B pareto
828 Pareto distribution
829 .TP
830 .RE
831 .P
832 When using a zipf or pareto distribution, an input value is also needed to
833 define the access pattern. For zipf, this is the zipf theta. For pareto,
834 it's the pareto power. Fio includes a test program, genzipf, that can be
835 used visualize what the given input values will yield in terms of hit rates.
836 If you wanted to use zipf with a theta of 1.2, you would use
837 random_distribution=zipf:1.2 as the option. If a non-uniform model is used,
838 fio will disable use of the random map.
839 .TP
840 .BI percentage_random \fR=\fPint
841 For a random workload, set how big a percentage should be random. This defaults
842 to 100%, in which case the workload is fully random. It can be set from
843 anywhere from 0 to 100.  Setting it to 0 would make the workload fully
844 sequential. It is possible to set different values for reads, writes, and
845 trim. To do so, simply use a comma separated list. See \fBblocksize\fR.
846 .TP
847 .B norandommap
848 Normally \fBfio\fR will cover every block of the file when doing random I/O. If
849 this parameter is given, a new offset will be chosen without looking at past
850 I/O history.  This parameter is mutually exclusive with \fBverify\fR.
851 .TP
852 .BI softrandommap \fR=\fPbool
853 See \fBnorandommap\fR. If fio runs with the random block map enabled and it
854 fails to allocate the map, if this option is set it will continue without a
855 random block map. As coverage will not be as complete as with random maps, this
856 option is disabled by default.
857 .TP
858 .BI random_generator \fR=\fPstr
859 Fio supports the following engines for generating IO offsets for random IO:
860 .RS
861 .TP
862 .B tausworthe
863 Strong 2^88 cycle random number generator
864 .TP
865 .B lfsr
866 Linear feedback shift register generator
867 .TP
868 .B tausworthe64
869 Strong 64-bit 2^258 cycle random number generator
870 .TP
871 .RE
872 .P
873 Tausworthe is a strong random number generator, but it requires tracking on the
874 side if we want to ensure that blocks are only read or written once. LFSR
875 guarantees that we never generate the same offset twice, and it's also less
876 computationally expensive. It's not a true random generator, however, though
877 for IO purposes it's typically good enough. LFSR only works with single block
878 sizes, not with workloads that use multiple block sizes. If used with such a
879 workload, fio may read or write some blocks multiple times.
880 .TP
881 .BI nice \fR=\fPint
882 Run job with given nice value.  See \fBnice\fR\|(2).
883 .TP
884 .BI prio \fR=\fPint
885 Set I/O priority value of this job between 0 (highest) and 7 (lowest).  See
886 \fBionice\fR\|(1).
887 .TP
888 .BI prioclass \fR=\fPint
889 Set I/O priority class.  See \fBionice\fR\|(1).
890 .TP
891 .BI thinktime \fR=\fPint
892 Stall job for given number of microseconds between issuing I/Os.
893 .TP
894 .BI thinktime_spin \fR=\fPint
895 Pretend to spend CPU time for given number of microseconds, sleeping the rest
896 of the time specified by \fBthinktime\fR.  Only valid if \fBthinktime\fR is set.
897 .TP
898 .BI thinktime_blocks \fR=\fPint
899 Only valid if thinktime is set - control how many blocks to issue, before
900 waiting \fBthinktime\fR microseconds. If not set, defaults to 1 which will
901 make fio wait \fBthinktime\fR microseconds after every block. This
902 effectively makes any queue depth setting redundant, since no more than 1 IO
903 will be queued before we have to complete it and do our thinktime. In other
904 words, this setting effectively caps the queue depth if the latter is larger.
905 Default: 1.
906 .TP
907 .BI rate \fR=\fPint
908 Cap bandwidth used by this job. The number is in bytes/sec, the normal postfix
909 rules apply. You can use \fBrate\fR=500k to limit reads and writes to 500k each,
910 or you can specify read and writes separately. Using \fBrate\fR=1m,500k would
911 limit reads to 1MB/sec and writes to 500KB/sec. Capping only reads or writes
912 can be done with \fBrate\fR=,500k or \fBrate\fR=500k,. The former will only
913 limit writes (to 500KB/sec), the latter will only limit reads.
914 .TP
915 .BI ratemin \fR=\fPint
916 Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth.
917 Failing to meet this requirement will cause the job to exit. The same format
918 as \fBrate\fR is used for read vs write separation.
919 .TP
920 .BI rate_iops \fR=\fPint
921 Cap the bandwidth to this number of IOPS. Basically the same as rate, just
922 specified independently of bandwidth. The same format as \fBrate\fR is used for
923 read vs write separation. If \fBblocksize\fR is a range, the smallest block
924 size is used as the metric.
925 .TP
926 .BI rate_iops_min \fR=\fPint
927 If this rate of I/O is not met, the job will exit. The same format as \fBrate\fR
928 is used for read vs write separation.
929 .TP
930 .BI ratecycle \fR=\fPint
931 Average bandwidth for \fBrate\fR and \fBratemin\fR over this number of
932 milliseconds.  Default: 1000ms.
933 .TP
934 .BI latency_target \fR=\fPint
935 If set, fio will attempt to find the max performance point that the given
936 workload will run at while maintaining a latency below this target. The
937 values is given in microseconds. See \fBlatency_window\fR and
938 \fBlatency_percentile\fR.
939 .TP
940 .BI latency_window \fR=\fPint
941 Used with \fBlatency_target\fR to specify the sample window that the job
942 is run at varying queue depths to test the performance. The value is given
943 in microseconds.
944 .TP
945 .BI latency_percentile \fR=\fPfloat
946 The percentage of IOs that must fall within the criteria specified by
947 \fBlatency_target\fR and \fBlatency_window\fR. If not set, this defaults
948 to 100.0, meaning that all IOs must be equal or below to the value set
949 by \fBlatency_target\fR.
950 .TP
951 .BI max_latency \fR=\fPint
952 If set, fio will exit the job if it exceeds this maximum latency. It will exit
953 with an ETIME error.
954 .TP
955 .BI cpumask \fR=\fPint
956 Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job
957 may run on.  See \fBsched_setaffinity\fR\|(2).
958 .TP
959 .BI cpus_allowed \fR=\fPstr
960 Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers.
961 .TP
962 .BI cpus_allowed_policy \fR=\fPstr
963 Set the policy of how fio distributes the CPUs specified by \fBcpus_allowed\fR
964 or \fBcpumask\fR. Two policies are supported:
965 .RS
966 .RS
967 .TP
968 .B shared
969 All jobs will share the CPU set specified.
970 .TP
971 .B split
972 Each job will get a unique CPU from the CPU set.
973 .RE
974 .P
975 \fBshared\fR is the default behaviour, if the option isn't specified. If
976 \fBsplit\fR is specified, then fio will assign one cpu per job. If not enough
977 CPUs are given for the jobs listed, then fio will roundrobin the CPUs in
978 the set.
979 .RE
980 .P
981 .TP
982 .BI numa_cpu_nodes \fR=\fPstr
983 Set this job running on specified NUMA nodes' CPUs. The arguments allow
984 comma delimited list of cpu numbers, A-B ranges, or 'all'.
985 .TP
986 .BI numa_mem_policy \fR=\fPstr
987 Set this job's memory policy and corresponding NUMA nodes. Format of
988 the arguments:
989 .RS
990 .TP
991 .B <mode>[:<nodelist>]
992 .TP
993 .B mode
994 is one of the following memory policy:
995 .TP
996 .B default, prefer, bind, interleave, local
997 .TP
998 .RE
999 For \fBdefault\fR and \fBlocal\fR memory policy, no \fBnodelist\fR is
1000 needed to be specified. For \fBprefer\fR, only one node is
1001 allowed. For \fBbind\fR and \fBinterleave\fR, \fBnodelist\fR allows
1002 comma delimited list of numbers, A-B ranges, or 'all'.
1003 .TP
1004 .BI startdelay \fR=\fPirange
1005 Delay start of job for the specified number of seconds. Supports all time
1006 suffixes to allow specification of hours, minutes, seconds and
1007 milliseconds - seconds are the default if a unit is omitted.
1008 Can be given as a range which causes each thread to choose randomly out of the
1009 range.
1010 .TP
1011 .BI runtime \fR=\fPint
1012 Terminate processing after the specified number of seconds.
1013 .TP
1014 .B time_based
1015 If given, run for the specified \fBruntime\fR duration even if the files are
1016 completely read or written. The same workload will be repeated as many times
1017 as \fBruntime\fR allows.
1018 .TP
1019 .BI ramp_time \fR=\fPint
1020 If set, fio will run the specified workload for this amount of time before
1021 logging any performance numbers. Useful for letting performance settle before
1022 logging results, thus minimizing the runtime required for stable results. Note
1023 that the \fBramp_time\fR is considered lead in time for a job, thus it will
1024 increase the total runtime if a special timeout or runtime is specified.
1025 .TP
1026 .BI invalidate \fR=\fPbool
1027 Invalidate buffer-cache for the file prior to starting I/O.  Default: true.
1028 .TP
1029 .BI sync \fR=\fPbool
1030 Use synchronous I/O for buffered writes.  For the majority of I/O engines,
1031 this means using O_SYNC.  Default: false.
1032 .TP
1033 .BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
1034 Allocation method for I/O unit buffer.  Allowed values are:
1035 .RS
1036 .RS
1037 .TP
1038 .B malloc
1039 Allocate memory with \fBmalloc\fR\|(3).
1040 .TP
1041 .B shm
1042 Use shared memory buffers allocated through \fBshmget\fR\|(2).
1043 .TP
1044 .B shmhuge
1045 Same as \fBshm\fR, but use huge pages as backing.
1046 .TP
1047 .B mmap
1048 Use \fBmmap\fR\|(2) for allocation.  Uses anonymous memory unless a filename
1049 is given after the option in the format `:\fIfile\fR'.
1050 .TP
1051 .B mmaphuge
1052 Same as \fBmmap\fR, but use huge files as backing.
1053 .RE
1054 .P
1055 The amount of memory allocated is the maximum allowed \fBblocksize\fR for the
1056 job multiplied by \fBiodepth\fR.  For \fBshmhuge\fR or \fBmmaphuge\fR to work,
1057 the system must have free huge pages allocated.  \fBmmaphuge\fR also needs to
1058 have hugetlbfs mounted, and \fIfile\fR must point there. At least on Linux,
1059 huge pages must be manually allocated. See \fB/proc/sys/vm/nr_hugehages\fR
1060 and the documentation for that. Normally you just need to echo an appropriate
1061 number, eg echoing 8 will ensure that the OS has 8 huge pages ready for
1062 use.
1063 .RE
1064 .TP
1065 .BI iomem_align \fR=\fPint "\fR,\fP mem_align" \fR=\fPint
1066 This indicates the memory alignment of the IO memory buffers. Note that the
1067 given alignment is applied to the first IO unit buffer, if using \fBiodepth\fR
1068 the alignment of the following buffers are given by the \fBbs\fR used. In
1069 other words, if using a \fBbs\fR that is a multiple of the page sized in the
1070 system, all buffers will be aligned to this value. If using a \fBbs\fR that
1071 is not page aligned, the alignment of subsequent IO memory buffers is the
1072 sum of the \fBiomem_align\fR and \fBbs\fR used.
1073 .TP
1074 .BI hugepage\-size \fR=\fPint
1075 Defines the size of a huge page.  Must be at least equal to the system setting.
1076 Should be a multiple of 1MB. Default: 4MB.
1077 .TP
1078 .B exitall
1079 Terminate all jobs when one finishes.  Default: wait for each job to finish.
1080 .TP
1081 .BI bwavgtime \fR=\fPint
1082 Average bandwidth calculations over the given time in milliseconds.  Default:
1083 500ms.
1084 .TP
1085 .BI iopsavgtime \fR=\fPint
1086 Average IOPS calculations over the given time in milliseconds.  Default:
1087 500ms.
1088 .TP
1089 .BI create_serialize \fR=\fPbool
1090 If true, serialize file creation for the jobs.  Default: true.
1091 .TP
1092 .BI create_fsync \fR=\fPbool
1093 \fBfsync\fR\|(2) data file after creation.  Default: true.
1094 .TP
1095 .BI create_on_open \fR=\fPbool
1096 If true, the files are not created until they are opened for IO by the job.
1097 .TP
1098 .BI create_only \fR=\fPbool
1099 If true, fio will only run the setup phase of the job. If files need to be
1100 laid out or updated on disk, only that will be done. The actual job contents
1101 are not executed.
1102 .TP
1103 .BI allow_file_create \fR=\fPbool
1104 If true, fio is permitted to create files as part of its workload. This is
1105 the default behavior. If this option is false, then fio will error out if the
1106 files it needs to use don't already exist. Default: true.
1107 .TP
1108 .BI allow_mounted_write \fR=\fPbool
1109 If this isn't set, fio will abort jobs that are destructive (eg that write)
1110 to what appears to be a mounted device or partition. This should help catch
1111 creating inadvertently destructive tests, not realizing that the test will
1112 destroy data on the mounted file system. Default: false.
1113 .TP
1114 .BI pre_read \fR=\fPbool
1115 If this is given, files will be pre-read into memory before starting the given
1116 IO operation. This will also clear the \fR \fBinvalidate\fR flag, since it is
1117 pointless to pre-read and then drop the cache. This will only work for IO
1118 engines that are seekable, since they allow you to read the same data
1119 multiple times. Thus it will not work on eg network or splice IO.
1120 .TP
1121 .BI unlink \fR=\fPbool
1122 Unlink job files when done.  Default: false.
1123 .TP
1124 .BI loops \fR=\fPint
1125 Specifies the number of iterations (runs of the same workload) of this job.
1126 Default: 1.
1127 .TP
1128 .BI verify_only \fR=\fPbool
1129 Do not perform the specified workload, only verify data still matches previous
1130 invocation of this workload. This option allows one to check data multiple
1131 times at a later date without overwriting it. This option makes sense only for
1132 workloads that write data, and does not support workloads with the
1133 \fBtime_based\fR option set.
1134 .TP
1135 .BI do_verify \fR=\fPbool
1136 Run the verify phase after a write phase.  Only valid if \fBverify\fR is set.
1137 Default: true.
1138 .TP
1139 .BI verify \fR=\fPstr
1140 Method of verifying file contents after each iteration of the job. Each
1141 verification method also implies verification of special header, which is
1142 written to the beginning of each block. This header also includes meta
1143 information, like offset of the block, block number, timestamp when block
1144 was written, etc.  \fBverify\fR=str can be combined with \fBverify_pattern\fR=str
1145 option.  The allowed values are:
1146 .RS
1147 .RS
1148 .TP
1149 .B md5 crc16 crc32 crc32c crc32c-intel crc64 crc7 sha256 sha512 sha1 xxhash
1150 Store appropriate checksum in the header of each block. crc32c-intel is
1151 hardware accelerated SSE4.2 driven, falls back to regular crc32c if
1152 not supported by the system.
1153 .TP
1154 .B meta
1155 This option is deprecated, since now meta information is included in generic
1156 verification header and meta verification happens by default.  For detailed
1157 information see the description of the \fBverify\fR=str setting. This option
1158 is kept because of compatibility's sake with old configurations. Do not use it.
1159 .TP
1160 .B pattern
1161 Verify a strict pattern. Normally fio includes a header with some basic
1162 information and checksumming, but if this option is set, only the
1163 specific pattern set with \fBverify_pattern\fR is verified.
1164 .TP
1165 .B null
1166 Pretend to verify.  Used for testing internals.
1167 .RE
1169 This option can be used for repeated burn-in tests of a system to make sure
1170 that the written data is also correctly read back. If the data direction given
1171 is a read or random read, fio will assume that it should verify a previously
1172 written file. If the data direction includes any form of write, the verify will
1173 be of the newly written data.
1174 .RE
1175 .TP
1176 .BI verifysort \fR=\fPbool
1177 If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to
1178 read them back in a sorted manner.  Default: true.
1179 .TP
1180 .BI verifysort_nr \fR=\fPint
1181 Pre-load and sort verify blocks for a read workload.
1182 .TP
1183 .BI verify_offset \fR=\fPint
1184 Swap the verification header with data somewhere else in the block before
1185 writing.  It is swapped back before verifying.
1186 .TP
1187 .BI verify_interval \fR=\fPint
1188 Write the verification header for this number of bytes, which should divide
1189 \fBblocksize\fR.  Default: \fBblocksize\fR.
1190 .TP
1191 .BI verify_pattern \fR=\fPstr
1192 If set, fio will fill the io buffers with this pattern. Fio defaults to filling
1193 with totally random bytes, but sometimes it's interesting to fill with a known
1194 pattern for io verification purposes. Depending on the width of the pattern,
1195 fio will fill 1/2/3/4 bytes of the buffer at the time(it can be either a
1196 decimal or a hex number). The verify_pattern if larger than a 32-bit quantity
1197 has to be a hex number that starts with either "0x" or "0X". Use with
1198 \fBverify\fP=str. Also, verify_pattern supports %o format, which means that for
1199 each block offset will be written and then verifyied back, e.g.:
1200 .RS
1201 .RS
1202 \fBverify_pattern\fR=%o
1203 .RE
1204 Or use combination of everything:
1205 .LP
1206 .RS
1207 \fBverify_pattern\fR=0xff%o"abcd"-21
1208 .RE
1209 .RE
1210 .TP
1211 .BI verify_fatal \fR=\fPbool
1212 If true, exit the job on the first observed verification failure.  Default:
1213 false.
1214 .TP
1215 .BI verify_dump \fR=\fPbool
1216 If set, dump the contents of both the original data block and the data block we
1217 read off disk to files. This allows later analysis to inspect just what kind of
1218 data corruption occurred. Off by default.
1219 .TP
1220 .BI verify_async \fR=\fPint
1221 Fio will normally verify IO inline from the submitting thread. This option
1222 takes an integer describing how many async offload threads to create for IO
1223 verification instead, causing fio to offload the duty of verifying IO contents
1224 to one or more separate threads.  If using this offload option, even sync IO
1225 engines can benefit from using an \fBiodepth\fR setting higher than 1, as it
1226 allows them to have IO in flight while verifies are running.
1227 .TP
1228 .BI verify_async_cpus \fR=\fPstr
1229 Tell fio to set the given CPU affinity on the async IO verification threads.
1230 See \fBcpus_allowed\fP for the format used.
1231 .TP
1232 .BI verify_backlog \fR=\fPint
1233 Fio will normally verify the written contents of a job that utilizes verify
1234 once that job has completed. In other words, everything is written then
1235 everything is read back and verified. You may want to verify continually
1236 instead for a variety of reasons. Fio stores the meta data associated with an
1237 IO block in memory, so for large verify workloads, quite a bit of memory would
1238 be used up holding this meta data. If this option is enabled, fio will write
1239 only N blocks before verifying these blocks.
1240 .TP
1241 .BI verify_backlog_batch \fR=\fPint
1242 Control how many blocks fio will verify if verify_backlog is set. If not set,
1243 will default to the value of \fBverify_backlog\fR (meaning the entire queue is
1244 read back and verified).  If \fBverify_backlog_batch\fR is less than 
1245 \fBverify_backlog\fR then not all blocks will be verified,  if 
1246 \fBverify_backlog_batch\fR is larger than \fBverify_backlog\fR,  some blocks
1247 will be verified more than once.
1248 .TP
1249 .BI trim_percentage \fR=\fPint
1250 Number of verify blocks to discard/trim.
1251 .TP
1252 .BI trim_verify_zero \fR=\fPbool
1253 Verify that trim/discarded blocks are returned as zeroes.
1254 .TP
1255 .BI trim_backlog \fR=\fPint
1256 Trim after this number of blocks are written.
1257 .TP
1258 .BI trim_backlog_batch \fR=\fPint
1259 Trim this number of IO blocks.
1260 .TP
1261 .BI experimental_verify \fR=\fPbool
1262 Enable experimental verification.
1263 .TP
1264 .BI verify_state_save \fR=\fPbool
1265 When a job exits during the write phase of a verify workload, save its
1266 current state. This allows fio to replay up until that point, if the
1267 verify state is loaded for the verify read phase.
1268 .TP
1269 .BI verify_state_load \fR=\fPbool
1270 If a verify termination trigger was used, fio stores the current write
1271 state of each thread. This can be used at verification time so that fio
1272 knows how far it should verify. Without this information, fio will run
1273 a full verification pass, according to the settings in the job file used.
1274 .TP
1275 .B stonewall "\fR,\fP wait_for_previous"
1276 Wait for preceding jobs in the job file to exit before starting this one.
1277 \fBstonewall\fR implies \fBnew_group\fR.
1278 .TP
1279 .B new_group
1280 Start a new reporting group.  If not given, all jobs in a file will be part
1281 of the same reporting group, unless separated by a stonewall.
1282 .TP
1283 .BI numjobs \fR=\fPint
1284 Number of clones (processes/threads performing the same workload) of this job.  
1285 Default: 1.
1286 .TP
1287 .B group_reporting
1288 If set, display per-group reports instead of per-job when \fBnumjobs\fR is
1289 specified.
1290 .TP
1291 .B thread
1292 Use threads created with \fBpthread_create\fR\|(3) instead of processes created
1293 with \fBfork\fR\|(2).
1294 .TP
1295 .BI zonesize \fR=\fPint
1296 Divide file into zones of the specified size in bytes.  See \fBzoneskip\fR.
1297 .TP
1298 .BI zonerange \fR=\fPint
1299 Give size of an IO zone.  See \fBzoneskip\fR.
1300 .TP
1301 .BI zoneskip \fR=\fPint
1302 Skip the specified number of bytes when \fBzonesize\fR bytes of data have been
1303 read.
1304 .TP
1305 .BI write_iolog \fR=\fPstr
1306 Write the issued I/O patterns to the specified file.  Specify a separate file
1307 for each job, otherwise the iologs will be interspersed and the file may be
1308 corrupt.
1309 .TP
1310 .BI read_iolog \fR=\fPstr
1311 Replay the I/O patterns contained in the specified file generated by
1312 \fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file.
1313 .TP
1314 .BI replay_no_stall \fR=\fPint
1315 While replaying I/O patterns using \fBread_iolog\fR the default behavior
1316 attempts to respect timing information between I/Os.  Enabling
1317 \fBreplay_no_stall\fR causes I/Os to be replayed as fast as possible while
1318 still respecting ordering.
1319 .TP
1320 .BI replay_redirect \fR=\fPstr
1321 While replaying I/O patterns using \fBread_iolog\fR the default behavior
1322 is to replay the IOPS onto the major/minor device that each IOP was recorded
1323 from.  Setting \fBreplay_redirect\fR causes all IOPS to be replayed onto the
1324 single specified device regardless of the device it was recorded from.
1325 .TP
1326 .BI replay_align \fR=\fPint
1327 Force alignment of IO offsets and lengths in a trace to this power of 2 value.
1328 .TP
1329 .BI replay_scale \fR=\fPint
1330 Scale sector offsets down by this factor when replaying traces.
1331 .TP
1332 .BI per_job_logs \fR=\fPbool
1333 If set, this generates bw/clat/iops log with per file private filenames. If
1334 not set, jobs with identical names will share the log filename. Default: true.
1335 .TP
1336 .BI write_bw_log \fR=\fPstr
1337 If given, write a bandwidth log of the jobs in this job file. Can be used to
1338 store data of the bandwidth of the jobs in their lifetime. The included
1339 fio_generate_plots script uses gnuplot to turn these text files into nice
1340 graphs. See \fBwrite_lat_log\fR for behaviour of given filename. For this
1341 option, the postfix is _bw.x.log, where x is the index of the job (1..N,
1342 where N is the number of jobs). If \fBper_job_logs\fR is false, then the
1343 filename will not include the job index.
1344 .TP
1345 .BI write_lat_log \fR=\fPstr
1346 Same as \fBwrite_bw_log\fR, but writes I/O completion latencies.  If no
1347 filename is given with this option, the default filename of
1348 "jobname_type.x.log" is used, where x is the index of the job (1..N, where
1349 N is the number of jobs). Even if the filename is given, fio will still
1350 append the type of log. If \fBper_job_logs\fR is false, then the filename will
1351 not include the job index.
1352 .TP
1353 .BI write_iops_log \fR=\fPstr
1354 Same as \fBwrite_bw_log\fR, but writes IOPS. If no filename is given with this
1355 option, the default filename of "jobname_type.x.log" is used, where x is the
1356 index of the job (1..N, where N is the number of jobs). Even if the filename
1357 is given, fio will still append the type of log. If \fBper_job_logs\fR is false,
1358 then the filename will not include the job index.
1359 .TP
1360 .BI log_avg_msec \fR=\fPint
1361 By default, fio will log an entry in the iops, latency, or bw log for every
1362 IO that completes. When writing to the disk log, that can quickly grow to a
1363 very large size. Setting this option makes fio average the each log entry
1364 over the specified period of time, reducing the resolution of the log.
1365 Defaults to 0.
1366 .TP
1367 .BI log_offset \fR=\fPbool
1368 If this is set, the iolog options will include the byte offset for the IO
1369 entry as well as the other data values.
1370 .TP
1371 .BI log_compression \fR=\fPint
1372 If this is set, fio will compress the IO logs as it goes, to keep the memory
1373 footprint lower. When a log reaches the specified size, that chunk is removed
1374 and compressed in the background. Given that IO logs are fairly highly
1375 compressible, this yields a nice memory savings for longer runs. The downside
1376 is that the compression will consume some background CPU cycles, so it may
1377 impact the run. This, however, is also true if the logging ends up consuming
1378 most of the system memory. So pick your poison. The IO logs are saved
1379 normally at the end of a run, by decompressing the chunks and storing them
1380 in the specified log file. This feature depends on the availability of zlib.
1381 .TP
1382 .BI log_store_compressed \fR=\fPbool
1383 If set, and \fBlog\fR_compression is also set, fio will store the log files in
1384 a compressed format. They can be decompressed with fio, using the
1385 \fB\-\-inflate-log\fR command line parameter. The files will be stored with a
1386 \fB\.fz\fR suffix.
1387 .TP
1388 .BI block_error_percentiles \fR=\fPbool
1389 If set, record errors in trim block-sized units from writes and trims and output
1390 a histogram of how many trims it took to get to errors, and what kind of error
1391 was encountered.
1392 .TP
1393 .BI disable_lat \fR=\fPbool
1394 Disable measurements of total latency numbers. Useful only for cutting
1395 back the number of calls to \fBgettimeofday\fR\|(2), as that does impact performance at
1396 really high IOPS rates.  Note that to really get rid of a large amount of these
1397 calls, this option must be used with disable_slat and disable_bw as well.
1398 .TP
1399 .BI disable_clat \fR=\fPbool
1400 Disable measurements of completion latency numbers. See \fBdisable_lat\fR.
1401 .TP
1402 .BI disable_slat \fR=\fPbool
1403 Disable measurements of submission latency numbers. See \fBdisable_lat\fR.
1404 .TP
1405 .BI disable_bw_measurement \fR=\fPbool
1406 Disable measurements of throughput/bandwidth numbers. See \fBdisable_lat\fR.
1407 .TP
1408 .BI lockmem \fR=\fPint
1409 Pin the specified amount of memory with \fBmlock\fR\|(2).  Can be used to
1410 simulate a smaller amount of memory. The amount specified is per worker.
1411 .TP
1412 .BI exec_prerun \fR=\fPstr
1413 Before running the job, execute the specified command with \fBsystem\fR\|(3).
1414 .RS
1415 Output is redirected in a file called \fBjobname.prerun.txt\fR
1416 .RE
1417 .TP
1418 .BI exec_postrun \fR=\fPstr
1419 Same as \fBexec_prerun\fR, but the command is executed after the job completes.
1420 .RS
1421 Output is redirected in a file called \fBjobname.postrun.txt\fR
1422 .RE
1423 .TP
1424 .BI ioscheduler \fR=\fPstr
1425 Attempt to switch the device hosting the file to the specified I/O scheduler.
1426 .TP
1427 .BI disk_util \fR=\fPbool
1428 Generate disk utilization statistics if the platform supports it. Default: true.
1429 .TP
1430 .BI clocksource \fR=\fPstr
1431 Use the given clocksource as the base of timing. The supported options are:
1432 .RS
1433 .TP
1434 .B gettimeofday
1435 \fBgettimeofday\fR\|(2)
1436 .TP
1437 .B clock_gettime
1438 \fBclock_gettime\fR\|(2)
1439 .TP
1440 .B cpu
1441 Internal CPU clock source
1442 .TP
1443 .RE
1444 .P
1445 \fBcpu\fR is the preferred clocksource if it is reliable, as it is very fast
1446 (and fio is heavy on time calls). Fio will automatically use this clocksource
1447 if it's supported and considered reliable on the system it is running on,
1448 unless another clocksource is specifically set. For x86/x86-64 CPUs, this
1449 means supporting TSC Invariant.
1450 .TP
1451 .BI gtod_reduce \fR=\fPbool
1452 Enable all of the \fBgettimeofday\fR\|(2) reducing options (disable_clat, disable_slat,
1453 disable_bw) plus reduce precision of the timeout somewhat to really shrink the
1454 \fBgettimeofday\fR\|(2) call count. With this option enabled, we only do about 0.4% of
1455 the gtod() calls we would have done if all time keeping was enabled.
1456 .TP
1457 .BI gtod_cpu \fR=\fPint
1458 Sometimes it's cheaper to dedicate a single thread of execution to just getting
1459 the current time. Fio (and databases, for instance) are very intensive on
1460 \fBgettimeofday\fR\|(2) calls. With this option, you can set one CPU aside for doing
1461 nothing but logging current time to a shared memory location. Then the other
1462 threads/processes that run IO workloads need only copy that segment, instead of
1463 entering the kernel with a \fBgettimeofday\fR\|(2) call. The CPU set aside for doing
1464 these time calls will be excluded from other uses. Fio will manually clear it
1465 from the CPU mask of other jobs.
1466 .TP
1467 .BI ignore_error \fR=\fPstr
1468 Sometimes you want to ignore some errors during test in that case you can specify
1469 error list for each error type.
1470 .br
1472 .br
1473 errors for given error type is separated with ':'.
1474 Error may be symbol ('ENOSPC', 'ENOMEM') or an integer.
1475 .br
1476 Example: ignore_error=EAGAIN,ENOSPC:122 .
1477 .br     
1478 This option will ignore EAGAIN from READ, and ENOSPC and 122(EDQUOT) from WRITE. 
1479 .TP
1480 .BI error_dump \fR=\fPbool
1481 If set dump every error even if it is non fatal, true by default. If disabled
1482 only fatal error will be dumped
1483 .TP
1484 .BI profile \fR=\fPstr
1485 Select a specific builtin performance test.
1486 .TP
1487 .BI cgroup \fR=\fPstr
1488 Add job to this control group. If it doesn't exist, it will be created.
1489 The system must have a mounted cgroup blkio mount point for this to work. If
1490 your system doesn't have it mounted, you can do so with:
1492 # mount \-t cgroup \-o blkio none /cgroup
1493 .TP
1494 .BI cgroup_weight \fR=\fPint
1495 Set the weight of the cgroup to this value. See the documentation that comes
1496 with the kernel, allowed values are in the range of 100..1000.
1497 .TP
1498 .BI cgroup_nodelete \fR=\fPbool
1499 Normally fio will delete the cgroups it has created after the job completion.
1500 To override this behavior and to leave cgroups around after the job completion,
1501 set cgroup_nodelete=1. This can be useful if one wants to inspect various
1502 cgroup files after job completion. Default: false
1503 .TP
1504 .BI uid \fR=\fPint
1505 Instead of running as the invoking user, set the user ID to this value before
1506 the thread/process does any work.
1507 .TP
1508 .BI gid \fR=\fPint
1509 Set group ID, see \fBuid\fR.
1510 .TP
1511 .BI unit_base \fR=\fPint
1512 Base unit for reporting.  Allowed values are:
1513 .RS
1514 .TP
1515 .B 0
1516 Use auto-detection (default).
1517 .TP
1518 .B 8
1519 Byte based.
1520 .TP
1521 .B 1
1522 Bit based.
1523 .RE
1524 .P
1525 .TP
1526 .BI flow_id \fR=\fPint
1527 The ID of the flow. If not specified, it defaults to being a global flow. See
1528 \fBflow\fR.
1529 .TP
1530 .BI flow \fR=\fPint
1531 Weight in token-based flow control. If this value is used, then there is a
1532 \fBflow counter\fR which is used to regulate the proportion of activity between
1533 two or more jobs. fio attempts to keep this flow counter near zero. The
1534 \fBflow\fR parameter stands for how much should be added or subtracted to the
1535 flow counter on each iteration of the main I/O loop. That is, if one job has
1536 \fBflow=8\fR and another job has \fBflow=-1\fR, then there will be a roughly
1537 1:8 ratio in how much one runs vs the other.
1538 .TP
1539 .BI flow_watermark \fR=\fPint
1540 The maximum value that the absolute value of the flow counter is allowed to
1541 reach before the job must wait for a lower value of the counter.
1542 .TP
1543 .BI flow_sleep \fR=\fPint
1544 The period of time, in microseconds, to wait after the flow watermark has been
1545 exceeded before retrying operations
1546 .TP
1547 .BI clat_percentiles \fR=\fPbool
1548 Enable the reporting of percentiles of completion latencies.
1549 .TP
1550 .BI percentile_list \fR=\fPfloat_list
1551 Overwrite the default list of percentiles for completion latencies and the
1552 block error histogram. Each number is a floating number in the range (0,100],
1553 and the maximum length of the list is 20. Use ':' to separate the
1554 numbers. For example, \-\-percentile_list=99.5:99.9 will cause fio to
1555 report the values of completion latency below which 99.5% and 99.9% of
1556 the observed latencies fell, respectively.
1557 .SS "Ioengine Parameters List"
1558 Some parameters are only valid when a specific ioengine is in use. These are
1559 used identically to normal parameters, with the caveat that when used on the
1560 command line, they must come after the ioengine.
1561 .TP
1562 .BI (cpu)cpuload \fR=\fPint
1563 Attempt to use the specified percentage of CPU cycles.
1564 .TP
1565 .BI (cpu)cpuchunks \fR=\fPint
1566 Split the load into cycles of the given time. In microseconds.
1567 .TP
1568 .BI (cpu)exit_on_io_done \fR=\fPbool
1569 Detect when IO threads are done, then exit.
1570 .TP
1571 .BI (libaio)userspace_reap
1572 Normally, with the libaio engine in use, fio will use
1573 the io_getevents system call to reap newly returned events.
1574 With this flag turned on, the AIO ring will be read directly
1575 from user-space to reap events. The reaping mode is only
1576 enabled when polling for a minimum of 0 events (eg when
1577 iodepth_batch_complete=0).
1578 .TP
1579 .BI (net,netsplice)hostname \fR=\fPstr
1580 The host name or IP address to use for TCP or UDP based IO.
1581 If the job is a TCP listener or UDP reader, the hostname is not
1582 used and must be omitted unless it is a valid UDP multicast address.
1583 .TP
1584 .BI (net,netsplice)port \fR=\fPint
1585 The TCP or UDP port to bind to or connect to. If this is used with
1586 \fBnumjobs\fR to spawn multiple instances of the same job type, then
1587 this will be the starting port number since fio will use a range of ports.
1588 .TP
1589 .BI (net,netsplice)interface \fR=\fPstr
1590 The IP address of the network interface used to send or receive UDP multicast
1591 packets.
1592 .TP
1593 .BI (net,netsplice)ttl \fR=\fPint
1594 Time-to-live value for outgoing UDP multicast packets. Default: 1
1595 .TP
1596 .BI (net,netsplice)nodelay \fR=\fPbool
1597 Set TCP_NODELAY on TCP connections.
1598 .TP
1599 .BI (net,netsplice)protocol \fR=\fPstr "\fR,\fP proto" \fR=\fPstr
1600 The network protocol to use. Accepted values are:
1601 .RS
1602 .RS
1603 .TP
1604 .B tcp
1605 Transmission control protocol
1606 .TP
1607 .B tcpv6
1608 Transmission control protocol V6
1609 .TP
1610 .B udp
1611 User datagram protocol
1612 .TP
1613 .B udpv6
1614 User datagram protocol V6
1615 .TP
1616 .B unix
1617 UNIX domain socket
1618 .RE
1619 .P
1620 When the protocol is TCP or UDP, the port must also be given,
1621 as well as the hostname if the job is a TCP listener or UDP
1622 reader. For unix sockets, the normal filename option should be
1623 used and the port is invalid.
1624 .RE
1625 .TP
1626 .BI (net,netsplice)listen
1627 For TCP network connections, tell fio to listen for incoming
1628 connections rather than initiating an outgoing connection. The
1629 hostname must be omitted if this option is used.
1630 .TP
1631 .BI (net, pingpong) \fR=\fPbool
1632 Normally a network writer will just continue writing data, and a network reader
1633 will just consume packets. If pingpong=1 is set, a writer will send its normal
1634 payload to the reader, then wait for the reader to send the same payload back.
1635 This allows fio to measure network latencies. The submission and completion
1636 latencies then measure local time spent sending or receiving, and the
1637 completion latency measures how long it took for the other end to receive and
1638 send back. For UDP multicast traffic pingpong=1 should only be set for a single
1639 reader when multiple readers are listening to the same address.
1640 .TP
1641 .BI (net, window_size) \fR=\fPint
1642 Set the desired socket buffer size for the connection.
1643 .TP
1644 .BI (net, mss) \fR=\fPint
1645 Set the TCP maximum segment size (TCP_MAXSEG).
1646 .TP
1647 .BI (e4defrag,donorname) \fR=\fPstr
1648 File will be used as a block donor (swap extents between files)
1649 .TP
1650 .BI (e4defrag,inplace) \fR=\fPint
1651 Configure donor file block allocation strategy          
1652 .RS
1653 .BI 0(default) :
1654 Preallocate donor's file on init
1655 .TP
1656 .BI 1:
1657 allocate space immediately inside defragment event, and free right after event
1658 .RE
1659 .TP
1660 .BI (rbd)rbdname \fR=\fPstr
1661 Specifies the name of the RBD.
1662 .TP
1663 .BI (rbd)pool \fR=\fPstr
1664 Specifies the name of the Ceph pool containing the RBD.
1665 .TP
1666 .BI (rbd)clientname \fR=\fPstr
1667 Specifies the username (without the 'client.' prefix) used to access the Ceph cluster.
1668 .TP
1669 .BI (mtd)skipbad \fR=\fPbool
1670 Skip operations against known bad blocks.
1672 While running, \fBfio\fR will display the status of the created jobs.  For
1673 example:
1674 .RS
1675 .P
1676 Threads: 1: [_r] [24.8% done] [ 13509/  8334 kb/s] [eta 00h:01m:31s]
1677 .RE
1678 .P
1679 The characters in the first set of brackets denote the current status of each
1680 threads.  The possible values are:
1681 .P
1682 .PD 0
1683 .RS
1684 .TP
1685 .B P
1686 Setup but not started.
1687 .TP
1688 .B C
1689 Thread created.
1690 .TP
1691 .B I
1692 Initialized, waiting.
1693 .TP
1694 .B R
1695 Running, doing sequential reads.
1696 .TP
1697 .B r
1698 Running, doing random reads.
1699 .TP
1700 .B W
1701 Running, doing sequential writes.
1702 .TP
1703 .B w
1704 Running, doing random writes.
1705 .TP
1706 .B M
1707 Running, doing mixed sequential reads/writes.
1708 .TP
1709 .B m
1710 Running, doing mixed random reads/writes.
1711 .TP
1712 .B F
1713 Running, currently waiting for \fBfsync\fR\|(2).
1714 .TP
1715 .B V
1716 Running, verifying written data.
1717 .TP
1718 .B E
1719 Exited, not reaped by main thread.
1720 .TP
1721 .B \-
1722 Exited, thread reaped.
1723 .RE
1724 .PD
1725 .P
1726 The second set of brackets shows the estimated completion percentage of
1727 the current group.  The third set shows the read and write I/O rate,
1728 respectively. Finally, the estimated run time of the job is displayed.
1729 .P
1730 When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data
1731 for each thread, each group of threads, and each disk, in that order.
1732 .P
1733 Per-thread statistics first show the threads client number, group-id, and
1734 error code.  The remaining figures are as follows:
1735 .RS
1736 .TP
1737 .B io
1738 Number of megabytes of I/O performed.
1739 .TP
1740 .B bw
1741 Average data rate (bandwidth).
1742 .TP
1743 .B runt
1744 Threads run time.
1745 .TP
1746 .B slat
1747 Submission latency minimum, maximum, average and standard deviation. This is
1748 the time it took to submit the I/O.
1749 .TP
1750 .B clat
1751 Completion latency minimum, maximum, average and standard deviation.  This
1752 is the time between submission and completion.
1753 .TP
1754 .B bw
1755 Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average
1756 and standard deviation.
1757 .TP
1758 .B cpu
1759 CPU usage statistics. Includes user and system time, number of context switches
1760 this thread went through and number of major and minor page faults.
1761 .TP
1762 .B IO depths
1763 Distribution of I/O depths.  Each depth includes everything less than (or equal)
1764 to it, but greater than the previous depth.
1765 .TP
1766 .B IO issued
1767 Number of read/write requests issued, and number of short read/write requests.
1768 .TP
1769 .B IO latencies
1770 Distribution of I/O completion latencies.  The numbers follow the same pattern
1771 as \fBIO depths\fR.
1772 .RE
1773 .P
1774 The group statistics show:
1775 .PD 0
1776 .RS
1777 .TP
1778 .B io
1779 Number of megabytes I/O performed.
1780 .TP
1781 .B aggrb
1782 Aggregate bandwidth of threads in the group.
1783 .TP
1784 .B minb
1785 Minimum average bandwidth a thread saw.
1786 .TP
1787 .B maxb
1788 Maximum average bandwidth a thread saw.
1789 .TP
1790 .B mint
1791 Shortest runtime of threads in the group.
1792 .TP
1793 .B maxt
1794 Longest runtime of threads in the group.
1795 .RE
1796 .PD
1797 .P
1798 Finally, disk statistics are printed with reads first:
1799 .PD 0
1800 .RS
1801 .TP
1802 .B ios
1803 Number of I/Os performed by all groups.
1804 .TP
1805 .B merge
1806 Number of merges in the I/O scheduler.
1807 .TP
1808 .B ticks
1809 Number of ticks we kept the disk busy.
1810 .TP
1811 .B io_queue
1812 Total time spent in the disk queue.
1813 .TP
1814 .B util
1815 Disk utilization.
1816 .RE
1817 .PD
1818 .P
1819 It is also possible to get fio to dump the current output while it is
1820 running, without terminating the job. To do that, send fio the \fBUSR1\fR
1821 signal.
1823 If the \fB\-\-minimal\fR / \fB\-\-append-terse\fR options are given, the
1824 results will be printed/appended in a semicolon-delimited format suitable for
1825 scripted use.
1826 A job description (if provided) follows on a new line.  Note that the first
1827 number in the line is the version number. If the output has to be changed
1828 for some reason, this number will be incremented by 1 to signify that
1829 change.  The fields are:
1830 .P
1831 .RS
1832 .B terse version, fio version, jobname, groupid, error
1833 .P
1834 Read status:
1835 .RS
1836 .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, IOPS, runtime \fR(ms)\fP
1837 .P
1838 Submission latency:
1839 .RS
1840 .B min, max, mean, standard deviation
1841 .RE
1842 Completion latency:
1843 .RS
1844 .B min, max, mean, standard deviation
1845 .RE
1846 Completion latency percentiles (20 fields):
1847 .RS
1848 .B Xth percentile=usec
1849 .RE
1850 Total latency:
1851 .RS
1852 .B min, max, mean, standard deviation
1853 .RE
1854 Bandwidth:
1855 .RS
1856 .B min, max, aggregate percentage of total, mean, standard deviation
1857 .RE
1858 .RE
1859 .P
1860 Write status:
1861 .RS
1862 .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, IOPS, runtime \fR(ms)\fP
1863 .P
1864 Submission latency:
1865 .RS
1866 .B min, max, mean, standard deviation
1867 .RE
1868 Completion latency:
1869 .RS
1870 .B min, max, mean, standard deviation
1871 .RE
1872 Completion latency percentiles (20 fields):
1873 .RS
1874 .B Xth percentile=usec
1875 .RE
1876 Total latency:
1877 .RS
1878 .B min, max, mean, standard deviation
1879 .RE
1880 Bandwidth:
1881 .RS
1882 .B min, max, aggregate percentage of total, mean, standard deviation
1883 .RE
1884 .RE
1885 .P
1886 CPU usage:
1887 .RS
1888 .B user, system, context switches, major page faults, minor page faults
1889 .RE
1890 .P
1891 IO depth distribution:
1892 .RS
1893 .B <=1, 2, 4, 8, 16, 32, >=64
1894 .RE
1895 .P
1896 IO latency distribution:
1897 .RS
1898 Microseconds:
1899 .RS
1900 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
1901 .RE
1902 Milliseconds:
1903 .RS
1904 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000
1905 .RE
1906 .RE
1907 .P
1908 Disk utilization (1 for each disk used):
1909 .RS
1910 .B name, read ios, write ios, read merges, write merges, read ticks, write ticks, read in-queue time, write in-queue time, disk utilization percentage
1911 .RE
1912 .P
1913 Error Info (dependent on continue_on_error, default off):
1914 .RS
1915 .B total # errors, first error code 
1916 .RE
1917 .P
1918 .B text description (if provided in config - appears on newline)
1919 .RE
1921 Normally you would run fio as a stand-alone application on the machine
1922 where the IO workload should be generated. However, it is also possible to
1923 run the frontend and backend of fio separately. This makes it possible to
1924 have a fio server running on the machine(s) where the IO workload should
1925 be running, while controlling it from another machine.
1927 To start the server, you would do:
1929 \fBfio \-\-server=args\fR
1931 on that machine, where args defines what fio listens to. The arguments
1932 are of the form 'type:hostname or IP:port'. 'type' is either 'ip' (or ip4)
1933 for TCP/IP v4, 'ip6' for TCP/IP v6, or 'sock' for a local unix domain
1934 socket. 'hostname' is either a hostname or IP address, and 'port' is the port to
1935 listen to (only valid for TCP/IP, not a local socket). Some examples:
1937 1) fio \-\-server
1939    Start a fio server, listening on all interfaces on the default port (8765).
1941 2) fio \-\-server=ip:hostname,4444
1943    Start a fio server, listening on IP belonging to hostname and on port 4444.
1945 3) fio \-\-server=ip6:::1,4444
1947    Start a fio server, listening on IPv6 localhost ::1 and on port 4444.
1949 4) fio \-\-server=,4444
1951    Start a fio server, listening on all interfaces on port 4444.
1953 5) fio \-\-server=
1955    Start a fio server, listening on IP on the default port.
1957 6) fio \-\-server=sock:/tmp/fio.sock
1959    Start a fio server, listening on the local socket /tmp/fio.sock.
1961 When a server is running, you can connect to it from a client. The client
1962 is run with:
1964 fio \-\-local-args \-\-client=server \-\-remote-args <job file(s)>
1966 where \-\-local-args are arguments that are local to the client where it is
1967 running, 'server' is the connect string, and \-\-remote-args and <job file(s)>
1968 are sent to the server. The 'server' string follows the same format as it
1969 does on the server side, to allow IP/hostname/socket and port strings.
1970 You can connect to multiple clients as well, to do that you could run:
1972 fio \-\-client=server2 \-\-client=server2 <job file(s)>
1974 If the job file is located on the fio server, then you can tell the server
1975 to load a local file as well. This is done by using \-\-remote-config:
1977 fio \-\-client=server \-\-remote-config /path/to/file.fio
1979 Then fio will open this local (to the server) job file instead
1980 of being passed one from the client.
1982 If you have many servers (example: 100 VMs/containers), you can input a pathname 
1983 of a file containing host IPs/names as the parameter value for the \-\-client option.
1984 For example, here is an example "host.list" file containing 2 hostnames:
1986 host1.your.dns.domain
1987 .br
1988 host2.your.dns.domain
1990 The fio command would then be:
1992 fio \-\-client=host.list <job file>
1994 In this mode, you cannot input server-specific parameters or job files, and all
1995 servers receive the same job file.
1997 In order to enable fio \-\-client runs utilizing a shared filesystem from multiple hosts,
1998 fio \-\-client now prepends the IP address of the server to the filename. For example, 
1999 if fio is using directory /mnt/nfs/fio and is writing filename fileio.tmp, 
2000 with a \-\-client hostfile
2001 containing two hostnames h1 and h2 with IP addresses and, then
2002 fio will create two files:
2004 /mnt/nfs/fio/
2005 .br
2006 /mnt/nfs/fio/
2010 .B fio
2011 was written by Jens Axboe <>,
2012 now Jens Axboe <>.
2013 .br
2014 This man page was written by Aaron Carroll <> based
2015 on documentation by Jens Axboe.
2017 Report bugs to the \fBfio\fR mailing list <>.
2018 See \fBREADME\fR.
2019 .SH "SEE ALSO"
2020 For further documentation see \fBHOWTO\fR and \fBREADME\fR.
2021 .br
2022 Sample jobfiles are available in the \fBexamples\fR directory.