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