[wasm] Implement AST printing into an ostream

src/wasm/ast-decoder.cc

 // Copyright 2015 the V8 project authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "src/signature.h"
 
 #include "src/bit-vector.h"
 #include "src/flags.h"
 #include "src/handles.h"
 #include "src/zone-containers.h"
@@ skipping 130 matching lines @@
         operand.type = kAstStmt;
       }
       return true;
     }
     error(pc, pc + 1, "invalid local index");
     return false;
   }
 
   inline bool Validate(const byte* pc, GlobalIndexOperand& operand) {
     ModuleEnv* m = module_;
-    if (m && m->module && operand.index < m->module->globals.size()) {
+    if (!m || !m->module) return false;

[titzer, 2016/06/10 10:57:40]

This change means that there will not be an error recorded for when there isn't
a module environment supplied. That will probably break downstream assumptions.

[Clemens Hammacher, 2016/06/13 09:45:17]

I changed it to have a Complete() and a Validate() function, s.t. Validate()
calls Complete(), and only Validate() will report any errors.

+    if (operand.index < m->module->globals.size()) {
       operand.machine_type = m->module->globals[operand.index].type;
       operand.type = WasmOpcodes::LocalTypeFor(operand.machine_type);
       return true;
     }
     error(pc, pc + 1, "invalid global index");
     return false;
   }
 
   inline bool Validate(const byte* pc, CallFunctionOperand& operand) {
     ModuleEnv* m = module_;
-    if (m && m->module && operand.index < m->module->functions.size()) {
+    if (!m || !m->module) return false;
+    if (operand.index < m->module->functions.size()) {
       operand.sig = m->module->functions[operand.index].sig;
       uint32_t expected = static_cast<uint32_t>(operand.sig->parameter_count());
       if (operand.arity != expected) {
         error(pc, pc + 1,
               "arity mismatch in direct function call (expected %u, got %u)",
               expected, operand.arity);
         return false;
       }
       return true;
     }
     error(pc, pc + 1, "invalid function index");
     return false;
   }
 
   inline bool Validate(const byte* pc, CallIndirectOperand& operand) {
     ModuleEnv* m = module_;
-    if (m && m->module && operand.index < m->module->signatures.size()) {
+    if (!m || !m->module) return false;
+    if (operand.index < m->module->signatures.size()) {
       operand.sig = m->module->signatures[operand.index];
       uint32_t expected = static_cast<uint32_t>(operand.sig->parameter_count());
       if (operand.arity != expected) {
         error(pc, pc + 1,
               "arity mismatch in indirect function call (expected %u, got %u)",
               expected, operand.arity);
         return false;
       }
       return true;
     }
     error(pc, pc + 1, "invalid signature index");
     return false;
   }
 
   inline bool Validate(const byte* pc, CallImportOperand& operand) {
     ModuleEnv* m = module_;
-    if (m && m->module && operand.index < m->module->import_table.size()) {
+    if (!m || !m->module) return false;
+    if (operand.index < m->module->import_table.size()) {
       operand.sig = m->module->import_table[operand.index].sig;
       uint32_t expected = static_cast<uint32_t>(operand.sig->parameter_count());
       if (operand.arity != expected) {
         error(pc, pc + 1, "arity mismatch in import call (expected %u, got %u)",
               expected, operand.arity);
         return false;
       }
       return true;
     }
     error(pc, pc + 1, "invalid signature index");
@@ skipping 177 matching lines @@
       default:
         return 1;
     }
   }
 };
 
 // A shift-reduce-parser strategy for decoding Wasm code that uses an explicit
 // shift-reduce strategy with multiple internal stacks.
 class SR_WasmDecoder : public WasmDecoder {
  public:
-  SR_WasmDecoder(Zone* zone, TFBuilder* builder, FunctionBody& body)
+  SR_WasmDecoder(Zone* zone, TFBuilder* builder, const FunctionBody& body)
       : WasmDecoder(body.module, body.sig, body.start, body.end),
         zone_(zone),
         builder_(builder),
         base_(body.base),
         local_type_vec_(zone),
         stack_(zone),
         control_(zone) {
     local_types_ = &local_type_vec_;
   }
 
@@ skipping 1114 matching lines @@
   WasmDecoder decoder(nullptr, nullptr, pc, end);
   return decoder.OpcodeLength(pc);
 }
 
 int OpcodeArity(const byte* pc, const byte* end) {
   WasmDecoder decoder(nullptr, nullptr, pc, end);
   return decoder.OpcodeArity(pc);
 }
 
 void PrintAstForDebugging(const byte* start, const byte* end) {
-  FunctionBody body = {nullptr, nullptr, start, start, end};
   base::AccountingAllocator allocator;
-  PrintAst(&allocator, body);
+  OFStream os(stdout);
+  PrintAst(&allocator, FunctionBody::ForTesting(start, end), os);
 }
 
-void PrintAst(base::AccountingAllocator* allocator, FunctionBody& body) {
+bool PrintAst(base::AccountingAllocator* allocator, const FunctionBody& body,
+              std::ostream& os,
+              std::function<void(uint32_t)> instruction_callback) {
   Zone zone(allocator);
   SR_WasmDecoder decoder(&zone, nullptr, body);
 
-  OFStream os(stdout);
-
   // Print the function signature.
   if (body.sig) {
     os << "// signature: " << *body.sig << std::endl;
   }
 
   // Print the local declarations.
   AstLocalDecls decls(&zone);
   decoder.DecodeLocalDecls(decls);
   const byte* pc = decoder.pc();
   if (body.start != decoder.pc()) {
     os << "// locals: ";
     for (auto p : decls.local_types) {
       LocalType type = p.first;
       uint32_t count = p.second;
       os << " " << count << " " << WasmOpcodes::TypeName(type);
     }
     os << std::endl;
 
     for (const byte* locals = body.start; locals < pc; locals++) {
-      printf(" 0x%02x,", *locals);
+      os << (locals == body.start ? "0x" : " 0x") << AsHex(*locals, 2) << ",";
     }
     os << std::endl;
   }
 
   os << "// body: \n";
-  int control_depth = 0;
+  unsigned control_depth = 0;
   while (pc < body.end) {
     size_t length = decoder.OpcodeLength(pc);
 
     WasmOpcode opcode = static_cast<WasmOpcode>(*pc);
     if (opcode == kExprElse) control_depth--;
 
-    for (int i = 0; i < control_depth && i < 32; i++) printf("  ");
-    printf("k%s,", WasmOpcodes::OpcodeName(opcode));
+    // 32 whitespaces
+    const char* padding = "                                ";
+    os.write(padding, control_depth < 32 ? control_depth : 32);
+    if (instruction_callback) {
+      instruction_callback(static_cast<int>(pc - body.start));
+    }
+    os << "k" << WasmOpcodes::OpcodeName(opcode) << ",";
 
     for (size_t i = 1; i < length; i++) {
-      printf(" 0x%02x,", pc[i]);
+      os << " " << AsHex(pc[i], 2) << ",";
     }
 
     switch (opcode) {
       case kExprIf:
       case kExprElse:
       case kExprLoop:
       case kExprBlock:
         os << "   // @" << static_cast<int>(pc - body.start);
         control_depth++;
         break;
@@ skipping 49 matching lines @@
         os << "   // arity=" << operand.arity;
         break;
       }
       default:
         break;
       }
 
     pc += length;
     os << std::endl;
   }
+
+  return decoder.ok();
 }
 
 BitVector* AnalyzeLoopAssignmentForTesting(Zone* zone, size_t num_locals,
                                            const byte* start, const byte* end) {
   FunctionBody body = {nullptr, nullptr, nullptr, start, end};
   SR_WasmDecoder decoder(zone, nullptr, body);
   return decoder.AnalyzeLoopAssignmentForTesting(start, num_locals);
 }
 
 }  // namespace wasm
 }  // namespace internal
 }  // namespace v8