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