From: Jens Axboe <axboe@suse.de>
Date: Tue, 4 Oct 2005 12:43:56 +0000 (+0200)
Subject: [PATCH] Add README and README.fio
X-Git-Url: https://git.kernel.dk/?a=commitdiff_plain;h=e709787caaf1222c4871c19ecbffa8532c6fda9e;p=disktools.git

[PATCH] Add README and README.fio
---

diff --git a/README b/README
new file mode 100644
index 0000000..35cfe18
--- /dev/null
+++ b/README
@@ -0,0 +1,10 @@
+disktools
+---------
+
+A collection of various disk/io related tools that I have written
+to test various performance aspects of the io system.
+
+If nothing else is mentioned, the license for the programs are GPL v2.
+
+Jens Axboe
+
diff --git a/README.fio b/README.fio
new file mode 100644
index 0000000..2edc567
--- /dev/null
+++ b/README.fio
@@ -0,0 +1,49 @@
+fio
+---
+
+fio is a tool that will spawn a number of thread doing a particular
+type of io action as specified by the user. fio takes a number of
+global parameters, each inherited by the thread unless otherwise
+parameters given to them overriding that setting is given.
+
+Options
+-------
+
+$ fio
+	-s IO is sequential
+	-b block size in bytes for each io
+	-t <sec> Runtime in seconds
+	-w Write statistics
+	-r For random io, sequence must be repeatable
+	-o <on> Use direct IO is 1, buffered if 0
+
+	<jobs>
+
+The <jobs> format is as follows:
+
+	rw=0/1		0 is read, 1 is write
+	prio=x		Run io at prio X, 0-7 is the kernel allowed range
+	prioclass=x	Run io at prio class X
+	file=foo	Do the io to file foo
+	bs=x		Thread blocksize is x bytes
+	direct=x	1 for direct IO, 0 for buffered IO
+	delay=x		Delay x useconds before each io
+	random		IO is randomized
+	sequential	IO is sequential
+
+
+Examples
+--------
+
+Spawn 2 threads, one read and one writer. Both threads want direct and
+sequential io, set these as global options. The reader wants a 4kb block
+size and the writer a 16kb block size, set those as thread options.
+
+$ fio -o1 -s "{rw=0,file=read_file,bs=4096}" "{rw=1,file=write_file,bs=16384}"
+
+Spawn 3 reader threads doing io at priorities 0, 3, and 6. The highest
+prio thread wants direct io, the others buffered. All want a 4kb block
+size.
+
+$ fio -o0 -s -b4096 "{rw=0,file=rf1,prio=6}" "{rw=0,file=rf2,prio=3}" "{rw=0,file=rf3,prio=0,direct=1}"
+