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