godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-24 15:26:15 +00:00
Code Releases Wiki Activity

Crash handler: Use print_error to include backtrace in logs

Browse Source
This commit is contained in:
Rémi Verschelde
2022-05-05 11:45:42 +02:00
parent 11b9435130
commit c366f8d2d4
3 changed files with 47 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
platform/linuxbsd/crash_handler_linuxbsd.cpp
View File

@@ -32,6 +32,7 @@
#include "core/config/project_settings.h" #include "core/config/project_settings.h"
#include "core/os/os.h" #include "core/os/os.h"
#include "core/string/print_string.h"
#include "core/version.h" #include "core/version.h"
#include "main/main.h" #include "main/main.h"
@@ -61,21 +62,22 @@ static void handle_crash(int sig) {
msg = proj_settings->get("debug/settings/crash_handler/message"); msg = proj_settings->get("debug/settings/crash_handler/message");
} }
// Dump the backtrace to stderr with a message to the user // Tell MainLoop about the crash. This can be handled by users too in Node.
fprintf(stderr, "\n================================================================\n");
fprintf(stderr, "%s: Program crashed with signal %d\n", __FUNCTION__, sig);
if (OS::get_singleton()->get_main_loop()) { if (OS::get_singleton()->get_main_loop()) {
OS::get_singleton()->get_main_loop()->notification(MainLoop::NOTIFICATION_CRASH); 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. // Print the engine version just before, so that people are reminded to include the version in backtrace reports.
if (String(VERSION_HASH).is_empty()) { if (String(VERSION_HASH).is_empty()) {
fprintf(stderr, "Engine version: %s\n", VERSION_FULL_NAME); print_error(vformat("Engine version: %s", VERSION_FULL_NAME));
} else { } else {
fprintf(stderr, "Engine version: %s (%s)\n", VERSION_FULL_NAME, VERSION_HASH); print_error(vformat("Engine version: %s (%s)", VERSION_FULL_NAME, VERSION_HASH));
} }
fprintf(stderr, "Dumping the backtrace. %s\n", msg.utf8().get_data()); print_error(vformat("Dumping the backtrace. %s", msg));
char **strings = backtrace_symbols(bt_buffer, size); char **strings = backtrace_symbols(bt_buffer, size);
if (strings) { if (strings) {
for (size_t i = 1; i < size; i++) { for (size_t i = 1; i < size; i++) {
@@ -117,13 +119,13 @@ static void handle_crash(int sig) {
output = output.substr(0, output.length() - 1); output = output.substr(0, output.length() - 1);
} }
fprintf(stderr, "[%ld] %s (%s)\n", (long int)i, fname, output.utf8().get_data()); print_error(vformat("[%d] %s (%s)", (int64_t)i, fname, output));
} }
free(strings); free(strings);
} }
fprintf(stderr, "-- END OF BACKTRACE --\n"); print_error("-- END OF BACKTRACE --");
fprintf(stderr, "================================================================\n"); print_error("================================================================");
// Abort to pass the error to the OS // Abort to pass the error to the OS
abort(); abort();

22
platform/osx/crash_handler_osx.mm
View File

@@ -32,6 +32,7 @@
#include "core/config/project_settings.h" #include "core/config/project_settings.h"
#include "core/os/os.h" #include "core/os/os.h"
#include "core/string/print_string.h"
#include "core/version.h" #include "core/version.h"
#include "main/main.h" #include "main/main.h"
@@ -85,21 +86,22 @@ static void handle_crash(int sig) {
msg = proj_settings->get("debug/settings/crash_handler/message"); msg = proj_settings->get("debug/settings/crash_handler/message");
} }
// Dump the backtrace to stderr with a message to the user // Tell MainLoop about the crash. This can be handled by users too in Node.
fprintf(stderr, "\n================================================================\n");
fprintf(stderr, "%s: Program crashed with signal %d\n", __FUNCTION__, sig);
if (OS::get_singleton()->get_main_loop()) { if (OS::get_singleton()->get_main_loop()) {
OS::get_singleton()->get_main_loop()->notification(MainLoop::NOTIFICATION_CRASH); 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. // Print the engine version just before, so that people are reminded to include the version in backtrace reports.
if (String(VERSION_HASH).is_empty()) { if (String(VERSION_HASH).is_empty()) {
fprintf(stderr, "Engine version: %s\n", VERSION_FULL_NAME); print_error(vformat("Engine version: %s", VERSION_FULL_NAME));
} else { } else {
fprintf(stderr, "Engine version: %s (%s)\n", VERSION_FULL_NAME, VERSION_HASH); print_error(vformat("Engine version: %s (%s)", VERSION_FULL_NAME, VERSION_HASH));
} }
fprintf(stderr, "Dumping the backtrace. %s\n", msg.utf8().get_data()); print_error(vformat("Dumping the backtrace. %s", msg));
char **strings = backtrace_symbols(bt_buffer, size); char **strings = backtrace_symbols(bt_buffer, size);
if (strings) { if (strings) {
void *load_addr = (void *)load_address(); void *load_addr = (void *)load_address();
@@ -157,13 +159,13 @@ static void handle_crash(int sig) {
} }
} }
fprintf(stderr, "[%zu] %s\n", i, output.utf8().get_data()); print_error(vformat("[%d] %s", (int64_t)i, output));
} }
free(strings); free(strings);
} }
fprintf(stderr, "-- END OF BACKTRACE --\n"); print_error("-- END OF BACKTRACE --");
fprintf(stderr, "================================================================\n"); print_error("================================================================");
// Abort to pass the error to the OS // Abort to pass the error to the OS
abort(); abort();

