polyphony 1.0 → 1.0.2

data/vendor/liburing/man/io_uring_buf_ring_add.3

@@ -1,53 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_buf_ring_add 3 "May 18, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_buf_ring_add \- add buffers to a shared buffer ring
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_buf_ring_add(struct io_uring_buf_ring *" br ",
-.BI "                           void *" addr ",
-.BI "                           unsigned int " len ",
-.BI "                           unsigned short " bid ",
-.BI "                           int " mask ",
-.BI "                           int " buf_offset ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_buf_ring_add (3)
-adds a new buffer to the shared buffer ring
-.IR br .
-The buffer address is indicated by
-.I addr
-and is of
-.I len
-bytes of length.
-.I bid
-is the buffer ID, which will be returned in the CQE.
-.I mask
-is the size mask of the ring, available from
-.BR io_uring_buf_ring_mask (3) .
-.I buf_offset
-is the offset to insert at from the current tail. If just one buffer is provided
-before the ring tail is committed with
-.BR io_uring_buf_ring_advance (3)
-or
-.BR io_uring_buf_ring_cq_advance (3),
-then
-.I buf_offset
-should be 0. If buffers are provided in a loop before being committed, the
-.I buf_offset
-must be incremented by one for each buffer added.
-
-.SH RETURN VALUE
-None
-.SH SEE ALSO
-.BR io_uring_register_buf_ring (3),
-.BR io_uring_buf_ring_mask (3),
-.BR io_uring_buf_ring_advance (3),
-.BR io_uring_buf_ring_cq_advance (3)

data/vendor/liburing/man/io_uring_buf_ring_advance.3

@@ -1,31 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_buf_ring_advance 3 "May 18, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_buf_ring_advance \- advance index of provided buffer in buffer ring
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_buf_ring_advance(struct io_uring_buf_ring *" br ",
-.BI "                               int " count ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_buf_ring_advance (3)
-commits
-.I count
-previously added buffers to the shared buffer ring
-.IR br ,
-making them visible to the kernel and hence consumable. This passes ownership
-of the buffer to the ring.
-
-.SH RETURN VALUE
-None
-.SH SEE ALSO
-.BR io_uring_register_buf_ring (3),
-.BR io_uring_buf_ring_add (3),
-.BR io_uring_buf_ring_cq_advance (3)

data/vendor/liburing/man/io_uring_buf_ring_cq_advance.3

@@ -1,41 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_buf_ring_cq_advance 3 "May 18, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_buf_ring_cq_advance \- advance index of provided buffer and CQ ring
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_buf_ring_cq_advance(struct io_uring *" ring ",
-.BI "                                  struct io_uring_buf_ring *" br ",
-.BI "                                  int " count ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_buf_ring_cq_advance (3)
-commits
-.I count
-previously added buffers to the shared buffer ring
-.IR br ,
-making them visible to the kernel and hence consumable. This passes ownership
-of the buffer to the ring. At the same time, it advances the CQ ring of
-.I ring
-by
-.I count
-amount. This effectively bundles both a
-.BR io_uring_buf_ring_advance (3)
-call and a
-.BR io_uring_cq_avance (3)
-into one operation. Since updating either ring index entails a store memory
-barrier, doing both at once is more efficient.
-
-.SH RETURN VALUE
-None
-.SH SEE ALSO
-.BR io_uring_register_buf_ring (3),
-.BR io_uring_buf_ring_add (3),
-.BR io_uring_buf_ring_advance (3)

data/vendor/liburing/man/io_uring_buf_ring_init.3

@@ -1,30 +0,0 @@
-.\" Copyright (C) 2022 Dylan Yudaken <dylany@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_buf_ring_init 3 "June 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_buf_ring_init \- Initialise a  buffer ring
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_buf_ring_init(struct io_uring_buf_ring *" br ");"
-.fi
-.SH DESCRIPTION
-.PP
-.BR io_uring_buf_ring_init (3)
-initialises
-.IR br
-so that it is ready to be used. It may be called after
-.BR io_uring_register_buf_ring (3)
-but must be called before the buffer ring is used in any other way.
-
-.SH RETURN VALUE
-None
-
-.SH SEE ALSO
-.BR io_uring_register_buf_ring (3),
-.BR io_uring_buf_ring_add (3)
-.BR io_uring_buf_ring_advance (3),
-.BR io_uring_buf_ring_cq_advance (3)

data/vendor/liburing/man/io_uring_buf_ring_mask.3

@@ -1,27 +0,0 @@
-.\" Copyright (C) 2022 Dylan Yudaken <dylany@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_buf_ring_mask 3 "June 13, 2022" "liburing-2.2" "liburing Manual"
-.SH NAME
-io_uring_buf_ring_mask \- Calculate buffer ring mask size
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_buf_ring_mask(__u32 " ring_entries ");"
-.fi
-.SH DESCRIPTION
-.PP
-.BR io_uring_buf_ring_mask (3)
-calculates the appropriate size mask for a buffer ring.
-.IR ring_entries
-is the ring entries as specified in
-.BR io_uring_register_buf_ring (3) .
-
-.SH RETURN VALUE
-Size mask for the buffer ring.
-
-.SH SEE ALSO
-.BR io_uring_register_buf_ring (3),
-.BR io_uring_buf_ring_add (3)

data/vendor/liburing/man/io_uring_check_version.3

@@ -1,72 +0,0 @@
-.\" Copyright (C) 2022 Christian Hergert <chergert@redhat.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_check_version 3 "December 1, 2022" "liburing-2.4" "liburing Manual"
-.SH NAME
-io_uring_check_version \- functions and macros to check the liburing version
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "bool io_uring_check_version(int " major ", int " minor ");"
-.BI "IO_URING_CHECK_VERSION(" major ", " minor ");"
-.PP
-.BI "int io_uring_major_version(void);"
-.BI "IO_URING_VERSION_MAJOR;"
-.PP
-.BI "int io_uring_minor_version(void);"
-.BI "IO_URING_VERSION_MINOR;"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_check_version (3)
-function returns
-.I true
-if the liburing library loaded by the dynamic linker is greater-than
-or equal-to the
-.I major
-and
-.I minor
-numbers provided.
-
-.PP
-The
-.BR IO_URING_CHECK_VERSION (3)
-macro returns
-.I 1
-if the liburing library being compiled against is greater-than or equal-to the
-.I major
-and
-.I minor
-numbers provided.
-
-.PP
-The
-.BR io_uring_major_version (3)
-function returns the
-.I major
-version number of the liburing library loaded by the dynamic linker.
-
-.PP
-The
-.BR IO_URING_VERSION_MAJOR (3)
-macro returns the
-.I major
-version number of the liburing library being compiled against.
-
-.PP
-The
-.BR io_uring_minor_version (3)
-function returns the
-.I minor
-version number of the liburing library loaded by the dynamic linker.
-
-.PP
-The
-.BR IO_URING_VERSION_MINOR (3)
-macro returns the
-.I minor
-version number of the liburing library being compiled against.
-

data/vendor/liburing/man/io_uring_close_ring_fd.3

@@ -1,43 +0,0 @@
-.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
-.\" Copyright (C) 2022 Josh Triplett <josh@joshtriplett.org>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_close_ring_fd 3 "September 25, 2022" "liburing-2.4" "liburing Manual"
-.SH NAME
-io_uring_close_ring_fd \- close a ring file descriptor and use it only via registered index
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "int io_uring_close_ring_fd(struct io_uring *" ring ");"
-.fi
-.SH DESCRIPTION
-.PP
-.BR io_uring_close_ring_fd (3)
-closes the ring file descriptor, which must have been previously registered.
-The file will remain open, but accessible only via the registered index, not
-via any file descriptor. Subsequent liburing calls will continue to work, using
-the registered ring fd.
-
-The kernel must support
-.BR IORING_FEAT_REG_REG_RING .
-
-Libraries that must avoid disrupting their users' uses of file descriptors, and
-must continue working even in the face of
-.BR close_range (2)
-and similar, can use
-.BR io_uring_close_ring_fd (3)
-to work with liburing without having any open file descriptor.
-
-.SH NOTES
-Each thread that wants to make use of io_uring must register the fd. A library
-that may get called from arbitrary theads may need to detect when it gets
-called on a previously unseen thread and create and register a ring for that
-thread.
-.SH RETURN VALUE
-Returns 1 on success, or
-.BR -errno
-on error.
-.SH SEE ALSO
-.BR io_uring_register_ring_fd (3)

data/vendor/liburing/man/io_uring_cq_advance.3

@@ -1,49 +0,0 @@
-.\" Copyright (C) 2022 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_cq_advance 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_cq_advance \- mark one or more io_uring completion events as consumed
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_cq_advance(struct io_uring *" ring ","
-.BI "                          unsigned " nr ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_cq_advance (3)
-function marks
-.I nr
-IO completions belonging to the
-.I ring
-param as consumed.
-
-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),
-.BR io_uring_peek_cqe (3),
-or any of the other CQE retrieval helpers, and mark it as consumed with
-.BR io_uring_cqe_seen (3).
-
-The function
-.BR io_uring_cqe_seen (3)
-calls the function
-.BR io_uring_cq_advance (3).
-
-Completions must be marked as seen, so their slot can get reused. Failure to do
-so will result in the same completion being returned on the next invocation.
-
-.SH RETURN VALUE
-None
-.SH SEE ALSO
-.BR io_uring_submit (3),
-.BR io_uring_wait_cqe (3),
-.BR io_uring_peek_cqe (3),
-.BR io_uring_wait_cqes (3),
-.BR io_uring_wait_cqe_timeout (3),
-.BR io_uring_cqe_seen (3)

data/vendor/liburing/man/io_uring_cq_has_overflow.3

@@ -1,25 +0,0 @@
-.\" Copyright (C) 2022 Dylan Yudaken <dylany@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_cq_has_overflow 3 "September 5, 2022" "liburing-2.3" "liburing Manual"
-.SH NAME
-io_uring_cq_has_overflow \- returns if there are overflow entries waiting to move to the CQ ring
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "bool io_uring_cq_has_overflow(const struct io_uring *" ring ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_cq_has_overflow (3)
-function informs the application if CQ entries have overflowed and are waiting to be flushed to
-the CQ ring. For example using
-.BR io_uring_get_events (3)
-.
-.SH RETURN VALUE
-True if there are CQ entries waiting to be flushed to the CQ ring.
-.SH SEE ALSO
-.BR io_uring_get_events (3)

data/vendor/liburing/man/io_uring_cq_ready.3

@@ -1,26 +0,0 @@
-.\" Copyright (C) 2022 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_cq_ready 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_cq_ready \- returns number of unconsumed ready entries in the CQ ring
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "unsigned io_uring_cq_ready(const struct io_uring *" ring ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_cq_ready (3)
-function returns the number of unconsumed entries that are ready belonging to the
-.I ring
-param.
-
-.SH RETURN VALUE
-Returns the number of unconsumed ready entries in the CQ ring.
-.SH SEE ALSO
-.BR io_uring_submit (3),
-.BR io_uring_wait_cqe (3)

data/vendor/liburing/man/io_uring_cqe_get_data.3

@@ -1,53 +0,0 @@
-.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_cqe_get_data 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_cqe_get_data \- get user data for completion event
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void *io_uring_cqe_get_data(struct io_uring_cqe *" cqe ");"
-.BI "
-.BI "__u64 io_uring_cqe_get_data64(struct io_uring_cqe *" cqe ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_cqe_get_data (3)
-function returns the user_data with the completion queue entry
-.IR cqe
-as a data pointer.
-
-The
-.BR io_uring_cqe_get_data64 (3)
-function returns the user_data with the completion queue entry
-.IR cqe
-as a 64-bit data value.
-
-After the caller has received a completion queue entry (CQE) with
-.BR io_uring_wait_cqe (3),
-the application can call
-.BR io_uring_cqe_get_data (3)
-or
-.BR io_uring_cqe_get_data64 (3)
-function to retrieve the
-.I user_data
-value. This requires that
-.I user_data
-has been set earlier with the function
-.BR io_uring_sqe_set_data (3)
-or
-.BR io_uring_sqe_set_data64 (3).
-
-.SH RETURN VALUE
-If the
-.I user_data
-value has been set before submitting the request, it will be returned.
-Otherwise the functions returns NULL.
-.SH SEE ALSO
-.BR io_uring_get_sqe (3),
-.BR io_uring_sqe_set_data (3),
-.BR io_uring_sqe_submit (3)

data/vendor/liburing/man/io_uring_cqe_get_data64.3

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

data/vendor/liburing/man/io_uring_cqe_seen.3

@@ -1,42 +0,0 @@
-.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
-.\"
-.\" SPDX-License-Identifier: LGPL-2.0-or-later
-.\"
-.TH io_uring_cqe_seen 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
-.SH NAME
-io_uring_cqe_seen \- mark io_uring completion event as consumed
-.SH SYNOPSIS
-.nf
-.B #include <liburing.h>
-.PP
-.BI "void io_uring_cqe_seen(struct io_uring *" ring ","
-.BI "                       struct io_uring_cqe *" cqe ");"
-.fi
-.SH DESCRIPTION
-.PP
-The
-.BR io_uring_cqe_seen (3)
-function marks the IO completion
-.I cqe
-belonging to the
-.I ring
-param as consumed.
-
-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),
-.BR io_uring_peek_cqe (3),
-or any of the other CQE retrieval helpers, and mark it as consumed with
-.BR io_uring_cqe_seen (3).
-
-Completions must be marked as completed so their slot can get reused.
-.SH RETURN VALUE
-None
-.SH SEE ALSO
-.BR io_uring_submit (3),
-.BR io_uring_wait_cqe (3),
-.BR io_uring_peek_cqe (3),
-.BR io_uring_wait_cqes (3),
-.BR io_uring_wait_cqe_timeout (3),
-.BR io_uring_cqe_seen (3)