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