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