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

MacOS: Improve crash handler performance

Browse Source 
The most significant change is the version calls `atos` with a batch of
addresses, rather than one at a time. Reduces large stack traces down
to about a second or less (after OS caching).
This commit is contained in:
Stuart Carnie
2025-10-09 06:19:21 +11:00
parent 4ad11b6af3
commit 33cc3c125d
1 changed files with 76 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
platform/macos/crash_handler_macos.mm
View File

@@ -55,17 +55,15 @@
#import <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);
}
if (!_NSGetExecutablePath(full_path, &size)) {
void *handle = dlopen(full_path, RTLD_LAZY | RTLD_NOLOAD);
void *addr = dlsym(handle, "main");
Dl_info info;
if (dladdr(addr, &info)) {
return (uint64_t)info.dli_fbase;
}
}
@@ -100,7 +98,7 @@ static void handle_crash(int sig) {
OS::get_singleton()->get_main_loop()->notification(MainLoop::NOTIFICATION_CRASH);
}
// Dump the backtrace to stderr with a message to the user
// 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));
@@ -111,69 +109,88 @@ static void handle_crash(int sig) {
print_error(vformat("Engine version: %s (%s)", GODOT_VERSION_FULL_NAME, GODOT_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;
List<String> args;
args.push_back("-o");
args.push_back(_execpath);
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");
args.push_back("-arch");
args.push_back("x86_64");
#elif defined(__aarch64__)
args.push_back("-arch");
args.push_back("arm64");
args.push_back("-arch");
args.push_back("arm64");
#endif
args.push_back("--fullPath");
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;
args.push_back("--fullPath");
args.push_back("-l");
char str[1024];
void *load_addr = (void *)load_address();
snprintf(str, 1024, "%p", load_addr);
args.push_back(str);
for (size_t i = 0; i < size; i++) {
snprintf(str, 1024, "%p", bt_buffer[i]);
args.push_back(str);
}
// Single execution of atos with all addresses.
String out;
int ret;
Error err = OS::get_singleton()->execute(String("atos"), args, &out, &ret);
if (err == OK) {
// Parse the multi-line output
Vector<String> lines = out.split("\n");
// Get demangled names from dladdr for fallback.
char **strings = backtrace_symbols(bt_buffer, size);
for (int i = 1; i < lines.size() && i < (int)size; i++) {
String output = lines[i];
// If atos failed for this address, fall back to dladdr.
if (output.substr(0, 2) == "0x" && strings) {
char fname[1024];
Dl_info info;
snprintf(fname, 1024, "%s", strings[i]);
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);
}
}
}
output = fname;
}
print_error(vformat("[%d] %s", (int64_t)i, output));
}
free(strings);
if (strings) {
free(strings);
}
} else {
// Fallback if atos fails entirely
char **strings = backtrace_symbols(bt_buffer, size);
if (strings) {
for (size_t i = 0; i < size; i++) {
print_error(vformat("[%d] %s", (int64_t)i, strings[i]));
}
free(strings);
}
}
print_error("-- END OF C++ BACKTRACE --");
print_error("================================================================");