diff mbox series

[4/7] Add gdb.Frame.static_link method

Message ID 20231101-dap-nested-function-v1-4-0b0c3b228ac7@adacore.com
State New
Headers
Series Handle nested functions in DAP |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gdb_build--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_gdb_check--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_gdb_check--master-arm success Testing passed
linaro-tcwg-bot/tcwg_gdb_build--master-arm success Testing passed

Commit Message

Tom Tromey Nov. 1, 2023, 5:09 p.m. UTC 
  This adds a new gdb.Frame.static_link method to the gdb Python layer.
This can be used to find the static link frame for a given frame.
---
 gdb/NEWS              |  3 +++
 gdb/doc/python.texi   | 10 ++++++++++
 gdb/python/py-frame.c | 26 ++++++++++++++++++++++++++
 3 files changed, 39 insertions(+)

Comments

Eli Zaretskii Nov. 1, 2023, 5:17 p.m. UTC | #1 
> From: Tom Tromey <tromey@adacore.com>
> Date: Wed, 01 Nov 2023 11:09:36 -0600
> 
> This adds a new gdb.Frame.static_link method to the gdb Python layer.
> This can be used to find the static link frame for a given frame.
> ---
>  gdb/NEWS              |  3 +++
>  gdb/doc/python.texi   | 10 ++++++++++
>  gdb/python/py-frame.c | 26 ++++++++++++++++++++++++++
>  3 files changed, 39 insertions(+)

The documentation parts of this patch are okay.  Thanks.

Reviewed-By: Eli Zaretskii <eliz@gnu.org>
diff mbox series

Patch

diff --git a/gdb/NEWS b/gdb/NEWS
index 95663433f1c..503f53a2ea1 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -17,6 +17,9 @@ 
   ** New read/write attribute gdb.Value.bytes that contains a bytes
      object holding the contents of this value.
 
+  ** New method gdb.Frame.static_link that returns the outer frame
+     of a nested function frame.
+
 *** Changes in GDB 14
 
 * GDB now supports the AArch64 Scalable Matrix Extension 2 (SME2), which
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 8cc3f92cbfe..afe447644c5 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -5732,6 +5732,16 @@  Set this frame to be the selected frame.  @xref{Stack, ,Examining the
 Stack}.
 @end defun
 
+@defun Frame.static_link ()
+In some languages (e.g., Ada, but also a GNU C extension), a nested
+function can access the variables in the outer scope.  This is done
+via a ``static link'', which is a reference from the nested frame to
+the appropriate outer frame.
+
+This method returns this frame's static link frame, if one exists.  If
+there is no static link, this method returns @code{None}.
+@end defun
+
 @defun Frame.level ()
 Return an integer, the stack frame level for this frame.  @xref{Frames, ,Stack Frames}.
 @end defun
diff --git a/gdb/python/py-frame.c b/gdb/python/py-frame.c
index 1a55e514e39..0a7e10f09ff 100644
--- a/gdb/python/py-frame.c
+++ b/gdb/python/py-frame.c
@@ -622,6 +622,30 @@  frapy_language (PyObject *self, PyObject *args)
   Py_RETURN_NONE;
 }
 
+/* The static link for this frame.  */
+
+static PyObject *
+frapy_static_link (PyObject *self, PyObject *args)
+{
+  frame_info_ptr link;
+
+  try
+    {
+      FRAPY_REQUIRE_VALID (self, link);
+
+      link = frame_follow_static_link (link);
+    }
+  catch (const gdb_exception &except)
+    {
+      GDB_PY_HANDLE_EXCEPTION (except);
+    }
+
+  if (link == nullptr)
+    Py_RETURN_NONE;
+
+  return frame_info_to_frame_object (link);
+}
+
 /* Implementation of gdb.newest_frame () -> gdb.Frame.
    Returns the newest frame object.  */
 
@@ -800,6 +824,8 @@  Return the value of the variable in this frame." },
     "The stack level of this frame." },
   { "language", frapy_language, METH_NOARGS,
     "The language of this frame." },
+  { "static_link", frapy_static_link, METH_NOARGS,
+    "The static link of this frame, or None." },
   {NULL}  /* Sentinel */
 };