[RFC] Release the GIL while running a gdb command or expression

Tom Tromey
2018-09-15T04:07:39Z

PR python/23615 points out that gdb.execute_gdb_command does not
release the Python GIL. This means that, while the gdb command is
running, other Python threads do not run.

This patch solves the problem by introducing a new RAII class that can
be used to temporarily release and then re-acquire the GIL, then puts
this into the appropriate places in execute_gdb_command and
gdbpy_parse_and_eval.

The main issue with this patch is that I could not think of a non-racy
way to test it. Any ideas?

gdb/ChangeLog
2018-09-07 Tom Tromey <tom@tromey.com>

PR python/23615:
* python/python.c (execute_gdb_command): Use gdbpy_allow_threads.
(gdbpy_parse_and_eval): Likewise.
* python/python-internal.h (gdbpy_allow_threads): New class.
---
gdb/ChangeLog | 7 +++++++
gdb/python/python-internal.h | 25 +++++++++++++++++++++++++
gdb/python/python.c | 3 +++
3 files changed, 35 insertions(+)

diff --git a/gdb/python/python-internal.h b/gdb/python/python-internal.h
index 785ad171511..9041fbeab3b 100644
--- a/gdb/python/python-internal.h
+++ b/gdb/python/python-internal.h
@@ -647,6 +647,31 @@ class gdbpy_enter_varobj : public gdbpy_enter

};

+/* The opposite of gdb_enter: this releases the GIL around a region,
+ allowing other Python threads to run. No Python APIs may be used
+ while this is active. */
+class gdbpy_allow_threads
+{
+public:
+
+ gdbpy_allow_threads ()
+ : m_save (PyEval_SaveThread ())
+ {
+ gdb_assert (m_save != nullptr);
+ }
+
+ ~gdbpy_allow_threads ()
+ {
+ PyEval_RestoreThread (m_save);
+ }
+
+ DISABLE_COPY_AND_ASSIGN (gdbpy_allow_threads);
+
+private:
+
+ PyThreadState *m_save;
+};
+
extern struct gdbarch *python_gdbarch;
extern const struct language_defn *python_language;

diff --git a/gdb/python/python.c b/gdb/python/python.c
index e89c90f8d9f..ca0c7478e91 100644
--- a/gdb/python/python.c
+++ b/gdb/python/python.c
@@ -586,6 +586,8 @@ execute_gdb_command (PyObject *self, PyObject *args, PyObject *kw)

TRY
{
+ gdbpy_allow_threads allow_threads;
+
struct interp *interp;

std::string arg_copy = arg;
@@ -934,6 +936,7 @@ gdbpy_parse_and_eval (PyObject *self, PyObject *args)

TRY
{
+ gdbpy_allow_threads allow_threads;
result = parse_and_eval (expr_str);
}
CATCH (except, RETURN_MASK_ALL)
--
2.17.1