Implement C++ symbol demangling on macOS #47486
Merged
Conversation
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
BrettDong
added
OS: macOS
BrettDong
force-pushed
the
demangle-mac
branch
2 times, most recently
from
e43fe6b to
e1b702d
Compare
|
I think this is a gcc header, so it could be available when building using Windows cross-compile/MSYS2/Cygwin (needs testing). Demangling when using MSVC should be different. |
Match function symbol names by a regular expression designed specifically for the stack trace pattern returned from backtrace_symbols() on macOS, and then try to demangle the symbol by abi::__cxa_demangle(). If demangling succeeds, then output the demangled symbol name, otherwise output the original raw symbol name. References: [1] https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/backtrace_symbols.3.html [2] https://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.3/a01696.html
BrettDong
force-pushed
the
demangle-mac
branch
from
e1b702d to
53f3a15
Compare
|
I'll try to implement symbol demangling on macOS, Linux and BSD first (in this and subsequent PRs), and then see if MinGW will also work. I don't have a x86 arch computer right now so I'm unable to code and test MSVC demangling. |
|
I tried to install Visual Studio 2019 on Windows 10 ARM VM but the debugger doesn't work. |
ZhilkinSerg
reviewed
Apr 7, 2021
| @@ -791,6 +793,34 @@ static constexpr int bt_cnt = 20; | |||
| static void *bt[bt_cnt]; | |||
| #endif | |||
|
|
|||
| #if !defined(_WIN32) | |||
| static void write_demangled_frame( std::ostream &out, const char *frame ) | |||
There was a problem hiding this comment.
We need to hide this function for Android:
20:11:27 [arm64-v8a] Compile++ : main <= debug.cpp
20:11:27 /var/lib/jenkins/workspace/Cataclysm-Android/android/app/jni/src/../../../../src/debug.cpp:831:13: warning: unused function 'write_demangled_frame' [-Wunused-function]
20:11:27 static void write_demangled_frame( std::ostream &out, const char *frame )
20:11:27 ^
20:11:27 1 warning generated.
scarf005
added a commit
to scarf005/Cataclysm-BN
that referenced
this pull request
Aug 30, 2023
from: CleverRaven/Cataclysm-DDA#47486 Co-authored-by: Brett Dong <[email protected]>
scarf005
added a commit
to scarf005/Cataclysm-BN
that referenced
this pull request
Aug 31, 2023
from: CleverRaven/Cataclysm-DDA#47486 Co-authored-by: Brett Dong <[email protected]>
scarf005
added a commit
to scarf005/Cataclysm-BN
that referenced
this pull request
Sep 1, 2023
from: CleverRaven/Cataclysm-DDA#47486 Co-authored-by: Brett Dong <[email protected]>
Firestorm01X2
pushed a commit
to cataclysmbnteam/Cataclysm-BN
that referenced
this pull request
Sep 3, 2023
* chore: unindent common messages was very confusing with `CMAKE_BUILD_TYPE` * fix(port): BSD macro in src/debug.cpp from: CleverRaven/Cataclysm-DDA#47440 Co-authored-by: Brett Dong <[email protected]> * fix(port): Implement C++ symbol demangling on macOS from: CleverRaven/Cataclysm-DDA#47486 Co-authored-by: Brett Dong <[email protected]> * refactor(port): Extract symbol demangling to a separate function from: CleverRaven/Cataclysm-DDA#47517 Co-authored-by: Brett Dong <[email protected]> * feat(port): Demangle symbol names on MinGW from: CleverRaven/Cataclysm-DDA#47517 Co-authored-by: Brett Dong <[email protected]> * feat(port): Implement C++ symbol demangling on Linux from: CleverRaven/Cataclysm-DDA#47621 Co-authored-by: Brett Dong <[email protected]> * feat(port): Implement C++ symbol demangling on FreeBSD and OpenBSD from: CleverRaven/Cataclysm-DDA#48152 Co-authored-by: Brett Dong <[email protected]> * fix(port): C++ symbol demangling on cross-compile MinGW from: CleverRaven/Cataclysm-DDA#48220 Co-authored-by: Brett Dong <[email protected]> * fix(port): memory leak in demangle() from: CleverRaven/Cataclysm-DDA#48230 Co-authored-by: Brett Dong <[email protected]> * feat(port): Backtrace on Android from: CleverRaven/Cataclysm-DDA#48371 Co-authored-by: Brett Dong <[email protected]> * chore(port): hide write_demangled_frame() for Android build from: CleverRaven/Cataclysm-DDA#48414 Co-authored-by: Brett Dong <[email protected]> * feat(port): demangle RTTI type names in debug messages from: CleverRaven/Cataclysm-DDA#52633 Co-authored-by: Brett Dong <[email protected]> * perf(port): optimize null stream in DebugLog from: CleverRaven/Cataclysm-DDA#55156 Co-authored-by: Brett Dong <[email protected]> * fix(port): reported version of newer Windows 10 releases from: CleverRaven/Cataclysm-DDA#55506 Co-authored-by: xuv <[email protected]> * feat(port): include build number in windows version report CleverRaven/Cataclysm-DDA#55646 Co-authored-by: xuv <[email protected]> * feat(port): get the actual static image base of modules from: CleverRaven/Cataclysm-DDA#55782 Co-authored-by: Qrox <[email protected]> * ci: fix version typo * feat(port): support libbacktrace on linux from: CleverRaven/Cataclysm-DDA#59020 Co-authored-by: John Bytheway <[email protected]> * build(cmake): support custom linker context: https://stackoverflow.com//questions/1867745/cmake-use-a-custom-linker#answer-66730019 * docs(cmake): linker, backtrace and libbacktrace --------- Co-authored-by: Brett Dong <[email protected]> Co-authored-by: xuv <[email protected]> Co-authored-by: Qrox <[email protected]> Co-authored-by: John Bytheway <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Infrastructure "Demangle C++ symbols in crash report on macOS"
Purpose of change
Try to implement C++ symbol demangling on macOS so that crash reports are easier to read.
Describe the solution
Extract symbol names from the output of
backtrace_symbols()system function by regular expression and then useabi::__cxa_demanglein<cxxabi.h>to demangle C++ symbols. The pattern of the output frombacktrace_symbols()differ across different systems, so in this PR I am only trying to implement the functionality on macOS.Describe the alternative you've considered
abi::__cxa_demanglein<cxxabi.h>, establish a pipe and invokec++filtcommand in the host system.clangsymbols.Testing
Before:
After:
Additional context
The idea was raised in #46758.
Edit: This should work perfectly if the binary is built natively on the same system. I don't know whether this will work in Jenkins cross-compiled version.
Edit 2: Jenkins also uses clang with libc++ when cross-compiling to macOS so theoretically I guess it will work too.
Edit 3:
<cxxabi.h>does not exist on Windows, so I moved it to!_WIN32region.