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