Expose hit count via SBBreakpointLocation.

[brucem]

Summary

SBBreakpointLocation exposed the ignore count, but didn't expose
the hit count. Both values were exposed by SBBreakpoint and
SBWatchpoint, so this makes things a bit more consistent.

[jingham]

If you are exposing this, could you write a test to make sure it stays correct? I added a sample test that you can easily copy and modify in:

packages/Python/lldbsuite/test/sample_test

The TestSampleTest.py test makes the binary, loads it into lldb and runs to a breakpoint. So it should be trivial to just check the location and make sure it is correct. Maybe drive around a little more and make sure it updates...

The breakpoint tests go in functionalities/breakpoints. Don't forget to reset the "LEVEL" variable in the Makefile to track the test location.

[jingham]

BTW, other than the lack of a test, this is fine.

[brucem]

Add a test.

[brucem]

Pavel, since Jim was okay with this before apart from it not having a test, want to take a quick look now? Thanks!

[labath]

The test looks well written. I've added a couple of suggestions you can consider including.

packages/Python/lldbsuite/test/functionalities/breakpoint/breakpoint_hit_count/TestBreakpointHitCount.py

16

You may want to add NO_DEBUG_INFO_TESTCASE = True here to turn off magic test duplication.

106

using assertEqual will give more meaningful error messages in case this ever breaks.

[brucem]

Update per comments.

include/lldb/API/SBBreakpointLocation.h

public:
   lldb::SBAddress GetAddress();
 
   lldb::addr_t GetLoadAddress();
 
   void SetEnabled(bool enabled);
 
   bool IsEnabled();
 
+  uint32_t GetHitCount();
+
   uint32_t GetIgnoreCount();
 
   void SetIgnoreCount(uint32_t n);
 
   void SetCondition(const char *condition);
 
   const char *GetCondition();
 

packages/Python/lldbsuite/test/functionalities/breakpoint/breakpoint_hit_count/Makefile

+LEVEL = ../../../make
+
+CXX_SOURCES := main.cpp
+
+include $(LEVEL)/Makefile.rules

packages/Python/lldbsuite/test/functionalities/breakpoint/breakpoint_hit_count/TestBreakpointHitCount.py

