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 2799fde98bbSAttilio Rao sx_try_slock_(struct sx *sx, const char *file, int line) 2805f36700aSJohn Baldwin { 2814e7f640dSJohn Baldwin uintptr_t x; 2825f36700aSJohn Baldwin 28335370593SAndriy Gapon if (SCHEDULER_STOPPED()) 28435370593SAndriy Gapon return (1); 28535370593SAndriy Gapon 286cd2fe4e6SAttilio Rao KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 287e3ae0dfeSAttilio Rao ("sx_try_slock() by idle thread %p on sx %s @ %s:%d", 288e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 289e3ae0dfeSAttilio Rao 290764a938bSPawel Jakub Dawidek for (;;) { 2914e7f640dSJohn Baldwin x = sx->sx_lock; 2920026c92cSJohn Baldwin KASSERT(x != SX_LOCK_DESTROYED, 2930026c92cSJohn Baldwin ("sx_try_slock() of destroyed sx @ %s:%d", file, line)); 294764a938bSPawel Jakub Dawidek if (!(x & SX_LOCK_SHARED)) 295764a938bSPawel Jakub Dawidek break; 296764a938bSPawel Jakub Dawidek if (atomic_cmpset_acq_ptr(&sx->sx_lock, x, x + SX_ONE_SHARER)) { 297aa89d8cdSJohn Baldwin LOCK_LOG_TRY("SLOCK", &sx->lock_object, 0, 1, file, line); 298aa89d8cdSJohn Baldwin WITNESS_LOCK(&sx->lock_object, LOP_TRYLOCK, file, line); 299de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, 300de2c95ccSMark Johnston sx, 0, 0, file, line, LOCKSTAT_READER); 301ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 3025f36700aSJohn Baldwin return (1); 3035f36700aSJohn Baldwin } 304764a938bSPawel Jakub Dawidek } 3054e7f640dSJohn Baldwin 3064e7f640dSJohn Baldwin LOCK_LOG_TRY("SLOCK", &sx->lock_object, 0, 0, file, line); 3074e7f640dSJohn Baldwin return (0); 3085f36700aSJohn Baldwin } 3095f36700aSJohn Baldwin 310f9819486SAttilio Rao int 311f9819486SAttilio Rao _sx_xlock(struct sx *sx, int opts, const char *file, int line) 3126281b30aSJason Evans { 3136ebb77b6SMateusz Guzik uintptr_t tid, x; 314f9819486SAttilio Rao int error = 0; 3156281b30aSJason Evans 31635370593SAndriy Gapon if (SCHEDULER_STOPPED()) 31735370593SAndriy Gapon return (0); 318cd2fe4e6SAttilio Rao KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 319e3ae0dfeSAttilio Rao ("sx_xlock() by idle thread %p on sx %s @ %s:%d", 320e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 3210026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 3220026c92cSJohn Baldwin ("sx_xlock() of destroyed sx @ %s:%d", file, line)); 323aa89d8cdSJohn Baldwin WITNESS_CHECKORDER(&sx->lock_object, LOP_NEWORDER | LOP_EXCLUSIVE, file, 32441313430SJohn Baldwin line, NULL); 3256ebb77b6SMateusz Guzik tid = (uintptr_t)curthread; 3266ebb77b6SMateusz Guzik x = SX_LOCK_UNLOCKED; 3276ebb77b6SMateusz Guzik if (!atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, tid)) 3286ebb77b6SMateusz Guzik error = _sx_xlock_hard(sx, x, tid, opts, file, line); 3296ebb77b6SMateusz Guzik else 3306ebb77b6SMateusz Guzik LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, sx, 3316ebb77b6SMateusz Guzik 0, 0, file, line, LOCKSTAT_WRITER); 332f9819486SAttilio Rao if (!error) { 333f9819486SAttilio Rao LOCK_LOG_LOCK("XLOCK", &sx->lock_object, 0, sx->sx_recurse, 334f9819486SAttilio Rao file, line); 335aa89d8cdSJohn Baldwin WITNESS_LOCK(&sx->lock_object, LOP_EXCLUSIVE, file, line); 336ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 3376281b30aSJason Evans } 3386281b30aSJason Evans 339f9819486SAttilio Rao return (error); 340f9819486SAttilio Rao } 341f9819486SAttilio Rao 3425f36700aSJohn Baldwin int 3439fde98bbSAttilio Rao sx_try_xlock_(struct sx *sx, const char *file, int line) 3445f36700aSJohn Baldwin { 3454e7f640dSJohn Baldwin int rval; 3465f36700aSJohn Baldwin 34735370593SAndriy Gapon if (SCHEDULER_STOPPED()) 34835370593SAndriy Gapon return (1); 34935370593SAndriy Gapon 350cd2fe4e6SAttilio Rao KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 351e3ae0dfeSAttilio Rao ("sx_try_xlock() by idle thread %p on sx %s @ %s:%d", 352e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 3530026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 3540026c92cSJohn Baldwin ("sx_try_xlock() of destroyed sx @ %s:%d", file, line)); 3554e7f640dSJohn Baldwin 356f0830182SAttilio Rao if (sx_xlocked(sx) && 357f0830182SAttilio Rao (sx->lock_object.lo_flags & LO_RECURSABLE) != 0) { 3584e7f640dSJohn Baldwin sx->sx_recurse++; 3594e7f640dSJohn Baldwin atomic_set_ptr(&sx->sx_lock, SX_LOCK_RECURSED); 3604e7f640dSJohn Baldwin rval = 1; 3614e7f640dSJohn Baldwin } else 3624e7f640dSJohn Baldwin rval = atomic_cmpset_acq_ptr(&sx->sx_lock, SX_LOCK_UNLOCKED, 3634e7f640dSJohn Baldwin (uintptr_t)curthread); 3644e7f640dSJohn Baldwin LOCK_LOG_TRY("XLOCK", &sx->lock_object, 0, rval, file, line); 3654e7f640dSJohn Baldwin if (rval) { 3664e7f640dSJohn Baldwin WITNESS_LOCK(&sx->lock_object, LOP_EXCLUSIVE | LOP_TRYLOCK, 3674e7f640dSJohn Baldwin file, line); 368076dd8ebSAndriy Gapon if (!sx_recursed(sx)) 369de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, 370de2c95ccSMark Johnston sx, 0, 0, file, line, LOCKSTAT_WRITER); 371ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 3725f36700aSJohn Baldwin } 3734e7f640dSJohn Baldwin 3744e7f640dSJohn Baldwin return (rval); 3755f36700aSJohn Baldwin } 3765f36700aSJohn Baldwin 3776281b30aSJason Evans void 37819284646SJohn Baldwin _sx_xunlock(struct sx *sx, const char *file, int line) 3796281b30aSJason Evans { 3806281b30aSJason Evans 38135370593SAndriy Gapon if (SCHEDULER_STOPPED()) 38235370593SAndriy Gapon return; 3830026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 3840026c92cSJohn Baldwin ("sx_xunlock() of destroyed sx @ %s:%d", file, line)); 3857ec137e5SJohn Baldwin _sx_assert(sx, SA_XLOCKED, file, line); 386aa89d8cdSJohn Baldwin WITNESS_UNLOCK(&sx->lock_object, LOP_EXCLUSIVE, file, line); 3874e7f640dSJohn Baldwin LOCK_LOG_LOCK("XUNLOCK", &sx->lock_object, 0, sx->sx_recurse, file, 3884e7f640dSJohn Baldwin line); 3896ebb77b6SMateusz Guzik _sx_xunlock_hard(sx, (uintptr_t)curthread, file, line); 390ce1c953eSMark Johnston TD_LOCKS_DEC(curthread); 3916281b30aSJason Evans } 392d55229b7SJason Evans 3934e7f640dSJohn Baldwin /* 3944e7f640dSJohn Baldwin * Try to do a non-blocking upgrade from a shared lock to an exclusive lock. 3954e7f640dSJohn Baldwin * This will only succeed if this thread holds a single shared lock. 3964e7f640dSJohn Baldwin * Return 1 if if the upgrade succeed, 0 otherwise. 3974e7f640dSJohn Baldwin */ 398d55229b7SJason Evans int 3999fde98bbSAttilio Rao sx_try_upgrade_(struct sx *sx, const char *file, int line) 400d55229b7SJason Evans { 4014e7f640dSJohn Baldwin uintptr_t x; 4024e7f640dSJohn Baldwin int success; 403d55229b7SJason Evans 40435370593SAndriy Gapon if (SCHEDULER_STOPPED()) 40535370593SAndriy Gapon return (1); 40635370593SAndriy Gapon 4070026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 4080026c92cSJohn Baldwin ("sx_try_upgrade() of destroyed sx @ %s:%d", file, line)); 4097ec137e5SJohn Baldwin _sx_assert(sx, SA_SLOCKED, file, line); 410d55229b7SJason Evans 4114e7f640dSJohn Baldwin /* 4124e7f640dSJohn Baldwin * Try to switch from one shared lock to an exclusive lock. We need 4134e7f640dSJohn Baldwin * to maintain the SX_LOCK_EXCLUSIVE_WAITERS flag if set so that 4144e7f640dSJohn Baldwin * we will wake up the exclusive waiters when we drop the lock. 4154e7f640dSJohn Baldwin */ 4164e7f640dSJohn Baldwin x = sx->sx_lock & SX_LOCK_EXCLUSIVE_WAITERS; 4174e7f640dSJohn Baldwin success = atomic_cmpset_ptr(&sx->sx_lock, SX_SHARERS_LOCK(1) | x, 4184e7f640dSJohn Baldwin (uintptr_t)curthread | x); 4194e7f640dSJohn Baldwin LOCK_LOG_TRY("XUPGRADE", &sx->lock_object, 0, success, file, line); 420a5aedd68SStacey Son if (success) { 421aa89d8cdSJohn Baldwin WITNESS_UPGRADE(&sx->lock_object, LOP_EXCLUSIVE | LOP_TRYLOCK, 422b0b7cb50SJohn Baldwin file, line); 42332cd0147SMark Johnston LOCKSTAT_RECORD0(sx__upgrade, sx); 424a5aedd68SStacey Son } 4254e7f640dSJohn Baldwin return (success); 426d55229b7SJason Evans } 427d55229b7SJason Evans 4284e7f640dSJohn Baldwin /* 4294e7f640dSJohn Baldwin * Downgrade an unrecursed exclusive lock into a single shared lock. 4304e7f640dSJohn Baldwin */ 431d55229b7SJason Evans void 4329fde98bbSAttilio Rao sx_downgrade_(struct sx *sx, const char *file, int line) 433d55229b7SJason Evans { 4344e7f640dSJohn Baldwin uintptr_t x; 435da7bbd2cSJohn Baldwin int wakeup_swapper; 436d55229b7SJason Evans 43735370593SAndriy Gapon if (SCHEDULER_STOPPED()) 43835370593SAndriy Gapon return; 43935370593SAndriy Gapon 4400026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 4410026c92cSJohn Baldwin ("sx_downgrade() of destroyed sx @ %s:%d", file, line)); 4427ec137e5SJohn Baldwin _sx_assert(sx, SA_XLOCKED | SA_NOTRECURSED, file, line); 4434e7f640dSJohn Baldwin #ifndef INVARIANTS 4444e7f640dSJohn Baldwin if (sx_recursed(sx)) 4454e7f640dSJohn Baldwin panic("downgrade of a recursed lock"); 4464e7f640dSJohn Baldwin #endif 447d55229b7SJason Evans 448aa89d8cdSJohn Baldwin WITNESS_DOWNGRADE(&sx->lock_object, 0, file, line); 449d55229b7SJason Evans 4504e7f640dSJohn Baldwin /* 4514e7f640dSJohn Baldwin * Try to switch from an exclusive lock with no shared waiters 4524e7f640dSJohn Baldwin * to one sharer with no shared waiters. If there are 4534e7f640dSJohn Baldwin * exclusive waiters, we don't need to lock the sleep queue so 4544e7f640dSJohn Baldwin * long as we preserve the flag. We do one quick try and if 4554e7f640dSJohn Baldwin * that fails we grab the sleepq lock to keep the flags from 4564e7f640dSJohn Baldwin * changing and do it the slow way. 4574e7f640dSJohn Baldwin * 4584e7f640dSJohn Baldwin * We have to lock the sleep queue if there are shared waiters 4594e7f640dSJohn Baldwin * so we can wake them up. 4604e7f640dSJohn Baldwin */ 4614e7f640dSJohn Baldwin x = sx->sx_lock; 4624e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED_WAITERS) && 4634e7f640dSJohn Baldwin atomic_cmpset_rel_ptr(&sx->sx_lock, x, SX_SHARERS_LOCK(1) | 4644e7f640dSJohn Baldwin (x & SX_LOCK_EXCLUSIVE_WAITERS))) { 4654e7f640dSJohn Baldwin LOCK_LOG_LOCK("XDOWNGRADE", &sx->lock_object, 0, 0, file, line); 4664e7f640dSJohn Baldwin return; 4674e7f640dSJohn Baldwin } 4684e7f640dSJohn Baldwin 4694e7f640dSJohn Baldwin /* 4704e7f640dSJohn Baldwin * Lock the sleep queue so we can read the waiters bits 4714e7f640dSJohn Baldwin * without any races and wakeup any shared waiters. 4724e7f640dSJohn Baldwin */ 4734e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 4744e7f640dSJohn Baldwin 4754e7f640dSJohn Baldwin /* 4764e7f640dSJohn Baldwin * Preserve SX_LOCK_EXCLUSIVE_WAITERS while downgraded to a single 4774e7f640dSJohn Baldwin * shared lock. If there are any shared waiters, wake them up. 4784e7f640dSJohn Baldwin */ 479da7bbd2cSJohn Baldwin wakeup_swapper = 0; 4804e7f640dSJohn Baldwin x = sx->sx_lock; 4814e7f640dSJohn Baldwin atomic_store_rel_ptr(&sx->sx_lock, SX_SHARERS_LOCK(1) | 4824e7f640dSJohn Baldwin (x & SX_LOCK_EXCLUSIVE_WAITERS)); 4834e7f640dSJohn Baldwin if (x & SX_LOCK_SHARED_WAITERS) 484da7bbd2cSJohn Baldwin wakeup_swapper = sleepq_broadcast(&sx->lock_object, SLEEPQ_SX, 485da7bbd2cSJohn Baldwin 0, SQ_SHARED_QUEUE); 4864e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 487d55229b7SJason Evans 488aa89d8cdSJohn Baldwin LOCK_LOG_LOCK("XDOWNGRADE", &sx->lock_object, 0, 0, file, line); 48932cd0147SMark Johnston LOCKSTAT_RECORD0(sx__downgrade, sx); 490da7bbd2cSJohn Baldwin 491da7bbd2cSJohn Baldwin if (wakeup_swapper) 492da7bbd2cSJohn Baldwin kick_proc0(); 4934e7f640dSJohn Baldwin } 494d55229b7SJason Evans 4954e7f640dSJohn Baldwin /* 4964e7f640dSJohn Baldwin * This function represents the so-called 'hard case' for sx_xlock 4974e7f640dSJohn Baldwin * operation. All 'easy case' failures are redirected to this. Note 4984e7f640dSJohn Baldwin * that ideally this would be a static function, but it needs to be 4994e7f640dSJohn Baldwin * accessible from at least sx.h. 5004e7f640dSJohn Baldwin */ 501f9819486SAttilio Rao int 502fa474043SMateusz Guzik _sx_xlock_hard(struct sx *sx, uintptr_t x, uintptr_t tid, int opts, 503fa474043SMateusz Guzik const char *file, int line) 5044e7f640dSJohn Baldwin { 5054e7f640dSJohn Baldwin GIANT_DECLARE; 5064e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 5074e7f640dSJohn Baldwin volatile struct thread *owner; 5081ae1c2a3SAttilio Rao u_int i, spintries = 0; 5094e7f640dSJohn Baldwin #endif 5101723a064SJeff Roberson #ifdef LOCK_PROFILING 5111723a064SJeff Roberson uint64_t waittime = 0; 5121723a064SJeff Roberson int contested = 0; 5131723a064SJeff Roberson #endif 5141723a064SJeff Roberson int error = 0; 51504126895SMateusz Guzik #if defined(ADAPTIVE_SX) || defined(KDTRACE_HOOKS) 5161ada9041SMateusz Guzik struct lock_delay_arg lda; 5171ada9041SMateusz Guzik #endif 518a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 519076dd8ebSAndriy Gapon uintptr_t state; 52061852185SMateusz Guzik u_int sleep_cnt = 0; 521a5aedd68SStacey Son int64_t sleep_time = 0; 522076dd8ebSAndriy Gapon int64_t all_time = 0; 523a5aedd68SStacey Son #endif 5244e7f640dSJohn Baldwin 52535370593SAndriy Gapon if (SCHEDULER_STOPPED()) 52635370593SAndriy Gapon return (0); 52735370593SAndriy Gapon 528fa5000a4SMateusz Guzik #if defined(ADAPTIVE_SX) 5291ada9041SMateusz Guzik lock_delay_arg_init(&lda, &sx_delay); 530fa5000a4SMateusz Guzik #elif defined(KDTRACE_HOOKS) 531fa5000a4SMateusz Guzik lock_delay_arg_init(&lda, NULL); 5321ada9041SMateusz Guzik #endif 5331ada9041SMateusz Guzik 534*c1aaf63cSMateusz Guzik if (__predict_false(x == SX_LOCK_UNLOCKED)) 535*c1aaf63cSMateusz Guzik x = SX_READ_VALUE(sx); 536*c1aaf63cSMateusz Guzik 5374e7f640dSJohn Baldwin /* If we already hold an exclusive lock, then recurse. */ 538c5f61e6fSMateusz Guzik if (__predict_false(lv_sx_owner(x) == (struct thread *)tid)) { 539f0830182SAttilio Rao KASSERT((sx->lock_object.lo_flags & LO_RECURSABLE) != 0, 540b0d67325SJohn Baldwin ("_sx_xlock_hard: recursed on non-recursive sx %s @ %s:%d\n", 541b0d67325SJohn Baldwin sx->lock_object.lo_name, file, line)); 5424e7f640dSJohn Baldwin sx->sx_recurse++; 5434e7f640dSJohn Baldwin atomic_set_ptr(&sx->sx_lock, SX_LOCK_RECURSED); 5444e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 5454e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p recursing", __func__, sx); 546f9819486SAttilio Rao return (0); 5474e7f640dSJohn Baldwin } 5484e7f640dSJohn Baldwin 5494e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 5504e7f640dSJohn Baldwin CTR5(KTR_LOCK, "%s: %s contested (lock=%p) at %s:%d", __func__, 5514e7f640dSJohn Baldwin sx->lock_object.lo_name, (void *)sx->sx_lock, file, line); 5524e7f640dSJohn Baldwin 553076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 554e2b25737SMark Johnston all_time -= lockstat_nsecs(&sx->lock_object); 555c5f61e6fSMateusz Guzik state = x; 556076dd8ebSAndriy Gapon #endif 557fc4f686dSMateusz Guzik for (;;) { 558c5f61e6fSMateusz Guzik if (x == SX_LOCK_UNLOCKED) { 559fa474043SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, tid)) 560fc4f686dSMateusz Guzik break; 561c5f61e6fSMateusz Guzik continue; 562c5f61e6fSMateusz Guzik } 563a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 5641ada9041SMateusz Guzik lda.spin_cnt++; 565a5aedd68SStacey Son #endif 566f5f9340bSFabien Thomas #ifdef HWPMC_HOOKS 567f5f9340bSFabien Thomas PMC_SOFT_CALL( , , lock, failed); 568f5f9340bSFabien Thomas #endif 569eea4f254SJeff Roberson lock_profile_obtain_lock_failed(&sx->lock_object, &contested, 570eea4f254SJeff Roberson &waittime); 5714e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 5724e7f640dSJohn Baldwin /* 5734e7f640dSJohn Baldwin * If the lock is write locked and the owner is 5744e7f640dSJohn Baldwin * running on another CPU, spin until the owner stops 5754e7f640dSJohn Baldwin * running or the state of the lock changes. 5764e7f640dSJohn Baldwin */ 5778545538bSJohn Baldwin if ((sx->lock_object.lo_flags & SX_NOADAPTIVE) == 0) { 5781ae1c2a3SAttilio Rao if ((x & SX_LOCK_SHARED) == 0) { 579c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 5804e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 5814e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 5824e7f640dSJohn Baldwin CTR3(KTR_LOCK, 5834e7f640dSJohn Baldwin "%s: spinning on %p held by %p", 5844e7f640dSJohn Baldwin __func__, sx, owner); 5852cba8dd3SJohn Baldwin KTR_STATE1(KTR_SCHED, "thread", 5862cba8dd3SJohn Baldwin sched_tdname(curthread), "spinning", 5872cba8dd3SJohn Baldwin "lockname:\"%s\"", 5882cba8dd3SJohn Baldwin sx->lock_object.lo_name); 5894e7f640dSJohn Baldwin GIANT_SAVE(); 590c5f61e6fSMateusz Guzik do { 5911ada9041SMateusz Guzik lock_delay(&lda); 592c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 593c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 594c5f61e6fSMateusz Guzik } while (owner != NULL && 595c5f61e6fSMateusz Guzik TD_IS_RUNNING(owner)); 5962cba8dd3SJohn Baldwin KTR_STATE0(KTR_SCHED, "thread", 5972cba8dd3SJohn Baldwin sched_tdname(curthread), "running"); 5984e7f640dSJohn Baldwin continue; 5994e7f640dSJohn Baldwin } 6001ae1c2a3SAttilio Rao } else if (SX_SHARERS(x) && spintries < asx_retries) { 6012cba8dd3SJohn Baldwin KTR_STATE1(KTR_SCHED, "thread", 6022cba8dd3SJohn Baldwin sched_tdname(curthread), "spinning", 6032cba8dd3SJohn Baldwin "lockname:\"%s\"", sx->lock_object.lo_name); 6048d3635c4SAttilio Rao GIANT_SAVE(); 6051ae1c2a3SAttilio Rao spintries++; 6061ae1c2a3SAttilio Rao for (i = 0; i < asx_loops; i++) { 6071ae1c2a3SAttilio Rao if (LOCK_LOG_TEST(&sx->lock_object, 0)) 6081ae1c2a3SAttilio Rao CTR4(KTR_LOCK, 6091ae1c2a3SAttilio Rao "%s: shared spinning on %p with %u and %u", 6101ae1c2a3SAttilio Rao __func__, sx, spintries, i); 6111ae1c2a3SAttilio Rao x = sx->sx_lock; 6121ae1c2a3SAttilio Rao if ((x & SX_LOCK_SHARED) == 0 || 6131ae1c2a3SAttilio Rao SX_SHARERS(x) == 0) 6141ae1c2a3SAttilio Rao break; 6151ae1c2a3SAttilio Rao cpu_spinwait(); 6161ae1c2a3SAttilio Rao #ifdef KDTRACE_HOOKS 6171ada9041SMateusz Guzik lda.spin_cnt++; 6181ae1c2a3SAttilio Rao #endif 6191ae1c2a3SAttilio Rao } 6202cba8dd3SJohn Baldwin KTR_STATE0(KTR_SCHED, "thread", 6212cba8dd3SJohn Baldwin sched_tdname(curthread), "running"); 622c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 6231ae1c2a3SAttilio Rao if (i != asx_loops) 6241ae1c2a3SAttilio Rao continue; 6251ae1c2a3SAttilio Rao } 6264e7f640dSJohn Baldwin } 6274e7f640dSJohn Baldwin #endif 6284e7f640dSJohn Baldwin 6294e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 630c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 6314e7f640dSJohn Baldwin 6324e7f640dSJohn Baldwin /* 6334e7f640dSJohn Baldwin * If the lock was released while spinning on the 6344e7f640dSJohn Baldwin * sleep queue chain lock, try again. 6354e7f640dSJohn Baldwin */ 6364e7f640dSJohn Baldwin if (x == SX_LOCK_UNLOCKED) { 6374e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 6384e7f640dSJohn Baldwin continue; 6394e7f640dSJohn Baldwin } 6404e7f640dSJohn Baldwin 6414e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 6424e7f640dSJohn Baldwin /* 6434e7f640dSJohn Baldwin * The current lock owner might have started executing 6444e7f640dSJohn Baldwin * on another CPU (or the lock could have changed 6454e7f640dSJohn Baldwin * owners) while we were waiting on the sleep queue 6464e7f640dSJohn Baldwin * chain lock. If so, drop the sleep queue lock and try 6474e7f640dSJohn Baldwin * again. 6484e7f640dSJohn Baldwin */ 6494e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED) && 6501ae1c2a3SAttilio Rao (sx->lock_object.lo_flags & SX_NOADAPTIVE) == 0) { 6514e7f640dSJohn Baldwin owner = (struct thread *)SX_OWNER(x); 6524e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 6534e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 6544e7f640dSJohn Baldwin continue; 6554e7f640dSJohn Baldwin } 6564e7f640dSJohn Baldwin } 6574e7f640dSJohn Baldwin #endif 6584e7f640dSJohn Baldwin 6594e7f640dSJohn Baldwin /* 6604e7f640dSJohn Baldwin * If an exclusive lock was released with both shared 6614e7f640dSJohn Baldwin * and exclusive waiters and a shared waiter hasn't 6624e7f640dSJohn Baldwin * woken up and acquired the lock yet, sx_lock will be 6634e7f640dSJohn Baldwin * set to SX_LOCK_UNLOCKED | SX_LOCK_EXCLUSIVE_WAITERS. 6644e7f640dSJohn Baldwin * If we see that value, try to acquire it once. Note 6654e7f640dSJohn Baldwin * that we have to preserve SX_LOCK_EXCLUSIVE_WAITERS 6664e7f640dSJohn Baldwin * as there are other exclusive waiters still. If we 6674e7f640dSJohn Baldwin * fail, restart the loop. 6684e7f640dSJohn Baldwin */ 6694e7f640dSJohn Baldwin if (x == (SX_LOCK_UNLOCKED | SX_LOCK_EXCLUSIVE_WAITERS)) { 6704e7f640dSJohn Baldwin if (atomic_cmpset_acq_ptr(&sx->sx_lock, 6714e7f640dSJohn Baldwin SX_LOCK_UNLOCKED | SX_LOCK_EXCLUSIVE_WAITERS, 6724e7f640dSJohn Baldwin tid | SX_LOCK_EXCLUSIVE_WAITERS)) { 6734e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 6744e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p claimed by new writer", 6754e7f640dSJohn Baldwin __func__, sx); 6764e7f640dSJohn Baldwin break; 6774e7f640dSJohn Baldwin } 6784e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 679c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 6804e7f640dSJohn Baldwin continue; 6814e7f640dSJohn Baldwin } 6824e7f640dSJohn Baldwin 6834e7f640dSJohn Baldwin /* 6844e7f640dSJohn Baldwin * Try to set the SX_LOCK_EXCLUSIVE_WAITERS. If we fail, 6854e7f640dSJohn Baldwin * than loop back and retry. 6864e7f640dSJohn Baldwin */ 6874e7f640dSJohn Baldwin if (!(x & SX_LOCK_EXCLUSIVE_WAITERS)) { 6884e7f640dSJohn Baldwin if (!atomic_cmpset_ptr(&sx->sx_lock, x, 6894e7f640dSJohn Baldwin x | SX_LOCK_EXCLUSIVE_WAITERS)) { 6904e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 691c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 6924e7f640dSJohn Baldwin continue; 6934e7f640dSJohn Baldwin } 6944e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 6954e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p set excl waiters flag", 6964e7f640dSJohn Baldwin __func__, sx); 6974e7f640dSJohn Baldwin } 6984e7f640dSJohn Baldwin 6994e7f640dSJohn Baldwin /* 7004e7f640dSJohn Baldwin * Since we have been unable to acquire the exclusive 7014e7f640dSJohn Baldwin * lock and the exclusive waiters flag is set, we have 7024e7f640dSJohn Baldwin * to sleep. 7034e7f640dSJohn Baldwin */ 7044e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 7054e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p blocking on sleep queue", 7064e7f640dSJohn Baldwin __func__, sx); 7074e7f640dSJohn Baldwin 708a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 709e2b25737SMark Johnston sleep_time -= lockstat_nsecs(&sx->lock_object); 710a5aedd68SStacey Son #endif 7114e7f640dSJohn Baldwin GIANT_SAVE(); 7124e7f640dSJohn Baldwin sleepq_add(&sx->lock_object, NULL, sx->lock_object.lo_name, 713f9819486SAttilio Rao SLEEPQ_SX | ((opts & SX_INTERRUPTIBLE) ? 714f9819486SAttilio Rao SLEEPQ_INTERRUPTIBLE : 0), SQ_EXCLUSIVE_QUEUE); 715f9819486SAttilio Rao if (!(opts & SX_INTERRUPTIBLE)) 716c5aa6b58SJeff Roberson sleepq_wait(&sx->lock_object, 0); 717f9819486SAttilio Rao else 718c5aa6b58SJeff Roberson error = sleepq_wait_sig(&sx->lock_object, 0); 719a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 720e2b25737SMark Johnston sleep_time += lockstat_nsecs(&sx->lock_object); 721a5aedd68SStacey Son sleep_cnt++; 722a5aedd68SStacey Son #endif 723f9819486SAttilio Rao if (error) { 724f9819486SAttilio Rao if (LOCK_LOG_TEST(&sx->lock_object, 0)) 725f9819486SAttilio Rao CTR2(KTR_LOCK, 726f9819486SAttilio Rao "%s: interruptible sleep by %p suspended by signal", 727f9819486SAttilio Rao __func__, sx); 728f9819486SAttilio Rao break; 729f9819486SAttilio Rao } 7304e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 7314e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p resuming from sleep queue", 7324e7f640dSJohn Baldwin __func__, sx); 733c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 7344e7f640dSJohn Baldwin } 735076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 736e2b25737SMark Johnston all_time += lockstat_nsecs(&sx->lock_object); 737076dd8ebSAndriy Gapon if (sleep_time) 73832cd0147SMark Johnston LOCKSTAT_RECORD4(sx__block, sx, sleep_time, 739076dd8ebSAndriy Gapon LOCKSTAT_WRITER, (state & SX_LOCK_SHARED) == 0, 740076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 7411ada9041SMateusz Guzik if (lda.spin_cnt > sleep_cnt) 74232cd0147SMark Johnston LOCKSTAT_RECORD4(sx__spin, sx, all_time - sleep_time, 743076dd8ebSAndriy Gapon LOCKSTAT_WRITER, (state & SX_LOCK_SHARED) == 0, 744076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 745076dd8ebSAndriy Gapon #endif 746f9819486SAttilio Rao if (!error) 747de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, sx, 748de2c95ccSMark Johnston contested, waittime, file, line, LOCKSTAT_WRITER); 749076dd8ebSAndriy Gapon GIANT_RESTORE(); 750f9819486SAttilio Rao return (error); 7514e7f640dSJohn Baldwin } 7524e7f640dSJohn Baldwin 7534e7f640dSJohn Baldwin /* 7544e7f640dSJohn Baldwin * This function represents the so-called 'hard case' for sx_xunlock 7554e7f640dSJohn Baldwin * operation. All 'easy case' failures are redirected to this. Note 7564e7f640dSJohn Baldwin * that ideally this would be a static function, but it needs to be 7574e7f640dSJohn Baldwin * accessible from at least sx.h. 7584e7f640dSJohn Baldwin */ 7594e7f640dSJohn Baldwin void 7604e7f640dSJohn Baldwin _sx_xunlock_hard(struct sx *sx, uintptr_t tid, const char *file, int line) 7614e7f640dSJohn Baldwin { 7624e7f640dSJohn Baldwin uintptr_t x; 763da7bbd2cSJohn Baldwin int queue, wakeup_swapper; 7644e7f640dSJohn Baldwin 76535370593SAndriy Gapon if (SCHEDULER_STOPPED()) 76635370593SAndriy Gapon return; 76735370593SAndriy Gapon 7684e7f640dSJohn Baldwin MPASS(!(sx->sx_lock & SX_LOCK_SHARED)); 7694e7f640dSJohn Baldwin 7706ebb77b6SMateusz Guzik if (!sx_recursed(sx)) { 7716ebb77b6SMateusz Guzik LOCKSTAT_PROFILE_RELEASE_RWLOCK(sx__release, sx, 7726ebb77b6SMateusz Guzik LOCKSTAT_WRITER); 7736ebb77b6SMateusz Guzik if (atomic_cmpset_rel_ptr(&sx->sx_lock, tid, SX_LOCK_UNLOCKED)) 7746ebb77b6SMateusz Guzik return; 7756ebb77b6SMateusz Guzik } else { 7766ebb77b6SMateusz Guzik /* The lock is recursed, unrecurse one level. */ 7774e7f640dSJohn Baldwin if ((--sx->sx_recurse) == 0) 7784e7f640dSJohn Baldwin atomic_clear_ptr(&sx->sx_lock, SX_LOCK_RECURSED); 7794e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 7804e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p unrecursing", __func__, sx); 7814e7f640dSJohn Baldwin return; 7824e7f640dSJohn Baldwin } 7834e7f640dSJohn Baldwin MPASS(sx->sx_lock & (SX_LOCK_SHARED_WAITERS | 7844e7f640dSJohn Baldwin SX_LOCK_EXCLUSIVE_WAITERS)); 7854e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 7864e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p contested", __func__, sx); 7874e7f640dSJohn Baldwin 7884e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 7894e7f640dSJohn Baldwin x = SX_LOCK_UNLOCKED; 7904e7f640dSJohn Baldwin 7914e7f640dSJohn Baldwin /* 7924e7f640dSJohn Baldwin * The wake up algorithm here is quite simple and probably not 7934e7f640dSJohn Baldwin * ideal. It gives precedence to shared waiters if they are 7944e7f640dSJohn Baldwin * present. For this condition, we have to preserve the 7954e7f640dSJohn Baldwin * state of the exclusive waiters flag. 7962028867dSAttilio Rao * If interruptible sleeps left the shared queue empty avoid a 7972028867dSAttilio Rao * starvation for the threads sleeping on the exclusive queue by giving 7982028867dSAttilio Rao * them precedence and cleaning up the shared waiters bit anyway. 7994e7f640dSJohn Baldwin */ 8002028867dSAttilio Rao if ((sx->sx_lock & SX_LOCK_SHARED_WAITERS) != 0 && 8012028867dSAttilio Rao sleepq_sleepcnt(&sx->lock_object, SQ_SHARED_QUEUE) != 0) { 8024e7f640dSJohn Baldwin queue = SQ_SHARED_QUEUE; 8034e7f640dSJohn Baldwin x |= (sx->sx_lock & SX_LOCK_EXCLUSIVE_WAITERS); 8044e7f640dSJohn Baldwin } else 8054e7f640dSJohn Baldwin queue = SQ_EXCLUSIVE_QUEUE; 8064e7f640dSJohn Baldwin 8074e7f640dSJohn Baldwin /* Wake up all the waiters for the specific queue. */ 8084e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 8094e7f640dSJohn Baldwin CTR3(KTR_LOCK, "%s: %p waking up all threads on %s queue", 8104e7f640dSJohn Baldwin __func__, sx, queue == SQ_SHARED_QUEUE ? "shared" : 8114e7f640dSJohn Baldwin "exclusive"); 8124e7f640dSJohn Baldwin atomic_store_rel_ptr(&sx->sx_lock, x); 813da7bbd2cSJohn Baldwin wakeup_swapper = sleepq_broadcast(&sx->lock_object, SLEEPQ_SX, 0, 814da7bbd2cSJohn Baldwin queue); 815c5aa6b58SJeff Roberson sleepq_release(&sx->lock_object); 816da7bbd2cSJohn Baldwin if (wakeup_swapper) 817da7bbd2cSJohn Baldwin kick_proc0(); 8184e7f640dSJohn Baldwin } 8194e7f640dSJohn Baldwin 820f9819486SAttilio Rao int 8219d2e4290SMateusz Guzik _sx_slock(struct sx *sx, int opts, const char *file, int line) 8224e7f640dSJohn Baldwin { 8234e7f640dSJohn Baldwin GIANT_DECLARE; 8244e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 8254e7f640dSJohn Baldwin volatile struct thread *owner; 8264e7f640dSJohn Baldwin #endif 8271723a064SJeff Roberson #ifdef LOCK_PROFILING 828c1a6d9faSAttilio Rao uint64_t waittime = 0; 829c1a6d9faSAttilio Rao int contested = 0; 8301723a064SJeff Roberson #endif 8314e7f640dSJohn Baldwin uintptr_t x; 832c1a6d9faSAttilio Rao int error = 0; 83304126895SMateusz Guzik #if defined(ADAPTIVE_SX) || defined(KDTRACE_HOOKS) 8341ada9041SMateusz Guzik struct lock_delay_arg lda; 8351ada9041SMateusz Guzik #endif 836a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 837076dd8ebSAndriy Gapon uintptr_t state; 83861852185SMateusz Guzik u_int sleep_cnt = 0; 839a5aedd68SStacey Son int64_t sleep_time = 0; 840076dd8ebSAndriy Gapon int64_t all_time = 0; 841a5aedd68SStacey Son #endif 842c1a6d9faSAttilio Rao 84335370593SAndriy Gapon if (SCHEDULER_STOPPED()) 84435370593SAndriy Gapon return (0); 84535370593SAndriy Gapon 846fa5000a4SMateusz Guzik #if defined(ADAPTIVE_SX) 8471ada9041SMateusz Guzik lock_delay_arg_init(&lda, &sx_delay); 848fa5000a4SMateusz Guzik #elif defined(KDTRACE_HOOKS) 849fa5000a4SMateusz Guzik lock_delay_arg_init(&lda, NULL); 8501ada9041SMateusz Guzik #endif 8513ae56ce9SMateusz Guzik KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 8523ae56ce9SMateusz Guzik ("sx_slock() by idle thread %p on sx %s @ %s:%d", 8533ae56ce9SMateusz Guzik curthread, sx->lock_object.lo_name, file, line)); 8543ae56ce9SMateusz Guzik KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 8553ae56ce9SMateusz Guzik ("sx_slock() of destroyed sx @ %s:%d", file, line)); 8563ae56ce9SMateusz Guzik WITNESS_CHECKORDER(&sx->lock_object, LOP_NEWORDER, file, line, NULL); 857076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 858e2b25737SMark Johnston all_time -= lockstat_nsecs(&sx->lock_object); 859076dd8ebSAndriy Gapon #endif 860c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 861c5f61e6fSMateusz Guzik #ifdef KDTRACE_HOOKS 862c5f61e6fSMateusz Guzik state = x; 863c5f61e6fSMateusz Guzik #endif 864076dd8ebSAndriy Gapon 8654e7f640dSJohn Baldwin /* 8664e7f640dSJohn Baldwin * As with rwlocks, we don't make any attempt to try to block 8674e7f640dSJohn Baldwin * shared locks once there is an exclusive waiter. 8684e7f640dSJohn Baldwin */ 8694e7f640dSJohn Baldwin for (;;) { 8704e7f640dSJohn Baldwin /* 8714e7f640dSJohn Baldwin * If no other thread has an exclusive lock then try to bump up 8724e7f640dSJohn Baldwin * the count of sharers. Since we have to preserve the state 8734e7f640dSJohn Baldwin * of SX_LOCK_EXCLUSIVE_WAITERS, if we fail to acquire the 8744e7f640dSJohn Baldwin * shared lock loop back and retry. 8754e7f640dSJohn Baldwin */ 8764e7f640dSJohn Baldwin if (x & SX_LOCK_SHARED) { 8774e7f640dSJohn Baldwin MPASS(!(x & SX_LOCK_SHARED_WAITERS)); 878fa474043SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, 8794e7f640dSJohn Baldwin x + SX_ONE_SHARER)) { 8804e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 8814e7f640dSJohn Baldwin CTR4(KTR_LOCK, 8824e7f640dSJohn Baldwin "%s: %p succeed %p -> %p", __func__, 8834e7f640dSJohn Baldwin sx, (void *)x, 8844e7f640dSJohn Baldwin (void *)(x + SX_ONE_SHARER)); 8854e7f640dSJohn Baldwin break; 8864e7f640dSJohn Baldwin } 8874e7f640dSJohn Baldwin continue; 8884e7f640dSJohn Baldwin } 889c5f61e6fSMateusz Guzik #ifdef KDTRACE_HOOKS 890c5f61e6fSMateusz Guzik lda.spin_cnt++; 891c5f61e6fSMateusz Guzik #endif 892c5f61e6fSMateusz Guzik 893f5f9340bSFabien Thomas #ifdef HWPMC_HOOKS 894f5f9340bSFabien Thomas PMC_SOFT_CALL( , , lock, failed); 895f5f9340bSFabien Thomas #endif 896eea4f254SJeff Roberson lock_profile_obtain_lock_failed(&sx->lock_object, &contested, 897eea4f254SJeff Roberson &waittime); 8984e7f640dSJohn Baldwin 8994e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 9004e7f640dSJohn Baldwin /* 9014e7f640dSJohn Baldwin * If the owner is running on another CPU, spin until 9024e7f640dSJohn Baldwin * the owner stops running or the state of the lock 9034e7f640dSJohn Baldwin * changes. 9044e7f640dSJohn Baldwin */ 9051ae1c2a3SAttilio Rao if ((sx->lock_object.lo_flags & SX_NOADAPTIVE) == 0) { 906c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 9074e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 9084e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 9094e7f640dSJohn Baldwin CTR3(KTR_LOCK, 9104e7f640dSJohn Baldwin "%s: spinning on %p held by %p", 9114e7f640dSJohn Baldwin __func__, sx, owner); 9122cba8dd3SJohn Baldwin KTR_STATE1(KTR_SCHED, "thread", 9132cba8dd3SJohn Baldwin sched_tdname(curthread), "spinning", 9142cba8dd3SJohn Baldwin "lockname:\"%s\"", sx->lock_object.lo_name); 9154e7f640dSJohn Baldwin GIANT_SAVE(); 916c5f61e6fSMateusz Guzik do { 9171ada9041SMateusz Guzik lock_delay(&lda); 918c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 919c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 920c5f61e6fSMateusz Guzik } while (owner != NULL && TD_IS_RUNNING(owner)); 9212cba8dd3SJohn Baldwin KTR_STATE0(KTR_SCHED, "thread", 9222cba8dd3SJohn Baldwin sched_tdname(curthread), "running"); 9234e7f640dSJohn Baldwin continue; 9244e7f640dSJohn Baldwin } 9254e7f640dSJohn Baldwin } 9264e7f640dSJohn Baldwin #endif 9274e7f640dSJohn Baldwin 9284e7f640dSJohn Baldwin /* 9294e7f640dSJohn Baldwin * Some other thread already has an exclusive lock, so 9304e7f640dSJohn Baldwin * start the process of blocking. 9314e7f640dSJohn Baldwin */ 9324e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 933c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 9344e7f640dSJohn Baldwin 9354e7f640dSJohn Baldwin /* 9364e7f640dSJohn Baldwin * The lock could have been released while we spun. 9374e7f640dSJohn Baldwin * In this case loop back and retry. 9384e7f640dSJohn Baldwin */ 9394e7f640dSJohn Baldwin if (x & SX_LOCK_SHARED) { 9404e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 9414e7f640dSJohn Baldwin continue; 9424e7f640dSJohn Baldwin } 9434e7f640dSJohn Baldwin 9444e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 9454e7f640dSJohn Baldwin /* 9464e7f640dSJohn Baldwin * If the owner is running on another CPU, spin until 9474e7f640dSJohn Baldwin * the owner stops running or the state of the lock 9484e7f640dSJohn Baldwin * changes. 9494e7f640dSJohn Baldwin */ 9504e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED) && 9511ae1c2a3SAttilio Rao (sx->lock_object.lo_flags & SX_NOADAPTIVE) == 0) { 9524e7f640dSJohn Baldwin owner = (struct thread *)SX_OWNER(x); 9534e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 9544e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 955c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 9564e7f640dSJohn Baldwin continue; 9574e7f640dSJohn Baldwin } 9584e7f640dSJohn Baldwin } 9594e7f640dSJohn Baldwin #endif 9604e7f640dSJohn Baldwin 9614e7f640dSJohn Baldwin /* 9624e7f640dSJohn Baldwin * Try to set the SX_LOCK_SHARED_WAITERS flag. If we 9634e7f640dSJohn Baldwin * fail to set it drop the sleep queue lock and loop 9644e7f640dSJohn Baldwin * back. 9654e7f640dSJohn Baldwin */ 9664e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED_WAITERS)) { 9674e7f640dSJohn Baldwin if (!atomic_cmpset_ptr(&sx->sx_lock, x, 9684e7f640dSJohn Baldwin x | SX_LOCK_SHARED_WAITERS)) { 9694e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 970c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 9714e7f640dSJohn Baldwin continue; 9724e7f640dSJohn Baldwin } 9734e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 9744e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p set shared waiters flag", 9754e7f640dSJohn Baldwin __func__, sx); 9764e7f640dSJohn Baldwin } 9774e7f640dSJohn Baldwin 9784e7f640dSJohn Baldwin /* 9794e7f640dSJohn Baldwin * Since we have been unable to acquire the shared lock, 9804e7f640dSJohn Baldwin * we have to sleep. 9814e7f640dSJohn Baldwin */ 9824e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 9834e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p blocking on sleep queue", 9844e7f640dSJohn Baldwin __func__, sx); 9854e7f640dSJohn Baldwin 986a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 987e2b25737SMark Johnston sleep_time -= lockstat_nsecs(&sx->lock_object); 988a5aedd68SStacey Son #endif 9894e7f640dSJohn Baldwin GIANT_SAVE(); 9904e7f640dSJohn Baldwin sleepq_add(&sx->lock_object, NULL, sx->lock_object.lo_name, 991f9819486SAttilio Rao SLEEPQ_SX | ((opts & SX_INTERRUPTIBLE) ? 992f9819486SAttilio Rao SLEEPQ_INTERRUPTIBLE : 0), SQ_SHARED_QUEUE); 993f9819486SAttilio Rao if (!(opts & SX_INTERRUPTIBLE)) 994c5aa6b58SJeff Roberson sleepq_wait(&sx->lock_object, 0); 995f9819486SAttilio Rao else 996c5aa6b58SJeff Roberson error = sleepq_wait_sig(&sx->lock_object, 0); 997a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 998e2b25737SMark Johnston sleep_time += lockstat_nsecs(&sx->lock_object); 999a5aedd68SStacey Son sleep_cnt++; 1000a5aedd68SStacey Son #endif 1001f9819486SAttilio Rao if (error) { 1002f9819486SAttilio Rao if (LOCK_LOG_TEST(&sx->lock_object, 0)) 1003f9819486SAttilio Rao CTR2(KTR_LOCK, 1004f9819486SAttilio Rao "%s: interruptible sleep by %p suspended by signal", 1005f9819486SAttilio Rao __func__, sx); 1006f9819486SAttilio Rao break; 1007f9819486SAttilio Rao } 10084e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 10094e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p resuming from sleep queue", 10104e7f640dSJohn Baldwin __func__, sx); 1011c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 10124e7f640dSJohn Baldwin } 1013076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 1014e2b25737SMark Johnston all_time += lockstat_nsecs(&sx->lock_object); 1015076dd8ebSAndriy Gapon if (sleep_time) 101632cd0147SMark Johnston LOCKSTAT_RECORD4(sx__block, sx, sleep_time, 1017076dd8ebSAndriy Gapon LOCKSTAT_READER, (state & SX_LOCK_SHARED) == 0, 1018076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 10191ada9041SMateusz Guzik if (lda.spin_cnt > sleep_cnt) 102032cd0147SMark Johnston LOCKSTAT_RECORD4(sx__spin, sx, all_time - sleep_time, 1021076dd8ebSAndriy Gapon LOCKSTAT_READER, (state & SX_LOCK_SHARED) == 0, 1022076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 1023076dd8ebSAndriy Gapon #endif 10243ae56ce9SMateusz Guzik if (error == 0) { 1025de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, sx, 1026de2c95ccSMark Johnston contested, waittime, file, line, LOCKSTAT_READER); 10273ae56ce9SMateusz Guzik LOCK_LOG_LOCK("SLOCK", &sx->lock_object, 0, 0, file, line); 10283ae56ce9SMateusz Guzik WITNESS_LOCK(&sx->lock_object, 0, file, line); 10293ae56ce9SMateusz Guzik TD_LOCKS_INC(curthread); 10303ae56ce9SMateusz Guzik } 10314e7f640dSJohn Baldwin GIANT_RESTORE(); 1032f9819486SAttilio Rao return (error); 10334e7f640dSJohn Baldwin } 10344e7f640dSJohn Baldwin 10354e7f640dSJohn Baldwin void 10369d2e4290SMateusz Guzik _sx_sunlock(struct sx *sx, const char *file, int line) 10374e7f640dSJohn Baldwin { 10384e7f640dSJohn Baldwin uintptr_t x; 1039da7bbd2cSJohn Baldwin int wakeup_swapper; 10404e7f640dSJohn Baldwin 104135370593SAndriy Gapon if (SCHEDULER_STOPPED()) 104235370593SAndriy Gapon return; 104335370593SAndriy Gapon 10443ae56ce9SMateusz Guzik KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 10453ae56ce9SMateusz Guzik ("sx_sunlock() of destroyed sx @ %s:%d", file, line)); 10463ae56ce9SMateusz Guzik _sx_assert(sx, SA_SLOCKED, file, line); 10473ae56ce9SMateusz Guzik WITNESS_UNLOCK(&sx->lock_object, 0, file, line); 10483ae56ce9SMateusz Guzik LOCK_LOG_LOCK("SUNLOCK", &sx->lock_object, 0, 0, file, line); 10499d2e4290SMateusz Guzik LOCKSTAT_PROFILE_RELEASE_RWLOCK(sx__release, sx, LOCKSTAT_READER); 1050c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 10514e7f640dSJohn Baldwin for (;;) { 10524e7f640dSJohn Baldwin /* 10534e7f640dSJohn Baldwin * We should never have sharers while at least one thread 10544e7f640dSJohn Baldwin * holds a shared lock. 10554e7f640dSJohn Baldwin */ 10564e7f640dSJohn Baldwin KASSERT(!(x & SX_LOCK_SHARED_WAITERS), 10574e7f640dSJohn Baldwin ("%s: waiting sharers", __func__)); 10584e7f640dSJohn Baldwin 10594e7f640dSJohn Baldwin /* 10604e7f640dSJohn Baldwin * See if there is more than one shared lock held. If 10614e7f640dSJohn Baldwin * so, just drop one and return. 10624e7f640dSJohn Baldwin */ 10634e7f640dSJohn Baldwin if (SX_SHARERS(x) > 1) { 1064fa474043SMateusz Guzik if (atomic_fcmpset_rel_ptr(&sx->sx_lock, &x, 10654e7f640dSJohn Baldwin x - SX_ONE_SHARER)) { 10664e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 10674e7f640dSJohn Baldwin CTR4(KTR_LOCK, 10684e7f640dSJohn Baldwin "%s: %p succeeded %p -> %p", 10694e7f640dSJohn Baldwin __func__, sx, (void *)x, 10704e7f640dSJohn Baldwin (void *)(x - SX_ONE_SHARER)); 10714e7f640dSJohn Baldwin break; 10724e7f640dSJohn Baldwin } 10734e7f640dSJohn Baldwin continue; 10744e7f640dSJohn Baldwin } 10754e7f640dSJohn Baldwin 10764e7f640dSJohn Baldwin /* 10774e7f640dSJohn Baldwin * If there aren't any waiters for an exclusive lock, 10784e7f640dSJohn Baldwin * then try to drop it quickly. 10794e7f640dSJohn Baldwin */ 10804e7f640dSJohn Baldwin if (!(x & SX_LOCK_EXCLUSIVE_WAITERS)) { 10814e7f640dSJohn Baldwin MPASS(x == SX_SHARERS_LOCK(1)); 1082fa474043SMateusz Guzik x = SX_SHARERS_LOCK(1); 1083fa474043SMateusz Guzik if (atomic_fcmpset_rel_ptr(&sx->sx_lock, 1084fa474043SMateusz Guzik &x, SX_LOCK_UNLOCKED)) { 10854e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 10864e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p last succeeded", 10874e7f640dSJohn Baldwin __func__, sx); 10884e7f640dSJohn Baldwin break; 10894e7f640dSJohn Baldwin } 10904e7f640dSJohn Baldwin continue; 10914e7f640dSJohn Baldwin } 10924e7f640dSJohn Baldwin 10934e7f640dSJohn Baldwin /* 10944e7f640dSJohn Baldwin * At this point, there should just be one sharer with 10954e7f640dSJohn Baldwin * exclusive waiters. 10964e7f640dSJohn Baldwin */ 10974e7f640dSJohn Baldwin MPASS(x == (SX_SHARERS_LOCK(1) | SX_LOCK_EXCLUSIVE_WAITERS)); 10984e7f640dSJohn Baldwin 10994e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 11004e7f640dSJohn Baldwin 11014e7f640dSJohn Baldwin /* 11024e7f640dSJohn Baldwin * Wake up semantic here is quite simple: 11034e7f640dSJohn Baldwin * Just wake up all the exclusive waiters. 11044e7f640dSJohn Baldwin * Note that the state of the lock could have changed, 11054e7f640dSJohn Baldwin * so if it fails loop back and retry. 11064e7f640dSJohn Baldwin */ 1107ddce63caSAttilio Rao if (!atomic_cmpset_rel_ptr(&sx->sx_lock, 11084e7f640dSJohn Baldwin SX_SHARERS_LOCK(1) | SX_LOCK_EXCLUSIVE_WAITERS, 11094e7f640dSJohn Baldwin SX_LOCK_UNLOCKED)) { 11104e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 1111c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 11124e7f640dSJohn Baldwin continue; 11134e7f640dSJohn Baldwin } 11144e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 11154e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p waking up all thread on" 11164e7f640dSJohn Baldwin "exclusive queue", __func__, sx); 1117da7bbd2cSJohn Baldwin wakeup_swapper = sleepq_broadcast(&sx->lock_object, SLEEPQ_SX, 1118da7bbd2cSJohn Baldwin 0, SQ_EXCLUSIVE_QUEUE); 1119c5aa6b58SJeff Roberson sleepq_release(&sx->lock_object); 1120da7bbd2cSJohn Baldwin if (wakeup_swapper) 1121da7bbd2cSJohn Baldwin kick_proc0(); 11224e7f640dSJohn Baldwin break; 11234e7f640dSJohn Baldwin } 11243ae56ce9SMateusz Guzik TD_LOCKS_DEC(curthread); 1125d55229b7SJason Evans } 11264e5e677bSJohn Baldwin 11274e5e677bSJohn Baldwin #ifdef INVARIANT_SUPPORT 1128781a35dfSJohn Baldwin #ifndef INVARIANTS 1129781a35dfSJohn Baldwin #undef _sx_assert 1130781a35dfSJohn Baldwin #endif 1131781a35dfSJohn Baldwin 11324e5e677bSJohn Baldwin /* 11334e5e677bSJohn Baldwin * In the non-WITNESS case, sx_assert() can only detect that at least 11344e5e677bSJohn Baldwin * *some* thread owns an slock, but it cannot guarantee that *this* 11354e5e677bSJohn Baldwin * thread owns an slock. 11364e5e677bSJohn Baldwin */ 11374e5e677bSJohn Baldwin void 1138d576deedSPawel Jakub Dawidek _sx_assert(const struct sx *sx, int what, const char *file, int line) 11394e5e677bSJohn Baldwin { 11404e7f640dSJohn Baldwin #ifndef WITNESS 11414e7f640dSJohn Baldwin int slocked = 0; 11424e7f640dSJohn Baldwin #endif 11434e5e677bSJohn Baldwin 114403129ba9SJohn Baldwin if (panicstr != NULL) 114503129ba9SJohn Baldwin return; 11464e5e677bSJohn Baldwin switch (what) { 11477ec137e5SJohn Baldwin case SA_SLOCKED: 11487ec137e5SJohn Baldwin case SA_SLOCKED | SA_NOTRECURSED: 11497ec137e5SJohn Baldwin case SA_SLOCKED | SA_RECURSED: 11504e7f640dSJohn Baldwin #ifndef WITNESS 11514e7f640dSJohn Baldwin slocked = 1; 11524e7f640dSJohn Baldwin /* FALLTHROUGH */ 11534e7f640dSJohn Baldwin #endif 11547ec137e5SJohn Baldwin case SA_LOCKED: 11557ec137e5SJohn Baldwin case SA_LOCKED | SA_NOTRECURSED: 11567ec137e5SJohn Baldwin case SA_LOCKED | SA_RECURSED: 11574e5e677bSJohn Baldwin #ifdef WITNESS 1158aa89d8cdSJohn Baldwin witness_assert(&sx->lock_object, what, file, line); 11594e5e677bSJohn Baldwin #else 11604e7f640dSJohn Baldwin /* 11614e7f640dSJohn Baldwin * If some other thread has an exclusive lock or we 11624e7f640dSJohn Baldwin * have one and are asserting a shared lock, fail. 11634e7f640dSJohn Baldwin * Also, if no one has a lock at all, fail. 11644e7f640dSJohn Baldwin */ 11654e7f640dSJohn Baldwin if (sx->sx_lock == SX_LOCK_UNLOCKED || 11664e7f640dSJohn Baldwin (!(sx->sx_lock & SX_LOCK_SHARED) && (slocked || 11674e7f640dSJohn Baldwin sx_xholder(sx) != curthread))) 116803129ba9SJohn Baldwin panic("Lock %s not %slocked @ %s:%d\n", 11694e7f640dSJohn Baldwin sx->lock_object.lo_name, slocked ? "share " : "", 11704e7f640dSJohn Baldwin file, line); 11714e7f640dSJohn Baldwin 11724e7f640dSJohn Baldwin if (!(sx->sx_lock & SX_LOCK_SHARED)) { 11734e7f640dSJohn Baldwin if (sx_recursed(sx)) { 11747ec137e5SJohn Baldwin if (what & SA_NOTRECURSED) 11754e7f640dSJohn Baldwin panic("Lock %s recursed @ %s:%d\n", 11764e7f640dSJohn Baldwin sx->lock_object.lo_name, file, 11774e7f640dSJohn Baldwin line); 11787ec137e5SJohn Baldwin } else if (what & SA_RECURSED) 11794e7f640dSJohn Baldwin panic("Lock %s not recursed @ %s:%d\n", 11804e7f640dSJohn Baldwin sx->lock_object.lo_name, file, line); 11814e7f640dSJohn Baldwin } 11824e5e677bSJohn Baldwin #endif 11834e5e677bSJohn Baldwin break; 11847ec137e5SJohn Baldwin case SA_XLOCKED: 11857ec137e5SJohn Baldwin case SA_XLOCKED | SA_NOTRECURSED: 11867ec137e5SJohn Baldwin case SA_XLOCKED | SA_RECURSED: 11874e7f640dSJohn Baldwin if (sx_xholder(sx) != curthread) 118803129ba9SJohn Baldwin panic("Lock %s not exclusively locked @ %s:%d\n", 1189aa89d8cdSJohn Baldwin sx->lock_object.lo_name, file, line); 11904e7f640dSJohn Baldwin if (sx_recursed(sx)) { 11917ec137e5SJohn Baldwin if (what & SA_NOTRECURSED) 11924e7f640dSJohn Baldwin panic("Lock %s recursed @ %s:%d\n", 11934e7f640dSJohn Baldwin sx->lock_object.lo_name, file, line); 11947ec137e5SJohn Baldwin } else if (what & SA_RECURSED) 11954e7f640dSJohn Baldwin panic("Lock %s not recursed @ %s:%d\n", 11964e7f640dSJohn Baldwin sx->lock_object.lo_name, file, line); 11974e5e677bSJohn Baldwin break; 11987ec137e5SJohn Baldwin case SA_UNLOCKED: 119919b0efd3SPawel Jakub Dawidek #ifdef WITNESS 1200aa89d8cdSJohn Baldwin witness_assert(&sx->lock_object, what, file, line); 120119b0efd3SPawel Jakub Dawidek #else 1202f6739b1dSPawel Jakub Dawidek /* 12034e7f640dSJohn Baldwin * If we hold an exclusve lock fail. We can't 12044e7f640dSJohn Baldwin * reliably check to see if we hold a shared lock or 12054e7f640dSJohn Baldwin * not. 1206f6739b1dSPawel Jakub Dawidek */ 12074e7f640dSJohn Baldwin if (sx_xholder(sx) == curthread) 120803129ba9SJohn Baldwin panic("Lock %s exclusively locked @ %s:%d\n", 1209aa89d8cdSJohn Baldwin sx->lock_object.lo_name, file, line); 121019b0efd3SPawel Jakub Dawidek #endif 121119b0efd3SPawel Jakub Dawidek break; 12124e5e677bSJohn Baldwin default: 12134e5e677bSJohn Baldwin panic("Unknown sx lock assertion: %d @ %s:%d", what, file, 12144e5e677bSJohn Baldwin line); 12154e5e677bSJohn Baldwin } 12164e5e677bSJohn Baldwin } 12174e5e677bSJohn Baldwin #endif /* INVARIANT_SUPPORT */ 1218d272fe53SJohn Baldwin 1219d272fe53SJohn Baldwin #ifdef DDB 12204e7f640dSJohn Baldwin static void 1221d576deedSPawel Jakub Dawidek db_show_sx(const struct lock_object *lock) 1222d272fe53SJohn Baldwin { 1223d272fe53SJohn Baldwin struct thread *td; 1224d576deedSPawel Jakub Dawidek const struct sx *sx; 1225d272fe53SJohn Baldwin 1226d576deedSPawel Jakub Dawidek sx = (const struct sx *)lock; 1227d272fe53SJohn Baldwin 1228d272fe53SJohn Baldwin db_printf(" state: "); 12294e7f640dSJohn Baldwin if (sx->sx_lock == SX_LOCK_UNLOCKED) 12304e7f640dSJohn Baldwin db_printf("UNLOCKED\n"); 12310026c92cSJohn Baldwin else if (sx->sx_lock == SX_LOCK_DESTROYED) { 12320026c92cSJohn Baldwin db_printf("DESTROYED\n"); 12330026c92cSJohn Baldwin return; 12340026c92cSJohn Baldwin } else if (sx->sx_lock & SX_LOCK_SHARED) 12354e7f640dSJohn Baldwin db_printf("SLOCK: %ju\n", (uintmax_t)SX_SHARERS(sx->sx_lock)); 12364e7f640dSJohn Baldwin else { 12374e7f640dSJohn Baldwin td = sx_xholder(sx); 1238d272fe53SJohn Baldwin db_printf("XLOCK: %p (tid %d, pid %d, \"%s\")\n", td, 1239431f8906SJulian Elischer td->td_tid, td->td_proc->p_pid, td->td_name); 12404e7f640dSJohn Baldwin if (sx_recursed(sx)) 12414e7f640dSJohn Baldwin db_printf(" recursed: %d\n", sx->sx_recurse); 12424e7f640dSJohn Baldwin } 12434e7f640dSJohn Baldwin 12444e7f640dSJohn Baldwin db_printf(" waiters: "); 12454e7f640dSJohn Baldwin switch(sx->sx_lock & 12464e7f640dSJohn Baldwin (SX_LOCK_SHARED_WAITERS | SX_LOCK_EXCLUSIVE_WAITERS)) { 12474e7f640dSJohn Baldwin case SX_LOCK_SHARED_WAITERS: 12484e7f640dSJohn Baldwin db_printf("shared\n"); 12494e7f640dSJohn Baldwin break; 12504e7f640dSJohn Baldwin case SX_LOCK_EXCLUSIVE_WAITERS: 12514e7f640dSJohn Baldwin db_printf("exclusive\n"); 12524e7f640dSJohn Baldwin break; 12534e7f640dSJohn Baldwin case SX_LOCK_SHARED_WAITERS | SX_LOCK_EXCLUSIVE_WAITERS: 12544e7f640dSJohn Baldwin db_printf("exclusive and shared\n"); 12554e7f640dSJohn Baldwin break; 12564e7f640dSJohn Baldwin default: 12574e7f640dSJohn Baldwin db_printf("none\n"); 12584e7f640dSJohn Baldwin } 1259d272fe53SJohn Baldwin } 1260462a7addSJohn Baldwin 1261462a7addSJohn Baldwin /* 1262462a7addSJohn Baldwin * Check to see if a thread that is blocked on a sleep queue is actually 1263462a7addSJohn Baldwin * blocked on an sx lock. If so, output some details and return true. 1264462a7addSJohn Baldwin * If the lock has an exclusive owner, return that in *ownerp. 1265462a7addSJohn Baldwin */ 1266462a7addSJohn Baldwin int 1267462a7addSJohn Baldwin sx_chain(struct thread *td, struct thread **ownerp) 1268462a7addSJohn Baldwin { 1269462a7addSJohn Baldwin struct sx *sx; 1270462a7addSJohn Baldwin 1271462a7addSJohn Baldwin /* 12724e7f640dSJohn Baldwin * Check to see if this thread is blocked on an sx lock. 12734e7f640dSJohn Baldwin * First, we check the lock class. If that is ok, then we 12744e7f640dSJohn Baldwin * compare the lock name against the wait message. 1275462a7addSJohn Baldwin */ 12764e7f640dSJohn Baldwin sx = td->td_wchan; 12774e7f640dSJohn Baldwin if (LOCK_CLASS(&sx->lock_object) != &lock_class_sx || 12784e7f640dSJohn Baldwin sx->lock_object.lo_name != td->td_wmesg) 1279462a7addSJohn Baldwin return (0); 1280462a7addSJohn Baldwin 1281462a7addSJohn Baldwin /* We think we have an sx lock, so output some details. */ 1282462a7addSJohn Baldwin db_printf("blocked on sx \"%s\" ", td->td_wmesg); 12834e7f640dSJohn Baldwin *ownerp = sx_xholder(sx); 12844e7f640dSJohn Baldwin if (sx->sx_lock & SX_LOCK_SHARED) 12854e7f640dSJohn Baldwin db_printf("SLOCK (count %ju)\n", 12864e7f640dSJohn Baldwin (uintmax_t)SX_SHARERS(sx->sx_lock)); 12874e7f640dSJohn Baldwin else 1288462a7addSJohn Baldwin db_printf("XLOCK\n"); 1289462a7addSJohn Baldwin return (1); 1290462a7addSJohn Baldwin } 1291d272fe53SJohn Baldwin #endif 1292