summaryrefslogtreecommitdiff
path: root/man/io_uring_prep_write_fixed.3
blob: c9729b448d33baa7a58fa84a582f49f5c222442b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
.\" 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 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
.I errno.
Instead it returns the negated
.I errno
directly in the CQE
.I res
field.
.SH SEE ALSO
.BR io_uring_prep_write (3), io_uring_register_buffers (3)