wasmer/tests/middleware_common.rs

#![cfg(all(any(feature = "backend-singlepass", feature = "backend-llvm"), test))]
use wabt::wat2wasm;
use wasmer::compiler::{compile_with, Compiler};
use wasmer::imports;
use wasmer::wasm::Func;
use wasmer_middleware_common::metering::*;
use wasmer_runtime_core::codegen::ModuleCodeGenerator;
use wasmer_runtime_core::codegen::{MiddlewareChain, StreamingCompiler};
use wasmer_runtime_core::error::RuntimeError;
use wasmer_runtime_core::fault::{pop_code_version, push_code_version};
use wasmer_runtime_core::state::CodeVersion;

// 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))
    "#;

#[cfg(feature = "backend-singlepass")]
mod singlepass {
    use super::{Compiler, Metering, MiddlewareChain, StreamingCompiler};
    fn get_compiler() -> impl Compiler {
        use wasmer_singlepass_backend::ModuleCodeGenerator as MCG;
        let limit = 100u64;
        let c: StreamingCompiler<MCG, _, _, _, _> = StreamingCompiler::new(move || {
            let mut chain = MiddlewareChain::new();
            chain.push(Metering::new(limit));
            chain
        });
        c
    }
    #[test]
    fn middleware_test_points_reduced_after_call() {
        super::middleware_test_points_reduced_after_call("singlepass", get_compiler())
    }
    #[test]
    fn middleware_test_traps_after_costly_call() {
        super::middleware_test_traps_after_costly_call("singlepass", get_compiler())
    }
}

#[cfg(feature = "backend-llvm")]
mod llvm {
    use super::{Compiler, Metering, MiddlewareChain, StreamingCompiler};
    fn get_compiler() -> impl Compiler {
        use wasmer_llvm_backend::ModuleCodeGenerator as MCG;
        let limit = 100u64;
        let c: StreamingCompiler<MCG, _, _, _, _> = StreamingCompiler::new(move || {
            let mut chain = MiddlewareChain::new();
            chain.push(Metering::new(limit));
            chain
        });
        c
    }
    #[test]
    fn middleware_test_points_reduced_after_call() {
        super::middleware_test_points_reduced_after_call("llvm", get_compiler())
    }
    #[test]
    fn middleware_test_traps_after_costly_call() {
        super::middleware_test_traps_after_costly_call("llvm", get_compiler())
    }
}

fn middleware_test_points_reduced_after_call(backend: &'static str, compiler: impl Compiler) {
    let wasm_binary = wat2wasm(WAT).unwrap();
    let module = compile_with(&wasm_binary, &compiler).unwrap();

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

    set_points_used(&mut instance, 0u64);

    let add_to: Func<(i32, i32), i32> = instance.exports.get("add_to").unwrap();

    let cv_pushed = if let Some(msm) = instance.module.runnable_module.get_module_state_map() {
        push_code_version(CodeVersion {
            baseline: true,
            msm: msm,
            base: instance.module.runnable_module.get_code().unwrap().as_ptr() as usize,
            backend: &backend,
            runnable_module: instance.module.runnable_module.clone(),
        });
        true
    } else {
        false
    };

    let value = add_to.call(3, 4).unwrap();
    if cv_pushed {
        pop_code_version().unwrap();
    }

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

    // verify it used the correct number of points
    assert_eq!(get_points_used(&instance), 74);
}

fn middleware_test_traps_after_costly_call(backend: &'static str, compiler: impl Compiler) {
    let wasm_binary = wat2wasm(WAT).unwrap();
    let module = compile_with(&wasm_binary, &compiler).unwrap();

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

    set_points_used(&mut instance, 0u64);

    let add_to: Func<(i32, i32), i32> = instance.exports.get("add_to").unwrap();

    let cv_pushed = if let Some(msm) = instance.module.runnable_module.get_module_state_map() {
        push_code_version(CodeVersion {
            baseline: true,
            msm: msm,
            base: instance.module.runnable_module.get_code().unwrap().as_ptr() as usize,
            backend: &backend,
            runnable_module: instance.module.runnable_module.clone(),
        });
        true
    } else {
        false
    };
    let result = add_to.call(10_000_000, 4);
    if cv_pushed {
        pop_code_version().unwrap();
    }

    let err = result.unwrap_err();
    if let RuntimeError::Metering(metering_err) = err {
        assert!(metering_err
            .downcast_ref::<ExecutionLimitExceededError>()
            .is_some());
    } else {
        assert!(false, "metering error not found");
    }

    // verify it used the correct number of points
    assert_eq!(get_points_used(&instance), 109); // Used points will be slightly more than `limit` because of the way we do gas checking.
}