gdb/python: implement the print_insn extension language hook
authorAndrew Burgess <andrew.burgess@embecosm.com>
Fri, 17 Sep 2021 17:12:34 +0000 (18:12 +0100)
committerAndrew Burgess <aburgess@redhat.com>
Wed, 15 Jun 2022 08:44:54 +0000 (09:44 +0100)
commit15e15b2d9cd3b1db68f99cd3b047352142ddfd1c
tree6bc04a49dbf8d60839ec0d73638eee4803acd559
parente4ae302562aba1bd166919d76341fb631e2d470a
gdb/python: implement the print_insn extension language hook

This commit extends the Python API to include disassembler support.

The motivation for this commit was to provide an API by which the user
could write Python scripts that would augment the output of the
disassembler.

To achieve this I have followed the model of the existing libopcodes
disassembler, that is, instructions are disassembled one by one.  This
does restrict the type of things that it is possible to do from a
Python script, i.e. all additional output has to fit on a single line,
but this was all I needed, and creating something more complex would,
I think, require greater changes to how GDB's internal disassembler
operates.

The disassembler API is contained in the new gdb.disassembler module,
which defines the following classes:

  DisassembleInfo

      Similar to libopcodes disassemble_info structure, has read-only
  properties: address, architecture, and progspace.  And has methods:
  __init__, read_memory, and is_valid.

      Each time GDB wants an instruction disassembled, an instance of
  this class is passed to a user written disassembler function, by
  reading the properties, and calling the methods (and other support
  methods in the gdb.disassembler module) the user can perform and
  return the disassembly.

  Disassembler

      This is a base-class which user written disassemblers should
  inherit from.  This base class provides base implementations of
  __init__ and __call__ which the user written disassembler should
  override.

  DisassemblerResult

      This class can be used to hold the result of a call to the
  disassembler, it's really just a wrapper around a string (the text
  of the disassembled instruction) and a length (in bytes).  The user
  can return an instance of this class from Disassembler.__call__ to
  represent the newly disassembled instruction.

The gdb.disassembler module also provides the following functions:

  register_disassembler

      This function registers an instance of a Disassembler sub-class
  as a disassembler, either for one specific architecture, or, as a
  global disassembler for all architectures.

  builtin_disassemble

      This provides access to GDB's builtin disassembler.  A common
  use case that I see is augmenting the existing disassembler output.
  The user code can call this function to have GDB disassemble the
  instruction in the normal way.  The user gets back a
  DisassemblerResult object, which they can then read in order to
  augment the disassembler output in any way they wish.

      This function also provides a mechanism to intercept the
  disassemblers reads of memory, thus the user can adjust what GDB
  sees when it is disassembling.

The included documentation provides a more detailed description of the
API.

There is also a new CLI command added:

  maint info python-disassemblers

This command is defined in the Python gdb.disassemblers module, and
can be used to list the currently registered Python disassemblers.
12 files changed:
gdb/Makefile.in
gdb/NEWS
gdb/data-directory/Makefile.in
gdb/doc/gdb.texinfo
gdb/doc/python.texi
gdb/python/lib/gdb/disassembler.py [new file with mode: 0644]
gdb/python/py-disasm.c [new file with mode: 0644]
gdb/python/python-internal.h
gdb/python/python.c
gdb/testsuite/gdb.python/py-disasm.c [new file with mode: 0644]
gdb/testsuite/gdb.python/py-disasm.exp [new file with mode: 0644]
gdb/testsuite/gdb.python/py-disasm.py [new file with mode: 0644]