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