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