| Jens Axboe | 72d7f5a | 2019-08-05 12:06:42 -0600 | [diff] [blame] | 1 | liburing |
| 2 | -------- |
| 3 | |
| Jobs Gate | 8abda3b | 2020-07-06 23:02:05 +0800 | [diff] [blame] | 4 | This is the io_uring library, liburing. liburing provides helpers to setup and |
| Jens Axboe | 72d7f5a | 2019-08-05 12:06:42 -0600 | [diff] [blame] | 5 | teardown io_uring instances, and also a simplified interface for |
| 6 | applications that don't need (or want) to deal with the full kernel |
| 7 | side implementation. |
| 8 | |
| 9 | For more info on io_uring, please see: |
| 10 | |
| Jens Axboe | b141467 | 2019-11-04 15:38:38 -0700 | [diff] [blame] | 11 | https://kernel.dk/io_uring.pdf |
| 12 | |
| 13 | Subscribe to io-uring@vger.kernel.org for io_uring related discussions |
| 14 | and development for both kernel and userspace. The list is archived here: |
| 15 | |
| 16 | https://lore.kernel.org/io-uring/ |
| Jens Axboe | 72d7f5a | 2019-08-05 12:06:42 -0600 | [diff] [blame] | 17 | |
| Jens Axboe | d9b3a10 | 2019-11-10 22:10:27 -0700 | [diff] [blame] | 18 | |
| 19 | ulimit settings |
| 20 | --------------- |
| 21 | |
| 22 | io_uring accounts memory it needs under the rlimit memlocked option, which |
| 23 | can be quite low on some setups (64K). The default is usually enough for |
| 24 | most use cases, but bigger rings or things like registered buffers deplete |
| 25 | it quickly. root isn't under this restriction, but regular users are. Going |
| 26 | into detail on how to bump the limit on various systems is beyond the scope |
| 27 | of this little blurb, but check /etc/security/limits.conf for user specific |
| 28 | settings, or /etc/systemd/user.conf and /etc/systemd/system.conf for systemd |
| 29 | setups. |
| 30 | |
| Jens Axboe | 236570e | 2020-01-30 09:08:07 -0700 | [diff] [blame] | 31 | Regressions tests |
| 32 | ----------------- |
| 33 | |
| 34 | The bulk of liburing is actually regression/unit tests for both liburing and |
| 35 | the kernel io_uring support. Please note that this suite isn't expected to |
| 36 | pass on older kernels, and may even crash or hang older kernels! |
| 37 | |
| Jens Axboe | b9f507d | 2020-01-20 15:50:36 -0700 | [diff] [blame] | 38 | License |
| 39 | ------- |
| Jens Axboe | d9b3a10 | 2019-11-10 22:10:27 -0700 | [diff] [blame] | 40 | |
| Jens Axboe | b9f507d | 2020-01-20 15:50:36 -0700 | [diff] [blame] | 41 | All software contained within this repo is dual licensed LGPL and MIT, see |
| Guillem Jover | 8e9f14e | 2020-04-11 20:24:05 +0200 | [diff] [blame] | 42 | COPYING and LICENSE, except for a header coming from the kernel which is |
| 43 | dual licensed GPL with a Linux-syscall-note exception and MIT, see |
| 44 | COPYING.GPL and <https://spdx.org/licenses/Linux-syscall-note.html>. |
| Jens Axboe | b9f507d | 2020-01-20 15:50:36 -0700 | [diff] [blame] | 45 | |
| 46 | Jens Axboe 2020-01-20 |