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