[lldb] Provide API to know which sanitizer generated an eStopReasonInstrumentation

[kubamracek]

Summary

We can provide this via StopReason->GetValue(). This is important so that users of SB API can treat various sanitizers differently (the extended stop reason data is also structured differently for different sanitizers).

[clayborg]

I am fine as long is Jim Ingham is fine. Jim, if you are good with this, just put it into Accept Revision.

[kubamracek]

@jingham ping

[jingham]

Aargh, sorry. My queue is overflowing... I had one tiny comment about the tests. If you do that, then it will be fine to go in.

packages/Python/lldbsuite/test/functionalities/asan/TestMemoryHistory.py

126–132

Can you add a check that GetStopReasonDataCount and only do the check for GetStopReasonDataAtIndex if this is 1? We have the ability to run the testsuite against older lldb's and it's good not to add failures if it can be avoided. Plus it's good to check that that call is returning a reasonable value.

packages/Python/lldbsuite/test/functionalities/asan/TestReportData.py

65–67

Same comment as above.

packages/Python/lldbsuite/test/functionalities/tsan/basic/TestTsanBasic.py

57–59

Same comment as above.

[kubamracek]

Addressing review comments.

[kubamracek]

ping

[clayborg]

Looks fine to me, make sure Jim is happy as well.

[jingham]

Sorry for the delay. That's fine.

include/lldb/API/SBThread.h

public:
 
   //--------------------------------------------------------------------------
   /// Get information associated with a stop reason.
   ///
   /// Breakpoint stop reasons will have data that consists of pairs of
   /// breakpoint IDs followed by the breakpoint location IDs (they always come
   /// in pairs).
   ///
-  /// Stop Reason              Count Data Type
-  /// ======================== ===== =========================================
-  /// eStopReasonNone          0
-  /// eStopReasonTrace         0
-  /// eStopReasonBreakpoint    N     duple: {breakpoint id, location id}
-  /// eStopReasonWatchpoint    1     watchpoint id
-  /// eStopReasonSignal        1     unix signal number
-  /// eStopReasonException     N     exception data
-  /// eStopReasonExec          0
-  /// eStopReasonPlanComplete  0
+  /// Stop Reason                Count Data Type
+  /// ========================== ===== =======================================
+  /// eStopReasonNone            0
+  /// eStopReasonTrace           0
+  /// eStopReasonBreakpoint      N     duple: {breakpoint id, location id}
+  /// eStopReasonWatchpoint      1     watchpoint id
+  /// eStopReasonSignal          1     unix signal number
+  /// eStopReasonException       N     exception data
+  /// eStopReasonExec            0
+  /// eStopReasonPlanComplete    0
+  /// eStopReasonInstrumentation 1     InstrumentationRuntimeType value
   //--------------------------------------------------------------------------
   uint64_t GetStopReasonDataAtIndex(uint32_t idx);
 
   bool GetStopReasonExtendedInfoAsJSON(lldb::SBStream &stream);
 
   SBThreadCollection
   GetStopReasonExtendedBacktraces(InstrumentationRuntimeType type);
 

include/lldb/API/SBThreadPlan.h

public:
 
   //--------------------------------------------------------------------------
   /// Get information associated with a stop reason.
   ///
   /// Breakpoint stop reasons will have data that consists of pairs of
   /// breakpoint IDs followed by the breakpoint location IDs (they always come
   /// in pairs).
   ///
