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
extern crate core;
pub mod btreemap;
pub mod cell;
#[cfg(target_arch = "wasm32")]
mod ic0_memory; pub mod log;
pub mod memory_manager;
pub mod reader;
pub mod storable;
#[cfg(test)]
mod tests;
mod types;
pub mod vec_mem;
pub mod writer;
pub use btreemap::{BTreeMap, BTreeMap as StableBTreeMap};
#[cfg(target_arch = "wasm32")]
pub use ic0_memory::Ic0StableMemory;
use std::error;
use std::fmt::{Display, Formatter};
pub use storable::Storable;
use types::Address;
pub use vec_mem::VectorMemory;
#[cfg(target_arch = "wasm32")]
pub type DefaultMemoryImpl = Ic0StableMemory;
#[cfg(not(target_arch = "wasm32"))]
pub type DefaultMemoryImpl = VectorMemory;
const WASM_PAGE_SIZE: u64 = 65536;
pub trait Memory {
fn size(&self) -> u64;
fn grow(&self, pages: u64) -> i64;
fn read(&self, offset: u64, dst: &mut [u8]);
fn write(&self, offset: u64, src: &[u8]);
}
fn read_u32<M: Memory>(m: &M, addr: Address) -> u32 {
let mut buf: [u8; 4] = [0; 4];
m.read(addr.get(), &mut buf);
u32::from_le_bytes(buf)
}
fn read_u64<M: Memory>(m: &M, addr: Address) -> u64 {
let mut buf: [u8; 8] = [0; 8];
m.read(addr.get(), &mut buf);
u64::from_le_bytes(buf)
}
fn write_u32<M: Memory>(m: &M, addr: Address, val: u32) {
write(m, addr.get(), &val.to_le_bytes());
}
fn write_u64<M: Memory>(m: &M, addr: Address, val: u64) {
write(m, addr.get(), &val.to_le_bytes());
}
#[derive(Debug)]
pub struct GrowFailed {
current_size: u64,
delta: u64,
}
impl Display for GrowFailed {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(
f,
"Failed to grow memory: current size={}, delta={}",
self.current_size, self.delta
)
}
}
impl error::Error for GrowFailed {}
fn safe_write<M: Memory>(memory: &M, offset: u64, bytes: &[u8]) -> Result<(), GrowFailed> {
let last_byte = offset
.checked_add(bytes.len() as u64)
.expect("Address space overflow");
let size_pages = memory.size();
let size_bytes = size_pages
.checked_mul(WASM_PAGE_SIZE)
.expect("Address space overflow");
if size_bytes < last_byte {
let diff_bytes = last_byte - size_bytes;
let diff_pages = diff_bytes
.checked_add(WASM_PAGE_SIZE - 1)
.expect("Address space overflow")
/ WASM_PAGE_SIZE;
if memory.grow(diff_pages) == -1 {
return Err(GrowFailed {
current_size: size_pages,
delta: diff_pages,
});
}
}
memory.write(offset, bytes);
Ok(())
}
fn write<M: Memory>(memory: &M, offset: u64, bytes: &[u8]) {
if let Err(GrowFailed {
current_size,
delta,
}) = safe_write(memory, offset, bytes)
{
panic!(
"Failed to grow memory from {} pages to {} pages (delta = {} pages).",
current_size,
current_size + delta,
delta
);
}
}
fn read_struct<T, M: Memory>(addr: Address, memory: &M) -> T {
let mut t: T = unsafe { core::mem::zeroed() };
let t_slice = unsafe {
core::slice::from_raw_parts_mut(&mut t as *mut _ as *mut u8, core::mem::size_of::<T>())
};
memory.read(addr.get(), t_slice);
t
}
fn write_struct<T, M: Memory>(t: &T, addr: Address, memory: &M) {
let slice = unsafe {
core::slice::from_raw_parts(t as *const _ as *const u8, core::mem::size_of::<T>())
};
write(memory, addr.get(), slice)
}
#[derive(Clone)]
pub struct RestrictedMemory<M: Memory> {
page_range: core::ops::Range<u64>,
memory: M,
}
impl<M: Memory> RestrictedMemory<M> {
pub fn new(memory: M, page_range: core::ops::Range<u64>) -> Self {
assert!(page_range.end < u64::MAX / WASM_PAGE_SIZE);
Self { memory, page_range }
}
}
impl<M: Memory> Memory for RestrictedMemory<M> {
fn size(&self) -> u64 {
let base_size = self.memory.size();
if base_size < self.page_range.start {
0
} else if base_size > self.page_range.end {
self.page_range.end - self.page_range.start
} else {
base_size - self.page_range.start
}
}
fn grow(&self, delta: u64) -> i64 {
let base_size = self.memory.size();
if base_size < self.page_range.start {
self.memory
.grow(self.page_range.start - base_size + delta)
.min(0)
} else if base_size >= self.page_range.end {
if delta == 0 {
(self.page_range.end - self.page_range.start) as i64
} else {
-1
}
} else {
let pages_left = self.page_range.end - base_size;
if pages_left < delta {
-1
} else {
let r = self.memory.grow(delta);
if r < 0 {
r
} else {
r - self.page_range.start as i64
}
}
}
}
fn read(&self, offset: u64, dst: &mut [u8]) {
self.memory
.read(self.page_range.start * WASM_PAGE_SIZE + offset, dst)
}
fn write(&self, offset: u64, src: &[u8]) {
self.memory
.write(self.page_range.start * WASM_PAGE_SIZE + offset, src)
}
}