[fio.git] / fio.1
1 .TH fio 1 "July 2017" "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 (e.g. \-\-debug=file,mem will enable
18 file and memory debugging). `help' will list all available tracing options.
19 .TP
20 .BI \-\-parse-only
21 Parse options only, don't start any I/O.
22 .TP
23 .BI \-\-output \fR=\fPfilename
24 Write output to \fIfilename\fR.
25 .TP
26 .BI \-\-output-format \fR=\fPformat
27 Set the reporting format to \fInormal\fR, \fIterse\fR, \fIjson\fR, or
28 \fIjson+\fR. Multiple formats can be selected, separate by a comma. \fIterse\fR
29 is a CSV based format. \fIjson+\fR is like \fIjson\fR, except it adds a full
30 dump of the latency buckets.
31 .TP
32 .BI \-\-runtime \fR=\fPruntime
33 Limit run time to \fIruntime\fR seconds.
34 .TP
35 .B \-\-bandwidth\-log
36 Generate aggregate bandwidth logs.
37 .TP
38 .B \-\-minimal
39 Print statistics in a terse, semicolon-delimited format.
40 .TP
41 .B \-\-append-terse
42 Print statistics in selected mode AND terse, semicolon-delimited format.
43 Deprecated, use \-\-output-format instead to select multiple formats.
44 .TP
45 .BI \-\-terse\-version \fR=\fPversion
46 Set terse version output format (default 3, or 2, 4, 5)
47 .TP
48 .B \-\-version
49 Print version information and exit.
50 .TP
51 .B \-\-help
52 Print a summary of the command line options and exit.
53 .TP
54 .B \-\-cpuclock-test
55 Perform test and validation of internal CPU clock.
56 .TP
57 .BI \-\-crctest \fR=\fP[test]
58 Test the speed of the built-in checksumming functions. If no argument is given,
59 all of them are tested. Alternatively, a comma separated list can be passed, in which
60 case the given ones are tested.
61 .TP
62 .BI \-\-cmdhelp \fR=\fPcommand
63 Print help information for \fIcommand\fR. May be `all' for all commands.
64 .TP
65 .BI \-\-enghelp \fR=\fPioengine[,command]
66 List all commands defined by \fIioengine\fR, or print help for \fIcommand\fR defined by \fIioengine\fR.
67 If no \fIioengine\fR is given, list all available ioengines.
68 .TP
69 .BI \-\-showcmd \fR=\fPjobfile
70 Convert \fIjobfile\fR to a set of command-line options.
71 .TP
72 .BI \-\-readonly
73 Turn on safety read-only checks, preventing writes. The \-\-readonly
74 option is an extra safety guard to prevent users from accidentally starting
75 a write workload when that is not desired. Fio will only write if
76 `rw=write/randwrite/rw/randrw` is given. This extra safety net can be used
77 as an extra precaution as \-\-readonly will also enable a write check in
78 the I/O engine core to prevent writes due to unknown user space bug(s).
79 .TP
80 .BI \-\-eta \fR=\fPwhen
81 Specifies when real-time ETA estimate should be printed. \fIwhen\fR may
82 be `always', `never' or `auto'.
83 .TP
84 .BI \-\-eta\-newline \fR=\fPtime
85 Force a new line for every \fItime\fR period passed. When the unit is omitted,
86 the value is interpreted in seconds.
87 .TP
88 .BI \-\-status\-interval \fR=\fPtime
89 Force full status dump every \fItime\fR period passed. When the unit is omitted,
90 the value is interpreted in seconds.
91 .TP
92 .BI \-\-section \fR=\fPname
93 Only run specified section \fIname\fR in job file. Multiple sections can be specified.
94 The \-\-section option allows one to combine related jobs into one file.
95 E.g. one job file could define light, moderate, and heavy sections. Tell
96 fio to run only the "heavy" section by giving \-\-section=heavy
97 command line option. One can also specify the "write" operations in one
98 section and "verify" operation in another section. The \-\-section option
99 only applies to job sections. The reserved *global* section is always
100 parsed and used.
101 .TP
102 .BI \-\-alloc\-size \fR=\fPkb
103 Set the internal smalloc pool size to \fIkb\fP in KiB. The
104 \-\-alloc-size switch allows one to use a larger pool size for smalloc.
105 If running large jobs with randommap enabled, fio can run out of memory.
106 Smalloc is an internal allocator for shared structures from a fixed size
107 memory pool and can grow to 16 pools. The pool size defaults to 16MiB.
108 NOTE: While running .fio_smalloc.* backing store files are visible
109 in /tmp.
110 .TP
111 .BI \-\-warnings\-fatal
112 All fio parser warnings are fatal, causing fio to exit with an error.
113 .TP
114 .BI \-\-max\-jobs \fR=\fPnr
115 Set the maximum number of threads/processes to support.
116 .TP
117 .BI \-\-server \fR=\fPargs
118 Start a backend server, with \fIargs\fP specifying what to listen to. See Client/Server section.
119 .TP
120 .BI \-\-daemonize \fR=\fPpidfile
121 Background a fio server, writing the pid to the given \fIpidfile\fP file.
122 .TP
123 .BI \-\-client \fR=\fPhostname
124 Instead of running the jobs locally, send and run them on the given host or set of hosts. See Client/Server section.
125 .TP
126 .BI \-\-remote-config \fR=\fPfile
127 Tell fio server to load this local file.
128 .TP
129 .BI \-\-idle\-prof \fR=\fPoption
130 Report CPU idleness. \fIoption\fP is one of the following:
131 .RS
132 .RS
133 .TP
134 .B calibrate
135 Run unit work calibration only and exit.
136 .TP
137 .B system
138 Show aggregate system idleness and unit work.
139 .TP
140 .B percpu
141 As "system" but also show per CPU idleness.
142 .RE
143 .RE
144 .TP
145 .BI \-\-inflate-log \fR=\fPlog
146 Inflate and output compressed log.
147 .TP
148 .BI \-\-trigger-file \fR=\fPfile
149 Execute trigger cmd when file exists.
150 .TP
151 .BI \-\-trigger-timeout \fR=\fPt
152 Execute trigger at this time.
153 .TP
154 .BI \-\-trigger \fR=\fPcmd
155 Set this command as local trigger.
156 .TP
157 .BI \-\-trigger-remote \fR=\fPcmd
158 Set this command as remote trigger.
159 .TP
160 .BI \-\-aux-path \fR=\fPpath
161 Use this path for fio state generated files.
163 Any parameters following the options will be assumed to be job files, unless
164 they match a job file parameter. Multiple job files can be listed and each job
165 file will be regarded as a separate group. Fio will `stonewall` execution
166 between each group.
168 Fio accepts one or more job files describing what it is
169 supposed to do. The job file format is the classic ini file, where the names
170 enclosed in [] brackets define the job name. You are free to use any ASCII name
171 you want, except *global* which has special meaning. Following the job name is
172 a sequence of zero or more parameters, one per line, that define the behavior of
173 the job. If the first character in a line is a ';' or a '#', the entire line is
174 discarded as a comment.
176 A *global* section sets defaults for the jobs described in that file. A job may
177 override a *global* section parameter, and a job file may even have several
178 *global* sections if so desired. A job is only affected by a *global* section
179 residing above it.
181 The \-\-cmdhelp option also lists all options. If used with an `option`
182 argument, \-\-cmdhelp will detail the given `option`.
184 See the `examples/` directory in the fio source for inspiration on how to write
185 job files. Note the copyright and license requirements currently apply to
186 `examples/` files.
188 Some parameters take an option of a given type, such as an integer or a
189 string. Anywhere a numeric value is required, an arithmetic expression may be
190 used, provided it is surrounded by parentheses. Supported operators are:
191 .RS
192 .RS
193 .TP
194 .B addition (+)
195 .TP
196 .B subtraction (-)
197 .TP
198 .B multiplication (*)
199 .TP
200 .B division (/)
201 .TP
202 .B modulus (%)
203 .TP
204 .B exponentiation (^)
205 .RE
206 .RE
207 .P
208 For time values in expressions, units are microseconds by default. This is
209 different than for time values not in expressions (not enclosed in
210 parentheses).
212 The following parameter types are used.
213 .TP
214 .I str
215 String. A sequence of alphanumeric characters.
216 .TP
217 .I time
218 Integer with possible time suffix. Without a unit value is interpreted as
219 seconds unless otherwise specified. Accepts a suffix of 'd' for days, 'h' for
220 hours, 'm' for minutes, 's' for seconds, 'ms' (or 'msec') for milliseconds and 'us'
221 (or 'usec') for microseconds. For example, use 10m for 10 minutes.
222 .TP
223 .I int
224 Integer. A whole number value, which may contain an integer prefix
225 and an integer suffix.
227 [*integer prefix*] **number** [*integer suffix*]
229 The optional *integer prefix* specifies the number's base. The default
230 is decimal. *0x* specifies hexadecimal.
232 The optional *integer suffix* specifies the number's units, and includes an
233 optional unit prefix and an optional unit. For quantities of data, the
234 default unit is bytes. For quantities of time, the default unit is seconds
235 unless otherwise specified.
237 With \fBkb_base=1000\fR, fio follows international standards for unit
238 prefixes. To specify power-of-10 decimal values defined in the
239 International System of Units (SI):
241 .nf
242 ki means kilo (K) or 1000
243 mi means mega (M) or 1000**2
244 gi means giga (G) or 1000**3
245 ti means tera (T) or 1000**4
246 pi means peta (P) or 1000**5
247 .fi
249 To specify power-of-2 binary values defined in IEC 80000-13:
251 .nf
252 k means kibi (Ki) or 1024
253 m means mebi (Mi) or 1024**2
254 g means gibi (Gi) or 1024**3
255 t means tebi (Ti) or 1024**4
256 p means pebi (Pi) or 1024**5
257 .fi
259 With \fBkb_base=1024\fR (the default), the unit prefixes are opposite
260 from those specified in the SI and IEC 80000-13 standards to provide
261 compatibility with old scripts. For example, 4k means 4096.
263 For quantities of data, an optional unit of 'B' may be included
264 (e.g., 'kB' is the same as 'k').
266 The *integer suffix* is not case sensitive (e.g., m/mi mean mebi/mega,
267 not milli). 'b' and 'B' both mean byte, not bit.
269 Examples with \fBkb_base=1000\fR:
271 .nf
272 4 KiB: 4096, 4096b, 4096B, 4k, 4kb, 4kB, 4K, 4KB
273 1 MiB: 1048576, 1m, 1024k
274 1 MB: 1000000, 1mi, 1000ki
275 1 TiB: 1073741824, 1t, 1024m, 1048576k
276 1 TB: 1000000000, 1ti, 1000mi, 1000000ki
277 .fi
279 Examples with \fBkb_base=1024\fR (default):
281 .nf
282 4 KiB: 4096, 4096b, 4096B, 4k, 4kb, 4kB, 4K, 4KB
283 1 MiB: 1048576, 1m, 1024k
284 1 MB: 1000000, 1mi, 1000ki
285 1 TiB: 1073741824, 1t, 1024m, 1048576k
286 1 TB: 1000000000, 1ti, 1000mi, 1000000ki
287 .fi
289 To specify times (units are not case sensitive):
291 .nf
292 D means days
293 H means hours
294 M mean minutes
295 s or sec means seconds (default)
296 ms or msec means milliseconds
297 us or usec means microseconds
298 .fi
300 If the option accepts an upper and lower range, use a colon ':' or
301 minus '-' to separate such values. See `irange` parameter type.
302 If the lower value specified happens to be larger than the upper value
303 the two values are swapped.
304 .TP
305 .I bool
306 Boolean. Usually parsed as an integer, however only defined for
307 true and false (1 and 0).
308 .TP
309 .I irange
310 Integer range with suffix. Allows value range to be given, such as
311 1024-4096. A colon may also be used as the separator, e.g. 1k:4k. If the
312 option allows two sets of ranges, they can be specified with a ',' or '/'
313 delimiter: 1k-4k/8k-32k. Also see `int` parameter type.
314 .TP
315 .I float_list
316 A list of floating point numbers, separated by a ':' character.
318 With the above in mind, here follows the complete list of fio job parameters.
319 .TP
320 .BI name \fR=\fPstr
321 May be used to override the job name.  On the command line, this parameter
322 has the special purpose of signalling the start of a new job.
323 .TP
324 .BI wait_for \fR=\fPstr
325 Specifies the name of the already defined job to wait for. Single waitee name
326 only may be specified. If set, the job won't be started until all workers of
327 the waitee job are done.  Wait_for operates on the job name basis, so there are
328 a few limitations. First, the waitee must be defined prior to the waiter job
329 (meaning no forward references). Second, if a job is being referenced as a
330 waitee, it must have a unique name (no duplicate waitees).
331 .TP
332 .BI description \fR=\fPstr
333 Human-readable description of the job. It is printed when the job is run, but
334 otherwise has no special purpose.
335 .TP
336 .BI directory \fR=\fPstr
337 Prefix filenames with this directory.  Used to place files in a location other
338 than `./'.
339 You can specify a number of directories by separating the names with a ':'
340 character. These directories will be assigned equally distributed to job clones
341 creates with \fInumjobs\fR as long as they are using generated filenames.
342 If specific \fIfilename(s)\fR are set fio will use the first listed directory,
343 and thereby matching the  \fIfilename\fR semantic which generates a file each
344 clone if not specified, but let all clones use the same if set. See
345 \fIfilename\fR for considerations regarding escaping certain characters on
346 some platforms.
347 .TP
348 .BI filename \fR=\fPstr
349 .B fio
350 normally makes up a file name based on the job name, thread number, and file
351 number. If you want to share files between threads in a job or several jobs,
352 specify a \fIfilename\fR for each of them to override the default.
353 If the I/O engine is file-based, you can specify
354 a number of files by separating the names with a `:' character. `\-' is a
355 reserved name, meaning stdin or stdout, depending on the read/write direction
356 set. On Windows, disk devices are accessed as \\.\PhysicalDrive0 for the first
357 device, \\.\PhysicalDrive1 for the second etc. Note: Windows and FreeBSD
358 prevent write access to areas of the disk containing in-use data
359 (e.g. filesystems). If the wanted filename does need to include a colon, then
360 escape that with a '\\' character. For instance, if the filename is
361 "/dev/dsk/foo@3,0:c", then you would use filename="/dev/dsk/foo@3,0\\:c".
362 .TP
363 .BI filename_format \fR=\fPstr
364 If sharing multiple files between jobs, it is usually necessary to have
365 fio generate the exact names that you want. By default, fio will name a file
366 based on the default file format specification of
367 \fBjobname.jobnumber.filenumber\fP. With this option, that can be
368 customized. Fio will recognize and replace the following keywords in this
369 string:
370 .RS
371 .RS
372 .TP
373 .B $jobname
374 The name of the worker thread or process.
375 .TP
376 .B $jobnum
377 The incremental number of the worker thread or process.
378 .TP
379 .B $filenum
380 The incremental number of the file for that worker thread or process.
381 .RE
382 .P
383 To have dependent jobs share a set of files, this option can be set to
384 have fio generate filenames that are shared between the two. For instance,
385 if \fBtestfiles.$filenum\fR is specified, file number 4 for any job will
386 be named \fBtestfiles.4\fR. The default of \fB$jobname.$jobnum.$filenum\fR
387 will be used if no other format specifier is given.
388 .RE
389 .P
390 .TP
391 .BI unique_filename \fR=\fPbool
392 To avoid collisions between networked clients, fio defaults to prefixing
393 any generated filenames (with a directory specified) with the source of
394 the client connecting. To disable this behavior, set this option to 0.
395 .TP
396 .BI lockfile \fR=\fPstr
397 Fio defaults to not locking any files before it does IO to them. If a file or
398 file descriptor is shared, fio can serialize IO to that file to make the end
399 result consistent. This is usual for emulating real workloads that share files.
400 The lock modes are:
401 .RS
402 .RS
403 .TP
404 .B none
405 No locking. This is the default.
406 .TP
407 .B exclusive
408 Only one thread or process may do IO at a time, excluding all others.
409 .TP
410 .B readwrite
411 Read-write locking on the file. Many readers may access the file at the same
412 time, but writes get exclusive access.
413 .RE
414 .RE
415 .P
416 .BI opendir \fR=\fPstr
417 Recursively open any files below directory \fIstr\fR.
418 .TP
419 .BI readwrite \fR=\fPstr "\fR,\fP rw" \fR=\fPstr
420 Type of I/O pattern.  Accepted values are:
421 .RS
422 .RS
423 .TP
424 .B read
425 Sequential reads.
426 .TP
427 .B write
428 Sequential writes.
429 .TP
430 .B trim
431 Sequential trims (Linux block devices only).
432 .TP
433 .B randread
434 Random reads.
435 .TP
436 .B randwrite
437 Random writes.
438 .TP
439 .B randtrim
440 Random trims (Linux block devices only).
441 .TP
442 .B rw, readwrite
443 Mixed sequential reads and writes.
444 .TP
445 .B randrw
446 Mixed random reads and writes.
447 .TP
448 .B trimwrite
449 Sequential trim and write mixed workload. Blocks will be trimmed first, then
450 the same blocks will be written to.
451 .RE
452 .P
453 Fio defaults to read if the option is not specified.
454 For mixed I/O, the default split is 50/50. For certain types of io the result
455 may still be skewed a bit, since the speed may be different. It is possible to
456 specify a number of IO's to do before getting a new offset, this is done by
457 appending a `:\fI<nr>\fR to the end of the string given. For a random read, it
458 would look like \fBrw=randread:8\fR for passing in an offset modifier with a
459 value of 8. If the postfix is used with a sequential IO pattern, then the value
460 specified will be added to the generated offset for each IO. For instance,
461 using \fBrw=write:4k\fR will skip 4k for every write. It turns sequential IO
462 into sequential IO with holes. See the \fBrw_sequencer\fR option.
463 .RE
464 .TP
465 .BI rw_sequencer \fR=\fPstr
466 If an offset modifier is given by appending a number to the \fBrw=<str>\fR line,
467 then this option controls how that number modifies the IO offset being
468 generated. Accepted values are:
469 .RS
470 .RS
471 .TP
472 .B sequential
473 Generate sequential offset
474 .TP
475 .B identical
476 Generate the same offset
477 .RE
478 .P
479 \fBsequential\fR is only useful for random IO, where fio would normally
480 generate a new random offset for every IO. If you append eg 8 to randread, you
481 would get a new random offset for every 8 IO's. The result would be a seek for
482 only every 8 IO's, instead of for every IO. Use \fBrw=randread:8\fR to specify
483 that. As sequential IO is already sequential, setting \fBsequential\fR for that
484 would not result in any differences.  \fBidentical\fR behaves in a similar
485 fashion, except it sends the same offset 8 number of times before generating a
486 new offset.
487 .RE
488 .P
489 .TP
490 .BI kb_base \fR=\fPint
491 The base unit for a kilobyte. The defacto base is 2^10, 1024.  Storage
492 manufacturers like to use 10^3 or 1000 as a base ten unit instead, for obvious
493 reasons. Allowed values are 1024 or 1000, with 1024 being the default.
494 .TP
495 .BI unified_rw_reporting \fR=\fPbool
496 Fio normally reports statistics on a per data direction basis, meaning that
497 reads, writes, and trims are accounted and reported separately. If this option is
498 set fio sums the results and reports them as "mixed" instead.
499 .TP
500 .BI randrepeat \fR=\fPbool
501 Seed the random number generator used for random I/O patterns in a predictable
502 way so the pattern is repeatable across runs.  Default: true.
503 .TP
504 .BI allrandrepeat \fR=\fPbool
505 Seed all random number generators in a predictable way so results are
506 repeatable across runs.  Default: false.
507 .TP
508 .BI randseed \fR=\fPint
509 Seed the random number generators based on this seed value, to be able to
510 control what sequence of output is being generated. If not set, the random
511 sequence depends on the \fBrandrepeat\fR setting.
512 .TP
513 .BI fallocate \fR=\fPstr
514 Whether pre-allocation is performed when laying down files. Accepted values
515 are:
516 .RS
517 .RS
518 .TP
519 .B none
520 Do not pre-allocate space.
521 .TP
522 .B native
523 Use a platform's native pre-allocation call but fall back to 'none' behavior if
524 it fails/is not implemented.
525 .TP
526 .B posix
527 Pre-allocate via \fBposix_fallocate\fR\|(3).
528 .TP
529 .B keep
530 Pre-allocate via \fBfallocate\fR\|(2) with FALLOC_FL_KEEP_SIZE set.
531 .TP
532 .B 0
533 Backward-compatible alias for 'none'.
534 .TP
535 .B 1
536 Backward-compatible alias for 'posix'.
537 .RE
538 .P
539 May not be available on all supported platforms. 'keep' is only
540 available on Linux. If using ZFS on Solaris this cannot be set to 'posix'
541 because ZFS doesn't support it. Default: 'native' if any pre-allocation methods
542 are available, 'none' if not.
543 .RE
544 .TP
545 .BI fadvise_hint \fR=\fPstr
546 Use \fBposix_fadvise\fR\|(2) to advise the kernel what I/O patterns
547 are likely to be issued. Accepted values are:
548 .RS
549 .RS
550 .TP
551 .B 0
552 Backwards compatible hint for "no hint".
553 .TP
554 .B 1
555 Backwards compatible hint for "advise with fio workload type". This
556 uses \fBFADV_RANDOM\fR for a random workload, and \fBFADV_SEQUENTIAL\fR
557 for a sequential workload.
558 .TP
559 .B sequential
560 Advise using \fBFADV_SEQUENTIAL\fR
561 .TP
562 .B random
563 Advise using \fBFADV_RANDOM\fR
564 .RE
565 .RE
566 .TP
567 .BI fadvise_stream \fR=\fPint
568 Use \fBposix_fadvise\fR\|(2) to advise the kernel what stream ID the
569 writes issued belong to. Only supported on Linux. Note, this option
570 may change going forward.
571 .TP
572 .BI size \fR=\fPint
573 Total size of I/O for this job.  \fBfio\fR will run until this many bytes have
574 been transferred, unless limited by other options (\fBruntime\fR, for instance,
575 or increased/descreased by \fBio_size\fR). Unless \fBnrfiles\fR and
576 \fBfilesize\fR options are given, this amount will be divided between the
577 available files for the job. If not set, fio will use the full size of the
578 given files or devices. If the files do not exist, size must be given. It is
579 also possible to give size as a percentage between 1 and 100. If size=20% is
580 given, fio will use 20% of the full size of the given files or devices.
581 .TP
582 .BI io_size \fR=\fPint "\fR,\fB io_limit \fR=\fPint
583 Normally fio operates within the region set by \fBsize\fR, which means that
584 the \fBsize\fR option sets both the region and size of IO to be performed.
585 Sometimes that is not what you want. With this option, it is possible to
586 define just the amount of IO that fio should do. For instance, if \fBsize\fR
587 is set to 20G and \fBio_limit\fR is set to 5G, fio will perform IO within
588 the first 20G but exit when 5G have been done. The opposite is also
589 possible - if \fBsize\fR is set to 20G, and \fBio_size\fR is set to 40G, then
590 fio will do 40G of IO within the 0..20G region.
591 .TP
592 .BI fill_device \fR=\fPbool "\fR,\fB fill_fs" \fR=\fPbool
593 Sets size to something really large and waits for ENOSPC (no space left on
594 device) as the terminating condition. Only makes sense with sequential write.
595 For a read workload, the mount point will be filled first then IO started on
596 the result. This option doesn't make sense if operating on a raw device node,
597 since the size of that is already known by the file system. Additionally,
598 writing beyond end-of-device will not return ENOSPC there.
599 .TP
600 .BI filesize \fR=\fPirange
601 Individual file sizes. May be a range, in which case \fBfio\fR will select sizes
602 for files at random within the given range, limited to \fBsize\fR in total (if
603 that is given). If \fBfilesize\fR is not specified, each created file is the
604 same size.
605 .TP
606 .BI file_append \fR=\fPbool
607 Perform IO after the end of the file. Normally fio will operate within the
608 size of a file. If this option is set, then fio will append to the file
609 instead. This has identical behavior to setting \fRoffset\fP to the size
610 of a file. This option is ignored on non-regular files.
611 .TP
612 .BI blocksize \fR=\fPint[,int][,int] "\fR,\fB bs" \fR=\fPint[,int][,int]
613 The block size in bytes for I/O units.  Default: 4096.
614 A single value applies to reads, writes, and trims.
615 Comma-separated values may be specified for reads, writes, and trims.
616 Empty values separated by commas use the default value. A value not
617 terminated in a comma applies to subsequent types.
618 .nf
619 Examples:
620 bs=256k    means 256k for reads, writes and trims
621 bs=8k,32k  means 8k for reads, 32k for writes and trims
622 bs=8k,32k, means 8k for reads, 32k for writes, and default for trims
623 bs=,8k     means default for reads, 8k for writes and trims
624 bs=,8k,    means default for reads, 8k for writes, and default for trims
625 .fi
626 .TP
627 .BI blocksize_range \fR=\fPirange[,irange][,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange][,irange]
628 A range of block sizes in bytes for I/O units.
629 The issued I/O unit will always be a multiple of the minimum size, unless
630 \fBblocksize_unaligned\fR is set.
631 Comma-separated ranges may be specified for reads, writes, and trims
632 as described in \fBblocksize\fR.
633 .nf
634 Example: bsrange=1k-4k,2k-8k.
635 .fi
636 .TP
637 .BI bssplit \fR=\fPstr[,str][,str]
638 This option allows even finer grained control of the block sizes issued,
639 not just even splits between them. With this option, you can weight various
640 block sizes for exact control of the issued IO for a job that has mixed
641 block sizes. The format of the option is bssplit=blocksize/percentage,
642 optionally adding as many definitions as needed separated by a colon.
643 Example: bssplit=4k/10:64k/50:32k/40 would issue 50% 64k blocks, 10% 4k
644 blocks and 40% 32k blocks. \fBbssplit\fR also supports giving separate
645 splits to reads, writes, and trims.
646 Comma-separated values may be specified for reads, writes, and trims
647 as described in \fBblocksize\fR.
648 .TP
649 .B blocksize_unaligned\fR,\fB bs_unaligned
650 If set, fio will issue I/O units with any size within \fBblocksize_range\fR,
651 not just multiples of the minimum size.  This typically won't
652 work with direct I/O, as that normally requires sector alignment.
653 .TP
654 .BI bs_is_seq_rand \fR=\fPbool
655 If this option is set, fio will use the normal read,write blocksize settings as
656 sequential,random blocksize settings instead. Any random read or write will
657 use the WRITE blocksize settings, and any sequential read or write will use
658 the READ blocksize settings.
659 .TP
660 .BI blockalign \fR=\fPint[,int][,int] "\fR,\fB ba" \fR=\fPint[,int][,int]
661 Boundary to which fio will align random I/O units. Default: \fBblocksize\fR.
662 Minimum alignment is typically 512b for using direct IO, though it usually
663 depends on the hardware block size.  This option is mutually exclusive with
664 using a random map for files, so it will turn off that option.
665 Comma-separated values may be specified for reads, writes, and trims
666 as described in \fBblocksize\fR.
667 .TP
668 .B zero_buffers
669 Initialize buffers with all zeros. Default: fill buffers with random data.
670 .TP
671 .B refill_buffers
672 If this option is given, fio will refill the IO buffers on every submit. The
673 default is to only fill it at init time and reuse that data. Only makes sense
674 if zero_buffers isn't specified, naturally. If data verification is enabled,
675 refill_buffers is also automatically enabled.
676 .TP
677 .BI scramble_buffers \fR=\fPbool
678 If \fBrefill_buffers\fR is too costly and the target is using data
679 deduplication, then setting this option will slightly modify the IO buffer
680 contents to defeat normal de-dupe attempts. This is not enough to defeat
681 more clever block compression attempts, but it will stop naive dedupe
682 of blocks. Default: true.
683 .TP
684 .BI buffer_compress_percentage \fR=\fPint
685 If this is set, then fio will attempt to provide IO buffer content (on WRITEs)
686 that compress to the specified level. Fio does this by providing a mix of
687 random data and a fixed pattern. The fixed pattern is either zeroes, or the
688 pattern specified by \fBbuffer_pattern\fR. If the pattern option is used, it
689 might skew the compression ratio slightly. Note that this is per block size
690 unit, for file/disk wide compression level that matches this setting. Note
691 that this is per block size unit, for file/disk wide compression level that
692 matches this setting, you'll also want to set refill_buffers.
693 .TP
694 .BI buffer_compress_chunk \fR=\fPint
695 See \fBbuffer_compress_percentage\fR. This setting allows fio to manage how
696 big the ranges of random data and zeroed data is. Without this set, fio will
697 provide \fBbuffer_compress_percentage\fR of blocksize random data, followed by
698 the remaining zeroed. With this set to some chunk size smaller than the block
699 size, fio can alternate random and zeroed data throughout the IO buffer.
700 .TP
701 .BI buffer_pattern \fR=\fPstr
702 If set, fio will fill the I/O buffers with this pattern or with the contents
703 of a file. If not set, the contents of I/O buffers are defined by the other
704 options related to buffer contents. The setting can be any pattern of bytes,
705 and can be prefixed with 0x for hex values. It may also be a string, where
706 the string must then be wrapped with ``""``. Or it may also be a filename,
707 where the filename must be wrapped with ``''`` in which case the file is
708 opened and read. Note that not all the file contents will be read if that
709 would cause the buffers to overflow. So, for example:
710 .RS
711 .RS
712 \fBbuffer_pattern\fR='filename'
713 .RS
714 or
715 .RE
716 \fBbuffer_pattern\fR="abcd"
717 .RS
718 or
719 .RE
720 \fBbuffer_pattern\fR=-12
721 .RS
722 or
723 .RE
724 \fBbuffer_pattern\fR=0xdeadface
725 .RE
726 .LP
727 Also you can combine everything together in any order:
728 .LP
729 .RS
730 \fBbuffer_pattern\fR=0xdeadface"abcd"-12'filename'
731 .RE
732 .RE
733 .TP
734 .BI dedupe_percentage \fR=\fPint
735 If set, fio will generate this percentage of identical buffers when writing.
736 These buffers will be naturally dedupable. The contents of the buffers depend
737 on what other buffer compression settings have been set. It's possible to have
738 the individual buffers either fully compressible, or not at all. This option
739 only controls the distribution of unique buffers.
740 .TP
741 .BI nrfiles \fR=\fPint
742 Number of files to use for this job.  Default: 1.
743 .TP
744 .BI openfiles \fR=\fPint
745 Number of files to keep open at the same time.  Default: \fBnrfiles\fR.
746 .TP
747 .BI file_service_type \fR=\fPstr
748 Defines how files to service are selected.  The following types are defined:
749 .RS
750 .RS
751 .TP
752 .B random
753 Choose a file at random.
754 .TP
755 .B roundrobin
756 Round robin over opened files (default).
757 .TP
758 .B sequential
759 Do each file in the set sequentially.
760 .TP
761 .B zipf
762 Use a zipfian distribution to decide what file to access.
763 .TP
764 .B pareto
765 Use a pareto distribution to decide what file to access.
766 .TP
767 .B normal
768 Use a Gaussian (normal) distribution to decide what file to access.
769 .TP
770 .B gauss
771 Alias for normal.
772 .RE
773 .P
774 For \fBrandom\fR, \fBroundrobin\fR, and \fBsequential\fR, a postfix can be
775 appended to tell fio how many I/Os to issue before switching to a new file.
776 For example, specifying \fBfile_service_type=random:8\fR would cause fio to
777 issue \fI8\fR I/Os before selecting a new file at random. For the non-uniform
778 distributions, a floating point postfix can be given to influence how the
779 distribution is skewed. See \fBrandom_distribution\fR for a description of how
780 that would work.
781 .RE
782 .TP
783 .BI ioengine \fR=\fPstr
784 Defines how the job issues I/O.  The following types are defined:
785 .RS
786 .RS
787 .TP
788 .B sync
789 Basic \fBread\fR\|(2) or \fBwrite\fR\|(2) I/O.  \fBfseek\fR\|(2) is used to
790 position the I/O location.
791 .TP
792 .B psync
793 Basic \fBpread\fR\|(2) or \fBpwrite\fR\|(2) I/O.
794 Default on all supported operating systems except for Windows.
795 .TP
796 .B vsync
797 Basic \fBreadv\fR\|(2) or \fBwritev\fR\|(2) I/O. Will emulate queuing by
798 coalescing adjacent IOs into a single submission.
799 .TP
800 .B pvsync
801 Basic \fBpreadv\fR\|(2) or \fBpwritev\fR\|(2) I/O.
802 .TP
803 .B pvsync2
804 Basic \fBpreadv2\fR\|(2) or \fBpwritev2\fR\|(2) I/O.
805 .TP
806 .B libaio
807 Linux native asynchronous I/O. This ioengine defines engine specific options.
808 .TP
809 .B posixaio
810 POSIX asynchronous I/O using \fBaio_read\fR\|(3) and \fBaio_write\fR\|(3).
811 .TP
812 .B solarisaio
813 Solaris native asynchronous I/O.
814 .TP
815 .B windowsaio
816 Windows native asynchronous I/O. Default on Windows.
817 .TP
818 .B mmap
819 File is memory mapped with \fBmmap\fR\|(2) and data copied using
820 \fBmemcpy\fR\|(3).
821 .TP
822 .B splice
823 \fBsplice\fR\|(2) is used to transfer the data and \fBvmsplice\fR\|(2) to
824 transfer data from user-space to the kernel.
825 .TP
826 .B sg
827 SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if
828 the target is an sg character device, we use \fBread\fR\|(2) and
829 \fBwrite\fR\|(2) for asynchronous I/O.
830 .TP
831 .B null
832 Doesn't transfer any data, just pretends to.  Mainly used to exercise \fBfio\fR
833 itself and for debugging and testing purposes.
834 .TP
835 .B net
836 Transfer over the network.  The protocol to be used can be defined with the
837 \fBprotocol\fR parameter.  Depending on the protocol, \fBfilename\fR,
838 \fBhostname\fR, \fBport\fR, or \fBlisten\fR must be specified.
839 This ioengine defines engine specific options.
840 .TP
841 .B netsplice
842 Like \fBnet\fR, but uses \fBsplice\fR\|(2) and \fBvmsplice\fR\|(2) to map data
843 and send/receive. This ioengine defines engine specific options.
844 .TP
845 .B cpuio
846 Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and
847 \fBcpuchunks\fR parameters. A job never finishes unless there is at least one
848 non-cpuio job.
849 .TP
850 .B guasi
851 The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface
852 approach to asynchronous I/O.
853 .br
854 See <http://www.xmailserver.org/guasi\-lib.html>.
855 .TP
856 .B rdma
857 The RDMA I/O engine supports both RDMA memory semantics (RDMA_WRITE/RDMA_READ)
858 and channel semantics (Send/Recv) for the InfiniBand, RoCE and iWARP protocols.
859 .TP
860 .B external
861 Loads an external I/O engine object file.  Append the engine filename as
862 `:\fIenginepath\fR'.
863 .TP
864 .B falloc
865    IO engine that does regular linux native fallocate call to simulate data
866 transfer as fio ioengine
867 .br
868   DDIR_READ  does fallocate(,mode = FALLOC_FL_KEEP_SIZE,)
869 .br
870   DIR_WRITE does fallocate(,mode = 0)
871 .br
873 .TP
874 .B e4defrag
875 IO engine that does regular EXT4_IOC_MOVE_EXT ioctls to simulate defragment activity
876 request to DDIR_WRITE event
877 .TP
878 .B rbd
879 IO engine supporting direct access to Ceph Rados Block Devices (RBD) via librbd
880 without the need to use the kernel rbd driver. This ioengine defines engine specific
881 options.
882 .TP
883 .B gfapi
884 Using Glusterfs libgfapi sync interface to direct access to Glusterfs volumes without
885 having to go through FUSE. This ioengine defines engine specific
886 options.
887 .TP
888 .B gfapi_async
889 Using Glusterfs libgfapi async interface to direct access to Glusterfs volumes without
890 having to go through FUSE. This ioengine defines engine specific
891 options.
892 .TP
893 .B libhdfs
894 Read and write through Hadoop (HDFS).  The \fBfilename\fR option is used to
895 specify host,port of the hdfs name-node to connect. This engine interprets
896 offsets a little differently. In HDFS, files once created cannot be modified.
897 So random writes are not possible. To imitate this, libhdfs engine expects
898 bunch of small files to be created over HDFS, and engine will randomly pick a
899 file out of those files based on the offset generated by fio backend. (see the
900 example job file to create such files, use rw=write option). Please note, you
901 might want to set necessary environment variables to work with hdfs/libhdfs
902 properly.
903 .TP
904 .B mtd
905 Read, write and erase an MTD character device (e.g., /dev/mtd0). Discards are
906 treated as erases. Depending on the underlying device type, the I/O may have
907 to go in a certain pattern, e.g., on NAND, writing sequentially to erase blocks
908 and discarding before overwriting. The trimwrite mode works well for this
909 constraint.
910 .TP
911 .B pmemblk
912 Read and write using filesystem DAX to a file on a filesystem mounted with
913 DAX on a persistent memory device through the NVML libpmemblk library.
914 .TP
915 .B dev-dax
916 Read and write using device DAX to a persistent memory device
917 (e.g., /dev/dax0.0) through the NVML libpmem library.
918 .RE
919 .P
920 .RE
921 .TP
922 .BI iodepth \fR=\fPint
923 Number of I/O units to keep in flight against the file. Note that increasing
924 iodepth beyond 1 will not affect synchronous ioengines (except for small
925 degress when verify_async is in use). Even async engines may impose OS
926 restrictions causing the desired depth not to be achieved.  This may happen on
927 Linux when using libaio and not setting \fBdirect\fR=1, since buffered IO is
928 not async on that OS. Keep an eye on the IO depth distribution in the
929 fio output to verify that the achieved depth is as expected. Default: 1.
930 .TP
931 .BI iodepth_batch \fR=\fPint "\fR,\fP iodepth_batch_submit" \fR=\fPint
932 This defines how many pieces of IO to submit at once. It defaults to 1
933 which means that we submit each IO as soon as it is available, but can
934 be raised to submit bigger batches of IO at the time. If it is set to 0
935 the \fBiodepth\fR value will be used.
936 .TP
937 .BI iodepth_batch_complete_min \fR=\fPint "\fR,\fP iodepth_batch_complete" \fR=\fPint
938 This defines how many pieces of IO to retrieve at once. It defaults to 1 which
939  means that we'll ask for a minimum of 1 IO in the retrieval process from the
940 kernel. The IO retrieval will go on until we hit the limit set by
941 \fBiodepth_low\fR. If this variable is set to 0, then fio will always check for
942 completed events before queuing more IO. This helps reduce IO latency, at the
943 cost of more retrieval system calls.
944 .TP
945 .BI iodepth_batch_complete_max \fR=\fPint
946 This defines maximum pieces of IO to
947 retrieve at once. This variable should be used along with
948 \fBiodepth_batch_complete_min\fR=int variable, specifying the range
949 of min and max amount of IO which should be retrieved. By default
950 it is equal to \fBiodepth_batch_complete_min\fR value.
952 Example #1:
953 .RS
954 .RS
955 \fBiodepth_batch_complete_min\fR=1
956 .LP
957 \fBiodepth_batch_complete_max\fR=<iodepth>
958 .RE
960 which means that we will retrieve at least 1 IO and up to the
961 whole submitted queue depth. If none of IO has been completed
962 yet, we will wait.
964 Example #2:
965 .RS
966 \fBiodepth_batch_complete_min\fR=0
967 .LP
968 \fBiodepth_batch_complete_max\fR=<iodepth>
969 .RE
971 which means that we can retrieve up to the whole submitted
972 queue depth, but if none of IO has been completed yet, we will
973 NOT wait and immediately exit the system call. In this example
974 we simply do polling.
975 .RE
976 .TP
977 .BI iodepth_low \fR=\fPint
978 Low watermark indicating when to start filling the queue again.  Default:
979 \fBiodepth\fR.
980 .TP
981 .BI io_submit_mode \fR=\fPstr
982 This option controls how fio submits the IO to the IO engine. The default is
983 \fBinline\fR, which means that the fio job threads submit and reap IO directly.
984 If set to \fBoffload\fR, the job threads will offload IO submission to a
985 dedicated pool of IO threads. This requires some coordination and thus has a
986 bit of extra overhead, especially for lower queue depth IO where it can
987 increase latencies. The benefit is that fio can manage submission rates
988 independently of the device completion rates. This avoids skewed latency
989 reporting if IO gets back up on the device side (the coordinated omission
990 problem).
991 .TP
992 .BI direct \fR=\fPbool
993 If true, use non-buffered I/O (usually O_DIRECT).  Default: false.
994 .TP
995 .BI atomic \fR=\fPbool
996 If value is true, attempt to use atomic direct IO. Atomic writes are guaranteed
997 to be stable once acknowledged by the operating system. Only Linux supports
998 O_ATOMIC right now.
999 .TP
1000 .BI buffered \fR=\fPbool
1001 If true, use buffered I/O.  This is the opposite of the \fBdirect\fR parameter.
1002 Default: true.
1003 .TP
1004 .BI offset \fR=\fPint
1005 Start I/O at the provided offset in the file, given as either a fixed size in
1006 bytes or a percentage. If a percentage is given, the next \fBblockalign\fR-ed
1007 offset will be used. Data before the given offset will not be touched. This
1008 effectively caps the file size at (real_size - offset). Can be combined with
1009 \fBsize\fR to constrain the start and end range of the I/O workload. A percentage
1010 can be specified by a number between 1 and 100 followed by '%', for example,
1011 offset=20% to specify 20%.
1012 .TP
1013 .BI offset_increment \fR=\fPint
1014 If this is provided, then the real offset becomes the
1015 offset + offset_increment * thread_number, where the thread number is a
1016 counter that starts at 0 and is incremented for each sub-job (i.e. when
1017 numjobs option is specified). This option is useful if there are several jobs
1018 which are intended to operate on a file in parallel disjoint segments, with
1019 even spacing between the starting points.
1020 .TP
1021 .BI number_ios \fR=\fPint
1022 Fio will normally perform IOs until it has exhausted the size of the region
1023 set by \fBsize\fR, or if it exhaust the allocated time (or hits an error
1024 condition). With this setting, the range/size can be set independently of
1025 the number of IOs to perform. When fio reaches this number, it will exit
1026 normally and report status. Note that this does not extend the amount
1027 of IO that will be done, it will only stop fio if this condition is met
1028 before other end-of-job criteria.
1029 .TP
1030 .BI fsync \fR=\fPint
1031 How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data.  If
1032 0, don't sync.  Default: 0.
1033 .TP
1034 .BI fdatasync \fR=\fPint
1035 Like \fBfsync\fR, but uses \fBfdatasync\fR\|(2) instead to only sync the
1036 data parts of the file. Default: 0.
1037 .TP
1038 .BI write_barrier \fR=\fPint
1039 Make every Nth write a barrier write.
1040 .TP
1041 .BI sync_file_range \fR=\fPstr:int
1042 Use \fBsync_file_range\fR\|(2) for every \fRval\fP number of write operations. Fio will
1043 track range of writes that have happened since the last \fBsync_file_range\fR\|(2) call.
1044 \fRstr\fP can currently be one or more of:
1045 .RS
1046 .TP
1047 .B wait_before
1049 .TP
1050 .B write
1052 .TP
1053 .B wait_after
1055 .TP
1056 .RE
1057 .P
1058 So if you do sync_file_range=wait_before,write:8, fio would use
1060 Also see the \fBsync_file_range\fR\|(2) man page.  This option is Linux specific.
1061 .TP
1062 .BI overwrite \fR=\fPbool
1063 If writing, setup the file first and do overwrites.  Default: false.
1064 .TP
1065 .BI end_fsync \fR=\fPbool
1066 Sync file contents when a write stage has completed.  Default: false.
1067 .TP
1068 .BI fsync_on_close \fR=\fPbool
1069 If true, sync file contents on close.  This differs from \fBend_fsync\fR in that
1070 it will happen on every close, not just at the end of the job.  Default: false.
1071 .TP
1072 .BI rwmixread \fR=\fPint
1073 Percentage of a mixed workload that should be reads. Default: 50.
1074 .TP
1075 .BI rwmixwrite \fR=\fPint
1076 Percentage of a mixed workload that should be writes.  If \fBrwmixread\fR and
1077 \fBrwmixwrite\fR are given and do not sum to 100%, the latter of the two
1078 overrides the first. This may interfere with a given rate setting, if fio is
1079 asked to limit reads or writes to a certain rate. If that is the case, then
1080 the distribution may be skewed. Default: 50.
1081 .TP
1082 .BI random_distribution \fR=\fPstr:float
1083 By default, fio will use a completely uniform random distribution when asked
1084 to perform random IO. Sometimes it is useful to skew the distribution in
1085 specific ways, ensuring that some parts of the data is more hot than others.
1086 Fio includes the following distribution models:
1087 .RS
1088 .TP
1089 .B random
1090 Uniform random distribution
1091 .TP
1092 .B zipf
1093 Zipf distribution
1094 .TP
1095 .B pareto
1096 Pareto distribution
1097 .TP
1098 .B normal
1099 Normal (Gaussian) distribution
1100 .TP
1101 .B zoned
1102 Zoned random distribution
1103 .TP
1104 .RE
1105 When using a \fBzipf\fR or \fBpareto\fR distribution, an input value is also
1106 needed to define the access pattern. For \fBzipf\fR, this is the zipf theta.
1107 For \fBpareto\fR, it's the pareto power. Fio includes a test program, genzipf,
1108 that can be used visualize what the given input values will yield in terms of
1109 hit rates. If you wanted to use \fBzipf\fR with a theta of 1.2, you would use
1110 random_distribution=zipf:1.2 as the option. If a non-uniform model is used,
1111 fio will disable use of the random map. For the \fBnormal\fR distribution, a
1112 normal (Gaussian) deviation is supplied as a value between 0 and 100.
1113 .P
1114 .RS
1115 For a \fBzoned\fR distribution, fio supports specifying percentages of IO
1116 access that should fall within what range of the file or device. For example,
1117 given a criteria of:
1118 .P
1119 .RS
1120 60% of accesses should be to the first 10%
1121 .RE
1122 .RS
1123 30% of accesses should be to the next 20%
1124 .RE
1125 .RS
1126 8% of accesses should be to to the next 30%
1127 .RE
1128 .RS
1129 2% of accesses should be to the next 40%
1130 .RE
1131 .P
1132 we can define that through zoning of the random accesses. For the above
1133 example, the user would do:
1134 .P
1135 .RS
1136 .B random_distribution=zoned:60/10:30/20:8/30:2/40
1137 .RE
1138 .P
1139 similarly to how \fBbssplit\fR works for setting ranges and percentages of block
1140 sizes. Like \fBbssplit\fR, it's possible to specify separate zones for reads,
1141 writes, and trims. If just one set is given, it'll apply to all of them.
1142 .RE
1143 .TP
1144 .BI percentage_random \fR=\fPint[,int][,int]
1145 For a random workload, set how big a percentage should be random. This defaults
1146 to 100%, in which case the workload is fully random. It can be set from
1147 anywhere from 0 to 100.  Setting it to 0 would make the workload fully
1148 sequential. It is possible to set different values for reads, writes, and
1149 trim. To do so, simply use a comma separated list. See \fBblocksize\fR.
1150 .TP
1151 .B norandommap
1152 Normally \fBfio\fR will cover every block of the file when doing random I/O. If
1153 this parameter is given, a new offset will be chosen without looking at past
1154 I/O history.  This parameter is mutually exclusive with \fBverify\fR.
1155 .TP
1156 .BI softrandommap \fR=\fPbool
1157 See \fBnorandommap\fR. If fio runs with the random block map enabled and it
1158 fails to allocate the map, if this option is set it will continue without a
1159 random block map. As coverage will not be as complete as with random maps, this
1160 option is disabled by default.
1161 .TP
1162 .BI random_generator \fR=\fPstr
1163 Fio supports the following engines for generating IO offsets for random IO:
1164 .RS
1165 .TP
1166 .B tausworthe
1167 Strong 2^88 cycle random number generator
1168 .TP
1169 .B lfsr
1170 Linear feedback shift register generator
1171 .TP
1172 .B tausworthe64
1173 Strong 64-bit 2^258 cycle random number generator
1174 .TP
1175 .RE
1176 .P
1177 Tausworthe is a strong random number generator, but it requires tracking on the
1178 side if we want to ensure that blocks are only read or written once. LFSR
1179 guarantees that we never generate the same offset twice, and it's also less
1180 computationally expensive. It's not a true random generator, however, though
1181 for IO purposes it's typically good enough. LFSR only works with single block
1182 sizes, not with workloads that use multiple block sizes. If used with such a
1183 workload, fio may read or write some blocks multiple times. The default
1184 value is tausworthe, unless the required space exceeds 2^32 blocks. If it does,
1185 then tausworthe64 is selected automatically.
1186 .TP
1187 .BI nice \fR=\fPint
1188 Run job with given nice value.  See \fBnice\fR\|(2).
1189 .TP
1190 .BI prio \fR=\fPint
1191 Set I/O priority value of this job between 0 (highest) and 7 (lowest).  See
1192 \fBionice\fR\|(1).
1193 .TP
1194 .BI prioclass \fR=\fPint
1195 Set I/O priority class.  See \fBionice\fR\|(1).
1196 .TP
1197 .BI thinktime \fR=\fPint
1198 Stall job for given number of microseconds between issuing I/Os.
1199 .TP
1200 .BI thinktime_spin \fR=\fPint
1201 Pretend to spend CPU time for given number of microseconds, sleeping the rest
1202 of the time specified by \fBthinktime\fR.  Only valid if \fBthinktime\fR is set.
1203 .TP
1204 .BI thinktime_blocks \fR=\fPint
1205 Only valid if thinktime is set - control how many blocks to issue, before
1206 waiting \fBthinktime\fR microseconds. If not set, defaults to 1 which will
1207 make fio wait \fBthinktime\fR microseconds after every block. This
1208 effectively makes any queue depth setting redundant, since no more than 1 IO
1209 will be queued before we have to complete it and do our thinktime. In other
1210 words, this setting effectively caps the queue depth if the latter is larger.
1211 Default: 1.
1212 .TP
1213 .BI rate \fR=\fPint[,int][,int]
1214 Cap bandwidth used by this job. The number is in bytes/sec, the normal postfix
1215 rules apply. You can use \fBrate\fR=500k to limit reads and writes to 500k each,
1216 or you can specify reads, write, and trim limits separately.
1217 Using \fBrate\fR=1m,500k would
1218 limit reads to 1MiB/sec and writes to 500KiB/sec. Capping only reads or writes
1219 can be done with \fBrate\fR=,500k or \fBrate\fR=500k,. The former will only
1220 limit writes (to 500KiB/sec), the latter will only limit reads.
1221 .TP
1222 .BI rate_min \fR=\fPint[,int][,int]
1223 Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth.
1224 Failing to meet this requirement will cause the job to exit. The same format
1225 as \fBrate\fR is used for read vs write vs trim separation.
1226 .TP
1227 .BI rate_iops \fR=\fPint[,int][,int]
1228 Cap the bandwidth to this number of IOPS. Basically the same as rate, just
1229 specified independently of bandwidth. The same format as \fBrate\fR is used for
1230 read vs write vs trim separation. If \fBblocksize\fR is a range, the smallest block
1231 size is used as the metric.
1232 .TP
1233 .BI rate_iops_min \fR=\fPint[,int][,int]
1234 If this rate of I/O is not met, the job will exit. The same format as \fBrate\fR
1235 is used for read vs write vs trim separation.
1236 .TP
1237 .BI rate_process \fR=\fPstr
1238 This option controls how fio manages rated IO submissions. The default is
1239 \fBlinear\fR, which submits IO in a linear fashion with fixed delays between
1240 IOs that gets adjusted based on IO completion rates. If this is set to
1241 \fBpoisson\fR, fio will submit IO based on a more real world random request
1242 flow, known as the Poisson process
1243 (https://en.wikipedia.org/wiki/Poisson_process). The lambda will be
1244 10^6 / IOPS for the given workload.
1245 .TP
1246 .BI rate_cycle \fR=\fPint
1247 Average bandwidth for \fBrate\fR and \fBrate_min\fR over this number of
1248 milliseconds.  Default: 1000ms.
1249 .TP
1250 .BI latency_target \fR=\fPint
1251 If set, fio will attempt to find the max performance point that the given
1252 workload will run at while maintaining a latency below this target. The
1253 values is given in microseconds. See \fBlatency_window\fR and
1254 \fBlatency_percentile\fR.
1255 .TP
1256 .BI latency_window \fR=\fPint
1257 Used with \fBlatency_target\fR to specify the sample window that the job
1258 is run at varying queue depths to test the performance. The value is given
1259 in microseconds.
1260 .TP
1261 .BI latency_percentile \fR=\fPfloat
1262 The percentage of IOs that must fall within the criteria specified by
1263 \fBlatency_target\fR and \fBlatency_window\fR. If not set, this defaults
1264 to 100.0, meaning that all IOs must be equal or below to the value set
1265 by \fBlatency_target\fR.
1266 .TP
1267 .BI max_latency \fR=\fPint
1268 If set, fio will exit the job if it exceeds this maximum latency. It will exit
1269 with an ETIME error.
1270 .TP
1271 .BI cpumask \fR=\fPint
1272 Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job
1273 may run on.  See \fBsched_setaffinity\fR\|(2).
1274 .TP
1275 .BI cpus_allowed \fR=\fPstr
1276 Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers.
1277 .TP
1278 .BI cpus_allowed_policy \fR=\fPstr
1279 Set the policy of how fio distributes the CPUs specified by \fBcpus_allowed\fR
1280 or \fBcpumask\fR. Two policies are supported:
1281 .RS
1282 .RS
1283 .TP
1284 .B shared
1285 All jobs will share the CPU set specified.
1286 .TP
1287 .B split
1288 Each job will get a unique CPU from the CPU set.
1289 .RE
1290 .P
1291 \fBshared\fR is the default behaviour, if the option isn't specified. If
1292 \fBsplit\fR is specified, then fio will assign one cpu per job. If not enough
1293 CPUs are given for the jobs listed, then fio will roundrobin the CPUs in
1294 the set.
1295 .RE
1296 .P
1297 .TP
1298 .BI numa_cpu_nodes \fR=\fPstr
1299 Set this job running on specified NUMA nodes' CPUs. The arguments allow
1300 comma delimited list of cpu numbers, A-B ranges, or 'all'.
1301 .TP
1302 .BI numa_mem_policy \fR=\fPstr
1303 Set this job's memory policy and corresponding NUMA nodes. Format of
1304 the arguments:
1305 .RS
1306 .TP
1307 .B <mode>[:<nodelist>]
1308 .TP
1309 .B mode
1310 is one of the following memory policy:
1311 .TP
1312 .B default, prefer, bind, interleave, local
1313 .TP
1314 .RE
1315 For \fBdefault\fR and \fBlocal\fR memory policy, no \fBnodelist\fR is
1316 needed to be specified. For \fBprefer\fR, only one node is
1317 allowed. For \fBbind\fR and \fBinterleave\fR, \fBnodelist\fR allows
1318 comma delimited list of numbers, A-B ranges, or 'all'.
1319 .TP
1320 .BI startdelay \fR=\fPirange
1321 Delay start of job for the specified number of seconds. Supports all time
1322 suffixes to allow specification of hours, minutes, seconds and
1323 milliseconds - seconds are the default if a unit is omitted.
1324 Can be given as a range which causes each thread to choose randomly out of the
1325 range.
1326 .TP
1327 .BI runtime \fR=\fPint
1328 Terminate processing after the specified number of seconds.
1329 .TP
1330 .B time_based
1331 If given, run for the specified \fBruntime\fR duration even if the files are
1332 completely read or written. The same workload will be repeated as many times
1333 as \fBruntime\fR allows.
1334 .TP
1335 .BI ramp_time \fR=\fPint
1336 If set, fio will run the specified workload for this amount of time before
1337 logging any performance numbers. Useful for letting performance settle before
1338 logging results, thus minimizing the runtime required for stable results. Note
1339 that the \fBramp_time\fR is considered lead in time for a job, thus it will
1340 increase the total runtime if a special timeout or runtime is specified.
1341 .TP
1342 .BI steadystate \fR=\fPstr:float "\fR,\fP ss" \fR=\fPstr:float
1343 Define the criterion and limit for assessing steady state performance. The
1344 first parameter designates the criterion whereas the second parameter sets the
1345 threshold. When the criterion falls below the threshold for the specified
1346 duration, the job will stop. For example, iops_slope:0.1% will direct fio
1347 to terminate the job when the least squares regression slope falls below 0.1%
1348 of the mean IOPS. If group_reporting is enabled this will apply to all jobs in
1349 the group. All assessments are carried out using only data from the rolling
1350 collection window. Threshold limits can be expressed as a fixed value or as a
1351 percentage of the mean in the collection window. Below are the available steady
1352 state assessment criteria.
1353 .RS
1354 .RS
1355 .TP
1356 .B iops
1357 Collect IOPS data. Stop the job if all individual IOPS measurements are within
1358 the specified limit of the mean IOPS (e.g., iops:2 means that all individual
1359 IOPS values must be within 2 of the mean, whereas iops:0.2% means that all
1360 individual IOPS values must be within 0.2% of the mean IOPS to terminate the
1361 job).
1362 .TP
1363 .B iops_slope
1364 Collect IOPS data and calculate the least squares regression slope. Stop the
1365 job if the slope falls below the specified limit.
1366 .TP
1367 .B bw
1368 Collect bandwidth data. Stop the job if all individual bandwidth measurements
1369 are within the specified limit of the mean bandwidth.
1370 .TP
1371 .B bw_slope
1372 Collect bandwidth data and calculate the least squares regression slope. Stop
1373 the job if the slope falls below the specified limit.
1374 .RE
1375 .RE
1376 .TP
1377 .BI steadystate_duration \fR=\fPtime "\fR,\fP ss_dur" \fR=\fPtime
1378 A rolling window of this duration will be used to judge whether steady state
1379 has been reached. Data will be collected once per second. The default is 0
1380 which disables steady state detection.
1381 .TP
1382 .BI steadystate_ramp_time \fR=\fPtime "\fR,\fP ss_ramp" \fR=\fPtime
1383 Allow the job to run for the specified duration before beginning data collection
1384 for checking the steady state job termination criterion. The default is 0.
1385 .TP
1386 .BI invalidate \fR=\fPbool
1387 Invalidate buffer-cache for the file prior to starting I/O.  Default: true.
1388 .TP
1389 .BI sync \fR=\fPbool
1390 Use synchronous I/O for buffered writes.  For the majority of I/O engines,
1391 this means using O_SYNC.  Default: false.
1392 .TP
1393 .BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
1394 Allocation method for I/O unit buffer.  Allowed values are:
1395 .RS
1396 .RS
1397 .TP
1398 .B malloc
1399 Allocate memory with \fBmalloc\fR\|(3). Default memory type.
1400 .TP
1401 .B shm
1402 Use shared memory buffers allocated through \fBshmget\fR\|(2).
1403 .TP
1404 .B shmhuge
1405 Same as \fBshm\fR, but use huge pages as backing.
1406 .TP
1407 .B mmap
1408 Use \fBmmap\fR\|(2) for allocation.  Uses anonymous memory unless a filename
1409 is given after the option in the format `:\fIfile\fR'.
1410 .TP
1411 .B mmaphuge
1412 Same as \fBmmap\fR, but use huge files as backing.
1413 .TP
1414 .B mmapshared
1415 Same as \fBmmap\fR, but use a MMAP_SHARED mapping.
1416 .TP
1417 .B cudamalloc
1418 Use GPU memory as the buffers for GPUDirect RDMA benchmark. The ioengine must be \fBrdma\fR.
1419 .RE
1420 .P
1421 The amount of memory allocated is the maximum allowed \fBblocksize\fR for the
1422 job multiplied by \fBiodepth\fR.  For \fBshmhuge\fR or \fBmmaphuge\fR to work,
1423 the system must have free huge pages allocated.  \fBmmaphuge\fR also needs to
1424 have hugetlbfs mounted, and \fIfile\fR must point there. At least on Linux,
1425 huge pages must be manually allocated. See \fB/proc/sys/vm/nr_hugehages\fR
1426 and the documentation for that. Normally you just need to echo an appropriate
1427 number, eg echoing 8 will ensure that the OS has 8 huge pages ready for
1428 use.
1429 .RE
1430 .TP
1431 .BI iomem_align \fR=\fPint "\fR,\fP mem_align" \fR=\fPint
1432 This indicates the memory alignment of the IO memory buffers. Note that the
1433 given alignment is applied to the first IO unit buffer, if using \fBiodepth\fR
1434 the alignment of the following buffers are given by the \fBbs\fR used. In
1435 other words, if using a \fBbs\fR that is a multiple of the page sized in the
1436 system, all buffers will be aligned to this value. If using a \fBbs\fR that
1437 is not page aligned, the alignment of subsequent IO memory buffers is the
1438 sum of the \fBiomem_align\fR and \fBbs\fR used.
1439 .TP
1440 .BI hugepage\-size \fR=\fPint
1441 Defines the size of a huge page.  Must be at least equal to the system setting.
1442 Should be a multiple of 1MiB. Default: 4MiB.
1443 .TP
1444 .B exitall
1445 Terminate all jobs when one finishes.  Default: wait for each job to finish.
1446 .TP
1447 .B exitall_on_error \fR=\fPbool
1448 Terminate all jobs if one job finishes in error.  Default: wait for each job
1449 to finish.
1450 .TP
1451 .BI bwavgtime \fR=\fPint
1452 Average bandwidth calculations over the given time in milliseconds. If the job
1453 also does bandwidth logging through \fBwrite_bw_log\fR, then the minimum of
1454 this option and \fBlog_avg_msec\fR will be used.  Default: 500ms.
1455 .TP
1456 .BI iopsavgtime \fR=\fPint
1457 Average IOPS calculations over the given time in milliseconds. If the job
1458 also does IOPS logging through \fBwrite_iops_log\fR, then the minimum of
1459 this option and \fBlog_avg_msec\fR will be used.  Default: 500ms.
1460 .TP
1461 .BI create_serialize \fR=\fPbool
1462 If true, serialize file creation for the jobs.  Default: true.
1463 .TP
1464 .BI create_fsync \fR=\fPbool
1465 \fBfsync\fR\|(2) data file after creation.  Default: true.
1466 .TP
1467 .BI create_on_open \fR=\fPbool
1468 If true, the files are not created until they are opened for IO by the job.
1469 .TP
1470 .BI create_only \fR=\fPbool
1471 If true, fio will only run the setup phase of the job. If files need to be
1472 laid out or updated on disk, only that will be done. The actual job contents
1473 are not executed.
1474 .TP
1475 .BI allow_file_create \fR=\fPbool
1476 If true, fio is permitted to create files as part of its workload. This is
1477 the default behavior. If this option is false, then fio will error out if the
1478 files it needs to use don't already exist. Default: true.
1479 .TP
1480 .BI allow_mounted_write \fR=\fPbool
1481 If this isn't set, fio will abort jobs that are destructive (eg that write)
1482 to what appears to be a mounted device or partition. This should help catch
1483 creating inadvertently destructive tests, not realizing that the test will
1484 destroy data on the mounted file system. Default: false.
1485 .TP
1486 .BI pre_read \fR=\fPbool
1487 If this is given, files will be pre-read into memory before starting the given
1488 IO operation. This will also clear the \fR \fBinvalidate\fR flag, since it is
1489 pointless to pre-read and then drop the cache. This will only work for IO
1490 engines that are seekable, since they allow you to read the same data
1491 multiple times. Thus it will not work on eg network or splice IO.
1492 .TP
1493 .BI unlink \fR=\fPbool
1494 Unlink job files when done.  Default: false.
1495 .TP
1496 .BI unlink_each_loop \fR=\fPbool
1497 Unlink job files after each iteration or loop.  Default: false.
1498 .TP
1499 .BI loops \fR=\fPint
1500 Specifies the number of iterations (runs of the same workload) of this job.
1501 Default: 1.
1502 .TP
1503 .BI verify_only \fR=\fPbool
1504 Do not perform the specified workload, only verify data still matches previous
1505 invocation of this workload. This option allows one to check data multiple
1506 times at a later date without overwriting it. This option makes sense only for
1507 workloads that write data, and does not support workloads with the
1508 \fBtime_based\fR option set.
1509 .TP
1510 .BI do_verify \fR=\fPbool
1511 Run the verify phase after a write phase.  Only valid if \fBverify\fR is set.
1512 Default: true.
1513 .TP
1514 .BI verify \fR=\fPstr
1515 Method of verifying file contents after each iteration of the job. Each
1516 verification method also implies verification of special header, which is
1517 written to the beginning of each block. This header also includes meta
1518 information, like offset of the block, block number, timestamp when block
1519 was written, etc.  \fBverify\fR=str can be combined with \fBverify_pattern\fR=str
1520 option.  The allowed values are:
1521 .RS
1522 .RS
1523 .TP
1524 .B md5 crc16 crc32 crc32c crc32c-intel crc64 crc7 sha256 sha512 sha1 sha3-224 sha3-256 sha3-384 sha3-512 xxhash
1525 Store appropriate checksum in the header of each block. crc32c-intel is
1526 hardware accelerated SSE4.2 driven, falls back to regular crc32c if
1527 not supported by the system.
1528 .TP
1529 .B meta
1530 This option is deprecated, since now meta information is included in generic
1531 verification header and meta verification happens by default.  For detailed
1532 information see the description of the \fBverify\fR=str setting. This option
1533 is kept because of compatibility's sake with old configurations. Do not use it.
1534 .TP
1535 .B pattern
1536 Verify a strict pattern. Normally fio includes a header with some basic
1537 information and checksumming, but if this option is set, only the
1538 specific pattern set with \fBverify_pattern\fR is verified.
1539 .TP
1540 .B null
1541 Pretend to verify.  Used for testing internals.
1542 .RE
1544 This option can be used for repeated burn-in tests of a system to make sure
1545 that the written data is also correctly read back. If the data direction given
1546 is a read or random read, fio will assume that it should verify a previously
1547 written file. If the data direction includes any form of write, the verify will
1548 be of the newly written data.
1549 .RE
1550 .TP
1551 .BI verifysort \fR=\fPbool
1552 If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to
1553 read them back in a sorted manner.  Default: true.
1554 .TP
1555 .BI verifysort_nr \fR=\fPint
1556 Pre-load and sort verify blocks for a read workload.
1557 .TP
1558 .BI verify_offset \fR=\fPint
1559 Swap the verification header with data somewhere else in the block before
1560 writing.  It is swapped back before verifying.
1561 .TP
1562 .BI verify_interval \fR=\fPint
1563 Write the verification header for this number of bytes, which should divide
1564 \fBblocksize\fR.  Default: \fBblocksize\fR.
1565 .TP
1566 .BI verify_pattern \fR=\fPstr
1567 If set, fio will fill the io buffers with this pattern. Fio defaults to filling
1568 with totally random bytes, but sometimes it's interesting to fill with a known
1569 pattern for io verification purposes. Depending on the width of the pattern,
1570 fio will fill 1/2/3/4 bytes of the buffer at the time(it can be either a
1571 decimal or a hex number). The verify_pattern if larger than a 32-bit quantity
1572 has to be a hex number that starts with either "0x" or "0X". Use with
1573 \fBverify\fP=str. Also, verify_pattern supports %o format, which means that for
1574 each block offset will be written and then verified back, e.g.:
1575 .RS
1576 .RS
1577 \fBverify_pattern\fR=%o
1578 .RE
1579 Or use combination of everything:
1580 .LP
1581 .RS
1582 \fBverify_pattern\fR=0xff%o"abcd"-21
1583 .RE
1584 .RE
1585 .TP
1586 .BI verify_fatal \fR=\fPbool
1587 If true, exit the job on the first observed verification failure.  Default:
1588 false.
1589 .TP
1590 .BI verify_dump \fR=\fPbool
1591 If set, dump the contents of both the original data block and the data block we
1592 read off disk to files. This allows later analysis to inspect just what kind of
1593 data corruption occurred. Off by default.
1594 .TP
1595 .BI verify_async \fR=\fPint
1596 Fio will normally verify IO inline from the submitting thread. This option
1597 takes an integer describing how many async offload threads to create for IO
1598 verification instead, causing fio to offload the duty of verifying IO contents
1599 to one or more separate threads.  If using this offload option, even sync IO
1600 engines can benefit from using an \fBiodepth\fR setting higher than 1, as it
1601 allows them to have IO in flight while verifies are running.
1602 .TP
1603 .BI verify_async_cpus \fR=\fPstr
1604 Tell fio to set the given CPU affinity on the async IO verification threads.
1605 See \fBcpus_allowed\fP for the format used.
1606 .TP
1607 .BI verify_backlog \fR=\fPint
1608 Fio will normally verify the written contents of a job that utilizes verify
1609 once that job has completed. In other words, everything is written then
1610 everything is read back and verified. You may want to verify continually
1611 instead for a variety of reasons. Fio stores the meta data associated with an
1612 IO block in memory, so for large verify workloads, quite a bit of memory would
1613 be used up holding this meta data. If this option is enabled, fio will write
1614 only N blocks before verifying these blocks.
1615 .TP
1616 .BI verify_backlog_batch \fR=\fPint
1617 Control how many blocks fio will verify if verify_backlog is set. If not set,
1618 will default to the value of \fBverify_backlog\fR (meaning the entire queue is
1619 read back and verified).  If \fBverify_backlog_batch\fR is less than
1620 \fBverify_backlog\fR then not all blocks will be verified,  if
1621 \fBverify_backlog_batch\fR is larger than \fBverify_backlog\fR,  some blocks
1622 will be verified more than once.
1623 .TP
1624 .BI trim_percentage \fR=\fPint
1625 Number of verify blocks to discard/trim.
1626 .TP
1627 .BI trim_verify_zero \fR=\fPbool
1628 Verify that trim/discarded blocks are returned as zeroes.
1629 .TP
1630 .BI trim_backlog \fR=\fPint
1631 Trim after this number of blocks are written.
1632 .TP
1633 .BI trim_backlog_batch \fR=\fPint
1634 Trim this number of IO blocks.
1635 .TP
1636 .BI experimental_verify \fR=\fPbool
1637 Enable experimental verification.
1638 .TP
1639 .BI verify_state_save \fR=\fPbool
1640 When a job exits during the write phase of a verify workload, save its
1641 current state. This allows fio to replay up until that point, if the
1642 verify state is loaded for the verify read phase.
1643 .TP
1644 .BI verify_state_load \fR=\fPbool
1645 If a verify termination trigger was used, fio stores the current write
1646 state of each thread. This can be used at verification time so that fio
1647 knows how far it should verify. Without this information, fio will run
1648 a full verification pass, according to the settings in the job file used.
1649 .TP
1650 .B stonewall "\fR,\fP wait_for_previous"
1651 Wait for preceding jobs in the job file to exit before starting this one.
1652 \fBstonewall\fR implies \fBnew_group\fR.
1653 .TP
1654 .B new_group
1655 Start a new reporting group.  If not given, all jobs in a file will be part
1656 of the same reporting group, unless separated by a stonewall.
1657 .TP
1658 .BI stats \fR=\fPbool
1659 By default, fio collects and shows final output results for all jobs that run.
1660 If this option is set to 0, then fio will ignore it in the final stat output.
1661 .TP
1662 .BI numjobs \fR=\fPint
1663 Number of clones (processes/threads performing the same workload) of this job.
1664 Default: 1.
1665 .TP
1666 .B group_reporting
1667 If set, display per-group reports instead of per-job when \fBnumjobs\fR is
1668 specified.
1669 .TP
1670 .B thread
1671 Use threads created with \fBpthread_create\fR\|(3) instead of processes created
1672 with \fBfork\fR\|(2).
1673 .TP
1674 .BI zonesize \fR=\fPint
1675 Divide file into zones of the specified size in bytes.  See \fBzoneskip\fR.
1676 .TP
1677 .BI zonerange \fR=\fPint
1678 Give size of an IO zone.  See \fBzoneskip\fR.
1679 .TP
1680 .BI zoneskip \fR=\fPint
1681 Skip the specified number of bytes when \fBzonesize\fR bytes of data have been
1682 read.
1683 .TP
1684 .BI write_iolog \fR=\fPstr
1685 Write the issued I/O patterns to the specified file.  Specify a separate file
1686 for each job, otherwise the iologs will be interspersed and the file may be
1687 corrupt.
1688 .TP
1689 .BI read_iolog \fR=\fPstr
1690 Replay the I/O patterns contained in the specified file generated by
1691 \fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file.
1692 .TP
1693 .BI replay_no_stall \fR=\fPint
1694 While replaying I/O patterns using \fBread_iolog\fR the default behavior
1695 attempts to respect timing information between I/Os.  Enabling
1696 \fBreplay_no_stall\fR causes I/Os to be replayed as fast as possible while
1697 still respecting ordering.
1698 .TP
1699 .BI replay_redirect \fR=\fPstr
1700 While replaying I/O patterns using \fBread_iolog\fR the default behavior
1701 is to replay the IOPS onto the major/minor device that each IOP was recorded
1702 from.  Setting \fBreplay_redirect\fR causes all IOPS to be replayed onto the
1703 single specified device regardless of the device it was recorded from.
1704 .TP
1705 .BI replay_align \fR=\fPint
1706 Force alignment of IO offsets and lengths in a trace to this power of 2 value.
1707 .TP
1708 .BI replay_scale \fR=\fPint
1709 Scale sector offsets down by this factor when replaying traces.
1710 .TP
1711 .BI per_job_logs \fR=\fPbool
1712 If set, this generates bw/clat/iops log with per file private filenames. If
1713 not set, jobs with identical names will share the log filename. Default: true.
1714 .TP
1715 .BI write_bw_log \fR=\fPstr
1716 If given, write a bandwidth log for this job. Can be used to store data of the
1717 bandwidth of the jobs in their lifetime. The included fio_generate_plots script
1718 uses gnuplot to turn these text files into nice graphs. See \fBwrite_lat_log\fR
1719 for behaviour of given filename. For this option, the postfix is _bw.x.log,
1720 where x is the index of the job (1..N, where N is the number of jobs). If
1721 \fBper_job_logs\fR is false, then the filename will not include the job index.
1722 See the \fBLOG FILE FORMATS\fR
1723 section.
1724 .TP
1725 .BI write_lat_log \fR=\fPstr
1726 Same as \fBwrite_bw_log\fR, but writes I/O completion latencies.  If no
1727 filename is given with this option, the default filename of
1728 "jobname_type.x.log" is used, where x is the index of the job (1..N, where
1729 N is the number of jobs). Even if the filename is given, fio will still
1730 append the type of log. If \fBper_job_logs\fR is false, then the filename will
1731 not include the job index. See the \fBLOG FILE FORMATS\fR section.
1732 .TP
1733 .BI write_hist_log \fR=\fPstr
1734 Same as \fBwrite_lat_log\fR, but writes I/O completion latency histograms. If
1735 no filename is given with this option, the default filename of
1736 "jobname_clat_hist.x.log" is used, where x is the index of the job (1..N, where
1737 N is the number of jobs). Even if the filename is given, fio will still append
1738 the type of log. If \fBper_job_logs\fR is false, then the filename will not
1739 include the job index. See the \fBLOG FILE FORMATS\fR section.
1740 .TP
1741 .BI write_iops_log \fR=\fPstr
1742 Same as \fBwrite_bw_log\fR, but writes IOPS. If no filename is given with this
1743 option, the default filename of "jobname_type.x.log" is used, where x is the
1744 index of the job (1..N, where N is the number of jobs). Even if the filename
1745 is given, fio will still append the type of log. If \fBper_job_logs\fR is false,
1746 then the filename will not include the job index. See the \fBLOG FILE FORMATS\fR
1747 section.
1748 .TP
1749 .BI log_avg_msec \fR=\fPint
1750 By default, fio will log an entry in the iops, latency, or bw log for every
1751 IO that completes. When writing to the disk log, that can quickly grow to a
1752 very large size. Setting this option makes fio average the each log entry
1753 over the specified period of time, reducing the resolution of the log. See
1754 \fBlog_max_value\fR as well.  Defaults to 0, logging all entries.
1755 .TP
1756 .BI log_max_value \fR=\fPbool
1757 If \fBlog_avg_msec\fR is set, fio logs the average over that window. If you
1758 instead want to log the maximum value, set this option to 1.  Defaults to
1759 0, meaning that averaged values are logged.
1760 .TP
1761 .BI log_hist_msec \fR=\fPint
1762 Same as \fBlog_avg_msec\fR, but logs entries for completion latency histograms.
1763 Computing latency percentiles from averages of intervals using \fBlog_avg_msec\fR
1764 is innacurate. Setting this option makes fio log histogram entries over the
1765 specified period of time, reducing log sizes for high IOPS devices while
1766 retaining percentile accuracy. See \fBlog_hist_coarseness\fR as well. Defaults
1767 to 0, meaning histogram logging is disabled.
1768 .TP
1769 .BI log_hist_coarseness \fR=\fPint
1770 Integer ranging from 0 to 6, defining the coarseness of the resolution of the
1771 histogram logs enabled with \fBlog_hist_msec\fR. For each increment in
1772 coarseness, fio outputs half as many bins. Defaults to 0, for which histogram
1773 logs contain 1216 latency bins. See the \fBLOG FILE FORMATS\fR section.
1774 .TP
1775 .BI log_offset \fR=\fPbool
1776 If this is set, the iolog options will include the byte offset for the IO
1777 entry as well as the other data values.
1778 .TP
1779 .BI log_compression \fR=\fPint
1780 If this is set, fio will compress the IO logs as it goes, to keep the memory
1781 footprint lower. When a log reaches the specified size, that chunk is removed
1782 and compressed in the background. Given that IO logs are fairly highly
1783 compressible, this yields a nice memory savings for longer runs. The downside
1784 is that the compression will consume some background CPU cycles, so it may
1785 impact the run. This, however, is also true if the logging ends up consuming
1786 most of the system memory. So pick your poison. The IO logs are saved
1787 normally at the end of a run, by decompressing the chunks and storing them
1788 in the specified log file. This feature depends on the availability of zlib.
1789 .TP
1790 .BI log_compression_cpus \fR=\fPstr
1791 Define the set of CPUs that are allowed to handle online log compression
1792 for the IO jobs. This can provide better isolation between performance
1793 sensitive jobs, and background compression work.
1794 .TP
1795 .BI log_store_compressed \fR=\fPbool
1796 If set, fio will store the log files in a compressed format. They can be
1797 decompressed with fio, using the \fB\-\-inflate-log\fR command line parameter.
1798 The files will be stored with a \fB\.fz\fR suffix.
1799 .TP
1800 .BI log_unix_epoch \fR=\fPbool
1801 If set, fio will log Unix timestamps to the log files produced by enabling
1802 \fBwrite_type_log\fR for each log type, instead of the default zero-based
1803 timestamps.
1804 .TP
1805 .BI block_error_percentiles \fR=\fPbool
1806 If set, record errors in trim block-sized units from writes and trims and output
1807 a histogram of how many trims it took to get to errors, and what kind of error
1808 was encountered.
1809 .TP
1810 .BI disable_lat \fR=\fPbool
1811 Disable measurements of total latency numbers. Useful only for cutting
1812 back the number of calls to \fBgettimeofday\fR\|(2), as that does impact performance at
1813 really high IOPS rates.  Note that to really get rid of a large amount of these
1814 calls, this option must be used with disable_slat and disable_bw as well.
1815 .TP
1816 .BI disable_clat \fR=\fPbool
1817 Disable measurements of completion latency numbers. See \fBdisable_lat\fR.
1818 .TP
1819 .BI disable_slat \fR=\fPbool
1820 Disable measurements of submission latency numbers. See \fBdisable_lat\fR.
1821 .TP
1822 .BI disable_bw_measurement \fR=\fPbool
1823 Disable measurements of throughput/bandwidth numbers. See \fBdisable_lat\fR.
1824 .TP
1825 .BI lockmem \fR=\fPint
1826 Pin the specified amount of memory with \fBmlock\fR\|(2).  Can be used to
1827 simulate a smaller amount of memory. The amount specified is per worker.
1828 .TP
1829 .BI exec_prerun \fR=\fPstr
1830 Before running the job, execute the specified command with \fBsystem\fR\|(3).
1831 .RS
1832 Output is redirected in a file called \fBjobname.prerun.txt\fR
1833 .RE
1834 .TP
1835 .BI exec_postrun \fR=\fPstr
1836 Same as \fBexec_prerun\fR, but the command is executed after the job completes.
1837 .RS
1838 Output is redirected in a file called \fBjobname.postrun.txt\fR
1839 .RE
1840 .TP
1841 .BI ioscheduler \fR=\fPstr
1842 Attempt to switch the device hosting the file to the specified I/O scheduler.
1843 .TP
1844 .BI disk_util \fR=\fPbool
1845 Generate disk utilization statistics if the platform supports it. Default: true.
1846 .TP
1847 .BI clocksource \fR=\fPstr
1848 Use the given clocksource as the base of timing. The supported options are:
1849 .RS
1850 .TP
1851 .B gettimeofday
1852 \fBgettimeofday\fR\|(2)
1853 .TP
1854 .B clock_gettime
1855 \fBclock_gettime\fR\|(2)
1856 .TP
1857 .B cpu
1858 Internal CPU clock source
1859 .TP
1860 .RE
1861 .P
1862 \fBcpu\fR is the preferred clocksource if it is reliable, as it is very fast
1863 (and fio is heavy on time calls). Fio will automatically use this clocksource
1864 if it's supported and considered reliable on the system it is running on,
1865 unless another clocksource is specifically set. For x86/x86-64 CPUs, this
1866 means supporting TSC Invariant.
1867 .TP
1868 .BI gtod_reduce \fR=\fPbool
1869 Enable all of the \fBgettimeofday\fR\|(2) reducing options (disable_clat, disable_slat,
1870 disable_bw) plus reduce precision of the timeout somewhat to really shrink the
1871 \fBgettimeofday\fR\|(2) call count. With this option enabled, we only do about 0.4% of
1872 the gtod() calls we would have done if all time keeping was enabled.
1873 .TP
1874 .BI gtod_cpu \fR=\fPint
1875 Sometimes it's cheaper to dedicate a single thread of execution to just getting
1876 the current time. Fio (and databases, for instance) are very intensive on
1877 \fBgettimeofday\fR\|(2) calls. With this option, you can set one CPU aside for doing
1878 nothing but logging current time to a shared memory location. Then the other
1879 threads/processes that run IO workloads need only copy that segment, instead of
1880 entering the kernel with a \fBgettimeofday\fR\|(2) call. The CPU set aside for doing
1881 these time calls will be excluded from other uses. Fio will manually clear it
1882 from the CPU mask of other jobs.
1883 .TP
1884 .BI ignore_error \fR=\fPstr
1885 Sometimes you want to ignore some errors during test in that case you can specify
1886 error list for each error type.
1887 .br
1889 .br
1890 errors for given error type is separated with ':'.
1891 Error may be symbol ('ENOSPC', 'ENOMEM') or an integer.
1892 .br
1893 Example: ignore_error=EAGAIN,ENOSPC:122 .
1894 .br
1895 This option will ignore EAGAIN from READ, and ENOSPC and 122(EDQUOT) from WRITE.
1896 .TP
1897 .BI error_dump \fR=\fPbool
1898 If set dump every error even if it is non fatal, true by default. If disabled
1899 only fatal error will be dumped
1900 .TP
1901 .BI profile \fR=\fPstr
1902 Select a specific builtin performance test.
1903 .TP
1904 .BI cgroup \fR=\fPstr
1905 Add job to this control group. If it doesn't exist, it will be created.
1906 The system must have a mounted cgroup blkio mount point for this to work. If
1907 your system doesn't have it mounted, you can do so with:
1909 # mount \-t cgroup \-o blkio none /cgroup
1910 .TP
1911 .BI cgroup_weight \fR=\fPint
1912 Set the weight of the cgroup to this value. See the documentation that comes
1913 with the kernel, allowed values are in the range of 100..1000.
1914 .TP
1915 .BI cgroup_nodelete \fR=\fPbool
1916 Normally fio will delete the cgroups it has created after the job completion.
1917 To override this behavior and to leave cgroups around after the job completion,
1918 set cgroup_nodelete=1. This can be useful if one wants to inspect various
1919 cgroup files after job completion. Default: false
1920 .TP
1921 .BI uid \fR=\fPint
1922 Instead of running as the invoking user, set the user ID to this value before
1923 the thread/process does any work.
1924 .TP
1925 .BI gid \fR=\fPint
1926 Set group ID, see \fBuid\fR.
1927 .TP
1928 .BI unit_base \fR=\fPint
1929 Base unit for reporting.  Allowed values are:
1930 .RS
1931 .TP
1932 .B 0
1933 Use auto-detection (default).
1934 .TP
1935 .B 8
1936 Byte based.
1937 .TP
1938 .B 1
1939 Bit based.
1940 .RE
1941 .P
1942 .TP
1943 .BI flow_id \fR=\fPint
1944 The ID of the flow. If not specified, it defaults to being a global flow. See
1945 \fBflow\fR.
1946 .TP
1947 .BI flow \fR=\fPint
1948 Weight in token-based flow control. If this value is used, then there is a
1949 \fBflow counter\fR which is used to regulate the proportion of activity between
1950 two or more jobs. fio attempts to keep this flow counter near zero. The
1951 \fBflow\fR parameter stands for how much should be added or subtracted to the
1952 flow counter on each iteration of the main I/O loop. That is, if one job has
1953 \fBflow=8\fR and another job has \fBflow=-1\fR, then there will be a roughly
1954 1:8 ratio in how much one runs vs the other.
1955 .TP
1956 .BI flow_watermark \fR=\fPint
1957 The maximum value that the absolute value of the flow counter is allowed to
1958 reach before the job must wait for a lower value of the counter.
1959 .TP
1960 .BI flow_sleep \fR=\fPint
1961 The period of time, in microseconds, to wait after the flow watermark has been
1962 exceeded before retrying operations
1963 .TP
1964 .BI clat_percentiles \fR=\fPbool
1965 Enable the reporting of percentiles of completion latencies.
1966 .TP
1967 .BI percentile_list \fR=\fPfloat_list
1968 Overwrite the default list of percentiles for completion latencies and the
1969 block error histogram. Each number is a floating number in the range (0,100],
1970 and the maximum length of the list is 20. Use ':' to separate the
1971 numbers. For example, \-\-percentile_list=99.5:99.9 will cause fio to
1972 report the values of completion latency below which 99.5% and 99.9% of
1973 the observed latencies fell, respectively.
1974 .SS "Ioengine Parameters List"
1975 Some parameters are only valid when a specific ioengine is in use. These are
1976 used identically to normal parameters, with the caveat that when used on the
1977 command line, they must come after the ioengine.
1978 .TP
1979 .BI (cpuio)cpuload \fR=\fPint
1980 Attempt to use the specified percentage of CPU cycles.
1981 .TP
1982 .BI (cpuio)cpuchunks \fR=\fPint
1983 Split the load into cycles of the given time. In microseconds.
1984 .TP
1985 .BI (cpuio)exit_on_io_done \fR=\fPbool
1986 Detect when IO threads are done, then exit.
1987 .TP
1988 .BI (libaio)userspace_reap
1989 Normally, with the libaio engine in use, fio will use
1990 the io_getevents system call to reap newly returned events.
1991 With this flag turned on, the AIO ring will be read directly
1992 from user-space to reap events. The reaping mode is only
1993 enabled when polling for a minimum of 0 events (eg when
1994 iodepth_batch_complete=0).
1995 .TP
1996 .BI (pvsync2)hipri
1997 Set RWF_HIPRI on IO, indicating to the kernel that it's of
1998 higher priority than normal.
1999 .TP
2000 .BI (net,netsplice)hostname \fR=\fPstr
2001 The host name or IP address to use for TCP or UDP based IO.
2002 If the job is a TCP listener or UDP reader, the hostname is not
2003 used and must be omitted unless it is a valid UDP multicast address.
2004 .TP
2005 .BI (net,netsplice)port \fR=\fPint
2006 The TCP or UDP port to bind to or connect to. If this is used with
2007 \fBnumjobs\fR to spawn multiple instances of the same job type, then
2008 this will be the starting port number since fio will use a range of ports.
2009 .TP
2010 .BI (net,netsplice)interface \fR=\fPstr
2011 The IP address of the network interface used to send or receive UDP multicast
2012 packets.
2013 .TP
2014 .BI (net,netsplice)ttl \fR=\fPint
2015 Time-to-live value for outgoing UDP multicast packets. Default: 1
2016 .TP
2017 .BI (net,netsplice)nodelay \fR=\fPbool
2018 Set TCP_NODELAY on TCP connections.
2019 .TP
2020 .BI (net,netsplice)protocol \fR=\fPstr "\fR,\fP proto" \fR=\fPstr
2021 The network protocol to use. Accepted values are:
2022 .RS
2023 .RS
2024 .TP
2025 .B tcp
2026 Transmission control protocol
2027 .TP
2028 .B tcpv6
2029 Transmission control protocol V6
2030 .TP
2031 .B udp
2032 User datagram protocol
2033 .TP
2034 .B udpv6
2035 User datagram protocol V6
2036 .TP
2037 .B unix
2038 UNIX domain socket
2039 .RE
2040 .P
2041 When the protocol is TCP or UDP, the port must also be given,
2042 as well as the hostname if the job is a TCP listener or UDP
2043 reader. For unix sockets, the normal filename option should be
2044 used and the port is invalid.
2045 .RE
2046 .TP
2047 .BI (net,netsplice)listen
2048 For TCP network connections, tell fio to listen for incoming
2049 connections rather than initiating an outgoing connection. The
2050 hostname must be omitted if this option is used.
2051 .TP
2052 .BI (net, pingpong) \fR=\fPbool
2053 Normally a network writer will just continue writing data, and a network reader
2054 will just consume packets. If pingpong=1 is set, a writer will send its normal
2055 payload to the reader, then wait for the reader to send the same payload back.
2056 This allows fio to measure network latencies. The submission and completion
2057 latencies then measure local time spent sending or receiving, and the
2058 completion latency measures how long it took for the other end to receive and
2059 send back. For UDP multicast traffic pingpong=1 should only be set for a single
2060 reader when multiple readers are listening to the same address.
2061 .TP
2062 .BI (net, window_size) \fR=\fPint
2063 Set the desired socket buffer size for the connection.
2064 .TP
2065 .BI (net, mss) \fR=\fPint
2066 Set the TCP maximum segment size (TCP_MAXSEG).
2067 .TP
2068 .BI (e4defrag,donorname) \fR=\fPstr
2069 File will be used as a block donor (swap extents between files)
2070 .TP
2071 .BI (e4defrag,inplace) \fR=\fPint
2072 Configure donor file block allocation strategy
2073 .RS
2074 .BI 0(default) :
2075 Preallocate donor's file on init
2076 .TP
2077 .BI 1:
2078 allocate space immediately inside defragment event, and free right after event
2079 .RE
2080 .TP
2081 .BI (rbd)clustername \fR=\fPstr
2082 Specifies the name of the ceph cluster.
2083 .TP
2084 .BI (rbd)rbdname \fR=\fPstr
2085 Specifies the name of the RBD.
2086 .TP
2087 .BI (rbd)pool \fR=\fPstr
2088 Specifies the name of the Ceph pool containing the RBD.
2089 .TP
2090 .BI (rbd)clientname \fR=\fPstr
2091 Specifies the username (without the 'client.' prefix) used to access the Ceph
2092 cluster. If the clustername is specified, the clientname shall be the full
2093 type.id string. If no type. prefix is given, fio will add 'client.' by default.
2094 .TP
2095 .BI (mtd)skipbad \fR=\fPbool
2096 Skip operations against known bad blocks.
2098 While running, \fBfio\fR will display the status of the created jobs.  For
2099 example:
2100 .RS
2101 .P
2102 Jobs: 1: [_r] [24.8% done] [ 13509/  8334 kb/s] [eta 00h:01m:31s]
2103 .RE
2104 .P
2105 The characters in the first set of brackets denote the current status of each
2106 threads.  The possible values are:
2107 .P
2108 .PD 0
2109 .RS
2110 .TP
2111 .B P
2112 Setup but not started.
2113 .TP
2114 .B C
2115 Thread created.
2116 .TP
2117 .B I
2118 Initialized, waiting.
2119 .TP
2120 .B R
2121 Running, doing sequential reads.
2122 .TP
2123 .B r
2124 Running, doing random reads.
2125 .TP
2126 .B W
2127 Running, doing sequential writes.
2128 .TP
2129 .B w
2130 Running, doing random writes.
2131 .TP
2132 .B M
2133 Running, doing mixed sequential reads/writes.
2134 .TP
2135 .B m
2136 Running, doing mixed random reads/writes.
2137 .TP
2138 .B F
2139 Running, currently waiting for \fBfsync\fR\|(2).
2140 .TP
2141 .B V
2142 Running, verifying written data.
2143 .TP
2144 .B E
2145 Exited, not reaped by main thread.
2146 .TP
2147 .B \-
2148 Exited, thread reaped.
2149 .RE
2150 .PD
2151 .P
2152 The second set of brackets shows the estimated completion percentage of
2153 the current group.  The third set shows the read and write I/O rate,
2154 respectively. Finally, the estimated run time of the job is displayed.
2155 .P
2156 When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data
2157 for each thread, each group of threads, and each disk, in that order.
2158 .P
2159 Per-thread statistics first show the threads client number, group-id, and
2160 error code.  The remaining figures are as follows:
2161 .RS
2162 .TP
2163 .B io
2164 Number of megabytes of I/O performed.
2165 .TP
2166 .B bw
2167 Average data rate (bandwidth).
2168 .TP
2169 .B runt
2170 Threads run time.
2171 .TP
2172 .B slat
2173 Submission latency minimum, maximum, average and standard deviation. This is
2174 the time it took to submit the I/O.
2175 .TP
2176 .B clat
2177 Completion latency minimum, maximum, average and standard deviation.  This
2178 is the time between submission and completion.
2179 .TP
2180 .B bw
2181 Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average
2182 and standard deviation.
2183 .TP
2184 .B cpu
2185 CPU usage statistics. Includes user and system time, number of context switches
2186 this thread went through and number of major and minor page faults. The CPU
2187 utilization numbers are averages for the jobs in that reporting group, while
2188 the context and fault counters are summed.
2189 .TP
2190 .B IO depths
2191 Distribution of I/O depths.  Each depth includes everything less than (or equal)
2192 to it, but greater than the previous depth.
2193 .TP
2194 .B IO issued
2195 Number of read/write requests issued, and number of short read/write requests.
2196 .TP
2197 .B IO latencies
2198 Distribution of I/O completion latencies.  The numbers follow the same pattern
2199 as \fBIO depths\fR.
2200 .RE
2201 .P
2202 The group statistics show:
2203 .PD 0
2204 .RS
2205 .TP
2206 .B io
2207 Number of megabytes I/O performed.
2208 .TP
2209 .B aggrb
2210 Aggregate bandwidth of threads in the group.
2211 .TP
2212 .B minb
2213 Minimum average bandwidth a thread saw.
2214 .TP
2215 .B maxb
2216 Maximum average bandwidth a thread saw.
2217 .TP
2218 .B mint
2219 Shortest runtime of threads in the group.
2220 .TP
2221 .B maxt
2222 Longest runtime of threads in the group.
2223 .RE
2224 .PD
2225 .P
2226 Finally, disk statistics are printed with reads first:
2227 .PD 0
2228 .RS
2229 .TP
2230 .B ios
2231 Number of I/Os performed by all groups.
2232 .TP
2233 .B merge
2234 Number of merges in the I/O scheduler.
2235 .TP
2236 .B ticks
2237 Number of ticks we kept the disk busy.
2238 .TP
2239 .B io_queue
2240 Total time spent in the disk queue.
2241 .TP
2242 .B util
2243 Disk utilization.
2244 .RE
2245 .PD
2246 .P
2247 It is also possible to get fio to dump the current output while it is
2248 running, without terminating the job. To do that, send fio the \fBUSR1\fR
2249 signal.
2251 If the \fB\-\-minimal\fR / \fB\-\-append-terse\fR options are given, the
2252 results will be printed/appended in a semicolon-delimited format suitable for
2253 scripted use.
2254 A job description (if provided) follows on a new line.  Note that the first
2255 number in the line is the version number. If the output has to be changed
2256 for some reason, this number will be incremented by 1 to signify that
2257 change. Numbers in brackets (e.g. "[v3]") indicate which terse version
2258 introduced a field. The fields are:
2259 .P
2260 .RS
2261 .B terse version, fio version [v3], jobname, groupid, error
2262 .P
2263 Read status:
2264 .RS
2265 .B Total I/O \fR(KiB)\fP, bandwidth \fR(KiB/s)\fP, IOPS, runtime \fR(ms)\fP
2266 .P
2267 Submission latency:
2268 .RS
2269 .B min, max, mean, standard deviation
2270 .RE
2271 Completion latency:
2272 .RS
2273 .B min, max, mean, standard deviation
2274 .RE
2275 Completion latency percentiles (20 fields):
2276 .RS
2277 .B Xth percentile=usec
2278 .RE
2279 Total latency:
2280 .RS
2281 .B min, max, mean, standard deviation
2282 .RE
2283 Bandwidth:
2284 .RS
2285 .B min, max, aggregate percentage of total, mean, standard deviation, number of samples [v5]
2286 .RE
2287 IOPS [v5]:
2288 .RS
2289 .B min, max, mean, standard deviation, number of samples
2290 .RE
2291 .RE
2292 .P
2293 Write status:
2294 .RS
2295 .B Total I/O \fR(KiB)\fP, bandwidth \fR(KiB/s)\fP, IOPS, runtime \fR(ms)\fP
2296 .P
2297 Submission latency:
2298 .RS
2299 .B min, max, mean, standard deviation
2300 .RE
2301 Completion latency:
2302 .RS
2303 .B min, max, mean, standard deviation
2304 .RE
2305 Completion latency percentiles (20 fields):
2306 .RS
2307 .B Xth percentile=usec
2308 .RE
2309 Total latency:
2310 .RS
2311 .B min, max, mean, standard deviation
2312 .RE
2313 Bandwidth:
2314 .RS
2315 .B min, max, aggregate percentage of total, mean, standard deviation, number of samples [v5]
2316 .RE
2317 IOPS [v5]:
2318 .RS
2319 .B min, max, mean, standard deviation, number of samples
2320 .RE
2321 .RE
2322 .P
2323 Trim status [all but version 3]:
2324 .RS
2325 Similar to Read/Write status but for trims.
2326 .RE
2327 .P
2328 CPU usage:
2329 .RS
2330 .B user, system, context switches, major page faults, minor page faults
2331 .RE
2332 .P
2333 IO depth distribution:
2334 .RS
2335 .B <=1, 2, 4, 8, 16, 32, >=64
2336 .RE
2337 .P
2338 IO latency distribution:
2339 .RS
2340 Microseconds:
2341 .RS
2342 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
2343 .RE
2344 Milliseconds:
2345 .RS
2346 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000
2347 .RE
2348 .RE
2349 .P
2350 Disk utilization (1 for each disk used) [v3]:
2351 .RS
2352 .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
2353 .RE
2354 .P
2355 Error Info (dependent on continue_on_error, default off):
2356 .RS
2357 .B total # errors, first error code
2358 .RE
2359 .P
2360 .B text description (if provided in config - appears on newline)
2361 .RE
2362 .P
2363 Below is a single line containing short names for each of the fields in
2364 the minimal output v3, separated by semicolons:
2365 .RS
2366 .P
2367 .nf
2368 terse_version_3;fio_version;jobname;groupid;error;read_kb;read_bandwidth;read_iops;read_runtime_ms;read_slat_min;read_slat_max;read_slat_mean;read_slat_dev;read_clat_max;read_clat_min;read_clat_mean;read_clat_dev;read_clat_pct01;read_clat_pct02;read_clat_pct03;read_clat_pct04;read_clat_pct05;read_clat_pct06;read_clat_pct07;read_clat_pct08;read_clat_pct09;read_clat_pct10;read_clat_pct11;read_clat_pct12;read_clat_pct13;read_clat_pct14;read_clat_pct15;read_clat_pct16;read_clat_pct17;read_clat_pct18;read_clat_pct19;read_clat_pct20;read_tlat_min;read_lat_max;read_lat_mean;read_lat_dev;read_bw_min;read_bw_max;read_bw_agg_pct;read_bw_mean;read_bw_dev;write_kb;write_bandwidth;write_iops;write_runtime_ms;write_slat_min;write_slat_max;write_slat_mean;write_slat_dev;write_clat_max;write_clat_min;write_clat_mean;write_clat_dev;write_clat_pct01;write_clat_pct02;write_clat_pct03;write_clat_pct04;write_clat_pct05;write_clat_pct06;write_clat_pct07;write_clat_pct08;write_clat_pct09;write_clat_pct10;write_clat_pct11;write_clat_pct12;write_clat_pct13;write_clat_pct14;write_clat_pct15;write_clat_pct16;write_clat_pct17;write_clat_pct18;write_clat_pct19;write_clat_pct20;write_tlat_min;write_lat_max;write_lat_mean;write_lat_dev;write_bw_min;write_bw_max;write_bw_agg_pct;write_bw_mean;write_bw_dev;cpu_user;cpu_sys;cpu_csw;cpu_mjf;pu_minf;iodepth_1;iodepth_2;iodepth_4;iodepth_8;iodepth_16;iodepth_32;iodepth_64;lat_2us;lat_4us;lat_10us;lat_20us;lat_50us;lat_100us;lat_250us;lat_500us;lat_750us;lat_1000us;lat_2ms;lat_4ms;lat_10ms;lat_20ms;lat_50ms;lat_100ms;lat_250ms;lat_500ms;lat_750ms;lat_1000ms;lat_2000ms;lat_over_2000ms;disk_name;disk_read_iops;disk_write_iops;disk_read_merges;disk_write_merges;disk_read_ticks;write_ticks;disk_queue_time;disk_util
2369 .fi
2370 .RE
2372 There are two trace file format that you can encounter. The older (v1) format
2373 is unsupported since version 1.20-rc3 (March 2008). It will still be described
2374 below in case that you get an old trace and want to understand it.
2376 In any case the trace is a simple text file with a single action per line.
2378 .P
2379 .B Trace file format v1
2380 .RS
2381 Each line represents a single io action in the following format:
2383 rw, offset, length
2385 where rw=0/1 for read/write, and the offset and length entries being in bytes.
2387 This format is not supported in Fio versions => 1.20-rc3.
2389 .RE
2390 .P
2391 .B Trace file format v2
2392 .RS
2393 The second version of the trace file format was added in Fio version 1.17.
2394 It allows one to access more then one file per trace and has a bigger set of
2395 possible file actions.
2397 The first line of the trace file has to be:
2399 \fBfio version 2 iolog\fR
2401 Following this can be lines in two different formats, which are described below.
2402 The file management format:
2404 \fBfilename action\fR
2406 The filename is given as an absolute path. The action can be one of these:
2408 .P
2409 .PD 0
2410 .RS
2411 .TP
2412 .B add
2413 Add the given filename to the trace
2414 .TP
2415 .B open
2416 Open the file with the given filename. The filename has to have been previously
2417 added with the \fBadd\fR action.
2418 .TP
2419 .B close
2420 Close the file with the given filename. The file must have previously been
2421 opened.
2422 .RE
2423 .PD
2424 .P
2426 The file io action format:
2428 \fBfilename action offset length\fR
2430 The filename is given as an absolute path, and has to have been added and opened
2431 before it can be used with this format. The offset and length are given in
2432 bytes. The action can be one of these:
2434 .P
2435 .PD 0
2436 .RS
2437 .TP
2438 .B wait
2439 Wait for 'offset' microseconds. Everything below 100 is discarded.  The time is
2440 relative to the previous wait statement.
2441 .TP
2442 .B read
2443 Read \fBlength\fR bytes beginning from \fBoffset\fR
2444 .TP
2445 .B write
2446 Write \fBlength\fR bytes beginning from \fBoffset\fR
2447 .TP
2448 .B sync
2449 fsync() the file
2450 .TP
2451 .B datasync
2452 fdatasync() the file
2453 .TP
2454 .B trim
2455 trim the given file from the given \fBoffset\fR for \fBlength\fR bytes
2456 .RE
2457 .PD
2458 .P
2461 In some cases, we want to understand CPU overhead in a test. For example,
2462 we test patches for the specific goodness of whether they reduce CPU usage.
2463 fio implements a balloon approach to create a thread per CPU that runs at
2464 idle priority, meaning that it only runs when nobody else needs the cpu.
2465 By measuring the amount of work completed by the thread, idleness of each
2466 CPU can be derived accordingly.
2468 An unit work is defined as touching a full page of unsigned characters. Mean
2469 and standard deviation of time to complete an unit work is reported in "unit
2470 work" section. Options can be chosen to report detailed percpu idleness or
2471 overall system idleness by aggregating percpu stats.
2474 Fio is usually run in one of two ways, when data verification is done. The
2475 first is a normal write job of some sort with verify enabled. When the
2476 write phase has completed, fio switches to reads and verifies everything
2477 it wrote. The second model is running just the write phase, and then later
2478 on running the same job (but with reads instead of writes) to repeat the
2479 same IO patterns and verify the contents. Both of these methods depend
2480 on the write phase being completed, as fio otherwise has no idea how much
2481 data was written.
2483 With verification triggers, fio supports dumping the current write state
2484 to local files. Then a subsequent read verify workload can load this state
2485 and know exactly where to stop. This is useful for testing cases where
2486 power is cut to a server in a managed fashion, for instance.
2488 A verification trigger consists of two things:
2490 .RS
2491 Storing the write state of each job
2492 .LP
2493 Executing a trigger command
2494 .RE
2496 The write state is relatively small, on the order of hundreds of bytes
2497 to single kilobytes. It contains information on the number of completions
2498 done, the last X completions, etc.
2500 A trigger is invoked either through creation (\fBtouch\fR) of a specified
2501 file in the system, or through a timeout setting. If fio is run with
2502 \fB\-\-trigger\-file=/tmp/trigger-file\fR, then it will continually check for
2503 the existence of /tmp/trigger-file. When it sees this file, it will
2504 fire off the trigger (thus saving state, and executing the trigger
2505 command).
2507 For client/server runs, there's both a local and remote trigger. If
2508 fio is running as a server backend, it will send the job states back
2509 to the client for safe storage, then execute the remote trigger, if
2510 specified. If a local trigger is specified, the server will still send
2511 back the write state, but the client will then execute the trigger.
2513 .RE
2514 .P
2515 .B Verification trigger example
2516 .RS
2518 Lets say we want to run a powercut test on the remote machine 'server'.
2519 Our write workload is in write-test.fio. We want to cut power to 'server'
2520 at some point during the run, and we'll run this test from the safety
2521 or our local machine, 'localbox'. On the server, we'll start the fio
2522 backend normally:
2524 server# \fBfio \-\-server\fR
2526 and on the client, we'll fire off the workload:
2528 localbox$ \fBfio \-\-client=server \-\-trigger\-file=/tmp/my\-trigger \-\-trigger-remote="bash \-c "echo b > /proc/sysrq-triger""\fR
2530 We set \fB/tmp/my-trigger\fR as the trigger file, and we tell fio to execute
2532 \fBecho b > /proc/sysrq-trigger\fR
2534 on the server once it has received the trigger and sent us the write
2535 state. This will work, but it's not \fIreally\fR cutting power to the server,
2536 it's merely abruptly rebooting it. If we have a remote way of cutting
2537 power to the server through IPMI or similar, we could do that through
2538 a local trigger command instead. Lets assume we have a script that does
2539 IPMI reboot of a given hostname, ipmi-reboot. On localbox, we could
2540 then have run fio with a local trigger instead:
2542 localbox$ \fBfio \-\-client=server \-\-trigger\-file=/tmp/my\-trigger \-\-trigger="ipmi-reboot server"\fR
2544 For this case, fio would wait for the server to send us the write state,
2545 then execute 'ipmi-reboot server' when that happened.
2547 .RE
2548 .P
2549 .B Loading verify state
2550 .RS
2551 To load store write state, read verification job file must contain
2552 the verify_state_load option. If that is set, fio will load the previously
2553 stored state. For a local fio run this is done by loading the files directly,
2554 and on a client/server run, the server backend will ask the client to send
2555 the files over and load them from there.
2557 .RE
2561 Fio supports a variety of log file formats, for logging latencies, bandwidth,
2562 and IOPS. The logs share a common format, which looks like this:
2564 .B time (msec), value, data direction, offset
2566 Time for the log entry is always in milliseconds. The value logged depends
2567 on the type of log, it will be one of the following:
2569 .P
2570 .PD 0
2571 .TP
2572 .B Latency log
2573 Value is in latency in usecs
2574 .TP
2575 .B Bandwidth log
2576 Value is in KiB/sec
2577 .TP
2578 .B IOPS log
2579 Value is in IOPS
2580 .PD
2581 .P
2583 Data direction is one of the following:
2585 .P
2586 .PD 0
2587 .TP
2588 .B 0
2589 IO is a READ
2590 .TP
2591 .B 1
2592 IO is a WRITE
2593 .TP
2594 .B 2
2595 IO is a TRIM
2596 .PD
2597 .P
2599 The \fIoffset\fR is the offset, in bytes, from the start of the file, for that
2600 particular IO. The logging of the offset can be toggled with \fBlog_offset\fR.
2602 If windowed logging is enabled through \fBlog_avg_msec\fR, then fio doesn't log
2603 individual IOs. Instead of logs the average values over the specified
2604 period of time. Since \fIdata direction\fR and \fIoffset\fR are per-IO values,
2605 they aren't applicable if windowed logging is enabled. If windowed logging
2606 is enabled and \fBlog_max_value\fR is set, then fio logs maximum values in
2607 that window instead of averages.
2609 For histogram logging the logs look like this:
2611 .B time (msec), data direction, block-size, bin 0, bin 1, ..., bin 1215
2613 Where 'bin i' gives the frequency of IO requests with a latency falling in
2614 the i-th bin. See \fBlog_hist_coarseness\fR for logging fewer bins.
2616 .RE
2619 Normally you would run fio as a stand-alone application on the machine
2620 where the IO workload should be generated. However, it is also possible to
2621 run the frontend and backend of fio separately. This makes it possible to
2622 have a fio server running on the machine(s) where the IO workload should
2623 be running, while controlling it from another machine.
2625 To start the server, you would do:
2627 \fBfio \-\-server=args\fR
2629 on that machine, where args defines what fio listens to. The arguments
2630 are of the form 'type:hostname or IP:port'. 'type' is either 'ip' (or ip4)
2631 for TCP/IP v4, 'ip6' for TCP/IP v6, or 'sock' for a local unix domain
2632 socket. 'hostname' is either a hostname or IP address, and 'port' is the port to
2633 listen to (only valid for TCP/IP, not a local socket). Some examples:
2635 1) \fBfio \-\-server\fR
2637    Start a fio server, listening on all interfaces on the default port (8765).
2639 2) \fBfio \-\-server=ip:hostname,4444\fR
2641    Start a fio server, listening on IP belonging to hostname and on port 4444.
2643 3) \fBfio \-\-server=ip6:::1,4444\fR
2645    Start a fio server, listening on IPv6 localhost ::1 and on port 4444.
2647 4) \fBfio \-\-server=,4444\fR
2649    Start a fio server, listening on all interfaces on port 4444.
2651 5) \fBfio \-\-server=\fR
2653    Start a fio server, listening on IP on the default port.
2655 6) \fBfio \-\-server=sock:/tmp/fio.sock\fR
2657    Start a fio server, listening on the local socket /tmp/fio.sock.
2659 When a server is running, you can connect to it from a client. The client
2660 is run with:
2662 \fBfio \-\-local-args \-\-client=server \-\-remote-args <job file(s)>\fR
2664 where \-\-local-args are arguments that are local to the client where it is
2665 running, 'server' is the connect string, and \-\-remote-args and <job file(s)>
2666 are sent to the server. The 'server' string follows the same format as it
2667 does on the server side, to allow IP/hostname/socket and port strings.
2668 You can connect to multiple clients as well, to do that you could run:
2670 \fBfio \-\-client=server2 \-\-client=server2 <job file(s)>\fR
2672 If the job file is located on the fio server, then you can tell the server
2673 to load a local file as well. This is done by using \-\-remote-config:
2675 \fBfio \-\-client=server \-\-remote-config /path/to/file.fio\fR
2677 Then fio will open this local (to the server) job file instead
2678 of being passed one from the client.
2680 If you have many servers (example: 100 VMs/containers), you can input a pathname
2681 of a file containing host IPs/names as the parameter value for the \-\-client option.
2682 For example, here is an example "host.list" file containing 2 hostnames:
2684 host1.your.dns.domain
2685 .br
2686 host2.your.dns.domain
2688 The fio command would then be:
2690 \fBfio \-\-client=host.list <job file>\fR
2692 In this mode, you cannot input server-specific parameters or job files, and all
2693 servers receive the same job file.
2695 In order to enable fio \-\-client runs utilizing a shared filesystem from multiple hosts,
2696 fio \-\-client now prepends the IP address of the server to the filename. For example,
2697 if fio is using directory /mnt/nfs/fio and is writing filename fileio.tmp,
2698 with a \-\-client hostfile
2699 containing two hostnames h1 and h2 with IP addresses and, then
2700 fio will create two files:
2702 /mnt/nfs/fio/
2703 .br
2704 /mnt/nfs/fio/
2708 .B fio
2709 was written by Jens Axboe <jens.axboe@oracle.com>,
2710 now Jens Axboe <axboe@fb.com>.
2711 .br
2712 This man page was written by Aaron Carroll <aaronc@cse.unsw.edu.au> based
2713 on documentation by Jens Axboe.
2715 Report bugs to the \fBfio\fR mailing list <fio@vger.kernel.org>.
2716 See \fBREADME\fR.
2717 .SH "SEE ALSO"
2718 For further documentation see \fBHOWTO\fR and \fBREADME\fR.
2719 .br
2720 Sample jobfiles are available in the \fBexamples\fR directory.
2721 .br
2722 These are typically located under /usr/share/doc/fio.
2724 \fBHOWTO\fR:  http://git.kernel.dk/cgit/fio/plain/HOWTO
2725 .br
2726 \fBREADME\fR: http://git.kernel.dk/cgit/fio/plain/README
2727 .br