Building
--------
-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:
+Just type 'make' and 'make 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.
+Note that GNU make is required. On BSD it's available from devel/gmake;
+on Solaris it's in the SUNWgmake package. On platforms where GNU make
+isn't the default, type 'gmake' instead of 'make'.
If your compile fails with an error like this:
based distros, it's typically called libaio-devel.
+Windows
+-------
+
+On Windows Cygwin (http://www.cygwin.com) is required with at least
+devel/gcc4 and devel/make installed in order to build fio, and
+admin/cygrunsrv to run it. You can also install devel/git to fetch/update
+the source files. To create an MSI installer package, install WiX 3.6 from
+http://wix.sourceforge.net/releases/ and run dobuild.cmd from the
+os/windows directory.
+
+Before running fio you'll need to have a copy of cygserver running. Run
+"/usr/bin/cygserver-config" from an elevated Cygwin shell (i.e. launch the
+Cygwin shell under the Administrator account) to configure it. Once
+configured, run "net start cygserver" to start it, or type
+"/usr/sbin/cygserver &" in the Cygwin shell to start a local copy.
+
+If fio exits with the message "Bad system call" it normally means that
+Cygserver isn't running.
+
+
Command line
------------
$ fio
- --debug Enable some debugging options (see below)
- --output Write output to file
- --timeout Runtime in seconds
- --latency-log Generate per-job latency logs
- --bandwidth-log Generate per-job bandwidth logs
- --minimal Minimal (terse) output
- --version Print version info and exit
- --help Print this page
+ --debug Enable some debugging options (see below)
+ --output Write output to file
+ --timeout Runtime in seconds
+ --latency-log Generate per-job latency logs
+ --bandwidth-log Generate per-job bandwidth logs
+ --minimal Minimal (terse) output
+ --version Print version info and exit
+ --help Print this page
--cmdhelp=cmd Print command help, "all" for all of them
- --showcmd Turn a job file into command line options
- --readonly Turn on safety read-only checks, preventing writes
- --eta=when When ETA estimate should be printed
- May be "always", "never" or "auto"
+ --showcmd Turn a job file into command line options
+ --readonly Turn on safety read-only checks, preventing writes
+ --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)
+ --warnings-fatal Fio parser warnings are fatal
Any parameters following the options will be assumed to be job files,
process Dump info related to processes
file Dump info related to file actions
- io Dump info related to IO queuing
- mem Dump info related to memory allocations
+ io Dump info related to IO queuing
+ mem Dump info related to memory allocations
blktrace Dump info related to blktrace setup
verify Dump info related to IO verification
- all Enable all debug options
+ 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
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