X-Git-Url: https://git.kernel.dk/?p=fio.git;a=blobdiff_plain;f=README;h=2eec1a2a92d8a92b2296b99c381713c037423144;hp=89e32c8c21d9f6d71068aa85e8ef10569f4e5e95;hb=a9523c6f4a43e4bbf942ee49068fe4f052c6991d;hpb=5f42100411888488beb3e17637dea57994f58153 diff --git a/README b/README index 89e32c8c..2eec1a2a 100644 --- a/README +++ b/README @@ -23,36 +23,74 @@ well. You can download them here: http://brick.kernel.dk/snaps/ -Pascal Bleser 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 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 +Red Hat, CentOS & Co: Dag Wieërs has RPMs for Red Hat related distros, find them here: - 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'. +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 has fio packages for Windows at +http://www.bluestop.org/fio . + Mailing list ------------ There's a mailing list associated with fio. It's meant for general -discussion, bug reporting, questions - basically anything that has to -do with fio. An automated mail detailing recent commits is automatically -sent to the list at most daily. The list address is fio-devel@kernel.dk, -subscribe by sending an empty email to fio-devel+subscribe@kernel.dk. +discussion, bug reporting, questions, and development - basically anything +that has to do with fio. An automated mail detailing recent commits is +automatically sent to the list at most daily. The list address is +fio@vger.kernel.org, subscribe by sending an email to +majordomo@vger.kernel.org with + +subscribe fio + +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/ 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 + +Same goes for AIX: -$ gmake -f Makefile.Freebsd && gmake -f Makefile.FreeBSD install +$ 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 @@ -91,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) + --warnings-fatal Fio parser warnings are fatal Any parameters following the options will be assumed to be job files, @@ -98,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. -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 @@ -118,6 +157,9 @@ options in fio. Currently the options are: 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 + 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 @@ -132,9 +174,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 -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 -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 @@ -169,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 - 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 @@ -191,8 +236,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 - 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. @@ -218,6 +263,7 @@ The job file parameters are: verify=x If 'x' == md5, use md5 for verifies. If 'x' == crc32, use crc32 for verifies. md5 is 'safer', but crc32 is a lot faster. Only makes sense for writing to a file. + For other types of checksumming, see HOWTO. stonewall Wait for preceeding jobs to end before running. numjobs=x Create 'x' similar entries for this job thread Use pthreads instead of forked jobs @@ -234,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 - 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 @@ -249,6 +297,50 @@ The job file parameters are: cpuchunks=x Split burn cycles into pieces of x usecs. + +Platforms +--------- + +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 +disk utility statistics and (I think) huge page support, support for that +does exist in FreeBSD/Solaris. + +Fio uses pthread mutexes for signalling and locking and FreeBSD does not +support process shared pthread mutexes. As a result, only threads are +supported on FreeBSD. This could be fixed with sysv ipc locking or +other locking alternatives. + +Other *BSD platforms are untested, but fio should work there almost out +of the box. Since I don't do test runs or even compiles on those platforms, +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. + +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 ------