projects / fio.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Remember to initialize return value in fixup_options()
[fio.git] / README
diff --git a/README b/README
index d5235de39a6ff7dfa32b9e055cbaac5974e7fc2a..2eec1a2a92d8a92b2296b99c381713c037423144 100644 (file)
--- a/README
+++ b/README
@@ -23,18 +23,41 @@ well. You can download them here:
 
 http://brick.kernel.dk/snaps/
 
 
 http://brick.kernel.dk/snaps/
 
-Pascal Bleser <guru@unixtech.be> has fio RPMs in his repository for
-SUSE variants, you can find them here:
 
 
+Binary packages
+---------------
+
+Debian:
+Starting with Debian "Squeeze", fio packages are part of the official
+Debian repository. http://packages.debian.org/search?keywords=fio
+
+Ubuntu:
+Starting with Ubuntu 10.04 LTS (aka "Lucid Lynx"), fio packages are part
+of the Ubuntu "universe" repository.
+http://packages.ubuntu.com/search?keywords=fio
+
+SUSE:
+Pascal Bleser <guru@unixtech.be> has fio RPMs in his repository for SUSE
+variants, you can find them here:
 http://linux01.gwdg.de/~pbleser/rpm-navigation.php?cat=System/fio
 
 http://linux01.gwdg.de/~pbleser/rpm-navigation.php?cat=System/fio
 
+Red Hat, CentOS & Co:
 Dag Wieërs has RPMs for Red Hat related distros, find them here:
 Dag Wieërs has RPMs for Red Hat related distros, find them here:
-
 http://dag.wieers.com/rpm/packages/fio/
 
 http://dag.wieers.com/rpm/packages/fio/
 
+Mandriva:
 Mandriva has integrated fio into their package repository, so installing
 on that distro should be as easy as typing 'urpmi fio'.
 
 Mandriva has integrated fio into their package repository, so installing
 on that distro should be as easy as typing 'urpmi fio'.
 
+Solaris:
+Packages for Solaris are available from OpenCSW. Install their pkgutil
+tool (http://www.opencsw.org/get-it/pkgutil/) and then install fio via
+'pkgutil -i fio'.
+
+Windows:
+Bruce Cran <bruce@cran.org.uk> has fio packages for Windows at
+http://www.bluestop.org/fio .
+
 
 Mailing list
 ------------
 
 Mailing list
 ------------
@@ -48,8 +71,11 @@ majordomo@vger.kernel.org with
 
 subscribe fio
 
 
 subscribe fio
 
-in the body of the email. There is no archive for the new list yet,
-archives for the old list can be found here:
+in the body of the email. Archives can be found here:
+
+http://www.spinics.net/lists/fio/
+
+and archives for the old list can be found here:
 
 http://maillist.kernel.dk/fio-devel/
 
 
 http://maillist.kernel.dk/fio-devel/
 
@@ -57,10 +83,14 @@ http://maillist.kernel.dk/fio-devel/
 Building
 --------
 
 Building
 --------
 
-Just type 'make' and 'make install'. If on FreeBSD, for now you have to
-specify the FreeBSD Makefile with -f and use gmake (not make), eg:
+Just type 'make' and 'make install'. If on BSD, for now you have to
+specify the BSD Makefile with -f and use gmake (not make), eg:
 
 
-$ gmake -f Makefile.Freebsd && gmake -f Makefile.FreeBSD install
+$ gmake -f Makefile.FreeBSD && gmake -f Makefile.FreeBSD install
+
+Same goes for AIX:
+
+$ gmake -f Makefile.aix && gmake -f Makefile.aix install
 
 Likewise with OpenSolaris, use the Makefile.solaris to compile there.
 The OpenSolaris make should work fine. This might change in the
 
 Likewise with OpenSolaris, use the Makefile.solaris to compile there.
 The OpenSolaris make should work fine. This might change in the
@@ -99,6 +129,7 @@ $ fio
                        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)
                        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)
+       --warnings-fatal Fio parser warnings are fatal
 
 
 Any parameters following the options will be assumed to be job files,
 
 
 Any parameters following the options will be assumed to be job files,
@@ -106,7 +137,7 @@ unless they match a job file parameter. You can add as many as you want,
 each job file will be regarded as a separate group and fio will stonewall
 its execution.
 
 each job file will be regarded as a separate group and fio will stonewall
 its execution.
 
