SelectionDAG: Remove implicit ilist iterator conversions, NFC
[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 (BasicBlock &BB : Fn) {
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->front();
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   // Mark exception register as live in.
977   if (unsigned Reg = TLI->getExceptionPointerRegister())
978     FuncInfo->ExceptionPointerVirtReg = MBB->addLiveIn(Reg, PtrRC);
979
980   // Mark exception selector register as live in.
981   if (unsigned Reg = TLI->getExceptionSelectorRegister())
982     FuncInfo->ExceptionSelectorVirtReg = MBB->addLiveIn(Reg, PtrRC);
983
984   return true;
985 }
986
987 /// isFoldedOrDeadInstruction - Return true if the specified instruction is
988 /// side-effect free and is either dead or folded into a generated instruction.
989 /// Return false if it needs to be emitted.
990 static bool isFoldedOrDeadInstruction(const Instruction *I,
991                                       FunctionLoweringInfo *FuncInfo) {
992   return !I->mayWriteToMemory() && // Side-effecting instructions aren't folded.
993          !isa<TerminatorInst>(I) &&    // Terminators aren't folded.
994          !isa<DbgInfoIntrinsic>(I) &&  // Debug instructions aren't folded.
995          !I->isEHPad() &&              // EH pad instructions aren't folded.
996          !FuncInfo->isExportedInst(I); // Exported instrs must be computed.
997 }
998
999 #ifndef NDEBUG
1000 // Collect per Instruction statistics for fast-isel misses.  Only those
1001 // instructions that cause the bail are accounted for.  It does not account for
1002 // instructions higher in the block.  Thus, summing the per instructions stats
1003 // will not add up to what is reported by NumFastIselFailures.
1004 static void collectFailStats(const Instruction *I) {
1005   switch (I->getOpcode()) {
1006   default: assert (0 && "<Invalid operator> ");
1007
1008   // Terminators
1009   case Instruction::Ret:         NumFastIselFailRet++; return;
1010   case Instruction::Br:          NumFastIselFailBr++; return;
1011   case Instruction::Switch:      NumFastIselFailSwitch++; return;
1012   case Instruction::IndirectBr:  NumFastIselFailIndirectBr++; return;
1013   case Instruction::Invoke:      NumFastIselFailInvoke++; return;
1014   case Instruction::Resume:      NumFastIselFailResume++; return;
1015   case Instruction::Unreachable: NumFastIselFailUnreachable++; return;
1016
1017   // Standard binary operators...
1018   case Instruction::Add:  NumFastIselFailAdd++; return;
1019   case Instruction::FAdd: NumFastIselFailFAdd++; return;
1020   case Instruction::Sub:  NumFastIselFailSub++; return;
1021   case Instruction::FSub: NumFastIselFailFSub++; return;
1022   case Instruction::Mul:  NumFastIselFailMul++; return;
1023   case Instruction::FMul: NumFastIselFailFMul++; return;
1024   case Instruction::UDiv: NumFastIselFailUDiv++; return;
1025   case Instruction::SDiv: NumFastIselFailSDiv++; return;
1026   case Instruction::FDiv: NumFastIselFailFDiv++; return;
1027   case Instruction::URem: NumFastIselFailURem++; return;
1028   case Instruction::SRem: NumFastIselFailSRem++; return;
1029   case Instruction::FRem: NumFastIselFailFRem++; return;
1030
1031   // Logical operators...
1032   case Instruction::And: NumFastIselFailAnd++; return;
1033   case Instruction::Or:  NumFastIselFailOr++; return;
1034   case Instruction::Xor: NumFastIselFailXor++; return;
1035
1036   // Memory instructions...
1037   case Instruction::Alloca:        NumFastIselFailAlloca++; return;
1038   case Instruction::Load:          NumFastIselFailLoad++; return;
1039   case Instruction::Store:         NumFastIselFailStore++; return;
1040   case Instruction::AtomicCmpXchg: NumFastIselFailAtomicCmpXchg++; return;
1041   case Instruction::AtomicRMW:     NumFastIselFailAtomicRMW++; return;
1042   case Instruction::Fence:         NumFastIselFailFence++; return;
1043   case Instruction::GetElementPtr: NumFastIselFailGetElementPtr++; return;
1044
1045   // Convert instructions...
1046   case Instruction::Trunc:    NumFastIselFailTrunc++; return;
1047   case Instruction::ZExt:     NumFastIselFailZExt++; return;
1048   case Instruction::SExt:     NumFastIselFailSExt++; return;
1049   case Instruction::FPTrunc:  NumFastIselFailFPTrunc++; return;
1050   case Instruction::FPExt:    NumFastIselFailFPExt++; return;
1051   case Instruction::FPToUI:   NumFastIselFailFPToUI++; return;
1052   case Instruction::FPToSI:   NumFastIselFailFPToSI++; return;
1053   case Instruction::UIToFP:   NumFastIselFailUIToFP++; return;
1054   case Instruction::SIToFP:   NumFastIselFailSIToFP++; return;
1055   case Instruction::IntToPtr: NumFastIselFailIntToPtr++; return;
1056   case Instruction::PtrToInt: NumFastIselFailPtrToInt++; return;
1057   case Instruction::BitCast:  NumFastIselFailBitCast++; return;
1058
1059   // Other instructions...
1060   case Instruction::ICmp:           NumFastIselFailICmp++; return;
1061   case Instruction::FCmp:           NumFastIselFailFCmp++; return;
1062   case Instruction::PHI:            NumFastIselFailPHI++; return;
1063   case Instruction::Select:         NumFastIselFailSelect++; return;
1064   case Instruction::Call: {
1065     if (auto const *Intrinsic = dyn_cast<IntrinsicInst>(I)) {
1066       switch (Intrinsic->getIntrinsicID()) {
1067       default:
1068         NumFastIselFailIntrinsicCall++; return;
1069       case Intrinsic::sadd_with_overflow:
1070         NumFastIselFailSAddWithOverflow++; return;
1071       case Intrinsic::uadd_with_overflow:
1072         NumFastIselFailUAddWithOverflow++; return;
1073       case Intrinsic::ssub_with_overflow:
1074         NumFastIselFailSSubWithOverflow++; return;
1075       case Intrinsic::usub_with_overflow:
1076         NumFastIselFailUSubWithOverflow++; return;
1077       case Intrinsic::smul_with_overflow:
1078         NumFastIselFailSMulWithOverflow++; return;
1079       case Intrinsic::umul_with_overflow:
1080         NumFastIselFailUMulWithOverflow++; return;
1081       case Intrinsic::frameaddress:
1082         NumFastIselFailFrameaddress++; return;
1083       case Intrinsic::sqrt:
1084           NumFastIselFailSqrt++; return;
1085       case Intrinsic::experimental_stackmap:
1086         NumFastIselFailStackMap++; return;
1087       case Intrinsic::experimental_patchpoint_void: // fall-through
1088       case Intrinsic::experimental_patchpoint_i64:
1089         NumFastIselFailPatchPoint++; return;
1090       }
1091     }
1092     NumFastIselFailCall++;
1093     return;
1094   }
1095   case Instruction::Shl:            NumFastIselFailShl++; return;
1096   case Instruction::LShr:           NumFastIselFailLShr++; return;
1097   case Instruction::AShr:           NumFastIselFailAShr++; return;
1098   case Instruction::VAArg:          NumFastIselFailVAArg++; return;
1099   case Instruction::ExtractElement: NumFastIselFailExtractElement++; return;
1100   case Instruction::InsertElement:  NumFastIselFailInsertElement++; return;
1101   case Instruction::ShuffleVector:  NumFastIselFailShuffleVector++; return;
1102   case Instruction::ExtractValue:   NumFastIselFailExtractValue++; return;
1103   case Instruction::InsertValue:    NumFastIselFailInsertValue++; return;
1104   case Instruction::LandingPad:     NumFastIselFailLandingPad++; return;
1105   }
1106 }
1107 #endif
1108
1109 void SelectionDAGISel::SelectAllBasicBlocks(const Function &Fn) {
1110   // Initialize the Fast-ISel state, if needed.
1111   FastISel *FastIS = nullptr;
1112   if (TM.Options.EnableFastISel)
1113     FastIS = TLI->createFastISel(*FuncInfo, LibInfo);
1114
1115   // Iterate over all basic blocks in the function.
1116   ReversePostOrderTraversal<const Function*> RPOT(&Fn);
1117   for (ReversePostOrderTraversal<const Function*>::rpo_iterator
1118        I = RPOT.begin(), E = RPOT.end(); I != E; ++I) {
1119     const BasicBlock *LLVMBB = *I;
1120
1121     if (OptLevel != CodeGenOpt::None) {
1122       bool AllPredsVisited = true;
1123       for (const_pred_iterator PI = pred_begin(LLVMBB), PE = pred_end(LLVMBB);
1124            PI != PE; ++PI) {
1125         if (!FuncInfo->VisitedBBs.count(*PI)) {
1126           AllPredsVisited = false;
1127           break;
1128         }
1129       }
1130
1131       if (AllPredsVisited) {
1132         for (BasicBlock::const_iterator I = LLVMBB->begin();
1133              const PHINode *PN = dyn_cast<PHINode>(I); ++I)
1134           FuncInfo->ComputePHILiveOutRegInfo(PN);
1135       } else {
1136         for (BasicBlock::const_iterator I = LLVMBB->begin();
1137              const PHINode *PN = dyn_cast<PHINode>(I); ++I)
1138           FuncInfo->InvalidatePHILiveOutRegInfo(PN);
1139       }
1140
1141       FuncInfo->VisitedBBs.insert(LLVMBB);
1142     }
1143
1144     BasicBlock::const_iterator const Begin =
1145         LLVMBB->getFirstNonPHI()->getIterator();
1146     BasicBlock::const_iterator const End = LLVMBB->end();
1147     BasicBlock::const_iterator BI = End;
1148
1149     FuncInfo->MBB = FuncInfo->MBBMap[LLVMBB];
1150     if (!FuncInfo->MBB)
1151       continue; // Some blocks like catchpads have no code or MBB.
1152     FuncInfo->InsertPt = FuncInfo->MBB->getFirstNonPHI();
1153
1154     // Setup an EH landing-pad block.
1155     FuncInfo->ExceptionPointerVirtReg = 0;
1156     FuncInfo->ExceptionSelectorVirtReg = 0;
1157     if (LLVMBB->isEHPad())
1158       if (!PrepareEHLandingPad())
1159         continue;
1160
1161     // Before doing SelectionDAG ISel, see if FastISel has been requested.
1162     if (FastIS) {
1163       FastIS->startNewBlock();
1164
1165       // Emit code for any incoming arguments. This must happen before
1166       // beginning FastISel on the entry block.
1167       if (LLVMBB == &Fn.getEntryBlock()) {
1168         ++NumEntryBlocks;
1169
1170         // Lower any arguments needed in this block if this is the entry block.
1171         if (!FastIS->lowerArguments()) {
1172           // Fast isel failed to lower these arguments
1173           ++NumFastIselFailLowerArguments;
1174           if (EnableFastISelAbort > 1)
1175             report_fatal_error("FastISel didn't lower all arguments");
1176
1177           // Use SelectionDAG argument lowering
1178           LowerArguments(Fn);
1179           CurDAG->setRoot(SDB->getControlRoot());
1180           SDB->clear();
1181           CodeGenAndEmitDAG();
1182         }
1183
1184         // If we inserted any instructions at the beginning, make a note of
1185         // where they are, so we can be sure to emit subsequent instructions
1186         // after them.
1187         if (FuncInfo->InsertPt != FuncInfo->MBB->begin())
1188           FastIS->setLastLocalValue(std::prev(FuncInfo->InsertPt));
1189         else
1190           FastIS->setLastLocalValue(nullptr);
1191       }
1192
1193       unsigned NumFastIselRemaining = std::distance(Begin, End);
1194       // Do FastISel on as many instructions as possible.
1195       for (; BI != Begin; --BI) {
1196         const Instruction *Inst = &*std::prev(BI);
1197
1198         // If we no longer require this instruction, skip it.
1199         if (isFoldedOrDeadInstruction(Inst, FuncInfo)) {
1200           --NumFastIselRemaining;
1201           continue;
1202         }
1203
1204         // Bottom-up: reset the insert pos at the top, after any local-value
1205         // instructions.
1206         FastIS->recomputeInsertPt();
1207
1208         // Try to select the instruction with FastISel.
1209         if (FastIS->selectInstruction(Inst)) {
1210           --NumFastIselRemaining;
1211           ++NumFastIselSuccess;
1212           // If fast isel succeeded, skip over all the folded instructions, and
1213           // then see if there is a load right before the selected instructions.
1214           // Try to fold the load if so.
1215           const Instruction *BeforeInst = Inst;
1216           while (BeforeInst != &*Begin) {
1217             BeforeInst = &*std::prev(BasicBlock::const_iterator(BeforeInst));
1218             if (!isFoldedOrDeadInstruction(BeforeInst, FuncInfo))
1219               break;
1220           }
1221           if (BeforeInst != Inst && isa<LoadInst>(BeforeInst) &&
1222               BeforeInst->hasOneUse() &&
1223               FastIS->tryToFoldLoad(cast<LoadInst>(BeforeInst), Inst)) {
1224             // If we succeeded, don't re-select the load.
1225             BI = std::next(BasicBlock::const_iterator(BeforeInst));
1226             --NumFastIselRemaining;
1227             ++NumFastIselSuccess;
1228           }
1229           continue;
1230         }
1231
1232 #ifndef NDEBUG
1233         if (EnableFastISelVerbose2)
1234           collectFailStats(Inst);
1235 #endif
1236
1237         // Then handle certain instructions as single-LLVM-Instruction blocks.
1238         if (isa<CallInst>(Inst)) {
1239
1240           if (EnableFastISelVerbose || EnableFastISelAbort) {
1241             dbgs() << "FastISel missed call: ";
1242             Inst->dump();
1243           }
1244           if (EnableFastISelAbort > 2)
1245             // FastISel selector couldn't handle something and bailed.
1246             // For the purpose of debugging, just abort.
1247             report_fatal_error("FastISel didn't select the entire block");
1248
1249           if (!Inst->getType()->isVoidTy() && !Inst->getType()->isTokenTy() &&
1250               !Inst->use_empty()) {
1251             unsigned &R = FuncInfo->ValueMap[Inst];
1252             if (!R)
1253               R = FuncInfo->CreateRegs(Inst->getType());
1254           }
1255
1256           bool HadTailCall = false;
1257           MachineBasicBlock::iterator SavedInsertPt = FuncInfo->InsertPt;
1258           SelectBasicBlock(Inst->getIterator(), BI, HadTailCall);
1259
1260           // If the call was emitted as a tail call, we're done with the block.
1261           // We also need to delete any previously emitted instructions.
1262           if (HadTailCall) {
1263             FastIS->removeDeadCode(SavedInsertPt, FuncInfo->MBB->end());
1264             --BI;
1265             break;
1266           }
1267
1268           // Recompute NumFastIselRemaining as Selection DAG instruction
1269           // selection may have handled the call, input args, etc.
1270           unsigned RemainingNow = std::distance(Begin, BI);
1271           NumFastIselFailures += NumFastIselRemaining - RemainingNow;
1272           NumFastIselRemaining = RemainingNow;
1273           continue;
1274         }
1275
1276         bool ShouldAbort = EnableFastISelAbort;
1277         if (EnableFastISelVerbose || EnableFastISelAbort) {
1278           if (isa<TerminatorInst>(Inst)) {
1279             // Use a different message for terminator misses.
1280             dbgs() << "FastISel missed terminator: ";
1281             // Don't abort unless for terminator unless the level is really high
1282             ShouldAbort = (EnableFastISelAbort > 2);
1283           } else {
1284             dbgs() << "FastISel miss: ";
1285           }
1286           Inst->dump();
1287         }
1288         if (ShouldAbort)
1289           // FastISel selector couldn't handle something and bailed.
1290           // For the purpose of debugging, just abort.
1291           report_fatal_error("FastISel didn't select the entire block");
1292
1293         NumFastIselFailures += NumFastIselRemaining;
1294         break;
1295       }
1296
1297       FastIS->recomputeInsertPt();
1298     } else {
1299       // Lower any arguments needed in this block if this is the entry block.
1300       if (LLVMBB == &Fn.getEntryBlock()) {
1301         ++NumEntryBlocks;
1302         LowerArguments(Fn);
1303       }
1304     }
1305
1306     if (Begin != BI)
1307       ++NumDAGBlocks;
1308     else
1309       ++NumFastIselBlocks;
1310
1311     if (Begin != BI) {
1312       // Run SelectionDAG instruction selection on the remainder of the block
1313       // not handled by FastISel. If FastISel is not run, this is the entire
1314       // block.
1315       bool HadTailCall;
1316       SelectBasicBlock(Begin, BI, HadTailCall);
1317     }
1318
1319     FinishBasicBlock();
1320     FuncInfo->PHINodesToUpdate.clear();
1321   }
1322
1323   delete FastIS;
1324   SDB->clearDanglingDebugInfo();
1325   SDB->SPDescriptor.resetPerFunctionState();
1326 }
1327
1328 /// Given that the input MI is before a partial terminator sequence TSeq, return
1329 /// true if M + TSeq also a partial terminator sequence.
1330 ///
1331 /// A Terminator sequence is a sequence of MachineInstrs which at this point in
1332 /// lowering copy vregs into physical registers, which are then passed into
1333 /// terminator instructors so we can satisfy ABI constraints. A partial
1334 /// terminator sequence is an improper subset of a terminator sequence (i.e. it
1335 /// may be the whole terminator sequence).
1336 static bool MIIsInTerminatorSequence(const MachineInstr *MI) {
1337   // If we do not have a copy or an implicit def, we return true if and only if
1338   // MI is a debug value.
1339   if (!MI->isCopy() && !MI->isImplicitDef())
1340     // Sometimes DBG_VALUE MI sneak in between the copies from the vregs to the
1341     // physical registers if there is debug info associated with the terminator
1342     // of our mbb. We want to include said debug info in our terminator
1343     // sequence, so we return true in that case.
1344     return MI->isDebugValue();
1345
1346   // We have left the terminator sequence if we are not doing one of the
1347   // following:
1348   //
1349   // 1. Copying a vreg into a physical register.
1350   // 2. Copying a vreg into a vreg.
1351   // 3. Defining a register via an implicit def.
1352
1353   // OPI should always be a register definition...
1354   MachineInstr::const_mop_iterator OPI = MI->operands_begin();
1355   if (!OPI->isReg() || !OPI->isDef())
1356     return false;
1357
1358   // Defining any register via an implicit def is always ok.
1359   if (MI->isImplicitDef())
1360     return true;
1361
1362   // Grab the copy source...
1363   MachineInstr::const_mop_iterator OPI2 = OPI;
1364   ++OPI2;
1365   assert(OPI2 != MI->operands_end()
1366          && "Should have a copy implying we should have 2 arguments.");
1367
1368   // Make sure that the copy dest is not a vreg when the copy source is a
1369   // physical register.
1370   if (!OPI2->isReg() ||
1371       (!TargetRegisterInfo::isPhysicalRegister(OPI->getReg()) &&
1372        TargetRegisterInfo::isPhysicalRegister(OPI2->getReg())))
1373     return false;
1374
1375   return true;
1376 }
1377
1378 /// Find the split point at which to splice the end of BB into its success stack
1379 /// protector check machine basic block.
1380 ///
1381 /// On many platforms, due to ABI constraints, terminators, even before register
1382 /// allocation, use physical registers. This creates an issue for us since
1383 /// physical registers at this point can not travel across basic
1384 /// blocks. Luckily, selectiondag always moves physical registers into vregs
1385 /// when they enter functions and moves them through a sequence of copies back
1386 /// into the physical registers right before the terminator creating a
1387 /// ``Terminator Sequence''. This function is searching for the beginning of the
1388 /// terminator sequence so that we can ensure that we splice off not just the
1389 /// terminator, but additionally the copies that move the vregs into the
1390 /// physical registers.
1391 static MachineBasicBlock::iterator
1392 FindSplitPointForStackProtector(MachineBasicBlock *BB, DebugLoc DL) {
1393   MachineBasicBlock::iterator SplitPoint = BB->getFirstTerminator();
1394   //
1395   if (SplitPoint == BB->begin())
1396     return SplitPoint;
1397
1398   MachineBasicBlock::iterator Start = BB->begin();
1399   MachineBasicBlock::iterator Previous = SplitPoint;
1400   --Previous;
1401
1402   while (MIIsInTerminatorSequence(Previous)) {
1403     SplitPoint = Previous;
1404     if (Previous == Start)
1405       break;
1406     --Previous;
1407   }
1408
1409   return SplitPoint;
1410 }
1411
1412 void
1413 SelectionDAGISel::FinishBasicBlock() {
1414
1415   DEBUG(dbgs() << "Total amount of phi nodes to update: "
1416                << FuncInfo->PHINodesToUpdate.size() << "\n";
1417         for (unsigned i = 0, e = FuncInfo->PHINodesToUpdate.size(); i != e; ++i)
1418           dbgs() << "Node " << i << " : ("
1419                  << FuncInfo->PHINodesToUpdate[i].first
1420                  << ", " << FuncInfo->PHINodesToUpdate[i].second << ")\n");
1421
1422   // Next, now that we know what the last MBB the LLVM BB expanded is, update
1423   // PHI nodes in successors.
1424   for (unsigned i = 0, e = FuncInfo->PHINodesToUpdate.size(); i != e; ++i) {
1425     MachineInstrBuilder PHI(*MF, FuncInfo->PHINodesToUpdate[i].first);
1426     assert(PHI->isPHI() &&
1427            "This is not a machine PHI node that we are updating!");
1428     if (!FuncInfo->MBB->isSuccessor(PHI->getParent()))
1429       continue;
1430     PHI.addReg(FuncInfo->PHINodesToUpdate[i].second).addMBB(FuncInfo->MBB);
1431   }
1432
1433   // Handle stack protector.
1434   if (SDB->SPDescriptor.shouldEmitStackProtector()) {
1435     MachineBasicBlock *ParentMBB = SDB->SPDescriptor.getParentMBB();
1436     MachineBasicBlock *SuccessMBB = SDB->SPDescriptor.getSuccessMBB();
1437
1438     // Find the split point to split the parent mbb. At the same time copy all
1439     // physical registers used in the tail of parent mbb into virtual registers
1440     // before the split point and back into physical registers after the split
1441     // point. This prevents us needing to deal with Live-ins and many other
1442     // register allocation issues caused by us splitting the parent mbb. The
1443     // register allocator will clean up said virtual copies later on.
1444     MachineBasicBlock::iterator SplitPoint =
1445       FindSplitPointForStackProtector(ParentMBB, SDB->getCurDebugLoc());
1446
1447     // Splice the terminator of ParentMBB into SuccessMBB.
1448     SuccessMBB->splice(SuccessMBB->end(), ParentMBB,
1449                        SplitPoint,
1450                        ParentMBB->end());
1451
1452     // Add compare/jump on neq/jump to the parent BB.
1453     FuncInfo->MBB = ParentMBB;
1454     FuncInfo->InsertPt = ParentMBB->end();
1455     SDB->visitSPDescriptorParent(SDB->SPDescriptor, ParentMBB);
1456     CurDAG->setRoot(SDB->getRoot());
1457     SDB->clear();
1458     CodeGenAndEmitDAG();
1459
1460     // CodeGen Failure MBB if we have not codegened it yet.
1461     MachineBasicBlock *FailureMBB = SDB->SPDescriptor.getFailureMBB();
1462     if (!FailureMBB->size()) {
1463       FuncInfo->MBB = FailureMBB;
1464       FuncInfo->InsertPt = FailureMBB->end();
1465       SDB->visitSPDescriptorFailure(SDB->SPDescriptor);
1466       CurDAG->setRoot(SDB->getRoot());
1467       SDB->clear();
1468       CodeGenAndEmitDAG();
1469     }
1470
1471     // Clear the Per-BB State.
1472     SDB->SPDescriptor.resetPerBBState();
1473   }
1474
1475   for (unsigned i = 0, e = SDB->BitTestCases.size(); i != e; ++i) {
1476     // Lower header first, if it wasn't already lowered
1477     if (!SDB->BitTestCases[i].Emitted) {
1478       // Set the current basic block to the mbb we wish to insert the code into
1479       FuncInfo->MBB = SDB->BitTestCases[i].Parent;
1480       FuncInfo->InsertPt = FuncInfo->MBB->end();
1481       // Emit the code
1482       SDB->visitBitTestHeader(SDB->BitTestCases[i], FuncInfo->MBB);
1483       CurDAG->setRoot(SDB->getRoot());
1484       SDB->clear();
1485       CodeGenAndEmitDAG();
1486     }
1487
1488     uint32_t UnhandledWeight = SDB->BitTestCases[i].Weight;
1489
1490     for (unsigned j = 0, ej = SDB->BitTestCases[i].Cases.size(); j != ej; ++j) {
1491       UnhandledWeight -= SDB->BitTestCases[i].Cases[j].ExtraWeight;
1492       // Set the current basic block to the mbb we wish to insert the code into
1493       FuncInfo->MBB = SDB->BitTestCases[i].Cases[j].ThisBB;
1494       FuncInfo->InsertPt = FuncInfo->MBB->end();
1495       // Emit the code
1496
1497       // If all cases cover a contiguous range, it is not necessary to jump to
1498       // the default block after the last bit test fails. This is because the
1499       // range check during bit test header creation has guaranteed that every
1500       // case here doesn't go outside the range.
1501       MachineBasicBlock *NextMBB;
1502       if (SDB->BitTestCases[i].ContiguousRange && j + 2 == ej)
1503         NextMBB = SDB->BitTestCases[i].Cases[j + 1].TargetBB;
1504       else if (j + 1 != ej)
1505         NextMBB = SDB->BitTestCases[i].Cases[j + 1].ThisBB;
1506       else
1507         NextMBB = SDB->BitTestCases[i].Default;
1508
1509       SDB->visitBitTestCase(SDB->BitTestCases[i],
1510                             NextMBB,
1511                             UnhandledWeight,
1512                             SDB->BitTestCases[i].Reg,
1513                             SDB->BitTestCases[i].Cases[j],
1514                             FuncInfo->MBB);
1515
1516       CurDAG->setRoot(SDB->getRoot());
1517       SDB->clear();
1518       CodeGenAndEmitDAG();
1519
1520       if (SDB->BitTestCases[i].ContiguousRange && j + 2 == ej)
1521         break;
1522     }
1523
1524     // Update PHI Nodes
1525     for (unsigned pi = 0, pe = FuncInfo->PHINodesToUpdate.size();
1526          pi != pe; ++pi) {
1527       MachineInstrBuilder PHI(*MF, FuncInfo->PHINodesToUpdate[pi].first);
1528       MachineBasicBlock *PHIBB = PHI->getParent();
1529       assert(PHI->isPHI() &&
1530              "This is not a machine PHI node that we are updating!");
1531       // This is "default" BB. We have two jumps to it. From "header" BB and
1532       // from last "case" BB.
1533       if (PHIBB == SDB->BitTestCases[i].Default)
1534         PHI.addReg(FuncInfo->PHINodesToUpdate[pi].second)
1535            .addMBB(SDB->BitTestCases[i].Parent)
1536            .addReg(FuncInfo->PHINodesToUpdate[pi].second)
1537            .addMBB(SDB->BitTestCases[i].Cases.back().ThisBB);
1538       // One of "cases" BB.
1539       for (unsigned j = 0, ej = SDB->BitTestCases[i].Cases.size();
1540            j != ej; ++j) {
1541         MachineBasicBlock* cBB = SDB->BitTestCases[i].Cases[j].ThisBB;
1542         if (cBB->isSuccessor(PHIBB))
1543           PHI.addReg(FuncInfo->PHINodesToUpdate[pi].second).addMBB(cBB);
1544       }
1545     }
1546   }
1547   SDB->BitTestCases.clear();
1548
1549   // If the JumpTable record is filled in, then we need to emit a jump table.
1550   // Updating the PHI nodes is tricky in this case, since we need to determine
1551   // whether the PHI is a successor of the range check MBB or the jump table MBB
1552   for (unsigned i = 0, e = SDB->JTCases.size(); i != e; ++i) {
1553     // Lower header first, if it wasn't already lowered
1554     if (!SDB->JTCases[i].first.Emitted) {
1555       // Set the current basic block to the mbb we wish to insert the code into
1556       FuncInfo->MBB = SDB->JTCases[i].first.HeaderBB;
1557       FuncInfo->InsertPt = FuncInfo->MBB->end();
1558       // Emit the code
1559       SDB->visitJumpTableHeader(SDB->JTCases[i].second, SDB->JTCases[i].first,
1560                                 FuncInfo->MBB);
1561       CurDAG->setRoot(SDB->getRoot());
1562       SDB->clear();
1563       CodeGenAndEmitDAG();
1564     }
1565
1566     // Set the current basic block to the mbb we wish to insert the code into
1567     FuncInfo->MBB = SDB->JTCases[i].second.MBB;
1568     FuncInfo->InsertPt = FuncInfo->MBB->end();
1569     // Emit the code
1570     SDB->visitJumpTable(SDB->JTCases[i].second);
1571     CurDAG->setRoot(SDB->getRoot());
1572     SDB->clear();
1573     CodeGenAndEmitDAG();
1574
1575     // Update PHI Nodes
1576     for (unsigned pi = 0, pe = FuncInfo->PHINodesToUpdate.size();
1577          pi != pe; ++pi) {
1578       MachineInstrBuilder PHI(*MF, FuncInfo->PHINodesToUpdate[pi].first);
1579       MachineBasicBlock *PHIBB = PHI->getParent();
1580       assert(PHI->isPHI() &&
1581              "This is not a machine PHI node that we are updating!");
1582       // "default" BB. We can go there only from header BB.
1583       if (PHIBB == SDB->JTCases[i].second.Default)
1584         PHI.addReg(FuncInfo->PHINodesToUpdate[pi].second)
1585            .addMBB(SDB->JTCases[i].first.HeaderBB);
1586       // JT BB. Just iterate over successors here
1587       if (FuncInfo->MBB->isSuccessor(PHIBB))
1588         PHI.addReg(FuncInfo->PHINodesToUpdate[pi].second).addMBB(FuncInfo->MBB);
1589     }
1590   }
1591   SDB->JTCases.clear();
1592
1593   // If we generated any switch lowering information, build and codegen any
1594   // additional DAGs necessary.
1595   for (unsigned i = 0, e = SDB->SwitchCases.size(); i != e; ++i) {
1596     // Set the current basic block to the mbb we wish to insert the code into
1597     FuncInfo->MBB = SDB->SwitchCases[i].ThisBB;
1598     FuncInfo->InsertPt = FuncInfo->MBB->end();
1599
1600     // Determine the unique successors.
1601     SmallVector<MachineBasicBlock *, 2> Succs;
1602     Succs.push_back(SDB->SwitchCases[i].TrueBB);
1603     if (SDB->SwitchCases[i].TrueBB != SDB->SwitchCases[i].FalseBB)
1604       Succs.push_back(SDB->SwitchCases[i].FalseBB);
1605
1606     // Emit the code. Note that this could result in FuncInfo->MBB being split.
1607     SDB->visitSwitchCase(SDB->SwitchCases[i], FuncInfo->MBB);
1608     CurDAG->setRoot(SDB->getRoot());
1609     SDB->clear();
1610     CodeGenAndEmitDAG();
1611
1612     // Remember the last block, now that any splitting is done, for use in
1613     // populating PHI nodes in successors.
1614     MachineBasicBlock *ThisBB = FuncInfo->MBB;
1615
1616     // Handle any PHI nodes in successors of this chunk, as if we were coming
1617     // from the original BB before switch expansion.  Note that PHI nodes can
1618     // occur multiple times in PHINodesToUpdate.  We have to be very careful to
1619     // handle them the right number of times.
1620     for (unsigned i = 0, e = Succs.size(); i != e; ++i) {
1621       FuncInfo->MBB = Succs[i];
1622       FuncInfo->InsertPt = FuncInfo->MBB->end();
1623       // FuncInfo->MBB may have been removed from the CFG if a branch was
1624       // constant folded.
1625       if (ThisBB->isSuccessor(FuncInfo->MBB)) {
1626         for (MachineBasicBlock::iterator
1627              MBBI = FuncInfo->MBB->begin(), MBBE = FuncInfo->MBB->end();
1628              MBBI != MBBE && MBBI->isPHI(); ++MBBI) {
1629           MachineInstrBuilder PHI(*MF, MBBI);
1630           // This value for this PHI node is recorded in PHINodesToUpdate.
1631           for (unsigned pn = 0; ; ++pn) {
1632             assert(pn != FuncInfo->PHINodesToUpdate.size() &&
1633                    "Didn't find PHI entry!");
1634             if (FuncInfo->PHINodesToUpdate[pn].first == PHI) {
1635               PHI.addReg(FuncInfo->PHINodesToUpdate[pn].second).addMBB(ThisBB);
1636               break;
1637             }
1638           }
1639         }
1640       }
1641     }
1642   }
1643   SDB->SwitchCases.clear();
1644 }
1645
1646
1647 /// Create the scheduler. If a specific scheduler was specified
1648 /// via the SchedulerRegistry, use it, otherwise select the
1649 /// one preferred by the target.
1650 ///
1651 ScheduleDAGSDNodes *SelectionDAGISel::CreateScheduler() {
1652   return ISHeuristic(this, OptLevel);
1653 }
1654
1655 //===----------------------------------------------------------------------===//
1656 // Helper functions used by the generated instruction selector.
1657 //===----------------------------------------------------------------------===//
1658 // Calls to these methods are generated by tblgen.
1659
1660 /// CheckAndMask - The isel is trying to match something like (and X, 255).  If
1661 /// the dag combiner simplified the 255, we still want to match.  RHS is the
1662 /// actual value in the DAG on the RHS of an AND, and DesiredMaskS is the value
1663 /// specified in the .td file (e.g. 255).
1664 bool SelectionDAGISel::CheckAndMask(SDValue LHS, ConstantSDNode *RHS,
1665                                     int64_t DesiredMaskS) const {
1666   const APInt &ActualMask = RHS->getAPIntValue();
1667   const APInt &DesiredMask = APInt(LHS.getValueSizeInBits(), DesiredMaskS);
1668
1669   // If the actual mask exactly matches, success!
1670   if (ActualMask == DesiredMask)
1671     return true;
1672
1673   // If the actual AND mask is allowing unallowed bits, this doesn't match.
1674   if (ActualMask.intersects(~DesiredMask))
1675     return false;
1676
1677   // Otherwise, the DAG Combiner may have proven that the value coming in is
1678   // either already zero or is not demanded.  Check for known zero input bits.
1679   APInt NeededMask = DesiredMask & ~ActualMask;
1680   if (CurDAG->MaskedValueIsZero(LHS, NeededMask))
1681     return true;
1682
1683   // TODO: check to see if missing bits are just not demanded.
1684
1685   // Otherwise, this pattern doesn't match.
1686   return false;
1687 }
1688
1689 /// CheckOrMask - The isel is trying to match something like (or X, 255).  If
1690 /// the dag combiner simplified the 255, we still want to match.  RHS is the
1691 /// actual value in the DAG on the RHS of an OR, and DesiredMaskS is the value
1692 /// specified in the .td file (e.g. 255).
1693 bool SelectionDAGISel::CheckOrMask(SDValue LHS, ConstantSDNode *RHS,
1694                                    int64_t DesiredMaskS) const {
1695   const APInt &ActualMask = RHS->getAPIntValue();
1696   const APInt &DesiredMask = APInt(LHS.getValueSizeInBits(), DesiredMaskS);
1697
1698   // If the actual mask exactly matches, success!
1699   if (ActualMask == DesiredMask)
1700     return true;
1701
1702   // If the actual AND mask is allowing unallowed bits, this doesn't match.
1703   if (ActualMask.intersects(~DesiredMask))
1704     return false;
1705
1706   // Otherwise, the DAG Combiner may have proven that the value coming in is
1707   // either already zero or is not demanded.  Check for known zero input bits.
1708   APInt NeededMask = DesiredMask & ~ActualMask;
1709
1710   APInt KnownZero, KnownOne;
1711   CurDAG->computeKnownBits(LHS, KnownZero, KnownOne);
1712
1713   // If all the missing bits in the or are already known to be set, match!
1714   if ((NeededMask & KnownOne) == NeededMask)
1715     return true;
1716
1717   // TODO: check to see if missing bits are just not demanded.
1718
1719   // Otherwise, this pattern doesn't match.
1720   return false;
1721 }
1722
1723 /// SelectInlineAsmMemoryOperands - Calls to this are automatically generated
1724 /// by tblgen.  Others should not call it.
1725 void SelectionDAGISel::
1726 SelectInlineAsmMemoryOperands(std::vector<SDValue> &Ops, SDLoc DL) {
1727   std::vector<SDValue> InOps;
1728   std::swap(InOps, Ops);
1729
1730   Ops.push_back(InOps[InlineAsm::Op_InputChain]); // 0
1731   Ops.push_back(InOps[InlineAsm::Op_AsmString]);  // 1
1732   Ops.push_back(InOps[InlineAsm::Op_MDNode]);     // 2, !srcloc
1733   Ops.push_back(InOps[InlineAsm::Op_ExtraInfo]);  // 3 (SideEffect, AlignStack)
1734
1735   unsigned i = InlineAsm::Op_FirstOperand, e = InOps.size();
1736   if (InOps[e-1].getValueType() == MVT::Glue)
1737     --e;  // Don't process a glue operand if it is here.
1738
1739   while (i != e) {
1740     unsigned Flags = cast<ConstantSDNode>(InOps[i])->getZExtValue();
1741     if (!InlineAsm::isMemKind(Flags)) {
1742       // Just skip over this operand, copying the operands verbatim.
1743       Ops.insert(Ops.end(), InOps.begin()+i,
1744                  InOps.begin()+i+InlineAsm::getNumOperandRegisters(Flags) + 1);
1745       i += InlineAsm::getNumOperandRegisters(Flags) + 1;
1746     } else {
1747       assert(InlineAsm::getNumOperandRegisters(Flags) == 1 &&
1748              "Memory operand with multiple values?");
1749
1750       unsigned TiedToOperand;
1751       if (InlineAsm::isUseOperandTiedToDef(Flags, TiedToOperand)) {
1752         // We need the constraint ID from the operand this is tied to.
1753         unsigned CurOp = InlineAsm::Op_FirstOperand;
1754         Flags = cast<ConstantSDNode>(InOps[CurOp])->getZExtValue();
1755         for (; TiedToOperand; --TiedToOperand) {
1756           CurOp += InlineAsm::getNumOperandRegisters(Flags)+1;
1757           Flags = cast<ConstantSDNode>(InOps[CurOp])->getZExtValue();
1758         }
1759       }
1760
1761       // Otherwise, this is a memory operand.  Ask the target to select it.
1762       std::vector<SDValue> SelOps;
1763       if (SelectInlineAsmMemoryOperand(InOps[i+1],
1764                                        InlineAsm::getMemoryConstraintID(Flags),
1765                                        SelOps))
1766         report_fatal_error("Could not match memory address.  Inline asm"
1767                            " failure!");
1768
1769       // Add this to the output node.
1770       unsigned NewFlags =
1771         InlineAsm::getFlagWord(InlineAsm::Kind_Mem, SelOps.size());
1772       Ops.push_back(CurDAG->getTargetConstant(NewFlags, DL, MVT::i32));
1773       Ops.insert(Ops.end(), SelOps.begin(), SelOps.end());
1774       i += 2;
1775     }
1776   }
1777
1778   // Add the glue input back if present.
1779   if (e != InOps.size())
1780     Ops.push_back(InOps.back());
1781 }
1782
1783 /// findGlueUse - Return use of MVT::Glue value produced by the specified
1784 /// SDNode.
1785 ///
1786 static SDNode *findGlueUse(SDNode *N) {
1787   unsigned FlagResNo = N->getNumValues()-1;
1788   for (SDNode::use_iterator I = N->use_begin(), E = N->use_end(); I != E; ++I) {
1789     SDUse &Use = I.getUse();
1790     if (Use.getResNo() == FlagResNo)
1791       return Use.getUser();
1792   }
1793   return nullptr;
1794 }
1795
1796 /// findNonImmUse - Return true if "Use" is a non-immediate use of "Def".
1797 /// This function recursively traverses up the operand chain, ignoring
1798 /// certain nodes.
1799 static bool findNonImmUse(SDNode *Use, SDNode* Def, SDNode *ImmedUse,
1800                           SDNode *Root, SmallPtrSetImpl<SDNode*> &Visited,
1801                           bool IgnoreChains) {
1802   // The NodeID's are given uniques ID's where a node ID is guaranteed to be
1803   // greater than all of its (recursive) operands.  If we scan to a point where
1804   // 'use' is smaller than the node we're scanning for, then we know we will
1805   // never find it.
1806   //
1807   // The Use may be -1 (unassigned) if it is a newly allocated node.  This can
1808   // happen because we scan down to newly selected nodes in the case of glue
1809   // uses.
1810   if ((Use->getNodeId() < Def->getNodeId() && Use->getNodeId() != -1))
1811     return false;
1812
1813   // Don't revisit nodes if we already scanned it and didn't fail, we know we
1814   // won't fail if we scan it again.
1815   if (!Visited.insert(Use).second)
1816     return false;
1817
1818   for (const SDValue &Op : Use->op_values()) {
1819     // Ignore chain uses, they are validated by HandleMergeInputChains.
1820     if (Op.getValueType() == MVT::Other && IgnoreChains)
1821       continue;
1822
1823     SDNode *N = Op.getNode();
1824     if (N == Def) {
1825       if (Use == ImmedUse || Use == Root)
1826         continue;  // We are not looking for immediate use.
1827       assert(N != Root);
1828       return true;
1829     }
1830
1831     // Traverse up the operand chain.
1832     if (findNonImmUse(N, Def, ImmedUse, Root, Visited, IgnoreChains))
1833       return true;
1834   }
1835   return false;
1836 }
1837
1838 /// IsProfitableToFold - Returns true if it's profitable to fold the specific
1839 /// operand node N of U during instruction selection that starts at Root.
1840 bool SelectionDAGISel::IsProfitableToFold(SDValue N, SDNode *U,
1841                                           SDNode *Root) const {
1842   if (OptLevel == CodeGenOpt::None) return false;
1843   return N.hasOneUse();
1844 }
1845
1846 /// IsLegalToFold - Returns true if the specific operand node N of
1847 /// U can be folded during instruction selection that starts at Root.
1848 bool SelectionDAGISel::IsLegalToFold(SDValue N, SDNode *U, SDNode *Root,
1849                                      CodeGenOpt::Level OptLevel,
1850                                      bool IgnoreChains) {
1851   if (OptLevel == CodeGenOpt::None) return false;
1852
1853   // If Root use can somehow reach N through a path that that doesn't contain
1854   // U then folding N would create a cycle. e.g. In the following
1855   // diagram, Root can reach N through X. If N is folded into into Root, then
1856   // X is both a predecessor and a successor of U.
1857   //
1858   //          [N*]           //
1859   //         ^   ^           //
1860   //        /     \          //
1861   //      [U*]    [X]?       //
1862   //        ^     ^          //
1863   //         \   /           //
1864   //          \ /            //
1865   //         [Root*]         //
1866   //
1867   // * indicates nodes to be folded together.
1868   //
1869   // If Root produces glue, then it gets (even more) interesting. Since it
1870   // will be "glued" together with its glue use in the scheduler, we need to
1871   // check if it might reach N.
1872   //
1873   //          [N*]           //
1874   //         ^   ^           //
1875   //        /     \          //
1876   //      [U*]    [X]?       //
1877   //        ^       ^        //
1878   //         \       \       //
1879   //          \      |       //
1880   //         [Root*] |       //
1881   //          ^      |       //
1882   //          f      |       //
1883   //          |      /       //
1884   //         [Y]    /        //
1885   //           ^   /         //
1886   //           f  /          //
1887   //           | /           //
1888   //          [GU]           //
1889   //
1890   // If GU (glue use) indirectly reaches N (the load), and Root folds N
1891   // (call it Fold), then X is a predecessor of GU and a successor of
1892   // Fold. But since Fold and GU are glued together, this will create
1893   // a cycle in the scheduling graph.
1894
1895   // If the node has glue, walk down the graph to the "lowest" node in the
1896   // glueged set.
1897   EVT VT = Root->getValueType(Root->getNumValues()-1);
1898   while (VT == MVT::Glue) {
1899     SDNode *GU = findGlueUse(Root);
1900     if (!GU)
1901       break;
1902     Root = GU;
1903     VT = Root->getValueType(Root->getNumValues()-1);
1904
1905     // If our query node has a glue result with a use, we've walked up it.  If
1906     // the user (which has already been selected) has a chain or indirectly uses
1907     // the chain, our WalkChainUsers predicate will not consider it.  Because of
1908     // this, we cannot ignore chains in this predicate.
1909     IgnoreChains = false;
1910   }
1911
1912
1913   SmallPtrSet<SDNode*, 16> Visited;
1914   return !findNonImmUse(Root, N.getNode(), U, Root, Visited, IgnoreChains);
1915 }
1916
1917 SDNode *SelectionDAGISel::Select_INLINEASM(SDNode *N) {
1918   SDLoc DL(N);
1919
1920   std::vector<SDValue> Ops(N->op_begin(), N->op_end());
1921   SelectInlineAsmMemoryOperands(Ops, DL);
1922
1923   const EVT VTs[] = {MVT::Other, MVT::Glue};
1924   SDValue New = CurDAG->getNode(ISD::INLINEASM, DL, VTs, Ops);
1925   New->setNodeId(-1);
1926   return New.getNode();
1927 }
1928
1929 SDNode
1930 *SelectionDAGISel::Select_READ_REGISTER(SDNode *Op) {
1931   SDLoc dl(Op);
1932   MDNodeSDNode *MD = dyn_cast<MDNodeSDNode>(Op->getOperand(1));
1933   const MDString *RegStr = dyn_cast<MDString>(MD->getMD()->getOperand(0));
1934   unsigned Reg =
1935       TLI->getRegisterByName(RegStr->getString().data(), Op->getValueType(0),
1936                              *CurDAG);
1937   SDValue New = CurDAG->getCopyFromReg(
1938                         Op->getOperand(0), dl, Reg, Op->getValueType(0));
1939   New->setNodeId(-1);
1940   return New.getNode();
1941 }
1942
1943 SDNode
1944 *SelectionDAGISel::Select_WRITE_REGISTER(SDNode *Op) {
1945   SDLoc dl(Op);
1946   MDNodeSDNode *MD = dyn_cast<MDNodeSDNode>(Op->getOperand(1));
1947   const MDString *RegStr = dyn_cast<MDString>(MD->getMD()->getOperand(0));
1948   unsigned Reg = TLI->getRegisterByName(RegStr->getString().data(),
1949                                         Op->getOperand(2).getValueType(),
1950                                         *CurDAG);
1951   SDValue New = CurDAG->getCopyToReg(
1952                         Op->getOperand(0), dl, Reg, Op->getOperand(2));
1953   New->setNodeId(-1);
1954   return New.getNode();
1955 }
1956
1957
1958
1959 SDNode *SelectionDAGISel::Select_UNDEF(SDNode *N) {
1960   return CurDAG->SelectNodeTo(N, TargetOpcode::IMPLICIT_DEF,N->getValueType(0));
1961 }
1962
1963 /// GetVBR - decode a vbr encoding whose top bit is set.
1964 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline uint64_t
1965 GetVBR(uint64_t Val, const unsigned char *MatcherTable, unsigned &Idx) {
1966   assert(Val >= 128 && "Not a VBR");
1967   Val &= 127;  // Remove first vbr bit.
1968
1969   unsigned Shift = 7;
1970   uint64_t NextBits;
1971   do {
1972     NextBits = MatcherTable[Idx++];
1973     Val |= (NextBits&127) << Shift;
1974     Shift += 7;
1975   } while (NextBits & 128);
1976
1977   return Val;
1978 }
1979
1980
1981 /// UpdateChainsAndGlue - When a match is complete, this method updates uses of
1982 /// interior glue and chain results to use the new glue and chain results.
1983 void SelectionDAGISel::
1984 UpdateChainsAndGlue(SDNode *NodeToMatch, SDValue InputChain,
1985                     const SmallVectorImpl<SDNode*> &ChainNodesMatched,
1986                     SDValue InputGlue,
1987                     const SmallVectorImpl<SDNode*> &GlueResultNodesMatched,
1988                     bool isMorphNodeTo) {
1989   SmallVector<SDNode*, 4> NowDeadNodes;
1990
1991   // Now that all the normal results are replaced, we replace the chain and
1992   // glue results if present.
1993   if (!ChainNodesMatched.empty()) {
1994     assert(InputChain.getNode() &&
1995            "Matched input chains but didn't produce a chain");
1996     // Loop over all of the nodes we matched that produced a chain result.
1997     // Replace all the chain results with the final chain we ended up with.
1998     for (unsigned i = 0, e = ChainNodesMatched.size(); i != e; ++i) {
1999       SDNode *ChainNode = ChainNodesMatched[i];
2000
2001       // If this node was already deleted, don't look at it.
2002       if (ChainNode->getOpcode() == ISD::DELETED_NODE)
2003         continue;
2004
2005       // Don't replace the results of the root node if we're doing a
2006       // MorphNodeTo.
2007       if (ChainNode == NodeToMatch && isMorphNodeTo)
2008         continue;
2009
2010       SDValue ChainVal = SDValue(ChainNode, ChainNode->getNumValues()-1);
2011       if (ChainVal.getValueType() == MVT::Glue)
2012         ChainVal = ChainVal.getValue(ChainVal->getNumValues()-2);
2013       assert(ChainVal.getValueType() == MVT::Other && "Not a chain?");
2014       CurDAG->ReplaceAllUsesOfValueWith(ChainVal, InputChain);
2015
2016       // If the node became dead and we haven't already seen it, delete it.
2017       if (ChainNode->use_empty() &&
2018           !std::count(NowDeadNodes.begin(), NowDeadNodes.end(), ChainNode))
2019         NowDeadNodes.push_back(ChainNode);
2020     }
2021   }
2022
2023   // If the result produces glue, update any glue results in the matched
2024   // pattern with the glue result.
2025   if (InputGlue.getNode()) {
2026     // Handle any interior nodes explicitly marked.
2027     for (unsigned i = 0, e = GlueResultNodesMatched.size(); i != e; ++i) {
2028       SDNode *FRN = GlueResultNodesMatched[i];
2029
2030       // If this node was already deleted, don't look at it.
2031       if (FRN->getOpcode() == ISD::DELETED_NODE)
2032         continue;
2033
2034       assert(FRN->getValueType(FRN->getNumValues()-1) == MVT::Glue &&
2035              "Doesn't have a glue result");
2036       CurDAG->ReplaceAllUsesOfValueWith(SDValue(FRN, FRN->getNumValues()-1),
2037                                         InputGlue);
2038
2039       // If the node became dead and we haven't already seen it, delete it.
2040       if (FRN->use_empty() &&
2041           !std::count(NowDeadNodes.begin(), NowDeadNodes.end(), FRN))
2042         NowDeadNodes.push_back(FRN);
2043     }
2044   }
2045
2046   if (!NowDeadNodes.empty())
2047     CurDAG->RemoveDeadNodes(NowDeadNodes);
2048
2049   DEBUG(dbgs() << "ISEL: Match complete!\n");
2050 }
2051
2052 enum ChainResult {
2053   CR_Simple,
2054   CR_InducesCycle,
2055   CR_LeadsToInteriorNode
2056 };
2057
2058 /// WalkChainUsers - Walk down the users of the specified chained node that is
2059 /// part of the pattern we're matching, looking at all of the users we find.
2060 /// This determines whether something is an interior node, whether we have a
2061 /// non-pattern node in between two pattern nodes (which prevent folding because
2062 /// it would induce a cycle) and whether we have a TokenFactor node sandwiched
2063 /// between pattern nodes (in which case the TF becomes part of the pattern).
2064 ///
2065 /// The walk we do here is guaranteed to be small because we quickly get down to
2066 /// already selected nodes "below" us.
2067 static ChainResult
2068 WalkChainUsers(const SDNode *ChainedNode,
2069                SmallVectorImpl<SDNode*> &ChainedNodesInPattern,
2070                SmallVectorImpl<SDNode*> &InteriorChainedNodes) {
2071   ChainResult Result = CR_Simple;
2072
2073   for (SDNode::use_iterator UI = ChainedNode->use_begin(),
2074          E = ChainedNode->use_end(); UI != E; ++UI) {
2075     // Make sure the use is of the chain, not some other value we produce.
2076     if (UI.getUse().getValueType() != MVT::Other) continue;
2077
2078     SDNode *User = *UI;
2079
2080     if (User->getOpcode() == ISD::HANDLENODE)  // Root of the graph.
2081       continue;
2082
2083     // If we see an already-selected machine node, then we've gone beyond the
2084     // pattern that we're selecting down into the already selected chunk of the
2085     // DAG.
2086     unsigned UserOpcode = User->getOpcode();
2087     if (User->isMachineOpcode() ||
2088         UserOpcode == ISD::CopyToReg ||
2089         UserOpcode == ISD::CopyFromReg ||
2090         UserOpcode == ISD::INLINEASM ||
2091         UserOpcode == ISD::EH_LABEL ||
2092         UserOpcode == ISD::LIFETIME_START ||
2093         UserOpcode == ISD::LIFETIME_END) {
2094       // If their node ID got reset to -1 then they've already been selected.
2095       // Treat them like a MachineOpcode.
2096       if (User->getNodeId() == -1)
2097         continue;
2098     }
2099
2100     // If we have a TokenFactor, we handle it specially.
2101     if (User->getOpcode() != ISD::TokenFactor) {
2102       // If the node isn't a token factor and isn't part of our pattern, then it
2103       // must be a random chained node in between two nodes we're selecting.
2104       // This happens when we have something like:
2105       //   x = load ptr
2106       //   call
2107       //   y = x+4
2108       //   store y -> ptr
2109       // Because we structurally match the load/store as a read/modify/write,
2110       // but the call is chained between them.  We cannot fold in this case
2111       // because it would induce a cycle in the graph.
2112       if (!std::count(ChainedNodesInPattern.begin(),
2113                       ChainedNodesInPattern.end(), User))
2114         return CR_InducesCycle;
2115
2116       // Otherwise we found a node that is part of our pattern.  For example in:
2117       //   x = load ptr
2118       //   y = x+4
2119       //   store y -> ptr
2120       // This would happen when we're scanning down from the load and see the
2121       // store as a user.  Record that there is a use of ChainedNode that is
2122       // part of the pattern and keep scanning uses.
2123       Result = CR_LeadsToInteriorNode;
2124       InteriorChainedNodes.push_back(User);
2125       continue;
2126     }
2127
2128     // If we found a TokenFactor, there are two cases to consider: first if the
2129     // TokenFactor is just hanging "below" the pattern we're matching (i.e. no
2130     // uses of the TF are in our pattern) we just want to ignore it.  Second,
2131     // the TokenFactor can be sandwiched in between two chained nodes, like so:
2132     //     [Load chain]
2133     //         ^
2134     //         |
2135     //       [Load]
2136     //       ^    ^
2137     //       |    \                    DAG's like cheese
2138     //      /       \                       do you?
2139     //     /         |
2140     // [TokenFactor] [Op]
2141     //     ^          ^
2142     //     |          |
2143     //      \        /
2144     //       \      /
2145     //       [Store]
2146     //
2147     // In this case, the TokenFactor becomes part of our match and we rewrite it
2148     // as a new TokenFactor.
2149     //
2150     // To distinguish these two cases, do a recursive walk down the uses.
2151     switch (WalkChainUsers(User, ChainedNodesInPattern, InteriorChainedNodes)) {
2152     case CR_Simple:
2153       // If the uses of the TokenFactor are just already-selected nodes, ignore
2154       // it, it is "below" our pattern.
2155       continue;
2156     case CR_InducesCycle:
2157       // If the uses of the TokenFactor lead to nodes that are not part of our
2158       // pattern that are not selected, folding would turn this into a cycle,
2159       // bail out now.
2160       return CR_InducesCycle;
2161     case CR_LeadsToInteriorNode:
2162       break;  // Otherwise, keep processing.
2163     }
2164
2165     // Okay, we know we're in the interesting interior case.  The TokenFactor
2166     // is now going to be considered part of the pattern so that we rewrite its
2167     // uses (it may have uses that are not part of the pattern) with the
2168     // ultimate chain result of the generated code.  We will also add its chain
2169     // inputs as inputs to the ultimate TokenFactor we create.
2170     Result = CR_LeadsToInteriorNode;
2171     ChainedNodesInPattern.push_back(User);
2172     InteriorChainedNodes.push_back(User);
2173     continue;
2174   }
2175
2176   return Result;
2177 }
2178
2179 /// HandleMergeInputChains - This implements the OPC_EmitMergeInputChains
2180 /// operation for when the pattern matched at least one node with a chains.  The
2181 /// input vector contains a list of all of the chained nodes that we match.  We
2182 /// must determine if this is a valid thing to cover (i.e. matching it won't
2183 /// induce cycles in the DAG) and if so, creating a TokenFactor node. that will
2184 /// be used as the input node chain for the generated nodes.
2185 static SDValue
2186 HandleMergeInputChains(SmallVectorImpl<SDNode*> &ChainNodesMatched,
2187                        SelectionDAG *CurDAG) {
2188   // Walk all of the chained nodes we've matched, recursively scanning down the
2189   // users of the chain result. This adds any TokenFactor nodes that are caught
2190   // in between chained nodes to the chained and interior nodes list.
2191   SmallVector<SDNode*, 3> InteriorChainedNodes;
2192   for (unsigned i = 0, e = ChainNodesMatched.size(); i != e; ++i) {
2193     if (WalkChainUsers(ChainNodesMatched[i], ChainNodesMatched,
2194                        InteriorChainedNodes) == CR_InducesCycle)
2195       return SDValue(); // Would induce a cycle.
2196   }
2197
2198   // Okay, we have walked all the matched nodes and collected TokenFactor nodes
2199   // that we are interested in.  Form our input TokenFactor node.
2200   SmallVector<SDValue, 3> InputChains;
2201   for (unsigned i = 0, e = ChainNodesMatched.size(); i != e; ++i) {
2202     // Add the input chain of this node to the InputChains list (which will be
2203     // the operands of the generated TokenFactor) if it's not an interior node.
2204     SDNode *N = ChainNodesMatched[i];
2205     if (N->getOpcode() != ISD::TokenFactor) {
2206       if (std::count(InteriorChainedNodes.begin(),InteriorChainedNodes.end(),N))
2207         continue;
2208
2209       // Otherwise, add the input chain.
2210       SDValue InChain = ChainNodesMatched[i]->getOperand(0);
2211       assert(InChain.getValueType() == MVT::Other && "Not a chain");
2212       InputChains.push_back(InChain);
2213       continue;
2214     }
2215
2216     // If we have a token factor, we want to add all inputs of the token factor
2217     // that are not part of the pattern we're matching.
2218     for (const SDValue &Op : N->op_values()) {
2219       if (!std::count(ChainNodesMatched.begin(), ChainNodesMatched.end(),
2220                       Op.getNode()))
2221         InputChains.push_back(Op);
2222     }
2223   }
2224
2225   if (InputChains.size() == 1)
2226     return InputChains[0];
2227   return CurDAG->getNode(ISD::TokenFactor, SDLoc(ChainNodesMatched[0]),
2228                          MVT::Other, InputChains);
2229 }
2230
2231 /// MorphNode - Handle morphing a node in place for the selector.
2232 SDNode *SelectionDAGISel::
2233 MorphNode(SDNode *Node, unsigned TargetOpc, SDVTList VTList,
2234           ArrayRef<SDValue> Ops, unsigned EmitNodeInfo) {
2235   // It is possible we're using MorphNodeTo to replace a node with no
2236   // normal results with one that has a normal result (or we could be
2237   // adding a chain) and the input could have glue and chains as well.
2238   // In this case we need to shift the operands down.
2239   // FIXME: This is a horrible hack and broken in obscure cases, no worse
2240   // than the old isel though.
2241   int OldGlueResultNo = -1, OldChainResultNo = -1;
2242
2243   unsigned NTMNumResults = Node->getNumValues();
2244   if (Node->getValueType(NTMNumResults-1) == MVT::Glue) {
2245     OldGlueResultNo = NTMNumResults-1;
2246     if (NTMNumResults != 1 &&
2247         Node->getValueType(NTMNumResults-2) == MVT::Other)
2248       OldChainResultNo = NTMNumResults-2;
2249   } else if (Node->getValueType(NTMNumResults-1) == MVT::Other)
2250     OldChainResultNo = NTMNumResults-1;
2251
2252   // Call the underlying SelectionDAG routine to do the transmogrification. Note
2253   // that this deletes operands of the old node that become dead.
2254   SDNode *Res = CurDAG->MorphNodeTo(Node, ~TargetOpc, VTList, Ops);
2255
2256   // MorphNodeTo can operate in two ways: if an existing node with the
2257   // specified operands exists, it can just return it.  Otherwise, it
2258   // updates the node in place to have the requested operands.
2259   if (Res == Node) {
2260     // If we updated the node in place, reset the node ID.  To the isel,
2261     // this should be just like a newly allocated machine node.
2262     Res->setNodeId(-1);
2263   }
2264
2265   unsigned ResNumResults = Res->getNumValues();
2266   // Move the glue if needed.
2267   if ((EmitNodeInfo & OPFL_GlueOutput) && OldGlueResultNo != -1 &&
2268       (unsigned)OldGlueResultNo != ResNumResults-1)
2269     CurDAG->ReplaceAllUsesOfValueWith(SDValue(Node, OldGlueResultNo),
2270                                       SDValue(Res, ResNumResults-1));
2271
2272   if ((EmitNodeInfo & OPFL_GlueOutput) != 0)
2273     --ResNumResults;
2274
2275   // Move the chain reference if needed.
2276   if ((EmitNodeInfo & OPFL_Chain) && OldChainResultNo != -1 &&
2277       (unsigned)OldChainResultNo != ResNumResults-1)
2278     CurDAG->ReplaceAllUsesOfValueWith(SDValue(Node, OldChainResultNo),
2279                                       SDValue(Res, ResNumResults-1));
2280
2281   // Otherwise, no replacement happened because the node already exists. Replace
2282   // Uses of the old node with the new one.
2283   if (Res != Node)
2284     CurDAG->ReplaceAllUsesWith(Node, Res);
2285
2286   return Res;
2287 }
2288
2289 /// CheckSame - Implements OP_CheckSame.
2290 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2291 CheckSame(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2292           SDValue N,
2293           const SmallVectorImpl<std::pair<SDValue, SDNode*> > &RecordedNodes) {
2294   // Accept if it is exactly the same as a previously recorded node.
2295   unsigned RecNo = MatcherTable[MatcherIndex++];
2296   assert(RecNo < RecordedNodes.size() && "Invalid CheckSame");
2297   return N == RecordedNodes[RecNo].first;
2298 }
2299
2300 /// CheckChildSame - Implements OP_CheckChildXSame.
2301 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2302 CheckChildSame(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2303              SDValue N,
2304              const SmallVectorImpl<std::pair<SDValue, SDNode*> > &RecordedNodes,
2305              unsigned ChildNo) {
2306   if (ChildNo >= N.getNumOperands())
2307     return false;  // Match fails if out of range child #.
2308   return ::CheckSame(MatcherTable, MatcherIndex, N.getOperand(ChildNo),
2309                      RecordedNodes);
2310 }
2311
2312 /// CheckPatternPredicate - Implements OP_CheckPatternPredicate.
2313 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2314 CheckPatternPredicate(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2315                       const SelectionDAGISel &SDISel) {
2316   return SDISel.CheckPatternPredicate(MatcherTable[MatcherIndex++]);
2317 }
2318
2319 /// CheckNodePredicate - Implements OP_CheckNodePredicate.
2320 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2321 CheckNodePredicate(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2322                    const SelectionDAGISel &SDISel, SDNode *N) {
2323   return SDISel.CheckNodePredicate(N, MatcherTable[MatcherIndex++]);
2324 }
2325
2326 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2327 CheckOpcode(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2328             SDNode *N) {
2329   uint16_t Opc = MatcherTable[MatcherIndex++];
2330   Opc |= (unsigned short)MatcherTable[MatcherIndex++] << 8;
2331   return N->getOpcode() == Opc;
2332 }
2333
2334 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2335 CheckType(const unsigned char *MatcherTable, unsigned &MatcherIndex, SDValue N,
2336           const TargetLowering *TLI, const DataLayout &DL) {
2337   MVT::SimpleValueType VT = (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
2338   if (N.getValueType() == VT) return true;
2339
2340   // Handle the case when VT is iPTR.
2341   return VT == MVT::iPTR && N.getValueType() == TLI->getPointerTy(DL);
2342 }
2343
2344 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2345 CheckChildType(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2346                SDValue N, const TargetLowering *TLI, const DataLayout &DL,
2347                unsigned ChildNo) {
2348   if (ChildNo >= N.getNumOperands())
2349     return false;  // Match fails if out of range child #.
2350   return ::CheckType(MatcherTable, MatcherIndex, N.getOperand(ChildNo), TLI,
2351                      DL);
2352 }
2353
2354 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2355 CheckCondCode(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2356               SDValue N) {
2357   return cast<CondCodeSDNode>(N)->get() ==
2358       (ISD::CondCode)MatcherTable[MatcherIndex++];
2359 }
2360
2361 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2362 CheckValueType(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2363                SDValue N, const TargetLowering *TLI, const DataLayout &DL) {
2364   MVT::SimpleValueType VT = (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
2365   if (cast<VTSDNode>(N)->getVT() == VT)
2366     return true;
2367
2368   // Handle the case when VT is iPTR.
2369   return VT == MVT::iPTR && cast<VTSDNode>(N)->getVT() == TLI->getPointerTy(DL);
2370 }
2371
2372 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2373 CheckInteger(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2374              SDValue N) {
2375   int64_t Val = MatcherTable[MatcherIndex++];
2376   if (Val & 128)
2377     Val = GetVBR(Val, MatcherTable, MatcherIndex);
2378
2379   ConstantSDNode *C = dyn_cast<ConstantSDNode>(N);
2380   return C && C->getSExtValue() == Val;
2381 }
2382
2383 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2384 CheckChildInteger(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2385                   SDValue N, unsigned ChildNo) {
2386   if (ChildNo >= N.getNumOperands())
2387     return false;  // Match fails if out of range child #.
2388   return ::CheckInteger(MatcherTable, MatcherIndex, N.getOperand(ChildNo));
2389 }
2390
2391 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2392 CheckAndImm(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2393             SDValue N, const SelectionDAGISel &SDISel) {
2394   int64_t Val = MatcherTable[MatcherIndex++];
2395   if (Val & 128)
2396     Val = GetVBR(Val, MatcherTable, MatcherIndex);
2397
2398   if (N->getOpcode() != ISD::AND) return false;
2399
2400   ConstantSDNode *C = dyn_cast<ConstantSDNode>(N->getOperand(1));
2401   return C && SDISel.CheckAndMask(N.getOperand(0), C, Val);
2402 }
2403
2404 LLVM_ATTRIBUTE_ALWAYS_INLINE static inline bool
2405 CheckOrImm(const unsigned char *MatcherTable, unsigned &MatcherIndex,
2406            SDValue N, const SelectionDAGISel &SDISel) {
2407   int64_t Val = MatcherTable[MatcherIndex++];
2408   if (Val & 128)
2409     Val = GetVBR(Val, MatcherTable, MatcherIndex);
2410
2411   if (N->getOpcode() != ISD::OR) return false;
2412
2413   ConstantSDNode *C = dyn_cast<ConstantSDNode>(N->getOperand(1));
2414   return C && SDISel.CheckOrMask(N.getOperand(0), C, Val);
2415 }
2416
2417 /// IsPredicateKnownToFail - If we know how and can do so without pushing a
2418 /// scope, evaluate the current node.  If the current predicate is known to
2419 /// fail, set Result=true and return anything.  If the current predicate is
2420 /// known to pass, set Result=false and return the MatcherIndex to continue
2421 /// with.  If the current predicate is unknown, set Result=false and return the
2422 /// MatcherIndex to continue with.
2423 static unsigned IsPredicateKnownToFail(const unsigned char *Table,
2424                                        unsigned Index, SDValue N,
2425                                        bool &Result,
2426                                        const SelectionDAGISel &SDISel,
2427                  SmallVectorImpl<std::pair<SDValue, SDNode*> > &RecordedNodes) {
2428   switch (Table[Index++]) {
2429   default:
2430     Result = false;
2431     return Index-1;  // Could not evaluate this predicate.
2432   case SelectionDAGISel::OPC_CheckSame:
2433     Result = !::CheckSame(Table, Index, N, RecordedNodes);
2434     return Index;
2435   case SelectionDAGISel::OPC_CheckChild0Same:
2436   case SelectionDAGISel::OPC_CheckChild1Same:
2437   case SelectionDAGISel::OPC_CheckChild2Same:
2438   case SelectionDAGISel::OPC_CheckChild3Same:
2439     Result = !::CheckChildSame(Table, Index, N, RecordedNodes,
2440                         Table[Index-1] - SelectionDAGISel::OPC_CheckChild0Same);
2441     return Index;
2442   case SelectionDAGISel::OPC_CheckPatternPredicate:
2443     Result = !::CheckPatternPredicate(Table, Index, SDISel);
2444     return Index;
2445   case SelectionDAGISel::OPC_CheckPredicate:
2446     Result = !::CheckNodePredicate(Table, Index, SDISel, N.getNode());
2447     return Index;
2448   case SelectionDAGISel::OPC_CheckOpcode:
2449     Result = !::CheckOpcode(Table, Index, N.getNode());
2450     return Index;
2451   case SelectionDAGISel::OPC_CheckType:
2452     Result = !::CheckType(Table, Index, N, SDISel.TLI,
2453                           SDISel.CurDAG->getDataLayout());
2454     return Index;
2455   case SelectionDAGISel::OPC_CheckChild0Type:
2456   case SelectionDAGISel::OPC_CheckChild1Type:
2457   case SelectionDAGISel::OPC_CheckChild2Type:
2458   case SelectionDAGISel::OPC_CheckChild3Type:
2459   case SelectionDAGISel::OPC_CheckChild4Type:
2460   case SelectionDAGISel::OPC_CheckChild5Type:
2461   case SelectionDAGISel::OPC_CheckChild6Type:
2462   case SelectionDAGISel::OPC_CheckChild7Type:
2463     Result = !::CheckChildType(
2464                  Table, Index, N, SDISel.TLI, SDISel.CurDAG->getDataLayout(),
2465                  Table[Index - 1] - SelectionDAGISel::OPC_CheckChild0Type);
2466     return Index;
2467   case SelectionDAGISel::OPC_CheckCondCode:
2468     Result = !::CheckCondCode(Table, Index, N);
2469     return Index;
2470   case SelectionDAGISel::OPC_CheckValueType:
2471     Result = !::CheckValueType(Table, Index, N, SDISel.TLI,
2472                                SDISel.CurDAG->getDataLayout());
2473     return Index;
2474   case SelectionDAGISel::OPC_CheckInteger:
2475     Result = !::CheckInteger(Table, Index, N);
2476     return Index;
2477   case SelectionDAGISel::OPC_CheckChild0Integer:
2478   case SelectionDAGISel::OPC_CheckChild1Integer:
2479   case SelectionDAGISel::OPC_CheckChild2Integer:
2480   case SelectionDAGISel::OPC_CheckChild3Integer:
2481   case SelectionDAGISel::OPC_CheckChild4Integer:
2482     Result = !::CheckChildInteger(Table, Index, N,
2483                      Table[Index-1] - SelectionDAGISel::OPC_CheckChild0Integer);
2484     return Index;
2485   case SelectionDAGISel::OPC_CheckAndImm:
2486     Result = !::CheckAndImm(Table, Index, N, SDISel);
2487     return Index;
2488   case SelectionDAGISel::OPC_CheckOrImm:
2489     Result = !::CheckOrImm(Table, Index, N, SDISel);
2490     return Index;
2491   }
2492 }
2493
2494 namespace {
2495
2496 struct MatchScope {
2497   /// FailIndex - If this match fails, this is the index to continue with.
2498   unsigned FailIndex;
2499
2500   /// NodeStack - The node stack when the scope was formed.
2501   SmallVector<SDValue, 4> NodeStack;
2502
2503   /// NumRecordedNodes - The number of recorded nodes when the scope was formed.
2504   unsigned NumRecordedNodes;
2505
2506   /// NumMatchedMemRefs - The number of matched memref entries.
2507   unsigned NumMatchedMemRefs;
2508
2509   /// InputChain/InputGlue - The current chain/glue
2510   SDValue InputChain, InputGlue;
2511
2512   /// HasChainNodesMatched - True if the ChainNodesMatched list is non-empty.
2513   bool HasChainNodesMatched, HasGlueResultNodesMatched;
2514 };
2515
2516 /// \\brief A DAG update listener to keep the matching state
2517 /// (i.e. RecordedNodes and MatchScope) uptodate if the target is allowed to
2518 /// change the DAG while matching.  X86 addressing mode matcher is an example
2519 /// for this.
2520 class MatchStateUpdater : public SelectionDAG::DAGUpdateListener
2521 {
2522       SmallVectorImpl<std::pair<SDValue, SDNode*> > &RecordedNodes;
2523       SmallVectorImpl<MatchScope> &MatchScopes;
2524 public:
2525   MatchStateUpdater(SelectionDAG &DAG,
2526                     SmallVectorImpl<std::pair<SDValue, SDNode*> > &RN,
2527                     SmallVectorImpl<MatchScope> &MS) :
2528     SelectionDAG::DAGUpdateListener(DAG),
2529     RecordedNodes(RN), MatchScopes(MS) { }
2530
2531   void NodeDeleted(SDNode *N, SDNode *E) override {
2532     // Some early-returns here to avoid the search if we deleted the node or
2533     // if the update comes from MorphNodeTo (MorphNodeTo is the last thing we
2534     // do, so it's unnecessary to update matching state at that point).
2535     // Neither of these can occur currently because we only install this
2536     // update listener during matching a complex patterns.
2537     if (!E || E->isMachineOpcode())
2538       return;
2539     // Performing linear search here does not matter because we almost never
2540     // run this code.  You'd have to have a CSE during complex pattern
2541     // matching.
2542     for (auto &I : RecordedNodes)
2543       if (I.first.getNode() == N)
2544         I.first.setNode(E);
2545
2546     for (auto &I : MatchScopes)
2547       for (auto &J : I.NodeStack)
2548         if (J.getNode() == N)
2549           J.setNode(E);
2550   }
2551 };
2552 }
2553
2554 SDNode *SelectionDAGISel::
2555 SelectCodeCommon(SDNode *NodeToMatch, const unsigned char *MatcherTable,
2556                  unsigned TableSize) {
2557   // FIXME: Should these even be selected?  Handle these cases in the caller?
2558   switch (NodeToMatch->getOpcode()) {
2559   default:
2560     break;
2561   case ISD::EntryToken:       // These nodes remain the same.
2562   case ISD::BasicBlock:
2563   case ISD::Register:
2564   case ISD::RegisterMask:
2565   case ISD::HANDLENODE:
2566   case ISD::MDNODE_SDNODE:
2567   case ISD::TargetConstant:
2568   case ISD::TargetConstantFP:
2569   case ISD::TargetConstantPool:
2570   case ISD::TargetFrameIndex:
2571   case ISD::TargetExternalSymbol:
2572   case ISD::MCSymbol:
2573   case ISD::TargetBlockAddress:
2574   case ISD::TargetJumpTable:
2575   case ISD::TargetGlobalTLSAddress:
2576   case ISD::TargetGlobalAddress:
2577   case ISD::TokenFactor:
2578   case ISD::CopyFromReg:
2579   case ISD::CopyToReg:
2580   case ISD::EH_LABEL:
2581   case ISD::LIFETIME_START:
2582   case ISD::LIFETIME_END:
2583     NodeToMatch->setNodeId(-1); // Mark selected.
2584     return nullptr;
2585   case ISD::AssertSext:
2586   case ISD::AssertZext:
2587     CurDAG->ReplaceAllUsesOfValueWith(SDValue(NodeToMatch, 0),
2588                                       NodeToMatch->getOperand(0));
2589     return nullptr;
2590   case ISD::INLINEASM: return Select_INLINEASM(NodeToMatch);
2591   case ISD::READ_REGISTER: return Select_READ_REGISTER(NodeToMatch);
2592   case ISD::WRITE_REGISTER: return Select_WRITE_REGISTER(NodeToMatch);
2593   case ISD::UNDEF:     return Select_UNDEF(NodeToMatch);
2594   }
2595
2596   assert(!NodeToMatch->isMachineOpcode() && "Node already selected!");
2597
2598   // Set up the node stack with NodeToMatch as the only node on the stack.
2599   SmallVector<SDValue, 8> NodeStack;
2600   SDValue N = SDValue(NodeToMatch, 0);
2601   NodeStack.push_back(N);
2602
2603   // MatchScopes - Scopes used when matching, if a match failure happens, this
2604   // indicates where to continue checking.
2605   SmallVector<MatchScope, 8> MatchScopes;
2606
2607   // RecordedNodes - This is the set of nodes that have been recorded by the
2608   // state machine.  The second value is the parent of the node, or null if the
2609   // root is recorded.
2610   SmallVector<std::pair<SDValue, SDNode*>, 8> RecordedNodes;
2611
2612   // MatchedMemRefs - This is the set of MemRef's we've seen in the input
2613   // pattern.
2614   SmallVector<MachineMemOperand*, 2> MatchedMemRefs;
2615
2616   // These are the current input chain and glue for use when generating nodes.
2617   // Various Emit operations change these.  For example, emitting a copytoreg
2618   // uses and updates these.
2619   SDValue InputChain, InputGlue;
2620
2621   // ChainNodesMatched - If a pattern matches nodes that have input/output
2622   // chains, the OPC_EmitMergeInputChains operation is emitted which indicates
2623   // which ones they are.  The result is captured into this list so that we can
2624   // update the chain results when the pattern is complete.
2625   SmallVector<SDNode*, 3> ChainNodesMatched;
2626   SmallVector<SDNode*, 3> GlueResultNodesMatched;
2627
2628   DEBUG(dbgs() << "ISEL: Starting pattern match on root node: ";
2629         NodeToMatch->dump(CurDAG);
2630         dbgs() << '\n');
2631
2632   // Determine where to start the interpreter.  Normally we start at opcode #0,
2633   // but if the state machine starts with an OPC_SwitchOpcode, then we
2634   // accelerate the first lookup (which is guaranteed to be hot) with the
2635   // OpcodeOffset table.
2636   unsigned MatcherIndex = 0;
2637
2638   if (!OpcodeOffset.empty()) {
2639     // Already computed the OpcodeOffset table, just index into it.
2640     if (N.getOpcode() < OpcodeOffset.size())
2641       MatcherIndex = OpcodeOffset[N.getOpcode()];
2642     DEBUG(dbgs() << "  Initial Opcode index to " << MatcherIndex << "\n");
2643
2644   } else if (MatcherTable[0] == OPC_SwitchOpcode) {
2645     // Otherwise, the table isn't computed, but the state machine does start
2646     // with an OPC_SwitchOpcode instruction.  Populate the table now, since this
2647     // is the first time we're selecting an instruction.
2648     unsigned Idx = 1;
2649     while (1) {
2650       // Get the size of this case.
2651       unsigned CaseSize = MatcherTable[Idx++];
2652       if (CaseSize & 128)
2653         CaseSize = GetVBR(CaseSize, MatcherTable, Idx);
2654       if (CaseSize == 0) break;
2655
2656       // Get the opcode, add the index to the table.
2657       uint16_t Opc = MatcherTable[Idx++];
2658       Opc |= (unsigned short)MatcherTable[Idx++] << 8;
2659       if (Opc >= OpcodeOffset.size())
2660         OpcodeOffset.resize((Opc+1)*2);
2661       OpcodeOffset[Opc] = Idx;
2662       Idx += CaseSize;
2663     }
2664
2665     // Okay, do the lookup for the first opcode.
2666     if (N.getOpcode() < OpcodeOffset.size())
2667       MatcherIndex = OpcodeOffset[N.getOpcode()];
2668   }
2669
2670   while (1) {
2671     assert(MatcherIndex < TableSize && "Invalid index");
2672 #ifndef NDEBUG
2673     unsigned CurrentOpcodeIndex = MatcherIndex;
2674 #endif
2675     BuiltinOpcodes Opcode = (BuiltinOpcodes)MatcherTable[MatcherIndex++];
2676     switch (Opcode) {
2677     case OPC_Scope: {
2678       // Okay, the semantics of this operation are that we should push a scope
2679       // then evaluate the first child.  However, pushing a scope only to have
2680       // the first check fail (which then pops it) is inefficient.  If we can
2681       // determine immediately that the first check (or first several) will
2682       // immediately fail, don't even bother pushing a scope for them.
2683       unsigned FailIndex;
2684
2685       while (1) {
2686         unsigned NumToSkip = MatcherTable[MatcherIndex++];
2687         if (NumToSkip & 128)
2688           NumToSkip = GetVBR(NumToSkip, MatcherTable, MatcherIndex);
2689         // Found the end of the scope with no match.
2690         if (NumToSkip == 0) {
2691           FailIndex = 0;
2692           break;
2693         }
2694
2695         FailIndex = MatcherIndex+NumToSkip;
2696
2697         unsigned MatcherIndexOfPredicate = MatcherIndex;
2698         (void)MatcherIndexOfPredicate; // silence warning.
2699
2700         // If we can't evaluate this predicate without pushing a scope (e.g. if
2701         // it is a 'MoveParent') or if the predicate succeeds on this node, we
2702         // push the scope and evaluate the full predicate chain.
2703         bool Result;
2704         MatcherIndex = IsPredicateKnownToFail(MatcherTable, MatcherIndex, N,
2705                                               Result, *this, RecordedNodes);
2706         if (!Result)
2707           break;
2708
2709         DEBUG(dbgs() << "  Skipped scope entry (due to false predicate) at "
2710                      << "index " << MatcherIndexOfPredicate
2711                      << ", continuing at " << FailIndex << "\n");
2712         ++NumDAGIselRetries;
2713
2714         // Otherwise, we know that this case of the Scope is guaranteed to fail,
2715         // move to the next case.
2716         MatcherIndex = FailIndex;
2717       }
2718
2719       // If the whole scope failed to match, bail.
2720       if (FailIndex == 0) break;
2721
2722       // Push a MatchScope which indicates where to go if the first child fails
2723       // to match.
2724       MatchScope NewEntry;
2725       NewEntry.FailIndex = FailIndex;
2726       NewEntry.NodeStack.append(NodeStack.begin(), NodeStack.end());
2727       NewEntry.NumRecordedNodes = RecordedNodes.size();
2728       NewEntry.NumMatchedMemRefs = MatchedMemRefs.size();
2729       NewEntry.InputChain = InputChain;
2730       NewEntry.InputGlue = InputGlue;
2731       NewEntry.HasChainNodesMatched = !ChainNodesMatched.empty();
2732       NewEntry.HasGlueResultNodesMatched = !GlueResultNodesMatched.empty();
2733       MatchScopes.push_back(NewEntry);
2734       continue;
2735     }
2736     case OPC_RecordNode: {
2737       // Remember this node, it may end up being an operand in the pattern.
2738       SDNode *Parent = nullptr;
2739       if (NodeStack.size() > 1)
2740         Parent = NodeStack[NodeStack.size()-2].getNode();
2741       RecordedNodes.push_back(std::make_pair(N, Parent));
2742       continue;
2743     }
2744
2745     case OPC_RecordChild0: case OPC_RecordChild1:
2746     case OPC_RecordChild2: case OPC_RecordChild3:
2747     case OPC_RecordChild4: case OPC_RecordChild5:
2748     case OPC_RecordChild6: case OPC_RecordChild7: {
2749       unsigned ChildNo = Opcode-OPC_RecordChild0;
2750       if (ChildNo >= N.getNumOperands())
2751         break;  // Match fails if out of range child #.
2752
2753       RecordedNodes.push_back(std::make_pair(N->getOperand(ChildNo),
2754                                              N.getNode()));
2755       continue;
2756     }
2757     case OPC_RecordMemRef:
2758       MatchedMemRefs.push_back(cast<MemSDNode>(N)->getMemOperand());
2759       continue;
2760
2761     case OPC_CaptureGlueInput:
2762       // If the current node has an input glue, capture it in InputGlue.
2763       if (N->getNumOperands() != 0 &&
2764           N->getOperand(N->getNumOperands()-1).getValueType() == MVT::Glue)
2765         InputGlue = N->getOperand(N->getNumOperands()-1);
2766       continue;
2767
2768     case OPC_MoveChild: {
2769       unsigned ChildNo = MatcherTable[MatcherIndex++];
2770       if (ChildNo >= N.getNumOperands())
2771         break;  // Match fails if out of range child #.
2772       N = N.getOperand(ChildNo);
2773       NodeStack.push_back(N);
2774       continue;
2775     }
2776
2777     case OPC_MoveParent:
2778       // Pop the current node off the NodeStack.
2779       NodeStack.pop_back();
2780       assert(!NodeStack.empty() && "Node stack imbalance!");
2781       N = NodeStack.back();
2782       continue;
2783
2784     case OPC_CheckSame:
2785       if (!::CheckSame(MatcherTable, MatcherIndex, N, RecordedNodes)) break;
2786       continue;
2787
2788     case OPC_CheckChild0Same: case OPC_CheckChild1Same:
2789     case OPC_CheckChild2Same: case OPC_CheckChild3Same:
2790       if (!::CheckChildSame(MatcherTable, MatcherIndex, N, RecordedNodes,
2791                             Opcode-OPC_CheckChild0Same))
2792         break;
2793       continue;
2794
2795     case OPC_CheckPatternPredicate:
2796       if (!::CheckPatternPredicate(MatcherTable, MatcherIndex, *this)) break;
2797       continue;
2798     case OPC_CheckPredicate:
2799       if (!::CheckNodePredicate(MatcherTable, MatcherIndex, *this,
2800                                 N.getNode()))
2801         break;
2802       continue;
2803     case OPC_CheckComplexPat: {
2804       unsigned CPNum = MatcherTable[MatcherIndex++];
2805       unsigned RecNo = MatcherTable[MatcherIndex++];
2806       assert(RecNo < RecordedNodes.size() && "Invalid CheckComplexPat");
2807
2808       // If target can modify DAG during matching, keep the matching state
2809       // consistent.
2810       std::unique_ptr<MatchStateUpdater> MSU;
2811       if (ComplexPatternFuncMutatesDAG())
2812         MSU.reset(new MatchStateUpdater(*CurDAG, RecordedNodes,
2813                                         MatchScopes));
2814
2815       if (!CheckComplexPattern(NodeToMatch, RecordedNodes[RecNo].second,
2816                                RecordedNodes[RecNo].first, CPNum,
2817                                RecordedNodes))
2818         break;
2819       continue;
2820     }
2821     case OPC_CheckOpcode:
2822       if (!::CheckOpcode(MatcherTable, MatcherIndex, N.getNode())) break;
2823       continue;
2824
2825     case OPC_CheckType:
2826       if (!::CheckType(MatcherTable, MatcherIndex, N, TLI,
2827                        CurDAG->getDataLayout()))
2828         break;
2829       continue;
2830
2831     case OPC_SwitchOpcode: {
2832       unsigned CurNodeOpcode = N.getOpcode();
2833       unsigned SwitchStart = MatcherIndex-1; (void)SwitchStart;
2834       unsigned CaseSize;
2835       while (1) {
2836         // Get the size of this case.
2837         CaseSize = MatcherTable[MatcherIndex++];
2838         if (CaseSize & 128)
2839           CaseSize = GetVBR(CaseSize, MatcherTable, MatcherIndex);
2840         if (CaseSize == 0) break;
2841
2842         uint16_t Opc = MatcherTable[MatcherIndex++];
2843         Opc |= (unsigned short)MatcherTable[MatcherIndex++] << 8;
2844
2845         // If the opcode matches, then we will execute this case.
2846         if (CurNodeOpcode == Opc)
2847           break;
2848
2849         // Otherwise, skip over this case.
2850         MatcherIndex += CaseSize;
2851       }
2852
2853       // If no cases matched, bail out.
2854       if (CaseSize == 0) break;
2855
2856       // Otherwise, execute the case we found.
2857       DEBUG(dbgs() << "  OpcodeSwitch from " << SwitchStart
2858                    << " to " << MatcherIndex << "\n");
2859       continue;
2860     }
2861
2862     case OPC_SwitchType: {
2863       MVT CurNodeVT = N.getSimpleValueType();
2864       unsigned SwitchStart = MatcherIndex-1; (void)SwitchStart;
2865       unsigned CaseSize;
2866       while (1) {
2867         // Get the size of this case.
2868         CaseSize = MatcherTable[MatcherIndex++];
2869         if (CaseSize & 128)
2870           CaseSize = GetVBR(CaseSize, MatcherTable, MatcherIndex);
2871         if (CaseSize == 0) break;
2872
2873         MVT CaseVT = (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
2874         if (CaseVT == MVT::iPTR)
2875           CaseVT = TLI->getPointerTy(CurDAG->getDataLayout());
2876
2877         // If the VT matches, then we will execute this case.
2878         if (CurNodeVT == CaseVT)
2879           break;
2880
2881         // Otherwise, skip over this case.
2882         MatcherIndex += CaseSize;
2883       }
2884
2885       // If no cases matched, bail out.
2886       if (CaseSize == 0) break;
2887
2888       // Otherwise, execute the case we found.
2889       DEBUG(dbgs() << "  TypeSwitch[" << EVT(CurNodeVT).getEVTString()
2890                    << "] from " << SwitchStart << " to " << MatcherIndex<<'\n');
2891       continue;
2892     }
2893     case OPC_CheckChild0Type: case OPC_CheckChild1Type:
2894     case OPC_CheckChild2Type: case OPC_CheckChild3Type:
2895     case OPC_CheckChild4Type: case OPC_CheckChild5Type:
2896     case OPC_CheckChild6Type: case OPC_CheckChild7Type:
2897       if (!::CheckChildType(MatcherTable, MatcherIndex, N, TLI,
2898                             CurDAG->getDataLayout(),
2899                             Opcode - OPC_CheckChild0Type))
2900         break;
2901       continue;
2902     case OPC_CheckCondCode:
2903       if (!::CheckCondCode(MatcherTable, MatcherIndex, N)) break;
2904       continue;
2905     case OPC_CheckValueType:
2906       if (!::CheckValueType(MatcherTable, MatcherIndex, N, TLI,
2907                             CurDAG->getDataLayout()))
2908         break;
2909       continue;
2910     case OPC_CheckInteger:
2911       if (!::CheckInteger(MatcherTable, MatcherIndex, N)) break;
2912       continue;
2913     case OPC_CheckChild0Integer: case OPC_CheckChild1Integer:
2914     case OPC_CheckChild2Integer: case OPC_CheckChild3Integer:
2915     case OPC_CheckChild4Integer:
2916       if (!::CheckChildInteger(MatcherTable, MatcherIndex, N,
2917                                Opcode-OPC_CheckChild0Integer)) break;
2918       continue;
2919     case OPC_CheckAndImm:
2920       if (!::CheckAndImm(MatcherTable, MatcherIndex, N, *this)) break;
2921       continue;
2922     case OPC_CheckOrImm:
2923       if (!::CheckOrImm(MatcherTable, MatcherIndex, N, *this)) break;
2924       continue;
2925
2926     case OPC_CheckFoldableChainNode: {
2927       assert(NodeStack.size() != 1 && "No parent node");
2928       // Verify that all intermediate nodes between the root and this one have
2929       // a single use.
2930       bool HasMultipleUses = false;
2931       for (unsigned i = 1, e = NodeStack.size()-1; i != e; ++i)
2932         if (!NodeStack[i].hasOneUse()) {
2933           HasMultipleUses = true;
2934           break;
2935         }
2936       if (HasMultipleUses) break;
2937
2938       // Check to see that the target thinks this is profitable to fold and that
2939       // we can fold it without inducing cycles in the graph.
2940       if (!IsProfitableToFold(N, NodeStack[NodeStack.size()-2].getNode(),
2941                               NodeToMatch) ||
2942           !IsLegalToFold(N, NodeStack[NodeStack.size()-2].getNode(),
2943                          NodeToMatch, OptLevel,
2944                          true/*We validate our own chains*/))
2945         break;
2946
2947       continue;
2948     }
2949     case OPC_EmitInteger: {
2950       MVT::SimpleValueType VT =
2951         (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
2952       int64_t Val = MatcherTable[MatcherIndex++];
2953       if (Val & 128)
2954         Val = GetVBR(Val, MatcherTable, MatcherIndex);
2955       RecordedNodes.push_back(std::pair<SDValue, SDNode*>(
2956                               CurDAG->getTargetConstant(Val, SDLoc(NodeToMatch),
2957                                                         VT), nullptr));
2958       continue;
2959     }
2960     case OPC_EmitRegister: {
2961       MVT::SimpleValueType VT =
2962         (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
2963       unsigned RegNo = MatcherTable[MatcherIndex++];
2964       RecordedNodes.push_back(std::pair<SDValue, SDNode*>(
2965                               CurDAG->getRegister(RegNo, VT), nullptr));
2966       continue;
2967     }
2968     case OPC_EmitRegister2: {
2969       // For targets w/ more than 256 register names, the register enum
2970       // values are stored in two bytes in the matcher table (just like
2971       // opcodes).
2972       MVT::SimpleValueType VT =
2973         (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
2974       unsigned RegNo = MatcherTable[MatcherIndex++];
2975       RegNo |= MatcherTable[MatcherIndex++] << 8;
2976       RecordedNodes.push_back(std::pair<SDValue, SDNode*>(
2977                               CurDAG->getRegister(RegNo, VT), nullptr));
2978       continue;
2979     }
2980
2981     case OPC_EmitConvertToTarget:  {
2982       // Convert from IMM/FPIMM to target version.
2983       unsigned RecNo = MatcherTable[MatcherIndex++];
2984       assert(RecNo < RecordedNodes.size() && "Invalid EmitConvertToTarget");
2985       SDValue Imm = RecordedNodes[RecNo].first;
2986
2987       if (Imm->getOpcode() == ISD::Constant) {
2988         const ConstantInt *Val=cast<ConstantSDNode>(Imm)->getConstantIntValue();
2989         Imm = CurDAG->getConstant(*Val, SDLoc(NodeToMatch), Imm.getValueType(),
2990                                   true);
2991       } else if (Imm->getOpcode() == ISD::ConstantFP) {
2992         const ConstantFP *Val=cast<ConstantFPSDNode>(Imm)->getConstantFPValue();
2993         Imm = CurDAG->getConstantFP(*Val, SDLoc(NodeToMatch),
2994                                     Imm.getValueType(), true);
2995       }
2996
2997       RecordedNodes.push_back(std::make_pair(Imm, RecordedNodes[RecNo].second));
2998       continue;
2999     }
3000
3001     case OPC_EmitMergeInputChains1_0:    // OPC_EmitMergeInputChains, 1, 0
3002     case OPC_EmitMergeInputChains1_1: {  // OPC_EmitMergeInputChains, 1, 1
3003       // These are space-optimized forms of OPC_EmitMergeInputChains.
3004       assert(!InputChain.getNode() &&
3005              "EmitMergeInputChains should be the first chain producing node");
3006       assert(ChainNodesMatched.empty() &&
3007              "Should only have one EmitMergeInputChains per match");
3008
3009       // Read all of the chained nodes.
3010       unsigned RecNo = Opcode == OPC_EmitMergeInputChains1_1;
3011       assert(RecNo < RecordedNodes.size() && "Invalid EmitMergeInputChains");
3012       ChainNodesMatched.push_back(RecordedNodes[RecNo].first.getNode());
3013
3014       // FIXME: What if other value results of the node have uses not matched
3015       // by this pattern?
3016       if (ChainNodesMatched.back() != NodeToMatch &&
3017           !RecordedNodes[RecNo].first.hasOneUse()) {
3018         ChainNodesMatched.clear();
3019         break;
3020       }
3021
3022       // Merge the input chains if they are not intra-pattern references.
3023       InputChain = HandleMergeInputChains(ChainNodesMatched, CurDAG);
3024
3025       if (!InputChain.getNode())
3026         break;  // Failed to merge.
3027       continue;
3028     }
3029
3030     case OPC_EmitMergeInputChains: {
3031       assert(!InputChain.getNode() &&
3032              "EmitMergeInputChains should be the first chain producing node");
3033       // This node gets a list of nodes we matched in the input that have
3034       // chains.  We want to token factor all of the input chains to these nodes
3035       // together.  However, if any of the input chains is actually one of the
3036       // nodes matched in this pattern, then we have an intra-match reference.
3037       // Ignore these because the newly token factored chain should not refer to
3038       // the old nodes.
3039       unsigned NumChains = MatcherTable[MatcherIndex++];
3040       assert(NumChains != 0 && "Can't TF zero chains");
3041
3042       assert(ChainNodesMatched.empty() &&
3043              "Should only have one EmitMergeInputChains per match");
3044
3045       // Read all of the chained nodes.
3046       for (unsigned i = 0; i != NumChains; ++i) {
3047         unsigned RecNo = MatcherTable[MatcherIndex++];
3048         assert(RecNo < RecordedNodes.size() && "Invalid EmitMergeInputChains");
3049         ChainNodesMatched.push_back(RecordedNodes[RecNo].first.getNode());
3050
3051         // FIXME: What if other value results of the node have uses not matched
3052         // by this pattern?
3053         if (ChainNodesMatched.back() != NodeToMatch &&
3054             !RecordedNodes[RecNo].first.hasOneUse()) {
3055           ChainNodesMatched.clear();
3056           break;
3057         }
3058       }
3059
3060       // If the inner loop broke out, the match fails.
3061       if (ChainNodesMatched.empty())
3062         break;
3063
3064       // Merge the input chains if they are not intra-pattern references.
3065       InputChain = HandleMergeInputChains(ChainNodesMatched, CurDAG);
3066
3067       if (!InputChain.getNode())
3068         break;  // Failed to merge.
3069
3070       continue;
3071     }
3072
3073     case OPC_EmitCopyToReg: {
3074       unsigned RecNo = MatcherTable[MatcherIndex++];
3075       assert(RecNo < RecordedNodes.size() && "Invalid EmitCopyToReg");
3076       unsigned DestPhysReg = MatcherTable[MatcherIndex++];
3077
3078       if (!InputChain.getNode())
3079         InputChain = CurDAG->getEntryNode();
3080
3081       InputChain = CurDAG->getCopyToReg(InputChain, SDLoc(NodeToMatch),
3082                                         DestPhysReg, RecordedNodes[RecNo].first,
3083                                         InputGlue);
3084
3085       InputGlue = InputChain.getValue(1);
3086       continue;
3087     }
3088
3089     case OPC_EmitNodeXForm: {
3090       unsigned XFormNo = MatcherTable[MatcherIndex++];
3091       unsigned RecNo = MatcherTable[MatcherIndex++];
3092       assert(RecNo < RecordedNodes.size() && "Invalid EmitNodeXForm");
3093       SDValue Res = RunSDNodeXForm(RecordedNodes[RecNo].first, XFormNo);
3094       RecordedNodes.push_back(std::pair<SDValue,SDNode*>(Res, nullptr));
3095       continue;
3096     }
3097
3098     case OPC_EmitNode:
3099     case OPC_MorphNodeTo: {
3100       uint16_t TargetOpc = MatcherTable[MatcherIndex++];
3101       TargetOpc |= (unsigned short)MatcherTable[MatcherIndex++] << 8;
3102       unsigned EmitNodeInfo = MatcherTable[MatcherIndex++];
3103       // Get the result VT list.
3104       unsigned NumVTs = MatcherTable[MatcherIndex++];
3105       SmallVector<EVT, 4> VTs;
3106       for (unsigned i = 0; i != NumVTs; ++i) {
3107         MVT::SimpleValueType VT =
3108           (MVT::SimpleValueType)MatcherTable[MatcherIndex++];
3109         if (VT == MVT::iPTR)
3110           VT = TLI->getPointerTy(CurDAG->getDataLayout()).SimpleTy;
3111         VTs.push_back(VT);
3112       }
3113
3114       if (EmitNodeInfo & OPFL_Chain)
3115         VTs.push_back(MVT::Other);
3116       if (EmitNodeInfo & OPFL_GlueOutput)
3117         VTs.push_back(MVT::Glue);
3118
3119       // This is hot code, so optimize the two most common cases of 1 and 2
3120       // results.
3121       SDVTList VTList;
3122       if (VTs.size() == 1)
3123         VTList = CurDAG->getVTList(VTs[0]);
3124       else if (VTs.size() == 2)
3125         VTList = CurDAG->getVTList(VTs[0], VTs[1]);
3126       else
3127         VTList = CurDAG->getVTList(VTs);
3128
3129       // Get the operand list.
3130       unsigned NumOps = MatcherTable[MatcherIndex++];
3131       SmallVector<SDValue, 8> Ops;
3132       for (unsigned i = 0; i != NumOps; ++i) {
3133         unsigned RecNo = MatcherTable[MatcherIndex++];
3134         if (RecNo & 128)
3135           RecNo = GetVBR(RecNo, MatcherTable, MatcherIndex);
3136
3137         assert(RecNo < RecordedNodes.size() && "Invalid EmitNode");
3138         Ops.push_back(RecordedNodes[RecNo].first);
3139       }
3140
3141       // If there are variadic operands to add, handle them now.
3142       if (EmitNodeInfo & OPFL_VariadicInfo) {
3143         // Determine the start index to copy from.
3144         unsigned FirstOpToCopy = getNumFixedFromVariadicInfo(EmitNodeInfo);
3145         FirstOpToCopy += (EmitNodeInfo & OPFL_Chain) ? 1 : 0;
3146         assert(NodeToMatch->getNumOperands() >= FirstOpToCopy &&
3147                "Invalid variadic node");
3148         // Copy all of the variadic operands, not including a potential glue
3149         // input.
3150         for (unsigned i = FirstOpToCopy, e = NodeToMatch->getNumOperands();
3151              i != e; ++i) {
3152           SDValue V = NodeToMatch->getOperand(i);
3153           if (V.getValueType() == MVT::Glue) break;
3154           Ops.push_back(V);
3155         }
3156       }
3157
3158       // If this has chain/glue inputs, add them.
3159       if (EmitNodeInfo & OPFL_Chain)
3160         Ops.push_back(InputChain);
3161       if ((EmitNodeInfo & OPFL_GlueInput) && InputGlue.getNode() != nullptr)
3162         Ops.push_back(InputGlue);
3163
3164       // Create the node.
3165       SDNode *Res = nullptr;
3166       if (Opcode != OPC_MorphNodeTo) {
3167         // If this is a normal EmitNode command, just create the new node and
3168         // add the results to the RecordedNodes list.
3169         Res = CurDAG->getMachineNode(TargetOpc, SDLoc(NodeToMatch),
3170                                      VTList, Ops);
3171
3172         // Add all the non-glue/non-chain results to the RecordedNodes list.
3173         for (unsigned i = 0, e = VTs.size(); i != e; ++i) {
3174           if (VTs[i] == MVT::Other || VTs[i] == MVT::Glue) break;
3175           RecordedNodes.push_back(std::pair<SDValue,SDNode*>(SDValue(Res, i),
3176                                                              nullptr));
3177         }
3178
3179       } else if (NodeToMatch->getOpcode() != ISD::DELETED_NODE) {
3180         Res = MorphNode(NodeToMatch, TargetOpc, VTList, Ops, EmitNodeInfo);
3181       } else {
3182         // NodeToMatch was eliminated by CSE when the target changed the DAG.
3183         // We will visit the equivalent node later.
3184         DEBUG(dbgs() << "Node was eliminated by CSE\n");
3185         return nullptr;
3186       }
3187
3188       // If the node had chain/glue results, update our notion of the current
3189       // chain and glue.
3190       if (EmitNodeInfo & OPFL_GlueOutput) {
3191         InputGlue = SDValue(Res, VTs.size()-1);
3192         if (EmitNodeInfo & OPFL_Chain)
3193           InputChain = SDValue(Res, VTs.size()-2);
3194       } else if (EmitNodeInfo & OPFL_Chain)
3195         InputChain = SDValue(Res, VTs.size()-1);
3196
3197       // If the OPFL_MemRefs glue is set on this node, slap all of the
3198       // accumulated memrefs onto it.
3199       //
3200       // FIXME: This is vastly incorrect for patterns with multiple outputs
3201       // instructions that access memory and for ComplexPatterns that match
3202       // loads.
3203       if (EmitNodeInfo & OPFL_MemRefs) {
3204         // Only attach load or store memory operands if the generated
3205         // instruction may load or store.
3206         const MCInstrDesc &MCID = TII->get(TargetOpc);
3207         bool mayLoad = MCID.mayLoad();
3208         bool mayStore = MCID.mayStore();
3209
3210         unsigned NumMemRefs = 0;
3211         for (SmallVectorImpl<MachineMemOperand *>::const_iterator I =
3212                MatchedMemRefs.begin(), E = MatchedMemRefs.end(); I != E; ++I) {
3213           if ((*I)->isLoad()) {
3214             if (mayLoad)
3215               ++NumMemRefs;
3216           } else if ((*I)->isStore()) {
3217             if (mayStore)
3218               ++NumMemRefs;
3219           } else {
3220             ++NumMemRefs;
3221           }
3222         }
3223
3224         MachineSDNode::mmo_iterator MemRefs =
3225           MF->allocateMemRefsArray(NumMemRefs);
3226
3227         MachineSDNode::mmo_iterator MemRefsPos = MemRefs;
3228         for (SmallVectorImpl<MachineMemOperand *>::const_iterator I =
3229                MatchedMemRefs.begin(), E = MatchedMemRefs.end(); I != E; ++I) {
3230           if ((*I)->isLoad()) {
3231             if (mayLoad)
3232               *MemRefsPos++ = *I;
3233           } else if ((*I)->isStore()) {
3234             if (mayStore)
3235               *MemRefsPos++ = *I;
3236           } else {
3237             *MemRefsPos++ = *I;
3238           }
3239         }
3240
3241         cast<MachineSDNode>(Res)
3242           ->setMemRefs(MemRefs, MemRefs + NumMemRefs);
3243       }
3244
3245       DEBUG(dbgs() << "  "
3246                    << (Opcode == OPC_MorphNodeTo ? "Morphed" : "Created")
3247                    << " node: "; Res->dump(CurDAG); dbgs() << "\n");
3248
3249       // If this was a MorphNodeTo then we're completely done!
3250       if (Opcode == OPC_MorphNodeTo) {
3251         // Update chain and glue uses.
3252         UpdateChainsAndGlue(NodeToMatch, InputChain, ChainNodesMatched,
3253                             InputGlue, GlueResultNodesMatched, true);
3254         return Res;
3255       }
3256
3257       continue;
3258     }
3259
3260     case OPC_MarkGlueResults: {
3261       unsigned NumNodes = MatcherTable[MatcherIndex++];
3262
3263       // Read and remember all the glue-result nodes.
3264       for (unsigned i = 0; i != NumNodes; ++i) {
3265         unsigned RecNo = MatcherTable[MatcherIndex++];
3266         if (RecNo & 128)
3267           RecNo = GetVBR(RecNo, MatcherTable, MatcherIndex);
3268
3269         assert(RecNo < RecordedNodes.size() && "Invalid MarkGlueResults");
3270         GlueResultNodesMatched.push_back(RecordedNodes[RecNo].first.getNode());
3271       }
3272       continue;
3273     }
3274
3275     case OPC_CompleteMatch: {
3276       // The match has been completed, and any new nodes (if any) have been
3277       // created.  Patch up references to the matched dag to use the newly
3278       // created nodes.
3279       unsigned NumResults = MatcherTable[MatcherIndex++];
3280
3281       for (unsigned i = 0; i != NumResults; ++i) {
3282         unsigned ResSlot = MatcherTable[MatcherIndex++];
3283         if (ResSlot & 128)
3284           ResSlot = GetVBR(ResSlot, MatcherTable, MatcherIndex);
3285
3286         assert(ResSlot < RecordedNodes.size() && "Invalid CompleteMatch");
3287         SDValue Res = RecordedNodes[ResSlot].first;
3288
3289         assert(i < NodeToMatch->getNumValues() &&
3290                NodeToMatch->getValueType(i) != MVT::Other &&
3291                NodeToMatch->getValueType(i) != MVT::Glue &&
3292                "Invalid number of results to complete!");
3293         assert((NodeToMatch->getValueType(i) == Res.getValueType() ||
3294                 NodeToMatch->getValueType(i) == MVT::iPTR ||
3295                 Res.getValueType() == MVT::iPTR ||
3296                 NodeToMatch->getValueType(i).getSizeInBits() ==
3297                     Res.getValueType().getSizeInBits()) &&
3298                "invalid replacement");
3299         CurDAG->ReplaceAllUsesOfValueWith(SDValue(NodeToMatch, i), Res);
3300       }
3301
3302       // If the root node defines glue, add it to the glue nodes to update list.
3303       if (NodeToMatch->getValueType(NodeToMatch->getNumValues()-1) == MVT::Glue)
3304         GlueResultNodesMatched.push_back(NodeToMatch);
3305
3306       // Update chain and glue uses.
3307       UpdateChainsAndGlue(NodeToMatch, InputChain, ChainNodesMatched,
3308                           InputGlue, GlueResultNodesMatched, false);
3309
3310       assert(NodeToMatch->use_empty() &&
3311              "Didn't replace all uses of the node?");
3312
3313       // FIXME: We just return here, which interacts correctly with SelectRoot
3314       // above.  We should fix this to not return an SDNode* anymore.
3315       return nullptr;
3316     }
3317     }
3318
3319     // If the code reached this point, then the match failed.  See if there is
3320     // another child to try in the current 'Scope', otherwise pop it until we
3321     // find a case to check.
3322     DEBUG(dbgs() << "  Match failed at index " << CurrentOpcodeIndex << "\n");
3323     ++NumDAGIselRetries;
3324     while (1) {
3325       if (MatchScopes.empty()) {
3326         CannotYetSelect(NodeToMatch);
3327         return nullptr;
3328       }
3329
3330       // Restore the interpreter state back to the point where the scope was
3331       // formed.
3332       MatchScope &LastScope = MatchScopes.back();
3333       RecordedNodes.resize(LastScope.NumRecordedNodes);
3334       NodeStack.clear();
3335       NodeStack.append(LastScope.NodeStack.begin(), LastScope.NodeStack.end());
3336       N = NodeStack.back();
3337
3338       if (LastScope.NumMatchedMemRefs != MatchedMemRefs.size())
3339         MatchedMemRefs.resize(LastScope.NumMatchedMemRefs);
3340       MatcherIndex = LastScope.FailIndex;
3341
3342       DEBUG(dbgs() << "  Continuing at " << MatcherIndex << "\n");
3343
3344       InputChain = LastScope.InputChain;
3345       InputGlue = LastScope.InputGlue;
3346       if (!LastScope.HasChainNodesMatched)
3347         ChainNodesMatched.clear();
3348       if (!LastScope.HasGlueResultNodesMatched)
3349         GlueResultNodesMatched.clear();
3350
3351       // Check to see what the offset is at the new MatcherIndex.  If it is zero
3352       // we have reached the end of this scope, otherwise we have another child
3353       // in the current scope to try.
3354       unsigned NumToSkip = MatcherTable[MatcherIndex++];
3355       if (NumToSkip & 128)
3356         NumToSkip = GetVBR(NumToSkip, MatcherTable, MatcherIndex);
3357
3358       // If we have another child in this scope to match, update FailIndex and
3359       // try it.
3360       if (NumToSkip != 0) {
3361         LastScope.FailIndex = MatcherIndex+NumToSkip;
3362         break;
3363       }
3364
3365       // End of this scope, pop it and try the next child in the containing
3366       // scope.
3367       MatchScopes.pop_back();
3368     }
3369   }
3370 }
3371
3372
3373
3374 void SelectionDAGISel::CannotYetSelect(SDNode *N) {
3375   std::string msg;
3376   raw_string_ostream Msg(msg);
3377   Msg << "Cannot select: ";
3378
3379   if (N->getOpcode() != ISD::INTRINSIC_W_CHAIN &&
3380       N->getOpcode() != ISD::INTRINSIC_WO_CHAIN &&
3381       N->getOpcode() != ISD::INTRINSIC_VOID) {
3382     N->printrFull(Msg, CurDAG);
3383     Msg << "\nIn function: " << MF->getName();
3384   } else {
3385     bool HasInputChain = N->getOperand(0).getValueType() == MVT::Other;
3386     unsigned iid =
3387       cast<ConstantSDNode>(N->getOperand(HasInputChain))->getZExtValue();
3388     if (iid < Intrinsic::num_intrinsics)
3389       Msg << "intrinsic %" << Intrinsic::getName((Intrinsic::ID)iid);
3390     else if (const TargetIntrinsicInfo *TII = TM.getIntrinsicInfo())
3391       Msg << "target intrinsic %" << TII->getName(iid);
3392     else
3393       Msg << "unknown intrinsic #" << iid;
3394   }
3395   report_fatal_error(Msg.str());
3396 }
3397
3398 char SelectionDAGISel::ID = 0;