Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 1 | fio |
| 2 | --- |
| 3 | |
Jens Axboe | 7980911 | 2006-06-09 10:14:54 +0200 | [diff] [blame] | 4 | fio is a tool that will spawn a number of threads or processes doing a |
| 5 | particular type of io action as specified by the user. fio takes a |
| 6 | number of global parameters, each inherited by the thread unless |
| 7 | otherwise parameters given to them overriding that setting is given. |
| 8 | The typical use of fio is to write a job file matching the io load |
| 9 | one wants to simulate. |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 10 | |
Jens Axboe | 2b02b54 | 2005-12-08 15:29:14 +0100 | [diff] [blame] | 11 | |
| 12 | Source |
| 13 | ------ |
| 14 | |
| 15 | fio resides in a git repo, the canonical place is: |
| 16 | |
| 17 | git://brick.kernel.dk/data/git/fio.git |
| 18 | |
Jens Axboe | 7980911 | 2006-06-09 10:14:54 +0200 | [diff] [blame] | 19 | Snapshots are frequently generated and they include the git meta data as |
| 20 | well. You can download them here: |
Jens Axboe | 2b02b54 | 2005-12-08 15:29:14 +0100 | [diff] [blame] | 21 | |
| 22 | http://brick.kernel.dk/snaps/ |
| 23 | |
Jens Axboe | 1053a10 | 2006-06-06 09:23:13 +0200 | [diff] [blame] | 24 | Pascal Bleser <guru@unixtech.be> has fio RPMs in his repository, you |
| 25 | can find them here: |
| 26 | |
| 27 | http://linux01.gwdg.de/~pbleser/rpm-navigation.php?cat=System/fio |
| 28 | |
Jens Axboe | 2b02b54 | 2005-12-08 15:29:14 +0100 | [diff] [blame] | 29 | |
Jens Axboe | bbfd6b0 | 2006-06-07 19:42:54 +0200 | [diff] [blame] | 30 | Building |
| 31 | -------- |
| 32 | |
| 33 | Just type 'make' and 'make install'. If on FreeBSD, for now you have to |
| 34 | specify the FreeBSD Makefile with -f, eg: |
| 35 | |
| 36 | $ make -f Makefile.Freebsd && make -f Makefile.FreeBSD install |
| 37 | |
Jens Axboe | edffcb9 | 2006-06-08 13:40:18 +0200 | [diff] [blame] | 38 | Likewise with OpenSolaris, use the Makefile.solaris to compile there. |
Jens Axboe | bbfd6b0 | 2006-06-07 19:42:54 +0200 | [diff] [blame] | 39 | This might change in the future if I opt for an autoconf type setup. |
| 40 | |
| 41 | |
Jens Axboe | 972cfd2 | 2006-06-09 11:08:56 +0200 | [diff] [blame] | 42 | Command line |
| 43 | ------------ |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 44 | |
| 45 | $ fio |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 46 | -t <sec> Runtime in seconds |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 47 | -l Generate per-job latency logs |
| 48 | -w Generate per-job bandwidth logs |
Jens Axboe | 9ebc27e | 2006-06-12 10:21:50 +0200 | [diff] [blame] | 49 | -o <file> Log output to file |
Jens Axboe | c6ae0a5 | 2006-06-12 11:04:44 +0200 | [diff] [blame] | 50 | -m Minimal (terse) output |
Jens Axboe | 4785f99 | 2006-05-26 03:59:10 +0200 | [diff] [blame] | 51 | -h Print help info |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 52 | -v Print version information and exit |
| 53 | |
Jens Axboe | 972cfd2 | 2006-06-09 11:08:56 +0200 | [diff] [blame] | 54 | Any parameters following the options will be assumed to be job files. |
| 55 | You can add as many as you want, each job file will be regarded as a |
| 56 | separate group and fio will stonewall it's execution. |
| 57 | |
Jens Axboe | 7980911 | 2006-06-09 10:14:54 +0200 | [diff] [blame] | 58 | |
| 59 | Job file |
| 60 | -------- |
| 61 | |
Jens Axboe | 71bfa16 | 2006-10-25 11:08:19 +0200 | [diff] [blame] | 62 | See the HOWTO file for a more detailed description of parameters and what |
| 63 | they mean. This file contains the terse version. Only a few options can |
| 64 | be controlled with command line parameters, generally it's a lot easier to |
| 65 | just write a simple job file to describe the workload. The job file format |
| 66 | is in the ini style format, as it's easy to read and write for the user. |
Jens Axboe | 7980911 | 2006-06-09 10:14:54 +0200 | [diff] [blame] | 67 | |
| 68 | The job file parameters are: |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 69 | |
Jens Axboe | 0145205 | 2006-06-07 10:29:47 +0200 | [diff] [blame] | 70 | name=x Use 'x' as the identifier for this job. |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 71 | directory=x Use 'x' as the top level directory for storing files |
Jens Axboe | b50b875 | 2006-10-24 19:05:53 +0200 | [diff] [blame] | 72 | filename=x Force the use of 'x' as the filename for all files |
| 73 | in this thread. If not given, fio will make up |
| 74 | a suitable filename based on the thread and file |
| 75 | number. |
Jens Axboe | 3d60d1e | 2006-05-25 06:31:06 +0200 | [diff] [blame] | 76 | rw=x 'x' may be: read, randread, write, randwrite, |
| 77 | rw (read-write mix), randrw (read-write random mix) |
Jens Axboe | a6ccc7b | 2006-06-02 10:14:15 +0200 | [diff] [blame] | 78 | rwmixcycle=x Base cycle for switching between read and write |
| 79 | in msecs. |
| 80 | rwmixread=x 'x' percentage of rw mix ios will be reads. If |
| 81 | rwmixwrite is also given, the last of the two will |
| 82 | be used if they don't add up to 100%. |
| 83 | rwmixwrite=x 'x' percentage of rw mix ios will be writes. See |
| 84 | rwmixread. |
Jens Axboe | 9ebc27e | 2006-06-12 10:21:50 +0200 | [diff] [blame] | 85 | rand_repeatable=x The sequence of random io blocks can be repeatable |
| 86 | across runs, if 'x' is 1. |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 87 | size=x Set file size to x bytes (x string can include k/m/g) |
| 88 | ioengine=x 'x' may be: aio/libaio/linuxaio for Linux aio, |
| 89 | posixaio for POSIX aio, sync for regular read/write io, |
Jens Axboe | 8756e4d | 2006-05-27 20:24:53 +0200 | [diff] [blame] | 90 | mmap for mmap'ed io, splice for using splice/vmsplice, |
| 91 | or sgio for direct SG_IO io. The latter only works on |
| 92 | Linux on SCSI (or SCSI-like devices, such as |
| 93 | usb-storage or sata/libata driven) devices. |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 94 | iodepth=x For async io, allow 'x' ios in flight |
| 95 | overwrite=x If 'x', layout a write file first. |
Jens Axboe | 53cdc68 | 2006-10-18 11:50:58 +0200 | [diff] [blame] | 96 | nrfiles=x Spread io load over 'x' number of files per job, |
| 97 | if possible. |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 98 | prio=x Run io at prio X, 0-7 is the kernel allowed range |
| 99 | prioclass=x Run io at prio class X |
| 100 | bs=x Use 'x' for thread blocksize. May include k/m postfix. |
| 101 | bsrange=x-y Mix thread block sizes randomly between x and y. May |
| 102 | also include k/m postfix. |
| 103 | direct=x 1 for direct IO, 0 for buffered IO |
| 104 | thinktime=x "Think" x usec after each io |
| 105 | rate=x Throttle rate to x KiB/sec |
| 106 | ratemin=x Quit if rate of x KiB/sec can't be met |
| 107 | ratecycle=x ratemin averaged over x msecs |
| 108 | cpumask=x Only allow job to run on CPUs defined by mask. |
Jens Axboe | 795407c | 2006-10-24 19:42:44 +0200 | [diff] [blame] | 109 | fsync=x If writing with buffered IO, fsync after every |
| 110 | 'x' blocks have been written. |
| 111 | end_fsync=x If 'x', run fsync() after end-of-job. |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 112 | startdelay=x Start this thread x seconds after startup |
Jens Axboe | 906c8d7 | 2006-06-13 09:37:56 +0200 | [diff] [blame] | 113 | timeout=x Terminate x seconds after startup. Can include a |
| 114 | normal time suffix if not given in seconds, such as |
| 115 | 'm' for minutes, 'h' for hours, and 'd' for days. |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 116 | offset=x Start io at offset x (x string can include k/m/g) |
| 117 | invalidate=x Invalidate page cache for file prior to doing io |
Jens Axboe | 795407c | 2006-10-24 19:42:44 +0200 | [diff] [blame] | 118 | sync=x Use sync writes if x and writing buffered IO. |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 119 | mem=x If x == malloc, use malloc for buffers. If x == shm, |
Jens Axboe | 795407c | 2006-10-24 19:42:44 +0200 | [diff] [blame] | 120 | use shared memory for buffers. If x == mmap, use |
| 121 | anonymous mmap. |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 122 | exitall When one thread quits, terminate the others |
| 123 | bwavgtime=x Average bandwidth stats over an x msec window. |
| 124 | create_serialize=x If 'x', serialize file creation. |
| 125 | create_fsync=x If 'x', run fsync() after file creation. |
Jens Axboe | f6cbb26 | 2006-10-18 14:16:42 +0200 | [diff] [blame] | 126 | unlink If set, unlink files when done. |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 127 | loops=x Run the job 'x' number of times. |
| 128 | verify=x If 'x' == md5, use md5 for verifies. If 'x' == crc32, |
| 129 | use crc32 for verifies. md5 is 'safer', but crc32 is |
| 130 | a lot faster. Only makes sense for writing to a file. |
| 131 | stonewall Wait for preceeding jobs to end before running. |
| 132 | numjobs=x Create 'x' similar entries for this job |
| 133 | thread Use pthreads instead of forked jobs |
Jens Axboe | 20dc95c | 2005-12-09 10:29:35 +0100 | [diff] [blame] | 134 | zonesize=x |
| 135 | zoneskip=y Zone options must be paired. If given, the job |
| 136 | will skip y bytes for every x read/written. This |
| 137 | can be used to gauge hard drive speed over the entire |
| 138 | platter, without reading everything. Both x/y can |
| 139 | include k/m/g suffix. |
Jens Axboe | aea47d4 | 2006-05-26 19:27:29 +0200 | [diff] [blame] | 140 | iolog=x Open and read io pattern from file 'x'. The file must |
| 141 | contain one io action per line in the following format: |
| 142 | rw, offset, length |
| 143 | where with rw=0/1 for read/write, and the offset |
| 144 | and length entries being in bytes. |
Jens Axboe | 843a741 | 2006-06-01 21:14:21 -0700 | [diff] [blame] | 145 | write_iolog=x Write an iolog to file 'x' in the same format as iolog. |
| 146 | The iolog options are exclusive, if both given the |
| 147 | read iolog will be performed. |
Jens Axboe | ec94ec5 | 2006-10-20 10:59:19 +0200 | [diff] [blame] | 148 | write_bw_log Write a bandwidth log. |
| 149 | write_lat_log Write a latency log. |
Jens Axboe | c04f7ec | 2006-05-31 10:13:16 +0200 | [diff] [blame] | 150 | lockmem=x Lock down x amount of memory on the machine, to |
| 151 | simulate a machine with less memory available. x can |
| 152 | include k/m/g suffix. |
Jens Axboe | b6f4d88 | 2006-06-02 10:32:51 +0200 | [diff] [blame] | 153 | nice=x Run job at given nice value. |
Jens Axboe | 4e0ba8a | 2006-06-06 09:36:28 +0200 | [diff] [blame] | 154 | exec_prerun=x Run 'x' before job io is begun. |
| 155 | exec_postrun=x Run 'x' after job io has finished. |
Jens Axboe | da86774 | 2006-06-06 10:39:10 -0700 | [diff] [blame] | 156 | ioscheduler=x Use ioscheduler 'x' for this job. |
Jens Axboe | b990b5c | 2006-09-14 09:48:22 +0200 | [diff] [blame] | 157 | cpuload=x For a CPU io thread, percentage of CPU time to attempt |
| 158 | to burn. |
| 159 | cpuchunks=x Split burn cycles into pieces of x. |
Jens Axboe | ebac465 | 2005-12-08 15:25:21 +0100 | [diff] [blame] | 160 | |
Jens Axboe | 7980911 | 2006-06-09 10:14:54 +0200 | [diff] [blame] | 161 | |
Jens Axboe | 7980911 | 2006-06-09 10:14:54 +0200 | [diff] [blame] | 162 | Author |
| 163 | ------ |
| 164 | |
Jens Axboe | aae22ca | 2006-09-05 10:46:22 +0200 | [diff] [blame] | 165 | Fio was written by Jens Axboe <axboe@kernel.dk> to enable flexible testing |
Jens Axboe | 7980911 | 2006-06-09 10:14:54 +0200 | [diff] [blame] | 166 | of the Linux IO subsystem and schedulers. He got tired of writing |
| 167 | specific test applications to simulate a given workload, and found that |
| 168 | the existing io benchmark/test tools out there weren't flexible enough |
| 169 | to do what he wanted. |
| 170 | |
Jens Axboe | aae22ca | 2006-09-05 10:46:22 +0200 | [diff] [blame] | 171 | Jens Axboe <axboe@kernel.dk> 20060905 |
Jens Axboe | 7980911 | 2006-06-09 10:14:54 +0200 | [diff] [blame] | 172 | |