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 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
use super::{shared::SharedMemory, view::*};
use wasmer_types::{MemoryError, MemoryType, Pages};
use crate::{
macros::backend::{gen_rt_ty, match_rt},
vm::{VMExtern, VMExternMemory, VMMemory},
AsStoreMut, AsStoreRef, ExportError, Exportable, Extern, StoreMut, StoreRef,
};
gen_rt_ty!(Memory
@cfg feature = "artifact-size" => derive(loupe::MemoryUsage)
@derives Debug, Clone, PartialEq, Eq, derive_more::From
);
impl BackendMemory {
/// Creates a new host [`BackendMemory`] from the provided [`MemoryType`].
///
/// This function will construct the `Memory` using the store
/// `BaseTunables`.
///
/// # Example
///
/// ```
/// # use wasmer::{Memory, MemoryType, Pages, Store, Type, Value};
/// # let mut store = Store::default();
/// #
/// let m = Memory::new(&mut store, MemoryType::new(1, None, false)).unwrap();
/// ```
#[inline]
pub fn new(store: &mut impl AsStoreMut, ty: MemoryType) -> Result<Self, MemoryError> {
match &store.as_store_mut().inner.store {
#[cfg(feature = "sys")]
crate::BackendStore::Sys(s) => Ok(Self::Sys(
crate::backend::sys::entities::memory::Memory::new(store, ty)?,
)),
#[cfg(feature = "wamr")]
crate::BackendStore::Wamr(s) => Ok(Self::Wamr(
crate::backend::wamr::entities::memory::Memory::new(store, ty)?,
)),
#[cfg(feature = "wasmi")]
crate::BackendStore::Wasmi(s) => Ok(Self::Wasmi(
crate::backend::wasmi::entities::memory::Memory::new(store, ty)?,
)),
#[cfg(feature = "v8")]
crate::BackendStore::V8(s) => Ok(Self::V8(
crate::backend::v8::entities::memory::Memory::new(store, ty)?,
)),
#[cfg(feature = "js")]
crate::BackendStore::Js(s) => Ok(Self::Js(
crate::backend::js::entities::memory::Memory::new(store, ty)?,
)),
#[cfg(feature = "jsc")]
crate::BackendStore::Jsc(s) => Ok(Self::Jsc(
crate::backend::jsc::entities::memory::Memory::new(store, ty)?,
)),
}
}
/// Create a memory object from an existing memory and attaches it to the store
#[inline]
pub fn new_from_existing(new_store: &mut impl AsStoreMut, memory: VMMemory) -> Self {
match new_store.as_store_mut().inner.store {
#[cfg(feature = "sys")]
crate::BackendStore::Sys(_) => Self::Sys(
crate::backend::sys::entities::memory::Memory::new_from_existing(
new_store,
memory.into_sys(),
),
),
#[cfg(feature = "wamr")]
crate::BackendStore::Wamr(_) => Self::Wamr(
crate::backend::wamr::entities::memory::Memory::new_from_existing(
new_store,
memory.into_wamr(),
),
),
#[cfg(feature = "wasmi")]
crate::BackendStore::Wasmi(_) => Self::Wasmi(
crate::backend::wasmi::entities::memory::Memory::new_from_existing(
new_store,
memory.into_wasmi(),
),
),
#[cfg(feature = "v8")]
crate::BackendStore::V8(_) => Self::V8(
crate::backend::v8::entities::memory::Memory::new_from_existing(
new_store,
memory.into_v8(),
),
),
#[cfg(feature = "js")]
crate::BackendStore::Js(_) => Self::Js(
crate::backend::js::entities::memory::Memory::new_from_existing(
new_store,
memory.into_js(),
),
),
#[cfg(feature = "jsc")]
crate::BackendStore::Jsc(_) => Self::Jsc(
crate::backend::jsc::entities::memory::Memory::new_from_existing(
new_store,
memory.into_jsc(),
),
),
}
}
/// Returns the [`MemoryType`] of the [`BackendMemory`].
///
/// # Example
///
/// ```
/// # use wasmer::{Memory, MemoryType, Pages, Store, Type, Value};
/// # let mut store = Store::default();
/// #
/// let mt = MemoryType::new(1, None, false);
/// let m = Memory::new(&mut store, mt).unwrap();
///
/// assert_eq!(m.ty(&mut store), mt);
/// ```
#[inline]
pub fn ty(&self, store: &impl AsStoreRef) -> MemoryType {
match_rt!(on self => s {
s.ty(store)
})
}
/// Grow memory by the specified amount of WebAssembly [`Pages`] and return
/// the previous memory size.
///
/// # Example
///
/// ```
/// # use wasmer::{Memory, MemoryType, Pages, Store, Type, Value, WASM_MAX_PAGES};
/// # let mut store = Store::default();
/// #
/// let m = Memory::new(&mut store, MemoryType::new(1, Some(3), false)).unwrap();
/// let p = m.grow(&mut store, 2).unwrap();
///
/// assert_eq!(p, Pages(1));
/// assert_eq!(m.view(&mut store).size(), Pages(3));
/// ```
///
/// # Errors
///
/// Returns an error if memory can't be grown by the specified amount
/// of pages.
///
/// ```should_panic
/// # use wasmer::{Memory, MemoryType, Pages, Store, Type, Value, WASM_MAX_PAGES};
/// # use wasmer::FunctionEnv;
/// # let mut store = Store::default();
/// # let env = FunctionEnv::new(&mut store, ());
/// #
/// let m = Memory::new(&mut store, MemoryType::new(1, Some(1), false)).unwrap();
///
/// // This results in an error: `MemoryError::CouldNotGrow`.
/// let s = m.grow(&mut store, 1).unwrap();
/// ```
#[inline]
pub fn grow<IntoPages>(
&self,
store: &mut impl AsStoreMut,
delta: IntoPages,
) -> Result<Pages, MemoryError>
where
IntoPages: Into<Pages>,
{
match_rt!(on self => s {
s.grow(store, delta)
})
}
/// Grows the memory to at least a minimum size.
///
/// # Note
///
/// If the memory is already big enough for the min size this function does nothing.
#[inline]
pub fn grow_at_least(
&self,
store: &mut impl AsStoreMut,
min_size: u64,
) -> Result<(), MemoryError> {
match_rt!(on self => s {
s.grow_at_least(store, min_size)
})
}
/// Resets the memory back to zero length
#[inline]
pub fn reset(&self, store: &mut impl AsStoreMut) -> Result<(), MemoryError> {
match_rt!(on self => s {
s.reset(store)
})
}
/// Attempts to duplicate this memory (if its clonable) in a new store
/// (copied memory)
#[inline]
pub fn copy_to_store(
&self,
store: &impl AsStoreRef,
new_store: &mut impl AsStoreMut,
) -> Result<Self, MemoryError> {
if !self.ty(store).shared {
// We should only be able to duplicate in a new store if the memory is shared
return Err(MemoryError::InvalidMemory {
reason: "memory is not a shared memory type".to_string(),
});
}
match self {
#[cfg(feature = "sys")]
Self::Sys(s) => s.try_copy(store).map(|new_memory| {
Self::new_from_existing(
new_store,
VMMemory::Sys(crate::backend::sys::vm::VMMemory(new_memory)),
)
}),
#[cfg(feature = "wamr")]
Self::Wamr(s) => s
.try_copy(store)
.map(|new_memory| Self::new_from_existing(new_store, VMMemory::Wamr(new_memory))),
#[cfg(feature = "wasmi")]
Self::Wasmi(s) => s
.try_copy(store)
.map(|new_memory| Self::new_from_existing(new_store, VMMemory::Wasmi(new_memory))),
#[cfg(feature = "v8")]
Self::V8(s) => s
.try_copy(store)
.map(|new_memory| Self::new_from_existing(new_store, VMMemory::V8(new_memory))),
#[cfg(feature = "js")]
Self::Js(s) => s
.try_copy(store)
.map(|new_memory| Self::new_from_existing(new_store, VMMemory::Js(new_memory))),
#[cfg(feature = "jsc")]
Self::Jsc(s) => s
.try_copy(store)
.map(|new_memory| Self::new_from_existing(new_store, VMMemory::Jsc(new_memory))),
}
}
#[inline]
pub(crate) fn from_vm_extern(store: &mut impl AsStoreMut, vm_extern: VMExternMemory) -> Self {
match &store.as_store_mut().inner.store {
#[cfg(feature = "sys")]
crate::BackendStore::Sys(s) => Self::Sys(
crate::backend::sys::entities::memory::Memory::from_vm_extern(store, vm_extern),
),
#[cfg(feature = "wamr")]
crate::BackendStore::Wamr(s) => Self::Wamr(
crate::backend::wamr::entities::memory::Memory::from_vm_extern(store, vm_extern),
),
#[cfg(feature = "wasmi")]
crate::BackendStore::Wasmi(s) => Self::Wasmi(
crate::backend::wasmi::entities::memory::Memory::from_vm_extern(store, vm_extern),
),
#[cfg(feature = "v8")]
crate::BackendStore::V8(s) => Self::V8(
crate::backend::v8::entities::memory::Memory::from_vm_extern(store, vm_extern),
),
#[cfg(feature = "js")]
crate::BackendStore::Js(s) => Self::Js(
crate::backend::js::entities::memory::Memory::from_vm_extern(store, vm_extern),
),
#[cfg(feature = "jsc")]
crate::BackendStore::Jsc(s) => Self::Jsc(
crate::backend::jsc::entities::memory::Memory::from_vm_extern(store, vm_extern),
),
}
}
/// Checks whether this `Memory` can be used with the given context.
#[inline]
pub fn is_from_store(&self, store: &impl AsStoreRef) -> bool {
match_rt!(on self => s {
s.is_from_store(store)
})
}
/// Attempt to create a new reference to the underlying memory; this new reference can then be
/// used within a different store (from the same implementer).
///
/// # Errors
///
/// Fails if the underlying memory is not clonable.
#[inline]
pub fn try_clone(&self, store: &impl AsStoreRef) -> Result<VMMemory, MemoryError> {
match self {
#[cfg(feature = "sys")]
Self::Sys(s) => s.try_clone(store).map(VMMemory::Sys),
#[cfg(feature = "wamr")]
Self::Wamr(s) => s.try_clone(store).map(VMMemory::Wamr),
#[cfg(feature = "wasmi")]
Self::Wasmi(s) => s.try_clone(store).map(VMMemory::Wasmi),
#[cfg(feature = "v8")]
Self::V8(s) => s.try_clone(store).map(VMMemory::V8),
#[cfg(feature = "js")]
Self::Js(s) => s.try_clone(store).map(VMMemory::Js),
#[cfg(feature = "jsc")]
Self::Jsc(s) => s.try_clone(store).map(VMMemory::Jsc),
}
}
/// Attempts to clone this memory (if its clonable) in a new store
/// (cloned memory will be shared between those that clone it)
#[inline]
pub fn share_in_store(
&self,
store: &impl AsStoreRef,
new_store: &mut impl AsStoreMut,
) -> Result<Self, MemoryError> {
if !self.ty(store).shared {
// We should only be able to duplicate in a new store if the memory is shared
return Err(MemoryError::InvalidMemory {
reason: "memory is not a shared memory type".to_string(),
});
}
match self {
#[cfg(feature = "sys")]
Self::Sys(s) => s
.try_clone(store)
.map(|new_memory| Self::new_from_existing(new_store, VMMemory::Sys(new_memory))),
#[cfg(feature = "wamr")]
Self::Wamr(s) => s
.try_clone(store)
.map(|new_memory| Self::new_from_existing(new_store, VMMemory::Wamr(new_memory))),
#[cfg(feature = "wasmi")]
Self::Wasmi(s) => s
.try_clone(store)
.map(|new_memory| Self::new_from_existing(new_store, VMMemory::Wasmi(new_memory))),
#[cfg(feature = "v8")]
Self::V8(s) => s
.try_clone(store)
.map(|new_memory| Self::new_from_existing(new_store, VMMemory::V8(new_memory))),
#[cfg(feature = "js")]
Self::Js(s) => s
.try_clone(store)
.map(|new_memory| Self::new_from_existing(new_store, VMMemory::Js(new_memory))),
#[cfg(feature = "jsc")]
Self::Jsc(s) => s
.try_clone(store)
.map(|new_memory| Self::new_from_existing(new_store, VMMemory::Jsc(new_memory))),
}
}
/// Get a [`SharedMemory`].
///
/// Only returns `Some(_)` if the memory is shared, and if the target
/// backend supports shared memory operations.
///
/// See [`SharedMemory`] and its methods for more information.
#[inline]
pub fn as_shared(&self, store: &impl AsStoreRef) -> Option<SharedMemory> {
if !self.ty(store).shared {
return None;
}
match_rt!(on self => s {
s.as_shared(store)
})
}
/// Create a [`VMExtern`] from self.
#[inline]
pub(crate) fn to_vm_extern(&self) -> VMExtern {
match_rt!(on self => s {
s.to_vm_extern()
})
}
}