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