Skip to contentSkip to conversation

liburing: add helpers to enable/disable eventfd notifications

PATCH Superseded Stefano Garzarella 2 participants 12 messages May 15, 2020 – May 20, 2020 io_uring

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

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_enable() to disable/enabled eventfd notifications.

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

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          |  31 +++++++
 src/include/liburing/io_uring.h |  11 ++-
 src/setup.c                     |   2 +
 test/Makefile                   |   4 +-
 test/eventfd-disable.c          | 148 ++++++++++++++++++++++++++++++++
 8 files changed, 204 insertions(+), 4 deletions(-)
 create mode 100644 test/eventfd-disable.c
Signature · 1 line
2.25.4
#1 lore raw

PATCH 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 dd85f7b..ea596f6 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 e48d746..602bb0e 100644
@@ -204,7 +204,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 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 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 enable/disable them.

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

---
 src/include/liburing.h          | 30 ++++++++++++++++++++++++++++++
 src/include/liburing/io_uring.h |  7 +++++++
 2 files changed, 37 insertions(+)
src/include/liburing.h +30 -0
index ea596f6..fe03547 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,34 @@ 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 int io_uring_cq_eventfd_enable(struct io_uring *ring,
+					     bool enabled)
+{
+	uint32_t flags;
+
+	if (!ring->cq.kflags)
+		return -ENOTSUP;
+
+	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;
+}
+
+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 int __io_uring_peek_cqe(struct io_uring *ring, struct io_uring_cqe **cqe_ptr)
 {
 	struct io_uring_cqe *cqe;
src/include/liburing/io_uring.h +7 -0
index 602bb0e..8c5775d 100644
@@ -209,6 +209,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
maintainer
#4 lore raw

Re: [PATCH liburing 3/5] Add helpers to set and get eventfd notification status

Quoted 43 lines · 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 enable/disable them.

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

---
 src/include/liburing.h          | 30 ++++++++++++++++++++++++++++++
 src/include/liburing/io_uring.h |  7 +++++++
 2 files changed, 37 insertions(+)
src/include/liburing.h +11 -0
index ea596f6..fe03547 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,34 @@ 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 int io_uring_cq_eventfd_enable(struct io_uring *ring,
+					     bool enabled)
+{
+	uint32_t flags;
+
+	if (!ring->cq.kflags)
+		return -ENOTSUP;
+
+	flags = *ring->cq.kflags;

src/include/liburing.h static inline unsigned io_uring_cq_ready(struct io_uring *ring) · line 468

Quoted 10 lines
src/include/liburing.h +10 -0
+
+	if (enabled)
+		flags &= ~IORING_CQ_EVENTFD_DISABLED;
+	else
+		flags |= IORING_CQ_EVENTFD_DISABLED;
+
+	IO_URING_WRITE_ONCE(*ring->cq.kflags, flags);
+
+	return 0;
+}

The -ENOTSUP seems a bit odd, I wonder if we should even flag that as an error.

The function should probably also be io_uring_cq_eventfd_toggle() or something like that, as it does both enable and disable.

Either that, or have two functions, and enable and disable.

The bigger question is probably how to handle kernels that don't have this feature. It'll succeed, but we'll still post events. Maybe the kernel side should have a feature flag that we can test?

Signature · 1 line
Jens Axboe
#5 lore raw

Re: [PATCH liburing 3/5] Add helpers to set and get eventfd notification status

Quoted 49 lines · Jens Axboe
Quoted 48 lines · 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 enable/disable them.

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

---
 src/include/liburing.h          | 30 ++++++++++++++++++++++++++++++
 src/include/liburing/io_uring.h |  7 +++++++
 2 files changed, 37 insertions(+)
src/include/liburing.h +16 -0
index ea596f6..fe03547 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,34 @@ 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 int io_uring_cq_eventfd_enable(struct io_uring *ring,
+					     bool enabled)
+{
+	uint32_t flags;
+
+	if (!ring->cq.kflags)
+		return -ENOTSUP;
+
+	flags = *ring->cq.kflags;
+
+	if (enabled)
+		flags &= ~IORING_CQ_EVENTFD_DISABLED;
+	else
+		flags |= IORING_CQ_EVENTFD_DISABLED;
Quoted 8 lines

src/include/liburing.h static inline unsigned io_uring_cq_ready(struct io_uring *ring) · line 468

Quoted 5 lines
src/include/liburing.h +5 -0
+
+	IO_URING_WRITE_ONCE(*ring->cq.kflags, flags);
+
+	return 0;
+}

The -ENOTSUP seems a bit odd, I wonder if we should even flag that as an error.

Do you think it's better to ignore the enabling/disabling if we don't have the flag field available?

Quoted 5 lines

The function should probably also be io_uring_cq_eventfd_toggle() or something like that, as it does both enable and disable.

Either that, or have two functions, and enable and disable.

Okay, I'll change it in io_uring_cq_eventfd_toggle().

Quoted 4 lines

The bigger question is probably how to handle kernels that don't have this feature. It'll succeed, but we'll still post events. Maybe the kernel side should have a feature flag that we can test?

I thought about that, and initially I added a IORING_FEAT_EVENTFD_DISABLE, but then I realized that we are adding the CQ 'flags' field together with the eventfd disabling feature.

So I supposed that if 'p->cq_off.flags' is not zero, than the kernel supports CQ flags and also the IORING_CQ_EVENTFD_DISABLED bit.

Do you think that's okay, or should we add IORING_FEAT_EVENTFD_DISABLE (or something similar)?

Thanks,
Stefano

#6 lore raw

Re: [PATCH liburing 3/5] Add helpers to set and get eventfd notification status

Quoted 79 lines · Stefano Garzarella
Quoted 49 lines · Jens Axboe
Quoted 48 lines · 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 enable/disable them.

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

---
 src/include/liburing.h          | 30 ++++++++++++++++++++++++++++++
 src/include/liburing/io_uring.h |  7 +++++++
 2 files changed, 37 insertions(+)
src/include/liburing.h +16 -0
index ea596f6..fe03547 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,34 @@ 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 int io_uring_cq_eventfd_enable(struct io_uring *ring,
+					     bool enabled)
+{
+	uint32_t flags;
+
+	if (!ring->cq.kflags)
+		return -ENOTSUP;
+
+	flags = *ring->cq.kflags;
+
+	if (enabled)
+		flags &= ~IORING_CQ_EVENTFD_DISABLED;
+	else
+		flags |= IORING_CQ_EVENTFD_DISABLED;
Quoted 8 lines

src/include/liburing.h static inline unsigned io_uring_cq_ready(struct io_uring *ring) · line 468

Quoted 5 lines
src/include/liburing.h +5 -0
+
+	IO_URING_WRITE_ONCE(*ring->cq.kflags, flags);
+
+	return 0;
+}

The -ENOTSUP seems a bit odd, I wonder if we should even flag that as an error.

Do you think it's better to ignore the enabling/disabling if we don't have the flag field available?

Quoted 5 lines

The function should probably also be io_uring_cq_eventfd_toggle() or something like that, as it does both enable and disable.

Either that, or have two functions, and enable and disable.

Okay, I'll change it in io_uring_cq_eventfd_toggle().

Quoted 4 lines

The bigger question is probably how to handle kernels that don't have this feature. It'll succeed, but we'll still post events. Maybe the kernel side should have a feature flag that we can test?

I thought about that, and initially I added a IORING_FEAT_EVENTFD_DISABLE, but then I realized that we are adding the CQ 'flags' field together with the eventfd disabling feature.

Quoted 5 lines

So I supposed that if 'p->cq_off.flags' is not zero, than the kernel supports CQ flags and also the IORING_CQ_EVENTFD_DISABLED bit.

Do you think that's okay, or should we add IORING_FEAT_EVENTFD_DISABLE (or something similar)?

Hi Jens,
I'm changing io_uring_cq_eventfd_enable() to io_uring_cq_eventfd_toggle().

Any advice on the error and eventual feature flag?

Thank you very much,
Stefano

maintainer
#7 lore raw

Re: [PATCH liburing 3/5] Add helpers to set and get eventfd notification status

Quoted 8 lines · Stefano Garzarella
Quoted 8 lines
Quoted 3 lines

The bigger question is probably how to handle kernels that don't have this feature. It'll succeed, but we'll still post events. Maybe the kernel side should have a feature flag that we can test?

I thought about that, and initially I added a IORING_FEAT_EVENTFD_DISABLE, but then I realized that we are adding the CQ 'flags' field together with the eventfd disabling feature.

Quoted 8 lines
Quoted 5 lines

So I supposed that if 'p->cq_off.flags' is not zero, than the kernel supports CQ flags and also the IORING_CQ_EVENTFD_DISABLED bit.

Do you think that's okay, or should we add IORING_FEAT_EVENTFD_DISABLE (or something similar)?

Hi Jens,
I'm changing io_uring_cq_eventfd_enable() to io_uring_cq_eventfd_toggle().

Sounds good.

Quoted 1 line

Any advice on the error and eventual feature flag?

I guess we can use cq_off.flags != 0 to tell if we have this feature or not, even though it's a bit quirky. But at the same time, probably not worth adding a specific feature flag for.

For the error, -EOPNOTSUPP seems fine if we don't have the feature. Just don't flag errors for enabling when already enabled, or vice versa. It's inherently racy in that completions can come in while the app is calling the helper, so we should make the interface relaxed.

Signature · 1 line
Jens Axboe
#8 lore raw

Re: [PATCH liburing 3/5] Add helpers to set and get eventfd notification status

Quoted 18 lines · Jens Axboe
Quoted 8 lines · Stefano Garzarella
Quoted 8 lines
Quoted 3 lines

The bigger question is probably how to handle kernels that don't have this feature. It'll succeed, but we'll still post events. Maybe the kernel side should have a feature flag that we can test?

I thought about that, and initially I added a IORING_FEAT_EVENTFD_DISABLE, but then I realized that we are adding the CQ 'flags' field together with the eventfd disabling feature.

Quoted 8 lines
Quoted 5 lines

So I supposed that if 'p->cq_off.flags' is not zero, than the kernel supports CQ flags and also the IORING_CQ_EVENTFD_DISABLED bit.

Do you think that's okay, or should we add IORING_FEAT_EVENTFD_DISABLE (or something similar)?

Hi Jens,
I'm changing io_uring_cq_eventfd_enable() to io_uring_cq_eventfd_toggle().

Quoted 7 lines

Sounds good.

Quoted 1 line

Any advice on the error and eventual feature flag?

I guess we can use cq_off.flags != 0 to tell if we have this feature or not, even though it's a bit quirky. But at the same time, probably not worth adding a specific feature flag for.

Agree.

Quoted 3 lines

For the error, -EOPNOTSUPP seems fine if we don't have the feature. Just don't flag errors for enabling when already enabled, or vice versa. It's

Okay.

Quoted 2 lines

inherently racy in that completions can come in while the app is calling the helper, so we should make the interface relaxed.

Yes, do you think we should also provide an interface to do double check while re-enabling notifications?
Or we can leave this to the application?

I mean something like this:

    bool io_uring_cq_eventfd_safe_enable(struct io_uring *ring)
    {
        /* enable notifications */
        io_uring_cq_eventfd_toggle(ring, true);

        /* Do we have any more cqe in the ring? */
        if (io_uring_cq_ready(ring)) {
            io_uring_cq_eventfd_toggle(ring, false);
            return false;
        }

        return true;
    }

Thanks,
Stefano

maintainer
#9 lore raw

Re: [PATCH liburing 3/5] Add helpers to set and get eventfd notification status

Quoted 44 lines · Stefano Garzarella
Quoted 18 lines · Jens Axboe
Quoted 8 lines · Stefano Garzarella
Quoted 8 lines
Quoted 3 lines

The bigger question is probably how to handle kernels that don't have this feature. It'll succeed, but we'll still post events. Maybe the kernel side should have a feature flag that we can test?

I thought about that, and initially I added a IORING_FEAT_EVENTFD_DISABLE, but then I realized that we are adding the CQ 'flags' field together with the eventfd disabling feature.

Quoted 8 lines
Quoted 5 lines

So I supposed that if 'p->cq_off.flags' is not zero, than the kernel supports CQ flags and also the IORING_CQ_EVENTFD_DISABLED bit.

Do you think that's okay, or should we add IORING_FEAT_EVENTFD_DISABLE (or something similar)?

Hi Jens,
I'm changing io_uring_cq_eventfd_enable() to io_uring_cq_eventfd_toggle().

Quoted 7 lines

Sounds good.

Quoted 1 line

Any advice on the error and eventual feature flag?

I guess we can use cq_off.flags != 0 to tell if we have this feature or not, even though it's a bit quirky. But at the same time, probably not worth adding a specific feature flag for.

Agree.

Quoted 3 lines

For the error, -EOPNOTSUPP seems fine if we don't have the feature. Just don't flag errors for enabling when already enabled, or vice versa. It's

Okay.

Quoted 2 lines

inherently racy in that completions can come in while the app is calling the helper, so we should make the interface relaxed.

Yes, do you think we should also provide an interface to do double check while re-enabling notifications?
Or we can leave this to the application?

I mean something like this:

Quoted 13 lines
    bool io_uring_cq_eventfd_safe_enable(struct io_uring *ring)
    {
        /* enable notifications */
        io_uring_cq_eventfd_toggle(ring, true);

        /* Do we have any more cqe in the ring? */
        if (io_uring_cq_ready(ring)) {
            io_uring_cq_eventfd_toggle(ring, false);
            return false;
        }

        return true;
    }

Let's just leave it for now unless/until there's a clear need for something like that.

Signature · 1 line
Jens Axboe
#10 lore raw

PATCH 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
#11 lore raw

PATCH 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.

---
 .gitignore             |   1 +
 test/Makefile          |   4 +-
 test/eventfd-disable.c | 148 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 151 insertions(+), 2 deletions(-)
 create mode 100644 test/eventfd-disable.c
.gitignore +1 -0
index 9784f0b..7f01e6e 100644
@@ -40,6 +40,7 @@
 /test/defer
 /test/eeed8b54e0df-test
 /test/eventfd
+/test/eventfd-disable
 /test/eventfd-ring
 /test/fadvise
 /test/fallocate
test/Makefile +2 -2
index ff4d4b8..a46e45d 100644
@@ -21,7 +21,7 @@ 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
+		lfs-openat lfs-openat-write eventfd-disable
 
 include ../Makefile.quiet
 
@@ -53,7 +53,7 @@ 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
+	splice.c lfs-openat.c lfs-openat-write.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