blob: 0b1f779572402d4736783cbc890bfbf748416b38 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/* rwsem.c: R/W semaphores: contention handling functions
3 *
4 * Written by David Howells (dhowells@redhat.com).
5 * Derived from arch/i386/kernel/semaphore.c
Alex Shice6711f2013-02-05 21:11:55 +08006 *
7 * Writer lock-stealing by Alex Shi <alex.shi@intel.com>
Michel Lespinassefe6e6742013-05-07 06:45:59 -07008 * and Michel Lespinasse <walken@google.com>
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -07009 *
10 * Optimistic spinning by Tim Chen <tim.c.chen@intel.com>
11 * and Davidlohr Bueso <davidlohr@hp.com>. Based on mutexes.
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 */
13#include <linux/rwsem.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/init.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050015#include <linux/export.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010016#include <linux/sched/signal.h>
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -070017#include <linux/sched/rt.h>
Ingo Molnar84f001e2017-02-01 16:36:40 +010018#include <linux/sched/wake_q.h>
Ingo Molnarb17b0152017-02-08 18:51:35 +010019#include <linux/sched/debug.h>
Davidlohr Bueso7a215f82015-01-30 01:14:25 -080020#include <linux/osq_lock.h>
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -070021
Davidlohr Bueso7a215f82015-01-30 01:14:25 -080022#include "rwsem.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Ingo Molnar4ea21762006-07-03 00:24:53 -070024/*
Tim Chen3cf2f342014-05-02 12:53:57 -070025 * Guide to the rw_semaphore's count field for common values.
26 * (32-bit case illustrated, similar for 64-bit)
27 *
28 * 0x0000000X (1) X readers active or attempting lock, no writer waiting
29 * X = #active_readers + #readers attempting to lock
30 * (X*ACTIVE_BIAS)
31 *
32 * 0x00000000 rwsem is unlocked, and no one is waiting for the lock or
33 * attempting to read lock or write lock.
34 *
35 * 0xffff000X (1) X readers active or attempting lock, with waiters for lock
36 * X = #active readers + # readers attempting lock
37 * (X*ACTIVE_BIAS + WAITING_BIAS)
38 * (2) 1 writer attempting lock, no waiters for lock
39 * X-1 = #active readers + #readers attempting lock
40 * ((X-1)*ACTIVE_BIAS + ACTIVE_WRITE_BIAS)
41 * (3) 1 writer active, no waiters for lock
42 * X-1 = #active readers + #readers attempting lock
43 * ((X-1)*ACTIVE_BIAS + ACTIVE_WRITE_BIAS)
44 *
45 * 0xffff0001 (1) 1 reader active or attempting lock, waiters for lock
46 * (WAITING_BIAS + ACTIVE_BIAS)
47 * (2) 1 writer active or attempting lock, no waiters for lock
48 * (ACTIVE_WRITE_BIAS)
49 *
50 * 0xffff0000 (1) There are writers or readers queued but none active
51 * or in the process of attempting lock.
52 * (WAITING_BIAS)
53 * Note: writer can attempt to steal lock for this count by adding
54 * ACTIVE_WRITE_BIAS in cmpxchg and checking the old count
55 *
56 * 0xfffe0001 (1) 1 writer active, or attempting lock. Waiters on queue.
57 * (ACTIVE_WRITE_BIAS + WAITING_BIAS)
58 *
59 * Note: Readers attempt to lock by adding ACTIVE_BIAS in down_read and checking
60 * the count becomes more than 0 for successful lock acquisition,
61 * i.e. the case where there are only readers or nobody has lock.
62 * (1st and 2nd case above).
63 *
64 * Writers attempt to lock by adding ACTIVE_WRITE_BIAS in down_write and
65 * checking the count becomes ACTIVE_WRITE_BIAS for successful lock
66 * acquisition (i.e. nobody else has lock or attempts lock). If
67 * unsuccessful, in rwsem_down_write_failed, we'll check to see if there
68 * are only waiters but none active (5th case above), and attempt to
69 * steal the lock.
70 *
71 */
72
73/*
Ingo Molnar4ea21762006-07-03 00:24:53 -070074 * Initialize an rwsem:
75 */
76void __init_rwsem(struct rw_semaphore *sem, const char *name,
77 struct lock_class_key *key)
78{
79#ifdef CONFIG_DEBUG_LOCK_ALLOC
80 /*
81 * Make sure we are not reinitializing a held semaphore:
82 */
83 debug_check_no_locks_freed((void *)sem, sizeof(*sem));
Peter Zijlstra4dfbb9d2006-10-11 01:45:14 -040084 lockdep_init_map(&sem->dep_map, name, key, 0);
Ingo Molnar4ea21762006-07-03 00:24:53 -070085#endif
Jason Low8ee62b12016-06-03 22:26:02 -070086 atomic_long_set(&sem->count, RWSEM_UNLOCKED_VALUE);
Thomas Gleixnerddb6c9b2010-02-24 09:54:54 +010087 raw_spin_lock_init(&sem->wait_lock);
Ingo Molnar4ea21762006-07-03 00:24:53 -070088 INIT_LIST_HEAD(&sem->wait_list);
Davidlohr Bueso5db6c6f2014-07-11 14:00:06 -070089#ifdef CONFIG_RWSEM_SPIN_ON_OWNER
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -070090 sem->owner = NULL;
Jason Low4d9d9512014-07-14 10:27:50 -070091 osq_lock_init(&sem->osq);
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -070092#endif
Ingo Molnar4ea21762006-07-03 00:24:53 -070093}
94
95EXPORT_SYMBOL(__init_rwsem);
96
Michel Lespinassee2d57f72013-05-07 06:45:49 -070097enum rwsem_waiter_type {
98 RWSEM_WAITING_FOR_WRITE,
99 RWSEM_WAITING_FOR_READ
100};
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102struct rwsem_waiter {
103 struct list_head list;
104 struct task_struct *task;
Michel Lespinassee2d57f72013-05-07 06:45:49 -0700105 enum rwsem_waiter_type type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106};
107
Michel Lespinassefe6e6742013-05-07 06:45:59 -0700108enum rwsem_wake_type {
109 RWSEM_WAKE_ANY, /* Wake whatever's at head of wait list */
110 RWSEM_WAKE_READERS, /* Wake readers only */
111 RWSEM_WAKE_READ_OWNED /* Waker thread holds the read lock */
112};
Michel Lespinasse70bdc6e2010-08-09 17:21:17 -0700113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114/*
115 * handle the lock release when processes blocked on it that can now run
116 * - if we come here from up_xxxx(), then:
117 * - the 'active part' of count (&0x0000ffff) reached 0 (but may have changed)
118 * - the 'waiting part' of count (&0xffff0000) is -ve (and will still be so)
Michel Lespinasse345af7b2010-08-09 17:21:15 -0700119 * - there must be someone on the queue
Davidlohr Bueso133e89e2016-05-13 11:56:26 -0700120 * - the wait_lock must be held by the caller
121 * - tasks are marked for wakeup, the caller must later invoke wake_up_q()
122 * to actually wakeup the blocked task(s) and drop the reference count,
123 * preferably when the wait_lock is released
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 * - woken process blocks are discarded from the list after having task zeroed
Davidlohr Bueso133e89e2016-05-13 11:56:26 -0700125 * - writers are only marked woken if downgrading is false
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 */
Davidlohr Bueso84b23f92016-08-05 01:04:43 -0700127static void __rwsem_mark_wake(struct rw_semaphore *sem,
128 enum rwsem_wake_type wake_type,
129 struct wake_q_head *wake_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130{
Davidlohr Bueso70800c32016-08-05 01:04:45 -0700131 struct rwsem_waiter *waiter, *tmp;
132 long oldcount, woken = 0, adjustment = 0;
Waiman Longa9e9bcb2019-04-28 17:25:38 -0400133 struct list_head wlist;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Davidlohr Bueso70800c32016-08-05 01:04:45 -0700135 /*
136 * Take a peek at the queue head waiter such that we can determine
137 * the wakeup(s) to perform.
138 */
139 waiter = list_first_entry(&sem->wait_list, struct rwsem_waiter, list);
Davidlohr Bueso84b23f92016-08-05 01:04:43 -0700140
Michel Lespinasse8cf53222013-05-07 06:45:58 -0700141 if (waiter->type == RWSEM_WAITING_FOR_WRITE) {
Davidlohr Bueso133e89e2016-05-13 11:56:26 -0700142 if (wake_type == RWSEM_WAKE_ANY) {
143 /*
144 * Mark writer at the front of the queue for wakeup.
145 * Until the task is actually later awoken later by
146 * the caller, other writers are able to steal it.
147 * Readers, on the other hand, will block as they
148 * will notice the queued writer.
Michel Lespinasse8cf53222013-05-07 06:45:58 -0700149 */
Davidlohr Bueso133e89e2016-05-13 11:56:26 -0700150 wake_q_add(wake_q, waiter->task);
Waiman Longa8654592019-04-04 13:43:19 -0400151 lockevent_inc(rwsem_wake_writer);
Davidlohr Bueso133e89e2016-05-13 11:56:26 -0700152 }
Davidlohr Bueso84b23f92016-08-05 01:04:43 -0700153
154 return;
Michel Lespinasse8cf53222013-05-07 06:45:58 -0700155 }
Michel Lespinasse345af7b2010-08-09 17:21:15 -0700156
Davidlohr Bueso84b23f92016-08-05 01:04:43 -0700157 /*
158 * Writers might steal the lock before we grant it to the next reader.
Michel Lespinassefe6e6742013-05-07 06:45:59 -0700159 * We prefer to do the first reader grant before counting readers
160 * so we can bail out early if a writer stole the lock.
Michel Lespinasse70bdc6e2010-08-09 17:21:17 -0700161 */
Michel Lespinassefe6e6742013-05-07 06:45:59 -0700162 if (wake_type != RWSEM_WAKE_READ_OWNED) {
163 adjustment = RWSEM_ACTIVE_READ_BIAS;
164 try_reader_grant:
Peter Zijlstra86a3b5f2016-05-18 12:42:21 +0200165 oldcount = atomic_long_fetch_add(adjustment, &sem->count);
Michel Lespinassefe6e6742013-05-07 06:45:59 -0700166 if (unlikely(oldcount < RWSEM_WAITING_BIAS)) {
Waiman Longbf7b4c42016-05-17 21:26:22 -0400167 /*
168 * If the count is still less than RWSEM_WAITING_BIAS
169 * after removing the adjustment, it is assumed that
170 * a writer has stolen the lock. We have to undo our
171 * reader grant.
172 */
173 if (atomic_long_add_return(-adjustment, &sem->count) <
174 RWSEM_WAITING_BIAS)
Davidlohr Bueso84b23f92016-08-05 01:04:43 -0700175 return;
176
Michel Lespinassefe6e6742013-05-07 06:45:59 -0700177 /* Last active locker left. Retry waking readers. */
178 goto try_reader_grant;
179 }
Waiman Long19c5d692016-05-17 21:26:19 -0400180 /*
Waiman Longc7580c12019-04-04 13:43:11 -0400181 * Set it to reader-owned to give spinners an early
182 * indication that readers now have the lock.
Waiman Long19c5d692016-05-17 21:26:19 -0400183 */
Waiman Long925b9cd2018-09-06 16:18:34 -0400184 __rwsem_set_reader_owned(sem, waiter->task);
Michel Lespinassefe6e6742013-05-07 06:45:59 -0700185 }
Michel Lespinasse345af7b2010-08-09 17:21:15 -0700186
Davidlohr Bueso84b23f92016-08-05 01:04:43 -0700187 /*
188 * Grant an infinite number of read locks to the readers at the front
Davidlohr Bueso70800c32016-08-05 01:04:45 -0700189 * of the queue. We know that woken will be at least 1 as we accounted
190 * for above. Note we increment the 'active part' of the count by the
191 * number of readers before waking any processes up.
Waiman Longa9e9bcb2019-04-28 17:25:38 -0400192 *
193 * We have to do wakeup in 2 passes to prevent the possibility that
194 * the reader count may be decremented before it is incremented. It
195 * is because the to-be-woken waiter may not have slept yet. So it
196 * may see waiter->task got cleared, finish its critical section and
197 * do an unlock before the reader count increment.
198 *
199 * 1) Collect the read-waiters in a separate list, count them and
200 * fully increment the reader count in rwsem.
201 * 2) For each waiters in the new list, clear waiter->task and
202 * put them into wake_q to be woken up later.
Michel Lespinasse345af7b2010-08-09 17:21:15 -0700203 */
Waiman Longa9e9bcb2019-04-28 17:25:38 -0400204 list_for_each_entry(waiter, &sem->wait_list, list) {
Davidlohr Bueso70800c32016-08-05 01:04:45 -0700205 if (waiter->type == RWSEM_WAITING_FOR_WRITE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 break;
207
Davidlohr Bueso70800c32016-08-05 01:04:45 -0700208 woken++;
Waiman Longa9e9bcb2019-04-28 17:25:38 -0400209 }
210 list_cut_before(&wlist, &sem->wait_list, &waiter->list);
Davidlohr Buesoe3851392016-05-13 11:56:27 -0700211
Waiman Longa9e9bcb2019-04-28 17:25:38 -0400212 adjustment = woken * RWSEM_ACTIVE_READ_BIAS - adjustment;
213 lockevent_cond_inc(rwsem_wake_reader, woken);
214 if (list_empty(&sem->wait_list)) {
215 /* hit end of list above */
216 adjustment -= RWSEM_WAITING_BIAS;
217 }
218
219 if (adjustment)
220 atomic_long_add(adjustment, &sem->count);
221
222 /* 2nd pass */
223 list_for_each_entry_safe(waiter, tmp, &wlist, list) {
224 struct task_struct *tsk;
225
226 tsk = waiter->task;
Xie Yongjie158488b2018-11-29 20:50:30 +0800227 get_task_struct(tsk);
Waiman Longa9e9bcb2019-04-28 17:25:38 -0400228
Davidlohr Buesoe3851392016-05-13 11:56:27 -0700229 /*
Xie Yongjie158488b2018-11-29 20:50:30 +0800230 * Ensure calling get_task_struct() before setting the reader
Davidlohr Buesoe3851392016-05-13 11:56:27 -0700231 * waiter to nil such that rwsem_down_read_failed() cannot
232 * race with do_exit() by always holding a reference count
233 * to the task to wakeup.
234 */
235 smp_store_release(&waiter->task, NULL);
Xie Yongjie158488b2018-11-29 20:50:30 +0800236 /*
237 * Ensure issuing the wakeup (either by us or someone else)
238 * after setting the reader waiter to nil.
239 */
Davidlohr Bueso07879c62018-12-18 11:53:52 -0800240 wake_q_add_safe(wake_q, tsk);
Davidlohr Bueso70800c32016-08-05 01:04:45 -0700241 }
Alex Shice6711f2013-02-05 21:11:55 +0800242}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244/*
Jason Lowc0fcb6c2016-05-16 17:38:00 -0700245 * This function must be called with the sem->wait_lock held to prevent
246 * race conditions between checking the rwsem wait list and setting the
247 * sem->count accordingly.
248 */
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700249static inline bool rwsem_try_write_lock(long count, struct rw_semaphore *sem)
250{
Jason Lowdebfab72014-09-16 17:16:57 -0700251 /*
Jason Lowc0fcb6c2016-05-16 17:38:00 -0700252 * Avoid trying to acquire write lock if count isn't RWSEM_WAITING_BIAS.
Jason Lowdebfab72014-09-16 17:16:57 -0700253 */
Jason Lowc0fcb6c2016-05-16 17:38:00 -0700254 if (count != RWSEM_WAITING_BIAS)
255 return false;
256
257 /*
258 * Acquire the lock by trying to set it to ACTIVE_WRITE_BIAS. If there
259 * are other tasks on the wait list, we need to add on WAITING_BIAS.
260 */
261 count = list_is_singular(&sem->wait_list) ?
262 RWSEM_ACTIVE_WRITE_BIAS :
263 RWSEM_ACTIVE_WRITE_BIAS + RWSEM_WAITING_BIAS;
264
Jason Low8ee62b12016-06-03 22:26:02 -0700265 if (atomic_long_cmpxchg_acquire(&sem->count, RWSEM_WAITING_BIAS, count)
266 == RWSEM_WAITING_BIAS) {
Davidlohr Bueso7a215f82015-01-30 01:14:25 -0800267 rwsem_set_owner(sem);
Jason Lowdebfab72014-09-16 17:16:57 -0700268 return true;
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700269 }
Jason Lowdebfab72014-09-16 17:16:57 -0700270
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700271 return false;
272}
273
Davidlohr Bueso5db6c6f2014-07-11 14:00:06 -0700274#ifdef CONFIG_RWSEM_SPIN_ON_OWNER
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275/*
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700276 * Try to acquire write lock before the writer has been put on wait queue.
277 */
278static inline bool rwsem_try_write_lock_unqueued(struct rw_semaphore *sem)
279{
Waiman Longa338ecb2019-04-04 13:43:13 -0400280 long count = atomic_long_read(&sem->count);
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700281
Waiman Longa338ecb2019-04-04 13:43:13 -0400282 while (!count || count == RWSEM_WAITING_BIAS) {
283 if (atomic_long_try_cmpxchg_acquire(&sem->count, &count,
284 count + RWSEM_ACTIVE_WRITE_BIAS)) {
Davidlohr Bueso7a215f82015-01-30 01:14:25 -0800285 rwsem_set_owner(sem);
Waiman Longa8654592019-04-04 13:43:19 -0400286 lockevent_inc(rwsem_opt_wlock);
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700287 return true;
Davidlohr Bueso7a215f82015-01-30 01:14:25 -0800288 }
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700289 }
Waiman Longa338ecb2019-04-04 13:43:13 -0400290 return false;
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700291}
292
Oleg Nesterov1b22fc62018-05-18 18:55:35 +0200293static inline bool owner_on_cpu(struct task_struct *owner)
294{
295 /*
296 * As lock holder preemption issue, we both skip spinning if
297 * task is not on cpu or its cpu is preempted
298 */
299 return owner->on_cpu && !vcpu_is_preempted(task_cpu(owner));
300}
301
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700302static inline bool rwsem_can_spin_on_owner(struct rw_semaphore *sem)
303{
304 struct task_struct *owner;
Davidlohr Bueso1a993672015-01-30 01:14:27 -0800305 bool ret = true;
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700306
Waiman Long5a817642018-05-15 17:49:51 -0400307 BUILD_BUG_ON(!rwsem_has_anonymous_owner(RWSEM_OWNER_UNKNOWN));
308
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700309 if (need_resched())
Jason Low37e95622014-07-04 20:49:32 -0700310 return false;
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700311
312 rcu_read_lock();
Davidlohr Bueso4d3199e2015-02-22 19:31:41 -0800313 owner = READ_ONCE(sem->owner);
Oleg Nesterov1b22fc62018-05-18 18:55:35 +0200314 if (owner) {
315 ret = is_rwsem_owner_spinnable(owner) &&
316 owner_on_cpu(owner);
Davidlohr Bueso1a993672015-01-30 01:14:27 -0800317 }
Davidlohr Bueso1a993672015-01-30 01:14:27 -0800318 rcu_read_unlock();
319 return ret;
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700320}
321
Waiman Longddd0fa72016-05-17 21:26:23 -0400322/*
323 * Return true only if we can still spin on the owner field of the rwsem.
324 */
325static noinline bool rwsem_spin_on_owner(struct rw_semaphore *sem)
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700326{
Waiman Longddd0fa72016-05-17 21:26:23 -0400327 struct task_struct *owner = READ_ONCE(sem->owner);
328
Waiman Longd7d760e2018-05-15 17:49:50 -0400329 if (!is_rwsem_owner_spinnable(owner))
330 return false;
Waiman Longddd0fa72016-05-17 21:26:23 -0400331
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700332 rcu_read_lock();
Waiman Longd7d760e2018-05-15 17:49:50 -0400333 while (owner && (READ_ONCE(sem->owner) == owner)) {
Jason Low9198f6e2015-03-06 23:45:31 -0800334 /*
335 * Ensure we emit the owner->on_cpu, dereference _after_
336 * checking sem->owner still matches owner, if that fails,
337 * owner might point to free()d memory, if it still matches,
338 * the rcu_read_lock() ensures the memory stays valid.
339 */
340 barrier();
341
Pan Xinhui05ffc952016-11-02 05:08:30 -0400342 /*
343 * abort spinning when need_resched or owner is not running or
344 * owner's cpu is preempted.
345 */
Oleg Nesterov1b22fc62018-05-18 18:55:35 +0200346 if (need_resched() || !owner_on_cpu(owner)) {
Davidlohr Buesob3fd4f02015-01-30 01:14:26 -0800347 rcu_read_unlock();
348 return false;
349 }
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700350
Christian Borntraegerf2f09a42016-10-25 11:03:14 +0200351 cpu_relax();
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700352 }
353 rcu_read_unlock();
Waiman Longd7d760e2018-05-15 17:49:50 -0400354
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700355 /*
Waiman Long19c5d692016-05-17 21:26:19 -0400356 * If there is a new owner or the owner is not set, we continue
357 * spinning.
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700358 */
Waiman Longd7d760e2018-05-15 17:49:50 -0400359 return is_rwsem_owner_spinnable(READ_ONCE(sem->owner));
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700360}
361
362static bool rwsem_optimistic_spin(struct rw_semaphore *sem)
363{
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700364 bool taken = false;
365
366 preempt_disable();
367
368 /* sem->wait_lock should not be held when doing optimistic spinning */
369 if (!rwsem_can_spin_on_owner(sem))
370 goto done;
371
372 if (!osq_lock(&sem->osq))
373 goto done;
374
Waiman Longddd0fa72016-05-17 21:26:23 -0400375 /*
376 * Optimistically spin on the owner field and attempt to acquire the
377 * lock whenever the owner changes. Spinning will be stopped when:
378 * 1) the owning writer isn't running; or
379 * 2) readers own the lock as we can't determine if they are
380 * actively running or not.
381 */
382 while (rwsem_spin_on_owner(sem)) {
Waiman Long19c5d692016-05-17 21:26:19 -0400383 /*
Waiman Longddd0fa72016-05-17 21:26:23 -0400384 * Try to acquire the lock
Waiman Long19c5d692016-05-17 21:26:19 -0400385 */
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700386 if (rwsem_try_write_lock_unqueued(sem)) {
387 taken = true;
388 break;
389 }
390
391 /*
392 * When there's no owner, we might have preempted between the
393 * owner acquiring the lock and setting the owner field. If
394 * we're an RT task that will live-lock because we won't let
395 * the owner complete.
396 */
Waiman Longddd0fa72016-05-17 21:26:23 -0400397 if (!sem->owner && (need_resched() || rt_task(current)))
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700398 break;
399
400 /*
401 * The cpu_relax() call is a compiler barrier which forces
402 * everything in this loop to be re-loaded. We don't need
403 * memory barriers as we'll eventually observe the right
404 * values at the cost of a few extra spins.
405 */
Christian Borntraegerf2f09a42016-10-25 11:03:14 +0200406 cpu_relax();
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700407 }
408 osq_unlock(&sem->osq);
409done:
410 preempt_enable();
Waiman Longa8654592019-04-04 13:43:19 -0400411 lockevent_cond_inc(rwsem_opt_fail, !taken);
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700412 return taken;
413}
414
Waiman Long59aabfc2015-04-30 17:12:16 -0400415/*
416 * Return true if the rwsem has active spinner
417 */
418static inline bool rwsem_has_spinner(struct rw_semaphore *sem)
419{
420 return osq_is_locked(&sem->osq);
421}
422
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700423#else
424static bool rwsem_optimistic_spin(struct rw_semaphore *sem)
425{
426 return false;
427}
Waiman Long59aabfc2015-04-30 17:12:16 -0400428
429static inline bool rwsem_has_spinner(struct rw_semaphore *sem)
430{
431 return false;
432}
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700433#endif
434
435/*
Waiman Longeecec782019-04-04 13:43:10 -0400436 * Wait for the read lock to be granted
437 */
438static inline struct rw_semaphore __sched *
439__rwsem_down_read_failed_common(struct rw_semaphore *sem, int state)
440{
441 long count, adjustment = -RWSEM_ACTIVE_READ_BIAS;
442 struct rwsem_waiter waiter;
443 DEFINE_WAKE_Q(wake_q);
444
445 waiter.task = current;
446 waiter.type = RWSEM_WAITING_FOR_READ;
447
448 raw_spin_lock_irq(&sem->wait_lock);
449 if (list_empty(&sem->wait_list)) {
450 /*
451 * In case the wait queue is empty and the lock isn't owned
452 * by a writer, this reader can exit the slowpath and return
453 * immediately as its RWSEM_ACTIVE_READ_BIAS has already
454 * been set in the count.
455 */
456 if (atomic_long_read(&sem->count) >= 0) {
457 raw_spin_unlock_irq(&sem->wait_lock);
Waiman Longc7580c12019-04-04 13:43:11 -0400458 rwsem_set_reader_owned(sem);
Waiman Longa8654592019-04-04 13:43:19 -0400459 lockevent_inc(rwsem_rlock_fast);
Waiman Longeecec782019-04-04 13:43:10 -0400460 return sem;
461 }
462 adjustment += RWSEM_WAITING_BIAS;
463 }
464 list_add_tail(&waiter.list, &sem->wait_list);
465
466 /* we're now waiting on the lock, but no longer actively locking */
467 count = atomic_long_add_return(adjustment, &sem->count);
468
469 /*
470 * If there are no active locks, wake the front queued process(es).
471 *
472 * If there are no writers and we are first in the queue,
473 * wake our own waiter to join the existing active readers !
474 */
475 if (count == RWSEM_WAITING_BIAS ||
476 (count > RWSEM_WAITING_BIAS &&
477 adjustment != -RWSEM_ACTIVE_READ_BIAS))
478 __rwsem_mark_wake(sem, RWSEM_WAKE_ANY, &wake_q);
479
480 raw_spin_unlock_irq(&sem->wait_lock);
481 wake_up_q(&wake_q);
482
483 /* wait to be given the lock */
484 while (true) {
485 set_current_state(state);
486 if (!waiter.task)
487 break;
488 if (signal_pending_state(state, current)) {
489 raw_spin_lock_irq(&sem->wait_lock);
490 if (waiter.task)
491 goto out_nolock;
492 raw_spin_unlock_irq(&sem->wait_lock);
493 break;
494 }
495 schedule();
Waiman Longa8654592019-04-04 13:43:19 -0400496 lockevent_inc(rwsem_sleep_reader);
Waiman Longeecec782019-04-04 13:43:10 -0400497 }
498
499 __set_current_state(TASK_RUNNING);
Waiman Longa8654592019-04-04 13:43:19 -0400500 lockevent_inc(rwsem_rlock);
Waiman Longeecec782019-04-04 13:43:10 -0400501 return sem;
502out_nolock:
503 list_del(&waiter.list);
504 if (list_empty(&sem->wait_list))
505 atomic_long_add(-RWSEM_WAITING_BIAS, &sem->count);
506 raw_spin_unlock_irq(&sem->wait_lock);
507 __set_current_state(TASK_RUNNING);
Waiman Longa8654592019-04-04 13:43:19 -0400508 lockevent_inc(rwsem_rlock_fail);
Waiman Longeecec782019-04-04 13:43:10 -0400509 return ERR_PTR(-EINTR);
510}
511
512__visible struct rw_semaphore * __sched
513rwsem_down_read_failed(struct rw_semaphore *sem)
514{
515 return __rwsem_down_read_failed_common(sem, TASK_UNINTERRUPTIBLE);
516}
517EXPORT_SYMBOL(rwsem_down_read_failed);
518
519__visible struct rw_semaphore * __sched
520rwsem_down_read_failed_killable(struct rw_semaphore *sem)
521{
522 return __rwsem_down_read_failed_common(sem, TASK_KILLABLE);
523}
524EXPORT_SYMBOL(rwsem_down_read_failed_killable);
525
526/*
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700527 * Wait until we successfully acquire the write lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 */
Michal Hockod47996082016-04-07 17:12:26 +0200529static inline struct rw_semaphore *
530__rwsem_down_write_failed_common(struct rw_semaphore *sem, int state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531{
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700532 long count;
533 bool waiting = true; /* any queued threads before us */
Michel Lespinasse1e782772013-05-07 06:45:51 -0700534 struct rwsem_waiter waiter;
Michal Hockod47996082016-04-07 17:12:26 +0200535 struct rw_semaphore *ret = sem;
Waiman Long194a6b52016-11-17 11:46:38 -0500536 DEFINE_WAKE_Q(wake_q);
Michel Lespinasse1e782772013-05-07 06:45:51 -0700537
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700538 /* undo write bias from down_write operation, stop active locking */
Jason Low8ee62b12016-06-03 22:26:02 -0700539 count = atomic_long_sub_return(RWSEM_ACTIVE_WRITE_BIAS, &sem->count);
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700540
541 /* do optimistic spinning and steal lock if possible */
542 if (rwsem_optimistic_spin(sem))
543 return sem;
544
545 /*
546 * Optimistic spinning failed, proceed to the slowpath
547 * and block until we can acquire the sem.
548 */
549 waiter.task = current;
Michel Lespinasse023fe4f2013-05-07 06:45:53 -0700550 waiter.type = RWSEM_WAITING_FOR_WRITE;
Michel Lespinasse1e782772013-05-07 06:45:51 -0700551
552 raw_spin_lock_irq(&sem->wait_lock);
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700553
554 /* account for this before adding a new element to the list */
Michel Lespinasse1e782772013-05-07 06:45:51 -0700555 if (list_empty(&sem->wait_list))
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700556 waiting = false;
557
Michel Lespinasse1e782772013-05-07 06:45:51 -0700558 list_add_tail(&waiter.list, &sem->wait_list);
559
560 /* we're now waiting on the lock, but no longer actively locking */
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700561 if (waiting) {
Jason Low8ee62b12016-06-03 22:26:02 -0700562 count = atomic_long_read(&sem->count);
Michel Lespinasse1e782772013-05-07 06:45:51 -0700563
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700564 /*
Andrew Morton0cc3d012014-06-04 20:19:48 +0200565 * If there were already threads queued before us and there are
566 * no active writers, the lock must be read owned; so we try to
567 * wake any read locks that were queued ahead of us.
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700568 */
Davidlohr Bueso133e89e2016-05-13 11:56:26 -0700569 if (count > RWSEM_WAITING_BIAS) {
Davidlohr Bueso84b23f92016-08-05 01:04:43 -0700570 __rwsem_mark_wake(sem, RWSEM_WAKE_READERS, &wake_q);
Davidlohr Bueso133e89e2016-05-13 11:56:26 -0700571 /*
572 * The wakeup is normally called _after_ the wait_lock
573 * is released, but given that we are proactively waking
574 * readers we can deal with the wake_q overhead as it is
575 * similar to releasing and taking the wait_lock again
576 * for attempting rwsem_try_write_lock().
577 */
578 wake_up_q(&wake_q);
Waiman Longbcc9a762017-01-21 21:33:35 -0500579
580 /*
581 * Reinitialize wake_q after use.
582 */
583 wake_q_init(&wake_q);
Davidlohr Bueso133e89e2016-05-13 11:56:26 -0700584 }
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700585
586 } else
Jason Low8ee62b12016-06-03 22:26:02 -0700587 count = atomic_long_add_return(RWSEM_WAITING_BIAS, &sem->count);
Michel Lespinasse1e782772013-05-07 06:45:51 -0700588
Michel Lespinasse023fe4f2013-05-07 06:45:53 -0700589 /* wait until we successfully acquire the lock */
Michal Hockod47996082016-04-07 17:12:26 +0200590 set_current_state(state);
Michel Lespinasse1e782772013-05-07 06:45:51 -0700591 while (true) {
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700592 if (rwsem_try_write_lock(count, sem))
593 break;
Michel Lespinasse1e782772013-05-07 06:45:51 -0700594 raw_spin_unlock_irq(&sem->wait_lock);
Michel Lespinassea7d2c572013-05-07 06:45:56 -0700595
596 /* Block until there are no active lockers. */
597 do {
Peter Zijlstra04cafed2016-05-12 13:57:45 +0200598 if (signal_pending_state(state, current))
599 goto out_nolock;
600
Michel Lespinassea7d2c572013-05-07 06:45:56 -0700601 schedule();
Waiman Longa8654592019-04-04 13:43:19 -0400602 lockevent_inc(rwsem_sleep_writer);
Michal Hockod47996082016-04-07 17:12:26 +0200603 set_current_state(state);
Jason Low8ee62b12016-06-03 22:26:02 -0700604 } while ((count = atomic_long_read(&sem->count)) & RWSEM_ACTIVE_MASK);
Michel Lespinassea7d2c572013-05-07 06:45:56 -0700605
Michel Lespinasse023fe4f2013-05-07 06:45:53 -0700606 raw_spin_lock_irq(&sem->wait_lock);
Michel Lespinasse1e782772013-05-07 06:45:51 -0700607 }
Davidlohr Bueso4fc828e2014-05-02 11:24:15 -0700608 __set_current_state(TASK_RUNNING);
Michel Lespinasse023fe4f2013-05-07 06:45:53 -0700609 list_del(&waiter.list);
610 raw_spin_unlock_irq(&sem->wait_lock);
Waiman Longa8654592019-04-04 13:43:19 -0400611 lockevent_inc(rwsem_wlock);
Michel Lespinasse1e782772013-05-07 06:45:51 -0700612
Michal Hockod47996082016-04-07 17:12:26 +0200613 return ret;
Peter Zijlstra04cafed2016-05-12 13:57:45 +0200614
615out_nolock:
616 __set_current_state(TASK_RUNNING);
617 raw_spin_lock_irq(&sem->wait_lock);
618 list_del(&waiter.list);
619 if (list_empty(&sem->wait_list))
Jason Low8ee62b12016-06-03 22:26:02 -0700620 atomic_long_add(-RWSEM_WAITING_BIAS, &sem->count);
Peter Zijlstra04cafed2016-05-12 13:57:45 +0200621 else
Davidlohr Bueso133e89e2016-05-13 11:56:26 -0700622 __rwsem_mark_wake(sem, RWSEM_WAKE_ANY, &wake_q);
Peter Zijlstra04cafed2016-05-12 13:57:45 +0200623 raw_spin_unlock_irq(&sem->wait_lock);
Davidlohr Bueso133e89e2016-05-13 11:56:26 -0700624 wake_up_q(&wake_q);
Waiman Longa8654592019-04-04 13:43:19 -0400625 lockevent_inc(rwsem_wlock_fail);
Peter Zijlstra04cafed2016-05-12 13:57:45 +0200626
627 return ERR_PTR(-EINTR);
Michal Hockod47996082016-04-07 17:12:26 +0200628}
629
630__visible struct rw_semaphore * __sched
631rwsem_down_write_failed(struct rw_semaphore *sem)
632{
633 return __rwsem_down_write_failed_common(sem, TASK_UNINTERRUPTIBLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634}
Davidlohr Buesodb0e716a2014-09-11 22:34:25 -0700635EXPORT_SYMBOL(rwsem_down_write_failed);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Michal Hockod47996082016-04-07 17:12:26 +0200637__visible struct rw_semaphore * __sched
638rwsem_down_write_failed_killable(struct rw_semaphore *sem)
639{
640 return __rwsem_down_write_failed_common(sem, TASK_KILLABLE);
641}
642EXPORT_SYMBOL(rwsem_down_write_failed_killable);
643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644/*
645 * handle waking up a waiter on the semaphore
646 * - up_read/up_write has decremented the active part of count if we come here
647 */
Andi Kleen3ebae4f2014-02-08 08:52:05 +0100648__visible
Thomas Gleixnerd1233752011-01-26 21:32:01 +0100649struct rw_semaphore *rwsem_wake(struct rw_semaphore *sem)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650{
651 unsigned long flags;
Waiman Long194a6b52016-11-17 11:46:38 -0500652 DEFINE_WAKE_Q(wake_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Waiman Long59aabfc2015-04-30 17:12:16 -0400654 /*
Prateek Sood9c29c3182017-09-07 20:00:58 +0530655 * __rwsem_down_write_failed_common(sem)
656 * rwsem_optimistic_spin(sem)
657 * osq_unlock(sem->osq)
658 * ...
659 * atomic_long_add_return(&sem->count)
660 *
661 * - VS -
662 *
663 * __up_write()
664 * if (atomic_long_sub_return_release(&sem->count) < 0)
665 * rwsem_wake(sem)
666 * osq_is_locked(&sem->osq)
667 *
668 * And __up_write() must observe !osq_is_locked() when it observes the
669 * atomic_long_add_return() in order to not miss a wakeup.
670 *
671 * This boils down to:
672 *
673 * [S.rel] X = 1 [RmW] r0 = (Y += 0)
674 * MB RMB
675 * [RmW] Y += 1 [L] r1 = X
676 *
677 * exists (r0=1 /\ r1=0)
678 */
679 smp_rmb();
680
681 /*
Waiman Long59aabfc2015-04-30 17:12:16 -0400682 * If a spinner is present, it is not necessary to do the wakeup.
683 * Try to do wakeup only if the trylock succeeds to minimize
684 * spinlock contention which may introduce too much delay in the
685 * unlock operation.
686 *
687 * spinning writer up_write/up_read caller
688 * --------------- -----------------------
689 * [S] osq_unlock() [L] osq
690 * MB RMB
691 * [RmW] rwsem_try_write_lock() [RmW] spin_trylock(wait_lock)
692 *
693 * Here, it is important to make sure that there won't be a missed
694 * wakeup while the rwsem is free and the only spinning writer goes
695 * to sleep without taking the rwsem. Even when the spinning writer
696 * is just going to break out of the waiting loop, it will still do
697 * a trylock in rwsem_down_write_failed() before sleeping. IOW, if
698 * rwsem_has_spinner() is true, it will guarantee at least one
699 * trylock attempt on the rwsem later on.
700 */
701 if (rwsem_has_spinner(sem)) {
702 /*
703 * The smp_rmb() here is to make sure that the spinner
704 * state is consulted before reading the wait_lock.
705 */
706 smp_rmb();
707 if (!raw_spin_trylock_irqsave(&sem->wait_lock, flags))
708 return sem;
709 goto locked;
710 }
Thomas Gleixnerddb6c9b2010-02-24 09:54:54 +0100711 raw_spin_lock_irqsave(&sem->wait_lock, flags);
Waiman Long59aabfc2015-04-30 17:12:16 -0400712locked:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 if (!list_empty(&sem->wait_list))
Davidlohr Bueso84b23f92016-08-05 01:04:43 -0700715 __rwsem_mark_wake(sem, RWSEM_WAKE_ANY, &wake_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
Thomas Gleixnerddb6c9b2010-02-24 09:54:54 +0100717 raw_spin_unlock_irqrestore(&sem->wait_lock, flags);
Davidlohr Bueso133e89e2016-05-13 11:56:26 -0700718 wake_up_q(&wake_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 return sem;
721}
Davidlohr Buesodb0e716a2014-09-11 22:34:25 -0700722EXPORT_SYMBOL(rwsem_wake);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
724/*
725 * downgrade a write lock into a read lock
726 * - caller incremented waiting part of count and discovered it still negative
727 * - just wake up any readers at the front of the queue
728 */
Andi Kleen3ebae4f2014-02-08 08:52:05 +0100729__visible
Thomas Gleixnerd1233752011-01-26 21:32:01 +0100730struct rw_semaphore *rwsem_downgrade_wake(struct rw_semaphore *sem)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731{
732 unsigned long flags;
Waiman Long194a6b52016-11-17 11:46:38 -0500733 DEFINE_WAKE_Q(wake_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734
Thomas Gleixnerddb6c9b2010-02-24 09:54:54 +0100735 raw_spin_lock_irqsave(&sem->wait_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 if (!list_empty(&sem->wait_list))
Davidlohr Bueso84b23f92016-08-05 01:04:43 -0700738 __rwsem_mark_wake(sem, RWSEM_WAKE_READ_OWNED, &wake_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Thomas Gleixnerddb6c9b2010-02-24 09:54:54 +0100740 raw_spin_unlock_irqrestore(&sem->wait_lock, flags);
Davidlohr Bueso133e89e2016-05-13 11:56:26 -0700741 wake_up_q(&wake_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 return sem;
744}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745EXPORT_SYMBOL(rwsem_downgrade_wake);