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