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