All of lore.kernel.org
 help / color / mirror / Atom feed
From: Kent Overstreet <kent.overstreet@linux.dev>
To: linux-kernel@vger.kernel.org, linux-mm@kvack.org,
	linux-fsdevel@vger.kernel.org
Cc: Kent Overstreet <kent.overstreet@linux.dev>,
	tglx@linutronix.de, x86@kernel.org, tj@kernel.org,
	peterz@infradead.org, mathieu.desnoyers@efficios.com,
	paulmck@kernel.org, keescook@chromium.org,
	dave.hansen@linux.intel.com, mingo@redhat.com, will@kernel.org,
	longman@redhat.com, boqun.feng@gmail.com, brauner@kernel.org
Subject: [PATCH 19/50] locking/mutex: split out mutex_types.h
Date: Fri, 15 Dec 2023 22:26:18 -0500	[thread overview]
Message-ID: <20231216032651.3553101-9-kent.overstreet@linux.dev> (raw)
In-Reply-To: <20231216032651.3553101-1-kent.overstreet@linux.dev>

Trimming down sched.h dependencies: we don't want to include more than
the base types.

Signed-off-by: Kent Overstreet <kent.overstreet@linux.dev>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Will Deacon <will@kernel.org>
Cc: Waiman Long <longman@redhat.com>
Cc: Boqun Feng <boqun.feng@gmail.com>
Signed-off-by: Kent Overstreet <kent.overstreet@linux.dev>
---
 include/linux/mutex.h       | 52 +--------------------------
 include/linux/mutex_types.h | 71 +++++++++++++++++++++++++++++++++++++
 include/linux/sched.h       |  2 +-
 3 files changed, 73 insertions(+), 52 deletions(-)
 create mode 100644 include/linux/mutex_types.h

diff --git a/include/linux/mutex.h b/include/linux/mutex.h
index a33aa9eb9fc3..0dfba5df6524 100644
--- a/include/linux/mutex.h
+++ b/include/linux/mutex.h
@@ -20,6 +20,7 @@
 #include <linux/osq_lock.h>
 #include <linux/debug_locks.h>
 #include <linux/cleanup.h>
+#include <linux/mutex_types.h>
 
 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 # define __DEP_MAP_MUTEX_INITIALIZER(lockname)			\
@@ -33,49 +34,6 @@
 
 #ifndef CONFIG_PREEMPT_RT
 
-/*
- * Simple, straightforward mutexes with strict semantics:
- *
- * - only one task can hold the mutex at a time
- * - only the owner can unlock the mutex
- * - multiple unlocks are not permitted
- * - recursive locking is not permitted
- * - a mutex object must be initialized via the API
- * - a mutex object must not be initialized via memset or copying
- * - task may not exit with mutex held
- * - memory areas where held locks reside must not be freed
- * - held mutexes must not be reinitialized
- * - mutexes may not be used in hardware or software interrupt
- *   contexts such as tasklets and timers
- *
- * These semantics are fully enforced when DEBUG_MUTEXES is
- * enabled. Furthermore, besides enforcing the above rules, the mutex
- * debugging code also implements a number of additional features
- * that make lock debugging easier and faster:
- *
- * - uses symbolic names of mutexes, whenever they are printed in debug output
- * - point-of-acquire tracking, symbolic lookup of function names
- * - list of all locks held in the system, printout of them
- * - owner tracking
- * - detects self-recursing locks and prints out all relevant info
- * - detects multi-task circular deadlocks and prints out all affected
- *   locks and tasks (and only those tasks)
- */
-struct mutex {
-	atomic_long_t		owner;
-	raw_spinlock_t		wait_lock;
-#ifdef CONFIG_MUTEX_SPIN_ON_OWNER
-	struct optimistic_spin_queue osq; /* Spinner MCS lock */
-#endif
-	struct list_head	wait_list;
-#ifdef CONFIG_DEBUG_MUTEXES
-	void			*magic;
-#endif
-#ifdef CONFIG_DEBUG_LOCK_ALLOC
-	struct lockdep_map	dep_map;
-#endif
-};
-
 #ifdef CONFIG_DEBUG_MUTEXES
 
 #define __DEBUG_MUTEX_INITIALIZER(lockname)				\
@@ -131,14 +89,6 @@ extern bool mutex_is_locked(struct mutex *lock);
 /*
  * Preempt-RT variant based on rtmutexes.
  */
