Replace i31.new with ref.i31 everywhere (#5931)

Replace i31.new with ref.i31 in the printer, tests, and source code. Continue
parsing i31.new for the time being to allow a graceful transition. Also update
the JS API to reflect the new instruction name.

Author: tlively

CHANGELOG.md

@@ -15,7 +15,9 @@ full changeset diff at the end of each section.
 Current Trunk
 -------------
 
- - "I31New" changed to "RefI31" everywhere it appears in the C API.
+ - "I31New" changed to "RefI31" everywhere it appears in the C API and similarly
+   "i31.new" has been replaced with "ref.i31" in the JS API and in printed
+   output.
 
 v115
 ----

scripts/gen-s-parser.py

@@ -564,7 +564,8 @@
     ("call_ref",             "makeCallRef(s, /*isReturn=*/false)"),
     ("return_call_ref",      "makeCallRef(s, /*isReturn=*/true)"),
     # GC
-    ("i31.new",              "makeRefI31(s)"),
+    ("i31.new",              "makeRefI31(s)"),  # deprecated
+    ("ref.i31",              "makeRefI31(s)"),
     ("i31.get_s",            "makeI31Get(s, true)"),
     ("i31.get_u",            "makeI31Get(s, false)"),
     ("ref.test",             "makeRefTest(s)"),

src/binaryen-c.h

@@ -2308,10 +2308,10 @@ BINARYEN_API void BinaryenTupleExtractSetIndex(BinaryenExpressionRef expr,
 
 // RefI31
 
-// Gets the value expression of an `i31.new` expression.
+// Gets the value expression of a `ref.i31` expression.
 BINARYEN_API BinaryenExpressionRef
 BinaryenRefI31GetValue(BinaryenExpressionRef expr);
-// Sets the value expression of an `i31.new` expression.
+// Sets the value expression of a `ref.i31` expression.
 BINARYEN_API void BinaryenRefI31SetValue(BinaryenExpressionRef expr,
                                          BinaryenExpressionRef valueExpr);
 

src/gen-s-parser.inc

@@ -2984,9 +2984,17 @@ switch (buf[0]) {
           case 'f':
             if (op == "ref.func"sv) { return makeRefFunc(s); }
             goto parse_error;
-          case 'i':
-            if (op == "ref.is_null"sv) { return makeRefIsNull(s); }
-            goto parse_error;
+          case 'i': {
+            switch (buf[5]) {
+              case '3':
+                if (op == "ref.i31"sv) { return makeRefI31(s); }
+                goto parse_error;
+              case 's':
+                if (op == "ref.is_null"sv) { return makeRefIsNull(s); }
+                goto parse_error;
+              default: goto parse_error;
+            }
+          }
           case 'n':
             if (op == "ref.null"sv) { return makeRefNull(s); }
             goto parse_error;
@@ -8585,13 +8593,25 @@ switch (buf[0]) {
               return *ret;
             }
             goto parse_error;
-          case 'i':
-            if (op == "ref.is_null"sv) {
-              auto ret = makeRefIsNull(ctx, pos);
-              CHECK_ERR(ret);
-              return *ret;
+          case 'i': {
+            switch (buf[5]) {
+              case '3':
+                if (op == "ref.i31"sv) {
+                  auto ret = makeRefI31(ctx, pos);
+                  CHECK_ERR(ret);
+                  return *ret;
+                }
+                goto parse_error;
+              case 's':
+                if (op == "ref.is_null"sv) {
+                  auto ret = makeRefIsNull(ctx, pos);
+                  CHECK_ERR(ret);
+                  return *ret;
+                }
+                goto parse_error;
+              default: goto parse_error;
             }
-            goto parse_error;
+          }
           case 'n':
             if (op == "ref.null"sv) {
               auto ret = makeRefNull(ctx, pos);

src/js/binaryen.js-post.js

@@ -2370,6 +2370,9 @@ function wrapModule(module, self = {}) {
     'func'(func, type) {
       return preserveStack(() => Module['_BinaryenRefFunc'](module, strToStack(func), type));
     },
+    'i31'(value) {
+      return Module['_BinaryenRefI31'](module, value);
+    },
     'eq'(left, right) {
       return Module['_BinaryenRefEq'](module, left, right);
     }
@@ -2418,9 +2421,6 @@ function wrapModule(module, self = {}) {
   };
 
   self['i31'] = {
-    'new'(value) {
-      return Module['_BinaryenRefI31'](module, value);
-    },
     'get_s'(i31) {
       return Module['_BinaryenI31Get'](module, i31, 1);
     },

src/passes/Print.cpp

@@ -1959,7 +1959,7 @@ struct PrintExpressionContents
     printMedium(o, "tuple.extract ");
     o << curr->index;
   }
-  void visitRefI31(RefI31* curr) { printMedium(o, "i31.new"); }
+  void visitRefI31(RefI31* curr) { printMedium(o, "ref.i31"); }
   void visitI31Get(I31Get* curr) {
     printMedium(o, curr->signed_ ? "i31.get_s" : "i31.get_u");
   }

src/passes/RemoveUnusedBrs.cpp

@@ -732,7 +732,7 @@ struct RemoveUnusedBrs : public WalkerPass<PostWalker<RemoveUnusedBrs>> {
         //
         //   (br_on_cast $l anyref i31ref
         //     (block (result anyref)
-        //       (i31.new ...)))
+        //       (ref.i31 ...)))
         //
         // We could just always do the cast and leave removing the casts to
         // OptimizeInstructions, but it's simple enough to avoid unnecessary

src/tools/fuzzing/fuzzing.cpp

@@ -2321,7 +2321,7 @@ Expression* TranslateToFuzzReader::makeBasicRef(Type type) {
         return builder.makeRefNull(HeapType::none);
       }
       auto nullability = getSubType(type.getNullability());
-      // i31.new is not allowed in initializer expressions.
+      // ref.i31 is not allowed in initializer expressions.
       HeapType subtype;
       switch (upTo(3)) {
         case 0:

src/wasm/wasm-validator.cpp

@@ -2504,11 +2504,11 @@ void FunctionValidator::visitCallRef(CallRef* curr) {
 
 void FunctionValidator::visitRefI31(RefI31* curr) {
   shouldBeTrue(
-    getModule()->features.hasGC(), curr, "i31.new requires gc [--enable-gc]");
+    getModule()->features.hasGC(), curr, "ref.i31 requires gc [--enable-gc]");
   shouldBeSubType(curr->value->type,
                   Type::i32,
                   curr->value,
-                  "i31.new's argument should be i32");
+                  "ref.i31's argument should be i32");
 }
 
 void FunctionValidator::visitI31Get(I31Get* curr) {

test/binaryen.js/expressions.js

@@ -1776,7 +1776,7 @@ console.log("# RefI31");
   const module = new binaryen.Module();
 
   var value = module.local.get(1, binaryen.i32);
-  const theRefI31 = binaryen.RefI31(module.i31.new(value));
+  const theRefI31 = binaryen.RefI31(module.ref.i31(value));
   assert(theRefI31 instanceof binaryen.RefI31);
   assert(theRefI31 instanceof binaryen.Expression);
   assert(theRefI31.value === value);
@@ -1792,7 +1792,7 @@ console.log("# RefI31");
   assert(
     theRefI31.toText()
     ==
-    "(i31.new\n (local.get $2)\n)\n"
+    "(ref.i31\n (local.get $2)\n)\n"
   );
 
   module.dispose();