feat: (CM64) Allow component model resources to be represented by i64 as well as i32. (#2496)

* allow resource rep i64

* fix

* allow CABI memory to be 64bit

* fix

* gate behind feature flag

* fix tests

* address comments

* fix

* remove file

Author: michael-weigelt

crates/wasmparser/src/features.rs

@@ -312,6 +312,12 @@ define_wasm_features! {
         /// Corresponds to the 🗺️ character in
         /// <https://github.com/WebAssembly/component-model/blob/main/design/mvp/Explainer.md>.
         pub cm_map: CM_MAP(1 << 38) = false;
+
+        /// Support for 64-bit contexts in the component model proposal.
+        ///
+        /// Corresponds to the 🐘 character in
+        /// <https://github.com/WebAssembly/component-model/blob/main/design/mvp/Explainer.md>.
+        pub cm64: CM64(1 << 39) = false;
     }
 }
 

crates/wasmparser/src/validator/component.rs

@@ -588,8 +588,17 @@ impl ComponentState {
                 }
 
                 // Current MVP restriction of the component model.
-                if rep != ValType::I32 {
-                    bail!(offset, "resources can only be represented by `i32`");
+                if rep == ValType::I64 && !component.features.cm64() {
+                    bail!(
+                        offset,
+                        "resources with `i64` require the `cm64` feature to be enabled"
+                    )
+                }
+                if rep != ValType::I32 && rep != ValType::I64 {
+                    bail!(
+                        offset,
+                        "resources can only be represented by `i32` or `i64`"
+                    );
                 }
 
                 // If specified validate that the destructor is both a valid
@@ -4351,25 +4360,24 @@ impl ComponentState {
     /// Validates that the linear memory at `idx` is valid to use as a canonical
     /// ABI memory.
     ///
-    /// At this time this requires that the memory is a plain 32-bit linear
-    /// memory. Notably this disallows shared memory and 64-bit linear memories.
+    /// At this time this requires that the memory is a plain 32-bit or 64-bit linear
+    /// memory. Notably this disallows shared memory.
     fn cabi_memory_at(&self, idx: u32, offset: usize) -> Result<()> {
         let ty = self.memory_at(idx, offset)?;
-        SubtypeCx::memory_type(
-            ty,
-            &MemoryType {
-                initial: 0,
-                maximum: None,
-                memory64: false,
-                shared: false,
-                page_size_log2: None,
-            },
-            offset,
-        )
-        .map_err(|mut e| {
-            e.add_context("canonical ABI memory is not a 32-bit linear memory".into());
-            e
-        })
+        let valid_memory_type = MemoryType {
+            initial: 0,
+            maximum: None,
+            memory64: ty.memory64,
+            shared: false,
+            page_size_log2: None,
+        };
+        if ty.memory64 && !self.features.cm64() {
+            bail!(
+                offset,
+                "64-bit memories require the `cm64` feature to be enabled"
+            );
+        }
+        SubtypeCx::memory_type(ty, &valid_memory_type, offset)
     }
 
     /// Completes the translation of this component, performing final

tests/cli/component-model/memory64.wast

@@ -51,4 +51,4 @@
     (alias core export $A "m" (core memory $m))
     (core func (canon lower (func $x) (memory $m)))
   )
-  "canonical ABI memory is not a 32-bit linear memory")
+  "64-bit memories require the `cm64` feature to be enabled")

tests/cli/component-model/memory64/memory64.wast

@@ -0,0 +1,10 @@
+;; RUN: wast --assert default --snapshot tests/snapshots -f cm64 %
+
+  (component
+    (import "x" (func $x (param "x" string)))
+    (core module $A
+      (memory (export "m") i64 1))
+    (core instance $A (instantiate $A))
+    (alias core export $A "m" (core memory $m))
+    (core func (canon lower (func $x) (memory $m)))
+  )

tests/cli/component-model/memory64/resources.wast

