polyphony 1.0.1 → 1.1

data/vendor/liburing/man/io_uring_prep_recvmsg.3

@@ -1,124 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_recvmsg 3 "March 12, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_recvmsg \- prepare a recvmsg request
-.SH SYNOPSIS
-.nf
-.B #include <sys/types.h>
-.B #include <sys/socket.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_recvmsg(struct io_uring_sqe *" sqe ","
-.BI "                           int " fd ","
-.BI "                           struct msghdr *" msg ","
-.BI "                           unsigned " flags ");"
-.PP
-.BI "void io_uring_prep_recvmsg_multishot(struct io_uring_sqe *" sqe ","
-.BI "                                     int " fd ","
-.BI "                                     struct msghdr *" msg ","
-.BI "                                     unsigned " flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_recvmsg (3)
-function prepares a recvmsg request. The submission queue entry
-.I sqe
-is setup to use the file descriptor
-.I fd
-to start receiving the data indicated by
-.I msg
-with the
-.BR recvmsg (2)
-defined flags in the
-.I flags
-argument.
-
-This function prepares an async
-.BR recvmsg (2)
-request. See that man page for details on the arguments specified to this
-prep helper.
-
-The multishot version allows the application to issue a single receive request,
-which repeatedly posts a CQE when data is available. It requires the
-.B IOSQE_BUFFER_SELECT
-flag to be set and no
-.B MSG_WAITALL
-flag to be set.
-Therefore each CQE will take a buffer out of a provided buffer pool for receiving.
-The application should check the flags of each CQE, regardless of its result.
-If a posted CQE does not have the
-.B IORING_CQE_F_MORE
-flag set then the multishot receive will be done and the application should issue a
-new request.
-
-Unlike
-.BR recvmsg (2),
-multishot recvmsg will prepend a
-.I struct io_uring_recvmsg_out
-which describes the layout of the rest of the buffer in combination with the initial
-.I struct msghdr
-submitted with the request. See
-.BR io_uring_recvmsg_out (3)
-for more information on accessing the data.
-
-Multishot variants are available since kernel 6.0.
-
-After calling this function, additional io_uring internal modifier flags
-may be set in the SQE
-.I ioprio
-field. The following flags are supported:
-.TP
-.B IORING_RECVSEND_POLL_FIRST
-If set, io_uring will assume the socket is currently empty and attempting to
-receive data will be unsuccessful. For this case, io_uring will arm internal
-poll and trigger a receive of the data when the socket has data to be read.
-This initial receive attempt can be wasteful for the case where the socket
-is expected to be empty, setting this flag will bypass the initial receive
-attempt and go straight to arming poll. If poll does indicate that data is
-ready to be received, the operation will proceed.
-
-Can be used with the CQE
-.B IORING_CQE_F_SOCK_NONEMPTY
-flag, which io_uring will set on CQEs after a
-.BR recv (2)
-or
-.BR recvmsg (2)
-operation. If set, the socket still had data to be read after the operation
-completed. Both these flags are available since 5.19.
-.P
-
-.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 recvmsg (2)

data/vendor/liburing/man/io_uring_prep_recvmsg_multishot.3

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

data/vendor/liburing/man/io_uring_prep_remove_buffers.3

