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