Missed fls() -> __fls() conversion

[fio.git] / README

diff --git a/README b/README
index ef614a28f250bc424c0b3c36f1e4ba95a003568c..059fead22a1ee530a17b15cff7b60bab8aefa2ba 100644 (file)
--- a/README
+++ b/README
@@ -57,6 +57,19 @@ $ make -f Makefile.Freebsd && make -f Makefile.FreeBSD install
 Likewise with OpenSolaris, use the Makefile.solaris to compile there.
 This might change in the future if I opt for an autoconf type setup.
 
+If your compile fails with an error like this:
+
+    CC gettime.o
+In file included from fio.h:23,
+                 from gettime.c:8:
+os/os.h:15:20: error: libaio.h: No such file or directory
+In file included from gettime.c:8:
+fio.h:119: error: field 'iocb' has incomplete type
+make: *** [gettime.o] Error 1
+
+Check that you have the libaio development package installed. On RPM
+based distros, it's typically called libaio-devel.
+
 
 Command line
 ------------
@@ -76,6 +89,7 @@ $ fio
        --eta=when      When ETA estimate should be printed
                        May be "always", "never" or "auto"
        --section=name  Only run specified section in job file
+       --alloc-size=kb Set smalloc pool to this size in kb (def 1024)
 
 
 Any parameters following the options will be assumed to be job files,
@@ -101,6 +115,8 @@ options in fio. Currently the options are:
        all             Enable all debug options
        random          Dump info related to random offset generation
        parse           Dump info related to option matching and parsing
+       diskutil        Dump info related to disk utilization updates
+       job:x           Dump info only related to job number x
        ? or help       Show available debug options.
 
 You can specify as many as you want, eg --debug=file,mem will enable
@@ -113,6 +129,12 @@ only by giving it a --section=heavy command line option. The section
 option only applies to job sections, the reserved 'global' section is
 always parsed and taken into account.
 
+Fio has an internal allocator for shared memory called smalloc. It
+allocates shared structures from this pool. The pool defaults to 1024k
+in size, and can grow to 32 pools. If running large jobs with randommap
+enabled it can run out of memory, in which case the --alloc-size switch
+is handy for starting with a larger pool size.
+
 
 Job file
 --------
@@ -149,8 +171,8 @@ The job file parameters are:
                        psync for regular pread/pwrite io, vsync for regular
                        readv/writev (with queuing emulation) mmap for mmap'ed
                        io, syslet-rw for syslet driven read/write, splice for
-                       using splice/vmsplice, sgio for direct SG_IO io, net
-                       for network io, or cpuio for a cycler burner load. sgio
+                       using splice/vmsplice, sg for direct SG_IO io, net
+                       for network io, or cpuio for a cycler burner load. sg
                        only works on Linux on SCSI (or SCSI-like devices, such
                        as usb-storage or sata/libata driven) devices. Fio also
                        has a null io engine, which is mainly used for testing