19454b2d8SWarner Losh /*- 28a36da99SPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 38a36da99SPedro F. Giffuni * 44e7f640dSJohn Baldwin * Copyright (c) 2007 Attilio Rao <attilio@freebsd.org> 54e7f640dSJohn Baldwin * Copyright (c) 2001 Jason Evans <jasone@freebsd.org> 64e7f640dSJohn Baldwin * All rights reserved. 76281b30aSJason Evans * 86281b30aSJason Evans * Redistribution and use in source and binary forms, with or without 96281b30aSJason Evans * modification, are permitted provided that the following conditions 106281b30aSJason Evans * are met: 116281b30aSJason Evans * 1. Redistributions of source code must retain the above copyright 126281b30aSJason Evans * notice(s), this list of conditions and the following disclaimer as 136281b30aSJason Evans * the first lines of this file unmodified other than the possible 146281b30aSJason Evans * addition of one or more copyright notices. 156281b30aSJason Evans * 2. Redistributions in binary form must reproduce the above copyright 166281b30aSJason Evans * notice(s), this list of conditions and the following disclaimer in the 176281b30aSJason Evans * documentation and/or other materials provided with the distribution. 186281b30aSJason Evans * 196281b30aSJason Evans * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY 206281b30aSJason Evans * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 216281b30aSJason Evans * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 226281b30aSJason Evans * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY 236281b30aSJason Evans * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 246281b30aSJason Evans * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 256281b30aSJason Evans * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 266281b30aSJason Evans * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 276281b30aSJason Evans * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 286281b30aSJason Evans * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 296281b30aSJason Evans * DAMAGE. 306281b30aSJason Evans */ 316281b30aSJason Evans 326281b30aSJason Evans /* 334e7f640dSJohn Baldwin * Shared/exclusive locks. This implementation attempts to ensure 344e7f640dSJohn Baldwin * deterministic lock granting behavior, so that slocks and xlocks are 354e7f640dSJohn Baldwin * interleaved. 366281b30aSJason Evans * 376281b30aSJason Evans * Priority propagation will not generally raise the priority of lock holders, 386281b30aSJason Evans * so should not be relied upon in combination with sx locks. 396281b30aSJason Evans */ 406281b30aSJason Evans 414e7f640dSJohn Baldwin #include "opt_ddb.h" 42f5f9340bSFabien Thomas #include "opt_hwpmc_hooks.h" 43e31d0833SAttilio Rao #include "opt_no_adaptive_sx.h" 444e7f640dSJohn Baldwin 45677b542eSDavid E. O'Brien #include <sys/cdefs.h> 46677b542eSDavid E. O'Brien __FBSDID("$FreeBSD$"); 47677b542eSDavid E. O'Brien 486281b30aSJason Evans #include <sys/param.h> 497a7ce668SAndriy Gapon #include <sys/systm.h> 50cd2fe4e6SAttilio Rao #include <sys/kdb.h> 510453ade5SMateusz Guzik #include <sys/kernel.h> 526281b30aSJason Evans #include <sys/ktr.h> 5319284646SJohn Baldwin #include <sys/lock.h> 546281b30aSJason Evans #include <sys/mutex.h> 55d272fe53SJohn Baldwin #include <sys/proc.h> 562cba8dd3SJohn Baldwin #include <sys/sched.h> 574e7f640dSJohn Baldwin #include <sys/sleepqueue.h> 586281b30aSJason Evans #include <sys/sx.h> 591ada9041SMateusz Guzik #include <sys/smp.h> 60e31d0833SAttilio Rao #include <sys/sysctl.h> 614e7f640dSJohn Baldwin 62e31d0833SAttilio Rao #if defined(SMP) && !defined(NO_ADAPTIVE_SX) 634e7f640dSJohn Baldwin #include <machine/cpu.h> 644e7f640dSJohn Baldwin #endif 656281b30aSJason Evans 66462a7addSJohn Baldwin #ifdef DDB 67d272fe53SJohn Baldwin #include <ddb/ddb.h> 684e7f640dSJohn Baldwin #endif 69d272fe53SJohn Baldwin 701ae1c2a3SAttilio Rao #if defined(SMP) && !defined(NO_ADAPTIVE_SX) 711ae1c2a3SAttilio Rao #define ADAPTIVE_SX 724e7f640dSJohn Baldwin #endif 734e7f640dSJohn Baldwin 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 91e41d6166SMateusz Guzik #define GIANT_SAVE(work) do { \ 92fb106123SMateusz Guzik if (__predict_false(mtx_owned(&Giant))) { \ 93e41d6166SMateusz Guzik work++; \ 944e7f640dSJohn Baldwin WITNESS_SAVE(&Giant.lock_object, Giant); \ 954e7f640dSJohn Baldwin while (mtx_owned(&Giant)) { \ 964e7f640dSJohn Baldwin _giantcnt++; \ 974e7f640dSJohn Baldwin mtx_unlock(&Giant); \ 984e7f640dSJohn Baldwin } \ 994e7f640dSJohn Baldwin } \ 1004e7f640dSJohn Baldwin } while (0) 1014e7f640dSJohn Baldwin 1024e7f640dSJohn Baldwin #define GIANT_RESTORE() do { \ 1034e7f640dSJohn Baldwin if (_giantcnt > 0) { \ 1044e7f640dSJohn Baldwin mtx_assert(&Giant, MA_NOTOWNED); \ 1054e7f640dSJohn Baldwin while (_giantcnt--) \ 1064e7f640dSJohn Baldwin mtx_lock(&Giant); \ 1074e7f640dSJohn Baldwin WITNESS_RESTORE(&Giant.lock_object, Giant); \ 1084e7f640dSJohn Baldwin } \ 1094e7f640dSJohn Baldwin } while (0) 1104e7f640dSJohn Baldwin 1114e7f640dSJohn Baldwin /* 112da7d0d1eSJohn Baldwin * Returns true if an exclusive lock is recursed. It assumes 113da7d0d1eSJohn Baldwin * curthread currently has an exclusive lock. 1144e7f640dSJohn Baldwin */ 1154e7f640dSJohn Baldwin #define sx_recursed(sx) ((sx)->sx_recurse != 0) 1164e7f640dSJohn Baldwin 117d576deedSPawel Jakub Dawidek static void assert_sx(const struct lock_object *lock, int what); 1184e7f640dSJohn Baldwin #ifdef DDB 119d576deedSPawel Jakub Dawidek static void db_show_sx(const struct lock_object *lock); 120d272fe53SJohn Baldwin #endif 1217faf4d90SDavide Italiano static void lock_sx(struct lock_object *lock, uintptr_t how); 122a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 123d576deedSPawel Jakub Dawidek static int owner_sx(const struct lock_object *lock, struct thread **owner); 124a5aedd68SStacey Son #endif 1257faf4d90SDavide Italiano static uintptr_t unlock_sx(struct lock_object *lock); 126d272fe53SJohn Baldwin 12719284646SJohn Baldwin struct lock_class lock_class_sx = { 128ae8dde30SJohn Baldwin .lc_name = "sx", 129ae8dde30SJohn Baldwin .lc_flags = LC_SLEEPLOCK | LC_SLEEPABLE | LC_RECURSABLE | LC_UPGRADABLE, 130f9721b43SAttilio Rao .lc_assert = assert_sx, 131d272fe53SJohn Baldwin #ifdef DDB 132ae8dde30SJohn Baldwin .lc_ddb_show = db_show_sx, 133d272fe53SJohn Baldwin #endif 1346e21afd4SJohn Baldwin .lc_lock = lock_sx, 1356e21afd4SJohn Baldwin .lc_unlock = unlock_sx, 136a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 137a5aedd68SStacey Son .lc_owner = owner_sx, 138a5aedd68SStacey Son #endif 13919284646SJohn Baldwin }; 14019284646SJohn Baldwin 141781a35dfSJohn Baldwin #ifndef INVARIANTS 142781a35dfSJohn Baldwin #define _sx_assert(sx, what, file, line) 143781a35dfSJohn Baldwin #endif 144781a35dfSJohn Baldwin 1451ae1c2a3SAttilio Rao #ifdef ADAPTIVE_SX 146e0e259a8SMateusz Guzik static __read_frequently u_int asx_retries; 147e0e259a8SMateusz Guzik static __read_frequently u_int asx_loops; 1486472ac3dSEd Schouten static SYSCTL_NODE(_debug, OID_AUTO, sx, CTLFLAG_RD, NULL, "sxlock debugging"); 149fbbb13f9SMatthew D Fleming SYSCTL_UINT(_debug_sx, OID_AUTO, retries, CTLFLAG_RW, &asx_retries, 0, ""); 150fbbb13f9SMatthew D Fleming SYSCTL_UINT(_debug_sx, OID_AUTO, loops, CTLFLAG_RW, &asx_loops, 0, ""); 1511ada9041SMateusz Guzik 152574adb65SMateusz Guzik static struct lock_delay_config __read_frequently sx_delay; 1531ada9041SMateusz Guzik 1548e5a3e9aSMateusz Guzik SYSCTL_INT(_debug_sx, OID_AUTO, delay_base, CTLFLAG_RW, &sx_delay.base, 1551ada9041SMateusz Guzik 0, ""); 1561ada9041SMateusz Guzik SYSCTL_INT(_debug_sx, OID_AUTO, delay_max, CTLFLAG_RW, &sx_delay.max, 1571ada9041SMateusz Guzik 0, ""); 1581ada9041SMateusz Guzik 159e0e259a8SMateusz Guzik static void 160e0e259a8SMateusz Guzik sx_lock_delay_init(void *arg __unused) 161e0e259a8SMateusz Guzik { 162e0e259a8SMateusz Guzik 163e0e259a8SMateusz Guzik lock_delay_default_init(&sx_delay); 164e0e259a8SMateusz Guzik asx_retries = 10; 165e0e259a8SMateusz Guzik asx_loops = max(10000, sx_delay.max); 166e0e259a8SMateusz Guzik } 167e0e259a8SMateusz Guzik LOCK_DELAY_SYSINIT(sx_lock_delay_init); 1681ae1c2a3SAttilio Rao #endif 1691ae1c2a3SAttilio Rao 1706281b30aSJason Evans void 171d576deedSPawel Jakub Dawidek assert_sx(const struct lock_object *lock, int what) 172f9721b43SAttilio Rao { 173f9721b43SAttilio Rao 174d576deedSPawel Jakub Dawidek sx_assert((const struct sx *)lock, what); 175f9721b43SAttilio Rao } 176f9721b43SAttilio Rao 177f9721b43SAttilio Rao void 1787faf4d90SDavide Italiano lock_sx(struct lock_object *lock, uintptr_t how) 1796e21afd4SJohn Baldwin { 1806e21afd4SJohn Baldwin struct sx *sx; 1816e21afd4SJohn Baldwin 1826e21afd4SJohn Baldwin sx = (struct sx *)lock; 1836e21afd4SJohn Baldwin if (how) 1846e21afd4SJohn Baldwin sx_slock(sx); 185cf6b879fSDavide Italiano else 186cf6b879fSDavide Italiano sx_xlock(sx); 1876e21afd4SJohn Baldwin } 1886e21afd4SJohn Baldwin 1897faf4d90SDavide Italiano uintptr_t 1906e21afd4SJohn Baldwin unlock_sx(struct lock_object *lock) 1916e21afd4SJohn Baldwin { 1926e21afd4SJohn Baldwin struct sx *sx; 1936e21afd4SJohn Baldwin 1946e21afd4SJohn Baldwin sx = (struct sx *)lock; 1957ec137e5SJohn Baldwin sx_assert(sx, SA_LOCKED | SA_NOTRECURSED); 1966e21afd4SJohn Baldwin if (sx_xlocked(sx)) { 1976e21afd4SJohn Baldwin sx_xunlock(sx); 198cf6b879fSDavide Italiano return (0); 1996e21afd4SJohn Baldwin } else { 2006e21afd4SJohn Baldwin sx_sunlock(sx); 201cf6b879fSDavide Italiano return (1); 2026e21afd4SJohn Baldwin } 2036e21afd4SJohn Baldwin } 2046e21afd4SJohn Baldwin 205a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 206a5aedd68SStacey Son int 207d576deedSPawel Jakub Dawidek owner_sx(const struct lock_object *lock, struct thread **owner) 208a5aedd68SStacey Son { 209c365a293SMark Johnston const struct sx *sx; 210c365a293SMark Johnston uintptr_t x; 211a5aedd68SStacey Son 212c365a293SMark Johnston sx = (const struct sx *)lock; 213c365a293SMark Johnston x = sx->sx_lock; 214c365a293SMark Johnston *owner = NULL; 215a5aedd68SStacey Son return ((x & SX_LOCK_SHARED) != 0 ? (SX_SHARERS(x) != 0) : 216c365a293SMark Johnston ((*owner = (struct thread *)SX_OWNER(x)) != NULL)); 217a5aedd68SStacey Son } 218a5aedd68SStacey Son #endif 219a5aedd68SStacey Son 2206e21afd4SJohn Baldwin void 221c27b5699SAndrew R. Reiter sx_sysinit(void *arg) 222c27b5699SAndrew R. Reiter { 223c27b5699SAndrew R. Reiter struct sx_args *sargs = arg; 224c27b5699SAndrew R. Reiter 225e4cd31ddSJeff Roberson sx_init_flags(sargs->sa_sx, sargs->sa_desc, sargs->sa_flags); 226c27b5699SAndrew R. Reiter } 227c27b5699SAndrew R. Reiter 228c27b5699SAndrew R. Reiter void 2294e7f640dSJohn Baldwin sx_init_flags(struct sx *sx, const char *description, int opts) 2306281b30aSJason Evans { 2314e7f640dSJohn Baldwin int flags; 2326281b30aSJason Evans 233b0d67325SJohn Baldwin MPASS((opts & ~(SX_QUIET | SX_RECURSE | SX_NOWITNESS | SX_DUPOK | 234f26db694SMateusz Guzik SX_NOPROFILE | SX_NEW)) == 0); 235353998acSAttilio Rao ASSERT_ATOMIC_LOAD_PTR(sx->sx_lock, 236353998acSAttilio Rao ("%s: sx_lock not aligned for %s: %p", __func__, description, 237353998acSAttilio Rao &sx->sx_lock)); 238b0d67325SJohn Baldwin 239f0830182SAttilio Rao flags = LO_SLEEPABLE | LO_UPGRADABLE; 2404e7f640dSJohn Baldwin if (opts & SX_DUPOK) 2414e7f640dSJohn Baldwin flags |= LO_DUPOK; 2424e7f640dSJohn Baldwin if (opts & SX_NOPROFILE) 2434e7f640dSJohn Baldwin flags |= LO_NOPROFILE; 2444e7f640dSJohn Baldwin if (!(opts & SX_NOWITNESS)) 2454e7f640dSJohn Baldwin flags |= LO_WITNESS; 246f0830182SAttilio Rao if (opts & SX_RECURSE) 247f0830182SAttilio Rao flags |= LO_RECURSABLE; 2484e7f640dSJohn Baldwin if (opts & SX_QUIET) 2494e7f640dSJohn Baldwin flags |= LO_QUIET; 250fd07ddcfSDmitry Chagin if (opts & SX_NEW) 251fd07ddcfSDmitry Chagin flags |= LO_NEW; 2524e7f640dSJohn Baldwin 253b5fb43e5SJohn Baldwin lock_init(&sx->lock_object, &lock_class_sx, description, NULL, flags); 2544e7f640dSJohn Baldwin sx->sx_lock = SX_LOCK_UNLOCKED; 2554e7f640dSJohn Baldwin sx->sx_recurse = 0; 2566281b30aSJason Evans } 2576281b30aSJason Evans 2586281b30aSJason Evans void 2596281b30aSJason Evans sx_destroy(struct sx *sx) 2606281b30aSJason Evans { 2616281b30aSJason Evans 2624e7f640dSJohn Baldwin KASSERT(sx->sx_lock == SX_LOCK_UNLOCKED, ("sx lock still held")); 2634e7f640dSJohn Baldwin KASSERT(sx->sx_recurse == 0, ("sx lock still recursed")); 2640026c92cSJohn Baldwin sx->sx_lock = SX_LOCK_DESTROYED; 265aa89d8cdSJohn Baldwin lock_destroy(&sx->lock_object); 2666281b30aSJason Evans } 2676281b30aSJason Evans 268f9819486SAttilio Rao int 269013c0b49SMateusz Guzik sx_try_slock_int(struct sx *sx LOCK_FILE_LINE_ARG_DEF) 2705f36700aSJohn Baldwin { 2714e7f640dSJohn Baldwin uintptr_t x; 2725f36700aSJohn Baldwin 27335370593SAndriy Gapon if (SCHEDULER_STOPPED()) 27435370593SAndriy Gapon return (1); 27535370593SAndriy Gapon 276cd2fe4e6SAttilio Rao KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread), 277e3ae0dfeSAttilio Rao ("sx_try_slock() by idle thread %p on sx %s @ %s:%d", 278e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 279e3ae0dfeSAttilio Rao 2804e7f640dSJohn Baldwin x = sx->sx_lock; 2815c5df0d9SMateusz Guzik for (;;) { 2820026c92cSJohn Baldwin KASSERT(x != SX_LOCK_DESTROYED, 2830026c92cSJohn Baldwin ("sx_try_slock() of destroyed sx @ %s:%d", file, line)); 284764a938bSPawel Jakub Dawidek if (!(x & SX_LOCK_SHARED)) 285764a938bSPawel Jakub Dawidek break; 2865c5df0d9SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, x + SX_ONE_SHARER)) { 287aa89d8cdSJohn Baldwin LOCK_LOG_TRY("SLOCK", &sx->lock_object, 0, 1, file, line); 288aa89d8cdSJohn Baldwin WITNESS_LOCK(&sx->lock_object, LOP_TRYLOCK, file, line); 289de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, 290de2c95ccSMark Johnston sx, 0, 0, file, line, LOCKSTAT_READER); 291ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 2922466d12bSMateusz Guzik curthread->td_sx_slocks++; 2935f36700aSJohn Baldwin return (1); 2945f36700aSJohn Baldwin } 295764a938bSPawel Jakub Dawidek } 2964e7f640dSJohn Baldwin 2974e7f640dSJohn Baldwin LOCK_LOG_TRY("SLOCK", &sx->lock_object, 0, 0, file, line); 2984e7f640dSJohn Baldwin return (0); 2995f36700aSJohn Baldwin } 3005f36700aSJohn Baldwin 301f9819486SAttilio Rao int 302013c0b49SMateusz Guzik sx_try_slock_(struct sx *sx, const char *file, int line) 303013c0b49SMateusz Guzik { 304013c0b49SMateusz Guzik 305013c0b49SMateusz Guzik return (sx_try_slock_int(sx LOCK_FILE_LINE_ARG)); 306013c0b49SMateusz Guzik } 307013c0b49SMateusz Guzik 308013c0b49SMateusz Guzik int 309f9819486SAttilio Rao _sx_xlock(struct sx *sx, int opts, const char *file, int line) 3106281b30aSJason Evans { 3116ebb77b6SMateusz Guzik uintptr_t tid, x; 312f9819486SAttilio Rao int error = 0; 3136281b30aSJason Evans 314704cb42fSMark Johnston KASSERT(kdb_active != 0 || SCHEDULER_STOPPED() || 315704cb42fSMark Johnston !TD_IS_IDLETHREAD(curthread), 316e3ae0dfeSAttilio Rao ("sx_xlock() by idle thread %p on sx %s @ %s:%d", 317e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 3180026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 3190026c92cSJohn Baldwin ("sx_xlock() of destroyed sx @ %s:%d", file, line)); 320aa89d8cdSJohn Baldwin WITNESS_CHECKORDER(&sx->lock_object, LOP_NEWORDER | LOP_EXCLUSIVE, file, 32141313430SJohn Baldwin line, NULL); 3226ebb77b6SMateusz Guzik tid = (uintptr_t)curthread; 3236ebb77b6SMateusz Guzik x = SX_LOCK_UNLOCKED; 3246ebb77b6SMateusz Guzik if (!atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, tid)) 325013c0b49SMateusz Guzik error = _sx_xlock_hard(sx, x, opts LOCK_FILE_LINE_ARG); 3266ebb77b6SMateusz Guzik else 3276ebb77b6SMateusz Guzik LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, sx, 3286ebb77b6SMateusz Guzik 0, 0, file, line, LOCKSTAT_WRITER); 329f9819486SAttilio Rao if (!error) { 330f9819486SAttilio Rao LOCK_LOG_LOCK("XLOCK", &sx->lock_object, 0, sx->sx_recurse, 331f9819486SAttilio Rao file, line); 332aa89d8cdSJohn Baldwin WITNESS_LOCK(&sx->lock_object, LOP_EXCLUSIVE, file, line); 333ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 3346281b30aSJason Evans } 3356281b30aSJason Evans 336f9819486SAttilio Rao return (error); 337f9819486SAttilio Rao } 338f9819486SAttilio Rao 3395f36700aSJohn Baldwin int 340013c0b49SMateusz Guzik sx_try_xlock_int(struct sx *sx LOCK_FILE_LINE_ARG_DEF) 3415f36700aSJohn Baldwin { 3425c5df0d9SMateusz Guzik struct thread *td; 3435c5df0d9SMateusz Guzik uintptr_t tid, x; 3444e7f640dSJohn Baldwin int rval; 3455c5df0d9SMateusz Guzik bool recursed; 3465f36700aSJohn Baldwin 3475c5df0d9SMateusz Guzik td = curthread; 3485c5df0d9SMateusz Guzik tid = (uintptr_t)td; 3495c5df0d9SMateusz Guzik if (SCHEDULER_STOPPED_TD(td)) 35035370593SAndriy Gapon return (1); 35135370593SAndriy Gapon 352704cb42fSMark Johnston KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(td), 353e3ae0dfeSAttilio Rao ("sx_try_xlock() by idle thread %p on sx %s @ %s:%d", 354e3ae0dfeSAttilio Rao curthread, sx->lock_object.lo_name, file, line)); 3550026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 3560026c92cSJohn Baldwin ("sx_try_xlock() of destroyed sx @ %s:%d", file, line)); 3574e7f640dSJohn Baldwin 3585c5df0d9SMateusz Guzik rval = 1; 3595c5df0d9SMateusz Guzik recursed = false; 3605c5df0d9SMateusz Guzik x = SX_LOCK_UNLOCKED; 361b247fd39SMateusz Guzik for (;;) { 362b247fd39SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, tid)) 363b247fd39SMateusz Guzik break; 364b247fd39SMateusz Guzik if (x == SX_LOCK_UNLOCKED) 365b247fd39SMateusz Guzik continue; 3665c5df0d9SMateusz Guzik if (x == tid && (sx->lock_object.lo_flags & LO_RECURSABLE)) { 3674e7f640dSJohn Baldwin sx->sx_recurse++; 3684e7f640dSJohn Baldwin atomic_set_ptr(&sx->sx_lock, SX_LOCK_RECURSED); 369b247fd39SMateusz Guzik break; 3705c5df0d9SMateusz Guzik } 371b247fd39SMateusz Guzik rval = 0; 372b247fd39SMateusz Guzik break; 3735c5df0d9SMateusz Guzik } 3745c5df0d9SMateusz Guzik 3754e7f640dSJohn Baldwin LOCK_LOG_TRY("XLOCK", &sx->lock_object, 0, rval, file, line); 3764e7f640dSJohn Baldwin if (rval) { 3774e7f640dSJohn Baldwin WITNESS_LOCK(&sx->lock_object, LOP_EXCLUSIVE | LOP_TRYLOCK, 3784e7f640dSJohn Baldwin file, line); 3795c5df0d9SMateusz Guzik if (!recursed) 380de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, 381de2c95ccSMark Johnston sx, 0, 0, file, line, LOCKSTAT_WRITER); 382ce1c953eSMark Johnston TD_LOCKS_INC(curthread); 3835f36700aSJohn Baldwin } 3844e7f640dSJohn Baldwin 3854e7f640dSJohn Baldwin return (rval); 3865f36700aSJohn Baldwin } 3875f36700aSJohn Baldwin 388013c0b49SMateusz Guzik int 389013c0b49SMateusz Guzik sx_try_xlock_(struct sx *sx, const char *file, int line) 390013c0b49SMateusz Guzik { 391013c0b49SMateusz Guzik 392013c0b49SMateusz Guzik return (sx_try_xlock_int(sx LOCK_FILE_LINE_ARG)); 393013c0b49SMateusz Guzik } 394013c0b49SMateusz Guzik 3956281b30aSJason Evans void 39619284646SJohn Baldwin _sx_xunlock(struct sx *sx, const char *file, int line) 3976281b30aSJason Evans { 3986281b30aSJason Evans 3990026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 4000026c92cSJohn Baldwin ("sx_xunlock() of destroyed sx @ %s:%d", file, line)); 4017ec137e5SJohn Baldwin _sx_assert(sx, SA_XLOCKED, file, line); 402aa89d8cdSJohn Baldwin WITNESS_UNLOCK(&sx->lock_object, LOP_EXCLUSIVE, file, line); 4034e7f640dSJohn Baldwin LOCK_LOG_LOCK("XUNLOCK", &sx->lock_object, 0, sx->sx_recurse, file, 4044e7f640dSJohn Baldwin line); 4050108a980SMateusz Guzik #if LOCK_DEBUG > 0 4066ebb77b6SMateusz Guzik _sx_xunlock_hard(sx, (uintptr_t)curthread, file, line); 407ffd5c94cSMateusz Guzik #else 408ffd5c94cSMateusz Guzik __sx_xunlock(sx, curthread, file, line); 409ffd5c94cSMateusz Guzik #endif 410ce1c953eSMark Johnston TD_LOCKS_DEC(curthread); 4116281b30aSJason Evans } 412d55229b7SJason Evans 4134e7f640dSJohn Baldwin /* 4144e7f640dSJohn Baldwin * Try to do a non-blocking upgrade from a shared lock to an exclusive lock. 4154e7f640dSJohn Baldwin * This will only succeed if this thread holds a single shared lock. 4164e7f640dSJohn Baldwin * Return 1 if if the upgrade succeed, 0 otherwise. 4174e7f640dSJohn Baldwin */ 418d55229b7SJason Evans int 419013c0b49SMateusz Guzik sx_try_upgrade_int(struct sx *sx LOCK_FILE_LINE_ARG_DEF) 420d55229b7SJason Evans { 4214e7f640dSJohn Baldwin uintptr_t x; 422a8e747c5SMateusz Guzik uintptr_t waiters; 4234e7f640dSJohn Baldwin int success; 424d55229b7SJason Evans 42535370593SAndriy Gapon if (SCHEDULER_STOPPED()) 42635370593SAndriy Gapon return (1); 42735370593SAndriy Gapon 4280026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 4290026c92cSJohn Baldwin ("sx_try_upgrade() of destroyed sx @ %s:%d", file, line)); 4307ec137e5SJohn Baldwin _sx_assert(sx, SA_SLOCKED, file, line); 431d55229b7SJason Evans 4324e7f640dSJohn Baldwin /* 4334e7f640dSJohn Baldwin * Try to switch from one shared lock to an exclusive lock. We need 4344e7f640dSJohn Baldwin * to maintain the SX_LOCK_EXCLUSIVE_WAITERS flag if set so that 4354e7f640dSJohn Baldwin * we will wake up the exclusive waiters when we drop the lock. 4364e7f640dSJohn Baldwin */ 437a8e747c5SMateusz Guzik success = 0; 438a8e747c5SMateusz Guzik x = SX_READ_VALUE(sx); 439a8e747c5SMateusz Guzik for (;;) { 440a8e747c5SMateusz Guzik if (SX_SHARERS(x) > 1) 441a8e747c5SMateusz Guzik break; 4422466d12bSMateusz Guzik waiters = (x & SX_LOCK_WAITERS); 443a8e747c5SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, 444a8e747c5SMateusz Guzik (uintptr_t)curthread | waiters)) { 445a8e747c5SMateusz Guzik success = 1; 446a8e747c5SMateusz Guzik break; 447a8e747c5SMateusz Guzik } 448a8e747c5SMateusz Guzik } 4494e7f640dSJohn Baldwin LOCK_LOG_TRY("XUPGRADE", &sx->lock_object, 0, success, file, line); 450a5aedd68SStacey Son if (success) { 4512466d12bSMateusz Guzik curthread->td_sx_slocks--; 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 459013c0b49SMateusz Guzik int 460013c0b49SMateusz Guzik sx_try_upgrade_(struct sx *sx, const char *file, int line) 461013c0b49SMateusz Guzik { 462013c0b49SMateusz Guzik 463013c0b49SMateusz Guzik return (sx_try_upgrade_int(sx LOCK_FILE_LINE_ARG)); 464013c0b49SMateusz Guzik } 465013c0b49SMateusz Guzik 4664e7f640dSJohn Baldwin /* 4674e7f640dSJohn Baldwin * Downgrade an unrecursed exclusive lock into a single shared lock. 4684e7f640dSJohn Baldwin */ 469d55229b7SJason Evans void 470013c0b49SMateusz Guzik sx_downgrade_int(struct sx *sx LOCK_FILE_LINE_ARG_DEF) 471d55229b7SJason Evans { 4724e7f640dSJohn Baldwin uintptr_t x; 473da7bbd2cSJohn Baldwin int wakeup_swapper; 474d55229b7SJason Evans 47535370593SAndriy Gapon if (SCHEDULER_STOPPED()) 47635370593SAndriy Gapon return; 47735370593SAndriy Gapon 4780026c92cSJohn Baldwin KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 4790026c92cSJohn Baldwin ("sx_downgrade() of destroyed sx @ %s:%d", file, line)); 4807ec137e5SJohn Baldwin _sx_assert(sx, SA_XLOCKED | SA_NOTRECURSED, file, line); 4814e7f640dSJohn Baldwin #ifndef INVARIANTS 4824e7f640dSJohn Baldwin if (sx_recursed(sx)) 4834e7f640dSJohn Baldwin panic("downgrade of a recursed lock"); 4844e7f640dSJohn Baldwin #endif 485d55229b7SJason Evans 486aa89d8cdSJohn Baldwin WITNESS_DOWNGRADE(&sx->lock_object, 0, file, line); 487d55229b7SJason Evans 4884e7f640dSJohn Baldwin /* 4894e7f640dSJohn Baldwin * Try to switch from an exclusive lock with no shared waiters 4904e7f640dSJohn Baldwin * to one sharer with no shared waiters. If there are 4914e7f640dSJohn Baldwin * exclusive waiters, we don't need to lock the sleep queue so 4924e7f640dSJohn Baldwin * long as we preserve the flag. We do one quick try and if 4934e7f640dSJohn Baldwin * that fails we grab the sleepq lock to keep the flags from 4944e7f640dSJohn Baldwin * changing and do it the slow way. 4954e7f640dSJohn Baldwin * 4964e7f640dSJohn Baldwin * We have to lock the sleep queue if there are shared waiters 4974e7f640dSJohn Baldwin * so we can wake them up. 4984e7f640dSJohn Baldwin */ 4994e7f640dSJohn Baldwin x = sx->sx_lock; 5004e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED_WAITERS) && 5014e7f640dSJohn Baldwin atomic_cmpset_rel_ptr(&sx->sx_lock, x, SX_SHARERS_LOCK(1) | 50226d94f99SMark Johnston (x & SX_LOCK_EXCLUSIVE_WAITERS))) 50326d94f99SMark Johnston goto out; 5044e7f640dSJohn Baldwin 5054e7f640dSJohn Baldwin /* 5064e7f640dSJohn Baldwin * Lock the sleep queue so we can read the waiters bits 5074e7f640dSJohn Baldwin * without any races and wakeup any shared waiters. 5084e7f640dSJohn Baldwin */ 5094e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 5104e7f640dSJohn Baldwin 5114e7f640dSJohn Baldwin /* 5124e7f640dSJohn Baldwin * Preserve SX_LOCK_EXCLUSIVE_WAITERS while downgraded to a single 5134e7f640dSJohn Baldwin * shared lock. If there are any shared waiters, wake them up. 5144e7f640dSJohn Baldwin */ 515da7bbd2cSJohn Baldwin wakeup_swapper = 0; 5164e7f640dSJohn Baldwin x = sx->sx_lock; 5174e7f640dSJohn Baldwin atomic_store_rel_ptr(&sx->sx_lock, SX_SHARERS_LOCK(1) | 5184e7f640dSJohn Baldwin (x & SX_LOCK_EXCLUSIVE_WAITERS)); 5194e7f640dSJohn Baldwin if (x & SX_LOCK_SHARED_WAITERS) 520da7bbd2cSJohn Baldwin wakeup_swapper = sleepq_broadcast(&sx->lock_object, SLEEPQ_SX, 521da7bbd2cSJohn Baldwin 0, SQ_SHARED_QUEUE); 5224e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 523d55229b7SJason Evans 524da7bbd2cSJohn Baldwin if (wakeup_swapper) 525da7bbd2cSJohn Baldwin kick_proc0(); 52626d94f99SMark Johnston 52726d94f99SMark Johnston out: 5282466d12bSMateusz Guzik curthread->td_sx_slocks++; 52926d94f99SMark Johnston LOCK_LOG_LOCK("XDOWNGRADE", &sx->lock_object, 0, 0, file, line); 53026d94f99SMark Johnston LOCKSTAT_RECORD0(sx__downgrade, sx); 5314e7f640dSJohn Baldwin } 532d55229b7SJason Evans 533013c0b49SMateusz Guzik void 534013c0b49SMateusz Guzik sx_downgrade_(struct sx *sx, const char *file, int line) 535013c0b49SMateusz Guzik { 536013c0b49SMateusz Guzik 537013c0b49SMateusz Guzik sx_downgrade_int(sx LOCK_FILE_LINE_ARG); 538013c0b49SMateusz Guzik } 539013c0b49SMateusz Guzik 5402466d12bSMateusz Guzik #ifdef ADAPTIVE_SX 5412466d12bSMateusz Guzik static inline void 5422466d12bSMateusz Guzik sx_drop_critical(uintptr_t x, bool *in_critical, int *extra_work) 5432466d12bSMateusz Guzik { 5442466d12bSMateusz Guzik 5452466d12bSMateusz Guzik if (x & SX_LOCK_WRITE_SPINNER) 5462466d12bSMateusz Guzik return; 5472466d12bSMateusz Guzik if (*in_critical) { 5482466d12bSMateusz Guzik critical_exit(); 5492466d12bSMateusz Guzik *in_critical = false; 5502466d12bSMateusz Guzik (*extra_work)--; 5512466d12bSMateusz Guzik } 5522466d12bSMateusz Guzik } 5532466d12bSMateusz Guzik #else 5542466d12bSMateusz Guzik #define sx_drop_critical(x, in_critical, extra_work) do { } while(0) 5552466d12bSMateusz Guzik #endif 5562466d12bSMateusz Guzik 5574e7f640dSJohn Baldwin /* 5584e7f640dSJohn Baldwin * This function represents the so-called 'hard case' for sx_xlock 5594e7f640dSJohn Baldwin * operation. All 'easy case' failures are redirected to this. Note 5604e7f640dSJohn Baldwin * that ideally this would be a static function, but it needs to be 5614e7f640dSJohn Baldwin * accessible from at least sx.h. 5624e7f640dSJohn Baldwin */ 563f9819486SAttilio Rao int 564013c0b49SMateusz Guzik _sx_xlock_hard(struct sx *sx, uintptr_t x, int opts LOCK_FILE_LINE_ARG_DEF) 5654e7f640dSJohn Baldwin { 5664e7f640dSJohn Baldwin GIANT_DECLARE; 5672466d12bSMateusz Guzik uintptr_t tid, setx; 5684e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 5694e7f640dSJohn Baldwin volatile struct thread *owner; 570d07e22cdSMateusz Guzik u_int i, n, spintries = 0; 5711dce110fSMatt Macy enum { READERS, WRITER } sleep_reason = READERS; 5722466d12bSMateusz Guzik bool in_critical = false; 5734e7f640dSJohn Baldwin #endif 5741723a064SJeff Roberson #ifdef LOCK_PROFILING 5751723a064SJeff Roberson uint64_t waittime = 0; 5761723a064SJeff Roberson int contested = 0; 5771723a064SJeff Roberson #endif 5781723a064SJeff Roberson int error = 0; 57904126895SMateusz Guzik #if defined(ADAPTIVE_SX) || defined(KDTRACE_HOOKS) 5801ada9041SMateusz Guzik struct lock_delay_arg lda; 5811ada9041SMateusz Guzik #endif 582a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 58361852185SMateusz Guzik u_int sleep_cnt = 0; 584a5aedd68SStacey Son int64_t sleep_time = 0; 585076dd8ebSAndriy Gapon int64_t all_time = 0; 586a5aedd68SStacey Son #endif 587e41d6166SMateusz Guzik #if defined(KDTRACE_HOOKS) || defined(LOCK_PROFILING) 5881dce110fSMatt Macy uintptr_t state = 0; 5892466d12bSMateusz Guzik int doing_lockprof = 0; 590e41d6166SMateusz Guzik #endif 591284194f1SMateusz Guzik int extra_work = 0; 5924e7f640dSJohn Baldwin 593013c0b49SMateusz Guzik tid = (uintptr_t)curthread; 59409bdec20SMateusz Guzik 59509bdec20SMateusz Guzik #ifdef KDTRACE_HOOKS 59609bdec20SMateusz Guzik if (LOCKSTAT_PROFILE_ENABLED(sx__acquire)) { 59709bdec20SMateusz Guzik while (x == SX_LOCK_UNLOCKED) { 59809bdec20SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, tid)) 59909bdec20SMateusz Guzik goto out_lockstat; 60009bdec20SMateusz Guzik } 60109bdec20SMateusz Guzik extra_work = 1; 6022466d12bSMateusz Guzik doing_lockprof = 1; 60309bdec20SMateusz Guzik all_time -= lockstat_nsecs(&sx->lock_object); 60409bdec20SMateusz Guzik state = x; 60509bdec20SMateusz Guzik } 60609bdec20SMateusz Guzik #endif 60709bdec20SMateusz Guzik #ifdef LOCK_PROFILING 60809bdec20SMateusz Guzik extra_work = 1; 6092466d12bSMateusz Guzik doing_lockprof = 1; 61009bdec20SMateusz Guzik state = x; 61109bdec20SMateusz Guzik #endif 61209bdec20SMateusz Guzik 61335370593SAndriy Gapon if (SCHEDULER_STOPPED()) 61435370593SAndriy Gapon return (0); 61535370593SAndriy Gapon 616fa5000a4SMateusz Guzik #if defined(ADAPTIVE_SX) 6171ada9041SMateusz Guzik lock_delay_arg_init(&lda, &sx_delay); 618fa5000a4SMateusz Guzik #elif defined(KDTRACE_HOOKS) 619fa5000a4SMateusz Guzik lock_delay_arg_init(&lda, NULL); 6201ada9041SMateusz Guzik #endif 6211ada9041SMateusz Guzik 622c1aaf63cSMateusz Guzik if (__predict_false(x == SX_LOCK_UNLOCKED)) 623c1aaf63cSMateusz Guzik x = SX_READ_VALUE(sx); 624c1aaf63cSMateusz Guzik 6254e7f640dSJohn Baldwin /* If we already hold an exclusive lock, then recurse. */ 626c5f61e6fSMateusz Guzik if (__predict_false(lv_sx_owner(x) == (struct thread *)tid)) { 627f0830182SAttilio Rao KASSERT((sx->lock_object.lo_flags & LO_RECURSABLE) != 0, 628b0d67325SJohn Baldwin ("_sx_xlock_hard: recursed on non-recursive sx %s @ %s:%d\n", 629b0d67325SJohn Baldwin sx->lock_object.lo_name, file, line)); 6304e7f640dSJohn Baldwin sx->sx_recurse++; 6314e7f640dSJohn Baldwin atomic_set_ptr(&sx->sx_lock, SX_LOCK_RECURSED); 6324e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 6334e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p recursing", __func__, sx); 634f9819486SAttilio Rao return (0); 6354e7f640dSJohn Baldwin } 6364e7f640dSJohn Baldwin 6374e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 6384e7f640dSJohn Baldwin CTR5(KTR_LOCK, "%s: %s contested (lock=%p) at %s:%d", __func__, 6394e7f640dSJohn Baldwin sx->lock_object.lo_name, (void *)sx->sx_lock, file, line); 6404e7f640dSJohn Baldwin 641ae7d25a4SMateusz Guzik #ifdef HWPMC_HOOKS 642ae7d25a4SMateusz Guzik PMC_SOFT_CALL( , , lock, failed); 643ae7d25a4SMateusz Guzik #endif 644ae7d25a4SMateusz Guzik lock_profile_obtain_lock_failed(&sx->lock_object, &contested, 645ae7d25a4SMateusz Guzik &waittime); 646ae7d25a4SMateusz Guzik 647fb106123SMateusz Guzik #ifndef INVARIANTS 648fb106123SMateusz Guzik GIANT_SAVE(extra_work); 649fb106123SMateusz Guzik #endif 650e41d6166SMateusz Guzik 651fc4f686dSMateusz Guzik for (;;) { 652c5f61e6fSMateusz Guzik if (x == SX_LOCK_UNLOCKED) { 653fa474043SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, tid)) 654fc4f686dSMateusz Guzik break; 655c5f61e6fSMateusz Guzik continue; 656c5f61e6fSMateusz Guzik } 657fb106123SMateusz Guzik #ifdef INVARIANTS 658fb106123SMateusz Guzik GIANT_SAVE(extra_work); 659fb106123SMateusz Guzik #endif 660a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 6611ada9041SMateusz Guzik lda.spin_cnt++; 662a5aedd68SStacey Son #endif 6634e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 664*befd3e35SMateusz Guzik if (x == (SX_LOCK_SHARED | SX_LOCK_WRITE_SPINNER)) { 665*befd3e35SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, tid)) 666*befd3e35SMateusz Guzik break; 667*befd3e35SMateusz Guzik continue; 668*befd3e35SMateusz Guzik } 669*befd3e35SMateusz Guzik 6704e7f640dSJohn Baldwin /* 6714e7f640dSJohn Baldwin * If the lock is write locked and the owner is 6724e7f640dSJohn Baldwin * running on another CPU, spin until the owner stops 6734e7f640dSJohn Baldwin * running or the state of the lock changes. 6744e7f640dSJohn Baldwin */ 6751ae1c2a3SAttilio Rao if ((x & SX_LOCK_SHARED) == 0) { 6762466d12bSMateusz Guzik sx_drop_critical(x, &in_critical, &extra_work); 677d94df98cSMateusz Guzik sleep_reason = WRITER; 678c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 679d94df98cSMateusz Guzik if (!TD_IS_RUNNING(owner)) 680d94df98cSMateusz Guzik goto sleepq; 6814e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 682d94df98cSMateusz Guzik CTR3(KTR_LOCK, "%s: spinning on %p held by %p", 6834e7f640dSJohn Baldwin __func__, sx, owner); 684d94df98cSMateusz Guzik KTR_STATE1(KTR_SCHED, "thread", sched_tdname(curthread), 685d94df98cSMateusz Guzik "spinning", "lockname:\"%s\"", 6862cba8dd3SJohn Baldwin sx->lock_object.lo_name); 687c5f61e6fSMateusz Guzik do { 6881ada9041SMateusz Guzik lock_delay(&lda); 689c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 690c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 691d94df98cSMateusz Guzik } while (owner != NULL && TD_IS_RUNNING(owner)); 692d94df98cSMateusz Guzik KTR_STATE0(KTR_SCHED, "thread", sched_tdname(curthread), 693d94df98cSMateusz Guzik "running"); 6944e7f640dSJohn Baldwin continue; 695d94df98cSMateusz Guzik } else if (SX_SHARERS(x) > 0) { 696d94df98cSMateusz Guzik sleep_reason = READERS; 697d94df98cSMateusz Guzik if (spintries == asx_retries) 698d94df98cSMateusz Guzik goto sleepq; 6992466d12bSMateusz Guzik if (!(x & SX_LOCK_WRITE_SPINNER)) { 7002466d12bSMateusz Guzik if (!in_critical) { 7012466d12bSMateusz Guzik critical_enter(); 7022466d12bSMateusz Guzik in_critical = true; 7032466d12bSMateusz Guzik extra_work++; 7042466d12bSMateusz Guzik } 7052466d12bSMateusz Guzik if (!atomic_fcmpset_ptr(&sx->sx_lock, &x, 7062466d12bSMateusz Guzik x | SX_LOCK_WRITE_SPINNER)) { 7072466d12bSMateusz Guzik critical_exit(); 7082466d12bSMateusz Guzik in_critical = false; 7092466d12bSMateusz Guzik extra_work--; 7102466d12bSMateusz Guzik continue; 7112466d12bSMateusz Guzik } 7122466d12bSMateusz Guzik } 7131ae1c2a3SAttilio Rao spintries++; 714d94df98cSMateusz Guzik KTR_STATE1(KTR_SCHED, "thread", sched_tdname(curthread), 715d94df98cSMateusz Guzik "spinning", "lockname:\"%s\"", 716d94df98cSMateusz Guzik sx->lock_object.lo_name); 717d07e22cdSMateusz Guzik n = SX_SHARERS(x); 7182466d12bSMateusz Guzik for (i = 0; i < asx_loops; i += n) { 719d07e22cdSMateusz Guzik lock_delay_spin(n); 72020a15d17SMateusz Guzik x = SX_READ_VALUE(sx); 7212466d12bSMateusz Guzik if (!(x & SX_LOCK_WRITE_SPINNER)) 7222466d12bSMateusz Guzik break; 7232466d12bSMateusz Guzik if (!(x & SX_LOCK_SHARED)) 7242466d12bSMateusz Guzik break; 7252466d12bSMateusz Guzik n = SX_SHARERS(x); 7262466d12bSMateusz Guzik if (n == 0) 7271ae1c2a3SAttilio Rao break; 7281ae1c2a3SAttilio Rao } 72920a15d17SMateusz Guzik #ifdef KDTRACE_HOOKS 73020a15d17SMateusz Guzik lda.spin_cnt += i; 73120a15d17SMateusz Guzik #endif 732d94df98cSMateusz Guzik KTR_STATE0(KTR_SCHED, "thread", sched_tdname(curthread), 733d94df98cSMateusz Guzik "running"); 734efa9f177SMateusz Guzik if (i < asx_loops) 7351ae1c2a3SAttilio Rao continue; 7361ae1c2a3SAttilio Rao } 737fb106123SMateusz Guzik sleepq: 738cde25ed4SMateusz Guzik #endif 7394e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 740c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 74193118b62SMateusz Guzik retry_sleepq: 7424e7f640dSJohn Baldwin 7434e7f640dSJohn Baldwin /* 7444e7f640dSJohn Baldwin * If the lock was released while spinning on the 7454e7f640dSJohn Baldwin * sleep queue chain lock, try again. 7464e7f640dSJohn Baldwin */ 7474e7f640dSJohn Baldwin if (x == SX_LOCK_UNLOCKED) { 7484e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 7492466d12bSMateusz Guzik sx_drop_critical(x, &in_critical, &extra_work); 7504e7f640dSJohn Baldwin continue; 7514e7f640dSJohn Baldwin } 7524e7f640dSJohn Baldwin 7534e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 7544e7f640dSJohn Baldwin /* 7554e7f640dSJohn Baldwin * The current lock owner might have started executing 7564e7f640dSJohn Baldwin * on another CPU (or the lock could have changed 7574e7f640dSJohn Baldwin * owners) while we were waiting on the sleep queue 7584e7f640dSJohn Baldwin * chain lock. If so, drop the sleep queue lock and try 7594e7f640dSJohn Baldwin * again. 7604e7f640dSJohn Baldwin */ 76128f1a9e3SMateusz Guzik if (!(x & SX_LOCK_SHARED)) { 7624e7f640dSJohn Baldwin owner = (struct thread *)SX_OWNER(x); 7634e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 7644e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 7652466d12bSMateusz Guzik sx_drop_critical(x, &in_critical, 7662466d12bSMateusz Guzik &extra_work); 7674e7f640dSJohn Baldwin continue; 7684e7f640dSJohn Baldwin } 769d94df98cSMateusz Guzik } else if (SX_SHARERS(x) > 0 && sleep_reason == WRITER) { 77028f1a9e3SMateusz Guzik sleepq_release(&sx->lock_object); 7712466d12bSMateusz Guzik sx_drop_critical(x, &in_critical, &extra_work); 77228f1a9e3SMateusz Guzik continue; 77328f1a9e3SMateusz Guzik } 7744e7f640dSJohn Baldwin #endif 7754e7f640dSJohn Baldwin 7764e7f640dSJohn Baldwin /* 7774e7f640dSJohn Baldwin * If an exclusive lock was released with both shared 7784e7f640dSJohn Baldwin * and exclusive waiters and a shared waiter hasn't 7794e7f640dSJohn Baldwin * woken up and acquired the lock yet, sx_lock will be 7804e7f640dSJohn Baldwin * set to SX_LOCK_UNLOCKED | SX_LOCK_EXCLUSIVE_WAITERS. 7814e7f640dSJohn Baldwin * If we see that value, try to acquire it once. Note 7824e7f640dSJohn Baldwin * that we have to preserve SX_LOCK_EXCLUSIVE_WAITERS 7834e7f640dSJohn Baldwin * as there are other exclusive waiters still. If we 7844e7f640dSJohn Baldwin * fail, restart the loop. 7854e7f640dSJohn Baldwin */ 7862466d12bSMateusz Guzik setx = x & (SX_LOCK_WAITERS | SX_LOCK_WRITE_SPINNER); 7872466d12bSMateusz Guzik if ((x & ~setx) == SX_LOCK_SHARED) { 7882466d12bSMateusz Guzik setx &= ~SX_LOCK_WRITE_SPINNER; 7892466d12bSMateusz Guzik if (!atomic_fcmpset_acq_ptr(&sx->sx_lock, &x, tid | setx)) 79093118b62SMateusz Guzik goto retry_sleepq; 7914e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 7924e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p claimed by new writer", 7934e7f640dSJohn Baldwin __func__, sx); 7944e7f640dSJohn Baldwin break; 7954e7f640dSJohn Baldwin } 7964e7f640dSJohn Baldwin 7972466d12bSMateusz Guzik #ifdef ADAPTIVE_SX 7982466d12bSMateusz Guzik /* 7992466d12bSMateusz Guzik * It is possible we set the SX_LOCK_WRITE_SPINNER bit. 8002466d12bSMateusz Guzik * It is an invariant that when the bit is set, there is 8012466d12bSMateusz Guzik * a writer ready to grab the lock. Thus clear the bit since 8022466d12bSMateusz Guzik * we are going to sleep. 8032466d12bSMateusz Guzik */ 8042466d12bSMateusz Guzik if (in_critical) { 8052466d12bSMateusz Guzik if ((x & SX_LOCK_WRITE_SPINNER) || 8062466d12bSMateusz Guzik !((x & SX_LOCK_EXCLUSIVE_WAITERS))) { 8072466d12bSMateusz Guzik setx = x & ~SX_LOCK_WRITE_SPINNER; 8082466d12bSMateusz Guzik setx |= SX_LOCK_EXCLUSIVE_WAITERS; 8092466d12bSMateusz Guzik if (!atomic_fcmpset_ptr(&sx->sx_lock, &x, 8102466d12bSMateusz Guzik setx)) { 8112466d12bSMateusz Guzik goto retry_sleepq; 8122466d12bSMateusz Guzik } 8132466d12bSMateusz Guzik } 8142466d12bSMateusz Guzik critical_exit(); 8152466d12bSMateusz Guzik in_critical = false; 8162466d12bSMateusz Guzik } else { 8172466d12bSMateusz Guzik #endif 8184e7f640dSJohn Baldwin /* 8194e7f640dSJohn Baldwin * Try to set the SX_LOCK_EXCLUSIVE_WAITERS. If we fail, 8204e7f640dSJohn Baldwin * than loop back and retry. 8214e7f640dSJohn Baldwin */ 8224e7f640dSJohn Baldwin if (!(x & SX_LOCK_EXCLUSIVE_WAITERS)) { 82393118b62SMateusz Guzik if (!atomic_fcmpset_ptr(&sx->sx_lock, &x, 8244e7f640dSJohn Baldwin x | SX_LOCK_EXCLUSIVE_WAITERS)) { 82593118b62SMateusz Guzik goto retry_sleepq; 8264e7f640dSJohn Baldwin } 8274e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 8284e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p set excl waiters flag", 8294e7f640dSJohn Baldwin __func__, sx); 8304e7f640dSJohn Baldwin } 8312466d12bSMateusz Guzik #ifdef ADAPTIVE_SX 8322466d12bSMateusz Guzik } 8332466d12bSMateusz Guzik #endif 8344e7f640dSJohn Baldwin 8354e7f640dSJohn Baldwin /* 8364e7f640dSJohn Baldwin * Since we have been unable to acquire the exclusive 8374e7f640dSJohn Baldwin * lock and the exclusive waiters flag is set, we have 8384e7f640dSJohn Baldwin * to sleep. 8394e7f640dSJohn Baldwin */ 8404e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 8414e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p blocking on sleep queue", 8424e7f640dSJohn Baldwin __func__, sx); 8434e7f640dSJohn Baldwin 844a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 845e2b25737SMark Johnston sleep_time -= lockstat_nsecs(&sx->lock_object); 846a5aedd68SStacey Son #endif 8474e7f640dSJohn Baldwin sleepq_add(&sx->lock_object, NULL, sx->lock_object.lo_name, 848f9819486SAttilio Rao SLEEPQ_SX | ((opts & SX_INTERRUPTIBLE) ? 849f9819486SAttilio Rao SLEEPQ_INTERRUPTIBLE : 0), SQ_EXCLUSIVE_QUEUE); 850f9819486SAttilio Rao if (!(opts & SX_INTERRUPTIBLE)) 851c5aa6b58SJeff Roberson sleepq_wait(&sx->lock_object, 0); 852f9819486SAttilio Rao else 853c5aa6b58SJeff Roberson error = sleepq_wait_sig(&sx->lock_object, 0); 854a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 855e2b25737SMark Johnston sleep_time += lockstat_nsecs(&sx->lock_object); 856a5aedd68SStacey Son sleep_cnt++; 857a5aedd68SStacey Son #endif 858f9819486SAttilio Rao if (error) { 859f9819486SAttilio Rao if (LOCK_LOG_TEST(&sx->lock_object, 0)) 860f9819486SAttilio Rao CTR2(KTR_LOCK, 861f9819486SAttilio Rao "%s: interruptible sleep by %p suspended by signal", 862f9819486SAttilio Rao __func__, sx); 863f9819486SAttilio Rao break; 864f9819486SAttilio Rao } 8654e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 8664e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p resuming from sleep queue", 8674e7f640dSJohn Baldwin __func__, sx); 868c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 8694e7f640dSJohn Baldwin } 870e41d6166SMateusz Guzik if (__predict_true(!extra_work)) 871e41d6166SMateusz Guzik return (error); 8722466d12bSMateusz Guzik #ifdef ADAPTIVE_SX 8732466d12bSMateusz Guzik if (in_critical) 8742466d12bSMateusz Guzik critical_exit(); 8752466d12bSMateusz Guzik #endif 876ee252fc9SMateusz Guzik GIANT_RESTORE(); 8772466d12bSMateusz Guzik #if defined(KDTRACE_HOOKS) || defined(LOCK_PROFILING) 8782466d12bSMateusz Guzik if (__predict_true(!doing_lockprof)) 8792466d12bSMateusz Guzik return (error); 880e41d6166SMateusz Guzik #endif 881076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 882e2b25737SMark Johnston all_time += lockstat_nsecs(&sx->lock_object); 883076dd8ebSAndriy Gapon if (sleep_time) 88432cd0147SMark Johnston LOCKSTAT_RECORD4(sx__block, sx, sleep_time, 885076dd8ebSAndriy Gapon LOCKSTAT_WRITER, (state & SX_LOCK_SHARED) == 0, 886076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 8871ada9041SMateusz Guzik if (lda.spin_cnt > sleep_cnt) 88832cd0147SMark Johnston LOCKSTAT_RECORD4(sx__spin, sx, all_time - sleep_time, 889076dd8ebSAndriy Gapon LOCKSTAT_WRITER, (state & SX_LOCK_SHARED) == 0, 890076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 89109bdec20SMateusz Guzik out_lockstat: 892076dd8ebSAndriy Gapon #endif 893f9819486SAttilio Rao if (!error) 894de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, sx, 895de2c95ccSMark Johnston contested, waittime, file, line, LOCKSTAT_WRITER); 896f9819486SAttilio Rao return (error); 8974e7f640dSJohn Baldwin } 8984e7f640dSJohn Baldwin 8994e7f640dSJohn Baldwin /* 9004e7f640dSJohn Baldwin * This function represents the so-called 'hard case' for sx_xunlock 9014e7f640dSJohn Baldwin * operation. All 'easy case' failures are redirected to this. Note 9024e7f640dSJohn Baldwin * that ideally this would be a static function, but it needs to be 9034e7f640dSJohn Baldwin * accessible from at least sx.h. 9044e7f640dSJohn Baldwin */ 9054e7f640dSJohn Baldwin void 906b584eb2eSMateusz Guzik _sx_xunlock_hard(struct sx *sx, uintptr_t x LOCK_FILE_LINE_ARG_DEF) 9074e7f640dSJohn Baldwin { 908b584eb2eSMateusz Guzik uintptr_t tid, setx; 909da7bbd2cSJohn Baldwin int queue, wakeup_swapper; 9104e7f640dSJohn Baldwin 91135370593SAndriy Gapon if (SCHEDULER_STOPPED()) 91235370593SAndriy Gapon return; 91335370593SAndriy Gapon 914b584eb2eSMateusz Guzik tid = (uintptr_t)curthread; 9154e7f640dSJohn Baldwin 916b584eb2eSMateusz Guzik if (__predict_false(x == tid)) 9173b3cf014SMateusz Guzik x = SX_READ_VALUE(sx); 918b584eb2eSMateusz Guzik 919b584eb2eSMateusz Guzik MPASS(!(x & SX_LOCK_SHARED)); 920b584eb2eSMateusz Guzik 921b584eb2eSMateusz Guzik if (__predict_false(x & SX_LOCK_RECURSED)) { 9226ebb77b6SMateusz Guzik /* The lock is recursed, unrecurse one level. */ 9234e7f640dSJohn Baldwin if ((--sx->sx_recurse) == 0) 9244e7f640dSJohn Baldwin atomic_clear_ptr(&sx->sx_lock, SX_LOCK_RECURSED); 9254e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 9264e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p unrecursing", __func__, sx); 9274e7f640dSJohn Baldwin return; 9284e7f640dSJohn Baldwin } 9293b3cf014SMateusz Guzik 9303b3cf014SMateusz Guzik LOCKSTAT_PROFILE_RELEASE_RWLOCK(sx__release, sx, LOCKSTAT_WRITER); 9313b3cf014SMateusz Guzik if (x == tid && 9323b3cf014SMateusz Guzik atomic_cmpset_rel_ptr(&sx->sx_lock, tid, SX_LOCK_UNLOCKED)) 9333b3cf014SMateusz Guzik return; 9343b3cf014SMateusz Guzik 9354e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 9364e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p contested", __func__, sx); 9374e7f640dSJohn Baldwin 9384e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 939bc24577cSMateusz Guzik x = SX_READ_VALUE(sx); 9402d96bd88SMateusz Guzik MPASS(x & (SX_LOCK_SHARED_WAITERS | SX_LOCK_EXCLUSIVE_WAITERS)); 9414e7f640dSJohn Baldwin 9424e7f640dSJohn Baldwin /* 9434e7f640dSJohn Baldwin * The wake up algorithm here is quite simple and probably not 9444e7f640dSJohn Baldwin * ideal. It gives precedence to shared waiters if they are 9454e7f640dSJohn Baldwin * present. For this condition, we have to preserve the 9464e7f640dSJohn Baldwin * state of the exclusive waiters flag. 9472028867dSAttilio Rao * If interruptible sleeps left the shared queue empty avoid a 9482028867dSAttilio Rao * starvation for the threads sleeping on the exclusive queue by giving 9492028867dSAttilio Rao * them precedence and cleaning up the shared waiters bit anyway. 9504e7f640dSJohn Baldwin */ 951bc24577cSMateusz Guzik setx = SX_LOCK_UNLOCKED; 9524e7f640dSJohn Baldwin queue = SQ_SHARED_QUEUE; 9532466d12bSMateusz Guzik if ((x & SX_LOCK_EXCLUSIVE_WAITERS) != 0 && 9542466d12bSMateusz Guzik sleepq_sleepcnt(&sx->lock_object, SQ_EXCLUSIVE_QUEUE) != 0) { 9552466d12bSMateusz Guzik queue = SQ_EXCLUSIVE_QUEUE; 9562466d12bSMateusz Guzik setx |= (x & SX_LOCK_SHARED_WAITERS); 957bc24577cSMateusz Guzik } 958bc24577cSMateusz Guzik atomic_store_rel_ptr(&sx->sx_lock, setx); 9594e7f640dSJohn Baldwin 9604e7f640dSJohn Baldwin /* Wake up all the waiters for the specific queue. */ 9614e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 9624e7f640dSJohn Baldwin CTR3(KTR_LOCK, "%s: %p waking up all threads on %s queue", 9634e7f640dSJohn Baldwin __func__, sx, queue == SQ_SHARED_QUEUE ? "shared" : 9644e7f640dSJohn Baldwin "exclusive"); 965bc24577cSMateusz Guzik 966da7bbd2cSJohn Baldwin wakeup_swapper = sleepq_broadcast(&sx->lock_object, SLEEPQ_SX, 0, 967da7bbd2cSJohn Baldwin queue); 968c5aa6b58SJeff Roberson sleepq_release(&sx->lock_object); 969da7bbd2cSJohn Baldwin if (wakeup_swapper) 970da7bbd2cSJohn Baldwin kick_proc0(); 9714e7f640dSJohn Baldwin } 9724e7f640dSJohn Baldwin 973834f70f3SMateusz Guzik static bool __always_inline 9742466d12bSMateusz Guzik __sx_can_read(struct thread *td, uintptr_t x, bool fp) 9752466d12bSMateusz Guzik { 9762466d12bSMateusz Guzik 9772466d12bSMateusz Guzik if ((x & (SX_LOCK_SHARED | SX_LOCK_EXCLUSIVE_WAITERS | SX_LOCK_WRITE_SPINNER)) 9782466d12bSMateusz Guzik == SX_LOCK_SHARED) 9792466d12bSMateusz Guzik return (true); 9802466d12bSMateusz Guzik if (!fp && td->td_sx_slocks && (x & SX_LOCK_SHARED)) 9812466d12bSMateusz Guzik return (true); 9822466d12bSMateusz Guzik return (false); 9832466d12bSMateusz Guzik } 9842466d12bSMateusz Guzik 9852466d12bSMateusz Guzik static bool __always_inline 9862466d12bSMateusz Guzik __sx_slock_try(struct sx *sx, struct thread *td, uintptr_t *xp, bool fp 9872466d12bSMateusz Guzik LOCK_FILE_LINE_ARG_DEF) 988834f70f3SMateusz Guzik { 989834f70f3SMateusz Guzik 990834f70f3SMateusz Guzik /* 991834f70f3SMateusz Guzik * If no other thread has an exclusive lock then try to bump up 992834f70f3SMateusz Guzik * the count of sharers. Since we have to preserve the state 993834f70f3SMateusz Guzik * of SX_LOCK_EXCLUSIVE_WAITERS, if we fail to acquire the 994834f70f3SMateusz Guzik * shared lock loop back and retry. 995834f70f3SMateusz Guzik */ 9962466d12bSMateusz Guzik while (__sx_can_read(td, *xp, fp)) { 997834f70f3SMateusz Guzik if (atomic_fcmpset_acq_ptr(&sx->sx_lock, xp, 998834f70f3SMateusz Guzik *xp + SX_ONE_SHARER)) { 999834f70f3SMateusz Guzik if (LOCK_LOG_TEST(&sx->lock_object, 0)) 1000834f70f3SMateusz Guzik CTR4(KTR_LOCK, "%s: %p succeed %p -> %p", 1001834f70f3SMateusz Guzik __func__, sx, (void *)*xp, 1002834f70f3SMateusz Guzik (void *)(*xp + SX_ONE_SHARER)); 10032466d12bSMateusz Guzik td->td_sx_slocks++; 1004834f70f3SMateusz Guzik return (true); 1005834f70f3SMateusz Guzik } 1006834f70f3SMateusz Guzik } 1007834f70f3SMateusz Guzik return (false); 1008834f70f3SMateusz Guzik } 1009834f70f3SMateusz Guzik 1010834f70f3SMateusz Guzik static int __noinline 1011013c0b49SMateusz Guzik _sx_slock_hard(struct sx *sx, int opts, uintptr_t x LOCK_FILE_LINE_ARG_DEF) 10124e7f640dSJohn Baldwin { 10134e7f640dSJohn Baldwin GIANT_DECLARE; 10142466d12bSMateusz Guzik struct thread *td; 10154e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 10164e7f640dSJohn Baldwin volatile struct thread *owner; 10172466d12bSMateusz Guzik u_int i, n, spintries = 0; 10184e7f640dSJohn Baldwin #endif 10191723a064SJeff Roberson #ifdef LOCK_PROFILING 1020c1a6d9faSAttilio Rao uint64_t waittime = 0; 1021c1a6d9faSAttilio Rao int contested = 0; 10221723a064SJeff Roberson #endif 1023c1a6d9faSAttilio Rao int error = 0; 102404126895SMateusz Guzik #if defined(ADAPTIVE_SX) || defined(KDTRACE_HOOKS) 10251ada9041SMateusz Guzik struct lock_delay_arg lda; 10261ada9041SMateusz Guzik #endif 1027a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 102861852185SMateusz Guzik u_int sleep_cnt = 0; 1029a5aedd68SStacey Son int64_t sleep_time = 0; 1030076dd8ebSAndriy Gapon int64_t all_time = 0; 1031a5aedd68SStacey Son #endif 1032e41d6166SMateusz Guzik #if defined(KDTRACE_HOOKS) || defined(LOCK_PROFILING) 10331dce110fSMatt Macy uintptr_t state = 0; 1034e41d6166SMateusz Guzik #endif 1035284194f1SMateusz Guzik int extra_work = 0; 1036c1a6d9faSAttilio Rao 10372466d12bSMateusz Guzik td = curthread; 10382466d12bSMateusz Guzik 103909bdec20SMateusz Guzik #ifdef KDTRACE_HOOKS 104009bdec20SMateusz Guzik if (LOCKSTAT_PROFILE_ENABLED(sx__acquire)) { 10412466d12bSMateusz Guzik if (__sx_slock_try(sx, td, &x, false LOCK_FILE_LINE_ARG)) 104209bdec20SMateusz Guzik goto out_lockstat; 104309bdec20SMateusz Guzik extra_work = 1; 104409bdec20SMateusz Guzik all_time -= lockstat_nsecs(&sx->lock_object); 104509bdec20SMateusz Guzik state = x; 104609bdec20SMateusz Guzik } 104709bdec20SMateusz Guzik #endif 104809bdec20SMateusz Guzik #ifdef LOCK_PROFILING 104909bdec20SMateusz Guzik extra_work = 1; 105009bdec20SMateusz Guzik state = x; 105109bdec20SMateusz Guzik #endif 105209bdec20SMateusz Guzik 105335370593SAndriy Gapon if (SCHEDULER_STOPPED()) 105435370593SAndriy Gapon return (0); 105535370593SAndriy Gapon 1056fa5000a4SMateusz Guzik #if defined(ADAPTIVE_SX) 10571ada9041SMateusz Guzik lock_delay_arg_init(&lda, &sx_delay); 1058fa5000a4SMateusz Guzik #elif defined(KDTRACE_HOOKS) 1059fa5000a4SMateusz Guzik lock_delay_arg_init(&lda, NULL); 10601ada9041SMateusz Guzik #endif 1061e41d6166SMateusz Guzik 1062ae7d25a4SMateusz Guzik #ifdef HWPMC_HOOKS 1063ae7d25a4SMateusz Guzik PMC_SOFT_CALL( , , lock, failed); 1064ae7d25a4SMateusz Guzik #endif 1065ae7d25a4SMateusz Guzik lock_profile_obtain_lock_failed(&sx->lock_object, &contested, 1066ae7d25a4SMateusz Guzik &waittime); 1067ae7d25a4SMateusz Guzik 1068fb106123SMateusz Guzik #ifndef INVARIANTS 1069fb106123SMateusz Guzik GIANT_SAVE(extra_work); 1070fb106123SMateusz Guzik #endif 1071076dd8ebSAndriy Gapon 10724e7f640dSJohn Baldwin /* 10734e7f640dSJohn Baldwin * As with rwlocks, we don't make any attempt to try to block 10744e7f640dSJohn Baldwin * shared locks once there is an exclusive waiter. 10754e7f640dSJohn Baldwin */ 10764e7f640dSJohn Baldwin for (;;) { 10772466d12bSMateusz Guzik if (__sx_slock_try(sx, td, &x, false LOCK_FILE_LINE_ARG)) 10784e7f640dSJohn Baldwin break; 1079fb106123SMateusz Guzik #ifdef INVARIANTS 1080fb106123SMateusz Guzik GIANT_SAVE(extra_work); 1081fb106123SMateusz Guzik #endif 1082c5f61e6fSMateusz Guzik #ifdef KDTRACE_HOOKS 1083c5f61e6fSMateusz Guzik lda.spin_cnt++; 1084c5f61e6fSMateusz Guzik #endif 1085c5f61e6fSMateusz Guzik 10864e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 10874e7f640dSJohn Baldwin /* 10884e7f640dSJohn Baldwin * If the owner is running on another CPU, spin until 10894e7f640dSJohn Baldwin * the owner stops running or the state of the lock 10904e7f640dSJohn Baldwin * changes. 10914e7f640dSJohn Baldwin */ 10922466d12bSMateusz Guzik if ((x & SX_LOCK_SHARED) == 0) { 1093c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 10944e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 10954e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 10964e7f640dSJohn Baldwin CTR3(KTR_LOCK, 10974e7f640dSJohn Baldwin "%s: spinning on %p held by %p", 10984e7f640dSJohn Baldwin __func__, sx, owner); 10992cba8dd3SJohn Baldwin KTR_STATE1(KTR_SCHED, "thread", 11002cba8dd3SJohn Baldwin sched_tdname(curthread), "spinning", 11012cba8dd3SJohn Baldwin "lockname:\"%s\"", sx->lock_object.lo_name); 1102c5f61e6fSMateusz Guzik do { 11031ada9041SMateusz Guzik lock_delay(&lda); 1104c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 1105c5f61e6fSMateusz Guzik owner = lv_sx_owner(x); 1106c5f61e6fSMateusz Guzik } while (owner != NULL && TD_IS_RUNNING(owner)); 11072cba8dd3SJohn Baldwin KTR_STATE0(KTR_SCHED, "thread", 11082cba8dd3SJohn Baldwin sched_tdname(curthread), "running"); 11094e7f640dSJohn Baldwin continue; 11104e7f640dSJohn Baldwin } 11112466d12bSMateusz Guzik } else { 11122466d12bSMateusz Guzik if ((x & SX_LOCK_WRITE_SPINNER) && SX_SHARERS(x) == 0) { 11132466d12bSMateusz Guzik MPASS(!__sx_can_read(td, x, false)); 11142466d12bSMateusz Guzik lock_delay_spin(2); 11152466d12bSMateusz Guzik x = SX_READ_VALUE(sx); 11162466d12bSMateusz Guzik continue; 11172466d12bSMateusz Guzik } 11182466d12bSMateusz Guzik if (spintries < asx_retries) { 11192466d12bSMateusz Guzik KTR_STATE1(KTR_SCHED, "thread", sched_tdname(curthread), 11202466d12bSMateusz Guzik "spinning", "lockname:\"%s\"", 11212466d12bSMateusz Guzik sx->lock_object.lo_name); 11222466d12bSMateusz Guzik n = SX_SHARERS(x); 11232466d12bSMateusz Guzik for (i = 0; i < asx_loops; i += n) { 11242466d12bSMateusz Guzik lock_delay_spin(n); 11252466d12bSMateusz Guzik x = SX_READ_VALUE(sx); 11262466d12bSMateusz Guzik if (!(x & SX_LOCK_SHARED)) 11272466d12bSMateusz Guzik break; 11282466d12bSMateusz Guzik n = SX_SHARERS(x); 11292466d12bSMateusz Guzik if (n == 0) 11302466d12bSMateusz Guzik break; 11312466d12bSMateusz Guzik if (__sx_can_read(td, x, false)) 11322466d12bSMateusz Guzik break; 11332466d12bSMateusz Guzik } 11342466d12bSMateusz Guzik #ifdef KDTRACE_HOOKS 11352466d12bSMateusz Guzik lda.spin_cnt += i; 11362466d12bSMateusz Guzik #endif 11372466d12bSMateusz Guzik KTR_STATE0(KTR_SCHED, "thread", sched_tdname(curthread), 11382466d12bSMateusz Guzik "running"); 11392466d12bSMateusz Guzik if (i < asx_loops) 11402466d12bSMateusz Guzik continue; 11412466d12bSMateusz Guzik } 11422466d12bSMateusz Guzik } 11434e7f640dSJohn Baldwin #endif 11444e7f640dSJohn Baldwin 11454e7f640dSJohn Baldwin /* 11464e7f640dSJohn Baldwin * Some other thread already has an exclusive lock, so 11474e7f640dSJohn Baldwin * start the process of blocking. 11484e7f640dSJohn Baldwin */ 11494e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 1150c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 115193118b62SMateusz Guzik retry_sleepq: 11522466d12bSMateusz Guzik if (((x & SX_LOCK_WRITE_SPINNER) && SX_SHARERS(x) == 0) || 11532466d12bSMateusz Guzik __sx_can_read(td, x, false)) { 11544e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 11554e7f640dSJohn Baldwin continue; 11564e7f640dSJohn Baldwin } 11574e7f640dSJohn Baldwin 11584e7f640dSJohn Baldwin #ifdef ADAPTIVE_SX 11594e7f640dSJohn Baldwin /* 11604e7f640dSJohn Baldwin * If the owner is running on another CPU, spin until 11614e7f640dSJohn Baldwin * the owner stops running or the state of the lock 11624e7f640dSJohn Baldwin * changes. 11634e7f640dSJohn Baldwin */ 1164f26db694SMateusz Guzik if (!(x & SX_LOCK_SHARED)) { 11654e7f640dSJohn Baldwin owner = (struct thread *)SX_OWNER(x); 11664e7f640dSJohn Baldwin if (TD_IS_RUNNING(owner)) { 11674e7f640dSJohn Baldwin sleepq_release(&sx->lock_object); 1168c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 11694e7f640dSJohn Baldwin continue; 11704e7f640dSJohn Baldwin } 11714e7f640dSJohn Baldwin } 11724e7f640dSJohn Baldwin #endif 11734e7f640dSJohn Baldwin 11744e7f640dSJohn Baldwin /* 11754e7f640dSJohn Baldwin * Try to set the SX_LOCK_SHARED_WAITERS flag. If we 11764e7f640dSJohn Baldwin * fail to set it drop the sleep queue lock and loop 11774e7f640dSJohn Baldwin * back. 11784e7f640dSJohn Baldwin */ 11794e7f640dSJohn Baldwin if (!(x & SX_LOCK_SHARED_WAITERS)) { 118093118b62SMateusz Guzik if (!atomic_fcmpset_ptr(&sx->sx_lock, &x, 118193118b62SMateusz Guzik x | SX_LOCK_SHARED_WAITERS)) 118293118b62SMateusz Guzik goto retry_sleepq; 11834e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 11844e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p set shared waiters flag", 11854e7f640dSJohn Baldwin __func__, sx); 11864e7f640dSJohn Baldwin } 11874e7f640dSJohn Baldwin 11884e7f640dSJohn Baldwin /* 11894e7f640dSJohn Baldwin * Since we have been unable to acquire the shared lock, 11904e7f640dSJohn Baldwin * we have to sleep. 11914e7f640dSJohn Baldwin */ 11924e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 11934e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p blocking on sleep queue", 11944e7f640dSJohn Baldwin __func__, sx); 11954e7f640dSJohn Baldwin 1196a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 1197e2b25737SMark Johnston sleep_time -= lockstat_nsecs(&sx->lock_object); 1198a5aedd68SStacey Son #endif 11994e7f640dSJohn Baldwin sleepq_add(&sx->lock_object, NULL, sx->lock_object.lo_name, 1200f9819486SAttilio Rao SLEEPQ_SX | ((opts & SX_INTERRUPTIBLE) ? 1201f9819486SAttilio Rao SLEEPQ_INTERRUPTIBLE : 0), SQ_SHARED_QUEUE); 1202f9819486SAttilio Rao if (!(opts & SX_INTERRUPTIBLE)) 1203c5aa6b58SJeff Roberson sleepq_wait(&sx->lock_object, 0); 1204f9819486SAttilio Rao else 1205c5aa6b58SJeff Roberson error = sleepq_wait_sig(&sx->lock_object, 0); 1206a5aedd68SStacey Son #ifdef KDTRACE_HOOKS 1207e2b25737SMark Johnston sleep_time += lockstat_nsecs(&sx->lock_object); 1208a5aedd68SStacey Son sleep_cnt++; 1209a5aedd68SStacey Son #endif 1210f9819486SAttilio Rao if (error) { 1211f9819486SAttilio Rao if (LOCK_LOG_TEST(&sx->lock_object, 0)) 1212f9819486SAttilio Rao CTR2(KTR_LOCK, 1213f9819486SAttilio Rao "%s: interruptible sleep by %p suspended by signal", 1214f9819486SAttilio Rao __func__, sx); 1215f9819486SAttilio Rao break; 1216f9819486SAttilio Rao } 12174e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 12184e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p resuming from sleep queue", 12194e7f640dSJohn Baldwin __func__, sx); 1220c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 12214e7f640dSJohn Baldwin } 1222e41d6166SMateusz Guzik #if defined(KDTRACE_HOOKS) || defined(LOCK_PROFILING) 1223e41d6166SMateusz Guzik if (__predict_true(!extra_work)) 1224e41d6166SMateusz Guzik return (error); 1225e41d6166SMateusz Guzik #endif 1226076dd8ebSAndriy Gapon #ifdef KDTRACE_HOOKS 1227e2b25737SMark Johnston all_time += lockstat_nsecs(&sx->lock_object); 1228076dd8ebSAndriy Gapon if (sleep_time) 122932cd0147SMark Johnston LOCKSTAT_RECORD4(sx__block, sx, sleep_time, 1230076dd8ebSAndriy Gapon LOCKSTAT_READER, (state & SX_LOCK_SHARED) == 0, 1231076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 12321ada9041SMateusz Guzik if (lda.spin_cnt > sleep_cnt) 123332cd0147SMark Johnston LOCKSTAT_RECORD4(sx__spin, sx, all_time - sleep_time, 1234076dd8ebSAndriy Gapon LOCKSTAT_READER, (state & SX_LOCK_SHARED) == 0, 1235076dd8ebSAndriy Gapon (state & SX_LOCK_SHARED) == 0 ? 0 : SX_SHARERS(state)); 123609bdec20SMateusz Guzik out_lockstat: 1237076dd8ebSAndriy Gapon #endif 12383ae56ce9SMateusz Guzik if (error == 0) { 1239de2c95ccSMark Johnston LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(sx__acquire, sx, 1240de2c95ccSMark Johnston contested, waittime, file, line, LOCKSTAT_READER); 12413ae56ce9SMateusz Guzik } 12424e7f640dSJohn Baldwin GIANT_RESTORE(); 1243f9819486SAttilio Rao return (error); 12444e7f640dSJohn Baldwin } 12454e7f640dSJohn Baldwin 1246834f70f3SMateusz Guzik int 1247013c0b49SMateusz Guzik _sx_slock_int(struct sx *sx, int opts LOCK_FILE_LINE_ARG_DEF) 12484e7f640dSJohn Baldwin { 12492466d12bSMateusz Guzik struct thread *td; 12504e7f640dSJohn Baldwin uintptr_t x; 1251834f70f3SMateusz Guzik int error; 12524e7f640dSJohn Baldwin 1253704cb42fSMark Johnston KASSERT(kdb_active != 0 || SCHEDULER_STOPPED() || 1254704cb42fSMark Johnston !TD_IS_IDLETHREAD(curthread), 1255834f70f3SMateusz Guzik ("sx_slock() by idle thread %p on sx %s @ %s:%d", 1256834f70f3SMateusz Guzik curthread, sx->lock_object.lo_name, file, line)); 12573ae56ce9SMateusz Guzik KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 1258834f70f3SMateusz Guzik ("sx_slock() of destroyed sx @ %s:%d", file, line)); 1259834f70f3SMateusz Guzik WITNESS_CHECKORDER(&sx->lock_object, LOP_NEWORDER, file, line, NULL); 1260834f70f3SMateusz Guzik 1261834f70f3SMateusz Guzik error = 0; 12622466d12bSMateusz Guzik td = curthread; 1263c5f61e6fSMateusz Guzik x = SX_READ_VALUE(sx); 1264e4ccf57fSMateusz Guzik if (__predict_false(LOCKSTAT_PROFILE_ENABLED(sx__acquire) || 12652466d12bSMateusz Guzik !__sx_slock_try(sx, td, &x, true LOCK_FILE_LINE_ARG))) 1266013c0b49SMateusz Guzik error = _sx_slock_hard(sx, opts, x LOCK_FILE_LINE_ARG); 1267e4ccf57fSMateusz Guzik else 1268e4ccf57fSMateusz Guzik lock_profile_obtain_lock_success(&sx->lock_object, 0, 0, 1269e4ccf57fSMateusz Guzik file, line); 1270834f70f3SMateusz Guzik if (error == 0) { 1271834f70f3SMateusz Guzik LOCK_LOG_LOCK("SLOCK", &sx->lock_object, 0, 0, file, line); 1272834f70f3SMateusz Guzik WITNESS_LOCK(&sx->lock_object, 0, file, line); 1273834f70f3SMateusz Guzik TD_LOCKS_INC(curthread); 1274834f70f3SMateusz Guzik } 1275834f70f3SMateusz Guzik return (error); 1276834f70f3SMateusz Guzik } 1277834f70f3SMateusz Guzik 1278013c0b49SMateusz Guzik int 1279013c0b49SMateusz Guzik _sx_slock(struct sx *sx, int opts, const char *file, int line) 1280013c0b49SMateusz Guzik { 1281013c0b49SMateusz Guzik 1282013c0b49SMateusz Guzik return (_sx_slock_int(sx, opts LOCK_FILE_LINE_ARG)); 1283013c0b49SMateusz Guzik } 1284013c0b49SMateusz Guzik 1285834f70f3SMateusz Guzik static bool __always_inline 12862466d12bSMateusz Guzik _sx_sunlock_try(struct sx *sx, struct thread *td, uintptr_t *xp) 1287834f70f3SMateusz Guzik { 1288834f70f3SMateusz Guzik 12894e7f640dSJohn Baldwin for (;;) { 12902466d12bSMateusz Guzik if (SX_SHARERS(*xp) > 1 || !(*xp & SX_LOCK_WAITERS)) { 1291834f70f3SMateusz Guzik if (atomic_fcmpset_rel_ptr(&sx->sx_lock, xp, 1292834f70f3SMateusz Guzik *xp - SX_ONE_SHARER)) { 12934e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 12944e7f640dSJohn Baldwin CTR4(KTR_LOCK, 12954e7f640dSJohn Baldwin "%s: %p succeeded %p -> %p", 1296834f70f3SMateusz Guzik __func__, sx, (void *)*xp, 1297834f70f3SMateusz Guzik (void *)(*xp - SX_ONE_SHARER)); 12982466d12bSMateusz Guzik td->td_sx_slocks--; 1299834f70f3SMateusz Guzik return (true); 13004e7f640dSJohn Baldwin } 13014e7f640dSJohn Baldwin continue; 13024e7f640dSJohn Baldwin } 1303834f70f3SMateusz Guzik break; 1304834f70f3SMateusz Guzik } 1305834f70f3SMateusz Guzik return (false); 1306834f70f3SMateusz Guzik } 1307834f70f3SMateusz Guzik 1308834f70f3SMateusz Guzik static void __noinline 13092466d12bSMateusz Guzik _sx_sunlock_hard(struct sx *sx, struct thread *td, uintptr_t x 13102466d12bSMateusz Guzik LOCK_FILE_LINE_ARG_DEF) 1311834f70f3SMateusz Guzik { 13121b54ffc8SMateusz Guzik int wakeup_swapper = 0; 13132466d12bSMateusz Guzik uintptr_t setx, queue; 1314834f70f3SMateusz Guzik 1315834f70f3SMateusz Guzik if (SCHEDULER_STOPPED()) 1316834f70f3SMateusz Guzik return; 1317834f70f3SMateusz Guzik 13182466d12bSMateusz Guzik if (_sx_sunlock_try(sx, td, &x)) 1319cec17473SMateusz Guzik goto out_lockstat; 13204e7f640dSJohn Baldwin 13214e7f640dSJohn Baldwin sleepq_lock(&sx->lock_object); 1322cec17473SMateusz Guzik x = SX_READ_VALUE(sx); 1323cec17473SMateusz Guzik for (;;) { 13242466d12bSMateusz Guzik if (_sx_sunlock_try(sx, td, &x)) 13251b54ffc8SMateusz Guzik break; 13261b54ffc8SMateusz Guzik 13274e7f640dSJohn Baldwin /* 13284e7f640dSJohn Baldwin * Wake up semantic here is quite simple: 13294e7f640dSJohn Baldwin * Just wake up all the exclusive waiters. 13304e7f640dSJohn Baldwin * Note that the state of the lock could have changed, 13314e7f640dSJohn Baldwin * so if it fails loop back and retry. 13324e7f640dSJohn Baldwin */ 13332466d12bSMateusz Guzik setx = SX_LOCK_UNLOCKED; 13342466d12bSMateusz Guzik queue = SQ_SHARED_QUEUE; 13352466d12bSMateusz Guzik if (x & SX_LOCK_EXCLUSIVE_WAITERS) { 13362466d12bSMateusz Guzik setx |= (x & SX_LOCK_SHARED_WAITERS); 13372466d12bSMateusz Guzik queue = SQ_EXCLUSIVE_QUEUE; 13382466d12bSMateusz Guzik } 13392466d12bSMateusz Guzik setx |= (x & SX_LOCK_WRITE_SPINNER); 1340cec17473SMateusz Guzik if (!atomic_fcmpset_rel_ptr(&sx->sx_lock, &x, setx)) 13414e7f640dSJohn Baldwin continue; 13424e7f640dSJohn Baldwin if (LOCK_LOG_TEST(&sx->lock_object, 0)) 13434e7f640dSJohn Baldwin CTR2(KTR_LOCK, "%s: %p waking up all thread on" 13444e7f640dSJohn Baldwin "exclusive queue", __func__, sx); 1345da7bbd2cSJohn Baldwin wakeup_swapper = sleepq_broadcast(&sx->lock_object, SLEEPQ_SX, 13462466d12bSMateusz Guzik 0, queue); 13472466d12bSMateusz Guzik td->td_sx_slocks--; 1348cec17473SMateusz Guzik break; 1349cec17473SMateusz Guzik } 1350c5aa6b58SJeff Roberson sleepq_release(&sx->lock_object); 1351da7bbd2cSJohn Baldwin if (wakeup_swapper) 1352da7bbd2cSJohn Baldwin kick_proc0(); 1353cec17473SMateusz Guzik out_lockstat: 1354dbe4541dSMark Johnston LOCKSTAT_PROFILE_RELEASE_RWLOCK(sx__release, sx, LOCKSTAT_READER); 1355834f70f3SMateusz Guzik } 1356834f70f3SMateusz Guzik 1357834f70f3SMateusz Guzik void 1358013c0b49SMateusz Guzik _sx_sunlock_int(struct sx *sx LOCK_FILE_LINE_ARG_DEF) 1359834f70f3SMateusz Guzik { 13602466d12bSMateusz Guzik struct thread *td; 1361834f70f3SMateusz Guzik uintptr_t x; 1362834f70f3SMateusz Guzik 1363834f70f3SMateusz Guzik KASSERT(sx->sx_lock != SX_LOCK_DESTROYED, 1364834f70f3SMateusz Guzik ("sx_sunlock() of destroyed sx @ %s:%d", file, line)); 1365834f70f3SMateusz Guzik _sx_assert(sx, SA_SLOCKED, file, line); 1366834f70f3SMateusz Guzik WITNESS_UNLOCK(&sx->lock_object, 0, file, line); 1367834f70f3SMateusz Guzik LOCK_LOG_LOCK("SUNLOCK", &sx->lock_object, 0, 0, file, line); 1368834f70f3SMateusz Guzik 13692466d12bSMateusz Guzik td = curthread; 1370834f70f3SMateusz Guzik x = SX_READ_VALUE(sx); 1371e4ccf57fSMateusz Guzik if (__predict_false(LOCKSTAT_PROFILE_ENABLED(sx__release) || 13722466d12bSMateusz Guzik !_sx_sunlock_try(sx, td, &x))) 13732466d12bSMateusz Guzik _sx_sunlock_hard(sx, td, x LOCK_FILE_LINE_ARG); 1374e4ccf57fSMateusz Guzik else 1375e4ccf57fSMateusz Guzik lock_profile_release_lock(&sx->lock_object); 1376834f70f3SMateusz Guzik 13773ae56ce9SMateusz Guzik TD_LOCKS_DEC(curthread); 1378d55229b7SJason Evans } 13794e5e677bSJohn Baldwin 1380013c0b49SMateusz Guzik void 1381013c0b49SMateusz Guzik _sx_sunlock(struct sx *sx, const char *file, int line) 1382013c0b49SMateusz Guzik { 1383013c0b49SMateusz Guzik 1384013c0b49SMateusz Guzik _sx_sunlock_int(sx LOCK_FILE_LINE_ARG); 1385013c0b49SMateusz Guzik } 1386013c0b49SMateusz Guzik 13874e5e677bSJohn Baldwin #ifdef INVARIANT_SUPPORT 1388781a35dfSJohn Baldwin #ifndef INVARIANTS 1389781a35dfSJohn Baldwin #undef _sx_assert 1390781a35dfSJohn Baldwin #endif 1391781a35dfSJohn Baldwin 13924e5e677bSJohn Baldwin /* 13934e5e677bSJohn Baldwin * In the non-WITNESS case, sx_assert() can only detect that at least 13944e5e677bSJohn Baldwin * *some* thread owns an slock, but it cannot guarantee that *this* 13954e5e677bSJohn Baldwin * thread owns an slock. 13964e5e677bSJohn Baldwin */ 13974e5e677bSJohn Baldwin void 1398d576deedSPawel Jakub Dawidek _sx_assert(const struct sx *sx, int what, const char *file, int line) 13994e5e677bSJohn Baldwin { 14004e7f640dSJohn Baldwin #ifndef WITNESS 14014e7f640dSJohn Baldwin int slocked = 0; 14024e7f640dSJohn Baldwin #endif 14034e5e677bSJohn Baldwin 1404d54474e6SEric van Gyzen if (SCHEDULER_STOPPED()) 140503129ba9SJohn Baldwin return; 14064e5e677bSJohn Baldwin switch (what) { 14077ec137e5SJohn Baldwin case SA_SLOCKED: 14087ec137e5SJohn Baldwin case SA_SLOCKED | SA_NOTRECURSED: 14097ec137e5SJohn Baldwin case SA_SLOCKED | SA_RECURSED: 14104e7f640dSJohn Baldwin #ifndef WITNESS 14114e7f640dSJohn Baldwin slocked = 1; 14124e7f640dSJohn Baldwin /* FALLTHROUGH */ 14134e7f640dSJohn Baldwin #endif 14147ec137e5SJohn Baldwin case SA_LOCKED: 14157ec137e5SJohn Baldwin case SA_LOCKED | SA_NOTRECURSED: 14167ec137e5SJohn Baldwin case SA_LOCKED | SA_RECURSED: 14174e5e677bSJohn Baldwin #ifdef WITNESS 1418aa89d8cdSJohn Baldwin witness_assert(&sx->lock_object, what, file, line); 14194e5e677bSJohn Baldwin #else 14204e7f640dSJohn Baldwin /* 14214e7f640dSJohn Baldwin * If some other thread has an exclusive lock or we 14224e7f640dSJohn Baldwin * have one and are asserting a shared lock, fail. 14234e7f640dSJohn Baldwin * Also, if no one has a lock at all, fail. 14244e7f640dSJohn Baldwin */ 14254e7f640dSJohn Baldwin if (sx->sx_lock == SX_LOCK_UNLOCKED || 14264e7f640dSJohn Baldwin (!(sx->sx_lock & SX_LOCK_SHARED) && (slocked || 14274e7f640dSJohn Baldwin sx_xholder(sx) != curthread))) 142803129ba9SJohn Baldwin panic("Lock %s not %slocked @ %s:%d\n", 14294e7f640dSJohn Baldwin sx->lock_object.lo_name, slocked ? "share " : "", 14304e7f640dSJohn Baldwin file, line); 14314e7f640dSJohn Baldwin 14324e7f640dSJohn Baldwin if (!(sx->sx_lock & SX_LOCK_SHARED)) { 14334e7f640dSJohn Baldwin if (sx_recursed(sx)) { 14347ec137e5SJohn Baldwin if (what & SA_NOTRECURSED) 14354e7f640dSJohn Baldwin panic("Lock %s recursed @ %s:%d\n", 14364e7f640dSJohn Baldwin sx->lock_object.lo_name, file, 14374e7f640dSJohn Baldwin line); 14387ec137e5SJohn Baldwin } else if (what & SA_RECURSED) 14394e7f640dSJohn Baldwin panic("Lock %s not recursed @ %s:%d\n", 14404e7f640dSJohn Baldwin sx->lock_object.lo_name, file, line); 14414e7f640dSJohn Baldwin } 14424e5e677bSJohn Baldwin #endif 14434e5e677bSJohn Baldwin break; 14447ec137e5SJohn Baldwin case SA_XLOCKED: 14457ec137e5SJohn Baldwin case SA_XLOCKED | SA_NOTRECURSED: 14467ec137e5SJohn Baldwin case SA_XLOCKED | SA_RECURSED: 14474e7f640dSJohn Baldwin if (sx_xholder(sx) != curthread) 144803129ba9SJohn Baldwin panic("Lock %s not exclusively locked @ %s:%d\n", 1449aa89d8cdSJohn Baldwin sx->lock_object.lo_name, file, line); 14504e7f640dSJohn Baldwin if (sx_recursed(sx)) { 14517ec137e5SJohn Baldwin if (what & SA_NOTRECURSED) 14524e7f640dSJohn Baldwin panic("Lock %s recursed @ %s:%d\n", 14534e7f640dSJohn Baldwin sx->lock_object.lo_name, file, line); 14547ec137e5SJohn Baldwin } else if (what & SA_RECURSED) 14554e7f640dSJohn Baldwin panic("Lock %s not recursed @ %s:%d\n", 14564e7f640dSJohn Baldwin sx->lock_object.lo_name, file, line); 14574e5e677bSJohn Baldwin break; 14587ec137e5SJohn Baldwin case SA_UNLOCKED: 145919b0efd3SPawel Jakub Dawidek #ifdef WITNESS 1460aa89d8cdSJohn Baldwin witness_assert(&sx->lock_object, what, file, line); 146119b0efd3SPawel Jakub Dawidek #else 1462f6739b1dSPawel Jakub Dawidek /* 14634e7f640dSJohn Baldwin * If we hold an exclusve lock fail. We can't 14644e7f640dSJohn Baldwin * reliably check to see if we hold a shared lock or 14654e7f640dSJohn Baldwin * not. 1466f6739b1dSPawel Jakub Dawidek */ 14674e7f640dSJohn Baldwin if (sx_xholder(sx) == curthread) 146803129ba9SJohn Baldwin panic("Lock %s exclusively locked @ %s:%d\n", 1469aa89d8cdSJohn Baldwin sx->lock_object.lo_name, file, line); 147019b0efd3SPawel Jakub Dawidek #endif 147119b0efd3SPawel Jakub Dawidek break; 14724e5e677bSJohn Baldwin default: 14734e5e677bSJohn Baldwin panic("Unknown sx lock assertion: %d @ %s:%d", what, file, 14744e5e677bSJohn Baldwin line); 14754e5e677bSJohn Baldwin } 14764e5e677bSJohn Baldwin } 14774e5e677bSJohn Baldwin #endif /* INVARIANT_SUPPORT */ 1478d272fe53SJohn Baldwin 1479d272fe53SJohn Baldwin #ifdef DDB 14804e7f640dSJohn Baldwin static void 1481d576deedSPawel Jakub Dawidek db_show_sx(const struct lock_object *lock) 1482d272fe53SJohn Baldwin { 1483d272fe53SJohn Baldwin struct thread *td; 1484d576deedSPawel Jakub Dawidek const struct sx *sx; 1485d272fe53SJohn Baldwin 1486d576deedSPawel Jakub Dawidek sx = (const struct sx *)lock; 1487d272fe53SJohn Baldwin 1488d272fe53SJohn Baldwin db_printf(" state: "); 14894e7f640dSJohn Baldwin if (sx->sx_lock == SX_LOCK_UNLOCKED) 14904e7f640dSJohn Baldwin db_printf("UNLOCKED\n"); 14910026c92cSJohn Baldwin else if (sx->sx_lock == SX_LOCK_DESTROYED) { 14920026c92cSJohn Baldwin db_printf("DESTROYED\n"); 14930026c92cSJohn Baldwin return; 14940026c92cSJohn Baldwin } else if (sx->sx_lock & SX_LOCK_SHARED) 14954e7f640dSJohn Baldwin db_printf("SLOCK: %ju\n", (uintmax_t)SX_SHARERS(sx->sx_lock)); 14964e7f640dSJohn Baldwin else { 14974e7f640dSJohn Baldwin td = sx_xholder(sx); 1498d272fe53SJohn Baldwin db_printf("XLOCK: %p (tid %d, pid %d, \"%s\")\n", td, 1499431f8906SJulian Elischer td->td_tid, td->td_proc->p_pid, td->td_name); 15004e7f640dSJohn Baldwin if (sx_recursed(sx)) 15014e7f640dSJohn Baldwin db_printf(" recursed: %d\n", sx->sx_recurse); 15024e7f640dSJohn Baldwin } 15034e7f640dSJohn Baldwin 15044e7f640dSJohn Baldwin db_printf(" waiters: "); 15054e7f640dSJohn Baldwin switch(sx->sx_lock & 15064e7f640dSJohn Baldwin (SX_LOCK_SHARED_WAITERS | SX_LOCK_EXCLUSIVE_WAITERS)) { 15074e7f640dSJohn Baldwin case SX_LOCK_SHARED_WAITERS: 15084e7f640dSJohn Baldwin db_printf("shared\n"); 15094e7f640dSJohn Baldwin break; 15104e7f640dSJohn Baldwin case SX_LOCK_EXCLUSIVE_WAITERS: 15114e7f640dSJohn Baldwin db_printf("exclusive\n"); 15124e7f640dSJohn Baldwin break; 15134e7f640dSJohn Baldwin case SX_LOCK_SHARED_WAITERS | SX_LOCK_EXCLUSIVE_WAITERS: 15144e7f640dSJohn Baldwin db_printf("exclusive and shared\n"); 15154e7f640dSJohn Baldwin break; 15164e7f640dSJohn Baldwin default: 15174e7f640dSJohn Baldwin db_printf("none\n"); 15184e7f640dSJohn Baldwin } 1519d272fe53SJohn Baldwin } 1520462a7addSJohn Baldwin 1521462a7addSJohn Baldwin /* 1522462a7addSJohn Baldwin * Check to see if a thread that is blocked on a sleep queue is actually 1523462a7addSJohn Baldwin * blocked on an sx lock. If so, output some details and return true. 1524462a7addSJohn Baldwin * If the lock has an exclusive owner, return that in *ownerp. 1525462a7addSJohn Baldwin */ 1526462a7addSJohn Baldwin int 1527462a7addSJohn Baldwin sx_chain(struct thread *td, struct thread **ownerp) 1528462a7addSJohn Baldwin { 1529462a7addSJohn Baldwin struct sx *sx; 1530462a7addSJohn Baldwin 1531462a7addSJohn Baldwin /* 15324e7f640dSJohn Baldwin * Check to see if this thread is blocked on an sx lock. 15334e7f640dSJohn Baldwin * First, we check the lock class. If that is ok, then we 15344e7f640dSJohn Baldwin * compare the lock name against the wait message. 1535462a7addSJohn Baldwin */ 15364e7f640dSJohn Baldwin sx = td->td_wchan; 15374e7f640dSJohn Baldwin if (LOCK_CLASS(&sx->lock_object) != &lock_class_sx || 15384e7f640dSJohn Baldwin sx->lock_object.lo_name != td->td_wmesg) 1539462a7addSJohn Baldwin return (0); 1540462a7addSJohn Baldwin 1541462a7addSJohn Baldwin /* We think we have an sx lock, so output some details. */ 1542462a7addSJohn Baldwin db_printf("blocked on sx \"%s\" ", td->td_wmesg); 15434e7f640dSJohn Baldwin *ownerp = sx_xholder(sx); 15444e7f640dSJohn Baldwin if (sx->sx_lock & SX_LOCK_SHARED) 15454e7f640dSJohn Baldwin db_printf("SLOCK (count %ju)\n", 15464e7f640dSJohn Baldwin (uintmax_t)SX_SHARERS(sx->sx_lock)); 15474e7f640dSJohn Baldwin else 1548462a7addSJohn Baldwin db_printf("XLOCK\n"); 1549462a7addSJohn Baldwin return (1); 1550462a7addSJohn Baldwin } 1551d272fe53SJohn Baldwin #endif 1552