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