[binutils-gdb] Introduce gdbpy_enter

[Tom Tromey <tromey at sourceware dot org>]

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=4ecee2c47da3e91c0571683acb5cfb8400402663

commit 4ecee2c47da3e91c0571683acb5cfb8400402663
Author: Tom Tromey <tom@tromey.com>
Date:   Mon Nov 7 15:56:57 2016 -0700

    Introduce gdbpy_enter
    
    This introduces gdbpy_enter, a class that can be used to acquire and
    release the Python GIL, and also set other Python-related globals used
    by gdb.  ensure_python_env is rewritten in terms of this new class.
    
    2017-01-10  Tom Tromey  <tom@tromey.com>
    
    	* python/python.c (gdbpy_enter): New constructor.
    	(~gdbpy_enter): New destructor.
    	(restore_python_env, ensure_python_env): Rewrite.
    	* python/python-internal.h (gdbpy_enter): New class.

Diff:
---
 gdb/ChangeLog                |  7 +++++
 gdb/python/python-internal.h | 25 ++++++++++++++++
 gdb/python/python.c          | 69 ++++++++++++++++++++------------------------
 3 files changed, 64 insertions(+), 37 deletions(-)

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index ca77585..b64e9e9 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,5 +1,12 @@
 2017-01-10  Tom Tromey  <tom@tromey.com>
 
+	* python/python.c (gdbpy_enter): New constructor.
+	(~gdbpy_enter): New destructor.
+	(restore_python_env, ensure_python_env): Rewrite.
+	* python/python-internal.h (gdbpy_enter): New class.
+
+2017-01-10  Tom Tromey  <tom@tromey.com>
+
 	* python/py-symbol.c (gdbpy_lookup_symbol): Use gdbpy_ref.
 
 2017-01-10  Tom Tromey  <tom@tromey.com>
diff --git a/gdb/python/python-internal.h b/gdb/python/python-internal.h
index 4b12aaf..a3b9b74 100644
--- a/gdb/python/python-internal.h
+++ b/gdb/python/python-internal.h
@@ -501,6 +501,31 @@ int gdbpy_initialize_unwind (void)
 struct cleanup *make_cleanup_py_decref (PyObject *py);
 struct cleanup *make_cleanup_py_xdecref (PyObject *py);
 
+/* Called before entering the Python interpreter to install the
+   current language and architecture to be used for Python values.
+   Also set the active extension language for GDB so that SIGINT's
+   are directed our way, and if necessary install the right SIGINT
+   handler.  */
+class gdbpy_enter
+{
+ public:
+
+  gdbpy_enter (struct gdbarch *gdbarch, const struct language_defn *language);
+
+  ~gdbpy_enter ();
+
+  gdbpy_enter (const gdbpy_enter &) = delete;
+  gdbpy_enter &operator= (const gdbpy_enter &) = delete;
+
+ private:
+
+  struct active_ext_lang_state *m_previous_active;
+  PyGILState_STATE m_state;
+  struct gdbarch *m_gdbarch;
+  const struct language_defn *m_language;
+  PyObject *m_error_type, *m_error_value, *m_error_traceback;
+};
+
 struct cleanup *ensure_python_env (struct gdbarch *gdbarch,
 				   const struct language_defn *language);
 
diff --git a/gdb/python/python.c b/gdb/python/python.c
index a2f3624..c01cc8b 100644
--- a/gdb/python/python.c
+++ b/gdb/python/python.c
@@ -202,23 +202,28 @@ const struct extension_language_ops python_extension_ops =
 struct gdbarch *python_gdbarch;
 const struct language_defn *python_language;
 
-/* Restore global language and architecture and Python GIL state
-   when leaving the Python interpreter.  */
-
-struct python_env
+gdbpy_enter::gdbpy_enter  (struct gdbarch *gdbarch,
+			   const struct language_defn *language)
+: m_gdbarch (python_gdbarch),
+  m_language (python_language)
 {
-  struct active_ext_lang_state *previous_active;
-  PyGILState_STATE state;
-  struct gdbarch *gdbarch;
-  const struct language_defn *language;
-  PyObject *error_type, *error_value, *error_traceback;
-};
+  /* We should not ever enter Python unless initialized.  */
+  if (!gdb_python_initialized)
+    error (_("Python not initialized"));
 
-static void
-restore_python_env (void *p)
-{
-  struct python_env *env = (struct python_env *)p;
+  m_previous_active = set_active_ext_lang (&extension_language_python);
 
+  m_state = PyGILState_Ensure ();
+
+  python_gdbarch = gdbarch;
+  python_language = language;
+
+  /* Save it and ensure ! PyErr_Occurred () afterwards.  */
+  PyErr_Fetch (&m_error_type, &m_error_value, &m_error_traceback);
+}
+
+gdbpy_enter::~gdbpy_enter ()
+{
   /* Leftover Python error is forbidden by Python Exception Handling.  */
   if (PyErr_Occurred ())
     {
@@ -227,15 +232,21 @@ restore_python_env (void *p)
       warning (_("internal error: Unhandled Python exception"));
     }
 
-  PyErr_Restore (env->error_type, env->error_value, env->error_traceback);
+  PyErr_Restore (m_error_type, m_error_value, m_error_traceback);
 
-  PyGILState_Release (env->state);
-  python_gdbarch = env->gdbarch;
-  python_language = env->language;
+  PyGILState_Release (m_state);
+  python_gdbarch = m_gdbarch;
+  python_language = m_language;
 
-  restore_active_ext_lang (env->previous_active);
+  restore_active_ext_lang (m_previous_active);
+}
+
+static void
+restore_python_env (void *p)
+{
+  gdbpy_enter *env = (gdbpy_enter *) p;
 
-  xfree (env);
+  delete env;
 }
 
 /* Called before entering the Python interpreter to install the
@@ -248,23 +259,7 @@ struct cleanup *
 ensure_python_env (struct gdbarch *gdbarch,
                    const struct language_defn *language)
 {
-  struct python_env *env = XNEW (struct python_env);
-
-  /* We should not ever enter Python unless initialized.  */
-  if (!gdb_python_initialized)
-    error (_("Python not initialized"));
-
-  env->previous_active = set_active_ext_lang (&extension_language_python);
-
-  env->state = PyGILState_Ensure ();
-  env->gdbarch = python_gdbarch;
-  env->language = python_language;
-
-  python_gdbarch = gdbarch;
-  python_language = language;
-
-  /* Save it and ensure ! PyErr_Occurred () afterwards.  */
-  PyErr_Fetch (&env->error_type, &env->error_value, &env->error_traceback);
+  gdbpy_enter *env = new gdbpy_enter (gdbarch, language);
 
   return make_cleanup (restore_python_env, env);
 }