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 15129051116SMateusz Guzik static struct lock_delay_config __read_mostly sx_delay = { 1521ada9041SMateusz Guzik .initial = 1000, 1531ada9041SMateusz Guzik .step = 500, 1541ada9041SMateusz Guzik .min = 100, 1551ada9041SMateusz Guzik .max = 5000, 1561ada9041SMateusz Guzik }; 1571ada9041SMateusz Guzik 1581ada9041SMateusz Guzik SYSCTL_INT(_debug_sx, OID_AUTO, delay_initial, CTLFLAG_RW, &sx_delay.initial, 1591ada9041SMateusz Guzik 0, ""); 1601ada9041SMateusz Guzik SYSCTL_INT(_debug_sx, OID_AUTO, delay_step, CTLFLAG_RW, &sx_delay.step, 1611ada9041SMateusz Guzik 0, ""); 1621ada9041SMateusz Guzik SYSCTL_INT(_debug_sx, OID_AUTO, delay_min, CTLFLAG_RW, &sx_delay.min, 1631ada9041SMateusz Guzik 0, ""); 1641ada9041SMateusz Guzik SYSCTL_INT(_debug_sx, OID_AUTO, delay_max, CTLFLAG_RW, &sx_delay.max, 1651ada9041SMateusz Guzik 0, ""); 1661ada9041SMateusz Guzik 1671ada9041SMateusz Guzik static void 1681ada9041SMateusz Guzik sx_delay_sysinit(void *dummy) 1691ada9041SMateusz Guzik { 1701ada9041SMateusz Guzik 1711ada9041SMateusz Guzik sx_delay.initial = mp_ncpus * 25; 1721ada9041SMateusz Guzik sx_delay.step = (mp_ncpus * 25) / 2; 1731ada9041SMateusz Guzik sx_delay.min = mp_ncpus * 5; 1741ada9041SMateusz Guzik sx_delay.max = mp_ncpus * 25 * 10; 1751ada9041SMateusz Guzik } 1761ada9041SMateusz Guzik LOCK_DELAY_SYSINIT(sx_delay_sysinit); 1771ae1c2a3SAttilio Rao #endif 1781ae1c2a3SAttilio Rao 1796281b30aSJason Evans void 180d576deedSPawel Jakub Dawidek assert_sx(const struct lock_object *lock, int what) 181f9721b43SAttilio Rao { 182f9721b43SAttilio Rao 183d576deedSPawel Jakub Dawidek sx_assert((const struct sx *)lock, what); 184f9721b43SAttilio Rao } 185f9721b43SAttilio Rao 186f9721b43SAttilio Rao void 1877faf4d90SDavide Italiano lock_sx(struct lock_object *lock, uintptr_t how) 1886e21afd4SJohn Baldwin { 1896e21afd4SJohn Baldwin struct sx *sx; 1906e21afd4SJohn Baldwin 1916e21afd4SJohn Baldwin sx = (struct sx *)lock; 1926e21afd4SJohn Baldwin if (how) 1936e21afd4SJohn Baldwin sx_slock(sx); 194cf6b879fSDavide Italiano else 195cf6b879fSDavide Italiano sx_xlock(sx); 1966e21afd4SJohn Baldwin } 1976e21afd4SJohn Baldwin 1987faf4d90SDavide Italiano uintptr_t 1996e21afd4SJohn Baldwin unlock_sx(struct lock_object *lock) 2006e21afd4SJohn Baldwin { 2016e21afd4SJohn Baldwin struct sx *sx; 2026e21afd4SJohn Baldwin 2036e21afd4SJohn Baldwin sx = (struct sx *)lock; 2047ec137e5SJohn Baldwin sx_assert(sx, SA_LOCKED | SA_NOTRECURSED); 2056e21afd4SJohn Baldwin if (sx_xlocked(sx)) { 2066e21afd4SJohn Baldwin sx_xunlock(sx); 207cf6b879fSDavide Italiano return (0); 2086e21afd4SJohn Baldwin } else { 2096e21afd4SJohn Baldwin sx_sunlock(sx); 210cf6b879fSDavide Italiano return (1); 2116e21afd4SJohn Baldwin } 2126e21afd4SJohn Baldwin } 2136e21afd4SJohn Baldwin 214a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 215a5aedd68SStacey Son int 216d576deedSPawel Jakub Dawidek owner_sx(const struct lock_object *lock, struct thread **owner) 217a5aedd68SStacey Son { 218c365a293SMark Johnston const struct sx *sx; 219c365a293SMark Johnston uintptr_t x; 220a5aedd68SStacey Son 221c365a293SMark Johnston sx = (const struct sx *)lock; 222c365a293SMark Johnston x = sx->sx_lock; 223c365a293SMark Johnston *owner = NULL; 224a5aedd68SStacey Son return ((x & SX_LOCK_SHARED) != 0 ? (SX_SHARERS(x) != 0) : 225c365a293SMark Johnston ((*owner = (struct thread *)SX_OWNER(x)) != NULL)); 226a5aedd68SStacey Son } 227a5aedd68SStacey Son #endif 228a5aedd68SStacey Son 2296e21afd4SJohn Baldwin void 230c27b5699SAndrew R. Reiter sx_sysinit(void *arg) 231c27b5699SAndrew R. Reiter { 232c27b5699SAndrew R. Reiter struct sx_args *sargs = arg; 233c27b5699SAndrew R. Reiter 234e4cd31ddSJeff Roberson sx_init_flags(sargs->sa_sx, sargs->sa_desc, sargs->sa_flags); 235c27b5699SAndrew R. Reiter } 236c27b5699SAndrew R. Reiter 237c27b5699SAndrew R. Reiter void 2384e7f640dSJohn Baldwin sx_init_flags(struct sx *sx, const char *description, int opts) 2396281b30aSJason Evans { 2404e7f640dSJohn Baldwin int flags; 2416281b30aSJason Evans 242b0d67325SJohn Baldwin MPASS((opts & ~(SX_QUIET | SX_RECURSE | SX_NOWITNESS | SX_DUPOK | 243fd07ddcfSDmitry Chagin SX_NOPROFILE | SX_NOADAPTIVE | SX_NEW)) == 0); 244353998acSAttilio Rao ASSERT_ATOMIC_LOAD_PTR(sx->sx_lock, 245353998acSAttilio Rao ("%s: sx_lock not aligned for %s: %p", __func__, description, 246353998acSAttilio Rao &sx->sx_lock)); 247b0d67325SJohn Baldwin 248f0830182SAttilio Rao flags = LO_SLEEPABLE | LO_UPGRADABLE; 2494e7f640dSJohn Baldwin if (opts & SX_DUPOK) 2504e7f640dSJohn Baldwin flags |= LO_DUPOK; 2514e7f640dSJohn Baldwin if (opts & SX_NOPROFILE) 2524e7f640dSJohn Baldwin flags |= LO_NOPROFILE; 2534e7f640dSJohn Baldwin if (!(opts & SX_NOWITNESS)) 2544e7f640dSJohn Baldwin flags |= LO_WITNESS; 255f0830182SAttilio Rao if (opts & SX_RECURSE) 256f0830182SAttilio Rao flags |= LO_RECURSABLE; 2574e7f640dSJohn Baldwin if (opts & SX_QUIET) 2584e7f640dSJohn Baldwin flags |= LO_QUIET; 259fd07ddcfSDmitry Chagin if (opts & SX_NEW) 260fd07ddcfSDmitry Chagin flags |= LO_NEW; 2614e7f640dSJohn Baldwin 262f0830182SAttilio Rao flags |= opts & SX_NOADAPTIVE; 263b5fb43e5SJohn Baldwin lock_init(&sx->lock_object, &lock_class_sx, description, NULL, flags); 2644e7f640dSJohn Baldwin sx->sx_lock = SX_LOCK_UNLOCKED; 2654e7f640dSJohn Baldwin sx->sx_recurse = 0; 2666281b30aSJason Evans } 2676281b30aSJason Evans 2686281b30aSJason Evans void 2696281b30aSJason Evans sx_destroy(struct sx *sx) 2706281b30aSJason Evans { 2716281b30aSJason Evans 2724e7f640dSJohn Baldwin KASSERT(sx->sx_lock == SX_LOCK_UNLOCKED, ("sx lock still held")); 2734e7f640dSJohn Baldwin KASSERT(sx->sx_recurse == 0, ("sx lock still recursed")); 2740026c92cSJohn Baldwin sx->sx_lock = SX_LOCK_DESTROYED; 275aa89d8cdSJohn Baldwin lock_destroy(&sx->lock_object); 2766281b30aSJason Evans } 2776281b30aSJason Evans 278f9819486SAttilio Rao int 279f9819486SAttilio Rao _sx_slock(struct sx *sx, int opts, const char *file, int line) 2806281b30aSJason Evans { 281f9819486SAttilio Rao int error = 0; 2826281b30aSJason Evans 28335370593SAndriy Gapon if (SCHEDULER_STOPPED()) 28435370593SAndriy Gapon return (0); 285cd2fe4e6SAttilio Rao KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 286e3ae0dfeSAttilio Rao ("sx_slock() by idle thread %p on sx %s @ %s:%d", 287e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 2880026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 2890026c92cSJohn Baldwin ("sx_slock() of destroyed sx @ %s:%d", file, line)); 29041313430SJohn Baldwin WITNESS_CHECKORDER(&sx->lock_object, LOP_NEWORDER, file, line, NULL); 291f9819486SAttilio Rao error = __sx_slock(sx, opts, file, line); 292f9819486SAttilio Rao if (!error) { 293aa89d8cdSJohn Baldwin LOCK_LOG_LOCK("SLOCK", &sx->lock_object, 0, 0, file, line); 294aa89d8cdSJohn Baldwin WITNESS_LOCK(&sx->lock_object, 0, file, line); 295ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 2966281b30aSJason Evans } 2976281b30aSJason Evans 298f9819486SAttilio Rao return (error); 299f9819486SAttilio Rao } 300f9819486SAttilio Rao 3015f36700aSJohn Baldwin int 3029fde98bbSAttilio Rao sx_try_slock_(struct sx *sx, const char *file, int line) 3035f36700aSJohn Baldwin { 3044e7f640dSJohn Baldwin uintptr_t x; 3055f36700aSJohn Baldwin 30635370593SAndriy Gapon if (SCHEDULER_STOPPED()) 30735370593SAndriy Gapon return (1); 30835370593SAndriy Gapon 309cd2fe4e6SAttilio Rao KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 310e3ae0dfeSAttilio Rao ("sx_try_slock() by idle thread %p on sx %s @ %s:%d", 311e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 312e3ae0dfeSAttilio Rao 313764a938bSPawel Jakub Dawidek for (;;) { 3144e7f640dSJohn Baldwin x = sx->sx_lock; 3150026c92cSJohn Baldwin KASSERT(x != SX_LOCK_DESTROYED, 3160026c92cSJohn Baldwin ("sx_try_slock() of destroyed sx @ %s:%d", file, line)); 317764a938bSPawel Jakub Dawidek if (!(x & SX_LOCK_SHARED)) 318764a938bSPawel Jakub Dawidek break; 319764a938bSPawel Jakub Dawidek if (atomic_cmpset_acq_ptr(&sx->sx_lock, x, x + SX_ONE_SHARER)) { 320aa89d8cdSJohn Baldwin LOCK_LOG_TRY("SLOCK", &sx->lock_object, 0, 1, file, line); 321aa89d8cdSJohn Baldwin WITNESS_LOCK(&sx->lock_object, LOP_TRYLOCK, file, line); 322de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, 323de2c95ccSMark Johnston sx, 0, 0, file, line, LOCKSTAT_READER); 324ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 3255f36700aSJohn Baldwin return (1); 3265f36700aSJohn Baldwin } 327764a938bSPawel Jakub Dawidek } 3284e7f640dSJohn Baldwin 3294e7f640dSJohn Baldwin LOCK_LOG_TRY("SLOCK", &sx->lock_object, 0, 0, file, line); 3304e7f640dSJohn Baldwin return (0); 3315f36700aSJohn Baldwin } 3325f36700aSJohn Baldwin 333f9819486SAttilio Rao int 334f9819486SAttilio Rao _sx_xlock(struct sx *sx, int opts, const char *file, int line) 3356281b30aSJason Evans { 336f9819486SAttilio Rao int error = 0; 3376281b30aSJason Evans 33835370593SAndriy Gapon if (SCHEDULER_STOPPED()) 33935370593SAndriy Gapon return (0); 340cd2fe4e6SAttilio Rao KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 341e3ae0dfeSAttilio Rao ("sx_xlock() by idle thread %p on sx %s @ %s:%d", 342e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 3430026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 3440026c92cSJohn Baldwin ("sx_xlock() of destroyed sx @ %s:%d", file, line)); 345aa89d8cdSJohn Baldwin WITNESS_CHECKORDER(&sx->lock_object, LOP_NEWORDER | LOP_EXCLUSIVE, file, 34641313430SJohn Baldwin line, NULL); 347f9819486SAttilio Rao error = __sx_xlock(sx, curthread, opts, file, line); 348f9819486SAttilio Rao if (!error) { 349f9819486SAttilio Rao LOCK_LOG_LOCK("XLOCK", &sx->lock_object, 0, sx->sx_recurse, 350f9819486SAttilio Rao file, line); 351aa89d8cdSJohn Baldwin WITNESS_LOCK(&sx->lock_object, LOP_EXCLUSIVE, file, line); 352ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 3536281b30aSJason Evans } 3546281b30aSJason Evans 355f9819486SAttilio Rao return (error); 356f9819486SAttilio Rao } 357f9819486SAttilio Rao 3585f36700aSJohn Baldwin int 3599fde98bbSAttilio Rao sx_try_xlock_(struct sx *sx, const char *file, int line) 3605f36700aSJohn Baldwin { 3614e7f640dSJohn Baldwin int rval; 3625f36700aSJohn Baldwin 36335370593SAndriy Gapon if (SCHEDULER_STOPPED()) 36435370593SAndriy Gapon return (1); 36535370593SAndriy Gapon 366cd2fe4e6SAttilio Rao KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 367e3ae0dfeSAttilio Rao ("sx_try_xlock() by idle thread %p on sx %s @ %s:%d", 368e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 3690026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 3700026c92cSJohn Baldwin ("sx_try_xlock() of destroyed sx @ %s:%d", file, line)); 3714e7f640dSJohn Baldwin 372f0830182SAttilio Rao if (sx_xlocked(sx) && 373f0830182SAttilio Rao (sx->lock_object.lo_flags & LO_RECURSABLE) != 0) { 3744e7f640dSJohn Baldwin sx->sx_recurse++; 3754e7f640dSJohn Baldwin atomic_set_ptr(&sx->sx_lock, SX_LOCK_RECURSED); 3764e7f640dSJohn Baldwin rval = 1; 3774e7f640dSJohn Baldwin } else 3784e7f640dSJohn Baldwin rval = atomic_cmpset_acq_ptr(&sx->sx_lock, SX_LOCK_UNLOCKED, 3794e7f640dSJohn Baldwin (uintptr_t)curthread); 3804e7f640dSJohn Baldwin LOCK_LOG_TRY("XLOCK", &sx->lock_object, 0, rval, file, line); 3814e7f640dSJohn Baldwin if (rval) { 3824e7f640dSJohn Baldwin WITNESS_LOCK(&sx->lock_object, LOP_EXCLUSIVE | LOP_TRYLOCK, 3834e7f640dSJohn Baldwin file, line); 384076dd8ebSAndriy Gapon if (!sx_recursed(sx)) 385de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, 386de2c95ccSMark Johnston sx, 0, 0, file, line, LOCKSTAT_WRITER); 387ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 3885f36700aSJohn Baldwin } 3894e7f640dSJohn Baldwin 3904e7f640dSJohn Baldwin return (rval); 3915f36700aSJohn Baldwin } 3925f36700aSJohn Baldwin 3936281b30aSJason Evans void 39419284646SJohn Baldwin _sx_sunlock(struct sx *sx, const char *file, int line) 3956281b30aSJason Evans { 3966281b30aSJason Evans 39735370593SAndriy Gapon if (SCHEDULER_STOPPED()) 39835370593SAndriy Gapon return; 3990026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 4000026c92cSJohn Baldwin ("sx_sunlock() of destroyed sx @ %s:%d", file, line)); 4017ec137e5SJohn Baldwin _sx_assert(sx, SA_SLOCKED, file, line); 402aa89d8cdSJohn Baldwin WITNESS_UNLOCK(&sx->lock_object, 0, file, line); 403aa89d8cdSJohn Baldwin LOCK_LOG_LOCK("SUNLOCK", &sx->lock_object, 0, 0, file, line); 4044e7f640dSJohn Baldwin __sx_sunlock(sx, file, line); 405ce1c953eSMark Johnston TD_LOCKS_DEC(curthread); 4066281b30aSJason Evans } 4076281b30aSJason Evans 4086281b30aSJason Evans void 40919284646SJohn Baldwin _sx_xunlock(struct sx *sx, const char *file, int line) 4106281b30aSJason Evans { 4116281b30aSJason Evans 41235370593SAndriy Gapon if (SCHEDULER_STOPPED()) 41335370593SAndriy Gapon return; 4140026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 4150026c92cSJohn Baldwin ("sx_xunlock() of destroyed sx @ %s:%d", file, line)); 4167ec137e5SJohn Baldwin _sx_assert(sx, SA_XLOCKED, file, line); 417aa89d8cdSJohn Baldwin WITNESS_UNLOCK(&sx->lock_object, LOP_EXCLUSIVE, file, line); 4184e7f640dSJohn Baldwin LOCK_LOG_LOCK("XUNLOCK", &sx->lock_object, 0, sx->sx_recurse, file, 4194e7f640dSJohn Baldwin line); 4204e7f640dSJohn Baldwin __sx_xunlock(sx, curthread, file, line); 421ce1c953eSMark Johnston TD_LOCKS_DEC(curthread); 4226281b30aSJason Evans } 423d55229b7SJason Evans 4244e7f640dSJohn Baldwin /* 4254e7f640dSJohn Baldwin * Try to do a non-blocking upgrade from a shared lock to an exclusive lock. 4264e7f640dSJohn Baldwin * This will only succeed if this thread holds a single shared lock. 4274e7f640dSJohn Baldwin * Return 1 if if the upgrade succeed, 0 otherwise. 4284e7f640dSJohn Baldwin */ 429d55229b7SJason Evans int 4309fde98bbSAttilio Rao sx_try_upgrade_(struct sx *sx, const char *file, int line) 431d55229b7SJason Evans { 4324e7f640dSJohn Baldwin uintptr_t x; 4334e7f640dSJohn Baldwin int success; 434d55229b7SJason Evans 43535370593SAndriy Gapon if (SCHEDULER_STOPPED()) 43635370593SAndriy Gapon return (1); 43735370593SAndriy Gapon 4380026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 4390026c92cSJohn Baldwin ("sx_try_upgrade() of destroyed sx @ %s:%d", file, line)); 4407ec137e5SJohn Baldwin _sx_assert(sx, SA_SLOCKED, file, line); 441d55229b7SJason Evans 4424e7f640dSJohn Baldwin /* 4434e7f640dSJohn Baldwin * Try to switch from one shared lock to an exclusive lock. We need 4444e7f640dSJohn Baldwin * to maintain the SX_LOCK_EXCLUSIVE_WAITERS flag if set so that 4454e7f640dSJohn Baldwin * we will wake up the exclusive waiters when we drop the lock. 4464e7f640dSJohn Baldwin */ 4474e7f640dSJohn Baldwin x = sx->sx_lock & SX_LOCK_EXCLUSIVE_WAITERS; 4484e7f640dSJohn Baldwin success = atomic_cmpset_ptr(&sx->sx_lock, SX_SHARERS_LOCK(1) | x, 4494e7f640dSJohn Baldwin (uintptr_t)curthread | x); 4504e7f640dSJohn Baldwin LOCK_LOG_TRY("XUPGRADE", &sx->lock_object, 0, success, file, line); 451a5aedd68SStacey Son if (success) { 452aa89d8cdSJohn Baldwin WITNESS_UPGRADE(&sx->lock_object, LOP_EXCLUSIVE | LOP_TRYLOCK, 453b0b7cb50SJohn Baldwin file, line); 45432cd0147SMark Johnston LOCKSTAT_RECORD0(sx__upgrade, sx); 455a5aedd68SStacey Son } 4564e7f640dSJohn Baldwin return (success); 457d55229b7SJason Evans } 458d55229b7SJason Evans 4594e7f640dSJohn Baldwin /* 4604e7f640dSJohn Baldwin * Downgrade an unrecursed exclusive lock into a single shared lock. 4614e7f640dSJohn Baldwin */ 462d55229b7SJason Evans void 4639fde98bbSAttilio Rao sx_downgrade_(struct sx *sx, const char *file, int line) 464d55229b7SJason Evans { 4654e7f640dSJohn Baldwin uintptr_t x; 466da7bbd2cSJohn Baldwin int wakeup_swapper; 467d55229b7SJason Evans 46835370593SAndriy Gapon if (SCHEDULER_STOPPED()) 46935370593SAndriy Gapon return; 47035370593SAndriy Gapon 4710026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 4720026c92cSJohn Baldwin ("sx_downgrade() of destroyed sx @ %s:%d", file, line)); 4737ec137e5SJohn Baldwin _sx_assert(sx, SA_XLOCKED | SA_NOTRECURSED, file, line); 4744e7f640dSJohn Baldwin #ifndef INVARIANTS 4754e7f640dSJohn Baldwin if (sx_recursed(sx)) 4764e7f640dSJohn Baldwin panic("downgrade of a recursed lock"); 4774e7f640dSJohn Baldwin #endif 478d55229b7SJason Evans 479aa89d8cdSJohn Baldwin WITNESS_DOWNGRADE(&sx->lock_object, 0, file, line); 480d55229b7SJason Evans 4814e7f640dSJohn Baldwin /* 4824e7f640dSJohn Baldwin * Try to switch from an exclusive lock with no shared waiters 4834e7f640dSJohn Baldwin * to one sharer with no shared waiters. If there are 4844e7f640dSJohn Baldwin * exclusive waiters, we don't need to lock the sleep queue so 4854e7f640dSJohn Baldwin * long as we preserve the flag. We do one quick try and if 4864e7f640dSJohn Baldwin * that fails we grab the sleepq lock to keep the flags from 4874e7f640dSJohn Baldwin * changing and do it the slow way. 4884e7f640dSJohn Baldwin * 4894e7f640dSJohn Baldwin * We have to lock the sleep queue if there are shared waiters 4904e7f640dSJohn Baldwin * so we can wake them up. 4914e7f640dSJohn Baldwin */ 4924e7f640dSJohn Baldwin x = sx->sx_lock; 4934e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED_WAITERS) && 4944e7f640dSJohn Baldwin atomic_cmpset_rel_ptr(&sx->sx_lock, x, SX_SHARERS_LOCK(1) | 4954e7f640dSJohn Baldwin (x & SX_LOCK_EXCLUSIVE_WAITERS))) { 4964e7f640dSJohn Baldwin LOCK_LOG_LOCK("XDOWNGRADE", &sx->lock_object, 0, 0, file, line); 4974e7f640dSJohn Baldwin return; 4984e7f640dSJohn Baldwin } 4994e7f640dSJohn Baldwin 5004e7f640dSJohn Baldwin /* 5014e7f640dSJohn Baldwin * Lock the sleep queue so we can read the waiters bits 5024e7f640dSJohn Baldwin * without any races and wakeup any shared waiters. 5034e7f640dSJohn Baldwin */ 5044e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 5054e7f640dSJohn Baldwin 5064e7f640dSJohn Baldwin /* 5074e7f640dSJohn Baldwin * Preserve SX_LOCK_EXCLUSIVE_WAITERS while downgraded to a single 5084e7f640dSJohn Baldwin * shared lock. If there are any shared waiters, wake them up. 5094e7f640dSJohn Baldwin */ 510da7bbd2cSJohn Baldwin wakeup_swapper = 0; 5114e7f640dSJohn Baldwin x = sx->sx_lock; 5124e7f640dSJohn Baldwin atomic_store_rel_ptr(&sx->sx_lock, SX_SHARERS_LOCK(1) | 5134e7f640dSJohn Baldwin (x & SX_LOCK_EXCLUSIVE_WAITERS)); 5144e7f640dSJohn Baldwin if (x & SX_LOCK_SHARED_WAITERS) 515da7bbd2cSJohn Baldwin wakeup_swapper = sleepq_broadcast(&sx->lock_object, SLEEPQ_SX, 516da7bbd2cSJohn Baldwin 0, SQ_SHARED_QUEUE); 5174e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 518d55229b7SJason Evans 519aa89d8cdSJohn Baldwin LOCK_LOG_LOCK("XDOWNGRADE", &sx->lock_object, 0, 0, file, line); 52032cd0147SMark Johnston LOCKSTAT_RECORD0(sx__downgrade, sx); 521da7bbd2cSJohn Baldwin 522da7bbd2cSJohn Baldwin if (wakeup_swapper) 523da7bbd2cSJohn Baldwin kick_proc0(); 5244e7f640dSJohn Baldwin } 525d55229b7SJason Evans 5264e7f640dSJohn Baldwin /* 5274e7f640dSJohn Baldwin * This function represents the so-called 'hard case' for sx_xlock 5284e7f640dSJohn Baldwin * operation. All 'easy case' failures are redirected to this. Note 5294e7f640dSJohn Baldwin * that ideally this would be a static function, but it needs to be 5304e7f640dSJohn Baldwin * accessible from at least sx.h. 5314e7f640dSJohn Baldwin */ 532f9819486SAttilio Rao int 533*fa474043SMateusz Guzik _sx_xlock_hard(struct sx *sx, uintptr_t x, uintptr_t tid, int opts, 534*fa474043SMateusz Guzik const char *file, int line) 5354e7f640dSJohn Baldwin { 5364e7f640dSJohn Baldwin GIANT_DECLARE; 5374e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 5384e7f640dSJohn Baldwin volatile struct thread *owner; 5391ae1c2a3SAttilio Rao u_int i, spintries = 0; 5404e7f640dSJohn Baldwin #endif 5411723a064SJeff Roberson #ifdef LOCK_PROFILING 5421723a064SJeff Roberson uint64_t waittime = 0; 5431723a064SJeff Roberson int contested = 0; 5441723a064SJeff Roberson #endif 5451723a064SJeff Roberson int error = 0; 54604126895SMateusz Guzik #if defined(ADAPTIVE_SX) || defined(KDTRACE_HOOKS) 5471ada9041SMateusz Guzik struct lock_delay_arg lda; 5481ada9041SMateusz Guzik #endif 549a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 550076dd8ebSAndriy Gapon uintptr_t state; 55161852185SMateusz Guzik u_int sleep_cnt = 0; 552a5aedd68SStacey Son int64_t sleep_time = 0; 553076dd8ebSAndriy Gapon int64_t all_time = 0; 554a5aedd68SStacey Son #endif 5554e7f640dSJohn Baldwin 55635370593SAndriy Gapon if (SCHEDULER_STOPPED()) 55735370593SAndriy Gapon return (0); 55835370593SAndriy Gapon 559fa5000a4SMateusz Guzik #if defined(ADAPTIVE_SX) 5601ada9041SMateusz Guzik lock_delay_arg_init(&lda, &sx_delay); 561fa5000a4SMateusz Guzik #elif defined(KDTRACE_HOOKS) 562fa5000a4SMateusz Guzik lock_delay_arg_init(&lda, NULL); 5631ada9041SMateusz Guzik #endif 5641ada9041SMateusz Guzik 5654e7f640dSJohn Baldwin /* If we already hold an exclusive lock, then recurse. */ 566c5f61e6fSMateusz Guzik if (__predict_false(lv_sx_owner(x) == (struct thread *)tid)) { 567f0830182SAttilio Rao KASSERT((sx->lock_object.lo_flags & LO_RECURSABLE) != 0, 568b0d67325SJohn Baldwin ("_sx_xlock_hard: recursed on non-recursive sx %s @ %s:%d\n", 569b0d67325SJohn Baldwin sx->lock_object.lo_name, file, line)); 5704e7f640dSJohn Baldwin sx->sx_recurse++; 5714e7f640dSJohn Baldwin atomic_set_ptr(&sx->sx_lock, SX_LOCK_RECURSED); 5724e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 5734e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p recursing", __func__, sx); 574f9819486SAttilio Rao return (0); 5754e7f640dSJohn Baldwin } 5764e7f640dSJohn Baldwin 5774e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 5784e7f640dSJohn Baldwin CTR5(KTR_LOCK, "%s: %s contested (lock=%p) at %s:%d", __func__, 5794e7f640dSJohn Baldwin sx->lock_object.lo_name, (void *)sx->sx_lock, file, line); 5804e7f640dSJohn Baldwin 581076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 582e2b25737SMark Johnston all_time -= lockstat_nsecs(&sx->lock_object); 583c5f61e6fSMateusz Guzik state = x; 584076dd8ebSAndriy Gapon #endif 585fc4f686dSMateusz Guzik for (;;) { 586c5f61e6fSMateusz Guzik if (x == SX_LOCK_UNLOCKED) { 587*fa474043SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, tid)) 588fc4f686dSMateusz Guzik break; 589c5f61e6fSMateusz Guzik continue; 590c5f61e6fSMateusz Guzik } 591a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 5921ada9041SMateusz Guzik lda.spin_cnt++; 593a5aedd68SStacey Son #endif 594f5f9340bSFabien Thomas #ifdef HWPMC_HOOKS 595f5f9340bSFabien Thomas PMC_SOFT_CALL( , , lock, failed); 596f5f9340bSFabien Thomas #endif 597eea4f254SJeff Roberson lock_profile_obtain_lock_failed(&sx->lock_object, &contested, 598eea4f254SJeff Roberson &waittime); 5994e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 6004e7f640dSJohn Baldwin /* 6014e7f640dSJohn Baldwin * If the lock is write locked and the owner is 6024e7f640dSJohn Baldwin * running on another CPU, spin until the owner stops 6034e7f640dSJohn Baldwin * running or the state of the lock changes. 6044e7f640dSJohn Baldwin */ 6058545538bSJohn Baldwin if ((sx->lock_object.lo_flags & SX_NOADAPTIVE) == 0) { 6061ae1c2a3SAttilio Rao if ((x & SX_LOCK_SHARED) == 0) { 607c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 6084e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 6094e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 6104e7f640dSJohn Baldwin CTR3(KTR_LOCK, 6114e7f640dSJohn Baldwin "%s: spinning on %p held by %p", 6124e7f640dSJohn Baldwin __func__, sx, owner); 6132cba8dd3SJohn Baldwin KTR_STATE1(KTR_SCHED, "thread", 6142cba8dd3SJohn Baldwin sched_tdname(curthread), "spinning", 6152cba8dd3SJohn Baldwin "lockname:\"%s\"", 6162cba8dd3SJohn Baldwin sx->lock_object.lo_name); 6174e7f640dSJohn Baldwin GIANT_SAVE(); 618c5f61e6fSMateusz Guzik do { 6191ada9041SMateusz Guzik lock_delay(&lda); 620c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 621c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 622c5f61e6fSMateusz Guzik } while (owner != NULL && 623c5f61e6fSMateusz Guzik TD_IS_RUNNING(owner)); 6242cba8dd3SJohn Baldwin KTR_STATE0(KTR_SCHED, "thread", 6252cba8dd3SJohn Baldwin sched_tdname(curthread), "running"); 6264e7f640dSJohn Baldwin continue; 6274e7f640dSJohn Baldwin } 6281ae1c2a3SAttilio Rao } else if (SX_SHARERS(x) && spintries < asx_retries) { 6292cba8dd3SJohn Baldwin KTR_STATE1(KTR_SCHED, "thread", 6302cba8dd3SJohn Baldwin sched_tdname(curthread), "spinning", 6312cba8dd3SJohn Baldwin "lockname:\"%s\"", sx->lock_object.lo_name); 6328d3635c4SAttilio Rao GIANT_SAVE(); 6331ae1c2a3SAttilio Rao spintries++; 6341ae1c2a3SAttilio Rao for (i = 0; i < asx_loops; i++) { 6351ae1c2a3SAttilio Rao if (LOCK_LOG_TEST(&sx->lock_object, 0)) 6361ae1c2a3SAttilio Rao CTR4(KTR_LOCK, 6371ae1c2a3SAttilio Rao "%s: shared spinning on %p with %u and %u", 6381ae1c2a3SAttilio Rao __func__, sx, spintries, i); 6391ae1c2a3SAttilio Rao x = sx->sx_lock; 6401ae1c2a3SAttilio Rao if ((x & SX_LOCK_SHARED) == 0 || 6411ae1c2a3SAttilio Rao SX_SHARERS(x) == 0) 6421ae1c2a3SAttilio Rao break; 6431ae1c2a3SAttilio Rao cpu_spinwait(); 6441ae1c2a3SAttilio Rao #ifdef KDTRACE_HOOKS 6451ada9041SMateusz Guzik lda.spin_cnt++; 6461ae1c2a3SAttilio Rao #endif 6471ae1c2a3SAttilio Rao } 6482cba8dd3SJohn Baldwin KTR_STATE0(KTR_SCHED, "thread", 6492cba8dd3SJohn Baldwin sched_tdname(curthread), "running"); 650c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 6511ae1c2a3SAttilio Rao if (i != asx_loops) 6521ae1c2a3SAttilio Rao continue; 6531ae1c2a3SAttilio Rao } 6544e7f640dSJohn Baldwin } 6554e7f640dSJohn Baldwin #endif 6564e7f640dSJohn Baldwin 6574e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 658c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 6594e7f640dSJohn Baldwin 6604e7f640dSJohn Baldwin /* 6614e7f640dSJohn Baldwin * If the lock was released while spinning on the 6624e7f640dSJohn Baldwin * sleep queue chain lock, try again. 6634e7f640dSJohn Baldwin */ 6644e7f640dSJohn Baldwin if (x == SX_LOCK_UNLOCKED) { 6654e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 6664e7f640dSJohn Baldwin continue; 6674e7f640dSJohn Baldwin } 6684e7f640dSJohn Baldwin 6694e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 6704e7f640dSJohn Baldwin /* 6714e7f640dSJohn Baldwin * The current lock owner might have started executing 6724e7f640dSJohn Baldwin * on another CPU (or the lock could have changed 6734e7f640dSJohn Baldwin * owners) while we were waiting on the sleep queue 6744e7f640dSJohn Baldwin * chain lock. If so, drop the sleep queue lock and try 6754e7f640dSJohn Baldwin * again. 6764e7f640dSJohn Baldwin */ 6774e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED) && 6781ae1c2a3SAttilio Rao (sx->lock_object.lo_flags & SX_NOADAPTIVE) == 0) { 6794e7f640dSJohn Baldwin owner = (struct thread *)SX_OWNER(x); 6804e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 6814e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 6824e7f640dSJohn Baldwin continue; 6834e7f640dSJohn Baldwin } 6844e7f640dSJohn Baldwin } 6854e7f640dSJohn Baldwin #endif 6864e7f640dSJohn Baldwin 6874e7f640dSJohn Baldwin /* 6884e7f640dSJohn Baldwin * If an exclusive lock was released with both shared 6894e7f640dSJohn Baldwin * and exclusive waiters and a shared waiter hasn't 6904e7f640dSJohn Baldwin * woken up and acquired the lock yet, sx_lock will be 6914e7f640dSJohn Baldwin * set to SX_LOCK_UNLOCKED | SX_LOCK_EXCLUSIVE_WAITERS. 6924e7f640dSJohn Baldwin * If we see that value, try to acquire it once. Note 6934e7f640dSJohn Baldwin * that we have to preserve SX_LOCK_EXCLUSIVE_WAITERS 6944e7f640dSJohn Baldwin * as there are other exclusive waiters still. If we 6954e7f640dSJohn Baldwin * fail, restart the loop. 6964e7f640dSJohn Baldwin */ 6974e7f640dSJohn Baldwin if (x == (SX_LOCK_UNLOCKED | SX_LOCK_EXCLUSIVE_WAITERS)) { 6984e7f640dSJohn Baldwin if (atomic_cmpset_acq_ptr(&sx->sx_lock, 6994e7f640dSJohn Baldwin SX_LOCK_UNLOCKED | SX_LOCK_EXCLUSIVE_WAITERS, 7004e7f640dSJohn Baldwin tid | SX_LOCK_EXCLUSIVE_WAITERS)) { 7014e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 7024e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p claimed by new writer", 7034e7f640dSJohn Baldwin __func__, sx); 7044e7f640dSJohn Baldwin break; 7054e7f640dSJohn Baldwin } 7064e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 707c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 7084e7f640dSJohn Baldwin continue; 7094e7f640dSJohn Baldwin } 7104e7f640dSJohn Baldwin 7114e7f640dSJohn Baldwin /* 7124e7f640dSJohn Baldwin * Try to set the SX_LOCK_EXCLUSIVE_WAITERS. If we fail, 7134e7f640dSJohn Baldwin * than loop back and retry. 7144e7f640dSJohn Baldwin */ 7154e7f640dSJohn Baldwin if (!(x & SX_LOCK_EXCLUSIVE_WAITERS)) { 7164e7f640dSJohn Baldwin if (!atomic_cmpset_ptr(&sx->sx_lock, x, 7174e7f640dSJohn Baldwin x | SX_LOCK_EXCLUSIVE_WAITERS)) { 7184e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 719c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 7204e7f640dSJohn Baldwin continue; 7214e7f640dSJohn Baldwin } 7224e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 7234e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p set excl waiters flag", 7244e7f640dSJohn Baldwin __func__, sx); 7254e7f640dSJohn Baldwin } 7264e7f640dSJohn Baldwin 7274e7f640dSJohn Baldwin /* 7284e7f640dSJohn Baldwin * Since we have been unable to acquire the exclusive 7294e7f640dSJohn Baldwin * lock and the exclusive waiters flag is set, we have 7304e7f640dSJohn Baldwin * to sleep. 7314e7f640dSJohn Baldwin */ 7324e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 7334e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p blocking on sleep queue", 7344e7f640dSJohn Baldwin __func__, sx); 7354e7f640dSJohn Baldwin 736a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 737e2b25737SMark Johnston sleep_time -= lockstat_nsecs(&sx->lock_object); 738a5aedd68SStacey Son #endif 7394e7f640dSJohn Baldwin GIANT_SAVE(); 7404e7f640dSJohn Baldwin sleepq_add(&sx->lock_object, NULL, sx->lock_object.lo_name, 741f9819486SAttilio Rao SLEEPQ_SX | ((opts & SX_INTERRUPTIBLE) ? 742f9819486SAttilio Rao SLEEPQ_INTERRUPTIBLE : 0), SQ_EXCLUSIVE_QUEUE); 743f9819486SAttilio Rao if (!(opts & SX_INTERRUPTIBLE)) 744c5aa6b58SJeff Roberson sleepq_wait(&sx->lock_object, 0); 745f9819486SAttilio Rao else 746c5aa6b58SJeff Roberson error = sleepq_wait_sig(&sx->lock_object, 0); 747a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 748e2b25737SMark Johnston sleep_time += lockstat_nsecs(&sx->lock_object); 749a5aedd68SStacey Son sleep_cnt++; 750a5aedd68SStacey Son #endif 751f9819486SAttilio Rao if (error) { 752f9819486SAttilio Rao if (LOCK_LOG_TEST(&sx->lock_object, 0)) 753f9819486SAttilio Rao CTR2(KTR_LOCK, 754f9819486SAttilio Rao "%s: interruptible sleep by %p suspended by signal", 755f9819486SAttilio Rao __func__, sx); 756f9819486SAttilio Rao break; 757f9819486SAttilio Rao } 7584e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 7594e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p resuming from sleep queue", 7604e7f640dSJohn Baldwin __func__, sx); 761c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 7624e7f640dSJohn Baldwin } 763076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 764e2b25737SMark Johnston all_time += lockstat_nsecs(&sx->lock_object); 765076dd8ebSAndriy Gapon if (sleep_time) 76632cd0147SMark Johnston LOCKSTAT_RECORD4(sx__block, sx, sleep_time, 767076dd8ebSAndriy Gapon LOCKSTAT_WRITER, (state & SX_LOCK_SHARED) == 0, 768076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 7691ada9041SMateusz Guzik if (lda.spin_cnt > sleep_cnt) 77032cd0147SMark Johnston LOCKSTAT_RECORD4(sx__spin, sx, all_time - sleep_time, 771076dd8ebSAndriy Gapon LOCKSTAT_WRITER, (state & SX_LOCK_SHARED) == 0, 772076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 773076dd8ebSAndriy Gapon #endif 774f9819486SAttilio Rao if (!error) 775de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, sx, 776de2c95ccSMark Johnston contested, waittime, file, line, LOCKSTAT_WRITER); 777076dd8ebSAndriy Gapon GIANT_RESTORE(); 778f9819486SAttilio Rao return (error); 7794e7f640dSJohn Baldwin } 7804e7f640dSJohn Baldwin 7814e7f640dSJohn Baldwin /* 7824e7f640dSJohn Baldwin * This function represents the so-called 'hard case' for sx_xunlock 7834e7f640dSJohn Baldwin * operation. All 'easy case' failures are redirected to this. Note 7844e7f640dSJohn Baldwin * that ideally this would be a static function, but it needs to be 7854e7f640dSJohn Baldwin * accessible from at least sx.h. 7864e7f640dSJohn Baldwin */ 7874e7f640dSJohn Baldwin void 7884e7f640dSJohn Baldwin _sx_xunlock_hard(struct sx *sx, uintptr_t tid, const char *file, int line) 7894e7f640dSJohn Baldwin { 7904e7f640dSJohn Baldwin uintptr_t x; 791da7bbd2cSJohn Baldwin int queue, wakeup_swapper; 7924e7f640dSJohn Baldwin 79335370593SAndriy Gapon if (SCHEDULER_STOPPED()) 79435370593SAndriy Gapon return; 79535370593SAndriy Gapon 7964e7f640dSJohn Baldwin MPASS(!(sx->sx_lock & SX_LOCK_SHARED)); 7974e7f640dSJohn Baldwin 7984e7f640dSJohn Baldwin /* If the lock is recursed, then unrecurse one level. */ 7994e7f640dSJohn Baldwin if (sx_xlocked(sx) && sx_recursed(sx)) { 8004e7f640dSJohn Baldwin if ((--sx->sx_recurse) == 0) 8014e7f640dSJohn Baldwin atomic_clear_ptr(&sx->sx_lock, SX_LOCK_RECURSED); 8024e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 8034e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p unrecursing", __func__, sx); 8044e7f640dSJohn Baldwin return; 8054e7f640dSJohn Baldwin } 8064e7f640dSJohn Baldwin MPASS(sx->sx_lock & (SX_LOCK_SHARED_WAITERS | 8074e7f640dSJohn Baldwin SX_LOCK_EXCLUSIVE_WAITERS)); 8084e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 8094e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p contested", __func__, sx); 8104e7f640dSJohn Baldwin 8114e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 8124e7f640dSJohn Baldwin x = SX_LOCK_UNLOCKED; 8134e7f640dSJohn Baldwin 8144e7f640dSJohn Baldwin /* 8154e7f640dSJohn Baldwin * The wake up algorithm here is quite simple and probably not 8164e7f640dSJohn Baldwin * ideal. It gives precedence to shared waiters if they are 8174e7f640dSJohn Baldwin * present. For this condition, we have to preserve the 8184e7f640dSJohn Baldwin * state of the exclusive waiters flag. 8192028867dSAttilio Rao * If interruptible sleeps left the shared queue empty avoid a 8202028867dSAttilio Rao * starvation for the threads sleeping on the exclusive queue by giving 8212028867dSAttilio Rao * them precedence and cleaning up the shared waiters bit anyway. 8224e7f640dSJohn Baldwin */ 8232028867dSAttilio Rao if ((sx->sx_lock & SX_LOCK_SHARED_WAITERS) != 0 && 8242028867dSAttilio Rao sleepq_sleepcnt(&sx->lock_object, SQ_SHARED_QUEUE) != 0) { 8254e7f640dSJohn Baldwin queue = SQ_SHARED_QUEUE; 8264e7f640dSJohn Baldwin x |= (sx->sx_lock & SX_LOCK_EXCLUSIVE_WAITERS); 8274e7f640dSJohn Baldwin } else 8284e7f640dSJohn Baldwin queue = SQ_EXCLUSIVE_QUEUE; 8294e7f640dSJohn Baldwin 8304e7f640dSJohn Baldwin /* Wake up all the waiters for the specific queue. */ 8314e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 8324e7f640dSJohn Baldwin CTR3(KTR_LOCK, "%s: %p waking up all threads on %s queue", 8334e7f640dSJohn Baldwin __func__, sx, queue == SQ_SHARED_QUEUE ? "shared" : 8344e7f640dSJohn Baldwin "exclusive"); 8354e7f640dSJohn Baldwin atomic_store_rel_ptr(&sx->sx_lock, x); 836da7bbd2cSJohn Baldwin wakeup_swapper = sleepq_broadcast(&sx->lock_object, SLEEPQ_SX, 0, 837da7bbd2cSJohn Baldwin queue); 838c5aa6b58SJeff Roberson sleepq_release(&sx->lock_object); 839da7bbd2cSJohn Baldwin if (wakeup_swapper) 840da7bbd2cSJohn Baldwin kick_proc0(); 8414e7f640dSJohn Baldwin } 8424e7f640dSJohn Baldwin 8434e7f640dSJohn Baldwin /* 8444e7f640dSJohn Baldwin * This function represents the so-called 'hard case' for sx_slock 8454e7f640dSJohn Baldwin * operation. All 'easy case' failures are redirected to this. Note 8464e7f640dSJohn Baldwin * that ideally this would be a static function, but it needs to be 8474e7f640dSJohn Baldwin * accessible from at least sx.h. 8484e7f640dSJohn Baldwin */ 849f9819486SAttilio Rao int 850f9819486SAttilio Rao _sx_slock_hard(struct sx *sx, int opts, const char *file, int line) 8514e7f640dSJohn Baldwin { 8524e7f640dSJohn Baldwin GIANT_DECLARE; 8534e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 8544e7f640dSJohn Baldwin volatile struct thread *owner; 8554e7f640dSJohn Baldwin #endif 8561723a064SJeff Roberson #ifdef LOCK_PROFILING 857c1a6d9faSAttilio Rao uint64_t waittime = 0; 858c1a6d9faSAttilio Rao int contested = 0; 8591723a064SJeff Roberson #endif 8604e7f640dSJohn Baldwin uintptr_t x; 861c1a6d9faSAttilio Rao int error = 0; 86204126895SMateusz Guzik #if defined(ADAPTIVE_SX) || defined(KDTRACE_HOOKS) 8631ada9041SMateusz Guzik struct lock_delay_arg lda; 8641ada9041SMateusz Guzik #endif 865a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 866076dd8ebSAndriy Gapon uintptr_t state; 86761852185SMateusz Guzik u_int sleep_cnt = 0; 868a5aedd68SStacey Son int64_t sleep_time = 0; 869076dd8ebSAndriy Gapon int64_t all_time = 0; 870a5aedd68SStacey Son #endif 871c1a6d9faSAttilio Rao 87235370593SAndriy Gapon if (SCHEDULER_STOPPED()) 87335370593SAndriy Gapon return (0); 87435370593SAndriy Gapon 875fa5000a4SMateusz Guzik #if defined(ADAPTIVE_SX) 8761ada9041SMateusz Guzik lock_delay_arg_init(&lda, &sx_delay); 877fa5000a4SMateusz Guzik #elif defined(KDTRACE_HOOKS) 878fa5000a4SMateusz Guzik lock_delay_arg_init(&lda, NULL); 8791ada9041SMateusz Guzik #endif 880076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 881e2b25737SMark Johnston all_time -= lockstat_nsecs(&sx->lock_object); 882076dd8ebSAndriy Gapon #endif 883c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 884c5f61e6fSMateusz Guzik #ifdef KDTRACE_HOOKS 885c5f61e6fSMateusz Guzik state = x; 886c5f61e6fSMateusz Guzik #endif 887076dd8ebSAndriy Gapon 8884e7f640dSJohn Baldwin /* 8894e7f640dSJohn Baldwin * As with rwlocks, we don't make any attempt to try to block 8904e7f640dSJohn Baldwin * shared locks once there is an exclusive waiter. 8914e7f640dSJohn Baldwin */ 8924e7f640dSJohn Baldwin for (;;) { 8934e7f640dSJohn Baldwin /* 8944e7f640dSJohn Baldwin * If no other thread has an exclusive lock then try to bump up 8954e7f640dSJohn Baldwin * the count of sharers. Since we have to preserve the state 8964e7f640dSJohn Baldwin * of SX_LOCK_EXCLUSIVE_WAITERS, if we fail to acquire the 8974e7f640dSJohn Baldwin * shared lock loop back and retry. 8984e7f640dSJohn Baldwin */ 8994e7f640dSJohn Baldwin if (x & SX_LOCK_SHARED) { 9004e7f640dSJohn Baldwin MPASS(!(x & SX_LOCK_SHARED_WAITERS)); 901*fa474043SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, 9024e7f640dSJohn Baldwin x + SX_ONE_SHARER)) { 9034e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 9044e7f640dSJohn Baldwin CTR4(KTR_LOCK, 9054e7f640dSJohn Baldwin "%s: %p succeed %p -> %p", __func__, 9064e7f640dSJohn Baldwin sx, (void *)x, 9074e7f640dSJohn Baldwin (void *)(x + SX_ONE_SHARER)); 9084e7f640dSJohn Baldwin break; 9094e7f640dSJohn Baldwin } 9104e7f640dSJohn Baldwin continue; 9114e7f640dSJohn Baldwin } 912c5f61e6fSMateusz Guzik #ifdef KDTRACE_HOOKS 913c5f61e6fSMateusz Guzik lda.spin_cnt++; 914c5f61e6fSMateusz Guzik #endif 915c5f61e6fSMateusz Guzik 916f5f9340bSFabien Thomas #ifdef HWPMC_HOOKS 917f5f9340bSFabien Thomas PMC_SOFT_CALL( , , lock, failed); 918f5f9340bSFabien Thomas #endif 919eea4f254SJeff Roberson lock_profile_obtain_lock_failed(&sx->lock_object, &contested, 920eea4f254SJeff Roberson &waittime); 9214e7f640dSJohn Baldwin 9224e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 9234e7f640dSJohn Baldwin /* 9244e7f640dSJohn Baldwin * If the owner is running on another CPU, spin until 9254e7f640dSJohn Baldwin * the owner stops running or the state of the lock 9264e7f640dSJohn Baldwin * changes. 9274e7f640dSJohn Baldwin */ 9281ae1c2a3SAttilio Rao if ((sx->lock_object.lo_flags & SX_NOADAPTIVE) == 0) { 929c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 9304e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 9314e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 9324e7f640dSJohn Baldwin CTR3(KTR_LOCK, 9334e7f640dSJohn Baldwin "%s: spinning on %p held by %p", 9344e7f640dSJohn Baldwin __func__, sx, owner); 9352cba8dd3SJohn Baldwin KTR_STATE1(KTR_SCHED, "thread", 9362cba8dd3SJohn Baldwin sched_tdname(curthread), "spinning", 9372cba8dd3SJohn Baldwin "lockname:\"%s\"", sx->lock_object.lo_name); 9384e7f640dSJohn Baldwin GIANT_SAVE(); 939c5f61e6fSMateusz Guzik do { 9401ada9041SMateusz Guzik lock_delay(&lda); 941c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 942c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 943c5f61e6fSMateusz Guzik } while (owner != NULL && TD_IS_RUNNING(owner)); 9442cba8dd3SJohn Baldwin KTR_STATE0(KTR_SCHED, "thread", 9452cba8dd3SJohn Baldwin sched_tdname(curthread), "running"); 9464e7f640dSJohn Baldwin continue; 9474e7f640dSJohn Baldwin } 9484e7f640dSJohn Baldwin } 9494e7f640dSJohn Baldwin #endif 9504e7f640dSJohn Baldwin 9514e7f640dSJohn Baldwin /* 9524e7f640dSJohn Baldwin * Some other thread already has an exclusive lock, so 9534e7f640dSJohn Baldwin * start the process of blocking. 9544e7f640dSJohn Baldwin */ 9554e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 956c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 9574e7f640dSJohn Baldwin 9584e7f640dSJohn Baldwin /* 9594e7f640dSJohn Baldwin * The lock could have been released while we spun. 9604e7f640dSJohn Baldwin * In this case loop back and retry. 9614e7f640dSJohn Baldwin */ 9624e7f640dSJohn Baldwin if (x & SX_LOCK_SHARED) { 9634e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 9644e7f640dSJohn Baldwin continue; 9654e7f640dSJohn Baldwin } 9664e7f640dSJohn Baldwin 9674e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 9684e7f640dSJohn Baldwin /* 9694e7f640dSJohn Baldwin * If the owner is running on another CPU, spin until 9704e7f640dSJohn Baldwin * the owner stops running or the state of the lock 9714e7f640dSJohn Baldwin * changes. 9724e7f640dSJohn Baldwin */ 9734e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED) && 9741ae1c2a3SAttilio Rao (sx->lock_object.lo_flags & SX_NOADAPTIVE) == 0) { 9754e7f640dSJohn Baldwin owner = (struct thread *)SX_OWNER(x); 9764e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 9774e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 978c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 9794e7f640dSJohn Baldwin continue; 9804e7f640dSJohn Baldwin } 9814e7f640dSJohn Baldwin } 9824e7f640dSJohn Baldwin #endif 9834e7f640dSJohn Baldwin 9844e7f640dSJohn Baldwin /* 9854e7f640dSJohn Baldwin * Try to set the SX_LOCK_SHARED_WAITERS flag. If we 9864e7f640dSJohn Baldwin * fail to set it drop the sleep queue lock and loop 9874e7f640dSJohn Baldwin * back. 9884e7f640dSJohn Baldwin */ 9894e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED_WAITERS)) { 9904e7f640dSJohn Baldwin if (!atomic_cmpset_ptr(&sx->sx_lock, x, 9914e7f640dSJohn Baldwin x | SX_LOCK_SHARED_WAITERS)) { 9924e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 993c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 9944e7f640dSJohn Baldwin continue; 9954e7f640dSJohn Baldwin } 9964e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 9974e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p set shared waiters flag", 9984e7f640dSJohn Baldwin __func__, sx); 9994e7f640dSJohn Baldwin } 10004e7f640dSJohn Baldwin 10014e7f640dSJohn Baldwin /* 10024e7f640dSJohn Baldwin * Since we have been unable to acquire the shared lock, 10034e7f640dSJohn Baldwin * we have to sleep. 10044e7f640dSJohn Baldwin */ 10054e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 10064e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p blocking on sleep queue", 10074e7f640dSJohn Baldwin __func__, sx); 10084e7f640dSJohn Baldwin 1009a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 1010e2b25737SMark Johnston sleep_time -= lockstat_nsecs(&sx->lock_object); 1011a5aedd68SStacey Son #endif 10124e7f640dSJohn Baldwin GIANT_SAVE(); 10134e7f640dSJohn Baldwin sleepq_add(&sx->lock_object, NULL, sx->lock_object.lo_name, 1014f9819486SAttilio Rao SLEEPQ_SX | ((opts & SX_INTERRUPTIBLE) ? 1015f9819486SAttilio Rao SLEEPQ_INTERRUPTIBLE : 0), SQ_SHARED_QUEUE); 1016f9819486SAttilio Rao if (!(opts & SX_INTERRUPTIBLE)) 1017c5aa6b58SJeff Roberson sleepq_wait(&sx->lock_object, 0); 1018f9819486SAttilio Rao else 1019c5aa6b58SJeff Roberson error = sleepq_wait_sig(&sx->lock_object, 0); 1020a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 1021e2b25737SMark Johnston sleep_time += lockstat_nsecs(&sx->lock_object); 1022a5aedd68SStacey Son sleep_cnt++; 1023a5aedd68SStacey Son #endif 1024f9819486SAttilio Rao if (error) { 1025f9819486SAttilio Rao if (LOCK_LOG_TEST(&sx->lock_object, 0)) 1026f9819486SAttilio Rao CTR2(KTR_LOCK, 1027f9819486SAttilio Rao "%s: interruptible sleep by %p suspended by signal", 1028f9819486SAttilio Rao __func__, sx); 1029f9819486SAttilio Rao break; 1030f9819486SAttilio Rao } 10314e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 10324e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p resuming from sleep queue", 10334e7f640dSJohn Baldwin __func__, sx); 1034c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 10354e7f640dSJohn Baldwin } 1036076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 1037e2b25737SMark Johnston all_time += lockstat_nsecs(&sx->lock_object); 1038076dd8ebSAndriy Gapon if (sleep_time) 103932cd0147SMark Johnston LOCKSTAT_RECORD4(sx__block, sx, sleep_time, 1040076dd8ebSAndriy Gapon LOCKSTAT_READER, (state & SX_LOCK_SHARED) == 0, 1041076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 10421ada9041SMateusz Guzik if (lda.spin_cnt > sleep_cnt) 104332cd0147SMark Johnston LOCKSTAT_RECORD4(sx__spin, sx, all_time - sleep_time, 1044076dd8ebSAndriy Gapon LOCKSTAT_READER, (state & SX_LOCK_SHARED) == 0, 1045076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 1046076dd8ebSAndriy Gapon #endif 1047eea4f254SJeff Roberson if (error == 0) 1048de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, sx, 1049de2c95ccSMark Johnston contested, waittime, file, line, LOCKSTAT_READER); 10504e7f640dSJohn Baldwin GIANT_RESTORE(); 1051f9819486SAttilio Rao return (error); 10524e7f640dSJohn Baldwin } 10534e7f640dSJohn Baldwin 10544e7f640dSJohn Baldwin /* 10554e7f640dSJohn Baldwin * This function represents the so-called 'hard case' for sx_sunlock 10564e7f640dSJohn Baldwin * operation. All 'easy case' failures are redirected to this. Note 10574e7f640dSJohn Baldwin * that ideally this would be a static function, but it needs to be 10584e7f640dSJohn Baldwin * accessible from at least sx.h. 10594e7f640dSJohn Baldwin */ 10604e7f640dSJohn Baldwin void 10614e7f640dSJohn Baldwin _sx_sunlock_hard(struct sx *sx, const char *file, int line) 10624e7f640dSJohn Baldwin { 10634e7f640dSJohn Baldwin uintptr_t x; 1064da7bbd2cSJohn Baldwin int wakeup_swapper; 10654e7f640dSJohn Baldwin 106635370593SAndriy Gapon if (SCHEDULER_STOPPED()) 106735370593SAndriy Gapon return; 106835370593SAndriy Gapon 1069c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 10704e7f640dSJohn Baldwin for (;;) { 10714e7f640dSJohn Baldwin /* 10724e7f640dSJohn Baldwin * We should never have sharers while at least one thread 10734e7f640dSJohn Baldwin * holds a shared lock. 10744e7f640dSJohn Baldwin */ 10754e7f640dSJohn Baldwin KASSERT(!(x & SX_LOCK_SHARED_WAITERS), 10764e7f640dSJohn Baldwin ("%s: waiting sharers", __func__)); 10774e7f640dSJohn Baldwin 10784e7f640dSJohn Baldwin /* 10794e7f640dSJohn Baldwin * See if there is more than one shared lock held. If 10804e7f640dSJohn Baldwin * so, just drop one and return. 10814e7f640dSJohn Baldwin */ 10824e7f640dSJohn Baldwin if (SX_SHARERS(x) > 1) { 1083*fa474043SMateusz Guzik if (atomic_fcmpset_rel_ptr(&sx->sx_lock, &x, 10844e7f640dSJohn Baldwin x - SX_ONE_SHARER)) { 10854e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 10864e7f640dSJohn Baldwin CTR4(KTR_LOCK, 10874e7f640dSJohn Baldwin "%s: %p succeeded %p -> %p", 10884e7f640dSJohn Baldwin __func__, sx, (void *)x, 10894e7f640dSJohn Baldwin (void *)(x - SX_ONE_SHARER)); 10904e7f640dSJohn Baldwin break; 10914e7f640dSJohn Baldwin } 10924e7f640dSJohn Baldwin continue; 10934e7f640dSJohn Baldwin } 10944e7f640dSJohn Baldwin 10954e7f640dSJohn Baldwin /* 10964e7f640dSJohn Baldwin * If there aren't any waiters for an exclusive lock, 10974e7f640dSJohn Baldwin * then try to drop it quickly. 10984e7f640dSJohn Baldwin */ 10994e7f640dSJohn Baldwin if (!(x & SX_LOCK_EXCLUSIVE_WAITERS)) { 11004e7f640dSJohn Baldwin MPASS(x == SX_SHARERS_LOCK(1)); 1101*fa474043SMateusz Guzik x = SX_SHARERS_LOCK(1); 1102*fa474043SMateusz Guzik if (atomic_fcmpset_rel_ptr(&sx->sx_lock, 1103*fa474043SMateusz Guzik &x, SX_LOCK_UNLOCKED)) { 11044e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 11054e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p last succeeded", 11064e7f640dSJohn Baldwin __func__, sx); 11074e7f640dSJohn Baldwin break; 11084e7f640dSJohn Baldwin } 11094e7f640dSJohn Baldwin continue; 11104e7f640dSJohn Baldwin } 11114e7f640dSJohn Baldwin 11124e7f640dSJohn Baldwin /* 11134e7f640dSJohn Baldwin * At this point, there should just be one sharer with 11144e7f640dSJohn Baldwin * exclusive waiters. 11154e7f640dSJohn Baldwin */ 11164e7f640dSJohn Baldwin MPASS(x == (SX_SHARERS_LOCK(1) | SX_LOCK_EXCLUSIVE_WAITERS)); 11174e7f640dSJohn Baldwin 11184e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 11194e7f640dSJohn Baldwin 11204e7f640dSJohn Baldwin /* 11214e7f640dSJohn Baldwin * Wake up semantic here is quite simple: 11224e7f640dSJohn Baldwin * Just wake up all the exclusive waiters. 11234e7f640dSJohn Baldwin * Note that the state of the lock could have changed, 11244e7f640dSJohn Baldwin * so if it fails loop back and retry. 11254e7f640dSJohn Baldwin */ 1126ddce63caSAttilio Rao if (!atomic_cmpset_rel_ptr(&sx->sx_lock, 11274e7f640dSJohn Baldwin SX_SHARERS_LOCK(1) | SX_LOCK_EXCLUSIVE_WAITERS, 11284e7f640dSJohn Baldwin SX_LOCK_UNLOCKED)) { 11294e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 1130c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 11314e7f640dSJohn Baldwin continue; 11324e7f640dSJohn Baldwin } 11334e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 11344e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p waking up all thread on" 11354e7f640dSJohn Baldwin "exclusive queue", __func__, sx); 1136da7bbd2cSJohn Baldwin wakeup_swapper = sleepq_broadcast(&sx->lock_object, SLEEPQ_SX, 1137da7bbd2cSJohn Baldwin 0, SQ_EXCLUSIVE_QUEUE); 1138c5aa6b58SJeff Roberson sleepq_release(&sx->lock_object); 1139da7bbd2cSJohn Baldwin if (wakeup_swapper) 1140da7bbd2cSJohn Baldwin kick_proc0(); 11414e7f640dSJohn Baldwin break; 11424e7f640dSJohn Baldwin } 1143d55229b7SJason Evans } 11444e5e677bSJohn Baldwin 11454e5e677bSJohn Baldwin #ifdef INVARIANT_SUPPORT 1146781a35dfSJohn Baldwin #ifndef INVARIANTS 1147781a35dfSJohn Baldwin #undef _sx_assert 1148781a35dfSJohn Baldwin #endif 1149781a35dfSJohn Baldwin 11504e5e677bSJohn Baldwin /* 11514e5e677bSJohn Baldwin * In the non-WITNESS case, sx_assert() can only detect that at least 11524e5e677bSJohn Baldwin * *some* thread owns an slock, but it cannot guarantee that *this* 11534e5e677bSJohn Baldwin * thread owns an slock. 11544e5e677bSJohn Baldwin */ 11554e5e677bSJohn Baldwin void 1156d576deedSPawel Jakub Dawidek _sx_assert(const struct sx *sx, int what, const char *file, int line) 11574e5e677bSJohn Baldwin { 11584e7f640dSJohn Baldwin #ifndef WITNESS 11594e7f640dSJohn Baldwin int slocked = 0; 11604e7f640dSJohn Baldwin #endif 11614e5e677bSJohn Baldwin 116203129ba9SJohn Baldwin if (panicstr != NULL) 116303129ba9SJohn Baldwin return; 11644e5e677bSJohn Baldwin switch (what) { 11657ec137e5SJohn Baldwin case SA_SLOCKED: 11667ec137e5SJohn Baldwin case SA_SLOCKED | SA_NOTRECURSED: 11677ec137e5SJohn Baldwin case SA_SLOCKED | SA_RECURSED: 11684e7f640dSJohn Baldwin #ifndef WITNESS 11694e7f640dSJohn Baldwin slocked = 1; 11704e7f640dSJohn Baldwin /* FALLTHROUGH */ 11714e7f640dSJohn Baldwin #endif 11727ec137e5SJohn Baldwin case SA_LOCKED: 11737ec137e5SJohn Baldwin case SA_LOCKED | SA_NOTRECURSED: 11747ec137e5SJohn Baldwin case SA_LOCKED | SA_RECURSED: 11754e5e677bSJohn Baldwin #ifdef WITNESS 1176aa89d8cdSJohn Baldwin witness_assert(&sx->lock_object, what, file, line); 11774e5e677bSJohn Baldwin #else 11784e7f640dSJohn Baldwin /* 11794e7f640dSJohn Baldwin * If some other thread has an exclusive lock or we 11804e7f640dSJohn Baldwin * have one and are asserting a shared lock, fail. 11814e7f640dSJohn Baldwin * Also, if no one has a lock at all, fail. 11824e7f640dSJohn Baldwin */ 11834e7f640dSJohn Baldwin if (sx->sx_lock == SX_LOCK_UNLOCKED || 11844e7f640dSJohn Baldwin (!(sx->sx_lock & SX_LOCK_SHARED) && (slocked || 11854e7f640dSJohn Baldwin sx_xholder(sx) != curthread))) 118603129ba9SJohn Baldwin panic("Lock %s not %slocked @ %s:%d\n", 11874e7f640dSJohn Baldwin sx->lock_object.lo_name, slocked ? "share " : "", 11884e7f640dSJohn Baldwin file, line); 11894e7f640dSJohn Baldwin 11904e7f640dSJohn Baldwin if (!(sx->sx_lock & SX_LOCK_SHARED)) { 11914e7f640dSJohn Baldwin if (sx_recursed(sx)) { 11927ec137e5SJohn Baldwin if (what & SA_NOTRECURSED) 11934e7f640dSJohn Baldwin panic("Lock %s recursed @ %s:%d\n", 11944e7f640dSJohn Baldwin sx->lock_object.lo_name, file, 11954e7f640dSJohn Baldwin line); 11967ec137e5SJohn Baldwin } else if (what & SA_RECURSED) 11974e7f640dSJohn Baldwin panic("Lock %s not recursed @ %s:%d\n", 11984e7f640dSJohn Baldwin sx->lock_object.lo_name, file, line); 11994e7f640dSJohn Baldwin } 12004e5e677bSJohn Baldwin #endif 12014e5e677bSJohn Baldwin break; 12027ec137e5SJohn Baldwin case SA_XLOCKED: 12037ec137e5SJohn Baldwin case SA_XLOCKED | SA_NOTRECURSED: 12047ec137e5SJohn Baldwin case SA_XLOCKED | SA_RECURSED: 12054e7f640dSJohn Baldwin if (sx_xholder(sx) != curthread) 120603129ba9SJohn Baldwin panic("Lock %s not exclusively locked @ %s:%d\n", 1207aa89d8cdSJohn Baldwin sx->lock_object.lo_name, file, line); 12084e7f640dSJohn Baldwin if (sx_recursed(sx)) { 12097ec137e5SJohn Baldwin if (what & SA_NOTRECURSED) 12104e7f640dSJohn Baldwin panic("Lock %s recursed @ %s:%d\n", 12114e7f640dSJohn Baldwin sx->lock_object.lo_name, file, line); 12127ec137e5SJohn Baldwin } else if (what & SA_RECURSED) 12134e7f640dSJohn Baldwin panic("Lock %s not recursed @ %s:%d\n", 12144e7f640dSJohn Baldwin sx->lock_object.lo_name, file, line); 12154e5e677bSJohn Baldwin break; 12167ec137e5SJohn Baldwin case SA_UNLOCKED: 121719b0efd3SPawel Jakub Dawidek #ifdef WITNESS 1218aa89d8cdSJohn Baldwin witness_assert(&sx->lock_object, what, file, line); 121919b0efd3SPawel Jakub Dawidek #else 1220f6739b1dSPawel Jakub Dawidek /* 12214e7f640dSJohn Baldwin * If we hold an exclusve lock fail. We can't 12224e7f640dSJohn Baldwin * reliably check to see if we hold a shared lock or 12234e7f640dSJohn Baldwin * not. 1224f6739b1dSPawel Jakub Dawidek */ 12254e7f640dSJohn Baldwin if (sx_xholder(sx) == curthread) 122603129ba9SJohn Baldwin panic("Lock %s exclusively locked @ %s:%d\n", 1227aa89d8cdSJohn Baldwin sx->lock_object.lo_name, file, line); 122819b0efd3SPawel Jakub Dawidek #endif 122919b0efd3SPawel Jakub Dawidek break; 12304e5e677bSJohn Baldwin default: 12314e5e677bSJohn Baldwin panic("Unknown sx lock assertion: %d @ %s:%d", what, file, 12324e5e677bSJohn Baldwin line); 12334e5e677bSJohn Baldwin } 12344e5e677bSJohn Baldwin } 12354e5e677bSJohn Baldwin #endif /* INVARIANT_SUPPORT */ 1236d272fe53SJohn Baldwin 1237d272fe53SJohn Baldwin #ifdef DDB 12384e7f640dSJohn Baldwin static void 1239d576deedSPawel Jakub Dawidek db_show_sx(const struct lock_object *lock) 1240d272fe53SJohn Baldwin { 1241d272fe53SJohn Baldwin struct thread *td; 1242d576deedSPawel Jakub Dawidek const struct sx *sx; 1243d272fe53SJohn Baldwin 1244d576deedSPawel Jakub Dawidek sx = (const struct sx *)lock; 1245d272fe53SJohn Baldwin 1246d272fe53SJohn Baldwin db_printf(" state: "); 12474e7f640dSJohn Baldwin if (sx->sx_lock == SX_LOCK_UNLOCKED) 12484e7f640dSJohn Baldwin db_printf("UNLOCKED\n"); 12490026c92cSJohn Baldwin else if (sx->sx_lock == SX_LOCK_DESTROYED) { 12500026c92cSJohn Baldwin db_printf("DESTROYED\n"); 12510026c92cSJohn Baldwin return; 12520026c92cSJohn Baldwin } else if (sx->sx_lock & SX_LOCK_SHARED) 12534e7f640dSJohn Baldwin db_printf("SLOCK: %ju\n", (uintmax_t)SX_SHARERS(sx->sx_lock)); 12544e7f640dSJohn Baldwin else { 12554e7f640dSJohn Baldwin td = sx_xholder(sx); 1256d272fe53SJohn Baldwin db_printf("XLOCK: %p (tid %d, pid %d, \"%s\")\n", td, 1257431f8906SJulian Elischer td->td_tid, td->td_proc->p_pid, td->td_name); 12584e7f640dSJohn Baldwin if (sx_recursed(sx)) 12594e7f640dSJohn Baldwin db_printf(" recursed: %d\n", sx->sx_recurse); 12604e7f640dSJohn Baldwin } 12614e7f640dSJohn Baldwin 12624e7f640dSJohn Baldwin db_printf(" waiters: "); 12634e7f640dSJohn Baldwin switch(sx->sx_lock & 12644e7f640dSJohn Baldwin (SX_LOCK_SHARED_WAITERS | SX_LOCK_EXCLUSIVE_WAITERS)) { 12654e7f640dSJohn Baldwin case SX_LOCK_SHARED_WAITERS: 12664e7f640dSJohn Baldwin db_printf("shared\n"); 12674e7f640dSJohn Baldwin break; 12684e7f640dSJohn Baldwin case SX_LOCK_EXCLUSIVE_WAITERS: 12694e7f640dSJohn Baldwin db_printf("exclusive\n"); 12704e7f640dSJohn Baldwin break; 12714e7f640dSJohn Baldwin case SX_LOCK_SHARED_WAITERS | SX_LOCK_EXCLUSIVE_WAITERS: 12724e7f640dSJohn Baldwin db_printf("exclusive and shared\n"); 12734e7f640dSJohn Baldwin break; 12744e7f640dSJohn Baldwin default: 12754e7f640dSJohn Baldwin db_printf("none\n"); 12764e7f640dSJohn Baldwin } 1277d272fe53SJohn Baldwin } 1278462a7addSJohn Baldwin 1279462a7addSJohn Baldwin /* 1280462a7addSJohn Baldwin * Check to see if a thread that is blocked on a sleep queue is actually 1281462a7addSJohn Baldwin * blocked on an sx lock. If so, output some details and return true. 1282462a7addSJohn Baldwin * If the lock has an exclusive owner, return that in *ownerp. 1283462a7addSJohn Baldwin */ 1284462a7addSJohn Baldwin int 1285462a7addSJohn Baldwin sx_chain(struct thread *td, struct thread **ownerp) 1286462a7addSJohn Baldwin { 1287462a7addSJohn Baldwin struct sx *sx; 1288462a7addSJohn Baldwin 1289462a7addSJohn Baldwin /* 12904e7f640dSJohn Baldwin * Check to see if this thread is blocked on an sx lock. 12914e7f640dSJohn Baldwin * First, we check the lock class. If that is ok, then we 12924e7f640dSJohn Baldwin * compare the lock name against the wait message. 1293462a7addSJohn Baldwin */ 12944e7f640dSJohn Baldwin sx = td->td_wchan; 12954e7f640dSJohn Baldwin if (LOCK_CLASS(&sx->lock_object) != &lock_class_sx || 12964e7f640dSJohn Baldwin sx->lock_object.lo_name != td->td_wmesg) 1297462a7addSJohn Baldwin return (0); 1298462a7addSJohn Baldwin 1299462a7addSJohn Baldwin /* We think we have an sx lock, so output some details. */ 1300462a7addSJohn Baldwin db_printf("blocked on sx \"%s\" ", td->td_wmesg); 13014e7f640dSJohn Baldwin *ownerp = sx_xholder(sx); 13024e7f640dSJohn Baldwin if (sx->sx_lock & SX_LOCK_SHARED) 13034e7f640dSJohn Baldwin db_printf("SLOCK (count %ju)\n", 13044e7f640dSJohn Baldwin (uintmax_t)SX_SHARERS(sx->sx_lock)); 13054e7f640dSJohn Baldwin else 1306462a7addSJohn Baldwin db_printf("XLOCK\n"); 1307462a7addSJohn Baldwin return (1); 1308462a7addSJohn Baldwin } 1309d272fe53SJohn Baldwin #endif 1310