X-Git-Url: https://git.kernel.dk/?a=blobdiff_plain;f=HOWTO;h=3b1eeb0606832a7808b43c309673079b3303d11f;hb=03e20d687566753b90383571e5e152c5142bdffd;hp=f338e7d4214c7f0356522720588499354d8da04e;hpb=c8dcfd7edcdafc5108ed3d39db6093ae7d209040;p=fio.git

diff --git a/HOWTO b/HOWTO
index f338e7d4..3b1eeb06 100644
--- a/HOWTO
+++ b/HOWTO
@@ -271,12 +271,14 @@ filename=str	Fio normally makes up a filename based on the job name,
 		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
 		as the two working files, you would use
-		filename=/dev/sda:/dev/sdb. If the wanted filename does need to
-		include a colon, then escape that with a '\' character. For
-		instance, if the filename is "/dev/dsk/foo@3,0:c", then you would
-		use filename="/dev/dsk/foo@3,0\:c". '-' is a reserved name,
-		meaning stdin or stdout. Which of the two depends on the read/write
-		direction set.
+		filename=/dev/sda:/dev/sdb. On Windows, disk devices are accessed
+		as /dev/sda for the first device (i.e. \Device\HardDisk0\Partition0,
+		/dev/sda1 for the first partition on the first disk etc.  If the 
+		wanted filename does need to include a colon, then escape that with 
+		a '\' character. For instance, if the filename is 
+		"/dev/dsk/foo@3,0:c", then you would use filename="/dev/dsk/foo@3,0\:c". 
+		'-' is a reserved name, meaning stdin or stdout. Which of the 
+		two depends on the read/write direction set.
 
 opendir=str	Tell fio to recursively add any file it can find in this
 		directory and down the file system tree.
@@ -492,6 +494,8 @@ ioengine=str	Defines how the job issues io to the file. The following
 
 			solarisaio Solaris native asynchronous io.
 
+			windowsaio Windows native asynchronous io.
+
 			mmap	File is memory mapped and data copied
 				to/from using memcpy(3).
 
@@ -549,7 +553,14 @@ ioengine=str	Defines how the job issues io to the file. The following
 iodepth=int	This defines how many io units to keep in flight against
 		the file. The default is 1 for each file defined in this
 		job, can be overridden with a larger value for higher
-		concurrency.
+		concurrency. Note that increasing iodepth beyond 1 will not
+		affect synchronous ioengines (except for small degress when
+		verify_async is in use). Even async engines my impose OS
+		restrictions causing the desired depth not to be achieved.
+		This may happen on Linux when using libaio and not setting
+		direct=1, since buffered IO is not async on that OS. Keep an
+		eye on the IO depth distribution in the fio output to verify
+		that the achieved depth is as expected. Default: 1.
 
 iodepth_batch_submit=int
 iodepth_batch=int This defines how many pieces of IO to submit at once.
@@ -935,13 +946,18 @@ verify_backlog=int	Fio will normally verify the written contents of a
 		associated with an IO block in memory, so for large
 		verify workloads, quite a bit of memory would be used up
 		holding this meta data. If this option is enabled, fio
+		will write only N blocks before verifying these blocks.
+
 		will verify the previously written blocks before continuing
 		to write new ones.
 
 verify_backlog_batch=int	Control how many blocks fio will verify
 		if verify_backlog is set. If not set, will default to
 		the value of verify_backlog (meaning the entire queue
-		is read back and verified).
+		is read back and verified).  If verify_backlog_batch is
+		less than verify_backlog then not all blocks will be verified,
+		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
 		starting this one. Can be used to insert serialization
@@ -1256,8 +1272,10 @@ For scripted usage where you typically want to generate tables or graphs
 of the results, fio can output the results in a semicolon separated format.
 The format is one long line of values, such as:
 
-2; client1;0;0;1906777;1090804;1790;0;0;0.000000;0.000000;0;0;0.000000;0.000000;929380;1152890;25.510151%;1078276.333333;128948.113404;0;0;0;0;0;0.000000;0.000000;0;0;0.000000;0.000000;0;0;0.000000%;0.000000;0.000000;100.000000%;0.000000%;324;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%;0.0%;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%
-;0.0%;0.0%;0.0%;0.0%;0.0%
+2;card0;0;0;7139336;121836;60004;1;10109;27.932460;116.933948;220;126861;3495.446807;1085.368601;226;126864;3523.635629;1089.012448;24063;99944;50.275485%;59818.274627;5540.657370;7155060;122104;60004;1;8338;29.086342;117.839068;388;128077;5032.488518;1234.785715;391;128085;5061.839412;1236.909129;23436;100928;50.287926%;59964.832030;5644.844189;14.595833%;19.394167%;123706;0;7313;0.1%;0.1%;0.1%;0.1%;0.1%;0.1%;100.0%;0.00%;0.00%;0.00%;0.00%;0.00%;0.00%;0.01%;0.02%;0.05%;0.16%;6.04%;40.40%;52.68%;0.64%;0.01%;0.00%;0.01%;0.00%;0.00%;0.00%;0.00%;0.00%
+A description of this job goes here.
+
+The job description (if provided) follows on a second line.
 
 To enable terse output, use the --minimal command line option. The first
 value is the version of the terse output format. If the output has to
@@ -1281,6 +1299,8 @@ Split up, the format is as follows:
 		Bw: 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: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000, >=2000
-	Text description
-
+	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
+	Additional Info (dependant on continue_on_error, default off): total # errors, first error code 
+	
+	Additional Info (dependant on description being set): Text description