Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1 | .TH fio 1 "September 2007" "User Manual" |
| 2 | .SH NAME |
| 3 | fio \- flexible I/O tester |
| 4 | .SH SYNOPSIS |
| 5 | .B fio |
| 6 | [\fIoptions\fR] [\fIjobfile\fR]... |
| 7 | .SH DESCRIPTION |
| 8 | .B fio |
| 9 | is a tool that will spawn a number of threads or processes doing a |
| 10 | particular type of I/O action as specified by the user. |
| 11 | The typical use of fio is to write a job file matching the I/O load |
| 12 | one wants to simulate. |
| 13 | .SH OPTIONS |
| 14 | .TP |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 15 | .BI \-\-debug \fR=\fPtype |
| 16 | Enable verbose tracing of various fio actions. May be `all' for all types |
| 17 | or individual types separated by a comma (eg \-\-debug=io,file). `help' will |
| 18 | list all available tracing options. |
| 19 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 20 | .BI \-\-output \fR=\fPfilename |
| 21 | Write output to \fIfilename\fR. |
| 22 | .TP |
liang xie | b2cecdc | 2012-08-31 08:22:42 -0700 | [diff] [blame] | 23 | .BI \-\-runtime \fR=\fPruntime |
| 24 | Limit run time to \fIruntime\fR seconds. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 25 | .TP |
| 26 | .B \-\-latency\-log |
| 27 | Generate per-job latency logs. |
| 28 | .TP |
| 29 | .B \-\-bandwidth\-log |
| 30 | Generate per-job bandwidth logs. |
| 31 | .TP |
| 32 | .B \-\-minimal |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 33 | Print statistics in a terse, semicolon-delimited format. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 34 | .TP |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 35 | .B \-\-version |
| 36 | Display version information and exit. |
| 37 | .TP |
Jens Axboe | 065248b | 2011-10-13 20:51:05 +0200 | [diff] [blame] | 38 | .BI \-\-terse\-version \fR=\fPversion |
Jens Axboe | 4d65865 | 2011-10-17 15:05:47 +0200 | [diff] [blame] | 39 | Set terse version output format (Current version 3, or older version 2). |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 40 | .TP |
| 41 | .B \-\-help |
| 42 | Display usage information and exit. |
| 43 | .TP |
| 44 | .BI \-\-cmdhelp \fR=\fPcommand |
| 45 | Print help information for \fIcommand\fR. May be `all' for all commands. |
| 46 | .TP |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 47 | .BI \-\-enghelp \fR=\fPioengine[,command] |
| 48 | List all commands defined by \fIioengine\fR, or print help for \fIcommand\fR defined by \fIioengine\fR. |
| 49 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 50 | .BI \-\-showcmd \fR=\fPjobfile |
| 51 | Convert \fIjobfile\fR to a set of command-line options. |
| 52 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 53 | .BI \-\-eta \fR=\fPwhen |
| 54 | Specifies when real-time ETA estimate should be printed. \fIwhen\fR may |
| 55 | be one of `always', `never' or `auto'. |
| 56 | .TP |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 57 | .BI \-\-readonly |
| 58 | Turn on safety read-only checks, preventing any attempted write. |
| 59 | .TP |
Aaron Carroll | c0a5d35 | 2008-02-26 23:10:39 +0100 | [diff] [blame] | 60 | .BI \-\-section \fR=\fPsec |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 61 | Only run section \fIsec\fR from job file. Multiple of these options can be given, adding more sections to run. |
Aaron Carroll | c0a5d35 | 2008-02-26 23:10:39 +0100 | [diff] [blame] | 62 | .TP |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 63 | .BI \-\-alloc\-size \fR=\fPkb |
| 64 | Set the internal smalloc pool size to \fIkb\fP kilobytes. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 65 | .TP |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 66 | .BI \-\-warnings\-fatal |
| 67 | All fio parser warnings are fatal, causing fio to exit with an error. |
Jens Axboe | 9183788 | 2008-02-05 12:02:07 +0100 | [diff] [blame] | 68 | .TP |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 69 | .BI \-\-max\-jobs \fR=\fPnr |
Martin Steigerwald | 57e118a | 2012-05-07 17:06:13 +0200 | [diff] [blame] | 70 | Set the maximum allowed number of jobs (threads/processes) to support. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 71 | .TP |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 72 | .BI \-\-server \fR=\fPargs |
| 73 | Start a backend server, with \fIargs\fP specifying what to listen to. See client/server section. |
Jens Axboe | f57a9c5 | 2011-09-09 21:01:37 +0200 | [diff] [blame] | 74 | .TP |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 75 | .BI \-\-daemonize \fR=\fPpidfile |
| 76 | Background a fio server, writing the pid to the given pid file. |
| 77 | .TP |
| 78 | .BI \-\-client \fR=\fPhost |
| 79 | Instead of running the jobs locally, send and run them on the given host. |
Huadong Liu | f2a2ce0 | 2013-01-30 13:22:24 +0100 | [diff] [blame] | 80 | .TP |
| 81 | .BI \-\-idle\-prof \fR=\fPoption |
| 82 | Report cpu idleness on a system or percpu basis (\fIoption\fP=system,percpu) or run unit work calibration only (\fIoption\fP=calibrate). |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 83 | .SH "JOB FILE FORMAT" |
| 84 | Job files are in `ini' format. They consist of one or more |
| 85 | job definitions, which begin with a job name in square brackets and |
| 86 | extend to the next job name. The job name can be any ASCII string |
| 87 | except `global', which has a special meaning. Following the job name is |
| 88 | a sequence of zero or more parameters, one per line, that define the |
| 89 | behavior of the job. Any line starting with a `;' or `#' character is |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 90 | considered a comment and ignored. |
Aaron Carroll | d9956b6 | 2007-11-16 12:12:45 +0100 | [diff] [blame] | 91 | .P |
| 92 | If \fIjobfile\fR is specified as `-', the job file will be read from |
| 93 | standard input. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 94 | .SS "Global Section" |
| 95 | The global section contains default parameters for jobs specified in the |
| 96 | job file. A job is only affected by global sections residing above it, |
| 97 | and there may be any number of global sections. Specific job definitions |
| 98 | may override any parameter set in global sections. |
| 99 | .SH "JOB PARAMETERS" |
| 100 | .SS Types |
| 101 | Some parameters may take arguments of a specific type. The types used are: |
| 102 | .TP |
| 103 | .I str |
| 104 | String: a sequence of alphanumeric characters. |
| 105 | .TP |
| 106 | .I int |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 107 | SI integer: a whole number, possibly containing a suffix denoting the base unit |
Jens Axboe | b09da8f | 2009-07-17 23:16:17 +0200 | [diff] [blame] | 108 | of the value. Accepted suffixes are `k', 'M', 'G', 'T', and 'P', denoting |
| 109 | kilo (1024), mega (1024^2), giga (1024^3), tera (1024^4), and peta (1024^5) |
| 110 | respectively. The suffix is not case sensitive. If prefixed with '0x', the |
Martin Steigerwald | 5982a92 | 2011-06-27 16:07:24 +0200 | [diff] [blame] | 111 | value is assumed to be base 16 (hexadecimal). A suffix may include a trailing 'b', |
| 112 | for instance 'kb' is identical to 'k'. You can specify a base 10 value |
Jens Axboe | 57fc29f | 2010-06-23 22:24:07 +0200 | [diff] [blame] | 113 | by using 'KiB', 'MiB', 'GiB', etc. This is useful for disk drives where |
| 114 | values are often given in base 10 values. Specifying '30GiB' will get you |
| 115 | 30*1000^3 bytes. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 116 | .TP |
| 117 | .I bool |
| 118 | Boolean: a true or false value. `0' denotes false, `1' denotes true. |
| 119 | .TP |
| 120 | .I irange |
| 121 | Integer range: a range of integers specified in the format |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 122 | \fIlower\fR:\fIupper\fR or \fIlower\fR\-\fIupper\fR. \fIlower\fR and |
| 123 | \fIupper\fR may contain a suffix as described above. If an option allows two |
| 124 | sets of ranges, they are separated with a `,' or `/' character. For example: |
| 125 | `8\-8k/8M\-4G'. |
Yu-ju Hong | 8334919 | 2011-08-13 00:53:44 +0200 | [diff] [blame] | 126 | .TP |
| 127 | .I float_list |
| 128 | List of floating numbers: A list of floating numbers, separated by |
| 129 | a ':' charcater. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 130 | .SS "Parameter List" |
| 131 | .TP |
| 132 | .BI name \fR=\fPstr |
Aaron Carroll | d9956b6 | 2007-11-16 12:12:45 +0100 | [diff] [blame] | 133 | May be used to override the job name. On the command line, this parameter |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 134 | has the special purpose of signalling the start of a new job. |
| 135 | .TP |
| 136 | .BI description \fR=\fPstr |
| 137 | Human-readable description of the job. It is printed when the job is run, but |
| 138 | otherwise has no special purpose. |
| 139 | .TP |
| 140 | .BI directory \fR=\fPstr |
| 141 | Prefix filenames with this directory. Used to place files in a location other |
| 142 | than `./'. |
| 143 | .TP |
| 144 | .BI filename \fR=\fPstr |
| 145 | .B fio |
| 146 | normally makes up a file name based on the job name, thread number, and file |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 147 | number. If you want to share files between threads in a job or several jobs, |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 148 | specify a \fIfilename\fR for each of them to override the default. |
| 149 | If the I/O engine is file-based, you can specify |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 150 | a number of files by separating the names with a `:' character. `\-' is a |
| 151 | reserved name, meaning stdin or stdout, depending on the read/write direction |
| 152 | set. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 153 | .TP |
Jens Axboe | 3ce9dca | 2009-06-10 08:55:21 +0200 | [diff] [blame] | 154 | .BI lockfile \fR=\fPstr |
| 155 | Fio defaults to not locking any files before it does IO to them. If a file or |
| 156 | file descriptor is shared, fio can serialize IO to that file to make the end |
| 157 | result consistent. This is usual for emulating real workloads that share files. |
| 158 | The lock modes are: |
| 159 | .RS |
| 160 | .RS |
| 161 | .TP |
| 162 | .B none |
| 163 | No locking. This is the default. |
| 164 | .TP |
| 165 | .B exclusive |
| 166 | Only one thread or process may do IO at the time, excluding all others. |
| 167 | .TP |
| 168 | .B readwrite |
| 169 | Read-write locking on the file. Many readers may access the file at the same |
| 170 | time, but writes get exclusive access. |
| 171 | .RE |
| 172 | .P |
| 173 | The option may be post-fixed with a lock batch number. If set, then each |
| 174 | thread/process may do that amount of IOs to the file before giving up the lock. |
| 175 | Since lock acquisition is expensive, batching the lock/unlocks will speed up IO. |
| 176 | .RE |
| 177 | .P |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 178 | .BI opendir \fR=\fPstr |
| 179 | Recursively open any files below directory \fIstr\fR. |
| 180 | .TP |
| 181 | .BI readwrite \fR=\fPstr "\fR,\fP rw" \fR=\fPstr |
| 182 | Type of I/O pattern. Accepted values are: |
| 183 | .RS |
| 184 | .RS |
| 185 | .TP |
| 186 | .B read |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 187 | Sequential reads. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 188 | .TP |
| 189 | .B write |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 190 | Sequential writes. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 191 | .TP |
| 192 | .B randread |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 193 | Random reads. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 194 | .TP |
| 195 | .B randwrite |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 196 | Random writes. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 197 | .TP |
Jens Axboe | 10b023d | 2012-03-23 13:40:06 +0100 | [diff] [blame] | 198 | .B rw, readwrite |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 199 | Mixed sequential reads and writes. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 200 | .TP |
| 201 | .B randrw |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 202 | Mixed random reads and writes. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 203 | .RE |
| 204 | .P |
Jens Axboe | 38dad62 | 2010-07-20 14:46:00 -0600 | [diff] [blame] | 205 | For mixed I/O, the default split is 50/50. For certain types of io the result |
| 206 | may still be skewed a bit, since the speed may be different. It is possible to |
Jens Axboe | 3b7fa9e | 2012-04-26 19:39:47 +0200 | [diff] [blame] | 207 | specify a number of IO's to do before getting a new offset, this is done by |
Jens Axboe | 38dad62 | 2010-07-20 14:46:00 -0600 | [diff] [blame] | 208 | appending a `:\fI<nr>\fR to the end of the string given. For a random read, it |
| 209 | would look like \fBrw=randread:8\fR for passing in an offset modifier with a |
Jens Axboe | 059b080 | 2011-08-25 09:09:37 +0200 | [diff] [blame] | 210 | value of 8. If the postfix is used with a sequential IO pattern, then the value |
| 211 | specified will be added to the generated offset for each IO. For instance, |
| 212 | using \fBrw=write:4k\fR will skip 4k for every write. It turns sequential IO |
| 213 | into sequential IO with holes. See the \fBrw_sequencer\fR option. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 214 | .RE |
| 215 | .TP |
Jens Axboe | 38dad62 | 2010-07-20 14:46:00 -0600 | [diff] [blame] | 216 | .BI rw_sequencer \fR=\fPstr |
| 217 | If an offset modifier is given by appending a number to the \fBrw=<str>\fR line, |
| 218 | then this option controls how that number modifies the IO offset being |
| 219 | generated. Accepted values are: |
| 220 | .RS |
| 221 | .RS |
| 222 | .TP |
| 223 | .B sequential |
| 224 | Generate sequential offset |
| 225 | .TP |
| 226 | .B identical |
| 227 | Generate the same offset |
| 228 | .RE |
| 229 | .P |
| 230 | \fBsequential\fR is only useful for random IO, where fio would normally |
| 231 | generate a new random offset for every IO. If you append eg 8 to randread, you |
| 232 | would get a new random offset for every 8 IO's. The result would be a seek for |
| 233 | only every 8 IO's, instead of for every IO. Use \fBrw=randread:8\fR to specify |
| 234 | that. As sequential IO is already sequential, setting \fBsequential\fR for that |
| 235 | would not result in any differences. \fBidentical\fR behaves in a similar |
| 236 | fashion, except it sends the same offset 8 number of times before generating a |
| 237 | new offset. |
| 238 | .RE |
| 239 | .P |
| 240 | .TP |
Jens Axboe | 90fef2d | 2009-07-17 22:33:32 +0200 | [diff] [blame] | 241 | .BI kb_base \fR=\fPint |
| 242 | The base unit for a kilobyte. The defacto base is 2^10, 1024. Storage |
| 243 | manufacturers like to use 10^3 or 1000 as a base ten unit instead, for obvious |
| 244 | reasons. Allow values are 1024 or 1000, with 1024 being the default. |
| 245 | .TP |
Jens Axboe | 771e58b | 2013-01-30 12:56:23 +0100 | [diff] [blame] | 246 | .BI unified_rw_reporting \fR=\fPbool |
| 247 | Fio normally reports statistics on a per data direction basis, meaning that |
| 248 | read, write, and trim are accounted and reported separately. If this option is |
| 249 | set, the fio will sum the results and report them as "mixed" instead. |
| 250 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 251 | .BI randrepeat \fR=\fPbool |
| 252 | Seed the random number generator in a predictable way so results are repeatable |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 253 | across runs. Default: true. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 254 | .TP |
Jens Axboe | 2615cc4 | 2011-03-28 09:35:09 +0200 | [diff] [blame] | 255 | .BI use_os_rand \fR=\fPbool |
| 256 | Fio can either use the random generator supplied by the OS to generator random |
| 257 | offsets, or it can use it's own internal generator (based on Tausworthe). |
| 258 | Default is to use the internal generator, which is often of better quality and |
| 259 | faster. Default: false. |
| 260 | .TP |
Eric Gouriou | a596f04 | 2011-06-17 09:11:45 +0200 | [diff] [blame] | 261 | .BI fallocate \fR=\fPstr |
| 262 | Whether pre-allocation is performed when laying down files. Accepted values |
| 263 | are: |
| 264 | .RS |
| 265 | .RS |
| 266 | .TP |
| 267 | .B none |
| 268 | Do not pre-allocate space. |
| 269 | .TP |
| 270 | .B posix |
| 271 | Pre-allocate via posix_fallocate(). |
| 272 | .TP |
| 273 | .B keep |
| 274 | Pre-allocate via fallocate() with FALLOC_FL_KEEP_SIZE set. |
| 275 | .TP |
| 276 | .B 0 |
| 277 | Backward-compatible alias for 'none'. |
| 278 | .TP |
| 279 | .B 1 |
| 280 | Backward-compatible alias for 'posix'. |
| 281 | .RE |
| 282 | .P |
| 283 | May not be available on all supported platforms. 'keep' is only |
| 284 | available on Linux. If using ZFS on Solaris this must be set to 'none' |
| 285 | because ZFS doesn't support it. Default: 'posix'. |
| 286 | .RE |
Jens Axboe | 7bc8c2c | 2010-01-28 11:31:31 +0100 | [diff] [blame] | 287 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 288 | .BI fadvise_hint \fR=\fPbool |
Zhu Yanhai | 23a7b04 | 2012-01-02 14:32:43 +0100 | [diff] [blame] | 289 | Use of \fIposix_fadvise\fR\|(2) to advise the kernel what I/O patterns |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 290 | are likely to be issued. Default: true. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 291 | .TP |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 292 | .BI size \fR=\fPint |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 293 | Total size of I/O for this job. \fBfio\fR will run until this many bytes have |
| 294 | been transfered, unless limited by other options (\fBruntime\fR, for instance). |
Jens Axboe | d7c8be0 | 2010-11-25 08:21:39 +0100 | [diff] [blame] | 295 | Unless \fBnrfiles\fR and \fBfilesize\fR options are given, this amount will be |
Jens Axboe | d666726 | 2010-06-25 11:32:48 +0200 | [diff] [blame] | 296 | divided between the available files for the job. If not set, fio will use the |
| 297 | full size of the given files or devices. If the the files do not exist, size |
Jens Axboe | 7bb5910 | 2011-07-12 19:47:03 +0200 | [diff] [blame] | 298 | must be given. It is also possible to give size as a percentage between 1 and |
| 299 | 100. If size=20% is given, fio will use 20% of the full size of the given files |
| 300 | or devices. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 301 | .TP |
Jens Axboe | 74586c1 | 2011-01-20 10:16:03 -0700 | [diff] [blame] | 302 | .BI fill_device \fR=\fPbool "\fR,\fB fill_fs" \fR=\fPbool |
Jens Axboe | 3ce9dca | 2009-06-10 08:55:21 +0200 | [diff] [blame] | 303 | Sets size to something really large and waits for ENOSPC (no space left on |
| 304 | device) as the terminating condition. Only makes sense with sequential write. |
| 305 | For a read workload, the mount point will be filled first then IO started on |
Jens Axboe | 4f12432 | 2011-01-19 15:35:26 -0700 | [diff] [blame] | 306 | the result. This option doesn't make sense if operating on a raw device node, |
| 307 | since the size of that is already known by the file system. Additionally, |
| 308 | writing beyond end-of-device will not return ENOSPC there. |
Jens Axboe | 3ce9dca | 2009-06-10 08:55:21 +0200 | [diff] [blame] | 309 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 310 | .BI filesize \fR=\fPirange |
| 311 | Individual file sizes. May be a range, in which case \fBfio\fR will select sizes |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 312 | for files at random within the given range, limited to \fBsize\fR in total (if |
| 313 | that is given). If \fBfilesize\fR is not specified, each created file is the |
| 314 | same size. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 315 | .TP |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 316 | .BI blocksize \fR=\fPint[,int] "\fR,\fB bs" \fR=\fPint[,int] |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 317 | Block size for I/O units. Default: 4k. Values for reads and writes can be |
Jens Axboe | 656ebab | 2010-04-13 10:39:14 +0200 | [diff] [blame] | 318 | specified separately in the format \fIread\fR,\fIwrite\fR, either of |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 319 | which may be empty to leave that value at its default. |
| 320 | .TP |
Jens Axboe | 9183788 | 2008-02-05 12:02:07 +0100 | [diff] [blame] | 321 | .BI blocksize_range \fR=\fPirange[,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange] |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 322 | Specify a range of I/O block sizes. The issued I/O unit will always be a |
| 323 | multiple of the minimum size, unless \fBblocksize_unaligned\fR is set. Applies |
Jens Axboe | 9183788 | 2008-02-05 12:02:07 +0100 | [diff] [blame] | 324 | to both reads and writes if only one range is given, but can be specified |
Jens Axboe | 656ebab | 2010-04-13 10:39:14 +0200 | [diff] [blame] | 325 | separately with a comma seperating the values. Example: bsrange=1k-4k,2k-8k. |
Jens Axboe | 9183788 | 2008-02-05 12:02:07 +0100 | [diff] [blame] | 326 | Also (see \fBblocksize\fR). |
| 327 | .TP |
| 328 | .BI bssplit \fR=\fPstr |
| 329 | This option allows even finer grained control of the block sizes issued, |
| 330 | not just even splits between them. With this option, you can weight various |
| 331 | block sizes for exact control of the issued IO for a job that has mixed |
| 332 | block sizes. The format of the option is bssplit=blocksize/percentage, |
Martin Steigerwald | 5982a92 | 2011-06-27 16:07:24 +0200 | [diff] [blame] | 333 | optionally adding as many definitions as needed separated by a colon. |
Jens Axboe | 9183788 | 2008-02-05 12:02:07 +0100 | [diff] [blame] | 334 | Example: bssplit=4k/10:64k/50:32k/40 would issue 50% 64k blocks, 10% 4k |
Jens Axboe | c83cdd3 | 2009-04-24 14:23:59 +0200 | [diff] [blame] | 335 | blocks and 40% 32k blocks. \fBbssplit\fR also supports giving separate |
| 336 | splits to reads and writes. The format is identical to what the |
| 337 | \fBbs\fR option accepts, the read and write parts are separated with a |
| 338 | comma. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 339 | .TP |
| 340 | .B blocksize_unaligned\fR,\fP bs_unaligned |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 341 | If set, any size in \fBblocksize_range\fR may be used. This typically won't |
| 342 | work with direct I/O, as that normally requires sector alignment. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 343 | .TP |
Jens Axboe | 2b7a01d | 2009-03-11 11:00:13 +0100 | [diff] [blame] | 344 | .BI blockalign \fR=\fPint[,int] "\fR,\fB ba" \fR=\fPint[,int] |
Martin Steigerwald | 639ce0f | 2009-05-20 11:33:49 +0200 | [diff] [blame] | 345 | At what boundary to align random IO offsets. Defaults to the same as 'blocksize' |
| 346 | the minimum blocksize given. Minimum alignment is typically 512b |
Jens Axboe | 2b7a01d | 2009-03-11 11:00:13 +0100 | [diff] [blame] | 347 | for using direct IO, though it usually depends on the hardware block size. |
| 348 | This option is mutually exclusive with using a random map for files, so it |
| 349 | will turn off that option. |
Jens Axboe | 4360266 | 2009-03-14 20:08:47 +0100 | [diff] [blame] | 350 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 351 | .B zero_buffers |
| 352 | Initialise buffers with all zeros. Default: fill buffers with random data. |
| 353 | .TP |
Jens Axboe | 901bb99 | 2009-03-14 20:17:36 +0100 | [diff] [blame] | 354 | .B refill_buffers |
| 355 | If this option is given, fio will refill the IO buffers on every submit. The |
| 356 | default is to only fill it at init time and reuse that data. Only makes sense |
| 357 | if zero_buffers isn't specified, naturally. If data verification is enabled, |
| 358 | refill_buffers is also automatically enabled. |
| 359 | .TP |
Jens Axboe | fd68418 | 2011-09-19 09:24:44 +0200 | [diff] [blame] | 360 | .BI scramble_buffers \fR=\fPbool |
| 361 | If \fBrefill_buffers\fR is too costly and the target is using data |
| 362 | deduplication, then setting this option will slightly modify the IO buffer |
| 363 | contents to defeat normal de-dupe attempts. This is not enough to defeat |
| 364 | more clever block compression attempts, but it will stop naive dedupe |
| 365 | of blocks. Default: true. |
| 366 | .TP |
Jens Axboe | c5751c6 | 2012-03-15 15:02:56 +0100 | [diff] [blame] | 367 | .BI buffer_compress_percentage \fR=\fPint |
| 368 | If this is set, then fio will attempt to provide IO buffer content (on WRITEs) |
| 369 | that compress to the specified level. Fio does this by providing a mix of |
| 370 | random data and zeroes. Note that this is per block size unit, for file/disk |
| 371 | wide compression level that matches this setting, you'll also want to set |
| 372 | \fBrefill_buffers\fR. |
| 373 | .TP |
| 374 | .BI buffer_compress_chunk \fR=\fPint |
| 375 | See \fBbuffer_compress_percentage\fR. This setting allows fio to manage how |
| 376 | big the ranges of random data and zeroed data is. Without this set, fio will |
| 377 | provide \fBbuffer_compress_percentage\fR of blocksize random data, followed by |
| 378 | the remaining zeroed. With this set to some chunk size smaller than the block |
| 379 | size, fio can alternate random and zeroed data throughout the IO buffer. |
| 380 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 381 | .BI nrfiles \fR=\fPint |
| 382 | Number of files to use for this job. Default: 1. |
| 383 | .TP |
| 384 | .BI openfiles \fR=\fPint |
| 385 | Number of files to keep open at the same time. Default: \fBnrfiles\fR. |
| 386 | .TP |
| 387 | .BI file_service_type \fR=\fPstr |
| 388 | Defines how files to service are selected. The following types are defined: |
| 389 | .RS |
| 390 | .RS |
| 391 | .TP |
| 392 | .B random |
| 393 | Choose a file at random |
| 394 | .TP |
| 395 | .B roundrobin |
| 396 | Round robin over open files (default). |
Jens Axboe | 6b7f685 | 2009-03-09 14:22:56 +0100 | [diff] [blame] | 397 | .B sequential |
| 398 | Do each file in the set sequentially. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 399 | .RE |
| 400 | .P |
| 401 | The number of I/Os to issue before switching a new file can be specified by |
| 402 | appending `:\fIint\fR' to the service type. |
| 403 | .RE |
| 404 | .TP |
| 405 | .BI ioengine \fR=\fPstr |
| 406 | Defines how the job issues I/O. The following types are defined: |
| 407 | .RS |
| 408 | .RS |
| 409 | .TP |
| 410 | .B sync |
| 411 | Basic \fIread\fR\|(2) or \fIwrite\fR\|(2) I/O. \fIfseek\fR\|(2) is used to |
| 412 | position the I/O location. |
| 413 | .TP |
gurudas pai | a31041e | 2007-10-23 15:12:30 +0200 | [diff] [blame] | 414 | .B psync |
| 415 | Basic \fIpread\fR\|(2) or \fIpwrite\fR\|(2) I/O. |
| 416 | .TP |
Jens Axboe | 9183788 | 2008-02-05 12:02:07 +0100 | [diff] [blame] | 417 | .B vsync |
| 418 | Basic \fIreadv\fR\|(2) or \fIwritev\fR\|(2) I/O. Will emulate queuing by |
| 419 | coalescing adjacents IOs into a single submission. |
| 420 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 421 | .B libaio |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 422 | Linux native asynchronous I/O. This ioengine defines engine specific options. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 423 | .TP |
| 424 | .B posixaio |
Bruce Cran | 03e20d6 | 2011-01-02 20:14:54 +0100 | [diff] [blame] | 425 | POSIX asynchronous I/O using \fIaio_read\fR\|(3) and \fIaio_write\fR\|(3). |
| 426 | .TP |
| 427 | .B solarisaio |
| 428 | Solaris native asynchronous I/O. |
| 429 | .TP |
| 430 | .B windowsaio |
| 431 | Windows native asynchronous I/O. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 432 | .TP |
| 433 | .B mmap |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 434 | File is memory mapped with \fImmap\fR\|(2) and data copied using |
| 435 | \fImemcpy\fR\|(3). |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 436 | .TP |
| 437 | .B splice |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 438 | \fIsplice\fR\|(2) is used to transfer the data and \fIvmsplice\fR\|(2) to |
| 439 | transfer data from user-space to the kernel. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 440 | .TP |
| 441 | .B syslet-rw |
| 442 | Use the syslet system calls to make regular read/write asynchronous. |
| 443 | .TP |
| 444 | .B sg |
| 445 | SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 446 | the target is an sg character device, we use \fIread\fR\|(2) and |
| 447 | \fIwrite\fR\|(2) for asynchronous I/O. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 448 | .TP |
| 449 | .B null |
| 450 | Doesn't transfer any data, just pretends to. Mainly used to exercise \fBfio\fR |
| 451 | itself and for debugging and testing purposes. |
| 452 | .TP |
| 453 | .B net |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 454 | Transfer over the network. The protocol to be used can be defined with the |
| 455 | \fBprotocol\fR parameter. Depending on the protocol, \fBfilename\fR, |
| 456 | \fBhostname\fR, \fBport\fR, or \fBlisten\fR must be specified. |
| 457 | This ioengine defines engine specific options. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 458 | .TP |
| 459 | .B netsplice |
| 460 | Like \fBnet\fR, but uses \fIsplice\fR\|(2) and \fIvmsplice\fR\|(2) to map data |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 461 | and send/receive. This ioengine defines engine specific options. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 462 | .TP |
gurudas pai | 53aec0a | 2007-10-05 13:20:18 +0200 | [diff] [blame] | 463 | .B cpuio |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 464 | Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and |
| 465 | \fBcpucycles\fR parameters. |
| 466 | .TP |
| 467 | .B guasi |
| 468 | The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface |
| 469 | approach to asycnronous I/O. |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 470 | .br |
| 471 | See <http://www.xmailserver.org/guasi\-lib.html>. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 472 | .TP |
ren yufei | 21b8aee | 2011-08-01 10:01:57 +0200 | [diff] [blame] | 473 | .B rdma |
Bart Van Assche | 85286c5 | 2011-08-07 21:50:51 +0200 | [diff] [blame] | 474 | The RDMA I/O engine supports both RDMA memory semantics (RDMA_WRITE/RDMA_READ) |
| 475 | and channel semantics (Send/Recv) for the InfiniBand, RoCE and iWARP protocols. |
ren yufei | 21b8aee | 2011-08-01 10:01:57 +0200 | [diff] [blame] | 476 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 477 | .B external |
| 478 | Loads an external I/O engine object file. Append the engine filename as |
| 479 | `:\fIenginepath\fR'. |
Dmitry Monakhov | d54fce8 | 2012-09-20 15:37:17 +0400 | [diff] [blame] | 480 | .TP |
| 481 | .B falloc |
| 482 | IO engine that does regular linux native fallocate callt to simulate data |
| 483 | transfer as fio ioengine |
| 484 | .br |
| 485 | DDIR_READ does fallocate(,mode = FALLOC_FL_KEEP_SIZE,) |
| 486 | .br |
Jens Axboe | 0981fd7 | 2012-09-20 19:23:02 +0200 | [diff] [blame] | 487 | DIR_WRITE does fallocate(,mode = 0) |
Dmitry Monakhov | d54fce8 | 2012-09-20 15:37:17 +0400 | [diff] [blame] | 488 | .br |
| 489 | DDIR_TRIM does fallocate(,mode = FALLOC_FL_KEEP_SIZE|FALLOC_FL_PUNCH_HOLE) |
| 490 | .TP |
| 491 | .B e4defrag |
| 492 | IO engine that does regular EXT4_IOC_MOVE_EXT ioctls to simulate defragment activity |
| 493 | request to DDIR_WRITE event |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 494 | .RE |
Jens Axboe | 595e173 | 2012-12-05 21:15:01 +0100 | [diff] [blame] | 495 | .P |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 496 | .RE |
| 497 | .TP |
| 498 | .BI iodepth \fR=\fPint |
Sebastian Kayser | 8489dae | 2010-12-01 22:28:47 +0100 | [diff] [blame] | 499 | Number of I/O units to keep in flight against the file. Note that increasing |
| 500 | iodepth beyond 1 will not affect synchronous ioengines (except for small |
Jens Axboe | ee72ca0 | 2010-12-02 20:05:37 +0100 | [diff] [blame] | 501 | degress when verify_async is in use). Even async engines my impose OS |
| 502 | restrictions causing the desired depth not to be achieved. This may happen on |
| 503 | Linux when using libaio and not setting \fBdirect\fR=1, since buffered IO is |
| 504 | not async on that OS. Keep an eye on the IO depth distribution in the |
| 505 | fio output to verify that the achieved depth is as expected. Default: 1. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 506 | .TP |
| 507 | .BI iodepth_batch \fR=\fPint |
| 508 | Number of I/Os to submit at once. Default: \fBiodepth\fR. |
| 509 | .TP |
Jens Axboe | 3ce9dca | 2009-06-10 08:55:21 +0200 | [diff] [blame] | 510 | .BI iodepth_batch_complete \fR=\fPint |
| 511 | This defines how many pieces of IO to retrieve at once. It defaults to 1 which |
| 512 | means that we'll ask for a minimum of 1 IO in the retrieval process from the |
| 513 | kernel. The IO retrieval will go on until we hit the limit set by |
| 514 | \fBiodepth_low\fR. If this variable is set to 0, then fio will always check for |
| 515 | completed events before queuing more IO. This helps reduce IO latency, at the |
| 516 | cost of more retrieval system calls. |
| 517 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 518 | .BI iodepth_low \fR=\fPint |
| 519 | Low watermark indicating when to start filling the queue again. Default: |
| 520 | \fBiodepth\fR. |
| 521 | .TP |
| 522 | .BI direct \fR=\fPbool |
| 523 | If true, use non-buffered I/O (usually O_DIRECT). Default: false. |
| 524 | .TP |
| 525 | .BI buffered \fR=\fPbool |
| 526 | If true, use buffered I/O. This is the opposite of the \fBdirect\fR parameter. |
| 527 | Default: true. |
| 528 | .TP |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 529 | .BI offset \fR=\fPint |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 530 | Offset in the file to start I/O. Data before the offset will not be touched. |
| 531 | .TP |
Jens Axboe | 591e9e0 | 2012-03-15 14:50:58 +0100 | [diff] [blame] | 532 | .BI offset_increment \fR=\fPint |
| 533 | If this is provided, then the real offset becomes the |
| 534 | offset + offset_increment * thread_number, where the thread number is a counter |
| 535 | that starts at 0 and is incremented for each job. This option is useful if |
| 536 | there are several jobs which are intended to operate on a file in parallel in |
| 537 | disjoint segments, with even spacing between the starting points. |
| 538 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 539 | .BI fsync \fR=\fPint |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 540 | How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data. If |
| 541 | 0, don't sync. Default: 0. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 542 | .TP |
Jens Axboe | 5f9099e | 2009-06-16 22:40:26 +0200 | [diff] [blame] | 543 | .BI fdatasync \fR=\fPint |
| 544 | Like \fBfsync\fR, but uses \fBfdatasync\fR\|(2) instead to only sync the |
| 545 | data parts of the file. Default: 0. |
| 546 | .TP |
Jens Axboe | e76b1da | 2010-03-09 20:49:54 +0100 | [diff] [blame] | 547 | .BI sync_file_range \fR=\fPstr:int |
| 548 | Use sync_file_range() for every \fRval\fP number of write operations. Fio will |
| 549 | track range of writes that have happened since the last sync_file_range() call. |
| 550 | \fRstr\fP can currently be one or more of: |
| 551 | .RS |
| 552 | .TP |
| 553 | .B wait_before |
| 554 | SYNC_FILE_RANGE_WAIT_BEFORE |
| 555 | .TP |
| 556 | .B write |
| 557 | SYNC_FILE_RANGE_WRITE |
| 558 | .TP |
| 559 | .B wait_after |
| 560 | SYNC_FILE_RANGE_WRITE |
| 561 | .TP |
| 562 | .RE |
| 563 | .P |
| 564 | So if you do sync_file_range=wait_before,write:8, fio would use |
| 565 | \fBSYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE\fP for every 8 writes. |
| 566 | Also see the sync_file_range(2) man page. This option is Linux specific. |
| 567 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 568 | .BI overwrite \fR=\fPbool |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 569 | If writing, setup the file first and do overwrites. Default: false. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 570 | .TP |
| 571 | .BI end_fsync \fR=\fPbool |
Jens Axboe | dbd11ea | 2013-01-13 17:16:46 +0100 | [diff] [blame] | 572 | Sync file contents when a write stage has completed. Default: false. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 573 | .TP |
| 574 | .BI fsync_on_close \fR=\fPbool |
| 575 | If true, sync file contents on close. This differs from \fBend_fsync\fR in that |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 576 | it will happen on every close, not just at the end of the job. Default: false. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 577 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 578 | .BI rwmixread \fR=\fPint |
| 579 | Percentage of a mixed workload that should be reads. Default: 50. |
| 580 | .TP |
| 581 | .BI rwmixwrite \fR=\fPint |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 582 | Percentage of a mixed workload that should be writes. If \fBrwmixread\fR and |
Jens Axboe | c35dd7a | 2009-06-10 08:39:16 +0200 | [diff] [blame] | 583 | \fBrwmixwrite\fR are given and do not sum to 100%, the latter of the two |
| 584 | overrides the first. This may interfere with a given rate setting, if fio is |
| 585 | asked to limit reads or writes to a certain rate. If that is the case, then |
| 586 | the distribution may be skewed. Default: 50. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 587 | .TP |
Jens Axboe | 92d42d6 | 2012-11-15 15:38:32 -0700 | [diff] [blame] | 588 | .BI random_distribution \fR=\fPstr:float |
| 589 | By default, fio will use a completely uniform random distribution when asked |
| 590 | to perform random IO. Sometimes it is useful to skew the distribution in |
| 591 | specific ways, ensuring that some parts of the data is more hot than others. |
| 592 | Fio includes the following distribution models: |
| 593 | .RS |
| 594 | .TP |
| 595 | .B random |
| 596 | Uniform random distribution |
| 597 | .TP |
| 598 | .B zipf |
| 599 | Zipf distribution |
| 600 | .TP |
| 601 | .B pareto |
| 602 | Pareto distribution |
| 603 | .TP |
| 604 | .RE |
| 605 | .P |
| 606 | When using a zipf or pareto distribution, an input value is also needed to |
| 607 | define the access pattern. For zipf, this is the zipf theta. For pareto, |
| 608 | it's the pareto power. Fio includes a test program, genzipf, that can be |
| 609 | used visualize what the given input values will yield in terms of hit rates. |
| 610 | If you wanted to use zipf with a theta of 1.2, you would use |
| 611 | random_distribution=zipf:1.2 as the option. If a non-uniform model is used, |
| 612 | fio will disable use of the random map. |
| 613 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 614 | .B norandommap |
| 615 | Normally \fBfio\fR will cover every block of the file when doing random I/O. If |
| 616 | this parameter is given, a new offset will be chosen without looking at past |
| 617 | I/O history. This parameter is mutually exclusive with \fBverify\fR. |
| 618 | .TP |
Jens Axboe | 744492c | 2011-08-08 09:47:13 +0200 | [diff] [blame] | 619 | .BI softrandommap \fR=\fPbool |
Jens Axboe | 3ce9dca | 2009-06-10 08:55:21 +0200 | [diff] [blame] | 620 | See \fBnorandommap\fR. If fio runs with the random block map enabled and it |
| 621 | fails to allocate the map, if this option is set it will continue without a |
| 622 | random block map. As coverage will not be as complete as with random maps, this |
| 623 | option is disabled by default. |
| 624 | .TP |
Jens Axboe | e8b1961 | 2012-12-05 10:28:08 +0100 | [diff] [blame] | 625 | .BI random_generator \fR=\fPstr |
| 626 | Fio supports the following engines for generating IO offsets for random IO: |
| 627 | .RS |
| 628 | .TP |
| 629 | .B tausworthe |
| 630 | Strong 2^88 cycle random number generator |
| 631 | .TP |
| 632 | .B lfsr |
| 633 | Linear feedback shift register generator |
| 634 | .TP |
| 635 | .RE |
| 636 | .P |
| 637 | Tausworthe is a strong random number generator, but it requires tracking on the |
| 638 | side if we want to ensure that blocks are only read or written once. LFSR |
| 639 | guarantees that we never generate the same offset twice, and it's also less |
| 640 | computationally expensive. It's not a true random generator, however, though |
| 641 | for IO purposes it's typically good enough. LFSR only works with single block |
| 642 | sizes, not with workloads that use multiple block sizes. If used with such a |
| 643 | workload, fio may read or write some blocks multiple times. |
| 644 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 645 | .BI nice \fR=\fPint |
| 646 | Run job with given nice value. See \fInice\fR\|(2). |
| 647 | .TP |
| 648 | .BI prio \fR=\fPint |
| 649 | Set I/O priority value of this job between 0 (highest) and 7 (lowest). See |
| 650 | \fIionice\fR\|(1). |
| 651 | .TP |
| 652 | .BI prioclass \fR=\fPint |
| 653 | Set I/O priority class. See \fIionice\fR\|(1). |
| 654 | .TP |
| 655 | .BI thinktime \fR=\fPint |
| 656 | Stall job for given number of microseconds between issuing I/Os. |
| 657 | .TP |
| 658 | .BI thinktime_spin \fR=\fPint |
| 659 | Pretend to spend CPU time for given number of microseconds, sleeping the rest |
| 660 | of the time specified by \fBthinktime\fR. Only valid if \fBthinktime\fR is set. |
| 661 | .TP |
| 662 | .BI thinktime_blocks \fR=\fPint |
| 663 | Number of blocks to issue before waiting \fBthinktime\fR microseconds. |
| 664 | Default: 1. |
| 665 | .TP |
| 666 | .BI rate \fR=\fPint |
Jens Axboe | c35dd7a | 2009-06-10 08:39:16 +0200 | [diff] [blame] | 667 | Cap bandwidth used by this job. The number is in bytes/sec, the normal postfix |
| 668 | rules apply. You can use \fBrate\fR=500k to limit reads and writes to 500k each, |
| 669 | or you can specify read and writes separately. Using \fBrate\fR=1m,500k would |
| 670 | limit reads to 1MB/sec and writes to 500KB/sec. Capping only reads or writes |
| 671 | can be done with \fBrate\fR=,500k or \fBrate\fR=500k,. The former will only |
| 672 | limit writes (to 500KB/sec), the latter will only limit reads. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 673 | .TP |
| 674 | .BI ratemin \fR=\fPint |
| 675 | Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth. |
Jens Axboe | c35dd7a | 2009-06-10 08:39:16 +0200 | [diff] [blame] | 676 | Failing to meet this requirement will cause the job to exit. The same format |
| 677 | as \fBrate\fR is used for read vs write separation. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 678 | .TP |
| 679 | .BI rate_iops \fR=\fPint |
Jens Axboe | c35dd7a | 2009-06-10 08:39:16 +0200 | [diff] [blame] | 680 | Cap the bandwidth to this number of IOPS. Basically the same as rate, just |
| 681 | specified independently of bandwidth. The same format as \fBrate\fR is used for |
| 682 | read vs write seperation. If \fBblocksize\fR is a range, the smallest block |
| 683 | size is used as the metric. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 684 | .TP |
| 685 | .BI rate_iops_min \fR=\fPint |
Jens Axboe | c35dd7a | 2009-06-10 08:39:16 +0200 | [diff] [blame] | 686 | If this rate of I/O is not met, the job will exit. The same format as \fBrate\fR |
| 687 | is used for read vs write seperation. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 688 | .TP |
| 689 | .BI ratecycle \fR=\fPint |
| 690 | Average bandwidth for \fBrate\fR and \fBratemin\fR over this number of |
| 691 | milliseconds. Default: 1000ms. |
| 692 | .TP |
Jens Axboe | 1550153 | 2012-10-24 16:37:45 +0200 | [diff] [blame] | 693 | .BI max_latency \fR=\fPint |
| 694 | If set, fio will exit the job if it exceeds this maximum latency. It will exit |
| 695 | with an ETIME error. |
| 696 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 697 | .BI cpumask \fR=\fPint |
| 698 | Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job |
| 699 | may run on. See \fBsched_setaffinity\fR\|(2). |
| 700 | .TP |
| 701 | .BI cpus_allowed \fR=\fPstr |
| 702 | Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers. |
| 703 | .TP |
Yufei Ren | d0b937e | 2012-10-19 23:11:52 -0400 | [diff] [blame] | 704 | .BI numa_cpu_nodes \fR=\fPstr |
| 705 | Set this job running on spcified NUMA nodes' CPUs. The arguments allow |
| 706 | comma delimited list of cpu numbers, A-B ranges, or 'all'. |
| 707 | .TP |
| 708 | .BI numa_mem_policy \fR=\fPstr |
| 709 | Set this job's memory policy and corresponding NUMA nodes. Format of |
| 710 | the argements: |
| 711 | .RS |
| 712 | .TP |
| 713 | .B <mode>[:<nodelist>] |
| 714 | .TP |
| 715 | .B mode |
| 716 | is one of the following memory policy: |
| 717 | .TP |
| 718 | .B default, prefer, bind, interleave, local |
| 719 | .TP |
| 720 | .RE |
| 721 | For \fBdefault\fR and \fBlocal\fR memory policy, no \fBnodelist\fR is |
| 722 | needed to be specified. For \fBprefer\fR, only one node is |
| 723 | allowed. For \fBbind\fR and \fBinterleave\fR, \fBnodelist\fR allows |
| 724 | comma delimited list of numbers, A-B ranges, or 'all'. |
| 725 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 726 | .BI startdelay \fR=\fPint |
| 727 | Delay start of job for the specified number of seconds. |
| 728 | .TP |
| 729 | .BI runtime \fR=\fPint |
| 730 | Terminate processing after the specified number of seconds. |
| 731 | .TP |
| 732 | .B time_based |
| 733 | If given, run for the specified \fBruntime\fR duration even if the files are |
| 734 | completely read or written. The same workload will be repeated as many times |
| 735 | as \fBruntime\fR allows. |
| 736 | .TP |
Jens Axboe | 901bb99 | 2009-03-14 20:17:36 +0100 | [diff] [blame] | 737 | .BI ramp_time \fR=\fPint |
| 738 | If set, fio will run the specified workload for this amount of time before |
| 739 | logging any performance numbers. Useful for letting performance settle before |
| 740 | logging results, thus minimizing the runtime required for stable results. Note |
Jens Axboe | c35dd7a | 2009-06-10 08:39:16 +0200 | [diff] [blame] | 741 | that the \fBramp_time\fR is considered lead in time for a job, thus it will |
| 742 | increase the total runtime if a special timeout or runtime is specified. |
Jens Axboe | 901bb99 | 2009-03-14 20:17:36 +0100 | [diff] [blame] | 743 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 744 | .BI invalidate \fR=\fPbool |
| 745 | Invalidate buffer-cache for the file prior to starting I/O. Default: true. |
| 746 | .TP |
| 747 | .BI sync \fR=\fPbool |
| 748 | Use synchronous I/O for buffered writes. For the majority of I/O engines, |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 749 | this means using O_SYNC. Default: false. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 750 | .TP |
| 751 | .BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr |
| 752 | Allocation method for I/O unit buffer. Allowed values are: |
| 753 | .RS |
| 754 | .RS |
| 755 | .TP |
| 756 | .B malloc |
| 757 | Allocate memory with \fImalloc\fR\|(3). |
| 758 | .TP |
| 759 | .B shm |
| 760 | Use shared memory buffers allocated through \fIshmget\fR\|(2). |
| 761 | .TP |
| 762 | .B shmhuge |
| 763 | Same as \fBshm\fR, but use huge pages as backing. |
| 764 | .TP |
| 765 | .B mmap |
| 766 | Use \fImmap\fR\|(2) for allocation. Uses anonymous memory unless a filename |
| 767 | is given after the option in the format `:\fIfile\fR'. |
| 768 | .TP |
| 769 | .B mmaphuge |
| 770 | Same as \fBmmap\fR, but use huge files as backing. |
| 771 | .RE |
| 772 | .P |
| 773 | The amount of memory allocated is the maximum allowed \fBblocksize\fR for the |
| 774 | job multiplied by \fBiodepth\fR. For \fBshmhuge\fR or \fBmmaphuge\fR to work, |
| 775 | the system must have free huge pages allocated. \fBmmaphuge\fR also needs to |
Jens Axboe | 2e266ba | 2009-09-14 08:56:53 +0200 | [diff] [blame] | 776 | have hugetlbfs mounted, and \fIfile\fR must point there. At least on Linux, |
| 777 | huge pages must be manually allocated. See \fB/proc/sys/vm/nr_hugehages\fR |
| 778 | and the documentation for that. Normally you just need to echo an appropriate |
| 779 | number, eg echoing 8 will ensure that the OS has 8 huge pages ready for |
| 780 | use. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 781 | .RE |
| 782 | .TP |
Jens Axboe | d392365 | 2011-08-03 12:38:39 +0200 | [diff] [blame] | 783 | .BI iomem_align \fR=\fPint "\fR,\fP mem_align" \fR=\fPint |
Jens Axboe | d529ee1 | 2009-07-01 10:33:03 +0200 | [diff] [blame] | 784 | This indiciates the memory alignment of the IO memory buffers. Note that the |
| 785 | given alignment is applied to the first IO unit buffer, if using \fBiodepth\fR |
| 786 | the alignment of the following buffers are given by the \fBbs\fR used. In |
| 787 | other words, if using a \fBbs\fR that is a multiple of the page sized in the |
| 788 | system, all buffers will be aligned to this value. If using a \fBbs\fR that |
| 789 | is not page aligned, the alignment of subsequent IO memory buffers is the |
| 790 | sum of the \fBiomem_align\fR and \fBbs\fR used. |
| 791 | .TP |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 792 | .BI hugepage\-size \fR=\fPint |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 793 | Defines the size of a huge page. Must be at least equal to the system setting. |
Jens Axboe | b22989b | 2009-07-17 22:29:23 +0200 | [diff] [blame] | 794 | Should be a multiple of 1MB. Default: 4MB. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 795 | .TP |
| 796 | .B exitall |
| 797 | Terminate all jobs when one finishes. Default: wait for each job to finish. |
| 798 | .TP |
| 799 | .BI bwavgtime \fR=\fPint |
| 800 | Average bandwidth calculations over the given time in milliseconds. Default: |
| 801 | 500ms. |
| 802 | .TP |
Jens Axboe | c8eeb9d | 2011-10-05 14:02:22 +0200 | [diff] [blame] | 803 | .BI iopsavgtime \fR=\fPint |
| 804 | Average IOPS calculations over the given time in milliseconds. Default: |
| 805 | 500ms. |
| 806 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 807 | .BI create_serialize \fR=\fPbool |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 808 | If true, serialize file creation for the jobs. Default: true. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 809 | .TP |
| 810 | .BI create_fsync \fR=\fPbool |
| 811 | \fIfsync\fR\|(2) data file after creation. Default: true. |
| 812 | .TP |
Jens Axboe | 6b7f685 | 2009-03-09 14:22:56 +0100 | [diff] [blame] | 813 | .BI create_on_open \fR=\fPbool |
| 814 | If true, the files are not created until they are opened for IO by the job. |
| 815 | .TP |
Jens Axboe | 25460cf | 2012-05-02 13:58:02 +0200 | [diff] [blame] | 816 | .BI create_only \fR=\fPbool |
| 817 | If true, fio will only run the setup phase of the job. If files need to be |
| 818 | laid out or updated on disk, only that will be done. The actual job contents |
| 819 | are not executed. |
| 820 | .TP |
Jens Axboe | e9f4847 | 2009-06-03 12:14:08 +0200 | [diff] [blame] | 821 | .BI pre_read \fR=\fPbool |
| 822 | If this is given, files will be pre-read into memory before starting the given |
| 823 | IO operation. This will also clear the \fR \fBinvalidate\fR flag, since it is |
Jens Axboe | 9c0d224 | 2009-07-01 12:26:28 +0200 | [diff] [blame] | 824 | pointless to pre-read and then drop the cache. This will only work for IO |
| 825 | engines that are seekable, since they allow you to read the same data |
| 826 | multiple times. Thus it will not work on eg network or splice IO. |
Jens Axboe | e9f4847 | 2009-06-03 12:14:08 +0200 | [diff] [blame] | 827 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 828 | .BI unlink \fR=\fPbool |
| 829 | Unlink job files when done. Default: false. |
| 830 | .TP |
| 831 | .BI loops \fR=\fPint |
| 832 | Specifies the number of iterations (runs of the same workload) of this job. |
| 833 | Default: 1. |
| 834 | .TP |
| 835 | .BI do_verify \fR=\fPbool |
| 836 | Run the verify phase after a write phase. Only valid if \fBverify\fR is set. |
| 837 | Default: true. |
| 838 | .TP |
| 839 | .BI verify \fR=\fPstr |
| 840 | Method of verifying file contents after each iteration of the job. Allowed |
| 841 | values are: |
| 842 | .RS |
| 843 | .RS |
| 844 | .TP |
Jens Axboe | b892dc0 | 2009-09-05 20:37:35 +0200 | [diff] [blame] | 845 | .B md5 crc16 crc32 crc32c crc32c-intel crc64 crc7 sha256 sha512 sha1 |
Jens Axboe | 0539d75 | 2010-06-21 15:22:56 +0200 | [diff] [blame] | 846 | Store appropriate checksum in the header of each block. crc32c-intel is |
| 847 | hardware accelerated SSE4.2 driven, falls back to regular crc32c if |
| 848 | not supported by the system. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 849 | .TP |
| 850 | .B meta |
| 851 | Write extra information about each I/O (timestamp, block number, etc.). The |
Jens Axboe | 996093b | 2010-06-24 08:37:13 +0200 | [diff] [blame] | 852 | block number is verified. See \fBverify_pattern\fR as well. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 853 | .TP |
| 854 | .B null |
| 855 | Pretend to verify. Used for testing internals. |
| 856 | .RE |
Jens Axboe | b892dc0 | 2009-09-05 20:37:35 +0200 | [diff] [blame] | 857 | |
| 858 | This option can be used for repeated burn-in tests of a system to make sure |
| 859 | that the written data is also correctly read back. If the data direction given |
| 860 | is a read or random read, fio will assume that it should verify a previously |
| 861 | written file. If the data direction includes any form of write, the verify will |
| 862 | be of the newly written data. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 863 | .RE |
| 864 | .TP |
| 865 | .BI verify_sort \fR=\fPbool |
| 866 | If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to |
| 867 | read them back in a sorted manner. Default: true. |
| 868 | .TP |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 869 | .BI verify_offset \fR=\fPint |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 870 | Swap the verification header with data somewhere else in the block before |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 871 | writing. It is swapped back before verifying. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 872 | .TP |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 873 | .BI verify_interval \fR=\fPint |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 874 | Write the verification header for this number of bytes, which should divide |
| 875 | \fBblocksize\fR. Default: \fBblocksize\fR. |
| 876 | .TP |
Jens Axboe | 996093b | 2010-06-24 08:37:13 +0200 | [diff] [blame] | 877 | .BI verify_pattern \fR=\fPstr |
| 878 | If set, fio will fill the io buffers with this pattern. Fio defaults to filling |
| 879 | with totally random bytes, but sometimes it's interesting to fill with a known |
| 880 | pattern for io verification purposes. Depending on the width of the pattern, |
| 881 | fio will fill 1/2/3/4 bytes of the buffer at the time(it can be either a |
| 882 | decimal or a hex number). The verify_pattern if larger than a 32-bit quantity |
| 883 | has to be a hex number that starts with either "0x" or "0X". Use with |
| 884 | \fBverify\fP=meta. |
| 885 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 886 | .BI verify_fatal \fR=\fPbool |
| 887 | If true, exit the job on the first observed verification failure. Default: |
| 888 | false. |
| 889 | .TP |
Jens Axboe | b463e93 | 2011-01-12 09:03:23 +0100 | [diff] [blame] | 890 | .BI verify_dump \fR=\fPbool |
| 891 | If set, dump the contents of both the original data block and the data block we |
| 892 | read off disk to files. This allows later analysis to inspect just what kind of |
Jens Axboe | ef71e31 | 2011-10-25 22:43:36 +0200 | [diff] [blame] | 893 | data corruption occurred. Off by default. |
Jens Axboe | b463e93 | 2011-01-12 09:03:23 +0100 | [diff] [blame] | 894 | .TP |
Jens Axboe | e8462bd | 2009-07-06 12:59:04 +0200 | [diff] [blame] | 895 | .BI verify_async \fR=\fPint |
| 896 | Fio will normally verify IO inline from the submitting thread. This option |
| 897 | takes an integer describing how many async offload threads to create for IO |
| 898 | verification instead, causing fio to offload the duty of verifying IO contents |
Jens Axboe | c85c324 | 2009-07-06 14:12:57 +0200 | [diff] [blame] | 899 | to one or more separate threads. If using this offload option, even sync IO |
| 900 | engines can benefit from using an \fBiodepth\fR setting higher than 1, as it |
| 901 | allows them to have IO in flight while verifies are running. |
Jens Axboe | e8462bd | 2009-07-06 12:59:04 +0200 | [diff] [blame] | 902 | .TP |
| 903 | .BI verify_async_cpus \fR=\fPstr |
| 904 | Tell fio to set the given CPU affinity on the async IO verification threads. |
| 905 | See \fBcpus_allowed\fP for the format used. |
| 906 | .TP |
Jens Axboe | 6f87418 | 2010-06-21 12:53:26 +0200 | [diff] [blame] | 907 | .BI verify_backlog \fR=\fPint |
| 908 | Fio will normally verify the written contents of a job that utilizes verify |
| 909 | once that job has completed. In other words, everything is written then |
| 910 | everything is read back and verified. You may want to verify continually |
| 911 | instead for a variety of reasons. Fio stores the meta data associated with an |
| 912 | IO block in memory, so for large verify workloads, quite a bit of memory would |
David Nellans | 092f707 | 2010-10-26 08:08:42 -0600 | [diff] [blame] | 913 | be used up holding this meta data. If this option is enabled, fio will write |
| 914 | only N blocks before verifying these blocks. |
Jens Axboe | 6f87418 | 2010-06-21 12:53:26 +0200 | [diff] [blame] | 915 | .TP |
| 916 | .BI verify_backlog_batch \fR=\fPint |
| 917 | Control how many blocks fio will verify if verify_backlog is set. If not set, |
| 918 | will default to the value of \fBverify_backlog\fR (meaning the entire queue is |
David Nellans | 092f707 | 2010-10-26 08:08:42 -0600 | [diff] [blame] | 919 | read back and verified). If \fBverify_backlog_batch\fR is less than |
| 920 | \fBverify_backlog\fR then not all blocks will be verified, if |
| 921 | \fBverify_backlog_batch\fR is larger than \fBverify_backlog\fR, some blocks |
| 922 | will be verified more than once. |
Jens Axboe | 6f87418 | 2010-06-21 12:53:26 +0200 | [diff] [blame] | 923 | .TP |
Jens Axboe | d392365 | 2011-08-03 12:38:39 +0200 | [diff] [blame] | 924 | .B stonewall "\fR,\fP wait_for_previous" |
Martin Steigerwald | 5982a92 | 2011-06-27 16:07:24 +0200 | [diff] [blame] | 925 | Wait for preceding jobs in the job file to exit before starting this one. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 926 | \fBstonewall\fR implies \fBnew_group\fR. |
| 927 | .TP |
| 928 | .B new_group |
| 929 | Start a new reporting group. If not given, all jobs in a file will be part |
| 930 | of the same reporting group, unless separated by a stonewall. |
| 931 | .TP |
| 932 | .BI numjobs \fR=\fPint |
| 933 | Number of clones (processes/threads performing the same workload) of this job. |
| 934 | Default: 1. |
| 935 | .TP |
| 936 | .B group_reporting |
| 937 | If set, display per-group reports instead of per-job when \fBnumjobs\fR is |
| 938 | specified. |
| 939 | .TP |
| 940 | .B thread |
| 941 | Use threads created with \fBpthread_create\fR\|(3) instead of processes created |
| 942 | with \fBfork\fR\|(2). |
| 943 | .TP |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 944 | .BI zonesize \fR=\fPint |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 945 | Divide file into zones of the specified size in bytes. See \fBzoneskip\fR. |
| 946 | .TP |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 947 | .BI zoneskip \fR=\fPint |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 948 | Skip the specified number of bytes when \fBzonesize\fR bytes of data have been |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 949 | read. |
| 950 | .TP |
| 951 | .BI write_iolog \fR=\fPstr |
Stefan Hajnoczi | 5b42a48 | 2011-01-08 20:28:41 +0100 | [diff] [blame] | 952 | Write the issued I/O patterns to the specified file. Specify a separate file |
| 953 | for each job, otherwise the iologs will be interspersed and the file may be |
| 954 | corrupt. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 955 | .TP |
| 956 | .BI read_iolog \fR=\fPstr |
| 957 | Replay the I/O patterns contained in the specified file generated by |
| 958 | \fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file. |
| 959 | .TP |
David Nellans | 64bbb86 | 2010-08-24 22:13:30 +0200 | [diff] [blame] | 960 | .BI replay_no_stall \fR=\fPint |
| 961 | While replaying I/O patterns using \fBread_iolog\fR the default behavior |
| 962 | attempts to respect timing information between I/Os. Enabling |
| 963 | \fBreplay_no_stall\fR causes I/Os to be replayed as fast as possible while |
| 964 | still respecting ordering. |
| 965 | .TP |
David Nellans | d1c46c0 | 2010-08-31 21:20:47 +0200 | [diff] [blame] | 966 | .BI replay_redirect \fR=\fPstr |
| 967 | While replaying I/O patterns using \fBread_iolog\fR the default behavior |
| 968 | is to replay the IOPS onto the major/minor device that each IOP was recorded |
| 969 | from. Setting \fBreplay_redirect\fR causes all IOPS to be replayed onto the |
| 970 | single specified device regardless of the device it was recorded from. |
| 971 | .TP |
Steven Noonan | 836bad5 | 2011-09-14 09:21:33 +0200 | [diff] [blame] | 972 | .BI write_bw_log \fR=\fPstr |
Jens Axboe | 901bb99 | 2009-03-14 20:17:36 +0100 | [diff] [blame] | 973 | If given, write a bandwidth log of the jobs in this job file. Can be used to |
| 974 | store data of the bandwidth of the jobs in their lifetime. The included |
| 975 | fio_generate_plots script uses gnuplot to turn these text files into nice |
| 976 | graphs. See \fBwrite_log_log\fR for behaviour of given filename. For this |
| 977 | option, the postfix is _bw.log. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 978 | .TP |
Steven Noonan | 836bad5 | 2011-09-14 09:21:33 +0200 | [diff] [blame] | 979 | .BI write_lat_log \fR=\fPstr |
Jens Axboe | 901bb99 | 2009-03-14 20:17:36 +0100 | [diff] [blame] | 980 | Same as \fBwrite_bw_log\fR, but writes I/O completion latencies. If no |
| 981 | filename is given with this option, the default filename of "jobname_type.log" |
| 982 | is used. Even if the filename is given, fio will still append the type of log. |
| 983 | .TP |
Jens Axboe | c8eeb9d | 2011-10-05 14:02:22 +0200 | [diff] [blame] | 984 | .BI write_iops_log \fR=\fPstr |
| 985 | Same as \fBwrite_bw_log\fR, but writes IOPS. If no filename is given with this |
| 986 | option, the default filename of "jobname_type.log" is used. Even if the |
| 987 | filename is given, fio will still append the type of log. |
| 988 | .TP |
Jens Axboe | b8bc8cb | 2011-12-01 09:04:31 +0100 | [diff] [blame] | 989 | .BI log_avg_msec \fR=\fPint |
| 990 | By default, fio will log an entry in the iops, latency, or bw log for every |
| 991 | IO that completes. When writing to the disk log, that can quickly grow to a |
| 992 | very large size. Setting this option makes fio average the each log entry |
| 993 | over the specified period of time, reducing the resolution of the log. |
| 994 | Defaults to 0. |
| 995 | .TP |
Steven Noonan | 836bad5 | 2011-09-14 09:21:33 +0200 | [diff] [blame] | 996 | .BI disable_lat \fR=\fPbool |
Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 997 | Disable measurements of total latency numbers. Useful only for cutting |
Jens Axboe | 901bb99 | 2009-03-14 20:17:36 +0100 | [diff] [blame] | 998 | back the number of calls to gettimeofday, as that does impact performance at |
| 999 | really high IOPS rates. Note that to really get rid of a large amount of these |
| 1000 | calls, this option must be used with disable_slat and disable_bw as well. |
| 1001 | .TP |
Steven Noonan | 836bad5 | 2011-09-14 09:21:33 +0200 | [diff] [blame] | 1002 | .BI disable_clat \fR=\fPbool |
Steven Noonan | c95f9da | 2011-06-22 09:47:09 +0200 | [diff] [blame] | 1003 | Disable measurements of completion latency numbers. See \fBdisable_lat\fR. |
Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1004 | .TP |
Steven Noonan | 836bad5 | 2011-09-14 09:21:33 +0200 | [diff] [blame] | 1005 | .BI disable_slat \fR=\fPbool |
Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1006 | Disable measurements of submission latency numbers. See \fBdisable_lat\fR. |
Jens Axboe | 901bb99 | 2009-03-14 20:17:36 +0100 | [diff] [blame] | 1007 | .TP |
Steven Noonan | 836bad5 | 2011-09-14 09:21:33 +0200 | [diff] [blame] | 1008 | .BI disable_bw_measurement \fR=\fPbool |
Jens Axboe | 02af098 | 2010-06-24 09:59:34 +0200 | [diff] [blame] | 1009 | Disable measurements of throughput/bandwidth numbers. See \fBdisable_lat\fR. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1010 | .TP |
Jens Axboe | f7fa265 | 2009-03-09 14:20:20 +0100 | [diff] [blame] | 1011 | .BI lockmem \fR=\fPint |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1012 | Pin the specified amount of memory with \fBmlock\fR\|(2). Can be used to |
| 1013 | simulate a smaller amount of memory. |
| 1014 | .TP |
| 1015 | .BI exec_prerun \fR=\fPstr |
| 1016 | Before running the job, execute the specified command with \fBsystem\fR\|(3). |
| 1017 | .TP |
| 1018 | .BI exec_postrun \fR=\fPstr |
| 1019 | Same as \fBexec_prerun\fR, but the command is executed after the job completes. |
| 1020 | .TP |
| 1021 | .BI ioscheduler \fR=\fPstr |
| 1022 | Attempt to switch the device hosting the file to the specified I/O scheduler. |
| 1023 | .TP |
| 1024 | .BI cpuload \fR=\fPint |
| 1025 | If the job is a CPU cycle-eater, attempt to use the specified percentage of |
| 1026 | CPU cycles. |
| 1027 | .TP |
| 1028 | .BI cpuchunks \fR=\fPint |
| 1029 | If the job is a CPU cycle-eater, split the load into cycles of the |
| 1030 | given time in milliseconds. |
| 1031 | .TP |
| 1032 | .BI disk_util \fR=\fPbool |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1033 | Generate disk utilization statistics if the platform supports it. Default: true. |
Jens Axboe | 901bb99 | 2009-03-14 20:17:36 +0100 | [diff] [blame] | 1034 | .TP |
Jens Axboe | 2389364 | 2012-12-17 14:44:08 +0100 | [diff] [blame] | 1035 | .BI clocksource \fR=\fPstr |
| 1036 | Use the given clocksource as the base of timing. The supported options are: |
| 1037 | .RS |
| 1038 | .TP |
| 1039 | .B gettimeofday |
| 1040 | gettimeofday(2) |
| 1041 | .TP |
| 1042 | .B clock_gettime |
| 1043 | clock_gettime(2) |
| 1044 | .TP |
| 1045 | .B cpu |
| 1046 | Internal CPU clock source |
| 1047 | .TP |
| 1048 | .RE |
| 1049 | .P |
| 1050 | \fBcpu\fR is the preferred clocksource if it is reliable, as it is very fast |
| 1051 | (and fio is heavy on time calls). Fio will automatically use this clocksource |
| 1052 | if it's supported and considered reliable on the system it is running on, |
| 1053 | unless another clocksource is specifically set. For x86/x86-64 CPUs, this |
| 1054 | means supporting TSC Invariant. |
| 1055 | .TP |
Jens Axboe | 901bb99 | 2009-03-14 20:17:36 +0100 | [diff] [blame] | 1056 | .BI gtod_reduce \fR=\fPbool |
| 1057 | Enable all of the gettimeofday() reducing options (disable_clat, disable_slat, |
| 1058 | disable_bw) plus reduce precision of the timeout somewhat to really shrink the |
| 1059 | gettimeofday() call count. With this option enabled, we only do about 0.4% of |
| 1060 | the gtod() calls we would have done if all time keeping was enabled. |
| 1061 | .TP |
| 1062 | .BI gtod_cpu \fR=\fPint |
| 1063 | Sometimes it's cheaper to dedicate a single thread of execution to just getting |
| 1064 | the current time. Fio (and databases, for instance) are very intensive on |
| 1065 | gettimeofday() calls. With this option, you can set one CPU aside for doing |
| 1066 | nothing but logging current time to a shared memory location. Then the other |
| 1067 | threads/processes that run IO workloads need only copy that segment, instead of |
| 1068 | entering the kernel with a gettimeofday() call. The CPU set aside for doing |
| 1069 | these time calls will be excluded from other uses. Fio will manually clear it |
| 1070 | from the CPU mask of other jobs. |
Radha Ramachandran | f2bba18 | 2009-06-15 08:40:16 +0200 | [diff] [blame] | 1071 | .TP |
Dmitry Monakhov | 8b28bd4 | 2012-09-23 15:46:09 +0400 | [diff] [blame] | 1072 | .BI ignore_error \fR=\fPstr |
| 1073 | Sometimes you want to ignore some errors during test in that case you can specify |
| 1074 | error list for each error type. |
| 1075 | .br |
| 1076 | ignore_error=READ_ERR_LIST,WRITE_ERR_LIST,VERIFY_ERR_LIST |
| 1077 | .br |
| 1078 | errors for given error type is separated with ':'. |
| 1079 | Error may be symbol ('ENOSPC', 'ENOMEM') or an integer. |
| 1080 | .br |
| 1081 | Example: ignore_error=EAGAIN,ENOSPC:122 . |
| 1082 | .br |
| 1083 | This option will ignore EAGAIN from READ, and ENOSPC and 122(EDQUOT) from WRITE. |
| 1084 | .TP |
| 1085 | .BI error_dump \fR=\fPbool |
| 1086 | If set dump every error even if it is non fatal, true by default. If disabled |
| 1087 | only fatal error will be dumped |
| 1088 | .TP |
Jens Axboe | a696fa2 | 2009-12-04 10:05:02 +0100 | [diff] [blame] | 1089 | .BI cgroup \fR=\fPstr |
| 1090 | Add job to this control group. If it doesn't exist, it will be created. |
Jens Axboe | 6adb38a | 2009-12-07 08:01:26 +0100 | [diff] [blame] | 1091 | The system must have a mounted cgroup blkio mount point for this to work. If |
| 1092 | your system doesn't have it mounted, you can do so with: |
| 1093 | |
Martin Steigerwald | 5982a92 | 2011-06-27 16:07:24 +0200 | [diff] [blame] | 1094 | # mount \-t cgroup \-o blkio none /cgroup |
Jens Axboe | a696fa2 | 2009-12-04 10:05:02 +0100 | [diff] [blame] | 1095 | .TP |
| 1096 | .BI cgroup_weight \fR=\fPint |
| 1097 | Set the weight of the cgroup to this value. See the documentation that comes |
| 1098 | with the kernel, allowed values are in the range of 100..1000. |
Jens Axboe | e0b0d89 | 2009-12-08 10:10:14 +0100 | [diff] [blame] | 1099 | .TP |
Vivek Goyal | 7de8709 | 2010-03-31 22:55:15 +0200 | [diff] [blame] | 1100 | .BI cgroup_nodelete \fR=\fPbool |
| 1101 | Normally fio will delete the cgroups it has created after the job completion. |
| 1102 | To override this behavior and to leave cgroups around after the job completion, |
| 1103 | set cgroup_nodelete=1. This can be useful if one wants to inspect various |
| 1104 | cgroup files after job completion. Default: false |
| 1105 | .TP |
Jens Axboe | e0b0d89 | 2009-12-08 10:10:14 +0100 | [diff] [blame] | 1106 | .BI uid \fR=\fPint |
| 1107 | Instead of running as the invoking user, set the user ID to this value before |
| 1108 | the thread/process does any work. |
| 1109 | .TP |
| 1110 | .BI gid \fR=\fPint |
| 1111 | Set group ID, see \fBuid\fR. |
Yu-ju Hong | 8334919 | 2011-08-13 00:53:44 +0200 | [diff] [blame] | 1112 | .TP |
Dan Ehrenberg | 9e684a4 | 2012-02-20 11:05:14 +0100 | [diff] [blame] | 1113 | .BI flow_id \fR=\fPint |
| 1114 | The ID of the flow. If not specified, it defaults to being a global flow. See |
| 1115 | \fBflow\fR. |
| 1116 | .TP |
| 1117 | .BI flow \fR=\fPint |
| 1118 | Weight in token-based flow control. If this value is used, then there is a |
| 1119 | \fBflow counter\fR which is used to regulate the proportion of activity between |
| 1120 | two or more jobs. fio attempts to keep this flow counter near zero. The |
| 1121 | \fBflow\fR parameter stands for how much should be added or subtracted to the |
| 1122 | flow counter on each iteration of the main I/O loop. That is, if one job has |
| 1123 | \fBflow=8\fR and another job has \fBflow=-1\fR, then there will be a roughly |
| 1124 | 1:8 ratio in how much one runs vs the other. |
| 1125 | .TP |
| 1126 | .BI flow_watermark \fR=\fPint |
| 1127 | The maximum value that the absolute value of the flow counter is allowed to |
| 1128 | reach before the job must wait for a lower value of the counter. |
| 1129 | .TP |
| 1130 | .BI flow_sleep \fR=\fPint |
| 1131 | The period of time, in microseconds, to wait after the flow watermark has been |
| 1132 | exceeded before retrying operations |
| 1133 | .TP |
Yu-ju Hong | 8334919 | 2011-08-13 00:53:44 +0200 | [diff] [blame] | 1134 | .BI clat_percentiles \fR=\fPbool |
| 1135 | Enable the reporting of percentiles of completion latencies. |
| 1136 | .TP |
| 1137 | .BI percentile_list \fR=\fPfloat_list |
| 1138 | Overwrite the default list of percentiles for completion |
| 1139 | latencies. Each number is a floating number in the range (0,100], and |
| 1140 | the maximum length of the list is 20. Use ':' to separate the |
Martin Steigerwald | 3eb0728 | 2011-10-05 11:41:54 +0200 | [diff] [blame] | 1141 | numbers. For example, \-\-percentile_list=99.5:99.9 will cause fio to |
Yu-ju Hong | 8334919 | 2011-08-13 00:53:44 +0200 | [diff] [blame] | 1142 | report the values of completion latency below which 99.5% and 99.9% of |
| 1143 | the observed latencies fell, respectively. |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 1144 | .SS "Ioengine Parameters List" |
| 1145 | Some parameters are only valid when a specific ioengine is in use. These are |
| 1146 | used identically to normal parameters, with the caveat that when used on the |
| 1147 | command line, the must come after the ioengine that defines them is selected. |
| 1148 | .TP |
| 1149 | .BI (libaio)userspace_reap |
| 1150 | Normally, with the libaio engine in use, fio will use |
| 1151 | the io_getevents system call to reap newly returned events. |
| 1152 | With this flag turned on, the AIO ring will be read directly |
| 1153 | from user-space to reap events. The reaping mode is only |
| 1154 | enabled when polling for a minimum of 0 events (eg when |
| 1155 | iodepth_batch_complete=0). |
| 1156 | .TP |
| 1157 | .BI (net,netsplice)hostname \fR=\fPstr |
| 1158 | The host name or IP address to use for TCP or UDP based IO. |
| 1159 | If the job is a TCP listener or UDP reader, the hostname is not |
| 1160 | used and must be omitted. |
| 1161 | .TP |
| 1162 | .BI (net,netsplice)port \fR=\fPint |
| 1163 | The TCP or UDP port to bind to or connect to. |
| 1164 | .TP |
Jens Axboe | 1d360ff | 2013-01-31 13:33:45 +0100 | [diff] [blame] | 1165 | .BI (net,netsplice)nodelay \fR=\fPbool |
| 1166 | Set TCP_NODELAY on TCP connections. |
| 1167 | .TP |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 1168 | .BI (net,netsplice)protocol \fR=\fPstr "\fR,\fP proto" \fR=\fPstr |
| 1169 | The network protocol to use. Accepted values are: |
| 1170 | .RS |
| 1171 | .RS |
| 1172 | .TP |
| 1173 | .B tcp |
| 1174 | Transmission control protocol |
| 1175 | .TP |
| 1176 | .B udp |
Bruce Cran | f5cc3d0 | 2012-10-10 08:17:44 -0600 | [diff] [blame] | 1177 | User datagram protocol |
Steven Lang | de890a1 | 2011-11-09 14:03:34 +0100 | [diff] [blame] | 1178 | .TP |
| 1179 | .B unix |
| 1180 | UNIX domain socket |
| 1181 | .RE |
| 1182 | .P |
| 1183 | When the protocol is TCP or UDP, the port must also be given, |
| 1184 | as well as the hostname if the job is a TCP listener or UDP |
| 1185 | reader. For unix sockets, the normal filename option should be |
| 1186 | used and the port is invalid. |
| 1187 | .RE |
| 1188 | .TP |
| 1189 | .BI (net,netsplice)listen |
| 1190 | For TCP network connections, tell fio to listen for incoming |
| 1191 | connections rather than initiating an outgoing connection. The |
| 1192 | hostname must be omitted if this option is used. |
Dmitry Monakhov | d54fce8 | 2012-09-20 15:37:17 +0400 | [diff] [blame] | 1193 | .TP |
Jens Axboe | 7aeb1e9 | 2012-12-06 20:53:57 +0100 | [diff] [blame] | 1194 | .BI (net, pingpong) \fR=\fPbool |
| 1195 | Normal a network writer will just continue writing data, and a network reader |
| 1196 | will just consume packages. If pingpong=1 is set, a writer will send its normal |
| 1197 | payload to the reader, then wait for the reader to send the same payload back. |
| 1198 | This allows fio to measure network latencies. The submission and completion |
| 1199 | latencies then measure local time spent sending or receiving, and the |
| 1200 | completion latency measures how long it took for the other end to receive and |
| 1201 | send back. |
| 1202 | .TP |
Dmitry Monakhov | d54fce8 | 2012-09-20 15:37:17 +0400 | [diff] [blame] | 1203 | .BI (e4defrag,donorname) \fR=\fPstr |
| 1204 | File will be used as a block donor (swap extents between files) |
| 1205 | .TP |
| 1206 | .BI (e4defrag,inplace) \fR=\fPint |
| 1207 | Configure donor file block allocation strategy |
| 1208 | .RS |
| 1209 | .BI 0(default) : |
| 1210 | Preallocate donor's file on init |
| 1211 | .TP |
| 1212 | .BI 1: |
| 1213 | allocate space immidietly inside defragment event, and free right after event |
| 1214 | .RE |
| 1215 | .TP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1216 | .SH OUTPUT |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1217 | While running, \fBfio\fR will display the status of the created jobs. For |
| 1218 | example: |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1219 | .RS |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1220 | .P |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1221 | Threads: 1: [_r] [24.8% done] [ 13509/ 8334 kb/s] [eta 00h:01m:31s] |
| 1222 | .RE |
| 1223 | .P |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1224 | The characters in the first set of brackets denote the current status of each |
| 1225 | threads. The possible values are: |
| 1226 | .P |
| 1227 | .PD 0 |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1228 | .RS |
| 1229 | .TP |
| 1230 | .B P |
| 1231 | Setup but not started. |
| 1232 | .TP |
| 1233 | .B C |
| 1234 | Thread created. |
| 1235 | .TP |
| 1236 | .B I |
| 1237 | Initialized, waiting. |
| 1238 | .TP |
| 1239 | .B R |
| 1240 | Running, doing sequential reads. |
| 1241 | .TP |
| 1242 | .B r |
| 1243 | Running, doing random reads. |
| 1244 | .TP |
| 1245 | .B W |
| 1246 | Running, doing sequential writes. |
| 1247 | .TP |
| 1248 | .B w |
| 1249 | Running, doing random writes. |
| 1250 | .TP |
| 1251 | .B M |
| 1252 | Running, doing mixed sequential reads/writes. |
| 1253 | .TP |
| 1254 | .B m |
| 1255 | Running, doing mixed random reads/writes. |
| 1256 | .TP |
| 1257 | .B F |
| 1258 | Running, currently waiting for \fBfsync\fR\|(2). |
| 1259 | .TP |
| 1260 | .B V |
| 1261 | Running, verifying written data. |
| 1262 | .TP |
| 1263 | .B E |
| 1264 | Exited, not reaped by main thread. |
| 1265 | .TP |
| 1266 | .B \- |
| 1267 | Exited, thread reaped. |
| 1268 | .RE |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1269 | .PD |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1270 | .P |
| 1271 | The second set of brackets shows the estimated completion percentage of |
| 1272 | the current group. The third set shows the read and write I/O rate, |
| 1273 | respectively. Finally, the estimated run time of the job is displayed. |
| 1274 | .P |
| 1275 | When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data |
| 1276 | for each thread, each group of threads, and each disk, in that order. |
| 1277 | .P |
| 1278 | Per-thread statistics first show the threads client number, group-id, and |
| 1279 | error code. The remaining figures are as follows: |
| 1280 | .RS |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1281 | .TP |
| 1282 | .B io |
| 1283 | Number of megabytes of I/O performed. |
| 1284 | .TP |
| 1285 | .B bw |
| 1286 | Average data rate (bandwidth). |
| 1287 | .TP |
| 1288 | .B runt |
| 1289 | Threads run time. |
| 1290 | .TP |
| 1291 | .B slat |
| 1292 | Submission latency minimum, maximum, average and standard deviation. This is |
| 1293 | the time it took to submit the I/O. |
| 1294 | .TP |
| 1295 | .B clat |
| 1296 | Completion latency minimum, maximum, average and standard deviation. This |
| 1297 | is the time between submission and completion. |
| 1298 | .TP |
| 1299 | .B bw |
| 1300 | Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average |
| 1301 | and standard deviation. |
| 1302 | .TP |
| 1303 | .B cpu |
| 1304 | CPU usage statistics. Includes user and system time, number of context switches |
| 1305 | this thread went through and number of major and minor page faults. |
| 1306 | .TP |
| 1307 | .B IO depths |
| 1308 | Distribution of I/O depths. Each depth includes everything less than (or equal) |
| 1309 | to it, but greater than the previous depth. |
| 1310 | .TP |
| 1311 | .B IO issued |
| 1312 | Number of read/write requests issued, and number of short read/write requests. |
| 1313 | .TP |
| 1314 | .B IO latencies |
| 1315 | Distribution of I/O completion latencies. The numbers follow the same pattern |
| 1316 | as \fBIO depths\fR. |
| 1317 | .RE |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1318 | .P |
| 1319 | The group statistics show: |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1320 | .PD 0 |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1321 | .RS |
| 1322 | .TP |
| 1323 | .B io |
| 1324 | Number of megabytes I/O performed. |
| 1325 | .TP |
| 1326 | .B aggrb |
| 1327 | Aggregate bandwidth of threads in the group. |
| 1328 | .TP |
| 1329 | .B minb |
| 1330 | Minimum average bandwidth a thread saw. |
| 1331 | .TP |
| 1332 | .B maxb |
| 1333 | Maximum average bandwidth a thread saw. |
| 1334 | .TP |
| 1335 | .B mint |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1336 | Shortest runtime of threads in the group. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1337 | .TP |
| 1338 | .B maxt |
| 1339 | Longest runtime of threads in the group. |
| 1340 | .RE |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1341 | .PD |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1342 | .P |
| 1343 | Finally, disk statistics are printed with reads first: |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1344 | .PD 0 |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1345 | .RS |
| 1346 | .TP |
| 1347 | .B ios |
| 1348 | Number of I/Os performed by all groups. |
| 1349 | .TP |
| 1350 | .B merge |
| 1351 | Number of merges in the I/O scheduler. |
| 1352 | .TP |
| 1353 | .B ticks |
| 1354 | Number of ticks we kept the disk busy. |
| 1355 | .TP |
| 1356 | .B io_queue |
| 1357 | Total time spent in the disk queue. |
| 1358 | .TP |
| 1359 | .B util |
| 1360 | Disk utilization. |
| 1361 | .RE |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1362 | .PD |
Jens Axboe | 8423bd1 | 2012-04-12 09:18:38 +0200 | [diff] [blame] | 1363 | .P |
| 1364 | It is also possible to get fio to dump the current output while it is |
| 1365 | running, without terminating the job. To do that, send fio the \fBUSR1\fR |
| 1366 | signal. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1367 | .SH TERSE OUTPUT |
| 1368 | If the \fB\-\-minimal\fR option is given, the results will be printed in a |
David Nellans | 562c2d2 | 2010-09-23 08:38:17 +0200 | [diff] [blame] | 1369 | semicolon-delimited format suitable for scripted use - a job description |
| 1370 | (if provided) follows on a new line. Note that the first |
Jens Axboe | 525c2bf | 2010-06-30 15:22:21 +0200 | [diff] [blame] | 1371 | number in the line is the version number. If the output has to be changed |
| 1372 | for some reason, this number will be incremented by 1 to signify that |
| 1373 | change. The fields are: |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1374 | .P |
| 1375 | .RS |
Jens Axboe | 5e726d0 | 2011-10-14 08:08:10 +0200 | [diff] [blame] | 1376 | .B terse version, fio version, jobname, groupid, error |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1377 | .P |
| 1378 | Read status: |
| 1379 | .RS |
Jens Axboe | 312b4af | 2011-10-13 13:11:42 +0200 | [diff] [blame] | 1380 | .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, IOPS, runtime \fR(ms)\fP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1381 | .P |
| 1382 | Submission latency: |
| 1383 | .RS |
| 1384 | .B min, max, mean, standard deviation |
| 1385 | .RE |
| 1386 | Completion latency: |
| 1387 | .RS |
| 1388 | .B min, max, mean, standard deviation |
| 1389 | .RE |
Jens Axboe | 1db92cb | 2011-10-13 13:43:36 +0200 | [diff] [blame] | 1390 | Completion latency percentiles (20 fields): |
| 1391 | .RS |
| 1392 | .B Xth percentile=usec |
| 1393 | .RE |
Jens Axboe | 525c2bf | 2010-06-30 15:22:21 +0200 | [diff] [blame] | 1394 | Total latency: |
| 1395 | .RS |
| 1396 | .B min, max, mean, standard deviation |
| 1397 | .RE |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1398 | Bandwidth: |
| 1399 | .RS |
| 1400 | .B min, max, aggregate percentage of total, mean, standard deviation |
| 1401 | .RE |
| 1402 | .RE |
| 1403 | .P |
| 1404 | Write status: |
| 1405 | .RS |
Jens Axboe | 312b4af | 2011-10-13 13:11:42 +0200 | [diff] [blame] | 1406 | .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, IOPS, runtime \fR(ms)\fP |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1407 | .P |
| 1408 | Submission latency: |
| 1409 | .RS |
| 1410 | .B min, max, mean, standard deviation |
| 1411 | .RE |
| 1412 | Completion latency: |
| 1413 | .RS |
| 1414 | .B min, max, mean, standard deviation |
| 1415 | .RE |
Jens Axboe | 1db92cb | 2011-10-13 13:43:36 +0200 | [diff] [blame] | 1416 | Completion latency percentiles (20 fields): |
| 1417 | .RS |
| 1418 | .B Xth percentile=usec |
| 1419 | .RE |
Jens Axboe | 525c2bf | 2010-06-30 15:22:21 +0200 | [diff] [blame] | 1420 | Total latency: |
| 1421 | .RS |
| 1422 | .B min, max, mean, standard deviation |
| 1423 | .RE |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1424 | Bandwidth: |
| 1425 | .RS |
| 1426 | .B min, max, aggregate percentage of total, mean, standard deviation |
| 1427 | .RE |
| 1428 | .RE |
| 1429 | .P |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1430 | CPU usage: |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1431 | .RS |
Carl Henrik Lunde | bd2626f | 2008-06-12 09:17:46 +0200 | [diff] [blame] | 1432 | .B user, system, context switches, major page faults, minor page faults |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1433 | .RE |
| 1434 | .P |
| 1435 | IO depth distribution: |
| 1436 | .RS |
| 1437 | .B <=1, 2, 4, 8, 16, 32, >=64 |
| 1438 | .RE |
| 1439 | .P |
David Nellans | 562c2d2 | 2010-09-23 08:38:17 +0200 | [diff] [blame] | 1440 | IO latency distribution: |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1441 | .RS |
David Nellans | 562c2d2 | 2010-09-23 08:38:17 +0200 | [diff] [blame] | 1442 | Microseconds: |
| 1443 | .RS |
| 1444 | .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000 |
| 1445 | .RE |
| 1446 | Milliseconds: |
| 1447 | .RS |
| 1448 | .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000 |
| 1449 | .RE |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1450 | .RE |
| 1451 | .P |
Jens Axboe | f2f788d | 2011-10-13 14:03:52 +0200 | [diff] [blame] | 1452 | Disk utilization (1 for each disk used): |
| 1453 | .RS |
| 1454 | .B name, read ios, write ios, read merges, write merges, read ticks, write ticks, read in-queue time, write in-queue time, disk utilization percentage |
| 1455 | .RE |
| 1456 | .P |
Martin Steigerwald | 5982a92 | 2011-06-27 16:07:24 +0200 | [diff] [blame] | 1457 | Error Info (dependent on continue_on_error, default off): |
David Nellans | 562c2d2 | 2010-09-23 08:38:17 +0200 | [diff] [blame] | 1458 | .RS |
| 1459 | .B total # errors, first error code |
| 1460 | .RE |
| 1461 | .P |
| 1462 | .B text description (if provided in config - appears on newline) |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1463 | .RE |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 1464 | .SH CLIENT / SERVER |
| 1465 | Normally you would run fio as a stand-alone application on the machine |
| 1466 | where the IO workload should be generated. However, it is also possible to |
| 1467 | run the frontend and backend of fio separately. This makes it possible to |
| 1468 | have a fio server running on the machine(s) where the IO workload should |
| 1469 | be running, while controlling it from another machine. |
| 1470 | |
| 1471 | To start the server, you would do: |
| 1472 | |
| 1473 | \fBfio \-\-server=args\fR |
| 1474 | |
| 1475 | on that machine, where args defines what fio listens to. The arguments |
Jens Axboe | 811826b | 2011-10-24 09:11:50 +0200 | [diff] [blame] | 1476 | are of the form 'type:hostname or IP:port'. 'type' is either 'ip' (or ip4) |
Martin Steigerwald | 20c67f1 | 2012-05-07 17:06:26 +0200 | [diff] [blame] | 1477 | for TCP/IP v4, 'ip6' for TCP/IP v6, or 'sock' for a local unix domain |
| 1478 | socket. 'hostname' is either a hostname or IP address, and 'port' is the port to |
Jens Axboe | 811826b | 2011-10-24 09:11:50 +0200 | [diff] [blame] | 1479 | listen to (only valid for TCP/IP, not a local socket). Some examples: |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 1480 | |
Martin Steigerwald | e01e974 | 2012-05-07 17:06:54 +0200 | [diff] [blame] | 1481 | 1) fio \-\-server |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 1482 | |
| 1483 | Start a fio server, listening on all interfaces on the default port (8765). |
| 1484 | |
Martin Steigerwald | e01e974 | 2012-05-07 17:06:54 +0200 | [diff] [blame] | 1485 | 2) fio \-\-server=ip:hostname,4444 |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 1486 | |
| 1487 | Start a fio server, listening on IP belonging to hostname and on port 4444. |
| 1488 | |
Martin Steigerwald | e01e974 | 2012-05-07 17:06:54 +0200 | [diff] [blame] | 1489 | 3) fio \-\-server=ip6:::1,4444 |
Jens Axboe | 811826b | 2011-10-24 09:11:50 +0200 | [diff] [blame] | 1490 | |
| 1491 | Start a fio server, listening on IPv6 localhost ::1 and on port 4444. |
| 1492 | |
Martin Steigerwald | e01e974 | 2012-05-07 17:06:54 +0200 | [diff] [blame] | 1493 | 4) fio \-\-server=,4444 |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 1494 | |
| 1495 | Start a fio server, listening on all interfaces on port 4444. |
| 1496 | |
Martin Steigerwald | e01e974 | 2012-05-07 17:06:54 +0200 | [diff] [blame] | 1497 | 5) fio \-\-server=1.2.3.4 |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 1498 | |
| 1499 | Start a fio server, listening on IP 1.2.3.4 on the default port. |
| 1500 | |
Martin Steigerwald | e01e974 | 2012-05-07 17:06:54 +0200 | [diff] [blame] | 1501 | 6) fio \-\-server=sock:/tmp/fio.sock |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 1502 | |
| 1503 | Start a fio server, listening on the local socket /tmp/fio.sock. |
| 1504 | |
| 1505 | When a server is running, you can connect to it from a client. The client |
| 1506 | is run with: |
| 1507 | |
Martin Steigerwald | e01e974 | 2012-05-07 17:06:54 +0200 | [diff] [blame] | 1508 | fio \-\-local-args \-\-client=server \-\-remote-args <job file(s)> |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 1509 | |
Martin Steigerwald | e01e974 | 2012-05-07 17:06:54 +0200 | [diff] [blame] | 1510 | where \-\-local-args are arguments that are local to the client where it is |
| 1511 | running, 'server' is the connect string, and \-\-remote-args and <job file(s)> |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 1512 | are sent to the server. The 'server' string follows the same format as it |
| 1513 | does on the server side, to allow IP/hostname/socket and port strings. |
| 1514 | You can connect to multiple clients as well, to do that you could run: |
| 1515 | |
Martin Steigerwald | e01e974 | 2012-05-07 17:06:54 +0200 | [diff] [blame] | 1516 | fio \-\-client=server2 \-\-client=server2 <job file(s)> |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1517 | .SH AUTHORS |
Jens Axboe | 49da124 | 2011-10-13 20:17:02 +0200 | [diff] [blame] | 1518 | |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1519 | .B fio |
Jens Axboe | aa58d25 | 2010-06-09 09:49:38 +0200 | [diff] [blame] | 1520 | was written by Jens Axboe <jens.axboe@oracle.com>, |
| 1521 | now Jens Axboe <jaxboe@fusionio.com>. |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1522 | .br |
| 1523 | This man page was written by Aaron Carroll <aaronc@cse.unsw.edu.au> based |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1524 | on documentation by Jens Axboe. |
| 1525 | .SH "REPORTING BUGS" |
Jens Axboe | 482900c | 2009-06-02 12:15:51 +0200 | [diff] [blame] | 1526 | Report bugs to the \fBfio\fR mailing list <fio@vger.kernel.org>. |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1527 | See \fBREADME\fR. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1528 | .SH "SEE ALSO" |
Aaron Carroll | d1429b5 | 2007-09-18 08:10:57 +0200 | [diff] [blame] | 1529 | For further documentation see \fBHOWTO\fR and \fBREADME\fR. |
| 1530 | .br |
| 1531 | Sample jobfiles are available in the \fBexamples\fR directory. |
Aaron Carroll | d60e92d | 2007-09-17 10:32:59 +0200 | [diff] [blame] | 1532 | |