-#include <linux/rtmutex.h>
-
-struct mutex {
-	struct rt_mutex_base	rtmutex;
-#ifdef CONFIG_DEBUG_LOCK_ALLOC
-	struct lockdep_map	dep_map;
-#endif
-};
 
 #define __MUTEX_INITIALIZER(mutexname)					\
 {									\
diff --git a/include/linux/mutex_types.h b/include/linux/mutex_types.h
new file mode 100644
index 000000000000..fdf7f515fde8
--- /dev/null
+++ b/include/linux/mutex_types.h
@@ -0,0 +1,71 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+#ifndef __LINUX_MUTEX_TYPES_H
+#define __LINUX_MUTEX_TYPES_H
+
+#include <linux/atomic.h>
+#include <linux/lockdep_types.h>
+#include <linux/osq_lock.h>
+#include <linux/spinlock_types.h>
+#include <linux/types.h>
+
+#ifndef CONFIG_PREEMPT_RT
+
+/*
+ * Simple, straightforward mutexes with strict semantics:
+ *
+ * - only one task can hold the mutex at a time
+ * - only the owner can unlock the mutex
+ * - multiple unlocks are not permitted
+ * - recursive locking is not permitted
+ * - a mutex object must be initialized via the API
+ * - a mutex object must not be initialized via memset or copying
+ * - task may not exit with mutex held
+ * - memory areas where held locks reside must not be freed
+ * - held mutexes must not be reinitialized
+ * - mutexes may not be used in hardware or software interrupt
+ *   contexts such as tasklets and timers
+ *
+ * These semantics are fully enforced when DEBUG_MUTEXES is
+ * enabled. Furthermore, besides enforcing the above rules, the mutex
+ * debugging code also implements a number of additional features
+ * that make lock debugging easier and faster:
+ *
+ * - uses symbolic names of mutexes, whenever they are printed in debug output
+ * - point-of-acquire tracking, symbolic lookup of function names
+ * - list of all locks held in the system, printout of them
+ * - owner tracking
+ * - detects self-recursing locks and prints out all relevant info
+ * - detects multi-task circular deadlocks and prints out all affected
+ *   locks and tasks (and only those tasks)
+ */
+struct mutex {
+	atomic_long_t		owner;
+	raw_spinlock_t		wait_lock;
+#ifdef CONFIG_MUTEX_SPIN_ON_OWNER
+	struct optimistic_spin_queue osq; /* Spinner MCS lock */
+#endif
+	struct list_head	wait_list;
+#ifdef CONFIG_DEBUG_MUTEXES
+	void			*magic;
+#endif
+#ifdef CONFIG_DEBUG_LOCK_ALLOC
+	struct lockdep_map	dep_map;
+#endif
+};
+
+#else /* !CONFIG_PREEMPT_RT */
+/*
+ * Preempt-RT variant based on rtmutexes.
+ */
+#include <linux/rtmutex.h>
+
+struct mutex {
+	struct rt_mutex_base	rtmutex;
+#ifdef CONFIG_DEBUG_LOCK_ALLOC
+	struct lockdep_map	dep_map;
+#endif
+};
+
+#endif /* CONFIG_PREEMPT_RT */
+
+#endif /* __LINUX_MUTEX_TYPES_H */
diff --git a/include/linux/sched.h b/include/linux/sched.h
index 3762809652da..e8892789969b 100644
--- a/include/linux/sched.h
+++ b/include/linux/sched.h
@@ -15,7 +15,7 @@
 #include <linux/sem.h>
 #include <linux/shm.h>
 #include <linux/kmsan_types.h>
-#include <linux/mutex.h>
+#include <linux/mutex_types.h>
 #include <linux/plist.h>
 #include <linux/hrtimer_types.h>
 #include <linux/irqflags.h>
-- 
2.43.0


  parent reply	other threads:[~2023-12-16  3:27 UTC|newest]

Thread overview: 96+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-16  2:47 [PATCH 00/50] big header dependency cleanup targeting sched.h Kent Overstreet
2023-12-16  2:47 ` [PATCH 01/50] drivers/gpu/drm/i915/i915_memcpy.c: fix missing includes Kent Overstreet
2024-03-08 13:46   ` Jani Nikula
2023-12-16  2:47 ` [PATCH 02/50] x86/kernel/fpu/bugs.c: fix missing include Kent Overstreet
2023-12-18 11:08   ` Sohil Mehta
2023-12-19  2:05     ` Kent Overstreet
2023-12-16  2:47 ` [PATCH 03/50] x86/lib/cache-smp.c: " Kent Overstreet
2023-12-18 10:48   ` Sohil Mehta
2023-12-19  2:06     ` Kent Overstreet
2023-12-19  4:04       ` Sohil Mehta
2023-12-16  2:47 ` [PATCH 04/50] x86/include/asm/debugreg.h: " Kent Overstreet
2023-12-16  2:47 ` [PATCH 05/50] x86/include/asm/paravirt_types.h: " Kent Overstreet
2023-12-16  2:47 ` [PATCH 06/50] task_stack.h: add " Kent Overstreet
2023-12-16  2:47 ` [PATCH 07/50] nsproxy.h: " Kent Overstreet
2023-12-16  2:47 ` [PATCH 08/50] kernel/fork.c: " Kent Overstreet
2023-12-16  2:47 ` [PATCH 09/50] kmsan: add missing types.h dependency Kent Overstreet
2023-12-16  2:47 ` [PATCH 10/50] time_namespace.h: fix missing include Kent Overstreet
2023-12-16  3:26 ` [PATCH 11/50] nodemask: Split out include/linux/nodemask_types.h Kent Overstreet
2023-12-16  3:26   ` [PATCH 12/50] prandom: Remove unused include Kent Overstreet
2023-12-16 18:52     ` Randy Dunlap
2023-12-16 22:19       ` Kent Overstreet
2023-12-16  3:26   ` [PATCH 13/50] timekeeping: Kill percpu.h dependency Kent Overstreet
2023-12-16  3:26   ` [PATCH 14/50] arm64: Fix circular header dependency Kent Overstreet
2023-12-16  3:26   ` [PATCH 15/50] kernel/numa.c: Move logging out of numa.h Kent Overstreet
2023-12-19 16:36     ` Nathan Chancellor
2023-12-19 21:02       ` Kent Overstreet
2023-12-19 22:52     ` Matthew Wilcox
2023-12-20  0:37       ` Kent Overstreet
2023-12-16  3:26   ` [PATCH 16/50] sched.h: Move (spin|rwlock)_needbreak() to spinlock.h Kent Overstreet
2024-01-15 20:31     ` Leonardo Bras
2023-12-16  3:26   ` [PATCH 17/50] ktime.h: move ktime_t to types.h Kent Overstreet
2023-12-16  3:26   ` [PATCH 18/50] hrtimers: Split out hrtimer_types.h Kent Overstreet
2023-12-16  3:26   ` Kent Overstreet [this message]
2023-12-18 16:53     ` [PATCH 19/50] locking/mutex: split out mutex_types.h Waiman Long
2023-12-18 18:12       ` Waiman Long
2023-12-19  1:46       ` Kent Overstreet
2023-12-19  3:04         ` Waiman Long
2023-12-19  3:37           ` Kent Overstreet
2023-12-19  3:39             ` Waiman Long
2023-12-16  3:26   ` [PATCH 20/50] posix-cpu-timers: Split out posix-timers_types.h Kent Overstreet
2023-12-16  3:26   ` [PATCH 21/50] locking/seqlock: Split out seqlock_types.h Kent Overstreet
2023-12-18 17:02     ` Waiman Long
2023-12-16  3:29 ` [PATCH 22/50] pid: Split out pid_types.h Kent Overstreet
2023-12-16  3:29   ` [PATCH 23/50] sched.h: move pid helpers to pid.h Kent Overstreet
2023-12-16  3:29   ` [PATCH 24/50] plist: Split out plist_types.h Kent Overstreet
2023-12-16  3:29   ` [PATCH 25/50] wait: Remove uapi header file from main header file Kent Overstreet
2023-12-18 12:39     ` Christian Brauner
2023-12-16  3:29   ` [PATCH 26/50] rslib: kill bogus dependency on list.h Kent Overstreet
2023-12-16 19:05     ` Randy Dunlap
2023-12-16 19:09       ` Kent Overstreet
2023-12-16 19:10       ` Randy Dunlap
2023-12-16  3:29   ` [PATCH 27/50] timerqueue: Split out timerqueue_types.h Kent Overstreet
2023-12-16  3:29   ` [PATCH 28/50] signal: Kill bogus dependency on list.h Kent Overstreet
2023-12-16  3:29   ` [PATCH 29/50] timers: Split out timer_types.h Kent Overstreet
2023-12-16  3:29   ` [PATCH 30/50] workqueue: Split out workqueue_types.h Kent Overstreet
2023-12-16  3:29   ` [PATCH 31/50] shm: Slim down dependencies Kent Overstreet
2023-12-16  3:29   ` [PATCH 32/50] ipc: Kill bogus dependency on spinlock.h Kent Overstreet
2023-12-18 11:04   ` [PATCH 22/50] pid: Split out pid_types.h Christian Brauner
2023-12-16  3:32 ` [PATCH 33/50] Split out irqflags_types.h Kent Overstreet
2023-12-16  3:32   ` [PATCH 34/50] mm_types_task.h: Trim dependencies Kent Overstreet
2023-12-16  3:32   ` [PATCH 35/50] cpumask: Split out cpumask_types.h Kent Overstreet
2023-12-16  3:32   ` [PATCH 36/50] syscall_user_dispatch.h: split out *_types.h Kent Overstreet
2023-12-16  3:32   ` [PATCH 37/50] x86/signal: kill dependency on time.h Kent Overstreet
2023-12-16  3:32   ` [PATCH 38/50] uapi/linux/resource.h: fix include Kent Overstreet
2023-12-16  3:32   ` [PATCH 39/50] refcount: Split out refcount_types.h Kent Overstreet
2023-12-16  3:32   ` [PATCH 40/50] seccomp: Split out seccomp_types.h Kent Overstreet
2023-12-16  3:32   ` [PATCH 41/50] uidgid: Split out uidgid_types.h Kent Overstreet
2023-12-18 11:01     ` Christian Brauner
2023-12-16  3:32   ` [PATCH 42/50] sem: Split out sem_types.h Kent Overstreet
2023-12-20 11:53     ` Geert Uytterhoeven
2023-12-20 21:39       ` Kent Overstreet
2024-01-02  8:47         ` Geert Uytterhoeven
2023-12-16  3:32   ` [PATCH 43/50] lockdep: move held_lock to lockdep_types.h Kent Overstreet
2023-12-18 17:05     ` Waiman Long
2023-12-16  3:35 ` [PATCH 44/50] restart_block: Trim includes Kent Overstreet
2023-12-16  3:35   ` [PATCH 45/50] rseq: Split out rseq.h from sched.h Kent Overstreet
2023-12-16  3:35   ` [PATCH 46/50] preempt.h: Kill dependency on list.h Kent Overstreet
2023-12-16  6:13     ` Matthew Wilcox
2023-12-16 19:21       ` Randy Dunlap
2023-12-16 22:35       ` Kent Overstreet
2023-12-17  0:04         ` Randy Dunlap
2023-12-17  0:18           ` Matthew Wilcox
2023-12-17  0:20             ` Kent Overstreet
2023-12-17  2:03               ` Randy Dunlap
2023-12-17  2:05                 ` Kent Overstreet
2023-12-17  0:18           ` Kent Overstreet
2023-12-17  0:26             ` Randy Dunlap
2023-12-16  3:35   ` [PATCH 47/50] thread_info, uaccess.h: Move HARDENED_USERCOPY to better location Kent Overstreet
2023-12-16  3:35   ` [PATCH 48/50] Kill unnecessary kernel.h include Kent Overstreet
2023-12-16  3:35   ` [PATCH 49/50] kill unnecessary thread_info.h include Kent Overstreet
2023-12-16  3:35   ` [PATCH 50/50] Kill sched.h dependency on rcupdate.h Kent Overstreet
2023-12-16 19:35     ` Paul E. McKenney
2023-12-16 22:20       ` Kent Overstreet
2023-12-20 11:59     ` Geert Uytterhoeven
2023-12-20 21:39       ` Kent Overstreet
2024-01-02 11:39         ` Geert Uytterhoeven

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=20231216032651.3553101-9-kent.overstreet@linux.dev \
    --to=kent.overstreet@linux.dev \
    --cc=boqun.feng@gmail.com \
    --cc=brauner@kernel.org \
    --cc=dave.hansen@linux.intel.com \
    --cc=keescook@chromium.org \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=longman@redhat.com \
    --cc=mathieu.desnoyers@efficios.com \
    --cc=mingo@redhat.com \
    --cc=paulmck@kernel.org \
    --cc=peterz@infradead.org \
    --cc=tglx@linutronix.de \
    --cc=tj@kernel.org \
    --cc=will@kernel.org \
    --cc=x86@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.