io_uring is a powerful new way to do asynchronous I/O programming under Linux. Doing away with various limitations of previous generation I/O subsystems, io_uring holds immense promise. For more details on what io_uring brings to the table, please see the chapter :ref:`what_is_io_uring`.
This io_uring guide was created by Shuveb Hussain, who is also the author of the Linux-focused blog, unixism.net. You can follow me on Twitter where my posts are mainly tech-related with a focus on Linux, performance, scalability and cloud.
The source code repository for this guide is here on Github. Please send me pull requests should you want to contribute. If you find any bugs in either the documentation or the included source code examples, please raise an issue on GitHub. The repository for the example programs is maintained separately. Please see details below.
Source code for all example programs in this guide are available on Github. If you find bugs in the examples, please raise issues on Github. I want to keep these examples simple and to the point. I many not merge pull requests that add features for that reason. Pull requests that fix bugs are welcome.
.. toctree::
:maxdepth: 1
:caption: Introduction
async_intro
what_is_io_uring
low_level
.. toctree::
:maxdepth: 1
:caption: Tutorial
:name: sec-tutorial
tutorial/index
tutorial/cat_liburing
tutorial/cp_liburing
tutorial/webserver_liburing
tutorial/probe_liburing
tutorial/link_liburing
tutorial/fixed_buffers
tutorial/sq_poll
tutorial/register_eventfd
.. toctree::
:maxdepth: 1
:caption: liburing Reference
:name: sec-liburing-reference
ref-liburing/index
ref-liburing/sqe
ref-liburing/cqe
ref-liburing/supported_caps
ref-liburing/setup_teardown
ref-liburing/submission
ref-liburing/completion
ref-liburing/advanced_usage
.. toctree::
:maxdepth: 1
:caption: io_uring Reference
:name: sec-iouring-reference
ref-iouring/index
ref-iouring/io_uring_setup
ref-iouring/io_uring_enter
ref-iouring/io_uring_register
.. toctree::
:maxdepth: 1
:caption: Changelog
changelog.rst