0df05683b4f16d2ec0f5a13cd782a3043a154957
[oota-llvm.git] / lib / CodeGen / SelectionDAG / SelectionDAGISel.cpp
1 //===-- SelectionDAGISel.cpp - Implement the SelectionDAGISel class -------===//
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 implements the SelectionDAGISel class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "llvm/CodeGen/GCStrategy.h"
15 #include "ScheduleDAGSDNodes.h"
16 #include "SelectionDAGBuilder.h"
17 #include "llvm/ADT/PostOrderIterator.h"
18 #include "llvm/ADT/Statistic.h"
19 #include "llvm/Analysis/AliasAnalysis.h"
20 #include "llvm/Analysis/BranchProbabilityInfo.h"
21 #include "llvm/Analysis/CFG.h"
22 #include "llvm/Analysis/LibCallSemantics.h"
23 #include "llvm/Analysis/TargetLibraryInfo.h"
24 #include "llvm/CodeGen/Analysis.h"
25 #include "llvm/CodeGen/FastISel.h"
26 #include "llvm/CodeGen/FunctionLoweringInfo.h"
27 #include "llvm/CodeGen/GCMetadata.h"
28 #include "llvm/CodeGen/MachineFrameInfo.h"
29 #include "llvm/CodeGen/MachineFunction.h"
30 #include "llvm/CodeGen/MachineInstrBuilder.h"
31 #include "llvm/CodeGen/MachineModuleInfo.h"
32 #include "llvm/CodeGen/MachineRegisterInfo.h"
33 #include "llvm/CodeGen/ScheduleHazardRecognizer.h"
34 #include "llvm/CodeGen/SchedulerRegistry.h"
35 #include "llvm/CodeGen/SelectionDAG.h"
36 #include "llvm/CodeGen/SelectionDAGISel.h"
37 #include "llvm/CodeGen/WinEHFuncInfo.h"
38 #include "llvm/IR/Constants.h"
39 #include "llvm/IR/DebugInfo.h"
40 #include "llvm/IR/Function.h"
41 #include "llvm/IR/InlineAsm.h"
42 #include "llvm/IR/Instructions.h"
43 #include "llvm/IR/IntrinsicInst.h"
44 #include "llvm/IR/Intrinsics.h"
45 #include "llvm/IR/LLVMContext.h"
46 #include "llvm/IR/Module.h"
47 #include "llvm/MC/MCAsmInfo.h"
48 #include "llvm/Support/Compiler.h"
49 #include "llvm/Support/Debug.h"
50 #include "llvm/Support/ErrorHandling.h"
51 #include "llvm/Support/Timer.h"
52 #include "llvm/Support/raw_ostream.h"
53 #include "llvm/Target/TargetInstrInfo.h"
54 #include "llvm/Target/TargetIntrinsicInfo.h"
55 #include "llvm/Target/TargetLowering.h"
56 #include "llvm/Target/TargetMachine.h"
57 #include "llvm/Target/TargetOptions.h"
58 #include "llvm/Target/TargetRegisterInfo.h"
59 #include "llvm/Target/TargetSubtargetInfo.h"
60 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
61 #include <algorithm>
62 using namespace llvm;
63
64 #define DEBUG_TYPE "isel"
65
66 STATISTIC(NumFastIselFailures, "Number of instructions fast isel failed on");
67 STATISTIC(NumFastIselSuccess, "Number of instructions fast isel selected");
68 STATISTIC(NumFastIselBlocks, "Number of blocks selected entirely by fast isel");
69 STATISTIC(NumDAGBlocks, "Number of blocks selected using DAG");
70 STATISTIC(NumDAGIselRetries,"Number of times dag isel has to try another path");
71 STATISTIC(NumEntryBlocks, "Number of entry blocks encountered");
72 STATISTIC(NumFastIselFailLowerArguments,
73           "Number of entry blocks where fast isel failed to lower arguments");
74
75 #ifndef NDEBUG
76 static cl::opt<bool>
77 EnableFastISelVerbose2("fast-isel-verbose2", cl::Hidden,
78           cl::desc("Enable extra verbose messages in the \"fast\" "
79                    "instruction selector"));
80
81   // Terminators
82 STATISTIC(NumFastIselFailRet,"Fast isel fails on Ret");
83 STATISTIC(NumFastIselFailBr,"Fast isel fails on Br");
84 STATISTIC(NumFastIselFailSwitch,"Fast isel fails on Switch");
85 STATISTIC(NumFastIselFailIndirectBr,"Fast isel fails on IndirectBr");
86 STATISTIC(NumFastIselFailInvoke,"Fast isel fails on Invoke");
87 STATISTIC(NumFastIselFailResume,"Fast isel fails on Resume");
88 STATISTIC(NumFastIselFailUnreachable,"Fast isel fails on Unreachable");
89
90   // Standard binary operators...
91 STATISTIC(NumFastIselFailAdd,"Fast isel fails on Add");
92 STATISTIC(NumFastIselFailFAdd,"Fast isel fails on FAdd");
93 STATISTIC(NumFastIselFailSub,"Fast isel fails on Sub");
94 STATISTIC(NumFastIselFailFSub,"Fast isel fails on FSub");
95 STATISTIC(NumFastIselFailMul,"Fast isel fails on Mul");
96 STATISTIC(NumFastIselFailFMul,"Fast isel fails on FMul");
97 STATISTIC(NumFastIselFailUDiv,"Fast isel fails on UDiv");
98 STATISTIC(NumFastIselFailSDiv,"Fast isel fails on SDiv");
99 STATISTIC(NumFastIselFailFDiv,"Fast isel fails on FDiv");
100 STATISTIC(NumFastIselFailURem,"Fast isel fails on URem");
101 STATISTIC(NumFastIselFailSRem,"Fast isel fails on SRem");
102 STATISTIC(NumFastIselFailFRem,"Fast isel fails on FRem");
103
104   // Logical operators...
105 STATISTIC(NumFastIselFailAnd,"Fast isel fails on And");
106 STATISTIC(NumFastIselFailOr,"Fast isel fails on Or");
107 STATISTIC(NumFastIselFailXor,"Fast isel fails on Xor");
108
109   // Memory instructions...
110 STATISTIC(NumFastIselFailAlloca,"Fast isel fails on Alloca");
111 STATISTIC(NumFastIselFailLoad,"Fast isel fails on Load");
112 STATISTIC(NumFastIselFailStore,"Fast isel fails on Store");
113 STATISTIC(NumFastIselFailAtomicCmpXchg,"Fast isel fails on AtomicCmpXchg");
114 STATISTIC(NumFastIselFailAtomicRMW,"Fast isel fails on AtomicRWM");
115 STATISTIC(NumFastIselFailFence,"Fast isel fails on Frence");
116 STATISTIC(NumFastIselFailGetElementPtr,"Fast isel fails on GetElementPtr");
117
118   // Convert instructions...
119 STATISTIC(NumFastIselFailTrunc,"Fast isel fails on Trunc");
120 STATISTIC(NumFastIselFailZExt,"Fast isel fails on ZExt");
121 STATISTIC(NumFastIselFailSExt,"Fast isel fails on SExt");
122 STATISTIC(NumFastIselFailFPTrunc,"Fast isel fails on FPTrunc");
123 STATISTIC(NumFastIselFailFPExt,"Fast isel fails on FPExt");
124 STATISTIC(NumFastIselFailFPToUI,"Fast isel fails on FPToUI");
125 STATISTIC(NumFastIselFailFPToSI,"Fast isel fails on FPToSI");
126 STATISTIC(NumFastIselFailUIToFP,"Fast isel fails on UIToFP");
127 STATISTIC(NumFastIselFailSIToFP,"Fast isel fails on SIToFP");
128 STATISTIC(NumFastIselFailIntToPtr,"Fast isel fails on IntToPtr");
129 STATISTIC(NumFastIselFailPtrToInt,"Fast isel fails on PtrToInt");
130 STATISTIC(NumFastIselFailBitCast,"Fast isel fails on BitCast");
131
132   // Other instructions...
133 STATISTIC(NumFastIselFailICmp,"Fast isel fails on ICmp");
134 STATISTIC(NumFastIselFailFCmp,"Fast isel fails on FCmp");
135 STATISTIC(NumFastIselFailPHI,"Fast isel fails on PHI");
136 STATISTIC(NumFastIselFailSelect,"Fast isel fails on Select");
137 STATISTIC(NumFastIselFailCall,"Fast isel fails on Call");
138 STATISTIC(NumFastIselFailShl,"Fast isel fails on Shl");
139 STATISTIC(NumFastIselFailLShr,"Fast isel fails on LShr");
140 STATISTIC(NumFastIselFailAShr,"Fast isel fails on AShr");
141 STATISTIC(NumFastIselFailVAArg,"Fast isel fails on VAArg");
142 STATISTIC(NumFastIselFailExtractElement,"Fast isel fails on ExtractElement");
143 STATISTIC(NumFastIselFailInsertElement,"Fast isel fails on InsertElement");
144 STATISTIC(NumFastIselFailShuffleVector,"Fast isel fails on ShuffleVector");
145 STATISTIC(NumFastIselFailExtractValue,"Fast isel fails on ExtractValue");
146 STATISTIC(NumFastIselFailInsertValue,"Fast isel fails on InsertValue");
147 STATISTIC(NumFastIselFailLandingPad,"Fast isel fails on LandingPad");
148
149 // Intrinsic instructions...
150 STATISTIC(NumFastIselFailIntrinsicCall, "Fast isel fails on Intrinsic call");
151 STATISTIC(NumFastIselFailSAddWithOverflow,
152           "Fast isel fails on sadd.with.overflow");
153 STATISTIC(NumFastIselFailUAddWithOverflow,
154           "Fast isel fails on uadd.with.overflow");
155 STATISTIC(NumFastIselFailSSubWithOverflow,
156           "Fast isel fails on ssub.with.overflow");
157 STATISTIC(NumFastIselFailUSubWithOverflow,
158           "Fast isel fails on usub.with.overflow");
159 STATISTIC(NumFastIselFailSMulWithOverflow,
160           "Fast isel fails on smul.with.overflow");
161 STATISTIC(NumFastIselFailUMulWithOverflow,
162           "Fast isel fails on umul.with.overflow");
163 STATISTIC(NumFastIselFailFrameaddress, "Fast isel fails on Frameaddress");
164 STATISTIC(NumFastIselFailSqrt, "Fast isel fails on sqrt call");
165 STATISTIC(NumFastIselFailStackMap, "Fast isel fails on StackMap call");
166 STATISTIC(NumFastIselFailPatchPoint, "Fast isel fails on PatchPoint call");
167 #endif
168
169 static cl::opt<bool>
170 EnableFastISelVerbose("fast-isel-verbose", cl::Hidden,
171           cl::desc("Enable verbose messages in the \"fast\" "
172                    "instruction selector"));
173 static cl::opt<int> EnableFastISelAbort(
174     "fast-isel-abort", cl::Hidden,
175     cl::desc("Enable abort calls when \"fast\" instruction selection "
176              "fails to lower an instruction: 0 disable the abort, 1 will "
177              "abort but for args, calls and terminators, 2 will also "
178              "abort for argument lowering, and 3 will never fallback "
179              "to SelectionDAG."));
180
181 static cl::opt<bool>
182 UseMBPI("use-mbpi",
183         cl::desc("use Machine Branch Probability Info"),
184         cl::init(true), cl::Hidden);
185
186 #ifndef NDEBUG
187 static cl::opt<std::string>
188 FilterDAGBasicBlockName("filter-view-dags", cl::Hidden,
189                         cl::desc("Only display the basic block whose name "
190                                  "matches this for all view-*-dags options"));
191 static cl::opt<bool>
192 ViewDAGCombine1("view-dag-combine1-dags", cl::Hidden,
193           cl::desc("Pop up a window to show dags before the first "
194                    "dag combine pass"));
195 static cl::opt<bool>
196 ViewLegalizeTypesDAGs("view-legalize-types-dags", cl::Hidden,
197           cl::desc("Pop up a window to show dags before legalize types"));
198 static cl::opt<bool>
199 ViewLegalizeDAGs("view-legalize-dags", cl::Hidden,
200           cl::desc("Pop up a window to show dags before legalize"));
201 static cl::opt<bool>
202 ViewDAGCombine2("view-dag-combine2-dags", cl::Hidden,
203           cl::desc("Pop up a window to show dags before the second "
204                    "dag combine pass"));
205 static cl::opt<bool>
206 ViewDAGCombineLT("view-dag-combine-lt-dags", cl::Hidden,
207           cl::desc("Pop up a window to show dags before the post legalize types"
208                    " dag combine pass"));
209 static cl::opt<bool>
210 ViewISelDAGs("view-isel-dags", cl::Hidden,
211           cl::desc("Pop up a window to show isel dags as they are selected"));
212 static cl::opt<bool>
213 ViewSchedDAGs("view-sched-dags", cl::Hidden,
214           cl::desc("Pop up a window to show sched dags as they are processed"));
215 static cl::opt<bool>
216 ViewSUnitDAGs("view-sunit-dags", cl::Hidden,
217       cl::desc("Pop up a window to show SUnit dags after they are processed"));
218 #else
219 static const bool ViewDAGCombine1 = false,
220                   ViewLegalizeTypesDAGs = false, ViewLegalizeDAGs = false,
221                   ViewDAGCombine2 = false,
222                   ViewDAGCombineLT = false,
223                   ViewISelDAGs = false, ViewSchedDAGs = false,
224                   ViewSUnitDAGs = false;
225 #endif
226
227 //===---------------------------------------------------------------------===//
228 ///
229 /// RegisterScheduler class - Track the registration of instruction schedulers.
230 ///
231 //===---------------------------------------------------------------------===//
232 MachinePassRegistry RegisterScheduler::Registry;
233
234 //===---------------------------------------------------------------------===//
235 ///
236 /// ISHeuristic command line option for instruction schedulers.
237 ///
238 //===---------------------------------------------------------------------===//
239 static cl::opt<RegisterScheduler::FunctionPassCtor, false,
240                RegisterPassParser<RegisterScheduler> >
241 ISHeuristic("pre-RA-sched",
242             cl::init(&createDefaultScheduler), cl::Hidden,
243             cl::desc("Instruction schedulers available (before register"
244                      " allocation):"));
245
246 static RegisterScheduler
247 defaultListDAGScheduler("default", "Best scheduler for the target",
248                         createDefaultScheduler);
249
250 namespace llvm {
251   //===--------------------------------------------------------------------===//
252   /// \brief This class is used by SelectionDAGISel to temporarily override
253   /// the optimization level on a per-function basis.
254   class OptLevelChanger {
255     SelectionDAGISel &IS;
256     CodeGenOpt::Level SavedOptLevel;
257     bool SavedFastISel;
258
259   public:
260     OptLevelChanger(SelectionDAGISel &ISel,
261                     CodeGenOpt::Level NewOptLevel) : IS(ISel) {
262       SavedOptLevel = IS.OptLevel;
263       if (NewOptLevel == SavedOptLevel)
264         return;
265       IS.OptLevel = NewOptLevel;
266       IS.TM.setOptLevel(NewOptLevel);
267       SavedFastISel = IS.TM.Options.EnableFastISel;
268       if (NewOptLevel == CodeGenOpt::None)
269         IS.TM.setFastISel(true);
270       DEBUG(dbgs() << "\nChanging optimization level for Function "
271             << IS.MF->getFunction()->getName() << "\n");
272       DEBUG(dbgs() << "\tBefore: -O" << SavedOptLevel
273             << " ; After: -O" << NewOptLevel << "\n");
274     }
275
276     ~OptLevelChanger() {
277       if (IS.OptLevel == SavedOptLevel)
278         return;
279       DEBUG(dbgs() << "\nRestoring optimization level for Function "
280             << IS.MF->getFunction()->getName() << "\n");
281       DEBUG(dbgs() << "\tBefore: -O" << IS.OptLevel
282             << " ; After: -O" << SavedOptLevel << "\n");
283       IS.OptLevel = SavedOptLevel;
284       IS.TM.setOptLevel(SavedOptLevel);
285       IS.TM.setFastISel(SavedFastISel);
286     }
287   };
288
289   //===--------------------------------------------------------------------===//
290   /// createDefaultScheduler - This creates an instruction scheduler appropriate
291   /// for the target.
292   ScheduleDAGSDNodes* createDefaultScheduler(SelectionDAGISel *IS,
293                                              CodeGenOpt::Level OptLevel) {
294     const TargetLowering *TLI = IS->TLI;
295     const TargetSubtargetInfo &ST = IS->MF->getSubtarget();
296
297     // Try first to see if the Target has its own way of selecting a scheduler
298     if (auto *SchedulerCtor = ST.getDAGScheduler(OptLevel)) {
299       return SchedulerCtor(IS, OptLevel);
300     }
301
302     if (OptLevel == CodeGenOpt::None ||
303         (ST.enableMachineScheduler() && ST.enableMachineSchedDefaultSched()) ||
304         TLI->getSchedulingPreference() == Sched::Source)
305       return createSourceListDAGScheduler(IS, OptLevel);
306     if (TLI->getSchedulingPreference() == Sched::RegPressure)
307       return createBURRListDAGScheduler(IS, OptLevel);
308     if (TLI->getSchedulingPreference() == Sched::Hybrid)
309       return createHybridListDAGScheduler(IS, OptLevel);
310     if (TLI->getSchedulingPreference() == Sched::VLIW)
311       return createVLIWDAGScheduler(IS, OptLevel);
312     assert(TLI->getSchedulingPreference() == Sched::ILP &&
313            "Unknown sched type!");
314     return createILPListDAGScheduler(IS, OptLevel);
315   }
316 }
317
318 // EmitInstrWithCustomInserter - This method should be implemented by targets
319 // that mark instructions with the 'usesCustomInserter' flag.  These
320 // instructions are special in various ways, which require special support to
321 // insert.  The specified MachineInstr is created but not inserted into any
322 // basic blocks, and this method is called to expand it into a sequence of
323 // instructions, potentially also creating new basic blocks and control flow.
324 // When new basic blocks are inserted and the edges from MBB to its successors
325 // are modified, the method should insert pairs of <OldSucc, NewSucc> into the
326 // DenseMap.
327 MachineBasicBlock *
328 TargetLowering::EmitInstrWithCustomInserter(MachineInstr *MI,
329                                             MachineBasicBlock *MBB) const {
330 #ifndef NDEBUG
331   dbgs() << "If a target marks an instruction with "
332           "'usesCustomInserter', it must implement "
333           "TargetLowering::EmitInstrWithCustomInserter!";
334 #endif
335   llvm_unreachable(nullptr);
336 }
337
338 void TargetLowering::AdjustInstrPostInstrSelection(MachineInstr *MI,
339                                                    SDNode *Node) const {
340   assert(!MI->hasPostISelHook() &&
341          "If a target marks an instruction with 'hasPostISelHook', "
342          "it must implement TargetLowering::AdjustInstrPostInstrSelection!");
343 }
344
345 //===----------------------------------------------------------------------===//
346 // SelectionDAGISel code
347 //===----------------------------------------------------------------------===//
348
349 SelectionDAGISel::SelectionDAGISel(TargetMachine &tm,
350                                    CodeGenOpt::Level OL) :
351   MachineFunctionPass(ID), TM(tm),
352   FuncInfo(new FunctionLoweringInfo()),
353   CurDAG(new SelectionDAG(tm, OL)),
354   SDB(new SelectionDAGBuilder(*CurDAG, *FuncInfo, OL)),
355   GFI(),
356   OptLevel(OL),
357   DAGSize(0) {
358     initializeGCModuleInfoPass(*PassRegistry::getPassRegistry());
359     initializeBranchProbabilityInfoWrapperPassPass(
360         *PassRegistry::getPassRegistry());
361     initializeAAResultsWrapperPassPass(*PassRegistry::getPassRegistry());
362     initializeTargetLibraryInfoWrapperPassPass(
363         *PassRegistry::getPassRegistry());
364   }
365
366 SelectionDAGISel::~SelectionDAGISel() {
367   delete SDB;
368   delete CurDAG;
369   delete FuncInfo;
370 }
371
372 void SelectionDAGISel::getAnalysisUsage(AnalysisUsage &AU) const {
373   AU.addRequired<AAResultsWrapperPass>();
374   AU.addRequired<GCModuleInfo>();
375   AU.addPreserved<GCModuleInfo>();
376   AU.addRequired<TargetLibraryInfoWrapperPass>();
377   if (UseMBPI && OptLevel != CodeGenOpt::None)
378     AU.addRequired<BranchProbabilityInfoWrapperPass>();
379   MachineFunctionPass::getAnalysisUsage(AU);
380 }
381
382 /// SplitCriticalSideEffectEdges - Look for critical edges with a PHI value that
383 /// may trap on it.  In this case we have to split the edge so that the path
384 /// through the predecessor block that doesn't go to the phi block doesn't
385 /// execute the possibly trapping instruction.
386 ///
387 /// This is required for correctness, so it must be done at -O0.
388 ///
389 static void SplitCriticalSideEffectEdges(Function &Fn) {
390   // Loop for blocks with phi nodes.
391   for (Function::iterator BB = Fn.begin(), E = Fn.end(); BB != E; ++BB) {
392     PHINode *PN = dyn_cast<PHINode>(BB->begin());
393     if (!PN) continue;
394
395   ReprocessBlock:
396     // For each block with a PHI node, check to see if any of the input values
397     // are potentially trapping constant expressions.  Constant expressions are
398     // the only potentially trapping value that can occur as the argument to a
399     // PHI.
400     for (BasicBlock::iterator I = BB->begin(); (PN = dyn_cast<PHINode>(I)); ++I)
401       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
402         ConstantExpr *CE = dyn_cast<ConstantExpr>(PN->getIncomingValue(i));
403         if (!CE || !CE->canTrap()) continue;
404
405         // The only case we have to worry about is when the edge is critical.
406         // Since this block has a PHI Node, we assume it has multiple input
407         // edges: check to see if the pred has multiple successors.
408         BasicBlock *Pred = PN->getIncomingBlock(i);
409         if (Pred->getTerminator()->getNumSuccessors() == 1)
410           continue;
411
412         // Okay, we have to split this edge.
413         SplitCriticalEdge(
414             Pred->getTerminator(), GetSuccessorNumber(Pred, BB),
415             CriticalEdgeSplittingOptions().setMergeIdenticalEdges());
416         goto ReprocessBlock;
417       }
418   }
419 }
420
421 bool SelectionDAGISel::runOnMachineFunction(MachineFunction &mf) {
422   // Do some sanity-checking on the command-line options.
423   assert((!EnableFastISelVerbose || TM.Options.EnableFastISel) &&
424          "-fast-isel-verbose requires -fast-isel");
425   assert((!EnableFastISelAbort || TM.Options.EnableFastISel) &&
426          "-fast-isel-abort > 0 requires -fast-isel");
427
428   const Function &Fn = *mf.getFunction();
429   MF = &mf;
430
431   // Reset the target options before resetting the optimization
432   // level below.
433   // FIXME: This is a horrible hack and should be processed via
434   // codegen looking at the optimization level explicitly when
435   // it wants to look at it.
436   TM.resetTargetOptions(Fn);
437   // Reset OptLevel to None for optnone functions.
438   CodeGenOpt::Level NewOptLevel = OptLevel;
439   if (Fn.hasFnAttribute(Attribute::OptimizeNone))
440     NewOptLevel = CodeGenOpt::None;
441   OptLevelChanger OLC(*this, NewOptLevel);
442
443   TII = MF->getSubtarget().getInstrInfo();
444   TLI = MF->getSubtarget().getTargetLowering();
445   RegInfo = &MF->getRegInfo();
446   AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
447   LibInfo = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
448   GFI = Fn.hasGC() ? &getAnalysis<GCModuleInfo>().getFunctionInfo(Fn) : nullptr;
449
450   DEBUG(dbgs() << "\n\n\n=== " << Fn.getName() << "\n");
451
452   SplitCriticalSideEffectEdges(const_cast<Function &>(Fn));
453
454   CurDAG->init(*MF);
455   FuncInfo->set(Fn, *MF, CurDAG);
456
457   if (UseMBPI && OptLevel != CodeGenOpt::None)
458     FuncInfo->BPI = &getAnalysis<BranchProbabilityInfoWrapperPass>().getBPI();
459   else
460     FuncInfo->BPI = nullptr;
461
462   SDB->init(GFI, *AA, LibInfo);
463
464   MF->setHasInlineAsm(false);
465
466   SelectAllBasicBlocks(Fn);
467
468   // If the first basic block in the function has live ins that need to be
469   // copied into vregs, emit the copies into the top of the block before
470   // emitting the code for the block.
471   MachineBasicBlock *EntryMBB = MF->begin();
472   const TargetRegisterInfo &TRI = *MF->getSubtarget().getRegisterInfo();
473   RegInfo->EmitLiveInCopies(EntryMBB, TRI, *TII);
474
475   DenseMap<unsigned, unsigned> LiveInMap;
476   if (!FuncInfo->ArgDbgValues.empty())
477     for (MachineRegisterInfo::livein_iterator LI = RegInfo->livein_begin(),
478            E = RegInfo->livein_end(); LI != E; ++LI)
479       if (LI->second)
480         LiveInMap.insert(std::make_pair(LI->first, LI->second));
481
482   // Insert DBG_VALUE instructions for function arguments to the entry block.
483   for (unsigned i = 0, e = FuncInfo->ArgDbgValues.size(); i != e; ++i) {
484     MachineInstr *MI = FuncInfo->ArgDbgValues[e-i-1];
485     bool hasFI = MI->getOperand(0).isFI();
486     unsigned Reg =
487         hasFI ? TRI.getFrameRegister(*MF) : MI->getOperand(0).getReg();
488     if (TargetRegisterInfo::isPhysicalRegister(Reg))
489       EntryMBB->insert(EntryMBB->begin(), MI);
490     else {
491       MachineInstr *Def = RegInfo->getVRegDef(Reg);
492       if (Def) {
493         MachineBasicBlock::iterator InsertPos = Def;
494         // FIXME: VR def may not be in entry block.
495         Def->getParent()->insert(std::next(InsertPos), MI);
496       } else
497         DEBUG(dbgs() << "Dropping debug info for dead vreg"
498               << TargetRegisterInfo::virtReg2Index(Reg) << "\n");
499     }
500
501     // If Reg is live-in then update debug info to track its copy in a vreg.
502     DenseMap<unsigned, unsigned>::iterator LDI = LiveInMap.find(Reg);
503     if (LDI != LiveInMap.end()) {
504       assert(!hasFI && "There's no handling of frame pointer updating here yet "
505                        "- add if needed");
506       MachineInstr *Def = RegInfo->getVRegDef(LDI->second);
507       MachineBasicBlock::iterator InsertPos = Def;
508       const MDNode *Variable = MI->getDebugVariable();
509       const MDNode *Expr = MI->getDebugExpression();
510       DebugLoc DL = MI->getDebugLoc();
511       bool IsIndirect = MI->isIndirectDebugValue();
512       unsigned Offset = IsIndirect ? MI->getOperand(1).getImm() : 0;
513       assert(cast<DILocalVariable>(Variable)->isValidLocationForIntrinsic(DL) &&
514              "Expected inlined-at fields to agree");
515       // Def is never a terminator here, so it is ok to increment InsertPos.
516       BuildMI(*EntryMBB, ++InsertPos, DL, TII->get(TargetOpcode::DBG_VALUE),
517               IsIndirect, LDI->second, Offset, Variable, Expr);
518
519       // If this vreg is directly copied into an exported register then
520       // that COPY instructions also need DBG_VALUE, if it is the only
521       // user of LDI->second.
522       MachineInstr *CopyUseMI = nullptr;
523       for (MachineRegisterInfo::use_instr_iterator
524            UI = RegInfo->use_instr_begin(LDI->second),
525            E = RegInfo->use_instr_end(); UI != E; ) {
526         MachineInstr *UseMI = &*(UI++);
527         if (UseMI->isDebugValue()) continue;
528         if (UseMI->isCopy() && !CopyUseMI && UseMI->getParent() == EntryMBB) {
529           CopyUseMI = UseMI; continue;
530         }
531         // Otherwise this is another use or second copy use.
532         CopyUseMI = nullptr; break;
533       }
534       if (CopyUseMI) {
535         // Use MI's debug location, which describes where Variable was
536         // declared, rather than whatever is attached to CopyUseMI.
537         MachineInstr *NewMI =
538             BuildMI(*MF, DL, TII->get(TargetOpcode::DBG_VALUE), IsIndirect,
539                     CopyUseMI->getOperand(0).getReg(), Offset, Variable, Expr);
540         MachineBasicBlock::iterator Pos = CopyUseMI;
541         EntryMBB->insertAfter(Pos, NewMI);
542       }
543     }
544   }
545
546   // Determine if there are any calls in this machine function.
547   MachineFrameInfo *MFI = MF->getFrameInfo();
548   for (const auto &MBB : *MF) {
549     if (MFI->hasCalls() && MF->hasInlineAsm())
550       break;
551
552     for (const auto &MI : MBB) {
553       const MCInstrDesc &MCID = TII->get(MI.getOpcode());
554       if ((MCID.isCall() && !MCID.isReturn()) ||
555           MI.isStackAligningInlineAsm()) {
556         MFI->setHasCalls(true);
557       }
558       if (MI.isInlineAsm()) {
559         MF->setHasInlineAsm(true);
560       }
561     }
562   }
563
564   // Determine if there is a call to setjmp in the machine function.
565   MF->setExposesReturnsTwice(Fn.callsFunctionThatReturnsTwice());
566
567   // Replace forward-declared registers with the registers containing
568   // the desired value.
569   MachineRegisterInfo &MRI = MF->getRegInfo();
570   for (DenseMap<unsigned, unsigned>::iterator
571        I = FuncInfo->RegFixups.begin(), E = FuncInfo->RegFixups.end();
572        I != E; ++I) {
573     unsigned From = I->first;
574     unsigned To = I->second;
575     // If To is also scheduled to be replaced, find what its ultimate
576     // replacement is.
577     for (;;) {
578       DenseMap<unsigned, unsigned>::iterator J = FuncInfo->RegFixups.find(To);
579       if (J == E) break;
580       To = J->second;
581     }
582     // Make sure the new register has a sufficiently constrained register class.
583     if (TargetRegisterInfo::isVirtualRegister(From) &&
584         TargetRegisterInfo::isVirtualRegister(To))
585       MRI.constrainRegClass(To, MRI.getRegClass(From));
586     // Replace it.
587
588
589     // Replacing one register with another won't touch the kill flags.
590     // We need to conservatively clear the kill flags as a kill on the old
591     // register might dominate existing uses of the new register.
592     if (!MRI.use_empty(To))
593       MRI.clearKillFlags(From);
594     MRI.replaceRegWith(From, To);
595   }
596
597   // Freeze the set of reserved registers now that MachineFrameInfo has been
598   // set up. All the information required by getReservedRegs() should be
599   // available now.
600   MRI.freezeReservedRegs(*MF);
601
602   // Release function-specific state. SDB and CurDAG are already cleared
603   // at this point.
604   FuncInfo->clear();
605
606   DEBUG(dbgs() << "*** MachineFunction at end of ISel ***\n");
607   DEBUG(MF->print(dbgs()));
608
609   return true;
610 }
611
612 void SelectionDAGISel::SelectBasicBlock(BasicBlock::const_iterator Begin,
613                                         BasicBlock::const_iterator End,
614                                         bool &HadTailCall) {
615   // Lower the instructions. If a call is emitted as a tail call, cease emitting
616   // nodes for this block.
617   for (BasicBlock::const_iterator I = Begin; I != End && !SDB->HasTailCall; ++I)
618     SDB->visit(*I);
619
620   // Make sure the root of the DAG is up-to-date.
621   CurDAG->setRoot(SDB->getControlRoot());
622   HadTailCall = SDB->HasTailCall;
623   SDB->clear();
624
625   // Final step, emit the lowered DAG as machine code.
626   CodeGenAndEmitDAG();
627 }
628
629 void SelectionDAGISel::ComputeLiveOutVRegInfo() {
630   SmallPtrSet<SDNode*, 128> VisitedNodes;
631   SmallVector<SDNode*, 128> Worklist;
632
633   Worklist.push_back(CurDAG->getRoot().getNode());
634
635   APInt KnownZero;
636   APInt KnownOne;
637
638   do {
639     SDNode *N = Worklist.pop_back_val();
640
641     // If we've already seen this node, ignore it.
642     if (!VisitedNodes.insert(N).second)
643       continue;
644
645     // Otherwise, add all chain operands to the worklist.
646     for (const SDValue &Op : N->op_values())
647       if (Op.getValueType() == MVT::Other)
648         Worklist.push_back(Op.getNode());
649
650     // If this is a CopyToReg with a vreg dest, process it.
651     if (N->getOpcode() != ISD::CopyToReg)
652       continue;
653
654     unsigned DestReg = cast<RegisterSDNode>(N->getOperand(1))->getReg();
655     if (!TargetRegisterInfo::isVirtualRegister(DestReg))
656       continue;
657
658     // Ignore non-scalar or non-integer values.
659     SDValue Src = N->getOperand(2);
660     EVT SrcVT = Src.getValueType();
661     if (!SrcVT.isInteger() || SrcVT.isVector())
662       continue;
663
664     unsigned NumSignBits = CurDAG->ComputeNumSignBits(Src);
665     CurDAG->computeKnownBits(Src, KnownZero, KnownOne);
666     FuncInfo->AddLiveOutRegInfo(DestReg, NumSignBits, KnownZero, KnownOne);
667   } while (!Worklist.empty());
668 }
669
670 void SelectionDAGISel::CodeGenAndEmitDAG() {
671   std::string GroupName;
672   if (TimePassesIsEnabled)
673     GroupName = "Instruction Selection and Scheduling";
674   std::string BlockName;
675   int BlockNumber = -1;
676   (void)BlockNumber;
677   bool MatchFilterBB = false; (void)MatchFilterBB;
678 #ifndef NDEBUG
679   MatchFilterBB = (FilterDAGBasicBlockName.empty() ||
680                    FilterDAGBasicBlockName ==
681                        FuncInfo->MBB->getBasicBlock()->getName().str());
682 #endif
683 #ifdef NDEBUG
684   if (ViewDAGCombine1 || ViewLegalizeTypesDAGs || ViewLegalizeDAGs ||
685       ViewDAGCombine2 || ViewDAGCombineLT || ViewISelDAGs || ViewSchedDAGs ||
686       ViewSUnitDAGs)
687 #endif
688   {
689     BlockNumber = FuncInfo->MBB->getNumber();
690     BlockName =
691         (MF->getName() + ":" + FuncInfo->MBB->getBasicBlock()->getName()).str();
692   }
693   DEBUG(dbgs() << "Initial selection DAG: BB#" << BlockNumber
694         << " '" << BlockName << "'\n"; CurDAG->dump());
695
696   if (ViewDAGCombine1 && MatchFilterBB)
697     CurDAG->viewGraph("dag-combine1 input for " + BlockName);
698
699   // Run the DAG combiner in pre-legalize mode.
700   {
701     NamedRegionTimer T("DAG Combining 1", GroupName, TimePassesIsEnabled);
702     CurDAG->Combine(BeforeLegalizeTypes, *AA, OptLevel);
703   }
704
705   DEBUG(dbgs() << "Optimized lowered selection DAG: BB#" << BlockNumber
706         << " '" << BlockName << "'\n"; CurDAG->dump());
707
708   // Second step, hack on the DAG until it only uses operations and types that
709   // the target supports.
710   if (ViewLegalizeTypesDAGs && MatchFilterBB)
711     CurDAG->viewGraph("legalize-types input for " + BlockName);
712
713   bool Changed;
714   {
715     NamedRegionTimer T("Type Legalization", GroupName, TimePassesIsEnabled);
716     Changed = CurDAG->LegalizeTypes();
717   }
718
719   DEBUG(dbgs() << "Type-legalized selection DAG: BB#" << BlockNumber
720         << " '" << BlockName << "'\n"; CurDAG->dump());
721
722   CurDAG->NewNodesMustHaveLegalTypes = true;
723
724   if (Changed) {
725     if (ViewDAGCombineLT && MatchFilterBB)
726       CurDAG->viewGraph("dag-combine-lt input for " + BlockName);
727
728     // Run the DAG combiner in post-type-legalize mode.
729     {
730       NamedRegionTimer T("DAG Combining after legalize types", GroupName,
731                          TimePassesIsEnabled);
732       CurDAG->Combine(AfterLegalizeTypes, *AA, OptLevel);
733     }
734
735     DEBUG(dbgs() << "Optimized type-legalized selection DAG: BB#" << BlockNumber
736           << " '" << BlockName << "'\n"; CurDAG->dump());
737
738   }
739
740   {
741     NamedRegionTimer T("Vector Legalization", GroupName, TimePassesIsEnabled);
742     Changed = CurDAG->LegalizeVectors();
743   }
744
745   if (Changed) {
746     {
747       NamedRegionTimer T("Type Legalization 2", GroupName, TimePassesIsEnabled);
748       CurDAG->LegalizeTypes();
749     }
750
751     if (ViewDAGCombineLT && MatchFilterBB)
752       CurDAG->viewGraph("dag-combine-lv input for " + BlockName);
753
754     // Run the DAG combiner in post-type-legalize mode.
755     {
756       NamedRegionTimer T("DAG Combining after legalize vectors", GroupName,
757                          TimePassesIsEnabled);
758       CurDAG->Combine(AfterLegalizeVectorOps, *AA, OptLevel);
759     }
760
761     DEBUG(dbgs() << "Optimized vector-legalized selection DAG: BB#"
762           << BlockNumber << " '" << BlockName << "'\n"; CurDAG->dump());
763   }
764
765   if (ViewLegalizeDAGs && MatchFilterBB)
766     CurDAG->viewGraph("legalize input for " + BlockName);
767
768   {
769     NamedRegionTimer T("DAG Legalization", GroupName, TimePassesIsEnabled);
770     CurDAG->Legalize();
771   }
772
773   DEBUG(dbgs() << "Legalized selection DAG: BB#" << BlockNumber
774         << " '" << BlockName << "'\n"; CurDAG->dump());
775
776   if (ViewDAGCombine2 && MatchFilterBB)
777     CurDAG->viewGraph("dag-combine2 input for " + BlockName);
778
779   // Run the DAG combiner in post-legalize mode.
780   {
781     NamedRegionTimer T("DAG Combining 2", GroupName, TimePassesIsEnabled);
782     CurDAG->Combine(AfterLegalizeDAG, *AA, OptLevel);
783   }
784
785   DEBUG(dbgs() << "Optimized legalized selection DAG: BB#" << BlockNumber
786         << " '" << BlockName << "'\n"; CurDAG->dump());
787
788   if (OptLevel != CodeGenOpt::None)
789     ComputeLiveOutVRegInfo();
790
791   if (ViewISelDAGs && MatchFilterBB)
792     CurDAG->viewGraph("isel input for " + BlockName);
793
794   // Third, instruction select all of the operations to machine code, adding the
795   // code to the MachineBasicBlock.
796   {
797     NamedRegionTimer T("Instruction Selection", GroupName, TimePassesIsEnabled);
798     DoInstructionSelection();
799   }
800
801   DEBUG(dbgs() << "Selected selection DAG: BB#" << BlockNumber
802         << " '" << BlockName << "'\n"; CurDAG->dump());
803
804   if (ViewSchedDAGs && MatchFilterBB)
805     CurDAG->viewGraph("scheduler input for " + BlockName);
806
807   // Schedule machine code.
808   ScheduleDAGSDNodes *Scheduler = CreateScheduler();
809   {
810     NamedRegionTimer T("Instruction Scheduling", GroupName,
811                        TimePassesIsEnabled);
812     Scheduler->Run(CurDAG, FuncInfo->MBB);
813   }
814
815   if (ViewSUnitDAGs && MatchFilterBB) Scheduler->viewGraph();
816
817   // Emit machine code to BB.  This can change 'BB' to the last block being
818   // inserted into.
819   MachineBasicBlock *FirstMBB = FuncInfo->MBB, *LastMBB;
820   {
821     NamedRegionTimer T("Instruction Creation", GroupName, TimePassesIsEnabled);
822
823     // FuncInfo->InsertPt is passed by reference and set to the end of the
824     // scheduled instructions.
825     LastMBB = FuncInfo->MBB = Scheduler->EmitSchedule(FuncInfo->InsertPt);
826   }
827
828   // If the block was split, make sure we update any references that are used to
829   // update PHI nodes later on.
830   if (FirstMBB != LastMBB)
831     SDB->UpdateSplitBlock(FirstMBB, LastMBB);
832
833   // Free the scheduler state.
834   {
835     NamedRegionTimer T("Instruction Scheduling Cleanup", GroupName,
836                        TimePassesIsEnabled);
837     delete Scheduler;
838   }
839
840   // Free the SelectionDAG state, now that we're finished with it.
841   CurDAG->clear();
842 }
843
844 namespace {
845 /// ISelUpdater - helper class to handle updates of the instruction selection
846 /// graph.
847 class ISelUpdater : public SelectionDAG::DAGUpdateListener {
848   SelectionDAG::allnodes_iterator &ISelPosition;
849 public:
850   ISelUpdater(SelectionDAG &DAG, SelectionDAG::allnodes_iterator &isp)
851     : SelectionDAG::DAGUpdateListener(DAG), ISelPosition(isp) {}
852
853   /// NodeDeleted - Handle nodes deleted from the graph. If the node being
854   /// deleted is the current ISelPosition node, update ISelPosition.
855   ///
856   void NodeDeleted(SDNode *N, SDNode *E) override {
857     if (ISelPosition == SelectionDAG::allnodes_iterator(N))
858       ++ISelPosition;
859   }
860 };
861 } // end anonymous namespace
862
863 void SelectionDAGISel::DoInstructionSelection() {
864   DEBUG(dbgs() << "===== Instruction selection begins: BB#"
865         << FuncInfo->MBB->getNumber()
866         << " '" << FuncInfo->MBB->getName() << "'\n");
867
868   PreprocessISelDAG();
869
870   // Select target instructions for the DAG.
871   {
872     // Number all nodes with a topological order and set DAGSize.
873     DAGSize = CurDAG->AssignTopologicalOrder();
874
875     // Create a dummy node (which is not added to allnodes), that adds
876     // a reference to the root node, preventing it from being deleted,
877     // and tracking any changes of the root.
878     HandleSDNode Dummy(CurDAG->getRoot());
879     SelectionDAG::allnodes_iterator ISelPosition (CurDAG->getRoot().getNode());
880     ++ISelPosition;
881
882     // Make sure that ISelPosition gets properly updated when nodes are deleted
883     // in calls made from this function.
884     ISelUpdater ISU(*CurDAG, ISelPosition);
885
886     // The AllNodes list is now topological-sorted. Visit the
887     // nodes by starting at the end of the list (the root of the
888     // graph) and preceding back toward the beginning (the entry
889     // node).
890     while (ISelPosition != CurDAG->allnodes_begin()) {
891       SDNode *Node = --ISelPosition;
892       // Skip dead nodes. DAGCombiner is expected to eliminate all dead nodes,
893       // but there are currently some corner cases that it misses. Also, this
894       // makes it theoretically possible to disable the DAGCombiner.
895       if (Node->use_empty())
896         continue;
897
898       SDNode *ResNode = Select(Node);
899
900       // FIXME: This is pretty gross.  'Select' should be changed to not return
901       // anything at all and this code should be nuked with a tactical strike.
902
903       // If node should not be replaced, continue with the next one.
904       if (ResNode == Node || Node->getOpcode() == ISD::DELETED_NODE)
905         continue;
906       // Replace node.
907       if (ResNode) {
908         ReplaceUses(Node, ResNode);
909       }
910
911       // If after the replacement this node is not used any more,
912       // remove this dead node.
913       if (Node->use_empty()) // Don't delete EntryToken, etc.
914         CurDAG->RemoveDeadNode(Node);
915     }
916
917     CurDAG->setRoot(Dummy.getValue());
918   }
919
920   DEBUG(dbgs() << "===== Instruction selection ends:\n");
921
922   PostprocessISelDAG();
923 }
924
925 static bool hasExceptionPointerOrCodeUser(const CatchPadInst *CPI) {
926   for (const User *U : CPI->users()) {
927     if (const IntrinsicInst *EHPtrCall = dyn_cast<IntrinsicInst>(U)) {
928       Intrinsic::ID IID = EHPtrCall->getIntrinsicID();
929       if (IID == Intrinsic::eh_exceptionpointer ||
930           IID == Intrinsic::eh_exceptioncode)
931         return true;
932     }
933   }
934   return false;
935 }
936
937 /// PrepareEHLandingPad - Emit an EH_LABEL, set up live-in registers, and
938 /// do other setup for EH landing-pad blocks.
939 bool SelectionDAGISel::PrepareEHLandingPad() {
940   MachineBasicBlock *MBB = FuncInfo->MBB;
941   const BasicBlock *LLVMBB = MBB->getBasicBlock();
942   const TargetRegisterClass *PtrRC =
943       TLI->getRegClassFor(TLI->getPointerTy(CurDAG->getDataLayout()));
944
945   // Catchpads have one live-in register, which typically holds the exception
946   // pointer or code.
947   if (const auto *CPI = dyn_cast<CatchPadInst>(LLVMBB->getFirstNonPHI())) {
948     if (hasExceptionPointerOrCodeUser(CPI)) {
949       // Get or create the virtual register to hold the pointer or code.  Mark
950       // the live in physreg and copy into the vreg.
951       MCPhysReg EHPhysReg = TLI->getExceptionPointerRegister();
952       assert(EHPhysReg && "target lacks exception pointer register");
953       MBB->addLiveIn(EHPhysReg);
954       unsigned VReg = FuncInfo->getCatchPadExceptionPointerVReg(CPI, PtrRC);
955       BuildMI(*MBB, FuncInfo->InsertPt, SDB->getCurDebugLoc(),
956               TII->get(TargetOpcode::COPY), VReg)
957           .addReg(EHPhysReg, RegState::Kill);
958     }
959     return true;
960   }
961
962   if (!LLVMBB->isLandingPad())
963     return true;
964
965   // Add a label to mark the beginning of the landing pad.  Deletion of the
966   // landing pad can thus be detected via the MachineModuleInfo.
967   MCSymbol *Label = MF->getMMI().addLandingPad(MBB);
968
969   // Assign the call site to the landing pad's begin label.
970   MF->getMMI().setCallSiteLandingPad(Label, SDB->LPadToCallSiteMap[MBB]);
971
972   const MCInstrDesc &II = TII->get(TargetOpcode::EH_LABEL);
973   BuildMI(*MBB, FuncInfo->InsertPt, SDB->getCurDebugLoc(), II)
974     .addSym(Label);
975
976   // If this personality function uses funclets, we need to split the landing
977   // pad into several BBs.
978   const Constant *Personality = MF->getFunction()->getPersonalityFn();
979   if (const auto *PF = dyn_cast<Function>(Personality->stripPointerCasts()))
980     MF->getMMI().addPersonality(PF);
981   EHPersonality PersonalityType = classifyEHPersonality(Personality);
982
983   if (isFuncletEHPersonality(PersonalityType)) {
984     SmallVector<MachineBasicBlock *, 4> ClauseBBs;
985     const IntrinsicInst *ActionsCall =
986         dyn_cast<IntrinsicInst>(LLVMBB->getFirstInsertionPt());
987     // Get all invoke BBs that unwind to this landingpad.
988     SmallVector<MachineBasicBlock *, 4> InvokeBBs(MBB->pred_begin(),
989                                                   MBB->pred_end());
990     if (ActionsCall && ActionsCall->getIntrinsicID() == Intrinsic::eh_actions) {
991       // If this is a call to llvm.eh.actions followed by indirectbr, then we've
992       // run WinEHPrepare, and we should remove this block from the machine CFG.
993       // Mark the targets of the indirectbr as landingpads instead.
994       for (const BasicBlock *LLVMSucc : successors(LLVMBB)) {
995         MachineBasicBlock *ClauseBB = FuncInfo->MBBMap[LLVMSucc];
996         // Add the edge from the invoke to the clause.
997         for (MachineBasicBlock *InvokeBB : InvokeBBs)
998           InvokeBB->addSuccessor(ClauseBB);
999
1000         // Mark the clause as a landing pad or MI passes will delete it.
1001         ClauseBB->setIsEHPad();
1002       }
1003     }
1004
1005     // Remove the edge from the invoke to the lpad.
1006     for (MachineBasicBlock *InvokeBB : InvokeBBs)
1007       InvokeBB->removeSuccessor(MBB);
1008
1009     // Don't select instructions for the landingpad.
1010     return false;
1011   }
1012
1013   // Mark exception register as live in.
1014   if (unsigned Reg = TLI->getExceptionPointerRegister())
1015     FuncInfo->ExceptionPointerVirtReg = MBB->addLiveIn(Reg, PtrRC);
1016
1017   // Mark exception selector register as live in.
1018   if (unsigned Reg = TLI->getExceptionSelectorRegister())
1019     FuncInfo->ExceptionSelectorVirtReg = MBB->addLiveIn(Reg, PtrRC);
1020
1021   return true;
1022 }
1023
1024 /// isFoldedOrDeadInstruction - Return true if the specified instruction is
1025 /// side-effect free and is either dead or folded into a generated instruction.
1026 /// Return false if it needs to be emitted.
1027 static bool isFoldedOrDeadInstruction(const Instruction *I,
1028                                       FunctionLoweringInfo *FuncInfo) {
1029   return !I->mayWriteToMemory() && // Side-effecting instructions aren't folded.
1030          !isa<TerminatorInst>(I) &&    // Terminators aren't folded.
1031          !isa<DbgInfoIntrinsic>(I) &&  // Debug instructions aren't folded.
1032          !I->isEHPad() &&              // EH pad instructions aren't folded.
1033          !FuncInfo->isExportedInst(I); // Exported instrs must be computed.
1034 }
1035
1036 #ifndef NDEBUG
1037 // Collect per Instruction statistics for fast-isel misses.  Only those
1038 // instructions that cause the bail are accounted for.  It does not account for
1039 // instructions higher in the block.  Thus, summing the per instructions stats
1040 // will not add up to what is reported by NumFastIselFailures.
1041 static void collectFailStats(const Instruction *I) {
1042   switch (I->getOpcode()) {
1043   default: assert (0 && "<Invalid operator> ");
1044
1045   // Terminators
1046   case Instruction::Ret:         NumFastIselFailRet++; return;
1047   case Instruction::Br:          NumFastIselFailBr++; return;
1048   case Instruction::Switch:      NumFastIselFailSwitch++; return;
1049   case Instruction::IndirectBr:  NumFastIselFailIndirectBr++; return;
1050   case Instruction::Invoke:      NumFastIselFailInvoke++; return;
1051   case Instruction::Resume:      NumFastIselFailResume++; return;
1052   case Instruction::Unreachable: NumFastIselFailUnreachable++; return;
1053
1054   // Standard binary operators...
1055   case Instruction::Add:  NumFastIselFailAdd++; return;
1056   case Instruction::FAdd: NumFastIselFailFAdd++; return;
1057   case Instruction::Sub:  NumFastIselFailSub++; return;
1058   case Instruction::FSub: NumFastIselFailFSub++; return;
1059   case Instruction::Mul:  NumFastIselFailMul++; return;
1060   case Instruction::FMul: NumFastIselFailFMul++; return;
1061   case Instruction::UDiv: NumFastIselFailUDiv++; return;
1062   case Instruction::SDiv: NumFastIselFailSDiv++; return;
1063   case Instruction::FDiv: NumFastIselFailFDiv++; return;
1064   case Instruction::URem: NumFastIselFailURem++; return;
1065   case Instruction::SRem: NumFastIselFailSRem++; return;
1066   case Instruction::FRem: NumFastIselFailFRem++; return;
1067
1068   // Logical operators...
1069   case Instruction::And: NumFastIselFailAnd++; return;
1070   case Instruction::Or:  NumFastIselFailOr++; return;
1071   case Instruction::Xor: NumFastIselFailXor++; return;
1072
1073   // Memory instructions...
1074   case Instruction::Alloca:        NumFastIselFailAlloca++; return;
1075   case Instruction::Load:          NumFastIselFailLoad++; return;
1076   case Instruction::Store:         NumFastIselFailStore++; return;
1077   case Instruction::AtomicCmpXchg: NumFastIselFailAtomicCmpXchg++; return;
1078   case Instruction::AtomicRMW:     NumFastIselFailAtomicRMW++; return;
1079   case Instruction::Fence:         NumFastIselFailFence++; return;
1080   case Instruction::GetElementPtr: NumFastIselFailGetElementPtr++; return;
1081
1082   // Convert instructions...
1083   case Instruction::Trunc:    NumFastIselFailTrunc++; return;
1084   case Instruction::ZExt:     NumFastIselFailZExt++; return;
1085   case Instruction::SExt:     NumFastIselFailSExt++; return;
1086   case Instruction::FPTrunc:  NumFastIselFailFPTrunc++; return;
1087   case Instruction::FPExt:    NumFastIselFailFPExt++; return;
1088   case Instruction::FPToUI:   NumFastIselFailFPToUI++; return;
1089   case Instruction::FPToSI:   NumFastIselFailFPToSI++; return;
1090   case Instruction::UIToFP:   NumFastIselFailUIToFP++; return;
1091   case Instruction::SIToFP:   NumFastIselFailSIToFP++; return;
1092   case Instruction::IntToPtr: NumFastIselFailIntToPtr++; return;
1093   case Instruction::PtrToInt: NumFastIselFailPtrToInt++; return;
1094   case Instruction::BitCast:  NumFastIselFailBitCast++; return;
1095
1096   // Other instructions...
1097   case Instruction::ICmp:           NumFastIselFailICmp++; return;
1098   case Instruction::FCmp:           NumFastIselFailFCmp++; return;
1099   case Instruction::PHI:            NumFastIselFailPHI++; return;
1100   case Instruction::Select:         NumFastIselFailSelect++; return;
1101   case Instruction::Call: {
1102     if (auto const *Intrinsic = dyn_cast<IntrinsicInst>(I)) {
1103       switch (Intrinsic->getIntrinsicID()) {
1104       default:
1105         NumFastIselFailIntrinsicCall++; return;
1106       case Intrinsic::sadd_with_overflow:
1107         NumFastIselFailSAddWithOverflow++; return;
1108       case Intrinsic::uadd_with_overflow:
1109         NumFastIselFailUAddWithOverflow++; return;
1110       case Intrinsic::ssub_with_overflow:
1111         NumFastIselFailSSubWithOverflow++; return;
1112       case Intrinsic::usub_with_overflow:
1113         NumFastIselFailUSubWithOverflow++; return;
1114       case Intrinsic::smul_with_overflow:
1115         NumFastIselFailSMulWithOverflow++; return;
1116       case Intrinsic::umul_with_overflow:
1117         NumFastIselFailUMulWithOverflow++; return;
1118       case Intrinsic::frameaddress:
1119         NumFastIselFailFrameaddress++; return;
1120       case Intrinsic::sqrt:
1121           NumFastIselFailSqrt++; return;
1122       case Intrinsic::experimental_stackmap:
1123         NumFastIselFailStackMap++; return;
1124       case Intrinsic::experimental_patchpoint_void: // fall-through
1125       case Intrinsic::experimental_patchpoint_i64:
1126         NumFastIselFailPatchPoint++; return;
1127       }
1128     }
1129     NumFastIselFailCall++;
1130     return;
1131   }
1132   case Instruction::Shl:            NumFastIselFailShl++; return;
1133   case Instruction::LShr:           NumFastIselFailLShr++; return;
1134   case Instruction::AShr:           NumFastIselFailAShr++; return;
1135   case Instruction::VAArg:          NumFastIselFailVAArg++; return;
1136   case Instruction::ExtractElement: NumFastIselFailExtractElement++; return;
1137   case Instruction::InsertElement:  NumFastIselFailInsertElement++; return;
1138   case Instruction::ShuffleVector:  NumFastIselFailShuffleVector++; return;
1139   case Instruction::ExtractValue:   NumFastIselFailExtractValue++; return;
1140   case Instruction::InsertValue:    NumFastIselFailInsertValue++; return;
1141   case Instruction::LandingPad:     NumFastIselFailLandingPad++; return;
1142   }
1143 }
1144 #endif
1145
1146 void SelectionDAGISel::SelectAllBasicBlocks(const Function &Fn) {
1147   // Initialize the Fast-ISel state, if needed.
1148   FastISel *FastIS = nullptr;
1149   if (TM.Options.EnableFastISel)
1150     FastIS = TLI->createFastISel(*FuncInfo, LibInfo);
1151
1152   // Iterate over all basic blocks in the function.
1153   ReversePostOrderTraversal<const Function*> RPOT(&Fn);
1154   for (ReversePostOrderTraversal<const Function*>::rpo_iterator
1155        I = RPOT.begin(), E = RPOT.end(); I != E; ++I) {
1156     const BasicBlock *LLVMBB = *I;
1157
1158     if (OptLevel != CodeGenOpt::None) {
1159       bool AllPredsVisited = true;
1160       for (const_pred_iterator PI = pred_begin(LLVMBB), PE = pred_end(LLVMBB);
1161            PI != PE; ++PI) {
1162         if (!FuncInfo->VisitedBBs.count(*PI)) {
1163           AllPredsVisited = false;
1164           break;
1165         }
1166       }
1167
1168       if (AllPredsVisited) {
1169         for (BasicBlock::const_iterator I = LLVMBB->begin();
1170              const PHINode *PN = dyn_cast<PHINode>(I); ++I)
1171           FuncInfo->ComputePHILiveOutRegInfo(PN);
1172       } else {
1173         for (BasicBlock::const_iterator I = LLVMBB->begin();
1174              const PHINode *PN = dyn_cast<PHINode>(I); ++I)
1175           FuncInfo->InvalidatePHILiveOutRegInfo(PN);
1176       }
1177
1178       FuncInfo->VisitedBBs.insert(LLVMBB);
1179     }
1180
1181     BasicBlock::const_iterator const Begin = LLVMBB->getFirstNonPHI();
1182     BasicBlock::const_iterator const End = LLVMBB->end();
1183     BasicBlock::const_iterator BI = End;
1184
1185     FuncInfo->MBB = FuncInfo->MBBMap[LLVMBB];
1186     if (!FuncInfo->MBB)
1187       continue; // Some blocks like catchpads have no code or MBB.
1188     FuncInfo->InsertPt = FuncInfo->MBB->getFirstNonPHI();
1189
1190     // Setup an EH landing-pad block.
1191     FuncInfo->ExceptionPointerVirtReg = 0;
1192     FuncInfo->ExceptionSelectorVirtReg = 0;
1193     if (!PrepareEHLandingPad())
1194       continue;
1195
1196     // Before doing SelectionDAG ISel, see if FastISel has been requested.
1197     if (FastIS) {
1198       FastIS->startNewBlock();
1199
1200       // Emit code for any incoming arguments. This must happen before
1201       // beginning FastISel on the entry block.
1202       if (LLVMBB == &Fn.getEntryBlock()) {
1203         ++NumEntryBlocks;
1204
1205         // Lower any arguments needed in this block if this is the entry block.
1206         if (!FastIS->lowerArguments()) {
1207           // Fast isel failed to lower these arguments
1208           ++NumFastIselFailLowerArguments;
1209           if (EnableFastISelAbort > 1)
1210             report_fatal_error("FastISel didn't lower all arguments");
1211
1212           // Use SelectionDAG argument lowering
1213           LowerArguments(Fn);
1214           CurDAG->setRoot(SDB->getControlRoot());
1215           SDB->clear();
1216           CodeGenAndEmitDAG();
1217         }
1218
1219         // If we inserted any instructions at the beginning, make a note of
1220         // where they are, so we can be sure to emit subsequent instructions
1221         // after them.
1222         if (FuncInfo->InsertPt != FuncInfo->MBB->begin())
1223           FastIS->setLastLocalValue(std::prev(FuncInfo->InsertPt));
1224         else
1225           FastIS->setLastLocalValue(nullptr);
1226       }
1227
1228       unsigned NumFastIselRemaining = std::distance(Begin, End);
1229       // Do FastISel on as many instructions as possible.
1230       for (; BI != Begin; --BI) {
1231         const Instruction *Inst = std::prev(BI);
1232
1233         // If we no longer require this instruction, skip it.
1234         if (isFoldedOrDeadInstruction(Inst, FuncInfo)) {
1235           --NumFastIselRemaining;
1236           continue;
1237         }
1238
1239         // Bottom-up: reset the insert pos at the top, after any local-value
1240         // instructions.
1241         FastIS->recomputeInsertPt();
1242
1243         // Try to select the instruction with FastISel.
1244         if (FastIS->selectInstruction(Inst)) {
1245           --NumFastIselRemaining;
1246           ++NumFastIselSuccess;
1247           // If fast isel succeeded, skip over all the folded instructions, and
1248           // then see if there is a load right before the selected instructions.
1249           // Try to fold the load if so.
1250           const Instruction *BeforeInst = Inst;
1251           while (BeforeInst != Begin) {
1252             BeforeInst = std::prev(BasicBlock::const_iterator(BeforeInst));
1253             if (!isFoldedOrDeadInstruction(BeforeInst, FuncInfo))
1254               break;
1255           }
1256           if (BeforeInst != Inst && isa<LoadInst>(BeforeInst) &&
1257               BeforeInst->hasOneUse() &&
1258               FastIS->tryToFoldLoad(cast<LoadInst>(BeforeInst), Inst)) {
1259             // If we succeeded, don't re-select the load.
1260             BI = std::next(BasicBlock::const_iterator(BeforeInst));
1261             --NumFastIselRemaining;
1262             ++NumFastIselSuccess;
1263           }
1264           continue;
1265         }
1266
1267 #ifndef NDEBUG
1268         if (EnableFastISelVerbose2)
1269           collectFailStats(Inst);
1270 #endif
1271
1272         // Then handle certain instructions as single-LLVM-Instruction blocks.
1273         if (isa<CallInst>(Inst)) {
1274
1275           if (EnableFastISelVerbose || EnableFastISelAbort) {
1276             dbgs() << "FastISel missed call: ";
1277             Inst->dump();
1278           }
1279           if (EnableFastISelAbort > 2)
1280             // FastISel selector couldn't handle something and bailed.
1281             // For the purpose of debugging, just abort.
1282             report_fatal_error("FastISel didn't select the entire block");
1283
1284           if (!Inst->getType()->isVoidTy() && !Inst->getType()->isTokenTy() &&
1285               !Inst->use_empty()) {
1286             unsigned &R = FuncInfo->ValueMap[Inst];
1287             if (!R)
1288               R = FuncInfo->CreateRegs(Inst->getType());
1289           }
1290
1291           bool HadTailCall = false;
1292           MachineBasicBlock::iterator SavedInsertPt = FuncInfo->InsertPt;
1293           SelectBasicBlock(Inst, BI, HadTailCall);
1294
1295           // If the call was emitted as a tail call, we're done with the block.
1296           // We also need to delete any previously emitted instructions.
1297           if (HadTailCall) {
1298             FastIS->removeDeadCode(SavedInsertPt, FuncInfo->MBB->end());
1299             --BI;
1300             break;
1301           }
1302
1303           // Recompute NumFastIselRemaining as Selection DAG instruction
1304           // selection may have handled the call, input args, etc.
1305           unsigned RemainingNow = std::distance(Begin, BI);
1306           NumFastIselFailures += NumFastIselRemaining - RemainingNow;
1307           NumFastIselRemaining = RemainingNow;
1308           continue;
1309         }
1310
1311         bool ShouldAbort = EnableFastISelAbort;
1312         if (EnableFastISelVerbose || EnableFastISelAbort) {
1313           if (isa<TerminatorInst>(Inst)) {
1314             // Use a different message for terminator misses.
1315             dbgs() << "FastISel missed terminator: ";
1316             // Don't abort unless for terminator unless the level is really high
1317             ShouldAbort = (EnableFastISelAbort > 2);
1318           } else {
1319             dbgs() << "FastISel miss: ";
1320           }
1321           Inst->dump();
1322         }
1323         if (ShouldAbort)
1324           // FastISel selector couldn't handle something and bailed.
1325           // For the purpose of debugging, just abort.
1326           report_fatal_error("FastISel didn't select the entire block");
1327
1328         NumFastIselFailures += NumFastIselRemaining;
1329         break;
1330       }
1331
1332       FastIS->recomputeInsertPt();
1333     } else {
1334       // Lower any arguments needed in this block if this is the entry block.
1335       if (LLVMBB == &Fn.getEntryBlock()) {
1336         ++NumEntryBlocks;
1337         LowerArguments(Fn);
1338       }
1339     }
1340
1341     if (Begin != BI)
1342       ++NumDAGBlocks;
1343     else
1344       ++NumFastIselBlocks;
1345
1346     if (Begin != BI) {
1347       // Run SelectionDAG instruction selection on the remainder of the block
1348       // not handled by FastISel. If FastISel is not run, this is the entire
1349       // block.
1350       bool HadTailCall;
1351       SelectBasicBlock(Begin, BI, HadTailCall);
1352     }
1353
1354     FinishBasicBlock();
1355     FuncInfo->PHINodesToUpdate.clear();
1356   }
1357
1358   delete FastIS;
1359   SDB->clearDanglingDebugInfo();
1360   SDB->SPDescriptor.resetPerFunctionState();
1361 }
1362
1363 /// Given that the input MI is before a partial terminator sequence TSeq, return
1364 /// true if M + TSeq also a partial terminator sequence.
1365 ///
1366 /// A Terminator sequence is a sequence of MachineInstrs which at this point in
1367 /// lowering copy vregs into physical registers, which are then passed into
1368 /// terminator instructors so we can satisfy ABI constraints. A partial
1369 /// terminator sequence is an improper subset of a terminator sequence (i.e. it
1370 /// may be the whole terminator sequence).
1371 static bool MIIsInTerminatorSequence(const MachineInstr *MI) {
1372   // If we do not have a copy or an implicit def, we return true if and only if
1373   // MI is a debug value.
1374   if (!MI->isCopy() && !MI->isImplicitDef())
1375     // Sometimes DBG_VALUE MI sneak in between the copies from the vregs to the
1376     // physical registers if there is debug info associated with the terminator
1377     // of our mbb. We want to include said debug info in our terminator
1378     // sequence, so we return true in that case.
1379     return MI->isDebugValue();
1380
1381   // We have left the terminator sequence if we are not doing one of the
1382   // following:
1383   //
1384   // 1. Copying a vreg into a physical register.
1385   // 2. Copying a vreg into a vreg.
1386   // 3. Defining a register via an implicit def.
1387
1388   // OPI should always be a register definition...
1389   MachineInstr::const_mop_iterator OPI = MI->operands_begin();
1390   if (!OPI->isReg() || !OPI->isDef())
1391     return false;
1392
1393   // Defining any register via an implicit def is always ok.
1394   if (MI->isImplicitDef())
1395     return true;
1396
1397   // Grab the copy source...
1398   MachineInstr::const_mop_iterator OPI2 = OPI;
1399   ++OPI2;
1400   assert(OPI2 != MI->operands_end()
1401          && "Should have a copy implying we should have 2 arguments.");
1402
1403   // Make sure that the copy dest is not a vreg when the copy source is a
1404   // physical register.
1405   if (!OPI2->isReg() ||
1406       (!TargetRegisterInfo::isPhysicalRegister(OPI->getReg()) &&
1407        TargetRegisterInfo::isPhysicalRegister(OPI2->getReg())))
1408     return false;
1409
1410   return true;
1411 }
1412
1413 /// Find the split point at which to splice the end of BB into its success stack
1414 /// protector check machine basic block.
1415 ///
1416 /// On many platforms, due to ABI constraints, terminators, even before register
1417 /// allocation, use physical registers. This creates an issue for us since
1418 /// physical registers at this point can not travel across basic
1419 /// blocks. Luckily, selectiondag always moves physical registers into vregs
1420 /// when they enter functions and moves them through a sequence of copies back
1421 /// into the physical registers right before the terminator creating a
1422 /// ``Terminator Sequence''. This function is searching for the beginning of the
1423 /// terminator sequence so that we can ensure that we splice off not just the
1424 /// terminator, but additionally the copies that move the vregs into the
1425 /// physical registers.
1426 static MachineBasicBlock::iterator
1427 FindSplitPointForStackProtector(MachineBasicBlock *BB, DebugLoc DL) {
1428   MachineBasicBlock::iterator SplitPoint = BB->getFirstTerminator();
1429   //
1430   if (SplitPoint == BB->begin())
1431     return SplitPoint;
1432
1433   MachineBasicBlock::iterator Start = BB->begin();
1434   MachineBasicBlock::iterator Previous = SplitPoint;
1435   --Previous;
1436
1437   while (MIIsInTerminatorSequence(Previous)) {
1438     SplitPoint = Previous;
1439     if (Previous == Start)
1440       break;
1441     --Previous;
1442   }
1443
1444   return SplitPoint;
1445 }
1446
1447 void
1448 SelectionDAGISel::FinishBasicBlock() {
1449
1450   DEBUG(dbgs() << "Total amount of phi nodes to update: "
1451                << FuncInfo->PHINodesToUpdate.size() << "\n";
1452         for (unsigned i = 0, e = FuncInfo->PHINodesToUpdate.size(); i != e; ++i)
1453           dbgs() << "Node " << i << " : ("
1454                  << FuncInfo->PHINodesToUpdate[i].first
1455                  << ", " << FuncInfo->PHINodesToUpdate[i].second << ")\n");
1456
1457   // Next, now that we know what the last MBB the LLVM BB expanded is, update
1458   // PHI nodes in successors.
1459   for (unsigned i = 0, e = FuncInfo->PHINodesToUpdate.size(); i != e; ++i) {
1460     MachineInstrBuilder PHI(*MF, FuncInfo->PHINodesToUpdate[i].first);
1461     assert(PHI->isPHI() &&
1462            "This is not a machine PHI node that we are updating!");
1463     if (!FuncInfo->MBB->isSuccessor(PHI->getParent()))
1464       continue;
1465     PHI.addReg(FuncInfo->PHINodesToUpdate[i].second).addMBB(FuncInfo->MBB);
1466   }
1467
1468   // Handle stack protector.
1469   if (SDB->SPDescriptor.shouldEmitStackProtector()) {
1470     MachineBasicBlock *ParentMBB = SDB->SPDescriptor.getParentMBB();
1471     MachineBasicBlock *SuccessMBB = SDB->SPDescriptor.getSuccessMBB();
1472
1473     // Find the split point to split the parent mbb. At the same time copy all
1474     // physical registers used in the tail of parent mbb into virtual registers
1475     // before the split point and back into physical registers after the split
1476     // point. This prevents us needing to deal with Live-ins and many other
1477     // register allocation issues caused by us splitting the parent mbb. The
1478     // register allocator will clean up said virtual copies later on.
1479     MachineBasicBlock::iterator SplitPoint =
1480       FindSplitPointForStackProtector(ParentMBB, SDB->getCurDebugLoc());
1481
1482     // Splice the terminator of ParentMBB into SuccessMBB.
1483     SuccessMBB->splice(SuccessMBB->end(), ParentMBB,
1484                        SplitPoint,
1485                        ParentMBB->end());
1486
1487     // Add compare/jump on neq/jump to the parent BB.
1488     FuncInfo->MBB = ParentMBB;
1489     FuncInfo->InsertPt = ParentMBB->end();
1490     SDB->visitSPDescriptorParent(SDB->SPDescriptor, ParentMBB);
1491     CurDAG->setRoot(SDB->getRoot());
1492     SDB->clear();
1493     CodeGenAndEmitDAG();
1494
1495     // CodeGen Failure MBB if we have not codegened it yet.
1496     MachineBasicBlock *FailureMBB = SDB->SPDescriptor.getFailureMBB();
1497     if (!FailureMBB->size()) {
1498       FuncInfo->MBB = FailureMBB;
1499       FuncInfo->InsertPt = FailureMBB->end();
1500       SDB->visitSPDescriptorFailure(SDB->SPDescriptor);
1501       CurDAG->setRoot(SDB->getRoot());
1502       SDB->clear();
1503       CodeGenAndEmitDAG();
1504     }
1505
1506     // Clear the Per-BB State.
1507     SDB->SPDescriptor.resetPerBBState();
1508   }
1509
1510   for (unsigned i = 0, e = SDB->BitTestCases.size(); i != e; ++i) {
1511     // Lower header first, if it wasn't already lowered
1512     if (!SDB->BitTestCases[i].Emitted) {
1513       // Set the current basic block to the mbb we wish to insert the code into
1514       FuncInfo->MBB = SDB->BitTestCases[i].Parent;
1515       FuncInfo->InsertPt = FuncInfo->MBB->end();
1516       // Emit the code
1517       SDB->visitBitTestHeader(SDB->BitTestCases[i], FuncInfo->MBB);
1518       CurDAG->setRoot(SDB->getRoot());
1519       SDB->clear();
1520       CodeGenAndEmitDAG();
1521     }
1522
1523     uint32_t UnhandledWeight = SDB->BitTestCases[i].Weight;
1524
1525     for (unsigned j = 0, ej = SDB->BitTestCases[i].Cases.size(); j != ej; ++j) {
1526       UnhandledWeight -= SDB->BitTestCases[i].Cases[j].ExtraWeight;
1527       // Set the current basic block to the mbb we wish to insert the code into
1528       FuncInfo->MBB = SDB->BitTestCases[i].Cases[j].ThisBB;
1529       FuncInfo->InsertPt = FuncInfo->MBB->end();
1530       // Emit the code
1531
1532       // If all cases cover a contiguous range, it is not necessary to jump to
1533       // the default block after the last bit test fails. This is because the
1534       // range check during bit test header creation has guaranteed that every
1535       // case here doesn't go outside the range.
1536       MachineBasicBlock *NextMBB;
1537       if (SDB->BitTestCases[i].ContiguousRange && j + 2 == ej)
1538         NextMBB = SDB->BitTestCases[i].Cases[j + 1].TargetBB;
1539       else if (j + 1 != ej)
1540         NextMBB = SDB->BitTestCases[i].Cases[j + 1].ThisBB;
1541       else
1542         NextMBB = SDB->BitTestCases[i].Default;
1543
1544       SDB->visitBitTestCase(SDB->BitTestCases[i],
1545                             NextMBB,
1546                             UnhandledWeight,
1547                             SDB->BitTestCases[i].Reg,
1548                             SDB->BitTestCases[i].Cases[j],
1549                             FuncInfo->MBB);
1550
1551       CurDAG->setRoot(SDB->getRoot());
1552       SDB->clear();
1553       CodeGenAndEmitDAG();
1554
1555       if (SDB->BitTestCases[i].ContiguousRange && j + 2 == ej)
1556         break;
1557     }
1558
1559     // Update PHI Nodes
1560     for (unsigned pi = 0, pe = FuncInfo->PHINodesToUpdate.size();
1561          pi != pe; ++pi) {
1562       MachineInstrBuilder PHI(*MF, FuncInfo->PHINodesToUpdate[pi].first);
1563       MachineBasicBlock *PHIBB = PHI->getParent();
1564       assert(PHI->isPHI() &&
1565              "This is not a machine PHI node that we are updating!");
1566       // This is "default" BB. We have two jumps to it. From "header" BB and
1567       // from last "case" BB.
1568       if (PHIBB == SDB->BitTestCases[i].Default)
1569         PHI.addReg(FuncInfo->PHINodesToUpdate[pi].second)
1570            .addMBB(SDB->BitTestCases[i].Parent)
1571            .addReg(FuncInfo->PHINodesToUpdate[pi].second)
1572            .addMBB(SDB->BitTestCases[i].Cases.back().ThisBB);
1573       // One of "cases" BB.
1574       for (unsigned j = 0, ej = SDB->BitTestCases[i].Cases.size();
1575            j != ej; ++j) {
1576         MachineBasicBlock* cBB = SDB->BitTestCases[i].Cases[j].ThisBB;
1577         if (cBB->isSuccessor(PHIBB))
1578           PHI.addReg(FuncInfo->PHINodesToUpdate[pi].second).addMBB(cBB);
1579       }
1580     }
1581   }
1582   SDB->BitTestCases.clear();
1583
1584   // If the JumpTable record is filled in, then we need to emit a jump table.
1585   // Updating the PHI nodes is tricky in this case, since we need to determine
1586   // whether the PHI is a successor of the range check MBB or the jump table MBB
1587   for (unsigned i = 0, e = SDB->JTCases.size(); i != e; ++i) {
1588     // Lower header first, if it wasn't already lowered
1589     if (!SDB->JTCases[i].first.Emitted) {
1590       // Set the current basic block to the mbb we wish to insert the code into
1591       FuncInfo->MBB = SDB->JTCases[i].first.HeaderBB;
1592       FuncInfo->InsertPt = FuncInfo->MBB->end();
1593       // Emit the code
1594       SDB->visitJumpTableHeader(SDB->JTCases[i].second, SDB->JTCases[i].first,
1595                                 FuncInfo->MBB);
1596       CurDAG->setRoot(SDB->getRoot());
1597       SDB->clear();
1598       CodeGenAndEmitDAG();
1599     }
1600
1601     // Set the current basic block to the mbb we wish to insert the code into
1602     FuncInfo->MBB = SDB->JTCases[i].second.MBB;
1603     FuncInfo->InsertPt = FuncInfo->MBB->end();
1604     // Emit the code
1605     SDB->visitJumpTable(SDB->JTCases[i].second);
1606     CurDAG->setRoot(SDB->getRoot());
1607     SDB->clear();
1608     CodeGenAndEmitDAG();
1609
1610     // Update PHI Nodes
1611     for (unsigned pi = 0, pe = FuncInfo->PHINodesToUpdate.size();
1612          pi != pe; ++pi) {
1613       MachineInstrBuilder PHI(*MF, FuncInfo->PHINodesToUpdate[pi].first);
1614       MachineBasicBlock *PHIBB = PHI->getParent();
1615       assert(PHI->isPHI() &&
1616              "This is not a machine PHI node that we are updating!");
1617       // "default" BB. We can go there only from header BB.
1618       if (PHIBB == SDB->JTCases[i].second.Default)
1619         PHI.addReg(FuncInfo->PHINodesToUpdate[pi].second)
1620            .addMBB(SDB->JTCases[i].first.HeaderBB);
1621       // JT BB. Just iterate over successors here
1622       if (FuncInfo->MBB->isSuccessor(PHIBB))
1623         PHI.addReg(FuncInfo->PHINodesToUpdate[pi].second).addMBB(FuncInfo->MBB);
1624     }
1625   }
1626   SDB->JTCases.clear();
1627
1628   // If we generated any switch lowering information, build and codegen any
1629   // additional DAGs necessary.
1630   for (unsigned i = 0, e = SDB->SwitchCases.size(); i != e; ++i) {
1631     // Set the current basic block to the mbb we wish to insert the code into
1632     FuncInfo->MBB = SDB->SwitchCases[i].ThisBB;
1633     FuncInfo->InsertPt = FuncInfo->MBB->end();
1634
1635     // Determine the unique successors.
1636     SmallVector<MachineBasicBlock *, 2> Succs;
1637     Succs.push_back(SDB->SwitchCases[i].TrueBB);
1638     if (SDB->SwitchCases[i].TrueBB != SDB->SwitchCases[i].FalseBB)
1639       Succs.push_back(SDB->SwitchCases[i].FalseBB);
1640
1641     // Emit the code. Note that this could result in FuncInfo->MBB being split.
1642     SDB->visitSwitchCase(SDB->SwitchCases[i], FuncInfo->MBB);
1643     CurDAG->setRoot(SDB->getRoot());
1644     SDB->clear();
1645     CodeGenAndEmitDAG();
1646
1647     // Remember the last block, now that any splitting is done, for use in
1648     // populating PHI nodes in successors.
1649     MachineBasicBlock *ThisBB = FuncInfo->MBB;
1650
1651     // Handle any PHI nodes in successors of this chunk, as if we were coming
1652     // from the original BB before switch expansion.  Note that PHI nodes can
1653     // occur multiple times in PHINodesToUpdate.  We have to be very careful to
1654     // handle them the right number of times.
1655     for (unsigned i = 0, e = Succs.size(); i != e; ++i) {
1656       FuncInfo->MBB = Succs[i];
1657       FuncInfo->InsertPt = FuncInfo->MBB->end();
1658       // FuncInfo->MBB may have been removed from the CFG if a branch was
1659       // constant folded.
1660       if (ThisBB->isSuccessor(FuncInfo->MBB)) {
1661         for (MachineBasicBlock::iterator
1662              MBBI = FuncInfo->MBB->begin(), MBBE = FuncInfo->MBB->end();
1663              MBBI != MBBE && MBBI->isPHI(); ++MBBI) {
1664           MachineInstrBuilder PHI(*MF, MBBI);
1665           // This value for this PHI node is recorded in PHINodesToUpdate.
1666           for (unsigned pn = 0; ; ++pn) {
1667             assert(pn != FuncInfo->PHINodesToUpdate.size() &&
1668                    "Didn't find PHI entry!");
1669             if (FuncInfo->PHINodesToUpdate[pn].first == PHI) {
1670               PHI.addReg(FuncInfo->PHINodesToUpdate[pn].second).addMBB(ThisBB);
1671               break;
1672             }
1673           }
1674         }
1675       }
1676     }
1677   }
1678   SDB->SwitchCases.clear();
1679 }
1680
1681
1682 /// Create the scheduler. If a specific scheduler was specified
1683 /// via the SchedulerRegistry, use it, otherwise select the
1684 /// one preferred by the target.
1685 ///
1686 ScheduleDAGSDNodes *SelectionDAGISel::CreateScheduler() {
1687   return ISHeuristic(this, OptLevel);
1688 }
1689
1690 //===----------------------------------------------------------------------===//
1691 // Helper functions used by the generated instruction selector.
1692 //===----------------------------------------------------------------------===//
1693 // Calls to these methods are generated by tblgen.
1694
1695 /// CheckAndMask - The isel is trying to match something like (and X, 255).  If
1696 /// the dag combiner simplified the 255, we still want to match.  RHS is the
1697 /// actual value in the DAG on the RHS of an AND, and DesiredMaskS is the value
1698 /// specified in the .td file (e.g. 255).
1699 bool SelectionDAGISel::CheckAndMask(SDValue LHS, ConstantSDNode *RHS,
1700                                     int64_t DesiredMaskS) const {
1701   const APInt &ActualMask = RHS->getAPIntValue();
1702   const APInt &DesiredMask = APInt(LHS.getValueSizeInBits(), DesiredMaskS);
1703
1704   // If the actual mask exactly matches, success!
1705   if (ActualMask == DesiredMask)
1706     return true;
1707
1708   // If the actual AND mask is allowing unallowed bits, this doesn't match.
1709   if (ActualMask.intersects(~DesiredMask))
1710     return false;
1711
1712   // Otherwise, the DAG Combiner may have proven that the value coming in is
1713   // either already zero or is not demanded.  Check for known zero input bits.
1714   APInt NeededMask = DesiredMask & ~ActualMask;
1715   if (CurDAG->MaskedValueIsZero(LHS, NeededMask))
1716     return true;
1717
1718   // TODO: check to see if missing bits are just not demanded.
1719
1720   // Otherwise, this pattern doesn't match.
1721   return false;
1722 }
1723
1724 /// CheckOrMask - The isel is trying to match something like (or X, 255).  If
1725 /// the dag combiner simplified the 255, we still want to match.  RHS is the
1726 /// actual value in the DAG on the RHS of an OR, and DesiredMaskS is the value
1727 /// specified in the .td file (e.g. 255).
1728 bool SelectionDAGISel::CheckOrMask(SDValue LHS, ConstantSDNode *RHS,
1729                                    int64_t DesiredMaskS) const {
1730   const APInt &ActualMask = RHS->getAPIntValue();
1731   const APInt &DesiredMask = APInt(LHS.getValueSizeInBits(), DesiredMaskS);
1732
1733   // If the actual mask exactly matches, success!
1734   if (ActualMask == DesiredMask)
1735     return true;
1736
1737   // If the actual AND mask is allowing unallowed bits, this doesn't match.
1738   if (ActualMask.intersects(~DesiredMask))
1739     return false;
1740
1741   // Otherwise, the DAG Combiner may have proven that the value coming in is
1742   // either already zero or is not demanded.  Check for known zero input bits.
1743   APInt NeededMask = DesiredMask & ~ActualMask;
1744
1745   APInt KnownZero, KnownOne;
1746   CurDAG->computeKnownBits(LHS, KnownZero, KnownOne);
1747
1748   // If all the missing bits in the or are already known to be set, match!
1749   if ((NeededMask & KnownOne) == NeededMask)
1750     return true;
1751
1752   // TODO: check to see if missing bits are just not demanded.
1753
1754   // Otherwise, this pattern doesn't match.
1755   return false;
1756 }
1757
1758 /// SelectInlineAsmMemoryOperands - Calls to this are automatically generated
1759 /// by tblgen.  Others should not call it.
1760 void SelectionDAGISel::
1761 SelectInlineAsmMemoryOperands(std::vector<SDValue> &Ops, SDLoc DL) {
1762   std::vector<SDValue> InOps;
1763   std::swap(InOps, Ops);
1764
1765   Ops.push_back(InOps[InlineAsm::Op_InputChain]); // 0
1766   Ops.push_back(InOps[InlineAsm::Op_AsmString]);  // 1
1767   Ops.push_back(InOps[InlineAsm::Op_MDNode]);     // 2, !srcloc
1768   Ops.push_back(InOps[InlineAsm::Op_ExtraInfo]);  // 3 (SideEffect, AlignStack)
1769
1770   unsigned i = InlineAsm::Op_FirstOperand, e = InOps.size();
1771   if (InOps[e-1].getValueType() == MVT::Glue)
1772     --e;  // Don't process a glue operand if it is here.
1773
1774   while (i != e) {
1775     unsigned Flags = cast<ConstantSDNode>(InOps[i])->getZExtValue();
1776     if (!InlineAsm::isMemKind(Flags)) {
1777       // Just skip over this operand, copying the operands verbatim.
1778       Ops.insert(Ops.end(), InOps.begin()+i,
1779                  InOps.begin()+i+InlineAsm::getNumOperandRegisters(Flags) + 1);
1780       i += InlineAsm::getNumOperandRegisters(Flags) + 1;
1781     } else {
1782       assert(InlineAsm::getNumOperandRegisters(Flags) == 1 &&
1783              "Memory operand with multiple values?");
1784
1785       unsigned TiedToOperand;
1786       if (InlineAsm::isUseOperandTiedToDef(Flags, TiedToOperand)) {
1787         // We need the constraint ID from the operand this is tied to.
1788         unsigned CurOp = InlineAsm::Op_FirstOperand;
1789         Flags = cast<ConstantSDNode>(InOps[CurOp])->getZExtValue();
1790         for (; TiedToOperand; --TiedToOperand) {
1791           CurOp += InlineAsm::getNumOperandRegisters(Flags)+1;
1792           Flags = cast<ConstantSDNode>(InOps[CurOp])->getZExtValue();
1793         }
1794       }
1795
1796       // Otherwise, this is a memory operand.  Ask the target to select it.
1797       std::vector<SDValue> SelOps;
1798       if (SelectInlineAsmMemoryOperand(InOps[i+1],
1799                                        InlineAsm::getMemoryConstraintID(Flags),
1800                                        SelOps))
1801         report_fatal_error("Could not match memory address.  Inline asm"
1802                            " failure!");
1803
1804       // Add this to the output node.
1805       unsigned NewFlags =
1806         InlineAsm::getFlagWord(InlineAsm::Kind_Mem, SelOps.size());
1807       Ops.push_back(CurDAG->getTargetConstant(NewFlags, DL, MVT::i32));
1808       Ops.insert(Ops.end(), SelOps.begin(), SelOps.end());
1809       i += 2;
1810     }
1811   }
1812
1813   // Add the glue input back if present.
1814   if (e != InOps.size())
1815     Ops.push_back(InOps.back());
1816 }
1817
1818 /// findGlueUse - Return use of MVT::Glue value produced by the specified
1819 /// SDNode.
1820 ///
1821 static SDNode *findGlueUse(SDNode *N) {
1822   unsigned FlagResNo = N->getNumValues()-1;
1823   for (SDNode::use_iterator I = N->use_begin(), E = N->use_end(); I != E; ++I) {
1824     SDUse &Use = I.getUse();
1825     if (Use.getResNo() == FlagResNo)
1826       return Use.getUser();
1827   }
1828   return nullptr;
1829 }
1830
1831 /// findNonImmUse - Return true if "Use" is a non-immediate use of "Def".
1832 /// This function recursively traverses up the operand chain, ignoring
1833 /// certain nodes.
1834 static bool findNonImmUse(SDNode *Use, SDNode* Def, SDNode *ImmedUse,
1835                           SDNode *Root, SmallPtrSetImpl<SDNode*> &Visited,
1836                           bool IgnoreChains) {
1837   // The NodeID's are given uniques ID's where a node ID is guaranteed to be
1838   // greater than all of its (recursive) operands.  If we scan to a point where
1839   // 'use' is smaller than the node we're scanning for, then we know we will
1840   // never find it.
1841   //
1842   // The Use may be -1 (unassigned) if it is a newly allocated node.  This can
1843   // happen because we scan down to newly selected nodes in the case of glue
1844   // uses.
1845   if ((Use->getNodeId() < Def->getNodeId() && Use->getNodeId() != -1))
1846     return false;
1847
1848   // Don't revisit nodes if we already scanned it and didn't fail, we know we
1849   // won't fail if we scan it again.
1850   if (!Visited.insert(Use).second)
1851     return false;
1852
1853   for (const SDValue &Op : Use->op_values()) {
1854     // Ignore chain uses, they are validated by HandleMergeInputChains.
1855     if (Op.getValueType() == MVT::Other && IgnoreChains)
1856       continue;
1857
1858     SDNode *N = Op.getNode();
1859     if (N == Def) {
1860       if (Use == ImmedUse || Use == Root)
1861         continue;  // We are not looking for immediate use.
1862       assert(N != Root);
1863       return true;
1864     }
1865
1866     // Traverse up the operand chain.
1867     if (findNonImmUse(N, Def, ImmedUse, Root, Visited, IgnoreChains))
1868       return true;
1869   }
1870   return false;
1871 }
1872
1873 /// IsProfitableToFold - Returns true if it's profitable to fold the specific
1874 /// operand node N of U during instruction selection that starts at Root.
1875 bool SelectionDAGISel::IsProfitableToFold(SDValue N, SDNode *U,
1876                                           SDNode *Root) const {
1877   if (OptLevel == CodeGenOpt::None) return false;
1878   return N.hasOneUse();
1879 }
1880
1881 /// IsLegalToFold - Returns true if the specific operand node N of
1882 /// U can be folded during instruction selection that starts at Root.
1883 bool SelectionDAGISel::IsLegalToFold(SDValue N, SDNode *U, SDNode *Root,
1884                                      CodeGenOpt::Level OptLevel,
1885                                      bool IgnoreChains) {
1886   if (OptLevel == CodeGenOpt::None) return false;
1887
1888   // If Root use can somehow reach N through a path that that doesn't contain
1889   // U then folding N would create a cycle. e.g. In the following
1890   // diagram, Root can reach N through X. If N is folded into into Root, then
1891   // X is both a predecessor and a successor of U.
1892   //
1893   //          [N*]           //
1894   //         ^   ^           //
1895   //        /     \          //
1896   //      [U*]    [X]?       //
1897   //        ^     ^          //
1898   //         \   /           //
1899   //          \ /            //
1900   //         [Root*]         //
1901   //
1902   // * indicates nodes to be folded together.
1903   //
1904   // If Root produces glue, then it gets (even more) interesting. Since it
1905   // will be "glued" together with its glue use in the scheduler, we need to
1906   // check if it might reach N.
1907   //
1908   //          [N*]           //
1909   //         ^   ^           //
1910   //        /     \          //
1911   //      [U*]    [X]?       //
1912   //        ^       ^        //
1913   //         \       \       //
1914   //          \      |       //
1915   //         [Root*] |       //
1916   //          ^      |       //
1917   //          f      |       //
1918   //          |      /       //
1919   //         [Y]    /        //
1920   //           ^   /         //
1921   //           f  /          //
1922   //           | /           //
1923   //          [GU]           //
1924   //
1925   // If GU (glue use) indirectly reaches N (the load), and Root folds N
1926   // (call it Fold), then X is a predecessor of GU and a successor of
1927   // Fold. But since Fold and GU are glued together, this will create
1928   // a cycle in the scheduling graph.
1929
1930   // If the node has glue, walk down the graph to the "lowest" node in the
1931   // glueged set.
1932   EVT VT = Root->getValueType(Root->getNumValues()-1);
1933   while (VT == MVT::Glue) {
1934     SDNode *GU = findGlueUse(Root);
1935     if (!GU)
1936       break;
1937     Root = GU;
1938     VT = Root->getValueType(Root->getNumValues()-1);
1939
1940     // If our query node has a glue result with a use, we've walked up it.  If
1941     // the user (which has already been selected) has a chain or indirectly uses
1942     // the chain, our WalkChainUsers predicate will not consider it.  Because of
1943     // this, we cannot ignore chains in this predicate.
1944     IgnoreChains = false;
1945   }
1946
1947
1948   SmallPtrSet<SDNode*, 16> Visited;
1949   return !findNonImmUse(Root, N.getNode(), U, Root, Visited, IgnoreChains);
1950 }
1951
1952 SDNode *SelectionDAGISel::Select_INLINEASM(SDNode *N) {
1953   SDLoc DL(N);
1954
1955   std::vector<SDValue> Ops(N->op_begin(), N->op_end());
1956   SelectInlineAsmMemoryOperands(Ops, DL);
1957
1958   const EVT VTs[] = {MVT::Other, MVT::Glue};
1959   SDValue New = CurDAG->getNode(ISD::INLINEASM, DL, VTs, Ops);
1960   New->setNodeId(-1);
1961   return New.getNode();
1962 }
1963
1964 SDNode
1965 *SelectionDAGISel::Select_READ_REGISTER(SDNode *Op) {
1966   SDLoc dl(Op);
1967   MDNodeSDNode *MD = dyn_cast<MDNodeSDNode>(Op->getOperand(1));
1968   const MDString *RegStr = dyn_cast<MDString>(MD->getMD()->getOperand(0));
1969   unsigned Reg =
1970       TLI->getRegisterByName(RegStr->getString().data(), Op->getValueType(0),
1971                              *CurDAG);
1972   SDValue New = CurDAG->getCopyFromReg(
1973                         Op->getOperand(0), dl, Reg, Op->getValueType(0));
1974   New->setNodeId(-1);
1975   return New.getNode();
1976 }
1977
1978 SDNode
1979 *SelectionDAGISel::Select_WRITE_REGISTER(SDNode *Op) {
1980   SDLoc dl(Op);
1981   MDNodeSDNode *MD = dyn_cast<MDNodeSDNode>(Op->getOperand(1));
1982   const MDString *RegStr = dyn_cast<MDString>(MD->getMD()->getOperand(0));
1983   unsigned Reg = TLI->getRegisterByName(RegStr->getString().data(),
1984                                         Op->getOperand(2).getValueType(),
1985                                         *CurDAG);
1986   SDValue New = CurDAG->getCopyToReg(
1987                         Op->getOperand(0), dl, Reg, Op->getOperand(2));
1988   New->setNodeId(-1);
1989   return New.getNode();
1990 }
1991
1992
1993
1994 SDNode *SelectionDAGISel::Select_UNDEF(SDNode *N) {
1995   return CurDAG->SelectNodeTo(N, TargetOpcode::IMPLICIT_DEF,N->getValueType(0));
1996 }
1997
1998 /// GetVBR - decode a vbr encoding whose top bit is set.
1999 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline uint64_t
2000 GetVBR(uint64_t Val, const unsigned char *MatcherTable, unsigned &Idx) {
2001   assert(Val >= 128 && "Not a VBR");
2002   Val &= 127;  // Remove first vbr bit.
2003
2004   unsigned Shift = 7;
2005   uint64_t NextBits;
2006   do {
2007     NextBits = MatcherTable[Idx++];
2008     Val |= (NextBits&127) << Shift;
2009     Shift += 7;
2010   } while (NextBits & 128);
2011
2012   return Val;
2013 }
2014
2015
2016 /// UpdateChainsAndGlue - When a match is complete, this method updates uses of
2017 /// interior glue and chain results to use the new glue and chain results.
2018 void SelectionDAGISel::
2019 UpdateChainsAndGlue(SDNode *NodeToMatch, SDValue InputChain,
2020                     const SmallVectorImpl<SDNode*> &ChainNodesMatched,
2021                     SDValue InputGlue,
2022                     const SmallVectorImpl<SDNode*> &GlueResultNodesMatched,
2023                     bool isMorphNodeTo) {
2024   SmallVector<SDNode*, 4> NowDeadNodes;
2025
2026   // Now that all the normal results are replaced, we replace the chain and
2027   // glue results if present.
2028   if (!ChainNodesMatched.empty()) {
2029     assert(InputChain.getNode() &&
2030            "Matched input chains but didn't produce a chain");
2031     // Loop over all of the nodes we matched that produced a chain result.
2032     // Replace all the chain results with the final chain we ended up with.
2033     for (unsigned i = 0, e = ChainNodesMatched.size(); i != e; ++i) {
2034       SDNode *ChainNode = ChainNodesMatched[i];
2035
2036       // If this node was already deleted, don't look at it.
2037       if (ChainNode->getOpcode() == ISD::DELETED_NODE)
2038         continue;
2039
2040       // Don't replace the results of the root node if we're doing a
2041       // MorphNodeTo.
2042       if (ChainNode == NodeToMatch && isMorphNodeTo)
2043         continue;
2044
2045       SDValue ChainVal = SDValue(ChainNode, ChainNode->getNumValues()-1);
2046       if (ChainVal.getValueType() == MVT::Glue)
2047         ChainVal = ChainVal.getValue(ChainVal->getNumValues()-2);
2048       assert(ChainVal.getValueType() == MVT::Other && "Not a chain?");
2049       CurDAG->ReplaceAllUsesOfValueWith(ChainVal, InputChain);
2050
2051       // If the node became dead and we haven't already seen it, delete it.
2052       if (ChainNode->use_empty() &&
2053           !std::count(NowDeadNodes.begin(), NowDeadNodes.end(), ChainNode))
2054         NowDeadNodes.push_back(ChainNode);
2055     }
2056   }
2057
2058   // If the result produces glue, update any glue results in the matched
2059   // pattern with the glue result.
2060   if (InputGlue.getNode()) {
2061     // Handle any interior nodes explicitly marked.
2062     for (unsigned i = 0, e = GlueResultNodesMatched.size(); i != e; ++i) {
2063       SDNode *FRN = GlueResultNodesMatched[i];
2064
2065       // If this node was already deleted, don't look at it.
2066       if (FRN->getOpcode() == ISD::DELETED_NODE)
2067         continue;
2068
2069       assert(FRN->getValueType(FRN->getNumValues()-1) == MVT::Glue &&
2070              "Doesn't have a glue result");
2071       CurDAG->ReplaceAllUsesOfValueWith(SDValue(FRN, FRN->getNumValues()-1),
2072                                         InputGlue);
2073
2074       // If the node became dead and we haven't already seen it, delete it.
2075       if (FRN->use_empty() &&
2076           !std::count(NowDeadNodes.begin(), NowDeadNodes.end(), FRN))
2077         NowDeadNodes.push_back(FRN);
2078     }
2079   }
2080
2081   if (!NowDeadNodes.empty())
2082     CurDAG->RemoveDeadNodes(NowDeadNodes);
2083
2084   DEBUG(dbgs() << "ISEL: Match complete!\n");
2085 }
2086
2087 enum ChainResult {
2088   CR_Simple,
2089   CR_InducesCycle,
2090   CR_LeadsToInteriorNode
2091 };
2092
2093 /// WalkChainUsers - Walk down the users of the specified chained node that is
2094 /// part of the pattern we're matching, looking at all of the users we find.
2095 /// This determines whether something is an interior node, whether we have a
2096 /// non-pattern node in between two pattern nodes (which prevent folding because
2097 /// it would induce a cycle) and whether we have a TokenFactor node sandwiched
2098 /// between pattern nodes (in which case the TF becomes part of the pattern).
2099 ///
2100 /// The walk we do here is guaranteed to be small because we quickly get down to
2101 /// already selected nodes "below" us.
2102 static ChainResult
2103 WalkChainUsers(const SDNode *ChainedNode,
2104                SmallVectorImpl<SDNode*> &ChainedNodesInPattern,
2105                SmallVectorImpl<SDNode*> &InteriorChainedNodes) {
2106   ChainResult Result = CR_Simple;
2107
2108   for (SDNode::use_iterator UI = ChainedNode->use_begin(),
2109          E = ChainedNode->use_end(); UI != E; ++UI) {
2110     // Make sure the use is of the chain, not some other value we produce.
2111     if (UI.getUse().getValueType() != MVT::Other) continue;
2112
2113     SDNode *User = *UI;
2114
2115     if (User->getOpcode() == ISD::HANDLENODE)  // Root of the graph.
2116       continue;
2117
2118     // If we see an already-selected machine node, then we've gone beyond the
2119     // pattern that we're selecting down into the already selected chunk of the
2120     // DAG.
2121     unsigned UserOpcode = User->getOpcode();
2122     if (User->isMachineOpcode() ||
2123         UserOpcode == ISD::CopyToReg ||
2124         UserOpcode == ISD::CopyFromReg ||
2125         UserOpcode == ISD::INLINEASM ||
2126         UserOpcode == ISD::EH_LABEL ||
2127         UserOpcode == ISD::LIFETIME_START ||
2128         UserOpcode == ISD::LIFETIME_END) {
2129       // If their node ID got reset to -1 then they've already been selected.
2130       // Treat them like a MachineOpcode.
2131       if (User->getNodeId() == -1)
2132         continue;
2133     }
2134
2135     // If we have a TokenFactor, we handle it specially.
2136     if (User->getOpcode() != ISD::TokenFactor) {
2137       // If the node isn't a token factor and isn't part of our pattern, then it
2138       // must be a random chained node in between two nodes we're selecting.
2139       // This happens when we have something like:
2140       //   x = load ptr
2141       //   call
2142       //   y = x+4
2143       //   store y -> ptr
2144       // Because we structurally match the load/store as a read/modify/write,
2145       // but the call is chained between them.  We cannot fold in this case
2146       // because it would induce a cycle in the graph.
2147       if (!std::count(ChainedNodesInPattern.begin(),
2148                       ChainedNodesInPattern.end(), User))
2149         return CR_InducesCycle;
2150
2151       // Otherwise we found a node that is part of our pattern.  For example in:
2152       //   x = load ptr
2153       //   y = x+4
2154       //   store y -> ptr
2155       // This would happen when we're scanning down from the load and see the
2156       // store as a user.  Record that there is a use of ChainedNode that is
2157       // part of the pattern and keep scanning uses.
2158       Result = CR_LeadsToInteriorNode;
2159       InteriorChainedNodes.push_back(User);
2160       continue;
2161     }
2162
2163     // If we found a TokenFactor, there are two cases to consider: first if the
2164     // TokenFactor is just hanging "below" the pattern we're matching (i.e. no
2165     // uses of the TF are in our pattern) we just want to ignore it.  Second,
2166     // the TokenFactor can be sandwiched in between two chained nodes, like so:
2167     //     [Load chain]
2168     //         ^
2169     //         |
2170     //       [Load]
2171     //       ^    ^
2172     //       |    \                    DAG's like cheese
2173     //      /       \                       do you?
2174     //     /         |
2175     // [TokenFactor] [Op]
2176     //     ^          ^
2177     //     |          |
2178     //      \        /
2179     //       \      /
2180     //       [Store]
2181     //
2182     // In this case, the TokenFactor becomes part of our match and we rewrite it
2183     // as a new TokenFactor.
2184     //
2185     // To distinguish these two cases, do a recursive walk down the uses.
2186     switch (WalkChainUsers(User, ChainedNodesInPattern, InteriorChainedNodes)) {
2187     case CR_Simple:
2188       // If the uses of the TokenFactor are just already-selected nodes, ignore
2189       // it, it is "below" our pattern.
2190       continue;
2191     case CR_InducesCycle:
2192       // If the uses of the TokenFactor lead to nodes that are not part of our
2193       // pattern that are not selected, folding would turn this into a cycle,
2194       // bail out now.
2195       return CR_InducesCycle;
2196     case CR_LeadsToInteriorNode:
2197       break;  // Otherwise, keep processing.
2198     }
2199
2200     // Okay, we know we're in the interesting interior case.  The TokenFactor
2201     // is now going to be considered part of the pattern so that we rewrite its
2202     // uses (it may have uses that are not part of the pattern) with the
2203     // ultimate chain result of the generated code.  We will also add its chain
2204     // inputs as inputs to the ultimate TokenFactor we create.
2205     Result = CR_LeadsToInteriorNode;
2206     ChainedNodesInPattern.push_back(User);
2207     InteriorChainedNodes.push_back(User);
2208     continue;
2209   }
2210
2211   return Result;
2212 }
2213
2214 /// HandleMergeInputChains - This implements the OPC_EmitMergeInputChains
2215 /// operation for when the pattern matched at least one node with a chains.  The
2216 /// input vector contains a list of all of the chained nodes that we match.  We
2217 /// must determine if this is a valid thing to cover (i.e. matching it won't
2218 /// induce cycles in the DAG) and if so, creating a TokenFactor node. that will
2219 /// be used as the input node chain for the generated nodes.
2220 static SDValue
2221 HandleMergeInputChains(SmallVectorImpl<SDNode*> &ChainNodesMatched,
2222                        SelectionDAG *CurDAG) {
2223   // Walk all of the chained nodes we've matched, recursively scanning down the
2224   // users of the chain result. This adds any TokenFactor nodes that are caught
2225   // in between chained nodes to the chained and interior nodes list.
2226   SmallVector<SDNode*, 3> InteriorChainedNodes;
2227   for (unsigned i = 0, e = ChainNodesMatched.size(); i != e; ++i) {
2228     if (WalkChainUsers(ChainNodesMatched[i], ChainNodesMatched,
2229                        InteriorChainedNodes) == CR_InducesCycle)
2230       return SDValue(); // Would induce a cycle.
2231   }
2232
2233   // Okay, we have walked all the matched nodes and collected TokenFactor nodes
2234   // that we are interested in.  Form our input TokenFactor node.
2235   SmallVector<SDValue, 3> InputChains;
2236   for (unsigned i = 0, e = ChainNodesMatched.size(); i != e; ++i) {
2237     // Add the input chain of this node to the InputChains list (which will be
2238     // the operands of the generated TokenFactor) if it's not an interior node.
2239     SDNode *N = ChainNodesMatched[i];
2240     if (N->getOpcode() != ISD::TokenFactor) {
2241       if (std::count(InteriorChainedNodes.begin(),InteriorChainedNodes.end(),N))
2242         continue;
2243
2244       // Otherwise, add the input chain.
2245       SDValue InChain = ChainNodesMatched[i]->getOperand(0);
2246       assert(InChain.getValueType() == MVT::Other && "Not a chain");
2247       InputChains.push_back(InChain);
2248       continue;
2249     }
2250
2251     // If we have a token factor, we want to add all inputs of the token factor
2252     // that are not part of the pattern we're matching.
2253     for (const SDValue &Op : N->op_values()) {
2254       if (!std::count(ChainNodesMatched.begin(), ChainNodesMatched.end(),
2255                       Op.getNode()))
2256         InputChains.push_back(Op);
2257     }
2258   }
2259
2260   if (InputChains.size() == 1)
2261     return InputChains[0];
2262   return CurDAG->getNode(ISD::TokenFactor, SDLoc(ChainNodesMatched[0]),
2263                          MVT::Other, InputChains);
2264 }
2265
2266 /// MorphNode - Handle morphing a node in place for the selector.
2267 SDNode *SelectionDAGISel::
2268 MorphNode(SDNode *Node, unsigned TargetOpc, SDVTList VTList,
2269           ArrayRef<SDValue> Ops, unsigned EmitNodeInfo) {
2270   // It is possible we're using MorphNodeTo to replace a node with no
2271   // normal results with one that has a normal result (or we could be
2272   // adding a chain) and the input could have glue and chains as well.
2273   // In this case we need to shift the operands down.
2274   // FIXME: This is a horrible hack and broken in obscure cases, no worse
2275   // than the old isel though.
2276   int OldGlueResultNo = -1, OldChainResultNo = -1;
2277
2278   unsigned NTMNumResults = Node->getNumValues();
2279   if (Node->getValueType(NTMNumResults-1) == MVT::Glue) {
2280     OldGlueResultNo = NTMNumResults-1;
2281     if (NTMNumResults != 1 &&
2282         Node->getValueType(NTMNumResults-2) == MVT::Other)
2283       OldChainResultNo = NTMNumResults-2;
2284   } else if (Node->getValueType(NTMNumResults-1) == MVT::Other)
2285     OldChainResultNo = NTMNumResults-1;
2286
2287   // Call the underlying SelectionDAG routine to do the transmogrification. Note
2288   // that this deletes operands of the old node that become dead.
2289   SDNode *Res = CurDAG->MorphNodeTo(Node, ~TargetOpc, VTList, Ops);
2290
2291   // MorphNodeTo can operate in two ways: if an existing node with the
2292   // specified operands exists, it can just return it.  Otherwise, it
2293   // updates the node in place to have the requested operands.
2294   if (Res == Node) {
2295     // If we updated the node in place, reset the node ID.  To the isel,
2296     // this should be just like a newly allocated machine node.
2297     Res->setNodeId(-1);
2298   }
2299
2300   unsigned ResNumResults = Res->getNumValues();
2301   // Move the glue if needed.
2302   if ((EmitNodeInfo & OPFL_GlueOutput) && OldGlueResultNo != -1 &&
2303       (unsigned)OldGlueResultNo != ResNumResults-1)
2304     CurDAG->ReplaceAllUsesOfValueWith(SDValue(Node, OldGlueResultNo),
2305                                       SDValue(Res, ResNumResults-1));
2306
2307   if ((EmitNodeInfo & OPFL_GlueOutput) != 0)
2308     --ResNumResults;
2309
2310   // Move the chain reference if needed.
2311   if ((EmitNodeInfo & OPFL_Chain) && OldChainResultNo != -1 &&
2312       (unsigned)OldChainResultNo != ResNumResults-1)
2313     CurDAG->ReplaceAllUsesOfValueWith(SDValue(Node, OldChainResultNo),
2314                                       SDValue(Res, ResNumResults-1));
2315
2316   // Otherwise, no replacement happened because the node already exists. Replace
2317   // Uses of the old node with the new one.
2318   if (Res != Node)
2319     CurDAG->ReplaceAllUsesWith(Node, Res);
2320
2321   return Res;
2322 }
2323
2324 /// CheckSame - Implements OP_CheckSame.
2325 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2326 CheckSame(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2327           SDValue N,
2328           const SmallVectorImpl<std::pair<SDValue, SDNode*> > &RecordedNodes) {
2329   // Accept if it is exactly the same as a previously recorded node.
2330   unsigned RecNo = MatcherTable[MatcherIndex++];
2331   assert(RecNo < RecordedNodes.size() && "Invalid CheckSame");
2332   return N == RecordedNodes[RecNo].first;
2333 }
2334
2335 /// CheckChildSame - Implements OP_CheckChildXSame.
2336 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2337 CheckChildSame(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2338              SDValue N,
2339              const SmallVectorImpl<std::pair<SDValue, SDNode*> > &RecordedNodes,
2340              unsigned ChildNo) {
2341   if (ChildNo >= N.getNumOperands())
2342     return false;  // Match fails if out of range child #.
2343   return ::CheckSame(MatcherTable, MatcherIndex, N.getOperand(ChildNo),
2344                      RecordedNodes);
2345 }
2346
2347 /// CheckPatternPredicate - Implements OP_CheckPatternPredicate.
2348 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2349 CheckPatternPredicate(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2350                       const SelectionDAGISel &SDISel) {
2351   return SDISel.CheckPatternPredicate(MatcherTable[MatcherIndex++]);
2352 }
2353
2354 /// CheckNodePredicate - Implements OP_CheckNodePredicate.
2355 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2356 CheckNodePredicate(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2357                    const SelectionDAGISel &SDISel, SDNode *N) {
2358   return SDISel.CheckNodePredicate(N, MatcherTable[MatcherIndex++]);
2359 }
2360
2361 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2362 CheckOpcode(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2363             SDNode *N) {
2364   uint16_t Opc = MatcherTable[MatcherIndex++];
2365   Opc |= (unsigned short)MatcherTable[MatcherIndex++] << 8;
2366   return N->getOpcode() == Opc;
2367 }
2368
2369 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2370 CheckType(const unsigned char *MatcherTable, unsigned &MatcherIndex, SDValue N,
2371           const TargetLowering *TLI, const DataLayout &DL) {
2372   MVT::SimpleValueType VT = (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
2373   if (N.getValueType() == VT) return true;
2374
2375   // Handle the case when VT is iPTR.
2376   return VT == MVT::iPTR && N.getValueType() == TLI->getPointerTy(DL);
2377 }
2378
2379 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2380 CheckChildType(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2381                SDValue N, const TargetLowering *TLI, const DataLayout &DL,
2382                unsigned ChildNo) {
2383   if (ChildNo >= N.getNumOperands())
2384     return false;  // Match fails if out of range child #.
2385   return ::CheckType(MatcherTable, MatcherIndex, N.getOperand(ChildNo), TLI,
2386                      DL);
2387 }
2388
2389 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2390 CheckCondCode(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2391               SDValue N) {
2392   return cast<CondCodeSDNode>(N)->get() ==
2393       (ISD::CondCode)MatcherTable[MatcherIndex++];
2394 }
2395
2396 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2397 CheckValueType(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2398                SDValue N, const TargetLowering *TLI, const DataLayout &DL) {
2399   MVT::SimpleValueType VT = (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
2400   if (cast<VTSDNode>(N)->getVT() == VT)
2401     return true;
2402
2403   // Handle the case when VT is iPTR.
2404   return VT == MVT::iPTR && cast<VTSDNode>(N)->getVT() == TLI->getPointerTy(DL);
2405 }
2406
2407 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2408 CheckInteger(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2409              SDValue N) {
2410   int64_t Val = MatcherTable[MatcherIndex++];
2411   if (Val & 128)
2412     Val = GetVBR(Val, MatcherTable, MatcherIndex);
2413
2414   ConstantSDNode *C = dyn_cast<ConstantSDNode>(N);
2415   return C && C->getSExtValue() == Val;
2416 }
2417
2418 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2419 CheckChildInteger(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2420                   SDValue N, unsigned ChildNo) {
2421   if (ChildNo >= N.getNumOperands())
2422     return false;  // Match fails if out of range child #.
2423   return ::CheckInteger(MatcherTable, MatcherIndex, N.getOperand(ChildNo));
2424 }
2425
2426 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2427 CheckAndImm(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2428             SDValue N, const SelectionDAGISel &SDISel) {
2429   int64_t Val = MatcherTable[MatcherIndex++];
2430   if (Val & 128)
2431     Val = GetVBR(Val, MatcherTable, MatcherIndex);
2432
2433   if (N->getOpcode() != ISD::AND) return false;
2434
2435   ConstantSDNode *C = dyn_cast<ConstantSDNode>(N->getOperand(1));
2436   return C && SDISel.CheckAndMask(N.getOperand(0), C, Val);
2437 }
2438
2439 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2440 CheckOrImm(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2441            SDValue N, const SelectionDAGISel &SDISel) {
2442   int64_t Val = MatcherTable[MatcherIndex++];
2443   if (Val & 128)
2444     Val = GetVBR(Val, MatcherTable, MatcherIndex);
2445
2446   if (N->getOpcode() != ISD::OR) return false;
2447
2448   ConstantSDNode *C = dyn_cast<ConstantSDNode>(N->getOperand(1));
2449   return C && SDISel.CheckOrMask(N.getOperand(0), C, Val);
2450 }
2451
2452 /// IsPredicateKnownToFail - If we know how and can do so without pushing a
2453 /// scope, evaluate the current node.  If the current predicate is known to
2454 /// fail, set Result=true and return anything.  If the current predicate is
2455 /// known to pass, set Result=false and return the MatcherIndex to continue
2456 /// with.  If the current predicate is unknown, set Result=false and return the
2457 /// MatcherIndex to continue with.
2458 static unsigned IsPredicateKnownToFail(const unsigned char *Table,
2459                                        unsigned Index, SDValue N,
2460                                        bool &Result,
2461                                        const SelectionDAGISel &SDISel,
2462                  SmallVectorImpl<std::pair<SDValue, SDNode*> > &RecordedNodes) {
2463   switch (Table[Index++]) {
2464   default:
2465     Result = false;
2466     return Index-1;  // Could not evaluate this predicate.
2467   case SelectionDAGISel::OPC_CheckSame:
2468     Result = !::CheckSame(Table, Index, N, RecordedNodes);
2469     return Index;
2470   case SelectionDAGISel::OPC_CheckChild0Same:
2471   case SelectionDAGISel::OPC_CheckChild1Same:
2472   case SelectionDAGISel::OPC_CheckChild2Same:
2473   case SelectionDAGISel::OPC_CheckChild3Same:
2474     Result = !::CheckChildSame(Table, Index, N, RecordedNodes,
2475                         Table[Index-1] - SelectionDAGISel::OPC_CheckChild0Same);
2476     return Index;
2477   case SelectionDAGISel::OPC_CheckPatternPredicate:
2478     Result = !::CheckPatternPredicate(Table, Index, SDISel);
2479     return Index;
2480   case SelectionDAGISel::OPC_CheckPredicate:
2481     Result = !::CheckNodePredicate(Table, Index, SDISel, N.getNode());
2482     return Index;
2483   case SelectionDAGISel::OPC_CheckOpcode:
2484     Result = !::CheckOpcode(Table, Index, N.getNode());
2485     return Index;
2486   case SelectionDAGISel::OPC_CheckType:
2487     Result = !::CheckType(Table, Index, N, SDISel.TLI,
2488                           SDISel.CurDAG->getDataLayout());
2489     return Index;
2490   case SelectionDAGISel::OPC_CheckChild0Type:
2491   case SelectionDAGISel::OPC_CheckChild1Type:
2492   case SelectionDAGISel::OPC_CheckChild2Type:
2493   case SelectionDAGISel::OPC_CheckChild3Type:
2494   case SelectionDAGISel::OPC_CheckChild4Type:
2495   case SelectionDAGISel::OPC_CheckChild5Type:
2496   case SelectionDAGISel::OPC_CheckChild6Type:
2497   case SelectionDAGISel::OPC_CheckChild7Type:
2498     Result = !::CheckChildType(
2499                  Table, Index, N, SDISel.TLI, SDISel.CurDAG->getDataLayout(),
2500                  Table[Index - 1] - SelectionDAGISel::OPC_CheckChild0Type);
2501     return Index;
2502   case SelectionDAGISel::OPC_CheckCondCode:
2503     Result = !::CheckCondCode(Table, Index, N);
2504     return Index;
2505   case SelectionDAGISel::OPC_CheckValueType:
2506     Result = !::CheckValueType(Table, Index, N, SDISel.TLI,
2507                                SDISel.CurDAG->getDataLayout());
2508     return Index;
2509   case SelectionDAGISel::OPC_CheckInteger:
2510     Result = !::CheckInteger(Table, Index, N);
2511     return Index;
2512   case SelectionDAGISel::OPC_CheckChild0Integer:
2513   case SelectionDAGISel::OPC_CheckChild1Integer:
2514   case SelectionDAGISel::OPC_CheckChild2Integer:
2515   case SelectionDAGISel::OPC_CheckChild3Integer:
2516   case SelectionDAGISel::OPC_CheckChild4Integer:
2517     Result = !::CheckChildInteger(Table, Index, N,
2518                      Table[Index-1] - SelectionDAGISel::OPC_CheckChild0Integer);
2519     return Index;
2520   case SelectionDAGISel::OPC_CheckAndImm:
2521     Result = !::CheckAndImm(Table, Index, N, SDISel);
2522     return Index;
2523   case SelectionDAGISel::OPC_CheckOrImm:
2524     Result = !::CheckOrImm(Table, Index, N, SDISel);
2525     return Index;
2526   }
2527 }
2528
2529 namespace {
2530
2531 struct MatchScope {
2532   /// FailIndex - If this match fails, this is the index to continue with.
2533   unsigned FailIndex;
2534
2535   /// NodeStack - The node stack when the scope was formed.
2536   SmallVector<SDValue, 4> NodeStack;
2537
2538   /// NumRecordedNodes - The number of recorded nodes when the scope was formed.
2539   unsigned NumRecordedNodes;
2540
2541   /// NumMatchedMemRefs - The number of matched memref entries.
2542   unsigned NumMatchedMemRefs;
2543
2544   /// InputChain/InputGlue - The current chain/glue
2545   SDValue InputChain, InputGlue;
2546
2547   /// HasChainNodesMatched - True if the ChainNodesMatched list is non-empty.
2548   bool HasChainNodesMatched, HasGlueResultNodesMatched;
2549 };
2550
2551 /// \\brief A DAG update listener to keep the matching state
2552 /// (i.e. RecordedNodes and MatchScope) uptodate if the target is allowed to
2553 /// change the DAG while matching.  X86 addressing mode matcher is an example
2554 /// for this.
2555 class MatchStateUpdater : public SelectionDAG::DAGUpdateListener
2556 {
2557       SmallVectorImpl<std::pair<SDValue, SDNode*> > &RecordedNodes;
2558       SmallVectorImpl<MatchScope> &MatchScopes;
2559 public:
2560   MatchStateUpdater(SelectionDAG &DAG,
2561                     SmallVectorImpl<std::pair<SDValue, SDNode*> > &RN,
2562                     SmallVectorImpl<MatchScope> &MS) :
2563     SelectionDAG::DAGUpdateListener(DAG),
2564     RecordedNodes(RN), MatchScopes(MS) { }
2565
2566   void NodeDeleted(SDNode *N, SDNode *E) override {
2567     // Some early-returns here to avoid the search if we deleted the node or
2568     // if the update comes from MorphNodeTo (MorphNodeTo is the last thing we
2569     // do, so it's unnecessary to update matching state at that point).
2570     // Neither of these can occur currently because we only install this
2571     // update listener during matching a complex patterns.
2572     if (!E || E->isMachineOpcode())
2573       return;
2574     // Performing linear search here does not matter because we almost never
2575     // run this code.  You'd have to have a CSE during complex pattern
2576     // matching.
2577     for (auto &I : RecordedNodes)
2578       if (I.first.getNode() == N)
2579         I.first.setNode(E);
2580
2581     for (auto &I : MatchScopes)
2582       for (auto &J : I.NodeStack)
2583         if (J.getNode() == N)
2584           J.setNode(E);
2585   }
2586 };
2587 }
2588
2589 SDNode *SelectionDAGISel::
2590 SelectCodeCommon(SDNode *NodeToMatch, const unsigned char *MatcherTable,
2591                  unsigned TableSize) {
2592   // FIXME: Should these even be selected?  Handle these cases in the caller?
2593   switch (NodeToMatch->getOpcode()) {
2594   default:
2595     break;
2596   case ISD::EntryToken:       // These nodes remain the same.
2597   case ISD::BasicBlock:
2598   case ISD::Register:
2599   case ISD::RegisterMask:
2600   case ISD::HANDLENODE:
2601   case ISD::MDNODE_SDNODE:
2602   case ISD::TargetConstant:
2603   case ISD::TargetConstantFP:
2604   case ISD::TargetConstantPool:
2605   case ISD::TargetFrameIndex:
2606   case ISD::TargetExternalSymbol:
2607   case ISD::MCSymbol:
2608   case ISD::TargetBlockAddress:
2609   case ISD::TargetJumpTable:
2610   case ISD::TargetGlobalTLSAddress:
2611   case ISD::TargetGlobalAddress:
2612   case ISD::TokenFactor:
2613   case ISD::CopyFromReg:
2614   case ISD::CopyToReg:
2615   case ISD::EH_LABEL:
2616   case ISD::LIFETIME_START:
2617   case ISD::LIFETIME_END:
2618     NodeToMatch->setNodeId(-1); // Mark selected.
2619     return nullptr;
2620   case ISD::AssertSext:
2621   case ISD::AssertZext:
2622     CurDAG->ReplaceAllUsesOfValueWith(SDValue(NodeToMatch, 0),
2623                                       NodeToMatch->getOperand(0));
2624     return nullptr;
2625   case ISD::INLINEASM: return Select_INLINEASM(NodeToMatch);
2626   case ISD::READ_REGISTER: return Select_READ_REGISTER(NodeToMatch);
2627   case ISD::WRITE_REGISTER: return Select_WRITE_REGISTER(NodeToMatch);
2628   case ISD::UNDEF:     return Select_UNDEF(NodeToMatch);
2629   }
2630
2631   assert(!NodeToMatch->isMachineOpcode() && "Node already selected!");
2632
2633   // Set up the node stack with NodeToMatch as the only node on the stack.
2634   SmallVector<SDValue, 8> NodeStack;
2635   SDValue N = SDValue(NodeToMatch, 0);
2636   NodeStack.push_back(N);
2637
2638   // MatchScopes - Scopes used when matching, if a match failure happens, this
2639   // indicates where to continue checking.
2640   SmallVector<MatchScope, 8> MatchScopes;
2641
2642   // RecordedNodes - This is the set of nodes that have been recorded by the
2643   // state machine.  The second value is the parent of the node, or null if the
2644   // root is recorded.
2645   SmallVector<std::pair<SDValue, SDNode*>, 8> RecordedNodes;
2646
2647   // MatchedMemRefs - This is the set of MemRef's we've seen in the input
2648   // pattern.
2649   SmallVector<MachineMemOperand*, 2> MatchedMemRefs;
2650
2651   // These are the current input chain and glue for use when generating nodes.
2652   // Various Emit operations change these.  For example, emitting a copytoreg
2653   // uses and updates these.
2654   SDValue InputChain, InputGlue;
2655
2656   // ChainNodesMatched - If a pattern matches nodes that have input/output
2657   // chains, the OPC_EmitMergeInputChains operation is emitted which indicates
2658   // which ones they are.  The result is captured into this list so that we can
2659   // update the chain results when the pattern is complete.
2660   SmallVector<SDNode*, 3> ChainNodesMatched;
2661   SmallVector<SDNode*, 3> GlueResultNodesMatched;
2662
2663   DEBUG(dbgs() << "ISEL: Starting pattern match on root node: ";
2664         NodeToMatch->dump(CurDAG);
2665         dbgs() << '\n');
2666
2667   // Determine where to start the interpreter.  Normally we start at opcode #0,
2668   // but if the state machine starts with an OPC_SwitchOpcode, then we
2669   // accelerate the first lookup (which is guaranteed to be hot) with the
2670   // OpcodeOffset table.
2671   unsigned MatcherIndex = 0;
2672
2673   if (!OpcodeOffset.empty()) {
2674     // Already computed the OpcodeOffset table, just index into it.
2675     if (N.getOpcode() < OpcodeOffset.size())
2676       MatcherIndex = OpcodeOffset[N.getOpcode()];
2677     DEBUG(dbgs() << "  Initial Opcode index to " << MatcherIndex << "\n");
2678
2679   } else if (MatcherTable[0] == OPC_SwitchOpcode) {
2680     // Otherwise, the table isn't computed, but the state machine does start
2681     // with an OPC_SwitchOpcode instruction.  Populate the table now, since this
2682     // is the first time we're selecting an instruction.
2683     unsigned Idx = 1;
2684     while (1) {
2685       // Get the size of this case.
2686       unsigned CaseSize = MatcherTable[Idx++];
2687       if (CaseSize & 128)
2688         CaseSize = GetVBR(CaseSize, MatcherTable, Idx);
2689       if (CaseSize == 0) break;
2690
2691       // Get the opcode, add the index to the table.
2692       uint16_t Opc = MatcherTable[Idx++];
2693       Opc |= (unsigned short)MatcherTable[Idx++] << 8;
2694       if (Opc >= OpcodeOffset.size())
2695         OpcodeOffset.resize((Opc+1)*2);
2696       OpcodeOffset[Opc] = Idx;
2697       Idx += CaseSize;
2698     }
2699
2700     // Okay, do the lookup for the first opcode.
2701     if (N.getOpcode() < OpcodeOffset.size())
2702       MatcherIndex = OpcodeOffset[N.getOpcode()];
2703   }
2704
2705   while (1) {
2706     assert(MatcherIndex < TableSize && "Invalid index");
2707 #ifndef NDEBUG
2708     unsigned CurrentOpcodeIndex = MatcherIndex;
2709 #endif
2710     BuiltinOpcodes Opcode = (BuiltinOpcodes)MatcherTable[MatcherIndex++];
2711     switch (Opcode) {
2712     case OPC_Scope: {
2713       // Okay, the semantics of this operation are that we should push a scope
2714       // then evaluate the first child.  However, pushing a scope only to have
2715       // the first check fail (which then pops it) is inefficient.  If we can
2716       // determine immediately that the first check (or first several) will
2717       // immediately fail, don't even bother pushing a scope for them.
2718       unsigned FailIndex;
2719
2720       while (1) {
2721         unsigned NumToSkip = MatcherTable[MatcherIndex++];
2722         if (NumToSkip & 128)
2723           NumToSkip = GetVBR(NumToSkip, MatcherTable, MatcherIndex);
2724         // Found the end of the scope with no match.
2725         if (NumToSkip == 0) {
2726           FailIndex = 0;
2727           break;
2728         }
2729
2730         FailIndex = MatcherIndex+NumToSkip;
2731
2732         unsigned MatcherIndexOfPredicate = MatcherIndex;
2733         (void)MatcherIndexOfPredicate; // silence warning.
2734
2735         // If we can't evaluate this predicate without pushing a scope (e.g. if
2736         // it is a 'MoveParent') or if the predicate succeeds on this node, we
2737         // push the scope and evaluate the full predicate chain.
2738         bool Result;
2739         MatcherIndex = IsPredicateKnownToFail(MatcherTable, MatcherIndex, N,
2740                                               Result, *this, RecordedNodes);
2741         if (!Result)
2742           break;
2743
2744         DEBUG(dbgs() << "  Skipped scope entry (due to false predicate) at "
2745                      << "index " << MatcherIndexOfPredicate
2746                      << ", continuing at " << FailIndex << "\n");
2747         ++NumDAGIselRetries;
2748
2749         // Otherwise, we know that this case of the Scope is guaranteed to fail,
2750         // move to the next case.
2751         MatcherIndex = FailIndex;
2752       }
2753
2754       // If the whole scope failed to match, bail.
2755       if (FailIndex == 0) break;
2756
2757       // Push a MatchScope which indicates where to go if the first child fails
2758       // to match.
2759       MatchScope NewEntry;
2760       NewEntry.FailIndex = FailIndex;
2761       NewEntry.NodeStack.append(NodeStack.begin(), NodeStack.end());
2762       NewEntry.NumRecordedNodes = RecordedNodes.size();
2763       NewEntry.NumMatchedMemRefs = MatchedMemRefs.size();
2764       NewEntry.InputChain = InputChain;
2765       NewEntry.InputGlue = InputGlue;
2766       NewEntry.HasChainNodesMatched = !ChainNodesMatched.empty();
2767       NewEntry.HasGlueResultNodesMatched = !GlueResultNodesMatched.empty();
2768       MatchScopes.push_back(NewEntry);
2769       continue;
2770     }
2771     case OPC_RecordNode: {
2772       // Remember this node, it may end up being an operand in the pattern.
2773       SDNode *Parent = nullptr;
2774       if (NodeStack.size() > 1)
2775         Parent = NodeStack[NodeStack.size()-2].getNode();
2776       RecordedNodes.push_back(std::make_pair(N, Parent));
2777       continue;
2778     }
2779
2780     case OPC_RecordChild0: case OPC_RecordChild1:
2781     case OPC_RecordChild2: case OPC_RecordChild3:
2782     case OPC_RecordChild4: case OPC_RecordChild5:
2783     case OPC_RecordChild6: case OPC_RecordChild7: {
2784       unsigned ChildNo = Opcode-OPC_RecordChild0;
2785       if (ChildNo >= N.getNumOperands())
2786         break;  // Match fails if out of range child #.
2787
2788       RecordedNodes.push_back(std::make_pair(N->getOperand(ChildNo),
2789                                              N.getNode()));
2790       continue;
2791     }
2792     case OPC_RecordMemRef:
2793       MatchedMemRefs.push_back(cast<MemSDNode>(N)->getMemOperand());
2794       continue;
2795
2796     case OPC_CaptureGlueInput:
2797       // If the current node has an input glue, capture it in InputGlue.
2798       if (N->getNumOperands() != 0 &&
2799           N->getOperand(N->getNumOperands()-1).getValueType() == MVT::Glue)
2800         InputGlue = N->getOperand(N->getNumOperands()-1);
2801       continue;
2802
2803     case OPC_MoveChild: {
2804       unsigned ChildNo = MatcherTable[MatcherIndex++];
2805       if (ChildNo >= N.getNumOperands())
2806         break;  // Match fails if out of range child #.
2807       N = N.getOperand(ChildNo);
2808       NodeStack.push_back(N);
2809       continue;
2810     }
2811
2812     case OPC_MoveParent:
2813       // Pop the current node off the NodeStack.
2814       NodeStack.pop_back();
2815       assert(!NodeStack.empty() && "Node stack imbalance!");
2816       N = NodeStack.back();
2817       continue;
2818
2819     case OPC_CheckSame:
2820       if (!::CheckSame(MatcherTable, MatcherIndex, N, RecordedNodes)) break;
2821       continue;
2822
2823     case OPC_CheckChild0Same: case OPC_CheckChild1Same:
2824     case OPC_CheckChild2Same: case OPC_CheckChild3Same:
2825       if (!::CheckChildSame(MatcherTable, MatcherIndex, N, RecordedNodes,
2826                             Opcode-OPC_CheckChild0Same))
2827         break;
2828       continue;
2829
2830     case OPC_CheckPatternPredicate:
2831       if (!::CheckPatternPredicate(MatcherTable, MatcherIndex, *this)) break;
2832       continue;
2833     case OPC_CheckPredicate:
2834       if (!::CheckNodePredicate(MatcherTable, MatcherIndex, *this,
2835                                 N.getNode()))
2836         break;
2837       continue;
2838     case OPC_CheckComplexPat: {
2839       unsigned CPNum = MatcherTable[MatcherIndex++];
2840       unsigned RecNo = MatcherTable[MatcherIndex++];
2841       assert(RecNo < RecordedNodes.size() && "Invalid CheckComplexPat");
2842
2843       // If target can modify DAG during matching, keep the matching state
2844       // consistent.
2845       std::unique_ptr<MatchStateUpdater> MSU;
2846       if (ComplexPatternFuncMutatesDAG())
2847         MSU.reset(new MatchStateUpdater(*CurDAG, RecordedNodes,
2848                                         MatchScopes));
2849
2850       if (!CheckComplexPattern(NodeToMatch, RecordedNodes[RecNo].second,
2851                                RecordedNodes[RecNo].first, CPNum,
2852                                RecordedNodes))
2853         break;
2854       continue;
2855     }
2856     case OPC_CheckOpcode:
2857       if (!::CheckOpcode(MatcherTable, MatcherIndex, N.getNode())) break;
2858       continue;
2859
2860     case OPC_CheckType:
2861       if (!::CheckType(MatcherTable, MatcherIndex, N, TLI,
2862                        CurDAG->getDataLayout()))
2863         break;
2864       continue;
2865
2866     case OPC_SwitchOpcode: {
2867       unsigned CurNodeOpcode = N.getOpcode();
2868       unsigned SwitchStart = MatcherIndex-1; (void)SwitchStart;
2869       unsigned CaseSize;
2870       while (1) {
2871         // Get the size of this case.
2872         CaseSize = MatcherTable[MatcherIndex++];
2873         if (CaseSize & 128)
2874           CaseSize = GetVBR(CaseSize, MatcherTable, MatcherIndex);
2875         if (CaseSize == 0) break;
2876
2877         uint16_t Opc = MatcherTable[MatcherIndex++];
2878         Opc |= (unsigned short)MatcherTable[MatcherIndex++] << 8;
2879
2880         // If the opcode matches, then we will execute this case.
2881         if (CurNodeOpcode == Opc)
2882           break;
2883
2884         // Otherwise, skip over this case.
2885         MatcherIndex += CaseSize;
2886       }
2887
2888       // If no cases matched, bail out.
2889       if (CaseSize == 0) break;
2890
2891       // Otherwise, execute the case we found.
2892       DEBUG(dbgs() << "  OpcodeSwitch from " << SwitchStart
2893                    << " to " << MatcherIndex << "\n");
2894       continue;
2895     }
2896
2897     case OPC_SwitchType: {
2898       MVT CurNodeVT = N.getSimpleValueType();
2899       unsigned SwitchStart = MatcherIndex-1; (void)SwitchStart;
2900       unsigned CaseSize;
2901       while (1) {
2902         // Get the size of this case.
2903         CaseSize = MatcherTable[MatcherIndex++];
2904         if (CaseSize & 128)
2905           CaseSize = GetVBR(CaseSize, MatcherTable, MatcherIndex);
2906         if (CaseSize == 0) break;
2907
2908         MVT CaseVT = (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
2909         if (CaseVT == MVT::iPTR)
2910           CaseVT = TLI->getPointerTy(CurDAG->getDataLayout());
2911
2912         // If the VT matches, then we will execute this case.
2913         if (CurNodeVT == CaseVT)
2914           break;
2915
2916         // Otherwise, skip over this case.
2917         MatcherIndex += CaseSize;
2918       }
2919
2920       // If no cases matched, bail out.
2921       if (CaseSize == 0) break;
2922
2923       // Otherwise, execute the case we found.
2924       DEBUG(dbgs() << "  TypeSwitch[" << EVT(CurNodeVT).getEVTString()
2925                    << "] from " << SwitchStart << " to " << MatcherIndex<<'\n');
2926       continue;
2927     }
2928     case OPC_CheckChild0Type: case OPC_CheckChild1Type:
2929     case OPC_CheckChild2Type: case OPC_CheckChild3Type:
2930     case OPC_CheckChild4Type: case OPC_CheckChild5Type:
2931     case OPC_CheckChild6Type: case OPC_CheckChild7Type:
2932       if (!::CheckChildType(MatcherTable, MatcherIndex, N, TLI,
2933                             CurDAG->getDataLayout(),
2934                             Opcode - OPC_CheckChild0Type))
2935         break;
2936       continue;
2937     case OPC_CheckCondCode:
2938       if (!::CheckCondCode(MatcherTable, MatcherIndex, N)) break;
2939       continue;
2940     case OPC_CheckValueType:
2941       if (!::CheckValueType(MatcherTable, MatcherIndex, N, TLI,
2942                             CurDAG->getDataLayout()))
2943         break;
2944       continue;
2945     case OPC_CheckInteger:
2946       if (!::CheckInteger(MatcherTable, MatcherIndex, N)) break;
2947       continue;
2948     case OPC_CheckChild0Integer: case OPC_CheckChild1Integer:
2949     case OPC_CheckChild2Integer: case OPC_CheckChild3Integer:
2950     case OPC_CheckChild4Integer:
2951       if (!::CheckChildInteger(MatcherTable, MatcherIndex, N,
2952                                Opcode-OPC_CheckChild0Integer)) break;
2953       continue;
2954     case OPC_CheckAndImm:
2955       if (!::CheckAndImm(MatcherTable, MatcherIndex, N, *this)) break;
2956       continue;
2957     case OPC_CheckOrImm:
2958       if (!::CheckOrImm(MatcherTable, MatcherIndex, N, *this)) break;
2959       continue;
2960
2961     case OPC_CheckFoldableChainNode: {
2962       assert(NodeStack.size() != 1 && "No parent node");
2963       // Verify that all intermediate nodes between the root and this one have
2964       // a single use.
2965       bool HasMultipleUses = false;
2966       for (unsigned i = 1, e = NodeStack.size()-1; i != e; ++i)
2967         if (!NodeStack[i].hasOneUse()) {
2968           HasMultipleUses = true;
2969           break;
2970         }
2971       if (HasMultipleUses) break;
2972
2973       // Check to see that the target thinks this is profitable to fold and that
2974       // we can fold it without inducing cycles in the graph.
2975       if (!IsProfitableToFold(N, NodeStack[NodeStack.size()-2].getNode(),
2976                               NodeToMatch) ||
2977           !IsLegalToFold(N, NodeStack[NodeStack.size()-2].getNode(),
2978                          NodeToMatch, OptLevel,
2979                          true/*We validate our own chains*/))
2980         break;
2981
2982       continue;
2983     }
2984     case OPC_EmitInteger: {
2985       MVT::SimpleValueType VT =
2986         (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
2987       int64_t Val = MatcherTable[MatcherIndex++];
2988       if (Val & 128)
2989         Val = GetVBR(Val, MatcherTable, MatcherIndex);
2990       RecordedNodes.push_back(std::pair<SDValue, SDNode*>(
2991                               CurDAG->getTargetConstant(Val, SDLoc(NodeToMatch),
2992                                                         VT), nullptr));
2993       continue;
2994     }
2995     case OPC_EmitRegister: {
2996       MVT::SimpleValueType VT =
2997         (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
2998       unsigned RegNo = MatcherTable[MatcherIndex++];
2999       RecordedNodes.push_back(std::pair<SDValue, SDNode*>(
3000                               CurDAG->getRegister(RegNo, VT), nullptr));
3001       continue;
3002     }
3003     case OPC_EmitRegister2: {
3004       // For targets w/ more than 256 register names, the register enum
3005       // values are stored in two bytes in the matcher table (just like
3006       // opcodes).
3007       MVT::SimpleValueType VT =
3008         (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
3009       unsigned RegNo = MatcherTable[MatcherIndex++];
3010       RegNo |= MatcherTable[MatcherIndex++] << 8;
3011       RecordedNodes.push_back(std::pair<SDValue, SDNode*>(
3012                               CurDAG->getRegister(RegNo, VT), nullptr));
3013       continue;
3014     }
3015
3016     case OPC_EmitConvertToTarget:  {
3017       // Convert from IMM/FPIMM to target version.
3018       unsigned RecNo = MatcherTable[MatcherIndex++];
3019       assert(RecNo < RecordedNodes.size() && "Invalid EmitConvertToTarget");
3020       SDValue Imm = RecordedNodes[RecNo].first;
3021
3022       if (Imm->getOpcode() == ISD::Constant) {
3023         const ConstantInt *Val=cast<ConstantSDNode>(Imm)->getConstantIntValue();
3024         Imm = CurDAG->getConstant(*Val, SDLoc(NodeToMatch), Imm.getValueType(),
3025                                   true);
3026       } else if (Imm->getOpcode() == ISD::ConstantFP) {
3027         const ConstantFP *Val=cast<ConstantFPSDNode>(Imm)->getConstantFPValue();
3028         Imm = CurDAG->getConstantFP(*Val, SDLoc(NodeToMatch),
3029                                     Imm.getValueType(), true);
3030       }
3031
3032       RecordedNodes.push_back(std::make_pair(Imm, RecordedNodes[RecNo].second));
3033       continue;
3034     }
3035
3036     case OPC_EmitMergeInputChains1_0:    // OPC_EmitMergeInputChains, 1, 0
3037     case OPC_EmitMergeInputChains1_1: {  // OPC_EmitMergeInputChains, 1, 1
3038       // These are space-optimized forms of OPC_EmitMergeInputChains.
3039       assert(!InputChain.getNode() &&
3040              "EmitMergeInputChains should be the first chain producing node");
3041       assert(ChainNodesMatched.empty() &&
3042              "Should only have one EmitMergeInputChains per match");
3043
3044       // Read all of the chained nodes.
3045       unsigned RecNo = Opcode == OPC_EmitMergeInputChains1_1;
3046       assert(RecNo < RecordedNodes.size() && "Invalid EmitMergeInputChains");
3047       ChainNodesMatched.push_back(RecordedNodes[RecNo].first.getNode());
3048
3049       // FIXME: What if other value results of the node have uses not matched
3050       // by this pattern?
3051       if (ChainNodesMatched.back() != NodeToMatch &&
3052           !RecordedNodes[RecNo].first.hasOneUse()) {
3053         ChainNodesMatched.clear();
3054         break;
3055       }
3056
3057       // Merge the input chains if they are not intra-pattern references.
3058       InputChain = HandleMergeInputChains(ChainNodesMatched, CurDAG);
3059
3060       if (!InputChain.getNode())
3061         break;  // Failed to merge.
3062       continue;
3063     }
3064
3065     case OPC_EmitMergeInputChains: {
3066       assert(!InputChain.getNode() &&
3067              "EmitMergeInputChains should be the first chain producing node");
3068       // This node gets a list of nodes we matched in the input that have
3069       // chains.  We want to token factor all of the input chains to these nodes
3070       // together.  However, if any of the input chains is actually one of the
3071       // nodes matched in this pattern, then we have an intra-match reference.
3072       // Ignore these because the newly token factored chain should not refer to
3073       // the old nodes.
3074       unsigned NumChains = MatcherTable[MatcherIndex++];
3075       assert(NumChains != 0 && "Can't TF zero chains");
3076
3077       assert(ChainNodesMatched.empty() &&
3078              "Should only have one EmitMergeInputChains per match");
3079
3080       // Read all of the chained nodes.
3081       for (unsigned i = 0; i != NumChains; ++i) {
3082         unsigned RecNo = MatcherTable[MatcherIndex++];
3083         assert(RecNo < RecordedNodes.size() && "Invalid EmitMergeInputChains");
3084         ChainNodesMatched.push_back(RecordedNodes[RecNo].first.getNode());
3085
3086         // FIXME: What if other value results of the node have uses not matched
3087         // by this pattern?
3088         if (ChainNodesMatched.back() != NodeToMatch &&
3089             !RecordedNodes[RecNo].first.hasOneUse()) {
3090           ChainNodesMatched.clear();
3091           break;
3092         }
3093       }
3094
3095       // If the inner loop broke out, the match fails.
3096       if (ChainNodesMatched.empty())
3097         break;
3098
3099       // Merge the input chains if they are not intra-pattern references.
3100       InputChain = HandleMergeInputChains(ChainNodesMatched, CurDAG);
3101
3102       if (!InputChain.getNode())
3103         break;  // Failed to merge.
3104
3105       continue;
3106     }
3107
3108     case OPC_EmitCopyToReg: {
3109       unsigned RecNo = MatcherTable[MatcherIndex++];
3110       assert(RecNo < RecordedNodes.size() && "Invalid EmitCopyToReg");
3111       unsigned DestPhysReg = MatcherTable[MatcherIndex++];
3112
3113       if (!InputChain.getNode())
3114         InputChain = CurDAG->getEntryNode();
3115
3116       InputChain = CurDAG->getCopyToReg(InputChain, SDLoc(NodeToMatch),
3117                                         DestPhysReg, RecordedNodes[RecNo].first,
3118                                         InputGlue);
3119
3120       InputGlue = InputChain.getValue(1);
3121       continue;
3122     }
3123
3124     case OPC_EmitNodeXForm: {
3125       unsigned XFormNo = MatcherTable[MatcherIndex++];
3126       unsigned RecNo = MatcherTable[MatcherIndex++];
3127       assert(RecNo < RecordedNodes.size() && "Invalid EmitNodeXForm");
3128       SDValue Res = RunSDNodeXForm(RecordedNodes[RecNo].first, XFormNo);
3129       RecordedNodes.push_back(std::pair<SDValue,SDNode*>(Res, nullptr));
3130       continue;
3131     }
3132
3133     case OPC_EmitNode:
3134     case OPC_MorphNodeTo: {
3135       uint16_t TargetOpc = MatcherTable[MatcherIndex++];
3136       TargetOpc |= (unsigned short)MatcherTable[MatcherIndex++] << 8;
3137       unsigned EmitNodeInfo = MatcherTable[MatcherIndex++];
3138       // Get the result VT list.
3139       unsigned NumVTs = MatcherTable[MatcherIndex++];
3140       SmallVector<EVT, 4> VTs;
3141       for (unsigned i = 0; i != NumVTs; ++i) {
3142         MVT::SimpleValueType VT =
3143           (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
3144         if (VT == MVT::iPTR)
3145           VT = TLI->getPointerTy(CurDAG->getDataLayout()).SimpleTy;
3146         VTs.push_back(VT);
3147       }
3148
3149       if (EmitNodeInfo & OPFL_Chain)
3150         VTs.push_back(MVT::Other);
3151       if (EmitNodeInfo & OPFL_GlueOutput)
3152         VTs.push_back(MVT::Glue);
3153
3154       // This is hot code, so optimize the two most common cases of 1 and 2
3155       // results.
3156       SDVTList VTList;
3157       if (VTs.size() == 1)
3158         VTList = CurDAG->getVTList(VTs[0]);
3159       else if (VTs.size() == 2)
3160         VTList = CurDAG->getVTList(VTs[0], VTs[1]);
3161       else
3162         VTList = CurDAG->getVTList(VTs);
3163
3164       // Get the operand list.
3165       unsigned NumOps = MatcherTable[MatcherIndex++];
3166       SmallVector<SDValue, 8> Ops;
3167       for (unsigned i = 0; i != NumOps; ++i) {
3168         unsigned RecNo = MatcherTable[MatcherIndex++];
3169         if (RecNo & 128)
3170           RecNo = GetVBR(RecNo, MatcherTable, MatcherIndex);
3171
3172         assert(RecNo < RecordedNodes.size() && "Invalid EmitNode");
3173         Ops.push_back(RecordedNodes[RecNo].first);
3174       }
3175
3176       // If there are variadic operands to add, handle them now.
3177       if (EmitNodeInfo & OPFL_VariadicInfo) {
3178         // Determine the start index to copy from.
3179         unsigned FirstOpToCopy = getNumFixedFromVariadicInfo(EmitNodeInfo);
3180         FirstOpToCopy += (EmitNodeInfo & OPFL_Chain) ? 1 : 0;
3181         assert(NodeToMatch->getNumOperands() >= FirstOpToCopy &&
3182                "Invalid variadic node");
3183         // Copy all of the variadic operands, not including a potential glue
3184         // input.
3185         for (unsigned i = FirstOpToCopy, e = NodeToMatch->getNumOperands();
3186              i != e; ++i) {
3187           SDValue V = NodeToMatch->getOperand(i);
3188           if (V.getValueType() == MVT::Glue) break;
3189           Ops.push_back(V);
3190         }
3191       }
3192
3193       // If this has chain/glue inputs, add them.
3194       if (EmitNodeInfo & OPFL_Chain)
3195         Ops.push_back(InputChain);
3196       if ((EmitNodeInfo & OPFL_GlueInput) && InputGlue.getNode() != nullptr)
3197         Ops.push_back(InputGlue);
3198
3199       // Create the node.
3200       SDNode *Res = nullptr;
3201       if (Opcode != OPC_MorphNodeTo) {
3202         // If this is a normal EmitNode command, just create the new node and
3203         // add the results to the RecordedNodes list.
3204         Res = CurDAG->getMachineNode(TargetOpc, SDLoc(NodeToMatch),
3205                                      VTList, Ops);
3206
3207         // Add all the non-glue/non-chain results to the RecordedNodes list.
3208         for (unsigned i = 0, e = VTs.size(); i != e; ++i) {
3209           if (VTs[i] == MVT::Other || VTs[i] == MVT::Glue) break;
3210           RecordedNodes.push_back(std::pair<SDValue,SDNode*>(SDValue(Res, i),
3211                                                              nullptr));
3212         }
3213
3214       } else if (NodeToMatch->getOpcode() != ISD::DELETED_NODE) {
3215         Res = MorphNode(NodeToMatch, TargetOpc, VTList, Ops, EmitNodeInfo);
3216       } else {
3217         // NodeToMatch was eliminated by CSE when the target changed the DAG.
3218         // We will visit the equivalent node later.
3219         DEBUG(dbgs() << "Node was eliminated by CSE\n");
3220         return nullptr;
3221       }
3222
3223       // If the node had chain/glue results, update our notion of the current
3224       // chain and glue.
3225       if (EmitNodeInfo & OPFL_GlueOutput) {
3226         InputGlue = SDValue(Res, VTs.size()-1);
3227         if (EmitNodeInfo & OPFL_Chain)
3228           InputChain = SDValue(Res, VTs.size()-2);
3229       } else if (EmitNodeInfo & OPFL_Chain)
3230         InputChain = SDValue(Res, VTs.size()-1);
3231
3232       // If the OPFL_MemRefs glue is set on this node, slap all of the
3233       // accumulated memrefs onto it.
3234       //
3235       // FIXME: This is vastly incorrect for patterns with multiple outputs
3236       // instructions that access memory and for ComplexPatterns that match
3237       // loads.
3238       if (EmitNodeInfo & OPFL_MemRefs) {
3239         // Only attach load or store memory operands if the generated
3240         // instruction may load or store.
3241         const MCInstrDesc &MCID = TII->get(TargetOpc);
3242         bool mayLoad = MCID.mayLoad();
3243         bool mayStore = MCID.mayStore();
3244
3245         unsigned NumMemRefs = 0;
3246         for (SmallVectorImpl<MachineMemOperand *>::const_iterator I =
3247                MatchedMemRefs.begin(), E = MatchedMemRefs.end(); I != E; ++I) {
3248           if ((*I)->isLoad()) {
3249             if (mayLoad)
3250               ++NumMemRefs;
3251           } else if ((*I)->isStore()) {
3252             if (mayStore)
3253               ++NumMemRefs;
3254           } else {
3255             ++NumMemRefs;
3256           }
3257         }
3258
3259         MachineSDNode::mmo_iterator MemRefs =
3260           MF->allocateMemRefsArray(NumMemRefs);
3261
3262         MachineSDNode::mmo_iterator MemRefsPos = MemRefs;
3263         for (SmallVectorImpl<MachineMemOperand *>::const_iterator I =
3264                MatchedMemRefs.begin(), E = MatchedMemRefs.end(); I != E; ++I) {
3265           if ((*I)->isLoad()) {
3266             if (mayLoad)
3267               *MemRefsPos++ = *I;
3268           } else if ((*I)->isStore()) {
3269             if (mayStore)
3270               *MemRefsPos++ = *I;
3271           } else {
3272             *MemRefsPos++ = *I;
3273           }
3274         }
3275
3276         cast<MachineSDNode>(Res)
3277           ->setMemRefs(MemRefs, MemRefs + NumMemRefs);
3278       }
3279
3280       DEBUG(dbgs() << "  "
3281                    << (Opcode == OPC_MorphNodeTo ? "Morphed" : "Created")
3282                    << " node: "; Res->dump(CurDAG); dbgs() << "\n");
3283
3284       // If this was a MorphNodeTo then we're completely done!
3285       if (Opcode == OPC_MorphNodeTo) {
3286         // Update chain and glue uses.
3287         UpdateChainsAndGlue(NodeToMatch, InputChain, ChainNodesMatched,
3288                             InputGlue, GlueResultNodesMatched, true);
3289         return Res;
3290       }
3291
3292       continue;
3293     }
3294
3295     case OPC_MarkGlueResults: {
3296       unsigned NumNodes = MatcherTable[MatcherIndex++];
3297
3298       // Read and remember all the glue-result nodes.
3299       for (unsigned i = 0; i != NumNodes; ++i) {
3300         unsigned RecNo = MatcherTable[MatcherIndex++];
3301         if (RecNo & 128)
3302           RecNo = GetVBR(RecNo, MatcherTable, MatcherIndex);
3303
3304         assert(RecNo < RecordedNodes.size() && "Invalid MarkGlueResults");
3305         GlueResultNodesMatched.push_back(RecordedNodes[RecNo].first.getNode());
3306       }
3307       continue;
3308     }
3309
3310     case OPC_CompleteMatch: {
3311       // The match has been completed, and any new nodes (if any) have been
3312       // created.  Patch up references to the matched dag to use the newly
3313       // created nodes.
3314       unsigned NumResults = MatcherTable[MatcherIndex++];
3315
3316       for (unsigned i = 0; i != NumResults; ++i) {
3317         unsigned ResSlot = MatcherTable[MatcherIndex++];
3318         if (ResSlot & 128)
3319           ResSlot = GetVBR(ResSlot, MatcherTable, MatcherIndex);
3320
3321         assert(ResSlot < RecordedNodes.size() && "Invalid CompleteMatch");
3322         SDValue Res = RecordedNodes[ResSlot].first;
3323
3324         assert(i < NodeToMatch->getNumValues() &&
3325                NodeToMatch->getValueType(i) != MVT::Other &&
3326                NodeToMatch->getValueType(i) != MVT::Glue &&
3327                "Invalid number of results to complete!");
3328         assert((NodeToMatch->getValueType(i) == Res.getValueType() ||
3329                 NodeToMatch->getValueType(i) == MVT::iPTR ||
3330                 Res.getValueType() == MVT::iPTR ||
3331                 NodeToMatch->getValueType(i).getSizeInBits() ==
3332                     Res.getValueType().getSizeInBits()) &&
3333                "invalid replacement");
3334         CurDAG->ReplaceAllUsesOfValueWith(SDValue(NodeToMatch, i), Res);
3335       }
3336
3337       // If the root node defines glue, add it to the glue nodes to update list.
3338       if (NodeToMatch->getValueType(NodeToMatch->getNumValues()-1) == MVT::Glue)
3339         GlueResultNodesMatched.push_back(NodeToMatch);
3340
3341       // Update chain and glue uses.
3342       UpdateChainsAndGlue(NodeToMatch, InputChain, ChainNodesMatched,
3343                           InputGlue, GlueResultNodesMatched, false);
3344
3345       assert(NodeToMatch->use_empty() &&
3346              "Didn't replace all uses of the node?");
3347
3348       // FIXME: We just return here, which interacts correctly with SelectRoot
3349       // above.  We should fix this to not return an SDNode* anymore.
3350       return nullptr;
3351     }
3352     }
3353
3354     // If the code reached this point, then the match failed.  See if there is
3355     // another child to try in the current 'Scope', otherwise pop it until we
3356     // find a case to check.
3357     DEBUG(dbgs() << "  Match failed at index " << CurrentOpcodeIndex << "\n");
3358     ++NumDAGIselRetries;
3359     while (1) {
3360       if (MatchScopes.empty()) {
3361         CannotYetSelect(NodeToMatch);
3362         return nullptr;
3363       }
3364
3365       // Restore the interpreter state back to the point where the scope was
3366       // formed.
3367       MatchScope &LastScope = MatchScopes.back();
3368       RecordedNodes.resize(LastScope.NumRecordedNodes);
3369       NodeStack.clear();
3370       NodeStack.append(LastScope.NodeStack.begin(), LastScope.NodeStack.end());
3371       N = NodeStack.back();
3372
3373       if (LastScope.NumMatchedMemRefs != MatchedMemRefs.size())
3374         MatchedMemRefs.resize(LastScope.NumMatchedMemRefs);
3375       MatcherIndex = LastScope.FailIndex;
3376
3377       DEBUG(dbgs() << "  Continuing at " << MatcherIndex << "\n");
3378
3379       InputChain = LastScope.InputChain;
3380       InputGlue = LastScope.InputGlue;
3381       if (!LastScope.HasChainNodesMatched)
3382         ChainNodesMatched.clear();
3383       if (!LastScope.HasGlueResultNodesMatched)
3384         GlueResultNodesMatched.clear();
3385
3386       // Check to see what the offset is at the new MatcherIndex.  If it is zero
3387       // we have reached the end of this scope, otherwise we have another child
3388       // in the current scope to try.
3389       unsigned NumToSkip = MatcherTable[MatcherIndex++];
3390       if (NumToSkip & 128)
3391         NumToSkip = GetVBR(NumToSkip, MatcherTable, MatcherIndex);
3392
3393       // If we have another child in this scope to match, update FailIndex and
3394       // try it.
3395       if (NumToSkip != 0) {
3396         LastScope.FailIndex = MatcherIndex+NumToSkip;
3397         break;
3398       }
3399
3400       // End of this scope, pop it and try the next child in the containing
3401       // scope.
3402       MatchScopes.pop_back();
3403     }
3404   }
3405 }
3406
3407
3408
3409 void SelectionDAGISel::CannotYetSelect(SDNode *N) {
3410   std::string msg;
3411   raw_string_ostream Msg(msg);
3412   Msg << "Cannot select: ";
3413
3414   if (N->getOpcode() != ISD::INTRINSIC_W_CHAIN &&
3415       N->getOpcode() != ISD::INTRINSIC_WO_CHAIN &&
3416       N->getOpcode() != ISD::INTRINSIC_VOID) {
3417     N->printrFull(Msg, CurDAG);
3418     Msg << "\nIn function: " << MF->getName();
3419   } else {
3420     bool HasInputChain = N->getOperand(0).getValueType() == MVT::Other;
3421     unsigned iid =
3422       cast<ConstantSDNode>(N->getOperand(HasInputChain))->getZExtValue();
3423     if (iid < Intrinsic::num_intrinsics)
3424       Msg << "intrinsic %" << Intrinsic::getName((Intrinsic::ID)iid);
3425     else if (const TargetIntrinsicInfo *TII = TM.getIntrinsicInfo())
3426       Msg << "target intrinsic %" << TII->getName(iid);
3427     else
3428       Msg << "unknown intrinsic #" << iid;
3429   }
3430   report_fatal_error(Msg.str());
3431 }
3432
3433 char SelectionDAGISel::ID = 0;