Mark do_verify and verify_fatal as booleans

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index 2797a58c3da2bbe6c240f039753ff52b0bb76265..3bee1a2d70a42622f70f7a00c422246e4eaa2d6c 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -170,7 +170,8 @@ 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.
 a string. The following types are used:
 
 str    String. This is a sequence of alpha characters.

-int    Integer. A whole number value, can be negative.
+int    Integer. A whole number value, can be negative. If prefixed with
+       0x, the integer is assumed to be of base 16 (hexidecimal).

 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,
 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,


@@ -568,6 +569,9 @@ loops=int   Run the specified number of iterations of this job. Used
                to repeat the same workload a given number of times. Defaults
                to 1.
 
                to repeat the same workload a given number of times. Defaults
                to 1.
 

+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:
 
 verify=str     If writing to a file, fio can verify the file contents
                after each iteration of the job. The allowed values are:
 


@@ -587,6 +591,14 @@ verify=str If writing to a file, fio can verify the file contents
                        crc7    Use a crc7 sum of the data area and store
                                it in the header of each block.
 
                        crc7    Use a crc7 sum of the data area and store
                                it in the header of each block.
 

+                       sha512  Use sha512 as the checksum function.
+
+                       sha256  Use sha256 as the checksum function.
+
+                       meta    Write extra information about each io
+                               (timestamp, block number etc.). The block
+                               number is verified.
+

                        null    Only pretend to verify. Useful for testing
                                internals with ioengine=null, not for much
                                else.
                        null    Only pretend to verify. Useful for testing
                                internals with ioengine=null, not for much
                                else.


@@ -603,10 +615,27 @@ verifysort=bool   If set, fio will sort written verify blocks when it deems
                fast IO where the red-black tree sorting CPU time becomes
                significant.
 
                fast IO where the red-black tree sorting CPU time becomes
                significant.
 

-header_interval=siint  Write the verification header at a finer granularity
+verify_offset=siint    Swap the verification header with data somewhere else
+                       in the block before writing. Its swapped back before
+                       verifying.
+
+verify_interval=siint  Write the verification header at a finer granularity

                        than the blocksize. It will be written for chunks the
                        size of header_interval. blocksize should divide this
                        evenly.
                        than the blocksize. It will be written for chunks the
                        size of header_interval. blocksize should divide this
                        evenly.

+
+verify_pattern=int     If set, fio will fill the io buffers with this
+               pattern. Fio defaults to filling with totally random
+               bytes, but sometimes it's interesting to fill with a known
+               pattern for io verification purposes. Depending on the
+               width of the pattern, fio will fill 1/2/3/4 bytes of the
+               buffer at the time. The verify_pattern cannot be larger than
+               a 32-bit quantity.
+
+verify_fatal=bool      Normally fio will keep checking the entire contents
+               before quitting on a block verification failure. If this
+               option is set, fio will exit the job on the first observed
+               failure.

                
 stonewall      Wait for preceeding jobs in the job file to exit, before
                starting this one. Can be used to insert serialization
                
 stonewall      Wait for preceeding jobs in the job file to exit, before
                starting this one. Can be used to insert serialization