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 | |
23 | .BI \-\-timeout \fR=\fPtimeout | |
24 | Limit run time to \fItimeout\fR seconds. | |
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 | |
53 | .B \-\-readonly | |
54 | Enable read-only safety checks. | |
55 | .TP | |
56 | .BI \-\-eta \fR=\fPwhen | |
57 | Specifies when real-time ETA estimate should be printed. \fIwhen\fR may | |
58 | be one of `always', `never' or `auto'. | |
59 | .TP | |
49da1240 JA |
60 | .BI \-\-readonly |
61 | Turn on safety read-only checks, preventing any attempted write. | |
62 | .TP | |
c0a5d35e | 63 | .BI \-\-section \fR=\fPsec |
49da1240 | 64 | Only run section \fIsec\fR from job file. Multiple of these options can be given, adding more sections to run. |
c0a5d35e | 65 | .TP |
49da1240 JA |
66 | .BI \-\-alloc\-size \fR=\fPkb |
67 | Set the internal smalloc pool size to \fIkb\fP kilobytes. | |
d60e92d1 | 68 | .TP |
49da1240 JA |
69 | .BI \-\-warnings\-fatal |
70 | All fio parser warnings are fatal, causing fio to exit with an error. | |
9183788d | 71 | .TP |
49da1240 JA |
72 | .BI \-\-max\-jobs \fR=\fPnr |
73 | Set the maximum allowed number of jobs (threads/processes) to suport. | |
d60e92d1 | 74 | .TP |
49da1240 JA |
75 | .BI \-\-server \fR=\fPargs |
76 | Start a backend server, with \fIargs\fP specifying what to listen to. See client/server section. | |
f57a9c59 | 77 | .TP |
49da1240 JA |
78 | .BI \-\-daemonize \fR=\fPpidfile |
79 | Background a fio server, writing the pid to the given pid file. | |
80 | .TP | |
81 | .BI \-\-client \fR=\fPhost | |
82 | Instead of running the jobs locally, send and run them on the given host. | |
d60e92d1 AC |
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 | |
d1429b5c | 90 | considered a comment and ignored. |
d9956b64 AC |
91 | .P |
92 | If \fIjobfile\fR is specified as `-', the job file will be read from | |
93 | standard input. | |
d60e92d1 AC |
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 | |
d60e92d1 | 107 | SI integer: a whole number, possibly containing a suffix denoting the base unit |
b09da8fa JA |
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 | |
5982a925 MS |
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 | |
57fc29fa JA |
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. | |
d60e92d1 AC |
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 | |
d1429b5c AC |
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'. | |
83349190 YH |
126 | .TP |
127 | .I float_list | |
128 | List of floating numbers: A list of floating numbers, separated by | |
129 | a ':' charcater. | |
d60e92d1 AC |
130 | .SS "Parameter List" |
131 | .TP | |
132 | .BI name \fR=\fPstr | |
d9956b64 | 133 | May be used to override the job name. On the command line, this parameter |
d60e92d1 AC |
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 | |
d1429b5c | 147 | number. If you want to share files between threads in a job or several jobs, |
de890a1e SL |
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 | |
d1429b5c AC |
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. | |
d60e92d1 | 153 | .TP |
3ce9dcaf JA |
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 | |
d60e92d1 AC |
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 | |
d1429b5c | 187 | Sequential reads. |
d60e92d1 AC |
188 | .TP |
189 | .B write | |
d1429b5c | 190 | Sequential writes. |
d60e92d1 AC |
191 | .TP |
192 | .B randread | |
d1429b5c | 193 | Random reads. |
d60e92d1 AC |
194 | .TP |
195 | .B randwrite | |
d1429b5c | 196 | Random writes. |
d60e92d1 AC |
197 | .TP |
198 | .B rw | |
d1429b5c | 199 | Mixed sequential reads and writes. |
d60e92d1 AC |
200 | .TP |
201 | .B randrw | |
d1429b5c | 202 | Mixed random reads and writes. |
d60e92d1 AC |
203 | .RE |
204 | .P | |
38dad62d JA |
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 | |
207 | specify a number of IO's to do before getting a new offset, this is one by | |
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 | |
059b0802 JA |
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. | |
d60e92d1 AC |
214 | .RE |
215 | .TP | |
38dad62d JA |
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 | |
90fef2d1 JA |
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 | |
d60e92d1 AC |
246 | .BI randrepeat \fR=\fPbool |
247 | Seed the random number generator in a predictable way so results are repeatable | |
d1429b5c | 248 | across runs. Default: true. |
d60e92d1 | 249 | .TP |
2615cc4b JA |
250 | .BI use_os_rand \fR=\fPbool |
251 | Fio can either use the random generator supplied by the OS to generator random | |
252 | offsets, or it can use it's own internal generator (based on Tausworthe). | |
253 | Default is to use the internal generator, which is often of better quality and | |
254 | faster. Default: false. | |
255 | .TP | |
a596f047 EG |
256 | .BI fallocate \fR=\fPstr |
257 | Whether pre-allocation is performed when laying down files. Accepted values | |
258 | are: | |
259 | .RS | |
260 | .RS | |
261 | .TP | |
262 | .B none | |
263 | Do not pre-allocate space. | |
264 | .TP | |
265 | .B posix | |
266 | Pre-allocate via posix_fallocate(). | |
267 | .TP | |
268 | .B keep | |
269 | Pre-allocate via fallocate() with FALLOC_FL_KEEP_SIZE set. | |
270 | .TP | |
271 | .B 0 | |
272 | Backward-compatible alias for 'none'. | |
273 | .TP | |
274 | .B 1 | |
275 | Backward-compatible alias for 'posix'. | |
276 | .RE | |
277 | .P | |
278 | May not be available on all supported platforms. 'keep' is only | |
279 | available on Linux. If using ZFS on Solaris this must be set to 'none' | |
280 | because ZFS doesn't support it. Default: 'posix'. | |
281 | .RE | |
7bc8c2cf | 282 | .TP |
d60e92d1 | 283 | .BI fadvise_hint \fR=\fPbool |
d1429b5c AC |
284 | Disable use of \fIposix_fadvise\fR\|(2) to advise the kernel what I/O patterns |
285 | are likely to be issued. Default: true. | |
d60e92d1 | 286 | .TP |
f7fa2653 | 287 | .BI size \fR=\fPint |
d60e92d1 AC |
288 | Total size of I/O for this job. \fBfio\fR will run until this many bytes have |
289 | been transfered, unless limited by other options (\fBruntime\fR, for instance). | |
d7c8be03 | 290 | Unless \fBnrfiles\fR and \fBfilesize\fR options are given, this amount will be |
d6667268 JA |
291 | divided between the available files for the job. If not set, fio will use the |
292 | full size of the given files or devices. If the the files do not exist, size | |
7bb59102 JA |
293 | must be given. It is also possible to give size as a percentage between 1 and |
294 | 100. If size=20% is given, fio will use 20% of the full size of the given files | |
295 | or devices. | |
d60e92d1 | 296 | .TP |
74586c1e | 297 | .BI fill_device \fR=\fPbool "\fR,\fB fill_fs" \fR=\fPbool |
3ce9dcaf JA |
298 | Sets size to something really large and waits for ENOSPC (no space left on |
299 | device) as the terminating condition. Only makes sense with sequential write. | |
300 | For a read workload, the mount point will be filled first then IO started on | |
4f12432e JA |
301 | the result. This option doesn't make sense if operating on a raw device node, |
302 | since the size of that is already known by the file system. Additionally, | |
303 | writing beyond end-of-device will not return ENOSPC there. | |
3ce9dcaf | 304 | .TP |
d60e92d1 AC |
305 | .BI filesize \fR=\fPirange |
306 | Individual file sizes. May be a range, in which case \fBfio\fR will select sizes | |
d1429b5c AC |
307 | for files at random within the given range, limited to \fBsize\fR in total (if |
308 | that is given). If \fBfilesize\fR is not specified, each created file is the | |
309 | same size. | |
d60e92d1 | 310 | .TP |
f7fa2653 | 311 | .BI blocksize \fR=\fPint[,int] "\fR,\fB bs" \fR=\fPint[,int] |
d60e92d1 | 312 | Block size for I/O units. Default: 4k. Values for reads and writes can be |
656ebab7 | 313 | specified separately in the format \fIread\fR,\fIwrite\fR, either of |
d60e92d1 AC |
314 | which may be empty to leave that value at its default. |
315 | .TP | |
9183788d | 316 | .BI blocksize_range \fR=\fPirange[,irange] "\fR,\fB bsrange" \fR=\fPirange[,irange] |
d1429b5c AC |
317 | Specify a range of I/O block sizes. The issued I/O unit will always be a |
318 | multiple of the minimum size, unless \fBblocksize_unaligned\fR is set. Applies | |
9183788d | 319 | to both reads and writes if only one range is given, but can be specified |
656ebab7 | 320 | separately with a comma seperating the values. Example: bsrange=1k-4k,2k-8k. |
9183788d JA |
321 | Also (see \fBblocksize\fR). |
322 | .TP | |
323 | .BI bssplit \fR=\fPstr | |
324 | This option allows even finer grained control of the block sizes issued, | |
325 | not just even splits between them. With this option, you can weight various | |
326 | block sizes for exact control of the issued IO for a job that has mixed | |
327 | block sizes. The format of the option is bssplit=blocksize/percentage, | |
5982a925 | 328 | optionally adding as many definitions as needed separated by a colon. |
9183788d | 329 | Example: bssplit=4k/10:64k/50:32k/40 would issue 50% 64k blocks, 10% 4k |
c83cdd3e JA |
330 | blocks and 40% 32k blocks. \fBbssplit\fR also supports giving separate |
331 | splits to reads and writes. The format is identical to what the | |
332 | \fBbs\fR option accepts, the read and write parts are separated with a | |
333 | comma. | |
d60e92d1 AC |
334 | .TP |
335 | .B blocksize_unaligned\fR,\fP bs_unaligned | |
d1429b5c AC |
336 | If set, any size in \fBblocksize_range\fR may be used. This typically won't |
337 | work with direct I/O, as that normally requires sector alignment. | |
d60e92d1 | 338 | .TP |
2b7a01d0 | 339 | .BI blockalign \fR=\fPint[,int] "\fR,\fB ba" \fR=\fPint[,int] |
639ce0f3 MS |
340 | At what boundary to align random IO offsets. Defaults to the same as 'blocksize' |
341 | the minimum blocksize given. Minimum alignment is typically 512b | |
2b7a01d0 JA |
342 | for using direct IO, though it usually depends on the hardware block size. |
343 | This option is mutually exclusive with using a random map for files, so it | |
344 | will turn off that option. | |
43602667 | 345 | .TP |
d60e92d1 AC |
346 | .B zero_buffers |
347 | Initialise buffers with all zeros. Default: fill buffers with random data. | |
348 | .TP | |
901bb994 JA |
349 | .B refill_buffers |
350 | If this option is given, fio will refill the IO buffers on every submit. The | |
351 | default is to only fill it at init time and reuse that data. Only makes sense | |
352 | if zero_buffers isn't specified, naturally. If data verification is enabled, | |
353 | refill_buffers is also automatically enabled. | |
354 | .TP | |
fd68418e JA |
355 | .BI scramble_buffers \fR=\fPbool |
356 | If \fBrefill_buffers\fR is too costly and the target is using data | |
357 | deduplication, then setting this option will slightly modify the IO buffer | |
358 | contents to defeat normal de-dupe attempts. This is not enough to defeat | |
359 | more clever block compression attempts, but it will stop naive dedupe | |
360 | of blocks. Default: true. | |
361 | .TP | |
d60e92d1 AC |
362 | .BI nrfiles \fR=\fPint |
363 | Number of files to use for this job. Default: 1. | |
364 | .TP | |
365 | .BI openfiles \fR=\fPint | |
366 | Number of files to keep open at the same time. Default: \fBnrfiles\fR. | |
367 | .TP | |
368 | .BI file_service_type \fR=\fPstr | |
369 | Defines how files to service are selected. The following types are defined: | |
370 | .RS | |
371 | .RS | |
372 | .TP | |
373 | .B random | |
374 | Choose a file at random | |
375 | .TP | |
376 | .B roundrobin | |
377 | Round robin over open files (default). | |
6b7f6851 JA |
378 | .B sequential |
379 | Do each file in the set sequentially. | |
d60e92d1 AC |
380 | .RE |
381 | .P | |
382 | The number of I/Os to issue before switching a new file can be specified by | |
383 | appending `:\fIint\fR' to the service type. | |
384 | .RE | |
385 | .TP | |
386 | .BI ioengine \fR=\fPstr | |
387 | Defines how the job issues I/O. The following types are defined: | |
388 | .RS | |
389 | .RS | |
390 | .TP | |
391 | .B sync | |
392 | Basic \fIread\fR\|(2) or \fIwrite\fR\|(2) I/O. \fIfseek\fR\|(2) is used to | |
393 | position the I/O location. | |
394 | .TP | |
a31041ea | 395 | .B psync |
396 | Basic \fIpread\fR\|(2) or \fIpwrite\fR\|(2) I/O. | |
397 | .TP | |
9183788d JA |
398 | .B vsync |
399 | Basic \fIreadv\fR\|(2) or \fIwritev\fR\|(2) I/O. Will emulate queuing by | |
400 | coalescing adjacents IOs into a single submission. | |
401 | .TP | |
d60e92d1 | 402 | .B libaio |
de890a1e | 403 | Linux native asynchronous I/O. This ioengine defines engine specific options. |
d60e92d1 AC |
404 | .TP |
405 | .B posixaio | |
03e20d68 BC |
406 | POSIX asynchronous I/O using \fIaio_read\fR\|(3) and \fIaio_write\fR\|(3). |
407 | .TP | |
408 | .B solarisaio | |
409 | Solaris native asynchronous I/O. | |
410 | .TP | |
411 | .B windowsaio | |
412 | Windows native asynchronous I/O. | |
d60e92d1 AC |
413 | .TP |
414 | .B mmap | |
d1429b5c AC |
415 | File is memory mapped with \fImmap\fR\|(2) and data copied using |
416 | \fImemcpy\fR\|(3). | |
d60e92d1 AC |
417 | .TP |
418 | .B splice | |
d1429b5c AC |
419 | \fIsplice\fR\|(2) is used to transfer the data and \fIvmsplice\fR\|(2) to |
420 | transfer data from user-space to the kernel. | |
d60e92d1 AC |
421 | .TP |
422 | .B syslet-rw | |
423 | Use the syslet system calls to make regular read/write asynchronous. | |
424 | .TP | |
425 | .B sg | |
426 | SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if | |
d1429b5c AC |
427 | the target is an sg character device, we use \fIread\fR\|(2) and |
428 | \fIwrite\fR\|(2) for asynchronous I/O. | |
d60e92d1 AC |
429 | .TP |
430 | .B null | |
431 | Doesn't transfer any data, just pretends to. Mainly used to exercise \fBfio\fR | |
432 | itself and for debugging and testing purposes. | |
433 | .TP | |
434 | .B net | |
de890a1e SL |
435 | Transfer over the network. The protocol to be used can be defined with the |
436 | \fBprotocol\fR parameter. Depending on the protocol, \fBfilename\fR, | |
437 | \fBhostname\fR, \fBport\fR, or \fBlisten\fR must be specified. | |
438 | This ioengine defines engine specific options. | |
d60e92d1 AC |
439 | .TP |
440 | .B netsplice | |
441 | Like \fBnet\fR, but uses \fIsplice\fR\|(2) and \fIvmsplice\fR\|(2) to map data | |
de890a1e | 442 | and send/receive. This ioengine defines engine specific options. |
d60e92d1 | 443 | .TP |
53aec0a4 | 444 | .B cpuio |
d60e92d1 AC |
445 | Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and |
446 | \fBcpucycles\fR parameters. | |
447 | .TP | |
448 | .B guasi | |
449 | The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface | |
450 | approach to asycnronous I/O. | |
d1429b5c AC |
451 | .br |
452 | See <http://www.xmailserver.org/guasi\-lib.html>. | |
d60e92d1 | 453 | .TP |
21b8aee8 | 454 | .B rdma |
85286c5c BVA |
455 | The RDMA I/O engine supports both RDMA memory semantics (RDMA_WRITE/RDMA_READ) |
456 | and channel semantics (Send/Recv) for the InfiniBand, RoCE and iWARP protocols. | |
21b8aee8 | 457 | .TP |
d60e92d1 AC |
458 | .B external |
459 | Loads an external I/O engine object file. Append the engine filename as | |
460 | `:\fIenginepath\fR'. | |
461 | .RE | |
462 | .RE | |
463 | .TP | |
464 | .BI iodepth \fR=\fPint | |
8489dae4 SK |
465 | Number of I/O units to keep in flight against the file. Note that increasing |
466 | iodepth beyond 1 will not affect synchronous ioengines (except for small | |
ee72ca09 JA |
467 | degress when verify_async is in use). Even async engines my impose OS |
468 | restrictions causing the desired depth not to be achieved. This may happen on | |
469 | Linux when using libaio and not setting \fBdirect\fR=1, since buffered IO is | |
470 | not async on that OS. Keep an eye on the IO depth distribution in the | |
471 | fio output to verify that the achieved depth is as expected. Default: 1. | |
d60e92d1 AC |
472 | .TP |
473 | .BI iodepth_batch \fR=\fPint | |
474 | Number of I/Os to submit at once. Default: \fBiodepth\fR. | |
475 | .TP | |
3ce9dcaf JA |
476 | .BI iodepth_batch_complete \fR=\fPint |
477 | This defines how many pieces of IO to retrieve at once. It defaults to 1 which | |
478 | means that we'll ask for a minimum of 1 IO in the retrieval process from the | |
479 | kernel. The IO retrieval will go on until we hit the limit set by | |
480 | \fBiodepth_low\fR. If this variable is set to 0, then fio will always check for | |
481 | completed events before queuing more IO. This helps reduce IO latency, at the | |
482 | cost of more retrieval system calls. | |
483 | .TP | |
d60e92d1 AC |
484 | .BI iodepth_low \fR=\fPint |
485 | Low watermark indicating when to start filling the queue again. Default: | |
486 | \fBiodepth\fR. | |
487 | .TP | |
488 | .BI direct \fR=\fPbool | |
489 | If true, use non-buffered I/O (usually O_DIRECT). Default: false. | |
490 | .TP | |
491 | .BI buffered \fR=\fPbool | |
492 | If true, use buffered I/O. This is the opposite of the \fBdirect\fR parameter. | |
493 | Default: true. | |
494 | .TP | |
f7fa2653 | 495 | .BI offset \fR=\fPint |
d60e92d1 AC |
496 | Offset in the file to start I/O. Data before the offset will not be touched. |
497 | .TP | |
498 | .BI fsync \fR=\fPint | |
d1429b5c AC |
499 | How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data. If |
500 | 0, don't sync. Default: 0. | |
d60e92d1 | 501 | .TP |
5f9099ea JA |
502 | .BI fdatasync \fR=\fPint |
503 | Like \fBfsync\fR, but uses \fBfdatasync\fR\|(2) instead to only sync the | |
504 | data parts of the file. Default: 0. | |
505 | .TP | |
e76b1da4 JA |
506 | .BI sync_file_range \fR=\fPstr:int |
507 | Use sync_file_range() for every \fRval\fP number of write operations. Fio will | |
508 | track range of writes that have happened since the last sync_file_range() call. | |
509 | \fRstr\fP can currently be one or more of: | |
510 | .RS | |
511 | .TP | |
512 | .B wait_before | |
513 | SYNC_FILE_RANGE_WAIT_BEFORE | |
514 | .TP | |
515 | .B write | |
516 | SYNC_FILE_RANGE_WRITE | |
517 | .TP | |
518 | .B wait_after | |
519 | SYNC_FILE_RANGE_WRITE | |
520 | .TP | |
521 | .RE | |
522 | .P | |
523 | So if you do sync_file_range=wait_before,write:8, fio would use | |
524 | \fBSYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE\fP for every 8 writes. | |
525 | Also see the sync_file_range(2) man page. This option is Linux specific. | |
526 | .TP | |
d60e92d1 | 527 | .BI overwrite \fR=\fPbool |
d1429b5c | 528 | If writing, setup the file first and do overwrites. Default: false. |
d60e92d1 AC |
529 | .TP |
530 | .BI end_fsync \fR=\fPbool | |
d1429b5c | 531 | Sync file contents when job exits. Default: false. |
d60e92d1 AC |
532 | .TP |
533 | .BI fsync_on_close \fR=\fPbool | |
534 | If true, sync file contents on close. This differs from \fBend_fsync\fR in that | |
d1429b5c | 535 | it will happen on every close, not just at the end of the job. Default: false. |
d60e92d1 AC |
536 | .TP |
537 | .BI rwmixcycle \fR=\fPint | |
538 | How many milliseconds before switching between reads and writes for a mixed | |
539 | workload. Default: 500ms. | |
540 | .TP | |
541 | .BI rwmixread \fR=\fPint | |
542 | Percentage of a mixed workload that should be reads. Default: 50. | |
543 | .TP | |
544 | .BI rwmixwrite \fR=\fPint | |
d1429b5c | 545 | Percentage of a mixed workload that should be writes. If \fBrwmixread\fR and |
c35dd7a6 JA |
546 | \fBrwmixwrite\fR are given and do not sum to 100%, the latter of the two |
547 | overrides the first. This may interfere with a given rate setting, if fio is | |
548 | asked to limit reads or writes to a certain rate. If that is the case, then | |
549 | the distribution may be skewed. Default: 50. | |
d60e92d1 AC |
550 | .TP |
551 | .B norandommap | |
552 | Normally \fBfio\fR will cover every block of the file when doing random I/O. If | |
553 | this parameter is given, a new offset will be chosen without looking at past | |
554 | I/O history. This parameter is mutually exclusive with \fBverify\fR. | |
555 | .TP | |
744492c9 | 556 | .BI softrandommap \fR=\fPbool |
3ce9dcaf JA |
557 | See \fBnorandommap\fR. If fio runs with the random block map enabled and it |
558 | fails to allocate the map, if this option is set it will continue without a | |
559 | random block map. As coverage will not be as complete as with random maps, this | |
560 | option is disabled by default. | |
561 | .TP | |
d60e92d1 AC |
562 | .BI nice \fR=\fPint |
563 | Run job with given nice value. See \fInice\fR\|(2). | |
564 | .TP | |
565 | .BI prio \fR=\fPint | |
566 | Set I/O priority value of this job between 0 (highest) and 7 (lowest). See | |
567 | \fIionice\fR\|(1). | |
568 | .TP | |
569 | .BI prioclass \fR=\fPint | |
570 | Set I/O priority class. See \fIionice\fR\|(1). | |
571 | .TP | |
572 | .BI thinktime \fR=\fPint | |
573 | Stall job for given number of microseconds between issuing I/Os. | |
574 | .TP | |
575 | .BI thinktime_spin \fR=\fPint | |
576 | Pretend to spend CPU time for given number of microseconds, sleeping the rest | |
577 | of the time specified by \fBthinktime\fR. Only valid if \fBthinktime\fR is set. | |
578 | .TP | |
579 | .BI thinktime_blocks \fR=\fPint | |
580 | Number of blocks to issue before waiting \fBthinktime\fR microseconds. | |
581 | Default: 1. | |
582 | .TP | |
583 | .BI rate \fR=\fPint | |
c35dd7a6 JA |
584 | Cap bandwidth used by this job. The number is in bytes/sec, the normal postfix |
585 | rules apply. You can use \fBrate\fR=500k to limit reads and writes to 500k each, | |
586 | or you can specify read and writes separately. Using \fBrate\fR=1m,500k would | |
587 | limit reads to 1MB/sec and writes to 500KB/sec. Capping only reads or writes | |
588 | can be done with \fBrate\fR=,500k or \fBrate\fR=500k,. The former will only | |
589 | limit writes (to 500KB/sec), the latter will only limit reads. | |
d60e92d1 AC |
590 | .TP |
591 | .BI ratemin \fR=\fPint | |
592 | Tell \fBfio\fR to do whatever it can to maintain at least the given bandwidth. | |
c35dd7a6 JA |
593 | Failing to meet this requirement will cause the job to exit. The same format |
594 | as \fBrate\fR is used for read vs write separation. | |
d60e92d1 AC |
595 | .TP |
596 | .BI rate_iops \fR=\fPint | |
c35dd7a6 JA |
597 | Cap the bandwidth to this number of IOPS. Basically the same as rate, just |
598 | specified independently of bandwidth. The same format as \fBrate\fR is used for | |
599 | read vs write seperation. If \fBblocksize\fR is a range, the smallest block | |
600 | size is used as the metric. | |
d60e92d1 AC |
601 | .TP |
602 | .BI rate_iops_min \fR=\fPint | |
c35dd7a6 JA |
603 | If this rate of I/O is not met, the job will exit. The same format as \fBrate\fR |
604 | is used for read vs write seperation. | |
d60e92d1 AC |
605 | .TP |
606 | .BI ratecycle \fR=\fPint | |
607 | Average bandwidth for \fBrate\fR and \fBratemin\fR over this number of | |
608 | milliseconds. Default: 1000ms. | |
609 | .TP | |
610 | .BI cpumask \fR=\fPint | |
611 | Set CPU affinity for this job. \fIint\fR is a bitmask of allowed CPUs the job | |
612 | may run on. See \fBsched_setaffinity\fR\|(2). | |
613 | .TP | |
614 | .BI cpus_allowed \fR=\fPstr | |
615 | Same as \fBcpumask\fR, but allows a comma-delimited list of CPU numbers. | |
616 | .TP | |
617 | .BI startdelay \fR=\fPint | |
618 | Delay start of job for the specified number of seconds. | |
619 | .TP | |
620 | .BI runtime \fR=\fPint | |
621 | Terminate processing after the specified number of seconds. | |
622 | .TP | |
623 | .B time_based | |
624 | If given, run for the specified \fBruntime\fR duration even if the files are | |
625 | completely read or written. The same workload will be repeated as many times | |
626 | as \fBruntime\fR allows. | |
627 | .TP | |
901bb994 JA |
628 | .BI ramp_time \fR=\fPint |
629 | If set, fio will run the specified workload for this amount of time before | |
630 | logging any performance numbers. Useful for letting performance settle before | |
631 | logging results, thus minimizing the runtime required for stable results. Note | |
c35dd7a6 JA |
632 | that the \fBramp_time\fR is considered lead in time for a job, thus it will |
633 | increase the total runtime if a special timeout or runtime is specified. | |
901bb994 | 634 | .TP |
d60e92d1 AC |
635 | .BI invalidate \fR=\fPbool |
636 | Invalidate buffer-cache for the file prior to starting I/O. Default: true. | |
637 | .TP | |
638 | .BI sync \fR=\fPbool | |
639 | Use synchronous I/O for buffered writes. For the majority of I/O engines, | |
d1429b5c | 640 | this means using O_SYNC. Default: false. |
d60e92d1 AC |
641 | .TP |
642 | .BI iomem \fR=\fPstr "\fR,\fP mem" \fR=\fPstr | |
643 | Allocation method for I/O unit buffer. Allowed values are: | |
644 | .RS | |
645 | .RS | |
646 | .TP | |
647 | .B malloc | |
648 | Allocate memory with \fImalloc\fR\|(3). | |
649 | .TP | |
650 | .B shm | |
651 | Use shared memory buffers allocated through \fIshmget\fR\|(2). | |
652 | .TP | |
653 | .B shmhuge | |
654 | Same as \fBshm\fR, but use huge pages as backing. | |
655 | .TP | |
656 | .B mmap | |
657 | Use \fImmap\fR\|(2) for allocation. Uses anonymous memory unless a filename | |
658 | is given after the option in the format `:\fIfile\fR'. | |
659 | .TP | |
660 | .B mmaphuge | |
661 | Same as \fBmmap\fR, but use huge files as backing. | |
662 | .RE | |
663 | .P | |
664 | The amount of memory allocated is the maximum allowed \fBblocksize\fR for the | |
665 | job multiplied by \fBiodepth\fR. For \fBshmhuge\fR or \fBmmaphuge\fR to work, | |
666 | the system must have free huge pages allocated. \fBmmaphuge\fR also needs to | |
2e266ba6 JA |
667 | have hugetlbfs mounted, and \fIfile\fR must point there. At least on Linux, |
668 | huge pages must be manually allocated. See \fB/proc/sys/vm/nr_hugehages\fR | |
669 | and the documentation for that. Normally you just need to echo an appropriate | |
670 | number, eg echoing 8 will ensure that the OS has 8 huge pages ready for | |
671 | use. | |
d60e92d1 AC |
672 | .RE |
673 | .TP | |
d392365e | 674 | .BI iomem_align \fR=\fPint "\fR,\fP mem_align" \fR=\fPint |
d529ee19 JA |
675 | This indiciates the memory alignment of the IO memory buffers. Note that the |
676 | given alignment is applied to the first IO unit buffer, if using \fBiodepth\fR | |
677 | the alignment of the following buffers are given by the \fBbs\fR used. In | |
678 | other words, if using a \fBbs\fR that is a multiple of the page sized in the | |
679 | system, all buffers will be aligned to this value. If using a \fBbs\fR that | |
680 | is not page aligned, the alignment of subsequent IO memory buffers is the | |
681 | sum of the \fBiomem_align\fR and \fBbs\fR used. | |
682 | .TP | |
f7fa2653 | 683 | .BI hugepage\-size \fR=\fPint |
d60e92d1 | 684 | Defines the size of a huge page. Must be at least equal to the system setting. |
b22989b9 | 685 | Should be a multiple of 1MB. Default: 4MB. |
d60e92d1 AC |
686 | .TP |
687 | .B exitall | |
688 | Terminate all jobs when one finishes. Default: wait for each job to finish. | |
689 | .TP | |
690 | .BI bwavgtime \fR=\fPint | |
691 | Average bandwidth calculations over the given time in milliseconds. Default: | |
692 | 500ms. | |
693 | .TP | |
c8eeb9df JA |
694 | .BI iopsavgtime \fR=\fPint |
695 | Average IOPS calculations over the given time in milliseconds. Default: | |
696 | 500ms. | |
697 | .TP | |
d60e92d1 | 698 | .BI create_serialize \fR=\fPbool |
d1429b5c | 699 | If true, serialize file creation for the jobs. Default: true. |
d60e92d1 AC |
700 | .TP |
701 | .BI create_fsync \fR=\fPbool | |
702 | \fIfsync\fR\|(2) data file after creation. Default: true. | |
703 | .TP | |
6b7f6851 JA |
704 | .BI create_on_open \fR=\fPbool |
705 | If true, the files are not created until they are opened for IO by the job. | |
706 | .TP | |
e9f48479 JA |
707 | .BI pre_read \fR=\fPbool |
708 | If this is given, files will be pre-read into memory before starting the given | |
709 | IO operation. This will also clear the \fR \fBinvalidate\fR flag, since it is | |
9c0d2241 JA |
710 | pointless to pre-read and then drop the cache. This will only work for IO |
711 | engines that are seekable, since they allow you to read the same data | |
712 | multiple times. Thus it will not work on eg network or splice IO. | |
e9f48479 | 713 | .TP |
d60e92d1 AC |
714 | .BI unlink \fR=\fPbool |
715 | Unlink job files when done. Default: false. | |
716 | .TP | |
717 | .BI loops \fR=\fPint | |
718 | Specifies the number of iterations (runs of the same workload) of this job. | |
719 | Default: 1. | |
720 | .TP | |
721 | .BI do_verify \fR=\fPbool | |
722 | Run the verify phase after a write phase. Only valid if \fBverify\fR is set. | |
723 | Default: true. | |
724 | .TP | |
725 | .BI verify \fR=\fPstr | |
726 | Method of verifying file contents after each iteration of the job. Allowed | |
727 | values are: | |
728 | .RS | |
729 | .RS | |
730 | .TP | |
b892dc08 | 731 | .B md5 crc16 crc32 crc32c crc32c-intel crc64 crc7 sha256 sha512 sha1 |
0539d758 JA |
732 | Store appropriate checksum in the header of each block. crc32c-intel is |
733 | hardware accelerated SSE4.2 driven, falls back to regular crc32c if | |
734 | not supported by the system. | |
d60e92d1 AC |
735 | .TP |
736 | .B meta | |
737 | Write extra information about each I/O (timestamp, block number, etc.). The | |
996093bb | 738 | block number is verified. See \fBverify_pattern\fR as well. |
d60e92d1 AC |
739 | .TP |
740 | .B null | |
741 | Pretend to verify. Used for testing internals. | |
742 | .RE | |
b892dc08 JA |
743 | |
744 | This option can be used for repeated burn-in tests of a system to make sure | |
745 | that the written data is also correctly read back. If the data direction given | |
746 | is a read or random read, fio will assume that it should verify a previously | |
747 | written file. If the data direction includes any form of write, the verify will | |
748 | be of the newly written data. | |
d60e92d1 AC |
749 | .RE |
750 | .TP | |
751 | .BI verify_sort \fR=\fPbool | |
752 | If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to | |
753 | read them back in a sorted manner. Default: true. | |
754 | .TP | |
f7fa2653 | 755 | .BI verify_offset \fR=\fPint |
d60e92d1 | 756 | Swap the verification header with data somewhere else in the block before |
d1429b5c | 757 | writing. It is swapped back before verifying. |
d60e92d1 | 758 | .TP |
f7fa2653 | 759 | .BI verify_interval \fR=\fPint |
d60e92d1 AC |
760 | Write the verification header for this number of bytes, which should divide |
761 | \fBblocksize\fR. Default: \fBblocksize\fR. | |
762 | .TP | |
996093bb JA |
763 | .BI verify_pattern \fR=\fPstr |
764 | If set, fio will fill the io buffers with this pattern. Fio defaults to filling | |
765 | with totally random bytes, but sometimes it's interesting to fill with a known | |
766 | pattern for io verification purposes. Depending on the width of the pattern, | |
767 | fio will fill 1/2/3/4 bytes of the buffer at the time(it can be either a | |
768 | decimal or a hex number). The verify_pattern if larger than a 32-bit quantity | |
769 | has to be a hex number that starts with either "0x" or "0X". Use with | |
770 | \fBverify\fP=meta. | |
771 | .TP | |
d60e92d1 AC |
772 | .BI verify_fatal \fR=\fPbool |
773 | If true, exit the job on the first observed verification failure. Default: | |
774 | false. | |
775 | .TP | |
b463e936 JA |
776 | .BI verify_dump \fR=\fPbool |
777 | If set, dump the contents of both the original data block and the data block we | |
778 | read off disk to files. This allows later analysis to inspect just what kind of | |
ef71e317 | 779 | data corruption occurred. Off by default. |
b463e936 | 780 | .TP |
e8462bd8 JA |
781 | .BI verify_async \fR=\fPint |
782 | Fio will normally verify IO inline from the submitting thread. This option | |
783 | takes an integer describing how many async offload threads to create for IO | |
784 | verification instead, causing fio to offload the duty of verifying IO contents | |
c85c324c JA |
785 | to one or more separate threads. If using this offload option, even sync IO |
786 | engines can benefit from using an \fBiodepth\fR setting higher than 1, as it | |
787 | allows them to have IO in flight while verifies are running. | |
e8462bd8 JA |
788 | .TP |
789 | .BI verify_async_cpus \fR=\fPstr | |
790 | Tell fio to set the given CPU affinity on the async IO verification threads. | |
791 | See \fBcpus_allowed\fP for the format used. | |
792 | .TP | |
6f87418f JA |
793 | .BI verify_backlog \fR=\fPint |
794 | Fio will normally verify the written contents of a job that utilizes verify | |
795 | once that job has completed. In other words, everything is written then | |
796 | everything is read back and verified. You may want to verify continually | |
797 | instead for a variety of reasons. Fio stores the meta data associated with an | |
798 | IO block in memory, so for large verify workloads, quite a bit of memory would | |
092f707f DN |
799 | be used up holding this meta data. If this option is enabled, fio will write |
800 | only N blocks before verifying these blocks. | |
6f87418f JA |
801 | .TP |
802 | .BI verify_backlog_batch \fR=\fPint | |
803 | Control how many blocks fio will verify if verify_backlog is set. If not set, | |
804 | will default to the value of \fBverify_backlog\fR (meaning the entire queue is | |
092f707f DN |
805 | read back and verified). If \fBverify_backlog_batch\fR is less than |
806 | \fBverify_backlog\fR then not all blocks will be verified, if | |
807 | \fBverify_backlog_batch\fR is larger than \fBverify_backlog\fR, some blocks | |
808 | will be verified more than once. | |
6f87418f | 809 | .TP |
d392365e | 810 | .B stonewall "\fR,\fP wait_for_previous" |
5982a925 | 811 | Wait for preceding jobs in the job file to exit before starting this one. |
d60e92d1 AC |
812 | \fBstonewall\fR implies \fBnew_group\fR. |
813 | .TP | |
814 | .B new_group | |
815 | Start a new reporting group. If not given, all jobs in a file will be part | |
816 | of the same reporting group, unless separated by a stonewall. | |
817 | .TP | |
818 | .BI numjobs \fR=\fPint | |
819 | Number of clones (processes/threads performing the same workload) of this job. | |
820 | Default: 1. | |
821 | .TP | |
822 | .B group_reporting | |
823 | If set, display per-group reports instead of per-job when \fBnumjobs\fR is | |
824 | specified. | |
825 | .TP | |
826 | .B thread | |
827 | Use threads created with \fBpthread_create\fR\|(3) instead of processes created | |
828 | with \fBfork\fR\|(2). | |
829 | .TP | |
f7fa2653 | 830 | .BI zonesize \fR=\fPint |
d60e92d1 AC |
831 | Divide file into zones of the specified size in bytes. See \fBzoneskip\fR. |
832 | .TP | |
f7fa2653 | 833 | .BI zoneskip \fR=\fPint |
d1429b5c | 834 | Skip the specified number of bytes when \fBzonesize\fR bytes of data have been |
d60e92d1 AC |
835 | read. |
836 | .TP | |
837 | .BI write_iolog \fR=\fPstr | |
5b42a488 SH |
838 | Write the issued I/O patterns to the specified file. Specify a separate file |
839 | for each job, otherwise the iologs will be interspersed and the file may be | |
840 | corrupt. | |
d60e92d1 AC |
841 | .TP |
842 | .BI read_iolog \fR=\fPstr | |
843 | Replay the I/O patterns contained in the specified file generated by | |
844 | \fBwrite_iolog\fR, or may be a \fBblktrace\fR binary file. | |
845 | .TP | |
64bbb865 DN |
846 | .BI replay_no_stall \fR=\fPint |
847 | While replaying I/O patterns using \fBread_iolog\fR the default behavior | |
848 | attempts to respect timing information between I/Os. Enabling | |
849 | \fBreplay_no_stall\fR causes I/Os to be replayed as fast as possible while | |
850 | still respecting ordering. | |
851 | .TP | |
d1c46c04 DN |
852 | .BI replay_redirect \fR=\fPstr |
853 | While replaying I/O patterns using \fBread_iolog\fR the default behavior | |
854 | is to replay the IOPS onto the major/minor device that each IOP was recorded | |
855 | from. Setting \fBreplay_redirect\fR causes all IOPS to be replayed onto the | |
856 | single specified device regardless of the device it was recorded from. | |
857 | .TP | |
836bad52 | 858 | .BI write_bw_log \fR=\fPstr |
901bb994 JA |
859 | If given, write a bandwidth log of the jobs in this job file. Can be used to |
860 | store data of the bandwidth of the jobs in their lifetime. The included | |
861 | fio_generate_plots script uses gnuplot to turn these text files into nice | |
862 | graphs. See \fBwrite_log_log\fR for behaviour of given filename. For this | |
863 | option, the postfix is _bw.log. | |
d60e92d1 | 864 | .TP |
836bad52 | 865 | .BI write_lat_log \fR=\fPstr |
901bb994 JA |
866 | Same as \fBwrite_bw_log\fR, but writes I/O completion latencies. If no |
867 | filename is given with this option, the default filename of "jobname_type.log" | |
868 | is used. Even if the filename is given, fio will still append the type of log. | |
869 | .TP | |
c8eeb9df JA |
870 | .BI write_iops_log \fR=\fPstr |
871 | Same as \fBwrite_bw_log\fR, but writes IOPS. If no filename is given with this | |
872 | option, the default filename of "jobname_type.log" is used. Even if the | |
873 | filename is given, fio will still append the type of log. | |
874 | .TP | |
836bad52 | 875 | .BI disable_lat \fR=\fPbool |
02af0988 | 876 | Disable measurements of total latency numbers. Useful only for cutting |
901bb994 JA |
877 | back the number of calls to gettimeofday, as that does impact performance at |
878 | really high IOPS rates. Note that to really get rid of a large amount of these | |
879 | calls, this option must be used with disable_slat and disable_bw as well. | |
880 | .TP | |
836bad52 | 881 | .BI disable_clat \fR=\fPbool |
c95f9daf | 882 | Disable measurements of completion latency numbers. See \fBdisable_lat\fR. |
02af0988 | 883 | .TP |
836bad52 | 884 | .BI disable_slat \fR=\fPbool |
02af0988 | 885 | Disable measurements of submission latency numbers. See \fBdisable_lat\fR. |
901bb994 | 886 | .TP |
836bad52 | 887 | .BI disable_bw_measurement \fR=\fPbool |
02af0988 | 888 | Disable measurements of throughput/bandwidth numbers. See \fBdisable_lat\fR. |
d60e92d1 | 889 | .TP |
f7fa2653 | 890 | .BI lockmem \fR=\fPint |
d60e92d1 AC |
891 | Pin the specified amount of memory with \fBmlock\fR\|(2). Can be used to |
892 | simulate a smaller amount of memory. | |
893 | .TP | |
894 | .BI exec_prerun \fR=\fPstr | |
895 | Before running the job, execute the specified command with \fBsystem\fR\|(3). | |
896 | .TP | |
897 | .BI exec_postrun \fR=\fPstr | |
898 | Same as \fBexec_prerun\fR, but the command is executed after the job completes. | |
899 | .TP | |
900 | .BI ioscheduler \fR=\fPstr | |
901 | Attempt to switch the device hosting the file to the specified I/O scheduler. | |
902 | .TP | |
903 | .BI cpuload \fR=\fPint | |
904 | If the job is a CPU cycle-eater, attempt to use the specified percentage of | |
905 | CPU cycles. | |
906 | .TP | |
907 | .BI cpuchunks \fR=\fPint | |
908 | If the job is a CPU cycle-eater, split the load into cycles of the | |
909 | given time in milliseconds. | |
910 | .TP | |
911 | .BI disk_util \fR=\fPbool | |
d1429b5c | 912 | Generate disk utilization statistics if the platform supports it. Default: true. |
901bb994 JA |
913 | .TP |
914 | .BI gtod_reduce \fR=\fPbool | |
915 | Enable all of the gettimeofday() reducing options (disable_clat, disable_slat, | |
916 | disable_bw) plus reduce precision of the timeout somewhat to really shrink the | |
917 | gettimeofday() call count. With this option enabled, we only do about 0.4% of | |
918 | the gtod() calls we would have done if all time keeping was enabled. | |
919 | .TP | |
920 | .BI gtod_cpu \fR=\fPint | |
921 | Sometimes it's cheaper to dedicate a single thread of execution to just getting | |
922 | the current time. Fio (and databases, for instance) are very intensive on | |
923 | gettimeofday() calls. With this option, you can set one CPU aside for doing | |
924 | nothing but logging current time to a shared memory location. Then the other | |
925 | threads/processes that run IO workloads need only copy that segment, instead of | |
926 | entering the kernel with a gettimeofday() call. The CPU set aside for doing | |
927 | these time calls will be excluded from other uses. Fio will manually clear it | |
928 | from the CPU mask of other jobs. | |
f2bba182 | 929 | .TP |
a696fa2a JA |
930 | .BI cgroup \fR=\fPstr |
931 | Add job to this control group. If it doesn't exist, it will be created. | |
6adb38a1 JA |
932 | The system must have a mounted cgroup blkio mount point for this to work. If |
933 | your system doesn't have it mounted, you can do so with: | |
934 | ||
5982a925 | 935 | # mount \-t cgroup \-o blkio none /cgroup |
a696fa2a JA |
936 | .TP |
937 | .BI cgroup_weight \fR=\fPint | |
938 | Set the weight of the cgroup to this value. See the documentation that comes | |
939 | with the kernel, allowed values are in the range of 100..1000. | |
e0b0d892 | 940 | .TP |
7de87099 VG |
941 | .BI cgroup_nodelete \fR=\fPbool |
942 | Normally fio will delete the cgroups it has created after the job completion. | |
943 | To override this behavior and to leave cgroups around after the job completion, | |
944 | set cgroup_nodelete=1. This can be useful if one wants to inspect various | |
945 | cgroup files after job completion. Default: false | |
946 | .TP | |
e0b0d892 JA |
947 | .BI uid \fR=\fPint |
948 | Instead of running as the invoking user, set the user ID to this value before | |
949 | the thread/process does any work. | |
950 | .TP | |
951 | .BI gid \fR=\fPint | |
952 | Set group ID, see \fBuid\fR. | |
83349190 YH |
953 | .TP |
954 | .BI clat_percentiles \fR=\fPbool | |
955 | Enable the reporting of percentiles of completion latencies. | |
956 | .TP | |
957 | .BI percentile_list \fR=\fPfloat_list | |
958 | Overwrite the default list of percentiles for completion | |
959 | latencies. Each number is a floating number in the range (0,100], and | |
960 | the maximum length of the list is 20. Use ':' to separate the | |
3eb07285 | 961 | numbers. For example, \-\-percentile_list=99.5:99.9 will cause fio to |
83349190 YH |
962 | report the values of completion latency below which 99.5% and 99.9% of |
963 | the observed latencies fell, respectively. | |
de890a1e SL |
964 | .SS "Ioengine Parameters List" |
965 | Some parameters are only valid when a specific ioengine is in use. These are | |
966 | used identically to normal parameters, with the caveat that when used on the | |
967 | command line, the must come after the ioengine that defines them is selected. | |
968 | .TP | |
969 | .BI (libaio)userspace_reap | |
970 | Normally, with the libaio engine in use, fio will use | |
971 | the io_getevents system call to reap newly returned events. | |
972 | With this flag turned on, the AIO ring will be read directly | |
973 | from user-space to reap events. The reaping mode is only | |
974 | enabled when polling for a minimum of 0 events (eg when | |
975 | iodepth_batch_complete=0). | |
976 | .TP | |
977 | .BI (net,netsplice)hostname \fR=\fPstr | |
978 | The host name or IP address to use for TCP or UDP based IO. | |
979 | If the job is a TCP listener or UDP reader, the hostname is not | |
980 | used and must be omitted. | |
981 | .TP | |
982 | .BI (net,netsplice)port \fR=\fPint | |
983 | The TCP or UDP port to bind to or connect to. | |
984 | .TP | |
985 | .BI (net,netsplice)protocol \fR=\fPstr "\fR,\fP proto" \fR=\fPstr | |
986 | The network protocol to use. Accepted values are: | |
987 | .RS | |
988 | .RS | |
989 | .TP | |
990 | .B tcp | |
991 | Transmission control protocol | |
992 | .TP | |
993 | .B udp | |
994 | Unreliable datagram protocol | |
995 | .TP | |
996 | .B unix | |
997 | UNIX domain socket | |
998 | .RE | |
999 | .P | |
1000 | When the protocol is TCP or UDP, the port must also be given, | |
1001 | as well as the hostname if the job is a TCP listener or UDP | |
1002 | reader. For unix sockets, the normal filename option should be | |
1003 | used and the port is invalid. | |
1004 | .RE | |
1005 | .TP | |
1006 | .BI (net,netsplice)listen | |
1007 | For TCP network connections, tell fio to listen for incoming | |
1008 | connections rather than initiating an outgoing connection. The | |
1009 | hostname must be omitted if this option is used. | |
d60e92d1 | 1010 | .SH OUTPUT |
d1429b5c AC |
1011 | While running, \fBfio\fR will display the status of the created jobs. For |
1012 | example: | |
d60e92d1 | 1013 | .RS |
d1429b5c | 1014 | .P |
d60e92d1 AC |
1015 | Threads: 1: [_r] [24.8% done] [ 13509/ 8334 kb/s] [eta 00h:01m:31s] |
1016 | .RE | |
1017 | .P | |
d1429b5c AC |
1018 | The characters in the first set of brackets denote the current status of each |
1019 | threads. The possible values are: | |
1020 | .P | |
1021 | .PD 0 | |
d60e92d1 AC |
1022 | .RS |
1023 | .TP | |
1024 | .B P | |
1025 | Setup but not started. | |
1026 | .TP | |
1027 | .B C | |
1028 | Thread created. | |
1029 | .TP | |
1030 | .B I | |
1031 | Initialized, waiting. | |
1032 | .TP | |
1033 | .B R | |
1034 | Running, doing sequential reads. | |
1035 | .TP | |
1036 | .B r | |
1037 | Running, doing random reads. | |
1038 | .TP | |
1039 | .B W | |
1040 | Running, doing sequential writes. | |
1041 | .TP | |
1042 | .B w | |
1043 | Running, doing random writes. | |
1044 | .TP | |
1045 | .B M | |
1046 | Running, doing mixed sequential reads/writes. | |
1047 | .TP | |
1048 | .B m | |
1049 | Running, doing mixed random reads/writes. | |
1050 | .TP | |
1051 | .B F | |
1052 | Running, currently waiting for \fBfsync\fR\|(2). | |
1053 | .TP | |
1054 | .B V | |
1055 | Running, verifying written data. | |
1056 | .TP | |
1057 | .B E | |
1058 | Exited, not reaped by main thread. | |
1059 | .TP | |
1060 | .B \- | |
1061 | Exited, thread reaped. | |
1062 | .RE | |
d1429b5c | 1063 | .PD |
d60e92d1 AC |
1064 | .P |
1065 | The second set of brackets shows the estimated completion percentage of | |
1066 | the current group. The third set shows the read and write I/O rate, | |
1067 | respectively. Finally, the estimated run time of the job is displayed. | |
1068 | .P | |
1069 | When \fBfio\fR completes (or is interrupted by Ctrl-C), it will show data | |
1070 | for each thread, each group of threads, and each disk, in that order. | |
1071 | .P | |
1072 | Per-thread statistics first show the threads client number, group-id, and | |
1073 | error code. The remaining figures are as follows: | |
1074 | .RS | |
d60e92d1 AC |
1075 | .TP |
1076 | .B io | |
1077 | Number of megabytes of I/O performed. | |
1078 | .TP | |
1079 | .B bw | |
1080 | Average data rate (bandwidth). | |
1081 | .TP | |
1082 | .B runt | |
1083 | Threads run time. | |
1084 | .TP | |
1085 | .B slat | |
1086 | Submission latency minimum, maximum, average and standard deviation. This is | |
1087 | the time it took to submit the I/O. | |
1088 | .TP | |
1089 | .B clat | |
1090 | Completion latency minimum, maximum, average and standard deviation. This | |
1091 | is the time between submission and completion. | |
1092 | .TP | |
1093 | .B bw | |
1094 | Bandwidth minimum, maximum, percentage of aggregate bandwidth received, average | |
1095 | and standard deviation. | |
1096 | .TP | |
1097 | .B cpu | |
1098 | CPU usage statistics. Includes user and system time, number of context switches | |
1099 | this thread went through and number of major and minor page faults. | |
1100 | .TP | |
1101 | .B IO depths | |
1102 | Distribution of I/O depths. Each depth includes everything less than (or equal) | |
1103 | to it, but greater than the previous depth. | |
1104 | .TP | |
1105 | .B IO issued | |
1106 | Number of read/write requests issued, and number of short read/write requests. | |
1107 | .TP | |
1108 | .B IO latencies | |
1109 | Distribution of I/O completion latencies. The numbers follow the same pattern | |
1110 | as \fBIO depths\fR. | |
1111 | .RE | |
d60e92d1 AC |
1112 | .P |
1113 | The group statistics show: | |
d1429b5c | 1114 | .PD 0 |
d60e92d1 AC |
1115 | .RS |
1116 | .TP | |
1117 | .B io | |
1118 | Number of megabytes I/O performed. | |
1119 | .TP | |
1120 | .B aggrb | |
1121 | Aggregate bandwidth of threads in the group. | |
1122 | .TP | |
1123 | .B minb | |
1124 | Minimum average bandwidth a thread saw. | |
1125 | .TP | |
1126 | .B maxb | |
1127 | Maximum average bandwidth a thread saw. | |
1128 | .TP | |
1129 | .B mint | |
d1429b5c | 1130 | Shortest runtime of threads in the group. |
d60e92d1 AC |
1131 | .TP |
1132 | .B maxt | |
1133 | Longest runtime of threads in the group. | |
1134 | .RE | |
d1429b5c | 1135 | .PD |
d60e92d1 AC |
1136 | .P |
1137 | Finally, disk statistics are printed with reads first: | |
d1429b5c | 1138 | .PD 0 |
d60e92d1 AC |
1139 | .RS |
1140 | .TP | |
1141 | .B ios | |
1142 | Number of I/Os performed by all groups. | |
1143 | .TP | |
1144 | .B merge | |
1145 | Number of merges in the I/O scheduler. | |
1146 | .TP | |
1147 | .B ticks | |
1148 | Number of ticks we kept the disk busy. | |
1149 | .TP | |
1150 | .B io_queue | |
1151 | Total time spent in the disk queue. | |
1152 | .TP | |
1153 | .B util | |
1154 | Disk utilization. | |
1155 | .RE | |
d1429b5c | 1156 | .PD |
d60e92d1 AC |
1157 | .SH TERSE OUTPUT |
1158 | If the \fB\-\-minimal\fR option is given, the results will be printed in a | |
562c2d2f DN |
1159 | semicolon-delimited format suitable for scripted use - a job description |
1160 | (if provided) follows on a new line. Note that the first | |
525c2bfa JA |
1161 | number in the line is the version number. If the output has to be changed |
1162 | for some reason, this number will be incremented by 1 to signify that | |
1163 | change. The fields are: | |
d60e92d1 AC |
1164 | .P |
1165 | .RS | |
5e726d0a | 1166 | .B terse version, fio version, jobname, groupid, error |
d60e92d1 AC |
1167 | .P |
1168 | Read status: | |
1169 | .RS | |
312b4af2 | 1170 | .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, IOPS, runtime \fR(ms)\fP |
d60e92d1 AC |
1171 | .P |
1172 | Submission latency: | |
1173 | .RS | |
1174 | .B min, max, mean, standard deviation | |
1175 | .RE | |
1176 | Completion latency: | |
1177 | .RS | |
1178 | .B min, max, mean, standard deviation | |
1179 | .RE | |
1db92cb6 JA |
1180 | Completion latency percentiles (20 fields): |
1181 | .RS | |
1182 | .B Xth percentile=usec | |
1183 | .RE | |
525c2bfa JA |
1184 | Total latency: |
1185 | .RS | |
1186 | .B min, max, mean, standard deviation | |
1187 | .RE | |
d60e92d1 AC |
1188 | Bandwidth: |
1189 | .RS | |
1190 | .B min, max, aggregate percentage of total, mean, standard deviation | |
1191 | .RE | |
1192 | .RE | |
1193 | .P | |
1194 | Write status: | |
1195 | .RS | |
312b4af2 | 1196 | .B Total I/O \fR(KB)\fP, bandwidth \fR(KB/s)\fP, IOPS, runtime \fR(ms)\fP |
d60e92d1 AC |
1197 | .P |
1198 | Submission latency: | |
1199 | .RS | |
1200 | .B min, max, mean, standard deviation | |
1201 | .RE | |
1202 | Completion latency: | |
1203 | .RS | |
1204 | .B min, max, mean, standard deviation | |
1205 | .RE | |
1db92cb6 JA |
1206 | Completion latency percentiles (20 fields): |
1207 | .RS | |
1208 | .B Xth percentile=usec | |
1209 | .RE | |
525c2bfa JA |
1210 | Total latency: |
1211 | .RS | |
1212 | .B min, max, mean, standard deviation | |
1213 | .RE | |
d60e92d1 AC |
1214 | Bandwidth: |
1215 | .RS | |
1216 | .B min, max, aggregate percentage of total, mean, standard deviation | |
1217 | .RE | |
1218 | .RE | |
1219 | .P | |
d1429b5c | 1220 | CPU usage: |
d60e92d1 | 1221 | .RS |
bd2626f0 | 1222 | .B user, system, context switches, major page faults, minor page faults |
d60e92d1 AC |
1223 | .RE |
1224 | .P | |
1225 | IO depth distribution: | |
1226 | .RS | |
1227 | .B <=1, 2, 4, 8, 16, 32, >=64 | |
1228 | .RE | |
1229 | .P | |
562c2d2f | 1230 | IO latency distribution: |
d60e92d1 | 1231 | .RS |
562c2d2f DN |
1232 | Microseconds: |
1233 | .RS | |
1234 | .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000 | |
1235 | .RE | |
1236 | Milliseconds: | |
1237 | .RS | |
1238 | .B <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000 | |
1239 | .RE | |
1240 | .RE | |
1241 | .P | |
f2f788dd JA |
1242 | Disk utilization (1 for each disk used): |
1243 | .RS | |
1244 | .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 | |
1245 | .RE | |
1246 | .P | |
5982a925 | 1247 | Error Info (dependent on continue_on_error, default off): |
562c2d2f DN |
1248 | .RS |
1249 | .B total # errors, first error code | |
d60e92d1 AC |
1250 | .RE |
1251 | .P | |
562c2d2f | 1252 | .B text description (if provided in config - appears on newline) |
d60e92d1 | 1253 | .RE |
49da1240 JA |
1254 | .SH CLIENT / SERVER |
1255 | Normally you would run fio as a stand-alone application on the machine | |
1256 | where the IO workload should be generated. However, it is also possible to | |
1257 | run the frontend and backend of fio separately. This makes it possible to | |
1258 | have a fio server running on the machine(s) where the IO workload should | |
1259 | be running, while controlling it from another machine. | |
1260 | ||
1261 | To start the server, you would do: | |
1262 | ||
1263 | \fBfio \-\-server=args\fR | |
1264 | ||
1265 | on that machine, where args defines what fio listens to. The arguments | |
811826be JA |
1266 | are of the form 'type:hostname or IP:port'. 'type' is either 'ip' (or ip4) |
1267 | for TCP/IP v4, 'ip6' for TCP/IP v6, or 'sock' for a local unix domain socket. | |
1268 | 'hostname' is either a hostname or IP address, and 'port' is the port to | |
1269 | listen to (only valid for TCP/IP, not a local socket). Some examples: | |
49da1240 JA |
1270 | |
1271 | 1) fio --server | |
1272 | ||
1273 | Start a fio server, listening on all interfaces on the default port (8765). | |
1274 | ||
811826be | 1275 | 2) fio --server=ip:hostname,4444 |
49da1240 JA |
1276 | |
1277 | Start a fio server, listening on IP belonging to hostname and on port 4444. | |
1278 | ||
811826be JA |
1279 | 3) fio --server=ip6:::1,4444 |
1280 | ||
1281 | Start a fio server, listening on IPv6 localhost ::1 and on port 4444. | |
1282 | ||
1283 | 4) fio --server=,4444 | |
49da1240 JA |
1284 | |
1285 | Start a fio server, listening on all interfaces on port 4444. | |
1286 | ||
811826be | 1287 | 5) fio --server=1.2.3.4 |
49da1240 JA |
1288 | |
1289 | Start a fio server, listening on IP 1.2.3.4 on the default port. | |
1290 | ||
811826be | 1291 | 6) fio --server=sock:/tmp/fio.sock |
49da1240 JA |
1292 | |
1293 | Start a fio server, listening on the local socket /tmp/fio.sock. | |
1294 | ||
1295 | When a server is running, you can connect to it from a client. The client | |
1296 | is run with: | |
1297 | ||
1298 | fio --local-args --client=server --remote-args <job file(s)> | |
1299 | ||
1300 | where --local-args are arguments that are local to the client where it is | |
1301 | running, 'server' is the connect string, and --remote-args and <job file(s)> | |
1302 | are sent to the server. The 'server' string follows the same format as it | |
1303 | does on the server side, to allow IP/hostname/socket and port strings. | |
1304 | You can connect to multiple clients as well, to do that you could run: | |
1305 | ||
1306 | fio --client=server2 --client=server2 <job file(s)> | |
d60e92d1 | 1307 | .SH AUTHORS |
49da1240 | 1308 | |
d60e92d1 | 1309 | .B fio |
aa58d252 JA |
1310 | was written by Jens Axboe <jens.axboe@oracle.com>, |
1311 | now Jens Axboe <jaxboe@fusionio.com>. | |
d1429b5c AC |
1312 | .br |
1313 | This man page was written by Aaron Carroll <aaronc@cse.unsw.edu.au> based | |
d60e92d1 AC |
1314 | on documentation by Jens Axboe. |
1315 | .SH "REPORTING BUGS" | |
482900c9 | 1316 | Report bugs to the \fBfio\fR mailing list <fio@vger.kernel.org>. |
d1429b5c | 1317 | See \fBREADME\fR. |
d60e92d1 | 1318 | .SH "SEE ALSO" |
d1429b5c AC |
1319 | For further documentation see \fBHOWTO\fR and \fBREADME\fR. |
1320 | .br | |
1321 | Sample jobfiles are available in the \fBexamples\fR directory. | |
d60e92d1 | 1322 |