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