594 lines
11 KiB
C
594 lines
11 KiB
C
/*
|
|
* Copyright (C) 2006-2008 Martin Willi
|
|
* Hochschule fuer Technik Rapperswil
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the
|
|
* Free Software Foundation; either version 2 of the License, or (at your
|
|
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
|
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* for more details.
|
|
*/
|
|
|
|
#define _GNU_SOURCE
|
|
|
|
#ifdef HAVE_DLADDR
|
|
# include <dlfcn.h>
|
|
#endif /* HAVE_DLADDR */
|
|
|
|
#ifdef HAVE_BACKTRACE
|
|
# include <execinfo.h>
|
|
#endif /* HAVE_BACKTRACE */
|
|
|
|
#include <string.h>
|
|
|
|
#include "backtrace.h"
|
|
|
|
#include <utils/debug.h>
|
|
|
|
typedef struct private_backtrace_t private_backtrace_t;
|
|
|
|
/**
|
|
* Private data of an backtrace_t object.
|
|
*/
|
|
struct private_backtrace_t {
|
|
|
|
/**
|
|
* Public backtrace_t interface.
|
|
*/
|
|
backtrace_t public;
|
|
|
|
/**
|
|
* Number of stacks frames obtained in stack_frames
|
|
*/
|
|
int frame_count;
|
|
|
|
/**
|
|
* Recorded stack frames.
|
|
*/
|
|
void *frames[];
|
|
};
|
|
|
|
/**
|
|
* Write a format string with arguments to a FILE line, if it is NULL to DBG
|
|
*/
|
|
static void println(FILE *file, char *format, ...)
|
|
{
|
|
char buf[512];
|
|
va_list args;
|
|
|
|
va_start(args, format);
|
|
if (file)
|
|
{
|
|
vfprintf(file, format, args);
|
|
fputs("\n", file);
|
|
}
|
|
else
|
|
{
|
|
vsnprintf(buf, sizeof(buf), format, args);
|
|
DBG1(DBG_LIB, "%s", buf);
|
|
}
|
|
va_end(args);
|
|
}
|
|
|
|
#ifdef HAVE_DLADDR
|
|
|
|
/**
|
|
* Same as tty_escape_get(), but for a potentially NULL FILE*
|
|
*/
|
|
static char* esc(FILE *file, tty_escape_t escape)
|
|
{
|
|
if (file)
|
|
{
|
|
return tty_escape_get(fileno(file), escape);
|
|
}
|
|
return "";
|
|
}
|
|
|
|
#ifdef HAVE_BFD_H
|
|
|
|
#include <bfd.h>
|
|
#include <collections/hashtable.h>
|
|
#include <threading/mutex.h>
|
|
|
|
/**
|
|
* Hashtable-cached bfd handle
|
|
*/
|
|
typedef struct {
|
|
/** binary file name on disk */
|
|
char *filename;
|
|
/** bfd handle */
|
|
bfd *abfd;
|
|
/** loaded symbols */
|
|
asymbol **syms;
|
|
} bfd_entry_t;
|
|
|
|
/**
|
|
* Destroy a bfd_entry
|
|
*/
|
|
static void bfd_entry_destroy(bfd_entry_t *this)
|
|
{
|
|
free(this->filename);
|
|
free(this->syms);
|
|
bfd_close(this->abfd);
|
|
free(this);
|
|
}
|
|
|
|
/**
|
|
* Data to pass to find_addr()
|
|
*/
|
|
typedef struct {
|
|
/** used bfd entry */
|
|
bfd_entry_t *entry;
|
|
/** backtrace address */
|
|
bfd_vma vma;
|
|
/** stream to log to */
|
|
FILE *file;
|
|
/** TRUE if complete */
|
|
bool found;
|
|
} bfd_find_data_t;
|
|
|
|
/**
|
|
* bfd entry cache
|
|
*/
|
|
static hashtable_t *bfds;
|
|
|
|
static mutex_t *bfd_mutex;
|
|
|
|
/**
|
|
* Hashtable hash function
|
|
*/
|
|
static u_int bfd_hash(char *key)
|
|
{
|
|
return chunk_hash(chunk_create(key, strlen(key)));
|
|
}
|
|
|
|
/**
|
|
* Hashtable equals function
|
|
*/
|
|
static bool bfd_equals(char *a, char *b)
|
|
{
|
|
return streq(a, b);
|
|
}
|
|
|
|
/**
|
|
* See header.
|
|
*/
|
|
void backtrace_init()
|
|
{
|
|
bfd_init();
|
|
bfds = hashtable_create((hashtable_hash_t)bfd_hash,
|
|
(hashtable_equals_t)bfd_equals, 8);
|
|
bfd_mutex = mutex_create(MUTEX_TYPE_DEFAULT);
|
|
}
|
|
|
|
/**
|
|
* See header.
|
|
*/
|
|
void backtrace_deinit()
|
|
{
|
|
enumerator_t *enumerator;
|
|
bfd_entry_t *entry;
|
|
char *key;
|
|
|
|
enumerator = bfds->create_enumerator(bfds);
|
|
while (enumerator->enumerate(enumerator, &key, &entry))
|
|
{
|
|
bfds->remove_at(bfds, enumerator);
|
|
bfd_entry_destroy(entry);
|
|
}
|
|
enumerator->destroy(enumerator);
|
|
|
|
bfds->destroy(bfds);
|
|
bfd_mutex->destroy(bfd_mutex);
|
|
}
|
|
|
|
/**
|
|
* Find and print information to an address
|
|
*/
|
|
static void find_addr(bfd *abfd, asection *section, bfd_find_data_t *data)
|
|
{
|
|
bfd_size_type size;
|
|
bfd_vma vma;
|
|
const char *source;
|
|
const char *function;
|
|
char fbuf[512] = "", sbuf[512] = "";
|
|
u_int line;
|
|
|
|
if (!data->found || (bfd_get_section_flags(abfd, section) & SEC_ALLOC) != 0)
|
|
{
|
|
vma = bfd_get_section_vma(abfd, section);
|
|
if (data->vma >= vma)
|
|
{
|
|
size = bfd_get_section_size(section);
|
|
if (data->vma < vma + size)
|
|
{
|
|
data->found = bfd_find_nearest_line(abfd, section,
|
|
data->entry->syms, data->vma - vma,
|
|
&source, &function, &line);
|
|
if (data->found)
|
|
{
|
|
if (source || function)
|
|
{
|
|
if (function)
|
|
{
|
|
snprintf(fbuf, sizeof(fbuf), "%s%s() ",
|
|
esc(data->file, TTY_FG_BLUE), function);
|
|
}
|
|
if (source)
|
|
{
|
|
snprintf(sbuf, sizeof(sbuf), "%s@ %s:%d",
|
|
esc(data->file, TTY_FG_GREEN), source, line);
|
|
}
|
|
println(data->file, " -> %s%s%s", fbuf, sbuf,
|
|
esc(data->file, TTY_FG_DEF));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Find a cached bfd entry, create'n'cache if not found
|
|
*/
|
|
static bfd_entry_t *get_bfd_entry(char *filename)
|
|
{
|
|
bool dynamic = FALSE, ok = FALSE;
|
|
bfd_entry_t *entry;
|
|
long size;
|
|
|
|
/* check cache */
|
|
entry = bfds->get(bfds, filename);
|
|
if (entry)
|
|
{
|
|
return entry;
|
|
}
|
|
|
|
INIT(entry,
|
|
.abfd = bfd_openr(filename, NULL),
|
|
);
|
|
|
|
if (!entry->abfd)
|
|
{
|
|
free(entry);
|
|
return NULL;
|
|
}
|
|
#ifdef BFD_DECOMPRESS
|
|
entry->abfd->flags |= BFD_DECOMPRESS;
|
|
#endif
|
|
if (bfd_check_format(entry->abfd, bfd_archive) == 0 &&
|
|
bfd_check_format_matches(entry->abfd, bfd_object, NULL))
|
|
{
|
|
if (bfd_get_file_flags(entry->abfd) & HAS_SYMS)
|
|
{
|
|
size = bfd_get_symtab_upper_bound(entry->abfd);
|
|
if (size == 0)
|
|
{
|
|
size = bfd_get_dynamic_symtab_upper_bound(entry->abfd);
|
|
}
|
|
if (size >= 0)
|
|
{
|
|
entry->syms = malloc(size);
|
|
if (dynamic)
|
|
{
|
|
ok = bfd_canonicalize_dynamic_symtab(entry->abfd,
|
|
entry->syms) >= 0;
|
|
}
|
|
else
|
|
{
|
|
ok = bfd_canonicalize_symtab(entry->abfd,
|
|
entry->syms) >= 0;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if (ok)
|
|
{
|
|
entry->filename = strdup(filename);
|
|
bfds->put(bfds, entry->filename, entry);
|
|
return entry;
|
|
}
|
|
bfd_entry_destroy(entry);
|
|
return NULL;
|
|
}
|
|
|
|
/**
|
|
* Print the source file with line number to file, libbfd variant
|
|
*/
|
|
static void print_sourceline(FILE *file, char *filename, void *ptr)
|
|
{
|
|
bfd_entry_t *entry;
|
|
bfd_find_data_t data = {
|
|
.file = file,
|
|
.vma = (uintptr_t)ptr,
|
|
};
|
|
bool old = FALSE;
|
|
|
|
bfd_mutex->lock(bfd_mutex);
|
|
if (lib->leak_detective)
|
|
{
|
|
old = lib->leak_detective->set_state(lib->leak_detective, FALSE);
|
|
}
|
|
entry = get_bfd_entry(filename);
|
|
if (entry)
|
|
{
|
|
data.entry = entry;
|
|
bfd_map_over_sections(entry->abfd, (void*)find_addr, &data);
|
|
}
|
|
if (lib->leak_detective)
|
|
{
|
|
lib->leak_detective->set_state(lib->leak_detective, old);
|
|
}
|
|
bfd_mutex->unlock(bfd_mutex);
|
|
}
|
|
|
|
#else /* !HAVE_BFD_H */
|
|
|
|
void backtrace_init() {}
|
|
void backtrace_deinit() {}
|
|
|
|
/**
|
|
* Print the source file with line number to file, slow addr2line variant
|
|
*/
|
|
static void print_sourceline(FILE *file, char *filename, void *ptr)
|
|
{
|
|
char buf[1024];
|
|
FILE *output;
|
|
int c, i = 0;
|
|
|
|
snprintf(buf, sizeof(buf), "addr2line -e %s %p", filename, ptr);
|
|
output = popen(buf, "r");
|
|
if (output)
|
|
{
|
|
while (i < sizeof(buf))
|
|
{
|
|
c = getc(output);
|
|
if (c == '\n' || c == EOF)
|
|
{
|
|
buf[i++] = 0;
|
|
break;
|
|
}
|
|
buf[i++] = c;
|
|
}
|
|
pclose(output);
|
|
|
|
println(file, " -> %s%s%s", esc(file, TTY_FG_GREEN), buf,
|
|
esc(file, TTY_FG_DEF));
|
|
}
|
|
}
|
|
|
|
#endif /* HAVE_BFD_H */
|
|
|
|
#else /* !HAVE_DLADDR */
|
|
|
|
void backtrace_init() {}
|
|
void backtrace_deinit() {}
|
|
|
|
#endif /* HAVE_DLADDR */
|
|
|
|
METHOD(backtrace_t, log_, void,
|
|
private_backtrace_t *this, FILE *file, bool detailed)
|
|
{
|
|
#if defined(HAVE_BACKTRACE) || defined(HAVE_LIBUNWIND_H)
|
|
size_t i;
|
|
char **strings;
|
|
|
|
strings = backtrace_symbols(this->frames, this->frame_count);
|
|
|
|
println(file, " dumping %d stack frame addresses:", this->frame_count);
|
|
for (i = 0; i < this->frame_count; i++)
|
|
{
|
|
#ifdef HAVE_DLADDR
|
|
Dl_info info;
|
|
|
|
if (dladdr(this->frames[i], &info))
|
|
{
|
|
void *ptr = this->frames[i];
|
|
|
|
if (strstr(info.dli_fname, ".so"))
|
|
{
|
|
ptr = (void*)(this->frames[i] - info.dli_fbase);
|
|
}
|
|
if (info.dli_sname)
|
|
{
|
|
println(file, " %s%s%s @ %p (%s%s%s+0x%tx) [%p]",
|
|
esc(file, TTY_FG_YELLOW), info.dli_fname,
|
|
esc(file, TTY_FG_DEF), info.dli_fbase,
|
|
esc(file, TTY_FG_RED), info.dli_sname,
|
|
esc(file, TTY_FG_DEF), this->frames[i] - info.dli_saddr,
|
|
this->frames[i]);
|
|
}
|
|
else
|
|
{
|
|
println(file, " %s%s%s @ %p [%p]",
|
|
esc(file, TTY_FG_YELLOW), info.dli_fname,
|
|
esc(file, TTY_FG_DEF), info.dli_fbase, this->frames[i]);
|
|
}
|
|
if (detailed && info.dli_fname[0])
|
|
{
|
|
print_sourceline(file, (char*)info.dli_fname, ptr);
|
|
}
|
|
}
|
|
else
|
|
#endif /* HAVE_DLADDR */
|
|
{
|
|
println(file, " %s", strings[i]);
|
|
}
|
|
}
|
|
free (strings);
|
|
#else /* !HAVE_BACKTRACE && !HAVE_LIBUNWIND_H */
|
|
println(file, "no support for backtrace()/libunwind");
|
|
#endif /* HAVE_BACKTRACE/HAVE_LIBUNWIND_H */
|
|
}
|
|
|
|
METHOD(backtrace_t, contains_function, bool,
|
|
private_backtrace_t *this, char *function[], int count)
|
|
{
|
|
#ifdef HAVE_DLADDR
|
|
int i, j;
|
|
|
|
for (i = 0; i< this->frame_count; i++)
|
|
{
|
|
Dl_info info;
|
|
|
|
if (dladdr(this->frames[i], &info) && info.dli_sname)
|
|
{
|
|
for (j = 0; j < count; j++)
|
|
{
|
|
if (streq(info.dli_sname, function[j]))
|
|
{
|
|
return TRUE;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
#endif /* HAVE_DLADDR */
|
|
return FALSE;
|
|
}
|
|
|
|
METHOD(backtrace_t, equals, bool,
|
|
private_backtrace_t *this, backtrace_t *other_public)
|
|
{
|
|
private_backtrace_t *other = (private_backtrace_t*)other_public;
|
|
int i;
|
|
|
|
if (this == other)
|
|
{
|
|
return TRUE;
|
|
}
|
|
if (this->frame_count != other->frame_count)
|
|
{
|
|
return FALSE;
|
|
}
|
|
for (i = 0; i < this->frame_count; i++)
|
|
{
|
|
if (this->frames[i] != other->frames[i])
|
|
{
|
|
return FALSE;
|
|
}
|
|
}
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
* Frame enumerator
|
|
*/
|
|
typedef struct {
|
|
/** implements enumerator_t */
|
|
enumerator_t public;
|
|
/** reference to backtrace */
|
|
private_backtrace_t *bt;
|
|
/** current position */
|
|
int i;
|
|
} frame_enumerator_t;
|
|
|
|
METHOD(enumerator_t, frame_enumerate, bool,
|
|
frame_enumerator_t *this, void **addr)
|
|
{
|
|
if (this->i < this->bt->frame_count)
|
|
{
|
|
*addr = this->bt->frames[this->i++];
|
|
return TRUE;
|
|
}
|
|
return FALSE;
|
|
}
|
|
|
|
METHOD(backtrace_t, create_frame_enumerator, enumerator_t*,
|
|
private_backtrace_t *this)
|
|
{
|
|
frame_enumerator_t *enumerator;
|
|
|
|
INIT(enumerator,
|
|
.public = {
|
|
.enumerate = (void*)_frame_enumerate,
|
|
.destroy = (void*)free,
|
|
},
|
|
.bt = this,
|
|
);
|
|
return &enumerator->public;
|
|
}
|
|
|
|
METHOD(backtrace_t, destroy, void,
|
|
private_backtrace_t *this)
|
|
{
|
|
free(this);
|
|
}
|
|
|
|
#ifdef HAVE_LIBUNWIND_H
|
|
#define UNW_LOCAL_ONLY
|
|
#include <libunwind.h>
|
|
|
|
/**
|
|
* libunwind variant for glibc backtrace()
|
|
*/
|
|
static inline int backtrace_unwind(void **frames, int count)
|
|
{
|
|
unw_context_t context;
|
|
unw_cursor_t cursor;
|
|
unw_word_t ip;
|
|
int depth = 0;
|
|
|
|
unw_getcontext(&context);
|
|
unw_init_local(&cursor, &context);
|
|
do
|
|
{
|
|
unw_get_reg(&cursor, UNW_REG_IP, &ip);
|
|
frames[depth++] = (void*)ip;
|
|
}
|
|
while (depth < count && unw_step(&cursor) > 0);
|
|
|
|
return depth;
|
|
}
|
|
#endif /* HAVE_UNWIND */
|
|
|
|
/**
|
|
* See header
|
|
*/
|
|
backtrace_t *backtrace_create(int skip)
|
|
{
|
|
private_backtrace_t *this;
|
|
void *frames[50];
|
|
int frame_count = 0;
|
|
|
|
#ifdef HAVE_LIBUNWIND_H
|
|
frame_count = backtrace_unwind(frames, countof(frames));
|
|
#elif defined(HAVE_BACKTRACE)
|
|
frame_count = backtrace(frames, countof(frames));
|
|
#endif /* HAVE_BACKTRACE */
|
|
frame_count = max(frame_count - skip, 0);
|
|
this = malloc(sizeof(private_backtrace_t) + frame_count * sizeof(void*));
|
|
memcpy(this->frames, frames + skip, frame_count * sizeof(void*));
|
|
this->frame_count = frame_count;
|
|
|
|
this->public = (backtrace_t) {
|
|
.log = _log_,
|
|
.contains_function = _contains_function,
|
|
.equals = _equals,
|
|
.create_frame_enumerator = _create_frame_enumerator,
|
|
.destroy = _destroy,
|
|
};
|
|
|
|
return &this->public;
|
|
}
|
|
|
|
/**
|
|
* See header
|
|
*/
|
|
void backtrace_dump(char *label, FILE *file, bool detailed)
|
|
{
|
|
backtrace_t *backtrace;
|
|
|
|
backtrace = backtrace_create(2);
|
|
|
|
if (label)
|
|
{
|
|
println(file, "Debug backtrace: %s", label);
|
|
}
|
|
backtrace->log(backtrace, file, detailed);
|
|
backtrace->destroy(backtrace);
|
|
}
|