blob: ff49065a451775a07e0550e51a5757bc45ce95a4 [file] [log] [blame]
//===--- Errors.cpp - Error reporting utilities ---------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// Utilities for reporting errors to stderr, system console, and crash logs.
//
//===----------------------------------------------------------------------===//
#if defined(__CYGWIN__) || defined(__ANDROID__) || defined(_WIN32) || defined(__HAIKU__)
# define SWIFT_SUPPORTS_BACKTRACE_REPORTING 0
#else
# define SWIFT_SUPPORTS_BACKTRACE_REPORTING 1
#endif
#if defined(_WIN32)
#include <mutex>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdint.h>
#if defined(_WIN32)
#include <io.h>
#else
#include <unistd.h>
#endif
#include <stdarg.h>
#include "ImageInspection.h"
#include "swift/Runtime/Debug.h"
#include "swift/Runtime/Mutex.h"
#include "swift/Demangling/Demangle.h"
#include "swift/Basic/LLVM.h"
#include "llvm/ADT/StringRef.h"
#if defined(_MSC_VER)
#include <DbgHelp.h>
#else
#include <cxxabi.h>
#endif
#if SWIFT_SUPPORTS_BACKTRACE_REPORTING
// execinfo.h is not available on Android. Checks in this file ensure that
// fatalError behaves as expected, but without stack traces.
#include <execinfo.h>
#endif
#if defined(__APPLE__)
#include <asl.h>
#elif defined(__ANDROID__)
#include <android/log.h>
#endif
namespace FatalErrorFlags {
enum: uint32_t {
ReportBacktrace = 1 << 0
};
} // end namespace FatalErrorFlags
using namespace swift;
#if SWIFT_SUPPORTS_BACKTRACE_REPORTING
static bool getSymbolNameAddr(llvm::StringRef libraryName, SymbolInfo syminfo,
std::string &symbolName, uintptr_t &addrOut) {
// If we failed to find a symbol and thus dlinfo->dli_sname is nullptr, we
// need to use the hex address.
bool hasUnavailableAddress = syminfo.symbolName == nullptr;
if (hasUnavailableAddress) {
return false;
}
// Ok, now we know that we have some sort of "real" name. Set the outAddr.
addrOut = uintptr_t(syminfo.symbolAddress);
// First lets try to demangle using cxxabi. If this fails, we will try to
// demangle with swift. We are taking advantage of __cxa_demangle actually
// providing failure status instead of just returning the original string like
// swift demangle.
#if defined(_WIN32)
DWORD dwFlags = UNDNAME_COMPLETE;
#if !defined(_WIN64)
dwFlags |= UNDNAME_32_BIT_DECODE;
#endif
static std::mutex mutex;
char szUndName[1024];
DWORD dwResult;
{
std::lock_guard<std::mutex> lock(m);
dwResult = UnDecorateSymbolName(syminfo.symbolName, szUndName,
sizeof(szUndName), dwFlags);
}
if (dwResult == TRUE) {
symbolName += szUndName;
return true;
}
#else
int status;
char *demangled = abi::__cxa_demangle(syminfo.symbolName, 0, 0, &status);
if (status == 0) {
assert(demangled != nullptr &&
"If __cxa_demangle succeeds, demangled should never be nullptr");
symbolName += demangled;
free(demangled);
return true;
}
assert(demangled == nullptr &&
"If __cxa_demangle fails, demangled should be a nullptr");
#endif
// Otherwise, try to demangle with swift. If swift fails to demangle, it will
// just pass through the original output.
symbolName = demangleSymbolAsString(
syminfo.symbolName, strlen(syminfo.symbolName),
Demangle::DemangleOptions::SimplifiedUIDemangleOptions());
return true;
}
#endif
void swift::dumpStackTraceEntry(unsigned index, void *framePC,
bool shortOutput) {
#if SWIFT_SUPPORTS_BACKTRACE_REPORTING
SymbolInfo syminfo;
// 0 is failure for lookupSymbol
if (0 == lookupSymbol(framePC, &syminfo)) {
return;
}
// If lookupSymbol succeeded then fileName is non-null. Thus, we find the
// library name here.
StringRef libraryName = StringRef(syminfo.fileName).rsplit('/').second;
// Next we get the symbol name that we are going to use in our backtrace.
std::string symbolName;
// We initialize symbolAddr to framePC so that if we succeed in finding the
// symbol, we get the offset in the function and if we fail to find the symbol
// we just get HexAddr + 0.
uintptr_t symbolAddr = uintptr_t(framePC);
bool foundSymbol =
getSymbolNameAddr(libraryName, syminfo, symbolName, symbolAddr);
ptrdiff_t offset = 0;
if (foundSymbol) {
offset = ptrdiff_t(uintptr_t(framePC) - symbolAddr);
} else {
offset = ptrdiff_t(uintptr_t(framePC) - uintptr_t(syminfo.baseAddress));
symbolAddr = uintptr_t(framePC);
symbolName = "<unavailable>";
}
// We do not use %p here for our pointers since the format is implementation
// defined. This makes it logically impossible to check the output. Forcing
// hexadecimal solves this issue.
// If the symbol is not available, we print out <unavailable> + offset
// from the base address of where the image containing framePC is mapped.
// This gives enough info to reconstruct identical debugging target after
// this process terminates.
if (shortOutput) {
fprintf(stderr, "%s`%s + %td", libraryName.data(), symbolName.c_str(),
offset);
} else {
constexpr const char *format = "%-4u %-34s 0x%0.16" PRIxPTR " %s + %td\n";
fprintf(stderr, format, index, libraryName.data(), symbolAddr,
symbolName.c_str(), offset);
}
#else
if (shortOutput) {
fprintf(stderr, "<unavailable>");
} else {
constexpr const char *format = "%-4u 0x%0.16tx\n";
fprintf(stderr, format, index, reinterpret_cast<uintptr_t>(framePC));
}
#endif
}
LLVM_ATTRIBUTE_NOINLINE
void swift::printCurrentBacktrace(unsigned framesToSkip) {
#if SWIFT_SUPPORTS_BACKTRACE_REPORTING
constexpr unsigned maxSupportedStackDepth = 128;
void *addrs[maxSupportedStackDepth];
int symbolCount = backtrace(addrs, maxSupportedStackDepth);
for (int i = framesToSkip; i < symbolCount; ++i) {
dumpStackTraceEntry(i - framesToSkip, addrs[i]);
}
#else
fprintf(stderr, "<backtrace unavailable>\n");
#endif
}
#ifdef SWIFT_HAVE_CRASHREPORTERCLIENT
#include <malloc/malloc.h>
// Instead of linking to CrashReporterClient.a (because it complicates the
// build system), define the only symbol from that static archive ourselves.
//
// The layout of this struct is CrashReporter ABI, so there are no ABI concerns
// here.
extern "C" {
LLVM_LIBRARY_VISIBILITY
struct crashreporter_annotations_t gCRAnnotations
__attribute__((__section__("__DATA," CRASHREPORTER_ANNOTATIONS_SECTION))) = {
CRASHREPORTER_ANNOTATIONS_VERSION, 0, 0, 0, 0, 0, 0, 0};
}
// Report a message to any forthcoming crash log.
static void
reportOnCrash(uint32_t flags, const char *message)
{
// We must use an "unsafe" mutex in this pathway since the normal "safe"
// mutex calls fatalError when an error is detected and fatalError ends up
// calling us. In other words we could get infinite recursion if the
// mutex errors.
static swift::StaticUnsafeMutex crashlogLock;
crashlogLock.lock();
char *oldMessage = (char *)CRGetCrashLogMessage();
char *newMessage;
if (oldMessage) {
asprintf(&newMessage, "%s%s", oldMessage, message);
if (malloc_size(oldMessage)) free(oldMessage);
} else {
newMessage = strdup(message);
}
CRSetCrashLogMessage(newMessage);
crashlogLock.unlock();
}
#else
static void
reportOnCrash(uint32_t flags, const char *message)
{
// empty
}
#endif
// Report a message to system console and stderr.
static void
reportNow(uint32_t flags, const char *message)
{
#if defined(_WIN32)
#define STDERR_FILENO 2
_write(STDERR_FILENO, message, strlen(message));
#else
write(STDERR_FILENO, message, strlen(message));
#endif
#if defined(__APPLE__)
asl_log(nullptr, nullptr, ASL_LEVEL_ERR, "%s", message);
#elif defined(__ANDROID__)
__android_log_print(ANDROID_LOG_FATAL, "SwiftRuntime", "%s", message);
#endif
#if SWIFT_SUPPORTS_BACKTRACE_REPORTING
if (flags & FatalErrorFlags::ReportBacktrace) {
fputs("Current stack trace:\n", stderr);
printCurrentBacktrace();
}
#endif
}
LLVM_ATTRIBUTE_NOINLINE SWIFT_RUNTIME_EXPORT
void _swift_runtime_on_report(uintptr_t flags, const char *message,
RuntimeErrorDetails *details) {
// Do nothing. This function is meant to be used by the debugger.
// The following is necessary to avoid calls from being optimized out.
asm volatile("" // Do nothing.
: // Output list, empty.
: "r" (flags), "r" (message), "r" (details) // Input list.
: // Clobber list, empty.
);
}
void swift::_swift_reportToDebugger(uintptr_t flags, const char *message,
RuntimeErrorDetails *details) {
_swift_runtime_on_report(flags, message, details);
}
bool swift::_swift_reportFatalErrorsToDebugger = true;
bool swift::_swift_shouldReportFatalErrorsToDebugger() {
return _swift_reportFatalErrorsToDebugger;
}
/// Report a fatal error to system console, stderr, and crash logs.
/// Does not crash by itself.
void swift::swift_reportError(uint32_t flags,
const char *message) {
#if defined(__APPLE__) && NDEBUG
flags &= ~FatalErrorFlags::ReportBacktrace;
#endif
reportNow(flags, message);
reportOnCrash(flags, message);
}
static int swift_vasprintf(char **strp, const char *fmt, va_list ap) {
#if defined(_WIN32)
int len = _vscprintf(fmt, ap);
if (len < 0)
return -1;
char *buffer = reinterpret_cast<char *>(malloc(len + 1));
if (!buffer)
return -1;
int result = vsprintf(buffer, fmt, ap);
if (result < 0) {
free(buffer);
return -1;
}
*strp = buffer;
return result;
#else
return vasprintf(strp, fmt, ap);
#endif
}
// Report a fatal error to system console, stderr, and crash logs, then abort.
LLVM_ATTRIBUTE_NORETURN
void
swift::fatalError(uint32_t flags, const char *format, ...)
{
va_list args;
va_start(args, format);
char *log;
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wuninitialized"
swift_vasprintf(&log, format, args);
#pragma GCC diagnostic pop
swift_reportError(flags, log);
abort();
}
// Report a warning to system console and stderr.
void
swift::warningv(uint32_t flags, const char *format, va_list args)
{
char *log;
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wuninitialized"
swift_vasprintf(&log, format, args);
#pragma GCC diagnostic pop
reportNow(flags, log);
free(log);
}
// Report a warning to system console and stderr.
void
swift::warning(uint32_t flags, const char *format, ...)
{
va_list args;
va_start(args, format);
warningv(flags, format, args);
}
// Crash when a deleted method is called by accident.
SWIFT_RUNTIME_EXPORT
LLVM_ATTRIBUTE_NORETURN
void
swift_deletedMethodError() {
swift::fatalError(/* flags = */ 0,
"Fatal error: Call of deleted method\n");
}
// Crash due to a retain count overflow.
// FIXME: can't pass the object's address from InlineRefCounts without hacks
void swift::swift_abortRetainOverflow() {
swift::fatalError(FatalErrorFlags::ReportBacktrace,
"Fatal error: Object was retained too many times");
}
// Crash due to an unowned retain count overflow.
// FIXME: can't pass the object's address from InlineRefCounts without hacks
void swift::swift_abortUnownedRetainOverflow() {
swift::fatalError(FatalErrorFlags::ReportBacktrace,
"Fatal error: Object's unowned reference was retained too many times");
}
// Crash due to a weak retain count overflow.
// FIXME: can't pass the object's address from InlineRefCounts without hacks
void swift::swift_abortWeakRetainOverflow() {
swift::fatalError(FatalErrorFlags::ReportBacktrace,
"Fatal error: Object's weak reference was retained too many times");
}
// Crash due to retain of a dead unowned reference.
// FIXME: can't pass the object's address from InlineRefCounts without hacks
void swift::swift_abortRetainUnowned(const void *object) {
if (object) {
swift::fatalError(FatalErrorFlags::ReportBacktrace,
"Fatal error: Attempted to read an unowned reference but "
"object %p was already deallocated", object);
} else {
swift::fatalError(FatalErrorFlags::ReportBacktrace,
"Fatal error: Attempted to read an unowned reference but "
"the object was already deallocated");
}
}