+"""
+Test breakpoint hit count features.
+"""
+
+from __future__ import print_function
+
+import lldb
+from lldbsuite.test.decorators import *
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test import lldbutil
+
+
+class BreakpointHitCountTestCase(TestBase):
+
+    NO_DEBUG_INFO_TESTCASE = True
+
+    mydir = TestBase.compute_mydir(__file__)
+
+    @add_test_categories(['pyapi'])
+    def test_breakpoint_location_hit_count(self):
+        """Use Python APIs to check breakpoint hit count."""
+        self.build()
+        self.do_test_breakpoint_location_hit_count()
+
+    def setUp(self):
+        # Call super's setUp().
+        TestBase.setUp(self)
+        self.a_int_body_line_no = line_number(
+            'main.cpp', '// Breakpoint Location 1')
+        self.a_float_body_line_no = line_number(
+            'main.cpp', '// Breakpoint Location 2')
+
+    def do_test_breakpoint_location_hit_count(self):
+        """Use Python APIs to check breakpoint hit count."""
+        exe = os.path.join(os.getcwd(), "a.out")
+
+        target = self.dbg.CreateTarget(exe)
+        self.assertTrue(target, VALID_TARGET)
+
+        # Create a breakpoint in main.cpp by name 'a',
+        # there should be two locations.
+        breakpoint = target.BreakpointCreateByName('a', 'a.out')
+        self.assertTrue(breakpoint and
+                        breakpoint.GetNumLocations() == 2,
+                        VALID_BREAKPOINT)
+
+        # Verify all breakpoint locations are enabled.
+        location1 = breakpoint.GetLocationAtIndex(0)
+        self.assertTrue(location1 and
+                        location1.IsEnabled(),
+                        VALID_BREAKPOINT_LOCATION)
+
+        location2 = breakpoint.GetLocationAtIndex(1)
+        self.assertTrue(location2 and
+                        location2.IsEnabled(),
+                        VALID_BREAKPOINT_LOCATION)
+
+        # Launch the process, and do not stop at entry point.
+        process = target.LaunchSimple(
+            None, None, self.get_process_working_directory())
+        self.assertTrue(process, PROCESS_IS_VALID)
+
+        # Verify 1st breakpoint location is hit.
+        from lldbsuite.test.lldbutil import get_stopped_thread
+        thread = get_stopped_thread(process, lldb.eStopReasonBreakpoint)
+        self.assertTrue(
+            thread.IsValid(),
+            "There should be a thread stopped due to breakpoint")
+
+        frame0 = thread.GetFrameAtIndex(0)
+        location1 = breakpoint.FindLocationByAddress(frame0.GetPC())
+        self.assertTrue(
+            frame0.GetLineEntry().GetLine() == self.a_int_body_line_no,
+            "Stopped in int a(int)")
+        self.assertTrue(location1)
+        self.assertEqual(location1.GetHitCount(), 1)
+        self.assertEqual(breakpoint.GetHitCount(), 1)
+
+        process.Continue()
+
+        # Verify 2nd breakpoint location is hit.
+        thread = get_stopped_thread(process, lldb.eStopReasonBreakpoint)
+        self.assertTrue(
+            thread.IsValid(),
+            "There should be a thread stopped due to breakpoint")
+
+        frame0 = thread.GetFrameAtIndex(0)
+        location2 = breakpoint.FindLocationByAddress(frame0.GetPC())
+        self.assertTrue(
+            frame0.GetLineEntry().GetLine() == self.a_float_body_line_no,
+            "Stopped in float a(float)")
+        self.assertTrue(location2)
+        self.assertEqual(location2.GetHitCount(), 1)
+        self.assertEqual(location1.GetHitCount(), 1)
+        self.assertEqual(breakpoint.GetHitCount(), 2)
+
+        process.Continue()
+
+        # Verify 2nd breakpoint location is hit again.
+        thread = get_stopped_thread(process, lldb.eStopReasonBreakpoint)
+        self.assertTrue(
+            thread.IsValid(),
+            "There should be a thread stopped due to breakpoint")
+
+        self.assertEqual(location2.GetHitCount(), 2)
+        self.assertEqual(location1.GetHitCount(), 1)
+        self.assertEqual(breakpoint.GetHitCount(), 3)
+
+        process.Continue()

packages/Python/lldbsuite/test/functionalities/breakpoint/breakpoint_hit_count/main.cpp

+//===-- main.cpp ------------------------------------------------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+int a(int val)
+{
+   return val; // Breakpoint Location 1
+}
+
+float a(float val)
+{
+    return val; // Breakpoint Location 2
+}
+
+int main (int argc, char const *argv[])
+{
+    int A1 = a(1);
+    float A2 = a(2.0f);
+    float A3 = a(3.0f);
+
+    return 0;
+}

scripts/interface/SBBreakpointLocation.i

public:
 
     void
     SetEnabled(bool enabled);
 
     bool
     IsEnabled ();
 
     uint32_t
+    GetHitCount ();
+
+    uint32_t
     GetIgnoreCount ();
 
     void
     SetIgnoreCount (uint32_t n);
 
     %feature("docstring", "
     //--------------------------------------------------------------------------
     /// The breakpoint location stops only if the condition expression evaluates

source/API/SBBreakpointLocation.cpp

bool SBBreakpointLocation::IsEnabled() {
   if (loc_sp) {
     std::lock_guard<std::recursive_mutex> guard(
         loc_sp->GetTarget().GetAPIMutex());
     return loc_sp->IsEnabled();
   } else
     return false;
 }
 
+uint32_t SBBreakpointLocation::GetHitCount() {
+  BreakpointLocationSP loc_sp = GetSP();
+  if (loc_sp) {
+    std::lock_guard<std::recursive_mutex> guard(
+        loc_sp->GetTarget().GetAPIMutex());
+    return loc_sp->GetHitCount();
+  } else
+    return 0;
+}
+
 uint32_t SBBreakpointLocation::GetIgnoreCount() {
   BreakpointLocationSP loc_sp = GetSP();
   if (loc_sp) {
     std::lock_guard<std::recursive_mutex> guard(
         loc_sp->GetTarget().GetAPIMutex());
     return loc_sp->GetIgnoreCount();
   } else
     return 0;