diff options
| author | Gil Cukierman <cukie@google.com> | 2022-10-31 14:08:03 +0000 |
|---|---|---|
| committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | 2022-10-31 14:08:03 +0000 |
| commit | dae12c7b40c255ad7c6612591e2908a266f2cfd5 (patch) | |
| tree | ebe9c872e416346e4b333e5062da32401c8e0a73 /man/io_uring_buf_ring_add.3 | |
| parent | d53db6851ea17b2d219d084e1afc683b8b62b105 (diff) | |
| parent | d0a2042580f3ed180db5e2b53029296a8b555115 (diff) | |
| download | liburing-dae12c7b40c255ad7c6612591e2908a266f2cfd5.tar.gz | |
Update liburing to version 2.2 am: d0a2042580main-16k-with-phones
Original change: https://android-review.googlesource.com/c/platform/external/liburing/+/2276974
Change-Id: I0ac5dbb2b0dadb76713528e6ab0110ec071bad63
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
Diffstat (limited to 'man/io_uring_buf_ring_add.3')
| -rw-r--r-- | man/io_uring_buf_ring_add.3 | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/man/io_uring_buf_ring_add.3 b/man/io_uring_buf_ring_add.3 new file mode 100644 index 0000000..9d8283b --- /dev/null +++ b/man/io_uring_buf_ring_add.3 @@ -0,0 +1,53 @@ +.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk> +.\" +.\" SPDX-License-Identifier: LGPL-2.0-or-later +.\" +.TH io_uring_buf_ring_add 3 "May 18, 2022" "liburing-2.2" "liburing Manual" +.SH NAME +io_uring_buf_ring_add \- add buffers to a shared buffer ring +.SH SYNOPSIS +.nf +.B #include <liburing.h> +.PP +.BI "int io_uring_buf_ring_add(struct io_uring_buf_ring *" br ", +.BI " void *" addr ", +.BI " unsigned int " len ", +.BI " unsigned short " bid ", +.BI " int " mask ", +.BI " int " buf_offset ");" +.fi +.SH DESCRIPTION +.PP +The +.BR io_uring_buf_ring_add (3) +adds a new buffer to the shared buffer ring +.IR br . +The buffer address is indicated by +.I addr +and is of +.I len +bytes of length. +.I bid +is the buffer ID, which will be returned in the CQE. +.I mask +is the size mask of the ring, available from +.BR io_uring_buf_ring_mask (3) . +.I buf_offset +is the offset to insert at from the current tail. If just one buffer is provided +before the ring tail is committed with +.BR io_uring_buf_ring_advance (3) +or +.BR io_uring_buf_ring_cq_advance (3), +then +.I buf_offset +should be 0. If buffers are provided in a loop before being committed, the +.I buf_offset +must be incremented by one for each buffer added. + +.SH RETURN VALUE +None +.SH SEE ALSO +.BR io_uring_register_buf_ring (3), +.BR io_uring_buf_ring_mask (3), +.BR io_uring_buf_ring_advance (3), +.BR io_uring_buf_ring_cq_advance (3) |