2 * Copyright (c) 2005 Antoine Brodin
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/kernel.h>
37 #include <sys/linker.h>
38 #include <sys/malloc.h>
40 #include <sys/stack.h>
41 #include <sys/systm.h>
42 #include <sys/sysctl.h>
44 FEATURE(stack, "Support for capturing kernel stack");
46 static MALLOC_DEFINE(M_STACK, "stack", "Stack Traces");
48 static int stack_symbol(vm_offset_t pc, char *namebuf, u_int buflen,
50 static int stack_symbol_ddb(vm_offset_t pc, const char **name, long *offset);
57 st = malloc(sizeof *st, M_STACK, M_WAITOK | M_ZERO);
62 stack_destroy(struct stack *st)
69 stack_put(struct stack *st, vm_offset_t pc)
72 if (st->depth < STACK_MAX) {
73 st->pcs[st->depth++] = pc;
80 stack_copy(const struct stack *src, struct stack *dst)
87 stack_zero(struct stack *st)
90 bzero(st, sizeof *st);
94 stack_print(const struct stack *st)
100 KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
101 for (i = 0; i < st->depth; i++) {
102 (void)stack_symbol(st->pcs[i], namebuf, sizeof(namebuf),
104 printf("#%d %p at %s+%#lx\n", i, (void *)st->pcs[i],
110 stack_print_short(const struct stack *st)
116 KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
117 for (i = 0; i < st->depth; i++) {
120 if (stack_symbol(st->pcs[i], namebuf, sizeof(namebuf),
122 printf("%s+%#lx", namebuf, offset);
124 printf("%p", (void *)st->pcs[i]);
130 stack_print_ddb(const struct stack *st)
136 KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
137 for (i = 0; i < st->depth; i++) {
138 stack_symbol_ddb(st->pcs[i], &name, &offset);
139 printf("#%d %p at %s+%#lx\n", i, (void *)st->pcs[i],
144 #if defined(DDB) || defined(WITNESS)
146 stack_print_short_ddb(const struct stack *st)
152 KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
153 for (i = 0; i < st->depth; i++) {
156 if (stack_symbol_ddb(st->pcs[i], &name, &offset) == 0)
157 printf("%s+%#lx", name, offset);
159 printf("%p", (void *)st->pcs[i]);
166 * Two print routines -- one for use from DDB and DDB-like contexts, the
167 * other for use in the live kernel.
170 stack_sbuf_print(struct sbuf *sb, const struct stack *st)
176 KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
177 for (i = 0; i < st->depth; i++) {
178 (void)stack_symbol(st->pcs[i], namebuf, sizeof(namebuf),
180 sbuf_printf(sb, "#%d %p at %s+%#lx\n", i, (void *)st->pcs[i],
185 #if defined(DDB) || defined(WITNESS)
187 stack_sbuf_print_ddb(struct sbuf *sb, const struct stack *st)
193 KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
194 for (i = 0; i < st->depth; i++) {
195 (void)stack_symbol_ddb(st->pcs[i], &name, &offset);
196 sbuf_printf(sb, "#%d %p at %s+%#lx\n", i, (void *)st->pcs[i],
204 stack_ktr(u_int mask, const char *file, int line, const struct stack *st,
205 u_int depth, int cheap)
213 KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
215 ktr_tracepoint(mask, file, line, "#0 %p %p %p %p %p %p",
216 st->pcs[0], st->pcs[1], st->pcs[2], st->pcs[3],
217 st->pcs[4], st->pcs[5]);
220 ktr_tracepoint(mask, file, line, "#1 %p %p %p %p %p %p",
221 st->pcs[6], st->pcs[7], st->pcs[8], st->pcs[9],
222 st->pcs[10], st->pcs[11]);
225 ktr_tracepoint(mask, file, line, "#2 %p %p %p %p %p %p",
226 st->pcs[12], st->pcs[13], st->pcs[14], st->pcs[15],
227 st->pcs[16], st->pcs[17]);
230 if (depth == 0 || st->depth < depth)
232 for (i = 0; i < depth; i++) {
233 (void)stack_symbol_ddb(st->pcs[i], &name, &offset);
234 ktr_tracepoint(mask, file, line, "#%d %p at %s+%#lx",
235 i, st->pcs[i], (u_long)name, offset, 0, 0);
243 * Two variants of stack symbol lookup -- one that uses the DDB interfaces
244 * and bypasses linker locking, and the other that doesn't.
247 stack_symbol(vm_offset_t pc, char *namebuf, u_int buflen, long *offset)
250 if (linker_search_symbol_name((caddr_t)pc, namebuf, buflen,
253 strlcpy(namebuf, "??", buflen);
260 stack_symbol_ddb(vm_offset_t pc, const char **name, long *offset)
262 linker_symval_t symval;
265 if (linker_ddb_search_symbol((caddr_t)pc, &sym, offset) != 0)
267 if (linker_ddb_symbol_values(sym, &symval) != 0)
269 if (symval.name != NULL) {