| 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 | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 12 |  | 
 | 13 | 1.0 Overview and history | 
 | 14 | ------------------------ | 
 | 15 | fio was originally written to save me the hassle of writing special test | 
 | 16 | case programs when I wanted to test a specific workload, either for | 
 | 17 | performance reasons or to find/reproduce a bug. The process of writing | 
 | 18 | such a test app can be tiresome, especially if you have to do it often. | 
 | 19 | Hence I needed a tool that would be able to simulate a given io workload | 
 | 20 | without resorting to writing a tailored test case again and again. | 
 | 21 |  | 
 | 22 | A test work load is difficult to define, though. There can be any number | 
 | 23 | of processes or threads involved, and they can each be using their own | 
 | 24 | way of generating io. You could have someone dirtying large amounts of | 
 | 25 | memory in an memory mapped file, or maybe several threads issuing | 
 | 26 | reads using asynchronous io. fio needed to be flexible enough to | 
 | 27 | simulate both of these cases, and many more. | 
 | 28 |  | 
 | 29 | 2.0 How fio works | 
 | 30 | ----------------- | 
 | 31 | The first step in getting fio to simulate a desired io workload, is | 
 | 32 | writing a job file describing that specific setup. A job file may contain | 
 | 33 | any number of threads and/or files - the typical contents of the job file | 
 | 34 | is a global section defining shared parameters, and one or more job | 
 | 35 | sections describing the jobs involved. When run, fio parses this file | 
 | 36 | and sets everything up as described. If we break down a job from top to | 
 | 37 | bottom, it contains the following basic parameters: | 
 | 38 |  | 
 | 39 | 	IO type		Defines the io pattern issued to the file(s). | 
 | 40 | 			We may only be reading sequentially from this | 
 | 41 | 			file(s), or we may be writing randomly. Or even | 
 | 42 | 			mixing reads and writes, sequentially or randomly. | 
 | 43 |  | 
 | 44 | 	Block size	In how large chunks are we issuing io? This may be | 
 | 45 | 			a single value, or it may describe a range of | 
 | 46 | 			block sizes. | 
 | 47 |  | 
 | 48 | 	IO size		How much data are we going to be reading/writing. | 
 | 49 |  | 
 | 50 | 	IO engine	How do we issue io? We could be memory mapping the | 
 | 51 | 			file, we could be using regular read/write, we | 
| Jens Axboe | d0ff85d | 2007-02-14 01:19:41 +0100 | [diff] [blame] | 52 | 			could be using splice, async io, syslet, or even | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 53 | 			SG (SCSI generic sg). | 
 | 54 |  | 
| Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 55 | 	IO depth	If the io engine is async, how large a queuing | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 56 | 			depth do we want to maintain? | 
 | 57 |  | 
 | 58 | 	IO type		Should we be doing buffered io, or direct/raw io? | 
 | 59 |  | 
 | 60 | 	Num files	How many files are we spreading the workload over. | 
 | 61 |  | 
 | 62 | 	Num threads	How many threads or processes should we spread | 
 | 63 | 			this workload over. | 
 | 64 | 	 | 
 | 65 | The above are the basic parameters defined for a workload, in addition | 
 | 66 | there's a multitude of parameters that modify other aspects of how this | 
 | 67 | job behaves. | 
 | 68 |  | 
 | 69 |  | 
 | 70 | 3.0 Running fio | 
 | 71 | --------------- | 
 | 72 | See the README file for command line parameters, there are only a few | 
 | 73 | of them. | 
 | 74 |  | 
 | 75 | Running fio is normally the easiest part - you just give it the job file | 
 | 76 | (or job files) as parameters: | 
 | 77 |  | 
 | 78 | $ fio job_file | 
 | 79 |  | 
 | 80 | and it will start doing what the job_file tells it to do. You can give | 
 | 81 | more than one job file on the command line, fio will serialize the running | 
 | 82 | of those files. Internally that is the same as using the 'stonewall' | 
 | 83 | parameter described the the parameter section. | 
 | 84 |  | 
| Jens Axboe | b469282 | 2006-10-27 13:43:22 +0200 | [diff] [blame] | 85 | If the job file contains only one job, you may as well just give the | 
 | 86 | parameters on the command line. The command line parameters are identical | 
 | 87 | to the job parameters, with a few extra that control global parameters | 
 | 88 | (see README). For example, for the job file parameter iodepth=2, the | 
| Jens Axboe | c2b1e75 | 2006-10-30 09:03:13 +0100 | [diff] [blame] | 89 | mirror command line option would be --iodepth 2 or --iodepth=2. You can | 
 | 90 | also use the command line for giving more than one job entry. For each | 
 | 91 | --name option that fio sees, it will start a new job with that name. | 
 | 92 | Command line entries following a --name entry will apply to that job, | 
 | 93 | until there are no more entries or a new --name entry is seen. This is | 
 | 94 | similar to the job file options, where each option applies to the current | 
 | 95 | job until a new [] job entry is seen. | 
| Jens Axboe | b469282 | 2006-10-27 13:43:22 +0200 | [diff] [blame] | 96 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 97 | fio does not need to run as root, except if the files or devices specified | 
 | 98 | in the job section requires that. Some other options may also be restricted, | 
| Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 99 | such as memory locking, io scheduler switching, and decreasing the nice value. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 100 |  | 
 | 101 |  | 
 | 102 | 4.0 Job file format | 
 | 103 | ------------------- | 
 | 104 | As previously described, fio accepts one or more job files describing | 
 | 105 | what it is supposed to do. The job file format is the classic ini file, | 
 | 106 | where the names enclosed in [] brackets define the job name. You are free | 
 | 107 | to use any ascii name you want, except 'global' which has special meaning. | 
 | 108 | A global section sets defaults for the jobs described in that file. A job | 
 | 109 | may override a global section parameter, and a job file may even have | 
 | 110 | several global sections if so desired. A job is only affected by a global | 
| Jens Axboe | 65db085 | 2007-02-20 10:22:01 +0100 | [diff] [blame] | 111 | section residing above it. If the first character in a line is a ';' or a | 
 | 112 | '#', the entire line is discarded as a comment. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 113 |  | 
| Aaron Carroll | 3c54bc4 | 2008-10-07 11:25:38 +0200 | [diff] [blame] | 114 | 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] | 115 | randomly reading from a 128MB file. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 116 |  | 
 | 117 | ; -- start job file -- | 
 | 118 | [global] | 
 | 119 | rw=randread | 
 | 120 | size=128m | 
 | 121 |  | 
 | 122 | [job1] | 
 | 123 |  | 
 | 124 | [job2] | 
 | 125 |  | 
 | 126 | ; -- end job file -- | 
 | 127 |  | 
 | 128 | As you can see, the job file sections themselves are empty as all the | 
 | 129 | described parameters are shared. As no filename= option is given, fio | 
| Jens Axboe | c2b1e75 | 2006-10-30 09:03:13 +0100 | [diff] [blame] | 130 | makes up a filename for each of the jobs as it sees fit. On the command | 
 | 131 | line, this job would look as follows: | 
 | 132 |  | 
 | 133 | $ fio --name=global --rw=randread --size=128m --name=job1 --name=job2 | 
 | 134 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 135 |  | 
| Aaron Carroll | 3c54bc4 | 2008-10-07 11:25:38 +0200 | [diff] [blame] | 136 | 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] | 137 | to files. | 
 | 138 |  | 
 | 139 | ; -- start job file -- | 
 | 140 | [random-writers] | 
 | 141 | ioengine=libaio | 
 | 142 | iodepth=4 | 
 | 143 | rw=randwrite | 
 | 144 | bs=32k | 
 | 145 | direct=0 | 
 | 146 | size=64m | 
 | 147 | numjobs=4 | 
 | 148 |  | 
 | 149 | ; -- end job file -- | 
 | 150 |  | 
 | 151 | Here we have no global section, as we only have one job defined anyway. | 
 | 152 | We want to use async io here, with a depth of 4 for each file. We also | 
| Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 153 | 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] | 154 | fork 4 identical jobs. The result is 4 processes each randomly writing | 
| Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 155 | 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] | 156 | have given the parameters on the command line. For this case, you would | 
 | 157 | specify: | 
 | 158 |  | 
 | 159 | $ fio --name=random-writers --ioengine=libaio --iodepth=4 --rw=randwrite --bs=32k --direct=0 --size=64m --numjobs=4 | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 160 |  | 
| Jens Axboe | 74929ac | 2009-08-05 11:42:37 +0200 | [diff] [blame] | 161 | 4.1 Environment variables | 
 | 162 | ------------------------- | 
 | 163 |  | 
