[fio.git] / fio.1
1 .TH fio 1 "August 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 \fItype\fR of various fio actions. May be `all' for all \fItype\fRs
17 or individual types separated by a comma (e.g. `\-\-debug=file,mem' will enable
18 file and memory debugging). `help' will list all available tracing options.
19 .TP
20 .BI \-\-parse\-only
21 Parse options only, don't start any I/O.
22 .TP
23 .BI \-\-output \fR=\fPfilename
24 Write output to \fIfilename\fR.
25 .TP
26 .BI \-\-output\-format \fR=\fPformat
27 Set the reporting \fIformat\fR to `normal', `terse', `json', or
28 `json+'. Multiple formats can be selected, separate by a comma. `terse'
29 is a CSV based format. `json+' is like `json', except it adds a full
30 dump of the latency buckets.
31 .TP
32 .BI \-\-runtime \fR=\fPruntime
33 Limit run time to \fIruntime\fR seconds.
34 .TP
35 .BI \-\-bandwidth\-log
36 Generate aggregate bandwidth logs.
37 .TP
38 .BI \-\-minimal
39 Print statistics in a terse, semicolon\-delimited format.
40 .TP
41 .BI \-\-append\-terse
42 Print statistics in selected mode AND terse, semicolon\-delimited format.
43 \fBDeprecated\fR, use \fB\-\-output\-format\fR instead to select multiple formats.
44 .TP
45 .BI \-\-terse\-version \fR=\fPversion
46 Set terse \fIversion\fR output format (default `3', or `2', `4', `5').
47 .TP
48 .BI \-\-version
49 Print version information and exit.
50 .TP
51 .BI \-\-help
52 Print a summary of the command line options and exit.
53 .TP
54 .BI \-\-cpuclock\-test
55 Perform test and validation of internal CPU clock.
56 .TP
57 .BI \-\-crctest \fR=\fP[test]
58 Test the speed of the built\-in checksumming functions. If no argument is given,
59 all of them are tested. Alternatively, a comma separated list can be passed, in which
60 case the given ones are tested.
61 .TP
62 .BI \-\-cmdhelp \fR=\fPcommand
63 Print help information for \fIcommand\fR. May be `all' for all commands.
64 .TP
65 .BI \-\-enghelp \fR=\fP[ioengine[,command]]
66 List all commands defined by \fIioengine\fR, or print help for \fIcommand\fR
67 defined by \fIioengine\fR. If no \fIioengine\fR is given, list all
68 available ioengines.
69 .TP
70 .BI \-\-showcmd \fR=\fPjobfile
71 Convert \fIjobfile\fR to a set of command\-line options.
72 .TP
73 .BI \-\-readonly
74 Turn on safety read\-only checks, preventing writes. The \fB\-\-readonly\fR
75 option is an extra safety guard to prevent users from accidentally starting
76 a write workload when that is not desired. Fio will only write if
77 `rw=write/randwrite/rw/randrw' is given. This extra safety net can be used
78 as an extra precaution as \fB\-\-readonly\fR will also enable a write check in
79 the I/O engine core to prevent writes due to unknown user space bug(s).
80 .TP
81 .BI \-\-eta \fR=\fPwhen
82 Specifies when real\-time ETA estimate should be printed. \fIwhen\fR may
83 be `always', `never' or `auto'.
84 .TP
85 .BI \-\-eta\-newline \fR=\fPtime
86 Force a new line for every \fItime\fR period passed. When the unit is omitted,
87 the value is interpreted in seconds.
88 .TP
89 .BI \-\-status\-interval \fR=\fPtime
90 Force full status dump every \fItime\fR period passed. When the unit is omitted,
91 the value is interpreted in seconds.
92 .TP
93 .BI \-\-section \fR=\fPname
94 Only run specified section \fIname\fR in job file. Multiple sections can be specified.
95 The \fB\-\-section\fR option allows one to combine related jobs into one file.
96 E.g. one job file could define light, moderate, and heavy sections. Tell
97 fio to run only the "heavy" section by giving `\-\-section=heavy'
98 command line option. One can also specify the "write" operations in one
99 section and "verify" operation in another section. The \fB\-\-section\fR option
100 only applies to job sections. The reserved *global* section is always
101 parsed and used.
102 .TP
103 .BI \-\-alloc\-size \fR=\fPkb
104 Set the internal smalloc pool size to \fIkb\fR in KiB. The
105 \fB\-\-alloc\-size\fR switch allows one to use a larger pool size for smalloc.
106 If running large jobs with randommap enabled, fio can run out of memory.
107 Smalloc is an internal allocator for shared structures from a fixed size
108 memory pool and can grow to 16 pools. The pool size defaults to 16MiB.
109 NOTE: While running `.fio_smalloc.*' backing store files are visible
110 in `/tmp'.
111 .TP
112 .BI \-\-warnings\-fatal
113 All fio parser warnings are fatal, causing fio to exit with an error.
114 .TP
115 .BI \-\-max\-jobs \fR=\fPnr
116 Set the maximum number of threads/processes to support to \fInr\fR.
117 .TP
118 .BI \-\-server \fR=\fPargs
119 Start a backend server, with \fIargs\fR specifying what to listen to.
120 See \fBCLIENT/SERVER\fR section.
121 .TP
122 .BI \-\-daemonize \fR=\fPpidfile
123 Background a fio server, writing the pid to the given \fIpidfile\fR file.
124 .TP
125 .BI \-\-client \fR=\fPhostname
126 Instead of running the jobs locally, send and run them on the given \fIhostname\fR
127 or set of \fIhostname\fRs. See \fBCLIENT/SERVER\fR section.
128 .TP
129 .BI \-\-remote\-config \fR=\fPfile
130 Tell fio server to load this local \fIfile\fR.
131 .TP
132 .BI \-\-idle\-prof \fR=\fPoption
133 Report CPU idleness. \fIoption\fR is one of the following:
134 .RS
135 .RS
136 .TP
137 .B calibrate
138 Run unit work calibration only and exit.
139 .TP
140 .B system
141 Show aggregate system idleness and unit work.
142 .TP
143 .B percpu
144 As \fBsystem\fR but also show per CPU idleness.
145 .RE
146 .RE
147 .TP
148 .BI \-\-inflate\-log \fR=\fPlog
149 Inflate and output compressed \fIlog\fR.
150 .TP
151 .BI \-\-trigger\-file \fR=\fPfile
152 Execute trigger command when \fIfile\fR exists.
153 .TP
154 .BI \-\-trigger\-timeout \fR=\fPtime
155 Execute trigger at this \fItime\fR.
156 .TP
157 .BI \-\-trigger \fR=\fPcommand
158 Set this \fIcommand\fR as local trigger.
159 .TP
160 .BI \-\-trigger\-remote \fR=\fPcommand
161 Set this \fIcommand\fR as remote trigger.
162 .TP
163 .BI \-\-aux\-path \fR=\fPpath
164 Use this \fIpath\fR for fio state generated files.
166 Any parameters following the options will be assumed to be job files, unless
167 they match a job file parameter. Multiple job files can be listed and each job
168 file will be regarded as a separate group. Fio will \fBstonewall\fR execution
169 between each group.
171 Fio accepts one or more job files describing what it is
172 supposed to do. The job file format is the classic ini file, where the names
173 enclosed in [] brackets define the job name. You are free to use any ASCII name
174 you want, except *global* which has special meaning. Following the job name is
175 a sequence of zero or more parameters, one per line, that define the behavior of
176 the job. If the first character in a line is a ';' or a '#', the entire line is
177 discarded as a comment.
179 A *global* section sets defaults for the jobs described in that file. A job may
180 override a *global* section parameter, and a job file may even have several
181 *global* sections if so desired. A job is only affected by a *global* section
182 residing above it.
184 The \fB\-\-cmdhelp\fR option also lists all options. If used with an \fIcommand\fR
185 argument, \fB\-\-cmdhelp\fR will detail the given \fIcommand\fR.
187 See the `examples/' directory for inspiration on how to write job files. Note
188 the copyright and license requirements currently apply to
189 `examples/' files.
191 Some parameters take an option of a given type, such as an integer or a
192 string. Anywhere a numeric value is required, an arithmetic expression may be
193 used, provided it is surrounded by parentheses. Supported operators are:
194 .RS
195 .P
196 .B addition (+)
197 .P
198 .B subtraction (\-)
199 .P
200 .B multiplication (*)
201 .P
202 .B division (/)
203 .P
204 .B modulus (%)
205 .P
206 .B exponentiation (^)
207 .RE
208 .P
209 For time values in expressions, units are microseconds by default. This is
210 different than for time values not in expressions (not enclosed in
211 parentheses).
213 The following parameter types are used.
214 .TP
215 .I str
216 String. A sequence of alphanumeric characters.
217 .TP
218 .I time
219 Integer with possible time suffix. Without a unit value is interpreted as
220 seconds unless otherwise specified. Accepts a suffix of 'd' for days, 'h' for
221 hours, 'm' for minutes, 's' for seconds, 'ms' (or 'msec') for milliseconds and 'us'
222 (or 'usec') for microseconds. For example, use 10m for 10 minutes.
223 .TP
224 .I int
225 Integer. A whole number value, which may contain an integer prefix
226 and an integer suffix.
227 .RS
228 .RS
229 .P
230 [*integer prefix*] **number** [*integer suffix*]
231 .RE
232 .P
233 The optional *integer prefix* specifies the number's base. The default
234 is decimal. *0x* specifies hexadecimal.
235 .P
236 The optional *integer suffix* specifies the number's units, and includes an
237 optional unit prefix and an optional unit. For quantities of data, the
238 default unit is bytes. For quantities of time, the default unit is seconds
239 unless otherwise specified.
240 .P
241 With `kb_base=1000', fio follows international standards for unit
242 prefixes. To specify power\-of\-10 decimal values defined in the
243 International System of Units (SI):
244 .RS
245 .P
246 .PD 0
247 Ki means kilo (K) or 1000
248 .P
249 Mi means mega (M) or 1000**2
250 .P
251 Gi means giga (G) or 1000**3
252 .P
253 Ti means tera (T) or 1000**4
254 .P
255 Pi means peta (P) or 1000**5
256 .PD
257 .RE
258 .P
259 To specify power\-of\-2 binary values defined in IEC 80000\-13:
260 .RS
261 .P
262 .PD 0
263 K means kibi (Ki) or 1024
264 .P
265 M means mebi (Mi) or 1024**2
266 .P
267 G means gibi (Gi) or 1024**3
268 .P
269 T means tebi (Ti) or 1024**4
270 .P
271 P means pebi (Pi) or 1024**5
272 .PD
273 .RE
274 .P
275 With `kb_base=1024' (the default), the unit prefixes are opposite
276 from those specified in the SI and IEC 80000\-13 standards to provide
277 compatibility with old scripts. For example, 4k means 4096.
278 .P
279 For quantities of data, an optional unit of 'B' may be included
280 (e.g., 'kB' is the same as 'k').
281 .P
282 The *integer suffix* is not case sensitive (e.g., m/mi mean mebi/mega,
283 not milli). 'b' and 'B' both mean byte, not bit.
284 .P
285 Examples with `kb_base=1000':
286 .RS
287 .P
288 .PD 0
289 4 KiB: 4096, 4096b, 4096B, 4k, 4kb, 4kB, 4K, 4KB
290 .P
291 1 MiB: 1048576, 1m, 1024k
292 .P
293 1 MB: 1000000, 1mi, 1000ki
294 .P
295 1 TiB: 1073741824, 1t, 1024m, 1048576k
296 .P
297 1 TB: 1000000000, 1ti, 1000mi, 1000000ki
298 .PD
299 .RE
300 .P
301 Examples with `kb_base=1024' (default):
302 .RS
303 .P
304 .PD 0
305 4 KiB: 4096, 4096b, 4096B, 4k, 4kb, 4kB, 4K, 4KB
306 .P
307 1 MiB: 1048576, 1m, 1024k
308 .P
309 1 MB: 1000000, 1mi, 1000ki
310 .P
311 1 TiB: 1073741824, 1t, 1024m, 1048576k
312 .P
313 1 TB: 1000000000, 1ti, 1000mi, 1000000ki
314 .PD
315 .RE
316 .P
317 To specify times (units are not case sensitive):
318 .RS
319 .P
320 .PD 0
321 D means days
322 .P
323 H means hours
324 .P
325 M mean minutes
326 .P
327 s or sec means seconds (default)
328 .P
329 ms or msec means milliseconds
330 .P
331 us or usec means microseconds
332 .PD
333 .RE
334 .P
335 If the option accepts an upper and lower range, use a colon ':' or
336 minus '\-' to separate such values. See \fIirange\fR parameter type.
337 If the lower value specified happens to be larger than the upper value
338 the two values are swapped.
339 .RE
340 .TP
341 .I bool
342 Boolean. Usually parsed as an integer, however only defined for
343 true and false (1 and 0).
344 .TP
345 .I irange
346 Integer range with suffix. Allows value range to be given, such as
347 1024\-4096. A colon may also be used as the separator, e.g. 1k:4k. If the
348 option allows two sets of ranges, they can be specified with a ',' or '/'
349 delimiter: 1k\-4k/8k\-32k. Also see \fIint\fR parameter type.
350 .TP
351 .I float_list
352 A list of floating point numbers, separated by a ':' character.
354 With the above in mind, here follows the complete list of fio job parameters.
355 .SS "Units"
356 .TP
357 .BI kb_base \fR=\fPint
358 Select the interpretation of unit prefixes in input parameters.
359 .RS
360 .RS
361 .TP
362 .B 1000
363 Inputs comply with IEC 80000\-13 and the International
364 System of Units (SI). Use:
365 .RS
366 .P
367 .PD 0
368 \- power\-of\-2 values with IEC prefixes (e.g., KiB)
369 .P
370 \- power\-of\-10 values with SI prefixes (e.g., kB)
371 .PD
372 .RE
373 .TP
374 .B 1024
375 Compatibility mode (default). To avoid breaking old scripts:
376 .P
377 .RS
378 .PD 0
379 \- power\-of\-2 values with SI prefixes
380 .P
381 \- power\-of\-10 values with IEC prefixes
382 .PD
383 .RE
384 .RE
385 .P
386 See \fBbs\fR for more details on input parameters.
387 .P
388 Outputs always use correct prefixes. Most outputs include both
389 side\-by\-side, like:
390 .P
391 .RS
392 bw=2383.3kB/s (2327.4KiB/s)
393 .RE
394 .P
395 If only one value is reported, then kb_base selects the one to use:
396 .P
397 .RS
398 .PD 0
399 1000 \-\- SI prefixes
400 .P
401 1024 \-\- IEC prefixes
402 .PD
403 .RE
404 .RE
405 .TP
406 .BI unit_base \fR=\fPint
407 Base unit for reporting. Allowed values are:
408 .RS
409 .RS
410 .TP
411 .B 0
412 Use auto\-detection (default).
413 .TP
414 .B 8
415 Byte based.
416 .TP
417 .B 1
418 Bit based.
419 .RE
420 .RE
421 .SS "Job description"
422 .TP
423 .BI name \fR=\fPstr
424 ASCII name of the job. This may be used to override the name printed by fio
425 for this job. Otherwise the job name is used. On the command line this
426 parameter has the special purpose of also signaling the start of a new job.
427 .TP
428 .BI description \fR=\fPstr
429 Text description of the job. Doesn't do anything except dump this text
430 description when this job is run. It's not parsed.
431 .TP
432 .BI loops \fR=\fPint
433 Run the specified number of iterations of this job. Used to repeat the same
434 workload a given number of times. Defaults to 1.
435 .TP
436 .BI numjobs \fR=\fPint
437 Create the specified number of clones of this job. Each clone of job
438 is spawned as an independent thread or process. May be used to setup a
439 larger number of threads/processes doing the same thing. Each thread is
440 reported separately; to see statistics for all clones as a whole, use
441 \fBgroup_reporting\fR in conjunction with \fBnew_group\fR.
442 See \fB\-\-max\-jobs\fR. Default: 1.
443 .SS "Time related parameters"
444 .TP
445 .BI runtime \fR=\fPtime
446 Tell fio to terminate processing after the specified period of time. It
447 can be quite hard to determine for how long a specified job will run, so
448 this parameter is handy to cap the total runtime to a given time. When
449 the unit is omitted, the value is intepreted in seconds.
450 .TP
451 .BI time_based
452 If set, fio will run for the duration of the \fBruntime\fR specified
453 even if the file(s) are completely read or written. It will simply loop over
454 the same workload as many times as the \fBruntime\fR allows.
455 .TP
456 .BI startdelay \fR=\fPirange(int)
457 Delay the start of job for the specified amount of time. Can be a single
458 value or a range. When given as a range, each thread will choose a value
459 randomly from within the range. Value is in seconds if a unit is omitted.
460 .TP
461 .BI ramp_time \fR=\fPtime
462 If set, fio will run the specified workload for this amount of time before
463 logging any performance numbers. Useful for letting performance settle
464 before logging results, thus minimizing the runtime required for stable
465 results. Note that the \fBramp_time\fR is considered lead in time for a job,
466 thus it will increase the total runtime if a special timeout or
467 \fBruntime\fR is specified. When the unit is omitted, the value is
468 given in seconds.
469 .TP
470 .BI clocksource \fR=\fPstr
471 Use the given clocksource as the base of timing. The supported options are:
472 .RS
473 .RS
474 .TP
475 .B gettimeofday
476 \fBgettimeofday\fR\|(2)
477 .TP
478 .B clock_gettime
479 \fBclock_gettime\fR\|(2)
480 .TP
481 .B cpu
482 Internal CPU clock source
483 .RE
484 .P
485 \fBcpu\fR is the preferred clocksource if it is reliable, as it is very fast (and
486 fio is heavy on time calls). Fio will automatically use this clocksource if
487 it's supported and considered reliable on the system it is running on,
488 unless another clocksource is specifically set. For x86/x86\-64 CPUs, this
489 means supporting TSC Invariant.
490 .RE
491 .TP
492 .BI gtod_reduce \fR=\fPbool
493 Enable all of the \fBgettimeofday\fR\|(2) reducing options
494 (\fBdisable_clat\fR, \fBdisable_slat\fR, \fBdisable_bw_measurement\fR) plus
495 reduce precision of the timeout somewhat to really shrink the
496 \fBgettimeofday\fR\|(2) call count. With this option enabled, we only do
497 about 0.4% of the \fBgettimeofday\fR\|(2) calls we would have done if all
498 time keeping was enabled.
499 .TP
500 .BI gtod_cpu \fR=\fPint
501 Sometimes it's cheaper to dedicate a single thread of execution to just
502 getting the current time. Fio (and databases, for instance) are very
503 intensive on \fBgettimeofday\fR\|(2) calls. With this option, you can set
504 one CPU aside for doing nothing but logging current time to a shared memory
505 location. Then the other threads/processes that run I/O workloads need only
506 copy that segment, instead of entering the kernel with a
507 \fBgettimeofday\fR\|(2) call. The CPU set aside for doing these time
508 calls will be excluded from other uses. Fio will manually clear it from the
509 CPU mask of other jobs.
510 .SS "Target file/device"
511 .TP
512 .BI directory \fR=\fPstr
513 Prefix \fBfilename\fRs with this directory. Used to place files in a different
514 location than `./'. You can specify a number of directories by
515 separating the names with a ':' character. These directories will be
516 assigned equally distributed to job clones created by \fBnumjobs\fR as
517 long as they are using generated filenames. If specific \fBfilename\fR(s) are
518 set fio will use the first listed directory, and thereby matching the
519 \fBfilename\fR semantic which generates a file each clone if not specified, but
520 let all clones use the same if set.
521 .RS
522 .P
523 See the \fBfilename\fR option for information on how to escape ':' and '\'
524 characters within the directory path itself.
525 .RE
526 .TP
527 .BI filename \fR=\fPstr
528 Fio normally makes up a \fBfilename\fR based on the job name, thread number, and
529 file number (see \fBfilename_format\fR). If you want to share files
530 between threads in a job or several
531 jobs with fixed file paths, specify a \fBfilename\fR for each of them to override
532 the default. If the ioengine is file based, you can specify a number of files
533 by separating the names with a ':' colon. So if you wanted a job to open
534 `/dev/sda' and `/dev/sdb' as the two working files, you would use
535 `filename=/dev/sda:/dev/sdb'. This also means that whenever this option is
536 specified, \fBnrfiles\fR is ignored. The size of regular files specified
537 by this option will be \fBsize\fR divided by number of files unless an
538 explicit size is specified by \fBfilesize\fR.
539 .RS
540 .P
541 Each colon and backslash in the wanted path must be escaped with a '\'
542 character. For instance, if the path is `/dev/dsk/foo@3,0:c' then you
543 would use `filename=/dev/dsk/foo@3,0\\:c' and if the path is
544 `F:\\\\filename' then you would use `filename=F\\:\\\\filename'.
545 .P
546 On Windows, disk devices are accessed as `\\\\\\\\.\\\\PhysicalDrive0' for
547 the first device, `\\\\\\\\.\\\\PhysicalDrive1' for the second etc.
548 Note: Windows and FreeBSD prevent write access to areas
549 of the disk containing in\-use data (e.g. filesystems).
550 .P
551 The filename `\-' is a reserved name, meaning *stdin* or *stdout*. Which
552 of the two depends on the read/write direction set.
553 .RE
554 .TP
555 .BI filename_format \fR=\fPstr
556 If sharing multiple files between jobs, it is usually necessary to have fio
557 generate the exact names that you want. By default, fio will name a file
558 based on the default file format specification of
559 `jobname.jobnumber.filenumber'. With this option, that can be
560 customized. Fio will recognize and replace the following keywords in this
561 string:
562 .RS
563 .RS
564 .TP
565 .B $jobname
566 The name of the worker thread or process.
567 .TP
568 .B $jobnum
569 The incremental number of the worker thread or process.
570 .TP
571 .B $filenum
572 The incremental number of the file for that worker thread or process.
573 .RE
574 .P
575 To have dependent jobs share a set of files, this option can be set to have
576 fio generate filenames that are shared between the two. For instance, if
577 `testfiles.$filenum' is specified, file number 4 for any job will be
578 named `testfiles.4'. The default of `$jobname.$jobnum.$filenum'
579 will be used if no other format specifier is given.
580 .RE
581 .TP
582 .BI unique_filename \fR=\fPbool
583 To avoid collisions between networked clients, fio defaults to prefixing any
584 generated filenames (with a directory specified) with the source of the
585 client connecting. To disable this behavior, set this option to 0.
586 .TP
587 .BI opendir \fR=\fPstr
588 Recursively open any files below directory \fIstr\fR.
589 .TP
590 .BI lockfile \fR=\fPstr
591 Fio defaults to not locking any files before it does I/O to them. If a file
592 or file descriptor is shared, fio can serialize I/O to that file to make the
593 end result consistent. This is usual for emulating real workloads that share
594 files. The lock modes are:
595 .RS
596 .RS
597 .TP
598 .B none
599 No locking. The default.
600 .TP
601 .B exclusive
602 Only one thread or process may do I/O at a time, excluding all others.
603 .TP
604 .B readwrite
605 Read\-write locking on the file. Many readers may
606 access the file at the same time, but writes get exclusive access.
607 .RE
608 .RE
609 .TP
610 .BI nrfiles \fR=\fPint
611 Number of files to use for this job. Defaults to 1. The size of files
612 will be \fBsize\fR divided by this unless explicit size is specified by
613 \fBfilesize\fR. Files are created for each thread separately, and each
614 file will have a file number within its name by default, as explained in
615 \fBfilename\fR section.
616 .TP
617 .BI openfiles \fR=\fPint
618 Number of files to keep open at the same time. Defaults to the same as
619 \fBnrfiles\fR, can be set smaller to limit the number simultaneous
620 opens.
621 .TP
622 .BI file_service_type \fR=\fPstr
623 Defines how fio decides which file from a job to service next. The following
624 types are defined:
625 .RS
626 .RS
627 .TP
628 .B random
629 Choose a file at random.
630 .TP
631 .B roundrobin
632 Round robin over opened files. This is the default.
633 .TP
634 .B sequential
635 Finish one file before moving on to the next. Multiple files can
636 still be open depending on \fBopenfiles\fR.
637 .TP
638 .B zipf
639 Use a Zipf distribution to decide what file to access.
640 .TP
641 .B pareto
642 Use a Pareto distribution to decide what file to access.
643 .TP
644 .B normal
645 Use a Gaussian (normal) distribution to decide what file to access.
646 .TP
647 .B gauss
648 Alias for normal.
649 .RE
650 .P
651 For \fBrandom\fR, \fBroundrobin\fR, and \fBsequential\fR, a postfix can be appended to
652 tell fio how many I/Os to issue before switching to a new file. For example,
653 specifying `file_service_type=random:8' would cause fio to issue
654 8 I/Os before selecting a new file at random. For the non\-uniform
655 distributions, a floating point postfix can be given to influence how the
656 distribution is skewed. See \fBrandom_distribution\fR for a description
657 of how that would work.
658 .RE
659 .TP
660 .BI ioscheduler \fR=\fPstr
661 Attempt to switch the device hosting the file to the specified I/O scheduler
662 before running.
663 .TP
664 .BI create_serialize \fR=\fPbool
665 If true, serialize the file creation for the jobs. This may be handy to
666 avoid interleaving of data files, which may greatly depend on the filesystem
667 used and even the number of processors in the system. Default: true.
668 .TP
669 .BI create_fsync \fR=\fPbool
670 \fBfsync\fR\|(2) the data file after creation. This is the default.
671 .TP
672 .BI create_on_open \fR=\fPbool
673 If true, don't pre\-create files but allow the job's open() to create a file
674 when it's time to do I/O. Default: false \-\- pre\-create all necessary files
675 when the job starts.
676 .TP
677 .BI create_only \fR=\fPbool
678 If true, fio will only run the setup phase of the job. If files need to be
679 laid out or updated on disk, only that will be done \-\- the actual job contents
680 are not executed. Default: false.
681 .TP
682 .BI allow_file_create \fR=\fPbool
683 If true, fio is permitted to create files as part of its workload. If this
684 option is false, then fio will error out if
685 the files it needs to use don't already exist. Default: true.
686 .TP
687 .BI allow_mounted_write \fR=\fPbool
688 If this isn't set, fio will abort jobs that are destructive (e.g. that write)
689 to what appears to be a mounted device or partition. This should help catch
690 creating inadvertently destructive tests, not realizing that the test will
691 destroy data on the mounted file system. Note that some platforms don't allow
692 writing against a mounted device regardless of this option. Default: false.
693 .TP
694 .BI pre_read \fR=\fPbool
695 If this is given, files will be pre\-read into memory before starting the
696 given I/O operation. This will also clear the \fBinvalidate\fR flag,
697 since it is pointless to pre\-read and then drop the cache. This will only
698 work for I/O engines that are seek\-able, since they allow you to read the
699 same data multiple times. Thus it will not work on non\-seekable I/O engines
700 (e.g. network, splice). Default: false.
701 .TP
702 .BI unlink \fR=\fPbool
703 Unlink the job files when done. Not the default, as repeated runs of that
704 job would then waste time recreating the file set again and again. Default:
705 false.
706 .TP
707 .BI unlink_each_loop \fR=\fPbool
708 Unlink job files after each iteration or loop. Default: false.
709 .TP
710 .BI zonesize \fR=\fPint
711 Divide a file into zones of the specified size. See \fBzoneskip\fR.
712 .TP
713 .BI zonerange \fR=\fPint
714 Give size of an I/O zone. See \fBzoneskip\fR.
715 .TP
716 .BI zoneskip \fR=\fPint
717 Skip the specified number of bytes when \fBzonesize\fR data has been
718 read. The two zone options can be used to only do I/O on zones of a file.
719 .SS "I/O type"
720 .TP
721 .BI direct \fR=\fPbool
722 If value is true, use non\-buffered I/O. This is usually O_DIRECT. Note that
723 ZFS on Solaris doesn't support direct I/O. On Windows the synchronous
724 ioengines don't support direct I/O. Default: false.
725 .TP
726 .BI atomic \fR=\fPbool
727 If value is true, attempt to use atomic direct I/O. Atomic writes are
728 guaranteed to be stable once acknowledged by the operating system. Only
729 Linux supports O_ATOMIC right now.
730 .TP
731 .BI buffered \fR=\fPbool
732 If value is true, use buffered I/O. This is the opposite of the
733 \fBdirect\fR option. Defaults to true.
734 .TP
735 .BI readwrite \fR=\fPstr "\fR,\fP rw" \fR=\fPstr
736 Type of I/O pattern. Accepted values are:
737 .RS
738 .RS
739 .TP
740 .B read
741 Sequential reads.
742 .TP
743 .B write
744 Sequential writes.
745 .TP
746 .B trim
747 Sequential trims (Linux block devices only).
748 .TP
749 .B randread
750 Random reads.
751 .TP
752 .B randwrite
753 Random writes.
754 .TP
755 .B randtrim
756 Random trims (Linux block devices only).
757 .TP
758 .B rw,readwrite
759 Sequential mixed reads and writes.
760 .TP
761 .B randrw
762 Random mixed reads and writes.
763 .TP
764 .B trimwrite
765 Sequential trim+write sequences. Blocks will be trimmed first,
766 then the same blocks will be written to.
767 .RE
768 .P
769 Fio defaults to read if the option is not specified. For the mixed I/O
770 types, the default is to split them 50/50. For certain types of I/O the
771 result may still be skewed a bit, since the speed may be different.
772 .P
773 It is possible to specify the number of I/Os to do before getting a new
774 offset by appending `:<nr>' to the end of the string given. For a
775 random read, it would look like `rw=randread:8' for passing in an offset
776 modifier with a value of 8. If the suffix is used with a sequential I/O
777 pattern, then the `<nr>' value specified will be added to the generated
778 offset for each I/O turning sequential I/O into sequential I/O with holes.
779 For instance, using `rw=write:4k' will skip 4k for every write. Also see
780 the \fBrw_sequencer\fR option.
781 .RE
782 .TP
783 .BI rw_sequencer \fR=\fPstr
784 If an offset modifier is given by appending a number to the `rw=\fIstr\fR'
785 line, then this option controls how that number modifies the I/O offset
786 being generated. Accepted values are:
787 .RS
788 .RS
789 .TP
790 .B sequential
791 Generate sequential offset.
792 .TP
793 .B identical
794 Generate the same offset.
795 .RE
796 .P
797 \fBsequential\fR is only useful for random I/O, where fio would normally
798 generate a new random offset for every I/O. If you append e.g. 8 to randread,
799 you would get a new random offset for every 8 I/Os. The result would be a
800 seek for only every 8 I/Os, instead of for every I/O. Use `rw=randread:8'
801 to specify that. As sequential I/O is already sequential, setting
802 \fBsequential\fR for that would not result in any differences. \fBidentical\fR
803 behaves in a similar fashion, except it sends the same offset 8 number of
804 times before generating a new offset.
805 .RE
806 .TP
807 .BI unified_rw_reporting \fR=\fPbool
808 Fio normally reports statistics on a per data direction basis, meaning that
809 reads, writes, and trims are accounted and reported separately. If this
810 option is set fio sums the results and report them as "mixed" instead.
811 .TP
812 .BI randrepeat \fR=\fPbool
813 Seed the random number generator used for random I/O patterns in a
814 predictable way so the pattern is repeatable across runs. Default: true.
815 .TP
816 .BI allrandrepeat \fR=\fPbool
817 Seed all random number generators in a predictable way so results are
818 repeatable across runs. Default: false.
819 .TP
820 .BI randseed \fR=\fPint
821 Seed the random number generators based on this seed value, to be able to
822 control what sequence of output is being generated. If not set, the random
823 sequence depends on the \fBrandrepeat\fR setting.
824 .TP
825 .BI fallocate \fR=\fPstr
826 Whether pre\-allocation is performed when laying down files.
827 Accepted values are:
828 .RS
829 .RS
830 .TP
831 .B none
832 Do not pre\-allocate space.
833 .TP
834 .B native
835 Use a platform's native pre\-allocation call but fall back to
836 \fBnone\fR behavior if it fails/is not implemented.
837 .TP
838 .B posix
839 Pre\-allocate via \fBposix_fallocate\fR\|(3).
840 .TP
841 .B keep
842 Pre\-allocate via \fBfallocate\fR\|(2) with
844 .TP
845 .B 0
846 Backward\-compatible alias for \fBnone\fR.
847 .TP
848 .B 1
849 Backward\-compatible alias for \fBposix\fR.
850 .RE
851 .P
852 May not be available on all supported platforms. \fBkeep\fR is only available
853 on Linux. If using ZFS on Solaris this cannot be set to \fBposix\fR
854 because ZFS doesn't support pre\-allocation. Default: \fBnative\fR if any
855 pre\-allocation methods are available, \fBnone\fR if not.
856 .RE
857 .TP
858 .BI fadvise_hint \fR=\fPstr
859 Use \fBposix_fadvise\fR\|(2) to advise the kernel what I/O patterns
860 are likely to be issued. Accepted values are:
861 .RS
862 .RS
863 .TP
864 .B 0
865 Backwards compatible hint for "no hint".
866 .TP
867 .B 1
868 Backwards compatible hint for "advise with fio workload type". This
869 uses FADV_RANDOM for a random workload, and FADV_SEQUENTIAL
870 for a sequential workload.
871 .TP
872 .B sequential
873 Advise using FADV_SEQUENTIAL.
874 .TP
875 .B random
876 Advise using FADV_RANDOM.
877 .RE
878 .RE
879 .TP
880 .BI write_hint \fR=\fPstr
881 Use \fBfcntl\fR\|(2) to advise the kernel what life time to expect
882 from a write. Only supported on Linux, as of version 4.13. Accepted
883 values are:
884 .RS
885 .RS
886 .TP
887 .B none
888 No particular life time associated with this file.
889 .TP
890 .B short
891 Data written to this file has a short life time.
892 .TP
893 .B medium
894 Data written to this file has a medium life time.
895 .TP
896 .B long
897 Data written to this file has a long life time.
898 .TP
899 .B extreme
900 Data written to this file has a very long life time.
901 .RE
902 .P
903 The values are all relative to each other, and no absolute meaning
904 should be associated with them.
905 .RE
906 .TP
907 .BI offset \fR=\fPint
908 Start I/O at the provided offset in the file, given as either a fixed size in
909 bytes or a percentage. If a percentage is given, the next \fBblockalign\fR\-ed
910 offset will be used. Data before the given offset will not be touched. This
911 effectively caps the file size at `real_size \- offset'. Can be combined with
912 \fBsize\fR to constrain the start and end range of the I/O workload.
913 A percentage can be specified by a number between 1 and 100 followed by '%',
914 for example, `offset=20%' to specify 20%.
915 .TP
916 .BI offset_increment \fR=\fPint
917 If this is provided, then the real offset becomes `\fBoffset\fR + \fBoffset_increment\fR
918 * thread_number', where the thread number is a counter that starts at 0 and
919 is incremented for each sub\-job (i.e. when \fBnumjobs\fR option is
920 specified). This option is useful if there are several jobs which are
921 intended to operate on a file in parallel disjoint segments, with even
922 spacing between the starting points.
923 .TP
924 .BI number_ios \fR=\fPint
925 Fio will normally perform I/Os until it has exhausted the size of the region
926 set by \fBsize\fR, or if it exhaust the allocated time (or hits an error
927 condition). With this setting, the range/size can be set independently of
928 the number of I/Os to perform. When fio reaches this number, it will exit
929 normally and report status. Note that this does not extend the amount of I/O
930 that will be done, it will only stop fio if this condition is met before
931 other end\-of\-job criteria.
932 .TP
933 .BI fsync \fR=\fPint
934 If writing to a file, issue an \fBfsync\fR\|(2) (or its equivalent) of
935 the dirty data for every number of blocks given. For example, if you give 32
936 as a parameter, fio will sync the file after every 32 writes issued. If fio is
937 using non\-buffered I/O, we may not sync the file. The exception is the sg
938 I/O engine, which synchronizes the disk cache anyway. Defaults to 0, which
939 means fio does not periodically issue and wait for a sync to complete. Also
940 see \fBend_fsync\fR and \fBfsync_on_close\fR.
941 .TP
942 .BI fdatasync \fR=\fPint
943 Like \fBfsync\fR but uses \fBfdatasync\fR\|(2) to only sync data and
944 not metadata blocks. In Windows, FreeBSD, and DragonFlyBSD there is no
945 \fBfdatasync\fR\|(2) so this falls back to using \fBfsync\fR\|(2).
946 Defaults to 0, which means fio does not periodically issue and wait for a
947 data\-only sync to complete.
948 .TP
949 .BI write_barrier \fR=\fPint
950 Make every N\-th write a barrier write.
951 .TP
952 .BI sync_file_range \fR=\fPstr:int
953 Use \fBsync_file_range\fR\|(2) for every \fIint\fR number of write
954 operations. Fio will track range of writes that have happened since the last
955 \fBsync_file_range\fR\|(2) call. \fIstr\fR can currently be one or more of:
956 .RS
957 .RS
958 .TP
959 .B wait_before
961 .TP
962 .B write
964 .TP
965 .B wait_after
967 .RE
968 .P
969 So if you do `sync_file_range=wait_before,write:8', fio would use
971 writes. Also see the \fBsync_file_range\fR\|(2) man page. This option is
972 Linux specific.
973 .RE
974 .TP
975 .BI overwrite \fR=\fPbool
976 If true, writes to a file will always overwrite existing data. If the file
977 doesn't already exist, it will be created before the write phase begins. If
978 the file exists and is large enough for the specified write phase, nothing
979 will be done. Default: false.
980 .TP
981 .BI end_fsync \fR=\fPbool
982 If true, \fBfsync\fR\|(2) file contents when a write stage has completed.
983 Default: false.
984 .TP
985 .BI fsync_on_close \fR=\fPbool
986 If true, fio will \fBfsync\fR\|(2) a dirty file on close. This differs
987 from \fBend_fsync\fR in that it will happen on every file close, not
988 just at the end of the job. Default: false.
989 .TP
990 .BI rwmixread \fR=\fPint
991 Percentage of a mixed workload that should be reads. Default: 50.
992 .TP
993 .BI rwmixwrite \fR=\fPint
994 Percentage of a mixed workload that should be writes. If both
995 \fBrwmixread\fR and \fBrwmixwrite\fR is given and the values do not
996 add up to 100%, the latter of the two will be used to override the
997 first. This may interfere with a given rate setting, if fio is asked to
998 limit reads or writes to a certain rate. If that is the case, then the
999 distribution may be skewed. Default: 50.
1000 .TP
1001 .BI random_distribution \fR=\fPstr:float[,str:float][,str:float]
1002 By default, fio will use a completely uniform random distribution when asked
1003 to perform random I/O. Sometimes it is useful to skew the distribution in
1004 specific ways, ensuring that some parts of the data is more hot than others.
1005 fio includes the following distribution models:
1006 .RS
1007 .RS
1008 .TP
1009 .B random
1010 Uniform random distribution
1011 .TP
1012 .B zipf
1013 Zipf distribution
1014 .TP
1015 .B pareto
1016 Pareto distribution
1017 .TP
1018 .B normal
1019 Normal (Gaussian) distribution
1020 .TP
1021 .B zoned
1022 Zoned random distribution
1023 .RE
1024 .P
1025 When using a \fBzipf\fR or \fBpareto\fR distribution, an input value is also
1026 needed to define the access pattern. For \fBzipf\fR, this is the `Zipf theta'.
1027 For \fBpareto\fR, it's the `Pareto power'. Fio includes a test
1028 program, \fBfio\-genzipf\fR, that can be used visualize what the given input
1029 values will yield in terms of hit rates. If you wanted to use \fBzipf\fR with
1030 a `theta' of 1.2, you would use `random_distribution=zipf:1.2' as the
1031 option. If a non\-uniform model is used, fio will disable use of the random
1032 map. For the \fBnormal\fR distribution, a normal (Gaussian) deviation is
1033 supplied as a value between 0 and 100.
1034 .P
1035 For a \fBzoned\fR distribution, fio supports specifying percentages of I/O
1036 access that should fall within what range of the file or device. For
1037 example, given a criteria of:
1038 .RS
1039 .P
1040 .PD 0
1041 60% of accesses should be to the first 10%
1042 .P
1043 30% of accesses should be to the next 20%
1044 .P
1045 8% of accesses should be to the next 30%
1046 .P
1047 2% of accesses should be to the next 40%
1048 .PD
1049 .RE
1050 .P
1051 we can define that through zoning of the random accesses. For the above
1052 example, the user would do:
1053 .RS
1054 .P
1055 random_distribution=zoned:60/10:30/20:8/30:2/40
1056 .RE
1057 .P
1058 similarly to how \fBbssplit\fR works for setting ranges and percentages
1059 of block sizes. Like \fBbssplit\fR, it's possible to specify separate
1060 zones for reads, writes, and trims. If just one set is given, it'll apply to
1061 all of them.
1062 .RE
1063 .TP
1064 .BI percentage_random \fR=\fPint[,int][,int]
1065 For a random workload, set how big a percentage should be random. This
1066 defaults to 100%, in which case the workload is fully random. It can be set
1067 from anywhere from 0 to 100. Setting it to 0 would make the workload fully
1068 sequential. Any setting in between will result in a random mix of sequential
1069 and random I/O, at the given percentages. Comma\-separated values may be
1070 specified for reads, writes, and trims as described in \fBblocksize\fR.
1071 .TP
1072 .BI norandommap
1073 Normally fio will cover every block of the file when doing random I/O. If
1074 this option is given, fio will just get a new random offset without looking
1075 at past I/O history. This means that some blocks may not be read or written,
1076 and that some blocks may be read/written more than once. If this option is
1077 used with \fBverify\fR and multiple blocksizes (via \fBbsrange\fR),
1078 only intact blocks are verified, i.e., partially\-overwritten blocks are
1079 ignored.
1080 .TP
1081 .BI softrandommap \fR=\fPbool
1082 See \fBnorandommap\fR. If fio runs with the random block map enabled and
1083 it fails to allocate the map, if this option is set it will continue without
1084 a random block map. As coverage will not be as complete as with random maps,
1085 this option is disabled by default.
1086 .TP
1087 .BI random_generator \fR=\fPstr
1088 Fio supports the following engines for generating I/O offsets for random I/O:
1089 .RS
1090 .RS
1091 .TP
1092 .B tausworthe
1093 Strong 2^88 cycle random number generator.
1094 .TP
1095 .B lfsr
1096 Linear feedback shift register generator.
1097 .TP
1098 .B tausworthe64
1099 Strong 64\-bit 2^258 cycle random number generator.
1100 .RE
1101 .P
1102 \fBtausworthe\fR is a strong random number generator, but it requires tracking
1103 on the side if we want to ensure that blocks are only read or written
1104 once. \fBlfsr\fR guarantees that we never generate the same offset twice, and
1105 it's also less computationally expensive. It's not a true random generator,
1106 however, though for I/O purposes it's typically good enough. \fBlfsr\fR only
1107 works with single block sizes, not with workloads that use multiple block
1108 sizes. If used with such a workload, fio may read or write some blocks
1109 multiple times. The default value is \fBtausworthe\fR, unless the required
1110 space exceeds 2^32 blocks. If it does, then \fBtausworthe64\fR is
1111 selected automatically.
1112 .RE
1113 .SS "Block size"
1114 .TP
1115 .BI blocksize \fR=\fPint[,int][,int] "\fR,\fB bs" \fR=\fPint[,int][,int]
1116 The block size in bytes used for I/O units. Default: 4096. A single value
1117 applies to reads, writes, and trims. Comma\-separated values may be
1118 specified for reads, writes, and trims. A value not terminated in a comma
1119 applies to subsequent types. Examples:
1120 .RS
1121 .RS
1122 .P
1123 .PD 0
1124 bs=256k        means 256k for reads, writes and trims.
1125 .P
1126 bs=8k,32k      means 8k for reads, 32k for writes and trims.
1127 .P
1128 bs=8k,32k,     means 8k for reads, 32k for writes, and default for trims.
1129 .P
1130 bs=,8k         means default for reads, 8k for writes and trims.
1131 .P
1132 bs=,8k,        means default for reads, 8k for writes, and default for trims.
1133 .PD
1134 .RE
1135 .RE
1136 .TP
1137 .BI blocksize_range \fR=\fPirange[,irange][,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange][,irange]
1138 A range of block sizes in bytes for I/O units. The issued I/O unit will
1139 always be a multiple of the minimum size, unless
1140 \fBblocksize_unaligned\fR is set.
1141 Comma\-separated ranges may be specified for reads, writes, and trims as
1142 described in \fBblocksize\fR. Example:
1143 .RS
1144 .RS
1145 .P
1146 bsrange=1k\-4k,2k\-8k
1147 .RE
1148 .RE
1149 .TP
1150 .BI bssplit \fR=\fPstr[,str][,str]
1151 Sometimes you want even finer grained control of the block sizes issued, not
1152 just an even split between them. This option allows you to weight various
1153 block sizes, so that you are able to define a specific amount of block sizes
1154 issued. The format for this option is:
1155 .RS
1156 .RS
1157 .P
1158 bssplit=blocksize/percentage:blocksize/percentage
1159 .RE
1160 .P
1161 for as many block sizes as needed. So if you want to define a workload that
1162 has 50% 64k blocks, 10% 4k blocks, and 40% 32k blocks, you would write:
1163 .RS
1164 .P
1165 bssplit=4k/10:64k/50:32k/40
1166 .RE
1167 .P
1168 Ordering does not matter. If the percentage is left blank, fio will fill in
1169 the remaining values evenly. So a bssplit option like this one:
1170 .RS
1171 .P
1172 bssplit=4k/50:1k/:32k/
1173 .RE
1174 .P
1175 would have 50% 4k ios, and 25% 1k and 32k ios. The percentages always add up
1176 to 100, if bssplit is given a range that adds up to more, it will error out.
1177 .P
1178 Comma\-separated values may be specified for reads, writes, and trims as
1179 described in \fBblocksize\fR.
1180 .P
1181 If you want a workload that has 50% 2k reads and 50% 4k reads, while having
1182 90% 4k writes and 10% 8k writes, you would specify:
1183 .RS
1184 .P
1185 bssplit=2k/50:4k/50,4k/90,8k/10
1186 .RE
1187 .RE
1188 .TP
1189 .BI blocksize_unaligned "\fR,\fB bs_unaligned"
1190 If set, fio will issue I/O units with any size within
1191 \fBblocksize_range\fR, not just multiples of the minimum size. This
1192 typically won't work with direct I/O, as that normally requires sector
1193 alignment.
1194 .TP
1195 .BI bs_is_seq_rand \fR=\fPbool
1196 If this option is set, fio will use the normal read,write blocksize settings
1197 as sequential,random blocksize settings instead. Any random read or write
1198 will use the WRITE blocksize settings, and any sequential read or write will
1199 use the READ blocksize settings.
1200 .TP
1201 .BI blockalign \fR=\fPint[,int][,int] "\fR,\fB ba" \fR=\fPint[,int][,int]
1202 Boundary to which fio will align random I/O units. Default:
1203 \fBblocksize\fR. Minimum alignment is typically 512b for using direct
1204 I/O, though it usually depends on the hardware block size. This option is
1205 mutually exclusive with using a random map for files, so it will turn off
1206 that option. Comma\-separated values may be specified for reads, writes, and
1207 trims as described in \fBblocksize\fR.
1208 .SS "Buffers and memory"
1209 .TP
1210 .BI zero_buffers
1211 Initialize buffers with all zeros. Default: fill buffers with random data.
1212 .TP
1213 .BI refill_buffers
1214 If this option is given, fio will refill the I/O buffers on every
1215 submit. The default is to only fill it at init time and reuse that
1216 data. Only makes sense if zero_buffers isn't specified, naturally. If data
1217 verification is enabled, \fBrefill_buffers\fR is also automatically enabled.
1218 .TP
1219 .BI scramble_buffers \fR=\fPbool
1220 If \fBrefill_buffers\fR is too costly and the target is using data
1221 deduplication, then setting this option will slightly modify the I/O buffer
1222 contents to defeat normal de\-dupe attempts. This is not enough to defeat
1223 more clever block compression attempts, but it will stop naive dedupe of
1224 blocks. Default: true.
1225 .TP
1226 .BI buffer_compress_percentage \fR=\fPint
1227 If this is set, then fio will attempt to provide I/O buffer content (on
1228 WRITEs) that compresses to the specified level. Fio does this by providing a
1229 mix of random data and a fixed pattern. The fixed pattern is either zeros,
1230 or the pattern specified by \fBbuffer_pattern\fR. If the pattern option
1231 is used, it might skew the compression ratio slightly. Note that this is per
1232 block size unit, for file/disk wide compression level that matches this
1233 setting, you'll also want to set \fBrefill_buffers\fR.
1234 .TP
1235 .BI buffer_compress_chunk \fR=\fPint
1236 See \fBbuffer_compress_percentage\fR. This setting allows fio to manage
1237 how big the ranges of random data and zeroed data is. Without this set, fio
1238 will provide \fBbuffer_compress_percentage\fR of blocksize random data,
1239 followed by the remaining zeroed. With this set to some chunk size smaller
1240 than the block size, fio can alternate random and zeroed data throughout the
1241 I/O buffer.
1242 .TP
1243 .BI buffer_pattern \fR=\fPstr
1244 If set, fio will fill the I/O buffers with this pattern or with the contents
1245 of a file. If not set, the contents of I/O buffers are defined by the other
1246 options related to buffer contents. The setting can be any pattern of bytes,
1247 and can be prefixed with 0x for hex values. It may also be a string, where
1248 the string must then be wrapped with "". Or it may also be a filename,
1249 where the filename must be wrapped with '' in which case the file is
1250 opened and read. Note that not all the file contents will be read if that
1251 would cause the buffers to overflow. So, for example:
1252 .RS
1253 .RS
1254 .P
1255 .PD 0
1256 buffer_pattern='filename'
1257 .P
1258 or:
1259 .P
1260 buffer_pattern="abcd"
1261 .P
1262 or:
1263 .P
1264 buffer_pattern=\-12
1265 .P
1266 or:
1267 .P
1268 buffer_pattern=0xdeadface
1269 .PD
1270 .RE
1271 .P
1272 Also you can combine everything together in any order:
1273 .RS
1274 .P
1275 buffer_pattern=0xdeadface"abcd"\-12'filename'
1276 .RE
1277 .RE
1278 .TP
1279 .BI dedupe_percentage \fR=\fPint
1280 If set, fio will generate this percentage of identical buffers when
1281 writing. These buffers will be naturally dedupable. The contents of the
1282 buffers depend on what other buffer compression settings have been set. It's
1283 possible to have the individual buffers either fully compressible, or not at
1284 all. This option only controls the distribution of unique buffers.
1285 .TP
1286 .BI invalidate \fR=\fPbool
1287 Invalidate the buffer/page cache parts of the files to be used prior to
1288 starting I/O if the platform and file type support it. Defaults to true.
1289 This will be ignored if \fBpre_read\fR is also specified for the
1290 same job.
1291 .TP
1292 .BI sync \fR=\fPbool
1293 Use synchronous I/O for buffered writes. For the majority of I/O engines,
1294 this means using O_SYNC. Default: false.
1295 .TP
1296 .BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
1297 Fio can use various types of memory as the I/O unit buffer. The allowed
1298 values are:
1299 .RS
1300 .RS
1301 .TP
1302 .B malloc
1303 Use memory from \fBmalloc\fR\|(3) as the buffers. Default memory type.
1304 .TP
1305 .B shm
1306 Use shared memory as the buffers. Allocated through \fBshmget\fR\|(2).
1307 .TP
1308 .B shmhuge
1309 Same as \fBshm\fR, but use huge pages as backing.
1310 .TP
1311 .B mmap
1312 Use \fBmmap\fR\|(2) to allocate buffers. May either be anonymous memory, or can
1313 be file backed if a filename is given after the option. The format
1314 is `mem=mmap:/path/to/file'.
1315 .TP
1316 .B mmaphuge
1317 Use a memory mapped huge file as the buffer backing. Append filename
1318 after mmaphuge, ala `mem=mmaphuge:/hugetlbfs/file'.
1319 .TP
1320 .B mmapshared
1321 Same as \fBmmap\fR, but use a MMAP_SHARED mapping.
1322 .TP
1323 .B cudamalloc
1324 Use GPU memory as the buffers for GPUDirect RDMA benchmark.
1325 The \fBioengine\fR must be \fBrdma\fR.
1326 .RE
1327 .P
1328 The area allocated is a function of the maximum allowed bs size for the job,
1329 multiplied by the I/O depth given. Note that for \fBshmhuge\fR and
1330 \fBmmaphuge\fR to work, the system must have free huge pages allocated. This
1331 can normally be checked and set by reading/writing
1332 `/proc/sys/vm/nr_hugepages' on a Linux system. Fio assumes a huge page
1333 is 4MiB in size. So to calculate the number of huge pages you need for a
1334 given job file, add up the I/O depth of all jobs (normally one unless
1335 \fBiodepth\fR is used) and multiply by the maximum bs set. Then divide
1336 that number by the huge page size. You can see the size of the huge pages in
1337 `/proc/meminfo'. If no huge pages are allocated by having a non\-zero
1338 number in `nr_hugepages', using \fBmmaphuge\fR or \fBshmhuge\fR will fail. Also
1339 see \fBhugepage\-size\fR.
1340 .P
1341 \fBmmaphuge\fR also needs to have hugetlbfs mounted and the file location
1342 should point there. So if it's mounted in `/huge', you would use
1343 `mem=mmaphuge:/huge/somefile'.
1344 .RE
1345 .TP
1346 .BI iomem_align \fR=\fPint "\fR,\fP mem_align" \fR=\fPint
1347 This indicates the memory alignment of the I/O memory buffers. Note that
1348 the given alignment is applied to the first I/O unit buffer, if using
1349 \fBiodepth\fR the alignment of the following buffers are given by the
1350 \fBbs\fR used. In other words, if using a \fBbs\fR that is a
1351 multiple of the page sized in the system, all buffers will be aligned to
1352 this value. If using a \fBbs\fR that is not page aligned, the alignment
1353 of subsequent I/O memory buffers is the sum of the \fBiomem_align\fR and
1354 \fBbs\fR used.
1355 .TP
1356 .BI hugepage\-size \fR=\fPint
1357 Defines the size of a huge page. Must at least be equal to the system
1358 setting, see `/proc/meminfo'. Defaults to 4MiB. Should probably
1359 always be a multiple of megabytes, so using `hugepage\-size=Xm' is the
1360 preferred way to set this to avoid setting a non\-pow\-2 bad value.
1361 .TP
1362 .BI lockmem \fR=\fPint
1363 Pin the specified amount of memory with \fBmlock\fR\|(2). Can be used to
1364 simulate a smaller amount of memory. The amount specified is per worker.
1365 .SS "I/O size"
1366 .TP
1367 .BI size \fR=\fPint
1368 The total size of file I/O for each thread of this job. Fio will run until
1369 this many bytes has been transferred, unless runtime is limited by other options
1370 (such as \fBruntime\fR, for instance, or increased/decreased by \fBio_size\fR).
1371 Fio will divide this size between the available files determined by options
1372 such as \fBnrfiles\fR, \fBfilename\fR, unless \fBfilesize\fR is
1373 specified by the job. If the result of division happens to be 0, the size is
1374 set to the physical size of the given files or devices if they exist.
1375 If this option is not specified, fio will use the full size of the given
1376 files or devices. If the files do not exist, size must be given. It is also
1377 possible to give size as a percentage between 1 and 100. If `size=20%' is
1378 given, fio will use 20% of the full size of the given files or devices.
1379 Can be combined with \fBoffset\fR to constrain the start and end range
1380 that I/O will be done within.
1381 .TP
1382 .BI io_size \fR=\fPint "\fR,\fB io_limit" \fR=\fPint
1383 Normally fio operates within the region set by \fBsize\fR, which means
1384 that the \fBsize\fR option sets both the region and size of I/O to be
1385 performed. Sometimes that is not what you want. With this option, it is
1386 possible to define just the amount of I/O that fio should do. For instance,
1387 if \fBsize\fR is set to 20GiB and \fBio_size\fR is set to 5GiB, fio
1388 will perform I/O within the first 20GiB but exit when 5GiB have been
1389 done. The opposite is also possible \-\- if \fBsize\fR is set to 20GiB,
1390 and \fBio_size\fR is set to 40GiB, then fio will do 40GiB of I/O within
1391 the 0..20GiB region.
1392 .TP
1393 .BI filesize \fR=\fPirange(int)
1394 Individual file sizes. May be a range, in which case fio will select sizes
1395 for files at random within the given range and limited to \fBsize\fR in
1396 total (if that is given). If not given, each created file is the same size.
1397 This option overrides \fBsize\fR in terms of file size, which means
1398 this value is used as a fixed size or possible range of each file.
1399 .TP
1400 .BI file_append \fR=\fPbool
1401 Perform I/O after the end of the file. Normally fio will operate within the
1402 size of a file. If this option is set, then fio will append to the file
1403 instead. This has identical behavior to setting \fBoffset\fR to the size
1404 of a file. This option is ignored on non\-regular files.
1405 .TP
1406 .BI fill_device \fR=\fPbool "\fR,\fB fill_fs" \fR=\fPbool
1407 Sets size to something really large and waits for ENOSPC (no space left on
1408 device) as the terminating condition. Only makes sense with sequential
1409 write. For a read workload, the mount point will be filled first then I/O
1410 started on the result. This option doesn't make sense if operating on a raw
1411 device node, since the size of that is already known by the file system.
1412 Additionally, writing beyond end\-of\-device will not return ENOSPC there.
1413 .SS "I/O engine"
1414 .TP
1415 .BI ioengine \fR=\fPstr
1416 Defines how the job issues I/O to the file. The following types are defined:
1417 .RS
1418 .RS
1419 .TP
1420 .B sync
1421 Basic \fBread\fR\|(2) or \fBwrite\fR\|(2)
1422 I/O. \fBlseek\fR\|(2) is used to position the I/O location.
1423 See \fBfsync\fR and \fBfdatasync\fR for syncing write I/Os.
1424 .TP
1425 .B psync
1426 Basic \fBpread\fR\|(2) or \fBpwrite\fR\|(2) I/O. Default on
1427 all supported operating systems except for Windows.
1428 .TP
1429 .B vsync
1430 Basic \fBreadv\fR\|(2) or \fBwritev\fR\|(2) I/O. Will emulate
1431 queuing by coalescing adjacent I/Os into a single submission.
1432 .TP
1433 .B pvsync
1434 Basic \fBpreadv\fR\|(2) or \fBpwritev\fR\|(2) I/O.
1435 .TP
1436 .B pvsync2
1437 Basic \fBpreadv2\fR\|(2) or \fBpwritev2\fR\|(2) I/O.
1438 .TP
1439 .B libaio
1440 Linux native asynchronous I/O. Note that Linux may only support
1441 queued behavior with non\-buffered I/O (set `direct=1' or
1442 `buffered=0').
1443 This engine defines engine specific options.
1444 .TP
1445 .B posixaio
1446 POSIX asynchronous I/O using \fBaio_read\fR\|(3) and
1447 \fBaio_write\fR\|(3).
1448 .TP
1449 .B solarisaio
1450 Solaris native asynchronous I/O.
1451 .TP
1452 .B windowsaio
1453 Windows native asynchronous I/O. Default on Windows.
1454 .TP
1455 .B mmap
1456 File is memory mapped with \fBmmap\fR\|(2) and data copied
1457 to/from using \fBmemcpy\fR\|(3).
1458 .TP
1459 .B splice
1460 \fBsplice\fR\|(2) is used to transfer the data and
1461 \fBvmsplice\fR\|(2) to transfer data from user space to the
1462 kernel.
1463 .TP
1464 .B sg
1465 SCSI generic sg v3 I/O. May either be synchronous using the SG_IO
1466 ioctl, or if the target is an sg character device we use
1467 \fBread\fR\|(2) and \fBwrite\fR\|(2) for asynchronous
1468 I/O. Requires \fBfilename\fR option to specify either block or
1469 character devices.
1470 .TP
1471 .B null
1472 Doesn't transfer any data, just pretends to. This is mainly used to
1473 exercise fio itself and for debugging/testing purposes.
1474 .TP
1475 .B net
1476 Transfer over the network to given `host:port'. Depending on the
1477 \fBprotocol\fR used, the \fBhostname\fR, \fBport\fR,
1478 \fBlisten\fR and \fBfilename\fR options are used to specify
1479 what sort of connection to make, while the \fBprotocol\fR option
1480 determines which protocol will be used. This engine defines engine
1481 specific options.
1482 .TP
1483 .B netsplice
1484 Like \fBnet\fR, but uses \fBsplice\fR\|(2) and
1485 \fBvmsplice\fR\|(2) to map data and send/receive.
1486 This engine defines engine specific options.
1487 .TP
1488 .B cpuio
1489 Doesn't transfer any data, but burns CPU cycles according to the
1490 \fBcpuload\fR and \fBcpuchunks\fR options. Setting
1491 \fBcpuload\fR\=85 will cause that job to do nothing but burn 85%
1492 of the CPU. In case of SMP machines, use `numjobs=<nr_of_cpu>'
1493 to get desired CPU usage, as the cpuload only loads a
1494 single CPU at the desired rate. A job never finishes unless there is
1495 at least one non\-cpuio job.
1496 .TP
1497 .B guasi
1498 The GUASI I/O engine is the Generic Userspace Asyncronous Syscall
1499 Interface approach to async I/O. See \fIhttp://www.xmailserver.org/guasi\-lib.html\fR
1500 for more info on GUASI.
1501 .TP
1502 .B rdma
1503 The RDMA I/O engine supports both RDMA memory semantics
1504 (RDMA_WRITE/RDMA_READ) and channel semantics (Send/Recv) for the
1505 InfiniBand, RoCE and iWARP protocols.
1506 .TP
1507 .B falloc
1508 I/O engine that does regular fallocate to simulate data transfer as
1509 fio ioengine.
1510 .RS
1511 .P
1512 .PD 0
1513 DDIR_READ      does fallocate(,mode = FALLOC_FL_KEEP_SIZE,).
1514 .P
1515 DIR_WRITE      does fallocate(,mode = 0).
1516 .P
1517 DDIR_TRIM      does fallocate(,mode = FALLOC_FL_KEEP_SIZE|FALLOC_FL_PUNCH_HOLE).
1518 .PD
1519 .RE
1520 .TP
1521 .B ftruncate
1522 I/O engine that sends \fBftruncate\fR\|(2) operations in response
1523 to write (DDIR_WRITE) events. Each ftruncate issued sets the file's
1524 size to the current block offset. \fBblocksize\fR is ignored.
1525 .TP
1526 .B e4defrag
1527 I/O engine that does regular EXT4_IOC_MOVE_EXT ioctls to simulate
1528 defragment activity in request to DDIR_WRITE event.
1529 .TP
1530 .B rbd
1531 I/O engine supporting direct access to Ceph Rados Block Devices
1532 (RBD) via librbd without the need to use the kernel rbd driver. This
1533 ioengine defines engine specific options.
1534 .TP
1535 .B gfapi
1536 Using GlusterFS libgfapi sync interface to direct access to
1537 GlusterFS volumes without having to go through FUSE. This ioengine
1538 defines engine specific options.
1539 .TP
1540 .B gfapi_async
1541 Using GlusterFS libgfapi async interface to direct access to
1542 GlusterFS volumes without having to go through FUSE. This ioengine
1543 defines engine specific options.
1544 .TP
1545 .B libhdfs
1546 Read and write through Hadoop (HDFS). The \fBfilename\fR option
1547 is used to specify host,port of the hdfs name\-node to connect. This
1548 engine interprets offsets a little differently. In HDFS, files once
1549 created cannot be modified so random writes are not possible. To
1550 imitate this the libhdfs engine expects a bunch of small files to be
1551 created over HDFS and will randomly pick a file from them
1552 based on the offset generated by fio backend (see the example
1553 job file to create such files, use `rw=write' option). Please
1554 note, it may be necessary to set environment variables to work
1555 with HDFS/libhdfs properly. Each job uses its own connection to
1556 HDFS.
1557 .TP
1558 .B mtd
1559 Read, write and erase an MTD character device (e.g.,
1560 `/dev/mtd0'). Discards are treated as erases. Depending on the
1561 underlying device type, the I/O may have to go in a certain pattern,
1562 e.g., on NAND, writing sequentially to erase blocks and discarding
1563 before overwriting. The \fBtrimwrite\fR mode works well for this
1564 constraint.
1565 .TP
1566 .B pmemblk
1567 Read and write using filesystem DAX to a file on a filesystem
1568 mounted with DAX on a persistent memory device through the NVML
1569 libpmemblk library.
1570 .TP
1571 .B dev\-dax
1572 Read and write using device DAX to a persistent memory device (e.g.,
1573 /dev/dax0.0) through the NVML libpmem library.
1574 .TP
1575 .B external
1576 Prefix to specify loading an external I/O engine object file. Append
1577 the engine filename, e.g. `ioengine=external:/tmp/foo.o' to load
1578 ioengine `foo.o' in `/tmp'.
1579 .SS "I/O engine specific parameters"
1580 In addition, there are some parameters which are only valid when a specific
1581 \fBioengine\fR is in use. These are used identically to normal parameters,
1582 with the caveat that when used on the command line, they must come after the
1583 \fBioengine\fR that defines them is selected.
1584 .TP
1585 .BI (libaio)userspace_reap
1586 Normally, with the libaio engine in use, fio will use the
1587 \fBio_getevents\fR\|(3) system call to reap newly returned events. With
1588 this flag turned on, the AIO ring will be read directly from user\-space to
1589 reap events. The reaping mode is only enabled when polling for a minimum of
1590 0 events (e.g. when `iodepth_batch_complete=0').
1591 .TP
1592 .BI (pvsync2)hipri
1593 Set RWF_HIPRI on I/O, indicating to the kernel that it's of higher priority
1594 than normal.
1595 .TP
1596 .BI (pvsync2)hipri_percentage
1597 When hipri is set this determines the probability of a pvsync2 I/O being high
1598 priority. The default is 100%.
1599 .TP
1600 .BI (cpuio)cpuload \fR=\fPint
1601 Attempt to use the specified percentage of CPU cycles. This is a mandatory
1602 option when using cpuio I/O engine.
1603 .TP
1604 .BI (cpuio)cpuchunks \fR=\fPint
1605 Split the load into cycles of the given time. In microseconds.
1606 .TP
1607 .BI (cpuio)exit_on_io_done \fR=\fPbool
1608 Detect when I/O threads are done, then exit.
1609 .TP
1610 .BI (libhdfs)namenode \fR=\fPstr
1611 The hostname or IP address of a HDFS cluster namenode to contact.
1612 .TP
1613 .BI (libhdfs)port
1614 The listening port of the HFDS cluster namenode.
1615 .TP
1616 .BI (netsplice,net)port
1617 The TCP or UDP port to bind to or connect to. If this is used with
1618 \fBnumjobs\fR to spawn multiple instances of the same job type, then
1619 this will be the starting port number since fio will use a range of
1620 ports.
1621 .TP
1622 .BI (netsplice,net)hostname \fR=\fPstr
1623 The hostname or IP address to use for TCP or UDP based I/O. If the job is
1624 a TCP listener or UDP reader, the hostname is not used and must be omitted
1625 unless it is a valid UDP multicast address.
1626 .TP
1627 .BI (netsplice,net)interface \fR=\fPstr
1628 The IP address of the network interface used to send or receive UDP
1629 multicast.
1630 .TP
1631 .BI (netsplice,net)ttl \fR=\fPint
1632 Time\-to\-live value for outgoing UDP multicast packets. Default: 1.
1633 .TP
1634 .BI (netsplice,net)nodelay \fR=\fPbool
1635 Set TCP_NODELAY on TCP connections.
1636 .TP
1637 .BI (netsplice,net)protocol \fR=\fPstr "\fR,\fP proto" \fR=\fPstr
1638 The network protocol to use. Accepted values are:
1639 .RS
1640 .RS
1641 .TP
1642 .B tcp
1643 Transmission control protocol.
1644 .TP
1645 .B tcpv6
1646 Transmission control protocol V6.
1647 .TP
1648 .B udp
1649 User datagram protocol.
1650 .TP
1651 .B udpv6
1652 User datagram protocol V6.
1653 .TP
1654 .B unix
1655 UNIX domain socket.
1656 .RE
1657 .P
1658 When the protocol is TCP or UDP, the port must also be given, as well as the
1659 hostname if the job is a TCP listener or UDP reader. For unix sockets, the
1660 normal \fBfilename\fR option should be used and the port is invalid.
1661 .RE
1662 .TP
1663 .BI (netsplice,net)listen
1664 For TCP network connections, tell fio to listen for incoming connections
1665 rather than initiating an outgoing connection. The \fBhostname\fR must
1666 be omitted if this option is used.
1667 .TP
1668 .BI (netsplice,net)pingpong
1669 Normally a network writer will just continue writing data, and a network
1670 reader will just consume packages. If `pingpong=1' is set, a writer will
1671 send its normal payload to the reader, then wait for the reader to send the
1672 same payload back. This allows fio to measure network latencies. The
1673 submission and completion latencies then measure local time spent sending or
1674 receiving, and the completion latency measures how long it took for the
1675 other end to receive and send back. For UDP multicast traffic
1676 `pingpong=1' should only be set for a single reader when multiple readers
1677 are listening to the same address.
1678 .TP
1679 .BI (netsplice,net)window_size \fR=\fPint
1680 Set the desired socket buffer size for the connection.
1681 .TP
1682 .BI (netsplice,net)mss \fR=\fPint
1683 Set the TCP maximum segment size (TCP_MAXSEG).
1684 .TP
1685 .BI (e4defrag)donorname \fR=\fPstr
1686 File will be used as a block donor (swap extents between files).
1687 .TP
1688 .BI (e4defrag)inplace \fR=\fPint
1689 Configure donor file blocks allocation strategy:
1690 .RS
1691 .RS
1692 .TP
1693 .B 0
1694 Default. Preallocate donor's file on init.
1695 .TP
1696 .B 1
1697 Allocate space immediately inside defragment event, and free right
1698 after event.
1699 .RE
1700 .RE
1701 .TP
1702 .BI (rbd)clustername \fR=\fPstr
1703 Specifies the name of the Ceph cluster.
1704 .TP
1705 .BI (rbd)rbdname \fR=\fPstr
1706 Specifies the name of the RBD.
1707 .TP
1708 .BI (rbd)pool \fR=\fPstr
1709 Specifies the name of the Ceph pool containing RBD.
1710 .TP
1711 .BI (rbd)clientname \fR=\fPstr
1712 Specifies the username (without the 'client.' prefix) used to access the
1713 Ceph cluster. If the \fBclustername\fR is specified, the \fBclientname\fR shall be
1714 the full *type.id* string. If no type. prefix is given, fio will add 'client.'
1715 by default.
1716 .TP
1717 .BI (mtd)skip_bad \fR=\fPbool
1718 Skip operations against known bad blocks.
1719 .TP
1720 .BI (libhdfs)hdfsdirectory
1721 libhdfs will create chunk in this HDFS directory.
1722 .TP
1723 .BI (libhdfs)chunk_size
1724 The size of the chunk to use for each file.
1725 .SS "I/O depth"
1726 .TP
1727 .BI iodepth \fR=\fPint
1728 Number of I/O units to keep in flight against the file. Note that
1729 increasing \fBiodepth\fR beyond 1 will not affect synchronous ioengines (except
1730 for small degrees when \fBverify_async\fR is in use). Even async
1731 engines may impose OS restrictions causing the desired depth not to be
1732 achieved. This may happen on Linux when using libaio and not setting
1733 `direct=1', since buffered I/O is not async on that OS. Keep an
1734 eye on the I/O depth distribution in the fio output to verify that the
1735 achieved depth is as expected. Default: 1.
1736 .TP
1737 .BI iodepth_batch_submit \fR=\fPint "\fR,\fP iodepth_batch" \fR=\fPint
1738 This defines how many pieces of I/O to submit at once. It defaults to 1
1739 which means that we submit each I/O as soon as it is available, but can be
1740 raised to submit bigger batches of I/O at the time. If it is set to 0 the
1741 \fBiodepth\fR value will be used.
1742 .TP
1743 .BI iodepth_batch_complete_min \fR=\fPint "\fR,\fP iodepth_batch_complete" \fR=\fPint
1744 This defines how many pieces of I/O to retrieve at once. It defaults to 1
1745 which means that we'll ask for a minimum of 1 I/O in the retrieval process
1746 from the kernel. The I/O retrieval will go on until we hit the limit set by
1747 \fBiodepth_low\fR. If this variable is set to 0, then fio will always
1748 check for completed events before queuing more I/O. This helps reduce I/O
1749 latency, at the cost of more retrieval system calls.
1750 .TP
1751 .BI iodepth_batch_complete_max \fR=\fPint
1752 This defines maximum pieces of I/O to retrieve at once. This variable should
1753 be used along with \fBiodepth_batch_complete_min\fR=\fIint\fR variable,
1754 specifying the range of min and max amount of I/O which should be
1755 retrieved. By default it is equal to \fBiodepth_batch_complete_min\fR
1756 value. Example #1:
1757 .RS
1758 .RS
1759 .P
1760 .PD 0
1761 iodepth_batch_complete_min=1
1762 .P
1763 iodepth_batch_complete_max=<iodepth>
1764 .PD
1765 .RE
1766 .P
1767 which means that we will retrieve at least 1 I/O and up to the whole
1768 submitted queue depth. If none of I/O has been completed yet, we will wait.
1769 Example #2:
1770 .RS
1771 .P
1772 .PD 0
1773 iodepth_batch_complete_min=0
1774 .P
1775 iodepth_batch_complete_max=<iodepth>
1776 .PD
1777 .RE
1778 .P
1779 which means that we can retrieve up to the whole submitted queue depth, but
1780 if none of I/O has been completed yet, we will NOT wait and immediately exit
1781 the system call. In this example we simply do polling.
1782 .RE
1783 .TP
1784 .BI iodepth_low \fR=\fPint
1785 The low water mark indicating when to start filling the queue
1786 again. Defaults to the same as \fBiodepth\fR, meaning that fio will
1787 attempt to keep the queue full at all times. If \fBiodepth\fR is set to
1788 e.g. 16 and \fBiodepth_low\fR is set to 4, then after fio has filled the queue of
1789 16 requests, it will let the depth drain down to 4 before starting to fill
1790 it again.
1791 .TP
1792 .BI serialize_overlap \fR=\fPbool
1793 Serialize in-flight I/Os that might otherwise cause or suffer from data races.
1794 When two or more I/Os are submitted simultaneously, there is no guarantee that
1795 the I/Os will be processed or completed in the submitted order. Further, if
1796 two or more of those I/Os are writes, any overlapping region between them can
1797 become indeterminate/undefined on certain storage. These issues can cause
1798 verification to fail erratically when at least one of the racing I/Os is
1799 changing data and the overlapping region has a non-zero size. Setting
1800 \fBserialize_overlap\fR tells fio to avoid provoking this behavior by explicitly
1801 serializing in-flight I/Os that have a non-zero overlap. Note that setting
1802 this option can reduce both performance and the \fBiodepth\fR achieved.
1803 Additionally this option does not work when \fBio_submit_mode\fR is set to
1804 offload. Default: false.
1805 .TP
1806 .BI io_submit_mode \fR=\fPstr
1807 This option controls how fio submits the I/O to the I/O engine. The default
1808 is `inline', which means that the fio job threads submit and reap I/O
1809 directly. If set to `offload', the job threads will offload I/O submission
1810 to a dedicated pool of I/O threads. This requires some coordination and thus
1811 has a bit of extra overhead, especially for lower queue depth I/O where it
1812 can increase latencies. The benefit is that fio can manage submission rates
1813 independently of the device completion rates. This avoids skewed latency
1814 reporting if I/O gets backed up on the device side (the coordinated omission
1815 problem).
1816 .SS "I/O rate"
1817 .TP
1818 .BI thinktime \fR=\fPtime
1819 Stall the job for the specified period of time after an I/O has completed before issuing the
1820 next. May be used to simulate processing being done by an application.
1821 When the unit is omitted, the value is interpreted in microseconds. See
1822 \fBthinktime_blocks\fR and \fBthinktime_spin\fR.
1823 .TP
1824 .BI thinktime_spin \fR=\fPtime
1825 Only valid if \fBthinktime\fR is set \- pretend to spend CPU time doing
1826 something with the data received, before falling back to sleeping for the
1827 rest of the period specified by \fBthinktime\fR. When the unit is
1828 omitted, the value is interpreted in microseconds.
1829 .TP
1830 .BI thinktime_blocks \fR=\fPint
1831 Only valid if \fBthinktime\fR is set \- control how many blocks to issue,
1832 before waiting \fBthinktime\fR usecs. If not set, defaults to 1 which will make
1833 fio wait \fBthinktime\fR usecs after every block. This effectively makes any
1834 queue depth setting redundant, since no more than 1 I/O will be queued
1835 before we have to complete it and do our \fBthinktime\fR. In other words, this
1836 setting effectively caps the queue depth if the latter is larger.
1837 .TP
1838 .BI rate \fR=\fPint[,int][,int]
1839 Cap the bandwidth used by this job. The number is in bytes/sec, the normal
1840 suffix rules apply. Comma\-separated values may be specified for reads,
1841 writes, and trims as described in \fBblocksize\fR.
1842 .RS
1843 .P
1844 For example, using `rate=1m,500k' would limit reads to 1MiB/sec and writes to
1845 500KiB/sec. Capping only reads or writes can be done with `rate=,500k' or
1846 `rate=500k,' where the former will only limit writes (to 500KiB/sec) and the
1847 latter will only limit reads.
1848 .RE
1849 .TP
1850 .BI rate_min \fR=\fPint[,int][,int]
1851 Tell fio to do whatever it can to maintain at least this bandwidth. Failing
1852 to meet this requirement will cause the job to exit. Comma\-separated values
1853 may be specified for reads, writes, and trims as described in
1854 \fBblocksize\fR.
1855 .TP
1856 .BI rate_iops \fR=\fPint[,int][,int]
1857 Cap the bandwidth to this number of IOPS. Basically the same as
1858 \fBrate\fR, just specified independently of bandwidth. If the job is
1859 given a block size range instead of a fixed value, the smallest block size
1860 is used as the metric. Comma\-separated values may be specified for reads,
1861 writes, and trims as described in \fBblocksize\fR.
1862 .TP
1863 .BI rate_iops_min \fR=\fPint[,int][,int]
1864 If fio doesn't meet this rate of I/O, it will cause the job to exit.
1865 Comma\-separated values may be specified for reads, writes, and trims as
1866 described in \fBblocksize\fR.
1867 .TP
1868 .BI rate_process \fR=\fPstr
1869 This option controls how fio manages rated I/O submissions. The default is
1870 `linear', which submits I/O in a linear fashion with fixed delays between
1871 I/Os that gets adjusted based on I/O completion rates. If this is set to
1872 `poisson', fio will submit I/O based on a more real world random request
1873 flow, known as the Poisson process
1874 (\fIhttps://en.wikipedia.org/wiki/Poisson_point_process\fR). The lambda will be
1875 10^6 / IOPS for the given workload.
1876 .SS "I/O latency"
1877 .TP
1878 .BI latency_target \fR=\fPtime
1879 If set, fio will attempt to find the max performance point that the given
1880 workload will run at while maintaining a latency below this target. When
1881 the unit is omitted, the value is interpreted in microseconds. See
1882 \fBlatency_window\fR and \fBlatency_percentile\fR.
1883 .TP
1884 .BI latency_window \fR=\fPtime
1885 Used with \fBlatency_target\fR to specify the sample window that the job
1886 is run at varying queue depths to test the performance. When the unit is
1887 omitted, the value is interpreted in microseconds.
1888 .TP
1889 .BI latency_percentile \fR=\fPfloat
1890 The percentage of I/Os that must fall within the criteria specified by
1891 \fBlatency_target\fR and \fBlatency_window\fR. If not set, this
1892 defaults to 100.0, meaning that all I/Os must be equal or below to the value
1893 set by \fBlatency_target\fR.
1894 .TP
1895 .BI max_latency \fR=\fPtime
1896 If set, fio will exit the job with an ETIMEDOUT error if it exceeds this
1897 maximum latency. When the unit is omitted, the value is interpreted in
1898 microseconds.
1899 .TP
1900 .BI rate_cycle \fR=\fPint
1901 Average bandwidth for \fBrate\fR and \fBrate_min\fR over this number
1902 of milliseconds. Defaults to 1000.
1903 .SS "I/O replay"
1904 .TP
1905 .BI write_iolog \fR=\fPstr
1906 Write the issued I/O patterns to the specified file. See
1907 \fBread_iolog\fR. Specify a separate file for each job, otherwise the
1908 iologs will be interspersed and the file may be corrupt.
1909 .TP
1910 .BI read_iolog \fR=\fPstr
1911 Open an iolog with the specified filename and replay the I/O patterns it
1912 contains. This can be used to store a workload and replay it sometime
1913 later. The iolog given may also be a blktrace binary file, which allows fio
1914 to replay a workload captured by blktrace. See
1915 \fBblktrace\fR\|(8) for how to capture such logging data. For blktrace
1916 replay, the file needs to be turned into a blkparse binary data file first
1917 (`blkparse <device> \-o /dev/null \-d file_for_fio.bin').
1918 .TP
1919 .BI replay_no_stall \fR=\fPbool
1920 When replaying I/O with \fBread_iolog\fR the default behavior is to
1921 attempt to respect the timestamps within the log and replay them with the
1922 appropriate delay between IOPS. By setting this variable fio will not
1923 respect the timestamps and attempt to replay them as fast as possible while
1924 still respecting ordering. The result is the same I/O pattern to a given
1925 device, but different timings.
1926 .TP
1927 .BI replay_redirect \fR=\fPstr
1928 While replaying I/O patterns using \fBread_iolog\fR the default behavior
1929 is to replay the IOPS onto the major/minor device that each IOP was recorded
1930 from. This is sometimes undesirable because on a different machine those
1931 major/minor numbers can map to a different device. Changing hardware on the
1932 same system can also result in a different major/minor mapping.
1933 \fBreplay_redirect\fR causes all I/Os to be replayed onto the single specified
1934 device regardless of the device it was recorded
1935 from. i.e. `replay_redirect=/dev/sdc' would cause all I/O
1936 in the blktrace or iolog to be replayed onto `/dev/sdc'. This means
1937 multiple devices will be replayed onto a single device, if the trace
1938 contains multiple devices. If you want multiple devices to be replayed
1939 concurrently to multiple redirected devices you must blkparse your trace
1940 into separate traces and replay them with independent fio invocations.
1941 Unfortunately this also breaks the strict time ordering between multiple
1942 device accesses.
1943 .TP
1944 .BI replay_align \fR=\fPint
1945 Force alignment of I/O offsets and lengths in a trace to this power of 2
1946 value.
1947 .TP
1948 .BI replay_scale \fR=\fPint
1949 Scale sector offsets down by this factor when replaying traces.
1950 .SS "Threads, processes and job synchronization"
1951 .TP
1952 .BI thread
1953 Fio defaults to creating jobs by using fork, however if this option is
1954 given, fio will create jobs by using POSIX Threads' function
1955 \fBpthread_create\fR\|(3) to create threads instead.
1956 .TP
1957 .BI wait_for \fR=\fPstr
1958 If set, the current job won't be started until all workers of the specified
1959 waitee job are done.
1960 .\" ignore blank line here from HOWTO as it looks normal without it
1961 \fBwait_for\fR operates on the job name basis, so there are a few
1962 limitations. First, the waitee must be defined prior to the waiter job
1963 (meaning no forward references). Second, if a job is being referenced as a
1964 waitee, it must have a unique name (no duplicate waitees).
1965 .TP
1966 .BI nice \fR=\fPint
1967 Run the job with the given nice value. See man \fBnice\fR\|(2).
1968 .\" ignore blank line here from HOWTO as it looks normal without it
1969 On Windows, values less than \-15 set the process class to "High"; \-1 through
1970 \-15 set "Above Normal"; 1 through 15 "Below Normal"; and above 15 "Idle"
1971 priority class.
1972 .TP
1973 .BI prio \fR=\fPint
1974 Set the I/O priority value of this job. Linux limits us to a positive value
1975 between 0 and 7, with 0 being the highest. See man
1976 \fBionice\fR\|(1). Refer to an appropriate manpage for other operating
1977 systems since meaning of priority may differ.
1978 .TP
1979 .BI prioclass \fR=\fPint
1980 Set the I/O priority class. See man \fBionice\fR\|(1).
1981 .TP
1982 .BI cpumask \fR=\fPint
1983 Set the CPU affinity of this job. The parameter given is a bit mask of
1984 allowed CPUs the job may run on. So if you want the allowed CPUs to be 1
1985 and 5, you would pass the decimal value of (1 << 1 | 1 << 5), or 34. See man
1986 \fBsched_setaffinity\fR\|(2). This may not work on all supported
1987 operating systems or kernel versions. This option doesn't work well for a
1988 higher CPU count than what you can store in an integer mask, so it can only
1989 control cpus 1\-32. For boxes with larger CPU counts, use
1990 \fBcpus_allowed\fR.
1991 .TP
1992 .BI cpus_allowed \fR=\fPstr
1993 Controls the same options as \fBcpumask\fR, but accepts a textual
1994 specification of the permitted CPUs instead. So to use CPUs 1 and 5 you
1995 would specify `cpus_allowed=1,5'. This option also allows a range of CPUs
1996 to be specified \-\- say you wanted a binding to CPUs 1, 5, and 8 to 15, you
1997 would set `cpus_allowed=1,5,8\-15'.
1998 .TP
1999 .BI cpus_allowed_policy \fR=\fPstr
2000 Set the policy of how fio distributes the CPUs specified by
2001 \fBcpus_allowed\fR or \fBcpumask\fR. Two policies are supported:
2002 .RS
2003 .RS
2004 .TP
2005 .B shared
2006 All jobs will share the CPU set specified.
2007 .TP
2008 .B split
2009 Each job will get a unique CPU from the CPU set.
2010 .RE
2011 .P
2012 \fBshared\fR is the default behavior, if the option isn't specified. If
2013 \fBsplit\fR is specified, then fio will will assign one cpu per job. If not
2014 enough CPUs are given for the jobs listed, then fio will roundrobin the CPUs
2015 in the set.
2016 .RE
2017 .TP
2018 .BI numa_cpu_nodes \fR=\fPstr
2019 Set this job running on specified NUMA nodes' CPUs. The arguments allow
2020 comma delimited list of cpu numbers, A\-B ranges, or `all'. Note, to enable
2021 NUMA options support, fio must be built on a system with libnuma\-dev(el)
2022 installed.
2023 .TP
2024 .BI numa_mem_policy \fR=\fPstr
2025 Set this job's memory policy and corresponding NUMA nodes. Format of the
2026 arguments:
2027 .RS
2028 .RS
2029 .P
2030 <mode>[:<nodelist>]
2031 .RE
2032 .P
2033 `mode' is one of the following memory poicies: `default', `prefer',
2034 `bind', `interleave' or `local'. For `default' and `local' memory
2035 policies, no node needs to be specified. For `prefer', only one node is
2036 allowed. For `bind' and `interleave' the `nodelist' may be as
2037 follows: a comma delimited list of numbers, A\-B ranges, or `all'.
2038 .RE
2039 .TP
2040 .BI cgroup \fR=\fPstr
2041 Add job to this control group. If it doesn't exist, it will be created. The
2042 system must have a mounted cgroup blkio mount point for this to work. If
2043 your system doesn't have it mounted, you can do so with:
2044 .RS
2045 .RS
2046 .P
2047 # mount \-t cgroup \-o blkio none /cgroup
2048 .RE
2049 .RE
2050 .TP
2051 .BI cgroup_weight \fR=\fPint
2052 Set the weight of the cgroup to this value. See the documentation that comes
2053 with the kernel, allowed values are in the range of 100..1000.
2054 .TP
2055 .BI cgroup_nodelete \fR=\fPbool
2056 Normally fio will delete the cgroups it has created after the job
2057 completion. To override this behavior and to leave cgroups around after the
2058 job completion, set `cgroup_nodelete=1'. This can be useful if one wants
2059 to inspect various cgroup files after job completion. Default: false.
2060 .TP
2061 .BI flow_id \fR=\fPint
2062 The ID of the flow. If not specified, it defaults to being a global
2063 flow. See \fBflow\fR.
2064 .TP
2065 .BI flow \fR=\fPint
2066 Weight in token\-based flow control. If this value is used, then there is
2067 a 'flow counter' which is used to regulate the proportion of activity between
2068 two or more jobs. Fio attempts to keep this flow counter near zero. The
2069 \fBflow\fR parameter stands for how much should be added or subtracted to the
2070 flow counter on each iteration of the main I/O loop. That is, if one job has
2071 `flow=8' and another job has `flow=\-1', then there will be a roughly 1:8
2072 ratio in how much one runs vs the other.
2073 .TP
2074 .BI flow_watermark \fR=\fPint
2075 The maximum value that the absolute value of the flow counter is allowed to
2076 reach before the job must wait for a lower value of the counter.
2077 .TP
2078 .BI flow_sleep \fR=\fPint
2079 The period of time, in microseconds, to wait after the flow watermark has
2080 been exceeded before retrying operations.
2081 .TP
2082 .BI stonewall "\fR,\fB wait_for_previous"
2083 Wait for preceding jobs in the job file to exit, before starting this
2084 one. Can be used to insert serialization points in the job file. A stone
2085 wall also implies starting a new reporting group, see
2086 \fBgroup_reporting\fR.
2087 .TP
2088 .BI exitall
2089 By default, fio will continue running all other jobs when one job finishes
2090 but sometimes this is not the desired action. Setting \fBexitall\fR will
2091 instead make fio terminate all other jobs when one job finishes.
2092 .TP
2093 .BI exec_prerun \fR=\fPstr
2094 Before running this job, issue the command specified through
2095 \fBsystem\fR\|(3). Output is redirected in a file called `jobname.prerun.txt'.
2096 .TP
2097 .BI exec_postrun \fR=\fPstr
2098 After the job completes, issue the command specified though
2099 \fBsystem\fR\|(3). Output is redirected in a file called `jobname.postrun.txt'.
2100 .TP
2101 .BI uid \fR=\fPint
2102 Instead of running as the invoking user, set the user ID to this value
2103 before the thread/process does any work.
2104 .TP
2105 .BI gid \fR=\fPint
2106 Set group ID, see \fBuid\fR.
2107 .SS "Verification"
2108 .TP
2109 .BI verify_only
2110 Do not perform specified workload, only verify data still matches previous
2111 invocation of this workload. This option allows one to check data multiple
2112 times at a later date without overwriting it. This option makes sense only
2113 for workloads that write data, and does not support workloads with the
2114 \fBtime_based\fR option set.
2115 .TP
2116 .BI do_verify \fR=\fPbool
2117 Run the verify phase after a write phase. Only valid if \fBverify\fR is
2118 set. Default: true.
2119 .TP
2120 .BI verify \fR=\fPstr
2121 If writing to a file, fio can verify the file contents after each iteration
2122 of the job. Each verification method also implies verification of special
2123 header, which is written to the beginning of each block. This header also
2124 includes meta information, like offset of the block, block number, timestamp
2125 when block was written, etc. \fBverify\fR can be combined with
2126 \fBverify_pattern\fR option. The allowed values are:
2127 .RS
2128 .RS
2129 .TP
2130 .B md5
2131 Use an md5 sum of the data area and store it in the header of
2132 each block.
2133 .TP
2134 .B crc64
2135 Use an experimental crc64 sum of the data area and store it in the
2136 header of each block.
2137 .TP
2138 .B crc32c
2139 Use a crc32c sum of the data area and store it in the header of
2140 each block. This will automatically use hardware acceleration
2141 (e.g. SSE4.2 on an x86 or CRC crypto extensions on ARM64) but will
2142 fall back to software crc32c if none is found. Generally the
2143 fatest checksum fio supports when hardware accelerated.
2144 .TP
2145 .B crc32c\-intel
2146 Synonym for crc32c.
2147 .TP
2148 .B crc32
2149 Use a crc32 sum of the data area and store it in the header of each
2150 block.
2151 .TP
2152 .B crc16
2153 Use a crc16 sum of the data area and store it in the header of each
2154 block.
2155 .TP
2156 .B crc7
2157 Use a crc7 sum of the data area and store it in the header of each
2158 block.
2159 .TP
2160 .B xxhash
2161 Use xxhash as the checksum function. Generally the fastest software
2162 checksum that fio supports.
2163 .TP
2164 .B sha512
2165 Use sha512 as the checksum function.
2166 .TP
2167 .B sha256
2168 Use sha256 as the checksum function.
2169 .TP
2170 .B sha1
2171 Use optimized sha1 as the checksum function.
2172 .TP
2173 .B sha3\-224
2174 Use optimized sha3\-224 as the checksum function.
2175 .TP
2176 .B sha3\-256
2177 Use optimized sha3\-256 as the checksum function.
2178 .TP
2179 .B sha3\-384
2180 Use optimized sha3\-384 as the checksum function.
2181 .TP
2182 .B sha3\-512
2183 Use optimized sha3\-512 as the checksum function.
2184 .TP
2185 .B meta
2186 This option is deprecated, since now meta information is included in
2187 generic verification header and meta verification happens by
2188 default. For detailed information see the description of the
2189 \fBverify\fR setting. This option is kept because of
2190 compatibility's sake with old configurations. Do not use it.
2191 .TP
2192 .B pattern
2193 Verify a strict pattern. Normally fio includes a header with some
2194 basic information and checksumming, but if this option is set, only
2195 the specific pattern set with \fBverify_pattern\fR is verified.
2196 .TP
2197 .B null
2198 Only pretend to verify. Useful for testing internals with
2199 `ioengine=null', not for much else.
2200 .RE
2201 .P
2202 This option can be used for repeated burn\-in tests of a system to make sure
2203 that the written data is also correctly read back. If the data direction
2204 given is a read or random read, fio will assume that it should verify a
2205 previously written file. If the data direction includes any form of write,
2206 the verify will be of the newly written data.
2207 .RE
2208 .TP
2209 .BI verifysort \fR=\fPbool
2210 If true, fio will sort written verify blocks when it deems it faster to read
2211 them back in a sorted manner. This is often the case when overwriting an
2212 existing file, since the blocks are already laid out in the file system. You
2213 can ignore this option unless doing huge amounts of really fast I/O where
2214 the red\-black tree sorting CPU time becomes significant. Default: true.
2215 .TP
2216 .BI verifysort_nr \fR=\fPint
2217 Pre\-load and sort verify blocks for a read workload.
2218 .TP
2219 .BI verify_offset \fR=\fPint
2220 Swap the verification header with data somewhere else in the block before
2221 writing. It is swapped back before verifying.
2222 .TP
2223 .BI verify_interval \fR=\fPint
2224 Write the verification header at a finer granularity than the
2225 \fBblocksize\fR. It will be written for chunks the size of
2226 \fBverify_interval\fR. \fBblocksize\fR should divide this evenly.
2227 .TP
2228 .BI verify_pattern \fR=\fPstr
2229 If set, fio will fill the I/O buffers with this pattern. Fio defaults to
2230 filling with totally random bytes, but sometimes it's interesting to fill
2231 with a known pattern for I/O verification purposes. Depending on the width
2232 of the pattern, fio will fill 1/2/3/4 bytes of the buffer at the time (it can
2233 be either a decimal or a hex number). The \fBverify_pattern\fR if larger than
2234 a 32\-bit quantity has to be a hex number that starts with either "0x" or
2235 "0X". Use with \fBverify\fR. Also, \fBverify_pattern\fR supports %o
2236 format, which means that for each block offset will be written and then
2237 verified back, e.g.:
2238 .RS
2239 .RS
2240 .P
2241 verify_pattern=%o
2242 .RE
2243 .P
2244 Or use combination of everything:
2245 .RS
2246 .P
2247 verify_pattern=0xff%o"abcd"\-12
2248 .RE
2249 .RE
2250 .TP
2251 .BI verify_fatal \fR=\fPbool
2252 Normally fio will keep checking the entire contents before quitting on a
2253 block verification failure. If this option is set, fio will exit the job on
2254 the first observed failure. Default: false.
2255 .TP
2256 .BI verify_dump \fR=\fPbool
2257 If set, dump the contents of both the original data block and the data block
2258 we read off disk to files. This allows later analysis to inspect just what
2259 kind of data corruption occurred. Off by default.
2260 .TP
2261 .BI verify_async \fR=\fPint
2262 Fio will normally verify I/O inline from the submitting thread. This option
2263 takes an integer describing how many async offload threads to create for I/O
2264 verification instead, causing fio to offload the duty of verifying I/O
2265 contents to one or more separate threads. If using this offload option, even
2266 sync I/O engines can benefit from using an \fBiodepth\fR setting higher
2267 than 1, as it allows them to have I/O in flight while verifies are running.
2268 Defaults to 0 async threads, i.e. verification is not asynchronous.
2269 .TP
2270 .BI verify_async_cpus \fR=\fPstr
2271 Tell fio to set the given CPU affinity on the async I/O verification
2272 threads. See \fBcpus_allowed\fR for the format used.
2273 .TP
2274 .BI verify_backlog \fR=\fPint
2275 Fio will normally verify the written contents of a job that utilizes verify
2276 once that job has completed. In other words, everything is written then
2277 everything is read back and verified. You may want to verify continually
2278 instead for a variety of reasons. Fio stores the meta data associated with
2279 an I/O block in memory, so for large verify workloads, quite a bit of memory
2280 would be used up holding this meta data. If this option is enabled, fio will
2281 write only N blocks before verifying these blocks.
2282 .TP
2283 .BI verify_backlog_batch \fR=\fPint
2284 Control how many blocks fio will verify if \fBverify_backlog\fR is
2285 set. If not set, will default to the value of \fBverify_backlog\fR
2286 (meaning the entire queue is read back and verified). If
2287 \fBverify_backlog_batch\fR is less than \fBverify_backlog\fR then not all
2288 blocks will be verified, if \fBverify_backlog_batch\fR is larger than
2289 \fBverify_backlog\fR, some blocks will be verified more than once.
2290 .TP
2291 .BI verify_state_save \fR=\fPbool
2292 When a job exits during the write phase of a verify workload, save its
2293 current state. This allows fio to replay up until that point, if the verify
2294 state is loaded for the verify read phase. The format of the filename is,
2295 roughly:
2296 .RS
2297 .RS
2298 .P
2299 <type>\-<jobname>\-<jobindex>\-verify.state.
2300 .RE
2301 .P
2302 <type> is "local" for a local run, "sock" for a client/server socket
2303 connection, and "ip" (, for instance) for a networked
2304 client/server connection. Defaults to true.
2305 .RE
2306 .TP
2307 .BI verify_state_load \fR=\fPbool
2308 If a verify termination trigger was used, fio stores the current write state
2309 of each thread. This can be used at verification time so that fio knows how
2310 far it should verify. Without this information, fio will run a full
2311 verification pass, according to the settings in the job file used. Default
2312 false.
2313 .TP
2314 .BI trim_percentage \fR=\fPint
2315 Number of verify blocks to discard/trim.
2316 .TP
2317 .BI trim_verify_zero \fR=\fPbool
2318 Verify that trim/discarded blocks are returned as zeros.
2319 .TP
2320 .BI trim_backlog \fR=\fPint
2321 Verify that trim/discarded blocks are returned as zeros.
2322 .TP
2323 .BI trim_backlog_batch \fR=\fPint
2324 Trim this number of I/O blocks.
2325 .TP
2326 .BI experimental_verify \fR=\fPbool
2327 Enable experimental verification.
2328 .SS "Steady state"
2329 .TP
2330 .BI steadystate \fR=\fPstr:float "\fR,\fP ss" \fR=\fPstr:float
2331 Define the criterion and limit for assessing steady state performance. The
2332 first parameter designates the criterion whereas the second parameter sets
2333 the threshold. When the criterion falls below the threshold for the
2334 specified duration, the job will stop. For example, `iops_slope:0.1%' will
2335 direct fio to terminate the job when the least squares regression slope
2336 falls below 0.1% of the mean IOPS. If \fBgroup_reporting\fR is enabled
2337 this will apply to all jobs in the group. Below is the list of available
2338 steady state assessment criteria. All assessments are carried out using only
2339 data from the rolling collection window. Threshold limits can be expressed
2340 as a fixed value or as a percentage of the mean in the collection window.
2341 .RS
2342 .RS
2343 .TP
2344 .B iops
2345 Collect IOPS data. Stop the job if all individual IOPS measurements
2346 are within the specified limit of the mean IOPS (e.g., `iops:2'
2347 means that all individual IOPS values must be within 2 of the mean,
2348 whereas `iops:0.2%' means that all individual IOPS values must be
2349 within 0.2% of the mean IOPS to terminate the job).
2350 .TP
2351 .B iops_slope
2352 Collect IOPS data and calculate the least squares regression
2353 slope. Stop the job if the slope falls below the specified limit.
2354 .TP
2355 .B bw
2356 Collect bandwidth data. Stop the job if all individual bandwidth
2357 measurements are within the specified limit of the mean bandwidth.
2358 .TP
2359 .B bw_slope
2360 Collect bandwidth data and calculate the least squares regression
2361 slope. Stop the job if the slope falls below the specified limit.
2362 .RE
2363 .RE
2364 .TP
2365 .BI steadystate_duration \fR=\fPtime "\fR,\fP ss_dur" \fR=\fPtime
2366 A rolling window of this duration will be used to judge whether steady state
2367 has been reached. Data will be collected once per second. The default is 0
2368 which disables steady state detection. When the unit is omitted, the
2369 value is interpreted in seconds.
2370 .TP
2371 .BI steadystate_ramp_time \fR=\fPtime "\fR,\fP ss_ramp" \fR=\fPtime
2372 Allow the job to run for the specified duration before beginning data
2373 collection for checking the steady state job termination criterion. The
2374 default is 0. When the unit is omitted, the value is interpreted in seconds.
2375 .SS "Measurements and reporting"
2376 .TP
2377 .BI per_job_logs \fR=\fPbool
2378 If set, this generates bw/clat/iops log with per file private filenames. If
2379 not set, jobs with identical names will share the log filename. Default:
2380 true.
2381 .TP
2382 .BI group_reporting
2383 It may sometimes be interesting to display statistics for groups of jobs as
2384 a whole instead of for each individual job. This is especially true if
2385 \fBnumjobs\fR is used; looking at individual thread/process output
2386 quickly becomes unwieldy. To see the final report per\-group instead of
2387 per\-job, use \fBgroup_reporting\fR. Jobs in a file will be part of the
2388 same reporting group, unless if separated by a \fBstonewall\fR, or by
2389 using \fBnew_group\fR.
2390 .TP
2391 .BI new_group
2392 Start a new reporting group. See: \fBgroup_reporting\fR. If not given,
2393 all jobs in a file will be part of the same reporting group, unless
2394 separated by a \fBstonewall\fR.
2395 .TP
2396 .BI stats \fR=\fPbool
2397 By default, fio collects and shows final output results for all jobs
2398 that run. If this option is set to 0, then fio will ignore it in
2399 the final stat output.
2400 .TP
2401 .BI write_bw_log \fR=\fPstr
2402 If given, write a bandwidth log for this job. Can be used to store data of
2403 the bandwidth of the jobs in their lifetime. The included
2404 \fBfio_generate_plots\fR script uses gnuplot to turn these
2405 text files into nice graphs. See \fBwrite_lat_log\fR for behavior of
2406 given filename. For this option, the postfix is `_bw.x.log', where `x'
2407 is the index of the job (1..N, where N is the number of jobs). If
2408 \fBper_job_logs\fR is false, then the filename will not include the job
2409 index. See \fBLOG FILE FORMATS\fR section.
2410 .TP
2411 .BI write_lat_log \fR=\fPstr
2412 Same as \fBwrite_bw_log\fR, except that this option stores I/O
2413 submission, completion, and total latencies instead. If no filename is given
2414 with this option, the default filename of `jobname_type.log' is
2415 used. Even if the filename is given, fio will still append the type of
2416 log. So if one specifies:
2417 .RS
2418 .RS
2419 .P
2420 write_lat_log=foo
2421 .RE
2422 .P
2423 The actual log names will be `foo_slat.x.log', `foo_clat.x.log',
2424 and `foo_lat.x.log', where `x' is the index of the job (1..N, where N
2425 is the number of jobs). This helps \fBfio_generate_plots\fR find the
2426 logs automatically. If \fBper_job_logs\fR is false, then the filename
2427 will not include the job index. See \fBLOG FILE FORMATS\fR section.
2428 .RE
2429 .TP
2430 .BI write_hist_log \fR=\fPstr
2431 Same as \fBwrite_lat_log\fR, but writes I/O completion latency
2432 histograms. If no filename is given with this option, the default filename
2433 of `jobname_clat_hist.x.log' is used, where `x' is the index of the
2434 job (1..N, where N is the number of jobs). Even if the filename is given,
2435 fio will still append the type of log. If \fBper_job_logs\fR is false,
2436 then the filename will not include the job index. See \fBLOG FILE FORMATS\fR section.
2437 .TP
2438 .BI write_iops_log \fR=\fPstr
2439 Same as \fBwrite_bw_log\fR, but writes IOPS. If no filename is given
2440 with this option, the default filename of `jobname_type.x.log' is
2441 used, where `x' is the index of the job (1..N, where N is the number of
2442 jobs). Even if the filename is given, fio will still append the type of
2443 log. If \fBper_job_logs\fR is false, then the filename will not include
2444 the job index. See \fBLOG FILE FORMATS\fR section.
2445 .TP
2446 .BI log_avg_msec \fR=\fPint
2447 By default, fio will log an entry in the iops, latency, or bw log for every
2448 I/O that completes. When writing to the disk log, that can quickly grow to a
2449 very large size. Setting this option makes fio average the each log entry
2450 over the specified period of time, reducing the resolution of the log. See
2451 \fBlog_max_value\fR as well. Defaults to 0, logging all entries.
2452 Also see \fBLOG FILE FORMATS\fR section.
2453 .TP
2454 .BI log_hist_msec \fR=\fPint
2455 Same as \fBlog_avg_msec\fR, but logs entries for completion latency
2456 histograms. Computing latency percentiles from averages of intervals using
2457 \fBlog_avg_msec\fR is inaccurate. Setting this option makes fio log
2458 histogram entries over the specified period of time, reducing log sizes for
2459 high IOPS devices while retaining percentile accuracy. See
2460 \fBlog_hist_coarseness\fR as well. Defaults to 0, meaning histogram
2461 logging is disabled.
2462 .TP
2463 .BI log_hist_coarseness \fR=\fPint
2464 Integer ranging from 0 to 6, defining the coarseness of the resolution of
2465 the histogram logs enabled with \fBlog_hist_msec\fR. For each increment
2466 in coarseness, fio outputs half as many bins. Defaults to 0, for which
2467 histogram logs contain 1216 latency bins. See \fBLOG FILE FORMATS\fR section.
2468 .TP
2469 .BI log_max_value \fR=\fPbool
2470 If \fBlog_avg_msec\fR is set, fio logs the average over that window. If
2471 you instead want to log the maximum value, set this option to 1. Defaults to
2472 0, meaning that averaged values are logged.
2473 .TP
2474 .BI log_offset \fR=\fPbool
2475 If this is set, the iolog options will include the byte offset for the I/O
2476 entry as well as the other data values. Defaults to 0 meaning that
2477 offsets are not present in logs. Also see \fBLOG FILE FORMATS\fR section.
2478 .TP
2479 .BI log_compression \fR=\fPint
2480 If this is set, fio will compress the I/O logs as it goes, to keep the
2481 memory footprint lower. When a log reaches the specified size, that chunk is
2482 removed and compressed in the background. Given that I/O logs are fairly
2483 highly compressible, this yields a nice memory savings for longer runs. The
2484 downside is that the compression will consume some background CPU cycles, so
2485 it may impact the run. This, however, is also true if the logging ends up
2486 consuming most of the system memory. So pick your poison. The I/O logs are
2487 saved normally at the end of a run, by decompressing the chunks and storing
2488 them in the specified log file. This feature depends on the availability of
2489 zlib.
2490 .TP
2491 .BI log_compression_cpus \fR=\fPstr
2492 Define the set of CPUs that are allowed to handle online log compression for
2493 the I/O jobs. This can provide better isolation between performance
2494 sensitive jobs, and background compression work.
2495 .TP
2496 .BI log_store_compressed \fR=\fPbool
2497 If set, fio will store the log files in a compressed format. They can be
2498 decompressed with fio, using the \fB\-\-inflate\-log\fR command line
2499 parameter. The files will be stored with a `.fz' suffix.
2500 .TP
2501 .BI log_unix_epoch \fR=\fPbool
2502 If set, fio will log Unix timestamps to the log files produced by enabling
2503 write_type_log for each log type, instead of the default zero\-based
2504 timestamps.
2505 .TP
2506 .BI block_error_percentiles \fR=\fPbool
2507 If set, record errors in trim block\-sized units from writes and trims and
2508 output a histogram of how many trims it took to get to errors, and what kind
2509 of error was encountered.
2510 .TP
2511 .BI bwavgtime \fR=\fPint
2512 Average the calculated bandwidth over the given time. Value is specified in
2513 milliseconds. If the job also does bandwidth logging through
2514 \fBwrite_bw_log\fR, then the minimum of this option and
2515 \fBlog_avg_msec\fR will be used. Default: 500ms.
2516 .TP
2517 .BI iopsavgtime \fR=\fPint
2518 Average the calculated IOPS over the given time. Value is specified in
2519 milliseconds. If the job also does IOPS logging through
2520 \fBwrite_iops_log\fR, then the minimum of this option and
2521 \fBlog_avg_msec\fR will be used. Default: 500ms.
2522 .TP
2523 .BI disk_util \fR=\fPbool
2524 Generate disk utilization statistics, if the platform supports it.
2525 Default: true.
2526 .TP
2527 .BI disable_lat \fR=\fPbool
2528 Disable measurements of total latency numbers. Useful only for cutting back
2529 the number of calls to \fBgettimeofday\fR\|(2), as that does impact
2530 performance at really high IOPS rates. Note that to really get rid of a
2531 large amount of these calls, this option must be used with
2532 \fBdisable_slat\fR and \fBdisable_bw_measurement\fR as well.
2533 .TP
2534 .BI disable_clat \fR=\fPbool
2535 Disable measurements of completion latency numbers. See
2536 \fBdisable_lat\fR.
2537 .TP
2538 .BI disable_slat \fR=\fPbool
2539 Disable measurements of submission latency numbers. See
2540 \fBdisable_lat\fR.
2541 .TP
2542 .BI disable_bw_measurement \fR=\fPbool "\fR,\fP disable_bw" \fR=\fPbool
2543 Disable measurements of throughput/bandwidth numbers. See
2544 \fBdisable_lat\fR.
2545 .TP
2546 .BI clat_percentiles \fR=\fPbool
2547 Enable the reporting of percentiles of completion latencies.
2548 .TP
2549 .BI percentile_list \fR=\fPfloat_list
2550 Overwrite the default list of percentiles for completion latencies and the
2551 block error histogram. Each number is a floating number in the range
2552 (0,100], and the maximum length of the list is 20. Use ':' to separate the
2553 numbers, and list the numbers in ascending order. For example,
2554 `\-\-percentile_list=99.5:99.9' will cause fio to report the values of
2555 completion latency below which 99.5% and 99.9% of the observed latencies
2556 fell, respectively.
2557 .SS "Error handling"
2558 .TP
2559 .BI exitall_on_error
2560 When one job finishes in error, terminate the rest. The default is to wait
2561 for each job to finish.
2562 .TP
2563 .BI continue_on_error \fR=\fPstr
2564 Normally fio will exit the job on the first observed failure. If this option
2565 is set, fio will continue the job when there is a 'non\-fatal error' (EIO or
2566 EILSEQ) until the runtime is exceeded or the I/O size specified is
2567 completed. If this option is used, there are two more stats that are
2568 appended, the total error count and the first error. The error field given
2569 in the stats is the first error that was hit during the run.
2570 The allowed values are:
2571 .RS
2572 .RS
2573 .TP
2574 .B none
2575 Exit on any I/O or verify errors.
2576 .TP
2577 .B read
2578 Continue on read errors, exit on all others.
2579 .TP
2580 .B write
2581 Continue on write errors, exit on all others.
2582 .TP
2583 .B io
2584 Continue on any I/O error, exit on all others.
2585 .TP
2586 .B verify
2587 Continue on verify errors, exit on all others.
2588 .TP
2589 .B all
2590 Continue on all errors.
2591 .TP
2592 .B 0
2593 Backward\-compatible alias for 'none'.
2594 .TP
2595 .B 1
2596 Backward\-compatible alias for 'all'.
2597 .RE
2598 .RE
2599 .TP
2600 .BI ignore_error \fR=\fPstr
2601 Sometimes you want to ignore some errors during test in that case you can
2602 specify error list for each error type, instead of only being able to
2603 ignore the default 'non\-fatal error' using \fBcontinue_on_error\fR.
2604 `ignore_error=READ_ERR_LIST,WRITE_ERR_LIST,VERIFY_ERR_LIST' errors for
2605 given error type is separated with ':'. Error may be symbol ('ENOSPC', 'ENOMEM')
2606 or integer. Example:
2607 .RS
2608 .RS
2609 .P
2610 ignore_error=EAGAIN,ENOSPC:122
2611 .RE
2612 .P
2613 This option will ignore EAGAIN from READ, and ENOSPC and 122(EDQUOT) from
2614 WRITE. This option works by overriding \fBcontinue_on_error\fR with
2615 the list of errors for each error type if any.
2616 .RE
2617 .TP
2618 .BI error_dump \fR=\fPbool
2619 If set dump every error even if it is non fatal, true by default. If
2620 disabled only fatal error will be dumped.
2621 .SS "Running predefined workloads"
2622 Fio includes predefined profiles that mimic the I/O workloads generated by
2623 other tools.
2624 .TP
2625 .BI profile \fR=\fPstr
2626 The predefined workload to run. Current profiles are:
2627 .RS
2628 .RS
2629 .TP
2630 .B tiobench
2631 Threaded I/O bench (tiotest/tiobench) like workload.
2632 .TP
2633 .B act
2634 Aerospike Certification Tool (ACT) like workload.
2635 .RE
2636 .RE
2637 .P
2638 To view a profile's additional options use \fB\-\-cmdhelp\fR after specifying
2639 the profile. For example:
2640 .RS
2641 .TP
2642 $ fio \-\-profile=act \-\-cmdhelp
2643 .RE
2644 .SS "Act profile options"
2645 .TP
2646 .BI device\-names \fR=\fPstr
2647 Devices to use.
2648 .TP
2649 .BI load \fR=\fPint
2650 ACT load multiplier. Default: 1.
2651 .TP
2652 .BI test\-duration\fR=\fPtime
2653 How long the entire test takes to run. When the unit is omitted, the value
2654 is given in seconds. Default: 24h.
2655 .TP
2656 .BI threads\-per\-queue\fR=\fPint
2657 Number of read I/O threads per device. Default: 8.
2658 .TP
2659 .BI read\-req\-num\-512\-blocks\fR=\fPint
2660 Number of 512B blocks to read at the time. Default: 3.
2661 .TP
2662 .BI large\-block\-op\-kbytes\fR=\fPint
2663 Size of large block ops in KiB (writes). Default: 131072.
2664 .TP
2665 .BI prep
2666 Set to run ACT prep phase.
2667 .SS "Tiobench profile options"
2668 .TP
2669 .BI size\fR=\fPstr
2670 Size in MiB.
2671 .TP
2672 .BI block\fR=\fPint
2673 Block size in bytes. Default: 4096.
2674 .TP
2675 .BI numruns\fR=\fPint
2676 Number of runs.
2677 .TP
2678 .BI dir\fR=\fPstr
2679 Test directory.
2680 .TP
2681 .BI threads\fR=\fPint
2682 Number of threads.
2684 Fio spits out a lot of output. While running, fio will display the status of the
2685 jobs created. An example of that would be:
2686 .P
2687 .nf
2688                 Jobs: 1 (f=1): [_(1),M(1)][24.8%][r=20.5MiB/s,w=23.5MiB/s][r=82,w=94 IOPS][eta 01m:31s]
2689 .fi
2690 .P
2691 The characters inside the first set of square brackets denote the current status of
2692 each thread. The first character is the first job defined in the job file, and so
2693 forth. The possible values (in typical life cycle order) are:
2694 .RS
2695 .TP
2696 .PD 0
2697 .B P
2698 Thread setup, but not started.
2699 .TP
2700 .B C
2701 Thread created.
2702 .TP
2703 .B I
2704 Thread initialized, waiting or generating necessary data.
2705 .TP
2706 .B P
2707 Thread running pre\-reading file(s).
2708 .TP
2709 .B /
2710 Thread is in ramp period.
2711 .TP
2712 .B R
2713 Running, doing sequential reads.
2714 .TP
2715 .B r
2716 Running, doing random reads.
2717 .TP
2718 .B W
2719 Running, doing sequential writes.
2720 .TP
2721 .B w
2722 Running, doing random writes.
2723 .TP
2724 .B M
2725 Running, doing mixed sequential reads/writes.
2726 .TP
2727 .B m
2728 Running, doing mixed random reads/writes.
2729 .TP
2730 .B D
2731 Running, doing sequential trims.
2732 .TP
2733 .B d
2734 Running, doing random trims.
2735 .TP
2736 .B F
2737 Running, currently waiting for \fBfsync\fR\|(2).
2738 .TP
2739 .B V
2740 Running, doing verification of written data.
2741 .TP
2742 .B f
2743 Thread finishing.
2744 .TP
2745 .B E
2746 Thread exited, not reaped by main thread yet.
2747 .TP
2748 .B \-
2749 Thread reaped.
2750 .TP
2751 .B X
2752 Thread reaped, exited with an error.
2753 .TP
2754 .B K
2755 Thread reaped, exited due to signal.
2756 .PD
2757 .RE
2758 .P
2759 Fio will condense the thread string as not to take up more space on the command
2760 line than needed. For instance, if you have 10 readers and 10 writers running,
2761 the output would look like this:
2762 .P
2763 .nf
2764                 Jobs: 20 (f=20): [R(10),W(10)][4.0%][r=20.5MiB/s,w=23.5MiB/s][r=82,w=94 IOPS][eta 57m:36s]
2765 .fi
2766 .P
2767 Note that the status string is displayed in order, so it's possible to tell which of
2768 the jobs are currently doing what. In the example above this means that jobs 1\-\-10
2769 are readers and 11\-\-20 are writers.
2770 .P
2771 The other values are fairly self explanatory \-\- number of threads currently
2772 running and doing I/O, the number of currently open files (f=), the estimated
2773 completion percentage, the rate of I/O since last check (read speed listed first,
2774 then write speed and optionally trim speed) in terms of bandwidth and IOPS,
2775 and time to completion for the current running group. It's impossible to estimate
2776 runtime of the following groups (if any).
2777 .P
2778 When fio is done (or interrupted by Ctrl\-C), it will show the data for
2779 each thread, group of threads, and disks in that order. For each overall thread (or
2780 group) the output looks like:
2781 .P
2782 .nf
2783                 Client1: (groupid=0, jobs=1): err= 0: pid=16109: Sat Jun 24 12:07:54 2017
2784                   write: IOPS=88, BW=623KiB/s (638kB/s)(30.4MiB/50032msec)
2785                     slat (nsec): min=500, max=145500, avg=8318.00, stdev=4781.50
2786                     clat (usec): min=170, max=78367, avg=4019.02, stdev=8293.31
2787                      lat (usec): min=174, max=78375, avg=4027.34, stdev=8291.79
2788                     clat percentiles (usec):
2789                      |  1.00th=[  302],  5.00th=[  326], 10.00th=[  343], 20.00th=[  363],
2790                      | 30.00th=[  392], 40.00th=[  404], 50.00th=[  416], 60.00th=[  445],
2791                      | 70.00th=[  816], 80.00th=[ 6718], 90.00th=[12911], 95.00th=[21627],
2792                      | 99.00th=[43779], 99.50th=[51643], 99.90th=[68682], 99.95th=[72877],
2793                      | 99.99th=[78119]
2794                    bw (  KiB/s): min=  532, max=  686, per=0.10%, avg=622.87, stdev=24.82, samples=  100
2795                    iops        : min=   76, max=   98, avg=88.98, stdev= 3.54, samples=  100
2796                     lat (usec) : 250=0.04%, 500=64.11%, 750=4.81%, 1000=2.79%
2797                     lat (msec) : 2=4.16%, 4=1.84%, 10=4.90%, 20=11.33%, 50=5.37%
2798                     lat (msec) : 100=0.65%
2799                   cpu          : usr=0.27%, sys=0.18%, ctx=12072, majf=0, minf=21
2800                   IO depths    : 1=85.0%, 2=13.1%, 4=1.8%, 8=0.1%, 16=0.0%, 32=0.0%, >=64=0.0%
2801                      submit    : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0%
2802                      complete  : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0%
2803                      issued rwt: total=0,4450,0, short=0,0,0, dropped=0,0,0
2804                      latency   : target=0, window=0, percentile=100.00%, depth=8
2805 .fi
2806 .P
2807 The job name (or first job's name when using \fBgroup_reporting\fR) is printed,
2808 along with the group id, count of jobs being aggregated, last error id seen (which
2809 is 0 when there are no errors), pid/tid of that thread and the time the job/group
2810 completed. Below are the I/O statistics for each data direction performed (showing
2811 writes in the example above). In the order listed, they denote:
2812 .RS
2813 .TP
2814 .B read/write/trim
2815 The string before the colon shows the I/O direction the statistics
2816 are for. \fIIOPS\fR is the average I/Os performed per second. \fIBW\fR
2817 is the average bandwidth rate shown as: value in power of 2 format
2818 (value in power of 10 format). The last two values show: (total
2819 I/O performed in power of 2 format / \fIruntime\fR of that thread).
2820 .TP
2821 .B slat
2822 Submission latency (\fImin\fR being the minimum, \fImax\fR being the
2823 maximum, \fIavg\fR being the average, \fIstdev\fR being the standard
2824 deviation). This is the time it took to submit the I/O. For
2825 sync I/O this row is not displayed as the slat is really the
2826 completion latency (since queue/complete is one operation there).
2827 This value can be in nanoseconds, microseconds or milliseconds \-\-\-
2828 fio will choose the most appropriate base and print that (in the
2829 example above nanoseconds was the best scale). Note: in \fB\-\-minimal\fR mode
2830 latencies are always expressed in microseconds.
2831 .TP
2832 .B clat
2833 Completion latency. Same names as slat, this denotes the time from
2834 submission to completion of the I/O pieces. For sync I/O, clat will
2835 usually be equal (or very close) to 0, as the time from submit to
2836 complete is basically just CPU time (I/O has already been done, see slat
2837 explanation).
2838 .TP
2839 .B bw
2840 Bandwidth statistics based on samples. Same names as the xlat stats,
2841 but also includes the number of samples taken (\fIsamples\fR) and an
2842 approximate percentage of total aggregate bandwidth this thread
2843 received in its group (\fIper\fR). This last value is only really
2844 useful if the threads in this group are on the same disk, since they
2845 are then competing for disk access.
2846 .TP
2847 .B iops
2848 IOPS statistics based on samples. Same names as \fBbw\fR.
2849 .TP
2850 .B cpu
2851 CPU usage. User and system time, along with the number of context
2852 switches this thread went through, usage of system and user time, and
2853 finally the number of major and minor page faults. The CPU utilization
2854 numbers are averages for the jobs in that reporting group, while the
2855 context and fault counters are summed.
2856 .TP
2857 .B IO depths
2858 The distribution of I/O depths over the job lifetime. The numbers are
2859 divided into powers of 2 and each entry covers depths from that value
2860 up to those that are lower than the next entry \-\- e.g., 16= covers
2861 depths from 16 to 31. Note that the range covered by a depth
2862 distribution entry can be different to the range covered by the
2863 equivalent \fBsubmit\fR/\fBcomplete\fR distribution entry.
2864 .TP
2865 .B IO submit
2866 How many pieces of I/O were submitting in a single submit call. Each
2867 entry denotes that amount and below, until the previous entry \-\- e.g.,
2868 16=100% means that we submitted anywhere between 9 to 16 I/Os per submit
2869 call. Note that the range covered by a \fBsubmit\fR distribution entry can
2870 be different to the range covered by the equivalent depth distribution
2871 entry.
2872 .TP
2873 .B IO complete
2874 Like the above \fBsubmit\fR number, but for completions instead.
2875 .TP
2876 .B IO issued rwt
2877 The number of \fBread/write/trim\fR requests issued, and how many of them were
2878 short or dropped.
2879 .TP
2880 .B IO latencies
2881 The distribution of I/O completion latencies. This is the time from when
2882 I/O leaves fio and when it gets completed. The numbers follow the same
2883 pattern as the I/O \fBdepths\fR, meaning that 2=1.6% means that 1.6% of the
2884 I/O completed within 2 msecs, 20=12.8% means that 12.8% of the I/O took
2885 more than 10 msecs, but less than (or equal to) 20 msecs.
2886 .RE
2887 .P
2888 After each client has been listed, the group statistics are printed. They
2889 will look like this:
2890 .P
2891 .nf
2892                 Run status group 0 (all jobs):
2893                    READ: bw=20.9MiB/s (21.9MB/s), 10.4MiB/s\-10.8MiB/s (10.9MB/s\-11.3MB/s), io=64.0MiB (67.1MB), run=2973\-3069msec
2894                   WRITE: bw=1231KiB/s (1261kB/s), 616KiB/s\-621KiB/s (630kB/s\-636kB/s), io=64.0MiB (67.1MB), run=52747\-53223msec
2895 .fi
2896 .P
2897 For each data direction it prints:
2898 .RS
2899 .TP
2900 .B bw
2901 Aggregate bandwidth of threads in this group followed by the
2902 minimum and maximum bandwidth of all the threads in this group.
2903 Values outside of brackets are power\-of\-2 format and those
2904 within are the equivalent value in a power\-of\-10 format.
2905 .TP
2906 .B io
2907 Aggregate I/O performed of all threads in this group. The
2908 format is the same as \fBbw\fR.
2909 .TP
2910 .B run
2911 The smallest and longest runtimes of the threads in this group.
2912 .RE
2913 .P
2914 And finally, the disk statistics are printed. This is Linux specific.
2915 They will look like this:
2916 .P
2917 .nf
2918                   Disk stats (read/write):
2919                     sda: ios=16398/16511, merge=30/162, ticks=6853/819634, in_queue=826487, util=100.00%
2920 .fi
2921 .P
2922 Each value is printed for both reads and writes, with reads first. The
2923 numbers denote:
2924 .RS
2925 .TP
2926 .B ios
2927 Number of I/Os performed by all groups.
2928 .TP
2929 .B merge
2930 Number of merges performed by the I/O scheduler.
2931 .TP
2932 .B ticks
2933 Number of ticks we kept the disk busy.
2934 .TP
2935 .B in_queue
2936 Total time spent in the disk queue.
2937 .TP
2938 .B util
2939 The disk utilization. A value of 100% means we kept the disk
2940 busy constantly, 50% would be a disk idling half of the time.
2941 .RE
2942 .P
2943 It is also possible to get fio to dump the current output while it is running,
2944 without terminating the job. To do that, send fio the USR1 signal. You can
2945 also get regularly timed dumps by using the \fB\-\-status\-interval\fR
2946 parameter, or by creating a file in `/tmp' named
2947 `fio\-dump\-status'. If fio sees this file, it will unlink it and dump the
2948 current output status.
2950 For scripted usage where you typically want to generate tables or graphs of the
2951 results, fio can output the results in a semicolon separated format. The format
2952 is one long line of values, such as:
2953 .P
2954 .nf
2955                 2;card0;0;0;7139336;121836;60004;1;10109;27.932460;116.933948;220;126861;3495.446807;1085.368601;226;126864;3523.635629;1089.012448;24063;99944;50.275485%;59818.274627;5540.657370;7155060;122104;60004;1;8338;29.086342;117.839068;388;128077;5032.488518;1234.785715;391;128085;5061.839412;1236.909129;23436;100928;50.287926%;59964.832030;5644.844189;14.595833%;19.394167%;123706;0;7313;0.1%;0.1%;0.1%;0.1%;0.1%;0.1%;100.0%;0.00%;0.00%;0.00%;0.00%;0.00%;0.00%;0.01%;0.02%;0.05%;0.16%;6.04%;40.40%;52.68%;0.64%;0.01%;0.00%;0.01%;0.00%;0.00%;0.00%;0.00%;0.00%
2956                 A description of this job goes here.
2957 .fi
2958 .P
2959 The job description (if provided) follows on a second line.
2960 .P
2961 To enable terse output, use the \fB\-\-minimal\fR or
2962 `\-\-output\-format=terse' command line options. The
2963 first value is the version of the terse output format. If the output has to be
2964 changed for some reason, this number will be incremented by 1 to signify that
2965 change.
2966 .P
2967 Split up, the format is as follows (comments in brackets denote when a
2968 field was introduced or whether it's specific to some terse version):
2969 .P
2970 .nf
2971                         terse version, fio version [v3], jobname, groupid, error
2972 .fi
2973 .RS
2974 .P
2975 .B
2976 READ status:
2977 .RE
2978 .P
2979 .nf
2980                         Total IO (KiB), bandwidth (KiB/sec), IOPS, runtime (msec)
2981                         Submission latency: min, max, mean, stdev (usec)
2982                         Completion latency: min, max, mean, stdev (usec)
2983                         Completion latency percentiles: 20 fields (see below)
2984                         Total latency: min, max, mean, stdev (usec)
2985                         Bw (KiB/s): min, max, aggregate percentage of total, mean, stdev, number of samples [v5]
2986                         IOPS [v5]: min, max, mean, stdev, number of samples
2987 .fi
2988 .RS
2989 .P
2990 .B
2991 WRITE status:
2992 .RE
2993 .P
2994 .nf
2995                         Total IO (KiB), bandwidth (KiB/sec), IOPS, runtime (msec)
2996                         Submission latency: min, max, mean, stdev (usec)
2997                         Completion latency: min, max, mean, stdev (usec)
2998                         Completion latency percentiles: 20 fields (see below)
2999                         Total latency: min, max, mean, stdev (usec)
3000                         Bw (KiB/s): min, max, aggregate percentage of total, mean, stdev, number of samples [v5]
3001                         IOPS [v5]: min, max, mean, stdev, number of samples
3002 .fi
3003 .RS
3004 .P
3005 .B
3006 TRIM status [all but version 3]:
3007 .RE
3008 .P
3009 .nf
3010                         Fields are similar to \fBREAD/WRITE\fR status.
3011 .fi
3012 .RS
3013 .P
3014 .B
3015 CPU usage:
3016 .RE
3017 .P
3018 .nf
3019                         user, system, context switches, major faults, minor faults
3020 .fi
3021 .RS
3022 .P
3023 .B
3024 I/O depths:
3025 .RE
3026 .P
3027 .nf
3028                         <=1, 2, 4, 8, 16, 32, >=64
3029 .fi
3030 .RS
3031 .P
3032 .B
3033 I/O latencies microseconds:
3034 .RE
3035 .P
3036 .nf
3037                         <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
3038 .fi
3039 .RS
3040 .P
3041 .B
3042 I/O latencies milliseconds:
3043 .RE
3044 .P
3045 .nf
3046                         <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000
3047 .fi
3048 .RS
3049 .P
3050 .B
3051 Disk utilization [v3]:
3052 .RE
3053 .P
3054 .nf
3055                         disk name, read ios, write ios, read merges, write merges, read ticks, write ticks, time spent in queue, disk utilization percentage
3056 .fi
3057 .RS
3058 .P
3059 .B
3060 Additional Info (dependent on continue_on_error, default off):
3061 .RE
3062 .P
3063 .nf
3064                         total # errors, first error code
3065 .fi
3066 .RS
3067 .P
3068 .B
3069 Additional Info (dependent on description being set):
3070 .RE
3071 .P
3072 .nf
3073                         Text description
3074 .fi
3075 .P
3076 Completion latency percentiles can be a grouping of up to 20 sets, so for the
3077 terse output fio writes all of them. Each field will look like this:
3078 .P
3079 .nf
3080                 1.00%=6112
3081 .fi
3082 .P
3083 which is the Xth percentile, and the `usec' latency associated with it.
3084 .P
3085 For \fBDisk utilization\fR, all disks used by fio are shown. So for each disk there
3086 will be a disk utilization section.
3087 .P
3088 Below is a single line containing short names for each of the fields in the
3089 minimal output v3, separated by semicolons:
3090 .P
3091 .nf
3092                 terse_version_3;fio_version;jobname;groupid;error;read_kb;read_bandwidth;read_iops;read_runtime_ms;read_slat_min;read_slat_max;read_slat_mean;read_slat_dev;read_clat_min;read_clat_max;read_clat_mean;read_clat_dev;read_clat_pct01;read_clat_pct02;read_clat_pct03;read_clat_pct04;read_clat_pct05;read_clat_pct06;read_clat_pct07;read_clat_pct08;read_clat_pct09;read_clat_pct10;read_clat_pct11;read_clat_pct12;read_clat_pct13;read_clat_pct14;read_clat_pct15;read_clat_pct16;read_clat_pct17;read_clat_pct18;read_clat_pct19;read_clat_pct20;read_tlat_min;read_lat_max;read_lat_mean;read_lat_dev;read_bw_min;read_bw_max;read_bw_agg_pct;read_bw_mean;read_bw_dev;write_kb;write_bandwidth;write_iops;write_runtime_ms;write_slat_min;write_slat_max;write_slat_mean;write_slat_dev;write_clat_min;write_clat_max;write_clat_mean;write_clat_dev;write_clat_pct01;write_clat_pct02;write_clat_pct03;write_clat_pct04;write_clat_pct05;write_clat_pct06;write_clat_pct07;write_clat_pct08;write_clat_pct09;write_clat_pct10;write_clat_pct11;write_clat_pct12;write_clat_pct13;write_clat_pct14;write_clat_pct15;write_clat_pct16;write_clat_pct17;write_clat_pct18;write_clat_pct19;write_clat_pct20;write_tlat_min;write_lat_max;write_lat_mean;write_lat_dev;write_bw_min;write_bw_max;write_bw_agg_pct;write_bw_mean;write_bw_dev;cpu_user;cpu_sys;cpu_csw;cpu_mjf;cpu_minf;iodepth_1;iodepth_2;iodepth_4;iodepth_8;iodepth_16;iodepth_32;iodepth_64;lat_2us;lat_4us;lat_10us;lat_20us;lat_50us;lat_100us;lat_250us;lat_500us;lat_750us;lat_1000us;lat_2ms;lat_4ms;lat_10ms;lat_20ms;lat_50ms;lat_100ms;lat_250ms;lat_500ms;lat_750ms;lat_1000ms;lat_2000ms;lat_over_2000ms;disk_name;disk_read_iops;disk_write_iops;disk_read_merges;disk_write_merges;disk_read_ticks;write_ticks;disk_queue_time;disk_util
3093 .fi
3095 The \fBjson+\fR output format is identical to the \fBjson\fR output format except that it
3096 adds a full dump of the completion latency bins. Each \fBbins\fR object contains a
3097 set of (key, value) pairs where keys are latency durations and values count how
3098 many I/Os had completion latencies of the corresponding duration. For example,
3099 consider:
3100 .RS
3101 .P
3102 "bins" : { "87552" : 1, "89600" : 1, "94720" : 1, "96768" : 1, "97792" : 1, "99840" : 1, "100864" : 2, "103936" : 6, "104960" : 534, "105984" : 5995, "107008" : 7529, ... }
3103 .RE
3104 .P
3105 This data indicates that one I/O required 87,552ns to complete, two I/Os required
3106 100,864ns to complete, and 7529 I/Os required 107,008ns to complete.
3107 .P
3108 Also included with fio is a Python script \fBfio_jsonplus_clat2csv\fR that takes
3109 json+ output and generates CSV\-formatted latency data suitable for plotting.
3110 .P
3111 The latency durations actually represent the midpoints of latency intervals.
3112 For details refer to `stat.h' in the fio source.
3114 There are two trace file format that you can encounter. The older (v1) format is
3115 unsupported since version 1.20\-rc3 (March 2008). It will still be described
3116 below in case that you get an old trace and want to understand it.
3117 .P
3118 In any case the trace is a simple text file with a single action per line.
3119 .TP
3120 .B Trace file format v1
3121 Each line represents a single I/O action in the following format:
3122 .RS
3123 .RS
3124 .P
3125 rw, offset, length
3126 .RE
3127 .P
3128 where `rw=0/1' for read/write, and the `offset' and `length' entries being in bytes.
3129 .P
3130 This format is not supported in fio versions >= 1.20\-rc3.
3131 .RE
3132 .TP
3133 .B Trace file format v2
3134 The second version of the trace file format was added in fio version 1.17. It
3135 allows to access more then one file per trace and has a bigger set of possible
3136 file actions.
3137 .RS
3138 .P
3139 The first line of the trace file has to be:
3140 .RS
3141 .P
3142 "fio version 2 iolog"
3143 .RE
3144 .P
3145 Following this can be lines in two different formats, which are described below.
3146 .P
3147 .B
3148 The file management format:
3149 .RS
3150 filename action
3151 .P
3152 The `filename' is given as an absolute path. The `action' can be one of these:
3153 .RS
3154 .TP
3155 .B add
3156 Add the given `filename' to the trace.
3157 .TP
3158 .B open
3159 Open the file with the given `filename'. The `filename' has to have
3160 been added with the \fBadd\fR action before.
3161 .TP
3162 .B close
3163 Close the file with the given `filename'. The file has to have been
3164 \fBopen\fRed before.
3165 .RE
3166 .RE
3167 .P
3168 .B
3169 The file I/O action format:
3170 .RS
3171 filename action offset length
3172 .P
3173 The `filename' is given as an absolute path, and has to have been \fBadd\fRed and
3174 \fBopen\fRed before it can be used with this format. The `offset' and `length' are
3175 given in bytes. The `action' can be one of these:
3176 .RS
3177 .TP
3178 .B wait
3179 Wait for `offset' microseconds. Everything below 100 is discarded.
3180 The time is relative to the previous `wait' statement.
3181 .TP
3182 .B read
3183 Read `length' bytes beginning from `offset'.
3184 .TP
3185 .B write
3186 Write `length' bytes beginning from `offset'.
3187 .TP
3188 .B sync
3189 \fBfsync\fR\|(2) the file.
3190 .TP
3191 .B datasync
3192 \fBfdatasync\fR\|(2) the file.
3193 .TP
3194 .B trim
3195 Trim the given file from the given `offset' for `length' bytes.
3196 .RE
3197 .RE
3199 In some cases, we want to understand CPU overhead in a test. For example, we
3200 test patches for the specific goodness of whether they reduce CPU usage.
3201 Fio implements a balloon approach to create a thread per CPU that runs at idle
3202 priority, meaning that it only runs when nobody else needs the cpu.
3203 By measuring the amount of work completed by the thread, idleness of each CPU
3204 can be derived accordingly.
3205 .P
3206 An unit work is defined as touching a full page of unsigned characters. Mean and
3207 standard deviation of time to complete an unit work is reported in "unit work"
3208 section. Options can be chosen to report detailed percpu idleness or overall
3209 system idleness by aggregating percpu stats.
3211 Fio is usually run in one of two ways, when data verification is done. The first
3212 is a normal write job of some sort with verify enabled. When the write phase has
3213 completed, fio switches to reads and verifies everything it wrote. The second
3214 model is running just the write phase, and then later on running the same job
3215 (but with reads instead of writes) to repeat the same I/O patterns and verify
3216 the contents. Both of these methods depend on the write phase being completed,
3217 as fio otherwise has no idea how much data was written.
3218 .P
3219 With verification triggers, fio supports dumping the current write state to
3220 local files. Then a subsequent read verify workload can load this state and know
3221 exactly where to stop. This is useful for testing cases where power is cut to a
3222 server in a managed fashion, for instance.
3223 .P
3224 A verification trigger consists of two things:
3225 .RS
3226 .P
3227 1) Storing the write state of each job.
3228 .P
3229 2) Executing a trigger command.
3230 .RE
3231 .P
3232 The write state is relatively small, on the order of hundreds of bytes to single
3233 kilobytes. It contains information on the number of completions done, the last X
3234 completions, etc.
3235 .P
3236 A trigger is invoked either through creation ('touch') of a specified file in
3237 the system, or through a timeout setting. If fio is run with
3238 `\-\-trigger\-file=/tmp/trigger\-file', then it will continually
3239 check for the existence of `/tmp/trigger\-file'. When it sees this file, it
3240 will fire off the trigger (thus saving state, and executing the trigger
3241 command).
3242 .P
3243 For client/server runs, there's both a local and remote trigger. If fio is
3244 running as a server backend, it will send the job states back to the client for
3245 safe storage, then execute the remote trigger, if specified. If a local trigger
3246 is specified, the server will still send back the write state, but the client
3247 will then execute the trigger.
3248 .RE
3249 .P
3250 .B Verification trigger example
3251 .RS
3252 Let's say we want to run a powercut test on the remote Linux machine 'server'.
3253 Our write workload is in `write\-test.fio'. We want to cut power to 'server' at
3254 some point during the run, and we'll run this test from the safety or our local
3255 machine, 'localbox'. On the server, we'll start the fio backend normally:
3256 .RS
3257 .P
3258 server# fio \-\-server
3259 .RE
3260 .P
3261 and on the client, we'll fire off the workload:
3262 .RS
3263 .P
3264 localbox$ fio \-\-client=server \-\-trigger\-file=/tmp/my\-trigger \-\-trigger\-remote="bash \-c "echo b > /proc/sysrq\-triger""
3265 .RE
3266 .P
3267 We set `/tmp/my\-trigger' as the trigger file, and we tell fio to execute:
3268 .RS
3269 .P
3270 echo b > /proc/sysrq\-trigger
3271 .RE
3272 .P
3273 on the server once it has received the trigger and sent us the write state. This
3274 will work, but it's not really cutting power to the server, it's merely
3275 abruptly rebooting it. If we have a remote way of cutting power to the server
3276 through IPMI or similar, we could do that through a local trigger command
3277 instead. Let's assume we have a script that does IPMI reboot of a given hostname,
3278 ipmi\-reboot. On localbox, we could then have run fio with a local trigger
3279 instead:
3280 .RS
3281 .P
3282 localbox$ fio \-\-client=server \-\-trigger\-file=/tmp/my\-trigger \-\-trigger="ipmi\-reboot server"
3283 .RE
3284 .P
3285 For this case, fio would wait for the server to send us the write state, then
3286 execute `ipmi\-reboot server' when that happened.
3287 .RE
3288 .P
3289 .B Loading verify state
3290 .RS
3291 To load stored write state, a read verification job file must contain the
3292 \fBverify_state_load\fR option. If that is set, fio will load the previously
3293 stored state. For a local fio run this is done by loading the files directly,
3294 and on a client/server run, the server backend will ask the client to send the
3295 files over and load them from there.
3296 .RE
3298 Fio supports a variety of log file formats, for logging latencies, bandwidth,
3299 and IOPS. The logs share a common format, which looks like this:
3300 .RS
3301 .P
3302 time (msec), value, data direction, block size (bytes), offset (bytes)
3303 .RE
3304 .P
3305 `Time' for the log entry is always in milliseconds. The `value' logged depends
3306 on the type of log, it will be one of the following:
3307 .RS
3308 .TP
3309 .B Latency log
3310 Value is latency in usecs
3311 .TP
3312 .B Bandwidth log
3313 Value is in KiB/sec
3314 .TP
3315 .B IOPS log
3316 Value is IOPS
3317 .RE
3318 .P
3319 `Data direction' is one of the following:
3320 .RS
3321 .TP
3322 .B 0
3323 I/O is a READ
3324 .TP
3325 .B 1
3326 I/O is a WRITE
3327 .TP
3328 .B 2
3329 I/O is a TRIM
3330 .RE
3331 .P
3332 The entry's `block size' is always in bytes. The `offset' is the offset, in bytes,
3333 from the start of the file, for that particular I/O. The logging of the offset can be
3334 toggled with \fBlog_offset\fR.
3335 .P
3336 Fio defaults to logging every individual I/O. When IOPS are logged for individual
3337 I/Os the `value' entry will always be 1. If windowed logging is enabled through
3338 \fBlog_avg_msec\fR, fio logs the average values over the specified period of time.
3339 If windowed logging is enabled and \fBlog_max_value\fR is set, then fio logs
3340 maximum values in that window instead of averages. Since `data direction', `block size'
3341 and `offset' are per\-I/O values, if windowed logging is enabled they
3342 aren't applicable and will be 0.
3344 Normally fio is invoked as a stand\-alone application on the machine where the
3345 I/O workload should be generated. However, the backend and frontend of fio can
3346 be run separately i.e., the fio server can generate an I/O workload on the "Device
3347 Under Test" while being controlled by a client on another machine.
3348 .P
3349 Start the server on the machine which has access to the storage DUT:
3350 .RS
3351 .P
3352 $ fio \-\-server=args
3353 .RE
3354 .P
3355 where `args' defines what fio listens to. The arguments are of the form
3356 `type,hostname' or `IP,port'. `type' is either `ip' (or ip4) for TCP/IP
3357 v4, `ip6' for TCP/IP v6, or `sock' for a local unix domain socket.
3358 `hostname' is either a hostname or IP address, and `port' is the port to listen
3359 to (only valid for TCP/IP, not a local socket). Some examples:
3360 .RS
3361 .TP
3362 1) \fBfio \-\-server\fR
3363 Start a fio server, listening on all interfaces on the default port (8765).
3364 .TP
3365 2) \fBfio \-\-server=ip:hostname,4444\fR
3366 Start a fio server, listening on IP belonging to hostname and on port 4444.
3367 .TP
3368 3) \fBfio \-\-server=ip6:::1,4444\fR
3369 Start a fio server, listening on IPv6 localhost ::1 and on port 4444.
3370 .TP
3371 4) \fBfio \-\-server=,4444\fR
3372 Start a fio server, listening on all interfaces on port 4444.
3373 .TP
3374 5) \fBfio \-\-server=\fR
3375 Start a fio server, listening on IP on the default port.
3376 .TP
3377 6) \fBfio \-\-server=sock:/tmp/fio.sock\fR
3378 Start a fio server, listening on the local socket `/tmp/fio.sock'.
3379 .RE
3380 .P
3381 Once a server is running, a "client" can connect to the fio server with:
3382 .RS
3383 .P
3384 $ fio <local\-args> \-\-client=<server> <remote\-args> <job file(s)>
3385 .RE
3386 .P
3387 where `local\-args' are arguments for the client where it is running, `server'
3388 is the connect string, and `remote\-args' and `job file(s)' are sent to the
3389 server. The `server' string follows the same format as it does on the server
3390 side, to allow IP/hostname/socket and port strings.
3391 .P
3392 Fio can connect to multiple servers this way:
3393 .RS
3394 .P
3395 $ fio \-\-client=<server1> <job file(s)> \-\-client=<server2> <job file(s)>
3396 .RE
3397 .P
3398 If the job file is located on the fio server, then you can tell the server to
3399 load a local file as well. This is done by using \fB\-\-remote\-config\fR:
3400 .RS
3401 .P
3402 $ fio \-\-client=server \-\-remote\-config /path/to/file.fio
3403 .RE
3404 .P
3405 Then fio will open this local (to the server) job file instead of being passed
3406 one from the client.
3407 .P
3408 If you have many servers (example: 100 VMs/containers), you can input a pathname
3409 of a file containing host IPs/names as the parameter value for the
3410 \fB\-\-client\fR option. For example, here is an example `host.list'
3411 file containing 2 hostnames:
3412 .RS
3413 .P
3414 .PD 0
3415 host1.your.dns.domain
3416 .P
3417 host2.your.dns.domain
3418 .PD
3419 .RE
3420 .P
3421 The fio command would then be:
3422 .RS
3423 .P
3424 $ fio \-\-client=host.list <job file(s)>
3425 .RE
3426 .P
3427 In this mode, you cannot input server\-specific parameters or job files \-\- all
3428 servers receive the same job file.
3429 .P
3430 In order to let `fio \-\-client' runs use a shared filesystem from multiple
3431 hosts, `fio \-\-client' now prepends the IP address of the server to the
3432 filename. For example, if fio is using the directory `/mnt/nfs/fio' and is
3433 writing filename `fileio.tmp', with a \fB\-\-client\fR `hostfile'
3434 containing two hostnames `h1' and `h2' with IP addresses and
3435, then fio will create two files:
3436 .RS
3437 .P
3438 .PD 0
3439 /mnt/nfs/fio/
3440 .P
3441 /mnt/nfs/fio/
3442 .PD
3443 .RE
3445 .B fio
3446 was written by Jens Axboe <jens.axboe@oracle.com>,
3447 now Jens Axboe <axboe@fb.com>.
3448 .br
3449 This man page was written by Aaron Carroll <aaronc@cse.unsw.edu.au> based
3450 on documentation by Jens Axboe.
3451 .br
3452 This man page was rewritten by Tomohiro Kusumi <tkusumi@tuxera.com> based
3453 on documentation by Jens Axboe.
3455 Report bugs to the \fBfio\fR mailing list <fio@vger.kernel.org>.
3456 .br
3458 .P
3459 \fBREPORTING\-BUGS\fR: \fIhttp://git.kernel.dk/cgit/fio/plain/REPORTING\-BUGS\fR
3460 .SH "SEE ALSO"
3461 For further documentation see \fBHOWTO\fR and \fBREADME\fR.
3462 .br
3463 Sample jobfiles are available in the `examples/' directory.
3464 .br
3465 These are typically located under `/usr/share/doc/fio'.
3466 .P
3467 \fBHOWTO\fR: \fIhttp://git.kernel.dk/cgit/fio/plain/HOWTO\fR
3468 .br
3469 \fBREADME\fR: \fIhttp://git.kernel.dk/cgit/fio/plain/README\fR