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
/*
* Copyright 2022 Fluence Labs Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use super::generic::*;
use crate::module::MModule;
use crate::module::MRecordTypes;
use crate::{IRecordType, IValue, MemoryStats, MError, MFunctionSignature, ModuleMemoryStat, MResult};
use marine_wasm_backend_traits::AsContextMut;
use marine_wasm_backend_traits::Store;
use marine_wasm_backend_traits::WasiState;
use marine_wasm_backend_traits::WasmBackend;
use serde::Serialize;
use std::collections::hash_map::Entry;
use std::collections::HashMap;
use std::sync::Arc;
use std::cell::RefCell;
/// Represent Marine module interface.
#[derive(PartialEq, Eq, Debug, Clone, Serialize)]
pub struct MModuleInterface<'a> {
pub record_types: &'a MRecordTypes,
pub function_signatures: Vec<MFunctionSignature>,
}
/// # Description
///
/// The base struct of Marine, the Fluence compute runtime.
/// Allows dynamic loading and unloading modules, but never frees resources used for instantiation.
/// A new module can import functions from previously loaded modules.
///
/// # Recommendations
///
/// Its not recommended to use this struct to load/unload unlimited number of modules.
/// Better alternative is to use multiple instances of this struct for independent groups of modules
/// and drop them when the group is no longer needed.
pub struct MarineCore<WB: WasmBackend> {
// set of modules registered inside Marine
modules: HashMap<String, MModule<WB>>,
// Wasm backend may have state in the future
#[allow(unused)]
wasm_backend: WB,
/// Container for all objects created by a Wasm backend.
store: RefCell<<WB as WasmBackend>::Store>,
}
impl<WB: WasmBackend> MarineCore<WB> {
pub fn new() -> MResult<Self> {
let wasm_backend = WB::new()?;
let store = <WB as WasmBackend>::Store::new(&wasm_backend);
Ok(Self {
modules: HashMap::new(),
wasm_backend,
store: RefCell::new(store),
})
}
/// Invoke a function of a module inside Marine by given function name with given arguments.
pub fn call(
&mut self,
module_name: impl AsRef<str>,
func_name: impl AsRef<str>,
arguments: &[IValue],
) -> MResult<Vec<IValue>> {
let module_name = module_name.as_ref();
let store = &mut self.store;
self.modules.get_mut(module_name).map_or_else(
|| Err(MError::NoSuchModule(module_name.to_string())),
|module| {
module.call(
&mut store.get_mut().as_context_mut(),
module_name,
func_name.as_ref(),
arguments,
)
},
)
}
/// Load a new module inside Marine.
pub fn load_module(
&mut self,
name: impl Into<String>,
wasm_bytes: &[u8],
config: MModuleConfig<WB>,
) -> MResult<()> {
self.load_module_(name.into(), wasm_bytes, config)
}
fn load_module_(
&mut self,
name: String,
wasm_bytes: &[u8],
config: MModuleConfig<WB>,
) -> MResult<()> {
let module = MModule::new(
&name,
self.store.get_mut(),
wasm_bytes,
config,
&self.modules,
)?;
match self.modules.entry(name) {
Entry::Vacant(entry) => {
entry.insert(module);
Ok(())
}
Entry::Occupied(entry) => Err(MError::NonUniqueModuleName(entry.key().clone())),
}
}
/// Unload previously loaded module.
pub fn unload_module(&mut self, name: impl AsRef<str>) -> MResult<()> {
// TODO: clean up all reference from adaptors after adding support of lazy linking
self.modules
.remove(name.as_ref())
.map(|_| ())
.ok_or_else(|| MError::NoSuchModule(name.as_ref().to_string()))
}
pub fn module_wasi_state<'s>(
&'s mut self,
module_name: impl AsRef<str>,
) -> Option<Box<dyn WasiState + 's>> {
self.modules
.get_mut(module_name.as_ref())
.map(|module| module.get_wasi_state())
}
/// Return function signatures of all loaded info Marine modules with their names.
pub fn interface(&self) -> impl Iterator<Item = (&str, MModuleInterface<'_>)> {
self.modules
.iter()
.map(|(module_name, module)| (module_name.as_str(), Self::get_module_interface(module)))
}
/// Return function signatures exported by module with given name.
pub fn module_interface(&self, module_name: impl AsRef<str>) -> Option<MModuleInterface<'_>> {
self.modules
.get(module_name.as_ref())
.map(Self::get_module_interface)
}
/// Return record types exported by module with given name.
pub fn module_record_types(&self, module_name: impl AsRef<str>) -> Option<&MRecordTypes> {
self.modules
.get(module_name.as_ref())
.map(|module| module.export_record_types())
}
/// Return record type for supplied record id exported by module with given name.
pub fn module_record_type_by_id(
&self,
module_name: impl AsRef<str>,
record_id: u64,
) -> Option<&Arc<IRecordType>> {
self.modules
.get(module_name.as_ref())
.and_then(|module| module.export_record_type_by_id(record_id))
}
/// Returns a heap size that all modules consume in bytes.
pub fn module_memory_stats(&self) -> MemoryStats<'_> {
let records = self
.modules
.iter()
.map(|(module_name, module)| {
ModuleMemoryStat::new(
module_name,
module.memory_size(&mut self.store.borrow_mut().as_context_mut()),
module.max_memory_size(),
)
})
.collect::<Vec<_>>();
records.into()
}
fn get_module_interface(module: &MModule<WB>) -> MModuleInterface<'_> {
let record_types = module.export_record_types();
let function_signatures = module.get_exports_signatures().collect::<Vec<_>>();
MModuleInterface {
record_types,
function_signatures,
}
}
}