7fbfba7bf8
than rely on the lockmgr support [1]: * bump the waiters only if the interlock is held * let brelvp() return the waiters count * rely on brelvp() instead than BUF_LOCKWAITERS() in order to check for the waiters number - Remove a namespace pollution introduced recently with lockmgr.h including lock.h by including lock.h directly in the consumers and making it mandatory for using lockmgr. - Modify flags accepted by lockinit(): * introduce LK_NOPROFILE which disables lock profiling for the specified lockmgr * introduce LK_QUIET which disables ktr tracing for the specified lockmgr [2] * disallow LK_SLEEPFAIL and LK_NOWAIT to be passed there so that it can only be used on a per-instance basis - Remove BUF_LOCKWAITERS() and lockwaiters() as they are no longer used This patch breaks KPI so __FreBSD_version will be bumped and manpages updated by further commits. Additively, 'struct buf' changes results in a disturbed ABI also. [2] Really, currently there is no ktr tracing in the lockmgr, but it will be added soon. [1] Submitted by: kib Tested by: pho, Andrea Barberio <insomniac at slackware dot it>
830 lines
24 KiB
C
830 lines
24 KiB
C
/*-
|
|
* Copyright (c) 1995
|
|
* The Regents of the University of California. All rights reserved.
|
|
*
|
|
* Copyright (C) 1997
|
|
* John S. Dyson. All rights reserved.
|
|
*
|
|
* This code contains ideas from software contributed to Berkeley by
|
|
* Avadis Tevanian, Jr., Michael Wayne Young, and the Mach Operating
|
|
* System project at Carnegie-Mellon University.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. All advertising materials mentioning features or use of this software
|
|
* must display the following acknowledgement:
|
|
* This product includes software developed by the University of
|
|
* California, Berkeley and its contributors.
|
|
* 4. Neither the name of the University nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*
|
|
* @(#)kern_lock.c 8.18 (Berkeley) 5/21/95
|
|
*/
|
|
|
|
#include <sys/cdefs.h>
|
|
__FBSDID("$FreeBSD$");
|
|
|
|
#include "opt_ddb.h"
|
|
#include "opt_global.h"
|
|
|
|
#include <sys/param.h>
|
|
#include <sys/kdb.h>
|
|
#include <sys/kernel.h>
|
|
#include <sys/ktr.h>
|
|
#include <sys/lock.h>
|
|
#include <sys/lockmgr.h>
|
|
#include <sys/mutex.h>
|
|
#include <sys/proc.h>
|
|
#include <sys/systm.h>
|
|
#include <sys/lock_profile.h>
|
|
#ifdef DEBUG_LOCKS
|
|
#include <sys/stack.h>
|
|
#endif
|
|
|
|
#define LOCKMGR_TRYOP(x) ((x) & LK_NOWAIT)
|
|
#define LOCKMGR_TRYW(x) (LOCKMGR_TRYOP((x)) ? LOP_TRYLOCK : 0)
|
|
#define LOCKMGR_UNHELD(x) (((x) & (LK_HAVE_EXCL | LK_SHARE_NONZERO)) == 0)
|
|
#define LOCKMGR_NOTOWNER(td) ((td) != curthread && (td) != LK_KERNPROC)
|
|
|
|
static void assert_lockmgr(struct lock_object *lock, int what);
|
|
#ifdef DDB
|
|
#include <ddb/ddb.h>
|
|
static void db_show_lockmgr(struct lock_object *lock);
|
|
#endif
|
|
static void lock_lockmgr(struct lock_object *lock, int how);
|
|
static int unlock_lockmgr(struct lock_object *lock);
|
|
|
|
struct lock_class lock_class_lockmgr = {
|
|
.lc_name = "lockmgr",
|
|
.lc_flags = LC_SLEEPLOCK | LC_SLEEPABLE | LC_RECURSABLE | LC_UPGRADABLE,
|
|
.lc_assert = assert_lockmgr,
|
|
#ifdef DDB
|
|
.lc_ddb_show = db_show_lockmgr,
|
|
#endif
|
|
.lc_lock = lock_lockmgr,
|
|
.lc_unlock = unlock_lockmgr,
|
|
};
|
|
|
|
#ifndef INVARIANTS
|
|
#define _lockmgr_assert(lkp, what, file, line)
|
|
#endif
|
|
|
|
/*
|
|
* Locking primitives implementation.
|
|
* Locks provide shared/exclusive sychronization.
|
|
*/
|
|
|
|
void
|
|
assert_lockmgr(struct lock_object *lock, int what)
|
|
{
|
|
|
|
panic("lockmgr locks do not support assertions");
|
|
}
|
|
|
|
void
|
|
lock_lockmgr(struct lock_object *lock, int how)
|
|
{
|
|
|
|
panic("lockmgr locks do not support sleep interlocking");
|
|
}
|
|
|
|
int
|
|
unlock_lockmgr(struct lock_object *lock)
|
|
{
|
|
|
|
panic("lockmgr locks do not support sleep interlocking");
|
|
}
|
|
|
|
#define COUNT(td, x) ((td)->td_locks += (x))
|
|
#define LK_ALL (LK_HAVE_EXCL | LK_WANT_EXCL | LK_WANT_UPGRADE | \
|
|
LK_SHARE_NONZERO | LK_WAIT_NONZERO)
|
|
|
|
static int acquire(struct lock **lkpp, int extflags, int wanted,
|
|
const char *wmesg, int prio, int timo, int *contested, uint64_t *waittime);
|
|
static int acquiredrain(struct lock *lkp, int extflags, const char *wmesg,
|
|
int prio, int timo);
|
|
|
|
static __inline void
|
|
sharelock(struct thread *td, struct lock *lkp, int incr) {
|
|
lkp->lk_flags |= LK_SHARE_NONZERO;
|
|
lkp->lk_sharecount += incr;
|
|
COUNT(td, incr);
|
|
}
|
|
|
|
static __inline void
|
|
shareunlock(struct thread *td, struct lock *lkp, int decr) {
|
|
|
|
KASSERT(lkp->lk_sharecount >= decr, ("shareunlock: count < decr"));
|
|
|
|
COUNT(td, -decr);
|
|
if (lkp->lk_sharecount == decr) {
|
|
lkp->lk_flags &= ~LK_SHARE_NONZERO;
|
|
if (lkp->lk_flags & (LK_WANT_UPGRADE | LK_WANT_EXCL)) {
|
|
wakeup(lkp);
|
|
}
|
|
lkp->lk_sharecount = 0;
|
|
} else {
|
|
lkp->lk_sharecount -= decr;
|
|
}
|
|
}
|
|
|
|
static int
|
|
acquire(struct lock **lkpp, int extflags, int wanted, const char *wmesg,
|
|
int prio, int timo, int *contested, uint64_t *waittime)
|
|
{
|
|
struct lock *lkp = *lkpp;
|
|
const char *iwmesg;
|
|
int error, iprio, itimo;
|
|
|
|
iwmesg = (wmesg != LK_WMESG_DEFAULT) ? wmesg : lkp->lk_wmesg;
|
|
iprio = (prio != LK_PRIO_DEFAULT) ? prio : lkp->lk_prio;
|
|
itimo = (timo != LK_TIMO_DEFAULT) ? timo : lkp->lk_timo;
|
|
|
|
CTR3(KTR_LOCK,
|
|
"acquire(): lkp == %p, extflags == 0x%x, wanted == 0x%x",
|
|
lkp, extflags, wanted);
|
|
|
|
if ((extflags & LK_NOWAIT) && (lkp->lk_flags & wanted))
|
|
return EBUSY;
|
|
error = 0;
|
|
if ((lkp->lk_flags & wanted) != 0)
|
|
lock_profile_obtain_lock_failed(&lkp->lk_object, contested, waittime);
|
|
|
|
while ((lkp->lk_flags & wanted) != 0) {
|
|
CTR2(KTR_LOCK,
|
|
"acquire(): lkp == %p, lk_flags == 0x%x sleeping",
|
|
lkp, lkp->lk_flags);
|
|
lkp->lk_flags |= LK_WAIT_NONZERO;
|
|
lkp->lk_waitcount++;
|
|
error = msleep(lkp, lkp->lk_interlock, iprio, iwmesg,
|
|
((extflags & LK_TIMELOCK) ? itimo : 0));
|
|
lkp->lk_waitcount--;
|
|
if (lkp->lk_waitcount == 0)
|
|
lkp->lk_flags &= ~LK_WAIT_NONZERO;
|
|
if (error)
|
|
break;
|
|
if (extflags & LK_SLEEPFAIL) {
|
|
error = ENOLCK;
|
|
break;
|
|
}
|
|
if (lkp->lk_newlock != NULL) {
|
|
mtx_lock(lkp->lk_newlock->lk_interlock);
|
|
mtx_unlock(lkp->lk_interlock);
|
|
if (lkp->lk_waitcount == 0)
|
|
wakeup((void *)(&lkp->lk_newlock));
|
|
*lkpp = lkp = lkp->lk_newlock;
|
|
}
|
|
}
|
|
mtx_assert(lkp->lk_interlock, MA_OWNED);
|
|
return (error);
|
|
}
|
|
|
|
/*
|
|
* Set, change, or release a lock.
|
|
*
|
|
* Shared requests increment the shared count. Exclusive requests set the
|
|
* LK_WANT_EXCL flag (preventing further shared locks), and wait for already
|
|
* accepted shared locks and shared-to-exclusive upgrades to go away.
|
|
*/
|
|
int
|
|
_lockmgr_args(struct lock *lkp, u_int flags, struct mtx *interlkp,
|
|
const char *wmesg, int prio, int timo, char *file, int line)
|
|
|
|
{
|
|
struct thread *td;
|
|
int error;
|
|
int extflags, lockflags;
|
|
int contested = 0;
|
|
uint64_t waitstart = 0;
|
|
|
|
error = 0;
|
|
td = curthread;
|
|
|
|
#ifdef INVARIANTS
|
|
if (lkp->lk_flags & LK_DESTROYED) {
|
|
if (flags & LK_INTERLOCK)
|
|
mtx_unlock(interlkp);
|
|
if (panicstr != NULL)
|
|
return (0);
|
|
panic("%s: %p lockmgr is destroyed", __func__, lkp);
|
|
}
|
|
#endif
|
|
mtx_lock(lkp->lk_interlock);
|
|
CTR6(KTR_LOCK,
|
|
"lockmgr(): lkp == %p (lk_wmesg == \"%s\"), owner == %p, exclusivecount == %d, flags == 0x%x, "
|
|
"td == %p", lkp, (wmesg != LK_WMESG_DEFAULT) ? wmesg :
|
|
lkp->lk_wmesg, lkp->lk_lockholder, lkp->lk_exclusivecount, flags,
|
|
td);
|
|
#ifdef DEBUG_LOCKS
|
|
{
|
|
struct stack stack; /* XXX */
|
|
stack_save(&stack);
|
|
CTRSTACK(KTR_LOCK, &stack, 0, 1);
|
|
}
|
|
#endif
|
|
|
|
if (flags & LK_INTERLOCK) {
|
|
mtx_assert(interlkp, MA_OWNED | MA_NOTRECURSED);
|
|
mtx_unlock(interlkp);
|
|
}
|
|
|
|
if ((flags & (LK_NOWAIT|LK_RELEASE)) == 0)
|
|
WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK,
|
|
&lkp->lk_interlock->lock_object,
|
|
"Acquiring lockmgr lock \"%s\"",
|
|
(wmesg != LK_WMESG_DEFAULT) ? wmesg : lkp->lk_wmesg);
|
|
|
|
if (panicstr != NULL) {
|
|
mtx_unlock(lkp->lk_interlock);
|
|
return (0);
|
|
}
|
|
if ((lkp->lk_flags & LK_NOSHARE) &&
|
|
(flags & LK_TYPE_MASK) == LK_SHARED) {
|
|
flags &= ~LK_TYPE_MASK;
|
|
flags |= LK_EXCLUSIVE;
|
|
}
|
|
extflags = (flags | lkp->lk_flags) & LK_EXTFLG_MASK;
|
|
|
|
switch (flags & LK_TYPE_MASK) {
|
|
|
|
case LK_SHARED:
|
|
if (!LOCKMGR_TRYOP(extflags))
|
|
WITNESS_CHECKORDER(&lkp->lk_object, LOP_NEWORDER, file,
|
|
line);
|
|
/*
|
|
* If we are not the exclusive lock holder, we have to block
|
|
* while there is an exclusive lock holder or while an
|
|
* exclusive lock request or upgrade request is in progress.
|
|
*
|
|
* However, if TDP_DEADLKTREAT is set, we override exclusive
|
|
* lock requests or upgrade requests ( but not the exclusive
|
|
* lock itself ).
|
|
*/
|
|
if (lkp->lk_lockholder != td) {
|
|
lockflags = LK_HAVE_EXCL;
|
|
if (!(td->td_pflags & TDP_DEADLKTREAT))
|
|
lockflags |= LK_WANT_EXCL | LK_WANT_UPGRADE;
|
|
error = acquire(&lkp, extflags, lockflags, wmesg,
|
|
prio, timo, &contested, &waitstart);
|
|
if (error)
|
|
break;
|
|
sharelock(td, lkp, 1);
|
|
if (lkp->lk_sharecount == 1)
|
|
lock_profile_obtain_lock_success(&lkp->lk_object, contested, waitstart, file, line);
|
|
WITNESS_LOCK(&lkp->lk_object, LOCKMGR_TRYW(extflags),
|
|
file, line);
|
|
|
|
#if defined(DEBUG_LOCKS)
|
|
stack_save(&lkp->lk_stack);
|
|
#endif
|
|
break;
|
|
}
|
|
/*
|
|
* We hold an exclusive lock, so downgrade it to shared.
|
|
* An alternative would be to fail with EDEADLK.
|
|
*/
|
|
/* FALLTHROUGH downgrade */
|
|
|
|
case LK_DOWNGRADE:
|
|
_lockmgr_assert(lkp, KA_XLOCKED, file, line);
|
|
sharelock(td, lkp, lkp->lk_exclusivecount);
|
|
WITNESS_DOWNGRADE(&lkp->lk_object, 0, file, line);
|
|
COUNT(td, -lkp->lk_exclusivecount);
|
|
lkp->lk_exclusivecount = 0;
|
|
lkp->lk_flags &= ~LK_HAVE_EXCL;
|
|
lkp->lk_lockholder = LK_NOPROC;
|
|
if (lkp->lk_waitcount)
|
|
wakeup((void *)lkp);
|
|
break;
|
|
|
|
case LK_UPGRADE:
|
|
/*
|
|
* Upgrade a shared lock to an exclusive one. If another
|
|
* shared lock has already requested an upgrade to an
|
|
* exclusive lock, our shared lock is released and an
|
|
* exclusive lock is requested (which will be granted
|
|
* after the upgrade). If we return an error, the file
|
|
* will always be unlocked.
|
|
*/
|
|
_lockmgr_assert(lkp, KA_SLOCKED, file, line);
|
|
shareunlock(td, lkp, 1);
|
|
if (lkp->lk_sharecount == 0)
|
|
lock_profile_release_lock(&lkp->lk_object);
|
|
/*
|
|
* If we are just polling, check to see if we will block.
|
|
*/
|
|
if ((extflags & LK_NOWAIT) &&
|
|
((lkp->lk_flags & LK_WANT_UPGRADE) ||
|
|
lkp->lk_sharecount > 1)) {
|
|
error = EBUSY;
|
|
WITNESS_UNLOCK(&lkp->lk_object, 0, file, line);
|
|
break;
|
|
}
|
|
if ((lkp->lk_flags & LK_WANT_UPGRADE) == 0) {
|
|
/*
|
|
* We are first shared lock to request an upgrade, so
|
|
* request upgrade and wait for the shared count to
|
|
* drop to zero, then take exclusive lock.
|
|
*/
|
|
lkp->lk_flags |= LK_WANT_UPGRADE;
|
|
error = acquire(&lkp, extflags, LK_SHARE_NONZERO, wmesg,
|
|
prio, timo, &contested, &waitstart);
|
|
lkp->lk_flags &= ~LK_WANT_UPGRADE;
|
|
|
|
if (error) {
|
|
if ((lkp->lk_flags & ( LK_WANT_EXCL | LK_WAIT_NONZERO)) == (LK_WANT_EXCL | LK_WAIT_NONZERO))
|
|
wakeup((void *)lkp);
|
|
WITNESS_UNLOCK(&lkp->lk_object, 0, file, line);
|
|
break;
|
|
}
|
|
if (lkp->lk_exclusivecount != 0)
|
|
panic("lockmgr: non-zero exclusive count");
|
|
lkp->lk_flags |= LK_HAVE_EXCL;
|
|
lkp->lk_lockholder = td;
|
|
lkp->lk_exclusivecount = 1;
|
|
WITNESS_UPGRADE(&lkp->lk_object, LOP_EXCLUSIVE |
|
|
LOP_TRYLOCK, file, line);
|
|
COUNT(td, 1);
|
|
lock_profile_obtain_lock_success(&lkp->lk_object, contested, waitstart, file, line);
|
|
#if defined(DEBUG_LOCKS)
|
|
stack_save(&lkp->lk_stack);
|
|
#endif
|
|
break;
|
|
}
|
|
/*
|
|
* Someone else has requested upgrade. Release our shared
|
|
* lock, awaken upgrade requestor if we are the last shared
|
|
* lock, then request an exclusive lock.
|
|
*/
|
|
WITNESS_UNLOCK(&lkp->lk_object, 0, file, line);
|
|
if ( (lkp->lk_flags & (LK_SHARE_NONZERO|LK_WAIT_NONZERO)) ==
|
|
LK_WAIT_NONZERO)
|
|
wakeup((void *)lkp);
|
|
/* FALLTHROUGH exclusive request */
|
|
|
|
case LK_EXCLUSIVE:
|
|
if (!LOCKMGR_TRYOP(extflags))
|
|
WITNESS_CHECKORDER(&lkp->lk_object, LOP_NEWORDER |
|
|
LOP_EXCLUSIVE, file, line);
|
|
if (lkp->lk_lockholder == td) {
|
|
/*
|
|
* Recursive lock.
|
|
*/
|
|
if ((extflags & (LK_NOWAIT | LK_CANRECURSE)) == 0)
|
|
panic("lockmgr: locking against myself");
|
|
if ((extflags & LK_CANRECURSE) != 0) {
|
|
lkp->lk_exclusivecount++;
|
|
WITNESS_LOCK(&lkp->lk_object, LOP_EXCLUSIVE |
|
|
LOCKMGR_TRYW(extflags), file, line);
|
|
COUNT(td, 1);
|
|
break;
|
|
}
|
|
}
|
|
/*
|
|
* If we are just polling, check to see if we will sleep.
|
|
*/
|
|
if ((extflags & LK_NOWAIT) &&
|
|
(lkp->lk_flags & (LK_HAVE_EXCL | LK_WANT_EXCL | LK_WANT_UPGRADE | LK_SHARE_NONZERO))) {
|
|
error = EBUSY;
|
|
break;
|
|
}
|
|
/*
|
|
* Try to acquire the want_exclusive flag.
|
|
*/
|
|
error = acquire(&lkp, extflags, (LK_HAVE_EXCL | LK_WANT_EXCL),
|
|
wmesg, prio, timo, &contested, &waitstart);
|
|
if (error)
|
|
break;
|
|
lkp->lk_flags |= LK_WANT_EXCL;
|
|
/*
|
|
* Wait for shared locks and upgrades to finish.
|
|
*/
|
|
error = acquire(&lkp, extflags, LK_HAVE_EXCL | LK_WANT_UPGRADE |
|
|
LK_SHARE_NONZERO, wmesg, prio, timo,
|
|
&contested, &waitstart);
|
|
lkp->lk_flags &= ~LK_WANT_EXCL;
|
|
if (error) {
|
|
if (lkp->lk_flags & LK_WAIT_NONZERO)
|
|
wakeup((void *)lkp);
|
|
break;
|
|
}
|
|
lkp->lk_flags |= LK_HAVE_EXCL;
|
|
lkp->lk_lockholder = td;
|
|
if (lkp->lk_exclusivecount != 0)
|
|
panic("lockmgr: non-zero exclusive count");
|
|
lkp->lk_exclusivecount = 1;
|
|
WITNESS_LOCK(&lkp->lk_object, LOP_EXCLUSIVE |
|
|
LOCKMGR_TRYW(extflags), file, line);
|
|
COUNT(td, 1);
|
|
lock_profile_obtain_lock_success(&lkp->lk_object, contested, waitstart, file, line);
|
|
#if defined(DEBUG_LOCKS)
|
|
stack_save(&lkp->lk_stack);
|
|
#endif
|
|
break;
|
|
|
|
case LK_RELEASE:
|
|
_lockmgr_assert(lkp, KA_LOCKED, file, line);
|
|
if (lkp->lk_exclusivecount != 0) {
|
|
if (lkp->lk_lockholder != LK_KERNPROC) {
|
|
WITNESS_UNLOCK(&lkp->lk_object, LOP_EXCLUSIVE,
|
|
file, line);
|
|
COUNT(td, -1);
|
|
}
|
|
if (lkp->lk_exclusivecount-- == 1) {
|
|
lkp->lk_flags &= ~LK_HAVE_EXCL;
|
|
lkp->lk_lockholder = LK_NOPROC;
|
|
lock_profile_release_lock(&lkp->lk_object);
|
|
}
|
|
} else if (lkp->lk_flags & LK_SHARE_NONZERO) {
|
|
WITNESS_UNLOCK(&lkp->lk_object, 0, file, line);
|
|
shareunlock(td, lkp, 1);
|
|
}
|
|
|
|
if (lkp->lk_flags & LK_WAIT_NONZERO)
|
|
wakeup((void *)lkp);
|
|
break;
|
|
|
|
case LK_DRAIN:
|
|
/*
|
|
* Check that we do not already hold the lock, as it can
|
|
* never drain if we do. Unfortunately, we have no way to
|
|
* check for holding a shared lock, but at least we can
|
|
* check for an exclusive one.
|
|
*/
|
|
if (!LOCKMGR_TRYOP(extflags))
|
|
WITNESS_CHECKORDER(&lkp->lk_object, LOP_NEWORDER |
|
|
LOP_EXCLUSIVE, file, line);
|
|
if (lkp->lk_lockholder == td)
|
|
panic("lockmgr: draining against myself");
|
|
|
|
error = acquiredrain(lkp, extflags, wmesg, prio, timo);
|
|
if (error)
|
|
break;
|
|
lkp->lk_flags |= LK_DRAINING | LK_HAVE_EXCL;
|
|
lkp->lk_lockholder = td;
|
|
lkp->lk_exclusivecount = 1;
|
|
WITNESS_LOCK(&lkp->lk_object, LOP_EXCLUSIVE |
|
|
LOCKMGR_TRYW(extflags), file, line);
|
|
COUNT(td, 1);
|
|
#if defined(DEBUG_LOCKS)
|
|
stack_save(&lkp->lk_stack);
|
|
#endif
|
|
break;
|
|
|
|
default:
|
|
mtx_unlock(lkp->lk_interlock);
|
|
panic("lockmgr: unknown locktype request %d",
|
|
flags & LK_TYPE_MASK);
|
|
/* NOTREACHED */
|
|
}
|
|
if ((lkp->lk_flags & LK_WAITDRAIN) &&
|
|
(lkp->lk_flags & (LK_HAVE_EXCL | LK_WANT_EXCL | LK_WANT_UPGRADE |
|
|
LK_SHARE_NONZERO | LK_WAIT_NONZERO)) == 0) {
|
|
lkp->lk_flags &= ~LK_WAITDRAIN;
|
|
wakeup((void *)&lkp->lk_flags);
|
|
}
|
|
mtx_unlock(lkp->lk_interlock);
|
|
return (error);
|
|
}
|
|
|
|
static int
|
|
acquiredrain(struct lock *lkp, int extflags, const char *wmesg, int prio,
|
|
int timo)
|
|
{
|
|
const char *iwmesg;
|
|
int error, iprio, itimo;
|
|
|
|
iwmesg = (wmesg != LK_WMESG_DEFAULT) ? wmesg : lkp->lk_wmesg;
|
|
iprio = (prio != LK_PRIO_DEFAULT) ? prio : lkp->lk_prio;
|
|
itimo = (timo != LK_TIMO_DEFAULT) ? timo : lkp->lk_timo;
|
|
|
|
if ((extflags & LK_NOWAIT) && (lkp->lk_flags & LK_ALL)) {
|
|
return EBUSY;
|
|
}
|
|
while (lkp->lk_flags & LK_ALL) {
|
|
lkp->lk_flags |= LK_WAITDRAIN;
|
|
error = msleep(&lkp->lk_flags, lkp->lk_interlock, iprio, iwmesg,
|
|
((extflags & LK_TIMELOCK) ? itimo : 0));
|
|
if (error)
|
|
return error;
|
|
if (extflags & LK_SLEEPFAIL) {
|
|
return ENOLCK;
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/*
|
|
* Initialize a lock; required before use.
|
|
*/
|
|
void
|
|
lockinit(lkp, prio, wmesg, timo, flags)
|
|
struct lock *lkp;
|
|
int prio;
|
|
const char *wmesg;
|
|
int timo;
|
|
int flags;
|
|
{
|
|
int iflags;
|
|
|
|
KASSERT((flags & (LK_NOWAIT | LK_SLEEPFAIL)) == 0,
|
|
("%s: Invalid flags passed with mask 0x%x", __func__,
|
|
flags & LK_EXTFLG_MASK));
|
|
CTR5(KTR_LOCK, "lockinit(): lkp == %p, prio == %d, wmesg == \"%s\", "
|
|
"timo == %d, flags = 0x%x\n", lkp, prio, wmesg, timo, flags);
|
|
|
|
lkp->lk_interlock = mtx_pool_alloc(mtxpool_lockbuilder);
|
|
lkp->lk_flags = (flags & LK_EXTFLG_MASK) & ~(LK_FUNC_MASK);
|
|
lkp->lk_sharecount = 0;
|
|
lkp->lk_waitcount = 0;
|
|
lkp->lk_exclusivecount = 0;
|
|
lkp->lk_prio = prio;
|
|
lkp->lk_timo = timo;
|
|
lkp->lk_lockholder = LK_NOPROC;
|
|
lkp->lk_newlock = NULL;
|
|
iflags = LO_RECURSABLE | LO_SLEEPABLE | LO_UPGRADABLE;
|
|
if (!(flags & LK_NODUP))
|
|
iflags |= LO_DUPOK;
|
|
if (flags & LK_NOPROFILE)
|
|
iflags |= LO_NOPROFILE;
|
|
if (!(flags & LK_NOWITNESS))
|
|
iflags |= LO_WITNESS;
|
|
if (flags & LK_QUIET)
|
|
iflags |= LO_QUIET;
|
|
#ifdef DEBUG_LOCKS
|
|
stack_zero(&lkp->lk_stack);
|
|
#endif
|
|
lock_init(&lkp->lk_object, &lock_class_lockmgr, wmesg, NULL, iflags);
|
|
}
|
|
|
|
/*
|
|
* Destroy a lock.
|
|
*/
|
|
void
|
|
lockdestroy(lkp)
|
|
struct lock *lkp;
|
|
{
|
|
|
|
CTR2(KTR_LOCK, "lockdestroy(): lkp == %p (lk_wmesg == \"%s\")",
|
|
lkp, lkp->lk_wmesg);
|
|
KASSERT((lkp->lk_flags & (LK_HAVE_EXCL | LK_SHARE_NONZERO)) == 0,
|
|
("lockmgr still held"));
|
|
KASSERT(lkp->lk_exclusivecount == 0, ("lockmgr still recursed"));
|
|
lkp->lk_flags = LK_DESTROYED;
|
|
lock_destroy(&lkp->lk_object);
|
|
}
|
|
|
|
/*
|
|
* Disown the lockmgr.
|
|
*/
|
|
void
|
|
_lockmgr_disown(struct lock *lkp, const char *file, int line)
|
|
{
|
|
struct thread *td;
|
|
|
|
td = curthread;
|
|
KASSERT(panicstr != NULL || (lkp->lk_flags & LK_DESTROYED) == 0,
|
|
("%s: %p lockmgr is destroyed", __func__, lkp));
|
|
_lockmgr_assert(lkp, KA_XLOCKED | KA_NOTRECURSED, file, line);
|
|
|
|
/*
|
|
* Drop the lock reference and switch the owner. This will result
|
|
* in an atomic operation like td_lock is only accessed by curthread
|
|
* and lk_lockholder only needs one write. Note also that the lock
|
|
* owner can be alredy KERNPROC, so in that case just skip the
|
|
* decrement.
|
|
*/
|
|
if (lkp->lk_lockholder == td) {
|
|
WITNESS_UNLOCK(&lkp->lk_object, LOP_EXCLUSIVE, file, line);
|
|
td->td_locks--;
|
|
}
|
|
lkp->lk_lockholder = LK_KERNPROC;
|
|
}
|
|
|
|
/*
|
|
* Determine the status of a lock.
|
|
*/
|
|
int
|
|
lockstatus(lkp)
|
|
struct lock *lkp;
|
|
{
|
|
int lock_type = 0;
|
|
int interlocked;
|
|
|
|
KASSERT((lkp->lk_flags & LK_DESTROYED) == 0,
|
|
("%s: %p lockmgr is destroyed", __func__, lkp));
|
|
|
|
if (!kdb_active) {
|
|
interlocked = 1;
|
|
mtx_lock(lkp->lk_interlock);
|
|
} else
|
|
interlocked = 0;
|
|
if (lkp->lk_exclusivecount != 0) {
|
|
if (lkp->lk_lockholder == curthread)
|
|
lock_type = LK_EXCLUSIVE;
|
|
else
|
|
lock_type = LK_EXCLOTHER;
|
|
} else if (lkp->lk_sharecount != 0)
|
|
lock_type = LK_SHARED;
|
|
if (interlocked)
|
|
mtx_unlock(lkp->lk_interlock);
|
|
return (lock_type);
|
|
}
|
|
|
|
/*
|
|
* Print out information about state of a lock. Used by VOP_PRINT
|
|
* routines to display status about contained locks.
|
|
*/
|
|
void
|
|
lockmgr_printinfo(lkp)
|
|
struct lock *lkp;
|
|
{
|
|
|
|
if (lkp->lk_sharecount)
|
|
printf(" lock type %s: SHARED (count %d)", lkp->lk_wmesg,
|
|
lkp->lk_sharecount);
|
|
else if (lkp->lk_flags & LK_HAVE_EXCL)
|
|
printf(" lock type %s: EXCL (count %d) by thread %p (pid %d)",
|
|
lkp->lk_wmesg, lkp->lk_exclusivecount,
|
|
lkp->lk_lockholder, lkp->lk_lockholder->td_proc->p_pid);
|
|
if (lkp->lk_waitcount > 0)
|
|
printf(" with %d pending", lkp->lk_waitcount);
|
|
#ifdef DEBUG_LOCKS
|
|
stack_print_ddb(&lkp->lk_stack);
|
|
#endif
|
|
}
|
|
|
|
#ifdef INVARIANT_SUPPORT
|
|
#ifndef INVARIANTS
|
|
#undef _lockmgr_assert
|
|
#endif
|
|
|
|
void
|
|
_lockmgr_assert(struct lock *lkp, int what, const char *file, int line)
|
|
{
|
|
struct thread *td;
|
|
u_int x;
|
|
int slocked = 0;
|
|
|
|
x = lkp->lk_flags;
|
|
td = lkp->lk_lockholder;
|
|
if (panicstr != NULL)
|
|
return;
|
|
switch (what) {
|
|
case KA_SLOCKED:
|
|
case KA_SLOCKED | KA_NOTRECURSED:
|
|
case KA_SLOCKED | KA_RECURSED:
|
|
slocked = 1;
|
|
case KA_LOCKED:
|
|
case KA_LOCKED | KA_NOTRECURSED:
|
|
case KA_LOCKED | KA_RECURSED:
|
|
#ifdef WITNESS
|
|
/*
|
|
* We cannot trust WITNESS if the lock is held in
|
|
* exclusive mode and a call to lockmgr_disown() happened.
|
|
* Workaround this skipping the check if the lock is
|
|
* held in exclusive mode even for the KA_LOCKED case.
|
|
*/
|
|
if (slocked || (x & LK_HAVE_EXCL) == 0) {
|
|
witness_assert(&lkp->lk_object, what, file, line);
|
|
break;
|
|
}
|
|
#endif
|
|
if (LOCKMGR_UNHELD(x) || ((x & LK_SHARE_NONZERO) == 0 &&
|
|
(slocked || LOCKMGR_NOTOWNER(td))))
|
|
panic("Lock %s not %slocked @ %s:%d\n",
|
|
lkp->lk_object.lo_name, slocked ? "share " : "",
|
|
file, line);
|
|
if ((x & LK_SHARE_NONZERO) == 0) {
|
|
if (lockmgr_recursed(lkp)) {
|
|
if (what & KA_NOTRECURSED)
|
|
panic("Lock %s recursed @ %s:%d\n",
|
|
lkp->lk_object.lo_name, file, line);
|
|
} else if (what & KA_RECURSED)
|
|
panic("Lock %s not recursed @ %s:%d\n",
|
|
lkp->lk_object.lo_name, file, line);
|
|
}
|
|
break;
|
|
case KA_XLOCKED:
|
|
case KA_XLOCKED | KA_NOTRECURSED:
|
|
case KA_XLOCKED | KA_RECURSED:
|
|
if ((x & LK_HAVE_EXCL) == 0 || LOCKMGR_NOTOWNER(td))
|
|
panic("Lock %s not exclusively locked @ %s:%d\n",
|
|
lkp->lk_object.lo_name, file, line);
|
|
if (lockmgr_recursed(lkp)) {
|
|
if (what & KA_NOTRECURSED)
|
|
panic("Lock %s recursed @ %s:%d\n",
|
|
lkp->lk_object.lo_name, file, line);
|
|
} else if (what & KA_RECURSED)
|
|
panic("Lock %s not recursed @ %s:%d\n",
|
|
lkp->lk_object.lo_name, file, line);
|
|
break;
|
|
case KA_UNLOCKED:
|
|
if (td == curthread || td == LK_KERNPROC)
|
|
panic("Lock %s exclusively locked @ %s:%d\n",
|
|
lkp->lk_object.lo_name, file, line);
|
|
break;
|
|
case KA_HELD:
|
|
case KA_UNHELD:
|
|
if (LOCKMGR_UNHELD(x)) {
|
|
if (what & KA_HELD)
|
|
panic("Lock %s not locked by anyone @ %s:%d\n",
|
|
lkp->lk_object.lo_name, file, line);
|
|
} else if (what & KA_UNHELD)
|
|
panic("Lock %s locked by someone @ %s:%d\n",
|
|
lkp->lk_object.lo_name, file, line);
|
|
break;
|
|
default:
|
|
panic("Unknown lockmgr lock assertion: 0x%x @ %s:%d", what,
|
|
file, line);
|
|
}
|
|
}
|
|
#endif /* INVARIANT_SUPPORT */
|
|
|
|
#ifdef DDB
|
|
/*
|
|
* Check to see if a thread that is blocked on a sleep queue is actually
|
|
* blocked on a 'struct lock'. If so, output some details and return true.
|
|
* If the lock has an exclusive owner, return that in *ownerp.
|
|
*/
|
|
int
|
|
lockmgr_chain(struct thread *td, struct thread **ownerp)
|
|
{
|
|
struct lock *lkp;
|
|
|
|
lkp = td->td_wchan;
|
|
|
|
/* Simple test to see if wchan points to a lockmgr lock. */
|
|
if (LOCK_CLASS(&lkp->lk_object) == &lock_class_lockmgr &&
|
|
lkp->lk_wmesg == td->td_wmesg)
|
|
goto ok;
|
|
|
|
/*
|
|
* If this thread is doing a DRAIN, then it would be asleep on
|
|
* &lkp->lk_flags rather than lkp.
|
|
*/
|
|
lkp = (struct lock *)((char *)td->td_wchan -
|
|
offsetof(struct lock, lk_flags));
|
|
if (LOCK_CLASS(&lkp->lk_object) == &lock_class_lockmgr &&
|
|
lkp->lk_wmesg == td->td_wmesg && (lkp->lk_flags & LK_WAITDRAIN))
|
|
goto ok;
|
|
|
|
/* Doen't seem to be a lockmgr lock. */
|
|
return (0);
|
|
|
|
ok:
|
|
/* Ok, we think we have a lockmgr lock, so output some details. */
|
|
db_printf("blocked on lk \"%s\" ", lkp->lk_wmesg);
|
|
if (lkp->lk_sharecount) {
|
|
db_printf("SHARED (count %d)\n", lkp->lk_sharecount);
|
|
*ownerp = NULL;
|
|
} else {
|
|
db_printf("EXCL (count %d)\n", lkp->lk_exclusivecount);
|
|
*ownerp = lkp->lk_lockholder;
|
|
}
|
|
return (1);
|
|
}
|
|
|
|
void
|
|
db_show_lockmgr(struct lock_object *lock)
|
|
{
|
|
struct thread *td;
|
|
struct lock *lkp;
|
|
|
|
lkp = (struct lock *)lock;
|
|
|
|
db_printf(" lock type: %s\n", lkp->lk_wmesg);
|
|
db_printf(" state: ");
|
|
if (lkp->lk_sharecount)
|
|
db_printf("SHARED (count %d)\n", lkp->lk_sharecount);
|
|
else if (lkp->lk_flags & LK_HAVE_EXCL) {
|
|
td = lkp->lk_lockholder;
|
|
db_printf("EXCL (count %d) %p ", lkp->lk_exclusivecount, td);
|
|
db_printf("(tid %d, pid %d, \"%s\")\n", td->td_tid,
|
|
td->td_proc->p_pid, td->td_name);
|
|
} else
|
|
db_printf("UNLOCKED\n");
|
|
if (lkp->lk_waitcount > 0)
|
|
db_printf(" waiters: %d\n", lkp->lk_waitcount);
|
|
}
|
|
#endif
|