fluencelabs/wasmer
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasmer synced 2025-06-28 08:01:33 +00:00
Code Issues Projects Releases Wiki Activity

Deny missing docs in runtime core and add missing docs

Browse Source
This commit is contained in:
Brandon Fish
2019-11-10 13:13:18 -06:00
parent 0d644a53db
commit aad390d09d
32 changed files with 674 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
lib/runtime-core/src/loader.rs
View File

@ -1,3 +1,4 @@
//! The loader module functions are used to load an instance.
use crate::{backend::RunnableModule, module::ModuleInfo, types::Type, types::Value, vm::Ctx};
#[cfg(unix)]
use libc::{mmap, mprotect, munmap, MAP_ANON, MAP_PRIVATE, PROT_EXEC, PROT_READ, PROT_WRITE};
@ -6,10 +7,14 @@ use std::{
ops::{Deref, DerefMut},
};
/// The loader trait represents the functions used to load an instance.
pub trait Loader {
/// The type of `Instance` for the loader.
type Instance: Instance;
/// The error type returned by the loader.
type Error: Debug;
/// Loads the given module and context into an instance.
fn load(
&self,
rm: &dyn RunnableModule,
@ -18,18 +23,23 @@ pub trait Loader {
) -> Result<Self::Instance, Self::Error>;
}
/// This trait represents an instance used by the loader.
pub trait Instance {
/// The error type returned by this instance.
type Error: Debug;
/// Call a function by id with the given args.
fn call(&mut self, id: usize, args: &[Value]) -> Result<u128, Self::Error>;
/// Read memory at the given offset and length.
fn read_memory(&mut self, _offset: u32, _len: u32) -> Result<Vec<u8>, Self::Error> {
unimplemented!("Instance::read_memory")
}
/// Write memory at the given offset and length.
fn write_memory(&mut self, _offset: u32, _len: u32, _buf: &[u8]) -> Result<(), Self::Error> {
unimplemented!("Instance::write_memory")
}
}
/// A local implementation for `Loader`.
pub struct LocalLoader;
impl Loader for LocalLoader {
@ -54,6 +64,7 @@ impl Loader for LocalLoader {
}
}
/// A local instance.
pub struct LocalInstance {
code: CodeMemory,
offsets: Vec<usize>,
@ -111,6 +122,7 @@ impl Instance for LocalInstance {
}
}
/// A pointer to code in memory.
pub struct CodeMemory {
ptr: *mut u8,
size: usize,
@ -136,6 +148,7 @@ impl CodeMemory {
#[cfg(unix)]
impl CodeMemory {
/// Creates a new code memory with the given size.
pub fn new(size: usize) -> CodeMemory {
if size == 0 {
return CodeMemory {
@ -167,12 +180,14 @@ impl CodeMemory {
}
}
/// Makes this code memory executable.
pub fn make_executable(&self) {
if unsafe { mprotect(self.ptr as _, self.size, PROT_READ | PROT_EXEC) } != 0 {
panic!("cannot set code memory to executable");
}
}
/// Makes this code memory writable.
pub fn make_writable(&self) {
if unsafe { mprotect(self.ptr as _, self.size, PROT_READ | PROT_WRITE) } != 0 {
panic!("cannot set code memory to writable");