[MSan] Implement __sanitizer_print_stack_trace().

[samsonov]

test/msan/print-stack-trace.cc

1 ↗

(On Diff #9766)

This test should go to test/sanitizer_common/TestCases (and remove the same test case from ASan suite).

[eugenis]

LGTM w/ nit

test/msan/print-stack-trace.cc

1 ↗

(On Diff #9766)

And when you do that, beware that on Mac (I think) stack trace line for main may have () after the function name. Or maybe not. Anyway, it's better to remove the space after main and before .*

[earthdok]

• move test to common

[earthdok]

Committed r209625

lib/msan/msan.h

 
 #define GET_STORE_STACK_TRACE_PC_BP(pc, bp)                            \
   StackTrace stack;                                                    \
   stack.size = 0;                                                      \
   if (__msan_get_track_origins() > 1 && msan_inited)                   \
     GetStackTrace(&stack, common_flags()->malloc_context_size, pc, bp, \
                   common_flags()->fast_unwind_on_malloc)
 
+#define GET_FATAL_STACK_TRACE_PC_BP(pc, bp)       \
+  StackTrace stack;                               \
+  stack.size = 0;                                 \
+  if (msan_inited)                                \
+    GetStackTrace(&stack, kStackTraceMax, pc, bp, \
+                  common_flags()->fast_unwind_on_fatal)
+
 #define GET_STORE_STACK_TRACE \
   GET_STORE_STACK_TRACE_PC_BP(StackTrace::GetCurrentPc(), GET_CURRENT_FRAME())
 
 class ScopedThreadLocalStateBackup {
  public:
   ScopedThreadLocalStateBackup() { Backup(); }
   ~ScopedThreadLocalStateBackup() { Restore(); }
   void Backup();

lib/msan/msan.cc

if (msan_expect_umr) {
     // Printf("Expected UMR\n");
     __msan_origin_tls = origin;
     msan_expected_umr_found = 1;
     return;
   }
 
   ++msan_report_count;
 
-  StackTrace stack;
-  GetStackTrace(&stack, kStackTraceMax, pc, bp,
-                common_flags()->fast_unwind_on_fatal);
+  GET_FATAL_STACK_TRACE_PC_BP(pc, bp);
 
   u32 report_origin =
     (__msan_get_track_origins() && OriginIsValid(origin)) ? origin : 0;
   ReportUMR(&stack, report_origin);
 
   if (__msan_get_track_origins() && !OriginIsValid(origin)) {
     Printf(
         "  ORIGIN: invalid (%x). Might be a bug in MemorySanitizer origin "

 }
 
 void __msan_set_expect_umr(int expect_umr) {
   if (expect_umr) {
     msan_expected_umr_found = 0;
   } else if (!msan_expected_umr_found) {
     GET_CALLER_PC_BP_SP;
     (void)sp;
-    StackTrace stack;
-    GetStackTrace(&stack, kStackTraceMax, pc, bp,
-                  common_flags()->fast_unwind_on_fatal);
+    GET_FATAL_STACK_TRACE_PC_BP(pc, bp);
     ReportExpectedUMRNotFound(&stack);
     Die();
   }
   msan_expect_umr = expect_umr;
 }
 
 void __msan_print_shadow(const void *x, uptr size) {
   if (!MEM_IS_APP(x)) {

 }
 
 #if !SANITIZER_SUPPORTS_WEAK_HOOKS
 extern "C" {
 SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
 const char* __msan_default_options() { return ""; }
 }  // extern "C"
 #endif
+
+extern "C" {
+SANITIZER_INTERFACE_ATTRIBUTE
+void __sanitizer_print_stack_trace() {
+  GET_FATAL_STACK_TRACE_PC_BP(StackTrace::GetCurrentPc(), GET_CURRENT_FRAME());
+  stack.Print();
+}
+}  // extern "C"

test/asan/TestCases/print-stack-trace.cc

-// RUN: %clangxx_asan -O0 %s -o %t && %run %t 2>&1 | FileCheck %s
-// RUN: %clangxx_asan -O3 %s -o %t && %run %t 2>&1 | FileCheck %s
-
-#include <sanitizer/asan_interface.h>
-
-void FooBarBaz() {
-  __sanitizer_print_stack_trace();
-}
-
-int main() {
-  FooBarBaz();
-  return 0;
-}
-// CHECK: {{    #0 0x.* in __sanitizer_print_stack_trace}}
-// CHECK: {{    #1 0x.* in FooBarBaz\(\) .*print-stack-trace.cc:7}}
-// CHECK: {{    #2 0x.* in main .*print-stack-trace.cc:11}}

test/sanitizer_common/TestCases/print-stack-trace.cc

+// RUN: %clangxx -O0 %s -o %t && %run %t 2>&1 | FileCheck %s
+// RUN: %clangxx -O3 %s -o %t && %run %t 2>&1 | FileCheck %s
+//
+// Not yet implemented for TSan.
+// https://code.google.com/p/address-sanitizer/issues/detail?id=243
+// XFAIL: tsan
+
+#include <sanitizer/common_interface_defs.h>
+
+void FooBarBaz() {
+  __sanitizer_print_stack_trace();
+}
+
+int main() {
+  FooBarBaz();
+  return 0;
+}
+// CHECK: {{    #0 0x.* in __sanitizer_print_stack_trace}}
+// CHECK: {{    #1 0x.* in FooBarBaz\(\) .*print-stack-trace.cc:11}}
+// CHECK: {{    #2 0x.* in main.*print-stack-trace.cc:15}}

test/sanitizer_common/lit.common.cfg

 # -*- Python -*-
 
 # Setup source root.
 config.test_source_root = os.path.join(os.path.dirname(__file__), "TestCases")
 
 config.name = "SanitizerCommon-" + config.tool_name
 
 if config.tool_name == "asan":
   tool_cflags = ["-fsanitize=address"]
 elif config.tool_name == "tsan":
   tool_cflags = ["-fsanitize=thread"]
 elif config.tool_name == "msan":
   tool_cflags = ["-fsanitize=memory"]
 else:
   lit_config.fatal("Unknown tool for sanitizer_common tests: %r" % config.tool_name)
 
+config.available_features.add(config.tool_name)
+
 clang_cflags = ["-g"] + tool_cflags + [config.target_cflags]
 clang_cxxflags = config.cxx_mode_flags + clang_cflags
 
 def build_invocation(compile_flags):
   return " " + " ".join([config.clang] + compile_flags) + " "
 
 config.substitutions.append( ("%clang ", build_invocation(clang_cflags)) )
 config.substitutions.append( ("%clangxx ", build_invocation(clang_cxxflags)) )
 
 config.suffixes = ['.c', '.cc', '.cpp']
 
 if config.host_os not in ['Linux', 'Darwin']:
   config.unsupported = True