Linux Kernel Mailing List | 1 Apr 20:01 2009

eventfd: improve support for semaphore-like behavior

Gitweb:     http://git.kernel.org/linus/bcd0b235bf3808dec5115c381cd55568f63b85f0
Commit:     bcd0b235bf3808dec5115c381cd55568f63b85f0
Parent:     4f0989dbfa8d18dd17c32120aac1eb3e906a62a2
Author:     Davide Libenzi <davidel <at> xmailserver.org>
AuthorDate: Tue Mar 31 15:24:18 2009 -0700
Committer:  Linus Torvalds <torvalds <at> linux-foundation.org>
CommitDate: Wed Apr 1 08:59:20 2009 -0700

    eventfd: improve support for semaphore-like behavior

    People started using eventfd in a semaphore-like way where before they
    were using pipes.

    That is, counter-based resource access.  Where a "wait()" returns
    immediately by decrementing the counter by one, if counter is greater than
    zero.  Otherwise will wait.  And where a "post(count)" will add count to
    the counter releasing the appropriate amount of waiters.  If eventfd the
    "post" (write) part is fine, while the "wait" (read) does not dequeue 1,
    but the whole counter value.

    The problem with eventfd is that a read() on the fd returns and wipes the
    whole counter, making the use of it as semaphore a little bit more
    cumbersome.  You can do a read() followed by a write() of COUNTER-1, but
    IMO it's pretty easy and cheap to make this work w/out extra steps.  This
    patch introduces a new eventfd flag that tells eventfd to only dequeue 1
    from the counter, allowing simple read/write to make it behave like a
    semaphore.  Simple test here:

    http://www.xmailserver.org/eventfd-sem.c

    To be back-compatible with earlier kernels, userspace applications should
    probe for the availability of this feature via

    #ifdef EFD_SEMAPHORE
    	fd = eventfd2 (CNT, EFD_SEMAPHORE);
    	if (fd == -1 && errno == EINVAL)
    		<fallback>
    #else
    		<fallback>
    #endif

    Signed-off-by: Davide Libenzi <davidel <at> xmailserver.org>
    Cc: <linux-api <at> vger.kernel.org>
    Tested-by: Michael Kerrisk <mtk.manpages <at> gmail.com>
    Cc: Ulrich Drepper <drepper <at> redhat.com>
    Signed-off-by: Andrew Morton <akpm <at> linux-foundation.org>
    Signed-off-by: Linus Torvalds <torvalds <at> linux-foundation.org>
---
 fs/eventfd.c            |   20 +++++++++++---------
 include/linux/eventfd.h |   12 +++++++++++-
 2 files changed, 22 insertions(+), 10 deletions(-)

