]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #ifndef __LINUX_SPINLOCK_H |
2 | #define __LINUX_SPINLOCK_H | |
3 | ||
4 | /* | |
fb1c8f93 IM |
5 | * include/linux/spinlock.h - generic spinlock/rwlock declarations |
6 | * | |
7 | * here's the role of the various spinlock/rwlock related include files: | |
8 | * | |
9 | * on SMP builds: | |
10 | * | |
fb3a6bbc | 11 | * asm/spinlock_types.h: contains the arch_spinlock_t/arch_rwlock_t and the |
fb1c8f93 IM |
12 | * initializers |
13 | * | |
14 | * linux/spinlock_types.h: | |
15 | * defines the generic type and initializers | |
16 | * | |
0199c4e6 | 17 | * asm/spinlock.h: contains the arch_spin_*()/etc. lowlevel |
fb1c8f93 IM |
18 | * implementations, mostly inline assembly code |
19 | * | |
20 | * (also included on UP-debug builds:) | |
21 | * | |
22 | * linux/spinlock_api_smp.h: | |
23 | * contains the prototypes for the _spin_*() APIs. | |
24 | * | |
25 | * linux/spinlock.h: builds the final spin_*() APIs. | |
26 | * | |
27 | * on UP builds: | |
28 | * | |
29 | * linux/spinlock_type_up.h: | |
30 | * contains the generic, simplified UP spinlock type. | |
31 | * (which is an empty structure on non-debug builds) | |
32 | * | |
33 | * linux/spinlock_types.h: | |
34 | * defines the generic type and initializers | |
35 | * | |
36 | * linux/spinlock_up.h: | |
0199c4e6 | 37 | * contains the arch_spin_*()/etc. version of UP |
fb1c8f93 IM |
38 | * builds. (which are NOPs on non-debug, non-preempt |
39 | * builds) | |
40 | * | |
41 | * (included on UP-non-debug builds:) | |
42 | * | |
43 | * linux/spinlock_api_up.h: | |
44 | * builds the _spin_*() APIs. | |
45 | * | |
46 | * linux/spinlock.h: builds the final spin_*() APIs. | |
1da177e4 LT |
47 | */ |
48 | ||
3f307891 | 49 | #include <linux/typecheck.h> |
1da177e4 LT |
50 | #include <linux/preempt.h> |
51 | #include <linux/linkage.h> | |
52 | #include <linux/compiler.h> | |
53 | #include <linux/thread_info.h> | |
54 | #include <linux/kernel.h> | |
55 | #include <linux/stringify.h> | |
676dcb8b | 56 | #include <linux/bottom_half.h> |
1da177e4 | 57 | |
1da177e4 LT |
58 | #include <asm/system.h> |
59 | ||
60 | /* | |
61 | * Must define these before including other files, inline functions need them | |
62 | */ | |
f83b5e32 | 63 | #define LOCK_SECTION_NAME ".text.lock."KBUILD_BASENAME |
1da177e4 LT |
64 | |
65 | #define LOCK_SECTION_START(extra) \ | |
66 | ".subsection 1\n\t" \ | |
67 | extra \ | |
68 | ".ifndef " LOCK_SECTION_NAME "\n\t" \ | |
69 | LOCK_SECTION_NAME ":\n\t" \ | |
70 | ".endif\n" | |
71 | ||
72 | #define LOCK_SECTION_END \ | |
73 | ".previous\n\t" | |
74 | ||
ec701584 | 75 | #define __lockfunc __attribute__((section(".spinlock.text"))) |
1da177e4 LT |
76 | |
77 | /* | |
fb3a6bbc | 78 | * Pull the arch_spinlock_t and arch_rwlock_t definitions: |
1da177e4 | 79 | */ |
fb1c8f93 | 80 | #include <linux/spinlock_types.h> |
1da177e4 | 81 | |
1da177e4 | 82 | /* |
c2f21ce2 | 83 | * Pull the arch_spin*() functions/declarations (UP-nondebug doesnt need them): |
1da177e4 | 84 | */ |
8a25d5de | 85 | #ifdef CONFIG_SMP |
fb1c8f93 | 86 | # include <asm/spinlock.h> |
1da177e4 | 87 | #else |
fb1c8f93 | 88 | # include <linux/spinlock_up.h> |
1da177e4 LT |
89 | #endif |
90 | ||
8a25d5de | 91 | #ifdef CONFIG_DEBUG_SPINLOCK |
c2f21ce2 TG |
92 | extern void __raw_spin_lock_init(raw_spinlock_t *lock, const char *name, |
93 | struct lock_class_key *key); | |
94 | # define raw_spin_lock_init(lock) \ | |
8a25d5de IM |
95 | do { \ |
96 | static struct lock_class_key __key; \ | |
97 | \ | |
c2f21ce2 | 98 | __raw_spin_lock_init((lock), #lock, &__key); \ |
8a25d5de IM |
99 | } while (0) |
100 | ||
101 | #else | |
c2f21ce2 TG |
102 | # define raw_spin_lock_init(lock) \ |
103 | do { *(lock) = __RAW_SPIN_LOCK_UNLOCKED(lock); } while (0) | |
8a25d5de IM |
104 | #endif |
105 | ||
c2f21ce2 | 106 | #define raw_spin_is_locked(lock) arch_spin_is_locked(&(lock)->raw_lock) |
fb1c8f93 | 107 | |
95c354fe | 108 | #ifdef CONFIG_GENERIC_LOCKBREAK |
c2f21ce2 | 109 | #define raw_spin_is_contended(lock) ((lock)->break_lock) |
95c354fe | 110 | #else |
a5ef7ca0 | 111 | |
0199c4e6 | 112 | #ifdef arch_spin_is_contended |
c2f21ce2 | 113 | #define raw_spin_is_contended(lock) arch_spin_is_contended(&(lock)->raw_lock) |
a5ef7ca0 | 114 | #else |
c2f21ce2 | 115 | #define raw_spin_is_contended(lock) (((void)(lock), 0)) |
0199c4e6 | 116 | #endif /*arch_spin_is_contended*/ |
95c354fe NP |
117 | #endif |
118 | ||
ad462769 JO |
119 | /* The lock does not imply full memory barrier. */ |
120 | #ifndef ARCH_HAS_SMP_MB_AFTER_LOCK | |
121 | static inline void smp_mb__after_lock(void) { smp_mb(); } | |
122 | #endif | |
123 | ||
fb1c8f93 | 124 | /** |
c2f21ce2 | 125 | * raw_spin_unlock_wait - wait until the spinlock gets unlocked |
fb1c8f93 IM |
126 | * @lock: the spinlock in question. |
127 | */ | |
c2f21ce2 | 128 | #define raw_spin_unlock_wait(lock) arch_spin_unlock_wait(&(lock)->raw_lock) |
fb1c8f93 | 129 | |
fb1c8f93 | 130 | #ifdef CONFIG_DEBUG_SPINLOCK |
9828ea9d TG |
131 | extern void do_raw_spin_lock(raw_spinlock_t *lock); |
132 | #define do_raw_spin_lock_flags(lock, flags) do_raw_spin_lock(lock) | |
133 | extern int do_raw_spin_trylock(raw_spinlock_t *lock); | |
134 | extern void do_raw_spin_unlock(raw_spinlock_t *lock); | |
fb1c8f93 | 135 | #else |
9828ea9d | 136 | static inline void do_raw_spin_lock(raw_spinlock_t *lock) |
c2f21ce2 TG |
137 | { |
138 | arch_spin_lock(&lock->raw_lock); | |
139 | } | |
140 | ||
141 | static inline void | |
9828ea9d | 142 | do_raw_spin_lock_flags(raw_spinlock_t *lock, unsigned long *flags) |
c2f21ce2 TG |
143 | { |
144 | arch_spin_lock_flags(&lock->raw_lock, *flags); | |
145 | } | |
146 | ||
9828ea9d | 147 | static inline int do_raw_spin_trylock(raw_spinlock_t *lock) |
c2f21ce2 TG |
148 | { |
149 | return arch_spin_trylock(&(lock)->raw_lock); | |
150 | } | |
151 | ||
9828ea9d | 152 | static inline void do_raw_spin_unlock(raw_spinlock_t *lock) |
c2f21ce2 TG |
153 | { |
154 | arch_spin_unlock(&lock->raw_lock); | |
155 | } | |
fb1c8f93 | 156 | #endif |
1da177e4 | 157 | |
1da177e4 | 158 | /* |
ef12f109 TG |
159 | * Define the various spin_lock methods. Note we define these |
160 | * regardless of whether CONFIG_SMP or CONFIG_PREEMPT are set. The | |
161 | * various methods are defined as nops in the case they are not | |
162 | * required. | |
1da177e4 | 163 | */ |
c2f21ce2 | 164 | #define raw_spin_trylock(lock) __cond_lock(lock, _spin_trylock(lock)) |
1da177e4 | 165 | |
c2f21ce2 | 166 | #define raw_spin_lock(lock) _spin_lock(lock) |
8a25d5de IM |
167 | |
168 | #ifdef CONFIG_DEBUG_LOCK_ALLOC | |
c2f21ce2 TG |
169 | # define raw_spin_lock_nested(lock, subclass) _spin_lock_nested(lock, subclass) |
170 | # define raw_spin_lock_nest_lock(lock, nest_lock) \ | |
b7d39aff PZ |
171 | do { \ |
172 | typecheck(struct lockdep_map *, &(nest_lock)->dep_map);\ | |
173 | _spin_lock_nest_lock(lock, &(nest_lock)->dep_map); \ | |
174 | } while (0) | |
8a25d5de | 175 | #else |
c2f21ce2 TG |
176 | # define raw_spin_lock_nested(lock, subclass) _spin_lock(lock) |
177 | # define raw_spin_lock_nest_lock(lock, nest_lock) _spin_lock(lock) | |
8a25d5de IM |
178 | #endif |
179 | ||
fb1c8f93 | 180 | #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK) |
b8e6ec86 | 181 | |
c2f21ce2 | 182 | #define raw_spin_lock_irqsave(lock, flags) \ |
3f307891 SR |
183 | do { \ |
184 | typecheck(unsigned long, flags); \ | |
185 | flags = _spin_lock_irqsave(lock); \ | |
186 | } while (0) | |
cfd3ef23 AV |
187 | |
188 | #ifdef CONFIG_DEBUG_LOCK_ALLOC | |
c2f21ce2 | 189 | #define raw_spin_lock_irqsave_nested(lock, flags, subclass) \ |
3f307891 SR |
190 | do { \ |
191 | typecheck(unsigned long, flags); \ | |
192 | flags = _spin_lock_irqsave_nested(lock, subclass); \ | |
193 | } while (0) | |
cfd3ef23 | 194 | #else |
c2f21ce2 | 195 | #define raw_spin_lock_irqsave_nested(lock, flags, subclass) \ |
3f307891 SR |
196 | do { \ |
197 | typecheck(unsigned long, flags); \ | |
198 | flags = _spin_lock_irqsave(lock); \ | |
199 | } while (0) | |
cfd3ef23 AV |
200 | #endif |
201 | ||
1da177e4 | 202 | #else |
b8e6ec86 | 203 | |
c2f21ce2 | 204 | #define raw_spin_lock_irqsave(lock, flags) \ |
3f307891 SR |
205 | do { \ |
206 | typecheck(unsigned long, flags); \ | |
207 | _spin_lock_irqsave(lock, flags); \ | |
208 | } while (0) | |
ef12f109 | 209 | |
c2f21ce2 TG |
210 | #define raw_spin_lock_irqsave_nested(lock, flags, subclass) \ |
211 | raw_spin_lock_irqsave(lock, flags) | |
cfd3ef23 | 212 | |
1da177e4 LT |
213 | #endif |
214 | ||
c2f21ce2 TG |
215 | #define raw_spin_lock_irq(lock) _spin_lock_irq(lock) |
216 | #define raw_spin_lock_bh(lock) _spin_lock_bh(lock) | |
217 | #define raw_spin_unlock(lock) _spin_unlock(lock) | |
218 | #define raw_spin_unlock_irq(lock) _spin_unlock_irq(lock) | |
1da177e4 | 219 | |
c2f21ce2 TG |
220 | #define raw_spin_unlock_irqrestore(lock, flags) \ |
221 | do { \ | |
222 | typecheck(unsigned long, flags); \ | |
3f307891 SR |
223 | _spin_unlock_irqrestore(lock, flags); \ |
224 | } while (0) | |
c2f21ce2 | 225 | #define raw_spin_unlock_bh(lock) _spin_unlock_bh(lock) |
1da177e4 | 226 | |
c2f21ce2 | 227 | #define raw_spin_trylock_bh(lock) __cond_lock(lock, _spin_trylock_bh(lock)) |
1da177e4 | 228 | |
c2f21ce2 | 229 | #define raw_spin_trylock_irq(lock) \ |
1da177e4 LT |
230 | ({ \ |
231 | local_irq_disable(); \ | |
c2f21ce2 | 232 | raw_spin_trylock(lock) ? \ |
fb1c8f93 | 233 | 1 : ({ local_irq_enable(); 0; }); \ |
1da177e4 LT |
234 | }) |
235 | ||
c2f21ce2 | 236 | #define raw_spin_trylock_irqsave(lock, flags) \ |
1da177e4 LT |
237 | ({ \ |
238 | local_irq_save(flags); \ | |
c2f21ce2 | 239 | raw_spin_trylock(lock) ? \ |
fb1c8f93 | 240 | 1 : ({ local_irq_restore(flags); 0; }); \ |
1da177e4 LT |
241 | }) |
242 | ||
c2f21ce2 TG |
243 | /** |
244 | * raw_spin_can_lock - would raw_spin_trylock() succeed? | |
245 | * @lock: the spinlock in question. | |
246 | */ | |
247 | #define raw_spin_can_lock(lock) (!raw_spin_is_locked(lock)) | |
248 | ||
249 | /* Include rwlock functions */ | |
250 | #include <linux/rwlock.h> | |
251 | ||
252 | /* | |
253 | * Pull the _spin_*()/_read_*()/_write_*() functions/declarations: | |
254 | */ | |
255 | #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK) | |
256 | # include <linux/spinlock_api_smp.h> | |
257 | #else | |
258 | # include <linux/spinlock_api_up.h> | |
259 | #endif | |
260 | ||
261 | /* | |
262 | * Map the spin_lock functions to the raw variants for PREEMPT_RT=n | |
263 | */ | |
264 | ||
265 | static inline raw_spinlock_t *spinlock_check(spinlock_t *lock) | |
266 | { | |
267 | return &lock->rlock; | |
268 | } | |
269 | ||
270 | #define spin_lock_init(_lock) \ | |
271 | do { \ | |
272 | spinlock_check(_lock); \ | |
273 | raw_spin_lock_init(&(_lock)->rlock); \ | |
274 | } while (0) | |
275 | ||
276 | static inline void spin_lock(spinlock_t *lock) | |
277 | { | |
278 | raw_spin_lock(&lock->rlock); | |
279 | } | |
280 | ||
281 | static inline void spin_lock_bh(spinlock_t *lock) | |
282 | { | |
283 | raw_spin_lock_bh(&lock->rlock); | |
284 | } | |
285 | ||
286 | static inline int spin_trylock(spinlock_t *lock) | |
287 | { | |
288 | return raw_spin_trylock(&lock->rlock); | |
289 | } | |
290 | ||
291 | #define spin_lock_nested(lock, subclass) \ | |
292 | do { \ | |
293 | raw_spin_lock_nested(spinlock_check(lock), subclass); \ | |
294 | } while (0) | |
295 | ||
296 | #define spin_lock_nest_lock(lock, nest_lock) \ | |
297 | do { \ | |
298 | raw_spin_lock_nest_lock(spinlock_check(lock), nest_lock); \ | |
299 | } while (0) | |
300 | ||
301 | static inline void spin_lock_irq(spinlock_t *lock) | |
302 | { | |
303 | raw_spin_lock_irq(&lock->rlock); | |
304 | } | |
305 | ||
306 | #define spin_lock_irqsave(lock, flags) \ | |
307 | do { \ | |
308 | raw_spin_lock_irqsave(spinlock_check(lock), flags); \ | |
309 | } while (0) | |
310 | ||
311 | #define spin_lock_irqsave_nested(lock, flags, subclass) \ | |
312 | do { \ | |
313 | raw_spin_lock_irqsave_nested(spinlock_check(lock), flags, subclass); \ | |
314 | } while (0) | |
315 | ||
316 | static inline void spin_unlock(spinlock_t *lock) | |
317 | { | |
318 | raw_spin_unlock(&lock->rlock); | |
319 | } | |
320 | ||
321 | static inline void spin_unlock_bh(spinlock_t *lock) | |
322 | { | |
323 | raw_spin_unlock_bh(&lock->rlock); | |
324 | } | |
325 | ||
326 | static inline void spin_unlock_irq(spinlock_t *lock) | |
327 | { | |
328 | raw_spin_unlock_irq(&lock->rlock); | |
329 | } | |
330 | ||
331 | static inline void spin_unlock_irqrestore(spinlock_t *lock, unsigned long flags) | |
332 | { | |
333 | raw_spin_unlock_irqrestore(&lock->rlock, flags); | |
334 | } | |
335 | ||
336 | static inline int spin_trylock_bh(spinlock_t *lock) | |
337 | { | |
338 | return raw_spin_trylock_bh(&lock->rlock); | |
339 | } | |
340 | ||
341 | static inline int spin_trylock_irq(spinlock_t *lock) | |
342 | { | |
343 | return raw_spin_trylock_irq(&lock->rlock); | |
344 | } | |
345 | ||
346 | #define spin_trylock_irqsave(lock, flags) \ | |
347 | ({ \ | |
348 | raw_spin_trylock_irqsave(spinlock_check(lock), flags); \ | |
349 | }) | |
350 | ||
351 | static inline void spin_unlock_wait(spinlock_t *lock) | |
352 | { | |
353 | raw_spin_unlock_wait(&lock->rlock); | |
354 | } | |
355 | ||
356 | static inline int spin_is_locked(spinlock_t *lock) | |
357 | { | |
358 | return raw_spin_is_locked(&lock->rlock); | |
359 | } | |
360 | ||
361 | static inline int spin_is_contended(spinlock_t *lock) | |
362 | { | |
363 | return raw_spin_is_contended(&lock->rlock); | |
364 | } | |
365 | ||
366 | static inline int spin_can_lock(spinlock_t *lock) | |
367 | { | |
368 | return raw_spin_can_lock(&lock->rlock); | |
369 | } | |
370 | ||
371 | static inline void assert_spin_locked(spinlock_t *lock) | |
372 | { | |
373 | assert_raw_spin_locked(&lock->rlock); | |
374 | } | |
375 | ||
1da177e4 | 376 | /* |
fb1c8f93 IM |
377 | * Pull the atomic_t declaration: |
378 | * (asm-mips/atomic.h needs above definitions) | |
1da177e4 | 379 | */ |
fb1c8f93 IM |
380 | #include <asm/atomic.h> |
381 | /** | |
382 | * atomic_dec_and_lock - lock on reaching reference count zero | |
383 | * @atomic: the atomic counter | |
384 | * @lock: the spinlock in question | |
dc07e721 BF |
385 | * |
386 | * Decrements @atomic by 1. If the result is 0, returns true and locks | |
387 | * @lock. Returns false for all other cases. | |
1da177e4 | 388 | */ |
fb1c8f93 IM |
389 | extern int _atomic_dec_and_lock(atomic_t *atomic, spinlock_t *lock); |
390 | #define atomic_dec_and_lock(atomic, lock) \ | |
dcc8e559 | 391 | __cond_lock(lock, _atomic_dec_and_lock(atomic, lock)) |
1da177e4 | 392 | |
1da177e4 | 393 | #endif /* __LINUX_SPINLOCK_H */ |