LCOV - code coverage report
Current view: top level - lib/CodeGen - MIRPrinter.cpp (source / functions) Hit Total Coverage
Test: llvm-toolchain.info Lines: 717 745 96.2 %
Date: 2017-09-14 15:23:50 Functions: 35 35 100.0 %
Legend: Lines: hit not hit

          Line data    Source code
       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 "llvm/ADT/DenseMap.h"
      16             : #include "llvm/ADT/None.h"
      17             : #include "llvm/ADT/SmallBitVector.h"
      18             : #include "llvm/ADT/SmallPtrSet.h"
      19             : #include "llvm/ADT/SmallVector.h"
      20             : #include "llvm/ADT/STLExtras.h"
      21             : #include "llvm/ADT/StringExtras.h"
      22             : #include "llvm/ADT/StringRef.h"
      23             : #include "llvm/ADT/Twine.h"
      24             : #include "llvm/CodeGen/GlobalISel/RegisterBank.h"
      25             : #include "llvm/CodeGen/MachineBasicBlock.h"
      26             : #include "llvm/CodeGen/MachineConstantPool.h"
      27             : #include "llvm/CodeGen/MachineFrameInfo.h"
      28             : #include "llvm/CodeGen/MachineFunction.h"
      29             : #include "llvm/CodeGen/MachineInstr.h"
      30             : #include "llvm/CodeGen/MachineJumpTableInfo.h"
      31             : #include "llvm/CodeGen/MachineMemOperand.h"
      32             : #include "llvm/CodeGen/MachineOperand.h"
      33             : #include "llvm/CodeGen/MachineRegisterInfo.h"
      34             : #include "llvm/CodeGen/MIRPrinter.h"
      35             : #include "llvm/CodeGen/MIRYamlMapping.h"
      36             : #include "llvm/CodeGen/PseudoSourceValue.h"
      37             : #include "llvm/IR/BasicBlock.h"
      38             : #include "llvm/IR/Constants.h"
      39             : #include "llvm/IR/DebugInfo.h"
      40             : #include "llvm/IR/DebugLoc.h"
      41             : #include "llvm/IR/Function.h"
      42             : #include "llvm/IR/GlobalValue.h"
      43             : #include "llvm/IR/InstrTypes.h"
      44             : #include "llvm/IR/Instructions.h"
      45             : #include "llvm/IR/Intrinsics.h"
      46             : #include "llvm/IR/IRPrintingPasses.h"
      47             : #include "llvm/IR/Module.h"
      48             : #include "llvm/IR/ModuleSlotTracker.h"
      49             : #include "llvm/IR/Value.h"
      50             : #include "llvm/MC/LaneBitmask.h"
      51             : #include "llvm/MC/MCDwarf.h"
      52             : #include "llvm/MC/MCSymbol.h"
      53             : #include "llvm/Support/AtomicOrdering.h"
      54             : #include "llvm/Support/BranchProbability.h"
      55             : #include "llvm/Support/Casting.h"
      56             : #include "llvm/Support/CommandLine.h"
      57             : #include "llvm/Support/ErrorHandling.h"
      58             : #include "llvm/Support/Format.h"
      59             : #include "llvm/Support/LowLevelTypeImpl.h"
      60             : #include "llvm/Support/raw_ostream.h"
      61             : #include "llvm/Support/YAMLTraits.h"
      62             : #include "llvm/Target/TargetInstrInfo.h"
      63             : #include "llvm/Target/TargetIntrinsicInfo.h"
      64             : #include "llvm/Target/TargetMachine.h"
      65             : #include "llvm/Target/TargetRegisterInfo.h"
      66             : #include "llvm/Target/TargetSubtargetInfo.h"
      67             : #include <algorithm>
      68             : #include <cassert>
      69             : #include <cinttypes>
      70             : #include <cstdint>
      71             : #include <iterator>
      72             : #include <string>
      73             : #include <utility>
      74             : #include <vector>
      75             : 
      76             : using namespace llvm;
      77             : 
      78       72306 : static cl::opt<bool> SimplifyMIR("simplify-mir",
      79      144612 :     cl::desc("Leave out unnecessary information when printing MIR"));
      80             : 
      81             : namespace {
      82             : 
      83             : /// This structure describes how to print out stack object references.
      84        4950 : struct FrameIndexOperand {
      85             :   std::string Name;
      86             :   unsigned ID;
      87             :   bool IsFixed;
      88             : 
      89             :   FrameIndexOperand(StringRef Name, unsigned ID, bool IsFixed)
      90         990 :       : Name(Name.str()), ID(ID), IsFixed(IsFixed) {}
      91             : 
      92             :   /// Return an ordinary stack object reference.
      93             :   static FrameIndexOperand create(StringRef Name, unsigned ID) {
      94         207 :     return FrameIndexOperand(Name, ID, /*IsFixed=*/false);
      95             :   }
      96             : 
      97             :   /// Return a fixed stack object reference.
      98             :   static FrameIndexOperand createFixed(unsigned ID) {
      99         576 :     return FrameIndexOperand("", ID, /*IsFixed=*/true);
     100             :   }
     101             : };
     102             : 
     103             : } // end anonymous namespace
     104             : 
     105             : namespace llvm {
     106             : 
     107             : /// This class prints out the machine functions using the MIR serialization
     108             : /// format.
     109        7365 : class MIRPrinter {
     110             :   raw_ostream &OS;
     111             :   DenseMap<const uint32_t *, unsigned> RegisterMaskIds;
     112             :   /// Maps from stack object indices to operand indices which will be used when
     113             :   /// printing frame index machine operands.
     114             :   DenseMap<int, FrameIndexOperand> StackObjectOperandMapping;
     115             : 
     116             : public:
     117        7365 :   MIRPrinter(raw_ostream &OS) : OS(OS) {}
     118             : 
     119             :   void print(const MachineFunction &MF);
     120             : 
     121             :   void convert(yaml::MachineFunction &MF, const MachineRegisterInfo &RegInfo,
     122             :                const TargetRegisterInfo *TRI);
     123             :   void convert(ModuleSlotTracker &MST, yaml::MachineFrameInfo &YamlMFI,
     124             :                const MachineFrameInfo &MFI);
     125             :   void convert(yaml::MachineFunction &MF,
     126             :                const MachineConstantPool &ConstantPool);
     127             :   void convert(ModuleSlotTracker &MST, yaml::MachineJumpTable &YamlJTI,
     128             :                const MachineJumpTableInfo &JTI);
     129             :   void convertStackObjects(yaml::MachineFunction &YMF,
     130             :                            const MachineFunction &MF, ModuleSlotTracker &MST);
     131             : 
     132             : private:
     133             :   void initRegisterMaskIds(const MachineFunction &MF);
     134             : };
     135             : 
     136             : /// This class prints out the machine instructions using the MIR serialization
     137             : /// format.
     138        6790 : class MIPrinter {
     139             :   raw_ostream &OS;
     140             :   ModuleSlotTracker &MST;
     141             :   const DenseMap<const uint32_t *, unsigned> &RegisterMaskIds;
     142             :   const DenseMap<int, FrameIndexOperand> &StackObjectOperandMapping;
     143             :   /// Synchronization scope names registered with LLVMContext.
     144             :   SmallVector<StringRef, 8> SSNs;
     145             : 
     146             :   bool canPredictBranchProbabilities(const MachineBasicBlock &MBB) const;
     147             :   bool canPredictSuccessors(const MachineBasicBlock &MBB) const;
     148             : 
     149             : public:
     150             :   MIPrinter(raw_ostream &OS, ModuleSlotTracker &MST,
     151             :             const DenseMap<const uint32_t *, unsigned> &RegisterMaskIds,
     152             :             const DenseMap<int, FrameIndexOperand> &StackObjectOperandMapping)
     153             :       : OS(OS), MST(MST), RegisterMaskIds(RegisterMaskIds),
     154        6790 :         StackObjectOperandMapping(StackObjectOperandMapping) {}
     155             : 
     156             :   void print(const MachineBasicBlock &MBB);
     157             : 
     158             :   void print(const MachineInstr &MI);
     159             :   void printMBBReference(const MachineBasicBlock &MBB);
     160             :   void printIRBlockReference(const BasicBlock &BB);
     161             :   void printIRValueReference(const Value &V);
     162             :   void printStackObjectReference(int FrameIndex);
     163             :   void printOffset(int64_t Offset);
     164             :   void printTargetFlags(const MachineOperand &Op);
     165             :   void print(const MachineOperand &Op, const TargetRegisterInfo *TRI,
     166             :              unsigned I, bool ShouldPrintRegisterTies,
     167             :              LLT TypeToPrint, bool IsDef = false);
     168             :   void print(const LLVMContext &Context, const TargetInstrInfo &TII,
     169             :              const MachineMemOperand &Op);
     170             :   void printSyncScope(const LLVMContext &Context, SyncScope::ID SSID);
     171             : 
     172             :   void print(const MCCFIInstruction &CFI, const TargetRegisterInfo *TRI);
     173             : };
     174             : 
     175             : } // end namespace llvm
     176             : 
     177             : namespace llvm {
     178             : namespace yaml {
     179             : 
     180             : /// This struct serializes the LLVM IR module.
     181             : template <> struct BlockScalarTraits<Module> {
     182             :   static void output(const Module &Mod, void *Ctxt, raw_ostream &OS) {
     183         587 :     Mod.print(OS, nullptr);
     184             :   }
     185             : 
     186             :   static StringRef input(StringRef Str, void *Ctxt, Module &Mod) {
     187           0 :     llvm_unreachable("LLVM Module is supposed to be parsed separately");
     188             :     return "";
     189             :   }
     190             : };
     191             : 
     192             : } // end namespace yaml
     193             : } // end namespace llvm
     194             : 
     195       55478 : static void printReg(unsigned Reg, raw_ostream &OS,
     196             :                      const TargetRegisterInfo *TRI) {
     197             :   // TODO: Print Stack Slots.
     198       55478 :   if (!Reg)
     199             :     OS << '_';
     200       50254 :   else if (TargetRegisterInfo::isVirtualRegister(Reg))
     201       40544 :     OS << '%' << TargetRegisterInfo::virtReg2Index(Reg);
     202       29982 :   else if (Reg < TRI->getNumRegs())
     203      149910 :     OS << '%' << StringRef(TRI->getName(Reg)).lower();
     204             :   else
     205           0 :     llvm_unreachable("Can't print this kind of register yet");
     206       55478 : }
     207             : 
     208        1266 : static void printReg(unsigned Reg, yaml::StringValue &Dest,
     209             :                      const TargetRegisterInfo *TRI) {
     210        3798 :   raw_string_ostream OS(Dest.Value);
     211        1266 :   printReg(Reg, OS, TRI);
     212        1266 : }
     213             : 
     214        2455 : void MIRPrinter::print(const MachineFunction &MF) {
     215        2455 :   initRegisterMaskIds(MF);
     216             : 
     217        4910 :   yaml::MachineFunction YamlMF;
     218        2455 :   YamlMF.Name = MF.getName();
     219        2455 :   YamlMF.Alignment = MF.getAlignment();
     220        2455 :   YamlMF.ExposesReturnsTwice = MF.exposesReturnsTwice();
     221             : 
     222        4910 :   YamlMF.Legalized = MF.getProperties().hasProperty(
     223             :       MachineFunctionProperties::Property::Legalized);
     224        4910 :   YamlMF.RegBankSelected = MF.getProperties().hasProperty(
     225             :       MachineFunctionProperties::Property::RegBankSelected);
     226        4910 :   YamlMF.Selected = MF.getProperties().hasProperty(
     227             :       MachineFunctionProperties::Property::Selected);
     228             : 
     229        2455 :   convert(YamlMF, MF.getRegInfo(), MF.getSubtarget().getRegisterInfo());
     230        4910 :   ModuleSlotTracker MST(MF.getFunction()->getParent());
     231        2455 :   MST.incorporateFunction(*MF.getFunction());
     232        2455 :   convert(MST, YamlMF.FrameInfo, MF.getFrameInfo());
     233        2455 :   convertStackObjects(YamlMF, MF, MST);
     234        2455 :   if (const auto *ConstantPool = MF.getConstantPool())
     235        2455 :     convert(YamlMF, *ConstantPool);
     236        2455 :   if (const auto *JumpTableInfo = MF.getJumpTableInfo())
     237           7 :     convert(MST, YamlMF.JumpTableInfo, *JumpTableInfo);
     238        4910 :   raw_string_ostream StrOS(YamlMF.Body.Value.Value);
     239        2455 :   bool IsNewlineNeeded = false;
     240       10684 :   for (const auto &MBB : MF) {
     241        3319 :     if (IsNewlineNeeded)
     242         883 :       StrOS << "\n";
     243        9957 :     MIPrinter(StrOS, MST, RegisterMaskIds, StackObjectOperandMapping)
     244        3319 :         .print(MBB);
     245        3319 :     IsNewlineNeeded = true;
     246             :   }
     247        2455 :   StrOS.flush();
     248        4910 :   yaml::Output Out(OS);
     249        2455 :   if (!SimplifyMIR)
     250             :       Out.setWriteDefaultValues(true);
     251        2455 :   Out << YamlMF;
     252        2455 : }
     253             : 
     254           2 : static void printCustomRegMask(const uint32_t *RegMask, raw_ostream &OS,
     255             :                                const TargetRegisterInfo *TRI) {
     256             :   assert(RegMask && "Can't print an empty register mask");
     257           2 :   OS << StringRef("CustomRegMask(");
     258             : 
     259           2 :   bool IsRegInRegMaskFound = false;
     260         494 :   for (int I = 0, E = TRI->getNumRegs(); I < E; I++) {
     261             :     // Check whether the register is asserted in regmask.
     262         492 :     if (RegMask[I / 32] & (1u << (I % 32))) {
     263          90 :       if (IsRegInRegMaskFound)
     264             :         OS << ',';
     265          90 :       printReg(I, OS, TRI);
     266          90 :       IsRegInRegMaskFound = true;
     267             :     }
     268             :   }
     269             : 
     270           2 :   OS << ')';
     271           2 : }
     272             : 
     273        2455 : void MIRPrinter::convert(yaml::MachineFunction &MF,
     274             :                          const MachineRegisterInfo &RegInfo,
     275             :                          const TargetRegisterInfo *TRI) {
     276        4910 :   MF.TracksRegLiveness = RegInfo.tracksLiveness();
     277             : 
     278             :   // Print the virtual register definitions.
     279       15975 :   for (unsigned I = 0, E = RegInfo.getNumVirtRegs(); I < E; ++I) {
     280       11065 :     unsigned Reg = TargetRegisterInfo::index2VirtReg(I);
     281       22130 :     yaml::VirtualRegisterDefinition VReg;
     282       11065 :     VReg.ID = I;
     283        6662 :     if (RegInfo.getRegClassOrNull(Reg))
     284        4760 :       VReg.Class =
     285       28560 :           StringRef(TRI->getRegClassName(RegInfo.getRegClass(Reg))).lower();
     286        4403 :     else if (RegInfo.getRegBankOrNull(Reg))
     287        5382 :       VReg.Class = StringRef(RegInfo.getRegBankOrNull(Reg)->getName()).lower();
     288             :     else {
     289       32448 :       VReg.Class = std::string("_");
     290             :       assert((RegInfo.def_empty(Reg) || RegInfo.getType(Reg).isValid()) &&
     291             :              "Generic registers must have a valid type");
     292             :     }
     293       11065 :     unsigned PreferredReg = RegInfo.getSimpleHint(Reg);
     294       11065 :     if (PreferredReg)
     295          28 :       printReg(PreferredReg, VReg.PreferredRegister, TRI);
     296       11065 :     MF.VirtualRegisters.push_back(VReg);
     297             :   }
     298             : 
     299             :   // Print the live ins.
     300        7896 :   for (auto I = RegInfo.livein_begin(), E = RegInfo.livein_end(); I != E; ++I) {
     301        1062 :     yaml::MachineFunctionLiveIn LiveIn;
     302         531 :     printReg(I->first, LiveIn.Register, TRI);
     303         531 :     if (I->second)
     304         201 :       printReg(I->second, LiveIn.VirtualRegister, TRI);
     305         531 :     MF.LiveIns.push_back(LiveIn);
     306             :   }
     307             : 
     308             :   // Prints the callee saved registers.
     309        2455 :   if (RegInfo.isUpdatedCSRsInitialized()) {
     310          12 :     const MCPhysReg *CalleeSavedRegs = RegInfo.getCalleeSavedRegs();
     311          24 :     std::vector<yaml::FlowStringValue> CalleeSavedRegisters;
     312         425 :     for (const MCPhysReg *I = CalleeSavedRegs; *I; ++I) {
     313         826 :       yaml::FlowStringValue Reg;
     314         413 :       printReg(*I, Reg, TRI);
     315         413 :       CalleeSavedRegisters.push_back(Reg);
     316             :     }
     317          12 :     MF.CalleeSavedRegisters = CalleeSavedRegisters;
     318             :   }
     319        2455 : }
     320             : 
     321        2455 : void MIRPrinter::convert(ModuleSlotTracker &MST,
     322             :                          yaml::MachineFrameInfo &YamlMFI,
     323             :                          const MachineFrameInfo &MFI) {
     324        2455 :   YamlMFI.IsFrameAddressTaken = MFI.isFrameAddressTaken();
     325        2455 :   YamlMFI.IsReturnAddressTaken = MFI.isReturnAddressTaken();
     326        2455 :   YamlMFI.HasStackMap = MFI.hasStackMap();
     327        2455 :   YamlMFI.HasPatchPoint = MFI.hasPatchPoint();
     328        2455 :   YamlMFI.StackSize = MFI.getStackSize();
     329        2455 :   YamlMFI.OffsetAdjustment = MFI.getOffsetAdjustment();
     330        2455 :   YamlMFI.MaxAlignment = MFI.getMaxAlignment();
     331        2455 :   YamlMFI.AdjustsStack = MFI.adjustsStack();
     332        2455 :   YamlMFI.HasCalls = MFI.hasCalls();
     333        4910 :   YamlMFI.MaxCallFrameSize = MFI.isMaxCallFrameSizeComputed()
     334        2740 :     ? MFI.getMaxCallFrameSize() : ~0u;
     335        2455 :   YamlMFI.HasOpaqueSPAdjustment = MFI.hasOpaqueSPAdjustment();
     336        2455 :   YamlMFI.HasVAStart = MFI.hasVAStart();
     337        2455 :   YamlMFI.HasMustTailInVarArgFunc = MFI.hasMustTailInVarArgFunc();
     338        2455 :   if (MFI.getSavePoint()) {
     339           3 :     raw_string_ostream StrOS(YamlMFI.SavePoint.Value);
     340           3 :     MIPrinter(StrOS, MST, RegisterMaskIds, StackObjectOperandMapping)
     341           1 :         .printMBBReference(*MFI.getSavePoint());
     342             :   }
     343        2455 :   if (MFI.getRestorePoint()) {
     344           3 :     raw_string_ostream StrOS(YamlMFI.RestorePoint.Value);
     345           3 :     MIPrinter(StrOS, MST, RegisterMaskIds, StackObjectOperandMapping)
     346           1 :         .printMBBReference(*MFI.getRestorePoint());
     347             :   }
     348        2455 : }
     349             : 
     350        2455 : void MIRPrinter::convertStackObjects(yaml::MachineFunction &YMF,
     351             :                                      const MachineFunction &MF,
     352             :                                      ModuleSlotTracker &MST) {
     353        2455 :   const MachineFrameInfo &MFI = MF.getFrameInfo();
     354        2455 :   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
     355             :   // Process fixed stack objects.
     356        2455 :   unsigned ID = 0;
     357        2743 :   for (int I = MFI.getObjectIndexBegin(); I < 0; ++I) {
     358         576 :     if (MFI.isDeadObjectIndex(I))
     359           0 :       continue;
     360             : 
     361         576 :     yaml::FixedMachineStackObject YamlObject;
     362         288 :     YamlObject.ID = ID;
     363         864 :     YamlObject.Type = MFI.isSpillSlotObjectIndex(I)
     364         288 :                           ? yaml::FixedMachineStackObject::SpillSlot
     365             :                           : yaml::FixedMachineStackObject::DefaultType;
     366         576 :     YamlObject.Offset = MFI.getObjectOffset(I);
     367         576 :     YamlObject.Size = MFI.getObjectSize(I);
     368         576 :     YamlObject.Alignment = MFI.getObjectAlignment(I);
     369         576 :     YamlObject.StackID = MFI.getStackID(I);
     370         576 :     YamlObject.IsImmutable = MFI.isImmutableObjectIndex(I);
     371         576 :     YamlObject.IsAliased = MFI.isAliasedObjectIndex(I);
     372         288 :     YMF.FixedStackObjects.push_back(YamlObject);
     373         288 :     StackObjectOperandMapping.insert(
     374        1440 :         std::make_pair(I, FrameIndexOperand::createFixed(ID++)));
     375             :   }
     376             : 
     377             :   // Process ordinary stack objects.
     378        2455 :   ID = 0;
     379        5117 :   for (int I = 0, E = MFI.getObjectIndexEnd(); I < E; ++I) {
     380         414 :     if (MFI.isDeadObjectIndex(I))
     381           0 :       continue;
     382             : 
     383         414 :     yaml::MachineStackObject YamlObject;
     384         207 :     YamlObject.ID = ID;
     385         414 :     if (const auto *Alloca = MFI.getObjectAllocation(I))
     386          74 :       YamlObject.Name.Value =
     387         296 :           Alloca->hasName() ? Alloca->getName() : "<unnamed alloca>";
     388         621 :     YamlObject.Type = MFI.isSpillSlotObjectIndex(I)
     389         207 :                           ? yaml::MachineStackObject::SpillSlot
     390         216 :                           : MFI.isVariableSizedObjectIndex(I)
     391         108 :                                 ? yaml::MachineStackObject::VariableSized
     392             :                                 : yaml::MachineStackObject::DefaultType;
     393         414 :     YamlObject.Offset = MFI.getObjectOffset(I);
     394         414 :     YamlObject.Size = MFI.getObjectSize(I);
     395         414 :     YamlObject.Alignment = MFI.getObjectAlignment(I);
     396         414 :     YamlObject.StackID = MFI.getStackID(I);
     397             : 
     398         207 :     YMF.StackObjects.push_back(YamlObject);
     399         828 :     StackObjectOperandMapping.insert(std::make_pair(
     400         828 :         I, FrameIndexOperand::create(YamlObject.Name.Value, ID++)));
     401             :   }
     402             : 
     403        9913 :   for (const auto &CSInfo : MFI.getCalleeSavedInfo()) {
     404         186 :     yaml::StringValue Reg;
     405          93 :     printReg(CSInfo.getReg(), Reg, TRI);
     406          93 :     auto StackObjectInfo = StackObjectOperandMapping.find(CSInfo.getFrameIdx());
     407             :     assert(StackObjectInfo != StackObjectOperandMapping.end() &&
     408             :            "Invalid stack object index");
     409          93 :     const FrameIndexOperand &StackObject = StackObjectInfo->second;
     410          93 :     if (StackObject.IsFixed)
     411          60 :       YMF.FixedStackObjects[StackObject.ID].CalleeSavedRegister = Reg;
     412             :     else
     413         126 :       YMF.StackObjects[StackObject.ID].CalleeSavedRegister = Reg;
     414             :   }
     415        4933 :   for (unsigned I = 0, E = MFI.getLocalFrameObjectCount(); I < E; ++I) {
     416          46 :     auto LocalObject = MFI.getLocalFrameObjectMap(I);
     417          23 :     auto StackObjectInfo = StackObjectOperandMapping.find(LocalObject.first);
     418             :     assert(StackObjectInfo != StackObjectOperandMapping.end() &&
     419             :            "Invalid stack object index");
     420          23 :     const FrameIndexOperand &StackObject = StackObjectInfo->second;
     421             :     assert(!StackObject.IsFixed && "Expected a locally mapped stack object");
     422          69 :     YMF.StackObjects[StackObject.ID].LocalOffset = LocalObject.second;
     423             :   }
     424             : 
     425             :   // Print the stack object references in the frame information class after
     426             :   // converting the stack objects.
     427        2455 :   if (MFI.hasStackProtectorIndex()) {
     428           3 :     raw_string_ostream StrOS(YMF.FrameInfo.StackProtector.Value);
     429           3 :     MIPrinter(StrOS, MST, RegisterMaskIds, StackObjectOperandMapping)
     430           1 :         .printStackObjectReference(MFI.getStackProtectorIndex());
     431             :   }
     432             : 
     433             :   // Print the debug variable information.
     434           4 :   for (const MachineFunction::VariableDbgInfo &DebugVar :
     435        7365 :        MF.getVariableDbgInfo()) {
     436           2 :     auto StackObjectInfo = StackObjectOperandMapping.find(DebugVar.Slot);
     437             :     assert(StackObjectInfo != StackObjectOperandMapping.end() &&
     438             :            "Invalid stack object index");
     439           2 :     const FrameIndexOperand &StackObject = StackObjectInfo->second;
     440             :     assert(!StackObject.IsFixed && "Expected a non-fixed stack object");
     441           4 :     auto &Object = YMF.StackObjects[StackObject.ID];
     442             :     {
     443           6 :       raw_string_ostream StrOS(Object.DebugVar.Value);
     444           2 :       DebugVar.Var->printAsOperand(StrOS, MST);
     445             :     }
     446             :     {
     447           6 :       raw_string_ostream StrOS(Object.DebugExpr.Value);
     448           2 :       DebugVar.Expr->printAsOperand(StrOS, MST);
     449             :     }
     450             :     {
     451           6 :       raw_string_ostream StrOS(Object.DebugLoc.Value);
     452           2 :       DebugVar.Loc->printAsOperand(StrOS, MST);
     453             :     }
     454             :   }
     455        2455 : }
     456             : 
     457        2455 : void MIRPrinter::convert(yaml::MachineFunction &MF,
     458             :                          const MachineConstantPool &ConstantPool) {
     459        2455 :   unsigned ID = 0;
     460        9848 :   for (const MachineConstantPoolEntry &Constant : ConstantPool.getConstants()) {
     461          56 :     std::string Str;
     462          56 :     raw_string_ostream StrOS(Str);
     463          28 :     if (Constant.isMachineConstantPoolEntry()) {
     464           4 :       Constant.Val.MachineCPVal->print(StrOS);
     465             :     } else {
     466          24 :       Constant.Val.ConstVal->printAsOperand(StrOS);
     467             :     }
     468             : 
     469          56 :     yaml::MachineConstantPoolValue YamlConstant;
     470          56 :     YamlConstant.ID = ID++;
     471         168 :     YamlConstant.Value = StrOS.str();
     472          28 :     YamlConstant.Alignment = Constant.getAlignment();
     473          28 :     YamlConstant.IsTargetSpecific = Constant.isMachineConstantPoolEntry();
     474             : 
     475          28 :     MF.Constants.push_back(YamlConstant);
     476             :   }
     477        2455 : }
     478             : 
     479           7 : void MIRPrinter::convert(ModuleSlotTracker &MST,
     480             :                          yaml::MachineJumpTable &YamlJTI,
     481             :                          const MachineJumpTableInfo &JTI) {
     482           7 :   YamlJTI.Kind = JTI.getEntryKind();
     483           7 :   unsigned ID = 0;
     484          35 :   for (const auto &Table : JTI.getJumpTables()) {
     485          14 :     std::string Str;
     486          14 :     yaml::MachineJumpTable::Entry Entry;
     487          14 :     Entry.ID = ID++;
     488         101 :     for (const auto *MBB : Table.MBBs) {
     489         146 :       raw_string_ostream StrOS(Str);
     490         219 :       MIPrinter(StrOS, MST, RegisterMaskIds, StackObjectOperandMapping)
     491          73 :           .printMBBReference(*MBB);
     492         365 :       Entry.Blocks.push_back(StrOS.str());
     493          73 :       Str.clear();
     494             :     }
     495           7 :     YamlJTI.Entries.push_back(Entry);
     496             :   }
     497           7 : }
     498             : 
     499        2455 : void MIRPrinter::initRegisterMaskIds(const MachineFunction &MF) {
     500        2455 :   const auto *TRI = MF.getSubtarget().getRegisterInfo();
     501        2455 :   unsigned I = 0;
     502       55376 :   for (const uint32_t *Mask : TRI->getRegMasks())
     503      151398 :     RegisterMaskIds.insert(std::make_pair(Mask, I++));
     504        2455 : }
     505             : 
     506        2596 : void llvm::guessSuccessors(const MachineBasicBlock &MBB,
     507             :                            SmallVectorImpl<MachineBasicBlock*> &Result,
     508             :                            bool &IsFallthrough) {
     509        5192 :   SmallPtrSet<MachineBasicBlock*,8> Seen;
     510             : 
     511       39504 :   for (const MachineInstr &MI : MBB) {
     512       14560 :     if (MI.isPHI())
     513          41 :       continue;
     514      117026 :     for (const MachineOperand &MO : MI.operands()) {
     515       43994 :       if (!MO.isMBB())
     516       43665 :         continue;
     517         329 :       MachineBasicBlock *Succ = MO.getMBB();
     518         329 :       auto RP = Seen.insert(Succ);
     519         329 :       if (RP.second)
     520         329 :         Result.push_back(Succ);
     521             :     }
     522             :   }
     523        2596 :   MachineBasicBlock::const_iterator I = MBB.getLastNonDebugInstr();
     524       10228 :   IsFallthrough = I == MBB.end() || !I->isBarrier();
     525        2596 : }
     526             : 
     527             : bool
     528        3319 : MIPrinter::canPredictBranchProbabilities(const MachineBasicBlock &MBB) const {
     529        3319 :   if (MBB.succ_size() <= 1)
     530             :     return true;
     531         326 :   if (!MBB.hasSuccessorProbabilities())
     532             :     return true;
     533             : 
     534             :   SmallVector<BranchProbability,8> Normalized(MBB.Probs.begin(),
     535        1292 :                                               MBB.Probs.end());
     536         646 :   BranchProbability::normalizeProbabilities(Normalized.begin(),
     537             :                                             Normalized.end());
     538        1292 :   SmallVector<BranchProbability,8> Equal(Normalized.size());
     539         646 :   BranchProbability::normalizeProbabilities(Equal.begin(), Equal.end());
     540             : 
     541        1292 :   return std::equal(Normalized.begin(), Normalized.end(), Equal.begin());
     542             : }
     543             : 
     544           6 : bool MIPrinter::canPredictSuccessors(const MachineBasicBlock &MBB) const {
     545          12 :   SmallVector<MachineBasicBlock*,8> GuessedSuccs;
     546             :   bool GuessedFallthrough;
     547           6 :   guessSuccessors(MBB, GuessedSuccs, GuessedFallthrough);
     548           6 :   if (GuessedFallthrough) {
     549           4 :     const MachineFunction &MF = *MBB.getParent();
     550          12 :     MachineFunction::const_iterator NextI = std::next(MBB.getIterator());
     551           4 :     if (NextI != MF.end()) {
     552           4 :       MachineBasicBlock *Next = const_cast<MachineBasicBlock*>(&*NextI);
     553           4 :       if (!is_contained(GuessedSuccs, Next))
     554           3 :         GuessedSuccs.push_back(Next);
     555             :     }
     556             :   }
     557          12 :   if (GuessedSuccs.size() != MBB.succ_size())
     558             :     return false;
     559          18 :   return std::equal(MBB.succ_begin(), MBB.succ_end(), GuessedSuccs.begin());
     560             : }
     561             : 
     562        3319 : void MIPrinter::print(const MachineBasicBlock &MBB) {
     563             :   assert(MBB.getNumber() >= 0 && "Invalid MBB number");
     564        6638 :   OS << "bb." << MBB.getNumber();
     565        3319 :   bool HasAttributes = false;
     566        3319 :   if (const auto *BB = MBB.getBasicBlock()) {
     567        3800 :     if (BB->hasName()) {
     568         949 :       OS << "." << BB->getName();
     569             :     } else {
     570         951 :       HasAttributes = true;
     571         951 :       OS << " (";
     572         951 :       int Slot = MST.getLocalSlot(BB);
     573         951 :       if (Slot == -1)
     574           0 :         OS << "<ir-block badref>";
     575             :       else
     576        5706 :         OS << (Twine("%ir-block.") + Twine(Slot)).str();
     577             :     }
     578             :   }
     579        3319 :   if (MBB.hasAddressTaken()) {
     580           9 :     OS << (HasAttributes ? ", " : " (");
     581           9 :     OS << "address-taken";
     582           9 :     HasAttributes = true;
     583             :   }
     584        3319 :   if (MBB.isEHPad()) {
     585           4 :     OS << (HasAttributes ? ", " : " (");
     586           4 :     OS << "landing-pad";
     587           4 :     HasAttributes = true;
     588             :   }
     589        3319 :   if (MBB.getAlignment()) {
     590           7 :     OS << (HasAttributes ? ", " : " (");
     591          14 :     OS << "align " << MBB.getAlignment();
     592           7 :     HasAttributes = true;
     593             :   }
     594        3312 :   if (HasAttributes)
     595         969 :     OS << ")";
     596        3319 :   OS << ":\n";
     597             : 
     598        3319 :   bool HasLineAttributes = false;
     599             :   // Print the successors
     600        3319 :   bool canPredictProbs = canPredictBranchProbabilities(MBB);
     601        4122 :   if (!MBB.succ_empty() && (!SimplifyMIR || !canPredictProbs ||
     602           6 :                             !canPredictSuccessors(MBB))) {
     603         793 :     OS.indent(2) << "successors: ";
     604        3538 :     for (auto I = MBB.succ_begin(), E = MBB.succ_end(); I != E; ++I) {
     605        2318 :       if (I != MBB.succ_begin())
     606         366 :         OS << ", ";
     607        1159 :       printMBBReference(**I);
     608        1159 :       if (!SimplifyMIR || !canPredictProbs)
     609        2310 :         OS << '('
     610        4620 :            << format("0x%08" PRIx32, MBB.getSuccProbability(I).getNumerator())
     611        1155 :            << ')';
     612             :     }
     613         793 :     OS << "\n";
     614         793 :     HasLineAttributes = true;
     615             :   }
     616             : 
     617             :   // Print the live in registers.
     618        3319 :   const MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
     619        5026 :   if (MRI.tracksLiveness() && !MBB.livein_empty()) {
     620        1138 :     const TargetRegisterInfo &TRI = *MRI.getTargetRegisterInfo();
     621        1138 :     OS.indent(2) << "liveins: ";
     622        1138 :     bool First = true;
     623        5190 :     for (const auto &LI : MBB.liveins()) {
     624        2914 :       if (!First)
     625        1776 :         OS << ", ";
     626        2914 :       First = false;
     627        2914 :       printReg(LI.PhysReg, OS, &TRI);
     628        5828 :       if (!LI.LaneMask.all())
     629          88 :         OS << ":0x" << PrintLaneMask(LI.LaneMask);
     630             :     }
     631        1138 :     OS << "\n";
     632        1138 :     HasLineAttributes = true;
     633             :   }
     634             : 
     635        2181 :   if (HasLineAttributes)
     636        1572 :     OS << "\n";
     637        3319 :   bool IsInBundle = false;
     638        6638 :   for (auto I = MBB.instr_begin(), E = MBB.instr_end(); I != E; ++I) {
     639       21774 :     const MachineInstr &MI = *I;
     640       21796 :     if (IsInBundle && !MI.isInsideBundle()) {
     641           6 :       OS.indent(2) << "}\n";
     642           6 :       IsInBundle = false;
     643             :     }
     644       21774 :     OS.indent(IsInBundle ? 4 : 2);
     645       21774 :     print(MI);
     646       21774 :     if (!IsInBundle && MI.getFlag(MachineInstr::BundledSucc)) {
     647           7 :       OS << " {";
     648           7 :       IsInBundle = true;
     649             :     }
     650       21774 :     OS << "\n";
     651             :   }
     652        3319 :   if (IsInBundle)
     653           1 :     OS.indent(2) << "}\n";
     654        3319 : }
     655             : 
     656             : /// Return true when an instruction has tied register that can't be determined
     657             : /// by the instruction's descriptor.
     658       21774 : static bool hasComplexRegisterTies(const MachineInstr &MI) {
     659       21774 :   const MCInstrDesc &MCID = MI.getDesc();
     660       88277 :   for (unsigned I = 0, E = MI.getNumOperands(); I < E; ++I) {
     661      133020 :     const auto &Operand = MI.getOperand(I);
     662      117611 :     if (!Operand.isReg() || Operand.isDef())
     663             :       // Ignore the defined registers as MCID marks only the uses as tied.
     664       34281 :       continue;
     665       64458 :     int ExpectedTiedIdx = MCID.getOperandConstraint(I, MCOI::TIED_TO);
     666       32229 :     int TiedIdx = Operand.isTied() ? int(MI.findTiedOperandIdx(I)) : -1;
     667       32229 :     if (ExpectedTiedIdx != TiedIdx)
     668             :       return true;
     669             :   }
     670             :   return false;
     671             : }
     672             : 
     673       66514 : static LLT getTypeToPrint(const MachineInstr &MI, unsigned OpIdx,
     674             :                           SmallBitVector &PrintedTypes,
     675             :                           const MachineRegisterInfo &MRI) {
     676      133028 :   const MachineOperand &Op = MI.getOperand(OpIdx);
     677       66514 :   if (!Op.isReg())
     678       15411 :     return LLT{};
     679             : 
     680       51103 :   if (MI.isVariadic() || OpIdx >= MI.getNumExplicitOperands())
     681       10506 :     return MRI.getType(Op.getReg());
     682             : 
     683       40597 :   auto &OpInfo = MI.getDesc().OpInfo[OpIdx];
     684       81194 :   if (!OpInfo.isGenericType())
     685       33953 :     return MRI.getType(Op.getReg());
     686             : 
     687       26576 :   if (PrintedTypes[OpInfo.getGenericTypeIndex()])
     688        1520 :     return LLT{};
     689             : 
     690        5124 :   PrintedTypes.set(OpInfo.getGenericTypeIndex());
     691        5124 :   return MRI.getType(Op.getReg());
     692             : }
     693             : 
     694       21774 : void MIPrinter::print(const MachineInstr &MI) {
     695       21774 :   const auto *MF = MI.getParent()->getParent();
     696       21774 :   const auto &MRI = MF->getRegInfo();
     697       21774 :   const auto &SubTarget = MF->getSubtarget();
     698       21774 :   const auto *TRI = SubTarget.getRegisterInfo();
     699             :   assert(TRI && "Expected target register info");
     700       21774 :   const auto *TII = SubTarget.getInstrInfo();
     701             :   assert(TII && "Expected target instruction info");
     702       21774 :   if (MI.isCFIInstruction())
     703             :     assert(MI.getNumOperands() == 1 && "Expected 1 operand in CFI instruction");
     704             : 
     705       43548 :   SmallBitVector PrintedTypes(8);
     706       21774 :   bool ShouldPrintRegisterTies = hasComplexRegisterTies(MI);
     707       21774 :   unsigned I = 0, E = MI.getNumOperands();
     708      175228 :   for (; I < E && MI.getOperand(I).isReg() && MI.getOperand(I).isDef() &&
     709       32262 :          !MI.getOperand(I).isImplicit();
     710             :        ++I) {
     711       16024 :     if (I)
     712         298 :       OS << ", ";
     713       32048 :     print(MI.getOperand(I), TRI, I, ShouldPrintRegisterTies,
     714             :           getTypeToPrint(MI, I, PrintedTypes, MRI),
     715             :           /*IsDef=*/true);
     716             :   }
     717             : 
     718       21774 :   if (I)
     719       15726 :     OS << " = ";
     720       21774 :   if (MI.getFlag(MachineInstr::FrameSetup))
     721         166 :     OS << "frame-setup ";
     722       65322 :   OS << TII->getName(MI.getOpcode());
     723       21774 :   if (I < E)
     724       20911 :     OS << ' ';
     725             : 
     726             :   bool NeedComma = false;
     727      122754 :   for (; I < E; ++I) {
     728       50490 :     if (NeedComma)
     729       29579 :       OS << ", ";
     730      100980 :     print(MI.getOperand(I), TRI, I, ShouldPrintRegisterTies,
     731             :           getTypeToPrint(MI, I, PrintedTypes, MRI));
     732       50490 :     NeedComma = true;
     733             :   }
     734             : 
     735       43548 :   if (MI.getDebugLoc()) {
     736         634 :     if (NeedComma)
     737         630 :       OS << ',';
     738         634 :     OS << " debug-location ";
     739        1268 :     MI.getDebugLoc()->printAsOperand(OS, MST);
     740             :   }
     741             : 
     742       21774 :   if (!MI.memoperands_empty()) {
     743        1385 :     OS << " :: ";
     744        1385 :     const LLVMContext &Context = MF->getFunction()->getContext();
     745        1385 :     bool NeedComma = false;
     746        2796 :     for (const auto *Op : MI.memoperands()) {
     747        1411 :       if (NeedComma)
     748          26 :         OS << ", ";
     749        1411 :       print(Context, *TII, *Op);
     750        1411 :       NeedComma = true;
     751             :     }
     752             :   }
     753       21774 : }
     754             : 
     755        2063 : void MIPrinter::printMBBReference(const MachineBasicBlock &MBB) {
     756        4126 :   OS << "%bb." << MBB.getNumber();
     757        2063 :   if (const auto *BB = MBB.getBasicBlock()) {
     758        2288 :     if (BB->hasName())
     759        2278 :       OS << '.' << BB->getName();
     760             :   }
     761        2063 : }
     762             : 
     763          10 : static void printIRSlotNumber(raw_ostream &OS, int Slot) {
     764          10 :   if (Slot == -1)
     765           0 :     OS << "<badref>";
     766             :   else
     767             :     OS << Slot;
     768          10 : }
     769             : 
     770           5 : void MIPrinter::printIRBlockReference(const BasicBlock &BB) {
     771           5 :   OS << "%ir-block.";
     772          10 :   if (BB.hasName()) {
     773           3 :     printLLVMNameWithoutPrefix(OS, BB.getName());
     774           3 :     return;
     775             :   }
     776           2 :   const Function *F = BB.getParent();
     777             :   int Slot;
     778           2 :   if (F == MST.getCurrentFunction()) {
     779           1 :     Slot = MST.getLocalSlot(&BB);
     780             :   } else {
     781             :     ModuleSlotTracker CustomMST(F->getParent(),
     782           2 :                                 /*ShouldInitializeAllMetadata=*/false);
     783           1 :     CustomMST.incorporateFunction(*F);
     784           1 :     Slot = CustomMST.getLocalSlot(&BB);
     785             :   }
     786           2 :   printIRSlotNumber(OS, Slot);
     787             : }
     788             : 
     789         695 : void MIPrinter::printIRValueReference(const Value &V) {
     790         583 :   if (isa<GlobalValue>(V)) {
     791         112 :     V.printAsOperand(OS, /*PrintType=*/false, MST);
     792         112 :     return;
     793             :   }
     794         133 :   if (isa<Constant>(V)) {
     795             :     // Machine memory operands can load/store to/from constant value pointers.
     796         266 :     OS << '`';
     797         133 :     V.printAsOperand(OS, /*PrintType=*/true, MST);
     798         133 :     OS << '`';
     799             :     return;
     800             :   }
     801         450 :   OS << "%ir.";
     802         450 :   if (V.hasName()) {
     803         442 :     printLLVMNameWithoutPrefix(OS, V.getName());
     804         442 :     return;
     805             :   }
     806           8 :   printIRSlotNumber(OS, MST.getLocalSlot(&V));
     807             : }
     808             : 
     809         672 : void MIPrinter::printStackObjectReference(int FrameIndex) {
     810         672 :   auto ObjectInfo = StackObjectOperandMapping.find(FrameIndex);
     811             :   assert(ObjectInfo != StackObjectOperandMapping.end() &&
     812             :          "Invalid frame index");
     813         672 :   const FrameIndexOperand &Operand = ObjectInfo->second;
     814         672 :   if (Operand.IsFixed) {
     815         890 :     OS << "%fixed-stack." << Operand.ID;
     816         445 :     return;
     817             :   }
     818         454 :   OS << "%stack." << Operand.ID;
     819         454 :   if (!Operand.Name.empty())
     820         138 :     OS << '.' << Operand.Name;
     821             : }
     822             : 
     823        1954 : void MIPrinter::printOffset(int64_t Offset) {
     824        1954 :   if (Offset == 0)
     825             :     return;
     826         132 :   if (Offset < 0) {
     827           3 :     OS << " - " << -Offset;
     828           3 :     return;
     829             :   }
     830         129 :   OS << " + " << Offset;
     831             : }
     832             : 
     833             : static const char *getTargetFlagName(const TargetInstrInfo *TII, unsigned TF) {
     834          42 :   auto Flags = TII->getSerializableDirectMachineOperandTargetFlags();
     835         177 :   for (const auto &I : Flags) {
     836         135 :     if (I.first == TF) {
     837          42 :       return I.second;
     838             :     }
     839             :   }
     840             :   return nullptr;
     841             : }
     842             : 
     843       66514 : void MIPrinter::printTargetFlags(const MachineOperand &Op) {
     844       15411 :   if (!Op.getTargetFlags())
     845       66498 :     return;
     846             :   const auto *TII =
     847          59 :       Op.getParent()->getParent()->getParent()->getSubtarget().getInstrInfo();
     848             :   assert(TII && "expected instruction info");
     849         118 :   auto Flags = TII->decomposeMachineOperandsTargetFlags(Op.getTargetFlags());
     850          59 :   OS << "target-flags(";
     851          59 :   const bool HasDirectFlags = Flags.first;
     852          59 :   const bool HasBitmaskFlags = Flags.second;
     853          59 :   if (!HasDirectFlags && !HasBitmaskFlags) {
     854          12 :     OS << "<unknown>) ";
     855          12 :     return;
     856             :   }
     857          47 :   if (HasDirectFlags) {
     858          84 :     if (const auto *Name = getTargetFlagName(TII, Flags.first))
     859          42 :       OS << Name;
     860             :     else
     861           0 :       OS << "<unknown target flag>";
     862             :   }
     863          47 :   if (!HasBitmaskFlags) {
     864          31 :     OS << ") ";
     865          31 :     return;
     866             :   }
     867          16 :   bool IsCommaNeeded = HasDirectFlags;
     868          16 :   unsigned BitMask = Flags.second;
     869          16 :   auto BitMasks = TII->getSerializableBitmaskMachineOperandTargetFlags();
     870          74 :   for (const auto &Mask : BitMasks) {
     871             :     // Check if the flag's bitmask has the bits of the current mask set.
     872          42 :     if ((BitMask & Mask.first) == Mask.first) {
     873          17 :       if (IsCommaNeeded)
     874          12 :         OS << ", ";
     875          17 :       IsCommaNeeded = true;
     876          17 :       OS << Mask.second;
     877             :       // Clear the bits which were serialized from the flag's bitmask.
     878          17 :       BitMask &= ~(Mask.first);
     879             :     }
     880             :   }
     881          16 :   if (BitMask) {
     882             :     // When the resulting flag's bitmask isn't zero, we know that we didn't
     883             :     // serialize all of the bit flags.
     884           0 :     if (IsCommaNeeded)
     885           0 :       OS << ", ";
     886           0 :     OS << "<unknown bitmask target flag>";
     887             :   }
     888          16 :   OS << ") ";
     889             : }
     890             : 
     891           2 : static const char *getTargetIndexName(const MachineFunction &MF, int Index) {
     892           2 :   const auto *TII = MF.getSubtarget().getInstrInfo();
     893             :   assert(TII && "expected instruction info");
     894           2 :   auto Indices = TII->getSerializableTargetIndices();
     895           4 :   for (const auto &I : Indices) {
     896           2 :     if (I.first == Index) {
     897           2 :       return I.second;
     898             :     }
     899             :   }
     900             :   return nullptr;
     901             : }
     902             : 
     903       66514 : void MIPrinter::print(const MachineOperand &Op, const TargetRegisterInfo *TRI,
     904             :                       unsigned I, bool ShouldPrintRegisterTies, LLT TypeToPrint,
     905             :                       bool IsDef) {
     906       66514 :   printTargetFlags(Op);
     907       66514 :   switch (Op.getType()) {
     908       51103 :   case MachineOperand::MO_Register:
     909       51103 :     if (Op.isImplicit())
     910       15240 :       OS << (Op.isDef() ? "implicit-def " : "implicit ");
     911       70942 :     else if (!IsDef && Op.isDef())
     912             :       // Print the 'def' flag only when the operand is defined after '='.
     913          35 :       OS << "def ";
     914       51103 :     if (Op.isInternalRead())
     915           8 :       OS << "internal ";
     916       51103 :     if (Op.isDead())
     917         942 :       OS << "dead ";
     918       51103 :     if (Op.isKill())
     919        1727 :       OS << "killed ";
     920       51103 :     if (Op.isUndef())
     921         348 :       OS << "undef ";
     922       51103 :     if (Op.isEarlyClobber())
     923         114 :       OS << "early-clobber ";
     924       51103 :     if (Op.isDebug())
     925         575 :       OS << "debug-use ";
     926       51103 :     printReg(Op.getReg(), OS, TRI);
     927             :     // Print the sub register.
     928       51103 :     if (Op.getSubReg() != 0)
     929        1540 :       OS << '.' << TRI->getSubRegIndexName(Op.getSubReg());
     930       51146 :     if (ShouldPrintRegisterTies && Op.isTied() && !Op.isDef())
     931          16 :       OS << "(tied-def " << Op.getParent()->findTiedOperandIdx(I) << ")";
     932       51103 :     if (TypeToPrint.isValid())
     933       29544 :       OS << '(' << TypeToPrint << ')';
     934             :     break;
     935       11877 :   case MachineOperand::MO_Immediate:
     936       11877 :     OS << Op.getImm();
     937       11877 :     break;
     938         513 :   case MachineOperand::MO_CImmediate:
     939         513 :     Op.getCImm()->printAsOperand(OS, /*PrintType=*/true, MST);
     940         513 :     break;
     941          40 :   case MachineOperand::MO_FPImmediate:
     942          40 :     Op.getFPImm()->printAsOperand(OS, /*PrintType=*/true, MST);
     943          40 :     break;
     944         829 :   case MachineOperand::MO_MachineBasicBlock:
     945         829 :     printMBBReference(*Op.getMBB());
     946         829 :     break;
     947         318 :   case MachineOperand::MO_FrameIndex:
     948         318 :     printStackObjectReference(Op.getIndex());
     949         318 :     break;
     950          32 :   case MachineOperand::MO_ConstantPoolIndex:
     951          64 :     OS << "%const." << Op.getIndex();
     952          64 :     printOffset(Op.getOffset());
     953          32 :     break;
     954           2 :   case MachineOperand::MO_TargetIndex:
     955           2 :     OS << "target-index(";
     956           4 :     if (const auto *Name = getTargetIndexName(
     957           2 :             *Op.getParent()->getParent()->getParent(), Op.getIndex()))
     958           2 :       OS << Name;
     959             :     else
     960           0 :       OS << "<unknown>";
     961           4 :     OS << ')';
     962           4 :     printOffset(Op.getOffset());
     963           2 :     break;
     964          13 :   case MachineOperand::MO_JumpTableIndex:
     965          13 :     OS << "%jump-table." << Op.getIndex();
     966             :     break;
     967         158 :   case MachineOperand::MO_ExternalSymbol: {
     968         316 :     StringRef Name = Op.getSymbolName();
     969         316 :     OS << '$';
     970         158 :     if (Name.empty()) {
     971           1 :       OS << "\"\"";
     972             :     } else {
     973         157 :       printLLVMNameWithoutPrefix(OS, Name);
     974             :     }
     975         316 :     printOffset(Op.getOffset());
     976             :     break;
     977             :   }
     978         346 :   case MachineOperand::MO_GlobalAddress:
     979         346 :     Op.getGlobal()->printAsOperand(OS, /*PrintType=*/false, MST);
     980         692 :     printOffset(Op.getOffset());
     981         346 :     break;
     982           5 :   case MachineOperand::MO_BlockAddress:
     983           5 :     OS << "blockaddress(";
     984          10 :     Op.getBlockAddress()->getFunction()->printAsOperand(OS, /*PrintType=*/false,
     985             :                                                         MST);
     986           5 :     OS << ", ";
     987          10 :     printIRBlockReference(*Op.getBlockAddress()->getBasicBlock());
     988          10 :     OS << ')';
     989          10 :     printOffset(Op.getOffset());
     990           5 :     break;
     991         292 :   case MachineOperand::MO_RegisterMask: {
     992         292 :     auto RegMaskInfo = RegisterMaskIds.find(Op.getRegMask());
     993         584 :     if (RegMaskInfo != RegisterMaskIds.end())
     994        1450 :       OS << StringRef(TRI->getRegMaskNames()[RegMaskInfo->second]).lower();
     995             :     else
     996           2 :       printCustomRegMask(Op.getRegMask(), OS, TRI);
     997             :     break;
     998             :   }
     999           1 :   case MachineOperand::MO_RegisterLiveOut: {
    1000           1 :     const uint32_t *RegMask = Op.getRegLiveOut();
    1001           1 :     OS << "liveout(";
    1002           1 :     bool IsCommaNeeded = false;
    1003         247 :     for (unsigned Reg = 0, E = TRI->getNumRegs(); Reg < E; ++Reg) {
    1004         246 :       if (RegMask[Reg / 32] & (1U << (Reg % 32))) {
    1005           4 :         if (IsCommaNeeded)
    1006           3 :           OS << ", ";
    1007           4 :         printReg(Reg, OS, TRI);
    1008           4 :         IsCommaNeeded = true;
    1009             :       }
    1010             :     }
    1011           1 :     OS << ")";
    1012           1 :     break;
    1013             :   }
    1014         682 :   case MachineOperand::MO_Metadata:
    1015         682 :     Op.getMetadata()->printAsOperand(OS, MST);
    1016         682 :     break;
    1017          12 :   case MachineOperand::MO_MCSymbol:
    1018          24 :     OS << "<mcsymbol " << *Op.getMCSymbol() << ">";
    1019          12 :     break;
    1020         145 :   case MachineOperand::MO_CFIIndex: {
    1021         145 :     const MachineFunction &MF = *Op.getParent()->getParent()->getParent();
    1022         290 :     print(MF.getFrameInstructions()[Op.getCFIIndex()], TRI);
    1023         145 :     break;
    1024             :   }
    1025          10 :   case MachineOperand::MO_IntrinsicID: {
    1026          10 :     Intrinsic::ID ID = Op.getIntrinsicID();
    1027          10 :     if (ID < Intrinsic::num_intrinsics)
    1028          50 :       OS << "intrinsic(@" << Intrinsic::getName(ID, None) << ')';
    1029             :     else {
    1030           0 :       const MachineFunction &MF = *Op.getParent()->getParent()->getParent();
    1031           0 :       const TargetIntrinsicInfo *TII = MF.getTarget().getIntrinsicInfo();
    1032           0 :       OS << "intrinsic(@" << TII->getName(ID) << ')';
    1033             :     }
    1034             :     break;
    1035             :   }
    1036         136 :   case MachineOperand::MO_Predicate: {
    1037         136 :     auto Pred = static_cast<CmpInst::Predicate>(Op.getPredicate());
    1038         272 :     OS << (CmpInst::isIntPredicate(Pred) ? "int" : "float") << "pred("
    1039         136 :        << CmpInst::getPredicateName(Pred) << ')';
    1040             :     break;
    1041             :   }
    1042             :   }
    1043       66514 : }
    1044             : 
    1045             : static const char *getTargetMMOFlagName(const TargetInstrInfo &TII,
    1046             :                                         unsigned TMMOFlag) {
    1047           6 :   auto Flags = TII.getSerializableMachineMemOperandTargetFlags();
    1048          16 :   for (const auto &I : Flags) {
    1049          10 :     if (I.first == TMMOFlag) {
    1050           6 :       return I.second;
    1051             :     }
    1052             :   }
    1053             :   return nullptr;
    1054             : }
    1055             : 
    1056        1411 : void MIPrinter::print(const LLVMContext &Context, const TargetInstrInfo &TII,
    1057             :                       const MachineMemOperand &Op) {
    1058        2822 :   OS << '(';
    1059        2822 :   if (Op.isVolatile())
    1060          96 :     OS << "volatile ";
    1061        2822 :   if (Op.isNonTemporal())
    1062          55 :     OS << "non-temporal ";
    1063        2822 :   if (Op.isDereferenceable())
    1064          73 :     OS << "dereferenceable ";
    1065        2822 :   if (Op.isInvariant())
    1066         127 :     OS << "invariant ";
    1067        2822 :   if (Op.getFlags() & MachineMemOperand::MOTargetFlag1)
    1068           6 :     OS << '"' << getTargetMMOFlagName(TII, MachineMemOperand::MOTargetFlag1)
    1069           2 :        << "\" ";
    1070        2822 :   if (Op.getFlags() & MachineMemOperand::MOTargetFlag2)
    1071          12 :     OS << '"' << getTargetMMOFlagName(TII, MachineMemOperand::MOTargetFlag2)
    1072           4 :        << "\" ";
    1073        2822 :   if (Op.getFlags() & MachineMemOperand::MOTargetFlag3)
    1074           0 :     OS << '"' << getTargetMMOFlagName(TII, MachineMemOperand::MOTargetFlag3)
    1075           0 :        << "\" ";
    1076        2822 :   if (Op.isLoad())
    1077         831 :     OS << "load ";
    1078             :   else {
    1079             :     assert(Op.isStore() && "Non load machine operand must be a store");
    1080         580 :     OS << "store ";
    1081             :   }
    1082             : 
    1083        1411 :   printSyncScope(Context, Op.getSyncScopeID());
    1084             : 
    1085        1411 :   if (Op.getOrdering() != AtomicOrdering::NotAtomic)
    1086          44 :     OS << toIRString(Op.getOrdering()) << ' ';
    1087        1411 :   if (Op.getFailureOrdering() != AtomicOrdering::NotAtomic)
    1088           0 :     OS << toIRString(Op.getFailureOrdering()) << ' ';
    1089             : 
    1090        1411 :   OS << Op.getSize();
    1091         880 :   if (const Value *Val = Op.getValue()) {
    1092        1390 :     OS << (Op.isLoad() ? " from " : " into ");
    1093         695 :     printIRValueReference(*Val);
    1094         531 :   } else if (const PseudoSourceValue *PVal = Op.getPseudoValue()) {
    1095        1062 :     OS << (Op.isLoad() ? " from " : " into ");
    1096             :     assert(PVal && "Expected a pseudo source value");
    1097         531 :     switch (PVal->kind()) {
    1098         138 :     case PseudoSourceValue::Stack:
    1099         138 :       OS << "stack";
    1100         138 :       break;
    1101          13 :     case PseudoSourceValue::GOT:
    1102          13 :       OS << "got";
    1103          13 :       break;
    1104           3 :     case PseudoSourceValue::JumpTable:
    1105           3 :       OS << "jump-table";
    1106           3 :       break;
    1107          20 :     case PseudoSourceValue::ConstantPool:
    1108          20 :       OS << "constant-pool";
    1109          20 :       break;
    1110         353 :     case PseudoSourceValue::FixedStack:
    1111         353 :       printStackObjectReference(
    1112             :           cast<FixedStackPseudoSourceValue>(PVal)->getFrameIndex());
    1113         353 :       break;
    1114           3 :     case PseudoSourceValue::GlobalValueCallEntry:
    1115           3 :       OS << "call-entry ";
    1116           3 :       cast<GlobalValuePseudoSourceValue>(PVal)->getValue()->printAsOperand(
    1117             :           OS, /*PrintType=*/false, MST);
    1118           3 :       break;
    1119           1 :     case PseudoSourceValue::ExternalSymbolCallEntry:
    1120           1 :       OS << "call-entry $";
    1121           2 :       printLLVMNameWithoutPrefix(
    1122             :           OS, cast<ExternalSymbolPseudoSourceValue>(PVal)->getSymbol());
    1123           1 :       break;
    1124           0 :     case PseudoSourceValue::TargetCustom:
    1125           0 :       llvm_unreachable("TargetCustom pseudo source values are not supported");
    1126             :       break;
    1127             :     }
    1128             :   }
    1129        1411 :   printOffset(Op.getOffset());
    1130        2822 :   if (Op.getBaseAlignment() != Op.getSize())
    1131         920 :     OS << ", align " << Op.getBaseAlignment();
    1132        1411 :   auto AAInfo = Op.getAAInfo();
    1133        1411 :   if (AAInfo.TBAA) {
    1134          31 :     OS << ", !tbaa ";
    1135          31 :     AAInfo.TBAA->printAsOperand(OS, MST);
    1136             :   }
    1137        1411 :   if (AAInfo.Scope) {
    1138           1 :     OS << ", !alias.scope ";
    1139           1 :     AAInfo.Scope->printAsOperand(OS, MST);
    1140             :   }
    1141        1411 :   if (AAInfo.NoAlias) {
    1142           1 :     OS << ", !noalias ";
    1143           1 :     AAInfo.NoAlias->printAsOperand(OS, MST);
    1144             :   }
    1145        1411 :   if (Op.getRanges()) {
    1146           1 :     OS << ", !range ";
    1147           1 :     Op.getRanges()->printAsOperand(OS, MST);
    1148             :   }
    1149        2822 :   OS << ')';
    1150        1411 : }
    1151             : 
    1152        1411 : void MIPrinter::printSyncScope(const LLVMContext &Context, SyncScope::ID SSID) {
    1153        1411 :   switch (SSID) {
    1154             :   case SyncScope::System: {
    1155             :     break;
    1156             :   }
    1157          11 :   default: {
    1158          11 :     if (SSNs.empty())
    1159           5 :       Context.getSyncScopeNames(SSNs);
    1160             : 
    1161          11 :     OS << "syncscope(\"";
    1162          22 :     PrintEscapedString(SSNs[SSID], OS);
    1163          11 :     OS << "\") ";
    1164          11 :     break;
    1165             :   }
    1166             :   }
    1167        1411 : }
    1168             : 
    1169         101 : static void printCFIRegister(unsigned DwarfReg, raw_ostream &OS,
    1170             :                              const TargetRegisterInfo *TRI) {
    1171         101 :   int Reg = TRI->getLLVMRegNum(DwarfReg, true);
    1172         101 :   if (Reg == -1) {
    1173           0 :     OS << "<badreg>";
    1174           0 :     return;
    1175             :   }
    1176         101 :   printReg(Reg, OS, TRI);
    1177             : }
    1178             : 
    1179         145 : void MIPrinter::print(const MCCFIInstruction &CFI,
    1180             :                       const TargetRegisterInfo *TRI) {
    1181         145 :   switch (CFI.getOperation()) {
    1182           2 :   case MCCFIInstruction::OpSameValue:
    1183           2 :     OS << "same_value ";
    1184           2 :     if (CFI.getLabel())
    1185           0 :       OS << "<mcsymbol> ";
    1186           2 :     printCFIRegister(CFI.getRegister(), OS, TRI);
    1187           2 :     break;
    1188          89 :   case MCCFIInstruction::OpOffset:
    1189          89 :     OS << "offset ";
    1190          89 :     if (CFI.getLabel())
    1191           0 :       OS << "<mcsymbol> ";
    1192          89 :     printCFIRegister(CFI.getRegister(), OS, TRI);
    1193          89 :     OS << ", " << CFI.getOffset();
    1194             :     break;
    1195           9 :   case MCCFIInstruction::OpDefCfaRegister:
    1196           9 :     OS << "def_cfa_register ";
    1197           9 :     if (CFI.getLabel())
    1198           0 :       OS << "<mcsymbol> ";
    1199           9 :     printCFIRegister(CFI.getRegister(), OS, TRI);
    1200           9 :     break;
    1201          44 :   case MCCFIInstruction::OpDefCfaOffset:
    1202          44 :     OS << "def_cfa_offset ";
    1203          44 :     if (CFI.getLabel())
    1204           2 :       OS << "<mcsymbol> ";
    1205          44 :     OS << CFI.getOffset();
    1206             :     break;
    1207           1 :   case MCCFIInstruction::OpDefCfa:
    1208           1 :     OS << "def_cfa ";
    1209           1 :     if (CFI.getLabel())
    1210           0 :       OS << "<mcsymbol> ";
    1211           1 :     printCFIRegister(CFI.getRegister(), OS, TRI);
    1212           1 :     OS << ", " << CFI.getOffset();
    1213             :     break;
    1214           0 :   default:
    1215             :     // TODO: Print the other CFI Operations.
    1216           0 :     OS << "<unserializable cfi operation>";
    1217           0 :     break;
    1218             :   }
    1219         145 : }
    1220             : 
    1221         587 : void llvm::printMIR(raw_ostream &OS, const Module &M) {
    1222        1174 :   yaml::Output Out(OS);
    1223         587 :   Out << const_cast<Module &>(M);
    1224         587 : }
    1225             : 
    1226        2455 : void llvm::printMIR(raw_ostream &OS, const MachineFunction &MF) {
    1227        4910 :   MIRPrinter Printer(OS);
    1228        2455 :   Printer.print(MF);
    1229      219373 : }

Generated by: LCOV version 1.13