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
use std::ops::Deref;
use std::sync::Arc;
use either::Either;
use num_traits::Zero;
use super::{Bytes, IntoIter};
use crate::array::{ArrayAccessor, Splitable};
/// [`Buffer`] is a contiguous memory region that can be shared across
/// thread boundaries.
///
/// The easiest way to think about [`Buffer<T>`] is being equivalent to
/// a `Arc<Vec<T>>`, with the following differences:
/// * slicing and cloning is `O(1)`.
/// * it supports external allocated memory
///
/// The easiest way to create one is to use its implementation of `From<Vec<T>>`.
///
/// # Examples
/// ```
/// use polars_arrow::buffer::Buffer;
///
/// let mut buffer: Buffer<u32> = vec![1, 2, 3].into();
/// assert_eq!(buffer.as_ref(), [1, 2, 3].as_ref());
///
/// // it supports copy-on-write semantics (i.e. back to a `Vec`)
/// let vec: Vec<u32> = buffer.into_mut().right().unwrap();
/// assert_eq!(vec, vec![1, 2, 3]);
///
/// // cloning and slicing is `O(1)` (data is shared)
/// let mut buffer: Buffer<u32> = vec![1, 2, 3].into();
/// let mut sliced = buffer.clone();
/// sliced.slice(1, 1);
/// assert_eq!(sliced.as_ref(), [2].as_ref());
/// // but cloning forbids getting mut since `slice` and `buffer` now share data
/// assert_eq!(buffer.get_mut_slice(), None);
/// ```
#[derive(Clone)]
pub struct Buffer<T> {
/// The internal byte buffer.
storage: Arc<Bytes<T>>,
/// A pointer into the buffer where our data starts.
ptr: *const T,
// The length of the buffer.
length: usize,
}
unsafe impl<T: Sync> Sync for Buffer<T> {}
unsafe impl<T: Send> Send for Buffer<T> {}
impl<T: PartialEq> PartialEq for Buffer<T> {
#[inline]
fn eq(&self, other: &Self) -> bool {
self.deref() == other.deref()
}
}
impl<T: std::fmt::Debug> std::fmt::Debug for Buffer<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
std::fmt::Debug::fmt(&**self, f)
}
}
impl<T> Default for Buffer<T> {
#[inline]
fn default() -> Self {
Vec::new().into()
}
}
impl<T> Buffer<T> {
/// Creates an empty [`Buffer`].
#[inline]
pub fn new() -> Self {
Self::default()
}
/// Auxiliary method to create a new Buffer
pub(crate) fn from_bytes(bytes: Bytes<T>) -> Self {
let ptr = bytes.as_ptr();
let length = bytes.len();
Buffer {
storage: Arc::new(bytes),
ptr,
length,
}
}
/// Returns the number of bytes in the buffer
#[inline]
pub fn len(&self) -> usize {
self.length
}
/// Returns whether the buffer is empty.
#[inline]
pub fn is_empty(&self) -> bool {
self.length == 0
}
/// Returns whether underlying data is sliced.
/// If sliced the [`Buffer`] is backed by
/// more data than the length of `Self`.
pub fn is_sliced(&self) -> bool {
self.storage.len() != self.length
}
/// Returns the byte slice stored in this buffer
#[inline]
pub fn as_slice(&self) -> &[T] {
// SAFETY:
// invariant of this struct `offset + length <= data.len()`
debug_assert!(self.offset() + self.length <= self.storage.len());
unsafe { std::slice::from_raw_parts(self.ptr, self.length) }
}
/// Returns the byte slice stored in this buffer
///
/// # Safety
/// `index` must be smaller than `len`
#[inline]
pub(super) unsafe fn get_unchecked(&self, index: usize) -> &T {
// SAFETY:
// invariant of this function
debug_assert!(index < self.length);
unsafe { &*self.ptr.add(index) }
}
/// Returns a new [`Buffer`] that is a slice of this buffer starting at `offset`.
/// Doing so allows the same memory region to be shared between buffers.
/// # Panics
/// Panics iff `offset + length` is larger than `len`.
#[inline]
pub fn sliced(self, offset: usize, length: usize) -> Self {
assert!(
offset + length <= self.len(),
"the offset of the new Buffer cannot exceed the existing length"
);
// SAFETY: we just checked bounds
unsafe { self.sliced_unchecked(offset, length) }
}
/// Slices this buffer starting at `offset`.
/// # Panics
/// Panics iff `offset + length` is larger than `len`.
#[inline]
pub fn slice(&mut self, offset: usize, length: usize) {
assert!(
offset + length <= self.len(),
"the offset of the new Buffer cannot exceed the existing length"
);
// SAFETY: we just checked bounds
unsafe { self.slice_unchecked(offset, length) }
}
/// Returns a new [`Buffer`] that is a slice of this buffer starting at `offset`.
/// Doing so allows the same memory region to be shared between buffers.
///
/// # Safety
/// The caller must ensure `offset + length <= self.len()`
#[inline]
#[must_use]
pub unsafe fn sliced_unchecked(mut self, offset: usize, length: usize) -> Self {
self.slice_unchecked(offset, length);
self
}
/// Slices this buffer starting at `offset`.
///
/// # Safety
/// The caller must ensure `offset + length <= self.len()`
#[inline]
pub unsafe fn slice_unchecked(&mut self, offset: usize, length: usize) {
self.ptr = self.ptr.add(offset);
self.length = length;
}
/// Returns a pointer to the start of the storage underlying this buffer.
#[inline]
pub(crate) fn storage_ptr(&self) -> *const T {
self.storage.as_ptr()
}
/// Returns the start offset of this buffer within the underlying storage.
#[inline]
pub fn offset(&self) -> usize {
unsafe {
let ret = self.ptr.offset_from(self.storage.as_ptr()) as usize;
debug_assert!(ret <= self.storage.len());
ret
}
}
/// # Safety
/// The caller must ensure that the buffer was properly initialized up to `len`.
#[inline]
pub unsafe fn set_len(&mut self, len: usize) {
self.length = len;
}
/// Returns a mutable reference to its underlying [`Vec`], if possible.
///
/// This operation returns [`Either::Right`] iff this [`Buffer`]:
/// * has not been cloned (i.e. [`Arc`]`::get_mut` yields [`Some`])
/// * has not been imported from the C data interface (FFI)
#[inline]
pub fn into_mut(mut self) -> Either<Self, Vec<T>> {
// We lose information if the data is sliced.
if self.is_sliced() {
return Either::Left(self);
}
match Arc::get_mut(&mut self.storage)
.and_then(|b| b.get_vec())
.map(std::mem::take)
{
Some(inner) => Either::Right(inner),
None => Either::Left(self),
}
}
/// Returns a mutable reference to its slice, if possible.
///
/// This operation returns [`Some`] iff this [`Buffer`]:
/// * has not been cloned (i.e. [`Arc`]`::get_mut` yields [`Some`])
/// * has not been imported from the C data interface (FFI)
#[inline]
pub fn get_mut_slice(&mut self) -> Option<&mut [T]> {
let offset = self.offset();
let unique = Arc::get_mut(&mut self.storage)?;
let vec = unique.get_vec()?;
Some(unsafe { vec.get_unchecked_mut(offset..offset + self.length) })
}
/// Get the strong count of underlying `Arc` data buffer.
pub fn shared_count_strong(&self) -> usize {
Arc::strong_count(&self.storage)
}
/// Get the weak count of underlying `Arc` data buffer.
pub fn shared_count_weak(&self) -> usize {
Arc::weak_count(&self.storage)
}
}
impl<T: Clone> Buffer<T> {
pub fn make_mut(self) -> Vec<T> {
match self.into_mut() {
Either::Right(v) => v,
Either::Left(same) => same.as_slice().to_vec(),
}
}
}
impl<T: Zero + Copy> Buffer<T> {
pub fn zeroed(len: usize) -> Self {
vec![T::zero(); len].into()
}
}
impl<T> From<Vec<T>> for Buffer<T> {
#[inline]
fn from(p: Vec<T>) -> Self {
let bytes: Bytes<T> = p.into();
let ptr = bytes.as_ptr();
let length = bytes.len();
Self {
storage: Arc::new(bytes),
ptr,
length,
}
}
}
impl<T> std::ops::Deref for Buffer<T> {
type Target = [T];
#[inline]
fn deref(&self) -> &[T] {
self.as_slice()
}
}
impl<T> FromIterator<T> for Buffer<T> {
#[inline]
fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
Vec::from_iter(iter).into()
}
}
impl<T: Copy> IntoIterator for Buffer<T> {
type Item = T;
type IntoIter = IntoIter<T>;
fn into_iter(self) -> Self::IntoIter {
IntoIter::new(self)
}
}
#[cfg(feature = "arrow_rs")]
impl<T: crate::types::NativeType> From<arrow_buffer::Buffer> for Buffer<T> {
fn from(value: arrow_buffer::Buffer) -> Self {
Self::from_bytes(crate::buffer::to_bytes(value))
}
}
#[cfg(feature = "arrow_rs")]
impl<T: crate::types::NativeType> From<Buffer<T>> for arrow_buffer::Buffer {
fn from(value: Buffer<T>) -> Self {
let offset = value.offset();
crate::buffer::to_buffer(value.storage).slice_with_length(
offset * std::mem::size_of::<T>(),
value.length * std::mem::size_of::<T>(),
)
}
}
unsafe impl<'a, T: 'a> ArrayAccessor<'a> for Buffer<T> {
type Item = &'a T;
unsafe fn value_unchecked(&'a self, index: usize) -> Self::Item {
unsafe { &*self.ptr.add(index) }
}
fn len(&self) -> usize {
Buffer::len(self)
}
}
impl<T> Splitable for Buffer<T> {
#[inline(always)]
fn check_bound(&self, offset: usize) -> bool {
offset <= self.len()
}
unsafe fn _split_at_unchecked(&self, offset: usize) -> (Self, Self) {
let storage = &self.storage;
(
Self {
storage: storage.clone(),
ptr: self.ptr,
length: offset,
},
Self {
storage: storage.clone(),
ptr: self.ptr.wrapping_add(offset),
length: self.length - offset,
},
)
}
}