path: root/man
AgeCommit message (Collapse)Author
2020-02-20man/io_uring_setup.2: fix 'sq_thread_idle' descriptionStefano Garzarella
In the kernel we are using msecs_to_jiffies() to convert the 'sq_thread_idle' parameter, provided by the user, in jiffies. So, the value is interpreted in milliseconds and not microseconds. Fixes: 59bb09c553eb ("man: add io_uring_setup.2 man page") Signed-off-by: Stefano Garzarella <> Signed-off-by: Jens Axboe <>
2020-02-19man/io_uring_enter.2: correct IORING_OP_STATXCarter Li
Signed-off-by: Carter Li <>
2020-02-12man/io_uring_register.2: add note of ring quiesce for file/buffers registrationJens Axboe
Signed-off-by: Jens Axboe <>
2020-02-11man/io_uring_setup.2: document IORING_FEAT_CUR_PERSONALITYJens Axboe
Signed-off-by: Jens Axboe <>
2020-02-02man: typo fixesAndres Freund
2020-02-01man/io_uring_enter.2: clarify how/when IOSQE_IO_LINK are terminatedJens Axboe
Signed-off-by: Jens Axboe <>
2020-01-30man/io_uring_enter.2: add IOSQE_ASYNCJens Axboe
Also include kernel version availability for all the other flags. Signed-off-by: Jens Axboe <>
2020-01-30man/io_uring_enter.2: add credentials personality fieldJens Axboe
Add an explanation of it, and link to how to register/unregister personalities. Signed-off-by: Jens Axboe <>
2020-01-30man/io_uring_register.2: add missing registration opcodesJens Axboe
Also mention availability of all of them in terms of kernel version for mainline. Signed-off-by: Jens Axboe <>
2020-01-30man/io_uring_enter.2: add fadvise/madviseJens Axboe
Also fix a few typos. Signed-off-by: Jens Axboe <>
2020-01-29man/io_uring_enter.2: add IORING_OP_{SEND,RECV}Jens Axboe
Signed-off-by: Jens Axboe <>
2020-01-29man/io_uring_enter.2: add notes on kernel version availabilityJens Axboe
Signed-off-by: Jens Axboe <>
2020-01-27Fix IORING_OP_CONNECT documentquininer
2020-01-06man/io_uring_enter: fix missing space in RECVMSGJens Axboe
Signed-off-by: Jens Axboe <>
2019-12-28man/io_uring_enter.2: improve timeout documentationJens Axboe
- Missing mention of -ENOENT on timeout removal - Mention the clock source used is CLOCK_MONOTONIC Signed-off-by: Jens Axboe <>
2019-12-25io_uring_setup.2: formatting and addition of read/write fixedJens Axboe
Signed-off-by: Jens Axboe <>
2019-12-25io_uring_setup.2: minor clarificationJens Axboe
Signed-off-by: Jens Axboe <>
2019-12-25Merge branch 'offset' of Axboe
* 'offset' of io_uring.h: add IORING_FEAT_RW_CUR_POS flag
2019-12-26io_uring.h: add IORING_FEAT_RW_CUR_POS flagCarter Li
and document it Signed-off-by: Carter Li <>
2019-12-26io_uring_enter.2: document IOSQE_IO_HARDLINKCarter Li
Signed-off-by: Carter Li <>
2019-12-25io_uring_enter.2: add note of files update array life timeJens Axboe
Signed-off-by: Jens Axboe <>
2019-12-25Add new opcodes to io_uring_enter.2 man pageJens Axboe
2019-11-08man/io_uring_enter.2: document -EBUSY returnJens Axboe
Signed-off-by: Jens Axboe <>
2019-11-07man/io_uring_enter.2: sync with kernelJens Axboe
Add the opcodes we hadn't added in here yet, and the updated sqe command structure. Signed-off-by: Jens Axboe <>
2019-11-07man/io_uring_enter.2: clarify -EAGAIN handlingJens Axboe
Signed-off-by: Jens Axboe <>
2019-11-07document IORING_SETUP_CQSIZEJeff Moyer
Add text in the io_uring_setup man page for the IORING_SETUP_CQSIZE option. Signed-off-by: Jeff Moyer <> Signed-off-by: Jens Axboe <>
2019-09-28Update struct io_uring_sqe in the man file.James Rouzier
Signed-off-by: James Rouzier <>
2019-07-15man: add IOSQE_IO_DRAIN and IOSQE_IO_LINKJens Axboe
Add descriptions of these SQE flags. Signed-off-by: Jens Axboe <>
2019-07-02Fix the use of memory barriersBart Van Assche
Introduce the smp_load_acquire() and smp_store_release() macros. Fix synchronization in io_uring_cq_advance() and __io_uring_get_cqe(). Remove a superfluous local variable, if-test and write barrier from __io_uring_submit(). Remove a superfluous barrier from test/io_uring_enter.c. Cc: Stefan Hajnoczi <> Cc: Roman Penyaev <> Signed-off-by: Bart Van Assche <> Signed-off-by: Jens Axboe <>
2019-05-20io_uring_register.2: fix multiple formatting issuesDmitry V. Levin
Signed-off-by: Dmitry V. Levin <> Signed-off-by: Jens Axboe <>
2019-05-20io_uring_enter.2: fix multiple formatting issuesDmitry V. Levin
Signed-off-by: Dmitry V. Levin <> Signed-off-by: Jens Axboe <>
2019-05-20io_uring_setup.2: fix multiple formatting issuesDmitry V. Levin
Signed-off-by: Dmitry V. Levin <> Signed-off-by: Jens Axboe <>
2019-05-18Fix manpage mmap() syntaxIan Gulliver
The examples in the io_uring_setup.2 man patch erroneously ORs the protection bits and mmap flags, fix it up. Signed-off-by: Ian Gulliver <> Signed-off-by: Jens Axboe <>
2019-05-01man/io_uring_enter.2: clarify io_uring_enter(2) return valuesJens Axboe
With the recent change to ensure that submission side errors that happen on behalf of an sqe are returned in the form of a cqe rather than -1/errno from the system call, make sure that the man page reflects that. Signed-off-by: Jens Axboe <>
2019-04-23man/io_uring_enter.2: add another ENOTSUPP instanceJens Axboe
Signed-off-by: Jens Axboe <>
2019-04-22man/io_uring_register.2: add another ENXIO caseJens Axboe
Signed-off-by: Jens Axboe <>
2019-04-10man/io_uring_setup.2: add EPERM case for IORING_SETUP_SQPOLLJens Axboe
Signed-off-by: Jens Axboe <>
2019-03-19Remove IOCQE_FLAG_CACHEHITJens Axboe
This cache hint has been removed from the io_uring series, as there's some hesitation to leak this information to userspace. Remove it from the header file and the man page. We can always re-introduce it later, if we get some variant of this included. Signed-off-by: Jens Axboe <>
2019-02-14io_uring_enter.2: clarify min_completeJeff Moyer
min_complete means slightly different things depending on how the ring was setup. Signed-off-by: Jeff Moyer <> Signed-off-by: Jens Axboe <>
2019-02-12man/io_uring_enter.2: clarify -EMFILE per-user caseJens Axboe
Signed-off-by: Jens Axboe <>
2019-02-12man/io_uring_enter.2: add mention of -EMFILE for fixed file setsJens Axboe
Signed-off-by: Jens Axboe <>
2019-02-10man/io_uring_enter: mention that SQE entries are always fully consumedJens Axboe
With a recent change to the kernel side, we now fully guarantee that once io_uring_enter(2) returns that X entries have been submitted, it's completely safe to reuse tohse entries. This used to not always be the case, if an SQE had to be punted to async context for submission. This makes for a more reliable and nicer interface. Signed-off-by: Jens Axboe <>
2019-02-09man/io_uring_register: make note of huge page pinningJens Axboe
Signed-off-by: Jens Axboe <>
2019-02-08remove sigsz from io_uring_enter.2Jeff Moyer
Users shouldn't be concerned with the size of the sigset. Signed-off-by: Jeff Moyer <> Signed-off-by: Jens Axboe <>
2019-02-08Add sigmask parameter to io_uring_enterJeff Moyer
Update liburing and io_uring_enter.2 to match the kernel. Signed-off-by: Jeff Moyer <> Signed-off-by: Jens Axboe <>
2019-02-08man/io_uring_register.2: add EMFILE errnoJens Axboe
Signed-off-by: Jens Axboe <>
2019-02-05man/io_uring_setup: mention that IORING_SETUP_SQPOLL needs fixed filesJens Axboe
Signed-off-by: Jens Axboe <>
2019-01-31man/io_uring_enter.2: we no longer EBUSY on mutex trylock failureJens Axboe
Signed-off-by: Jens Axboe <>
2019-01-30man: add io_uring_setup.2 man pageJeff Moyer
Initial man page for io_uring_setup. Content was taken from the kernel commit logs and from an LWN article written by Jon Corbet. Signed-off-by: Jeff Moyer <> Signed-off-by: Jens Axboe <>
2019-01-26man: fixup description of fixed files I/OJeff Moyer
The man page suggests that IOSQE_FIXED_FILE must be specified for all sqes when the io_uring instance has files registered. This is not the case, so clear that up. Also fix a typo (few->new) while we're in there. Signed-off-by: Jeff Moyer <> Signed-off-by: Jens Axboe <>