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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*
* Copyright (C) 2017 Apple Inc. All rights reserved.
* Copyright (C) 2017 Yusuke Suzuki <utatane.tea@gmail.com>
*
* 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 APPLE INC. ``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 APPLE INC. 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.
*/
#pragma once
#include <optional>
#include <span>
#include <wtf/Forward.h>
#include <wtf/SystemFree.h>
#if HAVE(BACKTRACE_SYMBOLS) || HAVE(BACKTRACE)
#include <execinfo.h>
#endif
#if USE(LIBBACKTRACE)
#include <backtrace.h>
#endif
#if HAVE(DLADDR)
#include <cxxabi.h>
#include <dlfcn.h>
#endif
#if OS(WINDOWS)
#include <windows.h>
#include <wtf/win/DbgHelperWin.h>
#endif
WTF_ALLOW_UNSAFE_BUFFER_USAGE_BEGIN
namespace WTF {
class PrintStream;
#if USE(LIBBACKTRACE)
WTF_EXPORT_PRIVATE char** symbolize(void* const*, int);
#endif
class StackTrace {
WTF_MAKE_FAST_ALLOCATED;
public:
WTF_EXPORT_PRIVATE NEVER_INLINE static std::unique_ptr<StackTrace> captureStackTrace(size_t maxFrames, size_t framesToSkip = 0);
std::span<void* const> stack() const
{
return std::span<void* const> { m_stack + m_initialFrame, m_size };
}
void dump(PrintStream&) const;
void forEachFrame(NOESCAPE const std::invocable<int, void*, const char*> auto&) const;
WTF_EXPORT_PRIVATE String toString() const;
private:
StackTrace(size_t size, size_t initialFrame)
: m_size(size)
, m_initialFrame(initialFrame)
{
}
size_t m_size;
size_t m_initialFrame;
void* m_stack[1];
};
class StackTraceSymbolResolver {
public:
StackTraceSymbolResolver(std::span<void* const> stack)
: m_stack(stack)
{
}
StackTraceSymbolResolver(const StackTrace& stack)
: m_stack(stack.stack())
{
}
class DemangleEntry {
WTF_MAKE_FAST_ALLOCATED;
public:
friend class StackTraceSymbolResolver;
const char* mangledName() const { return m_mangledName; }
const char* demangledName() const { return m_demangledName.get(); }
private:
DemangleEntry(const char* mangledName, const char* demangledName)
: m_mangledName(mangledName)
, m_demangledName(demangledName)
{ }
const char* m_mangledName { nullptr };
std::unique_ptr<const char[], SystemFree<const char[]>> m_demangledName;
};
WTF_EXPORT_PRIVATE static std::optional<DemangleEntry> demangle(void*);
void forEach(NOESCAPE const std::invocable<int, void*, const char*> auto& functor) const
{
#if USE(LIBBACKTRACE)
char** symbols = symbolize(m_stack.data(), m_stack.size());
if (!symbols)
return;
#elif HAVE(BACKTRACE_SYMBOLS)
char** symbols = backtrace_symbols(m_stack.data(), m_stack.size());
if (!symbols)
return;
#elif OS(WINDOWS)
HANDLE hProc = GetCurrentProcess();
uint8_t symbolData[sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR)] = { 0 };
auto symbolInfo = reinterpret_cast<SYMBOL_INFO*>(symbolData);
symbolInfo->SizeOfStruct = sizeof(SYMBOL_INFO);
symbolInfo->MaxNameLen = MAX_SYM_NAME;
#endif
for (size_t i = 0; i < m_stack.size(); ++i) {
const char* name = nullptr;
auto demangled = demangle(m_stack[i]);
if (demangled)
name = demangled->demangledName() ? demangled->demangledName() : demangled->mangledName();
#if HAVE(BACKTRACE_SYMBOLS)
if (!name || !strcmp(name, "<redacted>"))
name = symbols[i];
#elif OS(WINDOWS)
if (!name && DbgHelper::SymFromAddress(hProc, reinterpret_cast<DWORD64>(m_stack[i]), nullptr, symbolInfo))
name = symbolInfo->Name;
#endif
functor(i + 1, m_stack[i], name);
}
#if USE(LIBBACKTRACE)
for (size_t i = 0; i < m_stack.size(); ++i)
free(symbols[i]);
free(symbols);
#elif HAVE(BACKTRACE_SYMBOLS)
free(symbols);
#endif
}
private:
std::span<void* const> m_stack;
};
class StackTracePrinter {
public:
StackTracePrinter(std::span<void* const> stack, const char* prefix = "")
: m_stack(stack)
, m_prefix(prefix)
{
}
StackTracePrinter(const StackTrace& stack, const char* prefix = "")
: m_stack(stack.stack())
, m_prefix(prefix)
{
}
WTF_EXPORT_PRIVATE void dump(PrintStream&) const;
private:
const std::span<void* const> m_stack;
const char* const m_prefix;
};
inline void StackTrace::dump(PrintStream& out) const
{
StackTracePrinter { *this }.dump(out);
}
void StackTrace::forEachFrame(NOESCAPE const std::invocable<int, void*, const char*> auto& functor) const
{
StackTraceSymbolResolver { *this }.forEach(functor);
}
} // namespace WTF
using WTF::StackTrace;
using WTF::StackTraceSymbolResolver;
using WTF::StackTracePrinter;
WTF_ALLOW_UNSAFE_BUFFER_USAGE_END
|
