projects / fio.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
First snapshot of FIO for Windows
[fio.git] / README
diff --git a/README b/README
index 7a49dda519b170bdd3c6ed881a96f482ac8c52c9..f1ee9aa7676ebf08e0060d94fd34f7acd1746698 100644 (file)
--- a/README
+++ b/README
@@ -23,18 +23,37 @@ 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'.
+
 
 Mailing list
 ------------
 
 Mailing list
 ------------
@@ -48,8 +67,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/
 
@@ -62,6 +84,10 @@ specify the FreeBSD 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
 future if I opt for an autoconf type setup.
 Likewise with OpenSolaris, use the Makefile.solaris to compile there.
 The OpenSolaris make should work fine. This might change in the
 future if I opt for an autoconf type setup.
@@ -127,6 +153,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
@@ -141,9 +169,11 @@ 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
 
 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
+in size, and can grow to 128 pools. If running large jobs with randommap
 enabled it can run out of memory, in which case the --alloc-size switch
 enabled it can run out of memory, in which case the --alloc-size switch
-is handy for starting with a larger pool size.
+is handy for starting with a larger pool size. The backing store is
+files in /tmp. Fio cleans up after itself, while it is running you
+may see .fio_smalloc.* files in /tmp.
 
 
 Job file
 
 
 Job file
@@ -178,7 +208,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
@@ -200,8 +231,8 @@ The job file parameters are:
                        also include k/m postfix.
        direct=x        1 for direct IO, 0 for buffered IO
        thinktime=x     "Think" x usec after each io
                        also include k/m postfix.
        direct=x        1 for direct IO, 0 for buffered IO
        thinktime=x     "Think" x usec after each io
-       rate=x          Throttle rate to x KiB/sec
-       ratemin=x       Quit if rate of x KiB/sec can't be met
+       rate=x          Throttle rate to x KB/sec
+       ratemin=x       Quit if rate of x KB/sec can't be met
        ratecycle=x     ratemin averaged over x msecs
        cpumask=x       Only allow job to run on CPUs defined by mask.
        cpus_allowed=x  Like 'cpumask', but allow text setting of CPU affinity.
        ratecycle=x     ratemin averaged over x msecs
        cpumask=x       Only allow job to run on CPUs defined by mask.
        cpus_allowed=x  Like 'cpumask', but allow text setting of CPU affinity.
@@ -263,10 +294,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, 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
@@ -284,6 +315,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