* The Regents of the University of California. 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.
* %sccs.include.redist.c%
* @(#)kern_lock.c 8.14 (Berkeley) %G%
* Locking primitives implementation.
* Locks provide shared/exclusive sychronization.
#define COUNT(p, x) if (p) (p)->p_locks += (x)
* For multiprocessor system, try spin lock first.
* This should be inline expanded below, but we cannot have #if
* inside a multiline define.
int lock_wait_time
= 100;
#define PAUSE(lkp, wanted) \
if (lock_wait_time > 0) { \
simple_unlock(&lkp->lk_interlock); \
for (i = lock_wait_time; i > 0; i--) \
simple_lock(&lkp->lk_interlock); \
* It is an error to spin on a uniprocessor as nothing will ever cause
* the simple lock to clear while we are executing.
#define PAUSE(lkp, wanted)
#define ACQUIRE(lkp, error, extflags, wanted) \
for (error = 0; wanted; ) { \
simple_unlock(&(lkp)->lk_interlock); \
error = tsleep((void *)lkp, (lkp)->lk_prio, \
(lkp)->lk_wmesg, (lkp)->lk_timo); \
simple_lock(&(lkp)->lk_interlock); \
if ((extflags) & LK_SLEEPFAIL) { \
* Initialize a lock; required before use.
lockinit(lkp
, prio
, wmesg
, timo
, flags
)
bzero(lkp
, sizeof(struct lock
));
simple_lock_init(&lkp
->lk_interlock
);
lkp
->lk_flags
= flags
& LK_EXTFLG_MASK
;
lkp
->lk_lockholder
= LK_NOPROC
;
* Determine the status of a lock.
simple_lock(&lkp
->lk_interlock
);
if (lkp
->lk_exclusivecount
!= 0)
lock_type
= LK_EXCLUSIVE
;
else if (lkp
->lk_sharecount
!= 0)
simple_unlock(&lkp
->lk_interlock
);
* 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.
lockmgr(lkp
, flags
, interlkp
, p
)
__volatile
struct lock
*lkp
;
struct simplelock
*interlkp
;
simple_lock(&lkp
->lk_interlock
);
if (flags
& LK_INTERLOCK
)
extflags
= (flags
| lkp
->lk_flags
) & LK_EXTFLG_MASK
;
* Once a lock has drained, the LK_DRAINING flag is set and an
* exclusive lock is returned. The only valid operation thereafter
* is a single release of that exclusive lock. This final release
* clears the LK_DRAINING flag and sets the LK_DRAINED flag. Any
* further requests of any sort will result in a panic. The bits
* selected for these two flags are chosen so that they will be set
* in memory that is freed (freed memory is filled with 0xdeadbeef).
if (lkp
->lk_flags
& (LK_DRAINING
|LK_DRAINED
)) {
if (lkp
->lk_flags
& LK_DRAINED
)
panic("lockmgr: using decommissioned lock");
if ((flags
& LK_TYPE_MASK
) != LK_RELEASE
||
lkp
->lk_lockholder
!= pid
)
panic("lockmgr: non-release on draining lock: %d\n",
lkp
->lk_flags
&= ~LK_DRAINING
;
lkp
->lk_flags
|= LK_DRAINED
;
switch (flags
& LK_TYPE_MASK
) {
if (lkp
->lk_lockholder
!= pid
) {
* If just polling, check to see if we will block.
if ((extflags
& LK_NOWAIT
) && (lkp
->lk_flags
&
(LK_HAVE_EXCL
| LK_WANT_EXCL
| LK_WANT_UPGRADE
))) {
* Wait for exclusive locks and upgrades to clear.
ACQUIRE(lkp
, error
, extflags
, lkp
->lk_flags
&
(LK_HAVE_EXCL
| LK_WANT_EXCL
| LK_WANT_UPGRADE
));
* We hold an exclusive lock, so downgrade it to shared.
* An alternative would be to fail with EDEADLK.
/* fall into downgrade */
if (lkp
->lk_lockholder
!= pid
|| lkp
->lk_exclusivecount
== 0)
panic("lockmgr: not holding exclusive lock");
lkp
->lk_sharecount
+= lkp
->lk_exclusivecount
;
lkp
->lk_exclusivecount
= 0;
lkp
->lk_flags
&= ~LK_HAVE_EXCL
;
lkp
->lk_lockholder
= LK_NOPROC
;
* If another process is ahead of us to get an upgrade,
* then we want to fail rather than have an intervening
if (lkp
->lk_flags
& LK_WANT_UPGRADE
) {
/* fall into normal 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.
if (lkp
->lk_lockholder
== pid
|| lkp
->lk_sharecount
<= 0)
panic("lockmgr: upgrade exclusive lock");
* 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)) {
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
;
ACQUIRE(lkp
, error
, extflags
, lkp
->lk_sharecount
);
lkp
->lk_flags
&= ~LK_WANT_UPGRADE
;
lkp
->lk_flags
|= LK_HAVE_EXCL
;
lkp
->lk_lockholder
= pid
;
if (lkp
->lk_exclusivecount
!= 0)
panic("lockmgr: non-zero exclusive count");
lkp
->lk_exclusivecount
= 1;
* Someone else has requested upgrade. Release our shared
* lock, awaken upgrade requestor if we are the last shared
* lock, then request an exclusive lock.
if (lkp
->lk_sharecount
== 0 && lkp
->lk_waitcount
)
/* fall into exclusive request */
if (lkp
->lk_lockholder
== pid
&& pid
!= LK_KERNPROC
) {
if ((extflags
& LK_CANRECURSE
) == 0)
panic("lockmgr: locking against myself");
lkp
->lk_exclusivecount
++;
* 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
)) ||
lkp
->lk_sharecount
!= 0)) {
* Try to acquire the want_exclusive flag.
ACQUIRE(lkp
, error
, extflags
, lkp
->lk_flags
&
(LK_HAVE_EXCL
| LK_WANT_EXCL
));
lkp
->lk_flags
|= LK_WANT_EXCL
;
* Wait for shared locks and upgrades to finish.
ACQUIRE(lkp
, error
, extflags
, lkp
->lk_sharecount
!= 0 ||
(lkp
->lk_flags
& LK_WANT_UPGRADE
));
lkp
->lk_flags
&= ~LK_WANT_EXCL
;
lkp
->lk_flags
|= LK_HAVE_EXCL
;
lkp
->lk_lockholder
= pid
;
if (lkp
->lk_exclusivecount
!= 0)
panic("lockmgr: non-zero exclusive count");
lkp
->lk_exclusivecount
= 1;
if (lkp
->lk_exclusivecount
!= 0) {
if (pid
!= lkp
->lk_lockholder
)
panic("lockmgr: pid %d, not %s %d unlocking",
pid
, "exclusive lock holder",
lkp
->lk_exclusivecount
--;
if (lkp
->lk_exclusivecount
== 0) {
lkp
->lk_flags
&= ~LK_HAVE_EXCL
;
lkp
->lk_lockholder
= LK_NOPROC
;
} else if (lkp
->lk_sharecount
!= 0) {
* 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 (lkp
->lk_lockholder
== pid
)
panic("lockmgr: draining against myself");
* 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
)) ||
lkp
->lk_sharecount
!= 0 || lkp
->lk_waitcount
!= 0)) {
PAUSE(lkp
, ((lkp
->lk_flags
&
(LK_HAVE_EXCL
| LK_WANT_EXCL
| LK_WANT_UPGRADE
)) ||
lkp
->lk_sharecount
!= 0 || lkp
->lk_waitcount
!= 0));
for (error
= 0; ((lkp
->lk_flags
&
(LK_HAVE_EXCL
| LK_WANT_EXCL
| LK_WANT_UPGRADE
)) ||
lkp
->lk_sharecount
!= 0 || lkp
->lk_waitcount
!= 0); ) {
lkp
->lk_flags
|= LK_WAITDRAIN
;
simple_unlock(&lkp
->lk_interlock
);
if (error
= tsleep((void *)&lkp
->lk_flags
, lkp
->lk_prio
,
lkp
->lk_wmesg
, lkp
->lk_timo
))
if ((extflags
) & LK_SLEEPFAIL
)
simple_lock(&lkp
->lk_interlock
);
lkp
->lk_flags
|= LK_DRAINING
| LK_HAVE_EXCL
;
lkp
->lk_lockholder
= pid
;
lkp
->lk_exclusivecount
= 1;
simple_unlock(&lkp
->lk_interlock
);
panic("lockmgr: unknown locktype request %d",
if ((lkp
->lk_flags
& LK_WAITDRAIN
) && ((lkp
->lk_flags
&
(LK_HAVE_EXCL
| LK_WANT_EXCL
| LK_WANT_UPGRADE
)) == 0 &&
lkp
->lk_sharecount
== 0 && lkp
->lk_waitcount
== 0)) {
lkp
->lk_flags
&= ~LK_WAITDRAIN
;
wakeup((void *)&lkp
->lk_flags
);
simple_unlock(&lkp
->lk_interlock
);
* Print out information about state of a lock. Used by VOP_PRINT
* routines to display ststus about contained locks.
printf(" lock type %s: SHARED", lkp
->lk_wmesg
);
else if (lkp
->lk_flags
& LK_HAVE_EXCL
)
printf(" lock type %s: EXCL by pid %d", lkp
->lk_wmesg
,
if (lkp
->lk_waitcount
> 0)
printf(" with %d pending", lkp
->lk_waitcount
);
#if defined(DEBUG) && NCPUS == 1
struct ctldebug debug2
= { "lockpausetime", &lockpausetime
};
* Simple lock functions so that the debugger can see from whence
__volatile
struct simplelock
*alp
;
if (alp
->lock_data
== 1) {
panic("%s:%d: simple_lock: lock held", id
, l
);
if (lockpausetime
== 0) {
printf("%s:%d: simple_lock: lock held\n", id
, l
);
} else if (lockpausetime
> 0) {
printf("%s:%d: simple_lock: lock held...", id
, l
);
tsleep(&lockpausetime
, PCATCH
| PPAUSE
, "slock",
curproc
->p_simple_locks
++;
_simple_lock_try(alp
, id
, l
)
__volatile
struct simplelock
*alp
;
if (alp->lock_data == 1) {
panic("%s:%d: simple_lock_try: lock held", id, l);
if (lockpausetime == 0) {
printf("%s:%d: simple_lock_try: lock held\n", id, l);
} else if (lockpausetime > 0) {
printf("%s:%d: simple_lock_try: lock held...", id, l);
tsleep(&lockpausetime, PCATCH | PPAUSE, "slock",
curproc
->p_simple_locks
++;
_simple_unlock(alp
, id
, l
)
__volatile
struct simplelock
*alp
;
if (alp
->lock_data
== 0) {
panic("%s:%d: simple_unlock: lock not held", id
, l
);
if (lockpausetime
== 0) {
printf("%s:%d: simple_unlock: lock not held\n", id
, l
);
} else if (lockpausetime
> 0) {
printf("%s:%d: simple_unlock: lock not held...", id
, l
);
tsleep(&lockpausetime
, PCATCH
| PPAUSE
, "sunlock",
curproc
->p_simple_locks
--;
#endif /* DEBUG && NCPUS == 1 */