-
Notifications
You must be signed in to change notification settings - Fork 774
Expand file tree
/
Copy pathManagedType.cs
More file actions
267 lines (225 loc) · 10.4 KB
/
ManagedType.cs
File metadata and controls
267 lines (225 loc) · 10.4 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
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Runtime.InteropServices;
using System.Linq;
namespace Python.Runtime
{
/// <summary>
/// Common base class for all objects that are implemented in managed
/// code. It defines the common fields that associate CLR and Python
/// objects and common utilities to convert between those identities.
/// </summary>
[Serializable]
internal abstract class ManagedType
{
/// <summary>
/// Given a Python object, return the associated managed object or null.
/// </summary>
internal static ManagedType? GetManagedObject(BorrowedReference ob)
{
if (ob != null)
{
BorrowedReference tp = Runtime.PyObject_TYPE(ob);
var flags = PyType.GetFlags(tp);
if ((flags & TypeFlags.HasClrInstance) != 0)
{
var gc = TryGetGCHandle(ob, tp);
return (ManagedType?)gc?.Target;
}
}
return null;
}
internal static bool IsInstanceOfManagedType(BorrowedReference ob)
{
if (ob != null)
{
BorrowedReference tp = Runtime.PyObject_TYPE(ob);
if (tp == Runtime.PyTypeType || tp == Runtime.PyCLRMetaType)
{
tp = ob;
}
return IsManagedType(tp);
}
return false;
}
internal static bool IsManagedType(BorrowedReference type)
{
var flags = PyType.GetFlags(type);
return (flags & TypeFlags.HasClrInstance) != 0;
}
internal static BorrowedReference GetUnmanagedBaseType(BorrowedReference managedType)
{
Debug.Assert(managedType != null && IsManagedType(managedType));
do
{
managedType = PyType.GetBase(managedType);
Debug.Assert(managedType != null);
} while (IsManagedType(managedType));
return managedType;
}
internal unsafe static int PyVisit(BorrowedReference ob, IntPtr visit, IntPtr arg)
{
if (ob == null)
{
return 0;
}
var visitFunc = (delegate* unmanaged[Cdecl]<BorrowedReference, IntPtr, int>)(visit);
return visitFunc(ob, arg);
}
internal static unsafe void DecrefTypeAndFree(StolenReference ob)
{
if (ob == null) throw new ArgumentNullException(nameof(ob));
var borrowed = new BorrowedReference(ob.DangerousGetAddress());
var type = Runtime.PyObject_TYPE(borrowed);
var freePtr = Util.ReadIntPtr(type, TypeOffset.tp_free);
Debug.Assert(freePtr != IntPtr.Zero);
var free = (delegate* unmanaged[Cdecl]<StolenReference, void>)freePtr;
free(ob);
Runtime.XDecref(StolenReference.DangerousFromPointer(type.DangerousGetAddress()));
}
internal static int CallClear(BorrowedReference ob)
=> CallTypeClear(ob, Runtime.PyObject_TYPE(ob));
/// <summary>
/// Wrapper for calling tp_clear
/// </summary>
internal static unsafe int CallTypeClear(BorrowedReference ob, BorrowedReference tp)
{
if (ob == null) throw new ArgumentNullException(nameof(ob));
if (tp == null) throw new ArgumentNullException(nameof(tp));
var clearPtr = Util.ReadIntPtr(tp, TypeOffset.tp_clear);
if (clearPtr == IntPtr.Zero)
{
return 0;
}
var clearFunc = (delegate* unmanaged[Cdecl]<BorrowedReference, int>)clearPtr;
return clearFunc(ob);
}
internal Dictionary<string, object?>? Save(BorrowedReference ob)
{
return OnSave(ob);
}
internal void Load(BorrowedReference ob, Dictionary<string, object?>? context)
{
OnLoad(ob, context);
}
protected virtual Dictionary<string, object?>? OnSave(BorrowedReference ob) => null;
protected virtual void OnLoad(BorrowedReference ob, Dictionary<string, object?>? context) { }
/// <summary>
/// Initializes given object, or returns <c>false</c> and sets Python error on failure
/// </summary>
public virtual bool Init(BorrowedReference obj, BorrowedReference args, BorrowedReference kw)
{
// this just calls obj.__init__(*args, **kw)
using var init = Runtime.PyObject_GetAttr(obj, PyIdentifier.__init__);
Runtime.PyErr_Clear();
if (!init.IsNull())
{
using var result = Runtime.PyObject_Call(init.Borrow(), args, kw);
if (result.IsNull())
{
return false;
}
}
return true;
}
protected static void ClearObjectDict(BorrowedReference ob)
{
BorrowedReference type = Runtime.PyObject_TYPE(ob);
int instanceDictOffset = Util.ReadInt32(type, TypeOffset.tp_dictoffset);
// Debug.Assert(instanceDictOffset > 0);
if (instanceDictOffset > 0)
Runtime.Py_CLEAR(ob, instanceDictOffset);
}
protected static BorrowedReference GetObjectDict(BorrowedReference ob)
{
BorrowedReference type = Runtime.PyObject_TYPE(ob);
int instanceDictOffset = Util.ReadInt32(type, TypeOffset.tp_dictoffset);
Debug.Assert(instanceDictOffset > 0);
return Util.ReadRef(ob, instanceDictOffset);
}
protected static void SetObjectDict(BorrowedReference ob, StolenReference value)
{
if (value.Pointer == IntPtr.Zero) throw new ArgumentNullException(nameof(value));
SetObjectDictNullable(ob, value.AnalyzerWorkaround());
}
protected static void SetObjectDictNullable(BorrowedReference ob, StolenReference value)
{
BorrowedReference type = Runtime.PyObject_TYPE(ob);
int instanceDictOffset = Util.ReadInt32(type, TypeOffset.tp_dictoffset);
Debug.Assert(instanceDictOffset > 0);
Runtime.ReplaceReference(ob, instanceDictOffset, value.AnalyzerWorkaround());
}
internal static void GetGCHandle(BorrowedReference reflectedClrObject, BorrowedReference type, out IntPtr handle)
{
Debug.Assert(reflectedClrObject != null);
Debug.Assert(IsManagedType(type) || IsManagedType(reflectedClrObject));
Debug.Assert(Runtime.PyObject_TypeCheck(reflectedClrObject, type));
int gcHandleOffset = Util.ReadInt32(type, Offsets.tp_clr_inst_offset);
Debug.Assert(gcHandleOffset > 0);
handle = Util.ReadIntPtr(reflectedClrObject, gcHandleOffset);
}
internal static GCHandle? TryGetGCHandle(BorrowedReference reflectedClrObject, BorrowedReference type)
{
GetGCHandle(reflectedClrObject, type, out IntPtr handle);
return handle == IntPtr.Zero ? null : (GCHandle)handle;
}
internal static GCHandle? TryGetGCHandle(BorrowedReference reflectedClrObject)
{
BorrowedReference reflectedType = Runtime.PyObject_TYPE(reflectedClrObject);
return TryGetGCHandle(reflectedClrObject, reflectedType);
}
internal static GCHandle GetGCHandle(BorrowedReference reflectedClrObject)
=> TryGetGCHandle(reflectedClrObject) ?? throw new InvalidOperationException();
internal static GCHandle GetGCHandle(BorrowedReference reflectedClrObject, BorrowedReference type)
=> TryGetGCHandle(reflectedClrObject, type) ?? throw new InvalidOperationException();
internal static void InitGCHandle(BorrowedReference reflectedClrObject, BorrowedReference type, GCHandle handle)
{
Debug.Assert(TryGetGCHandle(reflectedClrObject) == null);
SetGCHandle(reflectedClrObject, type: type, handle);
}
internal static void InitGCHandle(BorrowedReference reflectedClrObject, GCHandle handle)
=> InitGCHandle(reflectedClrObject, Runtime.PyObject_TYPE(reflectedClrObject), handle);
internal static void SetGCHandle(BorrowedReference reflectedClrObject, BorrowedReference type, GCHandle newHandle)
{
Debug.Assert(type != null);
Debug.Assert(reflectedClrObject != null);
Debug.Assert(IsManagedType(type) || IsManagedType(reflectedClrObject));
Debug.Assert(Runtime.PyObject_TypeCheck(reflectedClrObject, type));
int offset = Util.ReadInt32(type, Offsets.tp_clr_inst_offset);
Debug.Assert(offset > 0);
Util.WriteIntPtr(reflectedClrObject, offset, (IntPtr)newHandle);
}
internal static void SetGCHandle(BorrowedReference reflectedClrObject, GCHandle newHandle)
=> SetGCHandle(reflectedClrObject, Runtime.PyObject_TYPE(reflectedClrObject), newHandle);
internal static bool TryFreeGCHandle(BorrowedReference reflectedClrObject)
=> TryFreeGCHandle(reflectedClrObject, Runtime.PyObject_TYPE(reflectedClrObject));
internal static bool TryFreeGCHandle(BorrowedReference reflectedClrObject, BorrowedReference type)
{
Debug.Assert(type != null);
Debug.Assert(reflectedClrObject != null);
Debug.Assert(IsManagedType(type) || IsManagedType(reflectedClrObject));
Debug.Assert(Runtime.PyObject_TypeCheck(reflectedClrObject, type));
int offset = Util.ReadInt32(type, Offsets.tp_clr_inst_offset);
Debug.Assert(offset > 0);
IntPtr raw = Util.ReadIntPtr(reflectedClrObject, offset);
if (raw == IntPtr.Zero) return false;
var handle = (GCHandle)raw;
handle.Free();
Util.WriteIntPtr(reflectedClrObject, offset, IntPtr.Zero);
return true;
}
internal static class Offsets
{
static Offsets()
{
int pyTypeSize = Util.ReadInt32(Runtime.PyTypeType, TypeOffset.tp_basicsize);
if (pyTypeSize < 0) throw new InvalidOperationException();
tp_clr_inst_offset = pyTypeSize;
tp_clr_inst = tp_clr_inst_offset + IntPtr.Size;
}
public static int tp_clr_inst_offset { get; }
public static int tp_clr_inst { get; }
}
}
}