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