2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2008 Attilio Rao <attilio@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice(s), this list of conditions and the following disclaimer as
12 * the first lines of this file unmodified other than the possible
13 * addition of one or more copyright notices.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice(s), this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
19 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
32 #include "opt_hwpmc_hooks.h"
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
41 #include <sys/lock_profile.h>
42 #include <sys/lockmgr.h>
43 #include <sys/lockstat.h>
44 #include <sys/mutex.h>
46 #include <sys/sleepqueue.h>
48 #include <sys/stack.h>
50 #include <sys/sysctl.h>
51 #include <sys/systm.h>
53 #include <machine/cpu.h>
60 #include <sys/pmckern.h>
61 PMC_SOFT_DECLARE( , , lock, failed);
64 CTASSERT(LK_UNLOCKED == (LK_UNLOCKED &
65 ~(LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS)));
67 #define SQ_EXCLUSIVE_QUEUE 0
68 #define SQ_SHARED_QUEUE 1
71 #define _lockmgr_assert(lk, what, file, line)
74 #define TD_SLOCKS_INC(td) ((td)->td_lk_slocks++)
75 #define TD_SLOCKS_DEC(td) ((td)->td_lk_slocks--)
78 #define STACK_PRINT(lk)
79 #define STACK_SAVE(lk)
80 #define STACK_ZERO(lk)
82 #define STACK_PRINT(lk) stack_print_ddb(&(lk)->lk_stack)
83 #define STACK_SAVE(lk) stack_save(&(lk)->lk_stack)
84 #define STACK_ZERO(lk) stack_zero(&(lk)->lk_stack)
87 #define LOCK_LOG2(lk, string, arg1, arg2) \
88 if (LOCK_LOG_TEST(&(lk)->lock_object, 0)) \
89 CTR2(KTR_LOCK, (string), (arg1), (arg2))
90 #define LOCK_LOG3(lk, string, arg1, arg2, arg3) \
91 if (LOCK_LOG_TEST(&(lk)->lock_object, 0)) \
92 CTR3(KTR_LOCK, (string), (arg1), (arg2), (arg3))
94 #define GIANT_DECLARE \
96 WITNESS_SAVE_DECL(Giant)
97 #define GIANT_RESTORE() do { \
98 if (__predict_false(_i > 0)) { \
101 WITNESS_RESTORE(&Giant.lock_object, Giant); \
104 #define GIANT_SAVE() do { \
105 if (__predict_false(mtx_owned(&Giant))) { \
106 WITNESS_SAVE(&Giant.lock_object, Giant); \
107 while (mtx_owned(&Giant)) { \
109 mtx_unlock(&Giant); \
114 static bool __always_inline
115 LK_CAN_SHARE(uintptr_t x, int flags, bool fp)
118 if ((x & (LK_SHARE | LK_EXCLUSIVE_WAITERS | LK_EXCLUSIVE_SPINNERS)) ==
121 if (fp || (!(x & LK_SHARE)))
123 if ((curthread->td_lk_slocks != 0 && !(flags & LK_NODDLKTREAT)) ||
124 (curthread->td_pflags & TDP_DEADLKTREAT))
129 #define LK_TRYOP(x) \
132 #define LK_CAN_WITNESS(x) \
133 (((x) & LK_NOWITNESS) == 0 && !LK_TRYOP(x))
134 #define LK_TRYWIT(x) \
135 (LK_TRYOP(x) ? LOP_TRYLOCK : 0)
137 #define lockmgr_disowned(lk) \
138 (((lk)->lk_lock & ~(LK_FLAGMASK & ~LK_SHARE)) == LK_KERNPROC)
140 #define lockmgr_xlocked_v(v) \
141 (((v) & ~(LK_FLAGMASK & ~LK_SHARE)) == (uintptr_t)curthread)
143 #define lockmgr_xlocked(lk) lockmgr_xlocked_v((lk)->lk_lock)
145 static void assert_lockmgr(const struct lock_object *lock, int how);
147 static void db_show_lockmgr(const struct lock_object *lock);
149 static void lock_lockmgr(struct lock_object *lock, uintptr_t how);
151 static int owner_lockmgr(const struct lock_object *lock,
152 struct thread **owner);
154 static uintptr_t unlock_lockmgr(struct lock_object *lock);
156 struct lock_class lock_class_lockmgr = {
157 .lc_name = "lockmgr",
158 .lc_flags = LC_RECURSABLE | LC_SLEEPABLE | LC_SLEEPLOCK | LC_UPGRADABLE,
159 .lc_assert = assert_lockmgr,
161 .lc_ddb_show = db_show_lockmgr,
163 .lc_lock = lock_lockmgr,
164 .lc_unlock = unlock_lockmgr,
166 .lc_owner = owner_lockmgr,
170 struct lockmgr_wait {
176 static bool __always_inline lockmgr_slock_try(struct lock *lk, uintptr_t *xp,
178 static bool __always_inline lockmgr_sunlock_try(struct lock *lk, uintptr_t *xp);
181 lockmgr_exit(u_int flags, struct lock_object *ilk, int wakeup_swapper)
183 struct lock_class *class;
185 if (flags & LK_INTERLOCK) {
186 class = LOCK_CLASS(ilk);
187 class->lc_unlock(ilk);
190 if (__predict_false(wakeup_swapper))
195 lockmgr_note_shared_acquire(struct lock *lk, int contested,
196 uint64_t waittime, const char *file, int line, int flags)
199 LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(lockmgr__acquire, lk, contested,
200 waittime, file, line, LOCKSTAT_READER);
201 LOCK_LOG_LOCK("SLOCK", &lk->lock_object, 0, 0, file, line);
202 WITNESS_LOCK(&lk->lock_object, LK_TRYWIT(flags), file, line);
203 TD_LOCKS_INC(curthread);
204 TD_SLOCKS_INC(curthread);
209 lockmgr_note_shared_release(struct lock *lk, const char *file, int line)
212 WITNESS_UNLOCK(&lk->lock_object, 0, file, line);
213 LOCK_LOG_LOCK("SUNLOCK", &lk->lock_object, 0, 0, file, line);
214 TD_LOCKS_DEC(curthread);
215 TD_SLOCKS_DEC(curthread);
219 lockmgr_note_exclusive_acquire(struct lock *lk, int contested,
220 uint64_t waittime, const char *file, int line, int flags)
223 LOCKSTAT_PROFILE_OBTAIN_RWLOCK_SUCCESS(lockmgr__acquire, lk, contested,
224 waittime, file, line, LOCKSTAT_WRITER);
225 LOCK_LOG_LOCK("XLOCK", &lk->lock_object, 0, lk->lk_recurse, file, line);
226 WITNESS_LOCK(&lk->lock_object, LOP_EXCLUSIVE | LK_TRYWIT(flags), file,
228 TD_LOCKS_INC(curthread);
233 lockmgr_note_exclusive_release(struct lock *lk, const char *file, int line)
236 if (LK_HOLDER(lk->lk_lock) != LK_KERNPROC) {
237 WITNESS_UNLOCK(&lk->lock_object, LOP_EXCLUSIVE, file, line);
238 TD_LOCKS_DEC(curthread);
240 LOCK_LOG_LOCK("XUNLOCK", &lk->lock_object, 0, lk->lk_recurse, file,
244 static __inline struct thread *
245 lockmgr_xholder(const struct lock *lk)
250 return ((x & LK_SHARE) ? NULL : (struct thread *)LK_HOLDER(x));
254 * It assumes sleepq_lock held and returns with this one unheld.
255 * It also assumes the generic interlock is sane and previously checked.
256 * If LK_INTERLOCK is specified the interlock is not reacquired after the
260 sleeplk(struct lock *lk, u_int flags, struct lock_object *ilk,
261 const char *wmesg, int pri, int timo, int queue)
264 struct lock_class *class;
267 class = (flags & LK_INTERLOCK) ? LOCK_CLASS(ilk) : NULL;
268 catch = pri & PCATCH;
272 LOCK_LOG3(lk, "%s: %p blocking on the %s sleepqueue", __func__, lk,
273 (queue == SQ_EXCLUSIVE_QUEUE) ? "exclusive" : "shared");
275 if (flags & LK_INTERLOCK)
276 class->lc_unlock(ilk);
277 if (queue == SQ_EXCLUSIVE_QUEUE && (flags & LK_SLEEPFAIL) != 0)
280 sleepq_add(&lk->lock_object, NULL, wmesg, SLEEPQ_LK | (catch ?
281 SLEEPQ_INTERRUPTIBLE : 0), queue);
282 if ((flags & LK_TIMELOCK) && timo)
283 sleepq_set_timeout(&lk->lock_object, timo);
286 * Decisional switch for real sleeping.
288 if ((flags & LK_TIMELOCK) && timo && catch)
289 error = sleepq_timedwait_sig(&lk->lock_object, pri);
290 else if ((flags & LK_TIMELOCK) && timo)
291 error = sleepq_timedwait(&lk->lock_object, pri);
293 error = sleepq_wait_sig(&lk->lock_object, pri);
295 sleepq_wait(&lk->lock_object, pri);
297 if ((flags & LK_SLEEPFAIL) && error == 0)
304 wakeupshlk(struct lock *lk, const char *file, int line)
306 uintptr_t v, x, orig_x;
308 int queue, wakeup_swapper;
313 if (lockmgr_sunlock_try(lk, &x))
317 * We should have a sharer with waiters, so enter the hard
318 * path in order to handle wakeups correctly.
320 sleepq_lock(&lk->lock_object);
321 orig_x = lk->lk_lock;
323 x = orig_x & (LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS);
327 * If the lock has exclusive waiters, give them preference in
328 * order to avoid deadlock with shared runners up.
329 * If interruptible sleeps left the exclusive queue empty
330 * avoid a starvation for the threads sleeping on the shared
331 * queue by giving them precedence and cleaning up the
332 * exclusive waiters bit anyway.
333 * Please note that lk_exslpfail count may be lying about
334 * the real number of waiters with the LK_SLEEPFAIL flag on
335 * because they may be used in conjunction with interruptible
336 * sleeps so lk_exslpfail might be considered an 'upper limit'
337 * bound, including the edge cases.
339 realexslp = sleepq_sleepcnt(&lk->lock_object,
341 if ((x & LK_EXCLUSIVE_WAITERS) != 0 && realexslp != 0) {
342 if (lk->lk_exslpfail < realexslp) {
343 lk->lk_exslpfail = 0;
344 queue = SQ_EXCLUSIVE_QUEUE;
345 v |= (x & LK_SHARED_WAITERS);
347 lk->lk_exslpfail = 0;
349 "%s: %p has only LK_SLEEPFAIL sleepers",
352 "%s: %p waking up threads on the exclusive queue",
355 sleepq_broadcast(&lk->lock_object,
356 SLEEPQ_LK, 0, SQ_EXCLUSIVE_QUEUE);
357 queue = SQ_SHARED_QUEUE;
363 * Exclusive waiters sleeping with LK_SLEEPFAIL on
364 * and using interruptible sleeps/timeout may have
365 * left spourious lk_exslpfail counts on, so clean
368 lk->lk_exslpfail = 0;
369 queue = SQ_SHARED_QUEUE;
372 if (lockmgr_sunlock_try(lk, &orig_x)) {
373 sleepq_release(&lk->lock_object);
377 x |= LK_SHARERS_LOCK(1);
378 if (!atomic_fcmpset_rel_ptr(&lk->lk_lock, &x, v)) {
382 LOCK_LOG3(lk, "%s: %p waking up threads on the %s queue",
383 __func__, lk, queue == SQ_SHARED_QUEUE ? "shared" :
385 wakeup_swapper |= sleepq_broadcast(&lk->lock_object, SLEEPQ_LK,
387 sleepq_release(&lk->lock_object);
391 LOCKSTAT_PROFILE_RELEASE_RWLOCK(lockmgr__release, lk, LOCKSTAT_READER);
392 return (wakeup_swapper);
396 assert_lockmgr(const struct lock_object *lock, int what)
399 panic("lockmgr locks do not support assertions");
403 lock_lockmgr(struct lock_object *lock, uintptr_t how)
406 panic("lockmgr locks do not support sleep interlocking");
410 unlock_lockmgr(struct lock_object *lock)
413 panic("lockmgr locks do not support sleep interlocking");
418 owner_lockmgr(const struct lock_object *lock, struct thread **owner)
421 panic("lockmgr locks do not support owner inquiring");
426 lockinit(struct lock *lk, int pri, const char *wmesg, int timo, int flags)
430 MPASS((flags & ~LK_INIT_MASK) == 0);
431 ASSERT_ATOMIC_LOAD_PTR(lk->lk_lock,
432 ("%s: lockmgr not aligned for %s: %p", __func__, wmesg,
435 iflags = LO_SLEEPABLE | LO_UPGRADABLE;
436 if (flags & LK_CANRECURSE)
437 iflags |= LO_RECURSABLE;
438 if ((flags & LK_NODUP) == 0)
440 if (flags & LK_NOPROFILE)
441 iflags |= LO_NOPROFILE;
442 if ((flags & LK_NOWITNESS) == 0)
443 iflags |= LO_WITNESS;
444 if (flags & LK_QUIET)
446 if (flags & LK_IS_VNODE)
447 iflags |= LO_IS_VNODE;
450 iflags |= flags & LK_NOSHARE;
452 lock_init(&lk->lock_object, &lock_class_lockmgr, wmesg, NULL, iflags);
453 lk->lk_lock = LK_UNLOCKED;
455 lk->lk_exslpfail = 0;
462 * XXX: Gross hacks to manipulate external lock flags after
463 * initialization. Used for certain vnode and buf locks.
466 lockallowshare(struct lock *lk)
469 lockmgr_assert(lk, KA_XLOCKED);
470 lk->lock_object.lo_flags &= ~LK_NOSHARE;
474 lockdisableshare(struct lock *lk)
477 lockmgr_assert(lk, KA_XLOCKED);
478 lk->lock_object.lo_flags |= LK_NOSHARE;
482 lockallowrecurse(struct lock *lk)
485 lockmgr_assert(lk, KA_XLOCKED);
486 lk->lock_object.lo_flags |= LO_RECURSABLE;
490 lockdisablerecurse(struct lock *lk)
493 lockmgr_assert(lk, KA_XLOCKED);
494 lk->lock_object.lo_flags &= ~LO_RECURSABLE;
498 lockdestroy(struct lock *lk)
501 KASSERT(lk->lk_lock == LK_UNLOCKED, ("lockmgr still held"));
502 KASSERT(lk->lk_recurse == 0, ("lockmgr still recursed"));
503 KASSERT(lk->lk_exslpfail == 0, ("lockmgr still exclusive waiters"));
504 lock_destroy(&lk->lock_object);
507 static bool __always_inline
508 lockmgr_slock_try(struct lock *lk, uintptr_t *xp, int flags, bool fp)
512 * If no other thread has an exclusive lock, or
513 * no exclusive waiter is present, bump the count of
514 * sharers. Since we have to preserve the state of
515 * waiters, if we fail to acquire the shared lock
516 * loop back and retry.
519 while (LK_CAN_SHARE(*xp, flags, fp)) {
520 if (atomic_fcmpset_acq_ptr(&lk->lk_lock, xp,
521 *xp + LK_ONE_SHARER)) {
528 static bool __always_inline
529 lockmgr_sunlock_try(struct lock *lk, uintptr_t *xp)
533 if (LK_SHARERS(*xp) > 1 || !(*xp & LK_ALL_WAITERS)) {
534 if (atomic_fcmpset_rel_ptr(&lk->lk_lock, xp,
535 *xp - LK_ONE_SHARER))
544 static __noinline int
545 lockmgr_slock_hard(struct lock *lk, u_int flags, struct lock_object *ilk,
546 const char *file, int line, struct lockmgr_wait *lwa)
554 uint64_t sleep_time = 0;
556 #ifdef LOCK_PROFILING
557 uint64_t waittime = 0;
561 if (KERNEL_PANICKED())
564 tid = (uintptr_t)curthread;
566 if (LK_CAN_WITNESS(flags))
567 WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER,
568 file, line, flags & LK_INTERLOCK ? ilk : NULL);
570 if (lockmgr_slock_try(lk, &x, flags, false))
573 PMC_SOFT_CALL( , , lock, failed);
575 lock_profile_obtain_lock_failed(&lk->lock_object,
576 &contested, &waittime);
579 * If the lock is already held by curthread in
580 * exclusive way avoid a deadlock.
582 if (LK_HOLDER(x) == tid) {
584 "%s: %p already held in exclusive mode",
591 * If the lock is expected to not sleep just give up
594 if (LK_TRYOP(flags)) {
595 LOCK_LOG2(lk, "%s: %p fails the try operation",
602 * Acquire the sleepqueue chain lock because we
603 * probabilly will need to manipulate waiters flags.
605 sleepq_lock(&lk->lock_object);
610 * if the lock can be acquired in shared mode, try
613 if (LK_CAN_SHARE(x, flags, false)) {
614 sleepq_release(&lk->lock_object);
619 * Try to set the LK_SHARED_WAITERS flag. If we fail,
620 * loop back and retry.
622 if ((x & LK_SHARED_WAITERS) == 0) {
623 if (!atomic_fcmpset_acq_ptr(&lk->lk_lock, &x,
624 x | LK_SHARED_WAITERS)) {
627 LOCK_LOG2(lk, "%s: %p set shared waiters flag",
632 iwmesg = lk->lock_object.lo_name;
636 iwmesg = lwa->iwmesg;
642 * As far as we have been unable to acquire the
643 * shared lock and the shared waiters flag is set,
647 sleep_time -= lockstat_nsecs(&lk->lock_object);
649 error = sleeplk(lk, flags, ilk, iwmesg, ipri, itimo,
652 sleep_time += lockstat_nsecs(&lk->lock_object);
654 flags &= ~LK_INTERLOCK;
657 "%s: interrupted sleep for %p with %d",
658 __func__, lk, error);
661 LOCK_LOG2(lk, "%s: %p resuming from the sleep queue",
667 LOCKSTAT_RECORD4(lockmgr__block, lk, sleep_time,
668 LOCKSTAT_READER, (x & LK_SHARE) == 0,
669 (x & LK_SHARE) == 0 ? 0 : LK_SHARERS(x));
671 #ifdef LOCK_PROFILING
672 lockmgr_note_shared_acquire(lk, contested, waittime,
675 lockmgr_note_shared_acquire(lk, 0, 0, file, line,
681 lockmgr_exit(flags, ilk, 0);
685 static __noinline int
686 lockmgr_xlock_hard(struct lock *lk, u_int flags, struct lock_object *ilk,
687 const char *file, int line, struct lockmgr_wait *lwa)
689 struct lock_class *class;
696 uint64_t sleep_time = 0;
698 #ifdef LOCK_PROFILING
699 uint64_t waittime = 0;
703 if (KERNEL_PANICKED())
706 tid = (uintptr_t)curthread;
708 if (LK_CAN_WITNESS(flags))
709 WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER |
710 LOP_EXCLUSIVE, file, line, flags & LK_INTERLOCK ?
714 * If curthread already holds the lock and this one is
715 * allowed to recurse, simply recurse on it.
717 if (lockmgr_xlocked(lk)) {
718 if ((flags & LK_CANRECURSE) == 0 &&
719 (lk->lock_object.lo_flags & LO_RECURSABLE) == 0) {
721 * If the lock is expected to not panic just
722 * give up and return.
724 if (LK_TRYOP(flags)) {
726 "%s: %p fails the try operation",
731 if (flags & LK_INTERLOCK) {
732 class = LOCK_CLASS(ilk);
733 class->lc_unlock(ilk);
735 panic("%s: recursing on non recursive lockmgr %p "
736 "@ %s:%d\n", __func__, lk, file, line);
739 LOCK_LOG2(lk, "%s: %p recursing", __func__, lk);
740 LOCK_LOG_LOCK("XLOCK", &lk->lock_object, 0,
741 lk->lk_recurse, file, line);
742 WITNESS_LOCK(&lk->lock_object, LOP_EXCLUSIVE |
743 LK_TRYWIT(flags), file, line);
744 TD_LOCKS_INC(curthread);
749 if (lk->lk_lock == LK_UNLOCKED &&
750 atomic_cmpset_acq_ptr(&lk->lk_lock, LK_UNLOCKED, tid))
753 PMC_SOFT_CALL( , , lock, failed);
755 lock_profile_obtain_lock_failed(&lk->lock_object,
756 &contested, &waittime);
759 * If the lock is expected to not sleep just give up
762 if (LK_TRYOP(flags)) {
763 LOCK_LOG2(lk, "%s: %p fails the try operation",
770 * Acquire the sleepqueue chain lock because we
771 * probabilly will need to manipulate waiters flags.
773 sleepq_lock(&lk->lock_object);
778 * if the lock has been released while we spun on
779 * the sleepqueue chain lock just try again.
781 if (x == LK_UNLOCKED) {
782 sleepq_release(&lk->lock_object);
787 * The lock can be in the state where there is a
788 * pending queue of waiters, but still no owner.
789 * This happens when the lock is contested and an
790 * owner is going to claim the lock.
791 * If curthread is the one successfully acquiring it
792 * claim lock ownership and return, preserving waiters
795 v = x & (LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS);
796 if ((x & ~v) == LK_UNLOCKED) {
797 v &= ~LK_EXCLUSIVE_SPINNERS;
798 if (atomic_fcmpset_acq_ptr(&lk->lk_lock, &x,
800 sleepq_release(&lk->lock_object);
802 "%s: %p claimed by a new writer",
810 * Try to set the LK_EXCLUSIVE_WAITERS flag. If we
811 * fail, loop back and retry.
813 if ((x & LK_EXCLUSIVE_WAITERS) == 0) {
814 if (!atomic_fcmpset_ptr(&lk->lk_lock, &x,
815 x | LK_EXCLUSIVE_WAITERS)) {
818 LOCK_LOG2(lk, "%s: %p set excl waiters flag",
823 iwmesg = lk->lock_object.lo_name;
827 iwmesg = lwa->iwmesg;
833 * As far as we have been unable to acquire the
834 * exclusive lock and the exclusive waiters flag
835 * is set, we will sleep.
838 sleep_time -= lockstat_nsecs(&lk->lock_object);
840 error = sleeplk(lk, flags, ilk, iwmesg, ipri, itimo,
843 sleep_time += lockstat_nsecs(&lk->lock_object);
845 flags &= ~LK_INTERLOCK;
848 "%s: interrupted sleep for %p with %d",
849 __func__, lk, error);
852 LOCK_LOG2(lk, "%s: %p resuming from the sleep queue",
858 LOCKSTAT_RECORD4(lockmgr__block, lk, sleep_time,
859 LOCKSTAT_WRITER, (x & LK_SHARE) == 0,
860 (x & LK_SHARE) == 0 ? 0 : LK_SHARERS(x));
862 #ifdef LOCK_PROFILING
863 lockmgr_note_exclusive_acquire(lk, contested, waittime,
866 lockmgr_note_exclusive_acquire(lk, 0, 0, file, line,
872 lockmgr_exit(flags, ilk, 0);
876 static __noinline int
877 lockmgr_upgrade(struct lock *lk, u_int flags, struct lock_object *ilk,
878 const char *file, int line, struct lockmgr_wait *lwa)
882 int wakeup_swapper = 0;
885 if (KERNEL_PANICKED())
888 tid = (uintptr_t)curthread;
890 _lockmgr_assert(lk, KA_SLOCKED, file, line);
892 x = v & LK_ALL_WAITERS;
893 v &= LK_EXCLUSIVE_SPINNERS;
896 * Try to switch from one shared lock to an exclusive one.
897 * We need to preserve waiters flags during the operation.
899 if (atomic_cmpset_ptr(&lk->lk_lock, LK_SHARERS_LOCK(1) | x | v,
901 LOCK_LOG_LOCK("XUPGRADE", &lk->lock_object, 0, 0, file,
903 WITNESS_UPGRADE(&lk->lock_object, LOP_EXCLUSIVE |
904 LK_TRYWIT(flags), file, line);
905 LOCKSTAT_RECORD0(lockmgr__upgrade, lk);
906 TD_SLOCKS_DEC(curthread);
910 op = flags & LK_TYPE_MASK;
913 * In LK_TRYUPGRADE mode, do not drop the lock,
914 * returning EBUSY instead.
916 if (op == LK_TRYUPGRADE) {
917 LOCK_LOG2(lk, "%s: %p failed the nowait upgrade",
924 * We have been unable to succeed in upgrading, so just
925 * give up the shared lock.
927 lockmgr_note_shared_release(lk, file, line);
928 wakeup_swapper |= wakeupshlk(lk, file, line);
929 error = lockmgr_xlock_hard(lk, flags, ilk, file, line, lwa);
930 flags &= ~LK_INTERLOCK;
932 lockmgr_exit(flags, ilk, wakeup_swapper);
937 lockmgr_lock_fast_path(struct lock *lk, u_int flags, struct lock_object *ilk,
938 const char *file, int line)
940 struct lock_class *class;
945 if (KERNEL_PANICKED())
948 op = flags & LK_TYPE_MASK;
952 if (LK_CAN_WITNESS(flags))
953 WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER,
954 file, line, flags & LK_INTERLOCK ? ilk : NULL);
955 if (__predict_false(lk->lock_object.lo_flags & LK_NOSHARE))
957 if (lockmgr_slock_try(lk, &x, flags, true)) {
958 lockmgr_note_shared_acquire(lk, 0, 0,
962 return (lockmgr_slock_hard(lk, flags, ilk, file, line,
967 if (LK_CAN_WITNESS(flags))
968 WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER |
969 LOP_EXCLUSIVE, file, line, flags & LK_INTERLOCK ?
971 tid = (uintptr_t)curthread;
972 if (lk->lk_lock == LK_UNLOCKED &&
973 atomic_cmpset_acq_ptr(&lk->lk_lock, LK_UNLOCKED, tid)) {
974 lockmgr_note_exclusive_acquire(lk, 0, 0, file, line,
978 return (lockmgr_xlock_hard(lk, flags, ilk, file, line,
984 return (lockmgr_upgrade(lk, flags, ilk, file, line, NULL));
988 if (__predict_true(locked)) {
989 if (__predict_false(flags & LK_INTERLOCK)) {
990 class = LOCK_CLASS(ilk);
991 class->lc_unlock(ilk);
995 return (__lockmgr_args(lk, flags, ilk, LK_WMESG_DEFAULT,
996 LK_PRIO_DEFAULT, LK_TIMO_DEFAULT, file, line));
1000 static __noinline int
1001 lockmgr_sunlock_hard(struct lock *lk, uintptr_t x, u_int flags, struct lock_object *ilk,
1002 const char *file, int line)
1005 int wakeup_swapper = 0;
1007 if (KERNEL_PANICKED())
1010 wakeup_swapper = wakeupshlk(lk, file, line);
1013 lockmgr_exit(flags, ilk, wakeup_swapper);
1017 static __noinline int
1018 lockmgr_xunlock_hard(struct lock *lk, uintptr_t x, u_int flags, struct lock_object *ilk,
1019 const char *file, int line)
1022 int wakeup_swapper = 0;
1026 if (KERNEL_PANICKED())
1029 tid = (uintptr_t)curthread;
1032 * As first option, treact the lock as if it has not
1034 * Fix-up the tid var if the lock has been disowned.
1036 if (LK_HOLDER(x) == LK_KERNPROC)
1040 * The lock is held in exclusive mode.
1041 * If the lock is recursed also, then unrecurse it.
1043 if (lockmgr_xlocked_v(x) && lockmgr_recursed(lk)) {
1044 LOCK_LOG2(lk, "%s: %p unrecursing", __func__, lk);
1048 if (tid != LK_KERNPROC)
1049 LOCKSTAT_PROFILE_RELEASE_RWLOCK(lockmgr__release, lk,
1052 if (x == tid && atomic_cmpset_rel_ptr(&lk->lk_lock, tid, LK_UNLOCKED))
1055 sleepq_lock(&lk->lock_object);
1060 * If the lock has exclusive waiters, give them
1061 * preference in order to avoid deadlock with
1062 * shared runners up.
1063 * If interruptible sleeps left the exclusive queue
1064 * empty avoid a starvation for the threads sleeping
1065 * on the shared queue by giving them precedence
1066 * and cleaning up the exclusive waiters bit anyway.
1067 * Please note that lk_exslpfail count may be lying
1068 * about the real number of waiters with the
1069 * LK_SLEEPFAIL flag on because they may be used in
1070 * conjunction with interruptible sleeps so
1071 * lk_exslpfail might be considered an 'upper limit'
1072 * bound, including the edge cases.
1074 MPASS((x & LK_EXCLUSIVE_SPINNERS) == 0);
1075 realexslp = sleepq_sleepcnt(&lk->lock_object, SQ_EXCLUSIVE_QUEUE);
1076 if ((x & LK_EXCLUSIVE_WAITERS) != 0 && realexslp != 0) {
1077 if (lk->lk_exslpfail < realexslp) {
1078 lk->lk_exslpfail = 0;
1079 queue = SQ_EXCLUSIVE_QUEUE;
1080 v |= (x & LK_SHARED_WAITERS);
1082 lk->lk_exslpfail = 0;
1084 "%s: %p has only LK_SLEEPFAIL sleepers",
1087 "%s: %p waking up threads on the exclusive queue",
1089 wakeup_swapper = sleepq_broadcast(&lk->lock_object,
1090 SLEEPQ_LK, 0, SQ_EXCLUSIVE_QUEUE);
1091 queue = SQ_SHARED_QUEUE;
1096 * Exclusive waiters sleeping with LK_SLEEPFAIL
1097 * on and using interruptible sleeps/timeout
1098 * may have left spourious lk_exslpfail counts
1099 * on, so clean it up anyway.
1101 lk->lk_exslpfail = 0;
1102 queue = SQ_SHARED_QUEUE;
1105 LOCK_LOG3(lk, "%s: %p waking up threads on the %s queue",
1106 __func__, lk, queue == SQ_SHARED_QUEUE ? "shared" :
1108 atomic_store_rel_ptr(&lk->lk_lock, v);
1109 wakeup_swapper |= sleepq_broadcast(&lk->lock_object, SLEEPQ_LK, 0, queue);
1110 sleepq_release(&lk->lock_object);
1113 lockmgr_exit(flags, ilk, wakeup_swapper);
1118 lockmgr_unlock_fast_path(struct lock *lk, u_int flags, struct lock_object *ilk)
1120 struct lock_class *class;
1125 if (KERNEL_PANICKED())
1131 _lockmgr_assert(lk, KA_LOCKED, file, line);
1133 if (__predict_true(x & LK_SHARE) != 0) {
1134 lockmgr_note_shared_release(lk, file, line);
1135 if (lockmgr_sunlock_try(lk, &x)) {
1136 LOCKSTAT_PROFILE_RELEASE_RWLOCK(lockmgr__release, lk, LOCKSTAT_READER);
1138 return (lockmgr_sunlock_hard(lk, x, flags, ilk, file, line));
1141 tid = (uintptr_t)curthread;
1142 lockmgr_note_exclusive_release(lk, file, line);
1143 if (!lockmgr_recursed(lk) &&
1144 atomic_cmpset_rel_ptr(&lk->lk_lock, tid, LK_UNLOCKED)) {
1145 LOCKSTAT_PROFILE_RELEASE_RWLOCK(lockmgr__release, lk, LOCKSTAT_WRITER);
1147 return (lockmgr_xunlock_hard(lk, x, flags, ilk, file, line));
1150 if (__predict_false(flags & LK_INTERLOCK)) {
1151 class = LOCK_CLASS(ilk);
1152 class->lc_unlock(ilk);
1158 * Lightweight entry points for common operations.
1160 * Functionality is similar to sx locks, in that none of the additional lockmgr
1161 * features are supported. To be clear, these are NOT supported:
1162 * 1. shared locking disablement
1163 * 2. returning with an error after sleep
1164 * 3. unlocking the interlock
1166 * If in doubt, use lockmgr_*_fast_path.
1169 lockmgr_slock(struct lock *lk, u_int flags, const char *file, int line)
1173 MPASS((flags & LK_TYPE_MASK) == LK_SHARED);
1174 MPASS((flags & LK_INTERLOCK) == 0);
1175 MPASS((lk->lock_object.lo_flags & LK_NOSHARE) == 0);
1177 if (LK_CAN_WITNESS(flags))
1178 WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER,
1180 if (__predict_true(lockmgr_slock_try(lk, &x, flags, true))) {
1181 lockmgr_note_shared_acquire(lk, 0, 0, file, line, flags);
1185 return (lockmgr_slock_hard(lk, flags, NULL, file, line, NULL));
1189 lockmgr_xlock(struct lock *lk, u_int flags, const char *file, int line)
1193 MPASS((flags & LK_TYPE_MASK) == LK_EXCLUSIVE);
1194 MPASS((flags & LK_INTERLOCK) == 0);
1196 if (LK_CAN_WITNESS(flags))
1197 WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER |
1198 LOP_EXCLUSIVE, file, line, NULL);
1199 tid = (uintptr_t)curthread;
1200 if (atomic_cmpset_acq_ptr(&lk->lk_lock, LK_UNLOCKED, tid)) {
1201 lockmgr_note_exclusive_acquire(lk, 0, 0, file, line,
1206 return (lockmgr_xlock_hard(lk, flags, NULL, file, line, NULL));
1210 lockmgr_unlock(struct lock *lk)
1219 _lockmgr_assert(lk, KA_LOCKED, file, line);
1221 if (__predict_true(x & LK_SHARE) != 0) {
1222 lockmgr_note_shared_release(lk, file, line);
1223 if (lockmgr_sunlock_try(lk, &x)) {
1224 LOCKSTAT_PROFILE_RELEASE_RWLOCK(lockmgr__release, lk, LOCKSTAT_READER);
1226 return (lockmgr_sunlock_hard(lk, x, LK_RELEASE, NULL, file, line));
1229 tid = (uintptr_t)curthread;
1230 lockmgr_note_exclusive_release(lk, file, line);
1231 if (!lockmgr_recursed(lk) &&
1232 atomic_cmpset_rel_ptr(&lk->lk_lock, tid, LK_UNLOCKED)) {
1233 LOCKSTAT_PROFILE_RELEASE_RWLOCK(lockmgr__release, lk, LOCKSTAT_WRITER);
1235 return (lockmgr_xunlock_hard(lk, x, LK_RELEASE, NULL, file, line));
1242 __lockmgr_args(struct lock *lk, u_int flags, struct lock_object *ilk,
1243 const char *wmesg, int pri, int timo, const char *file, int line)
1246 struct lockmgr_wait lwa;
1247 struct lock_class *class;
1249 uintptr_t tid, v, x;
1250 u_int op, realexslp;
1251 int error, ipri, itimo, queue, wakeup_swapper;
1252 #ifdef LOCK_PROFILING
1253 uint64_t waittime = 0;
1257 if (KERNEL_PANICKED())
1261 tid = (uintptr_t)curthread;
1262 op = (flags & LK_TYPE_MASK);
1263 iwmesg = (wmesg == LK_WMESG_DEFAULT) ? lk->lock_object.lo_name : wmesg;
1264 ipri = (pri == LK_PRIO_DEFAULT) ? lk->lk_pri : pri;
1265 itimo = (timo == LK_TIMO_DEFAULT) ? lk->lk_timo : timo;
1267 lwa.iwmesg = iwmesg;
1271 MPASS((flags & ~LK_TOTAL_MASK) == 0);
1272 KASSERT((op & (op - 1)) == 0,
1273 ("%s: Invalid requested operation @ %s:%d", __func__, file, line));
1274 KASSERT((flags & (LK_NOWAIT | LK_SLEEPFAIL)) == 0 ||
1275 (op != LK_DOWNGRADE && op != LK_RELEASE),
1276 ("%s: Invalid flags in regard of the operation desired @ %s:%d",
1277 __func__, file, line));
1278 KASSERT((flags & LK_INTERLOCK) == 0 || ilk != NULL,
1279 ("%s: LK_INTERLOCK passed without valid interlock @ %s:%d",
1280 __func__, file, line));
1281 KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread),
1282 ("%s: idle thread %p on lockmgr %s @ %s:%d", __func__, curthread,
1283 lk->lock_object.lo_name, file, line));
1285 class = (flags & LK_INTERLOCK) ? LOCK_CLASS(ilk) : NULL;
1287 if (lk->lock_object.lo_flags & LK_NOSHARE) {
1295 _lockmgr_assert(lk, KA_XLOCKED | KA_NOTRECURSED,
1297 if (flags & LK_INTERLOCK)
1298 class->lc_unlock(ilk);
1306 return (lockmgr_slock_hard(lk, flags, ilk, file, line, &lwa));
1310 return (lockmgr_upgrade(lk, flags, ilk, file, line, &lwa));
1313 return (lockmgr_xlock_hard(lk, flags, ilk, file, line, &lwa));
1316 _lockmgr_assert(lk, KA_XLOCKED, file, line);
1317 WITNESS_DOWNGRADE(&lk->lock_object, 0, file, line);
1320 * Panic if the lock is recursed.
1322 if (lockmgr_xlocked(lk) && lockmgr_recursed(lk)) {
1323 if (flags & LK_INTERLOCK)
1324 class->lc_unlock(ilk);
1325 panic("%s: downgrade a recursed lockmgr %s @ %s:%d\n",
1326 __func__, iwmesg, file, line);
1328 TD_SLOCKS_INC(curthread);
1331 * In order to preserve waiters flags, just spin.
1335 MPASS((x & LK_EXCLUSIVE_SPINNERS) == 0);
1336 x &= LK_ALL_WAITERS;
1337 if (atomic_cmpset_rel_ptr(&lk->lk_lock, tid | x,
1338 LK_SHARERS_LOCK(1) | x))
1342 LOCK_LOG_LOCK("XDOWNGRADE", &lk->lock_object, 0, 0, file, line);
1343 LOCKSTAT_RECORD0(lockmgr__downgrade, lk);
1346 _lockmgr_assert(lk, KA_LOCKED, file, line);
1349 if (__predict_true(x & LK_SHARE) != 0) {
1350 lockmgr_note_shared_release(lk, file, line);
1351 return (lockmgr_sunlock_hard(lk, x, flags, ilk, file, line));
1353 lockmgr_note_exclusive_release(lk, file, line);
1354 return (lockmgr_xunlock_hard(lk, x, flags, ilk, file, line));
1358 if (LK_CAN_WITNESS(flags))
1359 WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER |
1360 LOP_EXCLUSIVE, file, line, flags & LK_INTERLOCK ?
1364 * Trying to drain a lock we already own will result in a
1367 if (lockmgr_xlocked(lk)) {
1368 if (flags & LK_INTERLOCK)
1369 class->lc_unlock(ilk);
1370 panic("%s: draining %s with the lock held @ %s:%d\n",
1371 __func__, iwmesg, file, line);
1375 if (lk->lk_lock == LK_UNLOCKED &&
1376 atomic_cmpset_acq_ptr(&lk->lk_lock, LK_UNLOCKED, tid))
1380 PMC_SOFT_CALL( , , lock, failed);
1382 lock_profile_obtain_lock_failed(&lk->lock_object,
1383 &contested, &waittime);
1386 * If the lock is expected to not sleep just give up
1389 if (LK_TRYOP(flags)) {
1390 LOCK_LOG2(lk, "%s: %p fails the try operation",
1397 * Acquire the sleepqueue chain lock because we
1398 * probabilly will need to manipulate waiters flags.
1400 sleepq_lock(&lk->lock_object);
1404 * if the lock has been released while we spun on
1405 * the sleepqueue chain lock just try again.
1407 if (x == LK_UNLOCKED) {
1408 sleepq_release(&lk->lock_object);
1412 v = x & (LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS);
1413 if ((x & ~v) == LK_UNLOCKED) {
1414 v = (x & ~LK_EXCLUSIVE_SPINNERS);
1417 * If interruptible sleeps left the exclusive
1418 * queue empty avoid a starvation for the
1419 * threads sleeping on the shared queue by
1420 * giving them precedence and cleaning up the
1421 * exclusive waiters bit anyway.
1422 * Please note that lk_exslpfail count may be
1423 * lying about the real number of waiters with
1424 * the LK_SLEEPFAIL flag on because they may
1425 * be used in conjunction with interruptible
1426 * sleeps so lk_exslpfail might be considered
1427 * an 'upper limit' bound, including the edge
1430 if (v & LK_EXCLUSIVE_WAITERS) {
1431 queue = SQ_EXCLUSIVE_QUEUE;
1432 v &= ~LK_EXCLUSIVE_WAITERS;
1436 * Exclusive waiters sleeping with
1437 * LK_SLEEPFAIL on and using
1438 * interruptible sleeps/timeout may
1439 * have left spourious lk_exslpfail
1440 * counts on, so clean it up anyway.
1442 MPASS(v & LK_SHARED_WAITERS);
1443 lk->lk_exslpfail = 0;
1444 queue = SQ_SHARED_QUEUE;
1445 v &= ~LK_SHARED_WAITERS;
1447 if (queue == SQ_EXCLUSIVE_QUEUE) {
1449 sleepq_sleepcnt(&lk->lock_object,
1450 SQ_EXCLUSIVE_QUEUE);
1451 if (lk->lk_exslpfail >= realexslp) {
1452 lk->lk_exslpfail = 0;
1453 queue = SQ_SHARED_QUEUE;
1454 v &= ~LK_SHARED_WAITERS;
1455 if (realexslp != 0) {
1457 "%s: %p has only LK_SLEEPFAIL sleepers",
1460 "%s: %p waking up threads on the exclusive queue",
1466 SQ_EXCLUSIVE_QUEUE);
1469 lk->lk_exslpfail = 0;
1471 if (!atomic_cmpset_ptr(&lk->lk_lock, x, v)) {
1472 sleepq_release(&lk->lock_object);
1476 "%s: %p waking up all threads on the %s queue",
1477 __func__, lk, queue == SQ_SHARED_QUEUE ?
1478 "shared" : "exclusive");
1479 wakeup_swapper |= sleepq_broadcast(
1480 &lk->lock_object, SLEEPQ_LK, 0, queue);
1483 * If shared waiters have been woken up we need
1484 * to wait for one of them to acquire the lock
1485 * before to set the exclusive waiters in
1486 * order to avoid a deadlock.
1488 if (queue == SQ_SHARED_QUEUE) {
1489 for (v = lk->lk_lock;
1490 (v & LK_SHARE) && !LK_SHARERS(v);
1497 * Try to set the LK_EXCLUSIVE_WAITERS flag. If we
1498 * fail, loop back and retry.
1500 if ((x & LK_EXCLUSIVE_WAITERS) == 0) {
1501 if (!atomic_cmpset_ptr(&lk->lk_lock, x,
1502 x | LK_EXCLUSIVE_WAITERS)) {
1503 sleepq_release(&lk->lock_object);
1506 LOCK_LOG2(lk, "%s: %p set drain waiters flag",
1511 * As far as we have been unable to acquire the
1512 * exclusive lock and the exclusive waiters flag
1513 * is set, we will sleep.
1515 if (flags & LK_INTERLOCK) {
1516 class->lc_unlock(ilk);
1517 flags &= ~LK_INTERLOCK;
1520 sleepq_add(&lk->lock_object, NULL, iwmesg, SLEEPQ_LK,
1521 SQ_EXCLUSIVE_QUEUE);
1522 sleepq_wait(&lk->lock_object, ipri & PRIMASK);
1524 LOCK_LOG2(lk, "%s: %p resuming from the sleep queue",
1529 lock_profile_obtain_lock_success(&lk->lock_object,
1530 contested, waittime, file, line);
1531 LOCK_LOG_LOCK("DRAIN", &lk->lock_object, 0,
1532 lk->lk_recurse, file, line);
1533 WITNESS_LOCK(&lk->lock_object, LOP_EXCLUSIVE |
1534 LK_TRYWIT(flags), file, line);
1535 TD_LOCKS_INC(curthread);
1540 if (flags & LK_INTERLOCK)
1541 class->lc_unlock(ilk);
1542 panic("%s: unknown lockmgr request 0x%x\n", __func__, op);
1545 if (flags & LK_INTERLOCK)
1546 class->lc_unlock(ilk);
1554 _lockmgr_disown(struct lock *lk, const char *file, int line)
1558 if (SCHEDULER_STOPPED())
1561 tid = (uintptr_t)curthread;
1562 _lockmgr_assert(lk, KA_XLOCKED, file, line);
1565 * Panic if the lock is recursed.
1567 if (lockmgr_xlocked(lk) && lockmgr_recursed(lk))
1568 panic("%s: disown a recursed lockmgr @ %s:%d\n",
1569 __func__, file, line);
1572 * If the owner is already LK_KERNPROC just skip the whole operation.
1574 if (LK_HOLDER(lk->lk_lock) != tid)
1576 lock_profile_release_lock(&lk->lock_object);
1577 LOCKSTAT_RECORD1(lockmgr__disown, lk, LOCKSTAT_WRITER);
1578 LOCK_LOG_LOCK("XDISOWN", &lk->lock_object, 0, 0, file, line);
1579 WITNESS_UNLOCK(&lk->lock_object, LOP_EXCLUSIVE, file, line);
1580 TD_LOCKS_DEC(curthread);
1584 * In order to preserve waiters flags, just spin.
1588 MPASS((x & LK_EXCLUSIVE_SPINNERS) == 0);
1589 x &= LK_ALL_WAITERS;
1590 if (atomic_cmpset_rel_ptr(&lk->lk_lock, tid | x,
1598 lockmgr_printinfo(const struct lock *lk)
1603 if (lk->lk_lock == LK_UNLOCKED)
1604 printf("lock type %s: UNLOCKED\n", lk->lock_object.lo_name);
1605 else if (lk->lk_lock & LK_SHARE)
1606 printf("lock type %s: SHARED (count %ju)\n",
1607 lk->lock_object.lo_name,
1608 (uintmax_t)LK_SHARERS(lk->lk_lock));
1610 td = lockmgr_xholder(lk);
1611 if (td == (struct thread *)LK_KERNPROC)
1612 printf("lock type %s: EXCL by KERNPROC\n",
1613 lk->lock_object.lo_name);
1615 printf("lock type %s: EXCL by thread %p "
1616 "(pid %d, %s, tid %d)\n", lk->lock_object.lo_name,
1617 td, td->td_proc->p_pid, td->td_proc->p_comm,
1622 if (x & LK_EXCLUSIVE_WAITERS)
1623 printf(" with exclusive waiters pending\n");
1624 if (x & LK_SHARED_WAITERS)
1625 printf(" with shared waiters pending\n");
1626 if (x & LK_EXCLUSIVE_SPINNERS)
1627 printf(" with exclusive spinners pending\n");
1633 lockstatus(const struct lock *lk)
1642 if ((x & LK_SHARE) == 0) {
1643 if (v == (uintptr_t)curthread || v == LK_KERNPROC)
1647 } else if (x == LK_UNLOCKED)
1653 #ifdef INVARIANT_SUPPORT
1655 FEATURE(invariant_support,
1656 "Support for modules compiled with INVARIANTS option");
1659 #undef _lockmgr_assert
1663 _lockmgr_assert(const struct lock *lk, int what, const char *file, int line)
1667 if (KERNEL_PANICKED())
1671 case KA_SLOCKED | KA_NOTRECURSED:
1672 case KA_SLOCKED | KA_RECURSED:
1675 case KA_LOCKED | KA_NOTRECURSED:
1676 case KA_LOCKED | KA_RECURSED:
1680 * We cannot trust WITNESS if the lock is held in exclusive
1681 * mode and a call to lockmgr_disown() happened.
1682 * Workaround this skipping the check if the lock is held in
1683 * exclusive mode even for the KA_LOCKED case.
1685 if (slocked || (lk->lk_lock & LK_SHARE)) {
1686 witness_assert(&lk->lock_object, what, file, line);
1690 if (lk->lk_lock == LK_UNLOCKED ||
1691 ((lk->lk_lock & LK_SHARE) == 0 && (slocked ||
1692 (!lockmgr_xlocked(lk) && !lockmgr_disowned(lk)))))
1693 panic("Lock %s not %slocked @ %s:%d\n",
1694 lk->lock_object.lo_name, slocked ? "share" : "",
1697 if ((lk->lk_lock & LK_SHARE) == 0) {
1698 if (lockmgr_recursed(lk)) {
1699 if (what & KA_NOTRECURSED)
1700 panic("Lock %s recursed @ %s:%d\n",
1701 lk->lock_object.lo_name, file,
1703 } else if (what & KA_RECURSED)
1704 panic("Lock %s not recursed @ %s:%d\n",
1705 lk->lock_object.lo_name, file, line);
1709 case KA_XLOCKED | KA_NOTRECURSED:
1710 case KA_XLOCKED | KA_RECURSED:
1711 if (!lockmgr_xlocked(lk) && !lockmgr_disowned(lk))
1712 panic("Lock %s not exclusively locked @ %s:%d\n",
1713 lk->lock_object.lo_name, file, line);
1714 if (lockmgr_recursed(lk)) {
1715 if (what & KA_NOTRECURSED)
1716 panic("Lock %s recursed @ %s:%d\n",
1717 lk->lock_object.lo_name, file, line);
1718 } else if (what & KA_RECURSED)
1719 panic("Lock %s not recursed @ %s:%d\n",
1720 lk->lock_object.lo_name, file, line);
1723 if (lockmgr_xlocked(lk) || lockmgr_disowned(lk))
1724 panic("Lock %s exclusively locked @ %s:%d\n",
1725 lk->lock_object.lo_name, file, line);
1728 panic("Unknown lockmgr assertion: %d @ %s:%d\n", what, file,
1736 lockmgr_chain(struct thread *td, struct thread **ownerp)
1738 const struct lock *lk;
1742 if (LOCK_CLASS(&lk->lock_object) != &lock_class_lockmgr)
1744 db_printf("blocked on lockmgr %s", lk->lock_object.lo_name);
1745 if (lk->lk_lock & LK_SHARE)
1746 db_printf("SHARED (count %ju)\n",
1747 (uintmax_t)LK_SHARERS(lk->lk_lock));
1749 db_printf("EXCL\n");
1750 *ownerp = lockmgr_xholder(lk);
1756 db_show_lockmgr(const struct lock_object *lock)
1759 const struct lock *lk;
1761 lk = (const struct lock *)lock;
1763 db_printf(" state: ");
1764 if (lk->lk_lock == LK_UNLOCKED)
1765 db_printf("UNLOCKED\n");
1766 else if (lk->lk_lock & LK_SHARE)
1767 db_printf("SLOCK: %ju\n", (uintmax_t)LK_SHARERS(lk->lk_lock));
1769 td = lockmgr_xholder(lk);
1770 if (td == (struct thread *)LK_KERNPROC)
1771 db_printf("XLOCK: LK_KERNPROC\n");
1773 db_printf("XLOCK: %p (tid %d, pid %d, \"%s\")\n", td,
1774 td->td_tid, td->td_proc->p_pid,
1775 td->td_proc->p_comm);
1776 if (lockmgr_recursed(lk))
1777 db_printf(" recursed: %d\n", lk->lk_recurse);
1779 db_printf(" waiters: ");
1780 switch (lk->lk_lock & LK_ALL_WAITERS) {
1781 case LK_SHARED_WAITERS:
1782 db_printf("shared\n");
1784 case LK_EXCLUSIVE_WAITERS:
1785 db_printf("exclusive\n");
1787 case LK_ALL_WAITERS:
1788 db_printf("shared and exclusive\n");
1791 db_printf("none\n");
1793 db_printf(" spinners: ");
1794 if (lk->lk_lock & LK_EXCLUSIVE_SPINNERS)
1795 db_printf("exclusive\n");
1797 db_printf("none\n");