1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/* Copyright (C) 2012 Wildfire Games.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
// Note: This used to use BFD to get more useful debugging information.
// (See SVN r8270 if you want that code.)
// That requires binutils at runtime, which hits some bugs and library versioning
// issues on some Linux distros.
// The debugging info reported by this code with BFD wasn't especially useful,
// and it's easy enough to get people to run in gdb if we want a proper backtrace.
// So we now go with the simple approach of not using BFD.
#include "precompiled.h"
#include "lib/sysdep/sysdep.h"
#include "lib/debug.h"
#include <execinfo.h>
void* debug_GetCaller(void* UNUSED(context), const wchar_t* UNUSED(lastFuncToSkip))
{
// bt[0] == this function
// bt[1] == our caller
// bt[2] == the first caller they are interested in
// HACK: we currently don't support lastFuncToSkip (would require debug information),
// instead just returning the caller of the function calling us
void *bt[3];
int bt_size = backtrace(bt, 3);
if (bt_size < 3)
return NULL;
return bt[2];
}
Status debug_DumpStack(wchar_t* buf, size_t max_chars, void* UNUSED(context), const wchar_t* UNUSED(lastFuncToSkip))
{
static const size_t N_FRAMES = 16;
void *bt[N_FRAMES];
int bt_size = 0;
wchar_t *bufpos = buf;
wchar_t *bufend = buf + max_chars;
bt_size = backtrace(bt, ARRAY_SIZE(bt));
// Assumed max length of a single print-out
static const size_t MAX_OUT_CHARS = 1024;
for (size_t i = 0; (int)i < bt_size && bufpos+MAX_OUT_CHARS < bufend; i++)
{
wchar_t file[DEBUG_FILE_CHARS];
wchar_t symbol[DEBUG_SYMBOL_CHARS];
int line;
int len;
if (debug_ResolveSymbol(bt[i], symbol, file, &line) == 0)
{
if (file[0])
len = swprintf(bufpos, MAX_OUT_CHARS, L"(%p) %ls:%d %ls\n", bt[i], file, line, symbol);
else
len = swprintf(bufpos, MAX_OUT_CHARS, L"(%p) %ls\n", bt[i], symbol);
}
else
{
len = swprintf(bufpos, MAX_OUT_CHARS, L"(%p)\n", bt[i]);
}
if (len < 0)
{
// MAX_OUT_CHARS exceeded, realistically this was caused by some
// mindbogglingly long symbol name... replace the end with an
// ellipsis and a newline
memcpy(&bufpos[MAX_OUT_CHARS-6], L"...\n", 5*sizeof(wchar_t));
len = MAX_OUT_CHARS;
}
bufpos += len;
}
return INFO::OK;
}
Status debug_ResolveSymbol(void* ptr_of_interest, wchar_t* sym_name, wchar_t* file, int* line)
{
if (sym_name)
*sym_name = 0;
if (file)
*file = 0;
if (line)
*line = 0;
char** symbols = backtrace_symbols(&ptr_of_interest, 1);
if (symbols)
{
swprintf_s(sym_name, DEBUG_SYMBOL_CHARS, L"%hs", symbols[0]);
free(symbols);
// (Note that this will usually return a pretty useless string,
// because we compile with -fvisibility=hidden and there won't be
// any exposed symbols for backtrace_symbols to report.)
return INFO::OK;
}
else
{
return ERR::FAIL;
}
}
void debug_SetThreadName(char const* UNUSED(name))
{
// Currently unimplemented
}
|