-  /// Stop Reason              Count Data Type
-  /// ======================== ===== =========================================
-  /// eStopReasonNone          0
-  /// eStopReasonTrace         0
-  /// eStopReasonBreakpoint    N     duple: {breakpoint id, location id}
-  /// eStopReasonWatchpoint    1     watchpoint id
-  /// eStopReasonSignal        1     unix signal number
-  /// eStopReasonException     N     exception data
-  /// eStopReasonExec          0
-  /// eStopReasonPlanComplete  0
+  /// Stop Reason                Count Data Type
+  /// ========================== ===== =======================================
+  /// eStopReasonNone            0
+  /// eStopReasonTrace           0
+  /// eStopReasonBreakpoint      N     duple: {breakpoint id, location id}
+  /// eStopReasonWatchpoint      1     watchpoint id
+  /// eStopReasonSignal          1     unix signal number
+  /// eStopReasonException       N     exception data
+  /// eStopReasonExec            0
+  /// eStopReasonPlanComplete    0
+  /// eStopReasonInstrumentation 1     InstrumentationRuntimeType value
   //--------------------------------------------------------------------------
   uint64_t GetStopReasonDataAtIndex(uint32_t idx);
 
   SBThread GetThread() const;
 
   const lldb::SBThreadPlan &operator=(const lldb::SBThreadPlan &rhs);
 
   bool GetDescription(lldb::SBStream &description) const;

include/lldb/Target/InstrumentationRuntimeStopInfo.h

lldb::StopReason GetStopReason() const override {
     return lldb::eStopReasonInstrumentation;
   }
 
   const char *GetDescription() override;
 
   bool DoShouldNotify(Event *event_ptr) override { return true; }
 
   static lldb::StopInfoSP CreateStopReasonWithInstrumentationData(
-      Thread &thread, std::string description,
-      StructuredData::ObjectSP additional_data);
+      Thread &thread, lldb::InstrumentationRuntimeType type,
+      std::string description, StructuredData::ObjectSP additional_data);
 
 private:
-  InstrumentationRuntimeStopInfo(Thread &thread, std::string description,
+  InstrumentationRuntimeStopInfo(Thread &thread,
+                                 lldb::InstrumentationRuntimeType type,
+                                 std::string description,
                                  StructuredData::ObjectSP additional_data);
 };
 
 } // namespace lldb_private
 
 #endif // liblldb_InstrumentationRuntimeStopInfo_h_

include/lldb/Target/StopInfo.h

public:
 
   // The value of the StopInfo depends on the StopReason.
   // StopReason                  Meaning
   // ----------------------------------------------
   // eStopReasonBreakpoint       BreakpointSiteID
   // eStopReasonSignal           Signal number
   // eStopReasonWatchpoint       WatchpointLocationID
   // eStopReasonPlanComplete     No significance
+  // eStopReasonInstrumentation  InstrumentationRuntimeType value
 
   uint64_t GetValue() const { return m_value; }
 
   virtual lldb::StopReason GetStopReason() const = 0;
 
   // ShouldStopSynchronous will get called before any thread plans are
   // consulted, and if it says we should
   // resume the target, then we will just immediately resume.  This should not

packages/Python/lldbsuite/test/functionalities/asan/TestMemoryHistory.py

def asan_tests(self):
 
         self.expect(
             "thread list",
             "Process should be stopped due to ASan report",
             substrs=[
                 'stopped',
                 'stop reason = Use of deallocated memory'])
 
+        self.assertEqual(
+            process.GetSelectedThread().GetStopReason(),
+            lldb.eStopReasonInstrumentation)
+        self.assertEqual(
+            process.GetSelectedThread().GetStopReasonDataAtIndex(0),
+            lldb.eInstrumentationRuntimeTypeAddressSanitizer)
+
         # make sure the 'memory history' command still works even when we're
         # generating a report now
         self.expect(
             "memory history 'another_pointer'",
             substrs=[
                 'Memory allocated by Thread',
                 'a.out`f1',
                 'main.c:%d' %
                 self.line_malloc2])

packages/Python/lldbsuite/test/functionalities/asan/TestReportData.py

def asan_tests(self):
 
         self.expect(
             "thread list",
             "Process should be stopped due to ASan report",
             substrs=[
                 'stopped',
                 'stop reason = Use of deallocated memory'])
 
+        process = self.dbg.GetSelectedTarget().process
         self.assertEqual(
-            self.dbg.GetSelectedTarget().process.GetSelectedThread().GetStopReason(),
+            process.GetSelectedThread().GetStopReason(),
             lldb.eStopReasonInstrumentation)
