Exports .txtmap file when .wasm is exported from asm2wasm.

Author: dschuff

auto_update_tests.py

@@ -41,6 +41,10 @@
         print ' '.join(cmd)
         actual = run_command(cmd)
         with open(os.path.join('test', wasm), 'w') as o: o.write(actual)
+        if 'debugInfo' in asm:
+          cmd += ['--binarymap-file', os.path.join('test', wasm + '.map'), '-o', 'a.wasm']
+          run_command(cmd)
+
 
 for dot_s_dir in ['dot_s', 'llvm_autogenerated']:
   for s in sorted(os.listdir(os.path.join('test', dot_s_dir))):

check.py

@@ -189,6 +189,31 @@ def do_asm2wasm_test():
               fail_with_error('wasm interpreter error: ' + err) # failed to pretty-print
             fail_with_error('wasm interpreter error')
 
+        # verify debug info
+        if 'debugInfo' in asm:
+          txtmap = 'a.wasm.txtmap'
+          cmd += ['--binarymap-file', txtmap,
+                  '--binarymap-url', txtmap + '.map',
+                  '-o', 'a.wasm']
+          run_command(cmd)
+          if not os.path.isfile(txtmap):
+            fail_with_error('Debug info map not created: %s' % txtmap)
+          with open(wasm + '.txtmap', 'rb') as expected:
+            with open(txtmap, 'rb') as actual:
+              fail_if_not_identical(actual.read(), expected.read())
+          with open('a.wasm', 'rb') as binary:
+            url_section_name = bytearray([16]) + bytearray('sourceMappingURL')
+            payload = txtmap + '.map'
+            assert len(payload) < 256, 'name too long'
+            url_section_contents = bytearray([len(payload)]) + bytearray(payload)
+            print url_section_name
+            binary_contents = bytearray(binary.read())
+            if url_section_name not in binary_contents:
+              fail_with_error('source map url section not found in binary')
+            if url_section_contents not in binary_contents[binary_contents.index(url_section_name):]:
+              fail_with_error('source map url not found in url section')
+
+
 print '\n[ checking asm2wasm binary reading/writing... ]\n'
 
 asmjs = os.path.join(options.binaryen_test, 'hello_world.asm.js')

src/tools/asm2wasm.cpp

