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