2005-08-03 04:27:40 +00:00
|
|
|
/*-
|
2017-11-27 15:20:12 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
|
|
*
|
2005-08-03 04:27:40 +00:00
|
|
|
* Copyright (c) 2005 Antoine Brodin
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
* SUCH DAMAGE.
|
|
|
|
*/
|
|
|
|
|
2007-12-01 22:04:16 +00:00
|
|
|
#include "opt_ddb.h"
|
|
|
|
|
2005-08-03 04:27:40 +00:00
|
|
|
#include <sys/cdefs.h>
|
|
|
|
__FBSDID("$FreeBSD$");
|
|
|
|
|
|
|
|
#include <sys/param.h>
|
|
|
|
#include <sys/kernel.h>
|
|
|
|
#ifdef KTR
|
|
|
|
#include <sys/ktr.h>
|
|
|
|
#endif
|
|
|
|
#include <sys/linker.h>
|
|
|
|
#include <sys/malloc.h>
|
|
|
|
#include <sys/sbuf.h>
|
|
|
|
#include <sys/stack.h>
|
|
|
|
#include <sys/systm.h>
|
2011-02-25 10:11:01 +00:00
|
|
|
#include <sys/sysctl.h>
|
|
|
|
|
|
|
|
FEATURE(stack, "Support for capturing kernel stack");
|
2005-08-03 04:27:40 +00:00
|
|
|
|
2008-07-13 17:15:05 +00:00
|
|
|
static MALLOC_DEFINE(M_STACK, "stack", "Stack Traces");
|
2005-08-03 04:27:40 +00:00
|
|
|
|
2009-06-24 12:06:15 +00:00
|
|
|
static int stack_symbol(vm_offset_t pc, char *namebuf, u_int buflen,
|
2018-10-20 18:08:43 +00:00
|
|
|
long *offset, int flags);
|
2009-06-24 12:06:15 +00:00
|
|
|
static int stack_symbol_ddb(vm_offset_t pc, const char **name, long *offset);
|
2005-08-03 04:27:40 +00:00
|
|
|
|
|
|
|
struct stack *
|
2017-10-06 21:52:28 +00:00
|
|
|
stack_create(int flags)
|
2005-08-03 04:27:40 +00:00
|
|
|
{
|
|
|
|
struct stack *st;
|
|
|
|
|
2017-10-06 21:52:28 +00:00
|
|
|
st = malloc(sizeof(*st), M_STACK, flags | M_ZERO);
|
2005-08-03 04:27:40 +00:00
|
|
|
return (st);
|
|
|
|
}
|
|
|
|
|
|
|
|
void
|
|
|
|
stack_destroy(struct stack *st)
|
|
|
|
{
|
|
|
|
|
|
|
|
free(st, M_STACK);
|
|
|
|
}
|
|
|
|
|
|
|
|
int
|
|
|
|
stack_put(struct stack *st, vm_offset_t pc)
|
|
|
|
{
|
|
|
|
|
|
|
|
if (st->depth < STACK_MAX) {
|
|
|
|
st->pcs[st->depth++] = pc;
|
|
|
|
return (0);
|
|
|
|
} else
|
|
|
|
return (-1);
|
|
|
|
}
|
|
|
|
|
|
|
|
void
|
2011-11-16 19:06:55 +00:00
|
|
|
stack_copy(const struct stack *src, struct stack *dst)
|
2005-08-03 04:27:40 +00:00
|
|
|
{
|
|
|
|
|
|
|
|
*dst = *src;
|
|
|
|
}
|
|
|
|
|
|
|
|
void
|
|
|
|
stack_zero(struct stack *st)
|
|
|
|
{
|
|
|
|
|
|
|
|
bzero(st, sizeof *st);
|
|
|
|
}
|
|
|
|
|
|
|
|
void
|
2011-11-16 19:06:55 +00:00
|
|
|
stack_print(const struct stack *st)
|
2005-08-03 04:27:40 +00:00
|
|
|
{
|
2007-12-01 22:04:16 +00:00
|
|
|
char namebuf[64];
|
2005-08-03 04:27:40 +00:00
|
|
|
long offset;
|
|
|
|
int i;
|
|
|
|
|
2006-05-28 22:15:28 +00:00
|
|
|
KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
|
2005-08-03 04:27:40 +00:00
|
|
|
for (i = 0; i < st->depth; i++) {
|
2009-06-24 12:06:15 +00:00
|
|
|
(void)stack_symbol(st->pcs[i], namebuf, sizeof(namebuf),
|
2018-10-20 18:08:43 +00:00
|
|
|
&offset, M_WAITOK);
|
2005-08-03 04:27:40 +00:00
|
|
|
printf("#%d %p at %s+%#lx\n", i, (void *)st->pcs[i],
|
2007-12-01 22:04:16 +00:00
|
|
|
namebuf, offset);
|
2005-08-03 04:27:40 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2009-06-24 12:06:15 +00:00
|
|
|
void
|
2011-11-16 19:06:55 +00:00
|
|
|
stack_print_short(const struct stack *st)
|
2009-06-24 12:06:15 +00:00
|
|
|
{
|
|
|
|
char namebuf[64];
|
|
|
|
long offset;
|
|
|
|
int i;
|
|
|
|
|
|
|
|
KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
|
|
|
|
for (i = 0; i < st->depth; i++) {
|
|
|
|
if (i > 0)
|
|
|
|
printf(" ");
|
|
|
|
if (stack_symbol(st->pcs[i], namebuf, sizeof(namebuf),
|
2018-10-20 18:08:43 +00:00
|
|
|
&offset, M_WAITOK) == 0)
|
2009-06-24 12:06:15 +00:00
|
|
|
printf("%s+%#lx", namebuf, offset);
|
|
|
|
else
|
|
|
|
printf("%p", (void *)st->pcs[i]);
|
|
|
|
}
|
|
|
|
printf("\n");
|
|
|
|
}
|
|
|
|
|
2007-12-01 22:04:16 +00:00
|
|
|
void
|
2011-11-16 19:06:55 +00:00
|
|
|
stack_print_ddb(const struct stack *st)
|
2007-12-01 22:04:16 +00:00
|
|
|
{
|
2008-10-19 11:13:49 +00:00
|
|
|
const char *name;
|
2007-12-01 22:04:16 +00:00
|
|
|
long offset;
|
|
|
|
int i;
|
|
|
|
|
|
|
|
KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
|
|
|
|
for (i = 0; i < st->depth; i++) {
|
2008-10-19 11:13:49 +00:00
|
|
|
stack_symbol_ddb(st->pcs[i], &name, &offset);
|
2007-12-01 22:04:16 +00:00
|
|
|
printf("#%d %p at %s+%#lx\n", i, (void *)st->pcs[i],
|
2008-10-19 11:13:49 +00:00
|
|
|
name, offset);
|
2007-12-01 22:04:16 +00:00
|
|
|
}
|
|
|
|
}
|
2009-06-24 12:06:15 +00:00
|
|
|
|
2015-11-19 05:56:59 +00:00
|
|
|
#if defined(DDB) || defined(WITNESS)
|
2009-06-24 12:06:15 +00:00
|
|
|
void
|
2011-11-16 19:06:55 +00:00
|
|
|
stack_print_short_ddb(const struct stack *st)
|
2009-06-24 12:06:15 +00:00
|
|
|
{
|
|
|
|
const char *name;
|
|
|
|
long offset;
|
|
|
|
int i;
|
|
|
|
|
|
|
|
KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
|
|
|
|
for (i = 0; i < st->depth; i++) {
|
|
|
|
if (i > 0)
|
|
|
|
printf(" ");
|
|
|
|
if (stack_symbol_ddb(st->pcs[i], &name, &offset) == 0)
|
|
|
|
printf("%s+%#lx", name, offset);
|
|
|
|
else
|
|
|
|
printf("%p", (void *)st->pcs[i]);
|
|
|
|
}
|
|
|
|
printf("\n");
|
|
|
|
}
|
Break out stack(9) from ddb(4):
- Introduce per-architecture stack_machdep.c to hold stack_save(9).
- Introduce per-architecture machine/stack.h to capture any common
definitions required between db_trace.c and stack_machdep.c.
- Add new kernel option "options STACK"; we will build in stack(9) if it is
defined, or also if "options DDB" is defined to provide compatibility
with existing users of stack(9).
Add new stack_save_td(9) function, which allows the capture of a stacktrace
of another thread rather than the current thread, which the existing
stack_save(9) was limited to. It requires that the thread be neither
swapped out nor running, which is the responsibility of the consumer to
enforce.
Update stack(9) man page.
Build tested: amd64, arm, i386, ia64, powerpc, sparc64, sun4v
Runtime tested: amd64 (rwatson), arm (cognet), i386 (rwatson)
2007-12-02 20:40:35 +00:00
|
|
|
#endif
|
2007-12-01 22:04:16 +00:00
|
|
|
|
|
|
|
/*
|
2018-10-20 18:08:43 +00:00
|
|
|
* Format stack into sbuf from live kernel.
|
|
|
|
*
|
|
|
|
* flags - M_WAITOK or M_NOWAIT (EWOULDBLOCK).
|
2007-12-01 22:04:16 +00:00
|
|
|
*/
|
2018-10-20 18:08:43 +00:00
|
|
|
int
|
|
|
|
stack_sbuf_print_flags(struct sbuf *sb, const struct stack *st, int flags)
|
2005-08-03 04:27:40 +00:00
|
|
|
{
|
2007-12-01 22:04:16 +00:00
|
|
|
char namebuf[64];
|
|
|
|
long offset;
|
2018-10-20 18:08:43 +00:00
|
|
|
int i, error;
|
2007-12-01 22:04:16 +00:00
|
|
|
|
|
|
|
KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
|
|
|
|
for (i = 0; i < st->depth; i++) {
|
2018-10-20 18:08:43 +00:00
|
|
|
error = stack_symbol(st->pcs[i], namebuf, sizeof(namebuf),
|
|
|
|
&offset, flags);
|
|
|
|
if (error == EWOULDBLOCK)
|
|
|
|
return (error);
|
2007-12-01 22:04:16 +00:00
|
|
|
sbuf_printf(sb, "#%d %p at %s+%#lx\n", i, (void *)st->pcs[i],
|
|
|
|
namebuf, offset);
|
|
|
|
}
|
2018-10-20 18:08:43 +00:00
|
|
|
return (0);
|
|
|
|
}
|
|
|
|
|
|
|
|
void
|
|
|
|
stack_sbuf_print(struct sbuf *sb, const struct stack *st)
|
|
|
|
{
|
|
|
|
|
|
|
|
(void)stack_sbuf_print_flags(sb, st, M_WAITOK);
|
2007-12-01 22:04:16 +00:00
|
|
|
}
|
|
|
|
|
2015-11-19 05:56:59 +00:00
|
|
|
#if defined(DDB) || defined(WITNESS)
|
2007-12-01 22:04:16 +00:00
|
|
|
void
|
2011-11-16 19:06:55 +00:00
|
|
|
stack_sbuf_print_ddb(struct sbuf *sb, const struct stack *st)
|
2007-12-01 22:04:16 +00:00
|
|
|
{
|
2008-10-19 11:13:49 +00:00
|
|
|
const char *name;
|
2005-08-03 04:27:40 +00:00
|
|
|
long offset;
|
|
|
|
int i;
|
|
|
|
|
2006-05-28 22:15:28 +00:00
|
|
|
KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
|
2005-08-03 04:27:40 +00:00
|
|
|
for (i = 0; i < st->depth; i++) {
|
2009-06-24 12:06:15 +00:00
|
|
|
(void)stack_symbol_ddb(st->pcs[i], &name, &offset);
|
2005-08-03 04:27:40 +00:00
|
|
|
sbuf_printf(sb, "#%d %p at %s+%#lx\n", i, (void *)st->pcs[i],
|
2008-10-19 11:13:49 +00:00
|
|
|
name, offset);
|
2005-08-03 04:27:40 +00:00
|
|
|
}
|
|
|
|
}
|
2008-10-30 21:48:28 +00:00
|
|
|
#endif
|
2005-08-03 04:27:40 +00:00
|
|
|
|
|
|
|
#ifdef KTR
|
|
|
|
void
|
2011-11-16 19:06:55 +00:00
|
|
|
stack_ktr(u_int mask, const char *file, int line, const struct stack *st,
|
2019-03-15 22:39:55 +00:00
|
|
|
u_int depth)
|
2005-08-03 04:27:40 +00:00
|
|
|
{
|
2008-10-30 21:48:28 +00:00
|
|
|
#ifdef DDB
|
2008-10-19 11:13:49 +00:00
|
|
|
const char *name;
|
2005-08-03 04:27:40 +00:00
|
|
|
long offset;
|
|
|
|
int i;
|
2008-10-30 21:48:28 +00:00
|
|
|
#endif
|
2005-08-03 04:27:40 +00:00
|
|
|
|
2006-05-28 22:15:28 +00:00
|
|
|
KASSERT(st->depth <= STACK_MAX, ("bogus stack"));
|
2008-10-30 21:48:28 +00:00
|
|
|
#ifdef DDB
|
2019-03-15 22:39:55 +00:00
|
|
|
if (depth == 0 || st->depth < depth)
|
|
|
|
depth = st->depth;
|
|
|
|
for (i = 0; i < depth; i++) {
|
|
|
|
(void)stack_symbol_ddb(st->pcs[i], &name, &offset);
|
|
|
|
ktr_tracepoint(mask, file, line, "#%d %p at %s+%#lx",
|
|
|
|
i, st->pcs[i], (u_long)name, offset, 0, 0);
|
2005-08-29 11:34:08 +00:00
|
|
|
}
|
2019-03-15 22:39:55 +00:00
|
|
|
#endif
|
2005-08-03 04:27:40 +00:00
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2007-12-01 22:04:16 +00:00
|
|
|
/*
|
|
|
|
* Two variants of stack symbol lookup -- one that uses the DDB interfaces
|
|
|
|
* and bypasses linker locking, and the other that doesn't.
|
|
|
|
*/
|
2009-06-24 12:06:15 +00:00
|
|
|
static int
|
2018-10-20 18:08:43 +00:00
|
|
|
stack_symbol(vm_offset_t pc, char *namebuf, u_int buflen, long *offset,
|
|
|
|
int flags)
|
2005-08-03 04:27:40 +00:00
|
|
|
{
|
2018-10-20 18:08:43 +00:00
|
|
|
int error;
|
2007-12-01 22:04:16 +00:00
|
|
|
|
2018-10-20 18:08:43 +00:00
|
|
|
error = linker_search_symbol_name_flags((caddr_t)pc, namebuf, buflen,
|
|
|
|
offset, flags);
|
|
|
|
if (error == 0 || error == EWOULDBLOCK)
|
|
|
|
return (error);
|
|
|
|
|
|
|
|
*offset = 0;
|
|
|
|
strlcpy(namebuf, "??", buflen);
|
|
|
|
return (ENOENT);
|
2005-08-03 04:27:40 +00:00
|
|
|
}
|
2007-12-01 22:04:16 +00:00
|
|
|
|
2009-06-24 12:06:15 +00:00
|
|
|
static int
|
2008-10-19 11:13:49 +00:00
|
|
|
stack_symbol_ddb(vm_offset_t pc, const char **name, long *offset)
|
2007-12-01 22:04:16 +00:00
|
|
|
{
|
2008-10-19 11:13:49 +00:00
|
|
|
linker_symval_t symval;
|
|
|
|
c_linker_sym_t sym;
|
|
|
|
|
|
|
|
if (linker_ddb_search_symbol((caddr_t)pc, &sym, offset) != 0)
|
|
|
|
goto out;
|
|
|
|
if (linker_ddb_symbol_values(sym, &symval) != 0)
|
|
|
|
goto out;
|
|
|
|
if (symval.name != NULL) {
|
|
|
|
*name = symval.name;
|
2009-06-24 12:06:15 +00:00
|
|
|
return (0);
|
2008-10-19 11:13:49 +00:00
|
|
|
}
|
|
|
|
out:
|
|
|
|
*offset = 0;
|
|
|
|
*name = "??";
|
2009-06-24 12:06:15 +00:00
|
|
|
return (ENOENT);
|
2007-12-01 22:04:16 +00:00
|
|
|
}
|