Repository navigation
Expand file tree
/
Copy pathPythonHouseKeeper.h
More file actions
265 lines (215 loc) · 6.26 KB
/
Copy pathPythonHouseKeeper.h
File metadata and controls
265 lines (215 loc) · 6.26 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
#pragma once
#include "UnrealEnginePython.h"
#include "UObject/UObjectGlobals.h"
#include "UObject/WeakObjectPtr.h"
#include "Widgets/SWidget.h"
#include "Slate/UEPySlateDelegate.h"
#include "PythonDelegate.h"
class FUnrealEnginePythonHouseKeeper
{
struct FPythonUOjectTracker
{
FWeakObjectPtr Owner;
ue_PyUObject *PyUObject;
FPythonUOjectTracker(UObject *Object, ue_PyUObject *InPyUObject)
{
Owner = FWeakObjectPtr(Object);
PyUObject = InPyUObject;
}
};
struct FPythonDelegateTracker
{
FWeakObjectPtr Owner;
UPythonDelegate *Delegate;
FPythonDelegateTracker(UPythonDelegate *DelegateToTrack, UObject *DelegateOwner) : Owner(DelegateOwner), Delegate(DelegateToTrack)
{
}
~FPythonDelegateTracker()
{
}
};
struct FPythonSWidgetDelegateTracker
{
TWeakPtr<SWidget> Owner;
TSharedPtr<FPythonSlateDelegate> Delegate;
FPythonSWidgetDelegateTracker(TSharedRef<FPythonSlateDelegate> DelegateToTrack, TSharedRef<SWidget> DelegateOwner) : Owner(DelegateOwner), Delegate(DelegateToTrack)
{
}
~FPythonSWidgetDelegateTracker()
{
}
};
public:
static FUnrealEnginePythonHouseKeeper *Get()
{
static FUnrealEnginePythonHouseKeeper *Singleton;
if (!Singleton)
{
Singleton = new FUnrealEnginePythonHouseKeeper();
// register a new delegate for the GC
#if ENGINE_MINOR_VERSION >= 18
FCoreUObjectDelegates::GetPostGarbageCollect().AddRaw(Singleton, &FUnrealEnginePythonHouseKeeper::RunGCDelegate);
#else
FCoreUObjectDelegates::PostGarbageCollect.AddRaw(Singleton, &FUnrealEnginePythonHouseKeeper::RunGCDelegate);
#endif
}
return Singleton;
}
void RunGCDelegate()
{
PyGILState_STATE state = PyGILState_Ensure();
RunGC();
PyGILState_Release(state);
}
int32 RunGC()
{
int32 Garbaged = PyUObjectsGC();
Garbaged += DelegatesGC();
return Garbaged;
}
bool IsValidPyUObject(ue_PyUObject *PyUObject)
{
if (!PyUObject)
return false;
UObject *Object = PyUObject->ue_object;
FPythonUOjectTracker *Tracker = UObjectPyMapping.Find(Object);
if (!Tracker)
{
return false;
}
if (!Tracker->Owner.IsValid())
return false;
return true;
}
void RegisterPyUObject(UObject *Object, ue_PyUObject *InPyUObject)
{
UObjectPyMapping.Add(Object, FPythonUOjectTracker(Object, InPyUObject));
}
void UnregisterPyUObject(UObject *Object)
{
UObjectPyMapping.Remove(Object);
}
ue_PyUObject *GetPyUObject(UObject *Object)
{
FPythonUOjectTracker *Tracker = UObjectPyMapping.Find(Object);
if (!Tracker)
{
return nullptr;
}
if (!Tracker->Owner.IsValid(true))
{
#if defined(UEPY_MEMORY_DEBUG)
UE_LOG(LogPython, Warning, TEXT("DEFREF'ing UObject at %p (refcnt: %d)"), Object, Tracker->PyUObject->ob_base.ob_refcnt);
#endif
Py_DECREF((PyObject *)Tracker->PyUObject);
UnregisterPyUObject(Object);
return nullptr;
}
return Tracker->PyUObject;
}
uint32 PyUObjectsGC()
{
uint32 Garbaged = 0;
TArray<UObject *> BrokenList;
for (auto &UObjectPyItem : UObjectPyMapping)
{
UObject *Object = UObjectPyItem.Key;
FPythonUOjectTracker &Tracker = UObjectPyItem.Value;
#if defined(UEPY_MEMORY_DEBUG)
UE_LOG(LogPython, Warning, TEXT("Checking for UObject at %p"), Object);
#endif
if (!Tracker.Owner.IsValid(true))
{
#if defined(UEPY_MEMORY_DEBUG)
UE_LOG(LogPython, Warning, TEXT("Removing UObject at %p (refcnt: %d)"), Object, Tracker.PyUObject->ob_base.ob_refcnt);
#endif
BrokenList.Add(Object);
Garbaged++;
}
else
{
#if defined(UEPY_MEMORY_DEBUG)
UE_LOG(LogPython, Error, TEXT("UObject at %p %s is in use"), Object, *Object->GetName());
#endif
}
}
for (UObject *Object : BrokenList)
{
FPythonUOjectTracker &Tracker = UObjectPyMapping[Object];
Py_DECREF((PyObject *)Tracker.PyUObject);
UnregisterPyUObject(Object);
}
return Garbaged;
}
int32 DelegatesGC()
{
int32 Garbaged = 0;
#if defined(UEPY_MEMORY_DEBUG)
UE_LOG(LogPython, Display, TEXT("Garbage collecting %d UObject delegates"), PyDelegatesTracker.Num());
#endif
for (int32 i = PyDelegatesTracker.Num() - 1; i >= 0; --i)
{
FPythonDelegateTracker &Tracker = PyDelegatesTracker[i];
if (!Tracker.Owner.IsValid(true))
{
Tracker.Delegate->RemoveFromRoot();
PyDelegatesTracker.RemoveAt(i);
Garbaged++;
}
}
#if defined(UEPY_MEMORY_DEBUG)
UE_LOG(LogPython, Display, TEXT("Garbage collecting %d Slate delegates"), PySlateDelegatesTracker.Num());
#endif
for (int32 i = PySlateDelegatesTracker.Num() - 1; i >= 0; --i)
{
FPythonSWidgetDelegateTracker &Tracker = PySlateDelegatesTracker[i];
if (!Tracker.Owner.IsValid())
{
PySlateDelegatesTracker.RemoveAt(i);
Garbaged++;
}
}
return Garbaged;
}
UPythonDelegate *NewDelegate(UObject *Owner, PyObject *PyCallable, UFunction *Signature)
{
UPythonDelegate *Delegate = NewObject<UPythonDelegate>();
Delegate->AddToRoot();
Delegate->SetPyCallable(PyCallable);
Delegate->SetSignature(Signature);
FPythonDelegateTracker Tracker(Delegate, Owner);
PyDelegatesTracker.Add(Tracker);
return Delegate;
}
TSharedRef<FPythonSlateDelegate> NewSlateDelegate(TSharedRef<SWidget> Owner, PyObject *PyCallable)
{
TSharedRef<FPythonSlateDelegate> Delegate = MakeShareable(new FPythonSlateDelegate());
Delegate->SetPyCallable(PyCallable);
FPythonSWidgetDelegateTracker Tracker(Delegate, Owner);
PySlateDelegatesTracker.Add(Tracker);
return Delegate;
}
TSharedRef<FPythonSlateDelegate> NewDeferredSlateDelegate(PyObject *PyCallable)
{
TSharedRef<FPythonSlateDelegate> Delegate = MakeShareable(new FPythonSlateDelegate());
Delegate->SetPyCallable(PyCallable);
return Delegate;
}
void TrackDeferredSlateDelegate(TSharedRef<FPythonSlateDelegate> Delegate, TSharedRef<SWidget> Owner)
{
FPythonSWidgetDelegateTracker Tracker(Delegate, Owner);
PySlateDelegatesTracker.Add(Tracker);
}
TSharedRef<FPythonSlateDelegate> NewStaticSlateDelegate(PyObject *PyCallable)
{
TSharedRef<FPythonSlateDelegate> Delegate = MakeShareable(new FPythonSlateDelegate());
Delegate->SetPyCallable(PyCallable);
PyStaticSlateDelegatesTracker.Add(Delegate);
return Delegate;
}
private:
TMap<UObject *, FPythonUOjectTracker> UObjectPyMapping;
TArray<FPythonDelegateTracker> PyDelegatesTracker;
TArray<FPythonSWidgetDelegateTracker> PySlateDelegatesTracker;
TArray<TSharedRef<FPythonSlateDelegate>> PyStaticSlateDelegatesTracker;
};