22 Commits

Author SHA1 Message Date
Ian Gulliver
3200e997d0 Fix manpage mmap() syntax
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 <git@flamingcow.io>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-05-18 12:49:55 -06:00
Jens Axboe
ff73ac71a1 man/io_uring_enter.2: clarify io_uring_enter(2) return values
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 <axboe@kernel.dk>
2019-05-01 15:54:29 -06:00
Jens Axboe
87e2c401aa man/io_uring_enter.2: add another ENOTSUPP instance
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-04-23 10:35:46 -06:00
Jens Axboe
4a1a9dfe1f man/io_uring_register.2: add another ENXIO case
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-04-22 10:42:08 -06:00
Jens Axboe
0656d71c96 man/io_uring_setup.2: add EPERM case for IORING_SETUP_SQPOLL
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-04-10 08:41:42 -06:00
Jens Axboe
f8b12e48bf Remove IOCQE_FLAG_CACHEHIT
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 <axboe@kernel.dk>
2019-03-19 10:01:55 -06:00
Jeff Moyer
10a57a0823 io_uring_enter.2: clarify min_complete
min_complete means slightly different things depending on how the ring
was setup.

Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-02-14 17:13:44 -07:00
Jens Axboe
1a3020e7b4 man/io_uring_enter.2: clarify -EMFILE per-user case
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-02-12 14:11:34 -07:00
Jens Axboe
37e48698a0 man/io_uring_enter.2: add mention of -EMFILE for fixed file sets
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-02-12 10:31:52 -07:00
Jens Axboe
87ec82f00f man/io_uring_enter: mention that SQE entries are always fully consumed
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 <axboe@kernel.dk>
2019-02-10 15:54:30 -07:00
Jens Axboe
e9aa44135b man/io_uring_register: make note of huge page pinning
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-02-09 09:48:57 -07:00
Jeff Moyer
bd7ad347f9 remove sigsz from io_uring_enter.2
Users shouldn't be concerned with the size of the sigset.

Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-02-08 12:41:28 -07:00
Jeff Moyer
3ceb15c132 Add sigmask parameter to io_uring_enter
Update liburing and io_uring_enter.2 to match the kernel.

Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-02-08 11:33:28 -07:00
Jens Axboe
bed7020ffe man/io_uring_register.2: add EMFILE errno
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-02-08 08:19:25 -07:00
Jens Axboe
8471fb944d man/io_uring_setup: mention that IORING_SETUP_SQPOLL needs fixed files
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-02-05 11:42:04 -07:00
Jens Axboe
091b18fb85 man/io_uring_enter.2: we no longer EBUSY on mutex trylock failure
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-01-31 22:57:14 -07:00
Jeff Moyer
59bb09c553 man: add io_uring_setup.2 man page
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 <jmoyer@redhat.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-01-30 06:43:00 -07:00
Jeff Moyer
9688b4a00f man: fixup description of fixed files I/O
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 <jmoyer@redhat.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-01-26 06:40:48 -07:00
Jeff Moyer
2a8e5b105c man: io_uring_register: use a .TP list for flags
This seems to be the canonical way to do things.

Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-01-26 06:40:47 -07:00
Jeff Moyer
4a700b7e35 man: alphabetize the error section for io_uring_register
This also includes a couple of whitespace cleanups.  Most man pages
don't leave spaces between directives.

Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-01-26 06:40:44 -07:00
Jeff Moyer
81f9d4616e io_uring_enter.2 man page
Initial man page for io_uring_enter.

Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-01-22 12:57:07 -07:00
Jeff Moyer
980cc0f025 man: add a man page for io_uring_register
Initial content was taken from the kernel commits (Jens Axboe).

Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2019-01-17 16:19:07 -07:00