[disktools.git] / README.fio

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 KiB for each io
	-t <sec> Runtime in seconds
	-r For random io, sequence must be repeatable
	-R <on> If one thread fails to meet rate, quit all
	-o <on> Use direct IO is 1, buffered if 0
	-l Generate per-job latency logs
	-w Generate per-job bandwidth logs
	-f <file> Read <file> for job descriptions

The <jobs> format is as follows:

	directory=x	Use 'x' as the top level directory for storing files
	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
	bsrange=x-y	Mix thread block sizes randomly between x and y
	direct=x	1 for direct IO, 0 for buffered IO
	thinktime=x	"Think" x usec after each io
	random		IO is randomized
	sequential	IO is sequential
	rate=x		Throttle rate to x KiB/sec
	ratemin=x	Quit if rate of x KiB/sec can't be met
	ratecycle=x	ratemin averaged over x msecs
	cpumask=x	Allow job to run on CPUs defined by mask
	fsync=x		If writing, fsync after every x blocks have been written
	startdelay=x	Start this thread x seconds after startup
	timeout=x	Terminate x seconds after startup
	aio		Use Linux async io
	aio_depth=x	Allow x iocbs in flight
	size=x		Set file size to x bytes (x string can include k/m/g)
	offset=x	Start io at offset x (x string can include k/m/g)
	invalidate=x	Invalidate page cache for file prior to doing io
	sync=x		Use sync writes if x and writing
	mem=x		If x == malloc, use malloc for buffers. If x == shm,
			use shm for buffers.
	exitall		When one thread quits, terminate the others
	bwavgtime=x	Average bandwidth stats over x msec
	create_serialize=x	If 'x', serialize file creation.
	create_fsync=x	If 'x', run fsync() after file creation.
	loops=x		Run the job 'x' number of times.
	verify=x	If 'x' and writing, verify data written.
	stonewall	Wait for preceeding jobs to end before running.
	numjobs=x	Create 'x' similar entries for this job


Examples using a job file
-------------------------

A sample job file doing the same as above would look like this:

[read_file]
rw=0
bs=4096

[write_file]
rw=1
bs=16384

And fio would be invoked as:

$ fio -o1 -s -f file_with_above

The second example would look like this:

[rf1]
rw=0
prio=6

[rf2]
rw=0
prio=3

[rf3]
rw=0
prio=0
direct=1

And fio would be invoked as:

$ fio -o0 -s -b4096 -f file_with_above

'global' is a reserved keyword. When used as the filename, it sets the
default options for the threads following that section. It is possible
to have more than one global section in the file, as it only affects
subsequent jobs.

Also see the examples/ dir for sample job files.
Commit	Line	Data
e709787c JA	1	fio
	2	---
	3
	4	fio is a tool that will spawn a number of thread doing a particular
	5	type of io action as specified by the user. fio takes a number of
	6	global parameters, each inherited by the thread unless otherwise
	7	parameters given to them overriding that setting is given.
	8
	9	Options
	10	-------
	11
	12	$ fio
	13	-s IO is sequential
86184d14	14	-b block size in KiB for each io
e709787c	15	-t <sec> Runtime in seconds
e709787c	16	-r For random io, sequence must be repeatable
02bdd9ba	17	-R <on> If one thread fails to meet rate, quit all
e709787c	18	-o <on> Use direct IO is 1, buffered if 0
a0a9b35b JA	19	-l Generate per-job latency logs
a0a9b35b JA	20	-w Generate per-job bandwidth logs
7dd1389e	21	-f <file> Read <file> for job descriptions
e709787c	22
e709787c JA	23	The <jobs> format is as follows:
e709787c JA	24
fe74f555	25	directory=x Use 'x' as the top level directory for storing files
e709787c JA	26	rw=0/1 0 is read, 1 is write
	27	prio=x Run io at prio X, 0-7 is the kernel allowed range
	28	prioclass=x Run io at prio class X
	29	file=foo Do the io to file foo
8c033f93	30	bs=x Thread blocksize is x bytes
7889f07b	31	bsrange=x-y Mix thread block sizes randomly between x and y
e709787c	32	direct=x 1 for direct IO, 0 for buffered IO
e97712ed	33	thinktime=x "Think" x usec after each io
e709787c JA	34	random IO is randomized
e709787c JA	35	sequential IO is sequential
86184d14	36	rate=x Throttle rate to x KiB/sec
4240cfa1 JA	37	ratemin=x Quit if rate of x KiB/sec can't be met
4240cfa1 JA	38	ratecycle=x ratemin averaged over x msecs
18e0b78c	39	cpumask=x Allow job to run on CPUs defined by mask
4240cfa1	40	fsync=x If writing, fsync after every x blocks have been written
fc24389f	41	startdelay=x Start this thread x seconds after startup
67903a2e	42	timeout=x Terminate x seconds after startup
43000118 JA	43	aio Use Linux async io
43000118 JA	44	aio_depth=x Allow x iocbs in flight
02983297 JA	45	size=x Set file size to x bytes (x string can include k/m/g)
02983297 JA	46	offset=x Start io at offset x (x string can include k/m/g)
b95799ca	47	invalidate=x Invalidate page cache for file prior to doing io
74b4b5fb	48	sync=x Use sync writes if x and writing
99c6704f JA	49	mem=x If x == malloc, use malloc for buffers. If x == shm,
99c6704f JA	50	use shm for buffers.
98dd52d6	51	exitall When one thread quits, terminate the others
1d035750	52	bwavgtime=x Average bandwidth stats over x msec
b6794fbf JA	53	create_serialize=x If 'x', serialize file creation.
	54	create_fsync=x If 'x', run fsync() after file creation.
	55	loops=x Run the job 'x' number of times.
cfc702bd	56	verify=x If 'x' and writing, verify data written.
2a81240d	57	stonewall Wait for preceeding jobs to end before running.
fe74f555	58	numjobs=x Create 'x' similar entries for this job
e709787c JA	59
e709787c JA	60
7dd1389e JA	61	Examples using a job file
	62	-------------------------
	63
	64	A sample job file doing the same as above would look like this:
	65
	66	[read_file]
	67	rw=0
	68	bs=4096
	69
	70	[write_file]
	71	rw=1
	72	bs=16384
	73
	74	And fio would be invoked as:
	75
	76	$ fio -o1 -s -f file_with_above
	77
	78	The second example would look like this:
	79
	80	[rf1]
	81	rw=0
	82	prio=6
	83
	84	[rf2]
	85	rw=0
	86	prio=3
	87
	88	[rf3]
	89	rw=0
	90	prio=0
	91	direct=1
	92
	93	And fio would be invoked as:
	94
	95	$ fio -o0 -s -b4096 -f file_with_above
	96
47d45203 JA	97	'global' is a reserved keyword. When used as the filename, it sets the
	98	default options for the threads following that section. It is possible
	99	to have more than one global section in the file, as it only affects
	100	subsequent jobs.
ed864e24 JA	101
ed864e24 JA	102	Also see the examples/ dir for sample job files.
47d45203	103