lib/CodeGen/MIRPrinter.cpp

   1 //===- MIRPrinter.cpp - MIR serialization format printer ------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the class that prints out the LLVM IR and machine
  11 // functions using the MIR serialization format.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "MIRPrinter.h"
  16 #include "llvm/ADT/STLExtras.h"
  17 #include "llvm/CodeGen/MachineFunction.h"
  18 #include "llvm/CodeGen/MIRYamlMapping.h"
  19 #include "llvm/IR/BasicBlock.h"
  20 #include "llvm/IR/Module.h"
  21 #include "llvm/Support/MemoryBuffer.h"
  22 #include "llvm/Support/raw_ostream.h"
  23 #include "llvm/Support/YAMLTraits.h"
  24 #include "llvm/Target/TargetInstrInfo.h"
  25 #include "llvm/Target/TargetSubtargetInfo.h"
  26
  27 using namespace llvm;
  28
  29 namespace {
  30
  31 /// This class prints out the machine functions using the MIR serialization
  32 /// format.
  33 class MIRPrinter {
  34   raw_ostream &OS;
  35
  36 public:
  37   MIRPrinter(raw_ostream &OS) : OS(OS) {}
  38
  39   void print(const MachineFunction &MF);
  40
  41   void convert(yaml::MachineBasicBlock &YamlMBB, const MachineBasicBlock &MBB);
  42 };
  43
  44 /// This class prints out the machine instructions using the MIR serialization
  45 /// format.
  46 class MIPrinter {
  47   raw_ostream &OS;
  48
  49 public:
  50   MIPrinter(raw_ostream &OS) : OS(OS) {}
  51
  52   void print(const MachineInstr &MI);
  53   void print(const MachineOperand &Op, const TargetRegisterInfo *TRI);
  54 };
  55
  56 } // end anonymous namespace
  57
  58 namespace llvm {
  59 namespace yaml {
  60
  61 /// This struct serializes the LLVM IR module.
  62 template <> struct BlockScalarTraits<Module> {
  63   static void output(const Module &Mod, void *Ctxt, raw_ostream &OS) {
  64     Mod.print(OS, nullptr);
  65   }
  66   static StringRef input(StringRef Str, void *Ctxt, Module &Mod) {
  67     llvm_unreachable("LLVM Module is supposed to be parsed separately");
  68     return "";
  69   }
  70 };
  71
  72 } // end namespace yaml
  73 } // end namespace llvm
  74
  75 void MIRPrinter::print(const MachineFunction &MF) {
  76   yaml::MachineFunction YamlMF;
  77   YamlMF.Name = MF.getName();
  78   YamlMF.Alignment = MF.getAlignment();
  79   YamlMF.ExposesReturnsTwice = MF.exposesReturnsTwice();
  80   YamlMF.HasInlineAsm = MF.hasInlineAsm();
  81   for (const auto &MBB : MF) {
  82     yaml::MachineBasicBlock YamlMBB;
  83     convert(YamlMBB, MBB);
  84     YamlMF.BasicBlocks.push_back(YamlMBB);
  85   }
  86   yaml::Output Out(OS);
  87   Out << YamlMF;
  88 }
  89
  90 void MIRPrinter::convert(yaml::MachineBasicBlock &YamlMBB,
  91                          const MachineBasicBlock &MBB) {
  92   // TODO: Serialize unnamed BB references.
  93   if (const auto *BB = MBB.getBasicBlock())
  94     YamlMBB.Name = BB->hasName() ? BB->getName() : "<unnamed bb>";
  95   else
  96     YamlMBB.Name = "";
  97   YamlMBB.Alignment = MBB.getAlignment();
  98   YamlMBB.AddressTaken = MBB.hasAddressTaken();
  99   YamlMBB.IsLandingPad = MBB.isLandingPad();
 100
 101   // Print the machine instructions.
 102   YamlMBB.Instructions.reserve(MBB.size());
 103   std::string Str;
 104   for (const auto &MI : MBB) {
 105     raw_string_ostream StrOS(Str);
 106     MIPrinter(StrOS).print(MI);
 107     YamlMBB.Instructions.push_back(StrOS.str());
 108     Str.clear();
 109   }
 110 }
 111
 112 void MIPrinter::print(const MachineInstr &MI) {
 113   const auto &SubTarget = MI.getParent()->getParent()->getSubtarget();
 114   const auto *TRI = SubTarget.getRegisterInfo();
 115   assert(TRI && "Expected target register info");
 116   const auto *TII = SubTarget.getInstrInfo();
 117   assert(TII && "Expected target instruction info");
 118
 119   unsigned I = 0, E = MI.getNumOperands();
 120   for (; I < E && MI.getOperand(I).isReg() && MI.getOperand(I).isDef() &&
 121          !MI.getOperand(I).isImplicit();
 122        ++I) {
 123     if (I)
 124       OS << ", ";
 125     print(MI.getOperand(I), TRI);
 126   }
 127
 128   if (I)
 129     OS << " = ";
 130   OS << TII->getName(MI.getOpcode());
 131   // TODO: Print the instruction flags, machine mem operands.
 132   if (I < E)
 133     OS << ' ';
 134
 135   bool NeedComma = false;
 136   for (; I < E; ++I) {
 137     if (NeedComma)
 138       OS << ", ";
 139     print(MI.getOperand(I), TRI);
 140     NeedComma = true;
 141   }
 142 }
 143
 144 static void printReg(unsigned Reg, raw_ostream &OS,
 145                      const TargetRegisterInfo *TRI) {
 146   // TODO: Print Stack Slots.
 147   // TODO: Print virtual registers.
 148   if (!Reg)
 149     OS << '_';
 150   else if (Reg < TRI->getNumRegs())
 151     OS << '%' << StringRef(TRI->getName(Reg)).lower();
 152   else
 153     llvm_unreachable("Can't print this kind of register yet");
 154 }
 155
 156 void MIPrinter::print(const MachineOperand &Op, const TargetRegisterInfo *TRI) {
 157   switch (Op.getType()) {
 158   case MachineOperand::MO_Register:
 159     // TODO: Print register flags.
 160     printReg(Op.getReg(), OS, TRI);
 161     // TODO: Print sub register.
 162     break;
 163   case MachineOperand::MO_Immediate:
 164     OS << Op.getImm();
 165     break;
 166   default:
 167     // TODO: Print the other machine operands.
 168     llvm_unreachable("Can't print this machine operand at the moment");
 169   }
 170 }
 171
 172 void llvm::printMIR(raw_ostream &OS, const Module &M) {
 173   yaml::Output Out(OS);
 174   Out << const_cast<Module &>(M);
 175 }
 176
 177 void llvm::printMIR(raw_ostream &OS, const MachineFunction &MF) {
 178   MIRPrinter Printer(OS);
 179   Printer.print(MF);
 180 }