__io_uring_buf_ring_cq_advance(3) — Linux manual page

io_uring_bu..._cq_advance(3) liburing Manualio_uring_bu..._cq_advance(3)

NAME

       io_uring_buf_ring_cq_advance - advance index of provided buffer
       and CQ ring

SYNOPSIS

       #include <liburing.h>

       void io_uring_buf_ring_cq_advance(struct io_uring *ring,
                                         struct io_uring_buf_ring *br,
                                         int count);

       void __io_uring_buf_ring_cq_advance(struct io_uring *ring,
                                           struct io_uring_buf_ring *br,
                                           int cq_count,
                                           int buf_count);

DESCRIPTION

       The io_uring_buf_ring_cq_advance(3) commits count previously
       added buffers to the shared buffer ring br, making them visible
       to the kernel and hence consumable. This passes ownership of the
       buffer to the ring. At the same time, it advances the CQ ring of
       ring by count amount. This effectively bundles both a
       io_uring_buf_ring_advance(3) call and a io_uring_cq_advance(3)
       into one operation. Since updating either ring index entails a
       store memory barrier, doing both at once is more efficient.

       The __io_uring_buf_ring_cq_advance(3) function performs the same
       operation, except it splits the counts into two separate values.
       It advances the CQ ring by cq_count entries, and the buffer ring
       by buf_count entries rather than increment both by the same
       value.

RETURN VALUE

       None

SEE ALSO

       io_uring_register_buf_ring(3), io_uring_buf_ring_add(3),
       io_uring_buf_ring_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.2                  May 18, 2022  io_uring_bu..._cq_advance(3)

Pages that refer to this page: io_uring_buf_ring_cq_advance(3), __io_uring_buf_ring_cq_advance(3)

---