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