d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
203 lines
6.5 KiB
Text
203 lines
6.5 KiB
Text
/**************************************************************************/
|
|
/* crash_handler_macos.mm */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#include "crash_handler_macos.h"
|
|
|
|
#include "core/config/project_settings.h"
|
|
#include "core/os/os.h"
|
|
#include "core/string/print_string.h"
|
|
#include "core/version.h"
|
|
#include "main/main.h"
|
|
|
|
#include <string.h>
|
|
#include <unistd.h>
|
|
|
|
#if defined(DEBUG_ENABLED)
|
|
#define CRASH_HANDLER_ENABLED 1
|
|
#endif
|
|
|
|
#ifdef CRASH_HANDLER_ENABLED
|
|
#include <cxxabi.h>
|
|
#include <dlfcn.h>
|
|
#include <execinfo.h>
|
|
#include <signal.h>
|
|
#include <stdlib.h>
|
|
|
|
#include <mach-o/dyld.h>
|
|
#include <mach-o/getsect.h>
|
|
|
|
static uint64_t load_address() {
|
|
const struct segment_command_64 *cmd = getsegbyname("__TEXT");
|
|
char full_path[1024];
|
|
uint32_t size = sizeof(full_path);
|
|
|
|
if (cmd && !_NSGetExecutablePath(full_path, &size)) {
|
|
uint32_t dyld_count = _dyld_image_count();
|
|
for (uint32_t i = 0; i < dyld_count; i++) {
|
|
const char *image_name = _dyld_get_image_name(i);
|
|
if (image_name && strncmp(image_name, full_path, 1024) == 0) {
|
|
return cmd->vmaddr + _dyld_get_image_vmaddr_slide(i);
|
|
}
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static void handle_crash(int sig) {
|
|
if (OS::get_singleton() == nullptr) {
|
|
abort();
|
|
}
|
|
|
|
void *bt_buffer[256];
|
|
size_t size = backtrace(bt_buffer, 256);
|
|
String _execpath = OS::get_singleton()->get_executable_path();
|
|
|
|
String msg;
|
|
const ProjectSettings *proj_settings = ProjectSettings::get_singleton();
|
|
if (proj_settings) {
|
|
msg = proj_settings->get("debug/settings/crash_handler/message");
|
|
}
|
|
|
|
// Tell MainLoop about the crash. This can be handled by users too in Node.
|
|
if (OS::get_singleton()->get_main_loop()) {
|
|
OS::get_singleton()->get_main_loop()->notification(MainLoop::NOTIFICATION_CRASH);
|
|
}
|
|
|
|
// Dump the backtrace to stderr with a message to the user
|
|
print_error("\n================================================================");
|
|
print_error(vformat("%s: Program crashed with signal %d", __FUNCTION__, sig));
|
|
|
|
// Print the engine version just before, so that people are reminded to include the version in backtrace reports.
|
|
if (String(VERSION_HASH).is_empty()) {
|
|
print_error(vformat("Engine version: %s", VERSION_FULL_NAME));
|
|
} else {
|
|
print_error(vformat("Engine version: %s (%s)", VERSION_FULL_NAME, VERSION_HASH));
|
|
}
|
|
print_error(vformat("Dumping the backtrace. %s", msg));
|
|
char **strings = backtrace_symbols(bt_buffer, size);
|
|
if (strings) {
|
|
void *load_addr = (void *)load_address();
|
|
|
|
for (size_t i = 1; i < size; i++) {
|
|
char fname[1024];
|
|
Dl_info info;
|
|
|
|
snprintf(fname, 1024, "%s", strings[i]);
|
|
|
|
// Try to demangle the function name to provide a more readable one
|
|
if (dladdr(bt_buffer[i], &info) && info.dli_sname) {
|
|
if (info.dli_sname[0] == '_') {
|
|
int status;
|
|
char *demangled = abi::__cxa_demangle(info.dli_sname, nullptr, 0, &status);
|
|
|
|
if (status == 0 && demangled) {
|
|
snprintf(fname, 1024, "%s", demangled);
|
|
}
|
|
|
|
if (demangled) {
|
|
free(demangled);
|
|
}
|
|
}
|
|
}
|
|
|
|
String output = fname;
|
|
|
|
// Try to get the file/line number using atos
|
|
if (bt_buffer[i] > (void *)0x0 && OS::get_singleton()) {
|
|
List<String> args;
|
|
char str[1024];
|
|
|
|
args.push_back("-o");
|
|
args.push_back(_execpath);
|
|
#if defined(__x86_64) || defined(__x86_64__) || defined(__amd64__)
|
|
args.push_back("-arch");
|
|
args.push_back("x86_64");
|
|
#elif defined(__aarch64__)
|
|
args.push_back("-arch");
|
|
args.push_back("arm64");
|
|
#endif
|
|
args.push_back("-l");
|
|
snprintf(str, 1024, "%p", load_addr);
|
|
args.push_back(str);
|
|
snprintf(str, 1024, "%p", bt_buffer[i]);
|
|
args.push_back(str);
|
|
|
|
int ret;
|
|
String out = "";
|
|
Error err = OS::get_singleton()->execute(String("atos"), args, &out, &ret);
|
|
if (err == OK && out.substr(0, 2) != "0x") {
|
|
out = out.substr(0, out.length() - 1);
|
|
output = out;
|
|
}
|
|
}
|
|
|
|
print_error(vformat("[%d] %s", (int64_t)i, output));
|
|
}
|
|
|
|
free(strings);
|
|
}
|
|
print_error("-- END OF BACKTRACE --");
|
|
print_error("================================================================");
|
|
|
|
// Abort to pass the error to the OS
|
|
abort();
|
|
}
|
|
#endif
|
|
|
|
CrashHandler::CrashHandler() {
|
|
disabled = false;
|
|
}
|
|
|
|
CrashHandler::~CrashHandler() {
|
|
disable();
|
|
}
|
|
|
|
void CrashHandler::disable() {
|
|
if (disabled) {
|
|
return;
|
|
}
|
|
|
|
#ifdef CRASH_HANDLER_ENABLED
|
|
signal(SIGSEGV, nullptr);
|
|
signal(SIGFPE, nullptr);
|
|
signal(SIGILL, nullptr);
|
|
#endif
|
|
|
|
disabled = true;
|
|
}
|
|
|
|
void CrashHandler::initialize() {
|
|
#ifdef CRASH_HANDLER_ENABLED
|
|
signal(SIGSEGV, handle_crash);
|
|
signal(SIGFPE, handle_crash);
|
|
signal(SIGILL, handle_crash);
|
|
#endif
|
|
}
|