Home | History | Annotate | Line # | Download | only in kern
subr_lockdebug.c revision 1.37.4.1
      1  1.37.4.1    skrll /*	$NetBSD: subr_lockdebug.c,v 1.37.4.1 2009/01/19 13:19:39 skrll Exp $	*/
      2       1.2       ad 
      3       1.2       ad /*-
      4      1.28       ad  * Copyright (c) 2006, 2007, 2008 The NetBSD Foundation, Inc.
      5       1.2       ad  * All rights reserved.
      6       1.2       ad  *
      7       1.2       ad  * This code is derived from software contributed to The NetBSD Foundation
      8       1.2       ad  * by Andrew Doran.
      9       1.2       ad  *
     10       1.2       ad  * Redistribution and use in source and binary forms, with or without
     11       1.2       ad  * modification, are permitted provided that the following conditions
     12       1.2       ad  * are met:
     13       1.2       ad  * 1. Redistributions of source code must retain the above copyright
     14       1.2       ad  *    notice, this list of conditions and the following disclaimer.
     15       1.2       ad  * 2. Redistributions in binary form must reproduce the above copyright
     16       1.2       ad  *    notice, this list of conditions and the following disclaimer in the
     17       1.2       ad  *    documentation and/or other materials provided with the distribution.
     18       1.2       ad  *
     19       1.2       ad  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20       1.2       ad  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21       1.2       ad  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22       1.2       ad  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23       1.2       ad  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24       1.2       ad  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25       1.2       ad  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26       1.2       ad  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27       1.2       ad  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28       1.2       ad  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29       1.2       ad  * POSSIBILITY OF SUCH DAMAGE.
     30       1.2       ad  */
     31       1.2       ad 
     32       1.2       ad /*
     33      1.11       ad  * Basic lock debugging code shared among lock primitives.
     34       1.2       ad  */
     35       1.2       ad 
     36       1.9      dsl #include <sys/cdefs.h>
     37  1.37.4.1    skrll __KERNEL_RCSID(0, "$NetBSD: subr_lockdebug.c,v 1.37.4.1 2009/01/19 13:19:39 skrll Exp $");
     38       1.9      dsl 
     39       1.2       ad #include "opt_ddb.h"
     40       1.2       ad 
     41       1.2       ad #include <sys/param.h>
     42       1.2       ad #include <sys/proc.h>
     43       1.2       ad #include <sys/systm.h>
     44      1.10       ad #include <sys/kernel.h>
     45       1.2       ad #include <sys/kmem.h>
     46       1.2       ad #include <sys/lockdebug.h>
     47       1.2       ad #include <sys/sleepq.h>
     48      1.10       ad #include <sys/cpu.h>
     49      1.22       ad #include <sys/atomic.h>
     50      1.26       ad #include <sys/lock.h>
     51      1.36       ad #include <sys/rb.h>
     52      1.16     yamt 
     53      1.25       ad #include <machine/lock.h>
     54      1.25       ad 
     55      1.28       ad unsigned int		ld_panic;
     56      1.28       ad 
     57       1.2       ad #ifdef LOCKDEBUG
     58       1.2       ad 
     59       1.2       ad #define	LD_BATCH_SHIFT	9
     60       1.2       ad #define	LD_BATCH	(1 << LD_BATCH_SHIFT)
     61       1.2       ad #define	LD_BATCH_MASK	(LD_BATCH - 1)
     62       1.2       ad #define	LD_MAX_LOCKS	1048576
     63       1.2       ad #define	LD_SLOP		16
     64       1.2       ad 
     65       1.2       ad #define	LD_LOCKED	0x01
     66       1.2       ad #define	LD_SLEEPER	0x02
     67       1.2       ad 
     68      1.23       ad #define	LD_WRITE_LOCK	0x80000000
     69      1.23       ad 
     70       1.2       ad typedef struct lockdebug {
     71      1.16     yamt 	struct rb_node	ld_rb_node;	/* must be the first member */
     72      1.34       ad 	__cpu_simple_lock_t ld_spinlock;
     73       1.2       ad 	_TAILQ_ENTRY(struct lockdebug, volatile) ld_chain;
     74       1.2       ad 	_TAILQ_ENTRY(struct lockdebug, volatile) ld_achain;
     75       1.2       ad 	volatile void	*ld_lock;
     76       1.2       ad 	lockops_t	*ld_lockops;
     77       1.2       ad 	struct lwp	*ld_lwp;
     78       1.2       ad 	uintptr_t	ld_locked;
     79       1.2       ad 	uintptr_t	ld_unlocked;
     80      1.10       ad 	uintptr_t	ld_initaddr;
     81       1.2       ad 	uint16_t	ld_shares;
     82       1.2       ad 	uint16_t	ld_cpu;
     83       1.2       ad 	uint8_t		ld_flags;
     84       1.2       ad 	uint8_t		ld_shwant;	/* advisory */
     85       1.2       ad 	uint8_t		ld_exwant;	/* advisory */
     86       1.2       ad 	uint8_t		ld_unused;
     87       1.2       ad } volatile lockdebug_t;
     88       1.2       ad 
     89       1.2       ad typedef _TAILQ_HEAD(lockdebuglist, struct lockdebug, volatile) lockdebuglist_t;
     90       1.2       ad 
     91      1.34       ad __cpu_simple_lock_t	ld_mod_lk;
     92      1.13     matt lockdebuglist_t		ld_free = TAILQ_HEAD_INITIALIZER(ld_free);
     93      1.13     matt lockdebuglist_t		ld_all = TAILQ_HEAD_INITIALIZER(ld_all);
     94       1.2       ad int			ld_nfree;
     95       1.2       ad int			ld_freeptr;
     96       1.2       ad int			ld_recurse;
     97       1.5       ad bool			ld_nomore;
     98       1.2       ad lockdebug_t		ld_prime[LD_BATCH];
     99       1.2       ad 
    100      1.34       ad static void	lockdebug_abort1(lockdebug_t *, int, const char *,
    101      1.34       ad 				 const char *, bool);
    102      1.34       ad static int	lockdebug_more(int);
    103       1.5       ad static void	lockdebug_init(void);
    104       1.2       ad 
    105      1.16     yamt static signed int
    106      1.37     matt ld_rbto_compare_nodes(const struct rb_node *n1, const struct rb_node *n2)
    107      1.16     yamt {
    108      1.16     yamt 	const lockdebug_t *ld1 = (const void *)n1;
    109      1.16     yamt 	const lockdebug_t *ld2 = (const void *)n2;
    110      1.20     yamt 	const uintptr_t a = (uintptr_t)ld1->ld_lock;
    111      1.20     yamt 	const uintptr_t b = (uintptr_t)ld2->ld_lock;
    112      1.20     yamt 
    113      1.20     yamt 	if (a < b)
    114      1.20     yamt 		return 1;
    115      1.20     yamt 	if (a > b)
    116      1.16     yamt 		return -1;
    117      1.16     yamt 	return 0;
    118      1.16     yamt }
    119      1.16     yamt 
    120      1.16     yamt static signed int
    121      1.37     matt ld_rbto_compare_key(const struct rb_node *n, const void *key)
    122      1.16     yamt {
    123      1.16     yamt 	const lockdebug_t *ld = (const void *)n;
    124      1.20     yamt 	const uintptr_t a = (uintptr_t)ld->ld_lock;
    125      1.20     yamt 	const uintptr_t b = (uintptr_t)key;
    126      1.20     yamt 
    127      1.20     yamt 	if (a < b)
    128      1.20     yamt 		return 1;
    129      1.20     yamt 	if (a > b)
    130      1.16     yamt 		return -1;
    131      1.16     yamt 	return 0;
    132      1.16     yamt }
    133      1.16     yamt 
    134      1.16     yamt static struct rb_tree ld_rb_tree;
    135      1.16     yamt 
    136      1.16     yamt static const struct rb_tree_ops ld_rb_tree_ops = {
    137      1.37     matt 	.rbto_compare_nodes = ld_rbto_compare_nodes,
    138      1.37     matt 	.rbto_compare_key = ld_rbto_compare_key,
    139      1.16     yamt };
    140      1.16     yamt 
    141      1.34       ad static inline lockdebug_t *
    142      1.34       ad lockdebug_lookup1(volatile void *lock)
    143      1.23       ad {
    144      1.34       ad 	lockdebug_t *ld;
    145      1.34       ad 	struct cpu_info *ci;
    146      1.23       ad 
    147      1.34       ad 	ci = curcpu();
    148      1.34       ad 	__cpu_simple_lock(&ci->ci_data.cpu_ld_lock);
    149      1.34       ad 	ld = (lockdebug_t *)rb_tree_find_node(&ld_rb_tree, __UNVOLATILE(lock));
    150      1.34       ad 	__cpu_simple_unlock(&ci->ci_data.cpu_ld_lock);
    151      1.34       ad 	if (ld == NULL) {
    152      1.34       ad 		return NULL;
    153      1.34       ad 	}
    154      1.34       ad 	__cpu_simple_lock(&ld->ld_spinlock);
    155      1.23       ad 
    156      1.34       ad 	return ld;
    157       1.2       ad }
    158       1.2       ad 
    159      1.23       ad static void
    160      1.34       ad lockdebug_lock_cpus(void)
    161       1.2       ad {
    162      1.34       ad 	CPU_INFO_ITERATOR cii;
    163      1.34       ad 	struct cpu_info *ci;
    164       1.2       ad 
    165      1.34       ad 	for (CPU_INFO_FOREACH(cii, ci)) {
    166      1.34       ad 		__cpu_simple_lock(&ci->ci_data.cpu_ld_lock);
    167      1.34       ad 	}
    168      1.23       ad }
    169      1.23       ad 
    170      1.23       ad static void
    171      1.34       ad lockdebug_unlock_cpus(void)
    172      1.23       ad {
    173      1.34       ad 	CPU_INFO_ITERATOR cii;
    174      1.34       ad 	struct cpu_info *ci;
    175      1.23       ad 
    176      1.34       ad 	for (CPU_INFO_FOREACH(cii, ci)) {
    177      1.34       ad 		__cpu_simple_unlock(&ci->ci_data.cpu_ld_lock);
    178      1.34       ad 	}
    179       1.2       ad }
    180       1.2       ad 
    181       1.2       ad /*
    182      1.19     yamt  * lockdebug_lookup:
    183      1.19     yamt  *
    184      1.19     yamt  *	Find a lockdebug structure by a pointer to a lock and return it locked.
    185      1.19     yamt  */
    186      1.19     yamt static inline lockdebug_t *
    187  1.37.4.1    skrll lockdebug_lookup(volatile void *lock, uintptr_t where)
    188      1.19     yamt {
    189      1.19     yamt 	lockdebug_t *ld;
    190      1.19     yamt 
    191      1.34       ad 	ld = lockdebug_lookup1(lock);
    192      1.19     yamt 	if (ld == NULL)
    193  1.37.4.1    skrll 		panic("lockdebug_lookup: uninitialized lock (lock=%p, from=%08"PRIxPTR")", lock, where);
    194      1.19     yamt 	return ld;
    195      1.19     yamt }
    196      1.19     yamt 
    197      1.19     yamt /*
    198       1.2       ad  * lockdebug_init:
    199       1.2       ad  *
    200       1.2       ad  *	Initialize the lockdebug system.  Allocate an initial pool of
    201       1.2       ad  *	lockdebug structures before the VM system is up and running.
    202       1.2       ad  */
    203       1.5       ad static void
    204       1.2       ad lockdebug_init(void)
    205       1.2       ad {
    206       1.2       ad 	lockdebug_t *ld;
    207       1.2       ad 	int i;
    208       1.2       ad 
    209      1.34       ad 	TAILQ_INIT(&curcpu()->ci_data.cpu_ld_locks);
    210      1.34       ad 	TAILQ_INIT(&curlwp->l_ld_locks);
    211      1.34       ad 	__cpu_simple_lock_init(&curcpu()->ci_data.cpu_ld_lock);
    212      1.34       ad 	__cpu_simple_lock_init(&ld_mod_lk);
    213      1.15     matt 
    214      1.16     yamt 	rb_tree_init(&ld_rb_tree, &ld_rb_tree_ops);
    215      1.16     yamt 
    216       1.2       ad 	ld = ld_prime;
    217       1.2       ad 	for (i = 1, ld++; i < LD_BATCH; i++, ld++) {
    218      1.34       ad 		__cpu_simple_lock_init(&ld->ld_spinlock);
    219       1.2       ad 		TAILQ_INSERT_TAIL(&ld_free, ld, ld_chain);
    220       1.2       ad 		TAILQ_INSERT_TAIL(&ld_all, ld, ld_achain);
    221       1.2       ad 	}
    222       1.2       ad 	ld_freeptr = 1;
    223       1.2       ad 	ld_nfree = LD_BATCH - 1;
    224       1.2       ad }
    225       1.2       ad 
    226       1.2       ad /*
    227       1.2       ad  * lockdebug_alloc:
    228       1.2       ad  *
    229       1.2       ad  *	A lock is being initialized, so allocate an associated debug
    230       1.2       ad  *	structure.
    231       1.2       ad  */
    232      1.16     yamt bool
    233      1.10       ad lockdebug_alloc(volatile void *lock, lockops_t *lo, uintptr_t initaddr)
    234       1.2       ad {
    235       1.2       ad 	struct cpu_info *ci;
    236       1.2       ad 	lockdebug_t *ld;
    237      1.34       ad 	int s;
    238       1.2       ad 
    239      1.27       ad 	if (lo == NULL || panicstr != NULL || ld_panic)
    240      1.16     yamt 		return false;
    241       1.5       ad 	if (ld_freeptr == 0)
    242       1.5       ad 		lockdebug_init();
    243       1.2       ad 
    244      1.34       ad 	s = splhigh();
    245      1.34       ad 	__cpu_simple_lock(&ld_mod_lk);
    246      1.34       ad 	if ((ld = lockdebug_lookup1(lock)) != NULL) {
    247      1.34       ad 		__cpu_simple_unlock(&ld_mod_lk);
    248      1.34       ad 		lockdebug_abort1(ld, s, __func__, "already initialized", true);
    249      1.27       ad 		return false;
    250      1.19     yamt 	}
    251      1.19     yamt 
    252       1.2       ad 	/*
    253       1.2       ad 	 * Pinch a new debug structure.  We may recurse because we call
    254       1.2       ad 	 * kmem_alloc(), which may need to initialize new locks somewhere
    255       1.7    skrll 	 * down the path.  If not recursing, we try to maintain at least
    256       1.2       ad 	 * LD_SLOP structures free, which should hopefully be enough to
    257       1.2       ad 	 * satisfy kmem_alloc().  If we can't provide a structure, not to
    258       1.2       ad 	 * worry: we'll just mark the lock as not having an ID.
    259       1.2       ad 	 */
    260      1.23       ad 	ci = curcpu();
    261       1.2       ad 	ci->ci_lkdebug_recurse++;
    262       1.2       ad 	if (TAILQ_EMPTY(&ld_free)) {
    263       1.5       ad 		if (ci->ci_lkdebug_recurse > 1 || ld_nomore) {
    264       1.2       ad 			ci->ci_lkdebug_recurse--;
    265      1.34       ad 			__cpu_simple_unlock(&ld_mod_lk);
    266      1.34       ad 			splx(s);
    267      1.16     yamt 			return false;
    268       1.2       ad 		}
    269      1.34       ad 		s = lockdebug_more(s);
    270      1.34       ad 	} else if (ci->ci_lkdebug_recurse == 1 && ld_nfree < LD_SLOP) {
    271      1.34       ad 		s = lockdebug_more(s);
    272      1.34       ad 	}
    273       1.2       ad 	if ((ld = TAILQ_FIRST(&ld_free)) == NULL) {
    274      1.34       ad 		__cpu_simple_unlock(&ld_mod_lk);
    275      1.34       ad 		splx(s);
    276      1.16     yamt 		return false;
    277       1.2       ad 	}
    278       1.2       ad 	TAILQ_REMOVE(&ld_free, ld, ld_chain);
    279       1.2       ad 	ld_nfree--;
    280       1.2       ad 	ci->ci_lkdebug_recurse--;
    281       1.2       ad 
    282      1.34       ad 	if (ld->ld_lock != NULL) {
    283       1.2       ad 		panic("lockdebug_alloc: corrupt table");
    284      1.34       ad 	}
    285       1.2       ad 
    286       1.2       ad 	/* Initialise the structure. */
    287       1.2       ad 	ld->ld_lock = lock;
    288       1.2       ad 	ld->ld_lockops = lo;
    289       1.2       ad 	ld->ld_locked = 0;
    290       1.2       ad 	ld->ld_unlocked = 0;
    291       1.2       ad 	ld->ld_lwp = NULL;
    292      1.10       ad 	ld->ld_initaddr = initaddr;
    293      1.35       ad 	ld->ld_flags = (lo->lo_type == LOCKOPS_SLEEP ? LD_SLEEPER : 0);
    294      1.34       ad 	lockdebug_lock_cpus();
    295      1.16     yamt 	rb_tree_insert_node(&ld_rb_tree, __UNVOLATILE(&ld->ld_rb_node));
    296      1.34       ad 	lockdebug_unlock_cpus();
    297      1.34       ad 	__cpu_simple_unlock(&ld_mod_lk);
    298       1.2       ad 
    299      1.34       ad 	splx(s);
    300      1.16     yamt 	return true;
    301       1.2       ad }
    302       1.2       ad 
    303       1.2       ad /*
    304       1.2       ad  * lockdebug_free:
    305       1.2       ad  *
    306       1.2       ad  *	A lock is being destroyed, so release debugging resources.
    307       1.2       ad  */
    308       1.2       ad void
    309      1.16     yamt lockdebug_free(volatile void *lock)
    310       1.2       ad {
    311       1.2       ad 	lockdebug_t *ld;
    312      1.34       ad 	int s;
    313       1.2       ad 
    314      1.27       ad 	if (panicstr != NULL || ld_panic)
    315       1.2       ad 		return;
    316       1.2       ad 
    317      1.34       ad 	s = splhigh();
    318      1.34       ad 	__cpu_simple_lock(&ld_mod_lk);
    319  1.37.4.1    skrll 	ld = lockdebug_lookup(lock, (uintptr_t) __builtin_return_address(0));
    320      1.16     yamt 	if (ld == NULL) {
    321      1.34       ad 		__cpu_simple_unlock(&ld_mod_lk);
    322      1.35       ad 		panic("lockdebug_free: destroying uninitialized object %p"
    323      1.16     yamt 		    "(ld_lock=%p)", lock, ld->ld_lock);
    324      1.35       ad 		lockdebug_abort1(ld, s, __func__, "record follows", true);
    325      1.27       ad 		return;
    326       1.2       ad 	}
    327      1.27       ad 	if ((ld->ld_flags & LD_LOCKED) != 0 || ld->ld_shares != 0) {
    328      1.34       ad 		__cpu_simple_unlock(&ld_mod_lk);
    329      1.35       ad 		lockdebug_abort1(ld, s, __func__, "is locked or in use", true);
    330      1.27       ad 		return;
    331      1.27       ad 	}
    332      1.34       ad 	lockdebug_lock_cpus();
    333      1.16     yamt 	rb_tree_remove_node(&ld_rb_tree, __UNVOLATILE(&ld->ld_rb_node));
    334      1.34       ad 	lockdebug_unlock_cpus();
    335       1.2       ad 	ld->ld_lock = NULL;
    336       1.2       ad 	TAILQ_INSERT_TAIL(&ld_free, ld, ld_chain);
    337       1.2       ad 	ld_nfree++;
    338      1.34       ad 	__cpu_simple_unlock(&ld->ld_spinlock);
    339      1.34       ad 	__cpu_simple_unlock(&ld_mod_lk);
    340      1.34       ad 	splx(s);
    341       1.2       ad }
    342       1.2       ad 
    343       1.2       ad /*
    344       1.2       ad  * lockdebug_more:
    345       1.2       ad  *
    346       1.2       ad  *	Allocate a batch of debug structures and add to the free list.
    347      1.34       ad  *	Must be called with ld_mod_lk held.
    348       1.2       ad  */
    349      1.34       ad static int
    350      1.34       ad lockdebug_more(int s)
    351       1.2       ad {
    352       1.2       ad 	lockdebug_t *ld;
    353       1.2       ad 	void *block;
    354       1.5       ad 	int i, base, m;
    355       1.2       ad 
    356      1.35       ad 	/*
    357      1.35       ad 	 * Can't call kmem_alloc() if in interrupt context.  XXX We could
    358      1.35       ad 	 * deadlock, because we don't know which locks the caller holds.
    359      1.35       ad 	 */
    360      1.35       ad 	if (cpu_intr_p() || (curlwp->l_pflag & LP_INTR) != 0) {
    361      1.35       ad 		return s;
    362      1.35       ad 	}
    363      1.35       ad 
    364       1.2       ad 	while (ld_nfree < LD_SLOP) {
    365      1.34       ad 		__cpu_simple_unlock(&ld_mod_lk);
    366      1.34       ad 		splx(s);
    367       1.2       ad 		block = kmem_zalloc(LD_BATCH * sizeof(lockdebug_t), KM_SLEEP);
    368      1.34       ad 		s = splhigh();
    369      1.34       ad 		__cpu_simple_lock(&ld_mod_lk);
    370       1.2       ad 
    371       1.2       ad 		if (block == NULL)
    372      1.34       ad 			return s;
    373       1.2       ad 
    374       1.2       ad 		if (ld_nfree > LD_SLOP) {
    375       1.2       ad 			/* Somebody beat us to it. */
    376      1.34       ad 			__cpu_simple_unlock(&ld_mod_lk);
    377      1.34       ad 			splx(s);
    378       1.2       ad 			kmem_free(block, LD_BATCH * sizeof(lockdebug_t));
    379      1.34       ad 			s = splhigh();
    380      1.34       ad 			__cpu_simple_lock(&ld_mod_lk);
    381       1.2       ad 			continue;
    382       1.2       ad 		}
    383       1.2       ad 
    384       1.2       ad 		base = ld_freeptr;
    385       1.2       ad 		ld_nfree += LD_BATCH;
    386       1.2       ad 		ld = block;
    387       1.2       ad 		base <<= LD_BATCH_SHIFT;
    388       1.5       ad 		m = min(LD_MAX_LOCKS, base + LD_BATCH);
    389       1.5       ad 
    390       1.5       ad 		if (m == LD_MAX_LOCKS)
    391       1.5       ad 			ld_nomore = true;
    392       1.2       ad 
    393       1.5       ad 		for (i = base; i < m; i++, ld++) {
    394      1.34       ad 			__cpu_simple_lock_init(&ld->ld_spinlock);
    395       1.2       ad 			TAILQ_INSERT_TAIL(&ld_free, ld, ld_chain);
    396       1.2       ad 			TAILQ_INSERT_TAIL(&ld_all, ld, ld_achain);
    397       1.2       ad 		}
    398       1.2       ad 
    399      1.22       ad 		membar_producer();
    400       1.2       ad 	}
    401      1.34       ad 
    402      1.34       ad 	return s;
    403       1.2       ad }
    404       1.2       ad 
    405       1.2       ad /*
    406       1.2       ad  * lockdebug_wantlock:
    407       1.2       ad  *
    408       1.2       ad  *	Process the preamble to a lock acquire.
    409       1.2       ad  */
    410       1.2       ad void
    411      1.33       ad lockdebug_wantlock(volatile void *lock, uintptr_t where, bool shared,
    412      1.33       ad 		   bool trylock)
    413       1.2       ad {
    414       1.2       ad 	struct lwp *l = curlwp;
    415       1.2       ad 	lockdebug_t *ld;
    416       1.3  thorpej 	bool recurse;
    417      1.34       ad 	int s;
    418       1.2       ad 
    419       1.2       ad 	(void)shared;
    420       1.4  thorpej 	recurse = false;
    421       1.2       ad 
    422      1.27       ad 	if (panicstr != NULL || ld_panic)
    423       1.2       ad 		return;
    424       1.2       ad 
    425      1.34       ad 	s = splhigh();
    426  1.37.4.1    skrll 	if ((ld = lockdebug_lookup(lock, where)) == NULL) {
    427      1.34       ad 		splx(s);
    428       1.2       ad 		return;
    429      1.34       ad 	}
    430      1.32     yamt 	if ((ld->ld_flags & LD_LOCKED) != 0 || ld->ld_shares != 0) {
    431       1.2       ad 		if ((ld->ld_flags & LD_SLEEPER) != 0) {
    432      1.33       ad 			if (ld->ld_lwp == l && !(shared && trylock))
    433       1.4  thorpej 				recurse = true;
    434       1.2       ad 		} else if (ld->ld_cpu == (uint16_t)cpu_number())
    435       1.4  thorpej 			recurse = true;
    436       1.2       ad 	}
    437      1.10       ad 	if (cpu_intr_p()) {
    438      1.27       ad 		if ((ld->ld_flags & LD_SLEEPER) != 0) {
    439      1.34       ad 			lockdebug_abort1(ld, s, __func__,
    440      1.10       ad 			    "acquiring sleep lock from interrupt context",
    441      1.10       ad 			    true);
    442      1.27       ad 			return;
    443      1.27       ad 		}
    444      1.10       ad 	}
    445       1.2       ad 	if (shared)
    446       1.2       ad 		ld->ld_shwant++;
    447       1.2       ad 	else
    448       1.2       ad 		ld->ld_exwant++;
    449      1.27       ad 	if (recurse) {
    450      1.34       ad 		lockdebug_abort1(ld, s, __func__, "locking against myself",
    451      1.10       ad 		    true);
    452      1.27       ad 		return;
    453      1.27       ad 	}
    454      1.34       ad 	__cpu_simple_unlock(&ld->ld_spinlock);
    455      1.34       ad 	splx(s);
    456       1.2       ad }
    457       1.2       ad 
    458       1.2       ad /*
    459       1.2       ad  * lockdebug_locked:
    460       1.2       ad  *
    461       1.2       ad  *	Process a lock acquire operation.
    462       1.2       ad  */
    463       1.2       ad void
    464      1.35       ad lockdebug_locked(volatile void *lock, void *cvlock, uintptr_t where,
    465      1.35       ad 		 int shared)
    466       1.2       ad {
    467       1.2       ad 	struct lwp *l = curlwp;
    468       1.2       ad 	lockdebug_t *ld;
    469      1.34       ad 	int s;
    470       1.2       ad 
    471      1.27       ad 	if (panicstr != NULL || ld_panic)
    472       1.2       ad 		return;
    473       1.2       ad 
    474      1.34       ad 	s = splhigh();
    475  1.37.4.1    skrll 	if ((ld = lockdebug_lookup(lock, where)) == NULL) {
    476      1.34       ad 		splx(s);
    477       1.2       ad 		return;
    478      1.34       ad 	}
    479      1.35       ad 	if (cvlock) {
    480      1.35       ad 		KASSERT(ld->ld_lockops->lo_type == LOCKOPS_CV);
    481      1.35       ad 		if (lock == (void *)&lbolt) {
    482      1.35       ad 			/* nothing */
    483      1.35       ad 		} else if (ld->ld_shares++ == 0) {
    484      1.35       ad 			ld->ld_locked = (uintptr_t)cvlock;
    485      1.35       ad 		} else if (cvlock != (void *)ld->ld_locked) {
    486      1.35       ad 			lockdebug_abort1(ld, s, __func__, "multiple locks used"
    487      1.35       ad 			    " with condition variable", true);
    488      1.35       ad 			return;
    489      1.35       ad 		}
    490      1.35       ad 	} else if (shared) {
    491       1.2       ad 		l->l_shlocks++;
    492       1.2       ad 		ld->ld_shares++;
    493       1.2       ad 		ld->ld_shwant--;
    494       1.2       ad 	} else {
    495      1.27       ad 		if ((ld->ld_flags & LD_LOCKED) != 0) {
    496      1.34       ad 			lockdebug_abort1(ld, s, __func__, "already locked",
    497      1.34       ad 			    true);
    498      1.27       ad 			return;
    499      1.27       ad 		}
    500       1.2       ad 		ld->ld_flags |= LD_LOCKED;
    501       1.2       ad 		ld->ld_locked = where;
    502       1.2       ad 		ld->ld_exwant--;
    503       1.2       ad 		if ((ld->ld_flags & LD_SLEEPER) != 0) {
    504      1.34       ad 			TAILQ_INSERT_TAIL(&l->l_ld_locks, ld, ld_chain);
    505       1.2       ad 		} else {
    506      1.34       ad 			TAILQ_INSERT_TAIL(&curcpu()->ci_data.cpu_ld_locks,
    507      1.34       ad 			    ld, ld_chain);
    508       1.2       ad 		}
    509       1.2       ad 	}
    510      1.32     yamt 	ld->ld_cpu = (uint16_t)cpu_number();
    511      1.32     yamt 	ld->ld_lwp = l;
    512      1.34       ad 	__cpu_simple_unlock(&ld->ld_spinlock);
    513      1.34       ad 	splx(s);
    514       1.2       ad }
    515       1.2       ad 
    516       1.2       ad /*
    517       1.2       ad  * lockdebug_unlocked:
    518       1.2       ad  *
    519       1.2       ad  *	Process a lock release operation.
    520       1.2       ad  */
    521       1.2       ad void
    522      1.16     yamt lockdebug_unlocked(volatile void *lock, uintptr_t where, int shared)
    523       1.2       ad {
    524       1.2       ad 	struct lwp *l = curlwp;
    525       1.2       ad 	lockdebug_t *ld;
    526      1.34       ad 	int s;
    527       1.2       ad 
    528      1.27       ad 	if (panicstr != NULL || ld_panic)
    529       1.2       ad 		return;
    530       1.2       ad 
    531      1.34       ad 	s = splhigh();
    532  1.37.4.1    skrll 	if ((ld = lockdebug_lookup(lock, where)) == NULL) {
    533      1.34       ad 		splx(s);
    534       1.2       ad 		return;
    535      1.34       ad 	}
    536      1.35       ad 	if (ld->ld_lockops->lo_type == LOCKOPS_CV) {
    537      1.35       ad 		if (lock == (void *)&lbolt) {
    538      1.35       ad 			/* nothing */
    539      1.35       ad 		} else {
    540      1.35       ad 			ld->ld_shares--;
    541      1.35       ad 		}
    542      1.35       ad 	} else if (shared) {
    543      1.27       ad 		if (l->l_shlocks == 0) {
    544      1.34       ad 			lockdebug_abort1(ld, s, __func__,
    545      1.10       ad 			    "no shared locks held by LWP", true);
    546      1.27       ad 			return;
    547      1.27       ad 		}
    548      1.27       ad 		if (ld->ld_shares == 0) {
    549      1.34       ad 			lockdebug_abort1(ld, s, __func__,
    550      1.10       ad 			    "no shared holds on this lock", true);
    551      1.27       ad 			return;
    552      1.27       ad 		}
    553       1.2       ad 		l->l_shlocks--;
    554       1.2       ad 		ld->ld_shares--;
    555      1.32     yamt 		if (ld->ld_lwp == l)
    556      1.32     yamt 			ld->ld_lwp = NULL;
    557      1.32     yamt 		if (ld->ld_cpu == (uint16_t)cpu_number())
    558      1.32     yamt 			ld->ld_cpu = (uint16_t)-1;
    559       1.2       ad 	} else {
    560      1.27       ad 		if ((ld->ld_flags & LD_LOCKED) == 0) {
    561      1.34       ad 			lockdebug_abort1(ld, s, __func__, "not locked", true);
    562      1.27       ad 			return;
    563      1.27       ad 		}
    564       1.2       ad 
    565       1.2       ad 		if ((ld->ld_flags & LD_SLEEPER) != 0) {
    566      1.27       ad 			if (ld->ld_lwp != curlwp) {
    567      1.34       ad 				lockdebug_abort1(ld, s, __func__,
    568      1.10       ad 				    "not held by current LWP", true);
    569      1.27       ad 				return;
    570      1.27       ad 			}
    571       1.2       ad 			ld->ld_flags &= ~LD_LOCKED;
    572       1.2       ad 			ld->ld_unlocked = where;
    573       1.2       ad 			ld->ld_lwp = NULL;
    574      1.34       ad 			TAILQ_REMOVE(&l->l_ld_locks, ld, ld_chain);
    575       1.2       ad 		} else {
    576      1.27       ad 			if (ld->ld_cpu != (uint16_t)cpu_number()) {
    577      1.34       ad 				lockdebug_abort1(ld, s, __func__,
    578      1.10       ad 				    "not held by current CPU", true);
    579      1.27       ad 				return;
    580      1.27       ad 			}
    581       1.2       ad 			ld->ld_flags &= ~LD_LOCKED;
    582       1.2       ad 			ld->ld_unlocked = where;
    583       1.2       ad 			ld->ld_lwp = NULL;
    584      1.34       ad 			TAILQ_REMOVE(&curcpu()->ci_data.cpu_ld_locks, ld,
    585      1.34       ad 			    ld_chain);
    586       1.2       ad 		}
    587       1.2       ad 	}
    588      1.34       ad 	__cpu_simple_unlock(&ld->ld_spinlock);
    589      1.34       ad 	splx(s);
    590       1.2       ad }
    591       1.2       ad 
    592       1.2       ad /*
    593      1.35       ad  * lockdebug_wakeup:
    594      1.35       ad  *
    595      1.35       ad  *	Process a wakeup on a condition variable.
    596      1.35       ad  */
    597      1.35       ad void
    598      1.35       ad lockdebug_wakeup(volatile void *lock, uintptr_t where)
    599      1.35       ad {
    600      1.35       ad 	lockdebug_t *ld;
    601      1.35       ad 	int s;
    602      1.35       ad 
    603      1.35       ad 	if (panicstr != NULL || ld_panic || lock == (void *)&lbolt)
    604      1.35       ad 		return;
    605      1.35       ad 
    606      1.35       ad 	s = splhigh();
    607      1.35       ad 	/* Find the CV... */
    608  1.37.4.1    skrll 	if ((ld = lockdebug_lookup(lock, where)) == NULL) {
    609      1.35       ad 		splx(s);
    610      1.35       ad 		return;
    611      1.35       ad 	}
    612      1.35       ad 	/*
    613      1.35       ad 	 * If it has any waiters, ensure that they are using the
    614      1.35       ad 	 * same interlock.
    615      1.35       ad 	 */
    616      1.35       ad 	if (ld->ld_shares != 0 && !mutex_owned((kmutex_t *)ld->ld_locked)) {
    617      1.35       ad 		lockdebug_abort1(ld, s, __func__, "interlocking mutex not "
    618      1.35       ad 		    "held during wakeup", true);
    619      1.35       ad 		return;
    620      1.35       ad 	}
    621      1.35       ad 	__cpu_simple_unlock(&ld->ld_spinlock);
    622      1.35       ad 	splx(s);
    623      1.35       ad }
    624      1.35       ad 
    625      1.35       ad /*
    626       1.2       ad  * lockdebug_barrier:
    627       1.2       ad  *
    628       1.2       ad  *	Panic if we hold more than one specified spin lock, and optionally,
    629       1.2       ad  *	if we hold sleep locks.
    630       1.2       ad  */
    631       1.2       ad void
    632       1.2       ad lockdebug_barrier(volatile void *spinlock, int slplocks)
    633       1.2       ad {
    634       1.2       ad 	struct lwp *l = curlwp;
    635       1.2       ad 	lockdebug_t *ld;
    636      1.34       ad 	int s;
    637       1.2       ad 
    638      1.27       ad 	if (panicstr != NULL || ld_panic)
    639       1.2       ad 		return;
    640       1.2       ad 
    641      1.34       ad 	s = splhigh();
    642      1.34       ad 	if ((l->l_pflag & LP_INTR) == 0) {
    643      1.34       ad 		TAILQ_FOREACH(ld, &curcpu()->ci_data.cpu_ld_locks, ld_chain) {
    644       1.2       ad 			if (ld->ld_lock == spinlock) {
    645       1.2       ad 				continue;
    646       1.2       ad 			}
    647      1.34       ad 			__cpu_simple_lock(&ld->ld_spinlock);
    648      1.34       ad 			lockdebug_abort1(ld, s, __func__,
    649      1.34       ad 			    "spin lock held", true);
    650      1.34       ad 			return;
    651       1.2       ad 		}
    652       1.2       ad 	}
    653      1.34       ad 	if (slplocks) {
    654      1.34       ad 		splx(s);
    655      1.34       ad 		return;
    656      1.34       ad 	}
    657      1.34       ad 	if ((ld = TAILQ_FIRST(&l->l_ld_locks)) != NULL) {
    658      1.34       ad 		__cpu_simple_lock(&ld->ld_spinlock);
    659      1.34       ad 		lockdebug_abort1(ld, s, __func__, "sleep lock held", true);
    660      1.34       ad 		return;
    661      1.34       ad 	}
    662      1.34       ad 	splx(s);
    663      1.34       ad 	if (l->l_shlocks != 0) {
    664      1.34       ad 		panic("lockdebug_barrier: holding %d shared locks",
    665      1.34       ad 		    l->l_shlocks);
    666       1.2       ad 	}
    667       1.2       ad }
    668       1.2       ad 
    669       1.2       ad /*
    670      1.10       ad  * lockdebug_mem_check:
    671      1.10       ad  *
    672      1.10       ad  *	Check for in-use locks within a memory region that is
    673      1.16     yamt  *	being freed.
    674      1.10       ad  */
    675      1.10       ad void
    676      1.10       ad lockdebug_mem_check(const char *func, void *base, size_t sz)
    677      1.10       ad {
    678      1.16     yamt 	lockdebug_t *ld;
    679      1.34       ad 	struct cpu_info *ci;
    680      1.23       ad 	int s;
    681      1.10       ad 
    682      1.27       ad 	if (panicstr != NULL || ld_panic)
    683      1.24       ad 		return;
    684      1.24       ad 
    685      1.34       ad 	s = splhigh();
    686      1.34       ad 	ci = curcpu();
    687      1.34       ad 	__cpu_simple_lock(&ci->ci_data.cpu_ld_lock);
    688      1.16     yamt 	ld = (lockdebug_t *)rb_tree_find_node_geq(&ld_rb_tree, base);
    689      1.23       ad 	if (ld != NULL) {
    690      1.23       ad 		const uintptr_t lock = (uintptr_t)ld->ld_lock;
    691      1.23       ad 
    692      1.23       ad 		if ((uintptr_t)base > lock)
    693      1.23       ad 			panic("%s: corrupt tree ld=%p, base=%p, sz=%zu",
    694      1.23       ad 			    __func__, ld, base, sz);
    695      1.23       ad 		if (lock >= (uintptr_t)base + sz)
    696      1.23       ad 			ld = NULL;
    697      1.23       ad 	}
    698      1.34       ad 	__cpu_simple_unlock(&ci->ci_data.cpu_ld_lock);
    699      1.34       ad 	if (ld != NULL) {
    700      1.34       ad 		__cpu_simple_lock(&ld->ld_spinlock);
    701      1.34       ad 		lockdebug_abort1(ld, s, func,
    702      1.34       ad 		    "allocation contains active lock", !cold);
    703      1.16     yamt 		return;
    704      1.34       ad 	}
    705      1.34       ad 	splx(s);
    706      1.10       ad }
    707      1.10       ad 
    708      1.10       ad /*
    709       1.2       ad  * lockdebug_dump:
    710       1.2       ad  *
    711       1.2       ad  *	Dump information about a lock on panic, or for DDB.
    712       1.2       ad  */
    713       1.2       ad static void
    714       1.2       ad lockdebug_dump(lockdebug_t *ld, void (*pr)(const char *, ...))
    715       1.2       ad {
    716       1.2       ad 	int sleeper = (ld->ld_flags & LD_SLEEPER);
    717       1.2       ad 
    718       1.2       ad 	(*pr)(
    719       1.2       ad 	    "lock address : %#018lx type     : %18s\n"
    720      1.35       ad 	    "initialized  : %#018lx",
    721       1.2       ad 	    (long)ld->ld_lock, (sleeper ? "sleep/adaptive" : "spin"),
    722      1.10       ad 	    (long)ld->ld_initaddr);
    723       1.2       ad 
    724      1.35       ad 	if (ld->ld_lockops->lo_type == LOCKOPS_CV) {
    725      1.35       ad 		(*pr)(" interlock: %#018lx\n", ld->ld_locked);
    726      1.35       ad 	} else {
    727      1.35       ad 		(*pr)("\n"
    728      1.35       ad 		    "shared holds : %18u exclusive: %18u\n"
    729      1.35       ad 		    "shares wanted: %18u exclusive: %18u\n"
    730      1.35       ad 		    "current cpu  : %18u last held: %18u\n"
    731      1.35       ad 		    "current lwp  : %#018lx last held: %#018lx\n"
    732      1.35       ad 		    "last locked  : %#018lx unlocked : %#018lx\n",
    733      1.35       ad 		    (unsigned)ld->ld_shares, ((ld->ld_flags & LD_LOCKED) != 0),
    734      1.35       ad 		    (unsigned)ld->ld_shwant, (unsigned)ld->ld_exwant,
    735      1.35       ad 		    (unsigned)cpu_number(), (unsigned)ld->ld_cpu,
    736      1.35       ad 		    (long)curlwp, (long)ld->ld_lwp,
    737      1.35       ad 		    (long)ld->ld_locked, (long)ld->ld_unlocked);
    738      1.35       ad 	}
    739      1.35       ad 
    740       1.2       ad 	if (ld->ld_lockops->lo_dump != NULL)
    741       1.2       ad 		(*ld->ld_lockops->lo_dump)(ld->ld_lock);
    742       1.2       ad 
    743       1.2       ad 	if (sleeper) {
    744       1.2       ad 		(*pr)("\n");
    745       1.2       ad 		turnstile_print(ld->ld_lock, pr);
    746       1.2       ad 	}
    747       1.2       ad }
    748       1.2       ad 
    749       1.2       ad /*
    750      1.27       ad  * lockdebug_abort1:
    751       1.2       ad  *
    752      1.27       ad  *	An error has been trapped - dump lock info and panic.
    753       1.2       ad  */
    754       1.5       ad static void
    755      1.34       ad lockdebug_abort1(lockdebug_t *ld, int s, const char *func,
    756      1.10       ad 		 const char *msg, bool dopanic)
    757       1.2       ad {
    758       1.2       ad 
    759      1.27       ad 	/*
    760      1.27       ad 	 * Don't make the situation wose if the system is already going
    761      1.27       ad 	 * down in flames.  Once a panic is triggered, lockdebug state
    762      1.27       ad 	 * becomes stale and cannot be trusted.
    763      1.27       ad 	 */
    764      1.27       ad 	if (atomic_inc_uint_nv(&ld_panic) != 1) {
    765      1.34       ad 		__cpu_simple_unlock(&ld->ld_spinlock);
    766      1.34       ad 		splx(s);
    767      1.27       ad 		return;
    768      1.27       ad 	}
    769      1.27       ad 
    770       1.2       ad 	printf_nolog("%s error: %s: %s\n\n", ld->ld_lockops->lo_name,
    771       1.2       ad 	    func, msg);
    772       1.2       ad 	lockdebug_dump(ld, printf_nolog);
    773      1.34       ad 	__cpu_simple_unlock(&ld->ld_spinlock);
    774      1.34       ad 	splx(s);
    775       1.2       ad 	printf_nolog("\n");
    776      1.10       ad 	if (dopanic)
    777      1.10       ad 		panic("LOCKDEBUG");
    778       1.2       ad }
    779       1.2       ad 
    780       1.2       ad #endif	/* LOCKDEBUG */
    781       1.2       ad 
    782       1.2       ad /*
    783       1.2       ad  * lockdebug_lock_print:
    784       1.2       ad  *
    785       1.2       ad  *	Handle the DDB 'show lock' command.
    786       1.2       ad  */
    787       1.2       ad #ifdef DDB
    788       1.2       ad void
    789       1.2       ad lockdebug_lock_print(void *addr, void (*pr)(const char *, ...))
    790       1.2       ad {
    791       1.2       ad #ifdef LOCKDEBUG
    792       1.2       ad 	lockdebug_t *ld;
    793       1.2       ad 
    794       1.2       ad 	TAILQ_FOREACH(ld, &ld_all, ld_achain) {
    795       1.2       ad 		if (ld->ld_lock == addr) {
    796       1.2       ad 			lockdebug_dump(ld, pr);
    797       1.2       ad 			return;
    798       1.2       ad 		}
    799       1.2       ad 	}
    800       1.2       ad 	(*pr)("Sorry, no record of a lock with address %p found.\n", addr);
    801       1.2       ad #else
    802       1.2       ad 	(*pr)("Sorry, kernel not built with the LOCKDEBUG option.\n");
    803       1.2       ad #endif	/* LOCKDEBUG */
    804       1.2       ad }
    805       1.2       ad #endif	/* DDB */
    806       1.2       ad 
    807       1.2       ad /*
    808       1.2       ad  * lockdebug_abort:
    809       1.2       ad  *
    810       1.2       ad  *	An error has been trapped - dump lock info and call panic().
    811       1.2       ad  */
    812       1.2       ad void
    813      1.16     yamt lockdebug_abort(volatile void *lock, lockops_t *ops, const char *func,
    814      1.16     yamt 		const char *msg)
    815       1.2       ad {
    816       1.2       ad #ifdef LOCKDEBUG
    817       1.2       ad 	lockdebug_t *ld;
    818      1.34       ad 	int s;
    819       1.2       ad 
    820      1.34       ad 	s = splhigh();
    821  1.37.4.1    skrll 	if ((ld = lockdebug_lookup(lock,
    822  1.37.4.1    skrll 			(uintptr_t) __builtin_return_address(0))) != NULL) {
    823      1.34       ad 		lockdebug_abort1(ld, s, func, msg, true);
    824      1.34       ad 		return;
    825       1.2       ad 	}
    826      1.34       ad 	splx(s);
    827       1.2       ad #endif	/* LOCKDEBUG */
    828       1.2       ad 
    829      1.27       ad 	/*
    830      1.27       ad 	 * Complain first on the occurrance only.  Otherwise proceeed to
    831      1.27       ad 	 * panic where we will `rendezvous' with other CPUs if the machine
    832      1.27       ad 	 * is going down in flames.
    833      1.27       ad 	 */
    834      1.27       ad 	if (atomic_inc_uint_nv(&ld_panic) == 1) {
    835      1.27       ad 		printf_nolog("%s error: %s: %s\n\n"
    836      1.27       ad 		    "lock address : %#018lx\n"
    837      1.27       ad 		    "current cpu  : %18d\n"
    838      1.27       ad 		    "current lwp  : %#018lx\n",
    839      1.27       ad 		    ops->lo_name, func, msg, (long)lock, (int)cpu_number(),
    840      1.27       ad 		    (long)curlwp);
    841      1.27       ad 		(*ops->lo_dump)(lock);
    842      1.27       ad 		printf_nolog("\n");
    843      1.27       ad 	}
    844       1.2       ad 
    845       1.2       ad 	panic("lock error");
    846       1.2       ad }
    847