diff --git a/fs/eventfd.c b/fs/eventfd.c
index 5de2c2d..91c0829 100644
--- a/fs/eventfd.c
+++ b/fs/eventfd.c
 <at>  <at>  -28,6 +28,7  <at>  <at>  struct eventfd_ctx {
 	 * issue a wakeup.
 	 */
 	__u64 count;
+	unsigned int flags;
 };

 /*
 <at>  <at>  -87,22 +88,20  <at>  <at>  static ssize_t eventfd_read(struct file *file, char __user *buf, size_t count,
 {
 	struct eventfd_ctx *ctx = file->private_data;
 	ssize_t res;
-	__u64 ucnt;
+	__u64 ucnt = 0;
 	DECLARE_WAITQUEUE(wait, current);

 	if (count < sizeof(ucnt))
 		return -EINVAL;
 	spin_lock_irq(&ctx->wqh.lock);
 	res = -EAGAIN;
-	ucnt = ctx->count;
-	if (ucnt > 0)
+	if (ctx->count > 0)
 		res = sizeof(ucnt);
 	else if (!(file->f_flags & O_NONBLOCK)) {
 		__add_wait_queue(&ctx->wqh, &wait);
 		for (res = 0;;) {
 			set_current_state(TASK_INTERRUPTIBLE);
 			if (ctx->count > 0) {
-				ucnt = ctx->count;
 				res = sizeof(ucnt);
 				break;
 			}
 <at>  <at>  -117,8 +116,9  <at>  <at>  static ssize_t eventfd_read(struct file *file, char __user *buf, size_t count,
 		__remove_wait_queue(&ctx->wqh, &wait);
 		__set_current_state(TASK_RUNNING);
 	}
-	if (res > 0) {
-		ctx->count = 0;
+	if (likely(res > 0)) {
+		ucnt = (ctx->flags & EFD_SEMAPHORE) ? 1 : ctx->count;
+		ctx->count -= ucnt;
 		if (waitqueue_active(&ctx->wqh))
 			wake_up_locked(&ctx->wqh);
 	}
 <at>  <at>  -166,7 +166,7  <at>  <at>  static ssize_t eventfd_write(struct file *file, const char __user *buf, size_t c
 		__remove_wait_queue(&ctx->wqh, &wait);
 		__set_current_state(TASK_RUNNING);
 	}
-	if (res > 0) {
+	if (likely(res > 0)) {
 		ctx->count += ucnt;
 		if (waitqueue_active(&ctx->wqh))
 			wake_up_locked(&ctx->wqh);
 <at>  <at>  -207,7 +207,7  <at>  <at>  SYSCALL_DEFINE2(eventfd2, unsigned int, count, int, flags)
 	BUILD_BUG_ON(EFD_CLOEXEC != O_CLOEXEC);
 	BUILD_BUG_ON(EFD_NONBLOCK != O_NONBLOCK);

-	if (flags & ~(EFD_CLOEXEC | EFD_NONBLOCK))
+	if (flags & ~EFD_FLAGS_SET)
 		return -EINVAL;

 	ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
 <at>  <at>  -216,13 +216,14  <at>  <at>  SYSCALL_DEFINE2(eventfd2, unsigned int, count, int, flags)

 	init_waitqueue_head(&ctx->wqh);
 	ctx->count = count;
+	ctx->flags = flags;

 	/*
 	 * When we call this, the initialization must be complete, since
 	 * anon_inode_getfd() will install the fd.
 	 */
 	fd = anon_inode_getfd("[eventfd]", &eventfd_fops, ctx,
-			      flags & (O_CLOEXEC | O_NONBLOCK));
+			      flags & EFD_SHARED_FCNTL_FLAGS);
 	if (fd < 0)
 		kfree(ctx);
 	return fd;
 <at>  <at>  -232,3 +233,4  <at>  <at>  SYSCALL_DEFINE1(eventfd, unsigned int, count)
 {
 	return sys_eventfd2(count, 0);
 }
+
diff --git a/include/linux/eventfd.h b/include/linux/eventfd.h
index a667637..f45a8ae 100644
--- a/include/linux/eventfd.h
+++ b/include/linux/eventfd.h
 <at>  <at>  -13,10 +13,20  <at>  <at> 
 /* For O_CLOEXEC and O_NONBLOCK */
 #include <linux/fcntl.h>

-/* Flags for eventfd2.  */
+/*
+ * CAREFUL: Check include/asm-generic/fcntl.h when defining
+ * new flags, since they might collide with O_* ones. We want
+ * to re-use O_* flags that couldn't possibly have a meaning
+ * from eventfd, in order to leave a free define-space for
+ * shared O_* flags.
+ */
+#define EFD_SEMAPHORE (1 << 0)
 #define EFD_CLOEXEC O_CLOEXEC
 #define EFD_NONBLOCK O_NONBLOCK

+#define EFD_SHARED_FCNTL_FLAGS (O_CLOEXEC | O_NONBLOCK)
+#define EFD_FLAGS_SET (EFD_SHARED_FCNTL_FLAGS | EFD_SEMAPHORE)
+
 struct file *eventfd_fget(int fd);
 int eventfd_signal(struct file *file, int n);

--
To unsubscribe from this list: send the line "unsubscribe git-commits-head" in
the body of a message to majordomo <at> vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Gmane