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
|
/*
* 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.
*/
#include "config.h"
#include <wtf/StackTrace.h>
#include <type_traits>
#include <wtf/Assertions.h>
#include <wtf/PrintStream.h>
#include <wtf/StringPrintStream.h>
#if USE(LIBBACKTRACE)
#include <string.h>
#include <wtf/NeverDestroyed.h>
#endif
void WTFGetBacktrace(void** stack, int* size)
{
#if HAVE(BACKTRACE)
*size = backtrace(stack, *size);
#elif OS(WINDOWS)
*size = RtlCaptureStackBackTrace(0, *size, stack, nullptr);
#else
UNUSED_PARAM(stack);
*size = 0;
#endif
}
namespace WTF {
#if USE(LIBBACKTRACE)
static struct backtrace_state* backtraceState()
{
static NeverDestroyed<struct backtrace_state*> backtraceState = backtrace_create_state(nullptr, 1, nullptr, nullptr);
return backtraceState;
}
static void backtraceSyminfoCallback(void* data, uintptr_t, const char* symname, uintptr_t, uintptr_t)
{
const char** symbol = static_cast<const char**>(data);
*symbol = symname;
}
static int backtraceFullCallback(void* data, uintptr_t, const char*, int, const char* function)
{
const char** symbol = static_cast<const char**>(data);
*symbol = function;
return 0;
}
WTF_ALLOW_UNSAFE_BUFFER_USAGE_BEGIN
char** symbolize(void* const* addresses, int size)
{
struct backtrace_state* state = backtraceState();
if (!state)
return nullptr;
char** symbols = static_cast<char**>(malloc(sizeof(char*) * size));
for (int i = 0; i < size; ++i) {
uintptr_t pc = reinterpret_cast<uintptr_t>(addresses[i]);
char* symbol;
backtrace_pcinfo(state, pc, backtraceFullCallback, nullptr, &symbol);
if (!symbol)
backtrace_syminfo(backtraceState(), pc, backtraceSyminfoCallback, nullptr, &symbol);
if (symbol) {
char* demangled = abi::__cxa_demangle(symbol, nullptr, nullptr, nullptr);
if (demangled)
symbols[i] = demangled;
else
symbols[i] = strdup(symbol);
} else
symbols[i] = strdup("???");
}
return symbols;
}
WTF_ALLOW_UNSAFE_BUFFER_USAGE_END
#endif
std::unique_ptr<StackTrace> StackTrace::captureStackTrace(size_t maxFrames, size_t framesToSkip)
{
static_assert(sizeof(StackTrace) == sizeof(void*) * 3);
// We overwrite the memory of the two first skipped frames, m_stack[0] will hold the third one.
static_assert(offsetof(StackTrace, m_stack) == sizeof(void*) * 2);
maxFrames = std::max<size_t>(1, maxFrames);
// Skip 2 additional frames i.e. StackTrace::captureStackTrace and WTFGetBacktrace.
framesToSkip += 2;
size_t capacity = maxFrames + framesToSkip;
void** storage = static_cast<void**>(fastMalloc(capacity * sizeof(void*)));
size_t size = 0;
size_t initialFrame = 0;
int capturedFrames = static_cast<int>(capacity);
WTFGetBacktrace(storage, &capturedFrames);
if (static_cast<size_t>(capturedFrames) > framesToSkip) {
size = static_cast<size_t>(capturedFrames) - framesToSkip;
initialFrame = framesToSkip - 2;
}
return std::unique_ptr<StackTrace> { new (NotNull, storage) StackTrace(size, initialFrame) };
}
String StackTrace::toString() const
{
StringPrintStream stream;
dump(stream);
return stream.toString();
}
auto StackTraceSymbolResolver::demangle(void* pc) -> std::optional<DemangleEntry>
{
#if HAVE(DLADDR)
const char* mangledName = nullptr;
const char* cxaDemangled = nullptr;
Dl_info info;
if (dladdr(pc, &info) && info.dli_sname)
mangledName = info.dli_sname;
if (mangledName) {
int status = 0;
cxaDemangled = abi::__cxa_demangle(mangledName, nullptr, nullptr, &status);
UNUSED_PARAM(status);
}
if (mangledName || cxaDemangled)
return DemangleEntry { mangledName, cxaDemangled };
#else
UNUSED_PARAM(pc);
#endif
return std::nullopt;
}
void StackTracePrinter::dump(PrintStream& out) const
{
WTF_ALLOW_UNSAFE_BUFFER_USAGE_BEGIN
StackTraceSymbolResolver { m_stack }.forEach([&](int frameNumber, void* stackFrame, const char* name) {
out.printf("%s%-3d %p %s\n", m_prefix ? m_prefix : "", frameNumber, stackFrame, name);
});
WTF_ALLOW_UNSAFE_BUFFER_USAGE_END
}
} // namespace WTF
|