[PATCH] Handle multiple breakpoint hits in Python interface

[Kevin Pouget <kevin.pouget@gmail.com>]

Hello,

following the discussion on
http://sourceware.org/ml/gdb/2011-04/msg00131.html, here is a patch
which allows Python scripts to know that several breakpoints (with the
same PC) where hit during the "stop" event callback.
What do you think about it ?

Cordially,

Kevin

--

2011-04-22  Kevin Pouget  <kevin.pouget@st.com>

        Handle multiple breakpoint hits in Python interface:
        * gdb.texinfo (Events In Python): Indicate that multiple breakpoint
        may have been hit and rename the variable to breakpoints.

2011-04-22  Kevin Pouget  <kevin.pouget@st.com>

        Handle multiple breakpoint hits in Python interface:
        * python/py-bpevent.c (create_breakpoint_event_object): Rename C/Python
        variable to breakpoints.
        * python/py-stopevent.c (emit_stop_event): Return a Python tuple of
        bps instead of single breakpoint. Fix some space typos.
        * python/py-stopevent.c (create_breakpoint_event_object): Rename
        variable to breakpoints.

2011-04-22  Kevin Pouget  <kevin.pouget@st.com>

        Handle multiple breakpoint hits in Python interface:
        * gdb.python/py-events.exp: Set a duplicate breakpoint and check its
        presence.
        * gdb.python/py-events.py (breakpoint_stop_handler): Browse all the
        breakpoint hits.

--

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index edcf5c2..f042001 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -22086,12 +22086,12 @@ the @value{GDBN} command prompt.

 Also emits  @code{gdb.BreakpointEvent} which extends @code{gdb.StopEvent}.

-@code{gdb.BreakpointEvent} event indicates that a breakpoint has been hit, and
-has the following attributes:
+@code{gdb.BreakpointEvent} event indicates that one or several breakpoints have
+been hit, and has the following attributes:

 @table @code
-@defivar BreakpointEvent breakpoint
-A reference to the breakpoint that was hit of type @code{gdb.Breakpoint}.
+@defivar BreakpointEvent breakpoints
+A tuple containing references to the breakpoints (type
@code{gdb.Breakpoint}) that were hit.
 @xref{Breakpoints In Python}, for details of the @code{gdb.Breakpoint} object.
 @end defivar
 @end table
diff --git a/gdb/python/py-bpevent.c b/gdb/python/py-bpevent.c
index c7f7965..8c9808c 100644
--- a/gdb/python/py-bpevent.c
+++ b/gdb/python/py-bpevent.c
@@ -24,7 +24,7 @@ static PyTypeObject breakpoint_event_object_type;
 /* Create and initialize a BreakpointEvent object.  */

 PyObject *
-create_breakpoint_event_object (PyObject *breakpoint)
+create_breakpoint_event_object (PyObject *breakpoints)
 {
   PyObject *breakpoint_event_obj =
       create_stop_event_object (&breakpoint_event_object_type);
@@ -33,8 +33,8 @@ create_breakpoint_event_object (PyObject *breakpoint)
     goto fail;

   if (evpy_add_attribute (breakpoint_event_obj,
-                          "breakpoint",
-                          breakpoint) < 0)
+                          "breakpoints",
+                          breakpoints) < 0)
     goto fail;

   return breakpoint_event_obj;
