io_uring_prep_linkat(3) — Linux manual page

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

io_uring_prep_linkat(3)      liburing Manual     io_uring_prep_linkat(3)

NAME         top

       io_uring_prep_linkat - prepare a linkat request

SYNOPSIS         top

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

       void io_uring_prep_linkat(struct io_uring_sqe *sqe,
                                 int olddirfd,
                                 const char *oldpath,
                                 int newdirfd,
                                 const char *newpath,
                                 int flags);

       void io_uring_prep_link(struct io_uring_sqe *sqe,
                               const char *oldpath,
                               const char *newpath,
                               int flags);

DESCRIPTION         top

       The io_uring_prep_linkat(3) function prepares a linkat request.
       The submission queue entry sqe is setup to use the old directory
       file descriptor pointed to by olddirfd and old path pointed to by
       oldpath with the new directory file descriptor pointed to by
       newdirfd and the new path pointed to by newpath and using the
       specified flags in flags.

       The io_uring_prep_link(3) function prepares a link request. The
       submission queue entry sqe is setup to use the old path pointed
       to by oldpath and the new path pointed to by newpath, both
       relative to the current working directory and using the specified
       flags in flags.

       These functions prepare an async linkat(2) or link(2) request.
       See those man pages for details.

RETURN VALUE         top

       None

ERRORS         top

       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         top

       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         top

       io_uring_get_sqe(3), io_uring_submit(3), linkat(2), link(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 2023-12-22.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-12-19.)  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.2                 March 13, 2022      io_uring_prep_linkat(3)

Pages that refer to this page: io_uring_prep_link(3)io_uring_prep_linkat(3)