Add possibility to make sequential IO "holed"
[fio.git] / HOWTO
CommitLineData
71bfa161
JA
1Table of contents
2-----------------
3
41. Overview
52. How fio works
63. Running fio
74. Job file format
85. Detailed list of parameters
96. Normal output
107. Terse output
25c8b9d7 118. Trace file format
71bfa161
JA
12
131.0 Overview and history
14------------------------
15fio was originally written to save me the hassle of writing special test
16case programs when I wanted to test a specific workload, either for
17performance reasons or to find/reproduce a bug. The process of writing
18such a test app can be tiresome, especially if you have to do it often.
19Hence I needed a tool that would be able to simulate a given io workload
20without resorting to writing a tailored test case again and again.
21
22A test work load is difficult to define, though. There can be any number
23of processes or threads involved, and they can each be using their own
24way of generating io. You could have someone dirtying large amounts of
25memory in an memory mapped file, or maybe several threads issuing
26reads using asynchronous io. fio needed to be flexible enough to
27simulate both of these cases, and many more.
28
292.0 How fio works
30-----------------
31The first step in getting fio to simulate a desired io workload, is
32writing a job file describing that specific setup. A job file may contain
33any number of threads and/or files - the typical contents of the job file
34is a global section defining shared parameters, and one or more job
35sections describing the jobs involved. When run, fio parses this file
36and sets everything up as described. If we break down a job from top to
37bottom, it contains the following basic parameters:
38
39 IO type Defines the io pattern issued to the file(s).
40 We may only be reading sequentially from this
41 file(s), or we may be writing randomly. Or even
42 mixing reads and writes, sequentially or randomly.
43
44 Block size In how large chunks are we issuing io? This may be
45 a single value, or it may describe a range of
46 block sizes.
47
48 IO size How much data are we going to be reading/writing.
49
50 IO engine How do we issue io? We could be memory mapping the
51 file, we could be using regular read/write, we
d0ff85df 52 could be using splice, async io, syslet, or even
71bfa161
JA
53 SG (SCSI generic sg).
54
6c219763 55 IO depth If the io engine is async, how large a queuing
71bfa161
JA
56 depth do we want to maintain?
57
58 IO type Should we be doing buffered io, or direct/raw io?
59
60 Num files How many files are we spreading the workload over.
61
62 Num threads How many threads or processes should we spread
63 this workload over.
64
65The above are the basic parameters defined for a workload, in addition
66there's a multitude of parameters that modify other aspects of how this
67job behaves.
68
69
703.0 Running fio
71---------------
72See the README file for command line parameters, there are only a few
73of them.
74
75Running fio is normally the easiest part - you just give it the job file
76(or job files) as parameters:
77
78$ fio job_file
79
80and it will start doing what the job_file tells it to do. You can give
81more than one job file on the command line, fio will serialize the running
82of those files. Internally that is the same as using the 'stonewall'
83parameter described the the parameter section.
84
b4692828
JA
85If the job file contains only one job, you may as well just give the
86parameters on the command line. The command line parameters are identical
87to the job parameters, with a few extra that control global parameters
88(see README). For example, for the job file parameter iodepth=2, the
c2b1e753
JA
89mirror command line option would be --iodepth 2 or --iodepth=2. You can
90also use the command line for giving more than one job entry. For each
91--name option that fio sees, it will start a new job with that name.
92Command line entries following a --name entry will apply to that job,
93until there are no more entries or a new --name entry is seen. This is
94similar to the job file options, where each option applies to the current
95job until a new [] job entry is seen.
b4692828 96
71bfa161
JA
97fio does not need to run as root, except if the files or devices specified
98in the job section requires that. Some other options may also be restricted,
6c219763 99such as memory locking, io scheduler switching, and decreasing the nice value.
71bfa161
JA
100
101
1024.0 Job file format
103-------------------
104As previously described, fio accepts one or more job files describing
105what it is supposed to do. The job file format is the classic ini file,
106where the names enclosed in [] brackets define the job name. You are free
107to use any ascii name you want, except 'global' which has special meaning.
108A global section sets defaults for the jobs described in that file. A job
109may override a global section parameter, and a job file may even have
110several global sections if so desired. A job is only affected by a global
65db0851
JA
111section residing above it. If the first character in a line is a ';' or a
112'#', the entire line is discarded as a comment.
71bfa161 113
3c54bc46 114So let's look at a really simple job file that defines two processes, each
b22989b9 115randomly reading from a 128MB file.
71bfa161
JA
116
117; -- start job file --
118[global]
119rw=randread
120size=128m
121
122[job1]
123
124[job2]
125
126; -- end job file --
127
128As you can see, the job file sections themselves are empty as all the
129described parameters are shared. As no filename= option is given, fio
c2b1e753
JA
130makes up a filename for each of the jobs as it sees fit. On the command
131line, this job would look as follows:
132
133$ fio --name=global --rw=randread --size=128m --name=job1 --name=job2
134
71bfa161 135
3c54bc46 136Let's look at an example that has a number of processes writing randomly
71bfa161
JA
137to files.
138
139; -- start job file --
140[random-writers]
141ioengine=libaio
142iodepth=4
143rw=randwrite
144bs=32k
145direct=0
146size=64m
147numjobs=4
148
149; -- end job file --
150
151Here we have no global section, as we only have one job defined anyway.
152We want to use async io here, with a depth of 4 for each file. We also
b22989b9 153increased the buffer size used to 32KB and define numjobs to 4 to
71bfa161 154fork 4 identical jobs. The result is 4 processes each randomly writing
b22989b9 155to their own 64MB file. Instead of using the above job file, you could
b4692828
JA
156have given the parameters on the command line. For this case, you would
157specify:
158
159$ fio --name=random-writers --ioengine=libaio --iodepth=4 --rw=randwrite --bs=32k --direct=0 --size=64m --numjobs=4
71bfa161 160
74929ac2
JA
1614.1 Environment variables
162-------------------------
163
3c54bc46
AC
164fio also supports environment variable expansion in job files. Any
165substring of the form "${VARNAME}" as part of an option value (in other
166words, on the right of the `='), will be expanded to the value of the
167environment variable called VARNAME. If no such environment variable
168is defined, or VARNAME is the empty string, the empty string will be
169substituted.
170
171As an example, let's look at a sample fio invocation and job file:
172
173$ SIZE=64m NUMJOBS=4 fio jobfile.fio
174
175; -- start job file --
176[random-writers]
177rw=randwrite
178size=${SIZE}
179numjobs=${NUMJOBS}
180; -- end job file --
181
182This will expand to the following equivalent job file at runtime:
183
184; -- start job file --
185[random-writers]
186rw=randwrite
187size=64m
188numjobs=4
189; -- end job file --
190
71bfa161
JA
191fio ships with a few example job files, you can also look there for
192inspiration.
193
74929ac2
JA
1944.2 Reserved keywords
195---------------------
196
197Additionally, fio has a set of reserved keywords that will be replaced
198internally with the appropriate value. Those keywords are:
199
200$pagesize The architecture page size of the running system
201$mb_memory Megabytes of total memory in the system
202$ncpus Number of online available CPUs
203
204These can be used on the command line or in the job file, and will be
205automatically substituted with the current system values when the job
892a6ffc
JA
206is run. Simple math is also supported on these keywords, so you can
207perform actions like:
208
209size=8*$mb_memory
210
211and get that properly expanded to 8 times the size of memory in the
212machine.
74929ac2 213
71bfa161
JA
214
2155.0 Detailed list of parameters
216-------------------------------
217
218This section describes in details each parameter associated with a job.
219Some parameters take an option of a given type, such as an integer or
220a string. The following types are used:
221
222str String. This is a sequence of alpha characters.
b09da8fa 223time Integer with possible time suffix. In seconds unless otherwise
e417fd66
JA
224 specified, use eg 10m for 10 minutes. Accepts s/m/h for seconds,
225 minutes, and hours.
b09da8fa
JA
226int SI integer. A whole number value, which may contain a suffix
227 describing the base of the number. Accepted suffixes are k/m/g/t/p,
228 meaning kilo, mega, giga, tera, and peta. The suffix is not case
57fc29fa
JA
229 sensitive, and you may also include trailing 'b' (eg 'kb' is the same
230 as 'k'). So if you want to specify 4096, you could either write
b09da8fa 231 out '4096' or just give 4k. The suffixes signify base 2 values, so
57fc29fa
JA
232 1024 is 1k and 1024k is 1m and so on, unless the suffix is explicitly
233 set to a base 10 value using 'kib', 'mib', 'gib', etc. If that is the
234 case, then 1000 is used as the multiplier. This can be handy for
235 disks, since manufacturers generally use base 10 values when listing
236 the capacity of a drive. If the option accepts an upper and lower
237 range, use a colon ':' or minus '-' to separate such values. May also
238 include a prefix to indicate numbers base. If 0x is used, the number
239 is assumed to be hexadecimal. See irange.
71bfa161
JA
240bool Boolean. Usually parsed as an integer, however only defined for
241 true and false (1 and 0).
b09da8fa 242irange Integer range with suffix. Allows value range to be given, such
bf9a3edb 243 as 1024-4096. A colon may also be used as the separator, eg
0c9baf91
JA
244 1k:4k. If the option allows two sets of ranges, they can be
245 specified with a ',' or '/' delimiter: 1k-4k/8k-32k. Also see
f7fa2653 246 int.
83349190 247float_list A list of floating numbers, separated by a ':' character.
71bfa161
JA
248
249With the above in mind, here follows the complete list of fio job
250parameters.
251
252name=str ASCII name of the job. This may be used to override the
253 name printed by fio for this job. Otherwise the job
c2b1e753 254 name is used. On the command line this parameter has the
6c219763 255 special purpose of also signaling the start of a new
c2b1e753 256 job.
71bfa161 257
61697c37
JA
258description=str Text description of the job. Doesn't do anything except
259 dump this text description when this job is run. It's
260 not parsed.
261
3776041e 262directory=str Prefix filenames with this directory. Used to place files
71bfa161
JA
263 in a different location than "./".
264
265filename=str Fio normally makes up a filename based on the job name,
266 thread number, and file number. If you want to share
267 files between threads in a job or several jobs, specify
ed92ac0c 268 a filename for each of them to override the default. If
414c2a3e
JA
269 the ioengine used is 'net', the filename is the host, port,
270 and protocol to use in the format of =host/port/protocol.
271 See ioengine=net for more. If the ioengine is file based, you
272 can specify a number of files by separating the names with a
273 ':' colon. So if you wanted a job to open /dev/sda and /dev/sdb
274 as the two working files, you would use
03e20d68 275 filename=/dev/sda:/dev/sdb. On Windows, disk devices are accessed
ecc314ba
BC
276 as \\.\PhysicalDrive0 for the first device, \\.\PhysicalDrive1
277 for the second etc. If the wanted filename does need to
278 include a colon, then escape that with a '\' character.
279 For instance, if the filename is "/dev/dsk/foo@3,0:c",
280 then you would use filename="/dev/dsk/foo@3,0\:c".
03e20d68
BC
281 '-' is a reserved name, meaning stdin or stdout. Which of the
282 two depends on the read/write direction set.
71bfa161 283
bbf6b540
JA
284opendir=str Tell fio to recursively add any file it can find in this
285 directory and down the file system tree.
286
3776041e 287lockfile=str Fio defaults to not locking any files before it does
4d4e80f2
JA
288 IO to them. If a file or file descriptor is shared, fio
289 can serialize IO to that file to make the end result
290 consistent. This is usual for emulating real workloads that
291 share files. The lock modes are:
292
293 none No locking. The default.
294 exclusive Only one thread/process may do IO,
295 excluding all others.
296 readwrite Read-write locking on the file. Many
297 readers may access the file at the
298 same time, but writes get exclusive
299 access.
300
301 The option may be post-fixed with a lock batch number. If
302 set, then each thread/process may do that amount of IOs to
bf9a3edb 303 the file before giving up the lock. Since lock acquisition is
4d4e80f2 304 expensive, batching the lock/unlocks will speed up IO.
29c1349f 305
d3aad8f2 306readwrite=str
71bfa161
JA
307rw=str Type of io pattern. Accepted values are:
308
309 read Sequential reads
310 write Sequential writes
311 randwrite Random writes
312 randread Random reads
313 rw Sequential mixed reads and writes
314 randrw Random mixed reads and writes
315
316 For the mixed io types, the default is to split them 50/50.
317 For certain types of io the result may still be skewed a bit,
211097b2 318 since the speed may be different. It is possible to specify
38dad62d
JA
319 a number of IO's to do before getting a new offset, this is
320 one by appending a ':<nr>' to the end of the string given.
321 For a random read, it would look like 'rw=randread:8' for
059b0802
JA
322 passing in an offset modifier with a value of 8. If the
323 postfix is used with a sequential IO pattern, then the value
324 specified will be added to the generated offset for each IO.
325 For instance, using rw=write:4k will skip 4k for every
326 write. It turns sequential IO into sequential IO with holes.
327 See the 'rw_sequencer' option.
38dad62d
JA
328
329rw_sequencer=str If an offset modifier is given by appending a number to
330 the rw=<str> line, then this option controls how that
331 number modifies the IO offset being generated. Accepted
332 values are:
333
334 sequential Generate sequential offset
335 identical Generate the same offset
336
337 'sequential' is only useful for random IO, where fio would
338 normally generate a new random offset for every IO. If you
339 append eg 8 to randread, you would get a new random offset for
211097b2
JA
340 every 8 IO's. The result would be a seek for only every 8
341 IO's, instead of for every IO. Use rw=randread:8 to specify
38dad62d
JA
342 that. As sequential IO is already sequential, setting
343 'sequential' for that would not result in any differences.
344 'identical' behaves in a similar fashion, except it sends
345 the same offset 8 number of times before generating a new
346 offset.
71bfa161 347
90fef2d1
JA
348kb_base=int The base unit for a kilobyte. The defacto base is 2^10, 1024.
349 Storage manufacturers like to use 10^3 or 1000 as a base
350 ten unit instead, for obvious reasons. Allow values are
351 1024 or 1000, with 1024 being the default.
352
ee738499
JA
353randrepeat=bool For random IO workloads, seed the generator in a predictable
354 way so that results are repeatable across repetitions.
355
2615cc4b
JA
356use_os_rand=bool Fio can either use the random generator supplied by the OS
357 to generator random offsets, or it can use it's own internal
358 generator (based on Tausworthe). Default is to use the
359 internal generator, which is often of better quality and
360 faster.
361
a596f047
EG
362fallocate=str Whether pre-allocation is performed when laying down files.
363 Accepted values are:
364
365 none Do not pre-allocate space
366 posix Pre-allocate via posix_fallocate()
367 keep Pre-allocate via fallocate() with
368 FALLOC_FL_KEEP_SIZE set
369 0 Backward-compatible alias for 'none'
370 1 Backward-compatible alias for 'posix'
371
372 May not be available on all supported platforms. 'keep' is only
373 available on Linux.If using ZFS on Solaris this must be set to
374 'none' because ZFS doesn't support it. Default: 'posix'.
7bc8c2cf 375
d2f3ac35
JA
376fadvise_hint=bool By default, fio will use fadvise() to advise the kernel
377 on what IO patterns it is likely to issue. Sometimes you
378 want to test specific IO patterns without telling the
379 kernel about it, in which case you can disable this option.
380 If set, fio will use POSIX_FADV_SEQUENTIAL for sequential
381 IO and POSIX_FADV_RANDOM for random IO.
382
f7fa2653 383size=int The total size of file io for this job. Fio will run until
7616cafe
JA
384 this many bytes has been transferred, unless runtime is
385 limited by other options (such as 'runtime', for instance).
3776041e 386 Unless specific nrfiles and filesize options are given,
7616cafe 387 fio will divide this size between the available files
d6667268
JA
388 specified by the job. If not set, fio will use the full
389 size of the given files or devices. If the the files
7bb59102
JA
390 do not exist, size must be given. It is also possible to
391 give size as a percentage between 1 and 100. If size=20%
392 is given, fio will use 20% of the full size of the given
393 files or devices.
71bfa161 394
f7fa2653 395filesize=int Individual file sizes. May be a range, in which case fio
9c60ce64
JA
396 will select sizes for files at random within the given range
397 and limited to 'size' in total (if that is given). If not
398 given, each created file is the same size.
399
74586c1e
JA
400fill_device=bool
401fill_fs=bool Sets size to something really large and waits for ENOSPC (no
aa31f1f1 402 space left on device) as the terminating condition. Only makes
3ce9dcaf 403 sense with sequential write. For a read workload, the mount
4f12432e
JA
404 point will be filled first then IO started on the result. This
405 option doesn't make sense if operating on a raw device node,
406 since the size of that is already known by the file system.
407 Additionally, writing beyond end-of-device will not return
408 ENOSPC there.
aa31f1f1 409
f7fa2653
JA
410blocksize=int
411bs=int The block size used for the io units. Defaults to 4k. Values
412 can be given for both read and writes. If a single int is
413 given, it will apply to both. If a second int is specified
f90eff5a
JA
414 after a comma, it will apply to writes only. In other words,
415 the format is either bs=read_and_write or bs=read,write.
416 bs=4k,8k will thus use 4k blocks for reads, and 8k blocks
787f7e95
JA
417 for writes. If you only wish to set the write size, you
418 can do so by passing an empty read size - bs=,8k will set
419 8k for writes and leave the read default value.
a00735e6 420
2b7a01d0
JA
421blockalign=int
422ba=int At what boundary to align random IO offsets. Defaults to
423 the same as 'blocksize' the minimum blocksize given.
424 Minimum alignment is typically 512b for using direct IO,
425 though it usually depends on the hardware block size. This
426 option is mutually exclusive with using a random map for
427 files, so it will turn off that option.
428
d3aad8f2 429blocksize_range=irange
71bfa161
JA
430bsrange=irange Instead of giving a single block size, specify a range
431 and fio will mix the issued io block sizes. The issued
432 io unit will always be a multiple of the minimum value
f90eff5a
JA
433 given (also see bs_unaligned). Applies to both reads and
434 writes, however a second range can be given after a comma.
435 See bs=.
a00735e6 436
564ca972
JA
437bssplit=str Sometimes you want even finer grained control of the
438 block sizes issued, not just an even split between them.
439 This option allows you to weight various block sizes,
440 so that you are able to define a specific amount of
441 block sizes issued. The format for this option is:
442
443 bssplit=blocksize/percentage:blocksize/percentage
444
445 for as many block sizes as needed. So if you want to define
446 a workload that has 50% 64k blocks, 10% 4k blocks, and
447 40% 32k blocks, you would write:
448
449 bssplit=4k/10:64k/50:32k/40
450
451 Ordering does not matter. If the percentage is left blank,
452 fio will fill in the remaining values evenly. So a bssplit
453 option like this one:
454
455 bssplit=4k/50:1k/:32k/
456
457 would have 50% 4k ios, and 25% 1k and 32k ios. The percentages
458 always add up to 100, if bssplit is given a range that adds
459 up to more, it will error out.
460
720e84ad
JA
461 bssplit also supports giving separate splits to reads and
462 writes. The format is identical to what bs= accepts. You
463 have to separate the read and write parts with a comma. So
464 if you want a workload that has 50% 2k reads and 50% 4k reads,
465 while having 90% 4k writes and 10% 8k writes, you would
466 specify:
467
468 bssplit=2k/50:4k/50,4k/90,8k/10
469
d3aad8f2 470blocksize_unaligned
690adba3
JA
471bs_unaligned If this option is given, any byte size value within bsrange
472 may be used as a block range. This typically wont work with
473 direct IO, as that normally requires sector alignment.
71bfa161 474
e9459e5a
JA
475zero_buffers If this option is given, fio will init the IO buffers to
476 all zeroes. The default is to fill them with random data.
477
5973cafb
JA
478refill_buffers If this option is given, fio will refill the IO buffers
479 on every submit. The default is to only fill it at init
480 time and reuse that data. Only makes sense if zero_buffers
41ccd845
JA
481 isn't specified, naturally. If data verification is enabled,
482 refill_buffers is also automatically enabled.
5973cafb 483
71bfa161
JA
484nrfiles=int Number of files to use for this job. Defaults to 1.
485
390b1537
JA
486openfiles=int Number of files to keep open at the same time. Defaults to
487 the same as nrfiles, can be set smaller to limit the number
488 simultaneous opens.
489
5af1c6f3
JA
490file_service_type=str Defines how fio decides which file from a job to
491 service next. The following types are defined:
492
493 random Just choose a file at random.
494
495 roundrobin Round robin over open files. This
496 is the default.
497
a086c257
JA
498 sequential Finish one file before moving on to
499 the next. Multiple files can still be
500 open depending on 'openfiles'.
501
1907dbc6
JA
502 The string can have a number appended, indicating how
503 often to switch to a new file. So if option random:4 is
504 given, fio will switch to a new random file after 4 ios
505 have been issued.
506
71bfa161
JA
507ioengine=str Defines how the job issues io to the file. The following
508 types are defined:
509
510 sync Basic read(2) or write(2) io. lseek(2) is
511 used to position the io location.
512
a31041ea 513 psync Basic pread(2) or pwrite(2) io.
514
e05af9e5 515 vsync Basic readv(2) or writev(2) IO.
1d2af02a 516
15d182aa
JA
517 libaio Linux native asynchronous io. Note that Linux
518 may only support queued behaviour with
519 non-buffered IO (set direct=1 or buffered=0).
71bfa161
JA
520
521 posixaio glibc posix asynchronous io.
522
417f0068
JA
523 solarisaio Solaris native asynchronous io.
524
03e20d68
BC
525 windowsaio Windows native asynchronous io.
526
71bfa161
JA
527 mmap File is memory mapped and data copied
528 to/from using memcpy(3).
529
530 splice splice(2) is used to transfer the data and
531 vmsplice(2) to transfer data from user
532 space to the kernel.
533
d0ff85df
JA
534 syslet-rw Use the syslet system calls to make
535 regular read/write async.
536
71bfa161 537 sg SCSI generic sg v3 io. May either be
6c219763 538 synchronous using the SG_IO ioctl, or if
71bfa161
JA
539 the target is an sg character device
540 we use read(2) and write(2) for asynchronous
541 io.
542
a94ea28b
JA
543 null Doesn't transfer any data, just pretends
544 to. This is mainly used to exercise fio
545 itself and for debugging/testing purposes.
546
ed92ac0c
JA
547 net Transfer over the network to given host:port.
548 'filename' must be set appropriately to
414c2a3e 549 filename=host/port/protocol regardless of send
ed92ac0c 550 or receive, if the latter only the port
414c2a3e
JA
551 argument is used. 'host' may be an IP address
552 or hostname, port is the port number to be used,
553 and protocol may be 'udp' or 'tcp'. If no
554 protocol is given, TCP is used.
ed92ac0c 555
9cce02e8
JA
556 netsplice Like net, but uses splice/vmsplice to
557 map data and send/receive.
558
53aec0a4 559 cpuio Doesn't transfer any data, but burns CPU
ba0fbe10
JA
560 cycles according to the cpuload= and
561 cpucycle= options. Setting cpuload=85
562 will cause that job to do nothing but burn
36ecec83
GP
563 85% of the CPU. In case of SMP machines,
564 use numjobs=<no_of_cpu> to get desired CPU
565 usage, as the cpuload only loads a single
566 CPU at the desired rate.
ba0fbe10 567
e9a1806f
JA
568 guasi The GUASI IO engine is the Generic Userspace
569 Asyncronous Syscall Interface approach
570 to async IO. See
571
572 http://www.xmailserver.org/guasi-lib.html
573
574 for more info on GUASI.
575
21b8aee8 576 rdma The RDMA I/O engine supports both RDMA
eb52fa3f
BVA
577 memory semantics (RDMA_WRITE/RDMA_READ) and
578 channel semantics (Send/Recv) for the
579 InfiniBand, RoCE and iWARP protocols.
21b8aee8 580
8a7bd877
JA
581 external Prefix to specify loading an external
582 IO engine object file. Append the engine
583 filename, eg ioengine=external:/tmp/foo.o
584 to load ioengine foo.o in /tmp.
585
71bfa161
JA
586iodepth=int This defines how many io units to keep in flight against
587 the file. The default is 1 for each file defined in this
588 job, can be overridden with a larger value for higher
ee72ca09
JA
589 concurrency. Note that increasing iodepth beyond 1 will not
590 affect synchronous ioengines (except for small degress when
9b836561 591 verify_async is in use). Even async engines may impose OS
ee72ca09
JA
592 restrictions causing the desired depth not to be achieved.
593 This may happen on Linux when using libaio and not setting
594 direct=1, since buffered IO is not async on that OS. Keep an
595 eye on the IO depth distribution in the fio output to verify
596 that the achieved depth is as expected. Default: 1.
71bfa161 597
4950421a 598iodepth_batch_submit=int
cb5ab512 599iodepth_batch=int This defines how many pieces of IO to submit at once.
89e820f6
JA
600 It defaults to 1 which means that we submit each IO
601 as soon as it is available, but can be raised to submit
602 bigger batches of IO at the time.
cb5ab512 603
4950421a
JA
604iodepth_batch_complete=int This defines how many pieces of IO to retrieve
605 at once. It defaults to 1 which means that we'll ask
606 for a minimum of 1 IO in the retrieval process from
607 the kernel. The IO retrieval will go on until we
608 hit the limit set by iodepth_low. If this variable is
609 set to 0, then fio will always check for completed
610 events before queuing more IO. This helps reduce
611 IO latency, at the cost of more retrieval system calls.
612
e916b390
JA
613iodepth_low=int The low water mark indicating when to start filling
614 the queue again. Defaults to the same as iodepth, meaning
615 that fio will attempt to keep the queue full at all times.
616 If iodepth is set to eg 16 and iodepth_low is set to 4, then
617 after fio has filled the queue of 16 requests, it will let
618 the depth drain down to 4 before starting to fill it again.
619
71bfa161 620direct=bool If value is true, use non-buffered io. This is usually
9b836561 621 O_DIRECT. Note that ZFS on Solaris doesn't support direct io.
76a43db4
JA
622
623buffered=bool If value is true, use buffered io. This is the opposite
624 of the 'direct' option. Defaults to true.
71bfa161 625
f7fa2653 626offset=int Start io at the given offset in the file. The data before
71bfa161
JA
627 the given offset will not be touched. This effectively
628 caps the file size at real_size - offset.
629
630fsync=int If writing to a file, issue a sync of the dirty data
631 for every number of blocks given. For example, if you give
632 32 as a parameter, fio will sync the file for every 32
633 writes issued. If fio is using non-buffered io, we may
634 not sync the file. The exception is the sg io engine, which
6c219763 635 synchronizes the disk cache anyway.
71bfa161 636
e76b1da4 637fdatasync=int Like fsync= but uses fdatasync() to only sync data and not
5f9099ea 638 metadata blocks.
e72fa4d4
JA
639 In FreeBSD there is no fdatasync(), this falls back to
640 using fsync()
5f9099ea 641
e76b1da4
JA
642sync_file_range=str:val Use sync_file_range() for every 'val' number of
643 write operations. Fio will track range of writes that
644 have happened since the last sync_file_range() call. 'str'
645 can currently be one or more of:
646
647 wait_before SYNC_FILE_RANGE_WAIT_BEFORE
648 write SYNC_FILE_RANGE_WRITE
649 wait_after SYNC_FILE_RANGE_WAIT_AFTER
650
651 So if you do sync_file_range=wait_before,write:8, fio would
652 use SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE for
653 every 8 writes. Also see the sync_file_range(2) man page.
654 This option is Linux specific.
655
5036fc1e
JA
656overwrite=bool If true, writes to a file will always overwrite existing
657 data. If the file doesn't already exist, it will be
658 created before the write phase begins. If the file exists
659 and is large enough for the specified write phase, nothing
660 will be done.
71bfa161
JA
661
662end_fsync=bool If true, fsync file contents when the job exits.
663
ebb1415f
JA
664fsync_on_close=bool If true, fio will fsync() a dirty file on close.
665 This differs from end_fsync in that it will happen on every
666 file close, not just at the end of the job.
667
71bfa161
JA
668rwmixread=int How large a percentage of the mix should be reads.
669
670rwmixwrite=int How large a percentage of the mix should be writes. If both
671 rwmixread and rwmixwrite is given and the values do not add
672 up to 100%, the latter of the two will be used to override
c35dd7a6
JA
673 the first. This may interfere with a given rate setting,
674 if fio is asked to limit reads or writes to a certain rate.
675 If that is the case, then the distribution may be skewed.
71bfa161 676
bb8895e0
JA
677norandommap Normally fio will cover every block of the file when doing
678 random IO. If this option is given, fio will just get a
679 new random offset without looking at past io history. This
680 means that some blocks may not be read or written, and that
681 some blocks may be read/written more than once. This option
8347239a
JA
682 is mutually exclusive with verify= if and only if multiple
683 blocksizes (via bsrange=) are used, since fio only tracks
684 complete rewrites of blocks.
bb8895e0 685
0408c206
JA
686softrandommap=bool See norandommap. If fio runs with the random block map
687 enabled and it fails to allocate the map, if this option is
688 set it will continue without a random block map. As coverage
689 will not be as complete as with random maps, this option is
2b386d25
JA
690 disabled by default.
691
71bfa161
JA
692nice=int Run the job with the given nice value. See man nice(2).
693
694prio=int Set the io priority value of this job. Linux limits us to
695 a positive value between 0 and 7, with 0 being the highest.
696 See man ionice(1).
697
698prioclass=int Set the io priority class. See man ionice(1).
699
700thinktime=int Stall the job x microseconds after an io has completed before
701 issuing the next. May be used to simulate processing being
48097d5c
JA
702 done by an application. See thinktime_blocks and
703 thinktime_spin.
704
705thinktime_spin=int
706 Only valid if thinktime is set - pretend to spend CPU time
707 doing something with the data received, before falling back
708 to sleeping for the rest of the period specified by
709 thinktime.
9c1f7434
JA
710
711thinktime_blocks
712 Only valid if thinktime is set - control how many blocks
713 to issue, before waiting 'thinktime' usecs. If not set,
714 defaults to 1 which will make fio wait 'thinktime' usecs
715 after every block.
71bfa161 716
581e7141 717rate=int Cap the bandwidth used by this job. The number is in bytes/sec,
b09da8fa 718 the normal suffix rules apply. You can use rate=500k to limit
581e7141
JA
719 reads and writes to 500k each, or you can specify read and
720 writes separately. Using rate=1m,500k would limit reads to
721 1MB/sec and writes to 500KB/sec. Capping only reads or
722 writes can be done with rate=,500k or rate=500k,. The former
723 will only limit writes (to 500KB/sec), the latter will only
724 limit reads.
71bfa161
JA
725
726ratemin=int Tell fio to do whatever it can to maintain at least this
4e991c23 727 bandwidth. Failing to meet this requirement, will cause
581e7141
JA
728 the job to exit. The same format as rate is used for
729 read vs write separation.
4e991c23
JA
730
731rate_iops=int Cap the bandwidth to this number of IOPS. Basically the same
732 as rate, just specified independently of bandwidth. If the
733 job is given a block size range instead of a fixed value,
581e7141
JA
734 the smallest block size is used as the metric. The same format
735 as rate is used for read vs write seperation.
4e991c23
JA
736
737rate_iops_min=int If fio doesn't meet this rate of IO, it will cause
581e7141
JA
738 the job to exit. The same format as rate is used for read vs
739 write seperation.
71bfa161
JA
740
741ratecycle=int Average bandwidth for 'rate' and 'ratemin' over this number
6c219763 742 of milliseconds.
71bfa161
JA
743
744cpumask=int Set the CPU affinity of this job. The parameter given is a
a08bc17f
JA
745 bitmask of allowed CPU's the job may run on. So if you want
746 the allowed CPUs to be 1 and 5, you would pass the decimal
747 value of (1 << 1 | 1 << 5), or 34. See man
7dbb6eba 748 sched_setaffinity(2). This may not work on all supported
b0ea08ce
JA
749 operating systems or kernel versions. This option doesn't
750 work well for a higher CPU count than what you can store in
751 an integer mask, so it can only control cpus 1-32. For
752 boxes with larger CPU counts, use cpus_allowed.
71bfa161 753
d2e268b0
JA
754cpus_allowed=str Controls the same options as cpumask, but it allows a text
755 setting of the permitted CPUs instead. So to use CPUs 1 and
62a7273d
JA
756 5, you would specify cpus_allowed=1,5. This options also
757 allows a range of CPUs. Say you wanted a binding to CPUs
758 1, 5, and 8-15, you would set cpus_allowed=1,5,8-15.
d2e268b0 759
e417fd66 760startdelay=time Start this job the specified number of seconds after fio
71bfa161
JA
761 has started. Only useful if the job file contains several
762 jobs, and you want to delay starting some jobs to a certain
763 time.
764
e417fd66 765runtime=time Tell fio to terminate processing after the specified number
71bfa161
JA
766 of seconds. It can be quite hard to determine for how long
767 a specified job will run, so this parameter is handy to
768 cap the total runtime to a given time.
769
cf4464ca 770time_based If set, fio will run for the duration of the runtime
bf9a3edb 771 specified even if the file(s) are completely read or
cf4464ca
JA
772 written. It will simply loop over the same workload
773 as many times as the runtime allows.
774
e417fd66 775ramp_time=time If set, fio will run the specified workload for this amount
721938ae
JA
776 of time before logging any performance numbers. Useful for
777 letting performance settle before logging results, thus
b29ee5b3
JA
778 minimizing the runtime required for stable results. Note
779 that the ramp_time is considered lead in time for a job,
780 thus it will increase the total runtime if a special timeout
781 or runtime is specified.
721938ae 782
71bfa161
JA
783invalidate=bool Invalidate the buffer/page cache parts for this file prior
784 to starting io. Defaults to true.
785
786sync=bool Use sync io for buffered writes. For the majority of the
787 io engines, this means using O_SYNC.
788
d3aad8f2 789iomem=str
71bfa161
JA
790mem=str Fio can use various types of memory as the io unit buffer.
791 The allowed values are:
792
793 malloc Use memory from malloc(3) as the buffers.
794
795 shm Use shared memory as the buffers. Allocated
796 through shmget(2).
797
74b025b0
JA
798 shmhuge Same as shm, but use huge pages as backing.
799
313cb206
JA
800 mmap Use mmap to allocate buffers. May either be
801 anonymous memory, or can be file backed if
802 a filename is given after the option. The
803 format is mem=mmap:/path/to/file.
71bfa161 804
d0bdaf49
JA
805 mmaphuge Use a memory mapped huge file as the buffer
806 backing. Append filename after mmaphuge, ala
807 mem=mmaphuge:/hugetlbfs/file
808
71bfa161 809 The area allocated is a function of the maximum allowed
5394ae5f
JA
810 bs size for the job, multiplied by the io depth given. Note
811 that for shmhuge and mmaphuge to work, the system must have
812 free huge pages allocated. This can normally be checked
813 and set by reading/writing /proc/sys/vm/nr_hugepages on a
b22989b9 814 Linux system. Fio assumes a huge page is 4MB in size. So
5394ae5f
JA
815 to calculate the number of huge pages you need for a given
816 job file, add up the io depth of all jobs (normally one unless
817 iodepth= is used) and multiply by the maximum bs set. Then
818 divide that number by the huge page size. You can see the
819 size of the huge pages in /proc/meminfo. If no huge pages
820 are allocated by having a non-zero number in nr_hugepages,
56bb17f2 821 using mmaphuge or shmhuge will fail. Also see hugepage-size.
5394ae5f
JA
822
823 mmaphuge also needs to have hugetlbfs mounted and the file
824 location should point there. So if it's mounted in /huge,
825 you would use mem=mmaphuge:/huge/somefile.
71bfa161 826
d529ee19
JA
827iomem_align=int This indiciates the memory alignment of the IO memory buffers.
828 Note that the given alignment is applied to the first IO unit
829 buffer, if using iodepth the alignment of the following buffers
830 are given by the bs used. In other words, if using a bs that is
831 a multiple of the page sized in the system, all buffers will
832 be aligned to this value. If using a bs that is not page
833 aligned, the alignment of subsequent IO memory buffers is the
834 sum of the iomem_align and bs used.
835
f7fa2653 836hugepage-size=int
56bb17f2 837 Defines the size of a huge page. Must at least be equal
b22989b9 838 to the system setting, see /proc/meminfo. Defaults to 4MB.
c51074e7
JA
839 Should probably always be a multiple of megabytes, so using
840 hugepage-size=Xm is the preferred way to set this to avoid
841 setting a non-pow-2 bad value.
56bb17f2 842
71bfa161
JA
843exitall When one job finishes, terminate the rest. The default is
844 to wait for each job to finish, sometimes that is not the
845 desired action.
846
847bwavgtime=int Average the calculated bandwidth over the given time. Value
6c219763 848 is specified in milliseconds.
71bfa161
JA
849
850create_serialize=bool If true, serialize the file creating for the jobs.
851 This may be handy to avoid interleaving of data
852 files, which may greatly depend on the filesystem
853 used and even the number of processors in the system.
854
855create_fsync=bool fsync the data file after creation. This is the
856 default.
857
814452bd
JA
858create_on_open=bool Don't pre-setup the files for IO, just create open()
859 when it's time to do IO to that file.
860
afad68f7 861pre_read=bool If this is given, files will be pre-read into memory before
34f1c044
JA
862 starting the given IO operation. This will also clear
863 the 'invalidate' flag, since it is pointless to pre-read
9c0d2241
JA
864 and then drop the cache. This will only work for IO engines
865 that are seekable, since they allow you to read the same data
866 multiple times. Thus it will not work on eg network or splice
867 IO.
afad68f7 868
e545a6ce 869unlink=bool Unlink the job files when done. Not the default, as repeated
bf9a3edb
JA
870 runs of that job would then waste time recreating the file
871 set again and again.
71bfa161
JA
872
873loops=int Run the specified number of iterations of this job. Used
874 to repeat the same workload a given number of times. Defaults
875 to 1.
876
68e1f29a 877do_verify=bool Run the verify phase after a write phase. Only makes sense if
e84c73a8
SL
878 verify is set. Defaults to 1.
879
71bfa161
JA
880verify=str If writing to a file, fio can verify the file contents
881 after each iteration of the job. The allowed values are:
882
883 md5 Use an md5 sum of the data area and store
884 it in the header of each block.
885
17dc34df
JA
886 crc64 Use an experimental crc64 sum of the data
887 area and store it in the header of each
888 block.
889
bac39e0e
JA
890 crc32c Use a crc32c sum of the data area and store
891 it in the header of each block.
892
3845591f 893 crc32c-intel Use hardware assisted crc32c calcuation
0539d758
JA
894 provided on SSE4.2 enabled processors. Falls
895 back to regular software crc32c, if not
896 supported by the system.
3845591f 897
71bfa161
JA
898 crc32 Use a crc32 sum of the data area and store
899 it in the header of each block.
900
969f7ed3
JA
901 crc16 Use a crc16 sum of the data area and store
902 it in the header of each block.
903
17dc34df
JA
904 crc7 Use a crc7 sum of the data area and store
905 it in the header of each block.
906
cd14cc10
JA
907 sha512 Use sha512 as the checksum function.
908
909 sha256 Use sha256 as the checksum function.
910
7c353ceb
JA
911 sha1 Use optimized sha1 as the checksum function.
912
7437ee87
SL
913 meta Write extra information about each io
914 (timestamp, block number etc.). The block
996093bb 915 number is verified. See also verify_pattern.
7437ee87 916
36690c9b
JA
917 null Only pretend to verify. Useful for testing
918 internals with ioengine=null, not for much
919 else.
920
6c219763 921 This option can be used for repeated burn-in tests of a
71bfa161 922 system to make sure that the written data is also
b892dc08
JA
923 correctly read back. If the data direction given is
924 a read or random read, fio will assume that it should
925 verify a previously written file. If the data direction
926 includes any form of write, the verify will be of the
927 newly written data.
71bfa161 928
160b966d
JA
929verifysort=bool If set, fio will sort written verify blocks when it deems
930 it faster to read them back in a sorted manner. This is
931 often the case when overwriting an existing file, since
932 the blocks are already laid out in the file system. You
933 can ignore this option unless doing huge amounts of really
934 fast IO where the red-black tree sorting CPU time becomes
935 significant.
3f9f4e26 936
f7fa2653 937verify_offset=int Swap the verification header with data somewhere else
546a9142
SL
938 in the block before writing. Its swapped back before
939 verifying.
940
f7fa2653 941verify_interval=int Write the verification header at a finer granularity
3f9f4e26
SL
942 than the blocksize. It will be written for chunks the
943 size of header_interval. blocksize should divide this
944 evenly.
90059d65 945
0e92f873 946verify_pattern=str If set, fio will fill the io buffers with this
e28218f3
SL
947 pattern. Fio defaults to filling with totally random
948 bytes, but sometimes it's interesting to fill with a known
949 pattern for io verification purposes. Depending on the
950 width of the pattern, fio will fill 1/2/3/4 bytes of the
0e92f873
RR
951 buffer at the time(it can be either a decimal or a hex number).
952 The verify_pattern if larger than a 32-bit quantity has to
996093bb
JA
953 be a hex number that starts with either "0x" or "0X". Use
954 with verify=meta.
e28218f3 955
68e1f29a 956verify_fatal=bool Normally fio will keep checking the entire contents
a12a3b4d
JA
957 before quitting on a block verification failure. If this
958 option is set, fio will exit the job on the first observed
959 failure.
e8462bd8 960
b463e936
JA
961verify_dump=bool If set, dump the contents of both the original data
962 block and the data block we read off disk to files. This
963 allows later analysis to inspect just what kind of data
964 corruption occurred. On by default.
965
e8462bd8
JA
966verify_async=int Fio will normally verify IO inline from the submitting
967 thread. This option takes an integer describing how many
968 async offload threads to create for IO verification instead,
969 causing fio to offload the duty of verifying IO contents
c85c324c
JA
970 to one or more separate threads. If using this offload
971 option, even sync IO engines can benefit from using an
972 iodepth setting higher than 1, as it allows them to have
973 IO in flight while verifies are running.
e8462bd8
JA
974
975verify_async_cpus=str Tell fio to set the given CPU affinity on the
976 async IO verification threads. See cpus_allowed for the
977 format used.
6f87418f
JA
978
979verify_backlog=int Fio will normally verify the written contents of a
980 job that utilizes verify once that job has completed. In
981 other words, everything is written then everything is read
982 back and verified. You may want to verify continually
983 instead for a variety of reasons. Fio stores the meta data
984 associated with an IO block in memory, so for large
985 verify workloads, quite a bit of memory would be used up
986 holding this meta data. If this option is enabled, fio
f42195a3
JA
987 will write only N blocks before verifying these blocks.
988
6f87418f
JA
989 will verify the previously written blocks before continuing
990 to write new ones.
991
992verify_backlog_batch=int Control how many blocks fio will verify
993 if verify_backlog is set. If not set, will default to
994 the value of verify_backlog (meaning the entire queue
f42195a3
JA
995 is read back and verified). If verify_backlog_batch is
996 less than verify_backlog then not all blocks will be verified,
997 if verify_backlog_batch is larger than verify_backlog, some
998 blocks will be verified more than once.
160b966d 999
d392365e
JA
1000stonewall
1001wait_for_previous Wait for preceeding jobs in the job file to exit, before
71bfa161 1002 starting this one. Can be used to insert serialization
b3d62a75
JA
1003 points in the job file. A stone wall also implies starting
1004 a new reporting group.
1005
1006new_group Start a new reporting group. If this option isn't given,
1007 jobs in a file will be part of the same reporting group
bf9a3edb 1008 unless separated by a stone wall (or if it's a group
b3d62a75 1009 by itself, with the numjobs option).
71bfa161
JA
1010
1011numjobs=int Create the specified number of clones of this job. May be
1012 used to setup a larger number of threads/processes doing
fa28c85a
JA
1013 the same thing. We regard that grouping of jobs as a
1014 specific group.
1015
1016group_reporting If 'numjobs' is set, it may be interesting to display
1017 statistics for the group as a whole instead of for each
1018 individual job. This is especially true of 'numjobs' is
1019 large, looking at individual thread/process output quickly
1020 becomes unwieldy. If 'group_reporting' is specified, fio
1021 will show the final report per-group instead of per-job.
71bfa161
JA
1022
1023thread fio defaults to forking jobs, however if this option is
1024 given, fio will use pthread_create(3) to create threads
1025 instead.
1026
f7fa2653 1027zonesize=int Divide a file into zones of the specified size. See zoneskip.
71bfa161 1028
f7fa2653 1029zoneskip=int Skip the specified number of bytes when zonesize data has
71bfa161
JA
1030 been read. The two zone options can be used to only do
1031 io on zones of a file.
1032
076efc7c 1033write_iolog=str Write the issued io patterns to the specified file. See
5b42a488
SH
1034 read_iolog. Specify a separate file for each job, otherwise
1035 the iologs will be interspersed and the file may be corrupt.
71bfa161 1036
076efc7c 1037read_iolog=str Open an iolog with the specified file name and replay the
71bfa161 1038 io patterns it contains. This can be used to store a
6df8adaa
JA
1039 workload and replay it sometime later. The iolog given
1040 may also be a blktrace binary file, which allows fio
1041 to replay a workload captured by blktrace. See blktrace
1042 for how to capture such logging data. For blktrace replay,
1043 the file needs to be turned into a blkparse binary data
ea3e51c3 1044 file first (blkparse <device> -o /dev/null -d file_for_fio.bin).
64bbb865
DN
1045
1046replay_no_stall=int When replaying I/O with read_iolog the default behavior
62776229
JA
1047 is to attempt to respect the time stamps within the log and
1048 replay them with the appropriate delay between IOPS. By
1049 setting this variable fio will not respect the timestamps and
1050 attempt to replay them as fast as possible while still
1051 respecting ordering. The result is the same I/O pattern to a
1052 given device, but different timings.
71bfa161 1053
d1c46c04
DN
1054replay_redirect=str While replaying I/O patterns using read_iolog the
1055 default behavior is to replay the IOPS onto the major/minor
1056 device that each IOP was recorded from. This is sometimes
1057 undesireable because on a different machine those major/minor
1058 numbers can map to a different device. Changing hardware on
1059 the same system can also result in a different major/minor
1060 mapping. Replay_redirect causes all IOPS to be replayed onto
1061 the single specified device regardless of the device it was
1062 recorded from. i.e. replay_redirect=/dev/sdc would cause all
1063 IO in the blktrace to be replayed onto /dev/sdc. This means
1064 multiple devices will be replayed onto a single, if the trace
1065 contains multiple devices. If you want multiple devices to be
1066 replayed concurrently to multiple redirected devices you must
1067 blkparse your trace into separate traces and replay them with
1068 independent fio invocations. Unfortuantely this also breaks
1069 the strict time ordering between multiple device accesses.
1070
e3cedca7 1071write_bw_log=str If given, write a bandwidth log of the jobs in this job
71bfa161 1072 file. Can be used to store data of the bandwidth of the
e0da9bc2
JA
1073 jobs in their lifetime. The included fio_generate_plots
1074 script uses gnuplot to turn these text files into nice
e3cedca7
JA
1075 graphs. See write_log_log for behaviour of given
1076 filename. For this option, the postfix is _bw.log.
71bfa161 1077
e3cedca7 1078write_lat_log=str Same as write_bw_log, except that this option stores io
02af0988
JA
1079 submission, completion, and total latencies instead. If no
1080 filename is given with this option, the default filename of
1081 "jobname_type.log" is used. Even if the filename is given,
1082 fio will still append the type of log. So if one specifies
e3cedca7
JA
1083
1084 write_lat_log=foo
1085
02af0988
JA
1086 The actual log names will be foo_slat.log, foo_slat.log,
1087 and foo_lat.log. This helps fio_generate_plot fine the logs
1088 automatically.
71bfa161 1089
f7fa2653 1090lockmem=int Pin down the specified amount of memory with mlock(2). Can
71bfa161
JA
1091 potentially be used instead of removing memory or booting
1092 with less memory to simulate a smaller amount of memory.
1093
1094exec_prerun=str Before running this job, issue the command specified
1095 through system(3).
1096
1097exec_postrun=str After the job completes, issue the command specified
1098 though system(3).
1099
1100ioscheduler=str Attempt to switch the device hosting the file to the specified
1101 io scheduler before running.
1102
1103cpuload=int If the job is a CPU cycle eater, attempt to use the specified
1104 percentage of CPU cycles.
1105
1106cpuchunks=int If the job is a CPU cycle eater, split the load into
26eca2db 1107 cycles of the given time. In microseconds.
71bfa161 1108
0a839f30
JA
1109disk_util=bool Generate disk utilization statistics, if the platform
1110 supports it. Defaults to on.
1111
02af0988 1112disable_lat=bool Disable measurements of total latency numbers. Useful
9520ebb9
JA
1113 only for cutting back the number of calls to gettimeofday,
1114 as that does impact performance at really high IOPS rates.
1115 Note that to really get rid of a large amount of these
1116 calls, this option must be used with disable_slat and
1117 disable_bw as well.
1118
02af0988
JA
1119disable_clat=bool Disable measurements of completion latency numbers. See
1120 disable_lat.
1121
9520ebb9 1122disable_slat=bool Disable measurements of submission latency numbers. See
02af0988 1123 disable_slat.
9520ebb9
JA
1124
1125disable_bw=bool Disable measurements of throughput/bandwidth numbers. See
02af0988 1126 disable_lat.
9520ebb9 1127
83349190
YH
1128clat_percentiles=bool Enable the reporting of percentiles of
1129 completion latencies.
1130
1131percentile_list=float_list Overwrite the default list of percentiles
1132 for completion latencies. Each number is a floating
1133 number in the range (0,100], and the maximum length of
1134 the list is 20. Use ':' to separate the numbers, and
1135 list the numbers in ascending order. For example,
1136 --percentile_list=99.5:99.9 will cause fio to report
1137 the values of completion latency below which 99.5% and
1138 99.9% of the observed latencies fell, respectively.
1139
993bf48b
JA
1140gtod_reduce=bool Enable all of the gettimeofday() reducing options
1141 (disable_clat, disable_slat, disable_bw) plus reduce
1142 precision of the timeout somewhat to really shrink
1143 the gettimeofday() call count. With this option enabled,
1144 we only do about 0.4% of the gtod() calls we would have
1145 done if all time keeping was enabled.
1146
be4ecfdf
JA
1147gtod_cpu=int Sometimes it's cheaper to dedicate a single thread of
1148 execution to just getting the current time. Fio (and
1149 databases, for instance) are very intensive on gettimeofday()
1150 calls. With this option, you can set one CPU aside for
1151 doing nothing but logging current time to a shared memory
1152 location. Then the other threads/processes that run IO
1153 workloads need only copy that segment, instead of entering
1154 the kernel with a gettimeofday() call. The CPU set aside
1155 for doing these time calls will be excluded from other
1156 uses. Fio will manually clear it from the CPU mask of other
1157 jobs.
a696fa2a 1158
f2bba182
RR
1159continue_on_error=bool Normally fio will exit the job on the first observed
1160 failure. If this option is set, fio will continue the job when
1161 there is a 'non-fatal error' (EIO or EILSEQ) until the runtime
1162 is exceeded or the I/O size specified is completed. If this
1163 option is used, there are two more stats that are appended,
1164 the total error count and the first error. The error field
1165 given in the stats is the first error that was hit during the
1166 run.
be4ecfdf 1167
6adb38a1
JA
1168cgroup=str Add job to this control group. If it doesn't exist, it will
1169 be created. The system must have a mounted cgroup blkio
1170 mount point for this to work. If your system doesn't have it
1171 mounted, you can do so with:
a696fa2a
JA
1172
1173 # mount -t cgroup -o blkio none /cgroup
1174
a696fa2a
JA
1175cgroup_weight=int Set the weight of the cgroup to this value. See
1176 the documentation that comes with the kernel, allowed values
1177 are in the range of 100..1000.
71bfa161 1178
7de87099
VG
1179cgroup_nodelete=bool Normally fio will delete the cgroups it has created after
1180 the job completion. To override this behavior and to leave
1181 cgroups around after the job completion, set cgroup_nodelete=1.
1182 This can be useful if one wants to inspect various cgroup
1183 files after job completion. Default: false
1184
e0b0d892
JA
1185uid=int Instead of running as the invoking user, set the user ID to
1186 this value before the thread/process does any work.
1187
1188gid=int Set group ID, see uid.
1189
71bfa161
JA
11906.0 Interpreting the output
1191---------------------------
1192
1193fio spits out a lot of output. While running, fio will display the
1194status of the jobs created. An example of that would be:
1195
73c8b082 1196Threads: 1: [_r] [24.8% done] [ 13509/ 8334 kb/s] [eta 00h:01m:31s]
71bfa161
JA
1197
1198The characters inside the square brackets denote the current status of
1199each thread. The possible values (in typical life cycle order) are:
1200
1201Idle Run
1202---- ---
1203P Thread setup, but not started.
1204C Thread created.
1205I Thread initialized, waiting.
b0f65863 1206 p Thread running pre-reading file(s).
71bfa161
JA
1207 R Running, doing sequential reads.
1208 r Running, doing random reads.
1209 W Running, doing sequential writes.
1210 w Running, doing random writes.
1211 M Running, doing mixed sequential reads/writes.
1212 m Running, doing mixed random reads/writes.
1213 F Running, currently waiting for fsync()
fc6bd43c 1214 V Running, doing verification of written data.
71bfa161
JA
1215E Thread exited, not reaped by main thread yet.
1216_ Thread reaped.
1217
1218The other values are fairly self explanatory - number of threads
c9f60304
JA
1219currently running and doing io, rate of io since last check (read speed
1220listed first, then write speed), and the estimated completion percentage
1221and time for the running group. It's impossible to estimate runtime of
1222the following groups (if any).
71bfa161
JA
1223
1224When fio is done (or interrupted by ctrl-c), it will show the data for
1225each thread, group of threads, and disks in that order. For each data
1226direction, the output looks like:
1227
1228Client1 (g=0): err= 0:
35649e58 1229 write: io= 32MB, bw= 666KB/s, iops=89 , runt= 50320msec
6104ddb6
JA
1230 slat (msec): min= 0, max= 136, avg= 0.03, stdev= 1.92
1231 clat (msec): min= 0, max= 631, avg=48.50, stdev=86.82
b22989b9 1232 bw (KB/s) : min= 0, max= 1196, per=51.00%, avg=664.02, stdev=681.68
e7823a94 1233 cpu : usr=1.49%, sys=0.25%, ctx=7969, majf=0, minf=17
71619dc2 1234 IO depths : 1=0.1%, 2=0.3%, 4=0.5%, 8=99.0%, 16=0.0%, 32=0.0%, >32=0.0%
838bc709
JA
1235 submit : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0%
1236 complete : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0%
30061b97 1237 issued r/w: total=0/32768, short=0/0
8abdce66
JA
1238 lat (msec): 2=1.6%, 4=0.0%, 10=3.2%, 20=12.8%, 50=38.4%, 100=24.8%,
1239 lat (msec): 250=15.2%, 500=0.0%, 750=0.0%, 1000=0.0%, >=2048=0.0%
71bfa161
JA
1240
1241The client number is printed, along with the group id and error of that
1242thread. Below is the io statistics, here for writes. In the order listed,
1243they denote:
1244
1245io= Number of megabytes io performed
1246bw= Average bandwidth rate
35649e58 1247iops= Average IOs performed per second
71bfa161 1248runt= The runtime of that thread
72fbda2a 1249 slat= Submission latency (avg being the average, stdev being the
71bfa161
JA
1250 standard deviation). This is the time it took to submit
1251 the io. For sync io, the slat is really the completion
8a35c71e 1252 latency, since queue/complete is one operation there. This
bf9a3edb 1253 value can be in milliseconds or microseconds, fio will choose
8a35c71e 1254 the most appropriate base and print that. In the example
bf9a3edb 1255 above, milliseconds is the best scale.
71bfa161
JA
1256 clat= Completion latency. Same names as slat, this denotes the
1257 time from submission to completion of the io pieces. For
1258 sync io, clat will usually be equal (or very close) to 0,
1259 as the time from submit to complete is basically just
1260 CPU time (io has already been done, see slat explanation).
1261 bw= Bandwidth. Same names as the xlat stats, but also includes
1262 an approximate percentage of total aggregate bandwidth
1263 this thread received in this group. This last value is
1264 only really useful if the threads in this group are on the
1265 same disk, since they are then competing for disk access.
1266cpu= CPU usage. User and system time, along with the number
e7823a94
JA
1267 of context switches this thread went through, usage of
1268 system and user time, and finally the number of major
1269 and minor page faults.
71619dc2
JA
1270IO depths= The distribution of io depths over the job life time. The
1271 numbers are divided into powers of 2, so for example the
1272 16= entries includes depths up to that value but higher
1273 than the previous entry. In other words, it covers the
1274 range from 16 to 31.
838bc709
JA
1275IO submit= How many pieces of IO were submitting in a single submit
1276 call. Each entry denotes that amount and below, until
1277 the previous entry - eg, 8=100% mean that we submitted
1278 anywhere in between 5-8 ios per submit call.
1279IO complete= Like the above submit number, but for completions instead.
30061b97
JA
1280IO issued= The number of read/write requests issued, and how many
1281 of them were short.
ec118304
JA
1282IO latencies= The distribution of IO completion latencies. This is the
1283 time from when IO leaves fio and when it gets completed.
1284 The numbers follow the same pattern as the IO depths,
1285 meaning that 2=1.6% means that 1.6% of the IO completed
8abdce66
JA
1286 within 2 msecs, 20=12.8% means that 12.8% of the IO
1287 took more than 10 msecs, but less than (or equal to) 20 msecs.
71bfa161
JA
1288
1289After each client has been listed, the group statistics are printed. They
1290will look like this:
1291
1292Run status group 0 (all jobs):
b22989b9
JA
1293 READ: io=64MB, aggrb=22178, minb=11355, maxb=11814, mint=2840msec, maxt=2955msec
1294 WRITE: io=64MB, aggrb=1302, minb=666, maxb=669, mint=50093msec, maxt=50320msec
71bfa161
JA
1295
1296For each data direction, it prints:
1297
1298io= Number of megabytes io performed.
1299aggrb= Aggregate bandwidth of threads in this group.
1300minb= The minimum average bandwidth a thread saw.
1301maxb= The maximum average bandwidth a thread saw.
1302mint= The smallest runtime of the threads in that group.
1303maxt= The longest runtime of the threads in that group.
1304
1305And finally, the disk statistics are printed. They will look like this:
1306
1307Disk stats (read/write):
1308 sda: ios=16398/16511, merge=30/162, ticks=6853/819634, in_queue=826487, util=100.00%
1309
1310Each value is printed for both reads and writes, with reads first. The
1311numbers denote:
1312
1313ios= Number of ios performed by all groups.
1314merge= Number of merges io the io scheduler.
1315ticks= Number of ticks we kept the disk busy.
1316io_queue= Total time spent in the disk queue.
1317util= The disk utilization. A value of 100% means we kept the disk
1318 busy constantly, 50% would be a disk idling half of the time.
1319
1320
13217.0 Terse output
1322----------------
1323
1324For scripted usage where you typically want to generate tables or graphs
6af019c9 1325of the results, fio can output the results in a semicolon separated format.
71bfa161
JA
1326The format is one long line of values, such as:
1327
562c2d2f
DN
13282;card0;0;0;7139336;121836;60004;1;10109;27.932460;116.933948;220;126861;3495.446807;1085.368601;226;126864;3523.635629;1089.012448;24063;99944;50.275485%;59818.274627;5540.657370;7155060;122104;60004;1;8338;29.086342;117.839068;388;128077;5032.488518;1234.785715;391;128085;5061.839412;1236.909129;23436;100928;50.287926%;59964.832030;5644.844189;14.595833%;19.394167%;123706;0;7313;0.1%;0.1%;0.1%;0.1%;0.1%;0.1%;100.0%;0.00%;0.00%;0.00%;0.00%;0.00%;0.00%;0.01%;0.02%;0.05%;0.16%;6.04%;40.40%;52.68%;0.64%;0.01%;0.00%;0.01%;0.00%;0.00%;0.00%;0.00%;0.00%
1329A description of this job goes here.
1330
1331The job description (if provided) follows on a second line.
71bfa161 1332
525c2bfa
JA
1333To enable terse output, use the --minimal command line option. The first
1334value is the version of the terse output format. If the output has to
1335be changed for some reason, this number will be incremented by 1 to
1336signify that change.
6820cb3b 1337
71bfa161
JA
1338Split up, the format is as follows:
1339
525c2bfa 1340 version, jobname, groupid, error
71bfa161 1341 READ status:
b22989b9 1342 KB IO, bandwidth (KB/sec), runtime (msec)
71bfa161
JA
1343 Submission latency: min, max, mean, deviation
1344 Completion latency: min, max, mean, deviation
525c2bfa 1345 Total latency: min, max, mean, deviation
6c219763 1346 Bw: min, max, aggregate percentage of total, mean, deviation
71bfa161 1347 WRITE status:
b22989b9 1348 KB IO, bandwidth (KB/sec), runtime (msec)
71bfa161
JA
1349 Submission latency: min, max, mean, deviation
1350 Completion latency: min, max, mean, deviation
525c2bfa 1351 Total latency: min, max, mean, deviation
6c219763 1352 Bw: min, max, aggregate percentage of total, mean, deviation
046ee302 1353 CPU usage: user, system, context switches, major faults, minor faults
2270890c 1354 IO depths: <=1, 2, 4, 8, 16, 32, >=64
562c2d2f
DN
1355 IO latencies microseconds: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
1356 IO latencies milliseconds: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000
1357 Additional Info (dependant on continue_on_error, default off): total # errors, first error code
1358
f42195a3 1359 Additional Info (dependant on description being set): Text description
25c8b9d7
PD
1360
1361
13628.0 Trace file format
1363---------------------
1364There are two trace file format that you can encounter. The older (v1) format
1365is unsupported since version 1.20-rc3 (March 2008). It will still be described
1366below in case that you get an old trace and want to understand it.
1367
1368In any case the trace is a simple text file with a single action per line.
1369
1370
13718.1 Trace file format v1
1372------------------------
1373Each line represents a single io action in the following format:
1374
1375rw, offset, length
1376
1377where rw=0/1 for read/write, and the offset and length entries being in bytes.
1378
1379This format is not supported in Fio versions => 1.20-rc3.
1380
1381
13828.2 Trace file format v2
1383------------------------
1384The second version of the trace file format was added in Fio version 1.17.
1385It allows to access more then one file per trace and has a bigger set of
1386possible file actions.
1387
1388The first line of the trace file has to be:
1389
1390fio version 2 iolog
1391
1392Following this can be lines in two different formats, which are described below.
1393
1394The file management format:
1395
1396filename action
1397
1398The filename is given as an absolute path. The action can be one of these:
1399
1400add Add the given filename to the trace
1401open Open the file with the given filename. The filename has to have
1402 been added with the add action before.
1403close Close the file with the given filename. The file has to have been
1404 opened before.
1405
1406
1407The file io action format:
1408
1409filename action offset length
1410
1411The filename is given as an absolute path, and has to have been added and opened
1412before it can be used with this format. The offset and length are given in
1413bytes. The action can be one of these:
1414
1415wait Wait for 'offset' microseconds. Everything below 100 is discarded.
1416read Read 'length' bytes beginning from 'offset'
1417write Write 'length' bytes beginning from 'offset'
1418sync fsync() the file
1419datasync fdatasync() the file
1420trim trim the given file from the given 'offset' for 'length' bytes