aboutsummaryrefslogtreecommitdiff
path: root/llvm/lib/Support/Signals.cpp
diff options
context:
space:
mode:
authorFangrui Song <maskray@google.com>2020-08-20 08:14:10 -0700
committerFangrui Song <maskray@google.com>2020-08-21 11:27:13 -0700
commit06cad825cdd4c819e88eac8179a06d196304e78e (patch)
treee055e82148d48c205f48ad0d95c59159e59dc96c /llvm/lib/Support/Signals.cpp
parent0cadd162b7c17ec3159154fa25abad33fcf51005 (diff)
downloadllvm-06cad825cdd4c819e88eac8179a06d196304e78e.zip
llvm-06cad825cdd4c819e88eac8179a06d196304e78e.tar.gz
llvm-06cad825cdd4c819e88eac8179a06d196304e78e.tar.bz2
PrintStackTrace: don't symbolize if LLVM_DISABLE_SYMBOLIZATION is set
See http://lists.llvm.org/pipermail/llvm-dev/2017-June/113975.html for a related previous discussion. Many tools install signal handlers to print stack traces and optionally symbolize the addresses with an external program 'llvm-symbolizer' (when searching for 'llvm-symbolizer', the directory containg the executable is preferred over PATH). 'llvm-symbolizer' can be slow if the executable is large and/or if llvm-symbolizer' itself is under-optimized. For example, my 'llvm-lto2' from a -DCMAKE_BUILD_TYPE=Debug build is 443MiB. The 'llvm-symbolizer' from the same build takes ~2s to symbolize it. (An optimized 'llvm-symbolizer' takes 0.34s). A crashed clang may take more than 5s to symbolize a stack trace. If a test file has several `not --crash` RUN lines. It can be very slow in a Debug build. This patch makes `not --crash` set an environment variable to suppress symbolization. This is similar to D33804 which uses a command line option. I pick 'symbolization' instead of 'symbolication' because the former is used much more commonly and its stem matches 'llvm-symbolizer'. Also set LLVM_DISABLE_CRASH_REPORT=1, which is currently only applicable on `__APPLE__`. Reviewed By: dblaikie, aganea Differential Revision: https://reviews.llvm.org/D86170
Diffstat (limited to 'llvm/lib/Support/Signals.cpp')
-rw-r--r--llvm/lib/Support/Signals.cpp4
1 files changed, 3 insertions, 1 deletions
diff --git a/llvm/lib/Support/Signals.cpp b/llvm/lib/Support/Signals.cpp
index 2cfdf2d..83a606b 100644
--- a/llvm/lib/Support/Signals.cpp
+++ b/llvm/lib/Support/Signals.cpp
@@ -44,6 +44,8 @@ static cl::opt<bool, true>
cl::desc("Disable symbolizing crash backtraces."),
cl::location(DisableSymbolicationFlag), cl::Hidden);
+constexpr char DisableSymbolizationEnv[] = "LLVM_DISABLE_SYMBOLIZATION";
+
// Callbacks to run in signal handler must be lock-free because a signal handler
// could be running as we add new callbacks. We don't add unbounded numbers of
// callbacks, an array is therefore sufficient.
@@ -105,7 +107,7 @@ static FormattedNumber format_ptr(void *PC) {
LLVM_ATTRIBUTE_USED
static bool printSymbolizedStackTrace(StringRef Argv0, void **StackTrace,
int Depth, llvm::raw_ostream &OS) {
- if (DisableSymbolicationFlag)
+ if (DisableSymbolicationFlag || getenv(DisableSymbolizationEnv))
return false;
// Don't recursively invoke the llvm-symbolizer binary.