[PATCH] D86170: PrintStackTrace: don't symbolize if LLVM_DISABLE_SYMBOLIZATION is set

[Fangrui Song via Phabricator via llvm-commits]

MaskRay created this revision.
MaskRay added reviewers: dblaikie, jhenderson.
Herald added subscribers: llvm-commits, dexonsmith, hiraditya.
Herald added a project: LLVM.
MaskRay requested review of this revision.

Many tools install signal handlers to print stack traces and optionally
symbolize the addresses with an external program 'llvm-symbolizer'.

'llvm-symbolizer' can be slow if the executable is large and/or if
llvm-symbolizer' itself is less 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 <https://reviews.llvm.org/D33804> which uses a command line option.
I pick 'symbolization' instead of 'symbolication' before 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__`.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D86170

Files:
  llvm/lib/Support/Signals.cpp
  llvm/test/tools/not/disable-symbolization.test
  llvm/utils/not/not.cpp


Index: llvm/utils/not/not.cpp
===================================================================
--- llvm/utils/not/not.cpp
+++ llvm/utils/not/not.cpp
@@ -27,6 +27,11 @@
     ++argv;
     --argc;
     ExpectCrash = true;
+
+    // Crash is expected, so disable crash report and symbolization to reduce
+    // output and avoid potentially slow symbolization.
+    setenv("LLVM_DISABLE_CRASH_REPORT", "1", 0);
+    setenv("LLVM_DISABLE_SYMBOLIZATION", "1", 0);
   }
 
   if (argc == 0)
Index: llvm/test/tools/not/disable-symbolization.test
===================================================================
--- /dev/null
+++ llvm/test/tools/not/disable-symbolization.test
@@ -0,0 +1,5 @@
+# RUN: not --crash env > %t || true
+# RUN: FileCheck %s < %t
+
+# CHECK-DAG: LLVM_DISABLE_CRASH_REPORT=1
+# CHECK-DAG: LLVM_DISABLE_SYMBOLIZATION=1
Index: llvm/lib/Support/Signals.cpp
===================================================================
--- llvm/lib/Support/Signals.cpp
+++ llvm/lib/Support/Signals.cpp
@@ -44,6 +44,8 @@
                          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 @@
 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.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D86170.286396.patch
Type: text/x-patch
Size: 1844 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200818/278f4012/attachment-0001.bin>