-The --readonly switch is an extra safety guard to prevent accidentically
+The --readonly switch is an extra safety guard to prevent accidentally
 turning on a write setting when that is not desired. Fio will only write
 if rw=write/randwrite/rw/randrw is given, but this extra safety net can
 be used as an extra precaution. It will also enable a write check in the
 turning on a write setting when that is not desired. Fio will only write
 if rw=write/randwrite/rw/randrw is given, but this extra safety net can
 be used as an extra precaution. It will also enable a write check in the
@@ -127,6 +158,8 @@ options in fio. Currently the options are:
        diskutil        Dump info related to disk utilization updates
        job:x           Dump info only related to job number x
        mutex           Dump info only related to mutex up/down ops
        diskutil        Dump info related to disk utilization updates
        job:x           Dump info only related to job number x
        mutex           Dump info only related to mutex up/down ops
+       profile         Dump info related to profile extensions
+       time            Dump info related to internal time keeping
        ? or help       Show available debug options.
 
 You can specify as many as you want, eg --debug=file,mem will enable
        ? or help       Show available debug options.
 
 You can specify as many as you want, eg --debug=file,mem will enable
@@ -180,7 +213,8 @@ The job file parameters are:
        size=x          Set file size to x bytes (x string can include k/m/g)
        ioengine=x      'x' may be: aio/libaio/linuxaio for Linux aio,
                        posixaio for POSIX aio, solarisaio for Solaris
        size=x          Set file size to x bytes (x string can include k/m/g)
        ioengine=x      'x' may be: aio/libaio/linuxaio for Linux aio,
                        posixaio for POSIX aio, solarisaio for Solaris
-                       native async IO, sync for regular read/write io,
+                       native async IO, windowsaio for Windows native async IO,
+                       sync for regular read/write io,
                        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
                        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
@@ -246,7 +280,9 @@ The job file parameters are:
                        and length entries being in bytes.
        write_iolog=x   Write an iolog to file 'x' in the same format as iolog.
                        The iolog options are exclusive, if both given the
                        and length entries being in bytes.
        write_iolog=x   Write an iolog to file 'x' in the same format as iolog.
                        The iolog options are exclusive, if both given the
-                       read iolog will be performed.
+                       read iolog will be performed.  Specify a separate file
+                       for each job, otherwise the iologs will be interspersed
+                       and the file may be corrupt.
        write_bw_log    Write a bandwidth log.
        write_lat_log   Write a latency log.
        lockmem=x       Lock down x amount of memory on the machine, to
        write_bw_log    Write a bandwidth log.
        write_lat_log   Write a latency log.
        lockmem=x       Lock down x amount of memory on the machine, to
@@ -265,10 +301,10 @@ The job file parameters are:
 Platforms
 ---------
 
 Platforms
 ---------
 
-Fio works on (at least) Linux, Solaris, and FreeBSD. Some features and/or
-options may only be available on some of the platforms, typically because
-those features only apply to that platform (like the solarisaio engine, or
-the splice engine on Linux).
+Fio works on (at least) Linux, Solaris, AIX, OSX, NetBSD, Windows and FreeBSD.
+Some features and/or options may only be available on some of the platforms,
+typically because those features only apply to that platform (like the
+solarisaio engine, or the splice engine on Linux).
 
 Some features are not available on FreeBSD/Solaris even if they could be
 implemented, I'd be happy to take patches for that. An example of that is
 
 Some features are not available on FreeBSD/Solaris even if they could be
 implemented, I'd be happy to take patches for that. An example of that is
@@ -286,6 +322,23 @@ your mileage may vary. Sending me patches for other platforms is greatly
 appreciated. There's a lot of value in having the same test/benchmark tool
 available on all platforms.
 
 appreciated. There's a lot of value in having the same test/benchmark tool
 available on all platforms.
 
+Note that POSIX aio is not enabled by default on AIX. If you get messages like:
+
+    Symbol resolution failed for /usr/lib/libc.a(posix_aio.o) because:
+        Symbol _posix_kaio_rdwr (number 2) is not exported from dependent module /unix.
+
+you need to enable POSIX aio. Run the following commands as root:
+
+    # lsdev -C -l posix_aio0
+        posix_aio0 Defined  Posix Asynchronous I/O
+    # cfgmgr -l posix_aio0
+    # lsdev -C -l posix_aio0
+        posix_aio0 Available  Posix Asynchronous I/O
+
+POSIX aio should work now. To make the change permanent:
+
+    # chdev -l posix_aio0 -P -a autoconfig='available'
+        posix_aio0 changed
 
 
 Author
 
 
 Author
fio - Flexible IO Tester