| Aaron Carroll | 3c54bc4 | 2008-10-07 11:25:38 +0200 | [diff] [blame] | 164 | fio also supports environment variable expansion in job files. Any | 
 | 165 | substring of the form "${VARNAME}" as part of an option value (in other | 
 | 166 | words, on the right of the `='), will be expanded to the value of the | 
 | 167 | environment variable called VARNAME.  If no such environment variable | 
 | 168 | is defined, or VARNAME is the empty string, the empty string will be | 
 | 169 | substituted. | 
 | 170 |  | 
 | 171 | As an example, let's look at a sample fio invocation and job file: | 
 | 172 |  | 
 | 173 | $ SIZE=64m NUMJOBS=4 fio jobfile.fio | 
 | 174 |  | 
 | 175 | ; -- start job file -- | 
 | 176 | [random-writers] | 
 | 177 | rw=randwrite | 
 | 178 | size=${SIZE} | 
 | 179 | numjobs=${NUMJOBS} | 
 | 180 | ; -- end job file -- | 
 | 181 |  | 
 | 182 | This will expand to the following equivalent job file at runtime: | 
 | 183 |  | 
 | 184 | ; -- start job file -- | 
 | 185 | [random-writers] | 
 | 186 | rw=randwrite | 
 | 187 | size=64m | 
 | 188 | numjobs=4 | 
 | 189 | ; -- end job file -- | 
 | 190 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 191 | fio ships with a few example job files, you can also look there for | 
 | 192 | inspiration. | 
 | 193 |  | 
| Jens Axboe | 74929ac | 2009-08-05 11:42:37 +0200 | [diff] [blame] | 194 | 4.2 Reserved keywords | 
 | 195 | --------------------- | 
 | 196 |  | 
 | 197 | Additionally, fio has a set of reserved keywords that will be replaced | 
 | 198 | internally with the appropriate value. Those keywords are: | 
 | 199 |  | 
 | 200 | $pagesize	The architecture page size of the running system | 
 | 201 | $mb_memory	Megabytes of total memory in the system | 
 | 202 | $ncpus		Number of online available CPUs | 
 | 203 |  | 
 | 204 | These can be used on the command line or in the job file, and will be | 
 | 205 | automatically substituted with the current system values when the job | 
| Jens Axboe | 892a6ff | 2009-11-13 12:19:49 +0100 | [diff] [blame] | 206 | is run. Simple math is also supported on these keywords, so you can | 
 | 207 | perform actions like: | 
 | 208 |  | 
 | 209 | size=8*$mb_memory | 
 | 210 |  | 
 | 211 | and get that properly expanded to 8 times the size of memory in the | 
 | 212 | machine. | 
| Jens Axboe | 74929ac | 2009-08-05 11:42:37 +0200 | [diff] [blame] | 213 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 214 |  | 
 | 215 | 5.0 Detailed list of parameters | 
 | 216 | ------------------------------- | 
 | 217 |  | 
 | 218 | This section describes in details each parameter associated with a job. | 
 | 219 | Some parameters take an option of a given type, such as an integer or | 
 | 220 | a string. The following types are used: | 
 | 221 |  | 
 | 222 | str	String. This is a sequence of alpha characters. | 
| Jens Axboe | b09da8f | 2009-07-17 23:16:17 +0200 | [diff] [blame] | 223 | time	Integer with possible time suffix. In seconds unless otherwise | 
| Jens Axboe | e417fd6 | 2008-09-11 09:27:15 +0200 | [diff] [blame] | 224 | 	specified, use eg 10m for 10 minutes. Accepts s/m/h for seconds, | 
 | 225 | 	minutes, and hours. | 
| Jens Axboe | b09da8f | 2009-07-17 23:16:17 +0200 | [diff] [blame] | 226 | int	SI integer. A whole number value, which may contain a suffix | 
 | 227 | 	describing the base of the number. Accepted suffixes are k/m/g/t/p, | 
 | 228 | 	meaning kilo, mega, giga, tera, and peta. The suffix is not case | 
| Jens Axboe | 57fc29f | 2010-06-23 22:24:07 +0200 | [diff] [blame] | 229 | 	sensitive, and you may also include trailing 'b' (eg 'kb' is the same | 
 | 230 | 	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] | 231 | 	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] | 232 | 	1024 is 1k and 1024k is 1m and so on, unless the suffix is explicitly | 
 | 233 | 	set to a base 10 value using 'kib', 'mib', 'gib', etc. If that is the | 
 | 234 | 	case, then 1000 is used as the multiplier. This can be handy for | 
 | 235 | 	disks, since manufacturers generally use base 10 values when listing | 
 | 236 | 	the capacity of a drive. If the option accepts an upper and lower | 
 | 237 | 	range, use a colon ':' or minus '-' to separate such values.  May also | 
 | 238 | 	include a prefix to indicate numbers base. If 0x is used, the number | 
 | 239 | 	is assumed to be hexadecimal.  See irange. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 240 | bool	Boolean. Usually parsed as an integer, however only defined for | 
 | 241 | 	true and false (1 and 0). | 
| Jens Axboe | b09da8f | 2009-07-17 23:16:17 +0200 | [diff] [blame] | 242 | irange	Integer range with suffix. Allows value range to be given, such | 
| Jens Axboe | bf9a3ed | 2008-06-05 11:53:08 +0200 | [diff] [blame] | 243 | 	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] | 244 | 	1k:4k. If the option allows two sets of ranges, they can be | 
 | 245 | 	specified with a ',' or '/' delimiter: 1k-4k/8k-32k. Also see | 
| Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 246 | 	int. | 
| Yu-ju Hong | 8334919 | 2011-08-13 00:53:44 +0200 | [diff] [blame^] | 247 | float_list	A list of floating numbers, separated by a ':' character. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 248 |  | 
 | 249 | With the above in mind, here follows the complete list of fio job | 
 | 250 | parameters. | 
 | 251 |  | 
 | 252 | name=str	ASCII name of the job. This may be used to override the | 
 | 253 | 		name printed by fio for this job. Otherwise the job | 
| Jens Axboe | c2b1e75 | 2006-10-30 09:03:13 +0100 | [diff] [blame] | 254 | 		name is used. On the command line this parameter has the | 
| Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 255 | 		special purpose of also signaling the start of a new | 
| Jens Axboe | c2b1e75 | 2006-10-30 09:03:13 +0100 | [diff] [blame] | 256 | 		job. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 257 |  | 
| Jens Axboe | 61697c3 | 2007-02-05 15:04:46 +0100 | [diff] [blame] | 258 | description=str	Text description of the job. Doesn't do anything except | 
 | 259 | 		dump this text description when this job is run. It's | 
 | 260 | 		not parsed. | 
 | 261 |  | 
| Randy Dunlap | 3776041 | 2009-05-13 07:51:05 +0200 | [diff] [blame] | 262 | directory=str	Prefix filenames with this directory. Used to place files | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 263 | 		in a different location than "./". | 
 | 264 |  | 
 | 265 | filename=str	Fio normally makes up a filename based on the job name, | 
 | 266 | 		thread number, and file number. If you want to share | 
 | 267 | 		files between threads in a job or several jobs, specify | 
| Jens Axboe | ed92ac0 | 2007-02-06 14:43:52 +0100 | [diff] [blame] | 268 | 		a filename for each of them to override the default. If | 
| Jens Axboe | 414c2a3 | 2009-01-16 13:21:15 +0100 | [diff] [blame] | 269 | 		the ioengine used is 'net', the filename is the host, port, | 
 | 270 | 		and protocol to use in the format of =host/port/protocol. | 
 | 271 | 		See ioengine=net for more. If the ioengine is file based, you | 
 | 272 | 		can specify a number of files by separating the names with a | 
 | 273 | 		':' colon. So if you wanted a job to open /dev/sda and /dev/sdb | 
 | 274 | 		as the two working files, you would use | 
| Bruce Cran | 03e20d6 | 2011-01-02 20:14:54 +0100 | [diff] [blame] | 275 | 		filename=/dev/sda:/dev/sdb. On Windows, disk devices are accessed | 
| Bruce Cran | ecc314b | 2011-01-04 10:59:30 +0100 | [diff] [blame] | 276 | 		as \\.\PhysicalDrive0 for the first device, \\.\PhysicalDrive1 | 
 | 277 | 		for the second etc.  If the wanted filename does need to  | 
 | 278 | 		include a colon, then escape that with a '\' character.  | 
 | 279 | 		For instance, if the filename is "/dev/dsk/foo@3,0:c",  | 
 | 280 | 		then you would use filename="/dev/dsk/foo@3,0\:c".  | 
| Bruce Cran | 03e20d6 | 2011-01-02 20:14:54 +0100 | [diff] [blame] | 281 | 		'-' is a reserved name, meaning stdin or stdout. Which of the  | 
 | 282 | 		two depends on the read/write direction set. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 283 |  | 
| Jens Axboe | bbf6b54 | 2007-03-13 15:28:55 +0100 | [diff] [blame] | 284 | opendir=str	Tell fio to recursively add any file it can find in this | 
 | 285 | 		directory and down the file system tree. | 
 | 286 |  | 
| Randy Dunlap | 3776041 | 2009-05-13 07:51:05 +0200 | [diff] [blame] | 287 | lockfile=str	Fio defaults to not locking any files before it does | 
| Jens Axboe | 4d4e80f | 2008-03-04 10:18:56 +0100 | [diff] [blame] | 288 | 		IO to them. If a file or file descriptor is shared, fio | 
 | 289 | 		can serialize IO to that file to make the end result | 
 | 290 | 		consistent. This is usual for emulating real workloads that | 
 | 291 | 		share files. The lock modes are: | 
| Jens Axboe | 29c1349 | 2008-03-01 19:25:20 +0100 | [diff] [blame] | 292 |  | 
| Jens Axboe | 4d4e80f | 2008-03-04 10:18:56 +0100 | [diff] [blame] | 293 | 			none		No locking. The default. | 
 | 294 | 			exclusive	Only one thread/process may do IO, | 
 | 295 | 					excluding all others. | 
 | 296 | 			readwrite	Read-write locking on the file. Many | 
 | 297 | 					readers may access the file at the | 
 | 298 | 					same time, but writes get exclusive | 
 | 299 | 					access. | 
 | 300 |  | 
 | 301 | 		The option may be post-fixed with a lock batch number. If | 
 | 302 | 		set, then each thread/process may do that amount of IOs to | 
| Jens Axboe | bf9a3ed | 2008-06-05 11:53:08 +0200 | [diff] [blame] | 303 | 		the file before giving up the lock. Since lock acquisition is | 
| Jens Axboe | 4d4e80f | 2008-03-04 10:18:56 +0100 | [diff] [blame] | 304 | 		expensive, batching the lock/unlocks will speed up IO. | 
| Jens Axboe | 29c1349 | 2008-03-01 19:25:20 +0100 | [diff] [blame] | 305 |  | 
| Jens Axboe | d3aad8f | 2007-03-15 14:12:05 +0100 | [diff] [blame] | 306 | readwrite=str | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 307 | rw=str		Type of io pattern. Accepted values are: | 
 | 308 |  | 
 | 309 | 			read		Sequential reads | 
 | 310 | 			write		Sequential writes | 
 | 311 | 			randwrite	Random writes | 
 | 312 | 			randread	Random reads | 
 | 313 | 			rw		Sequential mixed reads and writes | 
 | 314 | 			randrw		Random mixed reads and writes | 
 | 315 |  | 
 | 316 | 		For the mixed io types, the default is to split them 50/50. | 
 | 317 | 		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] | 318 | 		since the speed may be different. It is possible to specify | 
| Jens Axboe | 38dad62 | 2010-07-20 14:46:00 -0600 | [diff] [blame] | 319 | 		a number of IO's to do before getting a new offset, this is | 
 | 320 | 		one by appending a ':<nr>' to the end of the string given. | 
 | 321 | 		For a random read, it would look like 'rw=randread:8' for | 
 | 322 | 		passing in an offset modifier with a value of 8. See the | 
 | 323 | 		'rw_sequencer' option. | 
 | 324 |  | 
 | 325 | rw_sequencer=str If an offset modifier is given by appending a number to | 
 | 326 | 		the rw=<str> line, then this option controls how that | 
 | 327 | 		number modifies the IO offset being generated. Accepted | 
 | 328 | 		values are: | 
 | 329 |  | 
 | 330 | 			sequential	Generate sequential offset | 
 | 331 | 			identical	Generate the same offset | 
 | 332 |  | 
 | 333 | 		'sequential' is only useful for random IO, where fio would | 
 | 334 | 		normally generate a new random offset for every IO. If you | 
 | 335 | 		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] | 336 | 		every 8 IO's. The result would be a seek for only every 8 | 
 | 337 | 		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] | 338 | 		that. As sequential IO is already sequential, setting | 
 | 339 | 		'sequential' for that would not result in any differences. | 
 | 340 | 		'identical' behaves in a similar fashion, except it sends | 
 | 341 | 		the same offset 8 number of times before generating a new | 
 | 342 | 		offset. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 343 |  | 
| Jens Axboe | 90fef2d | 2009-07-17 22:33:32 +0200 | [diff] [blame] | 344 | kb_base=int	The base unit for a kilobyte. The defacto base is 2^10, 1024. | 
 | 345 | 		Storage manufacturers like to use 10^3 or 1000 as a base | 
 | 346 | 		ten unit instead, for obvious reasons. Allow values are | 
 | 347 | 		1024 or 1000, with 1024 being the default. | 
 | 348 |  | 
| Jens Axboe | ee73849 | 2007-01-10 11:23:16 +0100 | [diff] [blame] | 349 | randrepeat=bool	For random IO workloads, seed the generator in a predictable | 
 | 350 | 		way so that results are repeatable across repetitions. | 
 | 351 |  | 
| Jens Axboe | 2615cc4 | 2011-03-28 09:35:09 +0200 | [diff] [blame] | 352 | use_os_rand=bool Fio can either use the random generator supplied by the OS | 
 | 353 | 		to generator random offsets, or it can use it's own internal | 
 | 354 | 		generator (based on Tausworthe). Default is to use the | 
 | 355 | 		internal generator, which is often of better quality and | 
 | 356 | 		faster. | 
 | 357 |  | 
| Eric Gouriou | a596f04 | 2011-06-17 09:11:45 +0200 | [diff] [blame] | 358 | fallocate=str	Whether pre-allocation is performed when laying down files. | 
 | 359 | 		Accepted values are: | 
 | 360 |  | 
 | 361 | 			none		Do not pre-allocate space | 
 | 362 | 			posix		Pre-allocate via posix_fallocate() | 
 | 363 | 			keep		Pre-allocate via fallocate() with | 
 | 364 | 					FALLOC_FL_KEEP_SIZE set | 
 | 365 | 			0		Backward-compatible alias for 'none' | 
 | 366 | 			1		Backward-compatible alias for 'posix' | 
 | 367 |  | 
 | 368 | 		May not be available on all supported platforms. 'keep' is only | 
 | 369 | 		available on Linux.If using ZFS on Solaris this must be set to | 
 | 370 | 		'none' because ZFS doesn't support it. Default: 'posix'. | 
| Jens Axboe | 7bc8c2c | 2010-01-28 11:31:31 +0100 | [diff] [blame] | 371 |  | 
| Jens Axboe | d2f3ac3 | 2007-03-22 19:24:09 +0100 | [diff] [blame] | 372 | fadvise_hint=bool By default, fio will use fadvise() to advise the kernel | 
 | 373 | 		on what IO patterns it is likely to issue. Sometimes you | 
 | 374 | 		want to test specific IO patterns without telling the | 
 | 375 | 		kernel about it, in which case you can disable this option. | 
 | 376 | 		If set, fio will use POSIX_FADV_SEQUENTIAL for sequential | 
 | 377 | 		IO and POSIX_FADV_RANDOM for random IO. | 
 | 378 |  | 
| Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 379 | 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] | 380 | 		this many bytes has been transferred, unless runtime is | 
 | 381 | 		limited by other options (such as 'runtime', for instance). | 
| Randy Dunlap | 3776041 | 2009-05-13 07:51:05 +0200 | [diff] [blame] | 382 | 		Unless specific nrfiles and filesize options are given, | 
| Jens Axboe | 7616caf | 2007-05-25 09:26:05 +0200 | [diff] [blame] | 383 | 		fio will divide this size between the available files | 
| Jens Axboe | d666726 | 2010-06-25 11:32:48 +0200 | [diff] [blame] | 384 | 		specified by the job. If not set, fio will use the full | 
 | 385 | 		size of the given files or devices. If the the files | 
| Jens Axboe | 7bb5910 | 2011-07-12 19:47:03 +0200 | [diff] [blame] | 386 | 		do not exist, size must be given. It is also possible to | 
 | 387 | 		give size as a percentage between 1 and 100. If size=20% | 
 | 388 | 		is given, fio will use 20% of the full size of the given | 
 | 389 | 		files or devices. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 390 |  | 
| Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 391 | 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] | 392 | 		will select sizes for files at random within the given range | 
 | 393 | 		and limited to 'size' in total (if that is given). If not | 
 | 394 | 		given, each created file is the same size. | 
 | 395 |  | 
| Jens Axboe | 74586c1 | 2011-01-20 10:16:03 -0700 | [diff] [blame] | 396 | fill_device=bool | 
 | 397 | 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] | 398 | 		space left on device) as the terminating condition. Only makes | 
| Jens Axboe | 3ce9dca | 2009-06-10 08:55:21 +0200 | [diff] [blame] | 399 |                 sense with sequential write. For a read workload, the mount | 
| Jens Axboe | 4f12432 | 2011-01-19 15:35:26 -0700 | [diff] [blame] | 400 | 		point will be filled first then IO started on the result. This | 
 | 401 | 		option doesn't make sense if operating on a raw device node, | 
 | 402 | 		since the size of that is already known by the file system. | 
 | 403 | 		Additionally, writing beyond end-of-device will not return | 
 | 404 | 		ENOSPC there. | 
| Shawn Lewis | aa31f1f | 2008-01-11 09:45:11 +0100 | [diff] [blame] | 405 |  | 
| Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 406 | blocksize=int | 
 | 407 | bs=int		The block size used for the io units. Defaults to 4k. Values | 
 | 408 | 		can be given for both read and writes. If a single int is | 
 | 409 | 		given, it will apply to both. If a second int is specified | 
| Jens Axboe | f90eff5 | 2006-11-06 11:08:21 +0100 | [diff] [blame] | 410 | 		after a comma, it will apply to writes only. In other words, | 
 | 411 | 		the format is either bs=read_and_write or bs=read,write. | 
 | 412 | 		bs=4k,8k will thus use 4k blocks for reads, and 8k blocks | 
| Jens Axboe | 787f7e9 | 2006-11-06 13:26:29 +0100 | [diff] [blame] | 413 | 		for writes. If you only wish to set the write size, you | 
 | 414 | 		can do so by passing an empty read size - bs=,8k will set | 
 | 415 | 		8k for writes and leave the read default value. | 
| Jens Axboe | a00735e | 2006-11-03 08:58:08 +0100 | [diff] [blame] | 416 |  | 
| Jens Axboe | 2b7a01d | 2009-03-11 11:00:13 +0100 | [diff] [blame] | 417 | blockalign=int | 
 | 418 | ba=int		At what boundary to align random IO offsets. Defaults to | 
 | 419 | 		the same as 'blocksize' the minimum blocksize given. | 
 | 420 | 		Minimum alignment is typically 512b for using direct IO, | 
 | 421 | 		though it usually depends on the hardware block size. This | 
 | 422 | 		option is mutually exclusive with using a random map for | 
 | 423 | 		files, so it will turn off that option. | 
 | 424 |  | 
| Jens Axboe | d3aad8f | 2007-03-15 14:12:05 +0100 | [diff] [blame] | 425 | blocksize_range=irange | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 426 | bsrange=irange	Instead of giving a single block size, specify a range | 
 | 427 | 		and fio will mix the issued io block sizes. The issued | 
 | 428 | 		io unit will always be a multiple of the minimum value | 
| Jens Axboe | f90eff5 | 2006-11-06 11:08:21 +0100 | [diff] [blame] | 429 | 		given (also see bs_unaligned). Applies to both reads and | 
 | 430 | 		writes, however a second range can be given after a comma. | 
 | 431 | 		See bs=. | 
| Jens Axboe | a00735e | 2006-11-03 08:58:08 +0100 | [diff] [blame] | 432 |  | 
| Jens Axboe | 564ca97 | 2007-12-14 12:21:19 +0100 | [diff] [blame] | 433 | bssplit=str	Sometimes you want even finer grained control of the | 
 | 434 | 		block sizes issued, not just an even split between them. | 
 | 435 | 		This option allows you to weight various block sizes, | 
 | 436 | 		so that you are able to define a specific amount of | 
 | 437 | 		block sizes issued. The format for this option is: | 
 | 438 |  | 
 | 439 | 			bssplit=blocksize/percentage:blocksize/percentage | 
 | 440 |  | 
 | 441 | 		for as many block sizes as needed. So if you want to define | 
 | 442 | 		a workload that has 50% 64k blocks, 10% 4k blocks, and | 
 | 443 | 		40% 32k blocks, you would write: | 
 | 444 |  | 
 | 445 | 			bssplit=4k/10:64k/50:32k/40 | 
 | 446 |  | 
 | 447 | 		Ordering does not matter. If the percentage is left blank, | 
 | 448 | 		fio will fill in the remaining values evenly. So a bssplit | 
 | 449 | 		option like this one: | 
 | 450 |  | 
 | 451 | 			bssplit=4k/50:1k/:32k/ | 
 | 452 |  | 
 | 453 | 		would have 50% 4k ios, and 25% 1k and 32k ios. The percentages | 
 | 454 | 		always add up to 100, if bssplit is given a range that adds | 
 | 455 | 		up to more, it will error out. | 
 | 456 |  | 
| Jens Axboe | 720e84a | 2009-04-21 08:29:55 +0200 | [diff] [blame] | 457 | 		bssplit also supports giving separate splits to reads and | 
 | 458 | 		writes. The format is identical to what bs= accepts. You | 
 | 459 | 		have to separate the read and write parts with a comma. So | 
 | 460 | 		if you want a workload that has 50% 2k reads and 50% 4k reads, | 
 | 461 | 		while having 90% 4k writes and 10% 8k writes, you would | 
 | 462 | 		specify: | 
 | 463 |  | 
 | 464 | 		bssplit=2k/50:4k/50,4k/90,8k/10 | 
 | 465 |  | 
| Jens Axboe | d3aad8f | 2007-03-15 14:12:05 +0100 | [diff] [blame] | 466 | blocksize_unaligned | 
| Jens Axboe | 690adba | 2006-10-30 15:25:09 +0100 | [diff] [blame] | 467 | bs_unaligned	If this option is given, any byte size value within bsrange | 
 | 468 | 		may be used as a block range. This typically wont work with | 
 | 469 | 		direct IO, as that normally requires sector alignment. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 470 |  | 
| Jens Axboe | e9459e5 | 2007-04-17 15:46:32 +0200 | [diff] [blame] | 471 | zero_buffers	If this option is given, fio will init the IO buffers to | 
 | 472 | 		all zeroes. The default is to fill them with random data. | 
 | 473 |  | 
| Jens Axboe | 5973caf | 2008-05-21 19:52:35 +0200 | [diff] [blame] | 474 | refill_buffers	If this option is given, fio will refill the IO buffers | 
 | 475 | 		on every submit. The default is to only fill it at init | 
 | 476 | 		time and reuse that data. Only makes sense if zero_buffers | 
| Jens Axboe | 41ccd84 | 2008-05-22 09:17:33 +0200 | [diff] [blame] | 477 | 		isn't specified, naturally. If data verification is enabled, | 
 | 478 | 		refill_buffers is also automatically enabled. | 
| Jens Axboe | 5973caf | 2008-05-21 19:52:35 +0200 | [diff] [blame] | 479 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 480 | nrfiles=int	Number of files to use for this job. Defaults to 1. | 
 | 481 |  | 
| Jens Axboe | 390b153 | 2007-03-09 13:03:00 +0100 | [diff] [blame] | 482 | openfiles=int	Number of files to keep open at the same time. Defaults to | 
 | 483 | 		the same as nrfiles, can be set smaller to limit the number | 
 | 484 | 		simultaneous opens. | 
 | 485 |  | 
| Jens Axboe | 5af1c6f | 2007-03-01 10:06:10 +0100 | [diff] [blame] | 486 | file_service_type=str  Defines how fio decides which file from a job to | 
 | 487 | 		service next. The following types are defined: | 
 | 488 |  | 
 | 489 | 			random	Just choose a file at random. | 
 | 490 |  | 
 | 491 | 			roundrobin  Round robin over open files. This | 
 | 492 | 				is the default. | 
 | 493 |  | 
| Jens Axboe | a086c25 | 2009-03-04 08:27:37 +0100 | [diff] [blame] | 494 | 			sequential  Finish one file before moving on to | 
 | 495 | 				the next. Multiple files can still be | 
 | 496 | 				open depending on 'openfiles'. | 
 | 497 |  | 
| Jens Axboe | 1907dbc | 2007-03-12 11:44:28 +0100 | [diff] [blame] | 498 | 		The string can have a number appended, indicating how | 
 | 499 | 		often to switch to a new file. So if option random:4 is | 
 | 500 | 		given, fio will switch to a new random file after 4 ios | 
 | 501 | 		have been issued. | 
 | 502 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 503 | ioengine=str	Defines how the job issues io to the file. The following | 
 | 504 | 		types are defined: | 
 | 505 |  | 
 | 506 | 			sync	Basic read(2) or write(2) io. lseek(2) is | 
 | 507 | 				used to position the io location. | 
 | 508 |  | 
| gurudas pai | a31041e | 2007-10-23 15:12:30 +0200 | [diff] [blame] | 509 | 			psync 	Basic pread(2) or pwrite(2) io. | 
 | 510 |  | 
| Gurudas Pai | e05af9e | 2008-02-06 11:16:15 +0100 | [diff] [blame] | 511 | 			vsync	Basic readv(2) or writev(2) IO. | 
| Jens Axboe | 1d2af02 | 2008-02-04 10:59:07 +0100 | [diff] [blame] | 512 |  | 
| Jens Axboe | 15d182a | 2009-01-16 19:15:07 +0100 | [diff] [blame] | 513 | 			libaio	Linux native asynchronous io. Note that Linux | 
 | 514 | 				may only support queued behaviour with | 
 | 515 | 				non-buffered IO (set direct=1 or buffered=0). | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 516 |  | 
 | 517 | 			posixaio glibc posix asynchronous io. | 
 | 518 |  | 
| Jens Axboe | 417f006 | 2008-06-02 11:59:30 +0200 | [diff] [blame] | 519 | 			solarisaio Solaris native asynchronous io. | 
 | 520 |  | 
| Bruce Cran | 03e20d6 | 2011-01-02 20:14:54 +0100 | [diff] [blame] | 521 | 			windowsaio Windows native asynchronous io. | 
 | 522 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 523 | 			mmap	File is memory mapped and data copied | 
 | 524 | 				to/from using memcpy(3). | 
 | 525 |  | 
 | 526 | 			splice	splice(2) is used to transfer the data and | 
 | 527 | 				vmsplice(2) to transfer data from user | 
 | 528 | 				space to the kernel. | 
 | 529 |  | 
| Jens Axboe | d0ff85d | 2007-02-14 01:19:41 +0100 | [diff] [blame] | 530 | 			syslet-rw Use the syslet system calls to make | 
 | 531 | 				regular read/write async. | 
 | 532 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 533 | 			sg	SCSI generic sg v3 io. May either be | 
| Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 534 | 				synchronous using the SG_IO ioctl, or if | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 535 | 				the target is an sg character device | 
 | 536 | 				we use read(2) and write(2) for asynchronous | 
 | 537 | 				io. | 
 | 538 |  | 
| Jens Axboe | a94ea28 | 2006-11-24 12:37:34 +0100 | [diff] [blame] | 539 | 			null	Doesn't transfer any data, just pretends | 
 | 540 | 				to. This is mainly used to exercise fio | 
 | 541 | 				itself and for debugging/testing purposes. | 
 | 542 |  | 
| Jens Axboe | ed92ac0 | 2007-02-06 14:43:52 +0100 | [diff] [blame] | 543 | 			net	Transfer over the network to given host:port. | 
 | 544 | 				'filename' must be set appropriately to | 
| Jens Axboe | 414c2a3 | 2009-01-16 13:21:15 +0100 | [diff] [blame] | 545 | 				filename=host/port/protocol regardless of send | 
| Jens Axboe | ed92ac0 | 2007-02-06 14:43:52 +0100 | [diff] [blame] | 546 | 				or receive, if the latter only the port | 
| Jens Axboe | 414c2a3 | 2009-01-16 13:21:15 +0100 | [diff] [blame] | 547 | 				argument is used. 'host' may be an IP address | 
 | 548 | 				or hostname, port is the port number to be used, | 
 | 549 | 				and protocol may be 'udp' or 'tcp'. If no | 
 | 550 | 				protocol is given, TCP is used. | 
| Jens Axboe | ed92ac0 | 2007-02-06 14:43:52 +0100 | [diff] [blame] | 551 |  | 
| Jens Axboe | 9cce02e | 2007-06-22 15:42:21 +0200 | [diff] [blame] | 552 | 			netsplice Like net, but uses splice/vmsplice to | 
 | 553 | 				map data and send/receive. | 
 | 554 |  | 
| gurudas pai | 53aec0a | 2007-10-05 13:20:18 +0200 | [diff] [blame] | 555 | 			cpuio	Doesn't transfer any data, but burns CPU | 
| Jens Axboe | ba0fbe1 | 2007-03-09 14:34:23 +0100 | [diff] [blame] | 556 | 				cycles according to the cpuload= and | 
 | 557 | 				cpucycle= options. Setting cpuload=85 | 
 | 558 | 				will cause that job to do nothing but burn | 
| Gurudas Pai | 36ecec8 | 2008-02-08 08:50:14 +0100 | [diff] [blame] | 559 | 				85% of the CPU. In case of SMP machines, | 
 | 560 | 				use numjobs=<no_of_cpu> to get desired CPU | 
 | 561 | 				usage, as the cpuload only loads a single | 
 | 562 | 				CPU at the desired rate. | 
| Jens Axboe | ba0fbe1 | 2007-03-09 14:34:23 +0100 | [diff] [blame] | 563 |  | 
| Jens Axboe | e9a1806 | 2007-03-21 08:51:56 +0100 | [diff] [blame] | 564 | 			guasi	The GUASI IO engine is the Generic Userspace | 
 | 565 | 				Asyncronous Syscall Interface approach | 
 | 566 | 				to async IO. See | 
 | 567 |  | 
 | 568 | 				http://www.xmailserver.org/guasi-lib.html | 
 | 569 |  | 
 | 570 | 				for more info on GUASI. | 
 | 571 |  | 
| ren yufei | 21b8aee | 2011-08-01 10:01:57 +0200 | [diff] [blame] | 572 | 			rdma    The RDMA I/O engine  supports  both  RDMA | 
 | 573 | 				memory semantic(RDMA_WRITE/RDMA_READ) and | 
 | 574 | 				channel semantic(Send/Recv) in InfiniBand, RoCE | 
 | 575 | 				and iWarp environment. | 
 | 576 |  | 
| Jens Axboe | 8a7bd87 | 2007-02-28 11:12:25 +0100 | [diff] [blame] | 577 | 			external Prefix to specify loading an external | 
 | 578 | 				IO engine object file. Append the engine | 
 | 579 | 				filename, eg ioengine=external:/tmp/foo.o | 
 | 580 | 				to load ioengine foo.o in /tmp. | 
 | 581 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 582 | iodepth=int	This defines how many io units to keep in flight against | 
 | 583 | 		the file. The default is 1 for each file defined in this | 
 | 584 | 		job, can be overridden with a larger value for higher | 
| Jens Axboe | ee72ca0 | 2010-12-02 20:05:37 +0100 | [diff] [blame] | 585 | 		concurrency. Note that increasing iodepth beyond 1 will not | 
 | 586 | 		affect synchronous ioengines (except for small degress when | 
| Bruce Cran | 9b83656 | 2011-01-08 19:49:54 +0100 | [diff] [blame] | 587 | 		verify_async is in use). Even async engines may impose OS | 
| Jens Axboe | ee72ca0 | 2010-12-02 20:05:37 +0100 | [diff] [blame] | 588 | 		restrictions causing the desired depth not to be achieved. | 
 | 589 | 		This may happen on Linux when using libaio and not setting | 
 | 590 | 		direct=1, since buffered IO is not async on that OS. Keep an | 
 | 591 | 		eye on the IO depth distribution in the fio output to verify | 
 | 592 | 		that the achieved depth is as expected. Default: 1. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 593 |  | 
| Jens Axboe | 4950421 | 2008-06-05 09:03:30 +0200 | [diff] [blame] | 594 | iodepth_batch_submit=int | 
| Jens Axboe | cb5ab51 | 2007-02-26 12:57:09 +0100 | [diff] [blame] | 595 | 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] | 596 | 		It defaults to 1 which means that we submit each IO | 
 | 597 | 		as soon as it is available, but can be raised to submit | 
 | 598 | 		bigger batches of IO at the time. | 
| Jens Axboe | cb5ab51 | 2007-02-26 12:57:09 +0100 | [diff] [blame] | 599 |  | 
| Jens Axboe | 4950421 | 2008-06-05 09:03:30 +0200 | [diff] [blame] | 600 | iodepth_batch_complete=int This defines how many pieces of IO to retrieve | 
 | 601 | 		at once. It defaults to 1 which means that we'll ask | 
 | 602 | 		for a minimum of 1 IO in the retrieval process from | 
 | 603 | 		the kernel. The IO retrieval will go on until we | 
 | 604 | 		hit the limit set by iodepth_low. If this variable is | 
 | 605 | 		set to 0, then fio will always check for completed | 
 | 606 | 		events before queuing more IO. This helps reduce | 
 | 607 | 		IO latency, at the cost of more retrieval system calls. | 
 | 608 |  | 
| Jens Axboe | e916b39 | 2007-02-20 14:37:26 +0100 | [diff] [blame] | 609 | iodepth_low=int	The low water mark indicating when to start filling | 
 | 610 | 		the queue again. Defaults to the same as iodepth, meaning | 
 | 611 | 		that fio will attempt to keep the queue full at all times. | 
 | 612 | 		If iodepth is set to eg 16 and iodepth_low is set to 4, then | 
 | 613 | 		after fio has filled the queue of 16 requests, it will let | 
 | 614 | 		the depth drain down to 4 before starting to fill it again. | 
 | 615 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 616 | 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] | 617 | 		O_DIRECT. Note that ZFS on Solaris doesn't support direct io. | 
| Jens Axboe | 76a43db | 2007-01-11 13:24:44 +0100 | [diff] [blame] | 618 |  | 
 | 619 | buffered=bool	If value is true, use buffered io. This is the opposite | 
 | 620 | 		of the 'direct' option. Defaults to true. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 621 |  | 
| Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 622 | 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] | 623 | 		the given offset will not be touched. This effectively | 
 | 624 | 		caps the file size at real_size - offset. | 
 | 625 |  | 
 | 626 | fsync=int	If writing to a file, issue a sync of the dirty data | 
 | 627 | 		for every number of blocks given. For example, if you give | 
 | 628 | 		32 as a parameter, fio will sync the file for every 32 | 
 | 629 | 		writes issued. If fio is using non-buffered io, we may | 
 | 630 | 		not sync the file. The exception is the sg io engine, which | 
| Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 631 | 		synchronizes the disk cache anyway. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 632 |  | 
| Jens Axboe | e76b1da | 2010-03-09 20:49:54 +0100 | [diff] [blame] | 633 | 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] | 634 | 		metadata blocks. | 
| Joshua Aune | e72fa4d | 2010-02-11 00:59:18 -0700 | [diff] [blame] | 635 | 		In FreeBSD there is no fdatasync(), this falls back to | 
 | 636 | 		using fsync() | 
| Jens Axboe | 5f9099e | 2009-06-16 22:40:26 +0200 | [diff] [blame] | 637 |  | 
| Jens Axboe | e76b1da | 2010-03-09 20:49:54 +0100 | [diff] [blame] | 638 | sync_file_range=str:val	Use sync_file_range() for every 'val' number of | 
 | 639 | 		write operations. Fio will track range of writes that | 
 | 640 | 		have happened since the last sync_file_range() call. 'str' | 
 | 641 | 		can currently be one or more of: | 
 | 642 |  | 
 | 643 | 		wait_before	SYNC_FILE_RANGE_WAIT_BEFORE | 
 | 644 | 		write		SYNC_FILE_RANGE_WRITE | 
 | 645 | 		wait_after	SYNC_FILE_RANGE_WAIT_AFTER | 
 | 646 |  | 
 | 647 | 		So if you do sync_file_range=wait_before,write:8, fio would | 
 | 648 | 		use SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE for | 
 | 649 | 		every 8 writes. Also see the sync_file_range(2) man page. | 
 | 650 | 		This option is Linux specific. | 
 | 651 |  | 
| Jens Axboe | 5036fc1 | 2008-04-15 09:20:46 +0200 | [diff] [blame] | 652 | overwrite=bool	If true, writes to a file will always overwrite existing | 
 | 653 | 		data. If the file doesn't already exist, it will be | 
 | 654 | 		created before the write phase begins. If the file exists | 
 | 655 | 		and is large enough for the specified write phase, nothing | 
 | 656 | 		will be done. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 657 |  | 
 | 658 | end_fsync=bool	If true, fsync file contents when the job exits. | 
 | 659 |  | 
| Jens Axboe | ebb1415 | 2007-03-13 14:42:15 +0100 | [diff] [blame] | 660 | fsync_on_close=bool	If true, fio will fsync() a dirty file on close. | 
 | 661 | 		This differs from end_fsync in that it will happen on every | 
 | 662 | 		file close, not just at the end of the job. | 
 | 663 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 664 | rwmixread=int	How large a percentage of the mix should be reads. | 
 | 665 |  | 
 | 666 | rwmixwrite=int	How large a percentage of the mix should be writes. If both | 
 | 667 | 		rwmixread and rwmixwrite is given and the values do not add | 
 | 668 | 		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] | 669 | 		the first. This may interfere with a given rate setting, | 
 | 670 | 		if fio is asked to limit reads or writes to a certain rate. | 
 | 671 | 		If that is the case, then the distribution may be skewed. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 672 |  | 
| Jens Axboe | bb8895e | 2006-10-30 15:14:48 +0100 | [diff] [blame] | 673 | norandommap	Normally fio will cover every block of the file when doing | 
 | 674 | 		random IO. If this option is given, fio will just get a | 
 | 675 | 		new random offset without looking at past io history. This | 
 | 676 | 		means that some blocks may not be read or written, and that | 
 | 677 | 		some blocks may be read/written more than once. This option | 
| Jens Axboe | 8347239 | 2009-02-19 21:32:12 +0100 | [diff] [blame] | 678 | 		is mutually exclusive with verify= if and only if multiple | 
 | 679 | 		blocksizes (via bsrange=) are used, since fio only tracks | 
 | 680 | 		complete rewrites of blocks. | 
| Jens Axboe | bb8895e | 2006-10-30 15:14:48 +0100 | [diff] [blame] | 681 |  | 
| Jens Axboe | 0408c20 | 2011-08-08 09:07:28 +0200 | [diff] [blame] | 682 | softrandommap=bool See norandommap. If fio runs with the random block map | 
 | 683 | 		enabled and it fails to allocate the map, if this option is | 
 | 684 | 		set it will continue without a random block map. As coverage | 
 | 685 | 		will not be as complete as with random maps, this option is | 
| Jens Axboe | 2b386d2 | 2008-03-26 10:32:57 +0100 | [diff] [blame] | 686 | 		disabled by default. | 
 | 687 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 688 | nice=int	Run the job with the given nice value. See man nice(2). | 
 | 689 |  | 
 | 690 | prio=int	Set the io priority value of this job. Linux limits us to | 
 | 691 | 		a positive value between 0 and 7, with 0 being the highest. | 
 | 692 | 		See man ionice(1). | 
 | 693 |  | 
 | 694 | prioclass=int	Set the io priority class. See man ionice(1). | 
 | 695 |  | 
 | 696 | thinktime=int	Stall the job x microseconds after an io has completed before | 
 | 697 | 		issuing the next. May be used to simulate processing being | 
| Jens Axboe | 48097d5 | 2007-02-17 06:30:44 +0100 | [diff] [blame] | 698 | 		done by an application. See thinktime_blocks and | 
 | 699 | 		thinktime_spin. | 
 | 700 |  | 
 | 701 | thinktime_spin=int | 
 | 702 | 		Only valid if thinktime is set - pretend to spend CPU time | 
 | 703 | 		doing something with the data received, before falling back | 
 | 704 | 		to sleeping for the rest of the period specified by | 
 | 705 | 		thinktime. | 
| Jens Axboe | 9c1f743 | 2007-01-03 20:43:19 +0100 | [diff] [blame] | 706 |  | 
 | 707 | thinktime_blocks | 
 | 708 | 		Only valid if thinktime is set - control how many blocks | 
 | 709 | 		to issue, before waiting 'thinktime' usecs. If not set, | 
 | 710 | 		defaults to 1 which will make fio wait 'thinktime' usecs | 
 | 711 | 		after every block. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 712 |  | 
| Jens Axboe | 581e714 | 2009-06-09 12:47:16 +0200 | [diff] [blame] | 713 | 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] | 714 | 		the normal suffix rules apply. You can use rate=500k to limit | 
| Jens Axboe | 581e714 | 2009-06-09 12:47:16 +0200 | [diff] [blame] | 715 | 		reads and writes to 500k each, or you can specify read and | 
 | 716 | 		writes separately. Using rate=1m,500k would limit reads to | 
 | 717 | 		1MB/sec and writes to 500KB/sec. Capping only reads or | 
 | 718 | 		writes can be done with rate=,500k or rate=500k,. The former | 
 | 719 | 		will only limit writes (to 500KB/sec), the latter will only | 
 | 720 | 		limit reads. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 721 |  | 
 | 722 | 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] | 723 | 		bandwidth. Failing to meet this requirement, will cause | 
| Jens Axboe | 581e714 | 2009-06-09 12:47:16 +0200 | [diff] [blame] | 724 | 		the job to exit. The same format as rate is used for | 
 | 725 | 		read vs write separation. | 
| Jens Axboe | 4e991c2 | 2007-03-15 11:41:11 +0100 | [diff] [blame] | 726 |  | 
 | 727 | rate_iops=int	Cap the bandwidth to this number of IOPS. Basically the same | 
 | 728 | 		as rate, just specified independently of bandwidth. If the | 
 | 729 | 		job is given a block size range instead of a fixed value, | 
| Jens Axboe | 581e714 | 2009-06-09 12:47:16 +0200 | [diff] [blame] | 730 | 		the smallest block size is used as the metric. The same format | 
 | 731 | 		as rate is used for read vs write seperation. | 
| Jens Axboe | 4e991c2 | 2007-03-15 11:41:11 +0100 | [diff] [blame] | 732 |  | 
 | 733 | 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] | 734 | 		the job to exit. The same format as rate is used for read vs | 
 | 735 | 		write seperation. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 736 |  | 
 | 737 | ratecycle=int	Average bandwidth for 'rate' and 'ratemin' over this number | 
| Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 738 | 		of milliseconds. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 739 |  | 
 | 740 | 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] | 741 | 		bitmask of allowed CPU's the job may run on. So if you want | 
 | 742 | 		the allowed CPUs to be 1 and 5, you would pass the decimal | 
 | 743 | 		value of (1 << 1 | 1 << 5), or 34. See man | 
| Jens Axboe | 7dbb6eb | 2007-05-22 09:13:31 +0200 | [diff] [blame] | 744 | 		sched_setaffinity(2). This may not work on all supported | 
| Jens Axboe | b0ea08c | 2008-12-05 12:57:11 +0100 | [diff] [blame] | 745 | 		operating systems or kernel versions. This option doesn't | 
 | 746 | 		work well for a higher CPU count than what you can store in | 
 | 747 | 		an integer mask, so it can only control cpus 1-32. For | 
 | 748 | 		boxes with larger CPU counts, use cpus_allowed. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 749 |  | 
| Jens Axboe | d2e268b | 2007-06-15 10:33:49 +0200 | [diff] [blame] | 750 | cpus_allowed=str Controls the same options as cpumask, but it allows a text | 
 | 751 | 		setting of the permitted CPUs instead. So to use CPUs 1 and | 
| Jens Axboe | 62a7273 | 2008-12-08 11:37:01 +0100 | [diff] [blame] | 752 | 		5, you would specify cpus_allowed=1,5. This options also | 
 | 753 | 		allows a range of CPUs. Say you wanted a binding to CPUs | 
 | 754 | 		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] | 755 |  | 
| Jens Axboe | e417fd6 | 2008-09-11 09:27:15 +0200 | [diff] [blame] | 756 | startdelay=time	Start this job the specified number of seconds after fio | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 757 | 		has started. Only useful if the job file contains several | 
 | 758 | 		jobs, and you want to delay starting some jobs to a certain | 
 | 759 | 		time. | 
 | 760 |  | 
| Jens Axboe | e417fd6 | 2008-09-11 09:27:15 +0200 | [diff] [blame] | 761 | runtime=time	Tell fio to terminate processing after the specified number | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 762 | 		of seconds. It can be quite hard to determine for how long | 
 | 763 | 		a specified job will run, so this parameter is handy to | 
 | 764 | 		cap the total runtime to a given time. | 
 | 765 |  | 
| Jens Axboe | cf4464c | 2007-04-17 20:14:42 +0200 | [diff] [blame] | 766 | 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] | 767 | 		specified even if the file(s) are completely read or | 
| Jens Axboe | cf4464c | 2007-04-17 20:14:42 +0200 | [diff] [blame] | 768 | 		written. It will simply loop over the same workload | 
 | 769 | 		as many times as the runtime allows. | 
 | 770 |  | 
| Jens Axboe | e417fd6 | 2008-09-11 09:27:15 +0200 | [diff] [blame] | 771 | 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] | 772 | 		of time before logging any performance numbers. Useful for | 
 | 773 | 		letting performance settle before logging results, thus | 
| Jens Axboe | b29ee5b | 2008-09-11 10:17:26 +0200 | [diff] [blame] | 774 | 		minimizing the runtime required for stable results. Note | 
 | 775 | 		that the ramp_time is considered lead in time for a job, | 
 | 776 | 		thus it will increase the total runtime if a special timeout | 
 | 777 | 		or runtime is specified. | 
| Jens Axboe | 721938a | 2008-09-10 09:46:16 +0200 | [diff] [blame] | 778 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 779 | invalidate=bool	Invalidate the buffer/page cache parts for this file prior | 
 | 780 | 		to starting io. Defaults to true. | 
 | 781 |  | 
 | 782 | sync=bool	Use sync io for buffered writes. For the majority of the | 
 | 783 | 		io engines, this means using O_SYNC. | 
 | 784 |  | 
| Jens Axboe | d3aad8f | 2007-03-15 14:12:05 +0100 | [diff] [blame] | 785 | iomem=str | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 786 | mem=str		Fio can use various types of memory as the io unit buffer. | 
 | 787 | 		The allowed values are: | 
 | 788 |  | 
 | 789 | 			malloc	Use memory from malloc(3) as the buffers. | 
 | 790 |  | 
 | 791 | 			shm	Use shared memory as the buffers. Allocated | 
 | 792 | 				through shmget(2). | 
 | 793 |  | 
| Jens Axboe | 74b025b | 2006-12-19 15:18:14 +0100 | [diff] [blame] | 794 | 			shmhuge	Same as shm, but use huge pages as backing. | 
 | 795 |  | 
| Jens Axboe | 313cb20 | 2006-12-21 09:50:00 +0100 | [diff] [blame] | 796 | 			mmap	Use mmap to allocate buffers. May either be | 
 | 797 | 				anonymous memory, or can be file backed if | 
 | 798 | 				a filename is given after the option. The | 
 | 799 | 				format is mem=mmap:/path/to/file. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 800 |  | 
| Jens Axboe | d0bdaf4 | 2006-12-20 14:40:44 +0100 | [diff] [blame] | 801 | 			mmaphuge Use a memory mapped huge file as the buffer | 
 | 802 | 				backing. Append filename after mmaphuge, ala | 
 | 803 | 				mem=mmaphuge:/hugetlbfs/file | 
 | 804 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 805 | 		The area allocated is a function of the maximum allowed | 
| Jens Axboe | 5394ae5 | 2006-12-20 20:15:41 +0100 | [diff] [blame] | 806 | 		bs size for the job, multiplied by the io depth given. Note | 
 | 807 | 		that for shmhuge and mmaphuge to work, the system must have | 
 | 808 | 		free huge pages allocated. This can normally be checked | 
 | 809 | 		and set by reading/writing /proc/sys/vm/nr_hugepages on a | 
| Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 810 | 		Linux system. Fio assumes a huge page is 4MB in size. So | 
| Jens Axboe | 5394ae5 | 2006-12-20 20:15:41 +0100 | [diff] [blame] | 811 | 		to calculate the number of huge pages you need for a given | 
 | 812 | 		job file, add up the io depth of all jobs (normally one unless | 
 | 813 | 		iodepth= is used) and multiply by the maximum bs set. Then | 
 | 814 | 		divide that number by the huge page size. You can see the | 
 | 815 | 		size of the huge pages in /proc/meminfo. If no huge pages | 
 | 816 | 		are allocated by having a non-zero number in nr_hugepages, | 
| Jens Axboe | 56bb17f | 2006-12-20 20:27:36 +0100 | [diff] [blame] | 817 | 		using mmaphuge or shmhuge will fail. Also see hugepage-size. | 
| Jens Axboe | 5394ae5 | 2006-12-20 20:15:41 +0100 | [diff] [blame] | 818 |  | 
 | 819 | 		mmaphuge also needs to have hugetlbfs mounted and the file | 
 | 820 | 		location should point there. So if it's mounted in /huge, | 
 | 821 | 		you would use mem=mmaphuge:/huge/somefile. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 822 |  | 
| Jens Axboe | d529ee1 | 2009-07-01 10:33:03 +0200 | [diff] [blame] | 823 | iomem_align=int	This indiciates the memory alignment of the IO memory buffers. | 
 | 824 | 		Note that the given alignment is applied to the first IO unit | 
 | 825 | 		buffer, if using iodepth the alignment of the following buffers | 
 | 826 | 		are given by the bs used. In other words, if using a bs that is | 
 | 827 | 		a multiple of the page sized in the system, all buffers will | 
 | 828 | 		be aligned to this value. If using a bs that is not page | 
 | 829 | 		aligned, the alignment of subsequent IO memory buffers is the | 
 | 830 | 		sum of the iomem_align and bs used. | 
 | 831 |  | 
| Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 832 | hugepage-size=int | 
| Jens Axboe | 56bb17f | 2006-12-20 20:27:36 +0100 | [diff] [blame] | 833 | 		Defines the size of a huge page. Must at least be equal | 
| Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 834 | 		to the system setting, see /proc/meminfo. Defaults to 4MB. | 
| Jens Axboe | c51074e | 2006-12-20 20:28:33 +0100 | [diff] [blame] | 835 | 		Should probably always be a multiple of megabytes, so using | 
 | 836 | 		hugepage-size=Xm is the preferred way to set this to avoid | 
 | 837 | 		setting a non-pow-2 bad value. | 
| Jens Axboe | 56bb17f | 2006-12-20 20:27:36 +0100 | [diff] [blame] | 838 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 839 | exitall		When one job finishes, terminate the rest. The default is | 
 | 840 | 		to wait for each job to finish, sometimes that is not the | 
 | 841 | 		desired action. | 
 | 842 |  | 
 | 843 | bwavgtime=int	Average the calculated bandwidth over the given time. Value | 
| Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 844 | 		is specified in milliseconds. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 845 |  | 
 | 846 | create_serialize=bool	If true, serialize the file creating for the jobs. | 
 | 847 | 			This may be handy to avoid interleaving of data | 
 | 848 | 			files, which may greatly depend on the filesystem | 
 | 849 | 			used and even the number of processors in the system. | 
 | 850 |  | 
 | 851 | create_fsync=bool	fsync the data file after creation. This is the | 
 | 852 | 			default. | 
 | 853 |  | 
| Jens Axboe | 814452b | 2009-03-04 12:53:13 +0100 | [diff] [blame] | 854 | create_on_open=bool	Don't pre-setup the files for IO, just create open() | 
 | 855 | 			when it's time to do IO to that file. | 
 | 856 |  | 
| Zhang, Yanmin | afad68f | 2009-05-20 11:30:55 +0200 | [diff] [blame] | 857 | 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] | 858 | 		starting the given IO operation. This will also clear | 
 | 859 | 		the 'invalidate' flag, since it is pointless to pre-read | 
| Jens Axboe | 9c0d224 | 2009-07-01 12:26:28 +0200 | [diff] [blame] | 860 | 		and then drop the cache. This will only work for IO engines | 
 | 861 | 		that are seekable, since they allow you to read the same data | 
 | 862 | 		multiple times. Thus it will not work on eg network or splice | 
 | 863 | 		IO. | 
| Zhang, Yanmin | afad68f | 2009-05-20 11:30:55 +0200 | [diff] [blame] | 864 |  | 
| Jens Axboe | e545a6c | 2007-01-14 00:00:29 +0100 | [diff] [blame] | 865 | 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] | 866 | 		runs of that job would then waste time recreating the file | 
 | 867 | 		set again and again. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 868 |  | 
 | 869 | loops=int	Run the specified number of iterations of this job. Used | 
 | 870 | 		to repeat the same workload a given number of times. Defaults | 
 | 871 | 		to 1. | 
 | 872 |  | 
| Jens Axboe | 68e1f29 | 2007-08-10 10:32:14 +0200 | [diff] [blame] | 873 | 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] | 874 | 		verify is set. Defaults to 1. | 
 | 875 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 876 | verify=str	If writing to a file, fio can verify the file contents | 
 | 877 | 		after each iteration of the job. The allowed values are: | 
 | 878 |  | 
 | 879 | 			md5	Use an md5 sum of the data area and store | 
 | 880 | 				it in the header of each block. | 
 | 881 |  | 
| Jens Axboe | 17dc34d | 2007-07-27 15:36:02 +0200 | [diff] [blame] | 882 | 			crc64	Use an experimental crc64 sum of the data | 
 | 883 | 				area and store it in the header of each | 
 | 884 | 				block. | 
 | 885 |  | 
| Jens Axboe | bac39e0 | 2008-06-11 20:46:19 +0200 | [diff] [blame] | 886 | 			crc32c	Use a crc32c sum of the data area and store | 
 | 887 | 				it in the header of each block. | 
 | 888 |  | 
| Jens Axboe | 3845591 | 2008-08-04 15:35:26 +0200 | [diff] [blame] | 889 | 			crc32c-intel Use hardware assisted crc32c calcuation | 
| Jens Axboe | 0539d75 | 2010-06-21 15:22:56 +0200 | [diff] [blame] | 890 | 				provided on SSE4.2 enabled processors. Falls | 
 | 891 | 				back to regular software crc32c, if not | 
 | 892 | 				supported by the system. | 
| Jens Axboe | 3845591 | 2008-08-04 15:35:26 +0200 | [diff] [blame] | 893 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 894 | 			crc32	Use a crc32 sum of the data area and store | 
 | 895 | 				it in the header of each block. | 
 | 896 |  | 
| Jens Axboe | 969f7ed | 2007-07-27 09:07:17 +0200 | [diff] [blame] | 897 | 			crc16	Use a crc16 sum of the data area and store | 
 | 898 | 				it in the header of each block. | 
 | 899 |  | 
| Jens Axboe | 17dc34d | 2007-07-27 15:36:02 +0200 | [diff] [blame] | 900 | 			crc7	Use a crc7 sum of the data area and store | 
 | 901 | 				it in the header of each block. | 
 | 902 |  | 
| Jens Axboe | cd14cc1 | 2007-07-30 10:59:33 +0200 | [diff] [blame] | 903 | 			sha512	Use sha512 as the checksum function. | 
 | 904 |  | 
 | 905 | 			sha256	Use sha256 as the checksum function. | 
 | 906 |  | 
| Jens Axboe | 7c353ce | 2009-08-09 22:40:33 +0200 | [diff] [blame] | 907 | 			sha1	Use optimized sha1 as the checksum function. | 
 | 908 |  | 
| Shawn Lewis | 7437ee8 | 2007-08-02 21:05:58 +0200 | [diff] [blame] | 909 | 			meta	Write extra information about each io | 
 | 910 | 				(timestamp, block number etc.). The block | 
| Jens Axboe | 996093b | 2010-06-24 08:37:13 +0200 | [diff] [blame] | 911 | 				number is verified. See also verify_pattern. | 
| Shawn Lewis | 7437ee8 | 2007-08-02 21:05:58 +0200 | [diff] [blame] | 912 |  | 
| Jens Axboe | 36690c9 | 2007-03-26 10:23:34 +0200 | [diff] [blame] | 913 | 			null	Only pretend to verify. Useful for testing | 
 | 914 | 				internals with ioengine=null, not for much | 
 | 915 | 				else. | 
 | 916 |  | 
| Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 917 | 		This option can be used for repeated burn-in tests of a | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 918 | 		system to make sure that the written data is also | 
| Jens Axboe | b892dc0 | 2009-09-05 20:37:35 +0200 | [diff] [blame] | 919 | 		correctly read back. If the data direction given is | 
 | 920 | 		a read or random read, fio will assume that it should | 
 | 921 | 		verify a previously written file. If the data direction | 
 | 922 | 		includes any form of write, the verify will be of the | 
 | 923 | 		newly written data. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 924 |  | 
| Jens Axboe | 160b966 | 2007-03-27 10:59:49 +0200 | [diff] [blame] | 925 | verifysort=bool	If set, fio will sort written verify blocks when it deems | 
 | 926 | 		it faster to read them back in a sorted manner. This is | 
 | 927 | 		often the case when overwriting an existing file, since | 
 | 928 | 		the blocks are already laid out in the file system. You | 
 | 929 | 		can ignore this option unless doing huge amounts of really | 
 | 930 | 		fast IO where the red-black tree sorting CPU time becomes | 
 | 931 | 		significant. | 
| Shawn Lewis | 3f9f4e2 | 2007-07-28 21:10:37 +0200 | [diff] [blame] | 932 |  | 
| Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 933 | verify_offset=int	Swap the verification header with data somewhere else | 
| Shawn Lewis | 546a914 | 2007-07-28 21:11:37 +0200 | [diff] [blame] | 934 | 			in the block before writing. Its swapped back before | 
 | 935 | 			verifying. | 
 | 936 |  | 
| Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 937 | verify_interval=int	Write the verification header at a finer granularity | 
| Shawn Lewis | 3f9f4e2 | 2007-07-28 21:10:37 +0200 | [diff] [blame] | 938 | 			than the blocksize. It will be written for chunks the | 
 | 939 | 			size of header_interval. blocksize should divide this | 
 | 940 | 			evenly. | 
| Jens Axboe | 90059d6 | 2007-07-30 09:33:12 +0200 | [diff] [blame] | 941 |  | 
| Radha Ramachandran | 0e92f87 | 2009-10-27 20:14:27 +0100 | [diff] [blame] | 942 | 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] | 943 | 		pattern. Fio defaults to filling with totally random | 
 | 944 | 		bytes, but sometimes it's interesting to fill with a known | 
 | 945 | 		pattern for io verification purposes. Depending on the | 
 | 946 | 		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] | 947 | 		buffer at the time(it can be either a decimal or a hex number). | 
 | 948 | 		The verify_pattern if larger than a 32-bit quantity has to | 
| Jens Axboe | 996093b | 2010-06-24 08:37:13 +0200 | [diff] [blame] | 949 | 		be a hex number that starts with either "0x" or "0X". Use | 
 | 950 | 		with verify=meta. | 
| Shawn Lewis | e28218f | 2008-01-16 11:01:33 +0100 | [diff] [blame] | 951 |  | 
| Jens Axboe | 68e1f29 | 2007-08-10 10:32:14 +0200 | [diff] [blame] | 952 | verify_fatal=bool	Normally fio will keep checking the entire contents | 
| Jens Axboe | a12a3b4 | 2007-08-09 10:20:54 +0200 | [diff] [blame] | 953 | 		before quitting on a block verification failure. If this | 
 | 954 | 		option is set, fio will exit the job on the first observed | 
 | 955 | 		failure. | 
| Jens Axboe | e8462bd | 2009-07-06 12:59:04 +0200 | [diff] [blame] | 956 |  | 
| Jens Axboe | b463e93 | 2011-01-12 09:03:23 +0100 | [diff] [blame] | 957 | verify_dump=bool	If set, dump the contents of both the original data | 
 | 958 | 		block and the data block we read off disk to files. This | 
 | 959 | 		allows later analysis to inspect just what kind of data | 
 | 960 | 		corruption occurred. On by default. | 
 | 961 |  | 
| Jens Axboe | e8462bd | 2009-07-06 12:59:04 +0200 | [diff] [blame] | 962 | verify_async=int	Fio will normally verify IO inline from the submitting | 
 | 963 | 		thread. This option takes an integer describing how many | 
 | 964 | 		async offload threads to create for IO verification instead, | 
 | 965 | 		causing fio to offload the duty of verifying IO contents | 
| Jens Axboe | c85c324 | 2009-07-06 14:12:57 +0200 | [diff] [blame] | 966 | 		to one or more separate threads. If using this offload | 
 | 967 | 		option, even sync IO engines can benefit from using an | 
 | 968 | 		iodepth setting higher than 1, as it allows them to have | 
 | 969 | 		IO in flight while verifies are running. | 
| Jens Axboe | e8462bd | 2009-07-06 12:59:04 +0200 | [diff] [blame] | 970 |  | 
 | 971 | verify_async_cpus=str	Tell fio to set the given CPU affinity on the | 
 | 972 | 		async IO verification threads. See cpus_allowed for the | 
 | 973 | 		format used. | 
| Jens Axboe | 6f87418 | 2010-06-21 12:53:26 +0200 | [diff] [blame] | 974 |  | 
 | 975 | verify_backlog=int	Fio will normally verify the written contents of a | 
 | 976 | 		job that utilizes verify once that job has completed. In | 
 | 977 | 		other words, everything is written then everything is read | 
 | 978 | 		back and verified. You may want to verify continually | 
 | 979 | 		instead for a variety of reasons. Fio stores the meta data | 
 | 980 | 		associated with an IO block in memory, so for large | 
 | 981 | 		verify workloads, quite a bit of memory would be used up | 
 | 982 | 		holding this meta data. If this option is enabled, fio | 
| Jens Axboe | f42195a | 2010-10-26 08:10:58 -0600 | [diff] [blame] | 983 | 		will write only N blocks before verifying these blocks. | 
 | 984 |  | 
| Jens Axboe | 6f87418 | 2010-06-21 12:53:26 +0200 | [diff] [blame] | 985 | 		will verify the previously written blocks before continuing | 
 | 986 | 		to write new ones. | 
 | 987 |  | 
 | 988 | verify_backlog_batch=int	Control how many blocks fio will verify | 
 | 989 | 		if verify_backlog is set. If not set, will default to | 
 | 990 | 		the value of verify_backlog (meaning the entire queue | 
| Jens Axboe | f42195a | 2010-10-26 08:10:58 -0600 | [diff] [blame] | 991 | 		is read back and verified).  If verify_backlog_batch is | 
 | 992 | 		less than verify_backlog then not all blocks will be verified, | 
 | 993 | 		if verify_backlog_batch is larger than verify_backlog, some | 
 | 994 | 		blocks will be verified more than once. | 
| Jens Axboe | 160b966 | 2007-03-27 10:59:49 +0200 | [diff] [blame] | 995 | 		 | 
| Jens Axboe | d392365 | 2011-08-03 12:38:39 +0200 | [diff] [blame] | 996 | stonewall | 
 | 997 | wait_for_previous Wait for preceeding jobs in the job file to exit, before | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 998 | 		starting this one. Can be used to insert serialization | 
| Jens Axboe | b3d62a7 | 2007-03-20 14:23:26 +0100 | [diff] [blame] | 999 | 		points in the job file. A stone wall also implies starting | 
 | 1000 | 		a new reporting group. | 
 | 1001 |  | 
 | 1002 | new_group	Start a new reporting group. If this option isn't given, | 
 | 1003 | 		jobs in a file will be part of the same reporting group | 
| Jens Axboe | bf9a3ed | 2008-06-05 11:53:08 +0200 | [diff] [blame] | 1004 | 		unless separated by a stone wall (or if it's a group | 
| Jens Axboe | b3d62a7 | 2007-03-20 14:23:26 +0100 | [diff] [blame] | 1005 | 		by itself, with the numjobs option). | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1006 |  | 
 | 1007 | numjobs=int	Create the specified number of clones of this job. May be | 
 | 1008 | 		used to setup a larger number of threads/processes doing | 
| Jens Axboe | fa28c85 | 2007-03-06 15:40:49 +0100 | [diff] [blame] | 1009 | 		the same thing. We regard that grouping of jobs as a | 
 | 1010 | 		specific group. | 
 | 1011 |  | 
 | 1012 | group_reporting	If 'numjobs' is set, it may be interesting to display | 
 | 1013 | 		statistics for the group as a whole instead of for each | 
 | 1014 | 		individual job. This is especially true of 'numjobs' is | 
 | 1015 | 		large, looking at individual thread/process output quickly | 
 | 1016 | 		becomes unwieldy. If 'group_reporting' is specified, fio | 
 | 1017 | 		will show the final report per-group instead of per-job. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1018 |  | 
 | 1019 | thread		fio defaults to forking jobs, however if this option is | 
 | 1020 | 		given, fio will use pthread_create(3) to create threads | 
 | 1021 | 		instead. | 
 | 1022 |  | 
| Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 1023 | 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] | 1024 |  | 
| Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 1025 | zoneskip=int	Skip the specified number of bytes when zonesize data has | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1026 | 		been read. The two zone options can be used to only do | 
 | 1027 | 		io on zones of a file. | 
 | 1028 |  | 
| Jens Axboe | 076efc7 | 2006-10-27 11:24:25 +0200 | [diff] [blame] | 1029 | 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] | 1030 | 		read_iolog.  Specify a separate file for each job, otherwise | 
 | 1031 | 		the iologs will be interspersed and the file may be corrupt. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1032 |  | 
| Jens Axboe | 076efc7 | 2006-10-27 11:24:25 +0200 | [diff] [blame] | 1033 | 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] | 1034 | 		io patterns it contains. This can be used to store a | 
| Jens Axboe | 6df8ada | 2007-05-15 13:23:19 +0200 | [diff] [blame] | 1035 | 		workload and replay it sometime later. The iolog given | 
 | 1036 | 		may also be a blktrace binary file, which allows fio | 
 | 1037 | 		to replay a workload captured by blktrace. See blktrace | 
 | 1038 | 		for how to capture such logging data. For blktrace replay, | 
 | 1039 | 		the file needs to be turned into a blkparse binary data | 
| Jens Axboe | ea3e51c | 2010-05-17 19:51:45 +0200 | [diff] [blame] | 1040 | 		file first (blkparse <device> -o /dev/null -d file_for_fio.bin). | 
| David Nellans | 64bbb86 | 2010-08-24 22:13:30 +0200 | [diff] [blame] | 1041 | 		 | 
 | 1042 | 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] | 1043 | 		is to attempt to respect the time stamps within the log and | 
 | 1044 | 		replay them with the appropriate delay between IOPS.  By | 
 | 1045 | 		setting this variable fio will not respect the timestamps and | 
 | 1046 | 		attempt to replay them as fast as possible while still | 
 | 1047 | 		respecting ordering.  The result is the same I/O pattern to a | 
 | 1048 | 		given device, but different timings. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1049 |  | 
| David Nellans | d1c46c0 | 2010-08-31 21:20:47 +0200 | [diff] [blame] | 1050 | replay_redirect=str While replaying I/O patterns using read_iolog the | 
 | 1051 | 		default behavior is to replay the IOPS onto the major/minor | 
 | 1052 | 		device that each IOP was recorded from.  This is sometimes | 
 | 1053 | 		undesireable because on a different machine those major/minor | 
 | 1054 | 		numbers can map to a different device.  Changing hardware on | 
 | 1055 | 		the same system can also result in a different major/minor | 
 | 1056 | 		mapping.  Replay_redirect causes all IOPS to be replayed onto | 
 | 1057 | 		the single specified device regardless of the device it was | 
 | 1058 | 		recorded from. i.e. replay_redirect=/dev/sdc would cause all | 
 | 1059 | 		IO in the blktrace to be replayed onto /dev/sdc.  This means | 
 | 1060 | 		multiple devices will be replayed onto a single, if the trace | 
 | 1061 | 		contains multiple devices.  If you want multiple devices to be | 
 | 1062 | 		replayed concurrently to multiple redirected devices you must | 
 | 1063 | 		blkparse your trace into separate traces and replay them with | 
 | 1064 | 		independent fio invocations.  Unfortuantely this also breaks | 
 | 1065 | 		the strict time ordering between multiple device accesses. | 
 | 1066 |  | 
| Jens Axboe | e3cedca | 2008-11-19 19:57:52 +0100 | [diff] [blame] | 1067 | 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] | 1068 | 		file. Can be used to store data of the bandwidth of the | 
| Jens Axboe | e0da9bc | 2006-10-25 13:08:57 +0200 | [diff] [blame] | 1069 | 		jobs in their lifetime. The included fio_generate_plots | 
 | 1070 | 		script uses gnuplot to turn these text files into nice | 
| Jens Axboe | e3cedca | 2008-11-19 19:57:52 +0100 | [diff] [blame] | 1071 | 		graphs. See write_log_log for behaviour of given | 
 | 1072 | 		filename. For this option, the postfix is _bw.log. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1073 |  | 
| Jens Axboe | e3cedca | 2008-11-19 19:57:52 +0100 | [diff] [blame] | 1074 | 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] | 1075 | 		submission, completion, and total latencies instead. If no | 
 | 1076 | 		filename is given with this option, the default filename of | 
 | 1077 | 		"jobname_type.log" is used. Even if the filename is given, | 
 | 1078 | 		fio will still append the type of log. So if one specifies | 
| Jens Axboe | e3cedca | 2008-11-19 19:57:52 +0100 | [diff] [blame] | 1079 |  | 
 | 1080 | 		write_lat_log=foo | 
 | 1081 |  | 
| Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1082 | 		The actual log names will be foo_slat.log, foo_slat.log, | 
 | 1083 | 		and foo_lat.log. This helps fio_generate_plot fine the logs | 
 | 1084 | 		automatically. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1085 |  | 
| Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 1086 | 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] | 1087 | 		potentially be used instead of removing memory or booting | 
 | 1088 | 		with less memory to simulate a smaller amount of memory. | 
 | 1089 |  | 
 | 1090 | exec_prerun=str	Before running this job, issue the command specified | 
 | 1091 | 		through system(3). | 
 | 1092 |  | 
 | 1093 | exec_postrun=str After the job completes, issue the command specified | 
 | 1094 | 		 though system(3). | 
 | 1095 |  | 
 | 1096 | ioscheduler=str	Attempt to switch the device hosting the file to the specified | 
 | 1097 | 		io scheduler before running. | 
 | 1098 |  | 
 | 1099 | cpuload=int	If the job is a CPU cycle eater, attempt to use the specified | 
 | 1100 | 		percentage of CPU cycles. | 
 | 1101 |  | 
 | 1102 | cpuchunks=int	If the job is a CPU cycle eater, split the load into | 
| Randy Dunlap | 26eca2d | 2009-05-13 07:50:38 +0200 | [diff] [blame] | 1103 | 		cycles of the given time. In microseconds. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1104 |  | 
| Jens Axboe | 0a839f3 | 2007-04-26 09:02:34 +0200 | [diff] [blame] | 1105 | disk_util=bool	Generate disk utilization statistics, if the platform | 
 | 1106 | 		supports it. Defaults to on. | 
 | 1107 |  | 
| Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1108 | disable_lat=bool Disable measurements of total latency numbers. Useful | 
| Jens Axboe | 9520ebb | 2008-10-16 21:03:27 +0200 | [diff] [blame] | 1109 | 		only for cutting back the number of calls to gettimeofday, | 
 | 1110 | 		as that does impact performance at really high IOPS rates. | 
 | 1111 | 		Note that to really get rid of a large amount of these | 
 | 1112 | 		calls, this option must be used with disable_slat and | 
 | 1113 | 		disable_bw as well. | 
 | 1114 |  | 
| Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1115 | disable_clat=bool Disable measurements of completion latency numbers. See | 
 | 1116 | 		disable_lat. | 
 | 1117 |  | 
| Jens Axboe | 9520ebb | 2008-10-16 21:03:27 +0200 | [diff] [blame] | 1118 | disable_slat=bool Disable measurements of submission latency numbers. See | 
| Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1119 | 		disable_slat. | 
| Jens Axboe | 9520ebb | 2008-10-16 21:03:27 +0200 | [diff] [blame] | 1120 |  | 
 | 1121 | disable_bw=bool	Disable measurements of throughput/bandwidth numbers. See | 
| Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1122 | 		disable_lat. | 
| Jens Axboe | 9520ebb | 2008-10-16 21:03:27 +0200 | [diff] [blame] | 1123 |  | 
| Yu-ju Hong | 8334919 | 2011-08-13 00:53:44 +0200 | [diff] [blame^] | 1124 | clat_percentiles=bool Enable the reporting of percentiles of | 
 | 1125 | 		 completion latencies. | 
 | 1126 |  | 
 | 1127 | percentile_list=float_list Overwrite the default list of percentiles | 
 | 1128 | 		for completion latencies. Each number is a floating | 
 | 1129 | 		number in the range (0,100], and the maximum length of | 
 | 1130 | 		the list is 20. Use ':' to separate the numbers, and | 
 | 1131 | 		list the numbers in ascending order. For example, | 
 | 1132 | 		--percentile_list=99.5:99.9 will cause fio to report | 
 | 1133 | 		the values of completion latency below which 99.5% and | 
 | 1134 | 		99.9% of the observed latencies fell, respectively. | 
 | 1135 |  | 
| Jens Axboe | 993bf48 | 2008-11-14 13:04:53 +0100 | [diff] [blame] | 1136 | gtod_reduce=bool Enable all of the gettimeofday() reducing options | 
 | 1137 | 		(disable_clat, disable_slat, disable_bw) plus reduce | 
 | 1138 | 		precision of the timeout somewhat to really shrink | 
 | 1139 | 		the gettimeofday() call count. With this option enabled, | 
 | 1140 | 		we only do about 0.4% of the gtod() calls we would have | 
 | 1141 | 		done if all time keeping was enabled. | 
 | 1142 |  | 
| Jens Axboe | be4ecfd | 2008-12-08 14:10:52 +0100 | [diff] [blame] | 1143 | gtod_cpu=int	Sometimes it's cheaper to dedicate a single thread of | 
 | 1144 | 		execution to just getting the current time. Fio (and | 
 | 1145 | 		databases, for instance) are very intensive on gettimeofday() | 
 | 1146 | 		calls. With this option, you can set one CPU aside for | 
 | 1147 | 		doing nothing but logging current time to a shared memory | 
 | 1148 | 		location. Then the other threads/processes that run IO | 
 | 1149 | 		workloads need only copy that segment, instead of entering | 
 | 1150 | 		the kernel with a gettimeofday() call. The CPU set aside | 
 | 1151 | 		for doing these time calls will be excluded from other | 
 | 1152 | 		uses. Fio will manually clear it from the CPU mask of other | 
 | 1153 | 		jobs. | 
| Jens Axboe | a696fa2 | 2009-12-04 10:05:02 +0100 | [diff] [blame] | 1154 |  | 
| Radha Ramachandran | f2bba18 | 2009-06-15 08:40:16 +0200 | [diff] [blame] | 1155 | continue_on_error=bool	Normally fio will exit the job on the first observed | 
 | 1156 | 		failure. If this option is set, fio will continue the job when | 
 | 1157 | 		there is a 'non-fatal error' (EIO or EILSEQ) until the runtime | 
 | 1158 | 		is exceeded or the I/O size specified is completed. If this | 
 | 1159 | 		option is used, there are two more stats that are appended, | 
 | 1160 | 		the total error count and the first error. The error field | 
 | 1161 | 		given in the stats is the first error that was hit during the | 
 | 1162 | 		run. | 
| Jens Axboe | be4ecfd | 2008-12-08 14:10:52 +0100 | [diff] [blame] | 1163 |  | 
| Jens Axboe | 6adb38a | 2009-12-07 08:01:26 +0100 | [diff] [blame] | 1164 | cgroup=str	Add job to this control group. If it doesn't exist, it will | 
 | 1165 | 		be created. The system must have a mounted cgroup blkio | 
 | 1166 | 		mount point for this to work. If your system doesn't have it | 
 | 1167 | 		mounted, you can do so with: | 
| Jens Axboe | a696fa2 | 2009-12-04 10:05:02 +0100 | [diff] [blame] | 1168 |  | 
 | 1169 | 		# mount -t cgroup -o blkio none /cgroup | 
 | 1170 |  | 
| Jens Axboe | a696fa2 | 2009-12-04 10:05:02 +0100 | [diff] [blame] | 1171 | cgroup_weight=int	Set the weight of the cgroup to this value. See | 
 | 1172 | 		the documentation that comes with the kernel, allowed values | 
 | 1173 | 		are in the range of 100..1000. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1174 |  | 
| Vivek Goyal | 7de8709 | 2010-03-31 22:55:15 +0200 | [diff] [blame] | 1175 | cgroup_nodelete=bool Normally fio will delete the cgroups it has created after | 
 | 1176 | 		the job completion. To override this behavior and to leave | 
 | 1177 | 		cgroups around after the job completion, set cgroup_nodelete=1. | 
 | 1178 | 		This can be useful if one wants to inspect various cgroup | 
 | 1179 | 		files after job completion. Default: false | 
 | 1180 |  | 
| Jens Axboe | e0b0d89 | 2009-12-08 10:10:14 +0100 | [diff] [blame] | 1181 | uid=int		Instead of running as the invoking user, set the user ID to | 
 | 1182 | 		this value before the thread/process does any work. | 
 | 1183 |  | 
 | 1184 | gid=int		Set group ID, see uid. | 
 | 1185 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1186 | 6.0 Interpreting the output | 
 | 1187 | --------------------------- | 
 | 1188 |  | 
 | 1189 | fio spits out a lot of output. While running, fio will display the | 
 | 1190 | status of the jobs created. An example of that would be: | 
 | 1191 |  | 
| Jens Axboe | 73c8b08 | 2007-01-11 19:25:52 +0100 | [diff] [blame] | 1192 | 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] | 1193 |  | 
 | 1194 | The characters inside the square brackets denote the current status of | 
 | 1195 | each thread. The possible values (in typical life cycle order) are: | 
 | 1196 |  | 
 | 1197 | Idle	Run | 
 | 1198 | ----    --- | 
 | 1199 | P		Thread setup, but not started. | 
 | 1200 | C		Thread created. | 
 | 1201 | I		Thread initialized, waiting. | 
| Jens Axboe | b0f6586 | 2009-05-20 11:52:15 +0200 | [diff] [blame] | 1202 | 	p	Thread running pre-reading file(s). | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1203 | 	R	Running, doing sequential reads. | 
 | 1204 | 	r	Running, doing random reads. | 
 | 1205 | 	W	Running, doing sequential writes. | 
 | 1206 | 	w	Running, doing random writes. | 
 | 1207 | 	M	Running, doing mixed sequential reads/writes. | 
 | 1208 | 	m	Running, doing mixed random reads/writes. | 
 | 1209 | 	F	Running, currently waiting for fsync() | 
| Jens Axboe | fc6bd43 | 2009-04-29 09:52:10 +0200 | [diff] [blame] | 1210 | 	V	Running, doing verification of written data. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1211 | E		Thread exited, not reaped by main thread yet. | 
 | 1212 | _		Thread reaped. | 
 | 1213 |  | 
 | 1214 | The other values are fairly self explanatory - number of threads | 
| Jens Axboe | c9f6030 | 2007-07-20 12:43:05 +0200 | [diff] [blame] | 1215 | currently running and doing io, rate of io since last check (read speed | 
 | 1216 | listed first, then write speed), and the estimated completion percentage | 
 | 1217 | and time for the running group. It's impossible to estimate runtime of | 
 | 1218 | the following groups (if any). | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1219 |  | 
 | 1220 | When fio is done (or interrupted by ctrl-c), it will show the data for | 
 | 1221 | each thread, group of threads, and disks in that order. For each data | 
 | 1222 | direction, the output looks like: | 
 | 1223 |  | 
 | 1224 | Client1 (g=0): err= 0: | 
| Paul Dubs | 35649e5 | 2011-07-21 16:04:52 +0200 | [diff] [blame] | 1225 |   write: io=    32MB, bw=   666KB/s, iops=89 , runt= 50320msec | 
| Jens Axboe | 6104ddb | 2007-01-11 14:24:29 +0100 | [diff] [blame] | 1226 |     slat (msec): min=    0, max=  136, avg= 0.03, stdev= 1.92 | 
 | 1227 |     clat (msec): min=    0, max=  631, avg=48.50, stdev=86.82 | 
| Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 1228 |     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] | 1229 |   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] | 1230 |   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] | 1231 |      submit    : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, >=64=0.0% | 
 | 1232 |      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] | 1233 |      issued r/w: total=0/32768, short=0/0 | 
| Jens Axboe | 8abdce6 | 2007-02-21 10:22:55 +0100 | [diff] [blame] | 1234 |      lat (msec): 2=1.6%, 4=0.0%, 10=3.2%, 20=12.8%, 50=38.4%, 100=24.8%, | 
 | 1235 |      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] | 1236 |  | 
 | 1237 | The client number is printed, along with the group id and error of that | 
 | 1238 | thread. Below is the io statistics, here for writes. In the order listed, | 
 | 1239 | they denote: | 
 | 1240 |  | 
 | 1241 | io=		Number of megabytes io performed | 
 | 1242 | bw=		Average bandwidth rate | 
| Paul Dubs | 35649e5 | 2011-07-21 16:04:52 +0200 | [diff] [blame] | 1243 | iops=           Average IOs performed per second | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1244 | runt=		The runtime of that thread | 
| Jens Axboe | 72fbda2 | 2007-03-20 10:02:06 +0100 | [diff] [blame] | 1245 | 	slat=	Submission latency (avg being the average, stdev being the | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1246 | 		standard deviation). This is the time it took to submit | 
 | 1247 | 		the io. For sync io, the slat is really the completion | 
| Jens Axboe | 8a35c71 | 2007-06-19 09:53:31 +0200 | [diff] [blame] | 1248 | 		latency, since queue/complete is one operation there. This | 
| Jens Axboe | bf9a3ed | 2008-06-05 11:53:08 +0200 | [diff] [blame] | 1249 | 		value can be in milliseconds or microseconds, fio will choose | 
| Jens Axboe | 8a35c71 | 2007-06-19 09:53:31 +0200 | [diff] [blame] | 1250 | 		the most appropriate base and print that. In the example | 
| Jens Axboe | bf9a3ed | 2008-06-05 11:53:08 +0200 | [diff] [blame] | 1251 | 		above, milliseconds is the best scale. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1252 | 	clat=	Completion latency. Same names as slat, this denotes the | 
 | 1253 | 		time from submission to completion of the io pieces. For | 
 | 1254 | 		sync io, clat will usually be equal (or very close) to 0, | 
 | 1255 | 		as the time from submit to complete is basically just | 
 | 1256 | 		CPU time (io has already been done, see slat explanation). | 
 | 1257 | 	bw=	Bandwidth. Same names as the xlat stats, but also includes | 
 | 1258 | 		an approximate percentage of total aggregate bandwidth | 
 | 1259 | 		this thread received in this group. This last value is | 
 | 1260 | 		only really useful if the threads in this group are on the | 
 | 1261 | 		same disk, since they are then competing for disk access. | 
 | 1262 | cpu=		CPU usage. User and system time, along with the number | 
| Jens Axboe | e7823a9 | 2007-09-07 20:33:33 +0200 | [diff] [blame] | 1263 | 		of context switches this thread went through, usage of | 
 | 1264 | 		system and user time, and finally the number of major | 
 | 1265 | 		and minor page faults. | 
| Jens Axboe | 71619dc | 2007-01-13 23:56:33 +0100 | [diff] [blame] | 1266 | IO depths=	The distribution of io depths over the job life time. The | 
 | 1267 | 		numbers are divided into powers of 2, so for example the | 
 | 1268 | 		16= entries includes depths up to that value but higher | 
 | 1269 | 		than the previous entry. In other words, it covers the | 
 | 1270 | 		range from 16 to 31. | 
| Jens Axboe | 838bc70 | 2008-05-22 13:08:23 +0200 | [diff] [blame] | 1271 | IO submit=	How many pieces of IO were submitting in a single submit | 
 | 1272 | 		call. Each entry denotes that amount and below, until | 
 | 1273 | 		the previous entry - eg, 8=100% mean that we submitted | 
 | 1274 | 		anywhere in between 5-8 ios per submit call. | 
 | 1275 | IO complete=	Like the above submit number, but for completions instead. | 
| Jens Axboe | 30061b9 | 2007-04-17 13:31:34 +0200 | [diff] [blame] | 1276 | IO issued=	The number of read/write requests issued, and how many | 
 | 1277 | 		of them were short. | 
| Jens Axboe | ec11830 | 2007-02-17 04:38:20 +0100 | [diff] [blame] | 1278 | IO latencies=	The distribution of IO completion latencies. This is the | 
 | 1279 | 		time from when IO leaves fio and when it gets completed. | 
 | 1280 | 		The numbers follow the same pattern as the IO depths, | 
 | 1281 | 		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] | 1282 | 		within 2 msecs, 20=12.8% means that 12.8% of the IO | 
 | 1283 | 		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] | 1284 |  | 
 | 1285 | After each client has been listed, the group statistics are printed. They | 
 | 1286 | will look like this: | 
 | 1287 |  | 
 | 1288 | Run status group 0 (all jobs): | 
| Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 1289 |    READ: io=64MB, aggrb=22178, minb=11355, maxb=11814, mint=2840msec, maxt=2955msec | 
 | 1290 |   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] | 1291 |  | 
 | 1292 | For each data direction, it prints: | 
 | 1293 |  | 
 | 1294 | io=		Number of megabytes io performed. | 
 | 1295 | aggrb=		Aggregate bandwidth of threads in this group. | 
 | 1296 | minb=		The minimum average bandwidth a thread saw. | 
 | 1297 | maxb=		The maximum average bandwidth a thread saw. | 
 | 1298 | mint=		The smallest runtime of the threads in that group. | 
 | 1299 | maxt=		The longest runtime of the threads in that group. | 
 | 1300 |  | 
 | 1301 | And finally, the disk statistics are printed. They will look like this: | 
 | 1302 |  | 
 | 1303 | Disk stats (read/write): | 
 | 1304 |   sda: ios=16398/16511, merge=30/162, ticks=6853/819634, in_queue=826487, util=100.00% | 
 | 1305 |  | 
 | 1306 | Each value is printed for both reads and writes, with reads first. The | 
 | 1307 | numbers denote: | 
 | 1308 |  | 
 | 1309 | ios=		Number of ios performed by all groups. | 
 | 1310 | merge=		Number of merges io the io scheduler. | 
 | 1311 | ticks=		Number of ticks we kept the disk busy. | 
 | 1312 | io_queue=	Total time spent in the disk queue. | 
 | 1313 | util=		The disk utilization. A value of 100% means we kept the disk | 
 | 1314 | 		busy constantly, 50% would be a disk idling half of the time. | 
 | 1315 |  | 
 | 1316 |  | 
 | 1317 | 7.0 Terse output | 
 | 1318 | ---------------- | 
 | 1319 |  | 
 | 1320 | For scripted usage where you typically want to generate tables or graphs | 
| Jens Axboe | 6af019c | 2007-03-06 19:50:58 +0100 | [diff] [blame] | 1321 | 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] | 1322 | The format is one long line of values, such as: | 
 | 1323 |  | 
| David Nellans | 562c2d2 | 2010-09-23 08:38:17 +0200 | [diff] [blame] | 1324 | 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% | 
 | 1325 | A description of this job goes here. | 
 | 1326 |  | 
 | 1327 | The job description (if provided) follows on a second line. | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1328 |  | 
| Jens Axboe | 525c2bf | 2010-06-30 15:22:21 +0200 | [diff] [blame] | 1329 | To enable terse output, use the --minimal command line option. The first | 
 | 1330 | value is the version of the terse output format. If the output has to | 
 | 1331 | be changed for some reason, this number will be incremented by 1 to | 
 | 1332 | signify that change. | 
| Jens Axboe | 6820cb3 | 2008-09-27 12:33:53 +0200 | [diff] [blame] | 1333 |  | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1334 | Split up, the format is as follows: | 
 | 1335 |  | 
| Jens Axboe | 525c2bf | 2010-06-30 15:22:21 +0200 | [diff] [blame] | 1336 | 	version, jobname, groupid, error | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1337 | 	READ status: | 
| Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 1338 | 		KB IO, bandwidth (KB/sec), runtime (msec) | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1339 | 		Submission latency: min, max, mean, deviation | 
 | 1340 | 		Completion latency: min, max, mean, deviation | 
| Jens Axboe | 525c2bf | 2010-06-30 15:22:21 +0200 | [diff] [blame] | 1341 | 		Total latency: min, max, mean, deviation | 
| Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 1342 | 		Bw: min, max, aggregate percentage of total, mean, deviation | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1343 | 	WRITE status: | 
| Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 1344 | 		KB IO, bandwidth (KB/sec), runtime (msec) | 
| Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 1345 | 		Submission latency: min, max, mean, deviation | 
 | 1346 | 		Completion latency: min, max, mean, deviation | 
| Jens Axboe | 525c2bf | 2010-06-30 15:22:21 +0200 | [diff] [blame] | 1347 | 		Total latency: min, max, mean, deviation | 
| Jens Axboe | 6c21976 | 2006-11-03 15:51:45 +0100 | [diff] [blame] | 1348 | 		Bw: min, max, aggregate percentage of total, mean, deviation | 
| Shawn Lewis | 046ee30 | 2007-11-21 09:38:34 +0100 | [diff] [blame] | 1349 | 	CPU usage: user, system, context switches, major faults, minor faults | 
| Jens Axboe | 2270890 | 2007-03-06 17:05:32 +0100 | [diff] [blame] | 1350 | 	IO depths: <=1, 2, 4, 8, 16, 32, >=64 | 
| David Nellans | 562c2d2 | 2010-09-23 08:38:17 +0200 | [diff] [blame] | 1351 | 	IO latencies microseconds: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000 | 
 | 1352 | 	IO latencies milliseconds: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000 | 
 | 1353 | 	Additional Info (dependant on continue_on_error, default off): total # errors, first error code  | 
 | 1354 | 	 | 
| Jens Axboe | f42195a | 2010-10-26 08:10:58 -0600 | [diff] [blame] | 1355 | 	Additional Info (dependant on description being set): Text description | 
| Paul Dubs | 25c8b9d | 2011-07-21 17:26:02 +0200 | [diff] [blame] | 1356 |  | 
 | 1357 |  | 
 | 1358 | 8.0 Trace file format | 
 | 1359 | --------------------- | 
 | 1360 | There are two trace file format that you can encounter. The older (v1) format  | 
 | 1361 | is unsupported since version 1.20-rc3 (March 2008). It will still be described | 
 | 1362 | below in case that you get an old trace and want to understand it. | 
 | 1363 |  | 
 | 1364 | In any case the trace is a simple text file with a single action per line. | 
 | 1365 |  | 
 | 1366 |  | 
 | 1367 | 8.1 Trace file format v1 | 
 | 1368 | ------------------------ | 
 | 1369 | Each line represents a single io action in the following format: | 
 | 1370 |  | 
 | 1371 | rw, offset, length | 
 | 1372 |  | 
 | 1373 | where rw=0/1 for read/write, and the offset and length entries being in bytes. | 
 | 1374 |  | 
 | 1375 | This format is not supported in Fio versions => 1.20-rc3. | 
 | 1376 |  | 
 | 1377 |  | 
 | 1378 | 8.2 Trace file format v2 | 
 | 1379 | ------------------------ | 
 | 1380 | The second version of the trace file format was added in Fio version 1.17. | 
 | 1381 | It allows to access more then one file per trace and has a bigger set of | 
 | 1382 | possible file actions. | 
 | 1383 |  | 
 | 1384 | The first line of the trace file has to be: | 
 | 1385 |  | 
 | 1386 | fio version 2 iolog | 
 | 1387 |  | 
 | 1388 | Following this can be lines in two different formats, which are described below. | 
 | 1389 |  | 
 | 1390 | The file management format: | 
 | 1391 |  | 
 | 1392 | filename action | 
 | 1393 |  | 
 | 1394 | The filename is given as an absolute path. The action can be one of these: | 
 | 1395 |  | 
 | 1396 | add          Add the given filename to the trace | 
 | 1397 | open         Open the file with the given filename. The filename has to have  | 
 | 1398 |              been added with the add action before. | 
 | 1399 | close        Close the file with the given filename. The file has to have been | 
 | 1400 |              opened before. | 
 | 1401 |  | 
 | 1402 |  | 
 | 1403 | The file io action format: | 
 | 1404 |  | 
 | 1405 | filename action offset length | 
 | 1406 |  | 
 | 1407 | The filename is given as an absolute path, and has to have been added and opened | 
 | 1408 | before it can be used with this format. The offset and length are given in  | 
 | 1409 | bytes. The action can be one of these: | 
 | 1410 |  | 
 | 1411 | wait       Wait for 'offset' microseconds. Everything below 100 is discarded. | 
 | 1412 | read       Read 'length' bytes beginning from 'offset' | 
 | 1413 | write      Write 'length' bytes beginning from 'offset' | 
 | 1414 | sync       fsync() the file | 
 | 1415 | datasync   fdatasync() the file | 
 | 1416 | trim       trim the given file from the given 'offset' for 'length' bytes |