@@ -0,0 +1,71 @@
+;; RUN: wast --assert default --snapshot tests/snapshots -f cm64 %
+
+(component
+  (type $x (resource (rep i64)))
+)
+
+(component
+  (type $x (resource (rep i64)))
+
+  (core func (canon resource.new $x))
+  (core func (canon resource.rep $x))
+  (core func (canon resource.drop $x))
+)
+
+(component
+  (core module $m
+    (func (export "dtor") (param i64))
+  )
+  (core instance $m (instantiate $m))
+  (type $x (resource (rep i64) (dtor (func $m "dtor"))))
+  (core func (canon resource.new $x))
+)
+
+(component
+  (type $x (resource (rep i64)))
+  (core func $f1 (canon resource.new $x))
+  (core func $f2 (canon resource.rep $x))
+  (core func $f3 (canon resource.drop $x))
+
+  (core module $m
+    (import "" "f1" (func (param i64) (result i32)))
+    (import "" "f2" (func (param i32) (result i64)))
+    (import "" "f3" (func (param i32)))
+  )
+
+  (core instance (instantiate $m
+    (with "" (instance
+      (export "f1" (func $f1))
+      (export "f2" (func $f2))
+      (export "f3" (func $f3))
+    ))
+  ))
+)
+
+(assert_invalid
+  (component
+  (core module $m
+    (func (export "dtor") (param i32))
+  )
+  (core instance $m (instantiate $m))
+  (type $x (resource (rep i64) (dtor (func $m "dtor"))))
+  (core func (canon resource.new $x))
+)
+  "wrong signature for a destructor")
+
+(assert_invalid
+  (component
+  (core module $m
+    (func (export "dtor") (param i64))
+  )
+  (core instance $m (instantiate $m))
+  (type $x (resource (rep i32) (dtor (func $m "dtor"))))
+  (core func (canon resource.new $x))
+)
+  "wrong signature for a destructor")
+
+  (assert_invalid
+  (component
+    (type $x (resource (rep v128)))
+  )
+  "resources can only be represented by `i32` or `i64`")

tests/cli/component-model/resources.wast

@@ -52,7 +52,7 @@
   (component
     (type $x (resource (rep i64)))
   )
-  "resources can only be represented by `i32`")
+  "resources with `i64` require the `cm64` feature to be enabled")
 
 (assert_invalid
   (component

tests/cli/component-model/shared-everything-threads/not-accepted.wast

@@ -31,4 +31,4 @@
     (alias core export $A "m" (core memory $m))
     (core func (canon lower (func $x) (memory $m)))
   )
-  "canonical ABI memory is not a 32-bit linear memory")
+  "mismatch in the shared flag for memories")

tests/cli/validate-unknown-features.wat.stderr

@@ -1,4 +1,4 @@
 error: invalid value 'unknown' for '--features <FEATURES>': unknown feature `unknown`
-Valid features: mutable-global, saturating-float-to-int, sign-extension, reference-types, multi-value, bulk-memory, simd, relaxed-simd, threads, shared-everything-threads, tail-call, floats, multi-memory, exceptions, memory64, extended-const, component-model, function-references, memory-control, gc, custom-page-sizes, legacy-exceptions, gc-types, stack-switching, wide-arithmetic, cm-values, cm-nested-names, cm-async, cm-async-stackful, cm-async-builtins, cm-threading, cm-error-context, cm-fixed-length-lists, cm-gc, call-indirect-overlong, bulk-memory-opt, custom-descriptors, compact-imports, cm-map, mvp, wasm1, wasm2, wasm3, lime1, all
+Valid features: mutable-global, saturating-float-to-int, sign-extension, reference-types, multi-value, bulk-memory, simd, relaxed-simd, threads, shared-everything-threads, tail-call, floats, multi-memory, exceptions, memory64, extended-const, component-model, function-references, memory-control, gc, custom-page-sizes, legacy-exceptions, gc-types, stack-switching, wide-arithmetic, cm-values, cm-nested-names, cm-async, cm-async-stackful, cm-async-builtins, cm-threading, cm-error-context, cm-fixed-length-lists, cm-gc, call-indirect-overlong, bulk-memory-opt, custom-descriptors, compact-imports, cm-map, cm64, mvp, wasm1, wasm2, wasm3, lime1, all
 
 For more information, try '--help'.

tests/snapshots/cli/component-model/memory64.wast.json

@@ -32,7 +32,7 @@
       "line": 46,
       "filename": "memory64.4.wasm",
       "module_type": "binary",
-      "text": "canonical ABI memory is not a 32-bit linear memory"
+      "text": "64-bit memories require the `cm64` feature to be enabled"
     }
   ]
 }

tests/snapshots/cli/component-model/memory64/memory64.wast.json

@@ -0,0 +1,11 @@
+{
+  "source_filename": "tests/cli/component-model/memory64/memory64.wast",
+  "commands": [
+    {
+      "type": "module",
+      "line": 3,
+      "filename": "memory64.0.wasm",
+      "module_type": "binary"
+    }
+  ]
+}