Skip to main content

pyo3_ffi/
objimpl.rs

1use core::ffi::{c_int, c_void};
2use libc::size_t;
3
4use crate::object::*;
5use crate::pyport::Py_ssize_t;
6
7extern_libpython! {
8    #[cfg_attr(PyPy, link_name = "PyPyObject_Malloc")]
9    pub fn PyObject_Malloc(size: size_t) -> *mut c_void;
10    #[cfg_attr(PyPy, link_name = "PyPyObject_Calloc")]
11    pub fn PyObject_Calloc(nelem: size_t, elsize: size_t) -> *mut c_void;
12    #[cfg_attr(PyPy, link_name = "PyPyObject_Realloc")]
13    pub fn PyObject_Realloc(ptr: *mut c_void, new_size: size_t) -> *mut c_void;
14    #[cfg_attr(PyPy, link_name = "PyPyObject_Free")]
15    pub fn PyObject_Free(ptr: *mut c_void);
16
17    // skipped PyObject_MALLOC
18    // skipped PyObject_REALLOC
19    // skipped PyObject_FREE
20    // skipped PyObject_Del
21    // skipped PyObject_DEL
22
23    #[cfg_attr(PyPy, link_name = "PyPyObject_Init")]
24    pub fn PyObject_Init(arg1: *mut PyObject, arg2: *mut PyTypeObject) -> *mut PyObject;
25    #[cfg_attr(PyPy, link_name = "PyPyObject_InitVar")]
26    pub fn PyObject_InitVar(
27        arg1: *mut PyVarObject,
28        arg2: *mut PyTypeObject,
29        arg3: Py_ssize_t,
30    ) -> *mut PyVarObject;
31
32    // skipped PyObject_INIT
33    // skipped PyObject_INIT_VAR
34
35    #[cfg_attr(PyPy, link_name = "_PyPyObject_New")]
36    fn _PyObject_New(typeobj: *mut PyTypeObject) -> *mut PyObject;
37    #[cfg_attr(PyPy, link_name = "_PyPyObject_NewVar")]
38    fn _PyObject_NewVar(typeobj: *mut PyTypeObject, n: Py_ssize_t) -> *mut PyVarObject;
39}
40
41#[inline]
42pub unsafe fn PyObject_New<T>(typeobj: *mut PyTypeObject) -> *mut T {
43    _PyObject_New(typeobj).cast()
44}
45
46// skipped PyObject_NEW
47
48#[inline]
49pub unsafe fn PyObject_NewVar<T>(typeobj: *mut PyTypeObject, n: Py_ssize_t) -> *mut T {
50    _PyObject_NewVar(typeobj, n).cast()
51}
52
53// skipped PyObject_NEW_VAR
54
55extern_libpython! {
56    #[cfg_attr(PyPy, link_name = "PyPyGC_Collect")]
57    pub fn PyGC_Collect() -> Py_ssize_t;
58
59    #[cfg(Py_3_10)]
60    #[cfg_attr(PyPy, link_name = "PyPyGC_Enable")]
61    pub fn PyGC_Enable() -> c_int;
62
63    #[cfg(Py_3_10)]
64    #[cfg_attr(PyPy, link_name = "PyPyGC_Disable")]
65    pub fn PyGC_Disable() -> c_int;
66
67    #[cfg(Py_3_10)]
68    #[cfg_attr(PyPy, link_name = "PyPyGC_IsEnabled")]
69    pub fn PyGC_IsEnabled() -> c_int;
70}
71
72#[inline]
73pub unsafe fn PyType_IS_GC(t: *mut PyTypeObject) -> c_int {
74    PyType_HasFeature(t, Py_TPFLAGS_HAVE_GC)
75}
76
77extern_libpython! {
78    fn _PyObject_GC_Resize(op: *mut PyVarObject, n: Py_ssize_t) -> *mut PyVarObject;
79}
80
81#[inline]
82pub unsafe fn PyObject_GC_Resize<T>(op: *mut PyObject, n: Py_ssize_t) -> *mut T {
83    _PyObject_GC_Resize(op.cast(), n).cast()
84}
85
86extern_libpython! {
87    #[cfg_attr(PyPy, link_name = "_PyPyObject_GC_New")]
88    fn _PyObject_GC_New(typeobj: *mut PyTypeObject) -> *mut PyObject;
89    #[cfg_attr(PyPy, link_name = "_PyPyObject_GC_NewVar")]
90    fn _PyObject_GC_NewVar(typeobj: *mut PyTypeObject, n: Py_ssize_t) -> *mut PyVarObject;
91
92    #[cfg(not(PyPy))]
93    pub fn PyObject_GC_Track(arg1: *mut c_void);
94
95    #[cfg(not(PyPy))]
96    pub fn PyObject_GC_UnTrack(arg1: *mut c_void);
97}
98
99// PyPy currently implements the following two as no-op macros
100// https://github.com/pypy/pypy/blob/194f9f44b50552d75484d67cda6e2b36607dee0c/pypy/module/cpyext/include/objimpl.h#L178-L190
101
102#[cfg(PyPy)]
103#[inline(always)]
104pub unsafe fn PyObject_GC_Track(_: *mut c_void) {}
105
106#[cfg(PyPy)]
107#[inline(always)]
108pub unsafe fn PyObject_GC_UnTrack(_: *mut c_void) {}
109
110extern_libpython! {
111    #[cfg_attr(PyPy, link_name = "PyPyObject_GC_Del")]
112    pub fn PyObject_GC_Del(arg1: *mut c_void);
113}
114
115#[inline]
116pub unsafe fn PyObject_GC_New<T>(typeobj: *mut PyTypeObject) -> *mut T {
117    _PyObject_GC_New(typeobj).cast()
118}
119
120#[inline]
121pub unsafe fn PyObject_GC_NewVar<T>(typeobj: *mut PyTypeObject, n: Py_ssize_t) -> *mut T {
122    _PyObject_GC_NewVar(typeobj, n).cast()
123}
124
125extern_libpython! {
126    #[cfg(any(not(PyPy), Py_3_10))] // added in 3.9, or 3.10 on PyPy
127    #[cfg_attr(PyPy, link_name = "PyPyObject_GC_IsTracked")]
128    pub fn PyObject_GC_IsTracked(arg1: *mut PyObject) -> c_int;
129    #[cfg(any(not(PyPy), Py_3_10))] // added in 3.9, or 3.10 on PyPy
130    #[cfg_attr(PyPy, link_name = "PyPyObject_GC_IsFinalized")]
131    pub fn PyObject_GC_IsFinalized(arg1: *mut PyObject) -> c_int;
132}
133
134// skipped Py_VISIT