sys/sys/mutex.h

   1 /*-
   2  * Copyright (c) 1997 Berkeley Software Design, Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  * 3. Berkeley Software Design Inc's name may not be used to endorse or
  13  *    promote products derived from this software without specific prior
  14  *    written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN INC ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN INC BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  *      from BSDI $Id: mutex.h,v 2.7.2.35 2000/04/27 03:10:26 cp Exp $
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _SYS_MUTEX_H_
  33 #define _SYS_MUTEX_H_
  34
  35 #include <sys/queue.h>
  36 #include <sys/_lock.h>
  37 #include <sys/_mutex.h>
  38
  39 #ifdef _KERNEL
  40 #include <sys/pcpu.h>
  41 #include <sys/lock_profile.h>
  42 #include <sys/lockstat.h>
  43 #include <machine/atomic.h>
  44 #include <machine/cpufunc.h>
  45
  46 /*
  47  * Mutex types and options passed to mtx_init().  MTX_QUIET and MTX_DUPOK
  48  * can also be passed in.
  49  */
  50 #define MTX_DEF         0x00000000      /* DEFAULT (sleep) lock */
  51 #define MTX_SPIN        0x00000001      /* Spin lock (disables interrupts) */
  52 #define MTX_RECURSE     0x00000004      /* Option: lock allowed to recurse */
  53 #define MTX_NOWITNESS   0x00000008      /* Don't do any witness checking. */
  54 #define MTX_NOPROFILE   0x00000020      /* Don't profile this lock */
  55 #define MTX_NEW         0x00000040      /* Don't check for double-init */
  56
  57 /*
  58  * Option flags passed to certain lock/unlock routines, through the use
  59  * of corresponding mtx_{lock,unlock}_flags() interface macros.
  60  */
  61 #define MTX_QUIET       LOP_QUIET       /* Don't log a mutex event */
  62 #define MTX_DUPOK       LOP_DUPOK       /* Don't log a duplicate acquire */
  63
  64 /*
  65  * State bits kept in mutex->mtx_lock, for the DEFAULT lock type. None of this,
  66  * with the exception of MTX_UNOWNED, applies to spin locks.
  67  */
  68 #define MTX_RECURSED    0x00000001      /* lock recursed (for MTX_DEF only) */
  69 #define MTX_CONTESTED   0x00000002      /* lock contested (for MTX_DEF only) */
  70 #define MTX_UNOWNED     0x00000004      /* Cookie for free mutex */
  71 #define MTX_FLAGMASK    (MTX_RECURSED | MTX_CONTESTED | MTX_UNOWNED)
  72
  73 /*
  74  * Value stored in mutex->mtx_lock to denote a destroyed mutex.
  75  */
  76 #define MTX_DESTROYED   (MTX_CONTESTED | MTX_UNOWNED)
  77
  78 /*
  79  * Prototypes
  80  *
  81  * NOTE: Functions prepended with `_' (underscore) are exported to other parts
  82  *       of the kernel via macros, thus allowing us to use the cpp LOCK_FILE
  83  *       and LOCK_LINE or for hiding the lock cookie crunching to the
  84  *       consumers. These functions should not be called directly by any
  85  *       code using the API. Their macros cover their functionality.
  86  *       Functions with a `_' suffix are the entrypoint for the common
  87  *       KPI covering both compat shims and fast path case.  These can be
  88  *       used by consumers willing to pass options, file and line
  89  *       informations, in an option-independent way.
  90  *
  91  * [See below for descriptions]
  92  *
  93  */
  94 void    _mtx_init(volatile uintptr_t *c, const char *name, const char *type,
  95             int opts);
  96 void    _mtx_destroy(volatile uintptr_t *c);
  97 void    mtx_sysinit(void *arg);
  98 int     _mtx_trylock_flags_(volatile uintptr_t *c, int opts, const char *file,
  99             int line);
 100 void    mutex_init(void);
 101 #if LOCK_DEBUG > 0
 102 void    __mtx_lock_sleep(volatile uintptr_t *c, uintptr_t v, uintptr_t tid,
 103             int opts, const char *file, int line);
 104 void    __mtx_unlock_sleep(volatile uintptr_t *c, int opts, const char *file,
 105             int line);
 106 #else
 107 void    __mtx_lock_sleep(volatile uintptr_t *c, uintptr_t v, uintptr_t tid,
 108             int opts);
 109 void    __mtx_unlock_sleep(volatile uintptr_t *c, int opts);
 110 #endif
 111
 112 #ifdef SMP
 113 void    _mtx_lock_spin_cookie(volatile uintptr_t *c, uintptr_t v, uintptr_t tid,
 114             int opts, const char *file, int line);
 115 #endif
 116 void    __mtx_lock_flags(volatile uintptr_t *c, int opts, const char *file,
 117             int line);
 118 void    __mtx_unlock_flags(volatile uintptr_t *c, int opts, const char *file,
 119             int line);
 120 void    __mtx_lock_spin_flags(volatile uintptr_t *c, int opts, const char *file,
 121              int line);
 122 int     __mtx_trylock_spin_flags(volatile uintptr_t *c, int opts,
 123              const char *file, int line);
 124 void    __mtx_unlock_spin_flags(volatile uintptr_t *c, int opts,
 125             const char *file, int line);
 126 #if defined(INVARIANTS) || defined(INVARIANT_SUPPORT)
 127 void    __mtx_assert(const volatile uintptr_t *c, int what, const char *file,
 128             int line);
 129 #endif
 130 void    thread_lock_flags_(struct thread *, int, const char *, int);
 131
 132 #define thread_lock(tdp)                                                \
 133         thread_lock_flags_((tdp), 0, __FILE__, __LINE__)
 134 #define thread_lock_flags(tdp, opt)                                     \
 135         thread_lock_flags_((tdp), (opt), __FILE__, __LINE__)
 136 #define thread_unlock(tdp)                                              \
 137        mtx_unlock_spin((tdp)->td_lock)
 138
 139 /*
 140  * Top-level macros to provide lock cookie once the actual mtx is passed.
 141  * They will also prevent passing a malformed object to the mtx KPI by
 142  * failing compilation as the mtx_lock reserved member will not be found.
 143  */
 144 #define mtx_init(m, n, t, o)                                            \
 145         _mtx_init(&(m)->mtx_lock, n, t, o)
 146 #define mtx_destroy(m)                                                  \
 147         _mtx_destroy(&(m)->mtx_lock)
 148 #define mtx_trylock_flags_(m, o, f, l)                                  \
 149         _mtx_trylock_flags_(&(m)->mtx_lock, o, f, l)
 150 #if LOCK_DEBUG > 0
 151 #define _mtx_lock_sleep(m, v, t, o, f, l)                               \
 152         __mtx_lock_sleep(&(m)->mtx_lock, v, t, o, f, l)
 153 #define _mtx_unlock_sleep(m, o, f, l)                                   \
 154         __mtx_unlock_sleep(&(m)->mtx_lock, o, f, l)
 155 #else
 156 #define _mtx_lock_sleep(m, v, t, o, f, l)                               \
 157         __mtx_lock_sleep(&(m)->mtx_lock, v, t, o)
 158 #define _mtx_unlock_sleep(m, o, f, l)                                   \
 159         __mtx_unlock_sleep(&(m)->mtx_lock, o)
 160 #endif
 161 #ifdef SMP
 162 #define _mtx_lock_spin(m, v, t, o, f, l)                                \
 163         _mtx_lock_spin_cookie(&(m)->mtx_lock, v, t, o, f, l)
 164 #endif
 165 #define _mtx_lock_flags(m, o, f, l)                                     \
 166         __mtx_lock_flags(&(m)->mtx_lock, o, f, l)
 167 #define _mtx_unlock_flags(m, o, f, l)                                   \
 168         __mtx_unlock_flags(&(m)->mtx_lock, o, f, l)
 169 #define _mtx_lock_spin_flags(m, o, f, l)                                \
 170         __mtx_lock_spin_flags(&(m)->mtx_lock, o, f, l)
 171 #define _mtx_trylock_spin_flags(m, o, f, l)                             \
 172         __mtx_trylock_spin_flags(&(m)->mtx_lock, o, f, l)
 173 #define _mtx_unlock_spin_flags(m, o, f, l)                              \
 174         __mtx_unlock_spin_flags(&(m)->mtx_lock, o, f, l)
 175 #if defined(INVARIANTS) || defined(INVARIANT_SUPPORT)
 176 #define _mtx_assert(m, w, f, l)                                         \
 177         __mtx_assert(&(m)->mtx_lock, w, f, l)
 178 #endif
 179
 180 #define mtx_recurse     lock_object.lo_data
 181
 182 /* Very simple operations on mtx_lock. */
 183
 184 /* Try to obtain mtx_lock once. */
 185 #define _mtx_obtain_lock(mp, tid)                                       \
 186         atomic_cmpset_acq_ptr(&(mp)->mtx_lock, MTX_UNOWNED, (tid))
 187
 188 #define _mtx_obtain_lock_fetch(mp, vp, tid)                             \
 189         atomic_fcmpset_rel_ptr(&(mp)->mtx_lock, vp, (tid))
 190
 191 /* Try to release mtx_lock if it is unrecursed and uncontested. */
 192 #define _mtx_release_lock(mp, tid)                                      \
 193         atomic_cmpset_rel_ptr(&(mp)->mtx_lock, (tid), MTX_UNOWNED)
 194
 195 /* Release mtx_lock quickly, assuming we own it. */
 196 #define _mtx_release_lock_quick(mp)                                     \
 197         atomic_store_rel_ptr(&(mp)->mtx_lock, MTX_UNOWNED)
 198
 199 /*
 200  * Full lock operations that are suitable to be inlined in non-debug
 201  * kernels.  If the lock cannot be acquired or released trivially then
 202  * the work is deferred to another function.
 203  */
 204
 205 /* Lock a normal mutex. */
 206 #define __mtx_lock(mp, tid, opts, file, line) do {                      \
 207         uintptr_t _tid = (uintptr_t)(tid);                              \
 208         uintptr_t _v = MTX_UNOWNED;                                     \
 209                                                                         \
 210         if (__predict_false(LOCKSTAT_PROFILE_ENABLED(adaptive__acquire) ||\
 211             !_mtx_obtain_lock_fetch((mp), &_v, _tid)))                  \
 212                 _mtx_lock_sleep((mp), _v, _tid, (opts), (file), (line));\
 213 } while (0)
 214
 215 /*
 216  * Lock a spin mutex.  For spinlocks, we handle recursion inline (it
 217  * turns out that function calls can be significantly expensive on
 218  * some architectures).  Since spin locks are not _too_ common,
 219  * inlining this code is not too big a deal.
 220  */
 221 #ifdef SMP
 222 #define __mtx_lock_spin(mp, tid, opts, file, line) do {                 \
 223         uintptr_t _tid = (uintptr_t)(tid);                              \
 224         uintptr_t _v = MTX_UNOWNED;                                     \
 225                                                                         \
 226         spinlock_enter();                                               \
 227         if (!_mtx_obtain_lock_fetch((mp), &_v, _tid)) {                 \
 228                 if (_v == _tid)                                         \
 229                         (mp)->mtx_recurse++;                            \
 230                 else                                                    \
 231                         _mtx_lock_spin((mp), _v, _tid, (opts), (file), (line));\
 232         } else                                                          \
 233                 LOCKSTAT_PROFILE_OBTAIN_LOCK_SUCCESS(spin__acquire,     \
 234                     mp, 0, 0, file, line);                              \
 235 } while (0)
 236 #define __mtx_trylock_spin(mp, tid, opts, file, line) __extension__  ({ \
 237         uintptr_t _tid = (uintptr_t)(tid);                              \
 238         int _ret;                                                       \
 239                                                                         \
 240         spinlock_enter();                                               \
 241         if (((mp)->mtx_lock != MTX_UNOWNED || !_mtx_obtain_lock((mp), _tid))) {\
 242                 spinlock_exit();                                        \
 243                 _ret = 0;                                               \
 244         } else {                                                        \
 245                 LOCKSTAT_PROFILE_OBTAIN_LOCK_SUCCESS(spin__acquire,     \
 246                     mp, 0, 0, file, line);                              \
 247                 _ret = 1;                                               \
 248         }                                                               \
 249         _ret;                                                           \
 250 })
 251 #else /* SMP */
 252 #define __mtx_lock_spin(mp, tid, opts, file, line) do {                 \
 253         uintptr_t _tid = (uintptr_t)(tid);                              \
 254                                                                         \
 255         spinlock_enter();                                               \
 256         if ((mp)->mtx_lock == _tid)                                     \
 257                 (mp)->mtx_recurse++;                                    \
 258         else {                                                          \
 259                 KASSERT((mp)->mtx_lock == MTX_UNOWNED, ("corrupt spinlock")); \
 260                 (mp)->mtx_lock = _tid;                                  \
 261         }                                                               \
 262 } while (0)
 263 #define __mtx_trylock_spin(mp, tid, opts, file, line) __extension__  ({ \
 264         uintptr_t _tid = (uintptr_t)(tid);                              \
 265         int _ret;                                                       \
 266                                                                         \
 267         spinlock_enter();                                               \
 268         if ((mp)->mtx_lock != MTX_UNOWNED) {                            \
 269                 spinlock_exit();                                        \
 270                 _ret = 0;                                               \
 271         } else {                                                        \
 272                 (mp)->mtx_lock = _tid;                                  \
 273                 _ret = 1;                                               \
 274         }                                                               \
 275         _ret;                                                           \
 276 })
 277 #endif /* SMP */
 278
 279 /* Unlock a normal mutex. */
 280 #define __mtx_unlock(mp, tid, opts, file, line) do {                    \
 281         uintptr_t _tid = (uintptr_t)(tid);                              \
 282                                                                         \
 283         if (__predict_false(LOCKSTAT_PROFILE_ENABLED(adaptive__release) ||\
 284             !_mtx_release_lock((mp), _tid)))                            \
 285                 _mtx_unlock_sleep((mp), (opts), (file), (line));        \
 286 } while (0)
 287
 288 /*
 289  * Unlock a spin mutex.  For spinlocks, we can handle everything
 290  * inline, as it's pretty simple and a function call would be too
 291  * expensive (at least on some architectures).  Since spin locks are
 292  * not _too_ common, inlining this code is not too big a deal.
 293  *
 294  * Since we always perform a spinlock_enter() when attempting to acquire a
 295  * spin lock, we need to always perform a matching spinlock_exit() when
 296  * releasing a spin lock.  This includes the recursion cases.
 297  */
 298 #ifdef SMP
 299 #define __mtx_unlock_spin(mp) do {                                      \
 300         if (mtx_recursed((mp)))                                         \
 301                 (mp)->mtx_recurse--;                                    \
 302         else {                                                          \
 303                 LOCKSTAT_PROFILE_RELEASE_LOCK(spin__release, mp);       \
 304                 _mtx_release_lock_quick((mp));                          \
 305         }                                                               \
 306         spinlock_exit();                                                \
 307 } while (0)
 308 #else /* SMP */
 309 #define __mtx_unlock_spin(mp) do {                                      \
 310         if (mtx_recursed((mp)))                                         \
 311                 (mp)->mtx_recurse--;                                    \
 312         else {                                                          \
 313                 LOCKSTAT_PROFILE_RELEASE_LOCK(spin__release, mp);       \
 314                 (mp)->mtx_lock = MTX_UNOWNED;                           \
 315         }                                                               \
 316         spinlock_exit();                                                \
 317 } while (0)
 318 #endif /* SMP */
 319
 320 /*
 321  * Exported lock manipulation interface.
 322  *
 323  * mtx_lock(m) locks MTX_DEF mutex `m'
 324  *
 325  * mtx_lock_spin(m) locks MTX_SPIN mutex `m'
 326  *
 327  * mtx_unlock(m) unlocks MTX_DEF mutex `m'
 328  *
 329  * mtx_unlock_spin(m) unlocks MTX_SPIN mutex `m'
 330  *
 331  * mtx_lock_spin_flags(m, opts) and mtx_lock_flags(m, opts) locks mutex `m'
 332  *     and passes option flags `opts' to the "hard" function, if required.
 333  *     With these routines, it is possible to pass flags such as MTX_QUIET
 334  *     to the appropriate lock manipulation routines.
 335  *
 336  * mtx_trylock(m) attempts to acquire MTX_DEF mutex `m' but doesn't sleep if
 337  *     it cannot. Rather, it returns 0 on failure and non-zero on success.
 338  *     It does NOT handle recursion as we assume that if a caller is properly
 339  *     using this part of the interface, he will know that the lock in question
 340  *     is _not_ recursed.
 341  *
 342  * mtx_trylock_flags(m, opts) is used the same way as mtx_trylock() but accepts
 343  *     relevant option flags `opts.'
 344  *
 345  * mtx_trylock_spin(m) attempts to acquire MTX_SPIN mutex `m' but doesn't
 346  *     spin if it cannot.  Rather, it returns 0 on failure and non-zero on
 347  *     success.  It always returns failure for recursed lock attempts.
 348  *
 349  * mtx_initialized(m) returns non-zero if the lock `m' has been initialized.
 350  *
 351  * mtx_owned(m) returns non-zero if the current thread owns the lock `m'
 352  *
 353  * mtx_recursed(m) returns non-zero if the lock `m' is presently recursed.
 354  */
 355 #define mtx_lock(m)             mtx_lock_flags((m), 0)
 356 #define mtx_lock_spin(m)        mtx_lock_spin_flags((m), 0)
 357 #define mtx_trylock(m)          mtx_trylock_flags((m), 0)
 358 #define mtx_trylock_spin(m)     mtx_trylock_spin_flags((m), 0)
 359 #define mtx_unlock(m)           mtx_unlock_flags((m), 0)
 360 #define mtx_unlock_spin(m)      mtx_unlock_spin_flags((m), 0)
 361
 362 struct mtx_pool;
 363
 364 struct mtx_pool *mtx_pool_create(const char *mtx_name, int pool_size, int opts);
 365 void mtx_pool_destroy(struct mtx_pool **poolp);
 366 struct mtx *mtx_pool_find(struct mtx_pool *pool, void *ptr);
 367 struct mtx *mtx_pool_alloc(struct mtx_pool *pool);
 368 #define mtx_pool_lock(pool, ptr)                                        \
 369         mtx_lock(mtx_pool_find((pool), (ptr)))
 370 #define mtx_pool_lock_spin(pool, ptr)                                   \
 371         mtx_lock_spin(mtx_pool_find((pool), (ptr)))
 372 #define mtx_pool_unlock(pool, ptr)                                      \
 373         mtx_unlock(mtx_pool_find((pool), (ptr)))
 374 #define mtx_pool_unlock_spin(pool, ptr)                                 \
 375         mtx_unlock_spin(mtx_pool_find((pool), (ptr)))
 376
 377 /*
 378  * mtxpool_sleep is a general purpose pool of sleep mutexes.
 379  */
 380 extern struct mtx_pool *mtxpool_sleep;
 381
 382 #ifndef LOCK_DEBUG
 383 #error LOCK_DEBUG not defined, include <sys/lock.h> before <sys/mutex.h>
 384 #endif
 385 #if LOCK_DEBUG > 0 || defined(MUTEX_NOINLINE)
 386 #define mtx_lock_flags_(m, opts, file, line)                            \
 387         _mtx_lock_flags((m), (opts), (file), (line))
 388 #define mtx_unlock_flags_(m, opts, file, line)                          \
 389         _mtx_unlock_flags((m), (opts), (file), (line))
 390 #define mtx_lock_spin_flags_(m, opts, file, line)                       \
 391         _mtx_lock_spin_flags((m), (opts), (file), (line))
 392 #define mtx_trylock_spin_flags_(m, opts, file, line)                    \
 393         _mtx_trylock_spin_flags((m), (opts), (file), (line))
 394 #define mtx_unlock_spin_flags_(m, opts, file, line)                     \
 395         _mtx_unlock_spin_flags((m), (opts), (file), (line))
 396 #else   /* LOCK_DEBUG == 0 && !MUTEX_NOINLINE */
 397 #define mtx_lock_flags_(m, opts, file, line)                            \
 398         __mtx_lock((m), curthread, (opts), (file), (line))
 399 #define mtx_unlock_flags_(m, opts, file, line)                          \
 400         __mtx_unlock((m), curthread, (opts), (file), (line))
 401 #define mtx_lock_spin_flags_(m, opts, file, line)                       \
 402         __mtx_lock_spin((m), curthread, (opts), (file), (line))
 403 #define mtx_trylock_spin_flags_(m, opts, file, line)                    \
 404         __mtx_trylock_spin((m), curthread, (opts), (file), (line))
 405 #define mtx_unlock_spin_flags_(m, opts, file, line)                     \
 406         __mtx_unlock_spin((m))
 407 #endif  /* LOCK_DEBUG > 0 || MUTEX_NOINLINE */
 408
 409 #ifdef INVARIANTS
 410 #define mtx_assert_(m, what, file, line)                                \
 411         _mtx_assert((m), (what), (file), (line))
 412
 413 #define GIANT_REQUIRED  mtx_assert_(&Giant, MA_OWNED, __FILE__, __LINE__)
 414
 415 #else   /* INVARIANTS */
 416 #define mtx_assert_(m, what, file, line)        (void)0
 417 #define GIANT_REQUIRED
 418 #endif  /* INVARIANTS */
 419
 420 #define mtx_lock_flags(m, opts)                                         \
 421         mtx_lock_flags_((m), (opts), LOCK_FILE, LOCK_LINE)
 422 #define mtx_unlock_flags(m, opts)                                       \
 423         mtx_unlock_flags_((m), (opts), LOCK_FILE, LOCK_LINE)
 424 #define mtx_lock_spin_flags(m, opts)                                    \
 425         mtx_lock_spin_flags_((m), (opts), LOCK_FILE, LOCK_LINE)
 426 #define mtx_unlock_spin_flags(m, opts)                                  \
 427         mtx_unlock_spin_flags_((m), (opts), LOCK_FILE, LOCK_LINE)
 428 #define mtx_trylock_flags(m, opts)                                      \
 429         mtx_trylock_flags_((m), (opts), LOCK_FILE, LOCK_LINE)
 430 #define mtx_trylock_spin_flags(m, opts)                                 \
 431         mtx_trylock_spin_flags_((m), (opts), LOCK_FILE, LOCK_LINE)
 432 #define mtx_assert(m, what)                                             \
 433         mtx_assert_((m), (what), __FILE__, __LINE__)
 434
 435 #define mtx_sleep(chan, mtx, pri, wmesg, timo)                          \
 436         _sleep((chan), &(mtx)->lock_object, (pri), (wmesg),             \
 437             tick_sbt * (timo), 0, C_HARDCLOCK)
 438
 439 #define MTX_READ_VALUE(m)       ((m)->mtx_lock)
 440
 441 #define mtx_initialized(m)      lock_initialized(&(m)->lock_object)
 442
 443 #define lv_mtx_owner(v) ((struct thread *)((v) & ~MTX_FLAGMASK))
 444
 445 #define mtx_owner(m)    lv_mtx_owner(MTX_READ_VALUE(m))
 446
 447 #define mtx_owned(m)    (mtx_owner(m) == curthread)
 448
 449 #define mtx_recursed(m) ((m)->mtx_recurse != 0)
 450
 451 #define mtx_name(m)     ((m)->lock_object.lo_name)
 452
 453 /*
 454  * Global locks.
 455  */
 456 extern struct mtx Giant;
 457 extern struct mtx blocked_lock;
 458
 459 /*
 460  * Giant lock manipulation and clean exit macros.
 461  * Used to replace return with an exit Giant and return.
 462  *
 463  * Note that DROP_GIANT*() needs to be paired with PICKUP_GIANT()
 464  * The #ifndef is to allow lint-like tools to redefine DROP_GIANT.
 465  */
 466 #ifndef DROP_GIANT
 467 #define DROP_GIANT()                                                    \
 468 do {                                                                    \
 469         int _giantcnt = 0;                                              \
 470         WITNESS_SAVE_DECL(Giant);                                       \
 471                                                                         \
 472         if (mtx_owned(&Giant)) {                                        \
 473                 WITNESS_SAVE(&Giant.lock_object, Giant);                \
 474                 for (_giantcnt = 0; mtx_owned(&Giant) &&                \
 475                     !SCHEDULER_STOPPED(); _giantcnt++)                  \
 476                         mtx_unlock(&Giant);                             \
 477         }
 478
 479 #define PICKUP_GIANT()                                                  \
 480         PARTIAL_PICKUP_GIANT();                                         \
 481 } while (0)
 482
 483 #define PARTIAL_PICKUP_GIANT()                                          \
 484         mtx_assert(&Giant, MA_NOTOWNED);                                \
 485         if (_giantcnt > 0) {                                            \
 486                 while (_giantcnt--)                                     \
 487                         mtx_lock(&Giant);                               \
 488                 WITNESS_RESTORE(&Giant.lock_object, Giant);             \
 489         }
 490 #endif
 491
 492 struct mtx_args {
 493         void            *ma_mtx;
 494         const char      *ma_desc;
 495         int              ma_opts;
 496 };
 497
 498 #define MTX_SYSINIT(name, mtx, desc, opts)                              \
 499         static struct mtx_args name##_args = {                          \
 500                 (mtx),                                                  \
 501                 (desc),                                                 \
 502                 (opts)                                                  \
 503         };                                                              \
 504         SYSINIT(name##_mtx_sysinit, SI_SUB_LOCK, SI_ORDER_MIDDLE,       \
 505             mtx_sysinit, &name##_args);                                 \
 506         SYSUNINIT(name##_mtx_sysuninit, SI_SUB_LOCK, SI_ORDER_MIDDLE,   \
 507             _mtx_destroy, __DEVOLATILE(void *, &(mtx)->mtx_lock))
 508
 509 /*
 510  * The INVARIANTS-enabled mtx_assert() functionality.
 511  *
 512  * The constants need to be defined for INVARIANT_SUPPORT infrastructure
 513  * support as _mtx_assert() itself uses them and the latter implies that
 514  * _mtx_assert() must build.
 515  */
 516 #if defined(INVARIANTS) || defined(INVARIANT_SUPPORT)
 517 #define MA_OWNED        LA_XLOCKED
 518 #define MA_NOTOWNED     LA_UNLOCKED
 519 #define MA_RECURSED     LA_RECURSED
 520 #define MA_NOTRECURSED  LA_NOTRECURSED
 521 #endif
 522
 523 /*
 524  * Common lock type names.
 525  */
 526 #define MTX_NETWORK_LOCK        "network driver"
 527
 528 #endif  /* _KERNEL */
 529 #endif  /* _SYS_MUTEX_H_ */