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