forked from pythonnet/pythonnet
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathruntime.cs
More file actions
2909 lines (2255 loc) · 156 KB
/
runtime.cs
File metadata and controls
2909 lines (2255 loc) · 156 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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
using System;
using System.Diagnostics;
using System.Diagnostics.Contracts;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading;
using System.Collections.Generic;
using Python.Runtime.Native;
using Python.Runtime.Platform;
using System.Linq;
using static System.FormattableString;
namespace Python.Runtime
{
/// <summary>
/// Encapsulates the low-level Python C API. Note that it is
/// the responsibility of the caller to have acquired the GIL
/// before calling any of these methods.
/// </summary>
public unsafe class Runtime
{
public static string PythonDLL
{
get => _PythonDll;
set
{
if (_isInitialized)
throw new InvalidOperationException("This property must be set before runtime is initialized");
_PythonDll = value;
}
}
static string _PythonDll = GetDefaultDllName();
private static string GetDefaultDllName()
{
string dll = Environment.GetEnvironmentVariable("PYTHONNET_PYDLL");
if (dll is not null) return dll;
try
{
LibraryLoader.Instance.GetFunction(IntPtr.Zero, "PyUnicode_GetMax");
return null;
} catch (MissingMethodException) { }
string verString = Environment.GetEnvironmentVariable("PYTHONNET_PYVER");
if (!Version.TryParse(verString, out var version)) return null;
return GetDefaultDllName(version);
}
private static string GetDefaultDllName(Version version)
{
string prefix = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "" : "lib";
string suffix = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
? Invariant($"{version.Major}{version.Minor}")
: Invariant($"{version.Major}.{version.Minor}");
string ext = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? ".dll"
: RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? ".dylib"
: ".so";
return prefix + "python" + suffix + ext;
}
// set to true when python is finalizing
internal static object IsFinalizingLock = new object();
internal static bool IsFinalizing;
private static bool _isInitialized = false;
internal static readonly bool Is32Bit = IntPtr.Size == 4;
// .NET core: System.Runtime.InteropServices.RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
internal static bool IsWindows = Environment.OSVersion.Platform == PlatformID.Win32NT;
internal static Version InteropVersion { get; }
= System.Reflection.Assembly.GetExecutingAssembly().GetName().Version;
public static int MainManagedThreadId { get; private set; }
public static ShutdownMode ShutdownMode { get; internal set; }
private static PyReferenceCollection _pyRefs = new PyReferenceCollection();
internal static Version PyVersion
{
get
{
using (var versionTuple = new PyTuple(PySys_GetObject("version_info")))
{
var major = Converter.ToInt32(versionTuple[0].Reference);
var minor = Converter.ToInt32(versionTuple[1].Reference);
var micro = Converter.ToInt32(versionTuple[2].Reference);
return new Version(major, minor, micro);
}
}
}
/// <summary>
/// Initialize the runtime...
/// </summary>
/// <remarks>Always call this method from the Main thread. After the
/// first call to this method, the main thread has acquired the GIL.</remarks>
internal static void Initialize(bool initSigs = false, ShutdownMode mode = ShutdownMode.Default)
{
if (_isInitialized)
{
return;
}
_isInitialized = true;
if (mode == ShutdownMode.Default)
{
mode = GetDefaultShutdownMode();
}
ShutdownMode = mode;
if (Py_IsInitialized() == 0)
{
Py_InitializeEx(initSigs ? 1 : 0);
if (PyEval_ThreadsInitialized() == 0)
{
PyEval_InitThreads();
}
// XXX: Reload mode may reduct to Soft mode,
// so even on Reload mode it still needs to save the RuntimeState
if (mode == ShutdownMode.Soft || mode == ShutdownMode.Reload)
{
RuntimeState.Save();
}
}
else
{
// If we're coming back from a domain reload or a soft shutdown,
// we have previously released the thread state. Restore the main
// thread state here.
if (mode != ShutdownMode.Extension)
{
PyGILState_Ensure();
}
}
MainManagedThreadId = Thread.CurrentThread.ManagedThreadId;
IsFinalizing = false;
InternString.Initialize();
InitPyMembers();
ABI.Initialize(PyVersion,
pyType: new BorrowedReference(PyTypeType));
GenericUtil.Reset();
PyScopeManager.Reset();
ClassManager.Reset();
ClassDerivedObject.Reset();
TypeManager.Initialize();
// Initialize modules that depend on the runtime class.
AssemblyManager.Initialize();
OperatorMethod.Initialize();
if (mode == ShutdownMode.Reload && RuntimeData.HasStashData())
{
RuntimeData.RestoreRuntimeData();
}
else
{
PyCLRMetaType = MetaType.Initialize(); // Steal a reference
ImportHook.Initialize();
}
Exceptions.Initialize();
// Need to add the runtime directory to sys.path so that we
// can find built-in assemblies like System.Data, et. al.
string rtdir = RuntimeEnvironment.GetRuntimeDirectory();
IntPtr path = PySys_GetObject("path").DangerousGetAddress();
IntPtr item = PyString_FromString(rtdir);
if (PySequence_Contains(path, item) == 0)
{
PyList_Append(new BorrowedReference(path), new BorrowedReference(item));
}
XDecref(item);
AssemblyManager.UpdatePath();
}
private static void InitPyMembers()
{
IntPtr op;
{
var builtins = GetBuiltins();
SetPyMember(ref PyNotImplemented, PyObject_GetAttrString(builtins, "NotImplemented"),
() => PyNotImplemented = IntPtr.Zero);
SetPyMember(ref PyBaseObjectType, PyObject_GetAttrString(builtins, "object"),
() => PyBaseObjectType = IntPtr.Zero);
SetPyMember(ref PyNone, PyObject_GetAttrString(builtins, "None"),
() => PyNone = IntPtr.Zero);
SetPyMember(ref PyTrue, PyObject_GetAttrString(builtins, "True"),
() => PyTrue = IntPtr.Zero);
SetPyMember(ref PyFalse, PyObject_GetAttrString(builtins, "False"),
() => PyFalse = IntPtr.Zero);
SetPyMemberTypeOf(ref PyBoolType, PyTrue,
() => PyBoolType = IntPtr.Zero);
SetPyMemberTypeOf(ref PyNoneType, PyNone,
() => PyNoneType = IntPtr.Zero);
SetPyMemberTypeOf(ref PyTypeType, PyNoneType,
() => PyTypeType = IntPtr.Zero);
op = PyObject_GetAttrString(builtins, "len");
SetPyMemberTypeOf(ref PyMethodType, op,
() => PyMethodType = IntPtr.Zero);
XDecref(op);
// For some arcane reason, builtins.__dict__.__setitem__ is *not*
// a wrapper_descriptor, even though dict.__setitem__ is.
//
// object.__init__ seems safe, though.
op = PyObject_GetAttr(PyBaseObjectType, PyIdentifier.__init__);
SetPyMemberTypeOf(ref PyWrapperDescriptorType, op,
() => PyWrapperDescriptorType = IntPtr.Zero);
XDecref(op);
SetPyMember(ref PySuper_Type, PyObject_GetAttrString(builtins, "super"),
() => PySuper_Type = IntPtr.Zero);
XDecref(builtins);
}
op = PyString_FromString("string");
SetPyMemberTypeOf(ref PyStringType, op,
() => PyStringType = IntPtr.Zero);
XDecref(op);
op = PyString_FromString("unicode");
SetPyMemberTypeOf(ref PyUnicodeType, op,
() => PyUnicodeType = IntPtr.Zero);
XDecref(op);
op = EmptyPyBytes();
SetPyMemberTypeOf(ref PyBytesType, op,
() => PyBytesType = IntPtr.Zero);
XDecref(op);
op = PyTuple_New(0);
SetPyMemberTypeOf(ref PyTupleType, op,
() => PyTupleType = IntPtr.Zero);
XDecref(op);
op = PyList_New(0);
SetPyMemberTypeOf(ref PyListType, op,
() => PyListType = IntPtr.Zero);
XDecref(op);
op = PyDict_New();
SetPyMemberTypeOf(ref PyDictType, op,
() => PyDictType = IntPtr.Zero);
XDecref(op);
op = PyInt_FromInt32(0);
SetPyMemberTypeOf(ref PyIntType, op,
() => PyIntType = IntPtr.Zero);
XDecref(op);
op = PyLong_FromLong(0);
SetPyMemberTypeOf(ref PyLongType, op,
() => PyLongType = IntPtr.Zero);
XDecref(op);
op = PyFloat_FromDouble(0);
SetPyMemberTypeOf(ref PyFloatType, op,
() => PyFloatType = IntPtr.Zero);
XDecref(op);
PyClassType = IntPtr.Zero;
PyInstanceType = IntPtr.Zero;
Error = new IntPtr(-1);
_PyObject_NextNotImplemented = Get_PyObject_NextNotImplemented();
{
using var sys = PyImport_ImportModule("sys");
SetPyMemberTypeOf(ref PyModuleType, sys.DangerousGetAddress(),
() => PyModuleType = IntPtr.Zero);
}
}
private static IntPtr Get_PyObject_NextNotImplemented()
{
IntPtr pyType = SlotHelper.CreateObjectType();
IntPtr iternext = Marshal.ReadIntPtr(pyType, TypeOffset.tp_iternext);
Runtime.XDecref(pyType);
return iternext;
}
/// <summary>
/// Tries to downgrade the shutdown mode, if possible.
/// The only possibles downgrades are:
/// Soft -> Normal
/// Reload -> Soft
/// Reload -> Normal
/// </summary>
/// <param name="mode">The desired shutdown mode</param>
/// <returns>The `mode` parameter if the downgrade is supported, the ShutdownMode
/// set at initialization otherwise.</returns>
static ShutdownMode TryDowngradeShutdown(ShutdownMode mode)
{
if (
mode == Runtime.ShutdownMode
|| mode == ShutdownMode.Normal
|| (mode == ShutdownMode.Soft && Runtime.ShutdownMode == ShutdownMode.Reload)
)
{
return mode;
}
else // we can't downgrade
{
return Runtime.ShutdownMode;
}
}
internal static void Shutdown(ShutdownMode mode)
{
if (Py_IsInitialized() == 0 || !_isInitialized)
{
return;
}
_isInitialized = false;
// If the shutdown mode specified is not the the same as the one specified
// during Initialization, we need to validate it; we can only downgrade,
// not upgrade the shutdown mode.
mode = TryDowngradeShutdown(mode);
var state = PyGILState_Ensure();
if (mode == ShutdownMode.Soft)
{
RunExitFuncs();
}
if (mode == ShutdownMode.Reload)
{
RuntimeData.Stash();
}
AssemblyManager.Shutdown();
OperatorMethod.Shutdown();
ImportHook.Shutdown();
ClearClrModules();
RemoveClrRootModule();
MoveClrInstancesOnwershipToPython();
ClassManager.DisposePythonWrappersForClrTypes();
TypeManager.RemoveTypes();
MetaType.Release();
PyCLRMetaType = IntPtr.Zero;
Exceptions.Shutdown();
Finalizer.Shutdown();
InternString.Shutdown();
if (mode != ShutdownMode.Normal && mode != ShutdownMode.Extension)
{
PyGC_Collect();
if (mode == ShutdownMode.Soft)
{
RuntimeState.Restore();
}
ResetPyMembers();
GC.Collect();
try
{
GC.WaitForFullGCComplete();
}
catch (NotImplementedException)
{
// Some clr runtime didn't implement GC.WaitForFullGCComplete yet.
}
GC.WaitForPendingFinalizers();
PyGILState_Release(state);
// Then release the GIL for good, if there is somehting to release
// Use the unchecked version as the checked version calls `abort()`
// if the current state is NULL.
if (_PyThreadState_UncheckedGet() != IntPtr.Zero)
{
PyEval_SaveThread();
}
}
else
{
ResetPyMembers();
if (mode != ShutdownMode.Extension)
{
Py_Finalize();
}
else
{
PyGILState_Release(state);
}
}
}
internal static void Shutdown()
{
var mode = ShutdownMode;
Shutdown(mode);
}
internal static ShutdownMode GetDefaultShutdownMode()
{
string modeEvn = Environment.GetEnvironmentVariable("PYTHONNET_SHUTDOWN_MODE");
if (modeEvn == null)
{
return ShutdownMode.Normal;
}
ShutdownMode mode;
if (Enum.TryParse(modeEvn, true, out mode))
{
return mode;
}
return ShutdownMode.Normal;
}
private static void RunExitFuncs()
{
PyObject atexit;
try
{
atexit = Py.Import("atexit");
}
catch (PythonException e) when (e.Is(Exceptions.ImportError))
{
// The runtime may not provided `atexit` module.
return;
}
using (atexit)
{
try
{
atexit.InvokeMethod("_run_exitfuncs").Dispose();
}
catch (PythonException e)
{
Console.Error.WriteLine(e);
}
}
}
private static void SetPyMember(ref IntPtr obj, IntPtr value, Action onRelease)
{
// XXX: For current usages, value should not be null.
PythonException.ThrowIfIsNull(value);
obj = value;
_pyRefs.Add(value, onRelease);
}
private static void SetPyMemberTypeOf(ref IntPtr obj, IntPtr value, Action onRelease)
{
var type = PyObject_Type(new BorrowedReference(value)).DangerousMoveToPointer();
SetPyMember(ref obj, type, onRelease);
}
private static void ResetPyMembers()
{
_pyRefs.Release();
}
private static void ClearClrModules()
{
var modules = PyImport_GetModuleDict();
var items = PyDict_Items(modules);
long length = PyList_Size(items);
for (long i = 0; i < length; i++)
{
var item = PyList_GetItem(items, i);
var name = PyTuple_GetItem(item, 0);
var module = PyTuple_GetItem(item, 1);
if (ManagedType.IsInstanceOfManagedType(module))
{
PyDict_DelItem(modules, name);
}
}
items.Dispose();
}
private static void RemoveClrRootModule()
{
var modules = PyImport_GetModuleDict();
PyDictTryDelItem(modules, "clr");
PyDictTryDelItem(modules, "clr._extra");
}
private static void PyDictTryDelItem(BorrowedReference dict, string key)
{
if (PyDict_DelItemString(dict, key) == 0)
{
return;
}
if (!PythonException.CurrentMatches(Exceptions.KeyError))
{
throw PythonException.ThrowLastAsClrException();
}
PyErr_Clear();
}
private static void MoveClrInstancesOnwershipToPython()
{
var objs = ManagedType.GetManagedObjects();
var copyObjs = objs.ToArray();
foreach (var entry in copyObjs)
{
ManagedType obj = entry.Key;
if (!objs.ContainsKey(obj))
{
System.Diagnostics.Debug.Assert(obj.gcHandle == default);
continue;
}
if (entry.Value == ManagedType.TrackTypes.Extension)
{
obj.CallTypeClear();
// obj's tp_type will degenerate to a pure Python type after TypeManager.RemoveTypes(),
// thus just be safe to give it back to GC chain.
if (!_PyObject_GC_IS_TRACKED(obj.ObjectReference))
{
PyObject_GC_Track(obj.pyHandle);
}
}
if (obj.gcHandle.IsAllocated)
{
obj.gcHandle.Free();
ManagedType.SetGCHandle(obj.ObjectReference, default);
}
obj.gcHandle = default;
}
ManagedType.ClearTrackedObjects();
}
internal static IntPtr PyBaseObjectType;
internal static IntPtr PyModuleType;
internal static IntPtr PyClassType;
internal static IntPtr PyInstanceType;
internal static IntPtr PySuper_Type;
internal static IntPtr PyCLRMetaType;
internal static IntPtr PyMethodType;
internal static IntPtr PyWrapperDescriptorType;
internal static IntPtr PyUnicodeType;
internal static IntPtr PyStringType;
internal static IntPtr PyTupleType;
internal static IntPtr PyListType;
internal static IntPtr PyDictType;
internal static IntPtr PyIntType;
internal static IntPtr PyLongType;
internal static IntPtr PyFloatType;
internal static IntPtr PyBoolType;
internal static IntPtr PyNoneType;
internal static IntPtr PyTypeType;
internal static IntPtr Py_NoSiteFlag;
internal static IntPtr PyBytesType;
internal static IntPtr _PyObject_NextNotImplemented;
internal static IntPtr PyNotImplemented;
internal const int Py_LT = 0;
internal const int Py_LE = 1;
internal const int Py_EQ = 2;
internal const int Py_NE = 3;
internal const int Py_GT = 4;
internal const int Py_GE = 5;
internal static IntPtr PyTrue;
internal static IntPtr PyFalse;
internal static IntPtr PyNone;
internal static IntPtr Error;
internal static BorrowedReference CLRMetaType => new BorrowedReference(PyCLRMetaType);
public static PyObject None
{
get
{
var none = Runtime.PyNone;
Runtime.XIncref(none);
return new PyObject(none);
}
}
/// <summary>
/// Check if any Python Exceptions occurred.
/// If any exist throw new PythonException.
/// </summary>
/// <remarks>
/// Can be used instead of `obj == IntPtr.Zero` for example.
/// </remarks>
internal static void CheckExceptionOccurred()
{
if (PyErr_Occurred() != null)
{
throw PythonException.ThrowLastAsClrException();
}
}
internal static IntPtr ExtendTuple(IntPtr t, params IntPtr[] args)
{
var size = PyTuple_Size(t);
int add = args.Length;
IntPtr item;
IntPtr items = PyTuple_New(size + add);
for (var i = 0; i < size; i++)
{
item = PyTuple_GetItem(t, i);
XIncref(item);
PyTuple_SetItem(items, i, item);
}
for (var n = 0; n < add; n++)
{
item = args[n];
XIncref(item);
PyTuple_SetItem(items, size + n, item);
}
return items;
}
internal static Type[] PythonArgsToTypeArray(IntPtr arg)
{
return PythonArgsToTypeArray(arg, false);
}
internal static Type[] PythonArgsToTypeArray(IntPtr arg, bool mangleObjects)
{
// Given a PyObject * that is either a single type object or a
// tuple of (managed or unmanaged) type objects, return a Type[]
// containing the CLR Type objects that map to those types.
IntPtr args = arg;
var free = false;
if (!PyTuple_Check(arg))
{
args = PyTuple_New(1);
XIncref(arg);
PyTuple_SetItem(args, 0, arg);
free = true;
}
var n = PyTuple_Size(args);
var types = new Type[n];
Type t = null;
for (var i = 0; i < n; i++)
{
IntPtr op = PyTuple_GetItem(args, i);
if (mangleObjects && (!PyType_Check(op)))
{
op = PyObject_TYPE(op);
}
ManagedType mt = ManagedType.GetManagedObject(op);
if (mt is ClassBase)
{
MaybeType _type = ((ClassBase)mt).type;
t = _type.Valid ? _type.Value : null;
}
else if (mt is CLRObject)
{
object inst = ((CLRObject)mt).inst;
if (inst is Type)
{
t = inst as Type;
}
}
else
{
t = Converter.GetTypeByAlias(op);
}
if (t == null)
{
types = null;
break;
}
types[i] = t;
}
if (free)
{
XDecref(args);
}
return types;
}
/// <summary>
/// Managed exports of the Python C API. Where appropriate, we do
/// some optimization to avoid managed <--> unmanaged transitions
/// (mostly for heavily used methods).
/// </summary>
internal static unsafe void XIncref(IntPtr op)
{
#if !CUSTOM_INCDEC_REF
Py_IncRef(op);
return;
#else
var p = (void*)op;
if ((void*)0 != p)
{
if (Is32Bit)
{
(*(int*)p)++;
}
else
{
(*(long*)p)++;
}
}
#endif
}
/// <summary>
/// Increase Python's ref counter for the given object, and get the object back.
/// </summary>
internal static IntPtr SelfIncRef(IntPtr op)
{
XIncref(op);
return op;
}
internal static unsafe void XDecref(IntPtr op)
{
#if DEBUG
Debug.Assert(op == IntPtr.Zero || Refcount(op) > 0);
#endif
#if !CUSTOM_INCDEC_REF
Py_DecRef(op);
return;
#else
var p = (void*)op;
if ((void*)0 != p)
{
if (Is32Bit)
{
--(*(int*)p);
}
else
{
--(*(long*)p);
}
if ((*(int*)p) == 0)
{
// PyObject_HEAD: struct _typeobject *ob_type
void* t = Is32Bit
? (void*)(*((uint*)p + 1))
: (void*)(*((ulong*)p + 1));
// PyTypeObject: destructor tp_dealloc
void* f = Is32Bit
? (void*)(*((uint*)t + 6))
: (void*)(*((ulong*)t + 6));
if ((void*)0 == f)
{
return;
}
NativeCall.Void_Call_1(new IntPtr(f), op);
}
}
#endif
}
[Pure]
internal static unsafe long Refcount(IntPtr op)
{
if (op == IntPtr.Zero)
{
return 0;
}
var p = (nint*)(op + ABI.RefCountOffset);
return *p;
}
/// <summary>
/// Export of Macro Py_XIncRef. Use XIncref instead.
/// Limit this function usage for Testing and Py_Debug builds
/// </summary>
/// <param name="ob">PyObject Ptr</param>
internal static void Py_IncRef(IntPtr ob) => Delegates.Py_IncRef(ob);
/// <summary>
/// Export of Macro Py_XDecRef. Use XDecref instead.
/// Limit this function usage for Testing and Py_Debug builds
/// </summary>
/// <param name="ob">PyObject Ptr</param>
internal static void Py_DecRef(IntPtr ob) => Delegates.Py_DecRef(ob);
internal static void Py_Initialize() => Delegates.Py_Initialize();
internal static void Py_InitializeEx(int initsigs) => Delegates.Py_InitializeEx(initsigs);
internal static int Py_IsInitialized() => Delegates.Py_IsInitialized();
internal static void Py_Finalize() => Delegates.Py_Finalize();
internal static IntPtr Py_NewInterpreter() => Delegates.Py_NewInterpreter();
internal static void Py_EndInterpreter(IntPtr threadState) => Delegates.Py_EndInterpreter(threadState);
internal static IntPtr PyThreadState_New(IntPtr istate) => Delegates.PyThreadState_New(istate);
internal static IntPtr PyThreadState_Get() => Delegates.PyThreadState_Get();
internal static IntPtr _PyThreadState_UncheckedGet() => Delegates._PyThreadState_UncheckedGet();
internal static IntPtr PyThread_get_key_value(IntPtr key) => Delegates.PyThread_get_key_value(key);
internal static int PyThread_get_thread_ident() => Delegates.PyThread_get_thread_ident();
internal static int PyThread_set_key_value(IntPtr key, IntPtr value) => Delegates.PyThread_set_key_value(key, value);
internal static IntPtr PyThreadState_Swap(IntPtr key) => Delegates.PyThreadState_Swap(key);
internal static int PyGILState_Check() => Delegates.PyGILState_Check();
internal static IntPtr PyGILState_Ensure() => Delegates.PyGILState_Ensure();
internal static void PyGILState_Release(IntPtr gs) => Delegates.PyGILState_Release(gs);
internal static IntPtr PyGILState_GetThisThreadState() => Delegates.PyGILState_GetThisThreadState();
public static int Py_Main(int argc, string[] argv)
{
var marshaler = StrArrayMarshaler.GetInstance(null);
var argvPtr = marshaler.MarshalManagedToNative(argv);
try
{
return Delegates.Py_Main(argc, argvPtr);
}
finally
{
marshaler.CleanUpNativeData(argvPtr);
}
}
internal static void PyEval_InitThreads() => Delegates.PyEval_InitThreads();
internal static int PyEval_ThreadsInitialized() => Delegates.PyEval_ThreadsInitialized();
internal static void PyEval_AcquireLock() => Delegates.PyEval_AcquireLock();
internal static void PyEval_ReleaseLock() => Delegates.PyEval_ReleaseLock();
internal static void PyEval_AcquireThread(IntPtr tstate) => Delegates.PyEval_AcquireThread(tstate);
internal static void PyEval_ReleaseThread(IntPtr tstate) => Delegates.PyEval_ReleaseThread(tstate);
internal static IntPtr PyEval_SaveThread() => Delegates.PyEval_SaveThread();
internal static void PyEval_RestoreThread(IntPtr tstate) => Delegates.PyEval_RestoreThread(tstate);
internal static BorrowedReference PyEval_GetBuiltins() => Delegates.PyEval_GetBuiltins();
internal static BorrowedReference PyEval_GetGlobals() => Delegates.PyEval_GetGlobals();
internal static IntPtr PyEval_GetLocals() => Delegates.PyEval_GetLocals();
internal static IntPtr Py_GetProgramName() => Delegates.Py_GetProgramName();
internal static void Py_SetProgramName(IntPtr name) => Delegates.Py_SetProgramName(name);
internal static IntPtr Py_GetPythonHome() => Delegates.Py_GetPythonHome();
internal static void Py_SetPythonHome(IntPtr home) => Delegates.Py_SetPythonHome(home);
internal static IntPtr Py_GetPath() => Delegates.Py_GetPath();
internal static void Py_SetPath(IntPtr home) => Delegates.Py_SetPath(home);
internal static IntPtr Py_GetVersion() => Delegates.Py_GetVersion();
internal static IntPtr Py_GetPlatform() => Delegates.Py_GetPlatform();
internal static IntPtr Py_GetCopyright() => Delegates.Py_GetCopyright();
internal static IntPtr Py_GetCompiler() => Delegates.Py_GetCompiler();
internal static IntPtr Py_GetBuildInfo() => Delegates.Py_GetBuildInfo();
const PyCompilerFlags Utf8String = PyCompilerFlags.IGNORE_COOKIE | PyCompilerFlags.SOURCE_IS_UTF8;
internal static int PyRun_SimpleString(string code)
{
using var codePtr = new StrPtr(code, Encoding.UTF8);
return Delegates.PyRun_SimpleStringFlags(codePtr, Utf8String);
}
internal static NewReference PyRun_String(string code, RunFlagType st, BorrowedReference globals, BorrowedReference locals)
{
using var codePtr = new StrPtr(code, Encoding.UTF8);
return Delegates.PyRun_StringFlags(codePtr, st, globals, locals, Utf8String);
}
internal static IntPtr PyEval_EvalCode(IntPtr co, IntPtr globals, IntPtr locals) => Delegates.PyEval_EvalCode(co, globals, locals);
/// <summary>
/// Return value: New reference.
/// This is a simplified interface to Py_CompileStringFlags() below, leaving flags set to NULL.
/// </summary>
internal static NewReference Py_CompileString(string str, string file, int start)
{
using var strPtr = new StrPtr(str, Encoding.UTF8);
using var fileObj = new PyString(file);
return Delegates.Py_CompileStringObject(strPtr, fileObj.Reference, start, Utf8String, -1);
}
internal static NewReference PyImport_ExecCodeModule(string name, BorrowedReference code)
{
using var namePtr = new StrPtr(name, Encoding.UTF8);
return Delegates.PyImport_ExecCodeModule(namePtr, code);
}
internal static IntPtr PyCFunction_NewEx(IntPtr ml, IntPtr self, IntPtr mod) => Delegates.PyCFunction_NewEx(ml, self, mod);
internal static IntPtr PyCFunction_Call(IntPtr func, IntPtr args, IntPtr kw) => Delegates.PyCFunction_Call(func, args, kw);
internal static IntPtr PyMethod_New(IntPtr func, IntPtr self, IntPtr cls) => Delegates.PyMethod_New(func, self, cls);
//====================================================================
// Python abstract object API
//====================================================================
/// <summary>
/// Return value: Borrowed reference.
/// A macro-like method to get the type of a Python object. This is
/// designed to be lean and mean in IL & avoid managed <-> unmanaged
/// transitions. Note that this does not incref the type object.
/// </summary>
internal static unsafe IntPtr PyObject_TYPE(IntPtr op)
{
var p = (void*)op;
if ((void*)0 == p)
{
return IntPtr.Zero;
}
Debug.Assert(TypeOffset.ob_type > 0);
IntPtr* typePtr = (IntPtr*)(op + TypeOffset.ob_type);
return *typePtr;
}
internal static unsafe BorrowedReference PyObject_TYPE(BorrowedReference op)
=> new BorrowedReference(PyObject_TYPE(op.DangerousGetAddress()));
/// <summary>
/// Managed version of the standard Python C API PyObject_Type call.
/// This version avoids a managed <-> unmanaged transition.
/// This one does incref the returned type object.
/// </summary>
internal static IntPtr PyObject_Type(IntPtr op)
{
IntPtr tp = PyObject_TYPE(op);
XIncref(tp);
return tp;