summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPavel Begunkov <asml.silence@gmail.com>2021-12-01 13:20:37 +0000
committerJens Axboe <axboe@kernel.dk>2021-12-07 09:17:36 -0700
commit1d86befc0552332fce761a63b2e28e33b743a074 (patch)
tree20e843cd84a8ad2dca0fac0d2dfd8d0a0b288c9b
parentd84c29b19ed0b130000619cff40141bb1fc3615b (diff)
downloadliburing-1d86befc0552332fce761a63b2e28e33b743a074.tar.gz
liburing-1d86befc0552332fce761a63b2e28e33b743a074.tar.bz2
man/io_uring_enter.2: notes about cqe-skip & drain interoperability
IOSQE_CQE_SKIP_SUCCESS can't be used together with draining in a single ring, add a paragraph explaining what are the restrictions. Signed-off-by: Pavel Begunkov <asml.silence@gmail.com> Link: https://lore.kernel.org/r/8c81bf9b01a54d1214bb65678c2ff1362a9f9328.1638364791.git.asml.silence@gmail.com [axboe: tweak the wording] Signed-off-by: Jens Axboe <axboe@kernel.dk>
-rw-r--r--man/io_uring_enter.29
1 files changed, 9 insertions, 0 deletions
diff --git a/man/io_uring_enter.2 b/man/io_uring_enter.2
index b003e05..589f3ef 100644
--- a/man/io_uring_enter.2
+++ b/man/io_uring_enter.2
@@ -1115,6 +1115,15 @@ CQEs in cases where the side effects of a successfully executed operation is
enough for userspace to know the state of the system. One such example would
be writing to a synchronisation file.
+This flag is incompatible with
+.B IOSQE_IO_DRAIN.
+Using both of them in a single ring is undefined behavior, even when they are
+not used together in a single request. Currently, after the first request with
+.B IOSQE_CQE_SKIP_SUCCESS,
+all subsequent requests marked with drain will be failed at submission time.
+Note that the error reporting is best effort only, and restrictions may change
+in the future.
+
Available since 5.17.
.PP