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