io_uring_cq_has_overflow(3) — Linux manual page

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

io_uring_cq_has_overflow(3)  liburing Manual io_uring_cq_has_overflow(3)

NAME         top

       io_uring_cq_has_overflow - returns if there are overflow entries
       waiting to move to the CQ ring

SYNOPSIS         top

       #include <liburing.h>

       bool io_uring_cq_has_overflow(const struct io_uring *ring);

DESCRIPTION         top

       The io_uring_cq_has_overflow(3) function informs the application
       if CQ entries have overflowed and are waiting to be flushed to
       the CQ ring. For example using io_uring_get_events(3)

NOTES         top

       Using this function is only valid if the ring has
       IORING_FEAT_NODROP set, as it's checking for a flag set by
       kernels supporting that feature. For really old kernels that
       don't support this feature, if CQE overflow is experienced the
       CQEs are lost. If that happens, the CQ ring overflow offset will
       get incremented.

RETURN VALUE         top

       True if there are CQ entries waiting to be flushed to the CQ
       ring.

SEE ALSO         top

       io_uring_get_events(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 [email protected].  This page
       was obtained from the project's upstream Git repository
       ⟨https://github.com/axboe/liburing⟩ on 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2024-06-03.)  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
       [email protected]

liburing-2.3                September 5, 2022io_uring_cq_has_overflow(3)

Pages that refer to this page: io_uring_cq_has_overflow(3)io_uring_get_events(3)