Add platform section to README

[fio.git] / README

diff --git a/README b/README
index dd3bab11a4937e68016fb0b934b9987d2b2eadc0..7a49dda519b170bdd3c6ed881a96f482ac8c52c9 100644 (file)
--- a/README
+++ b/README
@@ -259,6 +259,33 @@ The job file parameters are:
        cpuchunks=x     Split burn cycles into pieces of x usecs.
 
 
+
+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).
+
+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.
+
+
+
 Author
 ------