polyphony 1.0 → 1.0.2

data/vendor/liburing/man/io_uring_prep_fadvise.3

@@ -1,59 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_fadvise 3 "March 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_fadvise \- prepare a fadvise request
-.SH SYNOPSIS
-.nf
-.B #include <fcntl.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_fadvise(struct io_uring_sqe *" sqe ","
-.BI "                           int " fd ","
-.BI "                           __u64 " offset ","
-.BI "                           off_t " len ","
-.BI "                           int " advice ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_fadvise (3)
-function prepares an fadvise request. The submission queue entry
-.I sqe
-is setup to use the file descriptor pointed to by
-.I fd
-to start an fadvise operation at
-.I offset
-and of
-.I len
-length in bytes, giving it the advise located in
-.IR advice .
-
-This function prepares an async
-.BR posix_fadvise (2)
-request. See that man page 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 SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR io_uring_submit (3),
-.BR io_uring_register (2),
-.BR posix_fadvise (2)

data/vendor/liburing/man/io_uring_prep_fallocate.3

@@ -1,59 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_fallocate 3 "March 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_fallocate \- prepare a fallocate request
-.SH SYNOPSIS
-.nf
-.B #include <fcntl.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_fallocate(struct io_uring_sqe *" sqe ","
-.BI "                             int " fd ","
-.BI "                             int " mode ","
-.BI "                             off_t " offset ","
-.BI "                             off_t " len ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_fallocate (3)
-function prepares a fallocate request. The submission queue entry
-.I sqe
-is setup to use the file descriptor pointed to by
-.I fd
-to start a fallocate operation described by
-.I mode
-at offset
-.I offset
-and
-.I len
-length in bytes.
-
-This function prepares an async
-.BR fallocate (2)
-request. See that man page 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 SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR io_uring_submit (3),
-.BR fallocate (2)

data/vendor/liburing/man/io_uring_prep_fgetxattr.3

@@ -1 +0,0 @@
-io_uring_prep_getxattr.3

data/vendor/liburing/man/io_uring_prep_files_update.3

