polyphony 0.85 → 0.86

data/vendor/liburing/man/io_uring_free_probe.3

@@ -0,0 +1,24 @@
+.\" Copyright (C) 2022 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_free_probe "January 25, 2022" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_free_probe - free probe instance
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_free_probe(struct io_uring_probe *probe)"
+.fi
+.PP
+.SH DESCRIPTION
+.PP
+The function io_uring_free_probe() frees the
+.I probe
+instance allocated with the io_uring_get_probe() function.
+
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_get_probe (3)

data/vendor/liburing/man/io_uring_get_probe.3

@@ -0,0 +1,29 @@
+.\" Copyright (C) 2022 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_get_probe "January 25, 2022" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_get_probe - get probe instance
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "io_uring_probe *io_uring_get_probe(void)"
+.fi
+.PP
+.SH DESCRIPTION
+.PP
+The function io_uring_get_probe() returns an allocated io_uring_probe
+structure to the caller. The caller is responsible for freeing the
+structure with the function io_uring_free_probe().
+
+.SH NOTES
+Earlier versions of the Linux kernel do not support probe. If the kernel
+doesn't support probe, this function will return NULL.
+
+.SH RETURN VALUE
+On success it returns an allocated io_uring_probe structure, otherwise
+it returns NULL.
+.SH SEE ALSO
+.BR io_uring_free_probe (3)

data/vendor/liburing/man/io_uring_get_sqe.3

@@ -0,0 +1,38 @@
+.\" Copyright (C) 2020 Jens Axboe <axboe@kernel.dk>
+.\" Copyright (C) 2020 Red Hat, Inc.
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_get_sqe 3 "July 10, 2020" "liburing-0.7" "liburing Manual"
+.SH NAME
+io_uring_get_sqe - get the next available submission queue entry from the
+submission queue
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "struct io_uring_sqe *io_uring_get_sqe(struct io_uring " *ring );
+.fi
+.PP
+.SH DESCRIPTION
+.PP
+The io_uring_get_sqe() function gets the next available submission queue entry
+from the submission queue belonging to the
+.I ring
+param.
+
+On success io_uring_get_sqe() returns a pointer to the submission queue entry.
+On failure NULL is returned.
+
+If a submission queue entry is returned, it should be filled out via one of the
+prep functions such as
+.BR io_uring_prep_read (3)
+and submitted via
+.BR io_uring_submit (3).
+
+.SH RETURN VALUE
+.BR io_uring_get_sqe (3)
+returns a pointer to the next submission queue event on success and NULL on
+failure.
+.SH SEE ALSO
+.BR io_uring_submit (3)

data/vendor/liburing/man/io_uring_opcode_supported.3

@@ -0,0 +1,29 @@
+.\" Copyright (C) 2022 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_opcode_supported "January 25, 2022" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_opcode_supported - is op code supported?
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "int io_uring_opcode_supported(struct io_uring_probe *probe,"
+.BI "                              int opode)
+.fi
+.PP
+.SH DESCRIPTION
+.PP
+The function io_uring_opcode_supported allows the caller to determine if
+the passed in
+.I opcode
+belonging to the
+.I probe
+param is supported. An instance of the io_uring_probe instance can be
+obtained by calling the function io_uring_get_probe().
+
+.SH RETURN VALUE
+On success it returns 1, otherwise it returns 0.
+.SH SEE ALSO
+.BR io_uring_get_probe (3)

data/vendor/liburing/man/io_uring_prep_msg_ring.3

