Re: [RFC] [gdb/cli] Add maint info frame-unwinders

[Tom de Vries <tdevries@suse.de>]

[-- Attachment #1: Type: text/plain, Size: 769 bytes --]

On 2/9/23 14:53, Eli Zaretskii wrote:
>> Date: Thu,  9 Feb 2023 14:06:58 +0100
>> From: Tom de Vries via Gdb-patches <gdb-patches@sourceware.org>
>>
>> Add a new command "maint info frame-unwinders"
> 
> Thanks.
> 
>> +@kindex maint info frame-unwinders
>> +@item maint info frame-unwinders
>> +List frame unwinders, starting with the highest priority.
>     ^^^^^^^^^^^^^^^^^^^^
> I'd suggest "List the frame unwinders currently in effect", or
> something like it.  "List frame unwinders" is too terse, and possibly
> also not entirely correct English-wise.
> 

Thanks for spotting that.

Fixed in both the docs and the help message.

> What about NEWS? should this be called out there?

Added.

I've also added a Reviewed-By tag.

Any further comments?

Thanks,
- Tom

[-- Attachment #2: 0001-gdb-cli-Add-maint-info-frame-unwinders.patch --]
[-- Type: text/x-patch, Size: 5249 bytes --]

From 0e1f0f3797faceaa4a13d3bf11162da2df6ea5d4 Mon Sep 17 00:00:00 2001
From: Tom de Vries <tdevries@suse.de>
Date: Thu, 9 Feb 2023 09:57:34 +0100
Subject: [PATCH] [gdb/cli] Add maint info frame-unwinders

Add a new command "maint info frame-unwinders":
...
(gdb) help maint info frame-unwinders
List the frame unwinders currently in effect, starting with the highest \
  priority.
...

Output for i386:
...
$ gdb -q -batch -ex "set arch i386" -ex "maint info frame-unwinders"
The target architecture is set to "i386".
dummy                   DUMMY_FRAME
dwarf2 tailcall         TAILCALL_FRAME
inline                  INLINE_FRAME
i386 epilogue           NORMAL_FRAME
dwarf2                  NORMAL_FRAME
dwarf2 signal           SIGTRAMP_FRAME
i386 stack tramp        NORMAL_FRAME
i386 sigtramp           SIGTRAMP_FRAME
i386 prologue           NORMAL_FRAME
...

Output for x86_64:
...
$ gdb -q -batch -ex "set arch i386:x86-64" -ex "maint info frame-unwinders"
The target architecture is set to "i386:x86-64".
dummy                   DUMMY_FRAME
dwarf2 tailcall         TAILCALL_FRAME
inline                  INLINE_FRAME
python                  NORMAL_FRAME
amd64 epilogue          NORMAL_FRAME
i386 epilogue           NORMAL_FRAME
dwarf2                  NORMAL_FRAME
dwarf2 signal           SIGTRAMP_FRAME
amd64 sigtramp          SIGTRAMP_FRAME
amd64 prologue          NORMAL_FRAME
i386 stack tramp        NORMAL_FRAME
i386 sigtramp           SIGTRAMP_FRAME
i386 prologue           NORMAL_FRAME
...

Tested on x86_64-linux.

Reviewed-By: Tom Tromey <tom@tromey.com>
Reviewed-By: Eli Zaretskii <eliz@gnu.org>
---
 gdb/NEWS            |  4 ++++
 gdb/doc/gdb.texinfo |  4 ++++
 gdb/frame-unwind.c  | 32 ++++++++++++++++++++++++++++++++
 gdb/frame.c         |  4 ++--
 gdb/frame.h         |  4 ++++
 5 files changed, 46 insertions(+), 2 deletions(-)

diff --git a/gdb/NEWS b/gdb/NEWS
index 1567cbea9bd..b85923cf80d 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -52,6 +52,10 @@ maintenance print record-instruction [ N ]
   prints how GDB would undo the N-th previous instruction, and if N is
   positive, it prints how GDB will redo the N-th following instruction.
 
+maintenance info frame-unwinders
+  List the frame unwinders currently in effect, starting with the highest
+  priority.
+
 * MI changes
 
 ** mi now reports 'no-history' as a stop reason when hitting the end of the
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index eebb6dd422a..7b128053b5a 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -40986,6 +40986,10 @@ with the DWARF frame unwinders enabled.
 If DWARF frame unwinders are not supported for a particular target
 architecture, then enabling this flag does not cause them to be used.
 
+@kindex maint info frame-unwinders
+@item maint info frame-unwinders
+List the frame unwinders currently in effect, starting with the highest priority.
+
 @kindex maint set worker-threads
 @kindex maint show worker-threads
 @item maint set worker-threads
diff --git a/gdb/frame-unwind.c b/gdb/frame-unwind.c
index b708c64f967..76601faa479 100644
--- a/gdb/frame-unwind.c
+++ b/gdb/frame-unwind.c
@@ -28,6 +28,7 @@
 #include "target.h"
 #include "gdbarch.h"
 #include "dwarf2/frame-tailcall.h"
+#include "cli/cli-cmds.h"
 
 struct frame_unwind_table_entry
 {
@@ -337,3 +338,34 @@ frame_unwind_got_address (frame_info_ptr frame, int regnum,
 	     register_type (gdbarch, regnum), addr);
   return reg_val;
 }
+
+/* Implement "maintenance info frame-unwinders" command.  */
+
+static void
+maintenance_info_frame_unwinders (const char *args, int from_tty)
+{
+  struct gdbarch *gdbarch = target_gdbarch ();
+  struct frame_unwind_table *table = get_frame_unwind_table (gdbarch);
+
+  for (struct frame_unwind_table_entry *entry = table->list; entry != NULL;
+       entry = entry->next)
+    {
+      const char *name = entry->unwinder->name;
+      const char *type = frame_type_str (entry->unwinder->type);
+
+      gdb_printf (gdb_stdout, "%-16s\t%-16s\n", name, type);
+    }
+}
+
+void _initialize_frame_unwind ();
+void
+_initialize_frame_unwind ()
+{
+  /* Add "maint info frame-unwinders".  */
+  add_cmd ("frame-unwinders",
+	   class_maintenance,
+	   maintenance_info_frame_unwinders,
+	   _("List the frame unwinders currently in effect, "
+	     "starting with the highest priority."),
+	   &maintenanceinfolist);
+}
diff --git a/gdb/frame.c b/gdb/frame.c
index 9235a2ceb38..c69a3ea0cb0 100644
--- a/gdb/frame.c
+++ b/gdb/frame.c
@@ -439,9 +439,9 @@ frame_id::to_string () const
   return res;
 }
 
-/* Return a string representation of TYPE.  */
+/* See frame.h.  */
 
-static const char *
+const char *
 frame_type_str (frame_type type)
 {
   switch (type)
diff --git a/gdb/frame.h b/gdb/frame.h
index 4a99bd660df..6ed8db0af56 100644
--- a/gdb/frame.h
+++ b/gdb/frame.h
@@ -203,6 +203,10 @@ enum frame_type
   SENTINEL_FRAME
 };
 
+/* Return a string representation of TYPE.  */
+
+extern const char *frame_type_str (frame_type type);
+
 /* A wrapper for "frame_info *".  frame_info objects are invalidated
    whenever reinit_frame_cache is called.  This class arranges to
    invalidate the pointer when appropriate.  This is done to help

base-commit: aa1807419ba0b6fa4a8b497babc1c89b27e667e5
-- 
2.35.3