Simplify and consolidate type printing (#5816)

When printing Binaryen IR, we previously generated names for unnamed heap types
based on their structure. This was useful for seeing the structure of simple
types at a glance without having to separately go look up their definitions, but
it also had two problems:

1. The same name could be generated for multiple types. The generated names did
not take into account rec group structure or finality, so types that differed
only in these properties would have the same name. Also, generated type names
were limited in length, so very large types that shared only some structure
could also end up with the same names. Using the same name for multiple types
produces incorrect and unparsable output.

2. The generated names were not useful beyond the most trivial examples. Even
with length limits, names for nontrivial types were extremely long and visually
noisy, which made reading disassembled real-world code more challenging.

Fix these problems by emitting simple indexed names for unnamed heap types
instead. This regresses readability for very simple examples, but the trade off
is worth it.

This change also reduces the number of type printing systems we have by one.
Previously we had the system in Print.cpp, but we had another, more general and
extensible system in wasm-type-printing.h and wasm-type.cpp as well. Remove the
old type printing system from Print.cpp and replace it with a much smaller use
of the new system. This requires significant refactoring of Print.cpp so that
PrintExpressionContents object now holds a reference to a parent
PrintSExpression object that holds the type name state.

This diff is very large because almost every test output changed slightly. To
minimize the diff and ease review, change the type printer in wasm-type.cpp to
behave the same as the old type printer in Print.cpp except for the differences
in name generation. These changes will be reverted in much smaller PRs in the
future to generally improve how types are printed.

Author: tlively

src/passes/Print.cpp

@@ -155,7 +155,8 @@ struct TypePrinter {
   std::ostream& print(const Tuple& tuple);
   std::ostream& print(const Field& field);
   std::ostream& print(const Signature& sig);
-  std::ostream& print(const Struct& struct_);
+  std::ostream& print(const Struct& struct_,
+                      const std::unordered_map<Index, Name>& fieldNames);
   std::ostream& print(const Array& array);
 };
 
@@ -1762,9 +1763,9 @@ std::ostream& TypePrinter::print(HeapType type) {
     }
   }
 
