summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJens Axboe <axboe@kernel.dk>2022-02-13 16:00:06 -0700
committerJens Axboe <axboe@kernel.dk>2022-02-13 16:00:06 -0700
commit0525c2237098716e4aacb6966f57cdcc37c6f45d (patch)
treecbabe4ac78f5c2215a993b4a7148f30d4ef61db1
parentc193e22a4c9f0844390ac88e67288de3f8df5d20 (diff)
downloadliburing-0525c2237098716e4aacb6966f57cdcc37c6f45d.tar.gz
liburing-0525c2237098716e4aacb6966f57cdcc37c6f45d.tar.bz2
Add man pages for the prep_{read,write}_fixed helpers
Fixes: https://github.com/axboe/liburing/issues/522 Signed-off-by: Jens Axboe <axboe@kernel.dk>
-rw-r--r--man/io_uring_prep_read_fixed.354
-rw-r--r--man/io_uring_prep_write_fixed.354
2 files changed, 108 insertions, 0 deletions
diff --git a/man/io_uring_prep_read_fixed.3 b/man/io_uring_prep_read_fixed.3
new file mode 100644
index 0000000..c15c697
--- /dev/null
+++ b/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)
diff --git a/man/io_uring_prep_write_fixed.3 b/man/io_uring_prep_write_fixed.3
new file mode 100644
index 0000000..8667acf
--- /dev/null
+++ b/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 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_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)