diff options
author | Gil Cukierman <cukie@google.com> | 2022-10-28 15:33:44 -0400 |
---|---|---|
committer | Gil Cukierman <cukie@google.com> | 2022-10-28 15:39:12 -0400 |
commit | d0a2042580f3ed180db5e2b53029296a8b555115 (patch) | |
tree | ebe9c872e416346e4b333e5062da32401c8e0a73 /man/io_uring_prep_symlinkat.3 | |
parent | d53db6851ea17b2d219d084e1afc683b8b62b105 (diff) | |
parent | dda4848a9911120a903bef6284fb88286f4464c9 (diff) | |
download | liburing-d0a2042580f3ed180db5e2b53029296a8b555115.tar.gz |
Update liburing to version 2.2
Merge branch 'liburingtag2_2' into liburing_upgrade
Test: atest liburing_cpp_tests
Bug: b/253385258
Change-Id: Ia9b4acfce599cd0f7a2ab22999e64d107bc1b96c
Diffstat (limited to 'man/io_uring_prep_symlinkat.3')
-rw-r--r-- | man/io_uring_prep_symlinkat.3 | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/man/io_uring_prep_symlinkat.3 b/man/io_uring_prep_symlinkat.3 new file mode 100644 index 0000000..0fa7056 --- /dev/null +++ b/man/io_uring_prep_symlinkat.3 @@ -0,0 +1,85 @@ +.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk> +.\" +.\" SPDX-License-Identifier: LGPL-2.0-or-later +.\" +.TH io_uring_prep_symlinkat 3 "March 13, 2022" "liburing-2.2" "liburing Manual" +.SH NAME +io_uring_prep_symlinkat \- prepare a symlinkat request +.SH SYNOPSIS +.nf +.B #include <fcntl.h> +.B #include <unistd.h> +.B #include <liburing.h> +.PP +.BI "void io_uring_prep_symlinkat(struct io_uring_sqe *" sqe "," +.BI " const char *" target "," +.BI " int " newdirfd "," +.BI " const char *" linkpath ");" +.PP +.BI "void io_uring_prep_symlink(struct io_uring_sqe *" sqe "," +.BI " const char *" target "," +.BI " const char *" linkpath ");" +.fi +.SH DESCRIPTION +.PP +The +.BR io_uring_prep_symlinkat (3) +function prepares a symlinkat request. The submission queue entry +.I sqe +is setup to symlink the target path pointed to by +.I target +to the new destination indicated by +.I newdirfd +and +.IR linkpath . + +The +.BR io_uring_prep_symlink (3) +function prepares a symlink request. The submission queue entry +.I sqe +is setup to symlink the target path pointed to by +.I target +to the new destination indicated by +.I linkpath +relative to the the current working directory. This function prepares an async +.BR symlink (2) +request. See that man page for details. + +These functions prepare an async +.BR symlinkat (2) +or +.BR symlink (2) +request. See those man pages for details. + +.SH RETURN VALUE +None +.SH ERRORS +The CQE +.I 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 +.B -1 +on failure and set +.I errno +to the actual error value, io_uring never uses +.IR errno . +Instead it returns the negated +.I errno +directly in the CQE +.I res +field. +.SH 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 +.B IORING_FEAT_SUBMIT_STABLE +flag passed back from +.BR io_uring_queue_init_params (3). +.SH SEE ALSO +.BR io_uring_get_sqe (3), +.BR io_uring_submit (3), +.BR symlinkat (2), +.BR symlink (2) |