public inbox for [email protected]
 help / color / mirror / Atom feed
From: Pavel Begunkov <[email protected]>
To: [email protected]
Cc: Jens Axboe <[email protected]>, [email protected]
Subject: [PATCH liburing 4/4] man: document clock id and IORING_ENTER_ABS_TIMER
Date: Sun, 18 Aug 2024 19:55:44 +0100	[thread overview]
Message-ID: <24844efb9ef46691fa15a1da5198aaae3f759d1c.1724007045.git.asml.silence@gmail.com> (raw)
In-Reply-To: <[email protected]>

Signed-off-by: Pavel Begunkov <[email protected]>
---
 man/io_uring_enter.2    | 12 ++++++++++++
 man/io_uring_register.2 | 20 ++++++++++++++++++++
 2 files changed, 32 insertions(+)

diff --git a/man/io_uring_enter.2 b/man/io_uring_enter.2
index 5e4121b..8c79771 100644
--- a/man/io_uring_enter.2
+++ b/man/io_uring_enter.2
@@ -105,6 +105,18 @@ then setting this flag will tell the kernel that the
 .I ring_fd
 passed in is the registered ring offset rather than a normal file descriptor.
 
+.TP
+.B IORING_ENTER_ABS_TIMER
+
+When this flag is set, the timeout argument passed in
+.I struct io_uring_getevents_arg
+will be interpreted as an absolute
+time of the registered clock (see
+.B IORING_REGISTER_CLOCK
+) until which the waiting should end.
+
+Available since 6.12
+
 .PP
 .PP
 If the io_uring instance was configured for polling, by specifying
diff --git a/man/io_uring_register.2 b/man/io_uring_register.2
index 4590588..c8521b7 100644
--- a/man/io_uring_register.2
+++ b/man/io_uring_register.2
@@ -720,6 +720,26 @@ The application must have registered a file table first.
 
 Available since 6.0.
 
+.TP
+.B IORING_REGISTER_CLOCK
+Specifies which clock id io_uring will use for timers while waiting for
+completion events with
+.B IORING_ENTER_GETEVENTS.
+It's only effective if the timeout argument in
+.I struct io_uring_getevents_arg
+is passed, ignored otherwise.
+When used in conjunction with
+.B IORING_ENTER_ABS_TIMER,
+interprets the timeout argument as absolute time of the specified clock.
+
+The default clock is
+.B CLOCK_MONOTONIC.
+
+Available since 6.12 and supports
+.B CLOCK_MONOTONIC
+and
+.B CLOCK_BOOTTIME.
+
 .SH RETURN VALUE
 
 On success,
-- 
2.45.2


  parent reply	other threads:[~2024-08-18 18:55 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-18 18:55 [PATCH liburing 0/4] Tests for absolute timeouts and clockids Pavel Begunkov
2024-08-18 18:55 ` [PATCH liburing 1/4] Sync kernel headers Pavel Begunkov
2024-08-18 18:55 ` [PATCH liburing 2/4] src/register: add clock id registration helper Pavel Begunkov
2024-08-18 18:55 ` [PATCH liburing 3/4] test: test clockids and abs timeouts Pavel Begunkov
2024-08-18 18:55 ` Pavel Begunkov [this message]
2024-08-18 19:39 ` [PATCH liburing 0/4] Tests for absolute timeouts and clockids Jens Axboe
2024-08-18 19:40 ` Jens Axboe

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 \
    --in-reply-to=24844efb9ef46691fa15a1da5198aaae3f759d1c.1724007045.git.asml.silence@gmail.com \
    [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