Refactor how wasm features are calculated for *.wast tests (bytecod…

…ealliance#9560)

* Refactor how wasm features are calculated for `*.wast` tests

This commit refactors the `tests/wast.rs` test suite which runs all of
the upstream spec tests as `*.wast` files as well as our own
`misc_testsuite` which has its own suite of `*.wast` files. Previously
the set of wasm features active for each test was a sort of random
mishmash and convoluted set of conditionals which was updated and edited
over time as upstream proposal test suites evolved. This was then
mirrored into our own conventions for `misc_testsuite` as well. Overall
though this has a number of downsides I'm trying to fix here:

* The calculation of what features are enabled is quite complicated and
  effectively a random mishmash of `||` conditionals with hierarchies
  that don't make any sense beyond "this is just required to get things
  to pass".

* There is no means of per-test configuration. For example
  `canonicalize-nans.wast` had hardcoded logic in `tests/wast.rs` that
  it needed a different setting turned on in `Config`.

* There was no easy means to write tests for Wasmtime which take a union
  of a number of proposals together without having lots of sub-folders
  that may not make sense.

* Tests that require a particular proposal had to have duplicate logic
  for Winch as it doesn't support the full suite of features of all
  proposals that Cranelift does.

The new system implemented in this commit takes a leaf out of the
`disas` tests. There is a new `TestConfig` structure in the
`tests/wast.rs` harness which is decoded from each test (leading `;;!`
comments) which enables specifying, in each test, what's required. This
encompasses many wasm proposals but additionally captures other behavior
like nan-canonicalization. This means that all test files in
`misc_testsuite/**/*.wast` are now manually annotated with what wasm
features they require and what's needed to run. This makes per-test
configuration much easier, per-config-setting much easier, and blanket
ignore-by-proposal for Winch much easier as well.

For spec tests we can't modify the contents of the upstream `*.wast`
files. To handle this they're handled specially where `TestConfig` is
manually created and manipulated for each spec proposal and the main
test suite itself. This enables per-proposal configuration that doesn't
leak into any others and makes it more obvious what proposals are doing
what.

* Hack around Winch support for aarch64

tests/disas.rs

@@ -46,7 +46,6 @@ use cranelift_codegen::isa::{lookup_by_name, TargetIsa};
 use cranelift_codegen::settings::{Configurable, Flags, SetError};
 use libtest_mimic::{Arguments, Trial};
 use pulley_interpreter::decode::OpVisitor;
-use serde::de::DeserializeOwned;
 use serde_derive::Deserialize;
 use similar::TextDiff;
 use std::fmt::Write;
@@ -56,6 +55,8 @@ use tempfile::TempDir;
 use wasmtime::{Engine, OptLevel, Strategy};
 use wasmtime_cli_flags::CommonOptions;
 
+mod support;
+
 fn main() -> Result<()> {
     if cfg!(miri) {
         return Ok(());
@@ -152,7 +153,7 @@ impl Test {
     fn new(path: &Path) -> Result<Test> {
         let contents =
             std::fs::read_to_string(path).with_context(|| format!("failed to read {path:?}"))?;
-        let config: TestConfig = Test::parse_test_config(&contents)
+        let config: TestConfig = support::parse_test_config(&contents)
             .context("failed to parse test configuration as TOML")?;
         let mut flags = vec!["wasmtime"];
         match &config.flags {
@@ -170,24 +171,6 @@ impl Test {
         })
     }
 
-    /// Parse test configuration from the specified test, comments starting with
-    /// `;;!`.
-    fn parse_test_config<T>(wat: &str) -> Result<T>
-    where
-        T: DeserializeOwned,
-    {
-        // The test config source is the leading lines of the WAT file that are
-        // prefixed with `;;!`.
-        let config_lines: Vec<_> = wat
-            .lines()
-            .take_while(|l| l.starts_with(";;!"))
-            .map(|l| &l[3..])
-            .collect();
-        let config_text = config_lines.join("\n");
-
-        toml::from_str(&config_text).context("failed to parse the test configuration")
-    }
-
     /// Generates CLIF for all the wasm functions in this test.
     fn compile(&mut self) -> Result<CompileOutput> {
         // Use wasmtime::Config with its `emit_clif` option to get Wasmtime's

tests/misc_testsuite/component-model/adapter.wast

@@ -1,3 +1,5 @@
+;;! multi_memory = true
+
 ;; basic function lifting
 (component
   (core module $m

tests/misc_testsuite/component-model/fused.wast

@@ -1,3 +1,6 @@
+;;! multi_memory = true
+;;! component_model_more_flags = true
+
 ;; smoke test with no arguments and no results
 (component
   (core module $m

tests/misc_testsuite/component-model/modules.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 (component $foo
   (core module (export "a-module"))
 )

tests/misc_testsuite/component-model/strings.wast

@@ -1,3 +1,5 @@
+;;! multi_memory = true
+
 ;; unaligned utf16 string
 (assert_trap
   (component

tests/misc_testsuite/custom-page-sizes/custom-page-sizes-invalid.wast

@@ -1,3 +1,6 @@
+;;! custom_page_sizes = true
+;;! multi_memory = true
+
 ;; Page size that is not a power of two.
 (assert_malformed
   (module quote "(memory 0 (pagesize 3))")

tests/misc_testsuite/custom-page-sizes/custom-page-sizes.wast

@@ -1,3 +1,6 @@
+;;! custom_page_sizes = true
+;;! multi_memory = true
+
 ;; Check all the valid custom page sizes.
 (module (memory 1 (pagesize 1)))
 (module (memory 1 (pagesize 65536)))

tests/misc_testsuite/elem-ref-null.wast

@@ -1,2 +1,4 @@
+;;! reference_types = true
+
 (module
   (elem funcref (ref.null func)))

tests/misc_testsuite/elem_drop.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 (module
   (table 1 1 funcref)
   (elem (i32.const 0) funcref (ref.func 0))

tests/misc_testsuite/externref-id-function.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 (module
   (func (export "identity") (param externref) (result externref)
     local.get 0))

tests/misc_testsuite/externref-segment.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 (module
   (table 2 externref)
   (elem (i32.const 0) externref (ref.null extern))

tests/misc_testsuite/externref-table-dropped-segment-issue-8281.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 (module
   (table $t 0 0 externref)
 

tests/misc_testsuite/function-references/call_indirect.wast

@@ -1,3 +1,6 @@
+;;! gc = true
+;;! function_references = true
+
 (module
   (table $t1 2 funcref)
   (elem (table $t1) (i32.const 0) func $nop)

tests/misc_testsuite/function-references/instance.wast

@@ -1,3 +1,6 @@
+;;! gc = true
+;;! multi_memory = true
+
 ;; Instantiation is generative
 
 (module definition $M

tests/misc_testsuite/function-references/table_fill.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (table $t 10 externref)
 

tests/misc_testsuite/function-references/table_get.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (type $res-i32 (func (result i32)))
   (table $t2 2 externref)

tests/misc_testsuite/function-references/table_grow.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (table $t 0 externref)
 

tests/misc_testsuite/function-references/table_set.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (type $res-i32 (func (result i32)))
   (table $t2 1 externref)

tests/misc_testsuite/gc/anyref_that_is_i31_barriers.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 ;; Test that our inline GC barriers detect `i31`s and don't attempt to actually
 ;; deref them or anything like that.
 

tests/misc_testsuite/gc/array-alloc-too-large.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (type $arr_i8 (array i8))
   (type $arr_i64 (array i64))

tests/misc_testsuite/gc/array-init-data.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (type $arr (array (mut i8)))
 

tests/misc_testsuite/gc/array-new-data.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (type $arr (array (mut i8)))
 

tests/misc_testsuite/gc/array-new-elem.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (type $arr (array i31ref))
 

tests/misc_testsuite/gc/array-types.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (type (array i8))
   (type (array i16))

tests/misc_testsuite/gc/func-refs-in-gc-heap.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (type $f0 (func (result i32)))
 

tests/misc_testsuite/gc/i31ref-of-global-initializers.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module $env
   (global (export "g1") i32 (i32.const 42))
   (global (export "g2") i32 (i32.const 99))

tests/misc_testsuite/gc/i31ref-tables.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module $tables_of_i31ref
   (table $table 3 10 i31ref)
   (elem (table $table) (i32.const 0) i31ref (item (ref.i31 (i32.const 999)))

tests/misc_testsuite/gc/more-rec-groups-than-types.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 ;; Test that we properly handle empty rec groups and when we have more rec
 ;; groups defined in the type section than actual types (and therefore the
 ;; length that the type section reports is greater than the length of the types

tests/misc_testsuite/gc/null-i31ref.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (func (export "get_u-null") (result i32)
     (i31.get_u (ref.null i31))

tests/misc_testsuite/gc/rec-group-funcs.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 ;; Test that we properly canonicalize function types across modules, at the
 ;; engine level. We rely on this canonicalization to make cross-module imports
 ;; work among other things.

tests/misc_testsuite/gc/ref-test.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (func (export "nulls-to-nullable-tops") (result i32)
     (ref.test anyref (ref.null any))

tests/misc_testsuite/gc/struct-instructions.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (type $ty (struct (field (mut f32))
                     (field (mut i8))

tests/misc_testsuite/gc/struct-types.wast

@@ -1,3 +1,5 @@
+;;! gc = true
+
 (module
   (type (struct))
   (type (struct (field)))

tests/misc_testsuite/linking-errors.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 (module $m
   (global (export "g i32") i32 (i32.const 0))
   (global (export "g mut i32") (mut i32)  (i32.const 0))

tests/misc_testsuite/many_table_gets_lead_to_gc.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 (module
   (table $t 1 externref)
 

tests/misc_testsuite/memory64/bounds.wast

@@ -1,3 +1,5 @@
+;;! memory64 = true
+
 (assert_unlinkable
   (module
     (memory i64 1)

tests/misc_testsuite/memory64/codegen.wast

@@ -1,3 +1,5 @@
+;;! memory64 = true
+
 ;; make sure everything codegens correctly and has no cranelift verifier errors
 (module
   (memory i64 1)

tests/misc_testsuite/memory64/linking-errors.wast

@@ -1,3 +1,5 @@
+;;! memory64 = true
+
 (module $m
   (memory (export "mem") 0)
 )

tests/misc_testsuite/memory64/linking.wast

@@ -1,3 +1,5 @@
+;;! memory64 = true
+
 (module $export32 (memory (export "m") 1))
 (module $export64 (memory (export "m") i64 1))
 

tests/misc_testsuite/memory64/more-than-4gb.wast

@@ -1,3 +1,5 @@
+;;! memory64 = true
+
 ;; try to create as few 4gb memories as we can to reduce the memory consumption
 ;; of this test, so create one up front here and use it below.
 (module $memory

tests/misc_testsuite/memory64/multi-memory.wast

@@ -1,3 +1,6 @@
+;;! memory64 = true
+;;! multi_memory = true
+
 ;; 64 => 64
 (module
   (memory $a i64 1)

tests/misc_testsuite/memory64/offsets.wast

@@ -1,3 +1,5 @@
+;;! memory64 = true
+
 (module
   (memory i64 1)
   (func (export "load1") (result i32)

tests/misc_testsuite/memory64/simd.wast

@@ -1,3 +1,5 @@
+;;! memory64 = true
+
 ;; make sure everything codegens correctly and has no cranelift verifier errors
 (module
   (memory i64 1)

tests/misc_testsuite/memory64/threads.wast

@@ -1,3 +1,6 @@
+;;! memory64 = true
+;;! threads = true
+
 ;; make sure everything codegens correctly and has no cranelift verifier errors
 (module
   (memory i64 1)

tests/misc_testsuite/multi-memory/simple.wast

@@ -1,3 +1,5 @@
+;;! multi_memory = true
+
 (module
   (memory $m1 1)
   (memory $m2 1)

tests/misc_testsuite/mutable_externref_globals.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 ;; This test contains the changes in
 ;; https://github.com/WebAssembly/reference-types/pull/104, and can be deleted
 ;; once that merges and we update our upstream tests.

tests/misc_testsuite/no-mixup-stack-maps.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 (module
   (global $g (mut externref) (ref.null extern))
 

tests/misc_testsuite/no-panic.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 (module
   (func $test (param i32) (result externref)
         i32.const 0

tests/misc_testsuite/simd/canonicalize-nan.wast

@@ -1,3 +1,5 @@
+;;! nan_canonicalization = true
+
 ;; This *.wast test should be run with `cranelift_nan_canonicalization` set to
 ;; `true` in `wast.rs`
 

tests/misc_testsuite/simple_ref_is_null.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 (module
   (func (export "func_is_null") (param funcref) (result i32)
     (ref.is_null (local.get 0))

tests/misc_testsuite/table_copy_on_imported_tables.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 (module $m
   (func $f (param i32 i32 i32 i32 i32 i32) (result i32) (local.get 0))
   (func $g (param i32 i32 i32 i32 i32 i32) (result i32) (local.get 1))

tests/misc_testsuite/table_grow_with_funcref.wast

@@ -1,3 +1,5 @@
+;;! reference_types = true
+
 (module
   (table $t 0 funcref)
   (func (export "size") (result i32)

tests/misc_testsuite/tail-call/loop-across-modules.wast

@@ -1,3 +1,6 @@
+;;! tail_call = true
+;;! reference_types = true
+
 ;; Do the following loop: `A.f` indirect tail calls through the table, which is
 ;; populated by `B.start` to contain `B.g`, which in turn tail calls `A.f` and
 ;; the loop begins again.

tests/misc_testsuite/threads/LB.wast

@@ -1,3 +1,5 @@
+;;! threads = true
+
 (module $Mem
   (memory (export "shared") 1 1 shared)
 )

tests/misc_testsuite/threads/LB_atomic.wast

@@ -1,3 +1,5 @@
+;;! threads = true
+
 (module $Mem
   (memory (export "shared") 1 1 shared)
 )

tests/misc_testsuite/threads/MP.wast

@@ -1,3 +1,5 @@
+;;! threads = true
+
 (module $Mem
   (memory (export "shared") 1 1 shared)
 )

tests/misc_testsuite/threads/MP_atomic.wast

@@ -1,3 +1,5 @@
+;;! threads = true
+
 (module $Mem
   (memory (export "shared") 1 1 shared)
 )

tests/misc_testsuite/threads/MP_wait.wast

@@ -1,3 +1,5 @@
+;;! threads = true
+
 (module $Mem
   (memory (export "shared") 1 1 shared)
 )