-  os << "(type ";
-  printHeapTypeName(type);
-  os << " ";
+  auto names = generator(type);
+
+  os << "(type $" << names.name << ' ';
 
   if (isTemp(type)) {
     os << "(; temp ;) ";
@@ -1787,7 +1788,7 @@ std::ostream& TypePrinter::print(HeapType type) {
   if (type.isSignature()) {
     print(type.getSignature());
   } else if (type.isStruct()) {
-    print(type.getStruct());
+    print(type.getStruct(), names.fieldNames);
   } else if (type.isArray()) {
     print(type.getArray());
   } else {
@@ -1854,19 +1855,24 @@ std::ostream& TypePrinter::print(const Signature& sig) {
   return os << ')';
 }
 
-std::ostream& TypePrinter::print(const Struct& struct_) {
+std::ostream&
+TypePrinter::print(const Struct& struct_,
+                   const std::unordered_map<Index, Name>& fieldNames) {
   os << "(struct";
-  if (struct_.fields.size()) {
-    os << " (field";
+  for (Index i = 0; i < struct_.fields.size(); ++i) {
+    // TODO: move this to the function for printing fields.
+    os << " (field ";
+    if (auto it = fieldNames.find(i); it != fieldNames.end()) {
+      os << '$' << it->second << ' ';
+    }
+    print(struct_.fields[i]);
+    os << ')';
   }
-  for (const Field& field : struct_.fields) {
+  // TODO: Remove this extra space kept to minimize test diffs.
+  if (struct_.fields.size() == 0) {
     os << ' ';
-    print(field);
   }
-  if (struct_.fields.size()) {
-    os << ')';
-  }
-  return os << ')';
+  return os << ")";
 }
 
 std::ostream& TypePrinter::print(const Array& array) {

src/wasm/wasm-type.cpp

@@ -1,7 +1,7 @@
 (module
- (type $none_=>_none (func))
+ (type $0 (func))
  (memory $0 1 1)
- (func $foo (type $none_=>_none)
+ (func $foo (type $0)
   (drop
    (i32.atomic.rmw.cmpxchg
     (i32.const 0)

test/atomics-unshared.wast.from-wast

@@ -1,7 +1,7 @@
 (module
- (type $none_=>_none (func))
+ (type $0 (func))
  (memory $0 1 1)
- (func $foo (type $none_=>_none)
+ (func $foo (type $0)
   (drop
    (i32.atomic.rmw.cmpxchg
     (i32.const 0)

test/atomics-unshared.wast.fromBinary

@@ -1,7 +1,7 @@
 (module
- (type $none_=>_none (func))
+ (type $0 (func))
  (memory $0 1 1)
- (func $0 (type $none_=>_none)
+ (func $0 (type $0)
   (drop
    (i32.atomic.rmw.cmpxchg
     (i32.const 0)

test/atomics-unshared.wast.fromBinary.noDebugInfo

@@ -1,7 +1,7 @@
 (module
- (type $none_=>_none (func))
+ (type $0 (func))
  (memory $0 (shared 23 256))
- (func $0 (type $none_=>_none)
+ (func $0 (type $0)
   (local $0 i32)
   (local $1 i64)
   (drop
@@ -68,7 +68,7 @@
    (local.get $1)
   )
  )
- (func $1 (type $none_=>_none)
+ (func $1 (type $0)
   (local $0 i32)
   (local $1 i64)
   (drop
@@ -102,7 +102,7 @@
    )
   )
  )
- (func $2 (type $none_=>_none)
+ (func $2 (type $0)
   (local $0 i32)
   (local $1 i64)
   (drop
@@ -134,7 +134,7 @@
    )
   )
  )
- (func $3 (type $none_=>_none)
+ (func $3 (type $0)
   (local $0 i32)
   (local $1 i64)
   (drop
@@ -178,7 +178,7 @@
    )
   )
  )
- (func $4 (type $none_=>_none)
+ (func $4 (type $0)
   (atomic.fence)
  )
 )

test/atomics.wast.fromBinary.noDebugInfo

@@ -1,7 +1,7 @@
 (module
- (type $none_=>_none (func))
+ (type $0 (func))
  (memory $0 (shared i64 23 256))
- (func $0 (type $none_=>_none)
+ (func $0 (type $0)
   (local $0 i64)
   (local $1 i64)
   (local $2 i32)
@@ -69,7 +69,7 @@
    (local.get $1)
   )
  )
- (func $1 (type $none_=>_none)
+ (func $1 (type $0)
   (local $0 i64)
   (local $1 i64)
   (local $2 i32)
@@ -104,7 +104,7 @@
    )
   )
  )
- (func $2 (type $none_=>_none)
+ (func $2 (type $0)
   (local $0 i64)
   (local $1 i64)
   (local $2 i32)
@@ -137,7 +137,7 @@
    )
   )
  )
- (func $3 (type $none_=>_none)
+ (func $3 (type $0)
   (local $0 i64)
   (local $1 i64)
   (local $2 i32)
@@ -182,7 +182,7 @@
    )
   )
  )
- (func $4 (type $none_=>_none)
+ (func $4 (type $0)
   (atomic.fence)
  )
 )

test/atomics64.wast.fromBinary.noDebugInfo

@@ -1,5 +1,5 @@
 (module
- (type $none_=>_none (func))
+ (type $0 (func))
  (memory $0 (shared 1 1))
  (func $main
   (i32.atomic.store

test/binaryen.js/atomics.js.txt

@@ -1,7 +1,7 @@
 === default ===
 debugInfo=false
 (module
- (type $none_=>_none (func))
+ (type $0 (func))
  (memory $0 0)
  (export "test" (func $0))
  (func $0
@@ -23,7 +23,7 @@ debugInfo=true
 === without debug info ===
 debugInfo=false
 (module
- (type $none_=>_none (func))
+ (type $0 (func))
  (memory $0 0)
  (export "test" (func $0))
  (func $0

test/binaryen.js/debug-info.js.txt

@@ -10,7 +10,7 @@
 
 === parsed wast ===
 (module $hel
- (type $i32_=>_none (func (param i32)))
+ (type $0 (func (param i32)))
  (global $ld i32 (i32.const 0))
  (memory $lo 0 0)
  (table $wor 0 0 funcref)
@@ -22,7 +22,7 @@
 
 === roundtripped ===
 (module $hel
- (type $i32_=>_none (func (param i32)))
+ (type $0 (func (param i32)))
  (global $ld i32 (i32.const 0))
  (memory $lo 0 0)
  (table $wor 0 0 funcref)
@@ -34,7 +34,7 @@
 
 === roundtripped again ===
 (module $hel
- (type $i32_=>_none (func (param i32)))
+ (type $0 (func (param i32)))
  (global $ld i32 (i32.const 0))
  (memory $lo 0 0)
  (table $wor 0 0 funcref)