[RFA 2/3] use user_breakpoint_p in python code

[RFA 2/3] use user_breakpoint_p in python code

[Tom Tromey]

I noticed that bppy_get_visibility and gdbpy_breakpoint_created
implemented their own visibility checks, but subtly different from
user_breakpoint_p.  I think the latter is more correct, and so changed
the Python code to use it.

I suspect there isn't a decent way to test this, so no new test.

Built and regtested on x86-64 Fedora 23.

2016-05-19  Tom Tromey  <tom@tromey.com>

	* python/py-breakpoint.c (bppy_get_visibility)
	(gdbpy_breakpoint_created): Use user_breakpoint_p.
---
 gdb/ChangeLog              | 5 +++++
 gdb/python/py-breakpoint.c | 8 ++++----
 2 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 0968b85..a03d290 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,8 @@
+2016-05-19  Tom Tromey  <tom@tromey.com>
+
+	* python/py-breakpoint.c (bppy_get_visibility)
+	(gdbpy_breakpoint_created): Use user_breakpoint_p.
+
 2016-05-19  Andreas Schwab  <schwab@suse.de>
 
 	* ia64-libunwind-tdep.c (libunwind_descr): Add cast from void *.
diff --git a/gdb/python/py-breakpoint.c b/gdb/python/py-breakpoint.c
index 611a41e..f86da8d 100644
--- a/gdb/python/py-breakpoint.c
+++ b/gdb/python/py-breakpoint.c
@@ -540,10 +540,10 @@ bppy_get_visibility (PyObject *self, void *closure)
 
   BPPY_REQUIRE_VALID (self_bp);
 
-  if (self_bp->bp->number < 0)
-    Py_RETURN_FALSE;
+  if (user_breakpoint_p (self_bp->bp))
+    Py_RETURN_TRUE;
 
-  Py_RETURN_TRUE;
+  Py_RETURN_FALSE;
 }
 
 /* Python function to determine if the breakpoint is a temporary
@@ -862,7 +862,7 @@ gdbpy_breakpoint_created (struct breakpoint *bp)
   gdbpy_breakpoint_object *newbp;
   PyGILState_STATE state;
 
-  if (bp->number < 0 && bppy_pending_object == NULL)
+  if (!user_breakpoint_p (bp) && bppy_pending_object == NULL)
     return;
 
   if (bp->type != bp_breakpoint
-- 
2.5.5

[RFA 3/3] PR python/17698 - add Breakpoint.pending

[Tom Tromey]

This patch adds a "pending" attribute to gdb.Breakpoint.

Built and regtested on x86-64 Fedora 23.

2016-05-19  Tom Tromey  <tom@tromey.com>

	PR python/17698:
	* NEWS: Update.
	* python/py-breakpoint.c (bppy_get_pending): New function.
	(breakpoint_object_getset): Add entry for "pending".
	* breakpoint.h (pending_breakpoint_p): Declare.
	* breakpoint.c (pending_breakpoint_p): New function.

2016-05-19  Tom Tromey  <tom@tromey.com>

	PR python/17698:
	* python.texi (Breakpoints In Python): Document
	Breakpoint.pending.

2016-05-19  Tom Tromey  <tom@tromey.com>

	PR python/17698:
	* gdb.python/py-breakpoint.exp (test_bkpt_basic): Add "pending"
	test.
	(test_watchpoints): Likewise.
	(test_bkpt_pending): New proc.
---
 gdb/ChangeLog                              |  9 +++++++++
 gdb/NEWS                                   |  5 +++++
 gdb/breakpoint.c                           |  8 ++++++++
 gdb/breakpoint.h                           |  3 +++
 gdb/doc/ChangeLog                          |  6 ++++++
 gdb/doc/python.texi                        |  6 ++++++
 gdb/python/py-breakpoint.c                 | 20 ++++++++++++++++++++
 gdb/testsuite/ChangeLog                    |  8 ++++++++
 gdb/testsuite/gdb.python/py-breakpoint.exp | 11 +++++++++++
 9 files changed, 76 insertions(+)

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index a03d290..c8b54b4 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,5 +1,14 @@
 2016-05-19  Tom Tromey  <tom@tromey.com>
 
+	PR python/17698:
+	* NEWS: Update.
+	* python/py-breakpoint.c (bppy_get_pending): New function.
+	(breakpoint_object_getset): Add entry for "pending".
+	* breakpoint.h (pending_breakpoint_p): Declare.
+	* breakpoint.c (pending_breakpoint_p): New function.
+
+2016-05-19  Tom Tromey  <tom@tromey.com>
+
 	* python/py-breakpoint.c (bppy_get_visibility)
 	(gdbpy_breakpoint_created): Use user_breakpoint_p.
 
diff --git a/gdb/NEWS b/gdb/NEWS
index 3e8e7a1..4ca8fdd 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -48,6 +48,11 @@ maint info line-table REGEXP
 maint selftest
   Run any GDB unit tests that were compiled in.
 
+* Python Scripting
+
+  ** gdb.Breakpoint objects have a new attribute "pending", which
+     indicates whether the breakpoint is pending.
+
 * Support for tracepoints and fast tracepoints on s390-linux and s390x-linux
   was added in GDBserver, including JIT compiling fast tracepoint's
   conditional expression bytecode into native code.
diff --git a/gdb/breakpoint.c b/gdb/breakpoint.c
index d2dafef..6328b44 100644
--- a/gdb/breakpoint.c
+++ b/gdb/breakpoint.c
@@ -6791,6 +6791,14 @@ user_breakpoint_p (struct breakpoint *b)
   return b->number > 0;
 }
 
+/* See breakpoint.h.  */
+
+int
+pending_breakpoint_p (struct breakpoint *b)
+{
+  return b->loc == NULL;
+}
+
 /* Print information on user settable breakpoint (watchpoint, etc)
    number BNUM.  If BNUM is -1 print all user-settable breakpoints.
    If ALLFLAG is non-zero, include non-user-settable breakpoints.  If
diff --git a/gdb/breakpoint.h b/gdb/breakpoint.h
index 054eab4..5f06772 100644
--- a/gdb/breakpoint.h
+++ b/gdb/breakpoint.h
@@ -1618,6 +1618,9 @@ extern int pc_at_non_inline_function (struct address_space *aspace,
 
 extern int user_breakpoint_p (struct breakpoint *);
 
+/* Return true if this breakpoint is pending, false if not.  */
+extern int pending_breakpoint_p (struct breakpoint *);
+
 /* Attempt to determine architecture of location identified by SAL.  */
 extern struct gdbarch *get_sal_arch (struct symtab_and_line sal);
 
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 3e9c35a..c9c4244 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,5 +1,11 @@
 2016-05-19  Tom Tromey  <tom@tromey.com>
 
