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