Rename atomic.notify and *.atomic.wait (#3353)

- atomic.notify -> memory.atomic.notify - i32.atomic.wait -> memory.atomic.wait32 - i64.atomic.wait -> memory.atomic.wait64 See WebAssembly/threads#149. This renames instruction name printing but not the internal data structure names, such as `AtomicNotify`, which are not always the same as printed instruction names anyway. This also does not modify C API. But this fixes interface functions in binaryen.js because it seems binaryen.js's interface functions all follow the corresponding instruction names.
WebAssembly · Nov 13, 2020 · 75e6120 · 75e6120
1 parent cc2b3e4
commit 75e6120
Show file tree

Hide file tree

Showing 34 changed files with 155 additions and 140 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,10 @@ full changeset diff at the end of each section.
 Current Trunk
 -------------
 
+- JS API functions for atomic notify/wait instructions are renamed.
+  - `module.atomic.notify` -> `module.memory.atomic.notify`
+  - `module.i32.atomic.wait` -> `module.memory.atomic.wait32`
+  - `module.i64.atomic.wait` -> `module.memory.atomic.wait64`
 - Remove old/broken SpollPointers pass.  This pass: Spills values that might be
   pointers to the C stack. This allows Boehm-style GC to see them properly.
   This can be revived if needed from git history (#3261).

diff --git a/scripts/gen-s-parser.py b/scripts/gen-s-parser.py
@@ -201,9 +201,9 @@
     ("i64.extend16_s",      "makeUnary(s, UnaryOp::ExtendS16Int64)"),
     ("i64.extend32_s",      "makeUnary(s, UnaryOp::ExtendS32Int64)"),
     # atomic instructions
-    ("atomic.notify",           "makeAtomicNotify(s)"),
-    ("i32.atomic.wait",         "makeAtomicWait(s, Type::i32)"),
-    ("i64.atomic.wait",         "makeAtomicWait(s, Type::i64)"),
+    ("memory.atomic.notify",    "makeAtomicNotify(s)"),
+    ("memory.atomic.wait32",    "makeAtomicWait(s, Type::i32)"),
+    ("memory.atomic.wait64",    "makeAtomicWait(s, Type::i64)"),
     ("atomic.fence",            "makeAtomicFence(s)"),
     ("i32.atomic.load8_u",      "makeLoad(s, Type::i32, /*isAtomic=*/true)"),
     ("i32.atomic.load16_u",     "makeLoad(s, Type::i32, /*isAtomic=*/true)"),

diff --git a/src/binaryen-c.h b/src/binaryen-c.h
@@ -1404,47 +1404,47 @@ BinaryenAtomicCmpxchgSetReplacement(BinaryenExpressionRef expr,
 
 // AtomicWait
 
-// Gets the pointer expression of an `atomic.wait` expression.
+// Gets the pointer expression of an `memory.atomic.wait` expression.
 BINARYEN_API BinaryenExpressionRef
 BinaryenAtomicWaitGetPtr(BinaryenExpressionRef expr);
-// Sets the pointer expression of an `atomic.wait` expression.
+// Sets the pointer expression of an `memory.atomic.wait` expression.
 BINARYEN_API void BinaryenAtomicWaitSetPtr(BinaryenExpressionRef expr,
                                            BinaryenExpressionRef ptrExpr);
-// Gets the expression representing the expected value of an `atomic.wait`
-// expression.
+// Gets the expression representing the expected value of an
+// `memory.atomic.wait` expression.
 BINARYEN_API BinaryenExpressionRef
 BinaryenAtomicWaitGetExpected(BinaryenExpressionRef expr);
-// Sets the expression representing the expected value of an `atomic.wait`
-// expression.
+// Sets the expression representing the expected value of an
+// `memory.atomic.wait` expression.
 BINARYEN_API void
 BinaryenAtomicWaitSetExpected(BinaryenExpressionRef expr,
                               BinaryenExpressionRef expectedExpr);
-// Gets the timeout expression of an `atomic.wait` expression.
+// Gets the timeout expression of an `memory.atomic.wait` expression.
 BINARYEN_API BinaryenExpressionRef
 BinaryenAtomicWaitGetTimeout(BinaryenExpressionRef expr);
-// Sets the timeout expression of an `atomic.wait` expression.
+// Sets the timeout expression of an `memory.atomic.wait` expression.
 BINARYEN_API void
 BinaryenAtomicWaitSetTimeout(BinaryenExpressionRef expr,
                              BinaryenExpressionRef timeoutExpr);
-// Gets the expected type of an `atomic.wait` expression.
+// Gets the expected type of an `memory.atomic.wait` expression.
 BINARYEN_API BinaryenType
 BinaryenAtomicWaitGetExpectedType(BinaryenExpressionRef expr);
-// Sets the expected type of an `atomic.wait` expression.
+// Sets the expected type of an `memory.atomic.wait` expression.
 BINARYEN_API void BinaryenAtomicWaitSetExpectedType(BinaryenExpressionRef expr,
                                                     BinaryenType expectedType);
 
 // AtomicNotify
 
-// Gets the pointer expression of an `atomic.notify` expression.
+// Gets the pointer expression of an `memory.atomic.notify` expression.
 BINARYEN_API BinaryenExpressionRef
 BinaryenAtomicNotifyGetPtr(BinaryenExpressionRef expr);
-// Sets the pointer expression of an `atomic.notify` expression.
+// Sets the pointer expression of an `memory.atomic.notify` expression.
 BINARYEN_API void BinaryenAtomicNotifySetPtr(BinaryenExpressionRef expr,
                                              BinaryenExpressionRef ptrExpr);
-// Gets the notify count expression of an `atomic.notify` expression.
+// Gets the notify count expression of an `memory.atomic.notify` expression.
 BINARYEN_API BinaryenExpressionRef
 BinaryenAtomicNotifyGetNotifyCount(BinaryenExpressionRef expr);
-// Sets the notify count expression of an `atomic.notify` expression.
+// Sets the notify count expression of an `memory.atomic.notify` expression.
 BINARYEN_API void
 BinaryenAtomicNotifySetNotifyCount(BinaryenExpressionRef expr,
                                    BinaryenExpressionRef notifyCountExpr);

diff --git a/src/gen-s-parser.inc b/src/gen-s-parser.inc
@@ -50,17 +50,9 @@ switch (op[0]) {
           default: goto parse_error;
         }
       }
-      case 't': {
-        switch (op[7]) {
-          case 'f':
-            if (strcmp(op, "atomic.fence") == 0) { return makeAtomicFence(s); }
-            goto parse_error;
-          case 'n':
-            if (strcmp(op, "atomic.notify") == 0) { return makeAtomicNotify(s); }
-            goto parse_error;
-          default: goto parse_error;
-        }
-      }
+      case 't':
+        if (strcmp(op, "atomic.fence") == 0) { return makeAtomicFence(s); }
+        goto parse_error;
       default: goto parse_error;
     }
   }
