Linux Documentation
 help / color / mirror / Atom feed
From: Elizabeth Figura <zfigura@codeweavers.com>
To: Arnd Bergmann <arnd@arndb.de>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Jonathan Corbet <corbet@lwn.net>, Shuah Khan <shuah@kernel.org>
Cc: linux-kernel@vger.kernel.org, linux-api@vger.kernel.org,
	wine-devel@winehq.org, "André Almeida" <andrealmeid@igalia.com>,
	"Wolfram Sang" <wsa@kernel.org>,
	"Arkadiusz Hiler" <ahiler@codeweavers.com>,
	"Peter Zijlstra" <peterz@infradead.org>,
	"Andy Lutomirski" <luto@kernel.org>,
	linux-doc@vger.kernel.org, linux-kselftest@vger.kernel.org,
	"Randy Dunlap" <rdunlap@infradead.org>,
	"Ingo Molnar" <mingo@redhat.com>, "Will Deacon" <will@kernel.org>,
	"Waiman Long" <longman@redhat.com>,
	"Boqun Feng" <boqun.feng@gmail.com>,
	"Elizabeth Figura" <zfigura@codeweavers.com>
Subject: [PATCH v7 08/30] ntsync: Introduce NTSYNC_IOC_CREATE_EVENT.
Date: Fri, 13 Dec 2024 13:34:49 -0600	[thread overview]
Message-ID: <20241213193511.457338-9-zfigura@codeweavers.com> (raw)
In-Reply-To: <20241213193511.457338-1-zfigura@codeweavers.com>

This correspond to the NT syscall NtCreateEvent().

An NT event holds a single bit of state denoting whether it is signaled or
unsignaled.

There are two types of events: manual-reset and automatic-reset. When an
automatic-reset event is acquired via a wait function, its state is reset to
unsignaled. Manual-reset events are not affected by wait functions.

Whether the event is manual-reset, and its initial state, are specified at
creation time.

Signed-off-by: Elizabeth Figura <zfigura@codeweavers.com>
---
 drivers/misc/ntsync.c       | 59 +++++++++++++++++++++++++++++++++++++
 include/uapi/linux/ntsync.h |  6 ++++
 2 files changed, 65 insertions(+)

