[compiler-rt] r286894 - [tsan] Add support for C++ exceptions into TSan (call __tsan_func_exit during unwinding), compiler-rt part

[Kuba Brecka via llvm-commits]

Author: kuba.brecka
Date: Mon Nov 14 15:41:33 2016
New Revision: 286894

URL: http://llvm.org/viewvc/llvm-project?rev=286894&view=rev
Log:
[tsan] Add support for C++ exceptions into TSan (call __tsan_func_exit during unwinding), compiler-rt part

This adds support for TSan C++ exception handling, where we need to add extra calls to __tsan_func_exit when a function is exitted via exception mechanisms. Otherwise the shadow stack gets corrupted (leaked). This patch moves and enhances the existing implementation of EscapeEnumerator that finds all possible function exit points, and adds extra EH cleanup blocks where needed.

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


Added:
    compiler-rt/trunk/test/tsan/exceptions.cc
Modified:
    compiler-rt/trunk/lib/tsan/rtl/tsan_rtl.cc
    compiler-rt/trunk/test/tsan/test.h

Modified: compiler-rt/trunk/lib/tsan/rtl/tsan_rtl.cc
URL: http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/lib/tsan/rtl/tsan_rtl.cc?rev=286894&r1=286893&r2=286894&view=diff
==============================================================================
--- compiler-rt/trunk/lib/tsan/rtl/tsan_rtl.cc (original)
+++ compiler-rt/trunk/lib/tsan/rtl/tsan_rtl.cc Mon Nov 14 15:41:33 2016
@@ -1002,6 +1002,14 @@ void ThreadIgnoreEnd(ThreadState *thr, u
   }
 }
 
