1 //===- FastISel.cpp - Implementation of the FastISel 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 file contains the implementation of the FastISel class.
11 //
12 // "Fast" instruction selection is designed to emit very poor code quickly.
13 // Also, it is not designed to be able to do much lowering, so most illegal
14 // types (e.g. i64 on 32-bit targets) and operations are not supported.  It is
15 // also not intended to be able to do much optimization, except in a few cases
16 // where doing optimizations reduces overall compile time.  For example, folding
17 // constants into immediate fields is often done, because it's cheap and it
18 // reduces the number of instructions later phases have to examine.
19 //
20 // "Fast" instruction selection is able to fail gracefully and transfer
21 // control to the SelectionDAG selector for operations that it doesn't
22 // support.  In many cases, this allows us to avoid duplicating a lot of
23 // the complicated lowering logic that SelectionDAG currently has.
24 //
25 // The intended use for "fast" instruction selection is "-O0" mode
26 // compilation, where the quality of the generated code is irrelevant when
27 // weighed against the speed at which the code can be generated.  Also,
28 // at -O0, the LLVM optimizers are not running, and this makes the
29 // compile time of codegen a much higher portion of the overall compile
30 // time.  Despite its limitations, "fast" instruction selection is able to
31 // handle enough code on its own to provide noticeable overall speedups
32 // in -O0 compiles.
33 //
34 // Basic operations are supported in a target-independent way, by reading
35 // the same instruction descriptions that the SelectionDAG selector reads,
36 // and identifying simple arithmetic operations that can be directly selected
37 // from simple operators.  More complicated operations currently require
38 // target-specific code.
39 //
40 //===----------------------------------------------------------------------===//
41 
42 #include "llvm/CodeGen/FastISel.h"
43 #include "llvm/ADT/APFloat.h"
44 #include "llvm/ADT/APSInt.h"
45 #include "llvm/ADT/DenseMap.h"
46 #include "llvm/ADT/Optional.h"
47 #include "llvm/ADT/SmallPtrSet.h"
48 #include "llvm/ADT/SmallString.h"
49 #include "llvm/ADT/SmallVector.h"
50 #include "llvm/ADT/Statistic.h"
51 #include "llvm/Analysis/BranchProbabilityInfo.h"
52 #include "llvm/Analysis/TargetLibraryInfo.h"
53 #include "llvm/CodeGen/Analysis.h"
54 #include "llvm/CodeGen/FunctionLoweringInfo.h"
55 #include "llvm/CodeGen/ISDOpcodes.h"
56 #include "llvm/CodeGen/MachineBasicBlock.h"
57 #include "llvm/CodeGen/MachineFrameInfo.h"
58 #include "llvm/CodeGen/MachineInstr.h"
59 #include "llvm/CodeGen/MachineInstrBuilder.h"
60 #include "llvm/CodeGen/MachineMemOperand.h"
61 #include "llvm/CodeGen/MachineModuleInfo.h"
62 #include "llvm/CodeGen/MachineOperand.h"
63 #include "llvm/CodeGen/MachineRegisterInfo.h"
64 #include "llvm/CodeGen/StackMaps.h"
65 #include "llvm/CodeGen/TargetInstrInfo.h"
66 #include "llvm/CodeGen/TargetLowering.h"
67 #include "llvm/CodeGen/TargetSubtargetInfo.h"
68 #include "llvm/CodeGen/ValueTypes.h"
69 #include "llvm/IR/Argument.h"
70 #include "llvm/IR/Attributes.h"
71 #include "llvm/IR/BasicBlock.h"
72 #include "llvm/IR/CallSite.h"
73 #include "llvm/IR/CallingConv.h"
74 #include "llvm/IR/Constant.h"
75 #include "llvm/IR/Constants.h"
76 #include "llvm/IR/DataLayout.h"
77 #include "llvm/IR/DebugInfo.h"
78 #include "llvm/IR/DebugLoc.h"
79 #include "llvm/IR/DerivedTypes.h"
80 #include "llvm/IR/Function.h"
81 #include "llvm/IR/GetElementPtrTypeIterator.h"
82 #include "llvm/IR/GlobalValue.h"
83 #include "llvm/IR/InlineAsm.h"
84 #include "llvm/IR/InstrTypes.h"
85 #include "llvm/IR/Instruction.h"
86 #include "llvm/IR/Instructions.h"
87 #include "llvm/IR/IntrinsicInst.h"
88 #include "llvm/IR/LLVMContext.h"
89 #include "llvm/IR/Mangler.h"
90 #include "llvm/IR/Metadata.h"
91 #include "llvm/IR/Operator.h"
92 #include "llvm/IR/Type.h"
93 #include "llvm/IR/User.h"
94 #include "llvm/IR/Value.h"
95 #include "llvm/MC/MCContext.h"
96 #include "llvm/MC/MCInstrDesc.h"
97 #include "llvm/MC/MCRegisterInfo.h"
98 #include "llvm/Support/Casting.h"
99 #include "llvm/Support/Debug.h"
100 #include "llvm/Support/ErrorHandling.h"
101 #include "llvm/Support/MachineValueType.h"
102 #include "llvm/Support/MathExtras.h"
103 #include "llvm/Support/raw_ostream.h"
104 #include "llvm/Target/TargetMachine.h"
105 #include "llvm/Target/TargetOptions.h"
106 #include <algorithm>
107 #include <cassert>
108 #include <cstdint>
109 #include <iterator>
110 #include <utility>
111 
112 using namespace llvm;
113 
114 #define DEBUG_TYPE "isel"
115 
116 // FIXME: Remove this when compile time issues are addressed. Do this by only
117 // numbering instructions between local value map flush points instead of the
118 // entire BB.
119 static cl::opt<bool> SinkLocalValues("fast-isel-sink-local-values",
120                                      cl::init(false), cl::Hidden,
121                                      cl::desc("Sink local values in FastISel"));
122 
123 STATISTIC(NumFastIselSuccessIndependent, "Number of insts selected by "
124                                          "target-independent selector");
125 STATISTIC(NumFastIselSuccessTarget, "Number of insts selected by "
126                                     "target-specific selector");
127 STATISTIC(NumFastIselDead, "Number of dead insts removed on failure");
128 
129 /// Set the current block to which generated machine instructions will be
130 /// appended.
131 void FastISel::startNewBlock() {
132   assert(LocalValueMap.empty() &&
133          "local values should be cleared after finishing a BB");
134 
135   // Instructions are appended to FuncInfo.MBB. If the basic block already
136   // contains labels or copies, use the last instruction as the last local
137   // value.
138   EmitStartPt = nullptr;
139   if (!FuncInfo.MBB->empty())
140     EmitStartPt = &FuncInfo.MBB->back();
141   LastLocalValue = EmitStartPt;
142 }
143 
144 /// Flush the local CSE map and sink anything we can.
145 void FastISel::finishBasicBlock() { flushLocalValueMap(); }
146 
147 bool FastISel::lowerArguments() {
148   if (!FuncInfo.CanLowerReturn)
149     // Fallback to SDISel argument lowering code to deal with sret pointer
150     // parameter.
151     return false;
152 
153   if (!fastLowerArguments())
154     return false;
155 
156   // Enter arguments into ValueMap for uses in non-entry BBs.
157   for (Function::const_arg_iterator I = FuncInfo.Fn->arg_begin(),
158                                     E = FuncInfo.Fn->arg_end();
159        I != E; ++I) {
160     DenseMap<const Value *, unsigned>::iterator VI = LocalValueMap.find(&*I);
161     assert(VI != LocalValueMap.end() && "Missed an argument?");
162     FuncInfo.ValueMap[&*I] = VI->second;
163   }
164   return true;
165 }
166 
167 /// Return the defined register if this instruction defines exactly one
168 /// virtual register and uses no other virtual registers. Otherwise return 0.
169 static unsigned findSinkableLocalRegDef(MachineInstr &MI) {
170   unsigned RegDef = 0;
171   for (const MachineOperand &MO : MI.operands()) {
172     if (!MO.isReg())
173       continue;
174     if (MO.isDef()) {
175       if (RegDef)
176         return 0;
177       RegDef = MO.getReg();
178     } else if (TargetRegisterInfo::isVirtualRegister(MO.getReg())) {
179       // This is another use of a vreg. Don't try to sink it.
180       return 0;
181     }
182   }
183   return RegDef;
184 }
185 
186 void FastISel::flushLocalValueMap() {
187   // Try to sink local values down to their first use so that we can give them a
188   // better debug location. This has the side effect of shrinking local value
189   // live ranges, which helps out fast regalloc.
190   if (SinkLocalValues && LastLocalValue != EmitStartPt) {
191     // Sink local value materialization instructions between EmitStartPt and
192     // LastLocalValue. Visit them bottom-up, starting from LastLocalValue, to
193     // avoid inserting into the range that we're iterating over.
194     MachineBasicBlock::reverse_iterator RE =
195         EmitStartPt ? MachineBasicBlock::reverse_iterator(EmitStartPt)
196                     : FuncInfo.MBB->rend();
197     MachineBasicBlock::reverse_iterator RI(LastLocalValue);
198 
199     InstOrderMap OrderMap;
200     for (; RI != RE;) {
201       MachineInstr &LocalMI = *RI;
202       ++RI;
203       bool Store = true;
204       if (!LocalMI.isSafeToMove(nullptr, Store))
205         continue;
206       unsigned DefReg = findSinkableLocalRegDef(LocalMI);
207       if (DefReg == 0)
208         continue;
209 
210       sinkLocalValueMaterialization(LocalMI, DefReg, OrderMap);
211     }
212   }
213 
214   LocalValueMap.clear();
215   LastLocalValue = EmitStartPt;
216   recomputeInsertPt();
217   SavedInsertPt = FuncInfo.InsertPt;
218 }
219 
220 static bool isRegUsedByPhiNodes(unsigned DefReg,
221                                 FunctionLoweringInfo &FuncInfo) {
222   for (auto &P : FuncInfo.PHINodesToUpdate)
223     if (P.second == DefReg)
224       return true;
225   return false;
226 }
227 
228 /// Build a map of instruction orders. Return the first terminator and its
229 /// order. Consider EH_LABEL instructions to be terminators as well, since local
230 /// values for phis after invokes must be materialized before the call.
231 void FastISel::InstOrderMap::initialize(MachineBasicBlock *MBB) {
232   unsigned Order = 0;
233   for (MachineInstr &I : *MBB) {
234     if (!FirstTerminator &&
235         (I.isTerminator() || (I.isEHLabel() && &I != &MBB->front()))) {
236       FirstTerminator = &I;
237       FirstTerminatorOrder = Order;
238     }
239     Orders[&I] = Order++;
240   }
241 }
242 
243 void FastISel::sinkLocalValueMaterialization(MachineInstr &LocalMI,
244                                              unsigned DefReg,
245                                              InstOrderMap &OrderMap) {
246   // If this register is used by a register fixup, MRI will not contain all
247   // the uses until after register fixups, so don't attempt to sink or DCE
248   // this instruction. Register fixups typically come from no-op cast
249   // instructions, which replace the cast instruction vreg with the local
250   // value vreg.
251   if (FuncInfo.RegsWithFixups.count(DefReg))
252     return;
253 
254   // We can DCE this instruction if there are no uses and it wasn't a
255   // materialized for a successor PHI node.
256   bool UsedByPHI = isRegUsedByPhiNodes(DefReg, FuncInfo);
257   if (!UsedByPHI && MRI.use_nodbg_empty(DefReg)) {
258     if (EmitStartPt == &LocalMI)
259       EmitStartPt = EmitStartPt->getPrevNode();
260     DEBUG(dbgs() << "removing dead local value materialization " << LocalMI);
261     OrderMap.Orders.erase(&LocalMI);
262     LocalMI.eraseFromParent();
263     return;
264   }
265 
266   // Number the instructions if we haven't yet so we can efficiently find the
267   // earliest use.
268   if (OrderMap.Orders.empty())
269     OrderMap.initialize(FuncInfo.MBB);
270 
271   // Find the first user in the BB.
272   MachineInstr *FirstUser = nullptr;
273   unsigned FirstOrder = std::numeric_limits<unsigned>::max();
274   for (MachineInstr &UseInst : MRI.use_nodbg_instructions(DefReg)) {
275     unsigned UseOrder = OrderMap.Orders[&UseInst];
276     if (UseOrder < FirstOrder) {
277       FirstOrder = UseOrder;
278       FirstUser = &UseInst;
279     }
280   }
281 
282   // The insertion point will be the first terminator or the first user,
283   // whichever came first. If there was no terminator, this must be a
284   // fallthrough block and the insertion point is the end of the block.
285   MachineBasicBlock::instr_iterator SinkPos;
286   if (UsedByPHI && OrderMap.FirstTerminatorOrder < FirstOrder) {
287     FirstOrder = OrderMap.FirstTerminatorOrder;
288     SinkPos = OrderMap.FirstTerminator->getIterator();
289   } else if (FirstUser) {
290     SinkPos = FirstUser->getIterator();
291   } else {
292     assert(UsedByPHI && "must be users if not used by a phi");
293     SinkPos = FuncInfo.MBB->instr_end();
294   }
295 
296   // Collect all DBG_VALUEs before the new insertion position so that we can
297   // sink them.
298   SmallVector<MachineInstr *, 1> DbgValues;
299   for (MachineInstr &DbgVal : MRI.use_instructions(DefReg)) {
300     if (!DbgVal.isDebugValue())
301       continue;
302     unsigned UseOrder = OrderMap.Orders[&DbgVal];
303     if (UseOrder < FirstOrder)
304       DbgValues.push_back(&DbgVal);
305   }
306 
307   // Sink LocalMI before SinkPos and assign it the same DebugLoc.
308   DEBUG(dbgs() << "sinking local value to first use " << LocalMI);
309   FuncInfo.MBB->remove(&LocalMI);
310   FuncInfo.MBB->insert(SinkPos, &LocalMI);
311   if (SinkPos != FuncInfo.MBB->end())
312     LocalMI.setDebugLoc(SinkPos->getDebugLoc());
313 
314   // Sink any debug values that we've collected.
315   for (MachineInstr *DI : DbgValues) {
316     FuncInfo.MBB->remove(DI);
317     FuncInfo.MBB->insert(SinkPos, DI);
318   }
319 }
320 
321 bool FastISel::hasTrivialKill(const Value *V) {
322   // Don't consider constants or arguments to have trivial kills.
323   const Instruction *I = dyn_cast<Instruction>(V);
324   if (!I)
325     return false;
326 
327   // No-op casts are trivially coalesced by fast-isel.
328   if (const auto *Cast = dyn_cast<CastInst>(I))
329     if (Cast->isNoopCast(DL) && !hasTrivialKill(Cast->getOperand(0)))
330       return false;
331 
332   // Even the value might have only one use in the LLVM IR, it is possible that
333   // FastISel might fold the use into another instruction and now there is more
334   // than one use at the Machine Instruction level.
335   unsigned Reg = lookUpRegForValue(V);
336   if (Reg && !MRI.use_empty(Reg))
337     return false;
338 
339   // GEPs with all zero indices are trivially coalesced by fast-isel.
340   if (const auto *GEP = dyn_cast<GetElementPtrInst>(I))
341     if (GEP->hasAllZeroIndices() && !hasTrivialKill(GEP->getOperand(0)))
342       return false;
343 
344   // Only instructions with a single use in the same basic block are considered
345   // to have trivial kills.
346   return I->hasOneUse() &&
347          !(I->getOpcode() == Instruction::BitCast ||
348            I->getOpcode() == Instruction::PtrToInt ||
349            I->getOpcode() == Instruction::IntToPtr) &&
350          cast<Instruction>(*I->user_begin())->getParent() == I->getParent();
351 }
352 
353 unsigned FastISel::getRegForValue(const Value *V) {
354   EVT RealVT = TLI.getValueType(DL, V->getType(), /*AllowUnknown=*/true);
355   // Don't handle non-simple values in FastISel.
356   if (!RealVT.isSimple())
357     return 0;
358 
359   // Ignore illegal types. We must do this before looking up the value
360   // in ValueMap because Arguments are given virtual registers regardless
361   // of whether FastISel can handle them.
362   MVT VT = RealVT.getSimpleVT();
363   if (!TLI.isTypeLegal(VT)) {
364     // Handle integer promotions, though, because they're common and easy.
365     if (VT == MVT::i1 || VT == MVT::i8 || VT == MVT::i16)
366       VT = TLI.getTypeToTransformTo(V->getContext(), VT).getSimpleVT();
367     else
368       return 0;
369   }
370 
371   // Look up the value to see if we already have a register for it.
372   unsigned Reg = lookUpRegForValue(V);
373   if (Reg)
374     return Reg;
375 
376   // In bottom-up mode, just create the virtual register which will be used
377   // to hold the value. It will be materialized later.
378   if (isa<Instruction>(V) &&
379       (!isa<AllocaInst>(V) ||
380        !FuncInfo.StaticAllocaMap.count(cast<AllocaInst>(V))))
381     return FuncInfo.InitializeRegForValue(V);
382 
383   SavePoint SaveInsertPt = enterLocalValueArea();
384 
385   // Materialize the value in a register. Emit any instructions in the
386   // local value area.
387   Reg = materializeRegForValue(V, VT);
388 
389   leaveLocalValueArea(SaveInsertPt);
390 
391   return Reg;
392 }
393 
394 unsigned FastISel::materializeConstant(const Value *V, MVT VT) {
395   unsigned Reg = 0;
396   if (const auto *CI = dyn_cast<ConstantInt>(V)) {
397     if (CI->getValue().getActiveBits() <= 64)
398       Reg = fastEmit_i(VT, VT, ISD::Constant, CI->getZExtValue());
399   } else if (isa<AllocaInst>(V))
400     Reg = fastMaterializeAlloca(cast<AllocaInst>(V));
401   else if (isa<ConstantPointerNull>(V))
402     // Translate this as an integer zero so that it can be
403     // local-CSE'd with actual integer zeros.
404     Reg = getRegForValue(
405         Constant::getNullValue(DL.getIntPtrType(V->getContext())));
406   else if (const auto *CF = dyn_cast<ConstantFP>(V)) {
407     if (CF->isNullValue())
408       Reg = fastMaterializeFloatZero(CF);
409     else
410       // Try to emit the constant directly.
411       Reg = fastEmit_f(VT, VT, ISD::ConstantFP, CF);
412 
413     if (!Reg) {
414       // Try to emit the constant by using an integer constant with a cast.
415       const APFloat &Flt = CF->getValueAPF();
416       EVT IntVT = TLI.getPointerTy(DL);
417       uint32_t IntBitWidth = IntVT.getSizeInBits();
418       APSInt SIntVal(IntBitWidth, /*isUnsigned=*/false);
419       bool isExact;
420       (void)Flt.convertToInteger(SIntVal, APFloat::rmTowardZero, &isExact);
421       if (isExact) {
422         unsigned IntegerReg =
423             getRegForValue(ConstantInt::get(V->getContext(), SIntVal));
424         if (IntegerReg != 0)
425           Reg = fastEmit_r(IntVT.getSimpleVT(), VT, ISD::SINT_TO_FP, IntegerReg,
426                            /*Kill=*/false);
427       }
428     }
429   } else if (const auto *Op = dyn_cast<Operator>(V)) {
430     if (!selectOperator(Op, Op->getOpcode()))
431       if (!isa<Instruction>(Op) ||
432           !fastSelectInstruction(cast<Instruction>(Op)))
433         return 0;
434     Reg = lookUpRegForValue(Op);
435   } else if (isa<UndefValue>(V)) {
436     Reg = createResultReg(TLI.getRegClassFor(VT));
437     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
438             TII.get(TargetOpcode::IMPLICIT_DEF), Reg);
439   }
440   return Reg;
441 }
442 
443 /// Helper for getRegForValue. This function is called when the value isn't
444 /// already available in a register and must be materialized with new
445 /// instructions.
446 unsigned FastISel::materializeRegForValue(const Value *V, MVT VT) {
447   unsigned Reg = 0;
448   // Give the target-specific code a try first.
449   if (isa<Constant>(V))
450     Reg = fastMaterializeConstant(cast<Constant>(V));
451 
452   // If target-specific code couldn't or didn't want to handle the value, then
453   // give target-independent code a try.
454   if (!Reg)
455     Reg = materializeConstant(V, VT);
456 
457   // Don't cache constant materializations in the general ValueMap.
458   // To do so would require tracking what uses they dominate.
459   if (Reg) {
460     LocalValueMap[V] = Reg;
461     LastLocalValue = MRI.getVRegDef(Reg);
462   }
463   return Reg;
464 }
465 
466 unsigned FastISel::lookUpRegForValue(const Value *V) {
467   // Look up the value to see if we already have a register for it. We
468   // cache values defined by Instructions across blocks, and other values
469   // only locally. This is because Instructions already have the SSA
470   // def-dominates-use requirement enforced.
471   DenseMap<const Value *, unsigned>::iterator I = FuncInfo.ValueMap.find(V);
472   if (I != FuncInfo.ValueMap.end())
473     return I->second;
474   return LocalValueMap[V];
475 }
476 
477 void FastISel::updateValueMap(const Value *I, unsigned Reg, unsigned NumRegs) {
478   if (!isa<Instruction>(I)) {
479     LocalValueMap[I] = Reg;
480     return;
481   }
482 
483   unsigned &AssignedReg = FuncInfo.ValueMap[I];
484   if (AssignedReg == 0)
485     // Use the new register.
486     AssignedReg = Reg;
487   else if (Reg != AssignedReg) {
488     // Arrange for uses of AssignedReg to be replaced by uses of Reg.
489     for (unsigned i = 0; i < NumRegs; i++) {
490       FuncInfo.RegFixups[AssignedReg + i] = Reg + i;
491       FuncInfo.RegsWithFixups.insert(Reg + i);
492     }
493 
494     AssignedReg = Reg;
495   }
496 }
497 
498 std::pair<unsigned, bool> FastISel::getRegForGEPIndex(const Value *Idx) {
499   unsigned IdxN = getRegForValue(Idx);
500   if (IdxN == 0)
501     // Unhandled operand. Halt "fast" selection and bail.
502     return std::pair<unsigned, bool>(0, false);
503 
504   bool IdxNIsKill = hasTrivialKill(Idx);
505 
506   // If the index is smaller or larger than intptr_t, truncate or extend it.
507   MVT PtrVT = TLI.getPointerTy(DL);
508   EVT IdxVT = EVT::getEVT(Idx->getType(), /*HandleUnknown=*/false);
509   if (IdxVT.bitsLT(PtrVT)) {
510     IdxN = fastEmit_r(IdxVT.getSimpleVT(), PtrVT, ISD::SIGN_EXTEND, IdxN,
511                       IdxNIsKill);
512     IdxNIsKill = true;
513   } else if (IdxVT.bitsGT(PtrVT)) {
514     IdxN =
515         fastEmit_r(IdxVT.getSimpleVT(), PtrVT, ISD::TRUNCATE, IdxN, IdxNIsKill);
516     IdxNIsKill = true;
517   }
518   return std::pair<unsigned, bool>(IdxN, IdxNIsKill);
519 }
520 
521 void FastISel::recomputeInsertPt() {
522   if (getLastLocalValue()) {
523     FuncInfo.InsertPt = getLastLocalValue();
524     FuncInfo.MBB = FuncInfo.InsertPt->getParent();
525     ++FuncInfo.InsertPt;
526   } else
527     FuncInfo.InsertPt = FuncInfo.MBB->getFirstNonPHI();
528 
529   // Now skip past any EH_LABELs, which must remain at the beginning.
530   while (FuncInfo.InsertPt != FuncInfo.MBB->end() &&
531          FuncInfo.InsertPt->getOpcode() == TargetOpcode::EH_LABEL)
532     ++FuncInfo.InsertPt;
533 }
534 
535 void FastISel::removeDeadCode(MachineBasicBlock::iterator I,
536                               MachineBasicBlock::iterator E) {
537   assert(I.isValid() && E.isValid() && std::distance(I, E) > 0 &&
538          "Invalid iterator!");
539   while (I != E) {
540     MachineInstr *Dead = &*I;
541     ++I;
542     Dead->eraseFromParent();
543     ++NumFastIselDead;
544   }
545   recomputeInsertPt();
546 }
547 
548 FastISel::SavePoint FastISel::enterLocalValueArea() {
549   MachineBasicBlock::iterator OldInsertPt = FuncInfo.InsertPt;
550   DebugLoc OldDL = DbgLoc;
551   recomputeInsertPt();
552   DbgLoc = DebugLoc();
553   SavePoint SP = {OldInsertPt, OldDL};
554   return SP;
555 }
556 
557 void FastISel::leaveLocalValueArea(SavePoint OldInsertPt) {
558   if (FuncInfo.InsertPt != FuncInfo.MBB->begin())
559     LastLocalValue = &*std::prev(FuncInfo.InsertPt);
560 
561   // Restore the previous insert position.
562   FuncInfo.InsertPt = OldInsertPt.InsertPt;
563   DbgLoc = OldInsertPt.DL;
564 }
565 
566 bool FastISel::selectBinaryOp(const User *I, unsigned ISDOpcode) {
567   EVT VT = EVT::getEVT(I->getType(), /*HandleUnknown=*/true);
568   if (VT == MVT::Other || !VT.isSimple())
569     // Unhandled type. Halt "fast" selection and bail.
570     return false;
571 
572   // We only handle legal types. For example, on x86-32 the instruction
573   // selector contains all of the 64-bit instructions from x86-64,
574   // under the assumption that i64 won't be used if the target doesn't
575   // support it.
576   if (!TLI.isTypeLegal(VT)) {
577     // MVT::i1 is special. Allow AND, OR, or XOR because they
578     // don't require additional zeroing, which makes them easy.
579     if (VT == MVT::i1 && (ISDOpcode == ISD::AND || ISDOpcode == ISD::OR ||
580                           ISDOpcode == ISD::XOR))
581       VT = TLI.getTypeToTransformTo(I->getContext(), VT);
582     else
583       return false;
584   }
585 
586   // Check if the first operand is a constant, and handle it as "ri".  At -O0,
587   // we don't have anything that canonicalizes operand order.
588   if (const auto *CI = dyn_cast<ConstantInt>(I->getOperand(0)))
589     if (isa<Instruction>(I) && cast<Instruction>(I)->isCommutative()) {
590       unsigned Op1 = getRegForValue(I->getOperand(1));
591       if (!Op1)
592         return false;
593       bool Op1IsKill = hasTrivialKill(I->getOperand(1));
594 
595       unsigned ResultReg =
596           fastEmit_ri_(VT.getSimpleVT(), ISDOpcode, Op1, Op1IsKill,
597                        CI->getZExtValue(), VT.getSimpleVT());
598       if (!ResultReg)
599         return false;
600 
601       // We successfully emitted code for the given LLVM Instruction.
602       updateValueMap(I, ResultReg);
603       return true;
604     }
605 
606   unsigned Op0 = getRegForValue(I->getOperand(0));
607   if (!Op0) // Unhandled operand. Halt "fast" selection and bail.
608     return false;
609   bool Op0IsKill = hasTrivialKill(I->getOperand(0));
610 
611   // Check if the second operand is a constant and handle it appropriately.
612   if (const auto *CI = dyn_cast<ConstantInt>(I->getOperand(1))) {
613     uint64_t Imm = CI->getSExtValue();
614 
615     // Transform "sdiv exact X, 8" -> "sra X, 3".
616     if (ISDOpcode == ISD::SDIV && isa<BinaryOperator>(I) &&
617         cast<BinaryOperator>(I)->isExact() && isPowerOf2_64(Imm)) {
618       Imm = Log2_64(Imm);
619       ISDOpcode = ISD::SRA;
620     }
621 
622     // Transform "urem x, pow2" -> "and x, pow2-1".
623     if (ISDOpcode == ISD::UREM && isa<BinaryOperator>(I) &&
624         isPowerOf2_64(Imm)) {
625       --Imm;
626       ISDOpcode = ISD::AND;
627     }
628 
629     unsigned ResultReg = fastEmit_ri_(VT.getSimpleVT(), ISDOpcode, Op0,
630                                       Op0IsKill, Imm, VT.getSimpleVT());
631     if (!ResultReg)
632       return false;
633 
634     // We successfully emitted code for the given LLVM Instruction.
635     updateValueMap(I, ResultReg);
636     return true;
637   }
638 
639   unsigned Op1 = getRegForValue(I->getOperand(1));
640   if (!Op1) // Unhandled operand. Halt "fast" selection and bail.
641     return false;
642   bool Op1IsKill = hasTrivialKill(I->getOperand(1));
643 
644   // Now we have both operands in registers. Emit the instruction.
645   unsigned ResultReg = fastEmit_rr(VT.getSimpleVT(), VT.getSimpleVT(),
646                                    ISDOpcode, Op0, Op0IsKill, Op1, Op1IsKill);
647   if (!ResultReg)
648     // Target-specific code wasn't able to find a machine opcode for
649     // the given ISD opcode and type. Halt "fast" selection and bail.
650     return false;
651 
652   // We successfully emitted code for the given LLVM Instruction.
653   updateValueMap(I, ResultReg);
654   return true;
655 }
656 
657 bool FastISel::selectGetElementPtr(const User *I) {
658   unsigned N = getRegForValue(I->getOperand(0));
659   if (!N) // Unhandled operand. Halt "fast" selection and bail.
660     return false;
661   bool NIsKill = hasTrivialKill(I->getOperand(0));
662 
663   // Keep a running tab of the total offset to coalesce multiple N = N + Offset
664   // into a single N = N + TotalOffset.
665   uint64_t TotalOffs = 0;
666   // FIXME: What's a good SWAG number for MaxOffs?
667   uint64_t MaxOffs = 2048;
668   MVT VT = TLI.getPointerTy(DL);
669   for (gep_type_iterator GTI = gep_type_begin(I), E = gep_type_end(I);
670        GTI != E; ++GTI) {
671     const Value *Idx = GTI.getOperand();
672     if (StructType *StTy = GTI.getStructTypeOrNull()) {
673       uint64_t Field = cast<ConstantInt>(Idx)->getZExtValue();
674       if (Field) {
675         // N = N + Offset
676         TotalOffs += DL.getStructLayout(StTy)->getElementOffset(Field);
677         if (TotalOffs >= MaxOffs) {
678           N = fastEmit_ri_(VT, ISD::ADD, N, NIsKill, TotalOffs, VT);
679           if (!N) // Unhandled operand. Halt "fast" selection and bail.
680             return false;
681           NIsKill = true;
682           TotalOffs = 0;
683         }
684       }
685     } else {
686       Type *Ty = GTI.getIndexedType();
687 
688       // If this is a constant subscript, handle it quickly.
689       if (const auto *CI = dyn_cast<ConstantInt>(Idx)) {
690         if (CI->isZero())
691           continue;
692         // N = N + Offset
693         uint64_t IdxN = CI->getValue().sextOrTrunc(64).getSExtValue();
694         TotalOffs += DL.getTypeAllocSize(Ty) * IdxN;
695         if (TotalOffs >= MaxOffs) {
696           N = fastEmit_ri_(VT, ISD::ADD, N, NIsKill, TotalOffs, VT);
697           if (!N) // Unhandled operand. Halt "fast" selection and bail.
698             return false;
699           NIsKill = true;
700           TotalOffs = 0;
701         }
702         continue;
703       }
704       if (TotalOffs) {
705         N = fastEmit_ri_(VT, ISD::ADD, N, NIsKill, TotalOffs, VT);
706         if (!N) // Unhandled operand. Halt "fast" selection and bail.
707           return false;
708         NIsKill = true;
709         TotalOffs = 0;
710       }
711 
712       // N = N + Idx * ElementSize;
713       uint64_t ElementSize = DL.getTypeAllocSize(Ty);
714       std::pair<unsigned, bool> Pair = getRegForGEPIndex(Idx);
715       unsigned IdxN = Pair.first;
716       bool IdxNIsKill = Pair.second;
717       if (!IdxN) // Unhandled operand. Halt "fast" selection and bail.
718         return false;
719 
720       if (ElementSize != 1) {
721         IdxN = fastEmit_ri_(VT, ISD::MUL, IdxN, IdxNIsKill, ElementSize, VT);
722         if (!IdxN) // Unhandled operand. Halt "fast" selection and bail.
723           return false;
724         IdxNIsKill = true;
725       }
726       N = fastEmit_rr(VT, VT, ISD::ADD, N, NIsKill, IdxN, IdxNIsKill);
727       if (!N) // Unhandled operand. Halt "fast" selection and bail.
728         return false;
729     }
730   }
731   if (TotalOffs) {
732     N = fastEmit_ri_(VT, ISD::ADD, N, NIsKill, TotalOffs, VT);
733     if (!N) // Unhandled operand. Halt "fast" selection and bail.
734       return false;
735   }
736 
737   // We successfully emitted code for the given LLVM Instruction.
738   updateValueMap(I, N);
739   return true;
740 }
741 
742 bool FastISel::addStackMapLiveVars(SmallVectorImpl<MachineOperand> &Ops,
743                                    const CallInst *CI, unsigned StartIdx) {
744   for (unsigned i = StartIdx, e = CI->getNumArgOperands(); i != e; ++i) {
745     Value *Val = CI->getArgOperand(i);
746     // Check for constants and encode them with a StackMaps::ConstantOp prefix.
747     if (const auto *C = dyn_cast<ConstantInt>(Val)) {
748       Ops.push_back(MachineOperand::CreateImm(StackMaps::ConstantOp));
749       Ops.push_back(MachineOperand::CreateImm(C->getSExtValue()));
750     } else if (isa<ConstantPointerNull>(Val)) {
751       Ops.push_back(MachineOperand::CreateImm(StackMaps::ConstantOp));
752       Ops.push_back(MachineOperand::CreateImm(0));
753     } else if (auto *AI = dyn_cast<AllocaInst>(Val)) {
754       // Values coming from a stack location also require a special encoding,
755       // but that is added later on by the target specific frame index
756       // elimination implementation.
757       auto SI = FuncInfo.StaticAllocaMap.find(AI);
758       if (SI != FuncInfo.StaticAllocaMap.end())
759         Ops.push_back(MachineOperand::CreateFI(SI->second));
760       else
761         return false;
762     } else {
763       unsigned Reg = getRegForValue(Val);
764       if (!Reg)
765         return false;
766       Ops.push_back(MachineOperand::CreateReg(Reg, /*IsDef=*/false));
767     }
768   }
769   return true;
770 }
771 
772 bool FastISel::selectStackmap(const CallInst *I) {
773   // void @llvm.experimental.stackmap(i64 <id>, i32 <numShadowBytes>,
774   //                                  [live variables...])
775   assert(I->getCalledFunction()->getReturnType()->isVoidTy() &&
776          "Stackmap cannot return a value.");
777 
778   // The stackmap intrinsic only records the live variables (the arguments
779   // passed to it) and emits NOPS (if requested). Unlike the patchpoint
780   // intrinsic, this won't be lowered to a function call. This means we don't
781   // have to worry about calling conventions and target-specific lowering code.
782   // Instead we perform the call lowering right here.
783   //
784   // CALLSEQ_START(0, 0...)
785   // STACKMAP(id, nbytes, ...)
786   // CALLSEQ_END(0, 0)
787   //
788   SmallVector<MachineOperand, 32> Ops;
789 
790   // Add the <id> and <numBytes> constants.
791   assert(isa<ConstantInt>(I->getOperand(PatchPointOpers::IDPos)) &&
792          "Expected a constant integer.");
793   const auto *ID = cast<ConstantInt>(I->getOperand(PatchPointOpers::IDPos));
794   Ops.push_back(MachineOperand::CreateImm(ID->getZExtValue()));
795 
796   assert(isa<ConstantInt>(I->getOperand(PatchPointOpers::NBytesPos)) &&
797          "Expected a constant integer.");
798   const auto *NumBytes =
799       cast<ConstantInt>(I->getOperand(PatchPointOpers::NBytesPos));
800   Ops.push_back(MachineOperand::CreateImm(NumBytes->getZExtValue()));
801 
802   // Push live variables for the stack map (skipping the first two arguments
803   // <id> and <numBytes>).
804   if (!addStackMapLiveVars(Ops, I, 2))
805     return false;
806 
807   // We are not adding any register mask info here, because the stackmap doesn't
808   // clobber anything.
809 
810   // Add scratch registers as implicit def and early clobber.
811   CallingConv::ID CC = I->getCallingConv();
812   const MCPhysReg *ScratchRegs = TLI.getScratchRegisters(CC);
813   for (unsigned i = 0; ScratchRegs[i]; ++i)
814     Ops.push_back(MachineOperand::CreateReg(
815         ScratchRegs[i], /*IsDef=*/true, /*IsImp=*/true, /*IsKill=*/false,
816         /*IsDead=*/false, /*IsUndef=*/false, /*IsEarlyClobber=*/true));
817 
818   // Issue CALLSEQ_START
819   unsigned AdjStackDown = TII.getCallFrameSetupOpcode();
820   auto Builder =
821       BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, TII.get(AdjStackDown));
822   const MCInstrDesc &MCID = Builder.getInstr()->getDesc();
823   for (unsigned I = 0, E = MCID.getNumOperands(); I < E; ++I)
824     Builder.addImm(0);
825 
826   // Issue STACKMAP.
827   MachineInstrBuilder MIB = BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
828                                     TII.get(TargetOpcode::STACKMAP));
829   for (auto const &MO : Ops)
830     MIB.add(MO);
831 
832   // Issue CALLSEQ_END
833   unsigned AdjStackUp = TII.getCallFrameDestroyOpcode();
834   BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, TII.get(AdjStackUp))
835       .addImm(0)
836       .addImm(0);
837 
838   // Inform the Frame Information that we have a stackmap in this function.
839   FuncInfo.MF->getFrameInfo().setHasStackMap();
840 
841   return true;
842 }
843 
844 /// \brief Lower an argument list according to the target calling convention.
845 ///
846 /// This is a helper for lowering intrinsics that follow a target calling
847 /// convention or require stack pointer adjustment. Only a subset of the
848 /// intrinsic's operands need to participate in the calling convention.
849 bool FastISel::lowerCallOperands(const CallInst *CI, unsigned ArgIdx,
850                                  unsigned NumArgs, const Value *Callee,
851                                  bool ForceRetVoidTy, CallLoweringInfo &CLI) {
852   ArgListTy Args;
853   Args.reserve(NumArgs);
854 
855   // Populate the argument list.
856   ImmutableCallSite CS(CI);
857   for (unsigned ArgI = ArgIdx, ArgE = ArgIdx + NumArgs; ArgI != ArgE; ++ArgI) {
858     Value *V = CI->getOperand(ArgI);
859 
860     assert(!V->getType()->isEmptyTy() && "Empty type passed to intrinsic.");
861 
862     ArgListEntry Entry;
863     Entry.Val = V;
864     Entry.Ty = V->getType();
865     Entry.setAttributes(&CS, ArgI);
866     Args.push_back(Entry);
867   }
868 
869   Type *RetTy = ForceRetVoidTy ? Type::getVoidTy(CI->getType()->getContext())
870                                : CI->getType();
871   CLI.setCallee(CI->getCallingConv(), RetTy, Callee, std::move(Args), NumArgs);
872 
873   return lowerCallTo(CLI);
874 }
875 
876 FastISel::CallLoweringInfo &FastISel::CallLoweringInfo::setCallee(
877     const DataLayout &DL, MCContext &Ctx, CallingConv::ID CC, Type *ResultTy,
878     StringRef Target, ArgListTy &&ArgsList, unsigned FixedArgs) {
879   SmallString<32> MangledName;
880   Mangler::getNameWithPrefix(MangledName, Target, DL);
881   MCSymbol *Sym = Ctx.getOrCreateSymbol(MangledName);
882   return setCallee(CC, ResultTy, Sym, std::move(ArgsList), FixedArgs);
883 }
884 
885 bool FastISel::selectPatchpoint(const CallInst *I) {
886   // void|i64 @llvm.experimental.patchpoint.void|i64(i64 <id>,
887   //                                                 i32 <numBytes>,
888   //                                                 i8* <target>,
889   //                                                 i32 <numArgs>,
890   //                                                 [Args...],
891   //                                                 [live variables...])
892   CallingConv::ID CC = I->getCallingConv();
893   bool IsAnyRegCC = CC == CallingConv::AnyReg;
894   bool HasDef = !I->getType()->isVoidTy();
895   Value *Callee = I->getOperand(PatchPointOpers::TargetPos)->stripPointerCasts();
896 
897   // Get the real number of arguments participating in the call <numArgs>
898   assert(isa<ConstantInt>(I->getOperand(PatchPointOpers::NArgPos)) &&
899          "Expected a constant integer.");
900   const auto *NumArgsVal =
901       cast<ConstantInt>(I->getOperand(PatchPointOpers::NArgPos));
902   unsigned NumArgs = NumArgsVal->getZExtValue();
903 
904   // Skip the four meta args: <id>, <numNopBytes>, <target>, <numArgs>
905   // This includes all meta-operands up to but not including CC.
906   unsigned NumMetaOpers = PatchPointOpers::CCPos;
907   assert(I->getNumArgOperands() >= NumMetaOpers + NumArgs &&
908          "Not enough arguments provided to the patchpoint intrinsic");
909 
910   // For AnyRegCC the arguments are lowered later on manually.
911   unsigned NumCallArgs = IsAnyRegCC ? 0 : NumArgs;
912   CallLoweringInfo CLI;
913   CLI.setIsPatchPoint();
914   if (!lowerCallOperands(I, NumMetaOpers, NumCallArgs, Callee, IsAnyRegCC, CLI))
915     return false;
916 
917   assert(CLI.Call && "No call instruction specified.");
918 
919   SmallVector<MachineOperand, 32> Ops;
920 
921   // Add an explicit result reg if we use the anyreg calling convention.
922   if (IsAnyRegCC && HasDef) {
923     assert(CLI.NumResultRegs == 0 && "Unexpected result register.");
924     CLI.ResultReg = createResultReg(TLI.getRegClassFor(MVT::i64));
925     CLI.NumResultRegs = 1;
926     Ops.push_back(MachineOperand::CreateReg(CLI.ResultReg, /*IsDef=*/true));
927   }
928 
929   // Add the <id> and <numBytes> constants.
930   assert(isa<ConstantInt>(I->getOperand(PatchPointOpers::IDPos)) &&
931          "Expected a constant integer.");
932   const auto *ID = cast<ConstantInt>(I->getOperand(PatchPointOpers::IDPos));
933   Ops.push_back(MachineOperand::CreateImm(ID->getZExtValue()));
934 
935   assert(isa<ConstantInt>(I->getOperand(PatchPointOpers::NBytesPos)) &&
936          "Expected a constant integer.");
937   const auto *NumBytes =
938       cast<ConstantInt>(I->getOperand(PatchPointOpers::NBytesPos));
939   Ops.push_back(MachineOperand::CreateImm(NumBytes->getZExtValue()));
940 
941   // Add the call target.
942   if (const auto *C = dyn_cast<IntToPtrInst>(Callee)) {
943     uint64_t CalleeConstAddr =
944       cast<ConstantInt>(C->getOperand(0))->getZExtValue();
945     Ops.push_back(MachineOperand::CreateImm(CalleeConstAddr));
946   } else if (const auto *C = dyn_cast<ConstantExpr>(Callee)) {
947     if (C->getOpcode() == Instruction::IntToPtr) {
948       uint64_t CalleeConstAddr =
949         cast<ConstantInt>(C->getOperand(0))->getZExtValue();
950       Ops.push_back(MachineOperand::CreateImm(CalleeConstAddr));
951     } else
952       llvm_unreachable("Unsupported ConstantExpr.");
953   } else if (const auto *GV = dyn_cast<GlobalValue>(Callee)) {
954     Ops.push_back(MachineOperand::CreateGA(GV, 0));
955   } else if (isa<ConstantPointerNull>(Callee))
956     Ops.push_back(MachineOperand::CreateImm(0));
957   else
958     llvm_unreachable("Unsupported callee address.");
959 
960   // Adjust <numArgs> to account for any arguments that have been passed on
961   // the stack instead.
962   unsigned NumCallRegArgs = IsAnyRegCC ? NumArgs : CLI.OutRegs.size();
963   Ops.push_back(MachineOperand::CreateImm(NumCallRegArgs));
964 
965   // Add the calling convention
966   Ops.push_back(MachineOperand::CreateImm((unsigned)CC));
967 
968   // Add the arguments we omitted previously. The register allocator should
969   // place these in any free register.
970   if (IsAnyRegCC) {
971     for (unsigned i = NumMetaOpers, e = NumMetaOpers + NumArgs; i != e; ++i) {
972       unsigned Reg = getRegForValue(I->getArgOperand(i));
973       if (!Reg)
974         return false;
975       Ops.push_back(MachineOperand::CreateReg(Reg, /*IsDef=*/false));
976     }
977   }
978 
979   // Push the arguments from the call instruction.
980   for (auto Reg : CLI.OutRegs)
981     Ops.push_back(MachineOperand::CreateReg(Reg, /*IsDef=*/false));
982 
983   // Push live variables for the stack map.
984   if (!addStackMapLiveVars(Ops, I, NumMetaOpers + NumArgs))
985     return false;
986 
987   // Push the register mask info.
988   Ops.push_back(MachineOperand::CreateRegMask(
989       TRI.getCallPreservedMask(*FuncInfo.MF, CC)));
990 
991   // Add scratch registers as implicit def and early clobber.
992   const MCPhysReg *ScratchRegs = TLI.getScratchRegisters(CC);
993   for (unsigned i = 0; ScratchRegs[i]; ++i)
994     Ops.push_back(MachineOperand::CreateReg(
995         ScratchRegs[i], /*IsDef=*/true, /*IsImp=*/true, /*IsKill=*/false,
996         /*IsDead=*/false, /*IsUndef=*/false, /*IsEarlyClobber=*/true));
997 
998   // Add implicit defs (return values).
999   for (auto Reg : CLI.InRegs)
1000     Ops.push_back(MachineOperand::CreateReg(Reg, /*IsDef=*/true,
1001                                             /*IsImpl=*/true));
1002 
1003   // Insert the patchpoint instruction before the call generated by the target.
1004   MachineInstrBuilder MIB = BuildMI(*FuncInfo.MBB, CLI.Call, DbgLoc,
1005                                     TII.get(TargetOpcode::PATCHPOINT));
1006 
1007   for (auto &MO : Ops)
1008     MIB.add(MO);
1009 
1010   MIB->setPhysRegsDeadExcept(CLI.InRegs, TRI);
1011 
1012   // Delete the original call instruction.
1013   CLI.Call->eraseFromParent();
1014 
1015   // Inform the Frame Information that we have a patchpoint in this function.
1016   FuncInfo.MF->getFrameInfo().setHasPatchPoint();
1017 
1018   if (CLI.NumResultRegs)
1019     updateValueMap(I, CLI.ResultReg, CLI.NumResultRegs);
1020   return true;
1021 }
1022 
1023 bool FastISel::selectXRayCustomEvent(const CallInst *I) {
1024   const auto &Triple = TM.getTargetTriple();
1025   if (Triple.getArch() != Triple::x86_64 || !Triple.isOSLinux())
1026     return true; // don't do anything to this instruction.
1027   SmallVector<MachineOperand, 8> Ops;
1028   Ops.push_back(MachineOperand::CreateReg(getRegForValue(I->getArgOperand(0)),
1029                                           /*IsDef=*/false));
1030   Ops.push_back(MachineOperand::CreateReg(getRegForValue(I->getArgOperand(1)),
1031                                           /*IsDef=*/false));
1032   MachineInstrBuilder MIB =
1033       BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
1034               TII.get(TargetOpcode::PATCHABLE_EVENT_CALL));
1035   for (auto &MO : Ops)
1036     MIB.add(MO);
1037 
1038   // Insert the Patchable Event Call instruction, that gets lowered properly.
1039   return true;
1040 }
1041 
1042 bool FastISel::selectXRayTypedEvent(const CallInst *I) {
1043   const auto &Triple = TM.getTargetTriple();
1044   if (Triple.getArch() != Triple::x86_64 || !Triple.isOSLinux())
1045     return true; // don't do anything to this instruction.
1046   SmallVector<MachineOperand, 8> Ops;
1047   Ops.push_back(MachineOperand::CreateReg(getRegForValue(I->getArgOperand(0)),
1048                                           /*IsDef=*/false));
1049   Ops.push_back(MachineOperand::CreateReg(getRegForValue(I->getArgOperand(1)),
1050                                           /*IsDef=*/false));
1051   Ops.push_back(MachineOperand::CreateReg(getRegForValue(I->getArgOperand(2)),
1052                                           /*IsDef=*/false));
1053   MachineInstrBuilder MIB =
1054       BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
1055               TII.get(TargetOpcode::PATCHABLE_TYPED_EVENT_CALL));
1056   for (auto &MO : Ops)
1057     MIB.add(MO);
1058 
1059   // Insert the Patchable Typed Event Call instruction, that gets lowered properly.
1060   return true;
1061 }
1062 
1063 /// Returns an AttributeList representing the attributes applied to the return
1064 /// value of the given call.
1065 static AttributeList getReturnAttrs(FastISel::CallLoweringInfo &CLI) {
1066   SmallVector<Attribute::AttrKind, 2> Attrs;
1067   if (CLI.RetSExt)
1068     Attrs.push_back(Attribute::SExt);
1069   if (CLI.RetZExt)
1070     Attrs.push_back(Attribute::ZExt);
1071   if (CLI.IsInReg)
1072     Attrs.push_back(Attribute::InReg);
1073 
1074   return AttributeList::get(CLI.RetTy->getContext(), AttributeList::ReturnIndex,
1075                             Attrs);
1076 }
1077 
1078 bool FastISel::lowerCallTo(const CallInst *CI, const char *SymName,
1079                            unsigned NumArgs) {
1080   MCContext &Ctx = MF->getContext();
1081   SmallString<32> MangledName;
1082   Mangler::getNameWithPrefix(MangledName, SymName, DL);
1083   MCSymbol *Sym = Ctx.getOrCreateSymbol(MangledName);
1084   return lowerCallTo(CI, Sym, NumArgs);
1085 }
1086 
1087 bool FastISel::lowerCallTo(const CallInst *CI, MCSymbol *Symbol,
1088                            unsigned NumArgs) {
1089   ImmutableCallSite CS(CI);
1090 
1091   FunctionType *FTy = CS.getFunctionType();
1092   Type *RetTy = CS.getType();
1093 
1094   ArgListTy Args;
1095   Args.reserve(NumArgs);
1096 
1097   // Populate the argument list.
1098   // Attributes for args start at offset 1, after the return attribute.
1099   for (unsigned ArgI = 0; ArgI != NumArgs; ++ArgI) {
1100     Value *V = CI->getOperand(ArgI);
1101 
1102     assert(!V->getType()->isEmptyTy() && "Empty type passed to intrinsic.");
1103 
1104     ArgListEntry Entry;
1105     Entry.Val = V;
1106     Entry.Ty = V->getType();
1107     Entry.setAttributes(&CS, ArgI);
1108     Args.push_back(Entry);
1109   }
1110   TLI.markLibCallAttributes(MF, CS.getCallingConv(), Args);
1111 
1112   CallLoweringInfo CLI;
1113   CLI.setCallee(RetTy, FTy, Symbol, std::move(Args), CS, NumArgs);
1114 
1115   return lowerCallTo(CLI);
1116 }
1117 
1118 bool FastISel::lowerCallTo(CallLoweringInfo &CLI) {
1119   // Handle the incoming return values from the call.
1120   CLI.clearIns();
1121   SmallVector<EVT, 4> RetTys;
1122   ComputeValueVTs(TLI, DL, CLI.RetTy, RetTys);
1123 
1124   SmallVector<ISD::OutputArg, 4> Outs;
1125   GetReturnInfo(CLI.RetTy, getReturnAttrs(CLI), Outs, TLI, DL);
1126 
1127   bool CanLowerReturn = TLI.CanLowerReturn(
1128       CLI.CallConv, *FuncInfo.MF, CLI.IsVarArg, Outs, CLI.RetTy->getContext());
1129 
1130   // FIXME: sret demotion isn't supported yet - bail out.
1131   if (!CanLowerReturn)
1132     return false;
1133 
1134   for (unsigned I = 0, E = RetTys.size(); I != E; ++I) {
1135     EVT VT = RetTys[I];
1136     MVT RegisterVT = TLI.getRegisterType(CLI.RetTy->getContext(), VT);
1137     unsigned NumRegs = TLI.getNumRegisters(CLI.RetTy->getContext(), VT);
1138     for (unsigned i = 0; i != NumRegs; ++i) {
1139       ISD::InputArg MyFlags;
1140       MyFlags.VT = RegisterVT;
1141       MyFlags.ArgVT = VT;
1142       MyFlags.Used = CLI.IsReturnValueUsed;
1143       if (CLI.RetSExt)
1144         MyFlags.Flags.setSExt();
1145       if (CLI.RetZExt)
1146         MyFlags.Flags.setZExt();
1147       if (CLI.IsInReg)
1148         MyFlags.Flags.setInReg();
1149       CLI.Ins.push_back(MyFlags);
1150     }
1151   }
1152 
1153   // Handle all of the outgoing arguments.
1154   CLI.clearOuts();
1155   for (auto &Arg : CLI.getArgs()) {
1156     Type *FinalType = Arg.Ty;
1157     if (Arg.IsByVal)
1158       FinalType = cast<PointerType>(Arg.Ty)->getElementType();
1159     bool NeedsRegBlock = TLI.functionArgumentNeedsConsecutiveRegisters(
1160         FinalType, CLI.CallConv, CLI.IsVarArg);
1161 
1162     ISD::ArgFlagsTy Flags;
1163     if (Arg.IsZExt)
1164       Flags.setZExt();
1165     if (Arg.IsSExt)
1166       Flags.setSExt();
1167     if (Arg.IsInReg)
1168       Flags.setInReg();
1169     if (Arg.IsSRet)
1170       Flags.setSRet();
1171     if (Arg.IsSwiftSelf)
1172       Flags.setSwiftSelf();
1173     if (Arg.IsSwiftError)
1174       Flags.setSwiftError();
1175     if (Arg.IsByVal)
1176       Flags.setByVal();
1177     if (Arg.IsInAlloca) {
1178       Flags.setInAlloca();
1179       // Set the byval flag for CCAssignFn callbacks that don't know about
1180       // inalloca. This way we can know how many bytes we should've allocated
1181       // and how many bytes a callee cleanup function will pop.  If we port
1182       // inalloca to more targets, we'll have to add custom inalloca handling in
1183       // the various CC lowering callbacks.
1184       Flags.setByVal();
1185     }
1186     if (Arg.IsByVal || Arg.IsInAlloca) {
1187       PointerType *Ty = cast<PointerType>(Arg.Ty);
1188       Type *ElementTy = Ty->getElementType();
1189       unsigned FrameSize = DL.getTypeAllocSize(ElementTy);
1190       // For ByVal, alignment should come from FE. BE will guess if this info is
1191       // not there, but there are cases it cannot get right.
1192       unsigned FrameAlign = Arg.Alignment;
1193       if (!FrameAlign)
1194         FrameAlign = TLI.getByValTypeAlignment(ElementTy, DL);
1195       Flags.setByValSize(FrameSize);
1196       Flags.setByValAlign(FrameAlign);
1197     }
1198     if (Arg.IsNest)
1199       Flags.setNest();
1200     if (NeedsRegBlock)
1201       Flags.setInConsecutiveRegs();
1202     unsigned OriginalAlignment = DL.getABITypeAlignment(Arg.Ty);
1203     Flags.setOrigAlign(OriginalAlignment);
1204 
1205     CLI.OutVals.push_back(Arg.Val);
1206     CLI.OutFlags.push_back(Flags);
1207   }
1208 
1209   if (!fastLowerCall(CLI))
1210     return false;
1211 
1212   // Set all unused physreg defs as dead.
1213   assert(CLI.Call && "No call instruction specified.");
1214   CLI.Call->setPhysRegsDeadExcept(CLI.InRegs, TRI);
1215 
1216   if (CLI.NumResultRegs && CLI.CS)
1217     updateValueMap(CLI.CS->getInstruction(), CLI.ResultReg, CLI.NumResultRegs);
1218 
1219   return true;
1220 }
1221 
1222 bool FastISel::lowerCall(const CallInst *CI) {
1223   ImmutableCallSite CS(CI);
1224 
1225   FunctionType *FuncTy = CS.getFunctionType();
1226   Type *RetTy = CS.getType();
1227 
1228   ArgListTy Args;
1229   ArgListEntry Entry;
1230   Args.reserve(CS.arg_size());
1231 
1232   for (ImmutableCallSite::arg_iterator i = CS.arg_begin(), e = CS.arg_end();
1233        i != e; ++i) {
1234     Value *V = *i;
1235 
1236     // Skip empty types
1237     if (V->getType()->isEmptyTy())
1238       continue;
1239 
1240     Entry.Val = V;
1241     Entry.Ty = V->getType();
1242 
1243     // Skip the first return-type Attribute to get to params.
1244     Entry.setAttributes(&CS, i - CS.arg_begin());
1245     Args.push_back(Entry);
1246   }
1247 
1248   // Check if target-independent constraints permit a tail call here.
1249   // Target-dependent constraints are checked within fastLowerCall.
1250   bool IsTailCall = CI->isTailCall();
1251   if (IsTailCall && !isInTailCallPosition(CS, TM))
1252     IsTailCall = false;
1253 
1254   CallLoweringInfo CLI;
1255   CLI.setCallee(RetTy, FuncTy, CI->getCalledValue(), std::move(Args), CS)
1256       .setTailCall(IsTailCall);
1257 
1258   return lowerCallTo(CLI);
1259 }
1260 
1261 bool FastISel::selectCall(const User *I) {
1262   const CallInst *Call = cast<CallInst>(I);
1263 
1264   // Handle simple inline asms.
1265   if (const InlineAsm *IA = dyn_cast<InlineAsm>(Call->getCalledValue())) {
1266     // If the inline asm has side effects, then make sure that no local value
1267     // lives across by flushing the local value map.
1268     if (IA->hasSideEffects())
1269       flushLocalValueMap();
1270 
1271     // Don't attempt to handle constraints.
1272     if (!IA->getConstraintString().empty())
1273       return false;
1274 
1275     unsigned ExtraInfo = 0;
1276     if (IA->hasSideEffects())
1277       ExtraInfo |= InlineAsm::Extra_HasSideEffects;
1278     if (IA->isAlignStack())
1279       ExtraInfo |= InlineAsm::Extra_IsAlignStack;
1280 
1281     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
1282             TII.get(TargetOpcode::INLINEASM))
1283         .addExternalSymbol(IA->getAsmString().c_str())
1284         .addImm(ExtraInfo);
1285     return true;
1286   }
1287 
1288   MachineModuleInfo &MMI = FuncInfo.MF->getMMI();
1289   computeUsesVAFloatArgument(*Call, MMI);
1290 
1291   // Handle intrinsic function calls.
1292   if (const auto *II = dyn_cast<IntrinsicInst>(Call))
1293     return selectIntrinsicCall(II);
1294 
1295   // Usually, it does not make sense to initialize a value,
1296   // make an unrelated function call and use the value, because
1297   // it tends to be spilled on the stack. So, we move the pointer
1298   // to the last local value to the beginning of the block, so that
1299   // all the values which have already been materialized,
1300   // appear after the call. It also makes sense to skip intrinsics
1301   // since they tend to be inlined.
1302   flushLocalValueMap();
1303 
1304   return lowerCall(Call);
1305 }
1306 
1307 bool FastISel::selectIntrinsicCall(const IntrinsicInst *II) {
1308   switch (II->getIntrinsicID()) {
1309   default:
1310     break;
1311   // At -O0 we don't care about the lifetime intrinsics.
1312   case Intrinsic::lifetime_start:
1313   case Intrinsic::lifetime_end:
1314   // The donothing intrinsic does, well, nothing.
1315   case Intrinsic::donothing:
1316   // Neither does the sideeffect intrinsic.
1317   case Intrinsic::sideeffect:
1318   // Neither does the assume intrinsic; it's also OK not to codegen its operand.
1319   case Intrinsic::assume:
1320     return true;
1321   case Intrinsic::dbg_declare: {
1322     const DbgDeclareInst *DI = cast<DbgDeclareInst>(II);
1323     assert(DI->getVariable() && "Missing variable");
1324     if (!FuncInfo.MF->getMMI().hasDebugInfo()) {
1325       DEBUG(dbgs() << "Dropping debug info for " << *DI << "\n");
1326       return true;
1327     }
1328 
1329     const Value *Address = DI->getAddress();
1330     if (!Address || isa<UndefValue>(Address)) {
1331       DEBUG(dbgs() << "Dropping debug info for " << *DI << "\n");
1332       return true;
1333     }
1334 
1335     // Byval arguments with frame indices were already handled after argument
1336     // lowering and before isel.
1337     const auto *Arg =
1338         dyn_cast<Argument>(Address->stripInBoundsConstantOffsets());
1339     if (Arg && FuncInfo.getArgumentFrameIndex(Arg) != INT_MAX)
1340       return true;
1341 
1342     Optional<MachineOperand> Op;
1343     if (unsigned Reg = lookUpRegForValue(Address))
1344       Op = MachineOperand::CreateReg(Reg, false);
1345 
1346     // If we have a VLA that has a "use" in a metadata node that's then used
1347     // here but it has no other uses, then we have a problem. E.g.,
1348     //
1349     //   int foo (const int *x) {
1350     //     char a[*x];
1351     //     return 0;
1352     //   }
1353     //
1354     // If we assign 'a' a vreg and fast isel later on has to use the selection
1355     // DAG isel, it will want to copy the value to the vreg. However, there are
1356     // no uses, which goes counter to what selection DAG isel expects.
1357     if (!Op && !Address->use_empty() && isa<Instruction>(Address) &&
1358         (!isa<AllocaInst>(Address) ||
1359          !FuncInfo.StaticAllocaMap.count(cast<AllocaInst>(Address))))
1360       Op = MachineOperand::CreateReg(FuncInfo.InitializeRegForValue(Address),
1361                                      false);
1362 
1363     if (Op) {
1364       assert(DI->getVariable()->isValidLocationForIntrinsic(DbgLoc) &&
1365              "Expected inlined-at fields to agree");
1366       if (Op->isReg()) {
1367         Op->setIsDebug(true);
1368         // A dbg.declare describes the address of a source variable, so lower it
1369         // into an indirect DBG_VALUE.
1370         BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
1371                 TII.get(TargetOpcode::DBG_VALUE), /*IsIndirect*/ true,
1372                 Op->getReg(), DI->getVariable(), DI->getExpression());
1373       } else
1374         BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
1375                 TII.get(TargetOpcode::DBG_VALUE))
1376             .add(*Op)
1377             .addImm(0)
1378             .addMetadata(DI->getVariable())
1379             .addMetadata(DI->getExpression());
1380     } else {
1381       // We can't yet handle anything else here because it would require
1382       // generating code, thus altering codegen because of debug info.
1383       DEBUG(dbgs() << "Dropping debug info for " << *DI << "\n");
1384     }
1385     return true;
1386   }
1387   case Intrinsic::dbg_value: {
1388     // This form of DBG_VALUE is target-independent.
1389     const DbgValueInst *DI = cast<DbgValueInst>(II);
1390     const MCInstrDesc &II = TII.get(TargetOpcode::DBG_VALUE);
1391     const Value *V = DI->getValue();
1392     assert(DI->getVariable()->isValidLocationForIntrinsic(DbgLoc) &&
1393            "Expected inlined-at fields to agree");
1394     if (!V) {
1395       // Currently the optimizer can produce this; insert an undef to
1396       // help debugging.  Probably the optimizer should not do this.
1397       BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II, false, 0U,
1398               DI->getVariable(), DI->getExpression());
1399     } else if (const auto *CI = dyn_cast<ConstantInt>(V)) {
1400       if (CI->getBitWidth() > 64)
1401         BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II)
1402             .addCImm(CI)
1403             .addImm(0U)
1404             .addMetadata(DI->getVariable())
1405             .addMetadata(DI->getExpression());
1406       else
1407         BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II)
1408             .addImm(CI->getZExtValue())
1409             .addImm(0U)
1410             .addMetadata(DI->getVariable())
1411             .addMetadata(DI->getExpression());
1412     } else if (const auto *CF = dyn_cast<ConstantFP>(V)) {
1413       BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II)
1414           .addFPImm(CF)
1415           .addImm(0U)
1416           .addMetadata(DI->getVariable())
1417           .addMetadata(DI->getExpression());
1418     } else if (unsigned Reg = lookUpRegForValue(V)) {
1419       // FIXME: This does not handle register-indirect values at offset 0.
1420       bool IsIndirect = false;
1421       BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II, IsIndirect, Reg,
1422               DI->getVariable(), DI->getExpression());
1423     } else {
1424       // We can't yet handle anything else here because it would require
1425       // generating code, thus altering codegen because of debug info.
1426       DEBUG(dbgs() << "Dropping debug info for " << *DI << "\n");
1427     }
1428     return true;
1429   }
1430   case Intrinsic::objectsize: {
1431     ConstantInt *CI = cast<ConstantInt>(II->getArgOperand(1));
1432     unsigned long long Res = CI->isZero() ? -1ULL : 0;
1433     Constant *ResCI = ConstantInt::get(II->getType(), Res);
1434     unsigned ResultReg = getRegForValue(ResCI);
1435     if (!ResultReg)
1436       return false;
1437     updateValueMap(II, ResultReg);
1438     return true;
1439   }
1440   case Intrinsic::invariant_group_barrier:
1441   case Intrinsic::expect: {
1442     unsigned ResultReg = getRegForValue(II->getArgOperand(0));
1443     if (!ResultReg)
1444       return false;
1445     updateValueMap(II, ResultReg);
1446     return true;
1447   }
1448   case Intrinsic::experimental_stackmap:
1449     return selectStackmap(II);
1450   case Intrinsic::experimental_patchpoint_void:
1451   case Intrinsic::experimental_patchpoint_i64:
1452     return selectPatchpoint(II);
1453 
1454   case Intrinsic::xray_customevent:
1455     return selectXRayCustomEvent(II);
1456   case Intrinsic::xray_typedevent:
1457     return selectXRayTypedEvent(II);
1458   }
1459 
1460   return fastLowerIntrinsicCall(II);
1461 }
1462 
1463 bool FastISel::selectCast(const User *I, unsigned Opcode) {
1464   EVT SrcVT = TLI.getValueType(DL, I->getOperand(0)->getType());
1465   EVT DstVT = TLI.getValueType(DL, I->getType());
1466 
1467   if (SrcVT == MVT::Other || !SrcVT.isSimple() || DstVT == MVT::Other ||
1468       !DstVT.isSimple())
1469     // Unhandled type. Halt "fast" selection and bail.
1470     return false;
1471 
1472   // Check if the destination type is legal.
1473   if (!TLI.isTypeLegal(DstVT))
1474     return false;
1475 
1476   // Check if the source operand is legal.
1477   if (!TLI.isTypeLegal(SrcVT))
1478     return false;
1479 
1480   unsigned InputReg = getRegForValue(I->getOperand(0));
1481   if (!InputReg)
1482     // Unhandled operand.  Halt "fast" selection and bail.
1483     return false;
1484 
1485   bool InputRegIsKill = hasTrivialKill(I->getOperand(0));
1486 
1487   unsigned ResultReg = fastEmit_r(SrcVT.getSimpleVT(), DstVT.getSimpleVT(),
1488                                   Opcode, InputReg, InputRegIsKill);
1489   if (!ResultReg)
1490     return false;
1491 
1492   updateValueMap(I, ResultReg);
1493   return true;
1494 }
1495 
1496 bool FastISel::selectBitCast(const User *I) {
1497   // If the bitcast doesn't change the type, just use the operand value.
1498   if (I->getType() == I->getOperand(0)->getType()) {
1499     unsigned Reg = getRegForValue(I->getOperand(0));
1500     if (!Reg)
1501       return false;
1502     updateValueMap(I, Reg);
1503     return true;
1504   }
1505 
1506   // Bitcasts of other values become reg-reg copies or BITCAST operators.
1507   EVT SrcEVT = TLI.getValueType(DL, I->getOperand(0)->getType());
1508   EVT DstEVT = TLI.getValueType(DL, I->getType());
1509   if (SrcEVT == MVT::Other || DstEVT == MVT::Other ||
1510       !TLI.isTypeLegal(SrcEVT) || !TLI.isTypeLegal(DstEVT))
1511     // Unhandled type. Halt "fast" selection and bail.
1512     return false;
1513 
1514   MVT SrcVT = SrcEVT.getSimpleVT();
1515   MVT DstVT = DstEVT.getSimpleVT();
1516   unsigned Op0 = getRegForValue(I->getOperand(0));
1517   if (!Op0) // Unhandled operand. Halt "fast" selection and bail.
1518     return false;
1519   bool Op0IsKill = hasTrivialKill(I->getOperand(0));
1520 
1521   // First, try to perform the bitcast by inserting a reg-reg copy.
1522   unsigned ResultReg = 0;
1523   if (SrcVT == DstVT) {
1524     const TargetRegisterClass *SrcClass = TLI.getRegClassFor(SrcVT);
1525     const TargetRegisterClass *DstClass = TLI.getRegClassFor(DstVT);
1526     // Don't attempt a cross-class copy. It will likely fail.
1527     if (SrcClass == DstClass) {
1528       ResultReg = createResultReg(DstClass);
1529       BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
1530               TII.get(TargetOpcode::COPY), ResultReg).addReg(Op0);
1531     }
1532   }
1533 
1534   // If the reg-reg copy failed, select a BITCAST opcode.
1535   if (!ResultReg)
1536     ResultReg = fastEmit_r(SrcVT, DstVT, ISD::BITCAST, Op0, Op0IsKill);
1537 
1538   if (!ResultReg)
1539     return false;
1540 
1541   updateValueMap(I, ResultReg);
1542   return true;
1543 }
1544 
1545 // Remove local value instructions starting from the instruction after
1546 // SavedLastLocalValue to the current function insert point.
1547 void FastISel::removeDeadLocalValueCode(MachineInstr *SavedLastLocalValue)
1548 {
1549   MachineInstr *CurLastLocalValue = getLastLocalValue();
1550   if (CurLastLocalValue != SavedLastLocalValue) {
1551     // Find the first local value instruction to be deleted.
1552     // This is the instruction after SavedLastLocalValue if it is non-NULL.
1553     // Otherwise it's the first instruction in the block.
1554     MachineBasicBlock::iterator FirstDeadInst(SavedLastLocalValue);
1555     if (SavedLastLocalValue)
1556       ++FirstDeadInst;
1557     else
1558       FirstDeadInst = FuncInfo.MBB->getFirstNonPHI();
1559     setLastLocalValue(SavedLastLocalValue);
1560     removeDeadCode(FirstDeadInst, FuncInfo.InsertPt);
1561   }
1562 }
1563 
1564 bool FastISel::selectInstruction(const Instruction *I) {
1565   MachineInstr *SavedLastLocalValue = getLastLocalValue();
1566   // Just before the terminator instruction, insert instructions to
1567   // feed PHI nodes in successor blocks.
1568   if (isa<TerminatorInst>(I)) {
1569     if (!handlePHINodesInSuccessorBlocks(I->getParent())) {
1570       // PHI node handling may have generated local value instructions,
1571       // even though it failed to handle all PHI nodes.
1572       // We remove these instructions because SelectionDAGISel will generate
1573       // them again.
1574       removeDeadLocalValueCode(SavedLastLocalValue);
1575       return false;
1576     }
1577   }
1578 
1579   // FastISel does not handle any operand bundles except OB_funclet.
1580   if (ImmutableCallSite CS = ImmutableCallSite(I))
1581     for (unsigned i = 0, e = CS.getNumOperandBundles(); i != e; ++i)
1582       if (CS.getOperandBundleAt(i).getTagID() != LLVMContext::OB_funclet)
1583         return false;
1584 
1585   DbgLoc = I->getDebugLoc();
1586 
1587   SavedInsertPt = FuncInfo.InsertPt;
1588 
1589   if (const auto *Call = dyn_cast<CallInst>(I)) {
1590     const Function *F = Call->getCalledFunction();
1591     LibFunc Func;
1592 
1593     // As a special case, don't handle calls to builtin library functions that
1594     // may be translated directly to target instructions.
1595     if (F && !F->hasLocalLinkage() && F->hasName() &&
1596         LibInfo->getLibFunc(F->getName(), Func) &&
1597         LibInfo->hasOptimizedCodeGen(Func))
1598       return false;
1599 
1600     // Don't handle Intrinsic::trap if a trap function is specified.
1601     if (F && F->getIntrinsicID() == Intrinsic::trap &&
1602         Call->hasFnAttr("trap-func-name"))
1603       return false;
1604   }
1605 
1606   // First, try doing target-independent selection.
1607   if (!SkipTargetIndependentISel) {
1608     if (selectOperator(I, I->getOpcode())) {
1609       ++NumFastIselSuccessIndependent;
1610       DbgLoc = DebugLoc();
1611       return true;
1612     }
1613     // Remove dead code.
1614     recomputeInsertPt();
1615     if (SavedInsertPt != FuncInfo.InsertPt)
1616       removeDeadCode(FuncInfo.InsertPt, SavedInsertPt);
1617     SavedInsertPt = FuncInfo.InsertPt;
1618   }
1619   // Next, try calling the target to attempt to handle the instruction.
1620   if (fastSelectInstruction(I)) {
1621     ++NumFastIselSuccessTarget;
1622     DbgLoc = DebugLoc();
1623     return true;
1624   }
1625   // Remove dead code.
1626   recomputeInsertPt();
1627   if (SavedInsertPt != FuncInfo.InsertPt)
1628     removeDeadCode(FuncInfo.InsertPt, SavedInsertPt);
1629 
1630   DbgLoc = DebugLoc();
1631   // Undo phi node updates, because they will be added again by SelectionDAG.
1632   if (isa<TerminatorInst>(I)) {
1633     // PHI node handling may have generated local value instructions.
1634     // We remove them because SelectionDAGISel will generate them again.
1635     removeDeadLocalValueCode(SavedLastLocalValue);
1636     FuncInfo.PHINodesToUpdate.resize(FuncInfo.OrigNumPHINodesToUpdate);
1637   }
1638   return false;
1639 }
1640 
1641 /// Emit an unconditional branch to the given block, unless it is the immediate
1642 /// (fall-through) successor, and update the CFG.
1643 void FastISel::fastEmitBranch(MachineBasicBlock *MSucc,
1644                               const DebugLoc &DbgLoc) {
1645   if (FuncInfo.MBB->getBasicBlock()->size() > 1 &&
1646       FuncInfo.MBB->isLayoutSuccessor(MSucc)) {
1647     // For more accurate line information if this is the only instruction
1648     // in the block then emit it, otherwise we have the unconditional
1649     // fall-through case, which needs no instructions.
1650   } else {
1651     // The unconditional branch case.
1652     TII.insertBranch(*FuncInfo.MBB, MSucc, nullptr,
1653                      SmallVector<MachineOperand, 0>(), DbgLoc);
1654   }
1655   if (FuncInfo.BPI) {
1656     auto BranchProbability = FuncInfo.BPI->getEdgeProbability(
1657         FuncInfo.MBB->getBasicBlock(), MSucc->getBasicBlock());
1658     FuncInfo.MBB->addSuccessor(MSucc, BranchProbability);
1659   } else
1660     FuncInfo.MBB->addSuccessorWithoutProb(MSucc);
1661 }
1662 
1663 void FastISel::finishCondBranch(const BasicBlock *BranchBB,
1664                                 MachineBasicBlock *TrueMBB,
1665                                 MachineBasicBlock *FalseMBB) {
1666   // Add TrueMBB as successor unless it is equal to the FalseMBB: This can
1667   // happen in degenerate IR and MachineIR forbids to have a block twice in the
1668   // successor/predecessor lists.
1669   if (TrueMBB != FalseMBB) {
1670     if (FuncInfo.BPI) {
1671       auto BranchProbability =
1672           FuncInfo.BPI->getEdgeProbability(BranchBB, TrueMBB->getBasicBlock());
1673       FuncInfo.MBB->addSuccessor(TrueMBB, BranchProbability);
1674     } else
1675       FuncInfo.MBB->addSuccessorWithoutProb(TrueMBB);
1676   }
1677 
1678   fastEmitBranch(FalseMBB, DbgLoc);
1679 }
1680 
1681 /// Emit an FNeg operation.
1682 bool FastISel::selectFNeg(const User *I) {
1683   unsigned OpReg = getRegForValue(BinaryOperator::getFNegArgument(I));
1684   if (!OpReg)
1685     return false;
1686   bool OpRegIsKill = hasTrivialKill(I);
1687 
1688   // If the target has ISD::FNEG, use it.
1689   EVT VT = TLI.getValueType(DL, I->getType());
1690   unsigned ResultReg = fastEmit_r(VT.getSimpleVT(), VT.getSimpleVT(), ISD::FNEG,
1691                                   OpReg, OpRegIsKill);
1692   if (ResultReg) {
1693     updateValueMap(I, ResultReg);
1694     return true;
1695   }
1696 
1697   // Bitcast the value to integer, twiddle the sign bit with xor,
1698   // and then bitcast it back to floating-point.
1699   if (VT.getSizeInBits() > 64)
1700     return false;
1701   EVT IntVT = EVT::getIntegerVT(I->getContext(), VT.getSizeInBits());
1702   if (!TLI.isTypeLegal(IntVT))
1703     return false;
1704 
1705   unsigned IntReg = fastEmit_r(VT.getSimpleVT(), IntVT.getSimpleVT(),
1706                                ISD::BITCAST, OpReg, OpRegIsKill);
1707   if (!IntReg)
1708     return false;
1709 
1710   unsigned IntResultReg = fastEmit_ri_(
1711       IntVT.getSimpleVT(), ISD::XOR, IntReg, /*IsKill=*/true,
1712       UINT64_C(1) << (VT.getSizeInBits() - 1), IntVT.getSimpleVT());
1713   if (!IntResultReg)
1714     return false;
1715 
1716   ResultReg = fastEmit_r(IntVT.getSimpleVT(), VT.getSimpleVT(), ISD::BITCAST,
1717                          IntResultReg, /*IsKill=*/true);
1718   if (!ResultReg)
1719     return false;
1720 
1721   updateValueMap(I, ResultReg);
1722   return true;
1723 }
1724 
1725 bool FastISel::selectExtractValue(const User *U) {
1726   const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(U);
1727   if (!EVI)
1728     return false;
1729 
1730   // Make sure we only try to handle extracts with a legal result.  But also
1731   // allow i1 because it's easy.
1732   EVT RealVT = TLI.getValueType(DL, EVI->getType(), /*AllowUnknown=*/true);
1733   if (!RealVT.isSimple())
1734     return false;
1735   MVT VT = RealVT.getSimpleVT();
1736   if (!TLI.isTypeLegal(VT) && VT != MVT::i1)
1737     return false;
1738 
1739   const Value *Op0 = EVI->getOperand(0);
1740   Type *AggTy = Op0->getType();
1741 
1742   // Get the base result register.
1743   unsigned ResultReg;
1744   DenseMap<const Value *, unsigned>::iterator I = FuncInfo.ValueMap.find(Op0);
1745   if (I != FuncInfo.ValueMap.end())
1746     ResultReg = I->second;
1747   else if (isa<Instruction>(Op0))
1748     ResultReg = FuncInfo.InitializeRegForValue(Op0);
1749   else
1750     return false; // fast-isel can't handle aggregate constants at the moment
1751 
1752   // Get the actual result register, which is an offset from the base register.
1753   unsigned VTIndex = ComputeLinearIndex(AggTy, EVI->getIndices());
1754 
1755   SmallVector<EVT, 4> AggValueVTs;
1756   ComputeValueVTs(TLI, DL, AggTy, AggValueVTs);
1757 
1758   for (unsigned i = 0; i < VTIndex; i++)
1759     ResultReg += TLI.getNumRegisters(FuncInfo.Fn->getContext(), AggValueVTs[i]);
1760 
1761   updateValueMap(EVI, ResultReg);
1762   return true;
1763 }
1764 
1765 bool FastISel::selectOperator(const User *I, unsigned Opcode) {
1766   switch (Opcode) {
1767   case Instruction::Add:
1768     return selectBinaryOp(I, ISD::ADD);
1769   case Instruction::FAdd:
1770     return selectBinaryOp(I, ISD::FADD);
1771   case Instruction::Sub:
1772     return selectBinaryOp(I, ISD::SUB);
1773   case Instruction::FSub:
1774     // FNeg is currently represented in LLVM IR as a special case of FSub.
1775     if (BinaryOperator::isFNeg(I))
1776       return selectFNeg(I);
1777     return selectBinaryOp(I, ISD::FSUB);
1778   case Instruction::Mul:
1779     return selectBinaryOp(I, ISD::MUL);
1780   case Instruction::FMul:
1781     return selectBinaryOp(I, ISD::FMUL);
1782   case Instruction::SDiv:
1783     return selectBinaryOp(I, ISD::SDIV);
1784   case Instruction::UDiv:
1785     return selectBinaryOp(I, ISD::UDIV);
1786   case Instruction::FDiv:
1787     return selectBinaryOp(I, ISD::FDIV);
1788   case Instruction::SRem:
1789     return selectBinaryOp(I, ISD::SREM);
1790   case Instruction::URem:
1791     return selectBinaryOp(I, ISD::UREM);
1792   case Instruction::FRem:
1793     return selectBinaryOp(I, ISD::FREM);
1794   case Instruction::Shl:
1795     return selectBinaryOp(I, ISD::SHL);
1796   case Instruction::LShr:
1797     return selectBinaryOp(I, ISD::SRL);
1798   case Instruction::AShr:
1799     return selectBinaryOp(I, ISD::SRA);
1800   case Instruction::And:
1801     return selectBinaryOp(I, ISD::AND);
1802   case Instruction::Or:
1803     return selectBinaryOp(I, ISD::OR);
1804   case Instruction::Xor:
1805     return selectBinaryOp(I, ISD::XOR);
1806 
1807   case Instruction::GetElementPtr:
1808     return selectGetElementPtr(I);
1809 
1810   case Instruction::Br: {
1811     const BranchInst *BI = cast<BranchInst>(I);
1812 
1813     if (BI->isUnconditional()) {
1814       const BasicBlock *LLVMSucc = BI->getSuccessor(0);
1815       MachineBasicBlock *MSucc = FuncInfo.MBBMap[LLVMSucc];
1816       fastEmitBranch(MSucc, BI->getDebugLoc());
1817       return true;
1818     }
1819 
1820     // Conditional branches are not handed yet.
1821     // Halt "fast" selection and bail.
1822     return false;
1823   }
1824 
1825   case Instruction::Unreachable:
1826     if (TM.Options.TrapUnreachable)
1827       return fastEmit_(MVT::Other, MVT::Other, ISD::TRAP) != 0;
1828     else
1829       return true;
1830 
1831   case Instruction::Alloca:
1832     // FunctionLowering has the static-sized case covered.
1833     if (FuncInfo.StaticAllocaMap.count(cast<AllocaInst>(I)))
1834       return true;
1835 
1836     // Dynamic-sized alloca is not handled yet.
1837     return false;
1838 
1839   case Instruction::Call:
1840     return selectCall(I);
1841 
1842   case Instruction::BitCast:
1843     return selectBitCast(I);
1844 
1845   case Instruction::FPToSI:
1846     return selectCast(I, ISD::FP_TO_SINT);
1847   case Instruction::ZExt:
1848     return selectCast(I, ISD::ZERO_EXTEND);
1849   case Instruction::SExt:
1850     return selectCast(I, ISD::SIGN_EXTEND);
1851   case Instruction::Trunc:
1852     return selectCast(I, ISD::TRUNCATE);
1853   case Instruction::SIToFP:
1854     return selectCast(I, ISD::SINT_TO_FP);
1855 
1856   case Instruction::IntToPtr: // Deliberate fall-through.
1857   case Instruction::PtrToInt: {
1858     EVT SrcVT = TLI.getValueType(DL, I->getOperand(0)->getType());
1859     EVT DstVT = TLI.getValueType(DL, I->getType());
1860     if (DstVT.bitsGT(SrcVT))
1861       return selectCast(I, ISD::ZERO_EXTEND);
1862     if (DstVT.bitsLT(SrcVT))
1863       return selectCast(I, ISD::TRUNCATE);
1864     unsigned Reg = getRegForValue(I->getOperand(0));
1865     if (!Reg)
1866       return false;
1867     updateValueMap(I, Reg);
1868     return true;
1869   }
1870 
1871   case Instruction::ExtractValue:
1872     return selectExtractValue(I);
1873 
1874   case Instruction::PHI:
1875     llvm_unreachable("FastISel shouldn't visit PHI nodes!");
1876 
1877   default:
1878     // Unhandled instruction. Halt "fast" selection and bail.
1879     return false;
1880   }
1881 }
1882 
1883 FastISel::FastISel(FunctionLoweringInfo &FuncInfo,
1884                    const TargetLibraryInfo *LibInfo,
1885                    bool SkipTargetIndependentISel)
1886     : FuncInfo(FuncInfo), MF(FuncInfo.MF), MRI(FuncInfo.MF->getRegInfo()),
1887       MFI(FuncInfo.MF->getFrameInfo()), MCP(*FuncInfo.MF->getConstantPool()),
1888       TM(FuncInfo.MF->getTarget()), DL(MF->getDataLayout()),
1889       TII(*MF->getSubtarget().getInstrInfo()),
1890       TLI(*MF->getSubtarget().getTargetLowering()),
1891       TRI(*MF->getSubtarget().getRegisterInfo()), LibInfo(LibInfo),
1892       SkipTargetIndependentISel(SkipTargetIndependentISel) {}
1893 
1894 FastISel::~FastISel() = default;
1895 
1896 bool FastISel::fastLowerArguments() { return false; }
1897 
1898 bool FastISel::fastLowerCall(CallLoweringInfo & /*CLI*/) { return false; }
1899 
1900 bool FastISel::fastLowerIntrinsicCall(const IntrinsicInst * /*II*/) {
1901   return false;
1902 }
1903 
1904 unsigned FastISel::fastEmit_(MVT, MVT, unsigned) { return 0; }
1905 
1906 unsigned FastISel::fastEmit_r(MVT, MVT, unsigned, unsigned /*Op0*/,
1907                               bool /*Op0IsKill*/) {
1908   return 0;
1909 }
1910 
1911 unsigned FastISel::fastEmit_rr(MVT, MVT, unsigned, unsigned /*Op0*/,
1912                                bool /*Op0IsKill*/, unsigned /*Op1*/,
1913                                bool /*Op1IsKill*/) {
1914   return 0;
1915 }
1916 
1917 unsigned FastISel::fastEmit_i(MVT, MVT, unsigned, uint64_t /*Imm*/) {
1918   return 0;
1919 }
1920 
1921 unsigned FastISel::fastEmit_f(MVT, MVT, unsigned,
1922                               const ConstantFP * /*FPImm*/) {
1923   return 0;
1924 }
1925 
1926 unsigned FastISel::fastEmit_ri(MVT, MVT, unsigned, unsigned /*Op0*/,
1927                                bool /*Op0IsKill*/, uint64_t /*Imm*/) {
1928   return 0;
1929 }
1930 
1931 /// This method is a wrapper of fastEmit_ri. It first tries to emit an
1932 /// instruction with an immediate operand using fastEmit_ri.
1933 /// If that fails, it materializes the immediate into a register and try
1934 /// fastEmit_rr instead.
1935 unsigned FastISel::fastEmit_ri_(MVT VT, unsigned Opcode, unsigned Op0,
1936                                 bool Op0IsKill, uint64_t Imm, MVT ImmType) {
1937   // If this is a multiply by a power of two, emit this as a shift left.
1938   if (Opcode == ISD::MUL && isPowerOf2_64(Imm)) {
1939     Opcode = ISD::SHL;
1940     Imm = Log2_64(Imm);
1941   } else if (Opcode == ISD::UDIV && isPowerOf2_64(Imm)) {
1942     // div x, 8 -> srl x, 3
1943     Opcode = ISD::SRL;
1944     Imm = Log2_64(Imm);
1945   }
1946 
1947   // Horrible hack (to be removed), check to make sure shift amounts are
1948   // in-range.
1949   if ((Opcode == ISD::SHL || Opcode == ISD::SRA || Opcode == ISD::SRL) &&
1950       Imm >= VT.getSizeInBits())
1951     return 0;
1952 
1953   // First check if immediate type is legal. If not, we can't use the ri form.
1954   unsigned ResultReg = fastEmit_ri(VT, VT, Opcode, Op0, Op0IsKill, Imm);
1955   if (ResultReg)
1956     return ResultReg;
1957   unsigned MaterialReg = fastEmit_i(ImmType, ImmType, ISD::Constant, Imm);
1958   bool IsImmKill = true;
1959   if (!MaterialReg) {
1960     // This is a bit ugly/slow, but failing here means falling out of
1961     // fast-isel, which would be very slow.
1962     IntegerType *ITy =
1963         IntegerType::get(FuncInfo.Fn->getContext(), VT.getSizeInBits());
1964     MaterialReg = getRegForValue(ConstantInt::get(ITy, Imm));
1965     if (!MaterialReg)
1966       return 0;
1967     // FIXME: If the materialized register here has no uses yet then this
1968     // will be the first use and we should be able to mark it as killed.
1969     // However, the local value area for materialising constant expressions
1970     // grows down, not up, which means that any constant expressions we generate
1971     // later which also use 'Imm' could be after this instruction and therefore
1972     // after this kill.
1973     IsImmKill = false;
1974   }
1975   return fastEmit_rr(VT, VT, Opcode, Op0, Op0IsKill, MaterialReg, IsImmKill);
1976 }
1977 
1978 unsigned FastISel::createResultReg(const TargetRegisterClass *RC) {
1979   return MRI.createVirtualRegister(RC);
1980 }
1981 
1982 unsigned FastISel::constrainOperandRegClass(const MCInstrDesc &II, unsigned Op,
1983                                             unsigned OpNum) {
1984   if (TargetRegisterInfo::isVirtualRegister(Op)) {
1985     const TargetRegisterClass *RegClass =
1986         TII.getRegClass(II, OpNum, &TRI, *FuncInfo.MF);
1987     if (!MRI.constrainRegClass(Op, RegClass)) {
1988       // If it's not legal to COPY between the register classes, something
1989       // has gone very wrong before we got here.
1990       unsigned NewOp = createResultReg(RegClass);
1991       BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
1992               TII.get(TargetOpcode::COPY), NewOp).addReg(Op);
1993       return NewOp;
1994     }
1995   }
1996   return Op;
1997 }
1998 
1999 unsigned FastISel::fastEmitInst_(unsigned MachineInstOpcode,
2000                                  const TargetRegisterClass *RC) {
2001   unsigned ResultReg = createResultReg(RC);
2002   const MCInstrDesc &II = TII.get(MachineInstOpcode);
2003 
2004   BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II, ResultReg);
2005   return ResultReg;
2006 }
2007 
2008 unsigned FastISel::fastEmitInst_r(unsigned MachineInstOpcode,
2009                                   const TargetRegisterClass *RC, unsigned Op0,
2010                                   bool Op0IsKill) {
2011   const MCInstrDesc &II = TII.get(MachineInstOpcode);
2012 
2013   unsigned ResultReg = createResultReg(RC);
2014   Op0 = constrainOperandRegClass(II, Op0, II.getNumDefs());
2015 
2016   if (II.getNumDefs() >= 1)
2017     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II, ResultReg)
2018         .addReg(Op0, getKillRegState(Op0IsKill));
2019   else {
2020     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II)
2021         .addReg(Op0, getKillRegState(Op0IsKill));
2022     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
2023             TII.get(TargetOpcode::COPY), ResultReg).addReg(II.ImplicitDefs[0]);
2024   }
2025 
2026   return ResultReg;
2027 }
2028 
2029 unsigned FastISel::fastEmitInst_rr(unsigned MachineInstOpcode,
2030                                    const TargetRegisterClass *RC, unsigned Op0,
2031                                    bool Op0IsKill, unsigned Op1,
2032                                    bool Op1IsKill) {
2033   const MCInstrDesc &II = TII.get(MachineInstOpcode);
2034 
2035   unsigned ResultReg = createResultReg(RC);
2036   Op0 = constrainOperandRegClass(II, Op0, II.getNumDefs());
2037   Op1 = constrainOperandRegClass(II, Op1, II.getNumDefs() + 1);
2038 
2039   if (II.getNumDefs() >= 1)
2040     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II, ResultReg)
2041         .addReg(Op0, getKillRegState(Op0IsKill))
2042         .addReg(Op1, getKillRegState(Op1IsKill));
2043   else {
2044     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II)
2045         .addReg(Op0, getKillRegState(Op0IsKill))
2046         .addReg(Op1, getKillRegState(Op1IsKill));
2047     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
2048             TII.get(TargetOpcode::COPY), ResultReg).addReg(II.ImplicitDefs[0]);
2049   }
2050   return ResultReg;
2051 }
2052 
2053 unsigned FastISel::fastEmitInst_rrr(unsigned MachineInstOpcode,
2054                                     const TargetRegisterClass *RC, unsigned Op0,
2055                                     bool Op0IsKill, unsigned Op1,
2056                                     bool Op1IsKill, unsigned Op2,
2057                                     bool Op2IsKill) {
2058   const MCInstrDesc &II = TII.get(MachineInstOpcode);
2059 
2060   unsigned ResultReg = createResultReg(RC);
2061   Op0 = constrainOperandRegClass(II, Op0, II.getNumDefs());
2062   Op1 = constrainOperandRegClass(II, Op1, II.getNumDefs() + 1);
2063   Op2 = constrainOperandRegClass(II, Op2, II.getNumDefs() + 2);
2064 
2065   if (II.getNumDefs() >= 1)
2066     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II, ResultReg)
2067         .addReg(Op0, getKillRegState(Op0IsKill))
2068         .addReg(Op1, getKillRegState(Op1IsKill))
2069         .addReg(Op2, getKillRegState(Op2IsKill));
2070   else {
2071     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II)
2072         .addReg(Op0, getKillRegState(Op0IsKill))
2073         .addReg(Op1, getKillRegState(Op1IsKill))
2074         .addReg(Op2, getKillRegState(Op2IsKill));
2075     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
2076             TII.get(TargetOpcode::COPY), ResultReg).addReg(II.ImplicitDefs[0]);
2077   }
2078   return ResultReg;
2079 }
2080 
2081 unsigned FastISel::fastEmitInst_ri(unsigned MachineInstOpcode,
2082                                    const TargetRegisterClass *RC, unsigned Op0,
2083                                    bool Op0IsKill, uint64_t Imm) {
2084   const MCInstrDesc &II = TII.get(MachineInstOpcode);
2085 
2086   unsigned ResultReg = createResultReg(RC);
2087   Op0 = constrainOperandRegClass(II, Op0, II.getNumDefs());
2088 
2089   if (II.getNumDefs() >= 1)
2090     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II, ResultReg)
2091         .addReg(Op0, getKillRegState(Op0IsKill))
2092         .addImm(Imm);
2093   else {
2094     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II)
2095         .addReg(Op0, getKillRegState(Op0IsKill))
2096         .addImm(Imm);
2097     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
2098             TII.get(TargetOpcode::COPY), ResultReg).addReg(II.ImplicitDefs[0]);
2099   }
2100   return ResultReg;
2101 }
2102 
2103 unsigned FastISel::fastEmitInst_rii(unsigned MachineInstOpcode,
2104                                     const TargetRegisterClass *RC, unsigned Op0,
2105                                     bool Op0IsKill, uint64_t Imm1,
2106                                     uint64_t Imm2) {
2107   const MCInstrDesc &II = TII.get(MachineInstOpcode);
2108 
2109   unsigned ResultReg = createResultReg(RC);
2110   Op0 = constrainOperandRegClass(II, Op0, II.getNumDefs());
2111 
2112   if (II.getNumDefs() >= 1)
2113     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II, ResultReg)
2114         .addReg(Op0, getKillRegState(Op0IsKill))
2115         .addImm(Imm1)
2116         .addImm(Imm2);
2117   else {
2118     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II)
2119         .addReg(Op0, getKillRegState(Op0IsKill))
2120         .addImm(Imm1)
2121         .addImm(Imm2);
2122     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
2123             TII.get(TargetOpcode::COPY), ResultReg).addReg(II.ImplicitDefs[0]);
2124   }
2125   return ResultReg;
2126 }
2127 
2128 unsigned FastISel::fastEmitInst_f(unsigned MachineInstOpcode,
2129                                   const TargetRegisterClass *RC,
2130                                   const ConstantFP *FPImm) {
2131   const MCInstrDesc &II = TII.get(MachineInstOpcode);
2132 
2133   unsigned ResultReg = createResultReg(RC);
2134 
2135   if (II.getNumDefs() >= 1)
2136     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II, ResultReg)
2137         .addFPImm(FPImm);
2138   else {
2139     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II)
2140         .addFPImm(FPImm);
2141     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
2142             TII.get(TargetOpcode::COPY), ResultReg).addReg(II.ImplicitDefs[0]);
2143   }
2144   return ResultReg;
2145 }
2146 
2147 unsigned FastISel::fastEmitInst_rri(unsigned MachineInstOpcode,
2148                                     const TargetRegisterClass *RC, unsigned Op0,
2149                                     bool Op0IsKill, unsigned Op1,
2150                                     bool Op1IsKill, uint64_t Imm) {
2151   const MCInstrDesc &II = TII.get(MachineInstOpcode);
2152 
2153   unsigned ResultReg = createResultReg(RC);
2154   Op0 = constrainOperandRegClass(II, Op0, II.getNumDefs());
2155   Op1 = constrainOperandRegClass(II, Op1, II.getNumDefs() + 1);
2156 
2157   if (II.getNumDefs() >= 1)
2158     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II, ResultReg)
2159         .addReg(Op0, getKillRegState(Op0IsKill))
2160         .addReg(Op1, getKillRegState(Op1IsKill))
2161         .addImm(Imm);
2162   else {
2163     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II)
2164         .addReg(Op0, getKillRegState(Op0IsKill))
2165         .addReg(Op1, getKillRegState(Op1IsKill))
2166         .addImm(Imm);
2167     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
2168             TII.get(TargetOpcode::COPY), ResultReg).addReg(II.ImplicitDefs[0]);
2169   }
2170   return ResultReg;
2171 }
2172 
2173 unsigned FastISel::fastEmitInst_i(unsigned MachineInstOpcode,
2174                                   const TargetRegisterClass *RC, uint64_t Imm) {
2175   unsigned ResultReg = createResultReg(RC);
2176   const MCInstrDesc &II = TII.get(MachineInstOpcode);
2177 
2178   if (II.getNumDefs() >= 1)
2179     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II, ResultReg)
2180         .addImm(Imm);
2181   else {
2182     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, II).addImm(Imm);
2183     BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc,
2184             TII.get(TargetOpcode::COPY), ResultReg).addReg(II.ImplicitDefs[0]);
2185   }
2186   return ResultReg;
2187 }
2188 
2189 unsigned FastISel::fastEmitInst_extractsubreg(MVT RetVT, unsigned Op0,
2190                                               bool Op0IsKill, uint32_t Idx) {
2191   unsigned ResultReg = createResultReg(TLI.getRegClassFor(RetVT));
2192   assert(TargetRegisterInfo::isVirtualRegister(Op0) &&
2193          "Cannot yet extract from physregs");
2194   const TargetRegisterClass *RC = MRI.getRegClass(Op0);
2195   MRI.constrainRegClass(Op0, TRI.getSubClassWithSubReg(RC, Idx));
2196   BuildMI(*FuncInfo.MBB, FuncInfo.InsertPt, DbgLoc, TII.get(TargetOpcode::COPY),
2197           ResultReg).addReg(Op0, getKillRegState(Op0IsKill), Idx);
2198   return ResultReg;
2199 }
2200 
2201 /// Emit MachineInstrs to compute the value of Op with all but the least
2202 /// significant bit set to zero.
2203 unsigned FastISel::fastEmitZExtFromI1(MVT VT, unsigned Op0, bool Op0IsKill) {
2204   return fastEmit_ri(VT, VT, ISD::AND, Op0, Op0IsKill, 1);
2205 }
2206 
2207 /// HandlePHINodesInSuccessorBlocks - Handle PHI nodes in successor blocks.
2208 /// Emit code to ensure constants are copied into registers when needed.
2209 /// Remember the virtual registers that need to be added to the Machine PHI
2210 /// nodes as input.  We cannot just directly add them, because expansion
2211 /// might result in multiple MBB's for one BB.  As such, the start of the
2212 /// BB might correspond to a different MBB than the end.
2213 bool FastISel::handlePHINodesInSuccessorBlocks(const BasicBlock *LLVMBB) {
2214   const TerminatorInst *TI = LLVMBB->getTerminator();
2215 
2216   SmallPtrSet<MachineBasicBlock *, 4> SuccsHandled;
2217   FuncInfo.OrigNumPHINodesToUpdate = FuncInfo.PHINodesToUpdate.size();
2218 
2219   // Check successor nodes' PHI nodes that expect a constant to be available
2220   // from this block.
2221   for (unsigned succ = 0, e = TI->getNumSuccessors(); succ != e; ++succ) {
2222     const BasicBlock *SuccBB = TI->getSuccessor(succ);
2223     if (!isa<PHINode>(SuccBB->begin()))
2224       continue;
2225     MachineBasicBlock *SuccMBB = FuncInfo.MBBMap[SuccBB];
2226 
2227     // If this terminator has multiple identical successors (common for
2228     // switches), only handle each succ once.
2229     if (!SuccsHandled.insert(SuccMBB).second)
2230       continue;
2231 
2232     MachineBasicBlock::iterator MBBI = SuccMBB->begin();
2233 
2234     // At this point we know that there is a 1-1 correspondence between LLVM PHI
2235     // nodes and Machine PHI nodes, but the incoming operands have not been
2236     // emitted yet.
2237     for (const PHINode &PN : SuccBB->phis()) {
2238       // Ignore dead phi's.
2239       if (PN.use_empty())
2240         continue;
2241 
2242       // Only handle legal types. Two interesting things to note here. First,
2243       // by bailing out early, we may leave behind some dead instructions,
2244       // since SelectionDAG's HandlePHINodesInSuccessorBlocks will insert its
2245       // own moves. Second, this check is necessary because FastISel doesn't
2246       // use CreateRegs to create registers, so it always creates
2247       // exactly one register for each non-void instruction.
2248       EVT VT = TLI.getValueType(DL, PN.getType(), /*AllowUnknown=*/true);
2249       if (VT == MVT::Other || !TLI.isTypeLegal(VT)) {
2250         // Handle integer promotions, though, because they're common and easy.
2251         if (!(VT == MVT::i1 || VT == MVT::i8 || VT == MVT::i16)) {
2252           FuncInfo.PHINodesToUpdate.resize(FuncInfo.OrigNumPHINodesToUpdate);
2253           return false;
2254         }
2255       }
2256 
2257       const Value *PHIOp = PN.getIncomingValueForBlock(LLVMBB);
2258 
2259       // Set the DebugLoc for the copy. Prefer the location of the operand
2260       // if there is one; use the location of the PHI otherwise.
2261       DbgLoc = PN.getDebugLoc();
2262       if (const auto *Inst = dyn_cast<Instruction>(PHIOp))
2263         DbgLoc = Inst->getDebugLoc();
2264 
2265       unsigned Reg = getRegForValue(PHIOp);
2266       if (!Reg) {
2267         FuncInfo.PHINodesToUpdate.resize(FuncInfo.OrigNumPHINodesToUpdate);
2268         return false;
2269       }
2270       FuncInfo.PHINodesToUpdate.push_back(std::make_pair(&*MBBI++, Reg));
2271       DbgLoc = DebugLoc();
2272     }
2273   }
2274 
2275   return true;
2276 }
2277 
2278 bool FastISel::tryToFoldLoad(const LoadInst *LI, const Instruction *FoldInst) {
2279   assert(LI->hasOneUse() &&
2280          "tryToFoldLoad expected a LoadInst with a single use");
2281   // We know that the load has a single use, but don't know what it is.  If it
2282   // isn't one of the folded instructions, then we can't succeed here.  Handle
2283   // this by scanning the single-use users of the load until we get to FoldInst.
2284   unsigned MaxUsers = 6; // Don't scan down huge single-use chains of instrs.
2285 
2286   const Instruction *TheUser = LI->user_back();
2287   while (TheUser != FoldInst && // Scan up until we find FoldInst.
2288          // Stay in the right block.
2289          TheUser->getParent() == FoldInst->getParent() &&
2290          --MaxUsers) { // Don't scan too far.
2291     // If there are multiple or no uses of this instruction, then bail out.
2292     if (!TheUser->hasOneUse())
2293       return false;
2294 
2295     TheUser = TheUser->user_back();
2296   }
2297 
2298   // If we didn't find the fold instruction, then we failed to collapse the
2299   // sequence.
2300   if (TheUser != FoldInst)
2301     return false;
2302 
2303   // Don't try to fold volatile loads.  Target has to deal with alignment
2304   // constraints.
2305   if (LI->isVolatile())
2306     return false;
2307 
2308   // Figure out which vreg this is going into.  If there is no assigned vreg yet
2309   // then there actually was no reference to it.  Perhaps the load is referenced
2310   // by a dead instruction.
2311   unsigned LoadReg = getRegForValue(LI);
2312   if (!LoadReg)
2313     return false;
2314 
2315   // We can't fold if this vreg has no uses or more than one use.  Multiple uses
2316   // may mean that the instruction got lowered to multiple MIs, or the use of
2317   // the loaded value ended up being multiple operands of the result.
2318   if (!MRI.hasOneUse(LoadReg))
2319     return false;
2320 
2321   MachineRegisterInfo::reg_iterator RI = MRI.reg_begin(LoadReg);
2322   MachineInstr *User = RI->getParent();
2323 
2324   // Set the insertion point properly.  Folding the load can cause generation of
2325   // other random instructions (like sign extends) for addressing modes; make
2326   // sure they get inserted in a logical place before the new instruction.
2327   FuncInfo.InsertPt = User;
2328   FuncInfo.MBB = User->getParent();
2329 
2330   // Ask the target to try folding the load.
2331   return tryToFoldLoadIntoMI(User, RI.getOperandNo(), LI);
2332 }
2333 
2334 bool FastISel::canFoldAddIntoGEP(const User *GEP, const Value *Add) {
2335   // Must be an add.
2336   if (!isa<AddOperator>(Add))
2337     return false;
2338   // Type size needs to match.
2339   if (DL.getTypeSizeInBits(GEP->getType()) !=
2340       DL.getTypeSizeInBits(Add->getType()))
2341     return false;
2342   // Must be in the same basic block.
2343   if (isa<Instruction>(Add) &&
2344       FuncInfo.MBBMap[cast<Instruction>(Add)->getParent()] != FuncInfo.MBB)
2345     return false;
2346   // Must have a constant operand.
2347   return isa<ConstantInt>(cast<AddOperator>(Add)->getOperand(1));
2348 }
2349 
2350 MachineMemOperand *
2351 FastISel::createMachineMemOperandFor(const Instruction *I) const {
2352   const Value *Ptr;
2353   Type *ValTy;
2354   unsigned Alignment;
2355   MachineMemOperand::Flags Flags;
2356   bool IsVolatile;
2357 
2358   if (const auto *LI = dyn_cast<LoadInst>(I)) {
2359     Alignment = LI->getAlignment();
2360     IsVolatile = LI->isVolatile();
2361     Flags = MachineMemOperand::MOLoad;
2362     Ptr = LI->getPointerOperand();
2363     ValTy = LI->getType();
2364   } else if (const auto *SI = dyn_cast<StoreInst>(I)) {
2365     Alignment = SI->getAlignment();
2366     IsVolatile = SI->isVolatile();
2367     Flags = MachineMemOperand::MOStore;
2368     Ptr = SI->getPointerOperand();
2369     ValTy = SI->getValueOperand()->getType();
2370   } else
2371     return nullptr;
2372 
2373   bool IsNonTemporal = I->getMetadata(LLVMContext::MD_nontemporal) != nullptr;
2374   bool IsInvariant = I->getMetadata(LLVMContext::MD_invariant_load) != nullptr;
2375   bool IsDereferenceable =
2376       I->getMetadata(LLVMContext::MD_dereferenceable) != nullptr;
2377   const MDNode *Ranges = I->getMetadata(LLVMContext::MD_range);
2378 
2379   AAMDNodes AAInfo;
2380   I->getAAMetadata(AAInfo);
2381 
2382   if (Alignment == 0) // Ensure that codegen never sees alignment 0.
2383     Alignment = DL.getABITypeAlignment(ValTy);
2384 
2385   unsigned Size = DL.getTypeStoreSize(ValTy);
2386 
2387   if (IsVolatile)
2388     Flags |= MachineMemOperand::MOVolatile;
2389   if (IsNonTemporal)
2390     Flags |= MachineMemOperand::MONonTemporal;
2391   if (IsDereferenceable)
2392     Flags |= MachineMemOperand::MODereferenceable;
2393   if (IsInvariant)
2394     Flags |= MachineMemOperand::MOInvariant;
2395 
2396   return FuncInfo.MF->getMachineMemOperand(MachinePointerInfo(Ptr), Flags, Size,
2397                                            Alignment, AAInfo, Ranges);
2398 }
2399 
2400 CmpInst::Predicate FastISel::optimizeCmpPredicate(const CmpInst *CI) const {
2401   // If both operands are the same, then try to optimize or fold the cmp.
2402   CmpInst::Predicate Predicate = CI->getPredicate();
2403   if (CI->getOperand(0) != CI->getOperand(1))
2404     return Predicate;
2405 
2406   switch (Predicate) {
2407   default: llvm_unreachable("Invalid predicate!");
2408   case CmpInst::FCMP_FALSE: Predicate = CmpInst::FCMP_FALSE; break;
2409   case CmpInst::FCMP_OEQ:   Predicate = CmpInst::FCMP_ORD;   break;
2410   case CmpInst::FCMP_OGT:   Predicate = CmpInst::FCMP_FALSE; break;
2411   case CmpInst::FCMP_OGE:   Predicate = CmpInst::FCMP_ORD;   break;
2412   case CmpInst::FCMP_OLT:   Predicate = CmpInst::FCMP_FALSE; break;
2413   case CmpInst::FCMP_OLE:   Predicate = CmpInst::FCMP_ORD;   break;
2414   case CmpInst::FCMP_ONE:   Predicate = CmpInst::FCMP_FALSE; break;
2415   case CmpInst::FCMP_ORD:   Predicate = CmpInst::FCMP_ORD;   break;
2416   case CmpInst::FCMP_UNO:   Predicate = CmpInst::FCMP_UNO;   break;
2417   case CmpInst::FCMP_UEQ:   Predicate = CmpInst::FCMP_TRUE;  break;
2418   case CmpInst::FCMP_UGT:   Predicate = CmpInst::FCMP_UNO;   break;
2419   case CmpInst::FCMP_UGE:   Predicate = CmpInst::FCMP_TRUE;  break;
2420   case CmpInst::FCMP_ULT:   Predicate = CmpInst::FCMP_UNO;   break;
2421   case CmpInst::FCMP_ULE:   Predicate = CmpInst::FCMP_TRUE;  break;
2422   case CmpInst::FCMP_UNE:   Predicate = CmpInst::FCMP_UNO;   break;
2423   case CmpInst::FCMP_TRUE:  Predicate = CmpInst::FCMP_TRUE;  break;
2424 
2425   case CmpInst::ICMP_EQ:    Predicate = CmpInst::FCMP_TRUE;  break;
2426   case CmpInst::ICMP_NE:    Predicate = CmpInst::FCMP_FALSE; break;
2427   case CmpInst::ICMP_UGT:   Predicate = CmpInst::FCMP_FALSE; break;
2428   case CmpInst::ICMP_UGE:   Predicate = CmpInst::FCMP_TRUE;  break;
2429   case CmpInst::ICMP_ULT:   Predicate = CmpInst::FCMP_FALSE; break;
2430   case CmpInst::ICMP_ULE:   Predicate = CmpInst::FCMP_TRUE;  break;
2431   case CmpInst::ICMP_SGT:   Predicate = CmpInst::FCMP_FALSE; break;
2432   case CmpInst::ICMP_SGE:   Predicate = CmpInst::FCMP_TRUE;  break;
2433   case CmpInst::ICMP_SLT:   Predicate = CmpInst::FCMP_FALSE; break;
2434   case CmpInst::ICMP_SLE:   Predicate = CmpInst::FCMP_TRUE;  break;
2435   }
2436 
2437   return Predicate;
2438 }
2439