diff options
author | Tom Tromey <tromey@adacore.com> | 2022-06-23 11:11:36 -0600 |
---|---|---|
committer | Tom Tromey <tromey@adacore.com> | 2023-01-02 09:49:37 -0700 |
commit | de7d7cb58e6209ed11c31f635545ee2ee6ded307 (patch) | |
tree | d0681c4ad9e7207227166990d6133cca83fae24c /gdb/doc | |
parent | c43d829bca5e45c5e6c0255a549abc5766f6de7f (diff) | |
download | fsf-binutils-gdb-de7d7cb58e6209ed11c31f635545ee2ee6ded307.zip fsf-binutils-gdb-de7d7cb58e6209ed11c31f635545ee2ee6ded307.tar.gz fsf-binutils-gdb-de7d7cb58e6209ed11c31f635545ee2ee6ded307.tar.bz2 |
Initial implementation of Debugger Adapter Protocol
The Debugger Adapter Protocol is a JSON-RPC protocol that IDEs can use
to communicate with debuggers. You can find more information here:
https://microsoft.github.io/debug-adapter-protocol/
Frequently this is implemented as a shim, but it seemed to me that GDB
could implement it directly, via the Python API. This patch is the
initial implementation.
DAP is implemented as a new "interp". This is slightly weird, because
it doesn't act like an ordinary interpreter -- for example it doesn't
implement a command syntax, and doesn't use GDB's ordinary event loop.
However, this seemed like the best approach overall.
To run GDB in this mode, use:
gdb -i=dap
The DAP code will accept JSON-RPC messages on stdin and print
responses to stdout. GDB redirects the inferior's stdout to a new
pipe so that output can be encapsulated by the protocol.
The Python code uses multiple threads to do its work. Separate
threads are used for reading JSON from the client and for writing JSON
to the client. All GDB work is done in the main thread. (The first
implementation used asyncio, but this had some limitations, and so I
rewrote it to use threads instead.)
This is not a complete implementation of the protocol, but it does
implement enough to demonstrate that the overall approach works.
There is a rudimentary test suite. It uses a JSON parser written in
pure Tcl. This parser is under the same license as Tcl itself, so I
felt it was acceptable to simply import it into the tree.
There is also a bit of documentation -- just documenting the new
interpreter name.
Diffstat (limited to 'gdb/doc')
-rw-r--r-- | gdb/doc/gdb.texinfo | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index a72b2b9..ea54f25 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -29136,6 +29136,15 @@ The traditional console or command-line interpreter. This is the most often used interpreter with @value{GDBN}. With no interpreter specified at runtime, @value{GDBN} will use this interpreter. +@item dap +@cindex DAP +@cindex Debugger Adapter Protocol +When @value{GDBN} has been built with Python support, it also supports +the Debugger Adapter Protocol. This protocol can be used by a +debugger GUI or an IDE to communicate with @value{GDBN}. This +protocol is documented at +@url{https://microsoft.github.io/debug-adapter-protocol/}. + @item mi @cindex mi interpreter The newest @sc{gdb/mi} interface (currently @code{mi3}). Used primarily |