diff options
author | Jens Axboe <axboe@kernel.dk> | 2019-12-25 18:37:52 -0700 |
---|---|---|
committer | Jens Axboe <axboe@kernel.dk> | 2019-12-25 18:37:52 -0700 |
commit | bc3eb0571e70a2010ccb3e186e2045162f19bbd1 (patch) | |
tree | 957f5b1850735051098500512017f52434f6f82b /man | |
parent | 4c5f1c320ec4cbff642fb3e8e0c4a80eef707389 (diff) | |
download | liburing-bc3eb0571e70a2010ccb3e186e2045162f19bbd1.tar.gz liburing-bc3eb0571e70a2010ccb3e186e2045162f19bbd1.tar.bz2 |
Add new opcodes to io_uring_enter.2 man page
This adds:
IORING_OP_CONNECT
IORING_OP_FALLOCATE
IORING_OP_OPENAT
IORING_OP_CLOSE
IORING_OP_FILES_UPDATE
IORING_OP_STATX
IORING_OP_READ
IORING_OP_WRITE
to the opcode descriptions.
Fixes: https://github.com/axboe/liburing/issues/45
Signed-off-by: Jens Axboe <axboe@kernel.dk>
Diffstat (limited to 'man')
-rw-r--r-- | man/io_uring_enter.2 | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/man/io_uring_enter.2 b/man/io_uring_enter.2 index c11e824..5cf2bc7 100644 --- a/man/io_uring_enter.2 +++ b/man/io_uring_enter.2 @@ -325,6 +325,127 @@ if the timer expired and the linked request was attempted cancelled, or .I -ECANCELED if the timer got cancelled because of completion of the linked request. +.TP +.B IORING_OP_CONNECT +Issue the equivalent of a +.BR connect(2) +system call. +.I fd +must be set to the socket file descriptor, +.I addr +must contains the pointer to the sockaddr structure, and +.I len +must contain the socklen_t addrlen field. See also +.BR connect(2) +for the general description of the related system call. + +.TP +.B IORING_OP_FALLOCATE +Issue the equivalent of a +.BR fallocate(2) +system call. +.I fd +must be set to the file descriptor, +.I off +must contain the offset on which to operate, and +.I len +must the length. See also +.BR fallocate(2) +for the general description of the related system call. + +.TP +.B IORING_OP_OPENAT +Issue the equivalent of a +.BR openat(2) +system call. +.I fd +is the +.I dirfd +argument, +.I addr +must contain a pointer to the +.I *pathname +argument, +.I open_flags +should contain any flags passed in, and +.I mode +is access mode of the file. See also +.BR openat(2) +for the general description of the related system call. + +.TP +.B IORING_OP_CLOSE +Issue the equivalent of a +.BR close(2) +system call. +.I fd +is the file descriptor to be closed. See also +.BR close(2) +for the general description of the related system call. + +.TP +.B IORING_OP_STATX +Issue the equivalent of a +.BR statx(2) +system call. +.I fd +is the +.I dirfd +argument, +.I addr +must contain a pointer to the +.I *pathname +string, +.I statx_flags +is the +.I flags +argument, +.I len +should be the +.I mask +argument, and +.I addr +must contain a pointer to the +.I statxbuf +to be filled in. See also +.BR statx(2) +for the general description of the related system call. + +.TP +.B IORING_OP_READ IORING_OP_WRITE +Issue the equivalent of a +.BR read(2) +or +.BR write(2) +system call. +.I fd +is the file descriptor to be operated on, +.I addr +contains the buffer in question, and +.I len +contains the length of the IO operation. These are non-vectored versions of the +.B IORING_OP_READV +and +.B IORING_OP_WRITEV +opcodes. See also +.BR read(2) +and +.BR write(2) +for the general description of the related system call. + +.TP +.B IORING_OP_FILES_UPDATE +This command is an alternative to using +.B IORING_REGISTER_FILES_UPDATE +which then works in an async fashion, like the rest of the io_uring commands. +The arguments passed in are the same. +.I addr +must contain a pointer to the array of file descriptors, +.I len +must contain the length of the array, and +.I off +must contain the offset at which to operate. + .PP The .I flags |