@@ -36,6 +36,8 @@ int main(int argc, const char *argv[]) {
   bool legalizeJavaScriptFFI = true;
   Asm2WasmBuilder::TrapMode trapMode = Asm2WasmBuilder::TrapMode::JS;
   bool wasmOnly = false;
+  std::string binaryMapFile;
+  std::string binaryMapUrl;
   std::string symbolMap;
   bool emitBinary = true;
 
@@ -99,9 +101,15 @@ int main(int argc, const char *argv[]) {
            [&legalizeJavaScriptFFI](Options *o, const std::string &) {
              legalizeJavaScriptFFI = false;
            })
-      .add("--debuginfo", "-g", "Emit names section and debug info (for debug info you must emit text, -S, for this to work)",
+      .add("--debuginfo", "-g", "Emit names section in wasm binary (or full debuginfo in wast)",
            Options::Arguments::Zero,
            [&](Options *o, const std::string &arguments) { options.passOptions.debugInfo = true; })
+      .add("--binarymap-file", "-bm", "Emit binary map (if using binary output) to the specified file",
+           Options::Arguments::One,
+           [&binaryMapFile](Options *o, const std::string &argument) { binaryMapFile = argument; })
+      .add("--binarymap-url", "-bu", "Use specified string as binary map URL",
+           Options::Arguments::One,
+           [&binaryMapUrl](Options *o, const std::string &argument) { binaryMapUrl = argument; })
       .add("--symbolmap", "-s", "Emit a symbol map (indexes => names)",
            Options::Arguments::One,
            [&](Options *o, const std::string &argument) { symbolMap = argument; })
@@ -136,8 +144,9 @@ int main(int argc, const char *argv[]) {
   }
 
   Asm2WasmPreProcessor pre;
-  // wasm binaries can contain a names section, but not full debug info
-  pre.debugInfo = options.passOptions.debugInfo && !emitBinary;
+  // wasm binaries can contain a names section, but not full debug info --
+  // debug info is disabled if a map file is not specified with wasm binary
+  pre.debugInfo = options.passOptions.debugInfo && (!emitBinary || binaryMapFile.size());
   auto input(
       read_file<std::vector<char>>(options.extra["infile"], Flags::Text, options.debug ? Flags::Debug : Flags::Release));
   char *start = pre.process(input.data());
@@ -204,6 +213,10 @@ int main(int argc, const char *argv[]) {
   writer.setDebugInfo(options.passOptions.debugInfo);
   writer.setSymbolMap(symbolMap);
   writer.setBinary(emitBinary);
+  if (emitBinary) {
+    writer.setBinaryMapFilename(binaryMapFile);
+    writer.setBinaryMapUrl(binaryMapUrl);
+  }
   writer.write(wasm, options.extra["output"]);
 
   if (options.debug) std::cerr << "done." << std::endl;

src/tools/wasm-as.cpp

@@ -86,7 +86,8 @@ int main(int argc, const char *argv[]) {
   if (options.debug) std::cerr << "binarification..." << std::endl;
   BufferWithRandomAccess buffer(options.debug);
   WasmBinaryWriter writer(&wasm, buffer, options.debug);
-  writer.setDebugInfo(debugInfo);
+  // if debug info is used, then we want to emit the names section
+  writer.setNamesSection(debugInfo);
   if (symbolMap.size() > 0) writer.setSymbolMap(symbolMap);
   writer.write();
 

src/wasm-binary.h

@@ -308,6 +308,7 @@ enum EncodedType {
 
 namespace UserSections {
 extern const char* Name;
+extern const char* SourceMapUrl;
 
 enum Subsection {
   NameFunction = 1,
@@ -534,8 +535,11 @@ inline S32LEB binaryWasmType(WasmType type) {
 class WasmBinaryWriter : public Visitor<WasmBinaryWriter, void> {
   Module* wasm;
   BufferWithRandomAccess& o;
+  Function* currFunction = nullptr;
   bool debug;
   bool debugInfo = true;
+  std::ostream* binaryMap = nullptr;
+  std::string binaryMapUrl;
   std::string symbolMap;
 
   MixedArena allocator;
@@ -546,7 +550,11 @@ class WasmBinaryWriter : public Visitor<WasmBinaryWriter, void> {
     prepare();
   }
 
-  void setDebugInfo(bool set) { debugInfo = set; }
+  void setNamesSection(bool set) { debugInfo = set; }
+  void setBinaryMap(std::ostream* set, std::string url) {
+    binaryMap = set;
+    binaryMapUrl = url;
+  }
   void setSymbolMap(std::string set) { symbolMap = set; }
 
   void write();
@@ -582,6 +590,7 @@ class WasmBinaryWriter : public Visitor<WasmBinaryWriter, void> {
   void writeFunctionTableDeclaration();
   void writeTableElements();
   void writeNames();
+  void writeSourceMapUrl();
   void writeSymbolMap();
 
   // helpers
@@ -607,6 +616,19 @@ class WasmBinaryWriter : public Visitor<WasmBinaryWriter, void> {
   void recurse(Expression*& curr);
   std::vector<Name> breakStack;
 
+  void visit(Expression* curr) {
+    if (binaryMap && currFunction) {
+      // Dump the binaryMap debug info
+      auto& debugLocations = currFunction->debugLocations;
+      auto iter = debugLocations.find(curr);
+      if (iter != debugLocations.end()) {
+        auto fileName = wasm->debugInfoFileNames[iter->second.fileIndex];
+        *binaryMap << o.size() << ":" << fileName << ":" <<iter->second.lineNumber << '\n';
+      }
+    }
+    Visitor<WasmBinaryWriter>::visit(curr);
+  }
+
   void visitBlock(Block *curr);
   // emits a node, but if it is a block with no name, emit a list of its contents
   void recursePossibleBlockContents(Expression* curr);

src/wasm-io.h

@@ -48,11 +48,15 @@ class ModuleWriter : public ModuleIO {
   bool binary = true;
   bool debugInfo = false;
   std::string symbolMap;
+  std::string binaryMapFilename;
+  std::string binaryMapUrl;
 
 public:
   void setBinary(bool binary_) { binary = binary_; }
   void setDebugInfo(bool debugInfo_) { debugInfo = debugInfo_; }
   void setSymbolMap(std::string symbolMap_) { symbolMap = symbolMap_; }
+  void setBinaryMapFilename(std::string binaryMapFilename_) { binaryMapFilename = binaryMapFilename_; }
+  void setBinaryMapUrl(std::string binaryMapUrl_) { binaryMapUrl = binaryMapUrl_; }
 
   // write text
   void writeText(Module& wasm, std::string filename);

src/wasm/wasm-binary.cpp

@@ -46,6 +46,7 @@ void WasmBinaryWriter::write() {
   writeFunctions();
   writeDataSegments();
   if (debugInfo) writeNames();
+  if (binaryMap) writeSourceMapUrl();
   if (symbolMap.size() > 0) writeSymbolMap();
 
   finishUp();
@@ -236,6 +237,7 @@ void WasmBinaryWriter::writeFunctions() {
     size_t sizePos = writeU32LEBPlaceholder();
     size_t start = o.size();
     Function* function = wasm->functions[i].get();
+    currFunction = function;
     mappedLocals.clear();
     numLocalsByType.clear();
     if (debug) std::cerr << "writing" << function->name << std::endl;
@@ -258,6 +260,7 @@ void WasmBinaryWriter::writeFunctions() {
     if (debug) std::cerr << "body size: " << size << ", writing at " << sizePos << ", next starts at " << o.size() << std::endl;
     o.writeAt(sizePos, U32LEB(size));
   }
+  currFunction = nullptr;
   finishSection(start);
 }
 
@@ -420,6 +423,14 @@ void WasmBinaryWriter::writeNames() {
   finishSection(start);
 }
 
+void WasmBinaryWriter::writeSourceMapUrl() {
+  if (debug) std::cerr << "== writeSourceMapUrl" << std::endl;
+  auto start = startSection(BinaryConsts::Section::User);
+  writeInlineString(BinaryConsts::UserSections::SourceMapUrl);
+  writeInlineString(binaryMapUrl.c_str());
+  finishSection(start);
+}
+
 void WasmBinaryWriter::writeSymbolMap() {
   std::ofstream file(symbolMap);
   for (auto& import : wasm->imports) {

src/wasm/wasm-io.cpp

@@ -72,11 +72,21 @@ void ModuleWriter::writeBinary(Module& wasm, std::string filename) {
   if (debug) std::cerr << "writing binary to " << filename << "\n";
   BufferWithRandomAccess buffer(debug);
   WasmBinaryWriter writer(&wasm, buffer, debug);
-  writer.setDebugInfo(debugInfo);
+  // if debug info is used, then we want to emit the names section
+  writer.setNamesSection(debugInfo);
+  std::unique_ptr<std::ofstream> binaryMapStream;
+  if (binaryMapFilename.size()) {
+    binaryMapStream = make_unique<std::ofstream>();
+    binaryMapStream->open(binaryMapFilename);
+    writer.setBinaryMap(binaryMapStream.get(), binaryMapUrl);
+  }
   if (symbolMap.size() > 0) writer.setSymbolMap(symbolMap);
   writer.write();
   Output output(filename, Flags::Binary, debug ? Flags::Debug : Flags::Release);
   buffer.writeTo(output);
+  if (binaryMapStream) {
+    binaryMapStream->close();
+  }
 }
 
 void ModuleWriter::write(Module& wasm, std::string filename) {
@@ -88,4 +98,3 @@ void ModuleWriter::write(Module& wasm, std::string filename) {
 }
 
 }
-

src/wasm/wasm.cpp

@@ -28,6 +28,7 @@ Name WASM("wasm"),
 namespace BinaryConsts {
 namespace UserSections {
 const char* Name = "name";
+const char* SourceMapUrl = "sourceMappingURL";
 }
 }
 

test/debugInfo.fromasm.clamp.no-opts.txtmap

@@ -0,0 +1,8 @@
+164:tests/hello_world.c:5
+168:tests/hello_world.c:6
+172:tests/other_file.cpp:314159
+194:return.cpp:50
+201:return.cpp:100
+241:even-opted.cpp:1
+248:even-opted.cpp:2
+255:even-opted.cpp:3