io_uring_close_ring_fd(3) — Linux manual page

io_uring_close_ring_fd(3)    liburing Manual   io_uring_close_ring_fd(3)

NAME         top

       io_uring_close_ring_fd - close a ring file descriptor and use it
       only via registered index

SYNOPSIS         top

       #include <liburing.h>

       int io_uring_close_ring_fd(struct io_uring *ring);

DESCRIPTION         top

       io_uring_close_ring_fd(3) closes the ring file descriptor, which
       must have been previously registered.  The file will remain open,
       but accessible only via the registered index, not via any file
       descriptor. Subsequent liburing calls will continue to work,
       using the registered ring fd.

       The kernel must support IORING_FEAT_REG_REG_RING.

       Libraries that must avoid disrupting their users' uses of file
       descriptors, and must continue working even in the face of
       close_range(2) and similar, can use io_uring_close_ring_fd(3) to
       work with liburing without having any open file descriptor.

NOTES         top

       Each thread that wants to make use of io_uring must register the
       fd. A library that may get called from arbitrary theads may need
       to detect when it gets called on a previously unseen thread and
       create and register a ring for that thread.

RETURN VALUE         top

       Returns 1 on success, or -errno on error.

SEE ALSO         top

       io_uring_register_ring_fd(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 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               September 25, 2022  io_uring_close_ring_fd(3)

Pages that refer to this page: io_uring_close_ring_fd(3)

HTML rendering created 2024-06-26 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.