Emit binary function index in comment in text format, for convenience (#1232)

Author: kripken

scripts/test/s2wasm.py

@@ -119,7 +119,15 @@ def test_linker():
   for name, extra in expected_funcs:
     space = ' ' if extra else ''
     fail_if_not_contained(output, '(export "{0}" (func ${0}))'.format(name))
-    fail_if_not_contained(output, '(func ${0}'.format(name + space + extra))
+    for line in output.split('\n'):
+      if '(func ${0}'.format(name + space) in line:
+        # we found the relevant line for the function definition. remove
+        # a (; X ;) comment with its index
+        start = line.find('(; ')
+        if start >= 0:
+          end = line.find(' ;)')
+          line = line[:start] + line[end + 4:]
+        fail_if_not_contained(line, '(func ${0}'.format(name + space + extra))
 
 
 if __name__ == '__main__':

src/ast/module-utils.h

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2017 WebAssembly Community Group participants
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef wasm_ast_module_h
+#define wasm_ast_module_h
+
+#include "wasm.h"
+
+namespace wasm {
+
+namespace ModuleUtils {
+
+// Computes the indexes in a wasm binary, i.e., with function imports
+// and function implementations sharing a single index space, etc.
+struct BinaryIndexes {
+  std::unordered_map<Name, Index> functionIndexes;
+  std::unordered_map<Name, Index> globalIndexes;
+
+  BinaryIndexes(Module& wasm) {
+    for (Index i = 0; i < wasm.imports.size(); i++) {
+      auto& import = wasm.imports[i];
+      if (import->kind == ExternalKind::Function) {
+        auto index = functionIndexes.size();
+        functionIndexes[import->name] = index;
+      } else if (import->kind == ExternalKind::Global) {
+        auto index = globalIndexes.size();
+        globalIndexes[import->name] = index;
+      }
+    }
+    for (Index i = 0; i < wasm.functions.size(); i++) {
+      auto index = functionIndexes.size();
+      functionIndexes[wasm.functions[i]->name] = index;
+    }
+    for (Index i = 0; i < wasm.globals.size(); i++) {
+      auto index = globalIndexes.size();
+      globalIndexes[wasm.globals[i]->name] = index;
+    }
+  }
+};
+
+} // namespace ModuleUtils
+
+} // namespace wasm
+
+#endif // wasm_ast_module_h
+

src/passes/Print.cpp

@@ -22,6 +22,7 @@
 #include <wasm-printing.h>
 #include <pass.h>
 #include <pretty_printing.h>
+#include <ast/module-utils.h>
 
 namespace wasm {
 
@@ -47,6 +48,8 @@ struct PrintSExpression : public Visitor<PrintSExpression> {
   Function* currFunction = nullptr;
   Function::DebugLocation lastPrintedLocation;
 
+  std::unordered_map<Name, Index> functionIndexes;
+
   PrintSExpression(std::ostream& o) : o(o) {
     setMinify(false);
     if (!full) full = isFullForced();
@@ -686,6 +689,14 @@ struct PrintSExpression : public Visitor<PrintSExpression> {
     lastPrintedLocation = { 0, 0, 0 };
     printOpening(o, "func ", true);
     printName(curr->name);
+    if (currModule && !minify) {
+      // emit the function index in a comment
+      if (functionIndexes.empty()) {
+        ModuleUtils::BinaryIndexes indexes(*currModule);
+        functionIndexes = std::move(indexes.functionIndexes);
+      }
+      o << " (; " << functionIndexes[curr->name] << " ;)";
+    }
     if (curr->type.is()) {
       o << maybeSpace << "(type " << curr->type << ')';
     }

src/wasm-binary.h

@@ -696,8 +696,8 @@ class WasmBinaryWriter : public Visitor<WasmBinaryWriter, void> {
   void writeExports();
   void writeDataSegments();
 
-  std::map<Name, Index> mappedFunctions; // name of the Function => index. first imports, then internals
-  std::map<Name, uint32_t> mappedGlobals; // name of the Global => index. first imported globals, then internal globals
+  std::unordered_map<Name, Index> mappedFunctions; // name of the Function => index. first imports, then internals
+  std::unordered_map<Name, uint32_t> mappedGlobals; // name of the Global => index. first imported globals, then internal globals
   uint32_t getFunctionIndex(Name name);
   uint32_t getGlobalIndex(Name name);
 

src/wasm/wasm-binary.cpp

@@ -20,6 +20,7 @@
 #include "support/bits.h"
 #include "wasm-binary.h"
 #include "ast/branch-utils.h"
+#include "ast/module-utils.h"
 
 namespace wasm {
 
@@ -31,6 +32,9 @@ void WasmBinaryWriter::prepare() {
     }
     // TODO: depending on upstream flux https://github.com/WebAssembly/spec/pull/301 might want this: assert(!func->type.isNull());
   }
+  ModuleUtils::BinaryIndexes indexes(*wasm);
+  mappedFunctions = std::move(indexes.functionIndexes);
+  mappedGlobals = std::move(indexes.globalIndexes);
 }
 
 void WasmBinaryWriter::write() {
@@ -343,39 +347,11 @@ void WasmBinaryWriter::writeDataSegments() {
 }
 
 uint32_t WasmBinaryWriter::getFunctionIndex(Name name) {
-  if (!mappedFunctions.size()) {
-    // Create name => index mapping.
-    for (auto& import : wasm->imports) {
-      if (import->kind != ExternalKind::Function) continue;
-      assert(mappedFunctions.count(import->name) == 0);
-      auto index = mappedFunctions.size();
-      mappedFunctions[import->name] = index;
-    }
-    for (size_t i = 0; i < wasm->functions.size(); i++) {
-      assert(mappedFunctions.count(wasm->functions[i]->name) == 0);
-      auto index = mappedFunctions.size();
-      mappedFunctions[wasm->functions[i]->name] = index;
-    }
-  }
   assert(mappedFunctions.count(name));
   return mappedFunctions[name];
 }
 
 uint32_t WasmBinaryWriter::getGlobalIndex(Name name) {
-  if (!mappedGlobals.size()) {
-    // Create name => index mapping.
-    for (auto& import : wasm->imports) {
-      if (import->kind != ExternalKind::Global) continue;
-      assert(mappedGlobals.count(import->name) == 0);
-      auto index = mappedGlobals.size();
-      mappedGlobals[import->name] = index;
-    }
-    for (size_t i = 0; i < wasm->globals.size(); i++) {
-      assert(mappedGlobals.count(wasm->globals[i]->name) == 0);
-      auto index = mappedGlobals.size();
-      mappedGlobals[wasm->globals[i]->name] = index;
-    }
-  }
   assert(mappedGlobals.count(name));
   return mappedGlobals[name];
 }

test/atomics.wast.from-wast

@@ -1,7 +1,7 @@
 (module
  (type $0 (func))
  (memory $0 (shared 23 256))
- (func $atomic-loadstore (type $0)
+ (func $atomic-loadstore (; 0 ;) (type $0)
   (local $0 i32)
   (local $1 i64)
   (drop
@@ -68,7 +68,7 @@
    (get_local $1)
   )
  )
- (func $atomic-rmw (type $0)
+ (func $atomic-rmw (; 1 ;) (type $0)
   (local $0 i32)
   (local $1 i64)
   (drop
@@ -102,7 +102,7 @@
    )
   )
  )
- (func $atomic-cmpxchg (type $0)
+ (func $atomic-cmpxchg (; 2 ;) (type $0)
   (local $0 i32)
   (local $1 i64)
   (drop
@@ -134,7 +134,7 @@
    )
   )
  )
- (func $atomic-wait-wake (type $0)
+ (func $atomic-wait-wake (; 3 ;) (type $0)
   (local $0 i32)
   (local $1 i64)
   (drop

test/atomics.wast.fromBinary

@@ -1,7 +1,7 @@
 (module
  (type $0 (func))
  (memory $0 (shared 23 256))
- (func $atomic-loadstore (type $0)
+ (func $atomic-loadstore (; 0 ;) (type $0)
   (local $var$0 i32)
   (local $var$1 i64)
   (drop
@@ -68,7 +68,7 @@
    (get_local $var$1)
   )
  )
- (func $atomic-rmw (type $0)
+ (func $atomic-rmw (; 1 ;) (type $0)
   (local $var$0 i32)
   (local $var$1 i64)
   (drop
@@ -102,7 +102,7 @@
    )
   )
  )
- (func $atomic-cmpxchg (type $0)
+ (func $atomic-cmpxchg (; 2 ;) (type $0)
   (local $var$0 i32)
   (local $var$1 i64)
   (drop
@@ -134,7 +134,7 @@
    )
   )
  )
- (func $atomic-wait-wake (type $0)
+ (func $atomic-wait-wake (; 3 ;) (type $0)
   (local $var$0 i32)
   (local $var$1 i64)
   (drop

test/atomics.wast.fromBinary.noDebugInfo

@@ -1,7 +1,7 @@
 (module
  (type $0 (func))
  (memory $0 (shared 23 256))
- (func $0 (type $0)
+ (func $0 (; 0 ;) (type $0)
   (local $var$0 i32)
   (local $var$1 i64)
   (drop
@@ -68,7 +68,7 @@
    (get_local $var$1)
   )
  )
- (func $1 (type $0)
+ (func $1 (; 1 ;) (type $0)
   (local $var$0 i32)
   (local $var$1 i64)
   (drop
@@ -102,7 +102,7 @@
    )
   )
  )
- (func $2 (type $0)
+ (func $2 (; 2 ;) (type $0)
   (local $var$0 i32)
   (local $var$1 i64)
   (drop
@@ -134,7 +134,7 @@
    )
   )
  )
- (func $3 (type $0)
+ (func $3 (; 3 ;) (type $0)
   (local $var$0 i32)
   (local $var$1 i64)
   (drop

test/break-to-return.wasm.fromBinary

@@ -2,7 +2,7 @@
  (type $0 (func (param i32 i32) (result i32)))
  (memory $0 256 256)
  (export "add" (func $0))
- (func $0 (type $0) (param $var$0 i32) (param $var$1 i32) (result i32)
+ (func $0 (; 0 ;) (type $0) (param $var$0 i32) (param $var$1 i32) (result i32)
   (block $label$0 (result i32)
    (br $label$0
     (i32.add

test/ctor-eval/bad-indirect-call.wast.out

@@ -5,7 +5,7 @@
  (memory $0 256 256)
  (data (i32.const 10) "waka waka waka waka waka")
  (export "test1" (func $test1))
- (func $test1 (type $v)
+ (func $test1 (; 0 ;) (type $v)
   (call_indirect $v
    (i32.const 1)
   )
@@ -14,7 +14,7 @@
    (i32.const 120)
   )
  )
- (func $call-indirect (type $v)
+ (func $call-indirect (; 1 ;) (type $v)
   (i32.store8
    (i32.const 40)
    (i32.const 67)