|
| 1 | +use std::cell::UnsafeCell; |
| 2 | +use std::collections::hash_map::{Entry, HashMap}; |
| 3 | +use std::ops::Deref; |
| 4 | + |
| 5 | +use ndarray::{ArrayView, ArrayViewMut, Dimension, Ix1, Ix2, IxDyn}; |
| 6 | +use pyo3::{FromPyObject, PyAny, PyResult}; |
| 7 | + |
| 8 | +use crate::array::PyArray; |
| 9 | +use crate::dtype::Element; |
| 10 | +use crate::error::NotContiguousError; |
| 11 | + |
| 12 | +thread_local! { |
| 13 | + static BORROW_FLAGS: UnsafeCell<HashMap<usize, isize>> = UnsafeCell::new(HashMap::new()); |
| 14 | +} |
| 15 | + |
| 16 | +pub struct PyReadonlyArray<'py, T, D>(&'py PyArray<T, D>); |
| 17 | + |
| 18 | +pub type PyReadonlyArray1<'py, T> = PyReadonlyArray<'py, T, Ix1>; |
| 19 | + |
| 20 | +pub type PyReadonlyArray2<'py, T> = PyReadonlyArray<'py, T, Ix2>; |
| 21 | + |
| 22 | +pub type PyReadonlyArrayDyn<'py, T> = PyReadonlyArray<'py, T, IxDyn>; |
| 23 | + |
| 24 | +impl<'py, T, D> Deref for PyReadonlyArray<'py, T, D> { |
| 25 | + type Target = PyArray<T, D>; |
| 26 | + |
| 27 | + fn deref(&self) -> &Self::Target { |
| 28 | + self.0 |
| 29 | + } |
| 30 | +} |
| 31 | + |
| 32 | +impl<'py, T: Element, D: Dimension> FromPyObject<'py> for PyReadonlyArray<'py, T, D> { |
| 33 | + fn extract(obj: &'py PyAny) -> PyResult<Self> { |
| 34 | + let array: &'py PyArray<T, D> = obj.extract()?; |
| 35 | + Ok(array.readonly()) |
| 36 | + } |
| 37 | +} |
| 38 | + |
| 39 | +impl<'py, T, D> PyReadonlyArray<'py, T, D> |
| 40 | +where |
| 41 | + T: Element, |
| 42 | + D: Dimension, |
| 43 | +{ |
| 44 | + pub(crate) fn try_new(array: &'py PyArray<T, D>) -> Option<Self> { |
| 45 | + let address = array as *const PyArray<T, D> as usize; |
| 46 | + |
| 47 | + BORROW_FLAGS.with(|borrow_flags| { |
| 48 | + // SAFETY: Called on a thread local variable in a leaf function. |
| 49 | + let borrow_flags = unsafe { &mut *borrow_flags.get() }; |
| 50 | + |
| 51 | + match borrow_flags.entry(address) { |
| 52 | + Entry::Occupied(entry) => { |
| 53 | + let readers = entry.into_mut(); |
| 54 | + |
| 55 | + let new_readers = readers.wrapping_add(1); |
| 56 | + |
| 57 | + if new_readers <= 0 { |
| 58 | + cold(); |
| 59 | + return None; |
| 60 | + } |
| 61 | + |
| 62 | + *readers = new_readers; |
| 63 | + } |
| 64 | + Entry::Vacant(entry) => { |
| 65 | + entry.insert(1); |
| 66 | + } |
| 67 | + } |
| 68 | + |
| 69 | + Some(Self(array)) |
| 70 | + }) |
| 71 | + } |
| 72 | + |
| 73 | + pub fn as_array(&self) -> ArrayView<T, D> { |
| 74 | + // SAFETY: Thread-local borrow flags ensure aliasing discipline on this thread, |
| 75 | + // and `PyArray` is neither `Send` nor `Sync` |
| 76 | + unsafe { self.0.as_array() } |
| 77 | + } |
| 78 | + |
| 79 | + pub fn as_slice(&self) -> Result<&[T], NotContiguousError> { |
| 80 | + // SAFETY: Thread-local borrow flags ensure aliasing discipline on this thread, |
| 81 | + // and `PyArray` is neither `Send` nor `Sync` |
| 82 | + unsafe { self.0.as_slice() } |
| 83 | + } |
| 84 | +} |
| 85 | + |
| 86 | +impl<'a, T, D> Drop for PyReadonlyArray<'a, T, D> { |
| 87 | + fn drop(&mut self) { |
| 88 | + let address = self.0 as *const PyArray<T, D> as usize; |
| 89 | + |
| 90 | + BORROW_FLAGS.with(|borrow_flags| { |
| 91 | + // SAFETY: Called on a thread local variable in a leaf function. |
| 92 | + let borrow_flags = unsafe { &mut *borrow_flags.get() }; |
| 93 | + |
| 94 | + let readers = borrow_flags.get_mut(&address).unwrap(); |
| 95 | + |
| 96 | + *readers -= 1; |
| 97 | + |
| 98 | + if *readers == 0 { |
| 99 | + borrow_flags.remove(&address).unwrap(); |
| 100 | + } |
| 101 | + }); |
| 102 | + } |
| 103 | +} |
| 104 | + |
| 105 | +pub struct PyReadwriteArray<'py, T, D>(&'py PyArray<T, D>); |
| 106 | + |
| 107 | +pub type PyReadwriteArrayDyn<'py, T> = PyReadwriteArray<'py, T, IxDyn>; |
| 108 | + |
| 109 | +impl<'py, T, D> Deref for PyReadwriteArray<'py, T, D> { |
| 110 | + type Target = PyArray<T, D>; |
| 111 | + |
| 112 | + fn deref(&self) -> &Self::Target { |
| 113 | + self.0 |
| 114 | + } |
| 115 | +} |
| 116 | + |
| 117 | +impl<'py, T: Element, D: Dimension> FromPyObject<'py> for PyReadwriteArray<'py, T, D> { |
| 118 | + fn extract(obj: &'py PyAny) -> PyResult<Self> { |
| 119 | + let array: &'py PyArray<T, D> = obj.extract()?; |
| 120 | + Ok(array.readwrite()) |
| 121 | + } |
| 122 | +} |
| 123 | + |
| 124 | +impl<'py, T, D> PyReadwriteArray<'py, T, D> |
| 125 | +where |
| 126 | + T: Element, |
| 127 | + D: Dimension, |
| 128 | +{ |
| 129 | + pub(crate) fn try_new(array: &'py PyArray<T, D>) -> Option<Self> { |
| 130 | + let address = array as *const PyArray<T, D> as usize; |
| 131 | + |
| 132 | + BORROW_FLAGS.with(|borrow_flags| { |
| 133 | + // SAFETY: Called on a thread local variable in a leaf function. |
| 134 | + let borrow_flags = unsafe { &mut *borrow_flags.get() }; |
| 135 | + |
| 136 | + match borrow_flags.entry(address) { |
| 137 | + Entry::Occupied(entry) => { |
| 138 | + let writers = entry.into_mut(); |
| 139 | + |
| 140 | + if *writers != 0 { |
| 141 | + cold(); |
| 142 | + return None; |
| 143 | + } |
| 144 | + |
| 145 | + *writers = -1; |
| 146 | + } |
| 147 | + Entry::Vacant(entry) => { |
| 148 | + entry.insert(-1); |
| 149 | + } |
| 150 | + } |
| 151 | + |
| 152 | + Some(Self(array)) |
| 153 | + }) |
| 154 | + } |
| 155 | + |
| 156 | + pub fn as_array(&self) -> ArrayView<T, D> { |
| 157 | + // SAFETY: Thread-local borrow flags ensure aliasing discipline on this thread, |
| 158 | + // and `PyArray` is neither `Send` nor `Sync` |
| 159 | + unsafe { self.0.as_array() } |
| 160 | + } |
| 161 | + |
| 162 | + pub fn as_slice(&self) -> Result<&[T], NotContiguousError> { |
| 163 | + // SAFETY: Thread-local borrow flags ensure aliasing discipline on this thread, |
| 164 | + // and `PyArray` is neither `Send` nor `Sync` |
| 165 | + unsafe { self.0.as_slice() } |
| 166 | + } |
| 167 | + |
| 168 | + pub fn as_array_mut(&mut self) -> ArrayViewMut<T, D> { |
| 169 | + // SAFETY: Thread-local borrow flags ensure aliasing discipline on this thread, |
| 170 | + // and `PyArray` is neither `Send` nor `Sync` |
| 171 | + unsafe { self.0.as_array_mut() } |
| 172 | + } |
| 173 | + |
| 174 | + pub fn as_slice_mut(&self) -> Result<&mut [T], NotContiguousError> { |
| 175 | + // SAFETY: Thread-local borrow flags ensure aliasing discipline on this thread, |
| 176 | + // and `PyArray` is neither `Send` nor `Sync` |
| 177 | + unsafe { self.0.as_slice_mut() } |
| 178 | + } |
| 179 | +} |
| 180 | + |
| 181 | +impl<'a, T, D> Drop for PyReadwriteArray<'a, T, D> { |
| 182 | + fn drop(&mut self) { |
| 183 | + let address = self.0 as *const PyArray<T, D> as usize; |
| 184 | + |
| 185 | + BORROW_FLAGS.with(|borrow_flags| { |
| 186 | + // SAFETY: Called on a thread local variable in a leaf function. |
| 187 | + let borrow_flags = unsafe { &mut *borrow_flags.get() }; |
| 188 | + |
| 189 | + borrow_flags.remove(&address).unwrap(); |
| 190 | + }); |
| 191 | + } |
| 192 | +} |
| 193 | +#[cold] |
| 194 | +#[inline(always)] |
| 195 | +fn cold() {} |
0 commit comments