fio: add additional support for dev-dax ioengine
[fio.git] / fio.1
1 .TH fio 1 "December 2014" "User Manual"
3 fio \- flexible I/O tester
5 .B fio
6 [\fIoptions\fR] [\fIjobfile\fR]...
8 .B fio
9 is a tool that will spawn a number of threads or processes doing a
10 particular type of I/O action as specified by the user.
11 The typical use of fio is to write a job file matching the I/O load
12 one wants to simulate.
14 .TP
15 .BI \-\-debug \fR=\fPtype
16 Enable verbose tracing of various fio actions. May be `all' for all types
17 or individual types separated by a comma (eg \-\-debug=io,file). `help' will
18 list all available tracing options.
19 .TP
20 .BI \-\-output \fR=\fPfilename
21 Write output to \fIfilename\fR.
22 .TP
23 .BI \-\-output-format \fR=\fPformat
24 Set the reporting format to \fInormal\fR, \fIterse\fR, \fIjson\fR, or
25 \fIjson+\fR. Multiple formats can be selected, separate by a comma. \fIterse\fR
26 is a CSV based format. \fIjson+\fR is like \fIjson\fR, except it adds a full
27 dump of the latency buckets.
28 .TP
29 .BI \-\-runtime \fR=\fPruntime
30 Limit run time to \fIruntime\fR seconds.
31 .TP
32 .B \-\-bandwidth\-log
33 Generate aggregate bandwidth logs.
34 .TP
35 .B \-\-minimal
36 Print statistics in a terse, semicolon-delimited format.
37 .TP
38 .B \-\-append-terse
39 Print statistics in selected mode AND terse, semicolon-delimited format.
40 Deprecated, use \-\-output-format instead to select multiple formats.
41 .TP
42 .B \-\-version
43 Display version information and exit.
44 .TP
45 .BI \-\-terse\-version \fR=\fPversion
46 Set terse version output format (Current version 3, or older version 2).
47 .TP
48 .B \-\-help
49 Display usage information and exit.
50 .TP
51 .B \-\-cpuclock-test
52 Perform test and validation of internal CPU clock
53 .TP
54 .BI \-\-crctest[\fR=\fPtest]
55 Test the speed of the builtin checksumming functions. If no argument is given,
56 all of them are tested. Or a comma separated list can be passed, in which
57 case the given ones are tested.
58 .TP
59 .BI \-\-cmdhelp \fR=\fPcommand
60 Print help information for \fIcommand\fR.  May be `all' for all commands.
61 .TP
62 .BI \-\-enghelp \fR=\fPioengine[,command]
63 List all commands defined by \fIioengine\fR, or print help for \fIcommand\fR defined by \fIioengine\fR.
64 .TP
65 .BI \-\-showcmd \fR=\fPjobfile
66 Convert \fIjobfile\fR to a set of command-line options.
67 .TP
68 .BI \-\-eta \fR=\fPwhen
69 Specifies when real-time ETA estimate should be printed.  \fIwhen\fR may
70 be one of `always', `never' or `auto'.
71 .TP
72 .BI \-\-eta\-newline \fR=\fPtime
73 Force an ETA newline for every `time` period passed.
74 .TP
75 .BI \-\-status\-interval \fR=\fPtime
76 Report full output status every `time` period passed.
77 .TP
78 .BI \-\-readonly
79 Turn on safety read-only checks, preventing any attempted write.
80 .TP
81 .BI \-\-section \fR=\fPsec
82 Only run section \fIsec\fR from job file. This option can be used multiple times to add more sections to run.
83 .TP
84 .BI \-\-alloc\-size \fR=\fPkb
85 Set the internal smalloc pool size to \fIkb\fP kilobytes.
86 .TP
87 .BI \-\-warnings\-fatal
88 All fio parser warnings are fatal, causing fio to exit with an error.
89 .TP
90 .BI \-\-max\-jobs \fR=\fPnr
91 Set the maximum allowed number of jobs (threads/processes) to support.
92 .TP
93 .BI \-\-server \fR=\fPargs
94 Start a backend server, with \fIargs\fP specifying what to listen to. See client/server section.
95 .TP
96 .BI \-\-daemonize \fR=\fPpidfile
97 Background a fio server, writing the pid to the given pid file.
98 .TP
99 .BI \-\-client \fR=\fPhost
100 Instead of running the jobs locally, send and run them on the given host or set of hosts.  See client/server section.
101 .TP
102 .BI \-\-idle\-prof \fR=\fPoption
103 Report cpu idleness on a system or percpu basis (\fIoption\fP=system,percpu) or run unit work calibration only (\fIoption\fP=calibrate).
105 Job files are in `ini' format. They consist of one or more
106 job definitions, which begin with a job name in square brackets and
107 extend to the next job name.  The job name can be any ASCII string
108 except `global', which has a special meaning.  Following the job name is
109 a sequence of zero or more parameters, one per line, that define the
110 behavior of the job.  Any line starting with a `;' or `#' character is
111 considered a comment and ignored.
112 .P
113 If \fIjobfile\fR is specified as `-', the job file will be read from
114 standard input.
115 .SS "Global Section"
116 The global section contains default parameters for jobs specified in the
117 job file.  A job is only affected by global sections residing above it,
118 and there may be any number of global sections.  Specific job definitions
119 may override any parameter set in global sections.
121 .SS Types
122 Some parameters may take arguments of a specific type.
123 Anywhere a numeric value is required, an arithmetic expression may be used,
124 provided it is surrounded by parentheses. Supported operators are:
125 .RS
126 .RS
127 .TP
128 .B addition (+)
129 .TP
130 .B subtraction (-)
131 .TP
132 .B multiplication (*)
133 .TP
134 .B division (/)
135 .TP
136 .B modulus (%)
137 .TP
138 .B exponentiation (^)
139 .RE
140 .RE
141 .P
142 For time values in expressions, units are microseconds by default. This is
143 different than for time values not in expressions (not enclosed in
144 parentheses). The types used are:
145 .TP
146 .I str
147 String: a sequence of alphanumeric characters.
148 .TP
149 .I int
150 SI integer: a whole number, possibly containing a suffix denoting the base unit
151 of the value.  Accepted suffixes are `k', 'M', 'G', 'T', and 'P', denoting
152 kilo (1024), mega (1024^2), giga (1024^3), tera (1024^4), and peta (1024^5)
153 respectively. If prefixed with '0x', the value is assumed to be base 16
154 (hexadecimal). A suffix may include a trailing 'b', for instance 'kb' is
155 identical to 'k'. You can specify a base 10 value by using 'KiB', 'MiB','GiB',
156 etc. This is useful for disk drives where values are often given in base 10
157 values. Specifying '30GiB' will get you 30*1000^3 bytes.
158 When specifying times the default suffix meaning changes, still denoting the
159 base unit of the value, but accepted suffixes are 'D' (days), 'H' (hours), 'M'
160 (minutes), 'S' Seconds, 'ms' (or msec) milli seconds, 'us' (or 'usec') micro
161 seconds. Time values without a unit specify seconds.
162 The suffixes are not case sensitive.
163 .TP
164 .I bool
165 Boolean: a true or false value. `0' denotes false, `1' denotes true.
166 .TP
167 .I irange
168 Integer range: a range of integers specified in the format
169 \fIlower\fR:\fIupper\fR or \fIlower\fR\-\fIupper\fR. \fIlower\fR and
170 \fIupper\fR may contain a suffix as described above.  If an option allows two
171 sets of ranges, they are separated with a `,' or `/' character. For example:
172 `8\-8k/8M\-4G'.
173 .TP
174 .I float_list
175 List of floating numbers: A list of floating numbers, separated by
176 a ':' character.
177 .SS "Parameter List"
178 .TP
179 .BI name \fR=\fPstr
180 May be used to override the job name.  On the command line, this parameter
181 has the special purpose of signalling the start of a new job.
182 .TP
183 .BI wait_for \fR=\fPstr
184 Specifies the name of the already defined job to wait for. Single waitee name
185 only may be specified. If set, the job won't be started until all workers of
186 the waitee job are done.  Wait_for operates on the job name basis, so there are
187 a few limitations. First, the waitee must be defined prior to the waiter job
188 (meaning no forward references). Second, if a job is being referenced as a
189 waitee, it must have a unique name (no duplicate waitees).
190 .TP
191 .BI description \fR=\fPstr
192 Human-readable description of the job. It is printed when the job is run, but
193 otherwise has no special purpose.
194 .TP
195 .BI directory \fR=\fPstr
196 Prefix filenames with this directory.  Used to place files in a location other
197 than `./'.
198 You can specify a number of directories by separating the names with a ':'
199 character. These directories will be assigned equally distributed to job clones
200 creates with \fInumjobs\fR as long as they are using generated filenames.
201 If specific \fIfilename(s)\fR are set fio will use the first listed directory,
202 and thereby matching the  \fIfilename\fR semantic which generates a file each
203 clone if not specified, but let all clones use the same if set. See
204 \fIfilename\fR for considerations regarding escaping certain characters on
205 some platforms.
206 .TP
207 .BI filename \fR=\fPstr
208 .B fio
209 normally makes up a file name based on the job name, thread number, and file
210 number. If you want to share files between threads in a job or several jobs,
211 specify a \fIfilename\fR for each of them to override the default.
212 If the I/O engine is file-based, you can specify
213 a number of files by separating the names with a `:' character. `\-' is a
214 reserved name, meaning stdin or stdout, depending on the read/write direction
215 set. On Windows, disk devices are accessed as \\.\PhysicalDrive0 for the first
216 device, \\.\PhysicalDrive1 for the second etc. Note: Windows and FreeBSD
217 prevent write access to areas of the disk containing in-use data
218 (e.g. filesystems). If the wanted filename does need to include a colon, then
219 escape that with a '\\' character. For instance, if the filename is
220 "/dev/dsk/foo@3,0:c", then you would use filename="/dev/dsk/foo@3,0\\:c".
221 .TP
222 .BI filename_format \fR=\fPstr
223 If sharing multiple files between jobs, it is usually necessary to have
224 fio generate the exact names that you want. By default, fio will name a file
225 based on the default file format specification of
226 \fBjobname.jobnumber.filenumber\fP. With this option, that can be
227 customized. Fio will recognize and replace the following keywords in this
228 string:
229 .RS
230 .RS
231 .TP
232 .B $jobname
233 The name of the worker thread or process.
234 .TP
235 .B $jobnum
236 The incremental number of the worker thread or process.
237 .TP
238 .B $filenum
239 The incremental number of the file for that worker thread or process.
240 .RE
241 .P
242 To have dependent jobs share a set of files, this option can be set to
243 have fio generate filenames that are shared between the two. For instance,
244 if \fBtestfiles.$filenum\fR is specified, file number 4 for any job will
245 be named \fBtestfiles.4\fR. The default of \fB$jobname.$jobnum.$filenum\fR
246 will be used if no other format specifier is given.
247 .RE
248 .P
249 .TP
250 .BI unique_filename \fR=\fPbool
251 To avoid collisions between networked clients, fio defaults to prefixing
252 any generated filenames (with a directory specified) with the source of
253 the client connecting. To disable this behavior, set this option to 0.
254 .TP
255 .BI lockfile \fR=\fPstr
256 Fio defaults to not locking any files before it does IO to them. If a file or
257 file descriptor is shared, fio can serialize IO to that file to make the end
258 result consistent. This is usual for emulating real workloads that share files.
259 The lock modes are:
260 .RS
261 .RS
262 .TP
263 .B none
264 No locking. This is the default.
265 .TP
266 .B exclusive
267 Only one thread or process may do IO at a time, excluding all others.
268 .TP
269 .B readwrite
270 Read-write locking on the file. Many readers may access the file at the same
271 time, but writes get exclusive access.
272 .RE
273 .RE
274 .P
275 .BI opendir \fR=\fPstr
276 Recursively open any files below directory \fIstr\fR.
277 .TP
278 .BI readwrite \fR=\fPstr "\fR,\fP rw" \fR=\fPstr
279 Type of I/O pattern.  Accepted values are:
280 .RS
281 .RS
282 .TP
283 .B read
284 Sequential reads.
285 .TP
286 .B write
287 Sequential writes.
288 .TP
289 .B trim
290 Sequential trim (Linux block devices only).
291 .TP
292 .B randread
293 Random reads.
294 .TP
295 .B randwrite
296 Random writes.
297 .TP
298 .B randtrim
299 Random trim (Linux block devices only).
300 .TP
301 .B rw, readwrite
302 Mixed sequential reads and writes.
303 .TP
304 .B randrw
305 Mixed random reads and writes.
306 .TP
307 .B trimwrite
308 Trim and write mixed workload. Blocks will be trimmed first, then the same
309 blocks will be written to.
310 .RE
311 .P
312 Fio defaults to read if the option is not specified.
313 For mixed I/O, the default split is 50/50. For certain types of io the result
314 may still be skewed a bit, since the speed may be different. It is possible to
315 specify a number of IO's to do before getting a new offset, this is done by
316 appending a `:\fI<nr>\fR to the end of the string given. For a random read, it
317 would look like \fBrw=randread:8\fR for passing in an offset modifier with a
318 value of 8. If the postfix is used with a sequential IO pattern, then the value
319 specified will be added to the generated offset for each IO. For instance,
320 using \fBrw=write:4k\fR will skip 4k for every write. It turns sequential IO
321 into sequential IO with holes. See the \fBrw_sequencer\fR option.
322 .RE
323 .TP
324 .BI rw_sequencer \fR=\fPstr
325 If an offset modifier is given by appending a number to the \fBrw=<str>\fR line,
326 then this option controls how that number modifies the IO offset being
327 generated. Accepted values are:
328 .RS
329 .RS
330 .TP
331 .B sequential
332 Generate sequential offset
333 .TP
334 .B identical
335 Generate the same offset
336 .RE
337 .P
338 \fBsequential\fR is only useful for random IO, where fio would normally
339 generate a new random offset for every IO. If you append eg 8 to randread, you
340 would get a new random offset for every 8 IO's. The result would be a seek for
341 only every 8 IO's, instead of for every IO. Use \fBrw=randread:8\fR to specify
342 that. As sequential IO is already sequential, setting \fBsequential\fR for that
343 would not result in any differences.  \fBidentical\fR behaves in a similar
344 fashion, except it sends the same offset 8 number of times before generating a
345 new offset.
346 .RE
347 .P
348 .TP
349 .BI kb_base \fR=\fPint
350 The base unit for a kilobyte. The defacto base is 2^10, 1024.  Storage
351 manufacturers like to use 10^3 or 1000 as a base ten unit instead, for obvious
352 reasons. Allowed values are 1024 or 1000, with 1024 being the default.
353 .TP
354 .BI unified_rw_reporting \fR=\fPbool
355 Fio normally reports statistics on a per data direction basis, meaning that
356 read, write, and trim are accounted and reported separately. If this option is
357 set fio sums the results and reports them as "mixed" instead.
358 .TP
359 .BI randrepeat \fR=\fPbool
360 Seed the random number generator used for random I/O patterns in a predictable
361 way so the pattern is repeatable across runs.  Default: true.
362 .TP
363 .BI allrandrepeat \fR=\fPbool
364 Seed all random number generators in a predictable way so results are
365 repeatable across runs.  Default: false.
366 .TP
367 .BI randseed \fR=\fPint
368 Seed the random number generators based on this seed value, to be able to
369 control what sequence of output is being generated. If not set, the random
370 sequence depends on the \fBrandrepeat\fR setting.
371 .TP
372 .BI fallocate \fR=\fPstr
373 Whether pre-allocation is performed when laying down files. Accepted values
374 are:
375 .RS
376 .RS
377 .TP
378 .B none
379 Do not pre-allocate space.
380 .TP
381 .B posix
382 Pre-allocate via \fBposix_fallocate\fR\|(3).
383 .TP
384 .B keep
385 Pre-allocate via \fBfallocate\fR\|(2) with FALLOC_FL_KEEP_SIZE set.
386 .TP
387 .B 0
388 Backward-compatible alias for 'none'.
389 .TP
390 .B 1
391 Backward-compatible alias for 'posix'.
392 .RE
393 .P
394 May not be available on all supported platforms. 'keep' is only
395 available on Linux. If using ZFS on Solaris this must be set to 'none'
396 because ZFS doesn't support it. Default: 'posix'.
397 .RE
398 .TP
399 .BI fadvise_hint \fR=\fPbool
400 Use \fBposix_fadvise\fR\|(2) to advise the kernel what I/O patterns
401 are likely to be issued. Default: true.
402 .TP
403 .BI fadvise_stream \fR=\fPint
404 Use \fBposix_fadvise\fR\|(2) to advise the kernel what stream ID the
405 writes issued belong to. Only supported on Linux. Note, this option
406 may change going forward.
407 .TP
408 .BI size \fR=\fPint
409 Total size of I/O for this job.  \fBfio\fR will run until this many bytes have
410 been transferred, unless limited by other options (\fBruntime\fR, for instance,
411 or increased/descreased by \fBio_size\fR). Unless \fBnrfiles\fR and
412 \fBfilesize\fR options are given, this amount will be divided between the
413 available files for the job. If not set, fio will use the full size of the
414 given files or devices. If the files do not exist, size must be given. It is
415 also possible to give size as a percentage between 1 and 100. If size=20% is
416 given, fio will use 20% of the full size of the given files or devices.
417 .TP
418 .BI io_size \fR=\fPint "\fR,\fB io_limit \fR=\fPint
419 Normally fio operates within the region set by \fBsize\fR, which means that
420 the \fBsize\fR option sets both the region and size of IO to be performed.
421 Sometimes that is not what you want. With this option, it is possible to
422 define just the amount of IO that fio should do. For instance, if \fBsize\fR
423 is set to 20G and \fBio_limit\fR is set to 5G, fio will perform IO within
424 the first 20G but exit when 5G have been done. The opposite is also
425 possible - if \fBsize\fR is set to 20G, and \fBio_size\fR is set to 40G, then
426 fio will do 40G of IO within the 0..20G region.
427 .TP
428 .BI fill_device \fR=\fPbool "\fR,\fB fill_fs" \fR=\fPbool
429 Sets size to something really large and waits for ENOSPC (no space left on
430 device) as the terminating condition. Only makes sense with sequential write.
431 For a read workload, the mount point will be filled first then IO started on
432 the result. This option doesn't make sense if operating on a raw device node,
433 since the size of that is already known by the file system. Additionally,
434 writing beyond end-of-device will not return ENOSPC there.
435 .TP
436 .BI filesize \fR=\fPirange
437 Individual file sizes. May be a range, in which case \fBfio\fR will select sizes
438 for files at random within the given range, limited to \fBsize\fR in total (if
439 that is given). If \fBfilesize\fR is not specified, each created file is the
440 same size.
441 .TP
442 .BI file_append \fR=\fPbool
443 Perform IO after the end of the file. Normally fio will operate within the
444 size of a file. If this option is set, then fio will append to the file
445 instead. This has identical behavior to setting \fRoffset\fP to the size
446 of a file. This option is ignored on non-regular files.
447 .TP
448 .BI blocksize \fR=\fPint[,int] "\fR,\fB bs" \fR=\fPint[,int]
449 Block size for I/O units.  Default: 4k.  Values for reads, writes, and trims
450 can be specified separately in the format \fIread\fR,\fIwrite\fR,\fItrim\fR
451 either of which may be empty to leave that value at its default. If a trailing
452 comma isn't given, the remainder will inherit the last value set.
453 .TP
454 .BI blocksize_range \fR=\fPirange[,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange]
455 Specify a range of I/O block sizes.  The issued I/O unit will always be a
456 multiple of the minimum size, unless \fBblocksize_unaligned\fR is set.  Applies
457 to both reads and writes if only one range is given, but can be specified
458 separately with a comma separating the values. Example: bsrange=1k-4k,2k-8k.
459 Also (see \fBblocksize\fR).
460 .TP
461 .BI bssplit \fR=\fPstr
462 This option allows even finer grained control of the block sizes issued,
463 not just even splits between them. With this option, you can weight various
464 block sizes for exact control of the issued IO for a job that has mixed
465 block sizes. The format of the option is bssplit=blocksize/percentage,
466 optionally adding as many definitions as needed separated by a colon.
467 Example: bssplit=4k/10:64k/50:32k/40 would issue 50% 64k blocks, 10% 4k
468 blocks and 40% 32k blocks. \fBbssplit\fR also supports giving separate
469 splits to reads and writes. The format is identical to what the
470 \fBbs\fR option accepts, the read and write parts are separated with a
471 comma.
472 .TP
473 .B blocksize_unaligned\fR,\fP bs_unaligned
474 If set, any size in \fBblocksize_range\fR may be used.  This typically won't
475 work with direct I/O, as that normally requires sector alignment.
476 .TP
477 .BI blockalign \fR=\fPint[,int] "\fR,\fB ba" \fR=\fPint[,int]
478 At what boundary to align random IO offsets. Defaults to the same as 'blocksize'
479 the minimum blocksize given.  Minimum alignment is typically 512b
480 for using direct IO, though it usually depends on the hardware block size.
481 This option is mutually exclusive with using a random map for files, so it
482 will turn off that option.
483 .TP
484 .BI bs_is_seq_rand \fR=\fPbool
485 If this option is set, fio will use the normal read,write blocksize settings as
486 sequential,random instead. Any random read or write will use the WRITE
487 blocksize settings, and any sequential read or write will use the READ
488 blocksize setting.
489 .TP
490 .B zero_buffers
491 Initialize buffers with all zeros. Default: fill buffers with random data.
492 .TP
493 .B refill_buffers
494 If this option is given, fio will refill the IO buffers on every submit. The
495 default is to only fill it at init time and reuse that data. Only makes sense
496 if zero_buffers isn't specified, naturally. If data verification is enabled,
497 refill_buffers is also automatically enabled.
498 .TP
499 .BI scramble_buffers \fR=\fPbool
500 If \fBrefill_buffers\fR is too costly and the target is using data
501 deduplication, then setting this option will slightly modify the IO buffer
502 contents to defeat normal de-dupe attempts. This is not enough to defeat
503 more clever block compression attempts, but it will stop naive dedupe
504 of blocks. Default: true.
505 .TP
506 .BI buffer_compress_percentage \fR=\fPint
507 If this is set, then fio will attempt to provide IO buffer content (on WRITEs)
508 that compress to the specified level. Fio does this by providing a mix of
509 random data and a fixed pattern. The fixed pattern is either zeroes, or the
510 pattern specified by \fBbuffer_pattern\fR. If the pattern option is used, it
511 might skew the compression ratio slightly. Note that this is per block size
512 unit, for file/disk wide compression level that matches this setting. Note
513 that this is per block size unit, for file/disk wide compression level that
514 matches this setting, you'll also want to set refill_buffers.
515 .TP
516 .BI buffer_compress_chunk \fR=\fPint
517 See \fBbuffer_compress_percentage\fR. This setting allows fio to manage how
518 big the ranges of random data and zeroed data is. Without this set, fio will
519 provide \fBbuffer_compress_percentage\fR of blocksize random data, followed by
520 the remaining zeroed. With this set to some chunk size smaller than the block
521 size, fio can alternate random and zeroed data throughout the IO buffer.
522 .TP
523 .BI buffer_pattern \fR=\fPstr
524 If set, fio will fill the IO buffers with this pattern. If not set, the contents
525 of IO buffers is defined by the other options related to buffer contents. The
526 setting can be any pattern of bytes, and can be prefixed with 0x for hex
527 values. It may also be a string, where the string must then be wrapped with
528 "", e.g.:
529 .RS
530 .RS
531 \fBbuffer_pattern\fR="abcd"
532 .RS
533 or
534 .RE
535 \fBbuffer_pattern\fR=-12
536 .RS
537 or
538 .RE
539 \fBbuffer_pattern\fR=0xdeadface
540 .RE
541 .LP
542 Also you can combine everything together in any order:
543 .LP
544 .RS
545 \fBbuffer_pattern\fR=0xdeadface"abcd"-12
546 .RE
547 .RE
548 .TP
549 .BI dedupe_percentage \fR=\fPint
550 If set, fio will generate this percentage of identical buffers when writing.
551 These buffers will be naturally dedupable. The contents of the buffers depend
552 on what other buffer compression settings have been set. It's possible to have
553 the individual buffers either fully compressible, or not at all. This option
554 only controls the distribution of unique buffers.
555 .TP
556 .BI nrfiles \fR=\fPint
557 Number of files to use for this job.  Default: 1.
558 .TP
559 .BI openfiles \fR=\fPint
560 Number of files to keep open at the same time.  Default: \fBnrfiles\fR.
561 .TP
562 .BI file_service_type \fR=\fPstr
563 Defines how files to service are selected.  The following types are defined:
564 .RS
565 .RS
566 .TP
567 .B random
568 Choose a file at random.
569 .TP
570 .B roundrobin
571 Round robin over opened files (default).
572 .TP
573 .B sequential
574 Do each file in the set sequentially.
575 .TP
576 .B zipf
577 Use a zipfian distribution to decide what file to access.
578 .TP
579 .B pareto
580 Use a pareto distribution to decide what file to access.
581 .TP
582 .B gauss
583 Use a gaussian (normal) distribution to decide what file to access.
584 .RE
585 .P
586 For \fBrandom\fR, \fBroundrobin\fR, and \fBsequential\fR, a postfix can be
587 appended to tell fio how many I/Os to issue before switching to a new file.
588 For example, specifying \fBfile_service_type=random:8\fR would cause fio to
589 issue \fI8\fR I/Os before selecting a new file at random. For the non-uniform
590 distributions, a floating point postfix can be given to influence how the
591 distribution is skewed. See \fBrandom_distribution\fR for a description of how
592 that would work.
593 .RE
594 .TP
595 .BI ioengine \fR=\fPstr
596 Defines how the job issues I/O.  The following types are defined:
597 .RS
598 .RS
599 .TP
600 .B sync
601 Basic \fBread\fR\|(2) or \fBwrite\fR\|(2) I/O.  \fBfseek\fR\|(2) is used to
602 position the I/O location.
603 .TP
604 .B psync
605 Basic \fBpread\fR\|(2) or \fBpwrite\fR\|(2) I/O.
606 Default on all supported operating systems except for Windows.
607 .TP
608 .B vsync
609 Basic \fBreadv\fR\|(2) or \fBwritev\fR\|(2) I/O. Will emulate queuing by
610 coalescing adjacent IOs into a single submission.
611 .TP
612 .B pvsync
613 Basic \fBpreadv\fR\|(2) or \fBpwritev\fR\|(2) I/O.
614 .TP
615 .B pvsync2
616 Basic \fBpreadv2\fR\|(2) or \fBpwritev2\fR\|(2) I/O.
617 .TP
618 .B libaio
619 Linux native asynchronous I/O. This ioengine defines engine specific options.
620 .TP
621 .B posixaio
622 POSIX asynchronous I/O using \fBaio_read\fR\|(3) and \fBaio_write\fR\|(3).
623 .TP
624 .B solarisaio
625 Solaris native asynchronous I/O.
626 .TP
627 .B windowsaio
628 Windows native asynchronous I/O. Default on Windows.
629 .TP
630 .B mmap
631 File is memory mapped with \fBmmap\fR\|(2) and data copied using
632 \fBmemcpy\fR\|(3).
633 .TP
634 .B splice
635 \fBsplice\fR\|(2) is used to transfer the data and \fBvmsplice\fR\|(2) to
636 transfer data from user-space to the kernel.
637 .TP
638 .B sg
639 SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if
640 the target is an sg character device, we use \fBread\fR\|(2) and
641 \fBwrite\fR\|(2) for asynchronous I/O.
642 .TP
643 .B null
644 Doesn't transfer any data, just pretends to.  Mainly used to exercise \fBfio\fR
645 itself and for debugging and testing purposes.
646 .TP
647 .B net
648 Transfer over the network.  The protocol to be used can be defined with the
649 \fBprotocol\fR parameter.  Depending on the protocol, \fBfilename\fR,
650 \fBhostname\fR, \fBport\fR, or \fBlisten\fR must be specified.
651 This ioengine defines engine specific options.
652 .TP
653 .B netsplice
654 Like \fBnet\fR, but uses \fBsplice\fR\|(2) and \fBvmsplice\fR\|(2) to map data
655 and send/receive. This ioengine defines engine specific options.
656 .TP
657 .B cpuio
658 Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and
659 \fBcpuchunks\fR parameters. A job never finishes unless there is at least one
660 non-cpuio job.
661 .TP
662 .B guasi
663 The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface
664 approach to asynchronous I/O.
665 .br
666 See <\-lib.html>.
667 .TP
668 .B rdma
669 The RDMA I/O engine supports both RDMA memory semantics (RDMA_WRITE/RDMA_READ)
670 and channel semantics (Send/Recv) for the InfiniBand, RoCE and iWARP protocols.
671 .TP
672 .B external
673 Loads an external I/O engine object file.  Append the engine filename as
674 `:\fIenginepath\fR'.
675 .TP
676 .B falloc
677    IO engine that does regular linux native fallocate call to simulate data
678 transfer as fio ioengine
679 .br
680   DDIR_READ  does fallocate(,mode = FALLOC_FL_KEEP_SIZE,)
681 .br
682   DIR_WRITE does fallocate(,mode = 0)
683 .br
685 .TP
686 .B e4defrag
687 IO engine that does regular EXT4_IOC_MOVE_EXT ioctls to simulate defragment activity
688 request to DDIR_WRITE event
689 .TP
690 .B rbd
691 IO engine supporting direct access to Ceph Rados Block Devices (RBD) via librbd
692 without the need to use the kernel rbd driver. This ioengine defines engine specific
693 options.
694 .TP
695 .B gfapi
696 Using Glusterfs libgfapi sync interface to direct access to Glusterfs volumes without
697 having to go through FUSE. This ioengine defines engine specific
698 options.
699 .TP
700 .B gfapi_async
701 Using Glusterfs libgfapi async interface to direct access to Glusterfs volumes without
702 having to go through FUSE. This ioengine defines engine specific
703 options.
704 .TP
705 .B libhdfs
706 Read and write through Hadoop (HDFS).  The \fBfilename\fR option is used to
707 specify host,port of the hdfs name-node to connect. This engine interprets
708 offsets a little differently. In HDFS, files once created cannot be modified.
709 So random writes are not possible. To imitate this, libhdfs engine expects
710 bunch of small files to be created over HDFS, and engine will randomly pick a
711 file out of those files based on the offset generated by fio backend. (see the
712 example job file to create such files, use rw=write option). Please note, you
713 might want to set necessary environment variables to work with hdfs/libhdfs
714 properly.
715 .TP
716 .B mtd
717 Read, write and erase an MTD character device (e.g., /dev/mtd0). Discards are
718 treated as erases. Depending on the underlying device type, the I/O may have
719 to go in a certain pattern, e.g., on NAND, writing sequentially to erase blocks
720 and discarding before overwriting. The writetrim mode works well for this
721 constraint.
722 .TP
723 .B pmemblk
724 Read and write through the NVML libpmemblk interface.
725 .TP
726 .B dev-dax
727 Read and write through a DAX device exposed from persistent memory.
728 .RE
729 .P
730 .RE
731 .TP
732 .BI iodepth \fR=\fPint
733 Number of I/O units to keep in flight against the file. Note that increasing
734 iodepth beyond 1 will not affect synchronous ioengines (except for small
735 degress when verify_async is in use). Even async engines may impose OS
736 restrictions causing the desired depth not to be achieved.  This may happen on
737 Linux when using libaio and not setting \fBdirect\fR=1, since buffered IO is
738 not async on that OS. Keep an eye on the IO depth distribution in the
739 fio output to verify that the achieved depth is as expected. Default: 1.
740 .TP
741 .BI iodepth_batch \fR=\fPint "\fR,\fP iodepth_batch_submit" \fR=\fPint
742 This defines how many pieces of IO to submit at once. It defaults to 1
743 which means that we submit each IO as soon as it is available, but can
744 be raised to submit bigger batches of IO at the time. If it is set to 0
745 the \fBiodepth\fR value will be used.
746 .TP
747 .BI iodepth_batch_complete_min \fR=\fPint "\fR,\fP iodepth_batch_complete" \fR=\fPint
748 This defines how many pieces of IO to retrieve at once. It defaults to 1 which
749  means that we'll ask for a minimum of 1 IO in the retrieval process from the
750 kernel. The IO retrieval will go on until we hit the limit set by
751 \fBiodepth_low\fR. If this variable is set to 0, then fio will always check for
752 completed events before queuing more IO. This helps reduce IO latency, at the
753 cost of more retrieval system calls.
754 .TP
755 .BI iodepth_batch_complete_max \fR=\fPint
756 This defines maximum pieces of IO to
757 retrieve at once. This variable should be used along with
758 \fBiodepth_batch_complete_min\fR=int variable, specifying the range
759 of min and max amount of IO which should be retrieved. By default
760 it is equal to \fBiodepth_batch_complete_min\fR value.
762 Example #1:
763 .RS
764 .RS
765 \fBiodepth_batch_complete_min\fR=1
766 .LP
767 \fBiodepth_batch_complete_max\fR=<iodepth>
768 .RE
770 which means that we will retrieve at least 1 IO and up to the
771 whole submitted queue depth. If none of IO has been completed
772 yet, we will wait.
774 Example #2:
775 .RS
776 \fBiodepth_batch_complete_min\fR=0
777 .LP
778 \fBiodepth_batch_complete_max\fR=<iodepth>
779 .RE
781 which means that we can retrieve up to the whole submitted
782 queue depth, but if none of IO has been completed yet, we will
783 NOT wait and immediately exit the system call. In this example
784 we simply do polling.
785 .RE
786 .TP
787 .BI iodepth_low \fR=\fPint
788 Low watermark indicating when to start filling the queue again.  Default:
789 \fBiodepth\fR.
790 .TP
791 .BI io_submit_mode \fR=\fPstr
792 This option controls how fio submits the IO to the IO engine. The default is
793 \fBinline\fR, which means that the fio job threads submit and reap IO directly.
794 If set to \fBoffload\fR, the job threads will offload IO submission to a
795 dedicated pool of IO threads. This requires some coordination and thus has a
796 bit of extra overhead, especially for lower queue depth IO where it can
797 increase latencies. The benefit is that fio can manage submission rates
798 independently of the device completion rates. This avoids skewed latency
799 reporting if IO gets back up on the device side (the coordinated omission
800 problem).
801 .TP
802 .BI direct \fR=\fPbool
803 If true, use non-buffered I/O (usually O_DIRECT).  Default: false.
804 .TP
805 .BI atomic \fR=\fPbool
806 If value is true, attempt to use atomic direct IO. Atomic writes are guaranteed
807 to be stable once acknowledged by the operating system. Only Linux supports
808 O_ATOMIC right now.
809 .TP
810 .BI buffered \fR=\fPbool
811 If true, use buffered I/O.  This is the opposite of the \fBdirect\fR parameter.
812 Default: true.
813 .TP
814 .BI offset \fR=\fPint
815 Offset in the file to start I/O. Data before the offset will not be touched.
816 .TP
817 .BI offset_increment \fR=\fPint
818 If this is provided, then the real offset becomes the
819 offset + offset_increment * thread_number, where the thread number is a
820 counter that starts at 0 and is incremented for each sub-job (i.e. when
821 numjobs option is specified). This option is useful if there are several jobs
822 which are intended to operate on a file in parallel disjoint segments, with
823 even spacing between the starting points.
824 .TP
825 .BI number_ios \fR=\fPint
826 Fio will normally perform IOs until it has exhausted the size of the region
827 set by \fBsize\fR, or if it exhaust the allocated time (or hits an error
828 condition). With this setting, the range/size can be set independently of
829 the number of IOs to perform. When fio reaches this number, it will exit
830 normally and report status. Note that this does not extend the amount
831 of IO that will be done, it will only stop fio if this condition is met
832 before other end-of-job criteria.
833 .TP
834 .BI fsync \fR=\fPint
835 How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data.  If
836 0, don't sync.  Default: 0.
837 .TP
838 .BI fdatasync \fR=\fPint
839 Like \fBfsync\fR, but uses \fBfdatasync\fR\|(2) instead to only sync the
840 data parts of the file. Default: 0.
841 .TP
842 .BI write_barrier \fR=\fPint
843 Make every Nth write a barrier write.
844 .TP
845 .BI sync_file_range \fR=\fPstr:int
846 Use \fBsync_file_range\fR\|(2) for every \fRval\fP number of write operations. Fio will
847 track range of writes that have happened since the last \fBsync_file_range\fR\|(2) call.
848 \fRstr\fP can currently be one or more of:
849 .RS
850 .TP
851 .B wait_before
853 .TP
854 .B write
856 .TP
857 .B wait_after
859 .TP
860 .RE
861 .P
862 So if you do sync_file_range=wait_before,write:8, fio would use
864 Also see the \fBsync_file_range\fR\|(2) man page.  This option is Linux specific.
865 .TP
866 .BI overwrite \fR=\fPbool
867 If writing, setup the file first and do overwrites.  Default: false.
868 .TP
869 .BI end_fsync \fR=\fPbool
870 Sync file contents when a write stage has completed.  Default: false.
871 .TP
872 .BI fsync_on_close \fR=\fPbool
873 If true, sync file contents on close.  This differs from \fBend_fsync\fR in that
874 it will happen on every close, not just at the end of the job.  Default: false.
875 .TP
876 .BI rwmixread \fR=\fPint
877 Percentage of a mixed workload that should be reads. Default: 50.
878 .TP
879 .BI rwmixwrite \fR=\fPint
880 Percentage of a mixed workload that should be writes.  If \fBrwmixread\fR and
881 \fBrwmixwrite\fR are given and do not sum to 100%, the latter of the two
882 overrides the first. This may interfere with a given rate setting, if fio is
883 asked to limit reads or writes to a certain rate. If that is the case, then
884 the distribution may be skewed. Default: 50.
885 .TP
886 .BI random_distribution \fR=\fPstr:float
887 By default, fio will use a completely uniform random distribution when asked
888 to perform random IO. Sometimes it is useful to skew the distribution in
889 specific ways, ensuring that some parts of the data is more hot than others.
890 Fio includes the following distribution models:
891 .RS
892 .TP
893 .B random
894 Uniform random distribution
895 .TP
896 .B zipf
897 Zipf distribution
898 .TP
899 .B pareto
900 Pareto distribution
901 .TP
902 .B gauss
903 Normal (gaussian) distribution
904 .TP
905 .B zoned
906 Zoned random distribution
907 .TP
908 .RE
909 When using a \fBzipf\fR or \fBpareto\fR distribution, an input value is also
910 needed to define the access pattern. For \fBzipf\fR, this is the zipf theta.
911 For \fBpareto\fR, it's the pareto power. Fio includes a test program, genzipf,
912 that can be used visualize what the given input values will yield in terms of
913 hit rates. If you wanted to use \fBzipf\fR with a theta of 1.2, you would use
914 random_distribution=zipf:1.2 as the option. If a non-uniform model is used,
915 fio will disable use of the random map. For the \fBgauss\fR distribution, a
916 normal deviation is supplied as a value between 0 and 100.
917 .P
918 .RS
919 For a \fBzoned\fR distribution, fio supports specifying percentages of IO
920 access that should fall within what range of the file or device. For example,
921 given a criteria of:
922 .P
923 .RS
924 60% of accesses should be to the first 10%
925 .RE
926 .RS
927 30% of accesses should be to the next 20%
928 .RE
929 .RS
930 8% of accesses should be to to the next 30%
931 .RE
932 .RS
933 2% of accesses should be to the next 40%
934 .RE
935 .P
936 we can define that through zoning of the random accesses. For the above
937 example, the user would do:
938 .P
939 .RS
940 .B random_distribution=zoned:60/10:30/20:8/30:2/40
941 .RE
942 .P
943 similarly to how \fBbssplit\fR works for setting ranges and percentages of block
944 sizes. Like \fBbssplit\fR, it's possible to specify separate zones for reads,
945 writes, and trims. If just one set is given, it'll apply to all of them.
946 .RE
947 .TP
948 .BI percentage_random \fR=\fPint
949 For a random workload, set how big a percentage should be random. This defaults
950 to 100%, in which case the workload is fully random. It can be set from
951 anywhere from 0 to 100.  Setting it to 0 would make the workload fully
952 sequential. It is possible to set different values for reads, writes, and
953 trim. To do so, simply use a comma separated list. See \fBblocksize\fR.
954 .TP
955 .B norandommap
956 Normally \fBfio\fR will cover every block of the file when doing random I/O. If
957 this parameter is given, a new offset will be chosen without looking at past
958 I/O history.  This parameter is mutually exclusive with \fBverify\fR.
959 .TP
960 .BI softrandommap \fR=\fPbool
961 See \fBnorandommap\fR. If fio runs with the random block map enabled and it
962 fails to allocate the map, if this option is set it will continue without a
963 random block map. As coverage will not be as complete as with random maps, this
964 option is disabled by default.
965 .TP
966 .BI random_generator \fR=\fPstr
967 Fio supports the following engines for generating IO offsets for random IO:
968 .RS
969 .TP
970 .B tausworthe
971 Strong 2^88 cycle random number generator
972 .TP
973 .B lfsr
974 Linear feedback shift register generator
975 .TP
976 .B tausworthe64
977 Strong 64-bit 2^258 cycle random number generator
978 .TP
979 .RE
980 .P
981 Tausworthe is a strong random number generator, but it requires tracking on the
982 side if we want to ensure that blocks are only read or written once. LFSR
983 guarantees that we never generate the same offset twice, and it's also less
984 computationally expensive. It's not a true random generator, however, though
985 for IO purposes it's typically good enough. LFSR only works with single block
986 sizes, not with workloads that use multiple block sizes. If used with such a
987 workload, fio may read or write some blocks multiple times. The default
988 value is tausworthe, unless the required space exceeds 2^32 blocks. If it does,
989 then tausworthe64 is selected automatically.
990 .TP
991 .BI nice \fR=\fPint
992 Run job with given nice value.  See \fBnice\fR\|(2).
993 .TP
994 .BI prio \fR=\fPint
995 Set I/O priority value of this job between 0 (highest) and 7 (lowest).  See
996 \fBionice\fR\|(1).
997 .TP
998 .BI prioclass \fR=\fPint
999 Set I/O priority class.  See \fBionice\fR\|(1).
1000 .TP
1001 .BI thinktime \fR=\fPint
1002 Stall job for given number of microseconds between issuing I/Os.
1003 .TP
1004 .BI thinktime_spin \fR=\fPint
1005 Pretend to spend CPU time for given number of microseconds, sleeping the rest
1006 of the time specified by \fBthinktime\fR.  Only valid if \fBthinktime\fR is set.
1007 .TP
1008 .BI thinktime_blocks \fR=\fPint
1009 Only valid if thinktime is set - control how many blocks to issue, before
1010 waiting \fBthinktime\fR microseconds. If not set, defaults to 1 which will
1011 make fio wait \fBthinktime\fR microseconds after every block. This
1012 effectively makes any queue depth setting redundant, since no more than 1 IO
1013 will be queued before we have to complete it and do our thinktime. In other
1014 words, this setting effectively caps the queue depth if the latter is larger.
1015 Default: 1.
1016 .TP
1017 .BI rate \fR=\fPint
1018 Cap bandwidth used by this job. The number is in bytes/sec, the normal postfix
1019 rules apply. You can use \fBrate\fR=500k to limit reads and writes to 500k each,
1020 or you can specify read and writes separately. Using \fBrate\fR=1m,500k would
1021 limit reads to 1MB/sec and writes to 500KB/sec. Capping only reads or writes
1022 can be done with \fBrate\fR=,500k or \fBrate\fR=500k,. The former will only
1023 limit writes (to 500KB/sec), the latter will only limit reads.
1024 .TP
1025 .BI rate_min \fR=\fPint
1026 Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth.
1027 Failing to meet this requirement will cause the job to exit. The same format
1028 as \fBrate\fR is used for read vs write separation.
1029 .TP
1030 .BI rate_iops \fR=\fPint
1031 Cap the bandwidth to this number of IOPS. Basically the same as rate, just
1032 specified independently of bandwidth. The same format as \fBrate\fR is used for
1033 read vs write separation. If \fBblocksize\fR is a range, the smallest block
1034 size is used as the metric.
1035 .TP
1036 .BI rate_iops_min \fR=\fPint
1037 If this rate of I/O is not met, the job will exit. The same format as \fBrate\fR
1038 is used for read vs write separation.
1039 .TP
1040 .BI rate_process \fR=\fPstr
1041 This option controls how fio manages rated IO submissions. The default is
1042 \fBlinear\fR, which submits IO in a linear fashion with fixed delays between
1043 IOs that gets adjusted based on IO completion rates. If this is set to
1044 \fBpoisson\fR, fio will submit IO based on a more real world random request
1045 flow, known as the Poisson process
1046 ( The lambda will be
1047 10^6 / IOPS for the given workload.
1048 .TP
1049 .BI rate_cycle \fR=\fPint
1050 Average bandwidth for \fBrate\fR and \fBrate_min\fR over this number of
1051 milliseconds.  Default: 1000ms.
1052 .TP
1053 .BI latency_target \fR=\fPint
1054 If set, fio will attempt to find the max performance point that the given
1055 workload will run at while maintaining a latency below this target. The
1056 values is given in microseconds. See \fBlatency_window\fR and
1057 \fBlatency_percentile\fR.
1058 .TP
1059 .BI latency_window \fR=\fPint
1060 Used with \fBlatency_target\fR to specify the sample window that the job
1061 is run at varying queue depths to test the performance. The value is given
1062 in microseconds.
1063 .TP
1064 .BI latency_percentile \fR=\fPfloat
1065 The percentage of IOs that must fall within the criteria specified by
1066 \fBlatency_target\fR and \fBlatency_window\fR. If not set, this defaults
1067 to 100.0, meaning that all IOs must be equal or below to the value set
1068 by \fBlatency_target\fR.
1069 .TP
1070 .BI max_latency \fR=\fPint
1071 If set, fio will exit the job if it exceeds this maximum latency. It will exit
1072 with an ETIME error.
1073 .TP
1074 .BI cpumask \fR=\fPint
1075 Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job
1076 may run on.  See \fBsched_setaffinity\fR\|(2).
1077 .TP
1078 .BI cpus_allowed \fR=\fPstr
1079 Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers.
1080 .TP
1081 .BI cpus_allowed_policy \fR=\fPstr
1082 Set the policy of how fio distributes the CPUs specified by \fBcpus_allowed\fR
1083 or \fBcpumask\fR. Two policies are supported:
1084 .RS
1085 .RS
1086 .TP
1087 .B shared
1088 All jobs will share the CPU set specified.
1089 .TP
1090 .B split
1091 Each job will get a unique CPU from the CPU set.
1092 .RE
1093 .P
1094 \fBshared\fR is the default behaviour, if the option isn't specified. If
1095 \fBsplit\fR is specified, then fio will assign one cpu per job. If not enough
1096 CPUs are given for the jobs listed, then fio will roundrobin the CPUs in
1097 the set.
1098 .RE
1099 .P
1100 .TP
1101 .BI numa_cpu_nodes \fR=\fPstr
1102 Set this job running on specified NUMA nodes' CPUs. The arguments allow
1103 comma delimited list of cpu numbers, A-B ranges, or 'all'.
1104 .TP
1105 .BI numa_mem_policy \fR=\fPstr
1106 Set this job's memory policy and corresponding NUMA nodes. Format of
1107 the arguments:
1108 .RS
1109 .TP
1110 .B <mode>[:<nodelist>]
1111 .TP
1112 .B mode
1113 is one of the following memory policy:
1114 .TP
1115 .B default, prefer, bind, interleave, local
1116 .TP
1117 .RE
1118 For \fBdefault\fR and \fBlocal\fR memory policy, no \fBnodelist\fR is
1119 needed to be specified. For \fBprefer\fR, only one node is
1120 allowed. For \fBbind\fR and \fBinterleave\fR, \fBnodelist\fR allows
1121 comma delimited list of numbers, A-B ranges, or 'all'.
1122 .TP
1123 .BI startdelay \fR=\fPirange
1124 Delay start of job for the specified number of seconds. Supports all time
1125 suffixes to allow specification of hours, minutes, seconds and
1126 milliseconds - seconds are the default if a unit is omitted.
1127 Can be given as a range which causes each thread to choose randomly out of the
1128 range.
1129 .TP
1130 .BI runtime \fR=\fPint
1131 Terminate processing after the specified number of seconds.
1132 .TP
1133 .B time_based
1134 If given, run for the specified \fBruntime\fR duration even if the files are
1135 completely read or written. The same workload will be repeated as many times
1136 as \fBruntime\fR allows.
1137 .TP
1138 .BI ramp_time \fR=\fPint
1139 If set, fio will run the specified workload for this amount of time before
1140 logging any performance numbers. Useful for letting performance settle before
1141 logging results, thus minimizing the runtime required for stable results. Note
1142 that the \fBramp_time\fR is considered lead in time for a job, thus it will
1143 increase the total runtime if a special timeout or runtime is specified.
1144 .TP
1145 .BI steadystate \fR=\fPstr:float "\fR,\fP ss" \fR=\fPstr:float
1146 Define the criterion and limit for assessing steady state performance. The
1147 first parameter designates the criterion whereas the second parameter sets the
1148 threshold. When the criterion falls below the threshold for the specified
1149 duration, the job will stop. For example, iops_slope:0.1% will direct fio
1150 to terminate the job when the least squares regression slope falls below 0.1%
1151 of the mean IOPS. If group_reporting is enabled this will apply to all jobs in
1152 the group. All assessments are carried out using only data from the rolling
1153 collection window. Threshold limits can be expressed as a fixed value or as a
1154 percentage of the mean in the collection window. Below are the available steady
1155 state assessment criteria.
1156 .RS
1157 .RS
1158 .TP
1159 .B iops
1160 Collect IOPS data. Stop the job if all individual IOPS measurements are within
1161 the specified limit of the mean IOPS (e.g., iops:2 means that all individual
1162 IOPS values must be within 2 of the mean, whereas iops:0.2% means that all
1163 individual IOPS values must be within 0.2% of the mean IOPS to terminate the
1164 job).
1165 .TP
1166 .B iops_slope
1167 Collect IOPS data and calculate the least squares regression slope. Stop the
1168 job if the slope falls below the specified limit.
1169 .TP
1170 .B bw
1171 Collect bandwidth data. Stop the job if all individual bandwidth measurements
1172 are within the specified limit of the mean bandwidth.
1173 .TP
1174 .B bw_slope
1175 Collect bandwidth data and calculate the least squares regression slope. Stop
1176 the job if the slope falls below the specified limit.
1177 .RE
1178 .RE
1179 .TP
1180 .BI steadystate_duration \fR=\fPtime "\fR,\fP ss_dur" \fR=\fPtime
1181 A rolling window of this duration will be used to judge whether steady state
1182 has been reached. Data will be collected once per second. The default is 0
1183 which disables steady state detection.
1184 .TP
1185 .BI steadystate_ramp_time \fR=\fPtime "\fR,\fP ss_ramp" \fR=\fPtime
1186 Allow the job to run for the specified duration before beginning data collection
1187 for checking the steady state job termination criterion. The default is 0.
1188 .TP
1189 .BI invalidate \fR=\fPbool
1190 Invalidate buffer-cache for the file prior to starting I/O.  Default: true.
1191 .TP
1192 .BI sync \fR=\fPbool
1193 Use synchronous I/O for buffered writes.  For the majority of I/O engines,
1194 this means using O_SYNC.  Default: false.
1195 .TP
1196 .BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
1197 Allocation method for I/O unit buffer.  Allowed values are:
1198 .RS
1199 .RS
1200 .TP
1201 .B malloc
1202 Allocate memory with \fBmalloc\fR\|(3). Default memory type.
1203 .TP
1204 .B shm
1205 Use shared memory buffers allocated through \fBshmget\fR\|(2).
1206 .TP
1207 .B shmhuge
1208 Same as \fBshm\fR, but use huge pages as backing.
1209 .TP
1210 .B mmap
1211 Use \fBmmap\fR\|(2) for allocation.  Uses anonymous memory unless a filename
1212 is given after the option in the format `:\fIfile\fR'.
1213 .TP
1214 .B mmaphuge
1215 Same as \fBmmap\fR, but use huge files as backing.
1216 .TP
1217 .B mmapshared
1218 Same as \fBmmap\fR, but use a MMAP_SHARED mapping.
1219 .RE
1220 .P
1221 The amount of memory allocated is the maximum allowed \fBblocksize\fR for the
1222 job multiplied by \fBiodepth\fR.  For \fBshmhuge\fR or \fBmmaphuge\fR to work,
1223 the system must have free huge pages allocated.  \fBmmaphuge\fR also needs to
1224 have hugetlbfs mounted, and \fIfile\fR must point there. At least on Linux,
1225 huge pages must be manually allocated. See \fB/proc/sys/vm/nr_hugehages\fR
1226 and the documentation for that. Normally you just need to echo an appropriate
1227 number, eg echoing 8 will ensure that the OS has 8 huge pages ready for
1228 use.
1229 .RE
1230 .TP
1231 .BI iomem_align \fR=\fPint "\fR,\fP mem_align" \fR=\fPint
1232 This indicates the memory alignment of the IO memory buffers. Note that the
1233 given alignment is applied to the first IO unit buffer, if using \fBiodepth\fR
1234 the alignment of the following buffers are given by the \fBbs\fR used. In
1235 other words, if using a \fBbs\fR that is a multiple of the page sized in the
1236 system, all buffers will be aligned to this value. If using a \fBbs\fR that
1237 is not page aligned, the alignment of subsequent IO memory buffers is the
1238 sum of the \fBiomem_align\fR and \fBbs\fR used.
1239 .TP
1240 .BI hugepage\-size \fR=\fPint
1241 Defines the size of a huge page.  Must be at least equal to the system setting.
1242 Should be a multiple of 1MB. Default: 4MB.
1243 .TP
1244 .B exitall
1245 Terminate all jobs when one finishes.  Default: wait for each job to finish.
1246 .TP
1247 .B exitall_on_error \fR=\fPbool
1248 Terminate all jobs if one job finishes in error.  Default: wait for each job
1249 to finish.
1250 .TP
1251 .BI bwavgtime \fR=\fPint
1252 Average bandwidth calculations over the given time in milliseconds. If the job
1253 also does bandwidth logging through \fBwrite_bw_log\fR, then the minimum of
1254 this option and \fBlog_avg_msec\fR will be used.  Default: 500ms.
1255 .TP
1256 .BI iopsavgtime \fR=\fPint
1257 Average IOPS calculations over the given time in milliseconds. If the job
1258 also does IOPS logging through \fBwrite_iops_log\fR, then the minimum of
1259 this option and \fBlog_avg_msec\fR will be used.  Default: 500ms.
1260 .TP
1261 .BI create_serialize \fR=\fPbool
1262 If true, serialize file creation for the jobs.  Default: true.
1263 .TP
1264 .BI create_fsync \fR=\fPbool
1265 \fBfsync\fR\|(2) data file after creation.  Default: true.
1266 .TP
1267 .BI create_on_open \fR=\fPbool
1268 If true, the files are not created until they are opened for IO by the job.
1269 .TP
1270 .BI create_only \fR=\fPbool
1271 If true, fio will only run the setup phase of the job. If files need to be
1272 laid out or updated on disk, only that will be done. The actual job contents
1273 are not executed.
1274 .TP
1275 .BI allow_file_create \fR=\fPbool
1276 If true, fio is permitted to create files as part of its workload. This is
1277 the default behavior. If this option is false, then fio will error out if the
1278 files it needs to use don't already exist. Default: true.
1279 .TP
1280 .BI allow_mounted_write \fR=\fPbool
1281 If this isn't set, fio will abort jobs that are destructive (eg that write)
1282 to what appears to be a mounted device or partition. This should help catch
1283 creating inadvertently destructive tests, not realizing that the test will
1284 destroy data on the mounted file system. Default: false.
1285 .TP
1286 .BI pre_read \fR=\fPbool
1287 If this is given, files will be pre-read into memory before starting the given
1288 IO operation. This will also clear the \fR \fBinvalidate\fR flag, since it is
1289 pointless to pre-read and then drop the cache. This will only work for IO
1290 engines that are seekable, since they allow you to read the same data
1291 multiple times. Thus it will not work on eg network or splice IO.
1292 .TP
1293 .BI unlink \fR=\fPbool
1294 Unlink job files when done.  Default: false.
1295 .TP
1296 .BI unlink_each_loop \fR=\fPbool
1297 Unlink job files after each iteration or loop.  Default: false.
1298 .TP
1299 .BI loops \fR=\fPint
1300 Specifies the number of iterations (runs of the same workload) of this job.
1301 Default: 1.
1302 .TP
1303 .BI verify_only \fR=\fPbool
1304 Do not perform the specified workload, only verify data still matches previous
1305 invocation of this workload. This option allows one to check data multiple
1306 times at a later date without overwriting it. This option makes sense only for
1307 workloads that write data, and does not support workloads with the
1308 \fBtime_based\fR option set.
1309 .TP
1310 .BI do_verify \fR=\fPbool
1311 Run the verify phase after a write phase.  Only valid if \fBverify\fR is set.
1312 Default: true.
1313 .TP
1314 .BI verify \fR=\fPstr
1315 Method of verifying file contents after each iteration of the job. Each
1316 verification method also implies verification of special header, which is
1317 written to the beginning of each block. This header also includes meta
1318 information, like offset of the block, block number, timestamp when block
1319 was written, etc.  \fBverify\fR=str can be combined with \fBverify_pattern\fR=str
1320 option.  The allowed values are:
1321 .RS
1322 .RS
1323 .TP
1324 .B md5 crc16 crc32 crc32c crc32c-intel crc64 crc7 sha256 sha512 sha1 xxhash
1325 Store appropriate checksum in the header of each block. crc32c-intel is
1326 hardware accelerated SSE4.2 driven, falls back to regular crc32c if
1327 not supported by the system.
1328 .TP
1329 .B meta
1330 This option is deprecated, since now meta information is included in generic
1331 verification header and meta verification happens by default.  For detailed
1332 information see the description of the \fBverify\fR=str setting. This option
1333 is kept because of compatibility's sake with old configurations. Do not use it.
1334 .TP
1335 .B pattern
1336 Verify a strict pattern. Normally fio includes a header with some basic
1337 information and checksumming, but if this option is set, only the
1338 specific pattern set with \fBverify_pattern\fR is verified.
1339 .TP
1340 .B null
1341 Pretend to verify.  Used for testing internals.
1342 .RE
1344 This option can be used for repeated burn-in tests of a system to make sure
1345 that the written data is also correctly read back. If the data direction given
1346 is a read or random read, fio will assume that it should verify a previously
1347 written file. If the data direction includes any form of write, the verify will
1348 be of the newly written data.
1349 .RE
1350 .TP
1351 .BI verifysort \fR=\fPbool
1352 If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to
1353 read them back in a sorted manner.  Default: true.
1354 .TP
1355 .BI verifysort_nr \fR=\fPint
1356 Pre-load and sort verify blocks for a read workload.
1357 .TP
1358 .BI verify_offset \fR=\fPint
1359 Swap the verification header with data somewhere else in the block before
1360 writing.  It is swapped back before verifying.
1361 .TP
1362 .BI verify_interval \fR=\fPint
1363 Write the verification header for this number of bytes, which should divide
1364 \fBblocksize\fR.  Default: \fBblocksize\fR.
1365 .TP
1366 .BI verify_pattern \fR=\fPstr
1367 If set, fio will fill the io buffers with this pattern. Fio defaults to filling
1368 with totally random bytes, but sometimes it's interesting to fill with a known
1369 pattern for io verification purposes. Depending on the width of the pattern,
1370 fio will fill 1/2/3/4 bytes of the buffer at the time(it can be either a
1371 decimal or a hex number). The verify_pattern if larger than a 32-bit quantity
1372 has to be a hex number that starts with either "0x" or "0X". Use with
1373 \fBverify\fP=str. Also, verify_pattern supports %o format, which means that for
1374 each block offset will be written and then verified back, e.g.:
1375 .RS
1376 .RS
1377 \fBverify_pattern\fR=%o
1378 .RE
1379 Or use combination of everything:
1380 .LP
1381 .RS
1382 \fBverify_pattern\fR=0xff%o"abcd"-21
1383 .RE
1384 .RE
1385 .TP
1386 .BI verify_fatal \fR=\fPbool
1387 If true, exit the job on the first observed verification failure.  Default:
1388 false.
1389 .TP
1390 .BI verify_dump \fR=\fPbool
1391 If set, dump the contents of both the original data block and the data block we
1392 read off disk to files. This allows later analysis to inspect just what kind of
1393 data corruption occurred. Off by default.
1394 .TP
1395 .BI verify_async \fR=\fPint
1396 Fio will normally verify IO inline from the submitting thread. This option
1397 takes an integer describing how many async offload threads to create for IO
1398 verification instead, causing fio to offload the duty of verifying IO contents
1399 to one or more separate threads.  If using this offload option, even sync IO
1400 engines can benefit from using an \fBiodepth\fR setting higher than 1, as it
1401 allows them to have IO in flight while verifies are running.
1402 .TP
1403 .BI verify_async_cpus \fR=\fPstr
1404 Tell fio to set the given CPU affinity on the async IO verification threads.
1405 See \fBcpus_allowed\fP for the format used.
1406 .TP
1407 .BI verify_backlog \fR=\fPint
1408 Fio will normally verify the written contents of a job that utilizes verify
1409 once that job has completed. In other words, everything is written then
1410 everything is read back and verified. You may want to verify continually
1411 instead for a variety of reasons. Fio stores the meta data associated with an
1412 IO block in memory, so for large verify workloads, quite a bit of memory would
1413 be used up holding this meta data. If this option is enabled, fio will write
1414 only N blocks before verifying these blocks.
1415 .TP
1416 .BI verify_backlog_batch \fR=\fPint
1417 Control how many blocks fio will verify if verify_backlog is set. If not set,
1418 will default to the value of \fBverify_backlog\fR (meaning the entire queue is
1419 read back and verified).  If \fBverify_backlog_batch\fR is less than
1420 \fBverify_backlog\fR then not all blocks will be verified,  if
1421 \fBverify_backlog_batch\fR is larger than \fBverify_backlog\fR,  some blocks
1422 will be verified more than once.
1423 .TP
1424 .BI trim_percentage \fR=\fPint
1425 Number of verify blocks to discard/trim.
1426 .TP
1427 .BI trim_verify_zero \fR=\fPbool
1428 Verify that trim/discarded blocks are returned as zeroes.
1429 .TP
1430 .BI trim_backlog \fR=\fPint
1431 Trim after this number of blocks are written.
1432 .TP
1433 .BI trim_backlog_batch \fR=\fPint
1434 Trim this number of IO blocks.
1435 .TP
1436 .BI experimental_verify \fR=\fPbool
1437 Enable experimental verification.
1438 .TP
1439 .BI verify_state_save \fR=\fPbool
1440 When a job exits during the write phase of a verify workload, save its
1441 current state. This allows fio to replay up until that point, if the
1442 verify state is loaded for the verify read phase.
1443 .TP
1444 .BI verify_state_load \fR=\fPbool
1445 If a verify termination trigger was used, fio stores the current write
1446 state of each thread. This can be used at verification time so that fio
1447 knows how far it should verify. Without this information, fio will run
1448 a full verification pass, according to the settings in the job file used.
1449 .TP
1450 .B stonewall "\fR,\fP wait_for_previous"
1451 Wait for preceding jobs in the job file to exit before starting this one.
1452 \fBstonewall\fR implies \fBnew_group\fR.
1453 .TP
1454 .B new_group
1455 Start a new reporting group.  If not given, all jobs in a file will be part
1456 of the same reporting group, unless separated by a stonewall.
1457 .TP
1458 .BI numjobs \fR=\fPint
1459 Number of clones (processes/threads performing the same workload) of this job.
1460 Default: 1.
1461 .TP
1462 .B group_reporting
1463 If set, display per-group reports instead of per-job when \fBnumjobs\fR is
1464 specified.
1465 .TP
1466 .B thread
1467 Use threads created with \fBpthread_create\fR\|(3) instead of processes created
1468 with \fBfork\fR\|(2).
1469 .TP
1470 .BI zonesize \fR=\fPint
1471 Divide file into zones of the specified size in bytes.  See \fBzoneskip\fR.
1472 .TP
1473 .BI zonerange \fR=\fPint
1474 Give size of an IO zone.  See \fBzoneskip\fR.
1475 .TP
1476 .BI zoneskip \fR=\fPint
1477 Skip the specified number of bytes when \fBzonesize\fR bytes of data have been
1478 read.
1479 .TP
1480 .BI write_iolog \fR=\fPstr
1481 Write the issued I/O patterns to the specified file.  Specify a separate file
1482 for each job, otherwise the iologs will be interspersed and the file may be
1483 corrupt.
1484 .TP
1485 .BI read_iolog \fR=\fPstr
1486 Replay the I/O patterns contained in the specified file generated by
1487 \fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file.
1488 .TP
1489 .BI replay_no_stall \fR=\fPint
1490 While replaying I/O patterns using \fBread_iolog\fR the default behavior
1491 attempts to respect timing information between I/Os.  Enabling
1492 \fBreplay_no_stall\fR causes I/Os to be replayed as fast as possible while
1493 still respecting ordering.
1494 .TP
1495 .BI replay_redirect \fR=\fPstr
1496 While replaying I/O patterns using \fBread_iolog\fR the default behavior
1497 is to replay the IOPS onto the major/minor device that each IOP was recorded
1498 from.  Setting \fBreplay_redirect\fR causes all IOPS to be replayed onto the
1499 single specified device regardless of the device it was recorded from.
1500 .TP
1501 .BI replay_align \fR=\fPint
1502 Force alignment of IO offsets and lengths in a trace to this power of 2 value.
1503 .TP
1504 .BI replay_scale \fR=\fPint
1505 Scale sector offsets down by this factor when replaying traces.
1506 .TP
1507 .BI per_job_logs \fR=\fPbool
1508 If set, this generates bw/clat/iops log with per file private filenames. If
1509 not set, jobs with identical names will share the log filename. Default: true.
1510 .TP
1511 .BI write_bw_log \fR=\fPstr
1512 If given, write a bandwidth log for this job. Can be used to store data of the
1513 bandwidth of the jobs in their lifetime. The included fio_generate_plots script
1514 uses gnuplot to turn these text files into nice graphs. See \fBwrite_lat_log\fR
1515 for behaviour of given filename. For this option, the postfix is _bw.x.log,
1516 where x is the index of the job (1..N, where N is the number of jobs). If
1517 \fBper_job_logs\fR is false, then the filename will not include the job index.
1518 See the \fBLOG FILE FORMATS\fR
1519 section.
1520 .TP
1521 .BI write_lat_log \fR=\fPstr
1522 Same as \fBwrite_bw_log\fR, but writes I/O completion latencies.  If no
1523 filename is given with this option, the default filename of
1524 "jobname_type.x.log" is used, where x is the index of the job (1..N, where
1525 N is the number of jobs). Even if the filename is given, fio will still
1526 append the type of log. If \fBper_job_logs\fR is false, then the filename will
1527 not include the job index. See the \fBLOG FILE FORMATS\fR section.
1528 .TP
1529 .BI write_hist_log \fR=\fPstr
1530 Same as \fBwrite_lat_log\fR, but writes I/O completion latency histograms. If
1531 no filename is given with this option, the default filename of
1532 "jobname_clat_hist.x.log" is used, where x is the index of the job (1..N, where
1533 N is the number of jobs). Even if the filename is given, fio will still append
1534 the type of log. If \fBper_job_logs\fR is false, then the filename will not
1535 include the job index. See the \fBLOG FILE FORMATS\fR section.
1536 .TP
1537 .BI write_iops_log \fR=\fPstr
1538 Same as \fBwrite_bw_log\fR, but writes IOPS. If no filename is given with this
1539 option, the default filename of "jobname_type.x.log" is used, where x is the
1540 index of the job (1..N, where N is the number of jobs). Even if the filename
1541 is given, fio will still append the type of log. If \fBper_job_logs\fR is false,
1542 then the filename will not include the job index. See the \fBLOG FILE FORMATS\fR
1543 section.
1544 .TP
1545 .BI log_avg_msec \fR=\fPint
1546 By default, fio will log an entry in the iops, latency, or bw log for every
1547 IO that completes. When writing to the disk log, that can quickly grow to a
1548 very large size. Setting this option makes fio average the each log entry
1549 over the specified period of time, reducing the resolution of the log. See
1550 \fBlog_max_value\fR as well.  Defaults to 0, logging all entries.
1551 .TP
1552 .BI log_max_value \fR=\fPbool
1553 If \fBlog_avg_msec\fR is set, fio logs the average over that window. If you
1554 instead want to log the maximum value, set this option to 1.  Defaults to
1555 0, meaning that averaged values are logged.
1556 .TP
1557 .BI log_hist_msec \fR=\fPint
1558 Same as \fBlog_avg_msec\fR, but logs entries for completion latency histograms.
1559 Computing latency percentiles from averages of intervals using \fBlog_avg_msec\fR
1560 is innacurate. Setting this option makes fio log histogram entries over the
1561 specified period of time, reducing log sizes for high IOPS devices while
1562 retaining percentile accuracy. See \fBlog_hist_coarseness\fR as well. Defaults
1563 to 0, meaning histogram logging is disabled.
1564 .TP
1565 .BI log_hist_coarseness \fR=\fPint
1566 Integer ranging from 0 to 6, defining the coarseness of the resolution of the
1567 histogram logs enabled with \fBlog_hist_msec\fR. For each increment in
1568 coarseness, fio outputs half as many bins. Defaults to 0, for which histogram
1569 logs contain 1216 latency bins. See the \fBLOG FILE FORMATS\fR section.
1570 .TP
1571 .BI log_offset \fR=\fPbool
1572 If this is set, the iolog options will include the byte offset for the IO
1573 entry as well as the other data values.
1574 .TP
1575 .BI log_compression \fR=\fPint
1576 If this is set, fio will compress the IO logs as it goes, to keep the memory
1577 footprint lower. When a log reaches the specified size, that chunk is removed
1578 and compressed in the background. Given that IO logs are fairly highly
1579 compressible, this yields a nice memory savings for longer runs. The downside
1580 is that the compression will consume some background CPU cycles, so it may
1581 impact the run. This, however, is also true if the logging ends up consuming
1582 most of the system memory. So pick your poison. The IO logs are saved
1583 normally at the end of a run, by decompressing the chunks and storing them
1584 in the specified log file. This feature depends on the availability of zlib.
1585 .TP
1586 .BI log_compression_cpus \fR=\fPstr
1587 Define the set of CPUs that are allowed to handle online log compression
1588 for the IO jobs. This can provide better isolation between performance
1589 sensitive jobs, and background compression work.
1590 .TP
1591 .BI log_store_compressed \fR=\fPbool
1592 If set, fio will store the log files in a compressed format. They can be
1593 decompressed with fio, using the \fB\-\-inflate-log\fR command line parameter.
1594 The files will be stored with a \fB\.fz\fR suffix.
1595 .TP
1596 .BI log_unix_epoch \fR=\fPbool
1597 If set, fio will log Unix timestamps to the log files produced by enabling
1598 \fBwrite_type_log\fR for each log type, instead of the default zero-based
1599 timestamps.
1600 .TP
1601 .BI block_error_percentiles \fR=\fPbool
1602 If set, record errors in trim block-sized units from writes and trims and output
1603 a histogram of how many trims it took to get to errors, and what kind of error
1604 was encountered.
1605 .TP
1606 .BI disable_lat \fR=\fPbool
1607 Disable measurements of total latency numbers. Useful only for cutting
1608 back the number of calls to \fBgettimeofday\fR\|(2), as that does impact performance at
1609 really high IOPS rates.  Note that to really get rid of a large amount of these
1610 calls, this option must be used with disable_slat and disable_bw as well.
1611 .TP
1612 .BI disable_clat \fR=\fPbool
1613 Disable measurements of completion latency numbers. See \fBdisable_lat\fR.
1614 .TP
1615 .BI disable_slat \fR=\fPbool
1616 Disable measurements of submission latency numbers. See \fBdisable_lat\fR.
1617 .TP
1618 .BI disable_bw_measurement \fR=\fPbool
1619 Disable measurements of throughput/bandwidth numbers. See \fBdisable_lat\fR.
1620 .TP
1621 .BI lockmem \fR=\fPint
1622 Pin the specified amount of memory with \fBmlock\fR\|(2).  Can be used to
1623 simulate a smaller amount of memory. The amount specified is per worker.
1624 .TP
1625 .BI exec_prerun \fR=\fPstr
1626 Before running the job, execute the specified command with \fBsystem\fR\|(3).
1627 .RS
1628 Output is redirected in a file called \fBjobname.prerun.txt\fR
1629 .RE
1630 .TP
1631 .BI exec_postrun \fR=\fPstr
1632 Same as \fBexec_prerun\fR, but the command is executed after the job completes.
1633 .RS
1634 Output is redirected in a file called \fBjobname.postrun.txt\fR
1635 .RE
1636 .TP
1637 .BI ioscheduler \fR=\fPstr
1638 Attempt to switch the device hosting the file to the specified I/O scheduler.
1639 .TP
1640 .BI disk_util \fR=\fPbool
1641 Generate disk utilization statistics if the platform supports it. Default: true.
1642 .TP
1643 .BI clocksource \fR=\fPstr
1644 Use the given clocksource as the base of timing. The supported options are:
1645 .RS
1646 .TP
1647 .B gettimeofday
1648 \fBgettimeofday\fR\|(2)
1649 .TP
1650 .B clock_gettime
1651 \fBclock_gettime\fR\|(2)
1652 .TP
1653 .B cpu
1654 Internal CPU clock source
1655 .TP
1656 .RE
1657 .P
1658 \fBcpu\fR is the preferred clocksource if it is reliable, as it is very fast
1659 (and fio is heavy on time calls). Fio will automatically use this clocksource
1660 if it's supported and considered reliable on the system it is running on,
1661 unless another clocksource is specifically set. For x86/x86-64 CPUs, this
1662 means supporting TSC Invariant.
1663 .TP
1664 .BI gtod_reduce \fR=\fPbool
1665 Enable all of the \fBgettimeofday\fR\|(2) reducing options (disable_clat, disable_slat,
1666 disable_bw) plus reduce precision of the timeout somewhat to really shrink the
1667 \fBgettimeofday\fR\|(2) call count. With this option enabled, we only do about 0.4% of
1668 the gtod() calls we would have done if all time keeping was enabled.
1669 .TP
1670 .BI gtod_cpu \fR=\fPint
1671 Sometimes it's cheaper to dedicate a single thread of execution to just getting
1672 the current time. Fio (and databases, for instance) are very intensive on
1673 \fBgettimeofday\fR\|(2) calls. With this option, you can set one CPU aside for doing
1674 nothing but logging current time to a shared memory location. Then the other
1675 threads/processes that run IO workloads need only copy that segment, instead of
1676 entering the kernel with a \fBgettimeofday\fR\|(2) call. The CPU set aside for doing
1677 these time calls will be excluded from other uses. Fio will manually clear it
1678 from the CPU mask of other jobs.
1679 .TP
1680 .BI ignore_error \fR=\fPstr
1681 Sometimes you want to ignore some errors during test in that case you can specify
1682 error list for each error type.
1683 .br
1685 .br
1686 errors for given error type is separated with ':'.
1687 Error may be symbol ('ENOSPC', 'ENOMEM') or an integer.
1688 .br
1689 Example: ignore_error=EAGAIN,ENOSPC:122 .
1690 .br
1691 This option will ignore EAGAIN from READ, and ENOSPC and 122(EDQUOT) from WRITE.
1692 .TP
1693 .BI error_dump \fR=\fPbool
1694 If set dump every error even if it is non fatal, true by default. If disabled
1695 only fatal error will be dumped
1696 .TP
1697 .BI profile \fR=\fPstr
1698 Select a specific builtin performance test.
1699 .TP
1700 .BI cgroup \fR=\fPstr
1701 Add job to this control group. If it doesn't exist, it will be created.
1702 The system must have a mounted cgroup blkio mount point for this to work. If
1703 your system doesn't have it mounted, you can do so with:
1705 # mount \-t cgroup \-o blkio none /cgroup
1706 .TP
1707 .BI cgroup_weight \fR=\fPint
1708 Set the weight of the cgroup to this value. See the documentation that comes
1709 with the kernel, allowed values are in the range of 100..1000.
1710 .TP
1711 .BI cgroup_nodelete \fR=\fPbool
1712 Normally fio will delete the cgroups it has created after the job completion.
1713 To override this behavior and to leave cgroups around after the job completion,
1714 set cgroup_nodelete=1. This can be useful if one wants to inspect various
1715 cgroup files after job completion. Default: false
1716 .TP
1717 .BI uid \fR=\fPint
1718 Instead of running as the invoking user, set the user ID to this value before
1719 the thread/process does any work.
1720 .TP
1721 .BI gid \fR=\fPint
1722 Set group ID, see \fBuid\fR.
1723 .TP
1724 .BI unit_base \fR=\fPint
1725 Base unit for reporting.  Allowed values are:
1726 .RS
1727 .TP
1728 .B 0
1729 Use auto-detection (default).
1730 .TP
1731 .B 8
1732 Byte based.
1733 .TP
1734 .B 1
1735 Bit based.
1736 .RE
1737 .P
1738 .TP
1739 .BI flow_id \fR=\fPint
1740 The ID of the flow. If not specified, it defaults to being a global flow. See
1741 \fBflow\fR.
1742 .TP
1743 .BI flow \fR=\fPint
1744 Weight in token-based flow control. If this value is used, then there is a
1745 \fBflow counter\fR which is used to regulate the proportion of activity between
1746 two or more jobs. fio attempts to keep this flow counter near zero. The
1747 \fBflow\fR parameter stands for how much should be added or subtracted to the
1748 flow counter on each iteration of the main I/O loop. That is, if one job has
1749 \fBflow=8\fR and another job has \fBflow=-1\fR, then there will be a roughly
1750 1:8 ratio in how much one runs vs the other.
1751 .TP
1752 .BI flow_watermark \fR=\fPint
1753 The maximum value that the absolute value of the flow counter is allowed to
1754 reach before the job must wait for a lower value of the counter.
1755 .TP
1756 .BI flow_sleep \fR=\fPint
1757 The period of time, in microseconds, to wait after the flow watermark has been
1758 exceeded before retrying operations
1759 .TP
1760 .BI clat_percentiles \fR=\fPbool
1761 Enable the reporting of percentiles of completion latencies.
1762 .TP
1763 .BI percentile_list \fR=\fPfloat_list
1764 Overwrite the default list of percentiles for completion latencies and the
1765 block error histogram. Each number is a floating number in the range (0,100],
1766 and the maximum length of the list is 20. Use ':' to separate the
1767 numbers. For example, \-\-percentile_list=99.5:99.9 will cause fio to
1768 report the values of completion latency below which 99.5% and 99.9% of
1769 the observed latencies fell, respectively.
1770 .SS "Ioengine Parameters List"
1771 Some parameters are only valid when a specific ioengine is in use. These are
1772 used identically to normal parameters, with the caveat that when used on the
1773 command line, they must come after the ioengine.
1774 .TP
1775 .BI (cpuio)cpuload \fR=\fPint
1776 Attempt to use the specified percentage of CPU cycles.
1777 .TP
1778 .BI (cpuio)cpuchunks \fR=\fPint
1779 Split the load into cycles of the given time. In microseconds.
1780 .TP
1781 .BI (cpuio)exit_on_io_done \fR=\fPbool
1782 Detect when IO threads are done, then exit.
1783 .TP
1784 .BI (libaio)userspace_reap
1785 Normally, with the libaio engine in use, fio will use
1786 the io_getevents system call to reap newly returned events.
1787 With this flag turned on, the AIO ring will be read directly
1788 from user-space to reap events. The reaping mode is only
1789 enabled when polling for a minimum of 0 events (eg when
1790 iodepth_batch_complete=0).
1791 .TP
1792 .BI (pvsync2)hipri
1793 Set RWF_HIPRI on IO, indicating to the kernel that it's of
1794 higher priority than normal.
1795 .TP
1796 .BI (net,netsplice)hostname \fR=\fPstr
1797 The host name or IP address to use for TCP or UDP based IO.
1798 If the job is a TCP listener or UDP reader, the hostname is not
1799 used and must be omitted unless it is a valid UDP multicast address.
1800 .TP
1801 .BI (net,netsplice)port \fR=\fPint
1802 The TCP or UDP port to bind to or connect to. If this is used with
1803 \fBnumjobs\fR to spawn multiple instances of the same job type, then
1804 this will be the starting port number since fio will use a range of ports.
1805 .TP
1806 .BI (net,netsplice)interface \fR=\fPstr
1807 The IP address of the network interface used to send or receive UDP multicast
1808 packets.
1809 .TP
1810 .BI (net,netsplice)ttl \fR=\fPint
1811 Time-to-live value for outgoing UDP multicast packets. Default: 1
1812 .TP
1813 .BI (net,netsplice)nodelay \fR=\fPbool
1814 Set TCP_NODELAY on TCP connections.
1815 .TP
1816 .BI (net,netsplice)protocol \fR=\fPstr "\fR,\fP proto" \fR=\fPstr
1817 The network protocol to use. Accepted values are:
1818 .RS
1819 .RS
1820 .TP
1821 .B tcp
1822 Transmission control protocol
1823 .TP
1824 .B tcpv6
1825 Transmission control protocol V6
1826 .TP
1827 .B udp
1828 User datagram protocol
1829 .TP
1830 .B udpv6
1831 User datagram protocol V6
1832 .TP
1833 .B unix
1834 UNIX domain socket
1835 .RE
1836 .P
1837 When the protocol is TCP or UDP, the port must also be given,
1838 as well as the hostname if the job is a TCP listener or UDP
1839 reader. For unix sockets, the normal filename option should be
1840 used and the port is invalid.
1841 .RE
1842 .TP
1843 .BI (net,netsplice)listen
1844 For TCP network connections, tell fio to listen for incoming
1845 connections rather than initiating an outgoing connection. The
1846 hostname must be omitted if this option is used.
1847 .TP
1848 .BI (net, pingpong) \fR=\fPbool
1849 Normally a network writer will just continue writing data, and a network reader
1850 will just consume packets. If pingpong=1 is set, a writer will send its normal
1851 payload to the reader, then wait for the reader to send the same payload back.
1852 This allows fio to measure network latencies. The submission and completion
1853 latencies then measure local time spent sending or receiving, and the
1854 completion latency measures how long it took for the other end to receive and
1855 send back. For UDP multicast traffic pingpong=1 should only be set for a single
1856 reader when multiple readers are listening to the same address.
1857 .TP
1858 .BI (net, window_size) \fR=\fPint
1859 Set the desired socket buffer size for the connection.
1860 .TP
1861 .BI (net, mss) \fR=\fPint
1862 Set the TCP maximum segment size (TCP_MAXSEG).
1863 .TP
1864 .BI (e4defrag,donorname) \fR=\fPstr
1865 File will be used as a block donor (swap extents between files)
1866 .TP
1867 .BI (e4defrag,inplace) \fR=\fPint
1868 Configure donor file block allocation strategy
1869 .RS
1870 .BI 0(default) :
1871 Preallocate donor's file on init
1872 .TP
1873 .BI 1:
1874 allocate space immediately inside defragment event, and free right after event
1875 .RE
1876 .TP 
1877 .BI (rbd)clustername \fR=\fPstr
1878 Specifies the name of the ceph cluster.
1879 .TP
1880 .BI (rbd)rbdname \fR=\fPstr
1881 Specifies the name of the RBD.
1882 .TP
1883 .BI (rbd)pool \fR=\fPstr
1884 Specifies the name of the Ceph pool containing the RBD.
1885 .TP
1886 .BI (rbd)clientname \fR=\fPstr
1887 Specifies the username (without the 'client.' prefix) used to access the Ceph
1888 cluster. If the clustername is specified, the clientname shall be the full
1889 string. If no type. prefix is given, fio will add 'client.' by default.
1890 .TP
1891 .BI (mtd)skipbad \fR=\fPbool
1892 Skip operations against known bad blocks.
1894 While running, \fBfio\fR will display the status of the created jobs.  For
1895 example:
1896 .RS
1897 .P
1898 Threads: 1: [_r] [24.8% done] [ 13509/  8334 kb/s] [eta 00h:01m:31s]
1899 .RE
1900 .P
1901 The characters in the first set of brackets denote the current status of each
1902 threads.  The possible values are:
1903 .P
1904 .PD 0
1905 .RS
1906 .TP
1907 .B P
1908 Setup but not started.
1909 .TP
1910 .B C
1911 Thread created.
1912 .TP
1913 .B I
1914 Initialized, waiting.
1915 .TP
1916 .B R
1917 Running, doing sequential reads.
1918 .TP
1919 .B r
1920 Running, doing random reads.
1921 .TP
1922 .B W
1923 Running, doing sequential writes.
1924 .TP
1925 .B w
1926 Running, doing random writes.
1927 .TP
1928 .B M
1929 Running, doing mixed sequential reads/writes.
1930 .TP
1931 .B m
1932 Running, doing mixed random reads/writes.
1933 .TP
1934 .B F
1935 Running, currently waiting for \fBfsync\fR\|(2).
1936 .TP
1937 .B V
1938 Running, verifying written data.
1939 .TP
1940 .B E
1941 Exited, not reaped by main thread.
1942 .TP
1943 .B \-
1944 Exited, thread reaped.
1945 .RE
1946 .PD
1947 .P
1948 The second set of brackets shows the estimated completion percentage of
1949 the current group.  The third set shows the read and write I/O rate,
1950 respectively. Finally, the estimated run time of the job is displayed.
1951 .P
1952 When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data
1953 for each thread, each group of threads, and each disk, in that order.
1954 .P
1955 Per-thread statistics first show the threads client number, group-id, and
1956 error code.  The remaining figures are as follows:
1957 .RS
1958 .TP
1959 .B io
1960 Number of megabytes of I/O performed.
1961 .TP
1962 .B bw
1963 Average data rate (bandwidth).
1964 .TP
1965 .B runt
1966 Threads run time.
1967 .TP
1968 .B slat
1969 Submission latency minimum, maximum, average and standard deviation. This is
1970 the time it took to submit the I/O.
1971 .TP
1972 .B clat
1973 Completion latency minimum, maximum, average and standard deviation.  This
1974 is the time between submission and completion.
1975 .TP
1976 .B bw
1977 Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average
1978 and standard deviation.
1979 .TP
1980 .B cpu
1981 CPU usage statistics. Includes user and system time, number of context switches
1982 this thread went through and number of major and minor page faults. The CPU
1983 utilization numbers are averages for the jobs in that reporting group, while
1984 the context and fault counters are summed.
1985 .TP
1986 .B IO depths
1987 Distribution of I/O depths.  Each depth includes everything less than (or equal)
1988 to it, but greater than the previous depth.
1989 .TP
1990 .B IO issued
1991 Number of read/write requests issued, and number of short read/write requests.
1992 .TP
1993 .B IO latencies
1994 Distribution of I/O completion latencies.  The numbers follow the same pattern
1995 as \fBIO depths\fR.
1996 .RE
1997 .P
1998 The group statistics show:
1999 .PD 0
2000 .RS
2001 .TP
2002 .B io
2003 Number of megabytes I/O performed.
2004 .TP
2005 .B aggrb
2006 Aggregate bandwidth of threads in the group.
2007 .TP
2008 .B minb
2009 Minimum average bandwidth a thread saw.
2010 .TP
2011 .B maxb
2012 Maximum average bandwidth a thread saw.
2013 .TP
2014 .B mint
2015 Shortest runtime of threads in the group.
2016 .TP
2017 .B maxt
2018 Longest runtime of threads in the group.
2019 .RE
2020 .PD
2021 .P
2022 Finally, disk statistics are printed with reads first:
2023 .PD 0
2024 .RS
2025 .TP
2026 .B ios
2027 Number of I/Os performed by all groups.
2028 .TP
2029 .B merge
2030 Number of merges in the I/O scheduler.
2031 .TP
2032 .B ticks
2033 Number of ticks we kept the disk busy.
2034 .TP
2035 .B io_queue
2036 Total time spent in the disk queue.
2037 .TP
2038 .B util
2039 Disk utilization.
2040 .RE
2041 .PD
2042 .P
2043 It is also possible to get fio to dump the current output while it is
2044 running, without terminating the job. To do that, send fio the \fBUSR1\fR
2045 signal.
2047 If the \fB\-\-minimal\fR / \fB\-\-append-terse\fR options are given, the
2048 results will be printed/appended in a semicolon-delimited format suitable for
2049 scripted use.
2050 A job description (if provided) follows on a new line.  Note that the first
2051 number in the line is the version number. If the output has to be changed
2052 for some reason, this number will be incremented by 1 to signify that
2053 change.  The fields are:
2054 .P
2055 .RS
2056 .B terse version, fio version, jobname, groupid, error
2057 .P
2058 Read status:
2059 .RS
2060 .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, IOPS, runtime \fR(ms)\fP
2061 .P
2062 Submission latency:
2063 .RS
2064 .B min, max, mean, standard deviation
2065 .RE
2066 Completion latency:
2067 .RS
2068 .B min, max, mean, standard deviation
2069 .RE
2070 Completion latency percentiles (20 fields):
2071 .RS
2072 .B Xth percentile=usec
2073 .RE
2074 Total latency:
2075 .RS
2076 .B min, max, mean, standard deviation
2077 .RE
2078 Bandwidth:
2079 .RS
2080 .B min, max, aggregate percentage of total, mean, standard deviation
2081 .RE
2082 .RE
2083 .P
2084 Write status:
2085 .RS
2086 .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, IOPS, runtime \fR(ms)\fP
2087 .P
2088 Submission latency:
2089 .RS
2090 .B min, max, mean, standard deviation
2091 .RE
2092 Completion latency:
2093 .RS
2094 .B min, max, mean, standard deviation
2095 .RE
2096 Completion latency percentiles (20 fields):
2097 .RS
2098 .B Xth percentile=usec
2099 .RE
2100 Total latency:
2101 .RS
2102 .B min, max, mean, standard deviation
2103 .RE
2104 Bandwidth:
2105 .RS
2106 .B min, max, aggregate percentage of total, mean, standard deviation
2107 .RE
2108 .RE
2109 .P
2110 CPU usage:
2111 .RS
2112 .B user, system, context switches, major page faults, minor page faults
2113 .RE
2114 .P
2115 IO depth distribution:
2116 .RS
2117 .B <=1, 2, 4, 8, 16, 32, >=64
2118 .RE
2119 .P
2120 IO latency distribution:
2121 .RS
2122 Microseconds:
2123 .RS
2124 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
2125 .RE
2126 Milliseconds:
2127 .RS
2128 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000
2129 .RE
2130 .RE
2131 .P
2132 Disk utilization (1 for each disk used):
2133 .RS
2134 .B name, read ios, write ios, read merges, write merges, read ticks, write ticks, read in-queue time, write in-queue time, disk utilization percentage
2135 .RE
2136 .P
2137 Error Info (dependent on continue_on_error, default off):
2138 .RS
2139 .B total # errors, first error code
2140 .RE
2141 .P
2142 .B text description (if provided in config - appears on newline)
2143 .RE
2145 There are two trace file format that you can encounter. The older (v1) format
2146 is unsupported since version 1.20-rc3 (March 2008). It will still be described
2147 below in case that you get an old trace and want to understand it.
2149 In any case the trace is a simple text file with a single action per line.
2151 .P
2152 .B Trace file format v1
2153 .RS
2154 Each line represents a single io action in the following format:
2156 rw, offset, length
2158 where rw=0/1 for read/write, and the offset and length entries being in bytes.
2160 This format is not supported in Fio versions => 1.20-rc3.
2162 .RE
2163 .P
2164 .B Trace file format v2
2165 .RS
2166 The second version of the trace file format was added in Fio version 1.17.
2167 It allows one to access more then one file per trace and has a bigger set of
2168 possible file actions.
2170 The first line of the trace file has to be:
2172 \fBfio version 2 iolog\fR
2174 Following this can be lines in two different formats, which are described below.
2175 The file management format:
2177 \fBfilename action\fR
2179 The filename is given as an absolute path. The action can be one of these:
2181 .P
2182 .PD 0
2183 .RS
2184 .TP
2185 .B add
2186 Add the given filename to the trace
2187 .TP
2188 .B open
2189 Open the file with the given filename. The filename has to have been previously
2190 added with the \fBadd\fR action.
2191 .TP
2192 .B close
2193 Close the file with the given filename. The file must have previously been
2194 opened.
2195 .RE
2196 .PD
2197 .P
2199 The file io action format:
2201 \fBfilename action offset length\fR
2203 The filename is given as an absolute path, and has to have been added and opened
2204 before it can be used with this format. The offset and length are given in
2205 bytes. The action can be one of these:
2207 .P
2208 .PD 0
2209 .RS
2210 .TP
2211 .B wait
2212 Wait for 'offset' microseconds. Everything below 100 is discarded.  The time is
2213 relative to the previous wait statement.
2214 .TP
2215 .B read
2216 Read \fBlength\fR bytes beginning from \fBoffset\fR
2217 .TP
2218 .B write
2219 Write \fBlength\fR bytes beginning from \fBoffset\fR
2220 .TP
2221 .B sync
2222 fsync() the file
2223 .TP
2224 .B datasync
2225 fdatasync() the file
2226 .TP
2227 .B trim
2228 trim the given file from the given \fBoffset\fR for \fBlength\fR bytes
2229 .RE
2230 .PD
2231 .P
2234 In some cases, we want to understand CPU overhead in a test. For example,
2235 we test patches for the specific goodness of whether they reduce CPU usage.
2236 fio implements a balloon approach to create a thread per CPU that runs at
2237 idle priority, meaning that it only runs when nobody else needs the cpu.
2238 By measuring the amount of work completed by the thread, idleness of each
2239 CPU can be derived accordingly.
2241 An unit work is defined as touching a full page of unsigned characters. Mean
2242 and standard deviation of time to complete an unit work is reported in "unit
2243 work" section. Options can be chosen to report detailed percpu idleness or
2244 overall system idleness by aggregating percpu stats.
2247 Fio is usually run in one of two ways, when data verification is done. The
2248 first is a normal write job of some sort with verify enabled. When the
2249 write phase has completed, fio switches to reads and verifies everything
2250 it wrote. The second model is running just the write phase, and then later
2251 on running the same job (but with reads instead of writes) to repeat the
2252 same IO patterns and verify the contents. Both of these methods depend
2253 on the write phase being completed, as fio otherwise has no idea how much
2254 data was written.
2256 With verification triggers, fio supports dumping the current write state
2257 to local files. Then a subsequent read verify workload can load this state
2258 and know exactly where to stop. This is useful for testing cases where
2259 power is cut to a server in a managed fashion, for instance.
2261 A verification trigger consists of two things:
2263 .RS
2264 Storing the write state of each job
2265 .LP
2266 Executing a trigger command
2267 .RE
2269 The write state is relatively small, on the order of hundreds of bytes
2270 to single kilobytes. It contains information on the number of completions
2271 done, the last X completions, etc.
2273 A trigger is invoked either through creation (\fBtouch\fR) of a specified
2274 file in the system, or through a timeout setting. If fio is run with
2275 \fB\-\-trigger\-file=/tmp/trigger-file\fR, then it will continually check for
2276 the existence of /tmp/trigger-file. When it sees this file, it will
2277 fire off the trigger (thus saving state, and executing the trigger
2278 command).
2280 For client/server runs, there's both a local and remote trigger. If
2281 fio is running as a server backend, it will send the job states back
2282 to the client for safe storage, then execute the remote trigger, if
2283 specified. If a local trigger is specified, the server will still send
2284 back the write state, but the client will then execute the trigger.
2286 .RE
2287 .P
2288 .B Verification trigger example
2289 .RS
2291 Lets say we want to run a powercut test on the remote machine 'server'.
2292 Our write workload is in write-test.fio. We want to cut power to 'server'
2293 at some point during the run, and we'll run this test from the safety
2294 or our local machine, 'localbox'. On the server, we'll start the fio
2295 backend normally:
2297 server# \fBfio \-\-server\fR
2299 and on the client, we'll fire off the workload:
2301 localbox$ \fBfio \-\-client=server \-\-trigger\-file=/tmp/my\-trigger \-\-trigger-remote="bash \-c "echo b > /proc/sysrq-triger""\fR
2303 We set \fB/tmp/my-trigger\fR as the trigger file, and we tell fio to execute
2305 \fBecho b > /proc/sysrq-trigger\fR
2307 on the server once it has received the trigger and sent us the write
2308 state. This will work, but it's not \fIreally\fR cutting power to the server,
2309 it's merely abruptly rebooting it. If we have a remote way of cutting
2310 power to the server through IPMI or similar, we could do that through
2311 a local trigger command instead. Lets assume we have a script that does
2312 IPMI reboot of a given hostname, ipmi-reboot. On localbox, we could
2313 then have run fio with a local trigger instead:
2315 localbox$ \fBfio \-\-client=server \-\-trigger\-file=/tmp/my\-trigger \-\-trigger="ipmi-reboot server"\fR
2317 For this case, fio would wait for the server to send us the write state,
2318 then execute 'ipmi-reboot server' when that happened.
2320 .RE
2321 .P
2322 .B Loading verify state
2323 .RS
2324 To load store write state, read verification job file must contain
2325 the verify_state_load option. If that is set, fio will load the previously
2326 stored state. For a local fio run this is done by loading the files directly,
2327 and on a client/server run, the server backend will ask the client to send
2328 the files over and load them from there.
2330 .RE
2334 Fio supports a variety of log file formats, for logging latencies, bandwidth,
2335 and IOPS. The logs share a common format, which looks like this:
2337 .B time (msec), value, data direction, offset
2339 Time for the log entry is always in milliseconds. The value logged depends
2340 on the type of log, it will be one of the following:
2342 .P
2343 .PD 0
2344 .TP
2345 .B Latency log
2346 Value is in latency in usecs
2347 .TP
2348 .B Bandwidth log
2349 Value is in KB/sec
2350 .TP
2351 .B IOPS log
2352 Value is in IOPS
2353 .PD
2354 .P
2356 Data direction is one of the following:
2358 .P
2359 .PD 0
2360 .TP
2361 .B 0
2362 IO is a READ
2363 .TP
2364 .B 1
2365 IO is a WRITE
2366 .TP
2367 .B 2
2368 IO is a TRIM
2369 .PD
2370 .P
2372 The \fIoffset\fR is the offset, in bytes, from the start of the file, for that
2373 particular IO. The logging of the offset can be toggled with \fBlog_offset\fR.
2375 If windowed logging is enabled through \fBlog_avg_msec\fR, then fio doesn't log
2376 individual IOs. Instead of logs the average values over the specified
2377 period of time. Since \fIdata direction\fR and \fIoffset\fR are per-IO values,
2378 they aren't applicable if windowed logging is enabled. If windowed logging
2379 is enabled and \fBlog_max_value\fR is set, then fio logs maximum values in
2380 that window instead of averages.
2382 For histogram logging the logs look like this:
2384 .B time (msec), data direction, block-size, bin 0, bin 1, ..., bin 1215
2386 Where 'bin i' gives the frequency of IO requests with a latency falling in
2387 the i-th bin. See \fBlog_hist_coarseness\fR for logging fewer bins.
2389 .RE
2392 Normally you would run fio as a stand-alone application on the machine
2393 where the IO workload should be generated. However, it is also possible to
2394 run the frontend and backend of fio separately. This makes it possible to
2395 have a fio server running on the machine(s) where the IO workload should
2396 be running, while controlling it from another machine.
2398 To start the server, you would do:
2400 \fBfio \-\-server=args\fR
2402 on that machine, where args defines what fio listens to. The arguments
2403 are of the form 'type:hostname or IP:port'. 'type' is either 'ip' (or ip4)
2404 for TCP/IP v4, 'ip6' for TCP/IP v6, or 'sock' for a local unix domain
2405 socket. 'hostname' is either a hostname or IP address, and 'port' is the port to
2406 listen to (only valid for TCP/IP, not a local socket). Some examples:
2408 1) \fBfio \-\-server\fR
2410    Start a fio server, listening on all interfaces on the default port (8765).
2412 2) \fBfio \-\-server=ip:hostname,4444\fR
2414    Start a fio server, listening on IP belonging to hostname and on port 4444.
2416 3) \fBfio \-\-server=ip6:::1,4444\fR
2418    Start a fio server, listening on IPv6 localhost ::1 and on port 4444.
2420 4) \fBfio \-\-server=,4444\fR
2422    Start a fio server, listening on all interfaces on port 4444.
2424 5) \fBfio \-\-server=\fR
2426    Start a fio server, listening on IP on the default port.
2428 6) \fBfio \-\-server=sock:/tmp/fio.sock\fR
2430    Start a fio server, listening on the local socket /tmp/fio.sock.
2432 When a server is running, you can connect to it from a client. The client
2433 is run with:
2435 \fBfio \-\-local-args \-\-client=server \-\-remote-args <job file(s)>\fR
2437 where \-\-local-args are arguments that are local to the client where it is
2438 running, 'server' is the connect string, and \-\-remote-args and <job file(s)>
2439 are sent to the server. The 'server' string follows the same format as it
2440 does on the server side, to allow IP/hostname/socket and port strings.
2441 You can connect to multiple clients as well, to do that you could run:
2443 \fBfio \-\-client=server2 \-\-client=server2 <job file(s)>\fR
2445 If the job file is located on the fio server, then you can tell the server
2446 to load a local file as well. This is done by using \-\-remote-config:
2448 \fBfio \-\-client=server \-\-remote-config /path/to/file.fio\fR
2450 Then fio will open this local (to the server) job file instead
2451 of being passed one from the client.
2453 If you have many servers (example: 100 VMs/containers), you can input a pathname
2454 of a file containing host IPs/names as the parameter value for the \-\-client option.
2455 For example, here is an example "host.list" file containing 2 hostnames:
2457 host1.your.dns.domain
2458 .br
2459 host2.your.dns.domain
2461 The fio command would then be:
2463 \fBfio \-\-client=host.list <job file>\fR
2465 In this mode, you cannot input server-specific parameters or job files, and all
2466 servers receive the same job file.
2468 In order to enable fio \-\-client runs utilizing a shared filesystem from multiple hosts,
2469 fio \-\-client now prepends the IP address of the server to the filename. For example,
2470 if fio is using directory /mnt/nfs/fio and is writing filename fileio.tmp,
2471 with a \-\-client hostfile
2472 containing two hostnames h1 and h2 with IP addresses and, then
2473 fio will create two files:
2475 /mnt/nfs/fio/
2476 .br
2477 /mnt/nfs/fio/
2481 .B fio
2482 was written by Jens Axboe <>,
2483 now Jens Axboe <>.
2484 .br
2485 This man page was written by Aaron Carroll <> based
2486 on documentation by Jens Axboe.
2488 Report bugs to the \fBfio\fR mailing list <>.
2489 See \fBREADME\fR.
2490 .SH "SEE ALSO"
2491 For further documentation see \fBHOWTO\fR and \fBREADME\fR.
2492 .br
2493 Sample jobfiles are available in the \fBexamples\fR directory.