Add 'filesize' option
[fio.git] / HOWTO
CommitLineData
71bfa161
JA
1Table of contents
2-----------------
3
41. Overview
52. How fio works
63. Running fio
74. Job file format
85. Detailed list of parameters
96. Normal output
107. Terse output
11
12
131.0 Overview and history
14------------------------
15fio was originally written to save me the hassle of writing special test
16case programs when I wanted to test a specific workload, either for
17performance reasons or to find/reproduce a bug. The process of writing
18such a test app can be tiresome, especially if you have to do it often.
19Hence I needed a tool that would be able to simulate a given io workload
20without resorting to writing a tailored test case again and again.
21
22A test work load is difficult to define, though. There can be any number
23of processes or threads involved, and they can each be using their own
24way of generating io. You could have someone dirtying large amounts of
25memory in an memory mapped file, or maybe several threads issuing
26reads using asynchronous io. fio needed to be flexible enough to
27simulate both of these cases, and many more.
28
292.0 How fio works
30-----------------
31The first step in getting fio to simulate a desired io workload, is
32writing a job file describing that specific setup. A job file may contain
33any number of threads and/or files - the typical contents of the job file
34is a global section defining shared parameters, and one or more job
35sections describing the jobs involved. When run, fio parses this file
36and sets everything up as described. If we break down a job from top to
37bottom, 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
d0ff85df 52 could be using splice, async io, syslet, or even
71bfa161
JA
53 SG (SCSI generic sg).
54
6c219763 55 IO depth If the io engine is async, how large a queuing
71bfa161
JA
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
65The above are the basic parameters defined for a workload, in addition
66there's a multitude of parameters that modify other aspects of how this
67job behaves.
68
69
703.0 Running fio
71---------------
72See the README file for command line parameters, there are only a few
73of them.
74
75Running 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
80and it will start doing what the job_file tells it to do. You can give
81more than one job file on the command line, fio will serialize the running
82of those files. Internally that is the same as using the 'stonewall'
83parameter described the the parameter section.
84
b4692828
JA
85If the job file contains only one job, you may as well just give the
86parameters on the command line. The command line parameters are identical
87to the job parameters, with a few extra that control global parameters
88(see README). For example, for the job file parameter iodepth=2, the
c2b1e753
JA
89mirror command line option would be --iodepth 2 or --iodepth=2. You can
90also 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.
92Command line entries following a --name entry will apply to that job,
93until there are no more entries or a new --name entry is seen. This is
94similar to the job file options, where each option applies to the current
95job until a new [] job entry is seen.
b4692828 96
71bfa161
JA
97fio does not need to run as root, except if the files or devices specified
98in the job section requires that. Some other options may also be restricted,
6c219763 99such as memory locking, io scheduler switching, and decreasing the nice value.
71bfa161
JA
100
101
1024.0 Job file format
103-------------------
104As previously described, fio accepts one or more job files describing
105what it is supposed to do. The job file format is the classic ini file,
106where the names enclosed in [] brackets define the job name. You are free
107to use any ascii name you want, except 'global' which has special meaning.
108A global section sets defaults for the jobs described in that file. A job
109may override a global section parameter, and a job file may even have
110several global sections if so desired. A job is only affected by a global
65db0851
JA
111section residing above it. If the first character in a line is a ';' or a
112'#', the entire line is discarded as a comment.
71bfa161
JA
113
114So lets look at a really simple job file that define to threads, each
115randomly reading from a 128MiB file.
116
117; -- start job file --
118[global]
119rw=randread
120size=128m
121
122[job1]
123
124[job2]
125
126; -- end job file --
127
128As you can see, the job file sections themselves are empty as all the
129described parameters are shared. As no filename= option is given, fio
c2b1e753
JA
130makes up a filename for each of the jobs as it sees fit. On the command
131line, this job would look as follows:
132
133$ fio --name=global --rw=randread --size=128m --name=job1 --name=job2
134
71bfa161
JA
135
136Lets look at an example that have a number of processes writing randomly
137to files.
138
139; -- start job file --
140[random-writers]
141ioengine=libaio
142iodepth=4
143rw=randwrite
144bs=32k
145direct=0
146size=64m
147numjobs=4
148
149; -- end job file --
150
151Here we have no global section, as we only have one job defined anyway.
152We want to use async io here, with a depth of 4 for each file. We also
153increased the buffer size used to 32KiB and define numjobs to 4 to
154fork 4 identical jobs. The result is 4 processes each randomly writing
b4692828
JA
155to their own 64MiB file. Instead of using the above job file, you could
156have given the parameters on the command line. For this case, you would
157specify:
158
159$ fio --name=random-writers --ioengine=libaio --iodepth=4 --rw=randwrite --bs=32k --direct=0 --size=64m --numjobs=4
71bfa161
JA
160
161fio ships with a few example job files, you can also look there for
162inspiration.
163
164
1655.0 Detailed list of parameters
166-------------------------------
167
168This section describes in details each parameter associated with a job.
169Some parameters take an option of a given type, such as an integer or
170a string. The following types are used:
171
172str String. This is a sequence of alpha characters.
173int Integer. A whole number value, may be negative.
174siint SI integer. A whole number value, which may contain a postfix
175 describing the base of the number. Accepted postfixes are k/m/g,
6c219763 176 meaning kilo, mega, and giga. So if you want to specify 4096,
71bfa161
JA
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.
179bool Boolean. Usually parsed as an integer, however only defined for
180 true and false (1 and 0).
181irange Integer range with postfix. Allows value range to be given, such
0c9baf91
JA
182 as 1024-4096. A colon may also be used as the seperator, eg
183 1k:4k. If the option allows two sets of ranges, they can be
184 specified with a ',' or '/' delimiter: 1k-4k/8k-32k. Also see
185 siint.
71bfa161
JA
186
187With the above in mind, here follows the complete list of fio job
188parameters.
189
190name=str ASCII name of the job. This may be used to override the
191 name printed by fio for this job. Otherwise the job
c2b1e753 192 name is used. On the command line this parameter has the
6c219763 193 special purpose of also signaling the start of a new
c2b1e753 194 job.
71bfa161 195
61697c37
JA
196description=str Text description of the job. Doesn't do anything except
197 dump this text description when this job is run. It's
198 not parsed.
199
71bfa161
JA
200directory=str Prefix filenames with this directory. Used to places files
201 in a different location than "./".
202
203filename=str Fio normally makes up a filename based on the job name,
204 thread number, and file number. If you want to share
205 files between threads in a job or several jobs, specify
ed92ac0c
JA
206 a filename for each of them to override the default. If
207 the ioengine used is 'net', the filename is the host and
9f9214f2 208 port to connect to in the format of =host/port. If the
af52b345
JA
209 ioengine is file based, you can specify a number of files
210 by seperating the names with a ':' colon. So if you wanted
211 a job to open /dev/sda and /dev/sdb as the two working files,
212 you would use filename=/dev/sda:/dev/sdb
71bfa161 213
bbf6b540
JA
214opendir=str Tell fio to recursively add any file it can find in this
215 directory and down the file system tree.
216
71bfa161
JA
217rw=str Type of io pattern. Accepted values are:
218
219 read Sequential reads
220 write Sequential writes
221 randwrite Random writes
222 randread Random reads
223 rw Sequential mixed reads and writes
224 randrw Random mixed reads and writes
225
226 For the mixed io types, the default is to split them 50/50.
227 For certain types of io the result may still be skewed a bit,
228 since the speed may be different.
229
ee738499
JA
230randrepeat=bool For random IO workloads, seed the generator in a predictable
231 way so that results are repeatable across repetitions.
232
71bfa161
JA
233size=siint The total size of file io for this job. This may describe
234 the size of the single file the job uses, or it may be
235 divided between the number of files in the job. If the
236 file already exists, the file size will be adjusted to this
237 size if larger than the current file size. If this parameter
238 is not given and the file exists, the file size will be used.
239
9c60ce64
JA
240filesize=siint Individual file sizes. May be a range, in which case fio
241 will select sizes for files at random within the given range
242 and limited to 'size' in total (if that is given). If not
243 given, each created file is the same size.
244
f90eff5a
JA
245bs=siint The block size used for the io units. Defaults to 4k. Values
246 can be given for both read and writes. If a single siint is
247 given, it will apply to both. If a second siint is specified
248 after a comma, it will apply to writes only. In other words,
249 the format is either bs=read_and_write or bs=read,write.
250 bs=4k,8k will thus use 4k blocks for reads, and 8k blocks
787f7e95
JA
251 for writes. If you only wish to set the write size, you
252 can do so by passing an empty read size - bs=,8k will set
253 8k for writes and leave the read default value.
a00735e6 254
71bfa161
JA
255bsrange=irange Instead of giving a single block size, specify a range
256 and fio will mix the issued io block sizes. The issued
257 io unit will always be a multiple of the minimum value
f90eff5a
JA
258 given (also see bs_unaligned). Applies to both reads and
259 writes, however a second range can be given after a comma.
260 See bs=.
a00735e6 261
690adba3
JA
262bs_unaligned If this option is given, any byte size value within bsrange
263 may be used as a block range. This typically wont work with
264 direct IO, as that normally requires sector alignment.
71bfa161
JA
265
266nrfiles=int Number of files to use for this job. Defaults to 1.
267
390b1537
JA
268openfiles=int Number of files to keep open at the same time. Defaults to
269 the same as nrfiles, can be set smaller to limit the number
270 simultaneous opens.
271
5af1c6f3
JA
272file_service_type=str Defines how fio decides which file from a job to
273 service next. The following types are defined:
274
275 random Just choose a file at random.
276
277 roundrobin Round robin over open files. This
278 is the default.
279
1907dbc6
JA
280 The string can have a number appended, indicating how
281 often to switch to a new file. So if option random:4 is
282 given, fio will switch to a new random file after 4 ios
283 have been issued.
284
71bfa161
JA
285ioengine=str Defines how the job issues io to the file. The following
286 types are defined:
287
288 sync Basic read(2) or write(2) io. lseek(2) is
289 used to position the io location.
290
291 libaio Linux native asynchronous io.
292
293 posixaio glibc posix asynchronous io.
294
295 mmap File is memory mapped and data copied
296 to/from using memcpy(3).
297
298 splice splice(2) is used to transfer the data and
299 vmsplice(2) to transfer data from user
300 space to the kernel.
301
d0ff85df
JA
302 syslet-rw Use the syslet system calls to make
303 regular read/write async.
304
71bfa161 305 sg SCSI generic sg v3 io. May either be
6c219763 306 synchronous using the SG_IO ioctl, or if
71bfa161
JA
307 the target is an sg character device
308 we use read(2) and write(2) for asynchronous
309 io.
310
a94ea28b
JA
311 null Doesn't transfer any data, just pretends
312 to. This is mainly used to exercise fio
313 itself and for debugging/testing purposes.
314
ed92ac0c
JA
315 net Transfer over the network to given host:port.
316 'filename' must be set appropriately to
9f9214f2 317 filename=host/port regardless of send
ed92ac0c
JA
318 or receive, if the latter only the port
319 argument is used.
320
ba0fbe10
JA
321 cpu Doesn't transfer any data, but burns CPU
322 cycles according to the cpuload= and
323 cpucycle= options. Setting cpuload=85
324 will cause that job to do nothing but burn
325 85% of the CPU.
326
8a7bd877
JA
327 external Prefix to specify loading an external
328 IO engine object file. Append the engine
329 filename, eg ioengine=external:/tmp/foo.o
330 to load ioengine foo.o in /tmp.
331
71bfa161
JA
332iodepth=int This defines how many io units to keep in flight against
333 the file. The default is 1 for each file defined in this
334 job, can be overridden with a larger value for higher
335 concurrency.
336
cb5ab512
JA
337iodepth_batch=int This defines how many pieces of IO to submit at once.
338 It defaults to the same as iodepth, but can be set lower
339 if one so desires.
340
e916b390
JA
341iodepth_low=int The low water mark indicating when to start filling
342 the queue again. Defaults to the same as iodepth, meaning
343 that fio will attempt to keep the queue full at all times.
344 If iodepth is set to eg 16 and iodepth_low is set to 4, then
345 after fio has filled the queue of 16 requests, it will let
346 the depth drain down to 4 before starting to fill it again.
347
71bfa161 348direct=bool If value is true, use non-buffered io. This is usually
76a43db4
JA
349 O_DIRECT.
350
351buffered=bool If value is true, use buffered io. This is the opposite
352 of the 'direct' option. Defaults to true.
71bfa161
JA
353
354offset=siint Start io at the given offset in the file. The data before
355 the given offset will not be touched. This effectively
356 caps the file size at real_size - offset.
357
358fsync=int If writing to a file, issue a sync of the dirty data
359 for every number of blocks given. For example, if you give
360 32 as a parameter, fio will sync the file for every 32
361 writes issued. If fio is using non-buffered io, we may
362 not sync the file. The exception is the sg io engine, which
6c219763 363 synchronizes the disk cache anyway.
71bfa161
JA
364
365overwrite=bool If writing to a file, setup the file first and do overwrites.
366
367end_fsync=bool If true, fsync file contents when the job exits.
368
ebb1415f
JA
369fsync_on_close=bool If true, fio will fsync() a dirty file on close.
370 This differs from end_fsync in that it will happen on every
371 file close, not just at the end of the job.
372
6c219763 373rwmixcycle=int Value in milliseconds describing how often to switch between
71bfa161
JA
374 reads and writes for a mixed workload. The default is
375 500 msecs.
376
377rwmixread=int How large a percentage of the mix should be reads.
378
379rwmixwrite=int How large a percentage of the mix should be writes. If both
380 rwmixread and rwmixwrite is given and the values do not add
381 up to 100%, the latter of the two will be used to override
382 the first.
383
bb8895e0
JA
384norandommap Normally fio will cover every block of the file when doing
385 random IO. If this option is given, fio will just get a
386 new random offset without looking at past io history. This
387 means that some blocks may not be read or written, and that
388 some blocks may be read/written more than once. This option
389 is mutually exclusive with verify= for that reason.
390
71bfa161
JA
391nice=int Run the job with the given nice value. See man nice(2).
392
393prio=int Set the io priority value of this job. Linux limits us to
394 a positive value between 0 and 7, with 0 being the highest.
395 See man ionice(1).
396
397prioclass=int Set the io priority class. See man ionice(1).
398
399thinktime=int Stall the job x microseconds after an io has completed before
400 issuing the next. May be used to simulate processing being
48097d5c
JA
401 done by an application. See thinktime_blocks and
402 thinktime_spin.
403
404thinktime_spin=int
405 Only valid if thinktime is set - pretend to spend CPU time
406 doing something with the data received, before falling back
407 to sleeping for the rest of the period specified by
408 thinktime.
9c1f7434
JA
409
410thinktime_blocks
411 Only valid if thinktime is set - control how many blocks
412 to issue, before waiting 'thinktime' usecs. If not set,
413 defaults to 1 which will make fio wait 'thinktime' usecs
414 after every block.
71bfa161
JA
415
416rate=int Cap the bandwidth used by this job to this number of KiB/sec.
417
418ratemin=int Tell fio to do whatever it can to maintain at least this
419 bandwidth.
420
421ratecycle=int Average bandwidth for 'rate' and 'ratemin' over this number
6c219763 422 of milliseconds.
71bfa161
JA
423
424cpumask=int Set the CPU affinity of this job. The parameter given is a
425 bitmask of allowed CPU's the job may run on. See man
426 sched_setaffinity(2).
427
428startdelay=int Start this job the specified number of seconds after fio
429 has started. Only useful if the job file contains several
430 jobs, and you want to delay starting some jobs to a certain
431 time.
432
03b74b3e 433runtime=int Tell fio to terminate processing after the specified number
71bfa161
JA
434 of seconds. It can be quite hard to determine for how long
435 a specified job will run, so this parameter is handy to
436 cap the total runtime to a given time.
437
438invalidate=bool Invalidate the buffer/page cache parts for this file prior
439 to starting io. Defaults to true.
440
441sync=bool Use sync io for buffered writes. For the majority of the
442 io engines, this means using O_SYNC.
443
444mem=str Fio can use various types of memory as the io unit buffer.
445 The allowed values are:
446
447 malloc Use memory from malloc(3) as the buffers.
448
449 shm Use shared memory as the buffers. Allocated
450 through shmget(2).
451
74b025b0
JA
452 shmhuge Same as shm, but use huge pages as backing.
453
313cb206
JA
454 mmap Use mmap to allocate buffers. May either be
455 anonymous memory, or can be file backed if
456 a filename is given after the option. The
457 format is mem=mmap:/path/to/file.
71bfa161 458
d0bdaf49
JA
459 mmaphuge Use a memory mapped huge file as the buffer
460 backing. Append filename after mmaphuge, ala
461 mem=mmaphuge:/hugetlbfs/file
462
71bfa161 463 The area allocated is a function of the maximum allowed
5394ae5f
JA
464 bs size for the job, multiplied by the io depth given. Note
465 that for shmhuge and mmaphuge to work, the system must have
466 free huge pages allocated. This can normally be checked
467 and set by reading/writing /proc/sys/vm/nr_hugepages on a
468 Linux system. Fio assumes a huge page is 4MiB in size. So
469 to calculate the number of huge pages you need for a given
470 job file, add up the io depth of all jobs (normally one unless
471 iodepth= is used) and multiply by the maximum bs set. Then
472 divide that number by the huge page size. You can see the
473 size of the huge pages in /proc/meminfo. If no huge pages
474 are allocated by having a non-zero number in nr_hugepages,
56bb17f2 475 using mmaphuge or shmhuge will fail. Also see hugepage-size.
5394ae5f
JA
476
477 mmaphuge also needs to have hugetlbfs mounted and the file
478 location should point there. So if it's mounted in /huge,
479 you would use mem=mmaphuge:/huge/somefile.
71bfa161 480
56bb17f2
JA
481hugepage-size=siint
482 Defines the size of a huge page. Must at least be equal
483 to the system setting, see /proc/meminfo. Defaults to 4MiB.
c51074e7
JA
484 Should probably always be a multiple of megabytes, so using
485 hugepage-size=Xm is the preferred way to set this to avoid
486 setting a non-pow-2 bad value.
56bb17f2 487
71bfa161
JA
488exitall When one job finishes, terminate the rest. The default is
489 to wait for each job to finish, sometimes that is not the
490 desired action.
491
492bwavgtime=int Average the calculated bandwidth over the given time. Value
6c219763 493 is specified in milliseconds.
71bfa161
JA
494
495create_serialize=bool If true, serialize the file creating for the jobs.
496 This may be handy to avoid interleaving of data
497 files, which may greatly depend on the filesystem
498 used and even the number of processors in the system.
499
500create_fsync=bool fsync the data file after creation. This is the
501 default.
502
e545a6ce
JA
503unlink=bool Unlink the job files when done. Not the default, as repeated
504 runs of that job would then waste time recreating the fileset
505 again and again.
71bfa161
JA
506
507loops=int Run the specified number of iterations of this job. Used
508 to repeat the same workload a given number of times. Defaults
509 to 1.
510
511verify=str If writing to a file, fio can verify the file contents
512 after each iteration of the job. The allowed values are:
513
514 md5 Use an md5 sum of the data area and store
515 it in the header of each block.
516
517 crc32 Use a crc32 sum of the data area and store
518 it in the header of each block.
519
6c219763 520 This option can be used for repeated burn-in tests of a
71bfa161
JA
521 system to make sure that the written data is also
522 correctly read back.
523
524stonewall Wait for preceeding jobs in the job file to exit, before
525 starting this one. Can be used to insert serialization
526 points in the job file.
527
528numjobs=int Create the specified number of clones of this job. May be
529 used to setup a larger number of threads/processes doing
fa28c85a
JA
530 the same thing. We regard that grouping of jobs as a
531 specific group.
532
533group_reporting If 'numjobs' is set, it may be interesting to display
534 statistics for the group as a whole instead of for each
535 individual job. This is especially true of 'numjobs' is
536 large, looking at individual thread/process output quickly
537 becomes unwieldy. If 'group_reporting' is specified, fio
538 will show the final report per-group instead of per-job.
71bfa161
JA
539
540thread fio defaults to forking jobs, however if this option is
541 given, fio will use pthread_create(3) to create threads
542 instead.
543
544zonesize=siint Divide a file into zones of the specified size. See zoneskip.
545
546zoneskip=siint Skip the specified number of bytes when zonesize data has
547 been read. The two zone options can be used to only do
548 io on zones of a file.
549
076efc7c
JA
550write_iolog=str Write the issued io patterns to the specified file. See
551 read_iolog.
71bfa161 552
076efc7c 553read_iolog=str Open an iolog with the specified file name and replay the
71bfa161
JA
554 io patterns it contains. This can be used to store a
555 workload and replay it sometime later.
556
557write_bw_log If given, write a bandwidth log of the jobs in this job
558 file. Can be used to store data of the bandwidth of the
e0da9bc2
JA
559 jobs in their lifetime. The included fio_generate_plots
560 script uses gnuplot to turn these text files into nice
561 graphs.
71bfa161
JA
562
563write_lat_log Same as write_bw_log, except that this option stores io
564 completion latencies instead.
565
566lockmem=siint Pin down the specified amount of memory with mlock(2). Can
567 potentially be used instead of removing memory or booting
568 with less memory to simulate a smaller amount of memory.
569
570exec_prerun=str Before running this job, issue the command specified
571 through system(3).
572
573exec_postrun=str After the job completes, issue the command specified
574 though system(3).
575
576ioscheduler=str Attempt to switch the device hosting the file to the specified
577 io scheduler before running.
578
579cpuload=int If the job is a CPU cycle eater, attempt to use the specified
580 percentage of CPU cycles.
581
582cpuchunks=int If the job is a CPU cycle eater, split the load into
6c219763 583 cycles of the given time. In milliseconds.
71bfa161
JA
584
585
5866.0 Interpreting the output
587---------------------------
588
589fio spits out a lot of output. While running, fio will display the
590status of the jobs created. An example of that would be:
591
73c8b082 592Threads: 1: [_r] [24.8% done] [ 13509/ 8334 kb/s] [eta 00h:01m:31s]
71bfa161
JA
593
594The characters inside the square brackets denote the current status of
595each thread. The possible values (in typical life cycle order) are:
596
597Idle Run
598---- ---
599P Thread setup, but not started.
600C Thread created.
601I Thread initialized, waiting.
602 R Running, doing sequential reads.
603 r Running, doing random reads.
604 W Running, doing sequential writes.
605 w Running, doing random writes.
606 M Running, doing mixed sequential reads/writes.
607 m Running, doing mixed random reads/writes.
608 F Running, currently waiting for fsync()
609V Running, doing verification of written data.
610E Thread exited, not reaped by main thread yet.
611_ Thread reaped.
612
613The other values are fairly self explanatory - number of threads
6043c579
JA
614currently running and doing io, rate of io since last check, and the estimated
615completion percentage and time for the running group. It's impossible to
616estimate runtime of the following groups (if any).
71bfa161
JA
617
618When fio is done (or interrupted by ctrl-c), it will show the data for
619each thread, group of threads, and disks in that order. For each data
620direction, the output looks like:
621
622Client1 (g=0): err= 0:
623 write: io= 32MiB, bw= 666KiB/s, runt= 50320msec
6104ddb6
JA
624 slat (msec): min= 0, max= 136, avg= 0.03, stdev= 1.92
625 clat (msec): min= 0, max= 631, avg=48.50, stdev=86.82
626 bw (KiB/s) : min= 0, max= 1196, per=51.00%, avg=664.02, stdev=681.68
71bfa161 627 cpu : usr=1.49%, sys=0.25%, ctx=7969
71619dc2 628 IO depths : 1=0.1%, 2=0.3%, 4=0.5%, 8=99.0%, 16=0.0%, 32=0.0%, >32=0.0%
8abdce66
JA
629 lat (msec): 2=1.6%, 4=0.0%, 10=3.2%, 20=12.8%, 50=38.4%, 100=24.8%,
630 lat (msec): 250=15.2%, 500=0.0%, 750=0.0%, 1000=0.0%, >=2048=0.0%
71bfa161
JA
631
632The client number is printed, along with the group id and error of that
633thread. Below is the io statistics, here for writes. In the order listed,
634they denote:
635
636io= Number of megabytes io performed
637bw= Average bandwidth rate
638runt= The runtime of that thread
639 slat= Submission latency (avg being the average, dev being the
640 standard deviation). This is the time it took to submit
641 the io. For sync io, the slat is really the completion
642 latency, since queue/complete is one operation there.
643 clat= Completion latency. Same names as slat, this denotes the
644 time from submission to completion of the io pieces. For
645 sync io, clat will usually be equal (or very close) to 0,
646 as the time from submit to complete is basically just
647 CPU time (io has already been done, see slat explanation).
648 bw= Bandwidth. Same names as the xlat stats, but also includes
649 an approximate percentage of total aggregate bandwidth
650 this thread received in this group. This last value is
651 only really useful if the threads in this group are on the
652 same disk, since they are then competing for disk access.
653cpu= CPU usage. User and system time, along with the number
654 of context switches this thread went through.
71619dc2
JA
655IO depths= The distribution of io depths over the job life time. The
656 numbers are divided into powers of 2, so for example the
657 16= entries includes depths up to that value but higher
658 than the previous entry. In other words, it covers the
659 range from 16 to 31.
ec118304
JA
660IO latencies= The distribution of IO completion latencies. This is the
661 time from when IO leaves fio and when it gets completed.
662 The numbers follow the same pattern as the IO depths,
663 meaning that 2=1.6% means that 1.6% of the IO completed
8abdce66
JA
664 within 2 msecs, 20=12.8% means that 12.8% of the IO
665 took more than 10 msecs, but less than (or equal to) 20 msecs.
71bfa161
JA
666
667After each client has been listed, the group statistics are printed. They
668will look like this:
669
670Run status group 0 (all jobs):
671 READ: io=64MiB, aggrb=22178, minb=11355, maxb=11814, mint=2840msec, maxt=2955msec
672 WRITE: io=64MiB, aggrb=1302, minb=666, maxb=669, mint=50093msec, maxt=50320msec
673
674For each data direction, it prints:
675
676io= Number of megabytes io performed.
677aggrb= Aggregate bandwidth of threads in this group.
678minb= The minimum average bandwidth a thread saw.
679maxb= The maximum average bandwidth a thread saw.
680mint= The smallest runtime of the threads in that group.
681maxt= The longest runtime of the threads in that group.
682
683And finally, the disk statistics are printed. They will look like this:
684
685Disk stats (read/write):
686 sda: ios=16398/16511, merge=30/162, ticks=6853/819634, in_queue=826487, util=100.00%
687
688Each value is printed for both reads and writes, with reads first. The
689numbers denote:
690
691ios= Number of ios performed by all groups.
692merge= Number of merges io the io scheduler.
693ticks= Number of ticks we kept the disk busy.
694io_queue= Total time spent in the disk queue.
695util= The disk utilization. A value of 100% means we kept the disk
696 busy constantly, 50% would be a disk idling half of the time.
697
698
6997.0 Terse output
700----------------
701
702For scripted usage where you typically want to generate tables or graphs
6af019c9 703of the results, fio can output the results in a semicolon separated format.
71bfa161
JA
704The format is one long line of values, such as:
705
6af019c9
JA
706client1;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%
707;0.0%;0.0%;0.0%;0.0%;0.0%
71bfa161
JA
708
709Split up, the format is as follows:
710
711 jobname, groupid, error
712 READ status:
713 KiB IO, bandwidth (KiB/sec), runtime (msec)
714 Submission latency: min, max, mean, deviation
715 Completion latency: min, max, mean, deviation
6c219763 716 Bw: min, max, aggregate percentage of total, mean, deviation
71bfa161
JA
717 WRITE status:
718 KiB IO, bandwidth (KiB/sec), runtime (msec)
719 Submission latency: min, max, mean, deviation
720 Completion latency: min, max, mean, deviation
6c219763 721 Bw: min, max, aggregate percentage of total, mean, deviation
71bfa161 722 CPU usage: user, system, context switches
2270890c
JA
723 IO depths: <=1, 2, 4, 8, 16, 32, >=64
724 IO latencies: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, >=2000
725 Text description
71bfa161 726