io_uring_mlock_size(3) — Linux manual page

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

io_uring_mlock_size(3)       liburing Manual       io_uring_mlock_size(3)

NAME         top

       io_uring_mlock_size - get required memlock size for a ring

SYNOPSIS         top

       #include <liburing.h>

       ssize_t io_uring_mlock_size(unsigned entries, unsigned flags);

DESCRIPTION         top

       The io_uring_mlock_size(3) function returns the required
       RLIMIT_MEMLOCK memory size for an io_uring ring with entries
       entries and the specified setup flags.

       On newer kernels (5.12+), io_uring no longer requires any memlock
       memory and this function will return 0. On older kernels (5.11 and
       prior), this returns the required memory so that the caller can
       ensure that enough RLIMIT_MEMLOCK space is available before
       setting up a ring.

       For more control over the ring parameters, use
       io_uring_mlock_size_params(3) instead.

RETURN VALUE         top

       Returns the required memlock size in bytes on success, 0 if no
       memlock is needed, or a negative errno value on error.

SEE ALSO         top

       io_uring_mlock_size_params(3), io_uring_memory_size(3),
       io_uring_queue_init(3), getrlimit(2)

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_mlock_size(3)

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