allow GIL state debugging; require GILState to be properly disposed

lostmsu · lostmsu · commit 1e5338fefb8b · 2021-03-10T13:38:28.000-08:00
#1389 (comment)
diff --git a/src/runtime/pythonengine.cs b/src/runtime/pythonengine.cs
@@ -4,6 +4,7 @@
 using System.Linq;
 using System.Reflection;
 using System.Runtime.InteropServices;
+using System.Threading;
 
 namespace Python.Runtime
 {
@@ -51,6 +52,9 @@ public static bool IsInitialized
             get { return initialized; }
         }
 
+        /// <summary>Set to <c>true</c> to enable GIL debugging assistance.</summary>
+        public static bool DebugGIL { get; set; } = false;
+
         internal static DelegateManager DelegateManager
         {
             get
@@ -633,7 +637,7 @@ public static GILState GIL()
                 PythonEngine.Initialize();
             }
 
-            return new GILState();
+            return PythonEngine.DebugGIL ? new DebugGILState() : new GILState();
         }
 
         public static PyScope CreateScope()
@@ -658,7 +662,7 @@ internal GILState()
                 state = PythonEngine.AcquireLock();
             }
 
-            public void Dispose()
+            public virtual void Dispose()
             {
                 if (this.isDisposed) return;
 
@@ -669,7 +673,23 @@ public void Dispose()
 
             ~GILState()
             {
-                Dispose();
+                throw new InvalidOperationException("GIL must always be released, and it must be released from the same thread that acquired it.");
+            }
+        }
+
+        public class DebugGILState : GILState
+        {
+            readonly Thread owner;
+            internal DebugGILState() : base()
+            {
+                this.owner = Thread.CurrentThread;
+            }
+            public override void Dispose()
+            {
+                if (this.owner != Thread.CurrentThread)
+                    throw new InvalidOperationException("GIL must always be released from the same thread, that acquired it");
+
+                base.Dispose();
             }
         }
 

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`using System.Linq;`
`5`	`5`	`using System.Reflection;`
`6`	`6`	`using System.Runtime.InteropServices;`
	`7`	`+using System.Threading;`
`7`	`8`
`8`	`9`	`namespace Python.Runtime`
`9`	`10`	`{`
`@@ -51,6 +52,9 @@ public static bool IsInitialized`
`51`	`52`	`get { return initialized; }`
`52`	`53`	`}`
`53`	`54`
	`55`	`+ /// <summary>Set to <c>true</c> to enable GIL debugging assistance.</summary>`
	`56`	`+ public static bool DebugGIL { get; set; } = false;`
	`57`	`+`
`54`	`58`	`internal static DelegateManager DelegateManager`
`55`	`59`	`{`
`56`	`60`	`get`
`@@ -633,7 +637,7 @@ public static GILState GIL()`
`633`	`637`	`PythonEngine.Initialize();`
`634`	`638`	`}`
`635`	`639`
`636`		`- return new GILState();`
	`640`	`+ return PythonEngine.DebugGIL ? new DebugGILState() : new GILState();`
`637`	`641`	`}`
`638`	`642`
`639`	`643`	`public static PyScope CreateScope()`
`@@ -658,7 +662,7 @@ internal GILState()`
`658`	`662`	`state = PythonEngine.AcquireLock();`
`659`	`663`	`}`
`660`	`664`
`661`		`- public void Dispose()`
	`665`	`+ public virtual void Dispose()`
`662`	`666`	`{`
`663`	`667`	`if (this.isDisposed) return;`
`664`	`668`
`@@ -669,7 +673,23 @@ public void Dispose()`
`669`	`673`
`670`	`674`	`~GILState()`
`671`	`675`	`{`
`672`		`- Dispose();`
	`676`	`+ throw new InvalidOperationException("GIL must always be released, and it must be released from the same thread that acquired it.");`
	`677`	`+ }`
	`678`	`+ }`
	`679`	`+`
	`680`	`+ public class DebugGILState : GILState`
	`681`	`+ {`
	`682`	`+ readonly Thread owner;`
	`683`	`+ internal DebugGILState() : base()`
	`684`	`+ {`
	`685`	`+ this.owner = Thread.CurrentThread;`
	`686`	`+ }`
	`687`	`+ public override void Dispose()`
	`688`	`+ {`
	`689`	`+ if (this.owner != Thread.CurrentThread)`
	`690`	`+ throw new InvalidOperationException("GIL must always be released from the same thread, that acquired it");`
	`691`	`+`
	`692`	`+ base.Dispose();`
`673`	`693`	`}`
`674`	`694`	`}`
`675`	`695`