linux/tools/io_uring
Jens Axboe 21b4aa5d20 io_uring: add a few test tools
This adds two test programs in tools/io_uring/ that demonstrate both
the raw io_uring API (and all features) through a small benchmark
app, io_uring-bench, and the liburing exposed API in a simplified
cp(1) implementation through io_uring-cp.

Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-03-06 13:00:16 -07:00
..
Makefile io_uring: add a few test tools 2019-03-06 13:00:16 -07:00
README io_uring: add a few test tools 2019-03-06 13:00:16 -07:00
barrier.h io_uring: add a few test tools 2019-03-06 13:00:16 -07:00
io_uring-bench.c io_uring: add a few test tools 2019-03-06 13:00:16 -07:00
io_uring-cp.c io_uring: add a few test tools 2019-03-06 13:00:16 -07:00
liburing.h io_uring: add a few test tools 2019-03-06 13:00:16 -07:00
queue.c io_uring: add a few test tools 2019-03-06 13:00:16 -07:00
setup.c io_uring: add a few test tools 2019-03-06 13:00:16 -07:00
syscall.c io_uring: add a few test tools 2019-03-06 13:00:16 -07:00

README

This directory includes a few programs that demonstrate how to use io_uring
in an application. The examples are:

io_uring-cp
	A very basic io_uring implementation of cp(1). It takes two
	arguments, copies the first argument to the second. This example
	is part of liburing, and hence uses the simplified liburing API
	for setting up an io_uring instance, submitting IO, completing IO,
	etc. The support functions in queue.c and setup.c are straight
	out of liburing.

io_uring-bench
	Benchmark program that does random reads on a number of files. This
	app demonstrates the various features of io_uring, like fixed files,
	fixed buffers, and polled IO. There are options in the program to
	control which features to use. Arguments is the file (or files) that
	io_uring-bench should operate on. This uses the raw io_uring
	interface.

liburing can be cloned with git here:

	git://git.kernel.dk/liburing

and contains a number of unit tests as well for testing io_uring. It also
comes with man pages for the three system calls.

Fio includes an io_uring engine, you can clone fio here:

	git://git.kernel.dk/fio