+	PR python/17698:
+	* python.texi (Breakpoints In Python): Document
+	Breakpoint.pending.
+
+2016-05-19  Tom Tromey  <tom@tromey.com>
+
 	* python.texi (Breakpoints In Python): Move table of types and
 	table of watchpoint types earlier in node.
 
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 4847a14..0791a06 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -4673,6 +4673,12 @@ first command is @code{silent}.  This is not reported by the
 @code{silent} attribute.
 @end defvar
 
+@defvar Breakpoint.pending
+This attribute is @code{True} if the breakpoint is pending, and
+@code{False} otherwise.  @xref{Set Breaks}.  This attribute is
+read-only.
+@end defvar
+
 @anchor{python_breakpoint_thread}
 @defvar Breakpoint.thread
 If the breakpoint is thread-specific, this attribute holds the
diff --git a/gdb/python/py-breakpoint.c b/gdb/python/py-breakpoint.c
index f86da8d..d925bdc 100644
--- a/gdb/python/py-breakpoint.c
+++ b/gdb/python/py-breakpoint.c
@@ -563,6 +563,24 @@ bppy_get_temporary (PyObject *self, void *closure)
   Py_RETURN_FALSE;
 }
 
+/* Python function to determine if the breakpoint is a pending
+   breakpoint.  */
+
+static PyObject *
+bppy_get_pending (PyObject *self, void *closure)
+{
+  gdbpy_breakpoint_object *self_bp = (gdbpy_breakpoint_object *) self;
+
+  BPPY_REQUIRE_VALID (self_bp);
+
+  if (is_watchpoint (self_bp->bp))
+    Py_RETURN_FALSE;
+  if (pending_breakpoint_p (self_bp->bp))
+    Py_RETURN_TRUE;
+
+  Py_RETURN_FALSE;
+}
+
 /* Python function to get the breakpoint's number.  */
 static PyObject *
 bppy_get_number (PyObject *self, void *closure)
