Addedd -z option to specify file size for filepaths fio files
[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
43f09da1 129. CPU idleness profiling
71bfa161
JA
13
141.0 Overview and history
15------------------------
16fio was originally written to save me the hassle of writing special test
17case programs when I wanted to test a specific workload, either for
18performance reasons or to find/reproduce a bug. The process of writing
19such a test app can be tiresome, especially if you have to do it often.
20Hence I needed a tool that would be able to simulate a given io workload
21without resorting to writing a tailored test case again and again.
22
23A test work load is difficult to define, though. There can be any number
24of processes or threads involved, and they can each be using their own
25way of generating io. You could have someone dirtying large amounts of
26memory in an memory mapped file, or maybe several threads issuing
27reads using asynchronous io. fio needed to be flexible enough to
28simulate both of these cases, and many more.
29
302.0 How fio works
31-----------------
32The first step in getting fio to simulate a desired io workload, is
33writing a job file describing that specific setup. A job file may contain
34any number of threads and/or files - the typical contents of the job file
35is a global section defining shared parameters, and one or more job
36sections describing the jobs involved. When run, fio parses this file
37and sets everything up as described. If we break down a job from top to
38bottom, it contains the following basic parameters:
39
40 IO type Defines the io pattern issued to the file(s).
41 We may only be reading sequentially from this
42 file(s), or we may be writing randomly. Or even
43 mixing reads and writes, sequentially or randomly.
44
45 Block size In how large chunks are we issuing io? This may be
46 a single value, or it may describe a range of
47 block sizes.
48
49 IO size How much data are we going to be reading/writing.
50
51 IO engine How do we issue io? We could be memory mapping the
52 file, we could be using regular read/write, we
d0ff85df 53 could be using splice, async io, syslet, or even
71bfa161
JA
54 SG (SCSI generic sg).
55
6c219763 56 IO depth If the io engine is async, how large a queuing
71bfa161
JA
57 depth do we want to maintain?
58
59 IO type Should we be doing buffered io, or direct/raw io?
60
61 Num files How many files are we spreading the workload over.
62
63 Num threads How many threads or processes should we spread
64 this workload over.
66c098b8 65
71bfa161
JA
66The above are the basic parameters defined for a workload, in addition
67there's a multitude of parameters that modify other aspects of how this
68job behaves.
69
70
713.0 Running fio
72---------------
73See the README file for command line parameters, there are only a few
74of them.
75
76Running fio is normally the easiest part - you just give it the job file
77(or job files) as parameters:
78
79$ fio job_file
80
81and it will start doing what the job_file tells it to do. You can give
82more than one job file on the command line, fio will serialize the running
83of those files. Internally that is the same as using the 'stonewall'
550b1db6 84parameter described in the parameter section.
71bfa161 85
b4692828
JA
86If the job file contains only one job, you may as well just give the
87parameters on the command line. The command line parameters are identical
88to the job parameters, with a few extra that control global parameters
89(see README). For example, for the job file parameter iodepth=2, the
c2b1e753
JA
90mirror command line option would be --iodepth 2 or --iodepth=2. You can
91also use the command line for giving more than one job entry. For each
92--name option that fio sees, it will start a new job with that name.
93Command line entries following a --name entry will apply to that job,
94until there are no more entries or a new --name entry is seen. This is
95similar to the job file options, where each option applies to the current
96job until a new [] job entry is seen.
b4692828 97
71bfa161
JA
98fio does not need to run as root, except if the files or devices specified
99in the job section requires that. Some other options may also be restricted,
6c219763 100such as memory locking, io scheduler switching, and decreasing the nice value.
71bfa161
JA
101
102
1034.0 Job file format
104-------------------
105As previously described, fio accepts one or more job files describing
106what it is supposed to do. The job file format is the classic ini file,
107where the names enclosed in [] brackets define the job name. You are free
108to use any ascii name you want, except 'global' which has special meaning.
109A global section sets defaults for the jobs described in that file. A job
110may override a global section parameter, and a job file may even have
111several global sections if so desired. A job is only affected by a global
65db0851
JA
112section residing above it. If the first character in a line is a ';' or a
113'#', the entire line is discarded as a comment.
71bfa161 114
3c54bc46 115So let's look at a really simple job file that defines two processes, each
b22989b9 116randomly reading from a 128MB file.
71bfa161
JA
117
118; -- start job file --
119[global]
120rw=randread
121size=128m
122
123[job1]
124
125[job2]
126
127; -- end job file --
128
129As you can see, the job file sections themselves are empty as all the
130described parameters are shared. As no filename= option is given, fio
c2b1e753
JA
131makes up a filename for each of the jobs as it sees fit. On the command
132line, this job would look as follows:
133
134$ fio --name=global --rw=randread --size=128m --name=job1 --name=job2
135
71bfa161 136
3c54bc46 137Let's look at an example that has a number of processes writing randomly
71bfa161
JA
138to files.
139
140; -- start job file --
141[random-writers]
142ioengine=libaio
143iodepth=4
144rw=randwrite
145bs=32k
146direct=0
147size=64m
148numjobs=4
149
150; -- end job file --
151
152Here we have no global section, as we only have one job defined anyway.
153We want to use async io here, with a depth of 4 for each file. We also
b22989b9 154increased the buffer size used to 32KB and define numjobs to 4 to
71bfa161 155fork 4 identical jobs. The result is 4 processes each randomly writing
b22989b9 156to their own 64MB file. Instead of using the above job file, you could
b4692828
JA
157have given the parameters on the command line. For this case, you would
158specify:
159
160$ fio --name=random-writers --ioengine=libaio --iodepth=4 --rw=randwrite --bs=32k --direct=0 --size=64m --numjobs=4
71bfa161 161
df5ad464
AK
162When fio is utilized as a basis of any reasonably large test suite, it might be
163desirable to share a set of standardized settings across multiple job files.
164Instead of copy/pasting such settings, any section may pull in an external
165.fio file with 'include filename' directive, as in the following example:
166
167; -- start job file including.fio --
168[global]
169filename=/tmp/test
170filesize=1m
171include glob-include.fio
172
173[test]
174rw=randread
175bs=4k
176time_based=1
177runtime=10
178include test-include.fio
179; -- end job file including.fio --
180
181; -- start job file glob-include.fio --
182thread=1
183group_reporting=1
184; -- end job file glob-include.fio --
185
186; -- start job file test-include.fio --
187ioengine=libaio
188iodepth=4
189; -- end job file test-include.fio --
190
191Settings pulled into a section apply to that section only (except global
192section). Include directives may be nested in that any included file may
73568e1b
JA
193contain further include directive(s). Include files may not contain []
194sections.
df5ad464
AK
195
196
74929ac2
JA
1974.1 Environment variables
198-------------------------
199
3c54bc46
AC
200fio also supports environment variable expansion in job files. Any
201substring of the form "${VARNAME}" as part of an option value (in other
202words, on the right of the `='), will be expanded to the value of the
203environment variable called VARNAME. If no such environment variable
204is defined, or VARNAME is the empty string, the empty string will be
205substituted.
206
207As an example, let's look at a sample fio invocation and job file:
208
209$ SIZE=64m NUMJOBS=4 fio jobfile.fio
210
211; -- start job file --
212[random-writers]
213rw=randwrite
214size=${SIZE}
215numjobs=${NUMJOBS}
216; -- end job file --
217
218This will expand to the following equivalent job file at runtime:
219
220; -- start job file --
221[random-writers]
222rw=randwrite
223size=64m
224numjobs=4
225; -- end job file --
226
71bfa161
JA
227fio ships with a few example job files, you can also look there for
228inspiration.
229
74929ac2
JA
2304.2 Reserved keywords
231---------------------
232
233Additionally, fio has a set of reserved keywords that will be replaced
234internally with the appropriate value. Those keywords are:
235
236$pagesize The architecture page size of the running system
237$mb_memory Megabytes of total memory in the system
238$ncpus Number of online available CPUs
239
240These can be used on the command line or in the job file, and will be
241automatically substituted with the current system values when the job
892a6ffc
JA
242is run. Simple math is also supported on these keywords, so you can
243perform actions like:
244
245size=8*$mb_memory
246
247and get that properly expanded to 8 times the size of memory in the
248machine.
74929ac2 249
71bfa161
JA
250
2515.0 Detailed list of parameters
252-------------------------------
253
254This section describes in details each parameter associated with a job.
255Some parameters take an option of a given type, such as an integer or
d59aa780
JA
256a string. Anywhere a numeric value is required, an arithmetic expression
257may be used, provided it is surrounded by parentheses. Supported operators
258are:
259
260 addition (+)
261 subtraction (-)
262 multiplication (*)
263 division (/)
264 modulus (%)
265 exponentiation (^)
266
267For time values in expressions, units are microseconds by default. This is
268different than for time values not in expressions (not enclosed in
269parentheses). The following types are used:
71bfa161
JA
270
271str String. This is a sequence of alpha characters.
b09da8fa 272time Integer with possible time suffix. In seconds unless otherwise
e417fd66 273 specified, use eg 10m for 10 minutes. Accepts s/m/h for seconds,
0de5b26f
JA
274 minutes, and hours, and accepts 'ms' (or 'msec') for milliseconds,
275 and 'us' (or 'usec') for microseconds.
b09da8fa
JA
276int SI integer. A whole number value, which may contain a suffix
277 describing the base of the number. Accepted suffixes are k/m/g/t/p,
278 meaning kilo, mega, giga, tera, and peta. The suffix is not case
57fc29fa
JA
279 sensitive, and you may also include trailing 'b' (eg 'kb' is the same
280 as 'k'). So if you want to specify 4096, you could either write
b09da8fa 281 out '4096' or just give 4k. The suffixes signify base 2 values, so
57fc29fa
JA
282 1024 is 1k and 1024k is 1m and so on, unless the suffix is explicitly
283 set to a base 10 value using 'kib', 'mib', 'gib', etc. If that is the
284 case, then 1000 is used as the multiplier. This can be handy for
285 disks, since manufacturers generally use base 10 values when listing
286 the capacity of a drive. If the option accepts an upper and lower
287 range, use a colon ':' or minus '-' to separate such values. May also
288 include a prefix to indicate numbers base. If 0x is used, the number
289 is assumed to be hexadecimal. See irange.
71bfa161
JA
290bool Boolean. Usually parsed as an integer, however only defined for
291 true and false (1 and 0).
b09da8fa 292irange Integer range with suffix. Allows value range to be given, such
bf9a3edb 293 as 1024-4096. A colon may also be used as the separator, eg
0c9baf91
JA
294 1k:4k. If the option allows two sets of ranges, they can be
295 specified with a ',' or '/' delimiter: 1k-4k/8k-32k. Also see
f7fa2653 296 int.
83349190 297float_list A list of floating numbers, separated by a ':' character.
71bfa161
JA
298
299With the above in mind, here follows the complete list of fio job
300parameters.
301
302name=str ASCII name of the job. This may be used to override the
303 name printed by fio for this job. Otherwise the job
c2b1e753 304 name is used. On the command line this parameter has the
6c219763 305 special purpose of also signaling the start of a new
c2b1e753 306 job.
71bfa161 307
61697c37
JA
308description=str Text description of the job. Doesn't do anything except
309 dump this text description when this job is run. It's
310 not parsed.
311
3776041e 312directory=str Prefix filenames with this directory. Used to place files
67445b63
JA
313 in a different location than "./". See the 'filename' option
314 for escaping certain characters.
71bfa161
JA
315
316filename=str Fio normally makes up a filename based on the job name,
317 thread number, and file number. If you want to share
318 files between threads in a job or several jobs, specify
ed92ac0c 319 a filename for each of them to override the default. If
414c2a3e 320 the ioengine used is 'net', the filename is the host, port,
0fd666bf 321 and protocol to use in the format of =host,port,protocol.
414c2a3e
JA
322 See ioengine=net for more. If the ioengine is file based, you
323 can specify a number of files by separating the names with a
324 ':' colon. So if you wanted a job to open /dev/sda and /dev/sdb
325 as the two working files, you would use
30a4588a
JA
326 filename=/dev/sda:/dev/sdb. On Windows, disk devices are
327 accessed as \\.\PhysicalDrive0 for the first device,
328 \\.\PhysicalDrive1 for the second etc. Note: Windows and
329 FreeBSD prevent write access to areas of the disk containing
330 in-use data (e.g. filesystems).
331 If the wanted filename does need to include a colon, then
332 escape that with a '\' character. For instance, if the filename
333 is "/dev/dsk/foo@3,0:c", then you would use
334 filename="/dev/dsk/foo@3,0\:c". '-' is a reserved name, meaning
335 stdin or stdout. Which of the two depends on the read/write
336 direction set.
71bfa161 337
de98bd30
JA
338filename_format=str
339 If sharing multiple files between jobs, it is usually necessary
340 to have fio generate the exact names that you want. By default,
341 fio will name a file based on the default file format
342 specification of jobname.jobnumber.filenumber. With this
343 option, that can be customized. Fio will recognize and replace
344 the following keywords in this string:
345
346 $jobname
347 The name of the worker thread or process.
348
349 $jobnum
350 The incremental number of the worker thread or
351 process.
352
353 $filenum
354 The incremental number of the file for that worker
355 thread or process.
356
357 To have dependent jobs share a set of files, this option can
358 be set to have fio generate filenames that are shared between
359 the two. For instance, if testfiles.$filenum is specified,
360 file number 4 for any job will be named testfiles.4. The
361 default of $jobname.$jobnum.$filenum will be used if
362 no other format specifier is given.
363
bbf6b540
JA
364opendir=str Tell fio to recursively add any file it can find in this
365 directory and down the file system tree.
366
3776041e 367lockfile=str Fio defaults to not locking any files before it does
4d4e80f2
JA
368 IO to them. If a file or file descriptor is shared, fio
369 can serialize IO to that file to make the end result
370 consistent. This is usual for emulating real workloads that
371 share files. The lock modes are:
372
373 none No locking. The default.
374 exclusive Only one thread/process may do IO,
375 excluding all others.
376 readwrite Read-write locking on the file. Many
377 readers may access the file at the
378 same time, but writes get exclusive
379 access.
380
d3aad8f2 381readwrite=str
71bfa161
JA
382rw=str Type of io pattern. Accepted values are:
383
384 read Sequential reads
385 write Sequential writes
386 randwrite Random writes
387 randread Random reads
10b023db 388 rw,readwrite Sequential mixed reads and writes
71bfa161
JA
389 randrw Random mixed reads and writes
390
391 For the mixed io types, the default is to split them 50/50.
392 For certain types of io the result may still be skewed a bit,
211097b2 393 since the speed may be different. It is possible to specify
38dad62d 394 a number of IO's to do before getting a new offset, this is
892ea9bd 395 done by appending a ':<nr>' to the end of the string given.
38dad62d 396 For a random read, it would look like 'rw=randread:8' for
059b0802 397 passing in an offset modifier with a value of 8. If the
ddb754db 398 suffix is used with a sequential IO pattern, then the value
059b0802
JA
399 specified will be added to the generated offset for each IO.
400 For instance, using rw=write:4k will skip 4k for every
401 write. It turns sequential IO into sequential IO with holes.
402 See the 'rw_sequencer' option.
38dad62d
JA
403
404rw_sequencer=str If an offset modifier is given by appending a number to
405 the rw=<str> line, then this option controls how that
406 number modifies the IO offset being generated. Accepted
407 values are:
408
409 sequential Generate sequential offset
410 identical Generate the same offset
411
412 'sequential' is only useful for random IO, where fio would
413 normally generate a new random offset for every IO. If you
414 append eg 8 to randread, you would get a new random offset for
211097b2
JA
415 every 8 IO's. The result would be a seek for only every 8
416 IO's, instead of for every IO. Use rw=randread:8 to specify
38dad62d
JA
417 that. As sequential IO is already sequential, setting
418 'sequential' for that would not result in any differences.
419 'identical' behaves in a similar fashion, except it sends
420 the same offset 8 number of times before generating a new
421 offset.
71bfa161 422
90fef2d1
JA
423kb_base=int The base unit for a kilobyte. The defacto base is 2^10, 1024.
424 Storage manufacturers like to use 10^3 or 1000 as a base
425 ten unit instead, for obvious reasons. Allow values are
426 1024 or 1000, with 1024 being the default.
427
771e58be
JA
428unified_rw_reporting=bool Fio normally reports statistics on a per
429 data direction basis, meaning that read, write, and trim are
430 accounted and reported separately. If this option is set,
431 the fio will sum the results and report them as "mixed"
432 instead.
433
ee738499
JA
434randrepeat=bool For random IO workloads, seed the generator in a predictable
435 way so that results are repeatable across repetitions.
436
04778baf
JA
437randseed=int Seed the random number generators based on this seed value, to
438 be able to control what sequence of output is being generated.
439 If not set, the random sequence depends on the randrepeat
440 setting.
441
a596f047
EG
442fallocate=str Whether pre-allocation is performed when laying down files.
443 Accepted values are:
444
445 none Do not pre-allocate space
446 posix Pre-allocate via posix_fallocate()
447 keep Pre-allocate via fallocate() with
448 FALLOC_FL_KEEP_SIZE set
449 0 Backward-compatible alias for 'none'
450 1 Backward-compatible alias for 'posix'
451
452 May not be available on all supported platforms. 'keep' is only
453 available on Linux.If using ZFS on Solaris this must be set to
454 'none' because ZFS doesn't support it. Default: 'posix'.
7bc8c2cf 455
d2f3ac35
JA
456fadvise_hint=bool By default, fio will use fadvise() to advise the kernel
457 on what IO patterns it is likely to issue. Sometimes you
458 want to test specific IO patterns without telling the
459 kernel about it, in which case you can disable this option.
460 If set, fio will use POSIX_FADV_SEQUENTIAL for sequential
461 IO and POSIX_FADV_RANDOM for random IO.
462
f7fa2653 463size=int The total size of file io for this job. Fio will run until
7616cafe 464 this many bytes has been transferred, unless runtime is
a4d3b4db
JA
465 limited by other options (such as 'runtime', for instance,
466 or increased/decreased by 'io_size'). Unless specific nrfiles
467 and filesize options are given, fio will divide this size
468 between the available files specified by the job. If not set,
469 fio will use the full size of the given files or devices.
470 If the files do not exist, size must be given. It is also
471 possible to give size as a percentage between 1 and 100. If
472 size=20% is given, fio will use 20% of the full size of the
473 given files or devices.
474
475io_size=int
77731b29
JA
476io_limit=int Normally fio operates within the region set by 'size', which
477 means that the 'size' option sets both the region and size of
478 IO to be performed. Sometimes that is not what you want. With
479 this option, it is possible to define just the amount of IO
480 that fio should do. For instance, if 'size' is set to 20G and
a4d3b4db
JA
481 'io_size' is set to 5G, fio will perform IO within the first
482 20G but exit when 5G have been done. The opposite is also
483 possible - if 'size' is set to 20G, and 'io_size' is set to
484 40G, then fio will do 40G of IO within the 0..20G region.
77731b29 485
f7fa2653 486filesize=int Individual file sizes. May be a range, in which case fio
9c60ce64
JA
487 will select sizes for files at random within the given range
488 and limited to 'size' in total (if that is given). If not
489 given, each created file is the same size.
490
bedc9dc2
JA
491file_append=bool Perform IO after the end of the file. Normally fio will
492 operate within the size of a file. If this option is set, then
493 fio will append to the file instead. This has identical
0aae4ce7
JA
494 behavior to setting offset to the size of a file. This option
495 is ignored on non-regular files.
bedc9dc2 496
74586c1e
JA
497fill_device=bool
498fill_fs=bool Sets size to something really large and waits for ENOSPC (no
aa31f1f1 499 space left on device) as the terminating condition. Only makes
de98bd30 500 sense with sequential write. For a read workload, the mount
4f12432e
JA
501 point will be filled first then IO started on the result. This
502 option doesn't make sense if operating on a raw device node,
503 since the size of that is already known by the file system.
504 Additionally, writing beyond end-of-device will not return
505 ENOSPC there.
aa31f1f1 506
f7fa2653
JA
507blocksize=int
508bs=int The block size used for the io units. Defaults to 4k. Values
509 can be given for both read and writes. If a single int is
510 given, it will apply to both. If a second int is specified
f90eff5a 511 after a comma, it will apply to writes only. In other words,
d9472271
JA
512 the format is either bs=read_and_write or bs=read,write,trim.
513 bs=4k,8k will thus use 4k blocks for reads, 8k blocks for
514 writes, and 8k for trims. You can terminate the list with
515 a trailing comma. bs=4k,8k, would use the default value for
516 trims.. If you only wish to set the write size, you
787f7e95
JA
517 can do so by passing an empty read size - bs=,8k will set
518 8k for writes and leave the read default value.
a00735e6 519
2b7a01d0
JA
520blockalign=int
521ba=int At what boundary to align random IO offsets. Defaults to
522 the same as 'blocksize' the minimum blocksize given.
523 Minimum alignment is typically 512b for using direct IO,
524 though it usually depends on the hardware block size. This
525 option is mutually exclusive with using a random map for
526 files, so it will turn off that option.
527
d3aad8f2 528blocksize_range=irange
71bfa161
JA
529bsrange=irange Instead of giving a single block size, specify a range
530 and fio will mix the issued io block sizes. The issued
531 io unit will always be a multiple of the minimum value
f90eff5a
JA
532 given (also see bs_unaligned). Applies to both reads and
533 writes, however a second range can be given after a comma.
534 See bs=.
a00735e6 535
564ca972
JA
536bssplit=str Sometimes you want even finer grained control of the
537 block sizes issued, not just an even split between them.
538 This option allows you to weight various block sizes,
539 so that you are able to define a specific amount of
540 block sizes issued. The format for this option is:
541
542 bssplit=blocksize/percentage:blocksize/percentage
543
544 for as many block sizes as needed. So if you want to define
545 a workload that has 50% 64k blocks, 10% 4k blocks, and
546 40% 32k blocks, you would write:
547
548 bssplit=4k/10:64k/50:32k/40
549
550 Ordering does not matter. If the percentage is left blank,
551 fio will fill in the remaining values evenly. So a bssplit
552 option like this one:
553
554 bssplit=4k/50:1k/:32k/
555
556 would have 50% 4k ios, and 25% 1k and 32k ios. The percentages
557 always add up to 100, if bssplit is given a range that adds
558 up to more, it will error out.
559
720e84ad
JA
560 bssplit also supports giving separate splits to reads and
561 writes. The format is identical to what bs= accepts. You
562 have to separate the read and write parts with a comma. So
563 if you want a workload that has 50% 2k reads and 50% 4k reads,
564 while having 90% 4k writes and 10% 8k writes, you would
565 specify:
566
892ea9bd 567 bssplit=2k/50:4k/50,4k/90:8k/10
720e84ad 568
d3aad8f2 569blocksize_unaligned
690adba3
JA
570bs_unaligned If this option is given, any byte size value within bsrange
571 may be used as a block range. This typically wont work with
572 direct IO, as that normally requires sector alignment.
71bfa161 573
6aca9b3d
JA
574bs_is_seq_rand If this option is set, fio will use the normal read,write
575 blocksize settings as sequential,random instead. Any random
576 read or write will use the WRITE blocksize settings, and any
577 sequential read or write will use the READ blocksize setting.
578
e9459e5a
JA
579zero_buffers If this option is given, fio will init the IO buffers to
580 all zeroes. The default is to fill them with random data.
581
5973cafb
JA
582refill_buffers If this option is given, fio will refill the IO buffers
583 on every submit. The default is to only fill it at init
584 time and reuse that data. Only makes sense if zero_buffers
41ccd845
JA
585 isn't specified, naturally. If data verification is enabled,
586 refill_buffers is also automatically enabled.
5973cafb 587
fd68418e
JA
588scramble_buffers=bool If refill_buffers is too costly and the target is
589 using data deduplication, then setting this option will
590 slightly modify the IO buffer contents to defeat normal
591 de-dupe attempts. This is not enough to defeat more clever
592 block compression attempts, but it will stop naive dedupe of
593 blocks. Default: true.
594
c5751c62
JA
595buffer_compress_percentage=int If this is set, then fio will attempt to
596 provide IO buffer content (on WRITEs) that compress to
597 the specified level. Fio does this by providing a mix of
d1af2894
JA
598 random data and a fixed pattern. The fixed pattern is either
599 zeroes, or the pattern specified by buffer_pattern. If the
600 pattern option is used, it might skew the compression ratio
601 slightly. Note that this is per block size unit, for file/disk
602 wide compression level that matches this setting, you'll also
603 want to set refill_buffers.
c5751c62
JA
604
605buffer_compress_chunk=int See buffer_compress_percentage. This
606 setting allows fio to manage how big the ranges of random
607 data and zeroed data is. Without this set, fio will
608 provide buffer_compress_percentage of blocksize random
609 data, followed by the remaining zeroed. With this set
610 to some chunk size smaller than the block size, fio can
611 alternate random and zeroed data throughout the IO
612 buffer.
613
5c94b008
JA
614buffer_pattern=str If set, fio will fill the io buffers with this
615 pattern. If not set, the contents of io buffers is defined by
616 the other options related to buffer contents. The setting can
617 be any pattern of bytes, and can be prefixed with 0x for hex
618 values. It may also be a string, where the string must then
619 be wrapped with "".
620
621dedupe_percentage=int If set, fio will generate this percentage of
622 identical buffers when writing. These buffers will be
623 naturally dedupable. The contents of the buffers depend on
624 what other buffer compression settings have been set. It's
625 possible to have the individual buffers either fully
626 compressible, or not at all. This option only controls the
627 distribution of unique buffers.
ce35b1ec 628
71bfa161
JA
629nrfiles=int Number of files to use for this job. Defaults to 1.
630
390b1537
JA
631openfiles=int Number of files to keep open at the same time. Defaults to
632 the same as nrfiles, can be set smaller to limit the number
633 simultaneous opens.
634
5af1c6f3
JA
635file_service_type=str Defines how fio decides which file from a job to
636 service next. The following types are defined:
637
638 random Just choose a file at random.
639
640 roundrobin Round robin over open files. This
641 is the default.
642
a086c257
JA
643 sequential Finish one file before moving on to
644 the next. Multiple files can still be
645 open depending on 'openfiles'.
646
1907dbc6
JA
647 The string can have a number appended, indicating how
648 often to switch to a new file. So if option random:4 is
649 given, fio will switch to a new random file after 4 ios
650 have been issued.
651
71bfa161
JA
652ioengine=str Defines how the job issues io to the file. The following
653 types are defined:
654
655 sync Basic read(2) or write(2) io. lseek(2) is
656 used to position the io location.
657
a31041ea 658 psync Basic pread(2) or pwrite(2) io.
659
e05af9e5 660 vsync Basic readv(2) or writev(2) IO.
1d2af02a 661
a46c5e01
JA
662 psyncv Basic preadv(2) or pwritev(2) IO.
663
15d182aa
JA
664 libaio Linux native asynchronous io. Note that Linux
665 may only support queued behaviour with
666 non-buffered IO (set direct=1 or buffered=0).
de890a1e 667 This engine defines engine specific options.
71bfa161
JA
668
669 posixaio glibc posix asynchronous io.
670
417f0068
JA
671 solarisaio Solaris native asynchronous io.
672
03e20d68
BC
673 windowsaio Windows native asynchronous io.
674
71bfa161
JA
675 mmap File is memory mapped and data copied
676 to/from using memcpy(3).
677
678 splice splice(2) is used to transfer the data and
679 vmsplice(2) to transfer data from user
680 space to the kernel.
681
d0ff85df
JA
682 syslet-rw Use the syslet system calls to make
683 regular read/write async.
684
71bfa161 685 sg SCSI generic sg v3 io. May either be
6c219763 686 synchronous using the SG_IO ioctl, or if
71bfa161
JA
687 the target is an sg character device
688 we use read(2) and write(2) for asynchronous
689 io.
690
a94ea28b
JA
691 null Doesn't transfer any data, just pretends
692 to. This is mainly used to exercise fio
693 itself and for debugging/testing purposes.
694
ed92ac0c 695 net Transfer over the network to given host:port.
de890a1e
SL
696 Depending on the protocol used, the hostname,
697 port, listen and filename options are used to
698 specify what sort of connection to make, while
699 the protocol option determines which protocol
700 will be used.
701 This engine defines engine specific options.
ed92ac0c 702
9cce02e8
JA
703 netsplice Like net, but uses splice/vmsplice to
704 map data and send/receive.
de890a1e 705 This engine defines engine specific options.
9cce02e8 706
53aec0a4 707 cpuio Doesn't transfer any data, but burns CPU
ba0fbe10
JA
708 cycles according to the cpuload= and
709 cpucycle= options. Setting cpuload=85
710 will cause that job to do nothing but burn
36ecec83
GP
711 85% of the CPU. In case of SMP machines,
712 use numjobs=<no_of_cpu> to get desired CPU
713 usage, as the cpuload only loads a single
714 CPU at the desired rate.
ba0fbe10 715
e9a1806f
JA
716 guasi The GUASI IO engine is the Generic Userspace
717 Asyncronous Syscall Interface approach
718 to async IO. See
719
720 http://www.xmailserver.org/guasi-lib.html
721
722 for more info on GUASI.
723
21b8aee8 724 rdma The RDMA I/O engine supports both RDMA
eb52fa3f
BVA
725 memory semantics (RDMA_WRITE/RDMA_READ) and
726 channel semantics (Send/Recv) for the
727 InfiniBand, RoCE and iWARP protocols.
21b8aee8 728
b861be9f
JA
729 falloc IO engine that does regular fallocate to
730 simulate data transfer as fio ioengine.
731 DDIR_READ does fallocate(,mode = keep_size,)
732 DDIR_WRITE does fallocate(,mode = 0)
733 DDIR_TRIM does fallocate(,mode = punch_hole)
d54fce84
DM
734
735 e4defrag IO engine that does regular EXT4_IOC_MOVE_EXT
b861be9f
JA
736 ioctls to simulate defragment activity in
737 request to DDIR_WRITE event
738
739 rbd IO engine supporting direct access to Ceph
740 Rados Block Devices (RBD) via librbd without
741 the need to use the kernel rbd driver. This
742 ioengine defines engine specific options.
743
744 gfapi Using Glusterfs libgfapi sync interface to
745 direct access to Glusterfs volumes without
746 options.
747
748 gfapi_async Using Glusterfs libgfapi async interface
749 to direct access to Glusterfs volumes without
750 having to go through FUSE. This ioengine
751 defines engine specific options.
0981fd71 752
b74e419e
MM
753 libhdfs Read and write through Hadoop (HDFS).
754 The 'filename' option is used to specify host,
755 port of the hdfs name-node to connect. This
756 engine interprets offsets a little
757 differently. In HDFS, files once created
758 cannot be modified. So random writes are not
759 possible. To imitate this, libhdfs engine
760 expects bunch of small files to be created
761 over HDFS, and engine will randomly pick a
762 file out of those files based on the offset
763 generated by fio backend. (see the example
764 job file to create such files, use rw=write
765 option). Please note, you might want to set
766 necessary environment variables to work with
767 hdfs/libhdfs properly.
1b10477b 768
8a7bd877
JA
769 external Prefix to specify loading an external
770 IO engine object file. Append the engine
771 filename, eg ioengine=external:/tmp/foo.o
772 to load ioengine foo.o in /tmp.
773
71bfa161
JA
774iodepth=int This defines how many io units to keep in flight against
775 the file. The default is 1 for each file defined in this
776 job, can be overridden with a larger value for higher
ee72ca09
JA
777 concurrency. Note that increasing iodepth beyond 1 will not
778 affect synchronous ioengines (except for small degress when
9b836561 779 verify_async is in use). Even async engines may impose OS
ee72ca09
JA
780 restrictions causing the desired depth not to be achieved.
781 This may happen on Linux when using libaio and not setting
782 direct=1, since buffered IO is not async on that OS. Keep an
783 eye on the IO depth distribution in the fio output to verify
784 that the achieved depth is as expected. Default: 1.
71bfa161 785
4950421a 786iodepth_batch_submit=int
cb5ab512 787iodepth_batch=int This defines how many pieces of IO to submit at once.
89e820f6
JA
788 It defaults to 1 which means that we submit each IO
789 as soon as it is available, but can be raised to submit
790 bigger batches of IO at the time.
cb5ab512 791
4950421a
JA
792iodepth_batch_complete=int This defines how many pieces of IO to retrieve
793 at once. It defaults to 1 which means that we'll ask
794 for a minimum of 1 IO in the retrieval process from
795 the kernel. The IO retrieval will go on until we
796 hit the limit set by iodepth_low. If this variable is
797 set to 0, then fio will always check for completed
798 events before queuing more IO. This helps reduce
799 IO latency, at the cost of more retrieval system calls.
800
e916b390
JA
801iodepth_low=int The low water mark indicating when to start filling
802 the queue again. Defaults to the same as iodepth, meaning
803 that fio will attempt to keep the queue full at all times.
804 If iodepth is set to eg 16 and iodepth_low is set to 4, then
805 after fio has filled the queue of 16 requests, it will let
806 the depth drain down to 4 before starting to fill it again.
807
71bfa161 808direct=bool If value is true, use non-buffered io. This is usually
9b836561 809 O_DIRECT. Note that ZFS on Solaris doesn't support direct io.
93bcfd20 810 On Windows the synchronous ioengines don't support direct io.
76a43db4 811
d01612f3
CM
812atomic=bool If value is true, attempt to use atomic direct IO. Atomic
813 writes are guaranteed to be stable once acknowledged by
814 the operating system. Only Linux supports O_ATOMIC right
815 now.
816
76a43db4
JA
817buffered=bool If value is true, use buffered io. This is the opposite
818 of the 'direct' option. Defaults to true.
71bfa161 819
f7fa2653 820offset=int Start io at the given offset in the file. The data before
71bfa161
JA
821 the given offset will not be touched. This effectively
822 caps the file size at real_size - offset.
823
214ac7e0 824offset_increment=int If this is provided, then the real offset becomes
69bdd6ba
JH
825 offset + offset_increment * thread_number, where the thread
826 number is a counter that starts at 0 and is incremented for
827 each sub-job (i.e. when numjobs option is specified). This
828 option is useful if there are several jobs which are intended
829 to operate on a file in parallel disjoint segments, with
830 even spacing between the starting points.
214ac7e0 831
ddf24e42
JA
832number_ios=int Fio will normally perform IOs until it has exhausted the size
833 of the region set by size=, or if it exhaust the allocated
834 time (or hits an error condition). With this setting, the
835 range/size can be set independently of the number of IOs to
836 perform. When fio reaches this number, it will exit normally
be3fec7d
JA
837 and report status. Note that this does not extend the amount
838 of IO that will be done, it will only stop fio if this
839 condition is met before other end-of-job criteria.
ddf24e42 840
71bfa161
JA
841fsync=int If writing to a file, issue a sync of the dirty data
842 for every number of blocks given. For example, if you give
843 32 as a parameter, fio will sync the file for every 32
844 writes issued. If fio is using non-buffered io, we may
845 not sync the file. The exception is the sg io engine, which
6c219763 846 synchronizes the disk cache anyway.
71bfa161 847
e76b1da4 848fdatasync=int Like fsync= but uses fdatasync() to only sync data and not
5f9099ea 849 metadata blocks.
93bcfd20 850 In FreeBSD and Windows there is no fdatasync(), this falls back to
e72fa4d4 851 using fsync()
5f9099ea 852
e76b1da4
JA
853sync_file_range=str:val Use sync_file_range() for every 'val' number of
854 write operations. Fio will track range of writes that
855 have happened since the last sync_file_range() call. 'str'
856 can currently be one or more of:
857
858 wait_before SYNC_FILE_RANGE_WAIT_BEFORE
859 write SYNC_FILE_RANGE_WRITE
860 wait_after SYNC_FILE_RANGE_WAIT_AFTER
861
862 So if you do sync_file_range=wait_before,write:8, fio would
863 use SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE for
864 every 8 writes. Also see the sync_file_range(2) man page.
865 This option is Linux specific.
866
5036fc1e
JA
867overwrite=bool If true, writes to a file will always overwrite existing
868 data. If the file doesn't already exist, it will be
869 created before the write phase begins. If the file exists
870 and is large enough for the specified write phase, nothing
871 will be done.
71bfa161 872
dbd11ead 873end_fsync=bool If true, fsync file contents when a write stage has completed.
71bfa161 874
ebb1415f
JA
875fsync_on_close=bool If true, fio will fsync() a dirty file on close.
876 This differs from end_fsync in that it will happen on every
877 file close, not just at the end of the job.
878
71bfa161
JA
879rwmixread=int How large a percentage of the mix should be reads.
880
881rwmixwrite=int How large a percentage of the mix should be writes. If both
882 rwmixread and rwmixwrite is given and the values do not add
883 up to 100%, the latter of the two will be used to override
c35dd7a6
JA
884 the first. This may interfere with a given rate setting,
885 if fio is asked to limit reads or writes to a certain rate.
886 If that is the case, then the distribution may be skewed.
71bfa161 887
92d42d69
JA
888random_distribution=str:float By default, fio will use a completely uniform
889 random distribution when asked to perform random IO. Sometimes
890 it is useful to skew the distribution in specific ways,
891 ensuring that some parts of the data is more hot than others.
892 fio includes the following distribution models:
893
894 random Uniform random distribution
895 zipf Zipf distribution
896 pareto Pareto distribution
897
898 When using a zipf or pareto distribution, an input value
899 is also needed to define the access pattern. For zipf, this
900 is the zipf theta. For pareto, it's the pareto power. Fio
901 includes a test program, genzipf, that can be used visualize
902 what the given input values will yield in terms of hit rates.
903 If you wanted to use zipf with a theta of 1.2, you would use
904 random_distribution=zipf:1.2 as the option. If a non-uniform
905 model is used, fio will disable use of the random map.
906
211c9b89
JA
907percentage_random=int For a random workload, set how big a percentage should
908 be random. This defaults to 100%, in which case the workload
909 is fully random. It can be set from anywhere from 0 to 100.
910 Setting it to 0 would make the workload fully sequential. Any
911 setting in between will result in a random mix of sequential
d9472271
JA
912 and random IO, at the given percentages. It is possible to
913 set different values for reads, writes, and trim. To do so,
914 simply use a comma separated list. See blocksize.
211c9b89 915
bb8895e0
JA
916norandommap Normally fio will cover every block of the file when doing
917 random IO. If this option is given, fio will just get a
918 new random offset without looking at past io history. This
919 means that some blocks may not be read or written, and that
83da8fbf
JE
920 some blocks may be read/written more than once. If this option
921 is used with verify= and multiple blocksizes (via bsrange=),
922 only intact blocks are verified, i.e., partially-overwritten
923 blocks are ignored.
bb8895e0 924
0408c206
JA
925softrandommap=bool See norandommap. If fio runs with the random block map
926 enabled and it fails to allocate the map, if this option is
927 set it will continue without a random block map. As coverage
928 will not be as complete as with random maps, this option is
2b386d25
JA
929 disabled by default.
930
e8b1961d
JA
931random_generator=str Fio supports the following engines for generating
932 IO offsets for random IO:
933
934 tausworthe Strong 2^88 cycle random number generator
935 lfsr Linear feedback shift register generator
936
937 Tausworthe is a strong random number generator, but it
938 requires tracking on the side if we want to ensure that
939 blocks are only read or written once. LFSR guarantees
940 that we never generate the same offset twice, and it's
941 also less computationally expensive. It's not a true
942 random generator, however, though for IO purposes it's
943 typically good enough. LFSR only works with single
944 block sizes, not with workloads that use multiple block
945 sizes. If used with such a workload, fio may read or write
946 some blocks multiple times.
43f09da1 947
71bfa161
JA
948nice=int Run the job with the given nice value. See man nice(2).
949
950prio=int Set the io priority value of this job. Linux limits us to
951 a positive value between 0 and 7, with 0 being the highest.
952 See man ionice(1).
953
954prioclass=int Set the io priority class. See man ionice(1).
955
956thinktime=int Stall the job x microseconds after an io has completed before
957 issuing the next. May be used to simulate processing being
48097d5c
JA
958 done by an application. See thinktime_blocks and
959 thinktime_spin.
960
961thinktime_spin=int
962 Only valid if thinktime is set - pretend to spend CPU time
963 doing something with the data received, before falling back
964 to sleeping for the rest of the period specified by
965 thinktime.
9c1f7434 966
4d01ece6 967thinktime_blocks=int
9c1f7434
JA
968 Only valid if thinktime is set - control how many blocks
969 to issue, before waiting 'thinktime' usecs. If not set,
970 defaults to 1 which will make fio wait 'thinktime' usecs
4d01ece6
JA
971 after every block. This effectively makes any queue depth
972 setting redundant, since no more than 1 IO will be queued
973 before we have to complete it and do our thinktime. In
974 other words, this setting effectively caps the queue depth
975 if the latter is larger.
71bfa161 976
581e7141 977rate=int Cap the bandwidth used by this job. The number is in bytes/sec,
b09da8fa 978 the normal suffix rules apply. You can use rate=500k to limit
581e7141
JA
979 reads and writes to 500k each, or you can specify read and
980 writes separately. Using rate=1m,500k would limit reads to
981 1MB/sec and writes to 500KB/sec. Capping only reads or
982 writes can be done with rate=,500k or rate=500k,. The former
983 will only limit writes (to 500KB/sec), the latter will only
984 limit reads.
71bfa161
JA
985
986ratemin=int Tell fio to do whatever it can to maintain at least this
4e991c23 987 bandwidth. Failing to meet this requirement, will cause
581e7141
JA
988 the job to exit. The same format as rate is used for
989 read vs write separation.
4e991c23
JA
990
991rate_iops=int Cap the bandwidth to this number of IOPS. Basically the same
992 as rate, just specified independently of bandwidth. If the
993 job is given a block size range instead of a fixed value,
581e7141 994 the smallest block size is used as the metric. The same format
de8f6de9 995 as rate is used for read vs write separation.
4e991c23
JA
996
997rate_iops_min=int If fio doesn't meet this rate of IO, it will cause
581e7141 998 the job to exit. The same format as rate is used for read vs
de8f6de9 999 write separation.
71bfa161 1000
3e260a46
JA
1001latency_target=int If set, fio will attempt to find the max performance
1002 point that the given workload will run at while maintaining a
1003 latency below this target. The values is given in microseconds.
1004 See latency_window and latency_percentile
1005
1006latency_window=int Used with latency_target to specify the sample window
1007 that the job is run at varying queue depths to test the
1008 performance. The value is given in microseconds.
1009
1010latency_percentile=float The percentage of IOs that must fall within the
1011 criteria specified by latency_target and latency_window. If not
1012 set, this defaults to 100.0, meaning that all IOs must be equal
1013 or below to the value set by latency_target.
1014
15501535
JA
1015max_latency=int If set, fio will exit the job if it exceeds this maximum
1016 latency. It will exit with an ETIME error.
1017
71bfa161 1018ratecycle=int Average bandwidth for 'rate' and 'ratemin' over this number
6c219763 1019 of milliseconds.
71bfa161
JA
1020
1021cpumask=int Set the CPU affinity of this job. The parameter given is a
a08bc17f
JA
1022 bitmask of allowed CPU's the job may run on. So if you want
1023 the allowed CPUs to be 1 and 5, you would pass the decimal
1024 value of (1 << 1 | 1 << 5), or 34. See man
7dbb6eba 1025 sched_setaffinity(2). This may not work on all supported
b0ea08ce
JA
1026 operating systems or kernel versions. This option doesn't
1027 work well for a higher CPU count than what you can store in
1028 an integer mask, so it can only control cpus 1-32. For
1029 boxes with larger CPU counts, use cpus_allowed.
71bfa161 1030
d2e268b0
JA
1031cpus_allowed=str Controls the same options as cpumask, but it allows a text
1032 setting of the permitted CPUs instead. So to use CPUs 1 and
62a7273d
JA
1033 5, you would specify cpus_allowed=1,5. This options also
1034 allows a range of CPUs. Say you wanted a binding to CPUs
1035 1, 5, and 8-15, you would set cpus_allowed=1,5,8-15.
d2e268b0 1036
c2acfbac
JA
1037cpus_allowed_policy=str Set the policy of how fio distributes the CPUs
1038 specified by cpus_allowed or cpumask. Two policies are
1039 supported:
1040
1041 shared All jobs will share the CPU set specified.
1042 split Each job will get a unique CPU from the CPU set.
1043
1044 'shared' is the default behaviour, if the option isn't
ada083cd
JA
1045 specified. If split is specified, then fio will will assign
1046 one cpu per job. If not enough CPUs are given for the jobs
1047 listed, then fio will roundrobin the CPUs in the set.
c2acfbac 1048
d0b937ed
YR
1049numa_cpu_nodes=str Set this job running on spcified NUMA nodes' CPUs. The
1050 arguments allow comma delimited list of cpu numbers,
1051 A-B ranges, or 'all'. Note, to enable numa options support,
67bf9823 1052 fio must be built on a system with libnuma-dev(el) installed.
d0b937ed
YR
1053
1054numa_mem_policy=str Set this job's memory policy and corresponding NUMA
1055 nodes. Format of the argements:
1056 <mode>[:<nodelist>]
1057 `mode' is one of the following memory policy:
1058 default, prefer, bind, interleave, local
1059 For `default' and `local' memory policy, no node is
1060 needed to be specified.
1061 For `prefer', only one node is allowed.
1062 For `bind' and `interleave', it allow comma delimited
1063 list of numbers, A-B ranges, or 'all'.
1064
e417fd66 1065startdelay=time Start this job the specified number of seconds after fio
71bfa161
JA
1066 has started. Only useful if the job file contains several
1067 jobs, and you want to delay starting some jobs to a certain
1068 time.
1069
e417fd66 1070runtime=time Tell fio to terminate processing after the specified number
71bfa161
JA
1071 of seconds. It can be quite hard to determine for how long
1072 a specified job will run, so this parameter is handy to
1073 cap the total runtime to a given time.
1074
cf4464ca 1075time_based If set, fio will run for the duration of the runtime
bf9a3edb 1076 specified even if the file(s) are completely read or
cf4464ca
JA
1077 written. It will simply loop over the same workload
1078 as many times as the runtime allows.
1079
e417fd66 1080ramp_time=time If set, fio will run the specified workload for this amount
721938ae
JA
1081 of time before logging any performance numbers. Useful for
1082 letting performance settle before logging results, thus
b29ee5b3
JA
1083 minimizing the runtime required for stable results. Note
1084 that the ramp_time is considered lead in time for a job,
1085 thus it will increase the total runtime if a special timeout
1086 or runtime is specified.
721938ae 1087
71bfa161
JA
1088invalidate=bool Invalidate the buffer/page cache parts for this file prior
1089 to starting io. Defaults to true.
1090
1091sync=bool Use sync io for buffered writes. For the majority of the
1092 io engines, this means using O_SYNC.
1093
d3aad8f2 1094iomem=str
71bfa161
JA
1095mem=str Fio can use various types of memory as the io unit buffer.
1096 The allowed values are:
1097
1098 malloc Use memory from malloc(3) as the buffers.
1099
1100 shm Use shared memory as the buffers. Allocated
1101 through shmget(2).
1102
74b025b0
JA
1103 shmhuge Same as shm, but use huge pages as backing.
1104
313cb206
JA
1105 mmap Use mmap to allocate buffers. May either be
1106 anonymous memory, or can be file backed if
1107 a filename is given after the option. The
1108 format is mem=mmap:/path/to/file.
71bfa161 1109
d0bdaf49
JA
1110 mmaphuge Use a memory mapped huge file as the buffer
1111 backing. Append filename after mmaphuge, ala
1112 mem=mmaphuge:/hugetlbfs/file
1113
71bfa161 1114 The area allocated is a function of the maximum allowed
5394ae5f
JA
1115 bs size for the job, multiplied by the io depth given. Note
1116 that for shmhuge and mmaphuge to work, the system must have
1117 free huge pages allocated. This can normally be checked
1118 and set by reading/writing /proc/sys/vm/nr_hugepages on a
b22989b9 1119 Linux system. Fio assumes a huge page is 4MB in size. So
5394ae5f
JA
1120 to calculate the number of huge pages you need for a given
1121 job file, add up the io depth of all jobs (normally one unless
1122 iodepth= is used) and multiply by the maximum bs set. Then
1123 divide that number by the huge page size. You can see the
1124 size of the huge pages in /proc/meminfo. If no huge pages
1125 are allocated by having a non-zero number in nr_hugepages,
56bb17f2 1126 using mmaphuge or shmhuge will fail. Also see hugepage-size.
5394ae5f
JA
1127
1128 mmaphuge also needs to have hugetlbfs mounted and the file
1129 location should point there. So if it's mounted in /huge,
1130 you would use mem=mmaphuge:/huge/somefile.
71bfa161 1131
d529ee19
JA
1132iomem_align=int This indiciates the memory alignment of the IO memory buffers.
1133 Note that the given alignment is applied to the first IO unit
1134 buffer, if using iodepth the alignment of the following buffers
1135 are given by the bs used. In other words, if using a bs that is
1136 a multiple of the page sized in the system, all buffers will
1137 be aligned to this value. If using a bs that is not page
1138 aligned, the alignment of subsequent IO memory buffers is the
1139 sum of the iomem_align and bs used.
1140
f7fa2653 1141hugepage-size=int
56bb17f2 1142 Defines the size of a huge page. Must at least be equal
b22989b9 1143 to the system setting, see /proc/meminfo. Defaults to 4MB.
c51074e7
JA
1144 Should probably always be a multiple of megabytes, so using
1145 hugepage-size=Xm is the preferred way to set this to avoid
1146 setting a non-pow-2 bad value.
56bb17f2 1147
71bfa161
JA
1148exitall When one job finishes, terminate the rest. The default is
1149 to wait for each job to finish, sometimes that is not the
1150 desired action.
1151
1152bwavgtime=int Average the calculated bandwidth over the given time. Value
6c219763 1153 is specified in milliseconds.
71bfa161 1154
c8eeb9df
JA
1155iopsavgtime=int Average the calculated IOPS over the given time. Value
1156 is specified in milliseconds.
1157
71bfa161
JA
1158create_serialize=bool If true, serialize the file creating for the jobs.
1159 This may be handy to avoid interleaving of data
1160 files, which may greatly depend on the filesystem
1161 used and even the number of processors in the system.
1162
1163create_fsync=bool fsync the data file after creation. This is the
1164 default.
1165
814452bd
JA
1166create_on_open=bool Don't pre-setup the files for IO, just create open()
1167 when it's time to do IO to that file.
1168
25460cf6
JA
1169create_only=bool If true, fio will only run the setup phase of the job.
1170 If files need to be laid out or updated on disk, only
1171 that will be done. The actual job contents are not
1172 executed.
1173
afad68f7 1174pre_read=bool If this is given, files will be pre-read into memory before
34f1c044
JA
1175 starting the given IO operation. This will also clear
1176 the 'invalidate' flag, since it is pointless to pre-read
9c0d2241
JA
1177 and then drop the cache. This will only work for IO engines
1178 that are seekable, since they allow you to read the same data
1179 multiple times. Thus it will not work on eg network or splice
1180 IO.
afad68f7 1181
e545a6ce 1182unlink=bool Unlink the job files when done. Not the default, as repeated
bf9a3edb
JA
1183 runs of that job would then waste time recreating the file
1184 set again and again.
71bfa161
JA
1185
1186loops=int Run the specified number of iterations of this job. Used
1187 to repeat the same workload a given number of times. Defaults
1188 to 1.
1189
62167762
JC
1190verify_only Do not perform specified workload---only verify data still
1191 matches previous invocation of this workload. This option
1192 allows one to check data multiple times at a later date
1193 without overwriting it. This option makes sense only for
1194 workloads that write data, and does not support workloads
1195 with the time_based option set.
1196
68e1f29a 1197do_verify=bool Run the verify phase after a write phase. Only makes sense if
e84c73a8
SL
1198 verify is set. Defaults to 1.
1199
71bfa161
JA
1200verify=str If writing to a file, fio can verify the file contents
1201 after each iteration of the job. The allowed values are:
1202
1203 md5 Use an md5 sum of the data area and store
1204 it in the header of each block.
1205
17dc34df
JA
1206 crc64 Use an experimental crc64 sum of the data
1207 area and store it in the header of each
1208 block.
1209
bac39e0e
JA
1210 crc32c Use a crc32c sum of the data area and store
1211 it in the header of each block.
1212
3845591f 1213 crc32c-intel Use hardware assisted crc32c calcuation
0539d758
JA
1214 provided on SSE4.2 enabled processors. Falls
1215 back to regular software crc32c, if not
1216 supported by the system.
3845591f 1217
71bfa161
JA
1218 crc32 Use a crc32 sum of the data area and store
1219 it in the header of each block.
1220
969f7ed3
JA
1221 crc16 Use a crc16 sum of the data area and store
1222 it in the header of each block.
1223
17dc34df
JA
1224 crc7 Use a crc7 sum of the data area and store
1225 it in the header of each block.
1226
844ea602
JA
1227 xxhash Use xxhash as the checksum function. Generally
1228 the fastest software checksum that fio
1229 supports.
1230
cd14cc10
JA
1231 sha512 Use sha512 as the checksum function.
1232
1233 sha256 Use sha256 as the checksum function.
1234
7c353ceb
JA
1235 sha1 Use optimized sha1 as the checksum function.
1236
7437ee87
SL
1237 meta Write extra information about each io
1238 (timestamp, block number etc.). The block
62167762
JC
1239 number is verified. The io sequence number is
1240 verified for workloads that write data.
1241 See also verify_pattern.
7437ee87 1242
36690c9b
JA
1243 null Only pretend to verify. Useful for testing
1244 internals with ioengine=null, not for much
1245 else.
1246
6c219763 1247 This option can be used for repeated burn-in tests of a
71bfa161 1248 system to make sure that the written data is also
b892dc08
JA
1249 correctly read back. If the data direction given is
1250 a read or random read, fio will assume that it should
1251 verify a previously written file. If the data direction
1252 includes any form of write, the verify will be of the
1253 newly written data.
71bfa161 1254
160b966d
JA
1255verifysort=bool If set, fio will sort written verify blocks when it deems
1256 it faster to read them back in a sorted manner. This is
1257 often the case when overwriting an existing file, since
1258 the blocks are already laid out in the file system. You
1259 can ignore this option unless doing huge amounts of really
1260 fast IO where the red-black tree sorting CPU time becomes
1261 significant.
3f9f4e26 1262
f7fa2653 1263verify_offset=int Swap the verification header with data somewhere else
546a9142
SL
1264 in the block before writing. Its swapped back before
1265 verifying.
1266
f7fa2653 1267verify_interval=int Write the verification header at a finer granularity
3f9f4e26
SL
1268 than the blocksize. It will be written for chunks the
1269 size of header_interval. blocksize should divide this
1270 evenly.
90059d65 1271
0e92f873 1272verify_pattern=str If set, fio will fill the io buffers with this
e28218f3
SL
1273 pattern. Fio defaults to filling with totally random
1274 bytes, but sometimes it's interesting to fill with a known
1275 pattern for io verification purposes. Depending on the
1276 width of the pattern, fio will fill 1/2/3/4 bytes of the
0e92f873
RR
1277 buffer at the time(it can be either a decimal or a hex number).
1278 The verify_pattern if larger than a 32-bit quantity has to
996093bb
JA
1279 be a hex number that starts with either "0x" or "0X". Use
1280 with verify=meta.
e28218f3 1281
68e1f29a 1282verify_fatal=bool Normally fio will keep checking the entire contents
a12a3b4d
JA
1283 before quitting on a block verification failure. If this
1284 option is set, fio will exit the job on the first observed
1285 failure.
e8462bd8 1286
b463e936
JA
1287verify_dump=bool If set, dump the contents of both the original data
1288 block and the data block we read off disk to files. This
1289 allows later analysis to inspect just what kind of data
ef71e317 1290 corruption occurred. Off by default.
b463e936 1291
e8462bd8
JA
1292verify_async=int Fio will normally verify IO inline from the submitting
1293 thread. This option takes an integer describing how many
1294 async offload threads to create for IO verification instead,
1295 causing fio to offload the duty of verifying IO contents
c85c324c
JA
1296 to one or more separate threads. If using this offload
1297 option, even sync IO engines can benefit from using an
1298 iodepth setting higher than 1, as it allows them to have
1299 IO in flight while verifies are running.
e8462bd8
JA
1300
1301verify_async_cpus=str Tell fio to set the given CPU affinity on the
1302 async IO verification threads. See cpus_allowed for the
1303 format used.
6f87418f
JA
1304
1305verify_backlog=int Fio will normally verify the written contents of a
1306 job that utilizes verify once that job has completed. In
1307 other words, everything is written then everything is read
1308 back and verified. You may want to verify continually
1309 instead for a variety of reasons. Fio stores the meta data
1310 associated with an IO block in memory, so for large
1311 verify workloads, quite a bit of memory would be used up
1312 holding this meta data. If this option is enabled, fio
f42195a3
JA
1313 will write only N blocks before verifying these blocks.
1314
6f87418f
JA
1315verify_backlog_batch=int Control how many blocks fio will verify
1316 if verify_backlog is set. If not set, will default to
1317 the value of verify_backlog (meaning the entire queue
f42195a3
JA
1318 is read back and verified). If verify_backlog_batch is
1319 less than verify_backlog then not all blocks will be verified,
1320 if verify_backlog_batch is larger than verify_backlog, some
1321 blocks will be verified more than once.
66c098b8 1322
ca09be4b
JA
1323verify_state_save=bool When a job exits during the write phase of a verify
1324 workload, save its current state. This allows fio to replay
1325 up until that point, if the verify state is loaded for the
1326 verify read phase. The format of the filename is, roughly,
1327 <type>-<jobname>-<jobindex>-verify.state. <type> is "local"
1328 for a local run, "sock" for a client/server socket connection,
1329 and "ip" (192.168.0.1, for instance) for a networked
1330 client/server connection.
1331
1332verify_state_load=bool If a verify termination trigger was used, fio stores
1333 the current write state of each thread. This can be used at
1334 verification time so that fio knows how far it should verify.
1335 Without this information, fio will run a full verification
1336 pass, according to the settings in the job file used.
1337
d392365e 1338stonewall
de8f6de9 1339wait_for_previous Wait for preceding jobs in the job file to exit, before
71bfa161 1340 starting this one. Can be used to insert serialization
b3d62a75
JA
1341 points in the job file. A stone wall also implies starting
1342 a new reporting group.
1343
abcab6af 1344new_group Start a new reporting group. See: group_reporting.
71bfa161
JA
1345
1346numjobs=int Create the specified number of clones of this job. May be
1347 used to setup a larger number of threads/processes doing
abcab6af
AV
1348 the same thing. Each thread is reported separately; to see
1349 statistics for all clones as a whole, use group_reporting in
1350 conjunction with new_group.
1351
1352group_reporting It may sometimes be interesting to display statistics for
04b2f799
JA
1353 groups of jobs as a whole instead of for each individual job.
1354 This is especially true if 'numjobs' is used; looking at
1355 individual thread/process output quickly becomes unwieldy.
1356 To see the final report per-group instead of per-job, use
1357 'group_reporting'. Jobs in a file will be part of the same
1358 reporting group, unless if separated by a stonewall, or by
1359 using 'new_group'.
71bfa161
JA
1360
1361thread fio defaults to forking jobs, however if this option is
1362 given, fio will use pthread_create(3) to create threads
1363 instead.
1364
f7fa2653 1365zonesize=int Divide a file into zones of the specified size. See zoneskip.
71bfa161 1366
f7fa2653 1367zoneskip=int Skip the specified number of bytes when zonesize data has
71bfa161
JA
1368 been read. The two zone options can be used to only do
1369 io on zones of a file.
1370
076efc7c 1371write_iolog=str Write the issued io patterns to the specified file. See
5b42a488
SH
1372 read_iolog. Specify a separate file for each job, otherwise
1373 the iologs will be interspersed and the file may be corrupt.
71bfa161 1374
076efc7c 1375read_iolog=str Open an iolog with the specified file name and replay the
71bfa161 1376 io patterns it contains. This can be used to store a
6df8adaa
JA
1377 workload and replay it sometime later. The iolog given
1378 may also be a blktrace binary file, which allows fio
1379 to replay a workload captured by blktrace. See blktrace
1380 for how to capture such logging data. For blktrace replay,
1381 the file needs to be turned into a blkparse binary data
ea3e51c3 1382 file first (blkparse <device> -o /dev/null -d file_for_fio.bin).
66c098b8 1383
64bbb865 1384replay_no_stall=int When replaying I/O with read_iolog the default behavior
62776229
JA
1385 is to attempt to respect the time stamps within the log and
1386 replay them with the appropriate delay between IOPS. By
1387 setting this variable fio will not respect the timestamps and
1388 attempt to replay them as fast as possible while still
1389 respecting ordering. The result is the same I/O pattern to a
1390 given device, but different timings.
71bfa161 1391
d1c46c04
DN
1392replay_redirect=str While replaying I/O patterns using read_iolog the
1393 default behavior is to replay the IOPS onto the major/minor
1394 device that each IOP was recorded from. This is sometimes
de8f6de9 1395 undesirable because on a different machine those major/minor
d1c46c04
DN
1396 numbers can map to a different device. Changing hardware on
1397 the same system can also result in a different major/minor
1398 mapping. Replay_redirect causes all IOPS to be replayed onto
1399 the single specified device regardless of the device it was
1400 recorded from. i.e. replay_redirect=/dev/sdc would cause all
1401 IO in the blktrace to be replayed onto /dev/sdc. This means
1402 multiple devices will be replayed onto a single, if the trace
1403 contains multiple devices. If you want multiple devices to be
1404 replayed concurrently to multiple redirected devices you must
1405 blkparse your trace into separate traces and replay them with
1406 independent fio invocations. Unfortuantely this also breaks
1407 the strict time ordering between multiple device accesses.
1408
e3cedca7 1409write_bw_log=str If given, write a bandwidth log of the jobs in this job
71bfa161 1410 file. Can be used to store data of the bandwidth of the
e0da9bc2
JA
1411 jobs in their lifetime. The included fio_generate_plots
1412 script uses gnuplot to turn these text files into nice
ddb754db 1413 graphs. See write_lat_log for behaviour of given
8ad3b3dd
JA
1414 filename. For this option, the suffix is _bw.x.log, where
1415 x is the index of the job (1..N, where N is the number of
1416 jobs).
71bfa161 1417
e3cedca7 1418write_lat_log=str Same as write_bw_log, except that this option stores io
02af0988
JA
1419 submission, completion, and total latencies instead. If no
1420 filename is given with this option, the default filename of
1421 "jobname_type.log" is used. Even if the filename is given,
1422 fio will still append the type of log. So if one specifies
e3cedca7
JA
1423
1424 write_lat_log=foo
1425
8ad3b3dd
JA
1426 The actual log names will be foo_slat.x.log, foo_clat.x.log,
1427 and foo_lat.x.log, where x is the index of the job (1..N,
1428 where N is the number of jobs). This helps fio_generate_plot
1429 fine the logs automatically.
71bfa161 1430
b8bc8cba
JA
1431write_iops_log=str Same as write_bw_log, but writes IOPS. If no filename is
1432 given with this option, the default filename of
8ad3b3dd
JA
1433 "jobname_type.x.log" is used,where x is the index of the job
1434 (1..N, where N is the number of jobs). Even if the filename
1435 is given, fio will still append the type of log.
b8bc8cba
JA
1436
1437log_avg_msec=int By default, fio will log an entry in the iops, latency,
1438 or bw log for every IO that completes. When writing to the
1439 disk log, that can quickly grow to a very large size. Setting
1440 this option makes fio average the each log entry over the
1441 specified period of time, reducing the resolution of the log.
1442 Defaults to 0.
1443
ae588852
JA
1444log_offset=int If this is set, the iolog options will include the byte
1445 offset for the IO entry as well as the other data values.
1446
aee2ab67
JA
1447log_compression=int If this is set, fio will compress the IO logs as
1448 it goes, to keep the memory footprint lower. When a log
1449 reaches the specified size, that chunk is removed and
1450 compressed in the background. Given that IO logs are
1451 fairly highly compressible, this yields a nice memory
1452 savings for longer runs. The downside is that the
1453 compression will consume some background CPU cycles, so
1454 it may impact the run. This, however, is also true if
1455 the logging ends up consuming most of the system memory.
1456 So pick your poison. The IO logs are saved normally at the
1457 end of a run, by decompressing the chunks and storing them
1458 in the specified log file. This feature depends on the
1459 availability of zlib.
1460
b26317c9
JA
1461log_store_compressed=bool If set, and log_compression is also set,
1462 fio will store the log files in a compressed format. They
1463 can be decompressed with fio, using the --inflate-log
1464 command line parameter. The files will be stored with a
1465 .fz suffix.
1466
f7fa2653 1467lockmem=int Pin down the specified amount of memory with mlock(2). Can
71bfa161
JA
1468 potentially be used instead of removing memory or booting
1469 with less memory to simulate a smaller amount of memory.
81c6b6cd 1470 The amount specified is per worker.
71bfa161
JA
1471
1472exec_prerun=str Before running this job, issue the command specified
74c8c488
JA
1473 through system(3). Output is redirected in a file called
1474 jobname.prerun.txt.
71bfa161
JA
1475
1476exec_postrun=str After the job completes, issue the command specified
74c8c488
JA
1477 though system(3). Output is redirected in a file called
1478 jobname.postrun.txt.
71bfa161
JA
1479
1480ioscheduler=str Attempt to switch the device hosting the file to the specified
1481 io scheduler before running.
1482
0a839f30
JA
1483disk_util=bool Generate disk utilization statistics, if the platform
1484 supports it. Defaults to on.
1485
02af0988 1486disable_lat=bool Disable measurements of total latency numbers. Useful
9520ebb9
JA
1487 only for cutting back the number of calls to gettimeofday,
1488 as that does impact performance at really high IOPS rates.
1489 Note that to really get rid of a large amount of these
1490 calls, this option must be used with disable_slat and
1491 disable_bw as well.
1492
02af0988
JA
1493disable_clat=bool Disable measurements of completion latency numbers. See
1494 disable_lat.
1495
9520ebb9 1496disable_slat=bool Disable measurements of submission latency numbers. See
02af0988 1497 disable_slat.
9520ebb9
JA
1498
1499disable_bw=bool Disable measurements of throughput/bandwidth numbers. See
02af0988 1500 disable_lat.
9520ebb9 1501
83349190
YH
1502clat_percentiles=bool Enable the reporting of percentiles of
1503 completion latencies.
1504
1505percentile_list=float_list Overwrite the default list of percentiles
1506 for completion latencies. Each number is a floating
1507 number in the range (0,100], and the maximum length of
1508 the list is 20. Use ':' to separate the numbers, and
1509 list the numbers in ascending order. For example,
1510 --percentile_list=99.5:99.9 will cause fio to report
1511 the values of completion latency below which 99.5% and
1512 99.9% of the observed latencies fell, respectively.
1513
23893646
JA
1514clocksource=str Use the given clocksource as the base of timing. The
1515 supported options are:
1516
1517 gettimeofday gettimeofday(2)
1518
1519 clock_gettime clock_gettime(2)
1520
1521 cpu Internal CPU clock source
1522
1523 cpu is the preferred clocksource if it is reliable, as it
1524 is very fast (and fio is heavy on time calls). Fio will
1525 automatically use this clocksource if it's supported and
1526 considered reliable on the system it is running on, unless
1527 another clocksource is specifically set. For x86/x86-64 CPUs,
1528 this means supporting TSC Invariant.
1529
993bf48b
JA
1530gtod_reduce=bool Enable all of the gettimeofday() reducing options
1531 (disable_clat, disable_slat, disable_bw) plus reduce
1532 precision of the timeout somewhat to really shrink
1533 the gettimeofday() call count. With this option enabled,
1534 we only do about 0.4% of the gtod() calls we would have
1535 done if all time keeping was enabled.
1536
be4ecfdf
JA
1537gtod_cpu=int Sometimes it's cheaper to dedicate a single thread of
1538 execution to just getting the current time. Fio (and
1539 databases, for instance) are very intensive on gettimeofday()
1540 calls. With this option, you can set one CPU aside for
1541 doing nothing but logging current time to a shared memory
1542 location. Then the other threads/processes that run IO
1543 workloads need only copy that segment, instead of entering
1544 the kernel with a gettimeofday() call. The CPU set aside
1545 for doing these time calls will be excluded from other
1546 uses. Fio will manually clear it from the CPU mask of other
1547 jobs.
a696fa2a 1548
06842027 1549continue_on_error=str Normally fio will exit the job on the first observed
f2bba182
RR
1550 failure. If this option is set, fio will continue the job when
1551 there is a 'non-fatal error' (EIO or EILSEQ) until the runtime
1552 is exceeded or the I/O size specified is completed. If this
1553 option is used, there are two more stats that are appended,
1554 the total error count and the first error. The error field
1555 given in the stats is the first error that was hit during the
1556 run.
be4ecfdf 1557
06842027
SL
1558 The allowed values are:
1559
1560 none Exit on any IO or verify errors.
1561
1562 read Continue on read errors, exit on all others.
1563
1564 write Continue on write errors, exit on all others.
1565
1566 io Continue on any IO error, exit on all others.
1567
1568 verify Continue on verify errors, exit on all others.
1569
1570 all Continue on all errors.
1571
1572 0 Backward-compatible alias for 'none'.
1573
1574 1 Backward-compatible alias for 'all'.
1575
8b28bd41
DM
1576ignore_error=str Sometimes you want to ignore some errors during test
1577 in that case you can specify error list for each error type.
1578 ignore_error=READ_ERR_LIST,WRITE_ERR_LIST,VERIFY_ERR_LIST
1579 errors for given error type is separated with ':'. Error
1580 may be symbol ('ENOSPC', 'ENOMEM') or integer.
1581 Example:
1582 ignore_error=EAGAIN,ENOSPC:122
66c098b8
BC
1583 This option will ignore EAGAIN from READ, and ENOSPC and
1584 122(EDQUOT) from WRITE.
8b28bd41
DM
1585
1586error_dump=bool If set dump every error even if it is non fatal, true
1587 by default. If disabled only fatal error will be dumped
66c098b8 1588
6adb38a1
JA
1589cgroup=str Add job to this control group. If it doesn't exist, it will
1590 be created. The system must have a mounted cgroup blkio
1591 mount point for this to work. If your system doesn't have it
1592 mounted, you can do so with:
a696fa2a
JA
1593
1594 # mount -t cgroup -o blkio none /cgroup
1595
a696fa2a
JA
1596cgroup_weight=int Set the weight of the cgroup to this value. See
1597 the documentation that comes with the kernel, allowed values
1598 are in the range of 100..1000.
71bfa161 1599
7de87099
VG
1600cgroup_nodelete=bool Normally fio will delete the cgroups it has created after
1601 the job completion. To override this behavior and to leave
1602 cgroups around after the job completion, set cgroup_nodelete=1.
1603 This can be useful if one wants to inspect various cgroup
1604 files after job completion. Default: false
1605
e0b0d892
JA
1606uid=int Instead of running as the invoking user, set the user ID to
1607 this value before the thread/process does any work.
1608
1609gid=int Set group ID, see uid.
1610
9e684a49
DE
1611flow_id=int The ID of the flow. If not specified, it defaults to being a
1612 global flow. See flow.
1613
1614flow=int Weight in token-based flow control. If this value is used, then
1615 there is a 'flow counter' which is used to regulate the
1616 proportion of activity between two or more jobs. fio attempts
1617 to keep this flow counter near zero. The 'flow' parameter
1618 stands for how much should be added or subtracted to the flow
1619 counter on each iteration of the main I/O loop. That is, if
1620 one job has flow=8 and another job has flow=-1, then there
1621 will be a roughly 1:8 ratio in how much one runs vs the other.
1622
1623flow_watermark=int The maximum value that the absolute value of the flow
1624 counter is allowed to reach before the job must wait for a
1625 lower value of the counter.
1626
1627flow_sleep=int The period of time, in microseconds, to wait after the flow
1628 watermark has been exceeded before retrying operations
1629
de890a1e
SL
1630In addition, there are some parameters which are only valid when a specific
1631ioengine is in use. These are used identically to normal parameters, with the
1632caveat that when used on the command line, they must come after the ioengine
1633that defines them is selected.
1634
1635[libaio] userspace_reap Normally, with the libaio engine in use, fio will use
1636 the io_getevents system call to reap newly returned events.
1637 With this flag turned on, the AIO ring will be read directly
1638 from user-space to reap events. The reaping mode is only
1639 enabled when polling for a minimum of 0 events (eg when
1640 iodepth_batch_complete=0).
1641
0353050f
JA
1642[cpu] cpuload=int Attempt to use the specified percentage of CPU cycles.
1643
1644[cpu] cpuchunks=int Split the load into cycles of the given time. In
1645 microseconds.
1646
046395d7
JA
1647[cpu] exit_on_io_done=bool Detect when IO threads are done, then exit.
1648
de890a1e
SL
1649[netsplice] hostname=str
1650[net] hostname=str The host name or IP address to use for TCP or UDP based IO.
1651 If the job is a TCP listener or UDP reader, the hostname is not
b511c9aa
SB
1652 used and must be omitted unless it is a valid UDP multicast
1653 address.
de890a1e
SL
1654
1655[netsplice] port=int
6315af9d
JA
1656[net] port=int The TCP or UDP port to bind to or connect to. If this is used
1657with numjobs to spawn multiple instances of the same job type, then this will
1658be the starting port number since fio will use a range of ports.
de890a1e 1659
b93b6a2e
SB
1660[netsplice] interface=str
1661[net] interface=str The IP address of the network interface used to send or
1662 receive UDP multicast
1663
d3a623de
SB
1664[netsplice] ttl=int
1665[net] ttl=int Time-to-live value for outgoing UDP multicast packets.
1666 Default: 1
1667
1d360ffb
JA
1668[netsplice] nodelay=bool
1669[net] nodelay=bool Set TCP_NODELAY on TCP connections.
1670
de890a1e
SL
1671[netsplice] protocol=str
1672[netsplice] proto=str
1673[net] protocol=str
1674[net] proto=str The network protocol to use. Accepted values are:
1675
1676 tcp Transmission control protocol
49ccb8c1 1677 tcpv6 Transmission control protocol V6
f5cc3d0e 1678 udp User datagram protocol
49ccb8c1 1679 udpv6 User datagram protocol V6
de890a1e
SL
1680 unix UNIX domain socket
1681
1682 When the protocol is TCP or UDP, the port must also be given,
1683 as well as the hostname if the job is a TCP listener or UDP
1684 reader. For unix sockets, the normal filename option should be
1685 used and the port is invalid.
1686
1687[net] listen For TCP network connections, tell fio to listen for incoming
1688 connections rather than initiating an outgoing connection. The
1689 hostname must be omitted if this option is used.
1008602c 1690
b511c9aa 1691[net] pingpong Normaly a network writer will just continue writing data, and
7aeb1e94
JA
1692 a network reader will just consume packages. If pingpong=1
1693 is set, a writer will send its normal payload to the reader,
1694 then wait for the reader to send the same payload back. This
1695 allows fio to measure network latencies. The submission
1696 and completion latencies then measure local time spent
1697 sending or receiving, and the completion latency measures
1698 how long it took for the other end to receive and send back.
b511c9aa
SB
1699 For UDP multicast traffic pingpong=1 should only be set for a
1700 single reader when multiple readers are listening to the same
1701 address.
7aeb1e94 1702
1008602c
JA
1703[net] window_size Set the desired socket buffer size for the connection.
1704
e5f34d95
JA
1705[net] mss Set the TCP maximum segment size (TCP_MAXSEG).
1706
d54fce84
DM
1707[e4defrag] donorname=str
1708 File will be used as a block donor(swap extents between files)
1709[e4defrag] inplace=int
66c098b8 1710 Configure donor file blocks allocation strategy
d54fce84
DM
1711 0(default): Preallocate donor's file on init
1712 1 : allocate space immidietly inside defragment event,
1713 and free right after event
1714
de890a1e
SL
1715
1716
71bfa161
JA
17176.0 Interpreting the output
1718---------------------------
1719
1720fio spits out a lot of output. While running, fio will display the
1721status of the jobs created. An example of that would be:
1722
73c8b082 1723Threads: 1: [_r] [24.8% done] [ 13509/ 8334 kb/s] [eta 00h:01m:31s]
71bfa161
JA
1724
1725The characters inside the square brackets denote the current status of
1726each thread. The possible values (in typical life cycle order) are:
1727
1728Idle Run
1729---- ---
1730P Thread setup, but not started.
1731C Thread created.
9c6f6316 1732I Thread initialized, waiting or generating necessary data.
b0f65863 1733 p Thread running pre-reading file(s).
71bfa161
JA
1734 R Running, doing sequential reads.
1735 r Running, doing random reads.
1736 W Running, doing sequential writes.
1737 w Running, doing random writes.
1738 M Running, doing mixed sequential reads/writes.
1739 m Running, doing mixed random reads/writes.
1740 F Running, currently waiting for fsync()
3d434057 1741 f Running, finishing up (writing IO logs, etc)
fc6bd43c 1742 V Running, doing verification of written data.
71bfa161 1743E Thread exited, not reaped by main thread yet.
4f7e57a4
JA
1744_ Thread reaped, or
1745X Thread reaped, exited with an error.
a5e371a6 1746K Thread reaped, exited due to signal.
71bfa161 1747
3e2e48a7
JA
1748Fio will condense the thread string as not to take up more space on the
1749command line as is needed. For instance, if you have 10 readers and 10
1750writers running, the output would look like this:
1751
1752Jobs: 20 (f=20): [R(10),W(10)] [4.0% done] [2103MB/0KB/0KB /s] [538K/0/0 iops] [eta 57m:36s]
1753
1754Fio will still maintain the ordering, though. So the above means that jobs
17551..10 are readers, and 11..20 are writers.
1756
71bfa161 1757The other values are fairly self explanatory - number of threads
c9f60304
JA
1758currently running and doing io, rate of io since last check (read speed
1759listed first, then write speed), and the estimated completion percentage
1760and time for the running group. It's impossible to estimate runtime of
4f7e57a4
JA
1761the following groups (if any). Note that the string is displayed in order,
1762so it's possible to tell which of the jobs are currently doing what. The
1763first character is the first job defined in the job file, and so forth.
71bfa161
JA
1764
1765When fio is done (or interrupted by ctrl-c), it will show the data for
1766each thread, group of threads, and disks in that order. For each data
1767direction, the output looks like:
1768
1769Client1 (g=0): err= 0:
35649e58 1770 write: io= 32MB, bw= 666KB/s, iops=89 , runt= 50320msec
6104ddb6
JA
1771 slat (msec): min= 0, max= 136, avg= 0.03, stdev= 1.92
1772 clat (msec): min= 0, max= 631, avg=48.50, stdev=86.82
b22989b9 1773 bw (KB/s) : min= 0, max= 1196, per=51.00%, avg=664.02, stdev=681.68
e7823a94 1774 cpu : usr=1.49%, sys=0.25%, ctx=7969, majf=0, minf=17
71619dc2 1775 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
1776 submit : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0%
1777 complete : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0%
30061b97 1778 issued r/w: total=0/32768, short=0/0
8abdce66
JA
1779 lat (msec): 2=1.6%, 4=0.0%, 10=3.2%, 20=12.8%, 50=38.4%, 100=24.8%,
1780 lat (msec): 250=15.2%, 500=0.0%, 750=0.0%, 1000=0.0%, >=2048=0.0%
71bfa161
JA
1781
1782The client number is printed, along with the group id and error of that
1783thread. Below is the io statistics, here for writes. In the order listed,
1784they denote:
1785
1786io= Number of megabytes io performed
1787bw= Average bandwidth rate
35649e58 1788iops= Average IOs performed per second
71bfa161 1789runt= The runtime of that thread
72fbda2a 1790 slat= Submission latency (avg being the average, stdev being the
71bfa161
JA
1791 standard deviation). This is the time it took to submit
1792 the io. For sync io, the slat is really the completion
8a35c71e 1793 latency, since queue/complete is one operation there. This
bf9a3edb 1794 value can be in milliseconds or microseconds, fio will choose
8a35c71e 1795 the most appropriate base and print that. In the example
0d237712
LAG
1796 above, milliseconds is the best scale. Note: in --minimal mode
1797 latencies are always expressed in microseconds.
71bfa161
JA
1798 clat= Completion latency. Same names as slat, this denotes the
1799 time from submission to completion of the io pieces. For
1800 sync io, clat will usually be equal (or very close) to 0,
1801 as the time from submit to complete is basically just
1802 CPU time (io has already been done, see slat explanation).
1803 bw= Bandwidth. Same names as the xlat stats, but also includes
1804 an approximate percentage of total aggregate bandwidth
1805 this thread received in this group. This last value is
1806 only really useful if the threads in this group are on the
1807 same disk, since they are then competing for disk access.
1808cpu= CPU usage. User and system time, along with the number
e7823a94
JA
1809 of context switches this thread went through, usage of
1810 system and user time, and finally the number of major
1811 and minor page faults.
71619dc2
JA
1812IO depths= The distribution of io depths over the job life time. The
1813 numbers are divided into powers of 2, so for example the
1814 16= entries includes depths up to that value but higher
1815 than the previous entry. In other words, it covers the
1816 range from 16 to 31.
838bc709
JA
1817IO submit= How many pieces of IO were submitting in a single submit
1818 call. Each entry denotes that amount and below, until
1819 the previous entry - eg, 8=100% mean that we submitted
1820 anywhere in between 5-8 ios per submit call.
1821IO complete= Like the above submit number, but for completions instead.
30061b97
JA
1822IO issued= The number of read/write requests issued, and how many
1823 of them were short.
ec118304
JA
1824IO latencies= The distribution of IO completion latencies. This is the
1825 time from when IO leaves fio and when it gets completed.
1826 The numbers follow the same pattern as the IO depths,
1827 meaning that 2=1.6% means that 1.6% of the IO completed
8abdce66
JA
1828 within 2 msecs, 20=12.8% means that 12.8% of the IO
1829 took more than 10 msecs, but less than (or equal to) 20 msecs.
71bfa161
JA
1830
1831After each client has been listed, the group statistics are printed. They
1832will look like this:
1833
1834Run status group 0 (all jobs):
b22989b9
JA
1835 READ: io=64MB, aggrb=22178, minb=11355, maxb=11814, mint=2840msec, maxt=2955msec
1836 WRITE: io=64MB, aggrb=1302, minb=666, maxb=669, mint=50093msec, maxt=50320msec
71bfa161
JA
1837
1838For each data direction, it prints:
1839
1840io= Number of megabytes io performed.
1841aggrb= Aggregate bandwidth of threads in this group.
1842minb= The minimum average bandwidth a thread saw.
1843maxb= The maximum average bandwidth a thread saw.
1844mint= The smallest runtime of the threads in that group.
1845maxt= The longest runtime of the threads in that group.
1846
1847And finally, the disk statistics are printed. They will look like this:
1848
1849Disk stats (read/write):
1850 sda: ios=16398/16511, merge=30/162, ticks=6853/819634, in_queue=826487, util=100.00%
1851
1852Each value is printed for both reads and writes, with reads first. The
1853numbers denote:
1854
1855ios= Number of ios performed by all groups.
1856merge= Number of merges io the io scheduler.
1857ticks= Number of ticks we kept the disk busy.
1858io_queue= Total time spent in the disk queue.
1859util= The disk utilization. A value of 100% means we kept the disk
1860 busy constantly, 50% would be a disk idling half of the time.
1861
8423bd11
JA
1862It is also possible to get fio to dump the current output while it is
1863running, without terminating the job. To do that, send fio the USR1 signal.
06464907
JA
1864You can also get regularly timed dumps by using the --status-interval
1865parameter, or by creating a file in /tmp named fio-dump-status. If fio
1866sees this file, it will unlink it and dump the current output status.
8423bd11 1867
71bfa161
JA
1868
18697.0 Terse output
1870----------------
1871
1872For scripted usage where you typically want to generate tables or graphs
6af019c9 1873of the results, fio can output the results in a semicolon separated format.
71bfa161
JA
1874The format is one long line of values, such as:
1875
562c2d2f
DN
18762;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%
1877A description of this job goes here.
1878
1879The job description (if provided) follows on a second line.
71bfa161 1880
525c2bfa
JA
1881To enable terse output, use the --minimal command line option. The first
1882value is the version of the terse output format. If the output has to
1883be changed for some reason, this number will be incremented by 1 to
1884signify that change.
6820cb3b 1885
71bfa161
JA
1886Split up, the format is as follows:
1887
5e726d0a 1888 terse version, fio version, jobname, groupid, error
71bfa161 1889 READ status:
312b4af2 1890 Total IO (KB), bandwidth (KB/sec), IOPS, runtime (msec)
de196b82
JA
1891 Submission latency: min, max, mean, deviation (usec)
1892 Completion latency: min, max, mean, deviation (usec)
1db92cb6 1893 Completion latency percentiles: 20 fields (see below)
de196b82 1894 Total latency: min, max, mean, deviation (usec)
0d237712 1895 Bw (KB/s): min, max, aggregate percentage of total, mean, deviation
71bfa161 1896 WRITE status:
312b4af2 1897 Total IO (KB), bandwidth (KB/sec), IOPS, runtime (msec)
de196b82
JA
1898 Submission latency: min, max, mean, deviation (usec)
1899 Completion latency: min, max, mean, deviation (usec)
1db92cb6 1900 Completion latency percentiles: 20 fields (see below)
de196b82 1901 Total latency: min, max, mean, deviation (usec)
0d237712 1902 Bw (KB/s): min, max, aggregate percentage of total, mean, deviation
046ee302 1903 CPU usage: user, system, context switches, major faults, minor faults
2270890c 1904 IO depths: <=1, 2, 4, 8, 16, 32, >=64
562c2d2f
DN
1905 IO latencies microseconds: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
1906 IO latencies milliseconds: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000
f2f788dd
JA
1907 Disk utilization: Disk name, Read ios, write ios,
1908 Read merges, write merges,
1909 Read ticks, write ticks,
3d7cd9b4 1910 Time spent in queue, disk utilization percentage
de8f6de9 1911 Additional Info (dependent on continue_on_error, default off): total # errors, first error code
66c098b8 1912
de8f6de9 1913 Additional Info (dependent on description being set): Text description
25c8b9d7 1914
1db92cb6
JA
1915Completion latency percentiles can be a grouping of up to 20 sets, so
1916for the terse output fio writes all of them. Each field will look like this:
1917
1918 1.00%=6112
1919
1920which is the Xth percentile, and the usec latency associated with it.
1921
f2f788dd
JA
1922For disk utilization, all disks used by fio are shown. So for each disk
1923there will be a disk utilization section.
1924
25c8b9d7
PD
1925
19268.0 Trace file format
1927---------------------
66c098b8 1928There are two trace file format that you can encounter. The older (v1) format
25c8b9d7
PD
1929is unsupported since version 1.20-rc3 (March 2008). It will still be described
1930below in case that you get an old trace and want to understand it.
1931
1932In any case the trace is a simple text file with a single action per line.
1933
1934
19358.1 Trace file format v1
1936------------------------
1937Each line represents a single io action in the following format:
1938
1939rw, offset, length
1940
1941where rw=0/1 for read/write, and the offset and length entries being in bytes.
1942
1943This format is not supported in Fio versions => 1.20-rc3.
1944
1945
19468.2 Trace file format v2
1947------------------------
1948The second version of the trace file format was added in Fio version 1.17.
1949It allows to access more then one file per trace and has a bigger set of
1950possible file actions.
1951
1952The first line of the trace file has to be:
1953
1954fio version 2 iolog
1955
1956Following this can be lines in two different formats, which are described below.
1957
1958The file management format:
1959
1960filename action
1961
1962The filename is given as an absolute path. The action can be one of these:
1963
1964add Add the given filename to the trace
66c098b8 1965open Open the file with the given filename. The filename has to have
25c8b9d7
PD
1966 been added with the add action before.
1967close Close the file with the given filename. The file has to have been
1968 opened before.
1969
1970
1971The file io action format:
1972
1973filename action offset length
1974
1975The filename is given as an absolute path, and has to have been added and opened
66c098b8 1976before it can be used with this format. The offset and length are given in
25c8b9d7
PD
1977bytes. The action can be one of these:
1978
1979wait Wait for 'offset' microseconds. Everything below 100 is discarded.
1980read Read 'length' bytes beginning from 'offset'
1981write Write 'length' bytes beginning from 'offset'
1982sync fsync() the file
1983datasync fdatasync() the file
1984trim trim the given file from the given 'offset' for 'length' bytes
f2a2ce0e
HL
1985
1986
19879.0 CPU idleness profiling
06464907 1988--------------------------
f2a2ce0e
HL
1989In some cases, we want to understand CPU overhead in a test. For example,
1990we test patches for the specific goodness of whether they reduce CPU usage.
1991fio implements a balloon approach to create a thread per CPU that runs at
1992idle priority, meaning that it only runs when nobody else needs the cpu.
1993By measuring the amount of work completed by the thread, idleness of each
1994CPU can be derived accordingly.
1995
1996An unit work is defined as touching a full page of unsigned characters. Mean
1997and standard deviation of time to complete an unit work is reported in "unit
1998work" section. Options can be chosen to report detailed percpu idleness or
1999overall system idleness by aggregating percpu stats.
99b9a85a
JA
2000
2001
200210.0 Verification and triggers
2003------------------------------
2004Fio is usually run in one of two ways, when data verification is done. The
2005first is a normal write job of some sort with verify enabled. When the
2006write phase has completed, fio switches to reads and verifies everything
2007it wrote. The second model is running just the write phase, and then later
2008on running the same job (but with reads instead of writes) to repeat the
2009same IO patterns and verify the contents. Both of these methods depend
2010on the write phase being completed, as fio otherwise has no idea how much
2011data was written.
2012
2013With verification triggers, fio supports dumping the current write state
2014to local files. Then a subsequent read verify workload can load this state
2015and know exactly where to stop. This is useful for testing cases where
2016power is cut to a server in a managed fashion, for instance.
2017
2018A verification trigger consists of two things:
2019
20201) Storing the write state of each job
20212) Executing a trigger command
2022
2023The write state is relatively small, on the order of hundreds of bytes
2024to single kilobytes. It contains information on the number of completions
2025done, the last X completions, etc.
2026
2027A trigger is invoked either through creation ('touch') of a specified
2028file in the system, or through a timeout setting. If fio is run with
2029--trigger-file=/tmp/trigger-file, then it will continually check for
2030the existence of /tmp/trigger-file. When it sees this file, it will
2031fire off the trigger (thus saving state, and executing the trigger
2032command).
2033
2034For client/server runs, there's both a local and remote trigger. If
2035fio is running as a server backend, it will send the job states back
2036to the client for safe storage, then execute the remote trigger, if
2037specified. If a local trigger is specified, the server will still send
2038back the write state, but the client will then execute the trigger.
2039
204010.1 Verification trigger example
2041---------------------------------
2042Lets say we want to run a powercut test on the remote machine 'server'.
2043Our write workload is in write-test.fio. We want to cut power to 'server'
2044at some point during the run, and we'll run this test from the safety
2045or our local machine, 'localbox'. On the server, we'll start the fio
2046backend normally:
2047
2048server# fio --server
2049
2050and on the client, we'll fire off the workload:
2051
2052localbox$ fio --client=server --trigger-file=/tmp/my-trigger --trigger-remote="bash -c \"echo b > /proc/sysrq-triger\""
2053
2054We set /tmp/my-trigger as the trigger file, and we tell fio to execute
2055
2056echo b > /proc/sysrq-trigger
2057
2058on the server once it has received the trigger and sent us the write
2059state. This will work, but it's not _really_ cutting power to the server,
2060it's merely abruptly rebooting it. If we have a remote way of cutting
2061power to the server through IPMI or similar, we could do that through
2062a local trigger command instead. Lets assume we have a script that does
2063IPMI reboot of a given hostname, ipmi-reboot. On localbox, we could
2064then have run fio with a local trigger instead:
2065
2066localbox$ fio --client=server --trigger-file=/tmp/my-trigger --trigger="ipmi-reboot server"
2067
2068For this case, fio would wait for the server to send us the write state,
2069then execute 'ipmi-reboot server' when that happened.
2070
207110.1 Loading verify state
2072-------------------------
2073To load store write state, read verification job file must contain
2074the verify_state_load option. If that is set, fio will load the previously
2075stored state. For a local fio run this is done by loading the files directly,
2076and on a client/server run, the server backend will ask the client to send
2077the files over and load them from there.