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