diff --git a/gdb/python/py-stopevent.c b/gdb/python/py-stopevent.c
index 122fe6b..5e28756 100644
--- a/gdb/python/py-stopevent.c
+++ b/gdb/python/py-stopevent.c
@@ -45,26 +45,37 @@ int
 emit_stop_event (struct bpstats *bs, enum target_signal stop_signal)
 {
   PyObject *stop_event_obj = NULL; /* Appease GCC warning.  */
+  PyObject *list = NULL;
+  struct bpstats *current_bs;

   if (evregpy_no_listeners_p (gdb_py_events.stop))
     return 0;

-  if (bs && bs->breakpoint_at
-      && bs->breakpoint_at->py_bp_object)
+  /*Add any breakpoint set at this location to the list.  */
+  for (current_bs = bs; current_bs != NULL; current_bs = current_bs->next)
     {
-      stop_event_obj = create_breakpoint_event_object ((PyObject *) bs
-                                                       ->breakpoint_at
-                                                       ->py_bp_object);
+      if (current_bs->breakpoint_at
+          && current_bs->breakpoint_at->py_bp_object)
+        {
+          if (list == NULL)
+            list = PyList_New (0);
+
+          if (PyList_Append (list, (PyObject *)
current_bs->breakpoint_at->py_bp_object))
+            goto fail;
+        }
+    }
+  if (list != NULL)
+    {
+      stop_event_obj = create_breakpoint_event_object (list);
       if (!stop_event_obj)
-    goto fail;
+        goto fail;
     }

   /* Check if the signal is "Signal 0" or "Trace/breakpoint trap".  */
   if (stop_signal != TARGET_SIGNAL_0
       && stop_signal != TARGET_SIGNAL_TRAP)
     {
-      stop_event_obj =
-      create_signal_event_object (stop_signal);
+      stop_event_obj = create_signal_event_object (stop_signal);
       if (!stop_event_obj)
     goto fail;
     }
@@ -75,7 +86,7 @@ emit_stop_event (struct bpstats *bs, enum
target_signal stop_signal)
     {
       stop_event_obj = create_stop_event_object (&stop_event_object_type);
       if (!stop_event_obj)
-    goto fail;
+        goto fail;
     }

   return evpy_emit_event (stop_event_obj, gdb_py_events.stop);
diff --git a/gdb/python/py-stopevent.h b/gdb/python/py-stopevent.h
index 52f3511..4633ffd 100644
--- a/gdb/python/py-stopevent.h
+++ b/gdb/python/py-stopevent.h
@@ -28,7 +28,7 @@ extern void stop_evpy_dealloc (PyObject *self);
 extern int emit_stop_event (struct bpstats *bs,
                             enum target_signal stop_signal);

-extern PyObject *create_breakpoint_event_object (PyObject *breakpoint);
+extern PyObject *create_breakpoint_event_object (PyObject *breakpoints);

 extern PyObject *create_signal_event_object (enum target_signal stop_signal);

diff --git a/gdb/testsuite/gdb.python/py-events.exp
b/gdb/testsuite/gdb.python/py-events.exp
index e5d6daf..2b7cc08 100644
--- a/gdb/testsuite/gdb.python/py-events.exp
+++ b/gdb/testsuite/gdb.python/py-events.exp
@@ -45,12 +45,14 @@ if ![runto_main ] then {
 gdb_test "Test_Events" "Event testers registered."

 gdb_breakpoint "first"
+gdb_breakpoint "first"

 # Test continue event and breakpoint stop event
 gdb_test "continue" ".*event type: continue.*
 .*event type: stop.*
 .*stop reason: breakpoint.*
 .*breakpoint number: 2.*
+.*breakpoint number: 3.*
 all threads stopped"

 #test exited event.
diff --git a/gdb/testsuite/gdb.python/py-events.py
b/gdb/testsuite/gdb.python/py-events.py
index 9f05b9f..fb8f7e4 100644
--- a/gdb/testsuite/gdb.python/py-events.py
+++ b/gdb/testsuite/gdb.python/py-events.py
@@ -31,7 +31,8 @@ def breakpoint_stop_handler (event):
         print "event type: stop"
     if (isinstance (event, gdb.BreakpointEvent)):
         print "stop reason: breakpoint"
-        print "breakpoint number: %s" % (event.breakpoint.number)
+        for bp in event.breakpoints:
+            print "breakpoint number: %s" % (bp.number)
         if ( event.inferior_thread is not None) :
             print "thread num: %s" % (event.inferior_thread.num);
         else:
--
1.7.4.4