X-Git-Url: https://git.kernel.dk/?p=fio.git;a=blobdiff_plain;f=HOWTO;h=72a29a96eb1f05f69561fe85086fd9c5aa6e5cbc;hp=68e17e9f4743b6738fe10c1e329be9783f8af746;hb=eb52fa3f9b91181dd87335998b94864ab9c14d6c;hpb=b463e9363b826d5ba4f16e0115a26f24b77078f4 diff --git a/HOWTO b/HOWTO index 68e17e9f..72a29a96 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. @@ -348,11 +349,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 +383,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 @@ -546,6 +569,11 @@ 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. + external Prefix to specify loading an external IO engine object file. Append the engine filename, eg ioengine=external:/tmp/foo.o @@ -651,10 +679,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). @@ -965,7 +993,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. @@ -1092,6 +1121,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 @@ -1181,7 +1222,7 @@ 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 +1240,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 @@ -1311,3 +1353,64 @@ Split up, the format is as follows: Additional Info (dependant on continue_on_error, default off): total # errors, first error code Additional Info (dependant on description being set): Text description + + +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