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