subr_stack.c revision 174137
1/*- 2 * Copyright (c) 2005 Antoine Brodin 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 13 * 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 24 * SUCH DAMAGE. 25 */ 26 27#include "opt_ddb.h" 28 29#include <sys/cdefs.h> 30__FBSDID("$FreeBSD: head/sys/kern/subr_stack.c 174137 2007-12-01 22:04:16Z rwatson $"); 31 32#include <sys/param.h> 33#include <sys/kernel.h> 34#ifdef KTR 35#include <sys/ktr.h> 36#endif 37#include <sys/linker.h> 38#include <sys/malloc.h> 39#include <sys/sbuf.h> 40#include <sys/stack.h> 41#include <sys/systm.h> 42 43MALLOC_DEFINE(M_STACK, "stack", "Stack Traces"); 44 45static void stack_symbol(vm_offset_t pc, char *namebuf, u_int buflen, 46 long *offset); 47#ifdef DDB 48static void stack_symbol_ddb(vm_offset_t pc, char *namebuf, u_int buflen, 49 long *offset); 50#endif 51 52struct stack * 53stack_create(void) 54{ 55 struct stack *st; 56 57 st = malloc(sizeof *st, M_STACK, M_WAITOK | M_ZERO); 58 return (st); 59} 60 61void 62stack_destroy(struct stack *st) 63{ 64 65 free(st, M_STACK); 66} 67 68int 69stack_put(struct stack *st, vm_offset_t pc) 70{ 71 72 if (st->depth < STACK_MAX) { 73 st->pcs[st->depth++] = pc; 74 return (0); 75 } else 76 return (-1); 77} 78 79void 80stack_copy(struct stack *src, struct stack *dst) 81{ 82 83 *dst = *src; 84} 85 86void 87stack_zero(struct stack *st) 88{ 89 90 bzero(st, sizeof *st); 91} 92 93void 94stack_print(struct stack *st) 95{ 96 char namebuf[64]; 97 long offset; 98 int i; 99 100 KASSERT(st->depth <= STACK_MAX, ("bogus stack")); 101 for (i = 0; i < st->depth; i++) { 102 stack_symbol(st->pcs[i], namebuf, sizeof(namebuf), &offset); 103 printf("#%d %p at %s+%#lx\n", i, (void *)st->pcs[i], 104 namebuf, offset); 105 } 106} 107 108void 109stack_print_ddb(struct stack *st) 110{ 111 char namebuf[64]; 112 long offset; 113 int i; 114 115 KASSERT(st->depth <= STACK_MAX, ("bogus stack")); 116 for (i = 0; i < st->depth; i++) { 117 stack_symbol_ddb(st->pcs[i], namebuf, sizeof(namebuf), 118 &offset); 119 printf("#%d %p at %s+%#lx\n", i, (void *)st->pcs[i], 120 namebuf, offset); 121 } 122} 123 124/* 125 * Two print routines -- one for use from DDB and DDB-like contexts, the 126 * other for use in the live kernel. 127 */ 128void 129stack_sbuf_print(struct sbuf *sb, struct stack *st) 130{ 131 char namebuf[64]; 132 long offset; 133 int i; 134 135 KASSERT(st->depth <= STACK_MAX, ("bogus stack")); 136 for (i = 0; i < st->depth; i++) { 137 stack_symbol(st->pcs[i], namebuf, sizeof(namebuf), &offset); 138 sbuf_printf(sb, "#%d %p at %s+%#lx\n", i, (void *)st->pcs[i], 139 namebuf, offset); 140 } 141} 142 143#ifdef DDB 144void 145stack_sbuf_print_ddb(struct sbuf *sb, struct stack *st) 146{ 147 char namebuf[64]; 148 long offset; 149 int i; 150 151 KASSERT(st->depth <= STACK_MAX, ("bogus stack")); 152 for (i = 0; i < st->depth; i++) { 153 stack_symbol_ddb(st->pcs[i], namebuf, sizeof(namebuf), 154 &offset); 155 sbuf_printf(sb, "#%d %p at %s+%#lx\n", i, (void *)st->pcs[i], 156 namebuf, offset); 157 } 158} 159 160#ifdef KTR 161void 162stack_ktr(u_int mask, const char *file, int line, struct stack *st, u_int depth, 163 int cheap) 164{ 165 char namebuf[64]; 166 long offset; 167 int i; 168 169 KASSERT(st->depth <= STACK_MAX, ("bogus stack")); 170 if (cheap) { 171 ktr_tracepoint(mask, file, line, "#0 %p %p %p %p %p %p", 172 st->pcs[0], st->pcs[1], st->pcs[2], st->pcs[3], 173 st->pcs[4], st->pcs[5]); 174 if (st->depth <= 6) 175 return; 176 ktr_tracepoint(mask, file, line, "#1 %p %p %p %p %p %p", 177 st->pcs[6], st->pcs[7], st->pcs[8], st->pcs[9], 178 st->pcs[10], st->pcs[11]); 179 if (st->depth <= 12) 180 return; 181 ktr_tracepoint(mask, file, line, "#2 %p %p %p %p %p %p", 182 st->pcs[12], st->pcs[13], st->pcs[14], st->pcs[15], 183 st->pcs[16], st->pcs[17]); 184 } else { 185 if (depth == 0 || st->depth < depth) 186 depth = st->depth; 187 for (i = 0; i < depth; i++) { 188 stack_symbol_ddb(st->pcs[i], namebuf, 189 sizeof(namebuf), &offset); 190 ktr_tracepoint(mask, file, line, "#%d %p at %s+%#lx", 191 i, st->pcs[i], (u_long)namebuf, offset, 0, 0); 192 } 193 } 194} 195#endif 196#endif 197 198/* 199 * Two variants of stack symbol lookup -- one that uses the DDB interfaces 200 * and bypasses linker locking, and the other that doesn't. 201 */ 202static void 203stack_symbol(vm_offset_t pc, char *namebuf, u_int buflen, long *offset) 204{ 205 206 if (linker_search_symbol_name((caddr_t)pc, namebuf, buflen, 207 offset) != 0) { 208 *offset = 0; 209 strlcpy(namebuf, "Unknown func", buflen); 210 } 211} 212 213#ifdef DDB 214static void 215stack_symbol_ddb(vm_offset_t pc, char *namebuf, u_int buflen, long *offset) 216{ 217 218 if (linker_ddb_search_symbol_name((caddr_t)pc, namebuf, buflen, 219 offset) != 0) { 220 *offset = 0; 221 strlcpy(namebuf, "Unknown func", buflen); 222 }; 223} 224#endif 225