+        self.assertEqual(process.
+            GetSelectedThread().GetStopReasonDataAtIndex(0),
+            lldb.eInstrumentationRuntimeTypeAddressSanitizer)
 
         self.expect("bt", "The backtrace should show the crashing line",
                     substrs=['main.c:%d' % self.line_crash])
 
         self.expect(
             "thread info -s",
             "The extended stop info should contain the ASan provided fields",
             substrs=[

packages/Python/lldbsuite/test/functionalities/tsan/basic/TestTsanBasic.py

def tsan_tests(self):
             # On OS X 10.10 and older, we need to re-exec to enable
             # interceptors.
             self.runCmd("continue")
 
         # the stop reason of the thread should be breakpoint.
         self.expect("thread list", "A data race should be detected",
                     substrs=['stopped', 'stop reason = Data race detected'])
 
+        process = self.dbg.GetSelectedTarget().process
         self.assertEqual(
-            self.dbg.GetSelectedTarget().process.GetSelectedThread().GetStopReason(),
+            process.GetSelectedThread().GetStopReason(),
             lldb.eStopReasonInstrumentation)
+        self.assertEqual(
+            process.GetSelectedThread().GetStopReasonDataAtIndex(0),
+            lldb.eInstrumentationRuntimeTypeThreadSanitizer)
 
         # test that the TSan dylib is present
         self.expect(
             "image lookup -n __tsan_get_current_report",
             "__tsan_get_current_report should be present",
             substrs=['1 match found'])
 
         # We should be stopped in __tsan_on_report
-        process = self.dbg.GetSelectedTarget().process
         thread = process.GetSelectedThread()
         frame = thread.GetSelectedFrame()
         self.assertTrue("__tsan_on_report" in frame.GetFunctionName())
 
         # The stopped thread backtrace should contain either line1 or line2
         # from main.c.
         found = False
         for i in range(0, thread.GetNumFrames()):

scripts/interface/SBThread.i

~SBThread();
     %feature("docstring", "
     //--------------------------------------------------------------------------
     /// Get information associated with a stop reason.
     ///
     /// Breakpoint stop reasons will have data that consists of pairs of 
     /// breakpoint IDs followed by the breakpoint location IDs (they always come
     /// in pairs).
     ///
-    /// Stop Reason              Count Data Type
-    /// ======================== ===== =========================================
-    /// eStopReasonNone          0
-    /// eStopReasonTrace         0
-    /// eStopReasonBreakpoint    N     duple: {breakpoint id, location id}
-    /// eStopReasonWatchpoint    1     watchpoint id
-    /// eStopReasonSignal        1     unix signal number
-    /// eStopReasonException     N     exception data
-    /// eStopReasonExec          0
-    /// eStopReasonPlanComplete  0
+    /// Stop Reason                Count Data Type
+    /// ========================== ===== =======================================
+    /// eStopReasonNone            0
+    /// eStopReasonTrace           0
+    /// eStopReasonBreakpoint      N     duple: {breakpoint id, location id}
+    /// eStopReasonWatchpoint      1     watchpoint id
+    /// eStopReasonSignal          1     unix signal number
+    /// eStopReasonException       N     exception data
+    /// eStopReasonExec            0
+    /// eStopReasonPlanComplete    0
+    /// eStopReasonInstrumentation 1     InstrumentationRuntimeType value
     //--------------------------------------------------------------------------
     ") GetStopReasonDataAtIndex;
     uint64_t
     GetStopReasonDataAtIndex(uint32_t idx);
         
     %feature("autodoc", "
     Collects a thread's stop reason extended information dictionary and prints it
     into the SBStream in a JSON format. The format of this JSON dictionary depends

scripts/interface/SBThreadPlan.i

~SBThreadPlan ();
 
     //--------------------------------------------------------------------------
     /// Get information associated with a stop reason.
     ///
     /// Breakpoint stop reasons will have data that consists of pairs of 
     /// breakpoint IDs followed by the breakpoint location IDs (they always come
     /// in pairs).
     ///
-    /// Stop Reason              Count Data Type
-    /// ======================== ===== =========================================
-    /// eStopReasonNone          0
-    /// eStopReasonTrace         0
-    /// eStopReasonBreakpoint    N     duple: {breakpoint id, location id}
-    /// eStopReasonWatchpoint    1     watchpoint id
-    /// eStopReasonSignal        1     unix signal number
-    /// eStopReasonException     N     exception data
-    /// eStopReasonExec          0
-    /// eStopReasonPlanComplete  0
+    /// Stop Reason                Count Data Type
+    /// ========================== ===== =======================================
+    /// eStopReasonNone            0
+    /// eStopReasonTrace           0
+    /// eStopReasonBreakpoint      N     duple: {breakpoint id, location id}
+    /// eStopReasonWatchpoint      1     watchpoint id
+    /// eStopReasonSignal          1     unix signal number
+    /// eStopReasonException       N     exception data
+    /// eStopReasonExec            0
+    /// eStopReasonPlanComplete    0
+    /// eStopReasonInstrumentation 1     InstrumentationRuntimeType value
     //--------------------------------------------------------------------------
     uint64_t
     GetStopReasonDataAtIndex(uint32_t idx);
 
     SBThread
     GetThread () const;
 
     bool

source/API/SBThread.cpp

if (stop_locker.TryLock(&exe_ctx.GetProcessPtr()->GetRunLock())) {
         StopReason reason = stop_info_sp->GetStopReason();
         switch (reason) {
         case eStopReasonInvalid:
         case eStopReasonNone:
         case eStopReasonTrace:
         case eStopReasonExec:
         case eStopReasonPlanComplete:
         case eStopReasonThreadExiting:
-        case eStopReasonInstrumentation:
           // There is no data for these stop reasons.
           return 0;
 
         case eStopReasonBreakpoint: {
           break_id_t site_id = stop_info_sp->GetValue();
           lldb::BreakpointSiteSP bp_site_sp(
               exe_ctx.GetProcessPtr()->GetBreakpointSiteList().FindByID(
                   site_id));
           if (bp_site_sp)
             return bp_site_sp->GetNumberOfOwners() * 2;
           else
             return 0; // Breakpoint must have cleared itself...
         } break;
 
         case eStopReasonWatchpoint:
           return 1;
 
         case eStopReasonSignal:
           return 1;
 
         case eStopReasonException:
           return 1;
+
+        case eStopReasonInstrumentation:
+          return 1;
         }
       }
     } else {
       Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
       if (log)
         log->Printf("SBThread(%p)::GetStopReasonDataCount() => error: process "
                     "is running",
                     static_cast<void *>(exe_ctx.GetThreadPtr()));
if (stop_locker.TryLock(&exe_ctx.GetProcessPtr()->GetRunLock())) {
         StopReason reason = stop_info_sp->GetStopReason();
         switch (reason) {
         case eStopReasonInvalid:
         case eStopReasonNone:
         case eStopReasonTrace:
         case eStopReasonExec:
         case eStopReasonPlanComplete:
         case eStopReasonThreadExiting:
-        case eStopReasonInstrumentation:
           // There is no data for these stop reasons.
           return 0;
 
         case eStopReasonBreakpoint: {
           break_id_t site_id = stop_info_sp->GetValue();
           lldb::BreakpointSiteSP bp_site_sp(
               exe_ctx.GetProcessPtr()->GetBreakpointSiteList().FindByID(
                   site_id));
if (stop_locker.TryLock(&exe_ctx.GetProcessPtr()->GetRunLock())) {
         case eStopReasonWatchpoint:
           return stop_info_sp->GetValue();
 
         case eStopReasonSignal:
           return stop_info_sp->GetValue();
 
         case eStopReasonException:
           return stop_info_sp->GetValue();
+
+        case eStopReasonInstrumentation:
+          return stop_info_sp->GetValue();
         }
       }
     } else {
       Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
       if (log)
         log->Printf("SBThread(%p)::GetStopReasonDataAtIndex() => error: "
                     "process is running",
                     static_cast<void *>(exe_ctx.GetThreadPtr()));

source/Plugins/InstrumentationRuntime/AddressSanitizer/AddressSanitizerRuntime.cpp

bool AddressSanitizerRuntime::NotifyBreakpointHit(
   if (report) {
     description = instance->FormatDescription(report);
   }
   ProcessSP process_sp = instance->GetProcessSP();
   // Make sure this is the right process
   if (process_sp && process_sp == context->exe_ctx_ref.GetProcessSP()) {
     ThreadSP thread_sp = context->exe_ctx_ref.GetThreadSP();
     if (thread_sp)
-      thread_sp->SetStopInfo(InstrumentationRuntimeStopInfo::
-                                 CreateStopReasonWithInstrumentationData(
-                                     *thread_sp, description, report));
+      thread_sp->SetStopInfo(
+          InstrumentationRuntimeStopInfo::
+                  *thread_sp, eInstrumentationRuntimeTypeAddressSanitizer,
+                  description, report));
 
     StreamFileSP stream_sp(
         process_sp->GetTarget().GetDebugger().GetOutputFile());
     if (stream_sp) {
       stream_sp->Printf("AddressSanitizer report breakpoint hit. Use 'thread "
                         "info -s' to get extended information about the "
                         "report.\n");
     }

source/Plugins/InstrumentationRuntime/ThreadSanitizer/ThreadSanitizerRuntime.cpp

bool ThreadSanitizerRuntime::NotifyBreakpointHit(
   ProcessSP process_sp = instance->GetProcessSP();
   // Make sure this is the right process
   if (process_sp && process_sp == context->exe_ctx_ref.GetProcessSP()) {
     ThreadSP thread_sp = context->exe_ctx_ref.GetThreadSP();
     if (thread_sp)
       thread_sp->SetStopInfo(
           InstrumentationRuntimeStopInfo::
               CreateStopReasonWithInstrumentationData(
-                  *thread_sp, stop_reason_description, report));
+                  *thread_sp, eInstrumentationRuntimeTypeThreadSanitizer,
+                  stop_reason_description, report));
 
     StreamFileSP stream_sp(
         process_sp->GetTarget().GetDebugger().GetOutputFile());
     if (stream_sp) {
       stream_sp->Printf("ThreadSanitizer report breakpoint hit. Use 'thread "
                         "info -s' to get extended information about the "
                         "report.\n");
     }

source/Target/InstrumentationRuntimeStopInfo.cpp

 #include "lldb/Target/InstrumentationRuntime.h"
 #include "lldb/Target/Process.h"
 #include "lldb/lldb-private.h"
 
 using namespace lldb;
 using namespace lldb_private;
 
 InstrumentationRuntimeStopInfo::InstrumentationRuntimeStopInfo(
-    Thread &thread, std::string description,
+    Thread &thread, InstrumentationRuntimeType type, std::string description,
     StructuredData::ObjectSP additional_data)
-    : StopInfo(thread, 0) {
+    : StopInfo(thread, type) {
   m_extended_info = additional_data;
   m_description = description;
 }
 
 const char *InstrumentationRuntimeStopInfo::GetDescription() {
   return m_description.c_str();
 }
 
 StopInfoSP
 InstrumentationRuntimeStopInfo::CreateStopReasonWithInstrumentationData(
-    Thread &thread, std::string description,
+    Thread &thread, InstrumentationRuntimeType type, std::string description,
     StructuredData::ObjectSP additionalData) {
   return StopInfoSP(
-      new InstrumentationRuntimeStopInfo(thread, description, additionalData));
+      new InstrumentationRuntimeStopInfo(thread, type, description, additionalData));
 }