X-Git-Url: https://git.kernel.dk/?p=fio.git;a=blobdiff_plain;f=README;h=f67a02be5edfdea7c4a9fcf29bbc2751dc09ad2b;hp=37287dd4018f5b3676d574cb7aa073f509d3a6aa;hb=1ec3d69b0ed8cc7a3eba0192685034d5442989e4;hpb=78e7b3e7765a984742cf809c963499b92eca9c8a diff --git a/README b/README index 37287dd4..f67a02be 100644 --- a/README +++ b/README @@ -40,22 +40,38 @@ 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, eg: +specify the FreeBSD Makefile with -f and use gmake (not make), eg: -$ make -f Makefile.Freebsd && make -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. -This might change in the future if I opt for an autoconf type setup. +The OpenSolaris make should work fine. This might change in the +future if I opt for an autoconf type setup. If your compile fails with an error like this: @@ -117,6 +133,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 @@ -131,9 +150,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 @@ -190,8 +211,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. @@ -217,6 +238,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 @@ -248,6 +270,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, 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 ------