[PATCH] [tsan] print error summary line

[Kostya Serebryany]

Hi dvyukov,

just like in asan. 
Here we can also tests the summary line with lit (since we use the in-process symbolizer)

http://llvm-reviews.chandlerc.com/D377

Files:
  sanitizer_common/sanitizer_common.cc
  tsan/lit_tests/thread_leak3.c
  tsan/lit_tests/simple_race.cc
  tsan/lit_tests/free_race.c
  tsan/lit_tests/signal_errno.cc
  tsan/lit_tests/mutex_destroy_locked.cc
  tsan/lit_tests/signal_malloc.cc
  tsan/rtl/tsan_report.cc

Index: sanitizer_common/sanitizer_common.cc
===================================================================
--- sanitizer_common/sanitizer_common.cc
+++ sanitizer_common/sanitizer_common.cc
@@ -196,7 +196,7 @@
                         int line, const char *function) {
   const int kMaxSize = 1024;  // We don't want a summary too long.
   InternalScopedBuffer<char> buff(kMaxSize);
-  internal_snprintf(buff.data(), kMaxSize, "%s %s %s:%d %s",
+  internal_snprintf(buff.data(), kMaxSize, "%s: %s %s:%d %s",
                     SanitizerToolName, error_type,
                     file, line, function);
   __sanitizer_report_error_summary(buff.data());
Index: tsan/lit_tests/thread_leak3.c
===================================================================
--- tsan/lit_tests/thread_leak3.c
+++ tsan/lit_tests/thread_leak3.c
@@ -12,3 +12,4 @@
 }
 
 // CHECK: WARNING: ThreadSanitizer: thread leak
+// CHECK: SUMMARY: ThreadSanitizer: thread leak{{.*}}main
Index: tsan/lit_tests/simple_race.cc
===================================================================
--- tsan/lit_tests/simple_race.cc
+++ tsan/lit_tests/simple_race.cc
@@ -23,3 +23,4 @@
 }
 
 // CHECK: WARNING: ThreadSanitizer: data race
+// CHECK: SUMMARY: ThreadSanitizer: data race{{.*}}Thread
Index: tsan/lit_tests/free_race.c
===================================================================
--- tsan/lit_tests/free_race.c
+++ tsan/lit_tests/free_race.c
@@ -41,3 +41,4 @@
 // CHECK:   Previous write of size 8 at {{.*}} by thread T1{{.*}}:
 // CHECK:     #0 free
 // CHECK:     #{{(1|2)}} Thread1
+// CHECK: SUMMARY: ThreadSanitizer: heap-use-after-free{{.*}}Thread2
Index: tsan/lit_tests/signal_errno.cc
===================================================================
--- tsan/lit_tests/signal_errno.cc
+++ tsan/lit_tests/signal_errno.cc
@@ -10,7 +10,7 @@
 pthread_t mainth;
 volatile int done;
 
