Mention default values for readwrite=/ioengine=/mem= in documentation

[fio.git] / fio.1

diff --git a/fio.1 b/fio.1
index 0abe321304cc5f9a4c06812e32017148238803d1..0461d90e1f8ba6077fe38507021662f17c5f87ba 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -247,6 +247,11 @@ will be used if no other format specifier is given.
 .RE
 .P
 .TP
 .RE
 .P
 .TP

+.BI unique_filename \fR=\fPbool
+To avoid collisions between networked clients, fio defaults to prefixing
+any generated filenames (with a directory specified) with the source of
+the client connecting. To disable this behavior, set this option to 0.
+.TP

 .BI lockfile \fR=\fPstr
 Fio defaults to not locking any files before it does IO to them. If a file or
 file descriptor is shared, fio can serialize IO to that file to make the end
 .BI lockfile \fR=\fPstr
 Fio defaults to not locking any files before it does IO to them. If a file or
 file descriptor is shared, fio can serialize IO to that file to make the end


@@ -304,6 +309,7 @@ Trim and write mixed workload. Blocks will be trimmed first, then the same
 blocks will be written to.
 .RE
 .P
 blocks will be written to.
 .RE
 .P

+Fio defaults to read if the option is not specified.

 For mixed I/O, the default split is 50/50. For certain types of io the result
 may still be skewed a bit, since the speed may be different. It is possible to
 specify a number of IO's to do before getting a new offset, this is done by
 For mixed I/O, the default split is 50/50. For certain types of io the result
 may still be skewed a bit, since the speed may be different. It is possible to
 specify a number of IO's to do before getting a new offset, this is done by


@@ -566,10 +572,24 @@ Round robin over opened files (default).
 .TP
 .B sequential
 Do each file in the set sequentially.
 .TP
 .B sequential
 Do each file in the set sequentially.

+.TP
+.B zipf
+Use a zipfian distribution to decide what file to access.
+.TP
+.B pareto
+Use a pareto distribution to decide what file to access.
+.TP
+.B gauss
+Use a gaussian (normal) distribution to decide what file to access.

 .RE
 .P
 .RE
 .P

