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
mod canister;
#[cfg(test)]
mod tests;
pub use canister::CanisterStableMemory;
use std::{error, fmt, io};
const WASM_PAGE_SIZE_IN_BYTES: usize = 64 * 1024;
static CANISTER_STABLE_MEMORY: CanisterStableMemory = CanisterStableMemory {};
pub trait StableMemory {
fn stable_size(&self) -> u32;
fn stable64_size(&self) -> u64;
fn stable_grow(&self, new_pages: u32) -> Result<u32, StableMemoryError>;
fn stable64_grow(&self, new_pages: u64) -> Result<u64, StableMemoryError>;
fn stable_write(&self, offset: u32, buf: &[u8]);
fn stable64_write(&self, offset: u64, buf: &[u8]);
fn stable_read(&self, offset: u32, buf: &mut [u8]);
fn stable64_read(&self, offset: u64, buf: &mut [u8]);
}
pub fn stable_size() -> u32 {
CANISTER_STABLE_MEMORY.stable_size()
}
pub fn stable64_size() -> u64 {
CANISTER_STABLE_MEMORY.stable64_size()
}
#[derive(Debug)]
pub enum StableMemoryError {
OutOfMemory,
OutOfBounds,
}
impl fmt::Display for StableMemoryError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
Self::OutOfMemory => f.write_str("Out of memory"),
Self::OutOfBounds => f.write_str("Read exceeds allocated memory"),
}
}
}
impl error::Error for StableMemoryError {}
pub fn stable_grow(new_pages: u32) -> Result<u32, StableMemoryError> {
CANISTER_STABLE_MEMORY.stable_grow(new_pages)
}
pub fn stable64_grow(new_pages: u64) -> Result<u64, StableMemoryError> {
CANISTER_STABLE_MEMORY.stable64_grow(new_pages)
}
pub fn stable_write(offset: u32, buf: &[u8]) {
CANISTER_STABLE_MEMORY.stable_write(offset, buf)
}
pub fn stable64_write(offset: u64, buf: &[u8]) {
CANISTER_STABLE_MEMORY.stable64_write(offset, buf)
}
pub fn stable_read(offset: u32, buf: &mut [u8]) {
CANISTER_STABLE_MEMORY.stable_read(offset, buf)
}
pub fn stable64_read(offset: u64, buf: &mut [u8]) {
CANISTER_STABLE_MEMORY.stable64_read(offset, buf)
}
pub fn stable_bytes() -> Vec<u8> {
let size = (stable_size() as usize) << 16;
let mut vec = Vec::with_capacity(size);
unsafe {
super::ic0::stable_read(vec.as_ptr() as i32, 0, size as i32);
vec.set_len(size);
}
vec
}
pub struct StableWriter<M: StableMemory = CanisterStableMemory> {
offset: usize,
capacity: u32,
memory: M,
}
impl Default for StableWriter {
fn default() -> Self {
Self::with_memory(CanisterStableMemory::default(), 0)
}
}
impl<M: StableMemory> StableWriter<M> {
pub fn with_memory(memory: M, offset: usize) -> Self {
let capacity = memory.stable_size();
Self {
offset,
capacity,
memory,
}
}
pub fn grow(&mut self, new_pages: u32) -> Result<(), StableMemoryError> {
let old_page_count = self.memory.stable_grow(new_pages)?;
self.capacity = old_page_count + new_pages;
Ok(())
}
pub fn write(&mut self, buf: &[u8]) -> Result<usize, StableMemoryError> {
let required_capacity_bytes = self.offset + buf.len();
let required_capacity_pages = ((required_capacity_bytes + WASM_PAGE_SIZE_IN_BYTES - 1)
/ WASM_PAGE_SIZE_IN_BYTES) as u32;
let current_pages = self.capacity;
let additional_pages_required = required_capacity_pages.saturating_sub(current_pages);
if additional_pages_required > 0 {
self.grow(additional_pages_required)?;
}
self.memory.stable_write(self.offset as u32, buf);
self.offset += buf.len();
Ok(buf.len())
}
}
impl<M: StableMemory> io::Write for StableWriter<M> {
fn write(&mut self, buf: &[u8]) -> Result<usize, io::Error> {
self.write(buf)
.map_err(|e| io::Error::new(io::ErrorKind::OutOfMemory, e))
}
fn flush(&mut self) -> Result<(), io::Error> {
Ok(())
}
}
pub struct BufferedStableWriter<M: StableMemory = CanisterStableMemory> {
inner: io::BufWriter<StableWriter<M>>,
}
impl BufferedStableWriter {
pub fn new(buffer_size: usize) -> BufferedStableWriter {
BufferedStableWriter::with_writer(buffer_size, StableWriter::default())
}
}
impl<M: StableMemory> BufferedStableWriter<M> {
pub fn with_writer(buffer_size: usize, writer: StableWriter<M>) -> BufferedStableWriter<M> {
BufferedStableWriter {
inner: io::BufWriter::with_capacity(buffer_size, writer),
}
}
}
impl<M: StableMemory> io::Write for BufferedStableWriter<M> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
self.inner.write(buf)
}
fn flush(&mut self) -> io::Result<()> {
self.inner.flush()
}
}
pub struct StableReader<M: StableMemory = CanisterStableMemory> {
offset: usize,
capacity: u32,
memory: M,
}
impl Default for StableReader {
fn default() -> Self {
Self::with_memory(CanisterStableMemory::default(), 0)
}
}
impl<M: StableMemory> StableReader<M> {
pub fn with_memory(memory: M, offset: usize) -> Self {
let capacity = memory.stable_size();
Self {
offset,
capacity,
memory,
}
}
pub fn read(&mut self, buf: &mut [u8]) -> Result<usize, StableMemoryError> {
let capacity_bytes = self.capacity as usize * WASM_PAGE_SIZE_IN_BYTES;
let read_buf = if buf.len() + self.offset > capacity_bytes {
if self.offset < capacity_bytes {
&mut buf[..capacity_bytes - self.offset]
} else {
return Err(StableMemoryError::OutOfBounds);
}
} else {
buf
};
self.memory.stable_read(self.offset as u32, read_buf);
self.offset += read_buf.len();
Ok(read_buf.len())
}
}
impl<M: StableMemory> io::Read for StableReader<M> {
fn read(&mut self, buf: &mut [u8]) -> Result<usize, io::Error> {
self.read(buf).or(Ok(0))
}
}
pub struct BufferedStableReader<M: StableMemory = CanisterStableMemory> {
inner: io::BufReader<StableReader<M>>,
}
impl BufferedStableReader {
pub fn new(buffer_size: usize) -> BufferedStableReader {
BufferedStableReader::with_reader(buffer_size, StableReader::default())
}
}
impl<M: StableMemory> BufferedStableReader<M> {
pub fn with_reader(buffer_size: usize, reader: StableReader<M>) -> BufferedStableReader<M> {
BufferedStableReader {
inner: io::BufReader::with_capacity(buffer_size, reader),
}
}
}
impl<M: StableMemory> io::Read for BufferedStableReader<M> {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
self.inner.read(buf)
}
}