3 * The Regents of the University of California. All rights reserved.
6 * John S. Dyson. All rights reserved.
8 * This code contains ideas from software contributed to Berkeley by
9 * Avadis Tevanian, Jr., Michael Wayne Young, and the Mach Operating
10 * System project at Carnegie-Mellon University.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by the University of
23 * California, Berkeley and its contributors.
24 * 4. Neither the name of the University nor the names of its contributors
25 * may be used to endorse or promote products derived from this software
26 * without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 * @(#)kern_lock.c 8.18 (Berkeley) 5/21/95
41 * $FreeBSD: src/sys/kern/kern_lock.c,v 1.31.2.3 2001/12/25 01:44:44 dillon Exp $
42 * $DragonFly: src/sys/kern/kern_lock.c,v 1.27 2008/01/09 10:59:12 corecode Exp $
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/kernel.h>
52 #include <sys/sysctl.h>
53 #include <sys/spinlock.h>
54 #include <sys/thread2.h>
55 #include <sys/spinlock2.h>
58 * Locking primitives implementation.
59 * Locks provide shared/exclusive sychronization.
63 #define COUNT(td, x) (td)->td_locks += (x)
68 #define LOCK_WAIT_TIME 100
69 #define LOCK_SAMPLE_WAIT 7
71 #if defined(DIAGNOSTIC)
74 #define LOCK_INLINE __inline
77 #define LK_ALL (LK_HAVE_EXCL | LK_WANT_EXCL | LK_WANT_UPGRADE | \
78 LK_SHARE_NONZERO | LK_WAIT_NONZERO)
80 static int acquire(struct lock *lkp, int extflags, int wanted);
82 static LOCK_INLINE void
83 sharelock(struct lock *lkp, int incr) {
84 lkp->lk_flags |= LK_SHARE_NONZERO;
85 lkp->lk_sharecount += incr;
88 static LOCK_INLINE int
89 shareunlock(struct lock *lkp, int decr)
93 KASSERT(lkp->lk_sharecount >= decr, ("shareunlock: count < decr"));
95 if (lkp->lk_sharecount == decr) {
96 lkp->lk_flags &= ~LK_SHARE_NONZERO;
97 if (lkp->lk_flags & (LK_WANT_UPGRADE | LK_WANT_EXCL)) {
100 lkp->lk_sharecount = 0;
102 lkp->lk_sharecount -= decr;
108 * lock acquisition helper routine. Called with the lock's spinlock held.
111 acquire(struct lock *lkp, int extflags, int wanted)
115 if ((extflags & LK_NOWAIT) && (lkp->lk_flags & wanted)) {
119 while ((lkp->lk_flags & wanted) != 0) {
120 lkp->lk_flags |= LK_WAIT_NONZERO;
124 * Atomic spinlock release/sleep/reacquire.
126 error = ssleep(lkp, &lkp->lk_spinlock,
127 ((extflags & LK_PCATCH) ? PCATCH : 0),
129 ((extflags & LK_TIMELOCK) ? lkp->lk_timo : 0));
130 if (lkp->lk_waitcount == 1) {
131 lkp->lk_flags &= ~LK_WAIT_NONZERO;
132 lkp->lk_waitcount = 0;
138 if (extflags & LK_SLEEPFAIL)
145 * Set, change, or release a lock.
147 * Shared requests increment the shared count. Exclusive requests set the
148 * LK_WANT_EXCL flag (preventing further shared locks), and wait for already
149 * accepted shared locks and shared-to-exclusive upgrades to go away.
151 * A spinlock is held for most of the procedure. We must not do anything
152 * fancy while holding the spinlock.
156 lockmgr(struct lock *lkp, u_int flags)
158 debuglockmgr(struct lock *lkp, u_int flags,
159 const char *name, const char *file, int line)
173 if (mycpu->gd_intr_nesting_level &&
174 (flags & LK_NOWAIT) == 0 &&
175 (flags & LK_TYPE_MASK) != LK_RELEASE &&
176 panic_cpu_gd != mycpu
180 panic("lockmgr %s from %p: called from interrupt, ipi, "
181 "or hard code section",
182 lkp->lk_wmesg, ((int **)&lkp)[-1]);
184 panic("lockmgr %s from %s:%d: called from interrupt, ipi, "
185 "or hard code section",
186 lkp->lk_wmesg, file, line);
191 if (mycpu->gd_spinlocks_wr &&
192 ((flags & LK_NOWAIT) == 0)
194 panic("lockmgr %s from %s:%d: called with %d spinlocks held",
195 lkp->lk_wmesg, file, line, mycpu->gd_spinlocks_wr);
199 spin_lock(&lkp->lk_spinlock);
201 extflags = (flags | lkp->lk_flags) & LK_EXTFLG_MASK;
204 switch (flags & LK_TYPE_MASK) {
207 * If we are not the exclusive lock holder, we have to block
208 * while there is an exclusive lock holder or while an
209 * exclusive lock request or upgrade request is in progress.
211 * However, if TDF_DEADLKTREAT is set, we override exclusive
212 * lock requests or upgrade requests ( but not the exclusive
215 if (lkp->lk_lockholder != td) {
216 if (td->td_flags & TDF_DEADLKTREAT) {
226 LK_HAVE_EXCL | LK_WANT_EXCL |
237 * We hold an exclusive lock, so downgrade it to shared.
238 * An alternative would be to fail with EDEADLK.
242 /* fall into downgrade */
245 if (lkp->lk_lockholder != td || lkp->lk_exclusivecount == 0) {
246 spin_unlock(&lkp->lk_spinlock);
247 panic("lockmgr: not holding exclusive lock");
251 for (i = 0; i < LOCKMGR_DEBUG_ARRAY_SIZE; i++) {
252 if (td->td_lockmgr_stack[i] == lkp &&
253 td->td_lockmgr_stack_id[i] > 0
255 td->td_lockmgr_stack_id[i]--;
261 sharelock(lkp, lkp->lk_exclusivecount);
262 lkp->lk_exclusivecount = 0;
263 lkp->lk_flags &= ~LK_HAVE_EXCL;
264 lkp->lk_lockholder = LK_NOTHREAD;
265 if (lkp->lk_waitcount)
271 * If another process is ahead of us to get an upgrade,
272 * then we want to fail rather than have an intervening
275 if (lkp->lk_flags & LK_WANT_UPGRADE) {
276 dowakeup = shareunlock(lkp, 1);
281 /* fall into normal upgrade */
285 * Upgrade a shared lock to an exclusive one. If another
286 * shared lock has already requested an upgrade to an
287 * exclusive lock, our shared lock is released and an
288 * exclusive lock is requested (which will be granted
289 * after the upgrade). If we return an error, the file
290 * will always be unlocked.
292 if ((lkp->lk_lockholder == td) || (lkp->lk_sharecount <= 0)) {
293 spin_unlock(&lkp->lk_spinlock);
294 panic("lockmgr: upgrade exclusive lock");
296 dowakeup += shareunlock(lkp, 1);
299 * If we are just polling, check to see if we will block.
301 if ((extflags & LK_NOWAIT) &&
302 ((lkp->lk_flags & LK_WANT_UPGRADE) ||
303 lkp->lk_sharecount > 1)) {
307 if ((lkp->lk_flags & LK_WANT_UPGRADE) == 0) {
309 * We are first shared lock to request an upgrade, so
310 * request upgrade and wait for the shared count to
311 * drop to zero, then take exclusive lock.
313 * Although I don't think this can occur for
314 * robustness we also wait for any exclusive locks
315 * to be released. LK_WANT_UPGRADE is supposed to
316 * prevent new exclusive locks but might not in the
319 lkp->lk_flags |= LK_WANT_UPGRADE;
320 error = acquire(lkp, extflags,
321 LK_HAVE_EXCL | LK_SHARE_NONZERO);
322 lkp->lk_flags &= ~LK_WANT_UPGRADE;
326 lkp->lk_flags |= LK_HAVE_EXCL;
327 lkp->lk_lockholder = td;
328 if (lkp->lk_exclusivecount != 0) {
329 spin_unlock(&lkp->lk_spinlock);
330 panic("lockmgr(1): non-zero exclusive count");
332 lkp->lk_exclusivecount = 1;
333 #if defined(DEBUG_LOCKS)
334 lkp->lk_filename = file;
335 lkp->lk_lineno = line;
336 lkp->lk_lockername = name;
338 for (i = 0; i < LOCKMGR_DEBUG_ARRAY_SIZE; i++) {
340 * Recursive lockmgr path
342 if (td->td_lockmgr_stack[i] == lkp &&
343 td->td_lockmgr_stack_id[i] != 0
345 td->td_lockmgr_stack_id[i]++;
350 for (i = 0; i < LOCKMGR_DEBUG_ARRAY_SIZE; i++) {
352 * Use new lockmgr tracking slot
354 if (td->td_lockmgr_stack_id[i] == 0) {
355 td->td_lockmgr_stack_id[i]++;
356 td->td_lockmgr_stack[i] = lkp;
367 * Someone else has requested upgrade. Release our shared
368 * lock, awaken upgrade requestor if we are the last shared
369 * lock, then request an exclusive lock.
371 if ( (lkp->lk_flags & (LK_SHARE_NONZERO|LK_WAIT_NONZERO)) ==
375 /* fall into exclusive request */
378 if (lkp->lk_lockholder == td && td != LK_KERNTHREAD) {
382 if ((extflags & (LK_NOWAIT | LK_CANRECURSE)) == 0) {
383 spin_unlock(&lkp->lk_spinlock);
384 panic("lockmgr: locking against myself");
386 if ((extflags & LK_CANRECURSE) != 0) {
387 lkp->lk_exclusivecount++;
393 * If we are just polling, check to see if we will sleep.
395 if ((extflags & LK_NOWAIT) &&
396 (lkp->lk_flags & (LK_HAVE_EXCL | LK_WANT_EXCL |
397 LK_WANT_UPGRADE | LK_SHARE_NONZERO))) {
402 * Wait for exclusive lock holders to release and try to
403 * acquire the want_exclusive flag.
405 error = acquire(lkp, extflags, (LK_HAVE_EXCL | LK_WANT_EXCL));
408 lkp->lk_flags |= LK_WANT_EXCL;
411 * Wait for shared locks and upgrades to finish. We can lose
412 * the race against a successful shared lock upgrade in which
413 * case LK_HAVE_EXCL will get set regardless of our
414 * acquisition of LK_WANT_EXCL, so we have to acquire
415 * LK_HAVE_EXCL here as well.
417 error = acquire(lkp, extflags, LK_HAVE_EXCL |
420 lkp->lk_flags &= ~LK_WANT_EXCL;
423 lkp->lk_flags |= LK_HAVE_EXCL;
424 lkp->lk_lockholder = td;
425 if (lkp->lk_exclusivecount != 0) {
426 spin_unlock(&lkp->lk_spinlock);
427 panic("lockmgr(2): non-zero exclusive count");
429 lkp->lk_exclusivecount = 1;
430 #if defined(DEBUG_LOCKS)
431 lkp->lk_filename = file;
432 lkp->lk_lineno = line;
433 lkp->lk_lockername = name;
435 for (i = 0; i < LOCKMGR_DEBUG_ARRAY_SIZE; i++) {
437 * Recursive lockmgr path
439 if (td->td_lockmgr_stack[i] == lkp &&
440 td->td_lockmgr_stack_id[i] != 0
442 td->td_lockmgr_stack_id[i]++;
447 for (i = 0; i < LOCKMGR_DEBUG_ARRAY_SIZE; i++) {
449 * Use new lockmgr tracking slot
451 if (td->td_lockmgr_stack_id[i] == 0) {
452 td->td_lockmgr_stack_id[i]++;
453 td->td_lockmgr_stack[i] = lkp;
464 if (lkp->lk_exclusivecount != 0) {
465 if (lkp->lk_lockholder != td &&
466 lkp->lk_lockholder != LK_KERNTHREAD) {
467 spin_unlock(&lkp->lk_spinlock);
468 panic("lockmgr: pid %d, not %s thr %p/%p unlocking",
469 (td->td_proc ? td->td_proc->p_pid : -1),
470 "exclusive lock holder",
471 td, lkp->lk_lockholder);
473 if (lkp->lk_lockholder != LK_KERNTHREAD) {
476 if (lkp->lk_exclusivecount == 1) {
477 lkp->lk_flags &= ~LK_HAVE_EXCL;
478 lkp->lk_lockholder = LK_NOTHREAD;
479 lkp->lk_exclusivecount = 0;
481 lkp->lk_exclusivecount--;
484 for (i = 0; i < LOCKMGR_DEBUG_ARRAY_SIZE; i++) {
485 if (td->td_lockmgr_stack[i] == lkp &&
486 td->td_lockmgr_stack_id[i] > 0
488 td->td_lockmgr_stack_id[i]--;
493 } else if (lkp->lk_flags & LK_SHARE_NONZERO) {
494 dowakeup += shareunlock(lkp, 1);
497 if (lkp->lk_flags & LK_WAIT_NONZERO)
502 spin_unlock(&lkp->lk_spinlock);
503 panic("lockmgr: unknown locktype request %d",
504 flags & LK_TYPE_MASK);
507 spin_unlock(&lkp->lk_spinlock);
514 lockmgr_kernproc(struct lock *lp)
516 struct thread *td __debugvar = curthread;
518 if (lp->lk_lockholder != LK_KERNTHREAD) {
519 KASSERT(lp->lk_lockholder == td,
520 ("lockmgr_kernproc: lock not owned by curthread %p", td));
522 lp->lk_lockholder = LK_KERNTHREAD;
528 * Set the lock to be exclusively held. The caller is holding the lock's
529 * spinlock and the spinlock remains held on return. A panic will occur
530 * if the lock cannot be set to exclusive.
533 lockmgr_setexclusive_interlocked(struct lock *lkp)
535 thread_t td = curthread;
537 KKASSERT((lkp->lk_flags & (LK_HAVE_EXCL|LK_SHARE_NONZERO)) == 0);
538 KKASSERT(lkp->lk_exclusivecount == 0);
539 lkp->lk_flags |= LK_HAVE_EXCL;
540 lkp->lk_lockholder = td;
541 lkp->lk_exclusivecount = 1;
546 * Clear the caller's exclusive lock. The caller is holding the lock's
547 * spinlock. THIS FUNCTION WILL UNLOCK THE SPINLOCK.
549 * A panic will occur if the caller does not hold the lock.
552 lockmgr_clrexclusive_interlocked(struct lock *lkp)
554 thread_t td __debugvar = curthread;
557 KKASSERT((lkp->lk_flags & LK_HAVE_EXCL) && lkp->lk_exclusivecount == 1
558 && lkp->lk_lockholder == td);
559 lkp->lk_lockholder = LK_NOTHREAD;
560 lkp->lk_flags &= ~LK_HAVE_EXCL;
561 lkp->lk_exclusivecount = 0;
562 if (lkp->lk_flags & LK_WAIT_NONZERO)
565 spin_unlock(&lkp->lk_spinlock);
573 * Initialize a lock; required before use.
576 lockinit(struct lock *lkp, char *wmesg, int timo, int flags)
578 spin_init(&lkp->lk_spinlock);
579 lkp->lk_flags = (flags & LK_EXTFLG_MASK);
580 lkp->lk_sharecount = 0;
581 lkp->lk_waitcount = 0;
582 lkp->lk_exclusivecount = 0;
583 lkp->lk_wmesg = wmesg;
585 lkp->lk_lockholder = LK_NOTHREAD;
589 * Reinitialize a lock that is being reused for a different purpose, but
590 * which may have pending (blocked) threads sitting on it. The caller
591 * must already hold the interlock.
594 lockreinit(struct lock *lkp, char *wmesg, int timo, int flags)
596 spin_lock(&lkp->lk_spinlock);
597 lkp->lk_flags = (lkp->lk_flags & ~LK_EXTFLG_MASK) |
598 (flags & LK_EXTFLG_MASK);
599 lkp->lk_wmesg = wmesg;
601 spin_unlock(&lkp->lk_spinlock);
605 * Requires that the caller is the exclusive owner of this lock.
608 lockuninit(struct lock *l)
611 * At this point we should have removed all the references to this lock
612 * so there can't be anyone waiting on it.
614 KKASSERT(l->lk_waitcount == 0);
616 spin_uninit(&l->lk_spinlock);
620 * Determine the status of a lock.
623 lockstatus(struct lock *lkp, struct thread *td)
627 spin_lock(&lkp->lk_spinlock);
628 if (lkp->lk_exclusivecount != 0) {
629 if (td == NULL || lkp->lk_lockholder == td)
630 lock_type = LK_EXCLUSIVE;
632 lock_type = LK_EXCLOTHER;
633 } else if (lkp->lk_sharecount != 0) {
634 lock_type = LK_SHARED;
636 spin_unlock(&lkp->lk_spinlock);
641 * Return non-zero if the caller owns the lock shared or exclusive.
642 * We can only guess re: shared locks.
645 lockowned(struct lock *lkp)
647 thread_t td = curthread;
649 if (lkp->lk_exclusivecount)
650 return(lkp->lk_lockholder == td);
651 return(lkp->lk_sharecount != 0);
655 * Determine the number of holders of a lock.
657 * The non-blocking version can usually be used for assertions.
660 lockcount(struct lock *lkp)
664 spin_lock(&lkp->lk_spinlock);
665 count = lkp->lk_exclusivecount + lkp->lk_sharecount;
666 spin_unlock(&lkp->lk_spinlock);
671 lockcountnb(struct lock *lkp)
673 return (lkp->lk_exclusivecount + lkp->lk_sharecount);
677 * Print out information about state of a lock. Used by VOP_PRINT
678 * routines to display status about contained locks.
681 lockmgr_printinfo(struct lock *lkp)
683 struct thread *td = lkp->lk_lockholder;
686 if (td && td != LK_KERNTHREAD && td != LK_NOTHREAD)
691 if (lkp->lk_sharecount)
692 kprintf(" lock type %s: SHARED (count %d)", lkp->lk_wmesg,
694 else if (lkp->lk_flags & LK_HAVE_EXCL)
695 kprintf(" lock type %s: EXCL (count %d) by td %p pid %d",
696 lkp->lk_wmesg, lkp->lk_exclusivecount, td,
698 if (lkp->lk_waitcount > 0)
699 kprintf(" with %d pending", lkp->lk_waitcount);