io_uring_free_buf_ring(3) — Linux manual page

io_uring_free_buf_ring(3)    liburing Manual   io_uring_free_buf_ring(3)

NAME

       io_uring_free_buf_ring - register and free a buffer ring for
       provided buffers

SYNOPSIS

       #include <liburing.h>

       int io_uring_free_buf_ring(struct io_uring *ring,
                                  struct io_uring_buf_ring *br,
                                  unsigned int nentries,
                                  int bgid);

DESCRIPTION

       The io_uring_free_buf_ring(3) function unregisters a previously
       registered shared buffer ring. The ring must have heen previously
       returned from io_uring_setup_buf_ring(3).

       The ring argument must pointer to the ring for which the provided
       buffer ring is being registered, br must point to a buffer ring
       previously returned by io_uring_setup_buf_ring(3), nentries is
       the number of entries requested in the buffer ring, and bgid is
       the buffer group ID that br was setup with.

       Under the covers, this function uses
       io_uring_unregister_buf_ring(3) to unregister the ring, and
       handles the freeing of the ring rather than letting the
       application open code it.

       Available since 5.19.

RETURN VALUE

       On success io_uring_free_buf_ring(3) returns a pointer to the
       buffe ring. On failure it returns -errno.

SEE ALSO

       io_uring_setup_buf_ring(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.4                  Mar 07, 2023     io_uring_free_buf_ring(3)

Pages that refer to this page: io_uring_free_buf_ring(3), io_uring_setup_buf_ring(3)

---