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
//! COW (Copy-on-Write) buffer -- the fundamental memory primitive under [`Tensor`].
//!
//! [`Buffer<T>`] provides reference-counted storage with lazy deep-copy
//! semantics. Cloning a buffer increments the refcount (O(1)); mutation
//! via [`Buffer::set`] or [`Buffer::make_unique`] triggers a deep copy
//! only when the buffer is shared (`refcount > 1`).
//!
//! # Determinism
//!
//! Buffer operations are fully deterministic. No randomized hashing,
//! no platform-dependent allocation strategies. The COW mechanism
//! ensures that mutation of shared data always produces a fresh,
//! independent copy.
//!
//! [`Tensor`]: crate::tensor::Tensor
use std::cell::{Ref, RefCell};
use std::rc::Rc;
use crate::error::RuntimeError;
// ---------------------------------------------------------------------------
// 1. Buffer<T> -- Deterministic memory allocation with COW semantics
// ---------------------------------------------------------------------------
/// A reference-counted buffer with copy-on-write semantics.
///
/// Internally backed by `Rc<RefCell<Vec<T>>>`. When multiple `Buffer`s share
/// the same underlying storage, a mutation via [`Buffer::set`] or
/// [`Buffer::make_unique`] triggers a deep copy so that other holders are
/// unaffected.
#[derive(Debug)]
pub struct Buffer<T: Clone> {
inner: Rc<RefCell<Vec<T>>>,
}
impl<T: Clone> Buffer<T> {
/// Allocate a buffer of `len` elements, each initialized to `default`.
pub fn alloc(len: usize, default: T) -> Self {
Buffer {
inner: Rc::new(RefCell::new(vec![default; len])),
}
}
/// Create a buffer from an existing `Vec<T>`.
pub fn from_vec(data: Vec<T>) -> Self {
Buffer {
inner: Rc::new(RefCell::new(data)),
}
}
/// Number of elements in the buffer.
pub fn len(&self) -> usize {
self.inner.borrow().len()
}
/// Whether the buffer is empty.
pub fn is_empty(&self) -> bool {
self.inner.borrow().is_empty()
}
/// Read the value at `idx`. Returns `None` if out of bounds.
pub fn get(&self, idx: usize) -> Option<T> {
self.inner.borrow().get(idx).cloned()
}
/// Write `val` at `idx`. If the buffer is shared (refcount > 1), a deep
/// copy is performed first (COW). Returns `Err` if `idx` is out of bounds.
pub fn set(&mut self, idx: usize, val: T) -> Result<(), RuntimeError> {
self.make_unique();
let mut vec = self.inner.borrow_mut();
if idx >= vec.len() {
return Err(RuntimeError::IndexOutOfBounds {
index: idx,
length: vec.len(),
});
}
vec[idx] = val;
Ok(())
}
/// Return a snapshot of the data as a `Vec<T>`.
pub fn as_slice(&self) -> Vec<T> {
self.inner.borrow().clone()
}
/// Borrow the underlying Vec without cloning.
/// The returned `Ref` guard keeps the borrow alive.
pub fn borrow_data(&self) -> Ref<Vec<T>> {
self.inner.borrow()
}
/// Force a deep copy, returning a new `Buffer` that does not share
/// storage with `self`.
pub fn clone_buffer(&self) -> Buffer<T> {
Buffer {
inner: Rc::new(RefCell::new(self.inner.borrow().clone())),
}
}
/// Ensure this `Buffer` has exclusive ownership of the underlying data.
/// If the refcount is > 1, the data is deep-copied and this `Buffer` is
/// re-pointed to the fresh copy.
pub fn make_unique(&mut self) {
if Rc::strong_count(&self.inner) > 1 {
let data = self.inner.borrow().clone();
self.inner = Rc::new(RefCell::new(data));
}
}
/// Number of live references to the underlying storage.
pub fn refcount(&self) -> usize {
Rc::strong_count(&self.inner)
}
}
impl<T: Clone> Clone for Buffer<T> {
/// Cloning a `Buffer` increments the refcount — it does NOT copy data.
fn clone(&self) -> Self {
Buffer {
inner: Rc::clone(&self.inner),
}
}
}