Improve depth marking
[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                         libaio  Linux native asynchronous io.
348
349                         posixaio glibc posix asynchronous io.
350
351                         mmap    File is memory mapped and data copied
352                                 to/from using memcpy(3).
353
354                         splice  splice(2) is used to transfer the data and
355                                 vmsplice(2) to transfer data from user
356                                 space to the kernel.
357
358                         syslet-rw Use the syslet system calls to make
359                                 regular read/write async.
360
361                         sg      SCSI generic sg v3 io. May either be
362                                 synchronous using the SG_IO ioctl, or if
363                                 the target is an sg character device
364                                 we use read(2) and write(2) for asynchronous
365                                 io.
366
367                         null    Doesn't transfer any data, just pretends
368                                 to. This is mainly used to exercise fio
369                                 itself and for debugging/testing purposes.
370
371                         net     Transfer over the network to given host:port.
372                                 'filename' must be set appropriately to
373                                 filename=host/port regardless of send
374                                 or receive, if the latter only the port
375                                 argument is used.
376
377                         netsplice Like net, but uses splice/vmsplice to
378                                 map data and send/receive.
379
380                         cpuio   Doesn't transfer any data, but burns CPU
381                                 cycles according to the cpuload= and
382                                 cpucycle= options. Setting cpuload=85
383                                 will cause that job to do nothing but burn
384                                 85% of the CPU.
385
386                         guasi   The GUASI IO engine is the Generic Userspace
387                                 Asyncronous Syscall Interface approach
388                                 to async IO. See
389
390                                 http://www.xmailserver.org/guasi-lib.html
391
392                                 for more info on GUASI.
393
394                         external Prefix to specify loading an external
395                                 IO engine object file. Append the engine
396                                 filename, eg ioengine=external:/tmp/foo.o
397                                 to load ioengine foo.o in /tmp.
398
399 iodepth=int     This defines how many io units to keep in flight against
400                 the file. The default is 1 for each file defined in this
401                 job, can be overridden with a larger value for higher
402                 concurrency.
403
404 iodepth_batch=int This defines how many pieces of IO to submit at once.
405                 It defaults to 1 which means that we submit each IO
406                 as soon as it is available, but can be raised to submit
407                 bigger batches of IO at the time.
408
409 iodepth_low=int The low water mark indicating when to start filling
410                 the queue again. Defaults to the same as iodepth, meaning
411                 that fio will attempt to keep the queue full at all times.
412                 If iodepth is set to eg 16 and iodepth_low is set to 4, then
413                 after fio has filled the queue of 16 requests, it will let
414                 the depth drain down to 4 before starting to fill it again.
415
416 direct=bool     If value is true, use non-buffered io. This is usually
417                 O_DIRECT.
418
419 buffered=bool   If value is true, use buffered io. This is the opposite
420                 of the 'direct' option. Defaults to true.
421
422 offset=siint    Start io at the given offset in the file. The data before
423                 the given offset will not be touched. This effectively
424                 caps the file size at real_size - offset.
425
426 fsync=int       If writing to a file, issue a sync of the dirty data
427                 for every number of blocks given. For example, if you give
428                 32 as a parameter, fio will sync the file for every 32
429                 writes issued. If fio is using non-buffered io, we may
430                 not sync the file. The exception is the sg io engine, which
431                 synchronizes the disk cache anyway.
432
433 overwrite=bool  If writing to a file, setup the file first and do overwrites.
434
435 end_fsync=bool  If true, fsync file contents when the job exits.
436
437 fsync_on_close=bool     If true, fio will fsync() a dirty file on close.
438                 This differs from end_fsync in that it will happen on every
439                 file close, not just at the end of the job.
440
441 rwmixcycle=int  Value in milliseconds describing how often to switch between
442                 reads and writes for a mixed workload. The default is
443                 500 msecs.
444
445 rwmixread=int   How large a percentage of the mix should be reads.
446
447 rwmixwrite=int  How large a percentage of the mix should be writes. If both
448                 rwmixread and rwmixwrite is given and the values do not add
449                 up to 100%, the latter of the two will be used to override
450                 the first.
451
452 norandommap     Normally fio will cover every block of the file when doing
453                 random IO. If this option is given, fio will just get a
454                 new random offset without looking at past io history. This
455                 means that some blocks may not be read or written, and that
456                 some blocks may be read/written more than once. This option
457                 is mutually exclusive with verify= for that reason, since
458                 fio doesn't track potential block rewrites which may alter
459                 the calculated checksum for that block.
460
461 nice=int        Run the job with the given nice value. See man nice(2).
462
463 prio=int        Set the io priority value of this job. Linux limits us to
464                 a positive value between 0 and 7, with 0 being the highest.
465                 See man ionice(1).
466
467 prioclass=int   Set the io priority class. See man ionice(1).
468
469 thinktime=int   Stall the job x microseconds after an io has completed before
470                 issuing the next. May be used to simulate processing being
471                 done by an application. See thinktime_blocks and
472                 thinktime_spin.
473
474 thinktime_spin=int
475                 Only valid if thinktime is set - pretend to spend CPU time
476                 doing something with the data received, before falling back
477                 to sleeping for the rest of the period specified by
478                 thinktime.
479
480 thinktime_blocks
481                 Only valid if thinktime is set - control how many blocks
482                 to issue, before waiting 'thinktime' usecs. If not set,
483                 defaults to 1 which will make fio wait 'thinktime' usecs
484                 after every block.
485
486 rate=int        Cap the bandwidth used by this job to this number of KiB/sec.
487
488 ratemin=int     Tell fio to do whatever it can to maintain at least this
489                 bandwidth. Failing to meet this requirement, will cause
490                 the job to exit.
491
492 rate_iops=int   Cap the bandwidth to this number of IOPS. Basically the same
493                 as rate, just specified independently of bandwidth. If the
494                 job is given a block size range instead of a fixed value,
495                 the smallest block size is used as the metric.
496
497 rate_iops_min=int If fio doesn't meet this rate of IO, it will cause
498                 the job to exit.
499
500 ratecycle=int   Average bandwidth for 'rate' and 'ratemin' over this number
501                 of milliseconds.
502
503 cpumask=int     Set the CPU affinity of this job. The parameter given is a
504                 bitmask of allowed CPU's the job may run on. So if you want
505                 the allowed CPUs to be 1 and 5, you would pass the decimal
506                 value of (1 << 1 | 1 << 5), or 34. See man
507                 sched_setaffinity(2). This may not work on all supported
508                 operating systems or kernel versions.
509
510 cpus_allowed=str Controls the same options as cpumask, but it allows a text
511                 setting of the permitted CPUs instead. So to use CPUs 1 and
512                 5, you would specify cpus_allowed=1,5.
513
514 startdelay=int  Start this job the specified number of seconds after fio
515                 has started. Only useful if the job file contains several
516                 jobs, and you want to delay starting some jobs to a certain
517                 time.
518
519 runtime=int     Tell fio to terminate processing after the specified number
520                 of seconds. It can be quite hard to determine for how long
521                 a specified job will run, so this parameter is handy to
522                 cap the total runtime to a given time.
523
524 time_based      If set, fio will run for the duration of the runtime
525                 specified even if the file(s) are completey read or
526                 written. It will simply loop over the same workload
527                 as many times as the runtime allows.
528
529 invalidate=bool Invalidate the buffer/page cache parts for this file prior
530                 to starting io. Defaults to true.
531
532 sync=bool       Use sync io for buffered writes. For the majority of the
533                 io engines, this means using O_SYNC.
534
535 iomem=str
536 mem=str         Fio can use various types of memory as the io unit buffer.
537                 The allowed values are:
538
539                         malloc  Use memory from malloc(3) as the buffers.
540
541                         shm     Use shared memory as the buffers. Allocated
542                                 through shmget(2).
543
544                         shmhuge Same as shm, but use huge pages as backing.
545
546                         mmap    Use mmap to allocate buffers. May either be
547                                 anonymous memory, or can be file backed if
548                                 a filename is given after the option. The
549                                 format is mem=mmap:/path/to/file.
550
551                         mmaphuge Use a memory mapped huge file as the buffer
552                                 backing. Append filename after mmaphuge, ala
553                                 mem=mmaphuge:/hugetlbfs/file
554
555                 The area allocated is a function of the maximum allowed
556                 bs size for the job, multiplied by the io depth given. Note
557                 that for shmhuge and mmaphuge to work, the system must have
558                 free huge pages allocated. This can normally be checked
559                 and set by reading/writing /proc/sys/vm/nr_hugepages on a
560                 Linux system. Fio assumes a huge page is 4MiB in size. So
561                 to calculate the number of huge pages you need for a given
562                 job file, add up the io depth of all jobs (normally one unless
563                 iodepth= is used) and multiply by the maximum bs set. Then
564                 divide that number by the huge page size. You can see the
565                 size of the huge pages in /proc/meminfo. If no huge pages
566                 are allocated by having a non-zero number in nr_hugepages,
567                 using mmaphuge or shmhuge will fail. Also see hugepage-size.
568
569                 mmaphuge also needs to have hugetlbfs mounted and the file
570                 location should point there. So if it's mounted in /huge,
571                 you would use mem=mmaphuge:/huge/somefile.
572
573 hugepage-size=siint
574                 Defines the size of a huge page. Must at least be equal
575                 to the system setting, see /proc/meminfo. Defaults to 4MiB.
576                 Should probably always be a multiple of megabytes, so using
577                 hugepage-size=Xm is the preferred way to set this to avoid
578                 setting a non-pow-2 bad value.
579
580 exitall         When one job finishes, terminate the rest. The default is
581                 to wait for each job to finish, sometimes that is not the
582                 desired action.
583
584 bwavgtime=int   Average the calculated bandwidth over the given time. Value
585                 is specified in milliseconds.
586
587 create_serialize=bool   If true, serialize the file creating for the jobs.
588                         This may be handy to avoid interleaving of data
589                         files, which may greatly depend on the filesystem
590                         used and even the number of processors in the system.
591
592 create_fsync=bool       fsync the data file after creation. This is the
593                         default.
594
595 unlink=bool     Unlink the job files when done. Not the default, as repeated
596                 runs of that job would then waste time recreating the fileset
597                 again and again.
598
599 loops=int       Run the specified number of iterations of this job. Used
600                 to repeat the same workload a given number of times. Defaults
601                 to 1.
602
603 do_verify=bool  Run the verify phase after a write phase. Only makes sense if
604                 verify is set. Defaults to 1.
605
606 verify=str      If writing to a file, fio can verify the file contents
607                 after each iteration of the job. The allowed values are:
608
609                         md5     Use an md5 sum of the data area and store
610                                 it in the header of each block.
611
612                         crc64   Use an experimental crc64 sum of the data
613                                 area and store it in the header of each
614                                 block.
615
616                         crc32   Use a crc32 sum of the data area and store
617                                 it in the header of each block.
618
619                         crc16   Use a crc16 sum of the data area and store
620                                 it in the header of each block.
621
622                         crc7    Use a crc7 sum of the data area and store
623                                 it in the header of each block.
624
625                         sha512  Use sha512 as the checksum function.
626
627                         sha256  Use sha256 as the checksum function.
628
629                         meta    Write extra information about each io
630                                 (timestamp, block number etc.). The block
631                                 number is verified.
632
633                         null    Only pretend to verify. Useful for testing
634                                 internals with ioengine=null, not for much
635                                 else.
636
637                 This option can be used for repeated burn-in tests of a
638                 system to make sure that the written data is also
639                 correctly read back.
640
641 verifysort=bool If set, fio will sort written verify blocks when it deems
642                 it faster to read them back in a sorted manner. This is
643                 often the case when overwriting an existing file, since
644                 the blocks are already laid out in the file system. You
645                 can ignore this option unless doing huge amounts of really
646                 fast IO where the red-black tree sorting CPU time becomes
647                 significant.
648
649 verify_offset=siint     Swap the verification header with data somewhere else
650                         in the block before writing. Its swapped back before
651                         verifying.
652
653 verify_interval=siint   Write the verification header at a finer granularity
654                         than the blocksize. It will be written for chunks the
655                         size of header_interval. blocksize should divide this
656                         evenly.
657
658 verify_pattern=int      If set, fio will fill the io buffers with this
659                 pattern. Fio defaults to filling with totally random
660                 bytes, but sometimes it's interesting to fill with a known
661                 pattern for io verification purposes. Depending on the
662                 width of the pattern, fio will fill 1/2/3/4 bytes of the
663                 buffer at the time. The verify_pattern cannot be larger than
664                 a 32-bit quantity.
665
666 verify_fatal=bool       Normally fio will keep checking the entire contents
667                 before quitting on a block verification failure. If this
668                 option is set, fio will exit the job on the first observed
669                 failure.
670                 
671 stonewall       Wait for preceeding jobs in the job file to exit, before
672                 starting this one. Can be used to insert serialization
673                 points in the job file. A stone wall also implies starting
674                 a new reporting group.
675
676 new_group       Start a new reporting group. If this option isn't given,
677                 jobs in a file will be part of the same reporting group
678                 unless seperated by a stone wall (or if it's a group
679                 by itself, with the numjobs option).
680
681 numjobs=int     Create the specified number of clones of this job. May be
682                 used to setup a larger number of threads/processes doing
683                 the same thing. We regard that grouping of jobs as a
684                 specific group.
685
686 group_reporting If 'numjobs' is set, it may be interesting to display
687                 statistics for the group as a whole instead of for each
688                 individual job. This is especially true of 'numjobs' is
689                 large, looking at individual thread/process output quickly
690                 becomes unwieldy. If 'group_reporting' is specified, fio
691                 will show the final report per-group instead of per-job.
692
693 thread          fio defaults to forking jobs, however if this option is
694                 given, fio will use pthread_create(3) to create threads
695                 instead.
696
697 zonesize=siint  Divide a file into zones of the specified size. See zoneskip.
698
699 zoneskip=siint  Skip the specified number of bytes when zonesize data has
700                 been read. The two zone options can be used to only do
701                 io on zones of a file.
702
703 write_iolog=str Write the issued io patterns to the specified file. See
704                 read_iolog.
705
706 read_iolog=str  Open an iolog with the specified file name and replay the
707                 io patterns it contains. This can be used to store a
708                 workload and replay it sometime later. The iolog given
709                 may also be a blktrace binary file, which allows fio
710                 to replay a workload captured by blktrace. See blktrace
711                 for how to capture such logging data. For blktrace replay,
712                 the file needs to be turned into a blkparse binary data
713                 file first (blktrace <device> -d file_for_fio.bin).
714
715 write_bw_log    If given, write a bandwidth log of the jobs in this job
716                 file. Can be used to store data of the bandwidth of the
717                 jobs in their lifetime. The included fio_generate_plots
718                 script uses gnuplot to turn these text files into nice
719                 graphs.
720
721 write_lat_log   Same as write_bw_log, except that this option stores io
722                 completion latencies instead.
723
724 lockmem=siint   Pin down the specified amount of memory with mlock(2). Can
725                 potentially be used instead of removing memory or booting
726                 with less memory to simulate a smaller amount of memory.
727
728 exec_prerun=str Before running this job, issue the command specified
729                 through system(3).
730
731 exec_postrun=str After the job completes, issue the command specified
732                  though system(3).
733
734 ioscheduler=str Attempt to switch the device hosting the file to the specified
735                 io scheduler before running.
736
737 cpuload=int     If the job is a CPU cycle eater, attempt to use the specified
738                 percentage of CPU cycles.
739
740 cpuchunks=int   If the job is a CPU cycle eater, split the load into
741                 cycles of the given time. In milliseconds.
742
743 disk_util=bool  Generate disk utilization statistics, if the platform
744                 supports it. Defaults to on.
745
746
747 6.0 Interpreting the output
748 ---------------------------
749
750 fio spits out a lot of output. While running, fio will display the
751 status of the jobs created. An example of that would be:
752
753 Threads: 1: [_r] [24.8% done] [ 13509/  8334 kb/s] [eta 00h:01m:31s]
754
755 The characters inside the square brackets denote the current status of
756 each thread. The possible values (in typical life cycle order) are:
757
758 Idle    Run
759 ----    ---
760 P               Thread setup, but not started.
761 C               Thread created.
762 I               Thread initialized, waiting.
763         R       Running, doing sequential reads.
764         r       Running, doing random reads.
765         W       Running, doing sequential writes.
766         w       Running, doing random writes.
767         M       Running, doing mixed sequential reads/writes.
768         m       Running, doing mixed random reads/writes.
769         F       Running, currently waiting for fsync()
770 V               Running, doing verification of written data.
771 E               Thread exited, not reaped by main thread yet.
772 _               Thread reaped.
773
774 The other values are fairly self explanatory - number of threads
775 currently running and doing io, rate of io since last check (read speed
776 listed first, then write speed), and the estimated completion percentage
777 and time for the running group. It's impossible to estimate runtime of
778 the following groups (if any).
779
780 When fio is done (or interrupted by ctrl-c), it will show the data for
781 each thread, group of threads, and disks in that order. For each data
782 direction, the output looks like:
783
784 Client1 (g=0): err= 0:
785   write: io=    32MiB, bw=   666KiB/s, runt= 50320msec
786     slat (msec): min=    0, max=  136, avg= 0.03, stdev= 1.92
787     clat (msec): min=    0, max=  631, avg=48.50, stdev=86.82
788     bw (KiB/s) : min=    0, max= 1196, per=51.00%, avg=664.02, stdev=681.68
789   cpu        : usr=1.49%, sys=0.25%, ctx=7969, majf=0, minf=17
790   IO depths    : 1=0.1%, 2=0.3%, 4=0.5%, 8=99.0%, 16=0.0%, 32=0.0%, >32=0.0%
791      issued r/w: total=0/32768, short=0/0
792      lat (msec): 2=1.6%, 4=0.0%, 10=3.2%, 20=12.8%, 50=38.4%, 100=24.8%,
793      lat (msec): 250=15.2%, 500=0.0%, 750=0.0%, 1000=0.0%, >=2048=0.0%
794
795 The client number is printed, along with the group id and error of that
796 thread. Below is the io statistics, here for writes. In the order listed,
797 they denote:
798
799 io=             Number of megabytes io performed
800 bw=             Average bandwidth rate
801 runt=           The runtime of that thread
802         slat=   Submission latency (avg being the average, stdev being the
803                 standard deviation). This is the time it took to submit
804                 the io. For sync io, the slat is really the completion
805                 latency, since queue/complete is one operation there. This
806                 value can be in miliseconds or microseconds, fio will choose
807                 the most appropriate base and print that. In the example
808                 above, miliseconds is the best scale.
809         clat=   Completion latency. Same names as slat, this denotes the
810                 time from submission to completion of the io pieces. For
811                 sync io, clat will usually be equal (or very close) to 0,
812                 as the time from submit to complete is basically just
813                 CPU time (io has already been done, see slat explanation).
814         bw=     Bandwidth. Same names as the xlat stats, but also includes
815                 an approximate percentage of total aggregate bandwidth
816                 this thread received in this group. This last value is
817                 only really useful if the threads in this group are on the
818                 same disk, since they are then competing for disk access.
819 cpu=            CPU usage. User and system time, along with the number
820                 of context switches this thread went through, usage of
821                 system and user time, and finally the number of major
822                 and minor page faults.
823 IO depths=      The distribution of io depths over the job life time. The
824                 numbers are divided into powers of 2, so for example the
825                 16= entries includes depths up to that value but higher
826                 than the previous entry. In other words, it covers the
827                 range from 16 to 31.
828 IO issued=      The number of read/write requests issued, and how many
829                 of them were short.
830 IO latencies=   The distribution of IO completion latencies. This is the
831                 time from when IO leaves fio and when it gets completed.
832                 The numbers follow the same pattern as the IO depths,
833                 meaning that 2=1.6% means that 1.6% of the IO completed
834                 within 2 msecs, 20=12.8% means that 12.8% of the IO
835                 took more than 10 msecs, but less than (or equal to) 20 msecs.
836
837 After each client has been listed, the group statistics are printed. They
838 will look like this:
839
840 Run status group 0 (all jobs):
841    READ: io=64MiB, aggrb=22178, minb=11355, maxb=11814, mint=2840msec, maxt=2955msec
842   WRITE: io=64MiB, aggrb=1302, minb=666, maxb=669, mint=50093msec, maxt=50320msec
843
844 For each data direction, it prints:
845
846 io=             Number of megabytes io performed.
847 aggrb=          Aggregate bandwidth of threads in this group.
848 minb=           The minimum average bandwidth a thread saw.
849 maxb=           The maximum average bandwidth a thread saw.
850 mint=           The smallest runtime of the threads in that group.
851 maxt=           The longest runtime of the threads in that group.
852
853 And finally, the disk statistics are printed. They will look like this:
854
855 Disk stats (read/write):
856   sda: ios=16398/16511, merge=30/162, ticks=6853/819634, in_queue=826487, util=100.00%
857
858 Each value is printed for both reads and writes, with reads first. The
859 numbers denote:
860
861 ios=            Number of ios performed by all groups.
862 merge=          Number of merges io the io scheduler.
863 ticks=          Number of ticks we kept the disk busy.
864 io_queue=       Total time spent in the disk queue.
865 util=           The disk utilization. A value of 100% means we kept the disk
866                 busy constantly, 50% would be a disk idling half of the time.
867
868
869 7.0 Terse output
870 ----------------
871
872 For scripted usage where you typically want to generate tables or graphs
873 of the results, fio can output the results in a semicolon separated format.
874 The format is one long line of values, such as:
875
876 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%
877 ;0.0%;0.0%;0.0%;0.0%;0.0%
878
879 Split up, the format is as follows:
880
881         jobname, groupid, error
882         READ status:
883                 KiB IO, bandwidth (KiB/sec), runtime (msec)
884                 Submission latency: min, max, mean, deviation
885                 Completion latency: min, max, mean, deviation
886                 Bw: min, max, aggregate percentage of total, mean, deviation
887         WRITE 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         CPU usage: user, system, context switches, major faults, minor faults
893         IO depths: <=1, 2, 4, 8, 16, 32, >=64
894         IO latencies: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, >=2000
895         Text description
896