commit 502049219c5ff79800f1594b8afbfc8f3ed505f9
author Enna1 <xumingjie.enna1@bytedance.com> Sat Oct 08 09:55:40 2022 +0800
committer Copybara-Service <copybara-worker@google.com> Fri Oct 07 19:21:27 2022 -0700
tree 8f00aa2a641fa467fdb2700d80d6901e2056eee8
parent a4fca0c923d613975d544e84c2aa9e59da25858b

[memprof] dump memprof profile when receive deadly signals

Currently memprof profile is dumped when program exits (call `FinishAndWrite()` in ~Allocator) or `__memprof_profile_dump` is manually called.
For programs that never exit (e.g. server-side application), it will be useful to dump memprof profile when specific signal is received.
This patch installs a signal handler for deadly signals(SIGSEGV, SIGBUS, SIGABRT, SIGILL, SIGTRAP, SIGFPE) like we do in other sanitizers. In the signal handler `__memprof_profile_dump` is called to dump memprof profile.

Reviewed By: tejohnson

Differential Revision: https://reviews.llvm.org/D134795

GitOrigin-RevId: 9e80add2cfa9bb03bbe77cca9adec18137204538

lib/memprof/memprof_rtl.cpp

diff --git a/lib/memprof/memprof_rtl.cpp b/lib/memprof/memprof_rtl.cpp
index d568a07..d30b803 100644
--- a/lib/memprof/memprof_rtl.cpp
+++ b/lib/memprof/memprof_rtl.cpp
@@ -50,6 +50,14 @@
   }
 }
 
+static void MemprofOnDeadlySignal(int signo, void *siginfo, void *context) {
+  // We call StartReportDeadlySignal not HandleDeadlySignal so we get the
+  // deadly signal message to stderr but no writing to the profile output file
+  StartReportDeadlySignal();
+  __memprof_profile_dump();
+  Die();
+}
+
 static void CheckUnwind() {
   GET_STACK_TRACE(kStackTraceMax, common_flags()->fast_unwind_on_check);
   stack.Print();
@@ -183,6 +191,7 @@
   InitializeShadowMemory();
 
   TSDInit(PlatformTSDDtor);
+  InstallDeadlySignalHandlers(MemprofOnDeadlySignal);
 
   InitializeAllocator();
 

test/memprof/TestCases/memprof_profile_dump_on_abort.cpp

diff --git a/test/memprof/TestCases/memprof_profile_dump_on_abort.cpp b/test/memprof/TestCases/memprof_profile_dump_on_abort.cpp
new file mode 100644
index 0000000..5df611b
--- /dev/null
+++ b/test/memprof/TestCases/memprof_profile_dump_on_abort.cpp
@@ -0,0 +1,18 @@
+// RUN: %clangxx_memprof %s -o %t
+
+// RUN: %env_memprof_opts=print_text=true:log_path=stdout:handle_abort=1 not %run %t 2>&1 | FileCheck --check-prefix=CHECK-TEXT %s
+
+#include <stdlib.h>
+#include <string.h>
+int main(int argc, char **argv) {
+  char *x = (char *)malloc(10);
+  memset(x, 0, 10);
+  free(x);
+  abort();
+  return 0;
+}
+
+// CHECK-TEXT: MemProfiler:DEADLYSIGNAL
+// CHECK-TEXT: Recorded MIBs (incl. live on exit):
+// CHECK-TEXT: Memory allocation stack id
+// CHECK-TEXT: Stack for id