@@ -0,0 +1,58 @@
+.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_prep_msg_ring 3 "March 10, 2022" "liburing-2.2" "liburing Manual"
+.SH NAME
+io_uring_prep_msg_ring   - send a message to another ring
+
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_msg_ring(struct io_uring_sqe *sqe,"
+.BI "                        int fd,"
+.BI "                        unsigned int len,"
+.BI "                        __u64 data,"
+.BI "                        unsigned int flags)"
+
+.SH DESCRIPTION
+.PP
+io_uring_prep_msg_ring() prepares a to send a CQE to an io_uring file
+descriptor. The submission queue entry
+.I sqe
+is setup to use the file descriptor
+.I fd
+, which must identify a io_uring context, to post a CQE on that ring where
+the target CQE
+.BR res
+field will contain the content of
+.I len
+and the
+.BR user_data
+of
+.I data
+with the request modifier flags set by
+.I flags.
+Currently there are no valid flag modifiers, this field must contain
+.B 0.
+
+The targeted ring may be any ring that the user has access to, even the ring
+itself. This request can be used for simple message passing to another ring,
+allowing 32+64 bits of data to be transferred through the
+.I len
+and
+.I data
+fields. The use case may be anything from simply waking up someone waiting
+on the targeted ring, or it can be used to pass messages between the two
+rings.
+
+The resulting CQE posted on the target ring will have
+.B IORING_CQE_F_MSG
+set in its
+.I flags
+member, indicating to the target ring that this CQE is posted without having
+a relationship to an SQE issued on this ring.
+
+.SH RETURN VALUE
+None

data/vendor/liburing/man/io_uring_prep_read.3

@@ -0,0 +1,50 @@
+.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_prep_read 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_prep_read   - prepare I/O read request
+
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_prep_read(struct io_uring_sqe *sqe,"
+.BI "                        int fd,"
+.BI "                        void *buf,"
+.BI "                        unsigned nbytes,"
+.BI "                        __u64 offset)"
+
+.SH DESCRIPTION
+.PP
+The io_uring_prep_read() prepares an IO read request. The submission queue entry
+.I sqe
+is setup to use the file descriptor
+.I fd
+to start reading
+.I nbytes
+into the buffer
+.I buf
+at the specified
+.I offset.
+
+On files that support seeking, if the offset is set to
+.B -1,
+the read operation commences at the file offset, and the file offset is
+incremented by the number of bytes read. See
+.BR read (2)
+for more details. Note that for an async API, reading and updating the
+current file offset may result in unpredictable behavior, unless access
+to the file is serialized. It is not encouraged to use this feature, if it's
+possible to provide the desired IO offset from the application or library.
+
+On files that are not capable of seeking, the offset is ignored.
+
+After the read has been prepared it can be submitted with one of the submit
+functions.
+
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_get_sqe (3), io_uring_prep_readv (3), io_uring_prep_readv2 (3), io_uring_submit(3)

data/vendor/liburing/man/io_uring_prep_read_fixed.3

@@ -0,0 +1,54 @@
+.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_prep_read 3 "February 13, 2022" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_prep_read_fixed   - prepare I/O read request with registered buffer
+
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_prep_read_fixed(struct io_uring_sqe *sqe,"
+.BI "                        int fd,"
+.BI "                        void *buf,"
+.BI "                        unsigned nbytes,"
+.BI "                        __u64 offset,"
+.BI "                        int buf_index)"
+
+.SH DESCRIPTION
+.PP
+The io_uring_prep_read_fixed() prepares an IO read request with a previously
+registered IO buffer. The submission queue entry
+.I sqe
+is setup to use the file descriptor
+.I fd
+to start reading
+.I nbytes
+into the buffer
+.I buf
+at the specified
+.I offset,
+and with the buffer matching the registered index of
+.I buf_index.
+
+This work just like
+.B io_uring_prep_read(3)
+except it requires the user of buffers that have been registered with
+.B io_uring_register_buffers(3). The
+.I buf
+and
+.I nbytes
+arguments must fall within a region specificed by
+.I buf_index.
+in the previously registered buffer. The buffer need not be aligned with
+the start of the registered buffer.
+
+After the read has been prepared it can be submitted with one of the submit
+functions.
+
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_prep_read (3), io_uring_register_buffers (3)

data/vendor/liburing/man/io_uring_prep_readv.3

@@ -0,0 +1,51 @@
+.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_prep_readv 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_prep_readv  - prepare vector I/O read request
+.fi
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_prep_readv(struct io_uring_sqe *sqe,"
+.BI "                         int fd,"
+.BI "                         const struct iovec *iovecs,"
+.BI "                         unsigned nr_vecs,"
+.BI "                         __u64 offset)"
+.PP
+.SH DESCRIPTION
+.PP
+The io_uring_prep_readv() prepares a vectored IO read request. The submission
+queue entry
+.I sqe
+is setup to use the file descriptor
+.I fd
+to start reading
+.I nr_vecs
+into the
+.I iovecs
+array at the specified
+.I offset.
+
+On files that support seeking, if the offset is set to
+.B -1,
+the read operation commences at the file offset, and the file offset is
+incremented by the number of bytes read. See
+.BR read (2)
+for more details. Note that for an async API, reading and updating the
+current file offset may result in unpredictable behavior, unless access
+to the file is serialized. It is not encouraged to use this feature, if it's
+possible to provide the desired IO offset from the application or library.
+
+On files that are not capable of seeking, the offset is ignored.
+
+After the write has been prepared it can be submitted with one of the submit
+functions.
+
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_get_sqe (3), io_uring_prep_read (3), io_uring_prep_readv2 (3), io_uring_submit (3)

data/vendor/liburing/man/io_uring_prep_readv2.3

@@ -0,0 +1,79 @@
+.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_prep_readv2 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
+.SH NAME
+.fi
+io_uring_prep_readv2 - prepare vector I/O read request with flags
+
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_prep_readv2(struct io_uring_sqe *sqe,"
+.BI "                          int fd,"
+.BI "                          const struct iovec *iovecs,"
+.BI "                          unsigned nr_vecs,"
+.BI "                          __u64 offset,"
+.BI "                          int flags)"
+.fi
+.PP
+.SH DESCRIPTION
+.PP
+The io_uring_prep_readv2() prepares a vectored IO read request. The submission
+queue entry
+.I sqe
+is setup to use the file descriptor
+.I fd
+to start reading
+.I nr_vecs
+into the
+.I iovecs
+array at the specified
+.I offset.
+The behavior of the function can be controlled with the
+.I flags
+parameter.
+
+Supported values for
+.I flags
+are:
+.TP
+.B RWF_HIPRI
+High priority request, poll if possible
+.TP
+.B RWF_DSYNC
+per-IO O_DSYNC
+.TP
+.B RWF_SYNC
+per-IO O_SYNC
+.TP
+.B RWF_NOWAIT
+per-IO, return
+.B -EAGAIN
+if operation would block
+.TP
+.B RWF_APPEND
+per-IO O_APPEND
+
+.P
+On files that support seeking, if the offset is set to
+.B -1,
+the read operation commences at the file offset, and the file offset is
+incremented by the number of bytes read. See
+.BR read (2)
+for more details. Note that for an async API, reading and updating the
+current file offset may result in unpredictable behavior, unless access
+to the file is serialized. It is not encouraged to use this feature, if it's
+possible to provide the desired IO offset from the application or library.
+
+On files that are not capable of seeking, the offset is ignored.
+
+After the write has been prepared, it can be submitted with one of the submit
+functions.
+
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_get_sqe (3), io_uring_prep_read (3), io_uring_prep_readv (3), io_uring_submit (3)

data/vendor/liburing/man/io_uring_prep_write.3

@@ -0,0 +1,50 @@
+.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_prep_write 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_prep_write   - prepare I/O write request
+
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_prep_write(struct io_uring_sqe *sqe,"
+.BI "                         int fd,"
+.BI "                         const void *buf,"
+.BI "                         unsigned nbytes,"
+.BI "                         __u64 offset)"
+.PP
+.SH DESCRIPTION
+.PP
+The io_uring_prep_write() prepares an IO write request. The submission queue entry
+.I sqe
+is setup to use the file descriptor
+.I fd
+to start writing
+.I nbytes
+from the buffer
+.I buf
+at the specified
+.I offset.
+
+On files that support seeking, if the offset is set to
+.B -1,
+the write operation commences at the file offset, and the file offset is
+incremented by the number of bytes written. See
+.BR write (2)
+for more details. Note that for an async API, reading and updating the
+current file offset may result in unpredictable behavior, unless access
+to the file is serialized. It is not encouraged to use this feature, if it's
+possible to provide the desired IO offset from the application or library.
+
+On files that are not capable of seeking, the offset is ignored.
+
+After the write has been prepared, it can be submitted with one of the submit
+functions.
+
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_get_sqe (3), io_uring_submit (3)

data/vendor/liburing/man/io_uring_prep_write_fixed.3

@@ -0,0 +1,54 @@
+.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_prep_write 3 "February 13, 2022" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_prep_write_fixed   - prepare I/O write request with registered buffer
+
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_prep_write_fixed(struct io_uring_sqe *sqe,"
+.BI "                        int fd,"
+.BI "                        const void *buf,"
+.BI "                        unsigned nbytes,"
+.BI "                        __u64 offset,"
+.BI "                        int buf_index)"
+
+.SH DESCRIPTION
+.PP
+The io_uring_prep_write_fixed() prepares an IO write request with a previously
+registered IO buffer. The submission queue entry
+.I sqe
+is setup to use the file descriptor
+.I fd
+to start writing
+.I nbytes
+from the buffer
+.I buf
+at the specified
+.I offset,
+and with the buffer matching the registered index of
+.I buf_index.
+
+This work just like
+.B io_uring_prep_write(3)
+except it requires the user of buffers that have been registered with
+.B io_uring_register_buffers(3). The
+.I buf
+and
+.I nbytes
+arguments must fall within a region specificed by
+.I buf_index.
+in the previously registered buffer. The buffer need not be aligned with
+the start of the registered buffer.
+
+After the read has been prepared it can be submitted with one of the submit
+functions.
+
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_prep_write (3), io_uring_register_buffers (3)

data/vendor/liburing/man/io_uring_prep_writev.3

@@ -0,0 +1,51 @@
+.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_prep_writev 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_prep_writev  - prepare vector I/O write request
+
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_prep_writev(struct io_uring_sqe *sqe,"
+.BI "                          int fd,"
+.BI "                          const struct iovec *iovecs,"
+.BI "                          unsigned nr_vecs,"
+.BI "                          __u64 offset)"
+.PP
+.SH DESCRIPTION
+.PP
+The io_uring_prep_writev() prepares a vectored IO write request. The submission
+queue entry
+.I sqe
+is setup to use the file descriptor
+.I fd
+to start writing
+.I nr_vecs
+from the
+.I iovecs
+array at the specified
+.I offset.
+
+On files that support seeking, if the offset is set to
+.B -1,
+the write operation commences at the file offset, and the file offset is
+incremented by the number of bytes written. See
+.BR write (2)
+for more details. Note that for an async API, reading and updating the
+current file offset may result in unpredictable behavior, unless access
+to the file is serialized. It is not encouraged to use this feature, if it's
+possible to provide the desired IO offset from the application or library.
+
+On files that are not capable of seeking, the offset is ignored.
+
+After the write has been prepared it can be submitted with one of the submit
+functions.
+
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_get_sqe (3), io_uring_prep_write (3), io_uring_prep_writev2 (3), io_uring_submit (3)

data/vendor/liburing/man/io_uring_prep_writev2.3

@@ -0,0 +1,78 @@
+.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_prep_writev2 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_prep_writev2 - prepare vector I/O write request with flags
+
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_prep_writev2(struct io_uring_sqe *sqe,"
+.BI "                           int fd,"
+.BI "                           const struct iovec *iovecs,"
+.BI "                           unsigned nr_vecs,"
+.BI "                           __u64 offset,"
+.BI "                           int flags)"
+.fi
+.PP
+.SH DESCRIPTION
+.PP
+The io_uring_prep_writev2() prepares a vectored IO write request. The
+submission queue entry
+.I sqe
+is setup to use the file descriptor
+.I fd
+to start writing
+.I nr_vecs
+from the
+.I iovecs
+array at the specified
+.I offset.
+The behavior of the function can be controlled with the
+.I flags
+parameter.
+
+Supported values for
+.I flags
+are:
+.TP
+.B RWF_HIPRI
+High priority request, poll if possible
+.TP
+.B RWF_DSYNC
+per-IO O_DSYNC
+.TP
+.B RWF_SYNC
+per-IO O_SYNC
+.TP
+.B RWF_NOWAIT
+per-IO, return
+.B -EAGAIN
+if operation would block
+.TP
+.B RWF_APPEND
+per-IO O_APPEND
+
+.P
+On files that support seeking, if the offset is set to
+.B -1,
+the write operation commences at the file offset, and the file offset is
+incremented by the number of bytes written. See
+.BR write (2)
+for more details. Note that for an async API, reading and updating the
+current file offset may result in unpredictable behavior, unless access
+to the file is serialized. It is not encouraged to use this feature, if it's
+possible to provide the desired IO offset from the application or library.
+
+On files that are not capable of seeking, the offset is ignored.
+
+After the write has been prepared, it can be submitted with one of the submit
+functions.
+
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_get_sqe (3), io_uring_prep_write (3), io_uring_prep_writev (3), io_uring_submit (3)

data/vendor/liburing/man/io_uring_queue_exit.3

@@ -0,0 +1,27 @@
+.\" Copyright (C) 2020 Jens Axboe <axboe@kernel.dk>
+.\" Copyright (C) 2020 Red Hat, Inc.
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_queue_exit 3 "July 10, 2020" "liburing-0.7" "liburing Manual"
+.SH NAME
+io_uring_queue_exit - tear down io_uring submission and completion queues
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_queue_exit(struct io_uring * ring );"
+.fi
+.PP
+.SH DESCRIPTION
+.PP
+.BR io_uring_queue_exit (3)
+will release all resources acquired and initialized by
+.BR io_uring_queue_init (3).
+It first unmaps the memory shared between the application and the kernel and then closes the io_uring file descriptor.
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_setup (2),
+.BR mmap (2),
+.BR io_uring_queue_init (3)