44
platform/windows/crash_handler_windows.cpp
View File

@@ -32,6 +32,7 @@
#include "core/config/project_settings.h" #include "core/config/project_settings.h"
#include "core/os/os.h" #include "core/os/os.h"
#include "core/string/print_string.h"
#include "core/version.h" #include "core/version.h"
#include "main/main.h" #include "main/main.h"
@@ -129,13 +130,28 @@ DWORD CrashHandlerException(EXCEPTION_POINTERS *ep) {
return EXCEPTION_CONTINUE_SEARCH; return EXCEPTION_CONTINUE_SEARCH;
} }
fprintf(stderr, "\n================================================================\n"); String msg;
fprintf(stderr, "%s: Program crashed\n", __FUNCTION__); 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()) { if (OS::get_singleton()->get_main_loop()) {
OS::get_singleton()->get_main_loop()->notification(MainLoop::NOTIFICATION_CRASH); OS::get_singleton()->get_main_loop()->notification(MainLoop::NOTIFICATION_CRASH);
} }
print_error("\n================================================================");
print_error(vformat("%s: Program crashed", __FUNCTION__));
// 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));
// Load the symbols: // Load the symbols:
if (!SymInitialize(process, nullptr, false)) { if (!SymInitialize(process, nullptr, false)) {
return EXCEPTION_CONTINUE_SEARCH; return EXCEPTION_CONTINUE_SEARCH;
@@ -174,20 +190,6 @@ DWORD CrashHandlerException(EXCEPTION_POINTERS *ep) {
IMAGE_NT_HEADERS *h = ImageNtHeader(base); IMAGE_NT_HEADERS *h = ImageNtHeader(base);
DWORD image_type = h->FileHeader.Machine; DWORD image_type = h->FileHeader.Machine;
String msg;
const ProjectSettings *proj_settings = ProjectSettings::get_singleton();
if (proj_settings) {
msg = proj_settings->get("debug/settings/crash_handler/message");
}
// Print the engine version just before, so that people are reminded to include the version in backtrace reports.
if (String(VERSION_HASH).is_empty()) {
fprintf(stderr, "Engine version: %s\n", VERSION_FULL_NAME);
} else {
fprintf(stderr, "Engine version: %s (%s)\n", VERSION_FULL_NAME, VERSION_HASH);
}
fprintf(stderr, "Dumping the backtrace. %s\n", msg.utf8().get_data());
int n = 0; int n = 0;
do { do {
if (skip_first) { if (skip_first) {
@@ -197,12 +199,12 @@ DWORD CrashHandlerException(EXCEPTION_POINTERS *ep) {
std::string fnName = symbol(process, frame.AddrPC.Offset).undecorated_name(); std::string fnName = symbol(process, frame.AddrPC.Offset).undecorated_name();
if (SymGetLineFromAddr64(process, frame.AddrPC.Offset, &offset_from_symbol, &line)) { if (SymGetLineFromAddr64(process, frame.AddrPC.Offset, &offset_from_symbol, &line)) {
fprintf(stderr, "[%d] %s (%s:%d)\n", n, fnName.c_str(), line.FileName, line.LineNumber); print_error(vformat("[%d] %s (%s:%d)", n, fnName.c_str(), (char *)line.FileName, (int)line.LineNumber));
} else { } else {
fprintf(stderr, "[%d] %s\n", n, fnName.c_str()); print_error(vformat("[%d] %s", n, fnName.c_str()));
} }
} else { } else {
fprintf(stderr, "[%d] ???\n", n); print_error(vformat("[%d] ???", n));
} }
n++; n++;
@@ -213,8 +215,8 @@ DWORD CrashHandlerException(EXCEPTION_POINTERS *ep) {
} }
} while (frame.AddrReturn.Offset != 0 && n < 256); } while (frame.AddrReturn.Offset != 0 && n < 256);
fprintf(stderr, "-- END OF BACKTRACE --\n"); print_error("-- END OF BACKTRACE --");
fprintf(stderr, "================================================================\n"); print_error("================================================================");
SymCleanup(process); SymCleanup(process);