io_uring_memory_size_params(3) — Linux manual page

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

io_uring_m...size_params(3)  liburing Manual  io_uring_m...size_params(3)

NAME         top

       io_uring_memory_size_params - get memory size needed for a ring
       with params

SYNOPSIS         top

       #include <liburing.h>

       ssize_t io_uring_memory_size_params(unsigned entries, struct io_uring_params *p);

DESCRIPTION         top

       The io_uring_memory_size_params(3) function returns the total
       memory size needed for an io_uring ring with entries entries and
       the parameters specified in p.

       This is useful for applications that want to pre-allocate memory
       for a ring or want to know the memory footprint before creating a
       ring.

       This function provides more control than io_uring_memory_size(3)
       by allowing the caller to specify full ring parameters including
       CQ size via p->cq_entries when IORING_SETUP_CQSIZE is set in
       p->flags.

RETURN VALUE         top

       Returns the required memory size in bytes on success, or a
       negative errno value on error.

       -EINVAL
              Invalid entries value (0 or too large without
              IORING_SETUP_CLAMP).

SEE ALSO         top

       io_uring_memory_size(3), io_uring_mlock_size_params(3),
       io_uring_queue_init_params(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.11                January 18, 2025 io_uring_m...size_params(3)

Pages that refer to this page: io_uring_memory_size_params(3)io_uring_mlock_size_params(3)