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