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

// Copyright (c) 2017-present PyO3 Project and Contributors

//! Python GC support
//!

use crate::ffi;
use crate::type_object::PyTypeInfo;
use crate::AsPyPointer;
use crate::Python;
use std::os::raw::{c_int, c_void};

#[repr(transparent)]
pub struct PyTraverseError(c_int);

/// GC support
pub trait PyGCProtocol<'p>: PyTypeInfo {
    fn __traverse__(&'p self, visit: PyVisit) -> Result<(), PyTraverseError>;
    fn __clear__(&'p mut self);
}

pub trait PyGCTraverseProtocol<'p>: PyGCProtocol<'p> {}
pub trait PyGCClearProtocol<'p>: PyGCProtocol<'p> {}

#[doc(hidden)]
pub trait PyGCProtocolImpl {
    fn update_type_object(_type_object: &mut ffi::PyTypeObject);
}

impl<'p, T> PyGCProtocolImpl for T {
    default fn update_type_object(_type_object: &mut ffi::PyTypeObject) {}
}

impl<'p, T> PyGCProtocolImpl for T
where
    T: PyGCProtocol<'p>,
{
    fn update_type_object(type_object: &mut ffi::PyTypeObject) {
        type_object.tp_traverse = Self::tp_traverse();
        type_object.tp_clear = Self::tp_clear();
    }
}

#[derive(Copy, Clone)]
pub struct PyVisit<'p> {
    visit: ffi::visitproc,
    arg: *mut c_void,
    /// VisitProc contains a Python instance to ensure that
    /// 1) it is cannot be moved out of the traverse() call
    /// 2) it cannot be sent to other threads
    _py: Python<'p>,
}

impl<'p> PyVisit<'p> {
    pub fn call<T>(&self, obj: &T) -> Result<(), PyTraverseError>
    where
        T: AsPyPointer,
    {
        let r = unsafe { (self.visit)(obj.as_ptr(), self.arg) };
        if r == 0 {
            Ok(())
        } else {
            Err(PyTraverseError(r))
        }
    }
}

trait PyGCTraverseProtocolImpl {
    fn tp_traverse() -> Option<ffi::traverseproc>;
}

impl<'p, T> PyGCTraverseProtocolImpl for T
where
    T: PyGCProtocol<'p>,
{
    default fn tp_traverse() -> Option<ffi::traverseproc> {
        None
    }
}

#[doc(hidden)]
impl<T> PyGCTraverseProtocolImpl for T
where
    T: for<'p> PyGCTraverseProtocol<'p>,
{
    #[inline]
    fn tp_traverse() -> Option<ffi::traverseproc> {
        unsafe extern "C" fn tp_traverse<T>(
            slf: *mut ffi::PyObject,
            visit: ffi::visitproc,
            arg: *mut c_void,
        ) -> c_int
        where
            T: for<'p> PyGCTraverseProtocol<'p>,
        {
            let py = Python::assume_gil_acquired();
            let _pool = crate::GILPool::new(py);
            let slf = py.mut_from_borrowed_ptr::<T>(slf);

            let visit = PyVisit {
                visit,
                arg,
                _py: py,
            };
            match slf.__traverse__(visit) {
                Ok(()) => 0,
                Err(PyTraverseError(code)) => code,
            }
        }

        Some(tp_traverse::<T>)
    }
}

trait PyGCClearProtocolImpl {
    fn tp_clear() -> Option<ffi::inquiry>;
}

impl<'p, T> PyGCClearProtocolImpl for T
where
    T: PyGCProtocol<'p>,
{
    default fn tp_clear() -> Option<ffi::inquiry> {
        None
    }
}

impl<T> PyGCClearProtocolImpl for T
where
    T: for<'p> PyGCClearProtocol<'p>,
{
    #[inline]
    fn tp_clear() -> Option<ffi::inquiry> {
        unsafe extern "C" fn tp_clear<T>(slf: *mut ffi::PyObject) -> c_int
        where
            T: for<'p> PyGCClearProtocol<'p>,
        {
            let py = Python::assume_gil_acquired();
            let _pool = crate::GILPool::new(py);
            let slf = py.mut_from_borrowed_ptr::<T>(slf);

            slf.__clear__();
            0
        }
        Some(tp_clear::<T>)
    }
}