blob: 98ca767808dc2c98afca075d949dfaafb4f77c72 [file] [log] [blame]
Jens Axboe72d7f5a2019-08-05 12:06:42 -06001liburing
2--------
3
4This is the liburing library. liburing provides helpers to setup and
5teardown io_uring instances, and also a simplified interface for
6applications that don't need (or want) to deal with the full kernel
7side implementation.
8
9For more info on io_uring, please see:
10
Jens Axboeb1414672019-11-04 15:38:38 -070011https://kernel.dk/io_uring.pdf
12
13Subscribe to io-uring@vger.kernel.org for io_uring related discussions
14and development for both kernel and userspace. The list is archived here:
15
16https://lore.kernel.org/io-uring/
Jens Axboe72d7f5a2019-08-05 12:06:42 -060017
Jens Axboed9b3a102019-11-10 22:10:27 -070018
19ulimit settings
20---------------
21
22io_uring accounts memory it needs under the rlimit memlocked option, which
23can be quite low on some setups (64K). The default is usually enough for
24most use cases, but bigger rings or things like registered buffers deplete
25it quickly. root isn't under this restriction, but regular users are. Going
26into detail on how to bump the limit on various systems is beyond the scope
27of this little blurb, but check /etc/security/limits.conf for user specific
28settings, or /etc/systemd/user.conf and /etc/systemd/system.conf for systemd
29setups.
30
31
32Jens Axboe 2019-11-10