diff --git a/drivers/misc/ntsync.c b/drivers/misc/ntsync.c
index 03768ac25425..3e8827b6f480 100644
--- a/drivers/misc/ntsync.c
+++ b/drivers/misc/ntsync.c
@@ -26,6 +26,7 @@
 enum ntsync_type {
 	NTSYNC_TYPE_SEM,
 	NTSYNC_TYPE_MUTEX,
+	NTSYNC_TYPE_EVENT,
 };
 
 /*
@@ -61,6 +62,10 @@ struct ntsync_obj {
 			pid_t owner;
 			bool ownerdead;
 		} mutex;
+		struct {
+			bool manual;
+			bool signaled;
+		} event;
 	} u;
 
 	/*
@@ -233,6 +238,8 @@ static bool is_signaled(struct ntsync_obj *obj, __u32 owner)
 		if (obj->u.mutex.owner && obj->u.mutex.owner != owner)
 			return false;
 		return obj->u.mutex.count < UINT_MAX;
+	case NTSYNC_TYPE_EVENT:
+		return obj->u.event.signaled;
 	}
 
 	WARN(1, "bad object type %#x\n", obj->type);
@@ -283,6 +290,10 @@ static void try_wake_all(struct ntsync_device *dev, struct ntsync_q *q,
 				obj->u.mutex.count++;
 				obj->u.mutex.owner = q->owner;
 				break;
+			case NTSYNC_TYPE_EVENT:
+				if (!obj->u.event.manual)
+					obj->u.event.signaled = false;
+				break;
 			}
 		}
 		wake_up_process(q->task);
@@ -353,6 +364,28 @@ static void try_wake_any_mutex(struct ntsync_obj *mutex)
 	}
 }
 
+static void try_wake_any_event(struct ntsync_obj *event)
+{
+	struct ntsync_q_entry *entry;
+
+	ntsync_assert_held(event);
+	lockdep_assert(event->type == NTSYNC_TYPE_EVENT);
+
+	list_for_each_entry(entry, &event->any_waiters, node) {
+		struct ntsync_q *q = entry->q;
+		int signaled = -1;
+
+		if (!event->u.event.signaled)
+			break;
+
+		if (atomic_try_cmpxchg(&q->signaled, &signaled, entry->index)) {
+			if (!event->u.event.manual)
+				event->u.event.signaled = false;
+			wake_up_process(q->task);
+		}
+	}
+}
+
 /*
  * Actually change the semaphore state, returning -EOVERFLOW if it is made
  * invalid.
@@ -622,6 +655,27 @@ static int ntsync_create_mutex(struct ntsync_device *dev, void __user *argp)
 	return fd;
 }
 
+static int ntsync_create_event(struct ntsync_device *dev, void __user *argp)
+{
+	struct ntsync_event_args args;
+	struct ntsync_obj *event;
+	int fd;
+
+	if (copy_from_user(&args, argp, sizeof(args)))
+		return -EFAULT;
+
+	event = ntsync_alloc_obj(dev, NTSYNC_TYPE_EVENT);
+	if (!event)
+		return -ENOMEM;
+	event->u.event.manual = args.manual;
+	event->u.event.signaled = args.signaled;
+	fd = ntsync_obj_get_fd(event);
+	if (fd < 0)
+		kfree(event);
+
+	return fd;
+}
+
 static struct ntsync_obj *get_obj(struct ntsync_device *dev, int fd)
 {
 	struct file *file = fget(fd);
@@ -752,6 +806,9 @@ static void try_wake_any_obj(struct ntsync_obj *obj)
 	case NTSYNC_TYPE_MUTEX:
 		try_wake_any_mutex(obj);
 		break;
+	case NTSYNC_TYPE_EVENT:
+		try_wake_any_event(obj);
+		break;
 	}
 }
 
@@ -941,6 +998,8 @@ static long ntsync_char_ioctl(struct file *file, unsigned int cmd,
 	void __user *argp = (void __user *)parm;
 
 	switch (cmd) {
+	case NTSYNC_IOC_CREATE_EVENT:
+		return ntsync_create_event(dev, argp);
 	case NTSYNC_IOC_CREATE_MUTEX:
 		return ntsync_create_mutex(dev, argp);
 	case NTSYNC_IOC_CREATE_SEM:
diff --git a/include/uapi/linux/ntsync.h b/include/uapi/linux/ntsync.h
index 633958d90be3..e08aa02f4dcc 100644
--- a/include/uapi/linux/ntsync.h
+++ b/include/uapi/linux/ntsync.h
@@ -20,6 +20,11 @@ struct ntsync_mutex_args {
 	__u32 count;
 };
 
+struct ntsync_event_args {
+	__u32 manual;
+	__u32 signaled;
+};
+
 #define NTSYNC_WAIT_REALTIME	0x1
 
 struct ntsync_wait_args {
@@ -38,6 +43,7 @@ struct ntsync_wait_args {
 #define NTSYNC_IOC_WAIT_ANY		_IOWR('N', 0x82, struct ntsync_wait_args)
 #define NTSYNC_IOC_WAIT_ALL		_IOWR('N', 0x83, struct ntsync_wait_args)
 #define NTSYNC_IOC_CREATE_MUTEX		_IOW ('N', 0x84, struct ntsync_mutex_args)
+#define NTSYNC_IOC_CREATE_EVENT		_IOW ('N', 0x87, struct ntsync_event_args)
 
 #define NTSYNC_IOC_SEM_RELEASE		_IOWR('N', 0x81, __u32)
 #define NTSYNC_IOC_MUTEX_UNLOCK		_IOWR('N', 0x85, struct ntsync_mutex_args)
-- 
2.45.2


  parent reply	other threads:[~2024-12-13 19:35 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-13 19:34 [PATCH v7 00/30] NT synchronization primitive driver Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 01/30] ntsync: Return the fd from NTSYNC_IOC_CREATE_SEM Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 02/30] ntsync: Rename NTSYNC_IOC_SEM_POST to NTSYNC_IOC_SEM_RELEASE Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 03/30] ntsync: Introduce NTSYNC_IOC_WAIT_ANY Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 04/30] ntsync: Introduce NTSYNC_IOC_WAIT_ALL Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 05/30] ntsync: Introduce NTSYNC_IOC_CREATE_MUTEX Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 06/30] ntsync: Introduce NTSYNC_IOC_MUTEX_UNLOCK Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 07/30] ntsync: Introduce NTSYNC_IOC_MUTEX_KILL Elizabeth Figura
2024-12-13 19:34 ` Elizabeth Figura [this message]
2024-12-13 19:34 ` [PATCH v7 09/30] ntsync: Introduce NTSYNC_IOC_EVENT_SET Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 10/30] ntsync: Introduce NTSYNC_IOC_EVENT_RESET Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 11/30] ntsync: Introduce NTSYNC_IOC_EVENT_PULSE Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 12/30] ntsync: Introduce NTSYNC_IOC_SEM_READ Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 13/30] ntsync: Introduce NTSYNC_IOC_MUTEX_READ Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 14/30] ntsync: Introduce NTSYNC_IOC_EVENT_READ Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 15/30] ntsync: Introduce alertable waits Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 16/30] selftests: ntsync: Add some tests for semaphore state Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 17/30] selftests: ntsync: Add some tests for mutex state Elizabeth Figura
2024-12-13 19:34 ` [PATCH v7 18/30] selftests: ntsync: Add some tests for NTSYNC_IOC_WAIT_ANY Elizabeth Figura
2024-12-13 19:35 ` [PATCH v7 19/30] selftests: ntsync: Add some tests for NTSYNC_IOC_WAIT_ALL Elizabeth Figura
2024-12-13 19:35 ` [PATCH v7 20/30] selftests: ntsync: Add some tests for wakeup signaling with WINESYNC_IOC_WAIT_ANY Elizabeth Figura
2024-12-13 19:35 ` [PATCH v7 21/30] selftests: ntsync: Add some tests for wakeup signaling with WINESYNC_IOC_WAIT_ALL Elizabeth Figura
2024-12-13 19:35 ` [PATCH v7 22/30] selftests: ntsync: Add some tests for manual-reset event state Elizabeth Figura
2024-12-13 19:35 ` [PATCH v7 23/30] selftests: ntsync: Add some tests for auto-reset " Elizabeth Figura
2024-12-13 19:35 ` [PATCH v7 24/30] selftests: ntsync: Add some tests for wakeup signaling with events Elizabeth Figura
2024-12-13 19:35 ` [PATCH v7 25/30] selftests: ntsync: Add tests for alertable waits Elizabeth Figura
2024-12-13 19:35 ` [PATCH v7 26/30] selftests: ntsync: Add some tests for wakeup signaling via alerts Elizabeth Figura
2024-12-13 19:35 ` [PATCH v7 27/30] selftests: ntsync: Add a stress test for contended waits Elizabeth Figura
2024-12-13 19:35 ` [PATCH v7 28/30] maintainers: Add an entry for ntsync Elizabeth Figura
2024-12-13 19:35 ` [PATCH v7 29/30] docs: ntsync: Add documentation for the ntsync uAPI Elizabeth Figura
2024-12-13 19:35 ` [PATCH v7 30/30] ntsync: No longer depend on BROKEN Elizabeth Figura
2025-01-07 17:06 ` [PATCH v7 00/30] NT synchronization primitive driver Greg Kroah-Hartman
2025-01-07 19:42   ` Peter Zijlstra
2025-01-07 21:10     ` Elizabeth Figura

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=20241213193511.457338-9-zfigura@codeweavers.com \
    --to=zfigura@codeweavers.com \
    --cc=ahiler@codeweavers.com \
    --cc=andrealmeid@igalia.com \
    --cc=arnd@arndb.de \
    --cc=boqun.feng@gmail.com \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-api@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=longman@redhat.com \
    --cc=luto@kernel.org \
    --cc=mingo@redhat.com \
    --cc=peterz@infradead.org \
    --cc=rdunlap@infradead.org \
    --cc=shuah@kernel.org \
    --cc=will@kernel.org \
    --cc=wine-devel@winehq.org \
    --cc=wsa@kernel.org \
    /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