Fix inconsistencies in with man page <param>=<value>
[fio.git] / fio.1
1 .TH fio 1 "September 2007" "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 \-\-output \fR=\fPfilename
16 Write output to \fIfilename\fR.
17 .TP
18 .BI \-\-timeout \fR=\fPtimeout
19 Limit run time to \fItimeout\fR seconds.
20 .TP
21 .B \-\-latency\-log
22 Generate per-job latency logs.
23 .TP
24 .B \-\-bandwidth\-log
25 Generate per-job bandwidth logs.
26 .TP
27 .B \-\-minimal
28 Print statistics in a terse, semicolon-delimited format.
29 .TP
30 .BI \-\-showcmd \fR=\fPjobfile
31 Convert \fIjobfile\fR to a set of command-line options.
32 .TP
33 .B \-\-readonly
34 Enable read-only safety checks.
35 .TP
36 .BI \-\-eta \fR=\fPwhen
37 Specifies when real-time ETA estimate should be printed.  \fIwhen\fR may
38 be one of `always', `never' or `auto'.
39 .TP
40 .BI \-\-section \fR=\fPsec
41 Only run section \fIsec\fR from job file.
42 .TP
43 .BI \-\-cmdhelp \fR=\fPcommand
44 Print help information for \fIcommand\fR.  May be `all' for all commands.
45 .TP
46 .BI \-\-debug \fR=\fPtype
47 Enable verbose tracing of various fio actions. May be `all' for all types
48 or individual types separated by a comma (eg \-\-debug=io,file). `help' will
49 list all available tracing options.
50 .TP
51 .B \-\-help
52 Display usage information and exit.
53 .TP
54 .B \-\-version
55 Display version information and exit.
56 .TP
57 .B \-\-terse\-version\fR=\fPtype
58 Terse version output format
60 Job files are in `ini' format. They consist of one or more
61 job definitions, which begin with a job name in square brackets and
62 extend to the next job name.  The job name can be any ASCII string
63 except `global', which has a special meaning.  Following the job name is
64 a sequence of zero or more parameters, one per line, that define the
65 behavior of the job.  Any line starting with a `;' or `#' character is
66 considered a comment and ignored.
67 .P
68 If \fIjobfile\fR is specified as `-', the job file will be read from
69 standard input.
70 .SS "Global Section"
71 The global section contains default parameters for jobs specified in the
72 job file.  A job is only affected by global sections residing above it,
73 and there may be any number of global sections.  Specific job definitions
74 may override any parameter set in global sections.
76 .SS Types
77 Some parameters may take arguments of a specific type.  The types used are:
78 .TP
79 .I str
80 String: a sequence of alphanumeric characters.
81 .TP
82 .I int
83 SI integer: a whole number, possibly containing a suffix denoting the base unit
84 of the value.  Accepted suffixes are `k', 'M', 'G', 'T', and 'P', denoting
85 kilo (1024), mega (1024^2), giga (1024^3), tera (1024^4), and peta (1024^5)
86 respectively. The suffix is not case sensitive. If prefixed with '0x', the
87 value is assumed to be base 16 (hexadecimal). A suffix may include a trailing 'b',
88 for instance 'kb' is identical to 'k'. You can specify a base 10 value
89 by using 'KiB', 'MiB', 'GiB', etc. This is useful for disk drives where
90 values are often given in base 10 values. Specifying '30GiB' will get you
91 30*1000^3 bytes.
92 .TP
93 .I bool
94 Boolean: a true or false value. `0' denotes false, `1' denotes true.
95 .TP
96 .I irange
97 Integer range: a range of integers specified in the format
98 \fIlower\fR:\fIupper\fR or \fIlower\fR\-\fIupper\fR. \fIlower\fR and
99 \fIupper\fR may contain a suffix as described above.  If an option allows two
100 sets of ranges, they are separated with a `,' or `/' character. For example:
101 `8\-8k/8M\-4G'.
102 .TP
103 .I float_list
104 List of floating numbers: A list of floating numbers, separated by
105 a ':' charcater.
106 .SS "Parameter List"
107 .TP
108 .BI name \fR=\fPstr
109 May be used to override the job name.  On the command line, this parameter
110 has the special purpose of signalling the start of a new job.
111 .TP
112 .BI description \fR=\fPstr
113 Human-readable description of the job. It is printed when the job is run, but
114 otherwise has no special purpose.
115 .TP
116 .BI directory \fR=\fPstr
117 Prefix filenames with this directory.  Used to place files in a location other
118 than `./'.
119 .TP
120 .BI filename \fR=\fPstr
121 .B fio
122 normally makes up a file name based on the job name, thread number, and file
123 number. If you want to share files between threads in a job or several jobs,
124 specify a \fIfilename\fR for each of them to override the default. If the I/O
125 engine used is `net', \fIfilename\fR is the host and port to connect to in the
126 format \fIhost\fR/\fIport\fR. If the I/O engine is file-based, you can specify
127 a number of files by separating the names with a `:' character. `\-' is a
128 reserved name, meaning stdin or stdout, depending on the read/write direction
129 set.
130 .TP
131 .BI lockfile \fR=\fPstr
132 Fio defaults to not locking any files before it does IO to them. If a file or
133 file descriptor is shared, fio can serialize IO to that file to make the end
134 result consistent. This is usual for emulating real workloads that share files.
135 The lock modes are:
136 .RS
137 .RS
138 .TP
139 .B none
140 No locking. This is the default.
141 .TP
142 .B exclusive
143 Only one thread or process may do IO at the time, excluding all others.
144 .TP
145 .B readwrite
146 Read-write locking on the file. Many readers may access the file at the same
147 time, but writes get exclusive access.
148 .RE
149 .P
150 The option may be post-fixed with a lock batch number. If set, then each
151 thread/process may do that amount of IOs to the file before giving up the lock.
152 Since lock acquisition is expensive, batching the lock/unlocks will speed up IO.
153 .RE
154 .P
155 .BI opendir \fR=\fPstr
156 Recursively open any files below directory \fIstr\fR.
157 .TP
158 .BI readwrite \fR=\fPstr "\fR,\fP rw" \fR=\fPstr
159 Type of I/O pattern.  Accepted values are:
160 .RS
161 .RS
162 .TP
163 .B read
164 Sequential reads.
165 .TP
166 .B write
167 Sequential writes.
168 .TP
169 .B randread
170 Random reads.
171 .TP
172 .B randwrite
173 Random writes.
174 .TP
175 .B rw
176 Mixed sequential reads and writes.
177 .TP
178 .B randrw 
179 Mixed random reads and writes.
180 .RE
181 .P
182 For mixed I/O, the default split is 50/50. For certain types of io the result
183 may still be skewed a bit, since the speed may be different. It is possible to
184 specify a number of IO's to do before getting a new offset, this is one by
185 appending a `:\fI<nr>\fR to the end of the string given. For a random read, it
186 would look like \fBrw=randread:8\fR for passing in an offset modifier with a
187 value of 8. If the postfix is used with a sequential IO pattern, then the value
188 specified will be added to the generated offset for each IO. For instance,
189 using \fBrw=write:4k\fR will skip 4k for every write. It turns sequential IO
190 into sequential IO with holes. See the \fBrw_sequencer\fR option.
191 .RE
192 .TP
193 .BI rw_sequencer \fR=\fPstr
194 If an offset modifier is given by appending a number to the \fBrw=<str>\fR line,
195 then this option controls how that number modifies the IO offset being
196 generated. Accepted values are:
197 .RS
198 .RS
199 .TP
200 .B sequential
201 Generate sequential offset
202 .TP
203 .B identical
204 Generate the same offset
205 .RE
206 .P
207 \fBsequential\fR is only useful for random IO, where fio would normally
208 generate a new random offset for every IO. If you append eg 8 to randread, you
209 would get a new random offset for every 8 IO's. The result would be a seek for
210 only every 8 IO's, instead of for every IO. Use \fBrw=randread:8\fR to specify
211 that. As sequential IO is already sequential, setting \fBsequential\fR for that
212 would not result in any differences.  \fBidentical\fR behaves in a similar
213 fashion, except it sends the same offset 8 number of times before generating a
214 new offset.
215 .RE
216 .P
217 .TP
218 .BI kb_base \fR=\fPint
219 The base unit for a kilobyte. The defacto base is 2^10, 1024.  Storage
220 manufacturers like to use 10^3 or 1000 as a base ten unit instead, for obvious
221 reasons. Allow values are 1024 or 1000, with 1024 being the default.
222 .TP
223 .BI randrepeat \fR=\fPbool
224 Seed the random number generator in a predictable way so results are repeatable
225 across runs.  Default: true.
226 .TP
227 .BI use_os_rand \fR=\fPbool
228 Fio can either use the random generator supplied by the OS to generator random
229 offsets, or it can use it's own internal generator (based on Tausworthe).
230 Default is to use the internal generator, which is often of better quality and
231 faster. Default: false.
232 .TP
233 .BI fallocate \fR=\fPstr
234 Whether pre-allocation is performed when laying down files. Accepted values
235 are:
236 .RS
237 .RS
238 .TP
239 .B none
240 Do not pre-allocate space.
241 .TP
242 .B posix
243 Pre-allocate via posix_fallocate().
244 .TP
245 .B keep
246 Pre-allocate via fallocate() with FALLOC_FL_KEEP_SIZE set.
247 .TP
248 .B 0
249 Backward-compatible alias for 'none'.
250 .TP
251 .B 1
252 Backward-compatible alias for 'posix'.
253 .RE
254 .P
255 May not be available on all supported platforms. 'keep' is only
256 available on Linux. If using ZFS on Solaris this must be set to 'none'
257 because ZFS doesn't support it. Default: 'posix'.
258 .RE
259 .TP
260 .BI fadvise_hint \fR=\fPbool
261 Disable use of \fIposix_fadvise\fR\|(2) to advise the kernel what I/O patterns
262 are likely to be issued. Default: true.
263 .TP
264 .BI size \fR=\fPint
265 Total size of I/O for this job.  \fBfio\fR will run until this many bytes have
266 been transfered, unless limited by other options (\fBruntime\fR, for instance).
267 Unless \fBnrfiles\fR and \fBfilesize\fR options are given, this amount will be
268 divided between the available files for the job. If not set, fio will use the
269 full size of the given files or devices. If the the files do not exist, size
270 must be given. It is also possible to give size as a percentage between 1 and
271 100. If size=20% is given, fio will use 20% of the full size of the given files
272 or devices.
273 .TP
274 .BI fill_device \fR=\fPbool "\fR,\fB fill_fs" \fR=\fPbool
275 Sets size to something really large and waits for ENOSPC (no space left on
276 device) as the terminating condition. Only makes sense with sequential write.
277 For a read workload, the mount point will be filled first then IO started on
278 the result. This option doesn't make sense if operating on a raw device node,
279 since the size of that is already known by the file system. Additionally,
280 writing beyond end-of-device will not return ENOSPC there.
281 .TP
282 .BI filesize \fR=\fPirange
283 Individual file sizes. May be a range, in which case \fBfio\fR will select sizes
284 for files at random within the given range, limited to \fBsize\fR in total (if
285 that is given). If \fBfilesize\fR is not specified, each created file is the
286 same size.
287 .TP
288 .BI blocksize \fR=\fPint[,int] "\fR,\fB bs" \fR=\fPint[,int]
289 Block size for I/O units.  Default: 4k.  Values for reads and writes can be
290 specified separately in the format \fIread\fR,\fIwrite\fR, either of
291 which may be empty to leave that value at its default.
292 .TP
293 .BI blocksize_range \fR=\fPirange[,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange]
294 Specify a range of I/O block sizes.  The issued I/O unit will always be a
295 multiple of the minimum size, unless \fBblocksize_unaligned\fR is set.  Applies
296 to both reads and writes if only one range is given, but can be specified
297 separately with a comma seperating the values. Example: bsrange=1k-4k,2k-8k.
298 Also (see \fBblocksize\fR).
299 .TP
300 .BI bssplit \fR=\fPstr
301 This option allows even finer grained control of the block sizes issued,
302 not just even splits between them. With this option, you can weight various
303 block sizes for exact control of the issued IO for a job that has mixed
304 block sizes. The format of the option is bssplit=blocksize/percentage,
305 optionally adding as many definitions as needed separated by a colon.
306 Example: bssplit=4k/10:64k/50:32k/40 would issue 50% 64k blocks, 10% 4k
307 blocks and 40% 32k blocks. \fBbssplit\fR also supports giving separate
308 splits to reads and writes. The format is identical to what the
309 \fBbs\fR option accepts, the read and write parts are separated with a
310 comma.
311 .TP
312 .B blocksize_unaligned\fR,\fP bs_unaligned
313 If set, any size in \fBblocksize_range\fR may be used.  This typically won't
314 work with direct I/O, as that normally requires sector alignment.
315 .TP
316 .BI blockalign \fR=\fPint[,int] "\fR,\fB ba" \fR=\fPint[,int]
317 At what boundary to align random IO offsets. Defaults to the same as 'blocksize'
318 the minimum blocksize given.  Minimum alignment is typically 512b
319 for using direct IO, though it usually depends on the hardware block size.
320 This option is mutually exclusive with using a random map for files, so it
321 will turn off that option.
322 .TP
323 .B zero_buffers
324 Initialise buffers with all zeros. Default: fill buffers with random data.
325 .TP
326 .B refill_buffers
327 If this option is given, fio will refill the IO buffers on every submit. The
328 default is to only fill it at init time and reuse that data. Only makes sense
329 if zero_buffers isn't specified, naturally. If data verification is enabled,
330 refill_buffers is also automatically enabled.
331 .TP
332 .BI nrfiles \fR=\fPint
333 Number of files to use for this job.  Default: 1.
334 .TP
335 .BI openfiles \fR=\fPint
336 Number of files to keep open at the same time.  Default: \fBnrfiles\fR.
337 .TP
338 .BI file_service_type \fR=\fPstr
339 Defines how files to service are selected.  The following types are defined:
340 .RS
341 .RS
342 .TP
343 .B random
344 Choose a file at random
345 .TP
346 .B roundrobin
347 Round robin over open files (default).
348 .B sequential
349 Do each file in the set sequentially.
350 .RE
351 .P
352 The number of I/Os to issue before switching a new file can be specified by
353 appending `:\fIint\fR' to the service type.
354 .RE
355 .TP
356 .BI ioengine \fR=\fPstr
357 Defines how the job issues I/O.  The following types are defined:
358 .RS
359 .RS
360 .TP
361 .B sync
362 Basic \fIread\fR\|(2) or \fIwrite\fR\|(2) I/O.  \fIfseek\fR\|(2) is used to
363 position the I/O location.
364 .TP
365 .B psync
366 Basic \fIpread\fR\|(2) or \fIpwrite\fR\|(2) I/O.
367 .TP
368 .B vsync
369 Basic \fIreadv\fR\|(2) or \fIwritev\fR\|(2) I/O. Will emulate queuing by
370 coalescing adjacents IOs into a single submission.
371 .TP
372 .B libaio
373 Linux native asynchronous I/O.  This engine also has a sub-option,
374 \fBuserspace_reap\fR. To set it, use \fBioengine=libaio:userspace_reap\fR.
375 Normally, with the libaio engine in use, fio will use the
376 \fIio_getevents\fR\|(3) system call to reap newly returned events. With this
377 flag turned on, the AIO ring will be read directly from user-space to reap
378 events. The reaping mode is only enabled when polling for a minimum of \fB0\fR
379 events (eg when \fBiodepth_batch_complete=0\fR).
380 .TP
381 .B posixaio
382 POSIX asynchronous I/O using \fIaio_read\fR\|(3) and \fIaio_write\fR\|(3).
383 .TP
384 .B solarisaio
385 Solaris native asynchronous I/O.
386 .TP
387 .B windowsaio
388 Windows native asynchronous I/O.
389 .TP
390 .B mmap
391 File is memory mapped with \fImmap\fR\|(2) and data copied using
392 \fImemcpy\fR\|(3).
393 .TP
394 .B splice
395 \fIsplice\fR\|(2) is used to transfer the data and \fIvmsplice\fR\|(2) to
396 transfer data from user-space to the kernel.
397 .TP
398 .B syslet-rw
399 Use the syslet system calls to make regular read/write asynchronous.
400 .TP
401 .B sg
402 SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if
403 the target is an sg character device, we use \fIread\fR\|(2) and
404 \fIwrite\fR\|(2) for asynchronous I/O.
405 .TP
406 .B null
407 Doesn't transfer any data, just pretends to.  Mainly used to exercise \fBfio\fR
408 itself and for debugging and testing purposes.
409 .TP
410 .B net
411 Transfer over the network.  \fBfilename\fR must be set appropriately to
412 `\fIhost\fR/\fIport\fR' regardless of data direction.  If receiving, only the
413 \fIport\fR argument is used.
414 .TP
415 .B netsplice
416 Like \fBnet\fR, but uses \fIsplice\fR\|(2) and \fIvmsplice\fR\|(2) to map data
417 and send/receive.
418 .TP
419 .B cpuio
420 Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and
421 \fBcpucycles\fR parameters.
422 .TP
423 .B guasi
424 The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface
425 approach to asycnronous I/O.
426 .br
427 See <\-lib.html>.
428 .TP
429 .B rdma
430 The RDMA I/O engine supports both RDMA memory semantics (RDMA_WRITE/RDMA_READ)
431 and channel semantics (Send/Recv) for the InfiniBand, RoCE and iWARP protocols.
432 .TP
433 .B external
434 Loads an external I/O engine object file.  Append the engine filename as
435 `:\fIenginepath\fR'.
436 .RE
437 .RE
438 .TP
439 .BI iodepth \fR=\fPint
440 Number of I/O units to keep in flight against the file. Note that increasing
441 iodepth beyond 1 will not affect synchronous ioengines (except for small
442 degress when verify_async is in use). Even async engines my impose OS
443 restrictions causing the desired depth not to be achieved.  This may happen on
444 Linux when using libaio and not setting \fBdirect\fR=1, since buffered IO is
445 not async on that OS. Keep an eye on the IO depth distribution in the
446 fio output to verify that the achieved depth is as expected. Default: 1.
447 .TP
448 .BI iodepth_batch \fR=\fPint
449 Number of I/Os to submit at once.  Default: \fBiodepth\fR.
450 .TP
451 .BI iodepth_batch_complete \fR=\fPint
452 This defines how many pieces of IO to retrieve at once. It defaults to 1 which
453  means that we'll ask for a minimum of 1 IO in the retrieval process from the
454 kernel. The IO retrieval will go on until we hit the limit set by
455 \fBiodepth_low\fR. If this variable is set to 0, then fio will always check for
456 completed events before queuing more IO. This helps reduce IO latency, at the
457 cost of more retrieval system calls.
458 .TP
459 .BI iodepth_low \fR=\fPint
460 Low watermark indicating when to start filling the queue again.  Default:
461 \fBiodepth\fR. 
462 .TP
463 .BI direct \fR=\fPbool
464 If true, use non-buffered I/O (usually O_DIRECT).  Default: false.
465 .TP
466 .BI buffered \fR=\fPbool
467 If true, use buffered I/O.  This is the opposite of the \fBdirect\fR parameter.
468 Default: true.
469 .TP
470 .BI offset \fR=\fPint
471 Offset in the file to start I/O. Data before the offset will not be touched.
472 .TP
473 .BI fsync \fR=\fPint
474 How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data.  If
475 0, don't sync.  Default: 0.
476 .TP
477 .BI fdatasync \fR=\fPint
478 Like \fBfsync\fR, but uses \fBfdatasync\fR\|(2) instead to only sync the
479 data parts of the file. Default: 0.
480 .TP
481 .BI sync_file_range \fR=\fPstr:int
482 Use sync_file_range() for every \fRval\fP number of write operations. Fio will
483 track range of writes that have happened since the last sync_file_range() call.
484 \fRstr\fP can currently be one or more of:
485 .RS
486 .TP
487 .B wait_before
489 .TP
490 .B write
492 .TP
493 .B wait_after
495 .TP
496 .RE
497 .P
498 So if you do sync_file_range=wait_before,write:8, fio would use
500 Also see the sync_file_range(2) man page.  This option is Linux specific.
501 .TP
502 .BI overwrite \fR=\fPbool
503 If writing, setup the file first and do overwrites.  Default: false.
504 .TP
505 .BI end_fsync \fR=\fPbool
506 Sync file contents when job exits.  Default: false.
507 .TP
508 .BI fsync_on_close \fR=\fPbool
509 If true, sync file contents on close.  This differs from \fBend_fsync\fR in that
510 it will happen on every close, not just at the end of the job.  Default: false.
511 .TP
512 .BI rwmixcycle \fR=\fPint
513 How many milliseconds before switching between reads and writes for a mixed
514 workload. Default: 500ms.
515 .TP
516 .BI rwmixread \fR=\fPint
517 Percentage of a mixed workload that should be reads. Default: 50.
518 .TP
519 .BI rwmixwrite \fR=\fPint
520 Percentage of a mixed workload that should be writes.  If \fBrwmixread\fR and
521 \fBrwmixwrite\fR are given and do not sum to 100%, the latter of the two
522 overrides the first. This may interfere with a given rate setting, if fio is
523 asked to limit reads or writes to a certain rate. If that is the case, then
524 the distribution may be skewed. Default: 50.
525 .TP
526 .B norandommap
527 Normally \fBfio\fR will cover every block of the file when doing random I/O. If
528 this parameter is given, a new offset will be chosen without looking at past
529 I/O history.  This parameter is mutually exclusive with \fBverify\fR.
530 .TP
531 .BI softrandommap \fR=\fPbool
532 See \fBnorandommap\fR. If fio runs with the random block map enabled and it
533 fails to allocate the map, if this option is set it will continue without a
534 random block map. As coverage will not be as complete as with random maps, this
535 option is disabled by default.
536 .TP
537 .BI nice \fR=\fPint
538 Run job with given nice value.  See \fInice\fR\|(2).
539 .TP
540 .BI prio \fR=\fPint
541 Set I/O priority value of this job between 0 (highest) and 7 (lowest).  See
542 \fIionice\fR\|(1).
543 .TP
544 .BI prioclass \fR=\fPint
545 Set I/O priority class.  See \fIionice\fR\|(1).
546 .TP
547 .BI thinktime \fR=\fPint
548 Stall job for given number of microseconds between issuing I/Os.
549 .TP
550 .BI thinktime_spin \fR=\fPint
551 Pretend to spend CPU time for given number of microseconds, sleeping the rest
552 of the time specified by \fBthinktime\fR.  Only valid if \fBthinktime\fR is set.
553 .TP
554 .BI thinktime_blocks \fR=\fPint
555 Number of blocks to issue before waiting \fBthinktime\fR microseconds.
556 Default: 1.
557 .TP
558 .BI rate \fR=\fPint
559 Cap bandwidth used by this job. The number is in bytes/sec, the normal postfix
560 rules apply. You can use \fBrate\fR=500k to limit reads and writes to 500k each,
561 or you can specify read and writes separately. Using \fBrate\fR=1m,500k would
562 limit reads to 1MB/sec and writes to 500KB/sec. Capping only reads or writes
563 can be done with \fBrate\fR=,500k or \fBrate\fR=500k,. The former will only
564 limit writes (to 500KB/sec), the latter will only limit reads.
565 .TP
566 .BI ratemin \fR=\fPint
567 Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth.
568 Failing to meet this requirement will cause the job to exit. The same format
569 as \fBrate\fR is used for read vs write separation.
570 .TP
571 .BI rate_iops \fR=\fPint
572 Cap the bandwidth to this number of IOPS. Basically the same as rate, just
573 specified independently of bandwidth. The same format as \fBrate\fR is used for
574 read vs write seperation. If \fBblocksize\fR is a range, the smallest block
575 size is used as the metric.
576 .TP
577 .BI rate_iops_min \fR=\fPint
578 If this rate of I/O is not met, the job will exit. The same format as \fBrate\fR
579 is used for read vs write seperation.
580 .TP
581 .BI ratecycle \fR=\fPint
582 Average bandwidth for \fBrate\fR and \fBratemin\fR over this number of
583 milliseconds.  Default: 1000ms.
584 .TP
585 .BI cpumask \fR=\fPint
586 Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job
587 may run on.  See \fBsched_setaffinity\fR\|(2).
588 .TP
589 .BI cpus_allowed \fR=\fPstr
590 Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers.
591 .TP
592 .BI startdelay \fR=\fPint
593 Delay start of job for the specified number of seconds.
594 .TP
595 .BI runtime \fR=\fPint
596 Terminate processing after the specified number of seconds.
597 .TP
598 .B time_based
599 If given, run for the specified \fBruntime\fR duration even if the files are
600 completely read or written. The same workload will be repeated as many times
601 as \fBruntime\fR allows.
602 .TP
603 .BI ramp_time \fR=\fPint
604 If set, fio will run the specified workload for this amount of time before
605 logging any performance numbers. Useful for letting performance settle before
606 logging results, thus minimizing the runtime required for stable results. Note
607 that the \fBramp_time\fR is considered lead in time for a job, thus it will
608 increase the total runtime if a special timeout or runtime is specified.
609 .TP
610 .BI invalidate \fR=\fPbool
611 Invalidate buffer-cache for the file prior to starting I/O.  Default: true.
612 .TP
613 .BI sync \fR=\fPbool
614 Use synchronous I/O for buffered writes.  For the majority of I/O engines,
615 this means using O_SYNC.  Default: false.
616 .TP
617 .BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr
618 Allocation method for I/O unit buffer.  Allowed values are:
619 .RS
620 .RS
621 .TP
622 .B malloc
623 Allocate memory with \fImalloc\fR\|(3).
624 .TP
625 .B shm
626 Use shared memory buffers allocated through \fIshmget\fR\|(2).
627 .TP
628 .B shmhuge
629 Same as \fBshm\fR, but use huge pages as backing.
630 .TP
631 .B mmap
632 Use \fImmap\fR\|(2) for allocation.  Uses anonymous memory unless a filename
633 is given after the option in the format `:\fIfile\fR'.
634 .TP
635 .B mmaphuge
636 Same as \fBmmap\fR, but use huge files as backing.
637 .RE
638 .P
639 The amount of memory allocated is the maximum allowed \fBblocksize\fR for the
640 job multiplied by \fBiodepth\fR.  For \fBshmhuge\fR or \fBmmaphuge\fR to work,
641 the system must have free huge pages allocated.  \fBmmaphuge\fR also needs to
642 have hugetlbfs mounted, and \fIfile\fR must point there. At least on Linux,
643 huge pages must be manually allocated. See \fB/proc/sys/vm/nr_hugehages\fR
644 and the documentation for that. Normally you just need to echo an appropriate
645 number, eg echoing 8 will ensure that the OS has 8 huge pages ready for
646 use.
647 .RE
648 .TP
649 .BI iomem_align \fR=\fPint "\fR,\fP mem_align" \fR=\fPint
650 This indiciates the memory alignment of the IO memory buffers. Note that the
651 given alignment is applied to the first IO unit buffer, if using \fBiodepth\fR
652 the alignment of the following buffers are given by the \fBbs\fR used. In
653 other words, if using a \fBbs\fR that is a multiple of the page sized in the
654 system, all buffers will be aligned to this value. If using a \fBbs\fR that
655 is not page aligned, the alignment of subsequent IO memory buffers is the
656 sum of the \fBiomem_align\fR and \fBbs\fR used.
657 .TP
658 .BI hugepage\-size \fR=\fPint
659 Defines the size of a huge page.  Must be at least equal to the system setting.
660 Should be a multiple of 1MB. Default: 4MB.
661 .TP
662 .B exitall
663 Terminate all jobs when one finishes.  Default: wait for each job to finish.
664 .TP
665 .BI bwavgtime \fR=\fPint
666 Average bandwidth calculations over the given time in milliseconds.  Default:
667 500ms.
668 .TP
669 .BI create_serialize \fR=\fPbool
670 If true, serialize file creation for the jobs.  Default: true.
671 .TP
672 .BI create_fsync \fR=\fPbool
673 \fIfsync\fR\|(2) data file after creation.  Default: true.
674 .TP
675 .BI create_on_open \fR=\fPbool
676 If true, the files are not created until they are opened for IO by the job.
677 .TP
678 .BI pre_read \fR=\fPbool
679 If this is given, files will be pre-read into memory before starting the given
680 IO operation. This will also clear the \fR \fBinvalidate\fR flag, since it is
681 pointless to pre-read and then drop the cache. This will only work for IO
682 engines that are seekable, since they allow you to read the same data
683 multiple times. Thus it will not work on eg network or splice IO.
684 .TP
685 .BI unlink \fR=\fPbool
686 Unlink job files when done.  Default: false.
687 .TP
688 .BI loops \fR=\fPint
689 Specifies the number of iterations (runs of the same workload) of this job.
690 Default: 1.
691 .TP
692 .BI do_verify \fR=\fPbool
693 Run the verify phase after a write phase.  Only valid if \fBverify\fR is set.
694 Default: true.
695 .TP
696 .BI verify \fR=\fPstr
697 Method of verifying file contents after each iteration of the job.  Allowed
698 values are:
699 .RS
700 .RS
701 .TP
702 .B md5 crc16 crc32 crc32c crc32c-intel crc64 crc7 sha256 sha512 sha1
703 Store appropriate checksum in the header of each block. crc32c-intel is
704 hardware accelerated SSE4.2 driven, falls back to regular crc32c if
705 not supported by the system.
706 .TP
707 .B meta
708 Write extra information about each I/O (timestamp, block number, etc.). The
709 block number is verified. See \fBverify_pattern\fR as well.
710 .TP
711 .B null
712 Pretend to verify.  Used for testing internals.
713 .RE
715 This option can be used for repeated burn-in tests of a system to make sure
716 that the written data is also correctly read back. If the data direction given
717 is a read or random read, fio will assume that it should verify a previously
718 written file. If the data direction includes any form of write, the verify will
719 be of the newly written data.
720 .RE
721 .TP
722 .BI verify_sort \fR=\fPbool
723 If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to
724 read them back in a sorted manner.  Default: true.
725 .TP
726 .BI verify_offset \fR=\fPint
727 Swap the verification header with data somewhere else in the block before
728 writing.  It is swapped back before verifying.
729 .TP
730 .BI verify_interval \fR=\fPint
731 Write the verification header for this number of bytes, which should divide
732 \fBblocksize\fR.  Default: \fBblocksize\fR.
733 .TP
734 .BI verify_pattern \fR=\fPstr
735 If set, fio will fill the io buffers with this pattern. Fio defaults to filling
736 with totally random bytes, but sometimes it's interesting to fill with a known
737 pattern for io verification purposes. Depending on the width of the pattern,
738 fio will fill 1/2/3/4 bytes of the buffer at the time(it can be either a
739 decimal or a hex number). The verify_pattern if larger than a 32-bit quantity
740 has to be a hex number that starts with either "0x" or "0X". Use with
741 \fBverify\fP=meta.
742 .TP
743 .BI verify_fatal \fR=\fPbool
744 If true, exit the job on the first observed verification failure.  Default:
745 false.
746 .TP
747 .BI verify_dump \fR=\fPbool
748 If set, dump the contents of both the original data block and the data block we
749 read off disk to files. This allows later analysis to inspect just what kind of
750 data corruption occurred. On by default.
751 .TP
752 .BI verify_async \fR=\fPint
753 Fio will normally verify IO inline from the submitting thread. This option
754 takes an integer describing how many async offload threads to create for IO
755 verification instead, causing fio to offload the duty of verifying IO contents
756 to one or more separate threads.  If using this offload option, even sync IO
757 engines can benefit from using an \fBiodepth\fR setting higher than 1, as it
758 allows them to have IO in flight while verifies are running.
759 .TP
760 .BI verify_async_cpus \fR=\fPstr
761 Tell fio to set the given CPU affinity on the async IO verification threads.
762 See \fBcpus_allowed\fP for the format used.
763 .TP
764 .BI verify_backlog \fR=\fPint
765 Fio will normally verify the written contents of a job that utilizes verify
766 once that job has completed. In other words, everything is written then
767 everything is read back and verified. You may want to verify continually
768 instead for a variety of reasons. Fio stores the meta data associated with an
769 IO block in memory, so for large verify workloads, quite a bit of memory would
770 be used up holding this meta data. If this option is enabled, fio will write
771 only N blocks before verifying these blocks.
772 .TP
773 .BI verify_backlog_batch \fR=\fPint
774 Control how many blocks fio will verify if verify_backlog is set. If not set,
775 will default to the value of \fBverify_backlog\fR (meaning the entire queue is
776 read back and verified).  If \fBverify_backlog_batch\fR is less than 
777 \fBverify_backlog\fR then not all blocks will be verified,  if 
778 \fBverify_backlog_batch\fR is larger than \fBverify_backlog\fR,  some blocks
779 will be verified more than once.
780 .TP
781 .B stonewall "\fR,\fP wait_for_previous"
782 Wait for preceding jobs in the job file to exit before starting this one.
783 \fBstonewall\fR implies \fBnew_group\fR.
784 .TP
785 .B new_group
786 Start a new reporting group.  If not given, all jobs in a file will be part
787 of the same reporting group, unless separated by a stonewall.
788 .TP
789 .BI numjobs \fR=\fPint
790 Number of clones (processes/threads performing the same workload) of this job.  
791 Default: 1.
792 .TP
793 .B group_reporting
794 If set, display per-group reports instead of per-job when \fBnumjobs\fR is
795 specified.
796 .TP
797 .B thread
798 Use threads created with \fBpthread_create\fR\|(3) instead of processes created
799 with \fBfork\fR\|(2).
800 .TP
801 .BI zonesize \fR=\fPint
802 Divide file into zones of the specified size in bytes.  See \fBzoneskip\fR.
803 .TP
804 .BI zoneskip \fR=\fPint
805 Skip the specified number of bytes when \fBzonesize\fR bytes of data have been
806 read.
807 .TP
808 .BI write_iolog \fR=\fPstr
809 Write the issued I/O patterns to the specified file.  Specify a separate file
810 for each job, otherwise the iologs will be interspersed and the file may be
811 corrupt.
812 .TP
813 .BI read_iolog \fR=\fPstr
814 Replay the I/O patterns contained in the specified file generated by
815 \fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file.
816 .TP
817 .BI replay_no_stall \fR=\fPint
818 While replaying I/O patterns using \fBread_iolog\fR the default behavior
819 attempts to respect timing information between I/Os.  Enabling
820 \fBreplay_no_stall\fR causes I/Os to be replayed as fast as possible while
821 still respecting ordering.
822 .TP
823 .BI replay_redirect \fR=\fPstr
824 While replaying I/O patterns using \fBread_iolog\fR the default behavior
825 is to replay the IOPS onto the major/minor device that each IOP was recorded
826 from.  Setting \fBreplay_redirect\fR causes all IOPS to be replayed onto the
827 single specified device regardless of the device it was recorded from.
828 .TP
829 .BI write_bw_log \fR=\fPstr
830 If given, write a bandwidth log of the jobs in this job file. Can be used to
831 store data of the bandwidth of the jobs in their lifetime. The included
832 fio_generate_plots script uses gnuplot to turn these text files into nice
833 graphs. See \fBwrite_log_log\fR for behaviour of given filename. For this
834 option, the postfix is _bw.log.
835 .TP
836 .BI write_lat_log \fR=\fPstr
837 Same as \fBwrite_bw_log\fR, but writes I/O completion latencies.  If no
838 filename is given with this option, the default filename of "jobname_type.log"
839 is used. Even if the filename is given, fio will still append the type of log.
840 .TP
841 .BI disable_lat \fR=\fPbool
842 Disable measurements of total latency numbers. Useful only for cutting
843 back the number of calls to gettimeofday, as that does impact performance at
844 really high IOPS rates.  Note that to really get rid of a large amount of these
845 calls, this option must be used with disable_slat and disable_bw as well.
846 .TP
847 .BI disable_clat \fR=\fPbool
848 Disable measurements of completion latency numbers. See \fBdisable_lat\fR.
849 .TP
850 .BI disable_slat \fR=\fPbool
851 Disable measurements of submission latency numbers. See \fBdisable_lat\fR.
852 .TP
853 .BI disable_bw_measurement \fR=\fPbool
854 Disable measurements of throughput/bandwidth numbers. See \fBdisable_lat\fR.
855 .TP
856 .BI lockmem \fR=\fPint
857 Pin the specified amount of memory with \fBmlock\fR\|(2).  Can be used to
858 simulate a smaller amount of memory.
859 .TP
860 .BI exec_prerun \fR=\fPstr
861 Before running the job, execute the specified command with \fBsystem\fR\|(3).
862 .TP
863 .BI exec_postrun \fR=\fPstr
864 Same as \fBexec_prerun\fR, but the command is executed after the job completes.
865 .TP
866 .BI ioscheduler \fR=\fPstr
867 Attempt to switch the device hosting the file to the specified I/O scheduler.
868 .TP
869 .BI cpuload \fR=\fPint
870 If the job is a CPU cycle-eater, attempt to use the specified percentage of
871 CPU cycles.
872 .TP
873 .BI cpuchunks \fR=\fPint
874 If the job is a CPU cycle-eater, split the load into cycles of the
875 given time in milliseconds.
876 .TP
877 .BI disk_util \fR=\fPbool
878 Generate disk utilization statistics if the platform supports it. Default: true.
879 .TP
880 .BI gtod_reduce \fR=\fPbool
881 Enable all of the gettimeofday() reducing options (disable_clat, disable_slat,
882 disable_bw) plus reduce precision of the timeout somewhat to really shrink the
883 gettimeofday() call count. With this option enabled, we only do about 0.4% of
884 the gtod() calls we would have done if all time keeping was enabled.
885 .TP
886 .BI gtod_cpu \fR=\fPint
887 Sometimes it's cheaper to dedicate a single thread of execution to just getting
888 the current time. Fio (and databases, for instance) are very intensive on
889 gettimeofday() calls. With this option, you can set one CPU aside for doing
890 nothing but logging current time to a shared memory location. Then the other
891 threads/processes that run IO workloads need only copy that segment, instead of
892 entering the kernel with a gettimeofday() call. The CPU set aside for doing
893 these time calls will be excluded from other uses. Fio will manually clear it
894 from the CPU mask of other jobs.
895 .TP
896 .BI cgroup \fR=\fPstr
897 Add job to this control group. If it doesn't exist, it will be created.
898 The system must have a mounted cgroup blkio mount point for this to work. If
899 your system doesn't have it mounted, you can do so with:
901 # mount \-t cgroup \-o blkio none /cgroup
902 .TP
903 .BI cgroup_weight \fR=\fPint
904 Set the weight of the cgroup to this value. See the documentation that comes
905 with the kernel, allowed values are in the range of 100..1000.
906 .TP
907 .BI cgroup_nodelete \fR=\fPbool
908 Normally fio will delete the cgroups it has created after the job completion.
909 To override this behavior and to leave cgroups around after the job completion,
910 set cgroup_nodelete=1. This can be useful if one wants to inspect various
911 cgroup files after job completion. Default: false
912 .TP
913 .BI uid \fR=\fPint
914 Instead of running as the invoking user, set the user ID to this value before
915 the thread/process does any work.
916 .TP
917 .BI gid \fR=\fPint
918 Set group ID, see \fBuid\fR.
919 .TP
920 .BI clat_percentiles \fR=\fPbool
921 Enable the reporting of percentiles of completion latencies.
922 .TP
923 .BI percentile_list \fR=\fPfloat_list
924 Overwrite the default list of percentiles for completion
925 latencies. Each number is a floating number in the range (0,100], and
926 the maximum length of the list is 20. Use ':' to separate the
927 numbers. For example, --percentile_list=99.5:99.9 will cause fio to
928 report the values of completion latency below which 99.5% and 99.9% of
929 the observed latencies fell, respectively.
931 While running, \fBfio\fR will display the status of the created jobs.  For
932 example:
933 .RS
934 .P
935 Threads: 1: [_r] [24.8% done] [ 13509/  8334 kb/s] [eta 00h:01m:31s]
936 .RE
937 .P
938 The characters in the first set of brackets denote the current status of each
939 threads.  The possible values are:
940 .P
941 .PD 0
942 .RS
943 .TP
944 .B P
945 Setup but not started.
946 .TP
947 .B C
948 Thread created.
949 .TP
950 .B I
951 Initialized, waiting.
952 .TP
953 .B R
954 Running, doing sequential reads.
955 .TP
956 .B r
957 Running, doing random reads.
958 .TP
959 .B W
960 Running, doing sequential writes.
961 .TP
962 .B w
963 Running, doing random writes.
964 .TP
965 .B M
966 Running, doing mixed sequential reads/writes.
967 .TP
968 .B m
969 Running, doing mixed random reads/writes.
970 .TP
971 .B F
972 Running, currently waiting for \fBfsync\fR\|(2).
973 .TP
974 .B V
975 Running, verifying written data.
976 .TP
977 .B E
978 Exited, not reaped by main thread.
979 .TP
980 .B \-
981 Exited, thread reaped.
982 .RE
983 .PD
984 .P
985 The second set of brackets shows the estimated completion percentage of
986 the current group.  The third set shows the read and write I/O rate,
987 respectively. Finally, the estimated run time of the job is displayed.
988 .P
989 When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data
990 for each thread, each group of threads, and each disk, in that order.
991 .P
992 Per-thread statistics first show the threads client number, group-id, and
993 error code.  The remaining figures are as follows:
994 .RS
995 .TP
996 .B io
997 Number of megabytes of I/O performed.
998 .TP
999 .B bw
1000 Average data rate (bandwidth).
1001 .TP
1002 .B runt
1003 Threads run time.
1004 .TP
1005 .B slat
1006 Submission latency minimum, maximum, average and standard deviation. This is
1007 the time it took to submit the I/O.
1008 .TP
1009 .B clat
1010 Completion latency minimum, maximum, average and standard deviation.  This
1011 is the time between submission and completion.
1012 .TP
1013 .B bw
1014 Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average
1015 and standard deviation.
1016 .TP
1017 .B cpu
1018 CPU usage statistics. Includes user and system time, number of context switches
1019 this thread went through and number of major and minor page faults.
1020 .TP
1021 .B IO depths
1022 Distribution of I/O depths.  Each depth includes everything less than (or equal)
1023 to it, but greater than the previous depth.
1024 .TP
1025 .B IO issued
1026 Number of read/write requests issued, and number of short read/write requests.
1027 .TP
1028 .B IO latencies
1029 Distribution of I/O completion latencies.  The numbers follow the same pattern
1030 as \fBIO depths\fR.
1031 .RE
1032 .P
1033 The group statistics show:
1034 .PD 0
1035 .RS
1036 .TP
1037 .B io
1038 Number of megabytes I/O performed.
1039 .TP
1040 .B aggrb
1041 Aggregate bandwidth of threads in the group.
1042 .TP
1043 .B minb
1044 Minimum average bandwidth a thread saw.
1045 .TP
1046 .B maxb
1047 Maximum average bandwidth a thread saw.
1048 .TP
1049 .B mint
1050 Shortest runtime of threads in the group.
1051 .TP
1052 .B maxt
1053 Longest runtime of threads in the group.
1054 .RE
1055 .PD
1056 .P
1057 Finally, disk statistics are printed with reads first:
1058 .PD 0
1059 .RS
1060 .TP
1061 .B ios
1062 Number of I/Os performed by all groups.
1063 .TP
1064 .B merge
1065 Number of merges in the I/O scheduler.
1066 .TP
1067 .B ticks
1068 Number of ticks we kept the disk busy.
1069 .TP
1070 .B io_queue
1071 Total time spent in the disk queue.
1072 .TP
1073 .B util
1074 Disk utilization.
1075 .RE
1076 .PD
1078 If the \fB\-\-minimal\fR option is given, the results will be printed in a
1079 semicolon-delimited format suitable for scripted use - a job description
1080 (if provided) follows on a new line.  Note that the first
1081 number in the line is the version number. If the output has to be changed
1082 for some reason, this number will be incremented by 1 to signify that
1083 change.  The fields are:
1084 .P
1085 .RS
1086 .B version, jobname, groupid, error
1087 .P
1088 Read status:
1089 .RS
1090 .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, runtime \fR(ms)\fP
1091 .P
1092 Submission latency:
1093 .RS
1094 .B min, max, mean, standard deviation
1095 .RE
1096 Completion latency:
1097 .RS
1098 .B min, max, mean, standard deviation
1099 .RE
1100 Total latency:
1101 .RS
1102 .B min, max, mean, standard deviation
1103 .RE
1104 Bandwidth:
1105 .RS
1106 .B min, max, aggregate percentage of total, mean, standard deviation
1107 .RE
1108 .RE
1109 .P
1110 Write status:
1111 .RS
1112 .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, runtime \fR(ms)\fP
1113 .P
1114 Submission latency:
1115 .RS
1116 .B min, max, mean, standard deviation
1117 .RE
1118 Completion latency:
1119 .RS
1120 .B min, max, mean, standard deviation
1121 .RE
1122 Total latency:
1123 .RS
1124 .B min, max, mean, standard deviation
1125 .RE
1126 Bandwidth:
1127 .RS
1128 .B min, max, aggregate percentage of total, mean, standard deviation
1129 .RE
1130 .RE
1131 .P
1132 CPU usage:
1133 .RS
1134 .B user, system, context switches, major page faults, minor page faults
1135 .RE
1136 .P
1137 IO depth distribution:
1138 .RS
1139 .B <=1, 2, 4, 8, 16, 32, >=64
1140 .RE
1141 .P
1142 IO latency distribution:
1143 .RS
1144 Microseconds:
1145 .RS
1146 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
1147 .RE
1148 Milliseconds:
1149 .RS
1150 .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000
1151 .RE
1152 .RE
1153 .P
1154 Error Info (dependent on continue_on_error, default off):
1155 .RS
1156 .B total # errors, first error code 
1157 .RE
1158 .P
1159 .B text description (if provided in config - appears on newline)
1160 .RE
1162 .B fio
1163 was written by Jens Axboe <>,
1164 now Jens Axboe <>.
1165 .br
1166 This man page was written by Aaron Carroll <> based
1167 on documentation by Jens Axboe.
1169 Report bugs to the \fBfio\fR mailing list <>.
1170 See \fBREADME\fR.
1171 .SH "SEE ALSO"
1172 For further documentation see \fBHOWTO\fR and \fBREADME\fR.
1173 .br
1174 Sample jobfiles are available in the \fBexamples\fR directory.