[WebAssembly] Factor out a TypeToString function, since we need it in multiple places.
[oota-llvm.git] / lib / Target / WebAssembly / WebAssemblyAsmPrinter.cpp
index 9c5899991c7675d6c196e07d0483300ac6fde22b..1b175a7f8d5b2e3fa6907d781126580ece4898bf 100644 (file)
 //===----------------------------------------------------------------------===//
 
 #include "WebAssembly.h"
+#include "InstPrinter/WebAssemblyInstPrinter.h"
+#include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
+#include "WebAssemblyMCInstLower.h"
 #include "WebAssemblyMachineFunctionInfo.h"
 #include "WebAssemblyRegisterInfo.h"
 #include "WebAssemblySubtarget.h"
-#include "InstPrinter/WebAssemblyInstPrinter.h"
-#include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
-
 #include "llvm/ADT/SmallString.h"
+#include "llvm/ADT/StringExtras.h"
+#include "llvm/CodeGen/Analysis.h"
 #include "llvm/CodeGen/AsmPrinter.h"
 #include "llvm/CodeGen/MachineConstantPool.h"
 #include "llvm/CodeGen/MachineInstr.h"
 #include "llvm/IR/DataLayout.h"
-#include "llvm/IR/DebugInfo.h"
+#include "llvm/MC/MCContext.h"
 #include "llvm/MC/MCStreamer.h"
 #include "llvm/MC/MCSymbol.h"
 #include "llvm/Support/Debug.h"
 #include "llvm/Support/TargetRegistry.h"
 #include "llvm/Support/raw_ostream.h"
-
 using namespace llvm;
 
 #define DEBUG_TYPE "asm-printer"
@@ -40,11 +41,12 @@ using namespace llvm;
 namespace {
 
 class WebAssemblyAsmPrinter final : public AsmPrinter {
-  const WebAssemblyInstrInfo *TII;
+  const MachineRegisterInfo *MRI;
+  const WebAssemblyFunctionInfo *MFI;
 
 public:
   WebAssemblyAsmPrinter(TargetMachine &TM, std::unique_ptr<MCStreamer> Streamer)
-      : AsmPrinter(TM, std::move(Streamer)), TII(nullptr) {}
+      : AsmPrinter(TM, std::move(Streamer)), MRI(nullptr), MFI(nullptr) {}
 
 private:
   const char *getPassName() const override {
@@ -60,8 +62,8 @@ private:
   }
 
   bool runOnMachineFunction(MachineFunction &MF) override {
-    const auto &Subtarget = MF.getSubtarget<WebAssemblySubtarget>();
-    TII = Subtarget.getInstrInfo();
+    MRI = &MF.getRegInfo();
+    MFI = MF.getInfo<WebAssemblyFunctionInfo>();
     return AsmPrinter::runOnMachineFunction(MF);
   }
 
@@ -69,18 +71,21 @@ private:
   // AsmPrinter Implementation.
   //===------------------------------------------------------------------===//
 
-  void EmitGlobalVariable(const GlobalVariable *GV) override;
-
   void EmitJumpTableInfo() override;
   void EmitConstantPool() override;
-  void EmitFunctionEntryLabel() override;
   void EmitFunctionBodyStart() override;
-  void EmitFunctionBodyEnd() override;
-
   void EmitInstruction(const MachineInstr *MI) override;
-
-  static std::string toString(const APFloat &APF);
-  const char *toString(Type *Ty) const;
+  void EmitEndOfAsmFile(Module &M) override;
+  bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
+                       unsigned AsmVariant, const char *ExtraCode,
+                       raw_ostream &OS) override;
+  bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
+                             unsigned AsmVariant, const char *ExtraCode,
+                             raw_ostream &OS) override;
+
+  MVT getRegType(unsigned RegNo) const;
+  const char *toString(MVT VT) const;
+  std::string regToString(const MachineOperand &MO);
 };
 
 } // end anonymous namespace
@@ -89,142 +94,34 @@ private:
 // Helpers.
 //===----------------------------------------------------------------------===//
 
