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