xref: /netbsd-src/sys/kern/subr_debug.c (revision bfb6cb13d599546df69c7e4d20d70e22e15a549d)
1 /*	$NetBSD: subr_debug.c,v 1.2 2007/02/09 21:55:31 ad Exp $	*/
2 
3 /*-
4  * Copyright (c) 2007 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Andrew Doran.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the NetBSD
21  *	Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * Shared support code for kernels built with the DEBUG option.
41  */
42 
43 #include <sys/cdefs.h>
44 __KERNEL_RCSID(0, "$NetBSD: subr_debug.c,v 1.2 2007/02/09 21:55:31 ad Exp $");
45 
46 #include "opt_ddb.h"
47 
48 #include <sys/param.h>
49 #include <sys/proc.h>
50 #include <sys/systm.h>
51 #include <sys/kmem.h>
52 #include <sys/debug.h>
53 
54 #include <uvm/uvm_extern.h>
55 
56 #include <machine/lock.h>
57 #include <machine/cpu.h>
58 
59 /*
60  * Allocation/free validation by pointer address.  Introduces
61  * significant overhead and is not enabled by default.  Patch
62  * `debug_freecheck' to 1 at boot time to enable.
63  */
64 #define	FREECHECK_BYTES		(8*1024*1024)
65 
66 typedef struct fcitem {
67 	void		*i_addr;
68 	struct fcitem	*i_next;
69 } fcitem_t;
70 
71 fcitem_t		*freecheck_free;
72 __cpu_simple_lock_t	freecheck_lock;
73 int			debug_freecheck;
74 
75 void
76 debug_init(void)
77 {
78 	size_t cnt;
79 	fcitem_t *i;
80 
81 	__cpu_simple_lock_init(&freecheck_lock);
82 
83 	if (debug_freecheck) {
84 		i = (fcitem_t *)uvm_km_alloc(kernel_map, FREECHECK_BYTES, 0,
85 		    UVM_KMF_WIRED);
86 		if (i == NULL) {
87 			printf("freecheck_init: unable to allocate memory");
88 			return;
89 		}
90 
91 		for (cnt = FREECHECK_BYTES / sizeof(*i); cnt != 0; cnt--) {
92 			i->i_next = freecheck_free;
93 			freecheck_free = i++;
94 		}
95 	}
96 }
97 
98 void
99 freecheck_out(void **head, void *addr)
100 {
101 	fcitem_t *i;
102 	int s;
103 
104 	if (!debug_freecheck)
105 		return;
106 
107 	s = splvm();
108 	__cpu_simple_lock(&freecheck_lock);
109 	if ((i = freecheck_free) != NULL) {
110 		freecheck_free = i->i_next;
111 		i->i_addr = addr;
112 		i->i_next = *head;
113 		*head = i;
114 	}
115 	__cpu_simple_unlock(&freecheck_lock);
116 	splx(s);
117 
118 	if (i == NULL) {
119 		printf("freecheck_out: no more slots");
120 		debug_freecheck = 0;
121 	}
122 }
123 
124 void
125 freecheck_in(void **head, void *addr)
126 {
127 	fcitem_t *i;
128 	void *pp;
129 	int s;
130 
131 	if (!debug_freecheck)
132 		return;
133 
134 	s = splvm();
135 	__cpu_simple_lock(&freecheck_lock);
136 	for (i = *head, pp = head; i != NULL; pp = &i->i_next, i = i->i_next) {
137 		if (i->i_addr == addr) {
138 			*(fcitem_t **)pp = i->i_next;
139 			i->i_next = freecheck_free;
140 			freecheck_free = i;
141 			break;
142 		}
143 	}
144 	__cpu_simple_unlock(&freecheck_lock);
145 	splx(s);
146 
147 	if (i != NULL)
148 		return;
149 
150 #ifdef DDB
151 	printf("freecheck_in: %p not out", addr);
152 	Debugger();
153 #else
154 	panic("freecheck_in: %p not out", addr);
155 #endif
156 }
157