LLVM  9.0.0svn
InstructionSelect.cpp
Go to the documentation of this file.
1 //===- llvm/CodeGen/GlobalISel/InstructionSelect.cpp - InstructionSelect ---==//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 /// \file
9 /// This file implements the InstructionSelect class.
10 //===----------------------------------------------------------------------===//
11 
14 #include "llvm/ADT/Twine.h"
23 #include "llvm/Config/config.h"
24 #include "llvm/IR/Constants.h"
25 #include "llvm/IR/Function.h"
27 #include "llvm/Support/Debug.h"
29 
30 #define DEBUG_TYPE "instruction-select"
31 
32 using namespace llvm;
33 
34 #ifdef LLVM_GISEL_COV_PREFIX
36  CoveragePrefix("gisel-coverage-prefix", cl::init(LLVM_GISEL_COV_PREFIX),
37  cl::desc("Record GlobalISel rule coverage files of this "
38  "prefix if instrumentation was generated"));
39 #else
40 static const std::string CoveragePrefix = "";
41 #endif
42 
43 char InstructionSelect::ID = 0;
45  "Select target instructions out of generic instructions",
46  false, false)
49  "Select target instructions out of generic instructions",
50  false, false)
51 
52 InstructionSelect::InstructionSelect() : MachineFunctionPass(ID) {
54 }
55 
60 }
61 
63  // If the ISel pipeline failed, do not bother running that pass.
64  if (MF.getProperties().hasProperty(
66  return false;
67 
68  LLVM_DEBUG(dbgs() << "Selecting function: " << MF.getName() << '\n');
69 
70  const TargetPassConfig &TPC = getAnalysis<TargetPassConfig>();
72  CodeGenCoverage CoverageInfo;
73  assert(ISel && "Cannot work without InstructionSelector");
74 
75  // An optimization remark emitter. Used to report failures.
76  MachineOptimizationRemarkEmitter MORE(MF, /*MBFI=*/nullptr);
77 
78  // FIXME: There are many other MF/MFI fields we need to initialize.
79 
81 #ifndef NDEBUG
82  // Check that our input is fully legal: we require the function to have the
83  // Legalized property, so it should be.
84  // FIXME: This should be in the MachineVerifier, as the RegBankSelected
85  // property check already is.
87  if (const MachineInstr *MI = machineFunctionIsIllegal(MF)) {
88  reportGISelFailure(MF, TPC, MORE, "gisel-select",
89  "instruction is not legal", *MI);
90  return false;
91  }
92  // FIXME: We could introduce new blocks and will need to fix the outer loop.
93  // Until then, keep track of the number of blocks to assert that we don't.
94  const size_t NumBlocks = MF.size();
95 #endif
96 
97  for (MachineBasicBlock *MBB : post_order(&MF)) {
98  if (MBB->empty())
99  continue;
100 
101  // Select instructions in reverse block order. We permit erasing so have
102  // to resort to manually iterating and recognizing the begin (rend) case.
103  bool ReachedBegin = false;
104  for (auto MII = std::prev(MBB->end()), Begin = MBB->begin();
105  !ReachedBegin;) {
106 #ifndef NDEBUG
107  // Keep track of the insertion range for debug printing.
108  const auto AfterIt = std::next(MII);
109 #endif
110  // Select this instruction.
111  MachineInstr &MI = *MII;
112 
113  // And have our iterator point to the next instruction, if there is one.
114  if (MII == Begin)
115  ReachedBegin = true;
116  else
117  --MII;
118 
119  LLVM_DEBUG(dbgs() << "Selecting: \n " << MI);
120 
121  // We could have folded this instruction away already, making it dead.
122  // If so, erase it.
123  if (isTriviallyDead(MI, MRI)) {
124  LLVM_DEBUG(dbgs() << "Is dead; erasing.\n");
126  continue;
127  }
128 
129  if (!ISel->select(MI, CoverageInfo)) {
130  // FIXME: It would be nice to dump all inserted instructions. It's
131  // not obvious how, esp. considering select() can insert after MI.
132  reportGISelFailure(MF, TPC, MORE, "gisel-select", "cannot select", MI);
133  return false;
134  }
135 
136  // Dump the range of instructions that MI expanded into.
137  LLVM_DEBUG({
138  auto InsertedBegin = ReachedBegin ? MBB->begin() : std::next(MII);
139  dbgs() << "Into:\n";
140  for (auto &InsertedMI : make_range(InsertedBegin, AfterIt))
141  dbgs() << " " << InsertedMI;
142  dbgs() << '\n';
143  });
144  }
145  }
146 
147  for (MachineBasicBlock &MBB : MF) {
148  if (MBB.empty())
149  continue;
150 
151  // Try to find redundant copies b/w vregs of the same register class.
152  bool ReachedBegin = false;
153  for (auto MII = std::prev(MBB.end()), Begin = MBB.begin(); !ReachedBegin;) {
154  // Select this instruction.
155  MachineInstr &MI = *MII;
156 
157  // And have our iterator point to the next instruction, if there is one.
158  if (MII == Begin)
159  ReachedBegin = true;
160  else
161  --MII;
162  if (MI.getOpcode() != TargetOpcode::COPY)
163  continue;
164  unsigned SrcReg = MI.getOperand(1).getReg();
165  unsigned DstReg = MI.getOperand(0).getReg();
168  auto SrcRC = MRI.getRegClass(SrcReg);
169  auto DstRC = MRI.getRegClass(DstReg);
170  if (SrcRC == DstRC) {
171  MRI.replaceRegWith(DstReg, SrcReg);
173  }
174  }
175  }
176  }
177 
178 #ifndef NDEBUG
179  const TargetRegisterInfo &TRI = *MF.getSubtarget().getRegisterInfo();
180  // Now that selection is complete, there are no more generic vregs. Verify
181  // that the size of the now-constrained vreg is unchanged and that it has a
182  // register class.
183  for (unsigned I = 0, E = MRI.getNumVirtRegs(); I != E; ++I) {
184  unsigned VReg = TargetRegisterInfo::index2VirtReg(I);
185 
186  MachineInstr *MI = nullptr;
187  if (!MRI.def_empty(VReg))
188  MI = &*MRI.def_instr_begin(VReg);
189  else if (!MRI.use_empty(VReg))
190  MI = &*MRI.use_instr_begin(VReg);
191  if (!MI)
192  continue;
193 
194  const TargetRegisterClass *RC = MRI.getRegClassOrNull(VReg);
195  if (!RC) {
196  reportGISelFailure(MF, TPC, MORE, "gisel-select",
197  "VReg has no regclass after selection", *MI);
198  return false;
199  }
200 
201  const LLT Ty = MRI.getType(VReg);
202  if (Ty.isValid() && Ty.getSizeInBits() > TRI.getRegSizeInBits(*RC)) {
204  MF, TPC, MORE, "gisel-select",
205  "VReg's low-level type and register class have different sizes", *MI);
206  return false;
207  }
208  }
209 
210  if (MF.size() != NumBlocks) {
211  MachineOptimizationRemarkMissed R("gisel-select", "GISelFailure",
212  MF.getFunction().getSubprogram(),
213  /*MBB=*/nullptr);
214  R << "inserting blocks is not supported yet";
215  reportGISelFailure(MF, TPC, MORE, R);
216  return false;
217  }
218 #endif
219  auto &TLI = *MF.getSubtarget().getTargetLowering();
220  TLI.finalizeLowering(MF);
221 
222  LLVM_DEBUG({
223  dbgs() << "Rules covered by selecting function: " << MF.getName() << ":";
224  for (auto RuleID : CoverageInfo.covered())
225  dbgs() << " id" << RuleID;
226  dbgs() << "\n\n";
227  });
228  CoverageInfo.emit(CoveragePrefix,
229  MF.getSubtarget()
230  .getTargetLowering()
231  ->getTargetMachine()
232  .getTarget()
233  .getBackendName());
234 
235  // If we successfully selected the function nothing is going to use the vreg
236  // types after us (otherwise MIRPrinter would need them). Make sure the types
237  // disappear.
238  MRI.clearVirtRegTypes();
239 
240  // FIXME: Should we accurately track changes?
241  return true;
242 }
static PassRegistry * getPassRegistry()
getPassRegistry - Access the global registry object, which is automatically initialized at applicatio...
const TargetRegisterClass * getRegClass(unsigned Reg) const
Return the register class of the specified virtual register.
void clearVirtRegTypes()
Remove all types associated to virtual registers (after instruction selection and constraining of all...
This class represents lattice values for constants.
Definition: AllocatorList.h:23
void getSelectionDAGFallbackAnalysisUsage(AnalysisUsage &AU)
Modify analysis usage so it preserves passes required for the SelectionDAG fallback.
Definition: Utils.cpp:364
static unsigned index2VirtReg(unsigned Index)
Convert a 0-based index to a virtual register number.
void initializeInstructionSelectPass(PassRegistry &)
const MachineFunctionProperties & getProperties() const
Get the function properties.
unsigned size() const
unsigned getReg() const
getReg - Returns the register number.
static bool isVirtualRegister(unsigned Reg)
Return true if the specified register number is in the virtual register namespace.
LLT getType(unsigned Reg) const
Get the low-level type of Reg or LLT{} if Reg is not a generic (target independent) virtual register...
unsigned const TargetRegisterInfo * TRI
AnalysisUsage & addRequired()
#define INITIALIZE_PASS_DEPENDENCY(depName)
Definition: PassSupport.h:50
MachineFunctionPass - This class adapts the FunctionPass interface to allow convenient creation of pa...
bool emit(StringRef FilePrefix, StringRef BackendName) const
unsigned getOpcode() const
Returns the opcode of this MachineInstr.
Definition: MachineInstr.h:408
Target-Independent Code Generator Pass Configuration Options.
INITIALIZE_PASS_BEGIN(InstructionSelect, DEBUG_TYPE, "Select target instructions out of generic instructions", false, false) INITIALIZE_PASS_END(InstructionSelect
void eraseFromParentAndMarkDBGValuesForRemoval()
Unlink &#39;this&#39; from the containing basic block and delete it.
StringRef getName() const
getName - Return the name of the corresponding LLVM function.
void getAnalysisUsage(AnalysisUsage &AU) const override
getAnalysisUsage - This function should be overriden by passes that need analysis information to do t...
===- MachineOptimizationRemarkEmitter.h - Opt Diagnostics -*- C++ -*-—===//
initializer< Ty > init(const Ty &Val)
Definition: CommandLine.h:432
unsigned const MachineRegisterInfo * MRI
const TargetSubtargetInfo & getSubtarget() const
getSubtarget - Return the subtarget for which this machine code is being compiled.
void getAnalysisUsage(AnalysisUsage &AU) const override
getAnalysisUsage - Subclasses that override getAnalysisUsage must call this.
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
This file contains the declarations for the subclasses of Constant, which represent the different fla...
Represent the analysis usage information of a pass.
use_instr_iterator use_instr_begin(unsigned RegNo) const
bool isValid() const
bool runOnMachineFunction(MachineFunction &MF) override
runOnMachineFunction - This method must be overloaded to perform the desired machine code transformat...
bool def_empty(unsigned RegNo) const
def_empty - Return true if there are no instructions defining the specified register (it may be live-...
iterator_range< po_iterator< T > > post_order(const T &G)
unsigned getNumVirtRegs() const
getNumVirtRegs - Return the number of virtual registers created.
TargetRegisterInfo base class - We assume that the target defines a static array of TargetRegisterDes...
static const std::string CoveragePrefix
cl::opt< bool > DisableGISelLegalityCheck
#define DEBUG_TYPE
INITIALIZE_PASS_END(RegBankSelect, DEBUG_TYPE, "Assign register bank of generic virtual registers", false, false) RegBankSelect
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
const MachineInstr * machineFunctionIsIllegal(const MachineFunction &MF)
Checks that MIR is fully legal, returns an illegal instruction if it&#39;s not, nullptr otherwise...
The optimization diagnostic interface.
unsigned getSizeInBits() const
Returns the total size of the type. Must only be called on sized types.
#define MORE()
Definition: regcomp.c:251
This pass is responsible for selecting generic machine instructions to target-specific instructions...
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:132
bool use_empty(unsigned RegNo) const
use_empty - Return true if there are no instructions using the specified register.
def_instr_iterator def_instr_begin(unsigned RegNo) const
void replaceRegWith(unsigned FromReg, unsigned ToReg)
replaceRegWith - Replace all instances of FromReg with ToReg in the machine function.
MachineRegisterInfo - Keep track of information for virtual and physical registers, including vreg register classes, use/def chains for registers, etc.
Provides the logic to select generic machine instructions.
bool isTriviallyDead(const MachineInstr &MI, const MachineRegisterInfo &MRI)
Check whether an instruction MI is dead: it only defines dead virtual registers, and doesn&#39;t have oth...
Definition: Utils.cpp:160
Representation of each machine instruction.
Definition: MachineInstr.h:63
MachineRegisterInfo & getRegInfo()
getRegInfo - Return information about the registers currently in use.
virtual const InstructionSelector * getInstructionSelector() const
iterator_range< const_covered_iterator > covered() const
#define I(x, y, z)
Definition: MD5.cpp:58
Diagnostic information for missed-optimization remarks.
const TargetRegisterClass * getRegClassOrNull(unsigned Reg) const
Return the register class of Reg, or null if Reg has not been assigned a register class yet...
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
bool hasProperty(Property P) const
IRTranslator LLVM IR MI
inst_range instructions(Function *F)
Definition: InstIterator.h:133
unsigned getRegSizeInBits(const TargetRegisterClass &RC) const
Return the size in bits of a register from class RC.
#define LLVM_DEBUG(X)
Definition: Debug.h:122
const MachineOperand & getOperand(unsigned i) const
Definition: MachineInstr.h:413
void reportGISelFailure(MachineFunction &MF, const TargetPassConfig &TPC, MachineOptimizationRemarkEmitter &MORE, MachineOptimizationRemarkMissed &R)
Report an ISel error as a missed optimization remark to the LLVMContext&#39;s diagnostic stream...
Definition: Utils.cpp:181
This file describes how to lower LLVM code to machine code.