spinlock.h 8.94 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
2
3
4
#ifndef __LINUX_SPINLOCK_H
#define __LINUX_SPINLOCK_H

/*
Ingo Molnar's avatar
Ingo Molnar committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 * include/linux/spinlock.h - generic spinlock/rwlock declarations
 *
 * here's the role of the various spinlock/rwlock related include files:
 *
 * on SMP builds:
 *
 *  asm/spinlock_types.h: contains the raw_spinlock_t/raw_rwlock_t and the
 *                        initializers
 *
 *  linux/spinlock_types.h:
 *                        defines the generic type and initializers
 *
 *  asm/spinlock.h:       contains the __raw_spin_*()/etc. lowlevel
 *                        implementations, mostly inline assembly code
 *
 *   (also included on UP-debug builds:)
 *
 *  linux/spinlock_api_smp.h:
 *                        contains the prototypes for the _spin_*() APIs.
 *
 *  linux/spinlock.h:     builds the final spin_*() APIs.
 *
 * on UP builds:
 *
 *  linux/spinlock_type_up.h:
 *                        contains the generic, simplified UP spinlock type.
 *                        (which is an empty structure on non-debug builds)
 *
 *  linux/spinlock_types.h:
 *                        defines the generic type and initializers
 *
 *  linux/spinlock_up.h:
 *                        contains the __raw_spin_*()/etc. version of UP
 *                        builds. (which are NOPs on non-debug, non-preempt
 *                        builds)
 *
 *   (included on UP-non-debug builds:)
 *
 *  linux/spinlock_api_up.h:
 *                        builds the _spin_*() APIs.
 *
 *  linux/spinlock.h:     builds the final spin_*() APIs.
Linus Torvalds's avatar
Linus Torvalds committed
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 */

#include <linux/preempt.h>
#include <linux/linkage.h>
#include <linux/compiler.h>
#include <linux/thread_info.h>
#include <linux/kernel.h>
#include <linux/stringify.h>

#include <asm/system.h>

/*
 * Must define these before including other files, inline functions need them
 */
61
#define LOCK_SECTION_NAME ".text.lock."KBUILD_BASENAME
Linus Torvalds's avatar
Linus Torvalds committed
62
63
64
65
66
67
68
69
70
71
72
73
74
75

#define LOCK_SECTION_START(extra)               \
        ".subsection 1\n\t"                     \
        extra                                   \
        ".ifndef " LOCK_SECTION_NAME "\n\t"     \
        LOCK_SECTION_NAME ":\n\t"               \
        ".endif\n"

#define LOCK_SECTION_END                        \
        ".previous\n\t"

#define __lockfunc fastcall __attribute__((section(".spinlock.text")))

/*
Ingo Molnar's avatar
Ingo Molnar committed
76
 * Pull the raw_spinlock_t and raw_rwlock_t definitions:
Linus Torvalds's avatar
Linus Torvalds committed
77
 */
Ingo Molnar's avatar
Ingo Molnar committed
78
#include <linux/spinlock_types.h>
Linus Torvalds's avatar
Linus Torvalds committed
79

Ingo Molnar's avatar
Ingo Molnar committed
80
extern int __lockfunc generic__raw_read_trylock(raw_rwlock_t *lock);
Linus Torvalds's avatar
Linus Torvalds committed
81
82

/*
Ingo Molnar's avatar
Ingo Molnar committed
83
 * Pull the __raw*() functions/declarations (UP-nondebug doesnt need them):
Linus Torvalds's avatar
Linus Torvalds committed
84
 */
85
#ifdef CONFIG_SMP
Ingo Molnar's avatar
Ingo Molnar committed
86
# include <asm/spinlock.h>
Linus Torvalds's avatar
Linus Torvalds committed
87
#else
Ingo Molnar's avatar
Ingo Molnar committed
88
# include <linux/spinlock_up.h>
Linus Torvalds's avatar
Linus Torvalds committed
89
90
#endif

