xref: /linux-6.15/include/linux/spinlock_types.h (revision 445c8951)
1 #ifndef __LINUX_SPINLOCK_TYPES_H
2 #define __LINUX_SPINLOCK_TYPES_H
3 
4 /*
5  * include/linux/spinlock_types.h - generic spinlock type definitions
6  *                                  and initializers
7  *
8  * portions Copyright 2005, Red Hat, Inc., Ingo Molnar
9  * Released under the General Public License (GPL).
10  */
11 
12 #if defined(CONFIG_SMP)
13 # include <asm/spinlock_types.h>
14 #else
15 # include <linux/spinlock_types_up.h>
16 #endif
17 
18 #include <linux/lockdep.h>
19 
20 typedef struct {
21 	arch_spinlock_t raw_lock;
22 #ifdef CONFIG_GENERIC_LOCKBREAK
23 	unsigned int break_lock;
24 #endif
25 #ifdef CONFIG_DEBUG_SPINLOCK
26 	unsigned int magic, owner_cpu;
27 	void *owner;
28 #endif
29 #ifdef CONFIG_DEBUG_LOCK_ALLOC
30 	struct lockdep_map dep_map;
31 #endif
32 } spinlock_t;
33 
34 #define SPINLOCK_MAGIC		0xdead4ead
35 
36 #define SPINLOCK_OWNER_INIT	((void *)-1L)
37 
38 #ifdef CONFIG_DEBUG_LOCK_ALLOC
39 # define SPIN_DEP_MAP_INIT(lockname)	.dep_map = { .name = #lockname }
40 #else
41 # define SPIN_DEP_MAP_INIT(lockname)
42 #endif
43 
44 #ifdef CONFIG_DEBUG_SPINLOCK
45 # define __SPIN_LOCK_UNLOCKED(lockname)					\
46 	(spinlock_t)	{	.raw_lock = __RAW_SPIN_LOCK_UNLOCKED,	\
47 				.magic = SPINLOCK_MAGIC,		\
48 				.owner = SPINLOCK_OWNER_INIT,		\
49 				.owner_cpu = -1,			\
50 				SPIN_DEP_MAP_INIT(lockname) }
51 #else
52 # define __SPIN_LOCK_UNLOCKED(lockname) \
53 	(spinlock_t)	{	.raw_lock = __RAW_SPIN_LOCK_UNLOCKED,	\
54 				SPIN_DEP_MAP_INIT(lockname) }
55 #endif
56 
57 /*
58  * SPIN_LOCK_UNLOCKED defeats lockdep state tracking and is hence
59  * deprecated.
60  * Please use DEFINE_SPINLOCK() or __SPIN_LOCK_UNLOCKED() as
61  * appropriate.
62  */
63 #define SPIN_LOCK_UNLOCKED	__SPIN_LOCK_UNLOCKED(old_style_spin_init)
64 
65 #define DEFINE_SPINLOCK(x)	spinlock_t x = __SPIN_LOCK_UNLOCKED(x)
66 
67 #include <linux/rwlock_types.h>
68 
69 #endif /* __LINUX_SPINLOCK_TYPES_H */
70