summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJens Axboe <axboe@kernel.dk>2022-05-14 09:28:11 -0600
committerJens Axboe <axboe@kernel.dk>2022-05-14 09:28:11 -0600
commit91040e8b1e22de8ec79161bba6ced308cdf6b8fd (patch)
tree0e4906c9b5c977a0ef5b1ea65942b9111cdc1ca7
parentc519d1928a631873a622a3b81afdc1f2982ba35b (diff)
downloadliburing-91040e8b1e22de8ec79161bba6ced308cdf6b8fd.tar.gz
liburing-91040e8b1e22de8ec79161bba6ced308cdf6b8fd.tar.bz2
open/openat2: update man page to include IORING_FILE_INDEX_ALLOCaccept-multi
Signed-off-by: Jens Axboe <axboe@kernel.dk>
-rw-r--r--man/io_uring_prep_openat.312
-rw-r--r--man/io_uring_prep_openat2.311
2 files changed, 23 insertions, 0 deletions
diff --git a/man/io_uring_prep_openat.3 b/man/io_uring_prep_openat.3
index 8094619..b0f0946 100644
--- a/man/io_uring_prep_openat.3
+++ b/man/io_uring_prep_openat.3
@@ -67,6 +67,18 @@ Note that old kernels don't check the SQE
field, which is not a problem for liburing helpers, but users of the raw
io_uring interface need to zero SQEs to avoid unexpected behavior.
+If
+.B IORING_FILE_INDEX_ALLOC
+is used as the
+.I file_index
+for a direct open, then io_uring will allocate a free direct descriptor in
+the existing table. The allocated descriptor is returned in the CQE
+.I res
+field just like it would be for a non-direct open request. If no more entries
+are available in the direct descriptor table,
+.B -ENFILE
+is returned instead.
+
This function prepares an async
.BR openat (2)
request. See that man page for details.
diff --git a/man/io_uring_prep_openat2.3 b/man/io_uring_prep_openat2.3
index 4898e30..96682d8 100644
--- a/man/io_uring_prep_openat2.3
+++ b/man/io_uring_prep_openat2.3
@@ -67,6 +67,17 @@ Note that old kernels don't check the SQE
.I file_index
field, which is not a problem for liburing helpers, but users of the raw
io_uring interface need to zero SQEs to avoid unexpected behavior.
+If
+.B IORING_FILE_INDEX_ALLOC
+is used as the
+.I file_index
+for a direct open, then io_uring will allocate a free direct descriptor in
+the existing table. The allocated descriptor is returned in the CQE
+.I res
+field just like it would be for a non-direct open request. If no more entries
+are available in the direct descriptor table,
+.B -ENFILE
+is returned instead.
This function prepares an async
.BR openat2 (2)