[v2,3/6] Introduce gdb.interrupt
Checks
Commit Message
DAP cancellation needs a way to interrupt whatever is happening on
gdb's main thread -- whether that is the inferior, a gdb CLI command,
or Python code.
This patch adds a new gdb.interrupt() function for this purpose. It
simply sets the quit flag and lets gdb do the rest.
No tests in this patch -- instead this is tested via the DAP
cancellation tests.
Reviewed-By: Eli Zaretskii <eliz@gnu.org>
Reviewed-By: Kévin Le Gouguec <legouguec@adacore.com>
---
gdb/NEWS | 3 +++
gdb/doc/python.texi | 11 +++++++++++
gdb/python/python.c | 19 +++++++++++++++++++
3 files changed, 33 insertions(+)
Comments
> From: Tom Tromey <tromey@adacore.com>
> Date: Mon, 11 Dec 2023 09:02:20 -0700
> Cc: Eli Zaretskii <eliz@gnu.org>,
> Kévin Le Gouguec <legouguec@adacore.com>
>
> DAP cancellation needs a way to interrupt whatever is happening on
> gdb's main thread -- whether that is the inferior, a gdb CLI command,
> or Python code.
>
> This patch adds a new gdb.interrupt() function for this purpose. It
> simply sets the quit flag and lets gdb do the rest.
>
> No tests in this patch -- instead this is tested via the DAP
> cancellation tests.
>
> Reviewed-By: Eli Zaretskii <eliz@gnu.org>
> Reviewed-By: Kévin Le Gouguec <legouguec@adacore.com>
> ---
> gdb/NEWS | 3 +++
> gdb/doc/python.texi | 11 +++++++++++
> gdb/python/python.c | 19 +++++++++++++++++++
> 3 files changed, 33 insertions(+)
Thanks, the documentation parts are approved.
Reviewed-By: Eli Zaretskii <eliz@gnu.org>
@@ -75,6 +75,9 @@ show remote thread-options-packet
sub-classed to create handlers for objfiles with missing debug
information.
+ ** New function gdb.interrupt(), that interrupts GDB as if the user
+ typed control-c.
+
* Debugger Adapter Protocol changes
** GDB now emits the "process" event.
@@ -664,6 +664,17 @@ this an easy-to-use drop-in replacement for creating threads that will
work well in @value{GDBN}.
@end deftp
+@defun gdb.interrupt ()
+This causes @value{GDBN} to react as if the user had typed a control-C
+character at the terminal. That is, if the inferior is running, it is
+interrupted; if a @value{GDBN} command is executing, it is stopped;
+and if a Python command is running, @code{KeyboardInterrupt} will be
+raised.
+
+Unlike most Python APIs in @value{GDBN}, @code{interrupt} is
+thread-safe.
+@end defun
+
@defun gdb.post_event (event)
Put @var{event}, a callable object taking no arguments, into
@value{GDBN}'s internal event queue. This callable will be invoked at
@@ -1118,6 +1118,23 @@ gdbpy_post_event (PyObject *self, PyObject *args)
Py_RETURN_NONE;
}
+/* Interrupt the current operation on the main thread. */
+static PyObject *
+gdbpy_interrupt (PyObject *self, PyObject *args)
+{
+ {
+ /* Make sure the interrupt isn't delivered immediately somehow.
+ This probably is not truly needed, but at the same time it
+ seems more clear to be explicit about the intent. */
+ gdbpy_allow_threads temporarily_exit_python;
+ scoped_disable_cooperative_sigint_handling no_python_sigint;
+
+ set_quit_flag ();
+ }
+
+ Py_RETURN_NONE;
+}
+
/* This is the extension_language_ops.before_prompt "method". */
@@ -2678,6 +2695,8 @@ Parse String as an expression, evaluate it, and return the result as a Value."
{ "post_event", gdbpy_post_event, METH_VARARGS,
"Post an event into gdb's event loop." },
+ { "interrupt", gdbpy_interrupt, METH_NOARGS,
+ "Interrupt gdb's current operation." },
{ "target_charset", gdbpy_target_charset, METH_NOARGS,
"target_charset () -> string.\n\