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