From: Dylan Yudaken <[email protected]>
To: Jens Axboe <[email protected]>,
Pavel Begunkov <[email protected]>,
<[email protected]>
Cc: <[email protected]>, Dylan Yudaken <[email protected]>
Subject: [PATCH liburing v2 02/12] Add documentation for IORING_SETUP_DEFER_TASKRUN flag
Date: Thu, 1 Sep 2022 02:32:53 -0700 [thread overview]
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
Add man page entry to io_uring_setup.2 for the new flag
Signed-off-by: Dylan Yudaken <[email protected]>
---
man/io_uring_setup.2 | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/man/io_uring_setup.2 b/man/io_uring_setup.2
index 32a9e2ee89b5..01eb70d95292 100644
--- a/man/io_uring_setup.2
+++ b/man/io_uring_setup.2
@@ -257,6 +257,25 @@ how many userspace tasks do
.I
io_uring_enter(2).
Available since 5.20.
+.TP
+.B IORING_SETUP_DEFER_TASKRUN
+By default, io_uring will process all outstanding work at the end of any system
+call or thread interrupt. This can delay the application from making other progress.
+Setting this flag will hint to io_uring that it should defer work until an
+.BR io_uring_enter(2)
+call with the
+.B IORING_ENTER_GETEVENTS
+flag set. This allows the application to request work to run just before it wants to
+process completions.
+This flag requires the
+.BR IORING_SETUP_SINGLE_ISSUER
+flag to be set, and also enforces that the call to
+.BR io_uring_enter(2)
+is called from the same thread that submitted requests.
+Note that if this flag is set then it is the application's responsibility to periodically
+trigger work (for example via any of the CQE waiting functions) or else completions may
+not be delivered.
+Available since 6.1.
.PP
If no flags are specified, the io_uring instance is setup for
interrupt driven I/O. I/O may be submitted using
--
2.30.2
next prev parent reply other threads:[~2022-09-01 9:33 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-01 9:32 [PATCH liburing v2 00/12] Defer taskrun changes Dylan Yudaken
2022-09-01 9:32 ` [PATCH liburing v2 01/12] Copy defer task run definition from kernel Dylan Yudaken
2022-09-01 9:32 ` Dylan Yudaken [this message]
2022-09-01 9:32 ` [PATCH liburing v2 03/12] add io_uring_submit_and_get_events and io_uring_get_events Dylan Yudaken
2022-09-01 18:36 ` Jens Axboe
2022-09-05 8:31 ` Dylan Yudaken
2022-09-01 9:32 ` [PATCH liburing v2 04/12] add a t_probe_defer_taskrun helper function for tests Dylan Yudaken
2022-09-01 9:32 ` [PATCH liburing v2 05/12] update existing tests for defer taskrun Dylan Yudaken
2022-09-01 9:32 ` [PATCH liburing v2 06/12] add a defer-taskrun test Dylan Yudaken
2022-09-01 9:32 ` [PATCH liburing v2 07/12] update io_uring_enter.2 docs for IORING_FEAT_NODROP Dylan Yudaken
2022-09-01 9:32 ` [PATCH liburing v2 08/12] add docs for overflow lost errors Dylan Yudaken
2022-09-01 9:33 ` [PATCH liburing v2 09/12] expose CQ ring overflow state Dylan Yudaken
2022-09-01 9:33 ` [PATCH liburing v2 10/12] overflow: add tests Dylan Yudaken
2022-09-01 9:33 ` [PATCH liburing v2 11/12] file-verify test: log if short read Dylan Yudaken
2022-09-01 9:33 ` [PATCH liburing v2 12/12] shutdown test: bind to ephemeral port Dylan Yudaken
2022-09-01 11:44 ` Ammar Faizi
2022-09-01 12:54 ` Dylan Yudaken
2022-09-01 13:03 ` Ammar Faizi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox