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