io_uring_buf_ring_available(3) — Linux manual page

io_uring_b...g_available(3)  liburing Manual io_uring_b...g_available(3)

NAME

       io_uring_buf_ring_available - return number of unconsumed
       provided ring buffer entries

SYNOPSIS

       #include <liburing.h>

       int io_uring_buf_ring_available(struct io_uring *ring,
                                       struct io_uring_buf_ring *br,
                                       unsigned short bgid);

DESCRIPTION

       The io_uring_buf_ring_available(3) helper returns the number of
       unconsumed (by the kernel) entries in the br provided buffer
       group belonging to the io_uring ring and identified by the buffer
       group ID bgid.

       Since the head of the provided buffer ring is only visible to the
       kernel, it's impossible to otherwise know how many unconsumed
       entries exist in the given provided buffer ring. This function
       query the kernel to return that number.

NOTES

       The returned number of entries reflect the amount of unconsumed
       entries at the time that it was queried. If inflight IO exists
       that may consume provided buffers from this buffer group, then
       the returned value is inherently racy.

RETURN VALUE

       Returns the number of unconsumed entries on success, which may be
       0. In case of error, may return -ENOENT if the specified buffer
       group doesn't exist, or -EINVAL if the buffer group isn't of the
       correct type, or if the kernel doesn't support this feature.

SEE ALSO

       io_uring_register_buf_ring(3), io_uring_buf_ring_add(3),
       io_uring_buf_ring_cq_advance(3)

COLOPHON

       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 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
       man-pages@man7.org

liburing-2.6                  Jan 11, 2024   io_uring_b...g_available(3)

Pages that refer to this page: io_uring_buf_ring_available(3)

---