From a65565e06670b98bfa04c719ce8f8b5ebfc4b278 Mon Sep 17 00:00:00 2001 From: CPestka Date: Wed, 11 Oct 2023 13:21:42 +0200 Subject: [PATCH] io_uring_submit: note specifics on return value for SQPOLL Added the following behavior of io_uring_submit to the man page. When used with SQ_POLL and in the success case, the return value may not indicate the actual amount of successfully submitted submission queue entries, as mentioned in issue 88 Signed-off-by: Constantin Pestka constantin.pestka@web.de --- man/io_uring_submit.3 | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/man/io_uring_submit.3 b/man/io_uring_submit.3 index f871b8919..18a153272 100644 --- a/man/io_uring_submit.3 +++ b/man/io_uring_submit.3 @@ -26,7 +26,12 @@ and prepares the SQE using one of the provided helpers, it can be submitted with .SH RETURN VALUE On success .BR io_uring_submit (3) -returns the number of submitted submission queue entries. On failure it returns +returns the number of submitted submission queue entries, if SQPOLL is not used. +If SQPOLL is used, the return value may report a higher number of submitted +entries than actually submitted. If the the user requires accurate information +about how many submission queue entries have been successfully submitted, while +using SQPOLL, the user must fall back to repeatedly submitting a single submission +queue entry. On failure it returns .BR -errno . .SH NOTES For any request that passes in data in a struct, that data must remain