[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 <http://www.xmailserver.org/guasi\-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 .RE
726 .P
727 .RE
728 .TP
729 .BI iodepth \fR=\fPint
730 Number of I/O units to keep in flight against the file. Note that increasing
731 iodepth beyond 1 will not affect synchronous ioengines (except for small
732 degress when verify_async is in use). Even async engines may impose OS
733 restrictions causing the desired depth not to be achieved.  This may happen on
734 Linux when using libaio and not setting \fBdirect\fR=1, since buffered IO is
735 not async on that OS. Keep an eye on the IO depth distribution in the
736 fio output to verify that the achieved depth is as expected. Default: 1.
737 .TP
738 .BI iodepth_batch \fR=\fPint "\fR,\fP iodepth_batch_submit" \fR=\fPint
739 This defines how many pieces of IO to submit at once. It defaults to 1
740 which means that we submit each IO as soon as it is available, but can
741 be raised to submit bigger batches of IO at the time. If it is set to 0
742 the \fBiodepth\fR value will be used.
743 .TP
744 .BI iodepth_batch_complete_min \fR=\fPint "\fR,\fP iodepth_batch_complete" \fR=\fPint
745 This defines how many pieces of IO to retrieve at once. It defaults to 1 which
746  means that we'll ask for a minimum of 1 IO in the retrieval process from the
747 kernel. The IO retrieval will go on until we hit the limit set by
748 \fBiodepth_low\fR. If this variable is set to 0, then fio will always check for
749 completed events before queuing more IO. This helps reduce IO latency, at the
750 cost of more retrieval system calls.
751 .TP
752 .BI iodepth_batch_complete_max \fR=\fPint
753 This defines maximum pieces of IO to
754 retrieve at once. This variable should be used along with
755 \fBiodepth_batch_complete_min\fR=int variable, specifying the range
756 of min and max amount of IO which should be retrieved. By default
757 it is equal to \fBiodepth_batch_complete_min\fR value.
759 Example #1:
760 .RS
761 .RS
762 \fBiodepth_batch_complete_min\fR=1
763 .LP
764 \fBiodepth_batch_complete_max\fR=<iodepth>
765 .RE
767 which means that we will retrieve at least 1 IO and up to the
768 whole submitted queue depth. If none of IO has been completed
769 yet, we will wait.
771 Example #2:
772 .RS
773 \fBiodepth_batch_complete_min\fR=0
774 .LP
775 \fBiodepth_batch_complete_max\fR=<iodepth>
776 .RE
778 which means that we can retrieve up to the whole submitted
779 queue depth, but if none of IO has been completed yet, we will
780 NOT wait and immediately exit the system call. In this example
781 we simply do polling.
782 .RE
783 .TP
784 .BI iodepth_low \fR=\fPint
785 Low watermark indicating when to start filling the queue again.  Default:
786 \fBiodepth\fR.
787 .TP
788 .BI io_submit_mode \fR=\fPstr
789 This option controls how fio submits the IO to the IO engine. The default is
790 \fBinline\fR, which means that the fio job threads submit and reap IO directly.
791 If set to \fBoffload\fR, the job threads will offload IO submission to a
792 dedicated pool of IO threads. This requires some coordination and thus has a
793 bit of extra overhead, especially for lower queue depth IO where it can
794 increase latencies. The benefit is that fio can manage submission rates
795 independently of the device completion rates. This avoids skewed latency
796 reporting if IO gets back up on the device side (the coordinated omission
797 problem).
798 .TP
799 .BI direct \fR=\fPbool
800 If true, use non-buffered I/O (usually O_DIRECT).  Default: false.
801 .TP
802 .BI atomic \fR=\fPbool
803 If value is true, attempt to use atomic direct IO. Atomic writes are guaranteed
804 to be stable once acknowledged by the operating system. Only Linux supports
805 O_ATOMIC right now.
806 .TP
807 .BI buffered \fR=\fPbool
808 If true, use buffered I/O.  This is the opposite of the \fBdirect\fR parameter.
809 Default: true.
810 .TP
811 .BI offset \fR=\fPint
812 Offset in the file to start I/O. Data before the offset will not be touched.
813 .TP
814 .BI offset_increment \fR=\fPint
815 If this is provided, then the real offset becomes the
816 offset + offset_increment * thread_number, where the thread number is a
817 counter that starts at 0 and is incremented for each sub-job (i.e. when
818 numjobs option is specified). This option is useful if there are several jobs
819 which are intended to operate on a file in parallel disjoint segments, with
820 even spacing between the starting points.
821 .TP
822 .BI number_ios \fR=\fPint
823 Fio will normally perform IOs until it has exhausted the size of the region
824 set by \fBsize\fR, or if it exhaust the allocated time (or hits an error
825 condition). With this setting, the range/size can be set independently of
826 the number of IOs to perform. When fio reaches this number, it will exit
827 normally and report status. Note that this does not extend the amount
828 of IO that will be done, it will only stop fio if this condition is met
829 before other end-of-job criteria.
830 .TP
831 .BI fsync \fR=\fPint
832 How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data.  If
833 0, don't sync.  Default: 0.
834 .TP
835 .BI fdatasync \fR=\fPint
836 Like \fBfsync\fR, but uses \fBfdatasync\fR\|(2) instead to only sync the
837 data parts of the file. Default: 0.
838 .TP
839 .BI write_barrier \fR=\fPint
840 Make every Nth write a barrier write.
841 .TP
842 .BI sync_file_range \fR=\fPstr:int
843 Use \fBsync_file_range\fR\|(2) for every \fRval\fP number of write operations. Fio will
844 track range of writes that have happened since the last \fBsync_file_range\fR\|(2) call.
845 \fRstr\fP can currently be one or more of:
846 .RS
847 .TP
848 .B wait_before
850 .TP
851 .B write
853 .TP
854 .B wait_after
856 .TP
857 .RE
858 .P
859 So if you do sync_file_range=wait_before,write:8, fio would use
861 Also see the \fBsync_file_range\fR\|(2) man page.  This option is Linux specific.
862 .TP
863 .BI overwrite \fR=\fPbool
864 If writing, setup the file first and do overwrites.  Default: false.
865 .TP
866 .BI end_fsync \fR=\fPbool
867 Sync file contents when a write stage has completed.  Default: false.
868 .TP
869 .BI fsync_on_close \fR=\fPbool
870 If true, sync file contents on close.  This differs from \fBend_fsync\fR in that
871 it will happen on every close, not just at the end of the job.  Default: false.
872 .TP
873 .BI rwmixread \fR=\fPint
874 Percentage of a mixed workload that should be reads. Default: 50.
875 .TP
876 .BI rwmixwrite \fR=\fPint
877 Percentage of a mixed workload that should be writes.  If \fBrwmixread\fR and
878 \fBrwmixwrite\fR are given and do not sum to 100%, the latter of the two
879 overrides the first. This may interfere with a given rate setting, if fio is
880 asked to limit reads or writes to a certain rate. If that is the case, then
881 the distribution may be skewed. Default: 50.
882 .TP
883 .BI random_distribution \fR=\fPstr:float
884 By default, fio will use a completely uniform random distribution when asked
885 to perform random IO. Sometimes it is useful to skew the distribution in
886 specific ways, ensuring that some parts of the data is more hot than others.
887 Fio includes the following distribution models:
888 .RS
889 .TP
890 .B random
891 Uniform random distribution
892 .TP
893 .B zipf
894 Zipf distribution
895 .TP
896 .B pareto
897 Pareto distribution
898 .TP
899 .B gauss
900 Normal (gaussian) distribution
901 .TP
902 .B zoned
903 Zoned random distribution
904 .TP
905 .RE
906 When using a \fBzipf\fR or \fBpareto\fR distribution, an input value is also
907 needed to define the access pattern. For \fBzipf\fR, this is the zipf theta.
908 For \fBpareto\fR, it's the pareto power. Fio includes a test program, genzipf,
909 that can be used visualize what the given input values will yield in terms of
910 hit rates. If you wanted to use \fBzipf\fR with a theta of 1.2, you would use
911 random_distribution=zipf:1.2 as the option. If a non-uniform model is used,
912 fio will disable use of the random map. For the \fBgauss\fR distribution, a
913 normal deviation is supplied as a value between 0 and 100.
914 .P
915 .RS
916 For a \fBzoned\fR distribution, fio supports specifying percentages of IO
917 access that should fall within what range of the file or device. For example,
918 given a criteria of:
919 .P
920 .RS
921 60% of accesses should be to the first 10%
922 .RE
923 .RS
924 30% of accesses should be to the next 20%
925 .RE
926 .RS
927 8% of accesses should be to to the next 30%
928 .RE
929 .RS
930 2% of accesses should be to the next 40%
931 .RE
932 .P
933 we can define that through zoning of the random accesses. For the above
934 example, the user would do:
935 .P
936 .RS
937 .B random_distribution=zoned:60/10:30/20:8/30:2/40
938 .RE
939 .P
940 similarly to how \fBbssplit\fR works for setting ranges and percentages of block
941 sizes. Like \fBbssplit\fR, it's possible to specify separate zones for reads,
942 writes, and trims. If just one set is given, it'll apply to all of them.
943 .RE
944 .TP
945 .BI percentage_random \fR=\fPint
946 For a random workload, set how big a percentage should be random. This defaults
947 to 100%, in which case the workload is fully random. It can be set from
948 anywhere from 0 to 100.  Setting it to 0 would make the workload fully
949 sequential. It is possible to set different values for reads, writes, and
950 trim. To do so, simply use a comma separated list. See \fBblocksize\fR.
951 .TP
952 .B norandommap
953 Normally \fBfio\fR will cover every block of the file when doing random I/O. If
954 this parameter is given, a new offset will be chosen without looking at past
955 I/O history.  This parameter is mutually exclusive with \fBverify\fR.
956 .TP
957 .BI softrandommap \fR=\fPbool
958 See \fBnorandommap\fR. If fio runs with the random block map enabled and it
959 fails to allocate the map, if this option is set it will continue without a
960 random block map. As coverage will not be as complete as with random maps, this
961 option is disabled by default.
962 .TP
963 .BI random_generator \fR=\fPstr
964 Fio supports the following engines for generating IO offsets for random IO:
965 .RS
966 .TP
967 .B tausworthe
968 Strong 2^88 cycle random number generator
969 .TP
970 .B lfsr
971 Linear feedback shift register generator
972 .TP
973 .B tausworthe64
974 Strong 64-bit 2^258 cycle random number generator
975 .TP
976 .RE
977 .P
978 Tausworthe is a strong random number generator, but it requires tracking on the
979 side if we want to ensure that blocks are only read or written once. LFSR
980 guarantees that we never generate the same offset twice, and it's also less
981 computationally expensive. It's not a true random generator, however, though
982 for IO purposes it's typically good enough. LFSR only works with single block
983 sizes, not with workloads that use multiple block sizes. If used with such a
984 workload, fio may read or write some blocks multiple times. The default
985 value is tausworthe, unless the required space exceeds 2^32 blocks. If it does,
986 then tausworthe64 is selected automatically.
987 .TP
988 .BI nice \fR=\fPint
989 Run job with given nice value.  See \fBnice\fR\|(2).
990 .TP
991 .BI prio \fR=\fPint
992 Set I/O priority value of this job between 0 (highest) and 7 (lowest).  See
993 \fBionice\fR\|(1).
994 .TP
995 .BI prioclass \fR=\fPint
996 Set I/O priority class.  See \fBionice\fR\|(1).
997 .TP
998 .BI thinktime \fR=\fPint
999 Stall job for given number of microseconds between issuing I/Os.
1000 .TP
1001 .BI thinktime_spin \fR=\fPint
1002 Pretend to spend CPU time for given number of microseconds, sleeping the rest
1003 of the time specified by \fBthinktime\fR.  Only valid if \fBthinktime\fR is set.
1004 .TP
1005 .BI thinktime_blocks \fR=\fPint
1006 Only valid if thinktime is set - control how many blocks to issue, before
1007 waiting \fBthinktime\fR microseconds. If not set, defaults to 1 which will
1008 make fio wait \fBthinktime\fR microseconds after every block. This
1009 effectively makes any queue depth setting redundant, since no more than 1 IO
1010 will be queued before we have to complete it and do our thinktime. In other
1011 words, this setting effectively caps the queue depth if the latter is larger.
1012 Default: 1.
1013 .TP
1014 .BI rate \fR=\fPint
1015 Cap bandwidth used by this job. The number is in bytes/sec, the normal postfix
1016 rules apply. You can use \fBrate\fR=500k to limit reads and writes to 500k each,
1017 or you can specify read and writes separately. Using \fBrate\fR=1m,500k would
1018 limit reads to 1MB/sec and writes to 500KB/sec. Capping only reads or writes
1019 can be done with \fBrate\fR=,500k or \fBrate\fR=500k,. The former will only
1020 limit writes (to 500KB/sec), the latter will only limit reads.
1021 .TP
1022 .BI rate_min \fR=\fPint
1023 Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth.
1024 Failing to meet this requirement will cause the job to exit. The same format
1025 as \fBrate\fR is used for read vs write separation.
1026 .TP
1027 .BI rate_iops \fR=\fPint
1028 Cap the bandwidth to this number of IOPS. Basically the same as rate, just
1029 specified independently of bandwidth. The same format as \fBrate\fR is used for
1030 read vs write separation. If \fBblocksize\fR is a range, the smallest block
1031 size is used as the metric.
1032 .TP
1033 .BI rate_iops_min \fR=\fPint
1034 If this rate of I/O is not met, the job will exit. The same format as \fBrate\fR
1035 is used for read vs write separation.
1036 .TP
1037 .BI rate_process \fR=\fPstr
1038 This option controls how fio manages rated IO submissions. The default is
1039 \fBlinear\fR, which submits IO in a linear fashion with fixed delays between
1040 IOs that gets adjusted based on IO completion rates. If this is set to
1041 \fBpoisson\fR, fio will submit IO based on a more real world random request
1042 flow, known as the Poisson process
1043 (https://en.wikipedia.org/wiki/Poisson_process). The lambda will be
1044 10^6 / IOPS for the given workload.
1045 .TP
1046 .BI rate_cycle \fR=\fPint
1047 Average bandwidth for \fBrate\fR and \fBrate_min\fR over this number of
1048 milliseconds.  Default: 1000ms.
1049 .TP
1050 .BI latency_target \fR=\fPint
1051 If set, fio will attempt to find the max performance point that the given
1052 workload will run at while maintaining a latency below this target. The
1053 values is given in microseconds. See \fBlatency_window\fR and
1054 \fBlatency_percentile\fR.
1055 .TP
1056 .BI latency_window \fR=\fPint
1057 Used with \fBlatency_target\fR to specify the sample window that the job
1058 is run at varying queue depths to test the performance. The value is given
1059 in microseconds.
1060 .TP
1061 .BI latency_percentile \fR=\fPfloat
1062 The percentage of IOs that must fall within the criteria specified by
1063 \fBlatency_target\fR and \fBlatency_window\fR. If not set, this defaults
1064 to 100.0, meaning that all IOs must be equal or below to the value set
1065 by \fBlatency_target\fR.
1066 .TP
1067 .BI max_latency \fR=\fPint
1068 If set, fio will exit the job if it exceeds this maximum latency. It will exit
1069 with an ETIME error.
1070 .TP
1071 .BI cpumask \fR=\fPint
1072 Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job
1073 may run on.  See \fBsched_setaffinity\fR\|(2).
1074 .TP
1075 .BI cpus_allowed \fR=\fPstr
1076 Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers.
1077 .TP
1078 .BI cpus_allowed_policy \fR=\fPstr
1079 Set the policy of how fio distributes the CPUs specified by \fBcpus_allowed\fR
1080 or \fBcpumask\fR. Two policies are supported:
1081 .RS
1082 .RS
1083 .TP
1084 .B shared
1085 All jobs will share the CPU set specified.
1086 .TP
1087 .B split
1088 Each job will get a unique CPU from the CPU set.
1089 .RE
1090 .P
1091 \fBshared\fR is the default behaviour, if the option isn't specified. If
1092 \fBsplit\fR is specified, then fio will assign one cpu per job. If not enough
1093 CPUs are given for the jobs listed, then fio will roundrobin the CPUs in
1094 the set.
1095 .RE
1096 .P
1097 .TP
1098 .BI numa_cpu_nodes \fR=\fPstr
1099 Set this job running on specified NUMA nodes' CPUs. The arguments allow
1100 comma delimited list of cpu numbers, A-B ranges, or 'all'.
1101 .TP
1102 .BI numa_mem_policy \fR=\fPstr
1103 Set this job's memory policy and corresponding NUMA nodes. Format of
1104 the arguments:
1105 .RS
1106 .TP
1107 .B <mode>[:<nodelist>]
1108 .TP
1109 .B mode
1110 is one of the following memory policy:
1111 .TP
1112 .B default, prefer, bind, interleave, local
1113 .TP
1114 .RE
1115 For \fBdefault\fR and \fBlocal\fR memory policy, no \fBnodelist\fR is
1116 needed to be specified. For \fBprefer\fR, only one node is
1117 allowed. For \fBbind\fR and \fBinterleave\fR, \fBnodelist\fR allows
1118 comma delimited list of numbers, A-B ranges, or 'all'.
1119 .TP
1120 .BI startdelay \fR=\fPirange
1121 Delay start of job for the specified number of seconds. Supports all time
1122 suffixes to allow specification of hours, minutes, seconds and
1123 milliseconds - seconds are the default if a unit is omitted.
1124 Can be given as a range which causes each thread to choose randomly out of the
1125 range.
1126 .TP
1127 .BI runtime \fR=\fPint
1128 Terminate processing after the specified number of seconds.
1129 .TP
1130 .B time_based
1131 If given, run for the specified \fBruntime\fR duration even if the files are
1132 completely read or written. The same workload will be repeated as many times
1133 as \fBruntime\fR allows.
1134 .TP
1135 .BI ramp_time \fR=\fPint
1136 If set, fio will run the specified workload for this amount of time before
1137 logging any performance numbers. Useful for letting performance settle before
1138 logging results, thus minimizing the runtime required for stable results. Note
1139 that the \fBramp_time\fR is considered lead in time for a job, thus it will
1140 increase the total runtime if a special timeout or runtime is specified.
1141 .TP
1142 .BI steadystate \fR=\fPstr:float "\fR,\fP ss" \fR=\fPstr:float
1143 Define the criterion and limit for assessing steady state performance. The
1144 first parameter designates the criterion whereas the second parameter sets the
1145 threshold. When the criterion falls below the threshold for the specified
1146 duration, the job will stop. For example, iops_slope:0.1% will direct fio
1147 to terminate the job when the least squares regression slope falls below 0.1%
1148 of the mean IOPS. If group_reporting is enabled this will apply to all jobs in
1149 the group. All assessments are carried out using only data from the rolling
1150 collection window. Threshold limits can be expressed as a fixed value or as a
1151 percentage of the mean in the collection window. Below are the available steady
1152 state assessment criteria.
1153 .RS
1154 .RS
1155 .TP
1156 .B iops
1157 Collect IOPS data. Stop the job if all individual IOPS measurements are within
1158 the specified limit of the mean IOPS (e.g., iops:2 means that all individual
1159 IOPS values must be within 2 of the mean, whereas iops:0.2% means that all
1160 individual IOPS values must be within 0.2% of the mean IOPS to terminate the
1161 job).
1162 .TP
1163 .B iops_slope
1164 Collect IOPS data and calculate the least squares regression slope. Stop the
1165 job if the slope falls below the specified limit.
1166 .TP
1167 .B bw
1168 Collect bandwidth data. Stop the job if all individual bandwidth measurements
1169 are within the specified limit of the mean bandwidth.
1170 .TP
1171 .B bw_slope
1172 Collect bandwidth data and calculate the least squares regression slope. Stop
1173 the job if the slope falls below the specified limit.
1174 .RE
1175 .RE
1176 .TP
1177 .BI steadystate_duration \fR=\fPtime "\fR,\fP ss_dur" \fR=\fPtime
1178 A rolling window of this duration will be used to judge whether steady state
1179 has been reached. Data will be collected once per second. The default is 0
1180 which disables steady state detection.
1181 .TP
1182 .BI steadystate_ramp_time \fR=\fPtime "\fR,\fP ss_ramp" \fR=\fPtime
1183 Allow the job to run for the specified duration before beginning data collection
1184 for checking the steady state job termination criterion. The default is 0.
1185 .TP
1186 .BI invalidate \fR=\fPbool
1187 Invalidate buffer-cache for the file prior to starting I/O.  Default: true.
1188 .TP
1189 .BI sync \fR=\fPbool
1190 Use synchronous I/O for buffered writes.  For the majority of I/O engines,
1191 this means using O_SYNC.  Default: false.
1192 .TP
1193 .BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
1194 Allocation method for I/O unit buffer.  Allowed values are:
1195 .RS
1196 .RS
1197 .TP
1198 .B malloc
1199 Allocate memory with \fBmalloc\fR\|(3). Default memory type.
1200 .TP
1201 .B shm
1202 Use shared memory buffers allocated through \fBshmget\fR\|(2).
1203 .TP
1204 .B shmhuge
1205 Same as \fBshm\fR, but use huge pages as backing.
1206 .TP
1207 .B mmap
1208 Use \fBmmap\fR\|(2) for allocation.  Uses anonymous memory unless a filename
1209 is given after the option in the format `:\fIfile\fR'.
1210 .TP
1211 .B mmaphuge
1212 Same as \fBmmap\fR, but use huge files as backing.
1213 .TP
1214 .B mmapshared
1215 Same as \fBmmap\fR, but use a MMAP_SHARED mapping.
1216 .RE
1217 .P
1218 The amount of memory allocated is the maximum allowed \fBblocksize\fR for the
1219 job multiplied by \fBiodepth\fR.  For \fBshmhuge\fR or \fBmmaphuge\fR to work,
1220 the system must have free huge pages allocated.  \fBmmaphuge\fR also needs to
1221 have hugetlbfs mounted, and \fIfile\fR must point there. At least on Linux,
1222 huge pages must be manually allocated. See \fB/proc/sys/vm/nr_hugehages\fR
1223 and the documentation for that. Normally you just need to echo an appropriate
1224 number, eg echoing 8 will ensure that the OS has 8 huge pages ready for
1225 use.
1226 .RE
1227 .TP
1228 .BI iomem_align \fR=\fPint "\fR,\fP mem_align" \fR=\fPint
1229 This indicates the memory alignment of the IO memory buffers. Note that the
1230 given alignment is applied to the first IO unit buffer, if using \fBiodepth\fR
1231 the alignment of the following buffers are given by the \fBbs\fR used. In
1232 other words, if using a \fBbs\fR that is a multiple of the page sized in the
1233 system, all buffers will be aligned to this value. If using a \fBbs\fR that
1234 is not page aligned, the alignment of subsequent IO memory buffers is the
1235 sum of the \fBiomem_align\fR and \fBbs\fR used.
1236 .TP
1237 .BI hugepage\-size \fR=\fPint
1238 Defines the size of a huge page.  Must be at least equal to the system setting.
1239 Should be a multiple of 1MB. Default: 4MB.
1240 .TP
1241 .B exitall
1242 Terminate all jobs when one finishes.  Default: wait for each job to finish.
1243 .TP
1244 .B exitall_on_error \fR=\fPbool
1245 Terminate all jobs if one job finishes in error.  Default: wait for each job
1246 to finish.
1247 .TP
1248 .BI bwavgtime \fR=\fPint
1249 Average bandwidth calculations over the given time in milliseconds. If the job
1250 also does bandwidth logging through \fBwrite_bw_log\fR, then the minimum of
1251 this option and \fBlog_avg_msec\fR will be used.  Default: 500ms.
1252 .TP
1253 .BI iopsavgtime \fR=\fPint
1254 Average IOPS calculations over the given time in milliseconds. If the job
1255 also does IOPS logging through \fBwrite_iops_log\fR, then the minimum of
1256 this option and \fBlog_avg_msec\fR will be used.  Default: 500ms.
1257 .TP
1258 .BI create_serialize \fR=\fPbool
1259 If true, serialize file creation for the jobs.  Default: true.
1260 .TP
1261 .BI create_fsync \fR=\fPbool
1262 \fBfsync\fR\|(2) data file after creation.  Default: true.
1263 .TP
1264 .BI create_on_open \fR=\fPbool
1265 If true, the files are not created until they are opened for IO by the job.
1266 .TP
1267 .BI create_only \fR=\fPbool
1268 If true, fio will only run the setup phase of the job. If files need to be
1269 laid out or updated on disk, only that will be done. The actual job contents
1270 are not executed.
1271 .TP
1272 .BI allow_file_create \fR=\fPbool
1273 If true, fio is permitted to create files as part of its workload. This is
1274 the default behavior. If this option is false, then fio will error out if the
1275 files it needs to use don't already exist. Default: true.
1276 .TP
1277 .BI allow_mounted_write \fR=\fPbool
1278 If this isn't set, fio will abort jobs that are destructive (eg that write)
1279 to what appears to be a mounted device or partition. This should help catch
1280 creating inadvertently destructive tests, not realizing that the test will
1281 destroy data on the mounted file system. Default: false.
1282 .TP
1283 .BI pre_read \fR=\fPbool
1284 If this is given, files will be pre-read into memory before starting the given
1285 IO operation. This will also clear the \fR \fBinvalidate\fR flag, since it is
1286 pointless to pre-read and then drop the cache. This will only work for IO
1287 engines that are seekable, since they allow you to read the same data
1288 multiple times. Thus it will not work on eg network or splice IO.
1289 .TP
1290 .BI unlink \fR=\fPbool
1291 Unlink job files when done.  Default: false.
1292 .TP
1293 .BI unlink_each_loop \fR=\fPbool
1294 Unlink job files after each iteration or loop.  Default: false.
1295 .TP
1296 .BI loops \fR=\fPint
1297 Specifies the number of iterations (runs of the same workload) of this job.
1298 Default: 1.
1299 .TP
1300 .BI verify_only \fR=\fPbool
1301 Do not perform the specified workload, only verify data still matches previous
1302 invocation of this workload. This option allows one to check data multiple
1303 times at a later date without overwriting it. This option makes sense only for
1304 workloads that write data, and does not support workloads with the
1305 \fBtime_based\fR option set.
1306 .TP
1307 .BI do_verify \fR=\fPbool
1308 Run the verify phase after a write phase.  Only valid if \fBverify\fR is set.
1309 Default: true.
1310 .TP
1311 .BI verify \fR=\fPstr
1312 Method of verifying file contents after each iteration of the job. Each
1313 verification method also implies verification of special header, which is
1314 written to the beginning of each block. This header also includes meta
1315 information, like offset of the block, block number, timestamp when block
1316 was written, etc.  \fBverify\fR=str can be combined with \fBverify_pattern\fR=str
1317 option.  The allowed values are:
1318 .RS
1319 .RS
1320 .TP
1321 .B md5 crc16 crc32 crc32c crc32c-intel crc64 crc7 sha256 sha512 sha1 xxhash
1322 Store appropriate checksum in the header of each block. crc32c-intel is
1323 hardware accelerated SSE4.2 driven, falls back to regular crc32c if
1324 not supported by the system.
1325 .TP
1326 .B meta
1327 This option is deprecated, since now meta information is included in generic
1328 verification header and meta verification happens by default.  For detailed
1329 information see the description of the \fBverify\fR=str setting. This option
1330 is kept because of compatibility's sake with old configurations. Do not use it.
1331 .TP
1332 .B pattern
1333 Verify a strict pattern. Normally fio includes a header with some basic
1334 information and checksumming, but if this option is set, only the
1335 specific pattern set with \fBverify_pattern\fR is verified.
1336 .TP
1337 .B null
1338 Pretend to verify.  Used for testing internals.
1339 .RE
1341 This option can be used for repeated burn-in tests of a system to make sure
1342 that the written data is also correctly read back. If the data direction given
1343 is a read or random read, fio will assume that it should verify a previously
1344 written file. If the data direction includes any form of write, the verify will
1345 be of the newly written data.
1346 .RE
1347 .TP
1348 .BI verifysort \fR=\fPbool
1349 If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to
1350 read them back in a sorted manner.  Default: true.
1351 .TP
1352 .BI verifysort_nr \fR=\fPint
1353 Pre-load and sort verify blocks for a read workload.
1354 .TP
1355 .BI verify_offset \fR=\fPint
1356 Swap the verification header with data somewhere else in the block before
1357 writing.  It is swapped back before verifying.
1358 .TP
1359 .BI verify_interval \fR=\fPint
1360 Write the verification header for this number of bytes, which should divide
1361 \fBblocksize\fR.  Default: \fBblocksize\fR.
1362 .TP
1363 .BI verify_pattern \fR=\fPstr
1364 If set, fio will fill the io buffers with this pattern. Fio defaults to filling
1365 with totally random bytes, but sometimes it's interesting to fill with a known
1366 pattern for io verification purposes. Depending on the width of the pattern,
1367 fio will fill 1/2/3/4 bytes of the buffer at the time(it can be either a
1368 decimal or a hex number). The verify_pattern if larger than a 32-bit quantity
1369 has to be a hex number that starts with either "0x" or "0X". Use with
1370 \fBverify\fP=str. Also, verify_pattern supports %o format, which means that for
1371 each block offset will be written and then verified back, e.g.:
1372 .RS
1373 .RS
1374 \fBverify_pattern\fR=%o
1375 .RE
1376 Or use combination of everything:
1377 .LP
1378 .RS
1379 \fBverify_pattern\fR=0xff%o"abcd"-21
1380 .RE
1381 .RE
1382 .TP
1383 .BI verify_fatal \fR=\fPbool
1384 If true, exit the job on the first observed verification failure.  Default:
1385 false.
1386 .TP
1387 .BI verify_dump \fR=\fPbool
1388 If set, dump the contents of both the original data block and the data block we
1389 read off disk to files. This allows later analysis to inspect just what kind of
1390 data corruption occurred. Off by default.
1391 .TP
1392 .BI verify_async \fR=\fPint
1393 Fio will normally verify IO inline from the submitting thread. This option
1394 takes an integer describing how many async offload threads to create for IO
1395 verification instead, causing fio to offload the duty of verifying IO contents
1396 to one or more separate threads.  If using this offload option, even sync IO
1397 engines can benefit from using an \fBiodepth\fR setting higher than 1, as it
1398 allows them to have IO in flight while verifies are running.
1399 .TP
1400 .BI verify_async_cpus \fR=\fPstr
1401 Tell fio to set the given CPU affinity on the async IO verification threads.
1402 See \fBcpus_allowed\fP for the format used.
1403 .TP
1404 .BI verify_backlog \fR=\fPint
1405 Fio will normally verify the written contents of a job that utilizes verify
1406 once that job has completed. In other words, everything is written then
1407 everything is read back and verified. You may want to verify continually
1408 instead for a variety of reasons. Fio stores the meta data associated with an
1409 IO block in memory, so for large verify workloads, quite a bit of memory would
1410 be used up holding this meta data. If this option is enabled, fio will write
1411 only N blocks before verifying these blocks.
1412 .TP
1413 .BI verify_backlog_batch \fR=\fPint
1414 Control how many blocks fio will verify if verify_backlog is set. If not set,
1415 will default to the value of \fBverify_backlog\fR (meaning the entire queue is
1416 read back and verified).  If \fBverify_backlog_batch\fR is less than
1417 \fBverify_backlog\fR then not all blocks will be verified,  if
1418 \fBverify_backlog_batch\fR is larger than \fBverify_backlog\fR,  some blocks
1419 will be verified more than once.
1420 .TP
1421 .BI trim_percentage \fR=\fPint
1422 Number of verify blocks to discard/trim.
1423 .TP
1424 .BI trim_verify_zero \fR=\fPbool
1425 Verify that trim/discarded blocks are returned as zeroes.
1426 .TP
1427 .BI trim_backlog \fR=\fPint
1428 Trim after this number of blocks are written.
1429 .TP
1430 .BI trim_backlog_batch \fR=\fPint
1431 Trim this number of IO blocks.
1432 .TP
1433 .BI experimental_verify \fR=\fPbool
1434 Enable experimental verification.
1435 .TP
1436 .BI verify_state_save \fR=\fPbool
1437 When a job exits during the write phase of a verify workload, save its
1438 current state. This allows fio to replay up until that point, if the
1439 verify state is loaded for the verify read phase.
1440 .TP
1441 .BI verify_state_load \fR=\fPbool
1442 If a verify termination trigger was used, fio stores the current write
1443 state of each thread. This can be used at verification time so that fio
1444 knows how far it should verify. Without this information, fio will run
1445 a full verification pass, according to the settings in the job file used.
1446 .TP
1447 .B stonewall "\fR,\fP wait_for_previous"
1448 Wait for preceding jobs in the job file to exit before starting this one.
1449 \fBstonewall\fR implies \fBnew_group\fR.
1450 .TP
1451 .B new_group
1452 Start a new reporting group.  If not given, all jobs in a file will be part
1453 of the same reporting group, unless separated by a stonewall.
1454 .TP
1455 .BI numjobs \fR=\fPint
1456 Number of clones (processes/threads performing the same workload) of this job.
1457 Default: 1.
1458 .TP
1459 .B group_reporting
1460 If set, display per-group reports instead of per-job when \fBnumjobs\fR is
1461 specified.
1462 .TP
1463 .B thread
1464 Use threads created with \fBpthread_create\fR\|(3) instead of processes created
1465 with \fBfork\fR\|(2).
1466 .TP
1467 .BI zonesize \fR=\fPint
1468 Divide file into zones of the specified size in bytes.  See \fBzoneskip\fR.
1469 .TP
1470 .BI zonerange \fR=\fPint
1471 Give size of an IO zone.  See \fBzoneskip\fR.
1472 .TP
1473 .BI zoneskip \fR=\fPint
1474 Skip the specified number of bytes when \fBzonesize\fR bytes of data have been
1475 read.
1476 .TP
1477 .BI write_iolog \fR=\fPstr
1478 Write the issued I/O patterns to the specified file.  Specify a separate file
1479 for each job, otherwise the iologs will be interspersed and the file may be
1480 corrupt.
1481 .TP
1482 .BI read_iolog \fR=\fPstr
1483 Replay the I/O patterns contained in the specified file generated by
1484 \fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file.
1485 .TP
1486 .BI replay_no_stall \fR=\fPint
1487 While replaying I/O patterns using \fBread_iolog\fR the default behavior
1488 attempts to respect timing information between I/Os.  Enabling
1489 \fBreplay_no_stall\fR causes I/Os to be replayed as fast as possible while
1490 still respecting ordering.
1491 .TP
1492 .BI replay_redirect \fR=\fPstr
1493 While replaying I/O patterns using \fBread_iolog\fR the default behavior
1494 is to replay the IOPS onto the major/minor device that each IOP was recorded
1495 from.  Setting \fBreplay_redirect\fR causes all IOPS to be replayed onto the
1496 single specified device regardless of the device it was recorded from.
1497 .TP
1498 .BI replay_align \fR=\fPint
1499 Force alignment of IO offsets and lengths in a trace to this power of 2 value.
1500 .TP
1501 .BI replay_scale \fR=\fPint
1502 Scale sector offsets down by this factor when replaying traces.
1503 .TP
1504 .BI per_job_logs \fR=\fPbool
1505 If set, this generates bw/clat/iops log with per file private filenames. If
1506 not set, jobs with identical names will share the log filename. Default: true.
1507 .TP
1508 .BI write_bw_log \fR=\fPstr
1509 If given, write a bandwidth log for this job. Can be used to store data of the
1510 bandwidth of the jobs in their lifetime. The included fio_generate_plots script
1511 uses gnuplot to turn these text files into nice graphs. See \fBwrite_lat_log\fR
1512 for behaviour of given filename. For this option, the postfix is _bw.x.log,
1513 where x is the index of the job (1..N, where N is the number of jobs). If
1514 \fBper_job_logs\fR is false, then the filename will not include the job index.
1515 See the \fBLOG FILE FORMATS\fR
1516 section.
1517 .TP
1518 .BI write_lat_log \fR=\fPstr
1519 Same as \fBwrite_bw_log\fR, but writes I/O completion latencies.  If no
1520 filename is given with this option, the default filename of
1521 "jobname_type.x.log" is used, where x is the index of the job (1..N, where
1522 N is the number of jobs). Even if the filename is given, fio will still
1523 append the type of log. If \fBper_job_logs\fR is false, then the filename will
1524 not include the job index. See the \fBLOG FILE FORMATS\fR section.
1525 .TP
1526 .BI write_hist_log \fR=\fPstr
1527 Same as \fBwrite_lat_log\fR, but writes I/O completion latency histograms. If
1528 no filename is given with this option, the default filename of
1529 "jobname_clat_hist.x.log" is used, where x is the index of the job (1..N, where
1530 N is the number of jobs). Even if the filename is given, fio will still append
1531 the type of log. If \fBper_job_logs\fR is false, then the filename will not
1532 include the job index. See the \fBLOG FILE FORMATS\fR section.
1533 .TP
1534 .BI write_iops_log \fR=\fPstr
1535 Same as \fBwrite_bw_log\fR, but writes IOPS. If no filename is given with this
1536 option, the default filename of "jobname_type.x.log" is used, where x is the
1537 index of the job (1..N, where N is the number of jobs). Even if the filename
1538 is given, fio will still append the type of log. If \fBper_job_logs\fR is false,
1539 then the filename will not include the job index. See the \fBLOG FILE FORMATS\fR
1540 section.
1541 .TP
1542 .BI log_avg_msec \fR=\fPint
1543 By default, fio will log an entry in the iops, latency, or bw log for every
1544 IO that completes. When writing to the disk log, that can quickly grow to a
1545 very large size. Setting this option makes fio average the each log entry
1546 over the specified period of time, reducing the resolution of the log. See
1547 \fBlog_max_value\fR as well.  Defaults to 0, logging all entries.
1548 .TP
1549 .BI log_max_value \fR=\fPbool
1550 If \fBlog_avg_msec\fR is set, fio logs the average over that window. If you
1551 instead want to log the maximum value, set this option to 1.  Defaults to
1552 0, meaning that averaged values are logged.
1553 .TP
1554 .BI log_hist_msec \fR=\fPint
1555 Same as \fBlog_avg_msec\fR, but logs entries for completion latency histograms.
1556 Computing latency percentiles from averages of intervals using \fBlog_avg_msec\fR
1557 is innacurate. Setting this option makes fio log histogram entries over the
1558 specified period of time, reducing log sizes for high IOPS devices while
1559 retaining percentile accuracy. See \fBlog_hist_coarseness\fR as well. Defaults
1560 to 0, meaning histogram logging is disabled.
1561 .TP
1562 .BI log_hist_coarseness \fR=\fPint
1563 Integer ranging from 0 to 6, defining the coarseness of the resolution of the
1564 histogram logs enabled with \fBlog_hist_msec\fR. For each increment in
1565 coarseness, fio outputs half as many bins. Defaults to 0, for which histogram
1566 logs contain 1216 latency bins. See the \fBLOG FILE FORMATS\fR section.
1567 .TP
1568 .BI log_offset \fR=\fPbool
1569 If this is set, the iolog options will include the byte offset for the IO
1570 entry as well as the other data values.
1571 .TP
1572 .BI log_compression \fR=\fPint
1573 If this is set, fio will compress the IO logs as it goes, to keep the memory
1574 footprint lower. When a log reaches the specified size, that chunk is removed
1575 and compressed in the background. Given that IO logs are fairly highly
1576 compressible, this yields a nice memory savings for longer runs. The downside
1577 is that the compression will consume some background CPU cycles, so it may
1578 impact the run. This, however, is also true if the logging ends up consuming
1579 most of the system memory. So pick your poison. The IO logs are saved
1580 normally at the end of a run, by decompressing the chunks and storing them
1581 in the specified log file. This feature depends on the availability of zlib.
1582 .TP
1583 .BI log_compression_cpus \fR=\fPstr
1584 Define the set of CPUs that are allowed to handle online log compression
1585 for the IO jobs. This can provide better isolation between performance
1586 sensitive jobs, and background compression work.
1587 .TP
1588 .BI log_store_compressed \fR=\fPbool
1589 If set, fio will store the log files in a compressed format. They can be
1590 decompressed with fio, using the \fB\-\-inflate-log\fR command line parameter.
1591 The files will be stored with a \fB\.fz\fR suffix.
1592 .TP
1593 .BI log_unix_epoch \fR=\fPbool
1594 If set, fio will log Unix timestamps to the log files produced by enabling
1595 \fBwrite_type_log\fR for each log type, instead of the default zero-based
1596 timestamps.
1597 .TP
1598 .BI block_error_percentiles \fR=\fPbool
1599 If set, record errors in trim block-sized units from writes and trims and output
1600 a histogram of how many trims it took to get to errors, and what kind of error
1601 was encountered.
1602 .TP
1603 .BI disable_lat \fR=\fPbool
1604 Disable measurements of total latency numbers. Useful only for cutting
1605 back the number of calls to \fBgettimeofday\fR\|(2), as that does impact performance at
1606 really high IOPS rates.  Note that to really get rid of a large amount of these
1607 calls, this option must be used with disable_slat and disable_bw as well.
1608 .TP
1609 .BI disable_clat \fR=\fPbool
1610 Disable measurements of completion latency numbers. See \fBdisable_lat\fR.
1611 .TP
1612 .BI disable_slat \fR=\fPbool
1613 Disable measurements of submission latency numbers. See \fBdisable_lat\fR.
1614 .TP
1615 .BI disable_bw_measurement \fR=\fPbool
1616 Disable measurements of throughput/bandwidth numbers. See \fBdisable_lat\fR.
1617 .TP
1618 .BI lockmem \fR=\fPint
1619 Pin the specified amount of memory with \fBmlock\fR\|(2).  Can be used to
1620 simulate a smaller amount of memory. The amount specified is per worker.
1621 .TP
1622 .BI exec_prerun \fR=\fPstr
1623 Before running the job, execute the specified command with \fBsystem\fR\|(3).
1624 .RS
1625 Output is redirected in a file called \fBjobname.prerun.txt\fR
1626 .RE
1627 .TP
1628 .BI exec_postrun \fR=\fPstr
1629 Same as \fBexec_prerun\fR, but the command is executed after the job completes.
1630 .RS
1631 Output is redirected in a file called \fBjobname.postrun.txt\fR
1632 .RE
1633 .TP
1634 .BI ioscheduler \fR=\fPstr
1635 Attempt to switch the device hosting the file to the specified I/O scheduler.
1636 .TP
1637 .BI disk_util \fR=\fPbool
1638 Generate disk utilization statistics if the platform supports it. Default: true.
1639 .TP
1640 .BI clocksource \fR=\fPstr
1641 Use the given clocksource as the base of timing. The supported options are:
1642 .RS
1643 .TP
1644 .B gettimeofday
1645 \fBgettimeofday\fR\|(2)
1646 .TP
1647 .B clock_gettime
1648 \fBclock_gettime\fR\|(2)
1649 .TP
1650 .B cpu
1651 Internal CPU clock source
1652 .TP
1653 .RE
1654 .P
1655 \fBcpu\fR is the preferred clocksource if it is reliable, as it is very fast
1656 (and fio is heavy on time calls). Fio will automatically use this clocksource
1657 if it's supported and considered reliable on the system it is running on,
1658 unless another clocksource is specifically set. For x86/x86-64 CPUs, this
1659 means supporting TSC Invariant.
1660 .TP
1661 .BI gtod_reduce \fR=\fPbool
1662 Enable all of the \fBgettimeofday\fR\|(2) reducing options (disable_clat, disable_slat,
1663 disable_bw) plus reduce precision of the timeout somewhat to really shrink the
1664 \fBgettimeofday\fR\|(2) call count. With this option enabled, we only do about 0.4% of
1665 the gtod() calls we would have done if all time keeping was enabled.
1666 .TP
1667 .BI gtod_cpu \fR=\fPint
1668 Sometimes it's cheaper to dedicate a single thread of execution to just getting
1669 the current time. Fio (and databases, for instance) are very intensive on
1670 \fBgettimeofday\fR\|(2) calls. With this option, you can set one CPU aside for doing
1671 nothing but logging current time to a shared memory location. Then the other
1672 threads/processes that run IO workloads need only copy that segment, instead of
1673 entering the kernel with a \fBgettimeofday\fR\|(2) call. The CPU set aside for doing
1674 these time calls will be excluded from other uses. Fio will manually clear it
1675 from the CPU mask of other jobs.
1676 .TP
1677 .BI ignore_error \fR=\fPstr
1678 Sometimes you want to ignore some errors during test in that case you can specify
1679 error list for each error type.
1680 .br
1682 .br
1683 errors for given error type is separated with ':'.
1684 Error may be symbol ('ENOSPC', 'ENOMEM') or an integer.
1685 .br
1686 Example: ignore_error=EAGAIN,ENOSPC:122 .
1687 .br
1688 This option will ignore EAGAIN from READ, and ENOSPC and 122(EDQUOT) from WRITE.
1689 .TP
1690 .BI error_dump \fR=\fPbool
1691 If set dump every error even if it is non fatal, true by default. If disabled
1692 only fatal error will be dumped
1693 .TP
1694 .BI profile \fR=\fPstr
1695 Select a specific builtin performance test.
1696 .TP
1697 .BI cgroup \fR=\fPstr
1698 Add job to this control group. If it doesn't exist, it will be created.
1699 The system must have a mounted cgroup blkio mount point for this to work. If
1700 your system doesn't have it mounted, you can do so with:
1702 # mount \-t cgroup \-o blkio none /cgroup
1703 .TP
1704 .BI cgroup_weight \fR=\fPint
1705 Set the weight of the cgroup to this value. See the documentation that comes
1706 with the kernel, allowed values are in the range of 100..1000.
1707 .TP
1708 .BI cgroup_nodelete \fR=\fPbool
1709 Normally fio will delete the cgroups it has created after the job completion.
1710 To override this behavior and to leave cgroups around after the job completion,
1711 set cgroup_nodelete=1. This can be useful if one wants to inspect various
1712 cgroup files after job completion. Default: false
1713 .TP
1714 .BI uid \fR=\fPint
1715 Instead of running as the invoking user, set the user ID to this value before
1716 the thread/process does any work.
1717 .TP
1718 .BI gid \fR=\fPint
1719 Set group ID, see \fBuid\fR.
1720 .TP
1721 .BI unit_base \fR=\fPint
1722 Base unit for reporting.  Allowed values are:
1723 .RS
1724 .TP
1725 .B 0
1726 Use auto-detection (default).
1727 .TP
1728 .B 8
1729 Byte based.
1730 .TP
1731 .B 1
1732 Bit based.
1733 .RE
1734 .P
1735 .TP
1736 .BI flow_id \fR=\fPint
1737 The ID of the flow. If not specified, it defaults to being a global flow. See
1738 \fBflow\fR.
1739 .TP
1740 .BI flow \fR=\fPint
1741 Weight in token-based flow control. If this value is used, then there is a
1742 \fBflow counter\fR which is used to regulate the proportion of activity between
1743 two or more jobs. fio attempts to keep this flow counter near zero. The
1744 \fBflow\fR parameter stands for how much should be added or subtracted to the
1745 flow counter on each iteration of the main I/O loop. That is, if one job has
1746 \fBflow=8\fR and another job has \fBflow=-1\fR, then there will be a roughly
1747 1:8 ratio in how much one runs vs the other.
1748 .TP
1749 .BI flow_watermark \fR=\fPint
1750 The maximum value that the absolute value of the flow counter is allowed to
1751 reach before the job must wait for a lower value of the counter.
1752 .TP
1753 .BI flow_sleep \fR=\fPint
1754 The period of time, in microseconds, to wait after the flow watermark has been
1755 exceeded before retrying operations
1756 .TP
1757 .BI clat_percentiles \fR=\fPbool
1758 Enable the reporting of percentiles of completion latencies.
1759 .TP
1760 .BI percentile_list \fR=\fPfloat_list
1761 Overwrite the default list of percentiles for completion latencies and the
1762 block error histogram. Each number is a floating number in the range (0,100],
1763 and the maximum length of the list is 20. Use ':' to separate the
1764 numbers. For example, \-\-percentile_list=99.5:99.9 will cause fio to
1765 report the values of completion latency below which 99.5% and 99.9% of
1766 the observed latencies fell, respectively.
1767 .SS "Ioengine Parameters List"
1768 Some parameters are only valid when a specific ioengine is in use. These are
1769 used identically to normal parameters, with the caveat that when used on the
1770 command line, they must come after the ioengine.
1771 .TP
1772 .BI (cpuio)cpuload \fR=\fPint
1773 Attempt to use the specified percentage of CPU cycles.
1774 .TP
1775 .BI (cpuio)cpuchunks \fR=\fPint
1776 Split the load into cycles of the given time. In microseconds.
1777 .TP
1778 .BI (cpuio)exit_on_io_done \fR=\fPbool
1779 Detect when IO threads are done, then exit.
1780 .TP
1781 .BI (libaio)userspace_reap
1782 Normally, with the libaio engine in use, fio will use
1783 the io_getevents system call to reap newly returned events.
1784 With this flag turned on, the AIO ring will be read directly
1785 from user-space to reap events. The reaping mode is only
1786 enabled when polling for a minimum of 0 events (eg when
1787 iodepth_batch_complete=0).
1788 .TP
1789 .BI (pvsync2)hipri
1790 Set RWF_HIPRI on IO, indicating to the kernel that it's of
1791 higher priority than normal.
1792 .TP
1793 .BI (net,netsplice)hostname \fR=\fPstr
1794 The host name or IP address to use for TCP or UDP based IO.
1795 If the job is a TCP listener or UDP reader, the hostname is not
1796 used and must be omitted unless it is a valid UDP multicast address.
1797 .TP
1798 .BI (net,netsplice)port \fR=\fPint
1799 The TCP or UDP port to bind to or connect to. If this is used with
1800 \fBnumjobs\fR to spawn multiple instances of the same job type, then
1801 this will be the starting port number since fio will use a range of ports.
1802 .TP
1803 .BI (net,netsplice)interface \fR=\fPstr
1804 The IP address of the network interface used to send or receive UDP multicast
1805 packets.
1806 .TP
1807 .BI (net,netsplice)ttl \fR=\fPint
1808 Time-to-live value for outgoing UDP multicast packets. Default: 1
1809 .TP
1810 .BI (net,netsplice)nodelay \fR=\fPbool
1811 Set TCP_NODELAY on TCP connections.
1812 .TP
1813 .BI (net,netsplice)protocol \fR=\fPstr "\fR,\fP proto" \fR=\fPstr
1814 The network protocol to use. Accepted values are:
1815 .RS
1816 .RS
1817 .TP
1818 .B tcp
1819 Transmission control protocol
1820 .TP
1821 .B tcpv6
1822 Transmission control protocol V6
1823 .TP
1824 .B udp
1825 User datagram protocol
1826 .TP
1827 .B udpv6
1828 User datagram protocol V6
1829 .TP
1830 .B unix
1831 UNIX domain socket
1832 .RE
1833 .P
1834 When the protocol is TCP or UDP, the port must also be given,
1835 as well as the hostname if the job is a TCP listener or UDP
1836 reader. For unix sockets, the normal filename option should be
1837 used and the port is invalid.
1838 .RE
1839 .TP
1840 .BI (net,netsplice)listen
1841 For TCP network connections, tell fio to listen for incoming
1842 connections rather than initiating an outgoing connection. The
1843 hostname must be omitted if this option is used.
1844 .TP
1845 .BI (net, pingpong) \fR=\fPbool
1846 Normally a network writer will just continue writing data, and a network reader
1847 will just consume packets. If pingpong=1 is set, a writer will send its normal
1848 payload to the reader, then wait for the reader to send the same payload back.
1849 This allows fio to measure network latencies. The submission and completion
1850 latencies then measure local time spent sending or receiving, and the
1851 completion latency measures how long it took for the other end to receive and
1852 send back. For UDP multicast traffic pingpong=1 should only be set for a single
1853 reader when multiple readers are listening to the same address.
1854 .TP
1855 .BI (net, window_size) \fR=\fPint
1856 Set the desired socket buffer size for the connection.
1857 .TP
1858 .BI (net, mss) \fR=\fPint
1859 Set the TCP maximum segment size (TCP_MAXSEG).
1860 .TP
1861 .BI (e4defrag,donorname) \fR=\fPstr
1862 File will be used as a block donor (swap extents between files)
1863 .TP
1864 .BI (e4defrag,inplace) \fR=\fPint
1865 Configure donor file block allocation strategy
1866 .RS
1867 .BI 0(default) :
1868 Preallocate donor's file on init
1869 .TP
1870 .BI 1:
1871 allocate space immediately inside defragment event, and free right after event
1872 .RE
1873 .TP 
1874 .BI (rbd)clustername \fR=\fPstr
1875 Specifies the name of the ceph cluster.
1876 .TP
1877 .BI (rbd)rbdname \fR=\fPstr
1878 Specifies the name of the RBD.
1879 .TP
1880 .BI (rbd)pool \fR=\fPstr
1881 Specifies the name of the Ceph pool containing the RBD.
1882 .TP
1883 .BI (rbd)clientname \fR=\fPstr
1884 Specifies the username (without the 'client.' prefix) used to access the Ceph
1885 cluster. If the clustername is specified, the clientname shall be the full
1886 type.id string. If no type. prefix is given, fio will add 'client.' by default.
1887 .TP
1888 .BI (mtd)skipbad \fR=\fPbool
1889 Skip operations against known bad blocks.
1891 While running, \fBfio\fR will display the status of the created jobs.  For
1892 example:
1893 .RS
1894 .P
1895 Threads: 1: [_r] [24.8% done] [ 13509/  8334 kb/s] [eta 00h:01m:31s]
1896 .RE
1897 .P
1898 The characters in the first set of brackets denote the current status of each
1899 threads.  The possible values are:
1900 .P
1901 .PD 0
1902 .RS
1903 .TP
1904 .B P
1905 Setup but not started.
1906 .TP
1907 .B C
1908 Thread created.
1909 .TP
1910 .B I
1911 Initialized, waiting.
1912 .TP
1913 .B R
1914 Running, doing sequential reads.
1915 .TP
1916 .B r
1917 Running, doing random reads.
1918 .TP
1919 .B W
1920 Running, doing sequential writes.
1921 .TP
1922 .B w
1923 Running, doing random writes.
1924 .TP
1925 .B M
1926 Running, doing mixed sequential reads/writes.
1927 .TP
1928 .B m
1929 Running, doing mixed random reads/writes.
1930 .TP
1931 .B F
1932 Running, currently waiting for \fBfsync\fR\|(2).
1933 .TP
1934 .B V
1935 Running, verifying written data.
1936 .TP
1937 .B E
1938 Exited, not reaped by main thread.
1939 .TP
1940 .B \-
1941 Exited, thread reaped.
1942 .RE
1943 .PD
1944 .P
1945 The second set of brackets shows the estimated completion percentage of
1946 the current group.  The third set shows the read and write I/O rate,
1947 respectively. Finally, the estimated run time of the job is displayed.
1948 .P
1949 When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data
1950 for each thread, each group of threads, and each disk, in that order.
1951 .P
1952 Per-thread statistics first show the threads client number, group-id, and
1953 error code.  The remaining figures are as follows:
1954 .RS
1955 .TP
1956 .B io
1957 Number of megabytes of I/O performed.
1958 .TP
1959 .B bw
1960 Average data rate (bandwidth).
1961 .TP
1962 .B runt
1963 Threads run time.
1964 .TP
1965 .B slat
1966 Submission latency minimum, maximum, average and standard deviation. This is
1967 the time it took to submit the I/O.
1968 .TP
1969 .B clat
1970 Completion latency minimum, maximum, average and standard deviation.  This
1971 is the time between submission and completion.
1972 .TP
1973 .B bw
1974 Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average
1975 and standard deviation.
1976 .TP
1977 .B cpu
1978 CPU usage statistics. Includes user and system time, number of context switches
1979 this thread went through and number of major and minor page faults. The CPU
1980 utilization numbers are averages for the jobs in that reporting group, while
1981 the context and fault counters are summed.
1982 .TP
1983 .B IO depths
1984 Distribution of I/O depths.  Each depth includes everything less than (or equal)
1985 to it, but greater than the previous depth.
1986 .TP
1987 .B IO issued
1988 Number of read/write requests issued, and number of short read/write requests.
1989 .TP
1990 .B IO latencies
1991 Distribution of I/O completion latencies.  The numbers follow the same pattern
1992 as \fBIO depths\fR.
1993 .RE
1994 .P
1995 The group statistics show:
1996 .PD 0
1997 .RS
1998 .TP
1999 .B io
2000 Number of megabytes I/O performed.
2001 .TP
2002 .B aggrb
2003 Aggregate bandwidth of threads in the group.
2004 .TP
2005 .B minb
2006 Minimum average bandwidth a thread saw.
2007 .TP
2008 .B maxb
2009 Maximum average bandwidth a thread saw.
2010 .TP
2011 .B mint
2012 Shortest runtime of threads in the group.
2013 .TP
2014 .B maxt
2015 Longest runtime of threads in the group.
2016 .RE
2017 .PD
2018 .P
2019 Finally, disk statistics are printed with reads first:
2020 .PD 0
2021 .RS
2022 .TP
2023 .B ios
2024 Number of I/Os performed by all groups.
2025 .TP
2026 .B merge
2027 Number of merges in the I/O scheduler.
2028 .TP
2029 .B ticks
2030 Number of ticks we kept the disk busy.
2031 .TP
2032 .B io_queue
2033 Total time spent in the disk queue.
2034 .TP
2035 .B util
2036 Disk utilization.
2037 .RE
2038 .PD
2039 .P
2040 It is also possible to get fio to dump the current output while it is
2041 running, without terminating the job. To do that, send fio the \fBUSR1\fR
2042 signal.
2044 If the \fB\-\-minimal\fR / \fB\-\-append-terse\fR options are given, the
2045 results will be printed/appended in a semicolon-delimited format suitable for
2046 scripted use.
2047 A job description (if provided) follows on a new line.  Note that the first
2048 number in the line is the version number. If the output has to be changed
2049 for some reason, this number will be incremented by 1 to signify that
2050 change.  The fields are:
2051 .P
2052 .RS
2053 .B terse version, fio version, jobname, groupid, error
2054 .P
2055 Read status:
2056 .RS
2057 .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, IOPS, runtime \fR(ms)\fP
2058 .P
2059 Submission latency:
2060 .RS
2061 .B min, max, mean, standard deviation
2062 .RE
2063 Completion latency:
2064 .RS
2065 .B min, max, mean, standard deviation
2066 .RE
2067 Completion latency percentiles (20 fields):
2068 .RS
2069 .B Xth percentile=usec
2070 .RE
2071 Total latency:
2072 .RS
2073 .B min, max, mean, standard deviation
2074 .RE
2075 Bandwidth:
2076 .RS
2077 .B min, max, aggregate percentage of total, mean, standard deviation
2078 .RE
2079 .RE
2080 .P
2081 Write status:
2082 .RS
2083 .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, IOPS, runtime \fR(ms)\fP
2084 .P
2085 Submission latency:
2086 .RS
2087 .B min, max, mean, standard deviation
2088 .RE
2089 Completion latency:
2090 .RS
2091 .B min, max, mean, standard deviation
2092 .RE
2093 Completion latency percentiles (20 fields):
2094 .RS
2095 .B Xth percentile=usec
2096 .RE
2097 Total latency:
2098 .RS
2099 .B min, max, mean, standard deviation
2100 .RE
2101 Bandwidth:
2102 .RS
2103 .B min, max, aggregate percentage of total, mean, standard deviation
2104 .RE
2105 .RE
2106 .P
2107 CPU usage:
2108 .RS
2109 .B user, system, context switches, major page faults, minor page faults
2110 .RE
2111 .P
2112 IO depth distribution:
2113 .RS
2114 .B <=1, 2, 4, 8, 16, 32, >=64
2115 .RE
2116 .P
2117 IO latency distribution:
2118 .RS
2119 Microseconds:
2120 .RS
2121 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
2122 .RE
2123 Milliseconds:
2124 .RS
2125 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000
2126 .RE
2127 .RE
2128 .P
2129 Disk utilization (1 for each disk used):
2130 .RS
2131 .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
2132 .RE
2133 .P
2134 Error Info (dependent on continue_on_error, default off):
2135 .RS
2136 .B total # errors, first error code
2137 .RE
2138 .P
2139 .B text description (if provided in config - appears on newline)
2140 .RE
2142 There are two trace file format that you can encounter. The older (v1) format
2143 is unsupported since version 1.20-rc3 (March 2008). It will still be described
2144 below in case that you get an old trace and want to understand it.
2146 In any case the trace is a simple text file with a single action per line.
2148 .P
2149 .B Trace file format v1
2150 .RS
2151 Each line represents a single io action in the following format:
2153 rw, offset, length
2155 where rw=0/1 for read/write, and the offset and length entries being in bytes.
2157 This format is not supported in Fio versions => 1.20-rc3.
2159 .RE
2160 .P
2161 .B Trace file format v2
2162 .RS
2163 The second version of the trace file format was added in Fio version 1.17.
2164 It allows one to access more then one file per trace and has a bigger set of
2165 possible file actions.
2167 The first line of the trace file has to be:
2169 \fBfio version 2 iolog\fR
2171 Following this can be lines in two different formats, which are described below.
2172 The file management format:
2174 \fBfilename action\fR
2176 The filename is given as an absolute path. The action can be one of these:
2178 .P
2179 .PD 0
2180 .RS
2181 .TP
2182 .B add
2183 Add the given filename to the trace
2184 .TP
2185 .B open
2186 Open the file with the given filename. The filename has to have been previously
2187 added with the \fBadd\fR action.
2188 .TP
2189 .B close
2190 Close the file with the given filename. The file must have previously been
2191 opened.
2192 .RE
2193 .PD
2194 .P
2196 The file io action format:
2198 \fBfilename action offset length\fR
2200 The filename is given as an absolute path, and has to have been added and opened
2201 before it can be used with this format. The offset and length are given in
2202 bytes. The action can be one of these:
2204 .P
2205 .PD 0
2206 .RS
2207 .TP
2208 .B wait
2209 Wait for 'offset' microseconds. Everything below 100 is discarded.  The time is
2210 relative to the previous wait statement.
2211 .TP
2212 .B read
2213 Read \fBlength\fR bytes beginning from \fBoffset\fR
2214 .TP
2215 .B write
2216 Write \fBlength\fR bytes beginning from \fBoffset\fR
2217 .TP
2218 .B sync
2219 fsync() the file
2220 .TP
2221 .B datasync
2222 fdatasync() the file
2223 .TP
2224 .B trim
2225 trim the given file from the given \fBoffset\fR for \fBlength\fR bytes
2226 .RE
2227 .PD
2228 .P
2231 In some cases, we want to understand CPU overhead in a test. For example,
2232 we test patches for the specific goodness of whether they reduce CPU usage.
2233 fio implements a balloon approach to create a thread per CPU that runs at
2234 idle priority, meaning that it only runs when nobody else needs the cpu.
2235 By measuring the amount of work completed by the thread, idleness of each
2236 CPU can be derived accordingly.
2238 An unit work is defined as touching a full page of unsigned characters. Mean
2239 and standard deviation of time to complete an unit work is reported in "unit
2240 work" section. Options can be chosen to report detailed percpu idleness or
2241 overall system idleness by aggregating percpu stats.
2244 Fio is usually run in one of two ways, when data verification is done. The
2245 first is a normal write job of some sort with verify enabled. When the
2246 write phase has completed, fio switches to reads and verifies everything
2247 it wrote. The second model is running just the write phase, and then later
2248 on running the same job (but with reads instead of writes) to repeat the
2249 same IO patterns and verify the contents. Both of these methods depend
2250 on the write phase being completed, as fio otherwise has no idea how much
2251 data was written.
2253 With verification triggers, fio supports dumping the current write state
2254 to local files. Then a subsequent read verify workload can load this state
2255 and know exactly where to stop. This is useful for testing cases where
2256 power is cut to a server in a managed fashion, for instance.
2258 A verification trigger consists of two things:
2260 .RS
2261 Storing the write state of each job
2262 .LP
2263 Executing a trigger command
2264 .RE
2266 The write state is relatively small, on the order of hundreds of bytes
2267 to single kilobytes. It contains information on the number of completions
2268 done, the last X completions, etc.
2270 A trigger is invoked either through creation (\fBtouch\fR) of a specified
2271 file in the system, or through a timeout setting. If fio is run with
2272 \fB\-\-trigger\-file=/tmp/trigger-file\fR, then it will continually check for
2273 the existence of /tmp/trigger-file. When it sees this file, it will
2274 fire off the trigger (thus saving state, and executing the trigger
2275 command).
2277 For client/server runs, there's both a local and remote trigger. If
2278 fio is running as a server backend, it will send the job states back
2279 to the client for safe storage, then execute the remote trigger, if
2280 specified. If a local trigger is specified, the server will still send
2281 back the write state, but the client will then execute the trigger.
2283 .RE
2284 .P
2285 .B Verification trigger example
2286 .RS
2288 Lets say we want to run a powercut test on the remote machine 'server'.
2289 Our write workload is in write-test.fio. We want to cut power to 'server'
2290 at some point during the run, and we'll run this test from the safety
2291 or our local machine, 'localbox'. On the server, we'll start the fio
2292 backend normally:
2294 server# \fBfio \-\-server\fR
2296 and on the client, we'll fire off the workload:
2298 localbox$ \fBfio \-\-client=server \-\-trigger\-file=/tmp/my\-trigger \-\-trigger-remote="bash \-c "echo b > /proc/sysrq-triger""\fR
2300 We set \fB/tmp/my-trigger\fR as the trigger file, and we tell fio to execute
2302 \fBecho b > /proc/sysrq-trigger\fR
2304 on the server once it has received the trigger and sent us the write
2305 state. This will work, but it's not \fIreally\fR cutting power to the server,
2306 it's merely abruptly rebooting it. If we have a remote way of cutting
2307 power to the server through IPMI or similar, we could do that through
2308 a local trigger command instead. Lets assume we have a script that does
2309 IPMI reboot of a given hostname, ipmi-reboot. On localbox, we could
2310 then have run fio with a local trigger instead:
2312 localbox$ \fBfio \-\-client=server \-\-trigger\-file=/tmp/my\-trigger \-\-trigger="ipmi-reboot server"\fR
2314 For this case, fio would wait for the server to send us the write state,
2315 then execute 'ipmi-reboot server' when that happened.
2317 .RE
2318 .P
2319 .B Loading verify state
2320 .RS
2321 To load store write state, read verification job file must contain
2322 the verify_state_load option. If that is set, fio will load the previously
2323 stored state. For a local fio run this is done by loading the files directly,
2324 and on a client/server run, the server backend will ask the client to send
2325 the files over and load them from there.
2327 .RE
2331 Fio supports a variety of log file formats, for logging latencies, bandwidth,
2332 and IOPS. The logs share a common format, which looks like this:
2334 .B time (msec), value, data direction, offset
2336 Time for the log entry is always in milliseconds. The value logged depends
2337 on the type of log, it will be one of the following:
2339 .P
2340 .PD 0
2341 .TP
2342 .B Latency log
2343 Value is in latency in usecs
2344 .TP
2345 .B Bandwidth log
2346 Value is in KB/sec
2347 .TP
2348 .B IOPS log
2349 Value is in IOPS
2350 .PD
2351 .P
2353 Data direction is one of the following:
2355 .P
2356 .PD 0
2357 .TP
2358 .B 0
2359 IO is a READ
2360 .TP
2361 .B 1
2362 IO is a WRITE
2363 .TP
2364 .B 2
2365 IO is a TRIM
2366 .PD
2367 .P
2369 The \fIoffset\fR is the offset, in bytes, from the start of the file, for that
2370 particular IO. The logging of the offset can be toggled with \fBlog_offset\fR.
2372 If windowed logging is enabled through \fBlog_avg_msec\fR, then fio doesn't log
2373 individual IOs. Instead of logs the average values over the specified
2374 period of time. Since \fIdata direction\fR and \fIoffset\fR are per-IO values,
2375 they aren't applicable if windowed logging is enabled. If windowed logging
2376 is enabled and \fBlog_max_value\fR is set, then fio logs maximum values in
2377 that window instead of averages.
2379 For histogram logging the logs look like this:
2381 .B time (msec), data direction, block-size, bin 0, bin 1, ..., bin 1215
2383 Where 'bin i' gives the frequency of IO requests with a latency falling in
2384 the i-th bin. See \fBlog_hist_coarseness\fR for logging fewer bins.
2386 .RE
2389 Normally you would run fio as a stand-alone application on the machine
2390 where the IO workload should be generated. However, it is also possible to
2391 run the frontend and backend of fio separately. This makes it possible to
2392 have a fio server running on the machine(s) where the IO workload should
2393 be running, while controlling it from another machine.
2395 To start the server, you would do:
2397 \fBfio \-\-server=args\fR
2399 on that machine, where args defines what fio listens to. The arguments
2400 are of the form 'type:hostname or IP:port'. 'type' is either 'ip' (or ip4)
2401 for TCP/IP v4, 'ip6' for TCP/IP v6, or 'sock' for a local unix domain
2402 socket. 'hostname' is either a hostname or IP address, and 'port' is the port to
2403 listen to (only valid for TCP/IP, not a local socket). Some examples:
2405 1) \fBfio \-\-server\fR
2407    Start a fio server, listening on all interfaces on the default port (8765).
2409 2) \fBfio \-\-server=ip:hostname,4444\fR
2411    Start a fio server, listening on IP belonging to hostname and on port 4444.
2413 3) \fBfio \-\-server=ip6:::1,4444\fR
2415    Start a fio server, listening on IPv6 localhost ::1 and on port 4444.
2417 4) \fBfio \-\-server=,4444\fR
2419    Start a fio server, listening on all interfaces on port 4444.
2421 5) \fBfio \-\-server=\fR
2423    Start a fio server, listening on IP on the default port.
2425 6) \fBfio \-\-server=sock:/tmp/fio.sock\fR
2427    Start a fio server, listening on the local socket /tmp/fio.sock.
2429 When a server is running, you can connect to it from a client. The client
2430 is run with:
2432 \fBfio \-\-local-args \-\-client=server \-\-remote-args <job file(s)>\fR
2434 where \-\-local-args are arguments that are local to the client where it is
2435 running, 'server' is the connect string, and \-\-remote-args and <job file(s)>
2436 are sent to the server. The 'server' string follows the same format as it
2437 does on the server side, to allow IP/hostname/socket and port strings.
2438 You can connect to multiple clients as well, to do that you could run:
2440 \fBfio \-\-client=server2 \-\-client=server2 <job file(s)>\fR
2442 If the job file is located on the fio server, then you can tell the server
2443 to load a local file as well. This is done by using \-\-remote-config:
2445 \fBfio \-\-client=server \-\-remote-config /path/to/file.fio\fR
2447 Then fio will open this local (to the server) job file instead
2448 of being passed one from the client.
2450 If you have many servers (example: 100 VMs/containers), you can input a pathname
2451 of a file containing host IPs/names as the parameter value for the \-\-client option.
2452 For example, here is an example "host.list" file containing 2 hostnames:
2454 host1.your.dns.domain
2455 .br
2456 host2.your.dns.domain
2458 The fio command would then be:
2460 \fBfio \-\-client=host.list <job file>\fR
2462 In this mode, you cannot input server-specific parameters or job files, and all
2463 servers receive the same job file.
2465 In order to enable fio \-\-client runs utilizing a shared filesystem from multiple hosts,
2466 fio \-\-client now prepends the IP address of the server to the filename. For example,
2467 if fio is using directory /mnt/nfs/fio and is writing filename fileio.tmp,
2468 with a \-\-client hostfile
2469 containing two hostnames h1 and h2 with IP addresses and, then
2470 fio will create two files:
2472 /mnt/nfs/fio/
2473 .br
2474 /mnt/nfs/fio/
2478 .B fio
2479 was written by Jens Axboe <jens.axboe@oracle.com>,
2480 now Jens Axboe <axboe@fb.com>.
2481 .br
2482 This man page was written by Aaron Carroll <aaronc@cse.unsw.edu.au> based
2483 on documentation by Jens Axboe.
2485 Report bugs to the \fBfio\fR mailing list <fio@vger.kernel.org>.
2486 See \fBREADME\fR.
2487 .SH "SEE ALSO"
2488 For further documentation see \fBHOWTO\fR and \fBREADME\fR.
2489 .br
2490 Sample jobfiles are available in the \fBexamples\fR directory.