man7.org > Linux > man-pages

Linux/UNIX system programming training

io_uring_sqring_wait(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | COLOPHON 

io_uring_sqring_wait(3)      liburing Manual     io_uring_sqring_wait(3)

NAME         top

       io_uring_sqring_wait - wait for free space in the SQ ring

SYNOPSIS         top

       #include <liburing.h>

       int io_uring_sqring_wait(struct io_uring *ring);

DESCRIPTION         top

       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         top

       On success it returns the free space. If the kernel does not
       support the feature, -EINVAL is returned.

SEE ALSO         top

       io_uring_submit(3), io_uring_wait_cqe(3), io_uring_wait_cqes(3)

COLOPHON         top

       This page is part of the liburing (A library for io_uring)
       project.  Information about the project can be found at 
       ⟨https://github.com/axboe/liburing⟩.  If you have a bug report for
       this manual page, send it to io-uring@vger.kernel.org.  This page
       was obtained from the project's upstream Git repository
       ⟨https://github.com/axboe/liburing⟩ on 2023-12-22.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-12-19.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

liburing-2.1                January 25, 2022     io_uring_sqring_wait(3)

Pages that refer to this page: io_uring_sqring_wait(3)

HTML rendering created 2023-12-22 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI