This repository was archived by the owner on Jul 22, 2023. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathfinalizer.cs
More file actions
270 lines (249 loc) · 8.54 KB
/
Copy pathfinalizer.cs
File metadata and controls
270 lines (249 loc) · 8.54 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
namespace Python.Runtime
{
public class Finalizer
{
public class CollectArgs : EventArgs
{
public int ObjectCount { get; set; }
}
public class ErrorArgs : EventArgs
{
public Exception Error { get; set; }
}
public static readonly Finalizer Instance = new Finalizer();
public event EventHandler<CollectArgs> CollectOnce;
public event EventHandler<ErrorArgs> ErrorHandler;
public int Threshold { get; set; }
public bool Enable { get; set; }
private ConcurrentQueue<IPyDisposable> _objQueue = new ConcurrentQueue<IPyDisposable>();
private bool _pending = false;
private readonly object _collectingLock = new object();
private Task _finalizerTask;
#region FINALIZER_CHECK
#if FINALIZER_CHECK
private readonly object _queueLock = new object();
public bool RefCountValidationEnabled { get; set; } = true;
#else
public readonly bool RefCountValidationEnabled = false;
#endif
// Keep these declarations for compat even no FINALIZER_CHECK
public class IncorrectFinalizeArgs : EventArgs
{
public IntPtr Handle { get; internal set; }
public ICollection<IPyDisposable> ImpactedObjects { get; internal set; }
}
public class IncorrectRefCountException : Exception
{
public IntPtr PyPtr { get; internal set; }
private string _message;
public override string Message => _message;
public IncorrectRefCountException(IntPtr ptr)
{
PyPtr = ptr;
IntPtr pyname = Runtime.PyObject_Unicode(PyPtr);
string name = Runtime.GetManagedString(pyname);
Runtime.XDecref(pyname);
_message = $"{name} may has a incorrect ref count";
}
}
public delegate bool IncorrectRefCntHandler(object sender, IncorrectFinalizeArgs e);
public event IncorrectRefCntHandler IncorrectRefCntResolver;
public bool ThrowIfUnhandleIncorrectRefCount { get; set; } = true;
#endregion
private Finalizer()
{
Enable = true;
Threshold = 200;
}
public void Collect(bool forceDispose = true)
{
if (Instance._finalizerTask != null
&& !Instance._finalizerTask.IsCompleted)
{
var ts = PythonEngine.BeginAllowThreads();
Instance._finalizerTask.Wait();
PythonEngine.EndAllowThreads(ts);
}
else if (forceDispose)
{
Instance.DisposeAll();
}
}
public List<WeakReference> GetCollectedObjects()
{
return _objQueue.Select(T => new WeakReference(T)).ToList();
}
internal void AddFinalizedObject(IPyDisposable obj)
{
if (!Enable)
{
return;
}
if (Runtime.Py_IsInitialized() == 0)
{
// XXX: Memory will leak if a PyObject finalized after Python shutdown,
// for avoiding that case, user should call GC.Collect manual before shutdown.
return;
}
#if FINALIZER_CHECK
lock (_queueLock)
#endif
{
_objQueue.Enqueue(obj);
}
GC.ReRegisterForFinalize(obj);
if (!_pending && _objQueue.Count >= Threshold)
{
AddPendingCollect();
}
}
internal static void Shutdown()
{
if (Runtime.Py_IsInitialized() == 0)
{
Instance._objQueue = new ConcurrentQueue<IPyDisposable>();
return;
}
Instance.Collect(forceDispose: true);
}
private void AddPendingCollect()
{
if(Monitor.TryEnter(_collectingLock))
{
try
{
if (!_pending)
{
_pending = true;
// should already be complete but just in case
_finalizerTask?.Wait();
_finalizerTask = Task.Factory.StartNew(() =>
{
using (Py.GIL())
{
Instance.DisposeAll();
_pending = false;
}
});
}
}
finally
{
Monitor.Exit(_collectingLock);
}
}
}
private void DisposeAll()
{
CollectOnce?.Invoke(this, new CollectArgs()
{
ObjectCount = _objQueue.Count
});
#if FINALIZER_CHECK
lock (_queueLock)
#endif
{
#if FINALIZER_CHECK
ValidateRefCount();
#endif
IPyDisposable obj;
while (_objQueue.TryDequeue(out obj))
{
try
{
obj.Dispose();
Runtime.CheckExceptionOccurred();
}
catch (Exception e)
{
// We should not bother the main thread
ErrorHandler?.Invoke(this, new ErrorArgs()
{
Error = e
});
}
}
}
}
#if FINALIZER_CHECK
private void ValidateRefCount()
{
if (!RefCountValidationEnabled)
{
return;
}
var counter = new Dictionary<IntPtr, long>();
var holdRefs = new Dictionary<IntPtr, long>();
var indexer = new Dictionary<IntPtr, List<IPyDisposable>>();
foreach (var obj in _objQueue)
{
IntPtr[] handles = obj.GetTrackedHandles();
foreach (var handle in handles)
{
if (handle == IntPtr.Zero)
{
continue;
}
if (!counter.ContainsKey(handle))
{
counter[handle] = 0;
}
counter[handle]++;
if (!holdRefs.ContainsKey(handle))
{
holdRefs[handle] = Runtime.Refcount(handle);
}
List<IPyDisposable> objs;
if (!indexer.TryGetValue(handle, out objs))
{
objs = new List<IPyDisposable>();
indexer.Add(handle, objs);
}
objs.Add(obj);
}
}
foreach (var pair in counter)
{
IntPtr handle = pair.Key;
long cnt = pair.Value;
// Tracked handle's ref count is larger than the object's holds
// it may take an unspecified behaviour if it decref in Dispose
if (cnt > holdRefs[handle])
{
var args = new IncorrectFinalizeArgs()
{
Handle = handle,
ImpactedObjects = indexer[handle]
};
bool handled = false;
if (IncorrectRefCntResolver != null)
{
var funcList = IncorrectRefCntResolver.GetInvocationList();
foreach (IncorrectRefCntHandler func in funcList)
{
if (func(this, args))
{
handled = true;
break;
}
}
}
if (!handled && ThrowIfUnhandleIncorrectRefCount)
{
throw new IncorrectRefCountException(handle);
}
}
// Make sure no other references for PyObjects after this method
indexer[handle].Clear();
}
indexer.Clear();
}
#endif
}
}