1 #ifndef __LINUX_SPINLOCK_H
2 #define __LINUX_SPINLOCK_H
5 * include/linux/spinlock.h - generic spinlock/rwlock declarations
7 * here's the role of the various spinlock/rwlock related include files:
11 * asm/spinlock_types.h: contains the raw_spinlock_t/raw_rwlock_t and the
14 * linux/spinlock_types.h:
15 * defines the generic type and initializers
17 * asm/spinlock.h: contains the __raw_spin_*()/etc. lowlevel
18 * implementations, mostly inline assembly code
20 * (also included on UP-debug builds:)
22 * linux/spinlock_api_smp.h:
23 * contains the prototypes for the _spin_*() APIs.
25 * linux/spinlock.h: builds the final spin_*() APIs.
29 * linux/spinlock_type_up.h:
30 * contains the generic, simplified UP spinlock type.
31 * (which is an empty structure on non-debug builds)
33 * linux/spinlock_types.h:
34 * defines the generic type and initializers
36 * linux/spinlock_up.h:
37 * contains the __raw_spin_*()/etc. version of UP
38 * builds. (which are NOPs on non-debug, non-preempt
41 * (included on UP-non-debug builds:)
43 * linux/spinlock_api_up.h:
44 * builds the _spin_*() APIs.
46 * linux/spinlock.h: builds the final spin_*() APIs.
49 #include <linux/typecheck.h>
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>
56 #include <linux/bottom_half.h>
58 #include <asm/system.h>
61 * Must define these before including other files, inline functions need them
63 #define LOCK_SECTION_NAME ".text.lock."KBUILD_BASENAME
65 #define LOCK_SECTION_START(extra) \
68 ".ifndef " LOCK_SECTION_NAME "\n\t" \
69 LOCK_SECTION_NAME ":\n\t" \
72 #define LOCK_SECTION_END \
75 #define __lockfunc __attribute__((section(".spinlock.text")))
78 * Pull the raw_spinlock_t and raw_rwlock_t definitions:
80 #include <linux/spinlock_types.h>
83 extern int __lockfunc generic__raw_read_trylock(raw_rwlock_t *lock);
86 * Pull the __raw*() functions/declarations (UP-nondebug doesnt need them):
89 # include <asm/spinlock.h>
91 # include <linux/spinlock_up.h>
94 #ifdef CONFIG_DEBUG_SPINLOCK
95 extern void __spin_lock_init(spinlock_t *lock, const char *name,
96 struct lock_class_key *key);
97 # define spin_lock_init(lock) \
99 static struct lock_class_key __key; \
101 __spin_lock_init((lock), #lock, &__key); \
105 # define spin_lock_init(lock) \
106 do { *(lock) = SPIN_LOCK_UNLOCKED; } while (0)
109 #ifdef CONFIG_DEBUG_SPINLOCK
110 extern void __rwlock_init(rwlock_t *lock, const char *name,
111 struct lock_class_key *key);
112 # define rwlock_init(lock) \
114 static struct lock_class_key __key; \
116 __rwlock_init((lock), #lock, &__key); \
119 # define rwlock_init(lock) \
120 do { *(lock) = RW_LOCK_UNLOCKED; } while (0)
123 #define spin_is_locked(lock) __raw_spin_is_locked(&(lock)->raw_lock)
125 #ifdef CONFIG_GENERIC_LOCKBREAK
126 #define spin_is_contended(lock) ((lock)->break_lock)
129 #ifdef __raw_spin_is_contended
130 #define spin_is_contended(lock) __raw_spin_is_contended(&(lock)->raw_lock)
132 #define spin_is_contended(lock) (((void)(lock), 0))
133 #endif /*__raw_spin_is_contended*/
137 * spin_unlock_wait - wait until the spinlock gets unlocked
138 * @lock: the spinlock in question.
140 #define spin_unlock_wait(lock) __raw_spin_unlock_wait(&(lock)->raw_lock)
143 * Pull the _spin_*()/_read_*()/_write_*() functions/declarations:
145 #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK)
146 # include <linux/spinlock_api_smp.h>
148 # include <linux/spinlock_api_up.h>
151 #ifdef CONFIG_DEBUG_SPINLOCK
152 extern void _raw_spin_lock(spinlock_t *lock);
153 #define _raw_spin_lock_flags(lock, flags) _raw_spin_lock(lock)
154 extern int _raw_spin_trylock(spinlock_t *lock);
155 extern void _raw_spin_unlock(spinlock_t *lock);
156 extern void _raw_read_lock(rwlock_t *lock);
157 extern int _raw_read_trylock(rwlock_t *lock);
158 extern void _raw_read_unlock(rwlock_t *lock);
159 extern void _raw_write_lock(rwlock_t *lock);
160 extern int _raw_write_trylock(rwlock_t *lock);
161 extern void _raw_write_unlock(rwlock_t *lock);
163 # define _raw_spin_lock(lock) __raw_spin_lock(&(lock)->raw_lock)
164 # define _raw_spin_lock_flags(lock, flags) \
165 __raw_spin_lock_flags(&(lock)->raw_lock, *(flags))
166 # define _raw_spin_trylock(lock) __raw_spin_trylock(&(lock)->raw_lock)
167 # define _raw_spin_unlock(lock) __raw_spin_unlock(&(lock)->raw_lock)
168 # define _raw_read_lock(rwlock) __raw_read_lock(&(rwlock)->raw_lock)
169 # define _raw_read_trylock(rwlock) __raw_read_trylock(&(rwlock)->raw_lock)
170 # define _raw_read_unlock(rwlock) __raw_read_unlock(&(rwlock)->raw_lock)
171 # define _raw_write_lock(rwlock) __raw_write_lock(&(rwlock)->raw_lock)
172 # define _raw_write_trylock(rwlock) __raw_write_trylock(&(rwlock)->raw_lock)
173 # define _raw_write_unlock(rwlock) __raw_write_unlock(&(rwlock)->raw_lock)
176 #define read_can_lock(rwlock) __raw_read_can_lock(&(rwlock)->raw_lock)
177 #define write_can_lock(rwlock) __raw_write_can_lock(&(rwlock)->raw_lock)
180 * Define the various spin_lock and rw_lock methods. Note we define these
181 * regardless of whether CONFIG_SMP or CONFIG_PREEMPT are set. The various
182 * methods are defined as nops in the case they are not required.
184 #define spin_trylock(lock) __cond_lock(lock, _spin_trylock(lock))
185 #define read_trylock(lock) __cond_lock(lock, _read_trylock(lock))
186 #define write_trylock(lock) __cond_lock(lock, _write_trylock(lock))
188 #define spin_lock(lock) _spin_lock(lock)
190 #ifdef CONFIG_DEBUG_LOCK_ALLOC
191 # define spin_lock_nested(lock, subclass) _spin_lock_nested(lock, subclass)
192 # define spin_lock_nest_lock(lock, nest_lock) \
194 typecheck(struct lockdep_map *, &(nest_lock)->dep_map);\
195 _spin_lock_nest_lock(lock, &(nest_lock)->dep_map); \
198 # define spin_lock_nested(lock, subclass) _spin_lock(lock)
199 # define spin_lock_nest_lock(lock, nest_lock) _spin_lock(lock)
202 #define write_lock(lock) _write_lock(lock)
203 #define read_lock(lock) _read_lock(lock)
205 #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK)
207 #define spin_lock_irqsave(lock, flags) \
209 typecheck(unsigned long, flags); \
210 flags = _spin_lock_irqsave(lock); \
212 #define read_lock_irqsave(lock, flags) \
214 typecheck(unsigned long, flags); \
215 flags = _read_lock_irqsave(lock); \
217 #define write_lock_irqsave(lock, flags) \
219 typecheck(unsigned long, flags); \
220 flags = _write_lock_irqsave(lock); \
223 #ifdef CONFIG_DEBUG_LOCK_ALLOC
224 #define spin_lock_irqsave_nested(lock, flags, subclass) \
226 typecheck(unsigned long, flags); \
227 flags = _spin_lock_irqsave_nested(lock, subclass); \
230 #define spin_lock_irqsave_nested(lock, flags, subclass) \
232 typecheck(unsigned long, flags); \
233 flags = _spin_lock_irqsave(lock); \
239 #define spin_lock_irqsave(lock, flags) \
241 typecheck(unsigned long, flags); \
242 _spin_lock_irqsave(lock, flags); \
244 #define read_lock_irqsave(lock, flags) \
246 typecheck(unsigned long, flags); \
247 _read_lock_irqsave(lock, flags); \
249 #define write_lock_irqsave(lock, flags) \
251 typecheck(unsigned long, flags); \
252 _write_lock_irqsave(lock, flags); \
254 #define spin_lock_irqsave_nested(lock, flags, subclass) \
255 spin_lock_irqsave(lock, flags)
259 #define spin_lock_irq(lock) _spin_lock_irq(lock)
260 #define spin_lock_bh(lock) _spin_lock_bh(lock)
262 #define read_lock_irq(lock) _read_lock_irq(lock)
263 #define read_lock_bh(lock) _read_lock_bh(lock)
265 #define write_lock_irq(lock) _write_lock_irq(lock)
266 #define write_lock_bh(lock) _write_lock_bh(lock)
269 * We inline the unlock functions in the nondebug case:
271 #if defined(CONFIG_DEBUG_SPINLOCK) || defined(CONFIG_PREEMPT) || \
273 # define spin_unlock(lock) _spin_unlock(lock)
274 # define read_unlock(lock) _read_unlock(lock)
275 # define write_unlock(lock) _write_unlock(lock)
276 # define spin_unlock_irq(lock) _spin_unlock_irq(lock)
277 # define read_unlock_irq(lock) _read_unlock_irq(lock)
278 # define write_unlock_irq(lock) _write_unlock_irq(lock)
280 # define spin_unlock(lock) \
281 do {__raw_spin_unlock(&(lock)->raw_lock); __release(lock); } while (0)
282 # define read_unlock(lock) \
283 do {__raw_read_unlock(&(lock)->raw_lock); __release(lock); } while (0)
284 # define write_unlock(lock) \
285 do {__raw_write_unlock(&(lock)->raw_lock); __release(lock); } while (0)
286 # define spin_unlock_irq(lock) \
288 __raw_spin_unlock(&(lock)->raw_lock); \
290 local_irq_enable(); \
292 # define read_unlock_irq(lock) \
294 __raw_read_unlock(&(lock)->raw_lock); \
296 local_irq_enable(); \
298 # define write_unlock_irq(lock) \
300 __raw_write_unlock(&(lock)->raw_lock); \
302 local_irq_enable(); \
306 #define spin_unlock_irqrestore(lock, flags) \
308 typecheck(unsigned long, flags); \
309 _spin_unlock_irqrestore(lock, flags); \
311 #define spin_unlock_bh(lock) _spin_unlock_bh(lock)
313 #define read_unlock_irqrestore(lock, flags) \
315 typecheck(unsigned long, flags); \
316 _read_unlock_irqrestore(lock, flags); \
318 #define read_unlock_bh(lock) _read_unlock_bh(lock)
320 #define write_unlock_irqrestore(lock, flags) \
322 typecheck(unsigned long, flags); \
323 _write_unlock_irqrestore(lock, flags); \
325 #define write_unlock_bh(lock) _write_unlock_bh(lock)
327 #define spin_trylock_bh(lock) __cond_lock(lock, _spin_trylock_bh(lock))
329 #define spin_trylock_irq(lock) \
331 local_irq_disable(); \
332 spin_trylock(lock) ? \
333 1 : ({ local_irq_enable(); 0; }); \
336 #define spin_trylock_irqsave(lock, flags) \
338 local_irq_save(flags); \
339 spin_trylock(lock) ? \
340 1 : ({ local_irq_restore(flags); 0; }); \
343 #define write_trylock_irqsave(lock, flags) \
345 local_irq_save(flags); \
346 write_trylock(lock) ? \
347 1 : ({ local_irq_restore(flags); 0; }); \
351 * Pull the atomic_t declaration:
352 * (asm-mips/atomic.h needs above definitions)
354 #include <asm/atomic.h>
356 * atomic_dec_and_lock - lock on reaching reference count zero
357 * @atomic: the atomic counter
358 * @lock: the spinlock in question
360 * Decrements @atomic by 1. If the result is 0, returns true and locks
361 * @lock. Returns false for all other cases.
363 extern int _atomic_dec_and_lock(atomic_t *atomic, spinlock_t *lock);
364 #define atomic_dec_and_lock(atomic, lock) \
365 __cond_lock(lock, _atomic_dec_and_lock(atomic, lock))
368 * spin_can_lock - would spin_trylock() succeed?
369 * @lock: the spinlock in question.
371 #define spin_can_lock(lock) (!spin_is_locked(lock))
373 #else /* DDE_LINUX */
375 #define spin_lock_init(l) \
377 ddekit_lock_init(&(l)->ddekit_lock); \
378 (l)->need_init = 0; \
381 #define rwlock_init(l) spin_lock_init(l)
383 #define COND_INIT_LOCK(l) \
385 if ((l)->need_init) spin_lock_init(l); \
388 #define spin_lock(lock) \
390 COND_INIT_LOCK(lock); \
392 ddekit_lock_lock(&(lock)->ddekit_lock); \
395 #define read_lock(lock) spin_lock(lock)
396 #define write_lock(lock) spin_lock(lock)
397 #define spin_lock_irq(lock) local_irq_disable(); spin_lock(lock)
398 #define spin_lock_bh(lock) spin_lock(lock)
399 #define read_lock_irq(lock) spin_lock_irq(lock)
400 #define read_lock_bh(lock) spin_lock_bh(lock)
401 #define write_lock_irq(lock) spin_lock_irq(lock)
402 #define write_lock_bh(lock) spin_lock_bh(lock)
404 #define spin_unlock(lock) \
406 COND_INIT_LOCK(lock); \
407 ddekit_lock_unlock(&(lock)->ddekit_lock); \
411 #define read_unlock(lock) spin_unlock(lock)
412 #define write_unlock(lock) spin_unlock(lock)
414 #define spin_unlock_irq(lock) spin_unlock(lock); local_irq_enable()
415 #define spin_unlock_bh(lock) spin_unlock(lock)
416 #define read_unlock_irq(lock) spin_unlock_irq(lock)
417 #define read_unlock_bh(lock) spin_unlock_bh(lock)
418 #define write_unlock_irq(lock) spin_unlock_irq(lock)
419 #define write_unlock_bh(lock) spin_unlock_bh(lock)
421 #define spin_lock_irqsave(lock, flags) \
423 local_irq_save(flags); \
427 #define read_lock_irqsave(lock, flags) spin_lock_irqsave(lock, flags)
428 #define write_lock_irqsave(lock, flags) spin_lock_irqsave(lock, flags)
430 #define spin_unlock_irqrestore(lock, flags) \
433 local_irq_restore(flags); \
436 #define read_unlock_irqrestore(lock, flags) spin_unlock_irqrestore(lock, flags)
437 #define write_unlock_irqrestore(lock, flags) spin_unlock_irqrestore(lock, flags)
439 static int __lockfunc spin_trylock(spinlock_t *lock)
441 COND_INIT_LOCK(lock);
442 return ddekit_lock_try_lock(&lock->ddekit_lock) == 0;
445 #define _raw_spin_lock(l) spin_lock(l)
446 #define _raw_spin_unlock(l) spin_unlock(l)
447 #define _raw_spin_trylock(l) spin_trylock(l)
449 #define spin_trylock_irqsave(lock, flags) \
451 local_irq_save(flags); \
452 spin_trylock(lock) ? \
453 1 : ({ local_irq_restore(flags); 0; }); \
456 #define read_trylock(l) spin_trylock(l)
457 #define write_trylock(l) read_trylock(l)
459 #define spin_is_locked(x) \
460 (ddekit_lock_owner(&(x)->ddekit_lock) != 0)
462 #define assert_spin_locked(x) BUG_ON(!spin_is_locked(x))
465 #endif /* DDE_LINUX */
467 #endif /* __LINUX_SPINLOCK_H */