summaryrefslogtreecommitdiff
path: root/man/io_uring_register_ring_fd.3
diff options
context:
space:
mode:
authorJens Axboe <axboe@kernel.dk>2022-04-08 07:13:54 -0600
committerJens Axboe <axboe@kernel.dk>2022-04-08 07:13:54 -0600
commit706bd23d05bd656ba0aca5974ebcb03d7610e6e9 (patch)
treefeb554841542ecbf03f84b18a911d03f671747c7 /man/io_uring_register_ring_fd.3
parentfbd72c3bd426e9284a11840706196d46928142d8 (diff)
downloadliburing-706bd23d05bd656ba0aca5974ebcb03d7610e6e9.tar.gz
liburing-706bd23d05bd656ba0aca5974ebcb03d7610e6e9.tar.bz2
man/io_uring_register_ring_fd.3: try to improve NOTES section
Threaded applications can use this optimization, but they cannot use it if they share any given ring between multiple threads. Link: https://github.com/axboe/liburing/issues/559 Signed-off-by: Jens Axboe <axboe@kernel.dk>
Diffstat (limited to 'man/io_uring_register_ring_fd.3')
-rw-r--r--man/io_uring_register_ring_fd.37
1 files changed, 4 insertions, 3 deletions
diff --git a/man/io_uring_register_ring_fd.3 b/man/io_uring_register_ring_fd.3
index 0e872bd..144262f 100644
--- a/man/io_uring_register_ring_fd.3
+++ b/man/io_uring_register_ring_fd.3
@@ -35,9 +35,10 @@ for restrictions when a ring is shared.
.SH NOTES
When the ring descriptor is registered, it is stored internally in the
.I struct io_uring
-structure. If an application shares this structure between threads, then this
-optimization cannot be used as the threads may get different values for the
-registered descriptor.
+structure. For applications that share a ring between threads, for example
+having one thread do submits and another reap events, then this optimization
+cannot be used as each thread may have a different index for the registered
+ring fd.
.SH RETURN VALUE
Returns 1 on success, indicating that one file descriptor was registered,
or