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