diff options
| author | Gil Cukierman <cukie@google.com> | 2022-10-28 15:33:44 -0400 |
|---|---|---|
| committer | Gil Cukierman <cukie@google.com> | 2022-10-28 15:39:12 -0400 |
| commit | d0a2042580f3ed180db5e2b53029296a8b555115 (patch) | |
| tree | ebe9c872e416346e4b333e5062da32401c8e0a73 /man/io_uring_prep_remove_buffers.3 | |
| parent | d53db6851ea17b2d219d084e1afc683b8b62b105 (diff) | |
| parent | dda4848a9911120a903bef6284fb88286f4464c9 (diff) | |
| download | liburing-d0a2042580f3ed180db5e2b53029296a8b555115.tar.gz | |
Update liburing to version 2.2
Merge branch 'liburingtag2_2' into liburing_upgrade
Test: atest liburing_cpp_tests
Bug: b/253385258
Change-Id: Ia9b4acfce599cd0f7a2ab22999e64d107bc1b96c
Diffstat (limited to 'man/io_uring_prep_remove_buffers.3')
| -rw-r--r-- | man/io_uring_prep_remove_buffers.3 | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/man/io_uring_prep_remove_buffers.3 b/man/io_uring_prep_remove_buffers.3 new file mode 100644 index 0000000..cf4f226 --- /dev/null +++ b/man/io_uring_prep_remove_buffers.3 @@ -0,0 +1,52 @@ +.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk> +.\" +.\" SPDX-License-Identifier: LGPL-2.0-or-later +.\" +.TH io_uring_prep_remove_buffers 3 "March 13, 2022" "liburing-2.2" "liburing Manual" +.SH NAME +io_uring_prep_remove_buffers \- prepare a remove buffers request +.SH SYNOPSIS +.nf +.B #include <liburing.h> +.PP +.BI "void io_uring_prep_remove_buffers(struct io_uring_sqe *" sqe "," +.BI " int " nr "," +.BI " int " bgid ");" +.fi +.SH DESCRIPTION +.PP +The +.BR io_uring_prep_remove_buffers (3) +function prepares a request for removing previously supplied buffers. The +submission queue entry +.I sqe +is setup to remove +.I nr +number of buffers from the buffer group ID indicated by +.IR bgid . + +.SH RETURN VALUE +None +.SH ERRORS +These are the errors that are reported in the CQE +.I res +field. On success, +.I res +will contain the number of successfully removed buffers. On error, +the following errors can occur. +.TP +.B -ENOMEM +The kernel was unable to allocate memory for the request. +.TP +.B -EINVAL +One of the fields set in the SQE was invalid. +.TP +.B -ENOENT +No buffers exist at the specified +.I bgid +buffer group ID. +.SH SEE ALSO +.BR io_uring_get_sqe (3), +.BR io_uring_submit (3), +.BR io_uring_register (2), +.BR io_uring_prep_provide_buffers (3) |