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