@@ -1,92 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_files_update 3 "March 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_files_update \- prepare a registered file update request
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_files_update(struct io_uring_sqe *" sqe ","
-.BI "                                int *" fds ","
-.BI "                                unsigned " nr_fds ","
-.BI "                                int " offset ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_files_update (3)
-function prepares a request for updating a number of previously registered file
-descriptors. The submission queue entry
-.I sqe
-is setup to use the file descriptor array pointed to by
-.I fds
-and of
-.I nr_fds
-in length to update that amount of previously registered files starting at
-offset
-.IR offset .
-
-Once a previously registered file is updated with a new one, the existing
-entry is updated and then removed from the table. This operation is equivalent to
-first unregistering that entry and then inserting a new one, just bundled into
-one combined operation.
-
-If
-.I offset
-is specified as IORING_FILE_INDEX_ALLOC, io_uring will allocate free direct
-descriptors instead of having the application to pass, and store allocated
-direct descriptors into
-.I fds
-array,
-.I cqe->res
-will return the number of direct descriptors allocated.
-
-.SH RETURN VALUE
-None
-.SH ERRORS
-These are the errors that are reported in the CQE
-.I res
-field. On success,
-.I res
-will contain the number of successfully updated file descriptors. On error,
-the following errors can occur.
-.TP
-.B -ENOMEM
-The kernel was unable to allocate memory for the request.
-.TP
-.B -EINVAL
-One of the fields set in the SQE was invalid.
-.TP
-.B -EFAULT
-The kernel was unable to copy in the memory pointed to by
-.IR fds .
-.TP
-.B -EBADF
-On of the descriptors located in
-.I fds
-didn't refer to a valid file descriptor, or one of the file descriptors in
-the array referred to an io_uring instance.
-.TP
-.B -EOVERFLOW
-The product of
-.I offset
-and
-.I nr_fds
-exceed the valid amount or overflowed.
-.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 io_uring_register (2)

data/vendor/liburing/man/io_uring_prep_fsetxattr.3

@@ -1 +0,0 @@
-io_uring_prep_setxattr.3

data/vendor/liburing/man/io_uring_prep_fsync.3

@@ -1,70 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_fsync 3 "March 12, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_fsync \- prepare an fsync request
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_fsync(struct io_uring_sqe *" sqe ","
-.BI "                         int " fd ","
-.BI "                         unsigned " flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_fsync (3)
-function prepares an fsync request. The submission queue entry
-.I sqe
-is setup to use the file descriptor
-.I fd
-that should get synced, with the modifier flags indicated by the
-.I flags
-argument.
-
-This function prepares an fsync request. It can act either like an
-.BR fsync (2)
-operation, which is the default behavior. If
-.B IORING_FSYNC_DATASYNC
-is set in the
-.I flags
-argument, then it behaves like
-.BR fdatasync (2).
-If no range is specified, the
-.I fd
-will be synced from 0 to end-of-file.
-
-It's possible to specify a range to sync, if one is desired. If the
-.I off
-field of the SQE is set to non-zero, then that indicates the offset to
-start syncing at. If
-.I len
-is set in the SQE, then that indicates the size in bytes to sync from the
-offset. Note that these fields are not accepted by this helper, so they have
-to be set manually in the SQE after calling this prep helper.
-
-.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 SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR io_uring_submit (3),
-.BR fsync (2),
-.BR fdatasync (2)

data/vendor/liburing/man/io_uring_prep_getxattr.3

@@ -1,61 +0,0 @@
-.\" Copyright (C) 2023 Rutvik Patel <heyrutvik@gmail.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_getxattr 3 "January 23, 2023" "liburing-2.4" "liburing Manual"
-.SH NAME
-io_uring_prep_getxattr, io_uring_prep_fgetxattr \- prepare a request to get an 
-extended attribute value
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_getxattr(struct io_uring_sqe *" sqe ","
-.BI "                            const char *" name ","
-.BI "                            char *" value ","
-.BI "                            const char *" path ","
-.BI "                            unsigned int " len ");"
-.PP
-.BI "void io_uring_prep_fgetxattr(struct io_uring_sqe *" sqe ","
-.BI "                             int " fd ","
-.BI "                             const char *" name ","
-.BI "                             char *" value ","
-.BI "                             unsigned int " len ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_getxattr (3)
-function prepares a request to get an extended attribute value. The submission 
-queue entry
-.I sqe
-is setup to get the
-.I value
-of the extended attribute identified by
-.I name
-and associated with the given
-.I path
-in the filesystem.
-The
-.I len
-argument specifies the size (in bytes) of
-.IR value .
-
-.BR io_uring_prep_fgetxattr (3)
-is identical to 
-.BR io_uring_prep_getxattr (3),
-only the open file referred to by
-.I fd
-is interrogated in place of
-.IR path .
-
-This function prepares an async 
-.BR getxattr (2)
-request. See that man page for details.
-
-.SH RETURN VALUE
-None
-
-.SH SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR getxattr (2)

data/vendor/liburing/man/io_uring_prep_link.3

@@ -1 +0,0 @@
-io_uring_prep_linkat.3

data/vendor/liburing/man/io_uring_prep_link_timeout.3

@@ -1,94 +0,0 @@
-.\" Copyright (C) 2023 Rutvik Patel <heyrutvik@gmail.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_link_timeout 3 "January 23, 2023" "liburing-2.4" "liburing Manual"
-.SH NAME
-io_uring_prep_link_timeout \- a timeout request for linked sqes
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_link_timeout(struct io_uring_sqe *" sqe ","
-.BI "                                struct __kernel_timespec *" ts ","
-.BI "                                unsigned " flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The 
-.BR io_uring_prep_link_timeout (3)
-function prepares a timeout request for linked sqes. The submission queue entry 
-.I sqe
-is setup a timeout specified by
-.IR ts .
-The flags argument holds modifier
-.I flags
-for the timeout behaviour of the request.
-
-The
-.I ts
-argument must be filled in with the appropriate information for the timeout. It looks as follows:
-.PP
-.in +4n
-.EX
-struct __kernel_timespec {
-    __kernel_time64_t tv_sec;
-    long long tv_nsec;
-};
-.EE
-.in
-.PP
-
-The
-.I flags
-argument may contain:
-.TP
-.B IORING_TIMEOUT_ABS
-The value specified in
-.I ts
-is an absolute value rather than a relative one.
-.TP
-.B IORING_TIMEOUT_BOOTTIME
-The boottime clock source should be used.
-.TP
-.B IORING_TIMEOUT_REALTIME
-The realtime clock source should be used.
-.TP
-.B IORING_TIMEOUT_ETIME_SUCCESS
-Consider an expired timeout a success in terms of the posted completion.
-.PP
-
-It is invalid to create a chain (linked sqes) consisting only of a link timeout 
-request. If all the requests in the chain are completed before timeout, then the 
-link timeout request gets cancelled. Upon timeout, all the uncompleted requests 
-in the chain get cancelled.
-
-.SH RETURN VALUE
-None
-
-.SH ERRORS
-.PP
-These are the errors that are reported in the CQE
-.I res
-field. On success,
-.B 0
-is returned.
-.TP
-.B -ETIME
-The specified timeout occurred and triggered the completion event.
-.TP
-.B -EINVAL
-One of the fields set in the SQE was invalid. For example, two clock sources 
-where given, or the specified timeout seconds or nanoseconds where < 0.
-.TP
-.B -EFAULT
-io_uring was unable to access the data specified by ts.
-.TP
-.B -ECANCELED
-The timeout was canceled because all submitted requests were completed successfully 
-or one of the requests resulted in failure.
-
-
-.SH SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR io_uring_prep_timeout (3)

data/vendor/liburing/man/io_uring_prep_linkat.3

@@ -1,91 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_linkat 3 "March 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_linkat \- prepare a linkat request
-.SH SYNOPSIS
-.nf
-.B #include <fcntl.h>
-.B #include <unistd.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_linkat(struct io_uring_sqe *" sqe ","
-.BI "                          int " olddirfd ","
-.BI "                          const char *" oldpath ","
-.BI "                          int " newdirfd ","
-.BI "                          const char *" newpath ","
-.BI "                          int " flags ");"
-.PP
-.BI "void io_uring_prep_link(struct io_uring_sqe *" sqe ","
-.BI "                        const char *" oldpath ","
-.BI "                        const char *" newpath ","
-.BI "                        int " flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_linkat (3)
-function prepares a linkat request. The submission queue entry
-.I sqe
-is setup to use the old directory file descriptor pointed to by
-.I olddirfd
-and old path pointed to by
-.I oldpath
-with the new directory file descriptor pointed to by
-.I newdirfd
-and the new path pointed to by
-.I newpath
-and using the specified flags in
-.IR flags .
-
-The
-.BR io_uring_prep_link (3)
-function prepares a link request. The submission queue entry
-.I sqe
-is setup to use the old path pointed to by
-.I oldpath
-and the new path pointed to by
-.IR newpath ,
-both relative to the current working directory and using the specified flags in
-.IR flags .
-
-These functions prepare an async
-.BR linkat (2)
-or
-.BR link (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 linkat (2),
-.BR link (2)

data/vendor/liburing/man/io_uring_prep_madvise.3

@@ -1,56 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_madvise 3 "March 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_madvise \- prepare a madvise request
-.SH SYNOPSIS
-.nf
-.B #include <sys/mman.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_madvise(struct io_uring_sqe *" sqe ","
-.BI "                           void *" addr ","
-.BI "                           off_t " len ","
-.BI "                           int " advice ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_madvise (3)
-function prepares an madvise request. The submission queue entry
-.I sqe
-is setup to start an madvise operation at the virtual address of
-.I addr
-and of
-.I len
-length in bytes, giving it the advise located in
-.IR advice .
-
-This function prepares an async
-.BR madvise (2)
-request. See that man page 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 SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR io_uring_submit (3),
-.BR io_uring_register (2),
-.BR madvise (2)

data/vendor/liburing/man/io_uring_prep_mkdir.3

@@ -1 +0,0 @@
-io_uring_prep_mkdirat.3

data/vendor/liburing/man/io_uring_prep_mkdirat.3

@@ -1,83 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_mkdirat 3 "March 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_mkdirat \- prepare an mkdirat request
-.SH SYNOPSIS
-.nf
-.B #include <fcntl.h>
-.B #include <sys/stat.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_mkdirat(struct io_uring_sqe *" sqe ","
-.BI "                           int " dirfd ","
-.BI "                           const char *" path ","
-.BI "                           mode_t " mode ");"
-.PP
-.BI "void io_uring_prep_mkdir(struct io_uring_sqe *" sqe ","
-.BI "                         const char *" path ","
-.BI "                         mode_t " mode ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_mkdirat (3)
-function prepares a mkdirat request. The submission queue entry
-.I sqe
-is setup to use the directory file descriptor pointed to by
-.I dirfd
-to start a mkdirat operation on the path identified by
-.I path
-with the mode given in
-.IR mode .
-
-The
-.BR io_uring_prep_mkdir (3)
-function prepares a mkdir request. The submission queue entry
-.I sqe
-is setup to use the current working directory to start a mkdir
-operation on the path identified by
-.I path
-with the mode given in
-.IR mode .
-
-These functions prepare an async
-.BR mkdir (2)
-or
-.BR mkdirat (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 mkdirat (2),
-.BR mkdir (2)