-// Untyped, lower-case version of the opcode's name matching the names
-// WebAssembly opcodes are expected to have. The tablegen names are uppercase
-// and suffixed with their type (after an underscore).
-static SmallString<32> OpcodeName(const WebAssemblyInstrInfo *TII,
-                                  const MachineInstr *MI) {
-  std::string N(StringRef(TII->getName(MI->getOpcode())).lower());
-  std::string::size_type End = N.rfind('_');
-  End = std::string::npos == End ? N.length() : End;
-  return SmallString<32>(&N[0], &N[End]);
+MVT WebAssemblyAsmPrinter::getRegType(unsigned RegNo) const {
+  const TargetRegisterClass *TRC = MRI->getRegClass(RegNo);
+  for (MVT T : {MVT::i32, MVT::i64, MVT::f32, MVT::f64})
+    if (TRC->hasType(T))
+      return T;
+  DEBUG(errs() << "Unknown type for register number: " << RegNo);
+  llvm_unreachable("Unknown register type");
+  return MVT::Other;
 }
 
-static std::string toSymbol(StringRef S) { return ("$" + S).str(); }
-
-std::string WebAssemblyAsmPrinter::toString(const APFloat &FP) {
-  static const size_t BufBytes = 128;
-  char buf[BufBytes];
-  if (FP.isNaN())
-    assert((FP.bitwiseIsEqual(APFloat::getQNaN(FP.getSemantics())) ||
-            FP.bitwiseIsEqual(
-                APFloat::getQNaN(FP.getSemantics(), /*Negative=*/true))) &&
-           "convertToHexString handles neither SNaN nor NaN payloads");
-  // Use C99's hexadecimal floating-point representation.
-  auto Written = FP.convertToHexString(
-      buf, /*hexDigits=*/0, /*upperCase=*/false, APFloat::rmNearestTiesToEven);
-  (void)Written;
-  assert(Written != 0);
-  assert(Written < BufBytes);
-  return buf;
+std::string WebAssemblyAsmPrinter::regToString(const MachineOperand &MO) {
+  unsigned RegNo = MO.getReg();
+  assert(TargetRegisterInfo::isVirtualRegister(RegNo) &&
+         "Unlowered physical register encountered during assembly printing");
+  assert(!MFI->isVRegStackified(RegNo));
+  unsigned WAReg = MFI->getWAReg(RegNo);
+  assert(WAReg != WebAssemblyFunctionInfo::UnusedReg);
+  return '$' + utostr(WAReg);
 }
 
-const char *WebAssemblyAsmPrinter::toString(Type *Ty) const {
-  switch (Ty->getTypeID()) {
-  default:
-    break;
-  // Treat all pointers as the underlying integer into linear memory.
-  case Type::PointerTyID:
-    switch (getPointerSize()) {
-    case 4:
-      return "i32";
-    case 8:
-      return "i64";
-    default:
-      llvm_unreachable("unsupported pointer size");
-    }
-    break;
-  case Type::FloatTyID:
-    return "f32";
-  case Type::DoubleTyID:
-    return "f64";
-  case Type::IntegerTyID:
-    switch (Ty->getIntegerBitWidth()) {
-    case 8:
-      return "i8";
-    case 16:
-      return "i16";
-    case 32:
-      return "i32";
-    case 64:
-      return "i64";
-    default:
-      break;
-    }
-  }
-  DEBUG(dbgs() << "Invalid type "; Ty->print(dbgs()); dbgs() << '\n');
-  llvm_unreachable("invalid type");
-  return "<invalid>";
+const char *WebAssemblyAsmPrinter::toString(MVT VT) const {
+  return WebAssembly::TypeToString(VT);
 }
 
 //===----------------------------------------------------------------------===//
 // WebAssemblyAsmPrinter Implementation.
 //===----------------------------------------------------------------------===//
 
-void WebAssemblyAsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
-  SmallString<128> Str;
-  raw_svector_ostream OS(Str);
-  StringRef Name = GV->getName();
-  DEBUG(dbgs() << "Global " << Name << '\n');
-
-  if (!GV->hasInitializer()) {
-    DEBUG(dbgs() << "  Skipping declaration.\n");
-    return;
-  }
-
-  // Check to see if this is a special global used by LLVM.
-  static const char *Ignored[] = {"llvm.used", "llvm.metadata"};
-  for (const char *I : Ignored)
-    if (Name == I)
-      return;
-  // FIXME: Handle the following globals.
-  static const char *Unhandled[] = {"llvm.global_ctors", "llvm.global_dtors"};
-  for (const char *U : Unhandled)
-    if (Name == U)
-      report_fatal_error("Unhandled global");
-  if (Name.startswith("llvm."))
-    report_fatal_error("Unknown LLVM-internal global");
-
-  if (GV->isThreadLocal())
-    report_fatal_error("TLS isn't yet supported by WebAssembly");
-
-  const DataLayout &DL = getDataLayout();
-  const Constant *Init = GV->getInitializer();
-  if (isa<UndefValue>(Init))
-    Init = Constant::getNullValue(Init->getType());
-  unsigned Align = DL.getPrefTypeAlignment(Init->getType());
-
-  switch (GV->getLinkage()) {
-  case GlobalValue::InternalLinkage:
-  case GlobalValue::PrivateLinkage:
-    break;
-  case GlobalValue::AppendingLinkage:
-  case GlobalValue::LinkOnceAnyLinkage:
-  case GlobalValue::LinkOnceODRLinkage:
-  case GlobalValue::WeakAnyLinkage:
-  case GlobalValue::WeakODRLinkage:
-  case GlobalValue::ExternalLinkage:
-  case GlobalValue::CommonLinkage:
-    report_fatal_error("Linkage types other than internal and private aren't "
-                       "supported by WebAssembly yet");
-  default:
-    llvm_unreachable("Unknown linkage type");
-    return;
-  }
-
-  OS << "(global " << toSymbol(Name) << ' ' << toString(Init->getType()) << ' ';
-  if (const auto *C = dyn_cast<ConstantInt>(Init)) {
-    assert(C->getBitWidth() <= 64 && "Printing wider types unimplemented");
-    OS << C->getZExtValue();
-  } else if (const auto *C = dyn_cast<ConstantFP>(Init)) {
-    OS << toString(C->getValueAPF());
-  } else {
-    assert(false && "Only integer and floating-point constants are supported");
-  }
-  OS << ") ;; align " << Align;
-  OutStreamer->EmitRawText(OS.str());
-}
-
 void WebAssemblyAsmPrinter::EmitConstantPool() {
   assert(MF->getConstantPool()->getConstants().empty() &&
          "WebAssembly disables constant pools");
@@ -234,97 +131,182 @@ void WebAssemblyAsmPrinter::EmitJumpTableInfo() {
   // Nothing to do; jump tables are incorporated into the instruction stream.
 }
 
-void WebAssemblyAsmPrinter::EmitFunctionEntryLabel() {
-  SmallString<128> Str;
-  raw_svector_ostream OS(Str);
-
-  CurrentFnSym->redefineIfPossible();
-
-  // The function label could have already been emitted if two symbols end up
-  // conflicting due to asm renaming.  Detect this and emit an error.
-  if (CurrentFnSym->isVariable())
-    report_fatal_error("'" + Twine(CurrentFnSym->getName()) +
-                       "' is a protected alias");
-  if (CurrentFnSym->isDefined())
-    report_fatal_error("'" + Twine(CurrentFnSym->getName()) +
-                       "' label emitted multiple times to assembly file");
-
-  OS << "(func " << toSymbol(CurrentFnSym->getName());
-  OutStreamer->EmitRawText(OS.str());
+static void ComputeLegalValueVTs(const Function &F, const TargetMachine &TM,
+                                 Type *Ty, SmallVectorImpl<MVT> &ValueVTs) {
+  const DataLayout &DL(F.getParent()->getDataLayout());
+  const WebAssemblyTargetLowering &TLI =
+      *TM.getSubtarget<WebAssemblySubtarget>(F).getTargetLowering();
+  SmallVector<EVT, 4> VTs;
+  ComputeValueVTs(TLI, DL, Ty, VTs);
+
+  for (EVT VT : VTs) {
+    unsigned NumRegs = TLI.getNumRegisters(F.getContext(), VT);
+    MVT RegisterVT = TLI.getRegisterType(F.getContext(), VT);
+    for (unsigned i = 0; i != NumRegs; ++i)
+      ValueVTs.push_back(RegisterVT);
+  }
 }
 
 void WebAssemblyAsmPrinter::EmitFunctionBodyStart() {
-  SmallString<128> Str;
-  raw_svector_ostream OS(Str);
-  const Function *F = MF->getFunction();
-  Type *Rt = F->getReturnType();
-  if (!Rt->isVoidTy() || !F->arg_empty()) {
-    for (const Argument &A : F->args())
-      OS << " (param " << toString(A.getType()) << ')';
-    if (!Rt->isVoidTy())
-      OS << " (result " << toString(Rt) << ')';
-    OutStreamer->EmitRawText(OS.str());
+  if (!MFI->getParams().empty()) {
+    MCInst Param;
+    Param.setOpcode(WebAssembly::PARAM);
+    for (MVT VT : MFI->getParams())
+      Param.addOperand(MCOperand::createImm(VT.SimpleTy));
+    EmitToStreamer(*OutStreamer, Param);
   }
-}
 
-void WebAssemblyAsmPrinter::EmitFunctionBodyEnd() {
-  SmallString<128> Str;
-  raw_svector_ostream OS(Str);
-  OS << ") ;; end func " << toSymbol(CurrentFnSym->getName());
-  OutStreamer->EmitRawText(OS.str());
+  SmallVector<MVT, 4> ResultVTs;
+  const Function &F(*MF->getFunction());
+  ComputeLegalValueVTs(F, TM, F.getReturnType(), ResultVTs);
+  // If the return type needs to be legalized it will get converted into
+  // passing a pointer.
+  if (ResultVTs.size() == 1) {
+    MCInst Result;
+    Result.setOpcode(WebAssembly::RESULT);
+    Result.addOperand(MCOperand::createImm(ResultVTs.front().SimpleTy));
+    EmitToStreamer(*OutStreamer, Result);
+  }
+
+  bool AnyWARegs = false;
+  MCInst Local;
+  Local.setOpcode(WebAssembly::LOCAL);
+  for (unsigned Idx = 0, IdxE = MRI->getNumVirtRegs(); Idx != IdxE; ++Idx) {
+    unsigned VReg = TargetRegisterInfo::index2VirtReg(Idx);
+    unsigned WAReg = MFI->getWAReg(VReg);
+    // Don't declare unused registers.
+    if (WAReg == WebAssemblyFunctionInfo::UnusedReg)
+      continue;
+    // Don't redeclare parameters.
+    if (WAReg < MFI->getParams().size())
+      continue;
+    // Don't declare stackified registers.
+    if (int(WAReg) < 0)
+      continue;
+    Local.addOperand(MCOperand::createImm(getRegType(VReg).SimpleTy));
+    AnyWARegs = true;
+  }
+  if (AnyWARegs)
+    EmitToStreamer(*OutStreamer, Local);
+
+  AsmPrinter::EmitFunctionBodyStart();
 }
 
 void WebAssemblyAsmPrinter::EmitInstruction(const MachineInstr *MI) {
   DEBUG(dbgs() << "EmitInstruction: " << *MI << '\n');
+
+  switch (MI->getOpcode()) {
+  case WebAssembly::ARGUMENT_I32:
+  case WebAssembly::ARGUMENT_I64:
+  case WebAssembly::ARGUMENT_F32:
+  case WebAssembly::ARGUMENT_F64:
+    // These represent values which are live into the function entry, so there's
+    // no instruction to emit.
+    break;
+  case WebAssembly::LOOP_END:
+    // This is a no-op which just exists to tell AsmPrinter.cpp that there's a
+    // fallthrough which nevertheless requires a label for the destination here.
+    break;
+  default: {
+    WebAssemblyMCInstLower MCInstLowering(OutContext, *this);
+    MCInst TmpInst;
+    MCInstLowering.Lower(MI, TmpInst);
+    EmitToStreamer(*OutStreamer, TmpInst);
+    break;
+  }
+  }
+}
+
+void WebAssemblyAsmPrinter::EmitEndOfAsmFile(Module &M) {
+  const DataLayout &DL = M.getDataLayout();
+
   SmallString<128> Str;
   raw_svector_ostream OS(Str);
+  for (const Function &F : M)
+    if (F.isDeclarationForLinker()) {
+      assert(F.hasName() && "imported functions must have a name");
+      if (F.isIntrinsic())
+        continue;
+      if (Str.empty())
+        OS << "\t.imports\n";
+
+      MCSymbol *Sym = OutStreamer->getContext().getOrCreateSymbol(F.getName());
+      OS << "\t.import " << *Sym << " \"\" " << *Sym;
+
+      const WebAssemblyTargetLowering &TLI =
+          *TM.getSubtarget<WebAssemblySubtarget>(F).getTargetLowering();
+
+      // If we need to legalize the return type, it'll get converted into
+      // passing a pointer.
+      bool SawParam = false;
+      SmallVector<MVT, 4> ResultVTs;
+      ComputeLegalValueVTs(F, TM, F.getReturnType(), ResultVTs);
+      if (ResultVTs.size() > 1) {
+        ResultVTs.clear();
+        OS << " (param " << toString(TLI.getPointerTy(DL));
+        SawParam = true;
+      }
 
-  unsigned NumDefs = MI->getDesc().getNumDefs();
-  assert(NumDefs <= 1 &&
-         "Instructions with multiple result values not implemented");
+      for (const Argument &A : F.args()) {
+        SmallVector<MVT, 4> ParamVTs;
+        ComputeLegalValueVTs(F, TM, A.getType(), ParamVTs);
+        for (MVT VT : ParamVTs) {
+          if (!SawParam) {
+            OS << " (param";
+            SawParam = true;
+          }
+          OS << ' ' << toString(VT);
+        }
+      }
+      if (SawParam)
+        OS << ')';
 
-  OS << '\t';
+      for (MVT VT : ResultVTs)
+        OS << " (result " << toString(VT) << ')';
 
-  if (NumDefs != 0) {
-    const MachineOperand &MO = MI->getOperand(0);
-    unsigned Reg = MO.getReg();
-    OS << "(setlocal @" << TargetRegisterInfo::virtReg2Index(Reg) << ' ';
-  }
+      OS << '\n';
+    }
 
-  if (MI->getOpcode() == WebAssembly::COPY) {
-    OS << '@' << TargetRegisterInfo::virtReg2Index(MI->getOperand(1).getReg());
-  } else {
-    OS << '(' << OpcodeName(TII, MI);
-    for (const MachineOperand &MO : MI->uses())
-      switch (MO.getType()) {
-      default:
-        llvm_unreachable("unexpected machine operand type");
-      case MachineOperand::MO_Register: {
-        if (MO.isImplicit())
-          continue;
-        unsigned Reg = MO.getReg();
-        OS << " @" << TargetRegisterInfo::virtReg2Index(Reg);
-      } break;
-      case MachineOperand::MO_Immediate: {
-        OS << ' ' << MO.getImm();
-      } break;
-      case MachineOperand::MO_FPImmediate: {
-        OS << ' ' << toString(MO.getFPImm()->getValueAPF());
-      } break;
-      case MachineOperand::MO_GlobalAddress: {
-        OS << ' ' << toSymbol(MO.getGlobal()->getName());
-      } break;
-      case MachineOperand::MO_MachineBasicBlock: {
-        OS << ' ' << toSymbol(MO.getMBB()->getSymbol()->getName());
-      } break;
-      }
-    OS << ')';
+  StringRef Text = OS.str();
+  if (!Text.empty())
+    OutStreamer->EmitRawText(Text.substr(0, Text.size() - 1));
+
+  AsmPrinter::EmitEndOfAsmFile(M);
+}
+
+bool WebAssemblyAsmPrinter::PrintAsmOperand(const MachineInstr *MI,
+                                            unsigned OpNo, unsigned AsmVariant,
+                                            const char *ExtraCode,
+                                            raw_ostream &OS) {
+  if (AsmVariant != 0)
+    report_fatal_error("There are no defined alternate asm variants");
+
+  if (!ExtraCode) {
+    const MachineOperand &MO = MI->getOperand(OpNo);
+    if (MO.isImm())
+      OS << MO.getImm();
+    else
+      OS << regToString(MO);
+    return false;
   }
 
-  if (NumDefs != 0)
-    OS << ')';
+  return AsmPrinter::PrintAsmOperand(MI, OpNo, AsmVariant, ExtraCode, OS);
+}
+
+bool WebAssemblyAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
+                                                  unsigned OpNo,
+                                                  unsigned AsmVariant,
+                                                  const char *ExtraCode,
+                                                  raw_ostream &OS) {
+  if (AsmVariant != 0)
+    report_fatal_error("There are no defined alternate asm variants");
+
+  if (!ExtraCode) {
+    OS << regToString(MI->getOperand(OpNo));
+    return false;
+  }
 
-  OutStreamer->EmitRawText(OS.str());
+  return AsmPrinter::PrintAsmMemoryOperand(MI, OpNo, AsmVariant, ExtraCode, OS);
 }
 
 // Force static initialization.