@@ -1224,9 +1216,6 @@ switch (op[0]) {
                               default: goto parse_error;
                             }
                           }
-                          case 'w':
-                            if (strcmp(op, "i32.atomic.wait") == 0) { return makeAtomicWait(s, Type::i32); }
-                            goto parse_error;
                           default: goto parse_error;
                         }
                       }
@@ -1976,9 +1965,6 @@ switch (op[0]) {
                           default: goto parse_error;
                         }
                       }
-                      case 'w':
-                        if (strcmp(op, "i64.atomic.wait") == 0) { return makeAtomicWait(s, Type::i64); }
-                        goto parse_error;
                       default: goto parse_error;
                     }
                   }
@@ -2676,6 +2662,25 @@ switch (op[0]) {
   }
   case 'm': {
     switch (op[7]) {
+      case 'a': {
+        switch (op[14]) {
+          case 'n':
+            if (strcmp(op, "memory.atomic.notify") == 0) { return makeAtomicNotify(s); }
+            goto parse_error;
+          case 'w': {
+            switch (op[18]) {
+              case '3':
+                if (strcmp(op, "memory.atomic.wait32") == 0) { return makeAtomicWait(s, Type::i32); }
+                goto parse_error;
+              case '6':
+                if (strcmp(op, "memory.atomic.wait64") == 0) { return makeAtomicWait(s, Type::i64); }
+                goto parse_error;
+              default: goto parse_error;
+            }
+          }
+          default: goto parse_error;
+        }
+      }
       case 'c':
         if (strcmp(op, "memory.copy") == 0) { return makeMemoryCopy(s); }
         goto parse_error;

diff --git a/src/js/binaryen.js-post.js b/src/js/binaryen.js-post.js
@@ -629,6 +629,17 @@ function wrapModule(module, self = {}) {
     },
     'fill'(dest, value, size) {
       return Module['_BinaryenMemoryFill'](module, dest, value, size);
+    },
+    'atomic': {
+      'notify'(ptr, notifyCount) {
+        return Module['_BinaryenAtomicNotify'](module, ptr, notifyCount);
+      },
+      'wait32'(ptr, expected, timeout) {
+        return Module['_BinaryenAtomicWait'](module, ptr, expected, timeout, Module['i32']);
+      },
+      'wait64'(ptr, expected, timeout) {
+        return Module['_BinaryenAtomicWait'](module, ptr, expected, timeout, Module['i64']);
+      }
     }
   }
 
@@ -889,9 +900,6 @@ function wrapModule(module, self = {}) {
           return Module['_BinaryenAtomicCmpxchg'](module, 2, offset, ptr, expected, replacement, Module['i32'])
         },
       },
