linux-api.vger.kernel.org archive mirror
 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>,
	"Elizabeth Figura" <zfigura@codeweavers.com>
Subject: [PATCH v3 06/30] ntsync: Introduce NTSYNC_IOC_CREATE_MUTEX.
Date: Thu, 28 Mar 2024 19:05:57 -0500	[thread overview]
Message-ID: <20240329000621.148791-7-zfigura@codeweavers.com> (raw)
In-Reply-To: <20240329000621.148791-1-zfigura@codeweavers.com>

This corresponds to the NT syscall NtCreateMutant().

An NT mutex is recursive, with a 32-bit recursion counter. When acquired via
NtWaitForMultipleObjects(), the recursion counter is incremented by one.

The OS records the thread which acquired it. However, in order to keep this
driver self-contained, the owning thread ID is managed by user-space, and passed
as a parameter to all relevant ioctls.

The initial owner and recursion count, if any, are specified when the mutex is
created.

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

diff --git a/drivers/misc/ntsync.c b/drivers/misc/ntsync.c
index e914d626465a..173513aeeacc 100644
--- a/drivers/misc/ntsync.c
+++ b/drivers/misc/ntsync.c
@@ -24,6 +24,7 @@
 
 enum ntsync_type {
 	NTSYNC_TYPE_SEM,
+	NTSYNC_TYPE_MUTEX,
 };
 
 /*
@@ -53,6 +54,10 @@ struct ntsync_obj {
 			__u32 count;
 			__u32 max;
 		} sem;
+		struct {
+			__u32 count;
+			__u32 owner;
+		} mutex;
 	} u;
 
 	/*
@@ -132,6 +137,10 @@ static bool is_signaled(struct ntsync_obj *obj, __u32 owner)
 	switch (obj->type) {
 	case NTSYNC_TYPE_SEM:
 		return !!obj->u.sem.count;
+	case NTSYNC_TYPE_MUTEX:
+		if (obj->u.mutex.owner && obj->u.mutex.owner != owner)
+			return false;
+		return obj->u.mutex.count < UINT_MAX;
 	}
 
 	WARN(1, "bad object type %#x\n", obj->type);
@@ -175,6 +184,10 @@ static void try_wake_all(struct ntsync_device *dev, struct ntsync_q *q,
 			case NTSYNC_TYPE_SEM:
 				obj->u.sem.count--;
 				break;
+			case NTSYNC_TYPE_MUTEX:
+				obj->u.mutex.count++;
+				obj->u.mutex.owner = q->owner;
+				break;
 			}
 		}
 		wake_up_process(q->task);
@@ -217,6 +230,29 @@ static void try_wake_any_sem(struct ntsync_obj *sem)
 	}
 }
 
+static void try_wake_any_mutex(struct ntsync_obj *mutex)
+{
+	struct ntsync_q_entry *entry;
+
+	lockdep_assert_held(&mutex->lock);
+
+	list_for_each_entry(entry, &mutex->any_waiters, node) {
+		struct ntsync_q *q = entry->q;
+		int signaled = -1;
+
+		if (mutex->u.mutex.count == UINT_MAX)
+			break;
+		if (mutex->u.mutex.owner && mutex->u.mutex.owner != q->owner)
+			continue;
+
+		if (atomic_try_cmpxchg(&q->signaled, &signaled, entry->index)) {
+			mutex->u.mutex.count++;
+			mutex->u.mutex.owner = q->owner;
+			wake_up_process(q->task);
+		}
+	}
+}
+
 /*
  * Actually change the semaphore state, returning -EOVERFLOW if it is made
  * invalid.
@@ -376,6 +412,33 @@ static int ntsync_create_sem(struct ntsync_device *dev, void __user *argp)
 	return put_user(fd, &user_args->sem);
 }
 
+static int ntsync_create_mutex(struct ntsync_device *dev, void __user *argp)
+{
+	struct ntsync_mutex_args __user *user_args = argp;
+	struct ntsync_mutex_args args;
+	struct ntsync_obj *mutex;
+	int fd;
+
+	if (copy_from_user(&args, argp, sizeof(args)))
+		return -EFAULT;
+
+	if (!args.owner != !args.count)
+		return -EINVAL;
+
+	mutex = ntsync_alloc_obj(dev, NTSYNC_TYPE_MUTEX);
+	if (!mutex)
+		return -ENOMEM;
+	mutex->u.mutex.count = args.count;
+	mutex->u.mutex.owner = args.owner;
+	fd = ntsync_obj_get_fd(mutex);
+	if (fd < 0) {
+		kfree(mutex);
+		return fd;
+	}
+
+	return put_user(fd, &user_args->mutex);
+}
+
 static struct ntsync_obj *get_obj(struct ntsync_device *dev, int fd)
 {
 	struct file *file = fget(fd);
@@ -505,6 +568,9 @@ static void try_wake_any_obj(struct ntsync_obj *obj)
 	case NTSYNC_TYPE_SEM:
 		try_wake_any_sem(obj);
 		break;
+	case NTSYNC_TYPE_MUTEX:
+		try_wake_any_mutex(obj);
+		break;
 	}
 }
 
@@ -693,6 +759,8 @@ static long ntsync_char_ioctl(struct file *file, unsigned int cmd,
 	void __user *argp = (void __user *)parm;
 
 	switch (cmd) {
+	case NTSYNC_IOC_CREATE_MUTEX:
+		return ntsync_create_mutex(dev, argp);
 	case NTSYNC_IOC_CREATE_SEM:
 		return ntsync_create_sem(dev, argp);
 	case NTSYNC_IOC_WAIT_ALL:
diff --git a/include/uapi/linux/ntsync.h b/include/uapi/linux/ntsync.h
index 83784d4438a1..cd7841cdba49 100644
--- a/include/uapi/linux/ntsync.h
+++ b/include/uapi/linux/ntsync.h
@@ -16,6 +16,12 @@ struct ntsync_sem_args {
 	__u32 max;
 };
 
+struct ntsync_mutex_args {
+	__u32 mutex;
+	__u32 owner;
+	__u32 count;
+};
+
 #define NTSYNC_WAIT_REALTIME	0x1
 
 struct ntsync_wait_args {
@@ -34,6 +40,7 @@ struct ntsync_wait_args {
 #define NTSYNC_IOC_CREATE_SEM		_IOWR('N', 0x80, struct ntsync_sem_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		_IOWR('N', 0x84, struct ntsync_sem_args)
 
 #define NTSYNC_IOC_SEM_POST		_IOWR('N', 0x81, __u32)
 
-- 
2.43.0


  parent reply	other threads:[~2024-03-29  0:24 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-29  0:05 [PATCH v3 00/30] NT synchronization primitive driver Elizabeth Figura
2024-03-29  0:05 ` [PATCH v3 01/30] ntsync: Introduce the ntsync driver and character device Elizabeth Figura
2024-03-29  0:05 ` [PATCH v3 02/30] ntsync: Introduce NTSYNC_IOC_CREATE_SEM Elizabeth Figura
2024-03-29  0:05 ` [PATCH v3 03/30] ntsync: Introduce NTSYNC_IOC_SEM_POST Elizabeth Figura
2024-04-11 13:35   ` Greg Kroah-Hartman
2024-03-29  0:05 ` [PATCH v3 04/30] ntsync: Introduce NTSYNC_IOC_WAIT_ANY Elizabeth Figura
2024-04-11 13:34   ` Greg Kroah-Hartman
2024-04-12  0:33     ` Elizabeth Figura
2024-04-12  6:16       ` Greg Kroah-Hartman
2024-03-29  0:05 ` [PATCH v3 05/30] ntsync: Introduce NTSYNC_IOC_WAIT_ALL Elizabeth Figura
2024-03-29  0:05 ` Elizabeth Figura [this message]
2024-03-29  0:05 ` [PATCH v3 07/30] ntsync: Introduce NTSYNC_IOC_MUTEX_UNLOCK Elizabeth Figura
2024-03-29  0:05 ` [PATCH v3 08/30] ntsync: Introduce NTSYNC_IOC_MUTEX_KILL Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 09/30] ntsync: Introduce NTSYNC_IOC_CREATE_EVENT Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 10/30] ntsync: Introduce NTSYNC_IOC_EVENT_SET Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 11/30] ntsync: Introduce NTSYNC_IOC_EVENT_RESET Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 12/30] ntsync: Introduce NTSYNC_IOC_EVENT_PULSE Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 13/30] ntsync: Introduce NTSYNC_IOC_SEM_READ Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 14/30] ntsync: Introduce NTSYNC_IOC_MUTEX_READ Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 15/30] ntsync: Introduce NTSYNC_IOC_EVENT_READ Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 16/30] ntsync: Introduce alertable waits Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 17/30] selftests: ntsync: Add some tests for semaphore state Elizabeth Figura
2024-03-29 20:07   ` Muhammad Usama Anjum
2024-03-29  0:06 ` [PATCH v3 18/30] selftests: ntsync: Add some tests for mutex state Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 19/30] selftests: ntsync: Add some tests for NTSYNC_IOC_WAIT_ANY Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 20/30] selftests: ntsync: Add some tests for NTSYNC_IOC_WAIT_ALL Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 21/30] selftests: ntsync: Add some tests for wakeup signaling with WINESYNC_IOC_WAIT_ANY Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 22/30] selftests: ntsync: Add some tests for wakeup signaling with WINESYNC_IOC_WAIT_ALL Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 23/30] selftests: ntsync: Add some tests for manual-reset event state Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 24/30] selftests: ntsync: Add some tests for auto-reset " Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 25/30] selftests: ntsync: Add some tests for wakeup signaling with events Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 26/30] selftests: ntsync: Add tests for alertable waits Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 27/30] selftests: ntsync: Add some tests for wakeup signaling via alerts Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 28/30] selftests: ntsync: Add a stress test for contended waits Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 29/30] maintainers: Add an entry for ntsync Elizabeth Figura
2024-03-29  0:06 ` [PATCH v3 30/30] docs: ntsync: Add documentation for the ntsync uAPI Elizabeth Figura
2024-04-12  5:52   ` Bagas Sanjaya

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=20240329000621.148791-7-zfigura@codeweavers.com \
    --to=zfigura@codeweavers.com \
    --cc=ahiler@codeweavers.com \
    --cc=andrealmeid@igalia.com \
    --cc=arnd@arndb.de \
    --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=luto@kernel.org \
    --cc=peterz@infradead.org \
    --cc=rdunlap@infradead.org \
    --cc=shuah@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;
as well as URLs for NNTP newsgroup(s).