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