io_destroy(2) — Linux manual page

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | VERSIONS | STANDARDS | HISTORY | SEE ALSO | COLOPHON

io_destroy(2)              System Calls Manual             io_destroy(2)

NAME         top

       io_destroy - destroy an asynchronous I/O context

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #include <linux/aio_abi.h>    /* Definition of aio_context_t */
       #include <sys/syscall.h>      /* Definition of SYS_* constants */
       #include <unistd.h>

       int syscall(SYS_io_destroy, aio_context_t ctx_id);

       Note: glibc provides no wrapper for io_destroy(), necessitating
       the use of syscall(2).

DESCRIPTION         top

       Note: this page describes the raw Linux system call interface.
       The wrapper function provided by libaio uses a different type for
       the ctx_id argument.  See VERSIONS.

       The io_destroy() system call will attempt to cancel all
       outstanding asynchronous I/O operations against ctx_id, will
       block on the completion of all operations that could not be
       canceled, and will destroy the ctx_id.

RETURN VALUE         top

       On success, io_destroy() returns 0.  For the failure return, see
       VERSIONS.

ERRORS         top

       EFAULT The context pointed to is invalid.

       EINVAL The AIO context specified by ctx_id is invalid.

       ENOSYS io_destroy() is not implemented on this architecture.

VERSIONS         top

       You probably want to use the io_destroy() wrapper function
       provided by libaio.

       Note that the libaio wrapper function uses a different type
       (io_context_t) for the ctx_id argument.  Note also that the
       libaio wrapper does not follow the usual C library conventions
       for indicating errors: on error it returns a negated error number
       (the negative of one of the values listed in ERRORS).  If the
       system call is invoked via syscall(2), then the return value
       follows the usual conventions for indicating an error: -1, with
       errno set to a (positive) value that indicates the error.

STANDARDS         top

       Linux.

HISTORY         top

       Linux 2.5.

SEE ALSO         top

       io_cancel(2), io_getevents(2), io_setup(2), io_submit(2), aio(7)

COLOPHON         top

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  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
       [email protected]

Linux man-pages 6.9.1          2024-05-02                  io_destroy(2)

Pages that refer to this page: io_cancel(2)io_getevents(2)io_setup(2)io_submit(2)syscalls(2)aio(7)