server: properly reset state_number in fio_reset_state()
[fio.git] / HOWTO
diff --git a/HOWTO b/HOWTO
index ec7005fe5b44e1c70c2ff6e2195849599a24e0ca..56118140621803d434264910e0329e196d7db2a4 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -780,6 +780,9 @@ 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 seperation.
 
+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
                of milliseconds.
 
@@ -799,6 +802,24 @@ cpus_allowed=str Controls the same options as cpumask, but it allows a text
                allows a range of CPUs. Say you wanted a binding to CPUs
                1, 5, and 8-15, you would set cpus_allowed=1,5,8-15.
 
+numa_cpu_nodes=str Set this job running on spcified NUMA nodes' CPUs. The
+               arguments allow comma delimited list of cpu numbers,
+               A-B ranges, or 'all'. Note, to enable numa options support,
+               export the following environment variables,
+                       export EXTFLAGS+=" -DFIO_HAVE_LIBNUMA "
+                       export EXTLIBS+=" -lnuma "
+
+numa_mem_policy=str Set this job's memory policy and corresponding NUMA
+               nodes. Format of the argements:
+                       <mode>[:<nodelist>]
+               `mode' is one of the following memory policy:
+                       default, prefer, bind, interleave, local
+               For `default' and `local' memory policy, no node is
+               needed to be specified.
+               For `prefer', only one node is allowed.
+               For `bind' and `interleave', it allow comma delimited
+               list of numbers, A-B ranges, or 'all'.
+
 startdelay=time        Start this job the specified number of seconds after fio
                has started. Only useful if the job file contains several
                jobs, and you want to delay starting some jobs to a certain
@@ -1053,22 +1074,22 @@ wait_for_previous Wait for preceeding jobs in the job file to exit, before
                points in the job file. A stone wall also implies starting
                a new reporting group.
 
-new_group      Start a new reporting group. If this option isn't given,
-               jobs in a file will be part of the same reporting group
-               unless separated by a stone wall (or if it's a group
-               by itself, with the numjobs option).
+new_group      Start a new reporting group. See: group_reporting.
 
 numjobs=int    Create the specified number of clones of this job. May be
                used to setup a larger number of threads/processes doing
-               the same thing. We regard that grouping of jobs as a
-               specific group.
-
-group_reporting        If 'numjobs' is set, it may be interesting to display
-               statistics for the group as a whole instead of for each
-               individual job. This is especially true of 'numjobs' is
-               large, looking at individual thread/process output quickly
-               becomes unwieldy. If 'group_reporting' is specified, fio
-               will show the final report per-group instead of per-job.
+               the same thing. Each thread is reported separately; to see
+               statistics for all clones as a whole, use group_reporting in
+               conjunction with new_group.
+
+group_reporting        It may sometimes be interesting to display statistics for
+               groups of jobs as a whole instead of for each individual job.
+               This is especially true if 'numjobs' is used; looking at
+               individual thread/process output quickly becomes unwieldy.
+               To see the final report per-group instead of per-job, use
+               'group_reporting'. Jobs in a file will be part of the same
+               reporting group, unless if separated by a stonewall, or by
+               using 'new_group'.
 
 thread         fio defaults to forking jobs, however if this option is
                given, fio will use pthread_create(3) to create threads
@@ -1165,12 +1186,6 @@ exec_postrun=str After the job completes, issue the command specified
 ioscheduler=str        Attempt to switch the device hosting the file to the specified
                io scheduler before running.
 
-cpuload=int    If the job is a CPU cycle eater, attempt to use the specified
-               percentage of CPU cycles.
-
-cpuchunks=int  If the job is a CPU cycle eater, split the load into
-               cycles of the given time. In microseconds.
-
 disk_util=bool Generate disk utilization statistics, if the platform
                supports it. Defaults to on.
 
@@ -1248,6 +1263,19 @@ continue_on_error=str    Normally fio will exit the job on the first observed
 
                        1               Backward-compatible alias for 'all'.
 
+ignore_error=str Sometimes you want to ignore some errors during test
+                in that case you can specify error list for each error type.
+                ignore_error=READ_ERR_LIST,WRITE_ERR_LIST,VERIFY_ERR_LIST
+                errors for given error type is separated with ':'. Error
+                may be symbol ('ENOSPC', 'ENOMEM') or integer.
+                Example:
+                       ignore_error=EAGAIN,ENOSPC:122
+                This option will ignore EAGAIN from READ, and ENOSPC and 
+                122(EDQUOT) from WRITE. 
+
+error_dump=bool If set dump every error even if it is non fatal, true
+               by default. If disabled only fatal error will be dumped
+                                
 cgroup=str     Add job to this control group. If it doesn't exist, it will
                be created. The system must have a mounted cgroup blkio
                mount point for this to work. If your system doesn't have it
@@ -1301,6 +1329,11 @@ that defines them is selected.
                enabled when polling for a minimum of 0 events (eg when
                iodepth_batch_complete=0).
 
+[cpu] cpuload=int Attempt to use the specified percentage of CPU cycles.
+
+[cpu] cpuchunks=int Split the load into cycles of the given time. In
+               microseconds.
+
 [netsplice] hostname=str
 [net] hostname=str The host name or IP address to use for TCP or UDP based IO.
                If the job is a TCP listener or UDP reader, the hostname is not
@@ -1315,7 +1348,7 @@ that defines them is selected.
 [net] proto=str        The network protocol to use. Accepted values are:
 
                        tcp     Transmission control protocol
-                       udp     Unreliable datagram protocol
+                       udp     User datagram protocol
                        unix    UNIX domain socket
 
                When the protocol is TCP or UDP, the port must also be given,
@@ -1351,7 +1384,7 @@ Idle      Run
 ----    ---
 P              Thread setup, but not started.
 C              Thread created.
-I              Thread initialized, waiting.
+I              Thread initialized, waiting or generating necessary data.
        p       Thread running pre-reading file(s).
        R       Running, doing sequential reads.
        r       Running, doing random reads.