xref: /aosp_15_r20/external/liburing/man/io_uring_sqring_wait.3 (revision 25da2bea747f3a93b4c30fd9708b0618ef55a0e6)
Copyright (C) 2022 Stefan Roesch <[email protected]>

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

io_uring_sqring_wait "January 25, 2022" "liburing-2.1" "liburing Manual"
NAME
io_uring_sqring_wait - wait for free space in the SQ ring
SYNOPSIS
 #include <liburing.h> 

"int io_uring_sqring_wait(struct io_uring *" ring ");"

DESCRIPTION

The function io_uring_sqring_wait (3) allows the caller to wait for space to free up in the SQ ring belonging to the ring param, which happens when the kernel side thread has consumed one or more entries. If the SQ ring is currently non-full, no action is taken. This feature can only be used when the ring has been setup with IORING_SETUP_SQPOLL and hence is using an offloaded approach to request submissions.

RETURN VALUE
On success it returns the free space. If the kernel does not support the feature, -EINVAL is returned.
SEE ALSO
io_uring_submit (3), io_uring_wait_cqe (3), io_uring_wait_cqes (3)