[splice.git] / README

Splice test tools
-----------------

A small collection of tools that I used during testing of splice. Some
of them might even be useful outside of that :-)

ktee:		Sort of like tee. It uses sys_tee to avoid moving the data to
		user space. ktee will sys_tee stdin to stdout, then consume
		stdin by splicing it to the given file.

ktee-net:	Like ktee, except it splices stdin to a network host.

splice-cp:	Splice input file to output file, basically copying the
		data. If the -m option is given, pages will be migrated
		instead of copied.

splice-in:	Splice given file to stdout.

splice-tonet:	Splice stdin network host.

splice-fromnet:	Splice from network to stdout.

splice-out:	Splice stdin to given file.

splice-test4c:	Splice/sendfile test client. Use with splice-test4s. There
		must be a file of at least 128MiB called 'largefile' in the
		current directory, splice-test4c uses that as input data.

splice-test4s:	Dummy server for splice-test4c.

splice-bench:	Test various sides of splice performance.

vmsplice:
vmsplice2:	Splice user memory to a pipe.

vmsplice-to-user: Test splicing back into user memory.

All tools written by me, except splice-test4c/s which are from Ingo Molnar.


Jens Axboe, 20070613
Commit	Line	Data
d82dfd0f JA	1	Splice test tools
	2	-----------------
	3
	4	A small collection of tools that I used during testing of splice. Some
	5	of them might even be useful outside of that :-)
	6
	7	ktee: Sort of like tee. It uses sys_tee to avoid moving the data to
	8	user space. ktee will sys_tee stdin to stdout, then consume
	9	stdin by splicing it to the given file.
	10
	11	ktee-net: Like ktee, except it splices stdin to a network host.
	12
	13	splice-cp: Splice input file to output file, basically copying the
	14	data. If the -m option is given, pages will be migrated
	15	instead of copied.
	16
	17	splice-in: Splice given file to stdout.
	18
beeecb44 JA	19	splice-tonet: Splice stdin network host.
beeecb44 JA	20
60a1ce9b	21	splice-fromnet: Splice from network to stdout.
d82dfd0f JA	22
	23	splice-out: Splice stdin to given file.
	24
26df7797 JA	25	splice-test4c: Splice/sendfile test client. Use with splice-test4s. There
	26	must be a file of at least 128MiB called 'largefile' in the
	27	current directory, splice-test4c uses that as input data.
d82dfd0f JA	28
	29	splice-test4s: Dummy server for splice-test4c.
	30
d7b40d65 JA	31	splice-bench: Test various sides of splice performance.
d7b40d65 JA	32
5142f243 JA	33	vmsplice:
5142f243 JA	34	vmsplice2: Splice user memory to a pipe.
42bfe484	35
60a1ce9b JA	36	vmsplice-to-user: Test splicing back into user memory.
60a1ce9b JA	37
d82dfd0f JA	38	All tools written by me, except splice-test4c/s which are from Ingo Molnar.
	39
	40
	41
	42
60a1ce9b	43	Jens Axboe, 20070613
d82dfd0f	44