Merge pull request #2055 from CosmWasm/aw/optional-cranelift

Allow disabling cranelift

Author: aumetra

packages/vm/Cargo.toml

@@ -18,7 +18,7 @@ iterator = ["cosmwasm-std/iterator"]
 staking = ["cosmwasm-std/staking"]
 # this enables all stargate-related functionality, including the ibc entry points
 stargate = ["cosmwasm-std/stargate"]
-# Use cranelift backend instead of singlepass. This is required for development on Windows.
+# Use cranelift backend instead of singlepass
 cranelift = ["wasmer/cranelift"]
 # For heap profiling. Only used in the "heap_profiling" example.
 dhat-heap = ["dep:dhat"]
@@ -42,7 +42,7 @@ serde = { workspace = true }
 serde_json = "1.0.40"
 sha2 = "0.10.3"
 thiserror = "1.0.26"
-wasmer = { version = "=4.2.6", default-features = false, features = ["cranelift", "singlepass"] }
+wasmer = { version = "=4.2.6", default-features = false, features = ["singlepass"] }
 wasmer-middlewares = "=4.2.6"
 strum = { version = "0.25.0", default-features = false, features = ["derive"] }
 # For heap profiling. Only used in the "heap_profiling" example. This has to be a non-dev dependency

packages/vm/src/static_analysis.rs

@@ -107,10 +107,11 @@ impl ExportInfo for &wasmer::Module {
 mod tests {
     use std::str::FromStr;
 
+    use crate::wasm_backend::make_compiler_config;
     use crate::VmError;
 
     use super::*;
-    use wasmer::{Cranelift, Store};
+    use wasmer::Store;
 
     static CONTRACT: &[u8] = include_bytes!("../testdata/hackatom.wasm");
     static CORRUPTED: &[u8] = include_bytes!("../testdata/corrupted.wasm");
@@ -204,7 +205,7 @@ mod tests {
     #[test]
     fn exported_function_names_works_for_wasmer_with_no_prefix() {
         let wasm = wat::parse_str(r#"(module)"#).unwrap();
-        let compiler = Cranelift::default();
+        let compiler = make_compiler_config();
         let store = Store::new(compiler);
         let module = wasmer::Module::new(&store, wasm).unwrap();
         let exports = module.exported_function_names(None);
@@ -222,7 +223,7 @@ mod tests {
             )"#,
         )
         .unwrap();
-        let compiler = Cranelift::default();
+        let compiler = make_compiler_config();
         let store = Store::new(compiler);
         let module = wasmer::Module::new(&store, wasm).unwrap();
         let exports = module.exported_function_names(None);
@@ -235,7 +236,7 @@ mod tests {
     #[test]
     fn exported_function_names_works_for_wasmer_with_prefix() {
         let wasm = wat::parse_str(r#"(module)"#).unwrap();
-        let compiler = Cranelift::default();
+        let compiler = make_compiler_config();
         let store = Store::new(compiler);
         let module = wasmer::Module::new(&store, wasm).unwrap();
         let exports = module.exported_function_names(Some("b"));
@@ -254,7 +255,7 @@ mod tests {
             )"#,
         )
         .unwrap();
-        let compiler = Cranelift::default();
+        let compiler = make_compiler_config();
         let store = Store::new(compiler);
         let module = wasmer::Module::new(&store, wasm).unwrap();
         let exports = module.exported_function_names(Some("b"));

packages/vm/src/wasm_backend/engine.rs

@@ -1,9 +1,5 @@
 use std::sync::Arc;
-#[cfg(feature = "cranelift")]
-use wasmer::Cranelift;
 use wasmer::NativeEngineExt;
-#[cfg(not(feature = "cranelift"))]
-use wasmer::Singlepass;
 use wasmer::{
     sys::BaseTunables, wasmparser::Operator, CompilerConfig, Engine, Pages, Target, WASM_PAGE_SIZE,
 };
@@ -30,6 +26,14 @@ fn cost(_operator: &Operator) -> u64 {
     150
 }
 
+/// Use Cranelift as the compiler backend if the feature is enabled
+pub fn make_compiler_config() -> impl CompilerConfig + Into<Engine> {
+    #[cfg(feature = "cranelift")]
+    return wasmer::Cranelift::new();
+    #[cfg(not(feature = "cranelift"))]
+    wasmer::Singlepass::new()
+}
+
 /// Creates an engine without a compiler.
 /// This is used to run modules compiled before.
 pub fn make_runtime_engine(memory_limit: Option<Size>) -> Engine {
@@ -48,16 +52,11 @@ pub fn make_compiling_engine(memory_limit: Option<Size>) -> Engine {
     let deterministic = Arc::new(Gatekeeper::default());
     let metering = Arc::new(Metering::new(gas_limit, cost));
 
-    #[cfg(feature = "cranelift")]
-    let mut compiler = Cranelift::default();
-
-    #[cfg(not(feature = "cranelift"))]
-    let mut compiler = Singlepass::default();
-
+    let mut compiler = make_compiler_config();
     compiler.canonicalize_nans(true);
     compiler.push_middleware(deterministic);
     compiler.push_middleware(metering);
-    let mut engine = Engine::from(compiler);
+    let mut engine: Engine = compiler.into();
     if let Some(limit) = memory_limit {
         let base = BaseTunables::for_target(&Target::default());
         let tunables = LimitingTunables::new(base, limit_to_pages(limit));

packages/vm/src/wasm_backend/gatekeeper.rs

@@ -746,8 +746,9 @@ impl FunctionMiddleware for FunctionGatekeeper {
 #[cfg(test)]
 mod tests {
     use super::*;
+    use crate::wasm_backend::make_compiler_config;
     use std::sync::Arc;
-    use wasmer::{CompilerConfig, Cranelift, Module, Store};
+    use wasmer::{CompilerConfig, Module, Store};
 
     #[test]
     fn valid_wasm_instance_sanity() {
@@ -764,7 +765,7 @@ mod tests {
         .unwrap();
 
         let deterministic = Arc::new(Gatekeeper::default());
-        let mut compiler = Cranelift::default();
+        let mut compiler = make_compiler_config();
         compiler.push_middleware(deterministic);
         let store = Store::new(compiler);
         let result = Module::new(&store, wasm);
@@ -785,7 +786,7 @@ mod tests {
         .unwrap();
 
         let deterministic = Arc::new(Gatekeeper::default());
-        let mut compiler = Cranelift::default();
+        let mut compiler = make_compiler_config();
         compiler.push_middleware(deterministic);
         let store = Store::new(compiler);
         let result = Module::new(&store, wasm);
@@ -809,7 +810,7 @@ mod tests {
         .unwrap();
 
         let deterministic = Arc::new(Gatekeeper::default());
-        let mut compiler = Cranelift::default();
+        let mut compiler = make_compiler_config();
         compiler.push_middleware(deterministic);
         let store = Store::new(compiler);
         let result = Module::new(&store, wasm);

packages/vm/src/wasm_backend/mod.rs

@@ -3,5 +3,8 @@ mod engine;
 mod gatekeeper;
 mod limiting_tunables;
 
+#[cfg(test)]
+pub use engine::make_compiler_config;
+
 pub use compile::compile;
 pub use engine::{make_compiling_engine, make_runtime_engine};