add documentation about filename_format directory behavior
[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 next \fBblockalign\fR\-ed
917 offset will be used. Data before the given offset will not be touched. This
918 effectively caps the file size at `real_size \- offset'. Can be combined with
919 \fBsize\fR to constrain the start and end range of the I/O workload.
920 A percentage can be specified by a number between 1 and 100 followed by '%',
921 for example, `offset=20%' to specify 20%.
922 .TP
923 .BI offset_increment \fR=\fPint
924 If this is provided, then the real offset becomes `\fBoffset\fR + \fBoffset_increment\fR
925 * thread_number', where the thread number is a counter that starts at 0 and
926 is incremented for each sub\-job (i.e. when \fBnumjobs\fR option is
927 specified). This option is useful if there are several jobs which are
928 intended to operate on a file in parallel disjoint segments, with even
929 spacing between the starting points.
930 .TP
931 .BI number_ios \fR=\fPint
932 Fio will normally perform I/Os until it has exhausted the size of the region
933 set by \fBsize\fR, or if it exhaust the allocated time (or hits an error
934 condition). With this setting, the range/size can be set independently of
935 the number of I/Os to perform. When fio reaches this number, it will exit
936 normally and report status. Note that this does not extend the amount of I/O
937 that will be done, it will only stop fio if this condition is met before
938 other end\-of\-job criteria.
939 .TP
940 .BI fsync \fR=\fPint
941 If writing to a file, issue an \fBfsync\fR\|(2) (or its equivalent) of
942 the dirty data for every number of blocks given. For example, if you give 32
943 as a parameter, fio will sync the file after every 32 writes issued. If fio is
944 using non\-buffered I/O, we may not sync the file. The exception is the sg
945 I/O engine, which synchronizes the disk cache anyway. Defaults to 0, which
946 means fio does not periodically issue and wait for a sync to complete. Also
947 see \fBend_fsync\fR and \fBfsync_on_close\fR.
948 .TP
949 .BI fdatasync \fR=\fPint
950 Like \fBfsync\fR but uses \fBfdatasync\fR\|(2) to only sync data and
951 not metadata blocks. In Windows, FreeBSD, and DragonFlyBSD there is no
952 \fBfdatasync\fR\|(2) so this falls back to using \fBfsync\fR\|(2).
953 Defaults to 0, which means fio does not periodically issue and wait for a
954 data\-only sync to complete.
955 .TP
956 .BI write_barrier \fR=\fPint
957 Make every N\-th write a barrier write.
958 .TP
959 .BI sync_file_range \fR=\fPstr:int
960 Use \fBsync_file_range\fR\|(2) for every \fIint\fR number of write
961 operations. Fio will track range of writes that have happened since the last
962 \fBsync_file_range\fR\|(2) call. \fIstr\fR can currently be one or more of:
963 .RS
964 .RS
965 .TP
966 .B wait_before
968 .TP
969 .B write
971 .TP
972 .B wait_after
974 .RE
975 .P
976 So if you do `sync_file_range=wait_before,write:8', fio would use
978 writes. Also see the \fBsync_file_range\fR\|(2) man page. This option is
979 Linux specific.
980 .RE
981 .TP
982 .BI overwrite \fR=\fPbool
983 If true, writes to a file will always overwrite existing data. If the file
984 doesn't already exist, it will be created before the write phase begins. If
985 the file exists and is large enough for the specified write phase, nothing
986 will be done. Default: false.
987 .TP
988 .BI end_fsync \fR=\fPbool
989 If true, \fBfsync\fR\|(2) file contents when a write stage has completed.
990 Default: false.
991 .TP
992 .BI fsync_on_close \fR=\fPbool
993 If true, fio will \fBfsync\fR\|(2) a dirty file on close. This differs
994 from \fBend_fsync\fR in that it will happen on every file close, not
995 just at the end of the job. Default: false.
996 .TP
997 .BI rwmixread \fR=\fPint
998 Percentage of a mixed workload that should be reads. Default: 50.
999 .TP
1000 .BI rwmixwrite \fR=\fPint
1001 Percentage of a mixed workload that should be writes. If both
1002 \fBrwmixread\fR and \fBrwmixwrite\fR is given and the values do not
1003 add up to 100%, the latter of the two will be used to override the
1004 first. This may interfere with a given rate setting, if fio is asked to
1005 limit reads or writes to a certain rate. If that is the case, then the
1006 distribution may be skewed. Default: 50.
1007 .TP
1008 .BI random_distribution \fR=\fPstr:float[,str:float][,str:float]
1009 By default, fio will use a completely uniform random distribution when asked
1010 to perform random I/O. Sometimes it is useful to skew the distribution in
1011 specific ways, ensuring that some parts of the data is more hot than others.
1012 fio includes the following distribution models:
1013 .RS
1014 .RS
1015 .TP
1016 .B random
1017 Uniform random distribution
1018 .TP
1019 .B zipf
1020 Zipf distribution
1021 .TP
1022 .B pareto
1023 Pareto distribution
1024 .TP
1025 .B normal
1026 Normal (Gaussian) distribution
1027 .TP
1028 .B zoned
1029 Zoned random distribution
1030 .RE
1031 .P
1032 When using a \fBzipf\fR or \fBpareto\fR distribution, an input value is also
1033 needed to define the access pattern. For \fBzipf\fR, this is the `Zipf theta'.
1034 For \fBpareto\fR, it's the `Pareto power'. Fio includes a test
1035 program, \fBfio\-genzipf\fR, that can be used visualize what the given input
1036 values will yield in terms of hit rates. If you wanted to use \fBzipf\fR with
1037 a `theta' of 1.2, you would use `random_distribution=zipf:1.2' as the
1038 option. If a non\-uniform model is used, fio will disable use of the random
1039 map. For the \fBnormal\fR distribution, a normal (Gaussian) deviation is
1040 supplied as a value between 0 and 100.
1041 .P
1042 For a \fBzoned\fR distribution, fio supports specifying percentages of I/O
1043 access that should fall within what range of the file or device. For
1044 example, given a criteria of:
1045 .RS
1046 .P
1047 .PD 0
1048 60% of accesses should be to the first 10%
1049 .P
1050 30% of accesses should be to the next 20%
1051 .P
1052 8% of accesses should be to the next 30%
1053 .P
1054 2% of accesses should be to the next 40%
1055 .PD
1056 .RE
1057 .P
1058 we can define that through zoning of the random accesses. For the above
1059 example, the user would do:
1060 .RS
1061 .P
1062 random_distribution=zoned:60/10:30/20:8/30:2/40
1063 .RE
1064 .P
1065 similarly to how \fBbssplit\fR works for setting ranges and percentages
1066 of block sizes. Like \fBbssplit\fR, it's possible to specify separate
1067 zones for reads, writes, and trims. If just one set is given, it'll apply to
1068 all of them.
1069 .RE
1070 .TP
1071 .BI percentage_random \fR=\fPint[,int][,int]
1072 For a random workload, set how big a percentage should be random. This
1073 defaults to 100%, in which case the workload is fully random. It can be set
1074 from anywhere from 0 to 100. Setting it to 0 would make the workload fully
1075 sequential. Any setting in between will result in a random mix of sequential
1076 and random I/O, at the given percentages. Comma\-separated values may be
1077 specified for reads, writes, and trims as described in \fBblocksize\fR.
1078 .TP
1079 .BI norandommap
1080 Normally fio will cover every block of the file when doing random I/O. If
1081 this option is given, fio will just get a new random offset without looking
1082 at past I/O history. This means that some blocks may not be read or written,
1083 and that some blocks may be read/written more than once. If this option is
1084 used with \fBverify\fR and multiple blocksizes (via \fBbsrange\fR),
1085 only intact blocks are verified, i.e., partially\-overwritten blocks are
1086 ignored.
1087 .TP
1088 .BI softrandommap \fR=\fPbool
1089 See \fBnorandommap\fR. If fio runs with the random block map enabled and
1090 it fails to allocate the map, if this option is set it will continue without
1091 a random block map. As coverage will not be as complete as with random maps,
1092 this option is disabled by default.
1093 .TP
1094 .BI random_generator \fR=\fPstr
1095 Fio supports the following engines for generating I/O offsets for random I/O:
1096 .RS
1097 .RS
1098 .TP
1099 .B tausworthe
1100 Strong 2^88 cycle random number generator.
1101 .TP
1102 .B lfsr
1103 Linear feedback shift register generator.
1104 .TP
1105 .B tausworthe64
1106 Strong 64\-bit 2^258 cycle random number generator.
1107 .RE
1108 .P
1109 \fBtausworthe\fR is a strong random number generator, but it requires tracking
1110 on the side if we want to ensure that blocks are only read or written
1111 once. \fBlfsr\fR guarantees that we never generate the same offset twice, and
1112 it's also less computationally expensive. It's not a true random generator,
1113 however, though for I/O purposes it's typically good enough. \fBlfsr\fR only
1114 works with single block sizes, not with workloads that use multiple block
1115 sizes. If used with such a workload, fio may read or write some blocks
1116 multiple times. The default value is \fBtausworthe\fR, unless the required
1117 space exceeds 2^32 blocks. If it does, then \fBtausworthe64\fR is
1118 selected automatically.
1119 .RE
1120 .SS "Block size"
1121 .TP
1122 .BI blocksize \fR=\fPint[,int][,int] "\fR,\fB bs" \fR=\fPint[,int][,int]
1123 The block size in bytes used for I/O units. Default: 4096. A single value
1124 applies to reads, writes, and trims. Comma\-separated values may be
1125 specified for reads, writes, and trims. A value not terminated in a comma
1126 applies to subsequent types. Examples:
1127 .RS
1128 .RS
1129 .P
1130 .PD 0
1131 bs=256k        means 256k for reads, writes and trims.
1132 .P
1133 bs=8k,32k      means 8k for reads, 32k for writes and trims.
1134 .P
1135 bs=8k,32k,     means 8k for reads, 32k for writes, and default for trims.
1136 .P
1137 bs=,8k         means default for reads, 8k for writes and trims.
1138 .P
1139 bs=,8k,        means default for reads, 8k for writes, and default for trims.
1140 .PD
1141 .RE
1142 .RE
1143 .TP
1144 .BI blocksize_range \fR=\fPirange[,irange][,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange][,irange]
1145 A range of block sizes in bytes for I/O units. The issued I/O unit will
1146 always be a multiple of the minimum size, unless
1147 \fBblocksize_unaligned\fR is set.
1148 Comma\-separated ranges may be specified for reads, writes, and trims as
1149 described in \fBblocksize\fR. Example:
1150 .RS
1151 .RS
1152 .P
1153 bsrange=1k\-4k,2k\-8k
1154 .RE
1155 .RE
1156 .TP
1157 .BI bssplit \fR=\fPstr[,str][,str]
1158 Sometimes you want even finer grained control of the block sizes issued, not
1159 just an even split between them. This option allows you to weight various
1160 block sizes, so that you are able to define a specific amount of block sizes
1161 issued. The format for this option is:
1162 .RS
1163 .RS
1164 .P
1165 bssplit=blocksize/percentage:blocksize/percentage
1166 .RE
1167 .P
1168 for as many block sizes as needed. So if you want to define a workload that
1169 has 50% 64k blocks, 10% 4k blocks, and 40% 32k blocks, you would write:
1170 .RS
1171 .P
1172 bssplit=4k/10:64k/50:32k/40
1173 .RE
1174 .P
1175 Ordering does not matter. If the percentage is left blank, fio will fill in
1176 the remaining values evenly. So a bssplit option like this one:
1177 .RS
1178 .P
1179 bssplit=4k/50:1k/:32k/
1180 .RE
1181 .P
1182 would have 50% 4k ios, and 25% 1k and 32k ios. The percentages always add up
1183 to 100, if bssplit is given a range that adds up to more, it will error out.
1184 .P
1185 Comma\-separated values may be specified for reads, writes, and trims as
1186 described in \fBblocksize\fR.
1187 .P
1188 If you want a workload that has 50% 2k reads and 50% 4k reads, while having
1189 90% 4k writes and 10% 8k writes, you would specify:
1190 .RS
1191 .P
1192 bssplit=2k/50:4k/50,4k/90,8k/10
1193 .RE
1194 .RE
1195 .TP
1196 .BI blocksize_unaligned "\fR,\fB bs_unaligned"
1197 If set, fio will issue I/O units with any size within
1198 \fBblocksize_range\fR, not just multiples of the minimum size. This
1199 typically won't work with direct I/O, as that normally requires sector
1200 alignment.
1201 .TP
1202 .BI bs_is_seq_rand \fR=\fPbool
1203 If this option is set, fio will use the normal read,write blocksize settings
1204 as sequential,random blocksize settings instead. Any random read or write
1205 will use the WRITE blocksize settings, and any sequential read or write will
1206 use the READ blocksize settings.
1207 .TP
1208 .BI blockalign \fR=\fPint[,int][,int] "\fR,\fB ba" \fR=\fPint[,int][,int]
1209 Boundary to which fio will align random I/O units. Default:
1210 \fBblocksize\fR. Minimum alignment is typically 512b for using direct
1211 I/O, though it usually depends on the hardware block size. This option is
1212 mutually exclusive with using a random map for files, so it will turn off
1213 that option. Comma\-separated values may be specified for reads, writes, and
1214 trims as described in \fBblocksize\fR.
1215 .SS "Buffers and memory"
1216 .TP
1217 .BI zero_buffers
1218 Initialize buffers with all zeros. Default: fill buffers with random data.
1219 .TP
1220 .BI refill_buffers
1221 If this option is given, fio will refill the I/O buffers on every
1222 submit. The default is to only fill it at init time and reuse that
1223 data. Only makes sense if zero_buffers isn't specified, naturally. If data
1224 verification is enabled, \fBrefill_buffers\fR is also automatically enabled.
1225 .TP
1226 .BI scramble_buffers \fR=\fPbool
1227 If \fBrefill_buffers\fR is too costly and the target is using data
1228 deduplication, then setting this option will slightly modify the I/O buffer
1229 contents to defeat normal de\-dupe attempts. This is not enough to defeat
1230 more clever block compression attempts, but it will stop naive dedupe of
1231 blocks. Default: true.
1232 .TP
1233 .BI buffer_compress_percentage \fR=\fPint
1234 If this is set, then fio will attempt to provide I/O buffer content (on
1235 WRITEs) that compresses to the specified level. Fio does this by providing a
1236 mix of random data and a fixed pattern. The fixed pattern is either zeros,
1237 or the pattern specified by \fBbuffer_pattern\fR. If the pattern option
1238 is used, it might skew the compression ratio slightly. Note that this is per
1239 block size unit, for file/disk wide compression level that matches this
1240 setting, you'll also want to set \fBrefill_buffers\fR.
1241 .TP
1242 .BI buffer_compress_chunk \fR=\fPint
1243 See \fBbuffer_compress_percentage\fR. This setting allows fio to manage
1244 how big the ranges of random data and zeroed data is. Without this set, fio
1245 will provide \fBbuffer_compress_percentage\fR of blocksize random data,
1246 followed by the remaining zeroed. With this set to some chunk size smaller
1247 than the block size, fio can alternate random and zeroed data throughout the
1248 I/O buffer.
1249 .TP
1250 .BI buffer_pattern \fR=\fPstr
1251 If set, fio will fill the I/O buffers with this pattern or with the contents
1252 of a file. If not set, the contents of I/O buffers are defined by the other
1253 options related to buffer contents. The setting can be any pattern of bytes,
1254 and can be prefixed with 0x for hex values. It may also be a string, where
1255 the string must then be wrapped with "". Or it may also be a filename,
1256 where the filename must be wrapped with '' in which case the file is
1257 opened and read. Note that not all the file contents will be read if that
1258 would cause the buffers to overflow. So, for example:
1259 .RS
1260 .RS
1261 .P
1262 .PD 0
1263 buffer_pattern='filename'
1264 .P
1265 or:
1266 .P
1267 buffer_pattern="abcd"
1268 .P
1269 or:
1270 .P
1271 buffer_pattern=\-12
1272 .P
1273 or:
1274 .P
1275 buffer_pattern=0xdeadface
1276 .PD
1277 .RE
1278 .P
1279 Also you can combine everything together in any order:
1280 .RS
1281 .P
1282 buffer_pattern=0xdeadface"abcd"\-12'filename'
1283 .RE
1284 .RE
1285 .TP
1286 .BI dedupe_percentage \fR=\fPint
1287 If set, fio will generate this percentage of identical buffers when
1288 writing. These buffers will be naturally dedupable. The contents of the
1289 buffers depend on what other buffer compression settings have been set. It's
1290 possible to have the individual buffers either fully compressible, or not at
1291 all. This option only controls the distribution of unique buffers.
1292 .TP
1293 .BI invalidate \fR=\fPbool
1294 Invalidate the buffer/page cache parts of the files to be used prior to
1295 starting I/O if the platform and file type support it. Defaults to true.
1296 This will be ignored if \fBpre_read\fR is also specified for the
1297 same job.
1298 .TP
1299 .BI sync \fR=\fPbool
1300 Use synchronous I/O for buffered writes. For the majority of I/O engines,
1301 this means using O_SYNC. Default: false.
1302 .TP
1303 .BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
1304 Fio can use various types of memory as the I/O unit buffer. The allowed
1305 values are:
1306 .RS
1307 .RS
1308 .TP
1309 .B malloc
1310 Use memory from \fBmalloc\fR\|(3) as the buffers. Default memory type.
1311 .TP
1312 .B shm
1313 Use shared memory as the buffers. Allocated through \fBshmget\fR\|(2).
1314 .TP
1315 .B shmhuge
1316 Same as \fBshm\fR, but use huge pages as backing.
1317 .TP
1318 .B mmap
1319 Use \fBmmap\fR\|(2) to allocate buffers. May either be anonymous memory, or can
1320 be file backed if a filename is given after the option. The format
1321 is `mem=mmap:/path/to/file'.
1322 .TP
1323 .B mmaphuge
1324 Use a memory mapped huge file as the buffer backing. Append filename
1325 after mmaphuge, ala `mem=mmaphuge:/hugetlbfs/file'.
1326 .TP
1327 .B mmapshared
1328 Same as \fBmmap\fR, but use a MMAP_SHARED mapping.
1329 .TP
1330 .B cudamalloc
1331 Use GPU memory as the buffers for GPUDirect RDMA benchmark.
1332 The \fBioengine\fR must be \fBrdma\fR.
1333 .RE
1334 .P
1335 The area allocated is a function of the maximum allowed bs size for the job,
1336 multiplied by the I/O depth given. Note that for \fBshmhuge\fR and
1337 \fBmmaphuge\fR to work, the system must have free huge pages allocated. This
1338 can normally be checked and set by reading/writing
1339 `/proc/sys/vm/nr_hugepages' on a Linux system. Fio assumes a huge page
1340 is 4MiB in size. So to calculate the number of huge pages you need for a
1341 given job file, add up the I/O depth of all jobs (normally one unless
1342 \fBiodepth\fR is used) and multiply by the maximum bs set. Then divide
1343 that number by the huge page size. You can see the size of the huge pages in
1344 `/proc/meminfo'. If no huge pages are allocated by having a non\-zero
1345 number in `nr_hugepages', using \fBmmaphuge\fR or \fBshmhuge\fR will fail. Also
1346 see \fBhugepage\-size\fR.
1347 .P
1348 \fBmmaphuge\fR also needs to have hugetlbfs mounted and the file location
1349 should point there. So if it's mounted in `/huge', you would use
1350 `mem=mmaphuge:/huge/somefile'.
1351 .RE
1352 .TP
1353 .BI iomem_align \fR=\fPint "\fR,\fP mem_align" \fR=\fPint
1354 This indicates the memory alignment of the I/O memory buffers. Note that
1355 the given alignment is applied to the first I/O unit buffer, if using
1356 \fBiodepth\fR the alignment of the following buffers are given by the
1357 \fBbs\fR used. In other words, if using a \fBbs\fR that is a
1358 multiple of the page sized in the system, all buffers will be aligned to
1359 this value. If using a \fBbs\fR that is not page aligned, the alignment
1360 of subsequent I/O memory buffers is the sum of the \fBiomem_align\fR and
1361 \fBbs\fR used.
1362 .TP
1363 .BI hugepage\-size \fR=\fPint
1364 Defines the size of a huge page. Must at least be equal to the system
1365 setting, see `/proc/meminfo'. Defaults to 4MiB. Should probably
1366 always be a multiple of megabytes, so using `hugepage\-size=Xm' is the
1367 preferred way to set this to avoid setting a non\-pow\-2 bad value.
1368 .TP
1369 .BI lockmem \fR=\fPint
1370 Pin the specified amount of memory with \fBmlock\fR\|(2). Can be used to
1371 simulate a smaller amount of memory. The amount specified is per worker.
1372 .SS "I/O size"
1373 .TP
1374 .BI size \fR=\fPint
1375 The total size of file I/O for each thread of this job. Fio will run until
1376 this many bytes has been transferred, unless runtime is limited by other options
1377 (such as \fBruntime\fR, for instance, or increased/decreased by \fBio_size\fR).
1378 Fio will divide this size between the available files determined by options
1379 such as \fBnrfiles\fR, \fBfilename\fR, unless \fBfilesize\fR is
1380 specified by the job. If the result of division happens to be 0, the size is
1381 set to the physical size of the given files or devices if they exist.
1382 If this option is not specified, fio will use the full size of the given
1383 files or devices. If the files do not exist, size must be given. It is also
1384 possible to give size as a percentage between 1 and 100. If `size=20%' is
1385 given, fio will use 20% of the full size of the given files or devices.
1386 Can be combined with \fBoffset\fR to constrain the start and end range
1387 that I/O will be done within.
1388 .TP
1389 .BI io_size \fR=\fPint "\fR,\fB io_limit" \fR=\fPint
1390 Normally fio operates within the region set by \fBsize\fR, which means
1391 that the \fBsize\fR option sets both the region and size of I/O to be
1392 performed. Sometimes that is not what you want. With this option, it is
1393 possible to define just the amount of I/O that fio should do. For instance,
1394 if \fBsize\fR is set to 20GiB and \fBio_size\fR is set to 5GiB, fio
1395 will perform I/O within the first 20GiB but exit when 5GiB have been
1396 done. The opposite is also possible \-\- if \fBsize\fR is set to 20GiB,
1397 and \fBio_size\fR is set to 40GiB, then fio will do 40GiB of I/O within
1398 the 0..20GiB region.
1399 .TP
1400 .BI filesize \fR=\fPirange(int)
1401 Individual file sizes. May be a range, in which case fio will select sizes
1402 for files at random within the given range and limited to \fBsize\fR in
1403 total (if that is given). If not given, each created file is the same size.
1404 This option overrides \fBsize\fR in terms of file size, which means
1405 this value is used as a fixed size or possible range of each file.
1406 .TP
1407 .BI file_append \fR=\fPbool
1408 Perform I/O after the end of the file. Normally fio will operate within the
1409 size of a file. If this option is set, then fio will append to the file
1410 instead. This has identical behavior to setting \fBoffset\fR to the size
1411 of a file. This option is ignored on non\-regular files.
1412 .TP
1413 .BI fill_device \fR=\fPbool "\fR,\fB fill_fs" \fR=\fPbool
1414 Sets size to something really large and waits for ENOSPC (no space left on
1415 device) as the terminating condition. Only makes sense with sequential
1416 write. For a read workload, the mount point will be filled first then I/O
1417 started on the result. This option doesn't make sense if operating on a raw
1418 device node, since the size of that is already known by the file system.
1419 Additionally, writing beyond end\-of\-device will not return ENOSPC there.
1420 .SS "I/O engine"
1421 .TP
1422 .BI ioengine \fR=\fPstr
1423 Defines how the job issues I/O to the file. The following types are defined:
1424 .RS
1425 .RS
1426 .TP
1427 .B sync
1428 Basic \fBread\fR\|(2) or \fBwrite\fR\|(2)
1429 I/O. \fBlseek\fR\|(2) is used to position the I/O location.
1430 See \fBfsync\fR and \fBfdatasync\fR for syncing write I/Os.
1431 .TP
1432 .B psync
1433 Basic \fBpread\fR\|(2) or \fBpwrite\fR\|(2) I/O. Default on
1434 all supported operating systems except for Windows.
1435 .TP
1436 .B vsync
1437 Basic \fBreadv\fR\|(2) or \fBwritev\fR\|(2) I/O. Will emulate
1438 queuing by coalescing adjacent I/Os into a single submission.
1439 .TP
1440 .B pvsync
1441 Basic \fBpreadv\fR\|(2) or \fBpwritev\fR\|(2) I/O.
1442 .TP
1443 .B pvsync2
1444 Basic \fBpreadv2\fR\|(2) or \fBpwritev2\fR\|(2) I/O.
1445 .TP
1446 .B libaio
1447 Linux native asynchronous I/O. Note that Linux may only support
1448 queued behavior with non\-buffered I/O (set `direct=1' or
1449 `buffered=0').
1450 This engine defines engine specific options.
1451 .TP
1452 .B posixaio
1453 POSIX asynchronous I/O using \fBaio_read\fR\|(3) and
1454 \fBaio_write\fR\|(3).
1455 .TP
1456 .B solarisaio
1457 Solaris native asynchronous I/O.
1458 .TP
1459 .B windowsaio
1460 Windows native asynchronous I/O. Default on Windows.
1461 .TP
1462 .B mmap
1463 File is memory mapped with \fBmmap\fR\|(2) and data copied
1464 to/from using \fBmemcpy\fR\|(3).
1465 .TP
1466 .B splice
1467 \fBsplice\fR\|(2) is used to transfer the data and
1468 \fBvmsplice\fR\|(2) to transfer data from user space to the
1469 kernel.
1470 .TP
1471 .B sg
1472 SCSI generic sg v3 I/O. May either be synchronous using the SG_IO
1473 ioctl, or if the target is an sg character device we use
1474 \fBread\fR\|(2) and \fBwrite\fR\|(2) for asynchronous
1475 I/O. Requires \fBfilename\fR option to specify either block or
1476 character devices.
1477 .TP
1478 .B null
1479 Doesn't transfer any data, just pretends to. This is mainly used to
1480 exercise fio itself and for debugging/testing purposes.
1481 .TP
1482 .B net
1483 Transfer over the network to given `host:port'. Depending on the
1484 \fBprotocol\fR used, the \fBhostname\fR, \fBport\fR,
1485 \fBlisten\fR and \fBfilename\fR options are used to specify
1486 what sort of connection to make, while the \fBprotocol\fR option
1487 determines which protocol will be used. This engine defines engine
1488 specific options.
1489 .TP
1490 .B netsplice
1491 Like \fBnet\fR, but uses \fBsplice\fR\|(2) and
1492 \fBvmsplice\fR\|(2) to map data and send/receive.
1493 This engine defines engine specific options.
1494 .TP
1495 .B cpuio
1496 Doesn't transfer any data, but burns CPU cycles according to the
1497 \fBcpuload\fR and \fBcpuchunks\fR options. Setting
1498 \fBcpuload\fR\=85 will cause that job to do nothing but burn 85%
1499 of the CPU. In case of SMP machines, use `numjobs=<nr_of_cpu>'
1500 to get desired CPU usage, as the cpuload only loads a
1501 single CPU at the desired rate. A job never finishes unless there is
1502 at least one non\-cpuio job.
1503 .TP
1504 .B guasi
1505 The GUASI I/O engine is the Generic Userspace Asyncronous Syscall
1506 Interface approach to async I/O. See \fI\-lib.html\fR
1507 for more info on GUASI.
1508 .TP
1509 .B rdma
1510 The RDMA I/O engine supports both RDMA memory semantics
1511 (RDMA_WRITE/RDMA_READ) and channel semantics (Send/Recv) for the
1512 InfiniBand, RoCE and iWARP protocols.
1513 .TP
1514 .B falloc
1515 I/O engine that does regular fallocate to simulate data transfer as
1516 fio ioengine.
1517 .RS
1518 .P
1519 .PD 0
1520 DDIR_READ      does fallocate(,mode = FALLOC_FL_KEEP_SIZE,).
1521 .P
1522 DIR_WRITE      does fallocate(,mode = 0).
1523 .P
1524 DDIR_TRIM      does fallocate(,mode = FALLOC_FL_KEEP_SIZE|FALLOC_FL_PUNCH_HOLE).
1525 .PD
1526 .RE
1527 .TP
1528 .B ftruncate
1529 I/O engine that sends \fBftruncate\fR\|(2) operations in response
1530 to write (DDIR_WRITE) events. Each ftruncate issued sets the file's
1531 size to the current block offset. \fBblocksize\fR is ignored.
1532 .TP
1533 .B e4defrag
1534 I/O engine that does regular EXT4_IOC_MOVE_EXT ioctls to simulate
1535 defragment activity in request to DDIR_WRITE event.
1536 .TP
1537 .B rbd
1538 I/O engine supporting direct access to Ceph Rados Block Devices
1539 (RBD) via librbd without the need to use the kernel rbd driver. This
1540 ioengine defines engine specific options.
1541 .TP
1542 .B gfapi
1543 Using GlusterFS libgfapi sync interface to direct access to
1544 GlusterFS volumes without having to go through FUSE. This ioengine
1545 defines engine specific options.
1546 .TP
1547 .B gfapi_async
1548 Using GlusterFS libgfapi async interface to direct access to
1549 GlusterFS volumes without having to go through FUSE. This ioengine
1550 defines engine specific options.
1551 .TP
1552 .B libhdfs
1553 Read and write through Hadoop (HDFS). The \fBfilename\fR option
1554 is used to specify host,port of the hdfs name\-node to connect. This
1555 engine interprets offsets a little differently. In HDFS, files once
1556 created cannot be modified so random writes are not possible. To
1557 imitate this the libhdfs engine expects a bunch of small files to be
1558 created over HDFS and will randomly pick a file from them
1559 based on the offset generated by fio backend (see the example
1560 job file to create such files, use `rw=write' option). Please
1561 note, it may be necessary to set environment variables to work
1562 with HDFS/libhdfs properly. Each job uses its own connection to
1563 HDFS.
1564 .TP
1565 .B mtd
1566 Read, write and erase an MTD character device (e.g.,
1567 `/dev/mtd0'). Discards are treated as erases. Depending on the
1568 underlying device type, the I/O may have to go in a certain pattern,
1569 e.g., on NAND, writing sequentially to erase blocks and discarding
1570 before overwriting. The \fBtrimwrite\fR mode works well for this
1571 constraint.
1572 .TP
1573 .B pmemblk
1574 Read and write using filesystem DAX to a file on a filesystem
1575 mounted with DAX on a persistent memory device through the NVML
1576 libpmemblk library.
1577 .TP
1578 .B dev\-dax
1579 Read and write using device DAX to a persistent memory device (e.g.,
1580 /dev/dax0.0) through the NVML libpmem library.
1581 .TP
1582 .B external
1583 Prefix to specify loading an external I/O engine object file. Append
1584 the engine filename, e.g. `ioengine=external:/tmp/foo.o' to load
1585 ioengine `foo.o' in `/tmp'. The path can be either
1586 absolute or relative. See `engines/skeleton_external.c' in the fio source for
1587 details of writing an external I/O engine.
1588 .TP
1589 .B filecreate
1590 Create empty files only.  \fBfilesize\fR still needs to be specified so that fio
1591 will run and grab latency results, but no IO will actually be done on the files.
1592 .SS "I/O engine specific parameters"
1593 In addition, there are some parameters which are only valid when a specific
1594 \fBioengine\fR is in use. These are used identically to normal parameters,
1595 with the caveat that when used on the command line, they must come after the
1596 \fBioengine\fR that defines them is selected.
1597 .TP
1598 .BI (libaio)userspace_reap
1599 Normally, with the libaio engine in use, fio will use the
1600 \fBio_getevents\fR\|(3) system call to reap newly returned events. With
1601 this flag turned on, the AIO ring will be read directly from user\-space to
1602 reap events. The reaping mode is only enabled when polling for a minimum of
1603 0 events (e.g. when `iodepth_batch_complete=0').
1604 .TP
1605 .BI (pvsync2)hipri
1606 Set RWF_HIPRI on I/O, indicating to the kernel that it's of higher priority
1607 than normal.
1608 .TP
1609 .BI (pvsync2)hipri_percentage
1610 When hipri is set this determines the probability of a pvsync2 I/O being high
1611 priority. The default is 100%.
1612 .TP
1613 .BI (cpuio)cpuload \fR=\fPint
1614 Attempt to use the specified percentage of CPU cycles. This is a mandatory
1615 option when using cpuio I/O engine.
1616 .TP
1617 .BI (cpuio)cpuchunks \fR=\fPint
1618 Split the load into cycles of the given time. In microseconds.
1619 .TP
1620 .BI (cpuio)exit_on_io_done \fR=\fPbool
1621 Detect when I/O threads are done, then exit.
1622 .TP
1623 .BI (libhdfs)namenode \fR=\fPstr
1624 The hostname or IP address of a HDFS cluster namenode to contact.
1625 .TP
1626 .BI (libhdfs)port
1627 The listening port of the HFDS cluster namenode.
1628 .TP
1629 .BI (netsplice,net)port
1630 The TCP or UDP port to bind to or connect to. If this is used with
1631 \fBnumjobs\fR to spawn multiple instances of the same job type, then
1632 this will be the starting port number since fio will use a range of
1633 ports.
1634 .TP
1635 .BI (netsplice,net)hostname \fR=\fPstr
1636 The hostname or IP address to use for TCP or UDP based I/O. If the job is
1637 a TCP listener or UDP reader, the hostname is not used and must be omitted
1638 unless it is a valid UDP multicast address.
1639 .TP
1640 .BI (netsplice,net)interface \fR=\fPstr
1641 The IP address of the network interface used to send or receive UDP
1642 multicast.
1643 .TP
1644 .BI (netsplice,net)ttl \fR=\fPint
1645 Time\-to\-live value for outgoing UDP multicast packets. Default: 1.
1646 .TP
1647 .BI (netsplice,net)nodelay \fR=\fPbool
1648 Set TCP_NODELAY on TCP connections.
1649 .TP
1650 .BI (netsplice,net)protocol \fR=\fPstr "\fR,\fP proto" \fR=\fPstr
1651 The network protocol to use. Accepted values are:
1652 .RS
1653 .RS
1654 .TP
1655 .B tcp
1656 Transmission control protocol.
1657 .TP
1658 .B tcpv6
1659 Transmission control protocol V6.
1660 .TP
1661 .B udp
1662 User datagram protocol.
1663 .TP
1664 .B udpv6
1665 User datagram protocol V6.
1666 .TP
1667 .B unix
1668 UNIX domain socket.
1669 .RE
1670 .P
1671 When the protocol is TCP or UDP, the port must also be given, as well as the
1672 hostname if the job is a TCP listener or UDP reader. For unix sockets, the
1673 normal \fBfilename\fR option should be used and the port is invalid.
1674 .RE
1675 .TP
1676 .BI (netsplice,net)listen
1677 For TCP network connections, tell fio to listen for incoming connections
1678 rather than initiating an outgoing connection. The \fBhostname\fR must
1679 be omitted if this option is used.
1680 .TP
1681 .BI (netsplice,net)pingpong
1682 Normally a network writer will just continue writing data, and a network
1683 reader will just consume packages. If `pingpong=1' is set, a writer will
1684 send its normal payload to the reader, then wait for the reader to send the
1685 same payload back. This allows fio to measure network latencies. The
1686 submission and completion latencies then measure local time spent sending or
1687 receiving, and the completion latency measures how long it took for the
1688 other end to receive and send back. For UDP multicast traffic
1689 `pingpong=1' should only be set for a single reader when multiple readers
1690 are listening to the same address.
1691 .TP
1692 .BI (netsplice,net)window_size \fR=\fPint
1693 Set the desired socket buffer size for the connection.
1694 .TP
1695 .BI (netsplice,net)mss \fR=\fPint
1696 Set the TCP maximum segment size (TCP_MAXSEG).
1697 .TP
1698 .BI (e4defrag)donorname \fR=\fPstr
1699 File will be used as a block donor (swap extents between files).
1700 .TP
1701 .BI (e4defrag)inplace \fR=\fPint
1702 Configure donor file blocks allocation strategy:
1703 .RS
1704 .RS
1705 .TP
1706 .B 0
1707 Default. Preallocate donor's file on init.
1708 .TP
1709 .B 1
1710 Allocate space immediately inside defragment event, and free right
1711 after event.
1712 .RE
1713 .RE
1714 .TP
1715 .BI (rbd)clustername \fR=\fPstr
1716 Specifies the name of the Ceph cluster.
1717 .TP
1718 .BI (rbd)rbdname \fR=\fPstr
1719 Specifies the name of the RBD.
1720 .TP
1721 .BI (rbd)pool \fR=\fPstr
1722 Specifies the name of the Ceph pool containing RBD.
1723 .TP
1724 .BI (rbd)clientname \fR=\fPstr
1725 Specifies the username (without the 'client.' prefix) used to access the
1726 Ceph cluster. If the \fBclustername\fR is specified, the \fBclientname\fR shall be
1727 the full ** string. If no type. prefix is given, fio will add 'client.'
1728 by default.
1729 .TP
1730 .BI (mtd)skip_bad \fR=\fPbool
1731 Skip operations against known bad blocks.
1732 .TP
1733 .BI (libhdfs)hdfsdirectory
1734 libhdfs will create chunk in this HDFS directory.
1735 .TP
1736 .BI (libhdfs)chunk_size
1737 The size of the chunk to use for each file.
1738 .SS "I/O depth"
1739 .TP
1740 .BI iodepth \fR=\fPint
1741 Number of I/O units to keep in flight against the file. Note that
1742 increasing \fBiodepth\fR beyond 1 will not affect synchronous ioengines (except
1743 for small degrees when \fBverify_async\fR is in use). Even async
1744 engines may impose OS restrictions causing the desired depth not to be
1745 achieved. This may happen on Linux when using libaio and not setting
1746 `direct=1', since buffered I/O is not async on that OS. Keep an
1747 eye on the I/O depth distribution in the fio output to verify that the
1748 achieved depth is as expected. Default: 1.
1749 .TP
1750 .BI iodepth_batch_submit \fR=\fPint "\fR,\fP iodepth_batch" \fR=\fPint
1751 This defines how many pieces of I/O to submit at once. It defaults to 1
1752 which means that we submit each I/O as soon as it is available, but can be
1753 raised to submit bigger batches of I/O at the time. If it is set to 0 the
1754 \fBiodepth\fR value will be used.
1755 .TP
1756 .BI iodepth_batch_complete_min \fR=\fPint "\fR,\fP iodepth_batch_complete" \fR=\fPint
1757 This defines how many pieces of I/O to retrieve at once. It defaults to 1
1758 which means that we'll ask for a minimum of 1 I/O in the retrieval process
1759 from the kernel. The I/O retrieval will go on until we hit the limit set by
1760 \fBiodepth_low\fR. If this variable is set to 0, then fio will always
1761 check for completed events before queuing more I/O. This helps reduce I/O
1762 latency, at the cost of more retrieval system calls.
1763 .TP
1764 .BI iodepth_batch_complete_max \fR=\fPint
1765 This defines maximum pieces of I/O to retrieve at once. This variable should
1766 be used along with \fBiodepth_batch_complete_min\fR=\fIint\fR variable,
1767 specifying the range of min and max amount of I/O which should be
1768 retrieved. By default it is equal to \fBiodepth_batch_complete_min\fR
1769 value. Example #1:
1770 .RS
1771 .RS
1772 .P
1773 .PD 0
1774 iodepth_batch_complete_min=1
1775 .P
1776 iodepth_batch_complete_max=<iodepth>
1777 .PD
1778 .RE
1779 .P
1780 which means that we will retrieve at least 1 I/O and up to the whole
1781 submitted queue depth. If none of I/O has been completed yet, we will wait.
1782 Example #2:
1783 .RS
1784 .P
1785 .PD 0
1786 iodepth_batch_complete_min=0
1787 .P
1788 iodepth_batch_complete_max=<iodepth>
1789 .PD
1790 .RE
1791 .P
1792 which means that we can retrieve up to the whole submitted queue depth, but
1793 if none of I/O has been completed yet, we will NOT wait and immediately exit
1794 the system call. In this example we simply do polling.
1795 .RE
1796 .TP
1797 .BI iodepth_low \fR=\fPint
1798 The low water mark indicating when to start filling the queue
1799 again. Defaults to the same as \fBiodepth\fR, meaning that fio will
1800 attempt to keep the queue full at all times. If \fBiodepth\fR is set to
1801 e.g. 16 and \fBiodepth_low\fR is set to 4, then after fio has filled the queue of
1802 16 requests, it will let the depth drain down to 4 before starting to fill
1803 it again.
1804 .TP
1805 .BI serialize_overlap \fR=\fPbool
1806 Serialize in-flight I/Os that might otherwise cause or suffer from data races.
1807 When two or more I/Os are submitted simultaneously, there is no guarantee that
1808 the I/Os will be processed or completed in the submitted order. Further, if
1809 two or more of those I/Os are writes, any overlapping region between them can
1810 become indeterminate/undefined on certain storage. These issues can cause
1811 verification to fail erratically when at least one of the racing I/Os is
1812 changing data and the overlapping region has a non-zero size. Setting
1813 \fBserialize_overlap\fR tells fio to avoid provoking this behavior by explicitly
1814 serializing in-flight I/Os that have a non-zero overlap. Note that setting
1815 this option can reduce both performance and the \fBiodepth\fR achieved.
1816 Additionally this option does not work when \fBio_submit_mode\fR is set to
1817 offload. Default: false.
1818 .TP
1819 .BI io_submit_mode \fR=\fPstr
1820 This option controls how fio submits the I/O to the I/O engine. The default
1821 is `inline', which means that the fio job threads submit and reap I/O
1822 directly. If set to `offload', the job threads will offload I/O submission
1823 to a dedicated pool of I/O threads. This requires some coordination and thus
1824 has a bit of extra overhead, especially for lower queue depth I/O where it
1825 can increase latencies. The benefit is that fio can manage submission rates
1826 independently of the device completion rates. This avoids skewed latency
1827 reporting if I/O gets backed up on the device side (the coordinated omission
1828 problem).
1829 .SS "I/O rate"
1830 .TP
1831 .BI thinktime \fR=\fPtime
1832 Stall the job for the specified period of time after an I/O has completed before issuing the
1833 next. May be used to simulate processing being done by an application.
1834 When the unit is omitted, the value is interpreted in microseconds. See
1835 \fBthinktime_blocks\fR and \fBthinktime_spin\fR.
1836 .TP
1837 .BI thinktime_spin \fR=\fPtime
1838 Only valid if \fBthinktime\fR is set \- pretend to spend CPU time doing
1839 something with the data received, before falling back to sleeping for the
1840 rest of the period specified by \fBthinktime\fR. When the unit is
1841 omitted, the value is interpreted in microseconds.
1842 .TP
1843 .BI thinktime_blocks \fR=\fPint
1844 Only valid if \fBthinktime\fR is set \- control how many blocks to issue,
1845 before waiting \fBthinktime\fR usecs. If not set, defaults to 1 which will make
1846 fio wait \fBthinktime\fR usecs after every block. This effectively makes any
1847 queue depth setting redundant, since no more than 1 I/O will be queued
1848 before we have to complete it and do our \fBthinktime\fR. In other words, this
1849 setting effectively caps the queue depth if the latter is larger.
1850 .TP
1851 .BI rate \fR=\fPint[,int][,int]
1852 Cap the bandwidth used by this job. The number is in bytes/sec, the normal
1853 suffix rules apply. Comma\-separated values may be specified for reads,
1854 writes, and trims as described in \fBblocksize\fR.
1855 .RS
1856 .P
1857 For example, using `rate=1m,500k' would limit reads to 1MiB/sec and writes to
1858 500KiB/sec. Capping only reads or writes can be done with `rate=,500k' or
1859 `rate=500k,' where the former will only limit writes (to 500KiB/sec) and the
1860 latter will only limit reads.
1861 .RE
1862 .TP
1863 .BI rate_min \fR=\fPint[,int][,int]
1864 Tell fio to do whatever it can to maintain at least this bandwidth. Failing
1865 to meet this requirement will cause the job to exit. Comma\-separated values
1866 may be specified for reads, writes, and trims as described in
1867 \fBblocksize\fR.
1868 .TP
1869 .BI rate_iops \fR=\fPint[,int][,int]
1870 Cap the bandwidth to this number of IOPS. Basically the same as
1871 \fBrate\fR, just specified independently of bandwidth. If the job is
1872 given a block size range instead of a fixed value, the smallest block size
1873 is used as the metric. Comma\-separated values may be specified for reads,
1874 writes, and trims as described in \fBblocksize\fR.
1875 .TP
1876 .BI rate_iops_min \fR=\fPint[,int][,int]
1877 If fio doesn't meet this rate of I/O, it will cause the job to exit.
1878 Comma\-separated values may be specified for reads, writes, and trims as
1879 described in \fBblocksize\fR.
1880 .TP
1881 .BI rate_process \fR=\fPstr
1882 This option controls how fio manages rated I/O submissions. The default is
1883 `linear', which submits I/O in a linear fashion with fixed delays between
1884 I/Os that gets adjusted based on I/O completion rates. If this is set to
1885 `poisson', fio will submit I/O based on a more real world random request
1886 flow, known as the Poisson process
1887 (\fI\fR). The lambda will be
1888 10^6 / IOPS for the given workload.
1889 .SS "I/O latency"
1890 .TP
1891 .BI latency_target \fR=\fPtime
1892 If set, fio will attempt to find the max performance point that the given
1893 workload will run at while maintaining a latency below this target. When
1894 the unit is omitted, the value is interpreted in microseconds. See
1895 \fBlatency_window\fR and \fBlatency_percentile\fR.
1896 .TP
1897 .BI latency_window \fR=\fPtime
1898 Used with \fBlatency_target\fR to specify the sample window that the job
1899 is run at varying queue depths to test the performance. When the unit is
1900 omitted, the value is interpreted in microseconds.
1901 .TP
1902 .BI latency_percentile \fR=\fPfloat
1903 The percentage of I/Os that must fall within the criteria specified by
1904 \fBlatency_target\fR and \fBlatency_window\fR. If not set, this
1905 defaults to 100.0, meaning that all I/Os must be equal or below to the value
1906 set by \fBlatency_target\fR.
1907 .TP
1908 .BI max_latency \fR=\fPtime
1909 If set, fio will exit the job with an ETIMEDOUT error if it exceeds this
1910 maximum latency. When the unit is omitted, the value is interpreted in
1911 microseconds.
1912 .TP
1913 .BI rate_cycle \fR=\fPint
1914 Average bandwidth for \fBrate\fR and \fBrate_min\fR over this number
1915 of milliseconds. Defaults to 1000.
1916 .SS "I/O replay"
1917 .TP
1918 .BI write_iolog \fR=\fPstr
1919 Write the issued I/O patterns to the specified file. See
1920 \fBread_iolog\fR. Specify a separate file for each job, otherwise the
1921 iologs will be interspersed and the file may be corrupt.
1922 .TP
1923 .BI read_iolog \fR=\fPstr
1924 Open an iolog with the specified filename and replay the I/O patterns it
1925 contains. This can be used to store a workload and replay it sometime
1926 later. The iolog given may also be a blktrace binary file, which allows fio
1927 to replay a workload captured by blktrace. See
1928 \fBblktrace\fR\|(8) for how to capture such logging data. For blktrace
1929 replay, the file needs to be turned into a blkparse binary data file first
1930 (`blkparse <device> \-o /dev/null \-d file_for_fio.bin').
1931 .TP
1932 .BI replay_no_stall \fR=\fPbool
1933 When replaying I/O with \fBread_iolog\fR the default behavior is to
1934 attempt to respect the timestamps within the log and replay them with the
1935 appropriate delay between IOPS. By setting this variable fio will not
1936 respect the timestamps and attempt to replay them as fast as possible while
1937 still respecting ordering. The result is the same I/O pattern to a given
1938 device, but different timings.
1939 .TP
1940 .BI replay_redirect \fR=\fPstr
1941 While replaying I/O patterns using \fBread_iolog\fR the default behavior
1942 is to replay the IOPS onto the major/minor device that each IOP was recorded
1943 from. This is sometimes undesirable because on a different machine those
1944 major/minor numbers can map to a different device. Changing hardware on the
1945 same system can also result in a different major/minor mapping.
1946 \fBreplay_redirect\fR causes all I/Os to be replayed onto the single specified
1947 device regardless of the device it was recorded
1948 from. i.e. `replay_redirect=/dev/sdc' would cause all I/O
1949 in the blktrace or iolog to be replayed onto `/dev/sdc'. This means
1950 multiple devices will be replayed onto a single device, if the trace
1951 contains multiple devices. If you want multiple devices to be replayed
1952 concurrently to multiple redirected devices you must blkparse your trace
1953 into separate traces and replay them with independent fio invocations.
1954 Unfortunately this also breaks the strict time ordering between multiple
1955 device accesses.
1956 .TP
1957 .BI replay_align \fR=\fPint
1958 Force alignment of I/O offsets and lengths in a trace to this power of 2
1959 value.
1960 .TP
1961 .BI replay_scale \fR=\fPint
1962 Scale sector offsets down by this factor when replaying traces.
1963 .SS "Threads, processes and job synchronization"
1964 .TP
1965 .BI thread
1966 Fio defaults to creating jobs by using fork, however if this option is
1967 given, fio will create jobs by using POSIX Threads' function
1968 \fBpthread_create\fR\|(3) to create threads instead.
1969 .TP
1970 .BI wait_for \fR=\fPstr
1971 If set, the current job won't be started until all workers of the specified
1972 waitee job are done.
1973 .\" ignore blank line here from HOWTO as it looks normal without it
1974 \fBwait_for\fR operates on the job name basis, so there are a few
1975 limitations. First, the waitee must be defined prior to the waiter job
1976 (meaning no forward references). Second, if a job is being referenced as a
1977 waitee, it must have a unique name (no duplicate waitees).
1978 .TP
1979 .BI nice \fR=\fPint
1980 Run the job with the given nice value. See man \fBnice\fR\|(2).
1981 .\" ignore blank line here from HOWTO as it looks normal without it
1982 On Windows, values less than \-15 set the process class to "High"; \-1 through
1983 \-15 set "Above Normal"; 1 through 15 "Below Normal"; and above 15 "Idle"
1984 priority class.
1985 .TP
1986 .BI prio \fR=\fPint
1987 Set the I/O priority value of this job. Linux limits us to a positive value
1988 between 0 and 7, with 0 being the highest. See man
1989 \fBionice\fR\|(1). Refer to an appropriate manpage for other operating
1990 systems since meaning of priority may differ.
1991 .TP
1992 .BI prioclass \fR=\fPint
1993 Set the I/O priority class. See man \fBionice\fR\|(1).
1994 .TP
1995 .BI cpumask \fR=\fPint
1996 Set the CPU affinity of this job. The parameter given is a bit mask of
1997 allowed CPUs the job may run on. So if you want the allowed CPUs to be 1
1998 and 5, you would pass the decimal value of (1 << 1 | 1 << 5), or 34. See man
1999 \fBsched_setaffinity\fR\|(2). This may not work on all supported
2000 operating systems or kernel versions. This option doesn't work well for a
2001 higher CPU count than what you can store in an integer mask, so it can only
2002 control cpus 1\-32. For boxes with larger CPU counts, use
2003 \fBcpus_allowed\fR.
2004 .TP
2005 .BI cpus_allowed \fR=\fPstr
2006 Controls the same options as \fBcpumask\fR, but accepts a textual
2007 specification of the permitted CPUs instead. So to use CPUs 1 and 5 you
2008 would specify `cpus_allowed=1,5'. This option also allows a range of CPUs
2009 to be specified \-\- say you wanted a binding to CPUs 1, 5, and 8 to 15, you
2010 would set `cpus_allowed=1,5,8\-15'.
2011 .TP
2012 .BI cpus_allowed_policy \fR=\fPstr
2013 Set the policy of how fio distributes the CPUs specified by
2014 \fBcpus_allowed\fR or \fBcpumask\fR. Two policies are supported:
2015 .RS
2016 .RS
2017 .TP
2018 .B shared
2019 All jobs will share the CPU set specified.
2020 .TP
2021 .B split
2022 Each job will get a unique CPU from the CPU set.
2023 .RE
2024 .P
2025 \fBshared\fR is the default behavior, if the option isn't specified. If
2026 \fBsplit\fR is specified, then fio will will assign one cpu per job. If not
2027 enough CPUs are given for the jobs listed, then fio will roundrobin the CPUs
2028 in the set.
2029 .RE
2030 .TP
2031 .BI numa_cpu_nodes \fR=\fPstr
2032 Set this job running on specified NUMA nodes' CPUs. The arguments allow
2033 comma delimited list of cpu numbers, A\-B ranges, or `all'. Note, to enable
2034 NUMA options support, fio must be built on a system with libnuma\-dev(el)
2035 installed.
2036 .TP
2037 .BI numa_mem_policy \fR=\fPstr
2038 Set this job's memory policy and corresponding NUMA nodes. Format of the
2039 arguments:
2040 .RS
2041 .RS
2042 .P
2043 <mode>[:<nodelist>]
2044 .RE
2045 .P
2046 `mode' is one of the following memory poicies: `default', `prefer',
2047 `bind', `interleave' or `local'. For `default' and `local' memory
2048 policies, no node needs to be specified. For `prefer', only one node is
2049 allowed. For `bind' and `interleave' the `nodelist' may be as
2050 follows: a comma delimited list of numbers, A\-B ranges, or `all'.
2051 .RE
2052 .TP
2053 .BI cgroup \fR=\fPstr
2054 Add job to this control group. If it doesn't exist, it will be created. The
2055 system must have a mounted cgroup blkio mount point for this to work. If
2056 your system doesn't have it mounted, you can do so with:
2057 .RS
2058 .RS
2059 .P
2060 # mount \-t cgroup \-o blkio none /cgroup
2061 .RE
2062 .RE
2063 .TP
2064 .BI cgroup_weight \fR=\fPint
2065 Set the weight of the cgroup to this value. See the documentation that comes
2066 with the kernel, allowed values are in the range of 100..1000.
2067 .TP
2068 .BI cgroup_nodelete \fR=\fPbool
2069 Normally fio will delete the cgroups it has created after the job
2070 completion. To override this behavior and to leave cgroups around after the
2071 job completion, set `cgroup_nodelete=1'. This can be useful if one wants
2072 to inspect various cgroup files after job completion. Default: false.
2073 .TP
2074 .BI flow_id \fR=\fPint
2075 The ID of the flow. If not specified, it defaults to being a global
2076 flow. See \fBflow\fR.
2077 .TP
2078 .BI flow \fR=\fPint
2079 Weight in token\-based flow control. If this value is used, then there is
2080 a 'flow counter' which is used to regulate the proportion of activity between
2081 two or more jobs. Fio attempts to keep this flow counter near zero. The
2082 \fBflow\fR parameter stands for how much should be added or subtracted to the
2083 flow counter on each iteration of the main I/O loop. That is, if one job has
2084 `flow=8' and another job has `flow=\-1', then there will be a roughly 1:8
2085 ratio in how much one runs vs the other.
2086 .TP
2087 .BI flow_watermark \fR=\fPint
2088 The maximum value that the absolute value of the flow counter is allowed to
2089 reach before the job must wait for a lower value of the counter.
2090 .TP
2091 .BI flow_sleep \fR=\fPint
2092 The period of time, in microseconds, to wait after the flow watermark has
2093 been exceeded before retrying operations.
2094 .TP
2095 .BI stonewall "\fR,\fB wait_for_previous"
2096 Wait for preceding jobs in the job file to exit, before starting this
2097 one. Can be used to insert serialization points in the job file. A stone
2098 wall also implies starting a new reporting group, see
2099 \fBgroup_reporting\fR.
2100 .TP
2101 .BI exitall
2102 By default, fio will continue running all other jobs when one job finishes
2103 but sometimes this is not the desired action. Setting \fBexitall\fR will
2104 instead make fio terminate all other jobs when one job finishes.
2105 .TP
2106 .BI exec_prerun \fR=\fPstr
2107 Before running this job, issue the command specified through
2108 \fBsystem\fR\|(3). Output is redirected in a file called `jobname.prerun.txt'.
2109 .TP
2110 .BI exec_postrun \fR=\fPstr
2111 After the job completes, issue the command specified though
2112 \fBsystem\fR\|(3). Output is redirected in a file called `jobname.postrun.txt'.
2113 .TP
2114 .BI uid \fR=\fPint
2115 Instead of running as the invoking user, set the user ID to this value
2116 before the thread/process does any work.
2117 .TP
2118 .BI gid \fR=\fPint
2119 Set group ID, see \fBuid\fR.
2120 .SS "Verification"
2121 .TP
2122 .BI verify_only
2123 Do not perform specified workload, only verify data still matches previous
2124 invocation of this workload. This option allows one to check data multiple
2125 times at a later date without overwriting it. This option makes sense only
2126 for workloads that write data, and does not support workloads with the
2127 \fBtime_based\fR option set.
2128 .TP
2129 .BI do_verify \fR=\fPbool
2130 Run the verify phase after a write phase. Only valid if \fBverify\fR is
2131 set. Default: true.
2132 .TP
2133 .BI verify \fR=\fPstr
2134 If writing to a file, fio can verify the file contents after each iteration
2135 of the job. Each verification method also implies verification of special
2136 header, which is written to the beginning of each block. This header also
2137 includes meta information, like offset of the block, block number, timestamp
2138 when block was written, etc. \fBverify\fR can be combined with
2139 \fBverify_pattern\fR option. The allowed values are:
2140 .RS
2141 .RS
2142 .TP
2143 .B md5
2144 Use an md5 sum of the data area and store it in the header of
2145 each block.
2146 .TP
2147 .B crc64
2148 Use an experimental crc64 sum of the data area and store it in the
2149 header of each block.
2150 .TP
2151 .B crc32c
2152 Use a crc32c sum of the data area and store it in the header of
2153 each block. This will automatically use hardware acceleration
2154 (e.g. SSE4.2 on an x86 or CRC crypto extensions on ARM64) but will
2155 fall back to software crc32c if none is found. Generally the
2156 fatest checksum fio supports when hardware accelerated.
2157 .TP
2158 .B crc32c\-intel
2159 Synonym for crc32c.
2160 .TP
2161 .B crc32
2162 Use a crc32 sum of the data area and store it in the header of each
2163 block.
2164 .TP
2165 .B crc16
2166 Use a crc16 sum of the data area and store it in the header of each
2167 block.
2168 .TP
2169 .B crc7
2170 Use a crc7 sum of the data area and store it in the header of each
2171 block.
2172 .TP
2173 .B xxhash
2174 Use xxhash as the checksum function. Generally the fastest software
2175 checksum that fio supports.
2176 .TP
2177 .B sha512
2178 Use sha512 as the checksum function.
2179 .TP
2180 .B sha256
2181 Use sha256 as the checksum function.
2182 .TP
2183 .B sha1
2184 Use optimized sha1 as the checksum function.
2185 .TP
2186 .B sha3\-224
2187 Use optimized sha3\-224 as the checksum function.
2188 .TP
2189 .B sha3\-256
2190 Use optimized sha3\-256 as the checksum function.
2191 .TP
2192 .B sha3\-384
2193 Use optimized sha3\-384 as the checksum function.
2194 .TP
2195 .B sha3\-512
2196 Use optimized sha3\-512 as the checksum function.
2197 .TP
2198 .B meta
2199 This option is deprecated, since now meta information is included in
2200 generic verification header and meta verification happens by
2201 default. For detailed information see the description of the
2202 \fBverify\fR setting. This option is kept because of
2203 compatibility's sake with old configurations. Do not use it.
2204 .TP
2205 .B pattern
2206 Verify a strict pattern. Normally fio includes a header with some
2207 basic information and checksumming, but if this option is set, only
2208 the specific pattern set with \fBverify_pattern\fR is verified.
2209 .TP
2210 .B null
2211 Only pretend to verify. Useful for testing internals with
2212 `ioengine=null', not for much else.
2213 .RE
2214 .P
2215 This option can be used for repeated burn\-in tests of a system to make sure
2216 that the written data is also correctly read back. If the data direction
2217 given is a read or random read, fio will assume that it should verify a
2218 previously written file. If the data direction includes any form of write,
2219 the verify will be of the newly written data.
2220 .RE
2221 .TP
2222 .BI verifysort \fR=\fPbool
2223 If true, fio will sort written verify blocks when it deems it faster to read
2224 them back in a sorted manner. This is often the case when overwriting an
2225 existing file, since the blocks are already laid out in the file system. You
2226 can ignore this option unless doing huge amounts of really fast I/O where
2227 the red\-black tree sorting CPU time becomes significant. Default: true.
2228 .TP
2229 .BI verifysort_nr \fR=\fPint
2230 Pre\-load and sort verify blocks for a read workload.
2231 .TP
2232 .BI verify_offset \fR=\fPint
2233 Swap the verification header with data somewhere else in the block before
2234 writing. It is swapped back before verifying.
2235 .TP
2236 .BI verify_interval \fR=\fPint
2237 Write the verification header at a finer granularity than the
2238 \fBblocksize\fR. It will be written for chunks the size of
2239 \fBverify_interval\fR. \fBblocksize\fR should divide this evenly.
2240 .TP
2241 .BI verify_pattern \fR=\fPstr
2242 If set, fio will fill the I/O buffers with this pattern. Fio defaults to
2243 filling with totally random bytes, but sometimes it's interesting to fill
2244 with a known pattern for I/O verification purposes. Depending on the width
2245 of the pattern, fio will fill 1/2/3/4 bytes of the buffer at the time (it can
2246 be either a decimal or a hex number). The \fBverify_pattern\fR if larger than
2247 a 32\-bit quantity has to be a hex number that starts with either "0x" or
2248 "0X". Use with \fBverify\fR. Also, \fBverify_pattern\fR supports %o
2249 format, which means that for each block offset will be written and then
2250 verified back, e.g.:
2251 .RS
2252 .RS
2253 .P
2254 verify_pattern=%o
2255 .RE
2256 .P
2257 Or use combination of everything:
2258 .RS
2259 .P
2260 verify_pattern=0xff%o"abcd"\-12
2261 .RE
2262 .RE
2263 .TP
2264 .BI verify_fatal \fR=\fPbool
2265 Normally fio will keep checking the entire contents before quitting on a
2266 block verification failure. If this option is set, fio will exit the job on
2267 the first observed failure. Default: false.
2268 .TP
2269 .BI verify_dump \fR=\fPbool
2270 If set, dump the contents of both the original data block and the data block
2271 we read off disk to files. This allows later analysis to inspect just what
2272 kind of data corruption occurred. Off by default.
2273 .TP
2274 .BI verify_async \fR=\fPint
2275 Fio will normally verify I/O inline from the submitting thread. This option
2276 takes an integer describing how many async offload threads to create for I/O
2277 verification instead, causing fio to offload the duty of verifying I/O
2278 contents to one or more separate threads. If using this offload option, even
2279 sync I/O engines can benefit from using an \fBiodepth\fR setting higher
2280 than 1, as it allows them to have I/O in flight while verifies are running.
2281 Defaults to 0 async threads, i.e. verification is not asynchronous.
2282 .TP
2283 .BI verify_async_cpus \fR=\fPstr
2284 Tell fio to set the given CPU affinity on the async I/O verification
2285 threads. See \fBcpus_allowed\fR for the format used.
2286 .TP
2287 .BI verify_backlog \fR=\fPint
2288 Fio will normally verify the written contents of a job that utilizes verify
2289 once that job has completed. In other words, everything is written then
2290 everything is read back and verified. You may want to verify continually
2291 instead for a variety of reasons. Fio stores the meta data associated with
2292 an I/O block in memory, so for large verify workloads, quite a bit of memory
2293 would be used up holding this meta data. If this option is enabled, fio will
2294 write only N blocks before verifying these blocks.
2295 .TP
2296 .BI verify_backlog_batch \fR=\fPint
2297 Control how many blocks fio will verify if \fBverify_backlog\fR is
2298 set. If not set, will default to the value of \fBverify_backlog\fR
2299 (meaning the entire queue is read back and verified). If
2300 \fBverify_backlog_batch\fR is less than \fBverify_backlog\fR then not all
2301 blocks will be verified, if \fBverify_backlog_batch\fR is larger than
2302 \fBverify_backlog\fR, some blocks will be verified more than once.
2303 .TP
2304 .BI verify_state_save \fR=\fPbool
2305 When a job exits during the write phase of a verify workload, save its
2306 current state. This allows fio to replay up until that point, if the verify
2307 state is loaded for the verify read phase. The format of the filename is,
2308 roughly:
2309 .RS
2310 .RS
2311 .P
2312 <type>\-<jobname>\-<jobindex>\-verify.state.
2313 .RE
2314 .P
2315 <type> is "local" for a local run, "sock" for a client/server socket
2316 connection, and "ip" (, for instance) for a networked
2317 client/server connection. Defaults to true.
2318 .RE
2319 .TP
2320 .BI verify_state_load \fR=\fPbool
2321 If a verify termination trigger was used, fio stores the current write state
2322 of each thread. This can be used at verification time so that fio knows how
2323 far it should verify. Without this information, fio will run a full
2324 verification pass, according to the settings in the job file used. Default
2325 false.
2326 .TP
2327 .BI trim_percentage \fR=\fPint
2328 Number of verify blocks to discard/trim.
2329 .TP
2330 .BI trim_verify_zero \fR=\fPbool
2331 Verify that trim/discarded blocks are returned as zeros.
2332 .TP
2333 .BI trim_backlog \fR=\fPint
2334 Verify that trim/discarded blocks are returned as zeros.
2335 .TP
2336 .BI trim_backlog_batch \fR=\fPint
2337 Trim this number of I/O blocks.
2338 .TP
2339 .BI experimental_verify \fR=\fPbool
2340 Enable experimental verification.
2341 .SS "Steady state"
2342 .TP
2343 .BI steadystate \fR=\fPstr:float "\fR,\fP ss" \fR=\fPstr:float
2344 Define the criterion and limit for assessing steady state performance. The
2345 first parameter designates the criterion whereas the second parameter sets
2346 the threshold. When the criterion falls below the threshold for the
2347 specified duration, the job will stop. For example, `iops_slope:0.1%' will
2348 direct fio to terminate the job when the least squares regression slope
2349 falls below 0.1% of the mean IOPS. If \fBgroup_reporting\fR is enabled
2350 this will apply to all jobs in the group. Below is the list of available
2351 steady state assessment criteria. All assessments are carried out using only
2352 data from the rolling collection window. Threshold limits can be expressed
2353 as a fixed value or as a percentage of the mean in the collection window.
2354 .RS
2355 .RS
2356 .TP
2357 .B iops
2358 Collect IOPS data. Stop the job if all individual IOPS measurements
2359 are within the specified limit of the mean IOPS (e.g., `iops:2'
2360 means that all individual IOPS values must be within 2 of the mean,
2361 whereas `iops:0.2%' means that all individual IOPS values must be
2362 within 0.2% of the mean IOPS to terminate the job).
2363 .TP
2364 .B iops_slope
2365 Collect IOPS data and calculate the least squares regression
2366 slope. Stop the job if the slope falls below the specified limit.
2367 .TP
2368 .B bw
2369 Collect bandwidth data. Stop the job if all individual bandwidth
2370 measurements are within the specified limit of the mean bandwidth.
2371 .TP
2372 .B bw_slope
2373 Collect bandwidth data and calculate the least squares regression
2374 slope. Stop the job if the slope falls below the specified limit.
2375 .RE
2376 .RE
2377 .TP
2378 .BI steadystate_duration \fR=\fPtime "\fR,\fP ss_dur" \fR=\fPtime
2379 A rolling window of this duration will be used to judge whether steady state
2380 has been reached. Data will be collected once per second. The default is 0
2381 which disables steady state detection. When the unit is omitted, the
2382 value is interpreted in seconds.
2383 .TP
2384 .BI steadystate_ramp_time \fR=\fPtime "\fR,\fP ss_ramp" \fR=\fPtime
2385 Allow the job to run for the specified duration before beginning data
2386 collection for checking the steady state job termination criterion. The
2387 default is 0. When the unit is omitted, the value is interpreted in seconds.
2388 .SS "Measurements and reporting"
2389 .TP
2390 .BI per_job_logs \fR=\fPbool
2391 If set, this generates bw/clat/iops log with per file private filenames. If
2392 not set, jobs with identical names will share the log filename. Default:
2393 true.
2394 .TP
2395 .BI group_reporting
2396 It may sometimes be interesting to display statistics for groups of jobs as
2397 a whole instead of for each individual job. This is especially true if
2398 \fBnumjobs\fR is used; looking at individual thread/process output
2399 quickly becomes unwieldy. To see the final report per\-group instead of
2400 per\-job, use \fBgroup_reporting\fR. Jobs in a file will be part of the
2401 same reporting group, unless if separated by a \fBstonewall\fR, or by
2402 using \fBnew_group\fR.
2403 .TP
2404 .BI new_group
2405 Start a new reporting group. See: \fBgroup_reporting\fR. If not given,
2406 all jobs in a file will be part of the same reporting group, unless
2407 separated by a \fBstonewall\fR.
2408 .TP
2409 .BI stats \fR=\fPbool
2410 By default, fio collects and shows final output results for all jobs
2411 that run. If this option is set to 0, then fio will ignore it in
2412 the final stat output.
2413 .TP
2414 .BI write_bw_log \fR=\fPstr
2415 If given, write a bandwidth log for this job. Can be used to store data of
2416 the bandwidth of the jobs in their lifetime. The included
2417 \fBfio_generate_plots\fR script uses gnuplot to turn these
2418 text files into nice graphs. See \fBwrite_lat_log\fR for behavior of
2419 given filename. For this option, the postfix is `_bw.x.log', where `x'
2420 is the index of the job (1..N, where N is the number of jobs). If
2421 \fBper_job_logs\fR is false, then the filename will not include the job
2422 index. See \fBLOG FILE FORMATS\fR section.
2423 .TP
2424 .BI write_lat_log \fR=\fPstr
2425 Same as \fBwrite_bw_log\fR, except that this option stores I/O
2426 submission, completion, and total latencies instead. If no filename is given
2427 with this option, the default filename of `jobname_type.log' is
2428 used. Even if the filename is given, fio will still append the type of
2429 log. So if one specifies:
2430 .RS
2431 .RS
2432 .P
2433 write_lat_log=foo
2434 .RE
2435 .P
2436 The actual log names will be `foo_slat.x.log', `foo_clat.x.log',
2437 and `foo_lat.x.log', where `x' is the index of the job (1..N, where N
2438 is the number of jobs). This helps \fBfio_generate_plots\fR find the
2439 logs automatically. If \fBper_job_logs\fR is false, then the filename
2440 will not include the job index. See \fBLOG FILE FORMATS\fR section.
2441 .RE
2442 .TP
2443 .BI write_hist_log \fR=\fPstr
2444 Same as \fBwrite_lat_log\fR, but writes I/O completion latency
2445 histograms. If no filename is given with this option, the default filename
2446 of `jobname_clat_hist.x.log' is used, where `x' is the index of the
2447 job (1..N, where N is the number of jobs). Even if the filename is given,
2448 fio will still append the type of log. If \fBper_job_logs\fR is false,
2449 then the filename will not include the job index. See \fBLOG FILE FORMATS\fR section.
2450 .TP
2451 .BI write_iops_log \fR=\fPstr
2452 Same as \fBwrite_bw_log\fR, but writes IOPS. If no filename is given
2453 with this option, the default filename of `jobname_type.x.log' is
2454 used, where `x' is the index of the job (1..N, where N is the number of
2455 jobs). Even if the filename is given, fio will still append the type of
2456 log. If \fBper_job_logs\fR is false, then the filename will not include
2457 the job index. See \fBLOG FILE FORMATS\fR section.
2458 .TP
2459 .BI log_avg_msec \fR=\fPint
2460 By default, fio will log an entry in the iops, latency, or bw log for every
2461 I/O that completes. When writing to the disk log, that can quickly grow to a
2462 very large size. Setting this option makes fio average the each log entry
2463 over the specified period of time, reducing the resolution of the log. See
2464 \fBlog_max_value\fR as well. Defaults to 0, logging all entries.
2465 Also see \fBLOG FILE FORMATS\fR section.
2466 .TP
2467 .BI log_hist_msec \fR=\fPint
2468 Same as \fBlog_avg_msec\fR, but logs entries for completion latency
2469 histograms. Computing latency percentiles from averages of intervals using
2470 \fBlog_avg_msec\fR is inaccurate. Setting this option makes fio log
2471 histogram entries over the specified period of time, reducing log sizes for
2472 high IOPS devices while retaining percentile accuracy. See
2473 \fBlog_hist_coarseness\fR as well. Defaults to 0, meaning histogram
2474 logging is disabled.
2475 .TP
2476 .BI log_hist_coarseness \fR=\fPint
2477 Integer ranging from 0 to 6, defining the coarseness of the resolution of
2478 the histogram logs enabled with \fBlog_hist_msec\fR. For each increment
2479 in coarseness, fio outputs half as many bins. Defaults to 0, for which
2480 histogram logs contain 1216 latency bins. See \fBLOG FILE FORMATS\fR section.
2481 .TP
2482 .BI log_max_value \fR=\fPbool
2483 If \fBlog_avg_msec\fR is set, fio logs the average over that window. If
2484 you instead want to log the maximum value, set this option to 1. Defaults to
2485 0, meaning that averaged values are logged.
2486 .TP
2487 .BI log_offset \fR=\fPbool
2488 If this is set, the iolog options will include the byte offset for the I/O
2489 entry as well as the other data values. Defaults to 0 meaning that
2490 offsets are not present in logs. Also see \fBLOG FILE FORMATS\fR section.
2491 .TP
2492 .BI log_compression \fR=\fPint
2493 If this is set, fio will compress the I/O logs as it goes, to keep the
2494 memory footprint lower. When a log reaches the specified size, that chunk is
2495 removed and compressed in the background. Given that I/O logs are fairly
2496 highly compressible, this yields a nice memory savings for longer runs. The
2497 downside is that the compression will consume some background CPU cycles, so
2498 it may impact the run. This, however, is also true if the logging ends up
2499 consuming most of the system memory. So pick your poison. The I/O logs are
2500 saved normally at the end of a run, by decompressing the chunks and storing
2501 them in the specified log file. This feature depends on the availability of
2502 zlib.
2503 .TP
2504 .BI log_compression_cpus \fR=\fPstr
2505 Define the set of CPUs that are allowed to handle online log compression for
2506 the I/O jobs. This can provide better isolation between performance
2507 sensitive jobs, and background compression work.
2508 .TP
2509 .BI log_store_compressed \fR=\fPbool
2510 If set, fio will store the log files in a compressed format. They can be
2511 decompressed with fio, using the \fB\-\-inflate\-log\fR command line
2512 parameter. The files will be stored with a `.fz' suffix.
2513 .TP
2514 .BI log_unix_epoch \fR=\fPbool
2515 If set, fio will log Unix timestamps to the log files produced by enabling
2516 write_type_log for each log type, instead of the default zero\-based
2517 timestamps.
2518 .TP
2519 .BI block_error_percentiles \fR=\fPbool
2520 If set, record errors in trim block\-sized units from writes and trims and
2521 output a histogram of how many trims it took to get to errors, and what kind
2522 of error was encountered.
2523 .TP
2524 .BI bwavgtime \fR=\fPint
2525 Average the calculated bandwidth over the given time. Value is specified in
2526 milliseconds. If the job also does bandwidth logging through
2527 \fBwrite_bw_log\fR, then the minimum of this option and
2528 \fBlog_avg_msec\fR will be used. Default: 500ms.
2529 .TP
2530 .BI iopsavgtime \fR=\fPint
2531 Average the calculated IOPS over the given time. Value is specified in
2532 milliseconds. If the job also does IOPS logging through
2533 \fBwrite_iops_log\fR, then the minimum of this option and
2534 \fBlog_avg_msec\fR will be used. Default: 500ms.
2535 .TP
2536 .BI disk_util \fR=\fPbool
2537 Generate disk utilization statistics, if the platform supports it.
2538 Default: true.
2539 .TP
2540 .BI disable_lat \fR=\fPbool
2541 Disable measurements of total latency numbers. Useful only for cutting back
2542 the number of calls to \fBgettimeofday\fR\|(2), as that does impact
2543 performance at really high IOPS rates. Note that to really get rid of a
2544 large amount of these calls, this option must be used with
2545 \fBdisable_slat\fR and \fBdisable_bw_measurement\fR as well.
2546 .TP
2547 .BI disable_clat \fR=\fPbool
2548 Disable measurements of completion latency numbers. See
2549 \fBdisable_lat\fR.
2550 .TP
2551 .BI disable_slat \fR=\fPbool
2552 Disable measurements of submission latency numbers. See
2553 \fBdisable_lat\fR.
2554 .TP
2555 .BI disable_bw_measurement \fR=\fPbool "\fR,\fP disable_bw" \fR=\fPbool
2556 Disable measurements of throughput/bandwidth numbers. See
2557 \fBdisable_lat\fR.
2558 .TP
2559 .BI clat_percentiles \fR=\fPbool
2560 Enable the reporting of percentiles of completion latencies. This option is
2561 mutually exclusive with \fBlat_percentiles\fR.
2562 .TP
2563 .BI lat_percentiles \fR=\fPbool
2564 Enable the reporting of percentiles of IO latencies. This is similar to
2565 \fBclat_percentiles\fR, except that this includes the submission latency.
2566 This option is mutually exclusive with \fBclat_percentiles\fR.
2567 .TP
2568 .BI percentile_list \fR=\fPfloat_list
2569 Overwrite the default list of percentiles for completion latencies and the
2570 block error histogram. Each number is a floating number in the range
2571 (0,100], and the maximum length of the list is 20. Use ':' to separate the
2572 numbers, and list the numbers in ascending order. For example,
2573 `\-\-percentile_list=99.5:99.9' will cause fio to report the values of
2574 completion latency below which 99.5% and 99.9% of the observed latencies
2575 fell, respectively.
2576 .SS "Error handling"
2577 .TP
2578 .BI exitall_on_error
2579 When one job finishes in error, terminate the rest. The default is to wait
2580 for each job to finish.
2581 .TP
2582 .BI continue_on_error \fR=\fPstr
2583 Normally fio will exit the job on the first observed failure. If this option
2584 is set, fio will continue the job when there is a 'non\-fatal error' (EIO or
2585 EILSEQ) until the runtime is exceeded or the I/O size specified is
2586 completed. If this option is used, there are two more stats that are
2587 appended, the total error count and the first error. The error field given
2588 in the stats is the first error that was hit during the run.
2589 The allowed values are:
2590 .RS
2591 .RS
2592 .TP
2593 .B none
2594 Exit on any I/O or verify errors.
2595 .TP
2596 .B read
2597 Continue on read errors, exit on all others.
2598 .TP
2599 .B write
2600 Continue on write errors, exit on all others.
2601 .TP
2602 .B io
2603 Continue on any I/O error, exit on all others.
2604 .TP
2605 .B verify
2606 Continue on verify errors, exit on all others.
2607 .TP
2608 .B all
2609 Continue on all errors.
2610 .TP
2611 .B 0
2612 Backward\-compatible alias for 'none'.
2613 .TP
2614 .B 1
2615 Backward\-compatible alias for 'all'.
2616 .RE
2617 .RE
2618 .TP
2619 .BI ignore_error \fR=\fPstr
2620 Sometimes you want to ignore some errors during test in that case you can
2621 specify error list for each error type, instead of only being able to
2622 ignore the default 'non\-fatal error' using \fBcontinue_on_error\fR.
2623 `ignore_error=READ_ERR_LIST,WRITE_ERR_LIST,VERIFY_ERR_LIST' errors for
2624 given error type is separated with ':'. Error may be symbol ('ENOSPC', 'ENOMEM')
2625 or integer. Example:
2626 .RS
2627 .RS
2628 .P
2629 ignore_error=EAGAIN,ENOSPC:122
2630 .RE
2631 .P
2632 This option will ignore EAGAIN from READ, and ENOSPC and 122(EDQUOT) from
2633 WRITE. This option works by overriding \fBcontinue_on_error\fR with
2634 the list of errors for each error type if any.
2635 .RE
2636 .TP
2637 .BI error_dump \fR=\fPbool
2638 If set dump every error even if it is non fatal, true by default. If
2639 disabled only fatal error will be dumped.
2640 .SS "Running predefined workloads"
2641 Fio includes predefined profiles that mimic the I/O workloads generated by
2642 other tools.
2643 .TP
2644 .BI profile \fR=\fPstr
2645 The predefined workload to run. Current profiles are:
2646 .RS
2647 .RS
2648 .TP
2649 .B tiobench
2650 Threaded I/O bench (tiotest/tiobench) like workload.
2651 .TP
2652 .B act
2653 Aerospike Certification Tool (ACT) like workload.
2654 .RE
2655 .RE
2656 .P
2657 To view a profile's additional options use \fB\-\-cmdhelp\fR after specifying
2658 the profile. For example:
2659 .RS
2660 .TP
2661 $ fio \-\-profile=act \-\-cmdhelp
2662 .RE
2663 .SS "Act profile options"
2664 .TP
2665 .BI device\-names \fR=\fPstr
2666 Devices to use.
2667 .TP
2668 .BI load \fR=\fPint
2669 ACT load multiplier. Default: 1.
2670 .TP
2671 .BI test\-duration\fR=\fPtime
2672 How long the entire test takes to run. When the unit is omitted, the value
2673 is given in seconds. Default: 24h.
2674 .TP
2675 .BI threads\-per\-queue\fR=\fPint
2676 Number of read I/O threads per device. Default: 8.
2677 .TP
2678 .BI read\-req\-num\-512\-blocks\fR=\fPint
2679 Number of 512B blocks to read at the time. Default: 3.
2680 .TP
2681 .BI large\-block\-op\-kbytes\fR=\fPint
2682 Size of large block ops in KiB (writes). Default: 131072.
2683 .TP
2684 .BI prep
2685 Set to run ACT prep phase.
2686 .SS "Tiobench profile options"
2687 .TP
2688 .BI size\fR=\fPstr
2689 Size in MiB.
2690 .TP
2691 .BI block\fR=\fPint
2692 Block size in bytes. Default: 4096.
2693 .TP
2694 .BI numruns\fR=\fPint
2695 Number of runs.
2696 .TP
2697 .BI dir\fR=\fPstr
2698 Test directory.
2699 .TP
2700 .BI threads\fR=\fPint
2701 Number of threads.
2703 Fio spits out a lot of output. While running, fio will display the status of the
2704 jobs created. An example of that would be:
2705 .P
2706 .nf
2707                 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]
2708 .fi
2709 .P
2710 The characters inside the first set of square brackets denote the current status of
2711 each thread. The first character is the first job defined in the job file, and so
2712 forth. The possible values (in typical life cycle order) are:
2713 .RS
2714 .TP
2715 .PD 0
2716 .B P
2717 Thread setup, but not started.
2718 .TP
2719 .B C
2720 Thread created.
2721 .TP
2722 .B I
2723 Thread initialized, waiting or generating necessary data.
2724 .TP
2725 .B P
2726 Thread running pre\-reading file(s).
2727 .TP
2728 .B /
2729 Thread is in ramp period.
2730 .TP
2731 .B R
2732 Running, doing sequential reads.
2733 .TP
2734 .B r
2735 Running, doing random reads.
2736 .TP
2737 .B W
2738 Running, doing sequential writes.
2739 .TP
2740 .B w
2741 Running, doing random writes.
2742 .TP
2743 .B M
2744 Running, doing mixed sequential reads/writes.
2745 .TP
2746 .B m
2747 Running, doing mixed random reads/writes.
2748 .TP
2749 .B D
2750 Running, doing sequential trims.
2751 .TP
2752 .B d
2753 Running, doing random trims.
2754 .TP
2755 .B F
2756 Running, currently waiting for \fBfsync\fR\|(2).
2757 .TP
2758 .B V
2759 Running, doing verification of written data.
2760 .TP
2761 .B f
2762 Thread finishing.
2763 .TP
2764 .B E
2765 Thread exited, not reaped by main thread yet.
2766 .TP
2767 .B \-
2768 Thread reaped.
2769 .TP
2770 .B X
2771 Thread reaped, exited with an error.
2772 .TP
2773 .B K
2774 Thread reaped, exited due to signal.
2775 .PD
2776 .RE
2777 .P
2778 Fio will condense the thread string as not to take up more space on the command
2779 line than needed. For instance, if you have 10 readers and 10 writers running,
2780 the output would look like this:
2781 .P
2782 .nf
2783                 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]
2784 .fi
2785 .P
2786 Note that the status string is displayed in order, so it's possible to tell which of
2787 the jobs are currently doing what. In the example above this means that jobs 1\-\-10
2788 are readers and 11\-\-20 are writers.
2789 .P
2790 The other values are fairly self explanatory \-\- number of threads currently
2791 running and doing I/O, the number of currently open files (f=), the estimated
2792 completion percentage, the rate of I/O since last check (read speed listed first,
2793 then write speed and optionally trim speed) in terms of bandwidth and IOPS,
2794 and time to completion for the current running group. It's impossible to estimate
2795 runtime of the following groups (if any).
2796 .P
2797 When fio is done (or interrupted by Ctrl\-C), it will show the data for
2798 each thread, group of threads, and disks in that order. For each overall thread (or
2799 group) the output looks like:
2800 .P
2801 .nf
2802                 Client1: (groupid=0, jobs=1): err= 0: pid=16109: Sat Jun 24 12:07:54 2017
2803                   write: IOPS=88, BW=623KiB/s (638kB/s)(30.4MiB/50032msec)
2804                     slat (nsec): min=500, max=145500, avg=8318.00, stdev=4781.50
2805                     clat (usec): min=170, max=78367, avg=4019.02, stdev=8293.31
2806                      lat (usec): min=174, max=78375, avg=4027.34, stdev=8291.79
2807                     clat percentiles (usec):
2808                      |  1.00th=[  302],  5.00th=[  326], 10.00th=[  343], 20.00th=[  363],
2809                      | 30.00th=[  392], 40.00th=[  404], 50.00th=[  416], 60.00th=[  445],
2810                      | 70.00th=[  816], 80.00th=[ 6718], 90.00th=[12911], 95.00th=[21627],
2811                      | 99.00th=[43779], 99.50th=[51643], 99.90th=[68682], 99.95th=[72877],
2812                      | 99.99th=[78119]
2813                    bw (  KiB/s): min=  532, max=  686, per=0.10%, avg=622.87, stdev=24.82, samples=  100
2814                    iops        : min=   76, max=   98, avg=88.98, stdev= 3.54, samples=  100
2815                   lat (usec)   : 250=0.04%, 500=64.11%, 750=4.81%, 1000=2.79%
2816                   lat (msec)   : 2=4.16%, 4=1.84%, 10=4.90%, 20=11.33%, 50=5.37%
2817                   lat (msec)   : 100=0.65%
2818                   cpu          : usr=0.27%, sys=0.18%, ctx=12072, majf=0, minf=21
2819                   IO depths    : 1=85.0%, 2=13.1%, 4=1.8%, 8=0.1%, 16=0.0%, 32=0.0%, >=64=0.0%
2820                      submit    : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0%
2821                      complete  : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0%
2822                      issued rwt: total=0,4450,0, short=0,0,0, dropped=0,0,0
2823                      latency   : target=0, window=0, percentile=100.00%, depth=8
2824 .fi
2825 .P
2826 The job name (or first job's name when using \fBgroup_reporting\fR) is printed,
2827 along with the group id, count of jobs being aggregated, last error id seen (which
2828 is 0 when there are no errors), pid/tid of that thread and the time the job/group
2829 completed. Below are the I/O statistics for each data direction performed (showing
2830 writes in the example above). In the order listed, they denote:
2831 .RS
2832 .TP
2833 .B read/write/trim
2834 The string before the colon shows the I/O direction the statistics
2835 are for. \fIIOPS\fR is the average I/Os performed per second. \fIBW\fR
2836 is the average bandwidth rate shown as: value in power of 2 format
2837 (value in power of 10 format). The last two values show: (total
2838 I/O performed in power of 2 format / \fIruntime\fR of that thread).
2839 .TP
2840 .B slat
2841 Submission latency (\fImin\fR being the minimum, \fImax\fR being the
2842 maximum, \fIavg\fR being the average, \fIstdev\fR being the standard
2843 deviation). This is the time it took to submit the I/O. For
2844 sync I/O this row is not displayed as the slat is really the
2845 completion latency (since queue/complete is one operation there).
2846 This value can be in nanoseconds, microseconds or milliseconds \-\-\-
2847 fio will choose the most appropriate base and print that (in the
2848 example above nanoseconds was the best scale). Note: in \fB\-\-minimal\fR mode
2849 latencies are always expressed in microseconds.
2850 .TP
2851 .B clat
2852 Completion latency. Same names as slat, this denotes the time from
2853 submission to completion of the I/O pieces. For sync I/O, clat will
2854 usually be equal (or very close) to 0, as the time from submit to
2855 complete is basically just CPU time (I/O has already been done, see slat
2856 explanation).
2857 .TP
2858 .B lat
2859 Total latency. Same names as slat and clat, this denotes the time from
2860 when fio created the I/O unit to completion of the I/O operation.
2861 .TP
2862 .B bw
2863 Bandwidth statistics based on samples. Same names as the xlat stats,
2864 but also includes the number of samples taken (\fIsamples\fR) and an
2865 approximate percentage of total aggregate bandwidth this thread
2866 received in its group (\fIper\fR). This last value is only really
2867 useful if the threads in this group are on the same disk, since they
2868 are then competing for disk access.
2869 .TP
2870 .B iops
2871 IOPS statistics based on samples. Same names as \fBbw\fR.
2872 .TP
2873 .B lat (nsec/usec/msec)
2874 The distribution of I/O completion latencies. This is the time from when
2875 I/O leaves fio and when it gets completed. Unlike the separate
2876 read/write/trim sections above, the data here and in the remaining
2877 sections apply to all I/Os for the reporting group. 250=0.04% means that
2878 0.04% of the I/Os completed in under 250us. 500=64.11% means that 64.11%
2879 of the I/Os required 250 to 499us for completion.
2880 .TP
2881 .B cpu
2882 CPU usage. User and system time, along with the number of context
2883 switches this thread went through, usage of system and user time, and
2884 finally the number of major and minor page faults. The CPU utilization
2885 numbers are averages for the jobs in that reporting group, while the
2886 context and fault counters are summed.
2887 .TP
2888 .B IO depths
2889 The distribution of I/O depths over the job lifetime. The numbers are
2890 divided into powers of 2 and each entry covers depths from that value
2891 up to those that are lower than the next entry \-\- e.g., 16= covers
2892 depths from 16 to 31. Note that the range covered by a depth
2893 distribution entry can be different to the range covered by the
2894 equivalent \fBsubmit\fR/\fBcomplete\fR distribution entry.
2895 .TP
2896 .B IO submit
2897 How many pieces of I/O were submitting in a single submit call. Each
2898 entry denotes that amount and below, until the previous entry \-\- e.g.,
2899 16=100% means that we submitted anywhere between 9 to 16 I/Os per submit
2900 call. Note that the range covered by a \fBsubmit\fR distribution entry can
2901 be different to the range covered by the equivalent depth distribution
2902 entry.
2903 .TP
2904 .B IO complete
2905 Like the above \fBsubmit\fR number, but for completions instead.
2906 .TP
2907 .B IO issued rwt
2908 The number of \fBread/write/trim\fR requests issued, and how many of them were
2909 short or dropped.
2910 .TP
2911 .B IO latency
2912 These values are for \fBlatency-target\fR and related options. When
2913 these options are engaged, this section describes the I/O depth required
2914 to meet the specified latency target.
2915 .RE
2916 .P
2917 After each client has been listed, the group statistics are printed. They
2918 will look like this:
2919 .P
2920 .nf
2921                 Run status group 0 (all jobs):
2922                    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
2923                   WRITE: bw=1231KiB/s (1261kB/s), 616KiB/s\-621KiB/s (630kB/s\-636kB/s), io=64.0MiB (67.1MB), run=52747\-53223msec
2924 .fi
2925 .P
2926 For each data direction it prints:
2927 .RS
2928 .TP
2929 .B bw
2930 Aggregate bandwidth of threads in this group followed by the
2931 minimum and maximum bandwidth of all the threads in this group.
2932 Values outside of brackets are power\-of\-2 format and those
2933 within are the equivalent value in a power\-of\-10 format.
2934 .TP
2935 .B io
2936 Aggregate I/O performed of all threads in this group. The
2937 format is the same as \fBbw\fR.
2938 .TP
2939 .B run
2940 The smallest and longest runtimes of the threads in this group.
2941 .RE
2942 .P
2943 And finally, the disk statistics are printed. This is Linux specific.
2944 They will look like this:
2945 .P
2946 .nf
2947                   Disk stats (read/write):
2948                     sda: ios=16398/16511, merge=30/162, ticks=6853/819634, in_queue=826487, util=100.00%
2949 .fi
2950 .P
2951 Each value is printed for both reads and writes, with reads first. The
2952 numbers denote:
2953 .RS
2954 .TP
2955 .B ios
2956 Number of I/Os performed by all groups.
2957 .TP
2958 .B merge
2959 Number of merges performed by the I/O scheduler.
2960 .TP
2961 .B ticks
2962 Number of ticks we kept the disk busy.
2963 .TP
2964 .B in_queue
2965 Total time spent in the disk queue.
2966 .TP
2967 .B util
2968 The disk utilization. A value of 100% means we kept the disk
2969 busy constantly, 50% would be a disk idling half of the time.
2970 .RE
2971 .P
2972 It is also possible to get fio to dump the current output while it is running,
2973 without terminating the job. To do that, send fio the USR1 signal. You can
2974 also get regularly timed dumps by using the \fB\-\-status\-interval\fR
2975 parameter, or by creating a file in `/tmp' named
2976 `fio\-dump\-status'. If fio sees this file, it will unlink it and dump the
2977 current output status.
2979 For scripted usage where you typically want to generate tables or graphs of the
2980 results, fio can output the results in a semicolon separated format. The format
2981 is one long line of values, such as:
2982 .P
2983 .nf
2984                 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%
2985                 A description of this job goes here.
2986 .fi
2987 .P
2988 The job description (if provided) follows on a second line.
2989 .P
2990 To enable terse output, use the \fB\-\-minimal\fR or
2991 `\-\-output\-format=terse' command line options. The
2992 first value is the version of the terse output format. If the output has to be
2993 changed for some reason, this number will be incremented by 1 to signify that
2994 change.
2995 .P
2996 Split up, the format is as follows (comments in brackets denote when a
2997 field was introduced or whether it's specific to some terse version):
2998 .P
2999 .nf
3000                         terse version, fio version [v3], jobname, groupid, error
3001 .fi
3002 .RS
3003 .P
3004 .B
3005 READ status:
3006 .RE
3007 .P
3008 .nf
3009                         Total IO (KiB), bandwidth (KiB/sec), IOPS, runtime (msec)
3010                         Submission latency: min, max, mean, stdev (usec)
3011                         Completion latency: min, max, mean, stdev (usec)
3012                         Completion latency percentiles: 20 fields (see below)
3013                         Total latency: min, max, mean, stdev (usec)
3014                         Bw (KiB/s): min, max, aggregate percentage of total, mean, stdev, number of samples [v5]
3015                         IOPS [v5]: min, max, mean, stdev, number of samples
3016 .fi
3017 .RS
3018 .P
3019 .B
3020 WRITE status:
3021 .RE
3022 .P
3023 .nf
3024                         Total IO (KiB), bandwidth (KiB/sec), IOPS, runtime (msec)
3025                         Submission latency: min, max, mean, stdev (usec)
3026                         Completion latency: min, max, mean, stdev (usec)
3027                         Completion latency percentiles: 20 fields (see below)
3028                         Total latency: min, max, mean, stdev (usec)
3029                         Bw (KiB/s): min, max, aggregate percentage of total, mean, stdev, number of samples [v5]
3030                         IOPS [v5]: min, max, mean, stdev, number of samples
3031 .fi
3032 .RS
3033 .P
3034 .B
3035 TRIM status [all but version 3]:
3036 .RE
3037 .P
3038 .nf
3039                         Fields are similar to \fBREAD/WRITE\fR status.
3040 .fi
3041 .RS
3042 .P
3043 .B
3044 CPU usage:
3045 .RE
3046 .P
3047 .nf
3048                         user, system, context switches, major faults, minor faults
3049 .fi
3050 .RS
3051 .P
3052 .B
3053 I/O depths:
3054 .RE
3055 .P
3056 .nf
3057                         <=1, 2, 4, 8, 16, 32, >=64
3058 .fi
3059 .RS
3060 .P
3061 .B
3062 I/O latencies microseconds:
3063 .RE
3064 .P
3065 .nf
3066                         <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
3067 .fi
3068 .RS
3069 .P
3070 .B
3071 I/O latencies milliseconds:
3072 .RE
3073 .P
3074 .nf
3075                         <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000
3076 .fi
3077 .RS
3078 .P
3079 .B
3080 Disk utilization [v3]:
3081 .RE
3082 .P
3083 .nf
3084                         disk name, read ios, write ios, read merges, write merges, read ticks, write ticks, time spent in queue, disk utilization percentage
3085 .fi
3086 .RS
3087 .P
3088 .B
3089 Additional Info (dependent on continue_on_error, default off):
3090 .RE
3091 .P
3092 .nf
3093                         total # errors, first error code
3094 .fi
3095 .RS
3096 .P
3097 .B
3098 Additional Info (dependent on description being set):
3099 .RE
3100 .P
3101 .nf
3102                         Text description
3103 .fi
3104 .P
3105 Completion latency percentiles can be a grouping of up to 20 sets, so for the
3106 terse output fio writes all of them. Each field will look like this:
3107 .P
3108 .nf
3109                 1.00%=6112
3110 .fi
3111 .P
3112 which is the Xth percentile, and the `usec' latency associated with it.
3113 .P
3114 For \fBDisk utilization\fR, all disks used by fio are shown. So for each disk there
3115 will be a disk utilization section.
3116 .P
3117 Below is a single line containing short names for each of the fields in the
3118 minimal output v3, separated by semicolons:
3119 .P
3120 .nf
3121                 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
3122 .fi
3124 The \fBjson\fR output format is intended to be both human readable and convenient
3125 for automated parsing. For the most part its sections mirror those of the
3126 \fBnormal\fR output. The \fBruntime\fR value is reported in msec and the \fBbw\fR value is
3127 reported in 1024 bytes per second units.
3128 .fi
3130 The \fBjson+\fR output format is identical to the \fBjson\fR output format except that it
3131 adds a full dump of the completion latency bins. Each \fBbins\fR object contains a
3132 set of (key, value) pairs where keys are latency durations and values count how
3133 many I/Os had completion latencies of the corresponding duration. For example,
3134 consider:
3135 .RS
3136 .P
3137 "bins" : { "87552" : 1, "89600" : 1, "94720" : 1, "96768" : 1, "97792" : 1, "99840" : 1, "100864" : 2, "103936" : 6, "104960" : 534, "105984" : 5995, "107008" : 7529, ... }
3138 .RE
3139 .P
3140 This data indicates that one I/O required 87,552ns to complete, two I/Os required
3141 100,864ns to complete, and 7529 I/Os required 107,008ns to complete.
3142 .P
3143 Also included with fio is a Python script \fBfio_jsonplus_clat2csv\fR that takes
3144 json+ output and generates CSV\-formatted latency data suitable for plotting.
3145 .P
3146 The latency durations actually represent the midpoints of latency intervals.
3147 For details refer to `stat.h' in the fio source.
3149 There are two trace file format that you can encounter. The older (v1) format is
3150 unsupported since version 1.20\-rc3 (March 2008). It will still be described
3151 below in case that you get an old trace and want to understand it.
3152 .P
3153 In any case the trace is a simple text file with a single action per line.
3154 .TP
3155 .B Trace file format v1
3156 Each line represents a single I/O action in the following format:
3157 .RS
3158 .RS
3159 .P
3160 rw, offset, length
3161 .RE
3162 .P
3163 where `rw=0/1' for read/write, and the `offset' and `length' entries being in bytes.
3164 .P
3165 This format is not supported in fio versions >= 1.20\-rc3.
3166 .RE
3167 .TP
3168 .B Trace file format v2
3169 The second version of the trace file format was added in fio version 1.17. It
3170 allows to access more then one file per trace and has a bigger set of possible
3171 file actions.
3172 .RS
3173 .P
3174 The first line of the trace file has to be:
3175 .RS
3176 .P
3177 "fio version 2 iolog"
3178 .RE
3179 .P
3180 Following this can be lines in two different formats, which are described below.
3181 .P
3182 .B
3183 The file management format:
3184 .RS
3185 filename action
3186 .P
3187 The `filename' is given as an absolute path. The `action' can be one of these:
3188 .RS
3189 .TP
3190 .B add
3191 Add the given `filename' to the trace.
3192 .TP
3193 .B open
3194 Open the file with the given `filename'. The `filename' has to have
3195 been added with the \fBadd\fR action before.
3196 .TP
3197 .B close
3198 Close the file with the given `filename'. The file has to have been
3199 \fBopen\fRed before.
3200 .RE
3201 .RE
3202 .P
3203 .B
3204 The file I/O action format:
3205 .RS
3206 filename action offset length
3207 .P
3208 The `filename' is given as an absolute path, and has to have been \fBadd\fRed and
3209 \fBopen\fRed before it can be used with this format. The `offset' and `length' are
3210 given in bytes. The `action' can be one of these:
3211 .RS
3212 .TP
3213 .B wait
3214 Wait for `offset' microseconds. Everything below 100 is discarded.
3215 The time is relative to the previous `wait' statement.
3216 .TP
3217 .B read
3218 Read `length' bytes beginning from `offset'.
3219 .TP
3220 .B write
3221 Write `length' bytes beginning from `offset'.
3222 .TP
3223 .B sync
3224 \fBfsync\fR\|(2) the file.
3225 .TP
3226 .B datasync
3227 \fBfdatasync\fR\|(2) the file.
3228 .TP
3229 .B trim
3230 Trim the given file from the given `offset' for `length' bytes.
3231 .RE
3232 .RE
3234 In some cases, we want to understand CPU overhead in a test. For example, we
3235 test patches for the specific goodness of whether they reduce CPU usage.
3236 Fio implements a balloon approach to create a thread per CPU that runs at idle
3237 priority, meaning that it only runs when nobody else needs the cpu.
3238 By measuring the amount of work completed by the thread, idleness of each CPU
3239 can be derived accordingly.
3240 .P
3241 An unit work is defined as touching a full page of unsigned characters. Mean and
3242 standard deviation of time to complete an unit work is reported in "unit work"
3243 section. Options can be chosen to report detailed percpu idleness or overall
3244 system idleness by aggregating percpu stats.
3246 Fio is usually run in one of two ways, when data verification is done. The first
3247 is a normal write job of some sort with verify enabled. When the write phase has
3248 completed, fio switches to reads and verifies everything it wrote. The second
3249 model is running just the write phase, and then later on running the same job
3250 (but with reads instead of writes) to repeat the same I/O patterns and verify
3251 the contents. Both of these methods depend on the write phase being completed,
3252 as fio otherwise has no idea how much data was written.
3253 .P
3254 With verification triggers, fio supports dumping the current write state to
3255 local files. Then a subsequent read verify workload can load this state and know
3256 exactly where to stop. This is useful for testing cases where power is cut to a
3257 server in a managed fashion, for instance.
3258 .P
3259 A verification trigger consists of two things:
3260 .RS
3261 .P
3262 1) Storing the write state of each job.
3263 .P
3264 2) Executing a trigger command.
3265 .RE
3266 .P
3267 The write state is relatively small, on the order of hundreds of bytes to single
3268 kilobytes. It contains information on the number of completions done, the last X
3269 completions, etc.
3270 .P
3271 A trigger is invoked either through creation ('touch') of a specified file in
3272 the system, or through a timeout setting. If fio is run with
3273 `\-\-trigger\-file=/tmp/trigger\-file', then it will continually
3274 check for the existence of `/tmp/trigger\-file'. When it sees this file, it
3275 will fire off the trigger (thus saving state, and executing the trigger
3276 command).
3277 .P
3278 For client/server runs, there's both a local and remote trigger. If fio is
3279 running as a server backend, it will send the job states back to the client for
3280 safe storage, then execute the remote trigger, if specified. If a local trigger
3281 is specified, the server will still send back the write state, but the client
3282 will then execute the trigger.
3283 .RE
3284 .P
3285 .B Verification trigger example
3286 .RS
3287 Let's say we want to run a powercut test on the remote Linux machine 'server'.
3288 Our write workload is in `write\-test.fio'. We want to cut power to 'server' at
3289 some point during the run, and we'll run this test from the safety or our local
3290 machine, 'localbox'. On the server, we'll start the fio backend normally:
3291 .RS
3292 .P
3293 server# fio \-\-server
3294 .RE
3295 .P
3296 and on the client, we'll fire off the workload:
3297 .RS
3298 .P
3299 localbox$ fio \-\-client=server \-\-trigger\-file=/tmp/my\-trigger \-\-trigger\-remote="bash \-c "echo b > /proc/sysrq\-triger""
3300 .RE
3301 .P
3302 We set `/tmp/my\-trigger' as the trigger file, and we tell fio to execute:
3303 .RS
3304 .P
3305 echo b > /proc/sysrq\-trigger
3306 .RE
3307 .P
3308 on the server once it has received the trigger and sent us the write state. This
3309 will work, but it's not really cutting power to the server, it's merely
3310 abruptly rebooting it. If we have a remote way of cutting power to the server
3311 through IPMI or similar, we could do that through a local trigger command
3312 instead. Let's assume we have a script that does IPMI reboot of a given hostname,
3313 ipmi\-reboot. On localbox, we could then have run fio with a local trigger
3314 instead:
3315 .RS
3316 .P
3317 localbox$ fio \-\-client=server \-\-trigger\-file=/tmp/my\-trigger \-\-trigger="ipmi\-reboot server"
3318 .RE
3319 .P
3320 For this case, fio would wait for the server to send us the write state, then
3321 execute `ipmi\-reboot server' when that happened.
3322 .RE
3323 .P
3324 .B Loading verify state
3325 .RS
3326 To load stored write state, a read verification job file must contain the
3327 \fBverify_state_load\fR option. If that is set, fio will load the previously
3328 stored state. For a local fio run this is done by loading the files directly,
3329 and on a client/server run, the server backend will ask the client to send the
3330 files over and load them from there.
3331 .RE
3333 Fio supports a variety of log file formats, for logging latencies, bandwidth,
3334 and IOPS. The logs share a common format, which looks like this:
3335 .RS
3336 .P
3337 time (msec), value, data direction, block size (bytes), offset (bytes)
3338 .RE
3339 .P
3340 `Time' for the log entry is always in milliseconds. The `value' logged depends
3341 on the type of log, it will be one of the following:
3342 .RS
3343 .TP
3344 .B Latency log
3345 Value is latency in nsecs
3346 .TP
3347 .B Bandwidth log
3348 Value is in KiB/sec
3349 .TP
3350 .B IOPS log
3351 Value is IOPS
3352 .RE
3353 .P
3354 `Data direction' is one of the following:
3355 .RS
3356 .TP
3357 .B 0
3358 I/O is a READ
3359 .TP
3360 .B 1
3361 I/O is a WRITE
3362 .TP
3363 .B 2
3364 I/O is a TRIM
3365 .RE
3366 .P
3367 The entry's `block size' is always in bytes. The `offset' is the offset, in bytes,
3368 from the start of the file, for that particular I/O. The logging of the offset can be
3369 toggled with \fBlog_offset\fR.
3370 .P
3371 Fio defaults to logging every individual I/O. When IOPS are logged for individual
3372 I/Os the `value' entry will always be 1. If windowed logging is enabled through
3373 \fBlog_avg_msec\fR, fio logs the average values over the specified period of time.
3374 If windowed logging is enabled and \fBlog_max_value\fR is set, then fio logs
3375 maximum values in that window instead of averages. Since `data direction', `block size'
3376 and `offset' are per\-I/O values, if windowed logging is enabled they
3377 aren't applicable and will be 0.
3379 Normally fio is invoked as a stand\-alone application on the machine where the
3380 I/O workload should be generated. However, the backend and frontend of fio can
3381 be run separately i.e., the fio server can generate an I/O workload on the "Device
3382 Under Test" while being controlled by a client on another machine.
3383 .P
3384 Start the server on the machine which has access to the storage DUT:
3385 .RS
3386 .P
3387 $ fio \-\-server=args
3388 .RE
3389 .P
3390 where `args' defines what fio listens to. The arguments are of the form
3391 `type,hostname' or `IP,port'. `type' is either `ip' (or ip4) for TCP/IP
3392 v4, `ip6' for TCP/IP v6, or `sock' for a local unix domain socket.
3393 `hostname' is either a hostname or IP address, and `port' is the port to listen
3394 to (only valid for TCP/IP, not a local socket). Some examples:
3395 .RS
3396 .TP
3397 1) \fBfio \-\-server\fR
3398 Start a fio server, listening on all interfaces on the default port (8765).
3399 .TP
3400 2) \fBfio \-\-server=ip:hostname,4444\fR
3401 Start a fio server, listening on IP belonging to hostname and on port 4444.
3402 .TP
3403 3) \fBfio \-\-server=ip6:::1,4444\fR
3404 Start a fio server, listening on IPv6 localhost ::1 and on port 4444.
3405 .TP
3406 4) \fBfio \-\-server=,4444\fR
3407 Start a fio server, listening on all interfaces on port 4444.
3408 .TP
3409 5) \fBfio \-\-server=\fR
3410 Start a fio server, listening on IP on the default port.
3411 .TP
3412 6) \fBfio \-\-server=sock:/tmp/fio.sock\fR
3413 Start a fio server, listening on the local socket `/tmp/fio.sock'.
3414 .RE
3415 .P
3416 Once a server is running, a "client" can connect to the fio server with:
3417 .RS
3418 .P
3419 $ fio <local\-args> \-\-client=<server> <remote\-args> <job file(s)>
3420 .RE
3421 .P
3422 where `local\-args' are arguments for the client where it is running, `server'
3423 is the connect string, and `remote\-args' and `job file(s)' are sent to the
3424 server. The `server' string follows the same format as it does on the server
3425 side, to allow IP/hostname/socket and port strings.
3426 .P
3427 Fio can connect to multiple servers this way:
3428 .RS
3429 .P
3430 $ fio \-\-client=<server1> <job file(s)> \-\-client=<server2> <job file(s)>
3431 .RE
3432 .P
3433 If the job file is located on the fio server, then you can tell the server to
3434 load a local file as well. This is done by using \fB\-\-remote\-config\fR:
3435 .RS
3436 .P
3437 $ fio \-\-client=server \-\-remote\-config /path/to/file.fio
3438 .RE
3439 .P
3440 Then fio will open this local (to the server) job file instead of being passed
3441 one from the client.
3442 .P
3443 If you have many servers (example: 100 VMs/containers), you can input a pathname
3444 of a file containing host IPs/names as the parameter value for the
3445 \fB\-\-client\fR option. For example, here is an example `host.list'
3446 file containing 2 hostnames:
3447 .RS
3448 .P
3449 .PD 0
3450 host1.your.dns.domain
3451 .P
3452 host2.your.dns.domain
3453 .PD
3454 .RE
3455 .P
3456 The fio command would then be:
3457 .RS
3458 .P
3459 $ fio \-\-client=host.list <job file(s)>
3460 .RE
3461 .P
3462 In this mode, you cannot input server\-specific parameters or job files \-\- all
3463 servers receive the same job file.
3464 .P
3465 In order to let `fio \-\-client' runs use a shared filesystem from multiple
3466 hosts, `fio \-\-client' now prepends the IP address of the server to the
3467 filename. For example, if fio is using the directory `/mnt/nfs/fio' and is
3468 writing filename `fileio.tmp', with a \fB\-\-client\fR `hostfile'
3469 containing two hostnames `h1' and `h2' with IP addresses and
3470, then fio will create two files:
3471 .RS
3472 .P
3473 .PD 0
3474 /mnt/nfs/fio/
3475 .P
3476 /mnt/nfs/fio/
3477 .PD
3478 .RE
3480 .B fio
3481 was written by Jens Axboe <>,
3482 now Jens Axboe <>.
3483 .br
3484 This man page was written by Aaron Carroll <> based
3485 on documentation by Jens Axboe.
3486 .br
3487 This man page was rewritten by Tomohiro Kusumi <> based
3488 on documentation by Jens Axboe.
3490 Report bugs to the \fBfio\fR mailing list <>.
3491 .br
3493 .P
3495 .SH "SEE ALSO"
3496 For further documentation see \fBHOWTO\fR and \fBREADME\fR.
3497 .br
3498 Sample jobfiles are available in the `examples/' directory.
3499 .br
3500 These are typically located under `/usr/share/doc/fio'.
3501 .P
3502 \fBHOWTO\fR: \fI\fR
3503 .br
3504 \fBREADME\fR: \fI\fR