include/linux/rwsem.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* rwsem.h: R/W semaphores, public interface
   3  *
   4  * Written by David Howells (dhowells@redhat.com).
   5  * Derived from asm-i386/semaphore.h
   6  */
   7
   8 #ifndef _LINUX_RWSEM_H
   9 #define _LINUX_RWSEM_H
  10
  11 #include <linux/linkage.h>
  12
  13 #include <linux/types.h>
  14 #include <linux/kernel.h>
  15 #include <linux/list.h>
  16 #include <linux/spinlock.h>
  17 #include <linux/atomic.h>
  18 #include <linux/err.h>
  19 #ifdef CONFIG_RWSEM_SPIN_ON_OWNER
  20 #include <linux/osq_lock.h>
  21 #endif
  22
  23 /*
  24  * For an uncontended rwsem, count and owner are the only fields a task
  25  * needs to touch when acquiring the rwsem. So they are put next to each
  26  * other to increase the chance that they will share the same cacheline.
  27  *
  28  * In a contended rwsem, the owner is likely the most frequently accessed
  29  * field in the structure as the optimistic waiter that holds the osq lock
  30  * will spin on owner. For an embedded rwsem, other hot fields in the
  31  * containing structure should be moved further away from the rwsem to
  32  * reduce the chance that they will share the same cacheline causing
  33  * cacheline bouncing problem.
  34  */
  35 struct rw_semaphore {
  36         atomic_long_t count;
  37         /*
  38          * Write owner or one of the read owners as well flags regarding
  39          * the current state of the rwsem. Can be used as a speculative
  40          * check to see if the write owner is running on the cpu.
  41          */
  42         atomic_long_t owner;
  43 #ifdef CONFIG_RWSEM_SPIN_ON_OWNER
  44         struct optimistic_spin_queue osq; /* spinner MCS lock */
  45 #endif
  46         raw_spinlock_t wait_lock;
  47         struct list_head wait_list;
  48 #ifdef CONFIG_DEBUG_RWSEMS
  49         void *magic;
  50 #endif
  51 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  52         struct lockdep_map      dep_map;
  53 #endif
  54 };
  55
  56 /* In all implementations count != 0 means locked */
  57 static inline int rwsem_is_locked(struct rw_semaphore *sem)
  58 {
  59         return atomic_long_read(&sem->count) != 0;
  60 }
  61
  62 #define RWSEM_UNLOCKED_VALUE            0L
  63 #define __RWSEM_INIT_COUNT(name)        .count = ATOMIC_LONG_INIT(RWSEM_UNLOCKED_VALUE)
  64
  65 /* Common initializer macros and functions */
  66
  67 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  68 # define __RWSEM_DEP_MAP_INIT(lockname) , .dep_map = { .name = #lockname }
  69 #else
  70 # define __RWSEM_DEP_MAP_INIT(lockname)
  71 #endif
  72
  73 #ifdef CONFIG_DEBUG_RWSEMS
  74 # define __DEBUG_RWSEM_INITIALIZER(lockname) , .magic = &lockname
  75 #else
  76 # define __DEBUG_RWSEM_INITIALIZER(lockname)
  77 #endif
  78
  79 #ifdef CONFIG_RWSEM_SPIN_ON_OWNER
  80 #define __RWSEM_OPT_INIT(lockname) , .osq = OSQ_LOCK_UNLOCKED
  81 #else
  82 #define __RWSEM_OPT_INIT(lockname)
  83 #endif
  84
  85 #define __RWSEM_INITIALIZER(name)                               \
  86         { __RWSEM_INIT_COUNT(name),                             \
  87           .owner = ATOMIC_LONG_INIT(0),                         \
  88           .wait_list = LIST_HEAD_INIT((name).wait_list),        \
  89           .wait_lock = __RAW_SPIN_LOCK_UNLOCKED(name.wait_lock) \
  90           __RWSEM_OPT_INIT(name)                                \
  91           __DEBUG_RWSEM_INITIALIZER(name)                       \
  92           __RWSEM_DEP_MAP_INIT(name) }
  93
  94 #define DECLARE_RWSEM(name) \
  95         struct rw_semaphore name = __RWSEM_INITIALIZER(name)
  96
  97 extern void __init_rwsem(struct rw_semaphore *sem, const char *name,
  98                          struct lock_class_key *key);
  99
 100 #define init_rwsem(sem)                                         \
 101 do {                                                            \
 102         static struct lock_class_key __key;                     \
 103                                                                 \
 104         __init_rwsem((sem), #sem, &__key);                      \
 105 } while (0)
 106
 107 /*
 108  * This is the same regardless of which rwsem implementation that is being used.
 109  * It is just a heuristic meant to be called by somebody alreadying holding the
 110  * rwsem to see if somebody from an incompatible type is wanting access to the
 111  * lock.
 112  */
 113 static inline int rwsem_is_contended(struct rw_semaphore *sem)
 114 {
 115         return !list_empty(&sem->wait_list);
 116 }
 117
 118 /*
 119  * lock for reading
 120  */
 121 extern void down_read(struct rw_semaphore *sem);
 122 extern int __must_check down_read_killable(struct rw_semaphore *sem);
 123
 124 /*
 125  * trylock for reading -- returns 1 if successful, 0 if contention
 126  */
 127 extern int down_read_trylock(struct rw_semaphore *sem);
 128
 129 /*
 130  * lock for writing
 131  */
 132 extern void down_write(struct rw_semaphore *sem);
 133 extern int __must_check down_write_killable(struct rw_semaphore *sem);
 134
 135 /*
 136  * trylock for writing -- returns 1 if successful, 0 if contention
 137  */
 138 extern int down_write_trylock(struct rw_semaphore *sem);
 139
 140 /*
 141  * release a read lock
 142  */
 143 extern void up_read(struct rw_semaphore *sem);
 144
 145 /*
 146  * release a write lock
 147  */
 148 extern void up_write(struct rw_semaphore *sem);
 149
 150 /*
 151  * downgrade write lock to read lock
 152  */
 153 extern void downgrade_write(struct rw_semaphore *sem);
 154
 155 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 156 /*
 157  * nested locking. NOTE: rwsems are not allowed to recurse
 158  * (which occurs if the same task tries to acquire the same
 159  * lock instance multiple times), but multiple locks of the
 160  * same lock class might be taken, if the order of the locks
 161  * is always the same. This ordering rule can be expressed
 162  * to lockdep via the _nested() APIs, but enumerating the
 163  * subclasses that are used. (If the nesting relationship is
 164  * static then another method for expressing nested locking is
 165  * the explicit definition of lock class keys and the use of
 166  * lockdep_set_class() at lock initialization time.
 167  * See Documentation/locking/lockdep-design.rst for more details.)
 168  */
 169 extern void down_read_nested(struct rw_semaphore *sem, int subclass);
 170 extern void down_write_nested(struct rw_semaphore *sem, int subclass);
 171 extern int down_write_killable_nested(struct rw_semaphore *sem, int subclass);
 172 extern void _down_write_nest_lock(struct rw_semaphore *sem, struct lockdep_map *nest_lock);
 173
 174 # define down_write_nest_lock(sem, nest_lock)                   \
 175 do {                                                            \
 176         typecheck(struct lockdep_map *, &(nest_lock)->dep_map); \
 177         _down_write_nest_lock(sem, &(nest_lock)->dep_map);      \
 178 } while (0);
 179
 180 /*
 181  * Take/release a lock when not the owner will release it.
 182  *
 183  * [ This API should be avoided as much as possible - the
 184  *   proper abstraction for this case is completions. ]
 185  */
 186 extern void down_read_non_owner(struct rw_semaphore *sem);
 187 extern void up_read_non_owner(struct rw_semaphore *sem);
 188 #else
 189 # define down_read_nested(sem, subclass)                down_read(sem)
 190 # define down_write_nest_lock(sem, nest_lock)   down_write(sem)
 191 # define down_write_nested(sem, subclass)       down_write(sem)
 192 # define down_write_killable_nested(sem, subclass)      down_write_killable(sem)
 193 # define down_read_non_owner(sem)               down_read(sem)
 194 # define up_read_non_owner(sem)                 up_read(sem)
 195 #endif
 196
 197 #endif /* _LINUX_RWSEM_H */