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 |
Paul Dubs | 25c8b9d | 2011-07-21 17:26:02 +0200 | [diff] [blame] | 11 | 8. Trace file format |
Bruce Cran | 43f09da | 2013-02-24 11:09:11 +0000 | [diff] [blame] | 12 | 9. CPU idleness profiling |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 13 | |
| 14 | 1.0 Overview and history |
| 15 | ------------------------ |
| 16 | fio was originally written to save me the hassle of writing special test |
| 17 | case programs when I wanted to test a specific workload, either for |
| 18 | performance reasons or to find/reproduce a bug. The process of writing |
| 19 | such a test app can be tiresome, especially if you have to do it often. |
| 20 | Hence I needed a tool that would be able to simulate a given io workload |
| 21 | without resorting to writing a tailored test case again and again. |
| 22 | |
| 23 | A test work load is difficult to define, though. There can be any number |
| 24 | of processes or threads involved, and they can each be using their own |
| 25 | way of generating io. You could have someone dirtying large amounts of |
| 26 | memory in an memory mapped file, or maybe several threads issuing |
| 27 | reads using asynchronous io. fio needed to be flexible enough to |
| 28 | simulate both of these cases, and many more. |
| 29 | |
| 30 | 2.0 How fio works |
| 31 | ----------------- |
| 32 | The first step in getting fio to simulate a desired io workload, is |
| 33 | writing a job file describing that specific setup. A job file may contain |
| 34 | any number of threads and/or files - the typical contents of the job file |
| 35 | is a global section defining shared parameters, and one or more job |
| 36 | sections describing the jobs involved. When run, fio parses this file |
| 37 | and sets everything up as described. If we break down a job from top to |
| 38 | bottom, it contains the following basic parameters: |
| 39 | |
| 40 | IO type Defines the io pattern issued to the file(s). |
| 41 | We may only be reading sequentially from this |
| 42 | file(s), or we may be writing randomly. Or even |
| 43 | mixing reads and writes, sequentially or randomly. |
| 44 | |
| 45 | Block size In how large chunks are we issuing io? This may be |
| 46 | a single value, or it may describe a range of |
| 47 | block sizes. |
| 48 | |
| 49 | IO size How much data are we going to be reading/writing. |
| 50 | |
| 51 | IO engine How do we issue io? We could be memory mapping the |
| 52 | file, we could be using regular read/write, we |
Jens Axboe | d0ff85d | 2007-02-14 01:19:41 +0100 | [diff] [blame] | 53 | could be using splice, async io, syslet, or even |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 54 | SG (SCSI generic sg). |
| 55 | |
Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 56 | IO depth If the io engine is async, how large a queuing |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 57 | depth do we want to maintain? |
| 58 | |
| 59 | IO type Should we be doing buffered io, or direct/raw io? |
| 60 | |
| 61 | Num files How many files are we spreading the workload over. |
| 62 | |
| 63 | Num threads How many threads or processes should we spread |
| 64 | this workload over. |
Bruce Cran | 66c098b | 2012-11-27 12:16:07 +0000 | [diff] [blame] | 65 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 66 | The above are the basic parameters defined for a workload, in addition |
| 67 | there's a multitude of parameters that modify other aspects of how this |
| 68 | job behaves. |
| 69 | |
| 70 | |
| 71 | 3.0 Running fio |
| 72 | --------------- |
| 73 | See the README file for command line parameters, there are only a few |
| 74 | of them. |
| 75 | |
| 76 | Running fio is normally the easiest part - you just give it the job file |
| 77 | (or job files) as parameters: |
| 78 | |
| 79 | $ fio job_file |
| 80 | |
| 81 | and it will start doing what the job_file tells it to do. You can give |
| 82 | more than one job file on the command line, fio will serialize the running |
| 83 | of those files. Internally that is the same as using the 'stonewall' |
| 84 | parameter described the the parameter section. |
| 85 | |
Jens Axboe | b469282 | 2006-10-27 13:43:22 +0200 | [diff] [blame] | 86 | If the job file contains only one job, you may as well just give the |
| 87 | parameters on the command line. The command line parameters are identical |
| 88 | to the job parameters, with a few extra that control global parameters |
| 89 | (see README). For example, for the job file parameter iodepth=2, the |
Jens Axboe | c2b1e75 | 2006-10-30 09:03:13 +0100 | [diff] [blame] | 90 | mirror command line option would be --iodepth 2 or --iodepth=2. You can |
| 91 | also use the command line for giving more than one job entry. For each |
| 92 | --name option that fio sees, it will start a new job with that name. |
| 93 | Command line entries following a --name entry will apply to that job, |
| 94 | until there are no more entries or a new --name entry is seen. This is |
| 95 | similar to the job file options, where each option applies to the current |
| 96 | job until a new [] job entry is seen. |
Jens Axboe | b469282 | 2006-10-27 13:43:22 +0200 | [diff] [blame] | 97 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 98 | fio does not need to run as root, except if the files or devices specified |
| 99 | 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] | 100 | such as memory locking, io scheduler switching, and decreasing the nice value. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 101 | |
| 102 | |
| 103 | 4.0 Job file format |
| 104 | ------------------- |
| 105 | As previously described, fio accepts one or more job files describing |
| 106 | what it is supposed to do. The job file format is the classic ini file, |
| 107 | where the names enclosed in [] brackets define the job name. You are free |
| 108 | to use any ascii name you want, except 'global' which has special meaning. |
| 109 | A global section sets defaults for the jobs described in that file. A job |
| 110 | may override a global section parameter, and a job file may even have |
| 111 | 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] | 112 | section residing above it. If the first character in a line is a ';' or a |
| 113 | '#', the entire line is discarded as a comment. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 114 | |
Aaron Carroll | 3c54bc4 | 2008-10-07 11:25:38 +0200 | [diff] [blame] | 115 | So let's look at a really simple job file that defines two processes, each |
Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 116 | randomly reading from a 128MB file. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 117 | |
| 118 | ; -- start job file -- |
| 119 | [global] |
| 120 | rw=randread |
| 121 | size=128m |
| 122 | |
| 123 | [job1] |
| 124 | |
| 125 | [job2] |
| 126 | |
| 127 | ; -- end job file -- |
| 128 | |
| 129 | As you can see, the job file sections themselves are empty as all the |
| 130 | described parameters are shared. As no filename= option is given, fio |
Jens Axboe | c2b1e75 | 2006-10-30 09:03:13 +0100 | [diff] [blame] | 131 | makes up a filename for each of the jobs as it sees fit. On the command |
| 132 | line, this job would look as follows: |
| 133 | |
| 134 | $ fio --name=global --rw=randread --size=128m --name=job1 --name=job2 |
| 135 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 136 | |
Aaron Carroll | 3c54bc4 | 2008-10-07 11:25:38 +0200 | [diff] [blame] | 137 | Let's look at an example that has a number of processes writing randomly |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 138 | to files. |
| 139 | |
| 140 | ; -- start job file -- |
| 141 | [random-writers] |
| 142 | ioengine=libaio |
| 143 | iodepth=4 |
| 144 | rw=randwrite |
| 145 | bs=32k |
| 146 | direct=0 |
| 147 | size=64m |
| 148 | numjobs=4 |
| 149 | |
| 150 | ; -- end job file -- |
| 151 | |
| 152 | Here we have no global section, as we only have one job defined anyway. |
| 153 | We want to use async io here, with a depth of 4 for each file. We also |
Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 154 | increased the buffer size used to 32KB and define numjobs to 4 to |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 155 | fork 4 identical jobs. The result is 4 processes each randomly writing |
Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 156 | to their own 64MB file. Instead of using the above job file, you could |
Jens Axboe | b469282 | 2006-10-27 13:43:22 +0200 | [diff] [blame] | 157 | have given the parameters on the command line. For this case, you would |
| 158 | specify: |
| 159 | |
| 160 | $ 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] | 161 | |
Jens Axboe | 74929ac | 2009-08-05 11:42:37 +0200 | [diff] [blame] | 162 | 4.1 Environment variables |
| 163 | ------------------------- |
| 164 | |
Aaron Carroll | 3c54bc4 | 2008-10-07 11:25:38 +0200 | [diff] [blame] | 165 | fio also supports environment variable expansion in job files. Any |
| 166 | substring of the form "${VARNAME}" as part of an option value (in other |
| 167 | words, on the right of the `='), will be expanded to the value of the |
| 168 | environment variable called VARNAME. If no such environment variable |
| 169 | is defined, or VARNAME is the empty string, the empty string will be |
| 170 | substituted. |
| 171 | |
| 172 | As an example, let's look at a sample fio invocation and job file: |
| 173 | |
| 174 | $ SIZE=64m NUMJOBS=4 fio jobfile.fio |
| 175 | |
| 176 | ; -- start job file -- |
| 177 | [random-writers] |
| 178 | rw=randwrite |
| 179 | size=${SIZE} |
| 180 | numjobs=${NUMJOBS} |
| 181 | ; -- end job file -- |
| 182 | |
| 183 | This will expand to the following equivalent job file at runtime: |
| 184 | |
| 185 | ; -- start job file -- |
| 186 | [random-writers] |
| 187 | rw=randwrite |
| 188 | size=64m |
| 189 | numjobs=4 |
| 190 | ; -- end job file -- |
| 191 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 192 | fio ships with a few example job files, you can also look there for |
| 193 | inspiration. |
| 194 | |
Jens Axboe | 74929ac | 2009-08-05 11:42:37 +0200 | [diff] [blame] | 195 | 4.2 Reserved keywords |
| 196 | --------------------- |
| 197 | |
| 198 | Additionally, fio has a set of reserved keywords that will be replaced |
| 199 | internally with the appropriate value. Those keywords are: |
| 200 | |
| 201 | $pagesize The architecture page size of the running system |
| 202 | $mb_memory Megabytes of total memory in the system |
| 203 | $ncpus Number of online available CPUs |
| 204 | |
| 205 | These can be used on the command line or in the job file, and will be |
| 206 | automatically substituted with the current system values when the job |
Jens Axboe | 892a6ff | 2009-11-13 12:19:49 +0100 | [diff] [blame] | 207 | is run. Simple math is also supported on these keywords, so you can |
| 208 | perform actions like: |
| 209 | |
| 210 | size=8*$mb_memory |
| 211 | |
| 212 | and get that properly expanded to 8 times the size of memory in the |
| 213 | machine. |
Jens Axboe | 74929ac | 2009-08-05 11:42:37 +0200 | [diff] [blame] | 214 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 215 | |
| 216 | 5.0 Detailed list of parameters |
| 217 | ------------------------------- |
| 218 | |
| 219 | This section describes in details each parameter associated with a job. |
| 220 | Some parameters take an option of a given type, such as an integer or |
| 221 | a string. The following types are used: |
| 222 | |
| 223 | str String. This is a sequence of alpha characters. |
Jens Axboe | b09da8f | 2009-07-17 23:16:17 +0200 | [diff] [blame] | 224 | time Integer with possible time suffix. In seconds unless otherwise |
Jens Axboe | e417fd6 | 2008-09-11 09:27:15 +0200 | [diff] [blame] | 225 | specified, use eg 10m for 10 minutes. Accepts s/m/h for seconds, |
| 226 | minutes, and hours. |
Jens Axboe | b09da8f | 2009-07-17 23:16:17 +0200 | [diff] [blame] | 227 | int SI integer. A whole number value, which may contain a suffix |
| 228 | describing the base of the number. Accepted suffixes are k/m/g/t/p, |
| 229 | meaning kilo, mega, giga, tera, and peta. The suffix is not case |
Jens Axboe | 57fc29f | 2010-06-23 22:24:07 +0200 | [diff] [blame] | 230 | sensitive, and you may also include trailing 'b' (eg 'kb' is the same |
| 231 | as 'k'). So if you want to specify 4096, you could either write |
Jens Axboe | b09da8f | 2009-07-17 23:16:17 +0200 | [diff] [blame] | 232 | out '4096' or just give 4k. The suffixes signify base 2 values, so |
Jens Axboe | 57fc29f | 2010-06-23 22:24:07 +0200 | [diff] [blame] | 233 | 1024 is 1k and 1024k is 1m and so on, unless the suffix is explicitly |
| 234 | set to a base 10 value using 'kib', 'mib', 'gib', etc. If that is the |
| 235 | case, then 1000 is used as the multiplier. This can be handy for |
| 236 | disks, since manufacturers generally use base 10 values when listing |
| 237 | the capacity of a drive. If the option accepts an upper and lower |
| 238 | range, use a colon ':' or minus '-' to separate such values. May also |
| 239 | include a prefix to indicate numbers base. If 0x is used, the number |
| 240 | is assumed to be hexadecimal. See irange. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 241 | bool Boolean. Usually parsed as an integer, however only defined for |
| 242 | true and false (1 and 0). |
Jens Axboe | b09da8f | 2009-07-17 23:16:17 +0200 | [diff] [blame] | 243 | irange Integer range with suffix. Allows value range to be given, such |
Jens Axboe | bf9a3ed | 2008-06-05 11:53:08 +0200 | [diff] [blame] | 244 | as 1024-4096. A colon may also be used as the separator, eg |
Jens Axboe | 0c9baf9 | 2007-01-11 15:59:26 +0100 | [diff] [blame] | 245 | 1k:4k. If the option allows two sets of ranges, they can be |
| 246 | specified with a ',' or '/' delimiter: 1k-4k/8k-32k. Also see |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 247 | int. |
Yu-ju Hong | 8334919 | 2011-08-13 00:53:44 +0200 | [diff] [blame] | 248 | float_list A list of floating numbers, separated by a ':' character. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 249 | |
| 250 | With the above in mind, here follows the complete list of fio job |
| 251 | parameters. |
| 252 | |
| 253 | name=str ASCII name of the job. This may be used to override the |
| 254 | name printed by fio for this job. Otherwise the job |
Jens Axboe | c2b1e75 | 2006-10-30 09:03:13 +0100 | [diff] [blame] | 255 | name is used. On the command line this parameter has the |
Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 256 | special purpose of also signaling the start of a new |
Jens Axboe | c2b1e75 | 2006-10-30 09:03:13 +0100 | [diff] [blame] | 257 | job. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 258 | |
Jens Axboe | 61697c3 | 2007-02-05 15:04:46 +0100 | [diff] [blame] | 259 | description=str Text description of the job. Doesn't do anything except |
| 260 | dump this text description when this job is run. It's |
| 261 | not parsed. |
| 262 | |
Randy Dunlap | 3776041 | 2009-05-13 07:51:05 +0200 | [diff] [blame] | 263 | directory=str Prefix filenames with this directory. Used to place files |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 264 | in a different location than "./". |
| 265 | |
| 266 | filename=str Fio normally makes up a filename based on the job name, |
| 267 | thread number, and file number. If you want to share |
| 268 | files between threads in a job or several jobs, specify |
Jens Axboe | ed92ac0 | 2007-02-06 14:43:52 +0100 | [diff] [blame] | 269 | a filename for each of them to override the default. If |
Jens Axboe | 414c2a3 | 2009-01-16 13:21:15 +0100 | [diff] [blame] | 270 | the ioengine used is 'net', the filename is the host, port, |
Jens Axboe | 0fd666b | 2011-10-06 20:08:53 +0200 | [diff] [blame] | 271 | and protocol to use in the format of =host,port,protocol. |
Jens Axboe | 414c2a3 | 2009-01-16 13:21:15 +0100 | [diff] [blame] | 272 | See ioengine=net for more. If the ioengine is file based, you |
| 273 | can specify a number of files by separating the names with a |
| 274 | ':' colon. So if you wanted a job to open /dev/sda and /dev/sdb |
| 275 | as the two working files, you would use |
Jens Axboe | 30a4588 | 2013-01-30 12:53:55 +0100 | [diff] [blame] | 276 | filename=/dev/sda:/dev/sdb. On Windows, disk devices are |
| 277 | accessed as \\.\PhysicalDrive0 for the first device, |
| 278 | \\.\PhysicalDrive1 for the second etc. Note: Windows and |
| 279 | FreeBSD prevent write access to areas of the disk containing |
| 280 | in-use data (e.g. filesystems). |
| 281 | If the wanted filename does need to include a colon, then |
| 282 | escape that with a '\' character. For instance, if the filename |
| 283 | is "/dev/dsk/foo@3,0:c", then you would use |
| 284 | filename="/dev/dsk/foo@3,0\:c". '-' is a reserved name, meaning |
| 285 | stdin or stdout. Which of the two depends on the read/write |
| 286 | direction set. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 287 | |
Jens Axboe | de98bd3 | 2013-04-05 11:09:20 +0200 | [diff] [blame] | 288 | filename_format=str |
| 289 | If sharing multiple files between jobs, it is usually necessary |
| 290 | to have fio generate the exact names that you want. By default, |
| 291 | fio will name a file based on the default file format |
| 292 | specification of jobname.jobnumber.filenumber. With this |
| 293 | option, that can be customized. Fio will recognize and replace |
| 294 | the following keywords in this string: |
| 295 | |
| 296 | $jobname |
| 297 | The name of the worker thread or process. |
| 298 | |
| 299 | $jobnum |
| 300 | The incremental number of the worker thread or |
| 301 | process. |
| 302 | |
| 303 | $filenum |
| 304 | The incremental number of the file for that worker |
| 305 | thread or process. |
| 306 | |
| 307 | To have dependent jobs share a set of files, this option can |
| 308 | be set to have fio generate filenames that are shared between |
| 309 | the two. For instance, if testfiles.$filenum is specified, |
| 310 | file number 4 for any job will be named testfiles.4. The |
| 311 | default of $jobname.$jobnum.$filenum will be used if |
| 312 | no other format specifier is given. |
| 313 | |
Jens Axboe | bbf6b54 | 2007-03-13 15:28:55 +0100 | [diff] [blame] | 314 | opendir=str Tell fio to recursively add any file it can find in this |
| 315 | directory and down the file system tree. |
| 316 | |
Randy Dunlap | 3776041 | 2009-05-13 07:51:05 +0200 | [diff] [blame] | 317 | lockfile=str Fio defaults to not locking any files before it does |
Jens Axboe | 4d4e80f | 2008-03-04 10:18:56 +0100 | [diff] [blame] | 318 | IO to them. If a file or file descriptor is shared, fio |
| 319 | can serialize IO to that file to make the end result |
| 320 | consistent. This is usual for emulating real workloads that |
| 321 | share files. The lock modes are: |
Jens Axboe | 29c1349 | 2008-03-01 19:25:20 +0100 | [diff] [blame] | 322 | |
Jens Axboe | 4d4e80f | 2008-03-04 10:18:56 +0100 | [diff] [blame] | 323 | none No locking. The default. |
| 324 | exclusive Only one thread/process may do IO, |
| 325 | excluding all others. |
| 326 | readwrite Read-write locking on the file. Many |
| 327 | readers may access the file at the |
| 328 | same time, but writes get exclusive |
| 329 | access. |
| 330 | |
Jens Axboe | d3aad8f | 2007-03-15 14:12:05 +0100 | [diff] [blame] | 331 | readwrite=str |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 332 | rw=str Type of io pattern. Accepted values are: |
| 333 | |
| 334 | read Sequential reads |
| 335 | write Sequential writes |
| 336 | randwrite Random writes |
| 337 | randread Random reads |
Jens Axboe | 10b023d | 2012-03-23 13:40:06 +0100 | [diff] [blame] | 338 | rw,readwrite Sequential mixed reads and writes |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 339 | randrw Random mixed reads and writes |
| 340 | |
| 341 | For the mixed io types, the default is to split them 50/50. |
| 342 | 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] | 343 | since the speed may be different. It is possible to specify |
Jens Axboe | 38dad62 | 2010-07-20 14:46:00 -0600 | [diff] [blame] | 344 | a number of IO's to do before getting a new offset, this is |
| 345 | one by appending a ':<nr>' to the end of the string given. |
| 346 | For a random read, it would look like 'rw=randread:8' for |
Jens Axboe | 059b080 | 2011-08-25 09:09:37 +0200 | [diff] [blame] | 347 | passing in an offset modifier with a value of 8. If the |
Lucian Adrian Grijincu | ddb754d | 2012-04-05 18:18:35 -0600 | [diff] [blame] | 348 | suffix is used with a sequential IO pattern, then the value |
Jens Axboe | 059b080 | 2011-08-25 09:09:37 +0200 | [diff] [blame] | 349 | specified will be added to the generated offset for each IO. |
| 350 | For instance, using rw=write:4k will skip 4k for every |
| 351 | write. It turns sequential IO into sequential IO with holes. |
| 352 | See the 'rw_sequencer' option. |
Jens Axboe | 38dad62 | 2010-07-20 14:46:00 -0600 | [diff] [blame] | 353 | |
| 354 | rw_sequencer=str If an offset modifier is given by appending a number to |
| 355 | the rw=<str> line, then this option controls how that |
| 356 | number modifies the IO offset being generated. Accepted |
| 357 | values are: |
| 358 | |
| 359 | sequential Generate sequential offset |
| 360 | identical Generate the same offset |
| 361 | |
| 362 | 'sequential' is only useful for random IO, where fio would |
| 363 | normally generate a new random offset for every IO. If you |
| 364 | append eg 8 to randread, you would get a new random offset for |
Jens Axboe | 211097b | 2007-03-22 18:56:45 +0100 | [diff] [blame] | 365 | every 8 IO's. The result would be a seek for only every 8 |
| 366 | IO's, instead of for every IO. Use rw=randread:8 to specify |
Jens Axboe | 38dad62 | 2010-07-20 14:46:00 -0600 | [diff] [blame] | 367 | that. As sequential IO is already sequential, setting |
| 368 | 'sequential' for that would not result in any differences. |
| 369 | 'identical' behaves in a similar fashion, except it sends |
| 370 | the same offset 8 number of times before generating a new |
| 371 | offset. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 372 | |
Jens Axboe | 90fef2d | 2009-07-17 22:33:32 +0200 | [diff] [blame] | 373 | kb_base=int The base unit for a kilobyte. The defacto base is 2^10, 1024. |
| 374 | Storage manufacturers like to use 10^3 or 1000 as a base |
| 375 | ten unit instead, for obvious reasons. Allow values are |
| 376 | 1024 or 1000, with 1024 being the default. |
| 377 | |
Jens Axboe | 771e58b | 2013-01-30 12:56:23 +0100 | [diff] [blame] | 378 | unified_rw_reporting=bool Fio normally reports statistics on a per |
| 379 | data direction basis, meaning that read, write, and trim are |
| 380 | accounted and reported separately. If this option is set, |
| 381 | the fio will sum the results and report them as "mixed" |
| 382 | instead. |
| 383 | |
Jens Axboe | ee73849 | 2007-01-10 11:23:16 +0100 | [diff] [blame] | 384 | randrepeat=bool For random IO workloads, seed the generator in a predictable |
| 385 | way so that results are repeatable across repetitions. |
| 386 | |
Jens Axboe | 04778ba | 2014-01-10 20:57:01 -0700 | [diff] [blame] | 387 | randseed=int Seed the random number generators based on this seed value, to |
| 388 | be able to control what sequence of output is being generated. |
| 389 | If not set, the random sequence depends on the randrepeat |
| 390 | setting. |
| 391 | |
Jens Axboe | 2615cc4 | 2011-03-28 09:35:09 +0200 | [diff] [blame] | 392 | use_os_rand=bool Fio can either use the random generator supplied by the OS |
| 393 | to generator random offsets, or it can use it's own internal |
| 394 | generator (based on Tausworthe). Default is to use the |
| 395 | internal generator, which is often of better quality and |
| 396 | faster. |
| 397 | |
Eric Gouriou | a596f04 | 2011-06-17 09:11:45 +0200 | [diff] [blame] | 398 | fallocate=str Whether pre-allocation is performed when laying down files. |
| 399 | Accepted values are: |
| 400 | |
| 401 | none Do not pre-allocate space |
| 402 | posix Pre-allocate via posix_fallocate() |
| 403 | keep Pre-allocate via fallocate() with |
| 404 | FALLOC_FL_KEEP_SIZE set |
| 405 | 0 Backward-compatible alias for 'none' |
| 406 | 1 Backward-compatible alias for 'posix' |
| 407 | |
| 408 | May not be available on all supported platforms. 'keep' is only |
| 409 | available on Linux.If using ZFS on Solaris this must be set to |
| 410 | 'none' because ZFS doesn't support it. Default: 'posix'. |
Jens Axboe | 7bc8c2c | 2010-01-28 11:31:31 +0100 | [diff] [blame] | 411 | |
Jens Axboe | d2f3ac3 | 2007-03-22 19:24:09 +0100 | [diff] [blame] | 412 | fadvise_hint=bool By default, fio will use fadvise() to advise the kernel |
| 413 | on what IO patterns it is likely to issue. Sometimes you |
| 414 | want to test specific IO patterns without telling the |
| 415 | kernel about it, in which case you can disable this option. |
| 416 | If set, fio will use POSIX_FADV_SEQUENTIAL for sequential |
| 417 | IO and POSIX_FADV_RANDOM for random IO. |
| 418 | |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 419 | size=int The total size of file io for this job. Fio will run until |
Jens Axboe | 7616caf | 2007-05-25 09:26:05 +0200 | [diff] [blame] | 420 | this many bytes has been transferred, unless runtime is |
| 421 | limited by other options (such as 'runtime', for instance). |
Randy Dunlap | 3776041 | 2009-05-13 07:51:05 +0200 | [diff] [blame] | 422 | Unless specific nrfiles and filesize options are given, |
Jens Axboe | 7616caf | 2007-05-25 09:26:05 +0200 | [diff] [blame] | 423 | fio will divide this size between the available files |
Jens Axboe | d666726 | 2010-06-25 11:32:48 +0200 | [diff] [blame] | 424 | specified by the job. If not set, fio will use the full |
| 425 | size of the given files or devices. If the the files |
Jens Axboe | 7bb5910 | 2011-07-12 19:47:03 +0200 | [diff] [blame] | 426 | do not exist, size must be given. It is also possible to |
| 427 | give size as a percentage between 1 and 100. If size=20% |
| 428 | is given, fio will use 20% of the full size of the given |
| 429 | files or devices. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 430 | |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 431 | filesize=int Individual file sizes. May be a range, in which case fio |
Jens Axboe | 9c60ce6 | 2007-03-15 09:14:47 +0100 | [diff] [blame] | 432 | will select sizes for files at random within the given range |
| 433 | and limited to 'size' in total (if that is given). If not |
| 434 | given, each created file is the same size. |
| 435 | |
Jens Axboe | 74586c1 | 2011-01-20 10:16:03 -0700 | [diff] [blame] | 436 | fill_device=bool |
| 437 | fill_fs=bool Sets size to something really large and waits for ENOSPC (no |
Shawn Lewis | aa31f1f | 2008-01-11 09:45:11 +0100 | [diff] [blame] | 438 | space left on device) as the terminating condition. Only makes |
Jens Axboe | de98bd3 | 2013-04-05 11:09:20 +0200 | [diff] [blame] | 439 | sense with sequential write. For a read workload, the mount |
Jens Axboe | 4f12432 | 2011-01-19 15:35:26 -0700 | [diff] [blame] | 440 | point will be filled first then IO started on the result. This |
| 441 | option doesn't make sense if operating on a raw device node, |
| 442 | since the size of that is already known by the file system. |
| 443 | Additionally, writing beyond end-of-device will not return |
| 444 | ENOSPC there. |
Shawn Lewis | aa31f1f | 2008-01-11 09:45:11 +0100 | [diff] [blame] | 445 | |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 446 | blocksize=int |
| 447 | bs=int The block size used for the io units. Defaults to 4k. Values |
| 448 | can be given for both read and writes. If a single int is |
| 449 | given, it will apply to both. If a second int is specified |
Jens Axboe | f90eff5 | 2006-11-06 11:08:21 +0100 | [diff] [blame] | 450 | after a comma, it will apply to writes only. In other words, |
Jens Axboe | d947227 | 2013-07-25 10:20:45 -0600 | [diff] [blame] | 451 | the format is either bs=read_and_write or bs=read,write,trim. |
| 452 | bs=4k,8k will thus use 4k blocks for reads, 8k blocks for |
| 453 | writes, and 8k for trims. You can terminate the list with |
| 454 | a trailing comma. bs=4k,8k, would use the default value for |
| 455 | trims.. If you only wish to set the write size, you |
Jens Axboe | 787f7e9 | 2006-11-06 13:26:29 +0100 | [diff] [blame] | 456 | can do so by passing an empty read size - bs=,8k will set |
| 457 | 8k for writes and leave the read default value. |
Jens Axboe | a00735e | 2006-11-03 08:58:08 +0100 | [diff] [blame] | 458 | |
Jens Axboe | 2b7a01d | 2009-03-11 11:00:13 +0100 | [diff] [blame] | 459 | blockalign=int |
| 460 | ba=int At what boundary to align random IO offsets. Defaults to |
| 461 | the same as 'blocksize' the minimum blocksize given. |
| 462 | Minimum alignment is typically 512b for using direct IO, |
| 463 | though it usually depends on the hardware block size. This |
| 464 | option is mutually exclusive with using a random map for |
| 465 | files, so it will turn off that option. |
| 466 | |
Jens Axboe | d3aad8f | 2007-03-15 14:12:05 +0100 | [diff] [blame] | 467 | blocksize_range=irange |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 468 | bsrange=irange Instead of giving a single block size, specify a range |
| 469 | and fio will mix the issued io block sizes. The issued |
| 470 | io unit will always be a multiple of the minimum value |
Jens Axboe | f90eff5 | 2006-11-06 11:08:21 +0100 | [diff] [blame] | 471 | given (also see bs_unaligned). Applies to both reads and |
| 472 | writes, however a second range can be given after a comma. |
| 473 | See bs=. |
Jens Axboe | a00735e | 2006-11-03 08:58:08 +0100 | [diff] [blame] | 474 | |
Jens Axboe | 564ca97 | 2007-12-14 12:21:19 +0100 | [diff] [blame] | 475 | bssplit=str Sometimes you want even finer grained control of the |
| 476 | block sizes issued, not just an even split between them. |
| 477 | This option allows you to weight various block sizes, |
| 478 | so that you are able to define a specific amount of |
| 479 | block sizes issued. The format for this option is: |
| 480 | |
| 481 | bssplit=blocksize/percentage:blocksize/percentage |
| 482 | |
| 483 | for as many block sizes as needed. So if you want to define |
| 484 | a workload that has 50% 64k blocks, 10% 4k blocks, and |
| 485 | 40% 32k blocks, you would write: |
| 486 | |
| 487 | bssplit=4k/10:64k/50:32k/40 |
| 488 | |
| 489 | Ordering does not matter. If the percentage is left blank, |
| 490 | fio will fill in the remaining values evenly. So a bssplit |
| 491 | option like this one: |
| 492 | |
| 493 | bssplit=4k/50:1k/:32k/ |
| 494 | |
| 495 | would have 50% 4k ios, and 25% 1k and 32k ios. The percentages |
| 496 | always add up to 100, if bssplit is given a range that adds |
| 497 | up to more, it will error out. |
| 498 | |
Jens Axboe | 720e84a | 2009-04-21 08:29:55 +0200 | [diff] [blame] | 499 | bssplit also supports giving separate splits to reads and |
| 500 | writes. The format is identical to what bs= accepts. You |
| 501 | have to separate the read and write parts with a comma. So |
| 502 | if you want a workload that has 50% 2k reads and 50% 4k reads, |
| 503 | while having 90% 4k writes and 10% 8k writes, you would |
| 504 | specify: |
| 505 | |
| 506 | bssplit=2k/50:4k/50,4k/90,8k/10 |
| 507 | |
Jens Axboe | d3aad8f | 2007-03-15 14:12:05 +0100 | [diff] [blame] | 508 | blocksize_unaligned |
Jens Axboe | 690adba | 2006-10-30 15:25:09 +0100 | [diff] [blame] | 509 | bs_unaligned If this option is given, any byte size value within bsrange |
| 510 | may be used as a block range. This typically wont work with |
| 511 | direct IO, as that normally requires sector alignment. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 512 | |
Jens Axboe | 6aca9b3 | 2013-07-25 12:45:26 -0600 | [diff] [blame] | 513 | bs_is_seq_rand If this option is set, fio will use the normal read,write |
| 514 | blocksize settings as sequential,random instead. Any random |
| 515 | read or write will use the WRITE blocksize settings, and any |
| 516 | sequential read or write will use the READ blocksize setting. |
| 517 | |
Jens Axboe | e9459e5 | 2007-04-17 15:46:32 +0200 | [diff] [blame] | 518 | zero_buffers If this option is given, fio will init the IO buffers to |
| 519 | all zeroes. The default is to fill them with random data. |
| 520 | |
Jens Axboe | 5973caf | 2008-05-21 19:52:35 +0200 | [diff] [blame] | 521 | refill_buffers If this option is given, fio will refill the IO buffers |
| 522 | on every submit. The default is to only fill it at init |
| 523 | time and reuse that data. Only makes sense if zero_buffers |
Jens Axboe | 41ccd84 | 2008-05-22 09:17:33 +0200 | [diff] [blame] | 524 | isn't specified, naturally. If data verification is enabled, |
| 525 | refill_buffers is also automatically enabled. |
Jens Axboe | 5973caf | 2008-05-21 19:52:35 +0200 | [diff] [blame] | 526 | |
Jens Axboe | fd68418 | 2011-09-19 09:24:44 +0200 | [diff] [blame] | 527 | scramble_buffers=bool If refill_buffers is too costly and the target is |
| 528 | using data deduplication, then setting this option will |
| 529 | slightly modify the IO buffer contents to defeat normal |
| 530 | de-dupe attempts. This is not enough to defeat more clever |
| 531 | block compression attempts, but it will stop naive dedupe of |
| 532 | blocks. Default: true. |
| 533 | |
Jens Axboe | c5751c6 | 2012-03-15 15:02:56 +0100 | [diff] [blame] | 534 | buffer_compress_percentage=int If this is set, then fio will attempt to |
| 535 | provide IO buffer content (on WRITEs) that compress to |
| 536 | the specified level. Fio does this by providing a mix of |
| 537 | random data and zeroes. Note that this is per block size |
| 538 | unit, for file/disk wide compression level that matches |
| 539 | this setting, you'll also want to set refill_buffers. |
| 540 | |
| 541 | buffer_compress_chunk=int See buffer_compress_percentage. This |
| 542 | setting allows fio to manage how big the ranges of random |
| 543 | data and zeroed data is. Without this set, fio will |
| 544 | provide buffer_compress_percentage of blocksize random |
| 545 | data, followed by the remaining zeroed. With this set |
| 546 | to some chunk size smaller than the block size, fio can |
| 547 | alternate random and zeroed data throughout the IO |
| 548 | buffer. |
| 549 | |
Jens Axboe | ce35b1e | 2014-01-14 15:35:58 -0700 | [diff] [blame] | 550 | buffer_pattern=str If set, fio will fill the io buffers with this pattern. |
| 551 | If not set, the contents of io buffers is defined by the other |
| 552 | options related to buffer contents. The setting can be any |
| 553 | pattern of bytes, and can be prefixed with 0x for hex values. |
| 554 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 555 | nrfiles=int Number of files to use for this job. Defaults to 1. |
| 556 | |
Jens Axboe | 390b153 | 2007-03-09 13:03:00 +0100 | [diff] [blame] | 557 | openfiles=int Number of files to keep open at the same time. Defaults to |
| 558 | the same as nrfiles, can be set smaller to limit the number |
| 559 | simultaneous opens. |
| 560 | |
Jens Axboe | 5af1c6f | 2007-03-01 10:06:10 +0100 | [diff] [blame] | 561 | file_service_type=str Defines how fio decides which file from a job to |
| 562 | service next. The following types are defined: |
| 563 | |
| 564 | random Just choose a file at random. |
| 565 | |
| 566 | roundrobin Round robin over open files. This |
| 567 | is the default. |
| 568 | |
Jens Axboe | a086c25 | 2009-03-04 08:27:37 +0100 | [diff] [blame] | 569 | sequential Finish one file before moving on to |
| 570 | the next. Multiple files can still be |
| 571 | open depending on 'openfiles'. |
| 572 | |
Jens Axboe | 1907dbc | 2007-03-12 11:44:28 +0100 | [diff] [blame] | 573 | The string can have a number appended, indicating how |
| 574 | often to switch to a new file. So if option random:4 is |
| 575 | given, fio will switch to a new random file after 4 ios |
| 576 | have been issued. |
| 577 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 578 | ioengine=str Defines how the job issues io to the file. The following |
| 579 | types are defined: |
| 580 | |
| 581 | sync Basic read(2) or write(2) io. lseek(2) is |
| 582 | used to position the io location. |
| 583 | |
gurudas pai | a31041e | 2007-10-23 15:12:30 +0200 | [diff] [blame] | 584 | psync Basic pread(2) or pwrite(2) io. |
| 585 | |
Gurudas Pai | e05af9e | 2008-02-06 11:16:15 +0100 | [diff] [blame] | 586 | vsync Basic readv(2) or writev(2) IO. |
Jens Axboe | 1d2af02 | 2008-02-04 10:59:07 +0100 | [diff] [blame] | 587 | |
Jens Axboe | a46c5e0 | 2013-05-16 20:38:09 +0200 | [diff] [blame] | 588 | psyncv Basic preadv(2) or pwritev(2) IO. |
| 589 | |
Jens Axboe | 15d182a | 2009-01-16 19:15:07 +0100 | [diff] [blame] | 590 | libaio Linux native asynchronous io. Note that Linux |
| 591 | may only support queued behaviour with |
| 592 | non-buffered IO (set direct=1 or buffered=0). |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 593 | This engine defines engine specific options. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 594 | |
| 595 | posixaio glibc posix asynchronous io. |
| 596 | |
Jens Axboe | 417f006 | 2008-06-02 11:59:30 +0200 | [diff] [blame] | 597 | solarisaio Solaris native asynchronous io. |
| 598 | |
Bruce Cran | 03e20d6 | 2011-01-02 20:14:54 +0100 | [diff] [blame] | 599 | windowsaio Windows native asynchronous io. |
| 600 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 601 | mmap File is memory mapped and data copied |
| 602 | to/from using memcpy(3). |
| 603 | |
| 604 | splice splice(2) is used to transfer the data and |
| 605 | vmsplice(2) to transfer data from user |
| 606 | space to the kernel. |
| 607 | |
Jens Axboe | d0ff85d | 2007-02-14 01:19:41 +0100 | [diff] [blame] | 608 | syslet-rw Use the syslet system calls to make |
| 609 | regular read/write async. |
| 610 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 611 | sg SCSI generic sg v3 io. May either be |
Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 612 | synchronous using the SG_IO ioctl, or if |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 613 | the target is an sg character device |
| 614 | we use read(2) and write(2) for asynchronous |
| 615 | io. |
| 616 | |
Jens Axboe | a94ea28 | 2006-11-24 12:37:34 +0100 | [diff] [blame] | 617 | null Doesn't transfer any data, just pretends |
| 618 | to. This is mainly used to exercise fio |
| 619 | itself and for debugging/testing purposes. |
| 620 | |
Jens Axboe | ed92ac0 | 2007-02-06 14:43:52 +0100 | [diff] [blame] | 621 | net Transfer over the network to given host:port. |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 622 | Depending on the protocol used, the hostname, |
| 623 | port, listen and filename options are used to |
| 624 | specify what sort of connection to make, while |
| 625 | the protocol option determines which protocol |
| 626 | will be used. |
| 627 | This engine defines engine specific options. |
Jens Axboe | ed92ac0 | 2007-02-06 14:43:52 +0100 | [diff] [blame] | 628 | |
Jens Axboe | 9cce02e | 2007-06-22 15:42:21 +0200 | [diff] [blame] | 629 | netsplice Like net, but uses splice/vmsplice to |
| 630 | map data and send/receive. |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 631 | This engine defines engine specific options. |
Jens Axboe | 9cce02e | 2007-06-22 15:42:21 +0200 | [diff] [blame] | 632 | |
gurudas pai | 53aec0a | 2007-10-05 13:20:18 +0200 | [diff] [blame] | 633 | cpuio Doesn't transfer any data, but burns CPU |
Jens Axboe | ba0fbe1 | 2007-03-09 14:34:23 +0100 | [diff] [blame] | 634 | cycles according to the cpuload= and |
| 635 | cpucycle= options. Setting cpuload=85 |
| 636 | will cause that job to do nothing but burn |
Gurudas Pai | 36ecec8 | 2008-02-08 08:50:14 +0100 | [diff] [blame] | 637 | 85% of the CPU. In case of SMP machines, |
| 638 | use numjobs=<no_of_cpu> to get desired CPU |
| 639 | usage, as the cpuload only loads a single |
| 640 | CPU at the desired rate. |
Jens Axboe | ba0fbe1 | 2007-03-09 14:34:23 +0100 | [diff] [blame] | 641 | |
Jens Axboe | e9a1806 | 2007-03-21 08:51:56 +0100 | [diff] [blame] | 642 | guasi The GUASI IO engine is the Generic Userspace |
| 643 | Asyncronous Syscall Interface approach |
| 644 | to async IO. See |
| 645 | |
| 646 | http://www.xmailserver.org/guasi-lib.html |
| 647 | |
| 648 | for more info on GUASI. |
| 649 | |
ren yufei | 21b8aee | 2011-08-01 10:01:57 +0200 | [diff] [blame] | 650 | rdma The RDMA I/O engine supports both RDMA |
Bart Van Assche | eb52fa3 | 2011-08-15 09:01:05 +0200 | [diff] [blame] | 651 | memory semantics (RDMA_WRITE/RDMA_READ) and |
| 652 | channel semantics (Send/Recv) for the |
| 653 | InfiniBand, RoCE and iWARP protocols. |
ren yufei | 21b8aee | 2011-08-01 10:01:57 +0200 | [diff] [blame] | 654 | |
Dmitry Monakhov | d54fce8 | 2012-09-20 15:37:17 +0400 | [diff] [blame] | 655 | falloc IO engine that does regular fallocate to |
| 656 | simulate data transfer as fio ioengine. |
| 657 | DDIR_READ does fallocate(,mode = keep_size,) |
Jens Axboe | 0981fd7 | 2012-09-20 19:23:02 +0200 | [diff] [blame] | 658 | DDIR_WRITE does fallocate(,mode = 0) |
Dmitry Monakhov | d54fce8 | 2012-09-20 15:37:17 +0400 | [diff] [blame] | 659 | DDIR_TRIM does fallocate(,mode = punch_hole) |
| 660 | |
| 661 | e4defrag IO engine that does regular EXT4_IOC_MOVE_EXT |
| 662 | ioctls to simulate defragment activity in |
| 663 | request to DDIR_WRITE event |
Jens Axboe | 0981fd7 | 2012-09-20 19:23:02 +0200 | [diff] [blame] | 664 | |
Jens Axboe | 8a7bd87 | 2007-02-28 11:12:25 +0100 | [diff] [blame] | 665 | external Prefix to specify loading an external |
| 666 | IO engine object file. Append the engine |
| 667 | filename, eg ioengine=external:/tmp/foo.o |
| 668 | to load ioengine foo.o in /tmp. |
| 669 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 670 | iodepth=int This defines how many io units to keep in flight against |
| 671 | the file. The default is 1 for each file defined in this |
| 672 | job, can be overridden with a larger value for higher |
Jens Axboe | ee72ca0 | 2010-12-02 20:05:37 +0100 | [diff] [blame] | 673 | concurrency. Note that increasing iodepth beyond 1 will not |
| 674 | affect synchronous ioengines (except for small degress when |
Bruce Cran | 9b83656 | 2011-01-08 19:49:54 +0100 | [diff] [blame] | 675 | verify_async is in use). Even async engines may impose OS |
Jens Axboe | ee72ca0 | 2010-12-02 20:05:37 +0100 | [diff] [blame] | 676 | restrictions causing the desired depth not to be achieved. |
| 677 | This may happen on Linux when using libaio and not setting |
| 678 | direct=1, since buffered IO is not async on that OS. Keep an |
| 679 | eye on the IO depth distribution in the fio output to verify |
| 680 | that the achieved depth is as expected. Default: 1. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 681 | |
Jens Axboe | 4950421 | 2008-06-05 09:03:30 +0200 | [diff] [blame] | 682 | iodepth_batch_submit=int |
Jens Axboe | cb5ab51 | 2007-02-26 12:57:09 +0100 | [diff] [blame] | 683 | iodepth_batch=int This defines how many pieces of IO to submit at once. |
Jens Axboe | 89e820f | 2008-01-18 10:30:07 +0100 | [diff] [blame] | 684 | It defaults to 1 which means that we submit each IO |
| 685 | as soon as it is available, but can be raised to submit |
| 686 | bigger batches of IO at the time. |
Jens Axboe | cb5ab51 | 2007-02-26 12:57:09 +0100 | [diff] [blame] | 687 | |
Jens Axboe | 4950421 | 2008-06-05 09:03:30 +0200 | [diff] [blame] | 688 | iodepth_batch_complete=int This defines how many pieces of IO to retrieve |
| 689 | at once. It defaults to 1 which means that we'll ask |
| 690 | for a minimum of 1 IO in the retrieval process from |
| 691 | the kernel. The IO retrieval will go on until we |
| 692 | hit the limit set by iodepth_low. If this variable is |
| 693 | set to 0, then fio will always check for completed |
| 694 | events before queuing more IO. This helps reduce |
| 695 | IO latency, at the cost of more retrieval system calls. |
| 696 | |
Jens Axboe | e916b39 | 2007-02-20 14:37:26 +0100 | [diff] [blame] | 697 | iodepth_low=int The low water mark indicating when to start filling |
| 698 | the queue again. Defaults to the same as iodepth, meaning |
| 699 | that fio will attempt to keep the queue full at all times. |
| 700 | If iodepth is set to eg 16 and iodepth_low is set to 4, then |
| 701 | after fio has filled the queue of 16 requests, it will let |
| 702 | the depth drain down to 4 before starting to fill it again. |
| 703 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 704 | direct=bool If value is true, use non-buffered io. This is usually |
Bruce Cran | 9b83656 | 2011-01-08 19:49:54 +0100 | [diff] [blame] | 705 | O_DIRECT. Note that ZFS on Solaris doesn't support direct io. |
Bruce Cran | 93bcfd2 | 2012-02-20 20:18:19 +0100 | [diff] [blame] | 706 | On Windows the synchronous ioengines don't support direct io. |
Jens Axboe | 76a43db | 2007-01-11 13:24:44 +0100 | [diff] [blame] | 707 | |
Chris Mason | d01612f | 2013-11-15 15:52:58 -0700 | [diff] [blame] | 708 | atomic=bool If value is true, attempt to use atomic direct IO. Atomic |
| 709 | writes are guaranteed to be stable once acknowledged by |
| 710 | the operating system. Only Linux supports O_ATOMIC right |
| 711 | now. |
| 712 | |
Jens Axboe | 76a43db | 2007-01-11 13:24:44 +0100 | [diff] [blame] | 713 | buffered=bool If value is true, use buffered io. This is the opposite |
| 714 | of the 'direct' option. Defaults to true. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 715 | |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 716 | offset=int Start io at the given offset in the file. The data before |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 717 | the given offset will not be touched. This effectively |
| 718 | caps the file size at real_size - offset. |
| 719 | |
Dan Ehrenberg | 214ac7e | 2012-03-15 14:44:26 +0100 | [diff] [blame] | 720 | offset_increment=int If this is provided, then the real offset becomes |
| 721 | the offset + offset_increment * thread_number, where the |
| 722 | thread number is a counter that starts at 0 and is incremented |
| 723 | for each job. This option is useful if there are several jobs |
| 724 | which are intended to operate on a file in parallel in disjoint |
| 725 | segments, with even spacing between the starting points. |
| 726 | |
Jens Axboe | ddf24e4 | 2013-08-09 12:53:44 -0600 | [diff] [blame] | 727 | number_ios=int Fio will normally perform IOs until it has exhausted the size |
| 728 | of the region set by size=, or if it exhaust the allocated |
| 729 | time (or hits an error condition). With this setting, the |
| 730 | range/size can be set independently of the number of IOs to |
| 731 | perform. When fio reaches this number, it will exit normally |
| 732 | and report status. |
| 733 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 734 | fsync=int If writing to a file, issue a sync of the dirty data |
| 735 | for every number of blocks given. For example, if you give |
| 736 | 32 as a parameter, fio will sync the file for every 32 |
| 737 | writes issued. If fio is using non-buffered io, we may |
| 738 | not sync the file. The exception is the sg io engine, which |
Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 739 | synchronizes the disk cache anyway. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 740 | |
Jens Axboe | e76b1da | 2010-03-09 20:49:54 +0100 | [diff] [blame] | 741 | fdatasync=int Like fsync= but uses fdatasync() to only sync data and not |
Jens Axboe | 5f9099e | 2009-06-16 22:40:26 +0200 | [diff] [blame] | 742 | metadata blocks. |
Bruce Cran | 93bcfd2 | 2012-02-20 20:18:19 +0100 | [diff] [blame] | 743 | In FreeBSD and Windows there is no fdatasync(), this falls back to |
Joshua Aune | e72fa4d | 2010-02-11 00:59:18 -0700 | [diff] [blame] | 744 | using fsync() |
Jens Axboe | 5f9099e | 2009-06-16 22:40:26 +0200 | [diff] [blame] | 745 | |
Jens Axboe | e76b1da | 2010-03-09 20:49:54 +0100 | [diff] [blame] | 746 | sync_file_range=str:val Use sync_file_range() for every 'val' number of |
| 747 | write operations. Fio will track range of writes that |
| 748 | have happened since the last sync_file_range() call. 'str' |
| 749 | can currently be one or more of: |
| 750 | |
| 751 | wait_before SYNC_FILE_RANGE_WAIT_BEFORE |
| 752 | write SYNC_FILE_RANGE_WRITE |
| 753 | wait_after SYNC_FILE_RANGE_WAIT_AFTER |
| 754 | |
| 755 | So if you do sync_file_range=wait_before,write:8, fio would |
| 756 | use SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE for |
| 757 | every 8 writes. Also see the sync_file_range(2) man page. |
| 758 | This option is Linux specific. |
| 759 | |
Jens Axboe | 5036fc1 | 2008-04-15 09:20:46 +0200 | [diff] [blame] | 760 | overwrite=bool If true, writes to a file will always overwrite existing |
| 761 | data. If the file doesn't already exist, it will be |
| 762 | created before the write phase begins. If the file exists |
| 763 | and is large enough for the specified write phase, nothing |
| 764 | will be done. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 765 | |
Jens Axboe | dbd11ea | 2013-01-13 17:16:46 +0100 | [diff] [blame] | 766 | end_fsync=bool If true, fsync file contents when a write stage has completed. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 767 | |
Jens Axboe | ebb1415 | 2007-03-13 14:42:15 +0100 | [diff] [blame] | 768 | fsync_on_close=bool If true, fio will fsync() a dirty file on close. |
| 769 | This differs from end_fsync in that it will happen on every |
| 770 | file close, not just at the end of the job. |
| 771 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 772 | rwmixread=int How large a percentage of the mix should be reads. |
| 773 | |
| 774 | rwmixwrite=int How large a percentage of the mix should be writes. If both |
| 775 | rwmixread and rwmixwrite is given and the values do not add |
| 776 | up to 100%, the latter of the two will be used to override |
Jens Axboe | c35dd7a | 2009-06-10 08:39:16 +0200 | [diff] [blame] | 777 | the first. This may interfere with a given rate setting, |
| 778 | if fio is asked to limit reads or writes to a certain rate. |
| 779 | If that is the case, then the distribution may be skewed. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 780 | |
Jens Axboe | 92d42d6 | 2012-11-15 15:38:32 -0700 | [diff] [blame] | 781 | random_distribution=str:float By default, fio will use a completely uniform |
| 782 | random distribution when asked to perform random IO. Sometimes |
| 783 | it is useful to skew the distribution in specific ways, |
| 784 | ensuring that some parts of the data is more hot than others. |
| 785 | fio includes the following distribution models: |
| 786 | |
| 787 | random Uniform random distribution |
| 788 | zipf Zipf distribution |
| 789 | pareto Pareto distribution |
| 790 | |
| 791 | When using a zipf or pareto distribution, an input value |
| 792 | is also needed to define the access pattern. For zipf, this |
| 793 | is the zipf theta. For pareto, it's the pareto power. Fio |
| 794 | includes a test program, genzipf, that can be used visualize |
| 795 | what the given input values will yield in terms of hit rates. |
| 796 | If you wanted to use zipf with a theta of 1.2, you would use |
| 797 | random_distribution=zipf:1.2 as the option. If a non-uniform |
| 798 | model is used, fio will disable use of the random map. |
| 799 | |
Jens Axboe | 211c9b8 | 2013-04-26 08:56:17 -0600 | [diff] [blame] | 800 | percentage_random=int For a random workload, set how big a percentage should |
| 801 | be random. This defaults to 100%, in which case the workload |
| 802 | is fully random. It can be set from anywhere from 0 to 100. |
| 803 | Setting it to 0 would make the workload fully sequential. Any |
| 804 | setting in between will result in a random mix of sequential |
Jens Axboe | d947227 | 2013-07-25 10:20:45 -0600 | [diff] [blame] | 805 | and random IO, at the given percentages. It is possible to |
| 806 | set different values for reads, writes, and trim. To do so, |
| 807 | simply use a comma separated list. See blocksize. |
Jens Axboe | 211c9b8 | 2013-04-26 08:56:17 -0600 | [diff] [blame] | 808 | |
Jens Axboe | bb8895e | 2006-10-30 15:14:48 +0100 | [diff] [blame] | 809 | norandommap Normally fio will cover every block of the file when doing |
| 810 | random IO. If this option is given, fio will just get a |
| 811 | new random offset without looking at past io history. This |
| 812 | means that some blocks may not be read or written, and that |
| 813 | some blocks may be read/written more than once. This option |
Jens Axboe | 8347239 | 2009-02-19 21:32:12 +0100 | [diff] [blame] | 814 | is mutually exclusive with verify= if and only if multiple |
| 815 | blocksizes (via bsrange=) are used, since fio only tracks |
| 816 | complete rewrites of blocks. |
Jens Axboe | bb8895e | 2006-10-30 15:14:48 +0100 | [diff] [blame] | 817 | |
Jens Axboe | 0408c20 | 2011-08-08 09:07:28 +0200 | [diff] [blame] | 818 | softrandommap=bool See norandommap. If fio runs with the random block map |
| 819 | enabled and it fails to allocate the map, if this option is |
| 820 | set it will continue without a random block map. As coverage |
| 821 | will not be as complete as with random maps, this option is |
Jens Axboe | 2b386d2 | 2008-03-26 10:32:57 +0100 | [diff] [blame] | 822 | disabled by default. |
| 823 | |
Jens Axboe | e8b1961 | 2012-12-05 10:28:08 +0100 | [diff] [blame] | 824 | random_generator=str Fio supports the following engines for generating |
| 825 | IO offsets for random IO: |
| 826 | |
| 827 | tausworthe Strong 2^88 cycle random number generator |
| 828 | lfsr Linear feedback shift register generator |
| 829 | |
| 830 | Tausworthe is a strong random number generator, but it |
| 831 | requires tracking on the side if we want to ensure that |
| 832 | blocks are only read or written once. LFSR guarantees |
| 833 | that we never generate the same offset twice, and it's |
| 834 | also less computationally expensive. It's not a true |
| 835 | random generator, however, though for IO purposes it's |
| 836 | typically good enough. LFSR only works with single |
| 837 | block sizes, not with workloads that use multiple block |
| 838 | sizes. If used with such a workload, fio may read or write |
| 839 | some blocks multiple times. |
Bruce Cran | 43f09da | 2013-02-24 11:09:11 +0000 | [diff] [blame] | 840 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 841 | nice=int Run the job with the given nice value. See man nice(2). |
| 842 | |
| 843 | prio=int Set the io priority value of this job. Linux limits us to |
| 844 | a positive value between 0 and 7, with 0 being the highest. |
| 845 | See man ionice(1). |
| 846 | |
| 847 | prioclass=int Set the io priority class. See man ionice(1). |
| 848 | |
| 849 | thinktime=int Stall the job x microseconds after an io has completed before |
| 850 | issuing the next. May be used to simulate processing being |
Jens Axboe | 48097d5 | 2007-02-17 06:30:44 +0100 | [diff] [blame] | 851 | done by an application. See thinktime_blocks and |
| 852 | thinktime_spin. |
| 853 | |
| 854 | thinktime_spin=int |
| 855 | Only valid if thinktime is set - pretend to spend CPU time |
| 856 | doing something with the data received, before falling back |
| 857 | to sleeping for the rest of the period specified by |
| 858 | thinktime. |
Jens Axboe | 9c1f743 | 2007-01-03 20:43:19 +0100 | [diff] [blame] | 859 | |
Jens Axboe | 4d01ece | 2013-05-17 12:47:11 +0200 | [diff] [blame] | 860 | thinktime_blocks=int |
Jens Axboe | 9c1f743 | 2007-01-03 20:43:19 +0100 | [diff] [blame] | 861 | Only valid if thinktime is set - control how many blocks |
| 862 | to issue, before waiting 'thinktime' usecs. If not set, |
| 863 | defaults to 1 which will make fio wait 'thinktime' usecs |
Jens Axboe | 4d01ece | 2013-05-17 12:47:11 +0200 | [diff] [blame] | 864 | after every block. This effectively makes any queue depth |
| 865 | setting redundant, since no more than 1 IO will be queued |
| 866 | before we have to complete it and do our thinktime. In |
| 867 | other words, this setting effectively caps the queue depth |
| 868 | if the latter is larger. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 869 | |
Jens Axboe | 581e714 | 2009-06-09 12:47:16 +0200 | [diff] [blame] | 870 | rate=int Cap the bandwidth used by this job. The number is in bytes/sec, |
Jens Axboe | b09da8f | 2009-07-17 23:16:17 +0200 | [diff] [blame] | 871 | the normal suffix rules apply. You can use rate=500k to limit |
Jens Axboe | 581e714 | 2009-06-09 12:47:16 +0200 | [diff] [blame] | 872 | reads and writes to 500k each, or you can specify read and |
| 873 | writes separately. Using rate=1m,500k would limit reads to |
| 874 | 1MB/sec and writes to 500KB/sec. Capping only reads or |
| 875 | writes can be done with rate=,500k or rate=500k,. The former |
| 876 | will only limit writes (to 500KB/sec), the latter will only |
| 877 | limit reads. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 878 | |
| 879 | 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] | 880 | bandwidth. Failing to meet this requirement, will cause |
Jens Axboe | 581e714 | 2009-06-09 12:47:16 +0200 | [diff] [blame] | 881 | the job to exit. The same format as rate is used for |
| 882 | read vs write separation. |
Jens Axboe | 4e991c2 | 2007-03-15 11:41:11 +0100 | [diff] [blame] | 883 | |
| 884 | rate_iops=int Cap the bandwidth to this number of IOPS. Basically the same |
| 885 | as rate, just specified independently of bandwidth. If the |
| 886 | job is given a block size range instead of a fixed value, |
Jens Axboe | 581e714 | 2009-06-09 12:47:16 +0200 | [diff] [blame] | 887 | the smallest block size is used as the metric. The same format |
Anatol Pomozov | de8f6de | 2013-09-26 16:31:34 -0700 | [diff] [blame] | 888 | as rate is used for read vs write separation. |
Jens Axboe | 4e991c2 | 2007-03-15 11:41:11 +0100 | [diff] [blame] | 889 | |
| 890 | rate_iops_min=int If fio doesn't meet this rate of IO, it will cause |
Jens Axboe | 581e714 | 2009-06-09 12:47:16 +0200 | [diff] [blame] | 891 | the job to exit. The same format as rate is used for read vs |
Anatol Pomozov | de8f6de | 2013-09-26 16:31:34 -0700 | [diff] [blame] | 892 | write separation. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 893 | |
Jens Axboe | 3e260a4 | 2013-12-09 12:38:53 -0700 | [diff] [blame] | 894 | latency_target=int If set, fio will attempt to find the max performance |
| 895 | point that the given workload will run at while maintaining a |
| 896 | latency below this target. The values is given in microseconds. |
| 897 | See latency_window and latency_percentile |
| 898 | |
| 899 | latency_window=int Used with latency_target to specify the sample window |
| 900 | that the job is run at varying queue depths to test the |
| 901 | performance. The value is given in microseconds. |
| 902 | |
| 903 | latency_percentile=float The percentage of IOs that must fall within the |
| 904 | criteria specified by latency_target and latency_window. If not |
| 905 | set, this defaults to 100.0, meaning that all IOs must be equal |
| 906 | or below to the value set by latency_target. |
| 907 | |
Jens Axboe | 1550153 | 2012-10-24 16:37:45 +0200 | [diff] [blame] | 908 | max_latency=int If set, fio will exit the job if it exceeds this maximum |
| 909 | latency. It will exit with an ETIME error. |
| 910 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 911 | ratecycle=int Average bandwidth for 'rate' and 'ratemin' over this number |
Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 912 | of milliseconds. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 913 | |
| 914 | 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] | 915 | bitmask of allowed CPU's the job may run on. So if you want |
| 916 | the allowed CPUs to be 1 and 5, you would pass the decimal |
| 917 | value of (1 << 1 | 1 << 5), or 34. See man |
Jens Axboe | 7dbb6eb | 2007-05-22 09:13:31 +0200 | [diff] [blame] | 918 | sched_setaffinity(2). This may not work on all supported |
Jens Axboe | b0ea08c | 2008-12-05 12:57:11 +0100 | [diff] [blame] | 919 | operating systems or kernel versions. This option doesn't |
| 920 | work well for a higher CPU count than what you can store in |
| 921 | an integer mask, so it can only control cpus 1-32. For |
| 922 | boxes with larger CPU counts, use cpus_allowed. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 923 | |
Jens Axboe | d2e268b | 2007-06-15 10:33:49 +0200 | [diff] [blame] | 924 | cpus_allowed=str Controls the same options as cpumask, but it allows a text |
| 925 | setting of the permitted CPUs instead. So to use CPUs 1 and |
Jens Axboe | 62a7273 | 2008-12-08 11:37:01 +0100 | [diff] [blame] | 926 | 5, you would specify cpus_allowed=1,5. This options also |
| 927 | allows a range of CPUs. Say you wanted a binding to CPUs |
| 928 | 1, 5, and 8-15, you would set cpus_allowed=1,5,8-15. |
Jens Axboe | d2e268b | 2007-06-15 10:33:49 +0200 | [diff] [blame] | 929 | |
Yufei Ren | d0b937e | 2012-10-19 23:11:52 -0400 | [diff] [blame] | 930 | numa_cpu_nodes=str Set this job running on spcified NUMA nodes' CPUs. The |
| 931 | arguments allow comma delimited list of cpu numbers, |
| 932 | A-B ranges, or 'all'. Note, to enable numa options support, |
Jens Axboe | 67bf982 | 2013-01-10 11:23:19 +0100 | [diff] [blame] | 933 | fio must be built on a system with libnuma-dev(el) installed. |
Yufei Ren | d0b937e | 2012-10-19 23:11:52 -0400 | [diff] [blame] | 934 | |
| 935 | numa_mem_policy=str Set this job's memory policy and corresponding NUMA |
| 936 | nodes. Format of the argements: |
| 937 | <mode>[:<nodelist>] |
| 938 | `mode' is one of the following memory policy: |
| 939 | default, prefer, bind, interleave, local |
| 940 | For `default' and `local' memory policy, no node is |
| 941 | needed to be specified. |
| 942 | For `prefer', only one node is allowed. |
| 943 | For `bind' and `interleave', it allow comma delimited |
| 944 | list of numbers, A-B ranges, or 'all'. |
| 945 | |
Jens Axboe | e417fd6 | 2008-09-11 09:27:15 +0200 | [diff] [blame] | 946 | startdelay=time Start this job the specified number of seconds after fio |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 947 | has started. Only useful if the job file contains several |
| 948 | jobs, and you want to delay starting some jobs to a certain |
| 949 | time. |
| 950 | |
Jens Axboe | e417fd6 | 2008-09-11 09:27:15 +0200 | [diff] [blame] | 951 | runtime=time Tell fio to terminate processing after the specified number |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 952 | of seconds. It can be quite hard to determine for how long |
| 953 | a specified job will run, so this parameter is handy to |
| 954 | cap the total runtime to a given time. |
| 955 | |
Jens Axboe | cf4464c | 2007-04-17 20:14:42 +0200 | [diff] [blame] | 956 | time_based If set, fio will run for the duration of the runtime |
Jens Axboe | bf9a3ed | 2008-06-05 11:53:08 +0200 | [diff] [blame] | 957 | specified even if the file(s) are completely read or |
Jens Axboe | cf4464c | 2007-04-17 20:14:42 +0200 | [diff] [blame] | 958 | written. It will simply loop over the same workload |
| 959 | as many times as the runtime allows. |
| 960 | |
Jens Axboe | e417fd6 | 2008-09-11 09:27:15 +0200 | [diff] [blame] | 961 | ramp_time=time If set, fio will run the specified workload for this amount |
Jens Axboe | 721938a | 2008-09-10 09:46:16 +0200 | [diff] [blame] | 962 | of time before logging any performance numbers. Useful for |
| 963 | letting performance settle before logging results, thus |
Jens Axboe | b29ee5b | 2008-09-11 10:17:26 +0200 | [diff] [blame] | 964 | minimizing the runtime required for stable results. Note |
| 965 | that the ramp_time is considered lead in time for a job, |
| 966 | thus it will increase the total runtime if a special timeout |
| 967 | or runtime is specified. |
Jens Axboe | 721938a | 2008-09-10 09:46:16 +0200 | [diff] [blame] | 968 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 969 | invalidate=bool Invalidate the buffer/page cache parts for this file prior |
| 970 | to starting io. Defaults to true. |
| 971 | |
| 972 | sync=bool Use sync io for buffered writes. For the majority of the |
| 973 | io engines, this means using O_SYNC. |
| 974 | |
Jens Axboe | d3aad8f | 2007-03-15 14:12:05 +0100 | [diff] [blame] | 975 | iomem=str |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 976 | mem=str Fio can use various types of memory as the io unit buffer. |
| 977 | The allowed values are: |
| 978 | |
| 979 | malloc Use memory from malloc(3) as the buffers. |
| 980 | |
| 981 | shm Use shared memory as the buffers. Allocated |
| 982 | through shmget(2). |
| 983 | |
Jens Axboe | 74b025b | 2006-12-19 15:18:14 +0100 | [diff] [blame] | 984 | shmhuge Same as shm, but use huge pages as backing. |
| 985 | |
Jens Axboe | 313cb20 | 2006-12-21 09:50:00 +0100 | [diff] [blame] | 986 | mmap Use mmap to allocate buffers. May either be |
| 987 | anonymous memory, or can be file backed if |
| 988 | a filename is given after the option. The |
| 989 | format is mem=mmap:/path/to/file. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 990 | |
Jens Axboe | d0bdaf4 | 2006-12-20 14:40:44 +0100 | [diff] [blame] | 991 | mmaphuge Use a memory mapped huge file as the buffer |
| 992 | backing. Append filename after mmaphuge, ala |
| 993 | mem=mmaphuge:/hugetlbfs/file |
| 994 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 995 | The area allocated is a function of the maximum allowed |
Jens Axboe | 5394ae5 | 2006-12-20 20:15:41 +0100 | [diff] [blame] | 996 | bs size for the job, multiplied by the io depth given. Note |
| 997 | that for shmhuge and mmaphuge to work, the system must have |
| 998 | free huge pages allocated. This can normally be checked |
| 999 | and set by reading/writing /proc/sys/vm/nr_hugepages on a |
Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 1000 | Linux system. Fio assumes a huge page is 4MB in size. So |
Jens Axboe | 5394ae5 | 2006-12-20 20:15:41 +0100 | [diff] [blame] | 1001 | to calculate the number of huge pages you need for a given |
| 1002 | job file, add up the io depth of all jobs (normally one unless |
| 1003 | iodepth= is used) and multiply by the maximum bs set. Then |
| 1004 | divide that number by the huge page size. You can see the |
| 1005 | size of the huge pages in /proc/meminfo. If no huge pages |
| 1006 | are allocated by having a non-zero number in nr_hugepages, |
Jens Axboe | 56bb17f | 2006-12-20 20:27:36 +0100 | [diff] [blame] | 1007 | using mmaphuge or shmhuge will fail. Also see hugepage-size. |
Jens Axboe | 5394ae5 | 2006-12-20 20:15:41 +0100 | [diff] [blame] | 1008 | |
| 1009 | mmaphuge also needs to have hugetlbfs mounted and the file |
| 1010 | location should point there. So if it's mounted in /huge, |
| 1011 | you would use mem=mmaphuge:/huge/somefile. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1012 | |
Jens Axboe | d529ee1 | 2009-07-01 10:33:03 +0200 | [diff] [blame] | 1013 | iomem_align=int This indiciates the memory alignment of the IO memory buffers. |
| 1014 | Note that the given alignment is applied to the first IO unit |
| 1015 | buffer, if using iodepth the alignment of the following buffers |
| 1016 | are given by the bs used. In other words, if using a bs that is |
| 1017 | a multiple of the page sized in the system, all buffers will |
| 1018 | be aligned to this value. If using a bs that is not page |
| 1019 | aligned, the alignment of subsequent IO memory buffers is the |
| 1020 | sum of the iomem_align and bs used. |
| 1021 | |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 1022 | hugepage-size=int |
Jens Axboe | 56bb17f | 2006-12-20 20:27:36 +0100 | [diff] [blame] | 1023 | Defines the size of a huge page. Must at least be equal |
Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 1024 | to the system setting, see /proc/meminfo. Defaults to 4MB. |
Jens Axboe | c51074e | 2006-12-20 20:28:33 +0100 | [diff] [blame] | 1025 | Should probably always be a multiple of megabytes, so using |
| 1026 | hugepage-size=Xm is the preferred way to set this to avoid |
| 1027 | setting a non-pow-2 bad value. |
Jens Axboe | 56bb17f | 2006-12-20 20:27:36 +0100 | [diff] [blame] | 1028 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1029 | exitall When one job finishes, terminate the rest. The default is |
| 1030 | to wait for each job to finish, sometimes that is not the |
| 1031 | desired action. |
| 1032 | |
| 1033 | bwavgtime=int Average the calculated bandwidth over the given time. Value |
Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 1034 | is specified in milliseconds. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1035 | |
Jens Axboe | c8eeb9d | 2011-10-05 14:02:22 +0200 | [diff] [blame] | 1036 | iopsavgtime=int Average the calculated IOPS over the given time. Value |
| 1037 | is specified in milliseconds. |
| 1038 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1039 | create_serialize=bool If true, serialize the file creating for the jobs. |
| 1040 | This may be handy to avoid interleaving of data |
| 1041 | files, which may greatly depend on the filesystem |
| 1042 | used and even the number of processors in the system. |
| 1043 | |
| 1044 | create_fsync=bool fsync the data file after creation. This is the |
| 1045 | default. |
| 1046 | |
Jens Axboe | 814452b | 2009-03-04 12:53:13 +0100 | [diff] [blame] | 1047 | create_on_open=bool Don't pre-setup the files for IO, just create open() |
| 1048 | when it's time to do IO to that file. |
| 1049 | |
Jens Axboe | 25460cf | 2012-05-02 13:58:02 +0200 | [diff] [blame] | 1050 | create_only=bool If true, fio will only run the setup phase of the job. |
| 1051 | If files need to be laid out or updated on disk, only |
| 1052 | that will be done. The actual job contents are not |
| 1053 | executed. |
| 1054 | |
Zhang, Yanmin | afad68f | 2009-05-20 11:30:55 +0200 | [diff] [blame] | 1055 | pre_read=bool If this is given, files will be pre-read into memory before |
Jens Axboe | 34f1c04 | 2009-06-02 14:19:25 +0200 | [diff] [blame] | 1056 | starting the given IO operation. This will also clear |
| 1057 | the 'invalidate' flag, since it is pointless to pre-read |
Jens Axboe | 9c0d224 | 2009-07-01 12:26:28 +0200 | [diff] [blame] | 1058 | and then drop the cache. This will only work for IO engines |
| 1059 | that are seekable, since they allow you to read the same data |
| 1060 | multiple times. Thus it will not work on eg network or splice |
| 1061 | IO. |
Zhang, Yanmin | afad68f | 2009-05-20 11:30:55 +0200 | [diff] [blame] | 1062 | |
Jens Axboe | e545a6c | 2007-01-14 00:00:29 +0100 | [diff] [blame] | 1063 | unlink=bool Unlink the job files when done. Not the default, as repeated |
Jens Axboe | bf9a3ed | 2008-06-05 11:53:08 +0200 | [diff] [blame] | 1064 | runs of that job would then waste time recreating the file |
| 1065 | set again and again. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1066 | |
| 1067 | loops=int Run the specified number of iterations of this job. Used |
| 1068 | to repeat the same workload a given number of times. Defaults |
| 1069 | to 1. |
| 1070 | |
Juan Casse | 6216776 | 2013-09-17 14:06:13 -0700 | [diff] [blame] | 1071 | verify_only Do not perform specified workload---only verify data still |
| 1072 | matches previous invocation of this workload. This option |
| 1073 | allows one to check data multiple times at a later date |
| 1074 | without overwriting it. This option makes sense only for |
| 1075 | workloads that write data, and does not support workloads |
| 1076 | with the time_based option set. |
| 1077 | |
Jens Axboe | 68e1f29 | 2007-08-10 10:32:14 +0200 | [diff] [blame] | 1078 | 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] | 1079 | verify is set. Defaults to 1. |
| 1080 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1081 | verify=str If writing to a file, fio can verify the file contents |
| 1082 | after each iteration of the job. The allowed values are: |
| 1083 | |
| 1084 | md5 Use an md5 sum of the data area and store |
| 1085 | it in the header of each block. |
| 1086 | |
Jens Axboe | 17dc34d | 2007-07-27 15:36:02 +0200 | [diff] [blame] | 1087 | crc64 Use an experimental crc64 sum of the data |
| 1088 | area and store it in the header of each |
| 1089 | block. |
| 1090 | |
Jens Axboe | bac39e0 | 2008-06-11 20:46:19 +0200 | [diff] [blame] | 1091 | crc32c Use a crc32c sum of the data area and store |
| 1092 | it in the header of each block. |
| 1093 | |
Jens Axboe | 3845591 | 2008-08-04 15:35:26 +0200 | [diff] [blame] | 1094 | crc32c-intel Use hardware assisted crc32c calcuation |
Jens Axboe | 0539d75 | 2010-06-21 15:22:56 +0200 | [diff] [blame] | 1095 | provided on SSE4.2 enabled processors. Falls |
| 1096 | back to regular software crc32c, if not |
| 1097 | supported by the system. |
Jens Axboe | 3845591 | 2008-08-04 15:35:26 +0200 | [diff] [blame] | 1098 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1099 | crc32 Use a crc32 sum of the data area and store |
| 1100 | it in the header of each block. |
| 1101 | |
Jens Axboe | 969f7ed | 2007-07-27 09:07:17 +0200 | [diff] [blame] | 1102 | crc16 Use a crc16 sum of the data area and store |
| 1103 | it in the header of each block. |
| 1104 | |
Jens Axboe | 17dc34d | 2007-07-27 15:36:02 +0200 | [diff] [blame] | 1105 | crc7 Use a crc7 sum of the data area and store |
| 1106 | it in the header of each block. |
| 1107 | |
Jens Axboe | cd14cc1 | 2007-07-30 10:59:33 +0200 | [diff] [blame] | 1108 | sha512 Use sha512 as the checksum function. |
| 1109 | |
| 1110 | sha256 Use sha256 as the checksum function. |
| 1111 | |
Jens Axboe | 7c353ce | 2009-08-09 22:40:33 +0200 | [diff] [blame] | 1112 | sha1 Use optimized sha1 as the checksum function. |
| 1113 | |
Shawn Lewis | 7437ee8 | 2007-08-02 21:05:58 +0200 | [diff] [blame] | 1114 | meta Write extra information about each io |
| 1115 | (timestamp, block number etc.). The block |
Juan Casse | 6216776 | 2013-09-17 14:06:13 -0700 | [diff] [blame] | 1116 | number is verified. The io sequence number is |
| 1117 | verified for workloads that write data. |
| 1118 | See also verify_pattern. |
Shawn Lewis | 7437ee8 | 2007-08-02 21:05:58 +0200 | [diff] [blame] | 1119 | |
Jens Axboe | 36690c9 | 2007-03-26 10:23:34 +0200 | [diff] [blame] | 1120 | null Only pretend to verify. Useful for testing |
| 1121 | internals with ioengine=null, not for much |
| 1122 | else. |
| 1123 | |
Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 1124 | This option can be used for repeated burn-in tests of a |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1125 | system to make sure that the written data is also |
Jens Axboe | b892dc0 | 2009-09-05 20:37:35 +0200 | [diff] [blame] | 1126 | correctly read back. If the data direction given is |
| 1127 | a read or random read, fio will assume that it should |
| 1128 | verify a previously written file. If the data direction |
| 1129 | includes any form of write, the verify will be of the |
| 1130 | newly written data. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1131 | |
Jens Axboe | 160b966 | 2007-03-27 10:59:49 +0200 | [diff] [blame] | 1132 | verifysort=bool If set, fio will sort written verify blocks when it deems |
| 1133 | it faster to read them back in a sorted manner. This is |
| 1134 | often the case when overwriting an existing file, since |
| 1135 | the blocks are already laid out in the file system. You |
| 1136 | can ignore this option unless doing huge amounts of really |
| 1137 | fast IO where the red-black tree sorting CPU time becomes |
| 1138 | significant. |
Shawn Lewis | 3f9f4e2 | 2007-07-28 21:10:37 +0200 | [diff] [blame] | 1139 | |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 1140 | verify_offset=int Swap the verification header with data somewhere else |
Shawn Lewis | 546a914 | 2007-07-28 21:11:37 +0200 | [diff] [blame] | 1141 | in the block before writing. Its swapped back before |
| 1142 | verifying. |
| 1143 | |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 1144 | verify_interval=int Write the verification header at a finer granularity |
Shawn Lewis | 3f9f4e2 | 2007-07-28 21:10:37 +0200 | [diff] [blame] | 1145 | than the blocksize. It will be written for chunks the |
| 1146 | size of header_interval. blocksize should divide this |
| 1147 | evenly. |
Jens Axboe | 90059d6 | 2007-07-30 09:33:12 +0200 | [diff] [blame] | 1148 | |
Radha Ramachandran | 0e92f87 | 2009-10-27 20:14:27 +0100 | [diff] [blame] | 1149 | verify_pattern=str If set, fio will fill the io buffers with this |
Shawn Lewis | e28218f | 2008-01-16 11:01:33 +0100 | [diff] [blame] | 1150 | pattern. Fio defaults to filling with totally random |
| 1151 | bytes, but sometimes it's interesting to fill with a known |
| 1152 | pattern for io verification purposes. Depending on the |
| 1153 | width of the pattern, fio will fill 1/2/3/4 bytes of the |
Radha Ramachandran | 0e92f87 | 2009-10-27 20:14:27 +0100 | [diff] [blame] | 1154 | buffer at the time(it can be either a decimal or a hex number). |
| 1155 | The verify_pattern if larger than a 32-bit quantity has to |
Jens Axboe | 996093b | 2010-06-24 08:37:13 +0200 | [diff] [blame] | 1156 | be a hex number that starts with either "0x" or "0X". Use |
| 1157 | with verify=meta. |
Shawn Lewis | e28218f | 2008-01-16 11:01:33 +0100 | [diff] [blame] | 1158 | |
Jens Axboe | 68e1f29 | 2007-08-10 10:32:14 +0200 | [diff] [blame] | 1159 | verify_fatal=bool Normally fio will keep checking the entire contents |
Jens Axboe | a12a3b4 | 2007-08-09 10:20:54 +0200 | [diff] [blame] | 1160 | before quitting on a block verification failure. If this |
| 1161 | option is set, fio will exit the job on the first observed |
| 1162 | failure. |
Jens Axboe | e8462bd | 2009-07-06 12:59:04 +0200 | [diff] [blame] | 1163 | |
Jens Axboe | b463e93 | 2011-01-12 09:03:23 +0100 | [diff] [blame] | 1164 | verify_dump=bool If set, dump the contents of both the original data |
| 1165 | block and the data block we read off disk to files. This |
| 1166 | allows later analysis to inspect just what kind of data |
Jens Axboe | ef71e31 | 2011-10-25 22:43:36 +0200 | [diff] [blame] | 1167 | corruption occurred. Off by default. |
Jens Axboe | b463e93 | 2011-01-12 09:03:23 +0100 | [diff] [blame] | 1168 | |
Jens Axboe | e8462bd | 2009-07-06 12:59:04 +0200 | [diff] [blame] | 1169 | verify_async=int Fio will normally verify IO inline from the submitting |
| 1170 | thread. This option takes an integer describing how many |
| 1171 | async offload threads to create for IO verification instead, |
| 1172 | causing fio to offload the duty of verifying IO contents |
Jens Axboe | c85c324 | 2009-07-06 14:12:57 +0200 | [diff] [blame] | 1173 | to one or more separate threads. If using this offload |
| 1174 | option, even sync IO engines can benefit from using an |
| 1175 | iodepth setting higher than 1, as it allows them to have |
| 1176 | IO in flight while verifies are running. |
Jens Axboe | e8462bd | 2009-07-06 12:59:04 +0200 | [diff] [blame] | 1177 | |
| 1178 | verify_async_cpus=str Tell fio to set the given CPU affinity on the |
| 1179 | async IO verification threads. See cpus_allowed for the |
| 1180 | format used. |
Jens Axboe | 6f87418 | 2010-06-21 12:53:26 +0200 | [diff] [blame] | 1181 | |
| 1182 | verify_backlog=int Fio will normally verify the written contents of a |
| 1183 | job that utilizes verify once that job has completed. In |
| 1184 | other words, everything is written then everything is read |
| 1185 | back and verified. You may want to verify continually |
| 1186 | instead for a variety of reasons. Fio stores the meta data |
| 1187 | associated with an IO block in memory, so for large |
| 1188 | verify workloads, quite a bit of memory would be used up |
| 1189 | holding this meta data. If this option is enabled, fio |
Jens Axboe | f42195a | 2010-10-26 08:10:58 -0600 | [diff] [blame] | 1190 | will write only N blocks before verifying these blocks. |
| 1191 | |
Jens Axboe | 6f87418 | 2010-06-21 12:53:26 +0200 | [diff] [blame] | 1192 | verify_backlog_batch=int Control how many blocks fio will verify |
| 1193 | if verify_backlog is set. If not set, will default to |
| 1194 | the value of verify_backlog (meaning the entire queue |
Jens Axboe | f42195a | 2010-10-26 08:10:58 -0600 | [diff] [blame] | 1195 | is read back and verified). If verify_backlog_batch is |
| 1196 | less than verify_backlog then not all blocks will be verified, |
| 1197 | if verify_backlog_batch is larger than verify_backlog, some |
| 1198 | blocks will be verified more than once. |
Bruce Cran | 66c098b | 2012-11-27 12:16:07 +0000 | [diff] [blame] | 1199 | |
Jens Axboe | d392365 | 2011-08-03 12:38:39 +0200 | [diff] [blame] | 1200 | stonewall |
Anatol Pomozov | de8f6de | 2013-09-26 16:31:34 -0700 | [diff] [blame] | 1201 | wait_for_previous Wait for preceding jobs in the job file to exit, before |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1202 | starting this one. Can be used to insert serialization |
Jens Axboe | b3d62a7 | 2007-03-20 14:23:26 +0100 | [diff] [blame] | 1203 | points in the job file. A stone wall also implies starting |
| 1204 | a new reporting group. |
| 1205 | |
Akash Verma | abcab6a | 2012-10-04 15:58:28 -0700 | [diff] [blame] | 1206 | new_group Start a new reporting group. See: group_reporting. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1207 | |
| 1208 | numjobs=int Create the specified number of clones of this job. May be |
| 1209 | used to setup a larger number of threads/processes doing |
Akash Verma | abcab6a | 2012-10-04 15:58:28 -0700 | [diff] [blame] | 1210 | the same thing. Each thread is reported separately; to see |
| 1211 | statistics for all clones as a whole, use group_reporting in |
| 1212 | conjunction with new_group. |
Jens Axboe | fa28c85 | 2007-03-06 15:40:49 +0100 | [diff] [blame] | 1213 | |
Akash Verma | abcab6a | 2012-10-04 15:58:28 -0700 | [diff] [blame] | 1214 | group_reporting It may sometimes be interesting to display statistics for |
Jens Axboe | 04b2f79 | 2012-10-10 09:09:59 -0600 | [diff] [blame] | 1215 | groups of jobs as a whole instead of for each individual job. |
| 1216 | This is especially true if 'numjobs' is used; looking at |
| 1217 | individual thread/process output quickly becomes unwieldy. |
| 1218 | To see the final report per-group instead of per-job, use |
| 1219 | 'group_reporting'. Jobs in a file will be part of the same |
| 1220 | reporting group, unless if separated by a stonewall, or by |
| 1221 | using 'new_group'. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1222 | |
| 1223 | thread fio defaults to forking jobs, however if this option is |
| 1224 | given, fio will use pthread_create(3) to create threads |
| 1225 | instead. |
| 1226 | |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 1227 | zonesize=int Divide a file into zones of the specified size. See zoneskip. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1228 | |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 1229 | zoneskip=int Skip the specified number of bytes when zonesize data has |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1230 | been read. The two zone options can be used to only do |
| 1231 | io on zones of a file. |
| 1232 | |
Jens Axboe | 076efc7 | 2006-10-27 11:24:25 +0200 | [diff] [blame] | 1233 | write_iolog=str Write the issued io patterns to the specified file. See |
Stefan Hajnoczi | 5b42a48 | 2011-01-08 20:28:41 +0100 | [diff] [blame] | 1234 | read_iolog. Specify a separate file for each job, otherwise |
| 1235 | the iologs will be interspersed and the file may be corrupt. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1236 | |
Jens Axboe | 076efc7 | 2006-10-27 11:24:25 +0200 | [diff] [blame] | 1237 | 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] | 1238 | io patterns it contains. This can be used to store a |
Jens Axboe | 6df8ada | 2007-05-15 13:23:19 +0200 | [diff] [blame] | 1239 | workload and replay it sometime later. The iolog given |
| 1240 | may also be a blktrace binary file, which allows fio |
| 1241 | to replay a workload captured by blktrace. See blktrace |
| 1242 | for how to capture such logging data. For blktrace replay, |
| 1243 | the file needs to be turned into a blkparse binary data |
Jens Axboe | ea3e51c | 2010-05-17 19:51:45 +0200 | [diff] [blame] | 1244 | file first (blkparse <device> -o /dev/null -d file_for_fio.bin). |
Bruce Cran | 66c098b | 2012-11-27 12:16:07 +0000 | [diff] [blame] | 1245 | |
David Nellans | 64bbb86 | 2010-08-24 22:13:30 +0200 | [diff] [blame] | 1246 | replay_no_stall=int When replaying I/O with read_iolog the default behavior |
Jens Axboe | 6277622 | 2010-09-02 15:30:16 +0200 | [diff] [blame] | 1247 | is to attempt to respect the time stamps within the log and |
| 1248 | replay them with the appropriate delay between IOPS. By |
| 1249 | setting this variable fio will not respect the timestamps and |
| 1250 | attempt to replay them as fast as possible while still |
| 1251 | respecting ordering. The result is the same I/O pattern to a |
| 1252 | given device, but different timings. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1253 | |
David Nellans | d1c46c0 | 2010-08-31 21:20:47 +0200 | [diff] [blame] | 1254 | replay_redirect=str While replaying I/O patterns using read_iolog the |
| 1255 | default behavior is to replay the IOPS onto the major/minor |
| 1256 | device that each IOP was recorded from. This is sometimes |
Anatol Pomozov | de8f6de | 2013-09-26 16:31:34 -0700 | [diff] [blame] | 1257 | undesirable because on a different machine those major/minor |
David Nellans | d1c46c0 | 2010-08-31 21:20:47 +0200 | [diff] [blame] | 1258 | numbers can map to a different device. Changing hardware on |
| 1259 | the same system can also result in a different major/minor |
| 1260 | mapping. Replay_redirect causes all IOPS to be replayed onto |
| 1261 | the single specified device regardless of the device it was |
| 1262 | recorded from. i.e. replay_redirect=/dev/sdc would cause all |
| 1263 | IO in the blktrace to be replayed onto /dev/sdc. This means |
| 1264 | multiple devices will be replayed onto a single, if the trace |
| 1265 | contains multiple devices. If you want multiple devices to be |
| 1266 | replayed concurrently to multiple redirected devices you must |
| 1267 | blkparse your trace into separate traces and replay them with |
| 1268 | independent fio invocations. Unfortuantely this also breaks |
| 1269 | the strict time ordering between multiple device accesses. |
| 1270 | |
Jens Axboe | e3cedca | 2008-11-19 19:57:52 +0100 | [diff] [blame] | 1271 | write_bw_log=str If given, write a bandwidth log of the jobs in this job |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1272 | file. Can be used to store data of the bandwidth of the |
Jens Axboe | e0da9bc | 2006-10-25 13:08:57 +0200 | [diff] [blame] | 1273 | jobs in their lifetime. The included fio_generate_plots |
| 1274 | script uses gnuplot to turn these text files into nice |
Lucian Adrian Grijincu | ddb754d | 2012-04-05 18:18:35 -0600 | [diff] [blame] | 1275 | graphs. See write_lat_log for behaviour of given |
| 1276 | filename. For this option, the suffix is _bw.log. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1277 | |
Jens Axboe | e3cedca | 2008-11-19 19:57:52 +0100 | [diff] [blame] | 1278 | write_lat_log=str Same as write_bw_log, except that this option stores io |
Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1279 | submission, completion, and total latencies instead. If no |
| 1280 | filename is given with this option, the default filename of |
| 1281 | "jobname_type.log" is used. Even if the filename is given, |
| 1282 | fio will still append the type of log. So if one specifies |
Jens Axboe | e3cedca | 2008-11-19 19:57:52 +0100 | [diff] [blame] | 1283 | |
| 1284 | write_lat_log=foo |
| 1285 | |
Jens Axboe | d5d9459 | 2013-05-09 21:10:58 +0200 | [diff] [blame] | 1286 | The actual log names will be foo_slat.log, foo_clat.log, |
Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1287 | and foo_lat.log. This helps fio_generate_plot fine the logs |
| 1288 | automatically. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1289 | |
Jens Axboe | b8bc8cb | 2011-12-01 09:04:31 +0100 | [diff] [blame] | 1290 | write_iops_log=str Same as write_bw_log, but writes IOPS. If no filename is |
| 1291 | given with this option, the default filename of |
| 1292 | "jobname_type.log" is used. Even if the filename is given, |
| 1293 | fio will still append the type of log. |
| 1294 | |
| 1295 | log_avg_msec=int By default, fio will log an entry in the iops, latency, |
| 1296 | or bw log for every IO that completes. When writing to the |
| 1297 | disk log, that can quickly grow to a very large size. Setting |
| 1298 | this option makes fio average the each log entry over the |
| 1299 | specified period of time, reducing the resolution of the log. |
| 1300 | Defaults to 0. |
| 1301 | |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 1302 | lockmem=int Pin down the specified amount of memory with mlock(2). Can |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1303 | potentially be used instead of removing memory or booting |
| 1304 | with less memory to simulate a smaller amount of memory. |
Jens Axboe | 81c6b6c | 2013-04-10 19:30:50 +0200 | [diff] [blame] | 1305 | The amount specified is per worker. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1306 | |
| 1307 | exec_prerun=str Before running this job, issue the command specified |
Jens Axboe | 74c8c48 | 2013-07-17 22:15:09 -0600 | [diff] [blame] | 1308 | through system(3). Output is redirected in a file called |
| 1309 | jobname.prerun.txt. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1310 | |
| 1311 | exec_postrun=str After the job completes, issue the command specified |
Jens Axboe | 74c8c48 | 2013-07-17 22:15:09 -0600 | [diff] [blame] | 1312 | though system(3). Output is redirected in a file called |
| 1313 | jobname.postrun.txt. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1314 | |
| 1315 | ioscheduler=str Attempt to switch the device hosting the file to the specified |
| 1316 | io scheduler before running. |
| 1317 | |
Jens Axboe | 0a839f3 | 2007-04-26 09:02:34 +0200 | [diff] [blame] | 1318 | disk_util=bool Generate disk utilization statistics, if the platform |
| 1319 | supports it. Defaults to on. |
| 1320 | |
Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1321 | disable_lat=bool Disable measurements of total latency numbers. Useful |
Jens Axboe | 9520ebb | 2008-10-16 21:03:27 +0200 | [diff] [blame] | 1322 | only for cutting back the number of calls to gettimeofday, |
| 1323 | as that does impact performance at really high IOPS rates. |
| 1324 | Note that to really get rid of a large amount of these |
| 1325 | calls, this option must be used with disable_slat and |
| 1326 | disable_bw as well. |
| 1327 | |
Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1328 | disable_clat=bool Disable measurements of completion latency numbers. See |
| 1329 | disable_lat. |
| 1330 | |
Jens Axboe | 9520ebb | 2008-10-16 21:03:27 +0200 | [diff] [blame] | 1331 | disable_slat=bool Disable measurements of submission latency numbers. See |
Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1332 | disable_slat. |
Jens Axboe | 9520ebb | 2008-10-16 21:03:27 +0200 | [diff] [blame] | 1333 | |
| 1334 | disable_bw=bool Disable measurements of throughput/bandwidth numbers. See |
Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1335 | disable_lat. |
Jens Axboe | 9520ebb | 2008-10-16 21:03:27 +0200 | [diff] [blame] | 1336 | |
Yu-ju Hong | 8334919 | 2011-08-13 00:53:44 +0200 | [diff] [blame] | 1337 | clat_percentiles=bool Enable the reporting of percentiles of |
| 1338 | completion latencies. |
| 1339 | |
| 1340 | percentile_list=float_list Overwrite the default list of percentiles |
| 1341 | for completion latencies. Each number is a floating |
| 1342 | number in the range (0,100], and the maximum length of |
| 1343 | the list is 20. Use ':' to separate the numbers, and |
| 1344 | list the numbers in ascending order. For example, |
| 1345 | --percentile_list=99.5:99.9 will cause fio to report |
| 1346 | the values of completion latency below which 99.5% and |
| 1347 | 99.9% of the observed latencies fell, respectively. |
| 1348 | |
Jens Axboe | 2389364 | 2012-12-17 14:44:08 +0100 | [diff] [blame] | 1349 | clocksource=str Use the given clocksource as the base of timing. The |
| 1350 | supported options are: |
| 1351 | |
| 1352 | gettimeofday gettimeofday(2) |
| 1353 | |
| 1354 | clock_gettime clock_gettime(2) |
| 1355 | |
| 1356 | cpu Internal CPU clock source |
| 1357 | |
| 1358 | cpu is the preferred clocksource if it is reliable, as it |
| 1359 | is very fast (and fio is heavy on time calls). Fio will |
| 1360 | automatically use this clocksource if it's supported and |
| 1361 | considered reliable on the system it is running on, unless |
| 1362 | another clocksource is specifically set. For x86/x86-64 CPUs, |
| 1363 | this means supporting TSC Invariant. |
| 1364 | |
Jens Axboe | 993bf48 | 2008-11-14 13:04:53 +0100 | [diff] [blame] | 1365 | gtod_reduce=bool Enable all of the gettimeofday() reducing options |
| 1366 | (disable_clat, disable_slat, disable_bw) plus reduce |
| 1367 | precision of the timeout somewhat to really shrink |
| 1368 | the gettimeofday() call count. With this option enabled, |
| 1369 | we only do about 0.4% of the gtod() calls we would have |
| 1370 | done if all time keeping was enabled. |
| 1371 | |
Jens Axboe | be4ecfd | 2008-12-08 14:10:52 +0100 | [diff] [blame] | 1372 | gtod_cpu=int Sometimes it's cheaper to dedicate a single thread of |
| 1373 | execution to just getting the current time. Fio (and |
| 1374 | databases, for instance) are very intensive on gettimeofday() |
| 1375 | calls. With this option, you can set one CPU aside for |
| 1376 | doing nothing but logging current time to a shared memory |
| 1377 | location. Then the other threads/processes that run IO |
| 1378 | workloads need only copy that segment, instead of entering |
| 1379 | the kernel with a gettimeofday() call. The CPU set aside |
| 1380 | for doing these time calls will be excluded from other |
| 1381 | uses. Fio will manually clear it from the CPU mask of other |
| 1382 | jobs. |
Jens Axboe | a696fa2 | 2009-12-04 10:05:02 +0100 | [diff] [blame] | 1383 | |
Steven Lang | 0684202 | 2011-11-17 09:45:17 +0100 | [diff] [blame] | 1384 | continue_on_error=str Normally fio will exit the job on the first observed |
Radha Ramachandran | f2bba18 | 2009-06-15 08:40:16 +0200 | [diff] [blame] | 1385 | failure. If this option is set, fio will continue the job when |
| 1386 | there is a 'non-fatal error' (EIO or EILSEQ) until the runtime |
| 1387 | is exceeded or the I/O size specified is completed. If this |
| 1388 | option is used, there are two more stats that are appended, |
| 1389 | the total error count and the first error. The error field |
| 1390 | given in the stats is the first error that was hit during the |
| 1391 | run. |
Jens Axboe | be4ecfd | 2008-12-08 14:10:52 +0100 | [diff] [blame] | 1392 | |
Steven Lang | 0684202 | 2011-11-17 09:45:17 +0100 | [diff] [blame] | 1393 | The allowed values are: |
| 1394 | |
| 1395 | none Exit on any IO or verify errors. |
| 1396 | |
| 1397 | read Continue on read errors, exit on all others. |
| 1398 | |
| 1399 | write Continue on write errors, exit on all others. |
| 1400 | |
| 1401 | io Continue on any IO error, exit on all others. |
| 1402 | |
| 1403 | verify Continue on verify errors, exit on all others. |
| 1404 | |
| 1405 | all Continue on all errors. |
| 1406 | |
| 1407 | 0 Backward-compatible alias for 'none'. |
| 1408 | |
| 1409 | 1 Backward-compatible alias for 'all'. |
| 1410 | |
Dmitry Monakhov | 8b28bd4 | 2012-09-23 15:46:09 +0400 | [diff] [blame] | 1411 | ignore_error=str Sometimes you want to ignore some errors during test |
| 1412 | in that case you can specify error list for each error type. |
| 1413 | ignore_error=READ_ERR_LIST,WRITE_ERR_LIST,VERIFY_ERR_LIST |
| 1414 | errors for given error type is separated with ':'. Error |
| 1415 | may be symbol ('ENOSPC', 'ENOMEM') or integer. |
| 1416 | Example: |
| 1417 | ignore_error=EAGAIN,ENOSPC:122 |
Bruce Cran | 66c098b | 2012-11-27 12:16:07 +0000 | [diff] [blame] | 1418 | This option will ignore EAGAIN from READ, and ENOSPC and |
| 1419 | 122(EDQUOT) from WRITE. |
Dmitry Monakhov | 8b28bd4 | 2012-09-23 15:46:09 +0400 | [diff] [blame] | 1420 | |
| 1421 | error_dump=bool If set dump every error even if it is non fatal, true |
| 1422 | by default. If disabled only fatal error will be dumped |
Bruce Cran | 66c098b | 2012-11-27 12:16:07 +0000 | [diff] [blame] | 1423 | |
Jens Axboe | 6adb38a | 2009-12-07 08:01:26 +0100 | [diff] [blame] | 1424 | cgroup=str Add job to this control group. If it doesn't exist, it will |
| 1425 | be created. The system must have a mounted cgroup blkio |
| 1426 | mount point for this to work. If your system doesn't have it |
| 1427 | mounted, you can do so with: |
Jens Axboe | a696fa2 | 2009-12-04 10:05:02 +0100 | [diff] [blame] | 1428 | |
| 1429 | # mount -t cgroup -o blkio none /cgroup |
| 1430 | |
Jens Axboe | a696fa2 | 2009-12-04 10:05:02 +0100 | [diff] [blame] | 1431 | cgroup_weight=int Set the weight of the cgroup to this value. See |
| 1432 | the documentation that comes with the kernel, allowed values |
| 1433 | are in the range of 100..1000. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1434 | |
Vivek Goyal | 7de8709 | 2010-03-31 22:55:15 +0200 | [diff] [blame] | 1435 | cgroup_nodelete=bool Normally fio will delete the cgroups it has created after |
| 1436 | the job completion. To override this behavior and to leave |
| 1437 | cgroups around after the job completion, set cgroup_nodelete=1. |
| 1438 | This can be useful if one wants to inspect various cgroup |
| 1439 | files after job completion. Default: false |
| 1440 | |
Jens Axboe | e0b0d89 | 2009-12-08 10:10:14 +0100 | [diff] [blame] | 1441 | uid=int Instead of running as the invoking user, set the user ID to |
| 1442 | this value before the thread/process does any work. |
| 1443 | |
| 1444 | gid=int Set group ID, see uid. |
| 1445 | |
Dan Ehrenberg | 9e684a4 | 2012-02-20 11:05:14 +0100 | [diff] [blame] | 1446 | flow_id=int The ID of the flow. If not specified, it defaults to being a |
| 1447 | global flow. See flow. |
| 1448 | |
| 1449 | flow=int Weight in token-based flow control. If this value is used, then |
| 1450 | there is a 'flow counter' which is used to regulate the |
| 1451 | proportion of activity between two or more jobs. fio attempts |
| 1452 | to keep this flow counter near zero. The 'flow' parameter |
| 1453 | stands for how much should be added or subtracted to the flow |
| 1454 | counter on each iteration of the main I/O loop. That is, if |
| 1455 | one job has flow=8 and another job has flow=-1, then there |
| 1456 | will be a roughly 1:8 ratio in how much one runs vs the other. |
| 1457 | |
| 1458 | flow_watermark=int The maximum value that the absolute value of the flow |
| 1459 | counter is allowed to reach before the job must wait for a |
| 1460 | lower value of the counter. |
| 1461 | |
| 1462 | flow_sleep=int The period of time, in microseconds, to wait after the flow |
| 1463 | watermark has been exceeded before retrying operations |
| 1464 | |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 1465 | In addition, there are some parameters which are only valid when a specific |
| 1466 | ioengine is in use. These are used identically to normal parameters, with the |
| 1467 | caveat that when used on the command line, they must come after the ioengine |
| 1468 | that defines them is selected. |
| 1469 | |
| 1470 | [libaio] userspace_reap Normally, with the libaio engine in use, fio will use |
| 1471 | the io_getevents system call to reap newly returned events. |
| 1472 | With this flag turned on, the AIO ring will be read directly |
| 1473 | from user-space to reap events. The reaping mode is only |
| 1474 | enabled when polling for a minimum of 0 events (eg when |
| 1475 | iodepth_batch_complete=0). |
| 1476 | |
Jens Axboe | 0353050 | 2012-03-19 21:45:12 +0100 | [diff] [blame] | 1477 | [cpu] cpuload=int Attempt to use the specified percentage of CPU cycles. |
| 1478 | |
| 1479 | [cpu] cpuchunks=int Split the load into cycles of the given time. In |
| 1480 | microseconds. |
| 1481 | |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 1482 | [netsplice] hostname=str |
| 1483 | [net] hostname=str The host name or IP address to use for TCP or UDP based IO. |
| 1484 | If the job is a TCP listener or UDP reader, the hostname is not |
Shawn Bohrer | b511c9a | 2013-07-19 13:24:06 -0500 | [diff] [blame] | 1485 | used and must be omitted unless it is a valid UDP multicast |
| 1486 | address. |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 1487 | |
| 1488 | [netsplice] port=int |
| 1489 | [net] port=int The TCP or UDP port to bind to or connect to. |
| 1490 | |
Shawn Bohrer | b93b6a2 | 2013-07-19 13:24:07 -0500 | [diff] [blame] | 1491 | [netsplice] interface=str |
| 1492 | [net] interface=str The IP address of the network interface used to send or |
| 1493 | receive UDP multicast |
| 1494 | |
Shawn Bohrer | d3a623d | 2013-07-19 13:24:08 -0500 | [diff] [blame] | 1495 | [netsplice] ttl=int |
| 1496 | [net] ttl=int Time-to-live value for outgoing UDP multicast packets. |
| 1497 | Default: 1 |
| 1498 | |
Jens Axboe | 1d360ff | 2013-01-31 13:33:45 +0100 | [diff] [blame] | 1499 | [netsplice] nodelay=bool |
| 1500 | [net] nodelay=bool Set TCP_NODELAY on TCP connections. |
| 1501 | |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 1502 | [netsplice] protocol=str |
| 1503 | [netsplice] proto=str |
| 1504 | [net] protocol=str |
| 1505 | [net] proto=str The network protocol to use. Accepted values are: |
| 1506 | |
| 1507 | tcp Transmission control protocol |
Jens Axboe | 49ccb8c | 2014-01-23 16:49:37 -0800 | [diff] [blame] | 1508 | tcpv6 Transmission control protocol V6 |
Bruce Cran | f5cc3d0 | 2012-10-10 08:17:44 -0600 | [diff] [blame] | 1509 | udp User datagram protocol |
Jens Axboe | 49ccb8c | 2014-01-23 16:49:37 -0800 | [diff] [blame] | 1510 | udpv6 User datagram protocol V6 |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 1511 | unix UNIX domain socket |
| 1512 | |
| 1513 | When the protocol is TCP or UDP, the port must also be given, |
| 1514 | as well as the hostname if the job is a TCP listener or UDP |
| 1515 | reader. For unix sockets, the normal filename option should be |
| 1516 | used and the port is invalid. |
| 1517 | |
| 1518 | [net] listen For TCP network connections, tell fio to listen for incoming |
| 1519 | connections rather than initiating an outgoing connection. The |
| 1520 | hostname must be omitted if this option is used. |
Shawn Bohrer | b511c9a | 2013-07-19 13:24:06 -0500 | [diff] [blame] | 1521 | [net] pingpong Normaly a network writer will just continue writing data, and |
Jens Axboe | 7aeb1e9 | 2012-12-06 20:53:57 +0100 | [diff] [blame] | 1522 | a network reader will just consume packages. If pingpong=1 |
| 1523 | is set, a writer will send its normal payload to the reader, |
| 1524 | then wait for the reader to send the same payload back. This |
| 1525 | allows fio to measure network latencies. The submission |
| 1526 | and completion latencies then measure local time spent |
| 1527 | sending or receiving, and the completion latency measures |
| 1528 | how long it took for the other end to receive and send back. |
Shawn Bohrer | b511c9a | 2013-07-19 13:24:06 -0500 | [diff] [blame] | 1529 | For UDP multicast traffic pingpong=1 should only be set for a |
| 1530 | single reader when multiple readers are listening to the same |
| 1531 | address. |
Jens Axboe | 7aeb1e9 | 2012-12-06 20:53:57 +0100 | [diff] [blame] | 1532 | |
Dmitry Monakhov | d54fce8 | 2012-09-20 15:37:17 +0400 | [diff] [blame] | 1533 | [e4defrag] donorname=str |
| 1534 | File will be used as a block donor(swap extents between files) |
| 1535 | [e4defrag] inplace=int |
Bruce Cran | 66c098b | 2012-11-27 12:16:07 +0000 | [diff] [blame] | 1536 | Configure donor file blocks allocation strategy |
Dmitry Monakhov | d54fce8 | 2012-09-20 15:37:17 +0400 | [diff] [blame] | 1537 | 0(default): Preallocate donor's file on init |
| 1538 | 1 : allocate space immidietly inside defragment event, |
| 1539 | and free right after event |
| 1540 | |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 1541 | |
| 1542 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1543 | 6.0 Interpreting the output |
| 1544 | --------------------------- |
| 1545 | |
| 1546 | fio spits out a lot of output. While running, fio will display the |
| 1547 | status of the jobs created. An example of that would be: |
| 1548 | |
Jens Axboe | 73c8b08 | 2007-01-11 19:25:52 +0100 | [diff] [blame] | 1549 | 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] | 1550 | |
| 1551 | The characters inside the square brackets denote the current status of |
| 1552 | each thread. The possible values (in typical life cycle order) are: |
| 1553 | |
| 1554 | Idle Run |
| 1555 | ---- --- |
| 1556 | P Thread setup, but not started. |
| 1557 | C Thread created. |
Jens Axboe | 9c6f631 | 2012-11-07 09:15:45 +0100 | [diff] [blame] | 1558 | I Thread initialized, waiting or generating necessary data. |
Jens Axboe | b0f6586 | 2009-05-20 11:52:15 +0200 | [diff] [blame] | 1559 | p Thread running pre-reading file(s). |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1560 | R Running, doing sequential reads. |
| 1561 | r Running, doing random reads. |
| 1562 | W Running, doing sequential writes. |
| 1563 | w Running, doing random writes. |
| 1564 | M Running, doing mixed sequential reads/writes. |
| 1565 | m Running, doing mixed random reads/writes. |
| 1566 | F Running, currently waiting for fsync() |
Jens Axboe | fc6bd43 | 2009-04-29 09:52:10 +0200 | [diff] [blame] | 1567 | V Running, doing verification of written data. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1568 | E Thread exited, not reaped by main thread yet. |
Jens Axboe | 4f7e57a | 2012-03-30 21:21:20 +0200 | [diff] [blame] | 1569 | _ Thread reaped, or |
| 1570 | X Thread reaped, exited with an error. |
Jens Axboe | a5e371a | 2012-04-02 09:47:09 -0700 | [diff] [blame] | 1571 | K Thread reaped, exited due to signal. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1572 | |
| 1573 | The other values are fairly self explanatory - number of threads |
Jens Axboe | c9f6030 | 2007-07-20 12:43:05 +0200 | [diff] [blame] | 1574 | currently running and doing io, rate of io since last check (read speed |
| 1575 | listed first, then write speed), and the estimated completion percentage |
| 1576 | and time for the running group. It's impossible to estimate runtime of |
Jens Axboe | 4f7e57a | 2012-03-30 21:21:20 +0200 | [diff] [blame] | 1577 | the following groups (if any). Note that the string is displayed in order, |
| 1578 | so it's possible to tell which of the jobs are currently doing what. The |
| 1579 | first character is the first job defined in the job file, and so forth. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1580 | |
| 1581 | When fio is done (or interrupted by ctrl-c), it will show the data for |
| 1582 | each thread, group of threads, and disks in that order. For each data |
| 1583 | direction, the output looks like: |
| 1584 | |
| 1585 | Client1 (g=0): err= 0: |
Paul Dubs | 35649e5 | 2011-07-21 16:04:52 +0200 | [diff] [blame] | 1586 | write: io= 32MB, bw= 666KB/s, iops=89 , runt= 50320msec |
Jens Axboe | 6104ddb | 2007-01-11 14:24:29 +0100 | [diff] [blame] | 1587 | slat (msec): min= 0, max= 136, avg= 0.03, stdev= 1.92 |
| 1588 | clat (msec): min= 0, max= 631, avg=48.50, stdev=86.82 |
Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 1589 | bw (KB/s) : min= 0, max= 1196, per=51.00%, avg=664.02, stdev=681.68 |
Jens Axboe | e7823a9 | 2007-09-07 20:33:33 +0200 | [diff] [blame] | 1590 | cpu : usr=1.49%, sys=0.25%, ctx=7969, majf=0, minf=17 |
Jens Axboe | 71619dc | 2007-01-13 23:56:33 +0100 | [diff] [blame] | 1591 | 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 | 838bc70 | 2008-05-22 13:08:23 +0200 | [diff] [blame] | 1592 | submit : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0% |
| 1593 | complete : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0% |
Jens Axboe | 30061b9 | 2007-04-17 13:31:34 +0200 | [diff] [blame] | 1594 | issued r/w: total=0/32768, short=0/0 |
Jens Axboe | 8abdce6 | 2007-02-21 10:22:55 +0100 | [diff] [blame] | 1595 | lat (msec): 2=1.6%, 4=0.0%, 10=3.2%, 20=12.8%, 50=38.4%, 100=24.8%, |
| 1596 | 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] | 1597 | |
| 1598 | The client number is printed, along with the group id and error of that |
| 1599 | thread. Below is the io statistics, here for writes. In the order listed, |
| 1600 | they denote: |
| 1601 | |
| 1602 | io= Number of megabytes io performed |
| 1603 | bw= Average bandwidth rate |
Paul Dubs | 35649e5 | 2011-07-21 16:04:52 +0200 | [diff] [blame] | 1604 | iops= Average IOs performed per second |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1605 | runt= The runtime of that thread |
Jens Axboe | 72fbda2 | 2007-03-20 10:02:06 +0100 | [diff] [blame] | 1606 | slat= Submission latency (avg being the average, stdev being the |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1607 | standard deviation). This is the time it took to submit |
| 1608 | the io. For sync io, the slat is really the completion |
Jens Axboe | 8a35c71 | 2007-06-19 09:53:31 +0200 | [diff] [blame] | 1609 | latency, since queue/complete is one operation there. This |
Jens Axboe | bf9a3ed | 2008-06-05 11:53:08 +0200 | [diff] [blame] | 1610 | value can be in milliseconds or microseconds, fio will choose |
Jens Axboe | 8a35c71 | 2007-06-19 09:53:31 +0200 | [diff] [blame] | 1611 | the most appropriate base and print that. In the example |
Lucian Adrian Grijincu | 0d23771 | 2012-04-03 14:42:48 -0600 | [diff] [blame] | 1612 | above, milliseconds is the best scale. Note: in --minimal mode |
| 1613 | latencies are always expressed in microseconds. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1614 | clat= Completion latency. Same names as slat, this denotes the |
| 1615 | time from submission to completion of the io pieces. For |
| 1616 | sync io, clat will usually be equal (or very close) to 0, |
| 1617 | as the time from submit to complete is basically just |
| 1618 | CPU time (io has already been done, see slat explanation). |
| 1619 | bw= Bandwidth. Same names as the xlat stats, but also includes |
| 1620 | an approximate percentage of total aggregate bandwidth |
| 1621 | this thread received in this group. This last value is |
| 1622 | only really useful if the threads in this group are on the |
| 1623 | same disk, since they are then competing for disk access. |
| 1624 | cpu= CPU usage. User and system time, along with the number |
Jens Axboe | e7823a9 | 2007-09-07 20:33:33 +0200 | [diff] [blame] | 1625 | of context switches this thread went through, usage of |
| 1626 | system and user time, and finally the number of major |
| 1627 | and minor page faults. |
Jens Axboe | 71619dc | 2007-01-13 23:56:33 +0100 | [diff] [blame] | 1628 | IO depths= The distribution of io depths over the job life time. The |
| 1629 | numbers are divided into powers of 2, so for example the |
| 1630 | 16= entries includes depths up to that value but higher |
| 1631 | than the previous entry. In other words, it covers the |
| 1632 | range from 16 to 31. |
Jens Axboe | 838bc70 | 2008-05-22 13:08:23 +0200 | [diff] [blame] | 1633 | IO submit= How many pieces of IO were submitting in a single submit |
| 1634 | call. Each entry denotes that amount and below, until |
| 1635 | the previous entry - eg, 8=100% mean that we submitted |
| 1636 | anywhere in between 5-8 ios per submit call. |
| 1637 | IO complete= Like the above submit number, but for completions instead. |
Jens Axboe | 30061b9 | 2007-04-17 13:31:34 +0200 | [diff] [blame] | 1638 | IO issued= The number of read/write requests issued, and how many |
| 1639 | of them were short. |
Jens Axboe | ec11830 | 2007-02-17 04:38:20 +0100 | [diff] [blame] | 1640 | IO latencies= The distribution of IO completion latencies. This is the |
| 1641 | time from when IO leaves fio and when it gets completed. |
| 1642 | The numbers follow the same pattern as the IO depths, |
| 1643 | 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] | 1644 | within 2 msecs, 20=12.8% means that 12.8% of the IO |
| 1645 | 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] | 1646 | |
| 1647 | After each client has been listed, the group statistics are printed. They |
| 1648 | will look like this: |
| 1649 | |
| 1650 | Run status group 0 (all jobs): |
Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 1651 | READ: io=64MB, aggrb=22178, minb=11355, maxb=11814, mint=2840msec, maxt=2955msec |
| 1652 | WRITE: io=64MB, aggrb=1302, minb=666, maxb=669, mint=50093msec, maxt=50320msec |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1653 | |
| 1654 | For each data direction, it prints: |
| 1655 | |
| 1656 | io= Number of megabytes io performed. |
| 1657 | aggrb= Aggregate bandwidth of threads in this group. |
| 1658 | minb= The minimum average bandwidth a thread saw. |
| 1659 | maxb= The maximum average bandwidth a thread saw. |
| 1660 | mint= The smallest runtime of the threads in that group. |
| 1661 | maxt= The longest runtime of the threads in that group. |
| 1662 | |
| 1663 | And finally, the disk statistics are printed. They will look like this: |
| 1664 | |
| 1665 | Disk stats (read/write): |
| 1666 | sda: ios=16398/16511, merge=30/162, ticks=6853/819634, in_queue=826487, util=100.00% |
| 1667 | |
| 1668 | Each value is printed for both reads and writes, with reads first. The |
| 1669 | numbers denote: |
| 1670 | |
| 1671 | ios= Number of ios performed by all groups. |
| 1672 | merge= Number of merges io the io scheduler. |
| 1673 | ticks= Number of ticks we kept the disk busy. |
| 1674 | io_queue= Total time spent in the disk queue. |
| 1675 | util= The disk utilization. A value of 100% means we kept the disk |
| 1676 | busy constantly, 50% would be a disk idling half of the time. |
| 1677 | |
Jens Axboe | 8423bd1 | 2012-04-12 09:18:38 +0200 | [diff] [blame] | 1678 | It is also possible to get fio to dump the current output while it is |
| 1679 | running, without terminating the job. To do that, send fio the USR1 signal. |
Jens Axboe | 0646490 | 2013-04-24 20:38:54 -0600 | [diff] [blame] | 1680 | You can also get regularly timed dumps by using the --status-interval |
| 1681 | parameter, or by creating a file in /tmp named fio-dump-status. If fio |
| 1682 | sees this file, it will unlink it and dump the current output status. |
Jens Axboe | 8423bd1 | 2012-04-12 09:18:38 +0200 | [diff] [blame] | 1683 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1684 | |
| 1685 | 7.0 Terse output |
| 1686 | ---------------- |
| 1687 | |
| 1688 | For scripted usage where you typically want to generate tables or graphs |
Jens Axboe | 6af019c | 2007-03-06 19:50:58 +0100 | [diff] [blame] | 1689 | 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] | 1690 | The format is one long line of values, such as: |
| 1691 | |
David Nellans | 562c2d2 | 2010-09-23 08:38:17 +0200 | [diff] [blame] | 1692 | 2;card0;0;0;7139336;121836;60004;1;10109;27.932460;116.933948;220;126861;3495.446807;1085.368601;226;126864;3523.635629;1089.012448;24063;99944;50.275485%;59818.274627;5540.657370;7155060;122104;60004;1;8338;29.086342;117.839068;388;128077;5032.488518;1234.785715;391;128085;5061.839412;1236.909129;23436;100928;50.287926%;59964.832030;5644.844189;14.595833%;19.394167%;123706;0;7313;0.1%;0.1%;0.1%;0.1%;0.1%;0.1%;100.0%;0.00%;0.00%;0.00%;0.00%;0.00%;0.00%;0.01%;0.02%;0.05%;0.16%;6.04%;40.40%;52.68%;0.64%;0.01%;0.00%;0.01%;0.00%;0.00%;0.00%;0.00%;0.00% |
| 1693 | A description of this job goes here. |
| 1694 | |
| 1695 | The job description (if provided) follows on a second line. |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1696 | |
Jens Axboe | 525c2bf | 2010-06-30 15:22:21 +0200 | [diff] [blame] | 1697 | To enable terse output, use the --minimal command line option. The first |
| 1698 | value is the version of the terse output format. If the output has to |
| 1699 | be changed for some reason, this number will be incremented by 1 to |
| 1700 | signify that change. |
Jens Axboe | 6820cb3 | 2008-09-27 12:33:53 +0200 | [diff] [blame] | 1701 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1702 | Split up, the format is as follows: |
| 1703 | |
Jens Axboe | 5e726d0 | 2011-10-14 08:08:10 +0200 | [diff] [blame] | 1704 | terse version, fio version, jobname, groupid, error |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1705 | READ status: |
Jens Axboe | 312b4af | 2011-10-13 13:11:42 +0200 | [diff] [blame] | 1706 | Total IO (KB), bandwidth (KB/sec), IOPS, runtime (msec) |
Jens Axboe | de196b8 | 2012-04-02 07:03:26 -0700 | [diff] [blame] | 1707 | Submission latency: min, max, mean, deviation (usec) |
| 1708 | Completion latency: min, max, mean, deviation (usec) |
Jens Axboe | 1db92cb | 2011-10-13 13:43:36 +0200 | [diff] [blame] | 1709 | Completion latency percentiles: 20 fields (see below) |
Jens Axboe | de196b8 | 2012-04-02 07:03:26 -0700 | [diff] [blame] | 1710 | Total latency: min, max, mean, deviation (usec) |
Lucian Adrian Grijincu | 0d23771 | 2012-04-03 14:42:48 -0600 | [diff] [blame] | 1711 | Bw (KB/s): min, max, aggregate percentage of total, mean, deviation |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1712 | WRITE status: |
Jens Axboe | 312b4af | 2011-10-13 13:11:42 +0200 | [diff] [blame] | 1713 | Total IO (KB), bandwidth (KB/sec), IOPS, runtime (msec) |
Jens Axboe | de196b8 | 2012-04-02 07:03:26 -0700 | [diff] [blame] | 1714 | Submission latency: min, max, mean, deviation (usec) |
| 1715 | Completion latency: min, max, mean, deviation (usec) |
Jens Axboe | 1db92cb | 2011-10-13 13:43:36 +0200 | [diff] [blame] | 1716 | Completion latency percentiles: 20 fields (see below) |
Jens Axboe | de196b8 | 2012-04-02 07:03:26 -0700 | [diff] [blame] | 1717 | Total latency: min, max, mean, deviation (usec) |
Lucian Adrian Grijincu | 0d23771 | 2012-04-03 14:42:48 -0600 | [diff] [blame] | 1718 | Bw (KB/s): min, max, aggregate percentage of total, mean, deviation |
Shawn Lewis | 046ee30 | 2007-11-21 09:38:34 +0100 | [diff] [blame] | 1719 | CPU usage: user, system, context switches, major faults, minor faults |
Jens Axboe | 2270890 | 2007-03-06 17:05:32 +0100 | [diff] [blame] | 1720 | IO depths: <=1, 2, 4, 8, 16, 32, >=64 |
David Nellans | 562c2d2 | 2010-09-23 08:38:17 +0200 | [diff] [blame] | 1721 | IO latencies microseconds: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000 |
| 1722 | IO latencies milliseconds: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000 |
Jens Axboe | f2f788d | 2011-10-13 14:03:52 +0200 | [diff] [blame] | 1723 | Disk utilization: Disk name, Read ios, write ios, |
| 1724 | Read merges, write merges, |
| 1725 | Read ticks, write ticks, |
Jens Axboe | 3d7cd9b | 2011-10-18 08:31:01 +0200 | [diff] [blame] | 1726 | Time spent in queue, disk utilization percentage |
Anatol Pomozov | de8f6de | 2013-09-26 16:31:34 -0700 | [diff] [blame] | 1727 | Additional Info (dependent on continue_on_error, default off): total # errors, first error code |
Bruce Cran | 66c098b | 2012-11-27 12:16:07 +0000 | [diff] [blame] | 1728 | |
Anatol Pomozov | de8f6de | 2013-09-26 16:31:34 -0700 | [diff] [blame] | 1729 | Additional Info (dependent on description being set): Text description |
Paul Dubs | 25c8b9d | 2011-07-21 17:26:02 +0200 | [diff] [blame] | 1730 | |
Jens Axboe | 1db92cb | 2011-10-13 13:43:36 +0200 | [diff] [blame] | 1731 | Completion latency percentiles can be a grouping of up to 20 sets, so |
| 1732 | for the terse output fio writes all of them. Each field will look like this: |
| 1733 | |
| 1734 | 1.00%=6112 |
| 1735 | |
| 1736 | which is the Xth percentile, and the usec latency associated with it. |
| 1737 | |
Jens Axboe | f2f788d | 2011-10-13 14:03:52 +0200 | [diff] [blame] | 1738 | For disk utilization, all disks used by fio are shown. So for each disk |
| 1739 | there will be a disk utilization section. |
| 1740 | |
Paul Dubs | 25c8b9d | 2011-07-21 17:26:02 +0200 | [diff] [blame] | 1741 | |
| 1742 | 8.0 Trace file format |
| 1743 | --------------------- |
Bruce Cran | 66c098b | 2012-11-27 12:16:07 +0000 | [diff] [blame] | 1744 | There are two trace file format that you can encounter. The older (v1) format |
Paul Dubs | 25c8b9d | 2011-07-21 17:26:02 +0200 | [diff] [blame] | 1745 | is unsupported since version 1.20-rc3 (March 2008). It will still be described |
| 1746 | below in case that you get an old trace and want to understand it. |
| 1747 | |
| 1748 | In any case the trace is a simple text file with a single action per line. |
| 1749 | |
| 1750 | |
| 1751 | 8.1 Trace file format v1 |
| 1752 | ------------------------ |
| 1753 | Each line represents a single io action in the following format: |
| 1754 | |
| 1755 | rw, offset, length |
| 1756 | |
| 1757 | where rw=0/1 for read/write, and the offset and length entries being in bytes. |
| 1758 | |
| 1759 | This format is not supported in Fio versions => 1.20-rc3. |
| 1760 | |
| 1761 | |
| 1762 | 8.2 Trace file format v2 |
| 1763 | ------------------------ |
| 1764 | The second version of the trace file format was added in Fio version 1.17. |
| 1765 | It allows to access more then one file per trace and has a bigger set of |
| 1766 | possible file actions. |
| 1767 | |
| 1768 | The first line of the trace file has to be: |
| 1769 | |
| 1770 | fio version 2 iolog |
| 1771 | |
| 1772 | Following this can be lines in two different formats, which are described below. |
| 1773 | |
| 1774 | The file management format: |
| 1775 | |
| 1776 | filename action |
| 1777 | |
| 1778 | The filename is given as an absolute path. The action can be one of these: |
| 1779 | |
| 1780 | add Add the given filename to the trace |
Bruce Cran | 66c098b | 2012-11-27 12:16:07 +0000 | [diff] [blame] | 1781 | open Open the file with the given filename. The filename has to have |
Paul Dubs | 25c8b9d | 2011-07-21 17:26:02 +0200 | [diff] [blame] | 1782 | been added with the add action before. |
| 1783 | close Close the file with the given filename. The file has to have been |
| 1784 | opened before. |
| 1785 | |
| 1786 | |
| 1787 | The file io action format: |
| 1788 | |
| 1789 | filename action offset length |
| 1790 | |
| 1791 | The filename is given as an absolute path, and has to have been added and opened |
Bruce Cran | 66c098b | 2012-11-27 12:16:07 +0000 | [diff] [blame] | 1792 | before it can be used with this format. The offset and length are given in |
Paul Dubs | 25c8b9d | 2011-07-21 17:26:02 +0200 | [diff] [blame] | 1793 | bytes. The action can be one of these: |
| 1794 | |
| 1795 | wait Wait for 'offset' microseconds. Everything below 100 is discarded. |
| 1796 | read Read 'length' bytes beginning from 'offset' |
| 1797 | write Write 'length' bytes beginning from 'offset' |
| 1798 | sync fsync() the file |
| 1799 | datasync fdatasync() the file |
| 1800 | trim trim the given file from the given 'offset' for 'length' bytes |
Huadong Liu | f2a2ce0 | 2013-01-30 13:22:24 +0100 | [diff] [blame] | 1801 | |
| 1802 | |
| 1803 | 9.0 CPU idleness profiling |
Jens Axboe | 0646490 | 2013-04-24 20:38:54 -0600 | [diff] [blame] | 1804 | -------------------------- |
Huadong Liu | f2a2ce0 | 2013-01-30 13:22:24 +0100 | [diff] [blame] | 1805 | In some cases, we want to understand CPU overhead in a test. For example, |
| 1806 | we test patches for the specific goodness of whether they reduce CPU usage. |
| 1807 | fio implements a balloon approach to create a thread per CPU that runs at |
| 1808 | idle priority, meaning that it only runs when nobody else needs the cpu. |
| 1809 | By measuring the amount of work completed by the thread, idleness of each |
| 1810 | CPU can be derived accordingly. |
| 1811 | |
| 1812 | An unit work is defined as touching a full page of unsigned characters. Mean |
| 1813 | and standard deviation of time to complete an unit work is reported in "unit |
| 1814 | work" section. Options can be chosen to report detailed percpu idleness or |
| 1815 | overall system idleness by aggregating percpu stats. |