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