[v2,3/3] Add a way to temporarily set a gdb parameter from Python

Message ID 20220110215144.1714909-4-tromey@adacore.com
State New
Headers show
Series
  • Improvements to Python parameters
Related show

Commit Message

Simon Marchi via Gdb-patches Jan. 10, 2022, 9:51 p.m.
It's sometimes useful to temporarily set some gdb parameter from
Python.  Now that the 'endian' crash is fixed, and now that the
current language is no longer captured by the Python layer, it seems
reasonable to add a helper function for this situation.

This adds a new gdb.with_parameter function.  This creates a context
manager which temporarily sets some parameter to a specified value.
The old value is restored when the context is exited.  This is most
useful with the Python "with" statement:

   with gdb.with_parameter('language', 'ada'):
      ... do Ada stuff

This also adds a simple function to set a parameter,
gdb.set_parameter, as suggested by Andrew.

This is PR python/10790.

Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=10790
---
 gdb/NEWS                                    |  7 ++++++
 gdb/doc/python.texi                         | 26 +++++++++++++++++++++
 gdb/python/lib/gdb/__init__.py              | 17 ++++++++++++++
 gdb/testsuite/gdb.python/py-lookup-type.exp | 18 ++++++++++++++
 4 files changed, 68 insertions(+)

-- 
2.31.1

Comments

Simon Marchi via Gdb-patches Jan. 13, 2022, 8:50 a.m. | #1
> +

> +

> +@contextmanager

> +def with_parameter(name, value):

> +    """Temporarily set the GDB parameter NAME to VALUE.

> +    Note that this is a context manager."""

> +    old_value = parameter(name)

> +    set_parameter(name, value)

> +    # Nothing that useful to return.

> +    yield None

> +    set_parameter(name, old_value)

> +

> +


Hi,

In python, context managers are usually used the way RAII resources are
in c++. which is to ensure some resource is reliably released (parameter
is restored in this case) at the end of the block.  Here, if an
exception is thrown within the block, the original value is not
restored.

I would suggest something like:


    @contextmanager
    def with_parameter(name, value):
        """Temporarily set the GDB parameter NAME to VALUE.
        Note that this is a context manager."""
        old_value = parameter(name)
        set_parameter(name, value)
        try:
            yield
        finally:
            set_parameter(name, old_value)


This way, the parameter is restored even in case of exception, which is
what I would expect from a python user point of view.

Best,
Lancelot.
Simon Marchi via Gdb-patches Jan. 13, 2022, 7:46 p.m. | #2
Lancelot>         try:
Lancelot>             yield
Lancelot>         finally:
Lancelot>             set_parameter(name, old_value)

Lancelot> This way, the parameter is restored even in case of exception, which is
Lancelot> what I would expect from a python user point of view.

Yeah, thanks.  I had assumed @contextmanager would handle this.
Anyway I'll make this change.

Tom

Patch

diff --git a/gdb/NEWS b/gdb/NEWS
index c26e15b530a..c3c73b4e004 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -120,6 +120,13 @@  clone-inferior
      is equivalent to the existing 'maint packet' CLI command; it
      allows a user specified packet to be sent to the remote target.
 
+  ** New gdb.set_parameter(NAME, VALUE).  This sets the gdb parameter
+     NAME to VALUE.
+
+  ** New gdb.with_parameter(NAME, VALUE).  This returns a context
+     manager that temporarily sets the gdb parameter NAME to VALUE,
+     then resets it when the context is exited.
+
 * New features in the GDB remote stub, GDBserver
 
   ** GDBserver is now supported on OpenRISC GNU/Linux.
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 6bd5f6b90ac..2f309d7d91b 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -332,6 +332,32 @@  parameter's value is converted to a Python value of the appropriate
 type, and returned.
 @end defun
 
+@findex gdb.set_parameter
+@defun gdb.set_parameter (name, value)
+Sets the gdb parameter @var{name} to @var{value}.  As with
+@code{gdb.parameter}, the parameter name string may contain spaces if
+the parameter has a multi-part name.
+@end defun
+
+@findex gdb.with_parameter
+@defun gdb.with_parameter (name, value)
+Create a Python context manager (for use with the Python
+@command{with} statement) that temporarily sets the gdb parameter
+@var{name} to @var{value}.  On exit from the context, the previous
+value will be restored.
+
+This uses @code{gdb.parameter} in its implementation, so it can throw
+the same exceptions as that function.
+
+For example, it's sometimes useful to evaluate some Python code with a
+particular gdb language:
+
+@smallexample
+with gdb.with_parameter('language', 'pascal'):
+  ... language-specific operations
+@end smallexample
+@end defun
+
 @findex gdb.history
 @defun gdb.history (number)
 Return a value from @value{GDBN}'s value history (@pxref{Value
diff --git a/gdb/python/lib/gdb/__init__.py b/gdb/python/lib/gdb/__init__.py
index 11a1b444bfd..b32c66f6cb4 100644
--- a/gdb/python/lib/gdb/__init__.py
+++ b/gdb/python/lib/gdb/__init__.py
@@ -17,6 +17,7 @@  import traceback
 import os
 import sys
 import _gdb
+from contextlib import contextmanager
 
 # Python 3 moved "reload"
 if sys.version_info >= (3, 4):
@@ -231,6 +232,22 @@  def find_pc_line(pc):
     return current_progspace().find_pc_line(pc)
 
 
+def set_parameter(name, value):
+    """Set the GDB parameter NAME to VALUE."""
+    execute('set ' + name + ' ' + str(value), to_string=True)
+
+
+@contextmanager
+def with_parameter(name, value):
+    """Temporarily set the GDB parameter NAME to VALUE.
+    Note that this is a context manager."""
+    old_value = parameter(name)
+    set_parameter(name, value)
+    # Nothing that useful to return.
+    yield None
+    set_parameter(name, old_value)
+
+
 try:
     from pygments import formatters, lexers, highlight
 
diff --git a/gdb/testsuite/gdb.python/py-lookup-type.exp b/gdb/testsuite/gdb.python/py-lookup-type.exp
index 534a5fd418e..596ab9a9af8 100644
--- a/gdb/testsuite/gdb.python/py-lookup-type.exp
+++ b/gdb/testsuite/gdb.python/py-lookup-type.exp
@@ -55,6 +55,19 @@  test_lookup_type "objective-c" "char"
 
 test_lookup_type "pascal" "char"
 
+gdb_test "show language" \
+    "The current source language is .pascal.." \
+    "show language before 'with'"
+gdb_test_multiline "look up type using set_parameter" \
+    "python" "" \
+    "with gdb.with_parameter('language', 'ada'):" "" \
+    "  print(gdb.lookup_type('character'))" "" \
+    "end" "character"
+gdb_test "show language" \
+    "The current source language is .pascal.." \
+    "show language after 'with'"
+
+
 # Ensure that the language can be changed from within Python and still
 # affect the results.
 gdb_test_multiline "look up ada type from another language" \
@@ -62,3 +75,8 @@  gdb_test_multiline "look up ada type from another language" \
     "gdb.execute('set language ada')" "" \
     "print(gdb.lookup_type('character'))" "" \
     "end" "character"
+
+gdb_test_no_output "python gdb.set_parameter('language', 'rust')"
+gdb_test "show language" \
+    "The current source language is .rust.." \
+    "show language after 'set_parameter'"