engines/net: add TCP_MAXSEG setting (mss)
[fio.git] / fio.1
1 .TH fio 1 "October 2013" "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 \-\-runtime \fR=\fPruntime
24 Limit run time to \fIruntime\fR seconds.
25 .TP
26 .B \-\-latency\-log
27 Generate per-job latency logs.
28 .TP
29 .B \-\-bandwidth\-log
30 Generate per-job bandwidth logs.
31 .TP
32 .B \-\-minimal
33 Print statistics in a terse, semicolon-delimited format.
34 .TP
35 .B \-\-append-terse
36 Print statistics in selected mode AND terse, semicolon-delimited format.
37 .TP
38 .B \-\-version
39 Display version information and exit.
40 .TP
41 .BI \-\-terse\-version \fR=\fPversion
42 Set terse version output format (Current version 3, or older version 2).
43 .TP
44 .B \-\-help
45 Display usage information and exit.
46 .TP
47 .B \-\-cpuclock-test
48 Perform test and validation of internal CPU clock
49 .TP
50 .BI \-\-crctest[\fR=\fPtest]
51 Test the speed of the builtin checksumming functions. If no argument is given,
52 all of them are tested. Or a comma separated list can be passed, in which
53 case the given ones are tested.
54 .TP
55 .BI \-\-cmdhelp \fR=\fPcommand
56 Print help information for \fIcommand\fR.  May be `all' for all commands.
57 .TP
58 .BI \-\-enghelp \fR=\fPioengine[,command]
59 List all commands defined by \fIioengine\fR, or print help for \fIcommand\fR defined by \fIioengine\fR.
60 .TP
61 .BI \-\-showcmd \fR=\fPjobfile
62 Convert \fIjobfile\fR to a set of command-line options.
63 .TP
64 .BI \-\-eta \fR=\fPwhen
65 Specifies when real-time ETA estimate should be printed.  \fIwhen\fR may
66 be one of `always', `never' or `auto'.
67 .TP
68 .BI \-\-eta\-newline \fR=\fPtime
69 Force an ETA newline for every `time` period passed.
70 .TP
71 .BI \-\-status\-interval \fR=\fPtime
72 Report full output status every `time` period passed.
73 .TP
74 .BI \-\-readonly
75 Turn on safety read-only checks, preventing any attempted write.
76 .TP
77 .BI \-\-section \fR=\fPsec
78 Only run section \fIsec\fR from job file. This option can be used multiple times to add more sections to run.
79 .TP
80 .BI \-\-alloc\-size \fR=\fPkb
81 Set the internal smalloc pool size to \fIkb\fP kilobytes.
82 .TP
83 .BI \-\-warnings\-fatal
84 All fio parser warnings are fatal, causing fio to exit with an error.
85 .TP
86 .BI \-\-max\-jobs \fR=\fPnr
87 Set the maximum allowed number of jobs (threads/processes) to support.
88 .TP
89 .BI \-\-server \fR=\fPargs
90 Start a backend server, with \fIargs\fP specifying what to listen to. See client/server section.
91 .TP
92 .BI \-\-daemonize \fR=\fPpidfile
93 Background a fio server, writing the pid to the given pid file.
94 .TP
95 .BI \-\-client \fR=\fPhost
96 Instead of running the jobs locally, send and run them on the given host.
97 .TP
98 .BI \-\-idle\-prof \fR=\fPoption
99 Report cpu idleness on a system or percpu basis (\fIoption\fP=system,percpu) or run unit work calibration only (\fIoption\fP=calibrate).
101 Job files are in `ini' format. They consist of one or more
102 job definitions, which begin with a job name in square brackets and
103 extend to the next job name.  The job name can be any ASCII string
104 except `global', which has a special meaning.  Following the job name is
105 a sequence of zero or more parameters, one per line, that define the
106 behavior of the job.  Any line starting with a `;' or `#' character is
107 considered a comment and ignored.
108 .P
109 If \fIjobfile\fR is specified as `-', the job file will be read from
110 standard input.
111 .SS "Global Section"
112 The global section contains default parameters for jobs specified in the
113 job file.  A job is only affected by global sections residing above it,
114 and there may be any number of global sections.  Specific job definitions
115 may override any parameter set in global sections.
117 .SS Types
118 Some parameters may take arguments of a specific type.
119 Anywhere a numeric value is required, an arithmetic expression may be used,
120 provided it is surrounded by parentheses. Supported operators are:
121 .RS
122 .RS
123 .TP
124 .B addition (+)
125 .TP
126 .B subtraction (-)
127 .TP
128 .B multiplication (*)
129 .TP
130 .B division (/)
131 .TP
132 .B modulus (%)
133 .TP
134 .B exponentiation (^)
135 .RE
136 .RE
137 .P
138 For time values in expressions, units are microseconds by default. This is
139 different than for time values not in expressions (not enclosed in
140 parentheses). The types used are:
141 .TP
142 .I str
143 String: a sequence of alphanumeric characters.
144 .TP
145 .I int
146 SI integer: a whole number, possibly containing a suffix denoting the base unit
147 of the value.  Accepted suffixes are `k', 'M', 'G', 'T', and 'P', denoting
148 kilo (1024), mega (1024^2), giga (1024^3), tera (1024^4), and peta (1024^5)
149 respectively. If prefixed with '0x', the value is assumed to be base 16
150 (hexadecimal). A suffix may include a trailing 'b', for instance 'kb' is
151 identical to 'k'. You can specify a base 10 value by using 'KiB', 'MiB','GiB',
152 etc. This is useful for disk drives where values are often given in base 10
153 values. Specifying '30GiB' will get you 30*1000^3 bytes.
154 When specifying times the default suffix meaning changes, still denoting the
155 base unit of the value, but accepted suffixes are 'D' (days), 'H' (hours), 'M'
156 (minutes), 'S' Seconds, 'ms' (or msec) milli seconds, 'us' (or 'usec') micro
157 seconds. Time values without a unit specify seconds.
158 The suffixes are not case sensitive.
159 .TP
160 .I bool
161 Boolean: a true or false value. `0' denotes false, `1' denotes true.
162 .TP
163 .I irange
164 Integer range: a range of integers specified in the format
165 \fIlower\fR:\fIupper\fR or \fIlower\fR\-\fIupper\fR. \fIlower\fR and
166 \fIupper\fR may contain a suffix as described above.  If an option allows two
167 sets of ranges, they are separated with a `,' or `/' character. For example:
168 `8\-8k/8M\-4G'.
169 .TP
170 .I float_list
171 List of floating numbers: A list of floating numbers, separated by
172 a ':' character.
173 .SS "Parameter List"
174 .TP
175 .BI name \fR=\fPstr
176 May be used to override the job name.  On the command line, this parameter
177 has the special purpose of signalling the start of a new job.
178 .TP
179 .BI description \fR=\fPstr
180 Human-readable description of the job. It is printed when the job is run, but
181 otherwise has no special purpose.
182 .TP
183 .BI directory \fR=\fPstr
184 Prefix filenames with this directory.  Used to place files in a location other
185 than `./'.
186 You can specify a number of directories by separating the names with a ':'
187 character. These directories will be assigned equally distributed to job clones
188 creates with \fInumjobs\fR as long as they are using generated filenames.
189 If specific \fIfilename(s)\fR are set fio will use the first listed directory,
190 and thereby matching the  \fIfilename\fR semantic which generates a file each
191 clone if not specified, but let all clones use the same if set. See
192 \fIfilename\fR for considerations regarding escaping certain characters on
193 some platforms.
194 .TP
195 .BI filename \fR=\fPstr
196 .B fio
197 normally makes up a file name based on the job name, thread number, and file
198 number. If you want to share files between threads in a job or several jobs,
199 specify a \fIfilename\fR for each of them to override the default.
200 If the I/O engine is file-based, you can specify
201 a number of files by separating the names with a `:' character. `\-' is a
202 reserved name, meaning stdin or stdout, depending on the read/write direction
203 set. On Windows, disk devices are accessed as \\.\PhysicalDrive0 for the first
204 device, \\.\PhysicalDrive1 for the second etc. Note: Windows and FreeBSD
205 prevent write access to areas of the disk containing in-use data
206 (e.g. filesystems). If the wanted filename does need to include a colon, then
207 escape that with a '\\' character. For instance, if the filename is
208 "/dev/dsk/foo@3,0:c", then you would use filename="/dev/dsk/foo@3,0\\:c".
209 .TP
210 .BI filename_format \fR=\fPstr
211 If sharing multiple files between jobs, it is usually necessary to have
212 fio generate the exact names that you want. By default, fio will name a file
213 based on the default file format specification of
214 \fBjobname.jobnumber.filenumber\fP. With this option, that can be
215 customized. Fio will recognize and replace the following keywords in this
216 string:
217 .RS
218 .RS
219 .TP
220 .B $jobname
221 The name of the worker thread or process.
222 .TP
223 .B $jobnum
224 The incremental number of the worker thread or process.
225 .TP
226 .B $filenum
227 The incremental number of the file for that worker thread or process.
228 .RE
229 .P
230 To have dependent jobs share a set of files, this option can be set to
231 have fio generate filenames that are shared between the two. For instance,
232 if \fBtestfiles.$filenum\fR is specified, file number 4 for any job will
233 be named \fBtestfiles.4\fR. The default of \fB$jobname.$jobnum.$filenum\fR
234 will be used if no other format specifier is given.
235 .RE
236 .P
237 .TP
238 .BI lockfile \fR=\fPstr
239 Fio defaults to not locking any files before it does IO to them. If a file or
240 file descriptor is shared, fio can serialize IO to that file to make the end
241 result consistent. This is usual for emulating real workloads that share files.
242 The lock modes are:
243 .RS
244 .RS
245 .TP
246 .B none
247 No locking. This is the default.
248 .TP
249 .B exclusive
250 Only one thread or process may do IO at a time, excluding all others.
251 .TP
252 .B readwrite
253 Read-write locking on the file. Many readers may access the file at the same
254 time, but writes get exclusive access.
255 .RE
256 .RE
257 .P
258 .BI opendir \fR=\fPstr
259 Recursively open any files below directory \fIstr\fR.
260 .TP
261 .BI readwrite \fR=\fPstr "\fR,\fP rw" \fR=\fPstr
262 Type of I/O pattern.  Accepted values are:
263 .RS
264 .RS
265 .TP
266 .B read
267 Sequential reads.
268 .TP
269 .B write
270 Sequential writes.
271 .TP
272 .B trim
273 Sequential trim (Linux block devices only).
274 .TP
275 .B randread
276 Random reads.
277 .TP
278 .B randwrite
279 Random writes.
280 .TP
281 .B randtrim
282 Random trim (Linux block devices only).
283 .TP
284 .B rw, readwrite
285 Mixed sequential reads and writes.
286 .TP
287 .B randrw 
288 Mixed random reads and writes.
289 .RE
290 .P
291 For mixed I/O, the default split is 50/50. For certain types of io the result
292 may still be skewed a bit, since the speed may be different. It is possible to
293 specify a number of IO's to do before getting a new offset, this is done by
294 appending a `:\fI<nr>\fR to the end of the string given. For a random read, it
295 would look like \fBrw=randread:8\fR for passing in an offset modifier with a
296 value of 8. If the postfix is used with a sequential IO pattern, then the value
297 specified will be added to the generated offset for each IO. For instance,
298 using \fBrw=write:4k\fR will skip 4k for every write. It turns sequential IO
299 into sequential IO with holes. See the \fBrw_sequencer\fR option.
300 .RE
301 .TP
302 .BI rw_sequencer \fR=\fPstr
303 If an offset modifier is given by appending a number to the \fBrw=<str>\fR line,
304 then this option controls how that number modifies the IO offset being
305 generated. Accepted values are:
306 .RS
307 .RS
308 .TP
309 .B sequential
310 Generate sequential offset
311 .TP
312 .B identical
313 Generate the same offset
314 .RE
315 .P
316 \fBsequential\fR is only useful for random IO, where fio would normally
317 generate a new random offset for every IO. If you append eg 8 to randread, you
318 would get a new random offset for every 8 IO's. The result would be a seek for
319 only every 8 IO's, instead of for every IO. Use \fBrw=randread:8\fR to specify
320 that. As sequential IO is already sequential, setting \fBsequential\fR for that
321 would not result in any differences.  \fBidentical\fR behaves in a similar
322 fashion, except it sends the same offset 8 number of times before generating a
323 new offset.
324 .RE
325 .P
326 .TP
327 .BI kb_base \fR=\fPint
328 The base unit for a kilobyte. The defacto base is 2^10, 1024.  Storage
329 manufacturers like to use 10^3 or 1000 as a base ten unit instead, for obvious
330 reasons. Allowed values are 1024 or 1000, with 1024 being the default.
331 .TP
332 .BI unified_rw_reporting \fR=\fPbool
333 Fio normally reports statistics on a per data direction basis, meaning that
334 read, write, and trim are accounted and reported separately. If this option is
335 set fio sums the results and reports them as "mixed" instead.
336 .TP
337 .BI randrepeat \fR=\fPbool
338 Seed the random number generator used for random I/O patterns in a predictable
339 way so the pattern is repeatable across runs.  Default: true.
340 .TP
341 .BI allrandrepeat \fR=\fPbool
342 Seed all random number generators in a predictable way so results are
343 repeatable across runs.  Default: false.
344 .TP
345 .BI randseed \fR=\fPint
346 Seed the random number generators based on this seed value, to be able to
347 control what sequence of output is being generated. If not set, the random
348 sequence depends on the \fBrandrepeat\fR setting.
349 .TP
350 .BI use_os_rand \fR=\fPbool
351 Fio can either use the random generator supplied by the OS to generate random
352 offsets, or it can use its own internal generator (based on Tausworthe).
353 Default is to use the internal generator, which is often of better quality and
354 faster. Default: false.
355 .TP
356 .BI fallocate \fR=\fPstr
357 Whether pre-allocation is performed when laying down files. Accepted values
358 are:
359 .RS
360 .RS
361 .TP
362 .B none
363 Do not pre-allocate space.
364 .TP
365 .B posix
366 Pre-allocate via \fBposix_fallocate\fR\|(3).
367 .TP
368 .B keep
369 Pre-allocate via \fBfallocate\fR\|(2) with FALLOC_FL_KEEP_SIZE set.
370 .TP
371 .B 0
372 Backward-compatible alias for 'none'.
373 .TP
374 .B 1
375 Backward-compatible alias for 'posix'.
376 .RE
377 .P
378 May not be available on all supported platforms. 'keep' is only
379 available on Linux. If using ZFS on Solaris this must be set to 'none'
380 because ZFS doesn't support it. Default: 'posix'.
381 .RE
382 .TP
383 .BI fadvise_hint \fR=\fPbool
384 Use \fBposix_fadvise\fR\|(2) to advise the kernel what I/O patterns
385 are likely to be issued. Default: true.
386 .TP
387 .BI size \fR=\fPint
388 Total size of I/O for this job.  \fBfio\fR will run until this many bytes have
389 been transferred, unless limited by other options (\fBruntime\fR, for instance).
390 Unless \fBnrfiles\fR and \fBfilesize\fR options are given, this amount will be
391 divided between the available files for the job. If not set, fio will use the
392 full size of the given files or devices. If the files do not exist, size
393 must be given. It is also possible to give size as a percentage between 1 and
394 100. If size=20% is given, fio will use 20% of the full size of the given
395 files or devices.
396 .TP
397 .BI io_limit \fR=\fPint
398 Normally fio operates within the region set by \fBsize\fR, which means that
399 the \fBsize\fR option sets both the region and size of IO to be performed.
400 Sometimes that is not what you want. With this option, it is possible to
401 define just the amount of IO that fio should do. For instance, if \fBsize\fR
402 is set to 20G and \fBio_limit\fR is set to 5G, fio will perform IO within
403 the first 20G but exit when 5G have been done.
404 .TP
405 .BI fill_device \fR=\fPbool "\fR,\fB fill_fs" \fR=\fPbool
406 Sets size to something really large and waits for ENOSPC (no space left on
407 device) as the terminating condition. Only makes sense with sequential write.
408 For a read workload, the mount point will be filled first then IO started on
409 the result. This option doesn't make sense if operating on a raw device node,
410 since the size of that is already known by the file system. Additionally,
411 writing beyond end-of-device will not return ENOSPC there.
412 .TP
413 .BI filesize \fR=\fPirange
414 Individual file sizes. May be a range, in which case \fBfio\fR will select sizes
415 for files at random within the given range, limited to \fBsize\fR in total (if
416 that is given). If \fBfilesize\fR is not specified, each created file is the
417 same size.
418 .TP
419 .BI file_append \fR=\fPbool
420 Perform IO after the end of the file. Normally fio will operate within the
421 size of a file. If this option is set, then fio will append to the file
422 instead. This has identical behavior to setting \fRoffset\fP to the size
423 of a file. This option is ignored on non-regular files.
424 .TP
425 .BI blocksize \fR=\fPint[,int] "\fR,\fB bs" \fR=\fPint[,int]
426 Block size for I/O units.  Default: 4k.  Values for reads, writes, and trims
427 can be specified separately in the format \fIread\fR,\fIwrite\fR,\fItrim\fR
428 either of which may be empty to leave that value at its default. If a trailing
429 comma isn't given, the remainder will inherit the last value set.
430 .TP
431 .BI blocksize_range \fR=\fPirange[,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange]
432 Specify a range of I/O block sizes.  The issued I/O unit will always be a
433 multiple of the minimum size, unless \fBblocksize_unaligned\fR is set.  Applies
434 to both reads and writes if only one range is given, but can be specified
435 separately with a comma separating the values. Example: bsrange=1k-4k,2k-8k.
436 Also (see \fBblocksize\fR).
437 .TP
438 .BI bssplit \fR=\fPstr
439 This option allows even finer grained control of the block sizes issued,
440 not just even splits between them. With this option, you can weight various
441 block sizes for exact control of the issued IO for a job that has mixed
442 block sizes. The format of the option is bssplit=blocksize/percentage,
443 optionally adding as many definitions as needed separated by a colon.
444 Example: bssplit=4k/10:64k/50:32k/40 would issue 50% 64k blocks, 10% 4k
445 blocks and 40% 32k blocks. \fBbssplit\fR also supports giving separate
446 splits to reads and writes. The format is identical to what the
447 \fBbs\fR option accepts, the read and write parts are separated with a
448 comma.
449 .TP
450 .B blocksize_unaligned\fR,\fP bs_unaligned
451 If set, any size in \fBblocksize_range\fR may be used.  This typically won't
452 work with direct I/O, as that normally requires sector alignment.
453 .TP
454 .BI blockalign \fR=\fPint[,int] "\fR,\fB ba" \fR=\fPint[,int]
455 At what boundary to align random IO offsets. Defaults to the same as 'blocksize'
456 the minimum blocksize given.  Minimum alignment is typically 512b
457 for using direct IO, though it usually depends on the hardware block size.
458 This option is mutually exclusive with using a random map for files, so it
459 will turn off that option.
460 .TP
461 .BI bs_is_seq_rand \fR=\fPbool
462 If this option is set, fio will use the normal read,write blocksize settings as
463 sequential,random instead. Any random read or write will use the WRITE
464 blocksize settings, and any sequential read or write will use the READ
465 blocksize setting.
466 .TP
467 .B zero_buffers
468 Initialize buffers with all zeros. Default: fill buffers with random data.
469 The resulting IO buffers will not be completely zeroed, unless
470 \fPscramble_buffers\fR is also turned off.
471 .TP
472 .B refill_buffers
473 If this option is given, fio will refill the IO buffers on every submit. The
474 default is to only fill it at init time and reuse that data. Only makes sense
475 if zero_buffers isn't specified, naturally. If data verification is enabled,
476 refill_buffers is also automatically enabled.
477 .TP
478 .BI scramble_buffers \fR=\fPbool
479 If \fBrefill_buffers\fR is too costly and the target is using data
480 deduplication, then setting this option will slightly modify the IO buffer
481 contents to defeat normal de-dupe attempts. This is not enough to defeat
482 more clever block compression attempts, but it will stop naive dedupe
483 of blocks. Default: true.
484 .TP
485 .BI buffer_compress_percentage \fR=\fPint
486 If this is set, then fio will attempt to provide IO buffer content (on WRITEs)
487 that compress to the specified level. Fio does this by providing a mix of
488 random data and zeroes. Note that this is per block size unit, for file/disk
489 wide compression level that matches this setting, you'll also want to set
490 \fBrefill_buffers\fR.
491 .TP
492 .BI buffer_compress_chunk \fR=\fPint
493 See \fBbuffer_compress_percentage\fR. This setting allows fio to manage how
494 big the ranges of random data and zeroed data is. Without this set, fio will
495 provide \fBbuffer_compress_percentage\fR of blocksize random data, followed by
496 the remaining zeroed. With this set to some chunk size smaller than the block
497 size, fio can alternate random and zeroed data throughout the IO buffer.
498 .TP
499 .BI buffer_pattern \fR=\fPstr
500 If set, fio will fill the IO buffers with this pattern. If not set, the contents
501 of IO buffers is defined by the other options related to buffer contents. The
502 setting can be any pattern of bytes, and can be prefixed with 0x for hex
503 values. It may also be a string, where the string must then be wrapped with
504 "".
505 .TP
506 .BI dedupe_percentage \fR=\fPint
507 If set, fio will generate this percentage of identical buffers when writing.
508 These buffers will be naturally dedupable. The contents of the buffers depend
509 on what other buffer compression settings have been set. It's possible to have
510 the individual buffers either fully compressible, or not at all. This option
511 only controls the distribution of unique buffers.
512 .TP
513 .BI nrfiles \fR=\fPint
514 Number of files to use for this job.  Default: 1.
515 .TP
516 .BI openfiles \fR=\fPint
517 Number of files to keep open at the same time.  Default: \fBnrfiles\fR.
518 .TP
519 .BI file_service_type \fR=\fPstr
520 Defines how files to service are selected.  The following types are defined:
521 .RS
522 .RS
523 .TP
524 .B random
525 Choose a file at random.
526 .TP
527 .B roundrobin
528 Round robin over opened files (default).
529 .TP
530 .B sequential
531 Do each file in the set sequentially.
532 .RE
533 .P
534 The number of I/Os to issue before switching to a new file can be specified by
535 appending `:\fIint\fR' to the service type.
536 .RE
537 .TP
538 .BI ioengine \fR=\fPstr
539 Defines how the job issues I/O.  The following types are defined:
540 .RS
541 .RS
542 .TP
543 .B sync
544 Basic \fBread\fR\|(2) or \fBwrite\fR\|(2) I/O.  \fBfseek\fR\|(2) is used to
545 position the I/O location.
546 .TP
547 .B psync
548 Basic \fBpread\fR\|(2) or \fBpwrite\fR\|(2) I/O.
549 .TP
550 .B vsync
551 Basic \fBreadv\fR\|(2) or \fBwritev\fR\|(2) I/O. Will emulate queuing by
552 coalescing adjacent IOs into a single submission.
553 .TP
554 .B pvsync
555 Basic \fBpreadv\fR\|(2) or \fBpwritev\fR\|(2) I/O.
556 .TP
557 .B libaio
558 Linux native asynchronous I/O. This ioengine defines engine specific options.
559 .TP
560 .B posixaio
561 POSIX asynchronous I/O using \fBaio_read\fR\|(3) and \fBaio_write\fR\|(3).
562 .TP
563 .B solarisaio
564 Solaris native asynchronous I/O.
565 .TP
566 .B windowsaio
567 Windows native asynchronous I/O.
568 .TP
569 .B mmap
570 File is memory mapped with \fBmmap\fR\|(2) and data copied using
571 \fBmemcpy\fR\|(3).
572 .TP
573 .B splice
574 \fBsplice\fR\|(2) is used to transfer the data and \fBvmsplice\fR\|(2) to
575 transfer data from user-space to the kernel.
576 .TP
577 .B syslet-rw
578 Use the syslet system calls to make regular read/write asynchronous.
579 .TP
580 .B sg
581 SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if
582 the target is an sg character device, we use \fBread\fR\|(2) and
583 \fBwrite\fR\|(2) for asynchronous I/O.
584 .TP
585 .B null
586 Doesn't transfer any data, just pretends to.  Mainly used to exercise \fBfio\fR
587 itself and for debugging and testing purposes.
588 .TP
589 .B net
590 Transfer over the network.  The protocol to be used can be defined with the
591 \fBprotocol\fR parameter.  Depending on the protocol, \fBfilename\fR,
592 \fBhostname\fR, \fBport\fR, or \fBlisten\fR must be specified.
593 This ioengine defines engine specific options.
594 .TP
595 .B netsplice
596 Like \fBnet\fR, but uses \fBsplice\fR\|(2) and \fBvmsplice\fR\|(2) to map data
597 and send/receive. This ioengine defines engine specific options.
598 .TP
599 .B cpuio
600 Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and
601 \fBcpucycles\fR parameters.
602 .TP
603 .B guasi
604 The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface
605 approach to asynchronous I/O.
606 .br
607 See <http://www.xmailserver.org/guasi\-lib.html>.
608 .TP
609 .B rdma
610 The RDMA I/O engine supports both RDMA memory semantics (RDMA_WRITE/RDMA_READ)
611 and channel semantics (Send/Recv) for the InfiniBand, RoCE and iWARP protocols.
612 .TP
613 .B external
614 Loads an external I/O engine object file.  Append the engine filename as
615 `:\fIenginepath\fR'.
616 .TP
617 .B falloc
618    IO engine that does regular linux native fallocate call to simulate data
619 transfer as fio ioengine
620 .br
621   DDIR_READ  does fallocate(,mode = FALLOC_FL_KEEP_SIZE,)
622 .br
623   DIR_WRITE does fallocate(,mode = 0)
624 .br
626 .TP
627 .B e4defrag
628 IO engine that does regular EXT4_IOC_MOVE_EXT ioctls to simulate defragment activity
629 request to DDIR_WRITE event
630 .TP
631 .B rbd
632 IO engine supporting direct access to Ceph Rados Block Devices (RBD) via librbd 
633 without the need to use the kernel rbd driver. This ioengine defines engine specific 
634 options.
635 .TP
636 .B gfapi
637 Using Glusterfs libgfapi sync interface to direct access to Glusterfs volumes without
638 having to go through FUSE. This ioengine defines engine specific
639 options.
640 .TP
641 .B gfapi_async
642 Using Glusterfs libgfapi async interface to direct access to Glusterfs volumes without
643 having to go through FUSE. This ioengine defines engine specific
644 options.
645 .TP
646 .B libhdfs
647 Read and write through Hadoop (HDFS).  The \fBfilename\fR option is used to
648 specify host,port of the hdfs name-node to connect. This engine interprets
649 offsets a little differently. In HDFS, files once created cannot be modified.
650 So random writes are not possible. To imitate this, libhdfs engine expects
651 bunch of small files to be created over HDFS, and engine will randomly pick a
652 file out of those files based on the offset generated by fio backend. (see the
653 example job file to create such files, use rw=write option). Please note, you
654 might want to set necessary environment variables to work with hdfs/libhdfs
655 properly.
656 .RE
657 .P
658 .RE
659 .TP
660 .BI iodepth \fR=\fPint
661 Number of I/O units to keep in flight against the file. Note that increasing
662 iodepth beyond 1 will not affect synchronous ioengines (except for small
663 degress when verify_async is in use). Even async engines may impose OS
664 restrictions causing the desired depth not to be achieved.  This may happen on
665 Linux when using libaio and not setting \fBdirect\fR=1, since buffered IO is
666 not async on that OS. Keep an eye on the IO depth distribution in the
667 fio output to verify that the achieved depth is as expected. Default: 1.
668 .TP
669 .BI iodepth_batch \fR=\fPint
670 Number of I/Os to submit at once.  Default: \fBiodepth\fR.
671 .TP
672 .BI iodepth_batch_complete \fR=\fPint
673 This defines how many pieces of IO to retrieve at once. It defaults to 1 which
674  means that we'll ask for a minimum of 1 IO in the retrieval process from the
675 kernel. The IO retrieval will go on until we hit the limit set by
676 \fBiodepth_low\fR. If this variable is set to 0, then fio will always check for
677 completed events before queuing more IO. This helps reduce IO latency, at the
678 cost of more retrieval system calls.
679 .TP
680 .BI iodepth_low \fR=\fPint
681 Low watermark indicating when to start filling the queue again.  Default:
682 \fBiodepth\fR. 
683 .TP
684 .BI direct \fR=\fPbool
685 If true, use non-buffered I/O (usually O_DIRECT).  Default: false.
686 .TP
687 .BI atomic \fR=\fPbool
688 If value is true, attempt to use atomic direct IO. Atomic writes are guaranteed
689 to be stable once acknowledged by the operating system. Only Linux supports
690 O_ATOMIC right now.
691 .TP
692 .BI buffered \fR=\fPbool
693 If true, use buffered I/O.  This is the opposite of the \fBdirect\fR parameter.
694 Default: true.
695 .TP
696 .BI offset \fR=\fPint
697 Offset in the file to start I/O. Data before the offset will not be touched.
698 .TP
699 .BI offset_increment \fR=\fPint
700 If this is provided, then the real offset becomes the
701 offset + offset_increment * thread_number, where the thread number is a
702 counter that starts at 0 and is incremented for each sub-job (i.e. when
703 numjobs option is specified). This option is useful if there are several jobs
704 which are intended to operate on a file in parallel disjoint segments, with
705 even spacing between the starting points.
706 .TP
707 .BI number_ios \fR=\fPint
708 Fio will normally perform IOs until it has exhausted the size of the region
709 set by \fBsize\fR, or if it exhaust the allocated time (or hits an error
710 condition). With this setting, the range/size can be set independently of
711 the number of IOs to perform. When fio reaches this number, it will exit
712 normally and report status. Note that this does not extend the amount
713 of IO that will be done, it will only stop fio if this condition is met
714 before other end-of-job criteria.
715 .TP
716 .BI fsync \fR=\fPint
717 How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data.  If
718 0, don't sync.  Default: 0.
719 .TP
720 .BI fdatasync \fR=\fPint
721 Like \fBfsync\fR, but uses \fBfdatasync\fR\|(2) instead to only sync the
722 data parts of the file. Default: 0.
723 .TP
724 .BI write_barrier \fR=\fPint
725 Make every Nth write a barrier write.
726 .TP
727 .BI sync_file_range \fR=\fPstr:int
728 Use \fBsync_file_range\fR\|(2) for every \fRval\fP number of write operations. Fio will
729 track range of writes that have happened since the last \fBsync_file_range\fR\|(2) call.
730 \fRstr\fP can currently be one or more of:
731 .RS
732 .TP
733 .B wait_before
735 .TP
736 .B write
738 .TP
739 .B wait_after
741 .TP
742 .RE
743 .P
744 So if you do sync_file_range=wait_before,write:8, fio would use
746 Also see the \fBsync_file_range\fR\|(2) man page.  This option is Linux specific.
747 .TP
748 .BI overwrite \fR=\fPbool
749 If writing, setup the file first and do overwrites.  Default: false.
750 .TP
751 .BI end_fsync \fR=\fPbool
752 Sync file contents when a write stage has completed.  Default: false.
753 .TP
754 .BI fsync_on_close \fR=\fPbool
755 If true, sync file contents on close.  This differs from \fBend_fsync\fR in that
756 it will happen on every close, not just at the end of the job.  Default: false.
757 .TP
758 .BI rwmixread \fR=\fPint
759 Percentage of a mixed workload that should be reads. Default: 50.
760 .TP
761 .BI rwmixwrite \fR=\fPint
762 Percentage of a mixed workload that should be writes.  If \fBrwmixread\fR and
763 \fBrwmixwrite\fR are given and do not sum to 100%, the latter of the two
764 overrides the first. This may interfere with a given rate setting, if fio is
765 asked to limit reads or writes to a certain rate. If that is the case, then
766 the distribution may be skewed. Default: 50.
767 .TP
768 .BI random_distribution \fR=\fPstr:float
769 By default, fio will use a completely uniform random distribution when asked
770 to perform random IO. Sometimes it is useful to skew the distribution in
771 specific ways, ensuring that some parts of the data is more hot than others.
772 Fio includes the following distribution models:
773 .RS
774 .TP
775 .B random
776 Uniform random distribution
777 .TP
778 .B zipf
779 Zipf distribution
780 .TP
781 .B pareto
782 Pareto distribution
783 .TP
784 .RE
785 .P
786 When using a zipf or pareto distribution, an input value is also needed to
787 define the access pattern. For zipf, this is the zipf theta. For pareto,
788 it's the pareto power. Fio includes a test program, genzipf, that can be
789 used visualize what the given input values will yield in terms of hit rates.
790 If you wanted to use zipf with a theta of 1.2, you would use
791 random_distribution=zipf:1.2 as the option. If a non-uniform model is used,
792 fio will disable use of the random map.
793 .TP
794 .BI percentage_random \fR=\fPint
795 For a random workload, set how big a percentage should be random. This defaults
796 to 100%, in which case the workload is fully random. It can be set from
797 anywhere from 0 to 100.  Setting it to 0 would make the workload fully
798 sequential. It is possible to set different values for reads, writes, and
799 trim. To do so, simply use a comma separated list. See \fBblocksize\fR.
800 .TP
801 .B norandommap
802 Normally \fBfio\fR will cover every block of the file when doing random I/O. If
803 this parameter is given, a new offset will be chosen without looking at past
804 I/O history.  This parameter is mutually exclusive with \fBverify\fR.
805 .TP
806 .BI softrandommap \fR=\fPbool
807 See \fBnorandommap\fR. If fio runs with the random block map enabled and it
808 fails to allocate the map, if this option is set it will continue without a
809 random block map. As coverage will not be as complete as with random maps, this
810 option is disabled by default.
811 .TP
812 .BI random_generator \fR=\fPstr
813 Fio supports the following engines for generating IO offsets for random IO:
814 .RS
815 .TP
816 .B tausworthe
817 Strong 2^88 cycle random number generator
818 .TP
819 .B lfsr
820 Linear feedback shift register generator
821 .TP
822 .RE
823 .P
824 Tausworthe is a strong random number generator, but it requires tracking on the
825 side if we want to ensure that blocks are only read or written once. LFSR
826 guarantees that we never generate the same offset twice, and it's also less
827 computationally expensive. It's not a true random generator, however, though
828 for IO purposes it's typically good enough. LFSR only works with single block
829 sizes, not with workloads that use multiple block sizes. If used with such a
830 workload, fio may read or write some blocks multiple times.
831 .TP
832 .BI nice \fR=\fPint
833 Run job with given nice value.  See \fBnice\fR\|(2).
834 .TP
835 .BI prio \fR=\fPint
836 Set I/O priority value of this job between 0 (highest) and 7 (lowest).  See
837 \fBionice\fR\|(1).
838 .TP
839 .BI prioclass \fR=\fPint
840 Set I/O priority class.  See \fBionice\fR\|(1).
841 .TP
842 .BI thinktime \fR=\fPint
843 Stall job for given number of microseconds between issuing I/Os.
844 .TP
845 .BI thinktime_spin \fR=\fPint
846 Pretend to spend CPU time for given number of microseconds, sleeping the rest
847 of the time specified by \fBthinktime\fR.  Only valid if \fBthinktime\fR is set.
848 .TP
849 .BI thinktime_blocks \fR=\fPint
850 Only valid if thinktime is set - control how many blocks to issue, before
851 waiting \fBthinktime\fR microseconds. If not set, defaults to 1 which will
852 make fio wait \fBthinktime\fR microseconds after every block. This
853 effectively makes any queue depth setting redundant, since no more than 1 IO
854 will be queued before we have to complete it and do our thinktime. In other
855 words, this setting effectively caps the queue depth if the latter is larger.
856 Default: 1.
857 .TP
858 .BI rate \fR=\fPint
859 Cap bandwidth used by this job. The number is in bytes/sec, the normal postfix
860 rules apply. You can use \fBrate\fR=500k to limit reads and writes to 500k each,
861 or you can specify read and writes separately. Using \fBrate\fR=1m,500k would
862 limit reads to 1MB/sec and writes to 500KB/sec. Capping only reads or writes
863 can be done with \fBrate\fR=,500k or \fBrate\fR=500k,. The former will only
864 limit writes (to 500KB/sec), the latter will only limit reads.
865 .TP
866 .BI ratemin \fR=\fPint
867 Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth.
868 Failing to meet this requirement will cause the job to exit. The same format
869 as \fBrate\fR is used for read vs write separation.
870 .TP
871 .BI rate_iops \fR=\fPint
872 Cap the bandwidth to this number of IOPS. Basically the same as rate, just
873 specified independently of bandwidth. The same format as \fBrate\fR is used for
874 read vs write separation. If \fBblocksize\fR is a range, the smallest block
875 size is used as the metric.
876 .TP
877 .BI rate_iops_min \fR=\fPint
878 If this rate of I/O is not met, the job will exit. The same format as \fBrate\fR
879 is used for read vs write separation.
880 .TP
881 .BI ratecycle \fR=\fPint
882 Average bandwidth for \fBrate\fR and \fBratemin\fR over this number of
883 milliseconds.  Default: 1000ms.
884 .TP
885 .BI latency_target \fR=\fPint
886 If set, fio will attempt to find the max performance point that the given
887 workload will run at while maintaining a latency below this target. The
888 values is given in microseconds. See \fBlatency_window\fR and
889 \fBlatency_percentile\fR.
890 .TP
891 .BI latency_window \fR=\fPint
892 Used with \fBlatency_target\fR to specify the sample window that the job
893 is run at varying queue depths to test the performance. The value is given
894 in microseconds.
895 .TP
896 .BI latency_percentile \fR=\fPfloat
897 The percentage of IOs that must fall within the criteria specified by
898 \fBlatency_target\fR and \fBlatency_window\fR. If not set, this defaults
899 to 100.0, meaning that all IOs must be equal or below to the value set
900 by \fBlatency_target\fR.
901 .TP
902 .BI max_latency \fR=\fPint
903 If set, fio will exit the job if it exceeds this maximum latency. It will exit
904 with an ETIME error.
905 .TP
906 .BI cpumask \fR=\fPint
907 Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job
908 may run on.  See \fBsched_setaffinity\fR\|(2).
909 .TP
910 .BI cpus_allowed \fR=\fPstr
911 Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers.
912 .TP
913 .BI cpus_allowed_policy \fR=\fPstr
914 Set the policy of how fio distributes the CPUs specified by \fBcpus_allowed\fR
915 or \fBcpumask\fR. Two policies are supported:
916 .RS
917 .RS
918 .TP
919 .B shared
920 All jobs will share the CPU set specified.
921 .TP
922 .B split
923 Each job will get a unique CPU from the CPU set.
924 .RE
925 .P
926 \fBshared\fR is the default behaviour, if the option isn't specified. If
927 \fBsplit\fR is specified, then fio will assign one cpu per job. If not enough
928 CPUs are given for the jobs listed, then fio will roundrobin the CPUs in
929 the set.
930 .RE
931 .P
932 .TP
933 .BI numa_cpu_nodes \fR=\fPstr
934 Set this job running on specified NUMA nodes' CPUs. The arguments allow
935 comma delimited list of cpu numbers, A-B ranges, or 'all'.
936 .TP
937 .BI numa_mem_policy \fR=\fPstr
938 Set this job's memory policy and corresponding NUMA nodes. Format of
939 the arguments:
940 .RS
941 .TP
942 .B <mode>[:<nodelist>]
943 .TP
944 .B mode
945 is one of the following memory policy:
946 .TP
947 .B default, prefer, bind, interleave, local
948 .TP
949 .RE
950 For \fBdefault\fR and \fBlocal\fR memory policy, no \fBnodelist\fR is
951 needed to be specified. For \fBprefer\fR, only one node is
952 allowed. For \fBbind\fR and \fBinterleave\fR, \fBnodelist\fR allows
953 comma delimited list of numbers, A-B ranges, or 'all'.
954 .TP
955 .BI startdelay \fR=\fPirange
956 Delay start of job for the specified number of seconds. Supports all time
957 suffixes to allow specification of hours, minutes, seconds and
958 milliseconds - seconds are the default if a unit is ommited.
959 Can be given as a range which causes each thread to choose randomly out of the
960 range.
961 .TP
962 .BI runtime \fR=\fPint
963 Terminate processing after the specified number of seconds.
964 .TP
965 .B time_based
966 If given, run for the specified \fBruntime\fR duration even if the files are
967 completely read or written. The same workload will be repeated as many times
968 as \fBruntime\fR allows.
969 .TP
970 .BI ramp_time \fR=\fPint
971 If set, fio will run the specified workload for this amount of time before
972 logging any performance numbers. Useful for letting performance settle before
973 logging results, thus minimizing the runtime required for stable results. Note
974 that the \fBramp_time\fR is considered lead in time for a job, thus it will
975 increase the total runtime if a special timeout or runtime is specified.
976 .TP
977 .BI invalidate \fR=\fPbool
978 Invalidate buffer-cache for the file prior to starting I/O.  Default: true.
979 .TP
980 .BI sync \fR=\fPbool
981 Use synchronous I/O for buffered writes.  For the majority of I/O engines,
982 this means using O_SYNC.  Default: false.
983 .TP
984 .BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
985 Allocation method for I/O unit buffer.  Allowed values are:
986 .RS
987 .RS
988 .TP
989 .B malloc
990 Allocate memory with \fBmalloc\fR\|(3).
991 .TP
992 .B shm
993 Use shared memory buffers allocated through \fBshmget\fR\|(2).
994 .TP
995 .B shmhuge
996 Same as \fBshm\fR, but use huge pages as backing.
997 .TP
998 .B mmap
999 Use \fBmmap\fR\|(2) for allocation.  Uses anonymous memory unless a filename
1000 is given after the option in the format `:\fIfile\fR'.
1001 .TP
1002 .B mmaphuge
1003 Same as \fBmmap\fR, but use huge files as backing.
1004 .RE
1005 .P
1006 The amount of memory allocated is the maximum allowed \fBblocksize\fR for the
1007 job multiplied by \fBiodepth\fR.  For \fBshmhuge\fR or \fBmmaphuge\fR to work,
1008 the system must have free huge pages allocated.  \fBmmaphuge\fR also needs to
1009 have hugetlbfs mounted, and \fIfile\fR must point there. At least on Linux,
1010 huge pages must be manually allocated. See \fB/proc/sys/vm/nr_hugehages\fR
1011 and the documentation for that. Normally you just need to echo an appropriate
1012 number, eg echoing 8 will ensure that the OS has 8 huge pages ready for
1013 use.
1014 .RE
1015 .TP
1016 .BI iomem_align \fR=\fPint "\fR,\fP mem_align" \fR=\fPint
1017 This indicates the memory alignment of the IO memory buffers. Note that the
1018 given alignment is applied to the first IO unit buffer, if using \fBiodepth\fR
1019 the alignment of the following buffers are given by the \fBbs\fR used. In
1020 other words, if using a \fBbs\fR that is a multiple of the page sized in the
1021 system, all buffers will be aligned to this value. If using a \fBbs\fR that
1022 is not page aligned, the alignment of subsequent IO memory buffers is the
1023 sum of the \fBiomem_align\fR and \fBbs\fR used.
1024 .TP
1025 .BI hugepage\-size \fR=\fPint
1026 Defines the size of a huge page.  Must be at least equal to the system setting.
1027 Should be a multiple of 1MB. Default: 4MB.
1028 .TP
1029 .B exitall
1030 Terminate all jobs when one finishes.  Default: wait for each job to finish.
1031 .TP
1032 .BI bwavgtime \fR=\fPint
1033 Average bandwidth calculations over the given time in milliseconds.  Default:
1034 500ms.
1035 .TP
1036 .BI iopsavgtime \fR=\fPint
1037 Average IOPS calculations over the given time in milliseconds.  Default:
1038 500ms.
1039 .TP
1040 .BI create_serialize \fR=\fPbool
1041 If true, serialize file creation for the jobs.  Default: true.
1042 .TP
1043 .BI create_fsync \fR=\fPbool
1044 \fBfsync\fR\|(2) data file after creation.  Default: true.
1045 .TP
1046 .BI create_on_open \fR=\fPbool
1047 If true, the files are not created until they are opened for IO by the job.
1048 .TP
1049 .BI create_only \fR=\fPbool
1050 If true, fio will only run the setup phase of the job. If files need to be
1051 laid out or updated on disk, only that will be done. The actual job contents
1052 are not executed.
1053 .TP
1054 .BI pre_read \fR=\fPbool
1055 If this is given, files will be pre-read into memory before starting the given
1056 IO operation. This will also clear the \fR \fBinvalidate\fR flag, since it is
1057 pointless to pre-read and then drop the cache. This will only work for IO
1058 engines that are seekable, since they allow you to read the same data
1059 multiple times. Thus it will not work on eg network or splice IO.
1060 .TP
1061 .BI unlink \fR=\fPbool
1062 Unlink job files when done.  Default: false.
1063 .TP
1064 .BI loops \fR=\fPint
1065 Specifies the number of iterations (runs of the same workload) of this job.
1066 Default: 1.
1067 .TP
1068 .BI verify_only \fR=\fPbool
1069 Do not perform the specified workload, only verify data still matches previous
1070 invocation of this workload. This option allows one to check data multiple
1071 times at a later date without overwriting it. This option makes sense only for
1072 workloads that write data, and does not support workloads with the
1073 \fBtime_based\fR option set.
1074 .TP
1075 .BI do_verify \fR=\fPbool
1076 Run the verify phase after a write phase.  Only valid if \fBverify\fR is set.
1077 Default: true.
1078 .TP
1079 .BI verify \fR=\fPstr
1080 Method of verifying file contents after each iteration of the job.  Allowed
1081 values are:
1082 .RS
1083 .RS
1084 .TP
1085 .B md5 crc16 crc32 crc32c crc32c-intel crc64 crc7 sha256 sha512 sha1 xxhash
1086 Store appropriate checksum in the header of each block. crc32c-intel is
1087 hardware accelerated SSE4.2 driven, falls back to regular crc32c if
1088 not supported by the system.
1089 .TP
1090 .B meta
1091 Write extra information about each I/O (timestamp, block number, etc.). The
1092 block number is verified. See \fBverify_pattern\fR as well.
1093 .TP
1094 .B null
1095 Pretend to verify.  Used for testing internals.
1096 .RE
1098 This option can be used for repeated burn-in tests of a system to make sure
1099 that the written data is also correctly read back. If the data direction given
1100 is a read or random read, fio will assume that it should verify a previously
1101 written file. If the data direction includes any form of write, the verify will
1102 be of the newly written data.
1103 .RE
1104 .TP
1105 .BI verifysort \fR=\fPbool
1106 If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to
1107 read them back in a sorted manner.  Default: true.
1108 .TP
1109 .BI verifysort_nr \fR=\fPint
1110 Pre-load and sort verify blocks for a read workload.
1111 .TP
1112 .BI verify_offset \fR=\fPint
1113 Swap the verification header with data somewhere else in the block before
1114 writing.  It is swapped back before verifying.
1115 .TP
1116 .BI verify_interval \fR=\fPint
1117 Write the verification header for this number of bytes, which should divide
1118 \fBblocksize\fR.  Default: \fBblocksize\fR.
1119 .TP
1120 .BI verify_pattern \fR=\fPstr
1121 If set, fio will fill the io buffers with this pattern. Fio defaults to filling
1122 with totally random bytes, but sometimes it's interesting to fill with a known
1123 pattern for io verification purposes. Depending on the width of the pattern,
1124 fio will fill 1/2/3/4 bytes of the buffer at the time(it can be either a
1125 decimal or a hex number). The verify_pattern if larger than a 32-bit quantity
1126 has to be a hex number that starts with either "0x" or "0X". Use with
1127 \fBverify\fP=meta.
1128 .TP
1129 .BI verify_fatal \fR=\fPbool
1130 If true, exit the job on the first observed verification failure.  Default:
1131 false.
1132 .TP
1133 .BI verify_dump \fR=\fPbool
1134 If set, dump the contents of both the original data block and the data block we
1135 read off disk to files. This allows later analysis to inspect just what kind of
1136 data corruption occurred. Off by default.
1137 .TP
1138 .BI verify_async \fR=\fPint
1139 Fio will normally verify IO inline from the submitting thread. This option
1140 takes an integer describing how many async offload threads to create for IO
1141 verification instead, causing fio to offload the duty of verifying IO contents
1142 to one or more separate threads.  If using this offload option, even sync IO
1143 engines can benefit from using an \fBiodepth\fR setting higher than 1, as it
1144 allows them to have IO in flight while verifies are running.
1145 .TP
1146 .BI verify_async_cpus \fR=\fPstr
1147 Tell fio to set the given CPU affinity on the async IO verification threads.
1148 See \fBcpus_allowed\fP for the format used.
1149 .TP
1150 .BI verify_backlog \fR=\fPint
1151 Fio will normally verify the written contents of a job that utilizes verify
1152 once that job has completed. In other words, everything is written then
1153 everything is read back and verified. You may want to verify continually
1154 instead for a variety of reasons. Fio stores the meta data associated with an
1155 IO block in memory, so for large verify workloads, quite a bit of memory would
1156 be used up holding this meta data. If this option is enabled, fio will write
1157 only N blocks before verifying these blocks.
1158 .TP
1159 .BI verify_backlog_batch \fR=\fPint
1160 Control how many blocks fio will verify if verify_backlog is set. If not set,
1161 will default to the value of \fBverify_backlog\fR (meaning the entire queue is
1162 read back and verified).  If \fBverify_backlog_batch\fR is less than 
1163 \fBverify_backlog\fR then not all blocks will be verified,  if 
1164 \fBverify_backlog_batch\fR is larger than \fBverify_backlog\fR,  some blocks
1165 will be verified more than once.
1166 .TP
1167 .BI trim_percentage \fR=\fPint
1168 Number of verify blocks to discard/trim.
1169 .TP
1170 .BI trim_verify_zero \fR=\fPbool
1171 Verify that trim/discarded blocks are returned as zeroes.
1172 .TP
1173 .BI trim_backlog \fR=\fPint
1174 Trim after this number of blocks are written.
1175 .TP
1176 .BI trim_backlog_batch \fR=\fPint
1177 Trim this number of IO blocks.
1178 .TP
1179 .BI experimental_verify \fR=\fPbool
1180 Enable experimental verification.
1181 .TP
1182 .B stonewall "\fR,\fP wait_for_previous"
1183 Wait for preceding jobs in the job file to exit before starting this one.
1184 \fBstonewall\fR implies \fBnew_group\fR.
1185 .TP
1186 .B new_group
1187 Start a new reporting group.  If not given, all jobs in a file will be part
1188 of the same reporting group, unless separated by a stonewall.
1189 .TP
1190 .BI numjobs \fR=\fPint
1191 Number of clones (processes/threads performing the same workload) of this job.  
1192 Default: 1.
1193 .TP
1194 .B group_reporting
1195 If set, display per-group reports instead of per-job when \fBnumjobs\fR is
1196 specified.
1197 .TP
1198 .B thread
1199 Use threads created with \fBpthread_create\fR\|(3) instead of processes created
1200 with \fBfork\fR\|(2).
1201 .TP
1202 .BI zonesize \fR=\fPint
1203 Divide file into zones of the specified size in bytes.  See \fBzoneskip\fR.
1204 .TP
1205 .BI zonerange \fR=\fPint
1206 Give size of an IO zone.  See \fBzoneskip\fR.
1207 .TP
1208 .BI zoneskip \fR=\fPint
1209 Skip the specified number of bytes when \fBzonesize\fR bytes of data have been
1210 read.
1211 .TP
1212 .BI write_iolog \fR=\fPstr
1213 Write the issued I/O patterns to the specified file.  Specify a separate file
1214 for each job, otherwise the iologs will be interspersed and the file may be
1215 corrupt.
1216 .TP
1217 .BI read_iolog \fR=\fPstr
1218 Replay the I/O patterns contained in the specified file generated by
1219 \fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file.
1220 .TP
1221 .BI replay_no_stall \fR=\fPint
1222 While replaying I/O patterns using \fBread_iolog\fR the default behavior
1223 attempts to respect timing information between I/Os.  Enabling
1224 \fBreplay_no_stall\fR causes I/Os to be replayed as fast as possible while
1225 still respecting ordering.
1226 .TP
1227 .BI replay_redirect \fR=\fPstr
1228 While replaying I/O patterns using \fBread_iolog\fR the default behavior
1229 is to replay the IOPS onto the major/minor device that each IOP was recorded
1230 from.  Setting \fBreplay_redirect\fR causes all IOPS to be replayed onto the
1231 single specified device regardless of the device it was recorded from.
1232 .TP
1233 .BI write_bw_log \fR=\fPstr
1234 If given, write a bandwidth log of the jobs in this job file. Can be used to
1235 store data of the bandwidth of the jobs in their lifetime. The included
1236 fio_generate_plots script uses gnuplot to turn these text files into nice
1237 graphs. See \fBwrite_lat_log\fR for behaviour of given filename. For this
1238 option, the postfix is _bw.x.log, where x is the index of the job (1..N,
1239 where N is the number of jobs)
1240 .TP
1241 .BI write_lat_log \fR=\fPstr
1242 Same as \fBwrite_bw_log\fR, but writes I/O completion latencies.  If no
1243 filename is given with this option, the default filename of
1244 "jobname_type.x.log" is used, where x is the index of the job (1..N, where
1245 N is the number of jobs). Even if the filename is given, fio will still
1246 append the type of log.
1247 .TP
1248 .BI write_iops_log \fR=\fPstr
1249 Same as \fBwrite_bw_log\fR, but writes IOPS. If no filename is given with this
1250 option, the default filename of "jobname_type.x.log" is used, where x is the
1251 index of the job (1..N, where N is the number of jobs). Even if the filename
1252 is given, fio will still append the type of log.
1253 .TP
1254 .BI log_avg_msec \fR=\fPint
1255 By default, fio will log an entry in the iops, latency, or bw log for every
1256 IO that completes. When writing to the disk log, that can quickly grow to a
1257 very large size. Setting this option makes fio average the each log entry
1258 over the specified period of time, reducing the resolution of the log.
1259 Defaults to 0.
1260 .TP
1261 .BI log_offset \fR=\fPbool
1262 If this is set, the iolog options will include the byte offset for the IO
1263 entry as well as the other data values.
1264 .TP
1265 .BI log_compression \fR=\fPint
1266 If this is set, fio will compress the IO logs as it goes, to keep the memory
1267 footprint lower. When a log reaches the specified size, that chunk is removed
1268 and compressed in the background. Given that IO logs are fairly highly
1269 compressible, this yields a nice memory savings for longer runs. The downside
1270 is that the compression will consume some background CPU cycles, so it may
1271 impact the run. This, however, is also true if the logging ends up consuming
1272 most of the system memory. So pick your poison. The IO logs are saved
1273 normally at the end of a run, by decompressing the chunks and storing them
1274 in the specified log file. This feature depends on the availability of zlib.
1275 .TP
1276 .BI log_store_compressed \fR=\fPbool
1277 If set, and \fBlog\fR_compression is also set, fio will store the log files in
1278 a compressed format. They can be decompressed with fio, using the
1279 \fB\-\-inflate-log\fR command line parameter. The files will be stored with a
1280 \fB\.fz\fR suffix.
1281 .TP
1282 .BI disable_lat \fR=\fPbool
1283 Disable measurements of total latency numbers. Useful only for cutting
1284 back the number of calls to \fBgettimeofday\fR\|(2), as that does impact performance at
1285 really high IOPS rates.  Note that to really get rid of a large amount of these
1286 calls, this option must be used with disable_slat and disable_bw as well.
1287 .TP
1288 .BI disable_clat \fR=\fPbool
1289 Disable measurements of completion latency numbers. See \fBdisable_lat\fR.
1290 .TP
1291 .BI disable_slat \fR=\fPbool
1292 Disable measurements of submission latency numbers. See \fBdisable_lat\fR.
1293 .TP
1294 .BI disable_bw_measurement \fR=\fPbool
1295 Disable measurements of throughput/bandwidth numbers. See \fBdisable_lat\fR.
1296 .TP
1297 .BI lockmem \fR=\fPint
1298 Pin the specified amount of memory with \fBmlock\fR\|(2).  Can be used to
1299 simulate a smaller amount of memory. The amount specified is per worker.
1300 .TP
1301 .BI exec_prerun \fR=\fPstr
1302 Before running the job, execute the specified command with \fBsystem\fR\|(3).
1303 .RS
1304 Output is redirected in a file called \fBjobname.prerun.txt\fR
1305 .RE
1306 .TP
1307 .BI exec_postrun \fR=\fPstr
1308 Same as \fBexec_prerun\fR, but the command is executed after the job completes.
1309 .RS
1310 Output is redirected in a file called \fBjobname.postrun.txt\fR
1311 .RE
1312 .TP
1313 .BI ioscheduler \fR=\fPstr
1314 Attempt to switch the device hosting the file to the specified I/O scheduler.
1315 .TP
1316 .BI disk_util \fR=\fPbool
1317 Generate disk utilization statistics if the platform supports it. Default: true.
1318 .TP
1319 .BI clocksource \fR=\fPstr
1320 Use the given clocksource as the base of timing. The supported options are:
1321 .RS
1322 .TP
1323 .B gettimeofday
1324 \fBgettimeofday\fR\|(2)
1325 .TP
1326 .B clock_gettime
1327 \fBclock_gettime\fR\|(2)
1328 .TP
1329 .B cpu
1330 Internal CPU clock source
1331 .TP
1332 .RE
1333 .P
1334 \fBcpu\fR is the preferred clocksource if it is reliable, as it is very fast
1335 (and fio is heavy on time calls). Fio will automatically use this clocksource
1336 if it's supported and considered reliable on the system it is running on,
1337 unless another clocksource is specifically set. For x86/x86-64 CPUs, this
1338 means supporting TSC Invariant.
1339 .TP
1340 .BI gtod_reduce \fR=\fPbool
1341 Enable all of the \fBgettimeofday\fR\|(2) reducing options (disable_clat, disable_slat,
1342 disable_bw) plus reduce precision of the timeout somewhat to really shrink the
1343 \fBgettimeofday\fR\|(2) call count. With this option enabled, we only do about 0.4% of
1344 the gtod() calls we would have done if all time keeping was enabled.
1345 .TP
1346 .BI gtod_cpu \fR=\fPint
1347 Sometimes it's cheaper to dedicate a single thread of execution to just getting
1348 the current time. Fio (and databases, for instance) are very intensive on
1349 \fBgettimeofday\fR\|(2) calls. With this option, you can set one CPU aside for doing
1350 nothing but logging current time to a shared memory location. Then the other
1351 threads/processes that run IO workloads need only copy that segment, instead of
1352 entering the kernel with a \fBgettimeofday\fR\|(2) call. The CPU set aside for doing
1353 these time calls will be excluded from other uses. Fio will manually clear it
1354 from the CPU mask of other jobs.
1355 .TP
1356 .BI ignore_error \fR=\fPstr
1357 Sometimes you want to ignore some errors during test in that case you can specify
1358 error list for each error type.
1359 .br
1361 .br
1362 errors for given error type is separated with ':'.
1363 Error may be symbol ('ENOSPC', 'ENOMEM') or an integer.
1364 .br
1365 Example: ignore_error=EAGAIN,ENOSPC:122 .
1366 .br     
1367 This option will ignore EAGAIN from READ, and ENOSPC and 122(EDQUOT) from WRITE. 
1368 .TP
1369 .BI error_dump \fR=\fPbool
1370 If set dump every error even if it is non fatal, true by default. If disabled
1371 only fatal error will be dumped
1372 .TP
1373 .BI profile \fR=\fPstr
1374 Select a specific builtin performance test.
1375 .TP
1376 .BI cgroup \fR=\fPstr
1377 Add job to this control group. If it doesn't exist, it will be created.
1378 The system must have a mounted cgroup blkio mount point for this to work. If
1379 your system doesn't have it mounted, you can do so with:
1381 # mount \-t cgroup \-o blkio none /cgroup
1382 .TP
1383 .BI cgroup_weight \fR=\fPint
1384 Set the weight of the cgroup to this value. See the documentation that comes
1385 with the kernel, allowed values are in the range of 100..1000.
1386 .TP
1387 .BI cgroup_nodelete \fR=\fPbool
1388 Normally fio will delete the cgroups it has created after the job completion.
1389 To override this behavior and to leave cgroups around after the job completion,
1390 set cgroup_nodelete=1. This can be useful if one wants to inspect various
1391 cgroup files after job completion. Default: false
1392 .TP
1393 .BI uid \fR=\fPint
1394 Instead of running as the invoking user, set the user ID to this value before
1395 the thread/process does any work.
1396 .TP
1397 .BI gid \fR=\fPint
1398 Set group ID, see \fBuid\fR.
1399 .TP
1400 .BI unit_base \fR=\fPint
1401 Base unit for reporting.  Allowed values are:
1402 .RS
1403 .TP
1404 .B 0
1405 Use auto-detection (default).
1406 .TP
1407 .B 8
1408 Byte based.
1409 .TP
1410 .B 1
1411 Bit based.
1412 .RE
1413 .P
1414 .TP
1415 .BI flow_id \fR=\fPint
1416 The ID of the flow. If not specified, it defaults to being a global flow. See
1417 \fBflow\fR.
1418 .TP
1419 .BI flow \fR=\fPint
1420 Weight in token-based flow control. If this value is used, then there is a
1421 \fBflow counter\fR which is used to regulate the proportion of activity between
1422 two or more jobs. fio attempts to keep this flow counter near zero. The
1423 \fBflow\fR parameter stands for how much should be added or subtracted to the
1424 flow counter on each iteration of the main I/O loop. That is, if one job has
1425 \fBflow=8\fR and another job has \fBflow=-1\fR, then there will be a roughly
1426 1:8 ratio in how much one runs vs the other.
1427 .TP
1428 .BI flow_watermark \fR=\fPint
1429 The maximum value that the absolute value of the flow counter is allowed to
1430 reach before the job must wait for a lower value of the counter.
1431 .TP
1432 .BI flow_sleep \fR=\fPint
1433 The period of time, in microseconds, to wait after the flow watermark has been
1434 exceeded before retrying operations
1435 .TP
1436 .BI clat_percentiles \fR=\fPbool
1437 Enable the reporting of percentiles of completion latencies.
1438 .TP
1439 .BI percentile_list \fR=\fPfloat_list
1440 Overwrite the default list of percentiles for completion
1441 latencies. Each number is a floating number in the range (0,100], and
1442 the maximum length of the list is 20. Use ':' to separate the
1443 numbers. For example, \-\-percentile_list=99.5:99.9 will cause fio to
1444 report the values of completion latency below which 99.5% and 99.9% of
1445 the observed latencies fell, respectively.
1446 .SS "Ioengine Parameters List"
1447 Some parameters are only valid when a specific ioengine is in use. These are
1448 used identically to normal parameters, with the caveat that when used on the
1449 command line, they must come after the ioengine.
1450 .TP
1451 .BI (cpu)cpuload \fR=\fPint
1452 Attempt to use the specified percentage of CPU cycles.
1453 .TP
1454 .BI (cpu)cpuchunks \fR=\fPint
1455 Split the load into cycles of the given time. In microseconds.
1456 .TP
1457 .BI (cpu)exit_on_io_done \fR=\fPbool
1458 Detect when IO threads are done, then exit.
1459 .TP
1460 .BI (libaio)userspace_reap
1461 Normally, with the libaio engine in use, fio will use
1462 the io_getevents system call to reap newly returned events.
1463 With this flag turned on, the AIO ring will be read directly
1464 from user-space to reap events. The reaping mode is only
1465 enabled when polling for a minimum of 0 events (eg when
1466 iodepth_batch_complete=0).
1467 .TP
1468 .BI (net,netsplice)hostname \fR=\fPstr
1469 The host name or IP address to use for TCP or UDP based IO.
1470 If the job is a TCP listener or UDP reader, the hostname is not
1471 used and must be omitted unless it is a valid UDP multicast address.
1472 .TP
1473 .BI (net,netsplice)port \fR=\fPint
1474 The TCP or UDP port to bind to or connect to.
1475 .TP
1476 .BI (net,netsplice)interface \fR=\fPstr
1477 The IP address of the network interface used to send or receive UDP multicast
1478 packets.
1479 .TP
1480 .BI (net,netsplice)ttl \fR=\fPint
1481 Time-to-live value for outgoing UDP multicast packets. Default: 1
1482 .TP
1483 .BI (net,netsplice)nodelay \fR=\fPbool
1484 Set TCP_NODELAY on TCP connections.
1485 .TP
1486 .BI (net,netsplice)protocol \fR=\fPstr "\fR,\fP proto" \fR=\fPstr
1487 The network protocol to use. Accepted values are:
1488 .RS
1489 .RS
1490 .TP
1491 .B tcp
1492 Transmission control protocol
1493 .TP
1494 .B tcpv6
1495 Transmission control protocol V6
1496 .TP
1497 .B udp
1498 User datagram protocol
1499 .TP
1500 .B udpv6
1501 User datagram protocol V6
1502 .TP
1503 .B unix
1504 UNIX domain socket
1505 .RE
1506 .P
1507 When the protocol is TCP or UDP, the port must also be given,
1508 as well as the hostname if the job is a TCP listener or UDP
1509 reader. For unix sockets, the normal filename option should be
1510 used and the port is invalid.
1511 .RE
1512 .TP
1513 .BI (net,netsplice)listen
1514 For TCP network connections, tell fio to listen for incoming
1515 connections rather than initiating an outgoing connection. The
1516 hostname must be omitted if this option is used.
1517 .TP
1518 .BI (net, pingpong) \fR=\fPbool
1519 Normally a network writer will just continue writing data, and a network reader
1520 will just consume packets. If pingpong=1 is set, a writer will send its normal
1521 payload to the reader, then wait for the reader to send the same payload back.
1522 This allows fio to measure network latencies. The submission and completion
1523 latencies then measure local time spent sending or receiving, and the
1524 completion latency measures how long it took for the other end to receive and
1525 send back. For UDP multicast traffic pingpong=1 should only be set for a single
1526 reader when multiple readers are listening to the same address.
1527 .TP
1528 .BI (net, window_size) \fR=\fPint
1529 Set the desired socket buffer size for the connection.
1530 .TP
1531 .BI (net, mss) \fR=\fPint
1532 Set the TCP maximum segment size (TCP_MAXSEG).
1533 .TP
1534 .BI (e4defrag,donorname) \fR=\fPstr
1535 File will be used as a block donor (swap extents between files)
1536 .TP
1537 .BI (e4defrag,inplace) \fR=\fPint
1538 Configure donor file block allocation strategy          
1539 .RS
1540 .BI 0(default) :
1541 Preallocate donor's file on init
1542 .TP
1543 .BI 1:
1544 allocate space immediately inside defragment event, and free right after event
1545 .RE
1546 .TP
1547 .BI (rbd)rbdname \fR=\fPstr
1548 Specifies the name of the RBD.
1549 .TP
1550 .BI (rbd)pool \fR=\fPstr
1551 Specifies the name of the Ceph pool containing the RBD.
1552 .TP
1553 .BI (rbd)clientname \fR=\fPstr
1554 Specifies the username (without the 'client.' prefix) used to access the Ceph cluster.
1556 While running, \fBfio\fR will display the status of the created jobs.  For
1557 example:
1558 .RS
1559 .P
1560 Threads: 1: [_r] [24.8% done] [ 13509/  8334 kb/s] [eta 00h:01m:31s]
1561 .RE
1562 .P
1563 The characters in the first set of brackets denote the current status of each
1564 threads.  The possible values are:
1565 .P
1566 .PD 0
1567 .RS
1568 .TP
1569 .B P
1570 Setup but not started.
1571 .TP
1572 .B C
1573 Thread created.
1574 .TP
1575 .B I
1576 Initialized, waiting.
1577 .TP
1578 .B R
1579 Running, doing sequential reads.
1580 .TP
1581 .B r
1582 Running, doing random reads.
1583 .TP
1584 .B W
1585 Running, doing sequential writes.
1586 .TP
1587 .B w
1588 Running, doing random writes.
1589 .TP
1590 .B M
1591 Running, doing mixed sequential reads/writes.
1592 .TP
1593 .B m
1594 Running, doing mixed random reads/writes.
1595 .TP
1596 .B F
1597 Running, currently waiting for \fBfsync\fR\|(2).
1598 .TP
1599 .B V
1600 Running, verifying written data.
1601 .TP
1602 .B E
1603 Exited, not reaped by main thread.
1604 .TP
1605 .B \-
1606 Exited, thread reaped.
1607 .RE
1608 .PD
1609 .P
1610 The second set of brackets shows the estimated completion percentage of
1611 the current group.  The third set shows the read and write I/O rate,
1612 respectively. Finally, the estimated run time of the job is displayed.
1613 .P
1614 When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data
1615 for each thread, each group of threads, and each disk, in that order.
1616 .P
1617 Per-thread statistics first show the threads client number, group-id, and
1618 error code.  The remaining figures are as follows:
1619 .RS
1620 .TP
1621 .B io
1622 Number of megabytes of I/O performed.
1623 .TP
1624 .B bw
1625 Average data rate (bandwidth).
1626 .TP
1627 .B runt
1628 Threads run time.
1629 .TP
1630 .B slat
1631 Submission latency minimum, maximum, average and standard deviation. This is
1632 the time it took to submit the I/O.
1633 .TP
1634 .B clat
1635 Completion latency minimum, maximum, average and standard deviation.  This
1636 is the time between submission and completion.
1637 .TP
1638 .B bw
1639 Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average
1640 and standard deviation.
1641 .TP
1642 .B cpu
1643 CPU usage statistics. Includes user and system time, number of context switches
1644 this thread went through and number of major and minor page faults.
1645 .TP
1646 .B IO depths
1647 Distribution of I/O depths.  Each depth includes everything less than (or equal)
1648 to it, but greater than the previous depth.
1649 .TP
1650 .B IO issued
1651 Number of read/write requests issued, and number of short read/write requests.
1652 .TP
1653 .B IO latencies
1654 Distribution of I/O completion latencies.  The numbers follow the same pattern
1655 as \fBIO depths\fR.
1656 .RE
1657 .P
1658 The group statistics show:
1659 .PD 0
1660 .RS
1661 .TP
1662 .B io
1663 Number of megabytes I/O performed.
1664 .TP
1665 .B aggrb
1666 Aggregate bandwidth of threads in the group.
1667 .TP
1668 .B minb
1669 Minimum average bandwidth a thread saw.
1670 .TP
1671 .B maxb
1672 Maximum average bandwidth a thread saw.
1673 .TP
1674 .B mint
1675 Shortest runtime of threads in the group.
1676 .TP
1677 .B maxt
1678 Longest runtime of threads in the group.
1679 .RE
1680 .PD
1681 .P
1682 Finally, disk statistics are printed with reads first:
1683 .PD 0
1684 .RS
1685 .TP
1686 .B ios
1687 Number of I/Os performed by all groups.
1688 .TP
1689 .B merge
1690 Number of merges in the I/O scheduler.
1691 .TP
1692 .B ticks
1693 Number of ticks we kept the disk busy.
1694 .TP
1695 .B io_queue
1696 Total time spent in the disk queue.
1697 .TP
1698 .B util
1699 Disk utilization.
1700 .RE
1701 .PD
1702 .P
1703 It is also possible to get fio to dump the current output while it is
1704 running, without terminating the job. To do that, send fio the \fBUSR1\fR
1705 signal.
1707 If the \fB\-\-minimal\fR / \fB\-\-append-terse\fR options are given, the
1708 results will be printed/appended in a semicolon-delimited format suitable for
1709 scripted use.
1710 A job description (if provided) follows on a new line.  Note that the first
1711 number in the line is the version number. If the output has to be changed
1712 for some reason, this number will be incremented by 1 to signify that
1713 change.  The fields are:
1714 .P
1715 .RS
1716 .B terse version, fio version, jobname, groupid, error
1717 .P
1718 Read status:
1719 .RS
1720 .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, IOPS, runtime \fR(ms)\fP
1721 .P
1722 Submission latency:
1723 .RS
1724 .B min, max, mean, standard deviation
1725 .RE
1726 Completion latency:
1727 .RS
1728 .B min, max, mean, standard deviation
1729 .RE
1730 Completion latency percentiles (20 fields):
1731 .RS
1732 .B Xth percentile=usec
1733 .RE
1734 Total latency:
1735 .RS
1736 .B min, max, mean, standard deviation
1737 .RE
1738 Bandwidth:
1739 .RS
1740 .B min, max, aggregate percentage of total, mean, standard deviation
1741 .RE
1742 .RE
1743 .P
1744 Write status:
1745 .RS
1746 .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, IOPS, runtime \fR(ms)\fP
1747 .P
1748 Submission latency:
1749 .RS
1750 .B min, max, mean, standard deviation
1751 .RE
1752 Completion latency:
1753 .RS
1754 .B min, max, mean, standard deviation
1755 .RE
1756 Completion latency percentiles (20 fields):
1757 .RS
1758 .B Xth percentile=usec
1759 .RE
1760 Total latency:
1761 .RS
1762 .B min, max, mean, standard deviation
1763 .RE
1764 Bandwidth:
1765 .RS
1766 .B min, max, aggregate percentage of total, mean, standard deviation
1767 .RE
1768 .RE
1769 .P
1770 CPU usage:
1771 .RS
1772 .B user, system, context switches, major page faults, minor page faults
1773 .RE
1774 .P
1775 IO depth distribution:
1776 .RS
1777 .B <=1, 2, 4, 8, 16, 32, >=64
1778 .RE
1779 .P
1780 IO latency distribution:
1781 .RS
1782 Microseconds:
1783 .RS
1784 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
1785 .RE
1786 Milliseconds:
1787 .RS
1788 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000
1789 .RE
1790 .RE
1791 .P
1792 Disk utilization (1 for each disk used):
1793 .RS
1794 .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
1795 .RE
1796 .P
1797 Error Info (dependent on continue_on_error, default off):
1798 .RS
1799 .B total # errors, first error code 
1800 .RE
1801 .P
1802 .B text description (if provided in config - appears on newline)
1803 .RE
1805 Normally you would run fio as a stand-alone application on the machine
1806 where the IO workload should be generated. However, it is also possible to
1807 run the frontend and backend of fio separately. This makes it possible to
1808 have a fio server running on the machine(s) where the IO workload should
1809 be running, while controlling it from another machine.
1811 To start the server, you would do:
1813 \fBfio \-\-server=args\fR
1815 on that machine, where args defines what fio listens to. The arguments
1816 are of the form 'type:hostname or IP:port'. 'type' is either 'ip' (or ip4)
1817 for TCP/IP v4, 'ip6' for TCP/IP v6, or 'sock' for a local unix domain
1818 socket. 'hostname' is either a hostname or IP address, and 'port' is the port to
1819 listen to (only valid for TCP/IP, not a local socket). Some examples:
1821 1) fio \-\-server
1823    Start a fio server, listening on all interfaces on the default port (8765).
1825 2) fio \-\-server=ip:hostname,4444
1827    Start a fio server, listening on IP belonging to hostname and on port 4444.
1829 3) fio \-\-server=ip6:::1,4444
1831    Start a fio server, listening on IPv6 localhost ::1 and on port 4444.
1833 4) fio \-\-server=,4444
1835    Start a fio server, listening on all interfaces on port 4444.
1837 5) fio \-\-server=
1839    Start a fio server, listening on IP on the default port.
1841 6) fio \-\-server=sock:/tmp/fio.sock
1843    Start a fio server, listening on the local socket /tmp/fio.sock.
1845 When a server is running, you can connect to it from a client. The client
1846 is run with:
1848 fio \-\-local-args \-\-client=server \-\-remote-args <job file(s)>
1850 where \-\-local-args are arguments that are local to the client where it is
1851 running, 'server' is the connect string, and \-\-remote-args and <job file(s)>
1852 are sent to the server. The 'server' string follows the same format as it
1853 does on the server side, to allow IP/hostname/socket and port strings.
1854 You can connect to multiple clients as well, to do that you could run:
1856 fio \-\-client=server2 \-\-client=server2 <job file(s)>
1858 If the job file is located on the fio server, then you can tell the server
1859 to load a local file as well. This is done by using \-\-remote-config:
1861 fio \-\-client=server \-\-remote-config /path/to/file.fio
1863 Then the fio serer will open this local (to the server) job file instead
1864 of being passed one from the client.
1867 .B fio
1868 was written by Jens Axboe <jens.axboe@oracle.com>,
1869 now Jens Axboe <jaxboe@fusionio.com>.
1870 .br
1871 This man page was written by Aaron Carroll <aaronc@cse.unsw.edu.au> based
1872 on documentation by Jens Axboe.
1874 Report bugs to the \fBfio\fR mailing list <fio@vger.kernel.org>.
1875 See \fBREADME\fR.
1876 .SH "SEE ALSO"
1877 For further documentation see \fBHOWTO\fR and \fBREADME\fR.
1878 .br
1879 Sample jobfiles are available in the \fBexamples\fR directory.