19454b2d8SWarner Losh /*- 28a36da99SPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 38a36da99SPedro F. Giffuni * 4047dd67eSAttilio Rao * Copyright (c) 2008 Attilio Rao <attilio@FreeBSD.org> 5047dd67eSAttilio Rao * All rights reserved. 653bf4bb2SPeter Wemm * 753bf4bb2SPeter Wemm * Redistribution and use in source and binary forms, with or without 853bf4bb2SPeter Wemm * modification, are permitted provided that the following conditions 953bf4bb2SPeter Wemm * are met: 1053bf4bb2SPeter Wemm * 1. Redistributions of source code must retain the above copyright 11047dd67eSAttilio Rao * notice(s), this list of conditions and the following disclaimer as 12047dd67eSAttilio Rao * the first lines of this file unmodified other than the possible 13047dd67eSAttilio Rao * addition of one or more copyright notices. 1453bf4bb2SPeter Wemm * 2. Redistributions in binary form must reproduce the above copyright 15047dd67eSAttilio Rao * notice(s), this list of conditions and the following disclaimer in the 1653bf4bb2SPeter Wemm * documentation and/or other materials provided with the distribution. 1753bf4bb2SPeter Wemm * 18047dd67eSAttilio Rao * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY 19047dd67eSAttilio Rao * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 20047dd67eSAttilio Rao * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 21047dd67eSAttilio Rao * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY 22047dd67eSAttilio Rao * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 23047dd67eSAttilio Rao * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 24047dd67eSAttilio Rao * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 25047dd67eSAttilio Rao * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2653bf4bb2SPeter Wemm * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27047dd67eSAttilio Rao * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 28047dd67eSAttilio Rao * DAMAGE. 2953bf4bb2SPeter Wemm */ 3053bf4bb2SPeter Wemm 31047dd67eSAttilio Rao #include "opt_ddb.h" 32f5f9340bSFabien Thomas #include "opt_hwpmc_hooks.h" 33047dd67eSAttilio Rao 34677b542eSDavid E. O'Brien #include <sys/cdefs.h> 35677b542eSDavid E. O'Brien __FBSDID("$FreeBSD$"); 36677b542eSDavid E. O'Brien 3753bf4bb2SPeter Wemm #include <sys/param.h> 38cd2fe4e6SAttilio Rao #include <sys/kdb.h> 3961d80e90SJohn Baldwin #include <sys/ktr.h> 4053bf4bb2SPeter Wemm #include <sys/lock.h> 41047dd67eSAttilio Rao #include <sys/lock_profile.h> 428302d183SBruce Evans #include <sys/lockmgr.h> 43d8881ca3SJohn Baldwin #include <sys/mutex.h> 448302d183SBruce Evans #include <sys/proc.h> 45047dd67eSAttilio Rao #include <sys/sleepqueue.h> 46e8ddb61dSJeff Roberson #ifdef DEBUG_LOCKS 47e8ddb61dSJeff Roberson #include <sys/stack.h> 48e8ddb61dSJeff Roberson #endif 49651175c9SAttilio Rao #include <sys/sysctl.h> 50047dd67eSAttilio Rao #include <sys/systm.h> 5153bf4bb2SPeter Wemm 52047dd67eSAttilio Rao #include <machine/cpu.h> 536efc8a16SAttilio Rao 54be6847d7SJohn Baldwin #ifdef DDB 55be6847d7SJohn Baldwin #include <ddb/ddb.h> 56047dd67eSAttilio Rao #endif 57047dd67eSAttilio Rao 58f5f9340bSFabien Thomas #ifdef HWPMC_HOOKS 59f5f9340bSFabien Thomas #include <sys/pmckern.h> 60f5f9340bSFabien Thomas PMC_SOFT_DECLARE( , , lock, failed); 61f5f9340bSFabien Thomas #endif 62f5f9340bSFabien Thomas 63651175c9SAttilio Rao CTASSERT(((LK_ADAPTIVE | LK_NOSHARE) & LO_CLASSFLAGS) == 64651175c9SAttilio Rao (LK_ADAPTIVE | LK_NOSHARE)); 65651175c9SAttilio Rao CTASSERT(LK_UNLOCKED == (LK_UNLOCKED & 66651175c9SAttilio Rao ~(LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS))); 67047dd67eSAttilio Rao 68047dd67eSAttilio Rao #define SQ_EXCLUSIVE_QUEUE 0 69047dd67eSAttilio Rao #define SQ_SHARED_QUEUE 1 70047dd67eSAttilio Rao 71047dd67eSAttilio Rao #ifndef INVARIANTS 72047dd67eSAttilio Rao #define _lockmgr_assert(lk, what, file, line) 73047dd67eSAttilio Rao #endif 74ce1c953eSMark Johnston 75047dd67eSAttilio Rao #define TD_SLOCKS_INC(td) ((td)->td_lk_slocks++) 76047dd67eSAttilio Rao #define TD_SLOCKS_DEC(td) ((td)->td_lk_slocks--) 77047dd67eSAttilio Rao 78047dd67eSAttilio Rao #ifndef DEBUG_LOCKS 79047dd67eSAttilio Rao #define STACK_PRINT(lk) 80047dd67eSAttilio Rao #define STACK_SAVE(lk) 81047dd67eSAttilio Rao #define STACK_ZERO(lk) 82047dd67eSAttilio Rao #else 83047dd67eSAttilio Rao #define STACK_PRINT(lk) stack_print_ddb(&(lk)->lk_stack) 84047dd67eSAttilio Rao #define STACK_SAVE(lk) stack_save(&(lk)->lk_stack) 85047dd67eSAttilio Rao #define STACK_ZERO(lk) stack_zero(&(lk)->lk_stack) 86047dd67eSAttilio Rao #endif 87047dd67eSAttilio Rao 88047dd67eSAttilio Rao #define LOCK_LOG2(lk, string, arg1, arg2) \ 89047dd67eSAttilio Rao if (LOCK_LOG_TEST(&(lk)->lock_object, 0)) \ 90047dd67eSAttilio Rao CTR2(KTR_LOCK, (string), (arg1), (arg2)) 91047dd67eSAttilio Rao #define LOCK_LOG3(lk, string, arg1, arg2, arg3) \ 92047dd67eSAttilio Rao if (LOCK_LOG_TEST(&(lk)->lock_object, 0)) \ 93047dd67eSAttilio Rao CTR3(KTR_LOCK, (string), (arg1), (arg2), (arg3)) 94047dd67eSAttilio Rao 95e5f94314SAttilio Rao #define GIANT_DECLARE \ 96e5f94314SAttilio Rao int _i = 0; \ 97e5f94314SAttilio Rao WITNESS_SAVE_DECL(Giant) 98e5f94314SAttilio Rao #define GIANT_RESTORE() do { \ 99e5f94314SAttilio Rao if (_i > 0) { \ 100e5f94314SAttilio Rao while (_i--) \ 101e5f94314SAttilio Rao mtx_lock(&Giant); \ 102e5f94314SAttilio Rao WITNESS_RESTORE(&Giant.lock_object, Giant); \ 103e5f94314SAttilio Rao } \ 104e5f94314SAttilio Rao } while (0) 105e5f94314SAttilio Rao #define GIANT_SAVE() do { \ 106e5f94314SAttilio Rao if (mtx_owned(&Giant)) { \ 107e5f94314SAttilio Rao WITNESS_SAVE(&Giant.lock_object, Giant); \ 108e5f94314SAttilio Rao while (mtx_owned(&Giant)) { \ 109e5f94314SAttilio Rao _i++; \ 110e5f94314SAttilio Rao mtx_unlock(&Giant); \ 111e5f94314SAttilio Rao } \ 112e5f94314SAttilio Rao } \ 113e5f94314SAttilio Rao } while (0) 114e5f94314SAttilio Rao 11572ba3c08SKonstantin Belousov #define LK_CAN_SHARE(x, flags) \ 11672ba3c08SKonstantin Belousov (((x) & LK_SHARE) && \ 11772ba3c08SKonstantin Belousov (((x) & (LK_EXCLUSIVE_WAITERS | LK_EXCLUSIVE_SPINNERS)) == 0 || \ 11872ba3c08SKonstantin Belousov (curthread->td_lk_slocks != 0 && !(flags & LK_NODDLKTREAT)) || \ 11972ba3c08SKonstantin Belousov (curthread->td_pflags & TDP_DEADLKTREAT))) 120e5f94314SAttilio Rao #define LK_TRYOP(x) \ 121e5f94314SAttilio Rao ((x) & LK_NOWAIT) 122e5f94314SAttilio Rao 123e5f94314SAttilio Rao #define LK_CAN_WITNESS(x) \ 124e5f94314SAttilio Rao (((x) & LK_NOWITNESS) == 0 && !LK_TRYOP(x)) 125e5f94314SAttilio Rao #define LK_TRYWIT(x) \ 126e5f94314SAttilio Rao (LK_TRYOP(x) ? LOP_TRYLOCK : 0) 127047dd67eSAttilio Rao 128651175c9SAttilio Rao #define LK_CAN_ADAPT(lk, f) \ 129651175c9SAttilio Rao (((lk)->lock_object.lo_flags & LK_ADAPTIVE) != 0 && \ 130651175c9SAttilio Rao ((f) & LK_SLEEPFAIL) == 0) 131651175c9SAttilio Rao 132047dd67eSAttilio Rao #define lockmgr_disowned(lk) \ 133047dd67eSAttilio Rao (((lk)->lk_lock & ~(LK_FLAGMASK & ~LK_SHARE)) == LK_KERNPROC) 134047dd67eSAttilio Rao 135047dd67eSAttilio Rao #define lockmgr_xlocked(lk) \ 136047dd67eSAttilio Rao (((lk)->lk_lock & ~(LK_FLAGMASK & ~LK_SHARE)) == (uintptr_t)curthread) 137047dd67eSAttilio Rao 138d576deedSPawel Jakub Dawidek static void assert_lockmgr(const struct lock_object *lock, int how); 139047dd67eSAttilio Rao #ifdef DDB 140d576deedSPawel Jakub Dawidek static void db_show_lockmgr(const struct lock_object *lock); 141be6847d7SJohn Baldwin #endif 1427faf4d90SDavide Italiano static void lock_lockmgr(struct lock_object *lock, uintptr_t how); 143a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 144d576deedSPawel Jakub Dawidek static int owner_lockmgr(const struct lock_object *lock, 145d576deedSPawel Jakub Dawidek struct thread **owner); 146a5aedd68SStacey Son #endif 1477faf4d90SDavide Italiano static uintptr_t unlock_lockmgr(struct lock_object *lock); 14861bd5e21SKip Macy 14961bd5e21SKip Macy struct lock_class lock_class_lockmgr = { 1503ff6d229SJohn Baldwin .lc_name = "lockmgr", 151047dd67eSAttilio Rao .lc_flags = LC_RECURSABLE | LC_SLEEPABLE | LC_SLEEPLOCK | LC_UPGRADABLE, 152f9721b43SAttilio Rao .lc_assert = assert_lockmgr, 15361bd5e21SKip Macy #ifdef DDB 1546e21afd4SJohn Baldwin .lc_ddb_show = db_show_lockmgr, 15561bd5e21SKip Macy #endif 1566e21afd4SJohn Baldwin .lc_lock = lock_lockmgr, 157a5aedd68SStacey Son .lc_unlock = unlock_lockmgr, 158a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 159a5aedd68SStacey Son .lc_owner = owner_lockmgr, 160a5aedd68SStacey Son #endif 16161bd5e21SKip Macy }; 16261bd5e21SKip Macy 1631c6987ebSMateusz Guzik struct lockmgr_wait { 1641c6987ebSMateusz Guzik const char *iwmesg; 1651c6987ebSMateusz Guzik int ipri; 1661c6987ebSMateusz Guzik int itimo; 1671c6987ebSMateusz Guzik }; 1681c6987ebSMateusz Guzik 169c4a48867SMateusz Guzik static bool __always_inline lockmgr_slock_try(struct lock *lk, uintptr_t *xp, 170c4a48867SMateusz Guzik int flags); 1711c6987ebSMateusz Guzik static bool __always_inline lockmgr_sunlock_try(struct lock *lk, uintptr_t *xp); 1721c6987ebSMateusz Guzik 1731c6987ebSMateusz Guzik static void 1741c6987ebSMateusz Guzik lockmgr_exit(u_int flags, struct lock_object *ilk, int wakeup_swapper) 1751c6987ebSMateusz Guzik { 1761c6987ebSMateusz Guzik struct lock_class *class; 1771c6987ebSMateusz Guzik 1781c6987ebSMateusz Guzik if (flags & LK_INTERLOCK) { 1791c6987ebSMateusz Guzik class = LOCK_CLASS(ilk); 1801c6987ebSMateusz Guzik class->lc_unlock(ilk); 1811c6987ebSMateusz Guzik } 1821c6987ebSMateusz Guzik 1831c6987ebSMateusz Guzik if (__predict_false(wakeup_swapper)) 1841c6987ebSMateusz Guzik kick_proc0(); 1851c6987ebSMateusz Guzik } 186c4a48867SMateusz Guzik 187c4a48867SMateusz Guzik static void 188c4a48867SMateusz Guzik lockmgr_note_shared_acquire(struct lock *lk, int contested, 189c4a48867SMateusz Guzik uint64_t waittime, const char *file, int line, int flags) 190c4a48867SMateusz Guzik { 191c4a48867SMateusz Guzik 192c4a48867SMateusz Guzik lock_profile_obtain_lock_success(&lk->lock_object, contested, waittime, 193c4a48867SMateusz Guzik file, line); 194c4a48867SMateusz Guzik LOCK_LOG_LOCK("SLOCK", &lk->lock_object, 0, 0, file, line); 195c4a48867SMateusz Guzik WITNESS_LOCK(&lk->lock_object, LK_TRYWIT(flags), file, line); 196c4a48867SMateusz Guzik TD_LOCKS_INC(curthread); 197c4a48867SMateusz Guzik TD_SLOCKS_INC(curthread); 198c4a48867SMateusz Guzik STACK_SAVE(lk); 199c4a48867SMateusz Guzik } 200c4a48867SMateusz Guzik 201c4a48867SMateusz Guzik static void 202c4a48867SMateusz Guzik lockmgr_note_shared_release(struct lock *lk, const char *file, int line) 203c4a48867SMateusz Guzik { 204c4a48867SMateusz Guzik 205c4a48867SMateusz Guzik lock_profile_release_lock(&lk->lock_object); 206c4a48867SMateusz Guzik WITNESS_UNLOCK(&lk->lock_object, 0, file, line); 207c4a48867SMateusz Guzik LOCK_LOG_LOCK("SUNLOCK", &lk->lock_object, 0, 0, file, line); 208c4a48867SMateusz Guzik TD_LOCKS_DEC(curthread); 209c4a48867SMateusz Guzik TD_SLOCKS_DEC(curthread); 210c4a48867SMateusz Guzik } 211c4a48867SMateusz Guzik 212c4a48867SMateusz Guzik static void 213c4a48867SMateusz Guzik lockmgr_note_exclusive_acquire(struct lock *lk, int contested, 214c4a48867SMateusz Guzik uint64_t waittime, const char *file, int line, int flags) 215c4a48867SMateusz Guzik { 216c4a48867SMateusz Guzik 217c4a48867SMateusz Guzik lock_profile_obtain_lock_success(&lk->lock_object, contested, waittime, 218c4a48867SMateusz Guzik file, line); 219c4a48867SMateusz Guzik LOCK_LOG_LOCK("XLOCK", &lk->lock_object, 0, lk->lk_recurse, file, line); 220c4a48867SMateusz Guzik WITNESS_LOCK(&lk->lock_object, LOP_EXCLUSIVE | LK_TRYWIT(flags), file, 221c4a48867SMateusz Guzik line); 222c4a48867SMateusz Guzik TD_LOCKS_INC(curthread); 223c4a48867SMateusz Guzik STACK_SAVE(lk); 224c4a48867SMateusz Guzik } 225c4a48867SMateusz Guzik 226c4a48867SMateusz Guzik static void 227c4a48867SMateusz Guzik lockmgr_note_exclusive_release(struct lock *lk, const char *file, int line) 228c4a48867SMateusz Guzik { 229c4a48867SMateusz Guzik 230c4a48867SMateusz Guzik lock_profile_release_lock(&lk->lock_object); 231c4a48867SMateusz Guzik LOCK_LOG_LOCK("XUNLOCK", &lk->lock_object, 0, lk->lk_recurse, file, 232c4a48867SMateusz Guzik line); 233c4a48867SMateusz Guzik WITNESS_UNLOCK(&lk->lock_object, LOP_EXCLUSIVE, file, line); 234c4a48867SMateusz Guzik TD_LOCKS_DEC(curthread); 235c4a48867SMateusz Guzik } 236c4a48867SMateusz Guzik 237047dd67eSAttilio Rao static __inline struct thread * 238d576deedSPawel Jakub Dawidek lockmgr_xholder(const struct lock *lk) 239047dd67eSAttilio Rao { 240047dd67eSAttilio Rao uintptr_t x; 241047dd67eSAttilio Rao 242047dd67eSAttilio Rao x = lk->lk_lock; 243047dd67eSAttilio Rao return ((x & LK_SHARE) ? NULL : (struct thread *)LK_HOLDER(x)); 244047dd67eSAttilio Rao } 24584887fa3SAttilio Rao 24653bf4bb2SPeter Wemm /* 247047dd67eSAttilio Rao * It assumes sleepq_lock held and returns with this one unheld. 248047dd67eSAttilio Rao * It also assumes the generic interlock is sane and previously checked. 249047dd67eSAttilio Rao * If LK_INTERLOCK is specified the interlock is not reacquired after the 250047dd67eSAttilio Rao * sleep. 25153bf4bb2SPeter Wemm */ 252047dd67eSAttilio Rao static __inline int 253047dd67eSAttilio Rao sleeplk(struct lock *lk, u_int flags, struct lock_object *ilk, 254047dd67eSAttilio Rao const char *wmesg, int pri, int timo, int queue) 255047dd67eSAttilio Rao { 256e5f94314SAttilio Rao GIANT_DECLARE; 257047dd67eSAttilio Rao struct lock_class *class; 258047dd67eSAttilio Rao int catch, error; 25953bf4bb2SPeter Wemm 260047dd67eSAttilio Rao class = (flags & LK_INTERLOCK) ? LOCK_CLASS(ilk) : NULL; 2615047a8fdSAttilio Rao catch = pri & PCATCH; 262047dd67eSAttilio Rao pri &= PRIMASK; 263047dd67eSAttilio Rao error = 0; 264047dd67eSAttilio Rao 265047dd67eSAttilio Rao LOCK_LOG3(lk, "%s: %p blocking on the %s sleepqueue", __func__, lk, 266047dd67eSAttilio Rao (queue == SQ_EXCLUSIVE_QUEUE) ? "exclusive" : "shared"); 267047dd67eSAttilio Rao 268047dd67eSAttilio Rao if (flags & LK_INTERLOCK) 269047dd67eSAttilio Rao class->lc_unlock(ilk); 2702028867dSAttilio Rao if (queue == SQ_EXCLUSIVE_QUEUE && (flags & LK_SLEEPFAIL) != 0) 2712028867dSAttilio Rao lk->lk_exslpfail++; 272e5f94314SAttilio Rao GIANT_SAVE(); 273047dd67eSAttilio Rao sleepq_add(&lk->lock_object, NULL, wmesg, SLEEPQ_LK | (catch ? 274047dd67eSAttilio Rao SLEEPQ_INTERRUPTIBLE : 0), queue); 275a115fb62SHans Petter Selasky if ((flags & LK_TIMELOCK) && timo) 276047dd67eSAttilio Rao sleepq_set_timeout(&lk->lock_object, timo); 277a115fb62SHans Petter Selasky 278047dd67eSAttilio Rao /* 279047dd67eSAttilio Rao * Decisional switch for real sleeping. 280047dd67eSAttilio Rao */ 281047dd67eSAttilio Rao if ((flags & LK_TIMELOCK) && timo && catch) 282047dd67eSAttilio Rao error = sleepq_timedwait_sig(&lk->lock_object, pri); 283047dd67eSAttilio Rao else if ((flags & LK_TIMELOCK) && timo) 284047dd67eSAttilio Rao error = sleepq_timedwait(&lk->lock_object, pri); 285047dd67eSAttilio Rao else if (catch) 286047dd67eSAttilio Rao error = sleepq_wait_sig(&lk->lock_object, pri); 287047dd67eSAttilio Rao else 288047dd67eSAttilio Rao sleepq_wait(&lk->lock_object, pri); 289e5f94314SAttilio Rao GIANT_RESTORE(); 290047dd67eSAttilio Rao if ((flags & LK_SLEEPFAIL) && error == 0) 291047dd67eSAttilio Rao error = ENOLCK; 292047dd67eSAttilio Rao 293047dd67eSAttilio Rao return (error); 294047dd67eSAttilio Rao } 295047dd67eSAttilio Rao 296da7bbd2cSJohn Baldwin static __inline int 297047dd67eSAttilio Rao wakeupshlk(struct lock *lk, const char *file, int line) 298047dd67eSAttilio Rao { 2990ad122a9SMateusz Guzik uintptr_t v, x, orig_x; 3002028867dSAttilio Rao u_int realexslp; 301da7bbd2cSJohn Baldwin int queue, wakeup_swapper; 302047dd67eSAttilio Rao 303da7bbd2cSJohn Baldwin wakeup_swapper = 0; 304047dd67eSAttilio Rao for (;;) { 305047dd67eSAttilio Rao x = lk->lk_lock; 3061c6987ebSMateusz Guzik if (lockmgr_sunlock_try(lk, &x)) 307047dd67eSAttilio Rao break; 308047dd67eSAttilio Rao 309047dd67eSAttilio Rao /* 310047dd67eSAttilio Rao * We should have a sharer with waiters, so enter the hard 311047dd67eSAttilio Rao * path in order to handle wakeups correctly. 312047dd67eSAttilio Rao */ 313047dd67eSAttilio Rao sleepq_lock(&lk->lock_object); 3140ad122a9SMateusz Guzik orig_x = lk->lk_lock; 3150ad122a9SMateusz Guzik retry_sleepq: 3160ad122a9SMateusz Guzik x = orig_x & (LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS); 317047dd67eSAttilio Rao v = LK_UNLOCKED; 318047dd67eSAttilio Rao 319047dd67eSAttilio Rao /* 320047dd67eSAttilio Rao * If the lock has exclusive waiters, give them preference in 321047dd67eSAttilio Rao * order to avoid deadlock with shared runners up. 3222028867dSAttilio Rao * If interruptible sleeps left the exclusive queue empty 3232028867dSAttilio Rao * avoid a starvation for the threads sleeping on the shared 3242028867dSAttilio Rao * queue by giving them precedence and cleaning up the 3252028867dSAttilio Rao * exclusive waiters bit anyway. 326c636ba83SAttilio Rao * Please note that lk_exslpfail count may be lying about 327c636ba83SAttilio Rao * the real number of waiters with the LK_SLEEPFAIL flag on 328e3043798SPedro F. Giffuni * because they may be used in conjunction with interruptible 329aab9c8c2SAttilio Rao * sleeps so lk_exslpfail might be considered an 'upper limit' 330aab9c8c2SAttilio Rao * bound, including the edge cases. 331047dd67eSAttilio Rao */ 3322028867dSAttilio Rao realexslp = sleepq_sleepcnt(&lk->lock_object, 3332028867dSAttilio Rao SQ_EXCLUSIVE_QUEUE); 3342028867dSAttilio Rao if ((x & LK_EXCLUSIVE_WAITERS) != 0 && realexslp != 0) { 3352028867dSAttilio Rao if (lk->lk_exslpfail < realexslp) { 3362028867dSAttilio Rao lk->lk_exslpfail = 0; 337047dd67eSAttilio Rao queue = SQ_EXCLUSIVE_QUEUE; 338047dd67eSAttilio Rao v |= (x & LK_SHARED_WAITERS); 339047dd67eSAttilio Rao } else { 3402028867dSAttilio Rao lk->lk_exslpfail = 0; 3412028867dSAttilio Rao LOCK_LOG2(lk, 3422028867dSAttilio Rao "%s: %p has only LK_SLEEPFAIL sleepers", 3432028867dSAttilio Rao __func__, lk); 3442028867dSAttilio Rao LOCK_LOG2(lk, 3452028867dSAttilio Rao "%s: %p waking up threads on the exclusive queue", 3462028867dSAttilio Rao __func__, lk); 3472028867dSAttilio Rao wakeup_swapper = 3482028867dSAttilio Rao sleepq_broadcast(&lk->lock_object, 3492028867dSAttilio Rao SLEEPQ_LK, 0, SQ_EXCLUSIVE_QUEUE); 3502028867dSAttilio Rao queue = SQ_SHARED_QUEUE; 3512028867dSAttilio Rao } 3522028867dSAttilio Rao 3532028867dSAttilio Rao } else { 3549dbf7a62SAttilio Rao 3559dbf7a62SAttilio Rao /* 3569dbf7a62SAttilio Rao * Exclusive waiters sleeping with LK_SLEEPFAIL on 3579dbf7a62SAttilio Rao * and using interruptible sleeps/timeout may have 3589dbf7a62SAttilio Rao * left spourious lk_exslpfail counts on, so clean 3599dbf7a62SAttilio Rao * it up anyway. 3609dbf7a62SAttilio Rao */ 3619dbf7a62SAttilio Rao lk->lk_exslpfail = 0; 362047dd67eSAttilio Rao queue = SQ_SHARED_QUEUE; 363047dd67eSAttilio Rao } 364047dd67eSAttilio Rao 3650ad122a9SMateusz Guzik if (lockmgr_sunlock_try(lk, &orig_x)) { 366047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 3670ad122a9SMateusz Guzik break; 3680ad122a9SMateusz Guzik } 3690ad122a9SMateusz Guzik 3700ad122a9SMateusz Guzik x |= LK_SHARERS_LOCK(1); 3710ad122a9SMateusz Guzik if (!atomic_fcmpset_rel_ptr(&lk->lk_lock, &x, v)) { 3720ad122a9SMateusz Guzik orig_x = x; 3730ad122a9SMateusz Guzik goto retry_sleepq; 374047dd67eSAttilio Rao } 375047dd67eSAttilio Rao LOCK_LOG3(lk, "%s: %p waking up threads on the %s queue", 376047dd67eSAttilio Rao __func__, lk, queue == SQ_SHARED_QUEUE ? "shared" : 377047dd67eSAttilio Rao "exclusive"); 3782028867dSAttilio Rao wakeup_swapper |= sleepq_broadcast(&lk->lock_object, SLEEPQ_LK, 379da7bbd2cSJohn Baldwin 0, queue); 380047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 381047dd67eSAttilio Rao break; 382047dd67eSAttilio Rao } 383047dd67eSAttilio Rao 384c4a48867SMateusz Guzik lockmgr_note_shared_release(lk, file, line); 385da7bbd2cSJohn Baldwin return (wakeup_swapper); 386047dd67eSAttilio Rao } 387047dd67eSAttilio Rao 388047dd67eSAttilio Rao static void 389d576deedSPawel Jakub Dawidek assert_lockmgr(const struct lock_object *lock, int what) 390f9721b43SAttilio Rao { 391f9721b43SAttilio Rao 392f9721b43SAttilio Rao panic("lockmgr locks do not support assertions"); 393f9721b43SAttilio Rao } 394f9721b43SAttilio Rao 395047dd67eSAttilio Rao static void 3967faf4d90SDavide Italiano lock_lockmgr(struct lock_object *lock, uintptr_t how) 3976e21afd4SJohn Baldwin { 3986e21afd4SJohn Baldwin 3996e21afd4SJohn Baldwin panic("lockmgr locks do not support sleep interlocking"); 4006e21afd4SJohn Baldwin } 4016e21afd4SJohn Baldwin 4027faf4d90SDavide Italiano static uintptr_t 4036e21afd4SJohn Baldwin unlock_lockmgr(struct lock_object *lock) 4046e21afd4SJohn Baldwin { 4056e21afd4SJohn Baldwin 4066e21afd4SJohn Baldwin panic("lockmgr locks do not support sleep interlocking"); 4076e21afd4SJohn Baldwin } 4086e21afd4SJohn Baldwin 409a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 410a5aedd68SStacey Son static int 411d576deedSPawel Jakub Dawidek owner_lockmgr(const struct lock_object *lock, struct thread **owner) 412a5aedd68SStacey Son { 413a5aedd68SStacey Son 414a5aedd68SStacey Son panic("lockmgr locks do not support owner inquiring"); 415a5aedd68SStacey Son } 416a5aedd68SStacey Son #endif 417a5aedd68SStacey Son 41899448ed1SJohn Dyson void 419047dd67eSAttilio Rao lockinit(struct lock *lk, int pri, const char *wmesg, int timo, int flags) 42099448ed1SJohn Dyson { 4216efc8a16SAttilio Rao int iflags; 4226efc8a16SAttilio Rao 423047dd67eSAttilio Rao MPASS((flags & ~LK_INIT_MASK) == 0); 424353998acSAttilio Rao ASSERT_ATOMIC_LOAD_PTR(lk->lk_lock, 425353998acSAttilio Rao ("%s: lockmgr not aligned for %s: %p", __func__, wmesg, 426353998acSAttilio Rao &lk->lk_lock)); 42799448ed1SJohn Dyson 428f0830182SAttilio Rao iflags = LO_SLEEPABLE | LO_UPGRADABLE; 429f0830182SAttilio Rao if (flags & LK_CANRECURSE) 430f0830182SAttilio Rao iflags |= LO_RECURSABLE; 431047dd67eSAttilio Rao if ((flags & LK_NODUP) == 0) 4326efc8a16SAttilio Rao iflags |= LO_DUPOK; 4337fbfba7bSAttilio Rao if (flags & LK_NOPROFILE) 4347fbfba7bSAttilio Rao iflags |= LO_NOPROFILE; 435047dd67eSAttilio Rao if ((flags & LK_NOWITNESS) == 0) 4366efc8a16SAttilio Rao iflags |= LO_WITNESS; 4377fbfba7bSAttilio Rao if (flags & LK_QUIET) 4387fbfba7bSAttilio Rao iflags |= LO_QUIET; 439e63091eaSMarcel Moolenaar if (flags & LK_IS_VNODE) 440e63091eaSMarcel Moolenaar iflags |= LO_IS_VNODE; 441651175c9SAttilio Rao iflags |= flags & (LK_ADAPTIVE | LK_NOSHARE); 442047dd67eSAttilio Rao 443b5fb43e5SJohn Baldwin lock_init(&lk->lock_object, &lock_class_lockmgr, wmesg, NULL, iflags); 444047dd67eSAttilio Rao lk->lk_lock = LK_UNLOCKED; 445047dd67eSAttilio Rao lk->lk_recurse = 0; 4462028867dSAttilio Rao lk->lk_exslpfail = 0; 447047dd67eSAttilio Rao lk->lk_timo = timo; 448047dd67eSAttilio Rao lk->lk_pri = pri; 449047dd67eSAttilio Rao STACK_ZERO(lk); 45099448ed1SJohn Dyson } 45199448ed1SJohn Dyson 4523634d5b2SJohn Baldwin /* 4533634d5b2SJohn Baldwin * XXX: Gross hacks to manipulate external lock flags after 4543634d5b2SJohn Baldwin * initialization. Used for certain vnode and buf locks. 4553634d5b2SJohn Baldwin */ 4563634d5b2SJohn Baldwin void 4573634d5b2SJohn Baldwin lockallowshare(struct lock *lk) 4583634d5b2SJohn Baldwin { 4593634d5b2SJohn Baldwin 4603634d5b2SJohn Baldwin lockmgr_assert(lk, KA_XLOCKED); 4613634d5b2SJohn Baldwin lk->lock_object.lo_flags &= ~LK_NOSHARE; 4623634d5b2SJohn Baldwin } 4633634d5b2SJohn Baldwin 4643634d5b2SJohn Baldwin void 465575e02d9SKonstantin Belousov lockdisableshare(struct lock *lk) 466575e02d9SKonstantin Belousov { 467575e02d9SKonstantin Belousov 468575e02d9SKonstantin Belousov lockmgr_assert(lk, KA_XLOCKED); 469575e02d9SKonstantin Belousov lk->lock_object.lo_flags |= LK_NOSHARE; 470575e02d9SKonstantin Belousov } 471575e02d9SKonstantin Belousov 472575e02d9SKonstantin Belousov void 4733634d5b2SJohn Baldwin lockallowrecurse(struct lock *lk) 4743634d5b2SJohn Baldwin { 4753634d5b2SJohn Baldwin 4763634d5b2SJohn Baldwin lockmgr_assert(lk, KA_XLOCKED); 4773634d5b2SJohn Baldwin lk->lock_object.lo_flags |= LO_RECURSABLE; 4783634d5b2SJohn Baldwin } 4793634d5b2SJohn Baldwin 4803634d5b2SJohn Baldwin void 4813634d5b2SJohn Baldwin lockdisablerecurse(struct lock *lk) 4823634d5b2SJohn Baldwin { 4833634d5b2SJohn Baldwin 4843634d5b2SJohn Baldwin lockmgr_assert(lk, KA_XLOCKED); 4853634d5b2SJohn Baldwin lk->lock_object.lo_flags &= ~LO_RECURSABLE; 4863634d5b2SJohn Baldwin } 4873634d5b2SJohn Baldwin 488a18b1f1dSJason Evans void 489047dd67eSAttilio Rao lockdestroy(struct lock *lk) 490a18b1f1dSJason Evans { 491c91fcee7SJohn Baldwin 492047dd67eSAttilio Rao KASSERT(lk->lk_lock == LK_UNLOCKED, ("lockmgr still held")); 493047dd67eSAttilio Rao KASSERT(lk->lk_recurse == 0, ("lockmgr still recursed")); 4942028867dSAttilio Rao KASSERT(lk->lk_exslpfail == 0, ("lockmgr still exclusive waiters")); 495047dd67eSAttilio Rao lock_destroy(&lk->lock_object); 496047dd67eSAttilio Rao } 497047dd67eSAttilio Rao 498c4a48867SMateusz Guzik static bool __always_inline 499c4a48867SMateusz Guzik lockmgr_slock_try(struct lock *lk, uintptr_t *xp, int flags) 500c4a48867SMateusz Guzik { 501c4a48867SMateusz Guzik 502c4a48867SMateusz Guzik /* 503c4a48867SMateusz Guzik * If no other thread has an exclusive lock, or 504c4a48867SMateusz Guzik * no exclusive waiter is present, bump the count of 505c4a48867SMateusz Guzik * sharers. Since we have to preserve the state of 506c4a48867SMateusz Guzik * waiters, if we fail to acquire the shared lock 507c4a48867SMateusz Guzik * loop back and retry. 508c4a48867SMateusz Guzik */ 509c4a48867SMateusz Guzik *xp = lk->lk_lock; 510c4a48867SMateusz Guzik while (LK_CAN_SHARE(*xp, flags)) { 511c4a48867SMateusz Guzik if (atomic_fcmpset_acq_ptr(&lk->lk_lock, xp, 512c4a48867SMateusz Guzik *xp + LK_ONE_SHARER)) { 513c4a48867SMateusz Guzik return (true); 514c4a48867SMateusz Guzik } 515c4a48867SMateusz Guzik } 516c4a48867SMateusz Guzik return (false); 517c4a48867SMateusz Guzik } 518c4a48867SMateusz Guzik 519c4a48867SMateusz Guzik static bool __always_inline 5201c6987ebSMateusz Guzik lockmgr_sunlock_try(struct lock *lk, uintptr_t *xp) 521c4a48867SMateusz Guzik { 522c4a48867SMateusz Guzik 523c4a48867SMateusz Guzik for (;;) { 524c4a48867SMateusz Guzik /* 525c4a48867SMateusz Guzik * If there is more than one shared lock held, just drop one 526c4a48867SMateusz Guzik * and return. 527c4a48867SMateusz Guzik */ 5281c6987ebSMateusz Guzik if (LK_SHARERS(*xp) > 1) { 5291c6987ebSMateusz Guzik if (atomic_fcmpset_rel_ptr(&lk->lk_lock, xp, 5301c6987ebSMateusz Guzik *xp - LK_ONE_SHARER)) 531c4a48867SMateusz Guzik return (true); 532c4a48867SMateusz Guzik continue; 533c4a48867SMateusz Guzik } 534c4a48867SMateusz Guzik 535c4a48867SMateusz Guzik /* 536c4a48867SMateusz Guzik * If there are not waiters on the exclusive queue, drop the 537c4a48867SMateusz Guzik * lock quickly. 538c4a48867SMateusz Guzik */ 5391c6987ebSMateusz Guzik if ((*xp & LK_ALL_WAITERS) == 0) { 5401c6987ebSMateusz Guzik MPASS((*xp & ~LK_EXCLUSIVE_SPINNERS) == 541c4a48867SMateusz Guzik LK_SHARERS_LOCK(1)); 5421c6987ebSMateusz Guzik if (atomic_fcmpset_rel_ptr(&lk->lk_lock, xp, 543c4a48867SMateusz Guzik LK_UNLOCKED)) 544c4a48867SMateusz Guzik return (true); 545c4a48867SMateusz Guzik continue; 546c4a48867SMateusz Guzik } 547c4a48867SMateusz Guzik break; 548c4a48867SMateusz Guzik } 549c4a48867SMateusz Guzik return (false); 550c4a48867SMateusz Guzik } 551c4a48867SMateusz Guzik 5521c6987ebSMateusz Guzik static __noinline int 5531c6987ebSMateusz Guzik lockmgr_slock_hard(struct lock *lk, u_int flags, struct lock_object *ilk, 5541c6987ebSMateusz Guzik const char *file, int line, struct lockmgr_wait *lwa) 555c4a48867SMateusz Guzik { 5561c6987ebSMateusz Guzik uintptr_t tid, x; 5571c6987ebSMateusz Guzik int error = 0; 558047dd67eSAttilio Rao const char *iwmesg; 5591c6987ebSMateusz Guzik int ipri, itimo; 5601c6987ebSMateusz Guzik 5611723a064SJeff Roberson #ifdef LOCK_PROFILING 5621723a064SJeff Roberson uint64_t waittime = 0; 5631723a064SJeff Roberson int contested = 0; 5641723a064SJeff Roberson #endif 565047dd67eSAttilio Rao 5661c6987ebSMateusz Guzik if (__predict_false(panicstr != NULL)) 5671c6987ebSMateusz Guzik goto out; 5681c6987ebSMateusz Guzik 569047dd67eSAttilio Rao tid = (uintptr_t)curthread; 570047dd67eSAttilio Rao 571e5f94314SAttilio Rao if (LK_CAN_WITNESS(flags)) 572e5f94314SAttilio Rao WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER, 57324150d37SJohn Baldwin file, line, flags & LK_INTERLOCK ? ilk : NULL); 574047dd67eSAttilio Rao for (;;) { 575c4a48867SMateusz Guzik if (lockmgr_slock_try(lk, &x, flags)) 576047dd67eSAttilio Rao break; 577f5f9340bSFabien Thomas #ifdef HWPMC_HOOKS 578f5f9340bSFabien Thomas PMC_SOFT_CALL( , , lock, failed); 579f5f9340bSFabien Thomas #endif 580047dd67eSAttilio Rao lock_profile_obtain_lock_failed(&lk->lock_object, 581047dd67eSAttilio Rao &contested, &waittime); 582047dd67eSAttilio Rao 583047dd67eSAttilio Rao /* 58496f1567fSKonstantin Belousov * If the lock is already held by curthread in 585047dd67eSAttilio Rao * exclusive way avoid a deadlock. 586047dd67eSAttilio Rao */ 587047dd67eSAttilio Rao if (LK_HOLDER(x) == tid) { 588047dd67eSAttilio Rao LOCK_LOG2(lk, 58996f1567fSKonstantin Belousov "%s: %p already held in exclusive mode", 590047dd67eSAttilio Rao __func__, lk); 591047dd67eSAttilio Rao error = EDEADLK; 592047dd67eSAttilio Rao break; 593a18b1f1dSJason Evans } 594a18b1f1dSJason Evans 595a18b1f1dSJason Evans /* 596047dd67eSAttilio Rao * If the lock is expected to not sleep just give up 597047dd67eSAttilio Rao * and return. 598d7a7e179SAttilio Rao */ 599047dd67eSAttilio Rao if (LK_TRYOP(flags)) { 600047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p fails the try operation", 601047dd67eSAttilio Rao __func__, lk); 602047dd67eSAttilio Rao error = EBUSY; 603047dd67eSAttilio Rao break; 604047dd67eSAttilio Rao } 605047dd67eSAttilio Rao 606047dd67eSAttilio Rao /* 607047dd67eSAttilio Rao * Acquire the sleepqueue chain lock because we 608047dd67eSAttilio Rao * probabilly will need to manipulate waiters flags. 609047dd67eSAttilio Rao */ 610047dd67eSAttilio Rao sleepq_lock(&lk->lock_object); 611047dd67eSAttilio Rao x = lk->lk_lock; 6120ad122a9SMateusz Guzik retry_sleepq: 613047dd67eSAttilio Rao 614047dd67eSAttilio Rao /* 615047dd67eSAttilio Rao * if the lock can be acquired in shared mode, try 616047dd67eSAttilio Rao * again. 617047dd67eSAttilio Rao */ 61872ba3c08SKonstantin Belousov if (LK_CAN_SHARE(x, flags)) { 619047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 620047dd67eSAttilio Rao continue; 621047dd67eSAttilio Rao } 622047dd67eSAttilio Rao 623047dd67eSAttilio Rao /* 624047dd67eSAttilio Rao * Try to set the LK_SHARED_WAITERS flag. If we fail, 625047dd67eSAttilio Rao * loop back and retry. 626047dd67eSAttilio Rao */ 627047dd67eSAttilio Rao if ((x & LK_SHARED_WAITERS) == 0) { 6280ad122a9SMateusz Guzik if (!atomic_fcmpset_acq_ptr(&lk->lk_lock, &x, 629047dd67eSAttilio Rao x | LK_SHARED_WAITERS)) { 6300ad122a9SMateusz Guzik goto retry_sleepq; 631047dd67eSAttilio Rao } 632047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p set shared waiters flag", 633047dd67eSAttilio Rao __func__, lk); 634047dd67eSAttilio Rao } 635047dd67eSAttilio Rao 6361c6987ebSMateusz Guzik if (lwa == NULL) { 6371c6987ebSMateusz Guzik iwmesg = lk->lock_object.lo_name; 6381c6987ebSMateusz Guzik ipri = lk->lk_pri; 6391c6987ebSMateusz Guzik itimo = lk->lk_timo; 6401c6987ebSMateusz Guzik } else { 6411c6987ebSMateusz Guzik iwmesg = lwa->iwmesg; 6421c6987ebSMateusz Guzik ipri = lwa->ipri; 6431c6987ebSMateusz Guzik itimo = lwa->itimo; 6441c6987ebSMateusz Guzik } 6451c6987ebSMateusz Guzik 646047dd67eSAttilio Rao /* 647047dd67eSAttilio Rao * As far as we have been unable to acquire the 648047dd67eSAttilio Rao * shared lock and the shared waiters flag is set, 649047dd67eSAttilio Rao * we will sleep. 650047dd67eSAttilio Rao */ 651047dd67eSAttilio Rao error = sleeplk(lk, flags, ilk, iwmesg, ipri, itimo, 652047dd67eSAttilio Rao SQ_SHARED_QUEUE); 653047dd67eSAttilio Rao flags &= ~LK_INTERLOCK; 654047dd67eSAttilio Rao if (error) { 655047dd67eSAttilio Rao LOCK_LOG3(lk, 656047dd67eSAttilio Rao "%s: interrupted sleep for %p with %d", 657047dd67eSAttilio Rao __func__, lk, error); 658047dd67eSAttilio Rao break; 659047dd67eSAttilio Rao } 660047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p resuming from the sleep queue", 661047dd67eSAttilio Rao __func__, lk); 662047dd67eSAttilio Rao } 663047dd67eSAttilio Rao if (error == 0) { 664c4a48867SMateusz Guzik #ifdef LOCK_PROFILING 665c4a48867SMateusz Guzik lockmgr_note_shared_acquire(lk, contested, waittime, 666c4a48867SMateusz Guzik file, line, flags); 667c4a48867SMateusz Guzik #else 668c4a48867SMateusz Guzik lockmgr_note_shared_acquire(lk, 0, 0, file, line, 669c4a48867SMateusz Guzik flags); 670c4a48867SMateusz Guzik #endif 671047dd67eSAttilio Rao } 672047dd67eSAttilio Rao 6731c6987ebSMateusz Guzik out: 6741c6987ebSMateusz Guzik lockmgr_exit(flags, ilk, 0); 6751c6987ebSMateusz Guzik return (error); 676047dd67eSAttilio Rao } 677047dd67eSAttilio Rao 6781c6987ebSMateusz Guzik static __noinline int 6791c6987ebSMateusz Guzik lockmgr_xlock_hard(struct lock *lk, u_int flags, struct lock_object *ilk, 6801c6987ebSMateusz Guzik const char *file, int line, struct lockmgr_wait *lwa) 6811c6987ebSMateusz Guzik { 6821c6987ebSMateusz Guzik struct lock_class *class; 6831c6987ebSMateusz Guzik uintptr_t tid, x, v; 6841c6987ebSMateusz Guzik int error = 0; 6851c6987ebSMateusz Guzik const char *iwmesg; 6861c6987ebSMateusz Guzik int ipri, itimo; 6877c6fe803SKonstantin Belousov 6881c6987ebSMateusz Guzik #ifdef LOCK_PROFILING 6891c6987ebSMateusz Guzik uint64_t waittime = 0; 6901c6987ebSMateusz Guzik int contested = 0; 6911c6987ebSMateusz Guzik #endif 692047dd67eSAttilio Rao 6931c6987ebSMateusz Guzik if (__predict_false(panicstr != NULL)) 6941c6987ebSMateusz Guzik goto out; 6951c6987ebSMateusz Guzik 6961c6987ebSMateusz Guzik tid = (uintptr_t)curthread; 6971c6987ebSMateusz Guzik 698e5f94314SAttilio Rao if (LK_CAN_WITNESS(flags)) 699e5f94314SAttilio Rao WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER | 70024150d37SJohn Baldwin LOP_EXCLUSIVE, file, line, flags & LK_INTERLOCK ? 70124150d37SJohn Baldwin ilk : NULL); 702047dd67eSAttilio Rao 703047dd67eSAttilio Rao /* 70496f1567fSKonstantin Belousov * If curthread already holds the lock and this one is 705047dd67eSAttilio Rao * allowed to recurse, simply recurse on it. 706047dd67eSAttilio Rao */ 707047dd67eSAttilio Rao if (lockmgr_xlocked(lk)) { 708047dd67eSAttilio Rao if ((flags & LK_CANRECURSE) == 0 && 709f0830182SAttilio Rao (lk->lock_object.lo_flags & LO_RECURSABLE) == 0) { 710047dd67eSAttilio Rao /* 711047dd67eSAttilio Rao * If the lock is expected to not panic just 712047dd67eSAttilio Rao * give up and return. 713047dd67eSAttilio Rao */ 714047dd67eSAttilio Rao if (LK_TRYOP(flags)) { 715047dd67eSAttilio Rao LOCK_LOG2(lk, 716047dd67eSAttilio Rao "%s: %p fails the try operation", 717047dd67eSAttilio Rao __func__, lk); 718047dd67eSAttilio Rao error = EBUSY; 7191c6987ebSMateusz Guzik goto out; 720047dd67eSAttilio Rao } 7211c6987ebSMateusz Guzik if (flags & LK_INTERLOCK) { 7221c6987ebSMateusz Guzik class = LOCK_CLASS(ilk); 723047dd67eSAttilio Rao class->lc_unlock(ilk); 7241c6987ebSMateusz Guzik } 72583fc34eaSGleb Smirnoff panic("%s: recursing on non recursive lockmgr %p " 72683fc34eaSGleb Smirnoff "@ %s:%d\n", __func__, lk, file, line); 727047dd67eSAttilio Rao } 728047dd67eSAttilio Rao lk->lk_recurse++; 729047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p recursing", __func__, lk); 730047dd67eSAttilio Rao LOCK_LOG_LOCK("XLOCK", &lk->lock_object, 0, 731047dd67eSAttilio Rao lk->lk_recurse, file, line); 732e5f94314SAttilio Rao WITNESS_LOCK(&lk->lock_object, LOP_EXCLUSIVE | 733e5f94314SAttilio Rao LK_TRYWIT(flags), file, line); 734047dd67eSAttilio Rao TD_LOCKS_INC(curthread); 7351c6987ebSMateusz Guzik goto out; 736047dd67eSAttilio Rao } 737047dd67eSAttilio Rao 738fc4f686dSMateusz Guzik for (;;) { 739fc4f686dSMateusz Guzik if (lk->lk_lock == LK_UNLOCKED && 740fc4f686dSMateusz Guzik atomic_cmpset_acq_ptr(&lk->lk_lock, LK_UNLOCKED, tid)) 741fc4f686dSMateusz Guzik break; 742f5f9340bSFabien Thomas #ifdef HWPMC_HOOKS 743f5f9340bSFabien Thomas PMC_SOFT_CALL( , , lock, failed); 744f5f9340bSFabien Thomas #endif 745047dd67eSAttilio Rao lock_profile_obtain_lock_failed(&lk->lock_object, 746047dd67eSAttilio Rao &contested, &waittime); 747047dd67eSAttilio Rao 748047dd67eSAttilio Rao /* 749047dd67eSAttilio Rao * If the lock is expected to not sleep just give up 750047dd67eSAttilio Rao * and return. 751047dd67eSAttilio Rao */ 752047dd67eSAttilio Rao if (LK_TRYOP(flags)) { 753047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p fails the try operation", 754047dd67eSAttilio Rao __func__, lk); 755047dd67eSAttilio Rao error = EBUSY; 756047dd67eSAttilio Rao break; 757047dd67eSAttilio Rao } 758047dd67eSAttilio Rao 759047dd67eSAttilio Rao /* 760047dd67eSAttilio Rao * Acquire the sleepqueue chain lock because we 761047dd67eSAttilio Rao * probabilly will need to manipulate waiters flags. 762047dd67eSAttilio Rao */ 763047dd67eSAttilio Rao sleepq_lock(&lk->lock_object); 764047dd67eSAttilio Rao x = lk->lk_lock; 7650ad122a9SMateusz Guzik retry_sleepq: 766047dd67eSAttilio Rao 767047dd67eSAttilio Rao /* 768047dd67eSAttilio Rao * if the lock has been released while we spun on 769047dd67eSAttilio Rao * the sleepqueue chain lock just try again. 770047dd67eSAttilio Rao */ 771047dd67eSAttilio Rao if (x == LK_UNLOCKED) { 772047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 773047dd67eSAttilio Rao continue; 774047dd67eSAttilio Rao } 775047dd67eSAttilio Rao 776047dd67eSAttilio Rao /* 777047dd67eSAttilio Rao * The lock can be in the state where there is a 778047dd67eSAttilio Rao * pending queue of waiters, but still no owner. 779047dd67eSAttilio Rao * This happens when the lock is contested and an 780047dd67eSAttilio Rao * owner is going to claim the lock. 781047dd67eSAttilio Rao * If curthread is the one successfully acquiring it 782047dd67eSAttilio Rao * claim lock ownership and return, preserving waiters 783047dd67eSAttilio Rao * flags. 784047dd67eSAttilio Rao */ 785651175c9SAttilio Rao v = x & (LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS); 786651175c9SAttilio Rao if ((x & ~v) == LK_UNLOCKED) { 787651175c9SAttilio Rao v &= ~LK_EXCLUSIVE_SPINNERS; 7880ad122a9SMateusz Guzik if (atomic_fcmpset_acq_ptr(&lk->lk_lock, &x, 789047dd67eSAttilio Rao tid | v)) { 790047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 791047dd67eSAttilio Rao LOCK_LOG2(lk, 792047dd67eSAttilio Rao "%s: %p claimed by a new writer", 793047dd67eSAttilio Rao __func__, lk); 794047dd67eSAttilio Rao break; 795047dd67eSAttilio Rao } 7960ad122a9SMateusz Guzik goto retry_sleepq; 797047dd67eSAttilio Rao } 798047dd67eSAttilio Rao 799047dd67eSAttilio Rao /* 800047dd67eSAttilio Rao * Try to set the LK_EXCLUSIVE_WAITERS flag. If we 801047dd67eSAttilio Rao * fail, loop back and retry. 802047dd67eSAttilio Rao */ 803047dd67eSAttilio Rao if ((x & LK_EXCLUSIVE_WAITERS) == 0) { 8040ad122a9SMateusz Guzik if (!atomic_fcmpset_ptr(&lk->lk_lock, &x, 805047dd67eSAttilio Rao x | LK_EXCLUSIVE_WAITERS)) { 8060ad122a9SMateusz Guzik goto retry_sleepq; 807047dd67eSAttilio Rao } 808047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p set excl waiters flag", 809047dd67eSAttilio Rao __func__, lk); 810047dd67eSAttilio Rao } 811047dd67eSAttilio Rao 8121c6987ebSMateusz Guzik if (lwa == NULL) { 8131c6987ebSMateusz Guzik iwmesg = lk->lock_object.lo_name; 8141c6987ebSMateusz Guzik ipri = lk->lk_pri; 8151c6987ebSMateusz Guzik itimo = lk->lk_timo; 8161c6987ebSMateusz Guzik } else { 8171c6987ebSMateusz Guzik iwmesg = lwa->iwmesg; 8181c6987ebSMateusz Guzik ipri = lwa->ipri; 8191c6987ebSMateusz Guzik itimo = lwa->itimo; 8201c6987ebSMateusz Guzik } 8211c6987ebSMateusz Guzik 822047dd67eSAttilio Rao /* 823047dd67eSAttilio Rao * As far as we have been unable to acquire the 824047dd67eSAttilio Rao * exclusive lock and the exclusive waiters flag 825047dd67eSAttilio Rao * is set, we will sleep. 826047dd67eSAttilio Rao */ 827047dd67eSAttilio Rao error = sleeplk(lk, flags, ilk, iwmesg, ipri, itimo, 828047dd67eSAttilio Rao SQ_EXCLUSIVE_QUEUE); 829047dd67eSAttilio Rao flags &= ~LK_INTERLOCK; 830047dd67eSAttilio Rao if (error) { 831047dd67eSAttilio Rao LOCK_LOG3(lk, 832047dd67eSAttilio Rao "%s: interrupted sleep for %p with %d", 833047dd67eSAttilio Rao __func__, lk, error); 834047dd67eSAttilio Rao break; 835047dd67eSAttilio Rao } 836047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p resuming from the sleep queue", 837047dd67eSAttilio Rao __func__, lk); 838047dd67eSAttilio Rao } 839047dd67eSAttilio Rao if (error == 0) { 840c4a48867SMateusz Guzik #ifdef LOCK_PROFILING 841c4a48867SMateusz Guzik lockmgr_note_exclusive_acquire(lk, contested, waittime, 842c4a48867SMateusz Guzik file, line, flags); 843c4a48867SMateusz Guzik #else 844c4a48867SMateusz Guzik lockmgr_note_exclusive_acquire(lk, 0, 0, file, line, 845c4a48867SMateusz Guzik flags); 846c4a48867SMateusz Guzik #endif 847047dd67eSAttilio Rao } 8481c6987ebSMateusz Guzik 8491c6987ebSMateusz Guzik out: 8501c6987ebSMateusz Guzik lockmgr_exit(flags, ilk, 0); 8511c6987ebSMateusz Guzik return (error); 8521c6987ebSMateusz Guzik } 8531c6987ebSMateusz Guzik 8541c6987ebSMateusz Guzik static __noinline int 8551c6987ebSMateusz Guzik lockmgr_upgrade(struct lock *lk, u_int flags, struct lock_object *ilk, 8561c6987ebSMateusz Guzik const char *file, int line, struct lockmgr_wait *lwa) 8571c6987ebSMateusz Guzik { 8581c6987ebSMateusz Guzik uintptr_t tid, x, v; 8591c6987ebSMateusz Guzik int error = 0; 8601c6987ebSMateusz Guzik int wakeup_swapper = 0; 8611c6987ebSMateusz Guzik int op; 8621c6987ebSMateusz Guzik 8631c6987ebSMateusz Guzik if (__predict_false(panicstr != NULL)) 8641c6987ebSMateusz Guzik goto out; 8651c6987ebSMateusz Guzik 8661c6987ebSMateusz Guzik tid = (uintptr_t)curthread; 8671c6987ebSMateusz Guzik 8681c6987ebSMateusz Guzik _lockmgr_assert(lk, KA_SLOCKED, file, line); 8691c6987ebSMateusz Guzik v = lk->lk_lock; 8701c6987ebSMateusz Guzik x = v & LK_ALL_WAITERS; 8711c6987ebSMateusz Guzik v &= LK_EXCLUSIVE_SPINNERS; 8721c6987ebSMateusz Guzik 8731c6987ebSMateusz Guzik /* 8741c6987ebSMateusz Guzik * Try to switch from one shared lock to an exclusive one. 8751c6987ebSMateusz Guzik * We need to preserve waiters flags during the operation. 8761c6987ebSMateusz Guzik */ 8771c6987ebSMateusz Guzik if (atomic_cmpset_ptr(&lk->lk_lock, LK_SHARERS_LOCK(1) | x | v, 8781c6987ebSMateusz Guzik tid | x)) { 8791c6987ebSMateusz Guzik LOCK_LOG_LOCK("XUPGRADE", &lk->lock_object, 0, 0, file, 8801c6987ebSMateusz Guzik line); 8811c6987ebSMateusz Guzik WITNESS_UPGRADE(&lk->lock_object, LOP_EXCLUSIVE | 8821c6987ebSMateusz Guzik LK_TRYWIT(flags), file, line); 8831c6987ebSMateusz Guzik TD_SLOCKS_DEC(curthread); 8841c6987ebSMateusz Guzik goto out; 8851c6987ebSMateusz Guzik } 8861c6987ebSMateusz Guzik 8871c6987ebSMateusz Guzik op = flags & LK_TYPE_MASK; 8881c6987ebSMateusz Guzik 8891c6987ebSMateusz Guzik /* 8901c6987ebSMateusz Guzik * In LK_TRYUPGRADE mode, do not drop the lock, 8911c6987ebSMateusz Guzik * returning EBUSY instead. 8921c6987ebSMateusz Guzik */ 8931c6987ebSMateusz Guzik if (op == LK_TRYUPGRADE) { 8941c6987ebSMateusz Guzik LOCK_LOG2(lk, "%s: %p failed the nowait upgrade", 8951c6987ebSMateusz Guzik __func__, lk); 8961c6987ebSMateusz Guzik error = EBUSY; 8971c6987ebSMateusz Guzik goto out; 8981c6987ebSMateusz Guzik } 8991c6987ebSMateusz Guzik 9001c6987ebSMateusz Guzik /* 9011c6987ebSMateusz Guzik * We have been unable to succeed in upgrading, so just 9021c6987ebSMateusz Guzik * give up the shared lock. 9031c6987ebSMateusz Guzik */ 9041c6987ebSMateusz Guzik wakeup_swapper |= wakeupshlk(lk, file, line); 9051c6987ebSMateusz Guzik error = lockmgr_xlock_hard(lk, flags, ilk, file, line, lwa); 9061c6987ebSMateusz Guzik flags &= ~LK_INTERLOCK; 9071c6987ebSMateusz Guzik out: 9081c6987ebSMateusz Guzik lockmgr_exit(flags, ilk, wakeup_swapper); 9091c6987ebSMateusz Guzik return (error); 9101c6987ebSMateusz Guzik } 9111c6987ebSMateusz Guzik 9121c6987ebSMateusz Guzik int 9131c6987ebSMateusz Guzik lockmgr_lock_fast_path(struct lock *lk, u_int flags, struct lock_object *ilk, 9141c6987ebSMateusz Guzik const char *file, int line) 9151c6987ebSMateusz Guzik { 9161c6987ebSMateusz Guzik struct lock_class *class; 9171c6987ebSMateusz Guzik uintptr_t x, tid; 9181c6987ebSMateusz Guzik u_int op; 9191c6987ebSMateusz Guzik bool locked; 9201c6987ebSMateusz Guzik 921*b543c98cSConrad Meyer if (__predict_false(panicstr != NULL)) 922*b543c98cSConrad Meyer return (0); 923*b543c98cSConrad Meyer 9241c6987ebSMateusz Guzik op = flags & LK_TYPE_MASK; 9251c6987ebSMateusz Guzik locked = false; 9261c6987ebSMateusz Guzik switch (op) { 9271c6987ebSMateusz Guzik case LK_SHARED: 9281c6987ebSMateusz Guzik if (LK_CAN_WITNESS(flags)) 9291c6987ebSMateusz Guzik WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER, 9301c6987ebSMateusz Guzik file, line, flags & LK_INTERLOCK ? ilk : NULL); 9311c6987ebSMateusz Guzik if (__predict_false(lk->lock_object.lo_flags & LK_NOSHARE)) 9321c6987ebSMateusz Guzik break; 9331c6987ebSMateusz Guzik if (lockmgr_slock_try(lk, &x, flags)) { 9341c6987ebSMateusz Guzik lockmgr_note_shared_acquire(lk, 0, 0, 9351c6987ebSMateusz Guzik file, line, flags); 9361c6987ebSMateusz Guzik locked = true; 9371c6987ebSMateusz Guzik } else { 9381c6987ebSMateusz Guzik return (lockmgr_slock_hard(lk, flags, ilk, file, line, 9391c6987ebSMateusz Guzik NULL)); 9401c6987ebSMateusz Guzik } 9411c6987ebSMateusz Guzik break; 9421c6987ebSMateusz Guzik case LK_EXCLUSIVE: 9431c6987ebSMateusz Guzik if (LK_CAN_WITNESS(flags)) 9441c6987ebSMateusz Guzik WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER | 9451c6987ebSMateusz Guzik LOP_EXCLUSIVE, file, line, flags & LK_INTERLOCK ? 9461c6987ebSMateusz Guzik ilk : NULL); 9471c6987ebSMateusz Guzik tid = (uintptr_t)curthread; 9481c6987ebSMateusz Guzik if (lk->lk_lock == LK_UNLOCKED && 9491c6987ebSMateusz Guzik atomic_cmpset_acq_ptr(&lk->lk_lock, LK_UNLOCKED, tid)) { 9501c6987ebSMateusz Guzik lockmgr_note_exclusive_acquire(lk, 0, 0, file, line, 9511c6987ebSMateusz Guzik flags); 9521c6987ebSMateusz Guzik locked = true; 9531c6987ebSMateusz Guzik } else { 9541c6987ebSMateusz Guzik return (lockmgr_xlock_hard(lk, flags, ilk, file, line, 9551c6987ebSMateusz Guzik NULL)); 9561c6987ebSMateusz Guzik } 9571c6987ebSMateusz Guzik break; 9581c6987ebSMateusz Guzik case LK_UPGRADE: 9591c6987ebSMateusz Guzik case LK_TRYUPGRADE: 9601c6987ebSMateusz Guzik return (lockmgr_upgrade(lk, flags, ilk, file, line, NULL)); 9611c6987ebSMateusz Guzik default: 9621c6987ebSMateusz Guzik break; 9631c6987ebSMateusz Guzik } 9641c6987ebSMateusz Guzik if (__predict_true(locked)) { 9651c6987ebSMateusz Guzik if (__predict_false(flags & LK_INTERLOCK)) { 9661c6987ebSMateusz Guzik class = LOCK_CLASS(ilk); 9671c6987ebSMateusz Guzik class->lc_unlock(ilk); 9681c6987ebSMateusz Guzik } 9691c6987ebSMateusz Guzik return (0); 9701c6987ebSMateusz Guzik } else { 9711c6987ebSMateusz Guzik return (__lockmgr_args(lk, flags, ilk, LK_WMESG_DEFAULT, 9721c6987ebSMateusz Guzik LK_PRIO_DEFAULT, LK_TIMO_DEFAULT, file, line)); 9731c6987ebSMateusz Guzik } 9741c6987ebSMateusz Guzik } 9751c6987ebSMateusz Guzik 9761c6987ebSMateusz Guzik static __noinline int 9771c6987ebSMateusz Guzik lockmgr_sunlock_hard(struct lock *lk, uintptr_t x, u_int flags, struct lock_object *ilk, 9781c6987ebSMateusz Guzik const char *file, int line) 9791c6987ebSMateusz Guzik 9801c6987ebSMateusz Guzik { 9811c6987ebSMateusz Guzik int wakeup_swapper = 0; 9821c6987ebSMateusz Guzik 9831c6987ebSMateusz Guzik if (__predict_false(panicstr != NULL)) 9841c6987ebSMateusz Guzik goto out; 9851c6987ebSMateusz Guzik 9861c6987ebSMateusz Guzik wakeup_swapper = wakeupshlk(lk, file, line); 9871c6987ebSMateusz Guzik 9881c6987ebSMateusz Guzik out: 9891c6987ebSMateusz Guzik lockmgr_exit(flags, ilk, wakeup_swapper); 9901c6987ebSMateusz Guzik return (0); 9911c6987ebSMateusz Guzik } 9921c6987ebSMateusz Guzik 9931c6987ebSMateusz Guzik static __noinline int 9941c6987ebSMateusz Guzik lockmgr_xunlock_hard(struct lock *lk, uintptr_t x, u_int flags, struct lock_object *ilk, 9951c6987ebSMateusz Guzik const char *file, int line) 9961c6987ebSMateusz Guzik { 9971c6987ebSMateusz Guzik uintptr_t tid, v; 9981c6987ebSMateusz Guzik int wakeup_swapper = 0; 9991c6987ebSMateusz Guzik u_int realexslp; 10001c6987ebSMateusz Guzik int queue; 10011c6987ebSMateusz Guzik 10021c6987ebSMateusz Guzik if (__predict_false(panicstr != NULL)) 10031c6987ebSMateusz Guzik goto out; 10041c6987ebSMateusz Guzik 10051c6987ebSMateusz Guzik tid = (uintptr_t)curthread; 10061c6987ebSMateusz Guzik 10071c6987ebSMateusz Guzik /* 10081c6987ebSMateusz Guzik * As first option, treact the lock as if it has not 10091c6987ebSMateusz Guzik * any waiter. 10101c6987ebSMateusz Guzik * Fix-up the tid var if the lock has been disowned. 10111c6987ebSMateusz Guzik */ 10121c6987ebSMateusz Guzik if (LK_HOLDER(x) == LK_KERNPROC) 10131c6987ebSMateusz Guzik tid = LK_KERNPROC; 10141c6987ebSMateusz Guzik else { 10151c6987ebSMateusz Guzik WITNESS_UNLOCK(&lk->lock_object, LOP_EXCLUSIVE, file, line); 10161c6987ebSMateusz Guzik TD_LOCKS_DEC(curthread); 10171c6987ebSMateusz Guzik } 10181c6987ebSMateusz Guzik LOCK_LOG_LOCK("XUNLOCK", &lk->lock_object, 0, lk->lk_recurse, file, line); 10191c6987ebSMateusz Guzik 10201c6987ebSMateusz Guzik /* 10211c6987ebSMateusz Guzik * The lock is held in exclusive mode. 10221c6987ebSMateusz Guzik * If the lock is recursed also, then unrecurse it. 10231c6987ebSMateusz Guzik */ 10241c6987ebSMateusz Guzik if (lockmgr_xlocked(lk) && lockmgr_recursed(lk)) { 10251c6987ebSMateusz Guzik LOCK_LOG2(lk, "%s: %p unrecursing", __func__, lk); 10261c6987ebSMateusz Guzik lk->lk_recurse--; 10271c6987ebSMateusz Guzik goto out; 10281c6987ebSMateusz Guzik } 10291c6987ebSMateusz Guzik if (tid != LK_KERNPROC) 10301c6987ebSMateusz Guzik lock_profile_release_lock(&lk->lock_object); 10311c6987ebSMateusz Guzik 10321c6987ebSMateusz Guzik if (atomic_cmpset_rel_ptr(&lk->lk_lock, tid, LK_UNLOCKED)) 10331c6987ebSMateusz Guzik goto out; 10341c6987ebSMateusz Guzik 10351c6987ebSMateusz Guzik sleepq_lock(&lk->lock_object); 10361c6987ebSMateusz Guzik x = lk->lk_lock; 10371c6987ebSMateusz Guzik v = LK_UNLOCKED; 10381c6987ebSMateusz Guzik 10391c6987ebSMateusz Guzik /* 10401c6987ebSMateusz Guzik * If the lock has exclusive waiters, give them 10411c6987ebSMateusz Guzik * preference in order to avoid deadlock with 10421c6987ebSMateusz Guzik * shared runners up. 10431c6987ebSMateusz Guzik * If interruptible sleeps left the exclusive queue 10441c6987ebSMateusz Guzik * empty avoid a starvation for the threads sleeping 10451c6987ebSMateusz Guzik * on the shared queue by giving them precedence 10461c6987ebSMateusz Guzik * and cleaning up the exclusive waiters bit anyway. 10471c6987ebSMateusz Guzik * Please note that lk_exslpfail count may be lying 10481c6987ebSMateusz Guzik * about the real number of waiters with the 10491c6987ebSMateusz Guzik * LK_SLEEPFAIL flag on because they may be used in 10501c6987ebSMateusz Guzik * conjunction with interruptible sleeps so 10511c6987ebSMateusz Guzik * lk_exslpfail might be considered an 'upper limit' 10521c6987ebSMateusz Guzik * bound, including the edge cases. 10531c6987ebSMateusz Guzik */ 10541c6987ebSMateusz Guzik MPASS((x & LK_EXCLUSIVE_SPINNERS) == 0); 10551c6987ebSMateusz Guzik realexslp = sleepq_sleepcnt(&lk->lock_object, SQ_EXCLUSIVE_QUEUE); 10561c6987ebSMateusz Guzik if ((x & LK_EXCLUSIVE_WAITERS) != 0 && realexslp != 0) { 10571c6987ebSMateusz Guzik if (lk->lk_exslpfail < realexslp) { 10581c6987ebSMateusz Guzik lk->lk_exslpfail = 0; 10591c6987ebSMateusz Guzik queue = SQ_EXCLUSIVE_QUEUE; 10601c6987ebSMateusz Guzik v |= (x & LK_SHARED_WAITERS); 10611c6987ebSMateusz Guzik } else { 10621c6987ebSMateusz Guzik lk->lk_exslpfail = 0; 10631c6987ebSMateusz Guzik LOCK_LOG2(lk, 10641c6987ebSMateusz Guzik "%s: %p has only LK_SLEEPFAIL sleepers", 10651c6987ebSMateusz Guzik __func__, lk); 10661c6987ebSMateusz Guzik LOCK_LOG2(lk, 10671c6987ebSMateusz Guzik "%s: %p waking up threads on the exclusive queue", 10681c6987ebSMateusz Guzik __func__, lk); 10691c6987ebSMateusz Guzik wakeup_swapper = sleepq_broadcast(&lk->lock_object, 10701c6987ebSMateusz Guzik SLEEPQ_LK, 0, SQ_EXCLUSIVE_QUEUE); 10711c6987ebSMateusz Guzik queue = SQ_SHARED_QUEUE; 10721c6987ebSMateusz Guzik } 10731c6987ebSMateusz Guzik } else { 10741c6987ebSMateusz Guzik 10751c6987ebSMateusz Guzik /* 10761c6987ebSMateusz Guzik * Exclusive waiters sleeping with LK_SLEEPFAIL 10771c6987ebSMateusz Guzik * on and using interruptible sleeps/timeout 10781c6987ebSMateusz Guzik * may have left spourious lk_exslpfail counts 10791c6987ebSMateusz Guzik * on, so clean it up anyway. 10801c6987ebSMateusz Guzik */ 10811c6987ebSMateusz Guzik lk->lk_exslpfail = 0; 10821c6987ebSMateusz Guzik queue = SQ_SHARED_QUEUE; 10831c6987ebSMateusz Guzik } 10841c6987ebSMateusz Guzik 10851c6987ebSMateusz Guzik LOCK_LOG3(lk, "%s: %p waking up threads on the %s queue", 10861c6987ebSMateusz Guzik __func__, lk, queue == SQ_SHARED_QUEUE ? "shared" : 10871c6987ebSMateusz Guzik "exclusive"); 10881c6987ebSMateusz Guzik atomic_store_rel_ptr(&lk->lk_lock, v); 10891c6987ebSMateusz Guzik wakeup_swapper |= sleepq_broadcast(&lk->lock_object, SLEEPQ_LK, 0, queue); 10901c6987ebSMateusz Guzik sleepq_release(&lk->lock_object); 10911c6987ebSMateusz Guzik 10921c6987ebSMateusz Guzik out: 10931c6987ebSMateusz Guzik lockmgr_exit(flags, ilk, wakeup_swapper); 10941c6987ebSMateusz Guzik return (0); 10951c6987ebSMateusz Guzik } 10961c6987ebSMateusz Guzik 10971c6987ebSMateusz Guzik int 10981c6987ebSMateusz Guzik lockmgr_unlock_fast_path(struct lock *lk, u_int flags, struct lock_object *ilk) 10991c6987ebSMateusz Guzik { 11001c6987ebSMateusz Guzik struct lock_class *class; 11011c6987ebSMateusz Guzik uintptr_t x, tid; 11021c6987ebSMateusz Guzik bool unlocked; 11031c6987ebSMateusz Guzik const char *file; 11041c6987ebSMateusz Guzik int line; 11051c6987ebSMateusz Guzik 1106*b543c98cSConrad Meyer if (__predict_false(panicstr != NULL)) 1107*b543c98cSConrad Meyer return (0); 1108*b543c98cSConrad Meyer 11091c6987ebSMateusz Guzik file = __FILE__; 11101c6987ebSMateusz Guzik line = __LINE__; 11111c6987ebSMateusz Guzik 11121c6987ebSMateusz Guzik _lockmgr_assert(lk, KA_LOCKED, file, line); 11131c6987ebSMateusz Guzik unlocked = false; 11141c6987ebSMateusz Guzik x = lk->lk_lock; 11151c6987ebSMateusz Guzik if (__predict_true(x & LK_SHARE) != 0) { 11161c6987ebSMateusz Guzik if (lockmgr_sunlock_try(lk, &x)) { 11171c6987ebSMateusz Guzik lockmgr_note_shared_release(lk, file, line); 11181c6987ebSMateusz Guzik unlocked = true; 11191c6987ebSMateusz Guzik } else { 11201c6987ebSMateusz Guzik return (lockmgr_sunlock_hard(lk, x, flags, ilk, file, line)); 11211c6987ebSMateusz Guzik } 11221c6987ebSMateusz Guzik } else { 11231c6987ebSMateusz Guzik tid = (uintptr_t)curthread; 11241c6987ebSMateusz Guzik if (!lockmgr_recursed(lk) && 11251c6987ebSMateusz Guzik atomic_cmpset_rel_ptr(&lk->lk_lock, tid, LK_UNLOCKED)) { 11261c6987ebSMateusz Guzik lockmgr_note_exclusive_release(lk, file, line); 11271c6987ebSMateusz Guzik unlocked = true; 11281c6987ebSMateusz Guzik } else { 11291c6987ebSMateusz Guzik return (lockmgr_xunlock_hard(lk, x, flags, ilk, file, line)); 11301c6987ebSMateusz Guzik } 11311c6987ebSMateusz Guzik } 11321c6987ebSMateusz Guzik if (__predict_false(flags & LK_INTERLOCK)) { 11331c6987ebSMateusz Guzik class = LOCK_CLASS(ilk); 11341c6987ebSMateusz Guzik class->lc_unlock(ilk); 11351c6987ebSMateusz Guzik } 11361c6987ebSMateusz Guzik return (0); 11371c6987ebSMateusz Guzik } 11381c6987ebSMateusz Guzik 11391c6987ebSMateusz Guzik int 11401c6987ebSMateusz Guzik __lockmgr_args(struct lock *lk, u_int flags, struct lock_object *ilk, 11411c6987ebSMateusz Guzik const char *wmesg, int pri, int timo, const char *file, int line) 11421c6987ebSMateusz Guzik { 11431c6987ebSMateusz Guzik GIANT_DECLARE; 11441c6987ebSMateusz Guzik struct lockmgr_wait lwa; 11451c6987ebSMateusz Guzik struct lock_class *class; 11461c6987ebSMateusz Guzik const char *iwmesg; 11471c6987ebSMateusz Guzik uintptr_t tid, v, x; 11481c6987ebSMateusz Guzik u_int op, realexslp; 11491c6987ebSMateusz Guzik int error, ipri, itimo, queue, wakeup_swapper; 11501c6987ebSMateusz Guzik #ifdef LOCK_PROFILING 11511c6987ebSMateusz Guzik uint64_t waittime = 0; 11521c6987ebSMateusz Guzik int contested = 0; 11531c6987ebSMateusz Guzik #endif 11541c6987ebSMateusz Guzik 1155*b543c98cSConrad Meyer if (panicstr != NULL) 1156*b543c98cSConrad Meyer return (0); 1157*b543c98cSConrad Meyer 11581c6987ebSMateusz Guzik error = 0; 11591c6987ebSMateusz Guzik tid = (uintptr_t)curthread; 11601c6987ebSMateusz Guzik op = (flags & LK_TYPE_MASK); 11611c6987ebSMateusz Guzik iwmesg = (wmesg == LK_WMESG_DEFAULT) ? lk->lock_object.lo_name : wmesg; 11621c6987ebSMateusz Guzik ipri = (pri == LK_PRIO_DEFAULT) ? lk->lk_pri : pri; 11631c6987ebSMateusz Guzik itimo = (timo == LK_TIMO_DEFAULT) ? lk->lk_timo : timo; 11641c6987ebSMateusz Guzik 11651c6987ebSMateusz Guzik lwa.iwmesg = iwmesg; 11661c6987ebSMateusz Guzik lwa.ipri = ipri; 11671c6987ebSMateusz Guzik lwa.itimo = itimo; 11681c6987ebSMateusz Guzik 11691c6987ebSMateusz Guzik MPASS((flags & ~LK_TOTAL_MASK) == 0); 11701c6987ebSMateusz Guzik KASSERT((op & (op - 1)) == 0, 11711c6987ebSMateusz Guzik ("%s: Invalid requested operation @ %s:%d", __func__, file, line)); 11721c6987ebSMateusz Guzik KASSERT((flags & (LK_NOWAIT | LK_SLEEPFAIL)) == 0 || 11731c6987ebSMateusz Guzik (op != LK_DOWNGRADE && op != LK_RELEASE), 11741c6987ebSMateusz Guzik ("%s: Invalid flags in regard of the operation desired @ %s:%d", 11751c6987ebSMateusz Guzik __func__, file, line)); 11761c6987ebSMateusz Guzik KASSERT((flags & LK_INTERLOCK) == 0 || ilk != NULL, 11771c6987ebSMateusz Guzik ("%s: LK_INTERLOCK passed without valid interlock @ %s:%d", 11781c6987ebSMateusz Guzik __func__, file, line)); 11791c6987ebSMateusz Guzik KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 11801c6987ebSMateusz Guzik ("%s: idle thread %p on lockmgr %s @ %s:%d", __func__, curthread, 11811c6987ebSMateusz Guzik lk->lock_object.lo_name, file, line)); 11821c6987ebSMateusz Guzik 11831c6987ebSMateusz Guzik class = (flags & LK_INTERLOCK) ? LOCK_CLASS(ilk) : NULL; 11841c6987ebSMateusz Guzik 11851c6987ebSMateusz Guzik if (lk->lock_object.lo_flags & LK_NOSHARE) { 11861c6987ebSMateusz Guzik switch (op) { 11871c6987ebSMateusz Guzik case LK_SHARED: 11881c6987ebSMateusz Guzik op = LK_EXCLUSIVE; 11891c6987ebSMateusz Guzik break; 11901c6987ebSMateusz Guzik case LK_UPGRADE: 11911c6987ebSMateusz Guzik case LK_TRYUPGRADE: 11921c6987ebSMateusz Guzik case LK_DOWNGRADE: 11931c6987ebSMateusz Guzik _lockmgr_assert(lk, KA_XLOCKED | KA_NOTRECURSED, 11941c6987ebSMateusz Guzik file, line); 11951c6987ebSMateusz Guzik if (flags & LK_INTERLOCK) 11961c6987ebSMateusz Guzik class->lc_unlock(ilk); 11971c6987ebSMateusz Guzik return (0); 11981c6987ebSMateusz Guzik } 11991c6987ebSMateusz Guzik } 12001c6987ebSMateusz Guzik 12011c6987ebSMateusz Guzik wakeup_swapper = 0; 12021c6987ebSMateusz Guzik switch (op) { 12031c6987ebSMateusz Guzik case LK_SHARED: 12041c6987ebSMateusz Guzik return (lockmgr_slock_hard(lk, flags, ilk, file, line, &lwa)); 12051c6987ebSMateusz Guzik break; 12061c6987ebSMateusz Guzik case LK_UPGRADE: 12071c6987ebSMateusz Guzik case LK_TRYUPGRADE: 12081c6987ebSMateusz Guzik return (lockmgr_upgrade(lk, flags, ilk, file, line, &lwa)); 12091c6987ebSMateusz Guzik break; 12101c6987ebSMateusz Guzik case LK_EXCLUSIVE: 12111c6987ebSMateusz Guzik return (lockmgr_xlock_hard(lk, flags, ilk, file, line, &lwa)); 1212047dd67eSAttilio Rao break; 1213047dd67eSAttilio Rao case LK_DOWNGRADE: 12141c7d98d0SAttilio Rao _lockmgr_assert(lk, KA_XLOCKED, file, line); 1215e5f94314SAttilio Rao LOCK_LOG_LOCK("XDOWNGRADE", &lk->lock_object, 0, 0, file, line); 1216e5f94314SAttilio Rao WITNESS_DOWNGRADE(&lk->lock_object, 0, file, line); 12171c7d98d0SAttilio Rao 12181c7d98d0SAttilio Rao /* 12191c7d98d0SAttilio Rao * Panic if the lock is recursed. 12201c7d98d0SAttilio Rao */ 12211c7d98d0SAttilio Rao if (lockmgr_xlocked(lk) && lockmgr_recursed(lk)) { 12221c7d98d0SAttilio Rao if (flags & LK_INTERLOCK) 12231c7d98d0SAttilio Rao class->lc_unlock(ilk); 12241c7d98d0SAttilio Rao panic("%s: downgrade a recursed lockmgr %s @ %s:%d\n", 12251c7d98d0SAttilio Rao __func__, iwmesg, file, line); 12261c7d98d0SAttilio Rao } 1227e5f94314SAttilio Rao TD_SLOCKS_INC(curthread); 1228047dd67eSAttilio Rao 1229047dd67eSAttilio Rao /* 1230047dd67eSAttilio Rao * In order to preserve waiters flags, just spin. 1231047dd67eSAttilio Rao */ 1232047dd67eSAttilio Rao for (;;) { 1233651175c9SAttilio Rao x = lk->lk_lock; 1234651175c9SAttilio Rao MPASS((x & LK_EXCLUSIVE_SPINNERS) == 0); 1235651175c9SAttilio Rao x &= LK_ALL_WAITERS; 1236047dd67eSAttilio Rao if (atomic_cmpset_rel_ptr(&lk->lk_lock, tid | x, 1237e5f94314SAttilio Rao LK_SHARERS_LOCK(1) | x)) 1238047dd67eSAttilio Rao break; 1239047dd67eSAttilio Rao cpu_spinwait(); 1240047dd67eSAttilio Rao } 1241047dd67eSAttilio Rao break; 1242047dd67eSAttilio Rao case LK_RELEASE: 1243047dd67eSAttilio Rao _lockmgr_assert(lk, KA_LOCKED, file, line); 1244047dd67eSAttilio Rao x = lk->lk_lock; 1245047dd67eSAttilio Rao 12461c6987ebSMateusz Guzik if (__predict_true(x & LK_SHARE) != 0) { 12471c6987ebSMateusz Guzik return (lockmgr_sunlock_hard(lk, x, flags, ilk, file, line)); 1248047dd67eSAttilio Rao } else { 12491c6987ebSMateusz Guzik return (lockmgr_xunlock_hard(lk, x, flags, ilk, file, line)); 12502028867dSAttilio Rao } 1251047dd67eSAttilio Rao break; 1252047dd67eSAttilio Rao case LK_DRAIN: 1253e5f94314SAttilio Rao if (LK_CAN_WITNESS(flags)) 1254e5f94314SAttilio Rao WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER | 125524150d37SJohn Baldwin LOP_EXCLUSIVE, file, line, flags & LK_INTERLOCK ? 125624150d37SJohn Baldwin ilk : NULL); 1257047dd67eSAttilio Rao 1258047dd67eSAttilio Rao /* 125996f1567fSKonstantin Belousov * Trying to drain a lock we already own will result in a 1260047dd67eSAttilio Rao * deadlock. 1261047dd67eSAttilio Rao */ 1262047dd67eSAttilio Rao if (lockmgr_xlocked(lk)) { 1263047dd67eSAttilio Rao if (flags & LK_INTERLOCK) 1264047dd67eSAttilio Rao class->lc_unlock(ilk); 1265047dd67eSAttilio Rao panic("%s: draining %s with the lock held @ %s:%d\n", 1266047dd67eSAttilio Rao __func__, iwmesg, file, line); 1267047dd67eSAttilio Rao } 1268047dd67eSAttilio Rao 1269fc4f686dSMateusz Guzik for (;;) { 1270fc4f686dSMateusz Guzik if (lk->lk_lock == LK_UNLOCKED && 1271fc4f686dSMateusz Guzik atomic_cmpset_acq_ptr(&lk->lk_lock, LK_UNLOCKED, tid)) 1272fc4f686dSMateusz Guzik break; 1273fc4f686dSMateusz Guzik 1274f5f9340bSFabien Thomas #ifdef HWPMC_HOOKS 1275f5f9340bSFabien Thomas PMC_SOFT_CALL( , , lock, failed); 1276f5f9340bSFabien Thomas #endif 1277047dd67eSAttilio Rao lock_profile_obtain_lock_failed(&lk->lock_object, 1278047dd67eSAttilio Rao &contested, &waittime); 1279047dd67eSAttilio Rao 1280047dd67eSAttilio Rao /* 1281047dd67eSAttilio Rao * If the lock is expected to not sleep just give up 1282047dd67eSAttilio Rao * and return. 1283047dd67eSAttilio Rao */ 1284047dd67eSAttilio Rao if (LK_TRYOP(flags)) { 1285047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p fails the try operation", 1286047dd67eSAttilio Rao __func__, lk); 1287047dd67eSAttilio Rao error = EBUSY; 1288047dd67eSAttilio Rao break; 1289047dd67eSAttilio Rao } 1290047dd67eSAttilio Rao 1291047dd67eSAttilio Rao /* 1292047dd67eSAttilio Rao * Acquire the sleepqueue chain lock because we 1293047dd67eSAttilio Rao * probabilly will need to manipulate waiters flags. 1294047dd67eSAttilio Rao */ 1295047dd67eSAttilio Rao sleepq_lock(&lk->lock_object); 1296047dd67eSAttilio Rao x = lk->lk_lock; 1297047dd67eSAttilio Rao 1298047dd67eSAttilio Rao /* 1299047dd67eSAttilio Rao * if the lock has been released while we spun on 1300047dd67eSAttilio Rao * the sleepqueue chain lock just try again. 1301047dd67eSAttilio Rao */ 1302047dd67eSAttilio Rao if (x == LK_UNLOCKED) { 1303047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 1304047dd67eSAttilio Rao continue; 1305047dd67eSAttilio Rao } 1306047dd67eSAttilio Rao 1307651175c9SAttilio Rao v = x & (LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS); 1308651175c9SAttilio Rao if ((x & ~v) == LK_UNLOCKED) { 1309651175c9SAttilio Rao v = (x & ~LK_EXCLUSIVE_SPINNERS); 13102028867dSAttilio Rao 13112028867dSAttilio Rao /* 13122028867dSAttilio Rao * If interruptible sleeps left the exclusive 13132028867dSAttilio Rao * queue empty avoid a starvation for the 13142028867dSAttilio Rao * threads sleeping on the shared queue by 13152028867dSAttilio Rao * giving them precedence and cleaning up the 13162028867dSAttilio Rao * exclusive waiters bit anyway. 1317c636ba83SAttilio Rao * Please note that lk_exslpfail count may be 1318c636ba83SAttilio Rao * lying about the real number of waiters with 1319c636ba83SAttilio Rao * the LK_SLEEPFAIL flag on because they may 1320e3043798SPedro F. Giffuni * be used in conjunction with interruptible 1321aab9c8c2SAttilio Rao * sleeps so lk_exslpfail might be considered 1322aab9c8c2SAttilio Rao * an 'upper limit' bound, including the edge 1323c636ba83SAttilio Rao * cases. 13242028867dSAttilio Rao */ 1325047dd67eSAttilio Rao if (v & LK_EXCLUSIVE_WAITERS) { 1326047dd67eSAttilio Rao queue = SQ_EXCLUSIVE_QUEUE; 1327047dd67eSAttilio Rao v &= ~LK_EXCLUSIVE_WAITERS; 1328047dd67eSAttilio Rao } else { 13299dbf7a62SAttilio Rao 13309dbf7a62SAttilio Rao /* 13319dbf7a62SAttilio Rao * Exclusive waiters sleeping with 13329dbf7a62SAttilio Rao * LK_SLEEPFAIL on and using 13339dbf7a62SAttilio Rao * interruptible sleeps/timeout may 13349dbf7a62SAttilio Rao * have left spourious lk_exslpfail 13359dbf7a62SAttilio Rao * counts on, so clean it up anyway. 13369dbf7a62SAttilio Rao */ 1337047dd67eSAttilio Rao MPASS(v & LK_SHARED_WAITERS); 13389dbf7a62SAttilio Rao lk->lk_exslpfail = 0; 1339047dd67eSAttilio Rao queue = SQ_SHARED_QUEUE; 1340047dd67eSAttilio Rao v &= ~LK_SHARED_WAITERS; 1341047dd67eSAttilio Rao } 13422028867dSAttilio Rao if (queue == SQ_EXCLUSIVE_QUEUE) { 13432028867dSAttilio Rao realexslp = 13442028867dSAttilio Rao sleepq_sleepcnt(&lk->lock_object, 13452028867dSAttilio Rao SQ_EXCLUSIVE_QUEUE); 13462028867dSAttilio Rao if (lk->lk_exslpfail >= realexslp) { 13472028867dSAttilio Rao lk->lk_exslpfail = 0; 13482028867dSAttilio Rao queue = SQ_SHARED_QUEUE; 13492028867dSAttilio Rao v &= ~LK_SHARED_WAITERS; 13502028867dSAttilio Rao if (realexslp != 0) { 13512028867dSAttilio Rao LOCK_LOG2(lk, 13522028867dSAttilio Rao "%s: %p has only LK_SLEEPFAIL sleepers", 13532028867dSAttilio Rao __func__, lk); 13542028867dSAttilio Rao LOCK_LOG2(lk, 13552028867dSAttilio Rao "%s: %p waking up threads on the exclusive queue", 13562028867dSAttilio Rao __func__, lk); 13572028867dSAttilio Rao wakeup_swapper = 13582028867dSAttilio Rao sleepq_broadcast( 13592028867dSAttilio Rao &lk->lock_object, 13602028867dSAttilio Rao SLEEPQ_LK, 0, 13612028867dSAttilio Rao SQ_EXCLUSIVE_QUEUE); 13622028867dSAttilio Rao } 13632028867dSAttilio Rao } else 13642028867dSAttilio Rao lk->lk_exslpfail = 0; 13652028867dSAttilio Rao } 1366047dd67eSAttilio Rao if (!atomic_cmpset_ptr(&lk->lk_lock, x, v)) { 1367047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 1368047dd67eSAttilio Rao continue; 1369047dd67eSAttilio Rao } 1370047dd67eSAttilio Rao LOCK_LOG3(lk, 1371047dd67eSAttilio Rao "%s: %p waking up all threads on the %s queue", 1372047dd67eSAttilio Rao __func__, lk, queue == SQ_SHARED_QUEUE ? 1373047dd67eSAttilio Rao "shared" : "exclusive"); 1374814f26daSJohn Baldwin wakeup_swapper |= sleepq_broadcast( 1375da7bbd2cSJohn Baldwin &lk->lock_object, SLEEPQ_LK, 0, queue); 1376047dd67eSAttilio Rao 1377047dd67eSAttilio Rao /* 1378047dd67eSAttilio Rao * If shared waiters have been woken up we need 1379047dd67eSAttilio Rao * to wait for one of them to acquire the lock 1380047dd67eSAttilio Rao * before to set the exclusive waiters in 1381047dd67eSAttilio Rao * order to avoid a deadlock. 1382047dd67eSAttilio Rao */ 1383047dd67eSAttilio Rao if (queue == SQ_SHARED_QUEUE) { 1384047dd67eSAttilio Rao for (v = lk->lk_lock; 1385047dd67eSAttilio Rao (v & LK_SHARE) && !LK_SHARERS(v); 1386047dd67eSAttilio Rao v = lk->lk_lock) 1387047dd67eSAttilio Rao cpu_spinwait(); 1388047dd67eSAttilio Rao } 1389047dd67eSAttilio Rao } 1390047dd67eSAttilio Rao 1391047dd67eSAttilio Rao /* 1392047dd67eSAttilio Rao * Try to set the LK_EXCLUSIVE_WAITERS flag. If we 1393047dd67eSAttilio Rao * fail, loop back and retry. 1394047dd67eSAttilio Rao */ 1395047dd67eSAttilio Rao if ((x & LK_EXCLUSIVE_WAITERS) == 0) { 1396047dd67eSAttilio Rao if (!atomic_cmpset_ptr(&lk->lk_lock, x, 1397047dd67eSAttilio Rao x | LK_EXCLUSIVE_WAITERS)) { 1398047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 1399047dd67eSAttilio Rao continue; 1400047dd67eSAttilio Rao } 1401047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p set drain waiters flag", 1402047dd67eSAttilio Rao __func__, lk); 1403047dd67eSAttilio Rao } 1404047dd67eSAttilio Rao 1405047dd67eSAttilio Rao /* 1406047dd67eSAttilio Rao * As far as we have been unable to acquire the 1407047dd67eSAttilio Rao * exclusive lock and the exclusive waiters flag 1408047dd67eSAttilio Rao * is set, we will sleep. 1409047dd67eSAttilio Rao */ 1410047dd67eSAttilio Rao if (flags & LK_INTERLOCK) { 1411047dd67eSAttilio Rao class->lc_unlock(ilk); 1412047dd67eSAttilio Rao flags &= ~LK_INTERLOCK; 1413047dd67eSAttilio Rao } 1414e5f94314SAttilio Rao GIANT_SAVE(); 1415047dd67eSAttilio Rao sleepq_add(&lk->lock_object, NULL, iwmesg, SLEEPQ_LK, 1416047dd67eSAttilio Rao SQ_EXCLUSIVE_QUEUE); 1417047dd67eSAttilio Rao sleepq_wait(&lk->lock_object, ipri & PRIMASK); 1418e5f94314SAttilio Rao GIANT_RESTORE(); 1419047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p resuming from the sleep queue", 1420047dd67eSAttilio Rao __func__, lk); 1421047dd67eSAttilio Rao } 1422047dd67eSAttilio Rao 1423047dd67eSAttilio Rao if (error == 0) { 1424047dd67eSAttilio Rao lock_profile_obtain_lock_success(&lk->lock_object, 1425047dd67eSAttilio Rao contested, waittime, file, line); 1426047dd67eSAttilio Rao LOCK_LOG_LOCK("DRAIN", &lk->lock_object, 0, 1427047dd67eSAttilio Rao lk->lk_recurse, file, line); 1428e5f94314SAttilio Rao WITNESS_LOCK(&lk->lock_object, LOP_EXCLUSIVE | 1429e5f94314SAttilio Rao LK_TRYWIT(flags), file, line); 1430047dd67eSAttilio Rao TD_LOCKS_INC(curthread); 1431047dd67eSAttilio Rao STACK_SAVE(lk); 1432047dd67eSAttilio Rao } 1433047dd67eSAttilio Rao break; 1434047dd67eSAttilio Rao default: 1435047dd67eSAttilio Rao if (flags & LK_INTERLOCK) 1436047dd67eSAttilio Rao class->lc_unlock(ilk); 1437047dd67eSAttilio Rao panic("%s: unknown lockmgr request 0x%x\n", __func__, op); 1438047dd67eSAttilio Rao } 1439047dd67eSAttilio Rao 1440047dd67eSAttilio Rao if (flags & LK_INTERLOCK) 1441047dd67eSAttilio Rao class->lc_unlock(ilk); 1442da7bbd2cSJohn Baldwin if (wakeup_swapper) 1443da7bbd2cSJohn Baldwin kick_proc0(); 1444047dd67eSAttilio Rao 1445047dd67eSAttilio Rao return (error); 1446047dd67eSAttilio Rao } 1447047dd67eSAttilio Rao 1448d7a7e179SAttilio Rao void 1449047dd67eSAttilio Rao _lockmgr_disown(struct lock *lk, const char *file, int line) 1450047dd67eSAttilio Rao { 1451047dd67eSAttilio Rao uintptr_t tid, x; 1452047dd67eSAttilio Rao 145335370593SAndriy Gapon if (SCHEDULER_STOPPED()) 145435370593SAndriy Gapon return; 145535370593SAndriy Gapon 1456047dd67eSAttilio Rao tid = (uintptr_t)curthread; 14571c7d98d0SAttilio Rao _lockmgr_assert(lk, KA_XLOCKED, file, line); 14581c7d98d0SAttilio Rao 14591c7d98d0SAttilio Rao /* 14601c7d98d0SAttilio Rao * Panic if the lock is recursed. 14611c7d98d0SAttilio Rao */ 14621c7d98d0SAttilio Rao if (lockmgr_xlocked(lk) && lockmgr_recursed(lk)) 14631c7d98d0SAttilio Rao panic("%s: disown a recursed lockmgr @ %s:%d\n", 14641c7d98d0SAttilio Rao __func__, file, line); 1465047dd67eSAttilio Rao 1466047dd67eSAttilio Rao /* 146796f1567fSKonstantin Belousov * If the owner is already LK_KERNPROC just skip the whole operation. 1468047dd67eSAttilio Rao */ 1469047dd67eSAttilio Rao if (LK_HOLDER(lk->lk_lock) != tid) 1470047dd67eSAttilio Rao return; 147104a28689SJeff Roberson lock_profile_release_lock(&lk->lock_object); 1472e5f94314SAttilio Rao LOCK_LOG_LOCK("XDISOWN", &lk->lock_object, 0, 0, file, line); 1473e5f94314SAttilio Rao WITNESS_UNLOCK(&lk->lock_object, LOP_EXCLUSIVE, file, line); 1474e5f94314SAttilio Rao TD_LOCKS_DEC(curthread); 1475337c5ff4SAttilio Rao STACK_SAVE(lk); 1476047dd67eSAttilio Rao 1477047dd67eSAttilio Rao /* 1478047dd67eSAttilio Rao * In order to preserve waiters flags, just spin. 1479047dd67eSAttilio Rao */ 1480047dd67eSAttilio Rao for (;;) { 1481651175c9SAttilio Rao x = lk->lk_lock; 1482651175c9SAttilio Rao MPASS((x & LK_EXCLUSIVE_SPINNERS) == 0); 1483651175c9SAttilio Rao x &= LK_ALL_WAITERS; 148422dd228dSAttilio Rao if (atomic_cmpset_rel_ptr(&lk->lk_lock, tid | x, 1485e5f94314SAttilio Rao LK_KERNPROC | x)) 1486047dd67eSAttilio Rao return; 1487047dd67eSAttilio Rao cpu_spinwait(); 1488047dd67eSAttilio Rao } 1489047dd67eSAttilio Rao } 1490047dd67eSAttilio Rao 1491047dd67eSAttilio Rao void 1492d576deedSPawel Jakub Dawidek lockmgr_printinfo(const struct lock *lk) 1493d7a7e179SAttilio Rao { 1494d7a7e179SAttilio Rao struct thread *td; 1495047dd67eSAttilio Rao uintptr_t x; 1496d7a7e179SAttilio Rao 1497047dd67eSAttilio Rao if (lk->lk_lock == LK_UNLOCKED) 1498047dd67eSAttilio Rao printf("lock type %s: UNLOCKED\n", lk->lock_object.lo_name); 1499047dd67eSAttilio Rao else if (lk->lk_lock & LK_SHARE) 1500047dd67eSAttilio Rao printf("lock type %s: SHARED (count %ju)\n", 1501047dd67eSAttilio Rao lk->lock_object.lo_name, 1502047dd67eSAttilio Rao (uintmax_t)LK_SHARERS(lk->lk_lock)); 1503047dd67eSAttilio Rao else { 1504047dd67eSAttilio Rao td = lockmgr_xholder(lk); 1505e64b4fa8SKonstantin Belousov if (td == (struct thread *)LK_KERNPROC) 1506e64b4fa8SKonstantin Belousov printf("lock type %s: EXCL by KERNPROC\n", 1507e64b4fa8SKonstantin Belousov lk->lock_object.lo_name); 1508e64b4fa8SKonstantin Belousov else 15092573ea5fSIvan Voras printf("lock type %s: EXCL by thread %p " 1510e64b4fa8SKonstantin Belousov "(pid %d, %s, tid %d)\n", lk->lock_object.lo_name, 1511e64b4fa8SKonstantin Belousov td, td->td_proc->p_pid, td->td_proc->p_comm, 1512e64b4fa8SKonstantin Belousov td->td_tid); 1513d7a7e179SAttilio Rao } 1514d7a7e179SAttilio Rao 1515047dd67eSAttilio Rao x = lk->lk_lock; 1516047dd67eSAttilio Rao if (x & LK_EXCLUSIVE_WAITERS) 1517047dd67eSAttilio Rao printf(" with exclusive waiters pending\n"); 1518047dd67eSAttilio Rao if (x & LK_SHARED_WAITERS) 1519047dd67eSAttilio Rao printf(" with shared waiters pending\n"); 1520651175c9SAttilio Rao if (x & LK_EXCLUSIVE_SPINNERS) 1521651175c9SAttilio Rao printf(" with exclusive spinners pending\n"); 1522047dd67eSAttilio Rao 1523047dd67eSAttilio Rao STACK_PRINT(lk); 1524047dd67eSAttilio Rao } 1525047dd67eSAttilio Rao 152699448ed1SJohn Dyson int 1527d576deedSPawel Jakub Dawidek lockstatus(const struct lock *lk) 152899448ed1SJohn Dyson { 1529047dd67eSAttilio Rao uintptr_t v, x; 1530047dd67eSAttilio Rao int ret; 153199448ed1SJohn Dyson 1532047dd67eSAttilio Rao ret = LK_SHARED; 1533047dd67eSAttilio Rao x = lk->lk_lock; 1534047dd67eSAttilio Rao v = LK_HOLDER(x); 15350e9eb108SAttilio Rao 1536047dd67eSAttilio Rao if ((x & LK_SHARE) == 0) { 1537047dd67eSAttilio Rao if (v == (uintptr_t)curthread || v == LK_KERNPROC) 1538047dd67eSAttilio Rao ret = LK_EXCLUSIVE; 15396bdfe06aSEivind Eklund else 1540047dd67eSAttilio Rao ret = LK_EXCLOTHER; 1541047dd67eSAttilio Rao } else if (x == LK_UNLOCKED) 1542047dd67eSAttilio Rao ret = 0; 154399448ed1SJohn Dyson 1544047dd67eSAttilio Rao return (ret); 154553bf4bb2SPeter Wemm } 1546be6847d7SJohn Baldwin 154784887fa3SAttilio Rao #ifdef INVARIANT_SUPPORT 1548de5b1952SAlexander Leidinger 1549de5b1952SAlexander Leidinger FEATURE(invariant_support, 1550de5b1952SAlexander Leidinger "Support for modules compiled with INVARIANTS option"); 1551de5b1952SAlexander Leidinger 155284887fa3SAttilio Rao #ifndef INVARIANTS 155384887fa3SAttilio Rao #undef _lockmgr_assert 155484887fa3SAttilio Rao #endif 155584887fa3SAttilio Rao 155684887fa3SAttilio Rao void 1557d576deedSPawel Jakub Dawidek _lockmgr_assert(const struct lock *lk, int what, const char *file, int line) 155884887fa3SAttilio Rao { 155984887fa3SAttilio Rao int slocked = 0; 156084887fa3SAttilio Rao 156184887fa3SAttilio Rao if (panicstr != NULL) 156284887fa3SAttilio Rao return; 156384887fa3SAttilio Rao switch (what) { 156484887fa3SAttilio Rao case KA_SLOCKED: 156584887fa3SAttilio Rao case KA_SLOCKED | KA_NOTRECURSED: 156684887fa3SAttilio Rao case KA_SLOCKED | KA_RECURSED: 156784887fa3SAttilio Rao slocked = 1; 156884887fa3SAttilio Rao case KA_LOCKED: 156984887fa3SAttilio Rao case KA_LOCKED | KA_NOTRECURSED: 157084887fa3SAttilio Rao case KA_LOCKED | KA_RECURSED: 1571e5f94314SAttilio Rao #ifdef WITNESS 1572e5f94314SAttilio Rao 1573e5f94314SAttilio Rao /* 1574e5f94314SAttilio Rao * We cannot trust WITNESS if the lock is held in exclusive 1575e5f94314SAttilio Rao * mode and a call to lockmgr_disown() happened. 1576e5f94314SAttilio Rao * Workaround this skipping the check if the lock is held in 1577e5f94314SAttilio Rao * exclusive mode even for the KA_LOCKED case. 1578e5f94314SAttilio Rao */ 1579e5f94314SAttilio Rao if (slocked || (lk->lk_lock & LK_SHARE)) { 1580e5f94314SAttilio Rao witness_assert(&lk->lock_object, what, file, line); 1581e5f94314SAttilio Rao break; 1582e5f94314SAttilio Rao } 1583e5f94314SAttilio Rao #endif 1584047dd67eSAttilio Rao if (lk->lk_lock == LK_UNLOCKED || 1585047dd67eSAttilio Rao ((lk->lk_lock & LK_SHARE) == 0 && (slocked || 1586047dd67eSAttilio Rao (!lockmgr_xlocked(lk) && !lockmgr_disowned(lk))))) 158784887fa3SAttilio Rao panic("Lock %s not %slocked @ %s:%d\n", 1588047dd67eSAttilio Rao lk->lock_object.lo_name, slocked ? "share" : "", 158984887fa3SAttilio Rao file, line); 1590047dd67eSAttilio Rao 1591047dd67eSAttilio Rao if ((lk->lk_lock & LK_SHARE) == 0) { 1592047dd67eSAttilio Rao if (lockmgr_recursed(lk)) { 159384887fa3SAttilio Rao if (what & KA_NOTRECURSED) 159484887fa3SAttilio Rao panic("Lock %s recursed @ %s:%d\n", 1595047dd67eSAttilio Rao lk->lock_object.lo_name, file, 1596047dd67eSAttilio Rao line); 159784887fa3SAttilio Rao } else if (what & KA_RECURSED) 159884887fa3SAttilio Rao panic("Lock %s not recursed @ %s:%d\n", 1599047dd67eSAttilio Rao lk->lock_object.lo_name, file, line); 160084887fa3SAttilio Rao } 160184887fa3SAttilio Rao break; 160284887fa3SAttilio Rao case KA_XLOCKED: 160384887fa3SAttilio Rao case KA_XLOCKED | KA_NOTRECURSED: 160484887fa3SAttilio Rao case KA_XLOCKED | KA_RECURSED: 1605047dd67eSAttilio Rao if (!lockmgr_xlocked(lk) && !lockmgr_disowned(lk)) 160684887fa3SAttilio Rao panic("Lock %s not exclusively locked @ %s:%d\n", 1607047dd67eSAttilio Rao lk->lock_object.lo_name, file, line); 1608047dd67eSAttilio Rao if (lockmgr_recursed(lk)) { 160984887fa3SAttilio Rao if (what & KA_NOTRECURSED) 161084887fa3SAttilio Rao panic("Lock %s recursed @ %s:%d\n", 1611047dd67eSAttilio Rao lk->lock_object.lo_name, file, line); 161284887fa3SAttilio Rao } else if (what & KA_RECURSED) 161384887fa3SAttilio Rao panic("Lock %s not recursed @ %s:%d\n", 1614047dd67eSAttilio Rao lk->lock_object.lo_name, file, line); 161584887fa3SAttilio Rao break; 161684887fa3SAttilio Rao case KA_UNLOCKED: 1617047dd67eSAttilio Rao if (lockmgr_xlocked(lk) || lockmgr_disowned(lk)) 161884887fa3SAttilio Rao panic("Lock %s exclusively locked @ %s:%d\n", 1619047dd67eSAttilio Rao lk->lock_object.lo_name, file, line); 162084887fa3SAttilio Rao break; 162184887fa3SAttilio Rao default: 1622047dd67eSAttilio Rao panic("Unknown lockmgr assertion: %d @ %s:%d\n", what, file, 1623047dd67eSAttilio Rao line); 162484887fa3SAttilio Rao } 162584887fa3SAttilio Rao } 1626047dd67eSAttilio Rao #endif 162784887fa3SAttilio Rao 1628be6847d7SJohn Baldwin #ifdef DDB 1629462a7addSJohn Baldwin int 1630462a7addSJohn Baldwin lockmgr_chain(struct thread *td, struct thread **ownerp) 1631462a7addSJohn Baldwin { 1632047dd67eSAttilio Rao struct lock *lk; 1633462a7addSJohn Baldwin 1634047dd67eSAttilio Rao lk = td->td_wchan; 1635462a7addSJohn Baldwin 1636047dd67eSAttilio Rao if (LOCK_CLASS(&lk->lock_object) != &lock_class_lockmgr) 1637462a7addSJohn Baldwin return (0); 1638047dd67eSAttilio Rao db_printf("blocked on lockmgr %s", lk->lock_object.lo_name); 1639047dd67eSAttilio Rao if (lk->lk_lock & LK_SHARE) 1640047dd67eSAttilio Rao db_printf("SHARED (count %ju)\n", 1641047dd67eSAttilio Rao (uintmax_t)LK_SHARERS(lk->lk_lock)); 1642047dd67eSAttilio Rao else 1643047dd67eSAttilio Rao db_printf("EXCL\n"); 1644047dd67eSAttilio Rao *ownerp = lockmgr_xholder(lk); 1645462a7addSJohn Baldwin 1646462a7addSJohn Baldwin return (1); 1647462a7addSJohn Baldwin } 1648462a7addSJohn Baldwin 1649047dd67eSAttilio Rao static void 1650d576deedSPawel Jakub Dawidek db_show_lockmgr(const struct lock_object *lock) 1651be6847d7SJohn Baldwin { 1652be6847d7SJohn Baldwin struct thread *td; 1653d576deedSPawel Jakub Dawidek const struct lock *lk; 1654be6847d7SJohn Baldwin 1655d576deedSPawel Jakub Dawidek lk = (const struct lock *)lock; 1656be6847d7SJohn Baldwin 1657be6847d7SJohn Baldwin db_printf(" state: "); 1658047dd67eSAttilio Rao if (lk->lk_lock == LK_UNLOCKED) 1659be6847d7SJohn Baldwin db_printf("UNLOCKED\n"); 1660047dd67eSAttilio Rao else if (lk->lk_lock & LK_SHARE) 1661047dd67eSAttilio Rao db_printf("SLOCK: %ju\n", (uintmax_t)LK_SHARERS(lk->lk_lock)); 1662047dd67eSAttilio Rao else { 1663047dd67eSAttilio Rao td = lockmgr_xholder(lk); 1664047dd67eSAttilio Rao if (td == (struct thread *)LK_KERNPROC) 1665047dd67eSAttilio Rao db_printf("XLOCK: LK_KERNPROC\n"); 1666047dd67eSAttilio Rao else 1667047dd67eSAttilio Rao db_printf("XLOCK: %p (tid %d, pid %d, \"%s\")\n", td, 1668047dd67eSAttilio Rao td->td_tid, td->td_proc->p_pid, 1669047dd67eSAttilio Rao td->td_proc->p_comm); 1670047dd67eSAttilio Rao if (lockmgr_recursed(lk)) 1671047dd67eSAttilio Rao db_printf(" recursed: %d\n", lk->lk_recurse); 1672047dd67eSAttilio Rao } 1673047dd67eSAttilio Rao db_printf(" waiters: "); 1674047dd67eSAttilio Rao switch (lk->lk_lock & LK_ALL_WAITERS) { 1675047dd67eSAttilio Rao case LK_SHARED_WAITERS: 1676047dd67eSAttilio Rao db_printf("shared\n"); 1677e5023dd9SEdward Tomasz Napierala break; 1678047dd67eSAttilio Rao case LK_EXCLUSIVE_WAITERS: 1679047dd67eSAttilio Rao db_printf("exclusive\n"); 1680047dd67eSAttilio Rao break; 1681047dd67eSAttilio Rao case LK_ALL_WAITERS: 1682047dd67eSAttilio Rao db_printf("shared and exclusive\n"); 1683047dd67eSAttilio Rao break; 1684047dd67eSAttilio Rao default: 1685047dd67eSAttilio Rao db_printf("none\n"); 1686047dd67eSAttilio Rao } 1687651175c9SAttilio Rao db_printf(" spinners: "); 1688651175c9SAttilio Rao if (lk->lk_lock & LK_EXCLUSIVE_SPINNERS) 1689651175c9SAttilio Rao db_printf("exclusive\n"); 1690651175c9SAttilio Rao else 1691651175c9SAttilio Rao db_printf("none\n"); 1692be6847d7SJohn Baldwin } 1693be6847d7SJohn Baldwin #endif 1694