X-Git-Url: https://git.kernel.dk/?p=fio.git;a=blobdiff_plain;f=HOWTO;h=ec7005fe5b44e1c70c2ff6e2195849599a24e0ca;hp=68e17e9f4743b6738fe10c1e329be9783f8af746;hb=0981fd718a4b03a807c1b4b2ae6d0e93deee28c5;hpb=b463e9363b826d5ba4f16e0115a26f24b77078f4 diff --git a/HOWTO b/HOWTO index 68e17e9f..ec7005fe 100644 --- a/HOWTO +++ b/HOWTO @@ -8,7 +8,7 @@ Table of contents 5. Detailed list of parameters 6. Normal output 7. Terse output - +8. Trace file format 1.0 Overview and history ------------------------ @@ -244,6 +244,7 @@ irange Integer range with suffix. Allows value range to be given, such 1k:4k. If the option allows two sets of ranges, they can be specified with a ',' or '/' delimiter: 1k-4k/8k-32k. Also see int. +float_list A list of floating numbers, separated by a ':' character. With the above in mind, here follows the complete list of fio job parameters. @@ -266,7 +267,7 @@ filename=str Fio normally makes up a filename based on the job name, files between threads in a job or several jobs, specify a filename for each of them to override the default. If the ioengine used is 'net', the filename is the host, port, - and protocol to use in the format of =host/port/protocol. + and protocol to use in the format of =host,port,protocol. See ioengine=net for more. If the ioengine is file based, you can specify a number of files by separating the names with a ':' colon. So if you wanted a job to open /dev/sda and /dev/sdb @@ -309,7 +310,7 @@ rw=str Type of io pattern. Accepted values are: write Sequential writes randwrite Random writes randread Random reads - rw Sequential mixed reads and writes + rw,readwrite Sequential mixed reads and writes randrw Random mixed reads and writes For the mixed io types, the default is to split them 50/50. @@ -318,8 +319,12 @@ rw=str Type of io pattern. Accepted values are: a number of IO's to do before getting a new offset, this is one by appending a ':' to the end of the string given. For a random read, it would look like 'rw=randread:8' for - passing in an offset modifier with a value of 8. See the - 'rw_sequencer' option. + passing in an offset modifier with a value of 8. If the + suffix is used with a sequential IO pattern, then the value + specified will be added to the generated offset for each IO. + For instance, using rw=write:4k will skip 4k for every + write. It turns sequential IO into sequential IO with holes. + See the 'rw_sequencer' option. rw_sequencer=str If an offset modifier is given by appending a number to the rw= line, then this option controls how that @@ -348,11 +353,25 @@ kb_base=int The base unit for a kilobyte. The defacto base is 2^10, 1024. randrepeat=bool For random IO workloads, seed the generator in a predictable way so that results are repeatable across repetitions. -fallocate=bool By default, fio will use fallocate() to advise the system - of the size of the file we are going to write. This can be - turned off with fallocate=0. May not be available on all - supported platforms. If using ZFS on Solaris this must be - set to 0 because ZFS doesn't support it. +use_os_rand=bool Fio can either use the random generator supplied by the OS + to generator random offsets, or it can use it's own internal + generator (based on Tausworthe). Default is to use the + internal generator, which is often of better quality and + faster. + +fallocate=str Whether pre-allocation is performed when laying down files. + Accepted values are: + + none Do not pre-allocate space + posix Pre-allocate via posix_fallocate() + keep Pre-allocate via fallocate() with + FALLOC_FL_KEEP_SIZE set + 0 Backward-compatible alias for 'none' + 1 Backward-compatible alias for 'posix' + + May not be available on all supported platforms. 'keep' is only + available on Linux.If using ZFS on Solaris this must be set to + 'none' because ZFS doesn't support it. Default: 'posix'. fadvise_hint=bool By default, fio will use fadvise() to advise the kernel on what IO patterns it is likely to issue. Sometimes you @@ -368,17 +387,25 @@ size=int The total size of file io for this job. Fio will run until fio will divide this size between the available files specified by the job. If not set, fio will use the full size of the given files or devices. If the the files - do not exist, size must be given. + do not exist, size must be given. It is also possible to + give size as a percentage between 1 and 100. If size=20% + is given, fio will use 20% of the full size of the given + files or devices. filesize=int Individual file sizes. May be a range, in which case fio will select sizes for files at random within the given range and limited to 'size' in total (if that is given). If not given, each created file is the same size. -fill_device=bool Sets size to something really large and waits for ENOSPC (no +fill_device=bool +fill_fs=bool Sets size to something really large and waits for ENOSPC (no space left on device) as the terminating condition. Only makes sense with sequential write. For a read workload, the mount - point will be filled first then IO started on the result. + point will be filled first then IO started on the result. This + option doesn't make sense if operating on a raw device node, + since the size of that is already known by the file system. + Additionally, writing beyond end-of-device will not return + ENOSPC there. blocksize=int bs=int The block size used for the io units. Defaults to 4k. Values @@ -454,6 +481,29 @@ refill_buffers If this option is given, fio will refill the IO buffers isn't specified, naturally. If data verification is enabled, refill_buffers is also automatically enabled. +scramble_buffers=bool If refill_buffers is too costly and the target is + using data deduplication, then setting this option will + slightly modify the IO buffer contents to defeat normal + de-dupe attempts. This is not enough to defeat more clever + block compression attempts, but it will stop naive dedupe of + blocks. Default: true. + +buffer_compress_percentage=int If this is set, then fio will attempt to + provide IO buffer content (on WRITEs) that compress to + the specified level. Fio does this by providing a mix of + random data and zeroes. Note that this is per block size + unit, for file/disk wide compression level that matches + this setting, you'll also want to set refill_buffers. + +buffer_compress_chunk=int See buffer_compress_percentage. This + setting allows fio to manage how big the ranges of random + data and zeroed data is. Without this set, fio will + provide buffer_compress_percentage of blocksize random + data, followed by the remaining zeroed. With this set + to some chunk size smaller than the block size, fio can + alternate random and zeroed data throughout the IO + buffer. + nrfiles=int Number of files to use for this job. Defaults to 1. openfiles=int Number of files to keep open at the same time. Defaults to @@ -490,6 +540,7 @@ ioengine=str Defines how the job issues io to the file. The following libaio Linux native asynchronous io. Note that Linux may only support queued behaviour with non-buffered IO (set direct=1 or buffered=0). + This engine defines engine specific options. posixaio glibc posix asynchronous io. @@ -518,16 +569,16 @@ ioengine=str Defines how the job issues io to the file. The following itself and for debugging/testing purposes. net Transfer over the network to given host:port. - 'filename' must be set appropriately to - filename=host/port/protocol regardless of send - or receive, if the latter only the port - argument is used. 'host' may be an IP address - or hostname, port is the port number to be used, - and protocol may be 'udp' or 'tcp'. If no - protocol is given, TCP is used. + Depending on the protocol used, the hostname, + port, listen and filename options are used to + specify what sort of connection to make, while + the protocol option determines which protocol + will be used. + This engine defines engine specific options. netsplice Like net, but uses splice/vmsplice to map data and send/receive. + This engine defines engine specific options. cpuio Doesn't transfer any data, but burns CPU cycles according to the cpuload= and @@ -546,6 +597,21 @@ ioengine=str Defines how the job issues io to the file. The following for more info on GUASI. + rdma The RDMA I/O engine supports both RDMA + memory semantics (RDMA_WRITE/RDMA_READ) and + channel semantics (Send/Recv) for the + InfiniBand, RoCE and iWARP protocols. + + falloc IO engine that does regular fallocate to + simulate data transfer as fio ioengine. + DDIR_READ does fallocate(,mode = keep_size,) + DDIR_WRITE does fallocate(,mode = 0) + DDIR_TRIM does fallocate(,mode = punch_hole) + + e4defrag IO engine that does regular EXT4_IOC_MOVE_EXT + ioctls to simulate defragment activity in + request to DDIR_WRITE event + external Prefix to specify loading an external IO engine object file. Append the engine filename, eg ioengine=external:/tmp/foo.o @@ -587,6 +653,7 @@ iodepth_low=int The low water mark indicating when to start filling direct=bool If value is true, use non-buffered io. This is usually O_DIRECT. Note that ZFS on Solaris doesn't support direct io. + On Windows the synchronous ioengines don't support direct io. buffered=bool If value is true, use buffered io. This is the opposite of the 'direct' option. Defaults to true. @@ -595,6 +662,13 @@ offset=int Start io at the given offset in the file. The data before the given offset will not be touched. This effectively caps the file size at real_size - offset. +offset_increment=int If this is provided, then the real offset becomes + the offset + offset_increment * thread_number, where the + thread number is a counter that starts at 0 and is incremented + for each job. This option is useful if there are several jobs + which are intended to operate on a file in parallel in disjoint + segments, with even spacing between the starting points. + fsync=int If writing to a file, issue a sync of the dirty data for every number of blocks given. For example, if you give 32 as a parameter, fio will sync the file for every 32 @@ -604,7 +678,7 @@ fsync=int If writing to a file, issue a sync of the dirty data fdatasync=int Like fsync= but uses fdatasync() to only sync data and not metadata blocks. - In FreeBSD there is no fdatasync(), this falls back to + In FreeBSD and Windows there is no fdatasync(), this falls back to using fsync() sync_file_range=str:val Use sync_file_range() for every 'val' number of @@ -651,10 +725,10 @@ norandommap Normally fio will cover every block of the file when doing blocksizes (via bsrange=) are used, since fio only tracks complete rewrites of blocks. -softrandommap See norandommap. If fio runs with the random block map enabled - and it fails to allocate the map, if this option is set it - will continue without a random block map. As coverage will - not be as complete as with random maps, this option is +softrandommap=bool See norandommap. If fio runs with the random block map + enabled and it fails to allocate the map, if this option is + set it will continue without a random block map. As coverage + will not be as complete as with random maps, this option is disabled by default. nice=int Run the job with the given nice value. See man nice(2). @@ -815,6 +889,9 @@ exitall When one job finishes, terminate the rest. The default is bwavgtime=int Average the calculated bandwidth over the given time. Value is specified in milliseconds. +iopsavgtime=int Average the calculated IOPS over the given time. Value + is specified in milliseconds. + create_serialize=bool If true, serialize the file creating for the jobs. This may be handy to avoid interleaving of data files, which may greatly depend on the filesystem @@ -826,6 +903,11 @@ create_fsync=bool fsync the data file after creation. This is the create_on_open=bool Don't pre-setup the files for IO, just create open() when it's time to do IO to that file. +create_only=bool If true, fio will only run the setup phase of the job. + If files need to be laid out or updated on disk, only + that will be done. The actual job contents are not + executed. + pre_read=bool If this is given, files will be pre-read into memory before starting the given IO operation. This will also clear the 'invalidate' flag, since it is pointless to pre-read @@ -929,7 +1011,7 @@ verify_fatal=bool Normally fio will keep checking the entire contents verify_dump=bool If set, dump the contents of both the original data block and the data block we read off disk to files. This allows later analysis to inspect just what kind of data - corruption occurred. On by default. + corruption occurred. Off by default. verify_async=int Fio will normally verify IO inline from the submitting thread. This option takes an integer describing how many @@ -965,7 +1047,8 @@ verify_backlog_batch=int Control how many blocks fio will verify if verify_backlog_batch is larger than verify_backlog, some blocks will be verified more than once. -stonewall Wait for preceeding jobs in the job file to exit, before +stonewall +wait_for_previous Wait for preceeding jobs in the job file to exit, before starting this one. Can be used to insert serialization points in the job file. A stone wall also implies starting a new reporting group. @@ -1039,8 +1122,8 @@ write_bw_log=str If given, write a bandwidth log of the jobs in this job file. Can be used to store data of the bandwidth of the jobs in their lifetime. The included fio_generate_plots script uses gnuplot to turn these text files into nice - graphs. See write_log_log for behaviour of given - filename. For this option, the postfix is _bw.log. + graphs. See write_lat_log for behaviour of given + filename. For this option, the suffix is _bw.log. write_lat_log=str Same as write_bw_log, except that this option stores io submission, completion, and total latencies instead. If no @@ -1054,6 +1137,21 @@ write_lat_log=str Same as write_bw_log, except that this option stores io and foo_lat.log. This helps fio_generate_plot fine the logs automatically. +write_bw_log=str If given, write an IOPS log of the jobs in this job + file. See write_bw_log. + +write_iops_log=str Same as write_bw_log, but writes IOPS. If no filename is + given with this option, the default filename of + "jobname_type.log" is used. Even if the filename is given, + fio will still append the type of log. + +log_avg_msec=int By default, fio will log an entry in the iops, latency, + or bw log for every IO that completes. When writing to the + disk log, that can quickly grow to a very large size. Setting + this option makes fio average the each log entry over the + specified period of time, reducing the resolution of the log. + Defaults to 0. + lockmem=int Pin down the specified amount of memory with mlock(2). Can potentially be used instead of removing memory or booting with less memory to simulate a smaller amount of memory. @@ -1092,6 +1190,18 @@ disable_slat=bool Disable measurements of submission latency numbers. See disable_bw=bool Disable measurements of throughput/bandwidth numbers. See disable_lat. +clat_percentiles=bool Enable the reporting of percentiles of + completion latencies. + +percentile_list=float_list Overwrite the default list of percentiles + for completion latencies. Each number is a floating + number in the range (0,100], and the maximum length of + the list is 20. Use ':' to separate the numbers, and + list the numbers in ascending order. For example, + --percentile_list=99.5:99.9 will cause fio to report + the values of completion latency below which 99.5% and + 99.9% of the observed latencies fell, respectively. + gtod_reduce=bool Enable all of the gettimeofday() reducing options (disable_clat, disable_slat, disable_bw) plus reduce precision of the timeout somewhat to really shrink @@ -1111,7 +1221,7 @@ gtod_cpu=int Sometimes it's cheaper to dedicate a single thread of uses. Fio will manually clear it from the CPU mask of other jobs. -continue_on_error=bool Normally fio will exit the job on the first observed +continue_on_error=str Normally fio will exit the job on the first observed failure. If this option is set, fio will continue the job when there is a 'non-fatal error' (EIO or EILSEQ) until the runtime is exceeded or the I/O size specified is completed. If this @@ -1120,6 +1230,24 @@ continue_on_error=bool Normally fio will exit the job on the first observed given in the stats is the first error that was hit during the run. + The allowed values are: + + none Exit on any IO or verify errors. + + read Continue on read errors, exit on all others. + + write Continue on write errors, exit on all others. + + io Continue on any IO error, exit on all others. + + verify Continue on verify errors, exit on all others. + + all Continue on all errors. + + 0 Backward-compatible alias for 'none'. + + 1 Backward-compatible alias for 'all'. + cgroup=str Add job to this control group. If it doesn't exist, it will be created. The system must have a mounted cgroup blkio mount point for this to work. If your system doesn't have it @@ -1142,6 +1270,72 @@ uid=int Instead of running as the invoking user, set the user ID to gid=int Set group ID, see uid. +flow_id=int The ID of the flow. If not specified, it defaults to being a + global flow. See flow. + +flow=int Weight in token-based flow control. If this value is used, then + there is a 'flow counter' which is used to regulate the + proportion of activity between two or more jobs. fio attempts + to keep this flow counter near zero. The 'flow' parameter + stands for how much should be added or subtracted to the flow + counter on each iteration of the main I/O loop. That is, if + one job has flow=8 and another job has flow=-1, then there + will be a roughly 1:8 ratio in how much one runs vs the other. + +flow_watermark=int The maximum value that the absolute value of the flow + counter is allowed to reach before the job must wait for a + lower value of the counter. + +flow_sleep=int The period of time, in microseconds, to wait after the flow + watermark has been exceeded before retrying operations + +In addition, there are some parameters which are only valid when a specific +ioengine is in use. These are used identically to normal parameters, with the +caveat that when used on the command line, they must come after the ioengine +that defines them is selected. + +[libaio] userspace_reap Normally, with the libaio engine in use, fio will use + the io_getevents system call to reap newly returned events. + With this flag turned on, the AIO ring will be read directly + from user-space to reap events. The reaping mode is only + enabled when polling for a minimum of 0 events (eg when + iodepth_batch_complete=0). + +[netsplice] hostname=str +[net] hostname=str The host name or IP address to use for TCP or UDP based IO. + If the job is a TCP listener or UDP reader, the hostname is not + used and must be omitted. + +[netsplice] port=int +[net] port=int The TCP or UDP port to bind to or connect to. + +[netsplice] protocol=str +[netsplice] proto=str +[net] protocol=str +[net] proto=str The network protocol to use. Accepted values are: + + tcp Transmission control protocol + udp Unreliable datagram protocol + unix UNIX domain socket + + When the protocol is TCP or UDP, the port must also be given, + as well as the hostname if the job is a TCP listener or UDP + reader. For unix sockets, the normal filename option should be + used and the port is invalid. + +[net] listen For TCP network connections, tell fio to listen for incoming + connections rather than initiating an outgoing connection. The + hostname must be omitted if this option is used. +[e4defrag] donorname=str + File will be used as a block donor(swap extents between files) +[e4defrag] inplace=int + Configure donor file blocks allocation strategy + 0(default): Preallocate donor's file on init + 1 : allocate space immidietly inside defragment event, + and free right after event + + + 6.0 Interpreting the output --------------------------- @@ -1168,20 +1362,24 @@ I Thread initialized, waiting. F Running, currently waiting for fsync() V Running, doing verification of written data. E Thread exited, not reaped by main thread yet. -_ Thread reaped. +_ Thread reaped, or +X Thread reaped, exited with an error. +K Thread reaped, exited due to signal. The other values are fairly self explanatory - number of threads currently running and doing io, rate of io since last check (read speed listed first, then write speed), and the estimated completion percentage and time for the running group. It's impossible to estimate runtime of -the following groups (if any). +the following groups (if any). Note that the string is displayed in order, +so it's possible to tell which of the jobs are currently doing what. The +first character is the first job defined in the job file, and so forth. When fio is done (or interrupted by ctrl-c), it will show the data for each thread, group of threads, and disks in that order. For each data direction, the output looks like: Client1 (g=0): err= 0: - write: io= 32MB, bw= 666KB/s, runt= 50320msec + write: io= 32MB, bw= 666KB/s, iops=89 , runt= 50320msec slat (msec): min= 0, max= 136, avg= 0.03, stdev= 1.92 clat (msec): min= 0, max= 631, avg=48.50, stdev=86.82 bw (KB/s) : min= 0, max= 1196, per=51.00%, avg=664.02, stdev=681.68 @@ -1199,6 +1397,7 @@ they denote: io= Number of megabytes io performed bw= Average bandwidth rate +iops= Average IOs performed per second runt= The runtime of that thread slat= Submission latency (avg being the average, stdev being the standard deviation). This is the time it took to submit @@ -1206,7 +1405,8 @@ runt= The runtime of that thread latency, since queue/complete is one operation there. This value can be in milliseconds or microseconds, fio will choose the most appropriate base and print that. In the example - above, milliseconds is the best scale. + above, milliseconds is the best scale. Note: in --minimal mode + latencies are always expressed in microseconds. clat= Completion latency. Same names as slat, this denotes the time from submission to completion of the io pieces. For sync io, clat will usually be equal (or very close) to 0, @@ -1271,6 +1471,9 @@ io_queue= Total time spent in the disk queue. util= The disk utilization. A value of 100% means we kept the disk busy constantly, 50% would be a disk idling half of the time. +It is also possible to get fio to dump the current output while it is +running, without terminating the job. To do that, send fio the USR1 signal. + 7.0 Terse output ---------------- @@ -1291,23 +1494,100 @@ signify that change. Split up, the format is as follows: - version, jobname, groupid, error + terse version, fio version, jobname, groupid, error READ status: - KB IO, bandwidth (KB/sec), runtime (msec) - Submission latency: min, max, mean, deviation - Completion latency: min, max, mean, deviation - Total latency: min, max, mean, deviation - Bw: min, max, aggregate percentage of total, mean, deviation + Total IO (KB), bandwidth (KB/sec), IOPS, runtime (msec) + Submission latency: min, max, mean, deviation (usec) + Completion latency: min, max, mean, deviation (usec) + Completion latency percentiles: 20 fields (see below) + Total latency: min, max, mean, deviation (usec) + Bw (KB/s): min, max, aggregate percentage of total, mean, deviation WRITE status: - KB IO, bandwidth (KB/sec), runtime (msec) - Submission latency: min, max, mean, deviation - Completion latency: min, max, mean, deviation - Total latency: min, max, mean, deviation - Bw: min, max, aggregate percentage of total, mean, deviation + Total IO (KB), bandwidth (KB/sec), IOPS, runtime (msec) + Submission latency: min, max, mean, deviation (usec) + Completion latency: min, max, mean, deviation (usec) + Completion latency percentiles: 20 fields (see below) + Total latency: min, max, mean, deviation (usec) + Bw (KB/s): min, max, aggregate percentage of total, mean, deviation CPU usage: user, system, context switches, major faults, minor faults IO depths: <=1, 2, 4, 8, 16, 32, >=64 IO latencies microseconds: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000 IO latencies milliseconds: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, 2000, >=2000 + Disk utilization: Disk name, Read ios, write ios, + Read merges, write merges, + Read ticks, write ticks, + Time spent in queue, disk utilization percentage Additional Info (dependant on continue_on_error, default off): total # errors, first error code Additional Info (dependant on description being set): Text description + +Completion latency percentiles can be a grouping of up to 20 sets, so +for the terse output fio writes all of them. Each field will look like this: + + 1.00%=6112 + +which is the Xth percentile, and the usec latency associated with it. + +For disk utilization, all disks used by fio are shown. So for each disk +there will be a disk utilization section. + + +8.0 Trace file format +--------------------- +There are two trace file format that you can encounter. The older (v1) format +is unsupported since version 1.20-rc3 (March 2008). It will still be described +below in case that you get an old trace and want to understand it. + +In any case the trace is a simple text file with a single action per line. + + +8.1 Trace file format v1 +------------------------ +Each line represents a single io action in the following format: + +rw, offset, length + +where rw=0/1 for read/write, and the offset and length entries being in bytes. + +This format is not supported in Fio versions => 1.20-rc3. + + +8.2 Trace file format v2 +------------------------ +The second version of the trace file format was added in Fio version 1.17. +It allows to access more then one file per trace and has a bigger set of +possible file actions. + +The first line of the trace file has to be: + +fio version 2 iolog + +Following this can be lines in two different formats, which are described below. + +The file management format: + +filename action + +The filename is given as an absolute path. The action can be one of these: + +add Add the given filename to the trace +open Open the file with the given filename. The filename has to have + been added with the add action before. +close Close the file with the given filename. The file has to have been + opened before. + + +The file io action format: + +filename action offset length + +The filename is given as an absolute path, and has to have been added and opened +before it can be used with this format. The offset and length are given in +bytes. The action can be one of these: + +wait Wait for 'offset' microseconds. Everything below 100 is discarded. +read Read 'length' bytes beginning from 'offset' +write Write 'length' bytes beginning from 'offset' +sync fsync() the file +datasync fdatasync() the file +trim trim the given file from the given 'offset' for 'length' bytes