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/MachineConstantPool.h"
  18 #include "llvm/CodeGen/MachineFunction.h"
  19 #include "llvm/CodeGen/MachineFrameInfo.h"
  20 #include "llvm/CodeGen/MachineMemOperand.h"
  21 #include "llvm/CodeGen/MachineModuleInfo.h"
  22 #include "llvm/CodeGen/MachineRegisterInfo.h"
  23 #include "llvm/CodeGen/MIRYamlMapping.h"
  24 #include "llvm/IR/BasicBlock.h"
  25 #include "llvm/IR/Constants.h"
  26 #include "llvm/IR/Instructions.h"
  27 #include "llvm/IR/IRPrintingPasses.h"
  28 #include "llvm/IR/Module.h"
  29 #include "llvm/IR/ModuleSlotTracker.h"
  30 #include "llvm/Support/MemoryBuffer.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include "llvm/Support/YAMLTraits.h"
  33 #include "llvm/Target/TargetInstrInfo.h"
  34 #include "llvm/Target/TargetSubtargetInfo.h"
  35
  36 using namespace llvm;
  37
  38 namespace {
  39
  40 /// This structure describes how to print out stack object references.
  41 struct FrameIndexOperand {
  42   std::string Name;
  43   unsigned ID;
  44   bool IsFixed;
  45
  46   FrameIndexOperand(StringRef Name, unsigned ID, bool IsFixed)
  47       : Name(Name.str()), ID(ID), IsFixed(IsFixed) {}
  48
  49   /// Return an ordinary stack object reference.
  50   static FrameIndexOperand create(StringRef Name, unsigned ID) {
  51     return FrameIndexOperand(Name, ID, /*IsFixed=*/false);
  52   }
  53
  54   /// Return a fixed stack object reference.
  55   static FrameIndexOperand createFixed(unsigned ID) {
  56     return FrameIndexOperand("", ID, /*IsFixed=*/true);
  57   }
  58 };
  59
  60 } // end anonymous namespace
  61
  62 namespace llvm {
  63
  64 /// This class prints out the machine functions using the MIR serialization
  65 /// format.
  66 class MIRPrinter {
  67   raw_ostream &OS;
  68   DenseMap<const uint32_t *, unsigned> RegisterMaskIds;
  69   /// Maps from stack object indices to operand indices which will be used when
  70   /// printing frame index machine operands.
  71   DenseMap<int, FrameIndexOperand> StackObjectOperandMapping;
  72
  73 public:
  74   MIRPrinter(raw_ostream &OS) : OS(OS) {}
  75
  76   void print(const MachineFunction &MF);
  77
  78   void convert(yaml::MachineFunction &MF, const MachineRegisterInfo &RegInfo,
  79                const TargetRegisterInfo *TRI);
  80   void convert(ModuleSlotTracker &MST, yaml::MachineFrameInfo &YamlMFI,
  81                const MachineFrameInfo &MFI);
  82   void convert(yaml::MachineFunction &MF,
  83                const MachineConstantPool &ConstantPool);
  84   void convert(ModuleSlotTracker &MST, yaml::MachineJumpTable &YamlJTI,
  85                const MachineJumpTableInfo &JTI);
  86   void convertStackObjects(yaml::MachineFunction &MF,
  87                            const MachineFrameInfo &MFI, MachineModuleInfo &MMI,
  88                            ModuleSlotTracker &MST,
  89                            const TargetRegisterInfo *TRI);
  90
  91 private:
  92   void initRegisterMaskIds(const MachineFunction &MF);
  93 };
  94
  95 /// This class prints out the machine instructions using the MIR serialization
  96 /// format.
  97 class MIPrinter {
  98   raw_ostream &OS;
  99   ModuleSlotTracker &MST;
 100   const DenseMap<const uint32_t *, unsigned> &RegisterMaskIds;
 101   const DenseMap<int, FrameIndexOperand> &StackObjectOperandMapping;
 102
 103 public:
 104   MIPrinter(raw_ostream &OS, ModuleSlotTracker &MST,
 105             const DenseMap<const uint32_t *, unsigned> &RegisterMaskIds,
 106             const DenseMap<int, FrameIndexOperand> &StackObjectOperandMapping)
 107       : OS(OS), MST(MST), RegisterMaskIds(RegisterMaskIds),
 108         StackObjectOperandMapping(StackObjectOperandMapping) {}
 109
 110   void print(const MachineBasicBlock &MBB);
 111
 112   void print(const MachineInstr &MI);
 113   void printMBBReference(const MachineBasicBlock &MBB);
 114   void printIRBlockReference(const BasicBlock &BB);
 115   void printIRValueReference(const Value &V);
 116   void printStackObjectReference(int FrameIndex);
 117   void printOffset(int64_t Offset);
 118   void printTargetFlags(const MachineOperand &Op);
 119   void print(const MachineOperand &Op, const TargetRegisterInfo *TRI,
 120              bool IsDef = false);
 121   void print(const MachineMemOperand &Op);
 122
 123   void print(const MCCFIInstruction &CFI, const TargetRegisterInfo *TRI);
 124 };
 125
 126 } // end namespace llvm
 127
 128 namespace llvm {
 129 namespace yaml {
 130
 131 /// This struct serializes the LLVM IR module.
 132 template <> struct BlockScalarTraits<Module> {
 133   static void output(const Module &Mod, void *Ctxt, raw_ostream &OS) {
 134     Mod.print(OS, nullptr);
 135   }
 136   static StringRef input(StringRef Str, void *Ctxt, Module &Mod) {
 137     llvm_unreachable("LLVM Module is supposed to be parsed separately");
 138     return "";
 139   }
 140 };
 141
 142 } // end namespace yaml
 143 } // end namespace llvm
 144
 145 static void printReg(unsigned Reg, raw_ostream &OS,
 146                      const TargetRegisterInfo *TRI) {
 147   // TODO: Print Stack Slots.
 148   if (!Reg)
 149     OS << '_';
 150   else if (TargetRegisterInfo::isVirtualRegister(Reg))
 151     OS << '%' << TargetRegisterInfo::virtReg2Index(Reg);
 152   else if (Reg < TRI->getNumRegs())
 153     OS << '%' << StringRef(TRI->getName(Reg)).lower();
 154   else
 155     llvm_unreachable("Can't print this kind of register yet");
 156 }
 157
 158 static void printReg(unsigned Reg, yaml::StringValue &Dest,
 159                      const TargetRegisterInfo *TRI) {
 160   raw_string_ostream OS(Dest.Value);
 161   printReg(Reg, OS, TRI);
 162 }
 163
 164 void MIRPrinter::print(const MachineFunction &MF) {
 165   initRegisterMaskIds(MF);
 166
 167   yaml::MachineFunction YamlMF;
 168   YamlMF.Name = MF.getName();
 169   YamlMF.Alignment = MF.getAlignment();
 170   YamlMF.ExposesReturnsTwice = MF.exposesReturnsTwice();
 171   YamlMF.HasInlineAsm = MF.hasInlineAsm();
 172   convert(YamlMF, MF.getRegInfo(), MF.getSubtarget().getRegisterInfo());
 173   ModuleSlotTracker MST(MF.getFunction()->getParent());
 174   MST.incorporateFunction(*MF.getFunction());
 175   convert(MST, YamlMF.FrameInfo, *MF.getFrameInfo());
 176   convertStackObjects(YamlMF, *MF.getFrameInfo(), MF.getMMI(), MST,
 177                       MF.getSubtarget().getRegisterInfo());
 178   if (const auto *ConstantPool = MF.getConstantPool())
 179     convert(YamlMF, *ConstantPool);
 180   if (const auto *JumpTableInfo = MF.getJumpTableInfo())
 181     convert(MST, YamlMF.JumpTableInfo, *JumpTableInfo);
 182   raw_string_ostream StrOS(YamlMF.Body.Value.Value);
 183   bool IsNewlineNeeded = false;
 184   for (const auto &MBB : MF) {
 185     if (IsNewlineNeeded)
 186       StrOS << "\n";
 187     MIPrinter(StrOS, MST, RegisterMaskIds, StackObjectOperandMapping)
 188         .print(MBB);
 189     IsNewlineNeeded = true;
 190   }
 191   StrOS.flush();
 192   yaml::Output Out(OS);
 193   Out << YamlMF;
 194 }
 195
 196 void MIRPrinter::convert(yaml::MachineFunction &MF,
 197                          const MachineRegisterInfo &RegInfo,
 198                          const TargetRegisterInfo *TRI) {
 199   MF.IsSSA = RegInfo.isSSA();
 200   MF.TracksRegLiveness = RegInfo.tracksLiveness();
 201   MF.TracksSubRegLiveness = RegInfo.subRegLivenessEnabled();
 202
 203   // Print the virtual register definitions.
 204   for (unsigned I = 0, E = RegInfo.getNumVirtRegs(); I < E; ++I) {
 205     unsigned Reg = TargetRegisterInfo::index2VirtReg(I);
 206     yaml::VirtualRegisterDefinition VReg;
 207     VReg.ID = I;
 208     VReg.Class =
 209         StringRef(TRI->getRegClassName(RegInfo.getRegClass(Reg))).lower();
 210     unsigned PreferredReg = RegInfo.getSimpleHint(Reg);
 211     if (PreferredReg)
 212       printReg(PreferredReg, VReg.PreferredRegister, TRI);
 213     MF.VirtualRegisters.push_back(VReg);
 214   }
 215
 216   // Print the live ins.
 217   for (auto I = RegInfo.livein_begin(), E = RegInfo.livein_end(); I != E; ++I) {
 218     yaml::MachineFunctionLiveIn LiveIn;
 219     printReg(I->first, LiveIn.Register, TRI);
 220     if (I->second)
 221       printReg(I->second, LiveIn.VirtualRegister, TRI);
 222     MF.LiveIns.push_back(LiveIn);
 223   }
 224   // The used physical register mask is printed as an inverted callee saved
 225   // register mask.
 226   const BitVector &UsedPhysRegMask = RegInfo.getUsedPhysRegsMask();
 227   if (UsedPhysRegMask.none())
 228     return;
 229   std::vector<yaml::FlowStringValue> CalleeSavedRegisters;
 230   for (unsigned I = 0, E = UsedPhysRegMask.size(); I != E; ++I) {
 231     if (!UsedPhysRegMask[I]) {
 232       yaml::FlowStringValue Reg;
 233       printReg(I, Reg, TRI);
 234       CalleeSavedRegisters.push_back(Reg);
 235     }
 236   }
 237   MF.CalleeSavedRegisters = CalleeSavedRegisters;
 238 }
 239
 240 void MIRPrinter::convert(ModuleSlotTracker &MST,
 241                          yaml::MachineFrameInfo &YamlMFI,
 242                          const MachineFrameInfo &MFI) {
 243   YamlMFI.IsFrameAddressTaken = MFI.isFrameAddressTaken();
 244   YamlMFI.IsReturnAddressTaken = MFI.isReturnAddressTaken();
 245   YamlMFI.HasStackMap = MFI.hasStackMap();
 246   YamlMFI.HasPatchPoint = MFI.hasPatchPoint();
 247   YamlMFI.StackSize = MFI.getStackSize();
 248   YamlMFI.OffsetAdjustment = MFI.getOffsetAdjustment();
 249   YamlMFI.MaxAlignment = MFI.getMaxAlignment();
 250   YamlMFI.AdjustsStack = MFI.adjustsStack();
 251   YamlMFI.HasCalls = MFI.hasCalls();
 252   YamlMFI.MaxCallFrameSize = MFI.getMaxCallFrameSize();
 253   YamlMFI.HasOpaqueSPAdjustment = MFI.hasOpaqueSPAdjustment();
 254   YamlMFI.HasVAStart = MFI.hasVAStart();
 255   YamlMFI.HasMustTailInVarArgFunc = MFI.hasMustTailInVarArgFunc();
 256   if (MFI.getSavePoint()) {
 257     raw_string_ostream StrOS(YamlMFI.SavePoint.Value);
 258     MIPrinter(StrOS, MST, RegisterMaskIds, StackObjectOperandMapping)
 259         .printMBBReference(*MFI.getSavePoint());
 260   }
 261   if (MFI.getRestorePoint()) {
 262     raw_string_ostream StrOS(YamlMFI.RestorePoint.Value);
 263     MIPrinter(StrOS, MST, RegisterMaskIds, StackObjectOperandMapping)
 264         .printMBBReference(*MFI.getRestorePoint());
 265   }
 266 }
 267
 268 void MIRPrinter::convertStackObjects(yaml::MachineFunction &MF,
 269                                      const MachineFrameInfo &MFI,
 270                                      MachineModuleInfo &MMI,
 271                                      ModuleSlotTracker &MST,
 272                                      const TargetRegisterInfo *TRI) {
 273   // Process fixed stack objects.
 274   unsigned ID = 0;
 275   for (int I = MFI.getObjectIndexBegin(); I < 0; ++I) {
 276     if (MFI.isDeadObjectIndex(I))
 277       continue;
 278
 279     yaml::FixedMachineStackObject YamlObject;
 280     YamlObject.ID = ID;
 281     YamlObject.Type = MFI.isSpillSlotObjectIndex(I)
 282                           ? yaml::FixedMachineStackObject::SpillSlot
 283                           : yaml::FixedMachineStackObject::DefaultType;
 284     YamlObject.Offset = MFI.getObjectOffset(I);
 285     YamlObject.Size = MFI.getObjectSize(I);
 286     YamlObject.Alignment = MFI.getObjectAlignment(I);
 287     YamlObject.IsImmutable = MFI.isImmutableObjectIndex(I);
 288     YamlObject.IsAliased = MFI.isAliasedObjectIndex(I);
 289     MF.FixedStackObjects.push_back(YamlObject);
 290     StackObjectOperandMapping.insert(
 291         std::make_pair(I, FrameIndexOperand::createFixed(ID++)));
 292   }
 293
 294   // Process ordinary stack objects.
 295   ID = 0;
 296   for (int I = 0, E = MFI.getObjectIndexEnd(); I < E; ++I) {
 297     if (MFI.isDeadObjectIndex(I))
 298       continue;
 299
 300     yaml::MachineStackObject YamlObject;
 301     YamlObject.ID = ID;
 302     if (const auto *Alloca = MFI.getObjectAllocation(I))
 303       YamlObject.Name.Value =
 304           Alloca->hasName() ? Alloca->getName() : "<unnamed alloca>";
 305     YamlObject.Type = MFI.isSpillSlotObjectIndex(I)
 306                           ? yaml::MachineStackObject::SpillSlot
 307                           : MFI.isVariableSizedObjectIndex(I)
 308                                 ? yaml::MachineStackObject::VariableSized
 309                                 : yaml::MachineStackObject::DefaultType;
 310     YamlObject.Offset = MFI.getObjectOffset(I);
 311     YamlObject.Size = MFI.getObjectSize(I);
 312     YamlObject.Alignment = MFI.getObjectAlignment(I);
 313
 314     MF.StackObjects.push_back(YamlObject);
 315     StackObjectOperandMapping.insert(std::make_pair(
 316         I, FrameIndexOperand::create(YamlObject.Name.Value, ID++)));
 317   }
 318
 319   for (const auto &CSInfo : MFI.getCalleeSavedInfo()) {
 320     yaml::StringValue Reg;
 321     printReg(CSInfo.getReg(), Reg, TRI);
 322     auto StackObjectInfo = StackObjectOperandMapping.find(CSInfo.getFrameIdx());
 323     assert(StackObjectInfo != StackObjectOperandMapping.end() &&
 324            "Invalid stack object index");
 325     const FrameIndexOperand &StackObject = StackObjectInfo->second;
 326     if (StackObject.IsFixed)
 327       MF.FixedStackObjects[StackObject.ID].CalleeSavedRegister = Reg;
 328     else
 329       MF.StackObjects[StackObject.ID].CalleeSavedRegister = Reg;
 330   }
 331   for (unsigned I = 0, E = MFI.getLocalFrameObjectCount(); I < E; ++I) {
 332     auto LocalObject = MFI.getLocalFrameObjectMap(I);
 333     auto StackObjectInfo = StackObjectOperandMapping.find(LocalObject.first);
 334     assert(StackObjectInfo != StackObjectOperandMapping.end() &&
 335            "Invalid stack object index");
 336     const FrameIndexOperand &StackObject = StackObjectInfo->second;
 337     assert(!StackObject.IsFixed && "Expected a locally mapped stack object");
 338     MF.StackObjects[StackObject.ID].LocalOffset = LocalObject.second;
 339   }
 340
 341   // Print the stack object references in the frame information class after
 342   // converting the stack objects.
 343   if (MFI.hasStackProtectorIndex()) {
 344     raw_string_ostream StrOS(MF.FrameInfo.StackProtector.Value);
 345     MIPrinter(StrOS, MST, RegisterMaskIds, StackObjectOperandMapping)
 346         .printStackObjectReference(MFI.getStackProtectorIndex());
 347   }
 348
 349   // Print the debug variable information.
 350   for (MachineModuleInfo::VariableDbgInfo &DebugVar :
 351        MMI.getVariableDbgInfo()) {
 352     auto StackObjectInfo = StackObjectOperandMapping.find(DebugVar.Slot);
 353     assert(StackObjectInfo != StackObjectOperandMapping.end() &&
 354            "Invalid stack object index");
 355     const FrameIndexOperand &StackObject = StackObjectInfo->second;
 356     assert(!StackObject.IsFixed && "Expected a non-fixed stack object");
 357     auto &Object = MF.StackObjects[StackObject.ID];
 358     {
 359       raw_string_ostream StrOS(Object.DebugVar.Value);
 360       DebugVar.Var->printAsOperand(StrOS, MST);
 361     }
 362     {
 363       raw_string_ostream StrOS(Object.DebugExpr.Value);
 364       DebugVar.Expr->printAsOperand(StrOS, MST);
 365     }
 366     {
 367       raw_string_ostream StrOS(Object.DebugLoc.Value);
 368       DebugVar.Loc->printAsOperand(StrOS, MST);
 369     }
 370   }
 371 }
 372
 373 void MIRPrinter::convert(yaml::MachineFunction &MF,
 374                          const MachineConstantPool &ConstantPool) {
 375   unsigned ID = 0;
 376   for (const MachineConstantPoolEntry &Constant : ConstantPool.getConstants()) {
 377     // TODO: Serialize target specific constant pool entries.
 378     if (Constant.isMachineConstantPoolEntry())
 379       llvm_unreachable("Can't print target specific constant pool entries yet");
 380
 381     yaml::MachineConstantPoolValue YamlConstant;
 382     std::string Str;
 383     raw_string_ostream StrOS(Str);
 384     Constant.Val.ConstVal->printAsOperand(StrOS);
 385     YamlConstant.ID = ID++;
 386     YamlConstant.Value = StrOS.str();
 387     YamlConstant.Alignment = Constant.getAlignment();
 388     MF.Constants.push_back(YamlConstant);
 389   }
 390 }
 391
 392 void MIRPrinter::convert(ModuleSlotTracker &MST,
 393                          yaml::MachineJumpTable &YamlJTI,
 394                          const MachineJumpTableInfo &JTI) {
 395   YamlJTI.Kind = JTI.getEntryKind();
 396   unsigned ID = 0;
 397   for (const auto &Table : JTI.getJumpTables()) {
 398     std::string Str;
 399     yaml::MachineJumpTable::Entry Entry;
 400     Entry.ID = ID++;
 401     for (const auto *MBB : Table.MBBs) {
 402       raw_string_ostream StrOS(Str);
 403       MIPrinter(StrOS, MST, RegisterMaskIds, StackObjectOperandMapping)
 404           .printMBBReference(*MBB);
 405       Entry.Blocks.push_back(StrOS.str());
 406       Str.clear();
 407     }
 408     YamlJTI.Entries.push_back(Entry);
 409   }
 410 }
 411
 412 void MIRPrinter::initRegisterMaskIds(const MachineFunction &MF) {
 413   const auto *TRI = MF.getSubtarget().getRegisterInfo();
 414   unsigned I = 0;
 415   for (const uint32_t *Mask : TRI->getRegMasks())
 416     RegisterMaskIds.insert(std::make_pair(Mask, I++));
 417 }
 418
 419 void MIPrinter::print(const MachineBasicBlock &MBB) {
 420   assert(MBB.getNumber() >= 0 && "Invalid MBB number");
 421   OS << "bb." << MBB.getNumber();
 422   bool HasAttributes = false;
 423   if (const auto *BB = MBB.getBasicBlock()) {
 424     if (BB->hasName()) {
 425       OS << "." << BB->getName();
 426     } else {
 427       HasAttributes = true;
 428       OS << " (";
 429       int Slot = MST.getLocalSlot(BB);
 430       if (Slot == -1)
 431         OS << "<ir-block badref>";
 432       else
 433         OS << (Twine("%ir-block.") + Twine(Slot)).str();
 434     }
 435   }
 436   if (MBB.hasAddressTaken()) {
 437     OS << (HasAttributes ? ", " : " (");
 438     OS << "address-taken";
 439     HasAttributes = true;
 440   }
 441   if (MBB.isLandingPad()) {
 442     OS << (HasAttributes ? ", " : " (");
 443     OS << "landing-pad";
 444     HasAttributes = true;
 445   }
 446   if (MBB.getAlignment()) {
 447     OS << (HasAttributes ? ", " : " (");
 448     OS << "align " << MBB.getAlignment();
 449     HasAttributes = true;
 450   }
 451   if (HasAttributes)
 452     OS << ")";
 453   OS << ":\n";
 454
 455   bool HasLineAttributes = false;
 456   // Print the successors
 457   if (!MBB.succ_empty()) {
 458     OS.indent(2) << "successors: ";
 459     for (auto I = MBB.succ_begin(), E = MBB.succ_end(); I != E; ++I) {
 460       if (I != MBB.succ_begin())
 461         OS << ", ";
 462       printMBBReference(**I);
 463       if (MBB.hasSuccessorWeights())
 464         OS << '(' << MBB.getSuccWeight(I) << ')';
 465     }
 466     OS << "\n";
 467     HasLineAttributes = true;
 468   }
 469
 470   // Print the live in registers.
 471   const auto *TRI = MBB.getParent()->getSubtarget().getRegisterInfo();
 472   assert(TRI && "Expected target register info");
 473   if (!MBB.livein_empty()) {
 474     OS.indent(2) << "liveins: ";
 475     for (auto I = MBB.livein_begin(), E = MBB.livein_end(); I != E; ++I) {
 476       if (I != MBB.livein_begin())
 477         OS << ", ";
 478       printReg(*I, OS, TRI);
 479     }
 480     OS << "\n";
 481     HasLineAttributes = true;
 482   }
 483
 484   if (HasLineAttributes)
 485     OS << "\n";
 486   bool IsInBundle = false;
 487   for (auto I = MBB.instr_begin(), E = MBB.instr_end(); I != E; ++I) {
 488     const MachineInstr &MI = *I;
 489     if (IsInBundle && !MI.isInsideBundle()) {
 490       OS.indent(2) << "}\n";
 491       IsInBundle = false;
 492     }
 493     OS.indent(IsInBundle ? 4 : 2);
 494     print(MI);
 495     if (!IsInBundle && MI.getFlag(MachineInstr::BundledSucc)) {
 496       OS << " {";
 497       IsInBundle = true;
 498     }
 499     OS << "\n";
 500   }
 501   if (IsInBundle)
 502     OS.indent(2) << "}\n";
 503 }
 504
 505 void MIPrinter::print(const MachineInstr &MI) {
 506   const auto &SubTarget = MI.getParent()->getParent()->getSubtarget();
 507   const auto *TRI = SubTarget.getRegisterInfo();
 508   assert(TRI && "Expected target register info");
 509   const auto *TII = SubTarget.getInstrInfo();
 510   assert(TII && "Expected target instruction info");
 511   if (MI.isCFIInstruction())
 512     assert(MI.getNumOperands() == 1 && "Expected 1 operand in CFI instruction");
 513
 514   unsigned I = 0, E = MI.getNumOperands();
 515   for (; I < E && MI.getOperand(I).isReg() && MI.getOperand(I).isDef() &&
 516          !MI.getOperand(I).isImplicit();
 517        ++I) {
 518     if (I)
 519       OS << ", ";
 520     print(MI.getOperand(I), TRI, /*IsDef=*/true);
 521   }
 522
 523   if (I)
 524     OS << " = ";
 525   if (MI.getFlag(MachineInstr::FrameSetup))
 526     OS << "frame-setup ";
 527   OS << TII->getName(MI.getOpcode());
 528   if (I < E)
 529     OS << ' ';
 530
 531   bool NeedComma = false;
 532   for (; I < E; ++I) {
 533     if (NeedComma)
 534       OS << ", ";
 535     print(MI.getOperand(I), TRI);
 536     NeedComma = true;
 537   }
 538
 539   if (MI.getDebugLoc()) {
 540     if (NeedComma)
 541       OS << ',';
 542     OS << " debug-location ";
 543     MI.getDebugLoc()->printAsOperand(OS, MST);
 544   }
 545
 546   if (!MI.memoperands_empty()) {
 547     OS << " :: ";
 548     bool NeedComma = false;
 549     for (const auto *Op : MI.memoperands()) {
 550       if (NeedComma)
 551         OS << ", ";
 552       print(*Op);
 553       NeedComma = true;
 554     }
 555   }
 556 }
 557
 558 void MIPrinter::printMBBReference(const MachineBasicBlock &MBB) {
 559   OS << "%bb." << MBB.getNumber();
 560   if (const auto *BB = MBB.getBasicBlock()) {
 561     if (BB->hasName())
 562       OS << '.' << BB->getName();
 563   }
 564 }
 565
 566 void MIPrinter::printIRBlockReference(const BasicBlock &BB) {
 567   OS << "%ir-block.";
 568   if (BB.hasName()) {
 569     printLLVMNameWithoutPrefix(OS, BB.getName());
 570     return;
 571   }
 572   const Function *F = BB.getParent();
 573   int Slot;
 574   if (F == MST.getCurrentFunction()) {
 575     Slot = MST.getLocalSlot(&BB);
 576   } else {
 577     ModuleSlotTracker CustomMST(F->getParent(),
 578                                 /*ShouldInitializeAllMetadata=*/false);
 579     CustomMST.incorporateFunction(*F);
 580     Slot = CustomMST.getLocalSlot(&BB);
 581   }
 582   if (Slot == -1)
 583     OS << "<badref>";
 584   else
 585     OS << Slot;
 586 }
 587
 588 void MIPrinter::printIRValueReference(const Value &V) {
 589   OS << "%ir.";
 590   if (V.hasName()) {
 591     printLLVMNameWithoutPrefix(OS, V.getName());
 592     return;
 593   }
 594   // TODO: Serialize the unnamed IR value references.
 595   OS << "<unserializable ir value>";
 596 }
 597
 598 void MIPrinter::printStackObjectReference(int FrameIndex) {
 599   auto ObjectInfo = StackObjectOperandMapping.find(FrameIndex);
 600   assert(ObjectInfo != StackObjectOperandMapping.end() &&
 601          "Invalid frame index");
 602   const FrameIndexOperand &Operand = ObjectInfo->second;
 603   if (Operand.IsFixed) {
 604     OS << "%fixed-stack." << Operand.ID;
 605     return;
 606   }
 607   OS << "%stack." << Operand.ID;
 608   if (!Operand.Name.empty())
 609     OS << '.' << Operand.Name;
 610 }
 611
 612 void MIPrinter::printOffset(int64_t Offset) {
 613   if (Offset == 0)
 614     return;
 615   if (Offset < 0) {
 616     OS << " - " << -Offset;
 617     return;
 618   }
 619   OS << " + " << Offset;
 620 }
 621
 622 static const char *getTargetFlagName(const TargetInstrInfo *TII, unsigned TF) {
 623   auto Flags = TII->getSerializableDirectMachineOperandTargetFlags();
 624   for (const auto &I : Flags) {
 625     if (I.first == TF) {
 626       return I.second;
 627     }
 628   }
 629   return nullptr;
 630 }
 631
 632 void MIPrinter::printTargetFlags(const MachineOperand &Op) {
 633   if (!Op.getTargetFlags())
 634     return;
 635   const auto *TII =
 636       Op.getParent()->getParent()->getParent()->getSubtarget().getInstrInfo();
 637   assert(TII && "expected instruction info");
 638   auto Flags = TII->decomposeMachineOperandsTargetFlags(Op.getTargetFlags());
 639   OS << "target-flags(";
 640   const bool HasDirectFlags = Flags.first;
 641   const bool HasBitmaskFlags = Flags.second;
 642   if (!HasDirectFlags && !HasBitmaskFlags) {
 643     OS << "<unknown>) ";
 644     return;
 645   }
 646   if (HasDirectFlags) {
 647     if (const auto *Name = getTargetFlagName(TII, Flags.first))
 648       OS << Name;
 649     else
 650       OS << "<unknown target flag>";
 651   }
 652   if (!HasBitmaskFlags) {
 653     OS << ") ";
 654     return;
 655   }
 656   bool IsCommaNeeded = HasDirectFlags;
 657   unsigned BitMask = Flags.second;
 658   auto BitMasks = TII->getSerializableBitmaskMachineOperandTargetFlags();
 659   for (const auto &Mask : BitMasks) {
 660     // Check if the flag's bitmask has the bits of the current mask set.
 661     if ((BitMask & Mask.first) == Mask.first) {
 662       if (IsCommaNeeded)
 663         OS << ", ";
 664       IsCommaNeeded = true;
 665       OS << Mask.second;
 666       // Clear the bits which were serialized from the flag's bitmask.
 667       BitMask &= ~(Mask.first);
 668     }
 669   }
 670   if (BitMask) {
 671     // When the resulting flag's bitmask isn't zero, we know that we didn't
 672     // serialize all of the bit flags.
 673     if (IsCommaNeeded)
 674       OS << ", ";
 675     OS << "<unknown bitmask target flag>";
 676   }
 677   OS << ") ";
 678 }
 679
 680 static const char *getTargetIndexName(const MachineFunction &MF, int Index) {
 681   const auto *TII = MF.getSubtarget().getInstrInfo();
 682   assert(TII && "expected instruction info");
 683   auto Indices = TII->getSerializableTargetIndices();
 684   for (const auto &I : Indices) {
 685     if (I.first == Index) {
 686       return I.second;
 687     }
 688   }
 689   return nullptr;
 690 }
 691
 692 void MIPrinter::print(const MachineOperand &Op, const TargetRegisterInfo *TRI,
 693                       bool IsDef) {
 694   printTargetFlags(Op);
 695   switch (Op.getType()) {
 696   case MachineOperand::MO_Register:
 697     // FIXME: Serialize the tied register.
 698     if (Op.isImplicit())
 699       OS << (Op.isDef() ? "implicit-def " : "implicit ");
 700     else if (!IsDef && Op.isDef())
 701       // Print the 'def' flag only when the operand is defined after '='.
 702       OS << "def ";
 703     if (Op.isInternalRead())
 704       OS << "internal ";
 705     if (Op.isDead())
 706       OS << "dead ";
 707     if (Op.isKill())
 708       OS << "killed ";
 709     if (Op.isUndef())
 710       OS << "undef ";
 711     if (Op.isEarlyClobber())
 712       OS << "early-clobber ";
 713     if (Op.isDebug())
 714       OS << "debug-use ";
 715     printReg(Op.getReg(), OS, TRI);
 716     // Print the sub register.
 717     if (Op.getSubReg() != 0)
 718       OS << ':' << TRI->getSubRegIndexName(Op.getSubReg());
 719     break;
 720   case MachineOperand::MO_Immediate:
 721     OS << Op.getImm();
 722     break;
 723   case MachineOperand::MO_CImmediate:
 724     Op.getCImm()->printAsOperand(OS, /*PrintType=*/true, MST);
 725     break;
 726   case MachineOperand::MO_FPImmediate:
 727     Op.getFPImm()->printAsOperand(OS, /*PrintType=*/true, MST);
 728     break;
 729   case MachineOperand::MO_MachineBasicBlock:
 730     printMBBReference(*Op.getMBB());
 731     break;
 732   case MachineOperand::MO_FrameIndex:
 733     printStackObjectReference(Op.getIndex());
 734     break;
 735   case MachineOperand::MO_ConstantPoolIndex:
 736     OS << "%const." << Op.getIndex();
 737     printOffset(Op.getOffset());
 738     break;
 739   case MachineOperand::MO_TargetIndex: {
 740     OS << "target-index(";
 741     if (const auto *Name = getTargetIndexName(
 742             *Op.getParent()->getParent()->getParent(), Op.getIndex()))
 743       OS << Name;
 744     else
 745       OS << "<unknown>";
 746     OS << ')';
 747     printOffset(Op.getOffset());
 748     break;
 749   }
 750   case MachineOperand::MO_JumpTableIndex:
 751     OS << "%jump-table." << Op.getIndex();
 752     break;
 753   case MachineOperand::MO_ExternalSymbol:
 754     OS << '$';
 755     printLLVMNameWithoutPrefix(OS, Op.getSymbolName());
 756     printOffset(Op.getOffset());
 757     break;
 758   case MachineOperand::MO_GlobalAddress:
 759     Op.getGlobal()->printAsOperand(OS, /*PrintType=*/false, MST);
 760     printOffset(Op.getOffset());
 761     break;
 762   case MachineOperand::MO_BlockAddress:
 763     OS << "blockaddress(";
 764     Op.getBlockAddress()->getFunction()->printAsOperand(OS, /*PrintType=*/false,
 765                                                         MST);
 766     OS << ", ";
 767     printIRBlockReference(*Op.getBlockAddress()->getBasicBlock());
 768     OS << ')';
 769     printOffset(Op.getOffset());
 770     break;
 771   case MachineOperand::MO_RegisterMask: {
 772     auto RegMaskInfo = RegisterMaskIds.find(Op.getRegMask());
 773     if (RegMaskInfo != RegisterMaskIds.end())
 774       OS << StringRef(TRI->getRegMaskNames()[RegMaskInfo->second]).lower();
 775     else
 776       llvm_unreachable("Can't print this machine register mask yet.");
 777     break;
 778   }
 779   case MachineOperand::MO_RegisterLiveOut: {
 780     const uint32_t *RegMask = Op.getRegLiveOut();
 781     OS << "liveout(";
 782     bool IsCommaNeeded = false;
 783     for (unsigned Reg = 0, E = TRI->getNumRegs(); Reg < E; ++Reg) {
 784       if (RegMask[Reg / 32] & (1U << (Reg % 32))) {
 785         if (IsCommaNeeded)
 786           OS << ", ";
 787         printReg(Reg, OS, TRI);
 788         IsCommaNeeded = true;
 789       }
 790     }
 791     OS << ")";
 792     break;
 793   }
 794   case MachineOperand::MO_Metadata:
 795     Op.getMetadata()->printAsOperand(OS, MST);
 796     break;
 797   case MachineOperand::MO_CFIIndex: {
 798     const auto &MMI = Op.getParent()->getParent()->getParent()->getMMI();
 799     print(MMI.getFrameInstructions()[Op.getCFIIndex()], TRI);
 800     break;
 801   }
 802   default:
 803     // TODO: Print the other machine operands.
 804     llvm_unreachable("Can't print this machine operand at the moment");
 805   }
 806 }
 807
 808 void MIPrinter::print(const MachineMemOperand &Op) {
 809   OS << '(';
 810   // TODO: Print operand's target specific flags.
 811   if (Op.isVolatile())
 812     OS << "volatile ";
 813   if (Op.isNonTemporal())
 814     OS << "non-temporal ";
 815   if (Op.isInvariant())
 816     OS << "invariant ";
 817   if (Op.isLoad())
 818     OS << "load ";
 819   else {
 820     assert(Op.isStore() && "Non load machine operand must be a store");
 821     OS << "store ";
 822   }
 823   OS << Op.getSize() << (Op.isLoad() ? " from " : " into ");
 824   if (const Value *Val = Op.getValue()) {
 825     printIRValueReference(*Val);
 826   } else {
 827     const PseudoSourceValue *PVal = Op.getPseudoValue();
 828     assert(PVal && "Expected a pseudo source value");
 829     switch (PVal->kind()) {
 830     case PseudoSourceValue::Stack:
 831       OS << "stack";
 832       break;
 833     case PseudoSourceValue::GOT:
 834       OS << "got";
 835       break;
 836     case PseudoSourceValue::JumpTable:
 837       OS << "jump-table";
 838       break;
 839     case PseudoSourceValue::ConstantPool:
 840       OS << "constant-pool";
 841       break;
 842     case PseudoSourceValue::FixedStack:
 843       printStackObjectReference(
 844           cast<FixedStackPseudoSourceValue>(PVal)->getFrameIndex());
 845       break;
 846     case PseudoSourceValue::GlobalValueCallEntry:
 847       cast<GlobalValuePseudoSourceValue>(PVal)->getValue()->printAsOperand(
 848           OS, /*PrintType=*/false, MST);
 849       break;
 850     case PseudoSourceValue::ExternalSymbolCallEntry:
 851       OS << '$';
 852       printLLVMNameWithoutPrefix(
 853           OS, cast<ExternalSymbolPseudoSourceValue>(PVal)->getSymbol());
 854       break;
 855     }
 856   }
 857   printOffset(Op.getOffset());
 858   if (Op.getBaseAlignment() != Op.getSize())
 859     OS << ", align " << Op.getBaseAlignment();
 860   auto AAInfo = Op.getAAInfo();
 861   if (AAInfo.TBAA) {
 862     OS << ", !tbaa ";
 863     AAInfo.TBAA->printAsOperand(OS, MST);
 864   }
 865   if (AAInfo.Scope) {
 866     OS << ", !alias.scope ";
 867     AAInfo.Scope->printAsOperand(OS, MST);
 868   }
 869   if (AAInfo.NoAlias) {
 870     OS << ", !noalias ";
 871     AAInfo.NoAlias->printAsOperand(OS, MST);
 872   }
 873   if (Op.getRanges()) {
 874     OS << ", !range ";
 875     Op.getRanges()->printAsOperand(OS, MST);
 876   }
 877   OS << ')';
 878 }
 879
 880 static void printCFIRegister(unsigned DwarfReg, raw_ostream &OS,
 881                              const TargetRegisterInfo *TRI) {
 882   int Reg = TRI->getLLVMRegNum(DwarfReg, true);
 883   if (Reg == -1) {
 884     OS << "<badreg>";
 885     return;
 886   }
 887   printReg(Reg, OS, TRI);
 888 }
 889
 890 void MIPrinter::print(const MCCFIInstruction &CFI,
 891                       const TargetRegisterInfo *TRI) {
 892   switch (CFI.getOperation()) {
 893   case MCCFIInstruction::OpSameValue:
 894     OS << ".cfi_same_value ";
 895     if (CFI.getLabel())
 896       OS << "<mcsymbol> ";
 897     printCFIRegister(CFI.getRegister(), OS, TRI);
 898     break;
 899   case MCCFIInstruction::OpOffset:
 900     OS << ".cfi_offset ";
 901     if (CFI.getLabel())
 902       OS << "<mcsymbol> ";
 903     printCFIRegister(CFI.getRegister(), OS, TRI);
 904     OS << ", " << CFI.getOffset();
 905     break;
 906   case MCCFIInstruction::OpDefCfaRegister:
 907     OS << ".cfi_def_cfa_register ";
 908     if (CFI.getLabel())
 909       OS << "<mcsymbol> ";
 910     printCFIRegister(CFI.getRegister(), OS, TRI);
 911     break;
 912   case MCCFIInstruction::OpDefCfaOffset:
 913     OS << ".cfi_def_cfa_offset ";
 914     if (CFI.getLabel())
 915       OS << "<mcsymbol> ";
 916     OS << CFI.getOffset();
 917     break;
 918   case MCCFIInstruction::OpDefCfa:
 919     OS << ".cfi_def_cfa ";
 920     if (CFI.getLabel())
 921       OS << "<mcsymbol> ";
 922     printCFIRegister(CFI.getRegister(), OS, TRI);
 923     OS << ", " << CFI.getOffset();
 924     break;
 925   default:
 926     // TODO: Print the other CFI Operations.
 927     OS << "<unserializable cfi operation>";
 928     break;
 929   }
 930 }
 931
 932 void llvm::printMIR(raw_ostream &OS, const Module &M) {
 933   yaml::Output Out(OS);
 934   Out << const_cast<Module &>(M);
 935 }
 936
 937 void llvm::printMIR(raw_ostream &OS, const MachineFunction &MF) {
 938   MIRPrinter Printer(OS);
 939   Printer.print(MF);
 940 }