blob: a883b8f1fdc6efbadcab3ca130120cd28130e518 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Waiman Long19c5d692016-05-17 21:26:19 -04002/*
3 * The owner field of the rw_semaphore structure will be set to
4 * RWSEM_READ_OWNED when a reader grabs the lock. A writer will clear
5 * the owner field when it unlocks. A reader, on the other hand, will
6 * not touch the owner field when it unlocks.
7 *
8 * In essence, the owner field now has the following 3 states:
9 * 1) 0
10 * - lock is free or the owner hasn't set the field yet
11 * 2) RWSEM_READER_OWNED
12 * - lock is currently or previously owned by readers (lock is free
13 * or not set by owner yet)
14 * 3) Other non-zero value
15 * - a writer owns the lock
16 */
17#define RWSEM_READER_OWNED ((struct task_struct *)1UL)
18
Davidlohr Bueso7a215f82015-01-30 01:14:25 -080019#ifdef CONFIG_RWSEM_SPIN_ON_OWNER
Waiman Longfb6a44f2016-05-17 21:26:20 -040020/*
21 * All writes to owner are protected by WRITE_ONCE() to make sure that
22 * store tearing can't happen as optimistic spinners may read and use
23 * the owner value concurrently without lock. Read from owner, however,
24 * may not need READ_ONCE() as long as the pointer value is only used
25 * for comparison and isn't being dereferenced.
26 */
Davidlohr Bueso7a215f82015-01-30 01:14:25 -080027static inline void rwsem_set_owner(struct rw_semaphore *sem)
28{
Waiman Longfb6a44f2016-05-17 21:26:20 -040029 WRITE_ONCE(sem->owner, current);
Davidlohr Bueso7a215f82015-01-30 01:14:25 -080030}
31
32static inline void rwsem_clear_owner(struct rw_semaphore *sem)
33{
Waiman Longfb6a44f2016-05-17 21:26:20 -040034 WRITE_ONCE(sem->owner, NULL);
Davidlohr Bueso7a215f82015-01-30 01:14:25 -080035}
36
Waiman Long19c5d692016-05-17 21:26:19 -040037static inline void rwsem_set_reader_owned(struct rw_semaphore *sem)
38{
39 /*
40 * We check the owner value first to make sure that we will only
41 * do a write to the rwsem cacheline when it is really necessary
42 * to minimize cacheline contention.
43 */
44 if (sem->owner != RWSEM_READER_OWNED)
Waiman Longfb6a44f2016-05-17 21:26:20 -040045 WRITE_ONCE(sem->owner, RWSEM_READER_OWNED);
Waiman Long19c5d692016-05-17 21:26:19 -040046}
47
48static inline bool rwsem_owner_is_writer(struct task_struct *owner)
49{
50 return owner && owner != RWSEM_READER_OWNED;
51}
52
53static inline bool rwsem_owner_is_reader(struct task_struct *owner)
54{
55 return owner == RWSEM_READER_OWNED;
56}
Davidlohr Bueso7a215f82015-01-30 01:14:25 -080057#else
58static inline void rwsem_set_owner(struct rw_semaphore *sem)
59{
60}
61
62static inline void rwsem_clear_owner(struct rw_semaphore *sem)
63{
64}
Waiman Long19c5d692016-05-17 21:26:19 -040065
66static inline void rwsem_set_reader_owned(struct rw_semaphore *sem)
67{
68}
Davidlohr Bueso7a215f82015-01-30 01:14:25 -080069#endif