sys/sys/sx.h

   1 /*-
   2  * Copyright (c) 2007 Attilio Rao <attilio@freebsd.org>
   3  * Copyright (c) 2001 Jason Evans <jasone@freebsd.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice(s), this list of conditions and the following disclaimer as
  11  *    the first lines of this file unmodified other than the possible
  12  *    addition of one or more copyright notices.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice(s), this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  23  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  24  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  27  * DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _SYS_SX_H_
  33 #define _SYS_SX_H_
  34
  35 #include <sys/_lock.h>
  36 #include <sys/_sx.h>
  37
  38 #ifdef  _KERNEL
  39 #include <sys/pcpu.h>
  40 #include <sys/lock_profile.h>
  41 #include <machine/atomic.h>
  42 #endif
  43
  44 /*
  45  * In general, the sx locks and rwlocks use very similar algorithms.
  46  * The main difference in the implementations is how threads are
  47  * blocked when a lock is unavailable.  For this, sx locks use sleep
  48  * queues which do not support priority propagation, and rwlocks use
  49  * turnstiles which do.
  50  *
  51  * The sx_lock field consists of several fields.  The low bit
  52  * indicates if the lock is locked with a shared or exclusive lock.  A
  53  * value of 0 indicates an exclusive lock, and a value of 1 indicates
  54  * a shared lock.  Bit 1 is a boolean indicating if there are any
  55  * threads waiting for a shared lock.  Bit 2 is a boolean indicating
  56  * if there are any threads waiting for an exclusive lock.  Bit 3 is a
  57  * boolean indicating if an exclusive lock is recursively held.  The
  58  * rest of the variable's definition is dependent on the value of the
  59  * first bit.  For an exclusive lock, it is a pointer to the thread
  60  * holding the lock, similar to the mtx_lock field of mutexes.  For
  61  * shared locks, it is a count of read locks that are held.
  62  *
  63  * When the lock is not locked by any thread, it is encoded as a
  64  * shared lock with zero waiters.
  65  *
  66  * A note about memory barriers.  Exclusive locks need to use the same
  67  * memory barriers as mutexes: _acq when acquiring an exclusive lock
  68  * and _rel when releasing an exclusive lock.  On the other side,
  69  * shared lock needs to use an _acq barrier when acquiring the lock
  70  * but, since they don't update any locked data, no memory barrier is
  71  * needed when releasing a shared lock.
  72  */
  73
  74 #define SX_LOCK_SHARED                  0x01
  75 #define SX_LOCK_SHARED_WAITERS          0x02
  76 #define SX_LOCK_EXCLUSIVE_WAITERS       0x04
  77 #define SX_LOCK_RECURSED                0x08
  78 #define SX_LOCK_FLAGMASK                                                \
  79         (SX_LOCK_SHARED | SX_LOCK_SHARED_WAITERS |                      \
  80         SX_LOCK_EXCLUSIVE_WAITERS | SX_LOCK_RECURSED)
  81
  82 #define SX_OWNER(x)                     ((x) & ~SX_LOCK_FLAGMASK)
  83 #define SX_SHARERS_SHIFT                4
  84 #define SX_SHARERS(x)                   (SX_OWNER(x) >> SX_SHARERS_SHIFT)
  85 #define SX_SHARERS_LOCK(x)                                              \
  86         ((x) << SX_SHARERS_SHIFT | SX_LOCK_SHARED)
  87 #define SX_ONE_SHARER                   (1 << SX_SHARERS_SHIFT)
  88
  89 #define SX_LOCK_UNLOCKED                SX_SHARERS_LOCK(0)
  90 #define SX_LOCK_DESTROYED                                               \
  91         (SX_LOCK_SHARED_WAITERS | SX_LOCK_EXCLUSIVE_WAITERS)
  92
  93 #ifdef _KERNEL
  94
  95 /*
  96  * Function prototipes.  Routines that start with an underscore are not part
  97  * of the public interface and are wrappered with a macro.
  98  */
  99 void    sx_sysinit(void *arg);
 100 #define sx_init(sx, desc)       sx_init_flags((sx), (desc), 0)
 101 void    sx_init_flags(struct sx *sx, const char *description, int opts);
 102 void    sx_destroy(struct sx *sx);
 103 int     _sx_slock(struct sx *sx, int opts, const char *file, int line);
 104 int     _sx_xlock(struct sx *sx, int opts, const char *file, int line);
 105 int     _sx_try_slock(struct sx *sx, const char *file, int line);
 106 int     _sx_try_xlock(struct sx *sx, const char *file, int line);
 107 void    _sx_sunlock(struct sx *sx, const char *file, int line);
 108 void    _sx_xunlock(struct sx *sx, const char *file, int line);
 109 int     _sx_try_upgrade(struct sx *sx, const char *file, int line);
 110 void    _sx_downgrade(struct sx *sx, const char *file, int line);
 111 int     _sx_xlock_hard(struct sx *sx, uintptr_t tid, int opts,
 112             const char *file, int line);
 113 int     _sx_slock_hard(struct sx *sx, int opts, const char *file, int line);
 114 void    _sx_xunlock_hard(struct sx *sx, uintptr_t tid, const char *file, int
 115             line);
 116 void    _sx_sunlock_hard(struct sx *sx, const char *file, int line);
 117 #if defined(INVARIANTS) || defined(INVARIANT_SUPPORT)
 118 void    _sx_assert(struct sx *sx, int what, const char *file, int line);
 119 #endif
 120 #ifdef DDB
 121 int     sx_chain(struct thread *td, struct thread **ownerp);
 122 #endif
 123
 124 struct sx_args {
 125         struct sx       *sa_sx;
 126         const char      *sa_desc;
 127 };
 128
 129 #define SX_SYSINIT(name, sxa, desc)                                     \
 130         static struct sx_args name##_args = {                           \
 131                 (sxa),                                                  \
 132                 (desc)                                                  \
 133         };                                                              \
 134         SYSINIT(name##_sx_sysinit, SI_SUB_LOCK, SI_ORDER_MIDDLE,        \
 135             sx_sysinit, &name##_args);                                  \
 136         SYSUNINIT(name##_sx_sysuninit, SI_SUB_LOCK, SI_ORDER_MIDDLE,    \
 137             sx_destroy, (sxa))
 138
 139 /*
 140  * Full lock operations that are suitable to be inlined in non-debug kernels.
 141  * If the lock can't be acquired or released trivially then the work is
 142  * deferred to 'tougher' functions.
 143  */
 144
 145 /* Acquire an exclusive lock. */
 146 static __inline int
 147 __sx_xlock(struct sx *sx, struct thread *td, int opts, const char *file,
 148     int line)
 149 {
 150         uintptr_t tid = (uintptr_t)td;
 151         int error = 0;
 152
 153         if (!atomic_cmpset_acq_ptr(&sx->sx_lock, SX_LOCK_UNLOCKED, tid))
 154                 error = _sx_xlock_hard(sx, tid, opts, file, line);
 155         else
 156                 lock_profile_obtain_lock_success(&sx->lock_object, 0, 0, file,
 157                     line);
 158
 159         return (error);
 160 }
 161
 162 /* Release an exclusive lock. */
 163 static __inline void
 164 __sx_xunlock(struct sx *sx, struct thread *td, const char *file, int line)
 165 {
 166         uintptr_t tid = (uintptr_t)td;
 167
 168         if (!atomic_cmpset_rel_ptr(&sx->sx_lock, tid, SX_LOCK_UNLOCKED))
 169                 _sx_xunlock_hard(sx, tid, file, line);
 170 }
 171
 172 /* Acquire a shared lock. */
 173 static __inline int
 174 __sx_slock(struct sx *sx, int opts, const char *file, int line)
 175 {
 176         uintptr_t x = sx->sx_lock;
 177         int error = 0;
 178
 179         if (!(x & SX_LOCK_SHARED) ||
 180             !atomic_cmpset_acq_ptr(&sx->sx_lock, x, x + SX_ONE_SHARER))
 181                 error = _sx_slock_hard(sx, opts, file, line);
 182         else
 183                 lock_profile_obtain_lock_success(&sx->lock_object, 0, 0, file,
 184                     line);
 185
 186         return (error);
 187 }
 188
 189 /*
 190  * Release a shared lock.  We can just drop a single shared lock so
 191  * long as we aren't trying to drop the last shared lock when other
 192  * threads are waiting for an exclusive lock.  This takes advantage of
 193  * the fact that an unlocked lock is encoded as a shared lock with a
 194  * count of 0.
 195  */
 196 static __inline void
 197 __sx_sunlock(struct sx *sx, const char *file, int line)
 198 {
 199         uintptr_t x = sx->sx_lock;
 200
 201         if (x == (SX_SHARERS_LOCK(1) | SX_LOCK_EXCLUSIVE_WAITERS) ||
 202             !atomic_cmpset_ptr(&sx->sx_lock, x, x - SX_ONE_SHARER))
 203                 _sx_sunlock_hard(sx, file, line);
 204 }
 205
 206 /*
 207  * Public interface for lock operations.
 208  */
 209 #ifndef LOCK_DEBUG
 210 #error  "LOCK_DEBUG not defined, include <sys/lock.h> before <sys/sx.h>"
 211 #endif
 212 #if     (LOCK_DEBUG > 0) || defined(SX_NOINLINE)
 213 #define sx_xlock(sx)            (void)_sx_xlock((sx), 0, LOCK_FILE, LOCK_LINE)
 214 #define sx_xlock_sig(sx)                                                \
 215         _sx_xlock((sx), SX_INTERRUPTIBLE, LOCK_FILE, LOCK_LINE)
 216 #define sx_xunlock(sx)          _sx_xunlock((sx), LOCK_FILE, LOCK_LINE)
 217 #define sx_slock(sx)            (void)_sx_slock((sx), 0, LOCK_FILE, LOCK_LINE)
 218 #define sx_slock_sig(sx)                                                \
 219         _sx_slock((sx), SX_INTERRUPTIBLE, LOCK_FILE, LOCK_LINE)
 220 #define sx_sunlock(sx)          _sx_sunlock((sx), LOCK_FILE, LOCK_LINE)
 221 #else
 222 #define sx_xlock(sx)                                                    \
 223         (void)__sx_xlock((sx), curthread, 0, LOCK_FILE, LOCK_LINE)
 224 #define sx_xlock_sig(sx)                                                \
 225         __sx_xlock((sx), curthread, SX_INTERRUPTIBLE, LOCK_FILE, LOCK_LINE)
 226 #define sx_xunlock(sx)                                                  \
 227         __sx_xunlock((sx), curthread, LOCK_FILE, LOCK_LINE)
 228 #define sx_slock(sx)            (void)__sx_slock((sx), 0, LOCK_FILE, LOCK_LINE)
 229 #define sx_slock_sig(sx)                                                \
 230         __sx_slock((sx), SX_INTERRUPTIBLE, LOCK_FILE, LOCK_LINE)
 231 #define sx_sunlock(sx)          __sx_sunlock((sx), LOCK_FILE, LOCK_LINE)
 232 #endif  /* LOCK_DEBUG > 0 || SX_NOINLINE */
 233 #define sx_try_slock(sx)        _sx_try_slock((sx), LOCK_FILE, LOCK_LINE)
 234 #define sx_try_xlock(sx)        _sx_try_xlock((sx), LOCK_FILE, LOCK_LINE)
 235 #define sx_try_upgrade(sx)      _sx_try_upgrade((sx), LOCK_FILE, LOCK_LINE)
 236 #define sx_downgrade(sx)        _sx_downgrade((sx), LOCK_FILE, LOCK_LINE)
 237
 238 /*
 239  * Return a pointer to the owning thread if the lock is exclusively
 240  * locked.
 241  */
 242 #define sx_xholder(sx)                                                  \
 243         ((sx)->sx_lock & SX_LOCK_SHARED ? NULL :                        \
 244         (struct thread *)SX_OWNER((sx)->sx_lock))
 245
 246 #define sx_xlocked(sx)                                                  \
 247         (((sx)->sx_lock & ~(SX_LOCK_FLAGMASK & ~SX_LOCK_SHARED)) ==     \
 248             (uintptr_t)curthread)
 249
 250 #define sx_unlock(sx) do {                                              \
 251         if (sx_xlocked(sx))                                             \
 252                 sx_xunlock(sx);                                         \
 253         else                                                            \
 254                 sx_sunlock(sx);                                         \
 255 } while (0)
 256
 257 #define sx_sleep(chan, sx, pri, wmesg, timo)                            \
 258         _sleep((chan), &(sx)->lock_object, (pri), (wmesg), (timo))
 259
 260 /*
 261  * Options passed to sx_init_flags().
 262  */
 263 #define SX_DUPOK                0x01
 264 #define SX_NOPROFILE            0x02
 265 #define SX_NOWITNESS            0x04
 266 #define SX_QUIET                0x08
 267 #define SX_ADAPTIVESPIN         0x10
 268 #define SX_RECURSE              0x20
 269
 270 /*
 271  * Options passed to sx_*lock_hard().
 272  */
 273 #define SX_INTERRUPTIBLE        0x40
 274
 275 #if defined(INVARIANTS) || defined(INVARIANT_SUPPORT)
 276 #define SA_LOCKED               LA_LOCKED
 277 #define SA_SLOCKED              LA_SLOCKED
 278 #define SA_XLOCKED              LA_XLOCKED
 279 #define SA_UNLOCKED             LA_UNLOCKED
 280 #define SA_RECURSED             LA_RECURSED
 281 #define SA_NOTRECURSED          LA_NOTRECURSED
 282
 283 /* Backwards compatability. */
 284 #define SX_LOCKED               LA_LOCKED
 285 #define SX_SLOCKED              LA_SLOCKED
 286 #define SX_XLOCKED              LA_XLOCKED
 287 #define SX_UNLOCKED             LA_UNLOCKED
 288 #define SX_RECURSED             LA_RECURSED
 289 #define SX_NOTRECURSED          LA_NOTRECURSED
 290 #endif
 291
 292 #ifdef INVARIANTS
 293 #define sx_assert(sx, what)     _sx_assert((sx), (what), LOCK_FILE, LOCK_LINE)
 294 #else
 295 #define sx_assert(sx, what)
 296 #endif
 297
 298 #endif /* _KERNEL */
 299
 300 #endif /* !_SYS_SX_H_ */