1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __LINUX_SPINLOCK_H
3 #define __LINUX_SPINLOCK_H
4 #define __LINUX_INSIDE_SPINLOCK_H
7 * include/linux/spinlock.h - generic spinlock/rwlock declarations
9 * here's the role of the various spinlock/rwlock related include files:
13 * asm/spinlock_types.h: contains the arch_spinlock_t/arch_rwlock_t and the
16 * linux/spinlock_types_raw:
17 * The raw types and initializers
18 * linux/spinlock_types.h:
19 * defines the generic type and initializers
21 * asm/spinlock.h: contains the arch_spin_*()/etc. lowlevel
22 * implementations, mostly inline assembly code
24 * (also included on UP-debug builds:)
26 * linux/spinlock_api_smp.h:
27 * contains the prototypes for the _spin_*() APIs.
29 * linux/spinlock.h: builds the final spin_*() APIs.
33 * linux/spinlock_type_up.h:
34 * contains the generic, simplified UP spinlock type.
35 * (which is an empty structure on non-debug builds)
37 * linux/spinlock_types_raw:
38 * The raw RT types and initializers
39 * linux/spinlock_types.h:
40 * defines the generic type and initializers
42 * linux/spinlock_up.h:
43 * contains the arch_spin_*()/etc. version of UP
44 * builds. (which are NOPs on non-debug, non-preempt
47 * (included on UP-non-debug builds:)
49 * linux/spinlock_api_up.h:
50 * builds the _spin_*() APIs.
52 * linux/spinlock.h: builds the final spin_*() APIs.
55 #include <linux/typecheck.h>
56 #include <linux/preempt.h>
57 #include <linux/linkage.h>
58 #include <linux/compiler.h>
59 #include <linux/irqflags.h>
60 #include <linux/thread_info.h>
61 #include <linux/stringify.h>
62 #include <linux/bottom_half.h>
63 #include <linux/lockdep.h>
64 #include <linux/cleanup.h>
65 #include <asm/barrier.h>
66 #include <asm/mmiowb.h>
70 * Must define these before including other files, inline functions need them
72 #define LOCK_SECTION_NAME ".text..lock."KBUILD_BASENAME
74 #define LOCK_SECTION_START(extra) \
77 ".ifndef " LOCK_SECTION_NAME "\n\t" \
78 LOCK_SECTION_NAME ":\n\t" \
81 #define LOCK_SECTION_END \
84 #define __lockfunc __section(".spinlock.text")
87 * Pull the arch_spinlock_t and arch_rwlock_t definitions:
89 #include <linux/spinlock_types.h>
92 * Pull the arch_spin*() functions/declarations (UP-nondebug doesn't need them):
95 # include <asm/spinlock.h>
97 # include <linux/spinlock_up.h>
100 #ifdef CONFIG_DEBUG_SPINLOCK
101 extern void __raw_spin_lock_init(raw_spinlock_t *lock, const char *name,
102 struct lock_class_key *key, short inner);
104 # define raw_spin_lock_init(lock) \
106 static struct lock_class_key __key; \
108 __raw_spin_lock_init((lock), #lock, &__key, LD_WAIT_SPIN); \
112 # define raw_spin_lock_init(lock) \
113 do { *(lock) = __RAW_SPIN_LOCK_UNLOCKED(lock); } while (0)
116 #define raw_spin_is_locked(lock) arch_spin_is_locked(&(lock)->raw_lock)
118 #ifdef arch_spin_is_contended
119 #define raw_spin_is_contended(lock) arch_spin_is_contended(&(lock)->raw_lock)
121 #define raw_spin_is_contended(lock) (((void)(lock), 0))
122 #endif /*arch_spin_is_contended*/
125 * smp_mb__after_spinlock() provides the equivalent of a full memory barrier
126 * between program-order earlier lock acquisitions and program-order later
129 * This guarantees that the following two properties hold:
131 * 1) Given the snippet:
137 * WRITE_ONCE(X, 1); WRITE_ONCE(Y, 1);
138 * spin_lock(S); smp_mb();
139 * smp_mb__after_spinlock(); r1 = READ_ONCE(X);
143 * it is forbidden that CPU0 does not observe CPU1's store to Y (r0 = 0)
144 * and CPU1 does not observe CPU0's store to X (r1 = 0); see the comments
145 * preceding the call to smp_mb__after_spinlock() in __schedule() and in
148 * 2) Given the snippet:
154 * spin_lock(S); spin_lock(S); r1 = READ_ONCE(Y);
155 * WRITE_ONCE(X, 1); smp_mb__after_spinlock(); smp_rmb();
156 * spin_unlock(S); r0 = READ_ONCE(X); r2 = READ_ONCE(X);
160 * it is forbidden that CPU0's critical section executes before CPU1's
161 * critical section (r0 = 1), CPU2 observes CPU1's store to Y (r1 = 1)
162 * and CPU2 does not observe CPU0's store to X (r2 = 0); see the comments
163 * preceding the calls to smp_rmb() in try_to_wake_up() for similar
164 * snippets but "projected" onto two CPUs.
166 * Property (2) upgrades the lock to an RCsc lock.
168 * Since most load-store architectures implement ACQUIRE with an smp_mb() after
169 * the LL/SC loop, they need no further barriers. Similarly all our TSO
170 * architectures imply an smp_mb() for each atomic instruction and equally don't
173 * Architectures that can implement ACQUIRE better need to take care.
175 #ifndef smp_mb__after_spinlock
176 #define smp_mb__after_spinlock() kcsan_mb()
179 #ifdef CONFIG_DEBUG_SPINLOCK
180 extern void do_raw_spin_lock(raw_spinlock_t *lock) __acquires(lock);
181 extern int do_raw_spin_trylock(raw_spinlock_t *lock);
182 extern void do_raw_spin_unlock(raw_spinlock_t *lock) __releases(lock);
184 static inline void do_raw_spin_lock(raw_spinlock_t *lock) __acquires(lock)
187 arch_spin_lock(&lock->raw_lock);
191 static inline int do_raw_spin_trylock(raw_spinlock_t *lock)
193 int ret = arch_spin_trylock(&(lock)->raw_lock);
201 static inline void do_raw_spin_unlock(raw_spinlock_t *lock) __releases(lock)
203 mmiowb_spin_unlock();
204 arch_spin_unlock(&lock->raw_lock);
210 * Define the various spin_lock methods. Note we define these
211 * regardless of whether CONFIG_SMP or CONFIG_PREEMPTION are set. The
212 * various methods are defined as nops in the case they are not
215 #define raw_spin_trylock(lock) __cond_lock(lock, _raw_spin_trylock(lock))
217 #define raw_spin_lock(lock) _raw_spin_lock(lock)
219 #ifdef CONFIG_DEBUG_LOCK_ALLOC
220 # define raw_spin_lock_nested(lock, subclass) \
221 _raw_spin_lock_nested(lock, subclass)
223 # define raw_spin_lock_nest_lock(lock, nest_lock) \
225 typecheck(struct lockdep_map *, &(nest_lock)->dep_map);\
226 _raw_spin_lock_nest_lock(lock, &(nest_lock)->dep_map); \
230 * Always evaluate the 'subclass' argument to avoid that the compiler
231 * warns about set-but-not-used variables when building with
232 * CONFIG_DEBUG_LOCK_ALLOC=n and with W=1.
234 # define raw_spin_lock_nested(lock, subclass) \
235 _raw_spin_lock(((void)(subclass), (lock)))
236 # define raw_spin_lock_nest_lock(lock, nest_lock) _raw_spin_lock(lock)
239 #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK)
241 #define raw_spin_lock_irqsave(lock, flags) \
243 typecheck(unsigned long, flags); \
244 flags = _raw_spin_lock_irqsave(lock); \
247 #ifdef CONFIG_DEBUG_LOCK_ALLOC
248 #define raw_spin_lock_irqsave_nested(lock, flags, subclass) \
250 typecheck(unsigned long, flags); \
251 flags = _raw_spin_lock_irqsave_nested(lock, subclass); \
254 #define raw_spin_lock_irqsave_nested(lock, flags, subclass) \
256 typecheck(unsigned long, flags); \
257 flags = _raw_spin_lock_irqsave(lock); \
263 #define raw_spin_lock_irqsave(lock, flags) \
265 typecheck(unsigned long, flags); \
266 _raw_spin_lock_irqsave(lock, flags); \
269 #define raw_spin_lock_irqsave_nested(lock, flags, subclass) \
270 raw_spin_lock_irqsave(lock, flags)
274 #define raw_spin_lock_irq(lock) _raw_spin_lock_irq(lock)
275 #define raw_spin_lock_bh(lock) _raw_spin_lock_bh(lock)
276 #define raw_spin_unlock(lock) _raw_spin_unlock(lock)
277 #define raw_spin_unlock_irq(lock) _raw_spin_unlock_irq(lock)
279 #define raw_spin_unlock_irqrestore(lock, flags) \
281 typecheck(unsigned long, flags); \
282 _raw_spin_unlock_irqrestore(lock, flags); \
284 #define raw_spin_unlock_bh(lock) _raw_spin_unlock_bh(lock)
286 #define raw_spin_trylock_bh(lock) \
287 __cond_lock(lock, _raw_spin_trylock_bh(lock))
289 #define raw_spin_trylock_irq(lock) \
291 local_irq_disable(); \
292 raw_spin_trylock(lock) ? \
293 1 : ({ local_irq_enable(); 0; }); \
296 #define raw_spin_trylock_irqsave(lock, flags) \
298 local_irq_save(flags); \
299 raw_spin_trylock(lock) ? \
300 1 : ({ local_irq_restore(flags); 0; }); \
303 #ifndef CONFIG_PREEMPT_RT
304 /* Include rwlock functions for !RT */
305 #include <linux/rwlock.h>
309 * Pull the _spin_*()/_read_*()/_write_*() functions/declarations:
311 #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK)
312 # include <linux/spinlock_api_smp.h>
314 # include <linux/spinlock_api_up.h>
317 /* Non PREEMPT_RT kernel, map to raw spinlocks: */
318 #ifndef CONFIG_PREEMPT_RT
321 * Map the spin_lock functions to the raw variants for PREEMPT_RT=n
324 static __always_inline raw_spinlock_t *spinlock_check(spinlock_t *lock)
329 #ifdef CONFIG_DEBUG_SPINLOCK
331 # define spin_lock_init(lock) \
333 static struct lock_class_key __key; \
335 __raw_spin_lock_init(spinlock_check(lock), \
336 #lock, &__key, LD_WAIT_CONFIG); \
341 # define spin_lock_init(_lock) \
343 spinlock_check(_lock); \
344 *(_lock) = __SPIN_LOCK_UNLOCKED(_lock); \
349 static __always_inline void spin_lock(spinlock_t *lock)
351 raw_spin_lock(&lock->rlock);
354 static __always_inline void spin_lock_bh(spinlock_t *lock)
356 raw_spin_lock_bh(&lock->rlock);
359 static __always_inline int spin_trylock(spinlock_t *lock)
361 return raw_spin_trylock(&lock->rlock);
364 #define spin_lock_nested(lock, subclass) \
366 raw_spin_lock_nested(spinlock_check(lock), subclass); \
369 #define spin_lock_nest_lock(lock, nest_lock) \
371 raw_spin_lock_nest_lock(spinlock_check(lock), nest_lock); \
374 static __always_inline void spin_lock_irq(spinlock_t *lock)
376 raw_spin_lock_irq(&lock->rlock);
379 #define spin_lock_irqsave(lock, flags) \
381 raw_spin_lock_irqsave(spinlock_check(lock), flags); \
384 #define spin_lock_irqsave_nested(lock, flags, subclass) \
386 raw_spin_lock_irqsave_nested(spinlock_check(lock), flags, subclass); \
389 static __always_inline void spin_unlock(spinlock_t *lock)
391 raw_spin_unlock(&lock->rlock);
394 static __always_inline void spin_unlock_bh(spinlock_t *lock)
396 raw_spin_unlock_bh(&lock->rlock);
399 static __always_inline void spin_unlock_irq(spinlock_t *lock)
401 raw_spin_unlock_irq(&lock->rlock);
404 static __always_inline void spin_unlock_irqrestore(spinlock_t *lock, unsigned long flags)
406 raw_spin_unlock_irqrestore(&lock->rlock, flags);
409 static __always_inline int spin_trylock_bh(spinlock_t *lock)
411 return raw_spin_trylock_bh(&lock->rlock);
414 static __always_inline int spin_trylock_irq(spinlock_t *lock)
416 return raw_spin_trylock_irq(&lock->rlock);
419 #define spin_trylock_irqsave(lock, flags) \
421 raw_spin_trylock_irqsave(spinlock_check(lock), flags); \
425 * spin_is_locked() - Check whether a spinlock is locked.
426 * @lock: Pointer to the spinlock.
428 * This function is NOT required to provide any memory ordering
429 * guarantees; it could be used for debugging purposes or, when
430 * additional synchronization is needed, accompanied with other
431 * constructs (memory barriers) enforcing the synchronization.
433 * Returns: 1 if @lock is locked, 0 otherwise.
435 * Note that the function only tells you that the spinlock is
436 * seen to be locked, not that it is locked on your CPU.
438 * Further, on CONFIG_SMP=n builds with CONFIG_DEBUG_SPINLOCK=n,
439 * the return value is always 0 (see include/linux/spinlock_up.h).
440 * Therefore you should not rely heavily on the return value.
442 static __always_inline int spin_is_locked(spinlock_t *lock)
444 return raw_spin_is_locked(&lock->rlock);
447 static __always_inline int spin_is_contended(spinlock_t *lock)
449 return raw_spin_is_contended(&lock->rlock);
452 #define assert_spin_locked(lock) assert_raw_spin_locked(&(lock)->rlock)
454 #else /* !CONFIG_PREEMPT_RT */
455 # include <linux/spinlock_rt.h>
456 #endif /* CONFIG_PREEMPT_RT */
459 * Does a critical section need to be broken due to another
460 * task waiting?: (technically does not depend on CONFIG_PREEMPTION,
461 * but a general need for low latency)
463 static inline int spin_needbreak(spinlock_t *lock)
465 #ifdef CONFIG_PREEMPTION
466 return spin_is_contended(lock);
473 * Check if a rwlock is contended.
474 * Returns non-zero if there is another task waiting on the rwlock.
475 * Returns zero if the lock is not contended or the system / underlying
476 * rwlock implementation does not support contention detection.
477 * Technically does not depend on CONFIG_PREEMPTION, but a general need
480 static inline int rwlock_needbreak(rwlock_t *lock)
482 #ifdef CONFIG_PREEMPTION
483 return rwlock_is_contended(lock);
490 * Pull the atomic_t declaration:
491 * (asm-mips/atomic.h needs above definitions)
493 #include <linux/atomic.h>
495 * atomic_dec_and_lock - lock on reaching reference count zero
496 * @atomic: the atomic counter
497 * @lock: the spinlock in question
499 * Decrements @atomic by 1. If the result is 0, returns true and locks
500 * @lock. Returns false for all other cases.
502 extern int _atomic_dec_and_lock(atomic_t *atomic, spinlock_t *lock);
503 #define atomic_dec_and_lock(atomic, lock) \
504 __cond_lock(lock, _atomic_dec_and_lock(atomic, lock))
506 extern int _atomic_dec_and_lock_irqsave(atomic_t *atomic, spinlock_t *lock,
507 unsigned long *flags);
508 #define atomic_dec_and_lock_irqsave(atomic, lock, flags) \
509 __cond_lock(lock, _atomic_dec_and_lock_irqsave(atomic, lock, &(flags)))
511 extern int _atomic_dec_and_raw_lock(atomic_t *atomic, raw_spinlock_t *lock);
512 #define atomic_dec_and_raw_lock(atomic, lock) \
513 __cond_lock(lock, _atomic_dec_and_raw_lock(atomic, lock))
515 extern int _atomic_dec_and_raw_lock_irqsave(atomic_t *atomic, raw_spinlock_t *lock,
516 unsigned long *flags);
517 #define atomic_dec_and_raw_lock_irqsave(atomic, lock, flags) \
518 __cond_lock(lock, _atomic_dec_and_raw_lock_irqsave(atomic, lock, &(flags)))
520 int __alloc_bucket_spinlocks(spinlock_t **locks, unsigned int *lock_mask,
521 size_t max_size, unsigned int cpu_mult,
522 gfp_t gfp, const char *name,
523 struct lock_class_key *key);
525 #define alloc_bucket_spinlocks(locks, lock_mask, max_size, cpu_mult, gfp) \
527 static struct lock_class_key key; \
530 ret = __alloc_bucket_spinlocks(locks, lock_mask, max_size, \
531 cpu_mult, gfp, #locks, &key); \
535 void free_bucket_spinlocks(spinlock_t *locks);
537 DEFINE_LOCK_GUARD_1(raw_spinlock, raw_spinlock_t,
538 raw_spin_lock(_T->lock),
539 raw_spin_unlock(_T->lock))
541 DEFINE_LOCK_GUARD_1_COND(raw_spinlock, _try, raw_spin_trylock(_T->lock))
543 DEFINE_LOCK_GUARD_1(raw_spinlock_nested, raw_spinlock_t,
544 raw_spin_lock_nested(_T->lock, SINGLE_DEPTH_NESTING),
545 raw_spin_unlock(_T->lock))
547 DEFINE_LOCK_GUARD_1(raw_spinlock_irq, raw_spinlock_t,
548 raw_spin_lock_irq(_T->lock),
549 raw_spin_unlock_irq(_T->lock))
551 DEFINE_LOCK_GUARD_1_COND(raw_spinlock_irq, _try, raw_spin_trylock_irq(_T->lock))
553 DEFINE_LOCK_GUARD_1(raw_spinlock_irqsave, raw_spinlock_t,
554 raw_spin_lock_irqsave(_T->lock, _T->flags),
555 raw_spin_unlock_irqrestore(_T->lock, _T->flags),
558 DEFINE_LOCK_GUARD_1_COND(raw_spinlock_irqsave, _try,
559 raw_spin_trylock_irqsave(_T->lock, _T->flags))
561 DEFINE_LOCK_GUARD_1(spinlock, spinlock_t,
563 spin_unlock(_T->lock))
565 DEFINE_LOCK_GUARD_1_COND(spinlock, _try, spin_trylock(_T->lock))
567 DEFINE_LOCK_GUARD_1(spinlock_irq, spinlock_t,
568 spin_lock_irq(_T->lock),
569 spin_unlock_irq(_T->lock))
571 DEFINE_LOCK_GUARD_1_COND(spinlock_irq, _try,
572 spin_trylock_irq(_T->lock))
574 DEFINE_LOCK_GUARD_1(spinlock_irqsave, spinlock_t,
575 spin_lock_irqsave(_T->lock, _T->flags),
576 spin_unlock_irqrestore(_T->lock, _T->flags),
579 DEFINE_LOCK_GUARD_1_COND(spinlock_irqsave, _try,
580 spin_trylock_irqsave(_T->lock, _T->flags))
582 DEFINE_LOCK_GUARD_1(read_lock, rwlock_t,
584 read_unlock(_T->lock))
586 DEFINE_LOCK_GUARD_1(read_lock_irq, rwlock_t,
587 read_lock_irq(_T->lock),
588 read_unlock_irq(_T->lock))
590 DEFINE_LOCK_GUARD_1(read_lock_irqsave, rwlock_t,
591 read_lock_irqsave(_T->lock, _T->flags),
592 read_unlock_irqrestore(_T->lock, _T->flags),
595 DEFINE_LOCK_GUARD_1(write_lock, rwlock_t,
596 write_lock(_T->lock),
597 write_unlock(_T->lock))
599 DEFINE_LOCK_GUARD_1(write_lock_irq, rwlock_t,
600 write_lock_irq(_T->lock),
601 write_unlock_irq(_T->lock))
603 DEFINE_LOCK_GUARD_1(write_lock_irqsave, rwlock_t,
604 write_lock_irqsave(_T->lock, _T->flags),
605 write_unlock_irqrestore(_T->lock, _T->flags),
608 #undef __LINUX_INSIDE_SPINLOCK_H
609 #endif /* __LINUX_SPINLOCK_H */