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