io_uring_prep_futex_waitv(3) — Linux manual page

io_uring_prep_futex_waitv(3) liburing Manualio_uring_prep_futex_waitv(3)

NAME

       io_uring_prep_futex_waitv - prepare a futex waitv request

SYNOPSIS

       #include <linux/futex.h>
       #include <unistd.h>
       #include <liburing.h>

       void io_uring_prep_futex_waitv(struct io_uring_sqe *sqe,
                                      struct futex_waitv *futexv,
                                      uint32_t nr_futex,
                                      unsigned int flags);

DESCRIPTION

       The io_uring_prep_futex_waitv(3) function prepares a futex wait
       request for multiple futexes at the same time.  The submission
       queue entry sqe is setup for waiting on all futexes given by
       futexv and nr_futex is the number of futexes in that array.
       flags must be set to the io_uring specific futex flags.

       Unlike io_uring_prep_futex_wait(3), the desired bitset mask and
       values are passed in futexv.

       flags are currently unused and hence 0 must be passed.

       This function prepares an async futex(2) waitv request. See that
       man page for details.

RETURN VALUE

       None

ERRORS

       The CQE res field will contain the result of the operation. See
       the related man page for details on possible values. Note that
       where synchronous system calls will return -1 on failure and set
       errno to the actual error value, io_uring never uses errno.
       Instead it returns the negated errno directly in the CQE res
       field.

NOTES

       Unlike the sync futex syscalls that wait on a futex, io_uring
       does not support passing in a timeout for the request. Instead,
       applications are encouraged to use a linked timeout to abort the
       futex request at a given time, if desired.

SEE ALSO

       io_uring_get_sqe(3), io_uring_submit(3),
       io_uring_prep_futex_wait(3), io_uring_prep_futex_wake(3),
       io_uring_prep_link_timeout(3), futex(2) futex2(2)

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.5                  Sep 29, 2023  io_uring_prep_futex_waitv(3)

Pages that refer to this page: io_uring_prep_futex_wait(3), io_uring_prep_futex_waitv(3), io_uring_prep_futex_wake(3)

---