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