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