@@ -1053,6 +1071,8 @@ or None if no condition set."},
     "Whether the breakpoint is visible to the user."},
   { "temporary", bppy_get_temporary, NULL,
     "Whether this breakpoint is a temporary breakpoint."},
+  { "pending", bppy_get_pending, NULL,
+    "Whether this breakpoint is a pending breakpoint."},
   { NULL }  /* Sentinel.  */
 };
 
diff --git a/gdb/testsuite/ChangeLog b/gdb/testsuite/ChangeLog
index a773c63..4242525 100644
--- a/gdb/testsuite/ChangeLog
+++ b/gdb/testsuite/ChangeLog
@@ -1,3 +1,11 @@
+2016-05-19  Tom Tromey  <tom@tromey.com>
+
+	PR python/17698:
+	* gdb.python/py-breakpoint.exp (test_bkpt_basic): Add "pending"
+	test.
+	(test_watchpoints): Likewise.
+	(test_bkpt_pending): New proc.
+
 2016-05-18  Simon Marchi  <simon.marchi@ericsson.com>
 
 	* gdb.mi/mi-threads-interrupt.c: New file.
diff --git a/gdb/testsuite/gdb.python/py-breakpoint.exp b/gdb/testsuite/gdb.python/py-breakpoint.exp
index d1d1b22..4729733 100644
--- a/gdb/testsuite/gdb.python/py-breakpoint.exp
+++ b/gdb/testsuite/gdb.python/py-breakpoint.exp
@@ -46,6 +46,8 @@ proc test_bkpt_basic { } {
 	    "<gdb.Breakpoint object at $hex>" "Check obj exists @main"
 	gdb_test "python print (blist\[0\].location)" \
 	    "main." "Check breakpoint location @main"
+	gdb_test "python print (blist\[0\].pending)" "False" \
+	    "Check pending status of main breakpoint"
 
 	set mult_line [gdb_get_line_number "Break at multiply."]
 	gdb_breakpoint ${mult_line}
@@ -264,6 +266,7 @@ proc test_watchpoints { } {
 
 	gdb_py_test_silent_cmd  "python wp1 = gdb.Breakpoint (\"result\", type=gdb.BP_WATCHPOINT, wp_class=gdb.WP_WRITE )" \
 	    "Set watchpoint" 0
+	gdb_test "python print wp1.pending" "False"
 	gdb_test "continue" \
 	    ".*\[Ww\]atchpoint.*result.*Old value = 0.*New value = 25.*main.*" \
 	    "Test watchpoint write"
@@ -494,6 +497,13 @@ proc test_bkpt_address {} {
 	".*Breakpoint ($decimal)+ at .*$srcfile, line ($decimal)+\."
 }
 
+proc test_bkpt_pending {} {
+    delete_breakpoints
+    gdb_breakpoint "nosuchfunction" allow-pending
+    gdb_test "python print (gdb.breakpoints()\[0\].pending)" "True" \
+	"Check pending status of pending breakpoint"
+}
+
 test_bkpt_basic
 test_bkpt_deletion
 test_bkpt_cond_and_cmds
@@ -503,3 +513,4 @@ test_bkpt_internal
 test_bkpt_eval_funcs
 test_bkpt_temporary
 test_bkpt_address
+test_bkpt_pending
-- 
2.5.5

[RFA 0/4] Add "pending" attribute to gdb.Breakpoint

[Tom Tromey]

This started as a patch to add gdb.Breakpoint.pending, aka PR
python/17698.  However, I noticed a couple of other small oddities
while I was in there, and so now it's a short series.

Tom

[RFA 1/3] Rearrange Python breakpoint node in documentation

[Tom Tromey]

I noticed that the Python breakpoint documentation was ordered a bit
oddly.  It documented the constructor; then the stop method; then the
watchpoint constants (used for the constructor); then various other
methods and attributes; then the other constants used by the
constructor; and then finally some more methods and attributes.

This patch rearranges the node a little to move the constants to just
after the constructor and before the other methods and attributes.

2016-05-19  Tom Tromey  <tom@tromey.com>

	* python.texi (Breakpoints In Python): Move table of types and
	table of watchpoint types earlier in node.
---
 gdb/doc/ChangeLog   |  5 ++++
 gdb/doc/python.texi | 84 ++++++++++++++++++++++++++---------------------------
 2 files changed, 47 insertions(+), 42 deletions(-)

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index fe2e3be..3e9c35a 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@
+2016-05-19  Tom Tromey  <tom@tromey.com>
+
+	* python.texi (Breakpoints In Python): Move table of types and
+	table of watchpoint types earlier in node.
+
 2016-05-17  Tom Tromey  <tom@tromey.com>
 
 	* gdb.texinfo (Supported Languages): Mention Rust.  Update menu.
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index ffbf89a..4847a14 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -4567,6 +4567,48 @@ the class of watchpoint to create, if @var{type} is
 is assumed to be a @code{gdb.WP_WRITE} class.
 @end defun
 
+The available types are represented by constants defined in the @code{gdb}
+module:
+
+@vtable @code
+@vindex BP_BREAKPOINT
+@item gdb.BP_BREAKPOINT
+Normal code breakpoint.
+
+@vindex BP_WATCHPOINT
+@item gdb.BP_WATCHPOINT
+Watchpoint breakpoint.
+
+@vindex BP_HARDWARE_WATCHPOINT
+@item gdb.BP_HARDWARE_WATCHPOINT
+Hardware assisted watchpoint.
+
+@vindex BP_READ_WATCHPOINT
+@item gdb.BP_READ_WATCHPOINT
+Hardware assisted read watchpoint.
+
+@vindex BP_ACCESS_WATCHPOINT
+@item gdb.BP_ACCESS_WATCHPOINT
+Hardware assisted access watchpoint.
+@end vtable
+
+The available watchpoint types represented by constants are defined in the
+@code{gdb} module:
+
+@vtable @code
+@vindex WP_READ
+@item gdb.WP_READ
+Read only watchpoint.
+
+@vindex WP_WRITE
+@item gdb.WP_WRITE
+Write only watchpoint.
+
+@vindex WP_ACCESS
+@item gdb.WP_ACCESS
+Read/Write watchpoint.
+@end vtable
+
 @defun Breakpoint.stop (self)
 The @code{gdb.Breakpoint} class can be sub-classed and, in
 particular, you may choose to implement the @code{stop} method.
@@ -4601,23 +4643,6 @@ class MyBreakpoint (gdb.Breakpoint):
 @end smallexample
 @end defun
 
-The available watchpoint types represented by constants are defined in the
-@code{gdb} module:
-
-@vtable @code
-@vindex WP_READ
-@item gdb.WP_READ
-Read only watchpoint.
-
-@vindex WP_WRITE
-@item gdb.WP_WRITE
-Write only watchpoint.
-
-@vindex WP_ACCESS
-@item gdb.WP_ACCESS
-Read/Write watchpoint.
-@end vtable
-
 @defun Breakpoint.is_valid ()
 Return @code{True} if this @code{Breakpoint} object is valid,
 @code{False} otherwise.  A @code{Breakpoint} object can become invalid
@@ -4694,31 +4719,6 @@ function, will result in an error after the breakpoint has been hit
 writable.
 @end defvar
 
-The available types are represented by constants defined in the @code{gdb}
-module:
-
-@vtable @code
-@vindex BP_BREAKPOINT
-@item gdb.BP_BREAKPOINT
-Normal code breakpoint.
-
-@vindex BP_WATCHPOINT
-@item gdb.BP_WATCHPOINT
-Watchpoint breakpoint.
-
-@vindex BP_HARDWARE_WATCHPOINT
-@item gdb.BP_HARDWARE_WATCHPOINT
-Hardware assisted watchpoint.
-
-@vindex BP_READ_WATCHPOINT
-@item gdb.BP_READ_WATCHPOINT
-Hardware assisted read watchpoint.
-
-@vindex BP_ACCESS_WATCHPOINT
-@item gdb.BP_ACCESS_WATCHPOINT
-Hardware assisted access watchpoint.
-@end vtable
-
 @defvar Breakpoint.hit_count
 This attribute holds the hit count for the breakpoint, an integer.
 This attribute is writable, but currently it can only be set to zero.
-- 
2.5.5

Re: [RFA 1/3] Rearrange Python breakpoint node in documentation

[Eli Zaretskii]

> From: Tom Tromey <tom@tromey.com>
> Cc: Tom Tromey <tom@tromey.com>
> Date: Thu, 19 May 2016 16:06:01 -0600
> 
> I noticed that the Python breakpoint documentation was ordered a bit
> oddly.  It documented the constructor; then the stop method; then the
> watchpoint constants (used for the constructor); then various other
> methods and attributes; then the other constants used by the
> constructor; and then finally some more methods and attributes.
> 
> This patch rearranges the node a little to move the constants to just
> after the constructor and before the other methods and attributes.

OK, thanks.

Re: [RFA 3/3] PR python/17698 - add Breakpoint.pending

[Eli Zaretskii]

> From: Tom Tromey <tom@tromey.com>
> Cc: Tom Tromey <tom@tromey.com>
> Date: Thu, 19 May 2016 16:06:03 -0600
> 
> This patch adds a "pending" attribute to gdb.Breakpoint.
> 
> Built and regtested on x86-64 Fedora 23.
> 
> 2016-05-19  Tom Tromey  <tom@tromey.com>
> 
> 	PR python/17698:
> 	* NEWS: Update.
> 	* python/py-breakpoint.c (bppy_get_pending): New function.
> 	(breakpoint_object_getset): Add entry for "pending".
> 	* breakpoint.h (pending_breakpoint_p): Declare.
> 	* breakpoint.c (pending_breakpoint_p): New function.
> 
> 2016-05-19  Tom Tromey  <tom@tromey.com>
> 
> 	PR python/17698:
> 	* python.texi (Breakpoints In Python): Document
> 	Breakpoint.pending.
> 
> 2016-05-19  Tom Tromey  <tom@tromey.com>
> 
> 	PR python/17698:
> 	* gdb.python/py-breakpoint.exp (test_bkpt_basic): Add "pending"
> 	test.
> 	(test_watchpoints): Likewise.
> 	(test_bkpt_pending): New proc.

OK for the documentation parts.

Thanks.

Re: [RFA 3/3] PR python/17698 - add Breakpoint.pending

[Phil Muldoon]

On 19/05/16 23:06, Tom Tromey wrote:
> This patch adds a "pending" attribute to gdb.Breakpoint.
> 
> Built and regtested on x86-64 Fedora 23.
> 
> 2016-05-19  Tom Tromey  <tom@tromey.com>
> 
> 	PR python/17698:
> 	* NEWS: Update.
> 	* python/py-breakpoint.c (bppy_get_pending): New function.
> 	(breakpoint_object_getset): Add entry for "pending".
> 	* breakpoint.h (pending_breakpoint_p): Declare.
> 	* breakpoint.c (pending_breakpoint_p): New function.
> 
> 2016-05-19  Tom Tromey  <tom@tromey.com>
> 
> 	PR python/17698:
> 	* python.texi (Breakpoints In Python): Document
> 	Breakpoint.pending.
> 
> 2016-05-19  Tom Tromey  <tom@tromey.com>
> 
> 	PR python/17698:
> 	* gdb.python/py-breakpoint.exp (test_bkpt_basic): Add "pending"
> 	test.
> 	(test_watchpoints): Likewise.
> 	(test_bkpt_pending): New proc.

Looks good to me!

Cheers
Phil

Re: [RFA 2/3] use user_breakpoint_p in python code

[Phil Muldoon]

On 19/05/16 23:06, Tom Tromey wrote:
> I noticed that bppy_get_visibility and gdbpy_breakpoint_created
> implemented their own visibility checks, but subtly different from
> user_breakpoint_p.  I think the latter is more correct, and so changed
> the Python code to use it.
> 
> I suspect there isn't a decent way to test this, so no new test.
> 
> Built and regtested on x86-64 Fedora 23.
> 
> 2016-05-19  Tom Tromey  <tom@tromey.com>
> 
> 	* python/py-breakpoint.c (bppy_get_visibility)
> 	(gdbpy_breakpoint_created): Use user_breakpoint_p.
> ---
>  gdb/ChangeLog              | 5 +++++
>  gdb/python/py-breakpoint.c | 8 ++++----
>  2 files changed, 9 insertions(+), 4 deletions(-)

Looks good to me!

Cheers

Phil

Re: [RFA 2/3] use user_breakpoint_p in python code

[Yao Qi]

Tom Tromey <tom@tromey.com> writes:

> 2016-05-19  Tom Tromey  <tom@tromey.com>
>
> 	* python/py-breakpoint.c (bppy_get_visibility)
> 	(gdbpy_breakpoint_created): Use user_breakpoint_p.

It is OK.

-- 
Yao (齐尧)

Re: [RFA 3/3] PR python/17698 - add Breakpoint.pending

[Yao Qi]

Tom Tromey <tom@tromey.com> writes:

> This patch adds a "pending" attribute to gdb.Breakpoint.
>
> Built and regtested on x86-64 Fedora 23.

Patch is good to me.

-- 
Yao (齐尧)