io_uring_register_sync_cancel(3) — Linux manual page


io_uring_r...sync_cancel(3)  liburing Manual io_uring_r...sync_cancel(3)

NAME         top

       io_uring_register_sync_cancel - issue a synchronous cancelation

SYNOPSIS         top

       #include <liburing.h>

       int io_uring_register_sync_cancel(struct io_uring *ring,
                                         struct io_uring_sync_cancel_reg *reg);

DESCRIPTION         top

       The io_uring_register_sync_cancel(3) function performs a
       synchronous cancelation request based on the parameters specified
       in reg .

       The reg argument must be filled in with the appropriate
       information for the cancelation request. It looks as follows:

           struct io_uring_sync_cancel_reg {
               __u64 addr;
               __s32 fd;
               __u32 flags;
               struct __kernel_timespec timeout;
               __u64 pad[4];

       The arguments largely mirror what the async prep functions
       support, see io_uring_prep_cancel(3) for details. Similarly, the
       return value is the same. The exception is the timeout argument,
       which can be used to limit the time that the kernel will wait for
       cancelations to be successful. If the tv_sec and tv_nsec values
       are set to anything but -1UL , then they indicate a relative
       timeout upon which cancelations should be completed by.

       The pad values must be zero filled.

RETURN VALUE         top

       See io_uring_prep_cancel(3) for details on the return value. If
       timeout is set to indicate a timeout, then -ETIME will be
       returned if exceeded. If an unknown value is set in the request,
       or if the pad values are not cleared to zero, then -EINVAL is

SEE ALSO         top


COLOPHON         top

       This page is part of the liburing (A library for io_uring)
       project.  Information about the project can be found at 
       ⟨⟩.  If you have a bug report for
       this manual page, send it to  This page
       was obtained from the project's upstream Git repository
       ⟨⟩ 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

liburing-2.3               September 21, 2022io_uring_r...sync_cancel(3)

Pages that refer to this page: io_uring_register(2)io_uring_register_sync_cancel(3)