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