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/CodeGen/MIRPrinter.h"
16 #include "llvm/ADT/DenseMap.h"
17 #include "llvm/ADT/None.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/SmallBitVector.h"
20 #include "llvm/ADT/SmallPtrSet.h"
21 #include "llvm/ADT/SmallVector.h"
22 #include "llvm/ADT/StringRef.h"
23 #include "llvm/ADT/Twine.h"
24 #include "llvm/CodeGen/GlobalISel/RegisterBank.h"
25 #include "llvm/CodeGen/MIRYamlMapping.h"
26 #include "llvm/CodeGen/MachineBasicBlock.h"
27 #include "llvm/CodeGen/MachineConstantPool.h"
28 #include "llvm/CodeGen/MachineFrameInfo.h"
29 #include "llvm/CodeGen/MachineFunction.h"
30 #include "llvm/CodeGen/MachineInstr.h"
31 #include "llvm/CodeGen/MachineJumpTableInfo.h"
32 #include "llvm/CodeGen/MachineMemOperand.h"
33 #include "llvm/CodeGen/MachineOperand.h"
34 #include "llvm/CodeGen/MachineRegisterInfo.h"
35 #include "llvm/CodeGen/PseudoSourceValue.h"
36 #include "llvm/CodeGen/TargetInstrInfo.h"
37 #include "llvm/CodeGen/TargetRegisterInfo.h"
38 #include "llvm/CodeGen/TargetSubtargetInfo.h"
39 #include "llvm/IR/BasicBlock.h"
40 #include "llvm/IR/Constants.h"
41 #include "llvm/IR/DebugInfo.h"
42 #include "llvm/IR/DebugLoc.h"
43 #include "llvm/IR/Function.h"
44 #include "llvm/IR/GlobalValue.h"
45 #include "llvm/IR/IRPrintingPasses.h"
46 #include "llvm/IR/InstrTypes.h"
47 #include "llvm/IR/Instructions.h"
48 #include "llvm/IR/Intrinsics.h"
49 #include "llvm/IR/Module.h"
50 #include "llvm/IR/ModuleSlotTracker.h"
51 #include "llvm/IR/Value.h"
52 #include "llvm/MC/LaneBitmask.h"
53 #include "llvm/MC/MCContext.h"
54 #include "llvm/MC/MCDwarf.h"
55 #include "llvm/MC/MCSymbol.h"
56 #include "llvm/Support/AtomicOrdering.h"
57 #include "llvm/Support/BranchProbability.h"
58 #include "llvm/Support/Casting.h"
59 #include "llvm/Support/CommandLine.h"
60 #include "llvm/Support/ErrorHandling.h"
61 #include "llvm/Support/Format.h"
62 #include "llvm/Support/LowLevelTypeImpl.h"
63 #include "llvm/Support/YAMLTraits.h"
64 #include "llvm/Support/raw_ostream.h"
65 #include "llvm/Target/TargetIntrinsicInfo.h"
66 #include "llvm/Target/TargetMachine.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 static cl::opt<bool> SimplifyMIR(
79     "simplify-mir", cl::Hidden,
80     cl::desc("Leave out unnecessary information when printing MIR"));
81 
82 namespace {
83 
84 /// This structure describes how to print out stack object references.
85 struct FrameIndexOperand {
86   std::string Name;
87   unsigned ID;
88   bool IsFixed;
89 
90   FrameIndexOperand(StringRef Name, unsigned ID, bool IsFixed)
91       : Name(Name.str()), ID(ID), IsFixed(IsFixed) {}
92 
93   /// Return an ordinary stack object reference.
94   static FrameIndexOperand create(StringRef Name, unsigned ID) {
95     return FrameIndexOperand(Name, ID, /*IsFixed=*/false);
96   }
97 
98   /// Return a fixed stack object reference.
99   static FrameIndexOperand createFixed(unsigned ID) {
100     return FrameIndexOperand("", ID, /*IsFixed=*/true);
101   }
102 };
103 
104 } // end anonymous namespace
105 
106 namespace llvm {
107 
108 /// This class prints out the machine functions using the MIR serialization
109 /// format.
110 class MIRPrinter {
111   raw_ostream &OS;
112   DenseMap<const uint32_t *, unsigned> RegisterMaskIds;
113   /// Maps from stack object indices to operand indices which will be used when
114   /// printing frame index machine operands.
115   DenseMap<int, FrameIndexOperand> StackObjectOperandMapping;
116 
117 public:
118   MIRPrinter(raw_ostream &OS) : OS(OS) {}
119 
120   void print(const MachineFunction &MF);
121 
122   void convert(yaml::MachineFunction &MF, const MachineRegisterInfo &RegInfo,
123                const TargetRegisterInfo *TRI);
124   void convert(ModuleSlotTracker &MST, yaml::MachineFrameInfo &YamlMFI,
125                const MachineFrameInfo &MFI);
126   void convert(yaml::MachineFunction &MF,
127                const MachineConstantPool &ConstantPool);
128   void convert(ModuleSlotTracker &MST, yaml::MachineJumpTable &YamlJTI,
129                const MachineJumpTableInfo &JTI);
130   void convertStackObjects(yaml::MachineFunction &YMF,
131                            const MachineFunction &MF, ModuleSlotTracker &MST);
132 
133 private:
134   void initRegisterMaskIds(const MachineFunction &MF);
135 };
136 
137 /// This class prints out the machine instructions using the MIR serialization
138 /// format.
139 class MIPrinter {
140   raw_ostream &OS;
141   ModuleSlotTracker &MST;
142   const DenseMap<const uint32_t *, unsigned> &RegisterMaskIds;
143   const DenseMap<int, FrameIndexOperand> &StackObjectOperandMapping;
144   /// Synchronization scope names registered with LLVMContext.
145   SmallVector<StringRef, 8> SSNs;
146 
147   bool canPredictBranchProbabilities(const MachineBasicBlock &MBB) const;
148   bool canPredictSuccessors(const MachineBasicBlock &MBB) const;
149 
150 public:
151   MIPrinter(raw_ostream &OS, ModuleSlotTracker &MST,
152             const DenseMap<const uint32_t *, unsigned> &RegisterMaskIds,
153             const DenseMap<int, FrameIndexOperand> &StackObjectOperandMapping)
154       : OS(OS), MST(MST), RegisterMaskIds(RegisterMaskIds),
155         StackObjectOperandMapping(StackObjectOperandMapping) {}
156 
157   void print(const MachineBasicBlock &MBB);
158 
159   void print(const MachineInstr &MI);
160   void printStackObjectReference(int FrameIndex);
161   void print(const MachineInstr &MI, unsigned OpIdx,
162              const TargetRegisterInfo *TRI, bool ShouldPrintRegisterTies,
163              LLT TypeToPrint, bool PrintDef = true);
164 };
165 
166 } // end namespace llvm
167 
168 namespace llvm {
169 namespace yaml {
170 
171 /// This struct serializes the LLVM IR module.
172 template <> struct BlockScalarTraits<Module> {
173   static void output(const Module &Mod, void *Ctxt, raw_ostream &OS) {
174     Mod.print(OS, nullptr);
175   }
176 
177   static StringRef input(StringRef Str, void *Ctxt, Module &Mod) {
178     llvm_unreachable("LLVM Module is supposed to be parsed separately");
179     return "";
180   }
181 };
182 
183 } // end namespace yaml
184 } // end namespace llvm
185 
186 static void printRegMIR(unsigned Reg, yaml::StringValue &Dest,
187                         const TargetRegisterInfo *TRI) {
188   raw_string_ostream OS(Dest.Value);
189   OS << printReg(Reg, TRI);
190 }
191 
192 void MIRPrinter::print(const MachineFunction &MF) {
193   initRegisterMaskIds(MF);
194 
195   yaml::MachineFunction YamlMF;
196   YamlMF.Name = MF.getName();
197   YamlMF.Alignment = MF.getAlignment();
198   YamlMF.ExposesReturnsTwice = MF.exposesReturnsTwice();
199   YamlMF.HasWinCFI = MF.hasWinCFI();
200 
201   YamlMF.Legalized = MF.getProperties().hasProperty(
202       MachineFunctionProperties::Property::Legalized);
203   YamlMF.RegBankSelected = MF.getProperties().hasProperty(
204       MachineFunctionProperties::Property::RegBankSelected);
205   YamlMF.Selected = MF.getProperties().hasProperty(
206       MachineFunctionProperties::Property::Selected);
207   YamlMF.FailedISel = MF.getProperties().hasProperty(
208       MachineFunctionProperties::Property::FailedISel);
209 
210   convert(YamlMF, MF.getRegInfo(), MF.getSubtarget().getRegisterInfo());
211   ModuleSlotTracker MST(MF.getFunction().getParent());
212   MST.incorporateFunction(MF.getFunction());
213   convert(MST, YamlMF.FrameInfo, MF.getFrameInfo());
214   convertStackObjects(YamlMF, MF, MST);
215   if (const auto *ConstantPool = MF.getConstantPool())
216     convert(YamlMF, *ConstantPool);
217   if (const auto *JumpTableInfo = MF.getJumpTableInfo())
218     convert(MST, YamlMF.JumpTableInfo, *JumpTableInfo);
219   raw_string_ostream StrOS(YamlMF.Body.Value.Value);
220   bool IsNewlineNeeded = false;
221   for (const auto &MBB : MF) {
222     if (IsNewlineNeeded)
223       StrOS << "\n";
224     MIPrinter(StrOS, MST, RegisterMaskIds, StackObjectOperandMapping)
225         .print(MBB);
226     IsNewlineNeeded = true;
227   }
228   StrOS.flush();
229   yaml::Output Out(OS);
230   if (!SimplifyMIR)
231       Out.setWriteDefaultValues(true);
232   Out << YamlMF;
233 }
234 
235 static void printCustomRegMask(const uint32_t *RegMask, raw_ostream &OS,
236                                const TargetRegisterInfo *TRI) {
237   assert(RegMask && "Can't print an empty register mask");
238   OS << StringRef("CustomRegMask(");
239 
240   bool IsRegInRegMaskFound = false;
241   for (int I = 0, E = TRI->getNumRegs(); I < E; I++) {
242     // Check whether the register is asserted in regmask.
243     if (RegMask[I / 32] & (1u << (I % 32))) {
244       if (IsRegInRegMaskFound)
245         OS << ',';
246       OS << printReg(I, TRI);
247       IsRegInRegMaskFound = true;
248     }
249   }
250 
251   OS << ')';
252 }
253 
254 static void printRegClassOrBank(unsigned Reg, yaml::StringValue &Dest,
255                                 const MachineRegisterInfo &RegInfo,
256                                 const TargetRegisterInfo *TRI) {
257   raw_string_ostream OS(Dest.Value);
258   OS << printRegClassOrBank(Reg, RegInfo, TRI);
259 }
260 
261 template <typename T>
262 static void
263 printStackObjectDbgInfo(const MachineFunction::VariableDbgInfo &DebugVar,
264                         T &Object, ModuleSlotTracker &MST) {
265   std::array<std::string *, 3> Outputs{{&Object.DebugVar.Value,
266                                         &Object.DebugExpr.Value,
267                                         &Object.DebugLoc.Value}};
268   std::array<const Metadata *, 3> Metas{{DebugVar.Var,
269                                         DebugVar.Expr,
270                                         DebugVar.Loc}};
271   for (unsigned i = 0; i < 3; ++i) {
272     raw_string_ostream StrOS(*Outputs[i]);
273     Metas[i]->printAsOperand(StrOS, MST);
274   }
275 }
276 
277 void MIRPrinter::convert(yaml::MachineFunction &MF,
278                          const MachineRegisterInfo &RegInfo,
279                          const TargetRegisterInfo *TRI) {
280   MF.TracksRegLiveness = RegInfo.tracksLiveness();
281 
282   // Print the virtual register definitions.
283   for (unsigned I = 0, E = RegInfo.getNumVirtRegs(); I < E; ++I) {
284     unsigned Reg = TargetRegisterInfo::index2VirtReg(I);
285     yaml::VirtualRegisterDefinition VReg;
286     VReg.ID = I;
287     if (RegInfo.getVRegName(Reg) != "")
288       continue;
289     ::printRegClassOrBank(Reg, VReg.Class, RegInfo, TRI);
290     unsigned PreferredReg = RegInfo.getSimpleHint(Reg);
291     if (PreferredReg)
292       printRegMIR(PreferredReg, VReg.PreferredRegister, TRI);
293     MF.VirtualRegisters.push_back(VReg);
294   }
295 
296   // Print the live ins.
297   for (std::pair<unsigned, unsigned> LI : RegInfo.liveins()) {
298     yaml::MachineFunctionLiveIn LiveIn;
299     printRegMIR(LI.first, LiveIn.Register, TRI);
300     if (LI.second)
301       printRegMIR(LI.second, LiveIn.VirtualRegister, TRI);
302     MF.LiveIns.push_back(LiveIn);
303   }
304 
305   // Prints the callee saved registers.
306   if (RegInfo.isUpdatedCSRsInitialized()) {
307     const MCPhysReg *CalleeSavedRegs = RegInfo.getCalleeSavedRegs();
308     std::vector<yaml::FlowStringValue> CalleeSavedRegisters;
309     for (const MCPhysReg *I = CalleeSavedRegs; *I; ++I) {
310       yaml::FlowStringValue Reg;
311       printRegMIR(*I, Reg, TRI);
312       CalleeSavedRegisters.push_back(Reg);
313     }
314     MF.CalleeSavedRegisters = CalleeSavedRegisters;
315   }
316 }
317 
318 void MIRPrinter::convert(ModuleSlotTracker &MST,
319                          yaml::MachineFrameInfo &YamlMFI,
320                          const MachineFrameInfo &MFI) {
321   YamlMFI.IsFrameAddressTaken = MFI.isFrameAddressTaken();
322   YamlMFI.IsReturnAddressTaken = MFI.isReturnAddressTaken();
323   YamlMFI.HasStackMap = MFI.hasStackMap();
324   YamlMFI.HasPatchPoint = MFI.hasPatchPoint();
325   YamlMFI.StackSize = MFI.getStackSize();
326   YamlMFI.OffsetAdjustment = MFI.getOffsetAdjustment();
327   YamlMFI.MaxAlignment = MFI.getMaxAlignment();
328   YamlMFI.AdjustsStack = MFI.adjustsStack();
329   YamlMFI.HasCalls = MFI.hasCalls();
330   YamlMFI.MaxCallFrameSize = MFI.isMaxCallFrameSizeComputed()
331     ? MFI.getMaxCallFrameSize() : ~0u;
332   YamlMFI.CVBytesOfCalleeSavedRegisters =
333       MFI.getCVBytesOfCalleeSavedRegisters();
334   YamlMFI.HasOpaqueSPAdjustment = MFI.hasOpaqueSPAdjustment();
335   YamlMFI.HasVAStart = MFI.hasVAStart();
336   YamlMFI.HasMustTailInVarArgFunc = MFI.hasMustTailInVarArgFunc();
337   YamlMFI.LocalFrameSize = MFI.getLocalFrameSize();
338   if (MFI.getSavePoint()) {
339     raw_string_ostream StrOS(YamlMFI.SavePoint.Value);
340     StrOS << printMBBReference(*MFI.getSavePoint());
341   }
342   if (MFI.getRestorePoint()) {
343     raw_string_ostream StrOS(YamlMFI.RestorePoint.Value);
344     StrOS << printMBBReference(*MFI.getRestorePoint());
345   }
346 }
347 
348 void MIRPrinter::convertStackObjects(yaml::MachineFunction &YMF,
349                                      const MachineFunction &MF,
350                                      ModuleSlotTracker &MST) {
351   const MachineFrameInfo &MFI = MF.getFrameInfo();
352   const TargetRegisterInfo *TRI = MF.getSubtarget().getRegisterInfo();
353   // Process fixed stack objects.
354   unsigned ID = 0;
355   for (int I = MFI.getObjectIndexBegin(); I < 0; ++I) {
356     if (MFI.isDeadObjectIndex(I))
357       continue;
358 
359     yaml::FixedMachineStackObject YamlObject;
360     YamlObject.ID = ID;
361     YamlObject.Type = MFI.isSpillSlotObjectIndex(I)
362                           ? yaml::FixedMachineStackObject::SpillSlot
363                           : yaml::FixedMachineStackObject::DefaultType;
364     YamlObject.Offset = MFI.getObjectOffset(I);
365     YamlObject.Size = MFI.getObjectSize(I);
366     YamlObject.Alignment = MFI.getObjectAlignment(I);
367     YamlObject.StackID = MFI.getStackID(I);
368     YamlObject.IsImmutable = MFI.isImmutableObjectIndex(I);
369     YamlObject.IsAliased = MFI.isAliasedObjectIndex(I);
370     YMF.FixedStackObjects.push_back(YamlObject);
371     StackObjectOperandMapping.insert(
372         std::make_pair(I, FrameIndexOperand::createFixed(ID++)));
373   }
374 
375   // Process ordinary stack objects.
376   ID = 0;
377   for (int I = 0, E = MFI.getObjectIndexEnd(); I < E; ++I) {
378     if (MFI.isDeadObjectIndex(I))
379       continue;
380 
381     yaml::MachineStackObject YamlObject;
382     YamlObject.ID = ID;
383     if (const auto *Alloca = MFI.getObjectAllocation(I))
384       YamlObject.Name.Value =
385           Alloca->hasName() ? Alloca->getName() : "<unnamed alloca>";
386     YamlObject.Type = MFI.isSpillSlotObjectIndex(I)
387                           ? yaml::MachineStackObject::SpillSlot
388                           : MFI.isVariableSizedObjectIndex(I)
389                                 ? yaml::MachineStackObject::VariableSized
390                                 : yaml::MachineStackObject::DefaultType;
391     YamlObject.Offset = MFI.getObjectOffset(I);
392     YamlObject.Size = MFI.getObjectSize(I);
393     YamlObject.Alignment = MFI.getObjectAlignment(I);
394     YamlObject.StackID = MFI.getStackID(I);
395 
396     YMF.StackObjects.push_back(YamlObject);
397     StackObjectOperandMapping.insert(std::make_pair(
398         I, FrameIndexOperand::create(YamlObject.Name.Value, ID++)));
399   }
400 
401   for (const auto &CSInfo : MFI.getCalleeSavedInfo()) {
402     yaml::StringValue Reg;
403     printRegMIR(CSInfo.getReg(), Reg, TRI);
404     if (!CSInfo.isSpilledToReg()) {
405       auto StackObjectInfo = StackObjectOperandMapping.find(CSInfo.getFrameIdx());
406       assert(StackObjectInfo != StackObjectOperandMapping.end() &&
407              "Invalid stack object index");
408       const FrameIndexOperand &StackObject = StackObjectInfo->second;
409       if (StackObject.IsFixed) {
410         YMF.FixedStackObjects[StackObject.ID].CalleeSavedRegister = Reg;
411         YMF.FixedStackObjects[StackObject.ID].CalleeSavedRestored =
412           CSInfo.isRestored();
413       } else {
414         YMF.StackObjects[StackObject.ID].CalleeSavedRegister = Reg;
415         YMF.StackObjects[StackObject.ID].CalleeSavedRestored =
416           CSInfo.isRestored();
417       }
418     }
419   }
420   for (unsigned I = 0, E = MFI.getLocalFrameObjectCount(); I < E; ++I) {
421     auto LocalObject = MFI.getLocalFrameObjectMap(I);
422     auto StackObjectInfo = StackObjectOperandMapping.find(LocalObject.first);
423     assert(StackObjectInfo != StackObjectOperandMapping.end() &&
424            "Invalid stack object index");
425     const FrameIndexOperand &StackObject = StackObjectInfo->second;
426     assert(!StackObject.IsFixed && "Expected a locally mapped stack object");
427     YMF.StackObjects[StackObject.ID].LocalOffset = LocalObject.second;
428   }
429 
430   // Print the stack object references in the frame information class after
431   // converting the stack objects.
432   if (MFI.hasStackProtectorIndex()) {
433     raw_string_ostream StrOS(YMF.FrameInfo.StackProtector.Value);
434     MIPrinter(StrOS, MST, RegisterMaskIds, StackObjectOperandMapping)
435         .printStackObjectReference(MFI.getStackProtectorIndex());
436   }
437 
438   // Print the debug variable information.
439   for (const MachineFunction::VariableDbgInfo &DebugVar :
440        MF.getVariableDbgInfo()) {
441     auto StackObjectInfo = StackObjectOperandMapping.find(DebugVar.Slot);
442     assert(StackObjectInfo != StackObjectOperandMapping.end() &&
443            "Invalid stack object index");
444     const FrameIndexOperand &StackObject = StackObjectInfo->second;
445     if (StackObject.IsFixed) {
446       auto &Object = YMF.FixedStackObjects[StackObject.ID];
447       printStackObjectDbgInfo(DebugVar, Object, MST);
448     } else {
449       auto &Object = YMF.StackObjects[StackObject.ID];
450       printStackObjectDbgInfo(DebugVar, Object, MST);
451     }
452   }
453 }
454 
455 void MIRPrinter::convert(yaml::MachineFunction &MF,
456                          const MachineConstantPool &ConstantPool) {
457   unsigned ID = 0;
458   for (const MachineConstantPoolEntry &Constant : ConstantPool.getConstants()) {
459     std::string Str;
460     raw_string_ostream StrOS(Str);
461     if (Constant.isMachineConstantPoolEntry()) {
462       Constant.Val.MachineCPVal->print(StrOS);
463     } else {
464       Constant.Val.ConstVal->printAsOperand(StrOS);
465     }
466 
467     yaml::MachineConstantPoolValue YamlConstant;
468     YamlConstant.ID = ID++;
469     YamlConstant.Value = StrOS.str();
470     YamlConstant.Alignment = Constant.getAlignment();
471     YamlConstant.IsTargetSpecific = Constant.isMachineConstantPoolEntry();
472 
473     MF.Constants.push_back(YamlConstant);
474   }
475 }
476 
477 void MIRPrinter::convert(ModuleSlotTracker &MST,
478                          yaml::MachineJumpTable &YamlJTI,
479                          const MachineJumpTableInfo &JTI) {
480   YamlJTI.Kind = JTI.getEntryKind();
481   unsigned ID = 0;
482   for (const auto &Table : JTI.getJumpTables()) {
483     std::string Str;
484     yaml::MachineJumpTable::Entry Entry;
485     Entry.ID = ID++;
486     for (const auto *MBB : Table.MBBs) {
487       raw_string_ostream StrOS(Str);
488       StrOS << printMBBReference(*MBB);
489       Entry.Blocks.push_back(StrOS.str());
490       Str.clear();
491     }
492     YamlJTI.Entries.push_back(Entry);
493   }
494 }
495 
496 void MIRPrinter::initRegisterMaskIds(const MachineFunction &MF) {
497   const auto *TRI = MF.getSubtarget().getRegisterInfo();
498   unsigned I = 0;
499   for (const uint32_t *Mask : TRI->getRegMasks())
500     RegisterMaskIds.insert(std::make_pair(Mask, I++));
501 }
502 
503 void llvm::guessSuccessors(const MachineBasicBlock &MBB,
504                            SmallVectorImpl<MachineBasicBlock*> &Result,
505                            bool &IsFallthrough) {
506   SmallPtrSet<MachineBasicBlock*,8> Seen;
507 
508   for (const MachineInstr &MI : MBB) {
509     if (MI.isPHI())
510       continue;
511     for (const MachineOperand &MO : MI.operands()) {
512       if (!MO.isMBB())
513         continue;
514       MachineBasicBlock *Succ = MO.getMBB();
515       auto RP = Seen.insert(Succ);
516       if (RP.second)
517         Result.push_back(Succ);
518     }
519   }
520   MachineBasicBlock::const_iterator I = MBB.getLastNonDebugInstr();
521   IsFallthrough = I == MBB.end() || !I->isBarrier();
522 }
523 
524 bool
525 MIPrinter::canPredictBranchProbabilities(const MachineBasicBlock &MBB) const {
526   if (MBB.succ_size() <= 1)
527     return true;
528   if (!MBB.hasSuccessorProbabilities())
529     return true;
530 
531   SmallVector<BranchProbability,8> Normalized(MBB.Probs.begin(),
532                                               MBB.Probs.end());
533   BranchProbability::normalizeProbabilities(Normalized.begin(),
534                                             Normalized.end());
535   SmallVector<BranchProbability,8> Equal(Normalized.size());
536   BranchProbability::normalizeProbabilities(Equal.begin(), Equal.end());
537 
538   return std::equal(Normalized.begin(), Normalized.end(), Equal.begin());
539 }
540 
541 bool MIPrinter::canPredictSuccessors(const MachineBasicBlock &MBB) const {
542   SmallVector<MachineBasicBlock*,8> GuessedSuccs;
543   bool GuessedFallthrough;
544   guessSuccessors(MBB, GuessedSuccs, GuessedFallthrough);
545   if (GuessedFallthrough) {
546     const MachineFunction &MF = *MBB.getParent();
547     MachineFunction::const_iterator NextI = std::next(MBB.getIterator());
548     if (NextI != MF.end()) {
549       MachineBasicBlock *Next = const_cast<MachineBasicBlock*>(&*NextI);
550       if (!is_contained(GuessedSuccs, Next))
551         GuessedSuccs.push_back(Next);
552     }
553   }
554   if (GuessedSuccs.size() != MBB.succ_size())
555     return false;
556   return std::equal(MBB.succ_begin(), MBB.succ_end(), GuessedSuccs.begin());
557 }
558 
559 void MIPrinter::print(const MachineBasicBlock &MBB) {
560   assert(MBB.getNumber() >= 0 && "Invalid MBB number");
561   OS << "bb." << MBB.getNumber();
562   bool HasAttributes = false;
563   if (const auto *BB = MBB.getBasicBlock()) {
564     if (BB->hasName()) {
565       OS << "." << BB->getName();
566     } else {
567       HasAttributes = true;
568       OS << " (";
569       int Slot = MST.getLocalSlot(BB);
570       if (Slot == -1)
571         OS << "<ir-block badref>";
572       else
573         OS << (Twine("%ir-block.") + Twine(Slot)).str();
574     }
575   }
576   if (MBB.hasAddressTaken()) {
577     OS << (HasAttributes ? ", " : " (");
578     OS << "address-taken";
579     HasAttributes = true;
580   }
581   if (MBB.isEHPad()) {
582     OS << (HasAttributes ? ", " : " (");
583     OS << "landing-pad";
584     HasAttributes = true;
585   }
586   if (MBB.getAlignment()) {
587     OS << (HasAttributes ? ", " : " (");
588     OS << "align " << MBB.getAlignment();
589     HasAttributes = true;
590   }
591   if (HasAttributes)
592     OS << ")";
593   OS << ":\n";
594 
595   bool HasLineAttributes = false;
596   // Print the successors
597   bool canPredictProbs = canPredictBranchProbabilities(MBB);
598   // Even if the list of successors is empty, if we cannot guess it,
599   // we need to print it to tell the parser that the list is empty.
600   // This is needed, because MI model unreachable as empty blocks
601   // with an empty successor list. If the parser would see that
602   // without the successor list, it would guess the code would
603   // fallthrough.
604   if ((!MBB.succ_empty() && !SimplifyMIR) || !canPredictProbs ||
605       !canPredictSuccessors(MBB)) {
606     OS.indent(2) << "successors: ";
607     for (auto I = MBB.succ_begin(), E = MBB.succ_end(); I != E; ++I) {
608       if (I != MBB.succ_begin())
609         OS << ", ";
610       OS << printMBBReference(**I);
611       if (!SimplifyMIR || !canPredictProbs)
612         OS << '('
613            << format("0x%08" PRIx32, MBB.getSuccProbability(I).getNumerator())
614            << ')';
615     }
616     OS << "\n";
617     HasLineAttributes = true;
618   }
619 
620   // Print the live in registers.
621   const MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
622   if (MRI.tracksLiveness() && !MBB.livein_empty()) {
623     const TargetRegisterInfo &TRI = *MRI.getTargetRegisterInfo();
624     OS.indent(2) << "liveins: ";
625     bool First = true;
626     for (const auto &LI : MBB.liveins()) {
627       if (!First)
628         OS << ", ";
629       First = false;
630       OS << printReg(LI.PhysReg, &TRI);
631       if (!LI.LaneMask.all())
632         OS << ":0x" << PrintLaneMask(LI.LaneMask);
633     }
634     OS << "\n";
635     HasLineAttributes = true;
636   }
637 
638   if (HasLineAttributes)
639     OS << "\n";
640   bool IsInBundle = false;
641   for (auto I = MBB.instr_begin(), E = MBB.instr_end(); I != E; ++I) {
642     const MachineInstr &MI = *I;
643     if (IsInBundle && !MI.isInsideBundle()) {
644       OS.indent(2) << "}\n";
645       IsInBundle = false;
646     }
647     OS.indent(IsInBundle ? 4 : 2);
648     print(MI);
649     if (!IsInBundle && MI.getFlag(MachineInstr::BundledSucc)) {
650       OS << " {";
651       IsInBundle = true;
652     }
653     OS << "\n";
654   }
655   if (IsInBundle)
656     OS.indent(2) << "}\n";
657 }
658 
659 void MIPrinter::print(const MachineInstr &MI) {
660   const auto *MF = MI.getMF();
661   const auto &MRI = MF->getRegInfo();
662   const auto &SubTarget = MF->getSubtarget();
663   const auto *TRI = SubTarget.getRegisterInfo();
664   assert(TRI && "Expected target register info");
665   const auto *TII = SubTarget.getInstrInfo();
666   assert(TII && "Expected target instruction info");
667   if (MI.isCFIInstruction())
668     assert(MI.getNumOperands() == 1 && "Expected 1 operand in CFI instruction");
669 
670   SmallBitVector PrintedTypes(8);
671   bool ShouldPrintRegisterTies = MI.hasComplexRegisterTies();
672   unsigned I = 0, E = MI.getNumOperands();
673   for (; I < E && MI.getOperand(I).isReg() && MI.getOperand(I).isDef() &&
674          !MI.getOperand(I).isImplicit();
675        ++I) {
676     if (I)
677       OS << ", ";
678     print(MI, I, TRI, ShouldPrintRegisterTies,
679           MI.getTypeToPrint(I, PrintedTypes, MRI),
680           /*PrintDef=*/false);
681   }
682 
683   if (I)
684     OS << " = ";
685   if (MI.getFlag(MachineInstr::FrameSetup))
686     OS << "frame-setup ";
687   if (MI.getFlag(MachineInstr::FrameDestroy))
688     OS << "frame-destroy ";
689   if (MI.getFlag(MachineInstr::FmNoNans))
690     OS << "nnan ";
691   if (MI.getFlag(MachineInstr::FmNoInfs))
692     OS << "ninf ";
693   if (MI.getFlag(MachineInstr::FmNsz))
694     OS << "nsz ";
695   if (MI.getFlag(MachineInstr::FmArcp))
696     OS << "arcp ";
697   if (MI.getFlag(MachineInstr::FmContract))
698     OS << "contract ";
699   if (MI.getFlag(MachineInstr::FmAfn))
700     OS << "afn ";
701   if (MI.getFlag(MachineInstr::FmReassoc))
702     OS << "reassoc ";
703   if (MI.getFlag(MachineInstr::NoUWrap))
704     OS << "nuw ";
705   if (MI.getFlag(MachineInstr::NoSWrap))
706     OS << "nsw ";
707   if (MI.getFlag(MachineInstr::IsExact))
708     OS << "exact ";
709 
710   OS << TII->getName(MI.getOpcode());
711   if (I < E)
712     OS << ' ';
713 
714   bool NeedComma = false;
715   for (; I < E; ++I) {
716     if (NeedComma)
717       OS << ", ";
718     print(MI, I, TRI, ShouldPrintRegisterTies,
719           MI.getTypeToPrint(I, PrintedTypes, MRI));
720     NeedComma = true;
721   }
722 
723   // Print any optional symbols attached to this instruction as-if they were
724   // operands.
725   if (MCSymbol *PreInstrSymbol = MI.getPreInstrSymbol()) {
726     if (NeedComma)
727       OS << ',';
728     OS << " pre-instr-symbol ";
729     MachineOperand::printSymbol(OS, *PreInstrSymbol);
730     NeedComma = true;
731   }
732   if (MCSymbol *PostInstrSymbol = MI.getPostInstrSymbol()) {
733     if (NeedComma)
734       OS << ',';
735     OS << " post-instr-symbol ";
736     MachineOperand::printSymbol(OS, *PostInstrSymbol);
737     NeedComma = true;
738   }
739 
740   if (const DebugLoc &DL = MI.getDebugLoc()) {
741     if (NeedComma)
742       OS << ',';
743     OS << " debug-location ";
744     DL->printAsOperand(OS, MST);
745   }
746 
747   if (!MI.memoperands_empty()) {
748     OS << " :: ";
749     const LLVMContext &Context = MF->getFunction().getContext();
750     const MachineFrameInfo &MFI = MF->getFrameInfo();
751     bool NeedComma = false;
752     for (const auto *Op : MI.memoperands()) {
753       if (NeedComma)
754         OS << ", ";
755       Op->print(OS, MST, SSNs, Context, &MFI, TII);
756       NeedComma = true;
757     }
758   }
759 }
760 
761 void MIPrinter::printStackObjectReference(int FrameIndex) {
762   auto ObjectInfo = StackObjectOperandMapping.find(FrameIndex);
763   assert(ObjectInfo != StackObjectOperandMapping.end() &&
764          "Invalid frame index");
765   const FrameIndexOperand &Operand = ObjectInfo->second;
766   MachineOperand::printStackObjectReference(OS, Operand.ID, Operand.IsFixed,
767                                             Operand.Name);
768 }
769 
770 void MIPrinter::print(const MachineInstr &MI, unsigned OpIdx,
771                       const TargetRegisterInfo *TRI,
772                       bool ShouldPrintRegisterTies, LLT TypeToPrint,
773                       bool PrintDef) {
774   const MachineOperand &Op = MI.getOperand(OpIdx);
775   switch (Op.getType()) {
776   case MachineOperand::MO_Immediate:
777     if (MI.isOperandSubregIdx(OpIdx)) {
778       MachineOperand::printTargetFlags(OS, Op);
779       MachineOperand::printSubRegIdx(OS, Op.getImm(), TRI);
780       break;
781     }
782     LLVM_FALLTHROUGH;
783   case MachineOperand::MO_Register:
784   case MachineOperand::MO_CImmediate:
785   case MachineOperand::MO_FPImmediate:
786   case MachineOperand::MO_MachineBasicBlock:
787   case MachineOperand::MO_ConstantPoolIndex:
788   case MachineOperand::MO_TargetIndex:
789   case MachineOperand::MO_JumpTableIndex:
790   case MachineOperand::MO_ExternalSymbol:
791   case MachineOperand::MO_GlobalAddress:
792   case MachineOperand::MO_RegisterLiveOut:
793   case MachineOperand::MO_Metadata:
794   case MachineOperand::MO_MCSymbol:
795   case MachineOperand::MO_CFIIndex:
796   case MachineOperand::MO_IntrinsicID:
797   case MachineOperand::MO_Predicate:
798   case MachineOperand::MO_BlockAddress: {
799     unsigned TiedOperandIdx = 0;
800     if (ShouldPrintRegisterTies && Op.isReg() && Op.isTied() && !Op.isDef())
801       TiedOperandIdx = Op.getParent()->findTiedOperandIdx(OpIdx);
802     const TargetIntrinsicInfo *TII = MI.getMF()->getTarget().getIntrinsicInfo();
803     Op.print(OS, MST, TypeToPrint, PrintDef, /*IsStandalone=*/false,
804              ShouldPrintRegisterTies, TiedOperandIdx, TRI, TII);
805     break;
806   }
807   case MachineOperand::MO_FrameIndex:
808     printStackObjectReference(Op.getIndex());
809     break;
810   case MachineOperand::MO_RegisterMask: {
811     auto RegMaskInfo = RegisterMaskIds.find(Op.getRegMask());
812     if (RegMaskInfo != RegisterMaskIds.end())
813       OS << StringRef(TRI->getRegMaskNames()[RegMaskInfo->second]).lower();
814     else
815       printCustomRegMask(Op.getRegMask(), OS, TRI);
816     break;
817   }
818   }
819 }
820 
821 void llvm::printMIR(raw_ostream &OS, const Module &M) {
822   yaml::Output Out(OS);
823   Out << const_cast<Module &>(M);
824 }
825 
826 void llvm::printMIR(raw_ostream &OS, const MachineFunction &MF) {
827   MIRPrinter Printer(OS);
828   Printer.print(MF);
829 }
830