X-Git-Url: https://git.kernel.dk/?p=fio.git;a=blobdiff_plain;f=HOWTO;h=a534aa865d8c4a9384ebee3d823ecaaaf0fdfb3d;hp=bcc72b5882be95e4804a641f151cde13b214b432;hb=5d02b083f521bf7508249af8d3c7987992c7b718;hpb=36870c47801ca85d1a98c7ec47950b0aa360f865 diff --git a/HOWTO b/HOWTO index bcc72b58..a534aa86 100644 --- a/HOWTO +++ b/HOWTO @@ -198,7 +198,7 @@ sections. ------------------------- fio also supports environment variable expansion in job files. Any -substring of the form "${VARNAME}" as part of an option value (in other +sub-string of the form "${VARNAME}" as part of an option value (in other words, on the right of the `='), will be expanded to the value of the environment variable called VARNAME. If no such environment variable is defined, or VARNAME is the empty string, the empty string will be @@ -435,6 +435,7 @@ unified_rw_reporting=bool Fio normally reports statistics on a per randrepeat=bool For random IO workloads, seed the generator in a predictable way so that results are repeatable across repetitions. + Defaults to true. randseed=int Seed the random number generators based on this seed value, to be able to control what sequence of output is being generated. @@ -622,7 +623,16 @@ buffer_pattern=str If set, fio will fill the io buffers with this the other options related to buffer contents. The setting can be any pattern of bytes, and can be prefixed with 0x for hex values. It may also be a string, where the string must then - be wrapped with "". + be wrapped with "", e.g.: + + buffer_pattern="abcd" + or + buffer_pattern=-12 + or + buffer_pattern=0xdeadface + + Also you can combine everything together in any order: + buffer_pattern=0xdeadface"abcd"-12 dedupe_percentage=int If set, fio will generate this percentage of identical buffers when writing. These buffers will be @@ -802,8 +812,10 @@ iodepth_batch_submit=int iodepth_batch=int This defines how many pieces of IO to submit at once. It defaults to 1 which means that we submit each IO as soon as it is available, but can be raised to submit - bigger batches of IO at the time. + bigger batches of IO at the time. If it is set to 0 the iodepth + value will be used. +iodepth_batch_complete_min=int iodepth_batch_complete=int This defines how many pieces of IO to retrieve at once. It defaults to 1 which means that we'll ask for a minimum of 1 IO in the retrieval process from @@ -813,6 +825,31 @@ iodepth_batch_complete=int This defines how many pieces of IO to retrieve events before queuing more IO. This helps reduce IO latency, at the cost of more retrieval system calls. +iodepth_batch_complete_max=int This defines maximum pieces of IO to + retrieve at once. This variable should be used along with + iodepth_batch_complete_min=int variable, specifying the range + of min and max amount of IO which should be retrieved. By default + it is equal to iodepth_batch_complete_min value. + + Example #1: + + iodepth_batch_complete_min=1 + iodepth_batch_complete_max= + + which means that we will retrieve at leat 1 IO and up to the + whole submitted queue depth. If none of IO has been completed + yet, we will wait. + + Example #2: + + iodepth_batch_complete_min=0 + iodepth_batch_complete_max= + + which means that we can retrieve up to the whole submitted + queue depth, but if none of IO has been completed yet, we will + NOT wait and immediately exit the system call. In this example + we simply do polling. + iodepth_low=int The low water mark indicating when to start filling the queue again. Defaults to the same as iodepth, meaning that fio will attempt to keep the queue full at all times. @@ -874,8 +911,8 @@ 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 and Windows there is no fdatasync(), this falls back to - using fsync() + 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 write operations. Fio will track range of writes that @@ -960,6 +997,8 @@ random_generator=str Fio supports the following engines for generating tausworthe Strong 2^88 cycle random number generator lfsr Linear feedback shift register generator + tausworthe64 Strong 64-bit 2^258 cycle random number + generator Tausworthe is a strong random number generator, but it requires tracking on the side if we want to ensure that @@ -1010,7 +1049,7 @@ rate=int Cap the bandwidth used by this job. The number is in bytes/sec, will only limit writes (to 500KB/sec), the latter will only limit reads. -ratemin=int Tell fio to do whatever it can to maintain at least this +rate_min=int Tell fio to do whatever it can to maintain at least this bandwidth. Failing to meet this requirement, will cause the job to exit. The same format as rate is used for read vs write separation. @@ -1025,6 +1064,15 @@ rate_iops_min=int If fio doesn't meet this rate of IO, it will cause the job to exit. The same format as rate is used for read vs write separation. +rate_process=str This option controls how fio manages rated IO + submissions. The default is 'linear', which submits IO in a + linear fashion with fixed delays between IOs that gets + adjusted based on IO completion rates. If this is set to + 'poisson', fio will submit IO based on a more real world + random request flow, known as the Poisson process + (https://en.wikipedia.org/wiki/Poisson_process). The lambda + will be 10^6 / IOPS for the given workload. + latency_target=int If set, fio will attempt to find the max performance point that the given workload will run at while maintaining a latency below this target. The values is given in microseconds. @@ -1042,7 +1090,7 @@ latency_percentile=float The percentage of IOs that must fall within the max_latency=int If set, fio will exit the job if it exceeds this maximum latency. It will exit with an ETIME error. -ratecycle=int Average bandwidth for 'rate' and 'ratemin' over this number +rate_cycle=int Average bandwidth for 'rate' and 'rate_min' over this number of milliseconds. cpumask=int Set the CPU affinity of this job. The parameter given is a @@ -1138,6 +1186,9 @@ mem=str Fio can use various types of memory as the io unit buffer. backing. Append filename after mmaphuge, ala mem=mmaphuge:/hugetlbfs/file + mmapshared Same as mmap, but use a MMAP_SHARED + mapping. + The area allocated is a function of the maximum allowed bs size for the job, multiplied by the io depth given. Note that for shmhuge and mmaphuge to work, the system must have @@ -1198,6 +1249,17 @@ create_only=bool If true, fio will only run the setup phase of the job. that will be done. The actual job contents are not executed. +allow_file_create=bool If true, fio is permitted to create files as part + of its workload. This is the default behavior. If this + option is false, then fio will error out if the files it + needs to use don't already exist. Default: true. + +allow_mounted_write=bool If this isn't set, fio will abort jobs that + are destructive (eg that write) to what appears to be a + mounted device or partition. This should help catch creating + inadvertently destructive tests, not realizing that the test + will destroy data on the mounted file system. Default: false. + 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 @@ -1225,7 +1287,12 @@ do_verify=bool Run the verify phase after a write phase. Only makes sense if verify is set. Defaults to 1. verify=str If writing to a file, fio can verify the file contents - after each iteration of the job. The allowed values are: + after each iteration of the job. Each verification method also implies + verification of special header, which is written to the beginning of + each block. This header also includes meta information, like offset + of the block, block number, timestamp when block was written, etc. + verify=str can be combined with verify_pattern=str option. + The allowed values are: md5 Use an md5 sum of the data area and store it in the header of each block. @@ -1261,11 +1328,17 @@ verify=str If writing to a file, fio can verify the file contents sha1 Use optimized sha1 as the checksum function. - meta Write extra information about each io - (timestamp, block number etc.). The block - number is verified. The io sequence number is - verified for workloads that write data. - See also verify_pattern. + meta This option is deprecated, since now meta information is + included in generic verification header and meta verification + happens by default. For detailed information see the description + of the verify=str setting. This option is kept because of + compatibility's sake with old configurations. Do not use it. + + pattern Verify a strict pattern. Normally fio includes + a header with some basic information and + checksumming, but if this option is set, only + the specific pattern set with 'verify_pattern' + is verified. null Only pretend to verify. Useful for testing internals with ioengine=null, not for much @@ -1304,7 +1377,14 @@ verify_pattern=str If set, fio will fill the io buffers with this buffer at the time(it can be either a decimal or a hex number). The verify_pattern if larger than a 32-bit quantity has to be a hex number that starts with either "0x" or "0X". Use - with verify=meta. + with verify=str. Also, verify_pattern supports %o format, + which means that for each block offset will be written and + then verifyied back, e.g.: + + verify_pattern=%o + + Or use combination of everything: + verify_pattern=0xff%o"abcd"-12 verify_fatal=bool Normally fio will keep checking the entire contents before quitting on a block verification failure. If this @@ -1433,6 +1513,16 @@ replay_redirect=str While replaying I/O patterns using read_iolog the independent fio invocations. Unfortuantely this also breaks the strict time ordering between multiple device accesses. +replay_align=int Force alignment of IO offsets and lengths in a trace + to this power of 2 value. + +replay_scale=int Scale sector offsets down by this factor when + replaying traces. + +per_job_logs=bool If set, this generates bw/clat/iops log with per + file private filenames. If not set, jobs with identical names + will share the log filename. Default: true. + 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 @@ -1440,7 +1530,8 @@ write_bw_log=str If given, write a bandwidth log of the jobs in this job graphs. See write_lat_log for behaviour of given filename. For this option, the suffix is _bw.x.log, where x is the index of the job (1..N, where N is the number of - jobs). + jobs). If 'per_job_logs' is false, then the filename will not + include the job index. write_lat_log=str Same as write_bw_log, except that this option stores io submission, completion, and total latencies instead. If no @@ -1453,13 +1544,17 @@ write_lat_log=str Same as write_bw_log, except that this option stores io The actual log names will be foo_slat.x.log, foo_clat.x.log, and foo_lat.x.log, where x is the index of the job (1..N, where N is the number of jobs). This helps fio_generate_plot - fine the logs automatically. + fine the logs automatically. If 'per_job_logs' is false, then + the filename will not include the job index. + 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.x.log" is used,where x is the index of the job (1..N, where N is the number of jobs). Even if the filename - is given, fio will still append the type of log. + is given, fio will still append the type of log. If + 'per_job_logs' is false, then the filename will not include + the job index. 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 @@ -1921,18 +2016,18 @@ Split up, the format is as follows: terse version, fio version, jobname, groupid, error READ status: Total IO (KB), bandwidth (KB/sec), IOPS, runtime (msec) - Submission latency: min, max, mean, deviation (usec) - Completion latency: min, max, mean, deviation (usec) + Submission latency: min, max, mean, stdev (usec) + Completion latency: min, max, mean, stdev (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 + Total latency: min, max, mean, stdev (usec) + Bw (KB/s): min, max, aggregate percentage of total, mean, stdev WRITE status: Total IO (KB), bandwidth (KB/sec), IOPS, runtime (msec) - Submission latency: min, max, mean, deviation (usec) - Completion latency: min, max, mean, deviation (usec) + Submission latency: min, max, mean, stdev (usec) + Completion latency: min, max, mean, stdev(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 + Total latency: min, max, mean, stdev (usec) + Bw (KB/s): min, max, aggregate percentage of total, mean, stdev 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 @@ -2010,6 +2105,7 @@ 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. + The time is relative to the previous wait statement. read Read 'length' bytes beginning from 'offset' write Write 'length' bytes beginning from 'offset' sync fsync() the file