fio: HOWTO update
[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
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 lets look at a really simple job file that define to threads, each
115 randomly reading from a 128MiB 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 Lets look at an example that have 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 32KiB and define numjobs to 4 to
154 fork 4 identical jobs. The result is 4 processes each randomly writing
155 to their own 64MiB 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 fio ships with a few example job files, you can also look there for
162 inspiration.
163
164
165 5.0 Detailed list of parameters
166 -------------------------------
167
168 This section describes in details each parameter associated with a job.
169 Some parameters take an option of a given type, such as an integer or
170 a string. The following types are used:
171
172 str     String. This is a sequence of alpha characters.
173 int     Integer. A whole number value, can be negative. If prefixed with
174         0x, the integer is assumed to be of base 16 (hexidecimal).
175 siint   SI integer. A whole number value, which may contain a postfix
176         describing the base of the number. Accepted postfixes are k/m/g,
177         meaning kilo, mega, and giga. So if you want to specify 4096,
178         you could either write out '4096' or just give 4k. The postfixes
179         signify base 2 values, so 1024 is 1k and 1024k is 1m and so on.
180         If the option accepts an upper and lower range, use a colon ':'
181         or minus '-' to seperate such values. See irange.
182 bool    Boolean. Usually parsed as an integer, however only defined for
183         true and false (1 and 0).
184 irange  Integer range with postfix. Allows value range to be given, such
185         as 1024-4096. A colon may also be used as the seperator, eg
186         1k:4k. If the option allows two sets of ranges, they can be
187         specified with a ',' or '/' delimiter: 1k-4k/8k-32k. Also see
188         siint.
189
190 With the above in mind, here follows the complete list of fio job
191 parameters.
192
193 name=str        ASCII name of the job. This may be used to override the
194                 name printed by fio for this job. Otherwise the job
195                 name is used. On the command line this parameter has the
196                 special purpose of also signaling the start of a new
197                 job.
198
199 description=str Text description of the job. Doesn't do anything except
200                 dump this text description when this job is run. It's
201                 not parsed.
202
203 directory=str   Prefix filenames with this directory. Used to places files
204                 in a different location than "./".
205
206 filename=str    Fio normally makes up a filename based on the job name,
207                 thread number, and file number. If you want to share
208                 files between threads in a job or several jobs, specify
209                 a filename for each of them to override the default. If
210                 the ioengine used is 'net', the filename is the host and
211                 port to connect to in the format of =host/port. If the
212                 ioengine is file based, you can specify a number of files
213                 by seperating the names with a ':' colon. So if you wanted
214                 a job to open /dev/sda and /dev/sdb as the two working files,
215                 you would use filename=/dev/sda:/dev/sdb. '-' is a reserved
216                 name, meaning stdin or stdout. Which of the two depends
217                 on the read/write direction set.
218
219 opendir=str     Tell fio to recursively add any file it can find in this
220                 directory and down the file system tree.
221
222 readwrite=str
223 rw=str          Type of io pattern. Accepted values are:
224
225                         read            Sequential reads
226                         write           Sequential writes
227                         randwrite       Random writes
228                         randread        Random reads
229                         rw              Sequential mixed reads and writes
230                         randrw          Random mixed reads and writes
231
232                 For the mixed io types, the default is to split them 50/50.
233                 For certain types of io the result may still be skewed a bit,
234                 since the speed may be different. It is possible to specify
235                 a number of IO's to do before getting a new offset - this
236                 is only useful for random IO, where fio would normally
237                 generate a new random offset for every IO. If you append
238                 eg 8 to randread, you would get a new random offset for
239                 every 8 IO's. The result would be a seek for only every 8
240                 IO's, instead of for every IO. Use rw=randread:8 to specify
241                 that.
242
243 randrepeat=bool For random IO workloads, seed the generator in a predictable
244                 way so that results are repeatable across repetitions.
245
246 fadvise_hint=bool By default, fio will use fadvise() to advise the kernel
247                 on what IO patterns it is likely to issue. Sometimes you
248                 want to test specific IO patterns without telling the
249                 kernel about it, in which case you can disable this option.
250                 If set, fio will use POSIX_FADV_SEQUENTIAL for sequential
251                 IO and POSIX_FADV_RANDOM for random IO.
252
253 size=siint      The total size of file io for this job. Fio will run until
254                 this many bytes has been transferred, unless runtime is
255                 limited by other options (such as 'runtime', for instance).
256                 Unless specific nr_files and filesize options are given,
257                 fio will divide this size between the available files
258                 specified by the job.
259
260 filesize=siint  Individual file sizes. May be a range, in which case fio
261                 will select sizes for files at random within the given range
262                 and limited to 'size' in total (if that is given). If not
263                 given, each created file is the same size.
264
265 fill_device=bool Sets size to something really large and waits for ENOSPC (no
266                 space left on device) as the terminating condition. Only makes
267                 sense with sequential write.
268
269 blocksize=siint
270 bs=siint        The block size used for the io units. Defaults to 4k. Values
271                 can be given for both read and writes. If a single siint is
272                 given, it will apply to both. If a second siint is specified
273                 after a comma, it will apply to writes only. In other words,
274                 the format is either bs=read_and_write or bs=read,write.
275                 bs=4k,8k will thus use 4k blocks for reads, and 8k blocks
276                 for writes. If you only wish to set the write size, you
277                 can do so by passing an empty read size - bs=,8k will set
278                 8k for writes and leave the read default value.
279
280 blocksize_range=irange
281 bsrange=irange  Instead of giving a single block size, specify a range
282                 and fio will mix the issued io block sizes. The issued
283                 io unit will always be a multiple of the minimum value
284                 given (also see bs_unaligned). Applies to both reads and
285                 writes, however a second range can be given after a comma.
286                 See bs=.
287
288 bssplit=str     Sometimes you want even finer grained control of the
289                 block sizes issued, not just an even split between them.
290                 This option allows you to weight various block sizes,
291                 so that you are able to define a specific amount of
292                 block sizes issued. The format for this option is:
293
294                         bssplit=blocksize/percentage:blocksize/percentage
295
296                 for as many block sizes as needed. So if you want to define
297                 a workload that has 50% 64k blocks, 10% 4k blocks, and
298                 40% 32k blocks, you would write:
299
300                         bssplit=4k/10:64k/50:32k/40
301
302                 Ordering does not matter. If the percentage is left blank,
303                 fio will fill in the remaining values evenly. So a bssplit
304                 option like this one:
305
306                         bssplit=4k/50:1k/:32k/
307
308                 would have 50% 4k ios, and 25% 1k and 32k ios. The percentages
309                 always add up to 100, if bssplit is given a range that adds
310                 up to more, it will error out.
311
312 blocksize_unaligned
313 bs_unaligned    If this option is given, any byte size value within bsrange
314                 may be used as a block range. This typically wont work with
315                 direct IO, as that normally requires sector alignment.
316
317 zero_buffers    If this option is given, fio will init the IO buffers to
318                 all zeroes. The default is to fill them with random data.
319
320 nrfiles=int     Number of files to use for this job. Defaults to 1.
321
322 openfiles=int   Number of files to keep open at the same time. Defaults to
323                 the same as nrfiles, can be set smaller to limit the number
324                 simultaneous opens.
325
326 file_service_type=str  Defines how fio decides which file from a job to
327                 service next. The following types are defined:
328
329                         random  Just choose a file at random.
330
331                         roundrobin  Round robin over open files. This
332                                 is the default.
333
334                 The string can have a number appended, indicating how
335                 often to switch to a new file. So if option random:4 is
336                 given, fio will switch to a new random file after 4 ios
337                 have been issued.
338
339 ioengine=str    Defines how the job issues io to the file. The following
340                 types are defined:
341
342                         sync    Basic read(2) or write(2) io. lseek(2) is
343                                 used to position the io location.
344
345                         psync   Basic pread(2) or pwrite(2) io.
346
347                         vsync   Basic readv(2) or writev(2) IO.
348
349                         libaio  Linux native asynchronous io.
350
351                         posixaio glibc posix asynchronous io.
352
353                         mmap    File is memory mapped and data copied
354                                 to/from using memcpy(3).
355
356                         splice  splice(2) is used to transfer the data and
357                                 vmsplice(2) to transfer data from user
358                                 space to the kernel.
359
360                         syslet-rw Use the syslet system calls to make
361                                 regular read/write async.
362
363                         sg      SCSI generic sg v3 io. May either be
364                                 synchronous using the SG_IO ioctl, or if
365                                 the target is an sg character device
366                                 we use read(2) and write(2) for asynchronous
367                                 io.
368
369                         null    Doesn't transfer any data, just pretends
370                                 to. This is mainly used to exercise fio
371                                 itself and for debugging/testing purposes.
372
373                         net     Transfer over the network to given host:port.
374                                 'filename' must be set appropriately to
375                                 filename=host/port regardless of send
376                                 or receive, if the latter only the port
377                                 argument is used.
378
379                         netsplice Like net, but uses splice/vmsplice to
380                                 map data and send/receive.
381
382                         cpuio   Doesn't transfer any data, but burns CPU
383                                 cycles according to the cpuload= and
384                                 cpucycle= options. Setting cpuload=85
385                                 will cause that job to do nothing but burn
386                                 85% of the CPU. In case of SMP machines,
387                                 use numjobs=<no_of_cpu> to get desired CPU
388                                 usage, as the cpuload only loads a single
389                                 CPU at the desired rate.
390
391                         guasi   The GUASI IO engine is the Generic Userspace
392                                 Asyncronous Syscall Interface approach
393                                 to async IO. See
394
395                                 http://www.xmailserver.org/guasi-lib.html
396
397                                 for more info on GUASI.
398
399                         external Prefix to specify loading an external
400                                 IO engine object file. Append the engine
401                                 filename, eg ioengine=external:/tmp/foo.o
402                                 to load ioengine foo.o in /tmp.
403
404 iodepth=int     This defines how many io units to keep in flight against
405                 the file. The default is 1 for each file defined in this
406                 job, can be overridden with a larger value for higher
407                 concurrency.
408
409 iodepth_batch=int This defines how many pieces of IO to submit at once.
410                 It defaults to 1 which means that we submit each IO
411                 as soon as it is available, but can be raised to submit
412                 bigger batches of IO at the time.
413
414 iodepth_low=int The low water mark indicating when to start filling
415                 the queue again. Defaults to the same as iodepth, meaning
416                 that fio will attempt to keep the queue full at all times.
417                 If iodepth is set to eg 16 and iodepth_low is set to 4, then
418                 after fio has filled the queue of 16 requests, it will let
419                 the depth drain down to 4 before starting to fill it again.
420
421 direct=bool     If value is true, use non-buffered io. This is usually
422                 O_DIRECT.
423
424 buffered=bool   If value is true, use buffered io. This is the opposite
425                 of the 'direct' option. Defaults to true.
426
427 offset=siint    Start io at the given offset in the file. The data before
428                 the given offset will not be touched. This effectively
429                 caps the file size at real_size - offset.
430
431 fsync=int       If writing to a file, issue a sync of the dirty data
432                 for every number of blocks given. For example, if you give
433                 32 as a parameter, fio will sync the file for every 32
434                 writes issued. If fio is using non-buffered io, we may
435                 not sync the file. The exception is the sg io engine, which
436                 synchronizes the disk cache anyway.
437
438 overwrite=bool  If writing to a file, setup the file first and do overwrites.
439
440 end_fsync=bool  If true, fsync file contents when the job exits.
441
442 fsync_on_close=bool     If true, fio will fsync() a dirty file on close.
443                 This differs from end_fsync in that it will happen on every
444                 file close, not just at the end of the job.
445
446 rwmixcycle=int  Value in milliseconds describing how often to switch between
447                 reads and writes for a mixed workload. The default is
448                 500 msecs.
449
450 rwmixread=int   How large a percentage of the mix should be reads.
451
452 rwmixwrite=int  How large a percentage of the mix should be writes. If both
453                 rwmixread and rwmixwrite is given and the values do not add
454                 up to 100%, the latter of the two will be used to override
455                 the first.
456
457 norandommap     Normally fio will cover every block of the file when doing
458                 random IO. If this option is given, fio will just get a
459                 new random offset without looking at past io history. This
460                 means that some blocks may not be read or written, and that
461                 some blocks may be read/written more than once. This option
462                 is mutually exclusive with verify= for that reason, since
463                 fio doesn't track potential block rewrites which may alter
464                 the calculated checksum for that block.
465
466 nice=int        Run the job with the given nice value. See man nice(2).
467
468 prio=int        Set the io priority value of this job. Linux limits us to
469                 a positive value between 0 and 7, with 0 being the highest.
470                 See man ionice(1).
471
472 prioclass=int   Set the io priority class. See man ionice(1).
473
474 thinktime=int   Stall the job x microseconds after an io has completed before
475                 issuing the next. May be used to simulate processing being
476                 done by an application. See thinktime_blocks and
477                 thinktime_spin.
478
479 thinktime_spin=int
480                 Only valid if thinktime is set - pretend to spend CPU time
481                 doing something with the data received, before falling back
482                 to sleeping for the rest of the period specified by
483                 thinktime.
484
485 thinktime_blocks
486                 Only valid if thinktime is set - control how many blocks
487                 to issue, before waiting 'thinktime' usecs. If not set,
488                 defaults to 1 which will make fio wait 'thinktime' usecs
489                 after every block.
490
491 rate=int        Cap the bandwidth used by this job to this number of KiB/sec.
492
493 ratemin=int     Tell fio to do whatever it can to maintain at least this
494                 bandwidth. Failing to meet this requirement, will cause
495                 the job to exit.
496
497 rate_iops=int   Cap the bandwidth to this number of IOPS. Basically the same
498                 as rate, just specified independently of bandwidth. If the
499                 job is given a block size range instead of a fixed value,
500                 the smallest block size is used as the metric.
501
502 rate_iops_min=int If fio doesn't meet this rate of IO, it will cause
503                 the job to exit.
504
505 ratecycle=int   Average bandwidth for 'rate' and 'ratemin' over this number
506                 of milliseconds.
507
508 cpumask=int     Set the CPU affinity of this job. The parameter given is a
509                 bitmask of allowed CPU's the job may run on. So if you want
510                 the allowed CPUs to be 1 and 5, you would pass the decimal
511                 value of (1 << 1 | 1 << 5), or 34. See man
512                 sched_setaffinity(2). This may not work on all supported
513                 operating systems or kernel versions.
514
515 cpus_allowed=str Controls the same options as cpumask, but it allows a text
516                 setting of the permitted CPUs instead. So to use CPUs 1 and
517                 5, you would specify cpus_allowed=1,5.
518
519 startdelay=int  Start this job the specified number of seconds after fio
520                 has started. Only useful if the job file contains several
521                 jobs, and you want to delay starting some jobs to a certain
522                 time.
523
524 runtime=int     Tell fio to terminate processing after the specified number
525                 of seconds. It can be quite hard to determine for how long
526                 a specified job will run, so this parameter is handy to
527                 cap the total runtime to a given time.
528
529 time_based      If set, fio will run for the duration of the runtime
530                 specified even if the file(s) are completey read or
531                 written. It will simply loop over the same workload
532                 as many times as the runtime allows.
533
534 invalidate=bool Invalidate the buffer/page cache parts for this file prior
535                 to starting io. Defaults to true.
536
537 sync=bool       Use sync io for buffered writes. For the majority of the
538                 io engines, this means using O_SYNC.
539
540 iomem=str
541 mem=str         Fio can use various types of memory as the io unit buffer.
542                 The allowed values are:
543
544                         malloc  Use memory from malloc(3) as the buffers.
545
546                         shm     Use shared memory as the buffers. Allocated
547                                 through shmget(2).
548
549                         shmhuge Same as shm, but use huge pages as backing.
550
551                         mmap    Use mmap to allocate buffers. May either be
552                                 anonymous memory, or can be file backed if
553                                 a filename is given after the option. The
554                                 format is mem=mmap:/path/to/file.
555
556                         mmaphuge Use a memory mapped huge file as the buffer
557                                 backing. Append filename after mmaphuge, ala
558                                 mem=mmaphuge:/hugetlbfs/file
559
560                 The area allocated is a function of the maximum allowed
561                 bs size for the job, multiplied by the io depth given. Note
562                 that for shmhuge and mmaphuge to work, the system must have
563                 free huge pages allocated. This can normally be checked
564                 and set by reading/writing /proc/sys/vm/nr_hugepages on a
565                 Linux system. Fio assumes a huge page is 4MiB in size. So
566                 to calculate the number of huge pages you need for a given
567                 job file, add up the io depth of all jobs (normally one unless
568                 iodepth= is used) and multiply by the maximum bs set. Then
569                 divide that number by the huge page size. You can see the
570                 size of the huge pages in /proc/meminfo. If no huge pages
571                 are allocated by having a non-zero number in nr_hugepages,
572                 using mmaphuge or shmhuge will fail. Also see hugepage-size.
573
574                 mmaphuge also needs to have hugetlbfs mounted and the file
575                 location should point there. So if it's mounted in /huge,
576                 you would use mem=mmaphuge:/huge/somefile.
577
578 hugepage-size=siint
579                 Defines the size of a huge page. Must at least be equal
580                 to the system setting, see /proc/meminfo. Defaults to 4MiB.
581                 Should probably always be a multiple of megabytes, so using
582                 hugepage-size=Xm is the preferred way to set this to avoid
583                 setting a non-pow-2 bad value.
584
585 exitall         When one job finishes, terminate the rest. The default is
586                 to wait for each job to finish, sometimes that is not the
587                 desired action.
588
589 bwavgtime=int   Average the calculated bandwidth over the given time. Value
590                 is specified in milliseconds.
591
592 create_serialize=bool   If true, serialize the file creating for the jobs.
593                         This may be handy to avoid interleaving of data
594                         files, which may greatly depend on the filesystem
595                         used and even the number of processors in the system.
596
597 create_fsync=bool       fsync the data file after creation. This is the
598                         default.
599
600 unlink=bool     Unlink the job files when done. Not the default, as repeated
601                 runs of that job would then waste time recreating the fileset
602                 again and again.
603
604 loops=int       Run the specified number of iterations of this job. Used
605                 to repeat the same workload a given number of times. Defaults
606                 to 1.
607
608 do_verify=bool  Run the verify phase after a write phase. Only makes sense if
609                 verify is set. Defaults to 1.
610
611 verify=str      If writing to a file, fio can verify the file contents
612                 after each iteration of the job. The allowed values are:
613
614                         md5     Use an md5 sum of the data area and store
615                                 it in the header of each block.
616
617                         crc64   Use an experimental crc64 sum of the data
618                                 area and store it in the header of each
619                                 block.
620
621                         crc32   Use a crc32 sum of the data area and store
622                                 it in the header of each block.
623
624                         crc16   Use a crc16 sum of the data area and store
625                                 it in the header of each block.
626
627                         crc7    Use a crc7 sum of the data area and store
628                                 it in the header of each block.
629
630                         sha512  Use sha512 as the checksum function.
631
632                         sha256  Use sha256 as the checksum function.
633
634                         meta    Write extra information about each io
635                                 (timestamp, block number etc.). The block
636                                 number is verified.
637
638                         null    Only pretend to verify. Useful for testing
639                                 internals with ioengine=null, not for much
640                                 else.
641
642                 This option can be used for repeated burn-in tests of a
643                 system to make sure that the written data is also
644                 correctly read back.
645
646 verifysort=bool If set, fio will sort written verify blocks when it deems
647                 it faster to read them back in a sorted manner. This is
648                 often the case when overwriting an existing file, since
649                 the blocks are already laid out in the file system. You
650                 can ignore this option unless doing huge amounts of really
651                 fast IO where the red-black tree sorting CPU time becomes
652                 significant.
653
654 verify_offset=siint     Swap the verification header with data somewhere else
655                         in the block before writing. Its swapped back before
656                         verifying.
657
658 verify_interval=siint   Write the verification header at a finer granularity
659                         than the blocksize. It will be written for chunks the
660                         size of header_interval. blocksize should divide this
661                         evenly.
662
663 verify_pattern=int      If set, fio will fill the io buffers with this
664                 pattern. Fio defaults to filling with totally random
665                 bytes, but sometimes it's interesting to fill with a known
666                 pattern for io verification purposes. Depending on the
667                 width of the pattern, fio will fill 1/2/3/4 bytes of the
668                 buffer at the time. The verify_pattern cannot be larger than
669                 a 32-bit quantity.
670
671 verify_fatal=bool       Normally fio will keep checking the entire contents
672                 before quitting on a block verification failure. If this
673                 option is set, fio will exit the job on the first observed
674                 failure.
675                 
676 stonewall       Wait for preceeding jobs in the job file to exit, before
677                 starting this one. Can be used to insert serialization
678                 points in the job file. A stone wall also implies starting
679                 a new reporting group.
680
681 new_group       Start a new reporting group. If this option isn't given,
682                 jobs in a file will be part of the same reporting group
683                 unless seperated by a stone wall (or if it's a group
684                 by itself, with the numjobs option).
685
686 numjobs=int     Create the specified number of clones of this job. May be
687                 used to setup a larger number of threads/processes doing
688                 the same thing. We regard that grouping of jobs as a
689                 specific group.
690
691 group_reporting If 'numjobs' is set, it may be interesting to display
692                 statistics for the group as a whole instead of for each
693                 individual job. This is especially true of 'numjobs' is
694                 large, looking at individual thread/process output quickly
695                 becomes unwieldy. If 'group_reporting' is specified, fio
696                 will show the final report per-group instead of per-job.
697
698 thread          fio defaults to forking jobs, however if this option is
699                 given, fio will use pthread_create(3) to create threads
700                 instead.
701
702 zonesize=siint  Divide a file into zones of the specified size. See zoneskip.
703
704 zoneskip=siint  Skip the specified number of bytes when zonesize data has
705                 been read. The two zone options can be used to only do
706                 io on zones of a file.
707
708 write_iolog=str Write the issued io patterns to the specified file. See
709                 read_iolog.
710
711 read_iolog=str  Open an iolog with the specified file name and replay the
712                 io patterns it contains. This can be used to store a
713                 workload and replay it sometime later. The iolog given
714                 may also be a blktrace binary file, which allows fio
715                 to replay a workload captured by blktrace. See blktrace
716                 for how to capture such logging data. For blktrace replay,
717                 the file needs to be turned into a blkparse binary data
718                 file first (blktrace <device> -d file_for_fio.bin).
719
720 write_bw_log    If given, write a bandwidth log of the jobs in this job
721                 file. Can be used to store data of the bandwidth of the
722                 jobs in their lifetime. The included fio_generate_plots
723                 script uses gnuplot to turn these text files into nice
724                 graphs.
725
726 write_lat_log   Same as write_bw_log, except that this option stores io
727                 completion latencies instead.
728
729 lockmem=siint   Pin down the specified amount of memory with mlock(2). Can
730                 potentially be used instead of removing memory or booting
731                 with less memory to simulate a smaller amount of memory.
732
733 exec_prerun=str Before running this job, issue the command specified
734                 through system(3).
735
736 exec_postrun=str After the job completes, issue the command specified
737                  though system(3).
738
739 ioscheduler=str Attempt to switch the device hosting the file to the specified
740                 io scheduler before running.
741
742 cpuload=int     If the job is a CPU cycle eater, attempt to use the specified
743                 percentage of CPU cycles.
744
745 cpuchunks=int   If the job is a CPU cycle eater, split the load into
746                 cycles of the given time. In milliseconds.
747
748 disk_util=bool  Generate disk utilization statistics, if the platform
749                 supports it. Defaults to on.
750
751
752 6.0 Interpreting the output
753 ---------------------------
754
755 fio spits out a lot of output. While running, fio will display the
756 status of the jobs created. An example of that would be:
757
758 Threads: 1: [_r] [24.8% done] [ 13509/  8334 kb/s] [eta 00h:01m:31s]
759
760 The characters inside the square brackets denote the current status of
761 each thread. The possible values (in typical life cycle order) are:
762
763 Idle    Run
764 ----    ---
765 P               Thread setup, but not started.
766 C               Thread created.
767 I               Thread initialized, waiting.
768         R       Running, doing sequential reads.
769         r       Running, doing random reads.
770         W       Running, doing sequential writes.
771         w       Running, doing random writes.
772         M       Running, doing mixed sequential reads/writes.
773         m       Running, doing mixed random reads/writes.
774         F       Running, currently waiting for fsync()
775 V               Running, doing verification of written data.
776 E               Thread exited, not reaped by main thread yet.
777 _               Thread reaped.
778
779 The other values are fairly self explanatory - number of threads
780 currently running and doing io, rate of io since last check (read speed
781 listed first, then write speed), and the estimated completion percentage
782 and time for the running group. It's impossible to estimate runtime of
783 the following groups (if any).
784
785 When fio is done (or interrupted by ctrl-c), it will show the data for
786 each thread, group of threads, and disks in that order. For each data
787 direction, the output looks like:
788
789 Client1 (g=0): err= 0:
790   write: io=    32MiB, bw=   666KiB/s, runt= 50320msec
791     slat (msec): min=    0, max=  136, avg= 0.03, stdev= 1.92
792     clat (msec): min=    0, max=  631, avg=48.50, stdev=86.82
793     bw (KiB/s) : min=    0, max= 1196, per=51.00%, avg=664.02, stdev=681.68
794   cpu        : usr=1.49%, sys=0.25%, ctx=7969, majf=0, minf=17
795   IO depths    : 1=0.1%, 2=0.3%, 4=0.5%, 8=99.0%, 16=0.0%, 32=0.0%, >32=0.0%
796      issued r/w: total=0/32768, short=0/0
797      lat (msec): 2=1.6%, 4=0.0%, 10=3.2%, 20=12.8%, 50=38.4%, 100=24.8%,
798      lat (msec): 250=15.2%, 500=0.0%, 750=0.0%, 1000=0.0%, >=2048=0.0%
799
800 The client number is printed, along with the group id and error of that
801 thread. Below is the io statistics, here for writes. In the order listed,
802 they denote:
803
804 io=             Number of megabytes io performed
805 bw=             Average bandwidth rate
806 runt=           The runtime of that thread
807         slat=   Submission latency (avg being the average, stdev being the
808                 standard deviation). This is the time it took to submit
809                 the io. For sync io, the slat is really the completion
810                 latency, since queue/complete is one operation there. This
811                 value can be in miliseconds or microseconds, fio will choose
812                 the most appropriate base and print that. In the example
813                 above, miliseconds is the best scale.
814         clat=   Completion latency. Same names as slat, this denotes the
815                 time from submission to completion of the io pieces. For
816                 sync io, clat will usually be equal (or very close) to 0,
817                 as the time from submit to complete is basically just
818                 CPU time (io has already been done, see slat explanation).
819         bw=     Bandwidth. Same names as the xlat stats, but also includes
820                 an approximate percentage of total aggregate bandwidth
821                 this thread received in this group. This last value is
822                 only really useful if the threads in this group are on the
823                 same disk, since they are then competing for disk access.
824 cpu=            CPU usage. User and system time, along with the number
825                 of context switches this thread went through, usage of
826                 system and user time, and finally the number of major
827                 and minor page faults.
828 IO depths=      The distribution of io depths over the job life time. The
829                 numbers are divided into powers of 2, so for example the
830                 16= entries includes depths up to that value but higher
831                 than the previous entry. In other words, it covers the
832                 range from 16 to 31.
833 IO issued=      The number of read/write requests issued, and how many
834                 of them were short.
835 IO latencies=   The distribution of IO completion latencies. This is the
836                 time from when IO leaves fio and when it gets completed.
837                 The numbers follow the same pattern as the IO depths,
838                 meaning that 2=1.6% means that 1.6% of the IO completed
839                 within 2 msecs, 20=12.8% means that 12.8% of the IO
840                 took more than 10 msecs, but less than (or equal to) 20 msecs.
841
842 After each client has been listed, the group statistics are printed. They
843 will look like this:
844
845 Run status group 0 (all jobs):
846    READ: io=64MiB, aggrb=22178, minb=11355, maxb=11814, mint=2840msec, maxt=2955msec
847   WRITE: io=64MiB, aggrb=1302, minb=666, maxb=669, mint=50093msec, maxt=50320msec
848
849 For each data direction, it prints:
850
851 io=             Number of megabytes io performed.
852 aggrb=          Aggregate bandwidth of threads in this group.
853 minb=           The minimum average bandwidth a thread saw.
854 maxb=           The maximum average bandwidth a thread saw.
855 mint=           The smallest runtime of the threads in that group.
856 maxt=           The longest runtime of the threads in that group.
857
858 And finally, the disk statistics are printed. They will look like this:
859
860 Disk stats (read/write):
861   sda: ios=16398/16511, merge=30/162, ticks=6853/819634, in_queue=826487, util=100.00%
862
863 Each value is printed for both reads and writes, with reads first. The
864 numbers denote:
865
866 ios=            Number of ios performed by all groups.
867 merge=          Number of merges io the io scheduler.
868 ticks=          Number of ticks we kept the disk busy.
869 io_queue=       Total time spent in the disk queue.
870 util=           The disk utilization. A value of 100% means we kept the disk
871                 busy constantly, 50% would be a disk idling half of the time.
872
873
874 7.0 Terse output
875 ----------------
876
877 For scripted usage where you typically want to generate tables or graphs
878 of the results, fio can output the results in a semicolon separated format.
879 The format is one long line of values, such as:
880
881 client1;0;0;1906777;1090804;1790;0;0;0.000000;0.000000;0;0;0.000000;0.000000;929380;1152890;25.510151%;1078276.333333;128948.113404;0;0;0;0;0;0.000000;0.000000;0;0;0.000000;0.000000;0;0;0.000000%;0.000000;0.000000;100.000000%;0.000000%;324;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%;0.0%;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%
882 ;0.0%;0.0%;0.0%;0.0%;0.0%
883
884 Split up, the format is as follows:
885
886         jobname, groupid, error
887         READ status:
888                 KiB IO, bandwidth (KiB/sec), runtime (msec)
889                 Submission latency: min, max, mean, deviation
890                 Completion latency: min, max, mean, deviation
891                 Bw: min, max, aggregate percentage of total, mean, deviation
892         WRITE status:
893                 KiB IO, bandwidth (KiB/sec), runtime (msec)
894                 Submission latency: min, max, mean, deviation
895                 Completion latency: min, max, mean, deviation
896                 Bw: min, max, aggregate percentage of total, mean, deviation
897         CPU usage: user, system, context switches, major faults, minor faults
898         IO depths: <=1, 2, 4, 8, 16, 32, >=64
899         IO latencies: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, >=2000
900         Text description
901