-
-
Notifications
You must be signed in to change notification settings - Fork 21.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a crash handler to dump the backtrace on Windows, Linux and OS X
- Loading branch information
1 parent
06138bf
commit 83fe937
Showing
23 changed files
with
786 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /*************************************************************************/ | ||
| /* crash_handler_osx.h */ | ||
| /*************************************************************************/ | ||
| /* This file is part of: */ | ||
| /* GODOT ENGINE */ | ||
| /* https://godotengine.org */ | ||
| /*************************************************************************/ | ||
| /* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */ | ||
| /* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) */ | ||
| /* */ | ||
| /* 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. */ | ||
| /*************************************************************************/ | ||
| #ifndef CRASH_HANDLER_OSX_H | ||
| #define CRASH_HANDLER_OSX_H | ||
|
|
||
| class CrashHandler { | ||
|
|
||
| bool disabled; | ||
|
|
||
| public: | ||
| void initialize(); | ||
|
|
||
| void disable(); | ||
| bool is_disabled() const { return disabled; }; | ||
|
|
||
| CrashHandler(); | ||
| ~CrashHandler(); | ||
| }; | ||
|
|
||
| #endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| /*************************************************************************/ | ||
| /* crash_handler_osx.mm */ | ||
| /*************************************************************************/ | ||
| /* This file is part of: */ | ||
| /* GODOT ENGINE */ | ||
| /* https://godotengine.org */ | ||
| /*************************************************************************/ | ||
| /* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */ | ||
| /* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) */ | ||
| /* */ | ||
| /* 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 "main/main.h" | ||
| #include "os_osx.h" | ||
|
|
||
| #include <string.h> | ||
| #include <unistd.h> | ||
|
|
||
| // Note: Dump backtrace in 32bit mode is getting a bus error on the fgets by the ->execute, so enable only on 64bit | ||
| #if defined(DEBUG_ENABLED) && defined(__x86_64__) | ||
| #define CRASH_HANDLER_ENABLED 1 | ||
| #endif | ||
|
|
||
| #ifdef CRASH_HANDLER_ENABLED | ||
| #include <cxxabi.h> | ||
| #include <dlfcn.h> | ||
| #include <execinfo.h> | ||
| #include <signal.h> | ||
|
|
||
| #include <mach-o/dyld.h> | ||
| #include <mach-o/getsect.h> | ||
|
|
||
| #ifdef __x86_64__ | ||
| static uint64_t load_address() { | ||
| const struct segment_command_64 *cmd = getsegbyname("__TEXT"); | ||
| #else | ||
| static uint32_t load_address() { | ||
| const struct segment_command *cmd = getsegbyname("__TEXT"); | ||
| #endif | ||
| 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() == NULL) | ||
| return; | ||
|
|
||
| void *bt_buffer[256]; | ||
| size_t size = backtrace(bt_buffer, 256); | ||
| String _execpath = OS::get_singleton()->get_executable_path(); | ||
| String msg = GLOBAL_GET("debug/settings/backtrace/message"); | ||
|
|
||
| // Dump the backtrace to stderr with a message to the user | ||
| fprintf(stderr, "%s: Program crashed with signal %d\n", __FUNCTION__, sig); | ||
| fprintf(stderr, "Dumping the backtrace. %ls\n", msg.c_str()); | ||
| char **strings = backtrace_symbols(bt_buffer, size); | ||
| if (strings) { | ||
| void *load_addr = (void *)load_address(); | ||
|
|
||
| for (int 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, NULL, 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); | ||
| args.push_back("-arch"); | ||
| #ifdef __x86_64__ | ||
| args.push_back("x86_64"); | ||
| #else | ||
| args.push_back("i386"); | ||
| #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, true, NULL, &out, &ret); | ||
| if (err == OK && out.substr(0, 2) != "0x") { | ||
| out.erase(out.length() - 1, 1); | ||
| output = out; | ||
| } | ||
| } | ||
|
|
||
| fprintf(stderr, "[%d] %ls\n", i, output.c_str()); | ||
| } | ||
|
|
||
| free(strings); | ||
| } | ||
| fprintf(stderr, "-- END OF BACKTRACE --\n"); | ||
|
|
||
| // Abort to pass the error to the OS | ||
| abort(); | ||
| } | ||
| #endif | ||
|
|
||
| CrashHandler::CrashHandler() { | ||
| disabled = false; | ||
| } | ||
|
|
||
| CrashHandler::~CrashHandler() { | ||
| } | ||
|
|
||
| void CrashHandler::disable() { | ||
| if (disabled) | ||
| return; | ||
|
|
||
| #ifdef CRASH_HANDLER_ENABLED | ||
| signal(SIGSEGV, NULL); | ||
| signal(SIGFPE, NULL); | ||
| signal(SIGILL, NULL); | ||
| #endif | ||
|
|
||
| disabled = true; | ||
| } | ||
|
|
||
| void CrashHandler::initialize() { | ||
| #ifdef CRASH_HANDLER_ENABLED | ||
| signal(SIGSEGV, handle_crash); | ||
| signal(SIGFPE, handle_crash); | ||
| signal(SIGILL, handle_crash); | ||
| #endif | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.