X-Git-Url: https://git.kernel.dk/?p=fio.git;a=blobdiff_plain;f=HOWTO;h=3bda021d17c9090929d4276161b346242a0f27c4;hp=08a2b68dac71cdbd2cd101d02fa2f2859b22cd8c;hb=dc372f07b450e3b4c758d7a7fdaaca6c21843398;hpb=661598287ecc3b8987f312cf8403936552ce686a diff --git a/HOWTO b/HOWTO index 08a2b68d..3bda021d 100644 --- a/HOWTO +++ b/HOWTO @@ -170,7 +170,7 @@ Some parameters take an option of a given type, such as an integer or a string. The following types are used: str String. This is a sequence of alpha characters. -int Integer. A whole number value, may be negative. +int Integer. A whole number value, can be negative. siint SI integer. A whole number value, which may contain a postfix describing the base of the number. Accepted postfixes are k/m/g, meaning kilo, mega, and giga. So if you want to specify 4096, @@ -249,12 +249,12 @@ fadvise_hint=bool By default, fio will use fadvise() to advise the kernel If set, fio will use POSIX_FADV_SEQUENTIAL for sequential IO and POSIX_FADV_RANDOM for random IO. -size=siint The total size of file io for this job. This may describe - the size of the single file the job uses, or it may be - divided between the number of files in the job. If the - file already exists, the file size will be adjusted to this - size if larger than the current file size. If this parameter - is not given and the file exists, the file size will be used. +size=siint The total size of file io for this job. Fio will run until + this many bytes has been transferred, unless runtime is + limited by other options (such as 'runtime', for instance). + Unless specific nr_files and filesize options are given, + fio will divide this size between the available files + specified by the job. filesize=siint Individual file sizes. May be a range, in which case fio will select sizes for files at random within the given range @@ -285,6 +285,9 @@ bs_unaligned If this option is given, any byte size value within bsrange may be used as a block range. This typically wont work with direct IO, as that normally requires sector alignment. +zero_buffers If this option is given, fio will init the IO buffers to + all zeroes. The default is to fill them with random data. + 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 @@ -340,6 +343,9 @@ ioengine=str Defines how the job issues io to the file. The following or receive, if the latter only the port argument is used. + netsplice Like net, but uses splice/vmsplice to + map data and send/receive. + cpu Doesn't transfer any data, but burns CPU cycles according to the cpuload= and cpucycle= options. Setting cpuload=85 @@ -416,7 +422,9 @@ norandommap Normally fio will cover every block of the file when doing new random offset without looking at past io history. This means that some blocks may not be read or written, and that some blocks may be read/written more than once. This option - is mutually exclusive with verify= for that reason. + is mutually exclusive with verify= for that reason, since + fio doesn't track potential block rewrites which may alter + the calculated checksum for that block. nice=int Run the job with the given nice value. See man nice(2). @@ -461,8 +469,15 @@ ratecycle=int Average bandwidth for 'rate' and 'ratemin' over this number of milliseconds. cpumask=int Set the CPU affinity of this job. The parameter given is a - bitmask of allowed CPU's the job may run on. See man - sched_setaffinity(2). + bitmask of allowed CPU's the job may run on. So if you want + the allowed CPUs to be 1 and 5, you would pass the decimal + value of (1 << 1 | 1 << 5), or 34. See man + sched_setaffinity(2). This may not work on all supported + operating systems or kernel versions. + +cpus_allowed=str Controls the same options as cpumask, but it allows a text + setting of the permitted CPUs instead. So to use CPUs 1 and + 5, you would specify cpus_allowed=1,5. startdelay=int Start this job the specified number of seconds after fio has started. Only useful if the job file contains several @@ -474,6 +489,11 @@ runtime=int Tell fio to terminate processing after the specified number a specified job will run, so this parameter is handy to cap the total runtime to a given time. +time_based If set, fio will run for the duration of the runtime + specified even if the file(s) are completey read or + written. It will simply loop over the same workload + as many times as the runtime allows. + invalidate=bool Invalidate the buffer/page cache parts for this file prior to starting io. Defaults to true. @@ -610,7 +630,12 @@ write_iolog=str Write the issued io patterns to the specified file. See read_iolog=str Open an iolog with the specified file name and replay the io patterns it contains. This can be used to store a - workload and replay it sometime later. + workload and replay it sometime later. The iolog given + may also be a blktrace binary file, which allows fio + to replay a workload captured by blktrace. See blktrace + for how to capture such logging data. For blktrace replay, + the file needs to be turned into a blkparse binary data + file first (blktrace -d file_for_fio.bin). write_bw_log If given, write a bandwidth log of the jobs in this job file. Can be used to store data of the bandwidth of the @@ -640,6 +665,9 @@ cpuload=int If the job is a CPU cycle eater, attempt to use the specified cpuchunks=int If the job is a CPU cycle eater, split the load into cycles of the given time. In milliseconds. +disk_util=bool Generate disk utilization statistics, if the platform + supports it. Defaults to on. + 6.0 Interpreting the output --------------------------- @@ -669,9 +697,10 @@ E Thread exited, not reaped by main thread yet. _ Thread reaped. The other values are fairly self explanatory - number of threads -currently running and doing io, rate of io since last check, and the estimated -completion percentage and time for the running group. It's impossible to -estimate runtime of the following groups (if any). +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). 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 @@ -684,6 +713,7 @@ Client1 (g=0): err= 0: bw (KiB/s) : min= 0, max= 1196, per=51.00%, avg=664.02, stdev=681.68 cpu : usr=1.49%, sys=0.25%, ctx=7969 IO depths : 1=0.1%, 2=0.3%, 4=0.5%, 8=99.0%, 16=0.0%, 32=0.0%, >32=0.0% + issued r/w: total=0/32768, short=0/0 lat (msec): 2=1.6%, 4=0.0%, 10=3.2%, 20=12.8%, 50=38.4%, 100=24.8%, lat (msec): 250=15.2%, 500=0.0%, 750=0.0%, 1000=0.0%, >=2048=0.0% @@ -697,7 +727,10 @@ 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 the io. For sync io, the slat is really the completion - latency, since queue/complete is one operation there. + latency, since queue/complete is one operation there. This + value can be in miliseconds or microseconds, fio will choose + the most appropriate base and print that. In the example + above, miliseconds is the best scale. 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, @@ -715,6 +748,8 @@ IO depths= The distribution of io depths over the job life time. The 16= entries includes depths up to that value but higher than the previous entry. In other words, it covers the range from 16 to 31. +IO issued= The number of read/write requests issued, and how many + of them were short. IO latencies= The distribution of IO completion latencies. This is the time from when IO leaves fio and when it gets completed. The numbers follow the same pattern as the IO depths,