-      'wait'(ptr, expected, timeout) {
-        return Module['_BinaryenAtomicWait'](module, ptr, expected, timeout, Module['i32']);
-      }
     },
     'pop'() {
       return Module['_BinaryenPop'](module, Module['i32']);
@@ -1193,9 +1201,6 @@ function wrapModule(module, self = {}) {
           return Module['_BinaryenAtomicCmpxchg'](module, 4, offset, ptr, expected, replacement, Module['i64'])
         },
       },
-      'wait'(ptr, expected, timeout) {
-        return Module['_BinaryenAtomicWait'](module, ptr, expected, timeout, Module['i64']);
-      }
     },
     'pop'() {
       return Module['_BinaryenPop'](module, Module['i64']);
@@ -2132,9 +2137,6 @@ function wrapModule(module, self = {}) {
   };
 
   self['atomic'] = {
-    'notify'(ptr, notifyCount) {
-      return Module['_BinaryenAtomicNotify'](module, ptr, notifyCount);
-    },
     'fence'() {
       return Module['_BinaryenAtomicFence'](module);
     }

diff --git a/src/passes/Print.cpp b/src/passes/Print.cpp
@@ -317,13 +317,15 @@ struct PrintExpressionContents
   }
   void visitAtomicWait(AtomicWait* curr) {
     prepareColor(o);
-    o << forceConcrete(curr->expectedType) << ".atomic.wait";
+    Type type = forceConcrete(curr->expectedType);
+    assert(type == Type::i32 || type == Type::i64);
+    o << "memory.atomic.wait" << (type == Type::i32 ? "32" : "64");
     if (curr->offset) {
       o << " offset=" << curr->offset;
     }
   }
   void visitAtomicNotify(AtomicNotify* curr) {
-    printMedium(o, "atomic.notify");
+    printMedium(o, "memory.atomic.notify");
     if (curr->offset) {
       o << " offset=" << curr->offset;
     }

diff --git a/src/wasm/wasm-s-parser.cpp b/src/wasm/wasm-s-parser.cpp
@@ -1463,11 +1463,12 @@ Expression* SExpressionWasmBuilder::makeAtomicWait(Element& s, Type type) {
   } else if (type == Type::i64) {
     expectedAlign = 8;
   } else {
-    WASM_UNREACHABLE("Invalid prefix for atomic.wait");
+    WASM_UNREACHABLE("Invalid prefix for memory.atomic.wait");
   }
   size_t i = parseMemAttributes(s, ret->offset, align, expectedAlign);
   if (align != expectedAlign) {
-    throw ParseException("Align of atomic.wait must match size", s.line, s.col);
+    throw ParseException(
+      "Align of memory.atomic.wait must match size", s.line, s.col);
   }
   ret->ptr = parseExpression(s[i]);
   ret->expected = parseExpression(s[i + 1]);
@@ -1482,7 +1483,8 @@ Expression* SExpressionWasmBuilder::makeAtomicNotify(Element& s) {
   Address align;
   size_t i = parseMemAttributes(s, ret->offset, align, 4);
   if (align != 4) {
-    throw ParseException("Align of atomic.notify must be 4", s.line, s.col);
+    throw ParseException(
+      "Align of memory.atomic.notify must be 4", s.line, s.col);
   }
   ret->ptr = parseExpression(s[i]);
   ret->notifyCount = parseExpression(s[i + 1]);

diff --git a/test/atomics.wast b/test/atomics.wast
@@ -138,40 +138,40 @@
   (local $0 i32)
   (local $1 i64)
   (drop
-   (i32.atomic.wait
+   (memory.atomic.wait32
     (local.get $0)
     (local.get $0)
     (local.get $1)
    )
   )
   (drop
-   (i32.atomic.wait offset=4 align=4
+   (memory.atomic.wait32 offset=4 align=4
     (local.get $0)
     (local.get $0)
     (local.get $1)
    )
   )
   (drop
-   (atomic.notify
+   (memory.atomic.notify
     (local.get $0)
     (local.get $0)
    )
   )
   (drop
-   (atomic.notify offset=24 align=4
+   (memory.atomic.notify offset=24 align=4
     (local.get $0)
     (local.get $0)
    )
   )
   (drop
-   (i64.atomic.wait
+   (memory.atomic.wait64
     (local.get $0)
     (local.get $1)
     (local.get $1)
    )
   )
   (drop
-   (i64.atomic.wait align=8 offset=16
+   (memory.atomic.wait64 align=8 offset=16
     (local.get $0)
     (local.get $1)
     (local.get $1)

diff --git a/test/atomics.wast.from-wast b/test/atomics.wast.from-wast
@@ -138,40 +138,40 @@
   (local $0 i32)
   (local $1 i64)
   (drop
-   (i32.atomic.wait
+   (memory.atomic.wait32
     (local.get $0)
     (local.get $0)
     (local.get $1)
    )
   )
   (drop
-   (i32.atomic.wait offset=4
+   (memory.atomic.wait32 offset=4
     (local.get $0)
     (local.get $0)
     (local.get $1)
    )
   )
   (drop
-   (atomic.notify
+   (memory.atomic.notify
     (local.get $0)
     (local.get $0)
    )
   )
   (drop
-   (atomic.notify offset=24
+   (memory.atomic.notify offset=24
     (local.get $0)
     (local.get $0)
    )
   )
   (drop
-   (i64.atomic.wait
+   (memory.atomic.wait64
     (local.get $0)
     (local.get $1)
     (local.get $1)
    )
   )
   (drop
-   (i64.atomic.wait offset=16
+   (memory.atomic.wait64 offset=16
     (local.get $0)
     (local.get $1)
     (local.get $1)

diff --git a/test/atomics.wast.fromBinary b/test/atomics.wast.fromBinary
@@ -138,40 +138,40 @@
   (local $0 i32)
   (local $1 i64)
   (drop
-   (i32.atomic.wait
+   (memory.atomic.wait32
     (local.get $0)
     (local.get $0)
     (local.get $1)
    )
   )
   (drop
-   (i32.atomic.wait offset=4
+   (memory.atomic.wait32 offset=4
     (local.get $0)
     (local.get $0)
     (local.get $1)
    )
   )
   (drop
-   (atomic.notify
+   (memory.atomic.notify
     (local.get $0)
     (local.get $0)
    )
   )
   (drop
-   (atomic.notify offset=24
+   (memory.atomic.notify offset=24
     (local.get $0)
     (local.get $0)
    )
   )
   (drop
-   (i64.atomic.wait
+   (memory.atomic.wait64
     (local.get $0)
     (local.get $1)
     (local.get $1)
    )
   )
   (drop
-   (i64.atomic.wait offset=16
+   (memory.atomic.wait64 offset=16
     (local.get $0)
     (local.get $1)
     (local.get $1)