Blame README

Packit Service 63ea89
liburing
Packit Service 63ea89
--------
Packit Service 63ea89
Packit Service 63ea89
This is the io_uring library, liburing. liburing provides helpers to setup and
Packit Service 63ea89
teardown io_uring instances, and also a simplified interface for
Packit Service 63ea89
applications that don't need (or want) to deal with the full kernel
Packit Service 63ea89
side implementation.
Packit Service 63ea89
Packit Service 63ea89
For more info on io_uring, please see:
Packit Service 63ea89
Packit Service 63ea89
https://kernel.dk/io_uring.pdf
Packit Service 63ea89
Packit Service 63ea89
Subscribe to io-uring@vger.kernel.org for io_uring related discussions
Packit Service 63ea89
and development for both kernel and userspace. The list is archived here:
Packit Service 63ea89
Packit Service 63ea89
https://lore.kernel.org/io-uring/
Packit Service 63ea89
Packit Service 63ea89
Packit Service 63ea89
ulimit settings
Packit Service 63ea89
---------------
Packit Service 63ea89
Packit Service 63ea89
io_uring accounts memory it needs under the rlimit memlocked option, which
Packit Service 63ea89
can be quite low on some setups (64K). The default is usually enough for
Packit Service 63ea89
most use cases, but bigger rings or things like registered buffers deplete
Packit Service 63ea89
it quickly. root isn't under this restriction, but regular users are. Going
Packit Service 63ea89
into detail on how to bump the limit on various systems is beyond the scope
Packit Service 63ea89
of this little blurb, but check /etc/security/limits.conf for user specific
Packit Service 63ea89
settings, or /etc/systemd/user.conf and /etc/systemd/system.conf for systemd
Packit Service 63ea89
setups.
Packit Service 63ea89
Packit Service 63ea89
Regressions tests
Packit Service 63ea89
-----------------
Packit Service 63ea89
Packit Service 63ea89
The bulk of liburing is actually regression/unit tests for both liburing and
Packit Service 63ea89
the kernel io_uring support. Please note that this suite isn't expected to
Packit Service 63ea89
pass on older kernels, and may even crash or hang older kernels!
Packit Service 63ea89
Packit Service 63ea89
License
Packit Service 63ea89
-------
Packit Service 63ea89
Packit Service 63ea89
All software contained within this repo is dual licensed LGPL and MIT, see
Packit Service 63ea89
COPYING and LICENSE, except for a header coming from the kernel which is
Packit Service 63ea89
dual licensed GPL with a Linux-syscall-note exception and MIT, see
Packit Service 63ea89
COPYING.GPL and <https://spdx.org/licenses/Linux-syscall-note.html>.
Packit Service 63ea89
Packit Service 63ea89
Jens Axboe 2020-01-20