Skip to contentSkip to conversation

liburing: add helpers to enable/disable eventfd notifications

PATCH Applied Stefano Garzarella 2 participants 7 messages May 20, 2020 io_uring

lore
Share & tools
lore
#0 lore raw

v2 cover liburing: add helpers to enable/disable eventfd notifications

This series is based on top of a new IORING_CQ_EVENTFD_DISABLED flag available in the CQ ring flags.

I added io_uring_cq_eventfd_enabled() to get the status of eventfd notifications, and io_uring_cq_eventfd_toggle() to disable/enabled eventfd notifications.

I updated man pages and I added a eventfd-disable.c test case.

v1 -> v2:
- renamed io_uring_cq_eventfd_toggle()
- return EOPNOTSUPP only if we need to change the flag

Stefano Garzarella (5):
Add CQ ring 'flags' field
man/io_uring_setup.2: add 'flags' field in the struct
io_cqring_offsets
Add helpers to set and get eventfd notification status man/io_uring_register.2: add IORING_CQ_EVENTFD_DISABLED description Add test/eventfd-disable.c test case

 .gitignore                      |   1 +
 man/io_uring_register.2         |   8 ++
 man/io_uring_setup.2            |   3 +-
 src/include/liburing.h          |  34 ++++++++
 src/include/liburing/io_uring.h |  11 ++-
 src/setup.c                     |   2 +
 test/Makefile                   |   6 +-
 test/eventfd-disable.c          | 148 ++++++++++++++++++++++++++++++++
 8 files changed, 209 insertions(+), 4 deletions(-)
 create mode 100644 test/eventfd-disable.c
Signature · 1 line
2.25.4
#1 lore raw

PATCH v2 1/5 Add CQ ring 'flags' field

io_uring provides the new CQ ring 'flags' field if 'cq_off.flags' is not zero. In this case we set the 'cq->kflags' pointer, otherwise it will be NULL.

---
 src/include/liburing.h          | 1 +
 src/include/liburing/io_uring.h | 4 +++-
 src/setup.c                     | 2 ++
 3 files changed, 6 insertions(+), 1 deletion(-)
