1 // SPDX-License-Identifier: GPL-2.0
2 /* rwsem.c: R/W semaphores: contention handling functions
4 * Written by David Howells (dhowells@redhat.com).
5 * Derived from arch/i386/kernel/semaphore.c
7 * Writer lock-stealing by Alex Shi <alex.shi@intel.com>
8 * and Michel Lespinasse <walken@google.com>
10 * Optimistic spinning by Tim Chen <tim.c.chen@intel.com>
11 * and Davidlohr Bueso <davidlohr@hp.com>. Based on mutexes.
13 #include <linux/rwsem.h>
14 #include <linux/init.h>
15 #include <linux/export.h>
16 #include <linux/sched/signal.h>
17 #include <linux/sched/rt.h>
18 #include <linux/sched/wake_q.h>
19 #include <linux/sched/debug.h>
20 #include <linux/osq_lock.h>
25 * Guide to the rw_semaphore's count field for common values.
26 * (32-bit case illustrated, similar for 64-bit)
28 * 0x0000000X (1) X readers active or attempting lock, no writer waiting
29 * X = #active_readers + #readers attempting to lock
32 * 0x00000000 rwsem is unlocked, and no one is waiting for the lock or
33 * attempting to read lock or write lock.
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)
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
50 * 0xffff0000 (1) There are writers or readers queued but none active
51 * or in the process of attempting lock.
53 * Note: writer can attempt to steal lock for this count by adding
54 * ACTIVE_WRITE_BIAS in cmpxchg and checking the old count
56 * 0xfffe0001 (1) 1 writer active, or attempting lock. Waiters on queue.
57 * (ACTIVE_WRITE_BIAS + WAITING_BIAS)
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).
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
74 * Initialize an rwsem:
76 void __init_rwsem(struct rw_semaphore *sem, const char *name,
77 struct lock_class_key *key)
79 #ifdef CONFIG_DEBUG_LOCK_ALLOC
81 * Make sure we are not reinitializing a held semaphore:
83 debug_check_no_locks_freed((void *)sem, sizeof(*sem));
84 lockdep_init_map(&sem->dep_map, name, key, 0);
86 atomic_long_set(&sem->count, RWSEM_UNLOCKED_VALUE);
87 raw_spin_lock_init(&sem->wait_lock);
88 INIT_LIST_HEAD(&sem->wait_list);
90 #ifdef CONFIG_RWSEM_SPIN_ON_OWNER
91 osq_lock_init(&sem->osq);
95 EXPORT_SYMBOL(__init_rwsem);
97 enum rwsem_waiter_type {
98 RWSEM_WAITING_FOR_WRITE,
99 RWSEM_WAITING_FOR_READ
102 struct rwsem_waiter {
103 struct list_head list;
104 struct task_struct *task;
105 enum rwsem_waiter_type type;
108 enum 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 */
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)
119 * - there must be someone on the queue
120 * - 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
124 * - woken process blocks are discarded from the list after having task zeroed
125 * - writers are only marked woken if downgrading is false
127 static void __rwsem_mark_wake(struct rw_semaphore *sem,
128 enum rwsem_wake_type wake_type,
129 struct wake_q_head *wake_q)
131 struct rwsem_waiter *waiter, *tmp;
132 long oldcount, woken = 0, adjustment = 0;
133 struct list_head wlist;
136 * Take a peek at the queue head waiter such that we can determine
137 * the wakeup(s) to perform.
139 waiter = list_first_entry(&sem->wait_list, struct rwsem_waiter, list);
141 if (waiter->type == RWSEM_WAITING_FOR_WRITE) {
142 if (wake_type == RWSEM_WAKE_ANY) {
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.
150 wake_q_add(wake_q, waiter->task);
151 lockevent_inc(rwsem_wake_writer);
158 * Writers might steal the lock before we grant it to the next reader.
159 * We prefer to do the first reader grant before counting readers
160 * so we can bail out early if a writer stole the lock.
162 if (wake_type != RWSEM_WAKE_READ_OWNED) {
163 adjustment = RWSEM_ACTIVE_READ_BIAS;
165 oldcount = atomic_long_fetch_add(adjustment, &sem->count);
166 if (unlikely(oldcount < RWSEM_WAITING_BIAS)) {
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
173 if (atomic_long_add_return(-adjustment, &sem->count) <
177 /* Last active locker left. Retry waking readers. */
178 goto try_reader_grant;
181 * Set it to reader-owned to give spinners an early
182 * indication that readers now have the lock.
184 __rwsem_set_reader_owned(sem, waiter->task);
188 * Grant an infinite number of read locks to the readers at the front
189 * 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.
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.
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.
204 list_for_each_entry(waiter, &sem->wait_list, list) {
205 if (waiter->type == RWSEM_WAITING_FOR_WRITE)
210 list_cut_before(&wlist, &sem->wait_list, &waiter->list);
212 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;
220 atomic_long_add(adjustment, &sem->count);
223 list_for_each_entry_safe(waiter, tmp, &wlist, list) {
224 struct task_struct *tsk;
227 get_task_struct(tsk);
230 * Ensure calling get_task_struct() before setting the reader
231 * 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.
235 smp_store_release(&waiter->task, NULL);
237 * Ensure issuing the wakeup (either by us or someone else)
238 * after setting the reader waiter to nil.
240 wake_q_add_safe(wake_q, tsk);
245 * 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.
249 static inline bool rwsem_try_write_lock(long count, struct rw_semaphore *sem)
252 * Avoid trying to acquire write lock if count isn't RWSEM_WAITING_BIAS.
254 if (count != RWSEM_WAITING_BIAS)
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.
261 count = list_is_singular(&sem->wait_list) ?
262 RWSEM_ACTIVE_WRITE_BIAS :
263 RWSEM_ACTIVE_WRITE_BIAS + RWSEM_WAITING_BIAS;
265 if (atomic_long_cmpxchg_acquire(&sem->count, RWSEM_WAITING_BIAS, count)
266 == RWSEM_WAITING_BIAS) {
267 rwsem_set_owner(sem);
274 #ifdef CONFIG_RWSEM_SPIN_ON_OWNER
276 * Try to acquire write lock before the writer has been put on wait queue.
278 static inline bool rwsem_try_write_lock_unqueued(struct rw_semaphore *sem)
280 long count = atomic_long_read(&sem->count);
282 while (!count || count == RWSEM_WAITING_BIAS) {
283 if (atomic_long_try_cmpxchg_acquire(&sem->count, &count,
284 count + RWSEM_ACTIVE_WRITE_BIAS)) {
285 rwsem_set_owner(sem);
286 lockevent_inc(rwsem_opt_wlock);
293 static inline bool owner_on_cpu(struct task_struct *owner)
296 * As lock holder preemption issue, we both skip spinning if
297 * task is not on cpu or its cpu is preempted
299 return owner->on_cpu && !vcpu_is_preempted(task_cpu(owner));
302 static inline bool rwsem_can_spin_on_owner(struct rw_semaphore *sem)
304 struct task_struct *owner;
307 BUILD_BUG_ON(!rwsem_has_anonymous_owner(RWSEM_OWNER_UNKNOWN));
313 owner = READ_ONCE(sem->owner);
315 ret = is_rwsem_owner_spinnable(owner) &&
323 * Return true only if we can still spin on the owner field of the rwsem.
325 static noinline bool rwsem_spin_on_owner(struct rw_semaphore *sem)
327 struct task_struct *owner = READ_ONCE(sem->owner);
329 if (!is_rwsem_owner_spinnable(owner))
333 while (owner && (READ_ONCE(sem->owner) == owner)) {
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.
343 * abort spinning when need_resched or owner is not running or
344 * owner's cpu is preempted.
346 if (need_resched() || !owner_on_cpu(owner)) {
356 * If there is a new owner or the owner is not set, we continue
359 return is_rwsem_owner_spinnable(READ_ONCE(sem->owner));
362 static bool rwsem_optimistic_spin(struct rw_semaphore *sem)
368 /* sem->wait_lock should not be held when doing optimistic spinning */
369 if (!rwsem_can_spin_on_owner(sem))
372 if (!osq_lock(&sem->osq))
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.
382 while (rwsem_spin_on_owner(sem)) {
384 * Try to acquire the lock
386 if (rwsem_try_write_lock_unqueued(sem)) {
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.
397 if (!sem->owner && (need_resched() || rt_task(current)))
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.
408 osq_unlock(&sem->osq);
411 lockevent_cond_inc(rwsem_opt_fail, !taken);
415 static bool rwsem_optimistic_spin(struct rw_semaphore *sem)
422 * Wait for the read lock to be granted
424 static inline struct rw_semaphore __sched *
425 __rwsem_down_read_failed_common(struct rw_semaphore *sem, int state)
427 long count, adjustment = -RWSEM_ACTIVE_READ_BIAS;
428 struct rwsem_waiter waiter;
429 DEFINE_WAKE_Q(wake_q);
431 waiter.task = current;
432 waiter.type = RWSEM_WAITING_FOR_READ;
434 raw_spin_lock_irq(&sem->wait_lock);
435 if (list_empty(&sem->wait_list)) {
437 * In case the wait queue is empty and the lock isn't owned
438 * by a writer, this reader can exit the slowpath and return
439 * immediately as its RWSEM_ACTIVE_READ_BIAS has already
440 * been set in the count.
442 if (atomic_long_read(&sem->count) >= 0) {
443 raw_spin_unlock_irq(&sem->wait_lock);
444 rwsem_set_reader_owned(sem);
445 lockevent_inc(rwsem_rlock_fast);
448 adjustment += RWSEM_WAITING_BIAS;
450 list_add_tail(&waiter.list, &sem->wait_list);
452 /* we're now waiting on the lock, but no longer actively locking */
453 count = atomic_long_add_return(adjustment, &sem->count);
456 * If there are no active locks, wake the front queued process(es).
458 * If there are no writers and we are first in the queue,
459 * wake our own waiter to join the existing active readers !
461 if (count == RWSEM_WAITING_BIAS ||
462 (count > RWSEM_WAITING_BIAS &&
463 adjustment != -RWSEM_ACTIVE_READ_BIAS))
464 __rwsem_mark_wake(sem, RWSEM_WAKE_ANY, &wake_q);
466 raw_spin_unlock_irq(&sem->wait_lock);
469 /* wait to be given the lock */
471 set_current_state(state);
474 if (signal_pending_state(state, current)) {
475 raw_spin_lock_irq(&sem->wait_lock);
478 raw_spin_unlock_irq(&sem->wait_lock);
482 lockevent_inc(rwsem_sleep_reader);
485 __set_current_state(TASK_RUNNING);
486 lockevent_inc(rwsem_rlock);
489 list_del(&waiter.list);
490 if (list_empty(&sem->wait_list))
491 atomic_long_add(-RWSEM_WAITING_BIAS, &sem->count);
492 raw_spin_unlock_irq(&sem->wait_lock);
493 __set_current_state(TASK_RUNNING);
494 lockevent_inc(rwsem_rlock_fail);
495 return ERR_PTR(-EINTR);
498 __visible struct rw_semaphore * __sched
499 rwsem_down_read_failed(struct rw_semaphore *sem)
501 return __rwsem_down_read_failed_common(sem, TASK_UNINTERRUPTIBLE);
503 EXPORT_SYMBOL(rwsem_down_read_failed);
505 __visible struct rw_semaphore * __sched
506 rwsem_down_read_failed_killable(struct rw_semaphore *sem)
508 return __rwsem_down_read_failed_common(sem, TASK_KILLABLE);
510 EXPORT_SYMBOL(rwsem_down_read_failed_killable);
513 * Wait until we successfully acquire the write lock
515 static inline struct rw_semaphore *
516 __rwsem_down_write_failed_common(struct rw_semaphore *sem, int state)
519 bool waiting = true; /* any queued threads before us */
520 struct rwsem_waiter waiter;
521 struct rw_semaphore *ret = sem;
522 DEFINE_WAKE_Q(wake_q);
524 /* undo write bias from down_write operation, stop active locking */
525 count = atomic_long_sub_return(RWSEM_ACTIVE_WRITE_BIAS, &sem->count);
527 /* do optimistic spinning and steal lock if possible */
528 if (rwsem_optimistic_spin(sem))
532 * Optimistic spinning failed, proceed to the slowpath
533 * and block until we can acquire the sem.
535 waiter.task = current;
536 waiter.type = RWSEM_WAITING_FOR_WRITE;
538 raw_spin_lock_irq(&sem->wait_lock);
540 /* account for this before adding a new element to the list */
541 if (list_empty(&sem->wait_list))
544 list_add_tail(&waiter.list, &sem->wait_list);
546 /* we're now waiting on the lock, but no longer actively locking */
548 count = atomic_long_read(&sem->count);
551 * If there were already threads queued before us and there are
552 * no active writers, the lock must be read owned; so we try to
553 * wake any read locks that were queued ahead of us.
555 if (count > RWSEM_WAITING_BIAS) {
556 __rwsem_mark_wake(sem, RWSEM_WAKE_READERS, &wake_q);
558 * The wakeup is normally called _after_ the wait_lock
559 * is released, but given that we are proactively waking
560 * readers we can deal with the wake_q overhead as it is
561 * similar to releasing and taking the wait_lock again
562 * for attempting rwsem_try_write_lock().
567 * Reinitialize wake_q after use.
569 wake_q_init(&wake_q);
573 count = atomic_long_add_return(RWSEM_WAITING_BIAS, &sem->count);
575 /* wait until we successfully acquire the lock */
576 set_current_state(state);
578 if (rwsem_try_write_lock(count, sem))
580 raw_spin_unlock_irq(&sem->wait_lock);
582 /* Block until there are no active lockers. */
584 if (signal_pending_state(state, current))
588 lockevent_inc(rwsem_sleep_writer);
589 set_current_state(state);
590 } while ((count = atomic_long_read(&sem->count)) & RWSEM_ACTIVE_MASK);
592 raw_spin_lock_irq(&sem->wait_lock);
594 __set_current_state(TASK_RUNNING);
595 list_del(&waiter.list);
596 raw_spin_unlock_irq(&sem->wait_lock);
597 lockevent_inc(rwsem_wlock);
602 __set_current_state(TASK_RUNNING);
603 raw_spin_lock_irq(&sem->wait_lock);
604 list_del(&waiter.list);
605 if (list_empty(&sem->wait_list))
606 atomic_long_add(-RWSEM_WAITING_BIAS, &sem->count);
608 __rwsem_mark_wake(sem, RWSEM_WAKE_ANY, &wake_q);
609 raw_spin_unlock_irq(&sem->wait_lock);
611 lockevent_inc(rwsem_wlock_fail);
613 return ERR_PTR(-EINTR);
616 __visible struct rw_semaphore * __sched
617 rwsem_down_write_failed(struct rw_semaphore *sem)
619 return __rwsem_down_write_failed_common(sem, TASK_UNINTERRUPTIBLE);
621 EXPORT_SYMBOL(rwsem_down_write_failed);
623 __visible struct rw_semaphore * __sched
624 rwsem_down_write_failed_killable(struct rw_semaphore *sem)
626 return __rwsem_down_write_failed_common(sem, TASK_KILLABLE);
628 EXPORT_SYMBOL(rwsem_down_write_failed_killable);
631 * handle waking up a waiter on the semaphore
632 * - up_read/up_write has decremented the active part of count if we come here
635 struct rw_semaphore *rwsem_wake(struct rw_semaphore *sem)
638 DEFINE_WAKE_Q(wake_q);
640 raw_spin_lock_irqsave(&sem->wait_lock, flags);
642 if (!list_empty(&sem->wait_list))
643 __rwsem_mark_wake(sem, RWSEM_WAKE_ANY, &wake_q);
645 raw_spin_unlock_irqrestore(&sem->wait_lock, flags);
650 EXPORT_SYMBOL(rwsem_wake);
653 * downgrade a write lock into a read lock
654 * - caller incremented waiting part of count and discovered it still negative
655 * - just wake up any readers at the front of the queue
658 struct rw_semaphore *rwsem_downgrade_wake(struct rw_semaphore *sem)
661 DEFINE_WAKE_Q(wake_q);
663 raw_spin_lock_irqsave(&sem->wait_lock, flags);
665 if (!list_empty(&sem->wait_list))
666 __rwsem_mark_wake(sem, RWSEM_WAKE_READ_OWNED, &wake_q);
668 raw_spin_unlock_irqrestore(&sem->wait_lock, flags);
673 EXPORT_SYMBOL(rwsem_downgrade_wake);