[compiler-rt] r345110 - [hwasan] when printing a stack-related bugs, also print stack frame descriptions provided by the compiler

[Kostya Serebryany via llvm-commits]

Author: kcc
Date: Tue Oct 23 18:35:50 2018
New Revision: 345110

URL: http://llvm.org/viewvc/llvm-project?rev=345110&view=rev
Log:
[hwasan] when printing a stack-related bugs, also print stack frame descriptions provided by the compiler

Modified:
    compiler-rt/trunk/lib/hwasan/hwasan.cc
    compiler-rt/trunk/lib/hwasan/hwasan.h
    compiler-rt/trunk/lib/hwasan/hwasan_report.cc
    compiler-rt/trunk/test/hwasan/TestCases/stack-uar.c

Modified: compiler-rt/trunk/lib/hwasan/hwasan.cc
URL: http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/lib/hwasan/hwasan.cc?rev=345110&r1=345109&r2=345110&view=diff
==============================================================================
--- compiler-rt/trunk/lib/hwasan/hwasan.cc (original)
+++ compiler-rt/trunk/lib/hwasan/hwasan.cc Tue Oct 23 18:35:50 2018
@@ -225,15 +225,29 @@ struct FrameDescription {
   const char *Descr;
 };
 
+struct FrameDescriptionArray {
+  FrameDescription *beg, *end;
+};
+
+static InternalMmapVectorNoCtor<FrameDescriptionArray> AllFrames;
+
 void InitFrameDescriptors(uptr b, uptr e) {
   FrameDescription *beg = reinterpret_cast<FrameDescription *>(b);
   FrameDescription *end = reinterpret_cast<FrameDescription *>(e);
   // Must have at least one entry, which we can use for a linked list.
   CHECK_GE(end - beg, 1U);
-  if (Verbosity()) {
+  AllFrames.push_back({beg, end});
+  if (Verbosity())
     for (FrameDescription *frame_descr = beg; frame_descr < end; frame_descr++)
       Printf("Frame: %p %s\n", frame_descr->PC, frame_descr->Descr);
-  }
+}
+
+const char *GetStackFrameDescr(uptr pc) {
+  for (uptr i = 0, n = AllFrames.size(); i < n; i++)
+    for (auto p = AllFrames[i].beg; p < AllFrames[i].end; p++)
+      if (p->PC == pc)
+        return p->Descr;
+  return nullptr;
 }
 
 } // namespace __hwasan

Modified: compiler-rt/trunk/lib/hwasan/hwasan.h
URL: http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/lib/hwasan/hwasan.h?rev=345110&r1=345109&r2=345110&view=diff
==============================================================================
--- compiler-rt/trunk/lib/hwasan/hwasan.h (original)
+++ compiler-rt/trunk/lib/hwasan/hwasan.h Tue Oct 23 18:35:50 2018
@@ -93,6 +93,7 @@ void InstallTrapHandler();
 void InstallAtExitHandler();
 
 const char *GetStackOriginDescr(u32 id, uptr *pc);
+const char *GetStackFrameDescr(uptr pc);
 
 void EnterSymbolizer();
 void ExitSymbolizer();

Modified: compiler-rt/trunk/lib/hwasan/hwasan_report.cc
URL: http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/lib/hwasan/hwasan_report.cc?rev=345110&r1=345109&r2=345110&view=diff
==============================================================================
--- compiler-rt/trunk/lib/hwasan/hwasan_report.cc (original)
+++ compiler-rt/trunk/lib/hwasan/hwasan_report.cc Tue Oct 23 18:35:50 2018
@@ -204,11 +204,13 @@ void PrintAddressDescription(
         uptr pc_mask = (1ULL << 48) - 1;
         uptr pc = record & pc_mask;
         if (SymbolizedStack *frame = Symbolizer::GetOrInit()->SymbolizePC(pc)) {
-          frame_desc.append("  sp: 0x%zx pc: %p ", sp, pc);
+          frame_desc.append(" sp: 0x%zx pc: %p ", sp, pc);
           RenderFrame(&frame_desc, "in %f %s:%l\n", 0, frame->info,
                       common_flags()->symbolize_vs_style,
                       common_flags()->strip_path_prefix);
           frame->ClearAll();
+          if (auto Descr = GetStackFrameDescr(pc))
+            frame_desc.append("  %s\n", Descr);
         }
         Printf("%s", frame_desc.data());
         frame_desc.clear();

Modified: compiler-rt/trunk/test/hwasan/TestCases/stack-uar.c
URL: http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/test/hwasan/TestCases/stack-uar.c?rev=345110&r1=345109&r2=345110&view=diff
==============================================================================
--- compiler-rt/trunk/test/hwasan/TestCases/stack-uar.c (original)
+++ compiler-rt/trunk/test/hwasan/TestCases/stack-uar.c Tue Oct 23 18:35:50 2018
@@ -9,8 +9,8 @@ void USE(void *x) { // pretend_to_do_som
 
 __attribute__((noinline))
 char *buggy() {
-  char z[0x1000];
-  char *volatile p = z;
+  char zzz[0x1000];
+  char *volatile p = zzz;
   return p;
 }
 
@@ -29,9 +29,13 @@ int main() {
   // CHECK: is located in stack of thread
   // CHECK: Previosly allocated frames:
   // CHECK: Unrelated3
+  // CHECK: 16 CCC
   // CHECK: Unrelated2
+  // CHECK: 12 BB
   // CHECK: Unrelated1
+  // CHECK: 8 A
   // CHECK: buggy
+  // CHECK: 4096 zzz
 
   // CHECK: SUMMARY: HWAddressSanitizer: tag-mismatch {{.*}} in main
 }