-The number of I/Os to issue before switching to a new file can be specified by
-appending `:\fIint\fR' to the service type.
+For \fBrandom\fR, \fBroundrobin\fR, and \fBsequential\fR, a postfix can be
+appended to tell fio how many I/Os to issue before switching to a new file.
+For example, specifying \fBfile_service_type=random:8\fR would cause fio to
+issue \fI8\fR I/Os before selecting a new file at random. For the non-uniform
+distributions, a floating point postfix can be given to influence how the
+distribution is skewed. See \fBrandom_distribution\fR for a description of how
+that would work.

 .RE
 .TP
 .BI ioengine \fR=\fPstr
 .RE
 .TP
 .BI ioengine \fR=\fPstr


@@ -583,6 +603,7 @@ position the I/O location.
 .TP
 .B psync
 Basic \fBpread\fR\|(2) or \fBpwrite\fR\|(2) I/O.
 .TP
 .B psync
 Basic \fBpread\fR\|(2) or \fBpwrite\fR\|(2) I/O.

+Default on all supported operating systems except for Windows.

 .TP
 .B vsync
 Basic \fBreadv\fR\|(2) or \fBwritev\fR\|(2) I/O. Will emulate queuing by
 .TP
 .B vsync
 Basic \fBreadv\fR\|(2) or \fBwritev\fR\|(2) I/O. Will emulate queuing by


@@ -604,7 +625,7 @@ POSIX asynchronous I/O using \fBaio_read\fR\|(3) and \fBaio_write\fR\|(3).
 Solaris native asynchronous I/O.
 .TP
 .B windowsaio
 Solaris native asynchronous I/O.
 .TP
 .B windowsaio

-Windows native asynchronous I/O.
+Windows native asynchronous I/O. Default on Windows.

 .TP
 .B mmap
 File is memory mapped with \fBmmap\fR\|(2) and data copied using
 .TP
 .B mmap
 File is memory mapped with \fBmmap\fR\|(2) and data copied using


@@ -614,9 +635,6 @@ File is memory mapped with \fBmmap\fR\|(2) and data copied using
 \fBsplice\fR\|(2) is used to transfer the data and \fBvmsplice\fR\|(2) to
 transfer data from user-space to the kernel.
 .TP
 \fBsplice\fR\|(2) is used to transfer the data and \fBvmsplice\fR\|(2) to
 transfer data from user-space to the kernel.
 .TP

-.B syslet-rw
-Use the syslet system calls to make regular read/write asynchronous.
-.TP

 .B sg
 SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if
 the target is an sg character device, we use \fBread\fR\|(2) and
 .B sg
 SCSI generic sg v3 I/O. May be either synchronous using the SG_IO ioctl, or if
 the target is an sg character device, we use \fBread\fR\|(2) and


@@ -638,7 +656,7 @@ and send/receive. This ioengine defines engine specific options.
 .TP
 .B cpuio
 Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and
 .TP
 .B cpuio
 Doesn't transfer any data, but burns CPU cycles according to \fBcpuload\fR and

-\fBcpucycles\fR parameters.
+\fBcpuchunks\fR parameters.

 .TP
 .B guasi
 The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface
 .TP
 .B guasi
 The GUASI I/O engine is the Generic Userspace Asynchronous Syscall Interface


@@ -700,6 +718,9 @@ treated as erases. Depending on the underlying device type, the I/O may have
 to go in a certain pattern, e.g., on NAND, writing sequentially to erase blocks
 and discarding before overwriting. The writetrim mode works well for this
 constraint.
 to go in a certain pattern, e.g., on NAND, writing sequentially to erase blocks
 and discarding before overwriting. The writetrim mode works well for this
 constraint.

+.TP
+.B pmemblk
+Read and write through the NVML libpmemblk interface.

 .RE
 .P
 .RE
 .RE
 .P
 .RE


@@ -1130,7 +1151,7 @@ Allocation method for I/O unit buffer.  Allowed values are:
 .RS
 .TP
 .B malloc
 .RS
 .TP
 .B malloc

-Allocate memory with \fBmalloc\fR\|(3).
+Allocate memory with \fBmalloc\fR\|(3). Default memory type.

 .TP
 .B shm
 Use shared memory buffers allocated through \fBshmget\fR\|(2).
 .TP
 .B shm
 Use shared memory buffers allocated through \fBshmget\fR\|(2).


@@ -1180,12 +1201,14 @@ Terminate all jobs if one job finishes in error.  Default: wait for each job
 to finish.
 .TP
 .BI bwavgtime \fR=\fPint
 to finish.
 .TP
 .BI bwavgtime \fR=\fPint

-Average bandwidth calculations over the given time in milliseconds.  Default:
-500ms.
+Average bandwidth calculations over the given time in milliseconds. If the job
+also does bandwidth logging through \fBwrite_bw_log\fR, then the minimum of
+this option and \fBlog_avg_msec\fR will be used.  Default: 500ms.

 .TP
 .BI iopsavgtime \fR=\fPint
 .TP
 .BI iopsavgtime \fR=\fPint

-Average IOPS calculations over the given time in milliseconds.  Default:
-500ms.
+Average IOPS calculations over the given time in milliseconds. If the job
+also does IOPS logging through \fBwrite_iops_log\fR, then the minimum of
+this option and \fBlog_avg_msec\fR will be used.  Default: 500ms.

 .TP
 .BI create_serialize \fR=\fPbool
 If true, serialize file creation for the jobs.  Default: true.
 .TP
 .BI create_serialize \fR=\fPbool
 If true, serialize file creation for the jobs.  Default: true.


@@ -1688,7 +1711,7 @@ 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).
 .TP
 enabled when polling for a minimum of 0 events (eg when
 iodepth_batch_complete=0).
 .TP

-.BI (psyncv2)hipri
+.BI (pvsync2)hipri

 Set RWF_HIPRI on IO, indicating to the kernel that it's of
 higher priority than normal.
 .TP
 Set RWF_HIPRI on IO, indicating to the kernel that it's of
 higher priority than normal.
 .TP


@@ -1784,8 +1807,8 @@ Specifies the name of the Ceph pool containing the RBD.
 .TP
 .BI (rbd)clientname \fR=\fPstr
 Specifies the username (without the 'client.' prefix) used to access the Ceph
 .TP
 .BI (rbd)clientname \fR=\fPstr
 Specifies the username (without the 'client.' prefix) used to access the Ceph

-cluster. If the clustername is specified, the clientname should be full type.id
-string. If no type. prefix, fio will add 'client.' by default for you.
+cluster. If the clustername is specified, the clientname shall be the full
+type.id string. If no type. prefix is given, fio will add 'client.' by default.

 .TP
 .BI (mtd)skipbad \fR=\fPbool
 Skip operations against known bad blocks.
 .TP
 .BI (mtd)skipbad \fR=\fPbool
 Skip operations against known bad blocks.


@@ -2063,7 +2086,7 @@ This format is not supported in Fio versions => 1.20-rc3.
 .B Trace file format v2
 .RS
 The second version of the trace file format was added in Fio version 1.17.
 .B Trace file format v2
 .RS
 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
+It allows one 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:
 possible file actions.
 
 The first line of the trace file has to be: