blob: dceb0a59b6927e1052fde9ae68cdeb9f586f94e8 [file] [log] [blame]
Thomas Gleixner6b6b4792009-11-16 18:48:37 +01001#ifndef __LINUX_RWLOCK_API_SMP_H
2#define __LINUX_RWLOCK_API_SMP_H
3
4#ifndef __LINUX_SPINLOCK_API_SMP_H
5# error "please don't include this file directly"
6#endif
7
8/*
9 * include/linux/rwlock_api_smp.h
10 *
11 * spinlock API declarations on SMP (and debug)
12 * (implemented in kernel/spinlock.c)
13 *
14 * portions Copyright 2005, Red Hat, Inc., Ingo Molnar
15 * Released under the General Public License (GPL).
16 */
17
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010018void __lockfunc _raw_read_lock(rwlock_t *lock) __acquires(lock);
19void __lockfunc _raw_write_lock(rwlock_t *lock) __acquires(lock);
Minchan Kim4a57d6b2022-01-21 22:14:10 -080020void __lockfunc _raw_write_lock_nested(rwlock_t *lock, int subclass) __acquires(lock);
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010021void __lockfunc _raw_read_lock_bh(rwlock_t *lock) __acquires(lock);
22void __lockfunc _raw_write_lock_bh(rwlock_t *lock) __acquires(lock);
23void __lockfunc _raw_read_lock_irq(rwlock_t *lock) __acquires(lock);
24void __lockfunc _raw_write_lock_irq(rwlock_t *lock) __acquires(lock);
25unsigned long __lockfunc _raw_read_lock_irqsave(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010026 __acquires(lock);
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010027unsigned long __lockfunc _raw_write_lock_irqsave(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010028 __acquires(lock);
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010029int __lockfunc _raw_read_trylock(rwlock_t *lock);
30int __lockfunc _raw_write_trylock(rwlock_t *lock);
31void __lockfunc _raw_read_unlock(rwlock_t *lock) __releases(lock);
32void __lockfunc _raw_write_unlock(rwlock_t *lock) __releases(lock);
33void __lockfunc _raw_read_unlock_bh(rwlock_t *lock) __releases(lock);
34void __lockfunc _raw_write_unlock_bh(rwlock_t *lock) __releases(lock);
35void __lockfunc _raw_read_unlock_irq(rwlock_t *lock) __releases(lock);
36void __lockfunc _raw_write_unlock_irq(rwlock_t *lock) __releases(lock);
37void __lockfunc
38_raw_read_unlock_irqrestore(rwlock_t *lock, unsigned long flags)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010039 __releases(lock);
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010040void __lockfunc
41_raw_write_unlock_irqrestore(rwlock_t *lock, unsigned long flags)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010042 __releases(lock);
43
44#ifdef CONFIG_INLINE_READ_LOCK
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010045#define _raw_read_lock(lock) __raw_read_lock(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010046#endif
47
48#ifdef CONFIG_INLINE_WRITE_LOCK
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010049#define _raw_write_lock(lock) __raw_write_lock(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010050#endif
51
52#ifdef CONFIG_INLINE_READ_LOCK_BH
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010053#define _raw_read_lock_bh(lock) __raw_read_lock_bh(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010054#endif
55
56#ifdef CONFIG_INLINE_WRITE_LOCK_BH
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010057#define _raw_write_lock_bh(lock) __raw_write_lock_bh(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010058#endif
59
60#ifdef CONFIG_INLINE_READ_LOCK_IRQ
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010061#define _raw_read_lock_irq(lock) __raw_read_lock_irq(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010062#endif
63
64#ifdef CONFIG_INLINE_WRITE_LOCK_IRQ
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010065#define _raw_write_lock_irq(lock) __raw_write_lock_irq(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010066#endif
67
68#ifdef CONFIG_INLINE_READ_LOCK_IRQSAVE
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010069#define _raw_read_lock_irqsave(lock) __raw_read_lock_irqsave(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010070#endif
71
72#ifdef CONFIG_INLINE_WRITE_LOCK_IRQSAVE
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010073#define _raw_write_lock_irqsave(lock) __raw_write_lock_irqsave(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010074#endif
75
76#ifdef CONFIG_INLINE_READ_TRYLOCK
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010077#define _raw_read_trylock(lock) __raw_read_trylock(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010078#endif
79
80#ifdef CONFIG_INLINE_WRITE_TRYLOCK
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010081#define _raw_write_trylock(lock) __raw_write_trylock(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010082#endif
83
84#ifdef CONFIG_INLINE_READ_UNLOCK
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010085#define _raw_read_unlock(lock) __raw_read_unlock(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010086#endif
87
88#ifdef CONFIG_INLINE_WRITE_UNLOCK
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010089#define _raw_write_unlock(lock) __raw_write_unlock(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010090#endif
91
92#ifdef CONFIG_INLINE_READ_UNLOCK_BH
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010093#define _raw_read_unlock_bh(lock) __raw_read_unlock_bh(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010094#endif
95
96#ifdef CONFIG_INLINE_WRITE_UNLOCK_BH
Thomas Gleixner9c1721a2009-12-03 21:52:18 +010097#define _raw_write_unlock_bh(lock) __raw_write_unlock_bh(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +010098#endif
99
100#ifdef CONFIG_INLINE_READ_UNLOCK_IRQ
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100101#define _raw_read_unlock_irq(lock) __raw_read_unlock_irq(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100102#endif
103
104#ifdef CONFIG_INLINE_WRITE_UNLOCK_IRQ
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100105#define _raw_write_unlock_irq(lock) __raw_write_unlock_irq(lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100106#endif
107
108#ifdef CONFIG_INLINE_READ_UNLOCK_IRQRESTORE
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100109#define _raw_read_unlock_irqrestore(lock, flags) \
110 __raw_read_unlock_irqrestore(lock, flags)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100111#endif
112
113#ifdef CONFIG_INLINE_WRITE_UNLOCK_IRQRESTORE
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100114#define _raw_write_unlock_irqrestore(lock, flags) \
115 __raw_write_unlock_irqrestore(lock, flags)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100116#endif
117
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100118static inline int __raw_read_trylock(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100119{
120 preempt_disable();
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100121 if (do_raw_read_trylock(lock)) {
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100122 rwlock_acquire_read(&lock->dep_map, 0, 1, _RET_IP_);
123 return 1;
124 }
125 preempt_enable();
126 return 0;
127}
128
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100129static inline int __raw_write_trylock(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100130{
131 preempt_disable();
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100132 if (do_raw_write_trylock(lock)) {
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100133 rwlock_acquire(&lock->dep_map, 0, 1, _RET_IP_);
134 return 1;
135 }
136 preempt_enable();
137 return 0;
138}
139
140/*
141 * If lockdep is enabled then we use the non-preemption spin-ops
142 * even on CONFIG_PREEMPT, because lockdep assumes that interrupts are
143 * not re-enabled during lock-acquire (which the preempt-spin-ops do):
144 */
145#if !defined(CONFIG_GENERIC_LOCKBREAK) || defined(CONFIG_DEBUG_LOCK_ALLOC)
146
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100147static inline void __raw_read_lock(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100148{
149 preempt_disable();
150 rwlock_acquire_read(&lock->dep_map, 0, 0, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100151 LOCK_CONTENDED(lock, do_raw_read_trylock, do_raw_read_lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100152}
153
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100154static inline unsigned long __raw_read_lock_irqsave(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100155{
156 unsigned long flags;
157
158 local_irq_save(flags);
159 preempt_disable();
160 rwlock_acquire_read(&lock->dep_map, 0, 0, _RET_IP_);
Arnd Bergmannf98a3dc2021-10-22 13:59:38 +0200161 LOCK_CONTENDED(lock, do_raw_read_trylock, do_raw_read_lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100162 return flags;
163}
164
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100165static inline void __raw_read_lock_irq(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100166{
167 local_irq_disable();
168 preempt_disable();
169 rwlock_acquire_read(&lock->dep_map, 0, 0, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100170 LOCK_CONTENDED(lock, do_raw_read_trylock, do_raw_read_lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100171}
172
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100173static inline void __raw_read_lock_bh(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100174{
Peter Zijlstra9ea4c382013-11-19 16:13:38 +0100175 __local_bh_disable_ip(_RET_IP_, SOFTIRQ_LOCK_OFFSET);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100176 rwlock_acquire_read(&lock->dep_map, 0, 0, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100177 LOCK_CONTENDED(lock, do_raw_read_trylock, do_raw_read_lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100178}
179
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100180static inline unsigned long __raw_write_lock_irqsave(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100181{
182 unsigned long flags;
183
184 local_irq_save(flags);
185 preempt_disable();
186 rwlock_acquire(&lock->dep_map, 0, 0, _RET_IP_);
Arnd Bergmannf98a3dc2021-10-22 13:59:38 +0200187 LOCK_CONTENDED(lock, do_raw_write_trylock, do_raw_write_lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100188 return flags;
189}
190
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100191static inline void __raw_write_lock_irq(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100192{
193 local_irq_disable();
194 preempt_disable();
195 rwlock_acquire(&lock->dep_map, 0, 0, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100196 LOCK_CONTENDED(lock, do_raw_write_trylock, do_raw_write_lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100197}
198
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100199static inline void __raw_write_lock_bh(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100200{
Peter Zijlstra9ea4c382013-11-19 16:13:38 +0100201 __local_bh_disable_ip(_RET_IP_, SOFTIRQ_LOCK_OFFSET);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100202 rwlock_acquire(&lock->dep_map, 0, 0, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100203 LOCK_CONTENDED(lock, do_raw_write_trylock, do_raw_write_lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100204}
205
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100206static inline void __raw_write_lock(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100207{
208 preempt_disable();
209 rwlock_acquire(&lock->dep_map, 0, 0, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100210 LOCK_CONTENDED(lock, do_raw_write_trylock, do_raw_write_lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100211}
212
Minchan Kim4a57d6b2022-01-21 22:14:10 -0800213static inline void __raw_write_lock_nested(rwlock_t *lock, int subclass)
214{
215 preempt_disable();
216 rwlock_acquire(&lock->dep_map, subclass, 0, _RET_IP_);
217 LOCK_CONTENDED(lock, do_raw_write_trylock, do_raw_write_lock);
218}
219
Cheng Jianf791dd252017-11-03 18:59:48 +0800220#endif /* !CONFIG_GENERIC_LOCKBREAK || CONFIG_DEBUG_LOCK_ALLOC */
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100221
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100222static inline void __raw_write_unlock(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100223{
Qian Cai5facae42019-09-19 12:09:40 -0400224 rwlock_release(&lock->dep_map, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100225 do_raw_write_unlock(lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100226 preempt_enable();
227}
228
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100229static inline void __raw_read_unlock(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100230{
Qian Cai5facae42019-09-19 12:09:40 -0400231 rwlock_release(&lock->dep_map, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100232 do_raw_read_unlock(lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100233 preempt_enable();
234}
235
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100236static inline void
237__raw_read_unlock_irqrestore(rwlock_t *lock, unsigned long flags)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100238{
Qian Cai5facae42019-09-19 12:09:40 -0400239 rwlock_release(&lock->dep_map, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100240 do_raw_read_unlock(lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100241 local_irq_restore(flags);
242 preempt_enable();
243}
244
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100245static inline void __raw_read_unlock_irq(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100246{
Qian Cai5facae42019-09-19 12:09:40 -0400247 rwlock_release(&lock->dep_map, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100248 do_raw_read_unlock(lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100249 local_irq_enable();
250 preempt_enable();
251}
252
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100253static inline void __raw_read_unlock_bh(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100254{
Qian Cai5facae42019-09-19 12:09:40 -0400255 rwlock_release(&lock->dep_map, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100256 do_raw_read_unlock(lock);
Peter Zijlstra9ea4c382013-11-19 16:13:38 +0100257 __local_bh_enable_ip(_RET_IP_, SOFTIRQ_LOCK_OFFSET);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100258}
259
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100260static inline void __raw_write_unlock_irqrestore(rwlock_t *lock,
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100261 unsigned long flags)
262{
Qian Cai5facae42019-09-19 12:09:40 -0400263 rwlock_release(&lock->dep_map, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100264 do_raw_write_unlock(lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100265 local_irq_restore(flags);
266 preempt_enable();
267}
268
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100269static inline void __raw_write_unlock_irq(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100270{
Qian Cai5facae42019-09-19 12:09:40 -0400271 rwlock_release(&lock->dep_map, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100272 do_raw_write_unlock(lock);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100273 local_irq_enable();
274 preempt_enable();
275}
276
Thomas Gleixner9c1721a2009-12-03 21:52:18 +0100277static inline void __raw_write_unlock_bh(rwlock_t *lock)
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100278{
Qian Cai5facae42019-09-19 12:09:40 -0400279 rwlock_release(&lock->dep_map, _RET_IP_);
Thomas Gleixner9828ea92009-12-03 20:55:53 +0100280 do_raw_write_unlock(lock);
Peter Zijlstra9ea4c382013-11-19 16:13:38 +0100281 __local_bh_enable_ip(_RET_IP_, SOFTIRQ_LOCK_OFFSET);
Thomas Gleixner6b6b4792009-11-16 18:48:37 +0100282}
283
284#endif /* __LINUX_RWLOCK_API_SMP_H */