Rework mutex implementation selection

5 files changed, 309 insertions, 0 deletions

diff --git a/kern/mutex/mutex_pi_i.h b/kern/mutex/mutex_pi_i.h
new file mode 100644
index 00000000..6c39db74
--- /dev/null
+++ b/kern/mutex/mutex_pi_i.h
@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) 2017 Richard Braun.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef _KERN_MUTEX_PI_I_H
+#define _KERN_MUTEX_PI_I_H
+
+#ifndef _KERN_MUTEX_H
+#error "don't include <kern/mutex/mutex_pi_i.h> directly," \
+       " use <kern/mutex.h> instead"
+#endif
+
+#include <kern/mutex_types.h>
+#include <kern/rtmutex.h>
+
+/*
+ * Interface exported to the public mutex header.
+ */
+
+static inline void
+mutex_impl_init(struct mutex *mutex)
+{
+    rtmutex_init(&mutex->rtmutex);
+}
+
+#define mutex_impl_assert_locked(mutex) \
+    rtmutex_assert_locked(&(mutex)->rtmutex)
+
+static inline int
+mutex_impl_trylock(struct mutex *mutex)
+{
+    return rtmutex_trylock(&mutex->rtmutex);
+}
+
+static inline void
+mutex_impl_lock(struct mutex *mutex)
+{
+    rtmutex_lock(&mutex->rtmutex);
+}
+
+static inline void
+mutex_impl_unlock(struct mutex *mutex)
+{
+    rtmutex_unlock(&mutex->rtmutex);
+}
+
+#endif /* _KERN_MUTEX_PI_I_H */
diff --git a/kern/mutex/mutex_pi_types.h b/kern/mutex/mutex_pi_types.h
new file mode 100644
index 00000000..d9ebb6e2
--- /dev/null
+++ b/kern/mutex/mutex_pi_types.h
@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2017 Richard Braun.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ *
+ * Isolated type definition used to avoid inclusion circular dependencies.
+ */
+
+#ifndef _KERN_MUTEX_PI_TYPES_H
+#define _KERN_MUTEX_PI_TYPES_H
+
+#ifndef _KERN_MUTEX_TYPES_H
+#error "don't include <kern/mutex/mutex_pi_types.h> directly," \
+       " use <kern/mutex_types.h> instead"
+#endif
+
+#include <kern/rtmutex_types.h>
+
+/*
+ * Do not directly alias rtmutex to make sure they cannot be used
+ * with condition variables by mistake.
+ */
+struct mutex {
+    struct rtmutex rtmutex;
+};
+
+#endif /* _KERN_MUTEX_PI_TYPES_H */
diff --git a/kern/mutex/mutex_plain.c b/kern/mutex/mutex_plain.c
new file mode 100644
index 00000000..a925a5a2
--- /dev/null
+++ b/kern/mutex/mutex_plain.c
@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2017 Richard Braun.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <stdbool.h>
+#include <stddef.h>
+
+#include <kern/atomic.h>
+#include <kern/mutex.h>
+#include <kern/mutex_types.h>
+#include <kern/sleepq.h>
+
+void
+mutex_plain_lock_slow(struct mutex *mutex)
+{
+    unsigned int state;
+    struct sleepq *sleepq;
+    unsigned long flags;
+
+    sleepq = sleepq_lend(mutex, false, &flags);
+
+    for (;;) {
+        state = atomic_swap_release(&mutex->state, MUTEX_CONTENDED);
+
+        if (state == MUTEX_UNLOCKED) {
+            break;
+        }
+
+        sleepq_wait(sleepq, "mutex");
+    }
+
+    if (sleepq_empty(sleepq)) {
+        /* TODO Review memory order */
+        atomic_store(&mutex->state, MUTEX_LOCKED, ATOMIC_RELEASE);
+    }
+
+    sleepq_return(sleepq, flags);
+}
+
+void
+mutex_plain_unlock_slow(struct mutex *mutex)
+{
+    struct sleepq *sleepq;
+    unsigned long flags;
+
+    sleepq = sleepq_acquire(mutex, false, &flags);
+
+    if (sleepq != NULL) {
+        sleepq_signal(sleepq);
+        sleepq_release(sleepq, flags);
+    }
+}
diff --git a/kern/mutex/mutex_plain_i.h b/kern/mutex/mutex_plain_i.h
new file mode 100644
index 00000000..9e41ff27
--- /dev/null
+++ b/kern/mutex/mutex_plain_i.h
@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) 2017 Richard Braun.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef _KERN_MUTEX_PLAIN_I_H
+#define _KERN_MUTEX_PLAIN_I_H
+
+#ifndef _KERN_MUTEX_H
+#error "don't include <kern/mutex/mutex_plain_i.h> directly," \
+       " use <kern/mutex.h> instead"
+#endif
+
+#include <kern/assert.h>
+#include <kern/atomic.h>
+#include <kern/error.h>
+#include <kern/mutex_types.h>
+
+#define MUTEX_UNLOCKED  0
+#define MUTEX_LOCKED    1
+#define MUTEX_CONTENDED 2
+
+static inline void
+mutex_plain_init(struct mutex *mutex)
+{
+    mutex->state = MUTEX_UNLOCKED;
+}
+
+#define mutex_plain_assert_locked(mutex) \
+    assert((mutex)->state != MUTEX_UNLOCKED)
+
+static inline int
+mutex_plain_lock_fast(struct mutex *mutex)
+{
+    unsigned int state;
+
+    state = atomic_cas_acquire(&mutex->state, MUTEX_UNLOCKED, MUTEX_LOCKED);
+
+    if (unlikely(state != MUTEX_UNLOCKED)) {
+        return ERROR_BUSY;
+    }
+
+    return 0;
+}
+
+static inline int
+mutex_plain_unlock_fast(struct mutex *mutex)
+{
+    unsigned int state;
+
+    state = atomic_swap_release(&mutex->state, MUTEX_UNLOCKED);
+
+    if (unlikely(state == MUTEX_CONTENDED)) {
+        return ERROR_BUSY;
+    }
+
+    return 0;
+}
+
+void mutex_plain_lock_slow(struct mutex *mutex);
+void mutex_plain_unlock_slow(struct mutex *mutex);
+
+/*
+ * Interface exported to the public mutex header.
+ */
+
+#define mutex_impl_init             mutex_plain_init
+#define mutex_impl_assert_locked    mutex_plain_assert_locked
+
+static inline int
+mutex_impl_trylock(struct mutex *mutex)
+{
+    return mutex_plain_lock_fast(mutex);
+}
+
+static inline void
+mutex_impl_lock(struct mutex *mutex)
+{
+    int error;
+
+    error = mutex_plain_lock_fast(mutex);
+
+    if (unlikely(error)) {
+        mutex_plain_lock_slow(mutex);
+    }
+}
+
+static inline void
+mutex_impl_unlock(struct mutex *mutex)
+{
+    int error;
+
+    error = mutex_plain_unlock_fast(mutex);
+
+    if (unlikely(error)) {
+        mutex_plain_unlock_slow(mutex);
+    }
+}
+
+#endif /* _KERN_MUTEX_PLAIN_I_H */
diff --git a/kern/mutex/mutex_plain_types.h b/kern/mutex/mutex_plain_types.h
new file mode 100644
index 00000000..02731e94
--- /dev/null
+++ b/kern/mutex/mutex_plain_types.h
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2017 Richard Braun.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ *
+ * Isolated type definition used to avoid inclusion circular dependencies.
+ */
+
+#ifndef _KERN_MUTEX_PLAIN_TYPES_H
+#define _KERN_MUTEX_PLAIN_TYPES_H
+
+#ifndef _KERN_MUTEX_TYPES_H
+#error "don't include <kern/mutex/mutex_plain_types.h> directly," \
+       " use <kern/mutex_types.h> instead"
+#endif
+
+struct mutex {
+    unsigned int state;
+};
+
+#endif /* _KERN_MUTEX_PLAIN_TYPES_H */