plucky (3) io_uring_prep_unlinkat.3.gz

NAME

       io_uring_prep_unlinkat - prepare an unlinkat request

SYNOPSIS

       #include <fcntl.h>
       #include <unistd.h>
       #include <liburing.h>

       void io_uring_prep_unlinkat(struct io_uring_sqe *sqe,
                                   int dirfd,
                                   const char *path,
                                   int flags);

       void io_uring_prep_unlink(struct io_uring_sqe *sqe,
                                 const char *path,
                                 int flags);

DESCRIPTION

       The  io_uring_prep_unlinkat(3)  function  prepares an unlinkat request. The submission queue entry sqe is
       setup to use the directory file descriptor pointed to by dirfd to start an unlinkat operation on the path
       identified by path and using the flags given in flags.

       The  io_uring_prep_unlink(3) function prepares an unlink request. The submission queue entry sqe is setup
       to start an unlinkat operation on the path identified by path relative to the current  working  directory
       and using the flags given in flags.

       These functions prepare an async unlinkat(2) or unlink(2) request. See those man pages 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

       As with any request that passes in data in a struct, that data must remain valid until  the  request  has
       been  successfully  submitted.  It  need  not  remain  valid  until  completion.  Once a request has been
       submitted, the in-kernel state is stable. Very early kernels (5.4  and  earlier)  required  state  to  be
       stable  until  the  completion  occurred.  Applications  can  test  for  this  behavior by inspecting the
       IORING_FEAT_SUBMIT_STABLE flag passed back from io_uring_queue_init_params(3).

SEE ALSO

       io_uring_get_sqe(3), io_uring_submit(3), unlinkat(2), unlink(2)