io_uring_queue_mmap(3) — Linux manual page

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

io_uring_queue_mmap(3)       liburing Manual       io_uring_queue_mmap(3)

NAME         top

       io_uring_queue_mmap - mmap io_uring ring after setup

SYNOPSIS         top

       #include <liburing.h>

       int io_uring_queue_mmap(int fd, struct io_uring_params *p,
                               struct io_uring *ring);

DESCRIPTION         top

       The io_uring_queue_mmap(3) function maps the io_uring ring file
       descriptor fd into memory using the parameters in p.  The
       resulting ring is stored in ring.

       This function is a helper for applications that need to customize
       the ring setup process. Most applications should use
       io_uring_queue_init(3) or io_uring_queue_init_params(3) instead,
       which call io_uring_setup(2) and this function automatically.

       The fd argument should be a file descriptor returned by
       io_uring_setup(2), and p should contain the parameters returned by
       the setup call.

RETURN VALUE         top

       Returns 0 on success, or a negative errno value on error.

SEE ALSO         top

       io_uring_setup(2), io_uring_queue_init(3),
       io_uring_queue_init_params(3), io_uring_queue_exit(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 2026-05-24.  (At that time,
       the date of the most recent commit that was found in the
       repository was 2026-05-18.)  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                 January 18, 2025      io_uring_queue_mmap(3)

Pages that refer to this page: io_uring_queue_mmap(3)