diff options
| author | Jens Axboe <axboe@kernel.dk> | 2021-06-30 19:32:10 -0600 |
|---|---|---|
| committer | Jens Axboe <axboe@kernel.dk> | 2021-06-30 19:32:10 -0600 |
| commit | 11f6d56302c177a96d7eb1df86995939a4feb736 (patch) | |
| tree | d7a6a9943c71e386ea0d30ce71114e6a53464c6a | |
| parent | 603111a58a04926088bd0493ea5d4d2ff8aaef93 (diff) | |
| download | liburing-11f6d56302c177a96d7eb1df86995939a4feb736.tar.gz | |
man/io_uring_enter.2: clarify io_uring_enter(2) SQPOLL return value
If we're using SQPOLL, then the return value doesn't really indicate
how many IOs were submitted, as the actual submission happens out
of line. It'll usually be what the application asked to submit, even
if that differs from pending entries in the SQ ring.
Signed-off-by: Jens Axboe <axboe@kernel.dk>
| -rw-r--r-- | man/io_uring_enter.2 | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/man/io_uring_enter.2 b/man/io_uring_enter.2 index dd3c962..909cc9b 100644 --- a/man/io_uring_enter.2 +++ b/man/io_uring_enter.2 @@ -954,7 +954,12 @@ description of the opcodes above. returns the number of I/Os successfully consumed. This can be zero if .I to_submit -was zero or if the submission queue was empty. +was zero or if the submission queue was empty. Note that if the ring was +created with +.B IORING_SETUP_SQPOLL +specified, then the return value will generally be the same as +.I to_submit +as submission happens outside the context of the system call. The errors related to a submission queue entry will be returned through a completion queue entry (see section |