polyphony 1.0 → 1.0.2

data/vendor/liburing/man/io_uring_sq_space_left.3

@@ -1,25 +0,0 @@
-.\" Copyright (C) 2022 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_sq_space-left 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_sq_space_left \- free space in the SQ ring
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "unsigned io_uring_sq_space_left(const struct io_uring *" ring ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_sq_space_left (3)
-function returns how much space is left in the SQ ring belonging to the
-.I ring
-param.
-
-.SH RETURN VALUE
-Returns the number of availables entries in the SQ ring.
-.SH SEE ALSO
-.BR io_uring_sq_ready (3)

data/vendor/liburing/man/io_uring_sqe_set_data.3

@@ -1,48 +0,0 @@
-.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_sqe_set_data 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_sqe_set_data \- set user data for submission queue event
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_sqe_set_data(struct io_uring_sqe *" sqe ","
-.BI "                           void *" user_data ");"
-.BI "
-.BI "void io_uring_sqe_set_data64(struct io_uring_sqe *" sqe ","
-.BI "                             __u64 " data ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_sqe_set_data (3)
-function stores a
-.I user_data
-pointer with the submission queue entry
-.IR sqe .
-
-The
-.BR io_uring_sqe_set_data64 (3)
-function stores a 64-bit
-.I data
-value with the submission queue entry
-.IR sqe .
-
-After the caller has requested a submission queue entry (SQE) with
-.BR io_uring_get_sqe (3) ,
-they can associate a data pointer or value with the SQE. Once the completion
-arrives, the function
-.BR io_uring_cqe_get_data (3)
-or
-.BR io_uring_cqe_get_data64 (3)
-can be called to retrieve the data pointer or value associated with the
-submitted request.
-
-.SH RETURN VALUE
-None
-.SH SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR io_uring_cqe_get_data (3)

data/vendor/liburing/man/io_uring_sqe_set_data64.3

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

data/vendor/liburing/man/io_uring_sqe_set_flags.3

@@ -1,87 +0,0 @@
-.\" Copyright (C) 2022 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_sqe_set_flags 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_sqe_set_flags \- set flags for submission queue entry
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_sqe_set_flags(struct io_uring_sqe *" sqe ","
-.BI "                            unsigned " flags ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_sqe_set_flags (3)
-function allows the caller to change the behavior of the submission queue entry
-by specifying flags. It enables the
-.I flags
-belonging to the
-.I sqe
-submission queue entry param.
-
-.I flags
-is a bit mask of 0 or more of the following values ORed together:
-.TP
-.B IOSQE_FIXED_FILE
-The file descriptor in the SQE refers to the index of a previously registered
-file or direct file descriptor, not a normal file descriptor.
-.TP
-.B IOSQE_ASYNC
-Normal operation for io_uring is to try and issue an sqe as non-blocking first,
-and if that fails, execute it in an async manner. To support more efficient
-overlapped operation of requests that the application knows/assumes will
-always (or most of the time) block, the application can ask for an sqe to be
-issued async from the start. Note that this flag immediately causes the SQE
-to be offloaded to an async helper thread with no initial non-blocking attempt.
-This may be less efficient and should not be used liberally or without
-understanding the performance and efficiency tradeoffs.
-.TP
-.B IOSQE_IO_LINK
-When this flag is specified, the SQE forms a link with the next SQE in the
-submission ring. That next SQE will not be started before the previous request
-completes. This, in effect, forms a chain of SQEs, which can be arbitrarily
-long. The tail of the chain is denoted by the first SQE that does not have this
-flag set. Chains are not supported across submission boundaries. Even if the
-last SQE in a submission has this flag set, it will still terminate the current
-chain. This flag has no effect on previous SQE submissions, nor does it impact
-SQEs that are outside of the chain tail. This means that multiple chains can be
-executing in parallel, or chains and individual SQEs. Only members inside the
-chain are serialized. A chain of SQEs will be broken if any request in that
-chain ends in error.
-.TP
-.B IOSQE_IO_HARDLINK
-Like
-.B IOSQE_IO_LINK ,
-except the links aren't severed if an error or unexpected result occurs.
-.TP
-.B IOSQE_IO_DRAIN
-When this flag is specified, the SQE will not be started before previously
-submitted SQEs have completed, and new SQEs will not be started before this
-one completes.
-.TP
-.B IOSQE_CQE_SKIP_SUCCESS
-Request that no CQE be generated for this request, if it completes successfully.
-This can be useful in cases where the application doesn't need to know when
-a specific request completed, if it completed successfully.
-.TP
-.B IOSQE_BUFFER_SELECT
-If set, and if the request types supports it, select an IO buffer from the
-indicated buffer group. This can be used with requests that read or receive
-data from a file or socket, where buffer selection is deferred until the kernel
-is ready to transfer data, instead of when the IO is originally submitted. The
-application must also set the
-.I buf_group
-field in the SQE, indicating which previously registered buffer group to select
-a buffer from.
-
-.SH RETURN VALUE
-None
-.SH SEE ALSO
-.BR io_uring_submit (3),
-.BR io_uring_register (3)
-.BR io_uring_register_buffers (3)
-.BR io_uring_register_buf_ring (3)

data/vendor/liburing/man/io_uring_sqring_wait.3

@@ -1,34 +0,0 @@
-.\" Copyright (C) 2022 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_sqring_wait 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_sqring_wait \- wait for free space in the SQ ring
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_sqring_wait(struct io_uring *" ring ");"
-.fi
-.SH DESCRIPTION
-.PP
-The function
-.BR io_uring_sqring_wait (3)
-allows the caller to wait for space to free up in the SQ ring belonging to the
-.I ring
-param, which happens when the kernel side thread
-has consumed one or more entries. If the SQ ring is currently non-full,
-no action is taken.
-
-This feature can only be used when the ring has been setup with
-.B IORING_SETUP_SQPOLL
-and hence is using an offloaded approach to request submissions.
-
-.SH RETURN VALUE
-On success it returns the free space. If the kernel does not support the
-feature, -EINVAL is returned.
-.SH SEE ALSO
-.BR io_uring_submit (3),
-.BR io_uring_wait_cqe (3),
-.BR io_uring_wait_cqes (3)

data/vendor/liburing/man/io_uring_submit.3

@@ -1,46 +0,0 @@
-.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_submit 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_submit \- submit requests to the submission queue
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_submit(struct io_uring *" ring ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_submit (3)
-function submits the next events to the submission queue belonging to the
-.IR ring .
-
-After the caller retrieves a submission queue entry (SQE) with
-.BR io_uring_get_sqe (3)
-and prepares the SQE using one of the provided helpers, it can be submitted with
-.BR io_uring_submit (3) .
-
-.SH RETURN VALUE
-On success
-.BR io_uring_submit (3)
-returns the number of submitted submission queue entries. On failure it returns
-.BR -errno .
-.SH NOTES
-For 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).
-In general, the man pages for the individual prep helpers will have a note
-mentioning this fact as well, if required for the given command.
-.SH SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR io_uring_submit_and_wait (3),
-.BR io_uring_submit_and_wait_timeout (3)

data/vendor/liburing/man/io_uring_submit_and_get_events.3

@@ -1,31 +0,0 @@
-.\" Copyright (C), 2022  dylany
-.\" You may distribute this file under the terms of the GNU Free
-.\" Documentation License.
-.TH io_uring_submit_and_get_events 3 "September 5, 2022" "liburing-2.3" "liburing Manual"
-.SH NAME
-io_uring_submit_and_get_events \- submit requests to the submission queue and flush completions
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_submit_and_get_events(struct io_uring *" ring ");"
-.fi
-
-.SH DESCRIPTION
-The
-.BR io_uring_submit_and_get_events (3)
-function submits the next events to the submission queue as with
-.BR io_uring_submit (3) .
-After submission it will flush CQEs as with
-.BR io_uring_get_events (3) .
-
-The benefit of this function is that it does both with only one system call.
-
-.SH RETURN VALUE
-On success
-.BR io_uring_submit_and_get_events (3)
-returns the number of submitted submission queue entries. On failure it returns
-.BR -errno .
-.SH SEE ALSO
-.BR io_uring_submit (3),
-.BR io_uring_get_events (3)

data/vendor/liburing/man/io_uring_submit_and_wait.3

@@ -1,38 +0,0 @@
-.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_submit_and_wait 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_submit_and_wait \- submit requests to the submission queue and wait for completion
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_submit_and_wait(struct io_uring *" ring ","
-.BI "                             unsigned " wait_nr ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_submit_and_wait (3)
-function submits the next requests from the submission queue belonging to the
-.I ring
-and waits for
-.I wait_nr
-completion events.
-
-After the caller retrieves a submission queue entry (SQE) with
-.BR io_uring_get_sqe (3)
-and prepares the SQE, it can be submitted with
-.BR io_uring_submit_and_wait (3) .
-
-.SH RETURN VALUE
-On success
-.BR io_uring_submit_and_wait (3)
-returns the number of submitted submission queue entries. On failure it returns
-.BR -errno .
-.SH SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR io_uring_submit (3),
-.BR io_uring_submit_and_wait_timeout (3)

data/vendor/liburing/man/io_uring_submit_and_wait_timeout.3

@@ -1,56 +0,0 @@
-.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_submit_and_wait_timeout 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_submit_and_wait_timeout \- submit requests to the submission queue and
-wait for the completion with timeout
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_submit_and_wait_timeout(struct io_uring *" ring ","
-.BI "                                     struct io_uring_cqe **" cqe_ptr ","
-.BI "                                     unsigned " wait_nr ","
-.BI "                                     struct __kernel_timespec *" ts ","
-.BI "                                     sigset_t *" sigmask ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_submit_and_wait_timeout (3)
-function submits the next requests from the submission queue belonging to the
-.I ring
-and waits for
-.I wait_nr
-completion events, or until the timeout
-.I ts
-expires. The completion events are stored in the
-.I cqe_ptr
-array. The
-.I sigmask
-specifies the set of signals to block. The prevailing signal mask is restored
-before returning.
-
-After the caller retrieves a submission queue entry (SQE) with
-.BR io_uring_get_sqe (3)
-and prepares the SQE, it can be submitted with
-.BR io_uring_submit_and_wait_timeout (3) .
-
-.SH RETURN VALUE
-On success
-.BR io_uring_submit_and_wait_timeout (3)
-returns the number of submitted submission queue entries. On failure it returns
-.BR -errno .
-Note that in earlier versions of the liburing library, the return value was 0
-on success.
-The most common failure case is not receiving a completion within the specified
-timeout,
-.B -ETIME
-is returned in this case.
-.SH SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR io_uring_submit (3),
-.BR io_uring_submit_and_wait (3),
-.BR io_uring_wait_cqe (3)

data/vendor/liburing/man/io_uring_unregister_buf_ring.3

@@ -1,30 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_unregister_buf_ring 3 "May 18, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_unregister_buf_ring \- unregister a previously registered buffer ring
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_unregister_buf_ring(struct io_uring *" ring ",
-.BI "                                 int " bgid ");"
-.BI "
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_unregister_buf_ring (3)
-function unregisters a previously registered shared buffer ring indicated by
-.IR bgid .
-
-.SH RETURN VALUE
-On success
-.BR io_uring_unregister_buf_ring (3)
-returns 0. On failure it returns
-.BR -errno .
-.SH SEE ALSO
-.BR io_uring_register_buf_ring (3),
-.BR io_uring_buf_ring_free (3)

data/vendor/liburing/man/io_uring_unregister_buffers.3

@@ -1,27 +0,0 @@
-.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_unregister_buffers 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_unregister_buffers \- unregister buffers for fixed buffer operations
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_unregister_buffers(struct io_uring *" ring ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_unregister_buffers (3)
-function unregisters the fixed buffers previously registered to the
-.IR ring .
-
-.SH RETURN VALUE
-On success
-.BR io_uring_unregister_buffers (3)
-returns 0. On failure it returns
-.BR -errno .
-.SH SEE ALSO
-.BR io_uring_register_buffers (3)

data/vendor/liburing/man/io_uring_unregister_eventfd.3

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

data/vendor/liburing/man/io_uring_unregister_files.3

@@ -1,27 +0,0 @@
-.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_unregister_files 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_unregister_files \- unregister file descriptors
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_unregister_files(struct io_uring *" ring ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_unregister_files (3)
-function unregisters the file descriptors previously registered to the
-.IR ring .
-
-.SH RETURN VALUE
-On success
-.BR io_uring_unregister_files (3)
-returns 0. On failure it returns
-.BR -errno .
-.SH SEE ALSO
-.BR io_uring_register_files (3)

data/vendor/liburing/man/io_uring_unregister_iowq_aff.3

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

data/vendor/liburing/man/io_uring_unregister_ring_fd.3

@@ -1,32 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_unregister_ring_fd 3 "March 11, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_unregister_ring_fd \- unregister a ring file descriptor
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_unregister_ring_fd(struct io_uring *" ring ");"
-.fi
-.SH DESCRIPTION
-.PP
-.BR io_uring_unregister_ring_fd (3)
-unregisters the file descriptor of the ring.
-
-Unregisters a ring descriptor previously registered with the task. This is
-done automatically when
-.BR io_uring_queue_exit (3)
-is called, but can also be done to free up space for new ring registrations.
-For more information on ring descriptor registration, see
-.BR io_uring_register_ring_fd (3)
-
-.SH RETURN VALUE
-Returns 1 on success, indicating that one file descriptor was unregistered, or
-.BR -errno
-on error.
-.SH SEE ALSO
-.BR io_uring_register_ring_fd (3),
-.BR io_uring_register_files (3)

data/vendor/liburing/man/io_uring_wait_cqe.3

@@ -1,40 +0,0 @@
-.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_wait_cqe 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_wait_cqe \- wait for one io_uring completion event
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_wait_cqe(struct io_uring *" ring ","
-.BI "                      struct io_uring_cqe **" cqe_ptr ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_wait_cqe (3)
-function waits for an IO completion from the queue belonging to the
-.I ring
-param, waiting for it if necessary. If an event is already available in
-the ring when invoked, no waiting will occur. The
-.I cqe_ptr
-param is filled in on success.
-
-After the caller has submitted a request with
-.BR io_uring_submit (3),
-the application can retrieve the completion with
-.BR io_uring_wait_cqe (3).
-
-.SH RETURN VALUE
-On success
-.BR io_uring_wait_cqe (3)
-returns 0 and the cqe_ptr param is filled in. On failure it returns
-.BR -errno .
-The return value indicates the result of waiting for a CQE, and it has no
-relation to the CQE result itself.
-.SH SEE ALSO
-.BR io_uring_submit (3),
-.BR io_uring_wait_cqes (3)

data/vendor/liburing/man/io_uring_wait_cqe_nr.3

@@ -1,43 +0,0 @@
-.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_wait_cqe_nr 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_wait_cqe_nr \- wait for one or more io_uring completion events
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_wait_cqe_nr(struct io_uring *" ring ","
-.BI "                         struct io_uring_cqe **" cqe_ptr ","
-.BI "                         unsigned " wait_nr ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_wait_cqe_nr (3)
-function returns
-.I wait_nr
-IO completion events from the queue belonging to the
-.I ring
-param, waiting for it if necessary. If the requested number of events are
-already available in the ring when invoked, no waiting will occur. The
-.I cqe_ptr
-param is filled in on success.
-
-After the caller has submitted a request with
-.BR io_uring_submit (3),
-the application can retrieve the completion with
-.BR io_uring_wait_cqe (3).
-
-.SH RETURN VALUE
-On success
-.BR io_uring_wait_cqe_nr (3)
-returns 0 and the cqe_ptr param is filled in. On failure it returns
-.BR -errno .
-The return value indicates the result of waiting for a CQE, and it has no
-relation to the CQE result itself.
-.SH SEE ALSO
-.BR io_uring_submit (3),
-.BR io_uring_wait_cqes (3)

data/vendor/liburing/man/io_uring_wait_cqe_timeout.3

@@ -1,53 +0,0 @@
-.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_wait_cqe_timeout 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_wait_cqe_timeout \- wait for one io_uring completion event with timeout
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_wait_cqe_timeout(struct io_uring *" ring ","
-.BI "                              struct io_uring_cqe **" cqe_ptr ","
-.BI "                              struct __kernel_timespec *" ts ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_wait_cqe_timeout (3)
-function waits for one IO completion to be available from the queue belonging
-to the
-.I ring
-param, waiting for it if necessary or until the timeout
-.I ts
-expires. If an event is already available in the ring when invoked, no waiting
-will occur.
-
-The
-.I cqe_ptr
-param is filled in on success.
-
-If
-.I ts
-is specified and an older kernel without
-.B IORING_FEAT_EXT_ARG
-is used, the application does not need to call
-.BR io_uring_submit (3)
-before calling
-.BR io_uring_wait_cqes (3).
-For newer kernels with that feature flag set, there is no implied submit
-when waiting for a request.
-
-.SH RETURN VALUE
-On success
-.BR io_uring_wait_cqe_timeout (3)
-returns 0 and the cqe_ptr param is filled in. On failure it returns
-.BR -errno .
-The return value indicates the result of waiting for a CQE, and it has no
-relation to the CQE result itself.
-.SH SEE ALSO
-.BR io_uring_submit (3),
-.BR io_uring_wait_cqe_timeout (3),
-.BR io_uring_wait_cqe (3)