91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
#ifdef CONFIG_DEBUG_SPINLOCK
  extern void __spin_lock_init(spinlock_t *lock, const char *name,
			       struct lock_class_key *key);
# define spin_lock_init(lock)					\
do {								\
	static struct lock_class_key __key;			\
								\
	__spin_lock_init((lock), #lock, &__key);		\
} while (0)

#else
# define spin_lock_init(lock)					\
	do { *(lock) = SPIN_LOCK_UNLOCKED; } while (0)
#endif

#ifdef CONFIG_DEBUG_SPINLOCK
  extern void __rwlock_init(rwlock_t *lock, const char *name,
			    struct lock_class_key *key);
# define rwlock_init(lock)					\
do {								\
	static struct lock_class_key __key;			\
								\
	__rwlock_init((lock), #lock, &__key);			\
} while (0)
#else
# define rwlock_init(lock)					\
	do { *(lock) = RW_LOCK_UNLOCKED; } while (0)
#endif
Ingo Molnar's avatar
Ingo Molnar committed
119
120
121
122
123
124
125
126
127

#define spin_is_locked(lock)	__raw_spin_is_locked(&(lock)->raw_lock)

/**
 * spin_unlock_wait - wait until the spinlock gets unlocked
 * @lock: the spinlock in question.
 */
#define spin_unlock_wait(lock)	__raw_spin_unlock_wait(&(lock)->raw_lock)

Linus Torvalds's avatar
Linus Torvalds committed
128
/*
Ingo Molnar's avatar
Ingo Molnar committed
129
 * Pull the _spin_*()/_read_*()/_write_*() functions/declarations:
Linus Torvalds's avatar
Linus Torvalds committed
130
 */
Ingo Molnar's avatar
Ingo Molnar committed
131
132
#if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK)
# include <linux/spinlock_api_smp.h>
Linus Torvalds's avatar
Linus Torvalds committed
133
#else
Ingo Molnar's avatar
Ingo Molnar committed
134
# include <linux/spinlock_api_up.h>
Linus Torvalds's avatar
Linus Torvalds committed
135
136
#endif

Ingo Molnar's avatar
Ingo Molnar committed
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
#ifdef CONFIG_DEBUG_SPINLOCK
 extern void _raw_spin_lock(spinlock_t *lock);
#define _raw_spin_lock_flags(lock, flags) _raw_spin_lock(lock)
 extern int _raw_spin_trylock(spinlock_t *lock);
 extern void _raw_spin_unlock(spinlock_t *lock);
 extern void _raw_read_lock(rwlock_t *lock);
 extern int _raw_read_trylock(rwlock_t *lock);
 extern void _raw_read_unlock(rwlock_t *lock);
 extern void _raw_write_lock(rwlock_t *lock);
 extern int _raw_write_trylock(rwlock_t *lock);
 extern void _raw_write_unlock(rwlock_t *lock);
#else
# define _raw_spin_lock(lock)		__raw_spin_lock(&(lock)->raw_lock)
# define _raw_spin_lock_flags(lock, flags) \
		__raw_spin_lock_flags(&(lock)->raw_lock, *(flags))
152
153
# define _raw_spin_trylock(lock)	__raw_spin_trylock(&(lock)->raw_lock)
# define _raw_spin_unlock(lock)		__raw_spin_unlock(&(lock)->raw_lock)
Ingo Molnar's avatar
Ingo Molnar committed
154
155
# define _raw_read_lock(rwlock)		__raw_read_lock(&(rwlock)->raw_lock)
# define _raw_read_trylock(rwlock)	__raw_read_trylock(&(rwlock)->raw_lock)
156
157
# define _raw_read_unlock(rwlock)	__raw_read_unlock(&(rwlock)->raw_lock)
# define _raw_write_lock(rwlock)	__raw_write_lock(&(rwlock)->raw_lock)
Ingo Molnar's avatar
Ingo Molnar committed
158
# define _raw_write_trylock(rwlock)	__raw_write_trylock(&(rwlock)->raw_lock)
159
# define _raw_write_unlock(rwlock)	__raw_write_unlock(&(rwlock)->raw_lock)
Ingo Molnar's avatar
Ingo Molnar committed
160
#endif
Linus Torvalds's avatar
Linus Torvalds committed
161

Ingo Molnar's avatar
Ingo Molnar committed
162
163
#define read_can_lock(rwlock)		__raw_read_can_lock(&(rwlock)->raw_lock)
#define write_can_lock(rwlock)		__raw_write_can_lock(&(rwlock)->raw_lock)
Linus Torvalds's avatar
Linus Torvalds committed
164
165
166
167
168
169

/*
 * Define the various spin_lock and rw_lock methods.  Note we define these
 * regardless of whether CONFIG_SMP or CONFIG_PREEMPT are set. The various
 * methods are defined as nops in the case they are not required.
 */
Ingo Molnar's avatar
Ingo Molnar committed
170
171
172
#define spin_trylock(lock)		__cond_lock(_spin_trylock(lock))
#define read_trylock(lock)		__cond_lock(_read_trylock(lock))
#define write_trylock(lock)		__cond_lock(_write_trylock(lock))
Linus Torvalds's avatar
Linus Torvalds committed
173

Ingo Molnar's avatar
Ingo Molnar committed
174
#define spin_lock(lock)			_spin_lock(lock)
175
176
177
178
179
180
181

#ifdef CONFIG_DEBUG_LOCK_ALLOC
# define spin_lock_nested(lock, subclass) _spin_lock_nested(lock, subclass)
#else
# define spin_lock_nested(lock, subclass) _spin_lock(lock)
#endif

Ingo Molnar's avatar
Ingo Molnar committed
182
183
#define write_lock(lock)		_write_lock(lock)
#define read_lock(lock)			_read_lock(lock)
Linus Torvalds's avatar
Linus Torvalds committed
184

Ingo Molnar's avatar
Ingo Molnar committed
185
#if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK)
Linus Torvalds's avatar
Linus Torvalds committed
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
#define spin_lock_irqsave(lock, flags)	flags = _spin_lock_irqsave(lock)
#define read_lock_irqsave(lock, flags)	flags = _read_lock_irqsave(lock)
#define write_lock_irqsave(lock, flags)	flags = _write_lock_irqsave(lock)
#else
#define spin_lock_irqsave(lock, flags)	_spin_lock_irqsave(lock, flags)
#define read_lock_irqsave(lock, flags)	_read_lock_irqsave(lock, flags)
#define write_lock_irqsave(lock, flags)	_write_lock_irqsave(lock, flags)
#endif

#define spin_lock_irq(lock)		_spin_lock_irq(lock)
#define spin_lock_bh(lock)		_spin_lock_bh(lock)

#define read_lock_irq(lock)		_read_lock_irq(lock)
#define read_lock_bh(lock)		_read_lock_bh(lock)

#define write_lock_irq(lock)		_write_lock_irq(lock)
#define write_lock_bh(lock)		_write_lock_bh(lock)

204
205
206
/*
 * We inline the unlock functions in the nondebug case:
 */
207
208
#if defined(CONFIG_DEBUG_SPINLOCK) || defined(CONFIG_PREEMPT) || \
	!defined(CONFIG_SMP)
209
210
211
212
213
214
215
# define spin_unlock(lock)		_spin_unlock(lock)
# define read_unlock(lock)		_read_unlock(lock)
# define write_unlock(lock)		_write_unlock(lock)
# define spin_unlock_irq(lock)		_spin_unlock_irq(lock)
# define read_unlock_irq(lock)		_read_unlock_irq(lock)
# define write_unlock_irq(lock)		_write_unlock_irq(lock)
#else
216
217
218
# define spin_unlock(lock)		__raw_spin_unlock(&(lock)->raw_lock)
# define read_unlock(lock)		__raw_read_unlock(&(lock)->raw_lock)
# define write_unlock(lock)		__raw_write_unlock(&(lock)->raw_lock)
219
220
221
222
223
224
225
# define spin_unlock_irq(lock) \
    do { __raw_spin_unlock(&(lock)->raw_lock); local_irq_enable(); } while (0)
# define read_unlock_irq(lock) \
    do { __raw_read_unlock(&(lock)->raw_lock); local_irq_enable(); } while (0)
# define write_unlock_irq(lock) \
    do { __raw_write_unlock(&(lock)->raw_lock); local_irq_enable(); } while (0)
#endif
Linus Torvalds's avatar
Linus Torvalds committed
226

Ingo Molnar's avatar
Ingo Molnar committed
227
228
#define spin_unlock_irqrestore(lock, flags) \
					_spin_unlock_irqrestore(lock, flags)
Linus Torvalds's avatar
Linus Torvalds committed
229
230
#define spin_unlock_bh(lock)		_spin_unlock_bh(lock)

Ingo Molnar's avatar
Ingo Molnar committed
231
232
233
#define read_unlock_irqrestore(lock, flags) \
					_read_unlock_irqrestore(lock, flags)
#define read_unlock_bh(lock)		_read_unlock_bh(lock)
Linus Torvalds's avatar
Linus Torvalds committed
234

Ingo Molnar's avatar
Ingo Molnar committed
235
236
237
#define write_unlock_irqrestore(lock, flags) \
					_write_unlock_irqrestore(lock, flags)
#define write_unlock_bh(lock)		_write_unlock_bh(lock)
Linus Torvalds's avatar
Linus Torvalds committed
238

Ingo Molnar's avatar
Ingo Molnar committed
239
#define spin_trylock_bh(lock)		__cond_lock(_spin_trylock_bh(lock))
Linus Torvalds's avatar
Linus Torvalds committed
240
241
242
243
244

#define spin_trylock_irq(lock) \
({ \
	local_irq_disable(); \
	_spin_trylock(lock) ? \
Ingo Molnar's avatar
Ingo Molnar committed
245
	1 : ({ local_irq_enable(); 0;  }); \
Linus Torvalds's avatar
Linus Torvalds committed
246
247
248
249
250
251
})

#define spin_trylock_irqsave(lock, flags) \
({ \
	local_irq_save(flags); \
	_spin_trylock(lock) ? \
Ingo Molnar's avatar
Ingo Molnar committed
252
	1 : ({ local_irq_restore(flags); 0; }); \
Linus Torvalds's avatar
Linus Torvalds committed
253
254
255
})

/*
Ingo Molnar's avatar
Ingo Molnar committed
256
257
 * Pull the atomic_t declaration:
 * (asm-mips/atomic.h needs above definitions)
Linus Torvalds's avatar
Linus Torvalds committed
258
 */
Ingo Molnar's avatar
Ingo Molnar committed
259
260
261
262
263
#include <asm/atomic.h>
/**
 * atomic_dec_and_lock - lock on reaching reference count zero
 * @atomic: the atomic counter
 * @lock: the spinlock in question
Linus Torvalds's avatar
Linus Torvalds committed
264
 */
Ingo Molnar's avatar
Ingo Molnar committed
265
266
267
extern int _atomic_dec_and_lock(atomic_t *atomic, spinlock_t *lock);
#define atomic_dec_and_lock(atomic, lock) \
		__cond_lock(_atomic_dec_and_lock(atomic, lock))
Linus Torvalds's avatar
Linus Torvalds committed
268
269
270
271
272

/**
 * spin_can_lock - would spin_trylock() succeed?
 * @lock: the spinlock in question.
 */
Ingo Molnar's avatar
Ingo Molnar committed
273
#define spin_can_lock(lock)	(!spin_is_locked(lock))
Linus Torvalds's avatar
Linus Torvalds committed
274
275

#endif /* __LINUX_SPINLOCK_H */