Skip to content

Commit

Permalink
Add tests for metering, add option to compiler config
Browse files Browse the repository at this point in the history
  • Loading branch information
bjfish committed Jun 2, 2019
1 parent 995ecef commit e533a8a
Show file tree
Hide file tree
Showing 5 changed files with 179 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions lib/middleware-common/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,14 @@ edition = "2018"

[dependencies]
wasmer-runtime-core = { path = "../runtime-core" }
wasmer-clif-backend = { path = "../clif-backend", version = "0.4.2" }
wasmer-llvm-backend = { path = "../llvm-backend", version = "0.4.2", optional = true }
wasmer-singlepass-backend = { path = "../singlepass-backend", version = "0.4.2", optional = true }

[dev-dependencies]
wabt = "0.7.4"

[features]
clif = []
llvm = ["wasmer-llvm-backend"]
singlepass = ["wasmer-singlepass-backend"]
152 changes: 152 additions & 0 deletions lib/middleware-common/src/metering.rs
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,155 @@ impl FunctionMiddleware for Metering {
Ok(())
}
}

#[cfg(test)]
mod tests {

use wabt::wat2wasm;
use wasmer_runtime_core::{
backend::{Compiler, CompilerConfig},
compile_with_config, imports, Func,
};

#[cfg(feature = "llvm")]
fn get_compiler() -> impl Compiler {
use wasmer_llvm_backend::LLVMCompiler;
LLVMCompiler::new()
}

#[cfg(feature = "singlepass")]
fn get_compiler() -> impl Compiler {
use wasmer_singlepass_backend::SinglePassCompiler;
SinglePassCompiler::new()
}

#[cfg(not(any(feature = "llvm", feature = "clif", feature = "singlepass")))]
fn get_compiler() -> impl Compiler {
panic!("compiler not specified, activate a compiler via features");
use wasmer_clif_backend::CraneliftCompiler;
CraneliftCompiler::new()
}

// Assemblyscript
// export function add_to(x: i32, y: i32): i32 {
// for(var i = 0; i < x; i++){
// if(i % 1 == 0){
// y += i;
// } else {
// y *= i
// }
// }
// return y;
// }
static WAT: &'static str = r#"
(module
(type $t0 (func (param i32 i32) (result i32)))
(type $t1 (func))
(func $add_to (export "add_to") (type $t0) (param $p0 i32) (param $p1 i32) (result i32)
(local $l0 i32)
block $B0
i32.const 0
set_local $l0
loop $L1
get_local $l0
get_local $p0
i32.lt_s
i32.eqz
br_if $B0
get_local $l0
i32.const 1
i32.rem_s
i32.const 0
i32.eq
if $I2
get_local $p1
get_local $l0
i32.add
set_local $p1
else
get_local $p1
get_local $l0
i32.mul
set_local $p1
end
get_local $l0
i32.const 1
i32.add
set_local $l0
br $L1
unreachable
end
unreachable
end
get_local $p1)
(func $f1 (type $t1))
(table $table (export "table") 1 anyfunc)
(memory $memory (export "memory") 0)
(global $g0 i32 (i32.const 8))
(elem (i32.const 0) $f1))
"#;

#[test]
fn test_points_reduced_after_call() {
let wasm_binary = wat2wasm(WAT).unwrap();

let limit = 100u64;

let module = compile_with_config(
&wasm_binary,
&get_compiler(),
CompilerConfig {
points_limit: Some(limit),
..Default::default()
},
)
.unwrap();

let import_object = imports! {};
let mut instance = module.instantiate(&import_object).unwrap();

instance.context_mut().set_points_used(0u64);

let add_to: Func<(i32, i32), i32> = instance.func("add_to").unwrap();
let value = add_to.call(3, 4).unwrap();

// verify it returns the correct value
assert_eq!(value, 7);

// verify is uses the correct number of points
assert_eq!(instance.context().get_points_used(), 42); // TODO need to update assertion to actual points used.
}

#[test]
fn test_traps_after_costly_call() {
let wasm_binary = wat2wasm(WAT).unwrap();

let limit = 100u64;

let module = compile_with_config(
&wasm_binary,
&get_compiler(),
CompilerConfig {
points_limit: Some(limit),
..Default::default()
},
)
.unwrap();

let import_object = imports! {};
let mut instance = module.instantiate(&import_object).unwrap();

instance.context_mut().set_points_used(0u64);

let add_to: Func<(i32, i32), i32> = instance.func("add_to").unwrap();
let result = add_to.call(10_000_000, 4);

// verify it errors
assert_eq!(result.is_err(), true); // TODO assert that the trap is caused by PointsExausted

// verify is uses the correct number of points
assert_eq!(instance.context().get_points_used(), 99); // TODO need to update assertion to actual points used.
// TODO should points used be close to limit or at limit when trapping
}

}
2 changes: 2 additions & 0 deletions lib/runtime-core/src/backend.rs
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ pub struct CompilerConfig {
pub symbol_map: Option<HashMap<u32, String>>,
pub memory_bound_check_mode: MemoryBoundCheckMode,
pub enforce_stack_check: bool,
/// Enables metering functionality if set and used as default points limit during compilation
pub points_limit: Option<u64>,

This comment has been minimized.

Copy link
@losfair

losfair Jun 2, 2019

Contributor

Metering is purely a middleware functionality. We should not handle it in runtime-core. Same for {get,set}_points_used.

}

pub trait Compiler {
Expand Down
10 changes: 10 additions & 0 deletions lib/runtime-core/src/vm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,16 @@ impl Ctx {
pub fn dynamic_sigindice_count(&self) -> usize {
unsafe { (*self.local_backing).dynamic_sigindices.len() }
}

/// Returns the number of points used by a function call for metering
pub fn get_points_used(&self) -> u64 {
unimplemented!()
}

/// Sets the value of points used
pub fn set_points_used(&mut self, _value: u64) {
unimplemented!()
}
}

#[doc(hidden)]
Expand Down

0 comments on commit e533a8a

Please sign in to comment.