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 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
use alloc::collections::btree_map::BTreeMap;
use alloc::string::{String, ToString};
use alloc::vec;
use alloc::vec::Vec;
use const_interpreter_loop::{run_const, run_const_span};
use execution_info::ExecutionInfo;
use function_ref::FunctionRef;
use interpreter_loop::run;
use locals::Locals;
use lut::Lut;
use store::{DataInst, ElemInst, ImportedFuncInst, LocalFuncInst, TableInst};
use value::{ExternAddr, FuncAddr, Ref};
use value_stack::Stack;
use crate::core::error::StoreInstantiationError;
use crate::core::reader::types::element::{ElemItems, ElemMode};
use crate::core::reader::types::export::ExportDesc;
use crate::core::reader::types::import::ImportDesc;
use crate::core::reader::WasmReader;
use crate::execution::assert_validated::UnwrapValidatedExt;
use crate::execution::hooks::{EmptyHookSet, HookSet};
use crate::execution::store::{FuncInst, GlobalInst, MemInst, Store};
use crate::execution::value::Value;
use crate::validation::code::read_declared_locals;
use crate::value::InteropValueList;
use crate::{RefType, Result as CustomResult, RuntimeError, ValType, ValidationInfo};
// TODO
pub(crate) mod assert_validated;
pub mod const_interpreter_loop;
pub(crate) mod execution_info;
pub mod function_ref;
pub mod hooks;
mod interpreter_loop;
pub(crate) mod locals;
pub(crate) mod lut;
pub(crate) mod store;
pub mod value;
pub mod value_stack;
/// The default module name if a [RuntimeInstance] was created using [RuntimeInstance::new].
pub const DEFAULT_MODULE: &str = "__interpreter_default__";
pub struct RuntimeInstance<'b, H = EmptyHookSet>
where
H: HookSet,
{
pub modules: Vec<ExecutionInfo<'b>>,
module_map: BTreeMap<String, usize>,
lut: Option<Lut>,
pub hook_set: H,
}
impl<'b> RuntimeInstance<'b, EmptyHookSet> {
pub fn new(validation_info: &'_ ValidationInfo<'b>) -> CustomResult<Self> {
Self::new_with_hooks(DEFAULT_MODULE, validation_info, EmptyHookSet)
}
pub fn new_named(
module_name: &str,
validation_info: &'_ ValidationInfo<'b>,
) -> CustomResult<Self> {
Self::new_with_hooks(module_name, validation_info, EmptyHookSet)
}
}
impl<'b, H> RuntimeInstance<'b, H>
where
H: HookSet,
{
pub fn new_with_hooks(
module_name: &str,
validation_info: &'_ ValidationInfo<'b>,
hook_set: H,
) -> CustomResult<Self> {
trace!("Starting instantiation of bytecode");
let mut instance = RuntimeInstance {
modules: Vec::new(),
module_map: BTreeMap::new(),
lut: None,
hook_set,
};
instance.add_module(module_name, validation_info)?;
// TODO: how do we handle the start function, if we don't have a LUT yet?
if let Some(start) = validation_info.start {
// "start" is not always exported, so we need create a non-API exposed function reference.
// Note: function name is not important here, as it is not used in the verification process.
let start_fn = FunctionRef {
module_name: module_name.to_string(),
function_name: "start".to_string(),
module_index: 0,
function_index: start,
exported: false,
};
instance.invoke::<(), ()>(&start_fn, ())?;
}
Ok(instance)
}
pub fn get_function_by_name(
&self,
module_name: &str,
function_name: &str,
) -> Result<FunctionRef, RuntimeError> {
let (module_idx, func_idx) = self.get_indicies(module_name, function_name)?;
Ok(FunctionRef {
module_name: module_name.to_string(),
function_name: function_name.to_string(),
module_index: module_idx,
function_index: func_idx,
exported: true,
})
}
pub fn get_function_by_index(
&self,
module_idx: usize,
function_idx: usize,
) -> Result<FunctionRef, RuntimeError> {
let module = self
.modules
.get(module_idx)
.ok_or(RuntimeError::ModuleNotFound)?;
let function_name = module
.store
.exports
.iter()
.find(|export| match &export.desc {
ExportDesc::FuncIdx(idx) => *idx == function_idx,
_ => false,
})
.map(|export| export.name.clone())
.ok_or(RuntimeError::FunctionNotFound)?;
Ok(FunctionRef {
module_name: module.name.clone(),
function_name,
module_index: module_idx,
function_index: function_idx,
exported: true,
})
}
pub fn add_module(
&mut self,
module_name: &str,
validation_info: &'_ ValidationInfo<'b>,
) -> CustomResult<()> {
let store = Self::init_store(validation_info)?;
let exec_info = ExecutionInfo::new(
module_name,
validation_info.wasm,
validation_info.types.clone(),
store,
);
self.module_map
.insert(module_name.to_string(), self.modules.len());
self.modules.push(exec_info);
self.lut = Lut::new(&self.modules, &self.module_map);
Ok(())
}
pub fn invoke<Param: InteropValueList, Returns: InteropValueList>(
&mut self,
function_ref: &FunctionRef,
params: Param,
) -> Result<Returns, RuntimeError> {
// First, verify that the function reference is valid
let (module_idx, func_idx) = self.verify_function_ref(function_ref)?;
// -=-= Verification =-=-
trace!("{:?}", self.modules[module_idx].store.funcs);
let func_inst = self.modules[module_idx]
.store
.funcs
.get(func_idx)
.ok_or(RuntimeError::FunctionNotFound)?
.try_into_local()
.ok_or(RuntimeError::FunctionNotFound)?;
let func_ty = self.modules[module_idx]
.fn_types
.get(func_inst.ty)
.unwrap_validated();
// Check correct function parameters and return types
if func_ty.params.valtypes != Param::TYS {
panic!("Invalid `Param` generics");
}
if func_ty.returns.valtypes != Returns::TYS {
panic!("Invalid `Returns` generics");
}
// Prepare a new stack with the locals for the entry function
let mut stack = Stack::new();
let locals = Locals::new(
params.into_values().into_iter(),
func_inst.locals.iter().cloned(),
);
// setting `usize::MAX` as return address for the outermost function ensures that we
// observably fail upon errornoeusly continuing execution after that function returns.
stack.push_stackframe(
module_idx,
func_idx,
func_ty,
locals,
usize::MAX,
usize::MAX,
);
let mut current_module_idx = module_idx;
// Run the interpreter
run(
&mut self.modules,
&mut current_module_idx,
self.lut.as_ref().ok_or(RuntimeError::UnmetImport)?,
&mut stack,
EmptyHookSet,
)?;
// Pop return values from stack
let return_values = Returns::TYS
.iter()
.map(|ty| stack.pop_value(*ty))
.collect::<Vec<Value>>();
// Values are reversed because they were popped from stack one-by-one. Now reverse them back
let reversed_values = return_values.into_iter().rev();
let ret: Returns = Returns::from_values(reversed_values);
debug!("Successfully invoked function");
Ok(ret)
}
/// Invokes a function with the given parameters, and return types which are not known at compile time.
pub fn invoke_dynamic(
&mut self,
function_ref: &FunctionRef,
params: Vec<Value>,
ret_types: &[ValType],
) -> Result<Vec<Value>, RuntimeError> {
// First, verify that the function reference is valid
let (module_idx, func_idx) = self.verify_function_ref(function_ref)?;
// -=-= Verification =-=-
let func_inst = self.modules[module_idx]
.store
.funcs
.get(func_idx)
.ok_or(RuntimeError::FunctionNotFound)?
.try_into_local()
.ok_or(RuntimeError::FunctionNotFound)?;
let func_ty = self.modules[module_idx]
.fn_types
.get(func_inst.ty)
.unwrap_validated();
// Verify that the given parameters match the function parameters
let param_types = params.iter().map(|v| v.to_ty()).collect::<Vec<_>>();
if func_ty.params.valtypes != param_types {
panic!("Invalid parameters for function");
}
// Verify that the given return types match the function return types
if func_ty.returns.valtypes != ret_types {
panic!("Invalid return types for function");
}
// Prepare a new stack with the locals for the entry function
let mut stack = Stack::new();
let locals = Locals::new(params.into_iter(), func_inst.locals.iter().cloned());
stack.push_stackframe(module_idx, func_idx, func_ty, locals, 0, 0);
let mut currrent_module_idx = module_idx;
// Run the interpreter
run(
&mut self.modules,
&mut currrent_module_idx,
self.lut.as_ref().ok_or(RuntimeError::UnmetImport)?,
&mut stack,
EmptyHookSet,
)?;
let func_inst = self.modules[module_idx]
.store
.funcs
.get(func_idx)
.ok_or(RuntimeError::FunctionNotFound)?
.try_into_local()
.ok_or(RuntimeError::FunctionNotFound)?;
let func_ty = self.modules[module_idx]
.fn_types
.get(func_inst.ty)
.unwrap_validated();
// Pop return values from stack
let return_values = func_ty
.returns
.valtypes
.iter()
.map(|ty| stack.pop_value(*ty))
.collect::<Vec<Value>>();
// Values are reversed because they were popped from stack one-by-one. Now reverse them back
let reversed_values = return_values.into_iter().rev();
let ret = reversed_values.collect();
debug!("Successfully invoked function");
Ok(ret)
}
/// Get the indicies of a module and function by their names.
///
/// # Arguments
/// - `module_name`: The module in which to find the function.
/// - `function_name`: The name of the function to find inside the module. The function must be a local function and
/// not an import.
///
/// # Returns
/// - `Ok((module_idx, func_idx))`, where `module_idx` is the internal index of the module inside the
/// [RuntimeInstance], and `func_idx` is the internal index of the function inside the module.
/// - `Err(RuntimeError::ModuleNotFound)`, if the module is not found.
/// - `Err(RuntimeError::FunctionNotFound`, if the function is not found within the module.
fn get_indicies(
&self,
module_name: &str,
function_name: &str,
) -> Result<(usize, usize), RuntimeError> {
let module_idx = *self
.module_map
.get(module_name)
.ok_or(RuntimeError::ModuleNotFound)?;
let func_idx = self.modules[module_idx]
.store
.exports
.iter()
.find_map(|export| {
if export.name == function_name {
match export.desc {
ExportDesc::FuncIdx(func_idx) => Some(func_idx),
_ => None,
}
} else {
None
}
})
.ok_or(RuntimeError::FunctionNotFound)?;
Ok((module_idx, func_idx))
}
/// Verify that the function reference is still valid. A function reference may be invalid if it created from
/// another [RuntimeInstance] or the modules inside the instance have been changed in a way that the indicies inside
/// the [FunctionRef] would be invalid.
///
/// Note: this function ensures that making an unchecked indexation will not cause a panic.
///
/// # Returns
/// - `Ok((function_ref.module_idx, function_ref.func_idx))`
/// - `Err(RuntimeError::FunctionNotFound)`, or `Err(RuntimeError::ModuleNotFound)` if the function is not valid.
///
/// # Implementation details
/// For an exported function (i.e. created by the same [RuntimeInstance]), the names are re-resolved using
/// [RuntimeInstance::get_indicies], and the indicies are compared with the indicies in the [FunctionRef].
///
/// For a [FunctionRef] with the [export](FunctionRef::exported) flag set to `false`, the indicies are checked to be
/// in-bounds, and that the module name matches the module name in the [FunctionRef]. The function name is ignored.
fn verify_function_ref(
&self,
function_ref: &FunctionRef,
) -> Result<(usize, usize), RuntimeError> {
if function_ref.exported {
let (module_idx, func_idx) =
self.get_indicies(&function_ref.module_name, &function_ref.function_name)?;
// TODO: figure out errors :)
if module_idx != function_ref.module_index {
return Err(RuntimeError::ModuleNotFound);
}
if func_idx != function_ref.function_index {
return Err(RuntimeError::FunctionNotFound);
}
Ok((module_idx, func_idx))
} else {
let (module_idx, func_idx) = (function_ref.module_index, function_ref.function_index);
let module = self
.modules
.get(module_idx)
.ok_or(RuntimeError::ModuleNotFound)?;
if module.name != function_ref.module_name {
return Err(RuntimeError::ModuleNotFound);
}
// Sanity check that the function index is at least in the bounds of the store, though this doesn't mean
// that it's a valid function.
module
.store
.funcs
.get(func_idx)
.ok_or(RuntimeError::FunctionNotFound)?;
Ok((module_idx, func_idx))
}
}
fn init_store(validation_info: &ValidationInfo) -> CustomResult<Store> {
use StoreInstantiationError::*;
let function_instances: Vec<FuncInst> = {
let mut wasm_reader = WasmReader::new(validation_info.wasm);
let functions = validation_info.functions.iter();
let func_blocks = validation_info.func_blocks.iter();
let local_function_inst = functions.zip(func_blocks).map(|(ty, (func, sidetable))| {
wasm_reader
.move_start_to(*func)
.expect("function index to be in the bounds of the WASM binary");
let (locals, bytes_read) = wasm_reader
.measure_num_read_bytes(read_declared_locals)
.unwrap_validated();
let code_expr = wasm_reader
.make_span(func.len() - bytes_read)
.expect("TODO remove this expect");
FuncInst::Local(LocalFuncInst {
ty: *ty,
locals,
code_expr,
// TODO fix this ugly clone
sidetable: sidetable.clone(),
})
});
let imported_function_inst =
validation_info
.imports
.iter()
.filter_map(|import| match &import.desc {
ImportDesc::Func(type_idx) => Some(FuncInst::Imported(ImportedFuncInst {
ty: *type_idx,
module_name: import.module_name.clone(),
function_name: import.name.clone(),
})),
_ => None,
});
imported_function_inst.chain(local_function_inst).collect()
};
// https://webassembly.github.io/spec/core/exec/modules.html#tables
let mut tables: Vec<TableInst> = validation_info
.tables
.iter()
.map(|ty| TableInst::new(*ty))
.collect();
let mut passive_elem_indexes: Vec<usize> = vec![];
// https://webassembly.github.io/spec/core/syntax/modules.html#element-segments
let elements: Vec<ElemInst> = validation_info
.elements
.iter()
.enumerate()
.filter_map(|(i, elem)| {
trace!("Instantiating element {:#?}", elem);
let offsets = match &elem.init {
ElemItems::Exprs(_ref_type, init_exprs) => init_exprs
.iter()
.map(|expr| {
get_address_offset(
run_const_span(validation_info.wasm, expr, ()).unwrap_validated(),
)
})
.collect::<Vec<Option<u32>>>(),
ElemItems::RefFuncs(indicies) => {
// This branch gets taken when the elements are direct function references (i32 values), so we just return the indices
indicies
.iter()
.map(|el| Some(*el))
.collect::<Vec<Option<u32>>>()
}
};
let references: Vec<Ref> = offsets
.iter()
.map(|offset| {
let offset = offset.as_ref().map(|offset| *offset as usize);
match elem.ty() {
RefType::FuncRef => Ref::Func(FuncAddr::new(offset)),
RefType::ExternRef => Ref::Extern(ExternAddr::new(offset)),
}
})
.collect();
let instance = ElemInst {
ty: elem.ty(),
references,
};
match &elem.mode {
// As per https://webassembly.github.io/spec/core/syntax/modules.html#element-segments
// A declarative element segment is not available at runtime but merely serves to forward-declare
// references that are formed in code with instructions like `ref.func`
// Also, the answer given by Andreas Rossberg (the editor of the WASM Spec - Release 2.0)
// Per https://stackoverflow.com/questions/78672934/what-is-the-purpose-of-a-wasm-declarative-element-segment
// "[...] The reason Wasm requires this (admittedly ugly) forward declaration is to support streaming compilation [...]"
ElemMode::Declarative => None,
ElemMode::Passive => {
passive_elem_indexes.push(i);
Some(instance)
}
ElemMode::Active(active_elem) => {
let table_idx = active_elem.table_idx as usize;
let offset =
match run_const_span(validation_info.wasm, &active_elem.init_expr, ())
.unwrap_validated()
{
Value::I32(offset) => offset as usize,
// We are already asserting that on top of the stack there is an I32 at validation time
_ => unreachable!(),
};
let table = &mut tables[table_idx];
// This can't be verified at validation-time because we don't keep track of actual values when validating expressions
// we only keep track of the type of the values. As such we can't pop the exact value of an i32 from the validation stack
assert!(table.len() >= (offset + instance.len()));
table.elem[offset..offset + instance.references.len()]
.copy_from_slice(&instance.references);
Some(instance)
}
}
})
.collect();
let mut memory_instances: Vec<MemInst> = validation_info
.memories
.iter()
.map(|ty| MemInst::new(*ty))
.collect();
let data_sections: Vec<DataInst> = validation_info
.data
.iter()
.map(|d| {
use crate::core::reader::types::data::DataMode;
use crate::NumType;
if let DataMode::Active(active_data) = d.mode.clone() {
let mem_idx = active_data.memory_idx;
if mem_idx != 0 {
todo!("Active data has memory_idx different than 0");
}
assert!(memory_instances.len() > mem_idx);
let boxed_value = {
let mut wasm = WasmReader::new(validation_info.wasm);
wasm.move_start_to(active_data.offset).unwrap_validated();
let mut stack = Stack::new();
run_const(wasm, &mut stack, ());
stack.pop_value(ValType::NumType(NumType::I32))
// stack.peek_unknown_value().ok_or(MissingValueOnTheStack)?
};
// TODO: this shouldn't be a simple value, should it? I mean it can't be, but it can also be any type of ValType
// TODO: also, do we need to forcefully make it i32?
let offset: u32 = match boxed_value {
Value::I32(val) => val,
// Value::I64(val) => {
// if val > u32::MAX as u64 {
// return Err(I64ValueOutOfReach("data segment".to_owned()));
// }
// val as u32
// }
// TODO: implement all value types
_ => todo!(),
};
let mem_inst = memory_instances.get_mut(mem_idx).unwrap();
let len = mem_inst.data.len();
if offset as usize + d.init.len() > len {
return Err(ActiveDataWriteOutOfBounds);
}
let data = mem_inst
.data
.get_mut(offset as usize..offset as usize + d.init.len())
.unwrap();
data.copy_from_slice(&d.init);
}
Ok(DataInst {
data: d.init.clone(),
})
})
.collect::<Result<Vec<DataInst>, StoreInstantiationError>>()?;
let global_instances: Vec<GlobalInst> = validation_info
.globals
.iter()
.map({
let mut stack = Stack::new();
move |global| {
let mut wasm = WasmReader::new(validation_info.wasm);
// The place we are moving the start to should, by all means, be inside the wasm bytecode.
wasm.move_start_to(global.init_expr).unwrap_validated();
// We shouldn't need to clear the stack. If validation is correct, it will remain empty after execution.
run_const(wasm, &mut stack, ());
let value = stack.pop_value(global.ty.ty);
GlobalInst {
global: *global,
value,
}
}
})
.collect();
let exports = validation_info.exports.clone();
Ok(Store {
funcs: function_instances,
mems: memory_instances,
globals: global_instances,
data: data_sections,
tables,
elements,
passive_elem_indexes,
exports,
})
}
}
/// Used for getting the offset of an address.
///
/// Related to the Active Elements
///
/// <https://webassembly.github.io/spec/core/syntax/modules.html#element-segments>
///
/// Since active elements need an offset given by a constant expression, in this case
/// they can only be an i32 (which can be understood from either a [`Value::I32`] - but
/// since we don't unbox the address of the reference, for us also a [`Value::Ref`] -
/// or from a Global)
fn get_address_offset(value: Value) -> Option<u32> {
match value {
Value::I32(val) => Some(val),
Value::Ref(rref) => match rref {
Ref::Extern(_) => todo!("Not yet implemented"),
// TODO: fix
Ref::Func(func_addr) => func_addr.addr.map(|addr| addr as u32),
},
// INFO: from wasmtime - implement only global
_ => unreachable!(),
}
}