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
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?
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.
26 How much data are we going to be reading/writing.
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
36 If the I/O engine is async, how large a queuing depth do we want to
42 How many files are we spreading the workload over.
44 `Threads, processes and job synchronization`_
46 How many threads or processes should we spread this workload over.
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.
55 .. option:: --debug=type
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
63 Dump info related to processes.
65 Dump info related to file actions.
67 Dump info related to I/O queuing.
69 Dump info related to memory allocations.
71 Dump info related to blktrace setup.
73 Dump info related to I/O verification.
75 Enable all debug options.
77 Dump info related to random offset generation.
79 Dump info related to option matching and parsing.
81 Dump info related to disk utilization updates.
83 Dump info only related to job number x.
85 Dump info only related to mutex up/down ops.
87 Dump info related to profile extensions.
89 Dump info related to internal time keeping.
91 Dump info related to networking connections.
93 Dump info related to I/O rate switching.
95 Dump info related to log compress/decompress.
97 Show available debug options.
99 .. option:: --parse-only
101 Parse options only, don't start any I/O.
103 .. option:: --output=filename
105 Write output to file `filename`.
107 .. option:: --output-format=format
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
114 .. option:: --bandwidth-log
116 Generate aggregate bandwidth logs.
118 .. option:: --minimal
120 Print statistics in a terse, semicolon-delimited format.
122 .. option:: --append-terse
124 Print statistics in selected mode AND terse, semicolon-delimited format.
125 **Deprecated**, use :option:`--output-format` instead to select multiple
128 .. option:: --terse-version=version
130 Set terse `version` output format (default 3, or 2 or 4 or 5).
132 .. option:: --version
134 Print version information and exit.
138 Print a summary of the command line options and exit.
140 .. option:: --cpuclock-test
142 Perform test and validation of internal CPU clock.
144 .. option:: --crctest=[test]
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.
150 .. option:: --cmdhelp=command
152 Print help information for `command`. May be ``all`` for all commands.
154 .. option:: --enghelp=[ioengine[,command]]
156 List all commands defined by `ioengine`, or print help for `command`
157 defined by `ioengine`. If no `ioengine` is given, list all
160 .. option:: --showcmd=jobfile
162 Convert `jobfile` to a set of command-line options.
164 .. option:: --readonly
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).
173 .. option:: --eta=when
175 Specifies when real-time ETA estimate should be printed. `when` may be
176 `always`, `never` or `auto`.
178 .. option:: --eta-newline=time
180 Force a new line for every `time` period passed. When the unit is omitted,
181 the value is interpreted in seconds.
183 .. option:: --status-interval=time
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.
190 .. option:: --section=name
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
201 .. option:: --alloc-size=kb
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.
209 NOTE: While running :file:`.fio_smalloc.*` backing store files are visible
212 .. option:: --warnings-fatal
214 All fio parser warnings are fatal, causing fio to exit with an
217 .. option:: --max-jobs=nr
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 (:file:`/proc/sys/kernel/shmmax`) if fio runs into errors while
224 .. option:: --server=args
226 Start a backend server, with `args` specifying what to listen to.
227 See `Client/Server`_ section.
229 .. option:: --daemonize=pidfile
231 Background a fio server, writing the pid to the given `pidfile` file.
233 .. option:: --client=hostname
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.
238 .. option:: --remote-config=file
240 Tell fio server to load this local `file`.
242 .. option:: --idle-prof=option
244 Report CPU idleness. `option` is one of the following:
247 Run unit work calibration only and exit.
250 Show aggregate system idleness and unit work.
253 As **system** but also show per CPU idleness.
255 .. option:: --inflate-log=log
257 Inflate and output compressed `log`.
259 .. option:: --trigger-file=file
261 Execute trigger command when `file` exists.
263 .. option:: --trigger-timeout=time
265 Execute trigger at this `time`.
267 .. option:: --trigger=command
269 Set this `command` as local trigger.
271 .. option:: --trigger-remote=command
273 Set this `command` as remote trigger.
275 .. option:: --aux-path=path
277 Use this `path` for fio state generated files.
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.
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.
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
301 The :option:`--cmdhelp` option also lists all options. If used with a `command`
302 argument, :option:`--cmdhelp` will detail the given `command`.
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.
307 So let's look at a really simple job file that defines two processes, each
308 randomly reading from a 128MiB file:
312 ; -- start job file --
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::
328 $ fio --name=global --rw=randread --size=128m --name=job1 --name=job2
331 Let's look at an example that has a number of processes writing randomly to
336 ; -- start job file --
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::
354 $ fio --name=random-writers --ioengine=libaio --iodepth=4 --rw=randwrite --bs=32k --direct=0 --size=64m --numjobs=4
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
362 ; -- start job file including.fio --
366 include glob-include.fio
373 include test-include.fio
374 ; -- end job file including.fio --
378 ; -- start job file glob-include.fio --
381 ; -- end job file glob-include.fio --
385 ; -- start job file test-include.fio --
388 ; -- end job file test-include.fio --
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.
395 Environment variables
396 ~~~~~~~~~~~~~~~~~~~~~
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.
404 As an example, let's look at a sample fio invocation and job file::
406 $ SIZE=64m NUMJOBS=4 fio jobfile.fio
410 ; -- start job file --
417 This will expand to the following equivalent job file at runtime:
421 ; -- start job file --
428 Fio ships with a few example job files, you can also look there for inspiration.
433 Additionally, fio has a set of reserved keywords that will be replaced
434 internally with the appropriate value. Those keywords are:
438 The architecture page size of the running system.
442 Megabytes of total memory in the system.
446 Number of online available CPUs.
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
455 and get that properly expanded to 8 times the size of memory in the machine.
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:
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:
482 String: A sequence of alphanumeric characters.
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.
493 Integer. A whole number value, which may contain an integer prefix
494 and an integer suffix:
496 [*integer prefix*] **number** [*integer suffix*]
498 The optional *integer prefix* specifies the number's base. The default
499 is decimal. *0x* specifies hexadecimal.
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.
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):
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
516 To specify power-of-2 binary values defined in IEC 80000-13:
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
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.
528 For quantities of data, an optional unit of 'B' may be included
529 (e.g., 'kB' is the same as 'k').
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.
534 Examples with :option:`kb_base`\=1000:
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
542 Examples with :option:`kb_base`\=1024 (default):
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
550 To specify times (units are not case sensitive):
554 * *M* -- means minutes
555 * *s* -- or sec means seconds (default)
556 * *ms* -- or *msec* means milliseconds
557 * *us* -- or *usec* means microseconds
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.
567 Boolean. Usually parsed as an integer, however only defined for
568 true and false (1 and 0).
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>`.
579 A list of floating point numbers, separated by a ':' character.
581 With the above in mind, here follows the complete list of fio job parameters.
587 .. option:: kb_base=int
589 Select the interpretation of unit prefixes in input parameters.
592 Inputs comply with IEC 80000-13 and the International
593 System of Units (SI). Use:
595 - power-of-2 values with IEC prefixes (e.g., KiB)
596 - power-of-10 values with SI prefixes (e.g., kB)
599 Compatibility mode (default). To avoid breaking old scripts:
601 - power-of-2 values with SI prefixes
602 - power-of-10 values with IEC prefixes
604 See :option:`bs` for more details on input parameters.
606 Outputs always use correct prefixes. Most outputs include both
609 bw=2383.3kB/s (2327.4KiB/s)
611 If only one value is reported, then kb_base selects the one to use:
613 **1000** -- SI prefixes
615 **1024** -- IEC prefixes
617 .. option:: unit_base=int
619 Base unit for reporting. Allowed values are:
622 Use auto-detection (default).
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.
638 .. option:: description=str
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.
643 .. option:: loops=int
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.
648 .. option:: numjobs=int
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.
658 Time related parameters
659 ~~~~~~~~~~~~~~~~~~~~~~~
661 .. option:: runtime=time
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.
668 .. option:: time_based
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.
674 .. option:: startdelay=irange(time)
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.
680 .. option:: ramp_time=time
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
690 .. option:: clocksource=str
692 Use the given clocksource as the base of timing. The supported options are:
695 :manpage:`gettimeofday(2)`
698 :manpage:`clock_gettime(2)`
701 Internal CPU clock source
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.
709 .. option:: gtod_reduce=bool
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.
718 .. option:: gtod_cpu=int
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.
734 .. option:: directory=str
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.
745 See the :option:`filename` option for information on how to escape "``:``" and
746 "``\``" characters within the directory path itself.
748 .. option:: filename=str
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`.
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``.
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).
772 The filename "`-`" is a reserved name, meaning *stdin* or *stdout*. Which
773 of the two depends on the read/write direction set.
775 .. option:: filename_format=str
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
785 The name of the worker thread or process.
787 The incremental number of the worker thread or process.
789 The incremental number of the file for that worker thread or
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.
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.
805 .. option:: unique_filename=bool
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.
811 .. option:: opendir=str
813 Recursively open any files below directory `str`.
815 .. option:: lockfile=str
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:
823 No locking. The default.
825 Only one thread or process may do I/O at a time, excluding all
828 Read-write locking on the file. Many readers may
829 access the file at the same time, but writes get exclusive access.
831 .. option:: nrfiles=int
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.
840 .. option:: openfiles=int
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
846 .. option:: file_service_type=str
848 Defines how fio decides which file from a job to service next. The following
852 Choose a file at random.
855 Round robin over opened files. This is the default.
858 Finish one file before moving on to the next. Multiple files can
859 still be open depending on :option:`openfiles`.
862 Use a *Zipf* distribution to decide what file to access.
865 Use a *Pareto* distribution to decide what file to access.
868 Use a *Gaussian* (normal) distribution to decide what file to
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.
882 .. option:: ioscheduler=str
884 Attempt to switch the device hosting the file to the specified I/O scheduler
887 .. option:: create_serialize=bool
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.
893 .. option:: create_fsync=bool
895 :manpage:`fsync(2)` the data file after creation. This is the default.
897 .. option:: create_on_open=bool
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
903 .. option:: create_only=bool
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.
909 .. option:: allow_file_create=bool
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.
915 .. option:: allow_mounted_write=bool
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.
923 .. option:: pre_read=bool
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.
932 .. option:: unlink=bool
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:
938 .. option:: unlink_each_loop=bool
940 Unlink job files after each iteration or loop. Default: false.
942 .. option:: zonesize=int
944 Divide a file into zones of the specified size. See :option:`zoneskip`.
946 .. option:: zonerange=int
948 Give size of an I/O zone. See :option:`zoneskip`.
950 .. option:: zoneskip=int
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.
959 .. option:: direct=bool
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.
965 .. option:: atomic=bool
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.
971 .. option:: buffered=bool
973 If value is true, use buffered I/O. This is the opposite of the
974 :option:`direct` option. Defaults to true.
976 .. option:: readwrite=str, rw=str
978 Type of I/O pattern. Accepted values are:
985 Sequential trims (Linux block devices only).
991 Random trims (Linux block devices only).
993 Sequential mixed reads and writes.
995 Random mixed reads and writes.
997 Sequential trim+write sequences. Blocks will be trimmed first,
998 then the same blocks will be written to.
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.
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.
1013 .. option:: rw_sequencer=str
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:
1020 Generate sequential offset.
1022 Generate the same offset.
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.
1033 .. option:: unified_rw_reporting=bool
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.
1039 .. option:: randrepeat=bool
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.
1044 .. option:: allrandrepeat=bool
1046 Seed all random number generators in a predictable way so results are
1047 repeatable across runs. Default: false.
1049 .. option:: randseed=int
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.
1055 .. option:: fallocate=str
1057 Whether pre-allocation is performed when laying down files.
1058 Accepted values are:
1061 Do not pre-allocate space.
1064 Use a platform's native pre-allocation call but fall back to
1065 **none** behavior if it fails/is not implemented.
1068 Pre-allocate via :manpage:`posix_fallocate(3)`.
1071 Pre-allocate via :manpage:`fallocate(2)` with
1072 FALLOC_FL_KEEP_SIZE set.
1075 Backward-compatible alias for **none**.
1078 Backward-compatible alias for **posix**.
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.
1085 .. option:: fadvise_hint=str
1087 Use :manpage:`posix_fadvise(2)` to advise the kernel on what I/O patterns
1088 are likely to be issued. Accepted values are:
1091 Backwards-compatible hint for "no hint".
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.
1099 Advise using **FADV_SEQUENTIAL**.
1102 Advise using **FADV_RANDOM**.
1104 .. option:: write_hint=str
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
1111 No particular life time associated with this file.
1114 Data written to this file has a short life time.
1117 Data written to this file has a medium life time.
1120 Data written to this file has a long life time.
1123 Data written to this file has a very long life time.
1125 The values are all relative to each other, and no absolute meaning
1126 should be associated with them.
1128 .. option:: offset=int
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 generated offset will be
1132 aligned to the minimum ``blocksize`` or to the value of ``offset_align`` if
1133 provided. Data before the given offset will not be touched. This
1134 effectively caps the file size at `real_size - offset`. Can be combined with
1135 :option:`size` to constrain the start and end range of the I/O workload.
1136 A percentage can be specified by a number between 1 and 100 followed by '%',
1137 for example, ``offset=20%`` to specify 20%.
1139 .. option:: offset_align=int
1141 If set to non-zero value, the byte offset generated by a percentage ``offset``
1142 is aligned upwards to this value. Defaults to 0 meaning that a percentage
1143 offset is aligned to the minimum block size.
1145 .. option:: offset_increment=int
1147 If this is provided, then the real offset becomes `offset + offset_increment
1148 * thread_number`, where the thread number is a counter that starts at 0 and
1149 is incremented for each sub-job (i.e. when :option:`numjobs` option is
1150 specified). This option is useful if there are several jobs which are
1151 intended to operate on a file in parallel disjoint segments, with even
1152 spacing between the starting points.
1154 .. option:: number_ios=int
1156 Fio will normally perform I/Os until it has exhausted the size of the region
1157 set by :option:`size`, or if it exhaust the allocated time (or hits an error
1158 condition). With this setting, the range/size can be set independently of
1159 the number of I/Os to perform. When fio reaches this number, it will exit
1160 normally and report status. Note that this does not extend the amount of I/O
1161 that will be done, it will only stop fio if this condition is met before
1162 other end-of-job criteria.
1164 .. option:: fsync=int
1166 If writing to a file, issue an :manpage:`fsync(2)` (or its equivalent) of
1167 the dirty data for every number of blocks given. For example, if you give 32
1168 as a parameter, fio will sync the file after every 32 writes issued. If fio is
1169 using non-buffered I/O, we may not sync the file. The exception is the sg
1170 I/O engine, which synchronizes the disk cache anyway. Defaults to 0, which
1171 means fio does not periodically issue and wait for a sync to complete. Also
1172 see :option:`end_fsync` and :option:`fsync_on_close`.
1174 .. option:: fdatasync=int
1176 Like :option:`fsync` but uses :manpage:`fdatasync(2)` to only sync data and
1177 not metadata blocks. In Windows, FreeBSD, and DragonFlyBSD there is no
1178 :manpage:`fdatasync(2)` so this falls back to using :manpage:`fsync(2)`.
1179 Defaults to 0, which means fio does not periodically issue and wait for a
1180 data-only sync to complete.
1182 .. option:: write_barrier=int
1184 Make every `N-th` write a barrier write.
1186 .. option:: sync_file_range=str:int
1188 Use :manpage:`sync_file_range(2)` for every `int` number of write
1189 operations. Fio will track range of writes that have happened since the last
1190 :manpage:`sync_file_range(2)` call. `str` can currently be one or more of:
1193 SYNC_FILE_RANGE_WAIT_BEFORE
1195 SYNC_FILE_RANGE_WRITE
1197 SYNC_FILE_RANGE_WAIT_AFTER
1199 So if you do ``sync_file_range=wait_before,write:8``, fio would use
1200 ``SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE`` for every 8
1201 writes. Also see the :manpage:`sync_file_range(2)` man page. This option is
1204 .. option:: overwrite=bool
1206 If true, writes to a file will always overwrite existing data. If the file
1207 doesn't already exist, it will be created before the write phase begins. If
1208 the file exists and is large enough for the specified write phase, nothing
1209 will be done. Default: false.
1211 .. option:: end_fsync=bool
1213 If true, :manpage:`fsync(2)` file contents when a write stage has completed.
1216 .. option:: fsync_on_close=bool
1218 If true, fio will :manpage:`fsync(2)` a dirty file on close. This differs
1219 from :option:`end_fsync` in that it will happen on every file close, not
1220 just at the end of the job. Default: false.
1222 .. option:: rwmixread=int
1224 Percentage of a mixed workload that should be reads. Default: 50.
1226 .. option:: rwmixwrite=int
1228 Percentage of a mixed workload that should be writes. If both
1229 :option:`rwmixread` and :option:`rwmixwrite` is given and the values do not
1230 add up to 100%, the latter of the two will be used to override the
1231 first. This may interfere with a given rate setting, if fio is asked to
1232 limit reads or writes to a certain rate. If that is the case, then the
1233 distribution may be skewed. Default: 50.
1235 .. option:: random_distribution=str:float[,str:float][,str:float]
1237 By default, fio will use a completely uniform random distribution when asked
1238 to perform random I/O. Sometimes it is useful to skew the distribution in
1239 specific ways, ensuring that some parts of the data is more hot than others.
1240 fio includes the following distribution models:
1243 Uniform random distribution
1252 Normal (Gaussian) distribution
1255 Zoned random distribution
1257 When using a **zipf** or **pareto** distribution, an input value is also
1258 needed to define the access pattern. For **zipf**, this is the `Zipf
1259 theta`. For **pareto**, it's the `Pareto power`. Fio includes a test
1260 program, :command:`fio-genzipf`, that can be used visualize what the given input
1261 values will yield in terms of hit rates. If you wanted to use **zipf** with
1262 a `theta` of 1.2, you would use ``random_distribution=zipf:1.2`` as the
1263 option. If a non-uniform model is used, fio will disable use of the random
1264 map. For the **normal** distribution, a normal (Gaussian) deviation is
1265 supplied as a value between 0 and 100.
1267 For a **zoned** distribution, fio supports specifying percentages of I/O
1268 access that should fall within what range of the file or device. For
1269 example, given a criteria of:
1271 * 60% of accesses should be to the first 10%
1272 * 30% of accesses should be to the next 20%
1273 * 8% of accesses should be to the next 30%
1274 * 2% of accesses should be to the next 40%
1276 we can define that through zoning of the random accesses. For the above
1277 example, the user would do::
1279 random_distribution=zoned:60/10:30/20:8/30:2/40
1281 similarly to how :option:`bssplit` works for setting ranges and percentages
1282 of block sizes. Like :option:`bssplit`, it's possible to specify separate
1283 zones for reads, writes, and trims. If just one set is given, it'll apply to
1286 .. option:: percentage_random=int[,int][,int]
1288 For a random workload, set how big a percentage should be random. This
1289 defaults to 100%, in which case the workload is fully random. It can be set
1290 from anywhere from 0 to 100. Setting it to 0 would make the workload fully
1291 sequential. Any setting in between will result in a random mix of sequential
1292 and random I/O, at the given percentages. Comma-separated values may be
1293 specified for reads, writes, and trims as described in :option:`blocksize`.
1295 .. option:: norandommap
1297 Normally fio will cover every block of the file when doing random I/O. If
1298 this option is given, fio will just get a new random offset without looking
1299 at past I/O history. This means that some blocks may not be read or written,
1300 and that some blocks may be read/written more than once. If this option is
1301 used with :option:`verify` and multiple blocksizes (via :option:`bsrange`),
1302 only intact blocks are verified, i.e., partially-overwritten blocks are
1305 .. option:: softrandommap=bool
1307 See :option:`norandommap`. If fio runs with the random block map enabled and
1308 it fails to allocate the map, if this option is set it will continue without
1309 a random block map. As coverage will not be as complete as with random maps,
1310 this option is disabled by default.
1312 .. option:: random_generator=str
1314 Fio supports the following engines for generating I/O offsets for random I/O:
1317 Strong 2^88 cycle random number generator.
1319 Linear feedback shift register generator.
1321 Strong 64-bit 2^258 cycle random number generator.
1323 **tausworthe** is a strong random number generator, but it requires tracking
1324 on the side if we want to ensure that blocks are only read or written
1325 once. **lfsr** guarantees that we never generate the same offset twice, and
1326 it's also less computationally expensive. It's not a true random generator,
1327 however, though for I/O purposes it's typically good enough. **lfsr** only
1328 works with single block sizes, not with workloads that use multiple block
1329 sizes. If used with such a workload, fio may read or write some blocks
1330 multiple times. The default value is **tausworthe**, unless the required
1331 space exceeds 2^32 blocks. If it does, then **tausworthe64** is
1332 selected automatically.
1338 .. option:: blocksize=int[,int][,int], bs=int[,int][,int]
1340 The block size in bytes used for I/O units. Default: 4096. A single value
1341 applies to reads, writes, and trims. Comma-separated values may be
1342 specified for reads, writes, and trims. A value not terminated in a comma
1343 applies to subsequent types.
1348 means 256k for reads, writes and trims.
1351 means 8k for reads, 32k for writes and trims.
1354 means 8k for reads, 32k for writes, and default for trims.
1357 means default for reads, 8k for writes and trims.
1360 means default for reads, 8k for writes, and default for trims.
1362 .. option:: blocksize_range=irange[,irange][,irange], bsrange=irange[,irange][,irange]
1364 A range of block sizes in bytes for I/O units. The issued I/O unit will
1365 always be a multiple of the minimum size, unless
1366 :option:`blocksize_unaligned` is set.
1368 Comma-separated ranges may be specified for reads, writes, and trims as
1369 described in :option:`blocksize`.
1371 Example: ``bsrange=1k-4k,2k-8k``.
1373 .. option:: bssplit=str[,str][,str]
1375 Sometimes you want even finer grained control of the block sizes issued, not
1376 just an even split between them. This option allows you to weight various
1377 block sizes, so that you are able to define a specific amount of block sizes
1378 issued. The format for this option is::
1380 bssplit=blocksize/percentage:blocksize/percentage
1382 for as many block sizes as needed. So if you want to define a workload that
1383 has 50% 64k blocks, 10% 4k blocks, and 40% 32k blocks, you would write::
1385 bssplit=4k/10:64k/50:32k/40
1387 Ordering does not matter. If the percentage is left blank, fio will fill in
1388 the remaining values evenly. So a bssplit option like this one::
1390 bssplit=4k/50:1k/:32k/
1392 would have 50% 4k ios, and 25% 1k and 32k ios. The percentages always add up
1393 to 100, if bssplit is given a range that adds up to more, it will error out.
1395 Comma-separated values may be specified for reads, writes, and trims as
1396 described in :option:`blocksize`.
1398 If you want a workload that has 50% 2k reads and 50% 4k reads, while having
1399 90% 4k writes and 10% 8k writes, you would specify::
1401 bssplit=2k/50:4k/50,4k/90,8k/10
1403 .. option:: blocksize_unaligned, bs_unaligned
1405 If set, fio will issue I/O units with any size within
1406 :option:`blocksize_range`, not just multiples of the minimum size. This
1407 typically won't work with direct I/O, as that normally requires sector
1410 .. option:: bs_is_seq_rand=bool
1412 If this option is set, fio will use the normal read,write blocksize settings
1413 as sequential,random blocksize settings instead. Any random read or write
1414 will use the WRITE blocksize settings, and any sequential read or write will
1415 use the READ blocksize settings.
1417 .. option:: blockalign=int[,int][,int], ba=int[,int][,int]
1419 Boundary to which fio will align random I/O units. Default:
1420 :option:`blocksize`. Minimum alignment is typically 512b for using direct
1421 I/O, though it usually depends on the hardware block size. This option is
1422 mutually exclusive with using a random map for files, so it will turn off
1423 that option. Comma-separated values may be specified for reads, writes, and
1424 trims as described in :option:`blocksize`.
1430 .. option:: zero_buffers
1432 Initialize buffers with all zeros. Default: fill buffers with random data.
1434 .. option:: refill_buffers
1436 If this option is given, fio will refill the I/O buffers on every
1437 submit. The default is to only fill it at init time and reuse that
1438 data. Only makes sense if zero_buffers isn't specified, naturally. If data
1439 verification is enabled, `refill_buffers` is also automatically enabled.
1441 .. option:: scramble_buffers=bool
1443 If :option:`refill_buffers` is too costly and the target is using data
1444 deduplication, then setting this option will slightly modify the I/O buffer
1445 contents to defeat normal de-dupe attempts. This is not enough to defeat
1446 more clever block compression attempts, but it will stop naive dedupe of
1447 blocks. Default: true.
1449 .. option:: buffer_compress_percentage=int
1451 If this is set, then fio will attempt to provide I/O buffer content (on
1452 WRITEs) that compresses to the specified level. Fio does this by providing a
1453 mix of random data and a fixed pattern. The fixed pattern is either zeros,
1454 or the pattern specified by :option:`buffer_pattern`. If the pattern option
1455 is used, it might skew the compression ratio slightly. Note that this is per
1456 block size unit, see :option:`buffer_compress_chunk` for setting a finer
1457 granularity of compression regions.
1459 .. option:: buffer_compress_chunk=int
1461 See :option:`buffer_compress_percentage`. This setting allows fio to manage
1462 how big the ranges of random data and zeroed data is. Without this set, fio
1463 will provide :option:`buffer_compress_percentage` of blocksize random data,
1464 followed by the remaining zeroed. With this set to some chunk size smaller
1465 than the block size, fio can alternate random and zeroed data throughout the
1466 I/O buffer. This is particularly useful when bigger block sizes are used
1467 for a job. Defaults to 512.
1469 .. option:: buffer_pattern=str
1471 If set, fio will fill the I/O buffers with this pattern or with the contents
1472 of a file. If not set, the contents of I/O buffers are defined by the other
1473 options related to buffer contents. The setting can be any pattern of bytes,
1474 and can be prefixed with 0x for hex values. It may also be a string, where
1475 the string must then be wrapped with ``""``. Or it may also be a filename,
1476 where the filename must be wrapped with ``''`` in which case the file is
1477 opened and read. Note that not all the file contents will be read if that
1478 would cause the buffers to overflow. So, for example::
1480 buffer_pattern='filename'
1484 buffer_pattern="abcd"
1492 buffer_pattern=0xdeadface
1494 Also you can combine everything together in any order::
1496 buffer_pattern=0xdeadface"abcd"-12'filename'
1498 .. option:: dedupe_percentage=int
1500 If set, fio will generate this percentage of identical buffers when
1501 writing. These buffers will be naturally dedupable. The contents of the
1502 buffers depend on what other buffer compression settings have been set. It's
1503 possible to have the individual buffers either fully compressible, or not at
1504 all. This option only controls the distribution of unique buffers.
1506 .. option:: invalidate=bool
1508 Invalidate the buffer/page cache parts of the files to be used prior to
1509 starting I/O if the platform and file type support it. Defaults to true.
1510 This will be ignored if :option:`pre_read` is also specified for the
1513 .. option:: sync=bool
1515 Use synchronous I/O for buffered writes. For the majority of I/O engines,
1516 this means using O_SYNC. Default: false.
1518 .. option:: iomem=str, mem=str
1520 Fio can use various types of memory as the I/O unit buffer. The allowed
1524 Use memory from :manpage:`malloc(3)` as the buffers. Default memory
1528 Use shared memory as the buffers. Allocated through
1529 :manpage:`shmget(2)`.
1532 Same as shm, but use huge pages as backing.
1535 Use :manpage:`mmap(2)` to allocate buffers. May either be anonymous memory, or can
1536 be file backed if a filename is given after the option. The format
1537 is `mem=mmap:/path/to/file`.
1540 Use a memory mapped huge file as the buffer backing. Append filename
1541 after mmaphuge, ala `mem=mmaphuge:/hugetlbfs/file`.
1544 Same as mmap, but use a MMAP_SHARED mapping.
1547 Use GPU memory as the buffers for GPUDirect RDMA benchmark.
1548 The :option:`ioengine` must be `rdma`.
1550 The area allocated is a function of the maximum allowed bs size for the job,
1551 multiplied by the I/O depth given. Note that for **shmhuge** and
1552 **mmaphuge** to work, the system must have free huge pages allocated. This
1553 can normally be checked and set by reading/writing
1554 :file:`/proc/sys/vm/nr_hugepages` on a Linux system. Fio assumes a huge page
1555 is 4MiB in size. So to calculate the number of huge pages you need for a
1556 given job file, add up the I/O depth of all jobs (normally one unless
1557 :option:`iodepth` is used) and multiply by the maximum bs set. Then divide
1558 that number by the huge page size. You can see the size of the huge pages in
1559 :file:`/proc/meminfo`. If no huge pages are allocated by having a non-zero
1560 number in `nr_hugepages`, using **mmaphuge** or **shmhuge** will fail. Also
1561 see :option:`hugepage-size`.
1563 **mmaphuge** also needs to have hugetlbfs mounted and the file location
1564 should point there. So if it's mounted in :file:`/huge`, you would use
1565 `mem=mmaphuge:/huge/somefile`.
1567 .. option:: iomem_align=int, mem_align=int
1569 This indicates the memory alignment of the I/O memory buffers. Note that
1570 the given alignment is applied to the first I/O unit buffer, if using
1571 :option:`iodepth` the alignment of the following buffers are given by the
1572 :option:`bs` used. In other words, if using a :option:`bs` that is a
1573 multiple of the page sized in the system, all buffers will be aligned to
1574 this value. If using a :option:`bs` that is not page aligned, the alignment
1575 of subsequent I/O memory buffers is the sum of the :option:`iomem_align` and
1578 .. option:: hugepage-size=int
1580 Defines the size of a huge page. Must at least be equal to the system
1581 setting, see :file:`/proc/meminfo`. Defaults to 4MiB. Should probably
1582 always be a multiple of megabytes, so using ``hugepage-size=Xm`` is the
1583 preferred way to set this to avoid setting a non-pow-2 bad value.
1585 .. option:: lockmem=int
1587 Pin the specified amount of memory with :manpage:`mlock(2)`. Can be used to
1588 simulate a smaller amount of memory. The amount specified is per worker.
1594 .. option:: size=int
1596 The total size of file I/O for each thread of this job. Fio will run until
1597 this many bytes has been transferred, unless runtime is limited by other options
1598 (such as :option:`runtime`, for instance, or increased/decreased by :option:`io_size`).
1599 Fio will divide this size between the available files determined by options
1600 such as :option:`nrfiles`, :option:`filename`, unless :option:`filesize` is
1601 specified by the job. If the result of division happens to be 0, the size is
1602 set to the physical size of the given files or devices if they exist.
1603 If this option is not specified, fio will use the full size of the given
1604 files or devices. If the files do not exist, size must be given. It is also
1605 possible to give size as a percentage between 1 and 100. If ``size=20%`` is
1606 given, fio will use 20% of the full size of the given files or devices.
1607 Can be combined with :option:`offset` to constrain the start and end range
1608 that I/O will be done within.
1610 .. option:: io_size=int, io_limit=int
1612 Normally fio operates within the region set by :option:`size`, which means
1613 that the :option:`size` option sets both the region and size of I/O to be
1614 performed. Sometimes that is not what you want. With this option, it is
1615 possible to define just the amount of I/O that fio should do. For instance,
1616 if :option:`size` is set to 20GiB and :option:`io_size` is set to 5GiB, fio
1617 will perform I/O within the first 20GiB but exit when 5GiB have been
1618 done. The opposite is also possible -- if :option:`size` is set to 20GiB,
1619 and :option:`io_size` is set to 40GiB, then fio will do 40GiB of I/O within
1620 the 0..20GiB region.
1622 .. option:: filesize=irange(int)
1624 Individual file sizes. May be a range, in which case fio will select sizes
1625 for files at random within the given range and limited to :option:`size` in
1626 total (if that is given). If not given, each created file is the same size.
1627 This option overrides :option:`size` in terms of file size, which means
1628 this value is used as a fixed size or possible range of each file.
1630 .. option:: file_append=bool
1632 Perform I/O after the end of the file. Normally fio will operate within the
1633 size of a file. If this option is set, then fio will append to the file
1634 instead. This has identical behavior to setting :option:`offset` to the size
1635 of a file. This option is ignored on non-regular files.
1637 .. option:: fill_device=bool, fill_fs=bool
1639 Sets size to something really large and waits for ENOSPC (no space left on
1640 device) as the terminating condition. Only makes sense with sequential
1641 write. For a read workload, the mount point will be filled first then I/O
1642 started on the result. This option doesn't make sense if operating on a raw
1643 device node, since the size of that is already known by the file system.
1644 Additionally, writing beyond end-of-device will not return ENOSPC there.
1650 .. option:: ioengine=str
1652 Defines how the job issues I/O to the file. The following types are defined:
1655 Basic :manpage:`read(2)` or :manpage:`write(2)`
1656 I/O. :manpage:`lseek(2)` is used to position the I/O location.
1657 See :option:`fsync` and :option:`fdatasync` for syncing write I/Os.
1660 Basic :manpage:`pread(2)` or :manpage:`pwrite(2)` I/O. Default on
1661 all supported operating systems except for Windows.
1664 Basic :manpage:`readv(2)` or :manpage:`writev(2)` I/O. Will emulate
1665 queuing by coalescing adjacent I/Os into a single submission.
1668 Basic :manpage:`preadv(2)` or :manpage:`pwritev(2)` I/O.
1671 Basic :manpage:`preadv2(2)` or :manpage:`pwritev2(2)` I/O.
1674 Linux native asynchronous I/O. Note that Linux may only support
1675 queued behavior with non-buffered I/O (set ``direct=1`` or
1677 This engine defines engine specific options.
1680 POSIX asynchronous I/O using :manpage:`aio_read(3)` and
1681 :manpage:`aio_write(3)`.
1684 Solaris native asynchronous I/O.
1687 Windows native asynchronous I/O. Default on Windows.
1690 File is memory mapped with :manpage:`mmap(2)` and data copied
1691 to/from using :manpage:`memcpy(3)`.
1694 :manpage:`splice(2)` is used to transfer the data and
1695 :manpage:`vmsplice(2)` to transfer data from user space to the
1699 SCSI generic sg v3 I/O. May either be synchronous using the SG_IO
1700 ioctl, or if the target is an sg character device we use
1701 :manpage:`read(2)` and :manpage:`write(2)` for asynchronous
1702 I/O. Requires :option:`filename` option to specify either block or
1706 Doesn't transfer any data, just pretends to. This is mainly used to
1707 exercise fio itself and for debugging/testing purposes.
1710 Transfer over the network to given ``host:port``. Depending on the
1711 :option:`protocol` used, the :option:`hostname`, :option:`port`,
1712 :option:`listen` and :option:`filename` options are used to specify
1713 what sort of connection to make, while the :option:`protocol` option
1714 determines which protocol will be used. This engine defines engine
1718 Like **net**, but uses :manpage:`splice(2)` and
1719 :manpage:`vmsplice(2)` to map data and send/receive.
1720 This engine defines engine specific options.
1723 Doesn't transfer any data, but burns CPU cycles according to the
1724 :option:`cpuload` and :option:`cpuchunks` options. Setting
1725 :option:`cpuload`\=85 will cause that job to do nothing but burn 85%
1726 of the CPU. In case of SMP machines, use :option:`numjobs`\=<nr_of_cpu>
1727 to get desired CPU usage, as the cpuload only loads a
1728 single CPU at the desired rate. A job never finishes unless there is
1729 at least one non-cpuio job.
1732 The GUASI I/O engine is the Generic Userspace Asyncronous Syscall
1733 Interface approach to async I/O. See
1735 http://www.xmailserver.org/guasi-lib.html
1737 for more info on GUASI.
1740 The RDMA I/O engine supports both RDMA memory semantics
1741 (RDMA_WRITE/RDMA_READ) and channel semantics (Send/Recv) for the
1742 InfiniBand, RoCE and iWARP protocols.
1745 I/O engine that does regular fallocate to simulate data transfer as
1749 does fallocate(,mode = FALLOC_FL_KEEP_SIZE,).
1752 does fallocate(,mode = 0).
1755 does fallocate(,mode = FALLOC_FL_KEEP_SIZE|FALLOC_FL_PUNCH_HOLE).
1758 I/O engine that sends :manpage:`ftruncate(2)` operations in response
1759 to write (DDIR_WRITE) events. Each ftruncate issued sets the file's
1760 size to the current block offset. :option:`blocksize` is ignored.
1763 I/O engine that does regular EXT4_IOC_MOVE_EXT ioctls to simulate
1764 defragment activity in request to DDIR_WRITE event.
1767 I/O engine supporting direct access to Ceph Rados Block Devices
1768 (RBD) via librbd without the need to use the kernel rbd driver. This
1769 ioengine defines engine specific options.
1772 Using GlusterFS libgfapi sync interface to direct access to
1773 GlusterFS volumes without having to go through FUSE. This ioengine
1774 defines engine specific options.
1777 Using GlusterFS libgfapi async interface to direct access to
1778 GlusterFS volumes without having to go through FUSE. This ioengine
1779 defines engine specific options.
1782 Read and write through Hadoop (HDFS). The :option:`filename` option
1783 is used to specify host,port of the hdfs name-node to connect. This
1784 engine interprets offsets a little differently. In HDFS, files once
1785 created cannot be modified so random writes are not possible. To
1786 imitate this the libhdfs engine expects a bunch of small files to be
1787 created over HDFS and will randomly pick a file from them
1788 based on the offset generated by fio backend (see the example
1789 job file to create such files, use ``rw=write`` option). Please
1790 note, it may be necessary to set environment variables to work
1791 with HDFS/libhdfs properly. Each job uses its own connection to
1795 Read, write and erase an MTD character device (e.g.,
1796 :file:`/dev/mtd0`). Discards are treated as erases. Depending on the
1797 underlying device type, the I/O may have to go in a certain pattern,
1798 e.g., on NAND, writing sequentially to erase blocks and discarding
1799 before overwriting. The `trimwrite` mode works well for this
1803 Read and write using filesystem DAX to a file on a filesystem
1804 mounted with DAX on a persistent memory device through the NVML
1808 Read and write using device DAX to a persistent memory device (e.g.,
1809 /dev/dax0.0) through the NVML libpmem library.
1812 Prefix to specify loading an external I/O engine object file. Append
1813 the engine filename, e.g. ``ioengine=external:/tmp/foo.o`` to load
1814 ioengine :file:`foo.o` in :file:`/tmp`. The path can be either
1815 absolute or relative. See :file:`engines/skeleton_external.c` for
1816 details of writing an external I/O engine.
1819 Simply create the files and do no I/O to them. You still need to
1820 set `filesize` so that all the accounting still occurs, but no
1821 actual I/O will be done other than creating the file.
1823 I/O engine specific parameters
1824 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1826 In addition, there are some parameters which are only valid when a specific
1827 :option:`ioengine` is in use. These are used identically to normal parameters,
1828 with the caveat that when used on the command line, they must come after the
1829 :option:`ioengine` that defines them is selected.
1831 .. option:: userspace_reap : [libaio]
1833 Normally, with the libaio engine in use, fio will use the
1834 :manpage:`io_getevents(2)` system call to reap newly returned events. With
1835 this flag turned on, the AIO ring will be read directly from user-space to
1836 reap events. The reaping mode is only enabled when polling for a minimum of
1837 0 events (e.g. when :option:`iodepth_batch_complete` `=0`).
1839 .. option:: hipri : [pvsync2]
1841 Set RWF_HIPRI on I/O, indicating to the kernel that it's of higher priority
1844 .. option:: hipri_percentage : [pvsync2]
1846 When hipri is set this determines the probability of a pvsync2 I/O being high
1847 priority. The default is 100%.
1849 .. option:: cpuload=int : [cpuio]
1851 Attempt to use the specified percentage of CPU cycles. This is a mandatory
1852 option when using cpuio I/O engine.
1854 .. option:: cpuchunks=int : [cpuio]
1856 Split the load into cycles of the given time. In microseconds.
1858 .. option:: exit_on_io_done=bool : [cpuio]
1860 Detect when I/O threads are done, then exit.
1862 .. option:: namenode=str : [libhdfs]
1864 The hostname or IP address of a HDFS cluster namenode to contact.
1866 .. option:: port=int
1870 The listening port of the HFDS cluster namenode.
1874 The TCP or UDP port to bind to or connect to. If this is used with
1875 :option:`numjobs` to spawn multiple instances of the same job type, then
1876 this will be the starting port number since fio will use a range of
1879 .. option:: hostname=str : [netsplice] [net]
1881 The hostname or IP address to use for TCP or UDP based I/O. If the job is
1882 a TCP listener or UDP reader, the hostname is not used and must be omitted
1883 unless it is a valid UDP multicast address.
1885 .. option:: interface=str : [netsplice] [net]
1887 The IP address of the network interface used to send or receive UDP
1890 .. option:: ttl=int : [netsplice] [net]
1892 Time-to-live value for outgoing UDP multicast packets. Default: 1.
1894 .. option:: nodelay=bool : [netsplice] [net]
1896 Set TCP_NODELAY on TCP connections.
1898 .. option:: protocol=str, proto=str : [netsplice] [net]
1900 The network protocol to use. Accepted values are:
1903 Transmission control protocol.
1905 Transmission control protocol V6.
1907 User datagram protocol.
1909 User datagram protocol V6.
1913 When the protocol is TCP or UDP, the port must also be given, as well as the
1914 hostname if the job is a TCP listener or UDP reader. For unix sockets, the
1915 normal :option:`filename` option should be used and the port is invalid.
1917 .. option:: listen : [netsplice] [net]
1919 For TCP network connections, tell fio to listen for incoming connections
1920 rather than initiating an outgoing connection. The :option:`hostname` must
1921 be omitted if this option is used.
1923 .. option:: pingpong : [netsplice] [net]
1925 Normally a network writer will just continue writing data, and a network
1926 reader will just consume packages. If ``pingpong=1`` is set, a writer will
1927 send its normal payload to the reader, then wait for the reader to send the
1928 same payload back. This allows fio to measure network latencies. The
1929 submission and completion latencies then measure local time spent sending or
1930 receiving, and the completion latency measures how long it took for the
1931 other end to receive and send back. For UDP multicast traffic
1932 ``pingpong=1`` should only be set for a single reader when multiple readers
1933 are listening to the same address.
1935 .. option:: window_size : [netsplice] [net]
1937 Set the desired socket buffer size for the connection.
1939 .. option:: mss : [netsplice] [net]
1941 Set the TCP maximum segment size (TCP_MAXSEG).
1943 .. option:: donorname=str : [e4defrag]
1945 File will be used as a block donor (swap extents between files).
1947 .. option:: inplace=int : [e4defrag]
1949 Configure donor file blocks allocation strategy:
1952 Default. Preallocate donor's file on init.
1954 Allocate space immediately inside defragment event, and free right
1957 .. option:: clustername=str : [rbd]
1959 Specifies the name of the Ceph cluster.
1961 .. option:: rbdname=str : [rbd]
1963 Specifies the name of the RBD.
1965 .. option:: pool=str : [rbd]
1967 Specifies the name of the Ceph pool containing RBD.
1969 .. option:: clientname=str : [rbd]
1971 Specifies the username (without the 'client.' prefix) used to access the
1972 Ceph cluster. If the *clustername* is specified, the *clientname* shall be
1973 the full *type.id* string. If no type. prefix is given, fio will add
1974 'client.' by default.
1976 .. option:: skip_bad=bool : [mtd]
1978 Skip operations against known bad blocks.
1980 .. option:: hdfsdirectory : [libhdfs]
1982 libhdfs will create chunk in this HDFS directory.
1984 .. option:: chunk_size : [libhdfs]
1986 The size of the chunk to use for each file.
1992 .. option:: iodepth=int
1994 Number of I/O units to keep in flight against the file. Note that
1995 increasing *iodepth* beyond 1 will not affect synchronous ioengines (except
1996 for small degrees when :option:`verify_async` is in use). Even async
1997 engines may impose OS restrictions causing the desired depth not to be
1998 achieved. This may happen on Linux when using libaio and not setting
1999 :option:`direct`\=1, since buffered I/O is not async on that OS. Keep an
2000 eye on the I/O depth distribution in the fio output to verify that the
2001 achieved depth is as expected. Default: 1.
2003 .. option:: iodepth_batch_submit=int, iodepth_batch=int
2005 This defines how many pieces of I/O to submit at once. It defaults to 1
2006 which means that we submit each I/O as soon as it is available, but can be
2007 raised to submit bigger batches of I/O at the time. If it is set to 0 the
2008 :option:`iodepth` value will be used.
2010 .. option:: iodepth_batch_complete_min=int, iodepth_batch_complete=int
2012 This defines how many pieces of I/O to retrieve at once. It defaults to 1
2013 which means that we'll ask for a minimum of 1 I/O in the retrieval process
2014 from the kernel. The I/O retrieval will go on until we hit the limit set by
2015 :option:`iodepth_low`. If this variable is set to 0, then fio will always
2016 check for completed events before queuing more I/O. This helps reduce I/O
2017 latency, at the cost of more retrieval system calls.
2019 .. option:: iodepth_batch_complete_max=int
2021 This defines maximum pieces of I/O to retrieve at once. This variable should
2022 be used along with :option:`iodepth_batch_complete_min`\=int variable,
2023 specifying the range of min and max amount of I/O which should be
2024 retrieved. By default it is equal to the :option:`iodepth_batch_complete_min`
2029 iodepth_batch_complete_min=1
2030 iodepth_batch_complete_max=<iodepth>
2032 which means that we will retrieve at least 1 I/O and up to the whole
2033 submitted queue depth. If none of I/O has been completed yet, we will wait.
2037 iodepth_batch_complete_min=0
2038 iodepth_batch_complete_max=<iodepth>
2040 which means that we can retrieve up to the whole submitted queue depth, but
2041 if none of I/O has been completed yet, we will NOT wait and immediately exit
2042 the system call. In this example we simply do polling.
2044 .. option:: iodepth_low=int
2046 The low water mark indicating when to start filling the queue
2047 again. Defaults to the same as :option:`iodepth`, meaning that fio will
2048 attempt to keep the queue full at all times. If :option:`iodepth` is set to
2049 e.g. 16 and *iodepth_low* is set to 4, then after fio has filled the queue of
2050 16 requests, it will let the depth drain down to 4 before starting to fill
2053 .. option:: serialize_overlap=bool
2055 Serialize in-flight I/Os that might otherwise cause or suffer from data races.
2056 When two or more I/Os are submitted simultaneously, there is no guarantee that
2057 the I/Os will be processed or completed in the submitted order. Further, if
2058 two or more of those I/Os are writes, any overlapping region between them can
2059 become indeterminate/undefined on certain storage. These issues can cause
2060 verification to fail erratically when at least one of the racing I/Os is
2061 changing data and the overlapping region has a non-zero size. Setting
2062 ``serialize_overlap`` tells fio to avoid provoking this behavior by explicitly
2063 serializing in-flight I/Os that have a non-zero overlap. Note that setting
2064 this option can reduce both performance and the :option:`iodepth` achieved.
2065 Additionally this option does not work when :option:`io_submit_mode` is set to
2066 offload. Default: false.
2068 .. option:: io_submit_mode=str
2070 This option controls how fio submits the I/O to the I/O engine. The default
2071 is `inline`, which means that the fio job threads submit and reap I/O
2072 directly. If set to `offload`, the job threads will offload I/O submission
2073 to a dedicated pool of I/O threads. This requires some coordination and thus
2074 has a bit of extra overhead, especially for lower queue depth I/O where it
2075 can increase latencies. The benefit is that fio can manage submission rates
2076 independently of the device completion rates. This avoids skewed latency
2077 reporting if I/O gets backed up on the device side (the coordinated omission
2084 .. option:: thinktime=time
2086 Stall the job for the specified period of time after an I/O has completed before issuing the
2087 next. May be used to simulate processing being done by an application.
2088 When the unit is omitted, the value is interpreted in microseconds. See
2089 :option:`thinktime_blocks` and :option:`thinktime_spin`.
2091 .. option:: thinktime_spin=time
2093 Only valid if :option:`thinktime` is set - pretend to spend CPU time doing
2094 something with the data received, before falling back to sleeping for the
2095 rest of the period specified by :option:`thinktime`. When the unit is
2096 omitted, the value is interpreted in microseconds.
2098 .. option:: thinktime_blocks=int
2100 Only valid if :option:`thinktime` is set - control how many blocks to issue,
2101 before waiting :option:`thinktime` usecs. If not set, defaults to 1 which will make
2102 fio wait :option:`thinktime` usecs after every block. This effectively makes any
2103 queue depth setting redundant, since no more than 1 I/O will be queued
2104 before we have to complete it and do our :option:`thinktime`. In other words, this
2105 setting effectively caps the queue depth if the latter is larger.
2107 .. option:: rate=int[,int][,int]
2109 Cap the bandwidth used by this job. The number is in bytes/sec, the normal
2110 suffix rules apply. Comma-separated values may be specified for reads,
2111 writes, and trims as described in :option:`blocksize`.
2113 For example, using `rate=1m,500k` would limit reads to 1MiB/sec and writes to
2114 500KiB/sec. Capping only reads or writes can be done with `rate=,500k` or
2115 `rate=500k,` where the former will only limit writes (to 500KiB/sec) and the
2116 latter will only limit reads.
2118 .. option:: rate_min=int[,int][,int]
2120 Tell fio to do whatever it can to maintain at least this bandwidth. Failing
2121 to meet this requirement will cause the job to exit. Comma-separated values
2122 may be specified for reads, writes, and trims as described in
2123 :option:`blocksize`.
2125 .. option:: rate_iops=int[,int][,int]
2127 Cap the bandwidth to this number of IOPS. Basically the same as
2128 :option:`rate`, just specified independently of bandwidth. If the job is
2129 given a block size range instead of a fixed value, the smallest block size
2130 is used as the metric. Comma-separated values may be specified for reads,
2131 writes, and trims as described in :option:`blocksize`.
2133 .. option:: rate_iops_min=int[,int][,int]
2135 If fio doesn't meet this rate of I/O, it will cause the job to exit.
2136 Comma-separated values may be specified for reads, writes, and trims as
2137 described in :option:`blocksize`.
2139 .. option:: rate_process=str
2141 This option controls how fio manages rated I/O submissions. The default is
2142 `linear`, which submits I/O in a linear fashion with fixed delays between
2143 I/Os that gets adjusted based on I/O completion rates. If this is set to
2144 `poisson`, fio will submit I/O based on a more real world random request
2145 flow, known as the Poisson process
2146 (https://en.wikipedia.org/wiki/Poisson_point_process). The lambda will be
2147 10^6 / IOPS for the given workload.
2153 .. option:: latency_target=time
2155 If set, fio will attempt to find the max performance point that the given
2156 workload will run at while maintaining a latency below this target. When
2157 the unit is omitted, the value is interpreted in microseconds. See
2158 :option:`latency_window` and :option:`latency_percentile`.
2160 .. option:: latency_window=time
2162 Used with :option:`latency_target` to specify the sample window that the job
2163 is run at varying queue depths to test the performance. When the unit is
2164 omitted, the value is interpreted in microseconds.
2166 .. option:: latency_percentile=float
2168 The percentage of I/Os that must fall within the criteria specified by
2169 :option:`latency_target` and :option:`latency_window`. If not set, this
2170 defaults to 100.0, meaning that all I/Os must be equal or below to the value
2171 set by :option:`latency_target`.
2173 .. option:: max_latency=time
2175 If set, fio will exit the job with an ETIMEDOUT error if it exceeds this
2176 maximum latency. When the unit is omitted, the value is interpreted in
2179 .. option:: rate_cycle=int
2181 Average bandwidth for :option:`rate` and :option:`rate_min` over this number
2182 of milliseconds. Defaults to 1000.
2188 .. option:: write_iolog=str
2190 Write the issued I/O patterns to the specified file. See
2191 :option:`read_iolog`. Specify a separate file for each job, otherwise the
2192 iologs will be interspersed and the file may be corrupt.
2194 .. option:: read_iolog=str
2196 Open an iolog with the specified filename and replay the I/O patterns it
2197 contains. This can be used to store a workload and replay it sometime
2198 later. The iolog given may also be a blktrace binary file, which allows fio
2199 to replay a workload captured by :command:`blktrace`. See
2200 :manpage:`blktrace(8)` for how to capture such logging data. For blktrace
2201 replay, the file needs to be turned into a blkparse binary data file first
2202 (``blkparse <device> -o /dev/null -d file_for_fio.bin``).
2204 .. option:: replay_no_stall=bool
2206 When replaying I/O with :option:`read_iolog` the default behavior is to
2207 attempt to respect the timestamps within the log and replay them with the
2208 appropriate delay between IOPS. By setting this variable fio will not
2209 respect the timestamps and attempt to replay them as fast as possible while
2210 still respecting ordering. The result is the same I/O pattern to a given
2211 device, but different timings.
2213 .. option:: replay_redirect=str
2215 While replaying I/O patterns using :option:`read_iolog` the default behavior
2216 is to replay the IOPS onto the major/minor device that each IOP was recorded
2217 from. This is sometimes undesirable because on a different machine those
2218 major/minor numbers can map to a different device. Changing hardware on the
2219 same system can also result in a different major/minor mapping.
2220 ``replay_redirect`` causes all I/Os to be replayed onto the single specified
2221 device regardless of the device it was recorded
2222 from. i.e. :option:`replay_redirect`\= :file:`/dev/sdc` would cause all I/O
2223 in the blktrace or iolog to be replayed onto :file:`/dev/sdc`. This means
2224 multiple devices will be replayed onto a single device, if the trace
2225 contains multiple devices. If you want multiple devices to be replayed
2226 concurrently to multiple redirected devices you must blkparse your trace
2227 into separate traces and replay them with independent fio invocations.
2228 Unfortunately this also breaks the strict time ordering between multiple
2231 .. option:: replay_align=int
2233 Force alignment of I/O offsets and lengths in a trace to this power of 2
2236 .. option:: replay_scale=int
2238 Scale sector offsets down by this factor when replaying traces.
2241 Threads, processes and job synchronization
2242 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2246 Fio defaults to creating jobs by using fork, however if this option is
2247 given, fio will create jobs by using POSIX Threads' function
2248 :manpage:`pthread_create(3)` to create threads instead.
2250 .. option:: wait_for=str
2252 If set, the current job won't be started until all workers of the specified
2253 waitee job are done.
2255 ``wait_for`` operates on the job name basis, so there are a few
2256 limitations. First, the waitee must be defined prior to the waiter job
2257 (meaning no forward references). Second, if a job is being referenced as a
2258 waitee, it must have a unique name (no duplicate waitees).
2260 .. option:: nice=int
2262 Run the job with the given nice value. See man :manpage:`nice(2)`.
2264 On Windows, values less than -15 set the process class to "High"; -1 through
2265 -15 set "Above Normal"; 1 through 15 "Below Normal"; and above 15 "Idle"
2268 .. option:: prio=int
2270 Set the I/O priority value of this job. Linux limits us to a positive value
2271 between 0 and 7, with 0 being the highest. See man
2272 :manpage:`ionice(1)`. Refer to an appropriate manpage for other operating
2273 systems since meaning of priority may differ.
2275 .. option:: prioclass=int
2277 Set the I/O priority class. See man :manpage:`ionice(1)`.
2279 .. option:: cpumask=int
2281 Set the CPU affinity of this job. The parameter given is a bit mask of
2282 allowed CPUs the job may run on. So if you want the allowed CPUs to be 1
2283 and 5, you would pass the decimal value of (1 << 1 | 1 << 5), or 34. See man
2284 :manpage:`sched_setaffinity(2)`. This may not work on all supported
2285 operating systems or kernel versions. This option doesn't work well for a
2286 higher CPU count than what you can store in an integer mask, so it can only
2287 control cpus 1-32. For boxes with larger CPU counts, use
2288 :option:`cpus_allowed`.
2290 .. option:: cpus_allowed=str
2292 Controls the same options as :option:`cpumask`, but accepts a textual
2293 specification of the permitted CPUs instead. So to use CPUs 1 and 5 you
2294 would specify ``cpus_allowed=1,5``. This option also allows a range of CPUs
2295 to be specified -- say you wanted a binding to CPUs 1, 5, and 8 to 15, you
2296 would set ``cpus_allowed=1,5,8-15``.
2298 .. option:: cpus_allowed_policy=str
2300 Set the policy of how fio distributes the CPUs specified by
2301 :option:`cpus_allowed` or :option:`cpumask`. Two policies are supported:
2304 All jobs will share the CPU set specified.
2306 Each job will get a unique CPU from the CPU set.
2308 **shared** is the default behavior, if the option isn't specified. If
2309 **split** is specified, then fio will will assign one cpu per job. If not
2310 enough CPUs are given for the jobs listed, then fio will roundrobin the CPUs
2313 .. option:: numa_cpu_nodes=str
2315 Set this job running on specified NUMA nodes' CPUs. The arguments allow
2316 comma delimited list of cpu numbers, A-B ranges, or `all`. Note, to enable
2317 NUMA options support, fio must be built on a system with libnuma-dev(el)
2320 .. option:: numa_mem_policy=str
2322 Set this job's memory policy and corresponding NUMA nodes. Format of the
2327 ``mode`` is one of the following memory poicies: ``default``, ``prefer``,
2328 ``bind``, ``interleave`` or ``local``. For ``default`` and ``local`` memory
2329 policies, no node needs to be specified. For ``prefer``, only one node is
2330 allowed. For ``bind`` and ``interleave`` the ``nodelist`` may be as
2331 follows: a comma delimited list of numbers, A-B ranges, or `all`.
2333 .. option:: cgroup=str
2335 Add job to this control group. If it doesn't exist, it will be created. The
2336 system must have a mounted cgroup blkio mount point for this to work. If
2337 your system doesn't have it mounted, you can do so with::
2339 # mount -t cgroup -o blkio none /cgroup
2341 .. option:: cgroup_weight=int
2343 Set the weight of the cgroup to this value. See the documentation that comes
2344 with the kernel, allowed values are in the range of 100..1000.
2346 .. option:: cgroup_nodelete=bool
2348 Normally fio will delete the cgroups it has created after the job
2349 completion. To override this behavior and to leave cgroups around after the
2350 job completion, set ``cgroup_nodelete=1``. This can be useful if one wants
2351 to inspect various cgroup files after job completion. Default: false.
2353 .. option:: flow_id=int
2355 The ID of the flow. If not specified, it defaults to being a global
2356 flow. See :option:`flow`.
2358 .. option:: flow=int
2360 Weight in token-based flow control. If this value is used, then there is a
2361 'flow counter' which is used to regulate the proportion of activity between
2362 two or more jobs. Fio attempts to keep this flow counter near zero. The
2363 ``flow`` parameter stands for how much should be added or subtracted to the
2364 flow counter on each iteration of the main I/O loop. That is, if one job has
2365 ``flow=8`` and another job has ``flow=-1``, then there will be a roughly 1:8
2366 ratio in how much one runs vs the other.
2368 .. option:: flow_watermark=int
2370 The maximum value that the absolute value of the flow counter is allowed to
2371 reach before the job must wait for a lower value of the counter.
2373 .. option:: flow_sleep=int
2375 The period of time, in microseconds, to wait after the flow watermark has
2376 been exceeded before retrying operations.
2378 .. option:: stonewall, wait_for_previous
2380 Wait for preceding jobs in the job file to exit, before starting this
2381 one. Can be used to insert serialization points in the job file. A stone
2382 wall also implies starting a new reporting group, see
2383 :option:`group_reporting`.
2387 By default, fio will continue running all other jobs when one job finishes
2388 but sometimes this is not the desired action. Setting ``exitall`` will
2389 instead make fio terminate all other jobs when one job finishes.
2391 .. option:: exec_prerun=str
2393 Before running this job, issue the command specified through
2394 :manpage:`system(3)`. Output is redirected in a file called
2395 :file:`jobname.prerun.txt`.
2397 .. option:: exec_postrun=str
2399 After the job completes, issue the command specified though
2400 :manpage:`system(3)`. Output is redirected in a file called
2401 :file:`jobname.postrun.txt`.
2405 Instead of running as the invoking user, set the user ID to this value
2406 before the thread/process does any work.
2410 Set group ID, see :option:`uid`.
2416 .. option:: verify_only
2418 Do not perform specified workload, only verify data still matches previous
2419 invocation of this workload. This option allows one to check data multiple
2420 times at a later date without overwriting it. This option makes sense only
2421 for workloads that write data, and does not support workloads with the
2422 :option:`time_based` option set.
2424 .. option:: do_verify=bool
2426 Run the verify phase after a write phase. Only valid if :option:`verify` is
2429 .. option:: verify=str
2431 If writing to a file, fio can verify the file contents after each iteration
2432 of the job. Each verification method also implies verification of special
2433 header, which is written to the beginning of each block. This header also
2434 includes meta information, like offset of the block, block number, timestamp
2435 when block was written, etc. :option:`verify` can be combined with
2436 :option:`verify_pattern` option. The allowed values are:
2439 Use an md5 sum of the data area and store it in the header of
2443 Use an experimental crc64 sum of the data area and store it in the
2444 header of each block.
2447 Use a crc32c sum of the data area and store it in the header of
2448 each block. This will automatically use hardware acceleration
2449 (e.g. SSE4.2 on an x86 or CRC crypto extensions on ARM64) but will
2450 fall back to software crc32c if none is found. Generally the
2451 fatest checksum fio supports when hardware accelerated.
2457 Use a crc32 sum of the data area and store it in the header of each
2461 Use a crc16 sum of the data area and store it in the header of each
2465 Use a crc7 sum of the data area and store it in the header of each
2469 Use xxhash as the checksum function. Generally the fastest software
2470 checksum that fio supports.
2473 Use sha512 as the checksum function.
2476 Use sha256 as the checksum function.
2479 Use optimized sha1 as the checksum function.
2482 Use optimized sha3-224 as the checksum function.
2485 Use optimized sha3-256 as the checksum function.
2488 Use optimized sha3-384 as the checksum function.
2491 Use optimized sha3-512 as the checksum function.
2494 This option is deprecated, since now meta information is included in
2495 generic verification header and meta verification happens by
2496 default. For detailed information see the description of the
2497 :option:`verify` setting. This option is kept because of
2498 compatibility's sake with old configurations. Do not use it.
2501 Verify a strict pattern. Normally fio includes a header with some
2502 basic information and checksumming, but if this option is set, only
2503 the specific pattern set with :option:`verify_pattern` is verified.
2506 Only pretend to verify. Useful for testing internals with
2507 :option:`ioengine`\=null, not for much else.
2509 This option can be used for repeated burn-in tests of a system to make sure
2510 that the written data is also correctly read back. If the data direction
2511 given is a read or random read, fio will assume that it should verify a
2512 previously written file. If the data direction includes any form of write,
2513 the verify will be of the newly written data.
2515 .. option:: verifysort=bool
2517 If true, fio will sort written verify blocks when it deems it faster to read
2518 them back in a sorted manner. This is often the case when overwriting an
2519 existing file, since the blocks are already laid out in the file system. You
2520 can ignore this option unless doing huge amounts of really fast I/O where
2521 the red-black tree sorting CPU time becomes significant. Default: true.
2523 .. option:: verifysort_nr=int
2525 Pre-load and sort verify blocks for a read workload.
2527 .. option:: verify_offset=int
2529 Swap the verification header with data somewhere else in the block before
2530 writing. It is swapped back before verifying.
2532 .. option:: verify_interval=int
2534 Write the verification header at a finer granularity than the
2535 :option:`blocksize`. It will be written for chunks the size of
2536 ``verify_interval``. :option:`blocksize` should divide this evenly.
2538 .. option:: verify_pattern=str
2540 If set, fio will fill the I/O buffers with this pattern. Fio defaults to
2541 filling with totally random bytes, but sometimes it's interesting to fill
2542 with a known pattern for I/O verification purposes. Depending on the width
2543 of the pattern, fio will fill 1/2/3/4 bytes of the buffer at the time (it can
2544 be either a decimal or a hex number). The ``verify_pattern`` if larger than
2545 a 32-bit quantity has to be a hex number that starts with either "0x" or
2546 "0X". Use with :option:`verify`. Also, ``verify_pattern`` supports %o
2547 format, which means that for each block offset will be written and then
2548 verified back, e.g.::
2552 Or use combination of everything::
2554 verify_pattern=0xff%o"abcd"-12
2556 .. option:: verify_fatal=bool
2558 Normally fio will keep checking the entire contents before quitting on a
2559 block verification failure. If this option is set, fio will exit the job on
2560 the first observed failure. Default: false.
2562 .. option:: verify_dump=bool
2564 If set, dump the contents of both the original data block and the data block
2565 we read off disk to files. This allows later analysis to inspect just what
2566 kind of data corruption occurred. Off by default.
2568 .. option:: verify_async=int
2570 Fio will normally verify I/O inline from the submitting thread. This option
2571 takes an integer describing how many async offload threads to create for I/O
2572 verification instead, causing fio to offload the duty of verifying I/O
2573 contents to one or more separate threads. If using this offload option, even
2574 sync I/O engines can benefit from using an :option:`iodepth` setting higher
2575 than 1, as it allows them to have I/O in flight while verifies are running.
2576 Defaults to 0 async threads, i.e. verification is not asynchronous.
2578 .. option:: verify_async_cpus=str
2580 Tell fio to set the given CPU affinity on the async I/O verification
2581 threads. See :option:`cpus_allowed` for the format used.
2583 .. option:: verify_backlog=int
2585 Fio will normally verify the written contents of a job that utilizes verify
2586 once that job has completed. In other words, everything is written then
2587 everything is read back and verified. You may want to verify continually
2588 instead for a variety of reasons. Fio stores the meta data associated with
2589 an I/O block in memory, so for large verify workloads, quite a bit of memory
2590 would be used up holding this meta data. If this option is enabled, fio will
2591 write only N blocks before verifying these blocks.
2593 .. option:: verify_backlog_batch=int
2595 Control how many blocks fio will verify if :option:`verify_backlog` is
2596 set. If not set, will default to the value of :option:`verify_backlog`
2597 (meaning the entire queue is read back and verified). If
2598 ``verify_backlog_batch`` is less than :option:`verify_backlog` then not all
2599 blocks will be verified, if ``verify_backlog_batch`` is larger than
2600 :option:`verify_backlog`, some blocks will be verified more than once.
2602 .. option:: verify_state_save=bool
2604 When a job exits during the write phase of a verify workload, save its
2605 current state. This allows fio to replay up until that point, if the verify
2606 state is loaded for the verify read phase. The format of the filename is,
2609 <type>-<jobname>-<jobindex>-verify.state.
2611 <type> is "local" for a local run, "sock" for a client/server socket
2612 connection, and "ip" (192.168.0.1, for instance) for a networked
2613 client/server connection. Defaults to true.
2615 .. option:: verify_state_load=bool
2617 If a verify termination trigger was used, fio stores the current write state
2618 of each thread. This can be used at verification time so that fio knows how
2619 far it should verify. Without this information, fio will run a full
2620 verification pass, according to the settings in the job file used. Default
2623 .. option:: trim_percentage=int
2625 Number of verify blocks to discard/trim.
2627 .. option:: trim_verify_zero=bool
2629 Verify that trim/discarded blocks are returned as zeros.
2631 .. option:: trim_backlog=int
2633 Trim after this number of blocks are written.
2635 .. option:: trim_backlog_batch=int
2637 Trim this number of I/O blocks.
2639 .. option:: experimental_verify=bool
2641 Enable experimental verification.
2646 .. option:: steadystate=str:float, ss=str:float
2648 Define the criterion and limit for assessing steady state performance. The
2649 first parameter designates the criterion whereas the second parameter sets
2650 the threshold. When the criterion falls below the threshold for the
2651 specified duration, the job will stop. For example, `iops_slope:0.1%` will
2652 direct fio to terminate the job when the least squares regression slope
2653 falls below 0.1% of the mean IOPS. If :option:`group_reporting` is enabled
2654 this will apply to all jobs in the group. Below is the list of available
2655 steady state assessment criteria. All assessments are carried out using only
2656 data from the rolling collection window. Threshold limits can be expressed
2657 as a fixed value or as a percentage of the mean in the collection window.
2660 Collect IOPS data. Stop the job if all individual IOPS measurements
2661 are within the specified limit of the mean IOPS (e.g., ``iops:2``
2662 means that all individual IOPS values must be within 2 of the mean,
2663 whereas ``iops:0.2%`` means that all individual IOPS values must be
2664 within 0.2% of the mean IOPS to terminate the job).
2667 Collect IOPS data and calculate the least squares regression
2668 slope. Stop the job if the slope falls below the specified limit.
2671 Collect bandwidth data. Stop the job if all individual bandwidth
2672 measurements are within the specified limit of the mean bandwidth.
2675 Collect bandwidth data and calculate the least squares regression
2676 slope. Stop the job if the slope falls below the specified limit.
2678 .. option:: steadystate_duration=time, ss_dur=time
2680 A rolling window of this duration will be used to judge whether steady state
2681 has been reached. Data will be collected once per second. The default is 0
2682 which disables steady state detection. When the unit is omitted, the
2683 value is interpreted in seconds.
2685 .. option:: steadystate_ramp_time=time, ss_ramp=time
2687 Allow the job to run for the specified duration before beginning data
2688 collection for checking the steady state job termination criterion. The
2689 default is 0. When the unit is omitted, the value is interpreted in seconds.
2692 Measurements and reporting
2693 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2695 .. option:: per_job_logs=bool
2697 If set, this generates bw/clat/iops log with per file private filenames. If
2698 not set, jobs with identical names will share the log filename. Default:
2701 .. option:: group_reporting
2703 It may sometimes be interesting to display statistics for groups of jobs as
2704 a whole instead of for each individual job. This is especially true if
2705 :option:`numjobs` is used; looking at individual thread/process output
2706 quickly becomes unwieldy. To see the final report per-group instead of
2707 per-job, use :option:`group_reporting`. Jobs in a file will be part of the
2708 same reporting group, unless if separated by a :option:`stonewall`, or by
2709 using :option:`new_group`.
2711 .. option:: new_group
2713 Start a new reporting group. See: :option:`group_reporting`. If not given,
2714 all jobs in a file will be part of the same reporting group, unless
2715 separated by a :option:`stonewall`.
2717 .. option:: stats=bool
2719 By default, fio collects and shows final output results for all jobs
2720 that run. If this option is set to 0, then fio will ignore it in
2721 the final stat output.
2723 .. option:: write_bw_log=str
2725 If given, write a bandwidth log for this job. Can be used to store data of
2726 the bandwidth of the jobs in their lifetime.
2728 If no str argument is given, the default filename of
2729 :file:`jobname_type.x.log` is used. Even when the argument is given, fio
2730 will still append the type of log. So if one specifies::
2734 The actual log name will be :file:`foo_bw.x.log` where `x` is the index
2735 of the job (`1..N`, where `N` is the number of jobs). If
2736 :option:`per_job_logs` is false, then the filename will not include the
2739 The included :command:`fio_generate_plots` script uses :command:`gnuplot` to turn these
2740 text files into nice graphs. See `Log File Formats`_ for how data is
2741 structured within the file.
2743 .. option:: write_lat_log=str
2745 Same as :option:`write_bw_log`, except this option creates I/O
2746 submission (e.g., `file:`name_slat.x.log`), completion (e.g.,
2747 `file:`name_clat.x.log`), and total (e.g., `file:`name_lat.x.log`)
2748 latency files instead. See :option:`write_bw_log` for details about
2749 the filename format and `Log File Formats`_ for how data is structured
2752 .. option:: write_hist_log=str
2754 Same as :option:`write_bw_log` but writes an I/O completion latency
2755 histogram file (e.g., `file:`name_hist.x.log`) instead. Note that this
2756 file will be empty unless :option:`log_hist_msec` has also been set.
2757 See :option:`write_bw_log` for details about the filename format and
2758 `Log File Formats`_ for how data is structured within the file.
2760 .. option:: write_iops_log=str
2762 Same as :option:`write_bw_log`, but writes an IOPS file (e.g.
2763 `file:`name_iops.x.log`) instead. See :option:`write_bw_log` for
2764 details about the filename format and `Log File Formats`_ for how data
2765 is structured within the file.
2767 .. option:: log_avg_msec=int
2769 By default, fio will log an entry in the iops, latency, or bw log for every
2770 I/O that completes. When writing to the disk log, that can quickly grow to a
2771 very large size. Setting this option makes fio average the each log entry
2772 over the specified period of time, reducing the resolution of the log. See
2773 :option:`log_max_value` as well. Defaults to 0, logging all entries.
2774 Also see `Log File Formats`_.
2776 .. option:: log_hist_msec=int
2778 Same as :option:`log_avg_msec`, but logs entries for completion latency
2779 histograms. Computing latency percentiles from averages of intervals using
2780 :option:`log_avg_msec` is inaccurate. Setting this option makes fio log
2781 histogram entries over the specified period of time, reducing log sizes for
2782 high IOPS devices while retaining percentile accuracy. See
2783 :option:`log_hist_coarseness` and :option:`write_hist_log` as well.
2784 Defaults to 0, meaning histogram logging is disabled.
2786 .. option:: log_hist_coarseness=int
2788 Integer ranging from 0 to 6, defining the coarseness of the resolution of
2789 the histogram logs enabled with :option:`log_hist_msec`. For each increment
2790 in coarseness, fio outputs half as many bins. Defaults to 0, for which
2791 histogram logs contain 1216 latency bins. See :option:`write_hist_log`
2792 and `Log File Formats`_.
2794 .. option:: log_max_value=bool
2796 If :option:`log_avg_msec` is set, fio logs the average over that window. If
2797 you instead want to log the maximum value, set this option to 1. Defaults to
2798 0, meaning that averaged values are logged.
2800 .. option:: log_offset=bool
2802 If this is set, the iolog options will include the byte offset for the I/O
2803 entry as well as the other data values. Defaults to 0 meaning that
2804 offsets are not present in logs. Also see `Log File Formats`_.
2806 .. option:: log_compression=int
2808 If this is set, fio will compress the I/O logs as it goes, to keep the
2809 memory footprint lower. When a log reaches the specified size, that chunk is
2810 removed and compressed in the background. Given that I/O logs are fairly
2811 highly compressible, this yields a nice memory savings for longer runs. The
2812 downside is that the compression will consume some background CPU cycles, so
2813 it may impact the run. This, however, is also true if the logging ends up
2814 consuming most of the system memory. So pick your poison. The I/O logs are
2815 saved normally at the end of a run, by decompressing the chunks and storing
2816 them in the specified log file. This feature depends on the availability of
2819 .. option:: log_compression_cpus=str
2821 Define the set of CPUs that are allowed to handle online log compression for
2822 the I/O jobs. This can provide better isolation between performance
2823 sensitive jobs, and background compression work.
2825 .. option:: log_store_compressed=bool
2827 If set, fio will store the log files in a compressed format. They can be
2828 decompressed with fio, using the :option:`--inflate-log` command line
2829 parameter. The files will be stored with a :file:`.fz` suffix.
2831 .. option:: log_unix_epoch=bool
2833 If set, fio will log Unix timestamps to the log files produced by enabling
2834 write_type_log for each log type, instead of the default zero-based
2837 .. option:: block_error_percentiles=bool
2839 If set, record errors in trim block-sized units from writes and trims and
2840 output a histogram of how many trims it took to get to errors, and what kind
2841 of error was encountered.
2843 .. option:: bwavgtime=int
2845 Average the calculated bandwidth over the given time. Value is specified in
2846 milliseconds. If the job also does bandwidth logging through
2847 :option:`write_bw_log`, then the minimum of this option and
2848 :option:`log_avg_msec` will be used. Default: 500ms.
2850 .. option:: iopsavgtime=int
2852 Average the calculated IOPS over the given time. Value is specified in
2853 milliseconds. If the job also does IOPS logging through
2854 :option:`write_iops_log`, then the minimum of this option and
2855 :option:`log_avg_msec` will be used. Default: 500ms.
2857 .. option:: disk_util=bool
2859 Generate disk utilization statistics, if the platform supports it.
2862 .. option:: disable_lat=bool
2864 Disable measurements of total latency numbers. Useful only for cutting back
2865 the number of calls to :manpage:`gettimeofday(2)`, as that does impact
2866 performance at really high IOPS rates. Note that to really get rid of a
2867 large amount of these calls, this option must be used with
2868 :option:`disable_slat` and :option:`disable_bw_measurement` as well.
2870 .. option:: disable_clat=bool
2872 Disable measurements of completion latency numbers. See
2873 :option:`disable_lat`.
2875 .. option:: disable_slat=bool
2877 Disable measurements of submission latency numbers. See
2878 :option:`disable_lat`.
2880 .. option:: disable_bw_measurement=bool, disable_bw=bool
2882 Disable measurements of throughput/bandwidth numbers. See
2883 :option:`disable_lat`.
2885 .. option:: clat_percentiles=bool
2887 Enable the reporting of percentiles of completion latencies. This
2888 option is mutually exclusive with :option:`lat_percentiles`.
2890 .. option:: lat_percentiles=bool
2892 Enable the reporting of percentiles of I/O latencies. This is similar
2893 to :option:`clat_percentiles`, except that this includes the
2894 submission latency. This option is mutually exclusive with
2895 :option:`clat_percentiles`.
2897 .. option:: percentile_list=float_list
2899 Overwrite the default list of percentiles for completion latencies and the
2900 block error histogram. Each number is a floating number in the range
2901 (0,100], and the maximum length of the list is 20. Use ``:`` to separate the
2902 numbers, and list the numbers in ascending order. For example,
2903 ``--percentile_list=99.5:99.9`` will cause fio to report the values of
2904 completion latency below which 99.5% and 99.9% of the observed latencies
2911 .. option:: exitall_on_error
2913 When one job finishes in error, terminate the rest. The default is to wait
2914 for each job to finish.
2916 .. option:: continue_on_error=str
2918 Normally fio will exit the job on the first observed failure. If this option
2919 is set, fio will continue the job when there is a 'non-fatal error' (EIO or
2920 EILSEQ) until the runtime is exceeded or the I/O size specified is
2921 completed. If this option is used, there are two more stats that are
2922 appended, the total error count and the first error. The error field given
2923 in the stats is the first error that was hit during the run.
2925 The allowed values are:
2928 Exit on any I/O or verify errors.
2931 Continue on read errors, exit on all others.
2934 Continue on write errors, exit on all others.
2937 Continue on any I/O error, exit on all others.
2940 Continue on verify errors, exit on all others.
2943 Continue on all errors.
2946 Backward-compatible alias for 'none'.
2949 Backward-compatible alias for 'all'.
2951 .. option:: ignore_error=str
2953 Sometimes you want to ignore some errors during test in that case you can
2954 specify error list for each error type, instead of only being able to
2955 ignore the default 'non-fatal error' using :option:`continue_on_error`.
2956 ``ignore_error=READ_ERR_LIST,WRITE_ERR_LIST,VERIFY_ERR_LIST`` errors for
2957 given error type is separated with ':'. Error may be symbol ('ENOSPC',
2958 'ENOMEM') or integer. Example::
2960 ignore_error=EAGAIN,ENOSPC:122
2962 This option will ignore EAGAIN from READ, and ENOSPC and 122(EDQUOT) from
2963 WRITE. This option works by overriding :option:`continue_on_error` with
2964 the list of errors for each error type if any.
2966 .. option:: error_dump=bool
2968 If set dump every error even if it is non fatal, true by default. If
2969 disabled only fatal error will be dumped.
2971 Running predefined workloads
2972 ----------------------------
2974 Fio includes predefined profiles that mimic the I/O workloads generated by
2977 .. option:: profile=str
2979 The predefined workload to run. Current profiles are:
2982 Threaded I/O bench (tiotest/tiobench) like workload.
2985 Aerospike Certification Tool (ACT) like workload.
2987 To view a profile's additional options use :option:`--cmdhelp` after specifying
2988 the profile. For example::
2990 $ fio --profile=act --cmdhelp
2995 .. option:: device-names=str
3000 .. option:: load=int
3003 ACT load multiplier. Default: 1.
3005 .. option:: test-duration=time
3008 How long the entire test takes to run. When the unit is omitted, the value
3009 is given in seconds. Default: 24h.
3011 .. option:: threads-per-queue=int
3014 Number of read I/O threads per device. Default: 8.
3016 .. option:: read-req-num-512-blocks=int
3019 Number of 512B blocks to read at the time. Default: 3.
3021 .. option:: large-block-op-kbytes=int
3024 Size of large block ops in KiB (writes). Default: 131072.
3029 Set to run ACT prep phase.
3031 Tiobench profile options
3032 ~~~~~~~~~~~~~~~~~~~~~~~~
3034 .. option:: size=str
3039 .. option:: block=int
3042 Block size in bytes. Default: 4096.
3044 .. option:: numruns=int
3054 .. option:: threads=int
3059 Interpreting the output
3060 -----------------------
3063 Example output was based on the following:
3064 TZ=UTC fio --iodepth=8 --ioengine=null --size=100M --time_based \
3065 --rate=1256k --bs=14K --name=quick --runtime=1s --name=mixed \
3066 --runtime=2m --rw=rw
3068 Fio spits out a lot of output. While running, fio will display the status of the
3069 jobs created. An example of that would be::
3071 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]
3073 The characters inside the first set of square brackets denote the current status of
3074 each thread. The first character is the first job defined in the job file, and so
3075 forth. The possible values (in typical life cycle order) are:
3077 +------+-----+-----------------------------------------------------------+
3079 +======+=====+===========================================================+
3080 | P | | Thread setup, but not started. |
3081 +------+-----+-----------------------------------------------------------+
3082 | C | | Thread created. |
3083 +------+-----+-----------------------------------------------------------+
3084 | I | | Thread initialized, waiting or generating necessary data. |
3085 +------+-----+-----------------------------------------------------------+
3086 | | p | Thread running pre-reading file(s). |
3087 +------+-----+-----------------------------------------------------------+
3088 | | / | Thread is in ramp period. |
3089 +------+-----+-----------------------------------------------------------+
3090 | | R | Running, doing sequential reads. |
3091 +------+-----+-----------------------------------------------------------+
3092 | | r | Running, doing random reads. |
3093 +------+-----+-----------------------------------------------------------+
3094 | | W | Running, doing sequential writes. |
3095 +------+-----+-----------------------------------------------------------+
3096 | | w | Running, doing random writes. |
3097 +------+-----+-----------------------------------------------------------+
3098 | | M | Running, doing mixed sequential reads/writes. |
3099 +------+-----+-----------------------------------------------------------+
3100 | | m | Running, doing mixed random reads/writes. |
3101 +------+-----+-----------------------------------------------------------+
3102 | | D | Running, doing sequential trims. |
3103 +------+-----+-----------------------------------------------------------+
3104 | | d | Running, doing random trims. |
3105 +------+-----+-----------------------------------------------------------+
3106 | | F | Running, currently waiting for :manpage:`fsync(2)`. |
3107 +------+-----+-----------------------------------------------------------+
3108 | | V | Running, doing verification of written data. |
3109 +------+-----+-----------------------------------------------------------+
3110 | f | | Thread finishing. |
3111 +------+-----+-----------------------------------------------------------+
3112 | E | | Thread exited, not reaped by main thread yet. |
3113 +------+-----+-----------------------------------------------------------+
3114 | _ | | Thread reaped. |
3115 +------+-----+-----------------------------------------------------------+
3116 | X | | Thread reaped, exited with an error. |
3117 +------+-----+-----------------------------------------------------------+
3118 | K | | Thread reaped, exited due to signal. |
3119 +------+-----+-----------------------------------------------------------+
3122 Example output was based on the following:
3123 TZ=UTC fio --iodepth=8 --ioengine=null --size=100M --runtime=58m \
3124 --time_based --rate=2512k --bs=256K --numjobs=10 \
3125 --name=readers --rw=read --name=writers --rw=write
3127 Fio will condense the thread string as not to take up more space on the command
3128 line than needed. For instance, if you have 10 readers and 10 writers running,
3129 the output would look like this::
3131 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]
3133 Note that the status string is displayed in order, so it's possible to tell which of
3134 the jobs are currently doing what. In the example above this means that jobs 1--10
3135 are readers and 11--20 are writers.
3137 The other values are fairly self explanatory -- number of threads currently
3138 running and doing I/O, the number of currently open files (f=), the estimated
3139 completion percentage, the rate of I/O since last check (read speed listed first,
3140 then write speed and optionally trim speed) in terms of bandwidth and IOPS,
3141 and time to completion for the current running group. It's impossible to estimate
3142 runtime of the following groups (if any).
3145 Example output was based on the following:
3146 TZ=UTC fio --iodepth=16 --ioengine=posixaio --filename=/tmp/fiofile \
3147 --direct=1 --size=100M --time_based --runtime=50s --rate_iops=89 \
3148 --bs=7K --name=Client1 --rw=write
3150 When fio is done (or interrupted by :kbd:`Ctrl-C`), it will show the data for
3151 each thread, group of threads, and disks in that order. For each overall thread (or
3152 group) the output looks like::
3154 Client1: (groupid=0, jobs=1): err= 0: pid=16109: Sat Jun 24 12:07:54 2017
3155 write: IOPS=88, BW=623KiB/s (638kB/s)(30.4MiB/50032msec)
3156 slat (nsec): min=500, max=145500, avg=8318.00, stdev=4781.50
3157 clat (usec): min=170, max=78367, avg=4019.02, stdev=8293.31
3158 lat (usec): min=174, max=78375, avg=4027.34, stdev=8291.79
3159 clat percentiles (usec):
3160 | 1.00th=[ 302], 5.00th=[ 326], 10.00th=[ 343], 20.00th=[ 363],
3161 | 30.00th=[ 392], 40.00th=[ 404], 50.00th=[ 416], 60.00th=[ 445],
3162 | 70.00th=[ 816], 80.00th=[ 6718], 90.00th=[12911], 95.00th=[21627],
3163 | 99.00th=[43779], 99.50th=[51643], 99.90th=[68682], 99.95th=[72877],
3165 bw ( KiB/s): min= 532, max= 686, per=0.10%, avg=622.87, stdev=24.82, samples= 100
3166 iops : min= 76, max= 98, avg=88.98, stdev= 3.54, samples= 100
3167 lat (usec) : 250=0.04%, 500=64.11%, 750=4.81%, 1000=2.79%
3168 lat (msec) : 2=4.16%, 4=1.84%, 10=4.90%, 20=11.33%, 50=5.37%
3169 lat (msec) : 100=0.65%
3170 cpu : usr=0.27%, sys=0.18%, ctx=12072, majf=0, minf=21
3171 IO depths : 1=85.0%, 2=13.1%, 4=1.8%, 8=0.1%, 16=0.0%, 32=0.0%, >=64=0.0%
3172 submit : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0%
3173 complete : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0%
3174 issued rwt: total=0,4450,0, short=0,0,0, dropped=0,0,0
3175 latency : target=0, window=0, percentile=100.00%, depth=8
3177 The job name (or first job's name when using :option:`group_reporting`) is printed,
3178 along with the group id, count of jobs being aggregated, last error id seen (which
3179 is 0 when there are no errors), pid/tid of that thread and the time the job/group
3180 completed. Below are the I/O statistics for each data direction performed (showing
3181 writes in the example above). In the order listed, they denote:
3184 The string before the colon shows the I/O direction the statistics
3185 are for. **IOPS** is the average I/Os performed per second. **BW**
3186 is the average bandwidth rate shown as: value in power of 2 format
3187 (value in power of 10 format). The last two values show: (**total
3188 I/O performed** in power of 2 format / **runtime** of that thread).
3191 Submission latency (**min** being the minimum, **max** being the
3192 maximum, **avg** being the average, **stdev** being the standard
3193 deviation). This is the time it took to submit the I/O. For
3194 sync I/O this row is not displayed as the slat is really the
3195 completion latency (since queue/complete is one operation there).
3196 This value can be in nanoseconds, microseconds or milliseconds ---
3197 fio will choose the most appropriate base and print that (in the
3198 example above nanoseconds was the best scale). Note: in :option:`--minimal` mode
3199 latencies are always expressed in microseconds.
3202 Completion latency. Same names as slat, this denotes the time from
3203 submission to completion of the I/O pieces. For sync I/O, clat will
3204 usually be equal (or very close) to 0, as the time from submit to
3205 complete is basically just CPU time (I/O has already been done, see slat
3209 Total latency. Same names as slat and clat, this denotes the time from
3210 when fio created the I/O unit to completion of the I/O operation.
3213 Bandwidth statistics based on samples. Same names as the xlat stats,
3214 but also includes the number of samples taken (**samples**) and an
3215 approximate percentage of total aggregate bandwidth this thread
3216 received in its group (**per**). This last value is only really
3217 useful if the threads in this group are on the same disk, since they
3218 are then competing for disk access.
3221 IOPS statistics based on samples. Same names as bw.
3223 **lat (nsec/usec/msec)**
3224 The distribution of I/O completion latencies. This is the time from when
3225 I/O leaves fio and when it gets completed. Unlike the separate
3226 read/write/trim sections above, the data here and in the remaining
3227 sections apply to all I/Os for the reporting group. 250=0.04% means that
3228 0.04% of the I/Os completed in under 250us. 500=64.11% means that 64.11%
3229 of the I/Os required 250 to 499us for completion.
3232 CPU usage. User and system time, along with the number of context
3233 switches this thread went through, usage of system and user time, and
3234 finally the number of major and minor page faults. The CPU utilization
3235 numbers are averages for the jobs in that reporting group, while the
3236 context and fault counters are summed.
3239 The distribution of I/O depths over the job lifetime. The numbers are
3240 divided into powers of 2 and each entry covers depths from that value
3241 up to those that are lower than the next entry -- e.g., 16= covers
3242 depths from 16 to 31. Note that the range covered by a depth
3243 distribution entry can be different to the range covered by the
3244 equivalent submit/complete distribution entry.
3247 How many pieces of I/O were submitting in a single submit call. Each
3248 entry denotes that amount and below, until the previous entry -- e.g.,
3249 16=100% means that we submitted anywhere between 9 to 16 I/Os per submit
3250 call. Note that the range covered by a submit distribution entry can
3251 be different to the range covered by the equivalent depth distribution
3255 Like the above submit number, but for completions instead.
3258 The number of read/write/trim requests issued, and how many of them were
3262 These values are for :option:`latency_target` and related options. When
3263 these options are engaged, this section describes the I/O depth required
3264 to meet the specified latency target.
3267 Example output was based on the following:
3268 TZ=UTC fio --ioengine=null --iodepth=2 --size=100M --numjobs=2 \
3269 --rate_process=poisson --io_limit=32M --name=read --bs=128k \
3270 --rate=11M --name=write --rw=write --bs=2k --rate=700k
3272 After each client has been listed, the group statistics are printed. They
3273 will look like this::
3275 Run status group 0 (all jobs):
3276 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
3277 WRITE: bw=1231KiB/s (1261kB/s), 616KiB/s-621KiB/s (630kB/s-636kB/s), io=64.0MiB (67.1MB), run=52747-53223msec
3279 For each data direction it prints:
3282 Aggregate bandwidth of threads in this group followed by the
3283 minimum and maximum bandwidth of all the threads in this group.
3284 Values outside of brackets are power-of-2 format and those
3285 within are the equivalent value in a power-of-10 format.
3287 Aggregate I/O performed of all threads in this group. The
3288 format is the same as bw.
3290 The smallest and longest runtimes of the threads in this group.
3292 And finally, the disk statistics are printed. This is Linux specific. They will look like this::
3294 Disk stats (read/write):
3295 sda: ios=16398/16511, merge=30/162, ticks=6853/819634, in_queue=826487, util=100.00%
3297 Each value is printed for both reads and writes, with reads first. The
3301 Number of I/Os performed by all groups.
3303 Number of merges performed by the I/O scheduler.
3305 Number of ticks we kept the disk busy.
3307 Total time spent in the disk queue.
3309 The disk utilization. A value of 100% means we kept the disk
3310 busy constantly, 50% would be a disk idling half of the time.
3312 It is also possible to get fio to dump the current output while it is running,
3313 without terminating the job. To do that, send fio the **USR1** signal. You can
3314 also get regularly timed dumps by using the :option:`--status-interval`
3315 parameter, or by creating a file in :file:`/tmp` named
3316 :file:`fio-dump-status`. If fio sees this file, it will unlink it and dump the
3317 current output status.
3323 For scripted usage where you typically want to generate tables or graphs of the
3324 results, fio can output the results in a semicolon separated format. The format
3325 is one long line of values, such as::
3327 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%
3328 A description of this job goes here.
3330 The job description (if provided) follows on a second line.
3332 To enable terse output, use the :option:`--minimal` or
3333 :option:`--output-format`\=terse command line options. The
3334 first value is the version of the terse output format. If the output has to be
3335 changed for some reason, this number will be incremented by 1 to signify that
3338 Split up, the format is as follows (comments in brackets denote when a
3339 field was introduced or whether it's specific to some terse version):
3343 terse version, fio version [v3], jobname, groupid, error
3347 Total IO (KiB), bandwidth (KiB/sec), IOPS, runtime (msec)
3348 Submission latency: min, max, mean, stdev (usec)
3349 Completion latency: min, max, mean, stdev (usec)
3350 Completion latency percentiles: 20 fields (see below)
3351 Total latency: min, max, mean, stdev (usec)
3352 Bw (KiB/s): min, max, aggregate percentage of total, mean, stdev, number of samples [v5]
3353 IOPS [v5]: min, max, mean, stdev, number of samples
3359 Total IO (KiB), bandwidth (KiB/sec), IOPS, runtime (msec)
3360 Submission latency: min, max, mean, stdev (usec)
3361 Completion latency: min, max, mean, stdev (usec)
3362 Completion latency percentiles: 20 fields (see below)
3363 Total latency: min, max, mean, stdev (usec)
3364 Bw (KiB/s): min, max, aggregate percentage of total, mean, stdev, number of samples [v5]
3365 IOPS [v5]: min, max, mean, stdev, number of samples
3367 TRIM status [all but version 3]:
3369 Fields are similar to READ/WRITE status.
3373 user, system, context switches, major faults, minor faults
3377 <=1, 2, 4, 8, 16, 32, >=64
3379 I/O latencies microseconds::
3381 <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
3383 I/O latencies milliseconds::
3385 <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000
3387 Disk utilization [v3]::
3389 disk name, read ios, write ios, read merges, write merges, read ticks, write ticks,
3390 time spent in queue, disk utilization percentage
3392 Additional Info (dependent on continue_on_error, default off)::
3394 total # errors, first error code
3396 Additional Info (dependent on description being set)::
3400 Completion latency percentiles can be a grouping of up to 20 sets, so for the
3401 terse output fio writes all of them. Each field will look like this::
3405 which is the Xth percentile, and the `usec` latency associated with it.
3407 For `Disk utilization`, all disks used by fio are shown. So for each disk there
3408 will be a disk utilization section.
3410 Below is a single line containing short names for each of the fields in the
3411 minimal output v3, separated by semicolons::
3413 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
3419 The `json` output format is intended to be both human readable and convenient
3420 for automated parsing. For the most part its sections mirror those of the
3421 `normal` output. The `runtime` value is reported in msec and the `bw` value is
3422 reported in 1024 bytes per second units.
3428 The `json+` output format is identical to the `json` output format except that it
3429 adds a full dump of the completion latency bins. Each `bins` object contains a
3430 set of (key, value) pairs where keys are latency durations and values count how
3431 many I/Os had completion latencies of the corresponding duration. For example,
3434 "bins" : { "87552" : 1, "89600" : 1, "94720" : 1, "96768" : 1, "97792" : 1, "99840" : 1, "100864" : 2, "103936" : 6, "104960" : 534, "105984" : 5995, "107008" : 7529, ... }
3436 This data indicates that one I/O required 87,552ns to complete, two I/Os required
3437 100,864ns to complete, and 7529 I/Os required 107,008ns to complete.
3439 Also included with fio is a Python script `fio_jsonplus_clat2csv` that takes
3440 json+ output and generates CSV-formatted latency data suitable for plotting.
3442 The latency durations actually represent the midpoints of latency intervals.
3443 For details refer to :file:`stat.h`.
3449 There are two trace file format that you can encounter. The older (v1) format is
3450 unsupported since version 1.20-rc3 (March 2008). It will still be described
3451 below in case that you get an old trace and want to understand it.
3453 In any case the trace is a simple text file with a single action per line.
3456 Trace file format v1
3457 ~~~~~~~~~~~~~~~~~~~~
3459 Each line represents a single I/O action in the following format::
3463 where `rw=0/1` for read/write, and the `offset` and `length` entries being in bytes.
3465 This format is not supported in fio versions >= 1.20-rc3.
3468 Trace file format v2
3469 ~~~~~~~~~~~~~~~~~~~~
3471 The second version of the trace file format was added in fio version 1.17. It
3472 allows to access more then one file per trace and has a bigger set of possible
3475 The first line of the trace file has to be::
3479 Following this can be lines in two different formats, which are described below.
3481 The file management format::
3485 The `filename` is given as an absolute path. The `action` can be one of these:
3488 Add the given `filename` to the trace.
3490 Open the file with the given `filename`. The `filename` has to have
3491 been added with the **add** action before.
3493 Close the file with the given `filename`. The file has to have been
3497 The file I/O action format::
3499 filename action offset length
3501 The `filename` is given as an absolute path, and has to have been added and
3502 opened before it can be used with this format. The `offset` and `length` are
3503 given in bytes. The `action` can be one of these:
3506 Wait for `offset` microseconds. Everything below 100 is discarded.
3507 The time is relative to the previous `wait` statement.
3509 Read `length` bytes beginning from `offset`.
3511 Write `length` bytes beginning from `offset`.
3513 :manpage:`fsync(2)` the file.
3515 :manpage:`fdatasync(2)` the file.
3517 Trim the given file from the given `offset` for `length` bytes.
3519 CPU idleness profiling
3520 ----------------------
3522 In some cases, we want to understand CPU overhead in a test. For example, we
3523 test patches for the specific goodness of whether they reduce CPU usage.
3524 Fio implements a balloon approach to create a thread per CPU that runs at idle
3525 priority, meaning that it only runs when nobody else needs the cpu.
3526 By measuring the amount of work completed by the thread, idleness of each CPU
3527 can be derived accordingly.
3529 An unit work is defined as touching a full page of unsigned characters. Mean and
3530 standard deviation of time to complete an unit work is reported in "unit work"
3531 section. Options can be chosen to report detailed percpu idleness or overall
3532 system idleness by aggregating percpu stats.
3535 Verification and triggers
3536 -------------------------
3538 Fio is usually run in one of two ways, when data verification is done. The first
3539 is a normal write job of some sort with verify enabled. When the write phase has
3540 completed, fio switches to reads and verifies everything it wrote. The second
3541 model is running just the write phase, and then later on running the same job
3542 (but with reads instead of writes) to repeat the same I/O patterns and verify
3543 the contents. Both of these methods depend on the write phase being completed,
3544 as fio otherwise has no idea how much data was written.
3546 With verification triggers, fio supports dumping the current write state to
3547 local files. Then a subsequent read verify workload can load this state and know
3548 exactly where to stop. This is useful for testing cases where power is cut to a
3549 server in a managed fashion, for instance.
3551 A verification trigger consists of two things:
3553 1) Storing the write state of each job.
3554 2) Executing a trigger command.
3556 The write state is relatively small, on the order of hundreds of bytes to single
3557 kilobytes. It contains information on the number of completions done, the last X
3560 A trigger is invoked either through creation ('touch') of a specified file in
3561 the system, or through a timeout setting. If fio is run with
3562 :option:`--trigger-file`\= :file:`/tmp/trigger-file`, then it will continually
3563 check for the existence of :file:`/tmp/trigger-file`. When it sees this file, it
3564 will fire off the trigger (thus saving state, and executing the trigger
3567 For client/server runs, there's both a local and remote trigger. If fio is
3568 running as a server backend, it will send the job states back to the client for
3569 safe storage, then execute the remote trigger, if specified. If a local trigger
3570 is specified, the server will still send back the write state, but the client
3571 will then execute the trigger.
3573 Verification trigger example
3574 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3576 Let's say we want to run a powercut test on the remote Linux machine 'server'.
3577 Our write workload is in :file:`write-test.fio`. We want to cut power to 'server' at
3578 some point during the run, and we'll run this test from the safety or our local
3579 machine, 'localbox'. On the server, we'll start the fio backend normally::
3581 server# fio --server
3583 and on the client, we'll fire off the workload::
3585 localbox$ fio --client=server --trigger-file=/tmp/my-trigger --trigger-remote="bash -c \"echo b > /proc/sysrq-triger\""
3587 We set :file:`/tmp/my-trigger` as the trigger file, and we tell fio to execute::
3589 echo b > /proc/sysrq-trigger
3591 on the server once it has received the trigger and sent us the write state. This
3592 will work, but it's not **really** cutting power to the server, it's merely
3593 abruptly rebooting it. If we have a remote way of cutting power to the server
3594 through IPMI or similar, we could do that through a local trigger command
3595 instead. Let's assume we have a script that does IPMI reboot of a given hostname,
3596 ipmi-reboot. On localbox, we could then have run fio with a local trigger
3599 localbox$ fio --client=server --trigger-file=/tmp/my-trigger --trigger="ipmi-reboot server"
3601 For this case, fio would wait for the server to send us the write state, then
3602 execute ``ipmi-reboot server`` when that happened.
3604 Loading verify state
3605 ~~~~~~~~~~~~~~~~~~~~
3607 To load stored write state, a read verification job file must contain the
3608 :option:`verify_state_load` option. If that is set, fio will load the previously
3609 stored state. For a local fio run this is done by loading the files directly,
3610 and on a client/server run, the server backend will ask the client to send the
3611 files over and load them from there.
3617 Fio supports a variety of log file formats, for logging latencies, bandwidth,
3618 and IOPS. The logs share a common format, which looks like this:
3620 *time* (`msec`), *value*, *data direction*, *block size* (`bytes`),
3623 *Time* for the log entry is always in milliseconds. The *value* logged depends
3624 on the type of log, it will be one of the following:
3627 Value is latency in nsecs
3633 *Data direction* is one of the following:
3642 The entry's *block size* is always in bytes. The *offset* is the offset, in bytes,
3643 from the start of the file, for that particular I/O. The logging of the offset can be
3644 toggled with :option:`log_offset`.
3646 Fio defaults to logging every individual I/O. When IOPS are logged for individual
3647 I/Os the *value* entry will always be 1. If windowed logging is enabled through
3648 :option:`log_avg_msec`, fio logs the average values over the specified period of time.
3649 If windowed logging is enabled and :option:`log_max_value` is set, then fio logs
3650 maximum values in that window instead of averages. Since *data direction*, *block
3651 size* and *offset* are per-I/O values, if windowed logging is enabled they
3652 aren't applicable and will be 0.
3657 Normally fio is invoked as a stand-alone application on the machine where the
3658 I/O workload should be generated. However, the backend and frontend of fio can
3659 be run separately i.e., the fio server can generate an I/O workload on the "Device
3660 Under Test" while being controlled by a client on another machine.
3662 Start the server on the machine which has access to the storage DUT::
3666 where `args` defines what fio listens to. The arguments are of the form
3667 ``type,hostname`` or ``IP,port``. *type* is either ``ip`` (or ip4) for TCP/IP
3668 v4, ``ip6`` for TCP/IP v6, or ``sock`` for a local unix domain socket.
3669 *hostname* is either a hostname or IP address, and *port* is the port to listen
3670 to (only valid for TCP/IP, not a local socket). Some examples:
3674 Start a fio server, listening on all interfaces on the default port (8765).
3676 2) ``fio --server=ip:hostname,4444``
3678 Start a fio server, listening on IP belonging to hostname and on port 4444.
3680 3) ``fio --server=ip6:::1,4444``
3682 Start a fio server, listening on IPv6 localhost ::1 and on port 4444.
3684 4) ``fio --server=,4444``
3686 Start a fio server, listening on all interfaces on port 4444.
3688 5) ``fio --server=1.2.3.4``
3690 Start a fio server, listening on IP 1.2.3.4 on the default port.
3692 6) ``fio --server=sock:/tmp/fio.sock``
3694 Start a fio server, listening on the local socket :file:`/tmp/fio.sock`.
3696 Once a server is running, a "client" can connect to the fio server with::
3698 fio <local-args> --client=<server> <remote-args> <job file(s)>
3700 where `local-args` are arguments for the client where it is running, `server`
3701 is the connect string, and `remote-args` and `job file(s)` are sent to the
3702 server. The `server` string follows the same format as it does on the server
3703 side, to allow IP/hostname/socket and port strings.
3705 Fio can connect to multiple servers this way::
3707 fio --client=<server1> <job file(s)> --client=<server2> <job file(s)>
3709 If the job file is located on the fio server, then you can tell the server to
3710 load a local file as well. This is done by using :option:`--remote-config` ::
3712 fio --client=server --remote-config /path/to/file.fio
3714 Then fio will open this local (to the server) job file instead of being passed
3715 one from the client.
3717 If you have many servers (example: 100 VMs/containers), you can input a pathname
3718 of a file containing host IPs/names as the parameter value for the
3719 :option:`--client` option. For example, here is an example :file:`host.list`
3720 file containing 2 hostnames::
3722 host1.your.dns.domain
3723 host2.your.dns.domain
3725 The fio command would then be::
3727 fio --client=host.list <job file(s)>
3729 In this mode, you cannot input server-specific parameters or job files -- all
3730 servers receive the same job file.
3732 In order to let ``fio --client`` runs use a shared filesystem from multiple
3733 hosts, ``fio --client`` now prepends the IP address of the server to the
3734 filename. For example, if fio is using the directory :file:`/mnt/nfs/fio` and is
3735 writing filename :file:`fileio.tmp`, with a :option:`--client` `hostfile`
3736 containing two hostnames ``h1`` and ``h2`` with IP addresses 192.168.10.120 and
3737 192.168.10.121, then fio will create two files::
3739 /mnt/nfs/fio/192.168.10.120.fileio.tmp
3740 /mnt/nfs/fio/192.168.10.121.fileio.tmp