19454b2d8SWarner Losh /*- 24e7f640dSJohn Baldwin * Copyright (c) 2007 Attilio Rao <attilio@freebsd.org> 34e7f640dSJohn Baldwin * Copyright (c) 2001 Jason Evans <jasone@freebsd.org> 44e7f640dSJohn Baldwin * All rights reserved. 56281b30aSJason Evans * 66281b30aSJason Evans * Redistribution and use in source and binary forms, with or without 76281b30aSJason Evans * modification, are permitted provided that the following conditions 86281b30aSJason Evans * are met: 96281b30aSJason Evans * 1. Redistributions of source code must retain the above copyright 106281b30aSJason Evans * notice(s), this list of conditions and the following disclaimer as 116281b30aSJason Evans * the first lines of this file unmodified other than the possible 126281b30aSJason Evans * addition of one or more copyright notices. 136281b30aSJason Evans * 2. Redistributions in binary form must reproduce the above copyright 146281b30aSJason Evans * notice(s), this list of conditions and the following disclaimer in the 156281b30aSJason Evans * documentation and/or other materials provided with the distribution. 166281b30aSJason Evans * 176281b30aSJason Evans * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY 186281b30aSJason Evans * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 196281b30aSJason Evans * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 206281b30aSJason Evans * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY 216281b30aSJason Evans * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 226281b30aSJason Evans * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 236281b30aSJason Evans * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 246281b30aSJason Evans * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 256281b30aSJason Evans * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 266281b30aSJason Evans * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 276281b30aSJason Evans * DAMAGE. 286281b30aSJason Evans */ 296281b30aSJason Evans 306281b30aSJason Evans /* 314e7f640dSJohn Baldwin * Shared/exclusive locks. This implementation attempts to ensure 324e7f640dSJohn Baldwin * deterministic lock granting behavior, so that slocks and xlocks are 334e7f640dSJohn Baldwin * interleaved. 346281b30aSJason Evans * 356281b30aSJason Evans * Priority propagation will not generally raise the priority of lock holders, 366281b30aSJason Evans * so should not be relied upon in combination with sx locks. 376281b30aSJason Evans */ 386281b30aSJason Evans 394e7f640dSJohn Baldwin #include "opt_ddb.h" 40f5f9340bSFabien Thomas #include "opt_hwpmc_hooks.h" 41e31d0833SAttilio Rao #include "opt_no_adaptive_sx.h" 424e7f640dSJohn Baldwin 43677b542eSDavid E. O'Brien #include <sys/cdefs.h> 44677b542eSDavid E. O'Brien __FBSDID("$FreeBSD$"); 45677b542eSDavid E. O'Brien 466281b30aSJason Evans #include <sys/param.h> 477a7ce668SAndriy Gapon #include <sys/systm.h> 48cd2fe4e6SAttilio Rao #include <sys/kdb.h> 490453ade5SMateusz Guzik #include <sys/kernel.h> 506281b30aSJason Evans #include <sys/ktr.h> 5119284646SJohn Baldwin #include <sys/lock.h> 526281b30aSJason Evans #include <sys/mutex.h> 53d272fe53SJohn Baldwin #include <sys/proc.h> 542cba8dd3SJohn Baldwin #include <sys/sched.h> 554e7f640dSJohn Baldwin #include <sys/sleepqueue.h> 566281b30aSJason Evans #include <sys/sx.h> 571ada9041SMateusz Guzik #include <sys/smp.h> 58e31d0833SAttilio Rao #include <sys/sysctl.h> 594e7f640dSJohn Baldwin 60e31d0833SAttilio Rao #if defined(SMP) && !defined(NO_ADAPTIVE_SX) 614e7f640dSJohn Baldwin #include <machine/cpu.h> 624e7f640dSJohn Baldwin #endif 636281b30aSJason Evans 64462a7addSJohn Baldwin #ifdef DDB 65d272fe53SJohn Baldwin #include <ddb/ddb.h> 664e7f640dSJohn Baldwin #endif 67d272fe53SJohn Baldwin 681ae1c2a3SAttilio Rao #if defined(SMP) && !defined(NO_ADAPTIVE_SX) 691ae1c2a3SAttilio Rao #define ADAPTIVE_SX 704e7f640dSJohn Baldwin #endif 714e7f640dSJohn Baldwin 72f0830182SAttilio Rao CTASSERT((SX_NOADAPTIVE & LO_CLASSFLAGS) == SX_NOADAPTIVE); 73c1a6d9faSAttilio Rao 74f5f9340bSFabien Thomas #ifdef HWPMC_HOOKS 75f5f9340bSFabien Thomas #include <sys/pmckern.h> 76f5f9340bSFabien Thomas PMC_SOFT_DECLARE( , , lock, failed); 77f5f9340bSFabien Thomas #endif 78f5f9340bSFabien Thomas 794e7f640dSJohn Baldwin /* Handy macros for sleep queues. */ 804e7f640dSJohn Baldwin #define SQ_EXCLUSIVE_QUEUE 0 814e7f640dSJohn Baldwin #define SQ_SHARED_QUEUE 1 824e7f640dSJohn Baldwin 834e7f640dSJohn Baldwin /* 844e7f640dSJohn Baldwin * Variations on DROP_GIANT()/PICKUP_GIANT() for use in this file. We 854e7f640dSJohn Baldwin * drop Giant anytime we have to sleep or if we adaptively spin. 864e7f640dSJohn Baldwin */ 874e7f640dSJohn Baldwin #define GIANT_DECLARE \ 884e7f640dSJohn Baldwin int _giantcnt = 0; \ 894e7f640dSJohn Baldwin WITNESS_SAVE_DECL(Giant) \ 904e7f640dSJohn Baldwin 914e7f640dSJohn Baldwin #define GIANT_SAVE() do { \ 924e7f640dSJohn Baldwin if (mtx_owned(&Giant)) { \ 934e7f640dSJohn Baldwin WITNESS_SAVE(&Giant.lock_object, Giant); \ 944e7f640dSJohn Baldwin while (mtx_owned(&Giant)) { \ 954e7f640dSJohn Baldwin _giantcnt++; \ 964e7f640dSJohn Baldwin mtx_unlock(&Giant); \ 974e7f640dSJohn Baldwin } \ 984e7f640dSJohn Baldwin } \ 994e7f640dSJohn Baldwin } while (0) 1004e7f640dSJohn Baldwin 1014e7f640dSJohn Baldwin #define GIANT_RESTORE() do { \ 1024e7f640dSJohn Baldwin if (_giantcnt > 0) { \ 1034e7f640dSJohn Baldwin mtx_assert(&Giant, MA_NOTOWNED); \ 1044e7f640dSJohn Baldwin while (_giantcnt--) \ 1054e7f640dSJohn Baldwin mtx_lock(&Giant); \ 1064e7f640dSJohn Baldwin WITNESS_RESTORE(&Giant.lock_object, Giant); \ 1074e7f640dSJohn Baldwin } \ 1084e7f640dSJohn Baldwin } while (0) 1094e7f640dSJohn Baldwin 1104e7f640dSJohn Baldwin /* 111da7d0d1eSJohn Baldwin * Returns true if an exclusive lock is recursed. It assumes 112da7d0d1eSJohn Baldwin * curthread currently has an exclusive lock. 1134e7f640dSJohn Baldwin */ 1144e7f640dSJohn Baldwin #define sx_recursed(sx) ((sx)->sx_recurse != 0) 1154e7f640dSJohn Baldwin 116d576deedSPawel Jakub Dawidek static void assert_sx(const struct lock_object *lock, int what); 1174e7f640dSJohn Baldwin #ifdef DDB 118d576deedSPawel Jakub Dawidek static void db_show_sx(const struct lock_object *lock); 119d272fe53SJohn Baldwin #endif 1207faf4d90SDavide Italiano static void lock_sx(struct lock_object *lock, uintptr_t how); 121a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 122d576deedSPawel Jakub Dawidek static int owner_sx(const struct lock_object *lock, struct thread **owner); 123a5aedd68SStacey Son #endif 1247faf4d90SDavide Italiano static uintptr_t unlock_sx(struct lock_object *lock); 125d272fe53SJohn Baldwin 12619284646SJohn Baldwin struct lock_class lock_class_sx = { 127ae8dde30SJohn Baldwin .lc_name = "sx", 128ae8dde30SJohn Baldwin .lc_flags = LC_SLEEPLOCK | LC_SLEEPABLE | LC_RECURSABLE | LC_UPGRADABLE, 129f9721b43SAttilio Rao .lc_assert = assert_sx, 130d272fe53SJohn Baldwin #ifdef DDB 131ae8dde30SJohn Baldwin .lc_ddb_show = db_show_sx, 132d272fe53SJohn Baldwin #endif 1336e21afd4SJohn Baldwin .lc_lock = lock_sx, 1346e21afd4SJohn Baldwin .lc_unlock = unlock_sx, 135a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 136a5aedd68SStacey Son .lc_owner = owner_sx, 137a5aedd68SStacey Son #endif 13819284646SJohn Baldwin }; 13919284646SJohn Baldwin 140781a35dfSJohn Baldwin #ifndef INVARIANTS 141781a35dfSJohn Baldwin #define _sx_assert(sx, what, file, line) 142781a35dfSJohn Baldwin #endif 143781a35dfSJohn Baldwin 1441ae1c2a3SAttilio Rao #ifdef ADAPTIVE_SX 1451ae1c2a3SAttilio Rao static u_int asx_retries = 10; 1461ae1c2a3SAttilio Rao static u_int asx_loops = 10000; 1476472ac3dSEd Schouten static SYSCTL_NODE(_debug, OID_AUTO, sx, CTLFLAG_RD, NULL, "sxlock debugging"); 148fbbb13f9SMatthew D Fleming SYSCTL_UINT(_debug_sx, OID_AUTO, retries, CTLFLAG_RW, &asx_retries, 0, ""); 149fbbb13f9SMatthew D Fleming SYSCTL_UINT(_debug_sx, OID_AUTO, loops, CTLFLAG_RW, &asx_loops, 0, ""); 1501ada9041SMateusz Guzik 1518e5a3e9aSMateusz Guzik static struct lock_delay_config __read_mostly sx_delay; 1521ada9041SMateusz Guzik 1538e5a3e9aSMateusz Guzik SYSCTL_INT(_debug_sx, OID_AUTO, delay_base, CTLFLAG_RW, &sx_delay.base, 1541ada9041SMateusz Guzik 0, ""); 1551ada9041SMateusz Guzik SYSCTL_INT(_debug_sx, OID_AUTO, delay_max, CTLFLAG_RW, &sx_delay.max, 1561ada9041SMateusz Guzik 0, ""); 1571ada9041SMateusz Guzik 1588e5a3e9aSMateusz Guzik LOCK_DELAY_SYSINIT_DEFAULT(sx_delay); 1591ae1c2a3SAttilio Rao #endif 1601ae1c2a3SAttilio Rao 1616281b30aSJason Evans void 162d576deedSPawel Jakub Dawidek assert_sx(const struct lock_object *lock, int what) 163f9721b43SAttilio Rao { 164f9721b43SAttilio Rao 165d576deedSPawel Jakub Dawidek sx_assert((const struct sx *)lock, what); 166f9721b43SAttilio Rao } 167f9721b43SAttilio Rao 168f9721b43SAttilio Rao void 1697faf4d90SDavide Italiano lock_sx(struct lock_object *lock, uintptr_t how) 1706e21afd4SJohn Baldwin { 1716e21afd4SJohn Baldwin struct sx *sx; 1726e21afd4SJohn Baldwin 1736e21afd4SJohn Baldwin sx = (struct sx *)lock; 1746e21afd4SJohn Baldwin if (how) 1756e21afd4SJohn Baldwin sx_slock(sx); 176cf6b879fSDavide Italiano else 177cf6b879fSDavide Italiano sx_xlock(sx); 1786e21afd4SJohn Baldwin } 1796e21afd4SJohn Baldwin 1807faf4d90SDavide Italiano uintptr_t 1816e21afd4SJohn Baldwin unlock_sx(struct lock_object *lock) 1826e21afd4SJohn Baldwin { 1836e21afd4SJohn Baldwin struct sx *sx; 1846e21afd4SJohn Baldwin 1856e21afd4SJohn Baldwin sx = (struct sx *)lock; 1867ec137e5SJohn Baldwin sx_assert(sx, SA_LOCKED | SA_NOTRECURSED); 1876e21afd4SJohn Baldwin if (sx_xlocked(sx)) { 1886e21afd4SJohn Baldwin sx_xunlock(sx); 189cf6b879fSDavide Italiano return (0); 1906e21afd4SJohn Baldwin } else { 1916e21afd4SJohn Baldwin sx_sunlock(sx); 192cf6b879fSDavide Italiano return (1); 1936e21afd4SJohn Baldwin } 1946e21afd4SJohn Baldwin } 1956e21afd4SJohn Baldwin 196a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 197a5aedd68SStacey Son int 198d576deedSPawel Jakub Dawidek owner_sx(const struct lock_object *lock, struct thread **owner) 199a5aedd68SStacey Son { 200c365a293SMark Johnston const struct sx *sx; 201c365a293SMark Johnston uintptr_t x; 202a5aedd68SStacey Son 203c365a293SMark Johnston sx = (const struct sx *)lock; 204c365a293SMark Johnston x = sx->sx_lock; 205c365a293SMark Johnston *owner = NULL; 206a5aedd68SStacey Son return ((x & SX_LOCK_SHARED) != 0 ? (SX_SHARERS(x) != 0) : 207c365a293SMark Johnston ((*owner = (struct thread *)SX_OWNER(x)) != NULL)); 208a5aedd68SStacey Son } 209a5aedd68SStacey Son #endif 210a5aedd68SStacey Son 2116e21afd4SJohn Baldwin void 212c27b5699SAndrew R. Reiter sx_sysinit(void *arg) 213c27b5699SAndrew R. Reiter { 214c27b5699SAndrew R. Reiter struct sx_args *sargs = arg; 215c27b5699SAndrew R. Reiter 216e4cd31ddSJeff Roberson sx_init_flags(sargs->sa_sx, sargs->sa_desc, sargs->sa_flags); 217c27b5699SAndrew R. Reiter } 218c27b5699SAndrew R. Reiter 219c27b5699SAndrew R. Reiter void 2204e7f640dSJohn Baldwin sx_init_flags(struct sx *sx, const char *description, int opts) 2216281b30aSJason Evans { 2224e7f640dSJohn Baldwin int flags; 2236281b30aSJason Evans 224b0d67325SJohn Baldwin MPASS((opts & ~(SX_QUIET | SX_RECURSE | SX_NOWITNESS | SX_DUPOK | 225fd07ddcfSDmitry Chagin SX_NOPROFILE | SX_NOADAPTIVE | SX_NEW)) == 0); 226353998acSAttilio Rao ASSERT_ATOMIC_LOAD_PTR(sx->sx_lock, 227353998acSAttilio Rao ("%s: sx_lock not aligned for %s: %p", __func__, description, 228353998acSAttilio Rao &sx->sx_lock)); 229b0d67325SJohn Baldwin 230f0830182SAttilio Rao flags = LO_SLEEPABLE | LO_UPGRADABLE; 2314e7f640dSJohn Baldwin if (opts & SX_DUPOK) 2324e7f640dSJohn Baldwin flags |= LO_DUPOK; 2334e7f640dSJohn Baldwin if (opts & SX_NOPROFILE) 2344e7f640dSJohn Baldwin flags |= LO_NOPROFILE; 2354e7f640dSJohn Baldwin if (!(opts & SX_NOWITNESS)) 2364e7f640dSJohn Baldwin flags |= LO_WITNESS; 237f0830182SAttilio Rao if (opts & SX_RECURSE) 238f0830182SAttilio Rao flags |= LO_RECURSABLE; 2394e7f640dSJohn Baldwin if (opts & SX_QUIET) 2404e7f640dSJohn Baldwin flags |= LO_QUIET; 241fd07ddcfSDmitry Chagin if (opts & SX_NEW) 242fd07ddcfSDmitry Chagin flags |= LO_NEW; 2434e7f640dSJohn Baldwin 244f0830182SAttilio Rao flags |= opts & SX_NOADAPTIVE; 245b5fb43e5SJohn Baldwin lock_init(&sx->lock_object, &lock_class_sx, description, NULL, flags); 2464e7f640dSJohn Baldwin sx->sx_lock = SX_LOCK_UNLOCKED; 2474e7f640dSJohn Baldwin sx->sx_recurse = 0; 2486281b30aSJason Evans } 2496281b30aSJason Evans 2506281b30aSJason Evans void 2516281b30aSJason Evans sx_destroy(struct sx *sx) 2526281b30aSJason Evans { 2536281b30aSJason Evans 2544e7f640dSJohn Baldwin KASSERT(sx->sx_lock == SX_LOCK_UNLOCKED, ("sx lock still held")); 2554e7f640dSJohn Baldwin KASSERT(sx->sx_recurse == 0, ("sx lock still recursed")); 2560026c92cSJohn Baldwin sx->sx_lock = SX_LOCK_DESTROYED; 257aa89d8cdSJohn Baldwin lock_destroy(&sx->lock_object); 2586281b30aSJason Evans } 2596281b30aSJason Evans 260f9819486SAttilio Rao int 2619fde98bbSAttilio Rao sx_try_slock_(struct sx *sx, const char *file, int line) 2625f36700aSJohn Baldwin { 2634e7f640dSJohn Baldwin uintptr_t x; 2645f36700aSJohn Baldwin 26535370593SAndriy Gapon if (SCHEDULER_STOPPED()) 26635370593SAndriy Gapon return (1); 26735370593SAndriy Gapon 268cd2fe4e6SAttilio Rao KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 269e3ae0dfeSAttilio Rao ("sx_try_slock() by idle thread %p on sx %s @ %s:%d", 270e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 271e3ae0dfeSAttilio Rao 272764a938bSPawel Jakub Dawidek for (;;) { 2734e7f640dSJohn Baldwin x = sx->sx_lock; 2740026c92cSJohn Baldwin KASSERT(x != SX_LOCK_DESTROYED, 2750026c92cSJohn Baldwin ("sx_try_slock() of destroyed sx @ %s:%d", file, line)); 276764a938bSPawel Jakub Dawidek if (!(x & SX_LOCK_SHARED)) 277764a938bSPawel Jakub Dawidek break; 278764a938bSPawel Jakub Dawidek if (atomic_cmpset_acq_ptr(&sx->sx_lock, x, x + SX_ONE_SHARER)) { 279aa89d8cdSJohn Baldwin LOCK_LOG_TRY("SLOCK", &sx->lock_object, 0, 1, file, line); 280aa89d8cdSJohn Baldwin WITNESS_LOCK(&sx->lock_object, LOP_TRYLOCK, file, line); 281de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, 282de2c95ccSMark Johnston sx, 0, 0, file, line, LOCKSTAT_READER); 283ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 2845f36700aSJohn Baldwin return (1); 2855f36700aSJohn Baldwin } 286764a938bSPawel Jakub Dawidek } 2874e7f640dSJohn Baldwin 2884e7f640dSJohn Baldwin LOCK_LOG_TRY("SLOCK", &sx->lock_object, 0, 0, file, line); 2894e7f640dSJohn Baldwin return (0); 2905f36700aSJohn Baldwin } 2915f36700aSJohn Baldwin 292f9819486SAttilio Rao int 293f9819486SAttilio Rao _sx_xlock(struct sx *sx, int opts, const char *file, int line) 2946281b30aSJason Evans { 2956ebb77b6SMateusz Guzik uintptr_t tid, x; 296f9819486SAttilio Rao int error = 0; 2976281b30aSJason Evans 29835370593SAndriy Gapon if (SCHEDULER_STOPPED()) 29935370593SAndriy Gapon return (0); 300cd2fe4e6SAttilio Rao KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 301e3ae0dfeSAttilio Rao ("sx_xlock() by idle thread %p on sx %s @ %s:%d", 302e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 3030026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 3040026c92cSJohn Baldwin ("sx_xlock() of destroyed sx @ %s:%d", file, line)); 305aa89d8cdSJohn Baldwin WITNESS_CHECKORDER(&sx->lock_object, LOP_NEWORDER | LOP_EXCLUSIVE, file, 30641313430SJohn Baldwin line, NULL); 3076ebb77b6SMateusz Guzik tid = (uintptr_t)curthread; 3086ebb77b6SMateusz Guzik x = SX_LOCK_UNLOCKED; 3096ebb77b6SMateusz Guzik if (!atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, tid)) 3106ebb77b6SMateusz Guzik error = _sx_xlock_hard(sx, x, tid, opts, file, line); 3116ebb77b6SMateusz Guzik else 3126ebb77b6SMateusz Guzik LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, sx, 3136ebb77b6SMateusz Guzik 0, 0, file, line, LOCKSTAT_WRITER); 314f9819486SAttilio Rao if (!error) { 315f9819486SAttilio Rao LOCK_LOG_LOCK("XLOCK", &sx->lock_object, 0, sx->sx_recurse, 316f9819486SAttilio Rao file, line); 317aa89d8cdSJohn Baldwin WITNESS_LOCK(&sx->lock_object, LOP_EXCLUSIVE, file, line); 318ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 3196281b30aSJason Evans } 3206281b30aSJason Evans 321f9819486SAttilio Rao return (error); 322f9819486SAttilio Rao } 323f9819486SAttilio Rao 3245f36700aSJohn Baldwin int 3259fde98bbSAttilio Rao sx_try_xlock_(struct sx *sx, const char *file, int line) 3265f36700aSJohn Baldwin { 3274e7f640dSJohn Baldwin int rval; 3285f36700aSJohn Baldwin 32935370593SAndriy Gapon if (SCHEDULER_STOPPED()) 33035370593SAndriy Gapon return (1); 33135370593SAndriy Gapon 332cd2fe4e6SAttilio Rao KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 333e3ae0dfeSAttilio Rao ("sx_try_xlock() by idle thread %p on sx %s @ %s:%d", 334e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 3350026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 3360026c92cSJohn Baldwin ("sx_try_xlock() of destroyed sx @ %s:%d", file, line)); 3374e7f640dSJohn Baldwin 338f0830182SAttilio Rao if (sx_xlocked(sx) && 339f0830182SAttilio Rao (sx->lock_object.lo_flags & LO_RECURSABLE) != 0) { 3404e7f640dSJohn Baldwin sx->sx_recurse++; 3414e7f640dSJohn Baldwin atomic_set_ptr(&sx->sx_lock, SX_LOCK_RECURSED); 3424e7f640dSJohn Baldwin rval = 1; 3434e7f640dSJohn Baldwin } else 3444e7f640dSJohn Baldwin rval = atomic_cmpset_acq_ptr(&sx->sx_lock, SX_LOCK_UNLOCKED, 3454e7f640dSJohn Baldwin (uintptr_t)curthread); 3464e7f640dSJohn Baldwin LOCK_LOG_TRY("XLOCK", &sx->lock_object, 0, rval, file, line); 3474e7f640dSJohn Baldwin if (rval) { 3484e7f640dSJohn Baldwin WITNESS_LOCK(&sx->lock_object, LOP_EXCLUSIVE | LOP_TRYLOCK, 3494e7f640dSJohn Baldwin file, line); 350076dd8ebSAndriy Gapon if (!sx_recursed(sx)) 351de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, 352de2c95ccSMark Johnston sx, 0, 0, file, line, LOCKSTAT_WRITER); 353ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 3545f36700aSJohn Baldwin } 3554e7f640dSJohn Baldwin 3564e7f640dSJohn Baldwin return (rval); 3575f36700aSJohn Baldwin } 3585f36700aSJohn Baldwin 3596281b30aSJason Evans void 36019284646SJohn Baldwin _sx_xunlock(struct sx *sx, const char *file, int line) 3616281b30aSJason Evans { 3626281b30aSJason Evans 36335370593SAndriy Gapon if (SCHEDULER_STOPPED()) 36435370593SAndriy Gapon return; 3650026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 3660026c92cSJohn Baldwin ("sx_xunlock() of destroyed sx @ %s:%d", file, line)); 3677ec137e5SJohn Baldwin _sx_assert(sx, SA_XLOCKED, file, line); 368aa89d8cdSJohn Baldwin WITNESS_UNLOCK(&sx->lock_object, LOP_EXCLUSIVE, file, line); 3694e7f640dSJohn Baldwin LOCK_LOG_LOCK("XUNLOCK", &sx->lock_object, 0, sx->sx_recurse, file, 3704e7f640dSJohn Baldwin line); 3716ebb77b6SMateusz Guzik _sx_xunlock_hard(sx, (uintptr_t)curthread, file, line); 372ce1c953eSMark Johnston TD_LOCKS_DEC(curthread); 3736281b30aSJason Evans } 374d55229b7SJason Evans 3754e7f640dSJohn Baldwin /* 3764e7f640dSJohn Baldwin * Try to do a non-blocking upgrade from a shared lock to an exclusive lock. 3774e7f640dSJohn Baldwin * This will only succeed if this thread holds a single shared lock. 3784e7f640dSJohn Baldwin * Return 1 if if the upgrade succeed, 0 otherwise. 3794e7f640dSJohn Baldwin */ 380d55229b7SJason Evans int 3819fde98bbSAttilio Rao sx_try_upgrade_(struct sx *sx, const char *file, int line) 382d55229b7SJason Evans { 3834e7f640dSJohn Baldwin uintptr_t x; 3844e7f640dSJohn Baldwin int success; 385d55229b7SJason Evans 38635370593SAndriy Gapon if (SCHEDULER_STOPPED()) 38735370593SAndriy Gapon return (1); 38835370593SAndriy Gapon 3890026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 3900026c92cSJohn Baldwin ("sx_try_upgrade() of destroyed sx @ %s:%d", file, line)); 3917ec137e5SJohn Baldwin _sx_assert(sx, SA_SLOCKED, file, line); 392d55229b7SJason Evans 3934e7f640dSJohn Baldwin /* 3944e7f640dSJohn Baldwin * Try to switch from one shared lock to an exclusive lock. We need 3954e7f640dSJohn Baldwin * to maintain the SX_LOCK_EXCLUSIVE_WAITERS flag if set so that 3964e7f640dSJohn Baldwin * we will wake up the exclusive waiters when we drop the lock. 3974e7f640dSJohn Baldwin */ 3984e7f640dSJohn Baldwin x = sx->sx_lock & SX_LOCK_EXCLUSIVE_WAITERS; 3994e7f640dSJohn Baldwin success = atomic_cmpset_ptr(&sx->sx_lock, SX_SHARERS_LOCK(1) | x, 4004e7f640dSJohn Baldwin (uintptr_t)curthread | x); 4014e7f640dSJohn Baldwin LOCK_LOG_TRY("XUPGRADE", &sx->lock_object, 0, success, file, line); 402a5aedd68SStacey Son if (success) { 403aa89d8cdSJohn Baldwin WITNESS_UPGRADE(&sx->lock_object, LOP_EXCLUSIVE | LOP_TRYLOCK, 404b0b7cb50SJohn Baldwin file, line); 40532cd0147SMark Johnston LOCKSTAT_RECORD0(sx__upgrade, sx); 406a5aedd68SStacey Son } 4074e7f640dSJohn Baldwin return (success); 408d55229b7SJason Evans } 409d55229b7SJason Evans 4104e7f640dSJohn Baldwin /* 4114e7f640dSJohn Baldwin * Downgrade an unrecursed exclusive lock into a single shared lock. 4124e7f640dSJohn Baldwin */ 413d55229b7SJason Evans void 4149fde98bbSAttilio Rao sx_downgrade_(struct sx *sx, const char *file, int line) 415d55229b7SJason Evans { 4164e7f640dSJohn Baldwin uintptr_t x; 417da7bbd2cSJohn Baldwin int wakeup_swapper; 418d55229b7SJason Evans 41935370593SAndriy Gapon if (SCHEDULER_STOPPED()) 42035370593SAndriy Gapon return; 42135370593SAndriy Gapon 4220026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 4230026c92cSJohn Baldwin ("sx_downgrade() of destroyed sx @ %s:%d", file, line)); 4247ec137e5SJohn Baldwin _sx_assert(sx, SA_XLOCKED | SA_NOTRECURSED, file, line); 4254e7f640dSJohn Baldwin #ifndef INVARIANTS 4264e7f640dSJohn Baldwin if (sx_recursed(sx)) 4274e7f640dSJohn Baldwin panic("downgrade of a recursed lock"); 4284e7f640dSJohn Baldwin #endif 429d55229b7SJason Evans 430aa89d8cdSJohn Baldwin WITNESS_DOWNGRADE(&sx->lock_object, 0, file, line); 431d55229b7SJason Evans 4324e7f640dSJohn Baldwin /* 4334e7f640dSJohn Baldwin * Try to switch from an exclusive lock with no shared waiters 4344e7f640dSJohn Baldwin * to one sharer with no shared waiters. If there are 4354e7f640dSJohn Baldwin * exclusive waiters, we don't need to lock the sleep queue so 4364e7f640dSJohn Baldwin * long as we preserve the flag. We do one quick try and if 4374e7f640dSJohn Baldwin * that fails we grab the sleepq lock to keep the flags from 4384e7f640dSJohn Baldwin * changing and do it the slow way. 4394e7f640dSJohn Baldwin * 4404e7f640dSJohn Baldwin * We have to lock the sleep queue if there are shared waiters 4414e7f640dSJohn Baldwin * so we can wake them up. 4424e7f640dSJohn Baldwin */ 4434e7f640dSJohn Baldwin x = sx->sx_lock; 4444e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED_WAITERS) && 4454e7f640dSJohn Baldwin atomic_cmpset_rel_ptr(&sx->sx_lock, x, SX_SHARERS_LOCK(1) | 4464e7f640dSJohn Baldwin (x & SX_LOCK_EXCLUSIVE_WAITERS))) { 4474e7f640dSJohn Baldwin LOCK_LOG_LOCK("XDOWNGRADE", &sx->lock_object, 0, 0, file, line); 4484e7f640dSJohn Baldwin return; 4494e7f640dSJohn Baldwin } 4504e7f640dSJohn Baldwin 4514e7f640dSJohn Baldwin /* 4524e7f640dSJohn Baldwin * Lock the sleep queue so we can read the waiters bits 4534e7f640dSJohn Baldwin * without any races and wakeup any shared waiters. 4544e7f640dSJohn Baldwin */ 4554e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 4564e7f640dSJohn Baldwin 4574e7f640dSJohn Baldwin /* 4584e7f640dSJohn Baldwin * Preserve SX_LOCK_EXCLUSIVE_WAITERS while downgraded to a single 4594e7f640dSJohn Baldwin * shared lock. If there are any shared waiters, wake them up. 4604e7f640dSJohn Baldwin */ 461da7bbd2cSJohn Baldwin wakeup_swapper = 0; 4624e7f640dSJohn Baldwin x = sx->sx_lock; 4634e7f640dSJohn Baldwin atomic_store_rel_ptr(&sx->sx_lock, SX_SHARERS_LOCK(1) | 4644e7f640dSJohn Baldwin (x & SX_LOCK_EXCLUSIVE_WAITERS)); 4654e7f640dSJohn Baldwin if (x & SX_LOCK_SHARED_WAITERS) 466da7bbd2cSJohn Baldwin wakeup_swapper = sleepq_broadcast(&sx->lock_object, SLEEPQ_SX, 467da7bbd2cSJohn Baldwin 0, SQ_SHARED_QUEUE); 4684e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 469d55229b7SJason Evans 470aa89d8cdSJohn Baldwin LOCK_LOG_LOCK("XDOWNGRADE", &sx->lock_object, 0, 0, file, line); 47132cd0147SMark Johnston LOCKSTAT_RECORD0(sx__downgrade, sx); 472da7bbd2cSJohn Baldwin 473da7bbd2cSJohn Baldwin if (wakeup_swapper) 474da7bbd2cSJohn Baldwin kick_proc0(); 4754e7f640dSJohn Baldwin } 476d55229b7SJason Evans 4774e7f640dSJohn Baldwin /* 4784e7f640dSJohn Baldwin * This function represents the so-called 'hard case' for sx_xlock 4794e7f640dSJohn Baldwin * operation. All 'easy case' failures are redirected to this. Note 4804e7f640dSJohn Baldwin * that ideally this would be a static function, but it needs to be 4814e7f640dSJohn Baldwin * accessible from at least sx.h. 4824e7f640dSJohn Baldwin */ 483f9819486SAttilio Rao int 484fa474043SMateusz Guzik _sx_xlock_hard(struct sx *sx, uintptr_t x, uintptr_t tid, int opts, 485fa474043SMateusz Guzik const char *file, int line) 4864e7f640dSJohn Baldwin { 4874e7f640dSJohn Baldwin GIANT_DECLARE; 4884e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 4894e7f640dSJohn Baldwin volatile struct thread *owner; 4901ae1c2a3SAttilio Rao u_int i, spintries = 0; 4914e7f640dSJohn Baldwin #endif 4921723a064SJeff Roberson #ifdef LOCK_PROFILING 4931723a064SJeff Roberson uint64_t waittime = 0; 4941723a064SJeff Roberson int contested = 0; 4951723a064SJeff Roberson #endif 4961723a064SJeff Roberson int error = 0; 49704126895SMateusz Guzik #if defined(ADAPTIVE_SX) || defined(KDTRACE_HOOKS) 4981ada9041SMateusz Guzik struct lock_delay_arg lda; 4991ada9041SMateusz Guzik #endif 500a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 501076dd8ebSAndriy Gapon uintptr_t state; 50261852185SMateusz Guzik u_int sleep_cnt = 0; 503a5aedd68SStacey Son int64_t sleep_time = 0; 504076dd8ebSAndriy Gapon int64_t all_time = 0; 505a5aedd68SStacey Son #endif 5064e7f640dSJohn Baldwin 50735370593SAndriy Gapon if (SCHEDULER_STOPPED()) 50835370593SAndriy Gapon return (0); 50935370593SAndriy Gapon 510fa5000a4SMateusz Guzik #if defined(ADAPTIVE_SX) 5111ada9041SMateusz Guzik lock_delay_arg_init(&lda, &sx_delay); 512fa5000a4SMateusz Guzik #elif defined(KDTRACE_HOOKS) 513fa5000a4SMateusz Guzik lock_delay_arg_init(&lda, NULL); 5141ada9041SMateusz Guzik #endif 5151ada9041SMateusz Guzik 516c1aaf63cSMateusz Guzik if (__predict_false(x == SX_LOCK_UNLOCKED)) 517c1aaf63cSMateusz Guzik x = SX_READ_VALUE(sx); 518c1aaf63cSMateusz Guzik 5194e7f640dSJohn Baldwin /* If we already hold an exclusive lock, then recurse. */ 520c5f61e6fSMateusz Guzik if (__predict_false(lv_sx_owner(x) == (struct thread *)tid)) { 521f0830182SAttilio Rao KASSERT((sx->lock_object.lo_flags & LO_RECURSABLE) != 0, 522b0d67325SJohn Baldwin ("_sx_xlock_hard: recursed on non-recursive sx %s @ %s:%d\n", 523b0d67325SJohn Baldwin sx->lock_object.lo_name, file, line)); 5244e7f640dSJohn Baldwin sx->sx_recurse++; 5254e7f640dSJohn Baldwin atomic_set_ptr(&sx->sx_lock, SX_LOCK_RECURSED); 5264e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 5274e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p recursing", __func__, sx); 528f9819486SAttilio Rao return (0); 5294e7f640dSJohn Baldwin } 5304e7f640dSJohn Baldwin 5314e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 5324e7f640dSJohn Baldwin CTR5(KTR_LOCK, "%s: %s contested (lock=%p) at %s:%d", __func__, 5334e7f640dSJohn Baldwin sx->lock_object.lo_name, (void *)sx->sx_lock, file, line); 5344e7f640dSJohn Baldwin 535076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 536e2b25737SMark Johnston all_time -= lockstat_nsecs(&sx->lock_object); 537c5f61e6fSMateusz Guzik state = x; 538076dd8ebSAndriy Gapon #endif 539fc4f686dSMateusz Guzik for (;;) { 540c5f61e6fSMateusz Guzik if (x == SX_LOCK_UNLOCKED) { 541fa474043SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, tid)) 542fc4f686dSMateusz Guzik break; 543c5f61e6fSMateusz Guzik continue; 544c5f61e6fSMateusz Guzik } 545a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 5461ada9041SMateusz Guzik lda.spin_cnt++; 547a5aedd68SStacey Son #endif 548f5f9340bSFabien Thomas #ifdef HWPMC_HOOKS 549f5f9340bSFabien Thomas PMC_SOFT_CALL( , , lock, failed); 550f5f9340bSFabien Thomas #endif 551eea4f254SJeff Roberson lock_profile_obtain_lock_failed(&sx->lock_object, &contested, 552eea4f254SJeff Roberson &waittime); 5534e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 5544e7f640dSJohn Baldwin /* 5554e7f640dSJohn Baldwin * If the lock is write locked and the owner is 5564e7f640dSJohn Baldwin * running on another CPU, spin until the owner stops 5574e7f640dSJohn Baldwin * running or the state of the lock changes. 5584e7f640dSJohn Baldwin */ 5598545538bSJohn Baldwin if ((sx->lock_object.lo_flags & SX_NOADAPTIVE) == 0) { 5601ae1c2a3SAttilio Rao if ((x & SX_LOCK_SHARED) == 0) { 561c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 5624e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 5634e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 5644e7f640dSJohn Baldwin CTR3(KTR_LOCK, 5654e7f640dSJohn Baldwin "%s: spinning on %p held by %p", 5664e7f640dSJohn Baldwin __func__, sx, owner); 5672cba8dd3SJohn Baldwin KTR_STATE1(KTR_SCHED, "thread", 5682cba8dd3SJohn Baldwin sched_tdname(curthread), "spinning", 5692cba8dd3SJohn Baldwin "lockname:\"%s\"", 5702cba8dd3SJohn Baldwin sx->lock_object.lo_name); 5714e7f640dSJohn Baldwin GIANT_SAVE(); 572c5f61e6fSMateusz Guzik do { 5731ada9041SMateusz Guzik lock_delay(&lda); 574c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 575c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 576c5f61e6fSMateusz Guzik } while (owner != NULL && 577c5f61e6fSMateusz Guzik TD_IS_RUNNING(owner)); 5782cba8dd3SJohn Baldwin KTR_STATE0(KTR_SCHED, "thread", 5792cba8dd3SJohn Baldwin sched_tdname(curthread), "running"); 5804e7f640dSJohn Baldwin continue; 5814e7f640dSJohn Baldwin } 5821ae1c2a3SAttilio Rao } else if (SX_SHARERS(x) && spintries < asx_retries) { 5832cba8dd3SJohn Baldwin KTR_STATE1(KTR_SCHED, "thread", 5842cba8dd3SJohn Baldwin sched_tdname(curthread), "spinning", 5852cba8dd3SJohn Baldwin "lockname:\"%s\"", sx->lock_object.lo_name); 5868d3635c4SAttilio Rao GIANT_SAVE(); 5871ae1c2a3SAttilio Rao spintries++; 5881ae1c2a3SAttilio Rao for (i = 0; i < asx_loops; i++) { 5891ae1c2a3SAttilio Rao if (LOCK_LOG_TEST(&sx->lock_object, 0)) 5901ae1c2a3SAttilio Rao CTR4(KTR_LOCK, 5911ae1c2a3SAttilio Rao "%s: shared spinning on %p with %u and %u", 5921ae1c2a3SAttilio Rao __func__, sx, spintries, i); 5931ae1c2a3SAttilio Rao x = sx->sx_lock; 5941ae1c2a3SAttilio Rao if ((x & SX_LOCK_SHARED) == 0 || 5951ae1c2a3SAttilio Rao SX_SHARERS(x) == 0) 5961ae1c2a3SAttilio Rao break; 5971ae1c2a3SAttilio Rao cpu_spinwait(); 5981ae1c2a3SAttilio Rao #ifdef KDTRACE_HOOKS 5991ada9041SMateusz Guzik lda.spin_cnt++; 6001ae1c2a3SAttilio Rao #endif 6011ae1c2a3SAttilio Rao } 6022cba8dd3SJohn Baldwin KTR_STATE0(KTR_SCHED, "thread", 6032cba8dd3SJohn Baldwin sched_tdname(curthread), "running"); 604c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 6051ae1c2a3SAttilio Rao if (i != asx_loops) 6061ae1c2a3SAttilio Rao continue; 6071ae1c2a3SAttilio Rao } 6084e7f640dSJohn Baldwin } 6094e7f640dSJohn Baldwin #endif 6104e7f640dSJohn Baldwin 6114e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 612c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 6134e7f640dSJohn Baldwin 6144e7f640dSJohn Baldwin /* 6154e7f640dSJohn Baldwin * If the lock was released while spinning on the 6164e7f640dSJohn Baldwin * sleep queue chain lock, try again. 6174e7f640dSJohn Baldwin */ 6184e7f640dSJohn Baldwin if (x == SX_LOCK_UNLOCKED) { 6194e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 6204e7f640dSJohn Baldwin continue; 6214e7f640dSJohn Baldwin } 6224e7f640dSJohn Baldwin 6234e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 6244e7f640dSJohn Baldwin /* 6254e7f640dSJohn Baldwin * The current lock owner might have started executing 6264e7f640dSJohn Baldwin * on another CPU (or the lock could have changed 6274e7f640dSJohn Baldwin * owners) while we were waiting on the sleep queue 6284e7f640dSJohn Baldwin * chain lock. If so, drop the sleep queue lock and try 6294e7f640dSJohn Baldwin * again. 6304e7f640dSJohn Baldwin */ 6314e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED) && 6321ae1c2a3SAttilio Rao (sx->lock_object.lo_flags & SX_NOADAPTIVE) == 0) { 6334e7f640dSJohn Baldwin owner = (struct thread *)SX_OWNER(x); 6344e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 6354e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 6364e7f640dSJohn Baldwin continue; 6374e7f640dSJohn Baldwin } 6384e7f640dSJohn Baldwin } 6394e7f640dSJohn Baldwin #endif 6404e7f640dSJohn Baldwin 6414e7f640dSJohn Baldwin /* 6424e7f640dSJohn Baldwin * If an exclusive lock was released with both shared 6434e7f640dSJohn Baldwin * and exclusive waiters and a shared waiter hasn't 6444e7f640dSJohn Baldwin * woken up and acquired the lock yet, sx_lock will be 6454e7f640dSJohn Baldwin * set to SX_LOCK_UNLOCKED | SX_LOCK_EXCLUSIVE_WAITERS. 6464e7f640dSJohn Baldwin * If we see that value, try to acquire it once. Note 6474e7f640dSJohn Baldwin * that we have to preserve SX_LOCK_EXCLUSIVE_WAITERS 6484e7f640dSJohn Baldwin * as there are other exclusive waiters still. If we 6494e7f640dSJohn Baldwin * fail, restart the loop. 6504e7f640dSJohn Baldwin */ 6514e7f640dSJohn Baldwin if (x == (SX_LOCK_UNLOCKED | SX_LOCK_EXCLUSIVE_WAITERS)) { 6524e7f640dSJohn Baldwin if (atomic_cmpset_acq_ptr(&sx->sx_lock, 6534e7f640dSJohn Baldwin SX_LOCK_UNLOCKED | SX_LOCK_EXCLUSIVE_WAITERS, 6544e7f640dSJohn Baldwin tid | SX_LOCK_EXCLUSIVE_WAITERS)) { 6554e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 6564e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p claimed by new writer", 6574e7f640dSJohn Baldwin __func__, sx); 6584e7f640dSJohn Baldwin break; 6594e7f640dSJohn Baldwin } 6604e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 661c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 6624e7f640dSJohn Baldwin continue; 6634e7f640dSJohn Baldwin } 6644e7f640dSJohn Baldwin 6654e7f640dSJohn Baldwin /* 6664e7f640dSJohn Baldwin * Try to set the SX_LOCK_EXCLUSIVE_WAITERS. If we fail, 6674e7f640dSJohn Baldwin * than loop back and retry. 6684e7f640dSJohn Baldwin */ 6694e7f640dSJohn Baldwin if (!(x & SX_LOCK_EXCLUSIVE_WAITERS)) { 6704e7f640dSJohn Baldwin if (!atomic_cmpset_ptr(&sx->sx_lock, x, 6714e7f640dSJohn Baldwin x | SX_LOCK_EXCLUSIVE_WAITERS)) { 6724e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 673c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 6744e7f640dSJohn Baldwin continue; 6754e7f640dSJohn Baldwin } 6764e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 6774e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p set excl waiters flag", 6784e7f640dSJohn Baldwin __func__, sx); 6794e7f640dSJohn Baldwin } 6804e7f640dSJohn Baldwin 6814e7f640dSJohn Baldwin /* 6824e7f640dSJohn Baldwin * Since we have been unable to acquire the exclusive 6834e7f640dSJohn Baldwin * lock and the exclusive waiters flag is set, we have 6844e7f640dSJohn Baldwin * to sleep. 6854e7f640dSJohn Baldwin */ 6864e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 6874e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p blocking on sleep queue", 6884e7f640dSJohn Baldwin __func__, sx); 6894e7f640dSJohn Baldwin 690a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 691e2b25737SMark Johnston sleep_time -= lockstat_nsecs(&sx->lock_object); 692a5aedd68SStacey Son #endif 6934e7f640dSJohn Baldwin GIANT_SAVE(); 6944e7f640dSJohn Baldwin sleepq_add(&sx->lock_object, NULL, sx->lock_object.lo_name, 695f9819486SAttilio Rao SLEEPQ_SX | ((opts & SX_INTERRUPTIBLE) ? 696f9819486SAttilio Rao SLEEPQ_INTERRUPTIBLE : 0), SQ_EXCLUSIVE_QUEUE); 697f9819486SAttilio Rao if (!(opts & SX_INTERRUPTIBLE)) 698c5aa6b58SJeff Roberson sleepq_wait(&sx->lock_object, 0); 699f9819486SAttilio Rao else 700c5aa6b58SJeff Roberson error = sleepq_wait_sig(&sx->lock_object, 0); 701a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 702e2b25737SMark Johnston sleep_time += lockstat_nsecs(&sx->lock_object); 703a5aedd68SStacey Son sleep_cnt++; 704a5aedd68SStacey Son #endif 705f9819486SAttilio Rao if (error) { 706f9819486SAttilio Rao if (LOCK_LOG_TEST(&sx->lock_object, 0)) 707f9819486SAttilio Rao CTR2(KTR_LOCK, 708f9819486SAttilio Rao "%s: interruptible sleep by %p suspended by signal", 709f9819486SAttilio Rao __func__, sx); 710f9819486SAttilio Rao break; 711f9819486SAttilio Rao } 7124e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 7134e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p resuming from sleep queue", 7144e7f640dSJohn Baldwin __func__, sx); 715c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 7164e7f640dSJohn Baldwin } 717076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 718e2b25737SMark Johnston all_time += lockstat_nsecs(&sx->lock_object); 719076dd8ebSAndriy Gapon if (sleep_time) 72032cd0147SMark Johnston LOCKSTAT_RECORD4(sx__block, sx, sleep_time, 721076dd8ebSAndriy Gapon LOCKSTAT_WRITER, (state & SX_LOCK_SHARED) == 0, 722076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 7231ada9041SMateusz Guzik if (lda.spin_cnt > sleep_cnt) 72432cd0147SMark Johnston LOCKSTAT_RECORD4(sx__spin, sx, all_time - sleep_time, 725076dd8ebSAndriy Gapon LOCKSTAT_WRITER, (state & SX_LOCK_SHARED) == 0, 726076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 727076dd8ebSAndriy Gapon #endif 728f9819486SAttilio Rao if (!error) 729de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, sx, 730de2c95ccSMark Johnston contested, waittime, file, line, LOCKSTAT_WRITER); 731076dd8ebSAndriy Gapon GIANT_RESTORE(); 732f9819486SAttilio Rao return (error); 7334e7f640dSJohn Baldwin } 7344e7f640dSJohn Baldwin 7354e7f640dSJohn Baldwin /* 7364e7f640dSJohn Baldwin * This function represents the so-called 'hard case' for sx_xunlock 7374e7f640dSJohn Baldwin * operation. All 'easy case' failures are redirected to this. Note 7384e7f640dSJohn Baldwin * that ideally this would be a static function, but it needs to be 7394e7f640dSJohn Baldwin * accessible from at least sx.h. 7404e7f640dSJohn Baldwin */ 7414e7f640dSJohn Baldwin void 7424e7f640dSJohn Baldwin _sx_xunlock_hard(struct sx *sx, uintptr_t tid, const char *file, int line) 7434e7f640dSJohn Baldwin { 7444e7f640dSJohn Baldwin uintptr_t x; 745da7bbd2cSJohn Baldwin int queue, wakeup_swapper; 7464e7f640dSJohn Baldwin 74735370593SAndriy Gapon if (SCHEDULER_STOPPED()) 74835370593SAndriy Gapon return; 74935370593SAndriy Gapon 7504e7f640dSJohn Baldwin MPASS(!(sx->sx_lock & SX_LOCK_SHARED)); 7514e7f640dSJohn Baldwin 752*3b3cf014SMateusz Guzik x = SX_READ_VALUE(sx); 753*3b3cf014SMateusz Guzik if (x & SX_LOCK_RECURSED) { 7546ebb77b6SMateusz Guzik /* The lock is recursed, unrecurse one level. */ 7554e7f640dSJohn Baldwin if ((--sx->sx_recurse) == 0) 7564e7f640dSJohn Baldwin atomic_clear_ptr(&sx->sx_lock, SX_LOCK_RECURSED); 7574e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 7584e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p unrecursing", __func__, sx); 7594e7f640dSJohn Baldwin return; 7604e7f640dSJohn Baldwin } 761*3b3cf014SMateusz Guzik 762*3b3cf014SMateusz Guzik LOCKSTAT_PROFILE_RELEASE_RWLOCK(sx__release, sx, LOCKSTAT_WRITER); 763*3b3cf014SMateusz Guzik if (x == tid && 764*3b3cf014SMateusz Guzik atomic_cmpset_rel_ptr(&sx->sx_lock, tid, SX_LOCK_UNLOCKED)) 765*3b3cf014SMateusz Guzik return; 766*3b3cf014SMateusz Guzik 7674e7f640dSJohn Baldwin MPASS(sx->sx_lock & (SX_LOCK_SHARED_WAITERS | 7684e7f640dSJohn Baldwin SX_LOCK_EXCLUSIVE_WAITERS)); 7694e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 7704e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p contested", __func__, sx); 7714e7f640dSJohn Baldwin 7724e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 7734e7f640dSJohn Baldwin x = SX_LOCK_UNLOCKED; 7744e7f640dSJohn Baldwin 7754e7f640dSJohn Baldwin /* 7764e7f640dSJohn Baldwin * The wake up algorithm here is quite simple and probably not 7774e7f640dSJohn Baldwin * ideal. It gives precedence to shared waiters if they are 7784e7f640dSJohn Baldwin * present. For this condition, we have to preserve the 7794e7f640dSJohn Baldwin * state of the exclusive waiters flag. 7802028867dSAttilio Rao * If interruptible sleeps left the shared queue empty avoid a 7812028867dSAttilio Rao * starvation for the threads sleeping on the exclusive queue by giving 7822028867dSAttilio Rao * them precedence and cleaning up the shared waiters bit anyway. 7834e7f640dSJohn Baldwin */ 7842028867dSAttilio Rao if ((sx->sx_lock & SX_LOCK_SHARED_WAITERS) != 0 && 7852028867dSAttilio Rao sleepq_sleepcnt(&sx->lock_object, SQ_SHARED_QUEUE) != 0) { 7864e7f640dSJohn Baldwin queue = SQ_SHARED_QUEUE; 7874e7f640dSJohn Baldwin x |= (sx->sx_lock & SX_LOCK_EXCLUSIVE_WAITERS); 7884e7f640dSJohn Baldwin } else 7894e7f640dSJohn Baldwin queue = SQ_EXCLUSIVE_QUEUE; 7904e7f640dSJohn Baldwin 7914e7f640dSJohn Baldwin /* Wake up all the waiters for the specific queue. */ 7924e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 7934e7f640dSJohn Baldwin CTR3(KTR_LOCK, "%s: %p waking up all threads on %s queue", 7944e7f640dSJohn Baldwin __func__, sx, queue == SQ_SHARED_QUEUE ? "shared" : 7954e7f640dSJohn Baldwin "exclusive"); 7964e7f640dSJohn Baldwin atomic_store_rel_ptr(&sx->sx_lock, x); 797da7bbd2cSJohn Baldwin wakeup_swapper = sleepq_broadcast(&sx->lock_object, SLEEPQ_SX, 0, 798da7bbd2cSJohn Baldwin queue); 799c5aa6b58SJeff Roberson sleepq_release(&sx->lock_object); 800da7bbd2cSJohn Baldwin if (wakeup_swapper) 801da7bbd2cSJohn Baldwin kick_proc0(); 8024e7f640dSJohn Baldwin } 8034e7f640dSJohn Baldwin 804834f70f3SMateusz Guzik static bool __always_inline 805834f70f3SMateusz Guzik __sx_slock_try(struct sx *sx, uintptr_t *xp, const char *file, int line) 806834f70f3SMateusz Guzik { 807834f70f3SMateusz Guzik 808834f70f3SMateusz Guzik /* 809834f70f3SMateusz Guzik * If no other thread has an exclusive lock then try to bump up 810834f70f3SMateusz Guzik * the count of sharers. Since we have to preserve the state 811834f70f3SMateusz Guzik * of SX_LOCK_EXCLUSIVE_WAITERS, if we fail to acquire the 812834f70f3SMateusz Guzik * shared lock loop back and retry. 813834f70f3SMateusz Guzik */ 814834f70f3SMateusz Guzik while (*xp & SX_LOCK_SHARED) { 815834f70f3SMateusz Guzik MPASS(!(*xp & SX_LOCK_SHARED_WAITERS)); 816834f70f3SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, xp, 817834f70f3SMateusz Guzik *xp + SX_ONE_SHARER)) { 818834f70f3SMateusz Guzik if (LOCK_LOG_TEST(&sx->lock_object, 0)) 819834f70f3SMateusz Guzik CTR4(KTR_LOCK, "%s: %p succeed %p -> %p", 820834f70f3SMateusz Guzik __func__, sx, (void *)*xp, 821834f70f3SMateusz Guzik (void *)(*xp + SX_ONE_SHARER)); 822834f70f3SMateusz Guzik return (true); 823834f70f3SMateusz Guzik } 824834f70f3SMateusz Guzik } 825834f70f3SMateusz Guzik return (false); 826834f70f3SMateusz Guzik } 827834f70f3SMateusz Guzik 828834f70f3SMateusz Guzik static int __noinline 829834f70f3SMateusz Guzik _sx_slock_hard(struct sx *sx, int opts, const char *file, int line, uintptr_t x) 8304e7f640dSJohn Baldwin { 8314e7f640dSJohn Baldwin GIANT_DECLARE; 8324e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 8334e7f640dSJohn Baldwin volatile struct thread *owner; 8344e7f640dSJohn Baldwin #endif 8351723a064SJeff Roberson #ifdef LOCK_PROFILING 836c1a6d9faSAttilio Rao uint64_t waittime = 0; 837c1a6d9faSAttilio Rao int contested = 0; 8381723a064SJeff Roberson #endif 839c1a6d9faSAttilio Rao int error = 0; 84004126895SMateusz Guzik #if defined(ADAPTIVE_SX) || defined(KDTRACE_HOOKS) 8411ada9041SMateusz Guzik struct lock_delay_arg lda; 8421ada9041SMateusz Guzik #endif 843a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 844076dd8ebSAndriy Gapon uintptr_t state; 84561852185SMateusz Guzik u_int sleep_cnt = 0; 846a5aedd68SStacey Son int64_t sleep_time = 0; 847076dd8ebSAndriy Gapon int64_t all_time = 0; 848a5aedd68SStacey Son #endif 849c1a6d9faSAttilio Rao 85035370593SAndriy Gapon if (SCHEDULER_STOPPED()) 85135370593SAndriy Gapon return (0); 85235370593SAndriy Gapon 853fa5000a4SMateusz Guzik #if defined(ADAPTIVE_SX) 8541ada9041SMateusz Guzik lock_delay_arg_init(&lda, &sx_delay); 855fa5000a4SMateusz Guzik #elif defined(KDTRACE_HOOKS) 856fa5000a4SMateusz Guzik lock_delay_arg_init(&lda, NULL); 8571ada9041SMateusz Guzik #endif 858076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 859e2b25737SMark Johnston all_time -= lockstat_nsecs(&sx->lock_object); 860c5f61e6fSMateusz Guzik state = x; 861c5f61e6fSMateusz Guzik #endif 862076dd8ebSAndriy Gapon 8634e7f640dSJohn Baldwin /* 8644e7f640dSJohn Baldwin * As with rwlocks, we don't make any attempt to try to block 8654e7f640dSJohn Baldwin * shared locks once there is an exclusive waiter. 8664e7f640dSJohn Baldwin */ 8674e7f640dSJohn Baldwin for (;;) { 868834f70f3SMateusz Guzik if (__sx_slock_try(sx, &x, file, line)) 8694e7f640dSJohn Baldwin break; 870c5f61e6fSMateusz Guzik #ifdef KDTRACE_HOOKS 871c5f61e6fSMateusz Guzik lda.spin_cnt++; 872c5f61e6fSMateusz Guzik #endif 873c5f61e6fSMateusz Guzik 874f5f9340bSFabien Thomas #ifdef HWPMC_HOOKS 875f5f9340bSFabien Thomas PMC_SOFT_CALL( , , lock, failed); 876f5f9340bSFabien Thomas #endif 877eea4f254SJeff Roberson lock_profile_obtain_lock_failed(&sx->lock_object, &contested, 878eea4f254SJeff Roberson &waittime); 8794e7f640dSJohn Baldwin 8804e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 8814e7f640dSJohn Baldwin /* 8824e7f640dSJohn Baldwin * If the owner is running on another CPU, spin until 8834e7f640dSJohn Baldwin * the owner stops running or the state of the lock 8844e7f640dSJohn Baldwin * changes. 8854e7f640dSJohn Baldwin */ 8861ae1c2a3SAttilio Rao if ((sx->lock_object.lo_flags & SX_NOADAPTIVE) == 0) { 887c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 8884e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 8894e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 8904e7f640dSJohn Baldwin CTR3(KTR_LOCK, 8914e7f640dSJohn Baldwin "%s: spinning on %p held by %p", 8924e7f640dSJohn Baldwin __func__, sx, owner); 8932cba8dd3SJohn Baldwin KTR_STATE1(KTR_SCHED, "thread", 8942cba8dd3SJohn Baldwin sched_tdname(curthread), "spinning", 8952cba8dd3SJohn Baldwin "lockname:\"%s\"", sx->lock_object.lo_name); 8964e7f640dSJohn Baldwin GIANT_SAVE(); 897c5f61e6fSMateusz Guzik do { 8981ada9041SMateusz Guzik lock_delay(&lda); 899c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 900c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 901c5f61e6fSMateusz Guzik } while (owner != NULL && TD_IS_RUNNING(owner)); 9022cba8dd3SJohn Baldwin KTR_STATE0(KTR_SCHED, "thread", 9032cba8dd3SJohn Baldwin sched_tdname(curthread), "running"); 9044e7f640dSJohn Baldwin continue; 9054e7f640dSJohn Baldwin } 9064e7f640dSJohn Baldwin } 9074e7f640dSJohn Baldwin #endif 9084e7f640dSJohn Baldwin 9094e7f640dSJohn Baldwin /* 9104e7f640dSJohn Baldwin * Some other thread already has an exclusive lock, so 9114e7f640dSJohn Baldwin * start the process of blocking. 9124e7f640dSJohn Baldwin */ 9134e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 914c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 9154e7f640dSJohn Baldwin 9164e7f640dSJohn Baldwin /* 9174e7f640dSJohn Baldwin * The lock could have been released while we spun. 9184e7f640dSJohn Baldwin * In this case loop back and retry. 9194e7f640dSJohn Baldwin */ 9204e7f640dSJohn Baldwin if (x & SX_LOCK_SHARED) { 9214e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 9224e7f640dSJohn Baldwin continue; 9234e7f640dSJohn Baldwin } 9244e7f640dSJohn Baldwin 9254e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 9264e7f640dSJohn Baldwin /* 9274e7f640dSJohn Baldwin * If the owner is running on another CPU, spin until 9284e7f640dSJohn Baldwin * the owner stops running or the state of the lock 9294e7f640dSJohn Baldwin * changes. 9304e7f640dSJohn Baldwin */ 9314e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED) && 9321ae1c2a3SAttilio Rao (sx->lock_object.lo_flags & SX_NOADAPTIVE) == 0) { 9334e7f640dSJohn Baldwin owner = (struct thread *)SX_OWNER(x); 9344e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 9354e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 936c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 9374e7f640dSJohn Baldwin continue; 9384e7f640dSJohn Baldwin } 9394e7f640dSJohn Baldwin } 9404e7f640dSJohn Baldwin #endif 9414e7f640dSJohn Baldwin 9424e7f640dSJohn Baldwin /* 9434e7f640dSJohn Baldwin * Try to set the SX_LOCK_SHARED_WAITERS flag. If we 9444e7f640dSJohn Baldwin * fail to set it drop the sleep queue lock and loop 9454e7f640dSJohn Baldwin * back. 9464e7f640dSJohn Baldwin */ 9474e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED_WAITERS)) { 9484e7f640dSJohn Baldwin if (!atomic_cmpset_ptr(&sx->sx_lock, x, 9494e7f640dSJohn Baldwin x | SX_LOCK_SHARED_WAITERS)) { 9504e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 951c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 9524e7f640dSJohn Baldwin continue; 9534e7f640dSJohn Baldwin } 9544e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 9554e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p set shared waiters flag", 9564e7f640dSJohn Baldwin __func__, sx); 9574e7f640dSJohn Baldwin } 9584e7f640dSJohn Baldwin 9594e7f640dSJohn Baldwin /* 9604e7f640dSJohn Baldwin * Since we have been unable to acquire the shared lock, 9614e7f640dSJohn Baldwin * we have to sleep. 9624e7f640dSJohn Baldwin */ 9634e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 9644e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p blocking on sleep queue", 9654e7f640dSJohn Baldwin __func__, sx); 9664e7f640dSJohn Baldwin 967a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 968e2b25737SMark Johnston sleep_time -= lockstat_nsecs(&sx->lock_object); 969a5aedd68SStacey Son #endif 9704e7f640dSJohn Baldwin GIANT_SAVE(); 9714e7f640dSJohn Baldwin sleepq_add(&sx->lock_object, NULL, sx->lock_object.lo_name, 972f9819486SAttilio Rao SLEEPQ_SX | ((opts & SX_INTERRUPTIBLE) ? 973f9819486SAttilio Rao SLEEPQ_INTERRUPTIBLE : 0), SQ_SHARED_QUEUE); 974f9819486SAttilio Rao if (!(opts & SX_INTERRUPTIBLE)) 975c5aa6b58SJeff Roberson sleepq_wait(&sx->lock_object, 0); 976f9819486SAttilio Rao else 977c5aa6b58SJeff Roberson error = sleepq_wait_sig(&sx->lock_object, 0); 978a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 979e2b25737SMark Johnston sleep_time += lockstat_nsecs(&sx->lock_object); 980a5aedd68SStacey Son sleep_cnt++; 981a5aedd68SStacey Son #endif 982f9819486SAttilio Rao if (error) { 983f9819486SAttilio Rao if (LOCK_LOG_TEST(&sx->lock_object, 0)) 984f9819486SAttilio Rao CTR2(KTR_LOCK, 985f9819486SAttilio Rao "%s: interruptible sleep by %p suspended by signal", 986f9819486SAttilio Rao __func__, sx); 987f9819486SAttilio Rao break; 988f9819486SAttilio Rao } 9894e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 9904e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p resuming from sleep queue", 9914e7f640dSJohn Baldwin __func__, sx); 992c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 9934e7f640dSJohn Baldwin } 994076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 995e2b25737SMark Johnston all_time += lockstat_nsecs(&sx->lock_object); 996076dd8ebSAndriy Gapon if (sleep_time) 99732cd0147SMark Johnston LOCKSTAT_RECORD4(sx__block, sx, sleep_time, 998076dd8ebSAndriy Gapon LOCKSTAT_READER, (state & SX_LOCK_SHARED) == 0, 999076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 10001ada9041SMateusz Guzik if (lda.spin_cnt > sleep_cnt) 100132cd0147SMark Johnston LOCKSTAT_RECORD4(sx__spin, sx, all_time - sleep_time, 1002076dd8ebSAndriy Gapon LOCKSTAT_READER, (state & SX_LOCK_SHARED) == 0, 1003076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 1004076dd8ebSAndriy Gapon #endif 10053ae56ce9SMateusz Guzik if (error == 0) { 1006de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, sx, 1007de2c95ccSMark Johnston contested, waittime, file, line, LOCKSTAT_READER); 10083ae56ce9SMateusz Guzik } 10094e7f640dSJohn Baldwin GIANT_RESTORE(); 1010f9819486SAttilio Rao return (error); 10114e7f640dSJohn Baldwin } 10124e7f640dSJohn Baldwin 1013834f70f3SMateusz Guzik int 1014834f70f3SMateusz Guzik _sx_slock(struct sx *sx, int opts, const char *file, int line) 10154e7f640dSJohn Baldwin { 10164e7f640dSJohn Baldwin uintptr_t x; 1017834f70f3SMateusz Guzik int error; 10184e7f640dSJohn Baldwin 1019834f70f3SMateusz Guzik KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 1020834f70f3SMateusz Guzik ("sx_slock() by idle thread %p on sx %s @ %s:%d", 1021834f70f3SMateusz Guzik curthread, sx->lock_object.lo_name, file, line)); 10223ae56ce9SMateusz Guzik KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 1023834f70f3SMateusz Guzik ("sx_slock() of destroyed sx @ %s:%d", file, line)); 1024834f70f3SMateusz Guzik WITNESS_CHECKORDER(&sx->lock_object, LOP_NEWORDER, file, line, NULL); 1025834f70f3SMateusz Guzik 1026834f70f3SMateusz Guzik error = 0; 1027c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 1028834f70f3SMateusz Guzik if (__predict_false(LOCKSTAT_OOL_PROFILE_ENABLED(sx__acquire) || 1029834f70f3SMateusz Guzik !__sx_slock_try(sx, &x, file, line))) 1030834f70f3SMateusz Guzik error = _sx_slock_hard(sx, opts, file, line, x); 1031834f70f3SMateusz Guzik if (error == 0) { 1032834f70f3SMateusz Guzik LOCK_LOG_LOCK("SLOCK", &sx->lock_object, 0, 0, file, line); 1033834f70f3SMateusz Guzik WITNESS_LOCK(&sx->lock_object, 0, file, line); 1034834f70f3SMateusz Guzik TD_LOCKS_INC(curthread); 1035834f70f3SMateusz Guzik } 1036834f70f3SMateusz Guzik return (error); 1037834f70f3SMateusz Guzik } 1038834f70f3SMateusz Guzik 1039834f70f3SMateusz Guzik static bool __always_inline 1040834f70f3SMateusz Guzik _sx_sunlock_try(struct sx *sx, uintptr_t *xp) 1041834f70f3SMateusz Guzik { 1042834f70f3SMateusz Guzik 10434e7f640dSJohn Baldwin for (;;) { 10444e7f640dSJohn Baldwin /* 10454e7f640dSJohn Baldwin * We should never have sharers while at least one thread 10464e7f640dSJohn Baldwin * holds a shared lock. 10474e7f640dSJohn Baldwin */ 1048834f70f3SMateusz Guzik KASSERT(!(*xp & SX_LOCK_SHARED_WAITERS), 10494e7f640dSJohn Baldwin ("%s: waiting sharers", __func__)); 10504e7f640dSJohn Baldwin 10514e7f640dSJohn Baldwin /* 10524e7f640dSJohn Baldwin * See if there is more than one shared lock held. If 10534e7f640dSJohn Baldwin * so, just drop one and return. 10544e7f640dSJohn Baldwin */ 1055834f70f3SMateusz Guzik if (SX_SHARERS(*xp) > 1) { 1056834f70f3SMateusz Guzik if (atomic_fcmpset_rel_ptr(&sx->sx_lock, xp, 1057834f70f3SMateusz Guzik *xp - SX_ONE_SHARER)) { 10584e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 10594e7f640dSJohn Baldwin CTR4(KTR_LOCK, 10604e7f640dSJohn Baldwin "%s: %p succeeded %p -> %p", 1061834f70f3SMateusz Guzik __func__, sx, (void *)*xp, 1062834f70f3SMateusz Guzik (void *)(*xp - SX_ONE_SHARER)); 1063834f70f3SMateusz Guzik return (true); 10644e7f640dSJohn Baldwin } 10654e7f640dSJohn Baldwin continue; 10664e7f640dSJohn Baldwin } 10674e7f640dSJohn Baldwin 10684e7f640dSJohn Baldwin /* 10694e7f640dSJohn Baldwin * If there aren't any waiters for an exclusive lock, 10704e7f640dSJohn Baldwin * then try to drop it quickly. 10714e7f640dSJohn Baldwin */ 1072834f70f3SMateusz Guzik if (!(*xp & SX_LOCK_EXCLUSIVE_WAITERS)) { 1073834f70f3SMateusz Guzik MPASS(*xp == SX_SHARERS_LOCK(1)); 1074834f70f3SMateusz Guzik *xp = SX_SHARERS_LOCK(1); 1075fa474043SMateusz Guzik if (atomic_fcmpset_rel_ptr(&sx->sx_lock, 1076834f70f3SMateusz Guzik xp, SX_LOCK_UNLOCKED)) { 10774e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 10784e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p last succeeded", 10794e7f640dSJohn Baldwin __func__, sx); 1080834f70f3SMateusz Guzik return (true); 10814e7f640dSJohn Baldwin } 10824e7f640dSJohn Baldwin continue; 10834e7f640dSJohn Baldwin } 1084834f70f3SMateusz Guzik break; 1085834f70f3SMateusz Guzik } 1086834f70f3SMateusz Guzik return (false); 1087834f70f3SMateusz Guzik } 1088834f70f3SMateusz Guzik 1089834f70f3SMateusz Guzik static void __noinline 1090834f70f3SMateusz Guzik _sx_sunlock_hard(struct sx *sx, uintptr_t x, const char *file, int line) 1091834f70f3SMateusz Guzik { 1092834f70f3SMateusz Guzik int wakeup_swapper; 1093834f70f3SMateusz Guzik 1094834f70f3SMateusz Guzik if (SCHEDULER_STOPPED()) 1095834f70f3SMateusz Guzik return; 1096834f70f3SMateusz Guzik 1097834f70f3SMateusz Guzik LOCKSTAT_PROFILE_RELEASE_RWLOCK(sx__release, sx, LOCKSTAT_READER); 1098834f70f3SMateusz Guzik 1099834f70f3SMateusz Guzik for (;;) { 1100834f70f3SMateusz Guzik if (_sx_sunlock_try(sx, &x)) 1101834f70f3SMateusz Guzik break; 11024e7f640dSJohn Baldwin 11034e7f640dSJohn Baldwin /* 11044e7f640dSJohn Baldwin * At this point, there should just be one sharer with 11054e7f640dSJohn Baldwin * exclusive waiters. 11064e7f640dSJohn Baldwin */ 11074e7f640dSJohn Baldwin MPASS(x == (SX_SHARERS_LOCK(1) | SX_LOCK_EXCLUSIVE_WAITERS)); 11084e7f640dSJohn Baldwin 11094e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 11104e7f640dSJohn Baldwin 11114e7f640dSJohn Baldwin /* 11124e7f640dSJohn Baldwin * Wake up semantic here is quite simple: 11134e7f640dSJohn Baldwin * Just wake up all the exclusive waiters. 11144e7f640dSJohn Baldwin * Note that the state of the lock could have changed, 11154e7f640dSJohn Baldwin * so if it fails loop back and retry. 11164e7f640dSJohn Baldwin */ 1117ddce63caSAttilio Rao if (!atomic_cmpset_rel_ptr(&sx->sx_lock, 11184e7f640dSJohn Baldwin SX_SHARERS_LOCK(1) | SX_LOCK_EXCLUSIVE_WAITERS, 11194e7f640dSJohn Baldwin SX_LOCK_UNLOCKED)) { 11204e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 1121c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 11224e7f640dSJohn Baldwin continue; 11234e7f640dSJohn Baldwin } 11244e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 11254e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p waking up all thread on" 11264e7f640dSJohn Baldwin "exclusive queue", __func__, sx); 1127da7bbd2cSJohn Baldwin wakeup_swapper = sleepq_broadcast(&sx->lock_object, SLEEPQ_SX, 1128da7bbd2cSJohn Baldwin 0, SQ_EXCLUSIVE_QUEUE); 1129c5aa6b58SJeff Roberson sleepq_release(&sx->lock_object); 1130da7bbd2cSJohn Baldwin if (wakeup_swapper) 1131da7bbd2cSJohn Baldwin kick_proc0(); 11324e7f640dSJohn Baldwin break; 11334e7f640dSJohn Baldwin } 1134834f70f3SMateusz Guzik } 1135834f70f3SMateusz Guzik 1136834f70f3SMateusz Guzik void 1137834f70f3SMateusz Guzik _sx_sunlock(struct sx *sx, const char *file, int line) 1138834f70f3SMateusz Guzik { 1139834f70f3SMateusz Guzik uintptr_t x; 1140834f70f3SMateusz Guzik 1141834f70f3SMateusz Guzik KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 1142834f70f3SMateusz Guzik ("sx_sunlock() of destroyed sx @ %s:%d", file, line)); 1143834f70f3SMateusz Guzik _sx_assert(sx, SA_SLOCKED, file, line); 1144834f70f3SMateusz Guzik WITNESS_UNLOCK(&sx->lock_object, 0, file, line); 1145834f70f3SMateusz Guzik LOCK_LOG_LOCK("SUNLOCK", &sx->lock_object, 0, 0, file, line); 1146834f70f3SMateusz Guzik 1147834f70f3SMateusz Guzik x = SX_READ_VALUE(sx); 1148834f70f3SMateusz Guzik if (__predict_false(LOCKSTAT_OOL_PROFILE_ENABLED(sx__release) || 1149834f70f3SMateusz Guzik !_sx_sunlock_try(sx, &x))) 1150834f70f3SMateusz Guzik _sx_sunlock_hard(sx, x, file, line); 1151834f70f3SMateusz Guzik 11523ae56ce9SMateusz Guzik TD_LOCKS_DEC(curthread); 1153d55229b7SJason Evans } 11544e5e677bSJohn Baldwin 11554e5e677bSJohn Baldwin #ifdef INVARIANT_SUPPORT 1156781a35dfSJohn Baldwin #ifndef INVARIANTS 1157781a35dfSJohn Baldwin #undef _sx_assert 1158781a35dfSJohn Baldwin #endif 1159781a35dfSJohn Baldwin 11604e5e677bSJohn Baldwin /* 11614e5e677bSJohn Baldwin * In the non-WITNESS case, sx_assert() can only detect that at least 11624e5e677bSJohn Baldwin * *some* thread owns an slock, but it cannot guarantee that *this* 11634e5e677bSJohn Baldwin * thread owns an slock. 11644e5e677bSJohn Baldwin */ 11654e5e677bSJohn Baldwin void 1166d576deedSPawel Jakub Dawidek _sx_assert(const struct sx *sx, int what, const char *file, int line) 11674e5e677bSJohn Baldwin { 11684e7f640dSJohn Baldwin #ifndef WITNESS 11694e7f640dSJohn Baldwin int slocked = 0; 11704e7f640dSJohn Baldwin #endif 11714e5e677bSJohn Baldwin 117203129ba9SJohn Baldwin if (panicstr != NULL) 117303129ba9SJohn Baldwin return; 11744e5e677bSJohn Baldwin switch (what) { 11757ec137e5SJohn Baldwin case SA_SLOCKED: 11767ec137e5SJohn Baldwin case SA_SLOCKED | SA_NOTRECURSED: 11777ec137e5SJohn Baldwin case SA_SLOCKED | SA_RECURSED: 11784e7f640dSJohn Baldwin #ifndef WITNESS 11794e7f640dSJohn Baldwin slocked = 1; 11804e7f640dSJohn Baldwin /* FALLTHROUGH */ 11814e7f640dSJohn Baldwin #endif 11827ec137e5SJohn Baldwin case SA_LOCKED: 11837ec137e5SJohn Baldwin case SA_LOCKED | SA_NOTRECURSED: 11847ec137e5SJohn Baldwin case SA_LOCKED | SA_RECURSED: 11854e5e677bSJohn Baldwin #ifdef WITNESS 1186aa89d8cdSJohn Baldwin witness_assert(&sx->lock_object, what, file, line); 11874e5e677bSJohn Baldwin #else 11884e7f640dSJohn Baldwin /* 11894e7f640dSJohn Baldwin * If some other thread has an exclusive lock or we 11904e7f640dSJohn Baldwin * have one and are asserting a shared lock, fail. 11914e7f640dSJohn Baldwin * Also, if no one has a lock at all, fail. 11924e7f640dSJohn Baldwin */ 11934e7f640dSJohn Baldwin if (sx->sx_lock == SX_LOCK_UNLOCKED || 11944e7f640dSJohn Baldwin (!(sx->sx_lock & SX_LOCK_SHARED) && (slocked || 11954e7f640dSJohn Baldwin sx_xholder(sx) != curthread))) 119603129ba9SJohn Baldwin panic("Lock %s not %slocked @ %s:%d\n", 11974e7f640dSJohn Baldwin sx->lock_object.lo_name, slocked ? "share " : "", 11984e7f640dSJohn Baldwin file, line); 11994e7f640dSJohn Baldwin 12004e7f640dSJohn Baldwin if (!(sx->sx_lock & SX_LOCK_SHARED)) { 12014e7f640dSJohn Baldwin if (sx_recursed(sx)) { 12027ec137e5SJohn Baldwin if (what & SA_NOTRECURSED) 12034e7f640dSJohn Baldwin panic("Lock %s recursed @ %s:%d\n", 12044e7f640dSJohn Baldwin sx->lock_object.lo_name, file, 12054e7f640dSJohn Baldwin line); 12067ec137e5SJohn Baldwin } else if (what & SA_RECURSED) 12074e7f640dSJohn Baldwin panic("Lock %s not recursed @ %s:%d\n", 12084e7f640dSJohn Baldwin sx->lock_object.lo_name, file, line); 12094e7f640dSJohn Baldwin } 12104e5e677bSJohn Baldwin #endif 12114e5e677bSJohn Baldwin break; 12127ec137e5SJohn Baldwin case SA_XLOCKED: 12137ec137e5SJohn Baldwin case SA_XLOCKED | SA_NOTRECURSED: 12147ec137e5SJohn Baldwin case SA_XLOCKED | SA_RECURSED: 12154e7f640dSJohn Baldwin if (sx_xholder(sx) != curthread) 121603129ba9SJohn Baldwin panic("Lock %s not exclusively locked @ %s:%d\n", 1217aa89d8cdSJohn Baldwin sx->lock_object.lo_name, file, line); 12184e7f640dSJohn Baldwin if (sx_recursed(sx)) { 12197ec137e5SJohn Baldwin if (what & SA_NOTRECURSED) 12204e7f640dSJohn Baldwin panic("Lock %s recursed @ %s:%d\n", 12214e7f640dSJohn Baldwin sx->lock_object.lo_name, file, line); 12227ec137e5SJohn Baldwin } else if (what & SA_RECURSED) 12234e7f640dSJohn Baldwin panic("Lock %s not recursed @ %s:%d\n", 12244e7f640dSJohn Baldwin sx->lock_object.lo_name, file, line); 12254e5e677bSJohn Baldwin break; 12267ec137e5SJohn Baldwin case SA_UNLOCKED: 122719b0efd3SPawel Jakub Dawidek #ifdef WITNESS 1228aa89d8cdSJohn Baldwin witness_assert(&sx->lock_object, what, file, line); 122919b0efd3SPawel Jakub Dawidek #else 1230f6739b1dSPawel Jakub Dawidek /* 12314e7f640dSJohn Baldwin * If we hold an exclusve lock fail. We can't 12324e7f640dSJohn Baldwin * reliably check to see if we hold a shared lock or 12334e7f640dSJohn Baldwin * not. 1234f6739b1dSPawel Jakub Dawidek */ 12354e7f640dSJohn Baldwin if (sx_xholder(sx) == curthread) 123603129ba9SJohn Baldwin panic("Lock %s exclusively locked @ %s:%d\n", 1237aa89d8cdSJohn Baldwin sx->lock_object.lo_name, file, line); 123819b0efd3SPawel Jakub Dawidek #endif 123919b0efd3SPawel Jakub Dawidek break; 12404e5e677bSJohn Baldwin default: 12414e5e677bSJohn Baldwin panic("Unknown sx lock assertion: %d @ %s:%d", what, file, 12424e5e677bSJohn Baldwin line); 12434e5e677bSJohn Baldwin } 12444e5e677bSJohn Baldwin } 12454e5e677bSJohn Baldwin #endif /* INVARIANT_SUPPORT */ 1246d272fe53SJohn Baldwin 1247d272fe53SJohn Baldwin #ifdef DDB 12484e7f640dSJohn Baldwin static void 1249d576deedSPawel Jakub Dawidek db_show_sx(const struct lock_object *lock) 1250d272fe53SJohn Baldwin { 1251d272fe53SJohn Baldwin struct thread *td; 1252d576deedSPawel Jakub Dawidek const struct sx *sx; 1253d272fe53SJohn Baldwin 1254d576deedSPawel Jakub Dawidek sx = (const struct sx *)lock; 1255d272fe53SJohn Baldwin 1256d272fe53SJohn Baldwin db_printf(" state: "); 12574e7f640dSJohn Baldwin if (sx->sx_lock == SX_LOCK_UNLOCKED) 12584e7f640dSJohn Baldwin db_printf("UNLOCKED\n"); 12590026c92cSJohn Baldwin else if (sx->sx_lock == SX_LOCK_DESTROYED) { 12600026c92cSJohn Baldwin db_printf("DESTROYED\n"); 12610026c92cSJohn Baldwin return; 12620026c92cSJohn Baldwin } else if (sx->sx_lock & SX_LOCK_SHARED) 12634e7f640dSJohn Baldwin db_printf("SLOCK: %ju\n", (uintmax_t)SX_SHARERS(sx->sx_lock)); 12644e7f640dSJohn Baldwin else { 12654e7f640dSJohn Baldwin td = sx_xholder(sx); 1266d272fe53SJohn Baldwin db_printf("XLOCK: %p (tid %d, pid %d, \"%s\")\n", td, 1267431f8906SJulian Elischer td->td_tid, td->td_proc->p_pid, td->td_name); 12684e7f640dSJohn Baldwin if (sx_recursed(sx)) 12694e7f640dSJohn Baldwin db_printf(" recursed: %d\n", sx->sx_recurse); 12704e7f640dSJohn Baldwin } 12714e7f640dSJohn Baldwin 12724e7f640dSJohn Baldwin db_printf(" waiters: "); 12734e7f640dSJohn Baldwin switch(sx->sx_lock & 12744e7f640dSJohn Baldwin (SX_LOCK_SHARED_WAITERS | SX_LOCK_EXCLUSIVE_WAITERS)) { 12754e7f640dSJohn Baldwin case SX_LOCK_SHARED_WAITERS: 12764e7f640dSJohn Baldwin db_printf("shared\n"); 12774e7f640dSJohn Baldwin break; 12784e7f640dSJohn Baldwin case SX_LOCK_EXCLUSIVE_WAITERS: 12794e7f640dSJohn Baldwin db_printf("exclusive\n"); 12804e7f640dSJohn Baldwin break; 12814e7f640dSJohn Baldwin case SX_LOCK_SHARED_WAITERS | SX_LOCK_EXCLUSIVE_WAITERS: 12824e7f640dSJohn Baldwin db_printf("exclusive and shared\n"); 12834e7f640dSJohn Baldwin break; 12844e7f640dSJohn Baldwin default: 12854e7f640dSJohn Baldwin db_printf("none\n"); 12864e7f640dSJohn Baldwin } 1287d272fe53SJohn Baldwin } 1288462a7addSJohn Baldwin 1289462a7addSJohn Baldwin /* 1290462a7addSJohn Baldwin * Check to see if a thread that is blocked on a sleep queue is actually 1291462a7addSJohn Baldwin * blocked on an sx lock. If so, output some details and return true. 1292462a7addSJohn Baldwin * If the lock has an exclusive owner, return that in *ownerp. 1293462a7addSJohn Baldwin */ 1294462a7addSJohn Baldwin int 1295462a7addSJohn Baldwin sx_chain(struct thread *td, struct thread **ownerp) 1296462a7addSJohn Baldwin { 1297462a7addSJohn Baldwin struct sx *sx; 1298462a7addSJohn Baldwin 1299462a7addSJohn Baldwin /* 13004e7f640dSJohn Baldwin * Check to see if this thread is blocked on an sx lock. 13014e7f640dSJohn Baldwin * First, we check the lock class. If that is ok, then we 13024e7f640dSJohn Baldwin * compare the lock name against the wait message. 1303462a7addSJohn Baldwin */ 13044e7f640dSJohn Baldwin sx = td->td_wchan; 13054e7f640dSJohn Baldwin if (LOCK_CLASS(&sx->lock_object) != &lock_class_sx || 13064e7f640dSJohn Baldwin sx->lock_object.lo_name != td->td_wmesg) 1307462a7addSJohn Baldwin return (0); 1308462a7addSJohn Baldwin 1309462a7addSJohn Baldwin /* We think we have an sx lock, so output some details. */ 1310462a7addSJohn Baldwin db_printf("blocked on sx \"%s\" ", td->td_wmesg); 13114e7f640dSJohn Baldwin *ownerp = sx_xholder(sx); 13124e7f640dSJohn Baldwin if (sx->sx_lock & SX_LOCK_SHARED) 13134e7f640dSJohn Baldwin db_printf("SLOCK (count %ju)\n", 13144e7f640dSJohn Baldwin (uintmax_t)SX_SHARERS(sx->sx_lock)); 13154e7f640dSJohn Baldwin else 1316462a7addSJohn Baldwin db_printf("XLOCK\n"); 1317462a7addSJohn Baldwin return (1); 1318462a7addSJohn Baldwin } 1319d272fe53SJohn Baldwin #endif 1320