Validate the manipulated module before emitting it and give a warning if that fails. (#80)

* features into array

* validate module before emitting it

* more explicit flags

* fix

* changelog

* bump to 0.9.3

---------

Co-authored-by: Michael Weigelt <michael.weigelt@dfinity.com>
Co-authored-by: Linwei Shang <linwei.shang@dfinity.org>

Author: 3 people

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [0.9.3] - 2024-01-10
+
+* Validate the manipulated module before emitting it and give a warning if that fails.
+
 ## [0.9.2] - 2024-01-09
 
 * Fix: limit_resource works with wasm64.

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "ic-wasm"
-version = "0.9.2"
+version = "0.9.3"
 authors = ["DFINITY Stiftung"]
 edition = "2021"
 description = "A library for performing Wasm transformations specific to canisters running on the Internet Computer"
@@ -20,11 +20,12 @@ required-features = ["exe"]
 [dependencies]
 # Major version bump of walrus should result in a major version bump of ic-wasm.
 # Because we expose walrus types in ic-wasm public API.
-walrus = "0.22.0" 
+walrus = "0.22.0"
 candid = "0.10"
 rustc-demangle = "0.1"
 thiserror = "1.0.35"
 libflate = "2.0"
+wasmparser = "0.223.0"
 
 wasm-opt = { version = "0.116.0", optional = true }
 tempfile = { version = "3.5.0", optional = true }
@@ -44,4 +45,4 @@ assert_cmd = "2"
 
 [package.metadata.binstall]
 pkg-url = "{ repo }/releases/download/{ version }/{ name }-{ target }{ archive-suffix }"
-pkg-fmt = "tgz" # archive-suffix = .tar.gz
+pkg-fmt = "tgz"                                                                          # archive-suffix = .tar.gz

Cargo.toml

@@ -1,4 +1,5 @@
 use clap::{crate_authors, crate_version, Parser};
+use ic_wasm::utils::make_validator_with_features;
 use std::path::PathBuf;
 
 #[derive(Parser)]
@@ -202,8 +203,15 @@ fn main() -> anyhow::Result<()> {
             }
         }
     };
+    // validate new module
+    let module_bytes = m.emit_wasm();
+    let mut validator = make_validator_with_features();
+    if let Err(e) = validator.validate_all(&module_bytes) {
+        println!("WARNING: The output of ic-wasm failed to validate. Please report this via github issue or on https://forum.dfinity.org/");
+        eprintln!("{e}");
+    }
     if let Some(output) = opts.output {
-        m.emit_wasm_file(output)?;
+        std::fs::write(output, module_bytes).expect("failed to write wasm module");
     }
     Ok(())
 }

src/bin/main.rs

@@ -90,15 +90,10 @@ pub fn optimize(
     if let Some(max_size) = always_inline_max_function_size {
         optimizations.always_inline_max_size(*max_size);
     }
-    // The feature set should be align with IC `wasmtime` validation config:
-    // https://github.com/dfinity/ic/blob/6a6470d705a0f36fb94743b12892280409f85688/rs/embedders/src/wasm_utils/validation.rs#L1385
-    optimizations.enable_feature(wasm_opt::Feature::MutableGlobals);
-    optimizations.enable_feature(wasm_opt::Feature::TruncSat);
-    optimizations.enable_feature(wasm_opt::Feature::Simd);
-    optimizations.enable_feature(wasm_opt::Feature::BulkMemory);
-    optimizations.enable_feature(wasm_opt::Feature::SignExt);
-    optimizations.enable_feature(wasm_opt::Feature::ReferenceTypes);
-    optimizations.enable_feature(wasm_opt::Feature::Memory64);
+
+    for feature in IC_ENABLED_WASM_FEATURES {
+        optimizations.enable_feature(feature);
+    }
     optimizations.run(temp_file.path(), temp_file.path())?;
 
     // read optimized wasm back in from temp file

src/optimize.rs

@@ -4,11 +4,63 @@ use std::borrow::Cow;
 use std::collections::HashMap;
 use std::io::{self, Read};
 use walrus::*;
+use wasm_opt::Feature;
+use wasmparser::{Validator, WasmFeaturesInflated};
 
 pub const WASM_MAGIC_BYTES: &[u8] = &[0, 97, 115, 109];
 
 pub const GZIPPED_WASM_MAGIC_BYTES: &[u8] = &[31, 139, 8];
 
+// The feature set should be align with IC `wasmtime` validation config:
+// https://github.com/dfinity/ic/blob/6a6470d705a0f36fb94743b12892280409f85688/rs/embedders/src/wasm_utils/validation.rs#L1385
+// Since we use both wasm_opt::Feature and wasmparse::WasmFeature, we have to define the config/features for both.
+pub const IC_ENABLED_WASM_FEATURES: [Feature; 7] = [
+    Feature::MutableGlobals,
+    Feature::TruncSat,
+    Feature::Simd,
+    Feature::BulkMemory,
+    Feature::SignExt,
+    Feature::ReferenceTypes,
+    Feature::Memory64,
+];
+
+pub const IC_ENABLED_WASM_FEATURES_INFLATED: WasmFeaturesInflated = WasmFeaturesInflated {
+    mutable_global: true,
+    saturating_float_to_int: true,
+    sign_extension: true,
+    reference_types: true,
+    multi_value: true,
+    bulk_memory: true,
+    simd: true,
+    relaxed_simd: false,
+    threads: true,
+    shared_everything_threads: true,
+    tail_call: false,
+    floats: true,
+    multi_memory: true,
+    exceptions: true,
+    memory64: true,
+    extended_const: true,
+    component_model: true,
+    function_references: false,
+    memory_control: true,
+    gc: false,
+    custom_page_sizes: true,
+    component_model_values: true,
+    component_model_nested_names: true,
+    component_model_more_flags: true,
+    component_model_multiple_returns: true,
+    legacy_exceptions: true,
+    gc_types: true,
+    stack_switching: true,
+    wide_arithmetic: false,
+    component_model_async: true,
+};
+
+pub fn make_validator_with_features() -> Validator {
+    Validator::new_with_features(IC_ENABLED_WASM_FEATURES_INFLATED.into())
+}
+
 fn wasm_parser_config(keep_name_section: bool) -> ModuleConfig {
     let mut config = walrus::ModuleConfig::new();
     config.generate_name_section(keep_name_section);