HPCC-18841 Embedded python may lock up at process termination

This can cause issues for eclagent processes in particular Signed-off-by: Richard Chapman <rchapman@hpccsystems.com>
hpcc-systems · Dec 5, 2017 · b33bca5 · b33bca5
1 parent 60512ee
commit b33bca5
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/plugins/py3embed/py3embed.cpp b/plugins/py3embed/py3embed.cpp
@@ -252,6 +252,8 @@ static void releaseContext()
 
 // Use a global object to ensure that the Python interpreter is initialized on main thread
 
+static HINSTANCE keepLoadedHandle;
+
 static class Python3xGlobalState
 {
 public:
@@ -289,6 +291,9 @@ static class Python3xGlobalState
     }
     ~Python3xGlobalState()
     {
+        if (keepLoadedHandle)
+            FreeSharedObject(keepLoadedHandle);  // Must be process termination - ok to free now (and helps stop lockups at closedown in some Python libraries eg Tensorflow).
+
         if (threadContext)
             delete threadContext;   // The one on the main thread won't get picked up by the thread hook mechanism
         threadContext = NULL;
@@ -493,7 +498,7 @@ MODULE_INIT(INIT_PRIORITY_STANDARD)
                     if (tail)
                     {
                         tail[strlen(SharedObjectExtension)] = 0;
-                        HINSTANCE h = LoadSharedObject(fullName, false, false);
+                        keepLoadedHandle = LoadSharedObject(fullName, false, false);
                         break;
                     }
                 }

diff --git a/plugins/pyembed/pyembed.cpp b/plugins/pyembed/pyembed.cpp
@@ -245,6 +245,8 @@ static void releaseContext()
 
 // Use a global object to ensure that the Python interpreter is initialized on main thread
 
+static HINSTANCE keepLoadedHandle;
+
 static class Python27GlobalState
 {
 public:
@@ -282,6 +284,9 @@ static class Python27GlobalState
     }
     ~Python27GlobalState()
     {
+        if (keepLoadedHandle)
+            FreeSharedObject(keepLoadedHandle);  // Must be process termination - ok to free now (and helps stop lockups at closedown in some Python libraries eg Tensorflow).
+
         if (threadContext)
             delete threadContext;   // The one on the main thread won't get picked up by the thread hook mechanism
         threadContext = NULL;
@@ -458,7 +463,7 @@ static class Python27GlobalState
 
 MODULE_INIT(INIT_PRIORITY_STANDARD)
 {
-    // Make sure we are never unloaded (as Python may crash if we are)
+    // Make sure we are never dynamically unloaded (as Python may crash if we are)
     // we do this by doing a dynamic load of the pyembed library
     // This also allows eclcc to be able to use the library for constant folding
 #ifdef _WIN32
@@ -477,8 +482,7 @@ MODULE_INIT(INIT_PRIORITY_STANDARD)
     StringBuffer modname;
     if (findLoadedModule(modname, "libpy2embed"))
     {
-        HINSTANCE h = LoadSharedObject(modname, false, false);
-        // Deliberately leak this handle
+        keepLoadedHandle = LoadSharedObject(modname, false, false);
     }
 #endif
     return true;