@@ -1,52 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_remove_buffers 3 "March 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_remove_buffers \- prepare a remove buffers request
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_remove_buffers(struct io_uring_sqe *" sqe ","
-.BI "                                   int " nr ","
-.BI "                                   int " bgid ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_remove_buffers (3)
-function prepares a request for removing previously supplied buffers. The
-submission queue entry
-.I sqe
-is setup to remove
-.I nr
-number of buffers from the buffer group ID indicated by
-.IR bgid .
-
-.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 removed buffers. 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 -ENOENT
-No buffers exist at the specified
-.I bgid
-buffer group ID.
-.SH SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR io_uring_submit (3),
-.BR io_uring_register (2),
-.BR io_uring_prep_provide_buffers (3)

data/vendor/liburing/man/io_uring_prep_rename.3

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

data/vendor/liburing/man/io_uring_prep_renameat.3

@@ -1,96 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_renameat 3 "March 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_renameat \- prepare a renameat request
-.SH SYNOPSIS
-.nf
-.B #include <fcntl.h>
-.B #include <stdio.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_renameat(struct io_uring_sqe *" sqe ","
-.BI "                            int " olddirfd ","
-.BI "                            const char *" oldpath ","
-.BI "                            int " newdirfd ","
-.BI "                            const char *" newpath ","
-.BI "                            unsigned int " flags ");"
-.PP
-.BI "void io_uring_prep_rename(struct io_uring_sqe *" sqe ","
-.BI "                          const char *" oldpath ","
-.BI "                          const char *" newpath ","
-.BI "                          unsigned int " flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_renameat (3)
-function prepares a renameat 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_rename (3)
-function prepares a rename request. The submission queue entry
-.I sqe
-is setup to use the old path pointed to by
-.I oldpath
-with 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 renameat2 (2)
-or
-.BR rename (2)
-request. If
-.I flags
-is zero, then this call is similar to the
-.BR renameat (2)
-system call. 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 renameat (2),
-.BR renameat2 (2),
-.BR rename (2)

data/vendor/liburing/man/io_uring_prep_send.3

@@ -1,66 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_send 3 "March 12, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_send \- prepare a send request
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_send(struct io_uring_sqe *" sqe ","
-.BI "                        int " sockfd ","
-.BI "                        const void *" buf ","
-.BI "                        size_t " len ","
-.BI "                        int " flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_send (3)
-function prepares a send request. The submission queue entry
-.I sqe
-is setup to use the file descriptor
-.I sockfd
-to start sending the data from
-.I buf
-of size
-.I len
-bytes and with modifier flags
-.IR flags .
-
-Note that using
-.B IOSQE_IO_LINK
-with this request type requires the setting of
-.B MSG_WAITALL
-in the
-.IR flags
-argument, as a short send isn't a considered an error condition without
-that being set.
-
-This function prepares an async
-.BR send (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 send (2)

data/vendor/liburing/man/io_uring_prep_send_set_addr.3

@@ -1,38 +0,0 @@
-.\" Copyright (C) 2023 Rutvik Patel <heyrutvik@gmail.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_send_set_addr 3 "January 23, 2023" "liburing-2.4" "liburing Manual"
-.SH NAME
-io_uring_prep_send_set_addr \- set address details for send requests
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_send_set_addr(struct io_uring_sqe *" sqe ","
-.BI "                                 const struct sockaddr *" dest_addr ","
-.BI "                                 __u16 " addr_len ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_send_set_addr (3)
-function sets a socket destination address specified by
-.I dest_addr
-and its length using
-.I addr_len
-parameters. It can be used once 
-.I sqe
-is prepared using any of the
-.BR send (2)
-io_uring helpers. See man pages of
-.BR io_uring_prep_send (3)
-or
-.BR io_uring_prep_send_zc (3).
-.SH RETURN VALUE
-None
-.SH SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR io_uring_prep_send (3),
-.BR io_uring_prep_send_zc (3),
-.BR send (2)

data/vendor/liburing/man/io_uring_prep_send_zc.3

@@ -1,96 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_send_zc 3 "September 6, 2022" "liburing-2.3" "liburing Manual"
-.SH NAME
-io_uring_prep_send_zc \- prepare a zerocopy send request
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_send_zc(struct io_uring_sqe *" sqe ","
-.BI "                           int " sockfd ","
-.BI "                           const void *" buf ","
-.BI "                           size_t " len ","
-.BI "                           int " flags ","
-.BI "                           unsigned " zc_flags ");"
-.PP
-.BI "void io_uring_prep_send_zc_fixed(struct io_uring_sqe *" sqe ","
-.BI "                                 int " sockfd ","
-.BI "                                 const void *" buf ","
-.BI "                                 size_t " len ","
-.BI "                                 int " flags ","
-.BI "                                 unsigned " zc_flags ");"
-.BI "                                 unsigned " buf_index ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_send_zc (3)
-function prepares a zerocopy send request. The submission queue entry
-.I sqe
-is setup to use the file descriptor
-.I sockfd
-to start sending the data from
-.I buf
-of size
-.I len
-bytes with send modifier flags
-.I flags
-and zerocopy modifier flags
-.IR zc_flags .
-
-The 
-.BR io_uring_prep_send_zc_fixed (3)
-works just like
-.BR io_uring_prep_send_zc (3)
-except it requires the use of buffers that have been registered with 
-.BR io_uring_register_buffers (3).
-The
-.I buf
-and
-.I len
-arguments must fall within a region specified by
-.I buf_index
-in the previously registered buffer. The buffer need not be aligned with the 
-start of the registered buffer.
-
-Note that using
-.B IOSQE_IO_LINK
-with this request type requires the setting of
-.B MSG_WAITALL
-in the
-.I flags
-argument, as a short send isn't considered an error condition without
-that being set.
-
-These functions prepare an async zerocopy
-.BR send (2)
-request. See that man page for details. For details on the zerocopy nature
-of it, see
-.BR io_uring_enter (2) .
-
-.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_prep_send (3),
-.BR io_uring_enter (2),
-.BR send (2)

data/vendor/liburing/man/io_uring_prep_send_zc_fixed.3

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

data/vendor/liburing/man/io_uring_prep_sendmsg.3

@@ -1,89 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_sendmsg 3 "March 12, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_sendmsg \- prepare a sendmsg request
-.SH SYNOPSIS
-.nf
-.B #include <sys/types.h>
-.B #include <sys/socket.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_sendmsg(struct io_uring_sqe *" sqe ","
-.BI "                           int " fd ","
-.BI "                           const struct msghdr *" msg ","
-.BI "                           unsigned " flags ");"
-.PP
-.BI "void io_uring_prep_sendmsg_zc(struct io_uring_sqe *" sqe ","
-.BI "                              int " fd ","
-.BI "                              const struct msghdr *" msg ","
-.BI "                              unsigned " flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_sendmsg (3)
-function prepares a sendmsg request. The submission queue entry
-.I sqe
-is setup to use the file descriptor
-.I fd
-to start sending the data indicated by
-.I msg
-with the
-.BR sendmsg (2)
-defined flags in the
-.I flags
-argument.
-
-The
-.BR io_uring_prep_sendmsg_zc (3)
-accepts the same parameters as 
-.BR io_uring_prep_sendmsg (3)
-but prepares a zerocopy sendmsg request.
-
-Note that using
-.B IOSQE_IO_LINK
-with this request type requires the setting of
-.B MSG_WAITALL
-in the
-.I flags
-argument, as a short send isn't considered an error condition without
-that being set.
-
-This function prepares an async
-.BR sendmsg (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 sendmsg (2)

data/vendor/liburing/man/io_uring_prep_sendmsg_zc.3

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

data/vendor/liburing/man/io_uring_prep_setxattr.3

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

data/vendor/liburing/man/io_uring_prep_shutdown.3

@@ -1,53 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_prep_shutdown 3 "March 12, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_prep_shutdown \- prepare a shutdown request
-.SH SYNOPSIS
-.nf
-.B #include <sys/socket.h>
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_prep_shutdown(struct io_uring_sqe *" sqe ","
-.BI "                            int " sockfd ","
-.BI "                            int " how ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_prep_shutdown (3)
-function prepares a shutdown request. The submission queue entry
-.I sqe
-is setup to use the file descriptor
-.I sockfd
-that should be shutdown with the
-.I how
-argument.
-
-This function prepares an async
-.BR shutdown (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 shutdown (2)