src/include/liburing.h +1 -0
index 4311325..adc8db9 100644
@@ -41,6 +41,7 @@ struct io_uring_cq {
 	unsigned *ktail;
 	unsigned *kring_mask;
 	unsigned *kring_entries;
+	unsigned *kflags;
 	unsigned *koverflow;
 	struct io_uring_cqe *cqes;
 
src/include/liburing/io_uring.h +3 -1
index a279151..9860a8a 100644
@@ -205,7 +205,9 @@ struct io_cqring_offsets {
 	__u32 ring_entries;
 	__u32 overflow;
 	__u32 cqes;
-	__u64 resv[2];
+	__u32 flags;
+	__u32 resv1;
+	__u64 resv2;
 };
 
 /*
src/setup.c +2 -0
index f783b6a..860c112 100644
@@ -76,6 +76,8 @@ err:
 	cq->kring_entries = cq->ring_ptr + p->cq_off.ring_entries;
 	cq->koverflow = cq->ring_ptr + p->cq_off.overflow;
 	cq->cqes = cq->ring_ptr + p->cq_off.cqes;
+	if (p->cq_off.flags)
+		cq->kflags = cq->ring_ptr + p->cq_off.flags;
 	return 0;
 }
 
Signature · 1 line
2.25.4
#2 lore raw

PATCH v2 2/5 man/io_uring_setup.2: add 'flags' field in the struct io_cqring_offsets

In reply to Stefano Garzarella
---
 man/io_uring_setup.2 | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
man/io_uring_setup.2 +2 -1
index d48bb32..c929cb7 100644
@@ -325,7 +325,8 @@ struct io_cqring_offsets {
     __u32 ring_entries;
     __u32 overflow;
     __u32 cqes;
-    __u32 resv[4];
+    __u32 flags;
+    __u32 resv[3];
 };
 .EE
 .in
Signature · 1 line
2.25.4
#3 lore raw

PATCH v2 3/5 Add helpers to set and get eventfd notification status

In reply to Stefano Garzarella

This patch adds the new IORING_CQ_EVENTFD_DISABLED flag. It can be used to disable/enable notifications from the kernel when a request is completed and queued to the CQ ring.

We also add two helpers function to check if the notifications are enabled and to toggle them.

If the kernel doesn't provide CQ ring flags, the notifications are always enabled if an eventfd is registered.

---
v1 -> v2:
- renamed io_uring_cq_eventfd_toggle()
- return EOPNOTSUPP only if we need to change the flag

---
 src/include/liburing.h          | 33 +++++++++++++++++++++++++++++++++
 src/include/liburing/io_uring.h |  7 +++++++
 2 files changed, 40 insertions(+)
src/include/liburing.h +33 -0
index adc8db9..0192b47 100644
@@ -9,7 +9,9 @@ extern "C" {
 #include <sys/socket.h>
 #include <sys/uio.h>
 #include <sys/stat.h>
+#include <errno.h>
 #include <signal.h>
+#include <stdbool.h>
 #include <inttypes.h>
 #include <time.h>
 #include "liburing/compat.h"
@@ -445,6 +447,37 @@ static inline unsigned io_uring_cq_ready(struct io_uring *ring)
 	return io_uring_smp_load_acquire(ring->cq.ktail) - *ring->cq.khead;
 }
 
+static inline bool io_uring_cq_eventfd_enabled(struct io_uring *ring)
+{
+	if (!ring->cq.kflags)
+		return true;
+
+	return !(*ring->cq.kflags & IORING_CQ_EVENTFD_DISABLED);
+}
+
+static inline int io_uring_cq_eventfd_toggle(struct io_uring *ring,
+					     bool enabled)
+{
+	uint32_t flags;
+
+	if (!!enabled == io_uring_cq_eventfd_enabled(ring))
+		return 0;
+
+	if (!ring->cq.kflags)
+		return -EOPNOTSUPP;
+
+	flags = *ring->cq.kflags;
+
+	if (enabled)
+		flags &= ~IORING_CQ_EVENTFD_DISABLED;
+	else
+		flags |= IORING_CQ_EVENTFD_DISABLED;
+
+	IO_URING_WRITE_ONCE(*ring->cq.kflags, flags);
+
+	return 0;
+}
+
 /*
  * Return an IO completion, waiting for 'wait_nr' completions if one isn't
  * readily available. Returns 0 with cqe_ptr filled in on success, -errno on
src/include/liburing/io_uring.h +7 -0
index 9860a8a..92c2269 100644
@@ -210,6 +210,13 @@ struct io_cqring_offsets {
 	__u64 resv2;
 };
 
+/*
+ * cq_ring->flags
+ */
+
+/* disable eventfd notifications */
+#define IORING_CQ_EVENTFD_DISABLED	(1U << 0)
+
 /*
  * io_uring_enter(2) flags
  */
Signature · 1 line
2.25.4
#4 lore raw

PATCH v2 4/5 man/io_uring_register.2: add IORING_CQ_EVENTFD_DISABLED description

In reply to Stefano Garzarella
---
 man/io_uring_register.2 | 8 ++++++++
 1 file changed, 8 insertions(+)
man/io_uring_register.2 +8 -0
index e64f688..5022c03 100644
@@ -168,6 +168,14 @@ must contain a pointer to the eventfd file descriptor, and
 .I nr_args
 must be 1. Available since 5.2.
 
+An application can temporarily disable notifications, coming through the
+registered eventfd, by setting the
+.B IORING_CQ_EVENTFD_DISABLED
+bit in the
+.I flags
+field of the CQ ring.
+Available since 5.8.
+
 .TP
 .B IORING_REGISTER_EVENTFD_ASYNC
 This works just like
Signature · 1 line
2.25.4
#5 lore raw

PATCH v2 5/5 Add test/eventfd-disable.c test case

In reply to Stefano Garzarella

This new test checks if the mechanism to enable/disable notifications through eventfd when a request is completed works correctly.

---
v1 -> v2:
- renamed io_uring_cq_eventfd_toggle()

---
 .gitignore             |   1 +
 test/Makefile          |   6 +-
 test/eventfd-disable.c | 148 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 153 insertions(+), 2 deletions(-)
 create mode 100644 test/eventfd-disable.c
.gitignore +1 -0
index 19c47d9..fee76e8 100644
@@ -40,6 +40,7 @@
 /test/defer
 /test/eeed8b54e0df-test
 /test/eventfd
+/test/eventfd-disable
 /test/eventfd-ring
 /test/fadvise
 /test/fallocate
test/Makefile +4 -2
index 61825d1..7df550d 100644
@@ -21,7 +21,8 @@ all_targets += poll poll-cancel ring-leak fsync io_uring_setup io_uring_register
 		file-update accept-reuse poll-v-poll fadvise madvise \
 		short-read openat2 probe shared-wq personality eventfd \
 		send_recv eventfd-ring across-fork sq-poll-kthread splice \
-		lfs-openat lfs-openat-write iopoll d4ae271dfaae-test
+		lfs-openat lfs-openat-write iopoll d4ae271dfaae-test \
+		eventfd-disable
 
 include ../Makefile.quiet
 
@@ -53,7 +54,8 @@ test_srcs := poll.c poll-cancel.c ring-leak.c fsync.c io_uring_setup.c \
 	file-update.c accept-reuse.c poll-v-poll.c fadvise.c \
 	madvise.c short-read.c openat2.c probe.c shared-wq.c \
 	personality.c eventfd.c eventfd-ring.c across-fork.c sq-poll-kthread.c \
-	splice.c lfs-openat.c lfs-openat-write.c iopoll.c d4ae271dfaae-test.c
+	splice.c lfs-openat.c lfs-openat-write.c iopoll.c d4ae271dfaae-test.c \
+	eventfd-disable.c
 
 ifdef CONFIG_HAVE_STATX
 test_srcs += statx.c
test/eventfd-disable.c new file +148 -0

148 lines not on this page · raw message

Signature · 1 line
2.25.4
maintainer Applied
#6 lore raw
In reply to Stefano Garzarella
Quoted 7 lines · Stefano Garzarella

This series is based on top of a new IORING_CQ_EVENTFD_DISABLED flag available in the CQ ring flags.

I added io_uring_cq_eventfd_enabled() to get the status of eventfd notifications, and io_uring_cq_eventfd_toggle() to disable/enabled eventfd notifications.

Quoted 5 lines

I updated man pages and I added a eventfd-disable.c test case.

v1 -> v2:
- renamed io_uring_cq_eventfd_toggle()
- return EOPNOTSUPP only if we need to change the flag

Applied, thanks.

Signature · 1 line
Jens Axboe