19454b2d8SWarner Losh /*- 2047dd67eSAttilio Rao * Copyright (c) 2008 Attilio Rao <attilio@FreeBSD.org> 3047dd67eSAttilio Rao * All rights reserved. 453bf4bb2SPeter Wemm * 553bf4bb2SPeter Wemm * Redistribution and use in source and binary forms, with or without 653bf4bb2SPeter Wemm * modification, are permitted provided that the following conditions 753bf4bb2SPeter Wemm * are met: 853bf4bb2SPeter Wemm * 1. Redistributions of source code must retain the above copyright 9047dd67eSAttilio Rao * notice(s), this list of conditions and the following disclaimer as 10047dd67eSAttilio Rao * the first lines of this file unmodified other than the possible 11047dd67eSAttilio Rao * addition of one or more copyright notices. 1253bf4bb2SPeter Wemm * 2. Redistributions in binary form must reproduce the above copyright 13047dd67eSAttilio Rao * notice(s), this list of conditions and the following disclaimer in the 1453bf4bb2SPeter Wemm * documentation and/or other materials provided with the distribution. 1553bf4bb2SPeter Wemm * 16047dd67eSAttilio Rao * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY 17047dd67eSAttilio Rao * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 18047dd67eSAttilio Rao * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 19047dd67eSAttilio Rao * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY 20047dd67eSAttilio Rao * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 21047dd67eSAttilio Rao * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 22047dd67eSAttilio Rao * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 23047dd67eSAttilio Rao * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2453bf4bb2SPeter Wemm * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25047dd67eSAttilio Rao * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 26047dd67eSAttilio Rao * DAMAGE. 2753bf4bb2SPeter Wemm */ 2853bf4bb2SPeter Wemm 29651175c9SAttilio Rao #include "opt_adaptive_lockmgrs.h" 30047dd67eSAttilio Rao #include "opt_ddb.h" 31a5aedd68SStacey Son #include "opt_kdtrace.h" 32047dd67eSAttilio Rao 33677b542eSDavid E. O'Brien #include <sys/cdefs.h> 34677b542eSDavid E. O'Brien __FBSDID("$FreeBSD$"); 35677b542eSDavid E. O'Brien 3653bf4bb2SPeter Wemm #include <sys/param.h> 3761d80e90SJohn Baldwin #include <sys/ktr.h> 38651175c9SAttilio Rao #include <sys/linker_set.h> 3953bf4bb2SPeter Wemm #include <sys/lock.h> 40047dd67eSAttilio Rao #include <sys/lock_profile.h> 418302d183SBruce Evans #include <sys/lockmgr.h> 42d8881ca3SJohn Baldwin #include <sys/mutex.h> 438302d183SBruce Evans #include <sys/proc.h> 44047dd67eSAttilio Rao #include <sys/sleepqueue.h> 45e8ddb61dSJeff Roberson #ifdef DEBUG_LOCKS 46e8ddb61dSJeff Roberson #include <sys/stack.h> 47e8ddb61dSJeff Roberson #endif 48651175c9SAttilio Rao #include <sys/sysctl.h> 49047dd67eSAttilio Rao #include <sys/systm.h> 5053bf4bb2SPeter Wemm 51047dd67eSAttilio Rao #include <machine/cpu.h> 526efc8a16SAttilio Rao 53be6847d7SJohn Baldwin #ifdef DDB 54be6847d7SJohn Baldwin #include <ddb/ddb.h> 55047dd67eSAttilio Rao #endif 56047dd67eSAttilio Rao 57651175c9SAttilio Rao CTASSERT(((LK_ADAPTIVE | LK_NOSHARE) & LO_CLASSFLAGS) == 58651175c9SAttilio Rao (LK_ADAPTIVE | LK_NOSHARE)); 59651175c9SAttilio Rao CTASSERT(LK_UNLOCKED == (LK_UNLOCKED & 60651175c9SAttilio Rao ~(LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS))); 61047dd67eSAttilio Rao 62047dd67eSAttilio Rao #define SQ_EXCLUSIVE_QUEUE 0 63047dd67eSAttilio Rao #define SQ_SHARED_QUEUE 1 64047dd67eSAttilio Rao 65047dd67eSAttilio Rao #ifndef INVARIANTS 66047dd67eSAttilio Rao #define _lockmgr_assert(lk, what, file, line) 67047dd67eSAttilio Rao #define TD_LOCKS_INC(td) 68047dd67eSAttilio Rao #define TD_LOCKS_DEC(td) 69047dd67eSAttilio Rao #else 70047dd67eSAttilio Rao #define TD_LOCKS_INC(td) ((td)->td_locks++) 71047dd67eSAttilio Rao #define TD_LOCKS_DEC(td) ((td)->td_locks--) 72047dd67eSAttilio Rao #endif 73047dd67eSAttilio Rao #define TD_SLOCKS_INC(td) ((td)->td_lk_slocks++) 74047dd67eSAttilio Rao #define TD_SLOCKS_DEC(td) ((td)->td_lk_slocks--) 75047dd67eSAttilio Rao 76047dd67eSAttilio Rao #ifndef DEBUG_LOCKS 77047dd67eSAttilio Rao #define STACK_PRINT(lk) 78047dd67eSAttilio Rao #define STACK_SAVE(lk) 79047dd67eSAttilio Rao #define STACK_ZERO(lk) 80047dd67eSAttilio Rao #else 81047dd67eSAttilio Rao #define STACK_PRINT(lk) stack_print_ddb(&(lk)->lk_stack) 82047dd67eSAttilio Rao #define STACK_SAVE(lk) stack_save(&(lk)->lk_stack) 83047dd67eSAttilio Rao #define STACK_ZERO(lk) stack_zero(&(lk)->lk_stack) 84047dd67eSAttilio Rao #endif 85047dd67eSAttilio Rao 86047dd67eSAttilio Rao #define LOCK_LOG2(lk, string, arg1, arg2) \ 87047dd67eSAttilio Rao if (LOCK_LOG_TEST(&(lk)->lock_object, 0)) \ 88047dd67eSAttilio Rao CTR2(KTR_LOCK, (string), (arg1), (arg2)) 89047dd67eSAttilio Rao #define LOCK_LOG3(lk, string, arg1, arg2, arg3) \ 90047dd67eSAttilio Rao if (LOCK_LOG_TEST(&(lk)->lock_object, 0)) \ 91047dd67eSAttilio Rao CTR3(KTR_LOCK, (string), (arg1), (arg2), (arg3)) 92047dd67eSAttilio Rao 93e5f94314SAttilio Rao #define GIANT_DECLARE \ 94e5f94314SAttilio Rao int _i = 0; \ 95e5f94314SAttilio Rao WITNESS_SAVE_DECL(Giant) 96e5f94314SAttilio Rao #define GIANT_RESTORE() do { \ 97e5f94314SAttilio Rao if (_i > 0) { \ 98e5f94314SAttilio Rao while (_i--) \ 99e5f94314SAttilio Rao mtx_lock(&Giant); \ 100e5f94314SAttilio Rao WITNESS_RESTORE(&Giant.lock_object, Giant); \ 101e5f94314SAttilio Rao } \ 102e5f94314SAttilio Rao } while (0) 103e5f94314SAttilio Rao #define GIANT_SAVE() do { \ 104e5f94314SAttilio Rao if (mtx_owned(&Giant)) { \ 105e5f94314SAttilio Rao WITNESS_SAVE(&Giant.lock_object, Giant); \ 106e5f94314SAttilio Rao while (mtx_owned(&Giant)) { \ 107e5f94314SAttilio Rao _i++; \ 108e5f94314SAttilio Rao mtx_unlock(&Giant); \ 109e5f94314SAttilio Rao } \ 110e5f94314SAttilio Rao } \ 111e5f94314SAttilio Rao } while (0) 112e5f94314SAttilio Rao 113047dd67eSAttilio Rao #define LK_CAN_SHARE(x) \ 114047dd67eSAttilio Rao (((x) & LK_SHARE) && (((x) & LK_EXCLUSIVE_WAITERS) == 0 || \ 115651175c9SAttilio Rao ((x) & LK_EXCLUSIVE_SPINNERS) == 0 || \ 116e0f62984SAttilio Rao curthread->td_lk_slocks || (curthread->td_pflags & TDP_DEADLKTREAT))) 117e5f94314SAttilio Rao #define LK_TRYOP(x) \ 118e5f94314SAttilio Rao ((x) & LK_NOWAIT) 119e5f94314SAttilio Rao 120e5f94314SAttilio Rao #define LK_CAN_WITNESS(x) \ 121e5f94314SAttilio Rao (((x) & LK_NOWITNESS) == 0 && !LK_TRYOP(x)) 122e5f94314SAttilio Rao #define LK_TRYWIT(x) \ 123e5f94314SAttilio Rao (LK_TRYOP(x) ? LOP_TRYLOCK : 0) 124047dd67eSAttilio Rao 125651175c9SAttilio Rao #define LK_CAN_ADAPT(lk, f) \ 126651175c9SAttilio Rao (((lk)->lock_object.lo_flags & LK_ADAPTIVE) != 0 && \ 127651175c9SAttilio Rao ((f) & LK_SLEEPFAIL) == 0) 128651175c9SAttilio Rao 129047dd67eSAttilio Rao #define lockmgr_disowned(lk) \ 130047dd67eSAttilio Rao (((lk)->lk_lock & ~(LK_FLAGMASK & ~LK_SHARE)) == LK_KERNPROC) 131047dd67eSAttilio Rao 132047dd67eSAttilio Rao #define lockmgr_xlocked(lk) \ 133047dd67eSAttilio Rao (((lk)->lk_lock & ~(LK_FLAGMASK & ~LK_SHARE)) == (uintptr_t)curthread) 134047dd67eSAttilio Rao 135047dd67eSAttilio Rao static void assert_lockmgr(struct lock_object *lock, int how); 136047dd67eSAttilio Rao #ifdef DDB 13761bd5e21SKip Macy static void db_show_lockmgr(struct lock_object *lock); 138be6847d7SJohn Baldwin #endif 1396e21afd4SJohn Baldwin static void lock_lockmgr(struct lock_object *lock, int how); 140a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 141a5aedd68SStacey Son static int owner_lockmgr(struct lock_object *lock, struct thread **owner); 142a5aedd68SStacey Son #endif 1436e21afd4SJohn Baldwin static int unlock_lockmgr(struct lock_object *lock); 14461bd5e21SKip Macy 14561bd5e21SKip Macy struct lock_class lock_class_lockmgr = { 1463ff6d229SJohn Baldwin .lc_name = "lockmgr", 147047dd67eSAttilio Rao .lc_flags = LC_RECURSABLE | LC_SLEEPABLE | LC_SLEEPLOCK | LC_UPGRADABLE, 148f9721b43SAttilio Rao .lc_assert = assert_lockmgr, 14961bd5e21SKip Macy #ifdef DDB 1506e21afd4SJohn Baldwin .lc_ddb_show = db_show_lockmgr, 15161bd5e21SKip Macy #endif 1526e21afd4SJohn Baldwin .lc_lock = lock_lockmgr, 153a5aedd68SStacey Son .lc_unlock = unlock_lockmgr, 154a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 155a5aedd68SStacey Son .lc_owner = owner_lockmgr, 156a5aedd68SStacey Son #endif 15761bd5e21SKip Macy }; 15861bd5e21SKip Macy 159651175c9SAttilio Rao #ifdef ADAPTIVE_LOCKMGRS 160651175c9SAttilio Rao static u_int alk_retries = 10; 161651175c9SAttilio Rao static u_int alk_loops = 10000; 162651175c9SAttilio Rao SYSCTL_NODE(_debug, OID_AUTO, lockmgr, CTLFLAG_RD, NULL, "lockmgr debugging"); 163651175c9SAttilio Rao SYSCTL_UINT(_debug_lockmgr, OID_AUTO, retries, CTLFLAG_RW, &alk_retries, 0, ""); 164651175c9SAttilio Rao SYSCTL_UINT(_debug_lockmgr, OID_AUTO, loops, CTLFLAG_RW, &alk_loops, 0, ""); 165651175c9SAttilio Rao #endif 166651175c9SAttilio Rao 167047dd67eSAttilio Rao static __inline struct thread * 168047dd67eSAttilio Rao lockmgr_xholder(struct lock *lk) 169047dd67eSAttilio Rao { 170047dd67eSAttilio Rao uintptr_t x; 171047dd67eSAttilio Rao 172047dd67eSAttilio Rao x = lk->lk_lock; 173047dd67eSAttilio Rao return ((x & LK_SHARE) ? NULL : (struct thread *)LK_HOLDER(x)); 174047dd67eSAttilio Rao } 17584887fa3SAttilio Rao 17653bf4bb2SPeter Wemm /* 177047dd67eSAttilio Rao * It assumes sleepq_lock held and returns with this one unheld. 178047dd67eSAttilio Rao * It also assumes the generic interlock is sane and previously checked. 179047dd67eSAttilio Rao * If LK_INTERLOCK is specified the interlock is not reacquired after the 180047dd67eSAttilio Rao * sleep. 18153bf4bb2SPeter Wemm */ 182047dd67eSAttilio Rao static __inline int 183047dd67eSAttilio Rao sleeplk(struct lock *lk, u_int flags, struct lock_object *ilk, 184047dd67eSAttilio Rao const char *wmesg, int pri, int timo, int queue) 185047dd67eSAttilio Rao { 186e5f94314SAttilio Rao GIANT_DECLARE; 187047dd67eSAttilio Rao struct lock_class *class; 188047dd67eSAttilio Rao int catch, error; 18953bf4bb2SPeter Wemm 190047dd67eSAttilio Rao class = (flags & LK_INTERLOCK) ? LOCK_CLASS(ilk) : NULL; 1915047a8fdSAttilio Rao catch = pri & PCATCH; 192047dd67eSAttilio Rao pri &= PRIMASK; 193047dd67eSAttilio Rao error = 0; 194047dd67eSAttilio Rao 195047dd67eSAttilio Rao LOCK_LOG3(lk, "%s: %p blocking on the %s sleepqueue", __func__, lk, 196047dd67eSAttilio Rao (queue == SQ_EXCLUSIVE_QUEUE) ? "exclusive" : "shared"); 197047dd67eSAttilio Rao 198047dd67eSAttilio Rao if (flags & LK_INTERLOCK) 199047dd67eSAttilio Rao class->lc_unlock(ilk); 2002028867dSAttilio Rao if (queue == SQ_EXCLUSIVE_QUEUE && (flags & LK_SLEEPFAIL) != 0) 2012028867dSAttilio Rao lk->lk_exslpfail++; 202e5f94314SAttilio Rao GIANT_SAVE(); 203047dd67eSAttilio Rao sleepq_add(&lk->lock_object, NULL, wmesg, SLEEPQ_LK | (catch ? 204047dd67eSAttilio Rao SLEEPQ_INTERRUPTIBLE : 0), queue); 205047dd67eSAttilio Rao if ((flags & LK_TIMELOCK) && timo) 206047dd67eSAttilio Rao sleepq_set_timeout(&lk->lock_object, timo); 207047dd67eSAttilio Rao 208047dd67eSAttilio Rao /* 209047dd67eSAttilio Rao * Decisional switch for real sleeping. 210047dd67eSAttilio Rao */ 211047dd67eSAttilio Rao if ((flags & LK_TIMELOCK) && timo && catch) 212047dd67eSAttilio Rao error = sleepq_timedwait_sig(&lk->lock_object, pri); 213047dd67eSAttilio Rao else if ((flags & LK_TIMELOCK) && timo) 214047dd67eSAttilio Rao error = sleepq_timedwait(&lk->lock_object, pri); 215047dd67eSAttilio Rao else if (catch) 216047dd67eSAttilio Rao error = sleepq_wait_sig(&lk->lock_object, pri); 217047dd67eSAttilio Rao else 218047dd67eSAttilio Rao sleepq_wait(&lk->lock_object, pri); 219e5f94314SAttilio Rao GIANT_RESTORE(); 220047dd67eSAttilio Rao if ((flags & LK_SLEEPFAIL) && error == 0) 221047dd67eSAttilio Rao error = ENOLCK; 222047dd67eSAttilio Rao 223047dd67eSAttilio Rao return (error); 224047dd67eSAttilio Rao } 225047dd67eSAttilio Rao 226da7bbd2cSJohn Baldwin static __inline int 227047dd67eSAttilio Rao wakeupshlk(struct lock *lk, const char *file, int line) 228047dd67eSAttilio Rao { 229047dd67eSAttilio Rao uintptr_t v, x; 2302028867dSAttilio Rao u_int realexslp; 231da7bbd2cSJohn Baldwin int queue, wakeup_swapper; 232047dd67eSAttilio Rao 233047dd67eSAttilio Rao TD_LOCKS_DEC(curthread); 234047dd67eSAttilio Rao TD_SLOCKS_DEC(curthread); 235e5f94314SAttilio Rao WITNESS_UNLOCK(&lk->lock_object, 0, file, line); 236047dd67eSAttilio Rao LOCK_LOG_LOCK("SUNLOCK", &lk->lock_object, 0, 0, file, line); 237047dd67eSAttilio Rao 238da7bbd2cSJohn Baldwin wakeup_swapper = 0; 239047dd67eSAttilio Rao for (;;) { 240047dd67eSAttilio Rao x = lk->lk_lock; 241047dd67eSAttilio Rao 242047dd67eSAttilio Rao /* 243047dd67eSAttilio Rao * If there is more than one shared lock held, just drop one 244047dd67eSAttilio Rao * and return. 245047dd67eSAttilio Rao */ 246047dd67eSAttilio Rao if (LK_SHARERS(x) > 1) { 2477f9f80ceSAttilio Rao if (atomic_cmpset_rel_ptr(&lk->lk_lock, x, 248047dd67eSAttilio Rao x - LK_ONE_SHARER)) 249047dd67eSAttilio Rao break; 250047dd67eSAttilio Rao continue; 251047dd67eSAttilio Rao } 252047dd67eSAttilio Rao 253047dd67eSAttilio Rao /* 254047dd67eSAttilio Rao * If there are not waiters on the exclusive queue, drop the 255047dd67eSAttilio Rao * lock quickly. 256047dd67eSAttilio Rao */ 257047dd67eSAttilio Rao if ((x & LK_ALL_WAITERS) == 0) { 258651175c9SAttilio Rao MPASS((x & ~LK_EXCLUSIVE_SPINNERS) == 259651175c9SAttilio Rao LK_SHARERS_LOCK(1)); 2607f9f80ceSAttilio Rao if (atomic_cmpset_rel_ptr(&lk->lk_lock, x, LK_UNLOCKED)) 261047dd67eSAttilio Rao break; 262047dd67eSAttilio Rao continue; 263047dd67eSAttilio Rao } 264047dd67eSAttilio Rao 265047dd67eSAttilio Rao /* 266047dd67eSAttilio Rao * We should have a sharer with waiters, so enter the hard 267047dd67eSAttilio Rao * path in order to handle wakeups correctly. 268047dd67eSAttilio Rao */ 269047dd67eSAttilio Rao sleepq_lock(&lk->lock_object); 270651175c9SAttilio Rao x = lk->lk_lock & (LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS); 271047dd67eSAttilio Rao v = LK_UNLOCKED; 272047dd67eSAttilio Rao 273047dd67eSAttilio Rao /* 274047dd67eSAttilio Rao * If the lock has exclusive waiters, give them preference in 275047dd67eSAttilio Rao * order to avoid deadlock with shared runners up. 2762028867dSAttilio Rao * If interruptible sleeps left the exclusive queue empty 2772028867dSAttilio Rao * avoid a starvation for the threads sleeping on the shared 2782028867dSAttilio Rao * queue by giving them precedence and cleaning up the 2792028867dSAttilio Rao * exclusive waiters bit anyway. 280c636ba83SAttilio Rao * Please note that lk_exslpfail count may be lying about 281c636ba83SAttilio Rao * the real number of waiters with the LK_SLEEPFAIL flag on 282c636ba83SAttilio Rao * because they may be used in conjuction with interruptible 283c636ba83SAttilio Rao * sleeps so lk_exslpfail is consider as a 'upper limit' 284c636ba83SAttilio Rao * bound, considering the edge cases. 285047dd67eSAttilio Rao */ 2862028867dSAttilio Rao realexslp = sleepq_sleepcnt(&lk->lock_object, 2872028867dSAttilio Rao SQ_EXCLUSIVE_QUEUE); 2882028867dSAttilio Rao if ((x & LK_EXCLUSIVE_WAITERS) != 0 && realexslp != 0) { 2892028867dSAttilio Rao if (lk->lk_exslpfail < realexslp) { 2902028867dSAttilio Rao lk->lk_exslpfail = 0; 291047dd67eSAttilio Rao queue = SQ_EXCLUSIVE_QUEUE; 292047dd67eSAttilio Rao v |= (x & LK_SHARED_WAITERS); 293047dd67eSAttilio Rao } else { 2942028867dSAttilio Rao lk->lk_exslpfail = 0; 2952028867dSAttilio Rao LOCK_LOG2(lk, 2962028867dSAttilio Rao "%s: %p has only LK_SLEEPFAIL sleepers", 2972028867dSAttilio Rao __func__, lk); 2982028867dSAttilio Rao LOCK_LOG2(lk, 2992028867dSAttilio Rao "%s: %p waking up threads on the exclusive queue", 3002028867dSAttilio Rao __func__, lk); 3012028867dSAttilio Rao wakeup_swapper = 3022028867dSAttilio Rao sleepq_broadcast(&lk->lock_object, 3032028867dSAttilio Rao SLEEPQ_LK, 0, SQ_EXCLUSIVE_QUEUE); 3042028867dSAttilio Rao queue = SQ_SHARED_QUEUE; 3052028867dSAttilio Rao } 3062028867dSAttilio Rao 3072028867dSAttilio Rao } else { 3089dbf7a62SAttilio Rao 3099dbf7a62SAttilio Rao /* 3109dbf7a62SAttilio Rao * Exclusive waiters sleeping with LK_SLEEPFAIL on 3119dbf7a62SAttilio Rao * and using interruptible sleeps/timeout may have 3129dbf7a62SAttilio Rao * left spourious lk_exslpfail counts on, so clean 3139dbf7a62SAttilio Rao * it up anyway. 3149dbf7a62SAttilio Rao */ 3159dbf7a62SAttilio Rao lk->lk_exslpfail = 0; 316047dd67eSAttilio Rao queue = SQ_SHARED_QUEUE; 317047dd67eSAttilio Rao } 318047dd67eSAttilio Rao 3197f9f80ceSAttilio Rao if (!atomic_cmpset_rel_ptr(&lk->lk_lock, LK_SHARERS_LOCK(1) | x, 320047dd67eSAttilio Rao v)) { 321047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 322047dd67eSAttilio Rao continue; 323047dd67eSAttilio Rao } 324047dd67eSAttilio Rao LOCK_LOG3(lk, "%s: %p waking up threads on the %s queue", 325047dd67eSAttilio Rao __func__, lk, queue == SQ_SHARED_QUEUE ? "shared" : 326047dd67eSAttilio Rao "exclusive"); 3272028867dSAttilio Rao wakeup_swapper |= sleepq_broadcast(&lk->lock_object, SLEEPQ_LK, 328da7bbd2cSJohn Baldwin 0, queue); 329047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 330047dd67eSAttilio Rao break; 331047dd67eSAttilio Rao } 332047dd67eSAttilio Rao 333047dd67eSAttilio Rao lock_profile_release_lock(&lk->lock_object); 334da7bbd2cSJohn Baldwin return (wakeup_swapper); 335047dd67eSAttilio Rao } 336047dd67eSAttilio Rao 337047dd67eSAttilio Rao static void 338f9721b43SAttilio Rao assert_lockmgr(struct lock_object *lock, int what) 339f9721b43SAttilio Rao { 340f9721b43SAttilio Rao 341f9721b43SAttilio Rao panic("lockmgr locks do not support assertions"); 342f9721b43SAttilio Rao } 343f9721b43SAttilio Rao 344047dd67eSAttilio Rao static void 3456e21afd4SJohn Baldwin lock_lockmgr(struct lock_object *lock, int how) 3466e21afd4SJohn Baldwin { 3476e21afd4SJohn Baldwin 3486e21afd4SJohn Baldwin panic("lockmgr locks do not support sleep interlocking"); 3496e21afd4SJohn Baldwin } 3506e21afd4SJohn Baldwin 351047dd67eSAttilio Rao static int 3526e21afd4SJohn Baldwin unlock_lockmgr(struct lock_object *lock) 3536e21afd4SJohn Baldwin { 3546e21afd4SJohn Baldwin 3556e21afd4SJohn Baldwin panic("lockmgr locks do not support sleep interlocking"); 3566e21afd4SJohn Baldwin } 3576e21afd4SJohn Baldwin 358a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 359a5aedd68SStacey Son static int 360a5aedd68SStacey Son owner_lockmgr(struct lock_object *lock, struct thread **owner) 361a5aedd68SStacey Son { 362a5aedd68SStacey Son 363a5aedd68SStacey Son panic("lockmgr locks do not support owner inquiring"); 364a5aedd68SStacey Son } 365a5aedd68SStacey Son #endif 366a5aedd68SStacey Son 36799448ed1SJohn Dyson void 368047dd67eSAttilio Rao lockinit(struct lock *lk, int pri, const char *wmesg, int timo, int flags) 36999448ed1SJohn Dyson { 3706efc8a16SAttilio Rao int iflags; 3716efc8a16SAttilio Rao 372047dd67eSAttilio Rao MPASS((flags & ~LK_INIT_MASK) == 0); 373353998acSAttilio Rao ASSERT_ATOMIC_LOAD_PTR(lk->lk_lock, 374353998acSAttilio Rao ("%s: lockmgr not aligned for %s: %p", __func__, wmesg, 375353998acSAttilio Rao &lk->lk_lock)); 37699448ed1SJohn Dyson 377f0830182SAttilio Rao iflags = LO_SLEEPABLE | LO_UPGRADABLE; 378f0830182SAttilio Rao if (flags & LK_CANRECURSE) 379f0830182SAttilio Rao iflags |= LO_RECURSABLE; 380047dd67eSAttilio Rao if ((flags & LK_NODUP) == 0) 3816efc8a16SAttilio Rao iflags |= LO_DUPOK; 3827fbfba7bSAttilio Rao if (flags & LK_NOPROFILE) 3837fbfba7bSAttilio Rao iflags |= LO_NOPROFILE; 384047dd67eSAttilio Rao if ((flags & LK_NOWITNESS) == 0) 3856efc8a16SAttilio Rao iflags |= LO_WITNESS; 3867fbfba7bSAttilio Rao if (flags & LK_QUIET) 3877fbfba7bSAttilio Rao iflags |= LO_QUIET; 388651175c9SAttilio Rao iflags |= flags & (LK_ADAPTIVE | LK_NOSHARE); 389047dd67eSAttilio Rao 390047dd67eSAttilio Rao lk->lk_lock = LK_UNLOCKED; 391047dd67eSAttilio Rao lk->lk_recurse = 0; 3922028867dSAttilio Rao lk->lk_exslpfail = 0; 393047dd67eSAttilio Rao lk->lk_timo = timo; 394047dd67eSAttilio Rao lk->lk_pri = pri; 395047dd67eSAttilio Rao lock_init(&lk->lock_object, &lock_class_lockmgr, wmesg, NULL, iflags); 396047dd67eSAttilio Rao STACK_ZERO(lk); 39799448ed1SJohn Dyson } 39899448ed1SJohn Dyson 399a18b1f1dSJason Evans void 400047dd67eSAttilio Rao lockdestroy(struct lock *lk) 401a18b1f1dSJason Evans { 402c91fcee7SJohn Baldwin 403047dd67eSAttilio Rao KASSERT(lk->lk_lock == LK_UNLOCKED, ("lockmgr still held")); 404047dd67eSAttilio Rao KASSERT(lk->lk_recurse == 0, ("lockmgr still recursed")); 4052028867dSAttilio Rao KASSERT(lk->lk_exslpfail == 0, ("lockmgr still exclusive waiters")); 406047dd67eSAttilio Rao lock_destroy(&lk->lock_object); 407047dd67eSAttilio Rao } 408047dd67eSAttilio Rao 409047dd67eSAttilio Rao int 410047dd67eSAttilio Rao __lockmgr_args(struct lock *lk, u_int flags, struct lock_object *ilk, 411047dd67eSAttilio Rao const char *wmesg, int pri, int timo, const char *file, int line) 412047dd67eSAttilio Rao { 413e5f94314SAttilio Rao GIANT_DECLARE; 414047dd67eSAttilio Rao struct lock_class *class; 415047dd67eSAttilio Rao const char *iwmesg; 416047dd67eSAttilio Rao uintptr_t tid, v, x; 4172028867dSAttilio Rao u_int op, realexslp; 4181723a064SJeff Roberson int error, ipri, itimo, queue, wakeup_swapper; 4191723a064SJeff Roberson #ifdef LOCK_PROFILING 4201723a064SJeff Roberson uint64_t waittime = 0; 4211723a064SJeff Roberson int contested = 0; 4221723a064SJeff Roberson #endif 423651175c9SAttilio Rao #ifdef ADAPTIVE_LOCKMGRS 424651175c9SAttilio Rao volatile struct thread *owner; 425651175c9SAttilio Rao u_int i, spintries = 0; 426651175c9SAttilio Rao #endif 427047dd67eSAttilio Rao 428047dd67eSAttilio Rao error = 0; 429047dd67eSAttilio Rao tid = (uintptr_t)curthread; 430047dd67eSAttilio Rao op = (flags & LK_TYPE_MASK); 431047dd67eSAttilio Rao iwmesg = (wmesg == LK_WMESG_DEFAULT) ? lk->lock_object.lo_name : wmesg; 432047dd67eSAttilio Rao ipri = (pri == LK_PRIO_DEFAULT) ? lk->lk_pri : pri; 433047dd67eSAttilio Rao itimo = (timo == LK_TIMO_DEFAULT) ? lk->lk_timo : timo; 434047dd67eSAttilio Rao 435047dd67eSAttilio Rao MPASS((flags & ~LK_TOTAL_MASK) == 0); 436872b7289SAttilio Rao KASSERT((op & (op - 1)) == 0, 437872b7289SAttilio Rao ("%s: Invalid requested operation @ %s:%d", __func__, file, line)); 438047dd67eSAttilio Rao KASSERT((flags & (LK_NOWAIT | LK_SLEEPFAIL)) == 0 || 439047dd67eSAttilio Rao (op != LK_DOWNGRADE && op != LK_RELEASE), 440047dd67eSAttilio Rao ("%s: Invalid flags in regard of the operation desired @ %s:%d", 441047dd67eSAttilio Rao __func__, file, line)); 442047dd67eSAttilio Rao KASSERT((flags & LK_INTERLOCK) == 0 || ilk != NULL, 443047dd67eSAttilio Rao ("%s: LK_INTERLOCK passed without valid interlock @ %s:%d", 444047dd67eSAttilio Rao __func__, file, line)); 445047dd67eSAttilio Rao 446047dd67eSAttilio Rao class = (flags & LK_INTERLOCK) ? LOCK_CLASS(ilk) : NULL; 447047dd67eSAttilio Rao if (panicstr != NULL) { 448047dd67eSAttilio Rao if (flags & LK_INTERLOCK) 449047dd67eSAttilio Rao class->lc_unlock(ilk); 450047dd67eSAttilio Rao return (0); 451047dd67eSAttilio Rao } 452047dd67eSAttilio Rao 453047dd67eSAttilio Rao if (op == LK_SHARED && (lk->lock_object.lo_flags & LK_NOSHARE)) 454047dd67eSAttilio Rao op = LK_EXCLUSIVE; 455047dd67eSAttilio Rao 456da7bbd2cSJohn Baldwin wakeup_swapper = 0; 457047dd67eSAttilio Rao switch (op) { 458047dd67eSAttilio Rao case LK_SHARED: 459e5f94314SAttilio Rao if (LK_CAN_WITNESS(flags)) 460e5f94314SAttilio Rao WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER, 46141313430SJohn Baldwin file, line, ilk); 462047dd67eSAttilio Rao for (;;) { 463047dd67eSAttilio Rao x = lk->lk_lock; 464047dd67eSAttilio Rao 465047dd67eSAttilio Rao /* 466047dd67eSAttilio Rao * If no other thread has an exclusive lock, or 467047dd67eSAttilio Rao * no exclusive waiter is present, bump the count of 468047dd67eSAttilio Rao * sharers. Since we have to preserve the state of 469047dd67eSAttilio Rao * waiters, if we fail to acquire the shared lock 470047dd67eSAttilio Rao * loop back and retry. 471047dd67eSAttilio Rao */ 472047dd67eSAttilio Rao if (LK_CAN_SHARE(x)) { 473047dd67eSAttilio Rao if (atomic_cmpset_acq_ptr(&lk->lk_lock, x, 474047dd67eSAttilio Rao x + LK_ONE_SHARER)) 475047dd67eSAttilio Rao break; 476047dd67eSAttilio Rao continue; 477047dd67eSAttilio Rao } 478047dd67eSAttilio Rao lock_profile_obtain_lock_failed(&lk->lock_object, 479047dd67eSAttilio Rao &contested, &waittime); 480047dd67eSAttilio Rao 481047dd67eSAttilio Rao /* 48296f1567fSKonstantin Belousov * If the lock is already held by curthread in 483047dd67eSAttilio Rao * exclusive way avoid a deadlock. 484047dd67eSAttilio Rao */ 485047dd67eSAttilio Rao if (LK_HOLDER(x) == tid) { 486047dd67eSAttilio Rao LOCK_LOG2(lk, 48796f1567fSKonstantin Belousov "%s: %p already held in exclusive mode", 488047dd67eSAttilio Rao __func__, lk); 489047dd67eSAttilio Rao error = EDEADLK; 490047dd67eSAttilio Rao break; 491a18b1f1dSJason Evans } 492a18b1f1dSJason Evans 493a18b1f1dSJason Evans /* 494047dd67eSAttilio Rao * If the lock is expected to not sleep just give up 495047dd67eSAttilio Rao * and return. 496d7a7e179SAttilio Rao */ 497047dd67eSAttilio Rao if (LK_TRYOP(flags)) { 498047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p fails the try operation", 499047dd67eSAttilio Rao __func__, lk); 500047dd67eSAttilio Rao error = EBUSY; 501047dd67eSAttilio Rao break; 502047dd67eSAttilio Rao } 503047dd67eSAttilio Rao 504651175c9SAttilio Rao #ifdef ADAPTIVE_LOCKMGRS 505651175c9SAttilio Rao /* 506651175c9SAttilio Rao * If the owner is running on another CPU, spin until 507651175c9SAttilio Rao * the owner stops running or the state of the lock 5088d3635c4SAttilio Rao * changes. We need a double-state handle here 5098d3635c4SAttilio Rao * because for a failed acquisition the lock can be 5108d3635c4SAttilio Rao * either held in exclusive mode or shared mode 5118d3635c4SAttilio Rao * (for the writer starvation avoidance technique). 512651175c9SAttilio Rao */ 513651175c9SAttilio Rao if (LK_CAN_ADAPT(lk, flags) && (x & LK_SHARE) == 0 && 514651175c9SAttilio Rao LK_HOLDER(x) != LK_KERNPROC) { 515651175c9SAttilio Rao owner = (struct thread *)LK_HOLDER(x); 516651175c9SAttilio Rao if (LOCK_LOG_TEST(&lk->lock_object, 0)) 517651175c9SAttilio Rao CTR3(KTR_LOCK, 518651175c9SAttilio Rao "%s: spinning on %p held by %p", 519651175c9SAttilio Rao __func__, lk, owner); 520651175c9SAttilio Rao 521651175c9SAttilio Rao /* 522651175c9SAttilio Rao * If we are holding also an interlock drop it 523651175c9SAttilio Rao * in order to avoid a deadlock if the lockmgr 524651175c9SAttilio Rao * owner is adaptively spinning on the 525651175c9SAttilio Rao * interlock itself. 526651175c9SAttilio Rao */ 527651175c9SAttilio Rao if (flags & LK_INTERLOCK) { 528651175c9SAttilio Rao class->lc_unlock(ilk); 529651175c9SAttilio Rao flags &= ~LK_INTERLOCK; 530651175c9SAttilio Rao } 531651175c9SAttilio Rao GIANT_SAVE(); 532651175c9SAttilio Rao while (LK_HOLDER(lk->lk_lock) == 533651175c9SAttilio Rao (uintptr_t)owner && TD_IS_RUNNING(owner)) 534651175c9SAttilio Rao cpu_spinwait(); 5358d3635c4SAttilio Rao GIANT_RESTORE(); 5368d3635c4SAttilio Rao continue; 537651175c9SAttilio Rao } else if (LK_CAN_ADAPT(lk, flags) && 538651175c9SAttilio Rao (x & LK_SHARE) != 0 && LK_SHARERS(x) && 539651175c9SAttilio Rao spintries < alk_retries) { 540651175c9SAttilio Rao if (flags & LK_INTERLOCK) { 541651175c9SAttilio Rao class->lc_unlock(ilk); 542651175c9SAttilio Rao flags &= ~LK_INTERLOCK; 543651175c9SAttilio Rao } 544651175c9SAttilio Rao GIANT_SAVE(); 545651175c9SAttilio Rao spintries++; 546651175c9SAttilio Rao for (i = 0; i < alk_loops; i++) { 547651175c9SAttilio Rao if (LOCK_LOG_TEST(&lk->lock_object, 0)) 548651175c9SAttilio Rao CTR4(KTR_LOCK, 549651175c9SAttilio Rao "%s: shared spinning on %p with %u and %u", 550651175c9SAttilio Rao __func__, lk, spintries, i); 551651175c9SAttilio Rao x = lk->lk_lock; 552651175c9SAttilio Rao if ((x & LK_SHARE) == 0 || 553651175c9SAttilio Rao LK_CAN_SHARE(x) != 0) 554651175c9SAttilio Rao break; 555651175c9SAttilio Rao cpu_spinwait(); 556651175c9SAttilio Rao } 5578d3635c4SAttilio Rao GIANT_RESTORE(); 558651175c9SAttilio Rao if (i != alk_loops) 559651175c9SAttilio Rao continue; 560651175c9SAttilio Rao } 561651175c9SAttilio Rao #endif 562651175c9SAttilio Rao 563047dd67eSAttilio Rao /* 564047dd67eSAttilio Rao * Acquire the sleepqueue chain lock because we 565047dd67eSAttilio Rao * probabilly will need to manipulate waiters flags. 566047dd67eSAttilio Rao */ 567047dd67eSAttilio Rao sleepq_lock(&lk->lock_object); 568047dd67eSAttilio Rao x = lk->lk_lock; 569047dd67eSAttilio Rao 570047dd67eSAttilio Rao /* 571047dd67eSAttilio Rao * if the lock can be acquired in shared mode, try 572047dd67eSAttilio Rao * again. 573047dd67eSAttilio Rao */ 574047dd67eSAttilio Rao if (LK_CAN_SHARE(x)) { 575047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 576047dd67eSAttilio Rao continue; 577047dd67eSAttilio Rao } 578047dd67eSAttilio Rao 579651175c9SAttilio Rao #ifdef ADAPTIVE_LOCKMGRS 580651175c9SAttilio Rao /* 581651175c9SAttilio Rao * The current lock owner might have started executing 582651175c9SAttilio Rao * on another CPU (or the lock could have changed 583651175c9SAttilio Rao * owner) while we were waiting on the turnstile 584651175c9SAttilio Rao * chain lock. If so, drop the turnstile lock and try 585651175c9SAttilio Rao * again. 586651175c9SAttilio Rao */ 587651175c9SAttilio Rao if (LK_CAN_ADAPT(lk, flags) && (x & LK_SHARE) == 0 && 588651175c9SAttilio Rao LK_HOLDER(x) != LK_KERNPROC) { 589651175c9SAttilio Rao owner = (struct thread *)LK_HOLDER(x); 590651175c9SAttilio Rao if (TD_IS_RUNNING(owner)) { 591651175c9SAttilio Rao sleepq_release(&lk->lock_object); 592651175c9SAttilio Rao continue; 593651175c9SAttilio Rao } 594651175c9SAttilio Rao } 595651175c9SAttilio Rao #endif 596651175c9SAttilio Rao 597047dd67eSAttilio Rao /* 598047dd67eSAttilio Rao * Try to set the LK_SHARED_WAITERS flag. If we fail, 599047dd67eSAttilio Rao * loop back and retry. 600047dd67eSAttilio Rao */ 601047dd67eSAttilio Rao if ((x & LK_SHARED_WAITERS) == 0) { 602047dd67eSAttilio Rao if (!atomic_cmpset_acq_ptr(&lk->lk_lock, x, 603047dd67eSAttilio Rao x | LK_SHARED_WAITERS)) { 604047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 605047dd67eSAttilio Rao continue; 606047dd67eSAttilio Rao } 607047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p set shared waiters flag", 608047dd67eSAttilio Rao __func__, lk); 609047dd67eSAttilio Rao } 610047dd67eSAttilio Rao 611047dd67eSAttilio Rao /* 612047dd67eSAttilio Rao * As far as we have been unable to acquire the 613047dd67eSAttilio Rao * shared lock and the shared waiters flag is set, 614047dd67eSAttilio Rao * we will sleep. 615047dd67eSAttilio Rao */ 616047dd67eSAttilio Rao error = sleeplk(lk, flags, ilk, iwmesg, ipri, itimo, 617047dd67eSAttilio Rao SQ_SHARED_QUEUE); 618047dd67eSAttilio Rao flags &= ~LK_INTERLOCK; 619047dd67eSAttilio Rao if (error) { 620047dd67eSAttilio Rao LOCK_LOG3(lk, 621047dd67eSAttilio Rao "%s: interrupted sleep for %p with %d", 622047dd67eSAttilio Rao __func__, lk, error); 623047dd67eSAttilio Rao break; 624047dd67eSAttilio Rao } 625047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p resuming from the sleep queue", 626047dd67eSAttilio Rao __func__, lk); 627047dd67eSAttilio Rao } 628047dd67eSAttilio Rao if (error == 0) { 629047dd67eSAttilio Rao lock_profile_obtain_lock_success(&lk->lock_object, 630047dd67eSAttilio Rao contested, waittime, file, line); 631047dd67eSAttilio Rao LOCK_LOG_LOCK("SLOCK", &lk->lock_object, 0, 0, file, 632047dd67eSAttilio Rao line); 633e5f94314SAttilio Rao WITNESS_LOCK(&lk->lock_object, LK_TRYWIT(flags), file, 634e5f94314SAttilio Rao line); 635047dd67eSAttilio Rao TD_LOCKS_INC(curthread); 636047dd67eSAttilio Rao TD_SLOCKS_INC(curthread); 637047dd67eSAttilio Rao STACK_SAVE(lk); 638047dd67eSAttilio Rao } 639047dd67eSAttilio Rao break; 640047dd67eSAttilio Rao case LK_UPGRADE: 641047dd67eSAttilio Rao _lockmgr_assert(lk, KA_SLOCKED, file, line); 642651175c9SAttilio Rao v = lk->lk_lock; 643651175c9SAttilio Rao x = v & LK_ALL_WAITERS; 644651175c9SAttilio Rao v &= LK_EXCLUSIVE_SPINNERS; 645047dd67eSAttilio Rao 646047dd67eSAttilio Rao /* 647047dd67eSAttilio Rao * Try to switch from one shared lock to an exclusive one. 648047dd67eSAttilio Rao * We need to preserve waiters flags during the operation. 649047dd67eSAttilio Rao */ 650651175c9SAttilio Rao if (atomic_cmpset_ptr(&lk->lk_lock, LK_SHARERS_LOCK(1) | x | v, 651047dd67eSAttilio Rao tid | x)) { 652047dd67eSAttilio Rao LOCK_LOG_LOCK("XUPGRADE", &lk->lock_object, 0, 0, file, 653047dd67eSAttilio Rao line); 654e5f94314SAttilio Rao WITNESS_UPGRADE(&lk->lock_object, LOP_EXCLUSIVE | 655e5f94314SAttilio Rao LK_TRYWIT(flags), file, line); 656047dd67eSAttilio Rao TD_SLOCKS_DEC(curthread); 657047dd67eSAttilio Rao break; 658047dd67eSAttilio Rao } 659047dd67eSAttilio Rao 660047dd67eSAttilio Rao /* 661047dd67eSAttilio Rao * We have been unable to succeed in upgrading, so just 662047dd67eSAttilio Rao * give up the shared lock. 663047dd67eSAttilio Rao */ 664814f26daSJohn Baldwin wakeup_swapper |= wakeupshlk(lk, file, line); 665047dd67eSAttilio Rao 666047dd67eSAttilio Rao /* FALLTHROUGH */ 667047dd67eSAttilio Rao case LK_EXCLUSIVE: 668e5f94314SAttilio Rao if (LK_CAN_WITNESS(flags)) 669e5f94314SAttilio Rao WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER | 67041313430SJohn Baldwin LOP_EXCLUSIVE, file, line, ilk); 671047dd67eSAttilio Rao 672047dd67eSAttilio Rao /* 67396f1567fSKonstantin Belousov * If curthread already holds the lock and this one is 674047dd67eSAttilio Rao * allowed to recurse, simply recurse on it. 675047dd67eSAttilio Rao */ 676047dd67eSAttilio Rao if (lockmgr_xlocked(lk)) { 677047dd67eSAttilio Rao if ((flags & LK_CANRECURSE) == 0 && 678f0830182SAttilio Rao (lk->lock_object.lo_flags & LO_RECURSABLE) == 0) { 679047dd67eSAttilio Rao 680047dd67eSAttilio Rao /* 681047dd67eSAttilio Rao * If the lock is expected to not panic just 682047dd67eSAttilio Rao * give up and return. 683047dd67eSAttilio Rao */ 684047dd67eSAttilio Rao if (LK_TRYOP(flags)) { 685047dd67eSAttilio Rao LOCK_LOG2(lk, 686047dd67eSAttilio Rao "%s: %p fails the try operation", 687047dd67eSAttilio Rao __func__, lk); 688047dd67eSAttilio Rao error = EBUSY; 689047dd67eSAttilio Rao break; 690047dd67eSAttilio Rao } 691047dd67eSAttilio Rao if (flags & LK_INTERLOCK) 692047dd67eSAttilio Rao class->lc_unlock(ilk); 693047dd67eSAttilio Rao panic("%s: recursing on non recursive lockmgr %s @ %s:%d\n", 694047dd67eSAttilio Rao __func__, iwmesg, file, line); 695047dd67eSAttilio Rao } 696047dd67eSAttilio Rao lk->lk_recurse++; 697047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p recursing", __func__, lk); 698047dd67eSAttilio Rao LOCK_LOG_LOCK("XLOCK", &lk->lock_object, 0, 699047dd67eSAttilio Rao lk->lk_recurse, file, line); 700e5f94314SAttilio Rao WITNESS_LOCK(&lk->lock_object, LOP_EXCLUSIVE | 701e5f94314SAttilio Rao LK_TRYWIT(flags), file, line); 702047dd67eSAttilio Rao TD_LOCKS_INC(curthread); 703047dd67eSAttilio Rao break; 704047dd67eSAttilio Rao } 705047dd67eSAttilio Rao 706047dd67eSAttilio Rao while (!atomic_cmpset_acq_ptr(&lk->lk_lock, LK_UNLOCKED, 707047dd67eSAttilio Rao tid)) { 708047dd67eSAttilio Rao lock_profile_obtain_lock_failed(&lk->lock_object, 709047dd67eSAttilio Rao &contested, &waittime); 710047dd67eSAttilio Rao 711047dd67eSAttilio Rao /* 712047dd67eSAttilio Rao * If the lock is expected to not sleep just give up 713047dd67eSAttilio Rao * and return. 714047dd67eSAttilio Rao */ 715047dd67eSAttilio Rao if (LK_TRYOP(flags)) { 716047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p fails the try operation", 717047dd67eSAttilio Rao __func__, lk); 718047dd67eSAttilio Rao error = EBUSY; 719047dd67eSAttilio Rao break; 720047dd67eSAttilio Rao } 721047dd67eSAttilio Rao 722651175c9SAttilio Rao #ifdef ADAPTIVE_LOCKMGRS 723651175c9SAttilio Rao /* 724651175c9SAttilio Rao * If the owner is running on another CPU, spin until 725651175c9SAttilio Rao * the owner stops running or the state of the lock 726651175c9SAttilio Rao * changes. 727651175c9SAttilio Rao */ 728651175c9SAttilio Rao x = lk->lk_lock; 729651175c9SAttilio Rao if (LK_CAN_ADAPT(lk, flags) && (x & LK_SHARE) == 0 && 730651175c9SAttilio Rao LK_HOLDER(x) != LK_KERNPROC) { 731651175c9SAttilio Rao owner = (struct thread *)LK_HOLDER(x); 732651175c9SAttilio Rao if (LOCK_LOG_TEST(&lk->lock_object, 0)) 733651175c9SAttilio Rao CTR3(KTR_LOCK, 734651175c9SAttilio Rao "%s: spinning on %p held by %p", 735651175c9SAttilio Rao __func__, lk, owner); 736651175c9SAttilio Rao 737651175c9SAttilio Rao /* 738651175c9SAttilio Rao * If we are holding also an interlock drop it 739651175c9SAttilio Rao * in order to avoid a deadlock if the lockmgr 740651175c9SAttilio Rao * owner is adaptively spinning on the 741651175c9SAttilio Rao * interlock itself. 742651175c9SAttilio Rao */ 743651175c9SAttilio Rao if (flags & LK_INTERLOCK) { 744651175c9SAttilio Rao class->lc_unlock(ilk); 745651175c9SAttilio Rao flags &= ~LK_INTERLOCK; 746651175c9SAttilio Rao } 747651175c9SAttilio Rao GIANT_SAVE(); 748651175c9SAttilio Rao while (LK_HOLDER(lk->lk_lock) == 749651175c9SAttilio Rao (uintptr_t)owner && TD_IS_RUNNING(owner)) 750651175c9SAttilio Rao cpu_spinwait(); 7518d3635c4SAttilio Rao GIANT_RESTORE(); 7528d3635c4SAttilio Rao continue; 753651175c9SAttilio Rao } else if (LK_CAN_ADAPT(lk, flags) && 754651175c9SAttilio Rao (x & LK_SHARE) != 0 && LK_SHARERS(x) && 755651175c9SAttilio Rao spintries < alk_retries) { 756651175c9SAttilio Rao if ((x & LK_EXCLUSIVE_SPINNERS) == 0 && 757651175c9SAttilio Rao !atomic_cmpset_ptr(&lk->lk_lock, x, 758651175c9SAttilio Rao x | LK_EXCLUSIVE_SPINNERS)) 759651175c9SAttilio Rao continue; 760651175c9SAttilio Rao if (flags & LK_INTERLOCK) { 761651175c9SAttilio Rao class->lc_unlock(ilk); 762651175c9SAttilio Rao flags &= ~LK_INTERLOCK; 763651175c9SAttilio Rao } 764651175c9SAttilio Rao GIANT_SAVE(); 765651175c9SAttilio Rao spintries++; 766651175c9SAttilio Rao for (i = 0; i < alk_loops; i++) { 767651175c9SAttilio Rao if (LOCK_LOG_TEST(&lk->lock_object, 0)) 768651175c9SAttilio Rao CTR4(KTR_LOCK, 769651175c9SAttilio Rao "%s: shared spinning on %p with %u and %u", 770651175c9SAttilio Rao __func__, lk, spintries, i); 771651175c9SAttilio Rao if ((lk->lk_lock & 772651175c9SAttilio Rao LK_EXCLUSIVE_SPINNERS) == 0) 773651175c9SAttilio Rao break; 774651175c9SAttilio Rao cpu_spinwait(); 775651175c9SAttilio Rao } 7768d3635c4SAttilio Rao GIANT_RESTORE(); 777651175c9SAttilio Rao if (i != alk_loops) 778651175c9SAttilio Rao continue; 779651175c9SAttilio Rao } 780651175c9SAttilio Rao #endif 781651175c9SAttilio Rao 782047dd67eSAttilio Rao /* 783047dd67eSAttilio Rao * Acquire the sleepqueue chain lock because we 784047dd67eSAttilio Rao * probabilly will need to manipulate waiters flags. 785047dd67eSAttilio Rao */ 786047dd67eSAttilio Rao sleepq_lock(&lk->lock_object); 787047dd67eSAttilio Rao x = lk->lk_lock; 788047dd67eSAttilio Rao 789047dd67eSAttilio Rao /* 790047dd67eSAttilio Rao * if the lock has been released while we spun on 791047dd67eSAttilio Rao * the sleepqueue chain lock just try again. 792047dd67eSAttilio Rao */ 793047dd67eSAttilio Rao if (x == LK_UNLOCKED) { 794047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 795047dd67eSAttilio Rao continue; 796047dd67eSAttilio Rao } 797047dd67eSAttilio Rao 798651175c9SAttilio Rao #ifdef ADAPTIVE_LOCKMGRS 799651175c9SAttilio Rao /* 800651175c9SAttilio Rao * The current lock owner might have started executing 801651175c9SAttilio Rao * on another CPU (or the lock could have changed 802651175c9SAttilio Rao * owner) while we were waiting on the turnstile 803651175c9SAttilio Rao * chain lock. If so, drop the turnstile lock and try 804651175c9SAttilio Rao * again. 805651175c9SAttilio Rao */ 806651175c9SAttilio Rao if (LK_CAN_ADAPT(lk, flags) && (x & LK_SHARE) == 0 && 807651175c9SAttilio Rao LK_HOLDER(x) != LK_KERNPROC) { 808651175c9SAttilio Rao owner = (struct thread *)LK_HOLDER(x); 809651175c9SAttilio Rao if (TD_IS_RUNNING(owner)) { 810651175c9SAttilio Rao sleepq_release(&lk->lock_object); 811651175c9SAttilio Rao continue; 812651175c9SAttilio Rao } 813651175c9SAttilio Rao } 814651175c9SAttilio Rao #endif 815651175c9SAttilio Rao 816047dd67eSAttilio Rao /* 817047dd67eSAttilio Rao * The lock can be in the state where there is a 818047dd67eSAttilio Rao * pending queue of waiters, but still no owner. 819047dd67eSAttilio Rao * This happens when the lock is contested and an 820047dd67eSAttilio Rao * owner is going to claim the lock. 821047dd67eSAttilio Rao * If curthread is the one successfully acquiring it 822047dd67eSAttilio Rao * claim lock ownership and return, preserving waiters 823047dd67eSAttilio Rao * flags. 824047dd67eSAttilio Rao */ 825651175c9SAttilio Rao v = x & (LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS); 826651175c9SAttilio Rao if ((x & ~v) == LK_UNLOCKED) { 827651175c9SAttilio Rao v &= ~LK_EXCLUSIVE_SPINNERS; 828047dd67eSAttilio Rao if (atomic_cmpset_acq_ptr(&lk->lk_lock, x, 829047dd67eSAttilio Rao tid | v)) { 830047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 831047dd67eSAttilio Rao LOCK_LOG2(lk, 832047dd67eSAttilio Rao "%s: %p claimed by a new writer", 833047dd67eSAttilio Rao __func__, lk); 834047dd67eSAttilio Rao break; 835047dd67eSAttilio Rao } 836047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 837047dd67eSAttilio Rao continue; 838047dd67eSAttilio Rao } 839047dd67eSAttilio Rao 840047dd67eSAttilio Rao /* 841047dd67eSAttilio Rao * Try to set the LK_EXCLUSIVE_WAITERS flag. If we 842047dd67eSAttilio Rao * fail, loop back and retry. 843047dd67eSAttilio Rao */ 844047dd67eSAttilio Rao if ((x & LK_EXCLUSIVE_WAITERS) == 0) { 845047dd67eSAttilio Rao if (!atomic_cmpset_ptr(&lk->lk_lock, x, 846047dd67eSAttilio Rao x | LK_EXCLUSIVE_WAITERS)) { 847047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 848047dd67eSAttilio Rao continue; 849047dd67eSAttilio Rao } 850047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p set excl waiters flag", 851047dd67eSAttilio Rao __func__, lk); 852047dd67eSAttilio Rao } 853047dd67eSAttilio Rao 854047dd67eSAttilio Rao /* 855047dd67eSAttilio Rao * As far as we have been unable to acquire the 856047dd67eSAttilio Rao * exclusive lock and the exclusive waiters flag 857047dd67eSAttilio Rao * is set, we will sleep. 858047dd67eSAttilio Rao */ 859047dd67eSAttilio Rao error = sleeplk(lk, flags, ilk, iwmesg, ipri, itimo, 860047dd67eSAttilio Rao SQ_EXCLUSIVE_QUEUE); 861047dd67eSAttilio Rao flags &= ~LK_INTERLOCK; 862047dd67eSAttilio Rao if (error) { 863047dd67eSAttilio Rao LOCK_LOG3(lk, 864047dd67eSAttilio Rao "%s: interrupted sleep for %p with %d", 865047dd67eSAttilio Rao __func__, lk, error); 866047dd67eSAttilio Rao break; 867047dd67eSAttilio Rao } 868047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p resuming from the sleep queue", 869047dd67eSAttilio Rao __func__, lk); 870047dd67eSAttilio Rao } 871047dd67eSAttilio Rao if (error == 0) { 872047dd67eSAttilio Rao lock_profile_obtain_lock_success(&lk->lock_object, 873047dd67eSAttilio Rao contested, waittime, file, line); 874047dd67eSAttilio Rao LOCK_LOG_LOCK("XLOCK", &lk->lock_object, 0, 875047dd67eSAttilio Rao lk->lk_recurse, file, line); 876e5f94314SAttilio Rao WITNESS_LOCK(&lk->lock_object, LOP_EXCLUSIVE | 877e5f94314SAttilio Rao LK_TRYWIT(flags), file, line); 878047dd67eSAttilio Rao TD_LOCKS_INC(curthread); 879047dd67eSAttilio Rao STACK_SAVE(lk); 880047dd67eSAttilio Rao } 881047dd67eSAttilio Rao break; 882047dd67eSAttilio Rao case LK_DOWNGRADE: 883047dd67eSAttilio Rao _lockmgr_assert(lk, KA_XLOCKED | KA_NOTRECURSED, file, line); 884e5f94314SAttilio Rao LOCK_LOG_LOCK("XDOWNGRADE", &lk->lock_object, 0, 0, file, line); 885e5f94314SAttilio Rao WITNESS_DOWNGRADE(&lk->lock_object, 0, file, line); 886e5f94314SAttilio Rao TD_SLOCKS_INC(curthread); 887047dd67eSAttilio Rao 888047dd67eSAttilio Rao /* 889047dd67eSAttilio Rao * In order to preserve waiters flags, just spin. 890047dd67eSAttilio Rao */ 891047dd67eSAttilio Rao for (;;) { 892651175c9SAttilio Rao x = lk->lk_lock; 893651175c9SAttilio Rao MPASS((x & LK_EXCLUSIVE_SPINNERS) == 0); 894651175c9SAttilio Rao x &= LK_ALL_WAITERS; 895047dd67eSAttilio Rao if (atomic_cmpset_rel_ptr(&lk->lk_lock, tid | x, 896e5f94314SAttilio Rao LK_SHARERS_LOCK(1) | x)) 897047dd67eSAttilio Rao break; 898047dd67eSAttilio Rao cpu_spinwait(); 899047dd67eSAttilio Rao } 900047dd67eSAttilio Rao break; 901047dd67eSAttilio Rao case LK_RELEASE: 902047dd67eSAttilio Rao _lockmgr_assert(lk, KA_LOCKED, file, line); 903047dd67eSAttilio Rao x = lk->lk_lock; 904047dd67eSAttilio Rao 905047dd67eSAttilio Rao if ((x & LK_SHARE) == 0) { 906047dd67eSAttilio Rao 907047dd67eSAttilio Rao /* 908047dd67eSAttilio Rao * As first option, treact the lock as if it has not 909047dd67eSAttilio Rao * any waiter. 910047dd67eSAttilio Rao * Fix-up the tid var if the lock has been disowned. 911047dd67eSAttilio Rao */ 912047dd67eSAttilio Rao if (LK_HOLDER(x) == LK_KERNPROC) 913047dd67eSAttilio Rao tid = LK_KERNPROC; 914e5f94314SAttilio Rao else { 915e5f94314SAttilio Rao WITNESS_UNLOCK(&lk->lock_object, LOP_EXCLUSIVE, 916e5f94314SAttilio Rao file, line); 917047dd67eSAttilio Rao TD_LOCKS_DEC(curthread); 918e5f94314SAttilio Rao } 919047dd67eSAttilio Rao LOCK_LOG_LOCK("XUNLOCK", &lk->lock_object, 0, 920047dd67eSAttilio Rao lk->lk_recurse, file, line); 921047dd67eSAttilio Rao 922047dd67eSAttilio Rao /* 923047dd67eSAttilio Rao * The lock is held in exclusive mode. 924047dd67eSAttilio Rao * If the lock is recursed also, then unrecurse it. 925047dd67eSAttilio Rao */ 926047dd67eSAttilio Rao if (lockmgr_xlocked(lk) && lockmgr_recursed(lk)) { 927047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p unrecursing", __func__, 928047dd67eSAttilio Rao lk); 929047dd67eSAttilio Rao lk->lk_recurse--; 930047dd67eSAttilio Rao break; 931047dd67eSAttilio Rao } 93204a28689SJeff Roberson if (tid != LK_KERNPROC) 933047dd67eSAttilio Rao lock_profile_release_lock(&lk->lock_object); 934047dd67eSAttilio Rao 935047dd67eSAttilio Rao if (atomic_cmpset_rel_ptr(&lk->lk_lock, tid, 936047dd67eSAttilio Rao LK_UNLOCKED)) 937047dd67eSAttilio Rao break; 938047dd67eSAttilio Rao 939047dd67eSAttilio Rao sleepq_lock(&lk->lock_object); 940651175c9SAttilio Rao x = lk->lk_lock; 941047dd67eSAttilio Rao v = LK_UNLOCKED; 942047dd67eSAttilio Rao 943047dd67eSAttilio Rao /* 944047dd67eSAttilio Rao * If the lock has exclusive waiters, give them 945047dd67eSAttilio Rao * preference in order to avoid deadlock with 946047dd67eSAttilio Rao * shared runners up. 9472028867dSAttilio Rao * If interruptible sleeps left the exclusive queue 9482028867dSAttilio Rao * empty avoid a starvation for the threads sleeping 9492028867dSAttilio Rao * on the shared queue by giving them precedence 9502028867dSAttilio Rao * and cleaning up the exclusive waiters bit anyway. 951c636ba83SAttilio Rao * Please note that lk_exslpfail count may be lying 952c636ba83SAttilio Rao * about the real number of waiters with the 953c636ba83SAttilio Rao * LK_SLEEPFAIL flag on because they may be used in 954c636ba83SAttilio Rao * conjuction with interruptible sleeps so 955c636ba83SAttilio Rao * lk_exslpfail is consider as a 'upper limit' bound, 956c636ba83SAttilio Rao * considering the edge cases. 957047dd67eSAttilio Rao */ 958651175c9SAttilio Rao MPASS((x & LK_EXCLUSIVE_SPINNERS) == 0); 9592028867dSAttilio Rao realexslp = sleepq_sleepcnt(&lk->lock_object, 9602028867dSAttilio Rao SQ_EXCLUSIVE_QUEUE); 9612028867dSAttilio Rao if ((x & LK_EXCLUSIVE_WAITERS) != 0 && realexslp != 0) { 9622028867dSAttilio Rao if (lk->lk_exslpfail < realexslp) { 9632028867dSAttilio Rao lk->lk_exslpfail = 0; 964047dd67eSAttilio Rao queue = SQ_EXCLUSIVE_QUEUE; 965047dd67eSAttilio Rao v |= (x & LK_SHARED_WAITERS); 966047dd67eSAttilio Rao } else { 9672028867dSAttilio Rao lk->lk_exslpfail = 0; 9682028867dSAttilio Rao LOCK_LOG2(lk, 9692028867dSAttilio Rao "%s: %p has only LK_SLEEPFAIL sleepers", 9702028867dSAttilio Rao __func__, lk); 9712028867dSAttilio Rao LOCK_LOG2(lk, 9722028867dSAttilio Rao "%s: %p waking up threads on the exclusive queue", 9732028867dSAttilio Rao __func__, lk); 9742028867dSAttilio Rao wakeup_swapper = 9752028867dSAttilio Rao sleepq_broadcast(&lk->lock_object, 9762028867dSAttilio Rao SLEEPQ_LK, 0, SQ_EXCLUSIVE_QUEUE); 9772028867dSAttilio Rao queue = SQ_SHARED_QUEUE; 9782028867dSAttilio Rao } 9792028867dSAttilio Rao } else { 9809dbf7a62SAttilio Rao 9819dbf7a62SAttilio Rao /* 9829dbf7a62SAttilio Rao * Exclusive waiters sleeping with LK_SLEEPFAIL 9839dbf7a62SAttilio Rao * on and using interruptible sleeps/timeout 9849dbf7a62SAttilio Rao * may have left spourious lk_exslpfail counts 9859dbf7a62SAttilio Rao * on, so clean it up anyway. 9869dbf7a62SAttilio Rao */ 9879dbf7a62SAttilio Rao lk->lk_exslpfail = 0; 988047dd67eSAttilio Rao queue = SQ_SHARED_QUEUE; 989047dd67eSAttilio Rao } 990047dd67eSAttilio Rao 991047dd67eSAttilio Rao LOCK_LOG3(lk, 992047dd67eSAttilio Rao "%s: %p waking up threads on the %s queue", 993047dd67eSAttilio Rao __func__, lk, queue == SQ_SHARED_QUEUE ? "shared" : 994047dd67eSAttilio Rao "exclusive"); 995047dd67eSAttilio Rao atomic_store_rel_ptr(&lk->lk_lock, v); 9962028867dSAttilio Rao wakeup_swapper |= sleepq_broadcast(&lk->lock_object, 997da7bbd2cSJohn Baldwin SLEEPQ_LK, 0, queue); 998047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 999047dd67eSAttilio Rao break; 1000047dd67eSAttilio Rao } else 1001da7bbd2cSJohn Baldwin wakeup_swapper = wakeupshlk(lk, file, line); 1002047dd67eSAttilio Rao break; 1003047dd67eSAttilio Rao case LK_DRAIN: 1004e5f94314SAttilio Rao if (LK_CAN_WITNESS(flags)) 1005e5f94314SAttilio Rao WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER | 100641313430SJohn Baldwin LOP_EXCLUSIVE, file, line, ilk); 1007047dd67eSAttilio Rao 1008047dd67eSAttilio Rao /* 100996f1567fSKonstantin Belousov * Trying to drain a lock we already own will result in a 1010047dd67eSAttilio Rao * deadlock. 1011047dd67eSAttilio Rao */ 1012047dd67eSAttilio Rao if (lockmgr_xlocked(lk)) { 1013047dd67eSAttilio Rao if (flags & LK_INTERLOCK) 1014047dd67eSAttilio Rao class->lc_unlock(ilk); 1015047dd67eSAttilio Rao panic("%s: draining %s with the lock held @ %s:%d\n", 1016047dd67eSAttilio Rao __func__, iwmesg, file, line); 1017047dd67eSAttilio Rao } 1018047dd67eSAttilio Rao 1019047dd67eSAttilio Rao while (!atomic_cmpset_acq_ptr(&lk->lk_lock, LK_UNLOCKED, tid)) { 1020047dd67eSAttilio Rao lock_profile_obtain_lock_failed(&lk->lock_object, 1021047dd67eSAttilio Rao &contested, &waittime); 1022047dd67eSAttilio Rao 1023047dd67eSAttilio Rao /* 1024047dd67eSAttilio Rao * If the lock is expected to not sleep just give up 1025047dd67eSAttilio Rao * and return. 1026047dd67eSAttilio Rao */ 1027047dd67eSAttilio Rao if (LK_TRYOP(flags)) { 1028047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p fails the try operation", 1029047dd67eSAttilio Rao __func__, lk); 1030047dd67eSAttilio Rao error = EBUSY; 1031047dd67eSAttilio Rao break; 1032047dd67eSAttilio Rao } 1033047dd67eSAttilio Rao 1034047dd67eSAttilio Rao /* 1035047dd67eSAttilio Rao * Acquire the sleepqueue chain lock because we 1036047dd67eSAttilio Rao * probabilly will need to manipulate waiters flags. 1037047dd67eSAttilio Rao */ 1038047dd67eSAttilio Rao sleepq_lock(&lk->lock_object); 1039047dd67eSAttilio Rao x = lk->lk_lock; 1040047dd67eSAttilio Rao 1041047dd67eSAttilio Rao /* 1042047dd67eSAttilio Rao * if the lock has been released while we spun on 1043047dd67eSAttilio Rao * the sleepqueue chain lock just try again. 1044047dd67eSAttilio Rao */ 1045047dd67eSAttilio Rao if (x == LK_UNLOCKED) { 1046047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 1047047dd67eSAttilio Rao continue; 1048047dd67eSAttilio Rao } 1049047dd67eSAttilio Rao 1050651175c9SAttilio Rao v = x & (LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS); 1051651175c9SAttilio Rao if ((x & ~v) == LK_UNLOCKED) { 1052651175c9SAttilio Rao v = (x & ~LK_EXCLUSIVE_SPINNERS); 10532028867dSAttilio Rao 10542028867dSAttilio Rao /* 10552028867dSAttilio Rao * If interruptible sleeps left the exclusive 10562028867dSAttilio Rao * queue empty avoid a starvation for the 10572028867dSAttilio Rao * threads sleeping on the shared queue by 10582028867dSAttilio Rao * giving them precedence and cleaning up the 10592028867dSAttilio Rao * exclusive waiters bit anyway. 1060c636ba83SAttilio Rao * Please note that lk_exslpfail count may be 1061c636ba83SAttilio Rao * lying about the real number of waiters with 1062c636ba83SAttilio Rao * the LK_SLEEPFAIL flag on because they may 1063c636ba83SAttilio Rao * be used in conjuction with interruptible 1064c636ba83SAttilio Rao * sleeps so lk_exslpfail is consider as a 1065c636ba83SAttilio Rao * 'upper limit' bound, considering the edge 1066c636ba83SAttilio Rao * cases. 10672028867dSAttilio Rao */ 1068047dd67eSAttilio Rao if (v & LK_EXCLUSIVE_WAITERS) { 1069047dd67eSAttilio Rao queue = SQ_EXCLUSIVE_QUEUE; 1070047dd67eSAttilio Rao v &= ~LK_EXCLUSIVE_WAITERS; 1071047dd67eSAttilio Rao } else { 10729dbf7a62SAttilio Rao 10739dbf7a62SAttilio Rao /* 10749dbf7a62SAttilio Rao * Exclusive waiters sleeping with 10759dbf7a62SAttilio Rao * LK_SLEEPFAIL on and using 10769dbf7a62SAttilio Rao * interruptible sleeps/timeout may 10779dbf7a62SAttilio Rao * have left spourious lk_exslpfail 10789dbf7a62SAttilio Rao * counts on, so clean it up anyway. 10799dbf7a62SAttilio Rao */ 1080047dd67eSAttilio Rao MPASS(v & LK_SHARED_WAITERS); 10819dbf7a62SAttilio Rao lk->lk_exslpfail = 0; 1082047dd67eSAttilio Rao queue = SQ_SHARED_QUEUE; 1083047dd67eSAttilio Rao v &= ~LK_SHARED_WAITERS; 1084047dd67eSAttilio Rao } 10852028867dSAttilio Rao if (queue == SQ_EXCLUSIVE_QUEUE) { 10862028867dSAttilio Rao realexslp = 10872028867dSAttilio Rao sleepq_sleepcnt(&lk->lock_object, 10882028867dSAttilio Rao SQ_EXCLUSIVE_QUEUE); 10892028867dSAttilio Rao if (lk->lk_exslpfail >= realexslp) { 10902028867dSAttilio Rao lk->lk_exslpfail = 0; 10912028867dSAttilio Rao queue = SQ_SHARED_QUEUE; 10922028867dSAttilio Rao v &= ~LK_SHARED_WAITERS; 10932028867dSAttilio Rao if (realexslp != 0) { 10942028867dSAttilio Rao LOCK_LOG2(lk, 10952028867dSAttilio Rao "%s: %p has only LK_SLEEPFAIL sleepers", 10962028867dSAttilio Rao __func__, lk); 10972028867dSAttilio Rao LOCK_LOG2(lk, 10982028867dSAttilio Rao "%s: %p waking up threads on the exclusive queue", 10992028867dSAttilio Rao __func__, lk); 11002028867dSAttilio Rao wakeup_swapper = 11012028867dSAttilio Rao sleepq_broadcast( 11022028867dSAttilio Rao &lk->lock_object, 11032028867dSAttilio Rao SLEEPQ_LK, 0, 11042028867dSAttilio Rao SQ_EXCLUSIVE_QUEUE); 11052028867dSAttilio Rao } 11062028867dSAttilio Rao } else 11072028867dSAttilio Rao lk->lk_exslpfail = 0; 11082028867dSAttilio Rao } 1109047dd67eSAttilio Rao if (!atomic_cmpset_ptr(&lk->lk_lock, x, v)) { 1110047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 1111047dd67eSAttilio Rao continue; 1112047dd67eSAttilio Rao } 1113047dd67eSAttilio Rao LOCK_LOG3(lk, 1114047dd67eSAttilio Rao "%s: %p waking up all threads on the %s queue", 1115047dd67eSAttilio Rao __func__, lk, queue == SQ_SHARED_QUEUE ? 1116047dd67eSAttilio Rao "shared" : "exclusive"); 1117814f26daSJohn Baldwin wakeup_swapper |= sleepq_broadcast( 1118da7bbd2cSJohn Baldwin &lk->lock_object, SLEEPQ_LK, 0, queue); 1119047dd67eSAttilio Rao 1120047dd67eSAttilio Rao /* 1121047dd67eSAttilio Rao * If shared waiters have been woken up we need 1122047dd67eSAttilio Rao * to wait for one of them to acquire the lock 1123047dd67eSAttilio Rao * before to set the exclusive waiters in 1124047dd67eSAttilio Rao * order to avoid a deadlock. 1125047dd67eSAttilio Rao */ 1126047dd67eSAttilio Rao if (queue == SQ_SHARED_QUEUE) { 1127047dd67eSAttilio Rao for (v = lk->lk_lock; 1128047dd67eSAttilio Rao (v & LK_SHARE) && !LK_SHARERS(v); 1129047dd67eSAttilio Rao v = lk->lk_lock) 1130047dd67eSAttilio Rao cpu_spinwait(); 1131047dd67eSAttilio Rao } 1132047dd67eSAttilio Rao } 1133047dd67eSAttilio Rao 1134047dd67eSAttilio Rao /* 1135047dd67eSAttilio Rao * Try to set the LK_EXCLUSIVE_WAITERS flag. If we 1136047dd67eSAttilio Rao * fail, loop back and retry. 1137047dd67eSAttilio Rao */ 1138047dd67eSAttilio Rao if ((x & LK_EXCLUSIVE_WAITERS) == 0) { 1139047dd67eSAttilio Rao if (!atomic_cmpset_ptr(&lk->lk_lock, x, 1140047dd67eSAttilio Rao x | LK_EXCLUSIVE_WAITERS)) { 1141047dd67eSAttilio Rao sleepq_release(&lk->lock_object); 1142047dd67eSAttilio Rao continue; 1143047dd67eSAttilio Rao } 1144047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p set drain waiters flag", 1145047dd67eSAttilio Rao __func__, lk); 1146047dd67eSAttilio Rao } 1147047dd67eSAttilio Rao 1148047dd67eSAttilio Rao /* 1149047dd67eSAttilio Rao * As far as we have been unable to acquire the 1150047dd67eSAttilio Rao * exclusive lock and the exclusive waiters flag 1151047dd67eSAttilio Rao * is set, we will sleep. 1152047dd67eSAttilio Rao */ 1153047dd67eSAttilio Rao if (flags & LK_INTERLOCK) { 1154047dd67eSAttilio Rao class->lc_unlock(ilk); 1155047dd67eSAttilio Rao flags &= ~LK_INTERLOCK; 1156047dd67eSAttilio Rao } 1157e5f94314SAttilio Rao GIANT_SAVE(); 1158047dd67eSAttilio Rao sleepq_add(&lk->lock_object, NULL, iwmesg, SLEEPQ_LK, 1159047dd67eSAttilio Rao SQ_EXCLUSIVE_QUEUE); 1160047dd67eSAttilio Rao sleepq_wait(&lk->lock_object, ipri & PRIMASK); 1161e5f94314SAttilio Rao GIANT_RESTORE(); 1162047dd67eSAttilio Rao LOCK_LOG2(lk, "%s: %p resuming from the sleep queue", 1163047dd67eSAttilio Rao __func__, lk); 1164047dd67eSAttilio Rao } 1165047dd67eSAttilio Rao 1166047dd67eSAttilio Rao if (error == 0) { 1167047dd67eSAttilio Rao lock_profile_obtain_lock_success(&lk->lock_object, 1168047dd67eSAttilio Rao contested, waittime, file, line); 1169047dd67eSAttilio Rao LOCK_LOG_LOCK("DRAIN", &lk->lock_object, 0, 1170047dd67eSAttilio Rao lk->lk_recurse, file, line); 1171e5f94314SAttilio Rao WITNESS_LOCK(&lk->lock_object, LOP_EXCLUSIVE | 1172e5f94314SAttilio Rao LK_TRYWIT(flags), file, line); 1173047dd67eSAttilio Rao TD_LOCKS_INC(curthread); 1174047dd67eSAttilio Rao STACK_SAVE(lk); 1175047dd67eSAttilio Rao } 1176047dd67eSAttilio Rao break; 1177047dd67eSAttilio Rao default: 1178047dd67eSAttilio Rao if (flags & LK_INTERLOCK) 1179047dd67eSAttilio Rao class->lc_unlock(ilk); 1180047dd67eSAttilio Rao panic("%s: unknown lockmgr request 0x%x\n", __func__, op); 1181047dd67eSAttilio Rao } 1182047dd67eSAttilio Rao 1183047dd67eSAttilio Rao if (flags & LK_INTERLOCK) 1184047dd67eSAttilio Rao class->lc_unlock(ilk); 1185da7bbd2cSJohn Baldwin if (wakeup_swapper) 1186da7bbd2cSJohn Baldwin kick_proc0(); 1187047dd67eSAttilio Rao 1188047dd67eSAttilio Rao return (error); 1189047dd67eSAttilio Rao } 1190047dd67eSAttilio Rao 1191d7a7e179SAttilio Rao void 1192047dd67eSAttilio Rao _lockmgr_disown(struct lock *lk, const char *file, int line) 1193047dd67eSAttilio Rao { 1194047dd67eSAttilio Rao uintptr_t tid, x; 1195047dd67eSAttilio Rao 1196047dd67eSAttilio Rao tid = (uintptr_t)curthread; 1197047dd67eSAttilio Rao _lockmgr_assert(lk, KA_XLOCKED | KA_NOTRECURSED, file, line); 1198047dd67eSAttilio Rao 1199047dd67eSAttilio Rao /* 120096f1567fSKonstantin Belousov * If the owner is already LK_KERNPROC just skip the whole operation. 1201047dd67eSAttilio Rao */ 1202047dd67eSAttilio Rao if (LK_HOLDER(lk->lk_lock) != tid) 1203047dd67eSAttilio Rao return; 120404a28689SJeff Roberson lock_profile_release_lock(&lk->lock_object); 1205e5f94314SAttilio Rao LOCK_LOG_LOCK("XDISOWN", &lk->lock_object, 0, 0, file, line); 1206e5f94314SAttilio Rao WITNESS_UNLOCK(&lk->lock_object, LOP_EXCLUSIVE, file, line); 1207e5f94314SAttilio Rao TD_LOCKS_DEC(curthread); 1208337c5ff4SAttilio Rao STACK_SAVE(lk); 1209047dd67eSAttilio Rao 1210047dd67eSAttilio Rao /* 1211047dd67eSAttilio Rao * In order to preserve waiters flags, just spin. 1212047dd67eSAttilio Rao */ 1213047dd67eSAttilio Rao for (;;) { 1214651175c9SAttilio Rao x = lk->lk_lock; 1215651175c9SAttilio Rao MPASS((x & LK_EXCLUSIVE_SPINNERS) == 0); 1216651175c9SAttilio Rao x &= LK_ALL_WAITERS; 121722dd228dSAttilio Rao if (atomic_cmpset_rel_ptr(&lk->lk_lock, tid | x, 1218e5f94314SAttilio Rao LK_KERNPROC | x)) 1219047dd67eSAttilio Rao return; 1220047dd67eSAttilio Rao cpu_spinwait(); 1221047dd67eSAttilio Rao } 1222047dd67eSAttilio Rao } 1223047dd67eSAttilio Rao 1224047dd67eSAttilio Rao void 1225047dd67eSAttilio Rao lockmgr_printinfo(struct lock *lk) 1226d7a7e179SAttilio Rao { 1227d7a7e179SAttilio Rao struct thread *td; 1228047dd67eSAttilio Rao uintptr_t x; 1229d7a7e179SAttilio Rao 1230047dd67eSAttilio Rao if (lk->lk_lock == LK_UNLOCKED) 1231047dd67eSAttilio Rao printf("lock type %s: UNLOCKED\n", lk->lock_object.lo_name); 1232047dd67eSAttilio Rao else if (lk->lk_lock & LK_SHARE) 1233047dd67eSAttilio Rao printf("lock type %s: SHARED (count %ju)\n", 1234047dd67eSAttilio Rao lk->lock_object.lo_name, 1235047dd67eSAttilio Rao (uintmax_t)LK_SHARERS(lk->lk_lock)); 1236047dd67eSAttilio Rao else { 1237047dd67eSAttilio Rao td = lockmgr_xholder(lk); 1238047dd67eSAttilio Rao printf("lock type %s: EXCL by thread %p (pid %d)\n", 1239047dd67eSAttilio Rao lk->lock_object.lo_name, td, td->td_proc->p_pid); 1240d7a7e179SAttilio Rao } 1241d7a7e179SAttilio Rao 1242047dd67eSAttilio Rao x = lk->lk_lock; 1243047dd67eSAttilio Rao if (x & LK_EXCLUSIVE_WAITERS) 1244047dd67eSAttilio Rao printf(" with exclusive waiters pending\n"); 1245047dd67eSAttilio Rao if (x & LK_SHARED_WAITERS) 1246047dd67eSAttilio Rao printf(" with shared waiters pending\n"); 1247651175c9SAttilio Rao if (x & LK_EXCLUSIVE_SPINNERS) 1248651175c9SAttilio Rao printf(" with exclusive spinners pending\n"); 1249047dd67eSAttilio Rao 1250047dd67eSAttilio Rao STACK_PRINT(lk); 1251047dd67eSAttilio Rao } 1252047dd67eSAttilio Rao 125399448ed1SJohn Dyson int 1254047dd67eSAttilio Rao lockstatus(struct lock *lk) 125599448ed1SJohn Dyson { 1256047dd67eSAttilio Rao uintptr_t v, x; 1257047dd67eSAttilio Rao int ret; 125899448ed1SJohn Dyson 1259047dd67eSAttilio Rao ret = LK_SHARED; 1260047dd67eSAttilio Rao x = lk->lk_lock; 1261047dd67eSAttilio Rao v = LK_HOLDER(x); 12620e9eb108SAttilio Rao 1263047dd67eSAttilio Rao if ((x & LK_SHARE) == 0) { 1264047dd67eSAttilio Rao if (v == (uintptr_t)curthread || v == LK_KERNPROC) 1265047dd67eSAttilio Rao ret = LK_EXCLUSIVE; 12666bdfe06aSEivind Eklund else 1267047dd67eSAttilio Rao ret = LK_EXCLOTHER; 1268047dd67eSAttilio Rao } else if (x == LK_UNLOCKED) 1269047dd67eSAttilio Rao ret = 0; 127099448ed1SJohn Dyson 1271047dd67eSAttilio Rao return (ret); 127253bf4bb2SPeter Wemm } 1273be6847d7SJohn Baldwin 127484887fa3SAttilio Rao #ifdef INVARIANT_SUPPORT 127584887fa3SAttilio Rao #ifndef INVARIANTS 127684887fa3SAttilio Rao #undef _lockmgr_assert 127784887fa3SAttilio Rao #endif 127884887fa3SAttilio Rao 127984887fa3SAttilio Rao void 1280047dd67eSAttilio Rao _lockmgr_assert(struct lock *lk, int what, const char *file, int line) 128184887fa3SAttilio Rao { 128284887fa3SAttilio Rao int slocked = 0; 128384887fa3SAttilio Rao 128484887fa3SAttilio Rao if (panicstr != NULL) 128584887fa3SAttilio Rao return; 128684887fa3SAttilio Rao switch (what) { 128784887fa3SAttilio Rao case KA_SLOCKED: 128884887fa3SAttilio Rao case KA_SLOCKED | KA_NOTRECURSED: 128984887fa3SAttilio Rao case KA_SLOCKED | KA_RECURSED: 129084887fa3SAttilio Rao slocked = 1; 129184887fa3SAttilio Rao case KA_LOCKED: 129284887fa3SAttilio Rao case KA_LOCKED | KA_NOTRECURSED: 129384887fa3SAttilio Rao case KA_LOCKED | KA_RECURSED: 1294e5f94314SAttilio Rao #ifdef WITNESS 1295e5f94314SAttilio Rao 1296e5f94314SAttilio Rao /* 1297e5f94314SAttilio Rao * We cannot trust WITNESS if the lock is held in exclusive 1298e5f94314SAttilio Rao * mode and a call to lockmgr_disown() happened. 1299e5f94314SAttilio Rao * Workaround this skipping the check if the lock is held in 1300e5f94314SAttilio Rao * exclusive mode even for the KA_LOCKED case. 1301e5f94314SAttilio Rao */ 1302e5f94314SAttilio Rao if (slocked || (lk->lk_lock & LK_SHARE)) { 1303e5f94314SAttilio Rao witness_assert(&lk->lock_object, what, file, line); 1304e5f94314SAttilio Rao break; 1305e5f94314SAttilio Rao } 1306e5f94314SAttilio Rao #endif 1307047dd67eSAttilio Rao if (lk->lk_lock == LK_UNLOCKED || 1308047dd67eSAttilio Rao ((lk->lk_lock & LK_SHARE) == 0 && (slocked || 1309047dd67eSAttilio Rao (!lockmgr_xlocked(lk) && !lockmgr_disowned(lk))))) 131084887fa3SAttilio Rao panic("Lock %s not %slocked @ %s:%d\n", 1311047dd67eSAttilio Rao lk->lock_object.lo_name, slocked ? "share" : "", 131284887fa3SAttilio Rao file, line); 1313047dd67eSAttilio Rao 1314047dd67eSAttilio Rao if ((lk->lk_lock & LK_SHARE) == 0) { 1315047dd67eSAttilio Rao if (lockmgr_recursed(lk)) { 131684887fa3SAttilio Rao if (what & KA_NOTRECURSED) 131784887fa3SAttilio Rao panic("Lock %s recursed @ %s:%d\n", 1318047dd67eSAttilio Rao lk->lock_object.lo_name, file, 1319047dd67eSAttilio Rao line); 132084887fa3SAttilio Rao } else if (what & KA_RECURSED) 132184887fa3SAttilio Rao panic("Lock %s not recursed @ %s:%d\n", 1322047dd67eSAttilio Rao lk->lock_object.lo_name, file, line); 132384887fa3SAttilio Rao } 132484887fa3SAttilio Rao break; 132584887fa3SAttilio Rao case KA_XLOCKED: 132684887fa3SAttilio Rao case KA_XLOCKED | KA_NOTRECURSED: 132784887fa3SAttilio Rao case KA_XLOCKED | KA_RECURSED: 1328047dd67eSAttilio Rao if (!lockmgr_xlocked(lk) && !lockmgr_disowned(lk)) 132984887fa3SAttilio Rao panic("Lock %s not exclusively locked @ %s:%d\n", 1330047dd67eSAttilio Rao lk->lock_object.lo_name, file, line); 1331047dd67eSAttilio Rao if (lockmgr_recursed(lk)) { 133284887fa3SAttilio Rao if (what & KA_NOTRECURSED) 133384887fa3SAttilio Rao panic("Lock %s recursed @ %s:%d\n", 1334047dd67eSAttilio Rao lk->lock_object.lo_name, file, line); 133584887fa3SAttilio Rao } else if (what & KA_RECURSED) 133684887fa3SAttilio Rao panic("Lock %s not recursed @ %s:%d\n", 1337047dd67eSAttilio Rao lk->lock_object.lo_name, file, line); 133884887fa3SAttilio Rao break; 133984887fa3SAttilio Rao case KA_UNLOCKED: 1340047dd67eSAttilio Rao if (lockmgr_xlocked(lk) || lockmgr_disowned(lk)) 134184887fa3SAttilio Rao panic("Lock %s exclusively locked @ %s:%d\n", 1342047dd67eSAttilio Rao lk->lock_object.lo_name, file, line); 134384887fa3SAttilio Rao break; 134484887fa3SAttilio Rao default: 1345047dd67eSAttilio Rao panic("Unknown lockmgr assertion: %d @ %s:%d\n", what, file, 1346047dd67eSAttilio Rao line); 134784887fa3SAttilio Rao } 134884887fa3SAttilio Rao } 1349047dd67eSAttilio Rao #endif 135084887fa3SAttilio Rao 1351be6847d7SJohn Baldwin #ifdef DDB 1352462a7addSJohn Baldwin int 1353462a7addSJohn Baldwin lockmgr_chain(struct thread *td, struct thread **ownerp) 1354462a7addSJohn Baldwin { 1355047dd67eSAttilio Rao struct lock *lk; 1356462a7addSJohn Baldwin 1357047dd67eSAttilio Rao lk = td->td_wchan; 1358462a7addSJohn Baldwin 1359047dd67eSAttilio Rao if (LOCK_CLASS(&lk->lock_object) != &lock_class_lockmgr) 1360462a7addSJohn Baldwin return (0); 1361047dd67eSAttilio Rao db_printf("blocked on lockmgr %s", lk->lock_object.lo_name); 1362047dd67eSAttilio Rao if (lk->lk_lock & LK_SHARE) 1363047dd67eSAttilio Rao db_printf("SHARED (count %ju)\n", 1364047dd67eSAttilio Rao (uintmax_t)LK_SHARERS(lk->lk_lock)); 1365047dd67eSAttilio Rao else 1366047dd67eSAttilio Rao db_printf("EXCL\n"); 1367047dd67eSAttilio Rao *ownerp = lockmgr_xholder(lk); 1368462a7addSJohn Baldwin 1369462a7addSJohn Baldwin return (1); 1370462a7addSJohn Baldwin } 1371462a7addSJohn Baldwin 1372047dd67eSAttilio Rao static void 137361bd5e21SKip Macy db_show_lockmgr(struct lock_object *lock) 1374be6847d7SJohn Baldwin { 1375be6847d7SJohn Baldwin struct thread *td; 1376047dd67eSAttilio Rao struct lock *lk; 1377be6847d7SJohn Baldwin 1378047dd67eSAttilio Rao lk = (struct lock *)lock; 1379be6847d7SJohn Baldwin 1380be6847d7SJohn Baldwin db_printf(" state: "); 1381047dd67eSAttilio Rao if (lk->lk_lock == LK_UNLOCKED) 1382be6847d7SJohn Baldwin db_printf("UNLOCKED\n"); 1383047dd67eSAttilio Rao else if (lk->lk_lock & LK_SHARE) 1384047dd67eSAttilio Rao db_printf("SLOCK: %ju\n", (uintmax_t)LK_SHARERS(lk->lk_lock)); 1385047dd67eSAttilio Rao else { 1386047dd67eSAttilio Rao td = lockmgr_xholder(lk); 1387047dd67eSAttilio Rao if (td == (struct thread *)LK_KERNPROC) 1388047dd67eSAttilio Rao db_printf("XLOCK: LK_KERNPROC\n"); 1389047dd67eSAttilio Rao else 1390047dd67eSAttilio Rao db_printf("XLOCK: %p (tid %d, pid %d, \"%s\")\n", td, 1391047dd67eSAttilio Rao td->td_tid, td->td_proc->p_pid, 1392047dd67eSAttilio Rao td->td_proc->p_comm); 1393047dd67eSAttilio Rao if (lockmgr_recursed(lk)) 1394047dd67eSAttilio Rao db_printf(" recursed: %d\n", lk->lk_recurse); 1395047dd67eSAttilio Rao } 1396047dd67eSAttilio Rao db_printf(" waiters: "); 1397047dd67eSAttilio Rao switch (lk->lk_lock & LK_ALL_WAITERS) { 1398047dd67eSAttilio Rao case LK_SHARED_WAITERS: 1399047dd67eSAttilio Rao db_printf("shared\n"); 1400e5023dd9SEdward Tomasz Napierala break; 1401047dd67eSAttilio Rao case LK_EXCLUSIVE_WAITERS: 1402047dd67eSAttilio Rao db_printf("exclusive\n"); 1403047dd67eSAttilio Rao break; 1404047dd67eSAttilio Rao case LK_ALL_WAITERS: 1405047dd67eSAttilio Rao db_printf("shared and exclusive\n"); 1406047dd67eSAttilio Rao break; 1407047dd67eSAttilio Rao default: 1408047dd67eSAttilio Rao db_printf("none\n"); 1409047dd67eSAttilio Rao } 1410651175c9SAttilio Rao db_printf(" spinners: "); 1411651175c9SAttilio Rao if (lk->lk_lock & LK_EXCLUSIVE_SPINNERS) 1412651175c9SAttilio Rao db_printf("exclusive\n"); 1413651175c9SAttilio Rao else 1414651175c9SAttilio Rao db_printf("none\n"); 1415be6847d7SJohn Baldwin } 1416be6847d7SJohn Baldwin #endif 1417