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> | |
df9ee292 | 53 | #include <linux/irqflags.h> |
1da177e4 LT |
54 | #include <linux/thread_info.h> |
55 | #include <linux/kernel.h> | |
56 | #include <linux/stringify.h> | |
676dcb8b | 57 | #include <linux/bottom_half.h> |
96f951ed | 58 | #include <asm/barrier.h> |
1da177e4 | 59 | |
1da177e4 LT |
60 | |
61 | /* | |
62 | * Must define these before including other files, inline functions need them | |
63 | */ | |
75ddb0e8 | 64 | #define LOCK_SECTION_NAME ".text..lock."KBUILD_BASENAME |
1da177e4 LT |
65 | |
66 | #define LOCK_SECTION_START(extra) \ | |
67 | ".subsection 1\n\t" \ | |
68 | extra \ | |
69 | ".ifndef " LOCK_SECTION_NAME "\n\t" \ | |
70 | LOCK_SECTION_NAME ":\n\t" \ | |
71 | ".endif\n" | |
72 | ||
73 | #define LOCK_SECTION_END \ | |
74 | ".previous\n\t" | |
75 | ||
ec701584 | 76 | #define __lockfunc __attribute__((section(".spinlock.text"))) |
1da177e4 LT |
77 | |
78 | /* | |
fb3a6bbc | 79 | * Pull the arch_spinlock_t and arch_rwlock_t definitions: |
1da177e4 | 80 | */ |
fb1c8f93 | 81 | #include <linux/spinlock_types.h> |
1da177e4 | 82 | |
1da177e4 | 83 | /* |
25985edc | 84 | * Pull the arch_spin*() functions/declarations (UP-nondebug doesn't need them): |
1da177e4 | 85 | */ |
8a25d5de | 86 | #ifdef CONFIG_SMP |
fb1c8f93 | 87 | # include <asm/spinlock.h> |
1da177e4 | 88 | #else |
fb1c8f93 | 89 | # include <linux/spinlock_up.h> |
1da177e4 LT |
90 | #endif |
91 | ||
8a25d5de | 92 | #ifdef CONFIG_DEBUG_SPINLOCK |
c2f21ce2 TG |
93 | extern void __raw_spin_lock_init(raw_spinlock_t *lock, const char *name, |
94 | struct lock_class_key *key); | |
95 | # define raw_spin_lock_init(lock) \ | |
8a25d5de IM |
96 | do { \ |
97 | static struct lock_class_key __key; \ | |
98 | \ | |
c2f21ce2 | 99 | __raw_spin_lock_init((lock), #lock, &__key); \ |
8a25d5de IM |
100 | } while (0) |
101 | ||
102 | #else | |
c2f21ce2 TG |
103 | # define raw_spin_lock_init(lock) \ |
104 | do { *(lock) = __RAW_SPIN_LOCK_UNLOCKED(lock); } while (0) | |
8a25d5de IM |
105 | #endif |
106 | ||
c2f21ce2 | 107 | #define raw_spin_is_locked(lock) arch_spin_is_locked(&(lock)->raw_lock) |
fb1c8f93 | 108 | |
95c354fe | 109 | #ifdef CONFIG_GENERIC_LOCKBREAK |
c2f21ce2 | 110 | #define raw_spin_is_contended(lock) ((lock)->break_lock) |
95c354fe | 111 | #else |
a5ef7ca0 | 112 | |
0199c4e6 | 113 | #ifdef arch_spin_is_contended |
c2f21ce2 | 114 | #define raw_spin_is_contended(lock) arch_spin_is_contended(&(lock)->raw_lock) |
a5ef7ca0 | 115 | #else |
c2f21ce2 | 116 | #define raw_spin_is_contended(lock) (((void)(lock), 0)) |
0199c4e6 | 117 | #endif /*arch_spin_is_contended*/ |
95c354fe NP |
118 | #endif |
119 | ||
e0acd0a6 ON |
120 | /* |
121 | * Despite its name it doesn't necessarily has to be a full barrier. | |
122 | * It should only guarantee that a STORE before the critical section | |
123 | * can not be reordered with a LOAD inside this section. | |
124 | * spin_lock() is the one-way barrier, this LOAD can not escape out | |
125 | * of the region. So the default implementation simply ensures that | |
126 | * a STORE can not move into the critical section, smp_wmb() should | |
127 | * serialize it with another STORE done by spin_lock(). | |
128 | */ | |
129 | #ifndef smp_mb__before_spinlock | |
130 | #define smp_mb__before_spinlock() smp_wmb() | |
ad462769 JO |
131 | #endif |
132 | ||
01352fb8 PM |
133 | /* |
134 | * Place this after a lock-acquisition primitive to guarantee that | |
135 | * an UNLOCK+LOCK pair act as a full barrier. This guarantee applies | |
136 | * if the UNLOCK and LOCK are executed by the same CPU or if the | |
137 | * UNLOCK and LOCK operate on the same lock variable. | |
138 | */ | |
139 | #ifndef smp_mb__after_unlock_lock | |
140 | #define smp_mb__after_unlock_lock() do { } while (0) | |
141 | #endif | |
142 | ||
fb1c8f93 | 143 | /** |
c2f21ce2 | 144 | * raw_spin_unlock_wait - wait until the spinlock gets unlocked |
fb1c8f93 IM |
145 | * @lock: the spinlock in question. |
146 | */ | |
c2f21ce2 | 147 | #define raw_spin_unlock_wait(lock) arch_spin_unlock_wait(&(lock)->raw_lock) |
fb1c8f93 | 148 | |
fb1c8f93 | 149 | #ifdef CONFIG_DEBUG_SPINLOCK |
b97c4bc1 | 150 | extern void do_raw_spin_lock(raw_spinlock_t *lock) __acquires(lock); |
9828ea9d TG |
151 | #define do_raw_spin_lock_flags(lock, flags) do_raw_spin_lock(lock) |
152 | extern int do_raw_spin_trylock(raw_spinlock_t *lock); | |
b97c4bc1 | 153 | extern void do_raw_spin_unlock(raw_spinlock_t *lock) __releases(lock); |
fb1c8f93 | 154 | #else |
b97c4bc1 | 155 | static inline void do_raw_spin_lock(raw_spinlock_t *lock) __acquires(lock) |
c2f21ce2 | 156 | { |
b97c4bc1 | 157 | __acquire(lock); |
c2f21ce2 TG |
158 | arch_spin_lock(&lock->raw_lock); |
159 | } | |
160 | ||
161 | static inline void | |
b97c4bc1 | 162 | do_raw_spin_lock_flags(raw_spinlock_t *lock, unsigned long *flags) __acquires(lock) |
c2f21ce2 | 163 | { |
b97c4bc1 | 164 | __acquire(lock); |
c2f21ce2 TG |
165 | arch_spin_lock_flags(&lock->raw_lock, *flags); |
166 | } | |
167 | ||
9828ea9d | 168 | static inline int do_raw_spin_trylock(raw_spinlock_t *lock) |
c2f21ce2 TG |
169 | { |
170 | return arch_spin_trylock(&(lock)->raw_lock); | |
171 | } | |
172 | ||
b97c4bc1 | 173 | static inline void do_raw_spin_unlock(raw_spinlock_t *lock) __releases(lock) |
c2f21ce2 TG |
174 | { |
175 | arch_spin_unlock(&lock->raw_lock); | |
b97c4bc1 | 176 | __release(lock); |
c2f21ce2 | 177 | } |
fb1c8f93 | 178 | #endif |
1da177e4 | 179 | |
1da177e4 | 180 | /* |
ef12f109 TG |
181 | * Define the various spin_lock methods. Note we define these |
182 | * regardless of whether CONFIG_SMP or CONFIG_PREEMPT are set. The | |
183 | * various methods are defined as nops in the case they are not | |
184 | * required. | |
1da177e4 | 185 | */ |
9c1721aa | 186 | #define raw_spin_trylock(lock) __cond_lock(lock, _raw_spin_trylock(lock)) |
1da177e4 | 187 | |
9c1721aa | 188 | #define raw_spin_lock(lock) _raw_spin_lock(lock) |
8a25d5de IM |
189 | |
190 | #ifdef CONFIG_DEBUG_LOCK_ALLOC | |
9c1721aa TG |
191 | # define raw_spin_lock_nested(lock, subclass) \ |
192 | _raw_spin_lock_nested(lock, subclass) | |
193 | ||
c2f21ce2 | 194 | # define raw_spin_lock_nest_lock(lock, nest_lock) \ |
b7d39aff PZ |
195 | do { \ |
196 | typecheck(struct lockdep_map *, &(nest_lock)->dep_map);\ | |
9c1721aa | 197 | _raw_spin_lock_nest_lock(lock, &(nest_lock)->dep_map); \ |
b7d39aff | 198 | } while (0) |
8a25d5de | 199 | #else |
9c1721aa TG |
200 | # define raw_spin_lock_nested(lock, subclass) _raw_spin_lock(lock) |
201 | # define raw_spin_lock_nest_lock(lock, nest_lock) _raw_spin_lock(lock) | |
8a25d5de IM |
202 | #endif |
203 | ||
fb1c8f93 | 204 | #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK) |
b8e6ec86 | 205 | |
c2f21ce2 | 206 | #define raw_spin_lock_irqsave(lock, flags) \ |
3f307891 SR |
207 | do { \ |
208 | typecheck(unsigned long, flags); \ | |
9c1721aa | 209 | flags = _raw_spin_lock_irqsave(lock); \ |
3f307891 | 210 | } while (0) |
cfd3ef23 AV |
211 | |
212 | #ifdef CONFIG_DEBUG_LOCK_ALLOC | |
c2f21ce2 | 213 | #define raw_spin_lock_irqsave_nested(lock, flags, subclass) \ |
3f307891 SR |
214 | do { \ |
215 | typecheck(unsigned long, flags); \ | |
9c1721aa | 216 | flags = _raw_spin_lock_irqsave_nested(lock, subclass); \ |
3f307891 | 217 | } while (0) |
cfd3ef23 | 218 | #else |
c2f21ce2 | 219 | #define raw_spin_lock_irqsave_nested(lock, flags, subclass) \ |
3f307891 SR |
220 | do { \ |
221 | typecheck(unsigned long, flags); \ | |
9c1721aa | 222 | flags = _raw_spin_lock_irqsave(lock); \ |
3f307891 | 223 | } while (0) |
cfd3ef23 AV |
224 | #endif |
225 | ||
1da177e4 | 226 | #else |
b8e6ec86 | 227 | |
c2f21ce2 | 228 | #define raw_spin_lock_irqsave(lock, flags) \ |
3f307891 SR |
229 | do { \ |
230 | typecheck(unsigned long, flags); \ | |
9c1721aa | 231 | _raw_spin_lock_irqsave(lock, flags); \ |
3f307891 | 232 | } while (0) |
ef12f109 | 233 | |
c2f21ce2 TG |
234 | #define raw_spin_lock_irqsave_nested(lock, flags, subclass) \ |
235 | raw_spin_lock_irqsave(lock, flags) | |
cfd3ef23 | 236 | |
1da177e4 LT |
237 | #endif |
238 | ||
9c1721aa TG |
239 | #define raw_spin_lock_irq(lock) _raw_spin_lock_irq(lock) |
240 | #define raw_spin_lock_bh(lock) _raw_spin_lock_bh(lock) | |
241 | #define raw_spin_unlock(lock) _raw_spin_unlock(lock) | |
242 | #define raw_spin_unlock_irq(lock) _raw_spin_unlock_irq(lock) | |
1da177e4 | 243 | |
c2f21ce2 TG |
244 | #define raw_spin_unlock_irqrestore(lock, flags) \ |
245 | do { \ | |
246 | typecheck(unsigned long, flags); \ | |
9c1721aa | 247 | _raw_spin_unlock_irqrestore(lock, flags); \ |
3f307891 | 248 | } while (0) |
9c1721aa | 249 | #define raw_spin_unlock_bh(lock) _raw_spin_unlock_bh(lock) |
1da177e4 | 250 | |
9c1721aa TG |
251 | #define raw_spin_trylock_bh(lock) \ |
252 | __cond_lock(lock, _raw_spin_trylock_bh(lock)) | |
1da177e4 | 253 | |
c2f21ce2 | 254 | #define raw_spin_trylock_irq(lock) \ |
1da177e4 LT |
255 | ({ \ |
256 | local_irq_disable(); \ | |
c2f21ce2 | 257 | raw_spin_trylock(lock) ? \ |
fb1c8f93 | 258 | 1 : ({ local_irq_enable(); 0; }); \ |
1da177e4 LT |
259 | }) |
260 | ||
c2f21ce2 | 261 | #define raw_spin_trylock_irqsave(lock, flags) \ |
1da177e4 LT |
262 | ({ \ |
263 | local_irq_save(flags); \ | |
c2f21ce2 | 264 | raw_spin_trylock(lock) ? \ |
fb1c8f93 | 265 | 1 : ({ local_irq_restore(flags); 0; }); \ |
1da177e4 LT |
266 | }) |
267 | ||
c2f21ce2 TG |
268 | /** |
269 | * raw_spin_can_lock - would raw_spin_trylock() succeed? | |
270 | * @lock: the spinlock in question. | |
271 | */ | |
272 | #define raw_spin_can_lock(lock) (!raw_spin_is_locked(lock)) | |
273 | ||
274 | /* Include rwlock functions */ | |
275 | #include <linux/rwlock.h> | |
276 | ||
277 | /* | |
278 | * Pull the _spin_*()/_read_*()/_write_*() functions/declarations: | |
279 | */ | |
280 | #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK) | |
281 | # include <linux/spinlock_api_smp.h> | |
282 | #else | |
283 | # include <linux/spinlock_api_up.h> | |
284 | #endif | |
285 | ||
286 | /* | |
287 | * Map the spin_lock functions to the raw variants for PREEMPT_RT=n | |
288 | */ | |
289 | ||
290 | static inline raw_spinlock_t *spinlock_check(spinlock_t *lock) | |
291 | { | |
292 | return &lock->rlock; | |
293 | } | |
294 | ||
295 | #define spin_lock_init(_lock) \ | |
296 | do { \ | |
297 | spinlock_check(_lock); \ | |
298 | raw_spin_lock_init(&(_lock)->rlock); \ | |
299 | } while (0) | |
300 | ||
301 | static inline void spin_lock(spinlock_t *lock) | |
302 | { | |
303 | raw_spin_lock(&lock->rlock); | |
304 | } | |
305 | ||
306 | static inline void spin_lock_bh(spinlock_t *lock) | |
307 | { | |
308 | raw_spin_lock_bh(&lock->rlock); | |
309 | } | |
310 | ||
311 | static inline int spin_trylock(spinlock_t *lock) | |
312 | { | |
313 | return raw_spin_trylock(&lock->rlock); | |
314 | } | |
315 | ||
316 | #define spin_lock_nested(lock, subclass) \ | |
317 | do { \ | |
318 | raw_spin_lock_nested(spinlock_check(lock), subclass); \ | |
319 | } while (0) | |
320 | ||
321 | #define spin_lock_nest_lock(lock, nest_lock) \ | |
322 | do { \ | |
323 | raw_spin_lock_nest_lock(spinlock_check(lock), nest_lock); \ | |
324 | } while (0) | |
325 | ||
326 | static inline void spin_lock_irq(spinlock_t *lock) | |
327 | { | |
328 | raw_spin_lock_irq(&lock->rlock); | |
329 | } | |
330 | ||
331 | #define spin_lock_irqsave(lock, flags) \ | |
332 | do { \ | |
333 | raw_spin_lock_irqsave(spinlock_check(lock), flags); \ | |
334 | } while (0) | |
335 | ||
336 | #define spin_lock_irqsave_nested(lock, flags, subclass) \ | |
337 | do { \ | |
338 | raw_spin_lock_irqsave_nested(spinlock_check(lock), flags, subclass); \ | |
339 | } while (0) | |
340 | ||
341 | static inline void spin_unlock(spinlock_t *lock) | |
342 | { | |
343 | raw_spin_unlock(&lock->rlock); | |
344 | } | |
345 | ||
346 | static inline void spin_unlock_bh(spinlock_t *lock) | |
347 | { | |
348 | raw_spin_unlock_bh(&lock->rlock); | |
349 | } | |
350 | ||
351 | static inline void spin_unlock_irq(spinlock_t *lock) | |
352 | { | |
353 | raw_spin_unlock_irq(&lock->rlock); | |
354 | } | |
355 | ||
356 | static inline void spin_unlock_irqrestore(spinlock_t *lock, unsigned long flags) | |
357 | { | |
358 | raw_spin_unlock_irqrestore(&lock->rlock, flags); | |
359 | } | |
360 | ||
361 | static inline int spin_trylock_bh(spinlock_t *lock) | |
362 | { | |
363 | return raw_spin_trylock_bh(&lock->rlock); | |
364 | } | |
365 | ||
366 | static inline int spin_trylock_irq(spinlock_t *lock) | |
367 | { | |
368 | return raw_spin_trylock_irq(&lock->rlock); | |
369 | } | |
370 | ||
371 | #define spin_trylock_irqsave(lock, flags) \ | |
372 | ({ \ | |
373 | raw_spin_trylock_irqsave(spinlock_check(lock), flags); \ | |
374 | }) | |
375 | ||
376 | static inline void spin_unlock_wait(spinlock_t *lock) | |
377 | { | |
378 | raw_spin_unlock_wait(&lock->rlock); | |
379 | } | |
380 | ||
381 | static inline int spin_is_locked(spinlock_t *lock) | |
382 | { | |
383 | return raw_spin_is_locked(&lock->rlock); | |
384 | } | |
385 | ||
386 | static inline int spin_is_contended(spinlock_t *lock) | |
387 | { | |
388 | return raw_spin_is_contended(&lock->rlock); | |
389 | } | |
390 | ||
391 | static inline int spin_can_lock(spinlock_t *lock) | |
392 | { | |
393 | return raw_spin_can_lock(&lock->rlock); | |
394 | } | |
395 | ||
4ebc1b4b | 396 | #define assert_spin_locked(lock) assert_raw_spin_locked(&(lock)->rlock) |
c2f21ce2 | 397 | |
1da177e4 | 398 | /* |
fb1c8f93 IM |
399 | * Pull the atomic_t declaration: |
400 | * (asm-mips/atomic.h needs above definitions) | |
1da177e4 | 401 | */ |
60063497 | 402 | #include <linux/atomic.h> |
fb1c8f93 IM |
403 | /** |
404 | * atomic_dec_and_lock - lock on reaching reference count zero | |
405 | * @atomic: the atomic counter | |
406 | * @lock: the spinlock in question | |
dc07e721 BF |
407 | * |
408 | * Decrements @atomic by 1. If the result is 0, returns true and locks | |
409 | * @lock. Returns false for all other cases. | |
1da177e4 | 410 | */ |
fb1c8f93 IM |
411 | extern int _atomic_dec_and_lock(atomic_t *atomic, spinlock_t *lock); |
412 | #define atomic_dec_and_lock(atomic, lock) \ | |
dcc8e559 | 413 | __cond_lock(lock, _atomic_dec_and_lock(atomic, lock)) |
1da177e4 | 414 | |
1da177e4 | 415 | #endif /* __LINUX_SPINLOCK_H */ |