-static void handler(int, siginfo_t *s, void *c) {
+static void MyHandler(int, siginfo_t *s, void *c) {
   errno = 1;
   done = 1;
 }
@@ -23,7 +23,7 @@
 int main() {
   mainth = pthread_self();
   struct sigaction act = {};
-  act.sa_sigaction = &handler;
+  act.sa_sigaction = &MyHandler;
   sigaction(SIGPROF, &act, 0);
   pthread_t th;
   pthread_create(&th, 0, sendsignal, 0);
@@ -38,5 +38,6 @@
 }
 
 // CHECK: WARNING: ThreadSanitizer: signal handler spoils errno
-// CHECK:     #0 handler(int, siginfo{{(_t)?}}*, void*) {{.*}}signal_errno.cc
+// CHECK:     #0 MyHandler(int, siginfo{{(_t)?}}*, void*) {{.*}}signal_errno.cc
+// CHECK: SUMMARY: ThreadSanitizer: signal handler spoils errno{{.*}}MyHandler
 
Index: tsan/lit_tests/mutex_destroy_locked.cc
===================================================================
--- tsan/lit_tests/mutex_destroy_locked.cc
+++ tsan/lit_tests/mutex_destroy_locked.cc
@@ -19,3 +19,4 @@
 // CHECK:   Mutex {{.*}} created at:
 // CHECK:     #0 pthread_mutex_init
 // CHECK:     #1 main
+// CHECK: SUMMARY: ThreadSanitizer: destroy of a locked mutex{{.*}}main
Index: tsan/lit_tests/signal_malloc.cc
===================================================================
--- tsan/lit_tests/signal_malloc.cc
+++ tsan/lit_tests/signal_malloc.cc
@@ -8,7 +8,8 @@
 static void handler(int, siginfo_t*, void*) {
   // CHECK: WARNING: ThreadSanitizer: signal-unsafe call inside of a signal
   // CHECK:     #0 malloc
-  // CHECK:     #{{(1|2)}} handler(int, siginfo{{(_t)?}}*, void*) {{.*}}signal_malloc.cc:[[@LINE+1]]
+  // CHECK:     #{{(1|2)}} handler(int, siginfo{{(_t)?}}*, void*) {{.*}}signal_malloc.cc:[[@LINE+2]]
+  // CHECK: SUMMARY: ThreadSanitizer: signal-unsafe call inside of a signal{{.*}}handler
   volatile char *p = (char*)malloc(1);
   p[0] = 0;
   free((void*)p);
Index: tsan/rtl/tsan_report.cc
===================================================================
--- tsan/rtl/tsan_report.cc
+++ tsan/rtl/tsan_report.cc
@@ -43,23 +43,20 @@
   return buf;
 }
 
-static void PrintHeader(ReportType typ) {
-  Printf("WARNING: ThreadSanitizer: ");
-
+static const char *ReportTypeString(ReportType typ) {
   if (typ == ReportTypeRace)
-    Printf("data race");
-  else if (typ == ReportTypeUseAfterFree)
-    Printf("heap-use-after-free");
-  else if (typ == ReportTypeThreadLeak)
-    Printf("thread leak");
-  else if (typ == ReportTypeMutexDestroyLocked)
-    Printf("destroy of a locked mutex");
-  else if (typ == ReportTypeSignalUnsafe)
-    Printf("signal-unsafe call inside of a signal");
-  else if (typ == ReportTypeErrnoInSignal)
-    Printf("signal handler spoils errno");
-
-  Printf(" (pid=%d)\n", GetPid());
+    return "data race";
+  if (typ == ReportTypeUseAfterFree)
+    return "heap-use-after-free";
+  if (typ == ReportTypeThreadLeak)
+    return "thread leak";
+  if (typ == ReportTypeMutexDestroyLocked)
+    return "destroy of a locked mutex";
+  if (typ == ReportTypeSignalUnsafe)
+    return "signal-unsafe call inside of a signal";
+  if (typ == ReportTypeErrnoInSignal)
+    return "signal handler spoils errno";
+  return "";
 }
 
 void PrintStack(const ReportStack *ent) {
@@ -158,9 +155,28 @@
   PrintStack(s);
 }
 
+static ReportStack *ChooseSummaryStack(const ReportDesc *rep) {
+  if (rep->mops.Size())
+    return rep->mops[0]->stack;
+  if (rep->stacks.Size())
+    return rep->stacks[0];
+  if (rep->mutexes.Size())
+    return rep->mutexes[0]->stack;
+  if (rep->threads.Size())
+    return rep->threads[0]->stack;
+  return 0;
+}
+
+static ReportStack *SkipTsanInternalFrame(ReportStack *ent) {
+  if (ent && ent->next && internal_strstr(ent->file, "tsan/rtl/"))
+    return ent->next;
+  return ent;
+}
+
 void PrintReport(const ReportDesc *rep) {
   Printf("==================\n");
-  PrintHeader(rep->typ);
+  const char *rep_typ_str = ReportTypeString(rep->typ);
+  Printf("WARNING: ThreadSanitizer: %s (pid=%d)\n", rep_typ_str, GetPid());
 
   for (uptr i = 0; i < rep->stacks.Size(); i++) {
     if (i)
@@ -183,6 +199,9 @@
   for (uptr i = 0; i < rep->threads.Size(); i++)
     PrintThread(rep->threads[i]);
 
+  if (ReportStack *ent = SkipTsanInternalFrame(ChooseSummaryStack(rep)))
+    ReportErrorSummary(rep_typ_str, ent->file, ent->line, ent->func);
+
   Printf("==================\n");
 }
-------------- next part --------------
A non-text attachment was scrubbed...
Name: D377.1.patch
Type: text/x-patch
Size: 6162 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20130206/ad8c4bb4/attachment.bin>