+#if !SANITIZER_GO
+extern "C" SANITIZER_INTERFACE_ATTRIBUTE
+uptr __tsan_testonly_shadow_stack_current_size() {
+  ThreadState *thr = cur_thread();
+  return thr->shadow_stack_pos - thr->shadow_stack;
+}
+#endif
+
 void ThreadIgnoreSyncBegin(ThreadState *thr, uptr pc) {
   DPrintf("#%d: ThreadIgnoreSyncBegin\n", thr->tid);
   thr->ignore_sync++;

Added: compiler-rt/trunk/test/tsan/exceptions.cc
URL: http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/test/tsan/exceptions.cc?rev=286894&view=auto
==============================================================================
--- compiler-rt/trunk/test/tsan/exceptions.cc (added)
+++ compiler-rt/trunk/test/tsan/exceptions.cc Mon Nov 14 15:41:33 2016
@@ -0,0 +1,185 @@
+// RUN: %clangxx_tsan -O0 %s -o %t && %run %t 2>&1 | FileCheck %s
+// RUN: %clangxx_tsan -O1 %s -o %t && %run %t 2>&1 | FileCheck %s
+
+#include "test.h"
+#include <setjmp.h>
+
+__attribute__((noinline)) void throws_int() {
+  throw 42;
+}
+
+__attribute__((noinline)) void callee_throws() {
+  try {
+    throws_int();
+  } catch (int) {  // NOLINT
+    fprintf(stderr, "callee_throws caught exception\n");
+  }
+}
+
+__attribute__((noinline)) void throws_catches_rethrows() {
+  try {
+    throws_int();
+  } catch (int) {  // NOLINT
+    fprintf(stderr, "throws_catches_rethrows caught exception\n");
+    throw;
+  }
+}
+
+__attribute__((noinline)) void callee_rethrows() {
+  try {
+    throws_catches_rethrows();
+  } catch (int) {  // NOLINT
+    fprintf(stderr, "callee_rethrows caught exception\n");
+  }
+}
+
+__attribute__((noinline)) void throws_and_catches() {
+  try {
+    throws_int();
+  } catch (int) {  // NOLINT
+    fprintf(stderr, "throws_and_catches caught exception\n");
+  }
+}
+
+__attribute__((noinline)) void nested_try() {
+  try {
+    try {
+      throws_int();
+    } catch (double) {  // NOLINT
+      fprintf(stderr, "nested_try inner block caught exception\n");
+    }
+  } catch (int) {  // NOLINT
+    fprintf(stderr, "nested_try outer block caught exception\n");
+  }
+}
+
+__attribute__((noinline)) void nested_try2() {
+  try {
+    try {
+      throws_int();
+    } catch (int) {  // NOLINT
+      fprintf(stderr, "nested_try inner block caught exception\n");
+    }
+  } catch (double) {  // NOLINT
+    fprintf(stderr, "nested_try outer block caught exception\n");
+  }
+}
+
+class ClassWithDestructor {
+ public:
+  ClassWithDestructor() {
+    fprintf(stderr, "ClassWithDestructor\n");
+  }
+  ~ClassWithDestructor() {
+    fprintf(stderr, "~ClassWithDestructor\n");
+  }
+};
+
+__attribute__((noinline)) void local_object_then_throw() {
+  ClassWithDestructor obj;
+  throws_int();
+}
+
+__attribute__((noinline)) void cpp_object_with_destructor() {
+  try {
+    local_object_then_throw();
+  } catch (int) {  // NOLINT
+    fprintf(stderr, "cpp_object_with_destructor caught exception\n");
+  }
+}
+
+__attribute__((noinline)) void recursive_call(long n) {
+  if (n > 0) {
+    recursive_call(n - 1);
+  } else {
+    throws_int();
+  }
+}
+
+__attribute__((noinline)) void multiframe_unwind() {
+  try {
+    recursive_call(5);
+  } catch (int) {  // NOLINT
+    fprintf(stderr, "multiframe_unwind caught exception\n");
+  }
+}
+
+__attribute__((noinline)) void longjmp_unwind() {
+  jmp_buf env;
+  int i = setjmp(env);
+  if (i != 0) {
+    fprintf(stderr, "longjmp_unwind jumped\n");
+    return;
+  }
+
+  try {
+    longjmp(env, 42);
+  } catch (int) {  // NOLINT
+    fprintf(stderr, "longjmp_unwind caught exception\n");
+  }
+}
+
+__attribute__((noinline)) void recursive_call_longjmp(jmp_buf env, long n) {
+  if (n > 0) {
+    recursive_call_longjmp(env, n - 1);
+  } else {
+    longjmp(env, 42);
+  }
+}
+
+__attribute__((noinline)) void longjmp_unwind_multiple_frames() {
+  jmp_buf env;
+  int i = setjmp(env);
+  if (i != 0) {
+    fprintf(stderr, "longjmp_unwind_multiple_frames jumped\n");
+    return;
+  }
+
+  try {
+    recursive_call_longjmp(env, 5);
+  } catch (int) {  // NOLINT
+    fprintf(stderr, "longjmp_unwind_multiple_frames caught exception\n");
+  }
+}
+
+#define CHECK_SHADOW_STACK(val)                                                \
+  fprintf(stderr, (val == __tsan_testonly_shadow_stack_current_size()          \
+                       ? "OK.\n"                                               \
+                       : "Shadow stack leak!\n"));
+
+int main(int argc, const char * argv[]) {
+  fprintf(stderr, "Hello, World!\n");
+  unsigned long shadow_stack_size = __tsan_testonly_shadow_stack_current_size();
+
+  throws_and_catches();
+  CHECK_SHADOW_STACK(shadow_stack_size);
+
+  callee_throws();
+  CHECK_SHADOW_STACK(shadow_stack_size);
+
+  callee_rethrows();
+  CHECK_SHADOW_STACK(shadow_stack_size);
+
+  nested_try();
+  CHECK_SHADOW_STACK(shadow_stack_size);
+
+  nested_try2();
+  CHECK_SHADOW_STACK(shadow_stack_size);
+
+  cpp_object_with_destructor();
+  CHECK_SHADOW_STACK(shadow_stack_size);
+
+  multiframe_unwind();
+  CHECK_SHADOW_STACK(shadow_stack_size);
+
+  longjmp_unwind();
+  CHECK_SHADOW_STACK(shadow_stack_size);
+
+  longjmp_unwind_multiple_frames();
+  CHECK_SHADOW_STACK(shadow_stack_size);
+
+  return 0;
+}
+
+// CHECK: Hello, World!
+// CHECK-NOT: Shadow stack leak

Modified: compiler-rt/trunk/test/tsan/test.h
URL: http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/test/tsan/test.h?rev=286894&r1=286893&r2=286894&view=diff
==============================================================================
--- compiler-rt/trunk/test/tsan/test.h (original)
+++ compiler-rt/trunk/test/tsan/test.h Mon Nov 14 15:41:33 2016
@@ -23,6 +23,7 @@ extern "C" {
 void __tsan_testonly_barrier_init(invisible_barrier_t *barrier,
     unsigned count);
 void __tsan_testonly_barrier_wait(invisible_barrier_t *barrier);
+unsigned long __tsan_testonly_shadow_stack_current_size();
 #ifdef __cplusplus
 }
 #endif