gdb/python: Return None from Progspace.block_for_pc on error
authorAndrew Burgess <andrew.burgess@embecosm.com>
Wed, 23 Oct 2019 12:24:02 +0000 (13:24 +0100)
committerAndrew Burgess <andrew.burgess@embecosm.com>
Thu, 24 Oct 2019 14:27:02 +0000 (15:27 +0100)
commit33d569b709886a1208145806da80b689d9cae9da
tree393153a80ff5ac6d102cadcd43379e0e5273dbd7
parent867c09822cfff34f91cb8f222cb8ae3eb9acb6d8
gdb/python: Return None from Progspace.block_for_pc on error

The documentation for Progspace.block_for_pc says:

  Return the innermost gdb.Block containing the given pc value. If the
  block cannot be found for the pc value specified, the function will
  return None.

However, the implementation actually throws an error for invalid
addresses, like this:

    (gdb) python print gdb.current_progspace ().block_for_pc (1)
    Traceback (most recent call last):
      File "<string>", line 1, in <module>
    RuntimeError: Cannot locate object file for block.
    Error while executing Python code.
    (gdb)

This has been the behaviour since the command was first added (when
the documentation was still as above) in this commit:

    commit f3e9a8177c41893858fce2bdf339dbe90b3a4ef5
    Date:   Wed Feb 24 21:18:28 2010 +0000

Since that commit the code in question has moved around, but the
important parts are largely unchanged.  The function in question is
now in py-progspace.c:pspy_block_for_pc.

Examining the code shows that the real state is more complex than just
the function throws an error instead of returning None, instead the
real situation is:

  1. If we can't find a compilation unit for the $pc value then we
  throw an error, but

  2. If we can find a compilation unit, but can't find a block within
  the compilation unit for the $pc then return None.

I suspect for most users of the Python API this distinction is
irrelevant, and I propose that we standardise on one single failure
mechanism.

Given the function can currently return None in some cases, and is
documented to return None on error, I propose we make that the case
for all error paths, which is what this patch does.

As the Progspace.block_for_pc method is currently untested, I've added
some basic tests including for a call with an invalid $pc.

This is potentially an API breaking change, though an undocumented
part of the API.  Also, users should have been checking and handling a
None return value anyway, so my hope is that this shouldn't be too
disruptive.

gdb/ChangeLog:

* python/py-progspace.c (pspy_block_for_pc): Return None for all
error paths.

gdb/testsuite/ChangeLog:

* gdb.python/py-progspace.exp: Add tests for the
Progspace.block_for_pc method.

Change-Id: I9cea8d2132902bcad0013d1fd39080dd5423cc57
gdb/ChangeLog
gdb/python/py-progspace.c
gdb/testsuite/ChangeLog
gdb/testsuite/gdb.python/py-progspace.exp