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