polyphony 1.0.1 → 1.1

data/vendor/liburing/man/io_uring_prep_socket.3

@@ -1,118 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_socket 3 "May 27, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_socket \- prepare a socket creation request
-.SH SYNOPSIS
-.nf
-.B #include <sys/socket.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_socket(struct io_uring_sqe *" sqe ","
-.BI "                          int " domain ","
-.BI "                          int " type ","
-.BI "                          int " protocol ","
-.BI "                          unsigned int " flags ");"
-.PP
-.BI "void io_uring_prep_socket_direct(struct io_uring_sqe *" sqe ","
-.BI "                                 int " domain ","
-.BI "                                 int " type ","
-.BI "                                 int " protocol ","
-.BI "                                 unsigned int " file_index ","
-.BI "                                 unsigned int " flags ");"
-.PP
-.BI "void io_uring_prep_socket_direct_alloc(struct io_uring_sqe *" sqe ","
-.BI "                                 int " domain ","
-.BI "                                 int " type ","
-.BI "                                 int " protocol ","
-.BI "                                 unsigned int " flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_socket (3)
-function prepares a socket creation request. The submission queue entry
-.I sqe
-is setup to use the communication domain defined by
-.I domain
-and use the communication type defined by
-.I type
-and the protocol set by
-.IR protocol .
-The
-.I flags
-argument are currently unused.
-
-The
-.BR io_uring_prep_socket_direct (3)
-helper works just like
-.BR io_uring_prep_socket (3),
-except it maps the socket to a direct descriptor rather than return a normal
-file descriptor. The
-.I file_index
-argument should be set to the slot that should be used for this socket.
-
-The
-.BR io_uring_prep_socket_direct_alloc (3)
-helper works just like
-.BR io_uring_prep_socket_alloc (3),
-except it allocates a new direct descriptor rather than pass a free slot in. It
-is equivalent to using
-.BR io_uring_prep_socket_direct (3)
-with
-.B IORING_FILE_INDEX_ALLOC
-as the
-.I
-file_index .
-Upon completion, the
-.I res
-field of the CQE will return the direct slot that was allocated for the
-socket.
-
-If the direct variants are used, the application must first have registered
-a file table using
-.BR io_uring_register_files (3)
-of the appropriate size. Once registered, a direct socket request may use any
-entry in that table, as long as it is within the size of the registered table.
-If a specified entry already contains a file, the file will first be removed
-from the table and closed. It's consistent with the behavior of updating an
-existing file with
-.BR io_uring_register_files_update (3).
-
-For a direct descriptor socket request, the
-.I file_index
-argument can be set to
-.BR IORING_FILE_INDEX_ALLOC ,
-In this case a free entry in io_uring file table will
-be used automatically and the file index will be returned as CQE
-.IR res .
-.B -ENFILE
-is otherwise returned if there is no free entries in the io_uring file table.
-
-These functions prepare an async
-.BR socket (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 socket (2)

data/vendor/liburing/man/io_uring_prep_socket_direct.3

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

data/vendor/liburing/man/io_uring_prep_socket_direct_alloc.3

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

data/vendor/liburing/man/io_uring_prep_splice.3

@@ -1,120 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_splice 3 "March 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_splice \- prepare an splice request
-.SH SYNOPSIS
-.nf
-.B #include <fcntl.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_splice(struct io_uring_sqe *" sqe ","
-.BI "                          int " fd_in ","
-.BI "                          int64_t " off_in ","
-.BI "                          int " fd_out ","
-.BI "                          int64_t " off_out ","
-.BI "                          unsigned int " nbytes ","
-.BI "                          unsigned int " splice_flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_splice (3)
-function prepares a splice request. The submission queue entry
-.I sqe
-is setup to use as input the file descriptor
-.I fd_in
-at offset
-.IR off_in ,
-splicing data to the file descriptor at
-.I fd_out
-and at offset
-.IR off_out .
-.I nbytes
-bytes of data should be spliced between the two descriptors.
-.I splice_flags
-are modifier flags for the operation. See
-.BR splice (2)
-for the generic splice flags.
-
-If the
-.I fd_out
-descriptor,
-.B IOSQE_FIXED_FILE
-can be set in the SQE to indicate that. For the input file, the io_uring
-specific
-.B SPLICE_F_FD_IN_FIXED
-can be set in
-.I splice_flags
-and
-.I fd_in
-given as a registered file descriptor offset.
-
-If
-.I fd_in
-refers to a pipe,
-.I off_in
-is ignored and must be set to -1.
-
-If
-.I fd_in
-does not refer to a pipe and
-.I off_in
-is -1, then
-.I nbytes
-are read from
-.I fd_in
-starting from the file offset, which is incremented by the number of bytes read.
-
-If
-.I fd_in
-does not refer to a pipe and
-.I off_in
-is not -1, then the starting offset of
-.I fd_in
-will be
-.IR off_in .
-
-The same rules apply to
-.I fd_out
-and
-.IR off_out .
-
-This function prepares an async
-.BR splice (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 splice (2)
-
-.SH NOTES
-Note that even if
-.I fd_in
-or
-.I fd_out
-refers to a pipe, the splice operation can still fail with
-.B EINVAL
-if one of the fd doesn't explicitly support splice operation, e.g. reading from
-terminal is unsupported from kernel 5.7 to 5.11.

data/vendor/liburing/man/io_uring_prep_statx.3

@@ -1,74 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_statx 3 "March 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_statx \- prepare a statx request
-.SH SYNOPSIS
-.nf
-.B #include <sys/types.h>
-.B #include <sys/stat.h>
-.B #include <unistd.h>
-.B #include <fcntl.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_statx(struct io_uring_sqe *" sqe ","
-.BI "                         int " dirfd ","
-.BI "                         const char *" path ","
-.BI "                         int " flags ","
-.BI "                         unsigned " mask ","
-.BI "                         struct statx *" statxbuf ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_statx (3)
-function prepares a statx request. The submission queue entry
-.I sqe
-is setup to use the directory file descriptor pointed to by
-.I dirfd
-to start a statx operation on the path identified by
-.I path
-and using the flags given in
-.I flags
-for the fields specified by
-.I mask
-and into the buffer located at
-.IR statxbuf .
-
-This function prepares an async
-.BR statx (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 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 statx (2)

data/vendor/liburing/man/io_uring_prep_symlink.3

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

data/vendor/liburing/man/io_uring_prep_symlinkat.3

@@ -1,85 +0,0 @@
-.\" 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)

data/vendor/liburing/man/io_uring_prep_sync_file_range.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_sync_file_range 3 "March 12, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_sync_file_range \- prepare a sync_file_range request
-.SH SYNOPSIS
-.nf
-.B #include <fcntl.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_sync_file_range(struct io_uring_sqe *" sqe ","
-.BI "                                   int " fd ","
-.BI "                                   unsigned " len ","
-.BI "                                   __u64 " offset ","
-.BI "                                   int " flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_sync_file_range (3)
-function prepares a sync_file_range request. The submission queue entry
-.I sqe
-is setup to use the file descriptor
-.I fd
-that should get
-.I len
-bytes synced started at offset
-.I offset
-and with modifier flags in the
-.I flags
-argument.
-
-This function prepares an async
-.BR sync_file_range (2)
-request. See that man page for details on the arguments.
-
-.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 sync_file_range (2)

data/vendor/liburing/man/io_uring_prep_tee.3

@@ -1,74 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_tee 3 "March 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_tee \- prepare a tee request
-.SH SYNOPSIS
-.nf
-.B #include <fcntl.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_tee(struct io_uring_sqe *" sqe ","
-.BI "                       int " fd_in ","
-.BI "                       int " fd_out ","
-.BI "                       unsigned int " nbytes ","
-.BI "                       unsigned int " splice_flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_tee (3)
-function prepares a tee request. The submission queue entry
-.I sqe
-is setup to use as input the file descriptor
-.I fd_in
-and as output the file descriptor
-.I fd_out
-duplicating
-.I nbytes
-bytes worth of data.
-.I splice_flags
-are modifier flags for the operation. See
-.BR tee (2)
-for the generic splice flags.
-
-If the
-.I fd_out
-descriptor,
-.B IOSQE_FIXED_FILE
-can be set in the SQE to indicate that. For the input file, the io_uring
-specific
-.B SPLICE_F_FD_IN_FIXED
-can be set and
-.I fd_in
-given as a registered file descriptor offset.
-
-This function prepares an async
-.BR tee (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 splice (2),
-.BR tee (2)

data/vendor/liburing/man/io_uring_prep_timeout.3

@@ -1,95 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_poll_timeout 3 "March 12, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_timeoute \- prepare a timeout request
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_timeout(struct io_uring_sqe *" sqe ","
-.BI "                           struct __kernel_timespec *" ts ","
-.BI "                           unsigned " count ","
-.BI "                           unsigned " flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_timeout (3)
-function prepares a timeout request. The submission queue entry
-.I sqe
-is setup to arm a timeout specified by
-.I ts
-and with a timeout count of
-.I count
-completion entries. The
-.I flags
-argument holds modifier flags for the request.
-
-This request type can be used as a timeout waking anyone sleeping
-for events on the CQ ring. 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.
-Normally a timeout that triggers would return in a
-.B -ETIME
-CQE
-.I res
-value.
-.PP
-The timeout completion event will trigger if either the specified timeout
-has occurred, or the specified number of events to wait for have been posted
-to the CQ ring.
-
-.SH RETURN VALUE
-None
-.SH ERRORS
-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 clocksources
-where given, or the specified timeout seconds or nanoseconds where < 0.
-.TP
-.B -EFAULT
-io_uring was unable to access the data specified by
-.IR ts .
-.TP
-.B -ECANCELED
-The timeout was canceled by a removal request.
-.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_prep_timeout_remove (3),
-.BR io_uring_prep_timeout_update (3)

data/vendor/liburing/man/io_uring_prep_timeout_remove.3

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