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