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