xref: /aosp_15_r20/external/liburing/man/io_uring_prep_remove_buffers.3 (revision 25da2bea747f3a93b4c30fd9708b0618ef55a0e6)
Copyright (C) 2022 Jens Axboe <[email protected]>

SPDX-License-Identifier: LGPL-2.0-or-later

io_uring_prep_remove_buffers 3 "March 13, 2022" "liburing-2.2" "liburing Manual"
NAME
io_uring_prep_remove_buffers - prepare a remove buffers request
SYNOPSIS
 #include <liburing.h> 

"void io_uring_prep_remove_buffers(struct io_uring_sqe *" sqe "," " int " nr "," " int " bgid ");"

DESCRIPTION

The io_uring_prep_remove_buffers (3) function prepares a request for removing previously supplied buffers. The submission queue entry sqe is setup to remove nr number of buffers from the buffer group ID indicated by bgid .

RETURN VALUE
None
ERRORS
These are the errors that are reported in the CQE res field. On success, res will contain the number of successfully removed buffers. On error, the following errors can occur.

-ENOMEM The kernel was unable to allocate memory for the request.

-EINVAL One of the fields set in the SQE was invalid.

-ENOENT No buffers exist at the specified bgid buffer group ID.

SEE ALSO
io_uring_get_sqe (3), io_uring_submit (3), io_uring_register (2), io_uring_prep_provide_buffers (3)