1f22ef01cSRoman Divacky //===-- FunctionLoweringInfo.cpp ------------------------------------------===//
2f22ef01cSRoman Divacky //
3f22ef01cSRoman Divacky //                     The LLVM Compiler Infrastructure
4f22ef01cSRoman Divacky //
5f22ef01cSRoman Divacky // This file is distributed under the University of Illinois Open Source
6f22ef01cSRoman Divacky // License. See LICENSE.TXT for details.
7f22ef01cSRoman Divacky //
8f22ef01cSRoman Divacky //===----------------------------------------------------------------------===//
9f22ef01cSRoman Divacky //
10f22ef01cSRoman Divacky // This implements routines for translating functions from LLVM IR into
11f22ef01cSRoman Divacky // Machine IR.
12f22ef01cSRoman Divacky //
13f22ef01cSRoman Divacky //===----------------------------------------------------------------------===//
14f22ef01cSRoman Divacky 
15ffd1746dSEd Schouten #include "llvm/CodeGen/FunctionLoweringInfo.h"
16f22ef01cSRoman Divacky #include "llvm/CodeGen/Analysis.h"
17f22ef01cSRoman Divacky #include "llvm/CodeGen/MachineFrameInfo.h"
18139f7f9bSDimitry Andric #include "llvm/CodeGen/MachineFunction.h"
19f22ef01cSRoman Divacky #include "llvm/CodeGen/MachineInstrBuilder.h"
20f22ef01cSRoman Divacky #include "llvm/CodeGen/MachineRegisterInfo.h"
212cab237bSDimitry Andric #include "llvm/CodeGen/TargetFrameLowering.h"
222cab237bSDimitry Andric #include "llvm/CodeGen/TargetInstrInfo.h"
232cab237bSDimitry Andric #include "llvm/CodeGen/TargetLowering.h"
242cab237bSDimitry Andric #include "llvm/CodeGen/TargetRegisterInfo.h"
252cab237bSDimitry Andric #include "llvm/CodeGen/TargetSubtargetInfo.h"
264ba319b5SDimitry Andric #include "llvm/CodeGen/WasmEHFuncInfo.h"
27ff0cc061SDimitry Andric #include "llvm/CodeGen/WinEHFuncInfo.h"
28139f7f9bSDimitry Andric #include "llvm/IR/DataLayout.h"
29139f7f9bSDimitry Andric #include "llvm/IR/DerivedTypes.h"
30139f7f9bSDimitry Andric #include "llvm/IR/Function.h"
31139f7f9bSDimitry Andric #include "llvm/IR/Instructions.h"
32139f7f9bSDimitry Andric #include "llvm/IR/IntrinsicInst.h"
33139f7f9bSDimitry Andric #include "llvm/IR/LLVMContext.h"
34139f7f9bSDimitry Andric #include "llvm/IR/Module.h"
35f22ef01cSRoman Divacky #include "llvm/Support/Debug.h"
36f22ef01cSRoman Divacky #include "llvm/Support/ErrorHandling.h"
37f22ef01cSRoman Divacky #include "llvm/Support/MathExtras.h"
38ff0cc061SDimitry Andric #include "llvm/Support/raw_ostream.h"
39139f7f9bSDimitry Andric #include "llvm/Target/TargetOptions.h"
40f22ef01cSRoman Divacky #include <algorithm>
41f22ef01cSRoman Divacky using namespace llvm;
42f22ef01cSRoman Divacky 
4391bc56edSDimitry Andric #define DEBUG_TYPE "function-lowering-info"
4491bc56edSDimitry Andric 
45f22ef01cSRoman Divacky /// isUsedOutsideOfDefiningBlock - Return true if this instruction is used by
46f22ef01cSRoman Divacky /// PHI nodes or outside of the basic block that defines it, or used by a
47f22ef01cSRoman Divacky /// switch or atomic instruction, which may expand to multiple basic blocks.
isUsedOutsideOfDefiningBlock(const Instruction * I)48f22ef01cSRoman Divacky static bool isUsedOutsideOfDefiningBlock(const Instruction *I) {
49f22ef01cSRoman Divacky   if (I->use_empty()) return false;
50f22ef01cSRoman Divacky   if (isa<PHINode>(I)) return true;
51f22ef01cSRoman Divacky   const BasicBlock *BB = I->getParent();
5291bc56edSDimitry Andric   for (const User *U : I->users())
53ffd1746dSEd Schouten     if (cast<Instruction>(U)->getParent() != BB || isa<PHINode>(U))
54f22ef01cSRoman Divacky       return true;
5591bc56edSDimitry Andric 
56f22ef01cSRoman Divacky   return false;
57f22ef01cSRoman Divacky }
58f22ef01cSRoman Divacky 
getPreferredExtendForValue(const Value * V)5939d628a0SDimitry Andric static ISD::NodeType getPreferredExtendForValue(const Value *V) {
6039d628a0SDimitry Andric   // For the users of the source value being used for compare instruction, if
6139d628a0SDimitry Andric   // the number of signed predicate is greater than unsigned predicate, we
6239d628a0SDimitry Andric   // prefer to use SIGN_EXTEND.
6339d628a0SDimitry Andric   //
6439d628a0SDimitry Andric   // With this optimization, we would be able to reduce some redundant sign or
6539d628a0SDimitry Andric   // zero extension instruction, and eventually more machine CSE opportunities
6639d628a0SDimitry Andric   // can be exposed.
6739d628a0SDimitry Andric   ISD::NodeType ExtendKind = ISD::ANY_EXTEND;
6839d628a0SDimitry Andric   unsigned NumOfSigned = 0, NumOfUnsigned = 0;
6939d628a0SDimitry Andric   for (const User *U : V->users()) {
7039d628a0SDimitry Andric     if (const auto *CI = dyn_cast<CmpInst>(U)) {
7139d628a0SDimitry Andric       NumOfSigned += CI->isSigned();
7239d628a0SDimitry Andric       NumOfUnsigned += CI->isUnsigned();
7339d628a0SDimitry Andric     }
7439d628a0SDimitry Andric   }
7539d628a0SDimitry Andric   if (NumOfSigned > NumOfUnsigned)
7639d628a0SDimitry Andric     ExtendKind = ISD::SIGN_EXTEND;
7739d628a0SDimitry Andric 
7839d628a0SDimitry Andric   return ExtendKind;
7939d628a0SDimitry Andric }
8039d628a0SDimitry Andric 
set(const Function & fn,MachineFunction & mf,SelectionDAG * DAG)814f00c8c6SDimitry Andric void FunctionLoweringInfo::set(const Function &fn, MachineFunction &mf,
824f00c8c6SDimitry Andric                                SelectionDAG *DAG) {
83f22ef01cSRoman Divacky   Fn = &fn;
84f22ef01cSRoman Divacky   MF = &mf;
8539d628a0SDimitry Andric   TLI = MF->getSubtarget().getTargetLowering();
86f22ef01cSRoman Divacky   RegInfo = &MF->getRegInfo();
877d523365SDimitry Andric   const TargetFrameLowering *TFI = MF->getSubtarget().getFrameLowering();
883ca95b02SDimitry Andric   unsigned StackAlign = TFI->getStackAlignment();
89f22ef01cSRoman Divacky 
90ffd1746dSEd Schouten   // Check whether the function can return without sret-demotion.
91ffd1746dSEd Schouten   SmallVector<ISD::OutputArg, 4> Outs;
924ba319b5SDimitry Andric   CallingConv::ID CC = Fn->getCallingConv();
934ba319b5SDimitry Andric 
944ba319b5SDimitry Andric   GetReturnInfo(CC, Fn->getReturnType(), Fn->getAttributes(), Outs, *TLI,
95875ed548SDimitry Andric                 mf.getDataLayout());
964ba319b5SDimitry Andric   CanLowerReturn =
974ba319b5SDimitry Andric       TLI->CanLowerReturn(CC, *MF, Fn->isVarArg(), Outs, Fn->getContext());
98ffd1746dSEd Schouten 
993ca95b02SDimitry Andric   // If this personality uses funclets, we need to do a bit more work.
100d88c1a5aSDimitry Andric   DenseMap<const AllocaInst *, TinyPtrVector<int *>> CatchObjects;
1013ca95b02SDimitry Andric   EHPersonality Personality = classifyEHPersonality(
1023ca95b02SDimitry Andric       Fn->hasPersonalityFn() ? Fn->getPersonalityFn() : nullptr);
1033ca95b02SDimitry Andric   if (isFuncletEHPersonality(Personality)) {
1043ca95b02SDimitry Andric     // Calculate state numbers if we haven't already.
1053ca95b02SDimitry Andric     WinEHFuncInfo &EHInfo = *MF->getWinEHFuncInfo();
1063ca95b02SDimitry Andric     if (Personality == EHPersonality::MSVC_CXX)
1073ca95b02SDimitry Andric       calculateWinCXXEHStateNumbers(&fn, EHInfo);
1083ca95b02SDimitry Andric     else if (isAsynchronousEHPersonality(Personality))
1093ca95b02SDimitry Andric       calculateSEHStateNumbers(&fn, EHInfo);
1103ca95b02SDimitry Andric     else if (Personality == EHPersonality::CoreCLR)
1113ca95b02SDimitry Andric       calculateClrEHStateNumbers(&fn, EHInfo);
1123ca95b02SDimitry Andric 
1133ca95b02SDimitry Andric     // Map all BB references in the WinEH data to MBBs.
1143ca95b02SDimitry Andric     for (WinEHTryBlockMapEntry &TBME : EHInfo.TryBlockMap) {
1153ca95b02SDimitry Andric       for (WinEHHandlerType &H : TBME.HandlerArray) {
1163ca95b02SDimitry Andric         if (const AllocaInst *AI = H.CatchObj.Alloca)
117d88c1a5aSDimitry Andric           CatchObjects.insert({AI, {}}).first->second.push_back(
118d88c1a5aSDimitry Andric               &H.CatchObj.FrameIndex);
1193ca95b02SDimitry Andric         else
1203ca95b02SDimitry Andric           H.CatchObj.FrameIndex = INT_MAX;
1213ca95b02SDimitry Andric       }
1223ca95b02SDimitry Andric     }
1233ca95b02SDimitry Andric   }
1244ba319b5SDimitry Andric   if (Personality == EHPersonality::Wasm_CXX) {
1254ba319b5SDimitry Andric     WasmEHFuncInfo &EHInfo = *MF->getWasmEHFuncInfo();
1264ba319b5SDimitry Andric     calculateWasmEHInfo(&fn, EHInfo);
1274ba319b5SDimitry Andric   }
1283ca95b02SDimitry Andric 
129f22ef01cSRoman Divacky   // Initialize the mapping of values to registers.  This is only set up for
130f22ef01cSRoman Divacky   // instruction values that are used outside of the block that defines
131f22ef01cSRoman Divacky   // them.
132d88c1a5aSDimitry Andric   for (const BasicBlock &BB : *Fn) {
133d88c1a5aSDimitry Andric     for (const Instruction &I : BB) {
134d88c1a5aSDimitry Andric       if (const AllocaInst *AI = dyn_cast<AllocaInst>(&I)) {
1356122f3e6SDimitry Andric         Type *Ty = AI->getAllocatedType();
136f22ef01cSRoman Divacky         unsigned Align =
137875ed548SDimitry Andric           std::max((unsigned)MF->getDataLayout().getPrefTypeAlignment(Ty),
138f22ef01cSRoman Divacky                    AI->getAlignment());
1397d523365SDimitry Andric 
1407d523365SDimitry Andric         // Static allocas can be folded into the initial stack frame
1417d523365SDimitry Andric         // adjustment. For targets that don't realign the stack, don't
1427d523365SDimitry Andric         // do this if there is an extra alignment requirement.
1437d523365SDimitry Andric         if (AI->isStaticAlloca() &&
1447d523365SDimitry Andric             (TFI->isStackRealignable() || (Align <= StackAlign))) {
1457d523365SDimitry Andric           const ConstantInt *CUI = cast<ConstantInt>(AI->getArraySize());
1467d523365SDimitry Andric           uint64_t TySize = MF->getDataLayout().getTypeAllocSize(Ty);
147f22ef01cSRoman Divacky 
148f22ef01cSRoman Divacky           TySize *= CUI->getZExtValue();   // Get total allocated size.
149f22ef01cSRoman Divacky           if (TySize == 0) TySize = 1; // Don't create zero-sized stack objects.
1503ca95b02SDimitry Andric           int FrameIndex = INT_MAX;
1513ca95b02SDimitry Andric           auto Iter = CatchObjects.find(AI);
1523ca95b02SDimitry Andric           if (Iter != CatchObjects.end() && TLI->needsFixedCatchObjects()) {
153d88c1a5aSDimitry Andric             FrameIndex = MF->getFrameInfo().CreateFixedObject(
1543ca95b02SDimitry Andric                 TySize, 0, /*Immutable=*/false, /*isAliased=*/true);
155d88c1a5aSDimitry Andric             MF->getFrameInfo().setObjectAlignment(FrameIndex, Align);
1563ca95b02SDimitry Andric           } else {
1573ca95b02SDimitry Andric             FrameIndex =
158d88c1a5aSDimitry Andric                 MF->getFrameInfo().CreateStackObject(TySize, Align, false, AI);
1593ca95b02SDimitry Andric           }
1603ca95b02SDimitry Andric 
1613ca95b02SDimitry Andric           StaticAllocaMap[AI] = FrameIndex;
1623ca95b02SDimitry Andric           // Update the catch handler information.
163d88c1a5aSDimitry Andric           if (Iter != CatchObjects.end()) {
164d88c1a5aSDimitry Andric             for (int *CatchObjPtr : Iter->second)
165d88c1a5aSDimitry Andric               *CatchObjPtr = FrameIndex;
166d88c1a5aSDimitry Andric           }
16739d628a0SDimitry Andric         } else {
1687d523365SDimitry Andric           // FIXME: Overaligned static allocas should be grouped into
1697d523365SDimitry Andric           // a single dynamic allocation instead of using a separate
1707d523365SDimitry Andric           // stack allocation for each one.
1714f00c8c6SDimitry Andric           if (Align <= StackAlign)
1724f00c8c6SDimitry Andric             Align = 0;
1734f00c8c6SDimitry Andric           // Inform the Frame Information that we have variable-sized objects.
174d88c1a5aSDimitry Andric           MF->getFrameInfo().CreateVariableSizedObject(Align ? Align : 1, AI);
1754f00c8c6SDimitry Andric         }
1764f00c8c6SDimitry Andric       }
1774f00c8c6SDimitry Andric 
1784f00c8c6SDimitry Andric       // Look for inline asm that clobbers the SP register.
1794f00c8c6SDimitry Andric       if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
180d88c1a5aSDimitry Andric         ImmutableCallSite CS(&I);
18191bc56edSDimitry Andric         if (isa<InlineAsm>(CS.getCalledValue())) {
1824f00c8c6SDimitry Andric           unsigned SP = TLI->getStackPointerRegisterToSaveRestore();
183ff0cc061SDimitry Andric           const TargetRegisterInfo *TRI = MF->getSubtarget().getRegisterInfo();
1844f00c8c6SDimitry Andric           std::vector<TargetLowering::AsmOperandInfo> Ops =
185875ed548SDimitry Andric               TLI->ParseConstraints(Fn->getParent()->getDataLayout(), TRI, CS);
186d88c1a5aSDimitry Andric           for (TargetLowering::AsmOperandInfo &Op : Ops) {
1874f00c8c6SDimitry Andric             if (Op.Type == InlineAsm::isClobber) {
1884f00c8c6SDimitry Andric               // Clobbers don't have SDValue operands, hence SDValue().
1894f00c8c6SDimitry Andric               TLI->ComputeConstraintToUse(Op, SDValue(), DAG);
1904f00c8c6SDimitry Andric               std::pair<unsigned, const TargetRegisterClass *> PhysReg =
191ff0cc061SDimitry Andric                   TLI->getRegForInlineAsmConstraint(TRI, Op.ConstraintCode,
1924f00c8c6SDimitry Andric                                                     Op.ConstraintVT);
1934f00c8c6SDimitry Andric               if (PhysReg.first == SP)
194d88c1a5aSDimitry Andric                 MF->getFrameInfo().setHasOpaqueSPAdjustment(true);
1954f00c8c6SDimitry Andric             }
1964f00c8c6SDimitry Andric           }
1974f00c8c6SDimitry Andric         }
1984f00c8c6SDimitry Andric       }
1994f00c8c6SDimitry Andric 
20039d628a0SDimitry Andric       // Look for calls to the @llvm.va_start intrinsic. We can omit some
20139d628a0SDimitry Andric       // prologue boilerplate for variadic functions that don't examine their
20239d628a0SDimitry Andric       // arguments.
203d88c1a5aSDimitry Andric       if (const auto *II = dyn_cast<IntrinsicInst>(&I)) {
20439d628a0SDimitry Andric         if (II->getIntrinsicID() == Intrinsic::vastart)
205d88c1a5aSDimitry Andric           MF->getFrameInfo().setHasVAStart(true);
20639d628a0SDimitry Andric       }
20739d628a0SDimitry Andric 
2087d523365SDimitry Andric       // If we have a musttail call in a variadic function, we need to ensure we
20939d628a0SDimitry Andric       // forward implicit register parameters.
210d88c1a5aSDimitry Andric       if (const auto *CI = dyn_cast<CallInst>(&I)) {
21139d628a0SDimitry Andric         if (CI->isMustTailCall() && Fn->isVarArg())
212d88c1a5aSDimitry Andric           MF->getFrameInfo().setHasMustTailInVarArgFunc(true);
21339d628a0SDimitry Andric       }
21439d628a0SDimitry Andric 
215e580952dSDimitry Andric       // Mark values used outside their block as exported, by allocating
216e580952dSDimitry Andric       // a virtual register for them.
217d88c1a5aSDimitry Andric       if (isUsedOutsideOfDefiningBlock(&I))
218d88c1a5aSDimitry Andric         if (!isa<AllocaInst>(I) || !StaticAllocaMap.count(cast<AllocaInst>(&I)))
219d88c1a5aSDimitry Andric           InitializeRegForValue(&I);
220f22ef01cSRoman Divacky 
22139d628a0SDimitry Andric       // Decide the preferred extend type for a value.
222d88c1a5aSDimitry Andric       PreferredExtendType[&I] = getPreferredExtendForValue(&I);
223d88c1a5aSDimitry Andric     }
224e580952dSDimitry Andric   }
225e580952dSDimitry Andric 
226f22ef01cSRoman Divacky   // Create an initial MachineBasicBlock for each LLVM BasicBlock in F.  This
227f22ef01cSRoman Divacky   // also creates the initial PHI MachineInstrs, though none of the input
228f22ef01cSRoman Divacky   // operands are populated.
229d88c1a5aSDimitry Andric   for (const BasicBlock &BB : *Fn) {
2307d523365SDimitry Andric     // Don't create MachineBasicBlocks for imaginary EH pad blocks. These blocks
2317d523365SDimitry Andric     // are really data, and no instructions can live here.
232d88c1a5aSDimitry Andric     if (BB.isEHPad()) {
233d88c1a5aSDimitry Andric       const Instruction *PadInst = BB.getFirstNonPHI();
2347d523365SDimitry Andric       // If this is a non-landingpad EH pad, mark this function as using
2357d523365SDimitry Andric       // funclets.
2364ba319b5SDimitry Andric       // FIXME: SEH catchpads do not create EH scope/funclets, so we could avoid
2374ba319b5SDimitry Andric       // setting this in such cases in order to improve frame layout.
238d88c1a5aSDimitry Andric       if (!isa<LandingPadInst>(PadInst)) {
2394ba319b5SDimitry Andric         MF->setHasEHScopes(true);
240d88c1a5aSDimitry Andric         MF->setHasEHFunclets(true);
241d88c1a5aSDimitry Andric         MF->getFrameInfo().setHasOpaqueSPAdjustment(true);
2427d523365SDimitry Andric       }
243d88c1a5aSDimitry Andric       if (isa<CatchSwitchInst>(PadInst)) {
244d88c1a5aSDimitry Andric         assert(&*BB.begin() == PadInst &&
2457d523365SDimitry Andric                "WinEHPrepare failed to remove PHIs from imaginary BBs");
2467d523365SDimitry Andric         continue;
2477d523365SDimitry Andric       }
248d88c1a5aSDimitry Andric       if (isa<FuncletPadInst>(PadInst))
249d88c1a5aSDimitry Andric         assert(&*BB.begin() == PadInst && "WinEHPrepare failed to demote PHIs");
2507d523365SDimitry Andric     }
2517d523365SDimitry Andric 
252d88c1a5aSDimitry Andric     MachineBasicBlock *MBB = mf.CreateMachineBasicBlock(&BB);
253d88c1a5aSDimitry Andric     MBBMap[&BB] = MBB;
254f22ef01cSRoman Divacky     MF->push_back(MBB);
255f22ef01cSRoman Divacky 
256f22ef01cSRoman Divacky     // Transfer the address-taken flag. This is necessary because there could
257f22ef01cSRoman Divacky     // be multiple MachineBasicBlocks corresponding to one BasicBlock, and only
258f22ef01cSRoman Divacky     // the first one should be marked.
259d88c1a5aSDimitry Andric     if (BB.hasAddressTaken())
260f22ef01cSRoman Divacky       MBB->setHasAddressTaken();
261f22ef01cSRoman Divacky 
262d88c1a5aSDimitry Andric     // Mark landing pad blocks.
263d88c1a5aSDimitry Andric     if (BB.isEHPad())
264d88c1a5aSDimitry Andric       MBB->setIsEHPad();
265d88c1a5aSDimitry Andric 
266f22ef01cSRoman Divacky     // Create Machine PHI nodes for LLVM PHI nodes, lowering them as
267f22ef01cSRoman Divacky     // appropriate.
26830785c0eSDimitry Andric     for (const PHINode &PN : BB.phis()) {
26930785c0eSDimitry Andric       if (PN.use_empty())
270bd5abe19SDimitry Andric         continue;
271bd5abe19SDimitry Andric 
27230785c0eSDimitry Andric       // Skip empty types
27330785c0eSDimitry Andric       if (PN.getType()->isEmptyTy())
27430785c0eSDimitry Andric         continue;
27530785c0eSDimitry Andric 
27630785c0eSDimitry Andric       DebugLoc DL = PN.getDebugLoc();
27730785c0eSDimitry Andric       unsigned PHIReg = ValueMap[&PN];
278f22ef01cSRoman Divacky       assert(PHIReg && "PHI node does not have an assigned virtual register!");
279f22ef01cSRoman Divacky 
280f22ef01cSRoman Divacky       SmallVector<EVT, 4> ValueVTs;
28130785c0eSDimitry Andric       ComputeValueVTs(*TLI, MF->getDataLayout(), PN.getType(), ValueVTs);
282d88c1a5aSDimitry Andric       for (EVT VT : ValueVTs) {
283f785676fSDimitry Andric         unsigned NumRegisters = TLI->getNumRegisters(Fn->getContext(), VT);
28439d628a0SDimitry Andric         const TargetInstrInfo *TII = MF->getSubtarget().getInstrInfo();
285f22ef01cSRoman Divacky         for (unsigned i = 0; i != NumRegisters; ++i)
286f22ef01cSRoman Divacky           BuildMI(MBB, DL, TII->get(TargetOpcode::PHI), PHIReg + i);
287f22ef01cSRoman Divacky         PHIReg += NumRegisters;
288f22ef01cSRoman Divacky       }
289f22ef01cSRoman Divacky     }
290f22ef01cSRoman Divacky   }
291f22ef01cSRoman Divacky 
2924ba319b5SDimitry Andric   if (isFuncletEHPersonality(Personality)) {
2937d523365SDimitry Andric     WinEHFuncInfo &EHInfo = *MF->getWinEHFuncInfo();
2948f0fd8f6SDimitry Andric 
2957d523365SDimitry Andric     // Map all BB references in the WinEH data to MBBs.
2967d523365SDimitry Andric     for (WinEHTryBlockMapEntry &TBME : EHInfo.TryBlockMap) {
2977d523365SDimitry Andric       for (WinEHHandlerType &H : TBME.HandlerArray) {
2987d523365SDimitry Andric         if (H.Handler)
2997d523365SDimitry Andric           H.Handler = MBBMap[H.Handler.get<const BasicBlock *>()];
300ff0cc061SDimitry Andric       }
301ff0cc061SDimitry Andric     }
3027d523365SDimitry Andric     for (CxxUnwindMapEntry &UME : EHInfo.CxxUnwindMap)
3037d523365SDimitry Andric       if (UME.Cleanup)
3047d523365SDimitry Andric         UME.Cleanup = MBBMap[UME.Cleanup.get<const BasicBlock *>()];
3057d523365SDimitry Andric     for (SEHUnwindMapEntry &UME : EHInfo.SEHUnwindMap) {
3064ba319b5SDimitry Andric       const auto *BB = UME.Handler.get<const BasicBlock *>();
3077d523365SDimitry Andric       UME.Handler = MBBMap[BB];
3087d523365SDimitry Andric     }
3097d523365SDimitry Andric     for (ClrEHUnwindMapEntry &CME : EHInfo.ClrEHUnwindMap) {
3104ba319b5SDimitry Andric       const auto *BB = CME.Handler.get<const BasicBlock *>();
3117d523365SDimitry Andric       CME.Handler = MBBMap[BB];
312ff0cc061SDimitry Andric     }
313ff0cc061SDimitry Andric   }
314ff0cc061SDimitry Andric 
3154ba319b5SDimitry Andric   else if (Personality == EHPersonality::Wasm_CXX) {
3164ba319b5SDimitry Andric     WasmEHFuncInfo &EHInfo = *MF->getWasmEHFuncInfo();
3174ba319b5SDimitry Andric     // Map all BB references in the WinEH data to MBBs.
3184ba319b5SDimitry Andric     DenseMap<BBOrMBB, BBOrMBB> NewMap;
3194ba319b5SDimitry Andric     for (auto &KV : EHInfo.EHPadUnwindMap) {
3204ba319b5SDimitry Andric       const auto *Src = KV.first.get<const BasicBlock *>();
3214ba319b5SDimitry Andric       const auto *Dst = KV.second.get<const BasicBlock *>();
3224ba319b5SDimitry Andric       NewMap[MBBMap[Src]] = MBBMap[Dst];
3234ba319b5SDimitry Andric     }
3244ba319b5SDimitry Andric     EHInfo.EHPadUnwindMap = std::move(NewMap);
3254ba319b5SDimitry Andric     NewMap.clear();
3264ba319b5SDimitry Andric     for (auto &KV : EHInfo.ThrowUnwindMap) {
3274ba319b5SDimitry Andric       const auto *Src = KV.first.get<const BasicBlock *>();
3284ba319b5SDimitry Andric       const auto *Dst = KV.second.get<const BasicBlock *>();
3294ba319b5SDimitry Andric       NewMap[MBBMap[Src]] = MBBMap[Dst];
3304ba319b5SDimitry Andric     }
3314ba319b5SDimitry Andric     EHInfo.ThrowUnwindMap = std::move(NewMap);
3324ba319b5SDimitry Andric   }
3334ba319b5SDimitry Andric }
3344ba319b5SDimitry Andric 
335f22ef01cSRoman Divacky /// clear - Clear out all the function-specific state. This returns this
336f22ef01cSRoman Divacky /// FunctionLoweringInfo to an empty state, ready to be used for a
337f22ef01cSRoman Divacky /// different function.
clear()338f22ef01cSRoman Divacky void FunctionLoweringInfo::clear() {
339f22ef01cSRoman Divacky   MBBMap.clear();
340f22ef01cSRoman Divacky   ValueMap.clear();
3414ba319b5SDimitry Andric   VirtReg2Value.clear();
342f22ef01cSRoman Divacky   StaticAllocaMap.clear();
343f22ef01cSRoman Divacky   LiveOutRegInfo.clear();
344dd6029ffSDimitry Andric   VisitedBBs.clear();
345f22ef01cSRoman Divacky   ArgDbgValues.clear();
346e580952dSDimitry Andric   ByValArgFrameIndexMap.clear();
347ffd1746dSEd Schouten   RegFixups.clear();
3484ba319b5SDimitry Andric   RegsWithFixups.clear();
34939d628a0SDimitry Andric   StatepointStackSlots.clear();
3503ca95b02SDimitry Andric   StatepointSpillMaps.clear();
35139d628a0SDimitry Andric   PreferredExtendType.clear();
352f22ef01cSRoman Divacky }
353f22ef01cSRoman Divacky 
354ffd1746dSEd Schouten /// CreateReg - Allocate a single virtual register for the given type.
CreateReg(MVT VT)355139f7f9bSDimitry Andric unsigned FunctionLoweringInfo::CreateReg(MVT VT) {
35639d628a0SDimitry Andric   return RegInfo->createVirtualRegister(
35739d628a0SDimitry Andric       MF->getSubtarget().getTargetLowering()->getRegClassFor(VT));
358f22ef01cSRoman Divacky }
359f22ef01cSRoman Divacky 
360ffd1746dSEd Schouten /// CreateRegs - Allocate the appropriate number of virtual registers of
361f22ef01cSRoman Divacky /// the correctly promoted or expanded types.  Assign these registers
362f22ef01cSRoman Divacky /// consecutive vreg numbers and return the first assigned number.
363f22ef01cSRoman Divacky ///
364f22ef01cSRoman Divacky /// In the case that the given value has struct or array type, this function
365f22ef01cSRoman Divacky /// will assign registers for each member or element.
366f22ef01cSRoman Divacky ///
CreateRegs(Type * Ty)3676122f3e6SDimitry Andric unsigned FunctionLoweringInfo::CreateRegs(Type *Ty) {
36839d628a0SDimitry Andric   const TargetLowering *TLI = MF->getSubtarget().getTargetLowering();
369f785676fSDimitry Andric 
370f22ef01cSRoman Divacky   SmallVector<EVT, 4> ValueVTs;
371875ed548SDimitry Andric   ComputeValueVTs(*TLI, MF->getDataLayout(), Ty, ValueVTs);
372f22ef01cSRoman Divacky 
373f22ef01cSRoman Divacky   unsigned FirstReg = 0;
374f22ef01cSRoman Divacky   for (unsigned Value = 0, e = ValueVTs.size(); Value != e; ++Value) {
375f22ef01cSRoman Divacky     EVT ValueVT = ValueVTs[Value];
376f785676fSDimitry Andric     MVT RegisterVT = TLI->getRegisterType(Ty->getContext(), ValueVT);
377f22ef01cSRoman Divacky 
378f785676fSDimitry Andric     unsigned NumRegs = TLI->getNumRegisters(Ty->getContext(), ValueVT);
379f22ef01cSRoman Divacky     for (unsigned i = 0; i != NumRegs; ++i) {
380ffd1746dSEd Schouten       unsigned R = CreateReg(RegisterVT);
381f22ef01cSRoman Divacky       if (!FirstReg) FirstReg = R;
382f22ef01cSRoman Divacky     }
383f22ef01cSRoman Divacky   }
384f22ef01cSRoman Divacky   return FirstReg;
385f22ef01cSRoman Divacky }
386f22ef01cSRoman Divacky 
387dd6029ffSDimitry Andric /// GetLiveOutRegInfo - Gets LiveOutInfo for a register, returning NULL if the
388dd6029ffSDimitry Andric /// register is a PHI destination and the PHI's LiveOutInfo is not valid. If
389dd6029ffSDimitry Andric /// the register's LiveOutInfo is for a smaller bit width, it is extended to
390dd6029ffSDimitry Andric /// the larger bit width by zero extension. The bit width must be no smaller
391dd6029ffSDimitry Andric /// than the LiveOutInfo's existing bit width.
392dd6029ffSDimitry Andric const FunctionLoweringInfo::LiveOutInfo *
GetLiveOutRegInfo(unsigned Reg,unsigned BitWidth)393dd6029ffSDimitry Andric FunctionLoweringInfo::GetLiveOutRegInfo(unsigned Reg, unsigned BitWidth) {
394dd6029ffSDimitry Andric   if (!LiveOutRegInfo.inBounds(Reg))
39591bc56edSDimitry Andric     return nullptr;
396dd6029ffSDimitry Andric 
397dd6029ffSDimitry Andric   LiveOutInfo *LOI = &LiveOutRegInfo[Reg];
398dd6029ffSDimitry Andric   if (!LOI->IsValid)
39991bc56edSDimitry Andric     return nullptr;
400dd6029ffSDimitry Andric 
401f37b6182SDimitry Andric   if (BitWidth > LOI->Known.getBitWidth()) {
402dd6029ffSDimitry Andric     LOI->NumSignBits = 1;
4030f5676f4SDimitry Andric     LOI->Known = LOI->Known.zextOrTrunc(BitWidth);
404dd6029ffSDimitry Andric   }
405dd6029ffSDimitry Andric 
406dd6029ffSDimitry Andric   return LOI;
407dd6029ffSDimitry Andric }
408dd6029ffSDimitry Andric 
409dd6029ffSDimitry Andric /// ComputePHILiveOutRegInfo - Compute LiveOutInfo for a PHI's destination
410dd6029ffSDimitry Andric /// register based on the LiveOutInfo of its operands.
ComputePHILiveOutRegInfo(const PHINode * PN)411dd6029ffSDimitry Andric void FunctionLoweringInfo::ComputePHILiveOutRegInfo(const PHINode *PN) {
4126122f3e6SDimitry Andric   Type *Ty = PN->getType();
413dd6029ffSDimitry Andric   if (!Ty->isIntegerTy() || Ty->isVectorTy())
414dd6029ffSDimitry Andric     return;
415dd6029ffSDimitry Andric 
416dd6029ffSDimitry Andric   SmallVector<EVT, 1> ValueVTs;
417875ed548SDimitry Andric   ComputeValueVTs(*TLI, MF->getDataLayout(), Ty, ValueVTs);
418dd6029ffSDimitry Andric   assert(ValueVTs.size() == 1 &&
419dd6029ffSDimitry Andric          "PHIs with non-vector integer types should have a single VT.");
420dd6029ffSDimitry Andric   EVT IntVT = ValueVTs[0];
421dd6029ffSDimitry Andric 
422f785676fSDimitry Andric   if (TLI->getNumRegisters(PN->getContext(), IntVT) != 1)
423dd6029ffSDimitry Andric     return;
424f785676fSDimitry Andric   IntVT = TLI->getTypeToTransformTo(PN->getContext(), IntVT);
425dd6029ffSDimitry Andric   unsigned BitWidth = IntVT.getSizeInBits();
426dd6029ffSDimitry Andric 
427dd6029ffSDimitry Andric   unsigned DestReg = ValueMap[PN];
428dd6029ffSDimitry Andric   if (!TargetRegisterInfo::isVirtualRegister(DestReg))
429dd6029ffSDimitry Andric     return;
430dd6029ffSDimitry Andric   LiveOutRegInfo.grow(DestReg);
431dd6029ffSDimitry Andric   LiveOutInfo &DestLOI = LiveOutRegInfo[DestReg];
432dd6029ffSDimitry Andric 
433dd6029ffSDimitry Andric   Value *V = PN->getIncomingValue(0);
434dd6029ffSDimitry Andric   if (isa<UndefValue>(V) || isa<ConstantExpr>(V)) {
435dd6029ffSDimitry Andric     DestLOI.NumSignBits = 1;
436f37b6182SDimitry Andric     DestLOI.Known = KnownBits(BitWidth);
437dd6029ffSDimitry Andric     return;
438dd6029ffSDimitry Andric   }
439dd6029ffSDimitry Andric 
440dd6029ffSDimitry Andric   if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
441dd6029ffSDimitry Andric     APInt Val = CI->getValue().zextOrTrunc(BitWidth);
442dd6029ffSDimitry Andric     DestLOI.NumSignBits = Val.getNumSignBits();
443f37b6182SDimitry Andric     DestLOI.Known.Zero = ~Val;
444f37b6182SDimitry Andric     DestLOI.Known.One = Val;
445dd6029ffSDimitry Andric   } else {
446dd6029ffSDimitry Andric     assert(ValueMap.count(V) && "V should have been placed in ValueMap when its"
447dd6029ffSDimitry Andric                                 "CopyToReg node was created.");
448dd6029ffSDimitry Andric     unsigned SrcReg = ValueMap[V];
449dd6029ffSDimitry Andric     if (!TargetRegisterInfo::isVirtualRegister(SrcReg)) {
450dd6029ffSDimitry Andric       DestLOI.IsValid = false;
451dd6029ffSDimitry Andric       return;
452dd6029ffSDimitry Andric     }
453dd6029ffSDimitry Andric     const LiveOutInfo *SrcLOI = GetLiveOutRegInfo(SrcReg, BitWidth);
454dd6029ffSDimitry Andric     if (!SrcLOI) {
455dd6029ffSDimitry Andric       DestLOI.IsValid = false;
456dd6029ffSDimitry Andric       return;
457dd6029ffSDimitry Andric     }
458dd6029ffSDimitry Andric     DestLOI = *SrcLOI;
459dd6029ffSDimitry Andric   }
460dd6029ffSDimitry Andric 
461f37b6182SDimitry Andric   assert(DestLOI.Known.Zero.getBitWidth() == BitWidth &&
462f37b6182SDimitry Andric          DestLOI.Known.One.getBitWidth() == BitWidth &&
463dd6029ffSDimitry Andric          "Masks should have the same bit width as the type.");
464dd6029ffSDimitry Andric 
465dd6029ffSDimitry Andric   for (unsigned i = 1, e = PN->getNumIncomingValues(); i != e; ++i) {
466dd6029ffSDimitry Andric     Value *V = PN->getIncomingValue(i);
467dd6029ffSDimitry Andric     if (isa<UndefValue>(V) || isa<ConstantExpr>(V)) {
468dd6029ffSDimitry Andric       DestLOI.NumSignBits = 1;
469f37b6182SDimitry Andric       DestLOI.Known = KnownBits(BitWidth);
470dd6029ffSDimitry Andric       return;
471dd6029ffSDimitry Andric     }
472dd6029ffSDimitry Andric 
473dd6029ffSDimitry Andric     if (ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
474dd6029ffSDimitry Andric       APInt Val = CI->getValue().zextOrTrunc(BitWidth);
475dd6029ffSDimitry Andric       DestLOI.NumSignBits = std::min(DestLOI.NumSignBits, Val.getNumSignBits());
476f37b6182SDimitry Andric       DestLOI.Known.Zero &= ~Val;
477f37b6182SDimitry Andric       DestLOI.Known.One &= Val;
478dd6029ffSDimitry Andric       continue;
479dd6029ffSDimitry Andric     }
480dd6029ffSDimitry Andric 
481dd6029ffSDimitry Andric     assert(ValueMap.count(V) && "V should have been placed in ValueMap when "
482dd6029ffSDimitry Andric                                 "its CopyToReg node was created.");
483dd6029ffSDimitry Andric     unsigned SrcReg = ValueMap[V];
484dd6029ffSDimitry Andric     if (!TargetRegisterInfo::isVirtualRegister(SrcReg)) {
485dd6029ffSDimitry Andric       DestLOI.IsValid = false;
486dd6029ffSDimitry Andric       return;
487dd6029ffSDimitry Andric     }
488dd6029ffSDimitry Andric     const LiveOutInfo *SrcLOI = GetLiveOutRegInfo(SrcReg, BitWidth);
489dd6029ffSDimitry Andric     if (!SrcLOI) {
490dd6029ffSDimitry Andric       DestLOI.IsValid = false;
491dd6029ffSDimitry Andric       return;
492dd6029ffSDimitry Andric     }
493dd6029ffSDimitry Andric     DestLOI.NumSignBits = std::min(DestLOI.NumSignBits, SrcLOI->NumSignBits);
494f37b6182SDimitry Andric     DestLOI.Known.Zero &= SrcLOI->Known.Zero;
495f37b6182SDimitry Andric     DestLOI.Known.One &= SrcLOI->Known.One;
496dd6029ffSDimitry Andric   }
497dd6029ffSDimitry Andric }
498dd6029ffSDimitry Andric 
4996122f3e6SDimitry Andric /// setArgumentFrameIndex - Record frame index for the byval
500e580952dSDimitry Andric /// argument. This overrides previous frame index entry for this argument,
501e580952dSDimitry Andric /// if any.
setArgumentFrameIndex(const Argument * A,int FI)5026122f3e6SDimitry Andric void FunctionLoweringInfo::setArgumentFrameIndex(const Argument *A,
503e580952dSDimitry Andric                                                  int FI) {
504e580952dSDimitry Andric   ByValArgFrameIndexMap[A] = FI;
505e580952dSDimitry Andric }
506e580952dSDimitry Andric 
5076122f3e6SDimitry Andric /// getArgumentFrameIndex - Get frame index for the byval argument.
508e580952dSDimitry Andric /// If the argument does not have any assigned frame index then 0 is
509e580952dSDimitry Andric /// returned.
getArgumentFrameIndex(const Argument * A)5106122f3e6SDimitry Andric int FunctionLoweringInfo::getArgumentFrameIndex(const Argument *A) {
5115517e702SDimitry Andric   auto I = ByValArgFrameIndexMap.find(A);
512e580952dSDimitry Andric   if (I != ByValArgFrameIndexMap.end())
513e580952dSDimitry Andric     return I->second;
5144ba319b5SDimitry Andric   LLVM_DEBUG(dbgs() << "Argument does not have assigned frame index!\n");
5155517e702SDimitry Andric   return INT_MAX;
516e580952dSDimitry Andric }
517e580952dSDimitry Andric 
getCatchPadExceptionPointerVReg(const Value * CPI,const TargetRegisterClass * RC)5187d523365SDimitry Andric unsigned FunctionLoweringInfo::getCatchPadExceptionPointerVReg(
5197d523365SDimitry Andric     const Value *CPI, const TargetRegisterClass *RC) {
5207d523365SDimitry Andric   MachineRegisterInfo &MRI = MF->getRegInfo();
5217d523365SDimitry Andric   auto I = CatchPadExceptionPointers.insert({CPI, 0});
5227d523365SDimitry Andric   unsigned &VReg = I.first->second;
5237d523365SDimitry Andric   if (I.second)
5247d523365SDimitry Andric     VReg = MRI.createVirtualRegister(RC);
5257d523365SDimitry Andric   assert(VReg && "null vreg in exception pointer table!");
5267d523365SDimitry Andric   return VReg;
5277d523365SDimitry Andric }
5287d523365SDimitry Andric 
529d88c1a5aSDimitry Andric unsigned
getOrCreateSwiftErrorVReg(const MachineBasicBlock * MBB,const Value * Val)530d88c1a5aSDimitry Andric FunctionLoweringInfo::getOrCreateSwiftErrorVReg(const MachineBasicBlock *MBB,
531d88c1a5aSDimitry Andric                                                 const Value *Val) {
532d88c1a5aSDimitry Andric   auto Key = std::make_pair(MBB, Val);
533d88c1a5aSDimitry Andric   auto It = SwiftErrorVRegDefMap.find(Key);
534d88c1a5aSDimitry Andric   // If this is the first use of this swifterror value in this basic block,
535d88c1a5aSDimitry Andric   // create a new virtual register.
536d88c1a5aSDimitry Andric   // After we processed all basic blocks we will satisfy this "upwards exposed
537d88c1a5aSDimitry Andric   // use" by inserting a copy or phi at the beginning of this block.
538d88c1a5aSDimitry Andric   if (It == SwiftErrorVRegDefMap.end()) {
539d88c1a5aSDimitry Andric     auto &DL = MF->getDataLayout();
540d88c1a5aSDimitry Andric     const TargetRegisterClass *RC = TLI->getRegClassFor(TLI->getPointerTy(DL));
541d88c1a5aSDimitry Andric     auto VReg = MF->getRegInfo().createVirtualRegister(RC);
542d88c1a5aSDimitry Andric     SwiftErrorVRegDefMap[Key] = VReg;
543d88c1a5aSDimitry Andric     SwiftErrorVRegUpwardsUse[Key] = VReg;
544d88c1a5aSDimitry Andric     return VReg;
545d88c1a5aSDimitry Andric   } else return It->second;
546dff0c46cSDimitry Andric }
547dff0c46cSDimitry Andric 
setCurrentSwiftErrorVReg(const MachineBasicBlock * MBB,const Value * Val,unsigned VReg)548d88c1a5aSDimitry Andric void FunctionLoweringInfo::setCurrentSwiftErrorVReg(
549d88c1a5aSDimitry Andric     const MachineBasicBlock *MBB, const Value *Val, unsigned VReg) {
550d88c1a5aSDimitry Andric   SwiftErrorVRegDefMap[std::make_pair(MBB, Val)] = VReg;
5513ca95b02SDimitry Andric }
55224d58133SDimitry Andric 
55324d58133SDimitry Andric std::pair<unsigned, bool>
getOrCreateSwiftErrorVRegDefAt(const Instruction * I)55424d58133SDimitry Andric FunctionLoweringInfo::getOrCreateSwiftErrorVRegDefAt(const Instruction *I) {
55524d58133SDimitry Andric   auto Key = PointerIntPair<const Instruction *, 1, bool>(I, true);
55624d58133SDimitry Andric   auto It = SwiftErrorVRegDefUses.find(Key);
55724d58133SDimitry Andric   if (It == SwiftErrorVRegDefUses.end()) {
55824d58133SDimitry Andric     auto &DL = MF->getDataLayout();
55924d58133SDimitry Andric     const TargetRegisterClass *RC = TLI->getRegClassFor(TLI->getPointerTy(DL));
56024d58133SDimitry Andric     unsigned VReg =  MF->getRegInfo().createVirtualRegister(RC);
56124d58133SDimitry Andric     SwiftErrorVRegDefUses[Key] = VReg;
56224d58133SDimitry Andric     return std::make_pair(VReg, true);
56324d58133SDimitry Andric   }
56424d58133SDimitry Andric   return std::make_pair(It->second, false);
56524d58133SDimitry Andric }
56624d58133SDimitry Andric 
56724d58133SDimitry Andric std::pair<unsigned, bool>
getOrCreateSwiftErrorVRegUseAt(const Instruction * I,const MachineBasicBlock * MBB,const Value * Val)56824d58133SDimitry Andric FunctionLoweringInfo::getOrCreateSwiftErrorVRegUseAt(const Instruction *I, const MachineBasicBlock *MBB, const Value *Val) {
56924d58133SDimitry Andric   auto Key = PointerIntPair<const Instruction *, 1, bool>(I, false);
57024d58133SDimitry Andric   auto It = SwiftErrorVRegDefUses.find(Key);
57124d58133SDimitry Andric   if (It == SwiftErrorVRegDefUses.end()) {
57224d58133SDimitry Andric     unsigned VReg = getOrCreateSwiftErrorVReg(MBB, Val);
57324d58133SDimitry Andric     SwiftErrorVRegDefUses[Key] = VReg;
57424d58133SDimitry Andric     return std::make_pair(VReg, true);
57524d58133SDimitry Andric   }
57624d58133SDimitry Andric   return std::make_pair(It->second, false);
57724d58133SDimitry Andric }
5784ba319b5SDimitry Andric 
5794ba319b5SDimitry Andric const Value *
getValueFromVirtualReg(unsigned Vreg)5804ba319b5SDimitry Andric FunctionLoweringInfo::getValueFromVirtualReg(unsigned Vreg) {
5814ba319b5SDimitry Andric   if (VirtReg2Value.empty()) {
582*b5893f02SDimitry Andric     SmallVector<EVT, 4> ValueVTs;
5834ba319b5SDimitry Andric     for (auto &P : ValueMap) {
584*b5893f02SDimitry Andric       ValueVTs.clear();
585*b5893f02SDimitry Andric       ComputeValueVTs(*TLI, Fn->getParent()->getDataLayout(),
586*b5893f02SDimitry Andric                       P.first->getType(), ValueVTs);
587*b5893f02SDimitry Andric       unsigned Reg = P.second;
588*b5893f02SDimitry Andric       for (EVT VT : ValueVTs) {
589*b5893f02SDimitry Andric         unsigned NumRegisters = TLI->getNumRegisters(Fn->getContext(), VT);
590*b5893f02SDimitry Andric         for (unsigned i = 0, e = NumRegisters; i != e; ++i)
591*b5893f02SDimitry Andric           VirtReg2Value[Reg++] = P.first;
5924ba319b5SDimitry Andric       }
5934ba319b5SDimitry Andric     }
594*b5893f02SDimitry Andric   }
595*b5893f02SDimitry Andric   return VirtReg2Value.lookup(Vreg);
5964ba319b5SDimitry Andric }
597